/* Evolution calendar - Search bar widget for calendar views
*
* Copyright (C) 2001 Ximian, Inc.
*
* Author: Federico Mena-Quintero <federico@ximian.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public
* License as published by the Free Software Foundation.
*
* This program 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdlib.h>
#include <glib.h>
#include <gtk/gtkmenu.h>
#include <gtk/gtkmenuitem.h>
#include <gtk/gtkoptionmenu.h>
#include <gtk/gtksignal.h>
#include <libgnome/gnome-defs.h>
#include <libgnome/gnome-i18n.h>
#include <gal/widgets/e-unicode.h>
#include "cal-search-bar.h"
/* Menu items for the ESearchBar */
static ESearchBarItem search_menu_items[] = {
E_FILTERBAR_RESET,
{ NULL, -1, NULL }
};
/* IDs and option items for the ESearchBar */
enum {
SEARCH_ANY_FIELD_CONTAINS,
SEARCH_SUMMARY_CONTAINS,
SEARCH_DESCRIPTION_CONTAINS,
SEARCH_COMMENT_CONTAINS,
SEARCH_CATEGORY_IS,
};
static ESearchBarItem search_option_items[] = {
{ N_("Any field contains"), SEARCH_ANY_FIELD_CONTAINS, NULL },
{ N_("Summary contains"), SEARCH_SUMMARY_CONTAINS, NULL },
{ N_("Description contains"), SEARCH_DESCRIPTION_CONTAINS, NULL },
{ N_("Comment contains"), SEARCH_COMMENT_CONTAINS, NULL },
{ N_("Category is"), SEARCH_CATEGORY_IS, NULL },
{ NULL, -1, NULL }
};
/* IDs for the categories suboptions */
#define CATEGORIES_ALL 0
#define CATEGORIES_UNMATCHED 1
#define CATEGORIES_OFFSET 3
/* Private part of the CalSearchBar structure */
struct CalSearchBarPrivate {
/* Array of categories */
GPtrArray *categories;
};
static void cal_search_bar_class_init (CalSearchBarClass *class);
static void cal_search_bar_init (CalSearchBar *cal_search);
static void cal_search_bar_destroy (GtkObject *object);
static void cal_search_bar_query_changed (ESearchBar *search);
static void cal_search_bar_menu_activated (ESearchBar *search, int item);
static ESearchBarClass *parent_class = NULL;
/* Signal IDs */
enum {
SEXP_CHANGED,
CATEGORY_CHANGED,
LAST_SIGNAL
};
static guint cal_search_bar_signals[LAST_SIGNAL] = { 0 };
/**
* cal_search_bar_get_type:
*
* Registers the #CalSearchBar class if necessary and returns the type ID
* associated to it.
*
* Return value: The type ID of the #CalSearchBar class.
**/
GtkType
cal_search_bar_get_type (void)
{
static GtkType cal_search_bar_type = 0;
if (!cal_search_bar_type) {
static const GtkTypeInfo cal_search_bar_info = {
"CalSearchBar",
sizeof (CalSearchBar),
sizeof (CalSearchBarClass),
(GtkClassInitFunc) cal_search_bar_class_init,
(GtkObjectInitFunc) cal_search_bar_init,
NULL, /* reserved_1 */
NULL, /* reserved_2 */
(GtkClassInitFunc) NULL
};
cal_search_bar_type = gtk_type_unique (E_SEARCH_BAR_TYPE, &cal_search_bar_info);
}
return cal_search_bar_type;
}
/* Class initialization function for the calendar search bar */
static void
cal_search_bar_class_init (CalSearchBarClass *class)
{
ESearchBarClass *e_search_bar_class;
GtkObjectClass *object_class;
e_search_bar_class = (ESearchBarClass *) class;
object_class = (GtkObjectClass *) class;
parent_class = gtk_type_class (E_SEARCH_BAR_TYPE);
cal_search_bar_signals[SEXP_CHANGED] =
gtk_signal_new ("sexp_changed",
GTK_RUN_FIRST,
object_class->type,
GTK_SIGNAL_OFFSET (CalSearchBarClass, sexp_changed),
gtk_marshal_NONE__STRING,
GTK_TYPE_NONE, 1,
GTK_TYPE_STRING);
cal_search_bar_signals[CATEGORY_CHANGED] =
gtk_signal_new ("category_changed",
GTK_RUN_FIRST,
object_class->type,
GTK_SIGNAL_OFFSET (CalSearchBarClass, category_changed),
gtk_marshal_NONE__STRING,
GTK_TYPE_NONE, 1,
GTK_TYPE_STRING);
gtk_object_class_add_signals (object_class, cal_search_bar_signals, LAST_SIGNAL);
class->sexp_changed = NULL;
class->category_changed = NULL;
e_search_bar_class->query_changed = cal_search_bar_query_changed;
e_search_bar_class->menu_activated = cal_search_bar_menu_activated;
object_class->destroy = cal_search_bar_destroy;
}
/* Object initialization function for the calendar search bar */
static void
cal_search_bar_init (CalSearchBar *cal_search)
{
CalSearchBarPrivate *priv;
priv = g_new (CalSearchBarPrivate, 1);
cal_search->priv = priv;
priv->categories = g_ptr_array_new ();
g_ptr_array_set_size (priv->categories, 0);
}
/* Frees an array of categories */
static void
free_categories (GPtrArray *categories)
{
int i;
for (i = 0; i < categories->len; i++) {
g_assert (categories->pdata[i] != NULL);
g_free (categories->pdata[i]);
}
g_ptr_array_free (categories, TRUE);
}
/* Destroy handler for the calendar search bar */
static void
cal_search_bar_destroy (GtkObject *object)
{
CalSearchBar *cal_search;
CalSearchBarPrivate *priv;
g_return_if_fail (object != NULL);
g_return_if_fail (IS_CAL_SEARCH_BAR (object));
cal_search = CAL_SEARCH_BAR (object);
priv = cal_search->priv;
if (priv->categories) {
free_categories (priv->categories);
priv->categories = NULL;
}
g_free (priv);
cal_search->priv = NULL;
if (GTK_OBJECT_CLASS (parent_class)->destroy)
(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}
/* Emits the "sexp_changed" signal for the calendar search bar */
static void
notify_sexp_changed (CalSearchBar *cal_search, const char *sexp)
{
gtk_signal_emit (GTK_OBJECT (cal_search), cal_search_bar_signals[SEXP_CHANGED],
sexp);
}
/* Returns the string of the currently selected category, NULL for "Unmatched",
* or (const char *) 1 for "All".
*/
static const char *
get_current_category (CalSearchBar *cal_search)
{
CalSearchBarPrivate *priv;
int id, subid;
priv = cal_search->priv;
g_assert (priv->categories != NULL);
id = e_search_bar_get_item_id (E_SEARCH_BAR (cal_search));
if (id != SEARCH_CATEGORY_IS)
return NULL;
subid = e_search_bar_get_subitem_id (E_SEARCH_BAR (cal_search));
if (subid == CATEGORIES_ALL)
return (const char *) 1;
else if (subid == CATEGORIES_UNMATCHED)
return NULL;
else {
int i;
i = subid - CATEGORIES_OFFSET;
g_assert (i >= 0 && i < priv->categories->len);
return priv->categories->pdata[i];
}
}
/* Sets the query string to be (contains? "field" "text") */
static void
notify_query_contains (CalSearchBar *cal_search, const char *field)
{
char *text;
char *sexp;
text = e_search_bar_get_text (E_SEARCH_BAR (cal_search));
if (!text)
return; /* This is an error in the UTF8 conversion, not an empty string! */
sexp = g_strdup_printf ("(contains? \"%s\" \"%s\")", field, text);
g_free (text);
notify_sexp_changed (cal_search, sexp);
g_free (sexp);
}
/* Returns a sexp for the selected category in the drop-down menu. The "All"
* option is returned as (const char *) 1, and the "Unfiled" option is returned
* as NULL.
*/
static char *
get_category_sexp (CalSearchBar *cal_search)
{
const char *category;
category = get_current_category (cal_search);
if (category == NULL)
return g_strdup ("(has-categories? #f)"); /* Unfiled items */
else if (category == (const char *) 1)
return NULL; /* All items */
else
return g_strdup_printf ("(has-categories? \"%s\")", category); /* Specific category */
}
/* Sets the query string to the appropriate match for categories */
static void
notify_category_is (CalSearchBar *cal_search)
{
char *sexp;
sexp = get_category_sexp (cal_search);
if (!sexp)
notify_sexp_changed (cal_search, "#t"); /* Match all */
else
notify_sexp_changed (cal_search, sexp);
if (sexp)
g_free (sexp);
}
/* Creates a new query from the values in the widgets and notifies upstream */
static void
regen_query (CalSearchBar *cal_search)
{
CalSearchBarPrivate *priv;
int id;
const char *category;
priv = cal_search->priv;
/* Fetch the data from the ESearchBar's entry widgets */
id = e_search_bar_get_item_id (E_SEARCH_BAR (cal_search));
/* Generate the different types of queries */
switch (id) {
case SEARCH_ANY_FIELD_CONTAINS:
notify_query_contains (cal_search, "any");
break;
case SEARCH_SUMMARY_CONTAINS:
notify_query_contains (cal_search, "summary");
break;
case SEARCH_DESCRIPTION_CONTAINS:
notify_query_contains (cal_search, "description");
break;
case SEARCH_COMMENT_CONTAINS:
notify_query_contains (cal_search, "comment");
break;
case SEARCH_CATEGORY_IS:
notify_category_is (cal_search);
category = cal_search_bar_get_category (cal_search);
gtk_signal_emit (GTK_OBJECT (cal_search), cal_search_bar_signals[CATEGORY_CHANGED],
category);
break;
default:
g_assert_not_reached ();
}
}
/* query_changed handler for the calendar search bar */
static void
cal_search_bar_query_changed (ESearchBar *search)
{
CalSearchBar *cal_search;
cal_search = CAL_SEARCH_BAR (search);
regen_query (cal_search);
}
/* menu_activated handler for the calendar search bar */
static void
cal_search_bar_menu_activated (ESearchBar *search, int item)
{
CalSearchBar *cal_search;
cal_search = CAL_SEARCH_BAR (search);
switch (item) {
case E_FILTERBAR_RESET_ID:
notify_sexp_changed (cal_search, "#t"); /* match all */
/* FIXME: should we change the rest of the search bar so that
* the user sees that he selected "show all" instead of some
* type/text search combination?
*/
break;
default:
g_assert_not_reached ();
}
}
/* Creates the suboptions menu for the ESearchBar with the list of categories */
static void
make_suboptions (CalSearchBar *cal_search)
{
CalSearchBarPrivate *priv;
ESearchBarSubitem *subitems;
int i;
priv = cal_search->priv;
g_assert (priv->categories != NULL);
/* Categories plus "all", "unmatched", separator, terminator */
subitems = g_new (ESearchBarSubitem, priv->categories->len + 3 + 1);
/* All, unmatched, separator */
subitems[0].text = _("Any Category");
subitems[0].id = CATEGORIES_ALL;
subitems[0].translate = FALSE;
subitems[1].text = _("Unmatched");
subitems[1].id = CATEGORIES_UNMATCHED;
subitems[1].translate = FALSE;
/* All the other items */
if (priv->categories->len > 0) {
subitems[2].text = NULL; /* separator */
subitems[2].id = 0;
for (i = 0; i < priv->categories->len; i++) {
const char *category;
char *str;
category = priv->categories->pdata[i];
str = e_utf8_to_gtk_string (GTK_WIDGET (cal_search), category);
if (!str)
str = g_strdup ("");
subitems[i + CATEGORIES_OFFSET].text = str;
subitems[i + CATEGORIES_OFFSET].id = i + CATEGORIES_OFFSET;
subitems[i + CATEGORIES_OFFSET].translate = FALSE;
}
subitems[i + CATEGORIES_OFFSET].id = -1; /* terminator */
} else
subitems[2].id = -1; /* terminator */
e_search_bar_set_suboption (E_SEARCH_BAR (cal_search), SEARCH_CATEGORY_IS, subitems);
/* Free the strings */
for (i = 0; i < priv->categories->len; i++)
g_free (subitems[i + CATEGORIES_OFFSET].text);
g_free (subitems);
}
/**
* cal_search_bar_construct:
* @cal_search: A calendar search bar.
*
* Constructs a calendar search bar by binding its menu and option items.
*
* Return value: The same value as @cal_search.
**/
CalSearchBar *
cal_search_bar_construct (CalSearchBar *cal_search)
{
g_return_val_if_fail (cal_search != NULL, NULL);
g_return_val_if_fail (IS_CAL_SEARCH_BAR (cal_search), NULL);
e_search_bar_construct (E_SEARCH_BAR (cal_search), search_menu_items, search_option_items);
make_suboptions (cal_search);
e_search_bar_set_ids (E_SEARCH_BAR (cal_search), SEARCH_CATEGORY_IS, CATEGORIES_ALL);
return cal_search;
}
/**
* cal_search_bar_new:
*
* Creates a new calendar search bar.
*
* Return value: A newly-created calendar search bar. You should connect to the
* "sexp_changed" signal to monitor changes in the generated sexps.
**/
GtkWidget *
cal_search_bar_new (void)
{
CalSearchBar *cal_search;
cal_search = gtk_type_new (TYPE_CAL_SEARCH_BAR);
return GTK_WIDGET (cal_search_bar_construct (cal_search));
}
/* Used from qsort() */
static int
compare_categories_cb (const void *a, const void *b)
{
const char **ca, **cb;
ca = (const char **) a;
cb = (const char **) b;
/* FIXME: should use some utf8 strcoll() thingy */
return strcmp (*ca, *cb);
}
/* Creates a sorted array of categories based on the original one; copies the
* string values.
*/
static GPtrArray *
sort_categories (GPtrArray *categories)
{
GPtrArray *c;
int i;
c = g_ptr_array_new ();
g_ptr_array_set_size (c, categories->len);
for (i = 0; i < categories->len; i++)
c->pdata[i] = g_strdup (categories->pdata[i]);
qsort (c->pdata, c->len, sizeof (gpointer), compare_categories_cb);
return c;
}
/**
* cal_search_bar_set_categories:
* @cal_search: A calendar search bar.
* @categories: Array of pointers to strings for the category names.
*
* Sets the list of categories that are to be shown in the drop-down list
* of a calendar search bar. The search bar will automatically add an item
* for "unfiled" components, that is, those that have no categories assigned
* to them.
**/
void
cal_search_bar_set_categories (CalSearchBar *cal_search, GPtrArray *categories)
{
CalSearchBarPrivate *priv;
g_return_if_fail (cal_search != NULL);
g_return_if_fail (IS_CAL_SEARCH_BAR (cal_search));
g_return_if_fail (categories != NULL);
priv = cal_search->priv;
g_assert (priv->categories != NULL);
free_categories (priv->categories);
priv->categories = sort_categories (categories);
make_suboptions (cal_search);
}
/**
* cal_search_bar_get_category:
* @cal_search: A calendar search bar.
*
* Queries the currently selected category name in a calendar search bar.
* If "All" or "Unfiled" are selected, this function will return NULL.
*
* Return value: Name of the selected category, or NULL if there is no
* selected category.
**/
const char *
cal_search_bar_get_category (CalSearchBar *cal_search)
{
const char *category;
category = get_current_category (cal_search);
if (!category || category == (const char *) 1)
return NULL;
else
return category;
}
