Add quotes to sky region names (#3280)

Jürgen Knödlseder
1 parent 1790bed6
Showing 6 changed files with 89 additions and 18 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.7.1.rst
src/sky/GSkyRegionCircle.cpp
test/data/test_circle_region.reg
test/test_GSky.cpp
@@ -3,6 +3,7 @@
         * Bug fix version 1.7.1 released
         ================================
+        Add quotes to sky region names (#3280)
         Fix broken power law flux and eflux computation bug (#3279)
@@ -86,7 +86,10 @@ None
 12. Sky module
 --------------
-None
+The region files written by GSkyRegions were not readable by ds9 when region
+names were specified. It turned out that region names have to be put in quotes,
+either ", ' or {}. I modified the GSkyRegionCircle::read() and write() methods
+to support this logic, where {} are used in GSkyRegionCircle::write() (#3280).
 13. Support module
@@ -10,5 +10,7 @@ GammaLib 1.7.1 is a bug fix release for GammaLib release 1.7.
 The following bugs were fixed:
+* [`3280 <https://cta-redmine.irap.omp.eu/issues/3280>`_] -
+  Add quotes to sky region names
 * [`3279 <https://cta-redmine.irap.omp.eu/issues/3279>`_] -
   Fix broken power law flux and eflux computation bug
@@ -303,8 +303,8 @@ void GSkyRegionCircle::read(const std::string&amp; line)
 	std::string system = gammalib::split(region_def, ";")[0];
 	// Get the substring of the important values
-	unsigned    pos          = region_def.find("circle(");
-	unsigned    end          = region_def.find(")");
+	size_t      pos          = region_def.find("circle(");
+	size_t      end          = region_def.find(")");
 	std::string circlestring = region_def.substr(pos+7, end);
 	circlestring.erase(circlestring.find(")"), 1);
@@ -355,21 +355,68 @@ void GSkyRegionCircle::read(const std::string&amp; line)
 	// Compute solid angle
 	compute_solid_angle();
-	// Check if there is a given name for the region and set it
-	std::vector<std::string>comments = gammalib::split(comment, " ");
-	for (int i = 0; i < comments.size(); i++) {
-		if (gammalib::contains(comments[i], "text")) {
-			std::vector<std::string> attributes = gammalib::split(comments[i], "=");
-			if (attributes.size() < 2) {
-                std::string msg =
-                      "Invalid character sequence encountered in provided"
-                      " string \""+line+"\".\n"
-                      "An attribute of the type \"text=Name\" is expected.";
-				throw GException::invalid_value(G_READ, msg);
-			}
-			m_name = attributes[1];
-		}
-	}
+	// Check if there is a given name for the region and set it. Strings may
+    // be quoted with " or ' or {}
+    pos = comment.find("text");
+    if (pos != std::string::npos) {
+        pos = comment.find("=", pos+4);
+        if (pos != std::string::npos) {
+
+            // Set possible quotes
+            const std::string quotes_open  = "{'\"";
+            const std::string quotes_close = "}'\"";
+
+            // Set quotes found flag
+            bool found = false;
+
+            // Search for possible quotes and extract name
+            for (int i = 0; i < quotes_open.size(); ++i) {
+                std::string quote_open  = quotes_open.substr(i,1);
+                std::string quote_close = quotes_close.substr(i,1);
+                pos = comment.find(quote_open, pos+1);
+                if (pos != std::string::npos) {
+                    end = comment.find(quote_close, pos+1);
+                    if (end != std::string::npos) {
+                        int length = end-pos-1;
+                        if (length > 0) {
+                            m_name = comment.substr(pos+1, length);
+                        }
+                        else {
+                            m_name = "";
+                        }
+                        found = true;
+                    }
+                    else {
+                        std::string msg = "Missing "+quote_open+" following "+
+                                          quote_close+" encountered after "
+                                          "text attribute. Please add closing "
+                                          "quotes to text="+quote_open+"Name"+
+                                          quote_close+" attribute.";
+                        throw GException::invalid_value(G_READ, msg);
+                    }
+                }
+            } // endfor: looped over possible quotes
+
+            // Throw an exception if no quotes were found
+            if (!found) {
+                std::string msg = "Missing quotes \" or ' or {} following "
+                                  "text attribute. Please specify quotes "
+                                  "around the names of the text, for example "
+                                  "text={Name}.";
+                throw GException::invalid_value(G_READ, msg);
+            }
+
+        } // endif: = character found
+
+        // Signal that no = character was found after text
+        else {
+            std::string msg = "Missing = following text attribute.  Please "
+                              "specify the value for a text attribute, "
+                              "for example text={Name}.";
+            throw GException::invalid_value(G_READ, msg);
+        }
+
+    } // endif: text attribute found
 	// Return
 	return;
@@ -401,7 +448,9 @@ std::string GSkyRegionCircle::write(void) const
     // Optionally add region name
     if (m_name.length() > 0) {
         result.append(" # text=");
+        result.append("{");
         result.append(m_name);
+        result.append("}");
     }
     // Return string
@@ -2,3 +2,7 @@
 global color=green dashlist=8 3 width=1 font="helvetica 10 normal roman" select=1 highlite=1 dash=0 fixed=0 edit=1 move=1 delete=1 include=1 source=1
 fk5
 circle(0.1, -35.6, 10.0)
+circle(0.1, -35.6, 10.0) # text={}
+circle(0.1, -35.6, 10.0) # text={Test 1}
+circle(0.1, -35.6, 10.0) # text='Test 2'
+circle(0.1, -35.6, 10.0) # text="Test 3"
@@ -1594,11 +1594,17 @@ void TestGSky::test_GSkyMap_io(void)
 	}
     // Check if region was loaded correctly
+    test_value(regions.size(), 5, "5 sky regions expected");
     GSkyRegionCircle* circle = dynamic_cast<GSkyRegionCircle*>(regions[0]);
     test_assert(circle->type() == "Circle", "Region is not a circle");
     test_value(circle->radius(), 10.0, 1.0e-10);
     test_value(circle->ra(), 0.1, 1.0e-10);
     test_value(circle->dec(), -35.6, 1.0e-10);
+    test_value(regions[0]->name(), "", "No name for first sky region");
+    test_value(regions[1]->name(), "", "Empty name for second sky region");
+    test_value(regions[2]->name(), "Test 1", "Name \"Test 1\" for third sky region");
+    test_value(regions[3]->name(), "Test 2", "Name \"Test 2\" for fourth sky region");
+    test_value(regions[4]->name(), "Test 3", "Name \"Test 3\" for fifth sky region");
 	// Test regions saving
 	test_try("Test regions saving");
@@ -1621,11 +1627,17 @@ void TestGSky::test_GSkyMap_io(void)
 	}
     // Check if region was loaded correctly
+    test_value(regions.size(), 5, "5 sky regions expected");
     circle = dynamic_cast<GSkyRegionCircle*>(regions[0]);
     test_assert(circle->type() == "Circle", "Region is not a circle");
     test_value(circle->radius(), 10.0, 1.0e-10);
     test_value(circle->ra(), 0.1, 1.0e-10);
     test_value(circle->dec(), -35.6, 1.0e-10);
+    test_value(regions[0]->name(), "", "No name for first sky region");
+    test_value(regions[1]->name(), "", "Empty name for second sky region");
+    test_value(regions[2]->name(), "Test 1", "Name \"Test 1\" for third sky region");
+    test_value(regions[3]->name(), "Test 2", "Name \"Test 2\" for fourth sky region");
+    test_value(regions[4]->name(), "Test 3", "Name \"Test 3\" for fifth sky region");
     // Exit test
     return;