HelpPass Struct Reference

Inheritance diagram for HelpPass:

Collaboration diagram for HelpPass:

Public Member Functions
	HelpPass ()
virtual void	help ()
void	escape_tex (std::string &tex)
void	write_tex (FILE *f, std::string cmd, std::string title, std::string text)
void	escape_html (std::string &html)
void	write_html (FILE *idxf, std::string cmd, std::string title, std::string text)
virtual void	execute (std::vector< std::string > args, RTLIL::Design *)
pre_post_exec_state_t	pre_execute ()
void	post_execute (pre_post_exec_state_t state)
void	cmd_log_args (const std::vector< std::string > &args)
void	cmd_error (const std::vector< std::string > &args, size_t argidx, std::string msg)
void	extra_args (std::vector< std::string > args, size_t argidx, RTLIL::Design *design, bool select=true)
virtual void	run_register ()

Static Public Member Functions
static void	call (RTLIL::Design *design, std::string command)
static void	call (RTLIL::Design *design, std::vector< std::string > args)
static void	call_on_selection (RTLIL::Design *design, const RTLIL::Selection &selection, std::string command)
static void	call_on_selection (RTLIL::Design *design, const RTLIL::Selection &selection, std::vector< std::string > args)
static void	call_on_module (RTLIL::Design *design, RTLIL::Module *module, std::string command)
static void	call_on_module (RTLIL::Design *design, RTLIL::Module *module, std::vector< std::string > args)
static void	init_register ()
static void	done_register ()

Data Fields
std::string	pass_name
std::string	short_help
int	call_counter
int64_t	runtime_ns
Pass *	next_queued_pass

Detailed Description

Definition at line 519 of file register.cc.

Constructor & Destructor Documentation

HelpPass::HelpPass ( )

inline

Definition at line 520 of file register.cc.

: Pass("help", "display help messages") { }

Member Function Documentation

void Pass::call ( RTLIL::Design *  design, std::string  command  )

staticinherited

Definition at line 146 of file register.cc.

{
    std::vector<std::string> args;

    std::string cmd_buf = command;
    std::string tok = next_token(cmd_buf, " \t\r\n");

    if (tok.empty() || tok[0] == '#')
        return;

    if (tok[0] == '!') {
        cmd_buf = command.substr(command.find('!') + 1);
        while (!cmd_buf.empty() && (cmd_buf.back() == ' ' || cmd_buf.back() == '\t' ||
                cmd_buf.back() == '\r' || cmd_buf.back() == '\n'))
            cmd_buf.resize(cmd_buf.size()-1);
        log_header("Shell command: %s\n", cmd_buf.c_str());
        int retCode = run_command(cmd_buf);
        if (retCode != 0)
            log_cmd_error("Shell command returned error code %d.\n", retCode);
        return;
    }

    while (!tok.empty()) {
        if (tok == "#")
            break;
        if (tok.back() == ';') {
            int num_semikolon = 0;
            while (!tok.empty() && tok.back() == ';')
                tok.resize(tok.size()-1), num_semikolon++;
            if (!tok.empty())
                args.push_back(tok);
            call(design, args);
            args.clear();
            if (num_semikolon == 2)
                call(design, "clean");
            if (num_semikolon == 3)
                call(design, "clean -purge");
        } else
            args.push_back(tok);
        tok = next_token(cmd_buf, " \t\r\n");
    }

    call(design, args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::call ( RTLIL::Design *  design, std::vector< std::string >  args  )

staticinherited

Definition at line 191 of file register.cc.

{
    if (args.size() == 0 || args[0][0] == '#')
        return;

    if (echo_mode) {
        log("%s", create_prompt(design, 0));
        for (size_t i = 0; i < args.size(); i++)
            log("%s%s", i ? " " : "", args[i].c_str());
        log("\n");
    }

    if (pass_register.count(args[0]) == 0)
        log_cmd_error("No such command: %s (type 'help' for a command overview)\n", args[0].c_str());

    size_t orig_sel_stack_pos = design->selection_stack.size();
    auto state = pass_register[args[0]]->pre_execute();
    pass_register[args[0]]->execute(args, design);
    pass_register[args[0]]->post_execute(state);
    while (design->selection_stack.size() > orig_sel_stack_pos)
        design->selection_stack.pop_back();

    design->check();
}

Here is the call graph for this function:

void Pass::call_on_module ( RTLIL::Design *  design, RTLIL::Module *  module, std::string  command  )

staticinherited

Definition at line 240 of file register.cc.

{
    std::string backup_selected_active_module = design->selected_active_module;
    design->selected_active_module = module->name.str();
    design->selection_stack.push_back(RTLIL::Selection(false));
    design->selection_stack.back().select(module);

    Pass::call(design, command);

    design->selection_stack.pop_back();
    design->selected_active_module = backup_selected_active_module;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::call_on_module ( RTLIL::Design *  design, RTLIL::Module *  module, std::vector< std::string >  args  )

staticinherited

Definition at line 253 of file register.cc.

{
    std::string backup_selected_active_module = design->selected_active_module;
    design->selected_active_module = module->name.str();
    design->selection_stack.push_back(RTLIL::Selection(false));
    design->selection_stack.back().select(module);

    Pass::call(design, args);

    design->selection_stack.pop_back();
    design->selected_active_module = backup_selected_active_module;
}

Here is the call graph for this function:

void Pass::call_on_selection ( RTLIL::Design *  design, const RTLIL::Selection &  selection, std::string  command  )

staticinherited

Definition at line 216 of file register.cc.

{
    std::string backup_selected_active_module = design->selected_active_module;
    design->selected_active_module.clear();
    design->selection_stack.push_back(selection);

    Pass::call(design, command);

    design->selection_stack.pop_back();
    design->selected_active_module = backup_selected_active_module;
}

Here is the call graph for this function:

void Pass::call_on_selection ( RTLIL::Design *  design, const RTLIL::Selection &  selection, std::vector< std::string >  args  )

staticinherited

Definition at line 228 of file register.cc.

{
    std::string backup_selected_active_module = design->selected_active_module;
    design->selected_active_module.clear();
    design->selection_stack.push_back(selection);

    Pass::call(design, args);

    design->selection_stack.pop_back();
    design->selected_active_module = backup_selected_active_module;
}

Here is the call graph for this function:

void Pass::cmd_error ( const std::vector< std::string > &  args, size_t  argidx, std::string  msg  )

inherited

Definition at line 110 of file register.cc.

{
    std::string command_text;
    int error_pos = 0;

    for (size_t i = 0; i < args.size(); i++) {
        if (i < argidx)
            error_pos += args[i].size() + 1;
        command_text = command_text + (command_text.empty() ? "" : " ") + args[i];
    }

    log("\nSyntax error in command `%s':\n", command_text.c_str());
    help();

    log_cmd_error("Command syntax error: %s\n> %s\n> %*s^\n",
            msg.c_str(), command_text.c_str(), error_pos, "");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::cmd_log_args ( const std::vector< std::string > &  args )

inherited

Definition at line 100 of file register.cc.

{
    if (args.size() <= 1)
        return;
    log("Full command line:");
    for (size_t i = 0; i < args.size(); i++)
        log(" %s", args[i].c_str());
    log("\n");
}

Here is the call graph for this function:

void Pass::done_register ( )

staticinherited

Definition at line 62 of file register.cc.

{
    frontend_register.clear();
    pass_register.clear();
    backend_register.clear();
    log_assert(first_queued_pass == NULL);
}

Here is the caller graph for this function:

void HelpPass::escape_html ( std::string &  html )

inline

Definition at line 550 of file register.cc.

    {
        size_t pos = 0;
        while ((pos = html.find_first_of("<>&", pos)) != std::string::npos)
            switch (html[pos]) {
            case '<':
                html.replace(pos, 1, "&lt;");
                pos += 4;
                break;
            case '>':
                html.replace(pos, 1, "&gt;");
                pos += 4;
                break;
            case '&':
                html.replace(pos, 1, "&amp;");
                pos += 5;
                break;
            }
    }

Here is the caller graph for this function:

void HelpPass::escape_tex ( std::string &  tex )

inline

Definition at line 529 of file register.cc.

    {
        size_t pos = 0;
        while ((pos = tex.find('_', pos)) != std::string::npos) {
            tex.replace(pos, 1, "\\_");
            pos += 2;
        }
    }

Here is the caller graph for this function:

virtual void HelpPass::execute ( std::vector< std::string >  args, RTLIL::Design *    )

inlinevirtual

Implements Pass.

Definition at line 587 of file register.cc.

    {
        if (args.size() == 1) {
            log("\n");
            for (auto &it : pass_register)
                log("    %-20s %s\n", it.first.c_str(), it.second->short_help.c_str());
            log("\n");
            log("Type 'help <command>' for more information on a command.\n");
            log("\n");
            return;
        }

        if (args.size() == 2) {
            if (args[1] == "-all") {
                for (auto &it : pass_register) {
                    log("\n\n");
                    log("%s  --  %s\n", it.first.c_str(), it.second->short_help.c_str());
                    for (size_t i = 0; i < it.first.size() + it.second->short_help.size() + 6; i++)
                        log("=");
                    log("\n");
                    it.second->help();
                }
            }
            // this option is undocumented as it is for internal use only
            else if (args[1] == "-write-tex-command-reference-manual") {
                FILE *f = fopen("command-reference-manual.tex", "wt");
                fprintf(f, "%% Generated using the yosys 'help -write-tex-command-reference-manual' command.\n\n");
                for (auto &it : pass_register) {
                    std::ostringstream buf;
                    log_streams.push_back(&buf);
                    it.second->help();
                    log_streams.pop_back();
                    write_tex(f, it.first, it.second->short_help, buf.str());
                }
                fclose(f);
            }
            // this option is undocumented as it is for internal use only
            else if (args[1] == "-write-web-command-reference-manual") {
                FILE *f = fopen("templates/cmd_index.in", "wt");
                for (auto &it : pass_register) {
                    std::ostringstream buf;
                    log_streams.push_back(&buf);
                    it.second->help();
                    log_streams.pop_back();
                    write_html(f, it.first, it.second->short_help, buf.str());
                }
                fclose(f);
            }
            else if (pass_register.count(args[1]) == 0)
                log("No such command: %s\n", args[1].c_str());
            else
                pass_register.at(args[1])->help();
            return;
        }

        help();
    }

Here is the call graph for this function:

void Pass::extra_args ( std::vector< std::string >  args, size_t  argidx, RTLIL::Design *  design, bool  select = true  )

inherited

Definition at line 128 of file register.cc.

{
    for (; argidx < args.size(); argidx++)
    {
        std::string arg = args[argidx];

        if (arg.substr(0, 1) == "-")
            cmd_error(args, argidx, "Unknown option or option in arguments.");

        if (!select)
            cmd_error(args, argidx, "Extra argument.");

        handle_extra_select_args(this, args, argidx, args.size(), design);
        break;
    }
    // cmd_log_args(args);
}

Here is the call graph for this function:

virtual void HelpPass::help ( )

inlinevirtual

Reimplemented from Pass.

Definition at line 521 of file register.cc.

    {
        log("\n");
        log("    help  .............  list all commands\n");
        log("    help <command>  ...  print help message for given command\n");
        log("    help -all  ........  print complete command reference\n");
        log("\n");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::init_register ( )

staticinherited

Definition at line 54 of file register.cc.

{
    while (first_queued_pass) {
        first_queued_pass->run_register();
        first_queued_pass = first_queued_pass->next_queued_pass;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::post_execute ( Pass::pre_post_exec_state_t  state )

inherited

Definition at line 84 of file register.cc.

{
    int64_t time_ns = PerformanceTimer::query() - state.begin_ns;
    runtime_ns += time_ns;
    current_pass = state.parent_pass;
    if (current_pass)
        current_pass->runtime_ns -= time_ns;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Pass::pre_post_exec_state_t Pass::pre_execute ( )

inherited

Definition at line 74 of file register.cc.

{
    pre_post_exec_state_t state;
    call_counter++;
    state.begin_ns = PerformanceTimer::query();
    state.parent_pass = current_pass;
    current_pass = this;
    return state;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Pass::run_register ( )

virtualinherited

Reimplemented in Backend, and Frontend.

Definition at line 48 of file register.cc.

{
    log_assert(pass_register.count(pass_name) == 0);
    pass_register[pass_name] = this;
}

Here is the caller graph for this function:

void HelpPass::write_html ( FILE *  idxf, std::string  cmd, std::string  title, std::string  text  )

inline

Definition at line 569 of file register.cc.

    {
        FILE *f = fopen(stringf("cmd_%s.in", cmd.c_str()).c_str(), "wt");
        fprintf(idxf, "<li><a href=\"cmd_%s.html\"> ", cmd.c_str());

        escape_html(cmd);
        escape_html(title);
        escape_html(text);

        fprintf(idxf, "%s</a> <span>%s</span></a>\n", cmd.c_str(), title.c_str());

        fprintf(f, "@cmd_header %s@\n", cmd.c_str());
        fprintf(f, "<h1>%s - %s</h1>\n", cmd.c_str(), title.c_str());
        fprintf(f, "<pre>%s</pre>\n", text.c_str());
        fprintf(f, "@footer@\n");

        fclose(f);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void HelpPass::write_tex ( FILE *  f, std::string  cmd, std::string  title, std::string  text  )

inline

Definition at line 537 of file register.cc.

    {
        size_t begin = text.find_first_not_of("\n"), end = text.find_last_not_of("\n");
        if (begin != std::string::npos && end != std::string::npos && begin < end)
            text = text.substr(begin, end-begin+1);
        std::string cmd_unescaped = cmd;
        escape_tex(cmd);
        escape_tex(title);
        fprintf(f, "\\section{%s -- %s}\n", cmd.c_str(), title.c_str());
        fprintf(f, "\\label{cmd:%s}\n", cmd_unescaped.c_str());
        fprintf(f, "\\begin{lstlisting}[numbers=left,frame=single]\n");
        fprintf(f, "%s\n\\end{lstlisting}\n\n", text.c_str());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

int Pass::call_counter

inherited

Definition at line 36 of file register.h.

Pass* Pass::next_queued_pass

inherited

Definition at line 60 of file register.h.

std::string Pass::pass_name

inherited

Definition at line 29 of file register.h.

int64_t Pass::runtime_ns

inherited

Definition at line 37 of file register.h.

std::string Pass::short_help

inherited

Definition at line 29 of file register.h.

---

The documentation for this struct was generated from the following file:

• register.cc