lib/psiconv/list.h

/*
    list.h - Part of psiconv, a PSION 5 file formats converter
    Copyright (c) 1999, 2000  Frodo Looijaard <frodol@dds.nl> 

    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; either version 2 of the License, or
    (at your option) any later version.

    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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/* A generic list type. In C++, this would be much neater. All elements must
   be of the same size (solve it with pointers, if needed) */

#ifndef PSICONV_LIST_H
#define PSICONV_LIST_H

#include <stddef.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* Always use psiconv_list, never struct psiconv_list */
/* No need to export the actual internal format */
typedef struct psiconv_list_s *psiconv_list; 

/* Before using a list, call list_new. It takes the size of a single element
   as its argument. Always compute it with a sizeof() expression, just to be
   safe. The returned list is empty. 
   If there is not enough memory available, NULL is returned. You should 
   always test for this explicitely, because the other functions do not
   like a psiconv_list argument that is equal to NULL */
extern psiconv_list psiconv_list_new(int element_size);

/* This frees the list. If elements contain pointers that need to be freed
   separately, call list_free_el below. */
extern void psiconv_list_free(psiconv_list l);

/* This calls free_el first for each element, before doing a list_free.
   Note that you should *not* do 'free(el)' at any time; that is taken care of
   automatically. */
extern void psiconv_list_free_el(psiconv_list l, void free_el(void *el));

/* Return the number of allocated elements */
extern int psiconv_list_length(const psiconv_list l);

/* Return 1 if the list is empty, 0 if not */
extern int psiconv_list_is_empty(const psiconv_list l);

/* Get an element from the list, and return a pointer to it. Note: you can
   directly modify this element, but be careful not to write beyond the
   element memory space. 
   If indx is out of range, NULL is returned. */
extern void * psiconv_list_get(const psiconv_list l, unsigned int indx);

/* Add an element at the end of the list. The element is copied from the
   supplied element. Of course, this does not help if the element contains
   pointers. 
   As the lists extends itself, it may be necessary to allocate new
   memory. If this fails, a negative error-code is returned. If everything,
   succeeds, 0 is returned. */
extern int psiconv_list_add(psiconv_list l, const void *el);

/* Do some action for each element. Note: you can directly modify the
   elements supplied to action, and they will be changed in the list,
   but never try a free(el)! */
extern void psiconv_list_foreach_el(psiconv_list l, void action(void *el));

/* Clone the list, that is, copy it. If elements contain pointers, you
   should call the next routine. If not enough memory is available,
   NULL is returned. */
extern psiconv_list psiconv_list_clone(const psiconv_list l);

/* Read upto size_t elements from file f, and put them at the end of list l.
   Returned is the actual number of elements added. This assumes the file
   layout and the memory layout of elements is the same. Note that if
   not enough memory could be allocated, 0 is simply returned. */
extern size_t psiconv_list_fread(psiconv_list l,size_t size, FILE *f);

/* Concatenate two lists. The element sized does not have to be the same,
   but the result may be quite unexpected if it is not. */
int psiconv_list_concat(psiconv_list l, const psiconv_list extra);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif
1	frodo	2	/*
2			list.h - Part of psiconv, a PSION 5 file formats converter
3	frodo	63	Copyright (c) 1999, 2000 Frodo Looijaard <frodol@dds.nl>
4	frodo	2
5			This program is free software; you can redistribute it and/or modify
6			it under the terms of the GNU General Public License as published by
7			the Free Software Foundation; either version 2 of the License, or
8			(at your option) any later version.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			GNU General Public License for more details.
14
15			You should have received a copy of the GNU General Public License
16			along with this program; if not, write to the Free Software
17			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18			*/
19
20			/* A generic list type. In C++, this would be much neater. All elements must
21			be of the same size (solve it with pointers, if needed) */
22
23			#ifndef PSICONV_LIST_H
24			#define PSICONV_LIST_H
25
26			#include <stddef.h>
27			#include <stdio.h>
28
29	frodo	55	#ifdef __cplusplus
30			extern "C" {
31			#endif /* __cplusplus */
32
33	frodo	2	/* Always use psiconv_list, never struct psiconv_list */
34			/* No need to export the actual internal format */
35	frodo	56	typedef struct psiconv_list_s *psiconv_list;
36	frodo	2
37			/* Before using a list, call list_new. It takes the size of a single element
38			as its argument. Always compute it with a sizeof() expression, just to be
39	frodo	62	safe. The returned list is empty.
40			If there is not enough memory available, NULL is returned. You should
41			always test for this explicitely, because the other functions do not
42			like a psiconv_list argument that is equal to NULL */
43	frodo	2	extern psiconv_list psiconv_list_new(int element_size);
44
45			/* This frees the list. If elements contain pointers that need to be freed
46			separately, call list_free_el below. */
47			extern void psiconv_list_free(psiconv_list l);
48
49			/* This calls free_el first for each element, before doing a list_free.
50			Note that you should not do 'free(el)' at any time; that is taken care of
51			automatically. */
52			extern void psiconv_list_free_el(psiconv_list l, void free_el(void *el));
53
54			/* Return the number of allocated elements */
55			extern int psiconv_list_length(const psiconv_list l);
56
57			/* Return 1 if the list is empty, 0 if not */
58			extern int psiconv_list_is_empty(const psiconv_list l);
59
60			/* Get an element from the list, and return a pointer to it. Note: you can
61			directly modify this element, but be careful not to write beyond the
62	frodo	62	element memory space.
63			If indx is out of range, NULL is returned. */
64	frodo	2	extern void * psiconv_list_get(const psiconv_list l, unsigned int indx);
65
66			/* Add an element at the end of the list. The element is copied from the
67			supplied element. Of course, this does not help if the element contains
68	frodo	62	pointers.
69			As the lists extends itself, it may be necessary to allocate new
70			memory. If this fails, a negative error-code is returned. If everything,
71			succeeds, 0 is returned. */
72	frodo	70	extern int psiconv_list_add(psiconv_list l, const void *el);
73	frodo	2
74			/* Do some action for each element. Note: you can directly modify the
75			elements supplied to action, and they will be changed in the list,
76			but never try a free(el)! */
77			extern void psiconv_list_foreach_el(psiconv_list l, void action(void *el));
78
79			/* Clone the list, that is, copy it. If elements contain pointers, you
80	frodo	62	should call the next routine. If not enough memory is available,
81			NULL is returned. */
82	frodo	2	extern psiconv_list psiconv_list_clone(const psiconv_list l);
83
84			/* Read upto size_t elements from file f, and put them at the end of list l.
85			Returned is the actual number of elements added. This assumes the file
86	frodo	62	layout and the memory layout of elements is the same. Note that if
87			not enough memory could be allocated, 0 is simply returned. */
88	frodo	2	extern size_t psiconv_list_fread(psiconv_list l,size_t size, FILE *f);
89
90	frodo	72	/* Concatenate two lists. The element sized does not have to be the same,
91			but the result may be quite unexpected if it is not. */
92			int psiconv_list_concat(psiconv_list l, const psiconv_list extra);
93	frodo	62
94	frodo	72
95	frodo	55	#ifdef __cplusplus
96			}
97			#endif /* __cplusplus */
98
99	frodo	2	#endif
frodo@frodo.looijaard.name	ViewVC Help
Powered by ViewVC 1.1.26