clang  10.0.0svn
CommentSema.h
Go to the documentation of this file.
1 //===--- CommentSema.h - Doxygen comment semantic analysis ------*- C++ -*-===//
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 defines the semantic analysis class for Doxygen comments.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_CLANG_AST_COMMENTSEMA_H
14 #define LLVM_CLANG_AST_COMMENTSEMA_H
15 
16 #include "clang/AST/Comment.h"
17 #include "clang/Basic/Diagnostic.h"
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/Support/Allocator.h"
23 
24 namespace clang {
25 class Decl;
26 class SourceMgr;
27 class Preprocessor;
28 
29 namespace comments {
30 class CommandTraits;
31 
32 class Sema {
33  Sema(const Sema &) = delete;
34  void operator=(const Sema &) = delete;
35 
36  /// Allocator for AST nodes.
37  llvm::BumpPtrAllocator &Allocator;
38 
39  /// Source manager for the comment being parsed.
40  const SourceManager &SourceMgr;
41 
42  DiagnosticsEngine &Diags;
43 
44  CommandTraits &Traits;
45 
46  const Preprocessor *PP;
47 
48  /// Information about the declaration this comment is attached to.
49  DeclInfo *ThisDeclInfo;
50 
51  /// Comment AST nodes that correspond to parameter names in
52  /// \c TemplateParameters.
53  ///
54  /// Contains a valid value if \c DeclInfo->IsFilled is true.
55  llvm::StringMap<TParamCommandComment *> TemplateParameterDocs;
56 
57  /// AST node for the \command and its aliases.
58  const BlockCommandComment *BriefCommand;
59 
60  /// AST node for the \\headerfile command.
61  const BlockCommandComment *HeaderfileCommand;
62 
63  DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) {
64  return Diags.Report(Loc, DiagID);
65  }
66 
67  /// A stack of HTML tags that are currently open (not matched with closing
68  /// tags).
70 
71 public:
72  Sema(llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr,
73  DiagnosticsEngine &Diags, CommandTraits &Traits,
74  const Preprocessor *PP);
75 
76  void setDecl(const Decl *D);
77 
78  /// Returns a copy of array, owned by Sema's allocator.
79  template<typename T>
81  if (!Source.empty())
82  return Source.copy(Allocator);
83  return None;
84  }
85 
88 
90  SourceLocation LocEnd,
91  unsigned CommandID,
92  CommandMarkerKind CommandMarker);
93 
96 
98  ParagraphComment *Paragraph);
99 
101  SourceLocation LocEnd,
102  unsigned CommandID,
103  CommandMarkerKind CommandMarker);
104 
106  SourceLocation ArgLocBegin,
107  SourceLocation ArgLocEnd,
108  StringRef Arg);
109 
111  SourceLocation ArgLocBegin,
112  SourceLocation ArgLocEnd,
113  StringRef Arg);
114 
116  ParagraphComment *Paragraph);
117 
119  SourceLocation LocEnd,
120  unsigned CommandID,
121  CommandMarkerKind CommandMarker);
122 
124  SourceLocation ArgLocBegin,
125  SourceLocation ArgLocEnd,
126  StringRef Arg);
127 
129  ParagraphComment *Paragraph);
130 
132  SourceLocation CommandLocEnd,
133  unsigned CommandID);
134 
136  SourceLocation CommandLocEnd,
137  unsigned CommandID,
138  SourceLocation ArgLocBegin,
139  SourceLocation ArgLocEnd,
140  StringRef Arg);
141 
143  SourceLocation LocEnd,
144  StringRef CommandName);
145 
147  SourceLocation LocEnd,
148  unsigned CommandID);
149 
151  SourceLocation LocEnd,
152  StringRef Text);
153 
155  unsigned CommandID);
156 
158  StringRef Text);
159 
161  SourceLocation CloseNameLocBegin,
162  StringRef CloseName,
164 
166  unsigned CommandID,
167  SourceLocation TextBegin,
168  StringRef Text);
169 
171  StringRef TagName);
172 
175  SourceLocation GreaterLoc,
176  bool IsSelfClosing);
177 
179  SourceLocation LocEnd,
180  StringRef TagName);
181 
183 
185 
186  void checkReturnsCommand(const BlockCommandComment *Command);
187 
188  /// Emit diagnostics about duplicate block commands that should be
189  /// used only once per comment, e.g., \and \\returns.
190  void checkBlockCommandDuplicate(const BlockCommandComment *Command);
191 
193 
195 
197 
198  void checkContainerDecl(const BlockCommandComment *Comment);
199 
200  /// Resolve parameter names to parameter indexes in function declaration.
201  /// Emit diagnostics about unknown parametrs.
202  void resolveParamCommandIndexes(const FullComment *FC);
203 
204  bool isFunctionDecl();
205  bool isAnyFunctionDecl();
206 
207  /// \returns \c true if declaration that this comment is attached to declares
208  /// a function pointer.
210  /// \returns \c true if the declaration that this comment is attached to
211  /// declares a variable or a field whose type is a function or a block
212  /// pointer.
215  bool isObjCMethodDecl();
216  bool isObjCPropertyDecl();
218  bool isRecordLikeDecl();
219  bool isClassOrStructDecl();
220  bool isUnionDecl();
221  bool isObjCInterfaceDecl();
222  bool isObjCProtocolDecl();
223  bool isClassTemplateDecl();
224  bool isFunctionTemplateDecl();
225 
227 
228  /// Extract all important semantic information from
229  /// \c ThisDeclInfo->ThisDecl into \c ThisDeclInfo members.
230  void inspectThisDecl();
231 
232  /// Returns index of a function parameter with a given name.
233  unsigned resolveParmVarReference(StringRef Name,
235 
236  /// Returns index of a function parameter with the name closest to a given
237  /// typo.
238  unsigned correctTypoInParmVarReference(StringRef Typo,
240 
241  bool resolveTParamReference(StringRef Name,
242  const TemplateParameterList *TemplateParameters,
243  SmallVectorImpl<unsigned> *Position);
244 
246  StringRef Typo,
247  const TemplateParameterList *TemplateParameters);
248 
250  getInlineCommandRenderKind(StringRef Name) const;
251 };
252 
253 } // end namespace comments
254 } // end namespace clang
255 
256 #endif
257 
void actOnParamCommandFinish(ParamCommandComment *Command, ParagraphComment *Paragraph)
StringRef correctTypoInTParamReference(StringRef Typo, const TemplateParameterList *TemplateParameters)
ArrayRef< const ParmVarDecl * > getParamVars()
void checkBlockCommandEmptyParagraph(BlockCommandComment *Command)
void actOnHTMLStartTagFinish(HTMLStartTagComment *Tag, ArrayRef< HTMLStartTagComment::Attribute > Attrs, SourceLocation GreaterLoc, bool IsSelfClosing)
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:88
ParagraphComment * actOnParagraphComment(ArrayRef< InlineContentComment *> Content)
Definition: CommentSema.cpp:44
VerbatimBlockComment * actOnVerbatimBlockStart(SourceLocation Loc, unsigned CommandID)
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1290
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
unsigned correctTypoInParmVarReference(StringRef Typo, ArrayRef< const ParmVarDecl *> ParamVars)
Returns index of a function parameter with the name closest to a given typo.
HTMLStartTagComment * actOnHTMLStartTagStart(SourceLocation LocBegin, StringRef TagName)
void actOnBlockCommandArgs(BlockCommandComment *Command, ArrayRef< BlockCommandComment::Argument > Args)
Definition: CommentSema.cpp:61
void checkContainerDeclVerbatimLine(const BlockCommandComment *Comment)
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:67
void checkBlockCommandDuplicate(const BlockCommandComment *Command)
Emit diagnostics about duplicate block commands that should be used only once per comment...
void actOnVerbatimBlockFinish(VerbatimBlockComment *Block, SourceLocation CloseNameLocBegin, StringRef CloseName, ArrayRef< VerbatimBlockLineComment *> Lines)
TextComment * actOnText(SourceLocation LocBegin, SourceLocation LocEnd, StringRef Text)
A command with word-like arguments that is considered inline content.
Definition: Comment.h:298
A line of text contained in a verbatim block.
Definition: Comment.h:863
A verbatim line command.
Definition: Comment.h:943
void checkReturnsCommand(const BlockCommandComment *Command)
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:149
InlineContentComment * actOnUnknownCommand(SourceLocation LocBegin, SourceLocation LocEnd, StringRef CommandName)
FullComment * actOnFullComment(ArrayRef< BlockContentComment *> Blocks)
Any part of the comment.
Definition: Comment.h:52
Defines the Diagnostic-related interfaces.
Inline content (contained within a block).
Definition: Comment.h:237
RenderKind
The most appropriate rendering mode for this command, chosen on command semantics in Doxygen...
Definition: Comment.h:309
ArrayRef< T > copyArray(ArrayRef< T > Source)
Returns a copy of array, owned by Sema&#39;s allocator.
Definition: CommentSema.h:80
A verbatim block command (e.
Definition: Comment.h:891
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:1043
bool resolveTParamReference(StringRef Name, const TemplateParameterList *TemplateParameters, SmallVectorImpl< unsigned > *Position)
void inspectThisDecl()
Extract all important semantic information from ThisDeclInfo->ThisDecl into ThisDeclInfo members...
void actOnTParamCommandFinish(TParamCommandComment *Command, ParagraphComment *Paragraph)
CommandMarkerKind
Describes the syntax that was used in a documentation command.
Definition: Comment.h:36
A command that has zero or more word-like arguments (number of word-like arguments depends on command...
Definition: Comment.h:596
VerbatimBlockLineComment * actOnVerbatimBlockLine(SourceLocation Loc, StringRef Text)
unsigned resolveParmVarReference(StringRef Name, ArrayRef< const ParmVarDecl *> ParamVars)
Returns index of a function parameter with a given name.
An opening HTML tag with attributes.
Definition: Comment.h:413
void checkFunctionDeclVerbatimLine(const BlockCommandComment *Comment)
Definition: CommentSema.cpp:97
TParamCommandComment * actOnTParamCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
void actOnBlockCommandFinish(BlockCommandComment *Command, ParagraphComment *Paragraph)
Definition: CommentSema.cpp:66
This class provides information about commands that can be used in comments.
InlineCommandComment::RenderKind getInlineCommandRenderKind(StringRef Name) const
void checkDeprecatedCommand(const BlockCommandComment *Comment)
void checkContainerDecl(const BlockCommandComment *Comment)
Encodes a location in the source.
VerbatimLineComment * actOnVerbatimLine(SourceLocation LocBegin, unsigned CommandID, SourceLocation TextBegin, StringRef Text)
bool isFunctionOrBlockPointerVarLikeDecl()
ParamCommandComment * actOnParamCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
Definition: CommentSema.cpp:79
A closing HTML tag.
Definition: Comment.h:507
Doxygen \tparam command, describes a template parameter.
Definition: Comment.h:799
Dataflow Directional Tag Classes.
BlockCommandComment * actOnBlockCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
Definition: CommentSema.cpp:49
Information about the declaration, useful to clients of FullComment.
Definition: Comment.h:980
A single paragraph that contains inline content.
Definition: Comment.h:546
HTMLEndTagComment * actOnHTMLEndTag(SourceLocation LocBegin, SourceLocation LocEnd, StringRef TagName)
void actOnTParamCommandParamNameArg(TParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)
Defines the clang::SourceLocation class and associated facilities.
void setDecl(const Decl *D)
Definition: CommentSema.cpp:35
InlineCommandComment * actOnInlineCommand(SourceLocation CommandLocBegin, SourceLocation CommandLocEnd, unsigned CommandID)
Doxygen \param command.
Definition: Comment.h:711
StringRef Text
Definition: Format.cpp:1750
void actOnParamCommandParamNameArg(ParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)
void resolveParamCommandIndexes(const FullComment *FC)
Resolve parameter names to parameter indexes in function declaration.
This class handles loading and caching of source files into memory.
void actOnParamCommandDirectionArg(ParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)
A full comment attached to a declaration, contains block content.
Definition: Comment.h:1091
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:125