From 13967565a611d7de5c0f2bc688cadc0d6ba25b30 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Tue, 24 Sep 2019 08:25:32 +0200
Subject: [PATCH] ENH: stringOps removeComments and inplaceRemoveComments

- useful for manual handling of string with comments
---
 applications/test/string/Test-string.C        | 43 ++++++++++
 .../primitives/strings/stringOps/stringOps.C  | 86 ++++++++++++++++++-
 .../primitives/strings/stringOps/stringOps.H  |  9 +-
 3 files changed, 136 insertions(+), 2 deletions(-)

diff --git a/applications/test/string/Test-string.C b/applications/test/string/Test-string.C
index e3adafffab..46257c117b 100644
--- a/applications/test/string/Test-string.C
+++ b/applications/test/string/Test-string.C
@@ -44,6 +44,20 @@ Description
 
 using namespace Foam;
 
+void testCommentStripping(const std::string& s)
+{
+    Info<< "input" << nl
+        << "========" << nl
+        << s << nl
+        << "========" << nl;
+
+    Info<< "output" << nl
+        << "========" << nl
+        << stringOps::removeComments(s) << nl
+        << "========" << nl << nl;
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 // Main program:
 
@@ -158,6 +172,35 @@ int main(int argc, char *argv[])
     Info<<"trimRight: " << stringOps::trimRight(test) << endl;
     Info<<"trim: " << stringOps::trim(test) << endl;
 
+    // Test comment stripping
+    {
+        Info<< nl << "Test comment stripping" << nl;
+        testCommentStripping
+        (
+            "/String without comments/"
+        );
+        testCommentStripping
+        (
+            "Removed some/* C-comments */ / C comments"
+        );
+        testCommentStripping
+        (
+            "Removed some//C++ comments\n / C++ comments"
+        );
+        testCommentStripping
+        (
+            "Partly degenerate C comment </*/ C-comment..."
+        );
+        testCommentStripping
+        (
+            "Truncated C comment </* C-comment..."
+        );
+        testCommentStripping
+        (
+            "Truncated C++ comment <// C++ comment..."
+        );
+    }
+
     if (false)
     {
         Info<<"test move construct - string size:" << test.size() << nl;
diff --git a/src/OpenFOAM/primitives/strings/stringOps/stringOps.C b/src/OpenFOAM/primitives/strings/stringOps/stringOps.C
index 28f3c84774..7f34b82108 100644
--- a/src/OpenFOAM/primitives/strings/stringOps/stringOps.C
+++ b/src/OpenFOAM/primitives/strings/stringOps/stringOps.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017-2018 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011-2016 OpenFOAM Foundation
@@ -1104,6 +1104,90 @@ void Foam::stringOps::inplaceTrim(std::string& s)
 }
 
 
+Foam::string Foam::stringOps::removeComments(const string& original)
+{
+    string s(original);
+    inplaceRemoveComments(s);
+    return s;
+}
+
+
+void Foam::stringOps::inplaceRemoveComments(std::string& s)
+{
+    const auto len = s.length();
+
+    if (len < 2)
+    {
+        return;
+    }
+
+    std::string::size_type n = 0;
+
+    for (std::string::size_type i = 0; i < len; ++i)
+    {
+        char c = s[i];
+
+        if (n != i)
+        {
+            s[n] = c;
+        }
+        ++n;
+
+        // The start of a C/C++ comment?
+        if (c == '/')
+        {
+            ++i;
+
+            if (i == len)
+            {
+                // No further characters
+                break;
+            }
+
+            c = s[i];
+
+            if (c == '/')
+            {
+                // C++ comment - search for end-of-line
+                --n;
+                i = s.find('\n', ++i);
+
+                if (i == std::string::npos)
+                {
+                    // Trucated - done
+                    break;
+                }
+            }
+            else if (c == '*')
+            {
+                // C comment - search for '*/'
+                --n;
+                i = s.find("*/", ++i, 2);
+
+                if (i == std::string::npos)
+                {
+                    // Trucated - done
+                    break;
+                }
+
+                ++i;
+            }
+            else
+            {
+                // Not a C/C++ comment
+                if (n != i)
+                {
+                    s[n] = c;
+                }
+                ++n;
+            }
+        }
+    }
+
+    s.resize(n);
+}
+
+
 Foam::string Foam::stringOps::lower(const string& original)
 {
     string s(original);
diff --git a/src/OpenFOAM/primitives/strings/stringOps/stringOps.H b/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
index 6604ff9ab7..6eb2499f9a 100644
--- a/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
+++ b/src/OpenFOAM/primitives/strings/stringOps/stringOps.H
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2016-2018 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2016-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011-2012 OpenFOAM Foundation
@@ -351,6 +351,13 @@ namespace stringOps
     void inplaceTrim(std::string& s);
 
 
+    //- Return string with C/C++ comments removed
+    string removeComments(const string& original);
+
+    //- Remove C/C++ comments inplace
+    void inplaceRemoveComments(std::string& s);
+
+
     //- Return string transformed with std::tolower on each character
     string lower(const string& original);