Differential D12172 Diff 40486 source/blender/blenkernel/BKE_asset_catalog.hh

Changeset View

Standalone View

source/blender/blenkernel/BKE_asset_catalog.hh

This file was added.

				/*
				* 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.
				*/

				/** \file
				* \ingroup bke
				*/

				#pragma once

				#ifndef __cplusplus
				# error This is a C++ header. The C interface is yet to be implemented/designed.
				#endif

				#include "BLI_map.hh"
				#include "BLI_set.hh"
				#include "BLI_string_ref.hh"
				#include "BLI_vector_set.hh"

				#include <filesystem>
				#include <memory>
				#include <string>

				namespace blender::bke {

				using CatalogID = std::string;
				using CatalogPath = std::string;
				using CatalogFilePath = std::filesystem::path;

				class AssetCatalog;
				class AssetCatalogDefinitionFile;

				/* Manages the asset catalogs of a single asset library (i.e. of catalogs defined in a single
				* directory hierarchy). */
				class AssetCatalogService {
				public:
				const char path_separator = '/';

				SeverinUnsubmitted Done Inline Actions I'd suggest to default to Doxygen comments for all definitions. Severin: I'd suggest to default to Doxygen comments for all definitions.
				public:
				AssetCatalogService() = default;

				SeverinUnsubmitted Done Inline Actions People may expect that on Windows they can use `\`. Maybe explicitly note that this isn't supported. Severin: People may expect that on Windows they can use `\`. Maybe explicitly note that this isn't…
				sybrenAuthorUnsubmitted Done Inline Actions We could simply replace those with `/` as soon as they're entered. Something similar to the cleanup in the `BKE_asset_metadata_catalog_id_set()` function. sybren: We could simply replace those with `/` as soon as they're entered. Something similar to the…
				sybrenAuthorUnsubmitted Done Inline Actions I've added T90553: Normalise catalog paths by changing backslashes to forward slashes for this. sybren: I've added {T90553} for this.
				/* Return catalog with the given ID. Return nullptr if not found. */
				AssetCatalog *find_catalog(const CatalogID &catalog_id);

				void load_from_disk(const CatalogFilePath &asset_library_root);

				SeverinUnsubmitted Done Inline Actions Style guide is to use a trailing `_` for private/protected vars. https://wiki.blender.org/wiki/Style_Guide/C_Cpp#Class_data_member_names Severin: Style guide is to use a trailing `_` for private/protected vars. https://wiki.blender.
				sybrenAuthorUnsubmitted Done Inline Actions I know, hence the `TODO(@sybren): determine which properties should be private / get accessors.` note ;-) Now that things are at the "ready for initial review" stage, I'll just mark everything as private suffix with `_`. If it's not proven to be necessarily public, I'd rather have them private. sybren: I know, hence the `TODO(@sybren): determine which properties should be private / get accessors.
				/* Get CDF for testing only. */
				AssetCatalogDefinitionFile *get_catalog_definition_file();

				/* Return true iff there are no catalogs known. */
				bool is_empty() const;

				protected:
				/* These pointers are owned by this AssetCatalogService. */
				Map<CatalogID, std::unique_ptr<AssetCatalog>> catalogs_;
				std::unique_ptr<AssetCatalogDefinitionFile> catalog_definition_file_;

				void load_directory_recursive(const CatalogFilePath &directory_path);
				void load_single_file(const CatalogFilePath &catalog_definition_file_path);

				std::unique_ptr<AssetCatalogDefinitionFile> parse_catalog_file(
				const CatalogFilePath &catalog_definition_file_path);

				std::unique_ptr<AssetCatalog> parse_catalog_line(
				StringRef line, const AssetCatalogDefinitionFile *catalog_definition_file);
				};

				/** Keeps track of which catalogs are defined in a certain file on disk.
				* Only contains non-owning pointers to the #AssetCatalog instances, so ensure the lifetime of this
				* class is shorter than that of the #`AssetCatalog`s themselves. */
				class AssetCatalogDefinitionFile {
				public:
				CatalogFilePath file_path;

				AssetCatalogDefinitionFile() = default;

				/** Write the catalog definitions to the same file they were read from. */
				void write_to_disk() const;
				/** Write the catalog definitions to an arbitrary file path. */
				void write_to_disk(const CatalogFilePath &) const;

				bool contains(const CatalogID &catalog_id) const;
				/* Add a new catalog. Undefined behaviour if a catalog with the same ID was already added. */
				void add_new(AssetCatalog *catalog);

				protected:
				/* Catalogs stored in this file. They are mapped by ID to make it possible to query whether a
				* catalog is already known, without having to find the corresponding `AssetCatalog`. /
				Map<CatalogID, AssetCatalog *> catalogs_;
				};

				/** Asset Catalog definition, containing a symbolic ID and a path that points to a node in the
				* catalog hierarchy. */
				class AssetCatalog {
				public:
				AssetCatalog() = default;
				AssetCatalog(const CatalogID &catalog_id, const CatalogPath &path);

				CatalogID catalog_id;
				CatalogPath path;
				};

				} // namespace blender::bke