src/survexport.cc

   1 /* survexport.cc
   2  * Convert a processed survey data file to another format.
   3  */
   4
   5 /* Copyright (C) 1994-2004,2008,2010,2011,2013,2014,2018,2020 Olly Betts
   6  * Copyright (C) 2004 John Pybus (SVG Output code)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #define MSG_SETUP_PROJ_SEARCH_PATH 1
  28
  29 #include <math.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33
  34 #include "export.h"
  35 #include "mainfrm.h"
  36
  37 #include "cmdline.h"
  38 #include "filename.h"
  39 #include "img_hosted.h"
  40 #include "message.h"
  41 #include "str.h"
  42 #include "useful.h"
  43
  44 #include <iostream>
  45 #include <string>
  46
  47 using namespace std;
  48
  49 int
  50 main(int argc, char **argv)
  51 {
  52    double pan = 0;
  53    double tilt = -90.0;
  54    export_format format = FMT_MAX_PLUS_ONE_;
  55    int show_mask = 0;
  56    const char *survey = NULL;
  57    double grid = 0.0; /* grid spacing (or 0 for no grid) */
  58    double text_height = DEFAULT_TEXT_HEIGHT; /* for station labels */
  59    double marker_size = DEFAULT_MARKER_SIZE; /* for station markers */
  60    double scale = 500.0;
  61    SurveyFilter* filter = NULL;
  62
  63    {
  64        /* Default to .pos output if installed as 3dtopos. */
  65        char* progname = baseleaf_from_fnm(argv[0]);
  66        if (strcasecmp(progname, "3dtopos") == 0) {
  67            format = FMT_POS;
  68        }
  69        osfree(progname);
  70    }
  71
  72    const int OPT_FMT_BASE = 20000;
  73    enum {
  74        OPT_SCALE = 0x100, OPT_BEARING, OPT_TILT, OPT_PLAN, OPT_ELEV,
  75        OPT_LEGS, OPT_SURF, OPT_SPLAYS, OPT_CROSSES, OPT_LABELS, OPT_ENTS,
  76        OPT_FIXES, OPT_EXPORTS, OPT_XSECT, OPT_WALLS, OPT_PASG,
  77        OPT_CENTRED, OPT_FULL_COORDS, OPT_CLAMP_TO_GROUND, OPT_DEFAULTS
  78    };
  79    static const struct option long_opts[] = {
  80         /* const char *name; int has_arg (0 no_argument, 1 required, 2 options_*); int *flag; int val */
  81         {"survey", required_argument, 0, 's'},
  82         {"scale", required_argument, 0, OPT_SCALE},
  83         {"bearing", required_argument, 0, OPT_BEARING},
  84         {"tilt", required_argument, 0, OPT_TILT},
  85         {"plan", no_argument, 0, OPT_PLAN},
  86         {"elevation", no_argument, 0, OPT_ELEV},
  87         {"legs", no_argument, 0, OPT_LEGS},
  88         {"surface-legs", no_argument, 0, OPT_SURF},
  89         {"splays", no_argument, 0, OPT_SPLAYS},
  90         {"crosses", no_argument, 0, OPT_CROSSES},
  91         {"station-names", no_argument, 0, OPT_LABELS},
  92         {"entrances", no_argument, 0, OPT_ENTS},
  93         {"fixes", no_argument, 0, OPT_FIXES},
  94         {"exports", no_argument, 0, OPT_EXPORTS},
  95         {"cross-sections", no_argument, 0, OPT_XSECT},
  96         {"walls", no_argument, 0, OPT_WALLS},
  97         {"passages", no_argument, 0, OPT_PASG},
  98         {"origin-in-centre", no_argument, 0, OPT_CENTRED},
  99         {"full-coordinates", no_argument, 0, OPT_FULL_COORDS},
 100         {"clamp-to-ground", no_argument, 0, OPT_CLAMP_TO_GROUND},
 101         {"defaults", no_argument, 0, OPT_DEFAULTS},
 102         {"grid", optional_argument, 0, 'g'},
 103         {"text-height", required_argument, 0, 't'},
 104         {"marker-size", required_argument, 0, 'm'},
 105         {"csv", no_argument, 0, OPT_FMT_BASE + FMT_CSV},
 106         {"dxf", no_argument, 0, OPT_FMT_BASE + FMT_DXF},
 107         {"eps", no_argument, 0, OPT_FMT_BASE + FMT_EPS},
 108         {"gpx", no_argument, 0, OPT_FMT_BASE + FMT_GPX},
 109         {"hpgl", no_argument, 0, OPT_FMT_BASE + FMT_HPGL},
 110         {"json", no_argument, 0, OPT_FMT_BASE + FMT_JSON},
 111         {"kml", no_argument, 0, OPT_FMT_BASE + FMT_KML},
 112         {"plt", no_argument, 0, OPT_FMT_BASE + FMT_PLT},
 113         {"skencil", no_argument, 0, OPT_FMT_BASE + FMT_SK},
 114         {"pos", no_argument, 0, OPT_FMT_BASE + FMT_POS},
 115         {"svg", no_argument, 0, OPT_FMT_BASE + FMT_SVG},
 116         {"help", no_argument, 0, HLP_HELP},
 117         {"version", no_argument, 0, HLP_VERSION},
 118         // US spelling:
 119         {"origin-in-center", no_argument, 0, OPT_CENTRED},
 120         // Abbreviation:
 121         {"full-coords", no_argument, 0, OPT_FULL_COORDS},
 122         {0,0,0,0}
 123    };
 124
 125 #define short_opts "s:g::t:m:"
 126
 127    static struct help_msg help[] = {
 128         /*                      <-- */
 129         {HLP_ENCODELONG(0),   /*only load the sub-survey with this prefix*/199, 0},
 130         /* TRANSLATORS: These example input values should not be translated. */
 131         {HLP_ENCODELONG(1),   /*scale (50, 0.02, 1:50 and 2:100 all mean 1:50)*/217, 0},
 132         /* TRANSLATORS: These example input values should not be translated. */
 133         {HLP_ENCODELONG(2),   /*bearing (90, 90d, 100g all mean 90°)*/460, 0},
 134         /* TRANSLATORS: These example input values should not be translated. */
 135         {HLP_ENCODELONG(3),   /*tilt (45, 45d, 50g, 100% all mean 45°)*/461, 0},
 136         /* TRANSLATORS: Don't translate example command line option --tilt=-90 */
 137         {HLP_ENCODELONG(4),   /*plan view (equivalent to --tilt=-90)*/462, 0},
 138         /* TRANSLATORS: Don't translate example command line option --tilt=0 */
 139         {HLP_ENCODELONG(5),   /*elevation view (equivalent to --tilt=0)*/463, 0},
 140         {HLP_ENCODELONG(6),   /*underground survey legs*/476, 0},
 141         {HLP_ENCODELONG(7),   /*surface survey legs*/464, 0},
 142         {HLP_ENCODELONG(8),   /*splay legs*/465, 0},
 143         {HLP_ENCODELONG(9),   /*station markers*/474, 0},
 144         {HLP_ENCODELONG(10),  /*station labels*/475, 0},
 145         {HLP_ENCODELONG(11),  /*entrances*/466, 0},
 146         {HLP_ENCODELONG(12),  /*fixed points*/467, 0},
 147         {HLP_ENCODELONG(13),  /*exported stations*/468, 0},
 148         {HLP_ENCODELONG(14),  /*cross-sections*/469, 0},
 149         {HLP_ENCODELONG(15),  /*walls*/470, 0},
 150         {HLP_ENCODELONG(16),  /*passages*/471, 0},
 151         {HLP_ENCODELONG(17),  /*origin in centre*/472, 0},
 152         {HLP_ENCODELONG(18),  /*full coordinates*/473, 0},
 153         {HLP_ENCODELONG(19),  /*clamp to ground*/478, 0},
 154         {HLP_ENCODELONG(20),  /*include items exported by default*/155, 0},
 155         {HLP_ENCODELONG(21),  /*generate grid (default %sm)*/148, STRING(DEFAULT_GRID_SPACING)},
 156         {HLP_ENCODELONG(22),  /*station labels text height (default %s)*/149, STRING(DEFAULT_TEXT_HEIGHT)},
 157         {HLP_ENCODELONG(23),  /*station marker size (default %s)*/152, STRING(DEFAULT_MARKER_SIZE)},
 158         {HLP_ENCODELONG(24),  /*produce CSV output*/102, 0},
 159         {HLP_ENCODELONG(25),  /*produce DXF output*/156, 0},
 160         {HLP_ENCODELONG(26),  /*produce EPS output*/454, 0},
 161         {HLP_ENCODELONG(27),  /*produce GPX output*/455, 0},
 162         {HLP_ENCODELONG(28),  /*produce HPGL output*/456, 0},
 163         {HLP_ENCODELONG(29),  /*produce JSON output*/457, 0},
 164         {HLP_ENCODELONG(30),  /*produce KML output*/458, 0},
 165         /* TRANSLATORS: "Compass" and "Carto" are the names of software packages,
 166          * so should not be translated. */
 167         {HLP_ENCODELONG(31),  /*produce Compass PLT output for Carto*/159, 0},
 168         /* TRANSLATORS: "Skencil" is the name of a software package, so should not be
 169          * translated. */
 170         {HLP_ENCODELONG(32),  /*produce Skencil output*/158, 0},
 171         {HLP_ENCODELONG(33),  /*produce Survex POS output*/459, 0},
 172         {HLP_ENCODELONG(34),  /*produce SVG output*/160, 0},
 173         {0, 0, 0}
 174    };
 175
 176    msg_init(argv);
 177
 178    string optmap[sizeof(show_mask) * CHAR_BIT];
 179
 180    int long_index;
 181    bool always_include_defaults = false;
 182    cmdline_init(argc, argv, short_opts, long_opts, &long_index, help, 1, 2);
 183    while (1) {
 184       long_index = -1;
 185       int opt = cmdline_getopt();
 186       if (opt == EOF) break;
 187       int bit = 0;
 188       switch (opt) {
 189        case OPT_LEGS:
 190          bit = LEGS;
 191          break;
 192        case OPT_SURF:
 193          bit = SURF;
 194          break;
 195        case OPT_SPLAYS:
 196          bit = SPLAYS;
 197          break;
 198        case OPT_CROSSES:
 199          bit = STNS;
 200          break;
 201        case OPT_LABELS:
 202          bit = LABELS;
 203          break;
 204        case OPT_ENTS:
 205          bit = ENTS;
 206          break;
 207        case OPT_FIXES:
 208          bit = FIXES;
 209          break;
 210        case OPT_EXPORTS:
 211          bit = EXPORTS;
 212          break;
 213        case OPT_XSECT:
 214          bit = XSECT;
 215          break;
 216        case OPT_WALLS:
 217          bit = WALLS;
 218          break;
 219        case OPT_PASG:
 220          bit = PASG;
 221          break;
 222        case OPT_CENTRED:
 223          bit = CENTRED;
 224          break;
 225        case OPT_FULL_COORDS:
 226          bit = FULL_COORDS;
 227          break;
 228        case OPT_CLAMP_TO_GROUND:
 229          bit = CLAMP_TO_GROUND;
 230          break;
 231        case OPT_DEFAULTS:
 232          always_include_defaults = true;
 233          break;
 234        case 'g': /* Grid */
 235          if (optarg) {
 236             grid = cmdline_double_arg();
 237          } else {
 238             grid = (double)DEFAULT_GRID_SPACING;
 239          }
 240          bit = GRID;
 241          break;
 242        case OPT_SCALE: {
 243          char* colon = strchr(optarg, ':');
 244          if (!colon) {
 245              /* --scale=1000 => 1:1000 => scale = 1000 */
 246              scale = cmdline_double_arg();
 247              if (scale < 1.0) {
 248                  /* --scale=0.001 => 1:1000 => scale = 1000 */
 249                  scale = 1.0 / scale;
 250              }
 251          } else if (colon - optarg == 1 && optarg[0] == '1') {
 252              /* --scale=1:1000 => 1:1000 => scale = 1000 */
 253              optarg += 2;
 254              scale = cmdline_double_arg();
 255              optarg -= 2;
 256          } else {
 257              /* --scale=2:1000 => 1:500 => scale = 500 */
 258              *colon = '\0';
 259              scale = cmdline_double_arg();
 260              optarg = colon + 1;
 261              scale = cmdline_double_arg() / scale;
 262              *colon = ':';
 263          }
 264          bit = SCALE;
 265          break;
 266        }
 267        case OPT_BEARING: {
 268          int units = 0;
 269          size_t len = strlen(optarg);
 270          if (len > 0) {
 271              char ch = optarg[len - 1];
 272              switch (ch) {
 273                  case 'd':
 274                  case 'g':
 275                      units = ch;
 276                      optarg[len - 1] = '\0';
 277                      break;
 278              }
 279              pan = cmdline_double_arg();
 280              optarg[len - 1] = ch;
 281          } else {
 282              pan = cmdline_double_arg();
 283          }
 284          if (units == 'g') {
 285              pan *= 0.9;
 286          }
 287          bit = ORIENTABLE;
 288          break;
 289        }
 290        case OPT_TILT: {
 291          int units = 0;
 292          size_t len = strlen(optarg);
 293          if (len > 0) {
 294              char ch = optarg[len - 1];
 295              switch (ch) {
 296                  case '%':
 297                  case 'd':
 298                  case 'g':
 299                      units = ch;
 300                      optarg[len - 1] = '\0';
 301                      break;
 302              }
 303              tilt = cmdline_double_arg();
 304              optarg[len - 1] = ch;
 305          } else {
 306              tilt = cmdline_double_arg();
 307          }
 308          if (units == 'g') {
 309              tilt *= 0.9;
 310          } else if (units == '%') {
 311              tilt = deg(atan(tilt * 0.01));
 312          }
 313          bit = ORIENTABLE;
 314          break;
 315        }
 316        case OPT_PLAN:
 317          tilt = -90.0;
 318          bit = ORIENTABLE;
 319          break;
 320        case OPT_ELEV:
 321          tilt = 0.0;
 322          bit = ORIENTABLE;
 323          break;
 324        case 't': /* Text height */
 325          text_height = cmdline_double_arg();
 326          bit = TEXT_HEIGHT;
 327          break;
 328        case 'm': /* Marker size */
 329          marker_size = cmdline_double_arg();
 330          bit = MARKER_SIZE;
 331          break;
 332        case 's':
 333          if (survey) {
 334              if (!filter) {
 335                  filter = new SurveyFilter();
 336                  filter->add(survey);
 337              }
 338              filter->add(optarg);
 339          } else {
 340              survey = optarg;
 341          }
 342          break;
 343        default:
 344          if (opt >= OPT_FMT_BASE && opt < OPT_FMT_BASE + FMT_MAX_PLUS_ONE_) {
 345              format = export_format(opt - OPT_FMT_BASE);
 346          }
 347       }
 348       if (bit) {
 349           show_mask |= bit;
 350           int i = 0;
 351           while (((bit >> i) & 1) == 0) ++i;
 352
 353           if (!optmap[i].empty()) optmap[i] += ' ';
 354
 355           // Reconstruct what the command line option was.
 356           if (long_index < 0) {
 357               optmap[i] += '-';
 358               optmap[i] += char(opt);
 359               if (optarg) {
 360                   if (optarg == argv[optind - 1]) {
 361                       optmap[i] += ' ';
 362                   }
 363                   optmap[i] += optarg;
 364               }
 365           } else {
 366               optmap[i] += "--";
 367               optmap[i] += long_opts[long_index].name;
 368               if (optarg) {
 369                   if (optarg == argv[optind - 1]) {
 370                       optmap[i] += ' ';
 371                   } else {
 372                       optmap[i] += '=';
 373                   }
 374                   optmap[i] += optarg;
 375               }
 376           }
 377       }
 378    }
 379
 380    // A single --survey is handled by img at load-time.  Multiple --survey are
 381    // handled via a SurveyFilter at export time.
 382    if (filter) survey = NULL;
 383
 384    const char* fnm_in = argv[optind++];
 385    const char* fnm_out = argv[optind];
 386    if (fnm_out) {
 387       if (format == FMT_MAX_PLUS_ONE_) {
 388          // Select format based on extension.
 389          size_t len = strlen(fnm_out);
 390          for (size_t i = 0; i < FMT_MAX_PLUS_ONE_; ++i) {
 391             const auto& info = export_format_info[i];
 392             size_t l = strlen(info.extension);
 393             if (len > l + 1 &&
 394                 strcasecmp(fnm_out + len - l, info.extension) == 0) {
 395                format = export_format(i);
 396                break;
 397             }
 398          }
 399          if (format == FMT_MAX_PLUS_ONE_) {
 400             fatalerror(/*Export format not specified and not known from output file extension*/252);
 401          }
 402       }
 403    } else {
 404       if (format == FMT_MAX_PLUS_ONE_) {
 405          fatalerror(/*Export format not specified*/253);
 406       }
 407       char *baseleaf = baseleaf_from_fnm(fnm_in);
 408       /* note : memory allocated by fnm_out gets leaked in this case... */
 409       fnm_out = add_ext(baseleaf, export_format_info[format].extension);
 410       osfree(baseleaf);
 411    }
 412
 413    const auto& format_info_mask = export_format_info[format].mask;
 414    unsigned not_allowed = show_mask &~ format_info_mask;
 415    if (not_allowed) {
 416        printf("warning: The following options are not supported for this export format and will be ignored:\n");
 417        int i = 0;
 418        unsigned bit = 1;
 419        while (not_allowed) {
 420            if (not_allowed & bit) {
 421                // E.g. --walls maps to two bits in show_mask, but the options
 422                // are only put on the least significant in such cases.
 423                if (!optmap[i].empty())
 424                    printf("%s\n", optmap[i].c_str());
 425                not_allowed &= ~bit;
 426            }
 427            ++i;
 428            bit <<= 1;
 429        }
 430        show_mask &= format_info_mask;
 431    }
 432
 433    if (always_include_defaults || show_mask == 0) {
 434        show_mask |= export_format_info[format].defaults;
 435    }
 436
 437    if (!(format_info_mask & ORIENTABLE)) {
 438        pan = 0.0;
 439        tilt = -90.0;
 440    }
 441
 442    Model model;
 443    int err = model.Load(fnm_in, survey);
 444    if (err) fatalerror(err, fnm_in);
 445    if (filter) filter->SetSeparator(model.GetSeparator());
 446
 447    try {
 448        if (!Export(fnm_out, model.GetSurveyTitle(),
 449                    model.GetDateString(),
 450                    model, filter,
 451                    pan, tilt, show_mask, format,
 452                    grid, text_height, marker_size,
 453                    scale)) {
 454           fatalerror(/*Couldn’t write file “%s”*/402, fnm_out);
 455        }
 456    } catch (const wxString & m) {
 457        wxString r = msg_appname();
 458        r += ": ";
 459        r += wmsg(/*error*/93);
 460        r += ": ";
 461        r += m;
 462        wcerr << r.c_str() << '\n';
 463    }
 464
 465    return 0;
 466 }