sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

tools/nxstyle.c: Eliminate false alarms when checking for alignment of comments to the right of code. Fix check for C++ style comments so that strings like http:// and https:// do not generate false alarms.

Browse Source
This commit is contained in:
Gregory Nutt 2019-10-27 11:45:33 -06:00
parent 86a5eae270
commit ad9dc2b608
1 changed files with 39 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
tools/nxstyle.c
View File

@ -231,6 +231,13 @@ int main(int argc, char **argv, char **envp)
bstatm = false; /* True: This line is beginning of a statement */ bstatm = false; /* True: This line is beginning of a statement */
bfor = false; /* REVISIT: Implies for() is all on one line */ bfor = false; /* REVISIT: Implies for() is all on one line */
/* If we are not in a comment, then this certainly is not a right-hand comment. */
if (ncomment <= 0)
{
brhcomment = false;
}
/* Check for a blank line */ /* Check for a blank line */
for (n = 0; line[n] != '\n' && isspace((int)line[n]); n++) for (n = 0; line[n] != '\n' && isspace((int)line[n]); n++)
@ -873,13 +880,20 @@ int main(int argc, char **argv, char **envp)
comment_lineno = lineno; comment_lineno = lineno;
#endif #endif
brhcomment = false; /* Note that brhcomment must persist to support a
* later test for comment alignment. We will will
* fix that at the top of the loop when ncomment == 0.
*/
} }
} }
else else
{ {
/* Note that brhcomment must persist to support a later
* test for comment alignment. We will will fix that
* at the top of the loop when ncomment == 0.
*/
ncomment = 0; ncomment = 0;
brhcomment = false;
fprintf(stderr, fprintf(stderr,
"Closing without opening comment at line %d:%d\n", "Closing without opening comment at line %d:%d\n",
lineno, n); lineno, n);
@ -889,17 +903,20 @@ int main(int argc, char **argv, char **envp)
continue; continue;
} }
/* Check for C++ style comments /* Check for C++ style comments */
* NOTE: Gives false alarms on URLs (http://...) embedded
* inside of comments.
*/
else if (line[n + 1] == '/') else if (line[n + 1] == '/')
{ {
fprintf(stderr, "C++ style comment at %d:%d\n", /* Check for "http://" or "https://" */
lineno, n);
n++; if ((n < 5 || strncmp(&line[n - 5], "http://", 7) != 0) &&
continue; (n < 6 || strncmp(&line[n - 6], "https://", 8) != 0))
{
fprintf(stderr, "C++ style comment at %d:%d\n",
lineno, n);
n++;
continue;
}
} }
} }
@ -1292,8 +1309,15 @@ int main(int argc, char **argv, char **envp)
else if (line[n + 1] == '/') else if (line[n + 1] == '/')
{ {
fprintf(stderr, "C++ style comment on at %d:%d\n", /* Check for "http://" or "https://" */
lineno, n);
if ((n < 5 || strncmp(&line[n - 5], "http://", 7) != 0) &&
(n < 6 || strncmp(&line[n - 6], "https://", 8) != 0))
{
fprintf(stderr, "C++ style comment on at %d:%d\n",
lineno, n);
}
n++; n++;
} }
@ -1612,13 +1636,11 @@ int main(int argc, char **argv, char **envp)
* comments with a structure field definition). So disabled for * comments with a structure field definition). So disabled for
* comments before beginning of function definitions. * comments before beginning of function definitions.
* *
* REVISIT: We would like to suppress this error if this is a * Suppress this error if this is a comment to the right of code.
* comment to the right of code. Those are unaligned. However, * Those may be unaligned.
* The logic sequence current resets brhcomment to false during
* processing of the line prior to this test.
*/ */
if ((indent & 3) != 3 && bfunctions && dnest == 0 /* && !brhcomment */) if ((indent & 3) != 3 && bfunctions && dnest == 0 && !brhcomment)
{ {
fprintf(stderr, fprintf(stderr,
"Bad comment block alignment at line %d:%d\n", "Bad comment block alignment at line %d:%d\n",