trunk/src/waysx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/waysx.h,v 1.21 2010-05-22 18:40:47 amb Exp $

 A header file for the extended Ways structure.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2010 Andrew M. Bishop

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************/


#ifndef WAYSX_H
#define WAYSX_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "typesx.h"
#include "types.h"
#include "ways.h"


/* Data structures */


/*+ An extended structure containing a single way. +*/
struct _WayX
{
 way_t    id;                   /*+ The way identifier. +*/

 index_t  prop;                 /*+ The index of the properties of the way in the compacted list. +*/

 Way      way;                  /*+ The real Way data. +*/
};


/*+ A structure containing a set of ways (memory format). +*/
struct _WaysX
{
 char    *filename;             /*+ The name of the temporary file (for the WaysX). +*/
 int      fd;                   /*+ The file descriptor of the temporary file (for the WaysX). +*/

 uint32_t xnumber;              /*+ The number of unsorted extended ways. +*/

 WayX    *xdata;                /*+ The extended data for the Ways (sorted). +*/
 WayX     cached[2];            /*+ Two cached ways read from the file in slim mode. +*/

 uint32_t number;               /*+ How many entries are still useful? +*/

 uint32_t cnumber;              /*+ How many entries are there after compacting? +*/

 index_t *idata;                /*+ The index of the extended data for the Ways (sorted by ID). +*/

 char    *nfilename;            /*+ The name of the temporary file (for the names). +*/

 uint32_t nlength;              /*+ How long is the string of name entries? +*/
};


/* Functions */


WaysX *NewWayList(int append);
void FreeWayList(WaysX *waysx,int keep);

void SaveWayList(WaysX *waysx,const char *filename);

index_t IndexWayX(WaysX* waysx,way_t id);
WayX *LookupWayX(WaysX* waysx,index_t index,int position);

void AppendWay(WaysX* waysx,way_t id,Way *way,const char *name);

void SortWayList(WaysX *waysx);

#endif /* WAYSX_H */
1	amb	110	/***************************************
2	amb	398	$Header: /home/amb/CVS/routino/src/waysx.h,v 1.21 2010-05-22 18:40:47 amb Exp $
3	amb	110
4			A header file for the extended Ways structure.
5	amb	151
6			Part of the Routino routing software.
7	amb	110	****************/ /****************
8	amb	326	This file Copyright 2008-2010 Andrew M. Bishop
9	amb	110
10	amb	151	This program is free software: you can redistribute it and/or modify
11			it under the terms of the GNU Affero General Public License as published by
12			the Free Software Foundation, either version 3 of the License, or
13			(at your option) any later version.
14
15			This program is distributed in the hope that it will be useful,
16			but WITHOUT ANY WARRANTY; without even the implied warranty of
17			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			GNU Affero General Public License for more details.
19
20			You should have received a copy of the GNU Affero General Public License
21			along with this program. If not, see <http://www.gnu.org/licenses/>.
22	amb	110	***************************************/
23
24
25			#ifndef WAYSX_H
26			#define WAYSX_H /+ To stop multiple inclusions. +/
27
28			#include <stdint.h>
29
30	amb	199	#include "typesx.h"
31	amb	110	#include "types.h"
32	amb	262	#include "ways.h"
33	amb	110
34
35			/* Data structures */
36
37
38			/+ An extended structure containing a single way. +/
39			struct _WayX
40			{
41	amb	203	way_t id; /+ The way identifier. +/
42
43	amb	310	index_t prop; /+ The index of the properties of the way in the compacted list. +/
44
45	amb	262	Way way; /+ The real Way data. +/
46	amb	110	};
47
48
49			/+ A structure containing a set of ways (memory format). +/
50			struct _WaysX
51			{
52	amb	262	char filename; /+ The name of the temporary file (for the WaysX). +*/
53			int fd; /+ The file descriptor of the temporary file (for the WaysX). +/
54	amb	216
55	amb	262	uint32_t xnumber; /+ The number of unsorted extended ways. +/
56	amb	216
57	amb	262	WayX xdata; /+ The extended data for the Ways (sorted). +*/
58			WayX cached[2]; /+ Two cached ways read from the file in slim mode. +/
59
60	amb	215	uint32_t number; /+ How many entries are still useful? +/
61	amb	110
62	amb	262	uint32_t cnumber; /+ How many entries are there after compacting? +/
63	amb	203
64	amb	310	index_t idata; /+ The index of the extended data for the Ways (sorted by ID). +*/
65	amb	203
66	amb	262	char nfilename; /+ The name of the temporary file (for the names). +*/
67	amb	203
68	amb	262	uint32_t nlength; /+ How long is the string of name entries? +/
69	amb	110	};
70
71
72			/* Functions */
73
74
75	amb	326	WaysX *NewWayList(int append);
76			void FreeWayList(WaysX *waysx,int keep);
77	amb	110
78	amb	398	void SaveWayList(WaysX waysx,const char filename);
79	amb	110
80	amb	262	index_t IndexWayX(WaysX* waysx,way_t id);
81			WayX LookupWayX(WaysX waysx,index_t index,int position);
82	amb	110
83	amb	262	void AppendWay(WaysX* waysx,way_t id,Way way,const char name);
84	amb	203
85	amb	110	void SortWayList(WaysX *waysx);
86
87			#endif /* WAYSX_H */