trunk/src/waysx.h

/***************************************
 A header file for the extended Ways structure.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2012 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 "types.h"

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

#include "files.h"


/* Data structures */


/*+ An extended structure containing a single way. +*/
struct _WayX
{
 way_t    id;                   /*+ The way identifier; initially the OSM value, later the Way index. +*/

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


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

 int      fd;                   /*+ The file descriptor of the open file (for the WaysX). +*/

 index_t  number;               /*+ The number of extended ways still being considered. +*/

#if !SLIM

 WayX    *data;                 /*+ The extended ways data (when mapped into memory). +*/

#else

 WayX     cached[3];            /*+ Three cached extended ways read from the file in slim mode. +*/
 index_t  incache[3];           /*+ The indexes of the cached extended ways. +*/

#endif

 index_t  inumber;              /*+ The number of extended way IDs in the idata array. +*/
 way_t   *idata;                /*+ The extended way IDs (sorted by ID). +*/

 index_t *cdata;                /*+ The compacted way IDs (same order as sorted ways). +*/

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

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

 uint32_t nlength;              /*+ The length of the string of name entries. +*/
};


/* Functions in waysx.c */


WaysX *NewWayList(int append,int readonly,int index);
void FreeWayList(WaysX *waysx,int preserve);

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

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

index_t IndexWayX(WaysX *waysx,way_t id);

void SortWayList(WaysX *waysx);

void ExtractWayNames(WaysX *waysx,int preserve);

void CompactWayList(WaysX *waysx,SegmentsX *segmentsx);


/* Macros / inline functions */

#if !SLIM

#define LookupWayX(waysx,index,position)  &(waysx)->data[index]
  
#define PutBackWayX(waysx,wayx)           /* nop */

#else

static WayX *LookupWayX(WaysX *waysx,index_t index,int position);

static void PutBackWayX(WaysX *waysx,WayX *wayx);


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended way with the specified id from the file on disk.

  WayX *LookupWayX Returns a pointer to a cached copy of the extended way.

  WaysX *waysx The set of ways to use.

  index_t index The way index to look for.

  int position The position in the cache to use.
  ++++++++++++++++++++++++++++++++++++++*/

static inline WayX *LookupWayX(WaysX *waysx,index_t index,int position)
{
 SeekReadFile(waysx->fd,&waysx->cached[position-1],sizeof(WayX),(off_t)index*sizeof(WayX));

 waysx->incache[position-1]=index;

 return(&waysx->cached[position-1]);
}


/*++++++++++++++++++++++++++++++++++++++
  Put back an extended way's data into the file on disk.

  WaysX *waysx The set of ways to use.

  WayX *wayx The extended way to be put back.
  ++++++++++++++++++++++++++++++++++++++*/

static inline void PutBackWayX(WaysX *waysx,WayX *wayx)
{
 int position1=wayx-&waysx->cached[0];

 SeekWriteFile(waysx->fd,&waysx->cached[position1],sizeof(WayX),(off_t)waysx->incache[position1]*sizeof(WayX));
}

#endif /* SLIM */


#endif /* WAYSX_H */
1	amb	110	/***************************************
2			A header file for the extended Ways structure.
3	amb	151
4			Part of the Routino routing software.
5	amb	110	****************/ /****************
6	amb	964	This file Copyright 2008-2012 Andrew M. Bishop
7	amb	110
8	amb	151	This program is free software: you can redistribute it and/or modify
9			it under the terms of the GNU Affero General Public License as published by
10			the Free Software Foundation, either version 3 of the License, or
11			(at your option) any later version.
12
13			This program is distributed in the hope that it will be useful,
14			but WITHOUT ANY WARRANTY; without even the implied warranty of
15			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			GNU Affero General Public License for more details.
17
18			You should have received a copy of the GNU Affero General Public License
19			along with this program. If not, see <http://www.gnu.org/licenses/>.
20	amb	110	***************************************/
21
22
23			#ifndef WAYSX_H
24			#define WAYSX_H /+ To stop multiple inclusions. +/
25
26			#include <stdint.h>
27
28	amb	449	#include "types.h"
29
30	amb	199	#include "typesx.h"
31	amb	262	#include "ways.h"
32	amb	110
33	amb	451	#include "files.h"
34	amb	110
35	amb	451
36	amb	110	/* Data structures */
37
38
39			/+ An extended structure containing a single way. +/
40			struct _WayX
41			{
42	amb	1100	way_t id; /+ The way identifier; initially the OSM value, later the Way index. +/
43	amb	203
44	amb	1090	Way way; /+ The real way data. +/
45	amb	110	};
46
47
48			/+ A structure containing a set of ways (memory format). +/
49			struct _WaysX
50			{
51	amb	1120	char filename; /+ The name of the intermediate file (for the WaysX). +*/
52			char filename_tmp; /+ The name of the temporary file (for the WaysX). +*/
53	amb	216
54	amb	1120	int fd; /+ The file descriptor of the open file (for the WaysX). +/
55
56	amb	650	index_t number; /+ The number of extended ways still being considered. +/
57	amb	216
58	amb	452	#if !SLIM
59
60	amb	651	WayX data; /+ The extended ways data (when mapped into memory). +*/
61	amb	262
62	amb	452	#else
63
64	amb	964	WayX cached[3]; /+ Three cached extended ways read from the file in slim mode. +/
65			index_t incache[3]; /+ The indexes of the cached extended ways. +/
66	amb	452
67			#endif
68
69	amb	1145	index_t inumber; /+ The number of extended way IDs in the idata array. +/
70	amb	755	way_t idata; /+ The extended way IDs (sorted by ID). +*/
71	amb	203
72	amb	1100	index_t cdata; /+ The compacted way IDs (same order as sorted ways). +*/
73	amb	1093
74	amb	1120	char nfilename_tmp; /+ The name of the temporary file (for the WaysX names). +*/
75	amb	203
76	amb	1120	int nfd; /+ The file descriptor of the temporary file (for the WaysX names). +/
77
78	amb	680	uint32_t nlength; /+ The length of the string of name entries. +/
79	amb	110	};
80
81
82	amb	680	/* Functions in waysx.c */
83	amb	110
84
85	amb	1145	WaysX *NewWayList(int append,int readonly,int index);
86	amb	1151	void FreeWayList(WaysX *waysx,int preserve);
87	amb	110
88	amb	1151	void AppendWay(WaysX waysx,way_t id,Way way,const char *name);
89			void FinishWayList(WaysX *waysx);
90
91	amb	398	void SaveWayList(WaysX waysx,const char filename);
92	amb	110
93	amb	682	index_t IndexWayX(WaysX *waysx,way_t id);
94	amb	110
95			void SortWayList(WaysX *waysx);
96
97	amb	1136	void ExtractWayNames(WaysX *waysx,int preserve);
98
99	amb	1100	void CompactWayList(WaysX waysx,SegmentsX segmentsx);
100	amb	451
101	amb	499
102	amb	452	/* Macros / inline functions */
103	amb	451
104	amb	452	#if !SLIM
105	amb	451
106	amb	651	#define LookupWayX(waysx,index,position) &(waysx)->data[index]
107	amb	452
108	amb	942	#define PutBackWayX(waysx,wayx) /* nop */
109	amb	557
110	amb	452	#else
111
112	amb	682	static WayX LookupWayX(WaysX waysx,index_t index,int position);
113	amb	452
114	amb	942	static void PutBackWayX(WaysX waysx,WayX wayx);
115	amb	452
116	amb	557
117	amb	451	/*++++++++++++++++++++++++++++++++++++++
118	amb	680	Lookup a particular extended way with the specified id from the file on disk.
119	amb	451
120	amb	680	WayX *LookupWayX Returns a pointer to a cached copy of the extended way.
121	amb	451
122	amb	682	WaysX *waysx The set of ways to use.
123	amb	451
124			index_t index The way index to look for.
125
126			int position The position in the cache to use.
127			++++++++++++++++++++++++++++++++++++++*/
128
129	amb	682	static inline WayX LookupWayX(WaysX waysx,index_t index,int position)
130	amb	451	{
131	amb	887	SeekReadFile(waysx->fd,&waysx->cached[position-1],sizeof(WayX),(off_t)index*sizeof(WayX));
132	amb	451
133	amb	942	waysx->incache[position-1]=index;
134
135	amb	651	return(&waysx->cached[position-1]);
136	amb	451	}
137
138	amb	505
139			/*++++++++++++++++++++++++++++++++++++++
140	amb	680	Put back an extended way's data into the file on disk.
141	amb	505
142	amb	682	WaysX *waysx The set of ways to use.
143	amb	505
144	amb	942	WayX *wayx The extended way to be put back.
145	amb	505	++++++++++++++++++++++++++++++++++++++*/
146
147	amb	942	static inline void PutBackWayX(WaysX waysx,WayX wayx)
148	amb	505	{
149	amb	942	int position1=wayx-&waysx->cached[0];
150
151			SeekWriteFile(waysx->fd,&waysx->cached[position1],sizeof(WayX),(off_t)waysx->incache[position1]*sizeof(WayX));
152	amb	505	}
153
154	amb	452	#endif /* SLIM */
155	amb	451
156	amb	452
157	amb	110	#endif /* WAYSX_H */