1//===--- HLSLBuiltinTypeDeclBuilder.h - HLSL Builtin Type Decl Builder ---===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Helper classes for creating HLSL builtin class types. Used by external HLSL
10// sema source.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
15#define LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
16
17#include "clang/AST/Type.h"
18#include "clang/Sema/Sema.h"
19#include "llvm/ADT/StringMap.h"
20
21using llvm::hlsl::ResourceClass;
22using llvm::hlsl::ResourceDimension;
23
24namespace clang {
25
26class ClassTemplateDecl;
27class NamespaceDecl;
28class CXXRecordDecl;
29class FieldDecl;
30
31namespace hlsl {
32
33// Builder for builtin HLSL class types such as HLSL resource classes.
34// Allows creating declaration of builtin types using the builder pattern
35// like this:
36//
37// Decl = BuiltinTypeDeclBuilder(Sema, Namespace, "BuiltinClassName")
38// .addSimpleTemplateParams({"T"}, Concept)
39// .finalizeForwardDeclaration();
40//
41// And then completing the type like this:
42//
43// BuiltinTypeDeclBuilder(Sema, Decl)
44// .addDefaultHandleConstructor();
45// .addLoadMethods()
46// .completeDefinition();
47//
48class BuiltinTypeDeclBuilder {
49private:
50 Sema &SemaRef;
51 CXXRecordDecl *Record = nullptr;
52 ClassTemplateDecl *Template = nullptr;
53 ClassTemplateDecl *PrevTemplate = nullptr;
54 NamespaceDecl *HLSLNamespace = nullptr;
55 llvm::StringMap<FieldDecl *> Fields;
56
57public:
58 friend struct TemplateParameterListBuilder;
59 friend struct BuiltinTypeMethodBuilder;
60
61 BuiltinTypeDeclBuilder(Sema &SemaRef, CXXRecordDecl *R);
62 BuiltinTypeDeclBuilder(Sema &SemaRef, NamespaceDecl *Namespace,
63 StringRef Name);
64 ~BuiltinTypeDeclBuilder();
65
66 BuiltinTypeDeclBuilder &addSimpleTemplateParams(ArrayRef<StringRef> Names,
67 ConceptDecl *CD = nullptr);
68 BuiltinTypeDeclBuilder &
69 addSimpleTemplateParams(ArrayRef<StringRef> Names,
70 ArrayRef<QualType> DefaultTypes, ConceptDecl *CD);
71 CXXRecordDecl *finalizeForwardDeclaration() { return Record; }
72 BuiltinTypeDeclBuilder &completeDefinition();
73
74 BuiltinTypeDeclBuilder &
75 addMemberVariable(StringRef Name, QualType Type, llvm::ArrayRef<Attr *> Attrs,
76 AccessSpecifier Access = AccessSpecifier::AS_private);
77
78 BuiltinTypeDeclBuilder &
79 addBufferHandles(ResourceClass RC, bool IsROV, bool RawBuffer,
80 bool HasCounter,
81 AccessSpecifier Access = AccessSpecifier::AS_private);
82 BuiltinTypeDeclBuilder &
83 addTextureHandle(ResourceClass RC, bool IsROV, bool IsArray,
84 ResourceDimension RD,
85 AccessSpecifier Access = AccessSpecifier::AS_private);
86 BuiltinTypeDeclBuilder &addSamplerHandle();
87 BuiltinTypeDeclBuilder &addConstantBufferConversionToType();
88 BuiltinTypeDeclBuilder &
89 addArraySubscriptOperators(ResourceDimension Dim = ResourceDimension::Unknown,
90 bool IsArray = false);
91
92 // Builtin types constructors
93 BuiltinTypeDeclBuilder &addDefaultHandleConstructor(
94 AccessSpecifier Access = AccessSpecifier::AS_public);
95 BuiltinTypeDeclBuilder &
96 addCopyConstructor(AccessSpecifier Access = AccessSpecifier::AS_public);
97 BuiltinTypeDeclBuilder &addCopyAssignmentOperator(
98 AccessSpecifier Access = AccessSpecifier::AS_public);
99
100 // Static create methods
101 BuiltinTypeDeclBuilder &addStaticInitializationFunctions(bool HasCounter);
102
103 // Builtin types methods
104 BuiltinTypeDeclBuilder &addLoadMethods();
105 BuiltinTypeDeclBuilder &addTextureLoadMethods(ResourceDimension Dim,
106 bool IsArray = false);
107 BuiltinTypeDeclBuilder &addByteAddressBufferLoadMethods();
108 BuiltinTypeDeclBuilder &addByteAddressBufferStoreMethods();
109 BuiltinTypeDeclBuilder &addSampleMethods(ResourceDimension Dim,
110 bool IsArray = false);
111 BuiltinTypeDeclBuilder &addSampleBiasMethods(ResourceDimension Dim,
112 bool IsArray = false);
113 BuiltinTypeDeclBuilder &addSampleGradMethods(ResourceDimension Dim,
114 bool IsArray = false);
115 BuiltinTypeDeclBuilder &addSampleLevelMethods(ResourceDimension Dim,
116 bool IsArray = false);
117 BuiltinTypeDeclBuilder &addSampleCmpMethods(ResourceDimension Dim,
118 bool IsArray = false);
119 BuiltinTypeDeclBuilder &addSampleCmpLevelZeroMethods(ResourceDimension Dim,
120 bool IsArray = false);
121 BuiltinTypeDeclBuilder &addCalculateLodMethods(ResourceDimension Dim);
122 BuiltinTypeDeclBuilder &addGatherMethods(ResourceDimension Dim,
123 bool IsArray = false);
124 BuiltinTypeDeclBuilder &addGatherCmpMethods(ResourceDimension Dim,
125 bool IsArray = false);
126 BuiltinTypeDeclBuilder &addIncrementCounterMethod();
127 BuiltinTypeDeclBuilder &addDecrementCounterMethod();
128 BuiltinTypeDeclBuilder &addHandleAccessFunction(DeclarationName &Name,
129 bool IsConstReturn,
130 bool IsRef, QualType IndexTy,
131 QualType ElemTy = QualType());
132 BuiltinTypeDeclBuilder &
133 addLoadWithStatusFunction(DeclarationName &Name,
134 QualType ReturnTy = QualType());
135 BuiltinTypeDeclBuilder &addStoreFunction(DeclarationName &Name, bool IsConst,
136 QualType ValueType);
137 BuiltinTypeDeclBuilder &addAppendMethod();
138 BuiltinTypeDeclBuilder &addConsumeMethod();
139
140 BuiltinTypeDeclBuilder &addGetDimensionsMethodForBuffer();
141 BuiltinTypeDeclBuilder &addGetDimensionsMethods(ResourceDimension Dim);
142 BuiltinTypeDeclBuilder &addMipsMember(ResourceDimension Dim);
143
144private:
145 BuiltinTypeDeclBuilder &addCreateFromBinding();
146 BuiltinTypeDeclBuilder &addCreateFromImplicitBinding();
147 BuiltinTypeDeclBuilder &addCreateFromBindingWithImplicitCounter();
148 BuiltinTypeDeclBuilder &addCreateFromImplicitBindingWithImplicitCounter();
149 BuiltinTypeDeclBuilder &
150 addResourceMember(StringRef MemberName, ResourceClass RC,
151 ResourceDimension RD, bool IsROV, bool RawBuffer,
152 bool IsCounter, bool IsArray, QualType ElementTy,
153 AccessSpecifier Access = AccessSpecifier::AS_private);
154 BuiltinTypeDeclBuilder &addFriend(CXXRecordDecl *Friend);
155 CXXRecordDecl *addPrivateNestedRecord(StringRef Name);
156 CXXRecordDecl *addMipsSliceType(ResourceDimension Dim, QualType ReturnType);
157 CXXRecordDecl *addMipsType(ResourceDimension Dim, QualType ReturnType);
158 BuiltinTypeDeclBuilder &
159 addHandleMember(ResourceClass RC, ResourceDimension RD, bool IsROV,
160 bool RawBuffer, bool IsArray, QualType ElementTy,
161 AccessSpecifier Access = AccessSpecifier::AS_private);
162 BuiltinTypeDeclBuilder &
163 addCounterHandleMember(ResourceClass RC, bool IsROV, bool RawBuffer,
164 QualType ElementTy,
165 AccessSpecifier Access = AccessSpecifier::AS_private);
166 QualType getGatherReturnType();
167 FieldDecl *getResourceHandleField() const;
168 FieldDecl *getResourceCounterHandleField() const;
169 QualType getFirstTemplateTypeParam();
170 QualType getHandleElementType();
171 Expr *getConstantIntExpr(int value);
172 Expr *getConstantUnsignedIntExpr(unsigned value);
173 HLSLAttributedResourceType::Attributes getResourceAttrs() const;
174};
175
176} // namespace hlsl
177
178} // namespace clang
179
180#endif // LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
181