/*
 * 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.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/** @file
 * @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]]`
 *
 *  The program reads H3 indexes from stdin and outputs the corresponding
 *  cell boundaries to stdout, until EOF is encountered.
 *
 *  `--kml` causes KML output to be printed. `--kml-name` and
 *  `--kml-description` can be used to change the name and description in the
 *  KML header, which default to "H3 Geometry" and "Generated by
 *  h3ToGeoBoundary" respectively.
 *
 *  Examples:
 *
 *     `h3ToGeoBoundary < indexes.txt`
 *        - outputs plain text cell boundaries for the H3 indexes contained
 *          in the file `indexes.txt`
 *
 *     `h3ToGeoBoundary --kml --kml-name "kml title" --kml-description "h3
 *          cells" < indexes.txt > cells.kml`
 *        - creates the KML file `cells.kml` containing the cell boundaries for
 *          all of the H3 indexes contained in the file `indexes.txt`.
 */

#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "h3api.h"
#include "kml.h"
#include "utility.h"

void doCell(H3Index h, int isKmlOut) {
    GeoBoundary b;
    H3_EXPORT(h3ToGeoBoundary)(h, &b);

    char label[BUFF_SIZE];
    H3_EXPORT(h3ToString)(h, label, BUFF_SIZE);

    if (isKmlOut) {
        outputBoundaryKML(&b, label);
    } else {
        printf("%s\n", label);
        geoBoundaryPrintln(&b);
    }
}

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 *args[] = {&helpArg, &indexArg, &kmlArg, &kmlNameArg, &kmlDescArg};

    if (parseArgs(argc, argv, 5, args, &helpArg,
                  "Converts indexes to latitude/longitude cell boundaries in "
                  "degrees")) {
        return helpArg.found ? 0 : 1;
    }

    if (kmlArg.found) {
        char *kmlName = "H3 Geometry";
        if (kmlNameArg.found) kmlName = userKmlName;

        char *kmlDesc = "Generated by h3ToGeoBoundary";
        if (kmlDescArg.found) kmlDesc = userKmlDesc;

        kmlPtsHeader(kmlName, kmlDesc);
    }

    if (indexArg.found) {
        doCell(index, kmlArg.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, kmlArg.found);
        }
    }

    if (kmlArg.found) kmlPtsFooter();
}