From d09d8de870b6697c8a8b262e7e077b871a69b315 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Mon, 10 Dec 2012 08:09:59 -0500 Subject: Consolidate base utility libraries into libeutil. Evolution consists of entirely too many small utility libraries, which increases linking and loading time, places a burden on higher layers of the application (e.g. modules) which has to remember to link to all the small in-tree utility libraries, and makes it difficult to generate API documentation for these utility libraries in one Gtk-Doc module. Merge the following utility libraries under the umbrella of libeutil, and enforce a single-include policy on libeutil so we can reorganize the files as desired without disrupting its pseudo-public API. libemail-utils/libemail-utils.la libevolution-utils/libevolution-utils.la filter/libfilter.la widgets/e-timezone-dialog/libetimezonedialog.la widgets/menus/libmenus.la widgets/misc/libemiscwidgets.la widgets/table/libetable.la widgets/text/libetext.la This also merges libedataserverui from the Evolution-Data-Server module, since Evolution is its only consumer nowadays, and I'd like to make some improvements to those APIs without concern for backward-compatibility. And finally, start a Gtk-Doc module for libeutil. It's going to be a project just getting all the symbols _listed_ much less _documented_. But the skeletal structure is in place and I'm off to a good start. --- e-util/e-text-model.h | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 e-util/e-text-model.h (limited to 'e-util/e-text-model.h') diff --git a/e-util/e-text-model.h b/e-util/e-text-model.h new file mode 100644 index 0000000000..3426c183e2 --- /dev/null +++ b/e-util/e-text-model.h @@ -0,0 +1,112 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) version 3. + * + * 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with the program; if not, see + * + * + * Authors: + * Chris Lahey + * + * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) + * + */ + +#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION) +#error "Only should be included directly." +#endif + +#ifndef E_TEXT_MODEL_H +#define E_TEXT_MODEL_H + +#include + +G_BEGIN_DECLS + +#define E_TYPE_TEXT_MODEL (e_text_model_get_type ()) +#define E_TEXT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_TEXT_MODEL, ETextModel)) +#define E_TEXT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_TEXT_MODEL, ETextModelClass)) +#define E_IS_TEXT_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_TEXT_MODEL)) +#define E_IS_TEXT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_TEXT_MODEL)) +#define E_TEXT_MODEL_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), E_TYPE_TEXT_MODEL_TYPE, ETextModelClass)) + +typedef struct _ETextModel ETextModel; +typedef struct _ETextModelClass ETextModelClass; +typedef struct _ETextModelPrivate ETextModelPrivate; + +typedef gint (*ETextModelReposFn) (gint, gpointer); + +struct _ETextModel { + GObject item; + + ETextModelPrivate *priv; +}; + +struct _ETextModelClass { + GObjectClass parent_class; + + /* Signal */ + void (* changed) (ETextModel *model); + void (* reposition) (ETextModel *model, ETextModelReposFn fn, gpointer repos_fn_data); + void (* object_activated) (ETextModel *model, gint obj_num); + void (* cancel_completion) (ETextModel *model); + + /* Virtual methods */ + + gint (* validate_pos) (ETextModel *model, gint pos); + + const gchar *(* get_text) (ETextModel *model); + gint (* get_text_len) (ETextModel *model); + void (* set_text) (ETextModel *model, const gchar *text); + void (* insert) (ETextModel *model, gint position, const gchar *text); + void (* insert_length) (ETextModel *model, gint position, const gchar *text, gint length); + void (* delete) (ETextModel *model, gint position, gint length); + + void (* objectify) (ETextModel *model); + gint (* obj_count) (ETextModel *model); + const gchar *(* get_nth_obj) (ETextModel *model, gint n, gint *len); + gint (* obj_at_offset) (ETextModel *model, gint offset); +}; + +GType e_text_model_get_type (void); + +ETextModel *e_text_model_new (void); + +void e_text_model_changed (ETextModel *model); +void e_text_model_cancel_completion (ETextModel *model); + +void e_text_model_reposition (ETextModel *model, ETextModelReposFn fn, gpointer repos_data); +gint e_text_model_validate_position (ETextModel *model, gint pos); + +/* Functions for manipulating the underlying text. */ + +const gchar *e_text_model_get_text (ETextModel *model); +gint e_text_model_get_text_length (ETextModel *model); +void e_text_model_set_text (ETextModel *model, const gchar *text); +void e_text_model_insert (ETextModel *model, gint position, const gchar *text); +void e_text_model_insert_length (ETextModel *model, gint position, const gchar *text, gint length); +void e_text_model_prepend (ETextModel *model, const gchar *text); +void e_text_model_append (ETextModel *model, const gchar *text); +void e_text_model_delete (ETextModel *model, gint position, gint length); + +/* Functions for accessing embedded objects. */ + +gint e_text_model_object_count (ETextModel *model); +const gchar *e_text_model_get_nth_object (ETextModel *model, gint n, gint *len); +gchar *e_text_model_strdup_nth_object (ETextModel *model, gint n); +void e_text_model_get_nth_object_bounds (ETextModel *model, gint n, gint *start_pos, gint *end_pos); +gint e_text_model_get_object_at_offset (ETextModel *model, gint offset); +gint e_text_model_get_object_at_pointer (ETextModel *model, const gchar *c); +void e_text_model_activate_nth_object (ETextModel *model, gint n); + +G_END_DECLS + +#endif -- cgit v1.2.3