zeroc-ice 3.7.11 → 3.8.1

data/dist/ice/cpp/src/Slice/Preprocessor.cpp

@@ -1,66 +1,62 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#include <Slice/Preprocessor.h>
-#include <Slice/Util.h>
-#include <IceUtil/StringUtil.h>
-#include <IceUtil/StringConverter.h>
-#include <IceUtil/FileUtil.h>
-#include <IceUtil/UUID.h>
-#include <IceUtil/ConsoleUtil.h>
+// Copyright (c) ZeroC, Inc.
+
+#include "Preprocessor.h"
+#include "../Ice/ConsoleUtil.h"
+#include "../Ice/FileUtil.h"
+#include "Ice/StringConverter.h"
+#include "Ice/StringUtil.h"
+#include "Ice/UUID.h"
+#include "Util.h"
 #include <algorithm>
-#include <iterator>
-#include <vector>
+#include <cassert>
+#include <cstring>
 #include <fstream>
-#include <sys/types.h>
+#include <iterator>
 #include <sys/stat.h>
-#include <cstring>
+#include <sys/types.h>
+#include <vector>
 
 #ifndef _WIN32
-#   include <sys/wait.h>
+#    include <sys/wait.h>
 #endif
 
 using namespace std;
 using namespace Slice;
-using namespace IceUtilInternal;
+using namespace IceInternal;
 
 //
 // mcpp defines
 //
 namespace Slice
 {
-
-enum Outdest
-{
-    Out=0, Err=1, Dbg=2, Num_Outdest=3
-};
-
+    enum Outdest
+    {
+        Out = 0,
+        Err = 1,
+        Dbg = 2,
+        Num_Outdest = 3
+    };
 }
 
-extern "C" int   mcpp_lib_main(int argc, char** argv);
-extern "C" void  mcpp_use_mem_buffers(int tf);
+extern "C" int mcpp_lib_main(int argc, char** argv);
+extern "C" void mcpp_use_mem_buffers(int tf);
 extern "C" char* mcpp_get_mem_buffer(Outdest od);
 
 Slice::PreprocessorPtr
 Slice::Preprocessor::create(const string& path, const string& fileName, const vector<string>& args)
 {
-    return new Preprocessor(path, fileName, args);
+    return make_shared<Preprocessor>(path, fileName, args);
 }
 
-Slice::Preprocessor::Preprocessor(const string& path, const string& fileName, const vector<string>& args) :
-    _path(path),
-    _fileName(fullPath(fileName)),
-    _shortFileName(fileName),
-    _args(args),
-    _cppHandle(0)
+Slice::Preprocessor::Preprocessor(string path, const string& fileName, const vector<string>& args)
+    : _path(std::move(path)),
+      _fileName(fullPath(fileName)),
+      _shortFileName(fileName),
+      _args(args)
 {
 }
 
-Slice::Preprocessor::~Preprocessor()
-{
-    close();
-}
+Slice::Preprocessor::~Preprocessor() { close(); }
 
 string
 Slice::Preprocessor::getFileName()
@@ -74,23 +70,13 @@ Slice::Preprocessor::getBaseName()
     string base(_fileName);
     string suffix;
     string::size_type pos = base.rfind('.');
-    if(pos != string::npos)
+    if (pos != string::npos)
     {
         base.erase(pos);
     }
     return base;
 }
 
-string
-Slice::Preprocessor::addQuotes(const string& arg)
-{
-    //
-    // Add quotes around the given argument to ensure that arguments
-    // with spaces will be preserved as a single argument
-    //
-    return "\"" + escapeString(arg, "", IceUtilInternal::Unicode) + "\"";
-}
-
 string
 Slice::Preprocessor::normalizeIncludePath(const string& path)
 {
@@ -100,8 +86,8 @@ Slice::Preprocessor::normalizeIncludePath(const string& path)
     //
     // MCPP does not handle "-IC:/" well as an include path.
     //
-    if(path.size() != 3 || !(path[0] >= 'A' && path[0] <= 'Z') || (path[0] >= 'a' && path[0] <= 'z') ||
-       path[1] != ':' || path[2] != '\\')
+    if (path.size() != 3 || !((path[0] >= 'A' && path[0] <= 'Z') || (path[0] >= 'a' && path[0] <= 'z')) ||
+        path[1] != ':' || path[2] != '\\')
 #endif
     {
         replace(result.begin(), result.end(), '\\', '/');
@@ -113,24 +99,24 @@ Slice::Preprocessor::normalizeIncludePath(const string& path)
     // For UNC paths we need to ensure they are in the format that is
     // used by MCPP. IE. "//MACHINE/PATH"
     //
-    if(result.find("//") == 0)
+    if (result.find("//") == 0)
     {
         startReplace = 2;
     }
 #endif
     string::size_type pos;
-    while((pos = result.find("//", startReplace)) != string::npos)
+    while ((pos = result.find("//", startReplace)) != string::npos)
     {
         result.replace(pos, 2, "/");
     }
 
-    if(result == "/" || (result.size() == 3 && IceUtilInternal::isAlpha(result[0]) && result[1] == ':' &&
-                         result[2] == '/'))
+    if (result == "/" ||
+        (result.size() == 3 && IceInternal::isAlpha(result[0]) && result[1] == ':' && result[2] == '/'))
     {
         return result;
     }
 
-    if(result.size() > 1 && result[result.size() - 1] == '/')
+    if (result.size() > 1 && result[result.size() - 1] == '/')
     {
         result.erase(result.size() - 1);
     }
@@ -140,95 +126,70 @@ Slice::Preprocessor::normalizeIncludePath(const string& path)
 
 namespace
 {
-
-vector<string>
-baseArgs(vector<string> args, bool keepComments, const vector<string>& extraArgs, const string& fileName)
-{
-    if(keepComments)
-    {
-        args.push_back("-C");
-    }
-    args.push_back("-e");
-    args.push_back("en_us.utf8");
-
-    //
-    // Define version macros __ICE_VERSION__ is preferred. We keep
-    // ICE_VERSION for backward compatibility with 3.5.0.
-    //
-    const string version[2] = {"ICE_VERSION", "__ICE_VERSION__"};
-    for(int i = 0; i < 2; ++i)
+    vector<string> baseArgs(vector<string> args, const string& languageArg, const string& fileName)
     {
-        ostringstream os;
-        os << "-D" << version[i] << "=" << ICE_INT_VERSION;
-        args.push_back(os.str());
-    }
+        // -C keep comments
+        args.emplace_back("-C");
 
-    copy(extraArgs.begin(), extraArgs.end(), back_inserter(args));
-    args.push_back(fileName);
-    return args;
-}
+        // UTF-8 encoding
+        args.emplace_back("-e");
+        args.emplace_back("en_us.utf8");
 
-}
+        // Define version macros __ICE_VERSION__ is preferred. We keep ICE_VERSION for backward compatibility
+        // with 3.5.0.
+        const string version[2] = {"ICE_VERSION", "__ICE_VERSION__"};
+        for (const auto& i : version)
+        {
+            ostringstream os;
+            os << "-D" << i << "=" << ICE_INT_VERSION;
+            args.push_back(os.str());
+        }
 
-FILE*
-Slice::Preprocessor::preprocess(bool keepComments, const string& extraArg)
-{
-    vector<string> args;
-    if(!extraArg.empty())
-    {
-        args.push_back(extraArg);
+        args.push_back(languageArg);
+        args.push_back(fileName);
+        return args;
     }
-    return preprocess(keepComments, args);
 }
 
 FILE*
-Slice::Preprocessor::preprocess(bool keepComments, const vector<string>& extraArgs)
+Slice::Preprocessor::preprocess(const string& languageArg)
 {
-    if(!checkInputFile())
-    {
-        return 0;
-    }
+    checkInputFile();
 
-    //
     // Build arguments list.
-    //
-    vector<string> args = baseArgs(_args, keepComments, extraArgs, _fileName);
+    vector<string> args = baseArgs(_args, languageArg, _fileName);
     const char** argv = new const char*[args.size() + 1];
     argv[0] = "mcpp";
-    for(unsigned int i = 0; i < args.size(); ++i)
+    for (unsigned int i = 0; i < args.size(); ++i)
     {
         argv[i + 1] = args[i].c_str();
     }
 
-    //
     // Call mcpp using memory buffer.
-    //
     mcpp_use_mem_buffers(1);
     int status = mcpp_lib_main(static_cast<int>(args.size()) + 1, const_cast<char**>(argv));
     delete[] argv;
 
-    //
     // Display any errors.
-    //
     char* err = mcpp_get_mem_buffer(Err);
-    if(err)
+    if (err)
     {
         vector<string> messages = filterMcppWarnings(err);
-        for(vector<string>::const_iterator i = messages.begin(); i != messages.end(); ++i)
+        for (const auto& message : messages)
         {
-            emitRaw(i->c_str());
+            emitRaw(message.c_str());
 
             //
             // MCPP FIX: mcpp does not always return non-zero exit status when there is an error.
             //
-            if(i->find("error:") != string::npos)
+            if (message.find("error:") != string::npos)
             {
                 status = 1;
             }
         }
     }
 
-    if(status == 0)
+    if (status == 0)
     {
         //
         // Write output to temporary file.
@@ -246,552 +207,89 @@ Slice::Preprocessor::preprocess(bool keepComments, const vector<string>& extraAr
         // process call _tempnam before any of them call fopen and
         // they will end up using the same tmp file.
         //
-        wchar_t* name = _wtempnam(0, IceUtil::stringToWstring("slice-" + IceUtil::generateUUID()).c_str());
-        if(name)
+        wchar_t* name = _wtempnam(0, Ice::stringToWstring("slice-" + Ice::generateUUID()).c_str());
+        if (name)
         {
-            _cppFile = IceUtil::wstringToString(name);
+            _cppFile = Ice::wstringToString(name);
             free(name);
-            _cppHandle = IceUtilInternal::fopen(_cppFile, "w+");
+            _cppHandle = IceInternal::fopen(_cppFile, "w+");
         }
 #else
         _cppHandle = tmpfile();
 #endif
 
-        //
         // If that fails try to open file in current directory.
-        //
-        if(_cppHandle == 0)
+        if (_cppHandle == nullptr)
         {
 #ifdef _WIN32
-            _cppFile = "slice-" + IceUtil::generateUUID();
+            _cppFile = "slice-" + Ice::generateUUID();
 #else
-            _cppFile = ".slice-" + IceUtil::generateUUID();
+            _cppFile = ".slice-" + Ice::generateUUID();
 #endif
-            _cppHandle = IceUtilInternal::fopen(_cppFile, "w+");
+            _cppHandle = IceInternal::fopen(_cppFile, "w+");
         }
 
-        if(_cppHandle != 0)
+        if (_cppHandle != nullptr)
         {
-            if(buf)
+            if (buf)
             {
-                ::fwrite(buf, strlen(buf), 1, _cppHandle);
+                [[maybe_unused]] auto _ = ::fwrite(buf, strlen(buf), 1, _cppHandle);
             }
-            ::rewind(_cppHandle);
+            ::rewind(_cppHandle); // NOLINT(cert-msc24-c,cert-msc33-c)
         }
         else
         {
-            consoleErr << _path << ": error: could not open temporary file: " << _cppFile << endl;
+            // Calling this again causes the memory buffers to be freed.
+            mcpp_use_mem_buffers(1);
+            throw runtime_error(_path + ": error: could not open temporary file: " + _cppFile);
         }
     }
 
-    //
     // Calling this again causes the memory buffers to be freed.
-    //
     mcpp_use_mem_buffers(1);
 
     return _cppHandle;
 }
 
-bool
-Slice::Preprocessor::printMakefileDependencies(ostream& out, Language lang, const vector<string>& includePaths,
-                                               const string& extraArg, const string& cppSourceExt,
-                                               const string& optValue)
-{
-    vector<string> extraArgs;
-    extraArgs.push_back(extraArg);
-    return printMakefileDependencies(out, lang, includePaths, extraArgs, cppSourceExt, optValue);
-}
-
-bool
-Slice::Preprocessor::printMakefileDependencies(ostream& out, Language lang, const vector<string>& includePaths,
-                                               const vector<string>& extraArgs, const string& /*cppSourceExt*/,
-                                               const string& optValue)
-{
-    if(!checkInputFile())
-    {
-        return false;
-    }
-
-    string cppHeaderExt;
-    string pyPrefix;
-    if(lang == CPlusPlus)
-    {
-        cppHeaderExt = optValue;
-    }
-    else if(lang == Python)
-    {
-        pyPrefix = optValue;
-    }
-
-    //
-    // Build arguments list.
-    //
-    vector<string> args = _args;
-    args.push_back("-M");
-    args = baseArgs(args, false, extraArgs, _fileName);
-
-    const char** argv = new const char*[args.size() + 1];
-    for(unsigned int i = 0; i < args.size(); ++i)
-    {
-        argv[i + 1] = args[i].c_str();
-    }
-
-    //
-    // Call mcpp using memory buffer.
-    //
-    mcpp_use_mem_buffers(1);
-    int status = mcpp_lib_main(static_cast<int>(args.size() + 1), const_cast<char**>(argv));
-    delete[] argv;
-
-    //
-    // Print errors to stderr.
-    //
-    char* err = mcpp_get_mem_buffer(Err);
-    if(err)
-    {
-        vector<string> messages = filterMcppWarnings(err);
-        for(vector<string>::const_iterator i = messages.begin(); i != messages.end(); ++i)
-        {
-            emitRaw(i->c_str());
-        }
-    }
-
-    if(status != 0)
-    {
-        //
-        // Calling this again causes the memory buffers to be freed.
-        //
-        mcpp_use_mem_buffers(1);
-        return false;
-    }
-
-    //
-    // Get mcpp output.
-    //
-    string unprocessed;
-    char* buf = mcpp_get_mem_buffer(Out);
-    if(buf)
-    {
-        unprocessed = string(buf);
-    }
-
-    //
-    // Calling this again causes the memory buffers to be freed.
-    //
-    mcpp_use_mem_buffers(1);
-
-    //
-    // We now need to massage the result to get the desired output.
-    // First remove the backslash used to escape new lines.
-    //
-    string::size_type pos;
-    while((pos = unprocessed.find(" \\\n")) != string::npos)
-    {
-        unprocessed.replace(pos, 3, "\n");
-    }
-
-    //
-    // Split filenames in separate lines:
-    //
-    // /foo/A.ice /foo/B.ice becomes
-    // /foo/A.ice
-    // /foo/B.ice
-    //
-    // C:\foo\A.ice C:\foo\B.ice becomes
-    // C:\foo\A.ice
-    // C:\foo\B.ice
-    //
-    pos = 0;
-#ifdef _WIN32
-    while((pos = unprocessed.find(".ice ", pos)) != string::npos)
-    {
-        if(unprocessed.find(":", pos) == pos + 6)
-        {
-            unprocessed.replace(pos, 5, ".ice\n");
-            pos += 5;
-        }
-    }
-#else
-    while((pos = unprocessed.find(".ice /", pos)) != string::npos)
-    {
-        unprocessed.replace(pos, 5, ".ice\n");
-    }
-#endif
-
-    //
-    // Get the main output file name.
-    //
-#ifdef _MSC_VER
-     string suffix = ".obj:";
-#else
-     string suffix = ".o:";
-#endif
-    pos = unprocessed.find(suffix) + suffix.size();
-    string result;
-    if(lang != SliceXML)
-    {
-        result = unprocessed.substr(0, pos);
-    }
-
-    vector<string> fullIncludePaths;
-    for(vector<string>::const_iterator p = includePaths.begin(); p != includePaths.end(); ++p)
-    {
-        fullIncludePaths.push_back(fullPath(*p));
-    }
-
-    //
-    // Process each dependency.
-    //
-    string sourceFile;
-    vector<string> dependencies;
-
-    string::size_type end;
-    while((end = unprocessed.find("\n", pos)) != string::npos)
-    {
-        end += 1;
-        string file = IceUtilInternal::trim(unprocessed.substr(pos, end - pos));
-        if(file.rfind(".ice") == file.size() - 4)
-        {
-            if(IceUtilInternal::isAbsolutePath(file))
-            {
-                if(file == _fileName)
-                {
-                    file = _shortFileName;
-                }
-                else
-                {
-                    //
-                    // Transform back full paths generated by mcpp to paths relative to the specified
-                    // include paths.
-                    //
-                    string newFile = file;
-                    for(vector<string>::const_iterator p = fullIncludePaths.begin(); p != fullIncludePaths.end(); ++p)
-                    {
-                        if(file.compare(0, p->length(), *p) == 0)
-                        {
-                            string s = includePaths[static_cast<size_t>(p - fullIncludePaths.begin())] +
-                                file.substr(p->length());
-                            if(IceUtilInternal::isAbsolutePath(newFile) || s.size() < newFile.size())
-                            {
-                                newFile = s;
-                            }
-                        }
-                    }
-                    file = newFile;
-                }
-            }
-
-            if(lang == SliceXML)
-            {
-                if(result.size() == 0)
-                {
-                    result = "  <source name=\"" + file + "\">";
-                }
-                else
-                {
-                    result += "\n    <dependsOn name=\"" + file + "\"/>";
-                }
-            }
-            else if(lang == JavaScriptJSON)
-            {
-                if(sourceFile.empty())
-                {
-                    sourceFile = file;
-                }
-                else
-                {
-                    dependencies.push_back(file);
-                }
-            }
-            else
-            {
-                //
-                // Escape spaces in the file name.
-                //
-                string::size_type space = 0;
-                while((space = file.find(" ", space)) != string::npos)
-                {
-                    file.replace(space, 1, "\\ ");
-                    space += 2;
-                }
-
-                //
-                // Add to result
-                //
-                result += " \\\n " + file;
-            }
-        }
-        pos = end;
-    }
-    if(lang == SliceXML)
-    {
-        result += "\n  </source>\n";
-    }
-    else if(lang == JavaScriptJSON)
-    {
-        result = "\"" + sourceFile + "\":" + (dependencies.empty() ? "[]" : "[");
-        for(vector<string>::const_iterator i = dependencies.begin(); i != dependencies.end();)
-        {
-            string file = *i;
-            result += "\n    \"" + file + "\"";
-            if(++i == dependencies.end())
-            {
-                result += "]";
-            }
-            else
-            {
-                result += ",";
-            }
-        }
-
-        pos = 0;
-        while((pos = result.find("\\", pos + 1)) != string::npos)
-        {
-            result.insert(pos, 1, '\\');
-            ++pos;
-        }
-    }
-    else
-    {
-        result += "\n";
-    }
-
-    /*
-     * Emit dependencies in any of the following formats, depending on the
-     * length of the filenames:
-     *
-     * x.o[bj]: /path/x.ice /path/y.ice
-     *
-     * x.o[bj]: /path/x.ice \
-     *  /path/y.ice
-     *
-     * x.o[bj]: /path/x.ice /path/y.ice \
-     *  /path/z.ice
-     *
-     * x.o[bj]: \
-     *  /path/x.ice
-     *
-     * x.o[bj]: \
-     *  /path/x.ice \
-     *  /path/y.ice
-     *
-     * Spaces embedded within filenames are escaped with a backslash. Note that
-     * Windows filenames may contain colons.
-     *
-     */
-    switch(lang)
-    {
-        case CPlusPlus:
-        {
-            //
-            // Change .o[bj] suffix to the h header extension suffix.
-            //
-            pos = result.find(suffix);
-            if(pos != string::npos)
-            {
-                string name = result.substr(0, pos);
-                result.replace(0, pos + suffix.size() - 1, name + "." + cppHeaderExt);
-
-            }
-            break;
-        }
-        case SliceXML:
-            break;
-        case Java:
-        case MATLAB:
-        {
-            //
-            // We want to shift the files left one position, so that
-            // "x.h: x.ice y.ice" becomes "x.ice: y.ice".
-            //
-
-            //
-            // Remove the first file.
-            //
-            string::size_type start = result.find(suffix);
-            assert(start != string::npos);
-            start = result.find_first_not_of(" \t\r\n\\", start + suffix.size()); // Skip to beginning of next file.
-            assert(start != string::npos);
-            result.erase(0, start);
-
-            //
-            // Find end of next file.
-            //
-            pos = 0;
-            while((pos = result.find_first_of(" :\t\r\n\\", pos + 1)) != string::npos)
-            {
-                if(result[pos] == ':')
-                {
-                    result.insert(pos, 1, '\\'); // Escape colons.
-                    ++pos;
-                }
-                else if(result[pos] == '\\') // Ignore escaped characters.
-                {
-                    ++pos;
-                }
-                else
-                {
-                    break;
-                }
-            }
-
-            if(pos == string::npos)
-            {
-                result.append(":");
-            }
-            else
-            {
-                result.insert(pos, 1, ':');
-            }
-            break;
-        }
-        case CSharp:
-        {
-            //
-            // Change .o[bj] suffix to .cs suffix.
-            //
-            pos = 0;
-            if((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, ".cs");
-            }
-            break;
-        }
-        case JavaScriptJSON:
-            break;
-        case JavaScript:
-        {
-            //
-            // Change .o[bj] suffix to .js suffix.
-            //
-            pos = 0;
-            if((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, ".js");
-            }
-            break;
-        }
-        case Python:
-        {
-            //
-            // Change .o[bj] suffix to .py suffix.
-            //
-            if(pyPrefix.size() != 0)
-            {
-                result = pyPrefix + result;
-            }
-            pos = 0;
-            if((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, "_ice.py");
-            }
-            break;
-        }
-        case Ruby:
-        {
-            //
-            // Change .o[bj] suffix to .rb suffix.
-            //
-            pos = 0;
-            if((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, ".rb");
-            }
-            break;
-        }
-        case PHP:
-        {
-            //
-            // Change .o[bj] suffix to .php suffix.
-            //
-            pos = 0;
-            if((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, ".php");
-            }
-            break;
-        }
-        case ObjC:
-        {
-            pos = result.find(suffix);
-            if(pos != string::npos)
-            {
-                string name = result.substr(0, pos);
-                result.replace(0, pos + suffix.size() - 1, name + ".h " + name + ".m");
-            }
-            break;
-        }
-        case Swift:
-        {
-            //
-            // Change .o[bj] suffix to .swift suffix.
-            //
-            pos = 0;
-            if ((pos = result.find(suffix)) != string::npos)
-            {
-                result.replace(pos, suffix.size() - 1, ".swift");
-            }
-            break;
-        }
-        default:
-        {
-            assert(false);
-            break;
-        }
-    }
-
-    //
-    // Output result
-    //
-    out << result;
-    return true;
-}
-
-bool
+void
 Slice::Preprocessor::close()
 {
-    if(_cppHandle != 0)
+    if (_cppHandle != nullptr)
     {
         int status = fclose(_cppHandle);
-        _cppHandle = 0;
+        _cppHandle = nullptr;
 
-        if(_cppFile.size() != 0)
+        if (_cppFile.size() != 0)
         {
-            IceUtilInternal::unlink(_cppFile);
+            IceInternal::unlink(_cppFile);
         }
 
-        if(status != 0)
+        if (status != 0)
         {
-            return false;
+            throw runtime_error("failed to close preprocessor file: " + IceInternal::lastErrorToString());
         }
     }
-
-    return true;
 }
 
-bool
+void
 Slice::Preprocessor::checkInputFile()
 {
     string base(_fileName);
     string suffix;
     string::size_type pos = base.rfind('.');
-    if(pos != string::npos)
+    if (pos != string::npos)
     {
-        suffix = IceUtilInternal::toLower(base.substr(pos));
+        suffix = IceInternal::toLower(base.substr(pos));
     }
-    if(suffix != ".ice")
+    if (suffix != ".ice")
     {
-        consoleErr << _path << ": error: input files must end with `.ice'" << endl;
-        return false;
+        throw runtime_error(_path + ": error: input files must end with `.ice'");
     }
 
-    ifstream test(IceUtilInternal::streamFilename(_fileName).c_str());
-    if(!test)
+    ifstream test(IceInternal::streamFilename(_fileName).c_str());
+    if (!test)
     {
-        consoleErr << _path << ": error: cannot open `" << _fileName << "' for reading" << endl;
-        return false;
+        throw runtime_error(_path + ": error: cannot open '" + _fileName + "' for reading");
     }
     test.close();
-
-    return true;
 }