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);
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, ResourceDimension RD,
84 AccessSpecifier Access = AccessSpecifier::AS_private);
85 BuiltinTypeDeclBuilder &addSamplerHandle();
86 BuiltinTypeDeclBuilder &addArraySubscriptOperators(
87 ResourceDimension Dim = ResourceDimension::Unknown);
88
89 // Builtin types constructors
90 BuiltinTypeDeclBuilder &addDefaultHandleConstructor(
91 AccessSpecifier Access = AccessSpecifier::AS_public);
92 BuiltinTypeDeclBuilder &
93 addCopyConstructor(AccessSpecifier Access = AccessSpecifier::AS_public);
94 BuiltinTypeDeclBuilder &addCopyAssignmentOperator(
95 AccessSpecifier Access = AccessSpecifier::AS_public);
96
97 // Static create methods
98 BuiltinTypeDeclBuilder &addStaticInitializationFunctions(bool HasCounter);
99
100 // Builtin types methods
101 BuiltinTypeDeclBuilder &addLoadMethods();
102 BuiltinTypeDeclBuilder &addTextureLoadMethods(ResourceDimension Dim);
103 BuiltinTypeDeclBuilder &addByteAddressBufferLoadMethods();
104 BuiltinTypeDeclBuilder &addByteAddressBufferStoreMethods();
105 BuiltinTypeDeclBuilder &addSampleMethods(ResourceDimension Dim);
106 BuiltinTypeDeclBuilder &addSampleBiasMethods(ResourceDimension Dim);
107 BuiltinTypeDeclBuilder &addSampleGradMethods(ResourceDimension Dim);
108 BuiltinTypeDeclBuilder &addSampleLevelMethods(ResourceDimension Dim);
109 BuiltinTypeDeclBuilder &addSampleCmpMethods(ResourceDimension Dim);
110 BuiltinTypeDeclBuilder &addSampleCmpLevelZeroMethods(ResourceDimension Dim);
111 BuiltinTypeDeclBuilder &addCalculateLodMethods(ResourceDimension Dim);
112 BuiltinTypeDeclBuilder &addGatherMethods(ResourceDimension Dim);
113 BuiltinTypeDeclBuilder &addGatherCmpMethods(ResourceDimension Dim);
114 BuiltinTypeDeclBuilder &addIncrementCounterMethod();
115 BuiltinTypeDeclBuilder &addDecrementCounterMethod();
116 BuiltinTypeDeclBuilder &addHandleAccessFunction(DeclarationName &Name,
117 bool IsConst, bool IsRef,
118 QualType IndexTy,
119 QualType ElemTy = QualType());
120 BuiltinTypeDeclBuilder &
121 addLoadWithStatusFunction(DeclarationName &Name, bool IsConst,
122 QualType ReturnTy = QualType());
123 BuiltinTypeDeclBuilder &addStoreFunction(DeclarationName &Name, bool IsConst,
124 QualType ValueType);
125 BuiltinTypeDeclBuilder &addAppendMethod();
126 BuiltinTypeDeclBuilder &addConsumeMethod();
127
128 BuiltinTypeDeclBuilder &addGetDimensionsMethodForBuffer();
129 BuiltinTypeDeclBuilder &addGetDimensionsMethods(ResourceDimension Dim);
130 BuiltinTypeDeclBuilder &addMipsMember(ResourceDimension Dim);
131
132private:
133 BuiltinTypeDeclBuilder &addCreateFromBinding();
134 BuiltinTypeDeclBuilder &addCreateFromImplicitBinding();
135 BuiltinTypeDeclBuilder &addCreateFromBindingWithImplicitCounter();
136 BuiltinTypeDeclBuilder &addCreateFromImplicitBindingWithImplicitCounter();
137 BuiltinTypeDeclBuilder &
138 addResourceMember(StringRef MemberName, ResourceClass RC,
139 ResourceDimension RD, bool IsROV, bool RawBuffer,
140 bool IsCounter, QualType ElementTy,
141 AccessSpecifier Access = AccessSpecifier::AS_private);
142 BuiltinTypeDeclBuilder &addFriend(CXXRecordDecl *Friend);
143 CXXRecordDecl *addPrivateNestedRecord(StringRef Name);
144 CXXRecordDecl *addMipsSliceType(ResourceDimension Dim, QualType ReturnType);
145 CXXRecordDecl *addMipsType(ResourceDimension Dim, QualType ReturnType);
146 BuiltinTypeDeclBuilder &
147 addHandleMember(ResourceClass RC, ResourceDimension RD, bool IsROV,
148 bool RawBuffer, QualType ElementTy,
149 AccessSpecifier Access = AccessSpecifier::AS_private);
150 BuiltinTypeDeclBuilder &
151 addCounterHandleMember(ResourceClass RC, bool IsROV, bool RawBuffer,
152 QualType ElementTy,
153 AccessSpecifier Access = AccessSpecifier::AS_private);
154 QualType getGatherReturnType();
155 FieldDecl *getResourceHandleField() const;
156 FieldDecl *getResourceCounterHandleField() const;
157 QualType getFirstTemplateTypeParam();
158 QualType getHandleElementType();
159 Expr *getConstantIntExpr(int value);
160 Expr *getConstantUnsignedIntExpr(unsigned value);
161 HLSLAttributedResourceType::Attributes getResourceAttrs() const;
162};
163
164} // namespace hlsl
165
166} // namespace clang
167
168#endif // LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
169