Add GFilename::fullname() method that returns the full filename, including any extension.

Jürgen Knödlseder
1 parent a53748b6
Showing 5 changed files with 80 additions and 52 deletions
ChangeLog
NEWS
include/GFilename.hpp
pyext/GFilename.i
src/support/GFilename.cpp
-2016-02-22  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2016-02-12  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
         * Version 1.1.0 released
         =========================
-        Add GCTAEventList::remove method
+        Add GFilename::fullname() method
+        Add GCTAEventList::remove() method
         Handle also additional columns in GCTAEventList::append method
-        Correct GFitsTableCol::insert method for empty columns
-        Correct GCTAEdisp2D::compute_ebounds methods (#1662)
+        Correct GFitsTableCol::insert() method for empty columns
+        Correct GCTAEdisp2D::compute_ebounds_xxx() methods (#1662)
         Use GFilename in GFits to store filename (#1649)
         Load CTA GTI extension from the HDU name provided by the DSS keyword (#1598)
@@ -2,7 +2,7 @@ New Features and Important Changes in GammaLib 1.1.0
 Author(s) : Juergen Knoedlseder
-11 February 2016
+12 February 2016
 1. Introduction
@@ -74,7 +74,8 @@ None
 13. Support module
 ------------------
-None
+Add GFilename::fullname() method that returns the full filename including
+any FITS extension.
 14. XML module
 /***************************************************************************
  *                      GFilename.hpp - Filename class                     *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2015 by Juergen Knoedlseder                              *
+ *  copyright (C) 2015-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -59,6 +59,7 @@ public:
     bool               empty(void) const;
     int                size(void) const;
     int                length(void) const;
+    const std::string& fullname(void) const;
     const std::string& filename(void) const;
     std::string        extname(const std::string& defaultname = "") const;
     const std::string& expression(void) const;
@@ -78,10 +79,11 @@ protected:
     void set_filename(const std::string& filename);
     // Protected members
-    std::string m_filename;  //!< Filename (with stripped extension info)
-    std::string m_extname;   //!< Extension name ("": not set)
-    int         m_extno;     //!< Extension number  (-1: not set)
-    int         m_extver;    //!< Extension version (0: not set)
+    std::string m_fullname;   //!< Full file name
+    std::string m_filename;   //!< File name (with stripped extension info)
+    std::string m_extname;    //!< Extension name ("": not set)
+    int         m_extno;      //!< Extension number  (-1: not set)
+    int         m_extver;     //!< Extension version (0: not set)
     std::string m_expression; //!< Selection expression ("": not set)
 };
@@ -137,9 +139,25 @@ int GFilename::length(void) const
 /***********************************************************************//**
- * @brief Return file name
+ * @brief Return full filename
  *
- * @return String containing file name.
+ * @return String containing filename with extension.
+ *
+ * Returns the full filename, including any extension.
+ ***************************************************************************/
+inline
+const std::string& GFilename::fullname(void) const
+{
+    return (m_fullname);
+}
+
+
+/***********************************************************************//**
+ * @brief Return filename
+ *
+ * @return String containing filename without extension.
+ *
+ * Returns the file name without any extension.
  ***************************************************************************/
 inline
 const std::string& GFilename::filename(void) const
 /***************************************************************************
  *                       GFilename.i - Filename class                      *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2015 by Juergen Knoedlseder                              *
+ *  copyright (C) 2015-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -51,6 +51,7 @@ public:
     bool               empty(void) const;
     int                size(void) const;
     int                length(void) const;
+    const std::string& fullname(void) const;
     const std::string& filename(void) const;
     std::string        extname(const std::string& defaultname = "") const;
     const std::string& expression(void) const;
@@ -350,6 +350,7 @@ std::string GFilename::print(const GChatter&amp; chatter) const
 void GFilename::init_members(void)
 {
     // Initialise members
+    m_fullname.clear();
     m_filename.clear();
     m_extname.clear();
     m_extno  = -1;
@@ -369,10 +370,11 @@ void GFilename::init_members(void)
 void GFilename::copy_members(const GFilename& filename)
 {
     // Copy members
-    m_filename = filename.m_filename;
-    m_extname  = filename.m_extname;
-    m_extno    = filename.m_extno;
-    m_extver   = filename.m_extver;
+    m_fullname   = filename.m_fullname;
+    m_filename   = filename.m_filename;
+    m_extname    = filename.m_extname;
+    m_extno      = filename.m_extno;
+    m_extver     = filename.m_extver;
     m_expression = filename.m_expression;
     // Return
@@ -411,45 +413,48 @@ void GFilename::set_filename(const std::string&amp; filename)
     // Clear file name
     clear();
-    // Strip any whitespace
-    std::string fname = gammalib::strip_whitespace(filename);
+    // Strip any whitespace and store the full name
+    m_fullname = gammalib::strip_whitespace(filename);
     // Continue only if filename is not empty
-    if (!fname.empty()) {
+    if (!m_fullname.empty()) {
         // Check for [ symbol in filename
-        size_t start = fname.find_first_of("[");
+        size_t start = m_fullname.find_first_of("[");
         // If we have an extension then separate filename into filename
         // part and extension part and fill the information of th object
         if (start != std::string::npos) {
             // Check for ] symbol in filename
-            size_t stop = fname.find_first_of("]", start);
+            size_t stop = m_fullname.find_first_of("]", start);
             // If there is no ] symbol then throw an exception
             if (stop == std::string::npos) {
-                std::string msg = "Missing ] symbol in filename \""+
-                                  fname+"\" extension. Please correct the "
-                                  "filename.";
+                std::string msg = "Missing ] symbol in file name \""+
+                                  m_fullname+"\" extension. Please correct "
+                                  "the file name.";
                 throw GException::invalid_argument(G_SET_FILENAME, msg);
             }
             // If ] is not the last character then check if an opening bracket is next
-            if (stop < fname.length()-1) {
+            if (stop < m_fullname.length()-1) {
-                std::string character = gammalib::strip_whitespace(fname.substr(stop+1,1));
+                // Get character
+                std::string character = gammalib::strip_whitespace(m_fullname.substr(stop+1,1));
                 // If no bracket is coming, throw an exception
                 if (character != "[") {
-                    std::string msg = "Non-bracket character \""+character+"\" beyond ] symbol in filename \""+
-                            fname+"\" expression. Please correct the filename.";
+                    std::string msg = "Non-bracket character \""+character+
+                                      "\" beyond ] symbol in file name \""+
+                                      m_fullname+"\" expression. Please "
+                                      "correct the file name.";
                     throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
              }
             // Extract extension name
-            std::string extname = gammalib::strip_whitespace(fname.substr(start+1, stop-start-1));
+            std::string extname = gammalib::strip_whitespace(m_fullname.substr(start+1, stop-start-1));
             // Check if there is a , symbol that separates extension name
             // and extension version
@@ -464,8 +469,8 @@ void GFilename::set_filename(const std::string&amp; filename)
                 // If string is empty then throw an exception
                 if (extver.empty()) {
                     std::string msg = "No extension version found after , "
-                                      "symbol in filename \""+fname+
-                                      "\". Please correct the filename.";
+                                      "symbol in file name \""+m_fullname+
+                                      "\". Please correct the file name.";
                     throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
@@ -476,8 +481,9 @@ void GFilename::set_filename(const std::string&amp; filename)
                 // positive
                 if (m_extver <= 0) {
                     std::string msg = "Non-positive extension version "
-                                      "encountered in filename \""+fname+
-                                      "\". Please correct the filename.";
+                                      "encountered in file name \""+
+                                      m_fullname+ "\". Please correct the "
+                                      "file name.";
                     throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
@@ -489,8 +495,8 @@ void GFilename::set_filename(const std::string&amp; filename)
             // If we have an empty extension name then throw an exception
             if (extname.empty()) {
                 std::string msg = "An empty extension has been specified in "
-                                  "filename \""+fname+"\". Please correct the"
-                                  " filename.";
+                                  "file name \""+m_fullname+"\". Please "
+                                  "correct the file name.";
                 throw GException::invalid_argument(G_SET_FILENAME, msg);
             }
@@ -505,8 +511,8 @@ void GFilename::set_filename(const std::string&amp; filename)
                 // positive
                 if (m_extno < 0) {
                     std::string msg = "Negative extension number encountered "
-                                      "in filename \""+fname+"\". Please "
-                                      "correct the filename.";
+                                      "in file name \""+m_fullname+"\". "
+                                      "Please correct the file name.";
                     throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
@@ -521,48 +527,49 @@ void GFilename::set_filename(const std::string&amp; filename)
                 // Throw an exception if extension name is empty
                 if (m_extname.empty()) {
                     std::string msg = "Empty extension name encountered "
-                                      "in filename \""+fname+"\". Please "
-                                      "correct the filename.";
+                                      "in file name \""+m_fullname+"\". "
+                                      "Please correct the file name.";
                     throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
             } // endelse: extension name provided
             // Store the file name
-            m_filename = gammalib::strip_whitespace(fname.substr(0,start));
+            m_filename = gammalib::strip_whitespace(m_fullname.substr(0,start));
             // Check if there is an expression behind the extension name
-            size_t expr_start = fname.find_first_of("[", stop+1);
+            size_t expr_start = m_fullname.find_first_of("[", stop+1);
             if (expr_start != std::string::npos) {
                // Check for ] symbol in expression
-               size_t expr_stop = fname.find_first_of("]", expr_start);
+               size_t expr_stop = m_fullname.find_first_of("]", expr_start);
                // If there is no ] symbol then throw an exception
                if (expr_stop == std::string::npos) {
-                   std::string msg = "Missing ] symbol in filename \""+
-                                     fname+"\" expression. Please correct the "
-                                     "filename.";
+                   std::string msg = "Missing ] symbol in file name \""+
+                                     m_fullname+"\" expression. Please "
+                                     "correct the file name.";
                    throw GException::invalid_argument(G_SET_FILENAME, msg);
                }
                // If ] is not the last character then throw an exception
-               if (expr_stop < fname.length()-1) {
-                   std::string msg = "Characters beyond ] symbol in filename \""+
-                           fname+"\" expression. Please correct the filename.";
+               if (expr_stop < m_fullname.length()-1) {
+                   std::string msg = "Characters beyond ] symbol in file "
+                                     "name \""+m_fullname+"\" expression. "
+                                     "Please correct the file name.";
                    throw GException::invalid_argument(G_SET_FILENAME, msg);
                 }
                // Store expression
-               m_expression = gammalib::strip_whitespace(fname.substr(expr_start+1, expr_stop - expr_start-1));
+               m_expression = gammalib::strip_whitespace(m_fullname.substr(expr_start+1, expr_stop - expr_start-1));
             }
         } // endif: had extension
         // ... otherwise simply set the filename
         else {
-            m_filename = fname;
+            m_filename = m_fullname;
         }
     } // endif: filename was not empty