mirror of
https://github.com/felt/tippecanoe.git
synced 2026-10-02 08:25:40 +02:00
Erica FischerandClaude Opus 5
e6e1ec3263
* Generate the usage message of each tool from its long_options
The usage messages of tile-join, tippecanoe-overzoom,
tippecanoe-json-tool, tippecanoe-decode, and tippecanoe-enumerate were
hand-written lists of options that had drifted years out of date, since
nothing tied them to the options that are really accepted. Move the
option-list printing that tippecanoe already does into a shared
print_usage(), and use it in all the tools, so that the message is
derived from the same long_options table that getopt_long() gets and
can't fall behind it again.
The tables now carry section headings, as tippecanoe's does, and the
options that were only reachable by their short names (tile-join's -O,
-b, -R, and -r among them) are listed for the first time.
Also state the non-option arguments the way each tool really treats
them: tile-join takes source tilesets unless --read-from names a file to
read them from, tippecanoe-decode takes a tileset either alone or with a
zoom/x/y, tippecanoe-json-tool reads standard input when no files are
named, and tippecanoe-overzoom's two forms are the ones its argument
parsing recognizes. tippecanoe-overzoom now reports the missing -o
instead of passing NULL to fopen(), and tippecanoe-enumerate goes
through getopt_long() so that it will pick up any options added later.
The shared getopt_string() replaces the identical loop that four of the
tools each had for building the short option string, and strip_usage_headings()
the one for dropping the headings before getopt_long() sees them.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016frkRY1xXtiWjxYuCJ8vZY
* Print the usage message when tippecanoe is run with no arguments
Running `tippecanoe` with nothing at all reported the missing output
file, which is true but is not what someone who typed the bare command
needs to know. Check for the empty command line before parsing and print
the general usage message instead, and leave the specific complaint for
the case where an input file was named but an output file wasn't.
To make the message reachable from there, the options table and the
usage printing move out of main() into a usage() function, as in the
other tools.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016frkRY1xXtiWjxYuCJ8vZY
* Address review: alternation, the dead tile-join option, and --version
Four fixes from review of the generated usage messages:
* `--output` and `--output-to-directory` are one-of, not one required and
one optional, in both tippecanoe and tile-join. A `usage_required_option`
can now name an alternation that it belongs to, and the options in one
are listed together as `(--output=... | --output-to-directory=...)`,
which is what the runtime check enforces.
* tile-join's `--use-attribute-for-id` has had no implementation since
533e000 removed it; only the table entry was left behind, so the option
parsed and then exited with "Unrecognized option". Generating the usage
message from the table turned that into a documented option that doesn't
work, so remove the leftover entry too.
* `--version` was grouped under "Progress indicator", in the options table
and in the README both. Give it a heading of its own now that the
headings are something users see.
* print_usage() left `width` holding the length of the last synopsis line,
and only got away with it because every table so far begins with a
heading, which resets it. Start the option list on a line of its own
instead of depending on that.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016frkRY1xXtiWjxYuCJ8vZY
---------
Co-authored-by: Claude <noreply@anthropic.com>
53 lines
2.1 KiB
C++
53 lines
2.1 KiB
C++
#ifndef USAGE_HPP
|
|
#define USAGE_HPP
|
|
|
|
#include <stdio.h>
|
|
#include <getopt.h>
|
|
#include <string>
|
|
|
|
// An option that must be specified rather than being optional, and the
|
|
// placeholder to show for its argument in the usage message.
|
|
//
|
|
// Options that share the same non-zero `alternation` are alternatives to
|
|
// each other: one of them must be specified, but not more than one, and
|
|
// they are listed together as `(--this=... | --that=...)`.
|
|
struct usage_required_option {
|
|
const char *name;
|
|
const char *placeholder;
|
|
int alternation;
|
|
};
|
|
|
|
// Returns the short option string to pass to getopt_long() for the
|
|
// options in `long_options`, so that the two can't disagree about
|
|
// which short options exist or take arguments.
|
|
std::string getopt_string(const struct option *long_options);
|
|
|
|
// Copies `long_options` to `real_long_options`, leaving out the headings
|
|
// of the usage message, which are not real options and so must not be
|
|
// passed on to getopt_long(). The destination must be at least as large
|
|
// as the source.
|
|
void strip_usage_headings(const struct option *long_options, struct option *real_long_options);
|
|
|
|
// Prints a usage message for `program` to `out`:
|
|
//
|
|
// Usage: program forms[0]
|
|
// or: program forms[1]
|
|
// [--some-option] [--another-option=...] ...
|
|
//
|
|
// where `forms` is a NULL-terminated list of the ways the non-option
|
|
// arguments can be given, and the list of options is derived from
|
|
// `long_options`, the same table that is passed to getopt_long(), so that
|
|
// the message stays in sync with the options that are really accepted.
|
|
//
|
|
// Options named in `required` (a list terminated by a NULL name, or NULL
|
|
// if there are none) are shown without brackets, using the placeholder
|
|
// given there for their argument, and grouped with any alternatives to
|
|
// them. An entry in `long_options` with no `val` is printed as a heading
|
|
// for the options that follow it, and an entry with an empty name ends
|
|
// the listing, hiding any options after it.
|
|
void print_usage(FILE *out, const char *program, const char *const *forms,
|
|
const struct option *long_options,
|
|
const struct usage_required_option *required);
|
|
|
|
#endif
|