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

 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);
void FreeWayList(WaysX *waysx,int keep);

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

index_t IndexWayX(WaysX *waysx,way_t id);

void SortWayList(WaysX *waysx);

void ExtractWayNames(WaysX *waysx,int keep);

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

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


/* 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	/***************************************
2	A header file for the extended Ways structure.
3
4	Part of the Routino routing software.
5	****************/ /****************
6	This file Copyright 2008-2012 Andrew M. Bishop
7
8	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	***************************************/
21
22
23	#ifndef WAYSX_H
24	#define WAYSX_H /+ To stop multiple inclusions. +/
25
26	#include <stdint.h>
27
28	#include "types.h"
29
30	#include "typesx.h"
31	#include "ways.h"
32
33	#include "files.h"
34
35
36	/* Data structures */
37
38
39	/+ An extended structure containing a single way. +/
40	struct _WayX
41	{
42	way_t id; /+ The way identifier; initially the OSM value, later the Way index. +/
43
44	Way way; /+ The real way data. +/
45	};
46
47
48	/+ A structure containing a set of ways (memory format). +/
49	struct _WaysX
50	{
51	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
54	int fd; /+ The file descriptor of the open file (for the WaysX). +/
55
56	index_t number; /+ The number of extended ways still being considered. +/
57
58	#if !SLIM
59
60	WayX data; /+ The extended ways data (when mapped into memory). +*/
61
62	#else
63
64	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
67	#endif
68
69	way_t idata; /+ The extended way IDs (sorted by ID). +*/
70
71	index_t cdata; /+ The compacted way IDs (same order as sorted ways). +*/
72
73	char nfilename_tmp; /+ The name of the temporary file (for the WaysX names). +*/
74
75	int nfd; /+ The file descriptor of the temporary file (for the WaysX names). +/
76
77	uint32_t nlength; /+ The length of the string of name entries. +/
78	};
79
80
81	/* Functions in waysx.c */
82
83
84	WaysX *NewWayList(int append,int readonly);
85	void FreeWayList(WaysX *waysx,int keep);
86
87	void AppendWayList(WaysX waysx,way_t id,Way way,const char *name);
88	void FinishWayList(WaysX *waysx);
89
90	index_t IndexWayX(WaysX *waysx,way_t id);
91
92	void SortWayList(WaysX *waysx);
93
94	void ExtractWayNames(WaysX *waysx,int keep);
95
96	void CompactWayList(WaysX waysx,SegmentsX segmentsx);
97
98	void SaveWayList(WaysX waysx,const char filename);
99
100
101	/* Macros / inline functions */
102
103	#if !SLIM
104
105	#define LookupWayX(waysx,index,position) &(waysx)->data[index]
106
107	#define PutBackWayX(waysx,wayx) /* nop */
108
109	#else
110
111	static WayX LookupWayX(WaysX waysx,index_t index,int position);
112
113	static void PutBackWayX(WaysX waysx,WayX wayx);
114
115
116	/*++++++++++++++++++++++++++++++++++++++
117	Lookup a particular extended way with the specified id from the file on disk.
118
119	WayX *LookupWayX Returns a pointer to a cached copy of the extended way.
120
121	WaysX *waysx The set of ways to use.
122
123	index_t index The way index to look for.
124
125	int position The position in the cache to use.
126	++++++++++++++++++++++++++++++++++++++*/
127
128	static inline WayX LookupWayX(WaysX waysx,index_t index,int position)
129	{
130	SeekReadFile(waysx->fd,&waysx->cached[position-1],sizeof(WayX),(off_t)index*sizeof(WayX));
131
132	waysx->incache[position-1]=index;
133
134	return(&waysx->cached[position-1]);
135	}
136
137
138	/*++++++++++++++++++++++++++++++++++++++
139	Put back an extended way's data into the file on disk.
140
141	WaysX *waysx The set of ways to use.
142
143	WayX *wayx The extended way to be put back.
144	++++++++++++++++++++++++++++++++++++++*/
145
146	static inline void PutBackWayX(WaysX waysx,WayX wayx)
147	{
148	int position1=wayx-&waysx->cached[0];
149
150	SeekWriteFile(waysx->fd,&waysx->cached[position1],sizeof(WayX),(off_t)waysx->incache[position1]*sizeof(WayX));
151	}
152
153	#endif /* SLIM */
154
155
156	#endif /* WAYSX_H */