path: root/source/blender/blenkernel/BKE_derived_node_tree.hh

/*
 * 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.
 */

#ifndef __BKE_DERIVED_NODE_TREE_HH__
#define __BKE_DERIVED_NODE_TREE_HH__

/** \file
 * \ingroup bke
 *
 * DerivedNodeTree provides a flattened view on a bNodeTree, i.e. node groups are inlined. It
 * builds on top of NodeTreeRef and supports similar queries efficiently.
 *
 * Every inlined node remembers its path to the parent ("call stack").
 *
 * Unlinked group node inputs are handled separately from other sockets.
 *
 * There is a dot graph exporter for debugging purposes.
 */

#include "BKE_node_tree_ref.hh"

namespace blender {
namespace bke {

class DSocket;
class DInputSocket;
class DOutputSocket;
class DNode;
class DParentNode;
class DGroupInput;
class DerivedNodeTree;

class DSocket : NonCopyable, NonMovable {
 protected:
  DNode *m_node;
  const SocketRef *m_socket_ref;
  uint m_id;

  friend DerivedNodeTree;

 public:
  const DNode &node() const;

  uint id() const;
  uint index() const;

  bool is_input() const;
  bool is_output() const;

  const DSocket &as_base() const;
  const DInputSocket &as_input() const;
  const DOutputSocket &as_output() const;

  PointerRNA *rna() const;
  StringRefNull idname() const;
  StringRefNull name() const;

  const SocketRef &socket_ref() const;
  bNodeSocket *bsocket() const;

  bool is_available() const;
};

class DInputSocket : public DSocket {
 private:
  Vector<DOutputSocket *> m_linked_sockets;
  Vector<DGroupInput *> m_linked_group_inputs;

  friend DerivedNodeTree;

 public:
  const InputSocketRef &socket_ref() const;

  Span<const DOutputSocket *> linked_sockets() const;
  Span<const DGroupInput *> linked_group_inputs() const;

  bool is_linked() const;
};

class DOutputSocket : public DSocket {
 private:
  Vector<DInputSocket *> m_linked_sockets;

  friend DerivedNodeTree;

 public:
  const OutputSocketRef &socket_ref() const;
  Span<const DInputSocket *> linked_sockets() const;
};

class DGroupInput : NonCopyable, NonMovable {
 private:
  const InputSocketRef *m_socket_ref;
  DParentNode *m_parent;
  Vector<DInputSocket *> m_linked_sockets;
  uint m_id;

  friend DerivedNodeTree;

 public:
  const InputSocketRef &socket_ref() const;
  bNodeSocket *bsocket() const;
  const DParentNode *parent() const;
  Span<const DInputSocket *> linked_sockets() const;
  uint id() const;
  StringRefNull name() const;
};

class DNode : NonCopyable, NonMovable {
 private:
  const NodeRef *m_node_ref;
  DParentNode *m_parent;

  Span<DInputSocket *> m_inputs;
  Span<DOutputSocket *> m_outputs;

  uint m_id;

  friend DerivedNodeTree;

 public:
  const NodeRef &node_ref() const;
  const DParentNode *parent() const;

  Span<const DInputSocket *> inputs() const;
  Span<const DOutputSocket *> outputs() const;

  const DInputSocket &input(uint index) const;
  const DOutputSocket &output(uint index) const;

  uint id() const;

  PointerRNA *rna() const;
  StringRefNull idname() const;
  StringRefNull name() const;

 private:
  void destruct_with_sockets();
};

class DParentNode : NonCopyable, NonMovable {
 private:
  const NodeRef *m_node_ref;
  DParentNode *m_parent;
  uint m_id;

  friend DerivedNodeTree;

 public:
  const DParentNode *parent() const;
  const NodeRef &node_ref() const;
  uint id() const;
};

using NodeTreeRefMap = Map<bNodeTree *, std::unique_ptr<const NodeTreeRef>>;

class DerivedNodeTree : NonCopyable, NonMovable {
 private:
  LinearAllocator<> m_allocator;
  bNodeTree *m_btree;
  Vector<DNode *> m_nodes_by_id;
  Vector<DGroupInput *> m_group_inputs;
  Vector<DParentNode *> m_parent_nodes;

  Vector<DSocket *> m_sockets_by_id;
  Vector<DInputSocket *> m_input_sockets;
  Vector<DOutputSocket *> m_output_sockets;

  Map<const bNodeType *, Vector<DNode *>> m_nodes_by_type;

 public:
  DerivedNodeTree(bNodeTree *btree, NodeTreeRefMap &node_tree_refs);
  ~DerivedNodeTree();

  Span<const DNode *> nodes() const;
  Span<const DNode *> nodes_by_type(StringRefNull idname) const;
  Span<const DNode *> nodes_by_type(const bNodeType *nodetype) const;

  Span<const DSocket *> sockets() const;
  Span<const DInputSocket *> input_sockets() const;
  Span<const DOutputSocket *> output_sockets() const;

  Span<const DGroupInput *> group_inputs() const;

  std::string to_dot() const;

 private:
  /* Utility functions used during construction. */
  void insert_nodes_and_links_in_id_order(const NodeTreeRef &tree_ref,
                                          DParentNode *parent,
                                          Vector<DNode *> &all_nodes);
  DNode &create_node(const NodeRef &node_ref,
                     DParentNode *parent,
                     MutableSpan<DSocket *> r_sockets_map);
  void expand_groups(Vector<DNode *> &all_nodes,
                     Vector<DGroupInput *> &all_group_inputs,
                     Vector<DParentNode *> &all_parent_nodes,
                     NodeTreeRefMap &node_tree_refs);
  void expand_group_node(DNode &group_node,
                         Vector<DNode *> &all_nodes,
                         Vector<DGroupInput *> &all_group_inputs,
                         Vector<DParentNode *> &all_parent_nodes,
                         NodeTreeRefMap &node_tree_refs);
  void create_group_inputs_for_unlinked_inputs(DNode &node,
                                               Vector<DGroupInput *> &all_group_inputs);
  void relink_group_inputs(const NodeTreeRef &group_ref,
                           Span<DNode *> nodes_by_id,
                           DNode &group_node);
  void relink_group_outputs(const NodeTreeRef &group_ref,
                            Span<DNode *> nodes_by_id,
                            DNode &group_node);
  void remove_expanded_group_interfaces(Vector<DNode *> &all_nodes);
  void remove_unused_group_inputs(Vector<DGroupInput *> &all_group_inputs);
  void store_in_this_and_init_ids(Vector<DNode *> &&all_nodes,
                                  Vector<DGroupInput *> &&all_group_inputs,
                                  Vector<DParentNode *> &&all_parent_nodes);
};

/* --------------------------------------------------------------------
 * DSocket inline methods.
 */

inline const DNode &DSocket::node() const
{
  return *m_node;
}

inline uint DSocket::id() const
{
  return m_id;
}

inline uint DSocket::index() const
{
  return m_socket_ref->index();
}

inline bool DSocket::is_input() const
{
  return m_socket_ref->is_input();
}

inline bool DSocket::is_output() const
{
  return m_socket_ref->is_output();
}

inline const DSocket &DSocket::as_base() const
{
  return *this;
}

inline const DInputSocket &DSocket::as_input() const
{
  return *(DInputSocket *)this;
}

inline const DOutputSocket &DSocket::as_output() const
{
  return *(DOutputSocket *)this;
}

inline PointerRNA *DSocket::rna() const
{
  return m_socket_ref->rna();
}

inline StringRefNull DSocket::idname() const
{
  return m_socket_ref->idname();
}

inline StringRefNull DSocket::name() const
{
  return m_socket_ref->name();
}

inline const SocketRef &DSocket::socket_ref() const
{
  return *m_socket_ref;
}

inline bNodeSocket *DSocket::bsocket() const
{
  return m_socket_ref->bsocket();
}

inline bool DSocket::is_available() const
{
  return (m_socket_ref->bsocket()->flag & SOCK_UNAVAIL) == 0;
}

/* --------------------------------------------------------------------
 * DInputSocket inline methods.
 */

inline const InputSocketRef &DInputSocket::socket_ref() const
{
  return m_socket_ref->as_input();
}

inline Span<const DOutputSocket *> DInputSocket::linked_sockets() const
{
  return m_linked_sockets.as_span();
}

inline Span<const DGroupInput *> DInputSocket::linked_group_inputs() const
{
  return m_linked_group_inputs.as_span();
}

inline bool DInputSocket::is_linked() const
{
  return m_linked_sockets.size() > 0 || m_linked_group_inputs.size() > 0;
}

/* --------------------------------------------------------------------
 * DOutputSocket inline methods.
 */

inline const OutputSocketRef &DOutputSocket::socket_ref() const
{
  return m_socket_ref->as_output();
}

inline Span<const DInputSocket *> DOutputSocket::linked_sockets() const
{
  return m_linked_sockets.as_span();
}

/* --------------------------------------------------------------------
 * DGroupInput inline methods.
 */

inline const InputSocketRef &DGroupInput::socket_ref() const
{
  return *m_socket_ref;
}

inline bNodeSocket *DGroupInput::bsocket() const
{
  return m_socket_ref->bsocket();
}

inline const DParentNode *DGroupInput::parent() const
{
  return m_parent;
}

inline Span<const DInputSocket *> DGroupInput::linked_sockets() const
{
  return m_linked_sockets.as_span();
}

inline uint DGroupInput::id() const
{
  return m_id;
}

inline StringRefNull DGroupInput::name() const
{
  return m_socket_ref->name();
}

/* --------------------------------------------------------------------
 * DNode inline methods.
 */

inline const NodeRef &DNode::node_ref() const
{
  return *m_node_ref;
}

inline const DParentNode *DNode::parent() const
{
  return m_parent;
}

inline Span<const DInputSocket *> DNode::inputs() const
{
  return m_inputs;
}

inline Span<const DOutputSocket *> DNode::outputs() const
{
  return m_outputs;
}

inline const DInputSocket &DNode::input(uint index) const
{
  return *m_inputs[index];
}

inline const DOutputSocket &DNode::output(uint index) const
{
  return *m_outputs[index];
}

inline uint DNode::id() const
{
  return m_id;
}

inline PointerRNA *DNode::rna() const
{
  return m_node_ref->rna();
}

inline StringRefNull DNode::idname() const
{
  return m_node_ref->idname();
}

inline StringRefNull DNode::name() const
{
  return m_node_ref->name();
}

/* --------------------------------------------------------------------
 * DParentNode inline methods.
 */

inline const DParentNode *DParentNode::parent() const
{
  return m_parent;
}

inline const NodeRef &DParentNode::node_ref() const
{
  return *m_node_ref;
}

inline uint DParentNode::id() const
{
  return m_id;
}

/* --------------------------------------------------------------------
 * DerivedNodeTree inline methods.
 */

inline Span<const DNode *> DerivedNodeTree::nodes() const
{
  return m_nodes_by_id.as_span();
}

inline Span<const DNode *> DerivedNodeTree::nodes_by_type(StringRefNull idname) const
{
  const bNodeType *nodetype = nodeTypeFind(idname.data());
  return this->nodes_by_type(nodetype);
}

inline Span<const DNode *> DerivedNodeTree::nodes_by_type(const bNodeType *nodetype) const
{
  const Vector<DNode *> *nodes = m_nodes_by_type.lookup_ptr(nodetype);
  if (nodes == nullptr) {
    return {};
  }
  else {
    return nodes->as_span();
  }
}

inline Span<const DSocket *> DerivedNodeTree::sockets() const
{
  return m_sockets_by_id.as_span();
}

inline Span<const DInputSocket *> DerivedNodeTree::input_sockets() const
{
  return m_input_sockets.as_span();
}

inline Span<const DOutputSocket *> DerivedNodeTree::output_sockets() const
{
  return m_output_sockets.as_span();
}

inline Span<const DGroupInput *> DerivedNodeTree::group_inputs() const
{
  return m_group_inputs.as_span();
}

}  // namespace bke
}  // namespace blender

#endif /* __BKE_DERIVED_NODE_TREE_HH__ */