2 * document.h - this file is part of Geany, a fast and lightweight IDE
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>
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
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.
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
32 #include "Scintilla.h"
33 #include "ScintillaWidget.h"
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
41 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CR
46 typedef struct GeanyFilePrefs
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
;
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
;
69 extern GeanyFilePrefs file_prefs
;
73 * Structure for representing an open tab with all its properties.
77 /** General flag to represent this document is active and all properties are set correctly. */
79 gint index
; /**< Index in the documents array. */
80 /** Whether this document supports source code symbols(tags) to show in the sidebar. */
82 /** The UTF-8 encoded file name.
83 * Be careful; glibc and GLib file functions expect the locale representation of the
84 * file name which can be different from this.
85 * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
88 /** The encoding of the document, must be a valid string representation of an encoding, can
89 * be retrieved with @ref encodings_get_charset_from_index. */
91 /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */
93 struct GeanyEditor
*editor
; /**< The editor associated with the document. */
94 /** The filetype for this document, it's only a reference to one of the elements of the global
96 GeanyFiletype
*file_type
;
97 /** TMWorkObject object for this document, or @c NULL. */
98 TMWorkObject
*tm_file
;
99 /** Whether this document is read-only. */
101 /** Whether this document has been changed since it was last saved. */
103 /** The link-dereferenced, locale-encoded file name.
104 * If non-NULL, this indicates the file once existed on disk (not just as an
105 * unsaved document with a filename set).
107 * @note This is only assigned after a successful save or open - it should
108 * not be set elsewhere.
112 struct GeanyDocumentPrivate
*priv
; /* should be last, append fields before this item */
115 extern GPtrArray
*documents_array
;
118 /** Wraps documents_array so it can be used with C array syntax.
119 * Example: documents[0]->sci = NULL;
120 * @see document_index(). */
121 #define documents ((GeanyDocument **)GEANY(documents_array)->pdata)
123 /** @deprecated Use @ref foreach_document() instead.
124 * Iterates all valid documents.
125 * Use like a @c for statement.
126 * @param i @c guint index for document_index(). */
127 #ifndef GEANY_DISABLE_DEPRECATED
128 #define documents_foreach(i) foreach_document(i)
131 /** Iterates all valid documents.
132 * Use like a @c for statement.
133 * @param i @c guint index for document_index(). */
134 #define foreach_document(i) \
135 for (i = 0; i < GEANY(documents_array)->len; i++)\
136 if (!documents[i]->is_valid)\
138 else /* prevent outside 'else' matching our macro 'if' */
140 /** @c NULL-safe way to check @c doc_ptr->is_valid.
141 * This is useful when @a doc_ptr was stored some time earlier and documents may have been
143 * @note This should not be used to check the result of the main API functions,
144 * these only need a NULL-pointer check - @c document_get_current() != @c NULL. */
145 #define DOC_VALID(doc_ptr) \
146 (G_LIKELY((doc_ptr) != NULL && (doc_ptr)->is_valid))
149 * Returns the filename of the document passed or @c GEANY_STRING_UNTITLED
150 * (e.g. _("untitled")) if the document's filename was not yet set.
151 * This macro never returns @c NULL.
153 #define DOC_FILENAME(doc) \
154 (G_LIKELY((doc)->file_name != NULL) ? ((doc)->file_name) : GEANY_STRING_UNTITLED)
158 /* These functions will replace the older functions. For now they have a documents_ prefix. */
160 GeanyDocument
* document_new_file(const gchar
*filename
, GeanyFiletype
*ft
, const gchar
*text
);
162 GeanyDocument
* document_new_file_if_non_open(void);
164 GeanyDocument
* document_find_by_filename(const gchar
*utf8_filename
);
166 GeanyDocument
* document_find_by_real_path(const gchar
*realname
);
168 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
);
170 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
);
172 GeanyDocument
* document_open_file(const gchar
*locale_filename
, gboolean readonly
,
173 GeanyFiletype
*ft
, const gchar
*forced_enc
);
175 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
);
177 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
);
179 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
);
181 void document_reload_config(GeanyDocument
*doc
);
183 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
);
185 GeanyDocument
*document_index(gint idx
);
187 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
);
189 gint
document_get_notebook_page(GeanyDocument
*doc
);
191 GeanyDocument
* document_get_from_page(guint page_num
);
193 GeanyDocument
*document_get_current(void);
195 void document_show_tab(GeanyDocument
*doc
);
197 void document_init_doclist(void);
199 void document_finalize(void);
201 gboolean
document_remove_page(guint page_num
);
203 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
);
205 gboolean
document_close(GeanyDocument
*doc
);
207 gboolean
document_account_for_unsaved(void);
209 gboolean
document_close_all(void);
211 GeanyDocument
*document_clone(GeanyDocument
*old_doc
, const gchar
*utf8_filename
);
213 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
214 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
);
216 void document_open_file_list(const gchar
*data
, gsize length
);
218 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
219 const gchar
*forced_enc
);
221 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
224 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
225 gint flags
, gboolean search_backwards
, gboolean scroll
, GtkWidget
*parent
);
227 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
228 const gchar
*replace_text
, gint flags
, gboolean search_backwards
);
230 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
231 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
);
233 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
234 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
);
236 void document_update_tags(GeanyDocument
*doc
);
238 void document_update_tag_list_in_idle(GeanyDocument
*doc
);
240 void document_highlight_tags(GeanyDocument
*doc
);
242 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
);
244 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
);
246 /* own Undo / Redo implementation to be able to undo / redo changes
247 * to the encoding or the Unicode BOM (which are Scintilla independent).
248 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
250 gboolean
document_can_undo(GeanyDocument
*doc
);
252 gboolean
document_can_redo(GeanyDocument
*doc
);
254 void document_undo(GeanyDocument
*doc
);
256 void document_redo(GeanyDocument
*doc
);
258 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
260 void document_update_tab_label(GeanyDocument
*doc
);
262 const GdkColor
*document_get_status_color(GeanyDocument
*doc
);
264 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
);
266 gboolean
document_need_save_as(GeanyDocument
*doc
);
268 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
);
270 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
);
272 void document_apply_indent_settings(GeanyDocument
*doc
);
274 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
);
276 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
);
278 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
);
280 void document_grab_focus(GeanyDocument
*doc
);