blob: 29983b0a16c3ca93817d610a271b27044fd5a14a [file] [log] [blame]
Dmitri Gribenkoec925312012-07-06 00:28:32 +00001//===--- CommentParser.cpp - Doxygen comment parser -----------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Dmitri Gribenkoec925312012-07-06 00:28:32 +00006//
7//===----------------------------------------------------------------------===//
8
9#include "clang/AST/CommentParser.h"
Dmitri Gribenkoca7f80a2012-08-09 00:03:17 +000010#include "clang/AST/CommentCommandTraits.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000011#include "clang/AST/CommentDiagnostic.h"
12#include "clang/AST/CommentSema.h"
Dmitri Gribenkobcef3412013-02-09 15:16:58 +000013#include "clang/Basic/CharInfo.h"
Dmitri Gribenkof26054f2012-07-11 21:38:39 +000014#include "clang/Basic/SourceManager.h"
Dmitri Gribenkoec925312012-07-06 00:28:32 +000015#include "llvm/Support/ErrorHandling.h"
16
17namespace clang {
Dmitri Gribenko1e50cbf2013-08-23 18:03:40 +000018
19static inline bool isWhitespace(llvm::StringRef S) {
20 for (StringRef::const_iterator I = S.begin(), E = S.end(); I != E; ++I) {
21 if (!isWhitespace(*I))
22 return false;
23 }
24 return true;
25}
26
Dmitri Gribenkoec925312012-07-06 00:28:32 +000027namespace comments {
28
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000029/// Re-lexes a sequence of tok::text tokens.
30class TextTokenRetokenizer {
31 llvm::BumpPtrAllocator &Allocator;
Dmitri Gribenko0a363022012-07-24 17:52:18 +000032 Parser &P;
Dmitri Gribenko35b0c092012-07-24 18:23:31 +000033
34 /// This flag is set when there are no more tokens we can fetch from lexer.
35 bool NoMoreInterestingTokens;
36
37 /// Token buffer: tokens we have processed and lookahead.
Dmitri Gribenko0a363022012-07-24 17:52:18 +000038 SmallVector<Token, 16> Toks;
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000039
Dmitri Gribenko35b0c092012-07-24 18:23:31 +000040 /// A position in \c Toks.
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000041 struct Position {
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000042 const char *BufferStart;
43 const char *BufferEnd;
44 const char *BufferPtr;
45 SourceLocation BufferStartLoc;
Alexander Shaposhnikovc9370262016-09-20 18:32:48 +000046 unsigned CurToken;
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000047 };
48
49 /// Current position in Toks.
50 Position Pos;
51
52 bool isEnd() const {
53 return Pos.CurToken >= Toks.size();
54 }
55
56 /// Sets up the buffer pointers to point to current token.
57 void setupBuffer() {
Dmitri Gribenko0a363022012-07-24 17:52:18 +000058 assert(!isEnd());
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000059 const Token &Tok = Toks[Pos.CurToken];
60
61 Pos.BufferStart = Tok.getText().begin();
62 Pos.BufferEnd = Tok.getText().end();
63 Pos.BufferPtr = Pos.BufferStart;
64 Pos.BufferStartLoc = Tok.getLocation();
65 }
66
67 SourceLocation getSourceLocation() const {
68 const unsigned CharNo = Pos.BufferPtr - Pos.BufferStart;
69 return Pos.BufferStartLoc.getLocWithOffset(CharNo);
70 }
71
72 char peek() const {
73 assert(!isEnd());
74 assert(Pos.BufferPtr != Pos.BufferEnd);
75 return *Pos.BufferPtr;
76 }
77
78 void consumeChar() {
79 assert(!isEnd());
80 assert(Pos.BufferPtr != Pos.BufferEnd);
81 Pos.BufferPtr++;
82 if (Pos.BufferPtr == Pos.BufferEnd) {
83 Pos.CurToken++;
Dmitri Gribenko35b0c092012-07-24 18:23:31 +000084 if (isEnd() && !addToken())
85 return;
86
87 assert(!isEnd());
88 setupBuffer();
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +000089 }
90 }
91
Dmitri Gribenko0a363022012-07-24 17:52:18 +000092 /// Add a token.
93 /// Returns true on success, false if there are no interesting tokens to
94 /// fetch from lexer.
95 bool addToken() {
Dmitri Gribenko35b0c092012-07-24 18:23:31 +000096 if (NoMoreInterestingTokens)
Dmitri Gribenko0a363022012-07-24 17:52:18 +000097 return false;
98
Dmitri Gribenko35b0c092012-07-24 18:23:31 +000099 if (P.Tok.is(tok::newline)) {
100 // If we see a single newline token between text tokens, skip it.
101 Token Newline = P.Tok;
102 P.consumeToken();
103 if (P.Tok.isNot(tok::text)) {
104 P.putBack(Newline);
105 NoMoreInterestingTokens = true;
106 return false;
107 }
108 }
109 if (P.Tok.isNot(tok::text)) {
110 NoMoreInterestingTokens = true;
111 return false;
112 }
113
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000114 Toks.push_back(P.Tok);
115 P.consumeToken();
116 if (Toks.size() == 1)
117 setupBuffer();
118 return true;
119 }
120
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000121 void consumeWhitespace() {
122 while (!isEnd()) {
123 if (isWhitespace(peek()))
124 consumeChar();
125 else
126 break;
127 }
128 }
129
130 void formTokenWithChars(Token &Result,
131 SourceLocation Loc,
132 const char *TokBegin,
133 unsigned TokLength,
134 StringRef Text) {
135 Result.setLocation(Loc);
136 Result.setKind(tok::text);
137 Result.setLength(TokLength);
138#ifndef NDEBUG
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000139 Result.TextPtr = "<UNSET>";
140 Result.IntVal = 7;
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000141#endif
142 Result.setText(Text);
143 }
144
145public:
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000146 TextTokenRetokenizer(llvm::BumpPtrAllocator &Allocator, Parser &P):
Dmitri Gribenko35b0c092012-07-24 18:23:31 +0000147 Allocator(Allocator), P(P), NoMoreInterestingTokens(false) {
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000148 Pos.CurToken = 0;
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000149 addToken();
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000150 }
151
152 /// Extract a word -- sequence of non-whitespace characters.
153 bool lexWord(Token &Tok) {
154 if (isEnd())
155 return false;
156
157 Position SavedPos = Pos;
158
159 consumeWhitespace();
160 SmallString<32> WordText;
161 const char *WordBegin = Pos.BufferPtr;
162 SourceLocation Loc = getSourceLocation();
163 while (!isEnd()) {
164 const char C = peek();
165 if (!isWhitespace(C)) {
166 WordText.push_back(C);
167 consumeChar();
168 } else
169 break;
170 }
171 const unsigned Length = WordText.size();
172 if (Length == 0) {
173 Pos = SavedPos;
174 return false;
175 }
176
177 char *TextPtr = Allocator.Allocate<char>(Length + 1);
178
179 memcpy(TextPtr, WordText.c_str(), Length + 1);
180 StringRef Text = StringRef(TextPtr, Length);
181
Dmitri Gribenkoc55c6fc2012-12-19 17:34:55 +0000182 formTokenWithChars(Tok, Loc, WordBegin, Length, Text);
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000183 return true;
184 }
185
186 bool lexDelimitedSeq(Token &Tok, char OpenDelim, char CloseDelim) {
187 if (isEnd())
188 return false;
189
190 Position SavedPos = Pos;
191
192 consumeWhitespace();
193 SmallString<32> WordText;
194 const char *WordBegin = Pos.BufferPtr;
195 SourceLocation Loc = getSourceLocation();
196 bool Error = false;
197 if (!isEnd()) {
198 const char C = peek();
199 if (C == OpenDelim) {
200 WordText.push_back(C);
201 consumeChar();
202 } else
203 Error = true;
204 }
205 char C = '\0';
206 while (!Error && !isEnd()) {
207 C = peek();
208 WordText.push_back(C);
209 consumeChar();
210 if (C == CloseDelim)
211 break;
212 }
213 if (!Error && C != CloseDelim)
214 Error = true;
215
216 if (Error) {
217 Pos = SavedPos;
218 return false;
219 }
220
221 const unsigned Length = WordText.size();
222 char *TextPtr = Allocator.Allocate<char>(Length + 1);
223
224 memcpy(TextPtr, WordText.c_str(), Length + 1);
225 StringRef Text = StringRef(TextPtr, Length);
226
227 formTokenWithChars(Tok, Loc, WordBegin,
228 Pos.BufferPtr - WordBegin, Text);
229 return true;
230 }
231
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000232 /// Put back tokens that we didn't consume.
233 void putBackLeftoverTokens() {
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000234 if (isEnd())
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000235 return;
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000236
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000237 bool HavePartialTok = false;
238 Token PartialTok;
239 if (Pos.BufferPtr != Pos.BufferStart) {
240 formTokenWithChars(PartialTok, getSourceLocation(),
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000241 Pos.BufferPtr, Pos.BufferEnd - Pos.BufferPtr,
242 StringRef(Pos.BufferPtr,
243 Pos.BufferEnd - Pos.BufferPtr));
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000244 HavePartialTok = true;
245 Pos.CurToken++;
246 }
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000247
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000248 P.putBack(llvm::makeArrayRef(Toks.begin() + Pos.CurToken, Toks.end()));
249 Pos.CurToken = Toks.size();
250
251 if (HavePartialTok)
252 P.putBack(PartialTok);
Dmitri Gribenko1bfd9da2012-07-24 17:43:18 +0000253 }
254};
255
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000256Parser::Parser(Lexer &L, Sema &S, llvm::BumpPtrAllocator &Allocator,
Dmitri Gribenkoca7f80a2012-08-09 00:03:17 +0000257 const SourceManager &SourceMgr, DiagnosticsEngine &Diags,
258 const CommandTraits &Traits):
259 L(L), S(S), Allocator(Allocator), SourceMgr(SourceMgr), Diags(Diags),
260 Traits(Traits) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000261 consumeToken();
262}
263
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000264void Parser::parseParamCommandArgs(ParamCommandComment *PC,
265 TextTokenRetokenizer &Retokenizer) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000266 Token Arg;
267 // Check if argument looks like direction specification: [dir]
268 // e.g., [in], [out], [in,out]
269 if (Retokenizer.lexDelimitedSeq(Arg, '[', ']'))
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000270 S.actOnParamCommandDirectionArg(PC,
271 Arg.getLocation(),
272 Arg.getEndLocation(),
273 Arg.getText());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000274
275 if (Retokenizer.lexWord(Arg))
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000276 S.actOnParamCommandParamNameArg(PC,
277 Arg.getLocation(),
278 Arg.getEndLocation(),
279 Arg.getText());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000280}
281
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000282void Parser::parseTParamCommandArgs(TParamCommandComment *TPC,
283 TextTokenRetokenizer &Retokenizer) {
Dmitri Gribenko34df2202012-07-31 22:37:06 +0000284 Token Arg;
285 if (Retokenizer.lexWord(Arg))
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000286 S.actOnTParamCommandParamNameArg(TPC,
287 Arg.getLocation(),
288 Arg.getEndLocation(),
289 Arg.getText());
Dmitri Gribenko34df2202012-07-31 22:37:06 +0000290}
291
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000292void Parser::parseBlockCommandArgs(BlockCommandComment *BC,
293 TextTokenRetokenizer &Retokenizer,
294 unsigned NumArgs) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000295 typedef BlockCommandComment::Argument Argument;
Dmitri Gribenkobacb9f62012-07-06 16:41:59 +0000296 Argument *Args =
297 new (Allocator.Allocate<Argument>(NumArgs)) Argument[NumArgs];
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000298 unsigned ParsedArgs = 0;
299 Token Arg;
300 while (ParsedArgs < NumArgs && Retokenizer.lexWord(Arg)) {
301 Args[ParsedArgs] = Argument(SourceRange(Arg.getLocation(),
302 Arg.getEndLocation()),
303 Arg.getText());
304 ParsedArgs++;
305 }
306
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000307 S.actOnBlockCommandArgs(BC, llvm::makeArrayRef(Args, ParsedArgs));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000308}
309
310BlockCommandComment *Parser::parseBlockCommand() {
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000311 assert(Tok.is(tok::backslash_command) || Tok.is(tok::at_command));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000312
Craig Topper36250ad2014-05-12 05:36:57 +0000313 ParamCommandComment *PC = nullptr;
314 TParamCommandComment *TPC = nullptr;
315 BlockCommandComment *BC = nullptr;
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000316 const CommandInfo *Info = Traits.getCommandInfo(Tok.getCommandID());
Dmitri Gribenkobcf7f4d2013-03-04 23:06:15 +0000317 CommandMarkerKind CommandMarker =
318 Tok.is(tok::backslash_command) ? CMK_Backslash : CMK_At;
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000319 if (Info->IsParamCommand) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000320 PC = S.actOnParamCommandStart(Tok.getLocation(),
321 Tok.getEndLocation(),
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000322 Tok.getCommandID(),
Dmitri Gribenkobcf7f4d2013-03-04 23:06:15 +0000323 CommandMarker);
Dmitri Gribenko696d7222012-12-19 17:17:09 +0000324 } else if (Info->IsTParamCommand) {
Dmitri Gribenko34df2202012-07-31 22:37:06 +0000325 TPC = S.actOnTParamCommandStart(Tok.getLocation(),
326 Tok.getEndLocation(),
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000327 Tok.getCommandID(),
Dmitri Gribenkobcf7f4d2013-03-04 23:06:15 +0000328 CommandMarker);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000329 } else {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000330 BC = S.actOnBlockCommandStart(Tok.getLocation(),
331 Tok.getEndLocation(),
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000332 Tok.getCommandID(),
Dmitri Gribenkobcf7f4d2013-03-04 23:06:15 +0000333 CommandMarker);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000334 }
335 consumeToken();
336
Dmitri Gribenko71469302013-01-26 00:36:14 +0000337 if (isTokBlockCommand()) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000338 // Block command ahead. We can't nest block commands, so pretend that this
339 // command has an empty argument.
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000340 ParagraphComment *Paragraph = S.actOnParagraphComment(None);
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000341 if (PC) {
Dmitri Gribenko6297fa82012-08-06 23:48:44 +0000342 S.actOnParamCommandFinish(PC, Paragraph);
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000343 return PC;
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000344 } else if (TPC) {
Dmitri Gribenko6297fa82012-08-06 23:48:44 +0000345 S.actOnTParamCommandFinish(TPC, Paragraph);
346 return TPC;
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000347 } else {
348 S.actOnBlockCommandFinish(BC, Paragraph);
349 return BC;
350 }
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000351 }
352
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000353 if (PC || TPC || Info->NumArgs > 0) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000354 // In order to parse command arguments we need to retokenize a few
355 // following text tokens.
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000356 TextTokenRetokenizer Retokenizer(Allocator, *this);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000357
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000358 if (PC)
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000359 parseParamCommandArgs(PC, Retokenizer);
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000360 else if (TPC)
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000361 parseTParamCommandArgs(TPC, Retokenizer);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000362 else
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000363 parseBlockCommandArgs(BC, Retokenizer, Info->NumArgs);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000364
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000365 Retokenizer.putBackLeftoverTokens();
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000366 }
367
Dmitri Gribenko71469302013-01-26 00:36:14 +0000368 // If there's a block command ahead, we will attach an empty paragraph to
369 // this command.
370 bool EmptyParagraph = false;
371 if (isTokBlockCommand())
372 EmptyParagraph = true;
373 else if (Tok.is(tok::newline)) {
374 Token PrevTok = Tok;
375 consumeToken();
376 EmptyParagraph = isTokBlockCommand();
377 putBack(PrevTok);
378 }
379
380 ParagraphComment *Paragraph;
381 if (EmptyParagraph)
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000382 Paragraph = S.actOnParagraphComment(None);
Dmitri Gribenko71469302013-01-26 00:36:14 +0000383 else {
384 BlockContentComment *Block = parseParagraphOrBlockCommand();
385 // Since we have checked for a block command, we should have parsed a
386 // paragraph.
387 Paragraph = cast<ParagraphComment>(Block);
388 }
389
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000390 if (PC) {
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000391 S.actOnParamCommandFinish(PC, Paragraph);
392 return PC;
Dmitri Gribenkoc2c804d2013-04-18 20:50:35 +0000393 } else if (TPC) {
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000394 S.actOnTParamCommandFinish(TPC, Paragraph);
395 return TPC;
396 } else {
397 S.actOnBlockCommandFinish(BC, Paragraph);
398 return BC;
399 }
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000400}
401
402InlineCommandComment *Parser::parseInlineCommand() {
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000403 assert(Tok.is(tok::backslash_command) || Tok.is(tok::at_command));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000404
405 const Token CommandTok = Tok;
406 consumeToken();
407
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000408 TextTokenRetokenizer Retokenizer(Allocator, *this);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000409
410 Token ArgTok;
411 bool ArgTokValid = Retokenizer.lexWord(ArgTok);
412
413 InlineCommandComment *IC;
414 if (ArgTokValid) {
415 IC = S.actOnInlineCommand(CommandTok.getLocation(),
416 CommandTok.getEndLocation(),
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000417 CommandTok.getCommandID(),
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000418 ArgTok.getLocation(),
419 ArgTok.getEndLocation(),
420 ArgTok.getText());
421 } else {
422 IC = S.actOnInlineCommand(CommandTok.getLocation(),
423 CommandTok.getEndLocation(),
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000424 CommandTok.getCommandID());
Dmitri Gribenko657330e2019-08-05 08:05:16 +0000425
426 Diag(CommandTok.getEndLocation().getLocWithOffset(1),
427 diag::warn_doc_inline_contents_no_argument)
428 << CommandTok.is(tok::at_command)
429 << Traits.getCommandInfo(CommandTok.getCommandID())->Name
430 << SourceRange(CommandTok.getLocation(), CommandTok.getEndLocation());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000431 }
432
Dmitri Gribenko0a363022012-07-24 17:52:18 +0000433 Retokenizer.putBackLeftoverTokens();
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000434
435 return IC;
436}
437
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000438HTMLStartTagComment *Parser::parseHTMLStartTag() {
439 assert(Tok.is(tok::html_start_tag));
440 HTMLStartTagComment *HST =
441 S.actOnHTMLStartTagStart(Tok.getLocation(),
442 Tok.getHTMLTagStartName());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000443 consumeToken();
444
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000445 SmallVector<HTMLStartTagComment::Attribute, 2> Attrs;
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000446 while (true) {
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000447 switch (Tok.getKind()) {
448 case tok::html_ident: {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000449 Token Ident = Tok;
450 consumeToken();
451 if (Tok.isNot(tok::html_equals)) {
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000452 Attrs.push_back(HTMLStartTagComment::Attribute(Ident.getLocation(),
453 Ident.getHTMLIdent()));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000454 continue;
455 }
456 Token Equals = Tok;
457 consumeToken();
458 if (Tok.isNot(tok::html_quoted_string)) {
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000459 Diag(Tok.getLocation(),
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000460 diag::warn_doc_html_start_tag_expected_quoted_string)
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000461 << SourceRange(Equals.getLocation());
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000462 Attrs.push_back(HTMLStartTagComment::Attribute(Ident.getLocation(),
463 Ident.getHTMLIdent()));
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000464 while (Tok.is(tok::html_equals) ||
465 Tok.is(tok::html_quoted_string))
466 consumeToken();
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000467 continue;
468 }
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000469 Attrs.push_back(HTMLStartTagComment::Attribute(
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000470 Ident.getLocation(),
471 Ident.getHTMLIdent(),
472 Equals.getLocation(),
473 SourceRange(Tok.getLocation(),
474 Tok.getEndLocation()),
475 Tok.getHTMLQuotedString()));
476 consumeToken();
477 continue;
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000478 }
479
480 case tok::html_greater:
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000481 S.actOnHTMLStartTagFinish(HST,
482 S.copyArray(llvm::makeArrayRef(Attrs)),
483 Tok.getLocation(),
484 /* IsSelfClosing = */ false);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000485 consumeToken();
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000486 return HST;
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000487
488 case tok::html_slash_greater:
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000489 S.actOnHTMLStartTagFinish(HST,
490 S.copyArray(llvm::makeArrayRef(Attrs)),
491 Tok.getLocation(),
492 /* IsSelfClosing = */ true);
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000493 consumeToken();
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000494 return HST;
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000495
496 case tok::html_equals:
497 case tok::html_quoted_string:
498 Diag(Tok.getLocation(),
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000499 diag::warn_doc_html_start_tag_expected_ident_or_greater);
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000500 while (Tok.is(tok::html_equals) ||
501 Tok.is(tok::html_quoted_string))
502 consumeToken();
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000503 if (Tok.is(tok::html_ident) ||
504 Tok.is(tok::html_greater) ||
505 Tok.is(tok::html_slash_greater))
506 continue;
507
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000508 S.actOnHTMLStartTagFinish(HST,
509 S.copyArray(llvm::makeArrayRef(Attrs)),
510 SourceLocation(),
511 /* IsSelfClosing = */ false);
512 return HST;
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000513
514 default:
515 // Not a token from an HTML start tag. Thus HTML tag prematurely ended.
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000516 S.actOnHTMLStartTagFinish(HST,
517 S.copyArray(llvm::makeArrayRef(Attrs)),
518 SourceLocation(),
519 /* IsSelfClosing = */ false);
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000520 bool StartLineInvalid;
521 const unsigned StartLine = SourceMgr.getPresumedLineNumber(
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000522 HST->getLocation(),
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000523 &StartLineInvalid);
524 bool EndLineInvalid;
525 const unsigned EndLine = SourceMgr.getPresumedLineNumber(
526 Tok.getLocation(),
527 &EndLineInvalid);
528 if (StartLineInvalid || EndLineInvalid || StartLine == EndLine)
529 Diag(Tok.getLocation(),
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000530 diag::warn_doc_html_start_tag_expected_ident_or_greater)
531 << HST->getSourceRange();
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000532 else {
533 Diag(Tok.getLocation(),
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000534 diag::warn_doc_html_start_tag_expected_ident_or_greater);
535 Diag(HST->getLocation(), diag::note_doc_html_tag_started_here)
536 << HST->getSourceRange();
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000537 }
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000538 return HST;
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000539 }
540 }
541}
542
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000543HTMLEndTagComment *Parser::parseHTMLEndTag() {
544 assert(Tok.is(tok::html_end_tag));
545 Token TokEndTag = Tok;
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000546 consumeToken();
547 SourceLocation Loc;
548 if (Tok.is(tok::html_greater)) {
549 Loc = Tok.getLocation();
550 consumeToken();
551 }
552
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000553 return S.actOnHTMLEndTag(TokEndTag.getLocation(),
554 Loc,
555 TokEndTag.getHTMLTagEndName());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000556}
557
558BlockContentComment *Parser::parseParagraphOrBlockCommand() {
559 SmallVector<InlineContentComment *, 8> Content;
560
561 while (true) {
562 switch (Tok.getKind()) {
563 case tok::verbatim_block_begin:
564 case tok::verbatim_line_name:
565 case tok::eof:
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000566 break; // Block content or EOF ahead, finish this parapgaph.
567
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000568 case tok::unknown_command:
569 Content.push_back(S.actOnUnknownCommand(Tok.getLocation(),
570 Tok.getEndLocation(),
571 Tok.getUnknownCommandName()));
572 consumeToken();
573 continue;
574
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000575 case tok::backslash_command:
576 case tok::at_command: {
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000577 const CommandInfo *Info = Traits.getCommandInfo(Tok.getCommandID());
578 if (Info->IsBlockCommand) {
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000579 if (Content.size() == 0)
580 return parseBlockCommand();
581 break; // Block command ahead, finish this parapgaph.
582 }
Dmitri Gribenko76b91c32012-11-18 00:30:31 +0000583 if (Info->IsVerbatimBlockEndCommand) {
584 Diag(Tok.getLocation(),
585 diag::warn_verbatim_block_end_without_start)
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000586 << Tok.is(tok::at_command)
Dmitri Gribenko76b91c32012-11-18 00:30:31 +0000587 << Info->Name
588 << SourceRange(Tok.getLocation(), Tok.getEndLocation());
589 consumeToken();
590 continue;
591 }
Dmitri Gribenko9304d862012-09-11 19:22:03 +0000592 if (Info->IsUnknownCommand) {
593 Content.push_back(S.actOnUnknownCommand(Tok.getLocation(),
594 Tok.getEndLocation(),
595 Info->getID()));
596 consumeToken();
597 continue;
598 }
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000599 assert(Info->IsInlineCommand);
600 Content.push_back(parseInlineCommand());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000601 continue;
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000602 }
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000603
604 case tok::newline: {
605 consumeToken();
606 if (Tok.is(tok::newline) || Tok.is(tok::eof)) {
607 consumeToken();
608 break; // Two newlines -- end of paragraph.
609 }
Dmitri Gribenko1e50cbf2013-08-23 18:03:40 +0000610 // Also allow [tok::newline, tok::text, tok::newline] if the middle
611 // tok::text is just whitespace.
612 if (Tok.is(tok::text) && isWhitespace(Tok.getText())) {
613 Token WhitespaceTok = Tok;
614 consumeToken();
615 if (Tok.is(tok::newline) || Tok.is(tok::eof)) {
616 consumeToken();
617 break;
618 }
619 // We have [tok::newline, tok::text, non-newline]. Put back tok::text.
620 putBack(WhitespaceTok);
621 }
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000622 if (Content.size() > 0)
623 Content.back()->addTrailingNewline();
624 continue;
625 }
626
627 // Don't deal with HTML tag soup now.
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000628 case tok::html_start_tag:
629 Content.push_back(parseHTMLStartTag());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000630 continue;
631
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000632 case tok::html_end_tag:
633 Content.push_back(parseHTMLEndTag());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000634 continue;
635
636 case tok::text:
637 Content.push_back(S.actOnText(Tok.getLocation(),
638 Tok.getEndLocation(),
639 Tok.getText()));
640 consumeToken();
641 continue;
642
643 case tok::verbatim_block_line:
644 case tok::verbatim_block_end:
645 case tok::verbatim_line_text:
646 case tok::html_ident:
647 case tok::html_equals:
648 case tok::html_quoted_string:
649 case tok::html_greater:
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000650 case tok::html_slash_greater:
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000651 llvm_unreachable("should not see this token");
652 }
653 break;
654 }
655
Dmitri Gribenko34df2202012-07-31 22:37:06 +0000656 return S.actOnParagraphComment(S.copyArray(llvm::makeArrayRef(Content)));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000657}
658
659VerbatimBlockComment *Parser::parseVerbatimBlock() {
660 assert(Tok.is(tok::verbatim_block_begin));
661
662 VerbatimBlockComment *VB =
663 S.actOnVerbatimBlockStart(Tok.getLocation(),
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000664 Tok.getVerbatimBlockID());
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000665 consumeToken();
666
667 // Don't create an empty line if verbatim opening command is followed
668 // by a newline.
669 if (Tok.is(tok::newline))
670 consumeToken();
671
672 SmallVector<VerbatimBlockLineComment *, 8> Lines;
673 while (Tok.is(tok::verbatim_block_line) ||
674 Tok.is(tok::newline)) {
675 VerbatimBlockLineComment *Line;
676 if (Tok.is(tok::verbatim_block_line)) {
677 Line = S.actOnVerbatimBlockLine(Tok.getLocation(),
678 Tok.getVerbatimBlockText());
679 consumeToken();
680 if (Tok.is(tok::newline)) {
681 consumeToken();
682 }
683 } else {
684 // Empty line, just a tok::newline.
Dmitri Gribenkob03cc7e2012-07-18 21:27:38 +0000685 Line = S.actOnVerbatimBlockLine(Tok.getLocation(), "");
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000686 consumeToken();
687 }
688 Lines.push_back(Line);
689 }
690
Dmitri Gribenko66a00c72012-07-20 20:18:53 +0000691 if (Tok.is(tok::verbatim_block_end)) {
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000692 const CommandInfo *Info = Traits.getCommandInfo(Tok.getVerbatimBlockID());
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000693 S.actOnVerbatimBlockFinish(VB, Tok.getLocation(),
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000694 Info->Name,
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000695 S.copyArray(llvm::makeArrayRef(Lines)));
Dmitri Gribenko66a00c72012-07-20 20:18:53 +0000696 consumeToken();
697 } else {
698 // Unterminated \\verbatim block
Dmitri Gribenkoa9770ad2012-08-06 19:03:12 +0000699 S.actOnVerbatimBlockFinish(VB, SourceLocation(), "",
700 S.copyArray(llvm::makeArrayRef(Lines)));
Dmitri Gribenko66a00c72012-07-20 20:18:53 +0000701 }
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000702
703 return VB;
704}
705
706VerbatimLineComment *Parser::parseVerbatimLine() {
707 assert(Tok.is(tok::verbatim_line_name));
708
709 Token NameTok = Tok;
710 consumeToken();
711
712 SourceLocation TextBegin;
713 StringRef Text;
714 // Next token might not be a tok::verbatim_line_text if verbatim line
715 // starting command comes just before a newline or comment end.
716 if (Tok.is(tok::verbatim_line_text)) {
717 TextBegin = Tok.getLocation();
718 Text = Tok.getVerbatimLineText();
719 } else {
720 TextBegin = NameTok.getEndLocation();
721 Text = "";
722 }
723
724 VerbatimLineComment *VL = S.actOnVerbatimLine(NameTok.getLocation(),
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000725 NameTok.getVerbatimLineID(),
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000726 TextBegin,
727 Text);
728 consumeToken();
729 return VL;
730}
731
732BlockContentComment *Parser::parseBlockContent() {
733 switch (Tok.getKind()) {
734 case tok::text:
Dmitri Gribenko7acbf002012-09-10 20:32:42 +0000735 case tok::unknown_command:
Fariborz Jahaniane400cb72013-03-02 02:39:57 +0000736 case tok::backslash_command:
737 case tok::at_command:
Dmitri Gribenkoe00ffc72012-07-13 00:44:24 +0000738 case tok::html_start_tag:
739 case tok::html_end_tag:
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000740 return parseParagraphOrBlockCommand();
741
742 case tok::verbatim_block_begin:
743 return parseVerbatimBlock();
744
745 case tok::verbatim_line_name:
746 return parseVerbatimLine();
747
748 case tok::eof:
749 case tok::newline:
750 case tok::verbatim_block_line:
751 case tok::verbatim_block_end:
752 case tok::verbatim_line_text:
753 case tok::html_ident:
754 case tok::html_equals:
755 case tok::html_quoted_string:
756 case tok::html_greater:
Dmitri Gribenkof26054f2012-07-11 21:38:39 +0000757 case tok::html_slash_greater:
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000758 llvm_unreachable("should not see this token");
759 }
Matt Beaumont-Gay4106ea32012-07-06 21:13:09 +0000760 llvm_unreachable("bogus token kind");
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000761}
762
763FullComment *Parser::parseFullComment() {
764 // Skip newlines at the beginning of the comment.
765 while (Tok.is(tok::newline))
766 consumeToken();
767
768 SmallVector<BlockContentComment *, 8> Blocks;
769 while (Tok.isNot(tok::eof)) {
770 Blocks.push_back(parseBlockContent());
771
772 // Skip extra newlines after paragraph end.
773 while (Tok.is(tok::newline))
774 consumeToken();
775 }
Dmitri Gribenko34df2202012-07-31 22:37:06 +0000776 return S.actOnFullComment(S.copyArray(llvm::makeArrayRef(Blocks)));
Dmitri Gribenkoec925312012-07-06 00:28:32 +0000777}
778
779} // end namespace comments
780} // end namespace clang