source: git/src/cavern.c @ 62e7e3c

RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-data
Last change on this file since 62e7e3c was 62e7e3c, checked in by Olly Betts <olly@…>, 10 years ago

lib/,src/cavern.c,tests/: Eliminate the "Done." message which cavern
outputs near the end - it doesn't really serve a useful purpose.

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