RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 14:47:35 +00:00
Code Issues Activity Actions

Help+man+LibManual: Move argument handling to LibManual

Browse source 
This deduplicates argument handling logic from Help and man and makes it
more modular for future use cases. The argument handling works as
before: two arguments specify section and page (in this order), one
argument specifies either a page (the first section that it's found in
is used) or a path to a manpage markdown file.
This commit is contained in:
kleines Filmröllchen 2022-07-12 20:23:28 +02:00 • committed by Linus Groh
parent 64ca546a06
commit b65258c093
9 changed files with 149 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

63
Userland/Utilities/man.cpp
View file

@ -7,11 +7,13 @@
#include <AK/Assertions.h>
#include <AK/ByteBuffer.h>
#include <AK/DeprecatedString.h>
#include <AK/Utf8View.h>
#include <LibCore/ArgsParser.h>
#include <LibCore/File.h>
#include <LibCore/Stream.h>
#include <LibCore/System.h>
#include <LibMain/Main.h>
#include <LibManual/Node.h>
#include <LibManual/PageNode.h>
#include <LibManual/SectionNode.h>
#include <LibMarkdown/Document.h>
@ -56,64 +58,45 @@ ErrorOr<int> serenity_main(Main::Arguments arguments)
TRY(Core::System::unveil("/bin", "x"));
TRY(Core::System::unveil(nullptr, nullptr));
DeprecatedString section;
DeprecatedString name;
DeprecatedString section_argument;
DeprecatedString name_argument;
DeprecatedString pager;
Core::ArgsParser args_parser;
args_parser.set_general_help("Read manual pages. Try 'man man' to get started.");
args_parser.add_positional_argument(section, "Section of the man page", "section", Core::ArgsParser::Required::No);
args_parser.add_positional_argument(name, "Name of the man page", "name");
args_parser.add_positional_argument(section_argument, "Section of the man page", "section");
args_parser.add_positional_argument(name_argument, "Name of the man page", "name", Core::ArgsParser::Required::No);
args_parser.add_option(pager, "Pager to pipe the man page to", "pager", 'P', "pager");
args_parser.parse(arguments);
Vector<StringView, 2> query_parameters;
if (!section_argument.is_empty())
query_parameters.append(section_argument);
if (!name_argument.is_empty())
query_parameters.append(name_argument);
Optional<NonnullRefPtr<Manual::PageNode>> page;
if (section.is_empty()) {
for (auto const& s : Manual::sections) {
auto const maybe_page = make_ref_counted<Manual::PageNode>(s, TRY(String::from_utf8(name)));
if (Core::File::exists(TRY(maybe_page->path()).to_deprecated_string())) {
page = maybe_page;
section = s->section_name().to_deprecated_string();
break;
}
}
} else {
auto number_section = section.to_uint();
if (number_section.has_value())
page = make_ref_counted<Manual::PageNode>(Manual::sections[number_section.value() - 1], TRY(String::from_utf8(name)));
else
warnln("Section name '{}' invalid", section);
}
if (!page.has_value()) {
warnln("No man page for {}", name);
exit(1);
} else if (!Core::File::exists(TRY((*page)->path()))) {
warnln("No man page for {} in section {}", name, section);
exit(1);
}
auto page = TRY(Manual::Node::try_create_from_query(query_parameters));
auto page_name = TRY(page->name());
auto const* section = static_cast<Manual::SectionNode const*>(page->parent());
if (pager.is_empty())
pager = TRY(String::formatted("less -P 'Manual Page {}({}) line %l?e (END):.'", StringView(name).replace("'"sv, "'\\''"sv, ReplaceMode::FirstOnly), StringView(section).replace("'"sv, "'\\''"sv, ReplaceMode::FirstOnly))).to_deprecated_string();
pager = TRY(String::formatted("less -P 'Manual Page {}({}) line %l?e (END):.'",
TRY(page_name.replace("'"sv, "'\\''"sv, ReplaceMode::FirstOnly)),
TRY(section->section_name().replace("'"sv, "'\\''"sv, ReplaceMode::FirstOnly))))
.to_deprecated_string();
pid_t pager_pid = TRY(pipe_to_pager(pager));
auto file = TRY(Core::Stream::File::open(TRY((*page)->path()), Core::Stream::OpenMode::Read));
auto file = TRY(Core::Stream::File::open(TRY(page->path()), Core::Stream::OpenMode::Read));
TRY(Core::System::pledge("stdio proc"));
dbgln("Loading man page from {}", (*page)->path());
dbgln("Loading man page from {}", TRY(page->path()));
auto buffer = TRY(file->read_all());
auto source = DeprecatedString::copy(buffer);
const DeprecatedString title("SerenityOS manual");
auto const title = TRY(String::from_utf8("SerenityOS manual"sv));
int spaces = view_width / 2 - DeprecatedString(name).length() - DeprecatedString(section).length() - title.length() / 2 - 4;
if (spaces < 0)
spaces = 0;
out("{}({})", name, section);
while (spaces--)
out(" ");
outln(title);
int spaces = max(view_width / 2 - page_name.code_points().length() - section->section_name().code_points().length() - title.code_points().length() / 2 - 4, 0);
outln("{}({}){}{}", page_name, section->section_name(), DeprecatedString::repeated(' ', spaces), title);
auto document = Markdown::Document::parse(source);
VERIFY(document);