libanjuta/anjuta-utils.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * anjuta-utils.h
   4  * Copyright (C) Naba Kumar  <naba@gnome.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20 #ifndef _ANJUTA_UTILS_H_
  21 #define _ANJUTA_UTILS_H_
  22
  23 #include <glib.h>
  24 #include <gtk/gtk.h>
  25 #include <sys/types.h>
  26 #include <gio/gio.h>
  27
  28 G_BEGIN_DECLS
  29
  30 gboolean        anjuta_util_copy_file                                   (const gchar * src,
  31                                                                              const gchar * dest,
  32                                                                                  gboolean show_error);
  33
  34 gboolean        anjuta_util_diff                                                (const gchar* uri,
  35                                                                                  const gchar* text);
  36
  37 void            anjuta_util_color_from_string                   (const gchar * val, guint16 * r,
  38                                                                         guint16 * g, guint16 * b);
  39
  40 gchar*          anjuta_util_string_from_color                   (guint16 r, guint16 g, guint16 b);
  41
  42 GtkWidget*  anjuta_util_button_new_with_stock_image (const gchar* text,
  43                                                                                                         const gchar* stock_id);
  44
  45 GtkWidget*  anjuta_util_dialog_add_button                       (GtkDialog *dialog,
  46                                                                  const gchar* text,
  47                                                                                                          const gchar* stock_id,
  48                                                                                                          gint response_id);
  49
  50 void            anjuta_util_dialog_error                                (GtkWindow *parent,
  51                                                                              const gchar * mesg, ...);
  52 void            anjuta_util_dialog_warning                              (GtkWindow *parent,
  53                                                                              const gchar * mesg, ...);
  54 void            anjuta_util_dialog_info                                 (GtkWindow *parent,
  55                                                                                  const gchar * mesg, ...);
  56 void            anjuta_util_dialog_error_system                 (GtkWindow* parent, gint errnum,
  57                                                                                                         const gchar * mesg, ... );
  58 gboolean        anjuta_util_dialog_boolean_question             (GtkWindow *parent,
  59                                                                                                         const gchar * mesg, ...);
  60 gboolean        anjuta_util_dialog_input                                (GtkWindow *parent,
  61                                                                          const gchar *label,
  62                                                                                                          const gchar *default_value,
  63                                                                          gchar **value);
  64
  65 gboolean        anjuta_util_install_files                               (const gchar * const names);
  66 gboolean        anjuta_util_package_is_installed                (const gchar * lib, gboolean show);
  67 gboolean        anjuta_util_prog_is_installed                   (const gchar * prog, gboolean show);
  68
  69 gchar*          anjuta_util_get_a_tmp_file                              (void);
  70
  71 gchar*          anjuta_util_convert_to_utf8                             (const gchar *str);
  72
  73 GList*          anjuta_util_parse_args_from_string              (const gchar* string);
  74
  75 /***********************************************/
  76 /* String integer mapping utility functions    */
  77 /***********************************************/
  78 typedef struct _AnjutaUtilStringMap
  79 {
  80         int type;
  81         char *name;
  82 } AnjutaUtilStringMap;
  83
  84 int                     anjuta_util_type_from_string                    (AnjutaUtilStringMap *map,
  85                                                                              const char *str);
  86 const char *anjuta_util_string_from_type                        (AnjutaUtilStringMap *map,
  87                                                                  int type);
  88 GList *         anjuta_util_glist_from_map                              (AnjutaUtilStringMap *map);
  89
  90 /***********************************************/
  91 /*  Functions that operate on list of strings. */
  92 /***********************************************/
  93 void            anjuta_util_glist_strings_free                  (GList* list);
  94 void            anjuta_util_glist_strings_prefix                (GList * list, const gchar *prefix);
  95 void            anjuta_util_glist_strings_sufix                 (GList * list, const gchar *sufix);
  96 GList*          anjuta_util_glist_strings_sort                  (GList * list);
  97 gchar*          anjuta_util_glist_strings_join                  (GList * list, gchar *delimiter);
  98
  99 /**********************************************************/
 100 /* Both the returned glist and the data should be g_freed */
 101 /* Call g_list_strings_free() to do that.                 */
 102 /**********************************************************/
 103 GList*          anjuta_util_glist_from_string                   (const gchar* id);
 104 GList*          anjuta_util_glist_strings_dup                   (GList * list);
 105
 106 /* Dedup a list of paths - duplicates are removed from the tail.
 107 ** Useful for deduping Recent Files and Recent Projects */
 108 GList*          anjuta_util_glist_path_dedup                    (GList *list);
 109
 110 /* Adds the given string in the list, if it does not already exist. */
 111 /* The added string will come at the top of the list */
 112 /* The list will be then truncated to (length) items only */
 113 GList *         anjuta_util_update_string_list                  (GList *p_list,
 114                                                                         const gchar *p_str,
 115                                                                                                         gint length);
 116
 117 gboolean        anjuta_util_create_dir                                  (const gchar * d);
 118 gchar *         anjuta_util_user_shell                                  (void);
 119 gchar **        anjuta_util_user_terminal                               (void);
 120 pid_t           anjuta_util_execute_shell                               (const gchar *dir, const gchar *command);
 121 pid_t           anjuta_util_execute_terminal_shell              (const gchar *dir, const gchar *command);
 122
 123 gchar*          anjuta_util_escape_quotes                               (const gchar* str);
 124
 125 gchar*          anjuta_util_get_real_path                               (const gchar *path);
 126 gchar*          anjuta_util_get_current_dir                             (void);
 127 GFile *         anjuta_util_file_new_for_commandline_arg(const gchar *arg);
 128
 129 gchar*          anjuta_util_uri_get_dirname                             (const gchar *uri);
 130 gchar*          anjuta_util_replace_home_dir_with_tilde (const gchar *uri);
 131 gchar*          anjuta_util_shell_expand                                (const gchar *string);
 132 gchar*          anjuta_util_str_middle_truncate                 (const gchar *string,
 133                                                                                                         guint truncate_length);
 134
 135 gboolean        anjuta_util_is_project_file                             (const gchar *filename);
 136 gboolean        anjuta_util_is_template_file                    (const gchar *filename);
 137 gchar*          anjuta_util_get_file_mime_type                  (GFile *file);
 138 gchar*          anjuta_util_get_local_path_from_uri             (const gchar *uri);
 139
 140 void            anjuta_util_help_display                                (GtkWidget   *parent,
 141                                                                                                         const gchar *doc_id,
 142                                                                                                         const gchar *file_name);
 143
 144 /* XDG BaseDir specifcation functions */
 145 GFile*          anjuta_util_get_user_data_file                  (const gchar* path, ...);
 146 GFile*          anjuta_util_get_user_cache_file                 (const gchar* path, ...);
 147 GFile*          anjuta_util_get_user_config_file                (const gchar* path, ...);
 148 gchar*          anjuta_util_get_user_data_file_path             (const gchar* path, ...);
 149 gchar*          anjuta_util_get_user_cache_file_path    (const gchar* path, ...);
 150 gchar*          anjuta_util_get_user_config_file_path   (const gchar* path, ...);
 151
 152 /* Get the correct e-mail address */
 153 gchar*          anjuta_util_get_user_mail                               (void);
 154
 155 /* Function for converting GFile objects to string paths
 156  * Free the returned list with anjuta_util_glist_strings_free. */
 157 GList *         anjuta_util_convert_gfile_list_to_path_list (GList *list);
 158 GList *         anjuta_util_convert_gfile_list_to_relative_path_list (GList *list,
 159                                                                                                                          const gchar *parent);
 160
 161 /* Helper functions to load a GtkBuilder file and get widgets */
 162 GtkBuilder *anjuta_util_builder_new                                     (const gchar *filename,
 163                                                                         GError **error);
 164 gboolean        anjuta_util_builder_get_objects                 (GtkBuilder *builder,
 165                                                                     const gchar *first_widget,...);
 166
 167 /* Helper for drag and drop */
 168 GSList *        anjuta_utils_drop_get_files                             (GtkSelectionData *selection_data);
 169 GPtrArray * anjuta_util_clone_string_gptrarray          (const GPtrArray* source);
 170
 171 /* Temporarily copied here */
 172
 173 /**
 174  * ANJUTA_TYPE_BEGIN:
 175  * @class_name: Name of the object
 176  * @prefix: Prefix used for object methods
 177  * @parent_type: The parent type of the object
 178  *
 179  * Create a new GObject for Anjuta. You can use ANJUTA_TYPE_ADD_INTERFACE
 180  * to add interfaces to it and should close it using ANJUTA_TYPE_END
 181  */
 182 #define ANJUTA_TYPE_BEGIN(class_name, prefix, parent_type) \
 183 GType                                                     \
 184 prefix##_get_type (void)                                  \
 185 {                                                         \
 186   static GType type = 0;                                  \
 187   if (!type)                                              \
 188     {                                                     \
 189         static const GTypeInfo type_info =                \
 190         {                                                 \
 191           sizeof (class_name##Class),                     \
 192           (GBaseInitFunc) NULL,                           \
 193           (GBaseFinalizeFunc) NULL,                       \
 194           (GClassInitFunc) prefix##_class_init,           \
 195           (GClassFinalizeFunc) NULL,                      \
 196           NULL,                                           \
 197           sizeof (class_name),                            \
 198           0, /* n_preallocs */                            \
 199           (GInstanceInitFunc) prefix##_instance_init,     \
 200         };                                                \
 201                                                           \
 202         type = g_type_register_static (parent_type,       \
 203                                        #class_name,       \
 204                                        &type_info, 0);
 205
 206 /**
 207  * ANJUTA_TYPE_END
 208  *
 209  * Ends a declaration that began with ANJUTA_TYPE_BEGIN
 210  */
 211 #define ANJUTA_TYPE_END                                   \
 212      }                                                    \
 213   return type;                                            \
 214 }
 215
 216 /**
 217  * ANJUTA_TYPE_ADD_INTERFACE:
 218  * @prefix: Prefix for the interface methods
 219  * @interface_type: Type of the interface to implement
 220  *
 221  * Adds an interface to a declaration started with ANJUTA_TYPE_BEGIN
 222  */
 223 #define ANJUTA_TYPE_ADD_INTERFACE(prefix,interface_type)  \
 224     {                                                     \
 225         GInterfaceInfo iface_info = {                     \
 226             (GInterfaceInitFunc)prefix##_iface_init,      \
 227             NULL,                                         \
 228             NULL                                          \
 229         };                                                \
 230         g_type_add_interface_static (type,                \
 231                                      interface_type,      \
 232                                      &iface_info);        \
 233     }
 234
 235 /**
 236  * ANJUTA_TYPE_BOILERPLATE:
 237  * @class_name: Name of the object
 238  * @prefix: Prefix for the class methods
 239  * @parent_type: Parent type for object
 240  *
 241  * Simpliefied version of ANJUTA_TYPE_BEGIN that just creates an Object
 242  * without interfaces and doesn't need ANJUTA_TYPE_END
 243  */
 244 #define ANJUTA_TYPE_BOILERPLATE(class_name, prefix, parent_type) \
 245 ANJUTA_TYPE_BEGIN(class_name, prefix, parent_type);              \
 246 ANJUTA_TYPE_END
 247
 248 G_END_DECLS
 249
 250 #endif