source: git/src/cavern.c

faster-cavernlog
Last change on this file was c606770, checked in by Olly Betts <olly@…>, 3 weeks ago

Try to eliminate osdepend.{c,h} again

  • Property mode set to 100644
File size: 14.2 KB
RevLine 
[0156ccfc]1/* cavern.c
[bb90203]2 * SURVEX Cave surveying software: data reduction main and related functions
[4bea0f8]3 * Copyright (C) 1991-2023 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;
[63d4f07]63bool fExportUsed = false;
[c092d72]64char * proj_str_out = NULL;
[da9163b]65PJ * pj_cached = NULL;
[bb90203]66
67FILE *fhErrStat = NULL;
[693388e]68img *pimg = NULL;
[63d4f07]69bool fQuiet = false; /* just show brief summary + errors */
70bool fMute = false; /* just show errors */
71bool fSuppress = false; /* only output 3d file */
72static bool fLog = false; /* stdout to .log file */
73static bool f_warnings_are_errors = false; /* turn warnings into errors */
[647407d]74
75nosurveylink *nosurveyhead;
[bb90203]76
77real totadj, total, totplan, totvert;
[dfac588]78real min[6], max[6];
79prefix *pfxHi[6], *pfxLo[6];
[bb90203]80
[0532954]81string survey_title = S_INIT;
[bb90203]82
[63d4f07]83bool fExplicitTitle = false;
[bb90203]84
[8e8057c]85char *fnm_output_base = NULL;
86int fnm_output_base_is_dir = 0;
87
[ee05463]88lrudlist * model = NULL;
89lrud ** next_lrud = NULL;
90
[5d59477]91char output_separator = '.';
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;
[4bea0f8]186   pcs->convergence = HUGE_REAL;
[37d6b84]187   pcs->dec_filename = NULL;
188   pcs->dec_line = 0;
189   pcs->dec_context = NULL;
190   pcs->dec_lat = HUGE_VAL;
191   pcs->dec_lon = HUGE_VAL;
192   pcs->dec_alt = HUGE_VAL;
193   pcs->min_declination = HUGE_VAL;
194   pcs->max_declination = -HUGE_VAL;
[bb90203]195
196   /* Set up root of prefix hierarchy */
197   root = osnew(prefix);
198   root->up = root->right = root->down = NULL;
199   root->stn = NULL;
[421b7d2]200   root->pos = NULL;
[ff6cfe1]201   root->ident = NULL;
[932f7e9]202   root->min_export = root->max_export = 0;
[95c3272]203   root->sflags = BIT(SFLAGS_SURVEY);
[016068a]204   root->filename = NULL;
[647407d]205
206   nosurveyhead = NULL;
[bb90203]207
208   stnlist = NULL;
209   cLegs = cStns = cComponents = 0;
210   totadj = total = totplan = totvert = 0.0;
211
[0590246]212   for (d = 0; d < 6; d++) {
[fa42426]213      min[d] = HUGE_REAL;
214      max[d] = -HUGE_REAL;
[bb90203]215      pfxHi[d] = pfxLo[d] = NULL;
216   }
217
[d06141c]218   /* at least one argument must be given */
[b85e20f]219   cmdline_init(argc, argv, short_opts, long_opts, NULL, help, 1, -1);
[bb90203]220   while (1) {
[b85e20f]221      int opt = cmdline_getopt();
[bb90203]222      if (opt == EOF) break;
223      switch (opt) {
224       case 'p':
[21904d3]225         /* Ignore for compatibility with older versions. */
[b4fe9fb]226         break;
[8e8057c]227       case 'o': {
[9206096]228         osfree(fnm_output_base); /* in case of multiple -o options */
[8e8057c]229         /* can be a directory (in which case use basename of leaf input)
230          * or a file (in which case just trim the extension off) */
231         if (fDirectory(optarg)) {
232            /* this is a little tricky - we need to note the path here,
233             * and then add the leaf later on (in datain.c) */
234            fnm_output_base = base_from_fnm(optarg);
235            fnm_output_base_is_dir = 1;
236         } else {
237            fnm_output_base = base_from_fnm(optarg);
238         }
239         break;
240       }
[647407d]241       case 'q':
242         if (fQuiet) fMute = 1;
243         fQuiet = 1;
244         break;
245       case 's':
246         fSuppress = 1;
247         break;
[4833448]248       case 'v': {
249         int v = atoi(optarg);
250         if (v < IMG_VERSION_MIN || v > IMG_VERSION_MAX)
251            fatalerror(/*3d file format versions %d to %d supported*/88,
252                       IMG_VERSION_MIN, IMG_VERSION_MAX);
253         img_output_version = v;
254         break;
255       }
[bb9d869]256       case 'w':
257         f_warnings_are_errors = 1;
258         break;
[8e8057c]259       case 'z': {
260         /* Control which network optimisations are used (development tool) */
261         static int first_opt_z = 1;
[eb18f4d]262         char c;
[8e8057c]263         if (first_opt_z) {
[bb90203]264            optimize = 0;
[8e8057c]265            first_opt_z = 0;
[bb90203]266         }
[c50391b8]267         /* Lollipops, Parallel legs, Iterate mx, Delta* */
[eb18f4d]268         while ((c = *optarg++) != '\0')
[0580c6a]269            if (islower((unsigned char)c)) optimize |= BITA(c);
[0dab87a]270         break;
271       case 1:
[63d4f07]272         fLog = true;
[bb90203]273         break;
[affaeee]274#if OS_WIN32
[0dab87a]275       case 2:
[5b68ae1]276         atexit(pause_on_exit);
277         break;
278#endif
[bb90203]279       }
280      }
281   }
282
[0dab87a]283   if (fLog) {
284      char *fnm;
[9887ea0]285      if (!fnm_output_base) {
286         char *p;
287         p = baseleaf_from_fnm(argv[optind]);
[0156ccfc]288         fnm = add_ext(p, EXT_LOG);
[421b7d2]289         osfree(p);
[9887ea0]290      } else if (fnm_output_base_is_dir) {
[09e8f4c]291         char *p;
292         fnm = baseleaf_from_fnm(argv[optind]);
293         p = use_path(fnm_output_base, fnm);
294         osfree(fnm);
[0156ccfc]295         fnm = add_ext(p, EXT_LOG);
[09e8f4c]296         osfree(p);
297      } else {
[0156ccfc]298         fnm = add_ext(fnm_output_base, EXT_LOG);
[09e8f4c]299      }
[421b7d2]300
[0dab87a]301      if (!freopen(fnm, "w", stdout))
[0804fbe]302         fatalerror(/*Failed to open output file “%s”*/47, fnm);
[0dab87a]303
304      osfree(fnm);
305   }
306
[facdf7a]307   if (!fMute) {
308      const char *p = COPYRIGHT_MSG;
309      puts(PRETTYPACKAGE" "VERSION);
310      while (1) {
311          const char *q = p;
312          p = strstr(p, "(C)");
313          if (p == NULL) {
314              puts(q);
315              break;
316          }
317          fwrite(q, 1, p - q, stdout);
[ee7511a]318          fputs(msg(/*©*/0), stdout);
[facdf7a]319          p += 3;
320      }
321   }
[bb90203]322
[25ab06b]323   atexit(delete_output_on_error);
324
[bb90203]325   /* end of options, now process data files */
326   while (argv[optind]) {
327      const char *fnm = argv[optind];
328
329      if (!fExplicitTitle) {
[0532954]330          char *lf = baseleaf_from_fnm(fnm);
331          if (s_empty(&survey_title)) {
332              s_donate(&survey_title, lf);
333          } else {
334              s_catchar(&survey_title, ' ');
335              s_cat(&survey_title, lf);
336              osfree(lf);
337          }
[bb90203]338      }
339
340      /* Select defaults settings */
341      default_all(pcs);
[f4b609d]342      data_file(NULL, fnm); /* first argument is current path */
[cb3d1e2]343
[bb90203]344      optind++;
345   }
[cb3d1e2]346
[bb90203]347   validate();
348
[37d6b84]349   report_declination(pcs);
350
[bb90203]351   solve_network(/*stnlist*/); /* Find coordinates of all points */
352   validate();
[421b7d2]353
[a4ae909]354   /* close .3d file */
355   if (!img_close(pimg)) {
356      char *fnm = add_ext(fnm_output_base, EXT_SVX_3D);
[a405bc1]357      fatalerror(img_error2msg(img_error()), fnm);
[647407d]358   }
[7104f16]359   if (fhErrStat) safe_fclose(fhErrStat);
[bb90203]360
361   out_current_action(msg(/*Calculating statistics*/120));
[2b6eca8]362   if (!fMute) do_stats();
[647407d]363   if (!fQuiet) {
[f03053a7]364      /* clock() typically wraps after 72 minutes, but there doesn't seem
365       * to be a better way.  Still 72 minutes means some cave!
[be97baf]366       * We detect if clock() could have wrapped and suppress CPU time
367       * printing in this case.
[f03053a7]368       */
[be97baf]369      double tmUser = difftime(time(NULL), tmUserStart);
370      double tmCPU;
371      clock_t now = clock();
372#define CLOCK_T_WRAP \
373        (sizeof(clock_t)<sizeof(long)?(1ul << (CHAR_BIT * sizeof(clock_t))):0)
374      tmCPU = (now - (unsigned long)tmCPUStart)
375         / (double)CLOCKS_PER_SEC;
376      if (now < tmCPUStart)
377         tmCPU += CLOCK_T_WRAP / (double)CLOCKS_PER_SEC;
378      if (tmUser >= tmCPU + CLOCK_T_WRAP / (double)CLOCKS_PER_SEC)
379         tmCPU = 0;
[647407d]380
[27b8b59]381      /* tmUser is integer, tmCPU not - equivalent to (ceil(tmCPU) >= tmUser) */
[647407d]382      if (tmCPU + 1 > tmUser) {
[421b7d2]383         printf(msg(/*CPU time used %5.2fs*/140), tmCPU);
[647407d]384      } else if (tmCPU == 0) {
[27b8b59]385         if (tmUser != 0.0) {
[421b7d2]386            printf(msg(/*Time used %5.2fs*/141), tmUser);
[647407d]387         } else {
[421b7d2]388            fputs(msg(/*Time used unavailable*/142), stdout);
[647407d]389         }
[bb90203]390      } else {
[5b68ae1]391         printf(msg(/*Time used %5.2fs (%5.2fs CPU time)*/143), tmUser, tmCPU);
[bb90203]392      }
[5b68ae1]393      putnl();
[647407d]394   }
[25ab06b]395   if (msg_warnings || msg_errors) {
[7ebee5b]396      if (msg_errors || (f_warnings_are_errors && msg_warnings)) {
[5311876]397         printf(msg(/*There were %d warning(s) and %d error(s) - no output files produced.*/113),
[7ebee5b]398                msg_warnings, msg_errors);
399         putnl();
400         return EXIT_FAILURE;
401      }
402      printf(msg(/*There were %d warning(s).*/16), msg_warnings);
[25ab06b]403      putnl();
404   }
[bb9d869]405   return EXIT_SUCCESS;
[bb90203]406}
407
408static void
[85c0078]409do_range(int d, int msgno, real length_factor, const char * units)
[bb90203]410{
[1a21d04]411   if (d < 3) {
412      /* If the bound including anonymous stations is at an anonymous station
413       * but the bound only considering named stations is the same, use the
414       * named station for the anonymous bound too.
415       */
416      if (TSTBIT(pfxHi[d]->sflags, SFLAGS_ANON) && max[d] == max[d + 3]) {
417         pfxHi[d] = pfxHi[d + 3];
418      }
419      if (TSTBIT(pfxLo[d]->sflags, SFLAGS_ANON) && min[d] == min[d + 3]) {
420         pfxLo[d] = pfxLo[d + 3];
421      }
422   }
423
[ccc815d5]424   /* sprint_prefix uses a single buffer, so to report two stations in one
425    * message we need to make a temporary copy of the string for one of them.
426    */
[aecd032]427   char * pfx_hi = osstrdup(sprint_prefix(pfxHi[d]));
428   char * pfx_lo = sprint_prefix(pfxLo[d]);
[85c0078]429   real hi = max[d] * length_factor;
430   real lo = min[d] * length_factor;
431   printf(msg(msgno), hi - lo, units, pfx_hi, hi, units, pfx_lo, lo, units);
[aecd032]432   osfree(pfx_hi);
[2b6eca8]433   putnl();
[dfac588]434
[378112a]435   /* Range without anonymous stations at offset 3. */
[dfac588]436   if (d < 3 && (pfxHi[d] != pfxHi[d + 3] || pfxLo[d] != pfxLo[d + 3])) {
437      do_range(d + 3, msgno, length_factor, units);
438   }
[bb90203]439}
440
441static void
[06a871f]442do_stats(void)
[bb90203]443{
444   long cLoops = cComponents + cLegs - cStns;
[85c0078]445   int length_units = get_length_units(Q_LENGTH);
446   const char * units = get_units_string(length_units);
447   real length_factor = 1.0 / get_units_factor(length_units);
[bb90203]448
[2b6eca8]449   putnl();
[bb90203]450
[a63fdd2a]451   if (cStns == 1) {
[2b6eca8]452      fputs(msg(/*Survey contains 1 survey station,*/172), stdout);
[a63fdd2a]453   } else {
[2b6eca8]454      printf(msg(/*Survey contains %ld survey stations,*/173), cStns);
[a63fdd2a]455   }
[bb90203]456
[a63fdd2a]457   if (cLegs == 1) {
[2b6eca8]458      fputs(msg(/* joined by 1 leg.*/174), stdout);
[a63fdd2a]459   } else {
[2b6eca8]460      printf(msg(/* joined by %ld legs.*/175), cLegs);
[a63fdd2a]461   }
[bb90203]462
[2b6eca8]463   putnl();
[bb90203]464
[a63fdd2a]465   if (cLoops == 1) {
[2b6eca8]466      fputs(msg(/*There is 1 loop.*/138), stdout);
[a63fdd2a]467   } else {
[2b6eca8]468      printf(msg(/*There are %ld loops.*/139), cLoops);
[a63fdd2a]469   }
[bb90203]470
[2b6eca8]471   putnl();
[bb90203]472
473   if (cComponents != 1) {
[736f7df]474      /* TRANSLATORS: "Connected component" in the graph theory sense - it
475       * means there are %ld bits of survey with no connections between them.
476       * This message is only used if there are more than 1. */
[2b6eca8]477      printf(msg(/*Survey has %ld connected components.*/178), cComponents);
[a63fdd2a]478      putnl();
479   }
[bb90203]480
[85c0078]481   printf(msg(/*Total length of survey legs = %7.2f%s (%7.2f%s adjusted)*/132),
482          total * length_factor, units, totadj * length_factor, units);
[2b6eca8]483   putnl();
[85c0078]484   printf(msg(/*Total plan length of survey legs = %7.2f%s*/133),
485          totplan * length_factor, units);
[2b6eca8]486   putnl();
[85c0078]487   printf(msg(/*Total vertical length of survey legs = %7.2f%s*/134),
488          totvert * length_factor, units);
[2b6eca8]489   putnl();
490
[4ae2ea4]491   /* If there's no underground survey, we've no ranges */
492   if (pfxHi[0]) {
[736f7df]493      /* TRANSLATORS: numbers are altitudes of highest and lowest stations */
[85c0078]494      do_range(2, /*Vertical range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/135,
495               length_factor, units);
[736f7df]496      /* TRANSLATORS: c.f. previous message */
[85c0078]497      do_range(1, /*North-South range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/136,
498               length_factor, units);
[736f7df]499      /* TRANSLATORS: c.f. previous two messages */
[85c0078]500      do_range(0, /*East-West range = %4.2f%s (from %s at %4.2f%s to %s at %4.2f%s)*/137,
501               length_factor, units);
[4ae2ea4]502   }
[bb90203]503
[2b6eca8]504   print_node_stats();
[bb90203]505   /* Also, could give:
506    *  # nodes stations (ie have other than two references or are fixed)
507    *  # fixed stations (list of?)
508    */
509}
Note: See TracBrowser for help on using the repository browser.