languages.c

Go to the documentation of this file.

/*
 * File Name: languages.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) 2008 iRex Technologies B.V.
 * All rights reserved.
 */

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

// system include files, between < >
#include <locale.h>

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

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

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


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

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

#define MAX_LANGUAGES                 12

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

static gint g_orig_language = 0;
static gint g_cur_language = 0;

static GtkWidget* g_language_radios[MAX_LANGUAGES] = { 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                        NULL, 
                                                    };

static gboolean   g_is_firstboot        = FALSE;
static GtkWidget* g_main_window         = NULL ;
static GtkWidget* g_title               = NULL;
static GtkWidget* g_subtitle            = NULL;
static GtkWidget* g_language_label      = NULL;
static GtkWidget* g_language_label_desc = NULL;
static GtkWidget* g_continue_button     = NULL;
static GtkWidget* g_continue_label      = NULL;
static GtkWidget* g_continue_label_desc = NULL;

static const GdkColor grey = {0, 0x5500, 0x5500, 0x5500};

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

static GtkWidget* create_language_widgets       (GtkBox* parent);
static void create_descriptive_text_widgets     (GtkBox* parent);
static GtkWidget* create_continue_widgets       (GtkBox* parent);

static GSList*    get_available_locales         ();
static GSList*    get_available_languages       ();
static void       free_string_list              (GSList* lang_list);

static void       on_language_selection_changed (GtkWidget *widget, gpointer data);
static void       update_labels_and_buttons (void);
static gboolean   on_continue_button_clicked(GtkWidget* widget, gpointer data);

static void init_widgets_with_settings          (void);
//============================================================================
// Functions Implementation
//============================================================================

GtkWidget* create_language_window(GtkWidget* parent, gboolean is_firstboot)
{
    g_is_firstboot = is_firstboot;

    // create top window
    GtkWidget* top_window = parent;
    if (is_firstboot) 
    {
        gtk_window_fullscreen(GTK_WINDOW(top_window));
    } else 
    {
        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, 3);
    gtk_container_add(GTK_CONTAINER(top_window), vboxtop);

    // add header container the title and subtitle of this settings page
    create_title_keep_labels(GTK_VBOX(vboxtop), NULL, NULL, &g_title, &g_subtitle);

    GtkWidget* view = NULL ; 
    if (! is_firstboot) {
        // add the back/exit bar below the title 
        view = create_settingsview_for_type( SETTING_LANGUAGE );
        gtk_box_pack_start(GTK_BOX(vboxtop), view, FALSE, FALSE,0 ); 
    }

    // The margin settings section.
    create_language_widgets(GTK_BOX(vboxtop));


    if ( ! is_firstboot )
    {
        gtk_widget_grab_focus(view);
    }
    else {
        // create save frame
        create_continue_widgets(GTK_BOX(vboxtop));
    }
    
    // Update widget with current settings.
    init_widgets_with_settings();

    g_main_window = top_window;

    gtk_widget_show_all(top_window);

    return top_window;
}

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

static GtkWidget* create_radio_button_item(GtkWidget* group, gchar* title)
{
    GtkWidget* radio_button = NULL ;
    if ( group == NULL ) 
    {
        radio_button = gtk_radio_button_new(NULL); 
    }
    else {
        radio_button = gtk_radio_button_new_from_widget(GTK_RADIO_BUTTON(group)); 

    }
    gtk_widget_set_name(radio_button, "irex-settings-checkbutton");

    // alignment in radio button for some padding
    GtkWidget* align = gtk_alignment_new(0, 0.0, 1.0, 1.0);
    gtk_container_add(GTK_CONTAINER(radio_button), align);
    gtk_alignment_set_padding(GTK_ALIGNMENT(align)
                                , 6 // top
                                , 6 // bottom
                                , 6 // left
                                , 6 // right
            );
 
    // top level label for radio button ( no margins )
    GtkWidget* label = gtk_label_new( title );
    gtk_widget_set_name(label, "irex-radio-title");
    gtk_misc_set_alignment(GTK_MISC(label), 0.5, 0.0);
    gtk_container_add(GTK_CONTAINER(align), label);

    return radio_button;
}

static void create_descriptive_text_widgets(GtkBox* parent)
{
    GtkVBox* vbox = GTK_VBOX(parent);

    // the label Default Language
    g_language_label = subject_create();
    gtk_box_pack_start(GTK_BOX(vbox), g_language_label, FALSE, FALSE, 0);

    // the label language description
    g_language_label_desc = description_create();
    gtk_box_pack_start(GTK_BOX(vbox), g_language_label_desc, FALSE, FALSE, 0);

    // add separator
    GtkWidget* separator = create_separator_widgets();
    gtk_widget_set_name(separator, "irex-separator-invisible");
    gtk_box_pack_start(GTK_BOX(vbox), separator, FALSE, FALSE, 0);
}

static GtkWidget* create_language_widgets(GtkBox* parent)
{
    GtkVBox* frame = create_frame(GTK_VBOX(parent));
    
    // the descriptive text
    create_descriptive_text_widgets(GTK_BOX(frame));

    GSList* lang_list = get_available_languages();
    int n_languages = g_slist_length(lang_list);

    // limit the number of supported languages to MAX_LANGUAGES.
    // more does not fit on the screen
    if ( n_languages > MAX_LANGUAGES ) 
    {
        n_languages = MAX_LANGUAGES;
    }

    GList* p = (GList *) lang_list;

    int i = 0 ;
    for (i=0; i<n_languages; i++, p=p->next)
    {
        if ( i == 0 )
        {
                // the first radio button
                g_language_radios[i] =  create_radio_button_item(NULL, p->data); 
        }
        else {
                // The other radio buttons
                g_language_radios[i] = create_radio_button_item(g_language_radios[0], p->data);
        }

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

        gtk_box_pack_start(GTK_BOX(frame), g_language_radios[i], FALSE, FALSE, 0);
    }

    return GTK_WIDGET(frame);
}

static GtkWidget* create_continue_widgets(GtkBox* parent)
{
    GtkVBox* frame = create_frame(GTK_VBOX(parent));

    // the label Default Language
    g_continue_label = subject_create();
    gtk_box_pack_start(GTK_BOX(frame), g_continue_label, FALSE, FALSE, 0);

    // the label language description
    g_continue_label_desc = description_create();
    gtk_box_pack_start(GTK_BOX(frame), g_continue_label_desc, FALSE, FALSE, 0);

    // add separator
    GtkWidget* separator = create_separator_widgets();
    gtk_widget_set_name(separator, "irex-separator-invisible");
    gtk_box_pack_start(GTK_BOX(frame), separator, FALSE, FALSE, 0);

     // create button box
    GtkWidget* button_box = gtk_hbutton_box_new();
    gtk_box_pack_start(GTK_BOX(frame), button_box, FALSE, FALSE, 9);
    gtk_button_box_set_layout(GTK_BUTTON_BOX(button_box), GTK_BUTTONBOX_START);
    
    g_continue_button = gtk_button_new();
    gtk_box_pack_start(GTK_BOX(button_box), g_continue_button, FALSE, FALSE, 0);
    // Add signal handler.
    g_signal_connect(G_OBJECT(g_continue_button),
            "clicked",
            G_CALLBACK(on_continue_button_clicked ),
            (gpointer) NULL );

    return GTK_WIDGET(frame);
}

static void update_labels_and_buttons()
{
    if (g_is_firstboot)
    {
        // title
        gtk_label_set_label(GTK_LABEL(g_title), _("Setup"));
        // subtitle
        gtk_label_set_label(GTK_LABEL(g_subtitle), _("Language Selection"));
        // text for label g_language_label
        gtk_label_set_label(GTK_LABEL(g_language_label), _("Language"));
        // text for label g_language_label_desc
        gtk_label_set_label(GTK_LABEL(g_language_label_desc), _("Choose the language to be used on this Digital Reader "
                                                                "and click continue to start using the device"));
        // Continue section
        gtk_label_set_label(GTK_LABEL(g_continue_label), _("Save & Continue"));
        gtk_label_set_label(GTK_LABEL(g_continue_label_desc),
                _("Tap continue to save the changes and start using the device."));
        gtk_button_set_label(GTK_BUTTON(g_continue_button),  _("Save") );
    }
    else
    {
        // title
        gtk_label_set_label(GTK_LABEL(g_title), _("Settings"));
        // subtitle
        gtk_label_set_label(GTK_LABEL(g_subtitle), _("Language Selection"));
        // update exit bar
        update_settings_exit_text( _("to Settings"), _("Return to the Settings overview page"));
        // text for label g_language_label
        gtk_label_set_label(GTK_LABEL(g_language_label), _("Default Language"));
        // text for label g_language_label_desc
        gtk_label_set_label(GTK_LABEL(g_language_label_desc), _("Choose the language to be used on this Digital Reader"));
    }
}

static void on_language_selection_changed(GtkWidget *widget, gpointer data)
{
    GSList* available_locales = NULL;
    const char* cur_locale    = NULL;
    int index                 = (int)data;

    gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
    if (is_active == FALSE || index == g_cur_language)
    {
        return;
    }

    g_cur_language = index;

    // Step 1: Call setlocale.
    available_locales = get_available_locales();
    cur_locale = g_slist_nth_data(available_locales, g_cur_language);

    g_setenv("LANG", cur_locale, TRUE);
    setlocale(LC_ALL, cur_locale);
    free_string_list(available_locales);

    // Step 2: Update labels and buttons with new locale.
    update_labels_and_buttons();
    
    // Step 3: Save the new setting
    save_language_settings();
}

static gboolean on_continue_button_clicked(GtkWidget* widget, gpointer data)
{

    //save_language_settings();
    main_quit();
    return FALSE;
}

static GSList* get_available_locales()
{
    return get_value_string_list(GCONF_LOCALE_LIST);
}

static GSList* get_available_languages()
{
    return get_value_string_list(GCONF_LANGUAGE_LIST);
}

static void free_string_list(GSList* lang_list)
{
    GSList* p = lang_list;

    while (p)
    {
        g_free(p->data);
        p = p->next;
    }

    g_slist_free(lang_list);
    lang_list = NULL;
}

static void init_widgets_with_settings()
{
    // Update labels with current locale.
    update_labels_and_buttons();

    // Set current chosen language option.
    g_assert( g_cur_language < MAX_LANGUAGES );
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_language_radios[g_cur_language]), TRUE);
}

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

void load_language_settings()
{
    GSList* available_locales = get_available_locales();
    const char* cur_locale = get_value_string(GCONF_CURRENT_LOCALE);
    if (cur_locale == NULL)
    {
        cur_locale = "en_US";
    }

    GSList* found = g_slist_find_custom(available_locales, cur_locale, (GCompareFunc)strcmp);
    if (!found)
    {
        LOGPRINTF("Locale [%s] not found - try en_US", cur_locale);
        found = g_slist_find_custom(available_locales, "en_US", (GCompareFunc)strcmp);
    }
    if (!found)
    {
        LOGPRINTF("Locale en_US not found - try en_GB");
        found = g_slist_find_custom(available_locales, "en_GB", (GCompareFunc)strcmp);
    }

    g_orig_language = g_slist_position(available_locales, found);
    g_cur_language = g_orig_language;
}

void save_language_settings()
{
    GSList*  available_locales = NULL;
    gpointer cur_locale        = NULL;

    // Save language settings if necessary.
    if (g_cur_language != g_orig_language)
    {
        // Set current locale.
        available_locales = get_available_locales();
        cur_locale = g_slist_nth_data(available_locales, g_cur_language);
        set_value_string(GCONF_CURRENT_LOCALE, cur_locale);
        free_string_list(available_locales);
    }

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

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

void rollback_language_settings()
{
    GSList* available_locales = NULL;
    const char* cur_locale    = NULL;

    if (g_cur_language == g_orig_language)
    {
        return;
    }

    g_cur_language = g_orig_language;

    // Set locale back to original.
    available_locales = get_available_locales();
    cur_locale = g_slist_nth_data(available_locales, g_orig_language);
    setlocale(LC_ALL, cur_locale);
    free_string_list(available_locales);
}

void language_set_main_focus(void)
{
    gtk_widget_grab_focus(g_language_radios[0]);
}