src/document.h

   1 /*
   2  *      document.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2011 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License
  18  *      along with this program; if not, write to the Free Software
  19  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  *  @file document.h
  24  *  Document related actions: new, save, open, etc.
  25  **/
  26 /* Also Scintilla search actions - but these should probably be moved to search.c. */
  27
  28
  29 #ifndef GEANY_DOCUMENT_H
  30 #define GEANY_DOCUMENT_H 1
  31
  32 #include "Scintilla.h"
  33 #include "ScintillaWidget.h"
  34 #include "editor.h"
  35
  36 #if defined(G_OS_WIN32)
  37 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CRLF
  38 #elif defined(G_OS_UNIX)
  39 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_LF
  40 #else
  41 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CR
  42 #endif
  43
  44
  45 /** File Prefs. */
  46 typedef struct GeanyFilePrefs
  47 {
  48         gint                    default_new_encoding;
  49         gint                    default_open_encoding;
  50         gboolean                final_new_line;
  51         gboolean                strip_trailing_spaces;
  52         gboolean                replace_tabs;
  53         gboolean                tab_order_ltr;
  54         gboolean                tab_order_beside;
  55         gboolean                show_tab_cross;
  56         guint                   mru_length;
  57         gint                    default_eol_character;
  58         gint                    disk_check_timeout;
  59         gboolean                cmdline_new_files;      /* New file if command-line filename doesn't exist */
  60         gboolean                use_safe_file_saving;
  61         gboolean                ensure_convert_new_lines;
  62         gboolean                gio_unsafe_save_backup;
  63         gboolean                use_gio_unsafe_file_saving; /* whether to use GIO as the unsafe backend */
  64         gchar                   *extract_filetype_regex;        /* regex to extract filetype on opening */
  65 }
  66 GeanyFilePrefs;
  67
  68 extern GeanyFilePrefs file_prefs;
  69
  70
  71 /**
  72  *  Structure for representing an open tab with all its properties.
  73  **/
  74 struct GeanyDocument
  75 {
  76         /** General flag to represent this document is active and all properties are set correctly. */
  77         gboolean                 is_valid;
  78         gint                     index;         /**< Index in the documents array. */
  79         /** Whether this document supports source code symbols(tags) to show in the sidebar. */
  80         gboolean                 has_tags;
  81         /** The UTF-8 encoded file name.
  82          * Be careful; glibc and GLib file functions expect the locale representation of the
  83          * file name which can be different from this.
  84          * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
  85          * @see real_path. */
  86         gchar                   *file_name;
  87         /** The encoding of the document, must be a valid string representation of an encoding, can
  88          *  be retrieved with @ref encodings_get_charset_from_index. */
  89         gchar                   *encoding;
  90         /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */
  91         gboolean                 has_bom;
  92         struct GeanyEditor *editor;     /**< The editor associated with the document. */
  93         /** The filetype for this document, it's only a reference to one of the elements of the global
  94          *  filetypes array. */
  95         GeanyFiletype   *file_type;
  96         /** TMWorkObject object for this document, or @c NULL. */
  97         TMWorkObject    *tm_file;
  98         /** Whether this document is read-only. */
  99         gboolean                 readonly;
 100         /** Whether this document has been changed since it was last saved. */
 101         gboolean                 changed;
 102         /** The link-dereferenced, locale-encoded file name.
 103          * If non-NULL, this indicates the file once existed on disk (not just as an
 104          * unsaved document with a filename set).
 105          *
 106          * @note This is only assigned after a successful save or open - it should
 107          * not be set elsewhere.
 108          * @see file_name. */
 109         gchar                   *real_path;
 110
 111         struct GeanyDocumentPrivate *priv;      /* should be last, append fields before this item */
 112 };
 113
 114 extern GPtrArray *documents_array;
 115
 116
 117 /** Wraps documents_array so it can be used with C array syntax.
 118  * Example: documents[0]->sci = NULL;
 119  * @see document_index(). */
 120 #define documents ((GeanyDocument **)GEANY(documents_array)->pdata)
 121
 122 /** @deprecated Use @ref foreach_document() instead.
 123  * Iterates all valid documents.
 124  * Use like a @c for statement.
 125  * @param i @c guint index for document_index(). */
 126 #ifndef GEANY_DISABLE_DEPRECATED
 127 #define documents_foreach(i) foreach_document(i)
 128 #endif
 129
 130 /** Iterates all valid documents.
 131  * Use like a @c for statement.
 132  * @param i @c guint index for document_index(). */
 133 #define foreach_document(i) \
 134         for (i = 0; i < GEANY(documents_array)->len; i++)\
 135                 if (!documents[i]->is_valid)\
 136                         {}\
 137                 else /* prevent outside 'else' matching our macro 'if' */
 138
 139 /** @c NULL-safe way to check @c doc_ptr->is_valid.
 140  * This is useful when @a doc_ptr was stored some time earlier and documents may have been
 141  * closed since then.
 142  * @note This should not be used to check the result of the main API functions,
 143  * these only need a NULL-pointer check - @c document_get_current() != @c NULL. */
 144 #define DOC_VALID(doc_ptr) \
 145         (G_LIKELY((doc_ptr) != NULL && (doc_ptr)->is_valid))
 146
 147 /**
 148  *  Returns the filename of the document passed or @c GEANY_STRING_UNTITLED
 149  *  (e.g. _("untitled")) if the document's filename was not yet set.
 150  *  This macro never returns @c NULL.
 151  **/
 152 #define DOC_FILENAME(doc) \
 153         (G_LIKELY((doc)->file_name != NULL) ? ((doc)->file_name) : GEANY_STRING_UNTITLED)
 154
 155
 156
 157 /* These functions will replace the older functions. For now they have a documents_ prefix. */
 158
 159 GeanyDocument* document_new_file(const gchar *filename, GeanyFiletype *ft, const gchar *text);
 160
 161 GeanyDocument* document_new_file_if_non_open(void);
 162
 163 GeanyDocument* document_find_by_filename(const gchar *utf8_filename);
 164
 165 GeanyDocument* document_find_by_real_path(const gchar *realname);
 166
 167 gboolean document_save_file(GeanyDocument *doc, gboolean force);
 168
 169 gboolean document_save_file_as(GeanyDocument *doc, const gchar *utf8_fname);
 170
 171 GeanyDocument* document_open_file(const gchar *locale_filename, gboolean readonly,
 172                 GeanyFiletype *ft, const gchar *forced_enc);
 173
 174 gboolean document_reload_file(GeanyDocument *doc, const gchar *forced_enc);
 175
 176 void document_set_text_changed(GeanyDocument *doc, gboolean changed);
 177
 178 void document_set_filetype(GeanyDocument *doc, GeanyFiletype *type);
 179
 180 void document_reload_config(GeanyDocument *doc);
 181
 182 void document_rename_file(GeanyDocument *doc, const gchar *new_filename);
 183
 184 GeanyDocument *document_index(gint idx);
 185
 186 GeanyDocument *document_find_by_sci(ScintillaObject *sci);
 187
 188 gint document_get_notebook_page(GeanyDocument *doc);
 189
 190 GeanyDocument* document_get_from_page(guint page_num);
 191
 192 GeanyDocument *document_get_current(void);
 193
 194 void document_show_tab(GeanyDocument *doc);
 195
 196 void document_init_doclist(void);
 197
 198 void document_finalize(void);
 199
 200 gboolean document_remove_page(guint page_num);
 201
 202 void document_try_focus(GeanyDocument *doc, GtkWidget *source_widget);
 203
 204 gboolean document_close(GeanyDocument *doc);
 205
 206 gboolean document_account_for_unsaved(void);
 207
 208 gboolean document_close_all(void);
 209
 210 GeanyDocument *document_clone(GeanyDocument *old_doc, const gchar *utf8_filename);
 211
 212 GeanyDocument *document_open_file_full(GeanyDocument *doc, const gchar *filename, gint pos,
 213                 gboolean readonly, GeanyFiletype *ft, const gchar *forced_enc);
 214
 215 void document_open_file_list(const gchar *data, gsize length);
 216
 217 void document_open_files(const GSList *filenames, gboolean readonly, GeanyFiletype *ft,
 218                 const gchar *forced_enc);
 219
 220 gboolean document_search_bar_find(GeanyDocument *doc, const gchar *text, gint flags, gboolean inc,
 221                 gboolean backwards);
 222
 223 gint document_find_text(GeanyDocument *doc, const gchar *text, const gchar *original_text,
 224                 gint flags, gboolean search_backwards, gboolean scroll, GtkWidget *parent);
 225
 226 gint document_replace_text(GeanyDocument *doc, const gchar *find_text, const gchar *original_find_text,
 227                 const gchar *replace_text, gint flags, gboolean search_backwards);
 228
 229 gint document_replace_all(GeanyDocument *doc, const gchar *find_text, const gchar *replace_text,
 230                 const gchar *original_find_text, const gchar *original_replace_text, gint flags);
 231
 232 void document_replace_sel(GeanyDocument *doc, const gchar *find_text, const gchar *replace_text,
 233                                                   const gchar *original_find_text, const gchar *original_replace_text, gint flags);
 234
 235 void document_update_tag_list(GeanyDocument *doc, gboolean update);
 236
 237 void document_update_tag_list_in_idle(GeanyDocument *doc);
 238
 239 void document_update_type_keywords(GeanyDocument *doc);
 240
 241 void document_set_encoding(GeanyDocument *doc, const gchar *new_encoding);
 242
 243 gboolean document_check_disk_status(GeanyDocument *doc, gboolean force);
 244
 245 /* own Undo / Redo implementation to be able to undo / redo changes
 246  * to the encoding or the Unicode BOM (which are Scintilla independent).
 247  * All Scintilla events are stored in the undo / redo buffer and are passed through. */
 248
 249 gboolean document_can_undo(GeanyDocument *doc);
 250
 251 gboolean document_can_redo(GeanyDocument *doc);
 252
 253 void document_undo(GeanyDocument *doc);
 254
 255 void document_redo(GeanyDocument *doc);
 256
 257 void document_undo_add(GeanyDocument *doc, guint type, gpointer data);
 258
 259 void document_update_tab_label(GeanyDocument *doc);
 260
 261 const GdkColor *document_get_status_color(GeanyDocument *doc);
 262
 263 gchar *document_get_basename_for_display(GeanyDocument *doc, gint length);
 264
 265 gboolean document_need_save_as(GeanyDocument *doc);
 266
 267 gboolean document_detect_indent_type(GeanyDocument *doc, GeanyIndentType *type_);
 268
 269 gboolean document_detect_indent_width(GeanyDocument *doc, gint *width_);
 270
 271 void document_apply_indent_settings(GeanyDocument *doc);
 272
 273 gint document_compare_by_display_name(gconstpointer a, gconstpointer b);
 274
 275 gint document_compare_by_tab_order(gconstpointer a, gconstpointer b);
 276
 277 gint document_compare_by_tab_order_reverse(gconstpointer a, gconstpointer b);
 278
 279 void document_grab_focus(GeanyDocument *doc);
 280
 281 #endif