BKE_lib_remap.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.
 */
#pragma once
 
#include "BLI_compiler_attrs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* BKE_libblock_free, delete are declared in BKE_lib_id.h for convenience. */
 
/* Also IDRemap->flag. */
enum {
  ID_REMAP_SKIP_INDIRECT_USAGE = 1 << 0,
  ID_REMAP_SKIP_NEVER_NULL_USAGE = 1 << 1,
  ID_REMAP_FLAG_NEVER_NULL_USAGE = 1 << 2,
  ID_REMAP_FORCE_NEVER_NULL_USAGE = 1 << 3,
  ID_REMAP_NO_INDIRECT_PROXY_DATA_USAGE = 1 << 4,
  ID_REMAP_SKIP_OVERRIDE_LIBRARY = 1 << 5,
  ID_REMAP_SKIP_USER_CLEAR = 1 << 6,
  ID_REMAP_FORCE_INTERNAL_RUNTIME_POINTERS = 1 << 7,
};
 
/* Note: Requiring new_id to be non-null, this *may* not be the case ultimately,
 * but makes things simpler for now. */
void BKE_libblock_remap_locked(struct Main *bmain,
                               void *old_idv,
                               void *new_idv,
                               const short remap_flags) ATTR_NONNULL(1, 2);
void BKE_libblock_remap(struct Main *bmain, void *old_idv, void *new_idv, const short remap_flags)
    ATTR_NONNULL(1, 2);
 
void BKE_libblock_unlink(struct Main *bmain,
                         void *idv,
                         const bool do_flag_never_null,
                         const bool do_skip_indirect) ATTR_NONNULL();
 
void BKE_libblock_relink_ex(struct Main *bmain,
                            void *idv,
                            void *old_idv,
                            void *new_idv,
                            const short remap_flags) ATTR_NONNULL(1, 2);
 
void BKE_libblock_relink_to_newid(struct ID *id) ATTR_NONNULL();
 
typedef void (*BKE_library_free_notifier_reference_cb)(const void *);
typedef void (*BKE_library_remap_editor_id_reference_cb)(struct ID *, struct ID *);
 
void BKE_library_callback_free_notifier_reference_set(BKE_library_free_notifier_reference_cb func);
void BKE_library_callback_remap_editor_id_reference_set(
    BKE_library_remap_editor_id_reference_cb func);
 
#ifdef __cplusplus
}
#endif