Skip to content

ci: demos use generator option #1005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 11, 2025
Merged

ci: demos use generator option #1005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f88ffc2
refactor: xml generator use config values directly
alandefreitas Sep 11, 2025
f839ca6
ci: demos use generator option
alandefreitas Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,10 +692,10 @@ jobs:
[[ $generator = xml && $variant = multi ]] && continue
[[ $variant = multi ]] && multipage="true" || multipage="false"
# mrdocs boost.url demo
mrdocs --config="$(pwd)/boost/libs/url/doc/mrdocs.yml" "../CMakeLists.txt" --output="$(pwd)/demos/boost-url/$variant/$generator" --multipage=$multipage --generate="$generator" --log-level=debug
mrdocs --config="$(pwd)/boost/libs/url/doc/mrdocs.yml" "../CMakeLists.txt" --output="$(pwd)/demos/boost-url/$variant/$generator" --multipage=$multipage --generator="$generator" --log-level=debug
echo "Number of files in demos/boost-url/$variant/$generator: $(find demos/boost-url/$variant/$generator -type f | wc -l)"
# mrdocs documenting mrdocs demo
mrdocs --config="$(pwd)/docs/mrdocs.yml" "$(pwd)/CMakeLists.txt" --output="$(pwd)/demos/mrdocs/$variant/$generator" --multipage=$multipage --generate="$generator" --log-level=debug
mrdocs --config="$(pwd)/docs/mrdocs.yml" "$(pwd)/CMakeLists.txt" --output="$(pwd)/demos/mrdocs/$variant/$generator" --multipage=$multipage --generator="$generator" --log-level=debug
done
done

Expand Down
128 changes: 15 additions & 113 deletions src/lib/Gen/xml/XMLWriter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,73 +28,6 @@

namespace clang::mrdocs::xml {

struct XMLWriter::XmlKey
{
Options& opt;

explicit
XmlKey(
Options& opt_) noexcept
: opt(opt_)
{
}
};

struct XMLWriter::GenKey
{
Options& opt;

explicit
GenKey(
Options& opt_)
: opt(opt_)
{
}
};

} // clang::mrdocs::xml

template<>
struct llvm::yaml::MappingTraits<
clang::mrdocs::xml::XMLWriter::XmlKey>
{
static void mapping(IO& io,
clang::mrdocs::xml::XMLWriter::XmlKey& opt_)
{
auto& opt= opt_.opt;
io.mapOptional("index", opt.index);
io.mapOptional("prolog", opt.prolog);
io.mapOptional("legible-names", opt.legible_names);
}
};

template<>
struct llvm::yaml::MappingTraits<
clang::mrdocs::xml::XMLWriter::GenKey>
{
static void mapping(IO& io,
clang::mrdocs::xml::XMLWriter::GenKey& opt)
{
clang::mrdocs::xml::XMLWriter::XmlKey k(opt.opt);

io.mapOptional("xml", k);
}
};

template<>
struct llvm::yaml::MappingTraits<
clang::mrdocs::xml::XMLWriter::Options>
{
static void mapping(IO& io,
clang::mrdocs::xml::XMLWriter::Options& opt)
{
clang::mrdocs::xml::XMLWriter::GenKey k(opt);
io.mapOptional("generator", k);
}
};

namespace clang::mrdocs::xml {

//------------------------------------------------
//
// XMLWriter
Expand All @@ -115,33 +48,16 @@ Expected<void>
XMLWriter::
build()
{
YamlReporter reporter;

{
llvm::yaml::Input yin(
corpus_.config->configYaml,
&reporter, reporter);
yin.setAllowUnknownKeys(true);
yin >> options_;
auto ec = yin.error();
MRDOCS_CHECK(!ec, ec);
}
os_ <<
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" <<
"<mrdocs xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
" xsi:noNamespaceSchemaLocation=\"https://github.com/cppalliance/mrdocs/raw/develop/mrdocs.rnc\">\n";

if(options_.prolog)
os_ <<
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" <<
"<mrdocs xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
" xsi:noNamespaceSchemaLocation=\"https://github.com/cppalliance/mrdocs/raw/develop/mrdocs.rnc\">\n";

if (options_.index || options_.legible_names)
{
writeIndex();
}
// writeIndex();

visit(corpus_.globalNamespace(), *this);

if(options_.prolog)
os_ << "</mrdocs>\n";
os_ << "</mrdocs>\n";

return {};
}
Expand All @@ -155,30 +71,16 @@ writeIndex()
std::string temp;
temp.reserve(256);
tags_.open("symbols");
if(options_.legible_names)
LegibleNames const names(corpus_, true);
for(auto& I : corpus_)
{
LegibleNames const names(corpus_, true);
for(auto& I : corpus_)
{
corpus_.qualifiedName(I, temp);
auto legible_name = names.getUnqualified(I.id);
tags_.write("symbol", {}, {
{ "legible", legible_name },
{ "name", temp },
{ "tag", toString(I.Kind) },
{ I.id } });
}
}
else
{
for(auto& I : corpus_)
{
corpus_.qualifiedName(I, temp);
tags_.write("symbol", {}, {
{ "name", temp },
{ "tag", toString(I.Kind) },
{ I.id } });
}
corpus_.qualifiedName(I, temp);
auto legible_name = names.getUnqualified(I.id);
tags_.write("symbol", {}, {
{ "legible", legible_name },
{ "name", temp },
{ "tag", toString(I.Kind) },
{ I.id } });
}
tags_.close("symbols");
}
Expand Down
10 changes: 0 additions & 10 deletions src/lib/Gen/xml/XMLWriter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,6 @@ class XMLWriter
llvm::raw_ostream& os_;
Corpus const& corpus_;

struct GenKey;
struct XmlKey;
struct Options
{
bool index = false;
bool prolog = true;
bool legible_names = false;
};
Options options_;

public:
XMLWriter(
llvm::raw_ostream& os,
Expand Down
Loading