GDAL

cpl_list.h
Go to the documentation of this file.
1/**********************************************************************
2 * $Id$
3 *
4 * Name: cpl_list.h
5 * Project: CPL - Common Portability Library
6 * Purpose: List functions.
7 * Author: Andrey Kiselev, dron@remotesensing.org
8 *
9 **********************************************************************
10 * Copyright (c) 2003, Andrey Kiselev <dron@remotesensing.org>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31#ifndef CPL_LIST_H_INCLUDED
32#define CPL_LIST_H_INCLUDED
33
34#include "cpl_port.h"
35
45 CPL_C_START
46
48 typedef struct _CPLList CPLList;
49
51 struct _CPLList
52{
56 void *pData;
60 struct _CPLList *psNext;
61};
62
63 CPLList CPL_DLL *CPLListAppend(CPLList *psList, void *pData);
64 CPLList CPL_DLL *CPLListInsert(CPLList *psList, void *pData, int nPosition);
65 CPLList CPL_DLL *CPLListGetLast(CPLList *psList);
66 CPLList CPL_DLL *CPLListGet(CPLList *const psList, int nPosition);
67 int CPL_DLL CPLListCount(const CPLList *psList);
68 CPLList CPL_DLL *CPLListRemove(CPLList *psList, int nPosition);
69 void CPL_DLL CPLListDestroy(CPLList *psList);
70 CPLList CPL_DLL *CPLListGetNext(const CPLList *psElement);
71 void CPL_DLL *CPLListGetData(const CPLList *psElement);
72
73 CPL_C_END
74
75#endif /* CPL_LIST_H_INCLUDED */
CPLListDestroy
void CPLListDestroy(CPLList *psList)
Destroy a list.
Definition cpl_list.cpp:283
CPLListCount
int CPLListCount(const CPLList *psList)
Return the number of elements in a list.
Definition cpl_list.cpp:208
CPLListAppend
CPLList * CPLListAppend(CPLList *psList, void *pData)
Append an object list and return a pointer to the modified list.
Definition cpl_list.cpp:55
CPLListGetNext
CPLList * CPLListGetNext(const CPLList *psElement)
Return the pointer to next element in a list.
Definition cpl_list.cpp:307
CPLListRemove
CPLList * CPLListRemove(CPLList *psList, int nPosition)
Remove the element from the specified position (zero based) in a list.
Definition cpl_list.cpp:236
CPLListGetData
void * CPLListGetData(const CPLList *psElement)
Return pointer to the data object contained in given list element.
Definition cpl_list.cpp:327
CPLListInsert
CPLList * CPLListInsert(CPLList *psList, void *pData, int nPosition)
Insert an object into list at specified position (zero based).
Definition cpl_list.cpp:94
CPLListGetLast
CPLList * CPLListGetLast(CPLList *psList)
Return the pointer to last element in a list.
Definition cpl_list.cpp:154
CPLListGet
CPLList * CPLListGet(CPLList *const psList, int nPosition)
Return the pointer to the specified element in a list.
Definition cpl_list.cpp:180
cpl_port.h
Core portability definitions for CPL.
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition cpl_port.h:299
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition cpl_port.h:295
_CPLList
List element structure.
Definition cpl_list.h:52
_CPLList::pData
void * pData
Definition cpl_list.h:56
_CPLList::psNext
struct _CPLList * psNext
Definition cpl_list.h:60