NOD_node_declaration.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <cstdint>
#include <functional>
#include <type_traits>
 
#include "BLI_array.hh"
#include "BLI_map.hh"
#include "BLI_string_ref.hh"
#include "BLI_utildefines.h"
#include "BLI_vector.hh"
 
#include "BLT_translation.hh" /* IWYU pragma: export */
 
#include "DNA_node_types.h"
 
#include "RNA_types.hh"
 
#include "NOD_socket_usage_inference_fwd.hh"
 
struct bContext;
struct bNode;
struct uiLayout;
 
namespace blender::nodes {
 
class NodeDeclarationBuilder;
class PanelDeclaration;
 
enum class InputSocketFieldType : int8_t {
  None,
  IsSupported,
  Implicit,
};
 
enum class OutputSocketFieldType : int8_t {
  None,
  FieldSource,
  DependentField,
  PartiallyDependent,
};

enum class CompositorInputRealizationMode : int8_t {
  None,
  Transforms,
  OperationDomain,
};

class OutputFieldDependency {
 private:
  OutputSocketFieldType type_ = OutputSocketFieldType::None;
  Vector<int> linked_input_indices_;
 
 public:
  static OutputFieldDependency ForFieldSource();
  static OutputFieldDependency ForDataSource();
  static OutputFieldDependency ForDependentField();
  static OutputFieldDependency ForPartiallyDependentField(Vector<int> indices);
 
  OutputSocketFieldType field_type() const;
  Span<int> linked_input_indices() const;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(OutputFieldDependency, type_, linked_input_indices_)
};

struct FieldInferencingInterface {
  Array<InputSocketFieldType> inputs;
  Array<OutputFieldDependency> outputs;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(FieldInferencingInterface, inputs, outputs)
};
 
struct StructureTypeInterface {
  struct OutputDependency {
    StructureType type;
    Array<int> linked_inputs;
 
    BLI_STRUCT_EQUALITY_OPERATORS_2(OutputDependency, type, linked_inputs)
  };
 
  Array<StructureType> inputs;
  Array<OutputDependency> outputs;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(StructureTypeInterface, inputs, outputs)
};
 
namespace anonymous_attribute_lifetime {

struct PropagateRelation {
  int from_geometry_input;
  int to_geometry_output;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(PropagateRelation, from_geometry_input, to_geometry_output)
};

struct ReferenceRelation {
  int from_field_input;
  int to_field_output;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(ReferenceRelation, from_field_input, to_field_output)
};

struct EvalRelation {
  int field_input;
  int geometry_input;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(EvalRelation, field_input, geometry_input)
};

struct AvailableRelation {
  int field_output;
  int geometry_output;
 
  BLI_STRUCT_EQUALITY_OPERATORS_2(AvailableRelation, field_output, geometry_output)
};
 
struct RelationsInNode {
  Vector<PropagateRelation> propagate_relations;
  Vector<ReferenceRelation> reference_relations;
  Vector<EvalRelation> eval_relations;
  Vector<AvailableRelation> available_relations;
  Vector<int> available_on_none;
 
  BLI_STRUCT_EQUALITY_OPERATORS_5(RelationsInNode,
                                  propagate_relations,
                                  reference_relations,
                                  eval_relations,
                                  available_relations,
                                  available_on_none)
};
 
std::ostream &operator<<(std::ostream &stream, const RelationsInNode &relations);
 
}  // namespace anonymous_attribute_lifetime
namespace aal = anonymous_attribute_lifetime;

class ItemDeclaration {
 public:
  const PanelDeclaration *parent = nullptr;
 
  virtual ~ItemDeclaration() = default;
};
 
using ItemDeclarationPtr = std::unique_ptr<ItemDeclaration>;
 
struct SocketNameRNA {
  PointerRNA owner = PointerRNA_NULL;
  std::string property_name;
};
 
struct CustomSocketDrawParams {
  const bContext &C;
  uiLayout &layout;
  bNodeTree &tree;
  bNode &node;
  bNodeSocket &socket;
  PointerRNA node_ptr;
  PointerRNA socket_ptr;
  StringRefNull label;
  const Map<const bNode *, const bNode *> *menu_switch_source_by_index_switch = nullptr;
 
  void draw_standard(uiLayout &layout, std::optional<StringRefNull> label_override = std::nullopt);
};
 
using CustomSocketDrawFn = std::function<void(CustomSocketDrawParams &params)>;
using InputSocketUsageInferenceFn = std::function<std::optional<bool>(
    const socket_usage_inference::InputSocketUsageParams &params)>;

class SocketDeclaration : public ItemDeclaration {
 public:
  std::string name;
  std::string short_label;
  std::string identifier;
  std::string description;
  std::optional<std::string> translation_context;
  eNodeSocketInOut in_out;
  eNodeSocketDatatype socket_type;
  bool optional_label = false;
  bool hide_value = false;
  bool compact = false;
  bool is_multi_input = false;
  bool no_mute_links = false;
  bool is_available = true;
  bool is_attribute_name = false;
  bool is_default_link_socket = false;
  bool align_with_previous_socket = false;
  bool is_panel_toggle = false;
  bool is_layer_name = false;
  bool is_volume_grid_name = false;

  int index = -1;
 
  InputSocketFieldType input_field_type = InputSocketFieldType::None;
  OutputFieldDependency output_field_dependency;
 
  StructureType structure_type = StructureType::Single;
 
 private:
  CompositorInputRealizationMode compositor_realization_mode_ =
      CompositorInputRealizationMode::OperationDomain;

  int compositor_domain_priority_ = -1;

  std::function<void(bNode &)> make_available_fn_;
 
 public:
  NodeDefaultInputType default_input_type = NodeDefaultInputType::NODE_DEFAULT_INPUT_VALUE;
  std::unique_ptr<SocketNameRNA> socket_name_rna;
  std::unique_ptr<CustomSocketDrawFn> custom_draw_fn;
  std::unique_ptr<InputSocketUsageInferenceFn> usage_inference_fn;
 
  friend NodeDeclarationBuilder;
  friend class BaseSocketDeclarationBuilder;
  template<typename SocketDecl> friend class SocketDeclarationBuilder;
 
  ~SocketDeclaration() override = default;
 
  virtual bNodeSocket &build(bNodeTree &ntree, bNode &node) const = 0;
  virtual bool matches(const bNodeSocket &socket) const = 0;
  virtual bNodeSocket &update_or_build(bNodeTree &ntree, bNode &node, bNodeSocket &socket) const;

  virtual bool can_connect(const bNodeSocket &socket) const = 0;

  void make_available(bNode &node) const;
 
  const CompositorInputRealizationMode &compositor_realization_mode() const;
  int compositor_domain_priority() const;
 
 protected:
  void set_common_flags(bNodeSocket &socket) const;
  bool matches_common_data(const bNodeSocket &socket) const;
};
 
class NodeDeclarationBuilder;
class DeclarationListBuilder;
class PanelDeclarationBuilder;
 
class BaseSocketDeclarationBuilder {
 protected:
  bool reference_pass_all_ = false;
  bool field_on_all_ = false;
  bool propagate_from_all_ = false;
  NodeDeclarationBuilder *node_decl_builder_ = nullptr;
  SocketDeclaration *decl_base_ = nullptr;
 
  friend class NodeDeclarationBuilder;
  friend class DeclarationListBuilder;
 
 public:
  virtual ~BaseSocketDeclarationBuilder() = default;
 
  BaseSocketDeclarationBuilder &optional_label(bool value = true);
 
  BaseSocketDeclarationBuilder &hide_value(bool value = true);
 
  BaseSocketDeclarationBuilder &multi_input(bool value = true);
 
  BaseSocketDeclarationBuilder &compact(bool value = true);
 
  BaseSocketDeclarationBuilder &short_label(std::string value = "");
 
  BaseSocketDeclarationBuilder &description(std::string value = "");
 
  BaseSocketDeclarationBuilder &translation_context(
      std::optional<std::string> value = std::nullopt);
 
  BaseSocketDeclarationBuilder &no_muted_links(bool value = true);

  BaseSocketDeclarationBuilder &available(bool value = true);
 
  BaseSocketDeclarationBuilder &is_attribute_name(bool value = true);
 
  BaseSocketDeclarationBuilder &is_default_link_socket(bool value = true);
 
  BaseSocketDeclarationBuilder &default_input_type(NodeDefaultInputType value);

  BaseSocketDeclarationBuilder &supports_field();

  BaseSocketDeclarationBuilder &field_on_all();

  BaseSocketDeclarationBuilder &field_source();

  BaseSocketDeclarationBuilder &implicit_field(NodeDefaultInputType default_input);

  BaseSocketDeclarationBuilder &implicit_field_on_all(NodeDefaultInputType default_input);

  BaseSocketDeclarationBuilder &implicit_field_on(NodeDefaultInputType default_input,
                                                  Span<int> input_indices);

  BaseSocketDeclarationBuilder &field_on(Span<int> indices);

  BaseSocketDeclarationBuilder &dependent_field();

  BaseSocketDeclarationBuilder &dependent_field(Vector<int> input_dependencies);

  BaseSocketDeclarationBuilder &field_source_reference_all();

  BaseSocketDeclarationBuilder &reference_pass(Span<int> input_indices);

  BaseSocketDeclarationBuilder &reference_pass_all();

  BaseSocketDeclarationBuilder &propagate_all();
  BaseSocketDeclarationBuilder &propagate_all_instance_attributes();
 
  BaseSocketDeclarationBuilder &compositor_realization_mode(CompositorInputRealizationMode value);

  BaseSocketDeclarationBuilder &compositor_domain_priority(int priority);

  BaseSocketDeclarationBuilder &make_available(std::function<void(bNode &)> fn);

  BaseSocketDeclarationBuilder &custom_draw(CustomSocketDrawFn fn);

  BaseSocketDeclarationBuilder &usage_inference(InputSocketUsageInferenceFn fn);

  BaseSocketDeclarationBuilder &usage_by_single_menu(const int menu_value);

  BaseSocketDeclarationBuilder &usage_by_menu(const StringRef menu_input_identifier,
                                              const int menu_value);

  BaseSocketDeclarationBuilder &usage_by_menu(const StringRef menu_input_identifier,
                                              const Array<int> menu_values);

  BaseSocketDeclarationBuilder &align_with_previous(bool value = true);

  BaseSocketDeclarationBuilder &socket_name_ptr(PointerRNA ptr, StringRef property_name);
  BaseSocketDeclarationBuilder &socket_name_ptr(const ID *id,
                                                const StructRNA *srna,
                                                const void *data,
                                                StringRef property_name);
  BaseSocketDeclarationBuilder &panel_toggle(bool value = true);
 
  BaseSocketDeclarationBuilder &structure_type(StructureType structure_type);
 
  BaseSocketDeclarationBuilder &is_layer_name(bool value = true);
  BaseSocketDeclarationBuilder &is_volume_grid_name(bool value = true);

  int index() const;
 
  bool is_input() const;
  bool is_output() const;
};

template<typename SocketDecl>
class SocketDeclarationBuilder : public BaseSocketDeclarationBuilder {
 protected:
  using Self = typename SocketDecl::Builder;
  static_assert(std::is_base_of_v<SocketDeclaration, SocketDecl>);
  SocketDecl *decl_;
 
  friend class NodeDeclarationBuilder;
  friend class DeclarationListBuilder;
};
 
using SocketDeclarationPtr = std::unique_ptr<SocketDeclaration>;
 
using DrawNodeLayoutFn = void(uiLayout *, bContext *, PointerRNA *);
 
class SeparatorDeclaration : public ItemDeclaration {};
 
class LayoutDeclaration : public ItemDeclaration {
 public:
  std::function<DrawNodeLayoutFn> draw;
  bool is_default = false;
};

class PanelDeclaration : public ItemDeclaration {
 public:
  int identifier;
  std::string name;
  std::string description;
  std::optional<std::string> translation_context;
  bool default_collapsed = false;
  Vector<ItemDeclaration *> items;
  int index = -1;
  PanelDeclaration *parent_panel = nullptr;
 
 private:
  friend NodeDeclarationBuilder;
  friend class PanelDeclarationBuilder;
 
 public:
  ~PanelDeclaration() override = default;
 
  void build(bNodePanelState &panel) const;
  bool matches(const bNodePanelState &panel) const;
  void update_or_build(const bNodePanelState &old_panel, bNodePanelState &new_panel) const;
 
  int depth() const;

  const SocketDeclaration *panel_input_decl() const;
};

class DeclarationListBuilder {
 public:
  NodeDeclarationBuilder &node_decl_builder;
  Vector<ItemDeclaration *> &items;
  PanelDeclaration *parent_panel_decl = nullptr;
 
  DeclarationListBuilder(NodeDeclarationBuilder &node_decl_builder,
                         Vector<ItemDeclaration *> &items)
      : node_decl_builder(node_decl_builder), items(items)
  {
  }
 
  template<typename DeclType>
  typename DeclType::Builder &add_socket(StringRef name,
                                         StringRef identifier,
                                         eNodeSocketInOut in_out);
 
  template<typename DeclType>
  typename DeclType::Builder &add_input(StringRef name, StringRef identifier = "");
  template<typename DeclType>
  typename DeclType::Builder &add_output(StringRef name, StringRef identifier = "");
 
  BaseSocketDeclarationBuilder &add_input(eNodeSocketDatatype socket_type,
                                          StringRef name,
                                          StringRef identifier = "");
  BaseSocketDeclarationBuilder &add_input(eCustomDataType data_type,
                                          StringRef name,
                                          StringRef identifier = "");
  BaseSocketDeclarationBuilder &add_output(eNodeSocketDatatype socket_type,
                                           StringRef name,
                                           StringRef identifier = "");
  BaseSocketDeclarationBuilder &add_output(eCustomDataType data_type,
                                           StringRef name,
                                           StringRef identifier = "");
 
  PanelDeclarationBuilder &add_panel(StringRef name, int identifier = -1);
 
  void add_separator();
  void add_default_layout();
  void add_layout(std::function<void(uiLayout *, bContext *, PointerRNA *)> draw);
};
 
class PanelDeclarationBuilder : public DeclarationListBuilder {
 protected:
  using Self = PanelDeclarationBuilder;
  PanelDeclaration *decl_;
 
  friend class NodeDeclarationBuilder;
 
 public:
  PanelDeclarationBuilder(NodeDeclarationBuilder &node_builder, PanelDeclaration &decl)
      : DeclarationListBuilder(node_builder, decl.items), decl_(&decl)
  {
    this->parent_panel_decl = &decl;
  }
 
  Self &description(std::string value = "");
  Self &translation_context(std::optional<std::string> value = std::nullopt);
  Self &default_closed(bool closed);
};
 
using PanelDeclarationPtr = std::unique_ptr<PanelDeclaration>;
 
class NodeDeclaration {
 public:
  Vector<ItemDeclarationPtr> all_items;
  Vector<ItemDeclaration *> root_items;
  Vector<SocketDeclaration *> inputs;
  Vector<SocketDeclaration *> outputs;
  Vector<PanelDeclaration *> panels;
  std::unique_ptr<aal::RelationsInNode> anonymous_attribute_relations_;

  bool skip_updating_sockets = false;

  bool use_custom_socket_order = false;

  bool allow_any_socket_order = false;

  bool is_context_dependent = false;
 
  friend NodeDeclarationBuilder;

  void assert_valid() const;
 
  bool matches(const bNode &node) const;
  Span<SocketDeclaration *> sockets(eNodeSocketInOut in_out) const;
 
  const aal::RelationsInNode *anonymous_attribute_relations() const
  {
    return anonymous_attribute_relations_.get();
  }
 
  MEM_CXX_CLASS_ALLOC_FUNCS("NodeDeclaration")
};
 
class NodeDeclarationBuilder : public DeclarationListBuilder {
 private:
  const bke::bNodeType &typeinfo_;
  NodeDeclaration &declaration_;
  const bNodeTree *ntree_ = nullptr;
  const bNode *node_ = nullptr;
  Vector<std::unique_ptr<BaseSocketDeclarationBuilder>> socket_builders_;
  Vector<BaseSocketDeclarationBuilder *> input_socket_builders_;
  Vector<BaseSocketDeclarationBuilder *> output_socket_builders_;
  Vector<std::unique_ptr<PanelDeclarationBuilder>> panel_builders_;
  bool is_function_node_ = false;
 
  friend DeclarationListBuilder;
 
 public:
  NodeDeclarationBuilder(const bke::bNodeType &typeinfo,
                         NodeDeclaration &declaration,
                         const bNodeTree *ntree = nullptr,
                         const bNode *node = nullptr);
 
  const bNode *node_or_null() const
  {
    declaration_.is_context_dependent = true;
    return node_;
  }
 
  const bNodeTree *tree_or_null() const
  {
    declaration_.is_context_dependent = true;
    return ntree_;
  }

  void is_function_node()
  {
    is_function_node_ = true;
  }
 
  void finalize();
 
  void use_custom_socket_order(bool enable = true);
  void allow_any_socket_order(bool enable = true);
 
  aal::RelationsInNode &get_anonymous_attribute_relations()
  {
    if (!declaration_.anonymous_attribute_relations_) {
      declaration_.anonymous_attribute_relations_ = std::make_unique<aal::RelationsInNode>();
    }
    return *declaration_.anonymous_attribute_relations_;
  }
 
  NodeDeclaration &declaration()
  {
    return declaration_;
  }
 
 private:
  void build_remaining_anonymous_attribute_relations();
};
 
using ImplicitInputValueFn = std::function<void(const bNode &node, void *r_value)>;
std::optional<ImplicitInputValueFn> get_implicit_input_value_fn(NodeDefaultInputType type);
bool socket_type_supports_default_input_type(const bke::bNodeSocketType &socket_type,
                                             NodeDefaultInputType input_type);
 
void build_node_declaration(const bke::bNodeType &typeinfo,
                            NodeDeclaration &r_declaration,
                            const bNodeTree *ntree,
                            const bNode *node);
 
std::unique_ptr<SocketDeclaration> make_declaration_for_socket_type(
    eNodeSocketDatatype socket_type);
 
/* -------------------------------------------------------------------- */
 
template<typename DeclType>
inline typename DeclType::Builder &DeclarationListBuilder::add_input(StringRef name,
                                                                     StringRef identifier)
{
  return this->add_socket<DeclType>(name, identifier, SOCK_IN);
}
 
template<typename DeclType>
inline typename DeclType::Builder &DeclarationListBuilder::add_output(StringRef name,
                                                                      StringRef identifier)
{
  return this->add_socket<DeclType>(name, identifier, SOCK_OUT);
}
 
template<typename DeclType>
inline typename DeclType::Builder &DeclarationListBuilder::add_socket(StringRef name,
                                                                      StringRef identifier,
                                                                      eNodeSocketInOut in_out)
{
  static_assert(std::is_base_of_v<SocketDeclaration, DeclType>);
  using SocketBuilder = typename DeclType::Builder;
 
  BLI_assert(ELEM(in_out, SOCK_IN, SOCK_OUT));
 
  std::unique_ptr<SocketBuilder> socket_decl_builder_ptr = std::make_unique<SocketBuilder>();
  SocketBuilder &socket_decl_builder = *socket_decl_builder_ptr;
  this->node_decl_builder.socket_builders_.append(std::move(socket_decl_builder_ptr));
 
  std::unique_ptr<DeclType> socket_decl_ptr = std::make_unique<DeclType>();
  DeclType &socket_decl = *socket_decl_ptr;
  this->node_decl_builder.declaration_.all_items.append(std::move(socket_decl_ptr));
  this->items.append(&socket_decl);
 
  socket_decl.parent = this->parent_panel_decl;
  socket_decl_builder.node_decl_builder_ = &this->node_decl_builder;
 
  socket_decl_builder.decl_ = &socket_decl;
  socket_decl_builder.decl_base_ = &socket_decl;
  socket_decl.name = name;
  socket_decl.identifier = identifier.is_empty() ? name : identifier;
  socket_decl.in_out = in_out;
  socket_decl.socket_type = DeclType::static_socket_type;
 
  if (this->node_decl_builder.is_function_node_) {
    if (in_out == SOCK_IN) {
      socket_decl_builder.supports_field();
    }
    else {
      socket_decl_builder.dependent_field();
    }
  }
 
  if (in_out == SOCK_IN) {
    this->node_decl_builder.input_socket_builders_.append(&socket_decl_builder);
    socket_decl.index = this->node_decl_builder.declaration_.inputs.append_and_get_index(
        &socket_decl);
  }
  else {
    this->node_decl_builder.output_socket_builders_.append(&socket_decl_builder);
    socket_decl.index = this->node_decl_builder.declaration_.outputs.append_and_get_index(
        &socket_decl);
  }
  return socket_decl_builder;
}

 
/* -------------------------------------------------------------------- */
 
inline int BaseSocketDeclarationBuilder::index() const
{
  return decl_base_->index;
}
 
inline bool BaseSocketDeclarationBuilder::is_input() const
{
  return decl_base_->in_out == SOCK_IN;
}
 
inline bool BaseSocketDeclarationBuilder::is_output() const
{
  return decl_base_->in_out == SOCK_OUT;
}

 
}  // namespace blender::nodes