source: git/src/cavern.h @ b5907bb

RELEASE/1.2debug-cidebug-ci-sanitisersfaster-cavernloglog-selectstereo-2025walls-datawalls-data-hanging-as-warningwarn-only-for-hanging-survey
Last change on this file since b5907bb was b5907bb, checked in by Olly Betts <olly@…>, 4 years ago

Note stored declination/convergence are in radians

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