src/document.h

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