h3 3.4.4 → 3.5.0

data/ext/h3/src/src/apps/filters/geoToH3.c

@@ -17,7 +17,7 @@
  * @brief stdin/stdout filter that converts from lat/lon coordinates to integer
  * H3 indexes
  *
- *  usage: `geoToH3 --resolution res [--latitude lat --longitude lon]`
+ *  See `geoToH3 --help` for usage.
  *
  *  The program reads lat/lon pairs from stdin until EOF is encountered. For
  *  each lat/lon the program outputs to stdout the integer H3 index of the
@@ -32,8 +32,7 @@
  *       latN lonN
  */
 
-#include <stdio.h>
-#include <stdlib.h>
+#include "args.h"
 #include "h3Index.h"
 #include "utility.h"
 
@@ -58,8 +57,7 @@ int main(int argc, char* argv[]) {
     double lat = 0;
     double lon = 0;
 
-    Arg helpArg = {.names = {"-h", "--help"},
-                   .helpText = "Show this help message."};
+    Arg helpArg = ARG_HELP;
     Arg resArg = {.names = {"-r", "--resolution"},
                   .required = true,
                   .scanFormat = "%d",
@@ -72,7 +70,7 @@ int main(int argc, char* argv[]) {
                   .value = &lat,
                   .helpText =
                       "Latitude in degrees. If not specified, \"latitude "
-                      "longitude\" pairs will be read from stdin."};
+                      "longitude\" pairs will be read from standard input."};
     Arg lonArg = {.names = {"--lon", "--longitude"},
                   .scanFormat = "%lf",
                   .valueName = "lon",
@@ -80,17 +78,17 @@ int main(int argc, char* argv[]) {
                   .helpText = "Longitude in degrees."};
 
     Arg* args[] = {&helpArg, &resArg, &latArg, &lonArg};
-
+    const int numArgs = 4;
     const char* helpText =
         "Convert degrees latitude/longitude coordinates to H3 indexes.";
 
-    if (parseArgs(argc, argv, 4, args, &helpArg, helpText)) {
+    if (parseArgs(argc, argv, numArgs, args, &helpArg, helpText)) {
         return helpArg.found ? 0 : 1;
     }
 
     if (latArg.found != lonArg.found) {
         // One is found but the other is not.
-        printHelp(stderr, argv[0], helpText, 4, args,
+        printHelp(stderr, argv[0], helpText, numArgs, args,
                   "Latitude and longitude must both be specified.", NULL);
         return 1;
     }

data/ext/h3/src/src/apps/filters/h3ToComponents.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2017 Uber Technologies, Inc.
+ * Copyright 2016-2017, 2019 Uber Technologies, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,16 +17,14 @@
  * @brief stdin/stdout filter that converts from integer H3 indexes to
  * components.
  *
- *  usage: `h3ToComponents`
+ *  See `h3ToComponents --help` for usage.
  *
  *  The program reads H3 indexes from stdin until EOF and outputs the
  *  corresponding component strings to stdout.
  */
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include "baseCells.h"
+#include <inttypes.h>
+#include "args.h"
 #include "h3Index.h"
 #include "utility.h"
 
@@ -44,29 +42,12 @@ char resDigitToChar(int d) {
     return '0' + d;
 }
 
-void doCell(H3Index h, int verboseMode) {
+void doCell(H3Index h, bool verboseMode) {
     int h3Mode = H3_GET_MODE(h);
     int h3Res = H3_GET_RESOLUTION(h);
     int h3BaseCell = H3_GET_BASE_CELL(h);
-    if (verboseMode == 0) {
-        if (h3Mode == H3_HEXAGON_MODE) {
-            printf("%d:%d:%d:", h3Mode, h3Res, h3BaseCell);
-            for (int i = 1; i <= h3Res; i++) {
-                printf("%c", resDigitToChar(H3_GET_INDEX_DIGIT(h, i)));
-            }
-            printf("\n");
-        } else if (h3Mode == H3_UNIEDGE_MODE) {
-            printf("%d:%d:%d:%d:", h3Mode, H3_GET_RESERVED_BITS(h), h3Res,
-                   h3BaseCell);
-            for (int i = 1; i <= h3Res; i++) {
-                printf("%c", resDigitToChar(H3_GET_INDEX_DIGIT(h, i)));
-            }
-            printf("\n");
-        } else {
-            printf("INVALID INDEX\n");
-        }
-    } else {
-        char* modes[] = {
+    if (verboseMode) {
+        const char* modes[] = {
             "RESERVED",             // 0
             "Hexagon",              // 1
             "Unidirectional Edge",  // 2
@@ -100,33 +81,55 @@ void doCell(H3Index h, int verboseMode) {
                    resDigitToChar(H3_GET_INDEX_DIGIT(h, i)));
         }
         printf("╚════════════╝\n\n");
+    } else {
+        if (h3Mode == H3_HEXAGON_MODE) {
+            printf("%d:%d:%d:", h3Mode, h3Res, h3BaseCell);
+            for (int i = 1; i <= h3Res; i++) {
+                printf("%c", resDigitToChar(H3_GET_INDEX_DIGIT(h, i)));
+            }
+            printf("\n");
+        } else if (h3Mode == H3_UNIEDGE_MODE) {
+            printf("%d:%d:%d:%d:", h3Mode, H3_GET_RESERVED_BITS(h), h3Res,
+                   h3BaseCell);
+            for (int i = 1; i <= h3Res; i++) {
+                printf("%c", resDigitToChar(H3_GET_INDEX_DIGIT(h, i)));
+            }
+            printf("\n");
+        } else {
+            printf("INVALID INDEX\n");
+        }
     }
 }
 
 int main(int argc, char* argv[]) {
-    // check command line args
-    int verboseMode = 0;
-    if (argc > 1) {
-        if (strncmp("--verbose", argv[1], 9) == 0) {
-            verboseMode = 1;
-        } else {
-            fprintf(stderr, "usage: %s [--verbose]\n", argv[0]);
-            exit(1);
-        }
+    Arg helpArg = ARG_HELP;
+    Arg verboseArg = {.names = {"-v", "--verbose"},
+                      .helpText = "Verbose output mode."};
+    DEFINE_INDEX_ARG(index, indexArg);
+    const int numArgs = 3;
+    Arg* args[] = {&helpArg, &verboseArg, &indexArg};
+
+    if (parseArgs(argc, argv, numArgs, args, &helpArg,
+                  "Converts H3 indexes to component parts")) {
+        return helpArg.found ? 0 : 1;
     }
 
-    // process the indexes on stdin
-    char buff[BUFF_SIZE];
-    while (1) {
-        // get an index from stdin
-        if (!fgets(buff, BUFF_SIZE, stdin)) {
-            if (feof(stdin))
-                break;
-            else
-                error("reading H3 index from stdin");
-        }
+    if (indexArg.found) {
+        doCell(index, verboseArg.found);
+    } else {
+        // process the indexes on stdin
+        char buff[BUFF_SIZE];
+        while (1) {
+            // get an index from stdin
+            if (!fgets(buff, BUFF_SIZE, stdin)) {
+                if (feof(stdin))
+                    break;
+                else
+                    error("reading H3 index from stdin");
+            }
 
-        H3Index h3 = H3_EXPORT(stringToH3)(buff);
-        doCell(h3, verboseMode);
+            H3Index h3 = H3_EXPORT(stringToH3)(buff);
+            doCell(h3, verboseArg.found);
+        }
     }
 }

data/ext/h3/src/src/apps/filters/h3ToGeo.c

@@ -17,8 +17,7 @@
  * @brief stdin/stdout filter that converts from integer H3 indexes to lat/lon
  * cell center point
  *
- *  usage: `h3ToGeo [--index index] [--kml [--kml-name name] [--kml-description
- *  desc]]`
+ *  See `h3ToGeo --help` for usage.
  *
  *  The program reads H3 indexes from stdin and outputs the corresponding
  *  cell center points to stdout, until EOF is encountered. The H3 indexes
@@ -42,9 +41,7 @@
  */
 
 #include <inttypes.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
+#include "args.h"
 #include "h3api.h"
 #include "kml.h"
 #include "utility.h"
@@ -66,31 +63,11 @@ void doCell(H3Index h, int isKmlOut) {
 }
 
 int main(int argc, char *argv[]) {
-    H3Index index = 0;
-    char userKmlName[BUFF_SIZE] = {0};
-    char userKmlDesc[BUFF_SIZE] = {0};
-
-    Arg helpArg = {.names = {"-h", "--help"},
-                   .helpText = "Show this help message."};
-    Arg indexArg = {
-        .names = {"-i", "--index"},
-        .scanFormat = "%" PRIx64,
-        .valueName = "index",
-        .value = &index,
-        .helpText =
-            "Index, or not specified to read indexes from standard in."};
-    Arg kmlArg = {.names = {"-k", "--kml"},
-                  .helpText = "Print output in KML format."};
-    Arg kmlNameArg = {.names = {"--kn", "--kml-name"},
-                      .scanFormat = "%255c",  // BUFF_SIZE - 1
-                      .valueName = "name",
-                      .value = &userKmlName,
-                      .helpText = "Text for the KML name tag."};
-    Arg kmlDescArg = {.names = {"--kd", "--kml-description"},
-                      .scanFormat = "%255c",  // BUFF_SIZE - 1
-                      .valueName = "description",
-                      .value = &userKmlDesc,
-                      .helpText = "Text for the KML description tag."};
+    Arg helpArg = ARG_HELP;
+    DEFINE_INDEX_ARG(index, indexArg);
+    Arg kmlArg = ARG_KML;
+    DEFINE_KML_NAME_ARG(userKmlName, kmlNameArg);
+    DEFINE_KML_DESC_ARG(userKmlDesc, kmlDescArg);
 
     Arg *args[] = {&helpArg, &indexArg, &kmlArg, &kmlNameArg, &kmlDescArg};
 

data/ext/h3/src/src/apps/filters/h3ToGeoBoundary.c

@@ -17,8 +17,7 @@
  * @brief stdin/stdout filter that converts from integer H3 indexes to lat/lon
  * cell boundaries
  *
- *  usage: `h3ToGeoBoundary [--index index] [--kml [--kml-name name]
- * [--kml-description desc]]`
+ *  See `h3ToGeoBoundary --help` for usage.
  *
  *  The program reads H3 indexes from stdin and outputs the corresponding
  *  cell boundaries to stdout, until EOF is encountered.
@@ -44,6 +43,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include "args.h"
 #include "h3api.h"
 #include "kml.h"
 #include "utility.h"
@@ -64,31 +64,11 @@ void doCell(H3Index h, int isKmlOut) {
 }
 
 int main(int argc, char *argv[]) {
-    H3Index index = 0;
-    char userKmlName[BUFF_SIZE] = {0};
-    char userKmlDesc[BUFF_SIZE] = {0};
-
-    Arg helpArg = {.names = {"-h", "--help"},
-                   .helpText = "Show this help message."};
-    Arg indexArg = {
-        .names = {"-i", "--index"},
-        .scanFormat = "%" PRIx64,
-        .valueName = "index",
-        .value = &index,
-        .helpText =
-            "Index, or not specified to read indexes from standard in."};
-    Arg kmlArg = {.names = {"-k", "--kml"},
-                  .helpText = "Print output in KML format."};
-    Arg kmlNameArg = {.names = {"--kn", "--kml-name"},
-                      .scanFormat = "%255c",  // BUFF_SIZE - 1
-                      .valueName = "name",
-                      .value = &userKmlName,
-                      .helpText = "Text for the KML name tag."};
-    Arg kmlDescArg = {.names = {"--kd", "--kml-description"},
-                      .scanFormat = "%255c",  // BUFF_SIZE - 1
-                      .valueName = "description",
-                      .value = &userKmlDesc,
-                      .helpText = "Text for the KML description tag."};
+    Arg helpArg = ARG_HELP;
+    DEFINE_INDEX_ARG(index, indexArg);
+    Arg kmlArg = ARG_KML;
+    DEFINE_KML_NAME_ARG(userKmlName, kmlNameArg);
+    DEFINE_KML_DESC_ARG(userKmlDesc, kmlDescArg);
 
     Arg *args[] = {&helpArg, &indexArg, &kmlArg, &kmlNameArg, &kmlDescArg};
 

data/ext/h3/src/src/apps/filters/h3ToLocalIj.c

@@ -17,7 +17,7 @@
  * @brief stdin/stdout filter that converts from H3 indexes to local IJ
  * coordinates. This is experimental.
  *
- *  usage: `h3ToLocalIj [origin]`
+ *  See `h3ToLocalIj --help` for usage.
  *
  *  The program reads H3 indexes from stdin and outputs the corresponding
  *  IJ coordinates to stdout, until EOF is encountered. `NA` is printed if the
@@ -33,8 +33,7 @@
 #include <inttypes.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include "coordijk.h"
-#include "h3Index.h"
+#include "args.h"
 #include "h3api.h"
 #include "utility.h"
 
@@ -47,32 +46,50 @@ void doCell(H3Index h, H3Index origin) {
     }
 }
 
-int main(int argc, char *argv[]) {
-    // check command line args
-    if (argc != 2) {
-        fprintf(stderr, "usage: %s [origin]\n", argv[0]);
-        exit(1);
-    }
+int main(int argc, char* argv[]) {
+    H3Index origin = 0;
 
-    H3Index origin;
+    Arg helpArg = ARG_HELP;
+    Arg originArg = {
+        .names = {"-o", "--origin"},
+        .scanFormat = "%" PRIx64,
+        .valueName = "origin",
+        .value = &origin,
+        .required = true,
+        .helpText =
+            "Origin (anchoring index) for the local coordinate system."};
+    DEFINE_INDEX_ARG(index, indexArg);
 
-    if (!sscanf(argv[1], "%" PRIx64, &origin))
-        error("origin could not be read");
+    Arg* args[] = {&helpArg, &originArg, &indexArg};
+    const int numArgs = 3;
+    const char* helpText = "Converts H3 indexes to local IJ coordinates";
 
-    if (!H3_EXPORT(h3IsValid)(origin)) error("origin is invalid");
+    if (parseArgs(argc, argv, numArgs, args, &helpArg, helpText)) {
+        return helpArg.found ? 0 : 1;
+    }
 
-    // process the indexes on stdin
-    char buff[BUFF_SIZE];
-    while (1) {
-        // get an index from stdin
-        if (!fgets(buff, BUFF_SIZE, stdin)) {
-            if (feof(stdin))
-                break;
-            else
-                error("reading H3 index from stdin");
-        }
+    if (!H3_EXPORT(h3IsValid)(origin)) {
+        printHelp(stderr, argv[0], helpText, numArgs, args,
+                  "Origin is invalid.", NULL);
+        return 1;
+    }
 
-        H3Index h3 = H3_EXPORT(stringToH3)(buff);
-        doCell(h3, origin);
+    if (indexArg.found) {
+        doCell(index, origin);
+    } else {
+        // process the indexes on stdin
+        char buff[BUFF_SIZE];
+        while (1) {
+            // get an index from stdin
+            if (!fgets(buff, BUFF_SIZE, stdin)) {
+                if (feof(stdin))
+                    break;
+                else
+                    error("reading H3 index from stdin");
+            }
+
+            H3Index h3 = H3_EXPORT(stringToH3)(buff);
+            doCell(h3, origin);
+        }
     }
 }

data/ext/h3/src/src/apps/filters/hexRange.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2017 Uber Technologies, Inc.
+ * Copyright 2016-2017, 2019 Uber Technologies, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
  * @brief stdin/stdout filter that converts from integer H3 indexes to
  * k-rings
  *
- *  usage: `hexRange [k]`
+ *  See `hexRange --help` for usage.
  *
  *  The program reads H3 indexes from stdin until EOF and outputs
  *  the H3 indexes within k-ring `k` to stdout. Requires all indexes
@@ -28,10 +28,11 @@
  *  as the only output.
  */
 
+#include <inttypes.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include "algos.h"
-#include "h3Index.h"
+#include "args.h"
+#include "h3api.h"
 #include "utility.h"
 
 void doCell(H3Index h, int k) {
@@ -50,29 +51,47 @@ void doCell(H3Index h, int k) {
 }
 
 int main(int argc, char* argv[]) {
-    // check command line args
-    if (argc != 2) {
-        fprintf(stderr, "usage: %s [k]\n", argv[0]);
-        exit(1);
-    }
-
     int k = 0;
-    if (argc > 1) {
-        if (!sscanf(argv[1], "%d", &k)) error("k must be an integer");
+    H3Index origin = 0;
+
+    Arg helpArg = ARG_HELP;
+    Arg kArg = {.names = {"-k", NULL},
+                .required = true,
+                .scanFormat = "%d",
+                .valueName = "k",
+                .value = &k,
+                .helpText = "Radius in hexagons."};
+    Arg originArg = {
+        .names = {"-o", "--origin"},
+        .scanFormat = "%" PRIx64,
+        .valueName = "origin",
+        .value = &origin,
+        .helpText =
+            "Origin, or not specified to read origins from standard input."};
+    const int numArgs = 3;
+    Arg* args[] = {&helpArg, &kArg, &originArg};
+
+    if (parseArgs(argc, argv, numArgs, args, &helpArg,
+                  "Print indexes k distance away from the origin")) {
+        return helpArg.found ? 0 : 1;
     }
 
-    // process the indexes on stdin
-    char buff[BUFF_SIZE];
-    while (1) {
-        // get an index from stdin
-        if (!fgets(buff, BUFF_SIZE, stdin)) {
-            if (feof(stdin))
-                break;
-            else
-                error("reading H3 index from stdin");
-        }
+    if (originArg.found) {
+        doCell(origin, k);
+    } else {
+        // process the indexes on stdin
+        char buff[BUFF_SIZE];
+        while (1) {
+            // get an index from stdin
+            if (!fgets(buff, BUFF_SIZE, stdin)) {
+                if (feof(stdin))
+                    break;
+                else
+                    error("reading H3 index from stdin");
+            }
 
-        H3Index h3 = H3_EXPORT(stringToH3)(buff);
-        doCell(h3, k);
+            H3Index h3 = H3_EXPORT(stringToH3)(buff);
+            doCell(h3, k);
+        }
     }
 }