clang  15.0.0git
Public Member Functions | Protected Attributes | List of all members
clang::format::BreakableStringLiteral Class Reference

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/Format/BreakableToken.h"

Inheritance diagram for clang::format::BreakableStringLiteral:
Inheritance graph
[legend]
Collaboration diagram for clang::format::BreakableStringLiteral:
Collaboration graph
[legend]

Public Member Functions

 BreakableStringLiteral (const FormatToken &Tok, unsigned StartColumn, StringRef Prefix, StringRef Postfix, unsigned UnbreakableTailLength, bool InPPDirective, encoding::Encoding Encoding, const FormatStyle &Style)
 Creates a breakable token for a single line string literal. More...
 
Split getSplit (unsigned LineIndex, unsigned TailOffset, unsigned ColumnLimit, unsigned ContentStartColumn, const llvm::Regex &CommentPragmasRegex) const override
 Returns a range (offset, length) at which to break the line at LineIndex, if previously broken at TailOffset. More...
 
void insertBreak (unsigned LineIndex, unsigned TailOffset, Split Split, unsigned ContentIndent, WhitespaceManager &Whitespaces) const override
 Emits the previously retrieved Split via Whitespaces. More...
 
void compressWhitespace (unsigned LineIndex, unsigned TailOffset, Split Split, WhitespaceManager &Whitespaces) const override
 Replaces the whitespace range described by Split with a single space. More...
 
unsigned getLineCount () const override
 Returns the number of lines in this token in the original code. More...
 
unsigned getRangeLength (unsigned LineIndex, unsigned Offset, StringRef::size_type Length, unsigned StartColumn) const override
 Returns the number of columns required to format the text in the byte range [Offset, Offset + Length). More...
 
unsigned getRemainingLength (unsigned LineIndex, unsigned Offset, unsigned StartColumn) const override
 Returns the number of columns required to format the text following the byte Offset in the line LineIndex, including potentially unbreakable sequences of tokens following after the end of the token. More...
 
unsigned getContentStartColumn (unsigned LineIndex, bool Break) const override
 Returns the column at which content in line LineIndex starts, assuming no reflow. More...
 
- Public Member Functions inherited from clang::format::BreakableToken
virtual ~BreakableToken ()
 
virtual unsigned getContentIndent (unsigned LineIndex) const
 Returns additional content indent required for the second line after the content at line LineIndex is broken. More...
 
unsigned getLengthAfterCompression (unsigned RemainingTokenColumns, Split Split) const
 Returns the number of columns needed to format RemainingTokenColumns, assuming that Split is within the range measured by RemainingTokenColumns, and that the whitespace in Split is reduced to a single space. More...
 
virtual bool supportsReflow () const
 Returns whether the token supports reflowing text. More...
 
virtual Split getReflowSplit (unsigned LineIndex, const llvm::Regex &CommentPragmasRegex) const
 Returns a whitespace range (offset, length) of the content at LineIndex such that the content of that line is reflown to the end of the previous one. More...
 
virtual void reflow (unsigned LineIndex, WhitespaceManager &Whitespaces) const
 Reflows the current line into the end of the previous one. More...
 
virtual bool introducesBreakBeforeToken () const
 Returns whether there will be a line break at the start of the token. More...
 
virtual void adaptStartOfLine (unsigned LineIndex, WhitespaceManager &Whitespaces) const
 Replaces the whitespace between LineIndex-1 and LineIndex. More...
 
virtual Split getSplitAfterLastLine (unsigned TailOffset) const
 Returns a whitespace range (offset, length) of the content at the last line that needs to be reformatted after the last line has been reformatted. More...
 
void replaceWhitespaceAfterLastLine (unsigned TailOffset, Split SplitAfterLastLine, WhitespaceManager &Whitespaces) const
 Replaces the whitespace from SplitAfterLastLine on the last line after the last line has been formatted by performing a reformatting. More...
 
virtual void updateNextToken (LineState &State) const
 Updates the next token of State to the next token after this one. More...
 

Protected Attributes

unsigned StartColumn
 
StringRef Prefix
 
StringRef Postfix
 
StringRef Line
 
unsigned UnbreakableTailLength
 
- Protected Attributes inherited from clang::format::BreakableToken
const FormatTokenTok
 
const bool InPPDirective
 
const encoding::Encoding Encoding
 
const FormatStyleStyle
 

Additional Inherited Members

- Public Types inherited from clang::format::BreakableToken
typedef std::pair< StringRef::size_type, unsignedSplit
 Contains starting character index and length of split. More...
 
- Protected Member Functions inherited from clang::format::BreakableToken
 BreakableToken (const FormatToken &Tok, bool InPPDirective, encoding::Encoding Encoding, const FormatStyle &Style)
 

Detailed Description

Definition at line 245 of file BreakableToken.h.

Constructor & Destructor Documentation

◆ BreakableStringLiteral()

clang::format::BreakableStringLiteral::BreakableStringLiteral ( const FormatToken Tok,
unsigned  StartColumn,
StringRef  Prefix,
StringRef  Postfix,
unsigned  UnbreakableTailLength,
bool  InPPDirective,
encoding::Encoding  Encoding,
const FormatStyle Style 
)

Creates a breakable token for a single line string literal.

StartColumn specifies the column in which the token will start after formatting.

Definition at line 265 of file BreakableToken.cpp.

Member Function Documentation

◆ compressWhitespace()

void clang::format::BreakableStringLiteral::compressWhitespace ( unsigned  LineIndex,
unsigned  TailOffset,
Split  Split,
WhitespaceManager Whitespaces 
) const
inlineoverridevirtual

Replaces the whitespace range described by Split with a single space.

Implements clang::format::BreakableToken.

Definition at line 262 of file BreakableToken.h.

◆ getContentStartColumn()

unsigned clang::format::BreakableStringLiteral::getContentStartColumn ( unsigned  LineIndex,
bool  Break 
) const
overridevirtual

Returns the column at which content in line LineIndex starts, assuming no reflow.

If Break is true, returns the column at which the line should start after the line break. If Break is false, returns the column at which the line itself will start.

Implements clang::format::BreakableToken.

Definition at line 260 of file BreakableToken.cpp.

References Prefix, and StartColumn.

◆ getLineCount()

unsigned clang::format::BreakableStringLiteral::getLineCount ( ) const
overridevirtual

Returns the number of lines in this token in the original code.

Implements clang::format::BreakableToken.

Definition at line 242 of file BreakableToken.cpp.

◆ getRangeLength()

unsigned clang::format::BreakableStringLiteral::getRangeLength ( unsigned  LineIndex,
unsigned  Offset,
StringRef::size_type  Length,
unsigned  StartColumn 
) const
overridevirtual

Returns the number of columns required to format the text in the byte range [Offset, Offset + Length).

Offset is the byte offset from the start of the content of the line at LineIndex.

StartColumn is the column at which the text starts in the formatted file, needed to compute tab stops correctly.

Implements clang::format::BreakableToken.

Definition at line 244 of file BreakableToken.cpp.

◆ getRemainingLength()

unsigned clang::format::BreakableStringLiteral::getRemainingLength ( unsigned  LineIndex,
unsigned  Offset,
unsigned  StartColumn 
) const
overridevirtual

Returns the number of columns required to format the text following the byte Offset in the line LineIndex, including potentially unbreakable sequences of tokens following after the end of the token.

Offset is the byte offset from the start of the content of the line at LineIndex.

StartColumn is the column at which the text starts in the formatted file, needed to compute tab stops correctly.

For breakable tokens that never use extra space at the end of a line, this is equivalent to getRangeLength with a Length of StringRef::npos.

Reimplemented from clang::format::BreakableToken.

Definition at line 253 of file BreakableToken.cpp.

References clang::format::encoding::columnWidthWithTabs(), clang::format::BreakableToken::Encoding, Line, Offset, Postfix, StartColumn, clang::format::BreakableToken::Style, clang::format::FormatStyle::TabWidth, and UnbreakableTailLength.

◆ getSplit()

BreakableToken::Split clang::format::BreakableStringLiteral::getSplit ( unsigned  LineIndex,
unsigned  TailOffset,
unsigned  ColumnLimit,
unsigned  ContentStartColumn,
const llvm::Regex &  CommentPragmasRegex 
) const
overridevirtual

Returns a range (offset, length) at which to break the line at LineIndex, if previously broken at TailOffset.

If possible, do not violate ColumnLimit, assuming the text starting at TailOffset in the token is formatted starting at ContentStartColumn in the reformatted file.

Implements clang::format::BreakableToken.

Definition at line 277 of file BreakableToken.cpp.

References clang::format::BreakableToken::Encoding, clang::format::getStringSplit(), Line, Postfix, clang::format::BreakableToken::Style, and clang::format::FormatStyle::TabWidth.

◆ insertBreak()

void clang::format::BreakableStringLiteral::insertBreak ( unsigned  LineIndex,
unsigned  TailOffset,
Split  Split,
unsigned  ContentIndent,
WhitespaceManager Whitespaces 
) const
overridevirtual

Emits the previously retrieved Split via Whitespaces.

Implements clang::format::BreakableToken.

Definition at line 284 of file BreakableToken.cpp.

Member Data Documentation

◆ Line

StringRef clang::format::BreakableStringLiteral::Line
protected

Definition at line 280 of file BreakableToken.h.

Referenced by getRemainingLength(), and getSplit().

◆ Postfix

StringRef clang::format::BreakableStringLiteral::Postfix
protected

Definition at line 278 of file BreakableToken.h.

Referenced by getRemainingLength(), and getSplit().

◆ Prefix

StringRef clang::format::BreakableStringLiteral::Prefix
protected

Definition at line 276 of file BreakableToken.h.

Referenced by getContentStartColumn().

◆ StartColumn

unsigned clang::format::BreakableStringLiteral::StartColumn
protected

Definition at line 274 of file BreakableToken.h.

Referenced by getContentStartColumn(), and getRemainingLength().

◆ UnbreakableTailLength

unsigned clang::format::BreakableStringLiteral::UnbreakableTailLength
protected

Definition at line 283 of file BreakableToken.h.

Referenced by getRemainingLength().


The documentation for this class was generated from the following files: