source: git/src/cavern.c @ c964783

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

src/cavern.c: Remove unused function left over from recent change to
how coordinate ranges get reported.

git-svn-id: file:///home/survex-svn/survex/trunk@3679 4b37db11-9a0c-4f06-9ece-9ab7cdaee568

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