source: git/src/cavern.c @ 8e3144c8

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

Simplify to avoid code duplication

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