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 * SPDX-License-Identifier: MIT
13 ****************************************************************************/
14
15#ifndef CPL_LIST_H_INCLUDED
16#define CPL_LIST_H_INCLUDED
17
18#include "cpl_port.h"
19
29 CPL_C_START
30
32 typedef struct _CPLList CPLList;
33
35 struct _CPLList
36{
40 void *pData;
44 struct _CPLList *psNext;
45};
46
47 CPLList CPL_DLL *CPLListAppend(CPLList *psList, void *pData);
48 CPLList CPL_DLL *CPLListInsert(CPLList *psList, void *pData, int nPosition);
49 CPLList CPL_DLL *CPLListGetLast(CPLList *psList);
50 CPLList CPL_DLL *CPLListGet(CPLList *const psList, int nPosition);
51 int CPL_DLL CPLListCount(const CPLList *psList);
52 CPLList CPL_DLL *CPLListRemove(CPLList *psList, int nPosition);
53 void CPL_DLL CPLListDestroy(CPLList *psList);
54 CPLList CPL_DLL *CPLListGetNext(const CPLList *psElement);
55 void CPL_DLL *CPLListGetData(const CPLList *psElement);
56
57 CPL_C_END
58
59#endif /* CPL_LIST_H_INCLUDED */
CPLListDestroy
void CPLListDestroy(CPLList *psList)
Destroy a list.
Definition: cpl_list.cpp:267
CPLListCount
int CPLListCount(const CPLList *psList)
Return the number of elements in a list.
Definition: cpl_list.cpp:192
CPLListAppend
CPLList * CPLListAppend(CPLList *psList, void *pData)
Append an object list and return a pointer to the modified list.
Definition: cpl_list.cpp:39
CPLListGetNext
CPLList * CPLListGetNext(const CPLList *psElement)
Return the pointer to next element in a list.
Definition: cpl_list.cpp:291
CPLListRemove
CPLList * CPLListRemove(CPLList *psList, int nPosition)
Remove the element from the specified position (zero based) in a list.
Definition: cpl_list.cpp:220
CPLListGetData
void * CPLListGetData(const CPLList *psElement)
Return pointer to the data object contained in given list element.
Definition: cpl_list.cpp:311
CPLListInsert
CPLList * CPLListInsert(CPLList *psList, void *pData, int nPosition)
Insert an object into list at specified position (zero based).
Definition: cpl_list.cpp:78
CPLListGetLast
CPLList * CPLListGetLast(CPLList *psList)
Return the pointer to last element in a list.
Definition: cpl_list.cpp:138
CPLListGet
CPLList * CPLListGet(CPLList *const psList, int nPosition)
Return the pointer to the specified element in a list.
Definition: cpl_list.cpp:164
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:283
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:279
_CPLList
List element structure.
Definition: cpl_list.h:36
_CPLList::pData
void * pData
Definition: cpl_list.h:40
_CPLList::psNext
struct _CPLList * psNext
Definition: cpl_list.h:44