path.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
#ifndef FABLE_SCHEMA_PATH_HPP_
#define FABLE_SCHEMA_PATH_HPP_

#include <limits>   // for numeric_limits<>
#include <string>   // for string
#include <utility>  // for move

#include <boost/filesystem/path.hpp>  // for path

#include <fable/schema/interface.hpp>  // for Base<>

namespace fable {

// Forward declarations:
class Environment;  // from <fable/environment.hpp>

namespace schema {

class Path : public Base<Path> {
 public:  // Types and Constructors
  using Type = boost::filesystem::path;

  enum class State {
    Any,         
    Absent,      
    Exists,      
    Executable,  
    FileExists,  
    DirExists,   
    NotFile,     
    NotDir,      
  };

  Path(Type* ptr, std::string&& desc) : Base(JsonType::string, std::move(desc)), ptr_(ptr) {}

 public:  // Special
  State state() const { return req_state_; }

  Path state(State s) && {
    req_state_ = s;
    return std::move(*this);
  }
  void set_state(State s) { req_state_ = s; }

  Path absent() && { return std::move(*this).state(State::Absent); }
  Path exists() && { return std::move(*this).state(State::Exists); }
  Path executable() && { return std::move(*this).state(State::Executable); }
  Path file_exists() && { return std::move(*this).state(State::FileExists); }
  Path dir_exists() && { return std::move(*this).state(State::DirExists); }
  Path not_file() && { return std::move(*this).state(State::NotFile); }
  Path not_dir() && { return std::move(*this).state(State::NotDir); }

  Path not_empty() && {
    set_min_length(1);
    return std::move(*this);
  }

  Path absolute() && {
    req_abs_ = true;
    return std::move(*this);
  }

  bool resolve() const { return resolve_; }

  Path resolve(bool value) && {
    resolve_ = value;
    return std::move(*this);
  }
  void set_resolve(bool value) { resolve_ = value; }

  bool normalize() const { return normalize_; }
  Path normalize(bool value) && {
    normalize_ = value;
    return std::move(*this);
  }
  void set_normalize(bool value) { normalize_ = value; }

  bool interpolate() const { return interpolate_; }
  void set_interpolate(bool value) { interpolate_ = value; }
  Path interpolate(bool value) && {
    interpolate_ = value;
    return std::move(*this);
  }

  Environment* environment() const { return env_; }
  void set_environment(Environment* env) { env_ = env; }
  Path environment(Environment* env) && {
    env_ = env;
    return std::move(*this);
  }

  size_t min_length() const { return min_length_; }
  void set_min_length(size_t value) { min_length_ = value; }
  Path min_length(size_t value) && {
    min_length_ = value;
    return std::move(*this);
  }

  size_t max_length() const { return max_length_; }
  void set_max_length(size_t value) { max_length_ = value; }
  Path max_length(size_t value) && {
    max_length_ = value;
    return std::move(*this);
  }

  const std::string& pattern() const { return pattern_; }
  void set_pattern(const std::string& value) { pattern_ = value; }
  Path pattern(const std::string& value) && {
    pattern_ = value;
    return std::move(*this);
  }

 public:  // Overrides
  Json json_schema() const override;
  void validate(const Conf& c) const override;

  using Interface::to_json;
  void to_json(Json& j) const override {
    assert(ptr_ != nullptr);
    j = serialize(*ptr_);
  }

  void from_conf(const Conf& c) override {
    assert(ptr_ != nullptr);
    *ptr_ = deserialize(c);
  }

  Json serialize(const Type& x) const { return x.native(); }

  Type deserialize(const Conf& c) const;

  void reset_ptr() override { ptr_ = nullptr; }

 private:
  Type resolve_path(const Conf&, const Type&) const;

 private:
  State req_state_{State::Any};
  bool req_abs_{false};
  bool resolve_{true};
  bool normalize_{false};
  bool interpolate_{false};
  size_t min_length_{0};
  size_t max_length_{std::numeric_limits<size_t>::max()};
  std::string pattern_{};
  Environment* env_{nullptr};
  Type* ptr_{nullptr};
};

inline Path make_schema(boost::filesystem::path* ptr, std::string&& desc) {
  return Path(ptr, std::move(desc));
}

}  // namespace schema
}  // namespace fable

namespace nlohmann {

template <>
struct adl_serializer<boost::filesystem::path> {
  static void to_json(json& j, const boost::filesystem::path& p) { j = p.native(); }
  static void from_json(const json& j, boost::filesystem::path& p) { p = j.get<std::string>(); }
};

}  // namespace nlohmann

#endif  // FABLE_SCHEMA_PATH_HPP_