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
33 #include "filetypes.h"
37 #include "gtkcompat.h" /* Needed by ScintillaWidget.h */
38 #include "Scintilla.h" /* Needed by ScintillaWidget.h */
39 #include "ScintillaWidget.h" /* For ScintillaObject */
46 #if defined(G_OS_WIN32)
47 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CRLF
48 #elif defined(G_OS_UNIX)
49 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_LF
51 # define GEANY_DEFAULT_EOL_CHARACTER SC_EOL_CR
56 typedef struct GeanyFilePrefs
58 gint default_new_encoding
;
59 gint default_open_encoding
;
60 gboolean final_new_line
;
61 gboolean strip_trailing_spaces
;
62 gboolean replace_tabs
;
63 gboolean tab_order_ltr
;
64 gboolean tab_order_beside
;
65 gboolean show_tab_cross
;
67 gint default_eol_character
;
68 gint disk_check_timeout
;
69 gboolean cmdline_new_files
; /* New file if command-line filename doesn't exist */
70 gboolean use_safe_file_saving
;
71 gboolean ensure_convert_new_lines
;
72 gboolean gio_unsafe_save_backup
;
73 gboolean use_gio_unsafe_file_saving
; /* whether to use GIO as the unsafe backend */
74 gchar
*extract_filetype_regex
; /* regex to extract filetype on opening */
75 gboolean tab_close_switch_to_mru
;
79 extern GeanyFilePrefs file_prefs
;
83 * Structure for representing an open tab with all its properties.
85 typedef struct GeanyDocument
87 /** Flag used to check if this document is valid when iterating @ref documents_array. */
89 gint index
; /**< Index in the documents array. */
90 /** Whether this document supports source code symbols(tags) to show in the sidebar. */
92 /** The UTF-8 encoded file name.
93 * Be careful; glibc and GLib file functions expect the locale representation of the
94 * file name which can be different from this.
95 * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
98 /** The encoding of the document, must be a valid string representation of an encoding, can
99 * be retrieved with @ref encodings_get_charset_from_index. */
101 /** Internally used flag to indicate whether the file of this document has a byte-order-mark. */
103 GeanyEditor
*editor
; /**< The editor associated with the document. */
104 /** The filetype for this document, it's only a reference to one of the elements of the global
105 * filetypes array. */
106 GeanyFiletype
*file_type
;
107 /** TMWorkObject object for this document, or @c NULL. */
108 TMWorkObject
*tm_file
;
109 /** Whether this document is read-only. */
111 /** Whether this document has been changed since it was last saved. */
113 /** The link-dereferenced, locale-encoded file name.
114 * If non-NULL, this indicates the file once existed on disk (not just as an
115 * unsaved document with a filename set).
117 * @note This is only assigned after a successful save or open - it should
118 * not be set elsewhere.
122 struct GeanyDocumentPrivate
*priv
; /* should be last, append fields before this item */
126 extern GPtrArray
*documents_array
;
129 /** Wraps @ref documents_array so it can be used with C array syntax.
130 * @warning Always check the returned document is valid (@c doc->is_valid).
132 * Example: @code GeanyDocument *doc = documents[i]; @endcode
133 * @see documents_array(). */
134 #define documents ((GeanyDocument **)GEANY(documents_array)->pdata)
136 /** @deprecated Use @ref foreach_document() instead.
137 * Iterates all valid documents.
138 * Use like a @c for statement.
139 * @param i @c guint index for document_index(). */
140 #ifndef GEANY_DISABLE_DEPRECATED
141 #define documents_foreach(i) foreach_document(i)
144 /** Iterates all valid document indexes.
145 * Use like a @c for statement.
146 * @param i @c guint index for @ref documents_array.
151 * foreach_document(i)
153 * GeanyDocument *doc = documents[i];
154 * g_assert(doc->is_valid);
157 #define foreach_document(i) \
158 for (i = 0; i < GEANY(documents_array)->len; i++)\
159 if (!documents[i]->is_valid)\
161 else /* prevent outside 'else' matching our macro 'if' */
163 /** Null-safe way to check @ref GeanyDocument::is_valid.
164 * @note This should not be used to check the result of the main API functions,
165 * these only need a NULL-pointer check - @c document_get_current() != @c NULL. */
166 #define DOC_VALID(doc_ptr) \
167 ((doc_ptr) != NULL && (doc_ptr)->is_valid)
170 * Returns the filename of the document passed or @c GEANY_STRING_UNTITLED
171 * (e.g. _("untitled")) if the document's filename was not yet set.
172 * This macro never returns @c NULL.
174 #define DOC_FILENAME(doc) \
175 (G_LIKELY((doc)->file_name != NULL) ? ((doc)->file_name) : GEANY_STRING_UNTITLED)
178 /* These functions will replace the older functions. For now they have a documents_ prefix. */
180 GeanyDocument
* document_new_file(const gchar
*filename
, GeanyFiletype
*ft
, const gchar
*text
);
182 GeanyDocument
* document_new_file_if_non_open(void);
184 GeanyDocument
* document_find_by_filename(const gchar
*utf8_filename
);
186 GeanyDocument
* document_find_by_real_path(const gchar
*realname
);
188 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
);
190 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
);
192 GeanyDocument
* document_open_file(const gchar
*locale_filename
, gboolean readonly
,
193 GeanyFiletype
*ft
, const gchar
*forced_enc
);
195 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
);
197 gboolean
document_reload_prompt(GeanyDocument
*doc
, const gchar
*forced_enc
);
199 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
);
201 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
);
203 void document_reload_config(GeanyDocument
*doc
);
205 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
);
207 GeanyDocument
*document_index(gint idx
);
209 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
);
211 gint
document_get_notebook_page(GeanyDocument
*doc
);
213 GeanyDocument
* document_get_from_page(guint page_num
);
215 GeanyDocument
*document_get_current(void);
217 void document_show_tab(GeanyDocument
*doc
);
219 void document_init_doclist(void);
221 void document_finalize(void);
223 gboolean
document_remove_page(guint page_num
);
225 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
);
227 gboolean
document_close(GeanyDocument
*doc
);
229 gboolean
document_account_for_unsaved(void);
231 gboolean
document_close_all(void);
233 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
234 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
);
236 void document_open_file_list(const gchar
*data
, gsize length
);
238 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
239 const gchar
*forced_enc
);
241 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
244 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
245 gint flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
246 gboolean scroll
, GtkWidget
*parent
);
248 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
249 const gchar
*replace_text
, gint flags
, gboolean search_backwards
);
251 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
252 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
);
254 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
255 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
);
257 void document_update_tags(GeanyDocument
*doc
);
259 void document_update_tag_list_in_idle(GeanyDocument
*doc
);
261 void document_highlight_tags(GeanyDocument
*doc
);
263 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
);
265 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
);
267 /* own Undo / Redo implementation to be able to undo / redo changes
268 * to the encoding or the Unicode BOM (which are Scintilla independent).
269 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
271 gboolean
document_can_undo(GeanyDocument
*doc
);
273 gboolean
document_can_redo(GeanyDocument
*doc
);
275 void document_undo(GeanyDocument
*doc
);
277 void document_redo(GeanyDocument
*doc
);
279 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
281 void document_update_tab_label(GeanyDocument
*doc
);
283 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
);
285 const GdkColor
*document_get_status_color(GeanyDocument
*doc
);
287 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
);
289 gboolean
document_need_save_as(GeanyDocument
*doc
);
291 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
);
293 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
);
295 void document_apply_indent_settings(GeanyDocument
*doc
);
297 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
);
299 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
);
301 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
);
303 void document_grab_focus(GeanyDocument
*doc
);
305 GeanyDocument
*document_clone(GeanyDocument
*old_doc
);
309 #endif /* GEANY_DOCUMENT_H */