path.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5cpp.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the
// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
// Boston, MA  02110-1301 USA
// ===========================================================================
//
// Authors:
//    Eugen Wintersberger <eugen.wintersberger@desy.de>
//    Martin Shetty <martin.shetty@esss.se>
// Created on: Aug 24, 2017
//
#pragma once
 
#include <list>
#include <string>
#include <h5cpp/core/windows.hpp>
 
namespace hdf5 {
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpadded"
#endif
class DLL_EXPORT Path
{
  public:
    using value_type = std::string;
    using iterator = std::list<value_type>::iterator;
    using const_iterator = std::list<value_type>::const_iterator;
    using reverse_iterator = std::list<value_type>::reverse_iterator;
    using const_reverse_iterator= std::list<value_type>::const_reverse_iterator;
 
    Path();
 
    Path(const std::string &str);
    Path(const char *str);
 
    Path(const_iterator first_element, const_iterator last_element);
 
    explicit operator std::string() const
    {
      return to_string();
    }
 
    size_t size() const noexcept;
 
    const_iterator begin() const;
    const_iterator end() const;
 
 
    const_reverse_iterator rbegin() const;
    const_reverse_iterator rend() const;
 
    bool absolute() const noexcept;
 
    void absolute(bool value) noexcept;
 
    bool is_root() const;
 
    bool is_name() const;
 
    std::string name() const;
 
    Path parent() const;
 
    void append(const Path& p);
 
    Path relative_to(const Path& base) const;
 
    Path& operator+=(const Path &other);
 
#ifndef _DOXYGEN_ /* workaround for the #613 breathe bug */
    DLL_EXPORT friend bool operator==(const Path &lhs, const Path &rhs);
    DLL_EXPORT friend Path common_base(const Path& lhs, const Path& rhs);
#endif /* DOXYGEN */
  private:
    bool absolute_;
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4251)
#endif
    std::list<std::string> link_names_;
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
    void from_string(const std::string &str);
    std::string to_string() const;
 
    void sanitize();
};
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
#ifdef _DOXYGEN_ /* workaround for the #613 breathe bug */
    DLL_EXPORT friend bool operator==(const Path &lhs, const Path &rhs);
    DLL_EXPORT friend Path common_base(const Path& lhs, const Path& rhs);
#endif /* DOXYGEN */
 
DLL_EXPORT bool operator!=(const Path &lhs, const Path &rhs);
 
DLL_EXPORT Path operator+(const Path &lhs,const Path &rhs);
 
 
DLL_EXPORT std::ostream &operator<<(std::ostream &stream,const Path &path);
 
} // namespace hdf5