AS_asset_catalog_path.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_function_ref.hh"
#include "BLI_string_ref.hh"
#include "BLI_sys_types.h"
 
#include <string>
 
namespace blender::asset_system {
 
class AssetCatalogPath {
  friend std::ostream &operator<<(std::ostream &stream, const AssetCatalogPath &path_to_append);
 
  std::string path_ = "";
 
 public:
  static const char SEPARATOR;
 
  AssetCatalogPath() = default;
  AssetCatalogPath(StringRef path);
  AssetCatalogPath(std::string path);
  AssetCatalogPath(const char *path);
  AssetCatalogPath(const AssetCatalogPath &other_path) = default;
  AssetCatalogPath(AssetCatalogPath &&other_path) noexcept;
  ~AssetCatalogPath() = default;
 
  uint64_t hash() const;
  uint64_t length() const; /* Length of the path in bytes. */
 
  const char *c_str() const;
  const std::string &str() const;
 
  /* The last path component, used as label in the tree view. */
  StringRefNull name() const;
 
  /* In-class operators, because of the implicit `AssetCatalogPath(StringRef)` constructor.
   * Otherwise `string == string` could cast both sides to `AssetCatalogPath`. */
  bool operator==(const AssetCatalogPath &other_path) const;
  bool operator!=(const AssetCatalogPath &other_path) const;
  bool operator<(const AssetCatalogPath &other_path) const;
  AssetCatalogPath &operator=(const AssetCatalogPath &other_path) = default;
  AssetCatalogPath &operator=(AssetCatalogPath &&other_path) = default;
 
  AssetCatalogPath operator/(const AssetCatalogPath &path_to_append) const;
 
  /* False when the path is empty, true otherwise. */
  operator bool() const;
 
  [[nodiscard]] AssetCatalogPath cleanup() const;
 
  bool is_contained_in(const AssetCatalogPath &other_path) const;
 
  AssetCatalogPath parent() const;
 
  AssetCatalogPath rebase(const AssetCatalogPath &from_path,
                          const AssetCatalogPath &to_path) const;
 
  using ComponentIteratorFn = FunctionRef<void(StringRef component_name, bool is_last_component)>;
  void iterate_components(ComponentIteratorFn callback) const;
 
 protected:
  static std::string cleanup_component(StringRef component_name);
};
 
std::ostream &operator<<(std::ostream &stream, const AssetCatalogPath &path_to_append);
 
}  // namespace blender::asset_system