Skip to content

Insert headers in global module fragment #151624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HighCommander4 merged 6 commits into from
Aug 3, 2025
Merged

Insert headers in global module fragment #151624

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f7e79ed
[libtooling] Insert headers in global module fragment
MythreyaK Aug 1, 2025
973ace6
code review
MythreyaK Aug 2, 2025
e044938
code review
MythreyaK Aug 3, 2025
dc275e9
update comment for `getMinHeaderInsertionOffset`
MythreyaK Aug 3, 2025
908392a
Add comment from code review
MythreyaK Aug 3, 2025
e56d504
Merge branch 'main' into mythreyak/module-header-insertion
HighCommander4 Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions clang/lib/Tooling/Inclusions/HeaderIncludes.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ bool checkAndConsumeModuleDecl(const SourceManager &SM, Lexer &Lex,
return Matched;
}

// Returns the offset after header guard directives and any comments
// before/after header guards (e.g. #ifndef/#define pair, #pragma once). If no
// header guard is present in the code, this will return the offset after
// skipping all comments from the start of the code.
unsigned getOffsetAfterHeaderGuardsAndComments(StringRef FileName,
StringRef Code,
const IncludeStyle &Style) {
// Determines the minimum offset into the file where we want to insert header
// includes. This will be put (when available):
// - after `#pragma once`
// - after header guards (`#ifdef` and `#define`)
// - after opening global module (`module;`)
Copy link
Collaborator

@HighCommander4 HighCommander4 Aug 3, 2025

Choose a reason for hiding this comment

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

Can we add "after any comments at the start of the file or immediately following one of the above constructs"?

Copy link
Contributor Author

@MythreyaK MythreyaK Aug 3, 2025

Choose a reason for hiding this comment

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

Done

unsigned getMinHeaderInsertionOffset(StringRef FileName, StringRef Code,
const IncludeStyle &Style) {
// \p Consume returns location after header guard or 0 if no header guard is
// found.
auto ConsumeHeaderGuardAndComment =
Expand Down Expand Up @@ -300,8 +300,7 @@ const llvm::Regex HeaderIncludes::IncludeRegex(IncludeRegexPattern);
HeaderIncludes::HeaderIncludes(StringRef FileName, StringRef Code,
const IncludeStyle &Style)
: FileName(FileName), Code(Code), FirstIncludeOffset(-1),
MinInsertOffset(
getOffsetAfterHeaderGuardsAndComments(FileName, Code, Style)),
MinInsertOffset(getMinHeaderInsertionOffset(FileName, Code, Style)),
MaxInsertOffset(MinInsertOffset +
getMaxHeaderInsertionOffset(
FileName, Code.drop_front(MinInsertOffset), Style)),
Expand Down
Loading