Blender V5.3
asset.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10#include <utility>
11
12#include "DNA_ID.h"
13
14#include "BLI_listbase.hh"
15#include "BLI_string.hh"
16#include "BLI_string_ref.hh"
17#include "BLI_string_utf8.hh"
18#include "BLI_string_utils.hh"
19#include "BLI_uuid.hh"
20
21#include "BKE_asset.hh"
22#include "BKE_idprop.hh"
23#include "BKE_preview_image.hh"
24
25#include "BLO_read_write.hh"
26
27#include "MEM_guardedalloc.h"
28
29namespace blender {
30
32{
33 return MEM_new<AssetMetaData>(__func__);
34}
35
37{
38 MEM_delete(*asset_data);
39 *asset_data = nullptr;
40}
41
43{
44 return MEM_new<AssetMetaData>(__func__, *source);
45}
46
47AssetMetaData::AssetMetaData(const AssetMetaData &other)
48 : local_type_info(other.local_type_info),
49 properties(nullptr),
50 catalog_id(other.catalog_id),
51 active_tag(other.active_tag),
52 tot_tags(other.tot_tags),
53 flag(other.flag),
54 preferred_import_method(other.preferred_import_method)
55{
56 if (other.properties) {
57 properties = IDP_CopyProperty(other.properties);
58 }
59
60 STRNCPY(catalog_simple_name, other.catalog_simple_name);
61
62 author = BLI_strdup_null(other.author);
63 description = BLI_strdup_null(other.description);
64 copyright = BLI_strdup_null(other.copyright);
65 license = BLI_strdup_null(other.license);
66
67 BLI_duplicatelist(&tags, &other.tags);
68}
69
70AssetMetaData::AssetMetaData(AssetMetaData &&other)
71 : local_type_info(other.local_type_info),
72 properties(std::exchange(other.properties, nullptr)),
73 catalog_id(other.catalog_id),
74 author(std::exchange(other.author, nullptr)),
75 description(std::exchange(other.description, nullptr)),
76 copyright(std::exchange(other.copyright, nullptr)),
77 license(std::exchange(other.license, nullptr)),
78 active_tag(other.active_tag),
79 tot_tags(other.tot_tags),
80 flag(other.flag),
81 preferred_import_method(other.preferred_import_method)
82
83{
84 STRNCPY(catalog_simple_name, other.catalog_simple_name);
85 tags = other.tags;
86 other.tags.clear_no_delete();
87}
88
89AssetMetaData::~AssetMetaData()
90{
91 if (properties) {
92 IDP_FreeProperty(properties);
93 }
94 MEM_SAFE_DELETE(author);
95 MEM_SAFE_DELETE(description);
96 MEM_SAFE_DELETE(copyright);
97 MEM_SAFE_DELETE(license);
98 tags.free_no_destruct();
99}
100
101static AssetTag *asset_metadata_tag_add(AssetMetaData *asset_data, const char *const name)
102{
103 AssetTag *tag = MEM_new<AssetTag>(__func__);
104 STRNCPY_UTF8(tag->name, name);
105
106 BLI_addtail(&asset_data->tags, tag);
107 asset_data->tot_tags++;
108 /* Invariant! */
109 BLI_assert(asset_data->tags.count() == asset_data->tot_tags);
110
111 return tag;
112}
113
114AssetTag *BKE_asset_metadata_tag_add(AssetMetaData *asset_data, const char *name)
115{
116 AssetTag *tag = asset_metadata_tag_add(asset_data, name);
117 BLI_uniquename(&asset_data->tags, tag, name, '.', offsetof(AssetTag, name), sizeof(tag->name));
118 return tag;
119}
120
122{
123 AssetTagEnsureResult result = {nullptr};
124 if (!name[0]) {
125 return result;
126 }
127
128 AssetTag *tag = static_cast<AssetTag *>(
129 BLI_findstring(&asset_data->tags, name, offsetof(AssetTag, name)));
130
131 if (tag) {
132 result.tag = tag;
133 result.is_new = false;
134 return result;
135 }
136
137 tag = asset_metadata_tag_add(asset_data, name);
138
139 result.tag = tag;
140 result.is_new = true;
141 return result;
142}
143
145{
146 BLI_assert(BLI_findindex(&asset_data->tags, tag) >= 0);
147 BLI_freelinkN(&asset_data->tags, tag);
148 asset_data->tot_tags--;
149 /* Invariant! */
150 BLI_assert(asset_data->tags.count() == asset_data->tot_tags);
151}
152
157
159{
160 asset_data->catalog_id = BLI_uuid_nil();
161 asset_data->catalog_simple_name[0] = '\0';
162}
163
165 const bUUID catalog_id,
166 const char *catalog_simple_name)
167{
168 asset_data->catalog_id = catalog_id;
169 StringRef(catalog_simple_name).trim().copy_utf8_truncated(asset_data->catalog_simple_name);
170}
171
173{
174 using namespace blender::bke;
175 if (!asset_data->properties) {
176 asset_data->properties = idprop::create_group("AssetMetaData.properties").release();
177 }
178 /* Important: The property may already exist. For now just allow always allow a newly allocated
179 * property, and replace the existing one as a way of updating. */
180 IDP_ReplaceInGroup(asset_data->properties, prop);
181}
182
183IDProperty *BKE_asset_metadata_idprop_find(const AssetMetaData *asset_data, const char *name)
184{
185 if (!asset_data->properties) {
186 return nullptr;
187 }
188 return IDP_GetPropertyFromGroup(asset_data->properties, name);
189}
190
191/* Queries -------------------------------------------- */
192
194 const ID *owner_id)
195{
196 return BKE_previewimg_id_get(owner_id);
197}
198
199/* .blend file API -------------------------------------------- */
200
202{
203 writer->write_struct(asset_data);
204
205 if (asset_data->properties) {
206 IDP_BlendWrite(writer, asset_data->properties);
207 }
208
209 writer->write_string(asset_data->author);
210 writer->write_string(asset_data->description);
211 writer->write_string(asset_data->copyright);
212 writer->write_string(asset_data->license);
213
214 for (AssetTag &tag : asset_data->tags) {
215 writer->write_struct(&tag);
216 }
217}
218
220{
221 /* asset_data itself has been read already. */
222 asset_data->local_type_info = nullptr;
223
224 if (asset_data->properties) {
225 BLO_read_struct(reader, IDProperty, &asset_data->properties);
226 IDP_BlendDataRead(reader, &asset_data->properties);
227 }
228
229 BLO_read_string(reader, &asset_data->author);
230 BLO_read_string(reader, &asset_data->description);
231 BLO_read_string(reader, &asset_data->copyright);
232 BLO_read_string(reader, &asset_data->license);
233
234 BLO_read_struct_list(reader, AssetTag, &asset_data->tags);
235 BLI_assert(asset_data->tags.count() == asset_data->tot_tags);
236}
237
238} // namespace blender
#define IDP_BlendDataRead(reader, prop)
#define STRNCPY_UTF8(dst, src)
#define BLO_read_struct_list(reader, struct_name, list)
#define BLO_read_struct(reader, struct_name, ptr_p)
ID and Library types, which are fundamental for SDNA.
Read Blender memory allocation and freeing.
constexpr StringRef trim() const
void copy_utf8_truncated(char *dst, int64_t dst_size) const
Definition string_ref.cc:28
#define offsetof(t, d)
std::unique_ptr< IDProperty, IDPropertyDeleter > create_group(StringRef prop_name, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_GROUP.
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
void BKE_asset_metadata_catalog_id_clear(AssetMetaData *asset_data)
Definition asset.cc:158
char * STRNCPY(char(&dst)[N], const char *src)
void IDP_ReplaceInGroup(IDProperty *group, IDProperty *prop) ATTR_NONNULL()
Definition idprop.cc:737
void BKE_asset_metadata_idprop_ensure(AssetMetaData *asset_data, IDProperty *prop)
Definition asset.cc:172
void BKE_asset_metadata_write(BlendWriter *writer, AssetMetaData *asset_data)
Definition asset.cc:201
AssetMetaData * BKE_asset_metadata_copy(const AssetMetaData *source)
Definition asset.cc:42
void void void void void void BLI_duplicatelist(ListBase *dst, const ListBase *src) ATTR_NONNULL(1
Definition listbase.cc:834
void BKE_asset_metadata_free(AssetMetaData **asset_data)
Definition asset.cc:36
IDProperty * IDP_GetPropertyFromGroup(const IDProperty *prop, StringRef name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
Definition idprop.cc:818
void IDP_BlendWrite(BlendWriter *writer, const IDProperty *prop)
Definition idprop.cc:1696
void * BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:615
void BKE_asset_metadata_catalog_id_set(AssetMetaData *asset_data, bUUID catalog_id, const char *catalog_simple_name)
Definition asset.cc:164
PreviewImage * BKE_asset_metadata_preview_get_from_id(const AssetMetaData *asset_data, const ID *owner_id)
Definition asset.cc:193
void BKE_asset_metadata_tag_remove(AssetMetaData *asset_data, AssetTag *tag)
Definition asset.cc:144
AssetTag * BKE_asset_metadata_tag_add(AssetMetaData *asset_data, const char *name) ATTR_NONNULL(1
Definition asset.cc:114
void BLI_uniquename(const ListBase *list, void *vlink, const char *defname, char delim, int name_offset, size_t name_maxncpy) ATTR_NONNULL(1
int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:593
void BLI_freelinkN(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:277
IDProperty * BKE_asset_metadata_idprop_find(const AssetMetaData *asset_data, const char *name) ATTR_WARN_UNUSED_RESULT
Definition asset.cc:183
void BKE_asset_library_reference_init_default(AssetLibraryReference *library_ref)
Definition asset.cc:153
static AssetTag * asset_metadata_tag_add(AssetMetaData *asset_data, const char *const name)
Definition asset.cc:101
PreviewImage * BKE_previewimg_id_get(const ID *id)
AssetTag AssetTagEnsureResult BKE_asset_metadata_tag_ensure(AssetMetaData *asset_data, const char *name)
Definition asset.cc:121
AssetMetaData * BKE_asset_metadata_create()
Definition asset.cc:31
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
void BKE_asset_metadata_read(BlendDataReader *reader, AssetMetaData *asset_data)
Definition asset.cc:219
void IDP_FreeProperty(IDProperty *prop)
Definition idprop.cc:1403
char * BLI_strdup_null(const char *str) ATTR_WARN_UNUSED_RESULT ATTR_MALLOC
bUUID BLI_uuid_nil()
Definition uuid.cc:66
void BLO_read_string(BlendDataReader *reader, char **ptr_p)
Definition readfile.cc:6653
The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data),...
struct IDProperty * properties
ListBaseT< AssetTag > tags
struct AssetTypeInfo * local_type_info
User defined tag. Currently only used by assets, could be used more often at some point....
void write_string(const char *data)
void write_struct(const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
Universally Unique Identifier according to RFC4122.