PathTree.h

Go to the documentation of this file.

// Copyright 2014 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_PathTree_h_GUID_8C6C691A_AAB1_4586_64DD_BD3F870C9071
#define INCLUDED_PathTree_h_GUID_8C6C691A_AAB1_4586_64DD_BD3F870C9071

// Internal Includes
#include <osvr/Common/Export.h>
#include <osvr/Common/PathNode_fwd.h>
#include <osvr/Common/PathTree_fwd.h> // IWYU pragma: export

// Library/third-party includes
#include <boost/noncopyable.hpp>

// Standard includes
#include <string>

namespace osvr {
namespace common {
    class PathTree : boost::noncopyable {
      public:
        OSVR_COMMON_EXPORT PathTree();

        template <typename F> void visitTree(F &functor) { functor(*m_root); }

        template <typename F> void visitConstTree(F &functor) const {
            functor(const_cast<PathNode const &>(*m_root));
        }

        OSVR_COMMON_EXPORT PathNode &getNodeByPath(std::string const &path);

        OSVR_COMMON_EXPORT PathNode const &
        getNodeByPath(std::string const &path) const;

        OSVR_COMMON_EXPORT PathNode &
        getNodeByPath(std::string const &path,
                      PathElement const &finalComponentDefault);

        OSVR_COMMON_EXPORT void reset();

        PathNode &getRoot() { return *m_root; }

        PathNode const &getRoot() const { return *m_root; }

      private:
        PathNodePtr m_root;
    };

    OSVR_COMMON_EXPORT bool
    addAlias(PathNode &node, std::string const &source,
             AliasPriority priority = ALIASPRIORITY_MANUAL);

    OSVR_COMMON_EXPORT bool
    addAliasFromRoute(PathNode &node, std::string const &route,
                      AliasPriority priority = ALIASPRIORITY_MANUAL);

    bool addAliasFromSourceAndRelativeDest(
        PathNode &node, std::string const &source, std::string const &dest,
        AliasPriority priority = ALIASPRIORITY_MANUAL);

    bool addArticulation(PathNode &node, std::string const &source,
                         std::string const &dest);

    bool isPathAbsolute(std::string const &source);

    OSVR_COMMON_EXPORT void clonePathTree(PathTree const &src, PathTree &dest);

} // namespace common
} // namespace osvr

#endif // INCLUDED_PathTree_h_GUID_8C6C691A_AAB1_4586_64DD_BD3F870C9071