src/cavern.c

   1 /* cavern.c
   2  * SURVEX Cave surveying software: data reduction main and related functions
   3  * Copyright (C) 1991-2003,2004,2005,2010,2011,2013,2014,2015,2016,2017 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 "osdepend.h"
  44 #include "out.h"
  45 #include "str.h"
  46 #include "validate.h"
  47 #include "whichos.h"
  48
  49 #if OS_WIN32
  50 # include <conio.h> /* for _kbhit() and _getch() */
  51 #endif
  52
  53 /* For funcs which want to be immune from messing around with different
  54  * calling conventions */
  55 #ifndef CDECL
  56 # define CDECL
  57 #endif
  58
  59 /* Globals */
  60 node *stnlist = NULL;
  61 settings *pcs;
  62 prefix *root;
  63 prefix *anon_list = NULL;
  64 long cLegs, cStns;
  65 long cComponents;
  66 bool fExportUsed = fFalse;
  67 projPJ proj_out = NULL;
  68 char * proj_str_out = NULL;
  69
  70 FILE *fhErrStat = NULL;
  71 img *pimg = NULL;
  72 bool fQuiet = fFalse; /* just show brief summary + errors */
  73 bool fMute = fFalse; /* just show errors */
  74 bool fSuppress = fFalse; /* only output 3d file */
  75 static bool fLog = fFalse; /* stdout to .log file */
  76 static bool f_warnings_are_errors = fFalse; /* turn warnings into errors */
  77
  78 nosurveylink *nosurveyhead;
  79
  80 real totadj, total, totplan, totvert;
  81 real min[3], max[3];
  82 prefix *pfxHi[3], *pfxLo[3];
  83
  84 char *survey_title = NULL;
  85 int survey_title_len;
  86
  87 bool fExplicitTitle = fFalse;
  88
  89 char *fnm_output_base = NULL;
  90 int fnm_output_base_is_dir = 0;
  91
  92 lrudlist * model = NULL;
  93 lrud ** next_lrud = NULL;
  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 extern CDECL int
 156 main(int argc, char **argv)
 157 {
 158    int d;
 159    time_t tmUserStart = time(NULL);
 160    clock_t tmCPUStart = clock();
 161    {
 162        /* FIXME: localtime? */
 163        struct tm * t = localtime(&tmUserStart);
 164        int y = t->tm_year + 1900;
 165        current_days_since_1900 = days_since_1900(y, t->tm_mon + 1, t->tm_mday);
 166    }
 167
 168    /* Always buffer by line for aven's benefit. */
 169    setvbuf(stdout, NULL, _IOLBF, 0);
 170
 171    msg_init(argv);
 172
 173    pcs = osnew(settings);
 174    pcs->next = NULL;
 175    pcs->Translate = ((short*) osmalloc(ossizeof(short) * 257)) + 1;
 176    pcs->meta = NULL;
 177    pcs->proj = NULL;
 178    pcs->declination = HUGE_REAL;
 179    pcs->convergence = 0.0;
 180
 181    /* Set up root of prefix hierarchy */
 182    root = osnew(prefix);
 183    root->up = root->right = root->down = NULL;
 184    root->stn = NULL;
 185    root->pos = NULL;
 186    root->ident = NULL;
 187    root->min_export = root->max_export = 0;
 188    root->sflags = BIT(SFLAGS_SURVEY);
 189    root->filename = NULL;
 190
 191    nosurveyhead = NULL;
 192
 193    stnlist = NULL;
 194    cLegs = cStns = cComponents = 0;
 195    totadj = total = totplan = totvert = 0.0;
 196
 197    for (d = 0; d <= 2; d++) {
 198       min[d] = HUGE_REAL;
 199       max[d] = -HUGE_REAL;
 200       pfxHi[d] = pfxLo[d] = NULL;
 201    }
 202
 203    /* at least one argument must be given */
 204    cmdline_init(argc, argv, short_opts, long_opts, NULL, help, 1, -1);
 205    while (1) {
 206       int opt = cmdline_getopt();
 207       if (opt == EOF) break;
 208       switch (opt) {
 209        case 'p':
 210          /* Ignore for compatibility with older versions. */
 211          break;
 212        case 'o': {
 213          osfree(fnm_output_base); /* in case of multiple -o options */
 214          /* can be a directory (in which case use basename of leaf input)
 215           * or a file (in which case just trim the extension off) */
 216          if (fDirectory(optarg)) {
 217             /* this is a little tricky - we need to note the path here,
 218              * and then add the leaf later on (in datain.c) */
 219             fnm_output_base = base_from_fnm(optarg);
 220             fnm_output_base_is_dir = 1;
 221          } else {
 222             fnm_output_base = base_from_fnm(optarg);
 223          }
 224          break;
 225        }
 226        case 'q':
 227          if (fQuiet) fMute = 1;
 228          fQuiet = 1;
 229          break;
 230        case 's':
 231          fSuppress = 1;
 232          break;
 233        case 'v': {
 234          int v = atoi(optarg);
 235          if (v < IMG_VERSION_MIN || v > IMG_VERSION_MAX)
 236             fatalerror(/*3d file format versions %d to %d supported*/88,
 237                        IMG_VERSION_MIN, IMG_VERSION_MAX);
 238          img_output_version = v;
 239          break;
 240        }
 241        case 'w':
 242          f_warnings_are_errors = 1;
 243          break;
 244        case 'z': {
 245          /* Control which network optimisations are used (development tool) */
 246          static int first_opt_z = 1;
 247          char c;
 248          if (first_opt_z) {
 249             optimize = 0;
 250             first_opt_z = 0;
 251          }
 252          /* Lollipops, Parallel legs, Iterate mx, Delta* */
 253          while ((c = *optarg++) != '\0')
 254             if (islower((unsigned char)c)) optimize |= BITA(c);
 255          break;
 256        case 1:
 257          fLog = fTrue;
 258          break;
 259 #if OS_WIN32
 260        case 2:
 261          atexit(pause_on_exit);
 262          break;
 263 #endif
 264        }
 265       }
 266    }
 267
 268    if (fLog) {
 269       char *fnm;
 270       if (!fnm_output_base) {
 271          char *p;
 272          p = baseleaf_from_fnm(argv[optind]);
 273          fnm = add_ext(p, EXT_LOG);
 274          osfree(p);
 275       } else if (fnm_output_base_is_dir) {
 276          char *p;
 277          fnm = baseleaf_from_fnm(argv[optind]);
 278          p = use_path(fnm_output_base, fnm);
 279          osfree(fnm);
 280          fnm = add_ext(p, EXT_LOG);
 281          osfree(p);
 282       } else {
 283          fnm = add_ext(fnm_output_base, EXT_LOG);
 284       }
 285
 286       if (!freopen(fnm, "w", stdout))
 287          fatalerror(/*Failed to open output file “%s”*/47, fnm);
 288
 289       osfree(fnm);
 290    }
 291
 292    if (!fMute) {
 293       const char *p = COPYRIGHT_MSG;
 294       puts(PRETTYPACKAGE" "VERSION);
 295       while (1) {
 296           const char *q = p;
 297           p = strstr(p, "(C)");
 298           if (p == NULL) {
 299               puts(q);
 300               break;
 301           }
 302           fwrite(q, 1, p - q, stdout);
 303           fputs(msg(/*©*/0), stdout);
 304           p += 3;
 305       }
 306    }
 307
 308    atexit(delete_output_on_error);
 309
 310    /* end of options, now process data files */
 311    while (argv[optind]) {
 312       const char *fnm = argv[optind];
 313
 314       if (!fExplicitTitle) {
 315          char *lf;
 316          lf = baseleaf_from_fnm(fnm);
 317          if (survey_title) s_catchar(&survey_title, &survey_title_len, ' ');
 318          s_cat(&survey_title, &survey_title_len, lf);
 319          osfree(lf);
 320       }
 321
 322       /* Select defaults settings */
 323       default_all(pcs);
 324       data_file(NULL, fnm); /* first argument is current path */
 325
 326       optind++;
 327    }
 328
 329    validate();
 330
 331    solve_network(/*stnlist*/); /* Find coordinates of all points */
 332    validate();
 333
 334    /* close .3d file */
 335    if (!img_close(pimg)) {
 336       char *fnm = add_ext(fnm_output_base, EXT_SVX_3D);
 337       fatalerror(img_error2msg(img_error()), fnm);
 338    }
 339    if (fhErrStat) safe_fclose(fhErrStat);
 340
 341    out_current_action(msg(/*Calculating statistics*/120));
 342    if (!fMute) do_stats();
 343    if (!fQuiet) {
 344       /* clock() typically wraps after 72 minutes, but there doesn't seem
 345        * to be a better way.  Still 72 minutes means some cave!
 346        * We detect if clock() could have wrapped and suppress CPU time
 347        * printing in this case.
 348        */
 349       double tmUser = difftime(time(NULL), tmUserStart);
 350       double tmCPU;
 351       clock_t now = clock();
 352 #define CLOCK_T_WRAP \
 353         (sizeof(clock_t)<sizeof(long)?(1ul << (CHAR_BIT * sizeof(clock_t))):0)
 354       tmCPU = (now - (unsigned long)tmCPUStart)
 355          / (double)CLOCKS_PER_SEC;
 356       if (now < tmCPUStart)
 357          tmCPU += CLOCK_T_WRAP / (double)CLOCKS_PER_SEC;
 358       if (tmUser >= tmCPU + CLOCK_T_WRAP / (double)CLOCKS_PER_SEC)
 359          tmCPU = 0;
 360
 361       /* tmUser is integer, tmCPU not - equivalent to (ceil(tmCPU) >= tmUser) */
 362       if (tmCPU + 1 > tmUser) {
 363          printf(msg(/*CPU time used %5.2fs*/140), tmCPU);
 364       } else if (tmCPU == 0) {
 365          if (tmUser != 0.0) {
 366             printf(msg(/*Time used %5.2fs*/141), tmUser);
 367          } else {
 368             fputs(msg(/*Time used unavailable*/142), stdout);
 369          }
 370       } else {
 371          printf(msg(/*Time used %5.2fs (%5.2fs CPU time)*/143), tmUser, tmCPU);
 372       }
 373       putnl();
 374    }
 375    if (msg_warnings || msg_errors) {
 376       if (msg_errors || (f_warnings_are_errors && msg_warnings)) {
 377          printf(msg(/*There were %d warning(s) and %d error(s) - no output files produced.*/113),
 378                 msg_warnings, msg_errors);
 379          putnl();
 380          return EXIT_FAILURE;
 381       }
 382       printf(msg(/*There were %d warning(s).*/16), msg_warnings);
 383       putnl();
 384    }
 385    return EXIT_SUCCESS;
 386 }
 387
 388 static void
 389 do_range(int d, int msgno, real length_factor, const char * units)
 390 {
 391    /* sprint_prefix uses a single buffer, so to report two stations in one
 392     * message we need to make a temporary copy of the string for one of them.
 393     */
 394    char * pfx_hi = osstrdup(sprint_prefix(pfxHi[d]));
 395    char * pfx_lo = sprint_prefix(pfxLo[d]);
 396    real hi = max[d] * length_factor;
 397    real lo = min[d] * length_factor;
 398    printf(msg(msgno), hi - lo, units, pfx_hi, hi, units, pfx_lo, lo, units);
 399    osfree(pfx_hi);
 400    putnl();
 401 }
 402
 403 static void
 404 do_stats(void)
 405 {
 406    long cLoops = cComponents + cLegs - cStns;
 407    int length_units = get_length_units(Q_LENGTH);
 408    const char * units = get_units_string(length_units);
 409    real length_factor = 1.0 / get_units_factor(length_units);
 410
 411    putnl();
 412
 413    if (cStns == 1) {
 414       fputs(msg(/*Survey contains 1 survey station,*/172), stdout);
 415    } else {
 416       printf(msg(/*Survey contains %ld survey stations,*/173), cStns);
 417    }
 418
 419    if (cLegs == 1) {
 420       fputs(msg(/* joined by 1 leg.*/174), stdout);
 421    } else {
 422       printf(msg(/* joined by %ld legs.*/175), cLegs);
 423    }
 424
 425    putnl();
 426
 427    if (cLoops == 1) {
 428       fputs(msg(/*There is 1 loop.*/138), stdout);
 429    } else {
 430       printf(msg(/*There are %ld loops.*/139), cLoops);
 431    }
 432
 433    putnl();
 434
 435    if (cComponents != 1) {
 436       /* TRANSLATORS: "Connected component" in the graph theory sense - it
 437        * means there are %ld bits of survey with no connections between them.
 438        * This message is only used if there are more than 1. */
 439       printf(msg(/*Survey has %ld connected components.*/178), cComponents);
 440       putnl();
 441    }
 442
 443    printf(msg(/*Total length of survey legs = %7.2f%s (%7.2f%s adjusted)*/132),
 444           total * length_factor, units, totadj * length_factor, units);
 445    putnl();
 446    printf(msg(/*Total plan length of survey legs = %7.2f%s*/133),
 447           totplan * length_factor, units);
 448    putnl();
 449    printf(msg(/*Total vertical length of survey legs = %7.2f%s*/134),
 450           totvert * length_factor, units);
 451    putnl();
 452
 453    /* If there's no underground survey, we've no ranges */
 454    if (pfxHi[0]) {
 455       /* TRANSLATORS: numbers are altitudes of highest and lowest stations */
 456       do_range(2, /*Vertical range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/135,
 457                length_factor, units);
 458       /* TRANSLATORS: c.f. previous message */
 459       do_range(1, /*North-South range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/136,
 460                length_factor, units);
 461       /* TRANSLATORS: c.f. previous two messages */
 462       do_range(0, /*East-West range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/137,
 463                length_factor, units);
 464    }
 465
 466    print_node_stats();
 467    /* Also, could give:
 468     *  # nodes stations (ie have other than two references or are fixed)
 469     *  # fixed stations (list of?)
 470     */
 471 }