Namespaces
namespace	encoding
namespace	internal

Classes
class	AffectedRangeManager
class	AnnotatedLine
class	BreakableBlockComment
class	BreakableComment
class	BreakableLineCommentSection
class	BreakableStringLiteral
class	BreakableStringLiteralUsingOperators
class	BreakableToken
	Base class for tokens / ranges of tokens that can allow breaking within the tokens - for example, to avoid whitespace beyond the column limit, or to reflow text. More...
class	CompoundStatementIndenter
class	ContinuationIndenter
class	DefinitionBlockSeparator
class	Environment
class	FatalDiagnosticConsumer
struct	FormatStyle
	The FormatStyle is used to configure the formatting to follow specific guidelines. More...
struct	FormattingAttemptStatus
	Represents the status of a formatting attempt. More...
struct	FormatToken
	A wrapper around a `Token` storing information about the whitespace characters preceding it. More...
class	FormatTokenLexer
class	FormatTokenSource
struct	IndentationAndAlignment
	Represents the spaces at the start of a line, keeping track of what the spaces are for. More...
class	IndexedTokenSource
class	IntegerLiteralSeparatorFixer
class	JavaScriptImportSorter
struct	JsImportedSymbol
struct	JsModuleReference
class	LeftRightQualifierAlignmentFixer
struct	LineState
	The current state when indenting a unwrapped line. More...
class	MacroCallReconstructor
	Converts a sequence of UnwrappedLines containing expanded macros into a single UnwrappedLine containing the macro calls. More...
class	MacroExpander
	Takes a set of macro definitions as strings and allows expanding calls to those macros. More...
struct	MacroExpansion
	Contains information on the token's role in a macro expansion. More...
class	NamespaceEndCommentsFixer
class	NumericLiteralCaseFixer
struct	NumericLiteralInfo
class	ObjCPropertyAttributeOrderFixer
struct	ObjCPropertyEntry
struct	ParenState
class	ParseErrorCategory
struct	RawStringFormatStyleManager
class	ScopedLineState
class	ScopedMacroState
class	TokenAnalyzer
class	TokenAnnotator
	Determines extra information about the tokens comprising an `UnwrappedLine`. More...
struct	UnwrappedLine
	An unwrapped line is a sequence of `Token`, that we would like to put on a single line if there was no column limit. More...
class	UnwrappedLineConsumer
	Interface for users of the UnwrappedLineParser to receive the parsed lines. More...
class	UnwrappedLineFormatter
struct	UnwrappedLineNode
class	UnwrappedLineParser
class	UsingDeclarationsSorter
class	WhitespaceManager
	Manages the whitespaces around tokens and their replacements. More...

Typedefs
typedef std::function< std::pair< tooling::Replacements, unsigned >(const Environment &)>	AnalyzerPass

Enumerations
enum class	ParseError { Success = 0 , Error , Unsuitable , BinPackTrailingCommaConflict , InvalidQualifierSpecified , DuplicateQualifierSpecified , MissingQualifierType , MissingQualifierOrder }
enum	TokenType : uint8_t { NUM_TOKEN_TYPES }
	Determines the semantic type of a syntactic token, e.g. More...
enum	BraceBlockKind { BK_Unknown , BK_Block , BK_BracedInit }
enum	ParameterPackingKind { PPK_BinPacked , PPK_OnePerLine , PPK_Inconclusive }
enum	FormatDecision { FD_Unformatted , FD_Continue , FD_Break }
enum	MacroRole { MR_ExpandedArg , MR_UnexpandedArg , MR_Hidden }
	Roles a token can take in a configured macro expansion. More...
enum	LexerState { NORMAL , TEMPLATE_STRING , TOKEN_STASHED }
enum class	Base { Binary , Decimal , Hex , Other }
enum	LineType { LT_Invalid , LT_AccessModifier , LT_ImportStatement , LT_ObjCDecl , LT_ObjCMethodDecl , LT_ObjCProperty , LT_Other , LT_PreprocessorDirective , LT_VirtualFunctionDecl , LT_ArrayOfStructInitializer , LT_CommentAbovePPDirective , LT_RequiresExpression , LT_SimpleRequirement }
enum	ScopeType { ST_Class , ST_Enum , ST_CompoundRequirement , ST_Other }

Functions
const std::error_category &	getParseCategory ()
std::error_code	make_error_code (ParseError e)
FormatStyle	getLLVMStyle (FormatStyle::LanguageKind Language=FormatStyle::LK_Cpp)
	Returns a format style complying with the LLVM coding standards: http://llvm.org/docs/CodingStandards.html.
FormatStyle	getGoogleStyle (FormatStyle::LanguageKind Language)
	Returns a format style complying with one of Google's style guides: http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml.
FormatStyle	getChromiumStyle (FormatStyle::LanguageKind Language)
	Returns a format style complying with Chromium's style guide: http://www.chromium.org/developers/coding-style.
FormatStyle	getMozillaStyle ()
	Returns a format style complying with Mozilla's style guide: https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html.
FormatStyle	getWebKitStyle ()
	Returns a format style complying with Webkit's style guide: http://www.webkit.org/coding/coding-style.html.
FormatStyle	getGNUStyle ()
	Returns a format style complying with GNU Coding Standards: http://www.gnu.org/prep/standards/standards.html.
FormatStyle	getMicrosoftStyle (FormatStyle::LanguageKind Language)
	Returns a format style complying with Microsoft style guide: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017.
FormatStyle	getClangFormatStyle ()
FormatStyle	getNoStyle ()
	Returns style indicating formatting should be not applied at all.
bool	getPredefinedStyle (StringRef Name, FormatStyle::LanguageKind Language, FormatStyle *Style)
	Gets a predefined style for the specified language by name.
std::error_code	parseConfiguration (llvm::MemoryBufferRef Config, FormatStyle Style, bool AllowUnknownOptions=false, llvm::SourceMgr::DiagHandlerTy DiagHandler=nullptr, void DiagHandlerCtx=nullptr, bool IsDotHFile=false)
	Parse configuration from YAML-formatted text.
std::error_code	parseConfiguration (StringRef Config, FormatStyle *Style, bool AllowUnknownOptions=false, bool IsDotHFile=false)
	Like above but accepts an unnamed buffer.
std::string	configurationAsText (const FormatStyle &Style)
	Gets configuration in a YAML string.
tooling::Replacements	sortIncludes (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName, unsigned *Cursor=nullptr)
	Returns the replacements necessary to sort all #include blocks that are affected by Ranges.
Expected< tooling::Replacements >	formatReplacements (StringRef Code, const tooling::Replacements &Replaces, const FormatStyle &Style)
	Returns the replacements corresponding to applying and formatting `Replaces` on success; otheriwse, return an llvm::Error carrying llvm::StringError.
Expected< tooling::Replacements >	cleanupAroundReplacements (StringRef Code, const tooling::Replacements &Replaces, const FormatStyle &Style)
	Returns the replacements corresponding to applying `Replaces` and cleaning up the code after that on success; otherwise, return an llvm::Error carrying llvm::StringError.
tooling::Replacements	reformat (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>", FormattingAttemptStatus *Status=nullptr)
	Reformats the given `Ranges` in `Code`.
tooling::Replacements	reformat (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName, bool *IncompleteFormat)
	Same as above, except if IncompleteFormat is non-null, its value will be set to true if any of the affected ranges were not formatted due to a non-recoverable syntax error.
tooling::Replacements	cleanup (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
	Clean up any erroneous/redundant code in the given `Ranges` in `Code`.
tooling::Replacements	fixNamespaceEndComments (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
	Fix namespace end comments in the given `Ranges` in `Code`.
tooling::Replacements	separateDefinitionBlocks (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
	Inserts or removes empty lines separating definition blocks including classes, structs, functions, namespaces, and enums in the given `Ranges` in `Code`.
tooling::Replacements	sortUsingDeclarations (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
	Sort consecutive using declarations in the given `Ranges` in `Code`.
LangOptions	getFormattingLangOpts (const FormatStyle &Style=getLLVMStyle())
	Returns the LangOpts that the formatter expects you to set.
Expected< FormatStyle >	getStyle (StringRef StyleName, StringRef FileName, StringRef FallbackStyle, StringRef Code="", llvm::vfs::FileSystem *FS=nullptr, bool AllowUnknownOptions=false, llvm::SourceMgr::DiagHandlerTy DiagHandler=nullptr)
	Construct a FormatStyle based on StyleName.
FormatStyle::LanguageKind	guessLanguage (StringRef FileName, StringRef Code)
StringRef	getLanguageName (FormatStyle::LanguageKind Language)
bool	isClangFormatOn (StringRef Comment)
bool	isClangFormatOff (StringRef Comment)
static constexpr StringRef	Blanks (" \t\v\f\r")
static StringRef	getLineCommentIndentPrefix (StringRef Comment, const FormatStyle &Style)
static BreakableToken::Split	getCommentSplit (StringRef Text, unsigned ContentStartColumn, unsigned ColumnLimit, unsigned TabWidth, encoding::Encoding Encoding, const FormatStyle &Style, bool DecorationEndsWithStar=false)
static BreakableToken::Split	getStringSplit (StringRef Text, unsigned UsedColumns, unsigned ColumnLimit, unsigned TabWidth, encoding::Encoding Encoding)
bool	switchesFormatting (const FormatToken &Token)
	Checks if `Token` switches formatting, like /* clang-format off *‍/.
static bool	mayReflowContent (StringRef Content)
static bool	shouldIndentWrappedSelectorName (const FormatStyle &Style, LineType LineType)
static bool	shouldUnindentNextOperator (const FormatToken &Tok)
static unsigned	getLengthToMatchingParen (const FormatToken &Tok, ArrayRef< ParenState > Stack)
static unsigned	getLengthToNextOperator (const FormatToken &Tok)
static bool	startsSegmentOfBuilderTypeCall (const FormatToken &Tok)
static bool	isAlignableBinaryOperator (const FormatToken &Token)
static bool	startsNextOperand (const FormatToken &Current)
static unsigned	getChainLength (const FormatToken &Op)
static bool	mustBreakBinaryOperation (const FormatToken &Current, const FormatStyle &Style)
static bool	opensProtoMessageField (const FormatToken &LessTok, const FormatStyle &Style)
static std::optional< StringRef >	getRawStringDelimiter (StringRef TokenText)
static StringRef	getCanonicalRawStringDelimiter (const FormatStyle &Style, FormatStyle::LanguageKind Language)
static bool	hasNestedBlockInlined (const FormatToken *Previous, const FormatToken &Current, const FormatStyle &Style)
static unsigned	getLastLineEndColumn (StringRef Text, unsigned StartColumn, unsigned TabWidth, encoding::Encoding Encoding)
static StringRef	getEnclosingFunctionName (const FormatToken &Current)
llvm::Error	make_string_error (const Twine &Message)
static void	expandPresetsBraceWrapping (FormatStyle &Expanded)
static void	expandPresetsSpaceBeforeParens (FormatStyle &Expanded)
static void	expandPresetsSpacesInParens (FormatStyle &Expanded)
ParseError	validateQualifierOrder (FormatStyle *Style)
static bool	affectsRange (ArrayRef< tooling::Range > Ranges, unsigned Start, unsigned End)
static std::pair< unsigned, unsigned >	FindCursorIndex (const ArrayRef< IncludeDirective > &Includes, const ArrayRef< unsigned > &Indices, unsigned Cursor)
std::string	replaceCRLF (const std::string &Code)
static void	sortCppIncludes (const FormatStyle &Style, const ArrayRef< IncludeDirective > &Includes, ArrayRef< tooling::Range > Ranges, StringRef FileName, StringRef Code, tooling::Replacements &Replaces, unsigned *Cursor)
tooling::Replacements	sortCppIncludes (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName, tooling::Replacements &Replaces, unsigned *Cursor)
static unsigned	findJavaImportGroup (const FormatStyle &Style, StringRef ImportIdentifier)
static void	sortJavaImports (const FormatStyle &Style, const ArrayRef< JavaImportDirective > &Imports, ArrayRef< tooling::Range > Ranges, StringRef FileName, StringRef Code, tooling::Replacements &Replaces)
tooling::Replacements	sortJavaImports (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName, tooling::Replacements &Replaces)
bool	isMpegTS (StringRef Code)
bool	isLikelyXml (StringRef Code)
template<typename T>
static Expected< tooling::Replacements >	processReplacements (T ProcessFunc, StringRef Code, const tooling::Replacements &Replaces, const FormatStyle &Style)
static FormatStyle::LanguageKind	getLanguageByFileName (StringRef &FileName)
static FormatStyle::LanguageKind	getLanguageByComment (const Environment &Env)
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > >	loadAndParseConfigFile (StringRef ConfigFile, llvm::vfs::FileSystem FS, FormatStyle Style, bool AllowUnknownOptions, llvm::SourceMgr::DiagHandlerTy DiagHandler, bool IsDotHFile)
static bool	isClangFormatOnOff (StringRef Comment, bool On)
const char *	getTokenTypeName (TokenType Type)
	Determines the name of a token type.
static unsigned	CodePointsBetween (const FormatToken Begin, const FormatToken End)
bool	startsNextParameter (const FormatToken &Current, const FormatStyle &Style)
struct clang::format::FormatToken	getPrevious (T A1) const
template<typename... Ts>
FormatToken *	getPreviousOneOf (Ts... Ks) const
FormatToken *	getPreviousNonComment () const
	Returns the previous token ignoring comments.
FormatToken *	getNextNonComment () const
	Returns the next token ignoring comments.
bool	isPossibleMacro (bool AllowFollowingColonColon=false) const
	Returns `true` if this token likely names an object-like macro.
bool	isBlockIndentedInitRBrace (const FormatStyle &Style) const
	Returns `true` if this token ends a block indented initializer list.
bool	opensBlockOrBlockTypeList (const FormatStyle &Style) const
	Returns `true` if this tokens starts a block-type list, i.e. a list that should be indented with a block indent.
bool	isCppStructuredBinding (bool IsCpp) const
	Returns whether the token is the left square bracket of a C++ structured binding declaration.
bool	closesBlockOrBlockTypeList (const FormatStyle &Style) const
	Same as opensBlockOrBlockTypeList, but for the closing token.
const FormatToken *	getNamespaceToken () const
	Return the actual namespace token, if this token starts a namespace block.
void	copyFrom (const FormatToken &Tok)
static auto	lexCSharpString (const char Begin, const char End, bool Verbatim, bool Interpolated)
static size_t	countLeadingWhitespace (StringRef Text)
	Count the length of leading whitespace in a token.
static Base	getBase (StringRef IntegerLiteral)
template<typename T>
void	forEachToken (const UnwrappedLine &Line, const T &Call, FormatToken *Parent=nullptr)
bool	matchFilePath (StringRef Pattern, StringRef FilePath)
bool	matchFilePath (llvm::StringRef Pattern, llvm::StringRef FilePath)
const FormatToken *	getNamespaceToken (const AnnotatedLine Line, const SmallVectorImpl< AnnotatedLine > &AnnotatedLines)
StringRef	getNamespaceTokenText (const AnnotatedLine Line, const SmallVectorImpl< AnnotatedLine > &AnnotatedLines)
static bool	isNumericLiteralCaseFixerNeeded (const FormatStyle &Style)
static std::string	transformComponent (StringRef Component, FormatStyle::NumericLiteralComponentStyle ConfigValue)
static bool	matchesReservedSuffix (StringRef Suffix)
	Test if Suffix matches a C++ literal reserved by the library.
static std::string	format (StringRef NumericLiteral, const FormatStyle &Style)
void	addQualifierAlignmentFixerPasses (const FormatStyle &Style, SmallVectorImpl< AnalyzerPass > &Passes)
static void	replaceToken (const SourceManager &SourceMgr, tooling::Replacements &Fixes, const CharSourceRange &Range, std::string NewText)
static void	removeToken (const SourceManager &SourceMgr, tooling::Replacements &Fixes, const FormatToken *First)
static void	insertQualifierAfter (const SourceManager &SourceMgr, tooling::Replacements &Fixes, const FormatToken *First, const std::string &Qualifier)
static void	insertQualifierBefore (const SourceManager &SourceMgr, tooling::Replacements &Fixes, const FormatToken *First, const std::string &Qualifier)
static bool	endsWithSpace (const std::string &s)
static bool	startsWithSpace (const std::string &s)
static void	rotateTokens (const SourceManager &SourceMgr, tooling::Replacements &Fixes, const FormatToken First, const FormatToken Last, bool Left)
static bool	isConfiguredQualifier (const FormatToken *const Tok, const std::vector< tok::TokenKind > &Qualifiers)
static bool	isQualifier (const FormatToken *const Tok)
void	prepareLeftRightOrderingForQualifierAlignmentFixer (const std::vector< std::string > &Order, std::vector< std::string > &LeftOrder, std::vector< std::string > &RightOrder, std::vector< tok::TokenKind > &Qualifiers)
bool	isQualifierOrType (const FormatToken *Tok, const LangOptions &LangOpts)
bool	isConfiguredQualifierOrType (const FormatToken *Tok, const std::vector< tok::TokenKind > &Qualifiers, const LangOptions &LangOpts)
bool	operator< (const JsModuleReference &LHS, const JsModuleReference &RHS)
tooling::Replacements	sortJavaScriptImports (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName)
static bool	mustBreakAfterAttributes (const FormatToken &Tok, const FormatStyle &Style)
static unsigned	maxNestingDepth (const AnnotatedLine &Line)
static FormatToken *	skipNameQualifier (const FormatToken *Tok)
static FormatToken *	getFunctionName (const AnnotatedLine &Line, FormatToken *&OpeningParen)
static bool	isCtorOrDtorName (const FormatToken *Tok)
static bool	isFunctionDeclarationName (const LangOptions &LangOpts, const FormatToken &Current, const AnnotatedLine &Line, FormatToken *&ClosingParen)
static FormatToken *	findReturnTypeStart (const AnnotatedLine &Line)
static bool	isAllmanBrace (const FormatToken &Tok)
static bool	IsFunctionArgument (const FormatToken &Tok)
static bool	isEmptyLambdaAllowed (const FormatToken &Tok, FormatStyle::ShortLambdaStyle ShortLambdaOption)
static bool	isAllmanLambdaBrace (const FormatToken &Tok)
static auto	computeNewlines (const AnnotatedLine &Line, const AnnotatedLine PreviousLine, const AnnotatedLine PrevPrevLine, const SmallVectorImpl< AnnotatedLine * > &Lines, const FormatStyle &Style)
std::ostream &	operator<< (std::ostream &Stream, const UnwrappedLine &Line)
template<class T>
static void	hash_combine (std::size_t &seed, const T &v)
static bool	isGoogScope (const UnwrappedLine &Line)
static bool	isIIFE (const UnwrappedLine &Line, const AdditionalKeywords &Keywords)
static bool	ShouldBreakBeforeBrace (const FormatStyle &Style, const FormatToken &InitialToken, bool IsEmptyBlock, bool IsJavaRecord=false)
static bool	tokenCanStartNewLine (const FormatToken &Tok)
static bool	mustBeJSIdent (const AdditionalKeywords &Keywords, const FormatToken *FormatTok)
static bool	mustBeJSIdentOrValue (const AdditionalKeywords &Keywords, const FormatToken *FormatTok)
static bool	isJSDeclOrStmt (const AdditionalKeywords &Keywords, const FormatToken *FormatTok)
static bool	isC78Type (const FormatToken &Tok)
static bool	isC78ParameterDecl (const FormatToken Tok, const FormatToken Next, const FormatToken *FuncName)
static FormatToken *	getLastNonComment (const UnwrappedLine &Line)
static void	markOptionalBraces (FormatToken *LeftBrace)
static bool	continuesLineCommentSection (const FormatToken &FormatTok, const UnwrappedLine &Line, const FormatStyle &Style, const llvm::Regex &CommentPragmasRegex)
static const FormatToken &	getLineStart (const FormatToken &Tok)
static unsigned	indentLevelFor (const WhitespaceManager::Change &C)
static void	SetChangeSpaces (unsigned Start, unsigned Spaces, MutableArrayRef< WhitespaceManager::Change > Changes)
static void	IncrementChangeSpaces (unsigned Start, int Delta, MutableArrayRef< WhitespaceManager::Change > Changes)
static void	AlignTokenSequence (const FormatStyle &Style, unsigned Start, unsigned End, unsigned Column, bool RightJustify, ArrayRef< unsigned > Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes)
template<typename F, AlignStrategy Strategy = AlignStrategy::Normal>
static unsigned	AlignTokens (const FormatStyle &Style, F &&Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes, unsigned StartAt, const FormatStyle::AlignConsecutiveStyle &ACS={}, bool RightJustify=false)

Variables
const char *	StyleOptionHelpDescription
	Description to be used for help text for a llvm::cl option for specifying format style.
const char *	DefaultFormatStyle = "file"
	The suggested format style to use by default.
const char *	DefaultFallbackStyle = "LLVM"
	The suggested predefined style to use as the fallback style in getStyle.
static constexpr std::array< StringRef, 16 >	QtPropertyKeywords
static constexpr std::array< StringRef, 14 >	CppNonKeywordTypes

Typedef Documentation

◆ AnalyzerPass

typedef std::function<std::pair<tooling::Replacements, unsigned>( const Environment &)> clang::format::AnalyzerPass

Definition at line 25 of file QualifierAlignmentFixer.h.

Enumeration Type Documentation

◆ Base

enum class clang::format::Base

strong

Enumerator
Binary
Decimal
Hex
Other

Definition at line 20 of file IntegerLiteralSeparatorFixer.cpp.

◆ BraceBlockKind

enum clang::format::BraceBlockKind

Enumerator
BK_Unknown
BK_Block
BK_BracedInit

Definition at line 238 of file FormatToken.h.

◆ FormatDecision

enum clang::format::FormatDecision

Enumerator
FD_Unformatted
FD_Continue
FD_Break

Definition at line 243 of file FormatToken.h.

◆ LexerState

enum clang::format::LexerState

Enumerator
NORMAL
TEMPLATE_STRING
TOKEN_STASHED

Definition at line 29 of file FormatTokenLexer.h.

◆ LineType

enum clang::format::LineType

Enumerator
LT_Invalid
LT_AccessModifier
LT_ImportStatement
LT_ObjCDecl
LT_ObjCMethodDecl
LT_ObjCProperty
LT_Other
LT_PreprocessorDirective
LT_VirtualFunctionDecl
LT_ArrayOfStructInitializer
LT_CommentAbovePPDirective
LT_RequiresExpression
LT_SimpleRequirement

Definition at line 23 of file TokenAnnotator.h.

◆ MacroRole

enum clang::format::MacroRole

Roles a token can take in a configured macro expansion.

Enumerator
MR_ExpandedArg	The token was expanded from a macro argument when formatting the expanded token sequence.
MR_UnexpandedArg	The token is part of a macro argument that was previously formatted as expansion when formatting the unexpanded macro call.
MR_Hidden	The token was expanded from a macro definition, and is not visible as part of the macro call.

Definition at line 246 of file FormatToken.h.

◆ ParameterPackingKind

enum clang::format::ParameterPackingKind

Enumerator
PPK_BinPacked
PPK_OnePerLine
PPK_Inconclusive

Definition at line 241 of file FormatToken.h.

◆ ParseError

enum class clang::format::ParseError

strong

Enumerator
Success
Error
Unsuitable
BinPackTrailingCommaConflict
InvalidQualifierSpecified
DuplicateQualifierSpecified
MissingQualifierType
MissingQualifierOrder

Definition at line 36 of file Format.h.

◆ ScopeType

enum clang::format::ScopeType

Enumerator
ST_Class
ST_Enum
ST_CompoundRequirement
ST_Other

Definition at line 40 of file TokenAnnotator.h.

◆ TokenType

enum clang::format::TokenType : uint8_t

Determines the semantic type of a syntactic token, e.g.

whether "<" is a template opener or binary operator.

Enumerator
NUM_TOKEN_TYPES

Definition at line 227 of file FormatToken.h.

Function Documentation

◆ addQualifierAlignmentFixerPasses()

void clang::format::addQualifierAlignmentFixerPasses	(	const FormatStyle &	Style,
		SmallVectorImpl< AnalyzerPass > &	Passes )

Definition at line 25 of file QualifierAlignmentFixer.cpp.

References prepareLeftRightOrderingForQualifierAlignmentFixer(), and clang::format::TokenAnalyzer::process().

Referenced by clang::format::internal::reformat().

◆ affectsRange()

bool clang::format::affectsRange	(	ArrayRef< tooling::Range >	Ranges,
		unsigned	Start,
		unsigned	End )

static

Definition at line 3571 of file Format.cpp.

Referenced by sortCppIncludes(), and sortJavaImports().

◆ AlignTokens()

template<typename F, AlignStrategy Strategy = AlignStrategy::Normal>

unsigned clang::format::AlignTokens	(	const FormatStyle &	Style,
		F &&	Matches,
		SmallVector< WhitespaceManager::Change, 16 > &	Changes,
		unsigned	StartAt,
		const FormatStyle::AlignConsecutiveStyle &	ACS = {},
		bool	RightJustify = false )

static

Definition at line 506 of file WhitespaceManager.cpp.

◆ AlignTokenSequence()

void clang::format::AlignTokenSequence	(	const FormatStyle &	Style,
		unsigned	Start,
		unsigned	End,
		unsigned	Column,
		bool	RightJustify,
		ArrayRef< unsigned >	Matches,
		SmallVector< WhitespaceManager::Change, 16 > &	Changes )

static

Definition at line 346 of file WhitespaceManager.cpp.

References clang::Column, IncrementChangeSpaces(), NewlinesBefore, clang::format::FormatStyle::PAS_Right, Previous, clang::format::FormatStyle::RAS_Pointer, clang::format::FormatStyle::RAS_Right, and Tok.

◆ Blanks()

constexpr StringRef clang::format::Blanks ( " \t\v\f\r" )

staticconstexpr

◆ cleanup()

tooling::Replacements clang::format::cleanup	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName = "<stdin>" )

Clean up any erroneous/redundant code in the given Ranges in Code.

Returns the Replacements that clean up all Ranges in Code.

Definition at line 4468 of file Format.cpp.

References clang::FileName, clang::format::FormatStyle::LK_Cpp, and clang::format::Environment::make().

Referenced by cleanupAroundReplacements().

◆ cleanupAroundReplacements()

Expected< tooling::Replacements > clang::format::cleanupAroundReplacements	(	StringRef	Code,
		const tooling::Replacements &	Replaces,
		const FormatStyle &	Style )

Returns the replacements corresponding to applying Replaces and cleaning up the code after that on success; otherwise, return an llvm::Error carrying llvm::StringError.

This also supports inserting/deleting C++ #include directives:

If a replacement has offset UINT_MAX, length 0, and a replacement text that is an #include directive, this will insert the #include into the correct block in the Code.
If a replacement has offset UINT_MAX, length 1, and a replacement text that is the name of the header to be removed, the header will be removed from Code if it exists. The include manipulation is done via tooling::HeaderInclude, see its documentation for more details on how include insertion points are found and what edits are produced.

Definition at line 4235 of file Format.cpp.

References cleanup(), clang::FileName, and processReplacements().

Referenced by clang::tooling::applyAtomicChanges().

◆ closesBlockOrBlockTypeList()

bool clang::format::closesBlockOrBlockTypeList ( const FormatStyle & Style ) const

Same as opensBlockOrBlockTypeList, but for the closing token.

Definition at line 941 of file FormatToken.h.

References clang::format::FormatToken::isNot().

◆ CodePointsBetween()

unsigned clang::format::CodePointsBetween	(	const FormatToken *	Begin,
		const FormatToken *	End )

static

Definition at line 172 of file FormatToken.cpp.

References clang::format::FormatToken::ColumnWidth, and clang::format::FormatToken::TotalLength.

Referenced by clang::CommaSeparatedList::precomputeFormattingInfos().

◆ computeNewlines()

auto clang::format::computeNewlines	(	const AnnotatedLine &	Line,
		const AnnotatedLine *	PreviousLine,
		const AnnotatedLine *	PrevPrevLine,
		const SmallVectorImpl< AnnotatedLine * > &	Lines,
		const FormatStyle &	Style )

static

Definition at line 1630 of file UnwrappedLineFormatter.cpp.

◆ configurationAsText()

std::string clang::format::configurationAsText ( const FormatStyle & Style )

Gets configuration in a YAML string.

Definition at line 2588 of file Format.cpp.

References expandPresetsBraceWrapping(), expandPresetsSpaceBeforeParens(), expandPresetsSpacesInParens(), and clang::Text.

◆ continuesLineCommentSection()

bool clang::format::continuesLineCommentSection	(	const FormatToken &	FormatTok,
		const UnwrappedLine &	Line,
		const FormatStyle &	Style,
		const llvm::Regex &	CommentPragmasRegex )

static

Definition at line 4789 of file UnwrappedLineParser.cpp.

References clang::continuesLineComment(), continuesLineCommentSection(), clang::format::FormatToken::is(), clang::isLineComment(), clang::Line, clang::format::FormatToken::NewlinesBefore, clang::format::FormatStyle::RCS_Always, clang::format::UnwrappedLineNode::Tok, and clang::format::FormatToken::TokenText.

Referenced by continuesLineCommentSection().

◆ copyFrom()

void clang::format::copyFrom ( const FormatToken & Tok )

Definition at line 962 of file FormatToken.h.

References clang::format::FormatToken::is(), and clang::format::FormatToken::isOneOf().

◆ countLeadingWhitespace()

size_t clang::format::countLeadingWhitespace ( StringRef Text )

static

Count the length of leading whitespace in a token.

Definition at line 1226 of file FormatTokenLexer.cpp.

References clang::isHorizontalWhitespace(), clang::isVerticalWhitespace(), clang::isWhitespace(), and clang::Text.

◆ endsWithSpace()

bool clang::format::endsWithSpace ( const std::string & s )

static

Definition at line 100 of file QualifierAlignmentFixer.cpp.

Referenced by rotateTokens().

◆ expandPresetsBraceWrapping()

void clang::format::expandPresetsBraceWrapping ( FormatStyle & Expanded )

static

Definition at line 1715 of file Format.cpp.

Referenced by configurationAsText(), and clang::format::internal::reformat().

◆ expandPresetsSpaceBeforeParens()

void clang::format::expandPresetsSpaceBeforeParens ( FormatStyle & Expanded )

static

Definition at line 1815 of file Format.cpp.

Referenced by configurationAsText(), and clang::format::internal::reformat().

◆ expandPresetsSpacesInParens()

void clang::format::expandPresetsSpacesInParens ( FormatStyle & Expanded )

static

Definition at line 1839 of file Format.cpp.

References clang::format::FormatStyle::SIPO_Custom, clang::format::FormatStyle::SIPO_Never, clang::format::FormatStyle::SpacesInParens, and clang::format::FormatStyle::SpacesInParensOptions.

Referenced by configurationAsText(), and clang::format::internal::reformat().

◆ FindCursorIndex()

std::pair< unsigned, unsigned > clang::format::FindCursorIndex	(	const ArrayRef< IncludeDirective > &	Includes,
		const ArrayRef< unsigned > &	Indices,
		unsigned	Cursor )

static

Definition at line 3591 of file Format.cpp.

References clang::Text.

Referenced by sortCppIncludes().

◆ findJavaImportGroup()

unsigned clang::format::findJavaImportGroup	(	const FormatStyle &	Style,
		StringRef	ImportIdentifier )

static

Definition at line 3899 of file Format.cpp.

Referenced by sortJavaImports().

◆ findReturnTypeStart()

FormatToken * clang::format::findReturnTypeStart ( const AnnotatedLine & Line )

static

Definition at line 4102 of file TokenAnnotator.cpp.

References clang::isReturnTypePrefixSpecifier(), clang::Line, Next, and Tok.

Referenced by clang::format::TokenAnnotator::calculateFormattingInformation().

◆ fixNamespaceEndComments()

tooling::Replacements clang::format::fixNamespaceEndComments	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName = "<stdin>" )

Fix namespace end comments in the given Ranges in Code.

Returns the Replacements that fix the namespace comments in all Ranges in Code.

Definition at line 4490 of file Format.cpp.

References clang::FileName, clang::format::Environment::make(), and clang::format::TokenAnalyzer::process().

◆ forEachToken()

template<typename T>

void clang::format::forEachToken	(	const UnwrappedLine &	Line,
		const T &	Call,
		FormatToken *	Parent = nullptr )

Definition at line 32 of file MacroCallReconstructor.cpp.

References clang::Call, clang::First, forEachToken(), clang::Line, and clang::T.

Referenced by clang::format::MacroCallReconstructor::addLine(), and forEachToken().

◆ format()

std::string clang::format::format	(	StringRef	NumericLiteral,
		const FormatStyle &	Style )

static

Definition at line 78 of file NumericLiteralCaseFixer.cpp.

References clang::format::NumericLiteralInfo::BaseLetterPos, clang::format::NumericLiteralInfo::ExponentLetterPos, format(), matchesReservedSuffix(), clang::format::NumericLiteralInfo::SuffixPos, and transformComponent().

Referenced by format(), and clang::format::NumericLiteralCaseFixer::process().

◆ formatReplacements()

Expected< tooling::Replacements > clang::format::formatReplacements	(	StringRef	Code,
		const tooling::Replacements &	Replaces,
		const FormatStyle &	Style )

Returns the replacements corresponding to applying and formatting Replaces on success; otheriwse, return an llvm::Error carrying llvm::StringError.

Definition at line 4123 of file Format.cpp.

References clang::FileName, processReplacements(), reformat(), clang::format::FormatStyle::SortIncludes, and sortIncludes().

Referenced by clang::tooling::formatAndApplyAllReplacements().

◆ getBase()

Base clang::format::getBase ( StringRef IntegerLiteral )

static

Definition at line 22 of file IntegerLiteralSeparatorFixer.cpp.

References Binary, Decimal, Hex, and Other.

Referenced by clang::format::IntegerLiteralSeparatorFixer::process().

◆ getCanonicalRawStringDelimiter()

StringRef clang::format::getCanonicalRawStringDelimiter	(	const FormatStyle &	Style,
		FormatStyle::LanguageKind	Language )

static

Definition at line 230 of file ContinuationIndenter.cpp.

◆ getChainLength()

unsigned clang::format::getChainLength ( const FormatToken & Op )

static

Definition at line 149 of file ContinuationIndenter.cpp.

References clang::Last.

Referenced by mustBreakBinaryOperation().

◆ getChromiumStyle()

FormatStyle clang::format::getChromiumStyle ( FormatStyle::LanguageKind Language )

Returns a format style complying with Chromium's style guide: http://www.chromium.org/developers/coding-style.

Definition at line 2249 of file Format.cpp.

Referenced by getPredefinedStyle().

◆ getClangFormatStyle()

FormatStyle clang::format::getClangFormatStyle ( )

Definition at line 2404 of file Format.cpp.

References getLLVMStyle(), clang::format::FormatStyle::LE_LF, and clang::format::FormatStyle::RPS_ReturnStatement.

Referenced by getPredefinedStyle().

◆ getCommentSplit()

BreakableToken::Split clang::format::getCommentSplit	(	StringRef	Text,
		unsigned	ContentStartColumn,
		unsigned	ColumnLimit,
		unsigned	TabWidth,
		encoding::Encoding	Encoding,
		const FormatStyle &	Style,
		bool	DecorationEndsWithStar = false )

static

Definition at line 56 of file BreakableToken.cpp.

References Blanks(), clang::format::encoding::columnWidthWithTabs(), clang::format::encoding::getCodePointNumBytes(), and clang::Text.

Referenced by clang::format::BreakableBlockComment::getSplit(), and clang::format::BreakableComment::getSplit().

◆ getEnclosingFunctionName()

StringRef clang::format::getEnclosingFunctionName ( const FormatToken & Current )

static

Definition at line 2584 of file ContinuationIndenter.cpp.

References Tok.

◆ getFormattingLangOpts()

LangOptions clang::format::getFormattingLangOpts ( const FormatStyle & Style = getLLVMStyle() )

Returns the LangOpts that the formatter expects you to set.

Parameters

Style determines specific settings for lexing mode.

Definition at line 4510 of file Format.cpp.

References clang::format::FormatStyle::LK_C, clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_ObjC, clang::format::FormatStyle::LS_Auto, clang::format::FormatStyle::LS_Cpp11, clang::format::FormatStyle::LS_Cpp14, clang::format::FormatStyle::LS_Cpp17, clang::format::FormatStyle::LS_Cpp20, clang::format::FormatStyle::LS_Cpp23, clang::format::FormatStyle::LS_Cpp26, and clang::format::FormatStyle::LS_Latest.

Referenced by clang::format::IntegerLiteralSeparatorFixer::process(), clang::format::NumericLiteralCaseFixer::process(), clang::format::TokenAnalyzer::TokenAnalyzer(), clang::format::TokenAnnotator::TokenAnnotator(), and clang::format::UnwrappedLineParser::UnwrappedLineParser().

◆ getFunctionName()

FormatToken * clang::format::getFunctionName	(	const AnnotatedLine &	Line,
		FormatToken *&	OpeningParen )

static

Definition at line 3745 of file TokenAnnotator.cpp.

References clang::Line, Next, skipNameQualifier(), and Tok.

Referenced by clang::format::TokenAnnotator::annotate().

◆ getGNUStyle()

FormatStyle clang::format::getGNUStyle ( )

Returns a format style complying with GNU Coding Standards: http://www.gnu.org/prep/standards/standards.html.

Definition at line 2360 of file Format.cpp.

References clang::format::FormatStyle::BLS_Block, clang::format::FormatStyle::BOS_All, clang::format::FormatStyle::BS_GNU, clang::format::FormatStyle::DRTBS_All, getLLVMStyle(), clang::format::FormatStyle::RTBS_AllDefinitions, and clang::format::FormatStyle::SBPO_Always.

Referenced by getPredefinedStyle().

◆ getGoogleStyle()

FormatStyle clang::format::getGoogleStyle ( FormatStyle::LanguageKind Language )

Returns a format style complying with one of Google's style guides: http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml.

http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml. https://developers.google.com/protocol-buffers/docs/style.

Definition at line 2097 of file Format.cpp.

Referenced by getChromiumStyle(), getGoogleStyle(), and getPredefinedStyle().

◆ getLanguageByComment()

FormatStyle::LanguageKind clang::format::getLanguageByComment ( const Environment & Env )

static

Definition at line 4623 of file Format.cpp.

References clang::format::Environment::getFileID(), clang::format::Environment::getSourceManager(), clang::Lexer::LexFromRawLexer(), clang::format::FormatStyle::LK_C, clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_None, clang::format::FormatStyle::LK_ObjC, clang::Lexer::SetCommentRetentionState(), clang::Text, and Tok.

Referenced by guessLanguage().

◆ getLanguageByFileName()

FormatStyle::LanguageKind clang::format::getLanguageByFileName ( StringRef & FileName )

static

Definition at line 4571 of file Format.cpp.

References clang::FileName, clang::format::FormatStyle::LK_C, clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_CSharp, clang::format::FormatStyle::LK_Java, clang::format::FormatStyle::LK_JavaScript, clang::format::FormatStyle::LK_Json, clang::format::FormatStyle::LK_ObjC, clang::format::FormatStyle::LK_Proto, clang::format::FormatStyle::LK_TableGen, clang::format::FormatStyle::LK_TextProto, and clang::format::FormatStyle::LK_Verilog.

Referenced by guessLanguage().

◆ getLanguageName()

StringRef clang::format::getLanguageName ( FormatStyle::LanguageKind Language )

inline

Definition at line 6582 of file Format.h.

References clang::format::FormatStyle::LK_C, clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_CSharp, clang::format::FormatStyle::LK_Java, clang::format::FormatStyle::LK_JavaScript, clang::format::FormatStyle::LK_Json, clang::format::FormatStyle::LK_ObjC, clang::format::FormatStyle::LK_Proto, clang::format::FormatStyle::LK_TableGen, clang::format::FormatStyle::LK_TextProto, and clang::format::FormatStyle::LK_Verilog.

Referenced by getStyle(), and clang::format::TokenAnalyzer::TokenAnalyzer().

◆ getLastLineEndColumn()

unsigned clang::format::getLastLineEndColumn	(	StringRef	Text,
		unsigned	StartColumn,
		unsigned	TabWidth,
		encoding::Encoding	Encoding )

static

Definition at line 2352 of file ContinuationIndenter.cpp.

References clang::format::encoding::columnWidthWithTabs(), and clang::Text.

◆ getLastNonComment()

FormatToken * clang::format::getLastNonComment ( const UnwrappedLine & Line )

static

Definition at line 2882 of file UnwrappedLineParser.cpp.

References getLastNonComment(), clang::Token::isNot(), and clang::Line.

Referenced by getLastNonComment().

◆ getLengthToMatchingParen()

unsigned clang::format::getLengthToMatchingParen	(	const FormatToken &	Tok,
		ArrayRef< ParenState >	Stack )

static

Definition at line 49 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::CanBreakBefore, clang::format::FormatToken::isOneOf(), clang::format::FormatToken::MatchingParen, clang::format::FormatToken::Next, Tok, and clang::format::FormatToken::TotalLength.

Referenced by clang::format::ContinuationIndenter::mustBreak().

◆ getLengthToNextOperator()

unsigned clang::format::getLengthToNextOperator ( const FormatToken & Tok )

static

Definition at line 119 of file ContinuationIndenter.cpp.

References Tok.

Referenced by clang::format::ContinuationIndenter::mustBreak().

◆ getLineCommentIndentPrefix()

StringRef clang::format::getLineCommentIndentPrefix	(	StringRef	Comment,
		const FormatStyle &	Style )

static

Definition at line 30 of file BreakableToken.cpp.

Referenced by clang::format::BreakableLineCommentSection::BreakableLineCommentSection().

◆ getLineStart()

const FormatToken & clang::format::getLineStart ( const FormatToken & Tok )

static

Definition at line 24 of file WhitespaceManager.cpp.

References FD_Break, clang::Result, and Tok.

Referenced by indentLevelFor().

◆ getLLVMStyle()

FormatStyle clang::format::getLLVMStyle ( FormatStyle::LanguageKind Language = FormatStyle::LK_Cpp )

Returns a format style complying with the LLVM coding standards: http://llvm.org/docs/CodingStandards.html.

Definition at line 1847 of file Format.cpp.

Referenced by getClangFormatStyle(), getGNUStyle(), getGoogleStyle(), getMicrosoftStyle(), getMozillaStyle(), getNoStyle(), getPredefinedStyle(), getStyle(), getWebKitStyle(), guessLanguage(), and clang::format::RawStringFormatStyleManager::RawStringFormatStyleManager().

◆ getMicrosoftStyle()

FormatStyle clang::format::getMicrosoftStyle ( FormatStyle::LanguageKind Language )

Returns a format style complying with Microsoft style guide: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017.

Definition at line 2375 of file Format.cpp.

References clang::format::FormatStyle::BS_Custom, clang::format::FormatStyle::BWACS_Always, clang::format::FormatStyle::DRTBS_None, getLLVMStyle(), clang::format::FormatStyle::RTBS_None, clang::format::FormatStyle::SIS_Never, and clang::format::FormatStyle::UT_Never.

Referenced by getPredefinedStyle().

◆ getMozillaStyle()

FormatStyle clang::format::getMozillaStyle ( )

Returns a format style complying with Mozilla's style guide: https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html.

Definition at line 2309 of file Format.cpp.

Referenced by getPredefinedStyle().

◆ getNamespaceToken() [1/2]

const FormatToken * clang::format::getNamespaceToken ( ) const

Return the actual namespace token, if this token starts a namespace block.

Definition at line 949 of file FormatToken.h.

Referenced by clang::format::NamespaceEndCommentsFixer::analyze(), computeNewlines(), and getNamespaceTokenText().

◆ getNamespaceToken() [2/2]

const FormatToken * clang::format::getNamespaceToken	(	const AnnotatedLine *	Line,
		const SmallVectorImpl< AnnotatedLine * > &	AnnotatedLines )

Definition at line 248 of file NamespaceEndCommentsFixer.cpp.

References clang::format::FormatToken::is(), clang::format::UnwrappedLine::kInvalidIndex, and clang::Line.

◆ getNamespaceTokenText()

StringRef clang::format::getNamespaceTokenText	(	const AnnotatedLine *	Line,
		const SmallVectorImpl< AnnotatedLine * > &	AnnotatedLines )

Definition at line 271 of file NamespaceEndCommentsFixer.cpp.

References getNamespaceToken(), clang::Line, and clang::format::FormatToken::TokenText.

Referenced by clang::format::NamespaceEndCommentsFixer::analyze().

◆ getNextNonComment()

FormatToken * clang::format::getNextNonComment ( ) const

nodiscard

Returns the next token ignoring comments.

Definition at line 886 of file FormatToken.h.

References Tok.

◆ getNoStyle()

FormatStyle clang::format::getNoStyle ( )

Returns style indicating formatting should be not applied at all.

Definition at line 2418 of file Format.cpp.

References clang::format::FormatStyle::DisableFormat, getLLVMStyle(), clang::format::FormatStyle::SortIncludes, clang::format::FormatStyle::SortUsingDeclarations, and clang::format::FormatStyle::SUD_Never.

Referenced by getPredefinedStyle(), and getStyle().

◆ getParseCategory()

const std::error_category & clang::format::getParseCategory ( )

Definition at line 1676 of file Format.cpp.

References clang::C.

Referenced by make_error_code().

◆ getPredefinedStyle()

bool clang::format::getPredefinedStyle	(	StringRef	Name,
		FormatStyle::LanguageKind	Language,
		FormatStyle *	Style )

Gets a predefined style for the specified language by name.

Currently supported names: LLVM, Google, Chromium, Mozilla. Names are compared case-insensitively.

Returns true if the Style has been set.

Definition at line 2426 of file Format.cpp.

References getChromiumStyle(), getClangFormatStyle(), getGNUStyle(), getGoogleStyle(), getLLVMStyle(), getMicrosoftStyle(), getMozillaStyle(), getNoStyle(), and getWebKitStyle().

Referenced by getStyle(), and clang::format::RawStringFormatStyleManager::RawStringFormatStyleManager().

◆ getPrevious()

struct clang::format::FormatToken clang::format::getPrevious ( T A1 ) const

Definition at line 235 of file FormatToken.h.

◆ getPreviousNonComment()

FormatToken * clang::format::getPreviousNonComment ( ) const

nodiscard

Returns the previous token ignoring comments.

Definition at line 878 of file FormatToken.h.

References Tok.

◆ getPreviousOneOf()

template<typename... Ts>

FormatToken * clang::format::getPreviousOneOf ( Ts... Ks ) const

nodiscard

Definition at line 870 of file FormatToken.h.

References ForcedPrecedence, and Tok.

◆ getRawStringDelimiter()

std::optional< StringRef > clang::format::getRawStringDelimiter ( StringRef TokenText )

static

Definition at line 204 of file ContinuationIndenter.cpp.

References TokenText.

◆ getStringSplit()

BreakableToken::Split clang::format::getStringSplit	(	StringRef	Text,
		unsigned	UsedColumns,
		unsigned	ColumnLimit,
		unsigned	TabWidth,
		encoding::Encoding	Encoding )

static

Definition at line 158 of file BreakableToken.cpp.

References Blanks(), clang::format::encoding::columnWidthWithTabs(), clang::format::encoding::getCodePointNumBytes(), clang::format::encoding::getEscapeSequenceLength(), clang::isAlphanumeric(), and clang::Text.

Referenced by clang::format::BreakableStringLiteral::getSplit().

◆ getStyle()

Expected< FormatStyle > clang::format::getStyle	(	StringRef	StyleName,
		StringRef	FileName,
		StringRef	FallbackStyle,
		StringRef	Code = "",
		llvm::vfs::FileSystem *	FS = nullptr,
		bool	AllowUnknownOptions = false,
		llvm::SourceMgr::DiagHandlerTy	DiagHandler = nullptr )

Construct a FormatStyle based on StyleName.

StyleName can take several forms:

"{<key>: <value>, ...}" - Set specic style parameters.
"<style name>" - One of the style names supported by getPredefinedStyle().
"file" - Load style configuration from a file called .clang-format located in one of the parent directories of FileName or the current directory if FileName is empty.
"file:<format_file_path>" to explicitly specify the configuration file to use.

Parameters

[in]	StyleName	Style name to interpret according to the description above.
[in]	FileName	Path to start search for .clang-format if StyleName == "file".
[in]	FallbackStyle	The name of a predefined style used to fallback to in case `StyleName` is "file" and no file can be found.
[in]	Code	The actual code to be formatted. Used to determine the language if the filename isn't sufficient.
[in]	FS	The underlying file system, in which the file resides. By default, the file system is the real file system.
[in]	AllowUnknownOptions	If true, unknown format options only emit a warning. If false, errors are emitted on unknown format options.

Returns: FormatStyle as specified by StyleName. If StyleName is "file" and no file is found, returns FallbackStyle. If no style could be determined, returns an Error.

Definition at line 4696 of file Format.cpp.

References clang::FileName, getLanguageName(), getLLVMStyle(), getNoStyle(), getPredefinedStyle(), guessLanguage(), loadAndParseConfigFile(), make_string_error(), clang::format::FormatStyle::parseConfiguration, clang::Text, and Unsuitable.

Referenced by clang::tooling::formatAndApplyAllReplacements().

◆ getTokenTypeName()

const char * clang::format::getTokenTypeName ( TokenType Type )

Determines the name of a token type.

Definition at line 23 of file FormatToken.cpp.

References LIST_TOKEN_TYPES, NUM_TOKEN_TYPES, and TokNames.

◆ getWebKitStyle()

FormatStyle clang::format::getWebKitStyle ( )

Returns a format style complying with Webkit's style guide: http://www.webkit.org/coding/coding-style.html.

Definition at line 2336 of file Format.cpp.

References clang::format::FormatStyle::BCIS_BeforeComma, clang::format::FormatStyle::BLS_Block, clang::format::FormatStyle::BOS_All, clang::format::FormatStyle::BS_WebKit, getLLVMStyle(), clang::format::FormatStyle::NI_Inner, clang::format::FormatStyle::OAS_DontAlign, clang::format::FormatStyle::PAS_Left, clang::format::FormatStyle::SBS_Empty, clang::format::FormatStyle::SIEB_Always, and clang::format::FormatStyle::TCAS_Never.

Referenced by getPredefinedStyle().

◆ guessLanguage()

FormatStyle::LanguageKind clang::format::guessLanguage	(	StringRef	FileName,
		StringRef	Code )

Definition at line 4652 of file Format.cpp.

References clang::FileName, getLanguageByComment(), getLanguageByFileName(), getLLVMStyle(), clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_None, and clang::format::FormatStyle::LK_ObjC.

Referenced by getStyle().

◆ hash_combine()

template<class T>

void clang::format::hash_combine	(	std::size_t &	seed,
		const T &	v )

inlinestatic

Definition at line 662 of file UnwrappedLineParser.cpp.

References clang::T.

◆ hasNestedBlockInlined()

bool clang::format::hasNestedBlockInlined	(	const FormatToken *	Previous,
		const FormatToken &	Current,
		const FormatStyle &	Style )

static

Definition at line 1780 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::is(), and Previous.

◆ IncrementChangeSpaces()

void clang::format::IncrementChangeSpaces	(	unsigned	Start,
		int	Delta,
		MutableArrayRef< WhitespaceManager::Change >	Changes )

static

Definition at line 335 of file WhitespaceManager.cpp.

References abs(), and SetChangeSpaces().

Referenced by AlignTokenSequence().

◆ indentLevelFor()

unsigned clang::format::indentLevelFor ( const WhitespaceManager::Change & C )

static

Definition at line 31 of file WhitespaceManager.cpp.

References clang::format::FormatToken::AppliedIndentLevel, clang::C, getLineStart(), and clang::format::FormatToken::IndentLevel.

◆ insertQualifierAfter()

void clang::format::insertQualifierAfter	(	const SourceManager &	SourceMgr,
		tooling::Replacements &	Fixes,
		const FormatToken *	First,
		const std::string &	Qualifier )

static

Definition at line 74 of file QualifierAlignmentFixer.cpp.

References clang::First, clang::CharSourceRange::getCharRange(), and replaceToken().

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeRight().

◆ insertQualifierBefore()

void clang::format::insertQualifierBefore	(	const SourceManager &	SourceMgr,
		tooling::Replacements &	Fixes,
		const FormatToken *	First,
		const std::string &	Qualifier )

static

Definition at line 87 of file QualifierAlignmentFixer.cpp.

References clang::First, clang::CharSourceRange::getCharRange(), and replaceToken().

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft().

◆ isAlignableBinaryOperator()

bool clang::format::isAlignableBinaryOperator ( const FormatToken & Token )

static

Definition at line 132 of file ContinuationIndenter.cpp.

References clang::prec::Conditional, clang::Token::is(), and clang::prec::PointerToMember.

Referenced by mustBreakBinaryOperation(), and startsNextOperand().

◆ isAllmanBrace()

bool clang::format::isAllmanBrace ( const FormatToken & Tok )

static

Definition at line 5824 of file TokenAnnotator.cpp.

References BK_Block, and Tok.

◆ isAllmanLambdaBrace()

bool clang::format::isAllmanLambdaBrace ( const FormatToken & Tok )

static

Definition at line 5842 of file TokenAnnotator.cpp.

References BK_Block, and Tok.

◆ isBlockIndentedInitRBrace()

bool clang::format::FormatToken::isBlockIndentedInitRBrace ( const FormatStyle & Style ) const

nodiscard

Returns true if this token ends a block indented initializer list.

Definition at line 66 of file FormatToken.cpp.

References BK_BracedInit, clang::format::FormatStyle::BLS_Block, clang::format::FormatToken::is(), and MatchingParen.

◆ isC78ParameterDecl()

bool clang::format::isC78ParameterDecl	(	const FormatToken *	Tok,
		const FormatToken *	Next,
		const FormatToken *	FuncName )

static

Definition at line 1321 of file UnwrappedLineParser.cpp.

References isC78ParameterDecl(), isC78Type(), clang::format::FormatToken::isNot(), Next, clang::format::FormatToken::Previous, and Tok.

Referenced by isC78ParameterDecl().

◆ isC78Type()

bool clang::format::isC78Type ( const FormatToken & Tok )

static

Definition at line 1308 of file UnwrappedLineParser.cpp.

References isC78Type(), and Tok.

Referenced by isC78ParameterDecl(), and isC78Type().

◆ isClangFormatOff()

bool clang::format::isClangFormatOff ( StringRef Comment )

Definition at line 4916 of file Format.cpp.

References isClangFormatOnOff().

Referenced by clang::format::IntegerLiteralSeparatorFixer::process(), clang::format::NumericLiteralCaseFixer::process(), clang::format::TokenAnnotator::setCommentLineLevels(), sortCppIncludes(), and sortJavaImports().

◆ isClangFormatOn()

bool clang::format::isClangFormatOn ( StringRef Comment )

Definition at line 4912 of file Format.cpp.

References isClangFormatOnOff().

Referenced by clang::format::JavaScriptImportSorter::analyze(), clang::format::IntegerLiteralSeparatorFixer::process(), clang::format::NumericLiteralCaseFixer::process(), sortCppIncludes(), and sortJavaImports().

◆ isClangFormatOnOff()

bool clang::format::isClangFormatOnOff	(	StringRef	Comment,
		bool	On )

static

Definition at line 4900 of file Format.cpp.

References clang::On.

Referenced by isClangFormatOff(), and isClangFormatOn().

◆ isConfiguredQualifier()

bool clang::format::isConfiguredQualifier	(	const FormatToken *const	Tok,
		const std::vector< tok::TokenKind > &	Qualifiers )

static

Definition at line 155 of file QualifierAlignmentFixer.cpp.

References Tok.

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft(), and isConfiguredQualifierOrType().

◆ isConfiguredQualifierOrType()

bool clang::format::isConfiguredQualifierOrType	(	const FormatToken *	Tok,
		const std::vector< tok::TokenKind > &	Qualifiers,
		const LangOptions &	LangOpts )

Definition at line 643 of file QualifierAlignmentFixer.cpp.

References isConfiguredQualifier(), and Tok.

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft().

◆ isCppStructuredBinding()

bool clang::format::isCppStructuredBinding ( bool IsCpp ) const

Returns whether the token is the left square bracket of a C++ structured binding declaration.

Definition at line 929 of file FormatToken.h.

References TokenText.

◆ isCtorOrDtorName()

bool clang::format::isCtorOrDtorName ( const FormatToken * Tok )

static

Definition at line 3820 of file TokenAnnotator.cpp.

References Tok.

Referenced by clang::format::TokenAnnotator::annotate().

◆ isEmptyLambdaAllowed()

bool clang::format::isEmptyLambdaAllowed	(	const FormatToken &	Tok,
		FormatStyle::ShortLambdaStyle	ShortLambdaOption )

static

Definition at line 5837 of file TokenAnnotator.cpp.

References clang::format::FormatStyle::SLS_None, and Tok.

◆ IsFunctionArgument()

bool clang::format::IsFunctionArgument ( const FormatToken & Tok )

static

Definition at line 5830 of file TokenAnnotator.cpp.

References Tok.

◆ isFunctionDeclarationName()

bool clang::format::isFunctionDeclarationName	(	const LangOptions &	LangOpts,
		const FormatToken &	Current,
		const AnnotatedLine &	Line,
		FormatToken *&	ClosingParen )

static

Definition at line 3904 of file TokenAnnotator.cpp.

References clang::format::FormatToken::is(), clang::format::FormatToken::isNoneOf(), clang::format::FormatToken::isNot(), clang::Line, clang::format::FormatToken::NestingLevel, clang::format::FormatToken::Next, Next, Previous, and Tok.

Referenced by clang::format::TokenAnnotator::calculateFormattingInformation().

◆ isGoogScope()

bool clang::format::isGoogScope ( const UnwrappedLine & Line )

static

Definition at line 920 of file UnwrappedLineParser.cpp.

References isGoogScope(), and clang::Line.

Referenced by isGoogScope().

◆ isIIFE()

bool clang::format::isIIFE	(	const UnwrappedLine &	Line,
		const AdditionalKeywords &	Keywords )

static

Definition at line 938 of file UnwrappedLineParser.cpp.

References isIIFE(), clang::AdditionalKeywords::kw_function, and clang::Line.

Referenced by isIIFE().

◆ isJSDeclOrStmt()

bool clang::format::isJSDeclOrStmt	(	const AdditionalKeywords &	Keywords,
		const FormatToken *	FormatTok )

static

Definition at line 1288 of file UnwrappedLineParser.cpp.

References isJSDeclOrStmt(), clang::format::FormatToken::isOneOf(), clang::AdditionalKeywords::kw_async, clang::AdditionalKeywords::kw_finally, clang::AdditionalKeywords::kw_function, clang::AdditionalKeywords::kw_import, clang::AdditionalKeywords::kw_let, clang::AdditionalKeywords::kw_var, and clang::AdditionalKeywords::kw_yield.

Referenced by isJSDeclOrStmt().

◆ isLikelyXml()

bool clang::format::isLikelyXml ( StringRef Code )

Definition at line 4080 of file Format.cpp.

Referenced by clang::format::internal::reformat(), and sortIncludes().

◆ isMpegTS()

bool clang::format::isMpegTS ( StringRef Code )

Definition at line 4073 of file Format.cpp.

Referenced by clang::format::internal::reformat(), and sortIncludes().

◆ isNumericLiteralCaseFixerNeeded()

bool clang::format::isNumericLiteralCaseFixerNeeded ( const FormatStyle & Style )

static

Definition at line 25 of file NumericLiteralCaseFixer.cpp.

References clang::format::FormatStyle::LK_C, clang::format::FormatStyle::LK_Cpp, clang::format::FormatStyle::LK_CSharp, clang::format::FormatStyle::LK_Java, clang::format::FormatStyle::LK_JavaScript, clang::format::FormatStyle::LK_ObjC, and clang::format::FormatStyle::NLCS_Leave.

Referenced by clang::format::NumericLiteralCaseFixer::process().

◆ isPossibleMacro()

bool clang::format::isPossibleMacro ( bool AllowFollowingColonColon = false ) const

Returns true if this token likely names an object-like macro.

If AllowFollowingColonColon is true, a following :: does not disqualify the token from being considered macro-like.

Definition at line 897 of file FormatToken.h.

◆ isQualifier()

bool clang::format::isQualifier ( const FormatToken *const Tok )

static

Definition at line 160 of file QualifierAlignmentFixer.cpp.

References Tok.

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft(), clang::format::LeftRightQualifierAlignmentFixer::analyzeRight(), and isQualifierOrType().

◆ isQualifierOrType()

bool clang::format::isQualifierOrType	(	const FormatToken *	Tok,
		const LangOptions &	LangOpts )

Definition at line 638 of file QualifierAlignmentFixer.cpp.

References isQualifier(), and Tok.

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeRight().

◆ lexCSharpString()

auto clang::format::lexCSharpString	(	const char *	Begin,
		const char *	End,
		bool	Verbatim,
		bool	Interpolated )

static

Definition at line 812 of file FormatTokenLexer.cpp.

◆ loadAndParseConfigFile()

llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > clang::format::loadAndParseConfigFile	(	StringRef	ConfigFile,
		llvm::vfs::FileSystem *	FS,
		FormatStyle *	Style,
		bool	AllowUnknownOptions,
		llvm::SourceMgr::DiagHandlerTy	DiagHandler,
		bool	IsDotHFile )

Definition at line 4680 of file Format.cpp.

References clang::format::FormatStyle::parseConfiguration, and clang::Text.

Referenced by getStyle().

◆ make_error_code()

std::error_code clang::format::make_error_code ( ParseError e )

Definition at line 1680 of file Format.cpp.

References getParseCategory().

Referenced by clang::format::FormatStyle::parseConfiguration.

◆ make_string_error()

llvm::Error clang::format::make_string_error ( const Twine & Message )

inline

Definition at line 1684 of file Format.cpp.

Referenced by getStyle().

◆ markOptionalBraces()

void clang::format::markOptionalBraces ( FormatToken * LeftBrace )

static

Definition at line 2932 of file UnwrappedLineParser.cpp.

References clang::format::FormatToken::is(), markOptionalBraces(), clang::format::FormatToken::MatchingParen, and clang::format::FormatToken::Optional.

Referenced by markOptionalBraces().

◆ matchesReservedSuffix()

bool clang::format::matchesReservedSuffix ( StringRef Suffix )

static

Test if Suffix matches a C++ literal reserved by the library.

Matches against all suffixes reserved in the C++23 standard.

Definition at line 62 of file NumericLiteralCaseFixer.cpp.

Referenced by format().

◆ matchFilePath() [1/2]

bool clang::format::matchFilePath	(	llvm::StringRef	Pattern,
		llvm::StringRef	FilePath )

◆ matchFilePath() [2/2]

bool clang::format::matchFilePath	(	StringRef	Pattern,
		StringRef	FilePath )

Definition at line 24 of file MatchFilePath.cpp.

References clang::C, clang::Match, and matchFilePath().

Referenced by matchFilePath().

◆ maxNestingDepth()

unsigned clang::format::maxNestingDepth ( const AnnotatedLine & Line )

static

Definition at line 3703 of file TokenAnnotator.cpp.

References clang::Line, clang::Result, and Tok.

Referenced by clang::format::TokenAnnotator::annotate().

◆ mayReflowContent()

bool clang::format::mayReflowContent ( StringRef Content )

static

Definition at line 439 of file BreakableToken.cpp.

References Blanks(), and clang::isPunctuation().

Referenced by clang::format::BreakableBlockComment::mayReflow(), and clang::format::BreakableLineCommentSection::mayReflow().

◆ mustBeJSIdent()

bool clang::format::mustBeJSIdent	(	const AdditionalKeywords &	Keywords,
		const FormatToken *	FormatTok )

static

Definition at line 1264 of file UnwrappedLineParser.cpp.

Referenced by mustBeJSIdent(), and mustBeJSIdentOrValue().

◆ mustBeJSIdentOrValue()

bool clang::format::mustBeJSIdentOrValue	(	const AdditionalKeywords &	Keywords,
		const FormatToken *	FormatTok )

static

Definition at line 1279 of file UnwrappedLineParser.cpp.

References clang::Token::isLiteral(), clang::format::FormatToken::isOneOf(), mustBeJSIdent(), mustBeJSIdentOrValue(), and clang::format::FormatToken::Tok.

Referenced by mustBeJSIdentOrValue().

◆ mustBreakAfterAttributes()

bool clang::format::mustBreakAfterAttributes	(	const FormatToken &	Tok,
		const FormatStyle &	Style )

static

Definition at line 26 of file TokenAnnotator.cpp.

References clang::format::FormatStyle::ABS_Always, clang::format::FormatStyle::ABS_Never, and Tok.

Referenced by clang::format::TokenAnnotator::calculateFormattingInformation().

◆ mustBreakBinaryOperation()

bool clang::format::mustBreakBinaryOperation	(	const FormatToken &	Current,
		const FormatStyle &	Style )

static

Definition at line 157 of file ContinuationIndenter.cpp.

References clang::format::FormatStyle::BBO_Never, clang::format::FormatStyle::BOS_None, clang::format::FormatToken::CanBreakBefore, getChainLength(), clang::Token::getKind(), isAlignableBinaryOperator(), clang::format::FormatToken::Previous, startsNextOperand(), and clang::format::FormatToken::Tok.

◆ opensBlockOrBlockTypeList()

bool clang::format::FormatToken::opensBlockOrBlockTypeList ( const FormatStyle & Style ) const

nodiscard

Returns true if this tokens starts a block-type list, i.e. a list that should be indented with a block indent.

Definition at line 82 of file FormatToken.cpp.

References BK_Block, BK_BracedInit, clang::format::FormatStyle::BLS_Block, clang::format::FormatToken::getBlockKind(), clang::format::FormatToken::is(), and NestingLevel.

◆ opensProtoMessageField()

bool clang::format::opensProtoMessageField	(	const FormatToken &	LessTok,
		const FormatStyle &	Style )

static

Definition at line 191 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::is(), clang::format::FormatToken::isNot(), clang::format::FormatStyle::LK_Proto, clang::format::FormatToken::NestingLevel, and clang::format::FormatToken::Previous.

Referenced by clang::format::ContinuationIndenter::mustBreak().

◆ operator<()

bool clang::format::operator<	(	const JsModuleReference &	LHS,
		const JsModuleReference &	RHS )

Definition at line 101 of file SortJavaScriptImports.cpp.

References clang::format::JsModuleReference::ALIAS, clang::format::JsModuleReference::Category, clang::format::JsModuleReference::IsExport, clang::format::JsModuleReference::Prefix, clang::format::JsModuleReference::SIDE_EFFECT, and clang::format::JsModuleReference::URL.

◆ operator<<()

std::ostream & clang::format::operator<<	(	std::ostream &	Stream,
		const UnwrappedLine &	Line )

Definition at line 90 of file UnwrappedLineParser.cpp.

References clang::Line.

◆ parseConfiguration() [1/2]

std::error_code clang::format::parseConfiguration	(	llvm::MemoryBufferRef	Config,
		FormatStyle *	Style,
		bool	AllowUnknownOptions = false,
		llvm::SourceMgr::DiagHandlerTy	DiagHandler = nullptr,
		void *	DiagHandlerCtx = nullptr,
		bool	IsDotHFile = false )

Parse configuration from YAML-formatted text.

Style->Language is used to get the base style, if the BasedOnStyle option is present.

The FormatStyleSet of Style is reset.

When BasedOnStyle is not present, options not present in the YAML document, are retained in Style.

If AllowUnknownOptions is true, no errors are emitted if unknown format options are occurred.

If set all diagnostics are emitted through the DiagHandler.

Definition at line 2491 of file Format.cpp.

Referenced by parseConfiguration().

◆ parseConfiguration() [2/2]

std::error_code clang::format::parseConfiguration	(	StringRef	Config,
		FormatStyle *	Style,
		bool	AllowUnknownOptions = false,
		bool	IsDotHFile = false )

inline

Like above but accepts an unnamed buffer.

Definition at line 6409 of file Format.h.

References parseConfiguration().

◆ prepareLeftRightOrderingForQualifierAlignmentFixer()

void clang::format::prepareLeftRightOrderingForQualifierAlignmentFixer	(	const std::vector< std::string > &	Order,
		std::vector< std::string > &	LeftOrder,
		std::vector< std::string > &	RightOrder,
		std::vector< tok::TokenKind > &	Qualifiers )

Definition at line 604 of file QualifierAlignmentFixer.cpp.

References clang::format::LeftRightQualifierAlignmentFixer::getTokenFromQualifier().

Referenced by addQualifierAlignmentFixerPasses().

◆ processReplacements()

template<typename T>

Expected< tooling::Replacements > clang::format::processReplacements	(	T	ProcessFunc,
		StringRef	Code,
		const tooling::Replacements &	Replaces,
		const FormatStyle &	Style )

static

Definition at line 4104 of file Format.cpp.

References clang::tooling::Replacements::begin(), clang::tooling::Replacements::empty(), clang::FileName, clang::tooling::Replacements::getAffectedRanges(), clang::tooling::Replacements::merge(), and clang::T.

Referenced by cleanupAroundReplacements(), and formatReplacements().

◆ reformat() [1/2]

tooling::Replacements clang::format::reformat	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		bool *	IncompleteFormat )

Same as above, except if IncompleteFormat is non-null, its value will be set to true if any of the affected ranges were not formatted due to a non-recoverable syntax error.

Definition at line 4480 of file Format.cpp.

References clang::FileName, reformat(), and clang::Result.

◆ reformat() [2/2]

tooling::Replacements clang::format::reformat	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName = "<stdin>",
		FormattingAttemptStatus *	Status = nullptr )

Reformats the given Ranges in Code.

Each range is extended on either end to its next bigger logic unit, i.e. everything that might influence its formatting or might be influenced by its formatting.

Returns the Replacements necessary to make all Ranges comply with Style.

If Status is non-null, its value will be populated with the status of this formatting attempt. See FormattingAttemptStatus.

Definition at line 4457 of file Format.cpp.

References clang::FileName, and clang::format::internal::reformat().

Referenced by clang::tooling::applyAtomicChanges(), formatReplacements(), and reformat().

◆ removeToken()

void clang::format::removeToken	(	const SourceManager &	SourceMgr,
		tooling::Replacements &	Fixes,
		const FormatToken *	First )

static

Definition at line 66 of file QualifierAlignmentFixer.cpp.

References clang::First, clang::CharSourceRange::getCharRange(), and replaceToken().

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft().

◆ replaceCRLF()

std::string clang::format::replaceCRLF ( const std::string & Code )

Definition at line 3612 of file Format.cpp.

Referenced by sortCppIncludes(), and sortJavaImports().

◆ replaceToken()

void clang::format::replaceToken	(	const SourceManager &	SourceMgr,
		tooling::Replacements &	Fixes,
		const CharSourceRange &	Range,
		std::string	NewText )

static

Definition at line 54 of file QualifierAlignmentFixer.cpp.

References clang::tooling::Replacements::add().

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeRight(), insertQualifierAfter(), insertQualifierBefore(), removeToken(), and rotateTokens().

◆ rotateTokens()

void clang::format::rotateTokens	(	const SourceManager &	SourceMgr,
		tooling::Replacements &	Fixes,
		const FormatToken *	First,
		const FormatToken *	Last,
		bool	Left )

static

Definition at line 112 of file QualifierAlignmentFixer.cpp.

References endsWithSpace(), clang::First, clang::CharSourceRange::getCharRange(), clang::Last, replaceToken(), startsWithSpace(), and Tok.

Referenced by clang::format::LeftRightQualifierAlignmentFixer::analyzeLeft(), and clang::format::LeftRightQualifierAlignmentFixer::analyzeRight().

◆ separateDefinitionBlocks()

tooling::Replacements clang::format::separateDefinitionBlocks	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName = "<stdin>" )

Inserts or removes empty lines separating definition blocks including classes, structs, functions, namespaces, and enums in the given Ranges in Code.

Returns the Replacements that inserts or removes empty lines separating definition blocks in all Ranges in Code.

References DefaultFallbackStyle, DefaultFormatStyle, clang::FileName, and StyleOptionHelpDescription.

◆ SetChangeSpaces()

void clang::format::SetChangeSpaces	(	unsigned	Start,
		unsigned	Spaces,
		MutableArrayRef< WhitespaceManager::Change >	Changes )

static

Definition at line 308 of file WhitespaceManager.cpp.

Referenced by IncrementChangeSpaces().

◆ ShouldBreakBeforeBrace()

bool clang::format::ShouldBreakBeforeBrace	(	const FormatStyle &	Style,
		const FormatToken &	InitialToken,
		bool	IsEmptyBlock,
		bool	IsJavaRecord = false )

static

Definition at line 956 of file UnwrappedLineParser.cpp.

References clang::Token::getKind(), clang::format::FormatToken::is(), ShouldBreakBeforeBrace(), clang::format::FormatStyle::SRS_Empty, and clang::format::FormatToken::Tok.

Referenced by ShouldBreakBeforeBrace().

◆ shouldIndentWrappedSelectorName()

bool clang::format::shouldIndentWrappedSelectorName	(	const FormatStyle &	Style,
		LineType	LineType )

static

Definition at line 34 of file ContinuationIndenter.cpp.

References LT_ObjCMethodDecl.

◆ shouldUnindentNextOperator()

bool clang::format::shouldUnindentNextOperator ( const FormatToken & Tok )

static

Definition at line 41 of file ContinuationIndenter.cpp.

References clang::prec::Assignment, Previous, and Tok.

◆ skipNameQualifier()

FormatToken * clang::format::skipNameQualifier ( const FormatToken * Tok )

static

Definition at line 3712 of file TokenAnnotator.cpp.

References Tok.

Referenced by getFunctionName().

◆ sortCppIncludes() [1/2]

void clang::format::sortCppIncludes	(	const FormatStyle &	Style,
		const ArrayRef< IncludeDirective > &	Includes,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		StringRef	Code,
		tooling::Replacements &	Replaces,
		unsigned *	Cursor )

static

Definition at line 3640 of file Format.cpp.

References clang::tooling::Replacements::add(), affectsRange(), Cmp, clang::FileName, FindCursorIndex(), clang::tooling::IncludeStyle::IBS_Preserve, clang::tooling::IncludeStyle::IBS_Regroup, replaceCRLF(), and toString().

Referenced by sortCppIncludes(), and sortIncludes().

◆ sortCppIncludes() [2/2]

tooling::Replacements clang::format::sortCppIncludes	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		tooling::Replacements &	Replaces,
		unsigned *	Cursor )

Definition at line 3776 of file Format.cpp.

References clang::FileName, clang::tooling::IncludeCategoryManager::getIncludePriority(), clang::tooling::IncludeCategoryManager::getSortIncludePriority(), clang::tooling::IncludeStyle::IBS_Merge, clang::tooling::IncludeStyle::IBS_Regroup, clang::tooling::HeaderIncludes::IncludeRegex, isClangFormatOff(), isClangFormatOn(), clang::Line, clang::ast_matchers::match(), and sortCppIncludes().

◆ sortIncludes()

tooling::Replacements clang::format::sortIncludes	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		unsigned *	Cursor = nullptr )

Returns the replacements necessary to sort all #include blocks that are affected by Ranges.

Definition at line 4082 of file Format.cpp.

References clang::FileName, isLikelyXml(), isMpegTS(), sortCppIncludes(), sortJavaImports(), and sortJavaScriptImports().

Referenced by clang::tooling::applyAtomicChanges(), and formatReplacements().

◆ sortJavaImports() [1/2]

void clang::format::sortJavaImports	(	const FormatStyle &	Style,
		const ArrayRef< JavaImportDirective > &	Imports,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		StringRef	Code,
		tooling::Replacements &	Replaces )

static

Definition at line 3919 of file Format.cpp.

References clang::tooling::Replacements::add(), affectsRange(), clang::FileName, findJavaImportGroup(), clang::format::FormatStyle::JavaImportGroups, replaceCRLF(), clang::format::FormatStyle::SJSIO_After, and toString().

Referenced by sortIncludes(), and sortJavaImports().

◆ sortJavaImports() [2/2]

tooling::Replacements clang::format::sortJavaImports	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName,
		tooling::Replacements &	Replaces )

Definition at line 4003 of file Format.cpp.

References clang::FileName, isClangFormatOff(), isClangFormatOn(), clang::Line, sortJavaImports(), and clang::Static.

◆ sortJavaScriptImports()

tooling::Replacements clang::format::sortJavaScriptImports	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName )

Definition at line 586 of file SortJavaScriptImports.cpp.

References clang::FileName, clang::format::Environment::make(), and clang::format::TokenAnalyzer::process().

Referenced by sortIncludes().

◆ sortUsingDeclarations()

tooling::Replacements clang::format::sortUsingDeclarations	(	const FormatStyle &	Style,
		StringRef	Code,
		ArrayRef< tooling::Range >	Ranges,
		StringRef	FileName = "<stdin>" )

Sort consecutive using declarations in the given Ranges in Code.

Returns the Replacements that sort the using declarations in all Ranges in Code.

Definition at line 4500 of file Format.cpp.

References clang::FileName, clang::format::Environment::make(), and clang::format::TokenAnalyzer::process().

◆ startsNextOperand()

bool clang::format::startsNextOperand ( const FormatToken & Current )

static

Definition at line 141 of file ContinuationIndenter.cpp.

References isAlignableBinaryOperator(), clang::format::FormatToken::Previous, and Previous.

Referenced by mustBreakBinaryOperation().

◆ startsNextParameter()

bool clang::format::startsNextParameter	(	const FormatToken &	Current,
		const FormatStyle &	Style )

Definition at line 338 of file FormatToken.cpp.

References clang::format::FormatStyle::BCIS_BeforeComma, clang::format::FormatStyle::BILS_BeforeComma, clang::format::FormatToken::is(), clang::format::FormatStyle::LK_Proto, clang::format::FormatToken::Previous, and Previous.

Referenced by clang::format::TokenAnnotator::calculateFormattingInformation(), and clang::format::ContinuationIndenter::mustBreak().

◆ startsSegmentOfBuilderTypeCall()

bool clang::format::startsSegmentOfBuilderTypeCall ( const FormatToken & Tok )

static

Definition at line 127 of file ContinuationIndenter.cpp.

References Tok.

Referenced by clang::format::ContinuationIndenter::mustBreak().

◆ startsWithSpace()

bool clang::format::startsWithSpace ( const std::string & s )

static

Definition at line 106 of file QualifierAlignmentFixer.cpp.

Referenced by rotateTokens().

◆ switchesFormatting()

bool clang::format::switchesFormatting ( const FormatToken & Token )

Checks if Token switches formatting, like /* clang-format off *‍/.

Token must be a comment.

Definition at line 206 of file BreakableToken.cpp.

References clang::Token::is().

Referenced by clang::format::BreakableLineCommentSection::BreakableLineCommentSection(), clang::format::BreakableBlockComment::mayReflow(), and clang::format::BreakableLineCommentSection::mayReflow().

◆ tokenCanStartNewLine()

bool clang::format::tokenCanStartNewLine ( const FormatToken & Tok )

static

Definition at line 1243 of file UnwrappedLineParser.cpp.

References Tok, and tokenCanStartNewLine().

Referenced by tokenCanStartNewLine().

◆ transformComponent()

std::string clang::format::transformComponent	(	StringRef	Component,
		FormatStyle::NumericLiteralComponentStyle	ConfigValue )

static

Definition at line 47 of file NumericLiteralCaseFixer.cpp.

References clang::format::FormatStyle::NLCS_Lower, and clang::format::FormatStyle::NLCS_Upper.

Referenced by format().

◆ validateQualifierOrder()

ParseError clang::format::validateQualifierOrder ( FormatStyle * Style )

Definition at line 2459 of file Format.cpp.

References DuplicateQualifierSpecified, clang::format::LeftRightQualifierAlignmentFixer::getTokenFromQualifier(), InvalidQualifierSpecified, MissingQualifierOrder, MissingQualifierType, and Success.

Referenced by clang::format::FormatStyle::parseConfiguration.

Variable Documentation

◆ CppNonKeywordTypes

std::array<StringRef, 14> clang::format::CppNonKeywordTypes

staticconstexpr

Initial value:

= {
    "clock_t",  "int16_t",   "int32_t", "int64_t",   "int8_t",
    "intptr_t", "ptrdiff_t", "size_t",  "time_t",    "uint16_t",
    "uint32_t", "uint64_t",  "uint8_t", "uintptr_t",
}

Definition at line 48 of file FormatToken.cpp.

◆ DefaultFallbackStyle

const char * clang::format::DefaultFallbackStyle = "LLVM"

The suggested predefined style to use as the fallback style in getStyle.

Different builds can modify the value to the preferred styles.

Definition at line 4677 of file Format.cpp.

Referenced by separateDefinitionBlocks().

◆ DefaultFormatStyle

const char * clang::format::DefaultFormatStyle = "file"

The suggested format style to use by default.

This allows tools using getStyle to have a consistent default style. Different builds can modify the value to the preferred styles.

Definition at line 4675 of file Format.cpp.

Referenced by separateDefinitionBlocks().

◆ QtPropertyKeywords

std::array<StringRef, 16> clang::format::QtPropertyKeywords

staticconstexpr

Initial value:

= {
    "BINDABLE", "CONSTANT", "DESIGNABLE", "FINAL", "MEMBER",   "NOTIFY",
    "OVERRIDE", "READ",     "REQUIRED",   "RESET", "REVISION", "SCRIPTABLE",
    "STORED",   "USER",     "VIRTUAL",    "WRITE",
}

Definition at line 36 of file FormatToken.cpp.

◆ StyleOptionHelpDescription

const char * clang::format::StyleOptionHelpDescription

Initial value:

=
    "Set coding style. <string> can be:\n"
    "1. A preset: LLVM, GNU, Google, Chromium, Microsoft,\n"
    "   Mozilla, WebKit.\n"
    "2. 'file' to load style configuration from a\n"
    "   .clang-format file in one of the parent directories\n"
    "   of the source file (for stdin, see --assume-filename).\n"
    "   If no .clang-format file is found, falls back to\n"
    "   --fallback-style.\n"
    "   --style=file is the default.\n"
    "3. 'file:<format_file_path>' to explicitly specify\n"
    "   the configuration file.\n"
    "4. \"{key: value, ...}\" to set specific parameters, e.g.:\n"
    "   --style=\"{BasedOnStyle: llvm, IndentWidth: 8}\""

Description to be used for help text for a llvm::cl option for specifying format style.

The description is closely related to the operation of getStyle().

Definition at line 4556 of file Format.cpp.

Referenced by separateDefinitionBlocks().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ AnalyzerPass

Enumeration Type Documentation

◆ Base

◆ BraceBlockKind

◆ FormatDecision

◆ LexerState

◆ LineType

◆ MacroRole

◆ ParameterPackingKind

◆ ParseError

◆ ScopeType

◆ TokenType

Function Documentation

◆ addQualifierAlignmentFixerPasses()

◆ affectsRange()

◆ AlignTokens()

◆ AlignTokenSequence()

◆ Blanks()

◆ cleanup()

◆ cleanupAroundReplacements()

◆ closesBlockOrBlockTypeList()

◆ CodePointsBetween()

◆ computeNewlines()

◆ configurationAsText()

◆ continuesLineCommentSection()

◆ copyFrom()

◆ countLeadingWhitespace()

◆ endsWithSpace()

◆ expandPresetsBraceWrapping()

◆ expandPresetsSpaceBeforeParens()

◆ expandPresetsSpacesInParens()

◆ FindCursorIndex()

◆ findJavaImportGroup()

◆ findReturnTypeStart()

◆ fixNamespaceEndComments()

◆ forEachToken()

◆ format()

◆ formatReplacements()

◆ getBase()

◆ getCanonicalRawStringDelimiter()

◆ getChainLength()

◆ getChromiumStyle()

◆ getClangFormatStyle()

◆ getCommentSplit()

◆ getEnclosingFunctionName()

◆ getFormattingLangOpts()

◆ getFunctionName()

◆ getGNUStyle()

◆ getGoogleStyle()

◆ getLanguageByComment()

◆ getLanguageByFileName()

◆ getLanguageName()

◆ getLastLineEndColumn()

◆ getLastNonComment()

◆ getLengthToMatchingParen()

◆ getLengthToNextOperator()

◆ getLineCommentIndentPrefix()

◆ getLineStart()

◆ getLLVMStyle()

◆ getMicrosoftStyle()

◆ getMozillaStyle()

◆ getNamespaceToken() [1/2]

◆ getNamespaceToken() [2/2]

◆ getNamespaceTokenText()

◆ getNextNonComment()

◆ getNoStyle()

◆ getParseCategory()

◆ getPredefinedStyle()

◆ getPrevious()

◆ getPreviousNonComment()

◆ getPreviousOneOf()

◆ getRawStringDelimiter()

◆ getStringSplit()