1 //===--- CommentSema.cpp - Doxygen comment semantic analysis --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/AST/CommentSema.h"
11 #include "clang/AST/Attr.h"
12 #include "clang/AST/CommentCommandTraits.h"
13 #include "clang/AST/CommentDiagnostic.h"
14 #include "clang/AST/Decl.h"
15 #include "clang/AST/DeclTemplate.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Lex/Preprocessor.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringSwitch.h"
25 #include "clang/AST/CommentHTMLTagsProperties.inc"
26 } // end anonymous namespace
28 Sema::Sema(llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr,
29 DiagnosticsEngine &Diags, CommandTraits &Traits,
30 const Preprocessor *PP) :
31 Allocator(Allocator), SourceMgr(SourceMgr), Diags(Diags), Traits(Traits),
32 PP(PP), ThisDeclInfo(nullptr), BriefCommand(nullptr),
33 HeaderfileCommand(nullptr) {
36 void Sema::setDecl(const Decl *D) {
40 ThisDeclInfo = new (Allocator) DeclInfo;
41 ThisDeclInfo->CommentDecl = D;
42 ThisDeclInfo->IsFilled = false;
45 ParagraphComment *Sema::actOnParagraphComment(
46 ArrayRef<InlineContentComment *> Content) {
47 return new (Allocator) ParagraphComment(Content);
50 BlockCommandComment *Sema::actOnBlockCommandStart(
51 SourceLocation LocBegin,
52 SourceLocation LocEnd,
54 CommandMarkerKind CommandMarker) {
55 BlockCommandComment *BC = new (Allocator) BlockCommandComment(LocBegin, LocEnd,
58 checkContainerDecl(BC);
62 void Sema::actOnBlockCommandArgs(BlockCommandComment *Command,
63 ArrayRef<BlockCommandComment::Argument> Args) {
64 Command->setArgs(Args);
67 void Sema::actOnBlockCommandFinish(BlockCommandComment *Command,
68 ParagraphComment *Paragraph) {
69 Command->setParagraph(Paragraph);
70 checkBlockCommandEmptyParagraph(Command);
71 checkBlockCommandDuplicate(Command);
73 // These checks only make sense if the comment is attached to a
75 checkReturnsCommand(Command);
76 checkDeprecatedCommand(Command);
80 ParamCommandComment *Sema::actOnParamCommandStart(
81 SourceLocation LocBegin,
82 SourceLocation LocEnd,
84 CommandMarkerKind CommandMarker) {
85 ParamCommandComment *Command =
86 new (Allocator) ParamCommandComment(LocBegin, LocEnd, CommandID,
89 if (!isFunctionDecl() && !isFunctionOrBlockPointerVarLikeDecl())
90 Diag(Command->getLocation(),
91 diag::warn_doc_param_not_attached_to_a_function_decl)
93 << Command->getCommandNameRange(Traits);
98 void Sema::checkFunctionDeclVerbatimLine(const BlockCommandComment *Comment) {
99 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
100 if (!Info->IsFunctionDeclarationCommand)
104 switch (Comment->getCommandID()) {
105 case CommandTraits::KCI_function:
106 DiagSelect = (!isAnyFunctionDecl() && !isFunctionTemplateDecl())? 1 : 0;
108 case CommandTraits::KCI_functiongroup:
109 DiagSelect = (!isAnyFunctionDecl() && !isFunctionTemplateDecl())? 2 : 0;
111 case CommandTraits::KCI_method:
112 DiagSelect = !isObjCMethodDecl() ? 3 : 0;
114 case CommandTraits::KCI_methodgroup:
115 DiagSelect = !isObjCMethodDecl() ? 4 : 0;
117 case CommandTraits::KCI_callback:
118 DiagSelect = !isFunctionPointerVarDecl() ? 5 : 0;
125 Diag(Comment->getLocation(), diag::warn_doc_function_method_decl_mismatch)
126 << Comment->getCommandMarker()
127 << (DiagSelect-1) << (DiagSelect-1)
128 << Comment->getSourceRange();
131 void Sema::checkContainerDeclVerbatimLine(const BlockCommandComment *Comment) {
132 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
133 if (!Info->IsRecordLikeDeclarationCommand)
136 switch (Comment->getCommandID()) {
137 case CommandTraits::KCI_class:
138 DiagSelect = (!isClassOrStructDecl() && !isClassTemplateDecl()) ? 1 : 0;
139 // Allow @class command on @interface declarations.
140 // FIXME. Currently, \class and @class are indistinguishable. So,
141 // \class is also allowed on an @interface declaration
142 if (DiagSelect && Comment->getCommandMarker() && isObjCInterfaceDecl())
145 case CommandTraits::KCI_interface:
146 DiagSelect = !isObjCInterfaceDecl() ? 2 : 0;
148 case CommandTraits::KCI_protocol:
149 DiagSelect = !isObjCProtocolDecl() ? 3 : 0;
151 case CommandTraits::KCI_struct:
152 DiagSelect = !isClassOrStructDecl() ? 4 : 0;
154 case CommandTraits::KCI_union:
155 DiagSelect = !isUnionDecl() ? 5 : 0;
162 Diag(Comment->getLocation(), diag::warn_doc_api_container_decl_mismatch)
163 << Comment->getCommandMarker()
164 << (DiagSelect-1) << (DiagSelect-1)
165 << Comment->getSourceRange();
168 void Sema::checkContainerDecl(const BlockCommandComment *Comment) {
169 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
170 if (!Info->IsRecordLikeDetailCommand || isRecordLikeDecl())
173 switch (Comment->getCommandID()) {
174 case CommandTraits::KCI_classdesign:
177 case CommandTraits::KCI_coclass:
180 case CommandTraits::KCI_dependency:
183 case CommandTraits::KCI_helper:
186 case CommandTraits::KCI_helperclass:
189 case CommandTraits::KCI_helps:
192 case CommandTraits::KCI_instancesize:
195 case CommandTraits::KCI_ownership:
198 case CommandTraits::KCI_performance:
201 case CommandTraits::KCI_security:
204 case CommandTraits::KCI_superclass:
212 Diag(Comment->getLocation(), diag::warn_doc_container_decl_mismatch)
213 << Comment->getCommandMarker()
215 << Comment->getSourceRange();
218 /// \brief Turn a string into the corresponding PassDirection or -1 if it's not
220 static int getParamPassDirection(StringRef Arg) {
221 return llvm::StringSwitch<int>(Arg)
222 .Case("[in]", ParamCommandComment::In)
223 .Case("[out]", ParamCommandComment::Out)
224 .Cases("[in,out]", "[out,in]", ParamCommandComment::InOut)
228 void Sema::actOnParamCommandDirectionArg(ParamCommandComment *Command,
229 SourceLocation ArgLocBegin,
230 SourceLocation ArgLocEnd,
232 std::string ArgLower = Arg.lower();
233 int Direction = getParamPassDirection(ArgLower);
235 if (Direction == -1) {
236 // Try again with whitespace removed.
238 std::remove_if(ArgLower.begin(), ArgLower.end(), clang::isWhitespace),
240 Direction = getParamPassDirection(ArgLower);
242 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
243 if (Direction != -1) {
244 const char *FixedName = ParamCommandComment::getDirectionAsString(
245 (ParamCommandComment::PassDirection)Direction);
246 Diag(ArgLocBegin, diag::warn_doc_param_spaces_in_direction)
247 << ArgRange << FixItHint::CreateReplacement(ArgRange, FixedName);
249 Diag(ArgLocBegin, diag::warn_doc_param_invalid_direction) << ArgRange;
250 Direction = ParamCommandComment::In; // Sane fall back.
253 Command->setDirection((ParamCommandComment::PassDirection)Direction,
257 void Sema::actOnParamCommandParamNameArg(ParamCommandComment *Command,
258 SourceLocation ArgLocBegin,
259 SourceLocation ArgLocEnd,
261 // Parser will not feed us more arguments than needed.
262 assert(Command->getNumArgs() == 0);
264 if (!Command->isDirectionExplicit()) {
265 // User didn't provide a direction argument.
266 Command->setDirection(ParamCommandComment::In, /* Explicit = */ false);
268 typedef BlockCommandComment::Argument Argument;
269 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
272 Command->setArgs(llvm::makeArrayRef(A, 1));
275 void Sema::actOnParamCommandFinish(ParamCommandComment *Command,
276 ParagraphComment *Paragraph) {
277 Command->setParagraph(Paragraph);
278 checkBlockCommandEmptyParagraph(Command);
281 TParamCommandComment *Sema::actOnTParamCommandStart(
282 SourceLocation LocBegin,
283 SourceLocation LocEnd,
285 CommandMarkerKind CommandMarker) {
286 TParamCommandComment *Command =
287 new (Allocator) TParamCommandComment(LocBegin, LocEnd, CommandID,
290 if (!isTemplateOrSpecialization())
291 Diag(Command->getLocation(),
292 diag::warn_doc_tparam_not_attached_to_a_template_decl)
294 << Command->getCommandNameRange(Traits);
299 void Sema::actOnTParamCommandParamNameArg(TParamCommandComment *Command,
300 SourceLocation ArgLocBegin,
301 SourceLocation ArgLocEnd,
303 // Parser will not feed us more arguments than needed.
304 assert(Command->getNumArgs() == 0);
306 typedef BlockCommandComment::Argument Argument;
307 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
310 Command->setArgs(llvm::makeArrayRef(A, 1));
312 if (!isTemplateOrSpecialization()) {
313 // We already warned that this \\tparam is not attached to a template decl.
317 const TemplateParameterList *TemplateParameters =
318 ThisDeclInfo->TemplateParameters;
319 SmallVector<unsigned, 2> Position;
320 if (resolveTParamReference(Arg, TemplateParameters, &Position)) {
321 Command->setPosition(copyArray(llvm::makeArrayRef(Position)));
322 TParamCommandComment *&PrevCommand = TemplateParameterDocs[Arg];
324 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
325 Diag(ArgLocBegin, diag::warn_doc_tparam_duplicate)
327 Diag(PrevCommand->getLocation(), diag::note_doc_tparam_previous)
328 << PrevCommand->getParamNameRange();
330 PrevCommand = Command;
334 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
335 Diag(ArgLocBegin, diag::warn_doc_tparam_not_found)
338 if (!TemplateParameters || TemplateParameters->size() == 0)
341 StringRef CorrectedName;
342 if (TemplateParameters->size() == 1) {
343 const NamedDecl *Param = TemplateParameters->getParam(0);
344 const IdentifierInfo *II = Param->getIdentifier();
346 CorrectedName = II->getName();
348 CorrectedName = correctTypoInTParamReference(Arg, TemplateParameters);
351 if (!CorrectedName.empty()) {
352 Diag(ArgLocBegin, diag::note_doc_tparam_name_suggestion)
354 << FixItHint::CreateReplacement(ArgRange, CorrectedName);
358 void Sema::actOnTParamCommandFinish(TParamCommandComment *Command,
359 ParagraphComment *Paragraph) {
360 Command->setParagraph(Paragraph);
361 checkBlockCommandEmptyParagraph(Command);
364 InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin,
365 SourceLocation CommandLocEnd,
366 unsigned CommandID) {
367 ArrayRef<InlineCommandComment::Argument> Args;
368 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
369 return new (Allocator) InlineCommandComment(
373 getInlineCommandRenderKind(CommandName),
377 InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin,
378 SourceLocation CommandLocEnd,
380 SourceLocation ArgLocBegin,
381 SourceLocation ArgLocEnd,
383 typedef InlineCommandComment::Argument Argument;
384 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
387 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
389 return new (Allocator) InlineCommandComment(
393 getInlineCommandRenderKind(CommandName),
394 llvm::makeArrayRef(A, 1));
397 InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin,
398 SourceLocation LocEnd,
399 StringRef CommandName) {
400 unsigned CommandID = Traits.registerUnknownCommand(CommandName)->getID();
401 return actOnUnknownCommand(LocBegin, LocEnd, CommandID);
404 InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin,
405 SourceLocation LocEnd,
406 unsigned CommandID) {
407 ArrayRef<InlineCommandComment::Argument> Args;
408 return new (Allocator) InlineCommandComment(
409 LocBegin, LocEnd, CommandID,
410 InlineCommandComment::RenderNormal,
414 TextComment *Sema::actOnText(SourceLocation LocBegin,
415 SourceLocation LocEnd,
417 return new (Allocator) TextComment(LocBegin, LocEnd, Text);
420 VerbatimBlockComment *Sema::actOnVerbatimBlockStart(SourceLocation Loc,
421 unsigned CommandID) {
422 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
423 return new (Allocator) VerbatimBlockComment(
425 Loc.getLocWithOffset(1 + CommandName.size()),
429 VerbatimBlockLineComment *Sema::actOnVerbatimBlockLine(SourceLocation Loc,
431 return new (Allocator) VerbatimBlockLineComment(Loc, Text);
434 void Sema::actOnVerbatimBlockFinish(
435 VerbatimBlockComment *Block,
436 SourceLocation CloseNameLocBegin,
438 ArrayRef<VerbatimBlockLineComment *> Lines) {
439 Block->setCloseName(CloseName, CloseNameLocBegin);
440 Block->setLines(Lines);
443 VerbatimLineComment *Sema::actOnVerbatimLine(SourceLocation LocBegin,
445 SourceLocation TextBegin,
447 VerbatimLineComment *VL = new (Allocator) VerbatimLineComment(
449 TextBegin.getLocWithOffset(Text.size()),
453 checkFunctionDeclVerbatimLine(VL);
454 checkContainerDeclVerbatimLine(VL);
458 HTMLStartTagComment *Sema::actOnHTMLStartTagStart(SourceLocation LocBegin,
460 return new (Allocator) HTMLStartTagComment(LocBegin, TagName);
463 void Sema::actOnHTMLStartTagFinish(
464 HTMLStartTagComment *Tag,
465 ArrayRef<HTMLStartTagComment::Attribute> Attrs,
466 SourceLocation GreaterLoc,
467 bool IsSelfClosing) {
468 Tag->setAttrs(Attrs);
469 Tag->setGreaterLoc(GreaterLoc);
471 Tag->setSelfClosing();
472 else if (!isHTMLEndTagForbidden(Tag->getTagName()))
473 HTMLOpenTags.push_back(Tag);
476 HTMLEndTagComment *Sema::actOnHTMLEndTag(SourceLocation LocBegin,
477 SourceLocation LocEnd,
479 HTMLEndTagComment *HET =
480 new (Allocator) HTMLEndTagComment(LocBegin, LocEnd, TagName);
481 if (isHTMLEndTagForbidden(TagName)) {
482 Diag(HET->getLocation(), diag::warn_doc_html_end_forbidden)
483 << TagName << HET->getSourceRange();
484 HET->setIsMalformed();
488 bool FoundOpen = false;
489 for (SmallVectorImpl<HTMLStartTagComment *>::const_reverse_iterator
490 I = HTMLOpenTags.rbegin(), E = HTMLOpenTags.rend();
492 if ((*I)->getTagName() == TagName) {
498 Diag(HET->getLocation(), diag::warn_doc_html_end_unbalanced)
499 << HET->getSourceRange();
500 HET->setIsMalformed();
504 while (!HTMLOpenTags.empty()) {
505 HTMLStartTagComment *HST = HTMLOpenTags.pop_back_val();
506 StringRef LastNotClosedTagName = HST->getTagName();
507 if (LastNotClosedTagName == TagName) {
508 // If the start tag is malformed, end tag is malformed as well.
509 if (HST->isMalformed())
510 HET->setIsMalformed();
514 if (isHTMLEndTagOptional(LastNotClosedTagName))
517 bool OpenLineInvalid;
518 const unsigned OpenLine = SourceMgr.getPresumedLineNumber(
521 bool CloseLineInvalid;
522 const unsigned CloseLine = SourceMgr.getPresumedLineNumber(
526 if (OpenLineInvalid || CloseLineInvalid || OpenLine == CloseLine) {
527 Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch)
528 << HST->getTagName() << HET->getTagName()
529 << HST->getSourceRange() << HET->getSourceRange();
530 HST->setIsMalformed();
532 Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch)
533 << HST->getTagName() << HET->getTagName()
534 << HST->getSourceRange();
535 Diag(HET->getLocation(), diag::note_doc_html_end_tag)
536 << HET->getSourceRange();
537 HST->setIsMalformed();
544 FullComment *Sema::actOnFullComment(
545 ArrayRef<BlockContentComment *> Blocks) {
546 FullComment *FC = new (Allocator) FullComment(Blocks, ThisDeclInfo);
547 resolveParamCommandIndexes(FC);
549 // Complain about HTML tags that are not closed.
550 while (!HTMLOpenTags.empty()) {
551 HTMLStartTagComment *HST = HTMLOpenTags.pop_back_val();
552 if (isHTMLEndTagOptional(HST->getTagName()))
555 Diag(HST->getLocation(), diag::warn_doc_html_missing_end_tag)
556 << HST->getTagName() << HST->getSourceRange();
557 HST->setIsMalformed();
563 void Sema::checkBlockCommandEmptyParagraph(BlockCommandComment *Command) {
564 if (Traits.getCommandInfo(Command->getCommandID())->IsEmptyParagraphAllowed)
567 ParagraphComment *Paragraph = Command->getParagraph();
568 if (Paragraph->isWhitespace()) {
569 SourceLocation DiagLoc;
570 if (Command->getNumArgs() > 0)
571 DiagLoc = Command->getArgRange(Command->getNumArgs() - 1).getEnd();
572 if (!DiagLoc.isValid())
573 DiagLoc = Command->getCommandNameRange(Traits).getEnd();
574 Diag(DiagLoc, diag::warn_doc_block_command_empty_paragraph)
575 << Command->getCommandMarker()
576 << Command->getCommandName(Traits)
577 << Command->getSourceRange();
581 void Sema::checkReturnsCommand(const BlockCommandComment *Command) {
582 if (!Traits.getCommandInfo(Command->getCommandID())->IsReturnsCommand)
585 assert(ThisDeclInfo && "should not call this check on a bare comment");
587 // We allow the return command for all @properties because it can be used
588 // to document the value that the property getter returns.
589 if (isObjCPropertyDecl())
591 if (isFunctionDecl() || isFunctionOrBlockPointerVarLikeDecl()) {
592 if (ThisDeclInfo->ReturnType->isVoidType()) {
594 switch (ThisDeclInfo->CommentDecl->getKind()) {
596 if (ThisDeclInfo->IsObjCMethod)
601 case Decl::CXXConstructor:
604 case Decl::CXXDestructor:
608 Diag(Command->getLocation(),
609 diag::warn_doc_returns_attached_to_a_void_function)
610 << Command->getCommandMarker()
611 << Command->getCommandName(Traits)
613 << Command->getSourceRange();
618 Diag(Command->getLocation(),
619 diag::warn_doc_returns_not_attached_to_a_function_decl)
620 << Command->getCommandMarker()
621 << Command->getCommandName(Traits)
622 << Command->getSourceRange();
625 void Sema::checkBlockCommandDuplicate(const BlockCommandComment *Command) {
626 const CommandInfo *Info = Traits.getCommandInfo(Command->getCommandID());
627 const BlockCommandComment *PrevCommand = nullptr;
628 if (Info->IsBriefCommand) {
630 BriefCommand = Command;
633 PrevCommand = BriefCommand;
634 } else if (Info->IsHeaderfileCommand) {
635 if (!HeaderfileCommand) {
636 HeaderfileCommand = Command;
639 PrevCommand = HeaderfileCommand;
641 // We don't want to check this command for duplicates.
644 StringRef CommandName = Command->getCommandName(Traits);
645 StringRef PrevCommandName = PrevCommand->getCommandName(Traits);
646 Diag(Command->getLocation(), diag::warn_doc_block_command_duplicate)
647 << Command->getCommandMarker()
649 << Command->getSourceRange();
650 if (CommandName == PrevCommandName)
651 Diag(PrevCommand->getLocation(), diag::note_doc_block_command_previous)
652 << PrevCommand->getCommandMarker()
654 << PrevCommand->getSourceRange();
656 Diag(PrevCommand->getLocation(),
657 diag::note_doc_block_command_previous_alias)
658 << PrevCommand->getCommandMarker()
663 void Sema::checkDeprecatedCommand(const BlockCommandComment *Command) {
664 if (!Traits.getCommandInfo(Command->getCommandID())->IsDeprecatedCommand)
667 assert(ThisDeclInfo && "should not call this check on a bare comment");
669 const Decl *D = ThisDeclInfo->CommentDecl;
673 if (D->hasAttr<DeprecatedAttr>() ||
674 D->hasAttr<AvailabilityAttr>() ||
675 D->hasAttr<UnavailableAttr>())
678 Diag(Command->getLocation(),
679 diag::warn_doc_deprecated_not_sync)
680 << Command->getSourceRange();
682 // Try to emit a fixit with a deprecation attribute.
683 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
684 // Don't emit a Fix-It for non-member function definitions. GCC does not
685 // accept attributes on them.
686 const DeclContext *Ctx = FD->getDeclContext();
687 if ((!Ctx || !Ctx->isRecord()) &&
688 FD->doesThisDeclarationHaveABody())
691 StringRef AttributeSpelling = "__attribute__((deprecated))";
693 TokenValue Tokens[] = {
694 tok::kw___attribute, tok::l_paren, tok::l_paren,
695 PP->getIdentifierInfo("deprecated"),
696 tok::r_paren, tok::r_paren
698 StringRef MacroName = PP->getLastMacroWithSpelling(FD->getLocation(),
700 if (!MacroName.empty())
701 AttributeSpelling = MacroName;
704 SmallString<64> TextToInsert(" ");
705 TextToInsert += AttributeSpelling;
706 Diag(FD->getLocEnd(),
707 diag::note_add_deprecation_attr)
708 << FixItHint::CreateInsertion(FD->getLocEnd().getLocWithOffset(1),
713 void Sema::resolveParamCommandIndexes(const FullComment *FC) {
714 if (!isFunctionDecl()) {
715 // We already warned that \\param commands are not attached to a function
720 SmallVector<ParamCommandComment *, 8> UnresolvedParamCommands;
722 // Comment AST nodes that correspond to \c ParamVars for which we have
723 // found a \\param command or NULL if no documentation was found so far.
724 SmallVector<ParamCommandComment *, 8> ParamVarDocs;
726 ArrayRef<const ParmVarDecl *> ParamVars = getParamVars();
727 ParamVarDocs.resize(ParamVars.size(), nullptr);
729 // First pass over all \\param commands: resolve all parameter names.
730 for (Comment::child_iterator I = FC->child_begin(), E = FC->child_end();
732 ParamCommandComment *PCC = dyn_cast<ParamCommandComment>(*I);
733 if (!PCC || !PCC->hasParamName())
735 StringRef ParamName = PCC->getParamNameAsWritten();
737 // Check that referenced parameter name is in the function decl.
738 const unsigned ResolvedParamIndex = resolveParmVarReference(ParamName,
740 if (ResolvedParamIndex == ParamCommandComment::VarArgParamIndex) {
741 PCC->setIsVarArgParam();
744 if (ResolvedParamIndex == ParamCommandComment::InvalidParamIndex) {
745 UnresolvedParamCommands.push_back(PCC);
748 PCC->setParamIndex(ResolvedParamIndex);
749 if (ParamVarDocs[ResolvedParamIndex]) {
750 SourceRange ArgRange = PCC->getParamNameRange();
751 Diag(ArgRange.getBegin(), diag::warn_doc_param_duplicate)
752 << ParamName << ArgRange;
753 ParamCommandComment *PrevCommand = ParamVarDocs[ResolvedParamIndex];
754 Diag(PrevCommand->getLocation(), diag::note_doc_param_previous)
755 << PrevCommand->getParamNameRange();
757 ParamVarDocs[ResolvedParamIndex] = PCC;
760 // Find parameter declarations that have no corresponding \\param.
761 SmallVector<const ParmVarDecl *, 8> OrphanedParamDecls;
762 for (unsigned i = 0, e = ParamVarDocs.size(); i != e; ++i) {
763 if (!ParamVarDocs[i])
764 OrphanedParamDecls.push_back(ParamVars[i]);
767 // Second pass over unresolved \\param commands: do typo correction.
768 // Suggest corrections from a set of parameter declarations that have no
769 // corresponding \\param.
770 for (unsigned i = 0, e = UnresolvedParamCommands.size(); i != e; ++i) {
771 const ParamCommandComment *PCC = UnresolvedParamCommands[i];
773 SourceRange ArgRange = PCC->getParamNameRange();
774 StringRef ParamName = PCC->getParamNameAsWritten();
775 Diag(ArgRange.getBegin(), diag::warn_doc_param_not_found)
776 << ParamName << ArgRange;
778 // All parameters documented -- can't suggest a correction.
779 if (OrphanedParamDecls.size() == 0)
782 unsigned CorrectedParamIndex = ParamCommandComment::InvalidParamIndex;
783 if (OrphanedParamDecls.size() == 1) {
784 // If one parameter is not documented then that parameter is the only
785 // possible suggestion.
786 CorrectedParamIndex = 0;
788 // Do typo correction.
789 CorrectedParamIndex = correctTypoInParmVarReference(ParamName,
792 if (CorrectedParamIndex != ParamCommandComment::InvalidParamIndex) {
793 const ParmVarDecl *CorrectedPVD = OrphanedParamDecls[CorrectedParamIndex];
794 if (const IdentifierInfo *CorrectedII = CorrectedPVD->getIdentifier())
795 Diag(ArgRange.getBegin(), diag::note_doc_param_name_suggestion)
796 << CorrectedII->getName()
797 << FixItHint::CreateReplacement(ArgRange, CorrectedII->getName());
802 bool Sema::isFunctionDecl() {
805 if (!ThisDeclInfo->IsFilled)
807 return ThisDeclInfo->getKind() == DeclInfo::FunctionKind;
810 bool Sema::isAnyFunctionDecl() {
811 return isFunctionDecl() && ThisDeclInfo->CurrentDecl &&
812 isa<FunctionDecl>(ThisDeclInfo->CurrentDecl);
815 bool Sema::isFunctionOrMethodVariadic() {
816 if (!isAnyFunctionDecl() && !isObjCMethodDecl() && !isFunctionTemplateDecl())
818 if (const FunctionDecl *FD =
819 dyn_cast<FunctionDecl>(ThisDeclInfo->CurrentDecl))
820 return FD->isVariadic();
821 if (const FunctionTemplateDecl *FTD =
822 dyn_cast<FunctionTemplateDecl>(ThisDeclInfo->CurrentDecl))
823 return FTD->getTemplatedDecl()->isVariadic();
824 if (const ObjCMethodDecl *MD =
825 dyn_cast<ObjCMethodDecl>(ThisDeclInfo->CurrentDecl))
826 return MD->isVariadic();
830 bool Sema::isObjCMethodDecl() {
831 return isFunctionDecl() && ThisDeclInfo->CurrentDecl &&
832 isa<ObjCMethodDecl>(ThisDeclInfo->CurrentDecl);
835 bool Sema::isFunctionPointerVarDecl() {
838 if (!ThisDeclInfo->IsFilled)
840 if (ThisDeclInfo->getKind() == DeclInfo::VariableKind) {
841 if (const VarDecl *VD = dyn_cast_or_null<VarDecl>(ThisDeclInfo->CurrentDecl)) {
842 QualType QT = VD->getType();
843 return QT->isFunctionPointerType();
849 bool Sema::isFunctionOrBlockPointerVarLikeDecl() {
852 if (!ThisDeclInfo->IsFilled)
854 if (ThisDeclInfo->getKind() != DeclInfo::VariableKind ||
855 !ThisDeclInfo->CurrentDecl)
858 if (const auto *VD = dyn_cast<DeclaratorDecl>(ThisDeclInfo->CurrentDecl))
860 else if (const auto *PD =
861 dyn_cast<ObjCPropertyDecl>(ThisDeclInfo->CurrentDecl))
865 // We would like to warn about the 'returns'/'param' commands for
866 // variables that don't directly specify the function type, so type aliases
868 if (QT->getAs<TypedefType>())
870 return QT->isFunctionPointerType() || QT->isBlockPointerType();
873 bool Sema::isObjCPropertyDecl() {
876 if (!ThisDeclInfo->IsFilled)
878 return ThisDeclInfo->CurrentDecl->getKind() == Decl::ObjCProperty;
881 bool Sema::isTemplateOrSpecialization() {
884 if (!ThisDeclInfo->IsFilled)
886 return ThisDeclInfo->getTemplateKind() != DeclInfo::NotTemplate;
889 bool Sema::isRecordLikeDecl() {
892 if (!ThisDeclInfo->IsFilled)
894 return isUnionDecl() || isClassOrStructDecl() || isObjCInterfaceDecl() ||
895 isObjCProtocolDecl();
898 bool Sema::isUnionDecl() {
901 if (!ThisDeclInfo->IsFilled)
903 if (const RecordDecl *RD =
904 dyn_cast_or_null<RecordDecl>(ThisDeclInfo->CurrentDecl))
905 return RD->isUnion();
909 bool Sema::isClassOrStructDecl() {
912 if (!ThisDeclInfo->IsFilled)
914 return ThisDeclInfo->CurrentDecl &&
915 isa<RecordDecl>(ThisDeclInfo->CurrentDecl) &&
919 bool Sema::isClassTemplateDecl() {
922 if (!ThisDeclInfo->IsFilled)
924 return ThisDeclInfo->CurrentDecl &&
925 (isa<ClassTemplateDecl>(ThisDeclInfo->CurrentDecl));
928 bool Sema::isFunctionTemplateDecl() {
931 if (!ThisDeclInfo->IsFilled)
933 return ThisDeclInfo->CurrentDecl &&
934 (isa<FunctionTemplateDecl>(ThisDeclInfo->CurrentDecl));
937 bool Sema::isObjCInterfaceDecl() {
940 if (!ThisDeclInfo->IsFilled)
942 return ThisDeclInfo->CurrentDecl &&
943 isa<ObjCInterfaceDecl>(ThisDeclInfo->CurrentDecl);
946 bool Sema::isObjCProtocolDecl() {
949 if (!ThisDeclInfo->IsFilled)
951 return ThisDeclInfo->CurrentDecl &&
952 isa<ObjCProtocolDecl>(ThisDeclInfo->CurrentDecl);
955 ArrayRef<const ParmVarDecl *> Sema::getParamVars() {
956 if (!ThisDeclInfo->IsFilled)
958 return ThisDeclInfo->ParamVars;
961 void Sema::inspectThisDecl() {
962 ThisDeclInfo->fill();
965 unsigned Sema::resolveParmVarReference(StringRef Name,
966 ArrayRef<const ParmVarDecl *> ParamVars) {
967 for (unsigned i = 0, e = ParamVars.size(); i != e; ++i) {
968 const IdentifierInfo *II = ParamVars[i]->getIdentifier();
969 if (II && II->getName() == Name)
972 if (Name == "..." && isFunctionOrMethodVariadic())
973 return ParamCommandComment::VarArgParamIndex;
974 return ParamCommandComment::InvalidParamIndex;
978 class SimpleTypoCorrector {
979 const NamedDecl *BestDecl;
982 const unsigned MaxEditDistance;
984 unsigned BestEditDistance;
989 explicit SimpleTypoCorrector(StringRef Typo)
990 : BestDecl(nullptr), Typo(Typo), MaxEditDistance((Typo.size() + 2) / 3),
991 BestEditDistance(MaxEditDistance + 1), BestIndex(0), NextIndex(0) {}
993 void addDecl(const NamedDecl *ND);
995 const NamedDecl *getBestDecl() const {
996 if (BestEditDistance > MaxEditDistance)
1002 unsigned getBestDeclIndex() const {
1003 assert(getBestDecl());
1008 void SimpleTypoCorrector::addDecl(const NamedDecl *ND) {
1009 unsigned CurrIndex = NextIndex++;
1011 const IdentifierInfo *II = ND->getIdentifier();
1015 StringRef Name = II->getName();
1016 unsigned MinPossibleEditDistance = abs((int)Name.size() - (int)Typo.size());
1017 if (MinPossibleEditDistance > 0 &&
1018 Typo.size() / MinPossibleEditDistance < 3)
1021 unsigned EditDistance = Typo.edit_distance(Name, true, MaxEditDistance);
1022 if (EditDistance < BestEditDistance) {
1023 BestEditDistance = EditDistance;
1025 BestIndex = CurrIndex;
1028 } // end anonymous namespace
1030 unsigned Sema::correctTypoInParmVarReference(
1032 ArrayRef<const ParmVarDecl *> ParamVars) {
1033 SimpleTypoCorrector Corrector(Typo);
1034 for (unsigned i = 0, e = ParamVars.size(); i != e; ++i)
1035 Corrector.addDecl(ParamVars[i]);
1036 if (Corrector.getBestDecl())
1037 return Corrector.getBestDeclIndex();
1039 return ParamCommandComment::InvalidParamIndex;
1043 bool ResolveTParamReferenceHelper(
1045 const TemplateParameterList *TemplateParameters,
1046 SmallVectorImpl<unsigned> *Position) {
1047 for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) {
1048 const NamedDecl *Param = TemplateParameters->getParam(i);
1049 const IdentifierInfo *II = Param->getIdentifier();
1050 if (II && II->getName() == Name) {
1051 Position->push_back(i);
1055 if (const TemplateTemplateParmDecl *TTP =
1056 dyn_cast<TemplateTemplateParmDecl>(Param)) {
1057 Position->push_back(i);
1058 if (ResolveTParamReferenceHelper(Name, TTP->getTemplateParameters(),
1061 Position->pop_back();
1066 } // end anonymous namespace
1068 bool Sema::resolveTParamReference(
1070 const TemplateParameterList *TemplateParameters,
1071 SmallVectorImpl<unsigned> *Position) {
1073 if (!TemplateParameters)
1076 return ResolveTParamReferenceHelper(Name, TemplateParameters, Position);
1080 void CorrectTypoInTParamReferenceHelper(
1081 const TemplateParameterList *TemplateParameters,
1082 SimpleTypoCorrector &Corrector) {
1083 for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) {
1084 const NamedDecl *Param = TemplateParameters->getParam(i);
1085 Corrector.addDecl(Param);
1087 if (const TemplateTemplateParmDecl *TTP =
1088 dyn_cast<TemplateTemplateParmDecl>(Param))
1089 CorrectTypoInTParamReferenceHelper(TTP->getTemplateParameters(),
1093 } // end anonymous namespace
1095 StringRef Sema::correctTypoInTParamReference(
1097 const TemplateParameterList *TemplateParameters) {
1098 SimpleTypoCorrector Corrector(Typo);
1099 CorrectTypoInTParamReferenceHelper(TemplateParameters, Corrector);
1100 if (const NamedDecl *ND = Corrector.getBestDecl()) {
1101 const IdentifierInfo *II = ND->getIdentifier();
1102 assert(II && "SimpleTypoCorrector should not return this decl");
1103 return II->getName();
1108 InlineCommandComment::RenderKind
1109 Sema::getInlineCommandRenderKind(StringRef Name) const {
1110 assert(Traits.getCommandInfo(Name)->IsInlineCommand);
1112 return llvm::StringSwitch<InlineCommandComment::RenderKind>(Name)
1113 .Case("b", InlineCommandComment::RenderBold)
1114 .Cases("c", "p", InlineCommandComment::RenderMonospaced)
1115 .Cases("a", "e", "em", InlineCommandComment::RenderEmphasized)
1116 .Default(InlineCommandComment::RenderNormal);
1119 } // end namespace comments
1120 } // end namespace clang