Add GApplication::need_help() method that notifies the client application that t…

…he --help option has been specified on the command line (#572).

Add GApplication::need_help() method that notifies the client application that t…
…he --help option has been specified on the command line (#572).
Jürgen Knödlseder
1 parent add5f336
Showing 3 changed files with 52 additions and 17 deletions
include/GApplication.hpp
pyext/GApplication.i
src/app/GApplication.cpp
 /***************************************************************************
  *             GApplication.hpp - GammaLib application base class          *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2015 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -83,6 +83,7 @@ public:
     void               log_header(void);
     void               log_trailer(void);
     void               log_parameters(void);
+    const bool&        need_help(void) const;
     std::string        print(const GChatter& chatter = NORMAL) const;
     // Public members
@@ -105,6 +106,7 @@ protected:
     std::time_t              m_tstart;     //!< Calendar start time of execution
     std::clock_t             m_cstart;     //!< Clock start time of execution
     GApplicationPars         m_pars;       //!< Application parameters
+    bool                     m_need_help;  //!< --help specified
 };
@@ -209,4 +211,17 @@ const std::string&amp; GApplication::log_filename(void) const
     return (m_logfile);
 }
+
+/***********************************************************************//**
+ * @brief Signals if --help option has been specified
+ *
+ * @return True if --help option has been specified.
+ ***************************************************************************/
+inline
+const bool& GApplication::need_help(void) const
+{
+    // Return
+    return (m_need_help);
+}
+
 #endif /* GAPPLICATION_HPP */
@@ -70,6 +70,7 @@ public:
     void               log_header(void);
     void               log_trailer(void);
     void               log_parameters(void);
+    const bool&        need_help(void) const;
     // Public members
     GLog log;   //!< Application logger
 /***************************************************************************
  *             GApplication.cpp - GammaLib application base class          *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2015 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -131,15 +131,32 @@ GApplication::GApplication(const std::string&amp; name, const std::string&amp; version,
         m_args.push_back(gammalib::strip_whitespace(argv[i]));
     }
-    // Initialise application parameters
-    m_pars.load(par_filename(), m_args);
+    // Catch --help option before doing anything else. The actual action
+    // needs to be done by the client, but we skip the loading of the
+    // parameter file and the opening of the logger if the help option
+    // was specified.
+    m_need_help = false;
+    if (m_args.size() >= 2) {
+        if (m_args[1] == "--help") {
+            m_need_help = true;
+        }
+    }
-    // Set log filename and chattiness
-    set_log_filename();
-    set_log_chatter();
+    // If no --help option has been specified then proceed with loading
+    // the parameter file and opening the logger
+    if (!m_need_help) {
+
+        // Initialise application parameters
+        m_pars.load(par_filename(), m_args);
+
+        // Set log filename and chattiness
+        set_log_filename();
+        set_log_chatter();
+
+        // Initialise the application logger
+        logFileOpen();
-    // Initialise the application logger
-    logFileOpen();
+    } // endif: no --help option specified
     // Return
     return;
@@ -579,6 +596,7 @@ void GApplication::init_members(void)
     m_logfile.clear();
     m_args.clear();
     m_pars.clear();
+    m_need_help = false;
     // Save the execution calendar start time
     std::time(&m_tstart);
@@ -602,14 +620,15 @@ void GApplication::copy_members(const GApplication&amp; app)
     log = app.log;
     // Copy protected attributes
-    m_name    = app.m_name;
-    m_version = app.m_version;
-    m_parfile = app.m_parfile;
-    m_logfile = app.m_logfile;
-    m_args    = app.m_args;
-    m_tstart  = app.m_tstart;
-    m_cstart  = app.m_cstart;
-    m_pars    = app.m_pars;
+    m_name      = app.m_name;
+    m_version   = app.m_version;
+    m_parfile   = app.m_parfile;
+    m_logfile   = app.m_logfile;
+    m_args      = app.m_args;
+    m_tstart    = app.m_tstart;
+    m_cstart    = app.m_cstart;
+    m_pars      = app.m_pars;
+    m_need_help = app.m_need_help;
     // Return
     return;