xmlio Logo

Contents

  • 1. Overview and Quick Start
    • 1.1. Purpose
    • 1.2. Requirements
    • 1.3. Build and test
    • 1.4. First round trip
    • 1.5. Choosing an input constructor
    • 1.6. Where to continue
  • 2. Reading XML
    • 2.1. Input sources
    • 2.2. Paths and scalar reads
    • 2.3. Subreaders
    • 2.4. Attributes
    • 2.5. Queries and optional values
    • 2.6. Repeated siblings
    • 2.7. Reader diagnostics and mutation
    • 2.8. Complete XPath example
  • 3. Writing XML
    • 3.1. Memory and file writers
    • 3.2. Creating the document tree
    • 3.3. Attributes and empty elements
    • 3.4. Namespaces
    • 3.5. Text, escaping, and raw XML
    • 3.6. Embedding documents
    • 3.7. Serialization and output
    • 3.8. Complete composition example
  • 4. Types and XML Representations
    • 4.1. Representation summary
    • 4.2. Scalar values
    • 4.3. Complex numbers
    • 4.4. Sequential containers
    • 4.5. Pairs and maps
    • 4.6. Optional values
    • 4.7. Repeated siblings
  • 5. User-Defined Types
    • 5.1. Serialization by ordinary functions
    • 5.2. Required and optional fields
    • 5.3. Enums and readable XML
    • 5.4. Validation belongs to the type
    • 5.5. Nested and associative records
  • 6. XPath and XML Composition
    • 6.1. Useful XPath forms
    • 6.2. Namespaces
    • 6.3. Deferred typed groups
    • 6.4. Subtree extraction and provenance
    • 6.5. XML as metadata
    • 6.6. Combining catalogs
  • 7. Errors and Application Design
    • 7.1. Exception hierarchy
    • 7.2. Schema versions
    • 7.3. Required fields and unknown fields
    • 7.4. Application boundaries
    • 7.5. Security and ownership
  • 8. Building and Integration
    • 8.1. CMake options
    • 8.2. Complete developer build
    • 8.3. Choosing a compiler and build directory
    • 8.4. HTML-only builds
    • 8.5. Example programs
    • 8.6. Installation
    • 8.7. Consuming the package
  • 9. API Reference
    • xmlio
      • readXMLGroup()
      • readXMLVectorGroup()
      • readXMLArrayGroup()
      • read()
      • read()
      • read()
      • read()
      • read()
      • read()
      • read_map_into()
      • read()
      • read()
      • read()
      • read()
      • read()
      • read_optional()
      • read_optional()
      • read_many()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write()
      • write_many()
      • write()
      • write()
      • operator<<()
      • operator<<()
      • operator<<()
      • operator<<()
      • operator<<()
      • operator<<()
      • operator<<()
      • AttributeList
      • GroupXML_t
      • DuplicateKeyPolicy
        • error
        • keep_existing
        • overwrite
      • read_xml_group()
      • read_xml_vector_group()
      • exists()
      • count()
      • get_text()
      • push()
      • pop()
      • xmlio::Attribute
        • getName()
        • getValue()
        • isEmpty()
        • Attribute()
        • Attribute()
        • Attribute()
        • Attribute()
        • Attribute()
        • name()
        • value()
        • empty()
      • xmlio::ConversionError
        • ConversionError()
        • path()
        • value()
      • xmlio::GroupXml
        • xml
        • id
        • path
      • xmlio::ParseError
      • xmlio::QueryError
        • QueryError()
        • path()
      • xmlio::WriterError
      • xmlio::XMLBufferWriter
        • XMLBufferWriter()
        • XMLBufferWriter()
      • xmlio::XmlError
      • xmlio::XMLFileWriter
        • XMLFileWriter()
        • XMLFileWriter()
        • XMLFileWriter()
        • open()
        • flush()
        • fail()
        • is_open()
        • close()
      • xmlio::XMLReader
        • open()
        • open()
        • open()
        • load_from_file()
        • load_from_string()
        • close()
        • exists()
        • count()
        • text()
        • texts()
        • attribute()
        • get()
        • get()
        • get()
        • getAttribute()
        • getAttribute()
        • evaluateXPath()
        • printQueryResult()
        • print()
        • printRoot()
        • printCurrentContext()
        • printXPathNode()
        • str()
        • root_str()
        • context_str()
        • xpath_str()
        • XMLReader()
        • XMLReader()
        • XMLReader()
        • XMLReader()
        • XMLReader()
        • XMLReader()
        • operator=()
        • is_open()
        • is_derived()
        • registerNamespace()
        • set_text()
        • set()
        • from_string()
        • from_file()
      • xmlio::XMLWriter
        • openSimple()
        • closeSimple()
        • openStruct()
        • closeStruct()
        • openTag()
        • openTag()
        • openTag()
        • openTag()
        • closeTag()
        • emptyTag()
        • emptyTag()
        • emptyTag()
        • emptyTag()
        • write()
        • write()
        • write()
        • write()
        • writeXML()
        • write_element()
        • write()
        • write()
        • write()
        • write()
        • write()
        • set_attr()
        • set_attr()
        • set_attr()
        • set_attr()
        • XMLWriter()
        • XMLWriter()
        • XMLWriter()
        • operator=()
        • push()
        • pop()
        • empty()
        • depth()
        • str()
        • printRoot()
        • print()
        • save()
        • impl_
      • xmlio::detail
        • trim_ascii()
        • scalar_to_text()
        • scalar_from_text()
        • compact_sequence_text()
        • parse_compact_sequence()
        • read_structured_elements()
  • 10. ADAT XML compatibility
    • 10.1. Implemented in the core package
    • 10.2. Deliberate modernization
    • 10.3. Important behavioral differences
    • 10.4. Compatibility adapters not in the core
  • 11. License
xmlio
  • Search

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.