doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_library_query.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2014 by Blender Foundation.
17  * All rights reserved.
18  */
19 #ifndef __BKE_LIBRARY_QUERY_H__
20 #define __BKE_LIBRARY_QUERY_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 struct ID;
27 struct Main;
28
29 /* Tips for the callback for cases it's gonna to modify the pointer. */
30 enum {
31         IDWALK_CB_NOP = 0,
32         IDWALK_CB_NEVER_NULL = (1 << 0),
33         IDWALK_CB_NEVER_SELF = (1 << 1),
34
35         /**
36          * Indicates whether this is direct (i.e. by local data) or indirect (i.e. by linked data) usage.
37          * \note Object proxies are half-local, half-linked...
38          */
39         IDWALK_CB_INDIRECT_USAGE = (1 << 2),
40
41         /** That ID is used as mere sub-data by its owner
42          * (only case currently: those f***ing nodetrees in materials etc.).
43          * This means callback shall not *do* anything, only use this as informative data if it needs it. */
44         IDWALK_CB_PRIVATE = (1 << 3),
45
46         /** That ID is not really used by its owner, it's just an internal hint/helper.
47          * This addresses Their Highest Ugliness the 'from' pointers: Object->from_proxy and Key->from.
48          * How to handle that kind of cases totally depends on what caller code is doing... */
49         IDWALK_CB_LOOPBACK = (1 << 4),
50
51         /** That ID is used as static override's reference by its owner. */
52         IDWALK_CB_STATIC_OVERRIDE_REFERENCE = (1 << 5),
53
54         /**
55          * Adjusts #ID.us reference-count.
56          * \note keep in sync with 'newlibadr_us' use in readfile.c
57          */
58         IDWALK_CB_USER = (1 << 8),
59         /** Ensure #ID.us is at least 1 on use. */
60         IDWALK_CB_USER_ONE = (1 << 9),
61 };
62
63 enum {
64         IDWALK_RET_NOP            = 0,
65         IDWALK_RET_STOP_ITER      = 1 << 0,  /* Completely stop iteration. */
66         IDWALK_RET_STOP_RECURSION = 1 << 1,  /* Stop recursion, that is, do not loop over ID used by current one. */
67 };
68
69 /**
70  * Call a callback for each ID link which the given ID uses.
71  *
72  * \return a set of flags to control further iteration (0 to keep going).
73  */
74 typedef int (*LibraryIDLinkCallback) (void *user_data, struct ID *id_self, struct ID **id_pointer, int cb_flag);
75
76 /* Flags for the foreach function itself. */
77 enum {
78         IDWALK_NOP      = 0,
79         IDWALK_READONLY = (1 << 0),
80         IDWALK_RECURSE  = (1 << 1),  /* Also implies IDWALK_READONLY. */
81
82         IDWALK_NO_INDIRECT_PROXY_DATA_USAGE = (1 << 8),  /* Ugly special case :(((( */
83 };
84
85 /* Loop over all of the ID's this datablock links to. */
86 void BKE_library_foreach_ID_link(
87         struct Main *bmain, struct ID *id, LibraryIDLinkCallback callback, void *user_data, int flag);
88 void BKE_library_update_ID_link_user(struct ID *id_dst, struct ID *id_src, const int cb_flag);
89
90 int BKE_library_ID_use_ID(struct ID *id_user, struct ID *id_used);
91
92 bool BKE_library_id_can_use_idtype(struct ID *id_owner, const short id_type_used);
93
94 bool BKE_library_ID_is_locally_used(struct Main *bmain, void *idv);
95 bool BKE_library_ID_is_indirectly_used(struct Main *bmain, void *idv);
96 void BKE_library_ID_test_usages(struct Main *bmain, void *idv, bool *is_used_local, bool *is_used_linked);
97
98 void BKE_library_unused_linked_data_set_tag(struct Main *bmain, const bool do_init_tag);
99 void BKE_library_indirectly_used_data_tag_clear(struct Main *bmain);
100
101 #endif  /* __BKE_LIBRARY_QUERY_H__ */