clang 19.0.0git
ParseHLSL.cpp
Go to the documentation of this file.
1//===--- ParseHLSL.cpp - HLSL-specific parsing support --------------------===//
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// This file implements the parsing logic for HLSL language features.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/Attr.h"
16#include "clang/Parse/Parser.h"
18#include "clang/Sema/SemaHLSL.h"
19
20using namespace clang;
21
23 SourceLocation BufferLoc,
24 bool IsCBuffer, Parser &P) {
25 // The parse is failed, just return false.
26 if (!DG)
27 return false;
28 DeclGroupRef Decls = DG.get();
29 bool IsValid = true;
30 // Only allow function, variable, record decls inside HLSLBuffer.
31 for (DeclGroupRef::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
32 Decl *D = *I;
33 if (isa<CXXRecordDecl, RecordDecl, FunctionDecl, VarDecl>(D))
34 continue;
35
36 // FIXME: support nested HLSLBuffer and namespace inside HLSLBuffer.
37 if (isa<HLSLBufferDecl, NamespaceDecl>(D)) {
38 P.Diag(D->getLocation(), diag::err_invalid_declaration_in_hlsl_buffer)
39 << IsCBuffer;
40 IsValid = false;
41 continue;
42 }
43
44 IsValid = false;
45 P.Diag(D->getLocation(), diag::err_invalid_declaration_in_hlsl_buffer)
46 << IsCBuffer;
47 }
48 return IsValid;
49}
50
51Decl *Parser::ParseHLSLBuffer(SourceLocation &DeclEnd) {
52 assert((Tok.is(tok::kw_cbuffer) || Tok.is(tok::kw_tbuffer)) &&
53 "Not a cbuffer or tbuffer!");
54 bool IsCBuffer = Tok.is(tok::kw_cbuffer);
55 SourceLocation BufferLoc = ConsumeToken(); // Eat the 'cbuffer' or 'tbuffer'.
56
57 if (!Tok.is(tok::identifier)) {
58 Diag(Tok, diag::err_expected) << tok::identifier;
59 return nullptr;
60 }
61
64
65 ParsedAttributes Attrs(AttrFactory);
66 MaybeParseHLSLSemantics(Attrs, nullptr);
67
68 ParseScope BufferScope(this, Scope::DeclScope);
69 BalancedDelimiterTracker T(*this, tok::l_brace);
70 if (T.consumeOpen()) {
71 Diag(Tok, diag::err_expected) << tok::l_brace;
72 return nullptr;
73 }
74
75 Decl *D = Actions.HLSL().ActOnStartHLSLBuffer(
76 getCurScope(), IsCBuffer, BufferLoc, Identifier, IdentifierLoc,
77 T.getOpenLocation());
78
79 while (Tok.isNot(tok::r_brace) && Tok.isNot(tok::eof)) {
80 // FIXME: support attribute on constants inside cbuffer/tbuffer.
81 ParsedAttributes DeclAttrs(AttrFactory);
82 ParsedAttributes EmptyDeclSpecAttrs(AttrFactory);
83
85 ParseExternalDeclaration(DeclAttrs, EmptyDeclSpecAttrs);
87 *this)) {
88 T.skipToEnd();
89 DeclEnd = T.getCloseLocation();
90 BufferScope.Exit();
91 Actions.HLSL().ActOnFinishHLSLBuffer(D, DeclEnd);
92 return nullptr;
93 }
94 }
95
96 T.consumeClose();
97 DeclEnd = T.getCloseLocation();
98 BufferScope.Exit();
99 Actions.HLSL().ActOnFinishHLSLBuffer(D, DeclEnd);
100
101 Actions.ProcessDeclAttributeList(Actions.CurScope, D, Attrs);
102 return D;
103}
104
105static void fixSeparateAttrArgAndNumber(StringRef ArgStr, SourceLocation ArgLoc,
106 Token Tok, ArgsVector &ArgExprs,
107 Parser &P, ASTContext &Ctx,
108 Preprocessor &PP) {
109 StringRef Num = StringRef(Tok.getLiteralData(), Tok.getLength());
110 SourceLocation EndNumLoc = Tok.getEndLoc();
111
112 P.ConsumeToken(); // consume constant.
113 std::string FixedArg = ArgStr.str() + Num.str();
114 P.Diag(ArgLoc, diag::err_hlsl_separate_attr_arg_and_number)
115 << FixedArg
116 << FixItHint::CreateReplacement(SourceRange(ArgLoc, EndNumLoc), FixedArg);
117 ArgsUnion &Slot = ArgExprs.back();
118 Slot = IdentifierLoc::create(Ctx, ArgLoc, PP.getIdentifierInfo(FixedArg));
119}
120
121void Parser::ParseHLSLSemantics(ParsedAttributes &Attrs,
122 SourceLocation *EndLoc) {
123 // FIXME: HLSLSemantic is shared for Semantic and resource binding which is
124 // confusing. Need a better name to avoid misunderstanding. Issue
125 // https://github.com/llvm/llvm-project/issues/57882
126 assert(Tok.is(tok::colon) && "Not a HLSL Semantic");
127 ConsumeToken();
128
129 IdentifierInfo *II = nullptr;
130 if (Tok.is(tok::kw_register))
131 II = PP.getIdentifierInfo("register");
132 else if (Tok.is(tok::identifier))
133 II = Tok.getIdentifierInfo();
134
135 if (!II) {
136 Diag(Tok.getLocation(), diag::err_expected_semantic_identifier);
137 return;
138 }
139
141 if (EndLoc)
142 *EndLoc = Tok.getLocation();
143 ParsedAttr::Kind AttrKind =
145
146 ArgsVector ArgExprs;
147 switch (AttrKind) {
148 case ParsedAttr::AT_HLSLResourceBinding: {
149 if (ExpectAndConsume(tok::l_paren, diag::err_expected_lparen_after)) {
150 SkipUntil(tok::r_paren, StopAtSemi); // skip through )
151 return;
152 }
153 if (!Tok.is(tok::identifier)) {
154 Diag(Tok.getLocation(), diag::err_expected) << tok::identifier;
155 SkipUntil(tok::r_paren, StopAtSemi); // skip through )
156 return;
157 }
158 StringRef SlotStr = Tok.getIdentifierInfo()->getName();
159 SourceLocation SlotLoc = Tok.getLocation();
160 ArgExprs.push_back(ParseIdentifierLoc());
161
162 // Add numeric_constant for fix-it.
163 if (SlotStr.size() == 1 && Tok.is(tok::numeric_constant))
164 fixSeparateAttrArgAndNumber(SlotStr, SlotLoc, Tok, ArgExprs, *this,
165 Actions.Context, PP);
166
167 if (Tok.is(tok::comma)) {
168 ConsumeToken(); // consume comma
169 if (!Tok.is(tok::identifier)) {
170 Diag(Tok.getLocation(), diag::err_expected) << tok::identifier;
171 SkipUntil(tok::r_paren, StopAtSemi); // skip through )
172 return;
173 }
174 StringRef SpaceStr = Tok.getIdentifierInfo()->getName();
175 SourceLocation SpaceLoc = Tok.getLocation();
176 ArgExprs.push_back(ParseIdentifierLoc());
177
178 // Add numeric_constant for fix-it.
179 if (SpaceStr.equals("space") && Tok.is(tok::numeric_constant))
180 fixSeparateAttrArgAndNumber(SpaceStr, SpaceLoc, Tok, ArgExprs, *this,
181 Actions.Context, PP);
182 }
183 if (ExpectAndConsume(tok::r_paren, diag::err_expected)) {
184 SkipUntil(tok::r_paren, StopAtSemi); // skip through )
185 return;
186 }
187 } break;
189 Diag(Loc, diag::err_unknown_hlsl_semantic) << II;
190 return;
191 case ParsedAttr::AT_HLSLSV_GroupIndex:
192 case ParsedAttr::AT_HLSLSV_DispatchThreadID:
193 break;
194 default:
195 llvm_unreachable("invalid HLSL Semantic");
196 break;
197 }
198
199 Attrs.addNew(II, Loc, nullptr, SourceLocation(), ArgExprs.data(),
200 ArgExprs.size(), ParsedAttr::Form::HLSLSemantic());
201}
StringRef P
StringRef Identifier
Definition: Format.cpp:2980
static bool validateDeclsInsideHLSLBuffer(Parser::DeclGroupPtrTy DG, SourceLocation BufferLoc, bool IsCBuffer, Parser &P)
Definition: ParseHLSL.cpp:22
static void fixSeparateAttrArgAndNumber(StringRef ArgStr, SourceLocation ArgLoc, Token Tok, ArgsVector &ArgExprs, Parser &P, ASTContext &Ctx, Preprocessor &PP)
Definition: ParseHLSL.cpp:105
This file declares semantic analysis for HLSL constructs.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:182
@ AS_HLSLSemantic
<vardecl> : <semantic>
RAII class that helps handle the parsing of an open/close delimiter pair, such as braces { ....
iterator begin()
Definition: DeclGroup.h:99
iterator end()
Definition: DeclGroup.h:105
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:85
SourceLocation getLocation() const
Definition: DeclBase.h:444
static FixItHint CreateReplacement(CharSourceRange RemoveRange, StringRef Code)
Create a code modification hint that replaces the given source range with the given code string.
Definition: Diagnostic.h:134
One of these records is kept for each identifier that is lexed.
StringRef getName() const
Return the actual identifier string.
Wrapper for void* pointer.
Definition: Ownership.h:50
PtrTy get() const
Definition: Ownership.h:80
ParsedAttributes - A collection of parsed attributes.
Definition: ParsedAttr.h:951
ParsedAttr * addNew(IdentifierInfo *attrName, SourceRange attrRange, IdentifierInfo *scopeName, SourceLocation scopeLoc, ArgsUnion *args, unsigned numArgs, ParsedAttr::Form form, SourceLocation ellipsisLoc=SourceLocation())
Add attribute with expression arguments.
Definition: ParsedAttr.h:983
Parser - This implements a parser for the C family of languages.
Definition: Parser.h:55
DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID)
Definition: Parser.cpp:80
SourceLocation ConsumeToken()
ConsumeToken - Consume the current 'peek token' and lex the next one.
Definition: Parser.h:515
OpaquePtr< DeclGroupRef > DeclGroupPtrTy
Definition: Parser.h:480
Scope * getCurScope() const
Definition: Parser.h:469
bool SkipUntil(tok::TokenKind T, SkipUntilFlags Flags=static_cast< SkipUntilFlags >(0))
SkipUntil - Read tokens until we get to the specified token, then consume it (unless StopBeforeMatch ...
Definition: Parser.h:1261
@ StopAtSemi
Stop skipping at semicolon.
Definition: Parser.h:1240
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:128
IdentifierInfo * getIdentifierInfo(StringRef Name) const
Return information about the specified preprocessor identifier token.
@ DeclScope
This is a scope that can contain a declaration.
Definition: Scope.h:63
void ActOnFinishHLSLBuffer(Decl *Dcl, SourceLocation RBrace)
Definition: SemaHLSL.cpp:34
Decl * ActOnStartHLSLBuffer(Scope *BufferScope, bool CBuffer, SourceLocation KwLoc, IdentifierInfo *Ident, SourceLocation IdentLoc, SourceLocation LBrace)
Definition: SemaHLSL.cpp:18
ASTContext & Context
Definition: Sema.h:832
SemaHLSL & HLSL()
Definition: Sema.h:967
void ProcessDeclAttributeList(Scope *S, Decl *D, const ParsedAttributesView &AttrList, const ProcessDeclAttributeOptions &Options=ProcessDeclAttributeOptions())
ProcessDeclAttributeList - Apply all the decl attributes in the specified attribute list to the speci...
Encodes a location in the source.
A trivial tuple used to represent a source range.
Token - This structure provides full information about a lexed token.
Definition: Token.h:36
IdentifierInfo * getIdentifierInfo() const
Definition: Token.h:187
SourceLocation getEndLoc() const
Definition: Token.h:159
SourceLocation getLocation() const
Return a source location identifier for the specified offset in the current file.
Definition: Token.h:132
unsigned getLength() const
Definition: Token.h:135
bool is(tok::TokenKind K) const
is/isNot - Predicates to check if this token is a specific kind, as in "if (Tok.is(tok::l_brace)) {....
Definition: Token.h:99
bool isNot(tok::TokenKind K) const
Definition: Token.h:100
const char * getLiteralData() const
getLiteralData - For a literal token (numeric constant, string, etc), this returns a pointer to the s...
Definition: Token.h:225
The JSON file list parser is used to communicate input to InstallAPI.
llvm::PointerUnion< Expr *, IdentifierLoc * > ArgsUnion
A union of the various pointer types that can be passed to an ParsedAttr as an argument.
Definition: ParsedAttr.h:110
@ Result
The result type of a method or function.
const FunctionProtoType * T
Wraps an identifier and optional source location for the identifier.
Definition: ParsedAttr.h:100
static IdentifierLoc * create(ASTContext &Ctx, SourceLocation Loc, IdentifierInfo *Ident)
Definition: ParsedAttr.cpp:28