![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/preferences.cpp b/src/preferences.cpp
index 76edc2f7c54c7d2ae9c3dbaa312166d154cc874a..cb71e03b24d2b3e21c588b68cff1d3888ac974c2 100644 (file)
--- a/src/preferences.cpp
+++ b/src/preferences.cpp
*/
/* Authors:
* Krzysztof Kosiński <tweenk.pl@gmail.com>
+ * Jon A. Cruz <jon@joncruz.org>
*
- * Copyright (C) 2008 Authors
+ * Copyright (C) 2008,2009 Authors
*
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
+#include <cstring>
+#include <glibmm/fileutils.h>
+#include <glibmm/i18n.h>
+#include <glib.h>
+#include <glib/gstdio.h>
#include "preferences.h"
#include "preferences-skeleton.h"
#include "inkscape.h"
-#include "xml/repr.h"
#include "xml/node-observer.h"
#include "xml/node-iterators.h"
#include "xml/attribute-record.h"
-#include <cstring>
-#include <vector>
-#include <glibmm/fileutils.h>
-#include <glibmm/i18n.h>
-#include <glib.h>
-#include <glib/gstdio.h>
-#include <gtkmm/messagedialog.h>
#define PREFERENCES_FILE_NAME "preferences.xml"
_prefs_basename(PREFERENCES_FILE_NAME),
_prefs_dir(""),
_prefs_filename(""),
- _prefs_doc(NULL),
- _use_gui(true),
- _quiet(false),
- _loaded(false),
- _writable(false)
+ _prefs_doc(0),
+ _errorHandler(0),
+ _writable(false),
+ _hasError(false)
{
// profile_path essentailly returns the argument prefixed by the profile directory.
gchar *path = profile_path(NULL);
_prefs_dir = path;
g_free(path);
-
+
path = profile_path(_prefs_basename.data());
_prefs_filename = path;
g_free(path);
-
+
_loadDefaults();
+ _load();
}
Preferences::~Preferences()
{
- // when the preferences are unloaded, save them
- save();
-
// delete all PrefNodeObservers
for (_ObsMap::iterator i = _observer_map.begin(); i != _observer_map.end(); ) {
delete (*i++).second; // avoids reference to a deleted key
* @brief Load the user's customized preferences
*
* Tries to load the user's preferences.xml file. If there is none, creates it.
- * Displays dialog boxes on any errors.
*/
-void Preferences::load(bool use_gui, bool quiet)
-{
+void Preferences::_load()
+{
Glib::ustring const not_saved = _("Inkscape will run with default settings, "
- "and new settings will not be saved. ");
- _use_gui = use_gui;
- _quiet = quiet;
- _loaded = true;
-
+ "and new settings will not be saved. ");
+
// NOTE: After we upgrade to Glib 2.16, use Glib::ustring::compose
-
+
// 1. Does the file exist?
if (!g_file_test(_prefs_filename.data(), G_FILE_TEST_EXISTS)) {
// No - we need to create one.
// No - create the profile directory
if (g_mkdir(_prefs_dir.data(), 0755)) {
// the creation failed
- //_errorDialog(Glib::ustring::compose(_("Cannot create profile directory %1."),
+ //_reportError(Glib::ustring::compose(_("Cannot create profile directory %1."),
// Glib::filename_to_utf8(_prefs_dir)), not_saved);
gchar *msg = g_strdup_printf(_("Cannot create profile directory %s."),
Glib::filename_to_utf8(_prefs_dir).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
// create some subdirectories for user stuff
char const *user_dirs[] = {"keys", "templates", "icons", "extensions", "palettes", NULL};
- for(int i=0; user_dirs[i]; ++i) {
+ for (int i=0; user_dirs[i]; ++i) {
char *dir = profile_path(user_dirs[i]);
g_mkdir(dir, 0755);
g_free(dir);
}
-
+
} else if (!g_file_test(_prefs_dir.data(), G_FILE_TEST_IS_DIR)) {
// The profile dir is not actually a directory
- //_errorDialog(Glib::ustring::compose(_("%1 is not a valid directory."),
+ //_reportError(Glib::ustring::compose(_("%1 is not a valid directory."),
// Glib::filename_to_utf8(_prefs_dir)), not_saved);
gchar *msg = g_strdup_printf(_("%s is not a valid directory."),
Glib::filename_to_utf8(_prefs_dir).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
// The profile dir exists and is valid.
if (!g_file_set_contents(_prefs_filename.data(), preferences_skeleton, PREFERENCES_SKELETON_SIZE, NULL)) {
// The write failed.
- //_errorDialog(Glib::ustring::compose(_("Failed to create the preferences file %1."),
+ //_reportError(Glib::ustring::compose(_("Failed to create the preferences file %1."),
// Glib::filename_to_utf8(_prefs_filename)), not_saved);
gchar *msg = g_strdup_printf(_("Failed to create the preferences file %s."),
Glib::filename_to_utf8(_prefs_filename).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
-
+
// The prefs file was just created.
// We can return now and skip the rest of the load process.
_writable = true;
return;
}
-
+
// Yes, the pref file exists.
// 2. Is it a regular file?
if (!g_file_test(_prefs_filename.data(), G_FILE_TEST_IS_REGULAR)) {
- //_errorDialog(Glib::ustring::compose(_("The preferences file %1 is not a regular file."),
+ //_reportError(Glib::ustring::compose(_("The preferences file %1 is not a regular file."),
// Glib::filename_to_utf8(_prefs_filename)), not_saved);
gchar *msg = g_strdup_printf(_("The preferences file %s is not a regular file."),
Glib::filename_to_utf8(_prefs_filename).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
-
+
// 3. Is the file readable?
gchar *prefs_xml = NULL; gsize len = 0;
if (!g_file_get_contents(_prefs_filename.data(), &prefs_xml, &len, NULL)) {
- //_errorDialog(Glib::ustring::compose(_("The preferences file %1 could not be read."),
+ //_reportError(Glib::ustring::compose(_("The preferences file %1 could not be read."),
// Glib::filename_to_utf8(_prefs_filename)), not_saved);
gchar *msg = g_strdup_printf(_("The preferences file %s could not be read."),
Glib::filename_to_utf8(_prefs_filename).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
+
// 4. Is it valid XML?
Inkscape::XML::Document *prefs_read = sp_repr_read_mem(prefs_xml, len, NULL);
g_free(prefs_xml);
if (!prefs_read) {
- //_errorDialog(Glib::ustring::compose(_("The preferences file %1 is not a valid XML document."),
+ //_reportError(Glib::ustring::compose(_("The preferences file %1 is not a valid XML document."),
// Glib::filename_to_utf8(_prefs_filename)), not_saved);
gchar *msg = g_strdup_printf(_("The preferences file %s is not a valid XML document."),
Glib::filename_to_utf8(_prefs_filename).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
return;
}
+
// 5. Basic sanity check: does the root element have a correct name?
if (strcmp(prefs_read->root()->name(), "inkscape")) {
- //_errorDialog(Glib::ustring::compose(_("The file %1 is not a valid Inkscape preferences file."),
+ //_reportError(Glib::ustring::compose(_("The file %1 is not a valid Inkscape preferences file."),
// Glib::filename_to_utf8(_prefs_filename)), not_saved);
gchar *msg = g_strdup_printf(_("The file %s is not a valid Inkscape preferences file."),
Glib::filename_to_utf8(_prefs_filename).data());
- _errorDialog(msg, not_saved);
+ _reportError(msg, not_saved);
g_free(msg);
Inkscape::GC::release(prefs_read);
return;
}
-
+
// Merge the loaded prefs with defaults.
_prefs_doc->root()->mergeFrom(prefs_read->root(), "id");
Inkscape::GC::release(prefs_read);
*/
void Preferences::save()
{
- if (!_writable) return; // no-op if the prefs file is not writable
-
- // sp_repr_save_file uses utf-8 instead of the glib filename encoding.
- // I don't know why filenames are kept in utf-8 in Inkscape and then
- // converted to filename encoding when necessary through special functions
- // - wouldn't it be easier to keep things in the encoding they are supposed
- // to be in?
- Glib::ustring utf8name = Glib::filename_to_utf8(_prefs_filename);
- if (utf8name.empty()) return;
- sp_repr_save_file(_prefs_doc, utf8name.data());
+ // no-op if the prefs file is not writable
+ if (_writable) {
+ // sp_repr_save_file uses utf-8 instead of the glib filename encoding.
+ // I don't know why filenames are kept in utf-8 in Inkscape and then
+ // converted to filename encoding when necessary through special functions
+ // - wouldn't it be easier to keep things in the encoding they are supposed
+ // to be in?
+
+ // No, it would not. There are many reasons, one key reason being that the
+ // rest of GTK+ is explicitly UTF-8. From an engineering standpoint, keeping
+ // the filesystem encoding would change things from a one-to-many problem to
+ // instead be a many-to-many problem. Also filesystem encoding can change
+ // from one run of the program to the next, so can not be stored.
+ // There are many other factors, so ask if you would like to learn them. - JAC
+ Glib::ustring utf8name = Glib::filename_to_utf8(_prefs_filename);
+ if (!utf8name.empty()) {
+ sp_repr_save_file(_prefs_doc, utf8name.data());
+ }
+ }
}
+bool Preferences::getLastError( Glib::ustring& primary, Glib::ustring& secondary )
+{
+ bool result = _hasError;
+ if ( _hasError ) {
+ primary = _lastErrPrimary;
+ secondary = _lastErrSecondary;
+ _hasError = false;
+ _lastErrPrimary.clear();
+ _lastErrSecondary.clear();
+ } else {
+ primary.clear();
+ secondary.clear();
+ }
+ return result;
+}
// Now for the meat.
@@ -246,12 +263,13 @@ std::vector<Preferences::Entry> Preferences::getAllEntries(Glib::ustring const &
{
std::vector<Entry> temp;
Inkscape::XML::Node *node = _getNode(path, false);
- if (!node) return temp;
-
- // argh - purge this Util::List nonsense from XML classes fast
- Inkscape::Util::List<Inkscape::XML::AttributeRecord const> alist = node->attributeList();
- for (; alist; ++alist)
- temp.push_back( Entry(path + '/' + g_quark_to_string(alist->key), static_cast<void const*>(alist->value.pointer())) );
+ if (node) {
+ // argh - purge this Util::List nonsense from XML classes fast
+ Inkscape::Util::List<Inkscape::XML::AttributeRecord const> alist = node->attributeList();
+ for (; alist; ++alist) {
+ temp.push_back( Entry(path + '/' + g_quark_to_string(alist->key), static_cast<void const*>(alist->value.pointer())) );
+ }
+ }
return temp;
}
{
std::vector<Glib::ustring> temp;
Inkscape::XML::Node *node = _getNode(path, false);
- if (!node) return temp;
-
- for (Inkscape::XML::NodeSiblingIterator i = node->firstChild(); i; ++i) {
- temp.push_back(path + '/' + i->attribute("id"));
+ if (node) {
+ for (Inkscape::XML::NodeSiblingIterator i = node->firstChild(); i; ++i) {
+ temp.push_back(path + '/' + i->attribute("id"));
+ }
}
return temp;
}
@@ -377,33 +395,34 @@ void Preferences::PrefNodeObserver::notifyAttributeChanged(XML::Node &node, GQua
{
// filter out attributes we don't watch
gchar const *attr_name = g_quark_to_string(name);
- if ( !_filter.empty() && _filter != attr_name ) return;
-
- _ObserverData *d = static_cast<_ObserverData*>(Preferences::_get_pref_observer_data(_observer));
- Glib::ustring notify_path = _observer.observed_path;
-
- if (!d->_is_attr) {
- std::vector<gchar const *> path_fragments;
- notify_path.reserve(256); // this will make appending operations faster
-
- // walk the XML tree, saving each of the id attributes in a vector
- // we terminate when we hit the observer's attachment node, because the path to this node
- // is already stored in notify_path
- for (XML::NodeParentIterator n = &node; static_cast<XML::Node*>(n) != d->_node; ++n)
- path_fragments.push_back(n->attribute("id"));
- // assemble the elements into a path
- for (std::vector<gchar const *>::reverse_iterator i = path_fragments.rbegin(); i != path_fragments.rend(); ++i) {
+ if ( _filter.empty() || (_filter == attr_name) ) {
+ _ObserverData *d = static_cast<_ObserverData*>(Preferences::_get_pref_observer_data(_observer));
+ Glib::ustring notify_path = _observer.observed_path;
+
+ if (!d->_is_attr) {
+ std::vector<gchar const *> path_fragments;
+ notify_path.reserve(256); // this will make appending operations faster
+
+ // walk the XML tree, saving each of the id attributes in a vector
+ // we terminate when we hit the observer's attachment node, because the path to this node
+ // is already stored in notify_path
+ for (XML::NodeParentIterator n = &node; static_cast<XML::Node*>(n) != d->_node; ++n) {
+ path_fragments.push_back(n->attribute("id"));
+ }
+ // assemble the elements into a path
+ for (std::vector<gchar const *>::reverse_iterator i = path_fragments.rbegin(); i != path_fragments.rend(); ++i) {
+ notify_path.push_back('/');
+ notify_path.append(*i);
+ }
+
+ // append attribute name
notify_path.push_back('/');
- notify_path.append(*i);
+ notify_path.append(attr_name);
}
- // append attribute name
- notify_path.push_back('/');
- notify_path.append(attr_name);
+ Entry const val = Preferences::_create_pref_value(notify_path, static_cast<void const*>(new_value.pointer()));
+ _observer.notify(val);
}
-
- Entry const val = Preferences::_create_pref_value(notify_path, static_cast<void const*>(new_value.pointer()));
- _observer.notify(val);
}
/**
@@ -413,7 +432,7 @@ XML::Node *Preferences::_findObserverNode(Glib::ustring const &pref_path, Glib::
{
// first assume that the last path element is an entry.
_keySplit(pref_path, node_key, attr_key);
-
+
// find the node corresponding to the "directory".
Inkscape::XML::Node *node = _getNode(node_key, create), *child;
for (child = node->firstChild(); child; child = child->next()) {
@@ -433,45 +452,47 @@ XML::Node *Preferences::_findObserverNode(Glib::ustring const &pref_path, Glib::
void Preferences::addObserver(Observer &o)
{
// prevent adding the same observer twice
- if ( _observer_map.find(&o) != _observer_map.end() ) return;
-
- Glib::ustring node_key, attr_key;
- Inkscape::XML::Node *node;
- node = _findObserverNode(o.observed_path, node_key, attr_key, false);
- if (!node) return;
-
- // set additional data
- _ObserverData *priv_data = new _ObserverData;
- priv_data->_node = node;
- priv_data->_is_attr = !attr_key.empty();
- o._data = static_cast<void*>(priv_data);
-
- _observer_map[&o] = new PrefNodeObserver(o, attr_key);
-
- // if we watch a single pref, we want to receive notifications only for a single node
- if (priv_data->_is_attr) {
- node->addObserver( *(_observer_map[&o]) );
- } else {
- node->addSubtreeObserver( *(_observer_map[&o]) );
+ if ( _observer_map.find(&o) == _observer_map.end() ) {
+ Glib::ustring node_key, attr_key;
+ Inkscape::XML::Node *node;
+ node = _findObserverNode(o.observed_path, node_key, attr_key, false);
+ if (node) {
+ // set additional data
+ _ObserverData *priv_data = new _ObserverData;
+ priv_data->_node = node;
+ priv_data->_is_attr = !attr_key.empty();
+ o._data = static_cast<void*>(priv_data);
+
+ _observer_map[&o] = new PrefNodeObserver(o, attr_key);
+
+ // if we watch a single pref, we want to receive notifications only for a single node
+ if (priv_data->_is_attr) {
+ node->addObserver( *(_observer_map[&o]) );
+ } else {
+ node->addSubtreeObserver( *(_observer_map[&o]) );
+ }
+ }
}
}
void Preferences::removeObserver(Observer &o)
{
// prevent removing an observer which was not added
- if ( _observer_map.find(&o) == _observer_map.end() ) return;
- Inkscape::XML::Node *node = static_cast<_ObserverData*>(o._data)->_node;
- _ObserverData *priv_data = static_cast<_ObserverData*>(o._data);
- o._data = NULL;
-
- if (priv_data->_is_attr)
- node->removeObserver( *(_observer_map[&o]) );
- else
- node->removeSubtreeObserver( *(_observer_map[&o]) );
+ if ( _observer_map.find(&o) != _observer_map.end() ) {
+ Inkscape::XML::Node *node = static_cast<_ObserverData*>(o._data)->_node;
+ _ObserverData *priv_data = static_cast<_ObserverData*>(o._data);
+ o._data = NULL;
- delete priv_data;
- delete _observer_map[&o];
- _observer_map.erase(&o);
+ if (priv_data->_is_attr) {
+ node->removeObserver( *(_observer_map[&o]) );
+ } else {
+ node->removeSubtreeObserver( *(_observer_map[&o]) );
+ }
+
+ delete priv_data;
+ delete _observer_map[&o];
+ _observer_map.erase(&o);
+ }
}
@@ -489,43 +510,50 @@ Inkscape::XML::Node *Preferences::_getNode(Glib::ustring const &pref_key, bool c
{
// verify path
g_assert( pref_key.at(0) == '/' );
- g_assert( pref_key.find('.') == Glib::ustring::npos );
+ // No longer necessary, can cause problems with input devices which have a dot in the name
+ // g_assert( pref_key.find('.') == Glib::ustring::npos );
- Inkscape::XML::Node *node = _prefs_doc->root(), *child = NULL;
+ Inkscape::XML::Node *node = _prefs_doc->root();
+ Inkscape::XML::Node *child = NULL;
gchar **splits = g_strsplit(pref_key.data(), "/", 0);
-
- if ( splits == NULL ) return node;
-
- for (int part_i = 0; splits[part_i]; ++part_i) {
- // skip empty path segments
- if (!splits[part_i][0]) continue;
-
- for (child = node->firstChild(); child; child = child->next())
- if (!strcmp(splits[part_i], child->attribute("id"))) break;
-
- // If the previous loop found a matching key, child now contains the node
- // matching the processed key part. If no node was found then it is NULL.
- if (!child) {
- if (create) {
- // create the rest of the key
- while(splits[part_i]) {
- child = node->document()->createElement("group");
- child->setAttribute("id", splits[part_i]);
- node->appendChild(child);
-
- ++part_i;
- node = child;
+
+ if ( splits ) {
+ for (int part_i = 0; splits[part_i]; ++part_i) {
+ // skip empty path segments
+ if (!splits[part_i][0]) {
+ continue;
+ }
+
+ for (child = node->firstChild(); child; child = child->next()) {
+ if (!strcmp(splits[part_i], child->attribute("id"))) {
+ break;
}
- g_strfreev(splits);
- return node;
- } else {
- return NULL;
}
- }
- node = child;
+ // If the previous loop found a matching key, child now contains the node
+ // matching the processed key part. If no node was found then it is NULL.
+ if (!child) {
+ if (create) {
+ // create the rest of the key
+ while(splits[part_i]) {
+ child = node->document()->createElement("group");
+ child->setAttribute("id", splits[part_i]);
+ node->appendChild(child);
+
+ ++part_i;
+ node = child;
+ }
+ g_strfreev(splits);
+ return node;
+ } else {
+ return NULL;
+ }
+ }
+
+ node = child;
+ }
+ g_strfreev(splits);
}
- g_strfreev(splits);
return node;
}
// create node and attribute keys
Glib::ustring node_key, attr_key;
_keySplit(path, node_key, attr_key);
-
+
// retrieve the attribute
Inkscape::XML::Node *node = _getNode(node_key, false);
if ( node == NULL ) {
// create node and attribute keys
Glib::ustring node_key, attr_key;
_keySplit(path, node_key, attr_key);
-
+
// set the attribute
Inkscape::XML::Node *node = _getNode(node_key, true);
node->setAttribute(attr_key.data(), value);
bool Preferences::_extractBool(Entry const &v)
{
gchar const *s = static_cast<gchar const *>(v._value);
- if ( !s[0] || !strcmp(s, "0") || !strcmp(s, "false") ) return false;
- return true;
+ if ( !s[0] || !strcmp(s, "0") || !strcmp(s, "false") ) {
+ return false;
+ } else {
+ return true;
+ }
}
int Preferences::_extractInt(Entry const &v)
{
gchar const *s = static_cast<gchar const *>(v._value);
- if ( !strcmp(s, "true") ) return true;
- if ( !strcmp(s, "false") ) return false;
- return atoi(s);
+ if ( !strcmp(s, "true") ) {
+ return true;
+ } else if ( !strcmp(s, "false") ) {
+ return false;
+ } else {
+ return atoi(s);
+ }
}
double Preferences::_extractDouble(Entry const &v)
// we'll have to walk up the tree and call sp_repr_css_attr_add_from_string
Glib::ustring node_key, attr_key;
_keySplit(v._pref_path, node_key, attr_key);
-
+
Inkscape::XML::Node *node = _getNode(node_key, false);
return sp_repr_css_attr_inherited(node, attr_key.data());
}
@@ -617,17 +652,13 @@ void Preferences::_keySplit(Glib::ustring const &pref_path, Glib::ustring &node_
node_key = pref_path.substr(0, pref_path.rfind('/'));
}
-void Preferences::_errorDialog(Glib::ustring const &msg, Glib::ustring const &secondary)
+void Preferences::_reportError(Glib::ustring const &msg, Glib::ustring const &secondary)
{
- if (_quiet) return;
- if (_use_gui) {
- Gtk::MessageDialog err(
- msg, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_OK, true);
- err.set_secondary_text(secondary);
- err.run();
- } else {
- g_message("%s", msg.data());
- g_message("%s", secondary.data());
+ _hasError = true;
+ _lastErrPrimary = msg;
+ _lastErrSecondary = secondary;
+ if (_errorHandler) {
+ _errorHandler->handleError(msg, secondary);
}
}
@@ -636,11 +667,28 @@ Preferences::Entry const Preferences::_create_pref_value(Glib::ustring const &pa
return Entry(path, ptr);
}
+void Preferences::setErrorHandler(ErrorReporter* handler)
+{
+ _errorHandler = handler;
+}
+
+void Preferences::unload(bool save)
+{
+ if (_instance)
+ {
+ if (save) {
+ _instance->save();
+ }
+ delete _instance;
+ _instance = NULL;
+ }
+}
+
Preferences *Preferences::_instance = NULL;
} // namespace Inkscape
-
+
/*
Local Variables:
mode:c++