2 * document.h - this file is part of Geany, a fast and lightweight IDE
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>
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.
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.
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.
24 * Document related actions: new, save, open, etc.
26 /* Also Scintilla search actions - but these should probably be moved to search.c. */
29 #ifndef GEANY_DOCUMENT_H
30 #define GEANY_DOCUMENT_H 1
34 #include "Scintilla.h"
35 #include "ScintillaWidget.h"
39 #if defined(G_OS_WIN32)
40 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CRLF
41 #elif defined(G_OS_UNIX)
42 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_LF
44 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CR
49 typedef struct GeanyFilePrefs
51 gint default_new_encoding
;
52 gint default_open_encoding
;
53 gboolean final_new_line
;
54 gboolean strip_trailing_spaces
;
55 gboolean replace_tabs
;
56 gboolean tab_order_ltr
;
57 gboolean tab_order_beside
;
58 gboolean show_tab_cross
;
60 gint default_eol_character
;
61 gint disk_check_timeout
;
62 gboolean cmdline_new_files
; /* New file if command-line filename doesn't exist */
63 gboolean use_safe_file_saving
;
64 gboolean ensure_convert_new_lines
;
65 gboolean gio_unsafe_save_backup
;
66 gboolean use_gio_unsafe_file_saving
; /* whether to use GIO as the unsafe backend */
67 gchar
*extract_filetype_regex
; /* regex to extract filetype on opening */
68 gboolean tab_close_switch_to_mru
;
72 extern GeanyFilePrefs file_prefs
;
76 * Structure for representing an open tab with all its properties.
80 /** General flag to represent this document is active and all properties are set correctly. */
82 gint index
; /**< Index in the documents array. */
83 /** Whether this document supports source code symbols(tags) to show in the sidebar. */
85 /** The UTF-8 encoded file name.
86 * Be careful; glibc and GLib file functions expect the locale representation of the
87 * file name which can be different from this.
88 * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
91 /** The encoding of the document, must be a valid string representation of an encoding, can
92 * be retrieved with @ref encodings_get_charset_from_index. */
94 /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */
96 struct GeanyEditor
*editor
; /**< The editor associated with the document. */
97 /** The filetype for this document, it's only a reference to one of the elements of the global
99 GeanyFiletype
*file_type
;
100 /** TMWorkObject object for this document, or @c NULL. */
101 TMWorkObject
*tm_file
;
102 /** Whether this document is read-only. */
104 /** Whether this document has been changed since it was last saved. */
106 /** The link-dereferenced, locale-encoded file name.
107 * If non-NULL, this indicates the file once existed on disk (not just as an
108 * unsaved document with a filename set).
110 * @note This is only assigned after a successful save or open - it should
111 * not be set elsewhere.
115 struct GeanyDocumentPrivate
*priv
; /* should be last, append fields before this item */
118 extern GPtrArray
*documents_array
;
121 /** Wraps documents_array so it can be used with C array syntax.
122 * Example: documents[0]->sci = NULL;
123 * @see document_index(). */
124 #define documents ((GeanyDocument **)GEANY(documents_array)->pdata)
126 /** @deprecated Use @ref foreach_document() instead.
127 * Iterates all valid documents.
128 * Use like a @c for statement.
129 * @param i @c guint index for document_index(). */
130 #ifndef GEANY_DISABLE_DEPRECATED
131 #define documents_foreach(i) foreach_document(i)
134 /** Iterates all valid documents.
135 * Use like a @c for statement.
136 * @param i @c guint index for document_index(). */
137 #define foreach_document(i) \
138 for (i = 0; i < GEANY(documents_array)->len; i++)\
139 if (!documents[i]->is_valid)\
141 else /* prevent outside 'else' matching our macro 'if' */
143 /** @c NULL-safe way to check @c doc_ptr->is_valid.
144 * This is useful when @a doc_ptr was stored some time earlier and documents may have been
146 * @note This should not be used to check the result of the main API functions,
147 * these only need a NULL-pointer check - @c document_get_current() != @c NULL. */
148 #define DOC_VALID(doc_ptr) \
149 (G_LIKELY((doc_ptr) != NULL && (doc_ptr)->is_valid))
152 * Returns the filename of the document passed or @c GEANY_STRING_UNTITLED
153 * (e.g. _("untitled")) if the document's filename was not yet set.
154 * This macro never returns @c NULL.
156 #define DOC_FILENAME(doc) \
157 (G_LIKELY((doc)->file_name != NULL) ? ((doc)->file_name) : GEANY_STRING_UNTITLED)
161 /* These functions will replace the older functions. For now they have a documents_ prefix. */
163 GeanyDocument
* document_new_file(const gchar
*filename
, GeanyFiletype
*ft
, const gchar
*text
);
165 GeanyDocument
* document_new_file_if_non_open(void);
167 GeanyDocument
* document_find_by_filename(const gchar
*utf8_filename
);
169 GeanyDocument
* document_find_by_real_path(const gchar
*realname
);
171 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
);
173 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
);
175 GeanyDocument
* document_open_file(const gchar
*locale_filename
, gboolean readonly
,
176 GeanyFiletype
*ft
, const gchar
*forced_enc
);
178 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
);
180 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
);
182 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
);
184 void document_reload_config(GeanyDocument
*doc
);
186 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
);
188 GeanyDocument
*document_index(gint idx
);
190 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
);
192 gint
document_get_notebook_page(GeanyDocument
*doc
);
194 GeanyDocument
* document_get_from_page(guint page_num
);
196 GeanyDocument
*document_get_current(void);
198 void document_show_tab(GeanyDocument
*doc
);
200 void document_init_doclist(void);
202 void document_finalize(void);
204 gboolean
document_remove_page(guint page_num
);
206 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
);
208 gboolean
document_close(GeanyDocument
*doc
);
210 gboolean
document_account_for_unsaved(void);
212 gboolean
document_close_all(void);
214 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
215 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
);
217 void document_open_file_list(const gchar
*data
, gsize length
);
219 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
220 const gchar
*forced_enc
);
222 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
225 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
226 gint flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
227 gboolean scroll
, GtkWidget
*parent
);
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
);
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
);
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
);
238 void document_update_tags(GeanyDocument
*doc
);
240 void document_update_tag_list_in_idle(GeanyDocument
*doc
);
242 void document_highlight_tags(GeanyDocument
*doc
);
244 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
);
246 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
);
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. */
252 gboolean
document_can_undo(GeanyDocument
*doc
);
254 gboolean
document_can_redo(GeanyDocument
*doc
);
256 void document_undo(GeanyDocument
*doc
);
258 void document_redo(GeanyDocument
*doc
);
260 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
262 void document_update_tab_label(GeanyDocument
*doc
);
264 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
);
266 const GdkColor
*document_get_status_color(GeanyDocument
*doc
);
268 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
);
270 gboolean
document_need_save_as(GeanyDocument
*doc
);
272 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
);
274 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
);
276 void document_apply_indent_settings(GeanyDocument
*doc
);
278 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
);
280 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
);
282 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
);
284 void document_grab_focus(GeanyDocument
*doc
);
286 GeanyDocument
*document_clone(GeanyDocument
*old_doc
);