Add some operators to the GFilename class.

Jürgen Knödlseder
1 parent bedebe80
Showing 4 changed files with 95 additions and 37 deletions
include/GFilename.hpp
pyext/GFilename.i
src/fits/GFits.cpp
src/obs/GGti.cpp
@@ -61,6 +61,12 @@
  ***************************************************************************/
 class GFilename : public GBase {
+    // Friend functions
+    friend std::string operator+(const GFilename& filename, const std::string& string);
+    friend std::string operator+(const std::string& string, const GFilename& filename);
+    friend bool        operator==(const GFilename &a, const GFilename &b);
+    friend bool        operator!=(const GFilename &a, const GFilename &b);
+    
 public:
     // Constructors and destructors
     GFilename(void);
@@ -71,7 +77,7 @@ public:
     // Operators
     GFilename&         operator=(const GFilename& filename);
-    const std::string& operator()(void) const;
+                       operator std::string(void) const;
     // Methods
     void               clear(void);
@@ -83,6 +89,9 @@ public:
     //std::string        protocol(void) const;
     //std::string&       path(void) const;
     //std::string&       file(void) const;
+    //bool               exists(void) const;
+    //bool               is_fits(void) const;
+    //void               remove(void) const;
     std::string        extname(const std::string& defaultname = "") const;
     const std::string& expression(void) const;
     int                extno(const int& defaultno = -1) const;
@@ -114,16 +123,16 @@ protected:
 /***********************************************************************//**
- * @brief Filename operator
+ * @brief Implicit filename std::string convertor
  *
- * @return Full filename.
+ * @return Full filename as std::string.
  *
- * Returns the full filename including any FITS extension.
+ * Returns the full filename including any FITS extension as std::string.
  ***************************************************************************/
 inline
-const std::string& GFilename::operator()(void) const
+GFilename::operator std::string(void) const
 {
-    return (m_fullname);
+    return (gammalib::expand_env(m_fullname));
 }
@@ -237,4 +246,60 @@ bool GFilename::has_expression(void) const
     return (!m_expression.empty());
 }
+
+/***********************************************************************//**
+ * @brief String addition operator
+ *
+ * @param[in] filename Filename.
+ * @param[in] string String.
+ * @return String with filename + string.
+ ***************************************************************************/
+inline
+std::string operator+(const GFilename& filename, const std::string& string)
+{
+    return (std::string(filename)+string);
+}
+
+
+/***********************************************************************//**
+ * @brief String addition operator
+ *
+ * @param[in] string String.
+ * @param[in] filename Filename.
+ * @return String with string + filename.
+ ***************************************************************************/
+inline
+std::string operator+(const std::string& string, const GFilename& filename)
+{
+    return (string+std::string(filename));
+}
+
+
+/***********************************************************************//**
+ * @brief Filename equality operator
+ *
+ * @param[in] a First filename.
+ * @param[in] b Second filename.
+ * @return True if filenames are equal.
+ ***************************************************************************/
+inline
+bool operator==(const GFilename &a, const GFilename &b)
+{
+    return (std::string(a) == std::string(b));
+}
+
+
+/***********************************************************************//**
+ * @brief Filename inequality operator
+ *
+ * @param[in] a First filename.
+ * @param[in] b Second filename.
+ * @return True if filenames are not equal.
+ ***************************************************************************/
+inline
+bool operator!=(const GFilename &a, const GFilename &b)
+{
+    return (std::string(a) != std::string(b));
+}
+
 #endif /* GFILENAME_HPP */
@@ -44,9 +44,6 @@ public:
     GFilename(const char* filename);
     virtual ~GFilename(void);
-    // Operators
-    const std::string& operator()(void) const;
-
     // Methods
     void               clear(void);
     GFilename*         clone(void) const;
@@ -1017,19 +1017,19 @@ void GFits::open(const GFilename&amp; filename, const bool&amp; create)
     m_hdu.clear();
     // Expand environment variables
-    std::string fname(gammalib::expand_env(filename()));
+    //std::string fname(gammalib::expand_env(filename()));
     // Don't allow opening if a file is already open
     if (m_fitsfile != NULL) {
         std::string msg;
-        if (m_filename.url() == GFilename(fname).url()) {
-            msg = "FITS file \""+m_filename.url()+"\" has already been "
+        if (m_filename == filename) {
+            msg = "FITS file \""+m_filename+"\" has already been "
                   "opened, cannot open it again.";
         }
         else {
-            msg = "A FITS file \""+m_filename.url()+"\" has already "
+            msg = "A FITS file \""+m_filename+"\" has already "
                   "been opened, cannot open another FITS file \""+
-                  fname+"\" before closing the existing one.";
+                  filename+"\" before closing the existing one.";
         }
         throw GException::invalid_argument(G_OPEN, msg);
     }
@@ -1040,12 +1040,12 @@ void GFits::open(const GFilename&amp; filename, const bool&amp; create)
     // Try opening FITS file with readwrite access
     int status = 0;
-    status     = __ffopen(FHANDLE(m_fitsfile), fname.c_str(), 1, &status);
+    status     = __ffopen(FHANDLE(m_fitsfile), filename.c_str(), 1, &status);
     // If failed then try opening as readonly
     if (status == 104 || status == 112) {
         status      = 0;
-        status      = __ffopen(FHANDLE(m_fitsfile), fname.c_str(), 0, &status);
+        status      = __ffopen(FHANDLE(m_fitsfile), filename.c_str(), 0, &status);
         m_readwrite = false;
     }
@@ -1053,7 +1053,7 @@ void GFits::open(const GFilename&amp; filename, const bool&amp; create)
     // FITS file now
     if (create && status == 104) {
         status      = 0;
-        status      = __ffinit(FHANDLE(m_fitsfile), fname.c_str(), &status);
+        status      = __ffinit(FHANDLE(m_fitsfile), filename.c_str(), &status);
         m_readwrite = true;
         m_created   = true;
     }
@@ -1061,17 +1061,17 @@ void GFits::open(const GFilename&amp; filename, const bool&amp; create)
     // Throw special exception if status=202 (keyword not found). This error
     // may occur if the file is opened with an expression
     if (status == 202) {
-        throw GException::fits_open_error(G_OPEN, fname, status,
+        throw GException::fits_open_error(G_OPEN, filename, status,
                           "Keyword not found when opening file.");
     }
     // Throw any other error
     else if (status != 0) {
-        throw GException::fits_open_error(G_OPEN, fname, status);
+        throw GException::fits_open_error(G_OPEN, filename, status);
     }
     // Store FITS file name as GFilename object
-    m_filename = GFilename(fname);
+    m_filename = filename;
     // Determine number of HDUs
     int num_hdu = 0;
@@ -1227,11 +1227,8 @@ void GFits::save(const bool&amp; clobber)
  ***************************************************************************/
 void GFits::saveto(const GFilename& filename, const bool& clobber)
 {
-    // Expand environment variables
-    std::string fname = gammalib::expand_env(filename());
-
     // Create gzipped file name version
-    std::string gzfname = fname + ".gz";
+    std::string gzfname = filename + ".gz";
     // Debug header
     #if defined(G_DEBUG)
@@ -1243,8 +1240,8 @@ void GFits::saveto(const GFilename&amp; filename, const bool&amp; clobber)
     // consider here also the possibility that the file is gzipped, but
     // the file name does not contain the .gz extension.
     if (clobber) {
-        if (gammalib::file_exists(fname)) {
-            std::remove(fname.c_str());
+        if (gammalib::file_exists(filename)) {
+            std::remove(filename.c_str());
         }
         else {
             if (gammalib::file_exists(gzfname)) {
@@ -1254,25 +1251,24 @@ void GFits::saveto(const GFilename&amp; filename, const bool&amp; clobber)
     }
     // Otherwise, if file exists then throw an exception
-    else if (gammalib::file_exists(fname) ||
+    else if (gammalib::file_exists(filename) ||
              gammalib::file_exists(gzfname)) {
-        throw GException::fits_file_exist(G_SAVETO, fname);
+        throw GException::fits_file_exist(G_SAVETO, filename);
     }
     // Create or open FITS file
-    GFits new_fits;
-    new_fits.open(fname, true);
+    GFits fits(filename, true);;
     // Append all headers
     for (int i = 0; i < size(); ++i) {
-        new_fits.append(*m_hdu[i]);
+        fits.append(*m_hdu[i]);
     }
-    // Save new FITS file
-    new_fits.save();
+    // Save FITS file
+    fits.save();
-    // Close new FITS file
-    new_fits.close();
+    // Close FITS file
+    fits.close();
     // Debug trailer
     #if defined(G_DEBUG)
@@ -830,7 +830,7 @@ void GGti::write(GXmlElement&amp; xml) const
         if (!m_xml_filename.is_empty()) {
             // Write "file" attribute
-            par->attribute("file", m_xml_filename());
+            par->attribute("file", m_xml_filename);
             // Write GTI file
             save(m_xml_filename, true);
@@ -1059,7 +1059,7 @@ std::string GGti::print(const GChatter&amp; chatter) const
         // Optionally append XML filename
         if (!m_xml_filename.is_empty()) {
             result.append("\n"+gammalib::parformat("File name"));
-            result.append(m_xml_filename());
+            result.append(m_xml_filename);
         }
     } // endif: chatter was not silent