resource_keys.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once

 
#include "reusex/core/ProjectDB.hpp"
#include "reusex/core/materialepas_traits.hpp"
 
#include <optional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
namespace reusex::core {

enum class KeySource { builtin, leksikon, column };
enum class KeyScope { type, part };
std::string_view to_string(KeyScope); // "type" | "part"
 
inline constexpr std::string_view kBuiltinCategory = "Kortlægning";
inline constexpr std::string_view kColumnCategory = "Egne felter";
 
struct ResourceKey {
  std::string id; 
  std::string label;
  std::string category;
  KeyScope scope = KeyScope::part;
  std::string data_type = "text";
  std::string unit;                 
  std::vector<std::string> options; 
  bool editable = true;
  KeySource source = KeySource::builtin;
  std::string field;
  bool integer = false;
};

struct LeksikonField {
  std::string guid; 
  std::string field_name; 
  std::string category;   
  traits::PropertyType type = traits::PropertyType::String;
};

std::vector<LeksikonField> leksikon_fields();
std::vector<std::string> leksikon_categories();
 
std::vector<ResourceKey> builtin_keys(); 
std::vector<ResourceKey> leksikon_keys();
ResourceKey column_key(const ProjectDB::PropertyDefinition &def);
std::vector<ResourceKey>
key_catalogue(const std::vector<ProjectDB::PropertyDefinition> &columns);
std::vector<ResourceKey> key_catalogue(const ProjectDB &db);
const ResourceKey *find_key(const std::vector<ResourceKey> &catalogue,
                            std::string_view id);

class KeyValueError : public std::invalid_argument {
    public:
  KeyValueError(std::string key, const std::string &message)
      : std::invalid_argument(message), key_(std::move(key)) {}
  const std::string &key() const noexcept { return key_; }
 
    private:
  std::string key_;
};

std::optional<double> parse_number(std::string_view text);
std::string format_number(double v);

std::optional<std::string>
normalise_value(const ResourceKey &key,
                const std::optional<std::string> &value);
 
} // namespace reusex::core