Description
Definition at line 239 of file AsmFunctionIndex.h.
Public Member Functions | |
| size_t | add_footnote (const std::string &text) |
| Adds a footnote to the table. | |
| void | change_footnote (size_t idx, const std::string &text) |
| Change the text associated with a footnote. | |
| const std::string & | get_footnote (size_t idx) const |
| Get the string for a footnote. | |
| size_t | size () const |
| Returns the number of footnotes. | |
| void | set_footnote_title (const std::string &title) |
| Change the footnote title string. | |
| const std::string & | get_footnote_title () const |
| Get the footnote title. | |
| void | set_footnote_prefix (const std::string &prefix) |
| Set the footnote prefix string. | |
| const std::string & | get_footnote_prefix () const |
| Get the footnote prefix string. | |
| std::string | get_footnote_name (size_t idx) const |
| Generates a footnote name from a footnote index. | |
| void | print (std::ostream &) const |
| Print non-empty footnotes. | |
Protected Attributes | |
| std::vector< std::string > | footnotes |
| List of footnotes. | |
| std::string | footnote_prefix |
| String to emit before every footnote line. | |
Constructor & Destructor Documentation
◆ Footnotes()
|
inline |
Definition at line 241 of file AsmFunctionIndex.h.
Member Function Documentation
◆ add_footnote()
| size_t Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::add_footnote | ( | const std::string & | text | ) |
Adds a footnote to the table.
Footnotes are printed at the end of the table by the ShowFootnotes callback class. Footnotes are numbered starting at one rather than zero, and this function returns the footnote number. Calling this function with an empty text argument will reserve a footnote number but will not print the footnote in the final output.
The first line of the footnote is prefixed by the string "Footnote *N: " and subsequent lines are indented by the length of the prefix.
◆ change_footnote()
| void Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::change_footnote | ( | size_t | idx, |
| const std::string & | text | ||
| ) |
Change the text associated with a footnote.
The footnote must already exist, and the footnote idx is the value returned by a previous call to add_footnote(). Setting text to the empty string causes the footnote to not appear in the final output, but other footnotes are not renumbered to close the gap (because their references might have already been printed. See also, add_footnote().
◆ get_footnote()
| const std::string & Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::get_footnote | ( | size_t | idx | ) | const |
Get the string for a footnote.
The footnote must already exist and idx is a footnote number returned by a previous call to add_footnote().
◆ size()
|
inline |
Returns the number of footnotes.
Footnotes are numbered starting at one. The return value includes empty footnotes that won't be printed by the final output.
Definition at line 266 of file AsmFunctionIndex.h.
References footnotes.
◆ set_footnote_title()
| void Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::set_footnote_title | ( | const std::string & | title | ) |
Change the footnote title string.
The title string is printed before the first footnote if there are any footnotes with a non-empty string.
◆ get_footnote_title()
| const std::string & Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::get_footnote_title | ( | ) | const |
Get the footnote title.
The default title is "== Footnotes ==".
◆ set_footnote_prefix()
|
inline |
Set the footnote prefix string.
This string is printed before every line of the footnote area. The default is the empty string.
Definition at line 277 of file AsmFunctionIndex.h.
References footnote_prefix.
◆ get_footnote_prefix()
|
inline |
Get the footnote prefix string.
This string is printed before every line of the footnote area.
Definition at line 280 of file AsmFunctionIndex.h.
References footnote_prefix.
◆ get_footnote_name()
| std::string Rose::BinaryAnalysis::AsmFunctionIndex::Footnotes::get_footnote_name | ( | size_t | idx | ) | const |
Generates a footnote name from a footnote index.
The default is to return the index prefixed by an asterisk.
Member Data Documentation
◆ footnotes
|
protected |
List of footnotes.
Elmt zero is an optional footnote title string.
Definition at line 295 of file AsmFunctionIndex.h.
Referenced by size().
◆ footnote_prefix
|
protected |
String to emit before every footnote line.
Definition at line 296 of file AsmFunctionIndex.h.
Referenced by get_footnote_prefix(), and set_footnote_prefix().
The documentation for this class was generated from the following file:
