e5e8db73df
The main goal of this refactor is to make BPath module use `IDTypeInfo`, and move each ID-specific part of the `foreach_path` looper into their own IDTypeInfo struct, using a new `foreach_path` callback. Additionally, following improvements/cleanups are included: * Attempt to get better, more consistent namings. ** In particular, move from `path_visitor` to more standard `foreach_path`. * Update and extend documentation. ** API doc was moved to header, according to recent discussions on this topic. * Remove `BKE_bpath_relocate_visitor` from API, this is specific callback that belongs in `lib_id.c` user code. NOTE: This commit is expected to be 100% non-behavioral-change. This implies that several potential further changes were only noted as comments (like using a more generic solution for `lib_id_library_local_paths`, addressing inconsistencies like path of packed libraries always being skipped, regardless of the `BKE_BPATH_FOREACH_PATH_SKIP_PACKED` `eBPathForeachFlag` flag value, etc.). NOTE: basic unittests were added to master already in rBdcc500e5a265093bc9cc. Reviewed By: brecht Differential Revision: https://developer.blender.org/D13381
134 lines
4.0 KiB
C
134 lines
4.0 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*
|
|
* Contains code specific to the `Library` ID type.
|
|
*/
|
|
|
|
#include "CLG_log.h"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
/* all types are needed here, in order to do memory operations */
|
|
#include "DNA_ID.h"
|
|
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BLI_blenlib.h"
|
|
|
|
#include "BLT_translation.h"
|
|
|
|
#include "BKE_bpath.h"
|
|
#include "BKE_idtype.h"
|
|
#include "BKE_lib_id.h"
|
|
#include "BKE_lib_query.h"
|
|
#include "BKE_library.h"
|
|
#include "BKE_main.h"
|
|
#include "BKE_packedFile.h"
|
|
|
|
/* Unused currently. */
|
|
// static CLG_LogRef LOG = {.identifier = "bke.library"};
|
|
|
|
static void library_free_data(ID *id)
|
|
{
|
|
Library *library = (Library *)id;
|
|
if (library->packedfile) {
|
|
BKE_packedfile_free(library->packedfile);
|
|
}
|
|
}
|
|
|
|
static void library_foreach_id(ID *id, LibraryForeachIDData *data)
|
|
{
|
|
Library *lib = (Library *)id;
|
|
BKE_LIB_FOREACHID_PROCESS_IDSUPER(data, lib->parent, IDWALK_CB_NEVER_SELF);
|
|
}
|
|
|
|
static void library_foreach_path(ID *id, BPathForeachPathData *bpath_data)
|
|
{
|
|
Library *lib = (Library *)id;
|
|
|
|
/* FIXME: Find if we should respect #BKE_BPATH_FOREACH_PATH_SKIP_PACKED here, and if not, explain
|
|
* why. */
|
|
if (lib->packedfile !=
|
|
NULL /*&& (bpath_data->flag & BKE_BPATH_FOREACH_PATH_SKIP_PACKED) != 0 */) {
|
|
return;
|
|
}
|
|
|
|
if (BKE_bpath_foreach_path_fixed_process(bpath_data, lib->filepath)) {
|
|
BKE_library_filepath_set(bpath_data->bmain, lib, lib->filepath);
|
|
}
|
|
}
|
|
|
|
IDTypeInfo IDType_ID_LI = {
|
|
.id_code = ID_LI,
|
|
.id_filter = 0,
|
|
.main_listbase_index = INDEX_ID_LI,
|
|
.struct_size = sizeof(Library),
|
|
.name = "Library",
|
|
.name_plural = "libraries",
|
|
.translation_context = BLT_I18NCONTEXT_ID_LIBRARY,
|
|
.flags = IDTYPE_FLAGS_NO_COPY | IDTYPE_FLAGS_NO_LIBLINKING | IDTYPE_FLAGS_NO_ANIMDATA,
|
|
.asset_type_info = NULL,
|
|
|
|
.init_data = NULL,
|
|
.copy_data = NULL,
|
|
.free_data = library_free_data,
|
|
.make_local = NULL,
|
|
.foreach_id = library_foreach_id,
|
|
.foreach_cache = NULL,
|
|
.foreach_path = library_foreach_path,
|
|
.owner_get = NULL,
|
|
|
|
.blend_write = NULL,
|
|
.blend_read_data = NULL,
|
|
.blend_read_lib = NULL,
|
|
.blend_read_expand = NULL,
|
|
|
|
.blend_read_undo_preserve = NULL,
|
|
|
|
.lib_override_apply_post = NULL,
|
|
};
|
|
|
|
void BKE_library_filepath_set(Main *bmain, Library *lib, const char *filepath)
|
|
{
|
|
/* in some cases this is used to update the absolute path from the
|
|
* relative */
|
|
if (lib->filepath != filepath) {
|
|
BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
|
|
}
|
|
|
|
BLI_strncpy(lib->filepath_abs, filepath, sizeof(lib->filepath_abs));
|
|
|
|
/* Not essential but set `filepath_abs` is an absolute copy of value which
|
|
* is more useful if its kept in sync. */
|
|
if (BLI_path_is_rel(lib->filepath_abs)) {
|
|
/* NOTE(campbell): the file may be unsaved, in this case, setting the
|
|
* `filepath_abs` on an indirectly linked path is not allowed from the
|
|
* outliner, and its not really supported but allow from here for now
|
|
* since making local could cause this to be directly linked.
|
|
*/
|
|
/* Never make paths relative to parent lib - reading code (blenloader) always set *all*
|
|
* `lib->filepath` relative to current main, not to their parent for indirectly linked ones. */
|
|
const char *basepath = BKE_main_blendfile_path(bmain);
|
|
BLI_path_abs(lib->filepath_abs, basepath);
|
|
}
|
|
}
|