Changeset 93

Timestamp:

04/20/06 05:48:51 (2 years ago)

Author:

jordi

Message:

It's possible to set the configuration values and to load the configuration from a file. The test suite for the configuration doesn't test loading from a file.

Location:

trunk

Files:

• src/Config.cxx (modified) (9 diffs)
• src/Config.h (modified) (2 diffs)
• tests/ConfigTest.cxx (modified) (1 diff)
• tests/ConfigTest.h (modified) (2 diffs)

trunk/src/Config.cxx

@@ -16 +16 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
+#include <config.h>
+#include <glib/gstdio.h>
 #include "epdfview.h"
 
 using namespace ePDFView;
 
-/// Constants
+// Constants
 static gint DEFAULT_WINDOW_HEIGHT = 650;
 static gint DEFAULT_WINDOW_WIDTH = 600;
@@ -26 +28 @@
 static gint DEFAULT_WINDOW_Y = 0;
 
-/// Static member attributes.
+// Static member attributes.
 Config *Config::m_Config = NULL;
 gboolean Config::m_LoadFile = TRUE;
 
+// Forward declarations.
+gchar *getConfigFileName (void);
+void makeDirWithParents (const gchar *);
+
 ///
 /// @brief Constructs a new Config object.
 ///
+/// It creates and load from a file the configuration, unless the
+/// Config::loadFile() was called with FALSE.
+///
 Config::Config ()
 {
+    m_Values = g_key_file_new ();
+    if ( m_LoadFile )
+    {
+        gchar *configFile = getConfigFileName ();
+        GError *error = NULL;
+        if ( !g_key_file_load_from_file (m_Values, configFile, 
+                                         G_KEY_FILE_NONE, &error ) )
+        {
+            g_warning ("Couldn't load config file '%s': %s\n", configFile,
+                       error->message);
+            g_error_free (error);
+        }
+        g_free (configFile);
+    }
 }
 
@@ -42 +65 @@
 Config::~Config ()
 {
+    g_key_file_free (m_Values);
 }
 
@@ -80 +104 @@
 
 ///
+/// @brief Gets an integer configuration option.
+///
+/// @param group Configuration group where the key belongs.
+/// @param key The key name to retrieve its value.
+/// @param defaultValue The default value to return if @a key doesn't exists.
+///
+/// @return The value of the @a key in @a group or @a defaultValue if @a key
+///         doesn't exists.
+///
+gint
+Config::getInteger (const gchar *group, const gchar *key, gint defaultValue)
+{
+    gint value = defaultValue;
+
+    if ( g_key_file_has_key (m_Values, group, key, NULL) )
+    {
+        GError *error = NULL;
+        gint savedValue = g_key_file_get_integer (m_Values, group, key, &error);
+        if ( NULL == error )
+        {
+            value = savedValue;
+        }
+        else
+        {
+            g_warning ("Error reading key '%s' from group '%s': %s\n", 
+                       key, group, error->message);
+            g_error_free (error);
+        }        
+    }
+
+    return value;
+}
+
+///
 /// @brief Gets the main window's height.
 ///
@@ -87 +145 @@
 Config::getWindowHeight ()
 {
-    gint windowHeight = DEFAULT_WINDOW_HEIGHT;
-    
-    return windowHeight;
+    return getInteger ("main window", "height", DEFAULT_WINDOW_HEIGHT);
 }
 
@@ -100 +156 @@
 Config::getWindowWidth ()
 {
-    gint windowWidth = DEFAULT_WINDOW_WIDTH;
-    
-    return windowWidth;
+    return getInteger ("main window", "width", DEFAULT_WINDOW_WIDTH);
 }
 
@@ -112 +166 @@
 gint
 Config::getWindowX ()
-{
-    gint windowX = DEFAULT_WINDOW_X;
-    
-    return windowX;
+{    
+    return getInteger ("main window", "x", DEFAULT_WINDOW_X);
 }
 
@@ -126 +178 @@
 Config::getWindowY ()
 {
-    gint windowY = DEFAULT_WINDOW_Y;
-    
-    return windowY;
-}
-
+    return getInteger ("main window", "y", DEFAULT_WINDOW_Y);
+}
+
+///
+/// @brief Sets if load the configuration value.
+///
+/// This is mainly for testing only purposes. If it's called before
+/// the first call to getConfig(), then the configuration file is not 
+/// loaded.
+///
+/// @param load Set to TRUE to load the file, to FALSE to prevent loading it.
+///
 void
 Config::loadFile (gboolean load)
@@ -136 +195 @@
     m_LoadFile = load;
 }
+
+///
+/// @brief Saves the current window's size.
+///
+/// @param width The window's width.
+/// @param height The window's height.
+///
+void
+Config::setWindowSize (gint width, gint height)
+{
+    g_key_file_set_integer (m_Values, "main window", "width", width);
+    g_key_file_set_integer (m_Values, "main window", "height", height);
+}
+
+///
+/// @brief Saves the current window's position.
+///
+/// @param x The X position of the window.
+/// @param y The Y position of the window.
+///
+void
+Config::setWindowPos (gint x, gint y)
+{
+    g_key_file_set_integer (m_Values, "main window", "x", x);
+    g_key_file_set_integer (m_Values, "main window", "y", y);
+}
+
+///
+/// @brief Gets the configuration file name.
+///
+/// This function creates the directory where the configuration file should
+/// go, if it doesn't exist yet.
+///
+/// @return The full path to the configuration file.
+///
+gchar *
+getConfigFileName ()
+{
+    gchar *configDir = 
+        g_build_filename (g_get_user_config_dir (), PACKAGE, NULL);
+    makeDirWithParents (configDir);
+    gchar *configFile = g_build_filename (configDir, "main.conf", NULL);
+    g_free (configDir);
+
+    return configFile;
+}
+
+///
+/// @brief Creates the directory and all its parent directories.
+///
+/// If the directory already exists it does nothing.
+///
+/// @param path The directory to create.
+///
+void
+makeDirWithParents (const gchar *path)
+{
+    // Get the list of directories to create.
+    GList *dirs = NULL;
+    gchar *dirName = g_strdup (path);
+    while ( !g_file_test (dirName, G_FILE_TEST_EXISTS) );
+    {
+        dirs = g_list_prepend (dirs, dirName);
+        dirName = g_path_get_dirname (dirName);
+    }
+
+    // Now create all of them.
+    GList *dir = g_list_first (dirs);
+    while ( NULL != dir );
+    {
+        if ( -1 == g_mkdir ((gchar *)dir->data, 0700) )
+        {
+            g_warning ("Couldn't make directory '%s'\n", (gchar *)dir->data);
+        }
+        g_free (dir->data);
+        dir = g_list_next (dir);
+    }
+    g_list_free (dirs);
+}

trunk/src/Config.h

@@ -43 +43 @@
             gint getWindowX (void);
             gint getWindowY (void);
+            void setWindowSize (gint width, gint height);
+            void setWindowPos (gint x, gint y);
             
         protected:
+            GKeyFile *m_Values;
+            
             Config (void);
             Config (Config &config) { }
@@ -50 +54 @@
             static Config *m_Config;
             static gboolean m_LoadFile;
+
+            gint getInteger (const gchar *group, const char *key, 
+                             gint defaultValue);
     };
 }

trunk/tests/ConfigTest.cxx

@@ -58 +58 @@
     CPPUNIT_ASSERT_EQUAL (650, config.getWindowHeight ());
 }
+
+///
+/// @brief Check setting and retrieving values related to the main window.
+///
+void
+ConfigTest::windowValues ()
+{
+    Config::loadFile (FALSE);
+    Config &config = Config::getConfig ();
+
+    config.setWindowPos (30, 40);
+    config.setWindowSize (100, 90);
+    
+    CPPUNIT_ASSERT_EQUAL (30, config.getWindowX ());
+    CPPUNIT_ASSERT_EQUAL (40, config.getWindowY ());
+    CPPUNIT_ASSERT_EQUAL (100, config.getWindowWidth ());
+    CPPUNIT_ASSERT_EQUAL (90, config.getWindowHeight ());    
+}

trunk/tests/ConfigTest.h

@@ -27 +27 @@
         CPPUNIT_TEST_SUITE (ConfigTest);
         CPPUNIT_TEST (defaultValues);
+        CPPUNIT_TEST (windowValues);
         CPPUNIT_TEST_SUITE_END ();
 
@@ -34 +35 @@
 
             void defaultValues (void);
+            void windowValues (void);
     };
 }