diff options
Diffstat (limited to 'doc/cpp/parser')
| -rw-r--r-- | doc/cpp/parser/archive.rst | 21 | ||||
| -rw-r--r-- | doc/cpp/parser/base64.rst | 5 | ||||
| -rw-r--r-- | doc/cpp/parser/css.rst | 84 | ||||
| -rw-r--r-- | doc/cpp/parser/csv.rst | 17 | ||||
| -rw-r--r-- | doc/cpp/parser/exception.rst | 37 | ||||
| -rw-r--r-- | doc/cpp/parser/index.rst | 24 | ||||
| -rw-r--r-- | doc/cpp/parser/json.rst | 14 | ||||
| -rw-r--r-- | doc/cpp/parser/stream.rst | 24 | ||||
| -rw-r--r-- | doc/cpp/parser/types.rst | 43 | ||||
| -rw-r--r-- | doc/cpp/parser/util.rst | 13 | ||||
| -rw-r--r-- | doc/cpp/parser/xml.rst | 65 | ||||
| -rw-r--r-- | doc/cpp/parser/xml_writer.rst | 7 | ||||
| -rw-r--r-- | doc/cpp/parser/yaml.rst | 14 |
13 files changed, 368 insertions, 0 deletions
diff --git a/doc/cpp/parser/archive.rst b/doc/cpp/parser/archive.rst new file mode 100644 index 0000000..e5f7a25 --- /dev/null +++ b/doc/cpp/parser/archive.rst @@ -0,0 +1,21 @@ + +Archive +======= + +Zip archive +----------- + +.. doxygenstruct:: orcus::zip_file_entry_header + :members: + +.. doxygenclass:: orcus::zip_archive + :members: + +.. doxygenclass:: orcus::zip_archive_stream + :members: + +.. doxygenclass:: orcus::zip_archive_stream_fd + :members: + +.. doxygenclass:: orcus::zip_archive_stream_blob + :members: diff --git a/doc/cpp/parser/base64.rst b/doc/cpp/parser/base64.rst new file mode 100644 index 0000000..617db37 --- /dev/null +++ b/doc/cpp/parser/base64.rst @@ -0,0 +1,5 @@ + +Base64 +====== + +.. doxygenfile:: base64.hpp diff --git a/doc/cpp/parser/css.rst b/doc/cpp/parser/css.rst new file mode 100644 index 0000000..beb6cb2 --- /dev/null +++ b/doc/cpp/parser/css.rst @@ -0,0 +1,84 @@ +.. highlight:: cpp + +CSS parser +========== + +.. doxygenclass:: orcus::css_parser + :members: + +Parser handler +-------------- + +.. doxygenclass:: orcus::css_handler + :members: + +CSS types +--------- + +.. doxygenenum:: orcus::css::combinator_t +.. doxygenenum:: orcus::css::property_function_t +.. doxygenenum:: orcus::css::property_value_t + +.. doxygentypedef:: orcus::css::pseudo_element_t +.. doxygentypedef:: orcus::css::pseudo_class_t + +.. doxygenstruct:: orcus::css::rgba_color_t +.. doxygenstruct:: orcus::css::hsla_color_t + + +Constants +--------- + +Pseudo elements +^^^^^^^^^^^^^^^ + +.. doxygenvariable:: orcus::css::pseudo_element_after +.. doxygenvariable:: orcus::css::pseudo_element_before +.. doxygenvariable:: orcus::css::pseudo_element_first_letter +.. doxygenvariable:: orcus::css::pseudo_element_first_line +.. doxygenvariable:: orcus::css::pseudo_element_selection +.. doxygenvariable:: orcus::css::pseudo_element_backdrop + +Pseudo classes +^^^^^^^^^^^^^^ + +.. doxygenvariable:: orcus::css::pseudo_class_active +.. doxygenvariable:: orcus::css::pseudo_class_checked +.. doxygenvariable:: orcus::css::pseudo_class_default +.. doxygenvariable:: orcus::css::pseudo_class_dir +.. doxygenvariable:: orcus::css::pseudo_class_disabled +.. doxygenvariable:: orcus::css::pseudo_class_empty +.. doxygenvariable:: orcus::css::pseudo_class_enabled +.. doxygenvariable:: orcus::css::pseudo_class_first +.. doxygenvariable:: orcus::css::pseudo_class_first_child +.. doxygenvariable:: orcus::css::pseudo_class_first_of_type +.. doxygenvariable:: orcus::css::pseudo_class_fullscreen +.. doxygenvariable:: orcus::css::pseudo_class_focus +.. doxygenvariable:: orcus::css::pseudo_class_hover +.. doxygenvariable:: orcus::css::pseudo_class_indeterminate +.. doxygenvariable:: orcus::css::pseudo_class_in_range +.. doxygenvariable:: orcus::css::pseudo_class_invalid +.. doxygenvariable:: orcus::css::pseudo_class_lang +.. doxygenvariable:: orcus::css::pseudo_class_last_child +.. doxygenvariable:: orcus::css::pseudo_class_last_of_type +.. doxygenvariable:: orcus::css::pseudo_class_left +.. doxygenvariable:: orcus::css::pseudo_class_link +.. doxygenvariable:: orcus::css::pseudo_class_not +.. doxygenvariable:: orcus::css::pseudo_class_nth_child +.. doxygenvariable:: orcus::css::pseudo_class_nth_last_child +.. doxygenvariable:: orcus::css::pseudo_class_nth_last_of_type +.. doxygenvariable:: orcus::css::pseudo_class_nth_of_type +.. doxygenvariable:: orcus::css::pseudo_class_only_child +.. doxygenvariable:: orcus::css::pseudo_class_only_of_type +.. doxygenvariable:: orcus::css::pseudo_class_optional +.. doxygenvariable:: orcus::css::pseudo_class_out_of_range +.. doxygenvariable:: orcus::css::pseudo_class_read_only +.. doxygenvariable:: orcus::css::pseudo_class_read_write +.. doxygenvariable:: orcus::css::pseudo_class_required +.. doxygenvariable:: orcus::css::pseudo_class_right +.. doxygenvariable:: orcus::css::pseudo_class_root +.. doxygenvariable:: orcus::css::pseudo_class_scope +.. doxygenvariable:: orcus::css::pseudo_class_target +.. doxygenvariable:: orcus::css::pseudo_class_valid +.. doxygenvariable:: orcus::css::pseudo_class_visited + diff --git a/doc/cpp/parser/csv.rst b/doc/cpp/parser/csv.rst new file mode 100644 index 0000000..67e708a --- /dev/null +++ b/doc/cpp/parser/csv.rst @@ -0,0 +1,17 @@ +.. highlight:: cpp + +CSV parser +========== + +.. doxygenclass:: orcus::csv_parser + :members: + +.. doxygenstruct:: orcus::csv::parser_config + :members: + +Parser handler +-------------- + +.. doxygenclass:: orcus::csv_handler + :members: + diff --git a/doc/cpp/parser/exception.rst b/doc/cpp/parser/exception.rst new file mode 100644 index 0000000..e6b14cc --- /dev/null +++ b/doc/cpp/parser/exception.rst @@ -0,0 +1,37 @@ +.. highlight:: cpp + +Exceptions +========== + +.. doxygenclass:: orcus::general_error + :members: + +.. doxygenclass:: orcus::invalid_arg_error + :members: + +.. doxygenclass:: orcus::xml_structure_error + :members: + +.. doxygenclass:: orcus::json_structure_error + :members: + +.. doxygenclass:: orcus::invalid_map_error + :members: + +.. doxygenclass:: orcus::value_error + :members: + +.. doxygenclass:: orcus::xpath_error + :members: + +.. doxygenclass:: orcus::interface_error + :members: + +.. doxygenclass:: orcus::parse_error + :members: + +.. doxygenclass:: orcus::malformed_xml_error + :members: + +.. doxygenclass:: orcus::zip_error + :members: diff --git a/doc/cpp/parser/index.rst b/doc/cpp/parser/index.rst new file mode 100644 index 0000000..5a8141b --- /dev/null +++ b/doc/cpp/parser/index.rst @@ -0,0 +1,24 @@ + +Low-level parsers +================= + +This section presents the API's from the ``liborcus-parser`` part of this library, +which contains low-level parsers and utilities either used by or used in conjunction +with the parsers. The higher level import filters document models internally use +these parsers and utilities. + +.. toctree:: + :maxdepth: 1 + + xml.rst + xml_writer.rst + json.rst + css.rst + csv.rst + yaml.rst + types.rst + util.rst + stream.rst + base64.rst + archive.rst + exception.rst diff --git a/doc/cpp/parser/json.rst b/doc/cpp/parser/json.rst new file mode 100644 index 0000000..8aa402b --- /dev/null +++ b/doc/cpp/parser/json.rst @@ -0,0 +1,14 @@ +.. highlight:: cpp + +JSON parser +=========== + +.. doxygenclass:: orcus::json_parser + :members: + +Parser handler +-------------- + +.. doxygenclass:: orcus::json_handler + :members: + diff --git a/doc/cpp/parser/stream.rst b/doc/cpp/parser/stream.rst new file mode 100644 index 0000000..6f8ecde --- /dev/null +++ b/doc/cpp/parser/stream.rst @@ -0,0 +1,24 @@ +.. highlight:: cpp + +Stream +====== + +Stream buffers +-------------- + +.. doxygenclass:: orcus::file_content + :members: + +.. doxygenclass:: orcus::memory_content + :members: + +Utility functions +----------------- + +.. doxygenstruct:: orcus::line_with_offset + :members: + +.. doxygenfunction:: orcus::create_parse_error_output +.. doxygenfunction:: orcus::locate_line_with_offset +.. doxygenfunction:: orcus::locate_first_different_char +.. doxygenfunction:: orcus::calc_logical_string_length diff --git a/doc/cpp/parser/types.rst b/doc/cpp/parser/types.rst new file mode 100644 index 0000000..6c53267 --- /dev/null +++ b/doc/cpp/parser/types.rst @@ -0,0 +1,43 @@ + +Basic types +=========== + +Constants +--------- + +.. doxygenvariable:: orcus::INDEX_NOT_FOUND +.. doxygenvariable:: orcus::XMLNS_UNKNOWN_ID +.. doxygenvariable:: orcus::XML_UNKNOWN_TOKEN + +Type aliases +------------ + +.. doxygentypedef:: orcus::xml_token_attrs_t +.. doxygentypedef:: orcus::xml_token_t +.. doxygentypedef:: orcus::xmlns_id_t + +Structs +------- + +.. doxygenstruct:: orcus::date_time_t +.. doxygenstruct:: orcus::length_t +.. doxygenstruct:: orcus::parse_error_value_t +.. doxygenstruct:: orcus::xml_declaration_t +.. doxygenstruct:: orcus::xml_name_t +.. doxygenstruct:: orcus::xml_token_attr_t +.. doxygenstruct:: orcus::xml_token_element_t + +Enums +----- + +.. doxygenenum:: orcus::character_set_t +.. doxygenenum:: orcus::dump_format_t +.. doxygenenum:: orcus::format_t +.. doxygenenum:: orcus::length_unit_t + +Utility functions +----------------- + +.. doxygenfunction:: orcus::get_dump_format_entries +.. doxygenfunction:: orcus::to_character_set +.. doxygenfunction:: orcus::to_dump_format_enum diff --git a/doc/cpp/parser/util.rst b/doc/cpp/parser/util.rst new file mode 100644 index 0000000..2d3ec0d --- /dev/null +++ b/doc/cpp/parser/util.rst @@ -0,0 +1,13 @@ +.. highlight:: cpp + +Utilities +========= + +.. doxygenclass:: orcus::string_pool + :members: + +.. doxygenclass:: orcus::tokens + :members: + +.. doxygenclass:: orcus::cell_buffer + :members: diff --git a/doc/cpp/parser/xml.rst b/doc/cpp/parser/xml.rst new file mode 100644 index 0000000..462c466 --- /dev/null +++ b/doc/cpp/parser/xml.rst @@ -0,0 +1,65 @@ +.. highlight:: cpp + +XML parsers +=========== + +SAX base parser +--------------- + +.. doxygenclass:: orcus::sax_parser + :members: + +.. doxygenstruct:: orcus::sax_parser_default_config + :members: + +.. doxygenclass:: orcus::sax_handler + :members: + +.. doxygenstruct:: orcus::sax::parser_element + :members: + +.. doxygenstruct:: orcus::sax::parser_attribute + :members: + +SAX namespace parser +-------------------- + +.. doxygenclass:: orcus::sax_ns_parser + :members: + +.. doxygenclass:: orcus::sax_ns_handler + :members: + +.. doxygenstruct:: orcus::sax_ns_parser_element + :members: + +.. doxygenstruct:: orcus::sax_ns_parser_attribute + :members: + +SAX token parser +---------------- + +.. doxygenclass:: orcus::sax_token_parser + :members: + +.. doxygenclass:: orcus::sax_token_handler + :members: + +Namespace +--------- + +.. doxygenclass:: orcus::xmlns_repository + :members: + +.. doxygenclass:: orcus::xmlns_context + :members: + +Common +------ + +.. doxygenstruct:: orcus::sax::doctype_declaration + :members: + +.. doxygenfunction:: orcus::sax::decode_xml_encoded_char + +.. doxygenfunction:: orcus::sax::decode_xml_unicode_char diff --git a/doc/cpp/parser/xml_writer.rst b/doc/cpp/parser/xml_writer.rst new file mode 100644 index 0000000..1092ac4 --- /dev/null +++ b/doc/cpp/parser/xml_writer.rst @@ -0,0 +1,7 @@ +.. highlight:: cpp + +XML writer +========== + +.. doxygenclass:: orcus::xml_writer + :members: diff --git a/doc/cpp/parser/yaml.rst b/doc/cpp/parser/yaml.rst new file mode 100644 index 0000000..0a1107a --- /dev/null +++ b/doc/cpp/parser/yaml.rst @@ -0,0 +1,14 @@ +.. highlight:: cpp + +YAML parser +=========== + +.. doxygenclass:: orcus::yaml_parser + :members: + +Parser Handler +-------------- + +.. doxygenclass:: orcus::yaml_handler + :members: + |