mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-01 17:03:19 +00:00
Code Activity

log_help: Refactor help content adding

Browse source 
Content is now added to the `ContentListing` rather than the `PrettyHelp`.
`open_*` methods return the `ContentListing` that was added instead of leaving a hanging continuation.
This allows for (e.g.) options to be added directly to optiongroups, instead of requiring that groups be closed before continuation.
This also means that all `PrettyHelp`s are a listing, with the actual log being called by the default `Pass::help()`; making the mode field redundant.
Added `PrettyHelp::log_help()` which replaces the `PrettyHelp::Mode::LOG` logic.
Added `ContentListing::back()` which just returns the last element of the underlying content vector.
Some of the content tracking was made redundant and removed, in particular `PrettyHelp::_current_listing` and `ContentListing::parent`.

Converted `ContentListing` to a class instead of a struct, adjusting constructors to match.
Added `ContentListing` constructor that accepts a `source_location`.

Update `HelpPass::dump_cmds_json()` for new log_help.
This commit is contained in:
Krystine Sherwin 2025-07-21 10:35:18 +12:00
parent c97b0084b7
commit 1529d991fd
No known key found for this signature in database
4 changed files with 167 additions and 228 deletions
Download patch file Download diff file Expand all files Collapse all files

36
kernel/register.cc
View file

@ -118,7 +118,10 @@ void Pass::post_execute(Pass::pre_post_exec_state_t state)
void Pass::help()
{
if (!formatted_help()) {
auto prettyHelp = PrettyHelp();
if (formatted_help()) {
prettyHelp.log_help();
} else {
log("\n");
log("No help message for command `%s'.\n", pass_name.c_str());
log("\n");
@ -824,7 +827,7 @@ struct HelpPass : public Pass {
auto title = pass->short_help;
auto experimental_flag = pass->experimental_flag;
auto cmd_help = PrettyHelp(PrettyHelp::Mode::LISTING);
auto cmd_help = PrettyHelp();
auto has_pretty_help = pass->formatted_help();
if (!has_pretty_help) {
@ -837,6 +840,8 @@ struct HelpPass : public Pass {
source_location null_source;
string current_buffer = "";
auto root_listing = cmd_help.get_root();
auto current_listing = root_listing;
// dump command help
std::ostringstream buf;
@ -859,7 +864,8 @@ struct HelpPass : public Pass {
switch (current_state)
{
case PUState_signature:
cmd_help.usage(current_buffer, null_source);
root_listing->usage(current_buffer, null_source);
current_listing = root_listing;
current_state = PUState_none;
current_buffer = "";
break;
@ -886,16 +892,16 @@ struct HelpPass : public Pass {
if (IsSignature && first_pos <= 4 && (blank_lines >= 2 || current_state == PUState_signature)) {
if (current_state == PUState_options || current_state == PUState_optionbody) {
cmd_help.codeblock(current_buffer, "none", null_source);
current_listing->codeblock(current_buffer, "none", null_source);
current_buffer = "";
cmd_help.close(2);
} else if (current_state == PUState_signature) {
cmd_help.usage(current_buffer, null_source);
root_listing->usage(current_buffer, null_source);
current_buffer = "";
} else if (current_state == PUState_none && !current_buffer.empty()) {
cmd_help.codeblock(current_buffer, "none", null_source);
current_listing->codeblock(current_buffer, "none", null_source);
current_buffer = "";
}
current_listing = root_listing;
current_state = PUState_signature;
def_strip_count = first_pos;
catch_verific = false;
@ -903,15 +909,15 @@ struct HelpPass : public Pass {
def_strip_count = first_pos;
if (current_state == PUState_optionbody) {
if (!current_buffer.empty()) {
cmd_help.codeblock(current_buffer, "none", null_source);
current_listing->codeblock(current_buffer, "none", null_source);
current_buffer = "";
}
if (IsIndent) {
current_state = PUState_options;
cmd_help.close(1);
current_listing = root_listing->back();
} else {
current_state = PUState_none;
cmd_help.close(2);
current_listing = root_listing;
}
} else {
current_state = PUState_none;
@ -920,16 +926,16 @@ struct HelpPass : public Pass {
if (IsDefinition && !catch_verific && current_state != PUState_signature) {
if (!current_buffer.empty()) {
cmd_help.codeblock(current_buffer, "none", null_source);
current_listing->codeblock(current_buffer, "none", null_source);
current_buffer = "";
}
if (current_state == PUState_options || current_state == PUState_optionbody) {
cmd_help.close(1);
current_listing = root_listing->back();
} else {
cmd_help.open_optiongroup("", null_source);
current_listing = root_listing->open_optiongroup("", null_source);
}
current_state = PUState_options;
cmd_help.open_option(stripped_line, null_source);
current_listing = current_listing->open_option(stripped_line, null_source);
def_strip_count = first_pos;
} else {
if (current_state == PUState_options) {
@ -950,7 +956,7 @@ struct HelpPass : public Pass {
}
if (!current_buffer.empty()) {
cmd_help.codeblock(current_buffer, "none", null_source);
current_listing->codeblock(current_buffer, "none", null_source);
current_buffer = "";
}
}