This file implements functions declared in Format.h. More...

#include "clang/Format/Format.h"
#include "AffectedRangeManager.h"
#include "BreakableToken.h"
#include "ContinuationIndenter.h"
#include "DefinitionBlockSeparator.h"
#include "FormatInternal.h"
#include "FormatToken.h"
#include "FormatTokenLexer.h"
#include "IntegerLiteralSeparatorFixer.h"
#include "NamespaceEndCommentsFixer.h"
#include "QualifierAlignmentFixer.h"
#include "SortJavaScriptImports.h"
#include "TokenAnalyzer.h"
#include "TokenAnnotator.h"
#include "UnwrappedLineFormatter.h"
#include "UnwrappedLineParser.h"
#include "UsingDeclarationsSorter.h"
#include "WhitespaceManager.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticOptions.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Lexer.h"
#include "clang/Tooling/Inclusions/HeaderIncludes.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/Sequence.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Allocator.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/Regex.h"
#include "llvm/Support/VirtualFileSystem.h"
#include "llvm/Support/YAMLTraits.h"
#include <algorithm>
#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <unordered_map>

Include dependency graph for Format.cpp:

Go to the source code of this file.

Classes
struct	llvm::yaml::MappingTraits< FormatStyle::AlignConsecutiveStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::AttributeBreakingStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ArrayInitializerAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BinaryOperatorStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BinPackStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BitFieldColonSpacingStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BraceBreakingStyle >

struct	llvm::yaml::MappingTraits< FormatStyle::BraceWrappingFlags >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BracketAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BraceWrappingAfterControlStatementStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BreakBeforeConceptDeclarationsStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BreakBeforeInlineASMColonStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BreakConstructorInitializersStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BreakInheritanceListStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::BreakTemplateDeclarationsStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::DefinitionReturnTypeBreakingStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::EscapedNewlineAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::EmptyLineAfterAccessModifierStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::EmptyLineBeforeAccessModifierStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::IndentExternBlockStyle >

struct	llvm::yaml::MappingTraits< FormatStyle::IntegerLiteralSeparatorStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::JavaScriptQuoteStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::LanguageKind >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::LanguageStandard >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::LambdaBodyIndentationKind >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::LineEndingStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::NamespaceIndentationKind >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::OperandAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::PackConstructorInitializersStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::PointerAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::PPDirectiveIndentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::QualifierAlignmentStyle >

struct	llvm::yaml::MappingTraits< FormatStyle::RawStringFormat >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ReferenceAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::RequiresClausePositionStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::RequiresExpressionIndentationKind >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ReturnTypeBreakingStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SeparateDefinitionStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ShortBlockStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ShortFunctionStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ShortIfStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::ShortLambdaStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SortIncludesOptions >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SortJavaStaticImportOptions >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SortUsingDeclarationsOptions >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SpaceAroundPointerQualifiersStyle >

struct	llvm::yaml::MappingTraits< FormatStyle::SpaceBeforeParensCustom >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SpaceBeforeParensStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::SpacesInAnglesStyle >

struct	llvm::yaml::MappingTraits< FormatStyle::SpacesInLineComment >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::TrailingCommaStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::TrailingCommentsAlignmentKinds >

struct	llvm::yaml::MappingTraits< FormatStyle::TrailingCommentsAlignmentStyle >

struct	llvm::yaml::ScalarEnumerationTraits< FormatStyle::UseTabStyle >

struct	llvm::yaml::MappingTraits< FormatStyle >

struct	llvm::yaml::DocumentListTraits< std::vector< FormatStyle > >

Namespaces
namespace	llvm
	YAML serialization mapping.

namespace	llvm::yaml

namespace	clang

namespace	clang::format

namespace	clang::format::internal

Macros
#define	DEBUG_TYPE "format-formatter"

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

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

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

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

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

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.

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.

FormatStyle	clang::format::getChromiumStyle (FormatStyle::LanguageKind Language)
	Returns a format style complying with Chromium's style guide: http://www.chromium.org/developers/coding-style.

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.

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

FormatStyle	clang::format::getGNUStyle ()
	Returns a format style complying with GNU Coding Standards: http://www.gnu.org/prep/standards/standards.html.

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.

FormatStyle	clang::format::getNoStyle ()
	Returns style indicating formatting should be not applied at all.

bool	clang::format::getPredefinedStyle (StringRef Name, FormatStyle::LanguageKind Language, FormatStyle *Style)
	Gets a predefined style for the specified language by name.

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

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.

std::string	clang::format::configurationAsText (const FormatStyle &Style)
	Gets configuration in a YAML string.

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

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

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

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)

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

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

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

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

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

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

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

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

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.

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.

std::pair< tooling::Replacements, unsigned >	clang::format::internal::reformat (const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, unsigned FirstStartColumn, unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName, FormattingAttemptStatus *Status)
	Reformats the given `Ranges` in the code fragment `Code`.

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

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

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.

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

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

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

LangOptions	clang::format::getFormattingLangOpts (const FormatStyle &Style=getLLVMStyle())
	Returns the `LangOpts` that the formatter expects you to set.

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

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

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

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

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

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

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