Display help file if --help option is given (#572).

Jürgen Knödlseder
1 parent 4fc024b7
Showing 2 changed files with 51 additions and 0 deletions
src/support/ctool.cpp
src/support/ctool.hpp
@@ -49,6 +49,7 @@
 /* __ Method name definitions ____________________________________________ */
 #define G_GET_MEAN_POINTING        "ctool::get_mean_pointing(GObservations&)"
 #define G_CREATE_EBOUNDS                            "ctool::create_ebounds()"
+#define G_PROVIDE_HELP                                "ctool::provide_help()"
 /* __ Debug definitions __________________________________________________ */
@@ -109,6 +110,12 @@ ctool::ctool(const std::string&amp; name, const std::string&amp; version,
              int argc, char *argv[]) : 
        GApplication(name, version, argc, argv)
 {
+    // Catch --help option before doing anything else
+    if (need_help()) {
+        provide_help();
+        exit(0);
+    }
+    
     // Initialise members
     init_members();
@@ -978,3 +985,43 @@ size_t ctool::get_current_rss(void)
     // Return resident set size
     return rss;
 }
+
+
+/***********************************************************************//**
+ * @brief Dumps help text in the console
+ ***************************************************************************/
+void ctool::provide_help(void) const
+{
+    // Allocate line buffer
+    const int n = 1000; 
+    char  line[n];
+
+    // Build help file name
+    std::string helpfile = name()+".txt";
+
+    // Get ctools environment variable
+    char* ptr = std::getenv("CTOOLS");
+    if (ptr == NULL) {
+        std::string msg = "CTOOLS environment variable not set, cannot "
+                          "display help file. Please define CTOOLS "
+                          "environment variable.";
+        throw GException::invalid_value(G_PROVIDE_HELP, msg);
+    }
+
+    // If help file exists then display it, otherwise notify that no
+    // help is available
+    std::string fname = std::string(ptr) + "/share/help/" + helpfile;
+    FILE* fptr = fopen(fname.c_str(), "r");
+    if (fptr != NULL) {
+        while (fgets(line, n, fptr) != NULL) {
+            std::cout << std::string(line);
+        }
+        fclose(fptr);
+    }
+    else {
+        std::cout << "No help available for "+name()+"." << std::endl;
+    }
+
+    // Return
+    return;
+}
@@ -89,6 +89,10 @@ protected:
     GSkyDir         get_mean_pointing(const GObservations& obs);
     size_t          get_current_rss(void);
+protected:
+    // Protected methods
+    void           provide_help(void) const;
+    
     // Protected members
     bool           m_read_ahead; //!< Read ahead parameters
     bool           m_use_xml;    //!< Use XML file instead of FITS file for observations