920e709069
When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608
65 lines
2.4 KiB
C++
65 lines
2.4 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*
|
|
* API to generate and use a mapping from [ID type & name] to [id pointer], within a given Main
|
|
* data-base.
|
|
*
|
|
* \note `BKE_main` files are for operations over the Main database itself, or generating extra
|
|
* temp data to help working with it. Those should typically not affect the data-blocks themselves.
|
|
*
|
|
* \section Function Names
|
|
*
|
|
* - `BKE_main_idmap_` Should be used for functions in that file.
|
|
*/
|
|
|
|
#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,
|
|
};
|
|
|
|
/**
|
|
* Generate mapping from ID type/name to ID pointer for given \a bmain.
|
|
*
|
|
* \note When used during undo/redo, there is no guaranty that ID pointers from UI area are not
|
|
* pointing to freed memory (when some IDs have been deleted). To avoid crashes in those cases, one
|
|
* can provide the 'old' (aka current) Main database as reference. #BKE_main_idmap_lookup_id will
|
|
* then check that given ID does exist in \a old_bmain before trying to use it.
|
|
*
|
|
* \param create_valid_ids_set: If \a true, generate a reference to prevent freed memory accesses.
|
|
* \param old_bmain: If not NULL, its IDs will be added the valid references set.
|
|
*/
|
|
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);
|