2 * SURVEX Cave surveying software - header file
3 * Copyright (C) 1991-2003,2005,2006,2010,2013,2014,2015,2016 Olly Betts
4 * Copyright (C) 2004 Simeon Warner
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.
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.
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
24 /* Using covariances increases the memory required somewhat - may be
25 * desirable to disable this for small memory machines */
27 /* #define NO_COVARIANCES 1 */
38 #include "img_hosted.h"
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.
45 #ifndef EXPLICIT_FIXED_FLAG
46 # define EXPLICIT_FIXED_FLAG 0
49 typedef double real
; /* so we can change the precision used easily */
50 #define HUGE_REAL HUGE_VAL
51 #define REAL_EPSILON DBL_EPSILON
53 #if (!EXPLICIT_FIXED_FLAG)
54 # define UNFIXED_VAL HUGE_VAL /* if p[0]==UNFIXED_VAL, station is unfixed */
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
63 #define SPECIAL_ROOT 0x0020
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
73 extern char *fnm_output_base
;
74 extern int fnm_output_base_is_dir
;
76 extern bool fExportUsed
;
78 extern int current_days_since_1900
;
83 Q_NULL
= -1, Q_DEFAULT
, Q_POS
, Q_PLUMB
, Q_LEVEL
,
84 Q_GRADIENT
, Q_BACKGRADIENT
, Q_BEARING
, Q_BACKBEARING
,
85 Q_LENGTH
, Q_BACKLENGTH
, Q_DEPTH
, Q_DX
, Q_DY
, Q_DZ
, Q_COUNT
, Q_DECLINATION
,
86 Q_LEFT
, Q_RIGHT
, Q_UP
, Q_DOWN
,
91 INFER_NULL
= -1, INFER_EQUATES
, INFER_EXPORTS
, INFER_PLUMBS
, INFER_SUBSURVEYS
94 /* unsigned long to cope with 16-bit int-s */
95 #define BIT(N) (1UL << (N))
96 #define BITA(N) (1UL << ((N) - 'a'))
98 #define TSTBIT(W, N) (((W)>>(N))&1)
100 /* masks for quantities which are length and angles respectively */
101 #define LEN_QMASK (BIT(Q_LENGTH) | BIT(Q_BACKLENGTH) | BIT(Q_DEPTH) |\
102 BIT(Q_DX) | BIT(Q_DY) | BIT(Q_DZ) | BIT(Q_POS) | BIT(Q_COUNT))
103 #define ANG_QMASK (BIT(Q_BEARING) | BIT(Q_BACKBEARING) |\
104 BIT(Q_GRADIENT) | BIT(Q_BACKGRADIENT) | BIT(Q_PLUMB) | BIT(Q_LEVEL) |\
107 /* if you add/change the order, check factor_tab in commands.c */
109 UNITS_NULL
= -1, UNITS_METRES
, UNITS_FEET
, UNITS_YARDS
,
110 UNITS_DEGS
, UNITS_GRADS
, UNITS_PERCENT
, UNITS_MINUTES
, UNITS_MAC
113 /* don't reorder these values! They need to match with img.h too */
115 FLAGS_NOT
= -2, FLAGS_UNKNOWN
= -1, FLAGS_SURFACE
, FLAGS_DUPLICATE
,
118 /* underground, but through rock (e.g. radiolocation). Want to hide from
119 * plots by default (so not cave) but don't want to include in surface
120 * triangulation nets (so not surface) */
121 FLAGS_SKELETAL
, /* FIXME */
123 /* Don't need to match img.h: */
125 FLAGS_IMPLICIT_SPLAY
,
126 FLAGS_STYLE_BIT0
, FLAGS_STYLE_BIT1
, FLAGS_STYLE_BIT2
129 /* flags are currently stored in an unsigned char */
130 typedef int compiletimeassert_flags0
[FLAGS_STYLE_BIT2
<= 7 ? 1 : -1];
132 /* Mask to AND with to get bits to pass to img library. */
134 (BIT(FLAGS_SURFACE) | BIT(FLAGS_DUPLICATE) | BIT(FLAGS_SPLAY))
136 typedef int compiletimeassert_flags1
[BIT(FLAGS_SURFACE
) == img_FLAG_SURFACE
? 1 : -1];
137 typedef int compiletimeassert_flags2
[BIT(FLAGS_DUPLICATE
) == img_FLAG_DUPLICATE
? 1 : -1];
138 typedef int compiletimeassert_flags3
[BIT(FLAGS_SPLAY
) == img_FLAG_SPLAY
? 1 : -1];
141 /* Don't reorder these values! They need to match with img.h too. */
142 SFLAGS_SURFACE
= 0, SFLAGS_UNDERGROUND
, SFLAGS_ENTRANCE
, SFLAGS_EXPORTED
,
143 SFLAGS_FIXED
, SFLAGS_ANON
, SFLAGS_WALL
,
144 /* These values don't need to match img.h, but mustn't clash. */
146 SFLAGS_SOLVED
= 12, SFLAGS_SUSPECTTYPO
= 13, SFLAGS_SURVEY
= 14, SFLAGS_PREFIX_ENTERED
= 15
149 /* Mask to AND with to get bits to pass to img library. */
150 #define SFLAGS_MASK (BIT(SFLAGS_SURFACE) | BIT(SFLAGS_UNDERGROUND) |\
151 BIT(SFLAGS_ENTRANCE) | BIT(SFLAGS_EXPORTED) | BIT(SFLAGS_FIXED) |\
152 BIT(SFLAGS_ANON) | BIT(SFLAGS_WALL))
154 typedef int compiletimeassert_sflags1
[BIT(SFLAGS_SURFACE
) == img_SFLAG_SURFACE
? 1 : -1];
155 typedef int compiletimeassert_sflags2
[BIT(SFLAGS_UNDERGROUND
) == img_SFLAG_UNDERGROUND
? 1 : -1];
156 typedef int compiletimeassert_sflags3
[BIT(SFLAGS_ENTRANCE
) == img_SFLAG_ENTRANCE
? 1 : -1];
157 typedef int compiletimeassert_sflags4
[BIT(SFLAGS_EXPORTED
) == img_SFLAG_EXPORTED
? 1 : -1];
158 typedef int compiletimeassert_sflags5
[BIT(SFLAGS_FIXED
) == img_SFLAG_FIXED
? 1 : -1];
159 typedef int compiletimeassert_sflags6
[BIT(SFLAGS_ANON
) == img_SFLAG_ANON
? 1 : -1];
160 typedef int compiletimeassert_sflags7
[BIT(SFLAGS_WALL
) == img_SFLAG_WALL
? 1 : -1];
162 /* enumeration of field types */
164 End
= 0, Tape
, Comp
, Clino
, BackTape
, BackComp
, BackClino
,
165 Left
, Right
, Up
, Down
,
166 FrDepth
, ToDepth
, Dx
, Dy
, Dz
, FrCount
, ToCount
,
167 /* Up to here are readings are allowed multiple values
168 * and have slot in the value[] array in datain.c.
169 * (Depth, DepthChange, and Count can have multiple
170 * readings, but are actually handled using tokens
171 * above rather than as themselves).
173 * Fr must be the first reading after this comment!
175 Fr
, To
, Station
, Depth
, DepthChange
, Count
, Dir
,
176 Newline
, IgnoreAllAndNewLine
, Ignore
, IgnoreAll
,
177 /* IgnoreAll must be the last reading before this comment!
179 * Readings after this comment are only used in datain.c
180 * so can have enum values >= 32 because we only use a
181 * bitmask for those readings used in commands.c.
183 CompassDATComp
, CompassDATClino
, CompassDATBackComp
, CompassDATBackClino
,
184 CompassDATLeft
, CompassDATRight
, CompassDATUp
, CompassDATDown
,
188 /* if IgnoreAll is >= 32, the compiler will choke on this */
189 typedef char compiletimeassert_reading
[IgnoreAll
< 32 ? 1 : -1];
191 /* position or length vector */
192 typedef real delta
[3];
195 #ifdef NO_COVARIANCES
199 typedef real var
[3][3];
200 typedef real svar
[6];
204 typedef struct Prefix
{
205 struct Prefix
*up
, *down
, *right
;
209 const char *filename
;
211 /* If (min_export == 0) then max_export is max # levels above is this
212 * prefix is used (and so needs to be exported) (0 == parent only).
213 * If (min_export > 0) then max_export is max # levels above this
214 * prefix has been exported, and min_export is how far down the exports
215 * have got (if min_export > 1 after a run, this prefix hasn't been
216 * exported from below enough).
217 * If INFER_EXPORTS is active when a station is encountered, we
218 * set min_export = USHRT_MAX and max_export gets set as usual. Then at
219 * the end of the run, we also mark stations with min_export == USHRT_MAX
220 * and max_export > 0 as exported. */
221 unsigned short max_export
, min_export
;
222 /* stn flags - e.g. surface, underground, entrance
223 * also suspecttypo and survey */
224 unsigned short sflags
;
228 /* survey metadata */
229 typedef struct Meta_data
{
231 /* Days since 1900 for start and end date of survey, or -1 if undated. */
235 /* stuff stored for both forward & reverse legs */
238 /* bits 0..1 = reverse leg number; bit7 is fFullLeg */
239 /* bit6 = fReplacementLeg (by reduction rules) */
240 /* bit5 = articulation leg (i.e. carries no error) */
241 unsigned char reverse
;
242 /* flags - e.g. surface, duplicate survey
243 * only used if (FLAG_DATAHERE & !(FLAG_REPLACEMENTLEG|FLAG_FAKE))
244 * This could be only in linkfor, but this is actually more space
250 #define FLAG_DATAHERE 0x80
251 #define FLAG_REPLACEMENTLEG 0x40
252 #define FLAG_ARTICULATION 0x20
253 #define FLAG_FAKE 0x10 /* an equate or leg inside an sdfix */
254 #define MASK_REVERSEDIRN 0x03
256 /* reverse leg - deltas & vars stored on other dirn */
257 typedef struct LinkRev
{
261 /* forward leg - deltas & vars stored here */
262 typedef struct Link
{
265 svar v
; /* Variances */
269 /* node - like a station, except several nodes are used to represent a
270 * station with more than 3 legs connected to it
272 typedef struct Node
{
275 struct Node
*prev
, *next
;
279 /* station position */
281 delta p
; /* Position */
282 #if EXPLICIT_FIXED_FLAG
283 unsigned char fFixed
; /* flag indicating if station is a fixed point */
288 typedef struct Inst {
289 real zero, scale, units;
293 /* Survey data styles */
294 #define STYLE_NORMAL 0
295 #define STYLE_DIVING 1
296 #define STYLE_CARTESIAN 2
297 #define STYLE_CYLPOLAR 3
298 #define STYLE_NOSURVEY 4
299 #define STYLE_PASSAGE 5
300 #define STYLE_IGNORE 6
302 typedef int compiletimeassert_style1
[STYLE_NORMAL
== img_STYLE_NORMAL
? 1 : -1];
303 typedef int compiletimeassert_style2
[STYLE_DIVING
== img_STYLE_DIVING
? 1 : -1];
304 typedef int compiletimeassert_style3
[STYLE_CARTESIAN
== img_STYLE_CARTESIAN
? 1 : -1];
305 typedef int compiletimeassert_style4
[STYLE_CYLPOLAR
== img_STYLE_CYLPOLAR
? 1 : -1];
306 typedef int compiletimeassert_style5
[STYLE_NOSURVEY
== img_STYLE_NOSURVEY
? 1 : -1];
308 /* various settings preserved by *BEGIN and *END */
309 typedef struct Settings
{
310 struct Settings
*next
;
311 unsigned int Truncate
;
312 bool f_clino_percent
;
313 bool f_backclino_percent
;
314 bool dash_for_anon_wall_station
;
316 enum {OFF
, LOWER
, UPPER
} Case
;
319 prefix
*begin_survey
; /* used to check BEGIN and END match */
320 short *Translate
; /* if short is >= 16 bits, which ANSI requires */
325 const reading
*ordering
;
326 int begin_lineno
; /* 0 means no block started in this file */
329 /* Location at which we calculate the declination if
330 * z[Q_DECLINATION] == HUGE_REAL. */
331 real dec_x
, dec_y
, dec_z
;
332 /* Cached auto-declination, or HUGE_REAL for no cached value. Only
333 * meaningful if date1 != -1.
336 /* Grid convergence. */
341 /* global variables */
342 extern settings
*pcs
;
344 extern prefix
*anon_list
;
345 extern node
*stnlist
;
346 extern unsigned long optimize
;
347 extern projPJ proj_out
;
348 extern char * proj_str_out
;
350 extern char *survey_title
;
351 extern int survey_title_len
;
353 extern bool fExplicitTitle
;
354 extern long cLegs
, cStns
, cComponents
;
355 extern FILE *fhErrStat
;
357 extern real totadj
, total
, totplan
, totvert
;
358 extern real min
[3], max
[3];
359 extern prefix
*pfxHi
[3], *pfxLo
[3];
360 extern bool fQuiet
; /* just show brief summary + errors */
361 extern bool fMute
; /* just show errors */
362 extern bool fSuppress
; /* only output 3d file */
366 #define POS(S, D) ((S)->name->pos->p[(D)])
367 #define POSD(S) ((S)->name->pos->p)
369 #define data_here(L) ((L)->l.reverse & FLAG_DATAHERE)
370 #define reverse_leg_dirn(L) ((L)->l.reverse & MASK_REVERSEDIRN)
371 #define reverse_leg(L) ((L)->l.to->leg[reverse_leg_dirn(L)])
373 #if EXPLICIT_FIXED_FLAG
374 # define pfx_fixed(N) ((N)->pos->fFixed)
375 # define pos_fixed(P) ((P)->fFixed)
376 # define fix(S) (S)->name->pos->fFixed = (char)fTrue
377 # define fixpos(P) (P)->fFixed = (char)fTrue
378 # define unfix(S) (S)->name->pos->fFixed = (char)fFalse
380 # define pfx_fixed(N) ((N)->pos->p[0] != UNFIXED_VAL)
381 # define pos_fixed(P) ((P)->p[0] != UNFIXED_VAL)
383 # define fixpos(P) NOP
384 # define unfix(S) POS((S), 0) = UNFIXED_VAL
386 #define fixed(S) pfx_fixed((S)->name)
388 /* macros for special chars */
390 #define isEol(c) (pcs->Translate[(c)] & SPECIAL_EOL)
391 #define isBlank(c) (pcs->Translate[(c)] & SPECIAL_BLANK)
392 #define isKeywd(c) (pcs->Translate[(c)] & SPECIAL_KEYWORD)
393 #define isComm(c) (pcs->Translate[(c)] & SPECIAL_COMMENT)
394 #define isOmit(c) (pcs->Translate[(c)] & SPECIAL_OMIT)
395 #ifndef NO_DEPRECATED
396 #define isRoot(c) (pcs->Translate[(c)] & SPECIAL_ROOT)
398 #define isSep(c) (pcs->Translate[(c)] & SPECIAL_SEPARATOR)
399 #define isNames(c) (pcs->Translate[(c)] & SPECIAL_NAMES)
400 #define isDecimal(c) (pcs->Translate[(c)] & SPECIAL_DECIMAL)
401 #define isMinus(c) (pcs->Translate[(c)] & SPECIAL_MINUS)
402 #define isPlus(c) (pcs->Translate[(c)] & SPECIAL_PLUS)
403 #define isOpen(c) (pcs->Translate[(c)] & SPECIAL_OPEN)
404 #define isClose(c) (pcs->Translate[(c)] & SPECIAL_CLOSE)
406 #define isSign(c) (pcs->Translate[(c)] & (SPECIAL_PLUS | SPECIAL_MINUS))
407 #define isData(c) (pcs->Translate[(c)] & (SPECIAL_OMIT | SPECIAL_ROOT|\
408 SPECIAL_SEPARATOR | SPECIAL_NAMES | SPECIAL_DECIMAL | SPECIAL_PLUS |\
411 typedef struct nosurveylink
{
415 struct nosurveylink
*next
;
418 extern nosurveylink
*nosurveyhead
;
420 typedef struct lrud
{
427 typedef struct lrudlist
{
429 struct lrudlist
* next
;
432 extern lrudlist
* model
;
434 extern lrud
** next_lrud
;
436 #endif /* CAVERN_H */