clang  3.7.0
CommentSema.h
Go to the documentation of this file.
1 //===--- CommentSema.h - Doxygen comment semantic analysis ------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the semantic analysis class for Doxygen comments.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_AST_COMMENTSEMA_H
15 #define LLVM_CLANG_AST_COMMENTSEMA_H
16 
17 #include "clang/AST/Comment.h"
18 #include "clang/Basic/Diagnostic.h"
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/Support/Allocator.h"
24 
25 namespace clang {
26 class Decl;
27 class SourceMgr;
28 class Preprocessor;
29 
30 namespace comments {
31 class CommandTraits;
32 
33 class Sema {
34  Sema(const Sema &) = delete;
35  void operator=(const Sema &) = delete;
36 
37  /// Allocator for AST nodes.
38  llvm::BumpPtrAllocator &Allocator;
39 
40  /// Source manager for the comment being parsed.
41  const SourceManager &SourceMgr;
42 
43  DiagnosticsEngine &Diags;
44 
45  CommandTraits &Traits;
46 
47  const Preprocessor *PP;
48 
49  /// Information about the declaration this comment is attached to.
50  DeclInfo *ThisDeclInfo;
51 
52  /// Comment AST nodes that correspond to parameter names in
53  /// \c TemplateParameters.
54  ///
55  /// Contains a valid value if \c DeclInfo->IsFilled is true.
56  llvm::StringMap<TParamCommandComment *> TemplateParameterDocs;
57 
58  /// AST node for the \\brief command and its aliases.
59  const BlockCommandComment *BriefCommand;
60 
61  /// AST node for the \\headerfile command.
62  const BlockCommandComment *HeaderfileCommand;
63 
64  DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) {
65  return Diags.Report(Loc, DiagID);
66  }
67 
68  /// A stack of HTML tags that are currently open (not matched with closing
69  /// tags).
71 
72 public:
73  Sema(llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr,
74  DiagnosticsEngine &Diags, CommandTraits &Traits,
75  const Preprocessor *PP);
76 
77  void setDecl(const Decl *D);
78 
79  /// Returns a copy of array, owned by Sema's allocator.
80  template<typename T>
82  size_t Size = Source.size();
83  if (Size != 0) {
84  T *Mem = Allocator.Allocate<T>(Size);
85  std::uninitialized_copy(Source.begin(), Source.end(), Mem);
86  return llvm::makeArrayRef(Mem, Size);
87  }
88  return None;
89  }
90 
93 
95  SourceLocation LocEnd,
96  unsigned CommandID,
97  CommandMarkerKind CommandMarker);
98 
101 
103  ParagraphComment *Paragraph);
104 
106  SourceLocation LocEnd,
107  unsigned CommandID,
108  CommandMarkerKind CommandMarker);
109 
111  SourceLocation ArgLocBegin,
112  SourceLocation ArgLocEnd,
113  StringRef Arg);
114 
116  SourceLocation ArgLocBegin,
117  SourceLocation ArgLocEnd,
118  StringRef Arg);
119 
121  ParagraphComment *Paragraph);
122 
124  SourceLocation LocEnd,
125  unsigned CommandID,
126  CommandMarkerKind CommandMarker);
127 
129  SourceLocation ArgLocBegin,
130  SourceLocation ArgLocEnd,
131  StringRef Arg);
132 
134  ParagraphComment *Paragraph);
135 
137  SourceLocation CommandLocEnd,
138  unsigned CommandID);
139 
141  SourceLocation CommandLocEnd,
142  unsigned CommandID,
143  SourceLocation ArgLocBegin,
144  SourceLocation ArgLocEnd,
145  StringRef Arg);
146 
148  SourceLocation LocEnd,
149  StringRef CommandName);
150 
152  SourceLocation LocEnd,
153  unsigned CommandID);
154 
156  SourceLocation LocEnd,
157  StringRef Text);
158 
160  unsigned CommandID);
161 
163  StringRef Text);
164 
166  SourceLocation CloseNameLocBegin,
167  StringRef CloseName,
169 
171  unsigned CommandID,
172  SourceLocation TextBegin,
173  StringRef Text);
174 
176  StringRef TagName);
177 
180  SourceLocation GreaterLoc,
181  bool IsSelfClosing);
182 
184  SourceLocation LocEnd,
185  StringRef TagName);
186 
188 
190 
191  void checkReturnsCommand(const BlockCommandComment *Command);
192 
193  /// Emit diagnostics about duplicate block commands that should be
194  /// used only once per comment, e.g., \\brief and \\returns.
195  void checkBlockCommandDuplicate(const BlockCommandComment *Command);
196 
198 
200 
202 
204 
205  /// Resolve parameter names to parameter indexes in function declaration.
206  /// Emit diagnostics about unknown parametrs.
207  void resolveParamCommandIndexes(const FullComment *FC);
208 
209  bool isFunctionDecl();
210  bool isAnyFunctionDecl();
211 
212  /// \returns \c true if declaration that this comment is attached to declares
213  /// a function pointer.
216  bool isObjCMethodDecl();
217  bool isObjCPropertyDecl();
219  bool isRecordLikeDecl();
220  bool isClassOrStructDecl();
221  bool isUnionDecl();
222  bool isObjCInterfaceDecl();
223  bool isObjCProtocolDecl();
224  bool isClassTemplateDecl();
225  bool isFunctionTemplateDecl();
226 
228 
229  /// Extract all important semantic information from
230  /// \c ThisDeclInfo->ThisDecl into \c ThisDeclInfo members.
231  void inspectThisDecl();
232 
233  /// Returns index of a function parameter with a given name.
234  unsigned resolveParmVarReference(StringRef Name,
236 
237  /// Returns index of a function parameter with the name closest to a given
238  /// typo.
239  unsigned correctTypoInParmVarReference(StringRef Typo,
241 
242  bool resolveTParamReference(StringRef Name,
243  const TemplateParameterList *TemplateParameters,
245 
247  StringRef Typo,
248  const TemplateParameterList *TemplateParameters);
249 
251  getInlineCommandRenderKind(StringRef Name) const;
252 };
253 
254 } // end namespace comments
255 } // end namespace clang
256 
257 #endif
258 
void actOnParamCommandFinish(ParamCommandComment *Command, ParagraphComment *Paragraph)
StringRef correctTypoInTParamReference(StringRef Typo, const TemplateParameterList *TemplateParameters)
int Position
void actOnVerbatimBlockFinish(VerbatimBlockComment *Block, SourceLocation CloseNameLocBegin, StringRef CloseName, ArrayRef< VerbatimBlockLineComment * > Lines)
ArrayRef< const ParmVarDecl * > getParamVars()
void checkBlockCommandEmptyParagraph(BlockCommandComment *Command)
void actOnHTMLStartTagFinish(HTMLStartTagComment *Tag, ArrayRef< HTMLStartTagComment::Attribute > Attrs, SourceLocation GreaterLoc, bool IsSelfClosing)
VerbatimBlockComment * actOnVerbatimBlockStart(SourceLocation Loc, unsigned CommandID)
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1118
unsigned correctTypoInParmVarReference(StringRef Typo, ArrayRef< const ParmVarDecl * > ParamVars)
HTMLStartTagComment * actOnHTMLStartTagStart(SourceLocation LocBegin, StringRef TagName)
void actOnBlockCommandArgs(BlockCommandComment *Command, ArrayRef< BlockCommandComment::Argument > Args)
Definition: CommentSema.cpp:62
void checkContainerDeclVerbatimLine(const BlockCommandComment *Comment)
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:46
void checkBlockCommandDuplicate(const BlockCommandComment *Command)
TextComment * actOnText(SourceLocation LocBegin, SourceLocation LocEnd, StringRef Text)
A command with word-like arguments that is considered inline content.
Definition: Comment.h:303
A line of text contained in a verbatim block.
Definition: Comment.h:869
void checkReturnsCommand(const BlockCommandComment *Command)
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:135
InlineContentComment * actOnUnknownCommand(SourceLocation LocBegin, SourceLocation LocEnd, StringRef CommandName)
ArrayRef< T > copyArray(ArrayRef< T > Source)
Returns a copy of array, owned by Sema's allocator.
Definition: CommentSema.h:81
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:866
bool resolveTParamReference(StringRef Name, const TemplateParameterList *TemplateParameters, SmallVectorImpl< unsigned > *Position)
void actOnTParamCommandFinish(TParamCommandComment *Command, ParagraphComment *Paragraph)
SourceManager & SourceMgr
Definition: Format.cpp:1205
VerbatimBlockLineComment * actOnVerbatimBlockLine(SourceLocation Loc, StringRef Text)
An opening HTML tag with attributes.
Definition: Comment.h:419
void checkFunctionDeclVerbatimLine(const BlockCommandComment *Comment)
Definition: CommentSema.cpp:98
TParamCommandComment * actOnTParamCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
void actOnBlockCommandFinish(BlockCommandComment *Command, ParagraphComment *Paragraph)
Definition: CommentSema.cpp:67
ParagraphComment * actOnParagraphComment(ArrayRef< InlineContentComment * > Content)
Definition: CommentSema.cpp:45
void checkDeprecatedCommand(const BlockCommandComment *Comment)
void checkContainerDecl(const BlockCommandComment *Comment)
Encodes a location in the source. The SourceManager can decode this to get at the full include stack...
VerbatimLineComment * actOnVerbatimLine(SourceLocation LocBegin, unsigned CommandID, SourceLocation TextBegin, StringRef Text)
ParamCommandComment * actOnParamCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
Definition: CommentSema.cpp:80
A closing HTML tag.
Definition: Comment.h:513
Doxygen \tparam command, describes a template parameter.
Definition: Comment.h:805
BlockCommandComment * actOnBlockCommandStart(SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
Definition: CommentSema.cpp:50
Information about the declaration, useful to clients of FullComment.
Definition: Comment.h:986
A single paragraph that contains inline content.
Definition: Comment.h:552
StringRef Typo
HTMLEndTagComment * actOnHTMLEndTag(SourceLocation LocBegin, SourceLocation LocEnd, StringRef TagName)
Defines the Diagnostic-related interfaces.
void actOnTParamCommandParamNameArg(TParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)
FullComment * actOnFullComment(ArrayRef< BlockContentComment * > Blocks)
Defines the clang::SourceLocation class and associated facilities.
void setDecl(const Decl *D)
Definition: CommentSema.cpp:36
InlineCommandComment::RenderKind getInlineCommandRenderKind(StringRef Name) const
InlineCommandComment * actOnInlineCommand(SourceLocation CommandLocBegin, SourceLocation CommandLocEnd, unsigned CommandID)
Doxygen \param command.
Definition: Comment.h:717
void actOnParamCommandParamNameArg(ParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)
unsigned resolveParmVarReference(StringRef Name, ArrayRef< const ParmVarDecl * > ParamVars)
Returns index of a function parameter with a given name.
void resolveParamCommandIndexes(const FullComment *FC)
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:1097
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:96