add option to skip opening of HTML file

Author: striezel

code/html_generation.cpp

@@ -63,12 +63,12 @@ std::string getFirstFolderFileName(const FolderMap& fm)
 
 void openFirstIndexFile(const FolderMap& fm, const std::string& html_dir)
 {
-  auto fileName = getFirstFolderFileName(fm);
+  const auto fileName = getFirstFolderFileName(fm);
   if (fileName.empty())
   {
     return;
   }
-  const auto fullFileName = html_dir + fileName;
+  const auto fullFileName = libstriezel::filesystem::slashify(html_dir) + fileName;
   const auto browser = detect_browser();
   if (!browser.has_value())
   {
@@ -277,7 +277,5 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM
     return rcFileError;
   }
   std::cout << "All HTML files were created successfully!\n";
-  // Open first HTML file in browser.
-  openFirstIndexFile(fm, htmlDir);
   return 0;
 }

code/html_generation.hpp

@@ -35,4 +35,11 @@
  */
 int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTMLOptions htmlOptions);
 
+/** \brief Attempts to open the first folder index HTML file in a browser.
+ *
+ * \param fm         folder mappings for the message database
+ * \param html_dir   directory where the HTML files reside
+ */
+void openFirstIndexFile(const FolderMap& fm, const std::string& html_dir);
+
 #endif // PMDB_HTML_GENERATION_HPP

code/main.cpp

@@ -114,6 +114,9 @@ void showHelp(const std::string& name)
             << "                          --table=" << TableClasses::DefaultTableClass << "\n"
             << "                          --row=" << TableClasses::DefaultRowClass << "\n"
             << "                          --cell=" << TableClasses::DefaultCellClass << "\n"
+            << "  --no-open         - Usually the program tries to open the generated HTML\n"
+            << "                      files in a web browser for viewing. If this option is\n"
+            << "                      given, no such attempt is made.\n"
             << "  --subset-check    - Search for messages with texts that are completely\n"
             << "                      contained in other messages, too.\n"
             << "  --list-from X     - List all messages that were sent by user X, where X stands\n"
@@ -136,6 +139,7 @@ int main(int argc, char **argv)
 
   bool doHTML = false;
   HTMLOptions htmlOptions;
+  bool doNotOpen = false;
 
   bool searchForSubsets = false;
   std::vector<FilterUser> filters = std::vector<FilterUser>();
@@ -371,6 +375,15 @@ int main(int argc, char **argv)
           htmlOptions.tableClasses.cell       = TableClasses::DefaultCellClass;
           htmlOptions.tableClasses.useClasses = true;
         }//param == std-classes
+        else if (param == "--no-open")
+        {
+          if (doNotOpen)
+          {
+            std::cerr << "Parameter " << param << " must not occur more than once!\n";
+            return rcInvalidParameter;
+          }
+          doNotOpen = true;
+        }
         else if ((param == "--subset-check") || (param == "--redundant-check"))
         {
           if (searchForSubsets)
@@ -529,6 +542,11 @@ int main(int argc, char **argv)
     {
       return rc;
     }
+    if (!doNotOpen)
+    {
+      // Open first HTML file in browser.
+      openFirstIndexFile(fm, pmdb::paths::html());
+    }
   } // if HTML file generation was requested
 
   if (searchForSubsets)

readme.md

@@ -66,6 +66,9 @@ options:
                           --table=grid_table
                           --row=grid_tr
                           --cell=grid_td
+  --no-open         - Usually the program tries to open the generated HTML
+                      files in a web browser for viewing. If this option is
+                      given, no such attempt is made.
   --subset-check    - Search for messages with texts that are completely
                       contained in other messages, too.
   --list-from X     - List all messages that were sent by user X, where X stands

tests/pmdb/parameter-misuse.cmd

@@ -157,6 +157,13 @@ if %ERRORLEVEL% NEQ 1 (
   exit /B 1
 )
 
+:: --no-open: parameter given twice
+"%EXECUTABLE%" --no-save --no-load-default --xml "%XML_FILE%" --html --no-open --no-open
+if %ERRORLEVEL% NEQ 1 (
+  echo Executable did not exit with code 1 when no-open option was given twice.
+  exit /B 1
+)
+
 :: --subset-check: parameter given twice
 "%EXECUTABLE%" --no-save --no-load-default --xml "%XML_FILE%" --subset-check --subset-check
 if %ERRORLEVEL% NEQ 1 (

tests/pmdb/parameter-misuse.sh

@@ -177,6 +177,14 @@ then
   exit 1
 fi
 
+# --no-open: parameter given twice
+"$EXECUTABLE" --no-save --no-load-default --xml "$XML_FILE" --html --no-open --no-open
+if [ $? -ne 1 ]
+then
+  echo "Executable did not exit with code 1 when --no-open was given twice."
+  exit 1
+fi
+
 # --subset-check: parameter given twice
 "$EXECUTABLE" --no-save --no-load-default --xml "$XML_FILE" --subset-check --subset-check
 if [ $? -ne 1 ]