diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_library.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_library.h | 101 |
1 files changed, 58 insertions, 43 deletions
diff --git a/source/blender/blenkernel/BKE_library.h b/source/blender/blenkernel/BKE_library.h index 493873bc840..db4592b0618 100644 --- a/source/blender/blenkernel/BKE_library.h +++ b/source/blender/blenkernel/BKE_library.h @@ -30,6 +30,24 @@ extern "C" { #include "BLI_compiler_attrs.h" +/** + * Naming: BKE_id_ vs BKE_libblock_ + * + * WARNING: description below is ideal goal, current status of naming does not yet + * fully follow it (this is WIP). + * + * BKE_id_ should be used for rather high-level operations, that involve Main database and + * relations with other IDs, and can be considered as 'safe' (as in, in themselves, they leave + * affected IDs/Main in a consistent status). + * + * BKE_libblock_ should be used for lower level operations, that perform some parts of BKE_id_ ones, + * but will generally not ensure caller that affected data is in a consistent state + * by their own execution alone. + * + * Consequently, external code should not typically use BKE_libblock_ functions, + * except in some specific cases requiring advanced (and potentially dangerous) handling. + */ + struct BlendThumbnail; struct GHash; struct ID; @@ -44,9 +62,13 @@ struct wmWindowManager; size_t BKE_libblock_get_alloc_info(short type, const char **name); void *BKE_libblock_alloc_notest(short type) ATTR_WARN_UNUSED_RESULT; -void *BKE_libblock_alloc(struct Main *bmain, short type, const char *name, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1); +void *BKE_libblock_alloc(struct Main *bmain, short type, const char *name, const int flag) ATTR_WARN_UNUSED_RESULT; void BKE_libblock_init_empty(struct ID *id) ATTR_NONNULL(1); +void *BKE_id_new(struct Main *bmain, const short type, const char *name); +void *BKE_id_new_nomain(const short type, const char *name); + + /** * New ID creation/copying options. */ @@ -63,19 +85,27 @@ enum { LIB_ID_CREATE_NO_DEG_TAG = 1 << 8, /* Do not tag new ID for update in depsgraph. */ - /* Specific options to some ID types or usages, may be ignored by unrelated ID copying functions. */ + /*** Specific options to some ID types or usages. ***/ + /* May be ignored by unrelated ID copying functions. */ LIB_ID_COPY_NO_PROXY_CLEAR = 1 << 16, /* Object only, needed by make_local code. */ LIB_ID_COPY_NO_PREVIEW = 1 << 17, /* Do not copy preview data, when supported. */ LIB_ID_COPY_CACHES = 1 << 18, /* Copy runtime data caches. */ - /* XXX TODO Do we want to keep that? would rather try to get rid of it... */ - LIB_ID_COPY_ACTIONS = 1 << 19, /* EXCEPTION! Deep-copy actions used by animdata of copied ID. */ - LIB_ID_COPY_KEEP_LIB = 1 << 20, /* Keep the library pointer when copying datablock outside of bmain. */ + LIB_ID_COPY_NO_ANIMDATA = 1 << 19, /* Don't copy id->adt, used by ID datablock localization routines. */ + LIB_ID_COPY_CD_REFERENCE = 1 << 20, /* Mesh: Reference CD data layers instead of doing real copy. */ + + /*** XXX Hackish/not-so-nice specific behaviors needed for some corner cases. ***/ + /* Ideally we should not have those, but we need them for now... */ + LIB_ID_COPY_ACTIONS = 1 << 24, /* EXCEPTION! Deep-copy actions used by animdata of copied ID. */ + LIB_ID_COPY_KEEP_LIB = 1 << 25, /* Keep the library pointer when copying datablock outside of bmain. */ + LIB_ID_COPY_SHAPEKEY = 1 << 26, /* EXCEPTION! Deep-copy shapekeys used by copied obdata ID. */ }; void BKE_libblock_copy_ex(struct Main *bmain, const struct ID *id, struct ID **r_newid, const int flag); void *BKE_libblock_copy(struct Main *bmain, const struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); /* "Deprecated" old API. */ void *BKE_libblock_copy_nolib(const struct ID *id, const bool do_action) ATTR_NONNULL(); +/* Special version. sued by datablock localization. */ +void *BKE_libblock_copy_for_localize(const struct ID *id); void BKE_libblock_rename(struct Main *bmain, struct ID *id, const char *name) ATTR_NONNULL(); void BLI_libblock_ensure_unique_name(struct Main *bmain, const char *name) ATTR_NONNULL(); @@ -102,13 +132,16 @@ enum { LIB_ID_FREE_NO_UI_USER = 1 << 9, /* Do not attempt to remove freed ID from UI data/notifiers/... */ }; +void BKE_libblock_free_datablock(struct ID *id, const int flag) ATTR_NONNULL(); +void BKE_libblock_free_data(struct ID *id, const bool do_id_user) ATTR_NONNULL(); + void BKE_id_free_ex(struct Main *bmain, void *idv, int flag, const bool use_flag_from_idtag); void BKE_id_free(struct Main *bmain, void *idv); -/* Those three naming are bad actually, should be BKE_id_free... (since it goes beyond mere datablock). */ -/* "Deprecated" old API */ -void BKE_libblock_free_ex(struct Main *bmain, void *idv, const bool do_id_user, const bool do_ui_user) ATTR_NONNULL(); -void BKE_libblock_free(struct Main *bmain, void *idv) ATTR_NONNULL(); -void BKE_libblock_free_us(struct Main *bmain, void *idv) ATTR_NONNULL(); + +void BKE_id_free_us(struct Main *bmain, void *idv) ATTR_NONNULL(); + +void BKE_id_delete(struct Main *bmain, void *idv) ATTR_NONNULL(); +void BKE_id_multi_tagged_delete(struct Main *bmain) ATTR_NONNULL(); void BKE_libblock_management_main_add(struct Main *bmain, void *idv); void BKE_libblock_management_main_remove(struct Main *bmain, void *idv); @@ -116,12 +149,6 @@ void BKE_libblock_management_main_remove(struct Main *bmain, void *idv); void BKE_libblock_management_usercounts_set(struct Main *bmain, void *idv); void BKE_libblock_management_usercounts_clear(struct Main *bmain, void *idv); -/* TODO should be named "BKE_id_delete()". */ -void BKE_libblock_delete(struct Main *bmain, void *idv) ATTR_NONNULL(); - -void BKE_libblock_free_datablock(struct ID *id, const int flag) ATTR_NONNULL(); -void BKE_libblock_free_data(struct ID *id, const bool do_id_user) ATTR_NONNULL(); - void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id); void id_lib_extern(struct ID *id); void BKE_library_filepath_set(struct Main *bmain, struct Library *lib, const char *filepath); @@ -139,6 +166,7 @@ bool id_make_local(struct Main *bmain, struct ID *id, const bool test, const boo bool id_single_user(struct bContext *C, struct ID *id, struct PointerRNA *ptr, struct PropertyRNA *prop); bool id_copy(struct Main *bmain, const struct ID *id, struct ID **newid, bool test); bool BKE_id_copy_ex(struct Main *bmain, const struct ID *id, struct ID **r_newid, const int flag, const bool test); +void BKE_id_swap(struct Main *bmain, struct ID *id_a, struct ID *id_b); void id_sort_by_name(struct ListBase *lb, struct ID *id); void BKE_id_expand_local(struct Main *bmain, struct ID *id); void BKE_id_copy_ensure_local(struct Main *bmain, const struct ID *old_id, struct ID *new_id); @@ -147,30 +175,7 @@ bool new_id(struct ListBase *lb, struct ID *id, const char *name) ATTR_NONNULL(1 void id_clear_lib_data(struct Main *bmain, struct ID *id); void id_clear_lib_data_ex(struct Main *bmain, struct ID *id, const bool id_in_mainlist); -struct ListBase *which_libbase(struct Main *mainlib, short type); - -#define MAX_LIBARRAY 35 -int set_listbasepointers(struct Main *main, struct ListBase *lb[MAX_LIBARRAY]); - -/* Main API */ -struct Main *BKE_main_new(void); -void BKE_main_free(struct Main *mainvar); - -void BKE_main_lock(struct Main *bmain); -void BKE_main_unlock(struct Main *bmain); - -void BKE_main_relations_create(struct Main *bmain); -void BKE_main_relations_free(struct Main *bmain); - -struct BlendThumbnail *BKE_main_thumbnail_from_imbuf(struct Main *bmain, struct ImBuf *img); -struct ImBuf *BKE_main_thumbnail_to_imbuf(struct Main *bmain, struct BlendThumbnail *data); -void BKE_main_thumbnail_create(struct Main *bmain); - -const char *BKE_main_blendfile_path(const struct Main *bmain) - ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL; -const char *BKE_main_blendfile_path_from_global(void) - ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL; - +/* Affect whole Main database. */ void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value); void BKE_main_id_tag_listbase(struct ListBase *lb, const int tag, const bool value); void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value); @@ -182,8 +187,15 @@ void BKE_main_id_clear_newpoins(struct Main *bmain); void BKE_main_lib_objects_recalc_all(struct Main *bmain); -/* (MAX_ID_NAME - 2) + 3 */ -void BKE_id_ui_prefix(char name[66 + 1], const struct ID *id); +/* Only for repairing files via versioning, avoid for general use. */ +void BKE_main_id_repair_duplicate_names_listbase(struct ListBase *lb); + +#define MAX_ID_FULL_NAME (64 + 64 + 3 + 1) /* 64 is MAX_ID_NAME - 2 */ +#define MAX_ID_FULL_NAME_UI (MAX_ID_FULL_NAME + 3) /* Adds 'keycode' two letters at begining. */ +void BKE_id_full_name_get(char name[MAX_ID_FULL_NAME], const struct ID *id); +void BKE_id_full_name_ui_prefix_get(char name[MAX_ID_FULL_NAME_UI], const struct ID *id); + +char *BKE_id_to_unique_string_key(const struct ID *id); void BKE_library_free(struct Library *lib); @@ -194,7 +206,10 @@ void BKE_library_make_local( void BKE_id_tag_set_atomic(struct ID *id, int tag); void BKE_id_tag_clear_atomic(struct ID *id, int tag); -bool BKE_id_is_in_gobal_main(struct ID *id); +bool BKE_id_is_in_global_main(struct ID *id); + +void BKE_id_ordered_list(struct ListBase *ordered_lb, const struct ListBase *lb); +void BKE_id_reorder(const struct ListBase *lb, struct ID *id, struct ID *relative, bool after); /* use when "" is given to new_id() */ #define ID_FALLBACK_NAME N_("Untitled") |