diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_library_query.h')
-rw-r--r-- | source/blender/blenkernel/BKE_library_query.h | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_library_query.h b/source/blender/blenkernel/BKE_library_query.h new file mode 100644 index 00000000000..50958f8ee80 --- /dev/null +++ b/source/blender/blenkernel/BKE_library_query.h @@ -0,0 +1,57 @@ +/* + * ***** 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), +}; + +/* 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); + +#endif /* __BKE_LIBRARY_QUERY_H__ */ |