BKE_main_idmap.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_compiler_attrs.h"
#include "BLI_sys_types.h"
 
struct Library;
struct ID;
struct IDNameLib_Map;
struct Main;
 
enum {
  MAIN_IDMAP_TYPE_NAME = 1 << 0,
  MAIN_IDMAP_TYPE_UID = 1 << 1,
};

IDNameLib_Map *BKE_main_idmap_create(Main *bmain,
                                     bool create_valid_ids_set,
                                     Main *old_bmain,
                                     int idmap_types) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void BKE_main_idmap_clear(IDNameLib_Map &id_map);
void BKE_main_idmap_destroy(IDNameLib_Map *id_map) ATTR_NONNULL();
 
void BKE_main_idmap_insert_id(IDNameLib_Map *id_map, ID *id) ATTR_NONNULL();
void BKE_main_idmap_remove_id(IDNameLib_Map *id_map, const ID *id) ATTR_NONNULL();
 
Main *BKE_main_idmap_main_get(IDNameLib_Map *id_map) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 
ID *BKE_main_idmap_lookup_name(IDNameLib_Map *id_map,
                               short id_type,
                               const char *name,
                               const Library *lib) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 3);
ID *BKE_main_idmap_lookup_id(IDNameLib_Map *id_map, const ID *id) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1, 2);
 
ID *BKE_main_idmap_lookup_uid(IDNameLib_Map *id_map, uint session_uid) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);