GDAL
cpl_list.h
Go to the documentation of this file.
1 /**********************************************************************
2  * $Id: cpl_list.h 34518 2016-07-02 21:01:34Z goatbar $
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 
46 
48 typedef struct _CPLList
49 {
53  void *pData;
57  struct _CPLList *psNext;
58 } CPLList;
59 
60 CPLList CPL_DLL *CPLListAppend( CPLList *psList, void * pData );
61 CPLList CPL_DLL *CPLListInsert( CPLList *psList, void * pData, int nPosition );
62 CPLList CPL_DLL *CPLListGetLast( CPLList *psList );
63 CPLList CPL_DLL *CPLListGet( CPLList * const psList, int nPosition );
64 int CPL_DLL CPLListCount( const CPLList *psList );
65 CPLList CPL_DLL *CPLListRemove( CPLList *psList, int nPosition );
66 void CPL_DLL CPLListDestroy( CPLList *psList );
67 CPLList CPL_DLL *CPLListGetNext( const CPLList *psElement );
68 void CPL_DLL *CPLListGetData( const CPLList *psElement );
69 
71 
72 #endif /* CPL_LIST_H_INCLUDED */
CPLList * CPLListGet(CPLList *const psList, int nPosition)
Return the pointer to the specified element in a list.
Definition: cpl_list.cpp:182
List element structure.
Definition: cpl_list.h:48
Core portability definitions for CPL.
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:352
void CPLListDestroy(CPLList *psList)
Destroy a list.
Definition: cpl_list.cpp:285
CPLList * CPLListGetLast(CPLList *psList)
Return the pointer to last element in a list.
Definition: cpl_list.cpp:156
CPLList * CPLListGetNext(const CPLList *psElement)
Return the pointer to next element in a list.
Definition: cpl_list.cpp:309
CPLList * CPLListRemove(CPLList *psList, int nPosition)
Remove the element from the specified position (zero based) in a list.
Definition: cpl_list.cpp:238
void * CPLListGetData(const CPLList *psElement)
Return pointer to the data object contained in given list element.
Definition: cpl_list.cpp:329
void * pData
Definition: cpl_list.h:53
struct _CPLList CPLList
List element structure.
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:354
int CPLListCount(const CPLList *psList)
Return the number of elements in a list.
Definition: cpl_list.cpp:210
CPLList * CPLListInsert(CPLList *psList, void *pData, int nPosition)
Insert an object into list at specified position (zero based).
Definition: cpl_list.cpp:96
CPLList * CPLListAppend(CPLList *psList, void *pData)
Append an object list and return a pointer to the modified list.
Definition: cpl_list.cpp:57
struct _CPLList * psNext
Definition: cpl_list.h:57

Generated for GDAL by doxygen 1.8.8.