mirror of
https://github.com/MariaDB/server.git
synced 2025-01-21 06:22:28 +01:00
1601bdc38a
------------------------------------------------------------------------
r5092 | marko | 2009-05-25 09:54:17 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Adjust some function comments after r5091.
------------------------------------------------------------------------
r5100 | marko | 2009-05-25 12:09:45 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Split some long lines that were introduced in r5091.
------------------------------------------------------------------------
r5101 | marko | 2009-05-25 12:42:47 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Introduce the macro TEMP_INDEX_PREFIX_STR.
This is to avoid triggering an error in Doxygen.
------------------------------------------------------------------------
r5102 | marko | 2009-05-25 13:47:14 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Add missing file comments.
------------------------------------------------------------------------
r5103 | marko | 2009-05-25 13:52:29 +0300 (Mon, 25 May 2009) | 10 lines
branches/zip: Add @file comments, and convert decorative
/*********************************
comments to Doxygen /** style like this:
/*****************************//**
This conversion was performed by the following command:
perl -i -e 'while(<ARGV>){if (m|^/\*{30}\**$|) {
s|\*{4}$|//**| if ++$com>1; $_ .= "\@file $ARGV\n" if $com==2}
print; if(eof){$.=0;undef $com}}' */*[ch] include/univ.i
------------------------------------------------------------------------
r5104 | marko | 2009-05-25 14:39:07 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Revert ut0auxconf_* to r5102,
that is, make Doxygen ignore these test programs.
------------------------------------------------------------------------
r5105 | marko | 2009-05-25 14:52:20 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Enclose some #error checks inside #ifndef DOXYGEN
to prevent bogus Doxygen errors.
------------------------------------------------------------------------
r5106 | marko | 2009-05-25 16:09:24 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Add some Doxygen comments, mainly to structs, typedefs,
macros and global variables. Many more to go.
------------------------------------------------------------------------
r5108 | marko | 2009-05-26 00:32:35 +0300 (Tue, 26 May 2009) | 2 lines
branches/zip: lexyy.c: Remove the inadvertently added @file directive.
There is nothing for Doxygen to see in this file, move along.
------------------------------------------------------------------------
r5125 | marko | 2009-05-26 16:28:49 +0300 (Tue, 26 May 2009) | 3 lines
branches/zip: Add some Doxygen comments for many structs, typedefs,
#defines and global variables. Many are still missing.
------------------------------------------------------------------------
r5134 | marko | 2009-05-27 09:08:43 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add some Doxygen @return comments.
------------------------------------------------------------------------
r5139 | marko | 2009-05-27 10:01:40 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add Doxyfile.
------------------------------------------------------------------------
r5143 | marko | 2009-05-27 10:57:25 +0300 (Wed, 27 May 2009) | 3 lines
branches/zip: buf0buf.h, Doxyfile: Fix the Doxygen translation.
@defgroup is for source code modules, not for field groups.
Tell Doxygen to expand the UT_LIST declarations.
------------------------------------------------------------------------
125 lines
3.7 KiB
C
125 lines
3.7 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 2006, 2009, Innobase Oy. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/*******************************************************************//**
|
|
@file include/ut0vec.h
|
|
A vector of pointers to data items
|
|
|
|
Created 4/6/2006 Osku Salerma
|
|
************************************************************************/
|
|
|
|
#ifndef IB_VECTOR_H
|
|
#define IB_VECTOR_H
|
|
|
|
#include "univ.i"
|
|
#include "mem0mem.h"
|
|
|
|
/** An automatically resizing vector data type. */
|
|
typedef struct ib_vector_struct ib_vector_t;
|
|
|
|
/* An automatically resizing vector datatype with the following properties:
|
|
|
|
-Contains void* items.
|
|
|
|
-The items are owned by the caller.
|
|
|
|
-All memory allocation is done through a heap owned by the caller, who is
|
|
responsible for freeing it when done with the vector.
|
|
|
|
-When the vector is resized, the old memory area is left allocated since it
|
|
uses the same heap as the new memory area, so this is best used for
|
|
relatively small or short-lived uses.
|
|
*/
|
|
|
|
/****************************************************************//**
|
|
Create a new vector with the given initial size.
|
|
@return vector */
|
|
UNIV_INTERN
|
|
ib_vector_t*
|
|
ib_vector_create(
|
|
/*=============*/
|
|
mem_heap_t* heap, /*!< in: heap */
|
|
ulint size); /*!< in: initial size */
|
|
|
|
/****************************************************************//**
|
|
Push a new element to the vector, increasing its size if necessary. */
|
|
UNIV_INTERN
|
|
void
|
|
ib_vector_push(
|
|
/*===========*/
|
|
ib_vector_t* vec, /*!< in: vector */
|
|
void* elem); /*!< in: data element */
|
|
|
|
/****************************************************************//**
|
|
Get the number of elements in the vector.
|
|
@return number of elements in vector */
|
|
UNIV_INLINE
|
|
ulint
|
|
ib_vector_size(
|
|
/*===========*/
|
|
const ib_vector_t* vec); /*!< in: vector */
|
|
|
|
/****************************************************************//**
|
|
Test whether a vector is empty or not.
|
|
@return TRUE if empty */
|
|
UNIV_INLINE
|
|
ibool
|
|
ib_vector_is_empty(
|
|
/*===============*/
|
|
const ib_vector_t* vec); /*!< in: vector */
|
|
|
|
/****************************************************************//**
|
|
Get the n'th element.
|
|
@return n'th element */
|
|
UNIV_INLINE
|
|
void*
|
|
ib_vector_get(
|
|
/*==========*/
|
|
ib_vector_t* vec, /*!< in: vector */
|
|
ulint n); /*!< in: element index to get */
|
|
|
|
/****************************************************************//**
|
|
Remove the last element from the vector. */
|
|
UNIV_INLINE
|
|
void*
|
|
ib_vector_pop(
|
|
/*==========*/
|
|
ib_vector_t* vec); /*!< in: vector */
|
|
|
|
/****************************************************************//**
|
|
Free the underlying heap of the vector. Note that vec is invalid
|
|
after this call. */
|
|
UNIV_INLINE
|
|
void
|
|
ib_vector_free(
|
|
/*===========*/
|
|
ib_vector_t* vec); /*!< in,own: vector */
|
|
|
|
/** An automatically resizing vector data type. */
|
|
struct ib_vector_struct {
|
|
mem_heap_t* heap; /*!< heap */
|
|
void** data; /*!< data elements */
|
|
ulint used; /*!< number of elements currently used */
|
|
ulint total; /*!< number of elements allocated */
|
|
};
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "ut0vec.ic"
|
|
#endif
|
|
|
|
#endif
|