archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
da6dea5701311f41c7d70429b111b901b6bcf966
blender-archive/source/blender/blenkernel/BKE_main_idmap.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
2.5 KiB
C++
Raw Normal View History

readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
/*
* 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.
*/
Cleanup: Rename `BKE_library_idmap` file to `BKE_main_idmap` Part of T72604: > Proposal: BKE_library and BKE_main API naming: prefixes conventions
2020-02-07 16:29:02 +01:00
#pragma once
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup bke
Cleanup: Add basic doc about each `BKE_main` and `BKE_lib` files. Including expected prefixes for functions in those files. Part of T72604.
2020-02-10 15:05:54 +01:00
*
* 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.
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
*/
#include "BLI_compiler_attrs.h"
Cleanup: make remaining blenkernel headers work in C++
2020-03-02 15:07:49 +01:00
#ifdef __cplusplus
extern "C" {
#endif
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
struct ID;
struct IDNameLib_Map;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct Main;
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
Add an session-wise uuid integer to IDs. "session-wise" here mean while editing a same .blend file. So creating or opening a new one will reset the uuid counter. This should avoid any overflow in practice. Only IDs added to Main database get an uuid, runtime-only ones are not affected. This is intended to provide undo with a way to find IDs across several 'memory realms' (undo speedup project). No behavior change is expected from this commit itself. Part of T60695. Differential Revision: https://developer.blender.org/D7007
2020-03-05 16:17:14 +01:00
enum {
MAIN_IDMAP_TYPE_NAME = 1 << 0,
MAIN_IDMAP_TYPE_UUID = 1 << 1,
};
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
struct IDNameLib_Map *BKE_main_idmap_create(struct Main *bmain,
Fix (unreported) crash when undoing after ID deletion. Yes, we do can undo an ID deletion now. However, this requires extra care in UI 'remapping' to new IDs step (when undoing, we do not fully reload the UI from saved .blend). Otherwise, new UI (i.e. one from saved .blend file) might reference IDs that where freed in old bmain (the one before the undo), we cannot use those to get ID name then, that would be a nasty use-after-free! To prevent this, we generate a GSet of all valid ID pointers at that time (i.e. those found in both old and new Main's), and ensure any ID we try to remap by its name is in that GSet. Otherwise, there is no possible remapping, just return NULL.
2019-02-08 18:45:57 +01:00
const bool create_valid_ids_set,
Add an session-wise uuid integer to IDs. "session-wise" here mean while editing a same .blend file. So creating or opening a new one will reset the uuid counter. This should avoid any overflow in practice. Only IDs added to Main database get an uuid, runtime-only ones are not affected. This is intended to provide undo with a way to find IDs across several 'memory realms' (undo speedup project). No behavior change is expected from this commit itself. Part of T60695. Differential Revision: https://developer.blender.org/D7007
2020-03-05 16:17:14 +01:00
struct Main *old_bmain,
const int idmap_types) ATTR_WARN_UNUSED_RESULT
Fix (unreported) crash when undoing after ID deletion. Yes, we do can undo an ID deletion now. However, this requires extra care in UI 'remapping' to new IDs step (when undoing, we do not fully reload the UI from saved .blend). Otherwise, new UI (i.e. one from saved .blend file) might reference IDs that where freed in old bmain (the one before the undo), we cannot use those to get ID name then, that would be a nasty use-after-free! To prevent this, we generate a GSet of all valid ID pointers at that time (i.e. those found in both old and new Main's), and ensure any ID we try to remap by its name is in that GSet. Otherwise, there is no possible remapping, just return NULL.
2019-02-08 18:45:57 +01:00
ATTR_NONNULL(1);
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
void BKE_main_idmap_destroy(struct IDNameLib_Map *id_map) ATTR_NONNULL();
struct Main *BKE_main_idmap_main_get(struct IDNameLib_Map *id_map) ATTR_WARN_UNUSED_RESULT
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
ATTR_NONNULL();
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
struct ID *BKE_main_idmap_lookup_name(struct IDNameLib_Map *id_map,
Add an session-wise uuid integer to IDs. "session-wise" here mean while editing a same .blend file. So creating or opening a new one will reset the uuid counter. This should avoid any overflow in practice. Only IDs added to Main database get an uuid, runtime-only ones are not affected. This is intended to provide undo with a way to find IDs across several 'memory realms' (undo speedup project). No behavior change is expected from this commit itself. Part of T60695. Differential Revision: https://developer.blender.org/D7007
2020-03-05 16:17:14 +01:00
short id_type,
const char *name,
const struct Library *lib) ATTR_WARN_UNUSED_RESULT
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
ATTR_NONNULL(1, 3);
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
struct ID *BKE_main_idmap_lookup_id(struct IDNameLib_Map *id_map,
readfile: optimization for undo Was using O(n^2) lookup on ID's with undo. This caused undo to hang with 1000's of data-blocks (especially with heavy scenes & outliner-space, which doesn't even need to be visible to cause a slow-down). Internally this uses a ghash per id-type, which is lazy-initialized. Each key uses the name and library since there may be name collisions between libraries. Developer Notes: - Adds small `BKE_main_idmap_*` API. - Needed to change linking order for this to build.
2016-06-07 16:07:13 +10:00
const struct ID *id) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1, 2);
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
struct ID *BKE_main_idmap_lookup_uuid(struct IDNameLib_Map *id_map,
Add an session-wise uuid integer to IDs. "session-wise" here mean while editing a same .blend file. So creating or opening a new one will reset the uuid counter. This should avoid any overflow in practice. Only IDs added to Main database get an uuid, runtime-only ones are not affected. This is intended to provide undo with a way to find IDs across several 'memory realms' (undo speedup project). No behavior change is expected from this commit itself. Part of T60695. Differential Revision: https://developer.blender.org/D7007
2020-03-05 16:17:14 +01:00
const uint session_uuid) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1);
Cleanup: make remaining blenkernel headers work in C++
2020-03-02 15:07:49 +01:00
#ifdef __cplusplus
}
#endif
Copy Permalink