Better warning when in Fortran a comment block is not closed

albert-github · albert-github · commit 841deb4087fd · 2024-01-23T14:58:44.000+01:00
When having e.g. a stray `@code` in the comment we get a warning like: ``` Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock) ``` where the line 15475 is the end of the file. It is a bit hard to find where the problem actually occurs, so a warning like: ``` Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock), starting command: '@code' probable line reference: 6689 ``` is better
diff --git a/src/fortranscanner.l b/src/fortranscanner.l
@@ -184,6 +184,8 @@ struct fortranscannerYY_state
   bool                     docBlockInBody = false;
   bool                     docBlockJavaStyle;
   QCString                 docBlockName;
+  QCString                 blockString;
+  int                      blockLineNr=-1;
   QCString                 debugStr;
   size_t                   fencedSize = 0;
 //  Argument                *parameter; // element of parameter list
@@ -1436,6 +1438,8 @@ private                                 {
                                             yyextra->docBlockName.at(1)=')';
                                           }
                                           yyextra->fencedSize=0;
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>{CMD}"ifile"{B}+"\""[^\n\"]+"\"" {
@@ -1467,31 +1471,41 @@ private                                 {
                                           yyextra->docBlock += yytext;
                                           yyextra->docBlockName="<pre>";
                                           yyextra->fencedSize=0;
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>{B}*"<"<CODE>">"              {
                                           yyextra->docBlock += yytext;
                                           yyextra->docBlockName="<code>";
                                           yyextra->fencedSize=0;
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>{CMD}"startuml"/[^a-z_A-Z0-9\-]     { // verbatim command
                                           yyextra->docBlock += yytext;
                                           yyextra->docBlockName="uml";
                                           yyextra->fencedSize=0;
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>{CMD}("verbatim"|"iliteral"|"latexonly"|"htmlonly"|"xmlonly"|"manonly"|"rtfonly"|"docbookonly"|"dot"|"msc"|"code")/[^a-z_A-Z0-9\-]     { // verbatim command
                                           yyextra->docBlock += yytext;
                                           yyextra->docBlockName=&yytext[1];
                                           yyextra->fencedSize=0;
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>"~~~"[~]*                     {
                                           QCString pat = yytext;
                                           yyextra->docBlock += pat;
                                           yyextra->docBlockName="~~~";
                                           yyextra->fencedSize=pat.length();
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>"```"[`]*/(".")?[a-zA-Z0-9#_-]+ |
@@ -1501,6 +1515,8 @@ private                                 {
                                           yyextra->docBlock += pat;
                                           yyextra->docBlockName="```";
                                           yyextra->fencedSize=pat.length();
+                                          yyextra->blockString=yytext;
+                                          yyextra->blockLineNr=yyextra->lineNr;
                                           BEGIN(DocCopyBlock);
                                         }
 <DocBlock>[^@*`~\/\\\n]+                { // any character that isn't special
@@ -1528,6 +1544,8 @@ private                                 {
                                           if (yyextra->docBlockName=="<pre>")
                                           {
                                             yyextra->docBlockName="";
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -1536,6 +1554,8 @@ private                                 {
                                           if (yyextra->docBlockName=="<code>")
                                           {
                                             yyextra->docBlockName="";
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -1544,6 +1564,8 @@ private                                 {
                                           if (yyextra->docBlockName==&yytext[1])
                                           {
                                             yyextra->docBlockName="";
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -1552,6 +1574,8 @@ private                                 {
                                           if (&yytext[4]==yyextra->docBlockName)
                                           {
                                             yyextra->docBlockName="";
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -1573,6 +1597,8 @@ private                                 {
                                           yyextra->docBlock += pat;
                                           if (yyextra->docBlockName == "~~~" && yyextra->fencedSize==pat.length())
                                           {
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -1581,6 +1607,8 @@ private                                 {
                                           yyextra->docBlock += pat;
                                           if (yyextra->docBlockName == "```" && yyextra->fencedSize==pat.length())
                                           {
+                                            yyextra->blockString.clear();
+                                            yyextra->blockLineNr=-1;
                                             BEGIN(DocBlock);
                                           }
                                         }
@@ -3343,7 +3371,16 @@ static void scanner_abort(yyscan_t yyscanner)
 {
   struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
   fprintf(stderr,"********************************************************************\n");
-  fprintf(stderr,"Error in file %s line: %d, state: %d(%s)\n",qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START));
+  if (yyextra->blockLineNr == -1)
+  {
+    fprintf(stderr,"Error in file %s line: %d, state: %d(%s)\n",
+      qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START));
+  }
+  else
+  {
+    fprintf(stderr,"Error in file %s line: %d, state: %d(%s), starting command: '%s' probable line reference: %d\n",
+      qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START),qPrint(yyextra->blockString),yyextra->blockLineNr);
+  }
   fprintf(stderr,"********************************************************************\n");
 
   bool start=FALSE;

Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,8 @@ struct fortranscannerYY_state`
`184`	`184`	`bool docBlockInBody = false;`
`185`	`185`	`bool docBlockJavaStyle;`
`186`	`186`	`QCString docBlockName;`
	`187`	`+ QCString blockString;`
	`188`	`+ int blockLineNr=-1;`
`187`	`189`	`QCString debugStr;`
`188`	`190`	`size_t fencedSize = 0;`
`189`	`191`	`// Argument *parameter; // element of parameter list`
`@@ -1436,6 +1438,8 @@ private {`
`1436`	`1438`	`yyextra->docBlockName.at(1)=')';`
`1437`	`1439`	`}`
`1438`	`1440`	`yyextra->fencedSize=0;`
	`1441`	`+ yyextra->blockString=yytext;`
	`1442`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1439`	`1443`	`BEGIN(DocCopyBlock);`
`1440`	`1444`	`}`
`1441`	`1445`	`<DocBlock>{CMD}"ifile"{B}+"\""[^\n\"]+"\"" {`
`@@ -1467,31 +1471,41 @@ private {`
`1467`	`1471`	`yyextra->docBlock += yytext;`
`1468`	`1472`	`yyextra->docBlockName="<pre>";`
`1469`	`1473`	`yyextra->fencedSize=0;`
	`1474`	`+ yyextra->blockString=yytext;`
	`1475`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1470`	`1476`	`BEGIN(DocCopyBlock);`
`1471`	`1477`	`}`
`1472`	`1478`	`<DocBlock>{B}*"<"<CODE>">" {`
`1473`	`1479`	`yyextra->docBlock += yytext;`
`1474`	`1480`	`yyextra->docBlockName="<code>";`
`1475`	`1481`	`yyextra->fencedSize=0;`
	`1482`	`+ yyextra->blockString=yytext;`
	`1483`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1476`	`1484`	`BEGIN(DocCopyBlock);`
`1477`	`1485`	`}`
`1478`	`1486`	`<DocBlock>{CMD}"startuml"/[^a-z_A-Z0-9\-] { // verbatim command`
`1479`	`1487`	`yyextra->docBlock += yytext;`
`1480`	`1488`	`yyextra->docBlockName="uml";`
`1481`	`1489`	`yyextra->fencedSize=0;`
	`1490`	`+ yyextra->blockString=yytext;`
	`1491`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1482`	`1492`	`BEGIN(DocCopyBlock);`
`1483`	`1493`	`}`
`1484`	`1494`	`<DocBlock>{CMD}("verbatim"\|"iliteral"\|"latexonly"\|"htmlonly"\|"xmlonly"\|"manonly"\|"rtfonly"\|"docbookonly"\|"dot"\|"msc"\|"code")/[^a-z_A-Z0-9\-] { // verbatim command`
`1485`	`1495`	`yyextra->docBlock += yytext;`
`1486`	`1496`	`yyextra->docBlockName=&yytext[1];`
`1487`	`1497`	`yyextra->fencedSize=0;`
	`1498`	`+ yyextra->blockString=yytext;`
	`1499`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1488`	`1500`	`BEGIN(DocCopyBlock);`
`1489`	`1501`	`}`
`1490`	`1502`	`<DocBlock>"~~~"[~]* {`
`1491`	`1503`	`QCString pat = yytext;`
`1492`	`1504`	`yyextra->docBlock += pat;`
`1493`	`1505`	`yyextra->docBlockName="~~~";`
`1494`	`1506`	`yyextra->fencedSize=pat.length();`
	`1507`	`+ yyextra->blockString=yytext;`
	`1508`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1495`	`1509`	`BEGIN(DocCopyBlock);`
`1496`	`1510`	`}`
`1497`	`1511`	<DocBlock>"```"[`]*/(".")?[a-zA-Z0-9#_-]+ \|
`@@ -1501,6 +1515,8 @@ private {`
`1501`	`1515`	`yyextra->docBlock += pat;`
`1502`	`1516`	yyextra->docBlockName="```";
`1503`	`1517`	`yyextra->fencedSize=pat.length();`
	`1518`	`+ yyextra->blockString=yytext;`
	`1519`	`+ yyextra->blockLineNr=yyextra->lineNr;`
`1504`	`1520`	`BEGIN(DocCopyBlock);`
`1505`	`1521`	`}`
`1506`	`1522`	<DocBlock>[^@*`~\/\\\n]+ { // any character that isn't special
`@@ -1528,6 +1544,8 @@ private {`
`1528`	`1544`	`if (yyextra->docBlockName=="<pre>")`
`1529`	`1545`	`{`
`1530`	`1546`	`yyextra->docBlockName="";`
	`1547`	`+ yyextra->blockString.clear();`
	`1548`	`+ yyextra->blockLineNr=-1;`
`1531`	`1549`	`BEGIN(DocBlock);`
`1532`	`1550`	`}`
`1533`	`1551`	`}`
`@@ -1536,6 +1554,8 @@ private {`
`1536`	`1554`	`if (yyextra->docBlockName=="<code>")`
`1537`	`1555`	`{`
`1538`	`1556`	`yyextra->docBlockName="";`
	`1557`	`+ yyextra->blockString.clear();`
	`1558`	`+ yyextra->blockLineNr=-1;`
`1539`	`1559`	`BEGIN(DocBlock);`
`1540`	`1560`	`}`
`1541`	`1561`	`}`
`@@ -1544,6 +1564,8 @@ private {`
`1544`	`1564`	`if (yyextra->docBlockName==&yytext[1])`
`1545`	`1565`	`{`
`1546`	`1566`	`yyextra->docBlockName="";`
	`1567`	`+ yyextra->blockString.clear();`
	`1568`	`+ yyextra->blockLineNr=-1;`
`1547`	`1569`	`BEGIN(DocBlock);`
`1548`	`1570`	`}`
`1549`	`1571`	`}`
`@@ -1552,6 +1574,8 @@ private {`
`1552`	`1574`	`if (&yytext[4]==yyextra->docBlockName)`
`1553`	`1575`	`{`
`1554`	`1576`	`yyextra->docBlockName="";`
	`1577`	`+ yyextra->blockString.clear();`
	`1578`	`+ yyextra->blockLineNr=-1;`
`1555`	`1579`	`BEGIN(DocBlock);`
`1556`	`1580`	`}`
`1557`	`1581`	`}`
`@@ -1573,6 +1597,8 @@ private {`
`1573`	`1597`	`yyextra->docBlock += pat;`
`1574`	`1598`	`if (yyextra->docBlockName == "~~~" && yyextra->fencedSize==pat.length())`
`1575`	`1599`	`{`
	`1600`	`+ yyextra->blockString.clear();`
	`1601`	`+ yyextra->blockLineNr=-1;`
`1576`	`1602`	`BEGIN(DocBlock);`
`1577`	`1603`	`}`
`1578`	`1604`	`}`
`@@ -1581,6 +1607,8 @@ private {`
`1581`	`1607`	`yyextra->docBlock += pat;`
`1582`	`1608`	if (yyextra->docBlockName == "```" && yyextra->fencedSize==pat.length())
`1583`	`1609`	`{`
	`1610`	`+ yyextra->blockString.clear();`
	`1611`	`+ yyextra->blockLineNr=-1;`
`1584`	`1612`	`BEGIN(DocBlock);`
`1585`	`1613`	`}`
`1586`	`1614`	`}`
`@@ -3343,7 +3371,16 @@ static void scanner_abort(yyscan_t yyscanner)`
`3343`	`3371`	`{`
`3344`	`3372`	`struct yyguts_t yyg = (struct yyguts_t)yyscanner;`
`3345`	`3373`	`fprintf(stderr,"********************************************************************\n");`
`3346`		`- fprintf(stderr,"Error in file %s line: %d, state: %d(%s)\n",qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START));`
	`3374`	`+ if (yyextra->blockLineNr == -1)`
	`3375`	`+ {`
	`3376`	`+ fprintf(stderr,"Error in file %s line: %d, state: %d(%s)\n",`
	`3377`	`+ qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START));`
	`3378`	`+ }`
	`3379`	`+ else`
	`3380`	`+ {`
	`3381`	`+ fprintf(stderr,"Error in file %s line: %d, state: %d(%s), starting command: '%s' probable line reference: %d\n",`
	`3382`	`+ qPrint(yyextra->fileName),yyextra->lineNr,YY_START,stateToString(YY_START),qPrint(yyextra->blockString),yyextra->blockLineNr);`
	`3383`	`+ }`
`3347`	`3384`	`fprintf(stderr,"********************************************************************\n");`
`3348`	`3385`
`3349`	`3386`	`bool start=FALSE;`