Namespaces
namespace	encoding

namespace	internal

Classes
struct	AdditionalKeywords
	Encapsulates keywords that are context sensitive or for languages not properly supported by Clang's lexer. More...

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	CommaSeparatedList

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

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	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...

class	TokenRole

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_ImportStatement , LT_ObjCDecl , LT_ObjCMethodDecl , LT_ObjCProperty , LT_Other , LT_PreprocessorDirective , LT_VirtualFunctionDecl , LT_ArrayOfStructInitializer , LT_CommentAbovePPDirective }

enum	ScopeType { ST_Class , ST_Function , ST_Other }

Functions
const std::error_category &	getParseCategory ()

std::error_code	make_error_code (ParseError e)

FormatStyle	getLLVMStyle (FormatStyle::LanguageKind Language=FormatStyle::LanguageKind::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)
	Parse configuration from YAML-formatted text.

std::error_code	parseConfiguration (StringRef Config, FormatStyle *Style, bool AllowUnknownOptions=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`.

llvm::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.

llvm::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.

llvm::Expected< FormatStyle >	getStyle (StringRef StyleName, StringRef FileName, StringRef FallbackStyle, StringRef Code="", llvm::vfs::FileSystem *FS=nullptr, bool AllowUnknownOptions=false)
	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 bool	IsBlank (char C)

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	startsNextParameter (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 llvm::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 SmallVectorImpl< IncludeDirective > &Includes, const SmallVectorImpl< unsigned > &Indices, unsigned Cursor)

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

static void	sortCppIncludes (const FormatStyle &Style, const SmallVectorImpl< 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 SmallVectorImpl< 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 llvm::Expected< tooling::Replacements >	processReplacements (T ProcessFunc, StringRef Code, const tooling::Replacements &Replaces, const FormatStyle &Style)

static FormatStyle::LanguageKind	getLanguageByFileName (StringRef FileName)

llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > >	loadAndParseConfigFile (StringRef ConfigFile, llvm::vfs::FileSystem FS, FormatStyle Style, bool AllowUnknownOptions)

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	isLineComment (const FormatToken &FormatTok)

bool	continuesLineComment (const FormatToken &FormatTok, const FormatToken Previous, const FormatToken MinColumnToken)

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 (const StringRef IntegerLiteral)

template<typename T >
void	forEachToken (const UnwrappedLine &Line, const T &Call, FormatToken *Parent=nullptr)

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

StringRef	getNamespaceTokenText (const AnnotatedLine Line, const SmallVectorImpl< AnnotatedLine > &AnnotatedLines)

static bool	isObjCPropertyAttribute (const FormatToken *Tok)

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	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 *	getFunctionName (const AnnotatedLine &Line)

static bool	isCtorOrDtorName (const FormatToken *Tok)

static bool	isFunctionDeclarationName (bool IsCpp, const FormatToken &Current, const AnnotatedLine &Line, FormatToken *&ClosingParen)

static bool	isAllmanBrace (const FormatToken &Tok)

static bool	IsFunctionArgument (const FormatToken &Tok)

static bool	isItAnEmptyLambdaAllowed (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)

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)

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	isCOperatorFollowingVar (tok::TokenKind kind)

static bool	continuesLineCommentSection (const FormatToken &FormatTok, const UnwrappedLine &Line, const llvm::Regex &CommentPragmasRegex)

template<typename F >
static void	AlignTokenSequence (const FormatStyle &Style, unsigned Start, unsigned End, unsigned Column, bool RightJustify, F &&Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes)

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

static void	AlignMatchingTokenSequence (unsigned &StartOfSequence, unsigned &EndOfSequence, unsigned &MinColumn, std::function< bool(const WhitespaceManager::Change &C)> Matches, SmallVector< WhitespaceManager::Change, 16 > &Changes)

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 StringRef	Blanks = " \t\v\f\r"

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 195 of file FormatToken.h.

◆ FormatDecision

enum clang::format::FormatDecision

Enumerator
FD_Unformatted
FD_Continue
FD_Break

Definition at line 200 of file FormatToken.h.

◆ LexerState

enum clang::format::LexerState

Enumerator
NORMAL
TEMPLATE_STRING
TOKEN_STASHED

Definition at line 34 of file FormatTokenLexer.h.

◆ LineType

enum clang::format::LineType

Enumerator
LT_Invalid
LT_ImportStatement
LT_ObjCDecl
LT_ObjCMethodDecl
LT_ObjCProperty
LT_Other
LT_PreprocessorDirective
LT_VirtualFunctionDecl
LT_ArrayOfStructInitializer
LT_CommentAbovePPDirective

Definition at line 24 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 203 of file FormatToken.h.

◆ ParameterPackingKind

enum clang::format::ParameterPackingKind

Enumerator
PPK_BinPacked
PPK_OnePerLine
PPK_Inconclusive

Definition at line 198 of file FormatToken.h.

◆ ParseError

enum class clang::format::ParseError

strong

Enumerator
Success
Error
Unsuitable
BinPackTrailingCommaConflict
InvalidQualifierSpecified
DuplicateQualifierSpecified
MissingQualifierType
MissingQualifierOrder

Definition at line 35 of file Format.h.

◆ ScopeType

enum clang::format::ScopeType

Enumerator
ST_Class
ST_Function
ST_Other

Definition at line 37 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 184 of file FormatToken.h.

Function Documentation

◆ addQualifierAlignmentFixerPasses()

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

Definition at line 28 of file QualifierAlignmentFixer.cpp.

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

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

◆ affectsRange()

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

static

Definition at line 2994 of file Format.cpp.

Referenced by sortCppIncludes(), and sortJavaImports().

◆ AlignMatchingTokenSequence()

static void clang::format::AlignMatchingTokenSequence	(	unsigned &	StartOfSequence,
		unsigned &	EndOfSequence,
		unsigned &	MinColumn,
		std::function< bool(const WhitespaceManager::Change &C)>	Matches,
		SmallVector< WhitespaceManager::Change, 16 > &	Changes
	)

static

Definition at line 693 of file WhitespaceManager.cpp.

◆ AlignTokens()

template<typename F >

static 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 520 of file WhitespaceManager.cpp.

◆ AlignTokenSequence()

template<typename F >

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

static

Definition at line 281 of file WhitespaceManager.cpp.

References BK_BracedInit, clang::Column, clang::if(), clang::format::FormatStyle::PAS_Right, Previous, clang::format::FormatStyle::RAS_Pointer, and clang::format::FormatStyle::RAS_Right.

◆ 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 3797 of file Format.cpp.

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

Referenced by cleanupAroundReplacements().

◆ cleanupAroundReplacements()

llvm::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 3583 of file Format.cpp.

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

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

◆ CodePointsBetween()

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

static

Definition at line 182 of file FormatToken.cpp.

References Begin.

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

◆ computeNewlines()

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

static

Definition at line 1447 of file UnwrappedLineFormatter.cpp.

◆ configurationAsText()

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

Gets configuration in a YAML string.

Definition at line 2072 of file Format.cpp.

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

◆ continuesLineComment()

bool clang::format::continuesLineComment	(	const FormatToken &	FormatTok,
		const FormatToken *	Previous,
		const FormatToken *	MinColumnToken
	)

inline

Definition at line 1826 of file FormatToken.h.

Referenced by continuesLineCommentSection().

◆ continuesLineCommentSection()

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

static

Definition at line 4455 of file UnwrappedLineParser.cpp.

References continuesLineComment(), clang::format::FormatToken::is(), isLineComment(), clang::Line, Node, and clang::format::FormatToken::TokenText.

◆ countLeadingWhitespace()

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

static

Count the length of leading whitespace in a token.

Definition at line 989 of file FormatTokenLexer.cpp.

References Begin, and Text.

◆ endsWithSpace()

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

static

Definition at line 103 of file QualifierAlignmentFixer.cpp.

References s.

Referenced by rotateTokens().

◆ expandPresetsBraceWrapping()

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

static

Definition at line 1284 of file Format.cpp.

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

◆ expandPresetsSpaceBeforeParens()

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

static

Definition at line 1388 of file Format.cpp.

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

◆ expandPresetsSpacesInParens()

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

static

Definition at line 1417 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()

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

static

Definition at line 3013 of file Format.cpp.

References Text, and UINT_MAX.

Referenced by sortCppIncludes().

◆ findJavaImportGroup()

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

static

Definition at line 3268 of file Format.cpp.

References clang::format::FormatStyle::JavaImportGroups, and UINT_MAX.

Referenced by sortJavaImports().

◆ 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 3819 of file Format.cpp.

References Env, 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 Parent.

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

◆ formatReplacements()

llvm::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 3472 of file Format.cpp.

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

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

◆ getBase()

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

static

Definition at line 22 of file IntegerLiteralSeparatorFixer.cpp.

References Binary, Decimal, Hex, and Other.

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

◆ getCanonicalRawStringDelimiter()

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

static

Definition at line 188 of file ContinuationIndenter.cpp.

References clang::format::FormatStyle::RawStringFormats.

◆ 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 1772 of file Format.cpp.

Referenced by getPredefinedStyle().

◆ getClangFormatStyle()

FormatStyle clang::format::getClangFormatStyle ( )

Definition at line 1927 of file Format.cpp.

References getLLVMStyle(), clang::format::FormatStyle::InsertBraces, clang::format::FormatStyle::InsertNewlineAtEOF, clang::format::FormatStyle::LE_LF, clang::format::FormatStyle::LineEnding, clang::format::FormatStyle::RemoveBracesLLVM, clang::format::FormatStyle::RemoveParentheses, and clang::format::FormatStyle::RPS_ReturnStatement.

Referenced by getPredefinedStyle().

◆ getCommentSplit()

static 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 68 of file BreakableToken.cpp.

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

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

◆ getEnclosingFunctionName()

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

static

Definition at line 2210 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::getPreviousNonComment(), clang::format::FormatToken::MatchingParen, and clang::format::FormatToken::TokenText.

◆ 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 3839 of file Format.cpp.

References clang::format::FormatStyle::isCpp(), 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_Latest, and clang::format::FormatStyle::Standard.

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

◆ getFunctionName()

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

static

Definition at line 3154 of file TokenAnnotator.cpp.

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

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 1882 of file Format.cpp.

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 1631 of file Format.cpp.

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

◆ getLanguageByFileName()

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

static

Definition at line 3884 of file Format.cpp.

References clang::FileName, 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 5193 of file Format.h.

References 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()

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

static

Definition at line 1977 of file ContinuationIndenter.cpp.

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

◆ getLastNonComment()

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

static

Definition at line 2620 of file UnwrappedLineParser.cpp.

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

◆ getLengthToMatchingParen()

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

static

Definition at line 49 of file ContinuationIndenter.cpp.

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

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

◆ getLengthToNextOperator()

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

static

Definition at line 119 of file ContinuationIndenter.cpp.

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

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

◆ getLineCommentIndentPrefix()

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

static

Definition at line 42 of file BreakableToken.cpp.

References clang::format::FormatStyle::Language, and clang::format::FormatStyle::LK_TextProto.

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

◆ getLLVMStyle()

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

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

Definition at line 1425 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 1897 of file Format.cpp.

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 1832 of file Format.cpp.

Referenced by getPredefinedStyle().

◆ getNamespaceToken()

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

Definition at line 248 of file NamespaceEndCommentsFixer.cpp.

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

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

◆ 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().

◆ getNoStyle()

FormatStyle clang::format::getNoStyle ( )

Returns style indicating formatting should be not applied at all.

Definition at line 1937 of file Format.cpp.

References clang::format::FormatStyle::DisableFormat, getLLVMStyle(), clang::format::FormatStyle::SI_Never, 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 1245 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 1945 of file Format.cpp.

References getChromiumStyle(), getClangFormatStyle(), getGNUStyle(), getGoogleStyle(), getLLVMStyle(), getMicrosoftStyle(), getMozillaStyle(), getNoStyle(), getWebKitStyle(), clang::format::FormatStyle::InheritsParentConfig, and clang::format::FormatStyle::Language.

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

◆ getRawStringDelimiter()

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

static

Definition at line 162 of file ContinuationIndenter.cpp.

◆ getStringSplit()

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

static

Definition at line 171 of file BreakableToken.cpp.

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

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

◆ getStyle()

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

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 3954 of file Format.cpp.

References clang::FileName, getLanguageName(), getLLVMStyle(), getNoStyle(), getPredefinedStyle(), guessLanguage(), clang::format::FormatStyle::InheritsParentConfig, clang::format::FormatStyle::Language, loadAndParseConfigFile(), make_string_error(), clang::format::FormatStyle::parseConfiguration, 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 24 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 1858 of file Format.cpp.

Referenced by getPredefinedStyle().

◆ guessLanguage()

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

Definition at line 3919 of file Format.cpp.

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

Referenced by getStyle().

◆ hash_combine()

template<class T >

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

inlinestatic

Definition at line 655 of file UnwrappedLineParser.cpp.

References v.

◆ hasNestedBlockInlined()

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

static

Definition at line 1443 of file ContinuationIndenter.cpp.

References clang::format::FormatStyle::BraceWrappingFlags::BeforeLambdaBody, clang::format::FormatStyle::BraceWrapping, clang::format::FormatToken::is(), and Previous.

◆ insertQualifierAfter()

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

static

Definition at line 77 of file QualifierAlignmentFixer.cpp.

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

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

◆ insertQualifierBefore()

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

static

Definition at line 90 of file QualifierAlignmentFixer.cpp.

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

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

◆ isAllmanBrace()

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

static

Definition at line 4945 of file TokenAnnotator.cpp.

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

◆ isAllmanLambdaBrace()

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

static

Definition at line 4962 of file TokenAnnotator.cpp.

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

◆ IsBlank()

static bool clang::format::IsBlank ( char C )

static

Definition at line 29 of file BreakableToken.cpp.

References clang::C.

Referenced by getStringSplit().

◆ isC78ParameterDecl()

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

static

Definition at line 1283 of file UnwrappedLineParser.cpp.

References isC78Type(), clang::format::FormatToken::isNot(), clang::format::FormatToken::isOneOf(), and clang::format::FormatToken::Previous.

◆ isC78Type()

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

static

Definition at line 1270 of file UnwrappedLineParser.cpp.

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

Referenced by isC78ParameterDecl().

◆ isClangFormatOff()

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

Definition at line 4133 of file Format.cpp.

References isClangFormatOnOff().

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

◆ isClangFormatOn()

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

Definition at line 4129 of file Format.cpp.

References isClangFormatOnOff().

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

◆ isClangFormatOnOff()

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

static

Definition at line 4117 of file Format.cpp.

Referenced by isClangFormatOff(), and isClangFormatOn().

◆ isConfiguredQualifier()

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

static

Definition at line 156 of file QualifierAlignmentFixer.cpp.

References clang::Token::getKind(), and clang::format::FormatToken::Tok.

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

◆ isCOperatorFollowingVar()

static bool clang::format::isCOperatorFollowingVar ( tok::TokenKind kind )

static

Definition at line 3238 of file UnwrappedLineParser.cpp.

◆ isCtorOrDtorName()

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

static

Definition at line 3212 of file TokenAnnotator.cpp.

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

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

◆ IsFunctionArgument()

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

static

Definition at line 4951 of file TokenAnnotator.cpp.

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

◆ isFunctionDeclarationName()

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

static

Definition at line 3273 of file TokenAnnotator.cpp.

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

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

◆ isGoogScope()

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

static

Definition at line 906 of file UnwrappedLineParser.cpp.

References clang::Line.

◆ isIIFE()

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

static

Definition at line 924 of file UnwrappedLineParser.cpp.

References clang::format::AdditionalKeywords::kw_function, and clang::Line.

◆ isItAnEmptyLambdaAllowed()

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

static

Definition at line 4957 of file TokenAnnotator.cpp.

References clang::format::FormatToken::Children, and clang::format::FormatStyle::SLS_None.

◆ isJSDeclOrStmt()

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

static

Definition at line 1250 of file UnwrappedLineParser.cpp.

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

◆ isLikelyXml()

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

Definition at line 3429 of file Format.cpp.

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

◆ isLineComment()

bool clang::format::isLineComment ( const FormatToken & FormatTok )

inline

Definition at line 1819 of file FormatToken.h.

Referenced by continuesLineCommentSection().

◆ isMpegTS()

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

Definition at line 3422 of file Format.cpp.

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

◆ isObjCPropertyAttribute()

static bool clang::format::isObjCPropertyAttribute ( const FormatToken * Tok )

static

Definition at line 40 of file ObjCPropertyAttributeOrderFixer.cpp.

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

◆ isQualifier()

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

static

Definition at line 161 of file QualifierAlignmentFixer.cpp.

References clang::Token::getKind(), and clang::format::FormatToken::Tok.

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

◆ lexCSharpString()

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

static

Definition at line 645 of file FormatTokenLexer.cpp.

References Begin.

◆ loadAndParseConfigFile()

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

Definition at line 3943 of file Format.cpp.

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

Referenced by getStyle().

◆ make_error_code()

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

Definition at line 1249 of file Format.cpp.

References getParseCategory().

◆ make_string_error()

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

inline

Definition at line 1253 of file Format.cpp.

Referenced by getStyle().

◆ markOptionalBraces()

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

static

Definition at line 2668 of file UnwrappedLineParser.cpp.

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

◆ maxNestingDepth()

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

static

Definition at line 3145 of file TokenAnnotator.cpp.

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

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

◆ mayReflowContent()

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

static

Definition at line 450 of file BreakableToken.cpp.

References Blanks, and clang::isPunctuation().

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

◆ mustBeJSIdent()

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

static

Definition at line 1226 of file UnwrappedLineParser.cpp.

Referenced by mustBeJSIdentOrValue().

◆ mustBeJSIdentOrValue()

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

static

Definition at line 1241 of file UnwrappedLineParser.cpp.

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

◆ mustBreakAfterAttributes()

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

static

Definition at line 27 of file TokenAnnotator.cpp.

References clang::format::FormatStyle::ABS_Always, clang::format::FormatStyle::ABS_Leave, clang::format::FormatStyle::BreakAfterAttributes, and clang::format::FormatToken::NewlinesBefore.

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

◆ opensProtoMessageField()

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

static

Definition at line 149 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::is(), clang::format::FormatToken::isNot(), clang::format::FormatStyle::Language, clang::format::FormatStyle::LK_Proto, clang::format::FormatStyle::LK_TextProto, 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 105 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.

◆ 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`
	)

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 2006 of file Format.cpp.

Referenced by parseConfiguration().

◆ parseConfiguration() [2/2]

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

inline

Like above but accepts an unnamed buffer.

Definition at line 5021 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 577 of file QualifierAlignmentFixer.cpp.

References clang::format::LeftRightQualifierAlignmentFixer::getTokenFromQualifier(), and s.

Referenced by addQualifierAlignmentFixerPasses().

◆ processReplacements()

template<typename T >

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

static

Definition at line 3453 of file Format.cpp.

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

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 3809 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 3786 of file Format.cpp.

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

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

◆ removeToken()

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

static

Definition at line 69 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 3034 of file Format.cpp.

Referenced by sortCppIncludes(), and sortJavaImports().

◆ replaceToken()

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

static

Definition at line 57 of file QualifierAlignmentFixer.cpp.

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

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

◆ rotateTokens()

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

static

Definition at line 115 of file QualifierAlignmentFixer.cpp.

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

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.

◆ ShouldBreakBeforeBrace()

static bool clang::format::ShouldBreakBeforeBrace	(	const FormatStyle &	Style,
		const FormatToken &	InitialToken
	)

static

Definition at line 942 of file UnwrappedLineParser.cpp.

References clang::format::FormatStyle::BraceWrappingFlags::AfterClass, clang::format::FormatStyle::BraceWrappingFlags::AfterEnum, clang::format::FormatStyle::BraceWrappingFlags::AfterNamespace, clang::format::FormatStyle::BraceWrappingFlags::AfterStruct, clang::format::FormatStyle::BraceWrappingFlags::AfterUnion, clang::format::FormatStyle::BraceWrapping, clang::Token::getKind(), clang::format::FormatToken::is(), and clang::format::FormatToken::Tok.

◆ shouldIndentWrappedSelectorName()

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

static

Definition at line 34 of file ContinuationIndenter.cpp.

References clang::format::FormatStyle::IndentWrappedFunctionNames, and LT_ObjCMethodDecl.

◆ shouldUnindentNextOperator()

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

static

Definition at line 41 of file ContinuationIndenter.cpp.

References clang::prec::Assignment, clang::format::FormatToken::getPreviousNonComment(), and Previous.

◆ sortCppIncludes() [1/2]

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

static

Definition at line 3062 of file Format.cpp.

References clang::tooling::Replacements::add(), affectsRange(), clang::FileName, Filename, FindCursorIndex(), clang::tooling::IncludeStyle::IBS_Preserve, clang::tooling::IncludeStyle::IBS_Regroup, clang::tooling::IncludeStyle::IncludeBlocks, clang::format::FormatStyle::IncludeStyle, Priority, replaceCRLF(), clang::format::FormatStyle::SI_CaseInsensitive, and clang::format::FormatStyle::SortIncludes.

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 3160 of file Format.cpp.

References Category, clang::FileName, clang::tooling::IncludeCategoryManager::getIncludePriority(), clang::tooling::IncludeCategoryManager::getSortIncludePriority(), clang::tooling::IncludeStyle::IBS_Merge, clang::tooling::IncludeStyle::IBS_Regroup, clang::tooling::IncludeStyle::IncludeBlocks, clang::tooling::HeaderIncludes::IncludeRegex, clang::format::FormatStyle::IncludeStyle, isClangFormatOff(), isClangFormatOn(), clang::Line, clang::ast_matchers::match(), Priority, 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 3431 of file Format.cpp.

References clang::format::FormatStyle::DisableFormat, clang::FileName, isLikelyXml(), isMpegTS(), clang::format::FormatStyle::Language, clang::format::FormatStyle::LK_Java, clang::format::FormatStyle::LK_JavaScript, sortCppIncludes(), clang::format::FormatStyle::SortIncludes, sortJavaImports(), and sortJavaScriptImports().

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

◆ sortJavaImports() [1/2]

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

static

Definition at line 3288 of file Format.cpp.

References clang::tooling::Replacements::add(), affectsRange(), AssociatedCommentLines, clang::FileName, findJavaImportGroup(), Identifier, IsStatic, clang::format::FormatStyle::JavaImportGroups, replaceCRLF(), clang::format::FormatStyle::SJSIO_After, and clang::format::FormatStyle::SortJavaStaticImport.

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 3370 of file Format.cpp.

References AssociatedCommentLines, clang::FileName, Identifier, isClangFormatOff(), isClangFormatOn(), IsStatic, 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 591 of file SortJavaScriptImports.cpp.

References Env, 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 3829 of file Format.cpp.

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

◆ startsNextParameter()

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

static

Definition at line 132 of file ContinuationIndenter.cpp.

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

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

◆ startsSegmentOfBuilderTypeCall()

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

static

Definition at line 127 of file ContinuationIndenter.cpp.

References clang::format::FormatToken::closesScope(), clang::format::FormatToken::isMemberAccess(), and clang::format::FormatToken::Previous.

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

◆ startsWithSpace()

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

static

Definition at line 109 of file QualifierAlignmentFixer.cpp.

References s.

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 219 of file BreakableToken.cpp.

References clang::Token::is().

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

◆ tokenCanStartNewLine()

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

static

Definition at line 1204 of file UnwrappedLineParser.cpp.

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

◆ validateQualifierOrder()

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

Definition at line 1974 of file Format.cpp.

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

Variable Documentation

◆ Blanks

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

staticconstexpr

Definition at line 28 of file BreakableToken.cpp.

Referenced by clang::format::BreakableBlockComment::adaptStartOfLine(), clang::format::BreakableLineCommentSection::BreakableLineCommentSection(), getCommentSplit(), clang::format::BreakableBlockComment::getContentIndent(), clang::format::BreakableBlockComment::getReflowSplit(), clang::format::BreakableLineCommentSection::getReflowSplit(), clang::format::BreakableBlockComment::getSplitAfterLastLine(), clang::format::BreakableBlockComment::introducesBreakBeforeToken(), clang::format::BreakableBlockComment::mayReflow(), mayReflowContent(), and clang::format::BreakableBlockComment::reflow().

◆ 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 3940 of file Format.cpp.

◆ 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 3938 of file Format.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 3869 of file Format.cpp.

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()

◆ AlignMatchingTokenSequence()

◆ AlignTokens()

◆ AlignTokenSequence()

◆ cleanup()

◆ cleanupAroundReplacements()

◆ CodePointsBetween()

◆ computeNewlines()

◆ configurationAsText()

◆ continuesLineComment()

◆ continuesLineCommentSection()

◆ countLeadingWhitespace()

◆ endsWithSpace()

◆ expandPresetsBraceWrapping()

◆ expandPresetsSpaceBeforeParens()

◆ expandPresetsSpacesInParens()

◆ FindCursorIndex()

◆ findJavaImportGroup()

◆ fixNamespaceEndComments()

◆ forEachToken()

◆ formatReplacements()

◆ getBase()

◆ getCanonicalRawStringDelimiter()

◆ getChromiumStyle()

◆ getClangFormatStyle()

◆ getCommentSplit()

◆ getEnclosingFunctionName()

◆ getFormattingLangOpts()

◆ getFunctionName()

◆ getGNUStyle()

◆ getGoogleStyle()

◆ getLanguageByFileName()

◆ getLanguageName()

◆ getLastLineEndColumn()

◆ getLastNonComment()

◆ getLengthToMatchingParen()

◆ getLengthToNextOperator()

◆ getLineCommentIndentPrefix()

◆ getLLVMStyle()

◆ getMicrosoftStyle()

◆ getMozillaStyle()

◆ getNamespaceToken()

◆ getNamespaceTokenText()

◆ getNoStyle()

◆ getParseCategory()

◆ getPredefinedStyle()

◆ getRawStringDelimiter()

◆ getStringSplit()

◆ getStyle()

◆ getTokenTypeName()

◆ getWebKitStyle()

◆ guessLanguage()

◆ hash_combine()

◆ hasNestedBlockInlined()

◆ insertQualifierAfter()

◆ insertQualifierBefore()

◆ isAllmanBrace()

◆ isAllmanLambdaBrace()

◆ IsBlank()