BKE_node.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <optional>
 
#include "BLI_compiler_compat.h"
#include "BLI_span.hh"
 
#include "BKE_node_socket_value_fwd.hh"
#include "BKE_volume_enums.hh"
 
/* for FOREACH_NODETREE_BEGIN */
#include "DNA_node_types.h"
 
#include "RNA_types.hh"
 
#include "BLI_map.hh"
#include "BLI_string_ref.hh"
 
/* not very important, but the stack solver likes to know a maximum */
#define MAX_SOCKET 512
 
struct BlendDataReader;
struct BlendWriter;
struct FreestyleLineStyle;
struct GPUMaterial;
struct GPUNodeStack;
struct ID;
struct ImBuf;
struct LibraryForeachIDData;
struct Light;
struct Main;
struct Material;
struct PointerRNA;
struct Scene;
struct SpaceNode;
struct Tex;
struct World;
struct bContext;
struct bNode;
struct bNodeExecContext;
struct bNodeTreeExec;
struct bNodeExecData;
struct bNodeLink;
struct bNodeSocket;
struct bNodeStack;
struct bNodeTree;
struct bNodeTreeExec;
struct uiLayout;
 
namespace blender {
class CPPType;
namespace nodes {
class DNode;
class NodeMultiFunctionBuilder;
class GeoNodeExecParams;
class NodeDeclaration;
class NodeDeclarationBuilder;
class GatherAddNodeSearchParams;
class GatherLinkSearchOpParams;
struct NodeExtraInfoParams;
namespace value_elem {
class InverseElemEvalParams;
class ElemEvalParams;
}  // namespace value_elem
namespace inverse_eval {
class InverseEvalParams;
}  // namespace inverse_eval
}  // namespace nodes
namespace compositor {
class Context;
class NodeOperation;
}  // namespace compositor
}  // namespace blender
 
namespace blender::bke {
 
/* -------------------------------------------------------------------- */

struct bNodeSocketTemplate {
  int type;
  char name[/*MAX_NAME*/ 64];
  float val1, val2, val3, val4;
  float min, max;
  int subtype;
  int flag;
 
  /* After this line is used internal only. */

  bNodeSocket *sock;
  char identifier[/*MAX_NAME*/ 64];
};
 
/* Use `void *` for callbacks that require C++. This is rather ugly, but works well for now. This
 * would not be necessary if we would use bNodeSocketType and bNodeType only in C++ code.
 * However, achieving this requires quite a few changes currently. */
using NodeMultiFunctionBuildFunction = void (*)(blender::nodes::NodeMultiFunctionBuilder &builder);
using NodeGeometryExecFunction = void (*)(blender::nodes::GeoNodeExecParams params);
using NodeDeclareFunction = void (*)(blender::nodes::NodeDeclarationBuilder &builder);
using NodeDeclareDynamicFunction = void (*)(const bNodeTree &tree,
                                            const bNode &node,
                                            blender::nodes::NodeDeclarationBuilder &builder);
using SocketGetCPPValueFunction = void (*)(const void *socket_value, void *r_value);
using SocketGetGeometryNodesCPPValueFunction = SocketValueVariant (*)(const void *socket_value);
 
/* Adds socket link operations that are specific to this node type. */
using NodeGatherSocketLinkOperationsFunction =
    void (*)(blender::nodes::GatherLinkSearchOpParams &params);
 
/* Adds node add menu operations that are specific to this node type. */
using NodeGatherAddOperationsFunction =
    void (*)(blender::nodes::GatherAddNodeSearchParams &params);
 
using NodeGetCompositorOperationFunction =
    blender::compositor::NodeOperation *(*)(blender::compositor::Context & context,
                                            blender::nodes::DNode node);
using NodeExtraInfoFunction = void (*)(blender::nodes::NodeExtraInfoParams &params);
using NodeInverseElemEvalFunction =
    void (*)(blender::nodes::value_elem::InverseElemEvalParams &params);
using NodeElemEvalFunction = void (*)(blender::nodes::value_elem::ElemEvalParams &params);
using NodeInverseEvalFunction = void (*)(blender::nodes::inverse_eval::InverseEvalParams &params);
using NodeInternallyLinkedInputFunction = const bNodeSocket *(*)(const bNodeTree &tree,
                                                                 const bNode &node,
                                                                 const bNodeSocket &output_socket);
using NodeBlendWriteFunction = void (*)(const bNodeTree &tree,
                                        const bNode &node,
                                        BlendWriter &writer);
using NodeBlendDataReadFunction = void (*)(bNodeTree &tree, bNode &node, BlendDataReader &reader);

struct bNodeSocketType {
  std::string idname;
  std::string label;
  std::string subtype_label;
 
  void (*draw)(bContext *C,
               uiLayout *layout,
               PointerRNA *ptr,
               PointerRNA *node_ptr,
               StringRef text) = nullptr;
  void (*draw_color)(bContext *C, PointerRNA *ptr, PointerRNA *node_ptr, float *r_color) = nullptr;
  void (*draw_color_simple)(const bNodeSocketType *socket_type, float *r_color) = nullptr;
 
  void (*interface_draw)(ID *id,
                         bNodeTreeInterfaceSocket *socket,
                         bContext *C,
                         uiLayout *layout) = nullptr;
  void (*interface_init_socket)(ID *id,
                                const bNodeTreeInterfaceSocket *interface_socket,
                                bNode *node,
                                bNodeSocket *socket,
                                StringRefNull data_path) = nullptr;
  void (*interface_from_socket)(ID *id,
                                bNodeTreeInterfaceSocket *interface_socket,
                                const bNode *node,
                                const bNodeSocket *socket) = nullptr;
 
  /* RNA integration */
  ExtensionRNA ext_socket = {};
  ExtensionRNA ext_interface = {};
 
  /* for standard socket types in C */
  eNodeSocketDatatype type = eNodeSocketDatatype(0);
  int subtype = 0;
 
  /* When set, bNodeSocket->limit does not have any effect anymore. */
  bool use_link_limits_of_type = false;
  int input_link_limit = 0;
  int output_link_limit = 0;
 
  /* Callback to free the socket type. */
  void (*free_self)(bNodeSocketType *stype) = nullptr;
 
  /* Return the CPPType of this socket. */
  const blender::CPPType *base_cpp_type = nullptr;
  /* Get the value of this socket in a generic way. */
  SocketGetCPPValueFunction get_base_cpp_value = nullptr;
  /* Get geometry nodes cpp value. */
  SocketGetGeometryNodesCPPValueFunction get_geometry_nodes_cpp_value = nullptr;
  /* Default value for this socket type. */
  const SocketValueVariant *geometry_nodes_default_value = nullptr;
};
 
using NodeInitExecFunction = void *(*)(bNodeExecContext * context,
                                       bNode *node,
                                       bNodeInstanceKey key);
using NodeFreeExecFunction = void (*)(void *nodedata);
using NodeExecFunction = void (*)(
    void *data, int thread, bNode *, bNodeExecData *execdata, bNodeStack **in, bNodeStack **out);
using NodeGPUExecFunction = int (*)(
    GPUMaterial *mat, bNode *node, bNodeExecData *execdata, GPUNodeStack *in, GPUNodeStack *out);
using NodeMaterialXFunction = void (*)(void *data, bNode *node, bNodeSocket *out);
 
struct NodeInsertLinkParams {
  bNodeTree &ntree;
  bNode &node;
  bNodeLink &link;
  bContext *C = nullptr;
};

struct bNodeType {
  std::string idname;
  int type_legacy;
 
  std::string ui_name;
  std::string ui_description;
  int ui_icon;
  const char *enum_name_legacy = nullptr;
 
  float width = 0.0f, minwidth = 0.0f, maxwidth = 0.0f;
  float height = 0.0f, minheight = 0.0f, maxheight = 0.0f;
  short nclass = 0, flag = 0;
 
  /* templates for static sockets */
  bNodeSocketTemplate *inputs = nullptr, *outputs = nullptr;
 
  std::string storagename; /* struct name for DNA */
 
  /* Draw the option buttons on the node */
  void (*draw_buttons)(uiLayout *, bContext *C, PointerRNA *ptr) = nullptr;
  /* Additional parameters in the side panel */
  void (*draw_buttons_ex)(uiLayout *, bContext *C, PointerRNA *ptr) = nullptr;
 
  /* Additional drawing on backdrop */
  void (*draw_backdrop)(SpaceNode *snode, ImBuf *backdrop, bNode *node, int x, int y) = nullptr;

  void (*labelfunc)(const bNodeTree *ntree,
                    const bNode *node,
                    char *label,
                    int label_maxncpy) = nullptr;

  int (*ui_class)(const bNode *node) = nullptr;
  std::string (*ui_description_fn)(const bNode &node) = nullptr;

  void (*updatefunc)(bNodeTree *ntree, bNode *node) = nullptr;

  void (*initfunc)(bNodeTree *ntree, bNode *node) = nullptr;
  void (*freefunc)(bNode *node) = nullptr;
  void (*copyfunc)(bNodeTree *dest_ntree, bNode *dest_node, const bNode *src_node) = nullptr;
 
  /* Registerable API callback versions, called in addition to C callbacks */
  void (*initfunc_api)(const bContext *C, PointerRNA *ptr) = nullptr;
  void (*freefunc_api)(PointerRNA *ptr) = nullptr;
  void (*copyfunc_api)(PointerRNA *ptr, const bNode *src_node) = nullptr;

  bool (*add_ui_poll)(const bContext *C) = nullptr;

  bool (*poll)(const bNodeType *ntype,
               const bNodeTree *nodetree,
               const char **r_disabled_hint) = nullptr;
  bool (*poll_instance)(const bNode *node,
                        const bNodeTree *nodetree,
                        const char **r_disabled_hint) = nullptr;
 
  /* Optional handling of link insertion. Returns false if the link shouldn't be created. */
  bool (*insert_link)(NodeInsertLinkParams &params) = nullptr;
 
  void (*free_self)(bNodeType *ntype) = nullptr;
 
  /* **** execution callbacks **** */
  NodeInitExecFunction init_exec_fn = nullptr;
  NodeFreeExecFunction free_exec_fn = nullptr;
  NodeExecFunction exec_fn = nullptr;
  /* gpu */
  NodeGPUExecFunction gpu_fn = nullptr;
  /* MaterialX */
  NodeMaterialXFunction materialx_fn = nullptr;
 
  /* Get an instance of this node's compositor operation. Freeing the instance is the
   * responsibility of the caller. */
  NodeGetCompositorOperationFunction get_compositor_operation = nullptr;
 
  /* Build a multi-function for this node. */
  NodeMultiFunctionBuildFunction build_multi_function = nullptr;
 
  /* Execute a geometry node. */
  NodeGeometryExecFunction geometry_node_execute = nullptr;

  NodeDeclareFunction declare = nullptr;

  blender::nodes::NodeDeclaration *static_declaration = nullptr;

  NodeGatherSocketLinkOperationsFunction gather_link_search_ops = nullptr;

  NodeExtraInfoFunction get_extra_info = nullptr;

  NodeInternallyLinkedInputFunction internally_linked_input = nullptr;

  NodeBlendWriteFunction blend_write_storage_content = nullptr;
  NodeBlendDataReadFunction blend_data_read_storage_content = nullptr;

  NodeElemEvalFunction eval_elem = nullptr;

  NodeInverseElemEvalFunction eval_inverse_elem = nullptr;

  NodeInverseEvalFunction eval_inverse = nullptr;

  void (*register_operators)() = nullptr;

  bool no_muting = false;
  bool ignore_inferred_input_socket_visibility = false;
  const char *deprecation_notice = nullptr;

  bool (*can_sync_sockets)(const bContext &C, const bNodeTree &tree, const bNode &node) = nullptr;
 
  /* RNA integration */
  ExtensionRNA rna_ext = {};

  bool is_type(StringRef query_idname) const;
};

#define NODE_CLASS_INPUT 0
#define NODE_CLASS_OUTPUT 1
#define NODE_CLASS_OP_COLOR 3
#define NODE_CLASS_OP_VECTOR 4
#define NODE_CLASS_OP_FILTER 5
#define NODE_CLASS_GROUP 6
#define NODE_CLASS_CONVERTER 8
#define NODE_CLASS_MATTE 9
#define NODE_CLASS_DISTORT 10
#define NODE_CLASS_PATTERN 12
#define NODE_CLASS_TEXTURE 13
#define NODE_CLASS_SCRIPT 32
#define NODE_CLASS_INTERFACE 33
#define NODE_CLASS_SHADER 40
#define NODE_CLASS_GEOMETRY 41
#define NODE_CLASS_ATTRIBUTE 42
#define NODE_CLASS_LAYOUT 100

enum class NodeColorTag {
  None = 0,
  Attribute = 1,
  Color = 2,
  Converter = 3,
  Distort = 4,
  Filter = 5,
  Geometry = 6,
  Input = 7,
  Matte = 8,
  Output = 9,
  Script = 10,
  Shader = 11,
  Texture = 12,
  Vector = 13,
  Pattern = 14,
  Interface = 15,
  Group = 16,
};
 
using bNodeClassCallback = void (*)(void *calldata, int nclass, StringRefNull name);
 
struct bNodeTreeType {
  int type = 0;       /* type identifier */
  std::string idname; /* identifier name */
 
  /* The ID name of group nodes for this type. */
  std::string group_idname;
 
  std::string ui_name;
  std::string ui_description;
  int ui_icon = 0;
 
  /* callbacks */
  /* Iteration over all node classes. */
  void (*foreach_nodeclass)(void *calldata, bNodeClassCallback func) = nullptr;
  /* Check visibility in the node editor */
  bool (*poll)(const bContext *C, bNodeTreeType *ntreetype) = nullptr;
  /* Select a node tree from the context */
  void (*get_from_context)(const bContext *C,
                           bNodeTreeType *ntreetype,
                           bNodeTree **r_ntree,
                           ID **r_id,
                           ID **r_from) = nullptr;
 
  /* calls allowing threaded composite */
  void (*localize)(bNodeTree *localtree, bNodeTree *ntree) = nullptr;
  void (*local_merge)(Main *bmain, bNodeTree *localtree, bNodeTree *ntree) = nullptr;
 
  /* Tree update. Overrides `nodetype->updatetreefunc`. */
  void (*update)(bNodeTree *ntree) = nullptr;
 
  bool (*validate_link)(eNodeSocketDatatype from, eNodeSocketDatatype to) = nullptr;
 
  void (*node_add_init)(bNodeTree *ntree, bNode *bnode) = nullptr;
 
  /* Check if the socket type is valid for this tree type. */
  bool (*valid_socket_type)(bNodeTreeType *ntreetype, bNodeSocketType *socket_type) = nullptr;

  uint8_t no_group_interface = 0;
 
  /* RNA integration */
  ExtensionRNA rna_ext = {};
};

 
/* -------------------------------------------------------------------- */
 
bNodeTreeType *node_tree_type_find(StringRef idname);
void node_tree_type_add(bNodeTreeType &nt);
void node_tree_type_free_link(const bNodeTreeType &nt);
bool node_tree_is_registered(const bNodeTree &ntree);
 
Span<bNodeTreeType *> node_tree_types_get();

void node_tree_set_type(bNodeTree &ntree);
 
bNodeTree *node_tree_add_tree(Main *bmain, StringRef name, StringRef idname);

bNodeTree *node_tree_add_in_lib(Main *bmain,
                                Library *owner_library,
                                StringRefNull name,
                                StringRefNull idname);

void node_tree_free_embedded_tree(bNodeTree *ntree);

bNodeTree **node_tree_ptr_from_id(ID *id);

bNodeTree *node_tree_from_id(ID *id);

bool node_tree_contains_tree(const bNodeTree &tree_to_search_in,
                             const bNodeTree &tree_to_search_for);
 
void node_tree_update_all_users(Main *main, ID *id);

void node_tree_set_output(bNodeTree &ntree);

bNodeTree *node_tree_localize(bNodeTree *ntree, std::optional<ID *> new_owner_id);

void node_tree_blend_write(BlendWriter *writer, bNodeTree *ntree);

 
/* -------------------------------------------------------------------- */
 
bNodeType *node_type_find(StringRef idname);
StringRefNull node_type_find_alias(StringRefNull alias);
void node_register_type(bNodeType &ntype);
void node_unregister_type(bNodeType &ntype);
void node_register_alias(bNodeType &nt, StringRef alias);
 
Span<bNodeType *> node_types_get();
 
bNodeSocketType *node_socket_type_find(StringRef idname);
bNodeSocketType *node_socket_type_find_static(int type, int subtype = 0);
void node_register_socket_type(bNodeSocketType &stype);
void node_unregister_socket_type(bNodeSocketType &stype);
bool node_socket_is_registered(const bNodeSocket &sock);
StringRefNull node_socket_type_label(const bNodeSocketType &stype);
 
/* The optional dimensions argument can be provided for types that support multiple possible
 * dimensions like Vector. It is expected to be in the range [2, 4] and if not provided, 3 will be
 * assumed. */
std::optional<StringRefNull> node_static_socket_type(int type,
                                                     int subtype,
                                                     std::optional<int> dimensions = std::nullopt);
std::optional<StringRefNull> node_static_socket_interface_type_new(
    int type, int subtype, std::optional<int> dimensions = std::nullopt);
 
std::optional<StringRefNull> node_static_socket_label(int type, int subtype);
 
Span<bNodeSocketType *> node_socket_types_get();
 
bNodeSocket *node_find_socket(bNode &node, eNodeSocketInOut in_out, StringRef identifier);
const bNodeSocket *node_find_socket(const bNode &node,
                                    eNodeSocketInOut in_out,
                                    StringRef identifier);
bNodeSocket *node_add_socket(bNodeTree &ntree,
                             bNode &node,
                             eNodeSocketInOut in_out,
                             StringRefNull idname,
                             StringRefNull identifier,
                             StringRefNull name);
bNodeSocket *node_add_static_socket(bNodeTree &ntree,
                                    bNode &node,
                                    eNodeSocketInOut in_out,
                                    int type,
                                    int subtype,
                                    StringRefNull identifier,
                                    StringRefNull name);
void node_remove_socket(bNodeTree &ntree, bNode &node, bNodeSocket &sock);
 
void node_modify_socket_type_static(
    bNodeTree *ntree, bNode *node, bNodeSocket *sock, int type, int subtype);
 
bNode *node_add_node(const bContext *C,
                     bNodeTree &ntree,
                     StringRef idname,
                     std::optional<int> unique_identifier = std::nullopt);
bNode *node_add_static_node(const bContext *C, bNodeTree &ntree, int type);

void node_unique_name(bNodeTree &ntree, bNode &node);
void node_unique_id(bNodeTree &ntree, bNode &node);

void node_remove_node(
    Main *bmain, bNodeTree &ntree, bNode &node, bool do_id_user, bool remove_animation = true);
 
float2 node_dimensions_get(const bNode &node);
void node_tag_update_id(bNode &node);
void node_internal_links(bNode &node, bNodeLink **r_links, int *r_len);

bNodeLink &node_add_link(
    bNodeTree &ntree, bNode &fromnode, bNodeSocket &fromsock, bNode &tonode, bNodeSocket &tosock);
void node_remove_link(bNodeTree *ntree, bNodeLink &link);
void node_remove_socket_links(bNodeTree &ntree, bNodeSocket &sock);
 
bool node_link_is_hidden(const bNodeLink &link);
 
void node_attach_node(bNodeTree &ntree, bNode &node, bNode &parent);
void node_detach_node(bNodeTree &ntree, bNode &node);

bNode *node_find_node_try(bNodeTree &ntree, bNodeSocket &socket);

bNode &node_find_node(bNodeTree &ntree, bNodeSocket &socket);
const bNode &node_find_node(const bNodeTree &ntree, const bNodeSocket &socket);

bNode *node_find_node_by_name(bNodeTree &ntree, StringRefNull name);

const bNodeTreeInterfaceSocket *node_find_interface_input_by_identifier(const bNodeTree &ntree,
                                                                        StringRef identifier);
 
bool node_is_parent_and_child(const bNode &parent, const bNode &child);
 
int node_count_socket_links(const bNodeTree &ntree, const bNodeSocket &sock);

bool node_set_selected(bNode &node, bool select);
void node_set_active(bNodeTree &ntree, bNode &node);
bNode *node_get_active(bNodeTree &ntree);
void node_clear_active(bNodeTree &ntree);
bNode *node_get_active_texture(bNodeTree &ntree);
 
int node_socket_link_limit(const bNodeSocket &sock);

extern const bNodeInstanceKey NODE_INSTANCE_KEY_BASE;
extern const bNodeInstanceKey NODE_INSTANCE_KEY_NONE;
 
bNodeInstanceKey node_instance_key(bNodeInstanceKey parent_key,
                                   const bNodeTree *ntree,
                                   const bNode *node);

 
/* -------------------------------------------------------------------- */
 
bool node_group_poll(const bNodeTree *nodetree,
                     const bNodeTree *grouptree,
                     const char **r_disabled_hint);
 
void node_type_base_custom(bNodeType &ntype,
                           StringRefNull idname,
                           StringRefNull name,
                           StringRefNull enum_name,
                           short nclass);

void node_type_storage(bNodeType &ntype,
                       std::optional<StringRefNull> storagename,
                       void (*freefunc)(bNode *node),
                       void (*copyfunc)(bNodeTree *dest_ntree,
                                        bNode *dest_node,
                                        const bNode *src_node));

 
/* -------------------------------------------------------------------- */
 
#define NODE_UNDEFINED -2 /* node type is not registered */
#define NODE_CUSTOM -1    /* for dynamically registered custom types */
#define NODE_GROUP 2
#define NODE_FRAME 5
#define NODE_REROUTE 6
#define NODE_GROUP_INPUT 7
#define NODE_GROUP_OUTPUT 8
#define NODE_CUSTOM_GROUP 9
 
#define NODE_LEGACY_TYPE_GENERATION_START 5000

 
/* -------------------------------------------------------------------- */
 
/* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */
struct NodeTreeIterStore {
  bNodeTree *ngroup;
  Scene *scene;
  Material *mat;
  Tex *tex;
  Light *light;
  World *world;
  FreestyleLineStyle *linestyle;
};
 
void node_tree_iterator_init(NodeTreeIterStore *ntreeiter, Main *bmain);
bool node_tree_iterator_step(NodeTreeIterStore *ntreeiter, bNodeTree **r_nodetree, ID **r_id);
 
#define FOREACH_NODETREE_BEGIN(bmain, _nodetree, _id) \
  { \
    blender::bke::NodeTreeIterStore _nstore; \
    bNodeTree *_nodetree; \
    ID *_id; \
    /* avoid compiler warning about unused variables */ \
    blender::bke::node_tree_iterator_init(&_nstore, bmain); \
    while (blender::bke::node_tree_iterator_step(&_nstore, &_nodetree, &_id) == true) { \
      if (_nodetree) {
 
#define FOREACH_NODETREE_END \
  } \
  } \
  } \
  ((void)0)

 
/* -------------------------------------------------------------------- */
 
void node_tree_remove_layer_n(bNodeTree *ntree, Scene *scene, int layer_index);
 
void node_system_init();
void node_system_exit();
 
bNodeTree *node_tree_add_tree_embedded(Main *bmain,
                                       ID *owner_id,
                                       StringRefNull name,
                                       StringRefNull idname);
 
/* Copy/free functions, need to manage ID users. */

void node_tree_free_tree(bNodeTree &ntree);
 
bNodeTree *node_tree_copy_tree_ex(const bNodeTree &ntree, Main *bmain, bool do_id_user);
bNodeTree *node_tree_copy_tree(Main *bmain, const bNodeTree &ntree);
 
void node_tree_free_local_node(bNodeTree &ntree, bNode &node);
 
void node_tree_update_all_new(Main &main);

void node_update_asset_metadata(bNodeTree &node_tree);
 
void node_tree_node_flag_set(bNodeTree &ntree, int flag, bool enable);

void node_tree_local_merge(Main *bmain, bNodeTree *localtree, bNodeTree *ntree);

void node_tree_blend_read_data(BlendDataReader *reader, ID *owner_id, bNodeTree *ntree);
 
bool node_is_static_socket_type(const bNodeSocketType &stype);
 
StringRefNull node_socket_sub_type_label(int subtype);
 
void node_remove_socket_ex(bNodeTree &ntree, bNode &node, bNodeSocket &sock, bool do_id_user);
 
void node_modify_socket_type(bNodeTree &ntree,
                             bNode &node,
                             bNodeSocket &sock,
                             StringRefNull idname);

void node_unlink_node(bNodeTree &ntree, bNode &node);
 
void node_unlink_attached(bNodeTree *ntree, const bNode *parent);

void node_rebuild_id_vector(bNodeTree &node_tree);

bNode *node_copy_with_mapping(bNodeTree *dst_tree,
                              const bNode &node_src,
                              int flag,
                              std::optional<StringRefNull> dst_unique_name,
                              std::optional<int> dst_unique_identifier,
                              Map<const bNodeSocket *, bNodeSocket *> &new_socket_map,
                              bool allow_duplicate_names = false);

void node_socket_move_default_value(Main &bmain,
                                    bNodeTree &tree,
                                    bNodeSocket &src,
                                    bNodeSocket &dst);

void node_free_node(bNodeTree *tree, bNode &node);

void node_node_foreach_id(bNode *node, LibraryForeachIDData *data);

void node_link_set_mute(bNodeTree &ntree, bNodeLink &link, const bool muted);
 
bool node_link_is_selected(const bNodeLink &link);
 
void node_internal_relink(bNodeTree &ntree, bNode &node);
 
void node_position_relative(bNode &from_node,
                            const bNode &to_node,
                            const bNodeSocket *from_sock,
                            const bNodeSocket &to_sock);
 
void node_position_propagate(bNode &node);

bNode *node_find_root_parent(bNode &node);

void node_chain_iterator(const bNodeTree *ntree,
                         const bNode *node_start,
                         bool (*callback)(bNode *, bNode *, void *, const bool),
                         void *userdata,
                         bool reversed);

void node_chain_iterator_backwards(const bNodeTree *ntree,
                                   bNode *node_start,
                                   bool (*callback)(bNode *, bNode *, void *),
                                   void *userdata,
                                   int recursion_lvl);

void node_parents_iterator(bNode *node, bool (*callback)(bNode *, void *), void *userdata);

bool node_is_dangling_reroute(const bNodeTree &ntree, const bNode &node);
 
bNode *node_get_active_paint_canvas(bNodeTree &ntree);

bool node_supports_active_flag(const bNode &node, int sub_activity);
 
void node_set_socket_availability(bNodeTree &ntree, bNodeSocket &sock, bool is_available);

bool node_declaration_ensure(bNodeTree &ntree, bNode &node);

bool node_declaration_ensure_on_outdated_node(bNodeTree &ntree, bNode &node);

void node_socket_declarations_update(bNode *node);
 
/* Node Previews */
bool node_preview_used(const bNode &node);
 
struct bNodePreview {
  ImBuf *ibuf = nullptr;
 
  bNodePreview() = default;
  bNodePreview(const bNodePreview &other);
  bNodePreview(bNodePreview &&other);
  ~bNodePreview();
};
 
bNodePreview *node_preview_verify(Map<bNodeInstanceKey, bNodePreview> &previews,
                                  bNodeInstanceKey key,
                                  int xsize,
                                  int ysize,
                                  bool create);
 
void node_preview_init_tree(bNodeTree *ntree, int xsize, int ysize);
 
void node_preview_remove_unused(bNodeTree *ntree);
 
void node_preview_merge_tree(bNodeTree *to_ntree, bNodeTree *from_ntree, bool remove_old);
 
/* -------------------------------------------------------------------- */
 
std::string node_label(const bNodeTree &ntree, const bNode &node);

StringRefNull node_socket_label(const bNodeSocket &sock);

std::optional<StringRefNull> node_socket_short_label(const bNodeSocket &sock);

const char *node_socket_translation_context(const bNodeSocket &sock);
 
NodeColorTag node_color_tag(const bNode &node);

void node_type_base(bNodeType &ntype,
                    std::string idname,
                    std::optional<int16_t> legacy_type = std::nullopt);
 
void node_type_socket_templates(bNodeType *ntype,
                                bNodeSocketTemplate *inputs,
                                bNodeSocketTemplate *outputs);
 
void node_type_size(bNodeType &ntype, int width, int minwidth, int maxwidth);
 
enum class eNodeSizePreset : int8_t {
  Default,
  Small,
  Middle,
  Large,
};
 
void node_type_size_preset(bNodeType &ntype, eNodeSizePreset size);
 
/* -------------------------------------------------------------------- */
 
bool node_is_connected_to_output(const bNodeTree &ntree, const bNode &node);
 
bNodeSocket *node_find_enabled_socket(bNode &node, eNodeSocketInOut in_out, StringRef name);
 
bNodeSocket *node_find_enabled_input_socket(bNode &node, StringRef name);
 
bNodeSocket *node_find_enabled_output_socket(bNode &node, StringRef name);
 
extern bNodeTreeType NodeTreeTypeUndefined;
extern bNodeType NodeTypeUndefined;
extern bNodeSocketType NodeSocketTypeUndefined;
 
std::optional<eCustomDataType> socket_type_to_custom_data_type(eNodeSocketDatatype type);
std::optional<eNodeSocketDatatype> custom_data_type_to_socket_type(eCustomDataType type);
const CPPType *socket_type_to_geo_nodes_base_cpp_type(eNodeSocketDatatype type);
std::optional<eNodeSocketDatatype> geo_nodes_base_cpp_type_to_socket_type(const CPPType &type);
std::optional<VolumeGridType> socket_type_to_grid_type(eNodeSocketDatatype type);
std::optional<eNodeSocketDatatype> grid_type_to_socket_type(VolumeGridType type);

 */
class bNodeZoneType {
 public:
  std::string input_idname;
  std::string output_idname;
  int input_type;
  int output_type;
  int theme_id;
 
  virtual ~bNodeZoneType() = default;
 
  virtual const int &get_corresponding_output_id(const bNode &input_bnode) const = 0;
 
  int &get_corresponding_output_id(bNode &input_bnode) const
  {
    return const_cast<int &>(
        this->get_corresponding_output_id(const_cast<const bNode &>(input_bnode)));
  }
 
  const bNode *get_corresponding_input(const bNodeTree &tree, const bNode &output_bnode) const;
  bNode *get_corresponding_input(bNodeTree &tree, const bNode &output_bnode) const;
 
  const bNode *get_corresponding_output(const bNodeTree &tree, const bNode &input_bnode) const;
  bNode *get_corresponding_output(bNodeTree &tree, const bNode &input_bnode) const;
};
 
void register_node_zone_type(const bNodeZoneType &zone_type);
 
Span<const bNodeZoneType *> all_zone_types();
Span<int> all_zone_node_types();
Span<int> all_zone_input_node_types();
Span<int> all_zone_output_node_types();
const bNodeZoneType *zone_type_by_node_type(const int node_type);
 
inline bool bNodeType::is_type(const StringRef query_idname) const
{
  /* Ensure that the given idname exists to check for typos. */
  BLI_assert(node_type_find(query_idname) != nullptr);
  return this->idname == query_idname;
}
 
}  // namespace blender::bke
 
#define NODE_STORAGE_FUNCS(StorageT) \
  [[maybe_unused]] static StorageT &node_storage(bNode &node) \
  { \
    return *static_cast<StorageT *>(node.storage); \
  } \
  [[maybe_unused]] static const StorageT &node_storage(const bNode &node) \
  { \
    return *static_cast<const StorageT *>(node.storage); \
  }
 
constexpr int NODE_DEFAULT_MAX_WIDTH = 700;
constexpr int GROUP_NODE_DEFAULT_WIDTH = 140;
constexpr int GROUP_NODE_MAX_WIDTH = NODE_DEFAULT_MAX_WIDTH;
constexpr int GROUP_NODE_MIN_WIDTH = 60;