xml_structure_tree.hpp

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#ifndef INCLUDED_ORCUS_XML_STRUCTURE_TREE_HPP
#define INCLUDED_ORCUS_XML_STRUCTURE_TREE_HPP
 
#include "env.hpp"
#include "types.hpp"
 
#include <ostream>
#include <memory>
#include <functional>
#include <any>
 
namespace orcus {
 
class xmlns_context;
 
struct ORCUS_DLLPUBLIC xml_table_range_t
{
    std::vector<std::string> paths;
    std::vector<std::string> row_groups;
 
    xml_table_range_t();
    xml_table_range_t(const xml_table_range_t& other);
    xml_table_range_t(xml_table_range_t&& other) noexcept;
    ~xml_table_range_t();
 
    xml_table_range_t& operator=(xml_table_range_t other) noexcept;
 
    void swap(xml_table_range_t& other) noexcept;
};

class ORCUS_DLLPUBLIC xml_structure_tree
{
    struct impl;
    std::unique_ptr<impl> mp_impl;
 
public:
    xml_structure_tree() = delete;
    xml_structure_tree(const xml_structure_tree&) = delete;
    xml_structure_tree& operator= (const xml_structure_tree&) = delete;

    enum class callback_type : uint8_t
    {
        unknown = 0,

        on_repeat_node
    };

    using callback_handler_type = std::function<void(std::any)>;
 
    using range_handler_type = std::function<void(xml_table_range_t&&)>;
 
    struct ORCUS_DLLPUBLIC entity_name
    {
        xmlns_id_t ns;
        std::string_view name;
 
        entity_name();
        entity_name(xmlns_id_t _ns, std::string_view _name);
 
        bool operator< (const entity_name& r) const;
        bool operator== (const entity_name& r) const;
 
        struct ORCUS_DLLPUBLIC hash
        {
            size_t operator ()(const entity_name& val) const;
        };
    };
 
    typedef std::vector<entity_name> entity_names_type;
 
    struct ORCUS_DLLPUBLIC element
    {
        entity_name name;
        bool repeat;
        bool has_content;
 
        element();
        element(const entity_name& _name, bool _repeat, bool _has_content);
    };
 
    struct walker_impl;

    class ORCUS_DLLPUBLIC walker
    {
        friend class xml_structure_tree;
 
        std::unique_ptr<walker_impl> mp_impl;
 
        walker(const xml_structure_tree::impl& parent_impl);
    public:
        walker() = delete;
        walker(const walker& r);
        ~walker();
        walker& operator= (const walker& r);

        element root();

        element descend(const entity_name& name);

        element ascend();

        element move_to(const std::string& path);

        entity_names_type get_children();

        entity_names_type get_attributes();

        size_t get_xmlns_index(xmlns_id_t ns) const;
 
        std::string get_xmlns_short_name(xmlns_id_t ns) const;

        std::string to_string(const entity_name& name) const;

        std::string get_path() const;
    };
 
    xml_structure_tree(xmlns_context& xmlns_cxt);
    xml_structure_tree(xml_structure_tree&& other);
    ~xml_structure_tree();

    void set_callback(callback_type type, callback_handler_type callback);
 
    void parse(std::string_view s);
 
    void dump_compact(std::ostream& os) const;
 
    walker get_walker() const;
 
    void process_ranges(range_handler_type rh) const;
 
    void swap(xml_structure_tree& other);
};
 
}
 
 
 
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */