RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-31 08:58:11 +00:00
Code Issues Activity Actions

LibManual: Associate SubsectionNode with similarly named markdown file

Browse source 
For a subsection named `Foo` with a markdown file `Foo.md` in the same
directory, the document `Foo.md` will be returned when the subsection is
selected.

This prevents PageNodes and SubsectionNodes from sharing the same
name, which fixes an issue in Help where subsections could not be
navigated.
This commit is contained in:
Tim Ledbetter 2023-04-16 10:28:45 +01:00 • committed by Andrew Kaster
parent f9d8e42636
commit 10700ca4c1
3 changed files with 34 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

39
Userland/Libraries/LibManual/SectionNode.cpp
View file

@ -8,6 +8,7 @@
#include "PageNode.h" #include "PageNode.h"
#include "Path.h" #include "Path.h"
#include "SubsectionNode.h" #include "SubsectionNode.h"
#include <AK/HashTable.h>
#include <AK/LexicalPath.h> #include <AK/LexicalPath.h>
#include <AK/QuickSort.h> #include <AK/QuickSort.h>
#include <LibCore/DirIterator.h> #include <LibCore/DirIterator.h>
@ -43,7 +44,16 @@ ErrorOr<void> SectionNode::reify_if_needed() const
m_reified = true; m_reified = true;
auto own_path = TRY(path()); auto own_path = TRY(path());
Core::DirIterator dir_iter { own_path.to_deprecated_string(), Core::DirIterator::Flags::SkipDots }; Core::DirIterator dir_iterator { own_path.to_deprecated_string(), Core::DirIterator::Flags::SkipDots };
Vector<DeprecatedString> directories;
HashTable<DeprecatedString> files;
while (dir_iterator.has_next()) {
auto entry = dir_iterator.next();
if (entry->type == Core::DirectoryEntry::Type::Directory)
TRY(directories.try_append(entry->name));
else if (entry->type == Core::DirectoryEntry::Type::File && entry->name.ends_with(".md"sv, CaseSensitivity::CaseInsensitive))
TRY(files.try_set(entry->name));
}
struct Child { struct Child {
NonnullRefPtr<Node const> node; NonnullRefPtr<Node const> node;
@ -51,18 +61,21 @@ ErrorOr<void> SectionNode::reify_if_needed() const
}; };
Vector<Child> children; Vector<Child> children;
while (dir_iter.has_next()) { for (auto const& directory : directories) {
LexicalPath lexical_path(dir_iter.next_path()); LexicalPath lexical_path(directory);
if (lexical_path.extension() != "md") { RefPtr<PageNode> associated_page;
if (FileSystem::is_directory(LexicalPath::absolute_path(own_path.to_deprecated_string(), lexical_path.string()))) { auto matching_page_name = DeprecatedString::formatted("{}.md", directory);
dbgln("Found subsection {}", lexical_path); if (files.remove(matching_page_name))
children.append({ .node = TRY(try_make_ref_counted<SubsectionNode>(*this, lexical_path.title())), associated_page = TRY(try_make_ref_counted<PageNode>(*this, TRY(String::from_utf8(lexical_path.title()))));
.name_for_sorting = TRY(String::from_utf8(lexical_path.title())) });
} TRY(children.try_append({ .node = TRY(try_make_ref_counted<SubsectionNode>(*this, lexical_path.title(), associated_page)),
} else { .name_for_sorting = TRY(String::from_utf8(lexical_path.title())) }));
children.append({ .node = TRY(try_make_ref_counted<PageNode>(*this, TRY(String::from_utf8(lexical_path.title())))), }
.name_for_sorting = TRY(String::from_utf8(lexical_path.title())) });
} for (auto const& file : files) {
LexicalPath lexical_path(file);
children.append({ .node = TRY(try_make_ref_counted<PageNode>(*this, TRY(String::from_utf8(lexical_path.title())))),
.name_for_sorting = TRY(String::from_utf8(lexical_path.title())) });
} }
quick_sort(children, [](auto const& a, auto const& b) { return a.name_for_sorting < b.name_for_sorting; }); quick_sort(children, [](auto const& a, auto const& b) { return a.name_for_sorting < b.name_for_sorting; });

21
Userland/Libraries/LibManual/SubsectionNode.cpp
View file

@ -10,31 +10,16 @@
namespace Manual { namespace Manual {
SubsectionNode::SubsectionNode(NonnullRefPtr<SectionNode const> parent, StringView name) SubsectionNode::SubsectionNode(NonnullRefPtr<SectionNode const> parent, StringView name, RefPtr<PageNode> page)
: SectionNode(name, name) : SectionNode(name, name)
, m_parent(move(parent)) , m_parent(move(parent))
, m_page(move(page))
{ {
} }
Node const* SubsectionNode::parent() const { return m_parent; } Node const* SubsectionNode::parent() const { return m_parent; }
PageNode const* SubsectionNode::document() const PageNode const* SubsectionNode::document() const { return m_page; }
{
auto maybe_siblings = parent()->children();
if (maybe_siblings.is_error())
return nullptr;
auto siblings = maybe_siblings.release_value();
for (auto const& sibling : siblings) {
if (&*sibling == this)
continue;
auto sibling_name = sibling->name();
if (sibling_name.is_error())
continue;
if (sibling_name.value() == m_name && is<PageNode>(*sibling))
return static_cast<PageNode const*>(&*sibling);
}
return nullptr;
}
ErrorOr<String> SubsectionNode::name() const { return m_name; } ErrorOr<String> SubsectionNode::name() const { return m_name; }

6
Userland/Libraries/LibManual/SubsectionNode.h
View file

@ -6,6 +6,7 @@
#pragma once #pragma once
#include <LibManual/PageNode.h>
#include <LibManual/SectionNode.h> #include <LibManual/SectionNode.h>
namespace Manual { namespace Manual {
@ -13,7 +14,7 @@ namespace Manual {
// A non-toplevel (i.e. not numbered) manual section. // A non-toplevel (i.e. not numbered) manual section.
class SubsectionNode : public SectionNode { class SubsectionNode : public SectionNode {
public: public:
SubsectionNode(NonnullRefPtr<SectionNode const> parent, StringView name); SubsectionNode(NonnullRefPtr<SectionNode const> parent, StringView name, RefPtr<PageNode> page = {});
virtual ~SubsectionNode() = default; virtual ~SubsectionNode() = default;
virtual Node const* parent() const override; virtual Node const* parent() const override;
@ -23,6 +24,9 @@ public:
protected: protected:
NonnullRefPtr<SectionNode const> m_parent; NonnullRefPtr<SectionNode const> m_parent;
private:
RefPtr<PageNode> m_page;
}; };
} }