This is an archive of the discontinued LLVM Phabricator instance.

Differential D152051

libclang-cpp: Add external visibility attribute to all classes
Needs ReviewPublic

Authored by tstellar on Jun 2 2023, 7:42 PM.

Details

Reviewers
sscalpone
aaron.ballman
NoQ
ributzka
njames93
rymiel
HazardyKnusperkeks
owenpan
MyDeveloperDay
dang
Summary

Also compile with -fvisiblity=hidden. This in theory should be NFC,
but it's possible I missed adding LLVM_EXTERNAL_VISIBILITY to some of
the symbols. This is the first step towards reducing the amount of
public symbols exposed in libclang-cpp.so, so in the future we will
be dropping LLVM_EXTERNAL_VISIBILITY from classes and functions that
we don't want to make publicly available.

Before and after symbol counts:

$ nm -gD before/libclang-cpp.so | wc -l
30459
$ nm -gD after/libclang-cpp.so | wc -l
20875

Diff Detail

Event Timeline

tstellar created this revision.Jun 2 2023, 7:42 PM
Herald added a reviewer: sscalpone. · View Herald TranscriptJun 2 2023, 7:42 PM
Herald added a reviewer: aaron.ballman. · View Herald Transcript
Herald added a reviewer: NoQ. · View Herald Transcript
Herald added a reviewer: ributzka. · View Herald Transcript
Herald added a reviewer: njames93. · View Herald Transcript
Herald added projects: Restricted Project, Restricted Project, Restricted Project. · View Herald Transcript
Herald added reviewers: rymiel, HazardyKnusperkeks, owenpan, MyDeveloperDay. · View Herald Transcript
Herald added subscribers: cfe-commits, PiotrZSL, luke and 28 others. · View Herald Transcript
tstellar requested review of this revision.Jun 2 2023, 7:42 PM
Herald added a reviewer: dang. · View Herald TranscriptJun 2 2023, 7:42 PM
Herald added projects: Restricted Project, Restricted Project. · View Herald Transcript
Herald added subscribers: • pcwang-thead, MaskRay. · View Herald Transcript
NOTE: Clang-Format Team Automated Review Comment

Your review contains a change to clang/include/clang/Format/Format.h but does not contain an update to ClangFormatStyleOptions.rst

ClangFormatStyleOptions.rst is generated via clang/docs/tools/dump_format_style.py, please run this to regenerate the .rst

You can validate that the rst is valid by running.

./docs/tools/dump_format_style.py
mkdir -p html
/usr/bin/sphinx-build -n ./docs ./html
Herald added a comment. · View Herald TranscriptJun 2 2023, 7:42 PM
NOTE: Clang-Format Team Automated Review Comment

It looks like your clang-format review does not contain any unit tests, please try to ensure all code changes have a unit test (unless this is an NFC or refactoring, adding documentation etc..)

Add your unit tests in clang/unittests/Format and you can build with ninja FormatTests. We recommend using the verifyFormat(xxx) format of unit tests rather than EXPECT_EQ as this will ensure you change is tolerant to random whitespace changes (see FormatTest.cpp as an example)

For situations where your change is altering the TokenAnnotator.cpp which can happen if you are trying to improve the annotation phase to ensure we are correctly identifying the type of a token, please add a token annotator test in TokenAnnotatorTest.cpp

Harbormaster completed remote builds in B236341: Diff 528068.Jun 2 2023, 7:43 PM
tstellar added a parent revision: D152043: [Support] Use C++11 attribute syntax for visibility attributes.Jun 2 2023, 8:07 PM

I was not sure what to do with inline functions and also functions that were implemented in the headers, so I did not add the LLVM_EXTERNAL_VISIBILITY macro to most of those functions.

HazardyKnusperkeks added inline comments.Jun 3 2023, 7:21 AM
clang/include/clang/Format/Format.h
4532

This doesn't look formatted.

compnerd added a subscriber: compnerd.Jun 7 2023, 7:00 AM
In D152051#4392612, @tstellar wrote:

I was not sure what to do with inline functions and also functions that were implemented in the headers, so I did not add the LLVM_EXTERNAL_VISIBILITY macro to most of those functions.

I think that inline functions should have the attribute applied as well. That should be the equivalent of -fvisibility-inlines-hidden and should allow this to be useable for windows as well.

Please do not use LLVM_EXTERNAL_VISIBILITY but rather introduce a new macro (this will prevent the use on Windows).

I did write a tool to help with this: https://GitHub.com/compnerd/ids

tstellar added a comment.Jun 7 2023, 7:18 AM

! In D152051#4403167, @compnerd wrote:
Please do not use LLVM_EXTERNAL_VISIBILITY but rather introduce a new macro (this will prevent the use on Windows).

OK, so should I create a clang specific macro for this? And should it behave the same as LLVM_EXTERNAL_VISIBILITLY or do I need to have it expand to different values depending on the OS?

I did write a tool to help with this: https://GitHub.com/compnerd/ids

OK, thanks, I will check this out.

clang/include/clang/Format/Format.h
4532

I ran git-clang-format on the patch and it introduced a lot of unrelated changes, so I ended up dropping that part of the patch. I can go through and manually discard some of the more intrusive format changes. Any suggestions on which kind of formatting changes to keep and which ones to ignore?

aaron.ballman added subscribers: majnemer, rnk.Jun 8 2023, 6:19 AM

I seem to recall this came up in the past and there were issues, so I did some digging around our mail archives and figured I'd share what I found:

https://discourse.llvm.org/t/big-clang-dll-plug-in-mechanism-revision/19376/5
https://discourse.llvm.org/t/distributing-libclang-cpp-dll-for-windows-in-the-pre-built-downloads/54778
https://lists.llvm.org/pipermail/llvm-dev/2017-June/113925.html

However, those concerns seem to be more around dllexport behavior on Windows, so LLVM_LIBRARY_VISIBILITY shouldn't matter there.

CC @rnk @majnemer @compnerd for confirmation that we shouldn't also be thinking about Windows symbol exports.

tstellar added a comment.Jun 8 2023, 6:23 AM

I chatted with @compnerd on Discord, and I'm going to try to update D109192 and get that committed and then come back to this patch.

Large Diff

This large diff affects 490 files. Files without inline comments have been collapsed. Expand All Files

Revision Contents

PathSize
clang-tools-extra/
clang-tidy/
2 lines
4 lines
clang/
11 lines
include/
clang-c/
5 lines
clang/
APINotes/
2 lines
26 lines
ARCMigrate/
14 lines
10 lines
2 lines
AST/
8 lines
8 lines
4 lines
8 lines
9 lines
4 lines
2 lines
4 lines
2 lines
4 lines
2 lines
2 lines
2 lines
2 lines
2 lines
40 lines
4 lines
2 lines
2 lines
2 lines
18 lines
2 lines
2 lines
2 lines
2 lines
12 lines
56 lines
4 lines
32 lines
2 lines
4 lines
4 lines
2 lines
2 lines
6 lines
4 lines
168 lines
4 lines
2 lines
68 lines
2 lines
30 lines
62 lines
6 lines
4 lines
4 lines
2 lines
36 lines
14 lines
58 lines
2 lines
26 lines
4 lines
4 lines
6 lines
120 lines
116 lines
12 lines
32 lines
8 lines
2 lines
6 lines
26 lines
2 lines
6 lines
2 lines
2 lines
2 lines
8 lines
2 lines
2 lines
6 lines
6 lines
2 lines
2 lines
4 lines
208 lines
2 lines
4 lines
6 lines
2 lines
4 lines
4 lines
4 lines
4 lines
2 lines
2 lines
6 lines
8 lines
56 lines
10 lines
4 lines
8 lines
12 lines
146 lines
2 lines
6 lines
12 lines
16 lines
4 lines
160 lines
198 lines
2 lines
4 lines
2 lines
4 lines
4 lines
14 lines
ASTMatchers/
4 lines
448 lines
80 lines
16 lines
Dynamic/
2 lines
2 lines
4 lines
6 lines
16 lines
Analysis/
Analyses/
2 lines
6 lines
8 lines
4 lines
4 lines
4 lines
2 lines
6 lines
8 lines
10 lines
14 lines
74 lines
18 lines
6 lines
6 lines
6 lines
14 lines
2 lines
2 lines
42 lines
2 lines
4 lines
22 lines
4 lines
34 lines
DomainSpecific/
8 lines
2 lines
FlowSensitive/
2 lines
2 lines
2 lines
4 lines
8 lines
6 lines
2 lines
8 lines
12 lines
2 lines
2 lines
Models/
2 lines
4 lines
2 lines
2 lines
2 lines
6 lines
4 lines
6 lines
30 lines
2 lines
4 lines
2 lines
28 lines
58 lines
14 lines
Support/
4 lines
Basic/
1 line
2 lines
2 lines
2 lines
8 lines
2 lines
4 lines
2 lines
2 lines
22 lines
2 lines
4 lines
2 lines
4 lines
4 lines
6 lines
2 lines
2 lines
4 lines
14 lines
8 lines
2 lines
2 lines
6 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
22 lines
14 lines
12 lines
22 lines
2 lines
2 lines
6 lines
2 lines
2 lines
2 lines
2 lines
12 lines
16 lines
2 lines
6 lines
2 lines
CodeGen/
8 lines
36 lines
14 lines
6 lines
2 lines
4 lines
4 lines
2 lines
CrossTU/
12 lines
DirectoryWatcher/
2 lines
Driver/
52 lines
2 lines
2 lines
8 lines
2 lines
8 lines
8 lines
4 lines
6 lines
2 lines
4 lines
2 lines
2 lines
4 lines
48 lines
2 lines
Edit/
2 lines
2 lines
2 lines
2 lines
ExtractAPI/
44 lines
4 lines
2 lines
6 lines
2 lines
2 lines
Serialization/
2 lines
2 lines
Format/
64 lines
Frontend/
8 lines
2 lines
2 lines
2 lines
18 lines
2 lines
4 lines
10 lines
50 lines
6 lines
2 lines
2 lines
4 lines
10 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
2 lines
18 lines
2 lines
FrontendTool/
2 lines
Index/
2 lines
2 lines
26 lines
14 lines
32 lines
IndexSerialization/
6 lines
Interpreter/
4 lines
Lex/
2 lines
8 lines
2 lines
2 lines
4 lines
6 lines
2 lines
2 lines
6 lines
2 lines
14 lines
6 lines
4 lines
2 lines
4 lines
2 lines
6 lines
22 lines
8 lines
2 lines
2 lines
2 lines
2 lines
2 lines
Parse/
4 lines
2 lines
Rewrite/
Core/
4 lines
2 lines
4 lines
2 lines
Frontend/
4 lines
14 lines
Sema/
2 lines
2 lines
2 lines
32 lines
2 lines
14 lines
6 lines
4 lines
2 lines
2 lines
2 lines
2 lines
4 lines
6 lines
2 lines
4 lines
8 lines
2 lines
2 lines
14 lines
6 lines
2 lines
2 lines
10 lines
8 lines
2 lines
12 lines
2 lines
Serialization/
4 lines
2 lines
10 lines
2 lines
2 lines
4 lines
2 lines
2 lines
2 lines
4 lines
6 lines
2 lines
10 lines
6 lines
StaticAnalyzer/
Checkers/
2 lines
Core/
2 lines
BugReporter/
24 lines
26 lines
4 lines
22 lines
56 lines
4 lines
8 lines
PathSensitive/
2 lines
2 lines
8 lines
2 lines
4 lines
34 lines
2 lines
18 lines
8 lines
14 lines
2 lines
2 lines
6 lines
6 lines
2 lines
2 lines
82 lines
6 lines
4 lines
6 lines
2 lines
2 lines
2 lines
34 lines
2 lines
4 lines
2 lines
6 lines
4 lines
24 lines
4 lines
Frontend/
4 lines
10 lines
2 lines
4 lines
2 lines
Support/
8 lines
Testing/
2 lines
Tooling/
ASTDiff/
6 lines
6 lines
14 lines
4 lines
14 lines
2 lines
Core/
10 lines
20 lines
DependencyScanning/
10 lines
2 lines
6 lines
6 lines
4 lines
14 lines
2 lines
2 lines
Inclusions/
6 lines
4 lines
6 lines
2 lines
26 lines
4 lines
Refactoring/
6 lines
6 lines
Extract/
2 lines
2 lines
2 lines
4 lines
4 lines
12 lines
4 lines
2 lines
2 lines
4 lines
2 lines
2 lines
Rename/
8 lines
2 lines
2 lines
3 lines
4 lines
12 lines
2 lines
Syntax/
12 lines
4 lines
96 lines
2 lines
2 lines
24 lines
10 lines
32 lines
Transformer/
2 lines
26 lines
48 lines
12 lines
20 lines
28 lines
4 lines
lib/
Analysis/
plugins/
CheckerDependencyHandling/
4 lines
CheckerOptionHandling/
4 lines
SampleAnalyzer/
4 lines
Format/
2 lines
2 lines
5 lines
4 lines
2 lines
2 lines
Tooling/
2 lines
utils/
TableGen/
2 lines
llvm/
include/
llvm/
Support/
4 lines

Diff 528068

clang-tools-extra/clang-tidy/ClangTidyCheck.h

clang-tools-extra/clang-tidy/ClangTidyModule.h

clang/CMakeLists.txt

clang/include/clang-c/FatalErrorHandler.h

clang/include/clang/APINotes/APINotesYAMLCompiler.h

clang/include/clang/APINotes/Types.h

clang/include/clang/ARCMigrate/ARCMT.h

clang/include/clang/ARCMigrate/ARCMTActions.h

clang/include/clang/ARCMigrate/FileRemapper.h

clang/include/clang/AST/APValue.h

clang/include/clang/AST/ASTConcept.h

clang/include/clang/AST/ASTConsumer.h

clang/include/clang/AST/ASTContext.h

clang/include/clang/AST/ASTContextAllocate.h

clang/include/clang/AST/ASTDiagnostic.h

clang/include/clang/AST/ASTDumper.h

clang/include/clang/AST/ASTDumperUtils.h

clang/include/clang/AST/ASTImportError.h

clang/include/clang/AST/ASTImporter.h

clang/include/clang/AST/ASTImporterLookupTable.h

clang/include/clang/AST/ASTImporterSharedState.h

clang/include/clang/AST/ASTMutationListener.h

clang/include/clang/AST/ASTNodeTraverser.h

clang/include/clang/AST/ASTStructuralEquivalence.h

clang/include/clang/AST/ASTTypeTraits.h

clang/include/clang/AST/ASTUnresolvedSet.h

clang/include/clang/AST/ASTVector.h

clang/include/clang/AST/AbstractBasicReader.h

clang/include/clang/AST/AbstractBasicWriter.h

clang/include/clang/AST/Attr.h

clang/include/clang/AST/AttrIterator.h

clang/include/clang/AST/AttrVisitor.h

clang/include/clang/AST/Availability.h

clang/include/clang/AST/BaseSubobject.h

clang/include/clang/AST/CXXInheritance.h

clang/include/clang/AST/CanonicalType.h

clang/include/clang/AST/CharUnits.h

clang/include/clang/AST/Comment.h

clang/include/clang/AST/CommentBriefParser.h

clang/include/clang/AST/CommentCommandTraits.h

clang/include/clang/AST/CommentLexer.h

clang/include/clang/AST/CommentParser.h

clang/include/clang/AST/CommentSema.h

clang/include/clang/AST/CommentVisitor.h

clang/include/clang/AST/ComparisonCategories.h

clang/include/clang/AST/ComputeDependence.h

clang/include/clang/AST/CurrentSourceLocExprScope.h

clang/include/clang/AST/DataCollection.h

clang/include/clang/AST/Decl.h

clang/include/clang/AST/DeclAccessPair.h

clang/include/clang/AST/DeclBase.h

clang/include/clang/AST/DeclCXX.h

clang/include/clang/AST/DeclContextInternals.h

clang/include/clang/AST/DeclFriend.h

clang/include/clang/AST/DeclGroup.h

clang/include/clang/AST/DeclLookups.h

clang/include/clang/AST/DeclObjC.h

clang/include/clang/AST/DeclOpenMP.h

clang/include/clang/AST/DeclTemplate.h

clang/include/clang/AST/DeclVisitor.h

clang/include/clang/AST/DeclarationName.h

clang/include/clang/AST/DependenceFlags.h

clang/include/clang/AST/DependentDiagnostic.h

clang/include/clang/AST/EvaluatedExprVisitor.h

clang/include/clang/AST/Expr.h

clang/include/clang/AST/ExprCXX.h

clang/include/clang/AST/ExprConcepts.h

clang/include/clang/AST/ExprObjC.h

clang/include/clang/AST/ExprOpenMP.h

clang/include/clang/AST/ExternalASTMerger.h

clang/include/clang/AST/ExternalASTSource.h

clang/include/clang/AST/FormatString.h

clang/include/clang/AST/GlobalDecl.h

clang/include/clang/AST/JSONNodeDumper.h

clang/include/clang/AST/LambdaCapture.h

clang/include/clang/AST/LexicallyOrderedRecursiveASTVisitor.h

clang/include/clang/AST/LocInfoType.h

clang/include/clang/AST/Mangle.h

clang/include/clang/AST/MangleNumberingContext.h

clang/include/clang/AST/NSAPI.h

clang/include/clang/AST/NestedNameSpecifier.h

clang/include/clang/AST/NonTrivialTypeVisitor.h

clang/include/clang/AST/ODRDiagsEmitter.h

clang/include/clang/AST/ODRHash.h

clang/include/clang/AST/OSLog.h

clang/include/clang/AST/OpenMPClause.h

clang/include/clang/AST/OptionalDiagnostic.h

clang/include/clang/AST/ParentMap.h

clang/include/clang/AST/ParentMapContext.h

clang/include/clang/AST/PrettyDeclStackTrace.h

clang/include/clang/AST/PrettyPrinter.h

clang/include/clang/AST/QualTypeNames.h

clang/include/clang/AST/Randstruct.h

clang/include/clang/AST/RawCommentList.h

clang/include/clang/AST/RecordLayout.h

clang/include/clang/AST/RecursiveASTVisitor.h

clang/include/clang/AST/Redeclarable.h

clang/include/clang/AST/SelectorLocationsKind.h

clang/include/clang/AST/Stmt.h

clang/include/clang/AST/StmtCXX.h

clang/include/clang/AST/StmtGraphTraits.h

clang/include/clang/AST/StmtIterator.h

clang/include/clang/AST/StmtObjC.h

clang/include/clang/AST/StmtOpenMP.h

clang/include/clang/AST/StmtVisitor.h

clang/include/clang/AST/TemplateArgumentVisitor.h

clang/include/clang/AST/TemplateBase.h

clang/include/clang/AST/TemplateName.h

clang/include/clang/AST/TextNodeDumper.h

clang/include/clang/AST/Type.h

clang/include/clang/AST/TypeLoc.h

clang/include/clang/AST/TypeLocVisitor.h

clang/include/clang/AST/TypeOrdering.h

clang/include/clang/AST/TypeVisitor.h

clang/include/clang/AST/UnresolvedSet.h

clang/include/clang/AST/VTTBuilder.h

clang/include/clang/AST/VTableBuilder.h

clang/include/clang/ASTMatchers/ASTMatchFinder.h

clang/include/clang/ASTMatchers/ASTMatchers.h

clang/include/clang/ASTMatchers/ASTMatchersInternal.h

clang/include/clang/ASTMatchers/ASTMatchersMacros.h

clang/include/clang/ASTMatchers/Dynamic/Diagnostics.h

clang/include/clang/ASTMatchers/Dynamic/Parser.h

clang/include/clang/ASTMatchers/Dynamic/Registry.h

clang/include/clang/ASTMatchers/Dynamic/VariantValue.h

clang/include/clang/ASTMatchers/GtestMatchers.h

clang/include/clang/Analysis/Analyses/CFGReachabilityAnalysis.h

clang/include/clang/Analysis/Analyses/CalledOnceCheck.h

clang/include/clang/Analysis/Analyses/Consumed.h

clang/include/clang/Analysis/Analyses/Dominators.h

clang/include/clang/Analysis/Analyses/ExprMutationAnalyzer.h

clang/include/clang/Analysis/Analyses/LiveVariables.h

clang/include/clang/Analysis/Analyses/PostOrderCFGView.h

clang/include/clang/Analysis/Analyses/ReachableCode.h

clang/include/clang/Analysis/Analyses/ThreadSafety.h

clang/include/clang/Analysis/Analyses/ThreadSafetyCommon.h

clang/include/clang/Analysis/Analyses/ThreadSafetyLogical.h

clang/include/clang/Analysis/Analyses/ThreadSafetyTIL.h

clang/include/clang/Analysis/Analyses/ThreadSafetyTraverse.h

clang/include/clang/Analysis/Analyses/ThreadSafetyUtil.h

clang/include/clang/Analysis/Analyses/UninitializedValues.h

clang/include/clang/Analysis/Analyses/UnsafeBufferUsage.h

clang/include/clang/Analysis/AnalysisDeclContext.h

clang/include/clang/Analysis/AnyCall.h

clang/include/clang/Analysis/BodyFarm.h

clang/include/clang/Analysis/CFG.h

clang/include/clang/Analysis/CFGStmtMap.h

clang/include/clang/Analysis/CallGraph.h

clang/include/clang/Analysis/CloneDetection.h

clang/include/clang/Analysis/CodeInjector.h

clang/include/clang/Analysis/ConstructionContext.h

clang/include/clang/Analysis/DomainSpecific/CocoaConventions.h

clang/include/clang/Analysis/DomainSpecific/ObjCNoReturn.h

clang/include/clang/Analysis/FlowSensitive/Arena.h

clang/include/clang/Analysis/FlowSensitive/CFGMatchSwitch.h

clang/include/clang/Analysis/FlowSensitive/ControlFlowContext.h

clang/include/clang/Analysis/FlowSensitive/DataflowAnalysis.h

clang/include/clang/Analysis/FlowSensitive/DataflowAnalysisContext.h

clang/include/clang/Analysis/FlowSensitive/DataflowEnvironment.h

clang/include/clang/Analysis/FlowSensitive/DataflowValues.h

clang/include/clang/Analysis/FlowSensitive/DataflowWorklist.h

clang/include/clang/Analysis/FlowSensitive/DebugSupport.h

clang/include/clang/Analysis/FlowSensitive/Logger.h

clang/include/clang/Analysis/FlowSensitive/MatchSwitch.h

clang/include/clang/Analysis/FlowSensitive/Models/ChromiumCheckModel.h

clang/include/clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h

clang/include/clang/Analysis/FlowSensitive/NoopAnalysis.h

clang/include/clang/Analysis/FlowSensitive/NoopLattice.h

clang/include/clang/Analysis/FlowSensitive/Solver.h

clang/include/clang/Analysis/FlowSensitive/StorageLocation.h

clang/include/clang/Analysis/FlowSensitive/Transfer.h

clang/include/clang/Analysis/FlowSensitive/TypeErasedDataflowAnalysis.h

clang/include/clang/Analysis/FlowSensitive/Value.h

clang/include/clang/Analysis/FlowSensitive/WatchedLiteralsSolver.h

clang/include/clang/Analysis/IssueHash.h

clang/include/clang/Analysis/MacroExpansionContext.h

clang/include/clang/Analysis/PathDiagnostic.h

clang/include/clang/Analysis/ProgramPoint.h

clang/include/clang/Analysis/RetainSummaryManager.h

clang/include/clang/Analysis/Support/BumpVector.h

clang/include/clang/Basic/AddressSpaces.h

clang/include/clang/Basic/AllDiagnostics.h

clang/include/clang/Basic/AttrSubjectMatchRules.h

clang/include/clang/Basic/AttributeCommonInfo.h

clang/include/clang/Basic/Builtins.h

clang/include/clang/Basic/CharInfo.h

clang/include/clang/Basic/CodeGenOptions.h

clang/include/clang/Basic/Cuda.h

clang/include/clang/Basic/DarwinSDKInfo.h

clang/include/clang/Basic/Diagnostic.h

clang/include/clang/Basic/DiagnosticError.h

clang/include/clang/Basic/DiagnosticIDs.h

clang/include/clang/Basic/DiagnosticOptions.h

clang/include/clang/Basic/DirectoryEntry.h

clang/include/clang/Basic/ExpressionTraits.h

clang/include/clang/Basic/FileEntry.h

clang/include/clang/Basic/FileManager.h

clang/include/clang/Basic/FileSystemOptions.h

clang/include/clang/Basic/FileSystemStatCache.h

clang/include/clang/Basic/IdentifierTable.h

clang/include/clang/Basic/LangOptions.h

clang/include/clang/Basic/LangStandard.h

clang/include/clang/Basic/MacroBuilder.h

clang/include/clang/Basic/Module.h

clang/include/clang/Basic/NoSanitizeList.h

clang/include/clang/Basic/ObjCRuntime.h

clang/include/clang/Basic/OpenCLOptions.h

clang/include/clang/Basic/OperatorKinds.h

clang/include/clang/Basic/OperatorPrecedence.h

clang/include/clang/Basic/PartialDiagnostic.h

clang/include/clang/Basic/ProfileList.h

clang/include/clang/Basic/SanitizerSpecialCaseList.h

clang/include/clang/Basic/Sanitizers.h

clang/include/clang/Basic/Sarif.h

clang/include/clang/Basic/SourceLocation.h

clang/include/clang/Basic/SourceManager.h

clang/include/clang/Basic/SourceManagerInternals.h

clang/include/clang/Basic/Stack.h

clang/include/clang/Basic/SyncScope.h

clang/include/clang/Basic/TargetCXXABI.h

clang/include/clang/Basic/TargetID.h

clang/include/clang/Basic/TargetInfo.h

clang/include/clang/Basic/TargetOptions.h

clang/include/clang/Basic/TokenKinds.h

clang/include/clang/Basic/Version.h

clang/include/clang/Basic/Visibility.h

clang/include/clang/Basic/XRayInstr.h

clang/include/clang/Basic/XRayLists.h

clang/include/clang/CodeGen/CGFunctionInfo.h

clang/include/clang/CodeGen/CodeGenABITypes.h

clang/include/clang/CodeGen/CodeGenAction.h

clang/include/clang/CodeGen/ConstantInitBuilder.h

clang/include/clang/CodeGen/ConstantInitFuture.h

clang/include/clang/CodeGen/ModuleBuilder.h

clang/include/clang/CodeGen/ObjectFilePCHContainerOperations.h

clang/include/clang/CodeGen/SwiftCallingConv.h

clang/include/clang/CrossTU/CrossTranslationUnit.h

clang/include/clang/DirectoryWatcher/DirectoryWatcher.h

clang/include/clang/Driver/Action.h

clang/include/clang/Driver/Compilation.h

clang/include/clang/Driver/Distro.h

clang/include/clang/Driver/Driver.h

clang/include/clang/Driver/InputInfo.h

clang/include/clang/Driver/Job.h

clang/include/clang/Driver/Multilib.h

clang/include/clang/Driver/MultilibBuilder.h

clang/include/clang/Driver/OffloadBundler.h

clang/include/clang/Driver/OptionUtils.h

clang/include/clang/Driver/Options.h

clang/include/clang/Driver/SanitizerArgs.h

clang/include/clang/Driver/Tool.h

clang/include/clang/Driver/ToolChain.h

clang/include/clang/Driver/Types.h

clang/include/clang/Driver/XRayArgs.h

clang/include/clang/Edit/Commit.h

clang/include/clang/Edit/EditedSource.h

clang/include/clang/Edit/EditsReceiver.h

clang/include/clang/Edit/FileOffset.h

clang/include/clang/ExtractAPI/API.h

clang/include/clang/ExtractAPI/APIIgnoresList.h

clang/include/clang/ExtractAPI/AvailabilityInfo.h

clang/include/clang/ExtractAPI/DeclarationFragments.h

clang/include/clang/ExtractAPI/ExtractAPIVisitor.h

clang/include/clang/ExtractAPI/FrontendActions.h

clang/include/clang/ExtractAPI/Serialization/SerializerBase.h

clang/include/clang/ExtractAPI/Serialization/SymbolGraphSerializer.h

clang/include/clang/Format/Format.h

//===--- Format.h - Format C++ code -----------------------------*- C++ -*-===// //===--- Format.h - Format C++ code -----------------------------*- C++ -*-===//
Lint: Lint
Inline Actions

clang-format not found in user’s local PATH; not linting file.

Lint: Lint: clang-format not found in user’s local PATH; not linting file.
// //
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information. // See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// //
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
/// ///
Show All 28 Linesenum class ParseError {
Error, Error,
Unsuitable, Unsuitable,
BinPackTrailingCommaConflict, BinPackTrailingCommaConflict,
InvalidQualifierSpecified, InvalidQualifierSpecified,
DuplicateQualifierSpecified, DuplicateQualifierSpecified,
MissingQualifierType, MissingQualifierType,
MissingQualifierOrder MissingQualifierOrder
}; };
class ParseErrorCategory final : public std::error_category { class LLVM_EXTERNAL_VISIBILITY ParseErrorCategory final : public std::error_category {
public: public:
const char *name() const noexcept override; const char *name() const noexcept override;
std::string message(int EV) const override; std::string message(int EV) const override;
}; };
const std::error_category &getParseCategory(); LLVM_EXTERNAL_VISIBILITY const std::error_category &getParseCategory();
std::error_code make_error_code(ParseError e); LLVM_EXTERNAL_VISIBILITY std::error_code make_error_code(ParseError e);
/// The ``FormatStyle`` is used to configure the formatting to follow /// The ``FormatStyle`` is used to configure the formatting to follow
/// specific guidelines. /// specific guidelines.
struct FormatStyle { struct LLVM_EXTERNAL_VISIBILITY FormatStyle {
// If the BasedOn: was InheritParentConfig and this style needs the file from // If the BasedOn: was InheritParentConfig and this style needs the file from
// the parent directories. It is not part of the actual style for formatting. // the parent directories. It is not part of the actual style for formatting.
// Thus the // instead of ///. // Thus the // instead of ///.
bool InheritsParentConfig; bool InheritsParentConfig;
/// The extra indent or outdent of access modifiers, e.g. ``public:``. /// The extra indent or outdent of access modifiers, e.g. ``public:``.
/// \version 3.3 /// \version 3.3
int AccessModifierOffset; int AccessModifierOffset;
▲ Show 20 Lines • Show All 4,422 Lines • ▼ Show 20 Linesprivate:
parseConfiguration(llvm::MemoryBufferRef Config, FormatStyle *Style, parseConfiguration(llvm::MemoryBufferRef Config, FormatStyle *Style,
bool AllowUnknownOptions, bool AllowUnknownOptions,
llvm::SourceMgr::DiagHandlerTy DiagHandler, llvm::SourceMgr::DiagHandlerTy DiagHandler,
void *DiagHandlerCtxt); void *DiagHandlerCtxt);
}; };
/// Returns a format style complying with the LLVM coding standards: /// Returns a format style complying with the LLVM coding standards:
/// http://llvm.org/docs/CodingStandards.html. /// http://llvm.org/docs/CodingStandards.html.
FormatStyle getLLVMStyle( LLVM_EXTERNAL_VISIBILITY FormatStyle getLLVMStyle(
FormatStyle::LanguageKind Language = FormatStyle::LanguageKind::LK_Cpp); FormatStyle::LanguageKind Language = FormatStyle::LanguageKind::LK_Cpp);
/// Returns a format style complying with one of Google's style guides: /// 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/cppguide.xml.
/// http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml. /// http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml.
/// https://developers.google.com/protocol-buffers/docs/style. /// https://developers.google.com/protocol-buffers/docs/style.
FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language); LLVM_EXTERNAL_VISIBILITY FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language);
/// Returns a format style complying with Chromium's style guide: /// Returns a format style complying with Chromium's style guide:
/// http://www.chromium.org/developers/coding-style. /// http://www.chromium.org/developers/coding-style.
FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language); LLVM_EXTERNAL_VISIBILITY FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language);
/// Returns a format style complying with Mozilla's style guide: /// Returns a format style complying with Mozilla's style guide:
/// https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html. /// https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html.
FormatStyle getMozillaStyle(); LLVM_EXTERNAL_VISIBILITY FormatStyle getMozillaStyle();
/// Returns a format style complying with Webkit's style guide: /// Returns a format style complying with Webkit's style guide:
/// http://www.webkit.org/coding/coding-style.html /// http://www.webkit.org/coding/coding-style.html
FormatStyle getWebKitStyle(); LLVM_EXTERNAL_VISIBILITY FormatStyle getWebKitStyle();
/// Returns a format style complying with GNU Coding Standards: /// Returns a format style complying with GNU Coding Standards:
/// http://www.gnu.org/prep/standards/standards.html /// http://www.gnu.org/prep/standards/standards.html
FormatStyle getGNUStyle(); LLVM_EXTERNAL_VISIBILITY FormatStyle getGNUStyle();
/// Returns a format style complying with Microsoft style guide: /// 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 /// https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017
FormatStyle getMicrosoftStyle(FormatStyle::LanguageKind Language); LLVM_EXTERNAL_VISIBILITY FormatStyle getMicrosoftStyle(FormatStyle::LanguageKind Language);
/// Returns style indicating formatting should be not applied at all. /// Returns style indicating formatting should be not applied at all.
FormatStyle getNoStyle(); LLVM_EXTERNAL_VISIBILITY FormatStyle getNoStyle();
/// Gets a predefined style for the specified language by name. /// Gets a predefined style for the specified language by name.
/// ///
/// Currently supported names: LLVM, Google, Chromium, Mozilla. Names are /// Currently supported names: LLVM, Google, Chromium, Mozilla. Names are
/// compared case-insensitively. /// compared case-insensitively.
/// ///
/// Returns ``true`` if the Style has been set. /// Returns ``true`` if the Style has been set.
bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language, LLVM_EXTERNAL_VISIBILITY bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
HazardyKnusperkeksUnsubmitted
Not Done
ReplyInline Actions

This doesn't look formatted.

HazardyKnusperkeks: This doesn't look formatted.
tstellarAuthorUnsubmitted
Done
ReplyInline Actions

I ran git-clang-format on the patch and it introduced a lot of unrelated changes, so I ended up dropping that part of the patch. I can go through and manually discard some of the more intrusive format changes. Any suggestions on which kind of formatting changes to keep and which ones to ignore?

tstellar: I ran git-clang-format on the patch and it introduced a lot of unrelated changes, so I ended up…
FormatStyle *Style); FormatStyle *Style);
/// Parse configuration from YAML-formatted text. /// Parse configuration from YAML-formatted text.
/// ///
/// Style->Language is used to get the base style, if the ``BasedOnStyle`` /// Style->Language is used to get the base style, if the ``BasedOnStyle``
/// option is present. /// option is present.
/// ///
/// The FormatStyleSet of Style is reset. /// The FormatStyleSet of Style is reset.
/// ///
/// When ``BasedOnStyle`` is not present, options not present in the YAML /// When ``BasedOnStyle`` is not present, options not present in the YAML
/// document, are retained in \p Style. /// document, are retained in \p Style.
/// ///
/// If AllowUnknownOptions is true, no errors are emitted if unknown /// If AllowUnknownOptions is true, no errors are emitted if unknown
/// format options are occurred. /// format options are occurred.
/// ///
/// If set all diagnostics are emitted through the DiagHandler. /// If set all diagnostics are emitted through the DiagHandler.
std::error_code LLVM_EXTERNAL_VISIBILITY std::error_code
parseConfiguration(llvm::MemoryBufferRef Config, FormatStyle *Style, parseConfiguration(llvm::MemoryBufferRef Config, FormatStyle *Style,
bool AllowUnknownOptions = false, bool AllowUnknownOptions = false,
llvm::SourceMgr::DiagHandlerTy DiagHandler = nullptr, llvm::SourceMgr::DiagHandlerTy DiagHandler = nullptr,
void *DiagHandlerCtx = nullptr); void *DiagHandlerCtx = nullptr);
/// Like above but accepts an unnamed buffer. /// Like above but accepts an unnamed buffer.
inline std::error_code parseConfiguration(StringRef Config, FormatStyle *Style, inline std::error_code parseConfiguration(StringRef Config, FormatStyle *Style,
bool AllowUnknownOptions = false) { bool AllowUnknownOptions = false) {
return parseConfiguration(llvm::MemoryBufferRef(Config, "YAML"), Style, return parseConfiguration(llvm::MemoryBufferRef(Config, "YAML"), Style,
AllowUnknownOptions); AllowUnknownOptions);
} }
/// Gets configuration in a YAML string. /// Gets configuration in a YAML string.
std::string configurationAsText(const FormatStyle &Style); LLVM_EXTERNAL_VISIBILITY std::string configurationAsText(const FormatStyle &Style);
/// Returns the replacements necessary to sort all ``#include`` blocks /// Returns the replacements necessary to sort all ``#include`` blocks
/// that are affected by ``Ranges``. /// that are affected by ``Ranges``.
tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code, LLVM_EXTERNAL_VISIBILITY tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName, StringRef FileName,
unsigned *Cursor = nullptr); unsigned *Cursor = nullptr);
/// Returns the replacements corresponding to applying and formatting /// Returns the replacements corresponding to applying and formatting
/// \p Replaces on success; otheriwse, return an llvm::Error carrying /// \p Replaces on success; otheriwse, return an llvm::Error carrying
/// llvm::StringError. /// llvm::StringError.
llvm::Expected<tooling::Replacements> LLVM_EXTERNAL_VISIBILITY llvm::Expected<tooling::Replacements>
formatReplacements(StringRef Code, const tooling::Replacements &Replaces, formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
const FormatStyle &Style); const FormatStyle &Style);
/// Returns the replacements corresponding to applying \p Replaces and /// Returns the replacements corresponding to applying \p Replaces and
/// cleaning up the code after that on success; otherwise, return an llvm::Error /// cleaning up the code after that on success; otherwise, return an llvm::Error
/// carrying llvm::StringError. /// carrying llvm::StringError.
/// This also supports inserting/deleting C++ #include directives: /// This also supports inserting/deleting C++ #include directives:
/// - If a replacement has offset UINT_MAX, length 0, and a replacement text /// - 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 /// that is an #include directive, this will insert the #include into the
/// correct block in the \p Code. /// correct block in the \p Code.
/// - If a replacement has offset UINT_MAX, length 1, and a replacement text /// - 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 /// that is the name of the header to be removed, the header will be removed
/// from \p Code if it exists. /// from \p Code if it exists.
/// The include manipulation is done via `tooling::HeaderInclude`, see its /// The include manipulation is done via `tooling::HeaderInclude`, see its
/// documentation for more details on how include insertion points are found and /// documentation for more details on how include insertion points are found and
/// what edits are produced. /// what edits are produced.
llvm::Expected<tooling::Replacements> LLVM_EXTERNAL_VISIBILITY llvm::Expected<tooling::Replacements>
cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces, cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
const FormatStyle &Style); const FormatStyle &Style);
/// Represents the status of a formatting attempt. /// Represents the status of a formatting attempt.
struct FormattingAttemptStatus { struct FormattingAttemptStatus {
/// A value of ``false`` means that any of the affected ranges were not /// A value of ``false`` means that any of the affected ranges were not
/// formatted due to a non-recoverable syntax error. /// formatted due to a non-recoverable syntax error.
bool FormatComplete = true; bool FormatComplete = true;
Show All 10 Lines
/// everything that might influence its formatting or might be influenced by its /// everything that might influence its formatting or might be influenced by its
/// formatting. /// formatting.
/// ///
/// Returns the ``Replacements`` necessary to make all \p Ranges comply with /// Returns the ``Replacements`` necessary to make all \p Ranges comply with
/// \p Style. /// \p Style.
/// ///
/// If ``Status`` is non-null, its value will be populated with the status of /// If ``Status`` is non-null, its value will be populated with the status of
/// this formatting attempt. See \c FormattingAttemptStatus. /// this formatting attempt. See \c FormattingAttemptStatus.
tooling::Replacements reformat(const FormatStyle &Style, StringRef Code, LLVM_EXTERNAL_VISIBILITY tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName = "<stdin>", StringRef FileName = "<stdin>",
FormattingAttemptStatus *Status = nullptr); FormattingAttemptStatus *Status = nullptr);
/// Same as above, except if ``IncompleteFormat`` is non-null, its value /// 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 /// will be set to true if any of the affected ranges were not formatted due to
/// a non-recoverable syntax error. /// a non-recoverable syntax error.
tooling::Replacements reformat(const FormatStyle &Style, StringRef Code, LLVM_EXTERNAL_VISIBILITY tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName, bool *IncompleteFormat); StringRef FileName, bool *IncompleteFormat);
/// Clean up any erroneous/redundant code in the given \p Ranges in \p /// Clean up any erroneous/redundant code in the given \p Ranges in \p
/// Code. /// Code.
/// ///
/// Returns the ``Replacements`` that clean up all \p Ranges in \p Code. /// Returns the ``Replacements`` that clean up all \p Ranges in \p Code.
tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code, LLVM_EXTERNAL_VISIBILITY tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName = "<stdin>"); StringRef FileName = "<stdin>");
/// Fix namespace end comments in the given \p Ranges in \p Code. /// Fix namespace end comments in the given \p Ranges in \p Code.
/// ///
/// Returns the ``Replacements`` that fix the namespace comments in all /// Returns the ``Replacements`` that fix the namespace comments in all
/// \p Ranges in \p Code. /// \p Ranges in \p Code.
tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style, LLVM_EXTERNAL_VISIBILITY tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
StringRef Code, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName = "<stdin>"); StringRef FileName = "<stdin>");
/// Inserts or removes empty lines separating definition blocks including /// Inserts or removes empty lines separating definition blocks including
/// classes, structs, functions, namespaces, and enums in the given \p Ranges in /// classes, structs, functions, namespaces, and enums in the given \p Ranges in
/// \p Code. /// \p Code.
/// ///
/// Returns the ``Replacements`` that inserts or removes empty lines separating /// Returns the ``Replacements`` that inserts or removes empty lines separating
/// definition blocks in all \p Ranges in \p Code. /// definition blocks in all \p Ranges in \p Code.
tooling::Replacements separateDefinitionBlocks(const FormatStyle &Style, LLVM_EXTERNAL_VISIBILITY tooling::Replacements separateDefinitionBlocks(const FormatStyle &Style,
StringRef Code, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName = "<stdin>"); StringRef FileName = "<stdin>");
/// Sort consecutive using declarations in the given \p Ranges in /// Sort consecutive using declarations in the given \p Ranges in
/// \p Code. /// \p Code.
/// ///
/// Returns the ``Replacements`` that sort the using declarations in all /// Returns the ``Replacements`` that sort the using declarations in all
/// \p Ranges in \p Code. /// \p Ranges in \p Code.
tooling::Replacements sortUsingDeclarations(const FormatStyle &Style, LLVM_EXTERNAL_VISIBILITY tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
StringRef Code, StringRef Code,
ArrayRef<tooling::Range> Ranges, ArrayRef<tooling::Range> Ranges,
StringRef FileName = "<stdin>"); StringRef FileName = "<stdin>");
/// Returns the ``LangOpts`` that the formatter expects you to set. /// Returns the ``LangOpts`` that the formatter expects you to set.
/// ///
/// \param Style determines specific settings for lexing mode. /// \param Style determines specific settings for lexing mode.
LangOptions getFormattingLangOpts(const FormatStyle &Style = getLLVMStyle()); LLVM_EXTERNAL_VISIBILITY LangOptions getFormattingLangOpts(const FormatStyle &Style = getLLVMStyle());
/// Description to be used for help text for a ``llvm::cl`` option for /// Description to be used for help text for a ``llvm::cl`` option for
/// specifying format style. The description is closely related to the operation /// specifying format style. The description is closely related to the operation
/// of ``getStyle()``. /// of ``getStyle()``.
extern const char *StyleOptionHelpDescription; LLVM_EXTERNAL_VISIBILITY extern const char *StyleOptionHelpDescription;
/// The suggested format style to use by default. This allows tools using /// The suggested format style to use by default. This allows tools using
/// `getStyle` to have a consistent default style. /// `getStyle` to have a consistent default style.
/// Different builds can modify the value to the preferred styles. /// Different builds can modify the value to the preferred styles.
extern const char *DefaultFormatStyle; LLVM_EXTERNAL_VISIBILITY extern const char *DefaultFormatStyle;
/// The suggested predefined style to use as the fallback style in `getStyle`. /// The suggested predefined style to use as the fallback style in `getStyle`.
/// Different builds can modify the value to the preferred styles. /// Different builds can modify the value to the preferred styles.
extern const char *DefaultFallbackStyle; LLVM_EXTERNAL_VISIBILITY extern const char *DefaultFallbackStyle;
/// Construct a FormatStyle based on ``StyleName``. /// Construct a FormatStyle based on ``StyleName``.
/// ///
/// ``StyleName`` can take several forms: /// ``StyleName`` can take several forms:
/// * "{<key>: <value>, ...}" - Set specic style parameters. /// * "{<key>: <value>, ...}" - Set specic style parameters.
/// * "<style name>" - One of the style names supported by /// * "<style name>" - One of the style names supported by
/// getPredefinedStyle(). /// getPredefinedStyle().
/// * "file" - Load style configuration from a file called ``.clang-format`` /// * "file" - Load style configuration from a file called ``.clang-format``
Show All 14 Lines
/// default, the file system is the real file system. /// default, the file system is the real file system.
/// \param[in] AllowUnknownOptions If true, unknown format options only /// \param[in] AllowUnknownOptions If true, unknown format options only
/// emit a warning. If false, errors are emitted on unknown format /// emit a warning. If false, errors are emitted on unknown format
/// options. /// options.
/// ///
/// \returns FormatStyle as specified by ``StyleName``. If ``StyleName`` is /// \returns FormatStyle as specified by ``StyleName``. If ``StyleName`` is
/// "file" and no file is found, returns ``FallbackStyle``. If no style could be /// "file" and no file is found, returns ``FallbackStyle``. If no style could be
/// determined, returns an Error. /// determined, returns an Error.
llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName, LLVM_EXTERNAL_VISIBILITY llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
StringRef FallbackStyle, StringRef FallbackStyle,
StringRef Code = "", StringRef Code = "",
llvm::vfs::FileSystem *FS = nullptr, llvm::vfs::FileSystem *FS = nullptr,
bool AllowUnknownOptions = false); bool AllowUnknownOptions = false);
// Guesses the language from the ``FileName`` and ``Code`` to be formatted. // Guesses the language from the ``FileName`` and ``Code`` to be formatted.
// Defaults to FormatStyle::LK_Cpp. // Defaults to FormatStyle::LK_Cpp.
FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code); LLVM_EXTERNAL_VISIBILITY FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code);
// Returns a string representation of ``Language``. // Returns a string representation of ``Language``.
inline StringRef getLanguageName(FormatStyle::LanguageKind Language) { inline StringRef getLanguageName(FormatStyle::LanguageKind Language) {
switch (Language) { switch (Language) {
case FormatStyle::LK_Cpp: case FormatStyle::LK_Cpp:
return "C++"; return "C++";
case FormatStyle::LK_CSharp: case FormatStyle::LK_CSharp:
return "CSharp"; return "CSharp";
Show All 13 Lines case FormatStyle::LK_TextProto:
return "TextProto"; return "TextProto";
case FormatStyle::LK_Verilog: case FormatStyle::LK_Verilog:
return "Verilog"; return "Verilog";
default: default:
return "Unknown"; return "Unknown";
} }
} }
bool isClangFormatOn(StringRef Comment); LLVM_EXTERNAL_VISIBILITY bool isClangFormatOn(StringRef Comment);
bool isClangFormatOff(StringRef Comment); LLVM_EXTERNAL_VISIBILITY bool isClangFormatOff(StringRef Comment);
} // end namespace format } // end namespace format
} // end namespace clang } // end namespace clang
namespace std { namespace std {
template <> template <>
struct is_error_code_enum<clang::format::ParseError> : std::true_type {}; struct is_error_code_enum<clang::format::ParseError> : std::true_type {};
} // namespace std } // namespace std
#endif // LLVM_CLANG_FORMAT_FORMAT_H #endif // LLVM_CLANG_FORMAT_FORMAT_H

clang/include/clang/Frontend/ASTConsumers.h

clang/include/clang/Frontend/ASTUnit.h

clang/include/clang/Frontend/ChainedDiagnosticConsumer.h

clang/include/clang/Frontend/CompilerInstance.h

clang/include/clang/Frontend/CompilerInvocation.h

clang/include/clang/Frontend/DependencyOutputOptions.h

clang/include/clang/Frontend/DiagnosticRenderer.h

clang/include/clang/Frontend/FrontendAction.h

clang/include/clang/Frontend/FrontendActions.h

clang/include/clang/Frontend/FrontendOptions.h

clang/include/clang/Frontend/LogDiagnosticPrinter.h

clang/include/clang/Frontend/MigratorOptions.h

clang/include/clang/Frontend/MultiplexConsumer.h

clang/include/clang/Frontend/PrecompiledPreamble.h

clang/include/clang/Frontend/PreprocessorOutputOptions.h

clang/include/clang/Frontend/SARIFDiagnostic.h

clang/include/clang/Frontend/SARIFDiagnosticPrinter.h

clang/include/clang/Frontend/SerializedDiagnosticPrinter.h

clang/include/clang/Frontend/SerializedDiagnosticReader.h

clang/include/clang/Frontend/TextDiagnostic.h

clang/include/clang/Frontend/TextDiagnosticBuffer.h

clang/include/clang/Frontend/TextDiagnosticPrinter.h

clang/include/clang/Frontend/Utils.h

clang/include/clang/Frontend/VerifyDiagnosticConsumer.h

clang/include/clang/FrontendTool/Utils.h

clang/include/clang/Index/CommentToXML.h

clang/include/clang/Index/IndexDataConsumer.h

clang/include/clang/Index/IndexSymbol.h

clang/include/clang/Index/IndexingAction.h

clang/include/clang/Index/USRGeneration.h

clang/include/clang/IndexSerialization/SerializablePathCollection.h

clang/include/clang/Interpreter/Interpreter.h

clang/include/clang/Lex/CodeCompletionHandler.h

clang/include/clang/Lex/DependencyDirectivesScanner.h

clang/include/clang/Lex/DirectoryLookup.h

clang/include/clang/Lex/ExternalPreprocessorSource.h

clang/include/clang/Lex/HeaderMap.h

clang/include/clang/Lex/HeaderSearch.h

clang/include/clang/Lex/HeaderSearchOptions.h

clang/include/clang/Lex/Lexer.h

clang/include/clang/Lex/LiteralSupport.h

clang/include/clang/Lex/MacroArgs.h

clang/include/clang/Lex/MacroInfo.h

clang/include/clang/Lex/ModuleLoader.h

clang/include/clang/Lex/ModuleMap.h

clang/include/clang/Lex/MultipleIncludeOpt.h

clang/include/clang/Lex/PPCallbacks.h

clang/include/clang/Lex/PPConditionalDirectiveRecord.h

clang/include/clang/Lex/Pragma.h

clang/include/clang/Lex/PreprocessingRecord.h

clang/include/clang/Lex/Preprocessor.h

clang/include/clang/Lex/PreprocessorLexer.h

clang/include/clang/Lex/PreprocessorOptions.h

clang/include/clang/Lex/ScratchBuffer.h

clang/include/clang/Lex/Token.h

clang/include/clang/Lex/TokenLexer.h

clang/include/clang/Parse/ParseAST.h

clang/include/clang/Parse/Parser.h

clang/include/clang/Rewrite/Core/DeltaTree.h

clang/include/clang/Rewrite/Core/RewriteBuffer.h

clang/include/clang/Rewrite/Core/RewriteRope.h

clang/include/clang/Rewrite/Core/Rewriter.h

clang/include/clang/Rewrite/Frontend/FixItRewriter.h

clang/include/clang/Rewrite/Frontend/FrontendActions.h

clang/include/clang/Sema/AnalysisBasedWarnings.h

clang/include/clang/Sema/CXXFieldCollector.h

clang/include/clang/Sema/CleanupInfo.h

clang/include/clang/Sema/CodeCompleteConsumer.h

clang/include/clang/Sema/CodeCompleteOptions.h

clang/include/clang/Sema/DeclSpec.h

clang/include/clang/Sema/DelayedDiagnostic.h

clang/include/clang/Sema/Designator.h

clang/include/clang/Sema/EnterExpressionEvaluationContext.h

clang/include/clang/Sema/ExternalSemaSource.h

clang/include/clang/Sema/HLSLExternalSemaSource.h

clang/include/clang/Sema/IdentifierResolver.h

clang/include/clang/Sema/Initialization.h

clang/include/clang/Sema/Lookup.h

clang/include/clang/Sema/MultiplexExternalSemaSource.h

clang/include/clang/Sema/Overload.h

clang/include/clang/Sema/ParsedAttr.h

clang/include/clang/Sema/RISCVIntrinsicManager.h

clang/include/clang/Sema/Scope.h

clang/include/clang/Sema/ScopeInfo.h

clang/include/clang/Sema/Sema.h

clang/include/clang/Sema/SemaConsumer.h

clang/include/clang/Sema/SemaInternal.h

clang/include/clang/Sema/Template.h

clang/include/clang/Sema/TemplateDeduction.h

clang/include/clang/Sema/TemplateInstCallback.h

clang/include/clang/Sema/TypoCorrection.h

clang/include/clang/Sema/Weak.h

clang/include/clang/Serialization/ASTBitCodes.h

clang/include/clang/Serialization/ASTDeserializationListener.h

clang/include/clang/Serialization/ASTReader.h

clang/include/clang/Serialization/ASTRecordReader.h

clang/include/clang/Serialization/ASTRecordWriter.h

clang/include/clang/Serialization/ASTWriter.h

clang/include/clang/Serialization/ContinuousRangeMap.h

clang/include/clang/Serialization/GlobalModuleIndex.h

clang/include/clang/Serialization/InMemoryModuleCache.h

clang/include/clang/Serialization/ModuleFile.h

clang/include/clang/Serialization/ModuleFileExtension.h

clang/include/clang/Serialization/ModuleManager.h

clang/include/clang/Serialization/PCHContainerOperations.h

clang/include/clang/Serialization/SourceLocationEncoding.h

clang/include/clang/StaticAnalyzer/Checkers/MPIFunctionClassifier.h

clang/include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h

clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h

clang/include/clang/StaticAnalyzer/Core/BugReporter/BugType.h

clang/include/clang/StaticAnalyzer/Core/BugReporter/CommonBugCategories.h

clang/include/clang/StaticAnalyzer/Core/Checker.h

clang/include/clang/StaticAnalyzer/Core/CheckerManager.h

clang/include/clang/StaticAnalyzer/Core/CheckerRegistryData.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/APSIntType.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/BasicValueFactory.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/BlockCounter.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/CallDescription.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/CheckerHelpers.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/ConstraintManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/CoreEngine.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/DynamicCastInfo.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/DynamicTypeInfo.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/Environment.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/FunctionSummary.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/ProgramState_Fwd.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/RangedConstraintManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SMTConstraintManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SMTConv.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SVals.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SimpleConstraintManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/Store.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/StoreRef.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SummaryManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SymExpr.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h

clang/include/clang/StaticAnalyzer/Core/PathSensitive/WorkList.h

clang/include/clang/StaticAnalyzer/Frontend/AnalysisConsumer.h

clang/include/clang/StaticAnalyzer/Frontend/AnalyzerHelpFlags.h

clang/include/clang/StaticAnalyzer/Frontend/CheckerRegistry.h

clang/include/clang/StaticAnalyzer/Frontend/FrontendActions.h

clang/include/clang/StaticAnalyzer/Frontend/ModelConsumer.h

clang/include/clang/Support/RISCVVIntrinsicUtils.h

clang/include/clang/Testing/TestAST.h

clang/include/clang/Tooling/ASTDiff/ASTDiff.h

clang/include/clang/Tooling/AllTUsExecution.h

clang/include/clang/Tooling/ArgumentsAdjusters.h

clang/include/clang/Tooling/CommonOptionsParser.h

clang/include/clang/Tooling/CompilationDatabase.h

clang/include/clang/Tooling/CompilationDatabasePluginRegistry.h

clang/include/clang/Tooling/Core/Diagnostic.h

clang/include/clang/Tooling/Core/Replacement.h

clang/include/clang/Tooling/DependencyScanning/DependencyScanningFilesystem.h

clang/include/clang/Tooling/DependencyScanning/DependencyScanningService.h

clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h

clang/include/clang/Tooling/DependencyScanning/DependencyScanningWorker.h

clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h

clang/include/clang/Tooling/Execution.h

clang/include/clang/Tooling/FileMatchTrie.h

clang/include/clang/Tooling/FixIt.h

clang/include/clang/Tooling/Inclusions/HeaderAnalysis.h

clang/include/clang/Tooling/Inclusions/HeaderIncludes.h

clang/include/clang/Tooling/Inclusions/StandardLibrary.h

clang/include/clang/Tooling/JSONCompilationDatabase.h

clang/include/clang/Tooling/NodeIntrospection.h

clang/include/clang/Tooling/Refactoring.h

clang/include/clang/Tooling/Refactoring/ASTSelection.h

clang/include/clang/Tooling/Refactoring/AtomicChange.h

clang/include/clang/Tooling/Refactoring/Extract/Extract.h

clang/include/clang/Tooling/Refactoring/Extract/SourceExtraction.h

clang/include/clang/Tooling/Refactoring/Lookup.h

clang/include/clang/Tooling/Refactoring/RefactoringAction.h

clang/include/clang/Tooling/Refactoring/RefactoringActionRule.h

clang/include/clang/Tooling/Refactoring/RefactoringActionRuleRequirements.h

clang/include/clang/Tooling/Refactoring/RefactoringActionRules.h

clang/include/clang/Tooling/Refactoring/RefactoringOption.h

clang/include/clang/Tooling/Refactoring/RefactoringOptionVisitor.h

clang/include/clang/Tooling/Refactoring/RefactoringOptions.h

clang/include/clang/Tooling/Refactoring/RefactoringResultConsumer.h

clang/include/clang/Tooling/Refactoring/RefactoringRuleContext.h

clang/include/clang/Tooling/Refactoring/Rename/RenamingAction.h

clang/include/clang/Tooling/Refactoring/Rename/SymbolName.h

clang/include/clang/Tooling/Refactoring/Rename/SymbolOccurrences.h

clang/include/clang/Tooling/Refactoring/Rename/USRFindingAction.h

clang/include/clang/Tooling/Refactoring/Rename/USRLocFinder.h

clang/include/clang/Tooling/RefactoringCallbacks.h

clang/include/clang/Tooling/StandaloneExecution.h

clang/include/clang/Tooling/Syntax/BuildTree.h

clang/include/clang/Tooling/Syntax/Mutations.h

clang/include/clang/Tooling/Syntax/Nodes.h

clang/include/clang/Tooling/Syntax/TokenBufferTokenManager.h

clang/include/clang/Tooling/Syntax/TokenManager.h

clang/include/clang/Tooling/Syntax/Tokens.h

clang/include/clang/Tooling/Syntax/Tree.h

clang/include/clang/Tooling/Tooling.h

clang/include/clang/Tooling/Transformer/Parsing.h

clang/include/clang/Tooling/Transformer/RangeSelector.h

clang/include/clang/Tooling/Transformer/RewriteRule.h

clang/include/clang/Tooling/Transformer/SourceCode.h

clang/include/clang/Tooling/Transformer/SourceCodeBuilders.h

clang/include/clang/Tooling/Transformer/Stencil.h

clang/include/clang/Tooling/Transformer/Transformer.h

clang/lib/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandling.cpp

clang/lib/Analysis/plugins/CheckerOptionHandling/CheckerOptionHandling.cpp

clang/lib/Analysis/plugins/SampleAnalyzer/MainCallChecker.cpp

clang/lib/Format/FormatToken.h

clang/lib/Format/FormatTokenLexer.h

clang/lib/Format/Macros.h

clang/lib/Format/QualifierAlignmentFixer.h

clang/lib/Format/TokenAnnotator.h

clang/lib/Format/UnwrappedLineParser.h

clang/lib/Tooling/Execution.cpp

clang/utils/TableGen/ClangAttrEmitter.cpp

llvm/include/llvm/Support/Registry.h