trunk/src/waysx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/waysx.h,v 1.6 2009-06-25 17:46:46 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. +*/

 char    *name;                 /*+ The name of the way. +*/

 Way     *way;                  /*+ A pointer to the real Way data. +*/
};


/*+ A structure containing a set of ways (memory format). +*/
struct _WaysX
{
 uint32_t sorted;               /*+ Is the data sorted? +*/
 uint32_t alloced;              /*+ How many entries are allocated? +*/
 uint32_t number;               /*+ How many entries are used? +*/
 uint32_t length;               /*+ How long is the string of name entries? +*/

 WayX    *xdata;                /*+ The extended data for the Ways (unsorted). +*/
 WayX   **ixdata;                /*+ The extended data for the Ways (sorted by ID). +*/
 WayX   **ndata;                /*+ The extended data for the Ways (sorted by name and way properties). +*/

 uint32_t wnumber;              /*+ How many way entries are used? +*/

 Way     *wdata;                /*+ The data for the Ways (unsorted). +*/

 char    *names;                /*+ The array containing all the names. +*/
};


/* Macros */
 
#define LookupWayInWayX(xxx,yyy) (&(xxx)->wdata[yyy])

#define IndexWayInWayX(xxx,yyy)  ((yyy->way)-&(xxx)->wdata[0])


/* Functions */


WaysX *NewWayList(void);

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

WayX *FindWayX(WaysX* waysx,way_t id);

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

void SortWayList(WaysX *waysx);

#endif /* WAYSX_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/waysx.h,v 1.6 2009-06-25 17:46:46 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	char name; /+ The name of the way. +*/
44
45	Way way; /+ A pointer to the real Way data. +*/
46	};
47
48
49	/+ A structure containing a set of ways (memory format). +/
50	struct _WaysX
51	{
52	uint32_t sorted; /+ Is the data sorted? +/
53	uint32_t alloced; /+ How many entries are allocated? +/
54	uint32_t number; /+ How many entries are used? +/
55	uint32_t length; /+ How long is the string of name entries? +/
56
57	WayX xdata; /+ The extended data for the Ways (unsorted). +*/
58	WayX *ixdata; /+ The extended data for the Ways (sorted by ID). +*/
59	WayX *ndata; /+ The extended data for the Ways (sorted by name and way properties). +*/
60
61	uint32_t wnumber; /+ How many way entries are used? +/
62
63	Way wdata; /+ The data for the Ways (unsorted). +*/
64
65	char names; /+ The array containing all the names. +*/
66	};
67
68
69	/* Macros */
70
71	#define LookupWayInWayX(xxx,yyy) (&(xxx)->wdata[yyy])
72
73	#define IndexWayInWayX(xxx,yyy) ((yyy->way)-&(xxx)->wdata[0])
74
75
76	/* Functions */
77
78
79	WaysX *NewWayList(void);
80
81	void SaveWayList(WaysX waysx,const char filename);
82
83	WayX FindWayX(WaysX waysx,way_t id);
84
85	Way AppendWay(WaysX waysx,way_t id,const char *name);
86
87	void SortWayList(WaysX *waysx);
88
89	#endif /* WAYSX_H */