OpenVDB  7.2.0
VolumeComputeGenerator.h
Go to the documentation of this file.
1 // Copyright Contributors to the OpenVDB Project
2 // SPDX-License-Identifier: MPL-2.0
3 
11 
12 #ifndef OPENVDB_AX_VOLUME_COMPUTE_GENERATOR_HAS_BEEN_INCLUDED
13 #define OPENVDB_AX_VOLUME_COMPUTE_GENERATOR_HAS_BEEN_INCLUDED
14 
15 #include "ComputeGenerator.h"
16 #include "FunctionTypes.h"
17 
18 #include "../compiler/AttributeRegistry.h"
19 
20 #include <openvdb/version.h>
21 
22 namespace openvdb {
24 namespace OPENVDB_VERSION_NAME {
25 
26 namespace ax {
27 namespace codegen {
28 
45 {
46  // The signature of the generated function
47  using Signature =
48  void(const void* const,
49  const int32_t (*)[3],
50  const float (*)[3],
51  void**,
52  void**,
53  int64_t,
54  void*);
55 
57  static const size_t N_ARGS = FunctionTraitsT::N_ARGS;
58 
59  static const std::array<std::string, N_ARGS>& argumentKeys();
60  static std::string getDefaultName();
61 };
62 
63 
66 
67 namespace codegen_internal {
68 
73 {
80  VolumeComputeGenerator(llvm::Module& module,
81  const FunctionOptions& options,
82  FunctionRegistry& functionRegistry,
83  Logger& logger);
84 
85  ~VolumeComputeGenerator() override = default;
86 
87  using ComputeGenerator::traverse;
88  using ComputeGenerator::visit;
89 
90  AttributeRegistry::Ptr generate(const ast::Tree& node);
91  bool visit(const ast::Attribute*) override;
92 
93 private:
94  llvm::Value* accessorHandleFromToken(const std::string&);
95  void getAccessorValue(const std::string&, llvm::Value*);
96 };
97 
98 } // namespace codegen_internal
99 
100 } // namespace codegen
101 } // namespace ax
102 } // namespace OPENVDB_VERSION_NAME
103 } // namespace openvdb
104 
105 #endif // OPENVDB_AX_VOLUME_COMPUTE_GENERATOR_HAS_BEEN_INCLUDED
106 
Options that control how functions behave.
Definition: CompilerOptions.h:24
Templated function traits which provides compile-time index access to the types of the function signa...
Definition: ax/openvdb_ax/codegen/Types.h:279
The core visitor framework for code generation.
A Tree is the highest concrete (non-abstract) node in the entire AX AST hierarchy. It represents an entire conversion of a valid AX string.
Definition: AST.h:561
Contains frameworks for creating custom AX functions which can be registered within the FunctionRegis...
The function definition and signature which is built by the VolumeComputeGenerator.
Definition: VolumeComputeGenerator.h:44
void(const void *const, const int32_t(*)[3], const float(*)[3], void **, void **, int64_t, void *) Signature
Definition: VolumeComputeGenerator.h:54
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:94
Definition: openvdb/Exceptions.h:13
Attributes represent any access to a primitive value, typically associated with the &#39;@&#39; symbol syntax...
Definition: AST.h:1873
std::shared_ptr< AttributeRegistry > Ptr
Definition: AttributeRegistry.h:39
Library and file format version numbers.
The function registry which is used for function code generation. Each time a function is visited wit...
Definition: FunctionRegistry.h:36
Visitor object which will generate llvm IR for a syntax tree which has been generated from AX that ta...
Definition: VolumeComputeGenerator.h:72
Visitor object which will generate llvm IR for a syntax tree. This provides the majority of the code ...
Definition: ComputeGenerator.h:83
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:146
Logger for collecting errors and warnings that occur during AX compilation.
Definition: Logger.h:54