Differential D16449 Diff 57448 source/blender/asset_system/AS_asset_catalog_path.hh

Changeset View

Standalone View

source/blender/asset_system/AS_asset_catalog_path.hh

This file was moved from source/blender/blenkernel/BKE_asset_catalog_path.hh.

	/* SPDX-License-Identifier: GPL-2.0-or-later */			/* SPDX-License-Identifier: GPL-2.0-or-later */

	/** \file			/** \file
	* \ingroup bke			* \ingroup asset_system
	*/			*/

	#pragma once			#pragma once

	#ifndef __cplusplus
	# error This is a C++ header.
	#endif

	#include "BLI_function_ref.hh"			#include "BLI_function_ref.hh"
	#include "BLI_string_ref.hh"			#include "BLI_string_ref.hh"
	#include "BLI_sys_types.h"			#include "BLI_sys_types.h"

	#include <string>			#include <string>

	namespace blender::bke {			namespace blender::asset_system {

	/**			/**
	* Location of an Asset Catalog in the catalog tree, denoted by slash-separated path components.			* Location of an Asset Catalog in the catalog tree, denoted by slash-separated path components.
	*			*
	* Each path component is a string that is not allowed to have slashes or colons. The latter is to			* Each path component is a string that is not allowed to have slashes or colons. The latter is to
	* make things easy to save in the colon-delimited Catalog Definition File format.			* make things easy to save in the colon-delimited Catalog Definition File format.
	*			*
	* The path of a catalog determines where in the catalog hierarchy the catalog is shown. Examples			* The path of a catalog determines where in the catalog hierarchy the catalog is shown. Examples
	▲ Show 20 Lines • Show All 96 Lines • ▼ Show 20 Lines
	protected:			protected:
	/** Strip leading/trailing spaces and replace disallowed characters. */			/** Strip leading/trailing spaces and replace disallowed characters. */
	static std::string cleanup_component(StringRef component_name);			static std::string cleanup_component(StringRef component_name);
	};			};

	/** Output the path as string. */			/** Output the path as string. */
	std::ostream &operator<<(std::ostream &stream, const AssetCatalogPath &path_to_append);			std::ostream &operator<<(std::ostream &stream, const AssetCatalogPath &path_to_append);

	} // namespace blender::bke			} // namespace blender::asset_system