Changeset 108280 in vbox for trunk/include

Timestamp:

Feb 19, 2025 9:28:41 AM (2 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

167622

Message:

Runtime/RTScriptLex*: Implement support for optionally returning parsed comments (single and multi line) as tokens when enabled in the lexer config, bugref:10321

File:

• trunk/include/iprt/script.h (modified) (7 diffs)

trunk/include/iprt/script.h

@@ -98 +98 @@
     /** Some punctuator. */
     RTSCRIPTLEXTOKTYPE_PUNCTUATOR,
+    /** A single line comment. */
+    RTSCRIPTLEXTOKTYPE_COMMENT_SINGLE_LINE,
+    /** A multi line comment. */
+    RTSCRIPTLEXTOKTYPE_COMMENT_MULTI_LINE,
     /** Special error token, conveying an error message from the lexer. */
     RTSCRIPTLEXTOKTYPE_ERROR,
@@ -212 +216 @@
             PCRTSCRIPTLEXTOKMATCH pPunctuator;
         } Punctuator;
+        /** Comment */
+        struct
+        {
+            /** Pointer to the start of the comment (including the symbols starting the comment). */
+            const char            *pszComment;
+            /** Number of characters of the comment, including the null terminator. */
+            size_t                cchComment;
+        } Comment;
         /** Error. */
         struct
@@ -316 +328 @@
  * as the lexer will convert everything to uppercase internally. */
 #define RTSCRIPT_LEX_CFG_F_CASE_INSENSITIVE_UPPER RT_BIT(1)
+/** Comments are not skipped but passed back as tokens. */
+#define RTSCRIPT_LEX_CFG_F_COMMENTS_AS_TOKENS     RT_BIT(2)
 
 
@@ -369 +383 @@
  *                                 If not NULL the string cache must be freed by the caller when not used
  *                                 anymore.
+ * @param   phStrCacheComments     Where to store the pointer to the string cache containing all
+ *                                 comments on success when RTSCRIPT_LEX_CFG_F_COMMENTS_AS_TOKENS
+ *                                 is given, optional.
+ *                                 If not NULL the string cache must be freed by the caller when not used
+ *                                 anymore.
  * @param   pCfg                   The lexer config to use for identifying the different tokens.
  */
@@ -374 +393 @@
                                         PFNRTSCRIPTLEXDTOR pfnDtor, void *pvUser,
                                         size_t cchBuf, PRTSTRCACHE phStrCacheId, PRTSTRCACHE phStrCacheStringLit,
-                                        PCRTSCRIPTLEXCFG pCfg);
+                                        PRTSTRCACHE phStrCacheComments, PCRTSCRIPTLEXCFG pCfg);
 
 
@@ -391 +410 @@
  *                                 If not NULL the string cache must be freed by the caller when not used
  *                                 anymore.
+ * @param   phStrCacheComments     Where to store the pointer to the string cache containing all
+ *                                 comments on success when RTSCRIPT_LEX_CFG_F_COMMENTS_AS_TOKENS
+ *                                 is given, optional.
+ *                                 If not NULL the string cache must be freed by the caller when not used
+ *                                 anymore.
  * @param   pCfg                   The lexer config to use for identifying the different tokens.
  */
 RTDECL(int) RTScriptLexCreateFromString(PRTSCRIPTLEX phScriptLex, const char *pszSrc, PRTSTRCACHE phStrCacheId,
-                                        PRTSTRCACHE phStrCacheStringLit, PCRTSCRIPTLEXCFG pCfg);
+                                        PRTSTRCACHE phStrCacheStringLit, PRTSTRCACHE phStrCacheComments,
+                                        PCRTSCRIPTLEXCFG pCfg);
 
 
@@ -411 +436 @@
  *                                 If not NULL the string cache must be freed by the caller when not used
  *                                 anymore.
+ * @param   phStrCacheComments     Where to store the pointer to the string cache containing all
+ *                                 comments on success when RTSCRIPT_LEX_CFG_F_COMMENTS_AS_TOKENS
+ *                                 is given, optional.
+ *                                 If not NULL the string cache must be freed by the caller when not used
+ *                                 anymore.
  * @param   pCfg                   The lexer config to use for identifying the different tokens.
  */
 RTDECL(int) RTScriptLexCreateFromFile(PRTSCRIPTLEX phScriptLex, const char *pszFilename, PRTSTRCACHE phStrCacheId,
-                                      PRTSTRCACHE phStrCacheStringLit, PCRTSCRIPTLEXCFG pCfg);
+                                      PRTSTRCACHE phStrCacheStringLit, PRTSTRCACHE phStrCacheComments,
+                                      PCRTSCRIPTLEXCFG pCfg);