sensors.c

Go to the documentation of this file.

/*
 * File Name: sensors.c
 */

/*
 * This file is part of settings.
 *
 * settings is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * settings 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2010 IREX Technologies B.V.
 * All rights reserved.
 */

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

#include <gtk/gtk.h>
#include <gdk/gdk.h>

// ereader include files, between < >
#include <libergtk/ergtk.h>

// local include files, between " "
#include "i18n.h"
#include "log.h"
#include "settings.h"
#include "settings_utils.h"
#include "settings_style.h"

#include "sensors.h"


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

typedef struct
{
    gboolean lights_on;
    gboolean sound_on;
    gboolean lock_left_sensor;
    gboolean lock_middle_sensor;
    gboolean lock_right_sensor;
} SensorSettings;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Static Variables
//----------------------------------------------------------------------------


static SensorSettings g_orig_sensor_settings;
static SensorSettings g_cur_sensor_settings;

static GtkWidget* g_sensor_settings_window      = NULL;
static GtkWidget* g_light_radios[2]             = {NULL, NULL};
static GtkWidget* g_sound_radios[2]             = {NULL, NULL};
static GtkWidget* g_lock_left_sensor_check      = NULL;
static GtkWidget* g_lock_middle_sensor_check    = NULL;
static GtkWidget* g_lock_right_sensor_check     = NULL;
static GtkWidget* g_sensor_lock_image           = NULL;


//============================================================================
// Local Function Definitions
//============================================================================

static GtkWidget* create_light_widgets      (GtkBox* parent);
static GtkWidget* create_sound_widgets      (GtkBox* parent);
static GtkWidget* create_lock_widgets       (GtkBox* parent);

static void on_use_light_changed            (GtkWidget *widget, gpointer data);
static void on_use_sound_changed            (GtkWidget *widget, gpointer data);
static void on_lock_left_changed            (GtkWidget *widget, gpointer data);
static void on_lock_middle_changed          (GtkWidget *widget, gpointer data);
static void on_lock_right_changed           (GtkWidget *widget, gpointer data);
static void update_sensor_lock_image        (gboolean lock_left,
                                             gboolean lock_middle,
                                             gboolean lock_right);

static void init_widgets_with_settings      (void);
static void on_listview_row_activated       (GtkTreeView            *view,
                                             GtkTreePath            *path,
                                             GtkTreeViewColumn      *column,
                                             gpointer               user_data );

static void on_listview_navigate_cursor     (erGtkListView          *er_listview,
                                             erGtkListViewKeyPress  keycode,
                                             gpointer               user_data );

static gboolean on_focus_in(GtkWidget* widget, gpointer data );
static gboolean on_focus_out(GtkWidget* widget, gpointer data );



//============================================================================
// Functions Implementation
//============================================================================

void load_sensor_settings()
{
    g_orig_sensor_settings.lights_on           = get_value_bool(GCONF_USE_LIGHT);
    g_orig_sensor_settings.sound_on            = get_value_bool(GCONF_USE_SOUND);
    g_orig_sensor_settings.lock_left_sensor    = get_value_bool(GCONF_LOCK_LEFT_SENSOR);
    g_orig_sensor_settings.lock_middle_sensor  = get_value_bool(GCONF_LOCK_MIDDLE_SENSOR);
    g_orig_sensor_settings.lock_right_sensor   = get_value_bool(GCONF_LOCK_RIGHT_SENSOR);

    g_cur_sensor_settings = g_orig_sensor_settings;
    
    LOGPRINTF("Loading sensor settings, done.");
}


void save_sensor_settings()
{
    if (g_cur_sensor_settings.lights_on != g_orig_sensor_settings.lights_on)
    {
        set_value_bool(GCONF_USE_LIGHT, g_cur_sensor_settings.lights_on);
    }

    if (g_cur_sensor_settings.sound_on != g_orig_sensor_settings.sound_on)
    {
        set_value_bool(GCONF_USE_SOUND, g_cur_sensor_settings.sound_on);
    }

    if (g_cur_sensor_settings.lock_left_sensor != g_orig_sensor_settings.lock_left_sensor)
    {
        set_value_bool(GCONF_LOCK_LEFT_SENSOR, g_cur_sensor_settings.lock_left_sensor);
    }

    if (g_cur_sensor_settings.lock_middle_sensor != g_orig_sensor_settings.lock_middle_sensor)
    {
        set_value_bool(GCONF_LOCK_MIDDLE_SENSOR, g_cur_sensor_settings.lock_middle_sensor);
    }

    if (g_cur_sensor_settings.lock_right_sensor != g_orig_sensor_settings.lock_right_sensor)
    {
        set_value_bool(GCONF_LOCK_RIGHT_SENSOR, g_cur_sensor_settings.lock_right_sensor);
    }

    LOGPRINTF("Saving sensor settings, done.");
}

GtkWidget* create_sensors_window(GtkWidget* parent)
{
    // create top window
    GtkWidget* top_window = parent;
    gtk_window_maximize(GTK_WINDOW(top_window));
    gtk_window_set_resizable(GTK_WINDOW(top_window), FALSE);
    gtk_container_set_border_width(GTK_CONTAINER(top_window),WINDOW_BORDER_PADDING  );
    gtk_window_set_modal(GTK_WINDOW(top_window), TRUE);

    // top level vbox (vboxtop)
    GtkWidget* vboxtop = gtk_vbox_new(FALSE, 0);
    gtk_container_add(GTK_CONTAINER(top_window), vboxtop);

    // add header container the title and subtitle of this settings page
    create_title(GTK_VBOX(vboxtop), _("Settings"), _("Navigation Sensors"));
    
    // add the back/exit bar below the title 
    GtkWidget* view = create_settingsview();
    gtk_box_pack_start(GTK_BOX(vboxtop), view, FALSE, FALSE,0 ); 
    g_signal_connect(view, "row-activated", G_CALLBACK(on_listview_row_activated), NULL ) ;
    g_signal_connect(view, "navigate-cursor", G_CALLBACK(on_listview_navigate_cursor), NULL ) ;
    g_signal_connect(view, "focus-in-event", G_CALLBACK(on_focus_in), NULL );
    g_signal_connect(view, "focus-out-event", G_CALLBACK(on_focus_out), NULL );

   
    GtkWidget* vbox1 = GTK_WIDGET( create_frame(GTK_VBOX(vboxtop)) );
    create_light_widgets(GTK_BOX(vbox1));

    GtkWidget* vbox2 = GTK_WIDGET( create_frame(GTK_VBOX(vboxtop)) );
    create_sound_widgets(GTK_BOX(vbox2));

    GtkWidget* vbox3 = GTK_WIDGET( create_frame(GTK_VBOX(vboxtop)) );
    create_lock_widgets(GTK_BOX(vbox3));

    // Update widget with current settings.
    init_widgets_with_settings();

    g_sensor_settings_window = top_window;

    gtk_widget_grab_focus(view);

    gtk_widget_show_all(top_window);
    return top_window;
}


//============================================================================
// Local Functions Implementation
//============================================================================

static gboolean on_focus_in(GtkWidget* widget, gpointer data )
{
    g_assert(widget != NULL ) ;
    ergtk_list_view_set_cursor( ERGTK_LIST_VIEW(widget), 0); // row = 0;
    return FALSE;
}

static gboolean on_focus_out(GtkWidget* widget, gpointer data )
{
    g_assert(widget != NULL ) ;
    GtkTreeSelection* my_selection = gtk_tree_view_get_selection((GtkTreeView*) widget);
    g_assert( my_selection != NULL ) ;
    gtk_tree_selection_unselect_all(my_selection);
    return FALSE;
}

static void on_listview_row_activated ( GtkTreeView       *view,
                                        GtkTreePath       *path,
                                        GtkTreeViewColumn *column,
                                        gpointer          user_data )
{
    save_sensor_settings();
    main_quit();
    return;
}

static void on_listview_navigate_cursor ( erGtkListView         *er_listview,
                                          erGtkListViewKeyPress keycode,
                                          gpointer              user_data )
{
    GtkTreeSelection* my_selection = gtk_tree_view_get_selection((GtkTreeView*) er_listview);
    g_assert( my_selection != NULL ) ;

    // determine new cursor position
    switch (keycode)
    {
        case ERGTK_LIST_VIEW_PRESS_SHORT_DOWN:
        case ERGTK_LIST_VIEW_PRESS_LONG_DOWN:
            gtk_widget_grab_focus(GTK_WIDGET(g_light_radios[0])); // down: to first widget
            gtk_tree_selection_unselect_all(my_selection);
            break;
        default:
            LOGPRINTF("illegal erGtkListViewKeyPress [%d]", keycode);
            ;  // ignore
            break;
    }
}

// Widget Hierarchy
// |--Top Level vbox
//    |--lable subject ("Lights")
//    |--label description ("This setting controls the green indication lights next to the sensor panels.")
//    |--vbox
//       |--radio
//       |--radio
static GtkWidget* create_light_widgets(GtkBox* parent)
{
    // Top level vbox.
    GtkWidget* top_level_vbox = gtk_vbox_new(FALSE, ITEM_SPACING);
    gtk_box_pack_start(parent, top_level_vbox, FALSE, FALSE, 0);

    // Subject "Lights".
    GtkWidget* subject = subject_create();
    gtk_label_set_label(GTK_LABEL(subject), _("Lights"));
    gtk_box_pack_start(GTK_BOX(top_level_vbox), subject, FALSE, FALSE, 0);

    // Description "This setting controls..."
    GtkWidget* desc = description_create();
    gtk_label_set_label(GTK_LABEL(desc), _("This setting controls the green indication lights next to the sensor panels.")); 
    gtk_box_pack_start(GTK_BOX(top_level_vbox), desc, FALSE, FALSE, 0);


    // The vbox containing radio buttons.
    GtkWidget* vbox = gtk_vbox_new(TRUE, 0);
    gtk_box_pack_start(GTK_BOX(top_level_vbox), vbox, FALSE, FALSE, 0);

    int i = 0;
    for (i=0; i<2; i++)
    {
        if (i == 0)
        {
            // The radio button "On".
            g_light_radios[i] = gtk_radio_button_new_with_label(NULL, _("On"));
        }
        else
        {
            // The radio button "Off".
            g_light_radios[i] = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(g_light_radios[0]), _("Off"));
        }

        // Add signal handler.
        g_signal_connect_after(G_OBJECT(g_light_radios[i]),
            "toggled",
            G_CALLBACK(on_use_light_changed),
            (gpointer)i);

        gtk_box_pack_start(GTK_BOX(vbox), g_light_radios[i], FALSE, FALSE, 0);
    }

    return top_level_vbox;
}

// Widget Hierarchy
// |--Top Level vbox
//    |--label subject ("Sound")
//    |--label description ("You can turn the beep on or off with this setting.")
//    |--vbox
//       |--radio
//       |--radio
static GtkWidget* create_sound_widgets(GtkBox* parent)
{
    // Top level vbox.
    GtkWidget* top_level_vbox = gtk_vbox_new(FALSE, ITEM_SPACING);
    gtk_box_pack_start(parent, top_level_vbox, FALSE, FALSE, 0);

    // Subject "Sound".
    GtkWidget* subject = subject_create();
    gtk_label_set_label(GTK_LABEL(subject), _("Sound"));
    gtk_box_pack_start(GTK_BOX(top_level_vbox), subject, FALSE, FALSE, 0);

    // Description "You can turn..."
    GtkWidget* desc = description_create();
    gtk_label_set_label(GTK_LABEL(desc), _("You can turn the beep on or off with this setting."));    
    gtk_box_pack_start(GTK_BOX(top_level_vbox), desc, FALSE, FALSE, 0);

    // The vbox containing radio buttons.
    GtkWidget* vbox = gtk_vbox_new(TRUE, 0);
    gtk_box_pack_start(GTK_BOX(top_level_vbox), vbox, FALSE, FALSE, 0);

    int i=0;
    for (i=0; i<2; i++)
    {
        if (i == 0)
        {
            // The radio button "On".
            g_sound_radios[i] = gtk_radio_button_new_with_label(NULL, _("On"));
        }
        else
        {
            // The radio button "Off".
            g_sound_radios[i] = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(g_sound_radios[0]), _("Off"));
        }

        // Add signal handler.
        g_signal_connect_after(G_OBJECT(g_sound_radios[i]),
            "toggled",
            G_CALLBACK(on_use_sound_changed),
            (gpointer)i);

        gtk_box_pack_start(GTK_BOX(vbox), g_sound_radios[i], FALSE, FALSE, 0);
    }

    return top_level_vbox;
}


// Widget Hierarchy
// |--Top Level vbox
//    |--label Subject ("Sensor Lock")
//    |--label Descriptoin ("Customize your own sensor lock by choosing one or all of the lock options.")
//    |--hbox
//       |--vbox
//       |  |--check button
//       |  |--check button
//       |  +--check button
//       |--image
static GtkWidget* create_lock_widgets(GtkBox* parent)
{
    // Top level vbox.
    GtkWidget* top_level_vbox = gtk_vbox_new(FALSE, ITEM_SPACING);
    gtk_box_pack_start(parent, top_level_vbox, FALSE, FALSE, 0);

    // Subject "Sensor Lock".
    GtkWidget* subject = subject_create();
    gtk_label_set_label(GTK_LABEL(subject), _("Sensor Lock"));
    gtk_box_pack_start(GTK_BOX(top_level_vbox), subject, FALSE, FALSE, 0);

    // Description "Customize your own..."
    GtkWidget* desc = description_create();
    gtk_label_set_label(GTK_LABEL(desc), _("Customize your own sensor lock by choosing one or all of the lock options."));    
    gtk_box_pack_start(GTK_BOX(top_level_vbox), desc, FALSE, FALSE, 0);

    // The hbox containing check buttons and image.
    GtkWidget* hbox = gtk_hbox_new(FALSE, 0);
    gtk_box_pack_start(GTK_BOX(top_level_vbox), hbox, FALSE, FALSE, 0);

    // The vbox containing check buttons.
    GtkWidget* vbox = gtk_vbox_new(TRUE, 0);
    gtk_box_pack_start(GTK_BOX(hbox), vbox, FALSE, FALSE, 0);

    // The fist check button "Lock Left Sensors".
    g_lock_left_sensor_check = gtk_check_button_new_with_label(_("Lock Left Sensors"));
    g_signal_connect(G_OBJECT(g_lock_left_sensor_check),
        "toggled",
        G_CALLBACK(on_lock_left_changed),
        NULL);
    gtk_box_pack_start(GTK_BOX(vbox), g_lock_left_sensor_check, FALSE, FALSE, 0);

    // The second check button "Lock Middle Sensors".
    g_lock_middle_sensor_check = gtk_check_button_new_with_label(_("Lock Middle Sensors"));
    g_signal_connect(G_OBJECT(g_lock_middle_sensor_check),
        "toggled",
        G_CALLBACK(on_lock_middle_changed),
        NULL);
    gtk_box_pack_start(GTK_BOX(vbox), g_lock_middle_sensor_check, FALSE, FALSE, 0);

    // The third check button "Lock Right Sensors".
    g_lock_right_sensor_check = gtk_check_button_new_with_label(_("Lock Right Sensors"));
    g_signal_connect(G_OBJECT(g_lock_right_sensor_check),
        "toggled",
        G_CALLBACK(on_lock_right_changed),
        NULL);
    gtk_box_pack_start(GTK_BOX(vbox), g_lock_right_sensor_check, FALSE, FALSE, 0);

    // The sensor lock image.
    g_sensor_lock_image = gtk_image_new();
    gtk_box_pack_start(GTK_BOX(hbox), g_sensor_lock_image, TRUE, FALSE, 0);
    return top_level_vbox;
}



static void on_use_light_changed(GtkWidget *widget, gpointer data)
{
    int index = (int)data;
    gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));

    if (is_active == TRUE)
    {
        g_cur_sensor_settings.lights_on = (index == 0) ? TRUE : FALSE;
    }
}


static void on_use_sound_changed(GtkWidget *widget, gpointer data)
{
    int index = (int)data;
    gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));

    if (is_active == TRUE)
    {
        g_cur_sensor_settings.sound_on = (index == 0) ? TRUE : FALSE;
    }
}


static void on_lock_left_changed(GtkWidget *widget, gpointer data)
{
    g_cur_sensor_settings.lock_left_sensor = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
    // Update sensor lock image.
    update_sensor_lock_image(g_cur_sensor_settings.lock_left_sensor,
        g_cur_sensor_settings.lock_middle_sensor,
        g_cur_sensor_settings.lock_right_sensor);
}


static void on_lock_middle_changed(GtkWidget *widget, gpointer data)
{
    g_cur_sensor_settings.lock_middle_sensor = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
    // Update sensor lock image.
    update_sensor_lock_image(g_cur_sensor_settings.lock_left_sensor,
        g_cur_sensor_settings.lock_middle_sensor,
        g_cur_sensor_settings.lock_right_sensor);
}


static void on_lock_right_changed(GtkWidget *widget, gpointer data)
{
    g_cur_sensor_settings.lock_right_sensor = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
    // Update sensor lock image.
    update_sensor_lock_image(g_cur_sensor_settings.lock_left_sensor,
        g_cur_sensor_settings.lock_middle_sensor,
        g_cur_sensor_settings.lock_right_sensor);
}


static void update_sensor_lock_image(gboolean lock_left,
                                     gboolean lock_middle,
                                     gboolean lock_right)
{
    gchar* image_file = g_strdup_printf(DATADIR"/sensor-lock%1d%1d%1d.png",
        lock_left ? 1 : 0,
        lock_middle ? 1 : 0,
        lock_right ? 1 : 0);

    gtk_image_set_from_file(GTK_IMAGE(g_sensor_lock_image), image_file);
    g_free(image_file);
}


static void init_widgets_with_settings()
{
    int to_be_activated = 0;

    to_be_activated = g_cur_sensor_settings.lights_on == TRUE ? 0 : 1;
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_light_radios[to_be_activated]),
                                 TRUE);

    to_be_activated = g_cur_sensor_settings.sound_on == TRUE ? 0 : 1;
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_sound_radios[to_be_activated]),
                                 TRUE);

    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_lock_left_sensor_check),
        g_cur_sensor_settings.lock_left_sensor);

    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_lock_middle_sensor_check),
        g_cur_sensor_settings.lock_middle_sensor);

    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_lock_right_sensor_check),
        g_cur_sensor_settings.lock_right_sensor);

    // Update sensor lock image.
    update_sensor_lock_image(g_cur_sensor_settings.lock_left_sensor,
        g_cur_sensor_settings.lock_middle_sensor,
        g_cur_sensor_settings.lock_right_sensor);
}