mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-06-30 15:21:16 -03:00
61486954bc
Every builtin or function shipped with fish supports flag -h or --help to print a slightly condensed version of its manpage. Some of those help messages are longer than a typical screen; this commit pipes the help to a pager to make it easier to read. As in other places in fish we assume that either $PAGER or "less" is a valid pager and use that. In three places (error messages for bg, break and continue) the help is printed to stderr instead of stdout. To make sure the error message is visible in the pager, we pass it to builtin_print_help, every call of which needs to be updated. Fixes #6227
116 lines
3.5 KiB
C++
116 lines
3.5 KiB
C++
// Implementation of the builtin builtin.
|
|
#include "config.h" // IWYU pragma: keep
|
|
|
|
#include "builtin.h"
|
|
|
|
#include <stddef.h>
|
|
|
|
#include <algorithm>
|
|
#include <string>
|
|
|
|
#include "builtin_builtin.h"
|
|
#include "common.h"
|
|
#include "fallback.h" // IWYU pragma: keep
|
|
#include "io.h"
|
|
#include "wgetopt.h"
|
|
#include "wutil.h" // IWYU pragma: keep
|
|
|
|
struct builtin_cmd_opts_t {
|
|
bool print_help = false;
|
|
bool list_names = false;
|
|
bool query = false;
|
|
};
|
|
static const wchar_t *const short_options = L":hnq";
|
|
static const struct woption long_options[] = {{L"help", no_argument, NULL, 'h'},
|
|
{L"names", no_argument, NULL, 'n'},
|
|
{L"query", no_argument, NULL, 'q'},
|
|
{NULL, 0, NULL, 0}};
|
|
|
|
static int parse_cmd_opts(builtin_cmd_opts_t &opts, int *optind, int argc, wchar_t **argv,
|
|
parser_t &parser, io_streams_t &streams) {
|
|
wchar_t *cmd = argv[0];
|
|
int opt;
|
|
wgetopter_t w;
|
|
while ((opt = w.wgetopt_long(argc, argv, short_options, long_options, NULL)) != -1) {
|
|
switch (opt) {
|
|
case 'h': {
|
|
opts.print_help = true;
|
|
break;
|
|
}
|
|
case 'n': {
|
|
opts.list_names = true;
|
|
break;
|
|
}
|
|
case 'q': {
|
|
opts.query = true;
|
|
break;
|
|
}
|
|
case ':': {
|
|
builtin_missing_argument(parser, streams, cmd, argv[w.woptind - 1]);
|
|
return STATUS_INVALID_ARGS;
|
|
}
|
|
case '?': {
|
|
builtin_unknown_option(parser, streams, cmd, argv[w.woptind - 1]);
|
|
return STATUS_INVALID_ARGS;
|
|
}
|
|
default: {
|
|
DIE("unexpected retval from wgetopt_long");
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
*optind = w.woptind;
|
|
return STATUS_CMD_OK;
|
|
}
|
|
|
|
/// The builtin builtin, used for giving builtins precedence over functions. Mostly handled by the
|
|
/// parser. All this code does is some additional operational modes, such as printing a list of all
|
|
/// builtins, printing help, etc.
|
|
int builtin_builtin(parser_t &parser, io_streams_t &streams, wchar_t **argv) {
|
|
const wchar_t *cmd = argv[0];
|
|
int argc = builtin_count_args(argv);
|
|
builtin_cmd_opts_t opts;
|
|
|
|
int optind;
|
|
int retval = parse_cmd_opts(opts, &optind, argc, argv, parser, streams);
|
|
if (retval != STATUS_CMD_OK) return retval;
|
|
|
|
if (opts.print_help) {
|
|
builtin_print_help(parser, streams, cmd);
|
|
return STATUS_CMD_OK;
|
|
}
|
|
|
|
if (opts.query && opts.list_names) {
|
|
streams.err.append_format(BUILTIN_ERR_COMBO2, cmd,
|
|
_(L"--query and --names are mutually exclusive"));
|
|
return STATUS_INVALID_ARGS;
|
|
}
|
|
|
|
if (opts.query) {
|
|
wcstring_list_t names = builtin_get_names();
|
|
retval = STATUS_CMD_ERROR;
|
|
for (int i = optind; i < argc; i++) {
|
|
if (contains(names, argv[i])) {
|
|
retval = STATUS_CMD_OK;
|
|
break;
|
|
}
|
|
}
|
|
return retval;
|
|
}
|
|
|
|
if (opts.list_names) {
|
|
wcstring_list_t names = builtin_get_names();
|
|
std::sort(names.begin(), names.end());
|
|
|
|
for (size_t i = 0; i < names.size(); i++) {
|
|
const wchar_t *el = names.at(i).c_str();
|
|
|
|
streams.out.append(el);
|
|
streams.out.append(L"\n");
|
|
}
|
|
}
|
|
|
|
return STATUS_CMD_OK;
|
|
}
|