This interface is for classes that want to be called to format InputParameters. More...
#include <SyntaxFormatterInterface.h>
Public Member Functions | |
SyntaxFormatterInterface () | |
virtual | ~SyntaxFormatterInterface ()=default |
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... | |
virtual std::string | printBlockOpen (const std::string &name, short depth, const std::string &doc)=0 |
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 =0 |
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)=0 |
This function is called for each InputParameters object stored at a particular node. More... | |
This interface is for classes that want to be called to format InputParameters.
When the syntax tree is traversed, each of these methods are called at the right points to build up a formatted string that can meet a number of different needs.
Definition at line 22 of file SyntaxFormatterInterface.h.
|
inline |
Definition at line 25 of file SyntaxFormatterInterface.h.
|
virtualdefault |
|
inlinevirtual |
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().
|
inlinevirtual |
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().
|
inlinevirtual |
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.
|
pure virtual |
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.
Implemented in YAMLFormatter, and InputFileFormatter.
|
pure virtual |
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.
Implemented in YAMLFormatter, and InputFileFormatter.
|
pure virtual |
This function is called for each InputParameters object stored at a particular node.
It is responsible for formatting the parameters for the current node.
Implemented in YAMLFormatter, and InputFileFormatter.