HLSLBuiltinTypeDeclBuilder.h

Go to the documentation of this file.

//===--- HLSLBuiltinTypeDeclBuilder.h - HLSL Builtin Type Decl Builder  ---===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Helper classes for creating HLSL builtin class types. Used by external HLSL
// sema source.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
#define LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H
 
#include "clang/AST/Type.h"
#include "clang/Sema/Sema.h"
#include "llvm/ADT/StringMap.h"
 
using llvm::hlsl::ResourceClass;
using llvm::hlsl::ResourceDimension;
 
namespace clang {
 
class ClassTemplateDecl;
class NamespaceDecl;
class CXXRecordDecl;
class FieldDecl;
 
namespace hlsl {
 
// Builder for builtin HLSL class types such as HLSL resource classes.
// Allows creating declaration of builtin types using the builder pattern
// like this:
//
//   Decl = BuiltinTypeDeclBuilder(Sema, Namespace, "BuiltinClassName")
//           .addSimpleTemplateParams({"T"}, Concept)
//           .finalizeForwardDeclaration();
//
// And then completing the type like this:
//
//   BuiltinTypeDeclBuilder(Sema, Decl)
//          .addDefaultHandleConstructor();
//          .addLoadMethods()
//          .completeDefinition();
//
class BuiltinTypeDeclBuilder {
private:
  Sema &SemaRef;
  CXXRecordDecl *Record = nullptr;
  ClassTemplateDecl *Template = nullptr;
  ClassTemplateDecl *PrevTemplate = nullptr;
  NamespaceDecl *HLSLNamespace = nullptr;
  llvm::StringMap<FieldDecl *> Fields;
 
public:
  friend struct TemplateParameterListBuilder;
  friend struct BuiltinTypeMethodBuilder;
 
  BuiltinTypeDeclBuilder(Sema &SemaRef, CXXRecordDecl *R);
  BuiltinTypeDeclBuilder(Sema &SemaRef, NamespaceDecl *Namespace,
                         StringRef Name);
  ~BuiltinTypeDeclBuilder();
 
  BuiltinTypeDeclBuilder &addSimpleTemplateParams(ArrayRef<StringRef> Names,
                                                  ConceptDecl *CD = nullptr);
  BuiltinTypeDeclBuilder &
  addSimpleTemplateParams(ArrayRef<StringRef> Names,
                          ArrayRef<QualType> DefaultTypes, ConceptDecl *CD);
  // Adds `<typename element_type, int sample_count = 0>` for multisampled
  // textures, with \p CD constraining the element type. Unlike the other
  // textures the element type has no default argument.
  BuiltinTypeDeclBuilder &addMSTextureTemplateParams(StringRef ElementName,
                                                     StringRef SampleCountName,
                                                     ConceptDecl *CD);
  CXXRecordDecl *finalizeForwardDeclaration() { return Record; }
  BuiltinTypeDeclBuilder &completeDefinition();
 
  BuiltinTypeDeclBuilder &
  addMemberVariable(StringRef Name, QualType Type, llvm::ArrayRef<Attr *> Attrs,
                    AccessSpecifier Access = AccessSpecifier::AS_private);
 
  BuiltinTypeDeclBuilder &
  addBufferHandles(ResourceClass RC, bool IsROV, bool RawBuffer,
                   bool HasCounter,
                   AccessSpecifier Access = AccessSpecifier::AS_private);
  BuiltinTypeDeclBuilder &
  addTextureHandle(ResourceClass RC, bool IsROV, bool IsArray,
                   ResourceDimension RD, Expr *SampleCountExpr = nullptr,
                   AccessSpecifier Access = AccessSpecifier::AS_private);
  BuiltinTypeDeclBuilder &addSamplerHandle();
  BuiltinTypeDeclBuilder &addConstantBufferConversionToType();
  BuiltinTypeDeclBuilder &
  addArraySubscriptOperators(ResourceDimension Dim = ResourceDimension::Unknown,
                             bool IsArray = false);
 
  // Builtin types constructors
  BuiltinTypeDeclBuilder &addDefaultHandleConstructor(
      AccessSpecifier Access = AccessSpecifier::AS_public);
  BuiltinTypeDeclBuilder &
  addHeapResourceInfoConstructor(bool HasCounter = false);
  BuiltinTypeDeclBuilder &addHeapSamplerInfoConstructor();
  BuiltinTypeDeclBuilder &
  addCopyConstructor(AccessSpecifier Access = AccessSpecifier::AS_public);
  BuiltinTypeDeclBuilder &addCopyAssignmentOperator(
      AccessSpecifier Access = AccessSpecifier::AS_public);
 
  // Static create methods
  BuiltinTypeDeclBuilder &addStaticInitializationFunctions(bool HasCounter);
 
  // Builtin types methods
  BuiltinTypeDeclBuilder &addLoadMethods();
  BuiltinTypeDeclBuilder &addTextureLoadMethods(ResourceDimension Dim,
                                                bool IsArray = false);
  BuiltinTypeDeclBuilder &addTextureLoadMSMethods(ResourceDimension Dim,
                                                  bool IsArray = false);
  BuiltinTypeDeclBuilder &addRWTextureLoadMethods(ResourceDimension Dim,
                                                  bool IsArray = false);
  BuiltinTypeDeclBuilder &addByteAddressBufferLoadMethods();
  BuiltinTypeDeclBuilder &addByteAddressBufferStoreMethods();
  BuiltinTypeDeclBuilder &addByteAddressBufferInterlockedMethods();
  BuiltinTypeDeclBuilder &addSampleMethods(ResourceDimension Dim,
                                           bool IsArray = false);
  BuiltinTypeDeclBuilder &addSampleBiasMethods(ResourceDimension Dim,
                                               bool IsArray = false);
  BuiltinTypeDeclBuilder &addSampleGradMethods(ResourceDimension Dim,
                                               bool IsArray = false);
  BuiltinTypeDeclBuilder &addSampleLevelMethods(ResourceDimension Dim,
                                                bool IsArray = false);
  BuiltinTypeDeclBuilder &addSampleCmpMethods(ResourceDimension Dim,
                                              bool IsArray = false);
  BuiltinTypeDeclBuilder &addSampleCmpLevelZeroMethods(ResourceDimension Dim,
                                                       bool IsArray = false);
  BuiltinTypeDeclBuilder &addCalculateLodMethods(ResourceDimension Dim);
  BuiltinTypeDeclBuilder &addGatherMethods(ResourceDimension Dim,
                                           bool IsArray = false);
  BuiltinTypeDeclBuilder &addGatherCmpMethods(ResourceDimension Dim,
                                              bool IsArray = false);
  BuiltinTypeDeclBuilder &addIncrementCounterMethod();
  BuiltinTypeDeclBuilder &addDecrementCounterMethod();
  BuiltinTypeDeclBuilder &addHandleAccessFunction(DeclarationName &Name,
                                                  bool IsConstReturn,
                                                  bool IsRef, QualType IndexTy,
                                                  QualType ElemTy = QualType(),
                                                  bool TransposeResult = false);
  BuiltinTypeDeclBuilder &
  addLoadWithStatusFunction(DeclarationName &Name,
                            QualType ReturnTy = QualType());
  BuiltinTypeDeclBuilder &addStoreFunction(DeclarationName &Name, bool IsConst,
                                           QualType ValueType,
                                           bool TransposeArg = false);
  BuiltinTypeDeclBuilder &
  addByteAddressBufferInterlockedMethod(StringRef MethodName, QualType ValueTy,
                                        StringRef BuiltinName,
                                        bool RequiresOriginalValue = false);
  BuiltinTypeDeclBuilder &addByteAddressBufferInterlockedCompareMethod(
      StringRef MethodName, QualType ValueTy, StringRef BuiltinName,
      bool WithOriginalValue = false);
  BuiltinTypeDeclBuilder &addAppendMethod();
  BuiltinTypeDeclBuilder &addConsumeMethod();
 
  BuiltinTypeDeclBuilder &addGetDimensionsMethodForBuffer();
  BuiltinTypeDeclBuilder &addGetDimensionsMethods(ResourceDimension Dim);
  BuiltinTypeDeclBuilder &addMipsMember(ResourceDimension Dim);
 
private:
  BuiltinTypeDeclBuilder &addCreateFromBinding();
  BuiltinTypeDeclBuilder &addCreateFromImplicitBinding();
  BuiltinTypeDeclBuilder &addCreateFromBindingWithImplicitCounter();
  BuiltinTypeDeclBuilder &addCreateFromImplicitBindingWithImplicitCounter();
  BuiltinTypeDeclBuilder &
  addResourceMember(StringRef MemberName, ResourceClass RC,
                    ResourceDimension RD, bool IsROV, bool RawBuffer,
                    bool IsCounter, bool IsArray, QualType ElementTy,
                    Expr *SampleCountExpr = nullptr,
                    AccessSpecifier Access = AccessSpecifier::AS_private);
  BuiltinTypeDeclBuilder &addFriend(CXXRecordDecl *Friend);
  CXXRecordDecl *addPrivateNestedRecord(StringRef Name);
  CXXRecordDecl *addMipsSliceType(ResourceDimension Dim, QualType ReturnType);
  CXXRecordDecl *addMipsType(ResourceDimension Dim, QualType ReturnType);
  BuiltinTypeDeclBuilder &
  addHandleMember(ResourceClass RC, ResourceDimension RD, bool IsROV,
                  bool RawBuffer, bool IsArray, QualType ElementTy,
                  AccessSpecifier Access = AccessSpecifier::AS_private);
  BuiltinTypeDeclBuilder &
  addCounterHandleMember(ResourceClass RC, bool IsROV, bool RawBuffer,
                         QualType ElementTy,
                         AccessSpecifier Access = AccessSpecifier::AS_private);
  QualType getGatherReturnType();
  BuiltinTypeDeclBuilder &addDerivativeAvailability(StringRef MethodName);
  FieldDecl *getResourceHandleField() const;
  FieldDecl *getResourceCounterHandleField() const;
  QualType getFirstTemplateTypeParam();
  QualType getHandleElementType();
  Expr *getConstantIntExpr(int value);
  Expr *getConstantUnsignedIntExpr(unsigned value);
  HLSLAttributedResourceType::Attributes getResourceAttrs() const;
};
 
} // namespace hlsl
 
} // namespace clang
 
#endif // LLVM_CLANG_SEMA_HLSLBUILTINTYPEDECLBUILDER_H