1 //===--- CommentSema.cpp - Doxygen comment semantic analysis --------------===//
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
7 //===----------------------------------------------------------------------===//
9 #include "clang/AST/CommentSema.h"
10 #include "clang/AST/Attr.h"
11 #include "clang/AST/CommentCommandTraits.h"
12 #include "clang/AST/CommentDiagnostic.h"
13 #include "clang/AST/Decl.h"
14 #include "clang/AST/DeclTemplate.h"
15 #include "clang/Basic/SourceManager.h"
16 #include "clang/Lex/Preprocessor.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringSwitch.h"
24 #include "clang/AST/CommentHTMLTagsProperties.inc"
25 } // end anonymous namespace
27 Sema::Sema(llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr,
28 DiagnosticsEngine &Diags, CommandTraits &Traits,
29 const Preprocessor *PP) :
30 Allocator(Allocator), SourceMgr(SourceMgr), Diags(Diags), Traits(Traits),
31 PP(PP), ThisDeclInfo(nullptr), BriefCommand(nullptr),
32 HeaderfileCommand(nullptr) {
35 void Sema::setDecl(const Decl *D) {
39 ThisDeclInfo = new (Allocator) DeclInfo;
40 ThisDeclInfo->CommentDecl = D;
41 ThisDeclInfo->IsFilled = false;
44 ParagraphComment *Sema::actOnParagraphComment(
45 ArrayRef<InlineContentComment *> Content) {
46 return new (Allocator) ParagraphComment(Content);
49 BlockCommandComment *Sema::actOnBlockCommandStart(
50 SourceLocation LocBegin,
51 SourceLocation LocEnd,
53 CommandMarkerKind CommandMarker) {
54 BlockCommandComment *BC = new (Allocator) BlockCommandComment(LocBegin, LocEnd,
57 checkContainerDecl(BC);
61 void Sema::actOnBlockCommandArgs(BlockCommandComment *Command,
62 ArrayRef<BlockCommandComment::Argument> Args) {
63 Command->setArgs(Args);
66 void Sema::actOnBlockCommandFinish(BlockCommandComment *Command,
67 ParagraphComment *Paragraph) {
68 Command->setParagraph(Paragraph);
69 checkBlockCommandEmptyParagraph(Command);
70 checkBlockCommandDuplicate(Command);
72 // These checks only make sense if the comment is attached to a
74 checkReturnsCommand(Command);
75 checkDeprecatedCommand(Command);
79 ParamCommandComment *Sema::actOnParamCommandStart(
80 SourceLocation LocBegin,
81 SourceLocation LocEnd,
83 CommandMarkerKind CommandMarker) {
84 ParamCommandComment *Command =
85 new (Allocator) ParamCommandComment(LocBegin, LocEnd, CommandID,
88 if (!isFunctionDecl() && !isFunctionOrBlockPointerVarLikeDecl())
89 Diag(Command->getLocation(),
90 diag::warn_doc_param_not_attached_to_a_function_decl)
92 << Command->getCommandNameRange(Traits);
97 void Sema::checkFunctionDeclVerbatimLine(const BlockCommandComment *Comment) {
98 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
99 if (!Info->IsFunctionDeclarationCommand)
103 switch (Comment->getCommandID()) {
104 case CommandTraits::KCI_function:
105 DiagSelect = (!isAnyFunctionDecl() && !isFunctionTemplateDecl())? 1 : 0;
107 case CommandTraits::KCI_functiongroup:
108 DiagSelect = (!isAnyFunctionDecl() && !isFunctionTemplateDecl())? 2 : 0;
110 case CommandTraits::KCI_method:
111 DiagSelect = !isObjCMethodDecl() ? 3 : 0;
113 case CommandTraits::KCI_methodgroup:
114 DiagSelect = !isObjCMethodDecl() ? 4 : 0;
116 case CommandTraits::KCI_callback:
117 DiagSelect = !isFunctionPointerVarDecl() ? 5 : 0;
124 Diag(Comment->getLocation(), diag::warn_doc_function_method_decl_mismatch)
125 << Comment->getCommandMarker()
126 << (DiagSelect-1) << (DiagSelect-1)
127 << Comment->getSourceRange();
130 void Sema::checkContainerDeclVerbatimLine(const BlockCommandComment *Comment) {
131 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
132 if (!Info->IsRecordLikeDeclarationCommand)
135 switch (Comment->getCommandID()) {
136 case CommandTraits::KCI_class:
137 DiagSelect = (!isClassOrStructDecl() && !isClassTemplateDecl()) ? 1 : 0;
138 // Allow @class command on @interface declarations.
139 // FIXME. Currently, \class and @class are indistinguishable. So,
140 // \class is also allowed on an @interface declaration
141 if (DiagSelect && Comment->getCommandMarker() && isObjCInterfaceDecl())
144 case CommandTraits::KCI_interface:
145 DiagSelect = !isObjCInterfaceDecl() ? 2 : 0;
147 case CommandTraits::KCI_protocol:
148 DiagSelect = !isObjCProtocolDecl() ? 3 : 0;
150 case CommandTraits::KCI_struct:
151 DiagSelect = !isClassOrStructDecl() ? 4 : 0;
153 case CommandTraits::KCI_union:
154 DiagSelect = !isUnionDecl() ? 5 : 0;
161 Diag(Comment->getLocation(), diag::warn_doc_api_container_decl_mismatch)
162 << Comment->getCommandMarker()
163 << (DiagSelect-1) << (DiagSelect-1)
164 << Comment->getSourceRange();
167 void Sema::checkContainerDecl(const BlockCommandComment *Comment) {
168 const CommandInfo *Info = Traits.getCommandInfo(Comment->getCommandID());
169 if (!Info->IsRecordLikeDetailCommand || isRecordLikeDecl())
172 switch (Comment->getCommandID()) {
173 case CommandTraits::KCI_classdesign:
176 case CommandTraits::KCI_coclass:
179 case CommandTraits::KCI_dependency:
182 case CommandTraits::KCI_helper:
185 case CommandTraits::KCI_helperclass:
188 case CommandTraits::KCI_helps:
191 case CommandTraits::KCI_instancesize:
194 case CommandTraits::KCI_ownership:
197 case CommandTraits::KCI_performance:
200 case CommandTraits::KCI_security:
203 case CommandTraits::KCI_superclass:
211 Diag(Comment->getLocation(), diag::warn_doc_container_decl_mismatch)
212 << Comment->getCommandMarker()
214 << Comment->getSourceRange();
217 /// Turn a string into the corresponding PassDirection or -1 if it's not
219 static int getParamPassDirection(StringRef Arg) {
220 return llvm::StringSwitch<int>(Arg)
221 .Case("[in]", ParamCommandComment::In)
222 .Case("[out]", ParamCommandComment::Out)
223 .Cases("[in,out]", "[out,in]", ParamCommandComment::InOut)
227 void Sema::actOnParamCommandDirectionArg(ParamCommandComment *Command,
228 SourceLocation ArgLocBegin,
229 SourceLocation ArgLocEnd,
231 std::string ArgLower = Arg.lower();
232 int Direction = getParamPassDirection(ArgLower);
234 if (Direction == -1) {
235 // Try again with whitespace removed.
237 std::remove_if(ArgLower.begin(), ArgLower.end(), clang::isWhitespace),
239 Direction = getParamPassDirection(ArgLower);
241 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
242 if (Direction != -1) {
243 const char *FixedName = ParamCommandComment::getDirectionAsString(
244 (ParamCommandComment::PassDirection)Direction);
245 Diag(ArgLocBegin, diag::warn_doc_param_spaces_in_direction)
246 << ArgRange << FixItHint::CreateReplacement(ArgRange, FixedName);
248 Diag(ArgLocBegin, diag::warn_doc_param_invalid_direction) << ArgRange;
249 Direction = ParamCommandComment::In; // Sane fall back.
252 Command->setDirection((ParamCommandComment::PassDirection)Direction,
256 void Sema::actOnParamCommandParamNameArg(ParamCommandComment *Command,
257 SourceLocation ArgLocBegin,
258 SourceLocation ArgLocEnd,
260 // Parser will not feed us more arguments than needed.
261 assert(Command->getNumArgs() == 0);
263 if (!Command->isDirectionExplicit()) {
264 // User didn't provide a direction argument.
265 Command->setDirection(ParamCommandComment::In, /* Explicit = */ false);
267 typedef BlockCommandComment::Argument Argument;
268 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
271 Command->setArgs(llvm::makeArrayRef(A, 1));
274 void Sema::actOnParamCommandFinish(ParamCommandComment *Command,
275 ParagraphComment *Paragraph) {
276 Command->setParagraph(Paragraph);
277 checkBlockCommandEmptyParagraph(Command);
280 TParamCommandComment *Sema::actOnTParamCommandStart(
281 SourceLocation LocBegin,
282 SourceLocation LocEnd,
284 CommandMarkerKind CommandMarker) {
285 TParamCommandComment *Command =
286 new (Allocator) TParamCommandComment(LocBegin, LocEnd, CommandID,
289 if (!isTemplateOrSpecialization())
290 Diag(Command->getLocation(),
291 diag::warn_doc_tparam_not_attached_to_a_template_decl)
293 << Command->getCommandNameRange(Traits);
298 void Sema::actOnTParamCommandParamNameArg(TParamCommandComment *Command,
299 SourceLocation ArgLocBegin,
300 SourceLocation ArgLocEnd,
302 // Parser will not feed us more arguments than needed.
303 assert(Command->getNumArgs() == 0);
305 typedef BlockCommandComment::Argument Argument;
306 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
309 Command->setArgs(llvm::makeArrayRef(A, 1));
311 if (!isTemplateOrSpecialization()) {
312 // We already warned that this \\tparam is not attached to a template decl.
316 const TemplateParameterList *TemplateParameters =
317 ThisDeclInfo->TemplateParameters;
318 SmallVector<unsigned, 2> Position;
319 if (resolveTParamReference(Arg, TemplateParameters, &Position)) {
320 Command->setPosition(copyArray(llvm::makeArrayRef(Position)));
321 TParamCommandComment *&PrevCommand = TemplateParameterDocs[Arg];
323 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
324 Diag(ArgLocBegin, diag::warn_doc_tparam_duplicate)
326 Diag(PrevCommand->getLocation(), diag::note_doc_tparam_previous)
327 << PrevCommand->getParamNameRange();
329 PrevCommand = Command;
333 SourceRange ArgRange(ArgLocBegin, ArgLocEnd);
334 Diag(ArgLocBegin, diag::warn_doc_tparam_not_found)
337 if (!TemplateParameters || TemplateParameters->size() == 0)
340 StringRef CorrectedName;
341 if (TemplateParameters->size() == 1) {
342 const NamedDecl *Param = TemplateParameters->getParam(0);
343 const IdentifierInfo *II = Param->getIdentifier();
345 CorrectedName = II->getName();
347 CorrectedName = correctTypoInTParamReference(Arg, TemplateParameters);
350 if (!CorrectedName.empty()) {
351 Diag(ArgLocBegin, diag::note_doc_tparam_name_suggestion)
353 << FixItHint::CreateReplacement(ArgRange, CorrectedName);
357 void Sema::actOnTParamCommandFinish(TParamCommandComment *Command,
358 ParagraphComment *Paragraph) {
359 Command->setParagraph(Paragraph);
360 checkBlockCommandEmptyParagraph(Command);
363 InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin,
364 SourceLocation CommandLocEnd,
365 unsigned CommandID) {
366 ArrayRef<InlineCommandComment::Argument> Args;
367 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
368 return new (Allocator) InlineCommandComment(
372 getInlineCommandRenderKind(CommandName),
376 InlineCommandComment *Sema::actOnInlineCommand(SourceLocation CommandLocBegin,
377 SourceLocation CommandLocEnd,
379 SourceLocation ArgLocBegin,
380 SourceLocation ArgLocEnd,
382 typedef InlineCommandComment::Argument Argument;
383 Argument *A = new (Allocator) Argument(SourceRange(ArgLocBegin,
386 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
388 return new (Allocator) InlineCommandComment(
392 getInlineCommandRenderKind(CommandName),
393 llvm::makeArrayRef(A, 1));
396 InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin,
397 SourceLocation LocEnd,
398 StringRef CommandName) {
399 unsigned CommandID = Traits.registerUnknownCommand(CommandName)->getID();
400 return actOnUnknownCommand(LocBegin, LocEnd, CommandID);
403 InlineContentComment *Sema::actOnUnknownCommand(SourceLocation LocBegin,
404 SourceLocation LocEnd,
405 unsigned CommandID) {
406 ArrayRef<InlineCommandComment::Argument> Args;
407 return new (Allocator) InlineCommandComment(
408 LocBegin, LocEnd, CommandID,
409 InlineCommandComment::RenderNormal,
413 TextComment *Sema::actOnText(SourceLocation LocBegin,
414 SourceLocation LocEnd,
416 return new (Allocator) TextComment(LocBegin, LocEnd, Text);
419 VerbatimBlockComment *Sema::actOnVerbatimBlockStart(SourceLocation Loc,
420 unsigned CommandID) {
421 StringRef CommandName = Traits.getCommandInfo(CommandID)->Name;
422 return new (Allocator) VerbatimBlockComment(
424 Loc.getLocWithOffset(1 + CommandName.size()),
428 VerbatimBlockLineComment *Sema::actOnVerbatimBlockLine(SourceLocation Loc,
430 return new (Allocator) VerbatimBlockLineComment(Loc, Text);
433 void Sema::actOnVerbatimBlockFinish(
434 VerbatimBlockComment *Block,
435 SourceLocation CloseNameLocBegin,
437 ArrayRef<VerbatimBlockLineComment *> Lines) {
438 Block->setCloseName(CloseName, CloseNameLocBegin);
439 Block->setLines(Lines);
442 VerbatimLineComment *Sema::actOnVerbatimLine(SourceLocation LocBegin,
444 SourceLocation TextBegin,
446 VerbatimLineComment *VL = new (Allocator) VerbatimLineComment(
448 TextBegin.getLocWithOffset(Text.size()),
452 checkFunctionDeclVerbatimLine(VL);
453 checkContainerDeclVerbatimLine(VL);
457 HTMLStartTagComment *Sema::actOnHTMLStartTagStart(SourceLocation LocBegin,
459 return new (Allocator) HTMLStartTagComment(LocBegin, TagName);
462 void Sema::actOnHTMLStartTagFinish(
463 HTMLStartTagComment *Tag,
464 ArrayRef<HTMLStartTagComment::Attribute> Attrs,
465 SourceLocation GreaterLoc,
466 bool IsSelfClosing) {
467 Tag->setAttrs(Attrs);
468 Tag->setGreaterLoc(GreaterLoc);
470 Tag->setSelfClosing();
471 else if (!isHTMLEndTagForbidden(Tag->getTagName()))
472 HTMLOpenTags.push_back(Tag);
475 HTMLEndTagComment *Sema::actOnHTMLEndTag(SourceLocation LocBegin,
476 SourceLocation LocEnd,
478 HTMLEndTagComment *HET =
479 new (Allocator) HTMLEndTagComment(LocBegin, LocEnd, TagName);
480 if (isHTMLEndTagForbidden(TagName)) {
481 Diag(HET->getLocation(), diag::warn_doc_html_end_forbidden)
482 << TagName << HET->getSourceRange();
483 HET->setIsMalformed();
487 bool FoundOpen = false;
488 for (SmallVectorImpl<HTMLStartTagComment *>::const_reverse_iterator
489 I = HTMLOpenTags.rbegin(), E = HTMLOpenTags.rend();
491 if ((*I)->getTagName() == TagName) {
497 Diag(HET->getLocation(), diag::warn_doc_html_end_unbalanced)
498 << HET->getSourceRange();
499 HET->setIsMalformed();
503 while (!HTMLOpenTags.empty()) {
504 HTMLStartTagComment *HST = HTMLOpenTags.pop_back_val();
505 StringRef LastNotClosedTagName = HST->getTagName();
506 if (LastNotClosedTagName == TagName) {
507 // If the start tag is malformed, end tag is malformed as well.
508 if (HST->isMalformed())
509 HET->setIsMalformed();
513 if (isHTMLEndTagOptional(LastNotClosedTagName))
516 bool OpenLineInvalid;
517 const unsigned OpenLine = SourceMgr.getPresumedLineNumber(
520 bool CloseLineInvalid;
521 const unsigned CloseLine = SourceMgr.getPresumedLineNumber(
525 if (OpenLineInvalid || CloseLineInvalid || OpenLine == CloseLine) {
526 Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch)
527 << HST->getTagName() << HET->getTagName()
528 << HST->getSourceRange() << HET->getSourceRange();
529 HST->setIsMalformed();
531 Diag(HST->getLocation(), diag::warn_doc_html_start_end_mismatch)
532 << HST->getTagName() << HET->getTagName()
533 << HST->getSourceRange();
534 Diag(HET->getLocation(), diag::note_doc_html_end_tag)
535 << HET->getSourceRange();
536 HST->setIsMalformed();
543 FullComment *Sema::actOnFullComment(
544 ArrayRef<BlockContentComment *> Blocks) {
545 FullComment *FC = new (Allocator) FullComment(Blocks, ThisDeclInfo);
546 resolveParamCommandIndexes(FC);
548 // Complain about HTML tags that are not closed.
549 while (!HTMLOpenTags.empty()) {
550 HTMLStartTagComment *HST = HTMLOpenTags.pop_back_val();
551 if (isHTMLEndTagOptional(HST->getTagName()))
554 Diag(HST->getLocation(), diag::warn_doc_html_missing_end_tag)
555 << HST->getTagName() << HST->getSourceRange();
556 HST->setIsMalformed();
562 void Sema::checkBlockCommandEmptyParagraph(BlockCommandComment *Command) {
563 if (Traits.getCommandInfo(Command->getCommandID())->IsEmptyParagraphAllowed)
566 ParagraphComment *Paragraph = Command->getParagraph();
567 if (Paragraph->isWhitespace()) {
568 SourceLocation DiagLoc;
569 if (Command->getNumArgs() > 0)
570 DiagLoc = Command->getArgRange(Command->getNumArgs() - 1).getEnd();
571 if (!DiagLoc.isValid())
572 DiagLoc = Command->getCommandNameRange(Traits).getEnd();
573 Diag(DiagLoc, diag::warn_doc_block_command_empty_paragraph)
574 << Command->getCommandMarker()
575 << Command->getCommandName(Traits)
576 << Command->getSourceRange();
580 void Sema::checkReturnsCommand(const BlockCommandComment *Command) {
581 if (!Traits.getCommandInfo(Command->getCommandID())->IsReturnsCommand)
584 assert(ThisDeclInfo && "should not call this check on a bare comment");
586 // We allow the return command for all @properties because it can be used
587 // to document the value that the property getter returns.
588 if (isObjCPropertyDecl())
590 if (isFunctionDecl() || isFunctionOrBlockPointerVarLikeDecl()) {
591 if (ThisDeclInfo->ReturnType->isVoidType()) {
593 switch (ThisDeclInfo->CommentDecl->getKind()) {
595 if (ThisDeclInfo->IsObjCMethod)
600 case Decl::CXXConstructor:
603 case Decl::CXXDestructor:
607 Diag(Command->getLocation(),
608 diag::warn_doc_returns_attached_to_a_void_function)
609 << Command->getCommandMarker()
610 << Command->getCommandName(Traits)
612 << Command->getSourceRange();
617 Diag(Command->getLocation(),
618 diag::warn_doc_returns_not_attached_to_a_function_decl)
619 << Command->getCommandMarker()
620 << Command->getCommandName(Traits)
621 << Command->getSourceRange();
624 void Sema::checkBlockCommandDuplicate(const BlockCommandComment *Command) {
625 const CommandInfo *Info = Traits.getCommandInfo(Command->getCommandID());
626 const BlockCommandComment *PrevCommand = nullptr;
627 if (Info->IsBriefCommand) {
629 BriefCommand = Command;
632 PrevCommand = BriefCommand;
633 } else if (Info->IsHeaderfileCommand) {
634 if (!HeaderfileCommand) {
635 HeaderfileCommand = Command;
638 PrevCommand = HeaderfileCommand;
640 // We don't want to check this command for duplicates.
643 StringRef CommandName = Command->getCommandName(Traits);
644 StringRef PrevCommandName = PrevCommand->getCommandName(Traits);
645 Diag(Command->getLocation(), diag::warn_doc_block_command_duplicate)
646 << Command->getCommandMarker()
648 << Command->getSourceRange();
649 if (CommandName == PrevCommandName)
650 Diag(PrevCommand->getLocation(), diag::note_doc_block_command_previous)
651 << PrevCommand->getCommandMarker()
653 << PrevCommand->getSourceRange();
655 Diag(PrevCommand->getLocation(),
656 diag::note_doc_block_command_previous_alias)
657 << PrevCommand->getCommandMarker()
662 void Sema::checkDeprecatedCommand(const BlockCommandComment *Command) {
663 if (!Traits.getCommandInfo(Command->getCommandID())->IsDeprecatedCommand)
666 assert(ThisDeclInfo && "should not call this check on a bare comment");
668 const Decl *D = ThisDeclInfo->CommentDecl;
672 if (D->hasAttr<DeprecatedAttr>() ||
673 D->hasAttr<AvailabilityAttr>() ||
674 D->hasAttr<UnavailableAttr>())
677 Diag(Command->getLocation(),
678 diag::warn_doc_deprecated_not_sync)
679 << Command->getSourceRange();
681 // Try to emit a fixit with a deprecation attribute.
682 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
683 // Don't emit a Fix-It for non-member function definitions. GCC does not
684 // accept attributes on them.
685 const DeclContext *Ctx = FD->getDeclContext();
686 if ((!Ctx || !Ctx->isRecord()) &&
687 FD->doesThisDeclarationHaveABody())
690 StringRef AttributeSpelling = "__attribute__((deprecated))";
692 TokenValue Tokens[] = {
693 tok::kw___attribute, tok::l_paren, tok::l_paren,
694 PP->getIdentifierInfo("deprecated"),
695 tok::r_paren, tok::r_paren
697 StringRef MacroName = PP->getLastMacroWithSpelling(FD->getLocation(),
699 if (!MacroName.empty())
700 AttributeSpelling = MacroName;
703 SmallString<64> TextToInsert(" ");
704 TextToInsert += AttributeSpelling;
705 Diag(FD->getEndLoc(), diag::note_add_deprecation_attr)
706 << FixItHint::CreateInsertion(FD->getEndLoc().getLocWithOffset(1),
711 void Sema::resolveParamCommandIndexes(const FullComment *FC) {
712 if (!isFunctionDecl()) {
713 // We already warned that \\param commands are not attached to a function
718 SmallVector<ParamCommandComment *, 8> UnresolvedParamCommands;
720 // Comment AST nodes that correspond to \c ParamVars for which we have
721 // found a \\param command or NULL if no documentation was found so far.
722 SmallVector<ParamCommandComment *, 8> ParamVarDocs;
724 ArrayRef<const ParmVarDecl *> ParamVars = getParamVars();
725 ParamVarDocs.resize(ParamVars.size(), nullptr);
727 // First pass over all \\param commands: resolve all parameter names.
728 for (Comment::child_iterator I = FC->child_begin(), E = FC->child_end();
730 ParamCommandComment *PCC = dyn_cast<ParamCommandComment>(*I);
731 if (!PCC || !PCC->hasParamName())
733 StringRef ParamName = PCC->getParamNameAsWritten();
735 // Check that referenced parameter name is in the function decl.
736 const unsigned ResolvedParamIndex = resolveParmVarReference(ParamName,
738 if (ResolvedParamIndex == ParamCommandComment::VarArgParamIndex) {
739 PCC->setIsVarArgParam();
742 if (ResolvedParamIndex == ParamCommandComment::InvalidParamIndex) {
743 UnresolvedParamCommands.push_back(PCC);
746 PCC->setParamIndex(ResolvedParamIndex);
747 if (ParamVarDocs[ResolvedParamIndex]) {
748 SourceRange ArgRange = PCC->getParamNameRange();
749 Diag(ArgRange.getBegin(), diag::warn_doc_param_duplicate)
750 << ParamName << ArgRange;
751 ParamCommandComment *PrevCommand = ParamVarDocs[ResolvedParamIndex];
752 Diag(PrevCommand->getLocation(), diag::note_doc_param_previous)
753 << PrevCommand->getParamNameRange();
755 ParamVarDocs[ResolvedParamIndex] = PCC;
758 // Find parameter declarations that have no corresponding \\param.
759 SmallVector<const ParmVarDecl *, 8> OrphanedParamDecls;
760 for (unsigned i = 0, e = ParamVarDocs.size(); i != e; ++i) {
761 if (!ParamVarDocs[i])
762 OrphanedParamDecls.push_back(ParamVars[i]);
765 // Second pass over unresolved \\param commands: do typo correction.
766 // Suggest corrections from a set of parameter declarations that have no
767 // corresponding \\param.
768 for (unsigned i = 0, e = UnresolvedParamCommands.size(); i != e; ++i) {
769 const ParamCommandComment *PCC = UnresolvedParamCommands[i];
771 SourceRange ArgRange = PCC->getParamNameRange();
772 StringRef ParamName = PCC->getParamNameAsWritten();
773 Diag(ArgRange.getBegin(), diag::warn_doc_param_not_found)
774 << ParamName << ArgRange;
776 // All parameters documented -- can't suggest a correction.
777 if (OrphanedParamDecls.size() == 0)
780 unsigned CorrectedParamIndex = ParamCommandComment::InvalidParamIndex;
781 if (OrphanedParamDecls.size() == 1) {
782 // If one parameter is not documented then that parameter is the only
783 // possible suggestion.
784 CorrectedParamIndex = 0;
786 // Do typo correction.
787 CorrectedParamIndex = correctTypoInParmVarReference(ParamName,
790 if (CorrectedParamIndex != ParamCommandComment::InvalidParamIndex) {
791 const ParmVarDecl *CorrectedPVD = OrphanedParamDecls[CorrectedParamIndex];
792 if (const IdentifierInfo *CorrectedII = CorrectedPVD->getIdentifier())
793 Diag(ArgRange.getBegin(), diag::note_doc_param_name_suggestion)
794 << CorrectedII->getName()
795 << FixItHint::CreateReplacement(ArgRange, CorrectedII->getName());
800 bool Sema::isFunctionDecl() {
803 if (!ThisDeclInfo->IsFilled)
805 return ThisDeclInfo->getKind() == DeclInfo::FunctionKind;
808 bool Sema::isAnyFunctionDecl() {
809 return isFunctionDecl() && ThisDeclInfo->CurrentDecl &&
810 isa<FunctionDecl>(ThisDeclInfo->CurrentDecl);
813 bool Sema::isFunctionOrMethodVariadic() {
814 if (!isFunctionDecl() || !ThisDeclInfo->CurrentDecl)
816 if (const FunctionDecl *FD =
817 dyn_cast<FunctionDecl>(ThisDeclInfo->CurrentDecl))
818 return FD->isVariadic();
819 if (const FunctionTemplateDecl *FTD =
820 dyn_cast<FunctionTemplateDecl>(ThisDeclInfo->CurrentDecl))
821 return FTD->getTemplatedDecl()->isVariadic();
822 if (const ObjCMethodDecl *MD =
823 dyn_cast<ObjCMethodDecl>(ThisDeclInfo->CurrentDecl))
824 return MD->isVariadic();
825 if (const TypedefNameDecl *TD =
826 dyn_cast<TypedefNameDecl>(ThisDeclInfo->CurrentDecl)) {
827 QualType Type = TD->getUnderlyingType();
828 if (Type->isFunctionPointerType() || Type->isBlockPointerType())
829 Type = Type->getPointeeType();
830 if (const auto *FT = Type->getAs<FunctionProtoType>())
831 return FT->isVariadic();
836 bool Sema::isObjCMethodDecl() {
837 return isFunctionDecl() && ThisDeclInfo->CurrentDecl &&
838 isa<ObjCMethodDecl>(ThisDeclInfo->CurrentDecl);
841 bool Sema::isFunctionPointerVarDecl() {
844 if (!ThisDeclInfo->IsFilled)
846 if (ThisDeclInfo->getKind() == DeclInfo::VariableKind) {
847 if (const VarDecl *VD = dyn_cast_or_null<VarDecl>(ThisDeclInfo->CurrentDecl)) {
848 QualType QT = VD->getType();
849 return QT->isFunctionPointerType();
855 bool Sema::isFunctionOrBlockPointerVarLikeDecl() {
858 if (!ThisDeclInfo->IsFilled)
860 if (ThisDeclInfo->getKind() != DeclInfo::VariableKind ||
861 !ThisDeclInfo->CurrentDecl)
864 if (const auto *VD = dyn_cast<DeclaratorDecl>(ThisDeclInfo->CurrentDecl))
866 else if (const auto *PD =
867 dyn_cast<ObjCPropertyDecl>(ThisDeclInfo->CurrentDecl))
871 // We would like to warn about the 'returns'/'param' commands for
872 // variables that don't directly specify the function type, so type aliases
874 if (QT->getAs<TypedefType>())
876 return QT->isFunctionPointerType() || QT->isBlockPointerType();
879 bool Sema::isObjCPropertyDecl() {
882 if (!ThisDeclInfo->IsFilled)
884 return ThisDeclInfo->CurrentDecl->getKind() == Decl::ObjCProperty;
887 bool Sema::isTemplateOrSpecialization() {
890 if (!ThisDeclInfo->IsFilled)
892 return ThisDeclInfo->getTemplateKind() != DeclInfo::NotTemplate;
895 bool Sema::isRecordLikeDecl() {
898 if (!ThisDeclInfo->IsFilled)
900 return isUnionDecl() || isClassOrStructDecl() || isObjCInterfaceDecl() ||
901 isObjCProtocolDecl();
904 bool Sema::isUnionDecl() {
907 if (!ThisDeclInfo->IsFilled)
909 if (const RecordDecl *RD =
910 dyn_cast_or_null<RecordDecl>(ThisDeclInfo->CurrentDecl))
911 return RD->isUnion();
915 bool Sema::isClassOrStructDecl() {
918 if (!ThisDeclInfo->IsFilled)
920 return ThisDeclInfo->CurrentDecl &&
921 isa<RecordDecl>(ThisDeclInfo->CurrentDecl) &&
925 bool Sema::isClassTemplateDecl() {
928 if (!ThisDeclInfo->IsFilled)
930 return ThisDeclInfo->CurrentDecl &&
931 (isa<ClassTemplateDecl>(ThisDeclInfo->CurrentDecl));
934 bool Sema::isFunctionTemplateDecl() {
937 if (!ThisDeclInfo->IsFilled)
939 return ThisDeclInfo->CurrentDecl &&
940 (isa<FunctionTemplateDecl>(ThisDeclInfo->CurrentDecl));
943 bool Sema::isObjCInterfaceDecl() {
946 if (!ThisDeclInfo->IsFilled)
948 return ThisDeclInfo->CurrentDecl &&
949 isa<ObjCInterfaceDecl>(ThisDeclInfo->CurrentDecl);
952 bool Sema::isObjCProtocolDecl() {
955 if (!ThisDeclInfo->IsFilled)
957 return ThisDeclInfo->CurrentDecl &&
958 isa<ObjCProtocolDecl>(ThisDeclInfo->CurrentDecl);
961 ArrayRef<const ParmVarDecl *> Sema::getParamVars() {
962 if (!ThisDeclInfo->IsFilled)
964 return ThisDeclInfo->ParamVars;
967 void Sema::inspectThisDecl() {
968 ThisDeclInfo->fill();
971 unsigned Sema::resolveParmVarReference(StringRef Name,
972 ArrayRef<const ParmVarDecl *> ParamVars) {
973 for (unsigned i = 0, e = ParamVars.size(); i != e; ++i) {
974 const IdentifierInfo *II = ParamVars[i]->getIdentifier();
975 if (II && II->getName() == Name)
978 if (Name == "..." && isFunctionOrMethodVariadic())
979 return ParamCommandComment::VarArgParamIndex;
980 return ParamCommandComment::InvalidParamIndex;
984 class SimpleTypoCorrector {
985 const NamedDecl *BestDecl;
988 const unsigned MaxEditDistance;
990 unsigned BestEditDistance;
995 explicit SimpleTypoCorrector(StringRef Typo)
996 : BestDecl(nullptr), Typo(Typo), MaxEditDistance((Typo.size() + 2) / 3),
997 BestEditDistance(MaxEditDistance + 1), BestIndex(0), NextIndex(0) {}
999 void addDecl(const NamedDecl *ND);
1001 const NamedDecl *getBestDecl() const {
1002 if (BestEditDistance > MaxEditDistance)
1008 unsigned getBestDeclIndex() const {
1009 assert(getBestDecl());
1014 void SimpleTypoCorrector::addDecl(const NamedDecl *ND) {
1015 unsigned CurrIndex = NextIndex++;
1017 const IdentifierInfo *II = ND->getIdentifier();
1021 StringRef Name = II->getName();
1022 unsigned MinPossibleEditDistance = abs((int)Name.size() - (int)Typo.size());
1023 if (MinPossibleEditDistance > 0 &&
1024 Typo.size() / MinPossibleEditDistance < 3)
1027 unsigned EditDistance = Typo.edit_distance(Name, true, MaxEditDistance);
1028 if (EditDistance < BestEditDistance) {
1029 BestEditDistance = EditDistance;
1031 BestIndex = CurrIndex;
1034 } // end anonymous namespace
1036 unsigned Sema::correctTypoInParmVarReference(
1038 ArrayRef<const ParmVarDecl *> ParamVars) {
1039 SimpleTypoCorrector Corrector(Typo);
1040 for (unsigned i = 0, e = ParamVars.size(); i != e; ++i)
1041 Corrector.addDecl(ParamVars[i]);
1042 if (Corrector.getBestDecl())
1043 return Corrector.getBestDeclIndex();
1045 return ParamCommandComment::InvalidParamIndex;
1049 bool ResolveTParamReferenceHelper(
1051 const TemplateParameterList *TemplateParameters,
1052 SmallVectorImpl<unsigned> *Position) {
1053 for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) {
1054 const NamedDecl *Param = TemplateParameters->getParam(i);
1055 const IdentifierInfo *II = Param->getIdentifier();
1056 if (II && II->getName() == Name) {
1057 Position->push_back(i);
1061 if (const TemplateTemplateParmDecl *TTP =
1062 dyn_cast<TemplateTemplateParmDecl>(Param)) {
1063 Position->push_back(i);
1064 if (ResolveTParamReferenceHelper(Name, TTP->getTemplateParameters(),
1067 Position->pop_back();
1072 } // end anonymous namespace
1074 bool Sema::resolveTParamReference(
1076 const TemplateParameterList *TemplateParameters,
1077 SmallVectorImpl<unsigned> *Position) {
1079 if (!TemplateParameters)
1082 return ResolveTParamReferenceHelper(Name, TemplateParameters, Position);
1086 void CorrectTypoInTParamReferenceHelper(
1087 const TemplateParameterList *TemplateParameters,
1088 SimpleTypoCorrector &Corrector) {
1089 for (unsigned i = 0, e = TemplateParameters->size(); i != e; ++i) {
1090 const NamedDecl *Param = TemplateParameters->getParam(i);
1091 Corrector.addDecl(Param);
1093 if (const TemplateTemplateParmDecl *TTP =
1094 dyn_cast<TemplateTemplateParmDecl>(Param))
1095 CorrectTypoInTParamReferenceHelper(TTP->getTemplateParameters(),
1099 } // end anonymous namespace
1101 StringRef Sema::correctTypoInTParamReference(
1103 const TemplateParameterList *TemplateParameters) {
1104 SimpleTypoCorrector Corrector(Typo);
1105 CorrectTypoInTParamReferenceHelper(TemplateParameters, Corrector);
1106 if (const NamedDecl *ND = Corrector.getBestDecl()) {
1107 const IdentifierInfo *II = ND->getIdentifier();
1108 assert(II && "SimpleTypoCorrector should not return this decl");
1109 return II->getName();
1114 InlineCommandComment::RenderKind
1115 Sema::getInlineCommandRenderKind(StringRef Name) const {
1116 assert(Traits.getCommandInfo(Name)->IsInlineCommand);
1118 return llvm::StringSwitch<InlineCommandComment::RenderKind>(Name)
1119 .Case("b", InlineCommandComment::RenderBold)
1120 .Cases("c", "p", InlineCommandComment::RenderMonospaced)
1121 .Cases("a", "e", "em", InlineCommandComment::RenderEmphasized)
1122 .Default(InlineCommandComment::RenderNormal);
1125 } // end namespace comments
1126 } // end namespace clang