Refactor: move `Library`-specific functions into proper `BKE_library` file.
authorBastien Montagne <b.mont29@gmail.com>
Mon, 10 Feb 2020 16:10:17 +0000 (17:10 +0100)
committerBastien Montagne <b.mont29@gmail.com>
Mon, 10 Feb 2020 16:10:17 +0000 (17:10 +0100)
Even though we do not have much of those, this might change in the
future, and in any case having specific functions for this ID type in
generic `BKE_lib` area was really confusing.

source/blender/blenkernel/BKE_lib_id.h
source/blender/blenkernel/BKE_library.h [new file with mode: 0644]
source/blender/blenkernel/CMakeLists.txt
source/blender/blenkernel/intern/bpath.c
source/blender/blenkernel/intern/lib_id.c
source/blender/blenkernel/intern/lib_id_delete.c
source/blender/blenkernel/intern/library.c [new file with mode: 0644]
source/blender/blenloader/intern/blend_validate.c
source/blender/editors/space_outliner/outliner_draw.c
source/blender/makesrna/intern/rna_ID.c

index 2ff2644684a067714e7aea98c3c0ecc466312809..7d00e98f2396a1fd13cb106b1c249506ecba67b7 100644 (file)
@@ -182,7 +182,6 @@ void BKE_libblock_management_usercounts_clear(struct Main *bmain, void *idv);
 void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id);
 void id_lib_extern(struct ID *id);
 void id_lib_indirect_weak_link(struct ID *id);
-void BKE_library_filepath_set(struct Main *bmain, struct Library *lib, const char *filepath);
 void id_us_ensure_real(struct ID *id);
 void id_us_clear_real(struct ID *id);
 void id_us_plus_no_lib(struct ID *id);
@@ -241,8 +240,6 @@ void BKE_id_full_name_ui_prefix_get(char name[MAX_ID_FULL_NAME_UI], const struct
 
 char *BKE_id_to_unique_string_key(const struct ID *id);
 
-void BKE_library_free(struct Library *lib);
-
 void BKE_library_make_local(struct Main *bmain,
                             const struct Library *lib,
                             struct GHash *old_to_new_ids,
diff --git a/source/blender/blenkernel/BKE_library.h b/source/blender/blenkernel/BKE_library.h
new file mode 100644 (file)
index 0000000..1324e4e
--- /dev/null
@@ -0,0 +1,45 @@
+/*
+ * 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.
+ */
+#ifndef __BKE_LIBRARY_H__
+#define __BKE_LIBRARY_H__
+
+/** \file
+ * \ingroup bke
+ *
+ * API to manage `Library` data-blocks.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "BLI_compiler_attrs.h"
+
+struct Library;
+struct Main;
+
+void BKE_library_free(struct Library *lib);
+
+void BKE_library_filepath_set(struct Main *bmain, struct Library *lib, const char *filepath);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __BKE_LIBRARY_H__ */
index e2be61269f9419a29f7d418201fa54d85f6648c0..f536b8d94fc5f9ee169d130616a69e782f250200 100644 (file)
@@ -140,6 +140,7 @@ set(SRC
   intern/lib_override.c
   intern/lib_query.c
   intern/lib_remap.c
+  intern/library.c
   intern/light.c
   intern/lightprobe.c
   intern/linestyle.c
@@ -303,6 +304,7 @@ set(SRC
   BKE_lib_override.h
   BKE_lib_query.h
   BKE_lib_remap.h
+  BKE_library.h
   BKE_light.h
   BKE_lightprobe.h
   BKE_linestyle.h
index 835fd645e251830ad0859f133ea9807262fc8566..3743a340a531e73eedae45a03d23efba85736c4e 100644 (file)
@@ -67,6 +67,7 @@
 
 #include "BKE_font.h"
 #include "BKE_lib_id.h"
+#include "BKE_library.h"
 #include "BKE_main.h"
 #include "BKE_node.h"
 #include "BKE_report.h"
index 9a1ade90367a6df818d5a246e5d8f6b626a29683..d1dd325a4df700742f20b4bc5bcc2ea778554c67 100644 (file)
@@ -1532,13 +1532,6 @@ void *BKE_libblock_copy_for_localize(const ID *id)
   return idn;
 }
 
-void BKE_library_free(Library *lib)
-{
-  if (lib->packedfile) {
-    BKE_packedfile_free(lib->packedfile);
-  }
-}
-
 /* ***************** ID ************************ */
 ID *BKE_libblock_find_name(struct Main *bmain, const short type, const char *name)
 {
@@ -2504,31 +2497,6 @@ char *BKE_id_to_unique_string_key(const struct ID *id)
   }
 }
 
-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->name != filepath) {
-    BLI_strncpy(lib->name, filepath, sizeof(lib->name));
-  }
-
-  BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
-
-  /* not essential but set filepath is an absolute copy of value which
-   * is more useful if its kept in sync */
-  if (BLI_path_is_rel(lib->filepath)) {
-    /* note that the file may be unsaved, in this case, setting the
-     * filepath 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 - campbell
-     */
-    /* Never make paths relative to parent lib - reading code (blenloader) always set *all*
-     * lib->name 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, basepath);
-  }
-}
-
 void BKE_id_tag_set_atomic(ID *id, int tag)
 {
   atomic_fetch_and_or_int32(&id->tag, tag);
index fcca12a564a48397e6bee4fa3783ffb6c2c521fc..1be2a44cbb9b583eb44c14f32bfc71514202e64c 100644 (file)
@@ -78,6 +78,7 @@
 #include "BKE_lib_id.h"
 #include "BKE_lib_override.h"
 #include "BKE_lib_remap.h"
+#include "BKE_library.h"
 #include "BKE_linestyle.h"
 #include "BKE_mesh.h"
 #include "BKE_material.h"
diff --git a/source/blender/blenkernel/intern/library.c b/source/blender/blenkernel/intern/library.c
new file mode 100644 (file)
index 0000000..376d5aa
--- /dev/null
@@ -0,0 +1,75 @@
+/*
+ * 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 "BKE_lib_id.h"
+#include "BKE_library.h"
+#include "BKE_main.h"
+#include "BKE_packedFile.h"
+
+/* Unused currently. */
+// static CLG_LogRef LOG = {.identifier = "bke.library"};
+
+void BKE_library_free(Library *lib)
+{
+  if (lib->packedfile) {
+    BKE_packedfile_free(lib->packedfile);
+  }
+}
+
+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->name != filepath) {
+    BLI_strncpy(lib->name, filepath, sizeof(lib->name));
+  }
+
+  BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
+
+  /* not essential but set filepath is an absolute copy of value which
+   * is more useful if its kept in sync */
+  if (BLI_path_is_rel(lib->filepath)) {
+    /* note that the file may be unsaved, in this case, setting the
+     * filepath 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 - campbell
+     */
+    /* Never make paths relative to parent lib - reading code (blenloader) always set *all*
+     * lib->name 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, basepath);
+  }
+}
index 53bf70acb1c5db260f5024dda0a83eeccd05317f..cc4471965079d1a0f5840ede4abeb1dc1eec8391 100644 (file)
@@ -38,6 +38,7 @@
 
 #include "BKE_key.h"
 #include "BKE_lib_id.h"
+#include "BKE_library.h"
 #include "BKE_main.h"
 #include "BKE_report.h"
 
index c2b47d94af678128529eaaa777da471b985234a6..12704777b05ca4ae294d29349a1b8279135e19d2 100644 (file)
@@ -49,6 +49,7 @@
 #include "BKE_idcode.h"
 #include "BKE_layer.h"
 #include "BKE_lib_id.h"
+#include "BKE_library.h"
 #include "BKE_main.h"
 #include "BKE_modifier.h"
 #include "BKE_object.h"
index 7de6b651900cba6b464d6c791be4a6291b071f2f..8a216579c80a1a2df6e0b46101ea822eda06a981 100644 (file)
@@ -93,6 +93,7 @@ const EnumPropertyItem rna_enum_id_type_items[] = {
 #  include "BKE_lib_query.h"
 #  include "BKE_lib_override.h"
 #  include "BKE_lib_remap.h"
+#  include "BKE_library.h"
 #  include "BKE_animsys.h"
 #  include "BKE_material.h"
 #  include "BKE_global.h" /* XXX, remove me */