issue #10586 Backslash + quote mark causes doxygen not to generate documentation

albert-github · albert-github · commit f60c42c6c34a · 2024-01-25T11:59:23.000+01:00
The handling of (interpolated) verbatim C# strings didn't correctly handle the `\`.
Fixed the problem in different places.
diff --git a/src/code.l b/src/code.l
@@ -2229,7 +2229,7 @@ ENDQopt ("const"|"volatile"|"sealed"|"override")({BN}+("const"|"volatile"|"seale
                                           }
                                           BEGIN( SkipComment ) ;
                                         }
-<*>@\"                                  { // C# verbatim string
+<*>[$]?@\"                                  { // C# (interpolated) verbatim string
                                           startFontClass(yyscanner,"stringliteral");
                                           yyextra->code->codify(yytext);
                                           yyextra->lastVerbStringContext=YY_START;
diff --git a/src/commentcnv.l b/src/commentcnv.l
@@ -157,6 +157,7 @@ MAILADDR   ("mailto:")?[a-z_A-Z0-9\x80-\xff.+-]+"@"[a-z_A-Z0-9\x80-\xff-]+("."[a
 
 %x Scan
 %x SkipString
+%x SkipVerbString
 %x SkipChar
 %x SComment
 %x CComment
@@ -232,7 +233,7 @@ SLASHopt [/]*
                                       if (yyextra->lang!=SrcLangExt::Cpp) REJECT;
                                       copyToOutput(yyscanner,yytext,yyleng);
                                     }
-<Scan>[^"'!\/\n\\#,\-=; \t]*        { /* eat anything that is not " / , or \n */
+<Scan>[^"'!\/\n\\#,\-=; \t@$]*      { /* eat anything that is not " / , or \n */
                                        copyToOutput(yyscanner,yytext,yyleng);
                                     }
 <Scan>[,= ;\t]                      { /* eat , so we have a nice separator in long initialization lines */
@@ -343,6 +344,12 @@ SLASHopt [/]*
 				       }
 				     }
                                    }
+<Scan>[$]?"@\""                    { /* start of an interpolated verbatim C# string */
+                                     if (yyextra->lang!=SrcLangExt::CSharp) REJECT
+                                     copyToOutput(yyscanner,yytext,yyleng);
+				     yyextra->stringContext = YY_START;
+				     BEGIN(SkipVerbString);
+                                   }
 <Scan>"\""                         { /* start of a string */
                                      copyToOutput(yyscanner,yytext,yyleng);
 				     yyextra->stringContext = YY_START;
@@ -695,6 +702,22 @@ SLASHopt [/]*
 <SkipString>\n                     { /* new line inside string (illegal for some compilers) */
                                      copyToOutput(yyscanner,yytext,yyleng);
                                    }
+<SkipVerbString>[^"\n]+            {
+                                     copyToOutput(yyscanner,yytext,yyleng);
+                                   }
+<SkipVerbString>\"\"               { // escaped quote
+                                     copyToOutput(yyscanner,yytext,yyleng);
+                                   }
+<SkipVerbString>"\""       	   { /* end of string */
+                                     copyToOutput(yyscanner,yytext,yyleng);
+				     BEGIN(yyextra->stringContext);
+                                   }
+<SkipVerbString>.                  {
+                                     copyToOutput(yyscanner,yytext,yyleng);
+                                   }
+<SkipVerbString>\n                 {
+                                     copyToOutput(yyscanner,yytext,yyleng);
+                                   }
 <SkipChar>\\.		           { /* escaped character */
                                      if (yyextra->lang==SrcLangExt::Fortran || yyextra->lang==SrcLangExt::VHDL)
                                      {
diff --git a/src/pre.l b/src/pre.l
@@ -583,7 +583,7 @@ WSopt [ \t\r]*
 <CopyLine,LexCopyLine>"'"."'"           {
                                           outputArray(yyscanner,yytext,yyleng);
                                         }
-<CopyLine,LexCopyLine>@\"               {
+<CopyLine,LexCopyLine>[$]?@\"           {
                                           if (getLanguageFromFileName(yyextra->fileName)!=SrcLangExt::CSharp) REJECT;
                                           outputArray(yyscanner,yytext,yyleng);
                                           BEGIN( CopyStringCs );
@@ -610,6 +610,9 @@ WSopt [ \t\r]*
 <CopyStringCs>[^\"\r\n]+                {
                                           outputArray(yyscanner,yytext,yyleng);
                                         }
+<CopyStringCs>\"\"                      {
+                                          outputArray(yyscanner,yytext,yyleng);
+                                        }
 <CopyString>\\.                         {
                                           outputArray(yyscanner,yytext,yyleng);
                                         }
diff --git a/src/scanner.l b/src/scanner.l
@@ -3160,9 +3160,11 @@ NONLopt [^\n]*
                                           *yyextra->pSkipVerbString << yytext;
                                         }
 <SkipVerbString>"\\\\"                  { // escaped backslash
+                                          if (yyextra->insideCS) REJECT
                                           *yyextra->pSkipVerbString << yytext;
                                         }
 <SkipVerbString>"\\\""                  { // backslash escaped quote
+                                          if (yyextra->insideCS) REJECT
                                           *yyextra->pSkipVerbString << yytext;
                                         }
 <SkipVerbString>"\"\""                  { // quote escape

Original file line number	Diff line number	Diff line change
`@@ -2229,7 +2229,7 @@ ENDQopt ("const"\|"volatile"\|"sealed"\|"override")({BN}+("const"\|"volatile"\|"seale`
`2229`	`2229`	`}`
`2230`	`2230`	`BEGIN( SkipComment ) ;`
`2231`	`2231`	`}`
`2232`		`-<*>@\" { // C# verbatim string`
	`2232`	`+<*>[$]?@\" { // C# (interpolated) verbatim string`
`2233`	`2233`	`startFontClass(yyscanner,"stringliteral");`
`2234`	`2234`	`yyextra->code->codify(yytext);`
`2235`	`2235`	`yyextra->lastVerbStringContext=YY_START;`
Original file line number	Diff line number	Diff line change
`@@ -583,7 +583,7 @@ WSopt [ \t\r]*`
`583`	`583`	`<CopyLine,LexCopyLine>"'"."'" {`
`584`	`584`	`outputArray(yyscanner,yytext,yyleng);`
`585`	`585`	`}`
`586`		`-<CopyLine,LexCopyLine>@\" {`
	`586`	`+<CopyLine,LexCopyLine>[$]?@\" {`
`587`	`587`	`if (getLanguageFromFileName(yyextra->fileName)!=SrcLangExt::CSharp) REJECT;`
`588`	`588`	`outputArray(yyscanner,yytext,yyleng);`
`589`	`589`	`BEGIN( CopyStringCs );`
`@@ -610,6 +610,9 @@ WSopt [ \t\r]*`
`610`	`610`	`<CopyStringCs>[^\"\r\n]+ {`
`611`	`611`	`outputArray(yyscanner,yytext,yyleng);`
`612`	`612`	`}`
	`613`	`+<CopyStringCs>\"\" {`
	`614`	`+ outputArray(yyscanner,yytext,yyleng);`
	`615`	`+ }`
`613`	`616`	`<CopyString>\\. {`
`614`	`617`	`outputArray(yyscanner,yytext,yyleng);`
`615`	`618`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3160,9 +3160,11 @@ NONLopt [^\n]*`
`3160`	`3160`	`*yyextra->pSkipVerbString << yytext;`
`3161`	`3161`	`}`
`3162`	`3162`	`<SkipVerbString>"\\\\" { // escaped backslash`
	`3163`	`+ if (yyextra->insideCS) REJECT`
`3163`	`3164`	`*yyextra->pSkipVerbString << yytext;`
`3164`	`3165`	`}`
`3165`	`3166`	`<SkipVerbString>"\\\"" { // backslash escaped quote`
	`3167`	`+ if (yyextra->insideCS) REJECT`
`3166`	`3168`	`*yyextra->pSkipVerbString << yytext;`
`3167`	`3169`	`}`
`3168`	`3170`	`<SkipVerbString>"\"\"" { // quote escape`