ENH: basics for expression string handling

src/OpenFOAM/expressions/exprString/exprString.H

@@ -0,0 +1,172 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | www.openfoam.com
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+    Original code Copyright (C) 2012-2018 Bernhard Gschaider
+    Copyright (C) 2019 OpenCFD Ltd.
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Namespace
+    Foam::expressions::exprString
+
+Description
+    A variant of Foam::string with expansion of dictionary variables
+    into a comma-separated form.
+
+SourceFiles
+    exprString.C
+    exprStringI.H
+
+SeeAlso
+    Foam::exprTools::expressionEntry
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef expressions_exprString_H
+#define expressions_exprString_H
+
+#include "string.H"
+#include "dictionary.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace expressions
+{
+
+/*---------------------------------------------------------------------------*\
+                           Class exprString Declaration
+\*---------------------------------------------------------------------------*/
+
+class exprString
+:
+    public string
+{
+public:
+
+    // Constructors
+
+        //- Construct null
+        exprString() = default;
+
+        //- Copy construct
+        exprString(const exprString& rhs) = default;
+
+        //- Move construct
+        exprString(exprString&& rhs) = default;
+
+        //- Copy construct from std::string
+        inline explicit exprString(const std::string& s, bool doValidate=true);
+
+        //- Move construct from std::string
+        inline explicit exprString(std::string&& s, bool doValidate=true);
+
+        //- Construct as copy of character array
+        inline explicit exprString(const char* s, bool doValidate=true);
+
+        //- Copy construct and expand with dictionary variables
+        //  Optionally strip C/C++ comments from the input
+        inline exprString
+        (
+            const std::string& str,
+            const dictionary& dict,
+            const bool removeComments = false
+        );
+
+        //- Move construct and expand with dictionary variables
+        //  Optionally strip C/C++ comments from the input
+        inline exprString
+        (
+            std::string&& str,
+            const dictionary& dict,
+            const bool removeComments = false
+        );
+
+        //- Construct from Istream and expand with dictionary variables
+        //  Optionally strip C/C++ comments from the input
+        inline exprString
+        (
+            Istream& is,
+            const dictionary& dict,
+            const bool removeComments = false
+        );
+
+
+    //- Destructor
+    ~exprString() = default;
+
+
+    // Member Functions
+
+        //- Copy convert string to exprString.
+        //  No expansions, know what you are doing.
+        inline static exprString toExpr(const std::string& str);
+
+        //- Move convert string to exprString.
+        //  No expansions, know what you are doing.
+        inline static exprString toExpr(std::string&& str);
+
+        //- Inplace expansion with dictionary variables
+        //  Optionally strip C/C++ comments from the input
+        exprString& expand
+        (
+            const dictionary& dict,
+            const bool removeComments = false
+        );
+
+        //- Check for unexpanded '$' entries. Fatal if any exist.
+        inline bool valid() const;
+
+
+    // Member Operators
+
+        //- Copy assign
+        exprString& operator=(const exprString& str) = default;
+
+        //- Move assign
+        exprString& operator=(exprString&& str) = default;
+
+        //- Copy assign from c-string (no expansions)
+        inline exprString& operator=(const char* str);
+
+        //- Copy assign from string (no expansions)
+        inline exprString& operator=(const std::string& str);
+
+        //- Move assign from string (no expansions)
+        inline exprString& operator=(std::string&& str);
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace expressions
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#include "exprStringI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //