Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 1 | //===--- CommentSema.cpp - Doxygen comment semantic analysis --------------===// |
| 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 | #include "clang/AST/CommentSema.h" |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 11 | #include "clang/AST/CommentDiagnostic.h" |
Dmitri Gribenko | aa58081 | 2012-08-09 00:03:17 +0000 | [diff] [blame] | 12 | #include "clang/AST/CommentCommandTraits.h" |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 13 | #include "clang/AST/Decl.h" |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 14 | #include "clang/AST/DeclTemplate.h" |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 15 | #include "clang/Basic/SourceManager.h" |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 16 | #include "llvm/ADT/StringSwitch.h" |
| 17 | |
| 18 | namespace clang { |
| 19 | namespace comments { |
| 20 | |
Dmitri Gribenko | c24a76e | 2012-08-31 02:21:44 +0000 | [diff] [blame] | 21 | namespace { |
| 22 | #include "clang/AST/CommentHTMLTagsProperties.inc" |
| 23 | } // unnamed namespace |
| 24 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 25 | Sema::Sema(llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 26 | DiagnosticsEngine &Diags, CommandTraits &Traits) : |
Dmitri Gribenko | aa58081 | 2012-08-09 00:03:17 +0000 | [diff] [blame] | 27 | Allocator(Allocator), SourceMgr(SourceMgr), Diags(Diags), Traits(Traits), |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 28 | ThisDeclInfo(NULL), BriefCommand(NULL), ReturnsCommand(NULL) { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 29 | } |
| 30 | |
| 31 | void Sema::setDecl(const Decl *D) { |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 32 | if (!D) |
| 33 | return; |
| 34 | |
| 35 | ThisDeclInfo = new (Allocator) DeclInfo; |
| 36 | ThisDeclInfo->ThisDecl = D; |
Dmitri Gribenko | 651f8ce | 2012-08-01 23:21:57 +0000 | [diff] [blame] | 37 | ThisDeclInfo->IsFilled = false; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 38 | } |
| 39 | |
| 40 | ParagraphComment *Sema::actOnParagraphComment( |
| 41 | ArrayRef<InlineContentComment *> Content) { |
| 42 | return new (Allocator) ParagraphComment(Content); |
| 43 | } |
| 44 | |
| 45 | BlockCommandComment *Sema::actOnBlockCommandStart(SourceLocation LocBegin, |
| 46 | SourceLocation LocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 47 | unsigned CommandID) { |
| 48 | return new (Allocator) BlockCommandComment(LocBegin, LocEnd, CommandID); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 49 | } |
| 50 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 51 | void Sema::actOnBlockCommandArgs(BlockCommandComment *Command, |
| 52 | ArrayRef<BlockCommandComment::Argument> Args) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 53 | Command->setArgs(Args); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 54 | } |
| 55 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 56 | void Sema::actOnBlockCommandFinish(BlockCommandComment *Command, |
| 57 | ParagraphComment *Paragraph) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 58 | Command->setParagraph(Paragraph); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 59 | checkBlockCommandEmptyParagraph(Command); |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 60 | checkBlockCommandDuplicate(Command); |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 61 | checkReturnsCommand(Command); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | ParamCommandComment *Sema::actOnParamCommandStart(SourceLocation LocBegin, |
| 65 | SourceLocation LocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 66 | unsigned CommandID) { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 67 | ParamCommandComment *Command = |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 68 | new (Allocator) ParamCommandComment(LocBegin, LocEnd, CommandID); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 69 | |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 70 | if (!isFunctionDecl()) |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 71 | Diag(Command->getLocation(), |
| 72 | diag::warn_doc_param_not_attached_to_a_function_decl) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 73 | << Command->getCommandNameRange(Traits); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 74 | |
| 75 | return Command; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 76 | } |
| 77 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 78 | void Sema::actOnParamCommandDirectionArg(ParamCommandComment *Command, |
| 79 | SourceLocation ArgLocBegin, |
| 80 | SourceLocation ArgLocEnd, |
| 81 | StringRef Arg) { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 82 | ParamCommandComment::PassDirection Direction; |
| 83 | std::string ArgLower = Arg.lower(); |
| 84 | // TODO: optimize: lower Name first (need an API in SmallString for that), |
| 85 | // after that StringSwitch. |
| 86 | if (ArgLower == "[in]") |
| 87 | Direction = ParamCommandComment::In; |
| 88 | else if (ArgLower == "[out]") |
| 89 | Direction = ParamCommandComment::Out; |
| 90 | else if (ArgLower == "[in,out]" || ArgLower == "[out,in]") |
| 91 | Direction = ParamCommandComment::InOut; |
| 92 | else { |
| 93 | // Remove spaces. |
| 94 | std::string::iterator O = ArgLower.begin(); |
| 95 | for (std::string::iterator I = ArgLower.begin(), E = ArgLower.end(); |
| 96 | I != E; ++I) { |
| 97 | const char C = *I; |
| 98 | if (C != ' ' && C != '\n' && C != '\r' && |
| 99 | C != '\t' && C != '\v' && C != '\f') |
| 100 | *O++ = C; |
| 101 | } |
| 102 | ArgLower.resize(O - ArgLower.begin()); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 103 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 104 | bool RemovingWhitespaceHelped = false; |
| 105 | if (ArgLower == "[in]") { |
| 106 | Direction = ParamCommandComment::In; |
| 107 | RemovingWhitespaceHelped = true; |
| 108 | } else if (ArgLower == "[out]") { |
| 109 | Direction = ParamCommandComment::Out; |
| 110 | RemovingWhitespaceHelped = true; |
| 111 | } else if (ArgLower == "[in,out]" || ArgLower == "[out,in]") { |
| 112 | Direction = ParamCommandComment::InOut; |
| 113 | RemovingWhitespaceHelped = true; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 114 | } else { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 115 | Direction = ParamCommandComment::In; |
| 116 | RemovingWhitespaceHelped = false; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 117 | } |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 118 | |
| 119 | SourceRange ArgRange(ArgLocBegin, ArgLocEnd); |
| 120 | if (RemovingWhitespaceHelped) |
| 121 | Diag(ArgLocBegin, diag::warn_doc_param_spaces_in_direction) |
| 122 | << ArgRange |
| 123 | << FixItHint::CreateReplacement( |
| 124 | ArgRange, |
| 125 | ParamCommandComment::getDirectionAsString(Direction)); |
| 126 | else |
| 127 | Diag(ArgLocBegin, diag::warn_doc_param_invalid_direction) |
| 128 | << ArgRange; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 129 | } |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 130 | Command->setDirection(Direction, /* Explicit = */ true); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 131 | } |
| 132 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 133 | void Sema::actOnParamCommandParamNameArg(ParamCommandComment *Command, |
| 134 | SourceLocation ArgLocBegin, |
| 135 | SourceLocation ArgLocEnd, |
| 136 | StringRef Arg) { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 137 | // Parser will not feed us more arguments than needed. |
Dmitri Gribenko | 0eaf69d | 2012-07-13 19:02:42 +0000 | [diff] [blame] | 138 | assert(Command->getNumArgs() == 0); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 139 | |
| 140 | if (!Command->isDirectionExplicit()) { |
| 141 | // User didn't provide a direction argument. |
| 142 | Command->setDirection(ParamCommandComment::In, /* Explicit = */ false); |
| 143 | } |
| 144 | typedef BlockCommandComment::Argument Argument; |
| 145 | Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin, |
| 146 | ArgLocEnd), |
| 147 | Arg); |
| 148 | Command->setArgs(llvm::makeArrayRef(A, 1)); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 149 | } |
| 150 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 151 | void Sema::actOnParamCommandFinish(ParamCommandComment *Command, |
| 152 | ParagraphComment *Paragraph) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 153 | Command->setParagraph(Paragraph); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 154 | checkBlockCommandEmptyParagraph(Command); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 155 | } |
| 156 | |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 157 | TParamCommandComment *Sema::actOnTParamCommandStart(SourceLocation LocBegin, |
| 158 | SourceLocation LocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 159 | unsigned CommandID) { |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 160 | TParamCommandComment *Command = |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 161 | new (Allocator) TParamCommandComment(LocBegin, LocEnd, CommandID); |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 162 | |
Dmitri Gribenko | 04bf29e | 2012-08-06 21:31:15 +0000 | [diff] [blame] | 163 | if (!isTemplateOrSpecialization()) |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 164 | Diag(Command->getLocation(), |
| 165 | diag::warn_doc_tparam_not_attached_to_a_template_decl) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 166 | << Command->getCommandNameRange(Traits); |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 167 | |
| 168 | return Command; |
| 169 | } |
| 170 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 171 | void Sema::actOnTParamCommandParamNameArg(TParamCommandComment *Command, |
| 172 | SourceLocation ArgLocBegin, |
| 173 | SourceLocation ArgLocEnd, |
| 174 | StringRef Arg) { |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 175 | // Parser will not feed us more arguments than needed. |
| 176 | assert(Command->getNumArgs() == 0); |
| 177 | |
| 178 | typedef BlockCommandComment::Argument Argument; |
| 179 | Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin, |
| 180 | ArgLocEnd), |
| 181 | Arg); |
| 182 | Command->setArgs(llvm::makeArrayRef(A, 1)); |
| 183 | |
Dmitri Gribenko | 04bf29e | 2012-08-06 21:31:15 +0000 | [diff] [blame] | 184 | if (!isTemplateOrSpecialization()) { |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 185 | // We already warned that this \\tparam is not attached to a template decl. |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 186 | return; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 187 | } |
| 188 | |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 189 | const TemplateParameterList *TemplateParameters = |
| 190 | ThisDeclInfo->TemplateParameters; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 191 | SmallVector<unsigned, 2> Position; |
| 192 | if (resolveTParamReference(Arg, TemplateParameters, &Position)) { |
| 193 | Command->setPosition(copyArray(llvm::makeArrayRef(Position))); |
| 194 | llvm::StringMap<TParamCommandComment *>::iterator PrevCommandIt = |
| 195 | TemplateParameterDocs.find(Arg); |
| 196 | if (PrevCommandIt != TemplateParameterDocs.end()) { |
| 197 | SourceRange ArgRange(ArgLocBegin, ArgLocEnd); |
| 198 | Diag(ArgLocBegin, diag::warn_doc_tparam_duplicate) |
| 199 | << Arg << ArgRange; |
| 200 | TParamCommandComment *PrevCommand = PrevCommandIt->second; |
| 201 | Diag(PrevCommand->getLocation(), diag::note_doc_tparam_previous) |
| 202 | << PrevCommand->getParamNameRange(); |
| 203 | } |
| 204 | TemplateParameterDocs[Arg] = Command; |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 205 | return; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 206 | } |
| 207 | |
| 208 | SourceRange ArgRange(ArgLocBegin, ArgLocEnd); |
| 209 | Diag(ArgLocBegin, diag::warn_doc_tparam_not_found) |
| 210 | << Arg << ArgRange; |
| 211 | |
| 212 | if (!TemplateParameters || TemplateParameters->size() == 0) |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 213 | return; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 214 | |
| 215 | StringRef CorrectedName; |
| 216 | if (TemplateParameters->size() == 1) { |
| 217 | const NamedDecl *Param = TemplateParameters->getParam(0); |
| 218 | const IdentifierInfo *II = Param->getIdentifier(); |
| 219 | if (II) |
| 220 | CorrectedName = II->getName(); |
| 221 | } else { |
| 222 | CorrectedName = correctTypoInTParamReference(Arg, TemplateParameters); |
| 223 | } |
| 224 | |
| 225 | if (!CorrectedName.empty()) { |
| 226 | Diag(ArgLocBegin, diag::note_doc_tparam_name_suggestion) |
| 227 | << CorrectedName |
| 228 | << FixItHint::CreateReplacement(ArgRange, CorrectedName); |
| 229 | } |
| 230 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 231 | return; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 232 | } |
| 233 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 234 | void Sema::actOnTParamCommandFinish(TParamCommandComment *Command, |
| 235 | ParagraphComment *Paragraph) { |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 236 | Command->setParagraph(Paragraph); |
| 237 | checkBlockCommandEmptyParagraph(Command); |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 238 | } |
| 239 | |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 240 | InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin, |
| 241 | SourceLocation CommandLocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 242 | unsigned CommandID) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 243 | ArrayRef<InlineCommandComment::Argument> Args; |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 244 | StringRef CommandName = Traits.getCommandInfo(CommandID)->Name; |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 245 | return new (Allocator) InlineCommandComment( |
| 246 | CommandLocBegin, |
| 247 | CommandLocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 248 | CommandID, |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 249 | getInlineCommandRenderKind(CommandName), |
| 250 | Args); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin, |
| 254 | SourceLocation CommandLocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 255 | unsigned CommandID, |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 256 | SourceLocation ArgLocBegin, |
| 257 | SourceLocation ArgLocEnd, |
| 258 | StringRef Arg) { |
| 259 | typedef InlineCommandComment::Argument Argument; |
| 260 | Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin, |
| 261 | ArgLocEnd), |
| 262 | Arg); |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 263 | StringRef CommandName = Traits.getCommandInfo(CommandID)->Name; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 264 | |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 265 | return new (Allocator) InlineCommandComment( |
| 266 | CommandLocBegin, |
| 267 | CommandLocEnd, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 268 | CommandID, |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 269 | getInlineCommandRenderKind(CommandName), |
| 270 | llvm::makeArrayRef(A, 1)); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 271 | } |
| 272 | |
| 273 | InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin, |
| 274 | SourceLocation LocEnd, |
Dmitri Gribenko | b0b8a96 | 2012-09-11 19:22:03 +0000 | [diff] [blame] | 275 | StringRef CommandName) { |
| 276 | unsigned CommandID = Traits.registerUnknownCommand(CommandName)->getID(); |
| 277 | return actOnUnknownCommand(LocBegin, LocEnd, CommandID); |
| 278 | } |
| 279 | |
| 280 | InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin, |
| 281 | SourceLocation LocEnd, |
| 282 | unsigned CommandID) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 283 | ArrayRef<InlineCommandComment::Argument> Args; |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 284 | return new (Allocator) InlineCommandComment( |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 285 | LocBegin, LocEnd, CommandID, |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 286 | InlineCommandComment::RenderNormal, |
| 287 | Args); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 288 | } |
| 289 | |
| 290 | TextComment *Sema::actOnText(SourceLocation LocBegin, |
| 291 | SourceLocation LocEnd, |
| 292 | StringRef Text) { |
| 293 | return new (Allocator) TextComment(LocBegin, LocEnd, Text); |
| 294 | } |
| 295 | |
| 296 | VerbatimBlockComment *Sema::actOnVerbatimBlockStart(SourceLocation Loc, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 297 | unsigned CommandID) { |
| 298 | StringRef CommandName = Traits.getCommandInfo(CommandID)->Name; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 299 | return new (Allocator) VerbatimBlockComment( |
| 300 | Loc, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 301 | Loc.getLocWithOffset(1 + CommandName.size()), |
| 302 | CommandID); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 303 | } |
| 304 | |
| 305 | VerbatimBlockLineComment *Sema::actOnVerbatimBlockLine(SourceLocation Loc, |
| 306 | StringRef Text) { |
| 307 | return new (Allocator) VerbatimBlockLineComment(Loc, Text); |
| 308 | } |
| 309 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 310 | void Sema::actOnVerbatimBlockFinish( |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 311 | VerbatimBlockComment *Block, |
| 312 | SourceLocation CloseNameLocBegin, |
| 313 | StringRef CloseName, |
| 314 | ArrayRef<VerbatimBlockLineComment *> Lines) { |
| 315 | Block->setCloseName(CloseName, CloseNameLocBegin); |
| 316 | Block->setLines(Lines); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 317 | } |
| 318 | |
| 319 | VerbatimLineComment *Sema::actOnVerbatimLine(SourceLocation LocBegin, |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 320 | unsigned CommandID, |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 321 | SourceLocation TextBegin, |
| 322 | StringRef Text) { |
| 323 | return new (Allocator) VerbatimLineComment( |
| 324 | LocBegin, |
| 325 | TextBegin.getLocWithOffset(Text.size()), |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 326 | CommandID, |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 327 | TextBegin, |
| 328 | Text); |
| 329 | } |
| 330 | |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 331 | HTMLStartTagComment *Sema::actOnHTMLStartTagStart(SourceLocation LocBegin, |
| 332 | StringRef TagName) { |
| 333 | return new (Allocator) HTMLStartTagComment(LocBegin, TagName); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 334 | } |
| 335 | |
Dmitri Gribenko | 7d9b511 | 2012-08-06 19:03:12 +0000 | [diff] [blame] | 336 | void Sema::actOnHTMLStartTagFinish( |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 337 | HTMLStartTagComment *Tag, |
| 338 | ArrayRef<HTMLStartTagComment::Attribute> Attrs, |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 339 | SourceLocation GreaterLoc, |
| 340 | bool IsSelfClosing) { |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 341 | Tag->setAttrs(Attrs); |
| 342 | Tag->setGreaterLoc(GreaterLoc); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 343 | if (IsSelfClosing) |
| 344 | Tag->setSelfClosing(); |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 345 | else if (!isHTMLEndTagForbidden(Tag->getTagName())) |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 346 | HTMLOpenTags.push_back(Tag); |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 347 | } |
| 348 | |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 349 | HTMLEndTagComment *Sema::actOnHTMLEndTag(SourceLocation LocBegin, |
| 350 | SourceLocation LocEnd, |
| 351 | StringRef TagName) { |
| 352 | HTMLEndTagComment *HET = |
| 353 | new (Allocator) HTMLEndTagComment(LocBegin, LocEnd, TagName); |
| 354 | if (isHTMLEndTagForbidden(TagName)) { |
| 355 | Diag(HET->getLocation(), diag::warn_doc_html_end_forbidden) |
| 356 | << TagName << HET->getSourceRange(); |
| 357 | return HET; |
Dmitri Gribenko | 3d98698 | 2012-07-12 23:37:09 +0000 | [diff] [blame] | 358 | } |
| 359 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 360 | bool FoundOpen = false; |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 361 | for (SmallVectorImpl<HTMLStartTagComment *>::const_reverse_iterator |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 362 | I = HTMLOpenTags.rbegin(), E = HTMLOpenTags.rend(); |
| 363 | I != E; ++I) { |
| 364 | if ((*I)->getTagName() == TagName) { |
| 365 | FoundOpen = true; |
| 366 | break; |
| 367 | } |
| 368 | } |
| 369 | if (!FoundOpen) { |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 370 | Diag(HET->getLocation(), diag::warn_doc_html_end_unbalanced) |
| 371 | << HET->getSourceRange(); |
| 372 | return HET; |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 373 | } |
| 374 | |
| 375 | while (!HTMLOpenTags.empty()) { |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 376 | const HTMLStartTagComment *HST = HTMLOpenTags.back(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 377 | HTMLOpenTags.pop_back(); |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 378 | StringRef LastNotClosedTagName = HST->getTagName(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 379 | if (LastNotClosedTagName == TagName) |
| 380 | break; |
| 381 | |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 382 | if (isHTMLEndTagOptional(LastNotClosedTagName)) |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 383 | continue; |
| 384 | |
| 385 | bool OpenLineInvalid; |
| 386 | const unsigned OpenLine = SourceMgr.getPresumedLineNumber( |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 387 | HST->getLocation(), |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 388 | &OpenLineInvalid); |
| 389 | bool CloseLineInvalid; |
| 390 | const unsigned CloseLine = SourceMgr.getPresumedLineNumber( |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 391 | HET->getLocation(), |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 392 | &CloseLineInvalid); |
| 393 | |
| 394 | if (OpenLineInvalid || CloseLineInvalid || OpenLine == CloseLine) |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 395 | Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch) |
| 396 | << HST->getTagName() << HET->getTagName() |
| 397 | << HST->getSourceRange() << HET->getSourceRange(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 398 | else { |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 399 | Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch) |
| 400 | << HST->getTagName() << HET->getTagName() |
| 401 | << HST->getSourceRange(); |
| 402 | Diag(HET->getLocation(), diag::note_doc_html_end_tag) |
| 403 | << HET->getSourceRange(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 404 | } |
| 405 | } |
| 406 | |
Dmitri Gribenko | 3f38bf2 | 2012-07-13 00:44:24 +0000 | [diff] [blame] | 407 | return HET; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 408 | } |
| 409 | |
| 410 | FullComment *Sema::actOnFullComment( |
| 411 | ArrayRef<BlockContentComment *> Blocks) { |
Dmitri Gribenko | 9edd2c8 | 2012-08-24 17:45:39 +0000 | [diff] [blame] | 412 | FullComment *FC = new (Allocator) FullComment(Blocks, ThisDeclInfo); |
| 413 | resolveParamCommandIndexes(FC); |
| 414 | return FC; |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 415 | } |
| 416 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 417 | void Sema::checkBlockCommandEmptyParagraph(BlockCommandComment *Command) { |
Dmitri Gribenko | abcf0dc | 2012-09-13 20:36:01 +0000 | [diff] [blame] | 418 | if (Traits.getCommandInfo(Command->getCommandID())->IsEmptyParagraphAllowed) |
| 419 | return; |
| 420 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 421 | ParagraphComment *Paragraph = Command->getParagraph(); |
| 422 | if (Paragraph->isWhitespace()) { |
| 423 | SourceLocation DiagLoc; |
Dmitri Gribenko | 0eaf69d | 2012-07-13 19:02:42 +0000 | [diff] [blame] | 424 | if (Command->getNumArgs() > 0) |
| 425 | DiagLoc = Command->getArgRange(Command->getNumArgs() - 1).getEnd(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 426 | if (!DiagLoc.isValid()) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 427 | DiagLoc = Command->getCommandNameRange(Traits).getEnd(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 428 | Diag(DiagLoc, diag::warn_doc_block_command_empty_paragraph) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 429 | << Command->getCommandName(Traits) |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 430 | << Command->getSourceRange(); |
| 431 | } |
| 432 | } |
| 433 | |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 434 | void Sema::checkReturnsCommand(const BlockCommandComment *Command) { |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 435 | if (!Traits.getCommandInfo(Command->getCommandID())->IsReturnsCommand) |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 436 | return; |
| 437 | if (isFunctionDecl()) { |
| 438 | if (ThisDeclInfo->ResultType->isVoidType()) { |
| 439 | unsigned DiagKind; |
| 440 | switch (ThisDeclInfo->ThisDecl->getKind()) { |
| 441 | default: |
Dmitri Gribenko | 88815f3 | 2012-08-06 16:29:26 +0000 | [diff] [blame] | 442 | if (ThisDeclInfo->IsObjCMethod) |
| 443 | DiagKind = 3; |
| 444 | else |
| 445 | DiagKind = 0; |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 446 | break; |
| 447 | case Decl::CXXConstructor: |
| 448 | DiagKind = 1; |
| 449 | break; |
| 450 | case Decl::CXXDestructor: |
| 451 | DiagKind = 2; |
| 452 | break; |
| 453 | } |
| 454 | Diag(Command->getLocation(), |
| 455 | diag::warn_doc_returns_attached_to_a_void_function) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 456 | << Command->getCommandName(Traits) |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 457 | << DiagKind |
| 458 | << Command->getSourceRange(); |
| 459 | } |
| 460 | return; |
| 461 | } |
| 462 | Diag(Command->getLocation(), |
| 463 | diag::warn_doc_returns_not_attached_to_a_function_decl) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 464 | << Command->getCommandName(Traits) |
Dmitri Gribenko | 89ab7d0 | 2012-08-03 21:15:32 +0000 | [diff] [blame] | 465 | << Command->getSourceRange(); |
| 466 | } |
| 467 | |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 468 | void Sema::checkBlockCommandDuplicate(const BlockCommandComment *Command) { |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 469 | const CommandInfo *Info = Traits.getCommandInfo(Command->getCommandID()); |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 470 | const BlockCommandComment *PrevCommand = NULL; |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 471 | if (Info->IsBriefCommand) { |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 472 | if (!BriefCommand) { |
| 473 | BriefCommand = Command; |
| 474 | return; |
| 475 | } |
| 476 | PrevCommand = BriefCommand; |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 477 | } else if (Info->IsReturnsCommand) { |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 478 | if (!ReturnsCommand) { |
| 479 | ReturnsCommand = Command; |
| 480 | return; |
| 481 | } |
| 482 | PrevCommand = ReturnsCommand; |
| 483 | } else { |
| 484 | // We don't want to check this command for duplicates. |
| 485 | return; |
| 486 | } |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 487 | StringRef CommandName = Command->getCommandName(Traits); |
| 488 | StringRef PrevCommandName = PrevCommand->getCommandName(Traits); |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 489 | Diag(Command->getLocation(), diag::warn_doc_block_command_duplicate) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 490 | << CommandName |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 491 | << Command->getSourceRange(); |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 492 | if (CommandName == PrevCommandName) |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 493 | Diag(PrevCommand->getLocation(), diag::note_doc_block_command_previous) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 494 | << PrevCommandName |
| 495 | << PrevCommand->getSourceRange(); |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 496 | else |
| 497 | Diag(PrevCommand->getLocation(), |
| 498 | diag::note_doc_block_command_previous_alias) |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 499 | << PrevCommandName |
| 500 | << CommandName; |
Dmitri Gribenko | 9443c57 | 2012-08-06 17:08:27 +0000 | [diff] [blame] | 501 | } |
| 502 | |
Dmitri Gribenko | 9edd2c8 | 2012-08-24 17:45:39 +0000 | [diff] [blame] | 503 | void Sema::resolveParamCommandIndexes(const FullComment *FC) { |
| 504 | if (!isFunctionDecl()) { |
| 505 | // We already warned that \\param commands are not attached to a function |
| 506 | // decl. |
| 507 | return; |
| 508 | } |
| 509 | |
| 510 | llvm::SmallVector<ParamCommandComment *, 8> UnresolvedParamCommands; |
| 511 | |
| 512 | // Comment AST nodes that correspond to \c ParamVars for which we have |
| 513 | // found a \\param command or NULL if no documentation was found so far. |
| 514 | llvm::SmallVector<ParamCommandComment *, 8> ParamVarDocs; |
| 515 | |
| 516 | ArrayRef<const ParmVarDecl *> ParamVars = getParamVars(); |
| 517 | ParamVarDocs.resize(ParamVars.size(), NULL); |
| 518 | |
| 519 | // First pass over all \\param commands: resolve all parameter names. |
| 520 | for (Comment::child_iterator I = FC->child_begin(), E = FC->child_end(); |
| 521 | I != E; ++I) { |
| 522 | ParamCommandComment *PCC = dyn_cast<ParamCommandComment>(*I); |
| 523 | if (!PCC || !PCC->hasParamName()) |
| 524 | continue; |
| 525 | StringRef ParamName = PCC->getParamName(); |
| 526 | |
| 527 | // Check that referenced parameter name is in the function decl. |
| 528 | const unsigned ResolvedParamIndex = resolveParmVarReference(ParamName, |
| 529 | ParamVars); |
| 530 | if (ResolvedParamIndex == ParamCommandComment::InvalidParamIndex) { |
| 531 | UnresolvedParamCommands.push_back(PCC); |
| 532 | continue; |
| 533 | } |
| 534 | PCC->setParamIndex(ResolvedParamIndex); |
| 535 | if (ParamVarDocs[ResolvedParamIndex]) { |
| 536 | SourceRange ArgRange = PCC->getParamNameRange(); |
| 537 | Diag(ArgRange.getBegin(), diag::warn_doc_param_duplicate) |
| 538 | << ParamName << ArgRange; |
| 539 | ParamCommandComment *PrevCommand = ParamVarDocs[ResolvedParamIndex]; |
| 540 | Diag(PrevCommand->getLocation(), diag::note_doc_param_previous) |
| 541 | << PrevCommand->getParamNameRange(); |
| 542 | } |
| 543 | ParamVarDocs[ResolvedParamIndex] = PCC; |
| 544 | } |
| 545 | |
| 546 | // Find parameter declarations that have no corresponding \\param. |
| 547 | llvm::SmallVector<const ParmVarDecl *, 8> OrphanedParamDecls; |
| 548 | for (unsigned i = 0, e = ParamVarDocs.size(); i != e; ++i) { |
| 549 | if (!ParamVarDocs[i]) |
| 550 | OrphanedParamDecls.push_back(ParamVars[i]); |
| 551 | } |
| 552 | |
| 553 | // Second pass over unresolved \\param commands: do typo correction. |
| 554 | // Suggest corrections from a set of parameter declarations that have no |
| 555 | // corresponding \\param. |
| 556 | for (unsigned i = 0, e = UnresolvedParamCommands.size(); i != e; ++i) { |
| 557 | const ParamCommandComment *PCC = UnresolvedParamCommands[i]; |
| 558 | |
| 559 | SourceRange ArgRange = PCC->getParamNameRange(); |
| 560 | StringRef ParamName = PCC->getParamName(); |
| 561 | Diag(ArgRange.getBegin(), diag::warn_doc_param_not_found) |
| 562 | << ParamName << ArgRange; |
| 563 | |
| 564 | // All parameters documented -- can't suggest a correction. |
| 565 | if (OrphanedParamDecls.size() == 0) |
| 566 | continue; |
| 567 | |
| 568 | unsigned CorrectedParamIndex = ParamCommandComment::InvalidParamIndex; |
| 569 | if (OrphanedParamDecls.size() == 1) { |
| 570 | // If one parameter is not documented then that parameter is the only |
| 571 | // possible suggestion. |
| 572 | CorrectedParamIndex = 0; |
| 573 | } else { |
| 574 | // Do typo correction. |
| 575 | CorrectedParamIndex = correctTypoInParmVarReference(ParamName, |
| 576 | OrphanedParamDecls); |
| 577 | } |
| 578 | if (CorrectedParamIndex != ParamCommandComment::InvalidParamIndex) { |
| 579 | const ParmVarDecl *CorrectedPVD = OrphanedParamDecls[CorrectedParamIndex]; |
| 580 | if (const IdentifierInfo *CorrectedII = CorrectedPVD->getIdentifier()) |
| 581 | Diag(ArgRange.getBegin(), diag::note_doc_param_name_suggestion) |
| 582 | << CorrectedII->getName() |
| 583 | << FixItHint::CreateReplacement(ArgRange, CorrectedII->getName()); |
| 584 | } |
| 585 | } |
| 586 | } |
| 587 | |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 588 | bool Sema::isFunctionDecl() { |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 589 | if (!ThisDeclInfo) |
| 590 | return false; |
| 591 | if (!ThisDeclInfo->IsFilled) |
Dmitri Gribenko | 00c59f7 | 2012-07-24 20:58:46 +0000 | [diff] [blame] | 592 | inspectThisDecl(); |
Dmitri Gribenko | af19a6a | 2012-08-02 21:45:39 +0000 | [diff] [blame] | 593 | return ThisDeclInfo->getKind() == DeclInfo::FunctionKind; |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 594 | } |
| 595 | |
Dmitri Gribenko | 04bf29e | 2012-08-06 21:31:15 +0000 | [diff] [blame] | 596 | bool Sema::isTemplateOrSpecialization() { |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 597 | if (!ThisDeclInfo) |
| 598 | return false; |
| 599 | if (!ThisDeclInfo->IsFilled) |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 600 | inspectThisDecl(); |
Dmitri Gribenko | 04bf29e | 2012-08-06 21:31:15 +0000 | [diff] [blame] | 601 | return ThisDeclInfo->getTemplateKind() != DeclInfo::NotTemplate; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 602 | } |
| 603 | |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 604 | ArrayRef<const ParmVarDecl *> Sema::getParamVars() { |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 605 | if (!ThisDeclInfo->IsFilled) |
Dmitri Gribenko | 00c59f7 | 2012-07-24 20:58:46 +0000 | [diff] [blame] | 606 | inspectThisDecl(); |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 607 | return ThisDeclInfo->ParamVars; |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 608 | } |
| 609 | |
| 610 | void Sema::inspectThisDecl() { |
Dmitri Gribenko | 1ca7ecc | 2012-08-01 23:08:09 +0000 | [diff] [blame] | 611 | ThisDeclInfo->fill(); |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 612 | } |
| 613 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 614 | unsigned Sema::resolveParmVarReference(StringRef Name, |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 615 | ArrayRef<const ParmVarDecl *> ParamVars) { |
| 616 | for (unsigned i = 0, e = ParamVars.size(); i != e; ++i) { |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 617 | const IdentifierInfo *II = ParamVars[i]->getIdentifier(); |
| 618 | if (II && II->getName() == Name) |
| 619 | return i; |
| 620 | } |
| 621 | return ParamCommandComment::InvalidParamIndex; |
| 622 | } |
| 623 | |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 624 | namespace { |
| 625 | class SimpleTypoCorrector { |
| 626 | StringRef Typo; |
| 627 | const unsigned MaxEditDistance; |
| 628 | |
| 629 | const NamedDecl *BestDecl; |
| 630 | unsigned BestEditDistance; |
| 631 | unsigned BestIndex; |
| 632 | unsigned NextIndex; |
| 633 | |
| 634 | public: |
| 635 | SimpleTypoCorrector(StringRef Typo) : |
| 636 | Typo(Typo), MaxEditDistance((Typo.size() + 2) / 3), |
| 637 | BestDecl(NULL), BestEditDistance(MaxEditDistance + 1), |
| 638 | BestIndex(0), NextIndex(0) |
| 639 | { } |
| 640 | |
| 641 | void addDecl(const NamedDecl *ND); |
| 642 | |
| 643 | const NamedDecl *getBestDecl() const { |
| 644 | if (BestEditDistance > MaxEditDistance) |
| 645 | return NULL; |
| 646 | |
| 647 | return BestDecl; |
| 648 | } |
| 649 | |
| 650 | unsigned getBestDeclIndex() const { |
| 651 | assert(getBestDecl()); |
| 652 | return BestIndex; |
| 653 | } |
| 654 | }; |
| 655 | |
| 656 | void SimpleTypoCorrector::addDecl(const NamedDecl *ND) { |
| 657 | unsigned CurrIndex = NextIndex++; |
| 658 | |
| 659 | const IdentifierInfo *II = ND->getIdentifier(); |
| 660 | if (!II) |
| 661 | return; |
| 662 | |
| 663 | StringRef Name = II->getName(); |
| 664 | unsigned MinPossibleEditDistance = abs((int)Name.size() - (int)Typo.size()); |
| 665 | if (MinPossibleEditDistance > 0 && |
| 666 | Typo.size() / MinPossibleEditDistance < 3) |
| 667 | return; |
| 668 | |
| 669 | unsigned EditDistance = Typo.edit_distance(Name, true, MaxEditDistance); |
| 670 | if (EditDistance < BestEditDistance) { |
| 671 | BestEditDistance = EditDistance; |
| 672 | BestDecl = ND; |
| 673 | BestIndex = CurrIndex; |
| 674 | } |
| 675 | } |
| 676 | } // unnamed namespace |
| 677 | |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 678 | unsigned Sema::correctTypoInParmVarReference( |
| 679 | StringRef Typo, |
Dmitri Gribenko | 8487c52 | 2012-07-23 17:40:30 +0000 | [diff] [blame] | 680 | ArrayRef<const ParmVarDecl *> ParamVars) { |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 681 | SimpleTypoCorrector Corrector(Typo); |
| 682 | for (unsigned i = 0, e = ParamVars.size(); i != e; ++i) |
| 683 | Corrector.addDecl(ParamVars[i]); |
| 684 | if (Corrector.getBestDecl()) |
| 685 | return Corrector.getBestDeclIndex(); |
| 686 | else |
Dmitri Gribenko | 1ad23d6 | 2012-09-10 21:20:09 +0000 | [diff] [blame] | 687 | return ParamCommandComment::InvalidParamIndex; |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 688 | } |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 689 | |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 690 | namespace { |
| 691 | bool ResolveTParamReferenceHelper( |
| 692 | StringRef Name, |
| 693 | const TemplateParameterList *TemplateParameters, |
| 694 | SmallVectorImpl<unsigned> *Position) { |
| 695 | for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) { |
| 696 | const NamedDecl *Param = TemplateParameters->getParam(i); |
| 697 | const IdentifierInfo *II = Param->getIdentifier(); |
| 698 | if (II && II->getName() == Name) { |
| 699 | Position->push_back(i); |
| 700 | return true; |
| 701 | } |
| 702 | |
| 703 | if (const TemplateTemplateParmDecl *TTP = |
| 704 | dyn_cast<TemplateTemplateParmDecl>(Param)) { |
| 705 | Position->push_back(i); |
| 706 | if (ResolveTParamReferenceHelper(Name, TTP->getTemplateParameters(), |
| 707 | Position)) |
| 708 | return true; |
| 709 | Position->pop_back(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 710 | } |
| 711 | } |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 712 | return false; |
| 713 | } |
| 714 | } // unnamed namespace |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 715 | |
Dmitri Gribenko | 96b0986 | 2012-07-31 22:37:06 +0000 | [diff] [blame] | 716 | bool Sema::resolveTParamReference( |
| 717 | StringRef Name, |
| 718 | const TemplateParameterList *TemplateParameters, |
| 719 | SmallVectorImpl<unsigned> *Position) { |
| 720 | Position->clear(); |
| 721 | if (!TemplateParameters) |
| 722 | return false; |
| 723 | |
| 724 | return ResolveTParamReferenceHelper(Name, TemplateParameters, Position); |
| 725 | } |
| 726 | |
| 727 | namespace { |
| 728 | void CorrectTypoInTParamReferenceHelper( |
| 729 | const TemplateParameterList *TemplateParameters, |
| 730 | SimpleTypoCorrector &Corrector) { |
| 731 | for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) { |
| 732 | const NamedDecl *Param = TemplateParameters->getParam(i); |
| 733 | Corrector.addDecl(Param); |
| 734 | |
| 735 | if (const TemplateTemplateParmDecl *TTP = |
| 736 | dyn_cast<TemplateTemplateParmDecl>(Param)) |
| 737 | CorrectTypoInTParamReferenceHelper(TTP->getTemplateParameters(), |
| 738 | Corrector); |
| 739 | } |
| 740 | } |
| 741 | } // unnamed namespace |
| 742 | |
| 743 | StringRef Sema::correctTypoInTParamReference( |
| 744 | StringRef Typo, |
| 745 | const TemplateParameterList *TemplateParameters) { |
| 746 | SimpleTypoCorrector Corrector(Typo); |
| 747 | CorrectTypoInTParamReferenceHelper(TemplateParameters, Corrector); |
| 748 | if (const NamedDecl *ND = Corrector.getBestDecl()) { |
| 749 | const IdentifierInfo *II = ND->getIdentifier(); |
| 750 | assert(II && "SimpleTypoCorrector should not return this decl"); |
| 751 | return II->getName(); |
| 752 | } |
| 753 | return StringRef(); |
Dmitri Gribenko | a5ef44f | 2012-07-11 21:38:39 +0000 | [diff] [blame] | 754 | } |
| 755 | |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 756 | InlineCommandComment::RenderKind |
| 757 | Sema::getInlineCommandRenderKind(StringRef Name) const { |
Dmitri Gribenko | e4330a3 | 2012-09-10 20:32:42 +0000 | [diff] [blame] | 758 | assert(Traits.getCommandInfo(Name)->IsInlineCommand); |
Dmitri Gribenko | 2d66a50 | 2012-07-23 16:43:01 +0000 | [diff] [blame] | 759 | |
| 760 | return llvm::StringSwitch<InlineCommandComment::RenderKind>(Name) |
| 761 | .Case("b", InlineCommandComment::RenderBold) |
| 762 | .Cases("c", "p", InlineCommandComment::RenderMonospaced) |
| 763 | .Cases("a", "e", "em", InlineCommandComment::RenderEmphasized) |
| 764 | .Default(InlineCommandComment::RenderNormal); |
| 765 | } |
| 766 | |
Dmitri Gribenko | 8d3ba23 | 2012-07-06 00:28:32 +0000 | [diff] [blame] | 767 | } // end namespace comments |
| 768 | } // end namespace clang |
| 769 | |