src/cavern.h

   1 /* cavern.h
   2  * SURVEX Cave surveying software - header file
   3  * Copyright (C) 1991-2024 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.h>
  37
  38 #include "img_hosted.h"
  39 #include "str.h"
  40 #include "useful.h"
  41
  42 typedef double real; /* so we can change the precision used easily */
  43 #define HUGE_REAL HUGE_VAL
  44 #define REAL_EPSILON DBL_EPSILON
  45
  46 #define WGS84_DATUM_STRING "EPSG:4326"
  47
  48 #define SPECIAL_EOL             0x0001
  49 #define SPECIAL_BLANK           0x0002
  50 #define SPECIAL_KEYWORD         0x0004
  51 #define SPECIAL_COMMENT         0x0008
  52 #define SPECIAL_OMIT            0x0010
  53 #ifndef NO_DEPRECATED
  54 #define SPECIAL_ROOT            0x0020
  55 #endif
  56 #define SPECIAL_SEPARATOR       0x0040
  57 #define SPECIAL_NAMES           0x0080
  58 #define SPECIAL_DECIMAL         0x0100
  59 #define SPECIAL_MINUS           0x0200
  60 #define SPECIAL_PLUS            0x0400
  61 #define SPECIAL_OPEN            0x0800
  62 #define SPECIAL_CLOSE           0x1000
  63
  64 extern char *fnm_output_base;
  65 extern int fnm_output_base_is_dir;
  66
  67 extern bool fExportUsed;
  68
  69 extern int current_days_since_1900;
  70
  71 /* Types */
  72
  73 typedef enum {
  74    Q_NULL = -1, Q_DEFAULT, Q_POS, Q_PLUMB, Q_LEVEL,
  75    Q_GRADIENT, Q_BACKGRADIENT, Q_BEARING, Q_BACKBEARING,
  76    Q_LENGTH, Q_BACKLENGTH, Q_DEPTH, Q_DX, Q_DY, Q_DZ, Q_COUNT, Q_DECLINATION,
  77    Q_LEFT, Q_RIGHT, Q_UP, Q_DOWN,
  78    Q_MAC
  79 } q_quantity;
  80
  81 typedef enum {
  82    INFER_NULL = -1,
  83    INFER_EQUATES,
  84    INFER_EXPORTS,
  85    INFER_PLUMBS,
  86    INFER_SUBSURVEYS,
  87    /* In Compass DAT files a dummy zero-length leg from a station to itself is
  88     * used to provide a place to specify LRUD for the start or end of a
  89     * traverse (depending if dimensions are measured at the from or to
  90     * station), so we shouldn't warn about equating a station to itself.
  91     * This should be set *as well as* INFER_EQUATES.
  92     */
  93    INFER_EQUATES_SELF_OK
  94 } infer_what;
  95
  96 /* unsigned long to cope with 16-bit int-s */
  97 #define BIT(N) (1UL << (N))
  98 #define BITA(N) (1UL << ((N) - 'a'))
  99
 100 #define TSTBIT(W, N) (((W)>>(N))&1)
 101
 102 /* masks for quantities which are length and angles respectively */
 103 #define LEN_QMASK (BIT(Q_LENGTH) | BIT(Q_BACKLENGTH) | BIT(Q_DEPTH) |\
 104    BIT(Q_DX) | BIT(Q_DY) | BIT(Q_DZ) | BIT(Q_POS) | BIT(Q_COUNT) |\
 105    BIT(Q_LEFT) | BIT(Q_RIGHT) | BIT(Q_UP) | BIT(Q_DOWN))
 106 #define ANG_QMASK (BIT(Q_BEARING) | BIT(Q_BACKBEARING) |\
 107    BIT(Q_GRADIENT) | BIT(Q_BACKGRADIENT) | BIT(Q_PLUMB) | BIT(Q_LEVEL) |\
 108    BIT(Q_DECLINATION))
 109
 110 /* if you add/change the order, check factor_tab in commands.c */
 111 typedef enum {
 112    UNITS_NULL = -1, UNITS_METRES, UNITS_FEET, UNITS_YARDS,
 113    UNITS_DEGS, UNITS_QUADRANTS, UNITS_GRADS, UNITS_PERCENT, UNITS_MINUTES,
 114    UNITS_MAC, UNITS_DEPRECATED_ALIAS_FOR_GRADS
 115 } u_units;
 116
 117 /* don't reorder these values!  They need to match with img.h too */
 118 typedef enum {
 119    FLAGS_NOT = -2, FLAGS_UNKNOWN = -1, FLAGS_SURFACE, FLAGS_DUPLICATE,
 120    FLAGS_SPLAY,
 121 #if 0
 122    /* underground, but through rock (e.g. radiolocation).  Want to hide from
 123     * plots by default (so not cave) but don't want to include in surface
 124     * triangulation nets (so not surface) */
 125    FLAGS_SKELETAL, /* FIXME */
 126 #endif
 127    /* Don't need to match img.h: */
 128    FLAGS_ANON_ONE_END,
 129    FLAGS_IMPLICIT_SPLAY,
 130    FLAGS_STYLE_BIT0, FLAGS_STYLE_BIT1, FLAGS_STYLE_BIT2
 131 } flags;
 132
 133 /* flags are currently stored in an unsigned char */
 134 typedef int compiletimeassert_flags0[FLAGS_STYLE_BIT2 <= 7 ? 1 : -1];
 135
 136 /* Mask to AND with to get bits to pass to img library. */
 137 #define FLAGS_MASK \
 138     (BIT(FLAGS_SURFACE) | BIT(FLAGS_DUPLICATE) | BIT(FLAGS_SPLAY))
 139
 140 typedef int compiletimeassert_flags1[BIT(FLAGS_SURFACE) == img_FLAG_SURFACE ? 1 : -1];
 141 typedef int compiletimeassert_flags2[BIT(FLAGS_DUPLICATE) == img_FLAG_DUPLICATE ? 1 : -1];
 142 typedef int compiletimeassert_flags3[BIT(FLAGS_SPLAY) == img_FLAG_SPLAY ? 1 : -1];
 143
 144 typedef enum {
 145    /* Don't reorder these values!  They need to match with img.h too. */
 146    SFLAGS_SURFACE = 0, SFLAGS_UNDERGROUND, SFLAGS_ENTRANCE, SFLAGS_EXPORTED,
 147    SFLAGS_FIXED, SFLAGS_ANON, SFLAGS_WALL,
 148    /* These values don't need to match img.h, but mustn't clash. */
 149    SFLAGS_HANGING = 9,
 150    SFLAGS_USED = 10,
 151    SFLAGS_SOLVED = 11,
 152    SFLAGS_SUSPECTTYPO = 12,
 153    SFLAGS_SURVEY = 13,
 154    SFLAGS_PREFIX_ENTERED = 14,
 155    // If set, use ident.i; if unset, use ident.p
 156    SFLAGS_IDENT_INLINE = 15
 157 } sflags;
 158
 159 /* Mask to AND with to get bits to pass to img library. */
 160 #define SFLAGS_MASK (BIT(SFLAGS_SURFACE) | BIT(SFLAGS_UNDERGROUND) |\
 161         BIT(SFLAGS_ENTRANCE) | BIT(SFLAGS_EXPORTED) | BIT(SFLAGS_FIXED) |\
 162         BIT(SFLAGS_ANON) | BIT(SFLAGS_WALL))
 163
 164 typedef int compiletimeassert_sflags1[BIT(SFLAGS_SURFACE) == img_SFLAG_SURFACE ? 1 : -1];
 165 typedef int compiletimeassert_sflags2[BIT(SFLAGS_UNDERGROUND) == img_SFLAG_UNDERGROUND ? 1 : -1];
 166 typedef int compiletimeassert_sflags3[BIT(SFLAGS_ENTRANCE) == img_SFLAG_ENTRANCE ? 1 : -1];
 167 typedef int compiletimeassert_sflags4[BIT(SFLAGS_EXPORTED) == img_SFLAG_EXPORTED ? 1 : -1];
 168 typedef int compiletimeassert_sflags5[BIT(SFLAGS_FIXED) == img_SFLAG_FIXED ? 1 : -1];
 169 typedef int compiletimeassert_sflags6[BIT(SFLAGS_ANON) == img_SFLAG_ANON ? 1 : -1];
 170 typedef int compiletimeassert_sflags7[BIT(SFLAGS_WALL) == img_SFLAG_WALL ? 1 : -1];
 171
 172 /* enumeration of field types */
 173 typedef enum {
 174    End = 0, Tape, Comp, Clino, BackTape, BackComp, BackClino,
 175    Left, Right, Up, Down,
 176    FrDepth, ToDepth, Dx, Dy, Dz, FrCount, ToCount,
 177    /* Up to here are readings are allowed multiple values
 178     * and have slot in the value[] array in datain.c.
 179     * (Depth, DepthChange, and Count can have multiple
 180     * readings, but are actually handled using tokens
 181     * above rather than as themselves).
 182     *
 183     * Fr must be the first reading after this comment!
 184     */
 185    Fr, To, Station, Depth, DepthChange, Count, Dir,
 186    Newline, IgnoreAllAndNewLine, Ignore, IgnoreAll,
 187    /* IgnoreAll must be the last reading before this comment!
 188     *
 189     * Readings after this comment are only used in datain.c
 190     * so can have enum values >= 32 because we only use a
 191     * bitmask for those readings used in commands.c.
 192     */
 193    CompassDATFr, CompassDATTo,
 194    CompassDATComp, CompassDATClino, CompassDATBackComp, CompassDATBackClino,
 195    CompassDATLeft, CompassDATRight, CompassDATUp, CompassDATDown,
 196    CompassDATFlags,
 197
 198    WallsSRVFr, WallsSRVTo, WallsSRVTape, WallsSRVComp, WallsSRVClino,
 199    // Optional pair of readings giving heights above stations on CT surveys.
 200    WallsSRVHeights,
 201    // Optional delimited LRUD and variance overrides.
 202    WallsSRVExtras
 203 } reading;
 204
 205 /* if IgnoreAll is >= 32, the compiler will choke on this */
 206 typedef char compiletimeassert_reading[IgnoreAll < 32 ? 1 : -1];
 207
 208 /* position or length vector */
 209 typedef real delta[3];
 210
 211 /* variance */
 212 #ifdef NO_COVARIANCES
 213 typedef real var[3];
 214 typedef var svar;
 215 #else
 216 typedef real var[3][3];
 217 typedef real svar[6];
 218 #endif
 219
 220 /* station name */
 221 typedef struct Prefix {
 222    struct Prefix *up, *down, *right;
 223    struct Node *stn;
 224    struct Pos *pos;
 225    union {
 226        const char *p;
 227        char i[sizeof(const char*)];
 228    } ident;
 229    // A filename:line where this name was used.  If it's a station used in *fix
 230    // then this will be the location of such a *fix, otherwise if it's a
 231    // station used in *equate then it's the location of such a *equate.
 232    // Otherwise it's the first place it was used.
 233    const char *filename;
 234    unsigned int line;
 235    /* If (min_export == 0) then max_export is max # levels above is this
 236     * prefix is used (and so needs to be exported) (0 == parent only).
 237     * If (min_export > 0) then max_export is max # levels above this
 238     * prefix has been exported, and min_export is how far down the exports
 239     * have got (if min_export > 1 after a run, this prefix hasn't been
 240     * exported from below enough).
 241     * If INFER_EXPORTS is active when a station is encountered, we
 242     * set min_export = USHRT_MAX and max_export gets set as usual.  Then at
 243     * the end of the run, we also mark stations with min_export == USHRT_MAX
 244     * and max_export > 0 as exported. */
 245    unsigned short max_export, min_export;
 246    /* stn flags - e.g. surface, underground, entrance
 247     * also suspecttypo and survey */
 248    unsigned short sflags;
 249    short shape;
 250 } prefix;
 251
 252 static inline const char *prefix_ident(const prefix *p) {
 253     return TSTBIT(p->sflags, SFLAGS_IDENT_INLINE) ? p->ident.i : p->ident.p;
 254 }
 255
 256 /* survey metadata */
 257 typedef struct Meta_data {
 258     size_t ref_count;
 259     /* Days since 1900 for start and end date of survey, or -1 if undated. */
 260     int days1, days2;
 261 } meta_data;
 262
 263 /* stuff stored for both forward & reverse legs */
 264 typedef struct {
 265    struct Node *to;
 266    /* bits 0..1 = reverse leg number; bit7 is fFullLeg */
 267    /* bit6 = fReplacementLeg (by reduction rules) */
 268    /* bit5 = articulation leg (i.e. carries no error) */
 269    unsigned char reverse;
 270    /* flags - e.g. surface, duplicate survey
 271     * only used if (FLAG_DATAHERE & !(FLAG_REPLACEMENTLEG|FLAG_FAKE))
 272     * This could be only in linkfor, but this is actually more space
 273     * efficient.
 274     */
 275    unsigned char flags;
 276 } linkcommon;
 277
 278 #define FLAG_DATAHERE 0x80
 279 #define FLAG_REPLACEMENTLEG 0x40
 280 #define FLAG_ARTICULATION 0x20
 281 #define FLAG_FAKE 0x10 /* an equate or leg inside an sdfix */
 282 #define MASK_REVERSEDIRN 0x03
 283
 284 /* forward leg - deltas & vars stored here */
 285 typedef struct Link {
 286    linkcommon l;
 287    delta d; /* Delta */
 288    svar v; /* Variances */
 289    meta_data *meta;
 290 } linkfor;
 291
 292 /* node - like a station, except several nodes are used to represent a
 293  * station with more than 3 legs connected to it
 294  */
 295 typedef struct Node {
 296    struct Prefix *name;
 297    struct Link *leg[3];
 298    struct Node *prev, *next;
 299    // Used in netartic.c to identify unconnected components and articulation
 300    // points within components.
 301    //
 302    // Used in matrix.c to record the matrix row corresponding to this node
 303    // or -1 for nodes already fixed (more than one node may map to the same
 304    // row).
 305    long colour;
 306 } node;
 307
 308 /* station position */
 309 typedef struct Pos {
 310    // Easting, Northing, Altitude.
 311    real p[3];
 312 } pos;
 313
 314 /*
 315 typedef struct Inst {
 316    real zero, scale, units;
 317 } inst;
 318 */
 319
 320 /* Survey data styles */
 321 #define STYLE_NORMAL     0
 322 #define STYLE_DIVING     1
 323 #define STYLE_CARTESIAN  2
 324 #define STYLE_CYLPOLAR   3
 325 #define STYLE_NOSURVEY   4
 326 #define STYLE_PASSAGE    5
 327 #define STYLE_IGNORE     6
 328
 329 typedef int compiletimeassert_style1[STYLE_NORMAL == img_STYLE_NORMAL ? 1 : -1];
 330 typedef int compiletimeassert_style2[STYLE_DIVING == img_STYLE_DIVING ? 1 : -1];
 331 typedef int compiletimeassert_style3[STYLE_CARTESIAN == img_STYLE_CARTESIAN ? 1 : -1];
 332 typedef int compiletimeassert_style4[STYLE_CYLPOLAR == img_STYLE_CYLPOLAR ? 1 : -1];
 333 typedef int compiletimeassert_style5[STYLE_NOSURVEY == img_STYLE_NOSURVEY ? 1 : -1];
 334
 335 /* various settings preserved by *BEGIN and *END */
 336 typedef struct Settings {
 337    struct Settings *next;
 338    unsigned int Truncate;
 339    bool f_clino_percent;
 340    bool f_backclino_percent;
 341    bool f_bearing_quadrants;
 342    bool f_backbearing_quadrants;
 343    bool dash_for_anon_wall_station;
 344    bool from_equals_to_is_only_a_warning;
 345    unsigned char infer;
 346    enum {OFF, LOWER, UPPER} Case;
 347    /* STYLE_xxx value to process data as. */
 348    int style;
 349    /* STYLE_xxx value to put in 3d file (different for Compass DAT diving
 350     * data, as the data in the DAT file is always presented in the format
 351     * tape,compass,clino even if that isn't how it was really measured).
 352     */
 353    int recorded_style;
 354    prefix *Prefix;
 355    prefix *begin_survey; /* used to check BEGIN and END match */
 356    short *Translate; /* if short is >= 16 bits, which ANSI requires */
 357    real Var[Q_MAC];
 358    real z[Q_MAC];
 359    real sc[Q_MAC];
 360    real units[Q_MAC];
 361    const reading *ordering;
 362    long begin_lpos; /* File offset for start of BEGIN line */
 363    int begin_lineno; /* 0 means no block started in this file */
 364    int begin_col; /* Column of prefix in BEGIN line (or 0 if none) */
 365    int flags;
 366    char* proj_str;
 367    /* Location at which we calculate the declination if
 368     * z[Q_DECLINATION] == HUGE_REAL.
 369     *
 370     * Latitude and longitude are in radians; altitude is in metres above the
 371     * ellipsoid.
 372     */
 373    real dec_lat, dec_lon, dec_alt;
 374    /* Cached auto-declination in radians, or HUGE_REAL for no cached value.
 375     * Only meaningful if days1 != -1.
 376     */
 377    real declination;
 378    double min_declination, max_declination;
 379    int min_declination_days, max_declination_days;
 380    const char* dec_filename;
 381    int dec_line;
 382    /* Copy of the text of the `*declination auto ...` line (malloced). */
 383    char* dec_context;
 384    /* Grid convergence in radians. */
 385    real convergence;
 386    /* Input grid convergence in radians. */
 387    real input_convergence;
 388    /* Rotation from North for `*data cartesian`. */
 389    real cartesian_rotation;
 390    /* Which North to use for `*data cartesian`. */
 391    enum { TRUE_NORTH, GRID_NORTH, MAGNETIC_NORTH } cartesian_north;
 392    meta_data * meta;
 393 } settings;
 394
 395 /* global variables */
 396 extern settings *pcs;
 397 extern prefix *root;
 398 extern prefix *anon_list;
 399 extern node *fixedlist;
 400 extern node *stnlist;
 401 extern unsigned long optimize;
 402 extern char * proj_str_out;
 403 extern PJ * pj_cached;
 404
 405 extern string survey_title;
 406
 407 extern bool fExplicitTitle;
 408 extern long cLegs, cStns, cComponents;
 409 extern FILE *fhErrStat;
 410 extern img *pimg;
 411 extern real totadj, total, totplan, totvert;
 412 extern real min[9], max[9];
 413 extern prefix *pfxHi[9], *pfxLo[9];
 414 extern bool fQuiet; /* just show brief summary + errors */
 415 extern bool fMute; /* just show errors */
 416 extern bool fSuppress; /* only output 3d file */
 417
 418 /* macros */
 419
 420 #define POS(S, D) ((S)->name->pos->p[(D)])
 421 #define POSD(S) ((S)->name->pos->p)
 422
 423 #define data_here(L) ((L)->l.reverse & FLAG_DATAHERE)
 424 #define reverse_leg_dirn(L) ((L)->l.reverse & MASK_REVERSEDIRN)
 425 #define reverse_leg(L) ((L)->l.to->leg[reverse_leg_dirn(L)])
 426
 427 /* if p[0]==UNFIXED_VAL, station is unfixed */
 428 #define UNFIXED_VAL HUGE_VAL
 429 #define pfx_fixed(N) ((N)->pos->p[0] != UNFIXED_VAL)
 430 #define pos_fixed(P) ((P)->p[0] != UNFIXED_VAL)
 431 #define unfix(S) POS((S), 0) = UNFIXED_VAL
 432 #define fixed(S) pfx_fixed((S)->name)
 433
 434 /* macros for special chars */
 435
 436 #define isEol(c)    (pcs->Translate[(c)] & SPECIAL_EOL)
 437 #define isBlank(c)  (pcs->Translate[(c)] & SPECIAL_BLANK)
 438 #define isKeywd(c)  (pcs->Translate[(c)] & SPECIAL_KEYWORD)
 439 #define isComm(c)   (pcs->Translate[(c)] & SPECIAL_COMMENT)
 440 #define isOmit(c)   (pcs->Translate[(c)] & SPECIAL_OMIT)
 441 #ifndef NO_DEPRECATED
 442 #define isRoot(c)   (pcs->Translate[(c)] & SPECIAL_ROOT)
 443 #endif
 444 #define isSep(c)    (pcs->Translate[(c)] & SPECIAL_SEPARATOR)
 445 #define isNames(c)  (pcs->Translate[(c)] & SPECIAL_NAMES)
 446 #define isDecimal(c) (pcs->Translate[(c)] & SPECIAL_DECIMAL)
 447 #define isMinus(c)  (pcs->Translate[(c)] & SPECIAL_MINUS)
 448 #define isPlus(c)   (pcs->Translate[(c)] & SPECIAL_PLUS)
 449 #define isOpen(c)   (pcs->Translate[(c)] & SPECIAL_OPEN)
 450 #define isClose(c)  (pcs->Translate[(c)] & SPECIAL_CLOSE)
 451
 452 #define isSign(c)   (pcs->Translate[(c)] & (SPECIAL_PLUS | SPECIAL_MINUS))
 453 #define isData(c)   (pcs->Translate[(c)] & (SPECIAL_OMIT | SPECIAL_ROOT|\
 454    SPECIAL_SEPARATOR | SPECIAL_NAMES | SPECIAL_DECIMAL | SPECIAL_PLUS |\
 455    SPECIAL_MINUS))
 456
 457 typedef struct nosurveylink {
 458    node *fr, *to;
 459    int flags;
 460    meta_data *meta;
 461    struct nosurveylink *next;
 462 } nosurveylink;
 463
 464 extern nosurveylink *nosurveyhead;
 465
 466 typedef struct lrud {
 467     struct lrud * next;
 468     prefix *stn;
 469     meta_data *meta;
 470     real l, r, u, d;
 471 } lrud;
 472
 473 typedef struct lrudlist {
 474     lrud * tube;
 475     struct lrudlist * next;
 476 } lrudlist;
 477
 478 extern lrudlist * model;
 479
 480 extern lrud ** next_lrud;
 481
 482 extern char output_separator;
 483
 484 #endif /* CAVERN_H */