Improve error messages.

include/mapnik/config_error.hpp

@@ -28,29 +28,25 @@
 
 namespace mapnik {
 
+class xml_node;
 class config_error : public std::exception
 {
 public:
     config_error() {}
 
-    config_error( const std::string & what ) :
-        what_( what )
-    {
-    }
+    config_error(std::string const& what, xml_node const* node = 0, std::string const& filename="");
+    config_error(unsigned line_number, std::string const& filename, std::string const& what);
     virtual ~config_error() throw() {}
 
-    virtual const char * what() const throw()
-    {
-        return what_.c_str();
-    }
+    virtual const char * what() const throw();
 
-    void append_context(const std::string & ctx) const
-    {
-        what_ += " " + ctx;
-    }
+    void append_context(const std::string & ctx, xml_node const* node = 0, std::string const& filename="") const;
 
 protected:
     mutable std::string what_;
+    mutable unsigned line_number_;
+    mutable std::string file_;
+    mutable std::string node_name_;
 };
 }
 

include/mapnik/raster_colorizer.hpp

@@ -39,7 +39,6 @@
 
 // mapnik
 #include <mapnik/config.hpp>
-#include <mapnik/config_error.hpp>
 #include <mapnik/color.hpp>
 #include <mapnik/feature.hpp>
 #include <mapnik/enumeration.hpp>

include/mapnik/value.hpp

@@ -26,7 +26,6 @@
 // mapnik
 #include <mapnik/global.hpp>
 #include <mapnik/unicode.hpp>
-#include <mapnik/config_error.hpp>
 
 // boost
 #include <boost/variant.hpp>

include/mapnik/xml_tree.hpp

@@ -96,8 +96,11 @@ class xml_node
     void add_attribute(std::string const& name, std::string const& value);
     attribute_map const& get_attributes() const;
 
+    bool processed() const;
     void set_processed(bool processed) const;
 
+    unsigned line() const;
+
     const_iterator begin() const;
     const_iterator end() const;
 

src/agg/agg_renderer.cpp

@@ -26,7 +26,6 @@
 #include <mapnik/agg_rasterizer.hpp>
 #include <mapnik/marker_cache.hpp>
 #include <mapnik/unicode.hpp>
-#include <mapnik/config_error.hpp>
 #include <mapnik/font_set.hpp>
 #include <mapnik/parse_path.hpp>
 #include <mapnik/map.hpp>

src/build.py

@@ -179,6 +179,7 @@ def ldconfig(*args,**kwargs):
     text_placements/simple.cpp
     text_properties.cpp
     xml_tree.cpp
+    config_error.cpp
     """   
     )
 

src/cairo_renderer.cpp

@@ -29,7 +29,6 @@
 #include <mapnik/unicode.hpp>
 #include <mapnik/markers_placement.hpp>
 #include <mapnik/arrow.hpp>
-#include <mapnik/config_error.hpp>
 #include <mapnik/parse_path.hpp>
 #include <mapnik/marker_cache.hpp>
 #include <mapnik/svg/svg_path_adapter.hpp>

src/config_error.cpp

@@ -0,0 +1,44 @@
+#include <mapnik/config_error.hpp>
+#include <mapnik/xml_tree.hpp>
+
+namespace mapnik
+{
+config_error::config_error(std::string const& what, xml_node const* node, std::string const& filename)
+    : what_( what ), file_(filename)
+{
+    if (node)
+    {
+        node_name_ = node->name();
+        line_number_ = node->line();
+    }
+}
+
+
+config_error::config_error(unsigned line_number, std::string const& filename, std::string const& what)
+    : what_( what ), line_number_(line_number), file_(filename)
+{
+
+}
+
+ char const* config_error::what() const throw()
+{
+    std::stringstream s;
+    s << file_;
+    if (line_number_ > 0) s << " line " << line_number_;
+    if (!node_name_.empty()) s << " in node "<< node_name_;
+    if (line_number_ > 0 || !file_.empty()) s << ": ";
+    s << what_;
+    return s.str().c_str();
+}
+
+void config_error::append_context(const std::string & ctx, xml_node const* node, std::string const& filename) const
+{
+    what_ += " " + ctx;
+    if (node)
+    {
+        if (!line_number_) line_number_ = node->line();
+        if (node_name_.empty()) node_name_ = node->name();
+        if (file_.empty()) file_ = filename;
+    }
+}
+}

src/formatting/registry.cpp

@@ -25,6 +25,7 @@
 #include <mapnik/formatting/format.hpp>
 #include <mapnik/formatting/expression.hpp>
 #include <mapnik/xml_tree.hpp>
+#include <mapnik/config_error.hpp>
 
 namespace mapnik
 {
@@ -50,7 +51,7 @@ void registry::register_name(std::string name, from_xml_function_ptr ptr, bool o
 node_ptr registry::from_xml(xml_node const& xml)
 {
     std::map<std::string, from_xml_function_ptr>::const_iterator itr = map_.find(xml.name());
-    if (itr == map_.end())  throw config_error("Unknown element '" + xml.name() + "'");
+    if (itr == map_.end())  throw config_error("Unknown element '" + xml.name() + "'", &xml);
     return itr->second(xml);
 }
 } //ns formatting

src/grid/grid_renderer.cpp

@@ -31,7 +31,6 @@
 
 #include <mapnik/marker_cache.hpp>
 #include <mapnik/unicode.hpp>
-#include <mapnik/config_error.hpp>
 #include <mapnik/font_set.hpp>
 #include <mapnik/parse_path.hpp>
 #include <mapnik/map.hpp>

src/libxml2_loader.cpp

@@ -77,8 +77,7 @@ class libxml2_loader : boost::noncopyable
         boost::filesystem::path path(filename);
         if (!boost::filesystem::exists(path))
         {
-            throw config_error(string("Could not load map file '") +
-                               filename + "': File does not exist");
+            throw config_error(string("Could not load map file: File does not exist"), 0, filename);
         }
 
         xmlDocPtr doc = xmlCtxtReadFile(ctx_, filename.c_str(), encoding_, options_);
@@ -93,15 +92,7 @@ class libxml2_loader : boost::noncopyable
                 os << ": " << std::endl << error->message;
                 // remove CR
                 std::string msg = os.str().substr(0, os.str().size() - 1);
-                config_error ex(msg);
-
-                os.str("");
-                os << "(encountered in file '" << error->file << "' at line "
-                   << error->line << ")";
-
-                ex.append_context(os.str());
-
-                throw ex;
+                throw config_error(error->line, error->file, msg);
             }
         }
 
@@ -148,7 +139,7 @@ class libxml2_loader : boost::noncopyable
             {
                 os << ": " << std::endl << error->message;
             }
-            throw config_error(os.str());
+            throw config_error(error->line, error->file, os.str());
         }
 
         int iXIncludeReturn = xmlXIncludeProcessFlags(doc, options_);

src/load_map.cpp

@@ -195,7 +195,7 @@ expression_ptr map_parser::parse_expr(std::string const& str)
     expression_ptr expr(boost::make_shared<expr_node>(true));
     if (!expression_factory::parse_from_string(expr,str,expr_grammar_))
     {
-        throw mapnik::config_error( "Failed to parse expression: '" + str + "'" );
+        throw mapnik::config_error( "Failed to parse expression '" + str + "'" );
     }
     return expr;
 
@@ -354,7 +354,7 @@ void map_parser::parse_map(Map & map, xml_node const& pt, std::string const& bas
         }
         catch (const config_error & ex)
         {
-            ex.append_context("(in node Map)");
+            ex.append_context("", &map_node, filename_);
             throw;
         }
 
@@ -458,7 +458,7 @@ void map_parser::parse_map_include(Map & map, xml_node const& include)
         }
     }
     } catch (const config_error & ex) {
-        ex.append_context(std::string("in map '") + filename_ + "'");
+        ex.append_context("", &include, filename_);
         throw;
     }
 
@@ -489,7 +489,7 @@ void map_parser::parse_style(Map & map, xml_node const& sty)
 
         map.insert_style(name, style);
     } catch (const config_error & ex) {
-        ex.append_context(std::string("in style '") + name + "'");
+        ex.append_context(std::string("in style '") + name + "'", &sty, filename_);
         throw;
     }
 }
@@ -504,7 +504,7 @@ void map_parser::parse_metawriter(Map & map, xml_node const& pt)
         writer = metawriter_create(pt);
         map.insert_metawriter(name, writer);
     } catch (const config_error & ex) {
-        ex.append_context(std::string("in meta writer '") + name + "'");
+        ex.append_context(std::string("in meta writer '") + name + "'", &pt, filename_);
     }
 }
 
@@ -533,7 +533,7 @@ void map_parser::parse_fontset(Map & map, xml_node const& fset)
         // when it's parsed
         fontsets_.insert(pair<std::string, font_set>(name, fontset));
     } catch (const config_error & ex) {
-        ex.append_context(std::string("in FontSet '") + name + "'");
+        ex.append_context(std::string("in FontSet '") + name + "'", &fset, filename_);
         throw;
     }
 }
@@ -551,7 +551,7 @@ void map_parser::parse_font(font_set &fset, xml_node const& f)
     }
     else
     {
-        throw config_error(std::string("Must have 'face-name' set"));
+        throw config_error("Must have 'face-name' set", &f, filename_);
     }
 }
 

src/metawriter_factory.cpp

@@ -26,6 +26,7 @@
 #include <mapnik/metawriter_inmem.hpp>
 #include <mapnik/xml_tree.hpp>
 #include <mapnik/ptree_helpers.hpp>
+#include <mapnik/config_error.hpp>
 
 #include <boost/optional.hpp>
 
@@ -60,7 +61,7 @@ metawriter_create(xml_node const& pt)
         metawriter_inmem_ptr inmem = metawriter_inmem_ptr(new metawriter_inmem(properties));
         writer = inmem;
     } else {
-        throw config_error(string("Unknown type '") + type + "'");
+        throw config_error(string("Unknown type '") + type + "'", &pt);
     }
 
     return writer;

src/processed_text.cpp

@@ -1,4 +1,28 @@
+/*****************************************************************************
+ *
+ * This file is part of Mapnik (c++ mapping toolkit)
+ *
+ * Copyright (C) 2012 Artem Pavlenko
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ *****************************************************************************/
+
 #include <mapnik/processed_text.hpp>
+#include <mapnik/config_error.hpp>
+
 namespace mapnik
 {
 
@@ -43,7 +67,7 @@ string_info &processed_text::get_string_info()
         {
             if (!p.fontset.get_name().empty())
             {
-                throw config_error("Unable to find specified font set '" + p.face_name + "'");
+                throw config_error("Unable to find specified font set '" + p.fontset.get_name() + "'");
             } else if (!p.face_name.empty()) {
                 throw config_error("Unable to find specified font face '" + p.face_name + "'");
             } else {

src/text_placements/registry.cpp

@@ -23,6 +23,7 @@
 #include <mapnik/text_placements/registry.hpp>
 #include <mapnik/text_placements/simple.hpp>
 #include <mapnik/text_placements/list.hpp>
+#include <mapnik/config_error.hpp>
 
 namespace mapnik
 {
@@ -47,7 +48,7 @@ void registry::register_name(std::string name, from_xml_function_ptr ptr, bool o
 text_placements_ptr registry::from_xml(std::string name, xml_node const& xml, fontset_map const& fontsets)
 {
     std::map<std::string, from_xml_function_ptr>::const_iterator itr = map_.find(name);
-    if (itr == map_.end())  throw config_error("Unknown placement-type '" + name + "'");
+    if (itr == map_.end())  throw config_error("Unknown placement-type '" + name + "'", &xml);
     return itr->second(xml, fontsets);
 }
 } //ns formatting

src/text_properties.cpp

@@ -26,6 +26,7 @@
 #include <mapnik/expression_string.hpp>
 #include <mapnik/formatting/text.hpp>
 #include <mapnik/xml_tree.hpp>
+#include <mapnik/config_error.hpp>
 
 namespace mapnik
 {
@@ -266,16 +267,16 @@ void char_properties::from_xml(xml_node const& sym, fontset_map const& fontsets)
             fontset = itr->second;
         } else
         {
-            throw config_error("Unable to find any fontset named '" + *fontset_name_ + "'");
+            throw config_error("Unable to find any fontset named '" + *fontset_name_ + "'", &sym);
         }
     }
     if (!face_name.empty() && !fontset.get_name().empty())
     {
-        throw config_error(std::string("Can't have both face-name and fontset-name"));
+        throw config_error("Can't have both face-name and fontset-name", &sym);
     }
     if (face_name.empty() && fontset.get_name().empty())
     {
-        throw config_error(std::string("Must have face-name or fontset-name"));
+        throw config_error("Must have face-name or fontset-name", &sym);
     }
 }
 

src/xml_tree.cpp

@@ -288,6 +288,11 @@ void xml_node::set_processed(bool processed) const
     processed_ = processed;
 }
 
+bool xml_node::processed() const
+{
+    return processed_;
+}
+
 xml_node::const_iterator xml_node::begin() const
 {
     return children_.begin();
@@ -399,6 +404,11 @@ T xml_node::get_value() const
     return *result;
 }
 
+unsigned xml_node::line() const
+{
+    return line_;
+}
+
 #define compile_get_opt_attr(T) template boost::optional<T> xml_node::get_opt_attr<T>(std::string const&) const
 #define compile_get_attr(T) template T xml_node::get_attr<T>(std::string const&) const; template T xml_node::get_attr<T>(std::string const&, T const&) const
 #define compile_get_value(T) template T xml_node::get_value<T>() const