BKE_lib_query.h

Go to the documentation of this file.

/*
 * 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.
 */
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ID;
struct IDProperty;
struct Main;
 
/* Tips for the callback for cases it's gonna to modify the pointer. */
enum {
  IDWALK_CB_NOP = 0,
  IDWALK_CB_NEVER_NULL = (1 << 0),
  IDWALK_CB_NEVER_SELF = (1 << 1),
 
  IDWALK_CB_INDIRECT_USAGE = (1 << 2),
 
  IDWALK_CB_EMBEDDED = (1 << 3),
 
  IDWALK_CB_LOOPBACK = (1 << 4),
 
  IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE = (1 << 5),
 
  IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE = (1 << 6),
 
  IDWALK_CB_INTERNAL = (1 << 7),
 
  IDWALK_CB_USER = (1 << 8),
  IDWALK_CB_USER_ONE = (1 << 9),
};
 
enum {
  IDWALK_RET_NOP = 0,
  IDWALK_RET_STOP_ITER = 1 << 0,
  IDWALK_RET_STOP_RECURSION = 1 << 1,
};
 
typedef struct LibraryIDLinkCallbackData {
  void *user_data;
  struct Main *bmain;
  struct ID *id_owner;
  struct ID *id_self;
  struct ID **id_pointer;
  int cb_flag;
} LibraryIDLinkCallbackData;
 
typedef int (*LibraryIDLinkCallback)(LibraryIDLinkCallbackData *cb_data);
 
/* Flags for the foreach function itself. */
enum {
  IDWALK_NOP = 0,
  IDWALK_READONLY = (1 << 0),
  IDWALK_RECURSE = (1 << 1),    /* Also implies IDWALK_READONLY. */
  IDWALK_INCLUDE_UI = (1 << 2), /* Include UI pointers (from WM and screens editors). */
  IDWALK_IGNORE_EMBEDDED_ID = (1 << 3),
 
  IDWALK_NO_INDIRECT_PROXY_DATA_USAGE = (1 << 8), /* Ugly special case :(((( */
  IDWALK_DO_INTERNAL_RUNTIME_POINTERS = (1 << 9),
};
 
typedef struct LibraryForeachIDData LibraryForeachIDData;
 
bool BKE_lib_query_foreachid_process(struct LibraryForeachIDData *data,
                                     struct ID **id_pp,
                                     int cb_flag);
int BKE_lib_query_foreachid_process_flags_get(struct LibraryForeachIDData *data);
int BKE_lib_query_foreachid_process_callback_flag_override(struct LibraryForeachIDData *data,
                                                           const int cb_flag,
                                                           const bool do_replace);
 
#define BKE_LIB_FOREACHID_PROCESS_ID(_data, _id, _cb_flag) \
  { \
    CHECK_TYPE_ANY((_id), ID *, void *); \
    if (!BKE_lib_query_foreachid_process((_data), (ID **)&(_id), (_cb_flag))) { \
      return; \
    } \
  } \
  ((void)0)
 
#define BKE_LIB_FOREACHID_PROCESS(_data, _id_super, _cb_flag) \
  { \
    CHECK_TYPE(&((_id_super)->id), ID *); \
    if (!BKE_lib_query_foreachid_process((_data), (ID **)&(_id_super), (_cb_flag))) { \
      return; \
    } \
  } \
  ((void)0)
 
bool BKE_library_foreach_ID_embedded(struct LibraryForeachIDData *data, struct ID **id_pp);
void BKE_lib_query_idpropertiesForeachIDLink_callback(struct IDProperty *id_prop, void *user_data);
 
/* Loop over all of the ID's this datablock links to. */
void BKE_library_foreach_ID_link(
    struct Main *bmain, 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 cb_flag);
 
int BKE_library_ID_use_ID(struct ID *id_user, struct ID *id_used);
 
bool BKE_library_id_can_use_idtype(struct ID *id_owner, const short id_type_used);
 
bool BKE_library_ID_is_locally_used(struct Main *bmain, void *idv);
bool BKE_library_ID_is_indirectly_used(struct Main *bmain, void *idv);
void BKE_library_ID_test_usages(struct Main *bmain,
                                void *idv,
                                bool *is_used_local,
                                bool *is_used_linked);
 
void BKE_lib_query_unused_ids_tag(struct Main *bmain,
                                  const int tag,
                                  const bool do_local_ids,
                                  const bool do_linked_ids,
                                  const bool do_tag_recursive,
                                  int *r_num_tagged);
 
void BKE_library_unused_linked_data_set_tag(struct Main *bmain, const bool do_init_tag);
void BKE_library_indirectly_used_data_tag_clear(struct Main *bmain);
 
#ifdef __cplusplus
}
#endif