source: git/src/cavern.c @ 378112a

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

Use C-style comments

Not sure it's still actually useful, but at least currently the C
code is still C90.

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