clang
9.0.0
|
Rewriter - This is the main interface to the rewrite buffers. More...
#include "clang/Rewrite/Core/Rewriter.h"
Classes | |
struct | RewriteOptions |
Public Types | |
using | buffer_iterator = std::map< FileID, RewriteBuffer >::iterator |
using | const_buffer_iterator = std::map< FileID, RewriteBuffer >::const_iterator |
Public Member Functions | |
Rewriter ()=default | |
Rewriter (SourceManager &SM, const LangOptions &LO) | |
void | setSourceMgr (SourceManager &SM, const LangOptions &LO) |
SourceManager & | getSourceMgr () const |
const LangOptions & | getLangOpts () const |
int | getRangeSize (SourceRange Range, RewriteOptions opts=RewriteOptions()) const |
getRangeSize - Return the size in bytes of the specified range if they are in the same file. More... | |
int | getRangeSize (const CharSourceRange &Range, RewriteOptions opts=RewriteOptions()) const |
getRangeSize - Return the size in bytes of the specified range if they are in the same file. More... | |
std::string | getRewrittenText (CharSourceRange Range) const |
getRewrittenText - Return the rewritten form of the text in the specified range. More... | |
std::string | getRewrittenText (SourceRange Range) const |
getRewrittenText - Return the rewritten form of the text in the specified range. More... | |
bool | InsertText (SourceLocation Loc, StringRef Str, bool InsertAfter=true, bool indentNewLines=false) |
InsertText - Insert the specified string at the specified location in the original buffer. More... | |
bool | InsertTextAfter (SourceLocation Loc, StringRef Str) |
InsertTextAfter - Insert the specified string at the specified location in the original buffer. More... | |
bool | InsertTextAfterToken (SourceLocation Loc, StringRef Str) |
Insert the specified string after the token in the specified location. More... | |
bool | InsertTextBefore (SourceLocation Loc, StringRef Str) |
InsertText - Insert the specified string at the specified location in the original buffer. More... | |
bool | RemoveText (SourceLocation Start, unsigned Length, RewriteOptions opts=RewriteOptions()) |
RemoveText - Remove the specified text region. More... | |
bool | RemoveText (CharSourceRange range, RewriteOptions opts=RewriteOptions()) |
Remove the specified text region. More... | |
bool | RemoveText (SourceRange range, RewriteOptions opts=RewriteOptions()) |
Remove the specified text region. More... | |
bool | ReplaceText (SourceLocation Start, unsigned OrigLength, StringRef NewStr) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string. More... | |
bool | ReplaceText (CharSourceRange range, StringRef NewStr) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string. More... | |
bool | ReplaceText (SourceRange range, StringRef NewStr) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string. More... | |
bool | ReplaceText (SourceRange range, SourceRange replacementRange) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string. More... | |
bool | IncreaseIndentation (CharSourceRange range, SourceLocation parentIndent) |
Increase indentation for the lines between the given source range. More... | |
bool | IncreaseIndentation (SourceRange range, SourceLocation parentIndent) |
RewriteBuffer & | getEditBuffer (FileID FID) |
getEditBuffer - This is like getRewriteBufferFor, but always returns a buffer, and allows you to write on it directly. More... | |
const RewriteBuffer * | getRewriteBufferFor (FileID FID) const |
getRewriteBufferFor - Return the rewrite buffer for the specified FileID. More... | |
buffer_iterator | buffer_begin () |
buffer_iterator | buffer_end () |
const_buffer_iterator | buffer_begin () const |
const_buffer_iterator | buffer_end () const |
bool | overwriteChangedFiles () |
overwriteChangedFiles - Save all changed files to disk. More... | |
Static Public Member Functions | |
static bool | isRewritable (SourceLocation Loc) |
isRewritable - Return true if this location is a raw file location, which is rewritable. More... | |
Rewriter - This is the main interface to the rewrite buffers.
Its primary job is to dispatch high-level requests to the low-level RewriteBuffers that are involved.
Definition at line 32 of file Rewriter.h.
using clang::Rewriter::buffer_iterator = std::map<FileID, RewriteBuffer>::iterator |
Definition at line 54 of file Rewriter.h.
using clang::Rewriter::const_buffer_iterator = std::map<FileID, RewriteBuffer>::const_iterator |
Definition at line 55 of file Rewriter.h.
|
explicitdefault |
|
inlineexplicit |
Definition at line 58 of file Rewriter.h.
|
inline |
Definition at line 194 of file Rewriter.h.
Referenced by clang::FixItRewriter::buffer_begin().
|
inline |
Definition at line 196 of file Rewriter.h.
|
inline |
Definition at line 195 of file Rewriter.h.
Referenced by clang::FixItRewriter::buffer_end().
|
inline |
Definition at line 197 of file Rewriter.h.
References overwriteChangedFiles().
RewriteBuffer & Rewriter::getEditBuffer | ( | FileID | FID | ) |
getEditBuffer - This is like getRewriteBufferFor, but always returns a buffer, and allows you to write on it directly.
getEditBuffer - Get or create a RewriteBuffer for the specified FileID.
This is useful if you want efficient low-level access to apis for scribbling on one specific FileID's buffer.
Definition at line 229 of file Rewriter.cpp.
References clang::RewriteBuffer::Initialize().
Referenced by clang::html::AddLineNumbers(), clang::tooling::applyAllReplacements(), clang::html::EscapeText(), clang::index::SimpleFormatContext::getRewrittenText(), clang::html::HighlightRange(), IncreaseIndentation(), clang::RewriteMacrosInInput(), and clang::html::SyntaxHighlight().
|
inline |
Definition at line 67 of file Rewriter.h.
Referenced by EmitAlphaCounter(), and clang::html::HighlightRange().
int Rewriter::getRangeSize | ( | SourceRange | Range, |
RewriteOptions | opts = RewriteOptions() |
||
) | const |
getRangeSize - Return the size in bytes of the specified range if they are in the same file.
If not, this returns -1.
Definition at line 164 of file Rewriter.cpp.
References getRangeSize(), and clang::CharSourceRange::getTokenRange().
Referenced by hasSuperInitCall(), isRewritable(), RemoveText(), ReplaceText(), and clang::FixItRewriter::WriteFixedFile().
int Rewriter::getRangeSize | ( | const CharSourceRange & | Range, |
RewriteOptions | opts = RewriteOptions() |
||
) | const |
getRangeSize - Return the size in bytes of the specified range if they are in the same file.
If not, this returns -1.
Definition at line 134 of file Rewriter.cpp.
References clang::CharSourceRange::getBegin(), clang::CharSourceRange::getEnd(), clang::Rewriter::RewriteOptions::IncludeInsertsAtBeginOfRange, clang::Rewriter::RewriteOptions::IncludeInsertsAtEndOfRange, clang::CharSourceRange::isTokenRange(), and clang::Lexer::MeasureTokenLength().
|
inline |
getRewriteBufferFor - Return the rewrite buffer for the specified FileID.
If no modification has been made to it, return null.
Definition at line 187 of file Rewriter.h.
References clang::RewriteBuffer::end().
Referenced by applyEditsToTemp(), clang::FixItRewriter::IsModified(), clang::RewriteMacrosInInput(), Write_ProtocolExprReferencedMetadata(), and clang::FixItRewriter::WriteFixedFile().
std::string Rewriter::getRewrittenText | ( | CharSourceRange | Range | ) | const |
getRewrittenText - Return the rewritten form of the text in the specified range.
If the start or end of the range was unrewritable or if they are in different buffers, this returns an empty string.
Note that this method is not particularly efficient.
Definition at line 173 of file Rewriter.cpp.
References clang::RewriteBuffer::begin(), End, clang::CharSourceRange::getBegin(), clang::CharSourceRange::getEnd(), clang::CharSourceRange::isTokenRange(), clang::SourceLocation::isValid(), clang::Lexer::MeasureTokenLength(), and V.
Referenced by getRewrittenText(), and isRewritable().
|
inline |
getRewrittenText - Return the rewritten form of the text in the specified range.
If the start or end of the range was unrewritable or if they are in different buffers, this returns an empty string.
Note that this method is not particularly efficient.
Definition at line 94 of file Rewriter.h.
References getRewrittenText(), clang::CharSourceRange::getTokenRange(), and InsertText().
|
inline |
Definition at line 66 of file Rewriter.h.
Referenced by clang::html::AddHeaderFooterInternalBuiltinCSS(), clang::html::AddLineNumbers(), clang::tooling::Replacement::apply(), clang::tooling::RefactoringTool::applyAllReplacements(), EmitAlphaCounter(), clang::html::EscapeText(), clang::tooling::formatAndApplyAllReplacements(), HandlePopUpPieceEndTag(), and clang::html::HighlightRange().
bool Rewriter::IncreaseIndentation | ( | CharSourceRange | range, |
SourceLocation | parentIndent | ||
) |
Increase indentation for the lines between the given source range.
To determine what the indentation should be, 'parentIndent' is used that should be at a source location with an indentation one degree lower than the given range.
Definition at line 333 of file Rewriter.cpp.
References Filename, clang::CharSourceRange::getBegin(), clang::CharSourceRange::getEnd(), i, clang::RewriteBuffer::InsertText(), clang::CharSourceRange::isInvalid(), isWhitespaceExceptNL(), clang::tooling::remove(), clang::DiagnosticsEngine::Report(), and clang::SrcMgr::ContentCache::SourceLineCache.
Referenced by clang::arcmt::getFileRemappings(), IncreaseIndentation(), and ReplaceText().
|
inline |
Definition at line 174 of file Rewriter.h.
References getEditBuffer(), clang::CharSourceRange::getTokenRange(), and IncreaseIndentation().
bool Rewriter::InsertText | ( | SourceLocation | Loc, |
StringRef | Str, | ||
bool | InsertAfter = true , |
||
bool | indentNewLines = false |
||
) |
InsertText - Insert the specified string at the specified location in the original buffer.
This method returns true (and does nothing) if the input location was not rewritable, false otherwise.
indentNewLines | if true new lines in the string are indented using the indentation of the source line in position Loc . |
Definition at line 244 of file Rewriter.cpp.
References i, isWhitespaceExceptNL(), and clang::SrcMgr::ContentCache::SourceLineCache.
Referenced by clang::arcmt::getFileRemappings(), getRewrittenText(), hasSuperInitCall(), InsertTextAfter(), InsertTextBefore(), and clang::FixItRewriter::WriteFixedFile().
|
inline |
InsertTextAfter - Insert the specified string at the specified location in the original buffer.
This method returns true (and does nothing) if the input location was not rewritable, false otherwise. Text is inserted after any other text that has been previously inserted at the some point (the default behavior for InsertText).
Definition at line 112 of file Rewriter.h.
References InsertText(), and InsertTextAfterToken().
Referenced by clang::html::AddHeaderFooterInternalBuiltinCSS().
bool Rewriter::InsertTextAfterToken | ( | SourceLocation | Loc, |
StringRef | Str | ||
) |
Insert the specified string after the token in the specified location.
Definition at line 285 of file Rewriter.cpp.
References getRangeSize(), and clang::Rewriter::RewriteOptions::IncludeInsertsAtBeginOfRange.
Referenced by InsertTextAfter().
|
inline |
InsertText - Insert the specified string at the specified location in the original buffer.
This method returns true (and does nothing) if the input location was not rewritable, false otherwise. Text is inserted before any other text that has been previously inserted at the some point.
Definition at line 125 of file Rewriter.h.
References InsertText(), RemoveText(), and clang::Rewriter::RewriteOptions::RewriteOptions().
Referenced by clang::html::AddHeaderFooterInternalBuiltinCSS(), and HandlePopUpPieceEndTag().
|
inlinestatic |
isRewritable - Return true if this location is a raw file location, which is rewritable.
Locations from macros, etc are not rewritable.
Definition at line 71 of file Rewriter.h.
References getRangeSize(), getRewrittenText(), clang::SourceLocation::isFileID(), and clang::Rewriter::RewriteOptions::RewriteOptions().
bool Rewriter::overwriteChangedFiles | ( | ) |
overwriteChangedFiles - Save all changed files to disk.
Returns true if any files were not saved successfully. Outputs diagnostics via the source manager's diagnostic engine in case of an error.
Definition at line 454 of file Rewriter.cpp.
References clang::FileEntry::getName().
Referenced by clang::tooling::RefactoringTool::applyAllReplacements(), and buffer_end().
bool Rewriter::RemoveText | ( | SourceLocation | Start, |
unsigned | Length, | ||
RewriteOptions | opts = RewriteOptions() |
||
) |
RemoveText - Remove the specified text region.
Definition at line 297 of file Rewriter.cpp.
References clang::Rewriter::RewriteOptions::RemoveLineIfEmpty.
Referenced by clang::arcmt::getFileRemappings(), InsertTextBefore(), and RemoveText().
|
inline |
Remove the specified text region.
Definition at line 134 of file Rewriter.h.
References clang::CharSourceRange::getBegin(), getRangeSize(), and RemoveText().
|
inline |
Remove the specified text region.
Definition at line 140 of file Rewriter.h.
References clang::SourceRange::getBegin(), getRangeSize(), RemoveText(), and ReplaceText().
bool Rewriter::ReplaceText | ( | SourceLocation | Start, |
unsigned | OrigLength, | ||
StringRef | NewStr | ||
) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string.
This is effectively a combined "remove/insert" operation.
Definition at line 309 of file Rewriter.cpp.
Referenced by clang::tooling::Replacement::apply(), hasSuperInitCall(), RemoveText(), ReplaceText(), and clang::FixItRewriter::WriteFixedFile().
|
inline |
ReplaceText - This method replaces a range of characters in the input buffer with a new string.
This is effectively a combined "remove/insert" operation.
Definition at line 153 of file Rewriter.h.
References clang::CharSourceRange::getBegin(), getRangeSize(), and ReplaceText().
|
inline |
ReplaceText - This method replaces a range of characters in the input buffer with a new string.
This is effectively a combined "remove/insert" operation.
Definition at line 160 of file Rewriter.h.
References clang::SourceRange::getBegin(), getRangeSize(), IncreaseIndentation(), and ReplaceText().
bool Rewriter::ReplaceText | ( | SourceRange | range, |
SourceRange | replacementRange | ||
) |
ReplaceText - This method replaces a range of characters in the input buffer with a new string.
This is effectively a combined "remove/insert" operation.
Definition at line 319 of file Rewriter.cpp.
References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), getRangeSize(), clang::SourceRange::isInvalid(), and clang::RewriteBuffer::ReplaceText().
|
inline |
Definition at line 61 of file Rewriter.h.
References SM.
Referenced by clang::CreateModernObjCRewriter(), clang::CreateObjCRewriter(), and clang::RewriteMacrosInInput().