BKE_bpath.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
/* TODO: Make this module handle a bit more safely string length, instead of assuming buffers are
 * FILE_MAX length etc. */
 
#pragma once
 
#include "BLI_utildefines.h"
 
struct ID;
struct Main;
struct ReportList;
 
enum eBPathForeachFlag {
  /* Flags controlling the behavior of the generic BPath API. */
  BKE_BPATH_FOREACH_PATH_ABSOLUTE = (1 << 0),
  BKE_BPATH_FOREACH_PATH_SKIP_LINKED = (1 << 1),
  BKE_BPATH_FOREACH_PATH_SKIP_PACKED = (1 << 2),
  BKE_BPATH_FOREACH_PATH_RESOLVE_TOKEN = (1 << 3),
  /* Skip weak reference paths. Those paths are typically 'nice to have' extra information, but are
   * not used as actual source of data by the current .blend file.
   *
   * NOTE: Currently this only concerns the weak reference to a library file stored in
   * `ID::library_weak_reference`. */
  BKE_BPATH_TRAVERSE_SKIP_WEAK_REFERENCES = (1 << 5),
 
  BKE_BPATH_FOREACH_PATH_SKIP_MULTIFILE = (1 << 8),
  BKE_BPATH_FOREACH_PATH_RELOAD_EDITED = (1 << 9),
};
ENUM_OPERATORS(eBPathForeachFlag, BKE_BPATH_FOREACH_PATH_RELOAD_EDITED)
 
struct BPathForeachPathData;
 
using BPathForeachPathFunctionCallback = bool (*)(BPathForeachPathData *bpath_data,
                                                  char *path_dst,
                                                  size_t path_dst_maxncpy,
                                                  const char *path_src);
 
struct BPathForeachPathData {
  Main *bmain;
 
  BPathForeachPathFunctionCallback callback_function;
  eBPathForeachFlag flag;
 
  void *user_data;
 
  /* 'Private' data, caller don't need to set those. */
 
  const char *absolute_base_path;
 
  ID *owner_id;
 
  bool is_path_modified;
};
 
void BKE_bpath_foreach_path_id(BPathForeachPathData *bpath_data, ID *id);
 
void BKE_bpath_foreach_path_main(BPathForeachPathData *bpath_data);
 
/* TODO: Investigate using macros around those calls to check a bit better about actual
 * strings/buffers length (e,g, with static asserts). */
 
bool BKE_bpath_foreach_path_fixed_process(BPathForeachPathData *bpath_data,
                                          char *path,
                                          size_t path_maxncpy);
 
bool BKE_bpath_foreach_path_dirfile_fixed_process(BPathForeachPathData *bpath_data,
                                                  char *path_dir,
                                                  size_t path_dir_maxncpy,
                                                  char *path_file,
                                                  size_t path_file_maxncpy);
 
bool BKE_bpath_foreach_path_allocated_process(BPathForeachPathData *bpath_data, char **path);
 
void BKE_bpath_missing_files_check(Main *bmain, ReportList *reports);
 
struct BPathSummary {
  int count_total = 0;
  int count_changed = 0;
  int count_failed = 0;
};
 
void BKE_bpath_summary_report(const BPathSummary &summary, ReportList *reports);
 
void BKE_bpath_missing_files_find(Main *bmain,
                                  const char *searchpath,
                                  ReportList *reports,
                                  bool find_all);
 
void BKE_bpath_relative_rebase(Main *bmain,
                               const char *basedir_src,
                               const char *basedir_dst,
                               ReportList *reports,
                               BPathSummary *r_summary = nullptr);
 
void BKE_bpath_relative_convert(Main *bmain,
                                const char *basedir,
                                ReportList *reports,
                                BPathSummary *r_summary = nullptr);
 
void BKE_bpath_absolute_convert(Main *bmain,
                                const char *basedir,
                                ReportList *reports,
                                BPathSummary *r_summary = nullptr);
 
void *BKE_bpath_list_backup(Main *bmain, eBPathForeachFlag flag);
 
void BKE_bpath_list_restore(Main *bmain, eBPathForeachFlag flag, void *path_list_handle);
 
void BKE_bpath_list_free(void *path_list_handle);