improved nul device handling fix eclipse-sumo#3400 refs eclipse-sumo#…

…9620
pangzhenquan · Nov 24, 2021 · d1cadd5 · d1cadd5
1 parent f657250
commit d1cadd5
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 20 deletions.
diff --git a/src/router/RONet.cpp b/src/router/RONet.cpp
@@ -271,19 +271,31 @@ void
 RONet::openOutput(const OptionsCont& options) {
     if (options.isSet("output-file") && options.getString("output-file") != "") {
         myRoutesOutput = &OutputDevice::getDevice(options.getString("output-file"));
-        myRoutesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
-        myRoutesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        if (myRoutesOutput->isNull()) {
+            myRoutesOutput = nullptr;
+        } else {
+            myRoutesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
+            myRoutesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        }
     }
     if (options.exists("alternatives-output") && options.isSet("alternatives-output")
             && !(options.exists("write-trips") && options.getBool("write-trips"))) {
         myRouteAlternativesOutput = &OutputDevice::getDevice(options.getString("alternatives-output"));
-        myRouteAlternativesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
-        myRouteAlternativesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        if (myRouteAlternativesOutput->isNull()) {
+            myRouteAlternativesOutput = nullptr;
+        } else {
+            myRouteAlternativesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
+            myRouteAlternativesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        }
     }
     if (options.isSet("vtype-output")) {
         myTypesOutput = &OutputDevice::getDevice(options.getString("vtype-output"));
-        myTypesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
-        myTypesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        if (myTypesOutput->isNull()) {
+            myTypesOutput = nullptr;
+        } else {
+            myTypesOutput->writeHeader<ROEdge>(SUMO_TAG_ROUTES);
+            myTypesOutput->writeAttr("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").writeAttr("xsi:noNamespaceSchemaLocation", "http://sumo.dlr.de/xsd/routes_file.xsd");
+        }
     }
 }
 
@@ -692,7 +704,7 @@ RONet::saveAndRemoveRoutesUntil(OptionsCont& options, const RORouterProvider& pr
                 // ok, check whether it has been routed
                 if (r->getRoutingSuccess()) {
                     // write the route
-                    r->write(*myRoutesOutput, myRouteAlternativesOutput, myTypesOutput, options);
+                    r->write(myRoutesOutput, myRouteAlternativesOutput, myTypesOutput, options);
                     myWrittenRouteNo++;
                 } else {
                     myDiscardedRouteNo++;

diff --git a/src/router/RORoutable.h b/src/router/RORoutable.h
@@ -139,14 +139,16 @@ class RORoutable {
      * @param[in] typeos The types - output device to store the vehicle types into
      * @exception IOError If something fails (not yet implemented)
      */
-    void write(OutputDevice& os, OutputDevice* const altos,
+    void write(OutputDevice* os, OutputDevice* const altos,
                OutputDevice* const typeos, OptionsCont& options) const {
-        if (altos == 0 && typeos == 0) {
-            saveAsXML(os, &os, false, options);
-        } else {
-            saveAsXML(os, typeos, false, options);
+        if (os != nullptr) {
+            if (altos == nullptr && typeos == nullptr) {
+                saveAsXML(*os, os, false, options);
+            } else {
+                saveAsXML(*os, typeos, false, options);
+            }
         }
-        if (altos != 0) {
+        if (altos != nullptr) {
             saveAsXML(*altos, typeos, true, options);
         }
     }

diff --git a/src/utils/iodevices/OutputDevice.cpp b/src/utils/iodevices/OutputDevice.cpp
@@ -85,9 +85,8 @@ OutputDevice::getDevice(const std::string& name) {
             throw IOError("No port number given.");
         }
     } else {
-        const int len = (int)name.length();
-        std::string name2 = name;
-        if (OptionsCont::getOptions().isSet("output-prefix") && name != "/dev/null") {
+        std::string name2 = (name == "nul" || name == "NUL") ? "/dev/null" : name;
+        if (OptionsCont::getOptions().isSet("output-prefix") && name2 != "/dev/null") {
             std::string prefix = OptionsCont::getOptions().getString("output-prefix");
             const std::string::size_type metaTimeIndex = prefix.find("TIME");
             if (metaTimeIndex != std::string::npos) {
@@ -100,6 +99,7 @@ OutputDevice::getDevice(const std::string& name) {
             }
             name2 = FileHelpers::prependToLastPathComponent(prefix, name);
         }
+        const int len = (int)name.length();
         dev = new OutputDevice_File(name2, len > 3 && name.substr(len - 3) == ".gz");
     }
     dev->setPrecision();

diff --git a/src/utils/iodevices/OutputDevice.h b/src/utils/iodevices/OutputDevice.h
@@ -146,6 +146,13 @@ class OutputDevice {
      */
     virtual bool ok();
 
+    /** @brief returns the information whether the device will discard all output
+     * @return Whether the device redirects to /dev/null
+     */
+    virtual bool isNull() {
+        return false;
+    }
+
     /// @brief get filename or suitable description of this device
     const std::string& getFilename();
 

diff --git a/src/utils/iodevices/OutputDevice_File.cpp b/src/utils/iodevices/OutputDevice_File.cpp
@@ -36,17 +36,18 @@
 // method definitions
 // ===========================================================================
 OutputDevice_File::OutputDevice_File(const std::string& fullName, const bool compressed)
-    : OutputDevice(0, fullName), myFileStream(nullptr) {
-#ifdef WIN32
+    : OutputDevice(0, fullName) {
     if (fullName == "/dev/null") {
+        myAmNull = true;
+#ifdef WIN32
         myFileStream = new std::ofstream("NUL");
         if (!myFileStream->good()) {
             delete myFileStream;
             throw IOError("Could not redirect to NUL device (" + std::string(std::strerror(errno)) + ").");
         }
         return;
-    }
 #endif
+    }
     const std::string& localName = StringUtils::transcodeToLocal(fullName);
 #ifdef HAVE_ZLIB
     if (compressed) {

diff --git a/src/utils/iodevices/OutputDevice_File.h b/src/utils/iodevices/OutputDevice_File.h
@@ -48,6 +48,13 @@ class OutputDevice_File : public OutputDevice {
     /// @brief Destructor
     ~OutputDevice_File();
 
+    /** @brief returns the information whether the device will discard all output
+     * @return Whether the device redirects to /dev/null
+     */
+    bool isNull() {
+        return myAmNull;
+    }
+
 
 protected:
     /// @name Methods that override/implement OutputDevice-methods
@@ -62,6 +69,9 @@ class OutputDevice_File : public OutputDevice {
 
 private:
     /// The wrapped ofstream
-    std::ostream* myFileStream;
+    std::ostream* myFileStream = nullptr;
+
+    /// am I redirecting to /dev/null
+    bool myAmNull = false;
 
 };