Imported Upstream version 1.4.1
[routino] / src / waysx.h
1 /***************************************
2  $Header: /home/amb/routino/src/RCS/waysx.h,v 1.21 2010/05/22 18:40:47 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 "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  index_t  prop;                 /*+ The index of the properties of the way in the compacted list. +*/
44
45  Way      way;                  /*+ The real Way data. +*/
46 };
47
48
49 /*+ A structure containing a set of ways (memory format). +*/
50 struct _WaysX
51 {
52  char    *filename;             /*+ The name of the temporary file (for the WaysX). +*/
53  int      fd;                   /*+ The file descriptor of the temporary file (for the WaysX). +*/
54
55  uint32_t xnumber;              /*+ The number of unsorted extended ways. +*/
56
57  WayX    *xdata;                /*+ The extended data for the Ways (sorted). +*/
58  WayX     cached[2];            /*+ Two cached ways read from the file in slim mode. +*/
59
60  uint32_t number;               /*+ How many entries are still useful? +*/
61
62  uint32_t cnumber;              /*+ How many entries are there after compacting? +*/
63
64  index_t *idata;                /*+ The index of the extended data for the Ways (sorted by ID). +*/
65
66  char    *nfilename;            /*+ The name of the temporary file (for the names). +*/
67
68  uint32_t nlength;              /*+ How long is the string of name entries? +*/
69 };
70
71
72 /* Functions */
73
74
75 WaysX *NewWayList(int append);
76 void FreeWayList(WaysX *waysx,int keep);
77
78 void SaveWayList(WaysX *waysx,const char *filename);
79
80 index_t IndexWayX(WaysX* waysx,way_t id);
81 WayX *LookupWayX(WaysX* waysx,index_t index,int position);
82
83 void AppendWay(WaysX* waysx,way_t id,Way *way,const char *name);
84
85 void SortWayList(WaysX *waysx);
86
87 #endif /* WAYSX_H */