Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Feature to allow multiple translation unit compilations of generated pure headers #1141

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feature to allow multiple translation unit compilations of generated pure headers #1141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions source/parse.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3131,6 +3131,43 @@ struct declaration_node
auto parent_is_polymorphic() const -> bool
{ return parent_declaration && parent_declaration->is_polymorphic(); }

auto is_inline() const -> bool
{
return is_alias()
|| is_constexpr
|| template_parameters != nullptr;
}

auto parent_is_inline() const -> bool
{
for (auto p = parent_declaration; p; p = p->parent_declaration)
{
if (p->is_inline())
return true;
}
return false;
}

auto last_parent_function_is_not_inline() const -> bool
{
auto p = parent_declaration;

if (!p)
return false;

auto pp = p->parent_declaration;
if (!p->is_function())
p = nullptr;

while (pp) {
if (pp->is_function())
p = pp;
pp = pp->parent_declaration;
}

return p && !p->is_inline();
}

enum which {
functions = 1,
objects = 2,
Expand Down
122 changes: 90 additions & 32 deletions source/to_cpp1.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,19 @@ static cmdline_processor::register_flag cmd_no_rtti(
[]{ flag_no_rtti = true; }
);

// This changes how an h2 header is intended to be used.
// .h file becomes its interface, .hpp - implementation to include in a very bare bones .cpp that is easy to produce automatically by cmake.
// This requires some changes to function properly and not break ODR:
// 1. All aliases aka inline definitions should go to .h
// 2. .hpp should not include other .hpp files
static auto flag_tu_compat_h2 = false;
static cmdline_processor::register_flag cmd_tu_compat_h2(
4,
"tu-compatible-h2",
"Make pure headers compatible with multiple translation units compilation",
[] { flag_tu_compat_h2 = true; }
);

struct text_with_pos{
std::string text;
source_position pos;
Expand Down Expand Up @@ -246,7 +259,8 @@ class positional_printer
enum phases {
phase0_type_decls = 0,
phase1_type_defs_func_decls = 1,
phase2_func_defs = 2
phase2_inline_defs = 2,
phase3_regular_defs = 3
};
auto get_phase() const { return phase; }

Expand All @@ -256,7 +270,8 @@ class positional_printer
auto inc_phase() -> void {
switch (phase) {
break;case phase0_type_decls : phase = phase1_type_defs_func_decls;
break;case phase1_type_defs_func_decls: phase = phase2_func_defs;
break;case phase1_type_defs_func_decls: phase = phase2_inline_defs;
break;case phase2_inline_defs : phase = phase3_regular_defs;
break;default : assert(!"ICE: invalid lowering phase");
}
curr_pos = {};
Expand Down Expand Up @@ -458,7 +473,7 @@ class positional_printer
)
{
// Emit non-function body comments in phase1_type_defs_func_decls,
// and emit function body comments in phase2_func_defs
// and emit function body comments in phase3_regular_defs
assert(pparser);
if (
(
Expand All @@ -467,7 +482,7 @@ class positional_printer
)
||
(
phase == phase2_func_defs
phase == phase3_regular_defs
&& pparser->is_within_function_body( comments[next_comment].start.lineno )
)
)
Expand Down Expand Up @@ -605,7 +620,7 @@ class positional_printer
// -- but only if there's any Cpp2, otherwise don't
// because passing through all-Cpp1 code should always
// remain diff-identical
if (phase == phase2_func_defs) {
if (phase == phase3_regular_defs) {
print_extra("\n");
}
}
Expand Down Expand Up @@ -1447,7 +1462,10 @@ class cppfront
// Strip off the 2"
auto h_include = line.text.substr(0, line.text.size()-2);
printer.print_cpp1( h_include + "\"", curr_lineno );
hpp_includes += h_include + "pp\"\n";

if (!flag_tu_compat_h2) {
hpp_includes += h_include + "pp\"\n";
}
}
else {
printer.print_cpp1( line.text, curr_lineno );
Expand Down Expand Up @@ -1491,6 +1509,33 @@ class cppfront
return ret;
}

//---------------------------------------------------------------------
// Do phase2_inline_defs
//
printer.finalize_phase();
printer.next_phase();

if (
source.has_cpp2()
&& !flag_clean_cpp1
)
{
printer.print_extra("\n//=== Cpp2 inline definitions =================================================\n\n");
printer.reset_line_to(1, true);
}

for (auto& section : tokens.get_map())
{
assert(!section.second.empty());

// Get the parse tree for this section and emit each forward declaration
auto decls = parser.get_parse_tree_declarations_in_range(section.second);
for (auto& decl : decls) {
assert(decl);
emit(*decl);
}
}

// If there is Cpp2 code, we have more to do...

// First, if this is a .h2 and in a -pure-cpp2 compilation,
Expand Down Expand Up @@ -1522,9 +1567,8 @@ class cppfront
printer.print_extra( hpp_includes );
}


//---------------------------------------------------------------------
// Do phase2_func_defs
// Do phase3_regular_defs
//
printer.finalize_phase();
printer.next_phase();
Expand All @@ -1534,7 +1578,7 @@ class cppfront
&& !flag_clean_cpp1
)
{
printer.print_extra( "\n//=== Cpp2 function definitions =================================================\n\n" );
printer.print_extra( "\n//=== Cpp2 regular definitions =================================================\n\n" );
printer.reset_line_to(1, true);
}

Expand Down Expand Up @@ -5030,7 +5074,7 @@ class cppfront
auto ret = std::string{};

if (
printer.get_phase() == printer.phase2_func_defs
printer.get_phase() >= printer.phase2_inline_defs
&& n.parent_is_type()
// && !n.name()->as_string_view().starts_with("operator")
)
Expand Down Expand Up @@ -5104,7 +5148,7 @@ class cppfront
}

// Do the 'out' param and member init work only in the definition phase
if (printer.get_phase() == printer.phase2_func_defs)
if (printer.get_phase() == printer.phase3_regular_defs)
{
auto canonize_object_name = [&]( declaration_node const* obj )
-> std::string
Expand Down Expand Up @@ -5508,7 +5552,7 @@ class cppfront

// Declarations are handled in multiple passes,
// but we only want to emit the error messages once (in phase 2)
if (!sema.check(n, printer.get_phase() == printer.phase2_func_defs))
if (!sema.check(n, printer.get_phase() == printer.phase3_regular_defs))
{
return;
}
Expand All @@ -5524,10 +5568,24 @@ class cppfront
return;
}

const auto is_inline_def = n.is_inline() || n.parent_is_inline();
const auto is_phase2_def = is_inline_def || n.is_namespace() || n.is_type();
const auto is_phase3_def = !is_inline_def || n.last_parent_function_is_not_inline();
const auto is_phase2_def_to_print = is_phase2_def && printer.get_phase() == printer.phase2_inline_defs;
const auto is_phase3_def_to_print = is_phase3_def && printer.get_phase() == printer.phase3_regular_defs;
const auto is_phase2_or_3_def_to_print = is_phase2_def_to_print || is_phase3_def_to_print;

if (
printer.get_phase() >= printer.phase2_inline_defs
&& !is_phase2_or_3_def_to_print)
{
return;
}

// If this is a generated declaration (negative source line number),
// add a line break before
if (
printer.get_phase() == printer.phase2_func_defs
printer.get_phase() >= printer.phase2_inline_defs
&& n.position().lineno < 1
)
{
Expand Down Expand Up @@ -5558,12 +5616,12 @@ class cppfront
(
n.parent_is_type()
&& n.is_object_alias()
&& printer.get_phase() == printer.phase2_func_defs
&& printer.get_phase() == printer.phase2_inline_defs
)
||
(
n.parent_is_function()
&& printer.get_phase() == printer.phase2_func_defs
&& printer.get_phase() >= printer.phase2_inline_defs
)
)
{
Expand Down Expand Up @@ -5591,7 +5649,7 @@ class cppfront
if (
a->is_object_alias()
&& n.parent_is_type()
&& printer.get_phase() == printer.phase2_func_defs
&& printer.get_phase() >= printer.phase2_inline_defs
)
{
emit_parent_template_parameters();
Expand Down Expand Up @@ -5673,7 +5731,7 @@ class cppfront
n.position()
);
}
else if (printer.get_phase() == printer.phase2_func_defs) {
else if (printer.get_phase() == printer.phase2_inline_defs) {
// The following logic is not yet complete, so give a diagnostic for now
if (n.parent_declaration->parent_is_type()) {
errors.emplace_back(
Expand Down Expand Up @@ -5861,7 +5919,7 @@ class cppfront
// Print a line directive before every function definition, excluding lambdas.
// This is needed to enable debugging with lldb.
if (
printer.get_phase() == printer.phase2_func_defs
printer.get_phase() >= printer.phase2_inline_defs
&& n.is_function()
&& n.has_name()
&& n.initializer
Expand All @@ -5874,7 +5932,7 @@ class cppfront
// type(s) that have template parameters and/or requires clauses,
// emit those outer template parameters and requires clauses too
if (
printer.get_phase() == printer.phase2_func_defs
printer.get_phase() >= printer.phase2_inline_defs
&& n.is_function()
&& n.initializer // only if the function has a definition (is not abstract)
)
Expand All @@ -5886,13 +5944,13 @@ class cppfront
if (
n.template_parameters
&& (
printer.get_phase() < printer.phase2_func_defs
printer.get_phase() <= printer.phase1_type_defs_func_decls
|| n.is_object()
|| (
n.is_function()
printer.get_phase() >= printer.phase2_inline_defs
&& n.is_function()
&& n.has_name() // only if it is not unnamed function aka lambda
&& n.initializer // only if the function has a definition (is not abstract)
&& printer.get_phase() == printer.phase2_func_defs
)
)
&& (
Expand All @@ -5915,7 +5973,7 @@ class cppfront
);
auto& compound_stmt = std::get<statement_node::compound>(n.initializer->statement);

if (printer.get_phase() != printer.phase2_func_defs)
if (printer.get_phase() <= printer.phase1_type_defs_func_decls)
{
if (n.requires_clause_expression) {
printer.print_cpp2("requires( ", n.requires_pos);
Expand Down Expand Up @@ -6153,7 +6211,7 @@ class cppfront
else if (
n.is_function()
&& (
printer.get_phase() < printer.phase2_func_defs
printer.get_phase() <= printer.phase1_type_defs_func_decls
|| n.initializer // only emit definition if the function has one (is not abstract)
|| n.is_defaultable_function()
)
Expand Down Expand Up @@ -6269,7 +6327,7 @@ class cppfront

// Note: Include a phase check because Cpp1 does not allow
// these on out-of-line definitions
if (printer.get_phase() != printer.phase2_func_defs)
if (printer.get_phase() <= printer.phase1_type_defs_func_decls)
{
switch (this_->mod) {
break;case parameter_declaration_node::modifier::implicit:
Expand Down Expand Up @@ -6299,7 +6357,7 @@ class cppfront
// it's a Cpp1 non-member function so we need to say so (on the declaration only)
else if (
is_in_type
&& printer.get_phase() != printer.phase2_func_defs
&& printer.get_phase() <= printer.phase1_type_defs_func_decls
) {
if (emit_as_friend) {
prefix += "friend ";
Expand Down Expand Up @@ -6459,14 +6517,14 @@ class cppfront
// don't emit abstract virtual functions in phase 2
else if (
n.initializer
|| printer.get_phase() < printer.phase2_func_defs
|| printer.get_phase() <= printer.phase1_type_defs_func_decls
)
{
printer.print_cpp2( prefix, n.position() );
printer.print_cpp2( "auto ", n.position() );
if (
!emit_as_friend
|| printer.get_phase() != printer.phase2_func_defs
|| printer.get_phase() <= printer.phase1_type_defs_func_decls
)
{
printer.print_cpp2( type_qualification_if_any_for(n), n.position() );
Expand Down Expand Up @@ -6700,7 +6758,7 @@ class cppfront
||
(
n.parent_is_function()
&& printer.get_phase() == printer.phase2_func_defs
&& printer.get_phase() >= printer.phase2_inline_defs
)
||
(
Expand All @@ -6712,7 +6770,7 @@ class cppfront
{
auto& type = std::get<declaration_node::an_object>(n.type);
if (
printer.get_phase() == printer.phase2_func_defs
printer.get_phase() >= printer.phase2_inline_defs
&& type->is_concept()
)
{
Expand All @@ -6722,7 +6780,7 @@ class cppfront
emit_requires_clause();

if (
printer.get_phase() != printer.phase2_func_defs
printer.get_phase() <= printer.phase1_type_defs_func_decls
&& n.parent_is_namespace()
&& !type->is_concept()
)
Expand Down Expand Up @@ -6799,7 +6857,7 @@ class cppfront

if (
n.parent_is_namespace()
&& printer.get_phase() != printer.phase2_func_defs
&& printer.get_phase() <= printer.phase1_type_defs_func_decls
&& !type->is_concept()
)
{
Expand Down