This class produces produces a dump of the InputParameters that appears like the normal input file syntax. More...
#include <InputFileFormatter.h>
Public Member Functions | |
InputFileFormatter (bool dump_mode) | |
virtual std::string | printBlockOpen (const std::string &name, short depth, const std::string &) override |
This method is called at the beginning of each Node in the tree. More... | |
virtual std::string | printBlockClose (const std::string &name, short depth) const override |
This method is called at the end of of each Node in the tree. More... | |
virtual std::string | printParams (const std::string &prefix, const std::string &fully_qualified_name, InputParameters ¶ms, short depth, const std::string &search_string, bool &found) override |
This function is called for each InputParameters object stored at a particular node. More... | |
void | insertNode (std::string syntax, const std::string &action, bool is_action_params=true, InputParameters *params=NULL) |
std::string | print (const std::string &search_string) |
void | seenIt (const std::string &prefix, const std::string &item) |
bool | haveSeenIt (const std::string &prefix, const std::string &item) const |
virtual std::string | preamble () const |
This method is called once at the beginning of the tree traversal and can be used to build up header information. More... | |
virtual std::string | postscript () const |
This method is called once at the end of the tree traversal and can be used to add any necessary trailing information to the final formatted string. More... | |
virtual std::string | preTraverse (short) const |
This method is called once at each node in the syntax tree before traversing child nodes. More... | |
Protected Member Functions | |
bool | isLongNames () const |
Protected Attributes | |
bool | _dump_mode |
std::unique_ptr< TreeNode > | _root |
bool | _use_long_names |
This class produces produces a dump of the InputParameters that appears like the normal input file syntax.
Definition at line 18 of file InputFileFormatter.h.
InputFileFormatter::InputFileFormatter | ( | bool | dump_mode | ) |
Definition at line 18 of file InputFileFormatter.C.
|
inherited |
Definition at line 63 of file SyntaxTree.C.
Referenced by printParams(), and YAMLFormatter::printParams().
|
inherited |
|
protectedinherited |
Definition at line 227 of file SyntaxTree.C.
|
inlinevirtualinherited |
This method is called once at the end of the tree traversal and can be used to add any necessary trailing information to the final formatted string.
Reimplemented in YAMLFormatter.
Definition at line 41 of file SyntaxFormatterInterface.h.
Referenced by SyntaxTree::print().
|
inlinevirtualinherited |
This method is called once at the beginning of the tree traversal and can be used to build up header information.
Reimplemented in YAMLFormatter.
Definition at line 33 of file SyntaxFormatterInterface.h.
Referenced by SyntaxTree::print().
|
inlinevirtualinherited |
This method is called once at each node in the syntax tree before traversing child nodes.
Reimplemented in YAMLFormatter.
Definition at line 47 of file SyntaxFormatterInterface.h.
|
inherited |
Definition at line 39 of file SyntaxTree.C.
Referenced by ActionWarehouse::printInputFile().
|
overridevirtual |
This method is called at the end of of each Node in the tree.
It is typically used to provide formatting necessary when closing blocks.
Implements SyntaxFormatterInterface.
Definition at line 35 of file InputFileFormatter.C.
|
overridevirtual |
This method is called at the beginning of each Node in the tree.
It is typically used to provide formatting necessary when opening new blocks.
Implements SyntaxFormatterInterface.
Definition at line 21 of file InputFileFormatter.C.
|
overridevirtual |
This function is called for each InputParameters object stored at a particular node.
It is responsible for formatting the parameters for the current node.
Implements SyntaxFormatterInterface.
Definition at line 47 of file InputFileFormatter.C.
|
inherited |
Definition at line 57 of file SyntaxTree.C.
Referenced by printParams(), and YAMLFormatter::printParams().
|
protected |
Definition at line 34 of file InputFileFormatter.h.
Referenced by printParams().
|
protectedinherited |
Definition at line 76 of file SyntaxTree.h.
Referenced by SyntaxTree::insertNode(), and SyntaxTree::print().
|
protectedinherited |
Definition at line 77 of file SyntaxTree.h.
Referenced by SyntaxTree::isLongNames().