9b12b23d0b
Catalogs work like directories on disk (without hard-/symlinks), in that
an asset is only contained in one catalog.
See T90066 for design considerations.
#### Known Limitations
Only a single catalog definition file (CDF), is supported, at
`${ASSET_LIBRARY_ROOT}/blender_assets.cats.txt`. In the future this is
to be expanded to support arbitrary CDFs (like one per blend file, one
per subdirectory, etc.).
The current implementation is based on the asset browser, which in
practice means that the asset browser owns the `AssetCatalogService`
instance for the selected asset library. In the future these instances
will be accessible via a less UI-bound asset system.
The UI is still very rudimentary, only showing the catalog ID for the
currently selected asset. Most notably, the loaded catalogs are not
shown yet. The UI is being implemented and will be merged soon.
#### Catalog Identifiers
Catalogs are internally identified by UUID. In older designs this was a
human-readable name, which has the problem that it has to be kept in
sync with its semantics (so when renaming a catalog from X to Y, the
UUID can be kept the same).
Since UUIDs don't communicate any human-readable information, the
mapping from catalog UUID to its path (stored in the Catalog Definition
File, CDF) is critical for understanding which asset is stored in which
human-readable catalog. To make this less critical, and to allow manual
data reconstruction after a CDF is lost/corrupted, each catalog also has
a "simple name" that's stored along with the UUID. This is also stored
on each asset, next to the catalog UUID.
#### Writing to Disk
Before saving asset catalogs to disk, the to-be-overwritten file gets
inspected. Any new catalogs that are found thre are loaded to memory
before writing the catalogs back to disk:
- Changed catalog path: in-memory data wins
- Catalogs deleted on disk: they are recreated based on in-memory data
- Catalogs deleted in memory: deleted on disk as well
- New catalogs on disk: are loaded and thus survive the overwriting
#### Tree Design
This implements the initial tree structure to load catalogs into. See
T90608, and the basic design in T90066.
Reviewed By: Severin
Maniphest Tasks: T91552
Differential Revision: https://developer.blender.org/D12589
92 lines
2.6 KiB
C++
92 lines
2.6 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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* Functions for generating and handling UUID structs according to RFC4122.
|
|
*
|
|
* Note that these are true UUIDs, not to be confused with the "session uuid" defined in
|
|
* `BLI_session_uuid.h`.
|
|
*/
|
|
#include "DNA_uuid_types.h"
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* UUID generator for random (version 4) UUIDs. See RFC4122 section 4.4.
|
|
* This function is not thread-safe. */
|
|
bUUID BLI_uuid_generate_random(void);
|
|
|
|
/**
|
|
* Return the UUID nil value, consisting of all-zero fields.
|
|
*/
|
|
bUUID BLI_uuid_nil(void);
|
|
|
|
/** Return true only if this is the nil UUID. */
|
|
bool BLI_uuid_is_nil(bUUID uuid);
|
|
|
|
/** Compare two UUIDs, return true only if they are equal. */
|
|
bool BLI_uuid_equal(bUUID uuid1, bUUID uuid2);
|
|
|
|
/**
|
|
* Format UUID as string.
|
|
* The buffer must be at least 37 bytes (36 bytes for the UUID + terminating 0).
|
|
* Use `UUID_STRING_LEN` from DNA_uuid_types.h if you want to use a constant for this.
|
|
*/
|
|
void BLI_uuid_format(char *buffer, bUUID uuid) ATTR_NONNULL();
|
|
|
|
/**
|
|
* Parse a string as UUID.
|
|
* The string MUST be in the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`,
|
|
* as produced by #BLI_uuid_format().
|
|
*
|
|
* Return true if the string could be parsed, and false otherwise. In the latter case, the UUID may
|
|
* have been partially updated.
|
|
*/
|
|
bool BLI_uuid_parse_string(bUUID *uuid, const char *buffer) ATTR_NONNULL();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
|
|
# include <ostream>
|
|
|
|
/** Output the UUID as formatted ASCII string, see #BLI_uuid_format(). */
|
|
std::ostream &operator<<(std::ostream &stream, bUUID uuid);
|
|
|
|
namespace blender::bke {
|
|
|
|
class bUUID : public ::bUUID {
|
|
public:
|
|
bUUID() = default;
|
|
bUUID(const ::bUUID &struct_uuid);
|
|
explicit bUUID(const std::string &string_formatted_uuid);
|
|
|
|
uint64_t hash() const;
|
|
};
|
|
|
|
bool operator==(bUUID uuid1, bUUID uuid2);
|
|
|
|
} // namespace blender::bke
|
|
|
|
#endif
|