mirror of
https://github.com/MariaDB/server.git
synced 2025-01-22 23:04:20 +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. ------------------------------------------------------------------------
172 lines
5.4 KiB
C
172 lines
5.4 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/ut0list.h
|
|
A double-linked list
|
|
|
|
Created 4/26/2006 Osku Salerma
|
|
************************************************************************/
|
|
|
|
/*******************************************************************//**
|
|
A double-linked list. This differs from the one in ut0lst.h in that in this
|
|
one, each list node contains a pointer to the data, whereas the one in
|
|
ut0lst.h uses a strategy where the list pointers are embedded in the data
|
|
items themselves.
|
|
|
|
Use this one when you need to store arbitrary data in the list where you
|
|
can't embed the list pointers in the data, if a data item needs to be
|
|
stored in multiple lists, etc.
|
|
|
|
Note about the memory management: ib_list_t is a fixed-size struct whose
|
|
allocation/deallocation is done through ib_list_create/ib_list_free, but the
|
|
memory for the list nodes is allocated through a user-given memory heap,
|
|
which can either be the same for all nodes or vary per node. Most users will
|
|
probably want to create a memory heap to store the item-specific data, and
|
|
pass in this same heap to the list node creation functions, thus
|
|
automatically freeing the list node when the item's heap is freed.
|
|
|
|
************************************************************************/
|
|
|
|
#ifndef IB_LIST_H
|
|
#define IB_LIST_H
|
|
|
|
#include "mem0mem.h"
|
|
|
|
typedef struct ib_list_struct ib_list_t;
|
|
typedef struct ib_list_node_struct ib_list_node_t;
|
|
typedef struct ib_list_helper_struct ib_list_helper_t;
|
|
|
|
/****************************************************************//**
|
|
Create a new list using mem_alloc. Lists created with this function must be
|
|
freed with ib_list_free.
|
|
@return list */
|
|
UNIV_INTERN
|
|
ib_list_t*
|
|
ib_list_create(void);
|
|
/*=================*/
|
|
|
|
|
|
/****************************************************************//**
|
|
Create a new list using the given heap. ib_list_free MUST NOT BE CALLED for
|
|
lists created with this function.
|
|
@return list */
|
|
UNIV_INTERN
|
|
ib_list_t*
|
|
ib_list_create_heap(
|
|
/*================*/
|
|
mem_heap_t* heap); /*!< in: memory heap to use */
|
|
|
|
/****************************************************************//**
|
|
Free a list. */
|
|
UNIV_INTERN
|
|
void
|
|
ib_list_free(
|
|
/*=========*/
|
|
ib_list_t* list); /*!< in: list */
|
|
|
|
/****************************************************************//**
|
|
Add the data to the start of the list.
|
|
@return new list node */
|
|
UNIV_INTERN
|
|
ib_list_node_t*
|
|
ib_list_add_first(
|
|
/*==============*/
|
|
ib_list_t* list, /*!< in: list */
|
|
void* data, /*!< in: data */
|
|
mem_heap_t* heap); /*!< in: memory heap to use */
|
|
|
|
/****************************************************************//**
|
|
Add the data to the end of the list.
|
|
@return new list node */
|
|
UNIV_INTERN
|
|
ib_list_node_t*
|
|
ib_list_add_last(
|
|
/*=============*/
|
|
ib_list_t* list, /*!< in: list */
|
|
void* data, /*!< in: data */
|
|
mem_heap_t* heap); /*!< in: memory heap to use */
|
|
|
|
/****************************************************************//**
|
|
Add the data after the indicated node.
|
|
@return new list node */
|
|
UNIV_INTERN
|
|
ib_list_node_t*
|
|
ib_list_add_after(
|
|
/*==============*/
|
|
ib_list_t* list, /*!< in: list */
|
|
ib_list_node_t* prev_node, /*!< in: node preceding new node (can
|
|
be NULL) */
|
|
void* data, /*!< in: data */
|
|
mem_heap_t* heap); /*!< in: memory heap to use */
|
|
|
|
/****************************************************************//**
|
|
Remove the node from the list. */
|
|
UNIV_INTERN
|
|
void
|
|
ib_list_remove(
|
|
/*===========*/
|
|
ib_list_t* list, /*!< in: list */
|
|
ib_list_node_t* node); /*!< in: node to remove */
|
|
|
|
/****************************************************************//**
|
|
Get the first node in the list.
|
|
@return first node, or NULL */
|
|
UNIV_INLINE
|
|
ib_list_node_t*
|
|
ib_list_get_first(
|
|
/*==============*/
|
|
ib_list_t* list); /*!< in: list */
|
|
|
|
/****************************************************************//**
|
|
Get the last node in the list.
|
|
@return last node, or NULL */
|
|
UNIV_INLINE
|
|
ib_list_node_t*
|
|
ib_list_get_last(
|
|
/*=============*/
|
|
ib_list_t* list); /*!< in: list */
|
|
|
|
/* List. */
|
|
struct ib_list_struct {
|
|
ib_list_node_t* first; /*!< first node */
|
|
ib_list_node_t* last; /*!< last node */
|
|
ibool is_heap_list; /*!< TRUE if this list was
|
|
allocated through a heap */
|
|
};
|
|
|
|
/* A list node. */
|
|
struct ib_list_node_struct {
|
|
ib_list_node_t* prev; /*!< previous node */
|
|
ib_list_node_t* next; /*!< next node */
|
|
void* data; /*!< user data */
|
|
};
|
|
|
|
/* Quite often, the only additional piece of data you need is the per-item
|
|
memory heap, so we have this generic struct available to use in those
|
|
cases. */
|
|
struct ib_list_helper_struct {
|
|
mem_heap_t* heap; /*!< memory heap */
|
|
void* data; /*!< user data */
|
|
};
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "ut0list.ic"
|
|
#endif
|
|
|
|
#endif
|