[prev in list] [next in list] [prev in thread] [next in thread] 

List:       llvm-bugs
Subject:    [llvm-bugs] [Bug 63619] Clang-format SortIncludes does not allow main headers in <> instead of ""
From:       LLVM Bugs via llvm-bugs <llvm-bugs () lists ! llvm ! org>
Date:       2023-06-30 13:03:43
Message-ID: 20230630130343.1ad924954e2c44e3 () email ! llvm ! org
[Download RAW message or body]

[Attachment #2 (text/html)]

<table border="1" cellspacing="0" cellpadding="8">
    <tr>
        <th>Issue</th>
        <td>
            <a href=https://github.com/llvm/llvm-project/issues/63619>63619</a>
        </td>
    </tr>

    <tr>
        <th>Summary</th>
        <td>
            Clang-format SortIncludes does not allow main headers in &lt;&gt; instead \
of &quot;&quot;  </td>
    </tr>

    <tr>
      <th>Labels</th>
      <td>
      </td>
    </tr>

    <tr>
      <th>Assignees</th>
      <td>
      </td>
    </tr>

    <tr>
      <th>Reporter</th>
      <td>
          aristotelos
      </td>
    </tr>
</table>

<pre>
    Clang-format has advanced detection of the &quot;main header&quot; of a C++ file \
to keep it as the first include. However, this only works if the main header file is \
referenced using double quotes (`&quot;myproject/MyClass.h&quot;`), not if the main \
header is referenced using angle brackets (`&lt;myproject/MyClass.h&gt;`). This is \
invalid because there is no strict rule to put main header includes into double \
quotes.

## Root cause

Clang-format has [a hard-coded check that the main header file should be included \
with double quotes](https://github.com/llvm/llvm-project/blob/d32fb5e5f51dedba495301073b9250f84ac6d8a8/clang/lib/Tooling/Inclusions/HeaderIncludes.cpp#L237). \


## Reproduction scenario

Project layout:
```
myproject
   include
      myproject
 MyClass.h
   src
       MyClass.cc
```

.clang-format file:
```
SortIncludes: true
```

MyClass.cc:
```
#include &lt;myproject/MyClass.h&gt;
#include &lt;anotherproject/OtherClass.h&gt;
```

Clang-format will reformat this to:
```
#include &lt;anotherproject/OtherClass.h&gt;
#include &lt;myproject/MyClass.h&gt;
```
because it doesn&apos;t recognize `&lt;myproject/MyClass.h&gt;` as the main header \
reference.

Workaround: change MyClass.cc to:
```
#include &quot;myproject/MyClass.h&quot;
#include &lt;anotherproject/OtherClass.h&gt;
```


</pre>
<img width="1px" height="1px" alt="" \
src="http://email.email.llvm.org/o/eJysVU1v4zYQ_TX0ZRBBJi1HOuiQjzV2gRYt2gV6HpFjiw3DcUk \
qhvvrC0pxLHe9aRYoYMgYkMP35g3nEWO0O0_UiupeVI8LHFLPocVgY-JEjuOiY3NsHxz63c2WwzMm6DECmhf0m \
gwYSqSTZQ-8hdQTCCmf0XroCQ0FIWVeQHgQ8l7Ie9haR5AYnoj2YBNgHLO2NsQE1ms3GCrgMx_oJWc_QOptBPb \
uCAcOTxHsBDPDmM60EQJtKdBIa4jW78Dw0DmCvwZOFEHIWqzLzO-4D_wn6STk5ufjg8MYi15IOa42GdRzugZ0D \
QP9zhF0AfUTpTcQ9XAdRH2aQAr4muvKP_-CzhroSOMQKWOGsRrPEFOwOkEYJs32Q7qkM8mVz0h8WWwhykdR3r1 \
-pRJSwW_MCUaQ-eI3rRXVPUKPwdxoNmRA96SfIPWYrgsfex5c5n_iY-BgU3_JR1SPQtZ9Svso1J2QGyE3O5v6o \
Ss0Pwu5ce7l9HdzFq5z3Am5MUpuu4qqbbU0ZDpcNZUql-Wt6hpZldt6hXptaqyF3OhcTj7I5sSvzM6O8ZfMLVr \
2UcjN55H-l1f5Cr3fC6l-kup27Mw16Wgf2AzTRY-aPAbL832_TpTB4ZGHlEucFtfl628Mz3diDAFOkr3FAPDvT \
efLc9oUg54nvO3Q-irq9C30vNG5c99j-TuHdNJGqDtIYaB3Dp6hf-dAIdVrnfDeYFzZi57zPJwTfsnhNznXaF3 \
c64N1Lo_uFI2WkvhjdD9I4UdKvIQ7Db5NYJiiF_I2QSDNO2__JvhPNzlZ6Hww31zqwgf-4PCEgQdvclt1j35Hs \
8vzQUne8c__t4ML0yrTqAYX1C7Xdb1UpZRq0bd1JaVUJSI2ZaNL2ZlaK1TYqTWVt_V2YVtZSlWuVblUpVqpYom \
mkaumWpHUqxUpsSrpGa0rst8UHHYLG-NA7Vqtl83CYUcunt7E0I6m1A27KFalszHFc1qyydHl8zgfn7Gj42uCzvFh3qPs2lkgoT6B9TERmvxSZhmlXAzBtT_slmMN2d_GMv4JAAD__2QEc1A">



[Attachment #3 (text/plain)]

_______________________________________________
llvm-bugs mailing list
llvm-bugs@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs


[prev in list] [next in list] [prev in thread] [next in thread]