Skip to content

Commit

Permalink
[clang-format][NFC] Delete 100+ redundant #include lines in .cpp files
Browse files Browse the repository at this point in the history
  • Loading branch information
@owenca
owenca committed Mar 17, 2024
1 parent 65058a8 commit b92d6dd
Show file tree
Hide file tree
Showing 19 changed files with 0 additions and 106 deletions.
1 change: 0 additions & 1 deletion clang/lib/Format/AffectedRangeManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

#include "AffectedRangeManager.h"

#include "FormatToken.h"
#include "TokenAnnotator.h"

namespace clang {
Expand Down
4 changes: 0 additions & 4 deletions clang/lib/Format/BreakableToken.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@
#include "BreakableToken.h"
#include "ContinuationIndenter.h"
#include "clang/Basic/CharInfo.h"
#include "clang/Format/Format.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/Support/Debug.h"
#include <algorithm>

#define DEBUG_TYPE "format-token-breaker"

Expand Down
9 changes: 0 additions & 9 deletions clang/lib/Format/ContinuationIndenter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,6 @@
#include "ContinuationIndenter.h"
#include "BreakableToken.h"
#include "FormatInternal.h"
#include "FormatToken.h"
#include "WhitespaceManager.h"
#include "clang/Basic/OperatorPrecedence.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/TokenKinds.h"
#include "clang/Format/Format.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/Debug.h"
#include <optional>

#define DEBUG_TYPE "format-indenter"

Expand Down
1 change: 0 additions & 1 deletion clang/lib/Format/DefinitionBlockSeparator.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
//===----------------------------------------------------------------------===//

#include "DefinitionBlockSeparator.h"
#include "llvm/Support/Debug.h"
#define DEBUG_TYPE "definition-block-separator"

namespace clang {
Expand Down
3 changes: 0 additions & 3 deletions clang/lib/Format/FormatToken.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@

#include "FormatToken.h"
#include "ContinuationIndenter.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/Debug.h"
#include <climits>

namespace clang {
namespace format {
Expand Down
4 changes: 0 additions & 4 deletions clang/lib/Format/FormatTokenLexer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@
//===----------------------------------------------------------------------===//

#include "FormatTokenLexer.h"
#include "FormatToken.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Format/Format.h"
#include "llvm/Support/Regex.h"

namespace clang {
namespace format {
Expand Down
3 changes: 0 additions & 3 deletions clang/lib/Format/MacroCallReconstructor.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
#include "Macros.h"

#include "UnwrappedLineParser.h"
#include "clang/Basic/TokenKinds.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/Support/Debug.h"
#include <cassert>

#define DEBUG_TYPE "format-reconstruct"

Expand Down
11 changes: 0 additions & 11 deletions clang/lib/Format/MacroExpander.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,8 @@

#include "Macros.h"

#include "Encoding.h"
#include "FormatToken.h"
#include "FormatTokenLexer.h"
#include "clang/Basic/TokenKinds.h"
#include "clang/Format/Format.h"
#include "clang/Lex/HeaderSearch.h"
#include "clang/Lex/HeaderSearchOptions.h"
#include "clang/Lex/Lexer.h"
#include "clang/Lex/ModuleLoader.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Lex/PreprocessorOptions.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/ErrorHandling.h"

namespace clang {
namespace format {
Expand Down
3 changes: 0 additions & 3 deletions clang/lib/Format/NamespaceEndCommentsFixer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
//===----------------------------------------------------------------------===//

#include "NamespaceEndCommentsFixer.h"
#include "clang/Basic/TokenKinds.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"

#define DEBUG_TYPE "namespace-end-comments-fixer"

Expand Down
2 changes: 0 additions & 2 deletions clang/lib/Format/ObjCPropertyAttributeOrderFixer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@

#include "ObjCPropertyAttributeOrderFixer.h"

#include <algorithm>

namespace clang {
namespace format {

Expand Down
6 changes: 0 additions & 6 deletions clang/lib/Format/QualifierAlignmentFixer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@
//===----------------------------------------------------------------------===//

#include "QualifierAlignmentFixer.h"
#include "FormatToken.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"

#include <algorithm>
#include <optional>

#define DEBUG_TYPE "format-qualifier-alignment-fixer"

Expand Down
13 changes: 0 additions & 13 deletions clang/lib/Format/SortJavaScriptImports.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,6 @@

#include "SortJavaScriptImports.h"
#include "TokenAnalyzer.h"
#include "TokenAnnotator.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticOptions.h"
#include "clang/Basic/LLVM.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/TokenKinds.h"
#include "clang/Format/Format.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/Debug.h"
#include <algorithm>
#include <string>

#define DEBUG_TYPE "format-formatter"

Expand Down
15 changes: 0 additions & 15 deletions clang/lib/Format/TokenAnalyzer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,6 @@
//===----------------------------------------------------------------------===//

#include "TokenAnalyzer.h"
#include "AffectedRangeManager.h"
#include "Encoding.h"
#include "FormatToken.h"
#include "FormatTokenLexer.h"
#include "TokenAnnotator.h"
#include "UnwrappedLineParser.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticOptions.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Format/Format.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/Debug.h"
#include <type_traits>

#define DEBUG_TYPE "format-formatter"

Expand Down
4 changes: 0 additions & 4 deletions clang/lib/Format/TokenAnnotator.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@
//===----------------------------------------------------------------------===//

#include "TokenAnnotator.h"
#include "FormatToken.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/TokenKinds.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/Support/Debug.h"

#define DEBUG_TYPE "format-token-annotator"

Expand Down
2 changes: 0 additions & 2 deletions clang/lib/Format/UnwrappedLineFormatter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@
//===----------------------------------------------------------------------===//

#include "UnwrappedLineFormatter.h"
#include "FormatToken.h"
#include "NamespaceEndCommentsFixer.h"
#include "WhitespaceManager.h"
#include "llvm/Support/Debug.h"
#include <queue>

#define DEBUG_TYPE "format-formatter"
Expand Down
11 changes: 0 additions & 11 deletions clang/lib/Format/UnwrappedLineParser.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,9 @@
//===----------------------------------------------------------------------===//

#include "UnwrappedLineParser.h"
#include "FormatToken.h"
#include "FormatTokenLexer.h"
#include "FormatTokenSource.h"
#include "Macros.h"
#include "TokenAnnotator.h"
#include "clang/Basic/TokenKinds.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/raw_os_ostream.h"
#include "llvm/Support/raw_ostream.h"

#include <algorithm>
#include <utility>

#define DEBUG_TYPE "format-parser"

Expand Down
5 changes: 0 additions & 5 deletions clang/lib/Format/UsingDeclarationsSorter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@
//===----------------------------------------------------------------------===//

#include "UsingDeclarationsSorter.h"
#include "clang/Format/Format.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"

#include <algorithm>

#define DEBUG_TYPE "using-declarations-sorter"

Expand Down
3 changes: 0 additions & 3 deletions clang/lib/Format/WhitespaceManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
//===----------------------------------------------------------------------===//

#include "WhitespaceManager.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include <algorithm>

namespace clang {
namespace format {
Expand Down
6 changes: 0 additions & 6 deletions clang/tools/clang-format/ClangFormat.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,12 @@
//===----------------------------------------------------------------------===//

#include "../../lib/Format/MatchFilePath.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticOptions.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/Version.h"
#include "clang/Format/Format.h"
#include "clang/Rewrite/Core/Rewriter.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/Process.h"
#include <fstream>

using namespace llvm;
Expand Down

5 comments on commit b92d6dd

@dwblaikie
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How was this change created? The first change in this patch (I haven't looked at others) looks incorrect to me. AffectedRangeManager.cpp does use FormatToken, so it should include FormatToken.h - relying on indirect inclusion is brittle/a maintainability problem - because an unrelated refactoring of another header might break compilation of this file, for instance.

@owenca
Copy link
Contributor Author

@owenca owenca commented on b92d6dd Mar 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted in b2082a9

@dwblaikie
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some tools that can do the right thing for inclusion (Include What You Use, iwyu - not sure if there's a version of that that's modern/maintained) - ensuring only the necessary headers, and all the necessary headers. In any case - for big systemic changes like this, please send them for review in the future, and document the process by which the change is created so that can be reviewed.

Thanks for the revert/work!

@owenca
Copy link
Contributor Author

@owenca owenca commented on b92d6dd Mar 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some tools that can do the right thing for inclusion (Include What You Use, iwyu - not sure if there's a version of that that's modern/maintained) - ensuring only the necessary headers, and all the necessary headers.

Thanks for the advice! I mentioned Visual Studio in the revert commit message. I'll definitely give iwyu a try if Visual Studio doesn't work well.

In any case - for big systemic changes like this, please send them for review in the future, and document the process by which the change is created so that can be reviewed.

clang/lib/Format/*.cpp files both include superfluous headers and rely on indirect inclusions, and AFAIK the latter has been the norm for the past few years. That's why I used a script to delete all inclusions that wouldn't break the build. Had I known there might be objections, I wouldn't have pushed the NFC commit without creating a pull request even if the patch would only delete just one #include line.

@dwblaikie
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang/lib/Format/*.cpp files both include superfluous headers and rely on indirect inclusions, and AFAIK the latter has been the norm for the past few years.

Yeah, without tooling, most codebases end up in a mess like this, for sure - not sure/wouldn't expect it's /intentional/ to rely on indirect inclusion. Just that no one notices or looks closely enough/cares much, so long as it compiles. Hence tooling.

The VS include cleaner sounds like a plausible direction, indeed.

Please sign in to comment.