Bastien Montagne
4acf0f05a1
This mainly adds bpy.data.user_map() method, which goes over the whole Main database
to build a mapping (dict) {ID: {users_of_that_ID}}.
Very handy to check and debug ID usages, but could also be really valuable for py addons
creating temporary scenes, or some exporters, etc.
Note: current code in master's libquery misses some IDs (and reports some it should not,
like nodetrees), this is fixed in id-remap but still needs serious review before going to master.
This basically means that current bpy.data.user_map() **will not** report a complete and exhaustive
state of dependencies between IDs. Should work OK in most cases though.
Original work/idea comes from id-remap branch, was heavily reworked by @campbellbarton
and myself for master.
Reviewers: campbellbarton, sergey
Differential Revision: https://developer.blender.org/D1678
71 lines
2.1 KiB
C++
71 lines
2.1 KiB
C++
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* 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.
|
|
*
|
|
* The Original Code is Copyright (C) 2014 by Blender Foundation.
|
|
* All rights reserved.
|
|
*
|
|
* Contributor(s): Sergey SHarybin.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
#ifndef __BKE_LIBRARY_QUERY_H__
|
|
#define __BKE_LIBRARY_QUERY_H__
|
|
|
|
/** \file BKE_library_query.h
|
|
* \ingroup bke
|
|
* \since March 2014
|
|
* \author sergey
|
|
*/
|
|
|
|
struct ID;
|
|
|
|
/* Tips for the callback for cases it's gonna to modify the pointer. */
|
|
enum {
|
|
IDWALK_NOP = 0,
|
|
IDWALK_NEVER_NULL = (1 << 0),
|
|
IDWALK_NEVER_SELF = (1 << 1),
|
|
|
|
/**
|
|
* Adjusts #ID.us reference-count.
|
|
* \note keep in sync with 'newlibadr_us' use in readfile.c
|
|
*/
|
|
IDWALK_USER = (1 << 8),
|
|
/**
|
|
* Ensure #ID.us is at least 1 on use.
|
|
*/
|
|
IDWALK_USER_ONE = (1 << 9),
|
|
};
|
|
|
|
/* Call a callback for each ID link which the given ID uses.
|
|
*
|
|
* Return 'false' if you want to stop iteration.
|
|
*/
|
|
typedef bool (*LibraryIDLinkCallback) (void *user_data, struct ID **id_pointer, int cd_flag);
|
|
|
|
/* Flags for the foreach function itself. */
|
|
enum {
|
|
IDWALK_READONLY = (1 << 0),
|
|
};
|
|
|
|
/* Loop over all of the ID's this datablock links to. */
|
|
void BKE_library_foreach_ID_link(struct ID *id, LibraryIDLinkCallback callback, void *user_data, int flag);
|
|
void BKE_library_update_ID_link_user(struct ID *id_dst, struct ID *id_src, const int cd_flag);
|
|
|
|
int BKE_library_ID_use_ID(struct ID *id_user, struct ID *id_used);
|
|
|
|
#endif /* __BKE_LIBRARY_QUERY_H__ */
|