source: git/src/cavern.h @ c092d72

RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-data
Last change on this file since c092d72 was c092d72, checked in by Olly Betts <olly@…>, 10 years ago

lib/survex.pot,src/,tests/: More work on *cs.

  • Property mode set to 100644
File size: 13.8 KB
Line 
1/* cavern.h
2 * SURVEX Cave surveying software - header file
3 * Copyright (C) 1991-2003,2005,2006,2010,2013,2014 Olly Betts
4 * Copyright (C) 2004 Simeon Warner
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19 */
20
21#ifndef CAVERN_H
22#define CAVERN_H
23
24/* Using covariances increases the memory required somewhat - may be
25 * desirable to disable this for small memory machines */
26
27/* #define NO_COVARIANCES 1 */
28
29#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
32#include <ctype.h>
33#include <math.h>
34#include <float.h>
35
36#include <proj_api.h>
37
38#include "img_hosted.h"
39#include "useful.h"
40
41/* Set EXPLICIT_FIXED_FLAG to 1 to force an explicit fixed flag to be used
42 * in each pos struct, rather than using p[0]==UNFIXED_VAL to indicate
43 * unfixed-ness.  This may be slightly faster, but uses more memory.
44 */
45#ifndef EXPLICIT_FIXED_FLAG
46# define EXPLICIT_FIXED_FLAG 0
47#endif
48
49typedef double real; /* so we can change the precision used easily */
50#define HUGE_REAL HUGE_VAL
51#define REAL_EPSILON DBL_EPSILON
52
53#if (!EXPLICIT_FIXED_FLAG)
54# define UNFIXED_VAL HUGE_VAL /* if p[0]==UNFIXED_VAL, station is unfixed */
55#endif
56
57#define SPECIAL_EOL             0x0001
58#define SPECIAL_BLANK           0x0002
59#define SPECIAL_KEYWORD         0x0004
60#define SPECIAL_COMMENT         0x0008
61#define SPECIAL_OMIT            0x0010
62#ifndef NO_DEPRECATED
63#define SPECIAL_ROOT            0x0020
64#endif
65#define SPECIAL_SEPARATOR       0x0040
66#define SPECIAL_NAMES           0x0080
67#define SPECIAL_DECIMAL         0x0100
68#define SPECIAL_MINUS           0x0200
69#define SPECIAL_PLUS            0x0400
70#define SPECIAL_OPEN            0x0800
71#define SPECIAL_CLOSE           0x1000
72
73extern char *fnm_output_base;
74extern int fnm_output_base_is_dir;
75
76extern bool fExportUsed;
77
78extern int current_days_since_1900;
79
80/* Types */
81
82typedef enum {
83   Q_NULL = -1, Q_DEFAULT, Q_LENGTH, Q_DEPTH, Q_DX, Q_DY, Q_DZ, Q_COUNT, Q_POS,
84   Q_BEARING, Q_BACKBEARING, Q_GRADIENT, Q_BACKGRADIENT, Q_DECLINATION,
85   Q_PLUMB, Q_LEVEL, Q_LEFT, Q_RIGHT, Q_UP, Q_DOWN, Q_MAC
86} q_quantity;
87
88typedef enum {
89   INFER_NULL = -1, INFER_EQUATES, INFER_EXPORTS, INFER_PLUMBS, INFER_SUBSURVEYS
90} infer_what;
91
92/* unsigned long to cope with 16-bit int-s */
93#define BIT(N) (1UL << (N))
94#define BITA(N) (1UL << ((N) - 'a'))
95
96#define TSTBIT(W, N) (((W)>>(N))&1)
97
98/* masks for quantities which are length and angles respectively */
99#define LEN_QMASK (BIT(Q_LENGTH) | BIT(Q_DEPTH) |\
100   BIT(Q_DX) | BIT(Q_DY) | BIT(Q_DZ) | BIT(Q_POS) | BIT(Q_COUNT))
101#define ANG_QMASK (BIT(Q_BEARING) | BIT(Q_BACKBEARING) |\
102   BIT(Q_GRADIENT) | BIT(Q_BACKGRADIENT) | BIT(Q_PLUMB) | BIT(Q_LEVEL) |\
103   BIT(Q_DECLINATION))
104
105/* if you add/change the order, check factor_tab in commands.c */
106typedef enum {
107   UNITS_NULL = -1, UNITS_METRES, UNITS_FEET, UNITS_YARDS,
108   UNITS_DEGS, UNITS_GRADS, UNITS_PERCENT, UNITS_MINUTES, UNITS_MAC
109} u_units;
110
111/* don't reorder these values!  They need to match with img.h too */
112typedef enum {
113   FLAGS_NOT = -2, FLAGS_UNKNOWN = -1, FLAGS_SURFACE, FLAGS_DUPLICATE,
114   FLAGS_SPLAY,
115#if 0
116   /* underground, but through rock (e.g. radiolocation).  Want to hide from
117    * plots by default (so not cave) but don't want to include in surface
118    * triangulation nets (so not surface) */
119   FLAGS_SKELETAL, /* FIXME */
120#endif
121   /* Don't need to match img.h: */
122   FLAGS_ANON_ONE_END,
123   FLAGS_IMPLICIT_SPLAY,
124   FLAGS_STYLE_BIT0, FLAGS_STYLE_BIT1, FLAGS_STYLE_BIT2
125} flags;
126
127/* flags are currently stored in an unsigned char */
128typedef int compiletimeassert_flags0[FLAGS_STYLE_BIT2 <= 7 ? 1 : -1];
129
130/* Mask to AND with to get bits to pass to img library. */
131#define FLAGS_MASK \
132    (BIT(FLAGS_SURFACE) | BIT(FLAGS_DUPLICATE) | BIT(FLAGS_SPLAY))
133
134typedef int compiletimeassert_flags1[BIT(FLAGS_SURFACE) == img_FLAG_SURFACE ? 1 : -1];
135typedef int compiletimeassert_flags2[BIT(FLAGS_DUPLICATE) == img_FLAG_DUPLICATE ? 1 : -1];
136typedef int compiletimeassert_flags3[BIT(FLAGS_SPLAY) == img_FLAG_SPLAY ? 1 : -1];
137
138typedef enum {
139   /* Don't reorder these values!  They need to match with img.h too. */
140   SFLAGS_SURFACE = 0, SFLAGS_UNDERGROUND, SFLAGS_ENTRANCE, SFLAGS_EXPORTED,
141   SFLAGS_FIXED, SFLAGS_ANON, SFLAGS_WALL,
142   /* These values don't need to match img.h, but mustn't clash. */
143   SFLAGS_USED = 11,
144   SFLAGS_SOLVED = 12, SFLAGS_SUSPECTTYPO = 13, SFLAGS_SURVEY = 14, SFLAGS_PREFIX_ENTERED = 15
145} sflags;
146
147/* Mask to AND with to get bits to pass to img library. */
148#define SFLAGS_MASK (BIT(SFLAGS_SURFACE) | BIT(SFLAGS_UNDERGROUND) |\
149        BIT(SFLAGS_ENTRANCE) | BIT(SFLAGS_EXPORTED) | BIT(SFLAGS_FIXED) |\
150        BIT(SFLAGS_ANON) | BIT(SFLAGS_WALL))
151
152typedef int compiletimeassert_sflags1[BIT(SFLAGS_SURFACE) == img_SFLAG_SURFACE ? 1 : -1];
153typedef int compiletimeassert_sflags2[BIT(SFLAGS_UNDERGROUND) == img_SFLAG_UNDERGROUND ? 1 : -1];
154typedef int compiletimeassert_sflags3[BIT(SFLAGS_ENTRANCE) == img_SFLAG_ENTRANCE ? 1 : -1];
155typedef int compiletimeassert_sflags4[BIT(SFLAGS_EXPORTED) == img_SFLAG_EXPORTED ? 1 : -1];
156typedef int compiletimeassert_sflags5[BIT(SFLAGS_FIXED) == img_SFLAG_FIXED ? 1 : -1];
157typedef int compiletimeassert_sflags6[BIT(SFLAGS_ANON) == img_SFLAG_ANON ? 1 : -1];
158typedef int compiletimeassert_sflags7[BIT(SFLAGS_WALL) == img_SFLAG_WALL ? 1 : -1];
159
160/* enumeration of field types */
161typedef enum {
162   End = 0, Tape, Comp, Clino, BackComp, BackClino, Left, Right, Up, Down,
163   FrDepth, ToDepth, Dx, Dy, Dz, FrCount, ToCount,
164   /* Up to here are readings are allowed multiple values
165    * and have slot in the value[] array in datain.c.
166    * (Depth, DepthChange, and Count can have multiple
167    * readings, but are actually handled using tokens
168    * above rather than as themselves).
169    *
170    * Fr must be the first reading after this comment!
171    */
172   Fr, To, Station, Depth, DepthChange, Count, Dir,
173   Newline, IgnoreAllAndNewLine, Ignore, IgnoreAll,
174   /* IgnoreAll must be the last reading before this comment!
175    *
176    * Readings after this comment are only used in datain.c
177    * so can have enum values >= 32 because we only use a
178    * bitmask for those readings used in commands.c.
179    */
180   CompassDATComp, CompassDATClino, CompassDATBackComp, CompassDATBackClino,
181   CompassDATLeft, CompassDATRight, CompassDATUp, CompassDATDown,
182   CompassDATFlags
183} reading;
184/* Tape Comp Clino BackComp BackClino FrDepth ToDepth Dx Dy Dz FrCount ToCount */
185
186/* if IgnoreAll is >= 32, the compiler will choke on this */
187typedef char compiletimeassert_reading[IgnoreAll < 32 ? 1 : -1];
188
189/* position or length vector */
190typedef real delta[3];
191
192/* variance */
193#ifdef NO_COVARIANCES
194typedef real var[3];
195typedef var svar;
196#else
197typedef real var[3][3];
198typedef real svar[6];
199#endif
200
201/* station name */
202typedef struct Prefix {
203   struct Prefix *up, *down, *right;
204   struct Node *stn;
205   struct Pos *pos;
206   const char *ident;
207   const char *filename;
208   unsigned int line;
209   /* If (min_export == 0) then max_export is max # levels above is this
210    * prefix is used (and so needs to be exported) (0 == parent only).
211    * If (min_export > 0) then max_export is max # levels above this
212    * prefix has been exported, and min_export is how far down the exports
213    * have got (if min_export > 1 after a run, this prefix hasn't been
214    * exported from below enough).
215    * If INFER_EXPORTS is active when a station is encountered, we
216    * set min_export = USHRT_MAX and max_export gets set as usual.  Then at
217    * the end of the run, we also mark stations with min_export == USHRT_MAX
218    * and max_export > 0 as exported. */
219   unsigned short max_export, min_export;
220   /* stn flags - e.g. surface, underground, entrance
221    * also suspecttypo and survey */
222   unsigned short sflags;
223   short shape;
224} prefix;
225
226/* survey metadata */
227typedef struct Meta_data {
228    size_t ref_count;
229    int days1, days2;
230} meta_data;
231
232/* stuff stored for both forward & reverse legs */
233typedef struct {
234   struct Node *to;
235   /* bits 0..1 = reverse leg number; bit7 is fFullLeg */
236   /* bit6 = fReplacementLeg (by reduction rules) */
237   /* bit5 = articulation leg (i.e. carries no error) */
238   unsigned char reverse;
239   /* flags - e.g. surface, duplicate survey
240    * only used if (FLAG_DATAHERE & !(FLAG_REPLACEMENTLEG|FLAG_FAKE))
241    * This could be only in linkfor, but this is actually more space
242    * efficient.
243    */
244   unsigned char flags;
245} linkcommon;
246
247#define FLAG_DATAHERE 0x80
248#define FLAG_REPLACEMENTLEG 0x40
249#define FLAG_ARTICULATION 0x20
250#define FLAG_FAKE 0x10 /* an equate or leg inside an sdfix */
251#define MASK_REVERSEDIRN 0x03
252
253/* reverse leg - deltas & vars stored on other dirn */
254typedef struct LinkRev {
255   linkcommon l;
256} linkrev;
257
258/* forward leg - deltas & vars stored here */
259typedef struct Link {
260   linkcommon l;
261   delta d; /* Delta */
262   svar v; /* Variances */
263   meta_data *meta;
264} linkfor;
265
266/* node - like a station, except several nodes are used to represent a
267 * station with more than 3 legs connected to it
268 */
269typedef struct Node {
270   struct Prefix *name;
271   struct Link *leg[3];
272   struct Node *prev, *next;
273   long colour;
274} node;
275
276/* station position */
277typedef struct Pos {
278   delta p; /* Position */
279#if EXPLICIT_FIXED_FLAG
280   unsigned char fFixed; /* flag indicating if station is a fixed point */
281#endif
282} pos;
283
284/*
285typedef struct Inst {
286   real zero, scale, units;
287} inst;
288*/
289
290/* Survey data styles */
291#define STYLE_NORMAL     0
292#define STYLE_DIVING     1
293#define STYLE_CARTESIAN  2
294#define STYLE_CYLPOLAR   3
295#define STYLE_NOSURVEY   4
296#define STYLE_PASSAGE    5
297#define STYLE_IGNORE     6
298
299typedef int compiletimeassert_style1[STYLE_NORMAL == img_STYLE_NORMAL ? 1 : -1];
300typedef int compiletimeassert_style2[STYLE_DIVING == img_STYLE_DIVING ? 1 : -1];
301typedef int compiletimeassert_style3[STYLE_CARTESIAN == img_STYLE_CARTESIAN ? 1 : -1];
302typedef int compiletimeassert_style4[STYLE_CYLPOLAR == img_STYLE_CYLPOLAR ? 1 : -1];
303typedef int compiletimeassert_style5[STYLE_NOSURVEY == img_STYLE_NOSURVEY ? 1 : -1];
304
305/* various settings preserved by *BEGIN and *END */
306typedef struct Settings {
307   struct Settings *next;
308   unsigned int Truncate;
309   bool f_clino_percent;
310   bool f_backclino_percent;
311   bool dash_for_anon_wall_station;
312   unsigned char infer;
313   enum {OFF, LOWER, UPPER} Case;
314   int style;
315   prefix *Prefix;
316   prefix *begin_survey; /* used to check BEGIN and END match */
317   short *Translate; /* if short is >= 16 bits, which ANSI requires */
318   real Var[Q_MAC];
319   real z[Q_MAC];
320   real sc[Q_MAC];
321   real units[Q_MAC];
322   reading *ordering;
323   int begin_lineno; /* 0 means no block started in this file */
324   int flags;
325   projPJ proj;
326   meta_data * meta;
327} settings;
328
329/* global variables */
330extern settings *pcs;
331extern prefix *root;
332extern prefix *anon_list;
333extern node *stnlist;
334extern unsigned long optimize;
335extern projPJ proj_out;
336extern char * proj_str_out;
337
338extern char *survey_title;
339extern int survey_title_len;
340
341extern bool fExplicitTitle;
342extern long cLegs, cStns, cComponents;
343extern FILE *fhErrStat;
344extern img *pimg;
345#ifndef NO_PERCENTAGE
346extern bool fPercent;
347#endif
348extern real totadj, total, totplan, totvert;
349extern real min[3], max[3];
350extern prefix *pfxHi[3], *pfxLo[3];
351extern bool fQuiet; /* just show brief summary + errors */
352extern bool fMute; /* just show errors */
353extern bool fSuppress; /* only output 3d file */
354
355/* macros */
356
357#define POS(S, D) ((S)->name->pos->p[(D)])
358#define POSD(S) ((S)->name->pos->p)
359
360#define data_here(L) ((L)->l.reverse & FLAG_DATAHERE)
361#define reverse_leg_dirn(L) ((L)->l.reverse & MASK_REVERSEDIRN)
362#define reverse_leg(L) ((L)->l.to->leg[reverse_leg_dirn(L)])
363
364#if EXPLICIT_FIXED_FLAG
365# define pfx_fixed(N) ((N)->pos->fFixed)
366# define pos_fixed(P) ((P)->fFixed)
367# define fix(S) (S)->name->pos->fFixed = (char)fTrue
368# define fixpos(P) (P)->fFixed = (char)fTrue
369# define unfix(S) (S)->name->pos->fFixed = (char)fFalse
370#else
371# define pfx_fixed(N) ((N)->pos->p[0] != UNFIXED_VAL)
372# define pos_fixed(P) ((P)->p[0] != UNFIXED_VAL)
373# define fix(S) NOP
374# define fixpos(P) NOP
375# define unfix(S) POS((S), 0) = UNFIXED_VAL
376#endif
377#define fixed(S) pfx_fixed((S)->name)
378
379/* macros for special chars */
380
381#define isEol(c)    (pcs->Translate[(c)] & SPECIAL_EOL)
382#define isBlank(c)  (pcs->Translate[(c)] & SPECIAL_BLANK)
383#define isKeywd(c)  (pcs->Translate[(c)] & SPECIAL_KEYWORD)
384#define isComm(c)   (pcs->Translate[(c)] & SPECIAL_COMMENT)
385#define isOmit(c)   (pcs->Translate[(c)] & SPECIAL_OMIT)
386#ifndef NO_DEPRECATED
387#define isRoot(c)   (pcs->Translate[(c)] & SPECIAL_ROOT)
388#endif
389#define isSep(c)    (pcs->Translate[(c)] & SPECIAL_SEPARATOR)
390#define isNames(c)  (pcs->Translate[(c)] & SPECIAL_NAMES)
391#define isDecimal(c) (pcs->Translate[(c)] & SPECIAL_DECIMAL)
392#define isMinus(c)  (pcs->Translate[(c)] & SPECIAL_MINUS)
393#define isPlus(c)   (pcs->Translate[(c)] & SPECIAL_PLUS)
394#define isOpen(c)   (pcs->Translate[(c)] & SPECIAL_OPEN)
395#define isClose(c)  (pcs->Translate[(c)] & SPECIAL_CLOSE)
396
397#define isSign(c)   (pcs->Translate[(c)] & (SPECIAL_PLUS | SPECIAL_MINUS))
398#define isData(c)   (pcs->Translate[(c)] & (SPECIAL_OMIT | SPECIAL_ROOT|\
399   SPECIAL_SEPARATOR | SPECIAL_NAMES | SPECIAL_DECIMAL | SPECIAL_PLUS |\
400   SPECIAL_MINUS))
401
402typedef struct nosurveylink {
403   node *fr, *to;
404   int flags;
405   meta_data *meta;
406   struct nosurveylink *next;
407} nosurveylink;
408
409extern nosurveylink *nosurveyhead;
410
411typedef struct lrud {
412    struct lrud * next;
413    prefix *stn;
414    meta_data *meta;
415    real l, r, u, d;
416} lrud;
417
418typedef struct lrudlist {
419    lrud * tube;
420    struct lrudlist * next;
421} lrudlist;
422
423extern lrudlist * model;
424
425extern lrud ** next_lrud;
426
427#endif /* CAVERN_H */
Note: See TracBrowser for help on using the repository browser.