string.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
 
#include <limits>   // for numeric_limits<>
#include <string>   // for string
#include <utility>  // for move
#include <vector>   // for vector<>
 
#include <fable/fable_fwd.hpp>         // for Environment
#include <fable/schema/interface.hpp>  // for Base<>
 
namespace fable::schema {
 
constexpr auto FABLE_REGEX_C_IDENTIFIER = "^[a-zA-Z_][a-zA-Z0-9_]*$";
 
class String : public Base<String> {
 public:  // Types and Constructors
  using Type = std::string;
 
  String(Type* ptr, std::string desc) : Base(JsonType::string, std::move(desc)), ptr_(ptr) {}
 
 public:  // Special
  String not_empty() &&;
 
  [[nodiscard]] size_t min_length() const;
 
  String min_length(size_t value) &&;
 
  void set_min_length(size_t value);
 
  [[nodiscard]] size_t max_length() const;
 
  String max_length(size_t value) &&;
 
  void set_max_length(size_t value);
 
  [[nodiscard]] const std::string& pattern() const;
 
  String pattern(const std::string& value) &&;
 
  void set_pattern(const std::string& value);
 
  String c_identifier() &&;
 
  [[nodiscard]] bool interpolate() const;
 
  String interpolate(bool value) &&;
 
  void set_interpolate(bool value);
 
  [[nodiscard]] Environment* environment() const;
 
  String environment(Environment* env) &&;
 
  void set_environment(Environment* env);
 
  [[nodiscard]] const std::vector<std::string>& enum_of() const;
 
  String enum_of(std::vector<std::string>&& init);
 
  void set_enum_of(std::vector<std::string>&& init);
 
 public:  // Overrides
  [[nodiscard]] Json json_schema() const override;
  bool validate(const Conf& c, std::optional<SchemaError>& err) const override;
  using Interface::to_json;
  void to_json(Json& j) const override;
  void from_conf(const Conf& c) override;
  [[nodiscard]] Json serialize(const Type& x) const;
  [[nodiscard]] Type deserialize(const Conf& c) const;
  void serialize_into(Json& j, const Type& x) const { j = serialize(x); }
  void deserialize_into(const Conf& c, Type& x) const { x = deserialize(c); }
  void reset_ptr() override;
 
 private:
  bool interpolate_{false};
  size_t min_length_{0};
  size_t max_length_{std::numeric_limits<size_t>::max()};
  std::string pattern_{};
  std::vector<std::string> enum_{};
  Environment* env_{nullptr};
  Type* ptr_{nullptr};
};
 
inline String make_schema(std::string* ptr, std::string desc) {
  return {ptr, std::move(desc)};
}
 
}  // namespace fable::schema