2014-03-26 11:55:20 +01:00
|
|
|
/*
|
|
|
|
* ***** 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;
|
ID-Remap - Step one: core work (cleanup and rework of generic ID datablock handling).
This commit changes a lot of how IDs are handled internally, especially the unlinking/freeing
processes. So far, this was very fuzy, to summarize cleanly deleting or replacing a datablock
was pretty much impossible, except for a few special cases.
Also, unlinking was handled by each datatype, in a rather messy and prone-to-errors way (quite
a few ID usages were missed or wrongly handled that way).
One of the main goal of id-remap branch was to cleanup this, and fatorize ID links handling
by using library_query utils to allow generic handling of those, which is now the case
(now, generic ID links handling is only "knwon" from readfile.c and library_query.c).
This commit also adds backends to allow live replacement and deletion of datablocks in Blender
(so-called 'remapping' process, where we replace all usages of a given ID pointer by a new one,
or NULL one in case of unlinking).
This will allow nice new features, like ability to easily reload or relocate libraries, real immediate
deletion of datablocks in blender, replacement of one datablock by another, etc.
Some of those are for next commits.
A word of warning: this commit is highly risky, because it affects potentially a lot in Blender core.
Though it was tested rather deeply, being totally impossible to check all possible ID usage cases,
it's likely there are some remaining issues and bugs in new code... Please report them! ;)
Review task: D2027 (https://developer.blender.org/D2027).
Reviewed by campbellbarton, thanks a bunch.
2016-06-22 17:29:38 +02:00
|
|
|
struct Main;
|
2014-03-26 11:55:20 +01:00
|
|
|
|
|
|
|
/* Tips for the callback for cases it's gonna to modify the pointer. */
|
|
|
|
enum {
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_CB_NOP = 0,
|
|
|
|
IDWALK_CB_NEVER_NULL = (1 << 0),
|
|
|
|
IDWALK_CB_NEVER_SELF = (1 << 1),
|
2015-10-08 11:09:30 +02:00
|
|
|
|
2016-07-08 19:33:22 +02:00
|
|
|
/**
|
|
|
|
* Indicates whether this is direct (i.e. by local data) or indirect (i.e. by linked data) usage.
|
|
|
|
* \note Object proxies are half-local, half-linked...
|
|
|
|
*/
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_CB_INDIRECT_USAGE = (1 << 2),
|
2016-07-08 19:33:22 +02:00
|
|
|
|
2017-01-30 21:34:23 +01:00
|
|
|
/** That ID is used as mere sub-data by its owner
|
|
|
|
* (only case currently: those f***ing nodetrees in materials etc.).
|
|
|
|
* This means callback shall not *do* anything, only use this as informative data if it needs it. */
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_CB_PRIVATE = (1 << 3),
|
2017-01-30 21:34:23 +01:00
|
|
|
|
2017-05-05 16:13:01 +02:00
|
|
|
/** That ID is not really used by its owner, it's just an internal hint/helper.
|
|
|
|
* This addresses Their Highest Ugliness the 'from' pointers: Object->from_proxy and Key->from.
|
|
|
|
* How to handle that kind of cases totally depends on what caller code is doing... */
|
|
|
|
IDWALK_CB_LOOPBACK = (1 << 4),
|
|
|
|
|
2017-11-29 15:05:03 +01:00
|
|
|
/** That ID is used as static override's reference by its owner. */
|
|
|
|
IDWALK_CB_STATIC_OVERRIDE_REFERENCE = (1 << 5),
|
|
|
|
|
2015-10-08 11:09:30 +02:00
|
|
|
/**
|
|
|
|
* Adjusts #ID.us reference-count.
|
|
|
|
* \note keep in sync with 'newlibadr_us' use in readfile.c
|
|
|
|
*/
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_CB_USER = (1 << 8),
|
2017-01-30 21:34:23 +01:00
|
|
|
/** Ensure #ID.us is at least 1 on use. */
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_CB_USER_ONE = (1 << 9),
|
2014-03-26 11:55:20 +01:00
|
|
|
};
|
|
|
|
|
2016-03-24 12:28:41 +01:00
|
|
|
enum {
|
|
|
|
IDWALK_RET_NOP = 0,
|
2018-09-24 17:27:41 +02:00
|
|
|
IDWALK_RET_STOP_ITER = 1 << 0, /* Completely stop iteration. */
|
2016-03-24 12:28:41 +01:00
|
|
|
IDWALK_RET_STOP_RECURSION = 1 << 1, /* Stop recursion, that is, do not loop over ID used by current one. */
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Call a callback for each ID link which the given ID uses.
|
2014-03-26 11:55:20 +01:00
|
|
|
*
|
2016-04-01 01:02:59 +02:00
|
|
|
* \return a set of flags to control further iteration (0 to keep going).
|
2014-03-26 11:55:20 +01:00
|
|
|
*/
|
2017-01-31 10:41:25 +01:00
|
|
|
typedef int (*LibraryIDLinkCallback) (void *user_data, struct ID *id_self, struct ID **id_pointer, int cb_flag);
|
2014-03-26 11:55:20 +01:00
|
|
|
|
|
|
|
/* Flags for the foreach function itself. */
|
|
|
|
enum {
|
2017-01-31 09:47:59 +01:00
|
|
|
IDWALK_NOP = 0,
|
2014-03-26 11:55:20 +01:00
|
|
|
IDWALK_READONLY = (1 << 0),
|
2016-03-24 12:28:41 +01:00
|
|
|
IDWALK_RECURSE = (1 << 1), /* Also implies IDWALK_READONLY. */
|
2017-06-26 18:55:30 +02:00
|
|
|
|
|
|
|
IDWALK_NO_INDIRECT_PROXY_DATA_USAGE = (1 << 8), /* Ugly special case :(((( */
|
2014-03-26 11:55:20 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Loop over all of the ID's this datablock links to. */
|
2017-01-30 21:41:44 +01:00
|
|
|
void BKE_library_foreach_ID_link(
|
|
|
|
struct Main *bmain, struct ID *id, LibraryIDLinkCallback callback, void *user_data, int flag);
|
2017-01-31 10:41:25 +01:00
|
|
|
void BKE_library_update_ID_link_user(struct ID *id_dst, struct ID *id_src, const int cb_flag);
|
2014-03-26 11:55:20 +01:00
|
|
|
|
2016-01-06 19:34:42 +01:00
|
|
|
int BKE_library_ID_use_ID(struct ID *id_user, struct ID *id_used);
|
|
|
|
|
Datablock ID Properties
The absence of datablock properties "will certainly be resolved soon as the need for them is becoming obvious" said the [[http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.67/Python_Nodes|Python Nodes release notes]]. So this patch allows Python scripts to create ID Properties which reference datablocks.
This functionality is implemented for `PointerProperty` and now such properties can be created with Python.
In addition to the standard update callback, `PointerProperty` can have a `poll` callback (standard RNA) which is useful for search menus. For details see the test included in this patch.
Original author: @artfunkel
Alexander (Blend4Web Team)
Reviewers: brecht, artfunkel, mont29, campbellbarton
Reviewed By: mont29, campbellbarton
Subscribers: jta, sergey, campbellbarton, wisaac, poseidon4o, mont29, homyachetser, Evgeny_Rodygin, AlexKowel, yurikovelenov, fjuhec, sharlybg, cardboard, duarteframos, blueprintrandom, a.romanov, BYOB, disnel, aditiapratama, bliblubli, dfelinto, lukastoenne
Maniphest Tasks: T37754
Differential Revision: https://developer.blender.org/D113
2017-04-13 11:30:03 +02:00
|
|
|
bool BKE_library_id_can_use_idtype(struct ID *id_owner, const short id_type_used);
|
2016-07-07 20:51:21 +02:00
|
|
|
|
2016-07-07 19:39:14 +02:00
|
|
|
bool BKE_library_ID_is_locally_used(struct Main *bmain, void *idv);
|
"Fix" crash when deleting linked object which has indirect usages.
This is in fact very hairy situation here... Objects are only refcounted by scenes,
any other usage is 'free', which means once all object instanciations are gone Blender
considers it can delete it.
There is a trap here though: indirect usages. Typically, we should never modify linked data
(because it is essencially useless, changes would be ignored and ost on next reload or
even undo/redo). This means indirect usages are not affected by default 'safe' remapping/unlinking.
For unlinking preceeding deletion however, this is not acceptable - we are likely to end with
a zero-user ID (aka deletable one) which is still actually used by other linked data.
Solution choosen here is double:
I) From 'user-space' (i.e. outliner, operators...), we check for cases where deleting datablocks
should not be allowed (indirect data or indirectly used data), and abort (with report) if needed.
II) From 'lower' level (BKE_library_remap and RNA), we also unlink from linked data,
which makes actual deletion possible and safe.
Note that with previous behavior (2.77 one), linked object would be deleted, including from linked data -
but then, once file is saved and reloaded, indirect usage would link back the deleted object,
without any instanciation in scene, which made it somehow virtual and unreachable...
With new behavior, this is no more possible, but on the other hand it means that in situations of dependency cycles
(two linked objects using each other), linked objects become impossible to delete (from user space).
Not sure what's best here, behavior with those corner cases of library linking is very poorly defined... :(
2016-07-01 17:51:08 +02:00
|
|
|
bool BKE_library_ID_is_indirectly_used(struct Main *bmain, void *idv);
|
2016-07-07 19:39:14 +02:00
|
|
|
void BKE_library_ID_test_usages(struct Main *bmain, void *idv, bool *is_used_local, bool *is_used_linked);
|
"Fix" crash when deleting linked object which has indirect usages.
This is in fact very hairy situation here... Objects are only refcounted by scenes,
any other usage is 'free', which means once all object instanciations are gone Blender
considers it can delete it.
There is a trap here though: indirect usages. Typically, we should never modify linked data
(because it is essencially useless, changes would be ignored and ost on next reload or
even undo/redo). This means indirect usages are not affected by default 'safe' remapping/unlinking.
For unlinking preceeding deletion however, this is not acceptable - we are likely to end with
a zero-user ID (aka deletable one) which is still actually used by other linked data.
Solution choosen here is double:
I) From 'user-space' (i.e. outliner, operators...), we check for cases where deleting datablocks
should not be allowed (indirect data or indirectly used data), and abort (with report) if needed.
II) From 'lower' level (BKE_library_remap and RNA), we also unlink from linked data,
which makes actual deletion possible and safe.
Note that with previous behavior (2.77 one), linked object would be deleted, including from linked data -
but then, once file is saved and reloaded, indirect usage would link back the deleted object,
without any instanciation in scene, which made it somehow virtual and unreachable...
With new behavior, this is no more possible, but on the other hand it means that in situations of dependency cycles
(two linked objects using each other), linked objects become impossible to delete (from user space).
Not sure what's best here, behavior with those corner cases of library linking is very poorly defined... :(
2016-07-01 17:51:08 +02:00
|
|
|
|
2016-11-12 00:29:38 +01:00
|
|
|
void BKE_library_unused_linked_data_set_tag(struct Main *bmain, const bool do_init_tag);
|
2016-11-11 22:29:54 +01:00
|
|
|
void BKE_library_indirectly_used_data_tag_clear(struct Main *bmain);
|
2016-10-19 14:29:43 +02:00
|
|
|
|
2014-03-26 11:55:20 +01:00
|
|
|
#endif /* __BKE_LIBRARY_QUERY_H__ */
|