Class for create JSON machine readable documentation. More...
#include <type_output.hh>
Public Member Functions | |
| OutputJSONMachine (TypeBase *type, unsigned int depth=0) | |
 Public Member Functions inherited from Input::Type::OutputBase | |
| virtual ostream & | print (ostream &stream) |
Performs output of the documentation into given stream. The same effect has the reloaded operator '<<'. Returns reference to the same stream. More... | |
| void | set_filter (string regex_filter) |
Initializes and allocates regular expression filter regex_filter. More... | |
Protected Member Functions | |
| std::string | format_hash (std::size_t hash) |
| std::string | escape_description (std::string desc) |
| void | print_impl (ostream &stream, const Record *type, unsigned int depth) |
| void | print_impl (ostream &stream, const Array *type, unsigned int depth) |
| void | print_impl (ostream &stream, const AbstractRecord *type, unsigned int depth) |
| void | print_impl (ostream &stream, const AdHocAbstractRecord *type, unsigned int depth) |
| void | print_impl (ostream &stream, const Selection *type, unsigned int depth) |
| void | print_impl (ostream &stream, const Integer *type, unsigned int depth) |
| void | print_impl (ostream &stream, const Double *type, unsigned int depth) |
| void | print_impl (ostream &stream, const Bool *type, unsigned int depth) |
| void | print_impl (ostream &stream, const String *type, unsigned int depth) |
| void | print_impl (ostream &stream, const FileName *type, unsigned int depth) |
| void | print_abstract_record_keys (ostream &stream, const AbstractRecord *type, unsigned int depth) |
| Print all keys of AbstractRecord type or AdHocAbstractRecord type. More... | |
| Protected Member Functions inherited from Input::Type::OutputBase | |
| OutputBase (const TypeBase *type, unsigned int depth=0) | |
| virtual | ~OutputBase () |
| Destructor. More... | |
| void | get_array_sizes (Array array, unsigned int &lower, unsigned int &upper) |
| Gets range of array. More... | |
| const string & | get_record_description (const Record *rec) |
| Gets description of the given record type. More... | |
| void | get_record_key (Record rec, unsigned int key_idx, Record::Key &key) |
| Gets record key for given index. More... | |
| void | get_integer_bounds (Integer integer, int &lower, int &upper) |
| Gets range of integer. More... | |
| void | get_double_bounds (Double dbl, double &lower, double &upper) |
| Gets range of double. More... | |
| void | get_parent_ptr (Record rec, boost::shared_ptr< AbstractRecord > &parent_ptr) |
| Gets pointer of parent AbstractRecord for given Record. More... | |
| void | get_array_type (Array array, boost::shared_ptr< const TypeBase > &arr_type) |
| Gets pointer of inner type for given Array. More... | |
| void | get_default (Record::KeyIter it, string &type, string &value) |
| Gets values of default for given record key. More... | |
| const string & | get_selection_description (const Selection *sel) |
| Gets description of the given selection type. More... | |
| const string & | get_adhoc_parent_name (const AdHocAbstractRecord *a_rec) |
| Gets parent_name_ of the given AdHocAbstractRecord type. More... | |
| AbstractRecord::ChildDataIter | get_adhoc_parent_data (const AdHocAbstractRecord *a_rec) |
| Gets iterator to begin of parent_data_ of the given AdHocAbstractRecord type. More... | |
| const void * | get_record_data (const Record *rec) |
| Gets pointer of inner data for given Record. More... | |
| const void * | get_abstract_record_data (const AbstractRecord *a_rec) |
| Gets pointer of inner data for given AbstractRecord. More... | |
| const void * | get_selection_data (const Selection *sel) |
| Gets pointer of inner data for given Selection. More... | |
| const void * | get_array_data (const Array *array) |
| Gets pointer of inner data for given Array. More... | |
| const void * | get_type_base_data (const TypeBase *type) |
| Gets pointer of inner data for given TypeBase. More... | |
| void | print (ostream &stream, const TypeBase *type, unsigned int depth) |
| void | write_description (std::ostream &stream, const string &str, unsigned int padding, unsigned int hash_count=1) |
| void | write_default_value (std::ostream &stream, Default dft) |
Additional Inherited Members | |
| Protected Types inherited from Input::Type::OutputBase | |
| enum | DocumentationType { key_record, full_record } |
| Protected Attributes inherited from Input::Type::OutputBase | |
| const TypeBase * | type_ |
| Object for which is created printout. More... | |
| unsigned int | depth_ |
| Depth of printout (for value 0 is printed all input tree) More... | |
| DocumentationType | doc_type_ |
| Type of documentation output. More... | |
| unsigned int | size_setw_ |
| temporary value for printout of description (used in std::setw function) More... | |
| std::string | format_head |
| std::string | format_tail |
| ProcessedTypes | doc_flags_ |
| Stores flags and references of processed type. More... | |
| Static Protected Attributes inherited from Input::Type::OutputBase | |
| static const unsigned int | padding_size = 4 |
| Padding of new level of printout, used where we use indentation. More... | |
Detailed Description
Class for create JSON machine readable documentation.
Every type is represented by one JSON object, for Selection e.g.: "name" : (string), "full_name" : (string), "type" : "Selection", "values" : [ { "value" : (int), "name": (string), "description" : (string) } ]
Definition at line 442 of file type_output.hh.
Constructor & Destructor Documentation
|
inline |
Definition at line 444 of file type_output.hh.
Member Function Documentation
|
protected |
Definition at line 1271 of file type_output.cc.
|
protected |
Definition at line 1264 of file type_output.cc.
|
protected |
Print all keys of AbstractRecord type or AdHocAbstractRecord type.
Definition at line 1400 of file type_output.cc.
|
protectedvirtual |
Implements printout of Record type
Implements Input::Type::OutputBase.
Definition at line 1276 of file type_output.cc.
|
protectedvirtual |
Implements printout of Array type
Implements Input::Type::OutputBase.
Definition at line 1337 of file type_output.cc.
|
protectedvirtual |
Implements printout of AbstractRecord type
Implements Input::Type::OutputBase.
Definition at line 1359 of file type_output.cc.
|
protectedvirtual |
Implements printout of AdHocAbstractRecord type
Implements Input::Type::OutputBase.
Definition at line 1380 of file type_output.cc.
|
protectedvirtual |
Implements printout of Selection type
Implements Input::Type::OutputBase.
Definition at line 1425 of file type_output.cc.
|
protectedvirtual |
Implements printout of Integer type
Implements Input::Type::OutputBase.
Definition at line 1453 of file type_output.cc.
|
protectedvirtual |
Implements printout of Double type
Implements Input::Type::OutputBase.
Definition at line 1471 of file type_output.cc.
|
protectedvirtual |
Implements printout of Bool type
Implements Input::Type::OutputBase.
Definition at line 1488 of file type_output.cc.
|
protectedvirtual |
Implements printout of String type
Implements Input::Type::OutputBase.
Definition at line 1501 of file type_output.cc.
|
protectedvirtual |
Implements printout of FileName type
Implements Input::Type::OutputBase.
Definition at line 1514 of file type_output.cc.
The documentation for this class was generated from the following files:
- /home/builder/jenkins/F123-linux-release/flow123d/src/input/type_output.hh
- /home/builder/jenkins/F123-linux-release/flow123d/src/input/type_output.cc
