ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modify rule S1916: LaYC format (#2711)

Browse Source 
Share content with S2323.
This commit is contained in:
Marco Borgeaud 2023-08-02 11:47:38 +02:00 committed by GitHub
parent ebcace66f8
commit 6cae06f38c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
rules/S1916/cfamily/rule.adoc
View File

@ -1,20 +1,30 @@
== Why is this an issue?
The standard mentions that the line continuation character (``++\++``) should be immediately followed by a newline or be the very last character of the file in order for the lines to be joined.
include::../../../shared_content/cfamily/line_splicing.adoc[]
Several compilers have a loose implementation of _line-splicing_ and allow whitespace after the `\` character.
While this practice was non-portable until {cpp}23, it remains non-portable in C.
Furthermore, readers can easily be confused about the meaning of these whitespaces.
Several compilers relax this requirement by allowing whitespace after the ``++\++`` character, but this is not portable because other compilers may not do the same.
=== Compliant solution
Therefore, for portability and clarity, `\` should be immediately followed by a newline character, as in the following example.
[source,cpp]
----
// There should be no whitespace after the '\'
// Compliant: there is no whitespace after the '\'
#define FOO BAR \
BAZ
----
== Resources
=== Documentation
* {cpp} reference - https://en.cppreference.com/w/cpp/language/translation_phases[Phases of translation]
=== Related rules
* S2323 - Line-splicing should not be used in "//" comments
ifdef::env-github,rspecator-view[]
'''

7
rules/S2323/cfamily/rule.adoc
View File

@ -1,9 +1,6 @@
== Why is this an issue?
When a line of code ends with the `\` (backslash) character, the newline character is deleted.
The compiler considers the next line a continuation of the current line, resulting in only one logical line of code.
This source code transformation, known as _line-splicing_, occurs during the second phase of C and {cpp} translation.
include::../../../shared_content/cfamily/line_splicing.adoc[]
_Line-splicing_ is often harmless and is sometimes used to improve the readability of macros:
@ -36,7 +33,7 @@ bool isSpecialCharacter(char c)
Compilers may also delete whitespace characters between a backslash and the newline characters.
This practice is standard-compliant since {cpp}23.
In other words, trailing whitespace does not disable _line-splicing_.
In other words, trailing whitespaces do not disable _line-splicing_.
== Resources

4
shared_content/cfamily/line_splicing.adoc Normal file
View File

@ -0,0 +1,4 @@
When a line of code ends with the `\` (backslash) character, the newline character is deleted.
The compiler considers the next line a continuation of the current line, resulting in only one logical line of code.
This source code transformation, known as _line-splicing_, occurs during the second phase of C and {cpp} translation.