Imported Upstream version 1.5.1
[routino] / src / ways.h
1 /***************************************
2  $Header: /home/amb/routino/src/RCS/ways.h,v 1.42 2010/08/30 12:32:07 amb Exp $
3
4  A header file for the ways.
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 WAYS_H
26 #define WAYS_H    /*+ To stop multiple inclusions. +*/
27
28 #include <stdint.h>
29 #include <stdlib.h>
30
31 #include "types.h"
32
33 #include "files.h"
34
35
36 /* Data structures */
37
38
39 /*+ A structure containing a single way (members ordered to minimise overall size). +*/
40 struct _Way
41 {
42  index_t    name;               /*+ The offset of the name of the way in the names array. +*/
43
44  allow_t    allow;              /*+ The type of traffic allowed on the way. +*/
45
46  waytype_t  type;               /*+ The highway type of the way. +*/
47
48  wayprop_t  props;              /*+ The properties of the way. +*/
49
50  speed_t    speed;              /*+ The defined maximum speed limit of the way. +*/
51
52  weight_t   weight;             /*+ The defined maximum weight of traffic on the way. +*/
53  height_t   height;             /*+ The defined maximum height of traffic on the way. +*/
54  width_t    width;              /*+ The defined maximum width of traffic on the way. +*/
55  length_t   length;             /*+ The defined maximum length of traffic on the way. +*/
56 };
57
58
59 /*+ A structure containing the header from the file. +*/
60 typedef struct _WaysFile
61 {
62  index_t    number;             /*+ How many ways are stored? +*/
63  index_t    onumber;            /*+ How many ways were there originally? +*/
64
65  allow_t    allow;              /*+ The types of traffic that were seen when parsing. +*/
66  wayprop_t  props;              /*+ The properties that were seen when parsing. +*/
67 }
68  WaysFile;
69
70
71 /*+ A structure containing a set of ways (and pointers to mmap file). +*/
72 struct _Ways
73 {
74  WaysFile file;                 /*+ The header data from the file. +*/
75
76 #if !SLIM
77
78  void      *data;               /*+ The memory mapped data. +*/
79
80  Way       *ways;               /*+ An array of ways. +*/
81  char      *names;              /*+ An array of characters containing the names. +*/
82
83 #else
84
85  int        fd;                 /*+ The file descriptor for the file. +*/
86  off_t      namesoffset;        /*+ The offset of the names within the file. +*/
87
88  Way        wcached[2];         /*+ The cached ways. +*/
89
90  char      *ncached;            /*+ The cached way name. +*/
91  index_t    nincache;           /*+ The index of the cached way name. +*/
92  int        nalloc;             /*+ The amount of memory allocated for the way name. +*/
93
94 #endif
95 };
96
97
98 /* Functions */
99
100 Ways *LoadWayList(const char *filename);
101
102 int WaysCompare(Way *way1,Way *way2);
103
104
105 /* Macros and inline functions */
106
107 #if !SLIM
108
109 /*+ Return a Way* pointer given a set of ways and an index. +*/
110 #define LookupWay(xxx,yyy,zzz)     (&(xxx)->ways[yyy])
111
112 /*+ Return the name of a way given the Way pointer and a set of ways. +*/
113 #define WayName(xxx,yyy)           (&(xxx)->names[(yyy)->name])
114
115 #else
116
117 static Way *LookupWay(Ways *ways,index_t index,int position);
118
119 static char *WayName(Ways *ways,Way *way);
120
121
122 /*++++++++++++++++++++++++++++++++++++++
123   Find the Way information for a particular way.
124
125   Way *LookupWay Returns a pointer to the cached way information.
126
127   Ways *ways The ways structure to use.
128
129   index_t index The index of the way.
130
131   int position The position in the cache to store the value.
132   ++++++++++++++++++++++++++++++++++++++*/
133
134 static inline Way *LookupWay(Ways *ways,index_t index,int position)
135 {
136  SeekFile(ways->fd,sizeof(WaysFile)+(off_t)index*sizeof(Way));
137
138  ReadFile(ways->fd,&ways->wcached[position-1],sizeof(Way));
139
140  return(&ways->wcached[position-1]);
141 }
142
143
144 /*++++++++++++++++++++++++++++++++++++++
145   Find the name of a way.
146
147   char *WayName Returns a pointer to the name of the way.
148
149   Ways *ways The ways structure to use.
150
151   Way *way The Way pointer.
152   ++++++++++++++++++++++++++++++++++++++*/
153
154 static inline char *WayName(Ways *ways,Way *way)
155 {
156  int n=0;
157
158  if(way->name==ways->nincache)
159     return(ways->ncached);
160
161  SeekFile(ways->fd,ways->namesoffset+way->name);
162
163  if(!ways->ncached)
164     ways->ncached=(char*)malloc(32);
165
166  while(1)
167    {
168     int i;
169     int m=ReadFile(ways->fd,ways->ncached+n,32);
170
171     if(m<0)
172        break;
173     
174     for(i=n;i<n+32;i++)
175        if(ways->ncached[i]==0)
176           goto exitloop;
177
178     n+=32;
179
180     ways->ncached=(char*)realloc((void*)ways->ncached,n+32);
181    }
182
183  exitloop:
184
185  return(ways->ncached);
186 }
187
188 #endif
189
190
191 #endif /* WAYS_H */