AliasProcessor.h

Go to the documentation of this file.

// Copyright 2015 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_AliasProcessor_h_GUID_9C10FB5E_F8B9_44BB_BCF4_9E50FFBFA1C9
#define INCLUDED_AliasProcessor_h_GUID_9C10FB5E_F8B9_44BB_BCF4_9E50FFBFA1C9

// Internal Includes
#include <osvr/Common/Export.h>
#include <osvr/Common/PathElementTypes_fwd.h>
#include <osvr/Common/PathNode_fwd.h>

// Library/third-party includes
#include <json/value.h>

// Standard includes
// - none

namespace osvr {
namespace common {
    namespace detail {
        struct AliasProcessorOptions {
            bool permitRelativePath = false;
            bool permitRelativeSource = false;
            bool permitWildcard = false;
            AliasPriority defaultPriority = ALIASPRIORITY_AUTOMATIC;
        };
    } // namespace detail

    OSVR_COMMON_EXPORT Json::Value convertRouteToAlias(Json::Value const &val);

    OSVR_COMMON_EXPORT Json::Value
    createJSONAlias(std::string const &path, Json::Value const &destination);

    OSVR_COMMON_EXPORT Json::Value
        applyPriorityToAlias(Json::Value const &alias, AliasPriority priority);

    class AliasProcessor {
      public:
        AliasProcessor &enableRelativePath() {
            m_opts.permitRelativePath = true;
            return *this;
        }

        AliasProcessor &enableRelativeSource() {
            m_opts.permitRelativeSource = true;
            return *this;
        }

        AliasProcessor &enableWildcard() {
            m_opts.permitWildcard = true;
            return *this;
        }

        AliasProcessor &setDefaultPriority(AliasPriority prio) {
            m_opts.defaultPriority = prio;
            return *this;
        }

        OSVR_COMMON_EXPORT bool process(PathNode &node, Json::Value const &val);
      private:
        detail::AliasProcessorOptions m_opts;
    };
} // namespace common
} // namespace osvr
#endif // INCLUDED_AliasProcessor_h_GUID_9C10FB5E_F8B9_44BB_BCF4_9E50FFBFA1C9