trunk/src/waysx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/waysx.h,v 1.17 2009-10-09 18:47:40 amb Exp $

 A header file for the extended Ways structure.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008,2009 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. +*/

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

 index_t  name;                 /*+ The index of the name of the way. +*/
};


/*+ 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 extended data for the Ways (sorted by ID). +*/

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

 char    *names;                /*+ The names of the ways (unsorted). +*/

 uint32_t nnumber;              /*+ How many names are there after compacting? +*/

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


/* Functions */


WaysX *NewWayList(void);
void FreeWayList(WaysX *waysx);

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);

void CompactWayNames(WaysX* waysx);
void CompactWayProperties(WaysX* waysx);

#endif /* WAYSX_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/waysx.h,v 1.17 2009-10-09 18:47:40 amb Exp $
3
4	A header file for the extended Ways structure.
5
6	Part of the Routino routing software.
7	****************/ /****************
8	This file Copyright 2008,2009 Andrew M. Bishop
9
10	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	***************************************/
23
24
25	#ifndef WAYSX_H
26	#define WAYSX_H /+ To stop multiple inclusions. +/
27
28	#include <stdint.h>
29
30	#include "typesx.h"
31	#include "types.h"
32	#include "ways.h"
33
34
35	/* Data structures */
36
37
38	/+ An extended structure containing a single way. +/
39	struct _WayX
40	{
41	way_t id; /+ The way identifier. +/
42
43	Way way; /+ The real Way data. +/
44
45	index_t name; /+ The index of the name of the way. +/
46	};
47
48
49	/+ A structure containing a set of ways (memory format). +/
50	struct _WaysX
51	{
52	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
55	uint32_t xnumber; /+ The number of unsorted extended ways. +/
56
57	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	uint32_t number; /+ How many entries are still useful? +/
61
62	uint32_t cnumber; /+ How many entries are there after compacting? +/
63
64	index_t idata; /+ The extended data for the Ways (sorted by ID). +*/
65
66	char nfilename; /+ The name of the temporary file (for the names). +*/
67	int nfd; /+ The file descriptor of the temporary file (for the names). +/
68
69	char names; /+ The names of the ways (unsorted). +*/
70
71	uint32_t nnumber; /+ How many names are there after compacting? +/
72
73	uint32_t nlength; /+ How long is the string of name entries? +/
74	};
75
76
77	/* Functions */
78
79
80	WaysX *NewWayList(void);
81	void FreeWayList(WaysX *waysx);
82
83	void SaveWayList(WaysX waysx,const char filename);
84
85	index_t IndexWayX(WaysX* waysx,way_t id);
86	WayX LookupWayX(WaysX waysx,index_t index,int position);
87
88	void AppendWay(WaysX* waysx,way_t id,Way way,const char name);
89
90	void SortWayList(WaysX *waysx);
91
92	void CompactWayNames(WaysX* waysx);
93	void CompactWayProperties(WaysX* waysx);
94
95	#endif /* WAYSX_H */