BKE_node_tree_reference_lifetimes.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once

 
#include "BLI_bit_group_vector.hh"
#include "BLI_vector.hh"
 
#include "DNA_node_types.h"
 
#include "NOD_node_declaration.hh"
 
namespace blender::bke::node_tree_reference_lifetimes {
 
enum class ReferenceSetType {
  GroupOutputData,
  ClosureOutputData,
  GroupInputReferenceSet,
  ClosureInputReferenceSet,
  LocalReferenceSet,
};
 
struct ReferenceSetInfo {
  ReferenceSetType type;
  union {
    int index;
    const bNodeSocket *socket;
  };

  Vector<const bNodeSocket *> potential_data_origins;
 
  ReferenceSetInfo(ReferenceSetType type, const int index) : type(type), index(index)
  {
    BLI_assert(
        ELEM(type, ReferenceSetType::GroupInputReferenceSet, ReferenceSetType::GroupOutputData));
  }
 
  ReferenceSetInfo(ReferenceSetType type, const bNodeSocket *socket) : type(type), socket(socket)
  {
    BLI_assert(ELEM(type,
                    ReferenceSetType::LocalReferenceSet,
                    ReferenceSetType::ClosureInputReferenceSet,
                    ReferenceSetType::ClosureOutputData));
  }
 
  friend std::ostream &operator<<(std::ostream &stream, const ReferenceSetInfo &info);
};
 
struct ReferenceLifetimesInfo {
  Vector<ReferenceSetInfo> reference_sets;

  BitGroupVector<> required_data_by_socket;

  nodes::aal::RelationsInNode tree_relations;
};
 
bool analyse_reference_lifetimes(bNodeTree &tree);

bool can_contain_reference(eNodeSocketDatatype socket_type);
bool can_contain_referenced_data(eNodeSocketDatatype socket_type);
 
}  // namespace blender::bke::node_tree_reference_lifetimes