src/document.h

   1 /*
   2  *      document.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005 The Geany contributors
   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 along
  17  *      with this program; if not, write to the Free Software Foundation, Inc.,
  18  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 /**
  22  *  @file document.h
  23  *  Document related actions: new, save, open, etc.
  24  **/
  25 /* Also Scintilla search actions - but these should probably be moved to search.c. */
  26
  27
  28 #ifndef GEANY_DOCUMENT_H
  29 #define GEANY_DOCUMENT_H 1
  30
  31 #include "editor.h"
  32 #include "filetypes.h"
  33 #include "geany.h"
  34 #include "search.h"
  35
  36 #include "gtkcompat.h" /* Needed by ScintillaWidget.h */
  37 #include "Scintilla.h" /* Needed by ScintillaWidget.h */
  38 #include "ScintillaWidget.h" /* For ScintillaObject */
  39
  40 #include <glib.h>
  41
  42
  43 G_BEGIN_DECLS
  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         gboolean                tab_close_switch_to_mru;
  66         gboolean                keep_edit_history_on_reload; /* Keep undo stack upon, and allow undoing of, document reloading. */
  67         gboolean                show_keep_edit_history_on_reload_msg; /* whether to show the message introducing the above feature */
  68         gboolean                reload_clean_doc_on_file_change;
  69 }
  70 GeanyFilePrefs;
  71
  72
  73 #define GEANY_TYPE_DOCUMENT (document_get_type())
  74 GType document_get_type (void);
  75
  76 /**
  77  *  Structure for representing an open tab with all its properties.
  78  **/
  79 typedef struct GeanyDocument
  80 {
  81         /** Flag used to check if this document is valid when iterating @ref GeanyData::documents_array. */
  82         gboolean                 is_valid;
  83         gint                     index;         /**< Index in the documents array. */
  84         /** Whether this document supports source code symbols(tags) to show in the sidebar. */
  85         gboolean                 has_tags;
  86         /** The UTF-8 encoded file name.
  87          * Be careful; glibc and GLib file functions expect the locale representation of the
  88          * file name which can be different from this.
  89          * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
  90          * @see real_path. */
  91         gchar                   *file_name;
  92         /** The encoding of the document, must be a valid string representation of an encoding, can
  93          *  be retrieved with @ref encodings_get_charset_from_index. */
  94         gchar                   *encoding;
  95         /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */
  96         gboolean                 has_bom;
  97         GeanyEditor *editor;    /**< The editor associated with the document. */
  98         /** The filetype for this document, it's only a reference to one of the elements of the global
  99          *  filetypes array. */
 100         GeanyFiletype   *file_type;
 101         /** TMSourceFile object for this document, or @c NULL. */
 102         TMSourceFile    *tm_file;
 103         /** Whether this document is read-only. */
 104         gboolean                 readonly;
 105         /** Whether this document has been changed since it was last saved. */
 106         gboolean                 changed;
 107         /** The link-dereferenced, locale-encoded file name.
 108          * If non-NULL, this indicates the file once existed on disk (not just as an
 109          * unsaved document with a filename set).
 110          *
 111          * @note This is only assigned after a successful save or open - it should
 112          * not be set elsewhere.
 113          * @see file_name. */
 114         gchar                   *real_path;
 115         /** A pseudo-unique ID for this document.
 116          * @c 0 is reserved as an unused value.
 117          * @see document_find_by_id(). */
 118         guint                    id;
 119
 120         struct GeanyDocumentPrivate *priv;      /* should be last, append fields before this item */
 121 }
 122 GeanyDocument;
 123
 124 /** Wraps @ref GeanyData::documents_array so it can be used with C array syntax.
 125  * @warning Always check the returned document is valid (@c doc->is_valid).
 126  *
 127  * Example: @code GeanyDocument *doc = documents[i]; @endcode
 128  * @see documents_array(). */
 129 #define documents ((GeanyDocument **)GEANY(documents_array)->pdata)
 130
 131 /** @deprecated Use @ref foreach_document() instead.
 132  * Iterates all valid documents.
 133  * Use like a @c for statement.
 134  * @param i @c guint index for document_index(). */
 135 #ifndef GEANY_DISABLE_DEPRECATED
 136 #define documents_foreach(i) foreach_document(i)
 137 #endif
 138
 139 /** Iterates all valid document indexes.
 140  * Use like a @c for statement.
 141  * @param i @c guint index for @ref GeanyData::documents_array.
 142  *
 143  * Example:
 144  * @code
 145  * guint i;
 146  * foreach_document(i)
 147  * {
 148  *      GeanyDocument *doc = documents[i];
 149  *      g_assert(doc->is_valid);
 150  * }
 151  * @endcode */
 152 #define foreach_document(i) \
 153         for (i = 0; i < GEANY(documents_array)->len; i++)\
 154                 if (!documents[i]->is_valid)\
 155                         {}\
 156                 else /* prevent outside 'else' matching our macro 'if' */
 157
 158 /** Null-safe way to check @ref GeanyDocument::is_valid.
 159  * @note This should not be used to check the result of the main API functions,
 160  * these only need a NULL-pointer check - @c document_get_current() != @c NULL. */
 161 #define DOC_VALID(doc_ptr) \
 162         ((doc_ptr) != NULL && (doc_ptr)->is_valid)
 163
 164 /**
 165  *  Returns the filename of the document passed or @c GEANY_STRING_UNTITLED
 166  *  (e.g. _("untitled")) if the document's filename was not yet set.
 167  *  This macro never returns @c NULL.
 168  **/
 169 #define DOC_FILENAME(doc) \
 170         (G_LIKELY((doc)->file_name != NULL) ? ((doc)->file_name) : GEANY_STRING_UNTITLED)
 171
 172
 173 GeanyDocument* document_new_file(const gchar *filename, GeanyFiletype *ft, const gchar *text);
 174
 175 GeanyDocument *document_get_current(void);
 176
 177 GeanyDocument *document_get_from_notebook_child(GtkWidget *page);
 178
 179 GeanyDocument* document_get_from_page(guint page_num);
 180
 181 GeanyDocument* document_find_by_filename(const gchar *utf8_filename);
 182
 183 GeanyDocument* document_find_by_real_path(const gchar *realname);
 184
 185 gboolean document_save_file(GeanyDocument *doc, gboolean force);
 186
 187 GeanyDocument* document_open_file(const gchar *locale_filename, gboolean readonly,
 188                 GeanyFiletype *ft, const gchar *forced_enc);
 189
 190 void document_open_files(const GSList *filenames, gboolean readonly, GeanyFiletype *ft,
 191                 const gchar *forced_enc);
 192
 193 gboolean document_remove_page(guint page_num);
 194
 195 gboolean document_reload_force(GeanyDocument *doc, const gchar *forced_enc);
 196
 197 void document_set_encoding(GeanyDocument *doc, const gchar *new_encoding);
 198
 199 void document_set_text_changed(GeanyDocument *doc, gboolean changed);
 200
 201 void document_set_filetype(GeanyDocument *doc, GeanyFiletype *type);
 202
 203 gboolean document_close(GeanyDocument *doc);
 204
 205 GeanyDocument *document_index(gint idx);
 206
 207 gboolean document_save_file_as(GeanyDocument *doc, const gchar *utf8_fname);
 208
 209 void document_rename_file(GeanyDocument *doc, const gchar *new_filename);
 210
 211 const GdkColor *document_get_status_color(GeanyDocument *doc);
 212
 213 gchar *document_get_basename_for_display(GeanyDocument *doc, gint length);
 214
 215 gint document_get_notebook_page(GeanyDocument *doc);
 216
 217 gint document_compare_by_display_name(gconstpointer a, gconstpointer b);
 218
 219 gint document_compare_by_tab_order(gconstpointer a, gconstpointer b);
 220
 221 gint document_compare_by_tab_order_reverse(gconstpointer a, gconstpointer b);
 222
 223 GeanyDocument *document_find_by_id(guint id);
 224
 225
 226 #ifdef GEANY_PRIVATE
 227
 228 #if defined(G_OS_WIN32)
 229 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CRLF
 230 #else
 231 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_LF
 232 #endif
 233
 234 extern GeanyFilePrefs file_prefs;
 235 extern GPtrArray *documents_array;
 236
 237
 238 /* These functions will replace the older functions. For now they have a documents_ prefix. */
 239
 240 GeanyDocument* document_new_file_if_non_open(void);
 241
 242 gboolean document_reload_prompt(GeanyDocument *doc, const gchar *forced_enc);
 243
 244 void document_reload_config(GeanyDocument *doc);
 245
 246 GeanyDocument *document_find_by_sci(ScintillaObject *sci);
 247
 248 void document_show_tab(GeanyDocument *doc);
 249
 250 void document_init_doclist(void);
 251
 252 void document_finalize(void);
 253
 254 void document_try_focus(GeanyDocument *doc, GtkWidget *source_widget);
 255
 256 gboolean document_account_for_unsaved(void);
 257
 258 gboolean document_close_all(void);
 259
 260 GeanyDocument *document_open_file_full(GeanyDocument *doc, const gchar *filename, gint pos,
 261                 gboolean readonly, GeanyFiletype *ft, const gchar *forced_enc);
 262
 263 void document_open_file_list(const gchar *data, gsize length);
 264
 265 gboolean document_search_bar_find(GeanyDocument *doc, const gchar *text, gboolean inc,
 266                 gboolean backwards);
 267
 268 gint document_find_text(GeanyDocument *doc, const gchar *text, const gchar *original_text,
 269                 GeanyFindFlags flags, gboolean search_backwards, GeanyMatchInfo **match_,
 270                 gboolean scroll, GtkWidget *parent);
 271
 272 gint document_replace_text(GeanyDocument *doc, const gchar *find_text, const gchar *original_find_text,
 273                 const gchar *replace_text, GeanyFindFlags flags, gboolean search_backwards);
 274
 275 gint document_replace_all(GeanyDocument *doc, const gchar *find_text, const gchar *replace_text,
 276                 const gchar *original_find_text, const gchar *original_replace_text, GeanyFindFlags flags);
 277
 278 void document_replace_sel(GeanyDocument *doc, const gchar *find_text, const gchar *replace_text,
 279                                                   const gchar *original_find_text, const gchar *original_replace_text, GeanyFindFlags flags);
 280
 281 void document_update_tags(GeanyDocument *doc);
 282
 283 void document_update_tag_list_in_idle(GeanyDocument *doc);
 284
 285 void document_highlight_tags(GeanyDocument *doc);
 286
 287 gboolean document_check_disk_status(GeanyDocument *doc, gboolean force);
 288
 289 /* own Undo / Redo implementation to be able to undo / redo changes
 290  * to the encoding or the Unicode BOM (which are Scintilla independent).
 291  * All Scintilla events are stored in the undo / redo buffer and are passed through. */
 292
 293 gboolean document_can_undo(GeanyDocument *doc);
 294
 295 gboolean document_can_redo(GeanyDocument *doc);
 296
 297 void document_undo(GeanyDocument *doc);
 298
 299 void document_redo(GeanyDocument *doc);
 300
 301 void document_undo_add(GeanyDocument *doc, guint type, gpointer data);
 302
 303 void document_update_tab_label(GeanyDocument *doc);
 304
 305 const gchar *document_get_status_widget_class(GeanyDocument *doc);
 306
 307 gboolean document_need_save_as(GeanyDocument *doc);
 308
 309 gboolean document_detect_indent_type(GeanyDocument *doc, GeanyIndentType *type_);
 310
 311 gboolean document_detect_indent_width(GeanyDocument *doc, gint *width_);
 312
 313 void document_apply_indent_settings(GeanyDocument *doc);
 314
 315 void document_grab_focus(GeanyDocument *doc);
 316
 317 GeanyDocument *document_clone(GeanyDocument *old_doc);
 318
 319 gpointer document_get_data(const GeanyDocument *doc, const gchar *key);
 320
 321 void document_set_data(GeanyDocument *doc, const gchar *key, gpointer data);
 322
 323 void document_set_data_full(GeanyDocument *doc, const gchar *key,
 324         gpointer data, GDestroyNotify free_func);
 325
 326 #endif /* GEANY_PRIVATE */
 327
 328 G_END_DECLS
 329
 330 #endif /* GEANY_DOCUMENT_H */