clang
15.0.0git
|
#include "clang/AST/RawCommentList.h"
Classes | |
struct | CommentLine |
Public Types | |
enum | CommentKind { RCK_Invalid, RCK_OrdinaryBCPL, RCK_OrdinaryC, RCK_BCPLSlash, RCK_BCPLExcl, RCK_JavaDoc, RCK_Qt, RCK_Merged } |
Public Member Functions | |
RawComment () | |
RawComment (const SourceManager &SourceMgr, SourceRange SR, const CommentOptions &CommentOpts, bool Merged) | |
CommentKind | getKind () const LLVM_READONLY |
bool | isInvalid () const LLVM_READONLY |
bool | isMerged () const LLVM_READONLY |
bool | isAttached () const LLVM_READONLY |
Is this comment attached to any declaration? More... | |
void | setAttached () |
bool | isTrailingComment () const LLVM_READONLY |
Returns true if it is a comment that should be put after a member: More... | |
bool | isAlmostTrailingComment () const LLVM_READONLY |
Returns true if it is a probable typo: More... | |
bool | isOrdinary () const LLVM_READONLY |
Returns true if this comment is not a documentation comment. More... | |
bool | isDocumentation () const LLVM_READONLY |
Returns true if this comment any kind of a documentation comment. More... | |
StringRef | getRawText (const SourceManager &SourceMgr) const |
Returns raw comment text with comment markers. More... | |
SourceRange | getSourceRange () const LLVM_READONLY |
SourceLocation | getBeginLoc () const LLVM_READONLY |
SourceLocation | getEndLoc () const LLVM_READONLY |
const char * | getBriefText (const ASTContext &Context) const |
std::string | getFormattedText (const SourceManager &SourceMgr, DiagnosticsEngine &Diags) const |
Returns sanitized comment text, suitable for presentation in editor UIs. More... | |
std::vector< CommentLine > | getFormattedLines (const SourceManager &SourceMgr, DiagnosticsEngine &Diags) const |
Returns sanitized comment text as separated lines with locations in source, suitable for further processing and rendering requiring source locations. More... | |
comments::FullComment * | parse (const ASTContext &Context, const Preprocessor *PP, const Decl *D) const |
Parse the comment, assuming it is attached to decl D . More... | |
Friends | |
class | ASTReader |
Definition at line 32 of file RawCommentList.h.
Definition at line 34 of file RawCommentList.h.
|
inline |
Definition at line 45 of file RawCommentList.h.
RawComment::RawComment | ( | const SourceManager & | SourceMgr, |
SourceRange | SR, | ||
const CommentOptions & | CommentOpts, | ||
bool | Merged | ||
) |
Definition at line 110 of file RawCommentList.cpp.
References clang::SourceRange::getBegin(), clang::SourceManager::getBufferData(), clang::SourceManager::getDecomposedLoc(), clang::SourceRange::getEnd(), getRawText(), isOrdinaryKind(), onlyWhitespaceOnLineBefore(), clang::CommentOptions::ParseAllComments, RCK_Invalid, and RCK_Merged.
|
inline |
Definition at line 108 of file RawCommentList.h.
References clang::SourceRange::getBegin().
|
inline |
Definition at line 111 of file RawCommentList.h.
|
inline |
Definition at line 109 of file RawCommentList.h.
References clang::SourceRange::getEnd().
std::vector< RawComment::CommentLine > RawComment::getFormattedLines | ( | const SourceManager & | SourceMgr, |
DiagnosticsEngine & | Diags | ||
) | const |
Returns sanitized comment text as separated lines with locations in source, suitable for further processing and rendering requiring source locations.
Definition at line 378 of file RawCommentList.cpp.
References getRawText().
Referenced by getFormattedText().
std::string RawComment::getFormattedText | ( | const SourceManager & | SourceMgr, |
DiagnosticsEngine & | Diags | ||
) | const |
Returns sanitized comment text, suitable for presentation in editor UIs.
E.g. will transform: // This is a long multiline comment. // Parts of it might be indented. /* The comments styles might be mixed. */ into "This is a long multiline comment.\n" " Parts of it might be indented.\n" "The comments styles might be mixed." Also removes leading indentation and sanitizes some common cases: /* This is a first line.
Definition at line 360 of file RawCommentList.cpp.
References getFormattedLines(), getRawText(), Line, and string().
|
inline |
Definition at line 50 of file RawCommentList.h.
Referenced by clang::Sema::ActOnComment().
|
inline |
Returns raw comment text with comment markers.
Definition at line 98 of file RawCommentList.h.
Referenced by getFormattedLines(), getFormattedText(), parse(), and RawComment().
|
inline |
Definition at line 107 of file RawCommentList.h.
Referenced by clang::ASTContext::addComment(), and parse().
|
inline |
Returns true if it is a probable typo:
Definition at line 83 of file RawCommentList.h.
Referenced by clang::Sema::ActOnComment().
|
inline |
Is this comment attached to any declaration?
Definition at line 63 of file RawCommentList.h.
|
inline |
Returns true if this comment any kind of a documentation comment.
Definition at line 93 of file RawCommentList.h.
References isInvalid(), and isOrdinary().
Referenced by clang::ASTContext::cacheRawCommentForDecl(), and clang::ASTContext::getRawCommentForDeclNoCacheImpl().
|
inline |
Definition at line 54 of file RawCommentList.h.
References RCK_Invalid.
Referenced by isDocumentation().
|
inline |
Definition at line 58 of file RawCommentList.h.
References RCK_Merged.
|
inline |
Returns true if this comment is not a documentation comment.
Definition at line 88 of file RawCommentList.h.
References RCK_OrdinaryBCPL, and RCK_OrdinaryC.
Referenced by isDocumentation().
|
inline |
Returns true if it is a comment that should be put after a member:
Definition at line 76 of file RawCommentList.h.
Referenced by clang::ASTContext::getRawCommentForDeclNoCacheImpl().
comments::FullComment * RawComment::parse | ( | const ASTContext & | Context, |
const Preprocessor * | PP, | ||
const Decl * | D | ||
) | const |
Parse the comment, assuming it is attached to decl D
.
Definition at line 204 of file RawCommentList.cpp.
References clang::ASTContext::getAllocator(), clang::ASTContext::getCommentCommandTraits(), clang::ASTContext::getDiagnostics(), getRawText(), clang::ASTContext::getSourceManager(), and getSourceRange().
Referenced by clang::ASTContext::getCommentForDecl(), and clang::ASTContext::getLocalCommentForDeclUncached().
|
inline |
Definition at line 67 of file RawCommentList.h.
|
friend |
Definition at line 190 of file RawCommentList.h.