src/cavern.c

   1 /* cavern.c
   2  * SURVEX Cave surveying software: data reduction main and related functions
   3  * Copyright (C) 1991-2023 Olly Betts
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23
  24 #define MSG_SETUP_PROJ_SEARCH_PATH 1
  25
  26 #include <limits.h>
  27 #include <stdlib.h>
  28 #include <time.h>
  29
  30 #include "cavern.h"
  31 #include "cmdline.h"
  32 #include "commands.h"
  33 #include "date.h"
  34 #include "datain.h"
  35 #include "debug.h"
  36 #include "message.h"
  37 #include "filename.h"
  38 #include "filelist.h"
  39 #include "img_hosted.h"
  40 #include "listpos.h"
  41 #include "netbits.h"
  42 #include "netskel.h"
  43 #include "out.h"
  44 #include "str.h"
  45 #include "validate.h"
  46 #include "whichos.h"
  47
  48 #if OS_WIN32
  49 # include <conio.h> /* for _kbhit() and _getch() */
  50 #endif
  51
  52 /* For funcs which want to be immune from messing around with different
  53  * calling conventions */
  54 #ifndef CDECL
  55 # define CDECL
  56 #endif
  57
  58 /* Globals */
  59 node *stnlist = NULL;
  60 settings *pcs;
  61 prefix *root;
  62 prefix *anon_list = NULL;
  63 long cLegs, cStns;
  64 long cComponents;
  65 bool fExportUsed = false;
  66 char * proj_str_out = NULL;
  67 PJ * pj_cached = NULL;
  68
  69 FILE *fhErrStat = NULL;
  70 img *pimg = NULL;
  71 bool fQuiet = false; /* just show brief summary + errors */
  72 bool fMute = false; /* just show errors */
  73 bool fSuppress = false; /* only output 3d file */
  74 static bool fLog = false; /* stdout to .log file */
  75 static bool f_warnings_are_errors = false; /* turn warnings into errors */
  76
  77 nosurveylink *nosurveyhead;
  78
  79 real totadj, total, totplan, totvert;
  80 real min[6], max[6];
  81 prefix *pfxHi[6], *pfxLo[6];
  82
  83 string survey_title = S_INIT;
  84
  85 bool fExplicitTitle = false;
  86
  87 char *fnm_output_base = NULL;
  88 int fnm_output_base_is_dir = 0;
  89
  90 lrudlist * model = NULL;
  91 lrud ** next_lrud = NULL;
  92
  93 char output_separator = '.';
  94
  95 static void do_stats(void);
  96
  97 static const struct option long_opts[] = {
  98    /* const char *name; int has_arg (0 no_argument, 1 required_*, 2 optional_*); int *flag; int val; */
  99    {"percentage", no_argument, 0, 'p'},
 100    /* Ignore for compatibility with older versions. */
 101    {"no-percentage", no_argument, 0, 0},
 102    {"output", required_argument, 0, 'o'},
 103    {"quiet", no_argument, 0, 'q'},
 104    {"no-auxiliary-files", no_argument, 0, 's'},
 105    {"warnings-are-errors", no_argument, 0, 'w'},
 106    {"log", no_argument, 0, 1},
 107    {"3d-version", required_argument, 0, 'v'},
 108 #if OS_WIN32
 109    {"pause", no_argument, 0, 2},
 110 #endif
 111    {"help", no_argument, 0, HLP_HELP},
 112    {"version", no_argument, 0, HLP_VERSION},
 113    {0, 0, 0, 0}
 114 };
 115
 116 #define short_opts "pao:qsv:wz:"
 117
 118 static struct help_msg help[] = {
 119 /*                              <-- */
 120    /* TRANSLATORS: --help output for cavern --output option */
 121    {HLP_ENCODELONG(2),        /*set location for output files*/162, 0},
 122    /* TRANSLATORS: --help output for cavern --quiet option */
 123    {HLP_ENCODELONG(3),        /*only show brief summary (-qq for errors only)*/163, 0},
 124    /* TRANSLATORS: --help output for cavern --no-auxiliary-files option */
 125    {HLP_ENCODELONG(4),        /*do not create .err file*/164, 0},
 126    /* TRANSLATORS: --help output for cavern --warnings-are-errors option */
 127    {HLP_ENCODELONG(5),        /*turn warnings into errors*/165, 0},
 128    /* TRANSLATORS: --help output for cavern --log option */
 129    {HLP_ENCODELONG(6),        /*log output to .log file*/170, 0},
 130    /* TRANSLATORS: --help output for cavern --3d-version option */
 131    {HLP_ENCODELONG(7),        /*specify the 3d file format version to output*/171, 0},
 132  /*{'z',                        "set optimizations for network reduction"},*/
 133    {0, 0, 0}
 134 };
 135
 136 /* atexit functions */
 137 static void
 138 delete_output_on_error(void)
 139 {
 140    if (msg_errors || (f_warnings_are_errors && msg_warnings))
 141       filename_delete_output();
 142 }
 143
 144 #if OS_WIN32
 145 static void
 146 pause_on_exit(void)
 147 {
 148    while (_kbhit()) _getch();
 149    _getch();
 150 }
 151 #endif
 152
 153 int current_days_since_1900;
 154
 155 static void discarding_proj_logger(void *ctx, int level, const char *message) {
 156     (void)ctx;
 157     (void)level;
 158     (void)message;
 159 }
 160
 161 extern CDECL int
 162 main(int argc, char **argv)
 163 {
 164    int d;
 165    time_t tmUserStart = time(NULL);
 166    clock_t tmCPUStart = clock();
 167    {
 168        /* FIXME: localtime? */
 169        struct tm * t = localtime(&tmUserStart);
 170        int y = t->tm_year + 1900;
 171        current_days_since_1900 = days_since_1900(y, t->tm_mon + 1, t->tm_mday);
 172    }
 173
 174    /* Always buffer by line for aven's benefit. */
 175    setvbuf(stdout, NULL, _IOLBF, 0);
 176
 177    /* Prevent stderr spew from PROJ. */
 178    proj_log_func(PJ_DEFAULT_CTX, NULL, discarding_proj_logger);
 179
 180    msg_init(argv);
 181
 182    pcs = osnew(settings);
 183    pcs->next = NULL;
 184    pcs->Translate = ((short*) osmalloc(ossizeof(short) * 257)) + 1;
 185    pcs->meta = NULL;
 186    pcs->proj_str = NULL;
 187    pcs->declination = HUGE_REAL;
 188    pcs->convergence = HUGE_REAL;
 189    pcs->dec_filename = NULL;
 190    pcs->dec_line = 0;
 191    pcs->dec_context = NULL;
 192    pcs->dec_lat = HUGE_VAL;
 193    pcs->dec_lon = HUGE_VAL;
 194    pcs->dec_alt = HUGE_VAL;
 195    pcs->min_declination = HUGE_VAL;
 196    pcs->max_declination = -HUGE_VAL;
 197
 198    /* Set up root of prefix hierarchy */
 199    root = osnew(prefix);
 200    root->up = root->right = root->down = NULL;
 201    root->stn = NULL;
 202    root->pos = NULL;
 203    root->ident = NULL;
 204    root->min_export = root->max_export = 0;
 205    root->sflags = BIT(SFLAGS_SURVEY);
 206    root->filename = NULL;
 207
 208    nosurveyhead = NULL;
 209
 210    stnlist = NULL;
 211    cLegs = cStns = cComponents = 0;
 212    totadj = total = totplan = totvert = 0.0;
 213
 214    for (d = 0; d < 6; d++) {
 215       min[d] = HUGE_REAL;
 216       max[d] = -HUGE_REAL;
 217       pfxHi[d] = pfxLo[d] = NULL;
 218    }
 219
 220    /* at least one argument must be given */
 221    cmdline_init(argc, argv, short_opts, long_opts, NULL, help, 1, -1);
 222    while (1) {
 223       int opt = cmdline_getopt();
 224       if (opt == EOF) break;
 225       switch (opt) {
 226        case 'p':
 227          /* Ignore for compatibility with older versions. */
 228          break;
 229        case 'o': {
 230          osfree(fnm_output_base); /* in case of multiple -o options */
 231          /* can be a directory (in which case use basename of leaf input)
 232           * or a file (in which case just trim the extension off) */
 233          if (fDirectory(optarg)) {
 234             /* this is a little tricky - we need to note the path here,
 235              * and then add the leaf later on (in datain.c) */
 236             fnm_output_base = base_from_fnm(optarg);
 237             fnm_output_base_is_dir = 1;
 238          } else {
 239             fnm_output_base = base_from_fnm(optarg);
 240          }
 241          break;
 242        }
 243        case 'q':
 244          if (fQuiet) fMute = 1;
 245          fQuiet = 1;
 246          break;
 247        case 's':
 248          fSuppress = 1;
 249          break;
 250        case 'v': {
 251          int v = atoi(optarg);
 252          if (v < IMG_VERSION_MIN || v > IMG_VERSION_MAX)
 253             fatalerror(/*3d file format versions %d to %d supported*/88,
 254                        IMG_VERSION_MIN, IMG_VERSION_MAX);
 255          img_output_version = v;
 256          break;
 257        }
 258        case 'w':
 259          f_warnings_are_errors = 1;
 260          break;
 261        case 'z': {
 262          /* Control which network optimisations are used (development tool) */
 263          static int first_opt_z = 1;
 264          char c;
 265          if (first_opt_z) {
 266             optimize = 0;
 267             first_opt_z = 0;
 268          }
 269          /* Lollipops, Parallel legs, Iterate mx, Delta* */
 270          while ((c = *optarg++) != '\0')
 271             if (islower((unsigned char)c)) optimize |= BITA(c);
 272          break;
 273        case 1:
 274          fLog = true;
 275          break;
 276 #if OS_WIN32
 277        case 2:
 278          atexit(pause_on_exit);
 279          break;
 280 #endif
 281        }
 282       }
 283    }
 284
 285    if (fLog) {
 286       char *fnm;
 287       if (!fnm_output_base) {
 288          char *p;
 289          p = baseleaf_from_fnm(argv[optind]);
 290          fnm = add_ext(p, EXT_LOG);
 291          osfree(p);
 292       } else if (fnm_output_base_is_dir) {
 293          char *p;
 294          fnm = baseleaf_from_fnm(argv[optind]);
 295          p = use_path(fnm_output_base, fnm);
 296          osfree(fnm);
 297          fnm = add_ext(p, EXT_LOG);
 298          osfree(p);
 299       } else {
 300          fnm = add_ext(fnm_output_base, EXT_LOG);
 301       }
 302
 303       if (!freopen(fnm, "w", stdout))
 304          fatalerror(/*Failed to open output file “%s”*/47, fnm);
 305
 306       osfree(fnm);
 307    }
 308
 309    if (!fMute) {
 310       const char *p = COPYRIGHT_MSG;
 311       puts(PRETTYPACKAGE" "VERSION);
 312       while (1) {
 313           const char *q = p;
 314           p = strstr(p, "(C)");
 315           if (p == NULL) {
 316               puts(q);
 317               break;
 318           }
 319           fwrite(q, 1, p - q, stdout);
 320           fputs(msg(/*©*/0), stdout);
 321           p += 3;
 322       }
 323    }
 324
 325    atexit(delete_output_on_error);
 326
 327    /* end of options, now process data files */
 328    while (argv[optind]) {
 329       const char *fnm = argv[optind];
 330
 331       if (!fExplicitTitle) {
 332           char *lf = baseleaf_from_fnm(fnm);
 333           if (s_empty(&survey_title)) {
 334               s_donate(&survey_title, lf);
 335           } else {
 336               s_catchar(&survey_title, ' ');
 337               s_cat(&survey_title, lf);
 338               osfree(lf);
 339           }
 340       }
 341
 342       /* Select defaults settings */
 343       default_all(pcs);
 344       data_file(NULL, fnm); /* first argument is current path */
 345
 346       optind++;
 347    }
 348
 349    validate();
 350
 351    report_declination(pcs);
 352
 353    solve_network(/*stnlist*/); /* Find coordinates of all points */
 354    validate();
 355
 356    /* close .3d file */
 357    if (!img_close(pimg)) {
 358       char *fnm = add_ext(fnm_output_base, EXT_SVX_3D);
 359       fatalerror(img_error2msg(img_error()), fnm);
 360    }
 361    if (fhErrStat) safe_fclose(fhErrStat);
 362
 363    out_current_action(msg(/*Calculating statistics*/120));
 364    if (!fMute) do_stats();
 365    if (!fQuiet) {
 366       /* clock() typically wraps after 72 minutes, but there doesn't seem
 367        * to be a better way.  Still 72 minutes means some cave!
 368        * We detect if clock() could have wrapped and suppress CPU time
 369        * printing in this case.
 370        */
 371       double tmUser = difftime(time(NULL), tmUserStart);
 372       double tmCPU;
 373       clock_t now = clock();
 374 #define CLOCK_T_WRAP \
 375         (sizeof(clock_t)<sizeof(long)?(1ul << (CHAR_BIT * sizeof(clock_t))):0)
 376       tmCPU = (now - (unsigned long)tmCPUStart)
 377          / (double)CLOCKS_PER_SEC;
 378       if (now < tmCPUStart)
 379          tmCPU += CLOCK_T_WRAP / (double)CLOCKS_PER_SEC;
 380       if (tmUser >= tmCPU + CLOCK_T_WRAP / (double)CLOCKS_PER_SEC)
 381          tmCPU = 0;
 382
 383       /* tmUser is integer, tmCPU not - equivalent to (ceil(tmCPU) >= tmUser) */
 384       if (tmCPU + 1 > tmUser) {
 385          printf(msg(/*CPU time used %5.2fs*/140), tmCPU);
 386       } else if (tmCPU == 0) {
 387          if (tmUser != 0.0) {
 388             printf(msg(/*Time used %5.2fs*/141), tmUser);
 389          } else {
 390             fputs(msg(/*Time used unavailable*/142), stdout);
 391          }
 392       } else {
 393          printf(msg(/*Time used %5.2fs (%5.2fs CPU time)*/143), tmUser, tmCPU);
 394       }
 395       putnl();
 396    }
 397    if (msg_warnings || msg_errors) {
 398       if (msg_errors || (f_warnings_are_errors && msg_warnings)) {
 399          printf(msg(/*There were %d warning(s) and %d error(s) - no output files produced.*/113),
 400                 msg_warnings, msg_errors);
 401          putnl();
 402          return EXIT_FAILURE;
 403       }
 404       printf(msg(/*There were %d warning(s).*/16), msg_warnings);
 405       putnl();
 406    }
 407    return EXIT_SUCCESS;
 408 }
 409
 410 static void
 411 do_range(int d, int msgno, real length_factor, const char * units)
 412 {
 413    if (d < 3) {
 414       /* If the bound including anonymous stations is at an anonymous station
 415        * but the bound only considering named stations is the same, use the
 416        * named station for the anonymous bound too.
 417        */
 418       if (TSTBIT(pfxHi[d]->sflags, SFLAGS_ANON) && max[d] == max[d + 3]) {
 419          pfxHi[d] = pfxHi[d + 3];
 420       }
 421       if (TSTBIT(pfxLo[d]->sflags, SFLAGS_ANON) && min[d] == min[d + 3]) {
 422          pfxLo[d] = pfxLo[d + 3];
 423       }
 424    }
 425
 426    /* sprint_prefix uses a single buffer, so to report two stations in one
 427     * message we need to make a temporary copy of the string for one of them.
 428     */
 429    char * pfx_hi = osstrdup(sprint_prefix(pfxHi[d]));
 430    char * pfx_lo = sprint_prefix(pfxLo[d]);
 431    real hi = max[d] * length_factor;
 432    real lo = min[d] * length_factor;
 433    printf(msg(msgno), hi - lo, units, pfx_hi, hi, units, pfx_lo, lo, units);
 434    osfree(pfx_hi);
 435    putnl();
 436
 437    /* Range without anonymous stations at offset 3. */
 438    if (d < 3 && (pfxHi[d] != pfxHi[d + 3] || pfxLo[d] != pfxLo[d + 3])) {
 439       do_range(d + 3, msgno, length_factor, units);
 440    }
 441 }
 442
 443 static void
 444 do_stats(void)
 445 {
 446    long cLoops = cComponents + cLegs - cStns;
 447    int length_units = get_length_units(Q_LENGTH);
 448    const char * units = get_units_string(length_units);
 449    real length_factor = 1.0 / get_units_factor(length_units);
 450
 451    putnl();
 452
 453    if (cStns == 1) {
 454       fputs(msg(/*Survey contains 1 survey station,*/172), stdout);
 455    } else {
 456       printf(msg(/*Survey contains %ld survey stations,*/173), cStns);
 457    }
 458
 459    if (cLegs == 1) {
 460       fputs(msg(/* joined by 1 leg.*/174), stdout);
 461    } else {
 462       printf(msg(/* joined by %ld legs.*/175), cLegs);
 463    }
 464
 465    putnl();
 466
 467    if (cLoops == 1) {
 468       fputs(msg(/*There is 1 loop.*/138), stdout);
 469    } else {
 470       printf(msg(/*There are %ld loops.*/139), cLoops);
 471    }
 472
 473    putnl();
 474
 475    if (cComponents != 1) {
 476       /* TRANSLATORS: "Connected component" in the graph theory sense - it
 477        * means there are %ld bits of survey with no connections between them.
 478        * This message is only used if there are more than 1. */
 479       printf(msg(/*Survey has %ld connected components.*/178), cComponents);
 480       putnl();
 481    }
 482
 483    printf(msg(/*Total length of survey legs = %7.2f%s (%7.2f%s adjusted)*/132),
 484           total * length_factor, units, totadj * length_factor, units);
 485    putnl();
 486    printf(msg(/*Total plan length of survey legs = %7.2f%s*/133),
 487           totplan * length_factor, units);
 488    putnl();
 489    printf(msg(/*Total vertical length of survey legs = %7.2f%s*/134),
 490           totvert * length_factor, units);
 491    putnl();
 492
 493    /* If there's no underground survey, we've no ranges */
 494    if (pfxHi[0]) {
 495       /* TRANSLATORS: numbers are altitudes of highest and lowest stations */
 496       do_range(2, /*Vertical range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/135,
 497                length_factor, units);
 498       /* TRANSLATORS: c.f. previous message */
 499       do_range(1, /*North-South range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/136,
 500                length_factor, units);
 501       /* TRANSLATORS: c.f. previous two messages */
 502       do_range(0, /*East-West range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/137,
 503                length_factor, units);
 504    }
 505
 506    print_node_stats();
 507    /* Also, could give:
 508     *  # nodes stations (ie have other than two references or are fixed)
 509     *  # fixed stations (list of?)
 510     */
 511 }