XmlDocument.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/

 
#ifndef GUM_XML_DOCUMENT_H
#define GUM_XML_DOCUMENT_H
 
#include <exception>
#include <memory>
#include <string>
#include <vector>
 
#include <agrum/config.h>
 
namespace gum {

  class GUM_PUBLIC_BN XmlException: public std::exception {
    public:
    explicit XmlException(std::string message);
 
    const char* what() const noexcept override;
 
    private:
    std::string _message_;
  };

  class GUM_PUBLIC_BN XmlElement {
    public:
    XmlElement() = default;
 
    bool isNull() const noexcept { return _handle_ == nullptr; }

    XmlElement firstChildElement(const std::string& tag) const;

    XmlElement firstChildElement(const std::string& tag, bool throwIfNotFound) const;

    std::vector< XmlElement > children(const std::string& tag) const;
 
    std::string textOrDefault(const std::string& defaultValue) const;

    std::string attribute(const std::string& name) const;

    bool attribute(const std::string& name, std::string* out, bool throwIfNotFound = false) const;
 
    private:
    friend class XmlDocument;
 
    explicit XmlElement(void* ticppElement) noexcept : _handle_(ticppElement) {}
 
    void* _handle_ = nullptr;   
  };

  class GUM_PUBLIC_BN XmlDocument {
    public:
    XmlDocument();
    explicit XmlDocument(const std::string& filePath);
    ~XmlDocument();
 
    XmlDocument(XmlDocument&&) noexcept;
    XmlDocument& operator=(XmlDocument&&) noexcept;
    XmlDocument(const XmlDocument&)            = delete;
    XmlDocument& operator=(const XmlDocument&) = delete;

    void parse(const std::string& content);

    void loadFile();
 
    bool noChildren() const;

    XmlElement firstChildElement(const std::string& tag) const;
 
    private:
    struct Impl;
    std::unique_ptr< Impl > _pimpl_;
  };
 
} /* namespace gum */
 
#endif   // GUM_XML_DOCUMENT_H