RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 16:27: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

70
Userland/Libraries/LibManual/Node.cpp Normal file
View file

@ -0,0 +1,70 @@
/*
* Copyright (c) 2022, kleines Filmröllchen <filmroellchen@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "Node.h"
#include "PageNode.h"
#include "SectionNode.h"
#include <AK/Assertions.h>
#include <AK/LexicalPath.h>
#include <AK/Optional.h>
#include <AK/StringView.h>
#include <LibCore/File.h>
#include <LibCore/Stream.h>
#include <LibManual/Path.h>
namespace Manual {
ErrorOr<NonnullRefPtr<PageNode>> Node::try_create_from_query(Vector<StringView, 2> const& query_parameters)
{
if (query_parameters.size() > 2)
return Error::from_string_literal("Queries longer than 2 strings are not supported yet");
auto query_parameter_iterator = query_parameters.begin();
if (query_parameter_iterator.is_end())
// BUG! No query was given.
VERIFY_NOT_REACHED();
auto first_query_parameter = *query_parameter_iterator;
++query_parameter_iterator;
if (query_parameter_iterator.is_end()) {
// [/path/to/docs.md]
auto path_from_query = LexicalPath { first_query_parameter };
if (path_from_query.is_absolute()
&& path_from_query.is_child_of(manual_base_path)
&& path_from_query.extension() == "md"sv) {
auto section_directory = path_from_query.parent();
auto man_string_location = section_directory.basename().find("man"sv);
if (!man_string_location.has_value())
return Error::from_string_literal("Page is inside invalid section");
auto section_name = section_directory.basename().substring_view(man_string_location.value() + 3);
auto section = TRY(SectionNode::try_create_from_number(section_name));
return try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(path_from_query.title())));
}
// [page] (in any section)
Optional<NonnullRefPtr<PageNode>> maybe_page;
for (auto const& section : sections) {
auto const page = TRY(try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(first_query_parameter))));
if (Core::File::exists(TRY(page->path()))) {
maybe_page = page;
break;
}
}
if (maybe_page.has_value())
return maybe_page.release_value();
return Error::from_string_literal("Page not found");
}
// [section] [name]
auto second_query_parameter = *query_parameter_iterator;
auto section = TRY(SectionNode::try_create_from_number(first_query_parameter));
auto const page = TRY(try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(second_query_parameter))));
if (Core::File::exists(TRY(page->path())))
return page;
return Error::from_string_literal("Page doesn't exist in section");
}
}