GXmlAttribute class does no longer store the hyphens.

Hyphens are now stripped in the constructor and added back by the write() method.

GXmlAttribute class does no longer store the hyphens.
Hyphens are now stripped in the constructor and added back by the write() method.
Jürgen Knödlseder
1 parent 62fe5380
Showing 9 changed files with 145 additions and 228 deletions
ChangeLog
NEWS
README.md
include/GXmlAttribute.hpp
include/GXmlDocument.hpp
src/test/GTestSuite.cpp
src/xml/GXmlAttribute.cpp
src/xml/GXmlDocument.cpp
test/test_GXml.cpp
-2016-05-31  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2016-06-02  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
         * Version 1.1.0 released
         =========================
@@ -11,6 +11,7 @@
         Add component setting methods to GModelSky (#1770).
         Add GApplication::logFileClose() method.
         Add GModel::read_attributes() and write_attributes() private methods (#1765).
+        Also write test reports in case of an exception (#1746).
         Add GCTAObservation filename constructor (#1744).
         Add gammalib::number() function (#1743).
         Add GSkyMap::shape() and ndim() methods (#1733).
@@ -2,7 +2,7 @@ New Features and Important Changes in GammaLib 1.1.0
 Author(s) : Juergen Knoedlseder
-31 May 2016
+2 June 2016
 1. Introduction
@@ -271,7 +271,11 @@ easy creation of a CSV file, in particular from Python lists (#1773).
 14. XML module
 --------------
-None
+The GXmlAttribute class does no longer store the hyphens of an attribute, but
+the hyphens are stripped upon construction, and added back when writing the
+attribute into a URL. The side effect of this new behaviour is that XML test
+reports are also written in case that an exception has occured during a unit
+test (#1746).
 15. VO module
 GammaLib information
 ====================
-* Version: 1.1.0.dev1 (30 April 2016)
+* Version: 1.1.0.dev1 (2 June 2016)
 * Author:  Juergen Knoedlseder (jurgen.knodlseder@irap.omp.eu)
 [![Build Status](https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os)](https://cta-jenkins.irap.omp.eu/job/gammalib-integrate-os/)
 /***************************************************************************
  *           GXmlAttribute.hpp - XML attribute class definition            *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2015 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -48,8 +48,9 @@
  * - @p type has a value of "singleton"
  * - @p name has a value of "gamma-ray"
  *
- * The hyphens are stored together with the attribute value. Allowed hyphens
- * are " and '.
+ * The hyphens are stripped from the attribute value before storing in the
+ * name-value pair constructor. Hyphens are added when writing an attribute
+ * using the write() method. Allowed hyphens are " and '.
  ***************************************************************************/
 class GXmlAttribute : public GBase {
@@ -68,10 +69,10 @@ public:
     GXmlAttribute*     clone(void) const;
     std::string        classname(void) const;
     void               write(GUrl& url) const;
-    const std::string& name(void) const { return m_name; }
-    std::string        value(void) const;
-    void               name(const std::string& name) { m_name=name; }
-    void               value(std::string value);
+    const std::string& name(void) const;
+    const std::string& value(void) const;
+    void               name(const std::string& name);
+    void               value(const std::string& value);
     std::string        print(const GChatter& chatter = NORMAL) const;
 protected:
@@ -82,7 +83,7 @@ protected:
     // Protected data members
     std::string m_name;     //!< Attribute name
-    std::string m_value;    //!< Attribute value including hyphens
+    std::string m_value;    //!< Attribute value
 };
@@ -97,4 +98,53 @@ std::string GXmlAttribute::classname(void) const
     return ("GXmlAttribute");
 }
+
+/***********************************************************************//**
+ * @brief Return attribute name
+ *
+ * @return Attribute name.
+ ***************************************************************************/
+inline
+const std::string& GXmlAttribute::name(void) const
+{
+    return (m_name);
+}
+
+
+/***********************************************************************//**
+ * @brief Set attribute name
+ *
+ * @param[in] name Attribute name.
+ ***************************************************************************/
+inline
+void GXmlAttribute::name(const std::string& name)
+{
+    m_name = name;
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Return attribute value
+ *
+ * @return Attribute value.
+ ***************************************************************************/
+inline
+const std::string& GXmlAttribute::value(void) const
+{
+    return (m_value);
+}
+
+/***********************************************************************//**
+ * @brief Set attribute value
+ *
+ * @param[in] value Attribute value.
+ ***************************************************************************/
+inline
+void GXmlAttribute::value(const std::string& value)
+{
+    m_value = value;
+    return;
+}
+
 #endif /* GXMLATTRIBUTE_HPP */
 /***************************************************************************
  *           GXmlDocument.hpp - XML document node class definition         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -245,7 +245,7 @@ void GTestSuite::append(const pfunction function, const std::string&amp; name)
 /***********************************************************************//**
  * @brief Run all tests in test suite
  *
- * @return True is all tests were successful, false otherwise.
+ * @return True if all tests were successful, false otherwise.
  *
  * Executes all test functions that have been appended to the test suite.
  * For each test function a test case is added to the test suite.
@@ -309,6 +309,7 @@ bool GTestSuite::run(void)
             {
                 // For other exceptions
                 test->has_passed(false);
+                test->message("Non-standard C++ exception thrown");
             }
             // Compute elapsed time
 /***************************************************************************
  *         GXmlAttribute.cpp - XML attribute class implementation          *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -28,12 +28,11 @@
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
-#include "GException.hpp"
+//#include "GException.hpp"
 #include "GTools.hpp"
 #include "GXmlAttribute.hpp"
 /* __ Method name definitions ____________________________________________ */
-#define G_VALUE                           "GXmlAttribute::value(std::string)"
 /* __ Macros _____________________________________________________________ */
@@ -85,18 +84,31 @@ GXmlAttribute::GXmlAttribute(const GXmlAttribute&amp; attr)
  * @param[in] name Attribute name.
  * @param[in] value Attribute value.
  *
- * Construct attribute form a p@ name and a @p value. Predefined entities
+ * Construct attribute form a @p name and a @p value. Predefined entities
  * (e.g. &quot;) in attribute values are automatically converted into normal
- * characters.
+ * characters. The constructor strips any existing " or ' leading and
+ * trailing hyphens from the @p value string.
  ***************************************************************************/
 GXmlAttribute::GXmlAttribute(const std::string& name, const std::string& value)
 {
     // Initialise members
     init_members();
+    // Create working copy of attribute value
+    std::string v(value);
+
+    // Strip any pair of leading and trailing hyphens
+    int n = v.length();
+    if (n > 2) {
+        if (((v[0] ==  '"') && (v[n-1] ==  '"')) ||
+            ((v[0] == '\'') && (v[n-1] == '\''))) {
+            v = v.substr(1, n-2);
+        }
+    }
+
     // Set attribute
     this->name(name);
-    this->value(gammalib::xml2str(value));
+    this->value(gammalib::xml2str(v));
     // Return
     return;
@@ -195,11 +207,8 @@ GXmlAttribute* GXmlAttribute::clone(void) const
  ***************************************************************************/
 void GXmlAttribute::write(GUrl& url) const
 {
-    // Get value without quotation marks
-    std::string value = m_value.substr(1, m_value.length()-2);
-
-    // Convert value to XML format
-    value = "\""+gammalib::str2xml(value)+"\"";
+    // Convert value into XML format and add hyphens
+    std::string value = "\""+gammalib::str2xml(m_value)+"\"";
     // Write attribute into URL
     url.printf(" %s=%s", m_name.c_str(), value.c_str());
@@ -212,7 +221,7 @@ void GXmlAttribute::write(GUrl&amp; url) const
 /***********************************************************************//**
  * @brief Print element attribute
  *
- * @param[in] chatter Chattiness (defaults to NORMAL).
+ * @param[in] chatter Chattiness.
  * @return String containing element attribute.
  ***************************************************************************/
 std::string GXmlAttribute::print(const GChatter& chatter) const
@@ -224,7 +233,7 @@ std::string GXmlAttribute::print(const GChatter&amp; chatter) const
     if (chatter != SILENT) {
         // Append attribute to string
-        result.append(" "+m_name+"="+m_value);
+        result.append(" "+m_name+"=\""+m_value+"\"");
     } // endif: chatter was not silent
@@ -233,104 +242,6 @@ std::string GXmlAttribute::print(const GChatter&amp; chatter) const
 }
-/***********************************************************************//**
- * @brief Returns attribute value
- *
- * @return String containing the attribute value without hyphens.
- *
- * Returns the attribute value by stripping the hyphens.
- ***************************************************************************/
-std::string GXmlAttribute::value(void) const
-{
-    // Initialise attribute value
-    std::string value = "";
-
-    // Extract value by stripping hyphens
-    int n = m_value.length();
-    if (n > 2) {
-        value = m_value.substr(1, n-2);
-    }
-
-    // Return value
-    return value;
-}
-
-
-/***********************************************************************//**
- * @brief Set attribute value
- *
- * @param[in] value Attribute value.
- *
- * @exception GException::xml_attribute_value
- *            Invalid XML attribute value.
- *
- * Sets the value of the attribute. The method automatically adds the proper
- * hyphens to the value string if they do not exist.
- ***************************************************************************/
-void GXmlAttribute::value(std::string value)
-{
-    // Get length of value string
-    int n = value.length();
-
-    // Count hyphens and signal their presence at start/end
-    int  n_hyphens1 = 0;
-    int  n_hyphens2 = 0;
-    bool has_hyphens1 = (n >= 2 && value[0] == '\'' && value[n-1] == '\'');
-    bool has_hyphens2 = (n >= 2 && value[0] ==  '"' && value[n-1] ==  '"');
-    for (int i = 0; i < n; ++i) {
-        if (value[i] == '\'') n_hyphens1++;
-        if (value[i] ==  '"') n_hyphens2++;
-    }
-
-    // Case A: value has ' start and end hyphens. Keep value as is if no other
-    // ' hyphens are found. Otherwise, if more than 2 ' but no " hyphen is found
-    // then enclose the value in " hyphens. Finally, if more than 2 ' and at
-    // least one " hyphen is found we have an invalid value and throw an
-    // exception.
-    if (has_hyphens1) {
-        if (n_hyphens1 > 2 && n_hyphens2 == 0) {
-            value = "\"" + value + "\"";
-        }
-        else if (n_hyphens1 > 2 && n_hyphens2 > 0) {
-            throw GException::xml_attribute_value(G_VALUE, value);
-        }
-    }
-
-    // Case B: value has " start and end hyphens. Keep value as is if no other
-    // " hyphens are found. Otherwise, if more than 2 " but no ' hyphen is found
-    // then enclose the value in ' hyphens. Finally, if more than 2 " and at
-    // least one ' hyphen is found we have an invalid value and throw an
-    // exception.
-    else if (has_hyphens2) {
-        if (n_hyphens1 == 0 && n_hyphens2 > 2) {
-            value = "'" + value + "'";
-        }
-        else if (n_hyphens1 > 0 && n_hyphens2 > 2) {
-            throw GException::xml_attribute_value(G_VALUE, value);
-        }
-    }
-
-    // Case C: value has no start and end hyphens.
-    else {
-        if (n_hyphens1 >= 0 && n_hyphens2 == 0) {
-            value = "\"" + value + "\"";
-        }
-        else if (n_hyphens1 == 0 && n_hyphens2 > 0) {
-            value = "'" + value + "'";
-        }
-        else {
-            throw GException::xml_attribute_value(G_VALUE, value);
-        }
-    }
-
-    // Set value
-    m_value = value;
-
-    // Return
-    return;
-}
-
-
 /*==========================================================================
  =                                                                         =
  =                             Private methods                             =
 /***************************************************************************
  *        GXmlDocument.cpp - XML document node class implementation        *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -175,10 +175,11 @@ GXmlDocument* GXmlDocument::clone(void) const
 void GXmlDocument::write(GUrl& url, const int& indent) const
 {
     // Write document header into URL
-    url.printf("<?xml version=\"%s\" encoding=\"%s\" standalone=\"%s\"?>\n",
-               version().c_str(),
-               encoding().c_str(),
-               standalone().c_str());
+    url.printf("<?xml");
+    m_version.write(url);
+    m_encoding.write(url);
+    m_standalone.write(url);
+    url.printf("?>\n");
     // Write children into URL
     for (int i = 0; i < m_nodes.size(); ++i) {
@@ -211,9 +212,9 @@ std::string GXmlDocument::print(const GChatter&amp; chatter,
         // Append document to string
         result.append("GXmlDocument::");
-        result.append("version=" + version());
-        result.append(" encoding=" + encoding());
-        result.append(" standalone=" + standalone());
+        result.append("version=\"" + version() +"\"");
+        result.append(" encoding=\"" + encoding() +"\"");
+        result.append(" standalone=\"" + standalone() +"\"");
         // Append children
         for (int i = 0; i < m_nodes.size(); ++i) {
@@ -244,10 +245,10 @@ void GXmlDocument::init_members(void)
     m_standalone.clear();
     m_version.name("version");
     m_encoding.name("encoding");
-    m_standalone.name("m_standalone");
-    m_version.value("\"1.0\"");
-    m_encoding.value("\"UTF-8\"");
-    m_standalone.value("\"no\"");
+    m_standalone.name("standalone");
+    m_version.value("1.0");
+    m_encoding.value("UTF-8");
+    m_standalone.value("no");
     // Return
     return;
 /***************************************************************************
  *                    test_GXml.cpp - Test xml module                      *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -44,11 +44,16 @@ void TestGXml::set(void)
     m_xml_file = "data/test.xml";
     // Append tests
-    append(static_cast<pfunction>(&TestGXml::test_GXml_attributes), "Test XML attributes");
-    append(static_cast<pfunction>(&TestGXml::test_GXml_elements), "Test XML elements");
-    append(static_cast<pfunction>(&TestGXml::test_GXml_construct),"Test XML constructors");
-    append(static_cast<pfunction>(&TestGXml::test_GXml_load),"Test XML load");
-    append(static_cast<pfunction>(&TestGXml::test_GXml_access), "Test XML access");
+    append(static_cast<pfunction>(&TestGXml::test_GXml_attributes),
+           "Test XML attributes");
+    append(static_cast<pfunction>(&TestGXml::test_GXml_elements),
+           "Test XML elements");
+    append(static_cast<pfunction>(&TestGXml::test_GXml_construct),
+           "Test XML constructors");
+    append(static_cast<pfunction>(&TestGXml::test_GXml_load),
+           "Test XML load");
+    append(static_cast<pfunction>(&TestGXml::test_GXml_access),
+           "Test XML access");
     // Return
     return; 
@@ -68,94 +73,38 @@ TestGXml* TestGXml::clone(void) const
 /***********************************************************************//**
- * @brief Test XML arrtibutes
+ * @brief Test XML attributes
  **************************************************************************/
 void TestGXml::test_GXml_attributes(void)
 {
-    // Test valid attributes
-    test_try("Test valid attributes");
-    try {
-        GXmlAttribute attr("test", "1.0");
-        test_assert(attr.value() == "1.0","Test if value()= 1.0","Unexpected attribute "+attr.value());
-
-        attr.value("\"1.0\"");
-        test_assert(attr.value() == "1.0","Test if value()= 1.0","Unexpected attribute "+attr.value());
-
-        attr.value("'1.0'");
-        test_assert(attr.value() == "1.0","Test if value()= 1.0","Unexpected attribute "+attr.value());
-
-        attr.value("''1.0'");
-        test_assert(attr.value() == "''1.0'",
-                              "Test if value()= ''1.0'",
-                              "Unexpected attribute "+attr.value());
-
-        attr.value("'1.0");
-        test_assert(attr.value() == "'1.0",
-                              "Test if value()= '1.0",
-                              "Unexpected attribute "+attr.value());
-
-        attr.value("1.0'");
-        test_assert(attr.value() == "1.0'",
-                              "Test if value()= 1.0'",
-                              "Unexpected attribute "+attr.value());
-
-        attr.value("\"1.0");
-        test_assert(attr.value() == "\"1.0",
-                              "Test if value()= \"1.0",
-                              "Unexpected attribute "+attr.value());
-
-
-        attr.value("1.0\"");
-        test_assert(attr.value() == "1.0\"",
-                              "Test if value()= 1.0\"",
-                              "Unexpected attribute "+attr.value());
-
-        attr.value("\"\"1.0\"");
-        test_assert(attr.value() == "\"\"1.0\"",
-                              "Test if value()= \"\"1.0\"",
-                              "Unexpected attribute "+attr.value());
-        test_try_success();
-    }
-    catch (std::exception &e) {
-        test_try_failure(e);
-    }
-
-    // Test invalid attributes
-    test_try("Test invalid attributes 1");
-    try {
-        GXmlAttribute attr("test", "\"\"1.0'\"");
-        test_try_failure();
-    }
-    catch (GException::xml_attribute_value &e) {
-        test_try_success();
-    }
-    catch (std::exception &e) {
-        test_try_failure(e);
-    }
-
-    test_try("Test invalid attributes 2");
-    try {
-        GXmlAttribute attr("test", "''1.0\"");
-        test_try_failure();
-    }
-    catch (GException::xml_attribute_value &e) {
-        test_try_success();
-    }
-    catch (std::exception &e) {
-        test_try_failure(e);
-    }
-
-    test_try("Test invalid attributes 3");
-    try {
-        GXmlAttribute attr("test", "\"1.0'");
-        test_try_failure();
-    }
-    catch (GException::xml_attribute_value &e) {
-        test_try_success();
-    }
-    catch (std::exception &e) {
-        test_try_failure(e);
-    }
+    // Test attribute name-value constructors
+    GXmlAttribute attr1("test", "1.0");
+    test_assert(attr1.value() == "1.0", "Test if value()= 1.0",
+                "Unexpected attribute "+attr1.value());
+    GXmlAttribute attr2("test", "\"1.0\"");
+    test_assert(attr2.value() == "1.0", "Test if value()= 1.0",
+                "Unexpected attribute "+attr2.value());
+    GXmlAttribute attr3("test", "'1.0'");
+    test_assert(attr3.value() == "1.0", "Test if value()= 1.0",
+                "Unexpected attribute "+attr3.value());
+    GXmlAttribute attr4("test", "''1.0'");
+    test_assert(attr4.value() == "'1.0", "Test if value()= '1.0",
+                "Unexpected attribute "+attr4.value());
+    GXmlAttribute attr5("test", "'1.0");
+    test_assert(attr5.value() == "'1.0", "Test if value()= '1.0",
+                "Unexpected attribute "+attr5.value());
+    GXmlAttribute attr6("test", "1.0'");
+    test_assert(attr6.value() == "1.0'", "Test if value()= 1.0'",
+                "Unexpected attribute "+attr6.value());
+    GXmlAttribute attr7("test", "\"1.0");
+    test_assert(attr7.value() == "\"1.0", "Test if value()= \"1.0",
+                "Unexpected attribute "+attr7.value());
+    GXmlAttribute attr8("test", "1.0\"");
+    test_assert(attr8.value() == "1.0\"", "Test if value()= 1.0\"",
+                "Unexpected attribute "+attr8.value());
+    GXmlAttribute attr9("test", "\"\"1.0\"");
+    test_assert(attr9.value() == "\"1.0", "Test if value()= \"1.0",
+                "Unexpected attribute "+attr9.value());
     // Return
     return;