[PATCH] [WIP] clang-format: Enforce EOL at EOF as required by C standard

Daniel Jasper djasper at google.com
Sun Oct 6 06:13:57 PDT 2013


Actually, the C++11 standard says:
"A source file that is not empty and that does not end in a new-line
character, or that ends in a new-line character immediately preceded by a
backslash character before any such splicing takes place, shall be
processed as if an additional new-line character were appended to the file."

I think this pretty much implies that source files are allowed to not end
in a newline. Also, I think it is fine for clang-format to not alter its
input file in this regard. If your VCS requires this, configure your editor
appropriately ..


On Sun, Oct 6, 2013 at 2:10 PM, Alp Toker <alp at nuanti.com> wrote:

> Hi,
>
> I'm just putting this patch out there for now as it's been useful to us
> in its current state. Some tweaks are needed before this can land:
>
> 1) It needs a lot of existing unit tests to be fixed. The tests could be
> fixed before this patch goes in if anyone has the time to volunteer(!)
>
> 2) I'm not convinced it's worth even having a 'AllowNoEOL' format flag
> for this. The spec is clear that it's mandatory and many VCS also expect
> EOL at EOF to work properly.
>
> 3) That means we might do better to add a command line flag to identify
> that the code is being formatted for snippets, which uses the
> forSnippets() internally, in which case AllowNoEOL would be made true.
>
> 4) There are other rules such as trailing slash in 5.5.1.2 that I'm not
> sure are handled yet, though these could be worked on subequent to this
> patch landing.
>
> Note also that this fixes a bug in clang-format where it was reporting
> an error code for an empty (zero-sized) file. There's no benefit to the
> special case so we can just remove that check now.
>
> Here's the change:
>
>     clang-format: Enforce EOL at EOF as required by C standard
>
>     This enables end-of-line correction as specified for C-family
> languages.
>
>     C11 5.5.1.2p2 "A source file that is not empty shall end in a new-line
>     character"
>
>     The new setting 'AllowNoEOL' and the fluent
> FormatStyle::forSnippets() helper
>     are provided for consumers that prefer the old behaviour, which is
> preferable
>     for inline code snippets in documentation.
>
> Alp.
>
> --
> http://www.nuanti.com
> the browser experts
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20131006/afc69f29/attachment.html>


More information about the cfe-commits mailing list