FN_multi_function.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_hash.hh"
 
#include "FN_multi_function_context.hh"
#include "FN_multi_function_params.hh"
 
namespace blender::fn::multi_function {
 
class MultiFunction : NonCopyable, NonMovable {
 private:
  const Signature *signature_ref_ = nullptr;
 
 public:
  virtual ~MultiFunction() {}
 
  void call_auto(const IndexMask &mask, Params params, Context context) const;
  virtual void call(const IndexMask &mask, Params params, Context context) const = 0;
 
  virtual uint64_t hash() const
  {
    return get_default_hash(this);
  }
 
  virtual bool equals(const MultiFunction & /*other*/) const
  {
    return false;
  }
 
  int param_amount() const
  {
    return signature_ref_->params.size();
  }
 
  IndexRange param_indices() const
  {
    return signature_ref_->params.index_range();
  }
 
  ParamType param_type(int param_index) const
  {
    return signature_ref_->params[param_index].type;
  }
 
  StringRefNull param_name(int param_index) const
  {
    return signature_ref_->params[param_index].name;
  }
 
  StringRefNull name() const
  {
    return signature_ref_->function_name;
  }
 
  virtual std::string debug_name() const;
 
  const Signature &signature() const
  {
    BLI_assert(signature_ref_ != nullptr);
    return *signature_ref_;
  }
 
  struct ExecutionHints {
    int64_t min_grain_size = 10000;
    bool allocates_array = false;
    bool uniform_execution_time = true;
  };
 
  ExecutionHints execution_hints() const;
 
 protected:
  /* Make the function use the given signature. This should be called once in the constructor of
   * child classes. No copy of the signature is made, so the caller has to make sure that the
   * signature lives as long as the multi function. It is ok to embed the signature into the child
   * class. */
  void set_signature(const Signature *signature)
  {
    /* Take a pointer as argument, so that it is more obvious that no copy is created. */
    BLI_assert(signature != nullptr);
    signature_ref_ = signature;
  }
 
  virtual ExecutionHints get_execution_hints() const;
};
 
inline ParamsBuilder::ParamsBuilder(const MultiFunction &fn, const IndexMask *mask)
    : ParamsBuilder(fn.signature(), *mask)
{
}
 
}  // namespace blender::fn::multi_function
 
namespace blender {
namespace mf = fn::multi_function;
}