Imported Upstream version 1.5.1
[routino] / src / waysx.h
1 /***************************************
2  $Header: /home/amb/routino/src/RCS/waysx.h,v 1.28 2010/09/25 18:47:32 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-2010 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 "types.h"
31
32 #include "typesx.h"
33 #include "ways.h"
34
35 #include "files.h"
36
37
38 /* Data structures */
39
40
41 /*+ An extended structure containing a single way. +*/
42 struct _WayX
43 {
44  way_t    id;                   /*+ The way identifier. +*/
45
46  index_t  prop;                 /*+ The index of the properties of the way in the compacted list. +*/
47
48  Way      way;                  /*+ The real Way data. +*/
49 };
50
51
52 /*+ A structure containing a set of ways (memory format). +*/
53 struct _WaysX
54 {
55  char    *filename;             /*+ The name of the temporary file (for the WaysX). +*/
56  int      fd;                   /*+ The file descriptor of the temporary file (for the WaysX). +*/
57
58  index_t  xnumber;              /*+ The number of unsorted extended ways. +*/
59
60 #if !SLIM
61
62  WayX    *xdata;                /*+ The extended data for the Ways (sorted). +*/
63
64 #else
65
66  WayX     xcached[2];           /*+ Two cached ways read from the file in slim mode. +*/
67
68 #endif
69
70  index_t  number;               /*+ How many entries are still useful? +*/
71
72  index_t  cnumber;              /*+ How many entries are there after compacting? +*/
73
74  index_t *idata;                /*+ The index of the extended data for the Ways (sorted by ID). +*/
75
76  char    *nfilename;            /*+ The name of the temporary file (for the names). +*/
77
78  uint32_t nlength;              /*+ How long is the string of name entries? +*/
79 };
80
81
82 /* Functions */
83
84
85 WaysX *NewWayList(int append);
86 void FreeWayList(WaysX *waysx,int keep);
87
88 void SaveWayList(WaysX *waysx,const char *filename);
89
90 index_t IndexWayX(WaysX* waysx,way_t id);
91
92 void AppendWay(WaysX* waysx,way_t id,Way *way,const char *name);
93
94 void SortWayList(WaysX *waysx);
95
96 void CompactWayList(WaysX *waysx);
97
98
99 /* Macros / inline functions */
100
101 #if !SLIM
102
103 #define LookupWayX(waysx,index,position)  &(waysx)->xdata[index]
104   
105 #else
106
107 static WayX *LookupWayX(WaysX* waysx,index_t index,int position);
108
109
110 /*++++++++++++++++++++++++++++++++++++++
111   Lookup a particular extended way.
112
113   WayX *LookupWayX Returns a pointer to the extended way with the specified id.
114
115   WaysX* waysx The set of ways to process.
116
117   index_t index The way index to look for.
118
119   int position The position in the cache to use.
120   ++++++++++++++++++++++++++++++++++++++*/
121
122 static inline WayX *LookupWayX(WaysX* waysx,index_t index,int position)
123 {
124  SeekFile(waysx->fd,(off_t)index*sizeof(WayX));
125
126  ReadFile(waysx->fd,&waysx->xcached[position-1],sizeof(WayX));
127
128  return(&waysx->xcached[position-1]);
129 }
130
131
132 /*++++++++++++++++++++++++++++++++++++++
133   Put back an extended way.
134
135   WaysX* waysx The set of ways to process.
136
137   index_t index The way index to put back.
138
139   int position The position in the cache to use.
140   ++++++++++++++++++++++++++++++++++++++*/
141
142 static inline void PutBackWayX(WaysX* waysx,index_t index,int position)
143 {
144  SeekFile(waysx->fd,(off_t)index*sizeof(WayX));
145
146  WriteFile(waysx->fd,&waysx->xcached[position-1],sizeof(WayX));
147 }
148
149 #endif /* SLIM */
150
151
152 #endif /* WAYSX_H */