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 #include <libanjuta/interfaces/ianjuta-iterable.h>
  28
  29 G_BEGIN_DECLS
  30
  31 gboolean        anjuta_util_copy_file                                   (const gchar * src,
  32                                                                              const gchar * dest,
  33                                                                                  gboolean show_error);
  34
  35 gboolean        anjuta_util_diff                                                (const gchar* uri,
  36                                                                                  const gchar* text);
  37
  38 void            anjuta_util_color_from_string                   (const gchar * val, guint16 * r,
  39                                                                         guint16 * g, guint16 * b);
  40
  41 gchar*          anjuta_util_string_from_color                   (guint16 r, guint16 g, guint16 b);
  42
  43 GtkWidget*  anjuta_util_button_new_with_stock_image (const gchar* text,
  44                                                                                                         const gchar* stock_id);
  45
  46 GtkWidget*  anjuta_util_dialog_add_button                       (GtkDialog *dialog,
  47                                                                  const gchar* text,
  48                                                                                                          const gchar* stock_id,
  49                                                                                                          gint response_id);
  50
  51 void            anjuta_util_dialog_error                                (GtkWindow *parent,
  52                                                                              const gchar * mesg, ...);
  53 void            anjuta_util_dialog_warning                              (GtkWindow *parent,
  54                                                                              const gchar * mesg, ...);
  55 void            anjuta_util_dialog_info                                 (GtkWindow *parent,
  56                                                                                  const gchar * mesg, ...);
  57 void            anjuta_util_dialog_error_system                 (GtkWindow* parent, gint errnum,
  58                                                                                                         const gchar * mesg, ... );
  59 gboolean        anjuta_util_dialog_boolean_question             (GtkWindow *parent,
  60                                                                                                         const gchar * mesg, ...);
  61 gboolean        anjuta_util_dialog_input                                (GtkWindow *parent,
  62                                                                          const gchar *label,
  63                                                                                                          const gchar *default_value,
  64                                                                          gchar **value);
  65
  66 gboolean        anjuta_util_install_files                               (const gchar * const names);
  67 gboolean        anjuta_util_package_is_installed                (const gchar * lib, gboolean show);
  68 gboolean        anjuta_util_prog_is_installed                   (const gchar * prog, gboolean show);
  69
  70 gchar*          anjuta_util_get_a_tmp_file                              (void);
  71
  72 gchar*          anjuta_util_convert_to_utf8                             (const gchar *str);
  73
  74 gboolean        anjuta_util_jump_to_matching_brace              (IAnjutaIterable *iter,
  75                                                                  gchar brace, gint limit);
  76
  77 GList*          anjuta_util_parse_args_from_string              (const gchar* string);
  78
  79 /***********************************************/
  80 /* String integer mapping utility functions    */
  81 /***********************************************/
  82 typedef struct _AnjutaUtilStringMap
  83 {
  84         int type;
  85         char *name;
  86 } AnjutaUtilStringMap;
  87
  88 int                     anjuta_util_type_from_string                    (AnjutaUtilStringMap *map,
  89                                                                              const char *str);
  90 const char *anjuta_util_string_from_type                        (AnjutaUtilStringMap *map,
  91                                                                  int type);
  92 GList *         anjuta_util_glist_from_map                              (AnjutaUtilStringMap *map);
  93
  94 /***********************************************/
  95 /*  Functions that operate on list of strings. */
  96 /***********************************************/
  97 void            anjuta_util_glist_strings_free                  (GList* list);
  98 void            anjuta_util_glist_strings_prefix                (GList * list, const gchar *prefix);
  99 void            anjuta_util_glist_strings_sufix                 (GList * list, const gchar *sufix);
 100 GList*          anjuta_util_glist_strings_sort                  (GList * list);
 101 gchar*          anjuta_util_glist_strings_join                  (GList * list, gchar *delimiter);
 102
 103 /**********************************************************/
 104 /* Both the returned glist and the data should be g_freed */
 105 /* Call g_list_strings_free() to do that.                 */
 106 /**********************************************************/
 107 GList*          anjuta_util_glist_from_string                   (const gchar* id);
 108 GList*          anjuta_util_glist_strings_dup                   (GList * list);
 109
 110 /* Dedup a list of paths - duplicates are removed from the tail.
 111 ** Useful for deduping Recent Files and Recent Projects */
 112 GList*          anjuta_util_glist_path_dedup                    (GList *list);
 113
 114 /* Adds the given string in the list, if it does not already exist. */
 115 /* The added string will come at the top of the list */
 116 /* The list will be then truncated to (length) items only */
 117 GList *         anjuta_util_update_string_list                  (GList *p_list,
 118                                                                         const gchar *p_str,
 119                                                                                                         gint length);
 120
 121 gboolean        anjuta_util_create_dir                                  (const gchar * d);
 122 gchar *         anjuta_util_user_shell                                  (void);
 123 gchar **        anjuta_util_user_terminal                               (void);
 124 pid_t           anjuta_util_execute_shell                               (const gchar *dir, const gchar *command);
 125 pid_t           anjuta_util_execute_terminal_shell              (const gchar *dir, const gchar *command);
 126
 127 gchar*          anjuta_util_escape_quotes                               (const gchar* str);
 128
 129 gchar*          anjuta_util_get_real_path                               (const gchar *path);
 130 gchar*          anjuta_util_get_current_dir                             (void);
 131 GFile *         anjuta_util_file_new_for_commandline_arg(const gchar *arg);
 132
 133 gchar*          anjuta_util_uri_get_dirname                             (const gchar *uri);
 134 gchar*          anjuta_util_replace_home_dir_with_tilde (const gchar *uri);
 135 gchar*          anjuta_util_shell_expand                                (const gchar *string);
 136 gchar*          anjuta_util_str_middle_truncate                 (const gchar *string,
 137                                                                                                         guint truncate_length);
 138
 139 gboolean        anjuta_util_is_project_file                             (const gchar *filename);
 140 gboolean        anjuta_util_is_template_file                    (const gchar *filename);
 141 gchar*          anjuta_util_get_file_mime_type                  (GFile *file);
 142 gchar*          anjuta_util_get_local_path_from_uri             (const gchar *uri);
 143
 144 void            anjuta_util_help_display                                (GtkWidget   *parent,
 145                                                                                                         const gchar *doc_id,
 146                                                                                                         const gchar *item);
 147
 148 /* XDG BaseDir specifcation functions */
 149 GFile*          anjuta_util_get_user_data_file                  (const gchar* path, ...);
 150 GFile*          anjuta_util_get_user_cache_file                 (const gchar* path, ...);
 151 GFile*          anjuta_util_get_user_config_file                (const gchar* path, ...);
 152 gchar*          anjuta_util_get_user_data_file_path             (const gchar* path, ...);
 153 gchar*          anjuta_util_get_user_cache_file_path    (const gchar* path, ...);
 154 gchar*          anjuta_util_get_user_config_file_path   (const gchar* path, ...);
 155
 156 /* Get the correct e-mail address */
 157 gchar*          anjuta_util_get_user_mail                               (void);
 158
 159 /* Function for converting GFile objects to string paths
 160  * Free the returned list with anjuta_util_glist_strings_free. */
 161 GList *         anjuta_util_convert_gfile_list_to_path_list (GList *list);
 162 GList *         anjuta_util_convert_gfile_list_to_relative_path_list (GList *list,
 163                                                                                                                          const gchar *parent);
 164
 165 /* the returned GPtrArray should be freed with g_ptr_array_unref ().
 166  * The GPtrArray is created with g_free () destroy function as parameter.
 167  */
 168 GPtrArray * anjuta_util_convert_string_list_to_array(GList *list);
 169
 170 /* list all files in a given directory */
 171 void            anjuta_util_list_all_dir_children           (GList **children, GFile *dir);
 172
 173 /* Helper functions to load a GtkBuilder file and get widgets */
 174 GtkBuilder *anjuta_util_builder_new                                     (const gchar *filename,
 175                                                                         GError **error);
 176 gboolean        anjuta_util_builder_get_objects                 (GtkBuilder *builder,
 177                                                                     const gchar *first_widget,...);
 178
 179 /* Helper for drag and drop */
 180 GSList *        anjuta_utils_drop_get_files                             (GtkSelectionData *selection_data);
 181 GPtrArray * anjuta_util_clone_string_gptrarray          (const GPtrArray* source);
 182
 183 /* Temporarily copied here */
 184
 185 /**
 186  * ANJUTA_TYPE_BEGIN:
 187  * @class_name: Name of the object
 188  * @prefix: Prefix used for object methods
 189  * @parent_type: The parent type of the object
 190  *
 191  * Create a new GObject for Anjuta. You can use ANJUTA_TYPE_ADD_INTERFACE
 192  * to add interfaces to it and should close it using ANJUTA_TYPE_END
 193  */
 194 #define ANJUTA_TYPE_BEGIN(class_name, prefix, parent_type) \
 195 GType                                                     \
 196 prefix##_get_type (void)                                  \
 197 {                                                         \
 198   static GType type = 0;                                  \
 199   if (!type)                                              \
 200     {                                                     \
 201         static const GTypeInfo type_info =                \
 202         {                                                 \
 203           sizeof (class_name##Class),                     \
 204           (GBaseInitFunc) NULL,                           \
 205           (GBaseFinalizeFunc) NULL,                       \
 206           (GClassInitFunc) prefix##_class_init,           \
 207           (GClassFinalizeFunc) NULL,                      \
 208           NULL,                                           \
 209           sizeof (class_name),                            \
 210           0, /* n_preallocs */                            \
 211           (GInstanceInitFunc) prefix##_instance_init,     \
 212         };                                                \
 213                                                           \
 214         type = g_type_register_static (parent_type,       \
 215                                        #class_name,       \
 216                                        &type_info, 0);
 217
 218 /**
 219  * ANJUTA_TYPE_END
 220  *
 221  * Ends a declaration that began with ANJUTA_TYPE_BEGIN
 222  */
 223 #define ANJUTA_TYPE_END                                   \
 224      }                                                    \
 225   return type;                                            \
 226 }
 227
 228 /**
 229  * ANJUTA_TYPE_ADD_INTERFACE:
 230  * @prefix: Prefix for the interface methods
 231  * @interface_type: Type of the interface to implement
 232  *
 233  * Adds an interface to a declaration started with ANJUTA_TYPE_BEGIN
 234  */
 235 #define ANJUTA_TYPE_ADD_INTERFACE(prefix,interface_type)  \
 236     {                                                     \
 237         GInterfaceInfo iface_info = {                     \
 238             (GInterfaceInitFunc)prefix##_iface_init,      \
 239             NULL,                                         \
 240             NULL                                          \
 241         };                                                \
 242         g_type_add_interface_static (type,                \
 243                                      interface_type,      \
 244                                      &iface_info);        \
 245     }
 246
 247 /**
 248  * ANJUTA_TYPE_BOILERPLATE:
 249  * @class_name: Name of the object
 250  * @prefix: Prefix for the class methods
 251  * @parent_type: Parent type for object
 252  *
 253  * Simpliefied version of ANJUTA_TYPE_BEGIN that just creates an Object
 254  * without interfaces and doesn't need ANJUTA_TYPE_END
 255  */
 256 #define ANJUTA_TYPE_BOILERPLATE(class_name, prefix, parent_type) \
 257 ANJUTA_TYPE_BEGIN(class_name, prefix, parent_type);              \
 258 ANJUTA_TYPE_END
 259
 260 G_END_DECLS
 261
 262 #endif