BKE_path_templates.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2025 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

#pragma once
 
#include <cmath>
#include <optional>
 
#include "BLI_map.hh"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_string_ref.hh"
#include "BLI_string_utils.hh"
 
#include "BKE_report.hh"
 
#include "DNA_node_types.h"
#include "DNA_scene_types.h"
 
struct bContext;
struct PointerRNA;
struct PropertyRNA;
 
namespace blender::bke::path_templates {

class VariableMap {
  blender::Map<std::string, std::string> strings_;
  blender::Map<std::string, std::string> filepaths_;
  blender::Map<std::string, int64_t> integers_;
  blender::Map<std::string, double> floats_;
 
 public:
  bool contains(blender::StringRef name) const;

  bool remove(blender::StringRef name);

  bool add_string(blender::StringRef name, blender::StringRef value);

  bool add_filepath(blender::StringRef name, blender::StringRef value);

  bool add_integer(blender::StringRef name, int64_t value);

  bool add_float(blender::StringRef name, double value);

  std::optional<blender::StringRefNull> get_string(blender::StringRef name) const;

  std::optional<blender::StringRefNull> get_filepath(blender::StringRef name) const;

  std::optional<int64_t> get_integer(blender::StringRef name) const;

  std::optional<double> get_float(blender::StringRef name) const;
 
  /* ------------------------------------------------------------------
   * Convenience methods, to aid in consistency across different uses. */

  bool add_filename_only(blender::StringRef var_name,
                         blender::StringRefNull full_path,
                         blender::StringRef fallback);

  bool add_path_up_to_file(blender::StringRef var_name,
                           blender::StringRefNull full_path,
                           blender::StringRef fallback);
};
 
enum class ErrorType {
  UNESCAPED_CURLY_BRACE,
  VARIABLE_SYNTAX,
  FORMAT_SPECIFIER,
  UNKNOWN_VARIABLE,
};
 
struct Error {
  ErrorType type;
  blender::IndexRange byte_range;
};
 
bool operator==(const Error &left, const Error &right);
 
}  // namespace blender::bke::path_templates

std::optional<blender::bke::path_templates::VariableMap> BKE_build_template_variables_for_prop(
    const bContext *C, PointerRNA *ptr, PropertyRNA *prop);

void BKE_add_template_variables_general(blender::bke::path_templates::VariableMap &variables,
                                        const ID *path_owner_id);

void BKE_add_template_variables_for_render_path(
    blender::bke::path_templates::VariableMap &variables, const Scene &scene);

void BKE_add_template_variables_for_node(blender::bke::path_templates::VariableMap &variables,
                                         const bNode &owning_node);

bool BKE_path_contains_template_syntax(blender::StringRef path);

blender::Vector<blender::bke::path_templates::Error> BKE_path_validate_template(
    blender::StringRef path, const blender::bke::path_templates::VariableMap &template_variables);

blender::Vector<blender::bke::path_templates::Error> BKE_path_apply_template(
    char *path,
    int path_maxncpy,
    const blender::bke::path_templates::VariableMap &template_variables);
std::string BKE_path_template_error_to_string(const blender::bke::path_templates::Error &error,
                                              blender::StringRef path);

void BKE_report_path_template_errors(ReportList *reports,
                                     eReportType report_type,
                                     blender::StringRef path,
                                     blender::Span<blender::bke::path_templates::Error> errors);

std::optional<std::string> BKE_path_template_format_float(blender::StringRef format_specifier,
                                                          double value);

std::optional<std::string> BKE_path_template_format_int(blender::StringRef format_specifier,
                                                        int64_t value);