source: git/src/cavern.c @ 4475662

stereo-2025
Last change on this file since 4475662 was dedf67b, checked in by Olly Betts <olly@…>, 12 months ago

Fix to use new message for cavern --help

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