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 CXXRecordDecl *finalizeForwardDeclaration() { return Record; }
69 BuiltinTypeDeclBuilder &completeDefinition();
70
71 BuiltinTypeDeclBuilder &
72 addMemberVariable(StringRef Name, QualType Type, llvm::ArrayRef<Attr *> Attrs,
73 AccessSpecifier Access = AccessSpecifier::AS_private);
74
75 BuiltinTypeDeclBuilder &
76 addBufferHandles(ResourceClass RC, bool IsROV, bool RawBuffer,
77 bool HasCounter,
78 AccessSpecifier Access = AccessSpecifier::AS_private);
79 BuiltinTypeDeclBuilder &
80 addTextureHandle(ResourceClass RC, bool IsROV, ResourceDimension RD,
81 AccessSpecifier Access = AccessSpecifier::AS_private);
82 BuiltinTypeDeclBuilder &addSamplerHandle();
83 BuiltinTypeDeclBuilder &addArraySubscriptOperators();
84
85 // Builtin types constructors
86 BuiltinTypeDeclBuilder &addDefaultHandleConstructor();
87 BuiltinTypeDeclBuilder &addCopyConstructor();
88 BuiltinTypeDeclBuilder &addCopyAssignmentOperator();
89
90 // Static create methods
91 BuiltinTypeDeclBuilder &addStaticInitializationFunctions(bool HasCounter);
92
93 // Builtin types methods
94 BuiltinTypeDeclBuilder &addLoadMethods();
95 BuiltinTypeDeclBuilder &addSampleMethods(ResourceDimension Dim);
96 BuiltinTypeDeclBuilder &addIncrementCounterMethod();
97 BuiltinTypeDeclBuilder &addDecrementCounterMethod();
98 BuiltinTypeDeclBuilder &addHandleAccessFunction(DeclarationName &Name,
99 bool IsConst, bool IsRef);
100 BuiltinTypeDeclBuilder &addLoadWithStatusFunction(DeclarationName &Name,
101 bool IsConst);
102 BuiltinTypeDeclBuilder &addAppendMethod();
103 BuiltinTypeDeclBuilder &addConsumeMethod();
104
105 BuiltinTypeDeclBuilder &addGetDimensionsMethodForBuffer();
106
107private:
108 BuiltinTypeDeclBuilder &addCreateFromBinding();
109 BuiltinTypeDeclBuilder &addCreateFromImplicitBinding();
110 BuiltinTypeDeclBuilder &addCreateFromBindingWithImplicitCounter();
111 BuiltinTypeDeclBuilder &addCreateFromImplicitBindingWithImplicitCounter();
112 BuiltinTypeDeclBuilder &addResourceMember(StringRef MemberName,
113 ResourceClass RC,
114 ResourceDimension RD, bool IsROV,
115 bool RawBuffer, bool IsCounter,
116 AccessSpecifier Access);
117 BuiltinTypeDeclBuilder &
118 addHandleMember(ResourceClass RC, ResourceDimension RD, bool IsROV,
119 bool RawBuffer,
120 AccessSpecifier Access = AccessSpecifier::AS_private);
121 BuiltinTypeDeclBuilder &
122 addCounterHandleMember(ResourceClass RC, bool IsROV, bool RawBuffer,
123 AccessSpecifier Access = AccessSpecifier::AS_private);
124 FieldDecl *getResourceHandleField() const;
125 FieldDecl *getResourceCounterHandleField() const;
126 QualType getFirstTemplateTypeParam();
127 QualType getHandleElementType();
128 Expr *getConstantIntExpr(int value);
129 HLSLAttributedResourceType::Attributes getResourceAttrs() const;
130};
131
132} // namespace hlsl
133
134} // namespace clang
135
136#endif // LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
137