2 * document.c - 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.
23 * Document related actions: new, save, open, etc.
24 * Also Scintilla search actions.
34 #include "callbacks.h" /* for ignore_callback */
36 #include "documentprivate.h"
37 #include "encodings.h"
38 #include "encodingsprivate.h"
39 #include "filetypesprivate.h"
40 #include "geany.h" /* FIXME: why is this needed for DOC_FILENAME()? should come from documentprivate.h/document.h */
41 #include "geanyobject.h"
42 #include "geanywraplabel.h"
43 #include "highlighting.h"
45 #include "msgwindow.h"
49 #include "sciwrappers.h"
58 #include "gtkcompat.h"
60 #ifdef HAVE_SYS_TIME_H
61 # include <sys/time.h>
69 #ifdef HAVE_SYS_TYPES_H
70 # include <sys/types.h>
75 /* gstdio.h also includes sys/stat.h */
76 #include <glib/gstdio.h>
78 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
79 /*#define USE_GIO_FILEMON 1*/
82 #include <gdk/gdkkeysyms.h>
85 #define USE_GIO_FILE_OPERATIONS (!file_prefs.use_safe_file_saving && file_prefs.use_gio_unsafe_file_saving)
88 GeanyFilePrefs file_prefs
;
89 GPtrArray
*documents_array
= NULL
;
92 /* an undo action, also used for redo actions */
95 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
96 guint type
; /* to identify the action */
97 gpointer
*data
; /* the old value (before the change), in case of a redo action
98 * it contains the new value */
101 /* Custom document info bar response IDs */
104 RESPONSE_DOCUMENT_RELOAD
= 1,
105 RESPONSE_DOCUMENT_SAVE
,
109 static guint doc_id_counter
= 0;
112 static void document_undo_clear_stack(GTrashStack
**stack
);
113 static void document_undo_clear(GeanyDocument
*doc
);
114 static void document_undo_add_internal(GeanyDocument
*doc
, guint type
, gpointer data
);
115 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
116 static gboolean
remove_page(guint page_num
);
117 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
118 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
119 const gchar
*btn_1
, GtkResponseType response_1
,
120 const gchar
*btn_2
, GtkResponseType response_2
,
121 const gchar
*btn_3
, GtkResponseType response_3
,
122 const gchar
*extra_text
, const gchar
*format
, ...) G_GNUC_PRINTF(11, 12);
126 * Finds a document whose @c real_path field matches the given filename.
128 * @param realname The filename to search, which should be identical to the
129 * string returned by @c tm_get_real_path().
131 * @return @transfer{none} @nullable The matching document, or @c NULL.
132 * @note This is only really useful when passing a @c TMSourceFile::file_name.
133 * @see GeanyDocument::real_path.
134 * @see document_find_by_filename().
139 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
144 return NULL
; /* file doesn't exist on disk */
146 for (i
= 0; i
< documents_array
->len
; i
++)
148 GeanyDocument
*doc
= documents
[i
];
150 if (! doc
->is_valid
|| ! doc
->real_path
)
153 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
162 /* dereference symlinks, /../ junk in path and return locale encoding */
163 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
165 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
166 gchar
*realname
= tm_get_real_path(locale_name
);
174 * Finds a document with the given filename.
175 * This matches either an exact GeanyDocument::file_name string, or variant
176 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
179 * @param utf8_filename The filename to search (in UTF-8 encoding).
181 * @return @transfer{none} @nullable The matching document, or @c NULL.
182 * @see document_find_by_real_path().
185 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
191 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
193 /* First search GeanyDocument::file_name, so we can find documents with a
194 * filename set but not saved on disk, like vcdiff produces */
195 for (i
= 0; i
< documents_array
->len
; i
++)
199 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
202 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
207 /* Now try matching based on the realpath(), which is unique per file on disk */
208 realname
= get_real_path_from_utf8(utf8_filename
);
209 doc
= document_find_by_real_path(realname
);
215 /* returns the document which has sci, or NULL. */
216 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
220 g_return_val_if_fail(sci
!= NULL
, NULL
);
222 for (i
= 0; i
< documents_array
->len
; i
++)
224 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
231 /** Lookup an old document by its ID.
232 * Useful when the corresponding document may have been closed since the
234 * @param id The ID of the document to find
235 * @return @transfer{none} @c NULL if the document is no longer open.
240 * GeanyDocument *doc = ...;
241 * id = doc->id; // store ID
243 * // time passes - the document may have been closed by now
244 * GeanyDocument *doc = document_find_by_id(id);
245 * gboolean still_open = (doc != NULL);
249 GeanyDocument
*document_find_by_id(guint id
)
258 if (documents
[i
]->id
== id
)
265 /* gets the widget the main_widgets.notebook consider is its child for this document */
266 static GtkWidget
*document_get_notebook_child(GeanyDocument
*doc
)
271 g_return_val_if_fail(doc
!= NULL
, NULL
);
273 child
= GTK_WIDGET(doc
->editor
->sci
);
274 parent
= gtk_widget_get_parent(child
);
275 /* search for the direct notebook child, mirroring document_get_from_page() */
276 while (parent
&& ! GTK_IS_NOTEBOOK(parent
))
279 parent
= gtk_widget_get_parent(child
);
286 /** Gets the notebook page index for a document.
287 * @param doc The document.
291 gint
document_get_notebook_page(GeanyDocument
*doc
)
293 GtkWidget
*child
= document_get_notebook_child(doc
);
295 return gtk_notebook_page_num(GTK_NOTEBOOK(main_widgets
.notebook
), child
);
300 * Recursively searches a containers children until it finds a
301 * Scintilla widget, or NULL if one was not found.
303 static ScintillaObject
*locate_sci_in_container(GtkWidget
*container
)
305 ScintillaObject
*sci
= NULL
;
306 GList
*children
, *iter
;
308 g_return_val_if_fail(GTK_IS_CONTAINER(container
), NULL
);
310 children
= gtk_container_get_children(GTK_CONTAINER(container
));
311 for (iter
= children
; iter
!= NULL
; iter
= g_list_next(iter
))
313 if (IS_SCINTILLA(iter
->data
))
315 sci
= SCINTILLA(iter
->data
);
318 else if (GTK_IS_CONTAINER(iter
->data
))
320 sci
= locate_sci_in_container(iter
->data
);
321 if (IS_SCINTILLA(sci
))
326 g_list_free(children
);
332 /* Finds the document for the given notebook page widget */
333 GeanyDocument
*document_get_from_notebook_child(GtkWidget
*page
)
335 ScintillaObject
*sci
;
337 g_return_val_if_fail(GTK_IS_BOX(page
), NULL
);
339 sci
= locate_sci_in_container(page
);
340 g_return_val_if_fail(IS_SCINTILLA(sci
), NULL
);
342 return document_find_by_sci(sci
);
347 * Finds the document for the given notebook page @a page_num.
349 * @param page_num The notebook page number to search.
351 * @return @transfer{none} @nullable The corresponding document for the given notebook page, or @c NULL.
354 GeanyDocument
*document_get_from_page(guint page_num
)
358 if (page_num
>= documents_array
->len
)
361 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
363 return document_get_from_notebook_child(parent
);
368 * Finds the current document.
370 * @return @transfer{none} @nullable A pointer to the current document or @c NULL if there are no opened documents.
373 GeanyDocument
*document_get_current(void)
375 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
380 return document_get_from_page((guint
) cur_page
);
384 void document_init_doclist(void)
386 documents_array
= g_ptr_array_new();
390 void document_finalize(void)
394 for (i
= 0; i
< documents_array
->len
; i
++)
395 g_free(documents
[i
]);
396 g_ptr_array_free(documents_array
, TRUE
);
401 * Returns the last part of the filename of the given GeanyDocument. The result is also
402 * truncated to a maximum of @a length characters in case the filename is very long.
404 * @param doc The document to use.
405 * @param length The length of the resulting string or -1 to use a default value.
407 * @return The ellipsized last part of the filename of @a doc, should be freed when no
412 /* TODO make more use of this */
414 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
416 gchar
*base_name
, *short_name
;
418 g_return_val_if_fail(doc
!= NULL
, NULL
);
423 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
424 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
432 void document_update_tab_label(GeanyDocument
*doc
)
437 g_return_if_fail(doc
!= NULL
);
439 short_name
= document_get_basename_for_display(doc
, -1);
441 /* we need to use the event box for the tooltip, labels don't get the necessary events */
442 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
443 parent
= gtk_widget_get_parent(parent
);
445 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
447 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
454 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
455 * according to the document's save state.
456 * This is called by Geany mostly when opening or saving files.
458 * @param doc The document to use.
459 * @param changed Whether the document state should indicate changes have been made.
462 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
464 g_return_if_fail(doc
!= NULL
);
466 doc
->changed
= changed
;
468 if (! main_status
.quitting
)
470 ui_update_tab_status(doc
);
471 ui_save_buttons_toggle(changed
);
472 ui_set_window_title(doc
);
473 ui_update_statusbar(doc
, -1);
478 /* returns the next free place in the document list,
479 * or -1 if the documents_array is full */
480 static gint
document_get_new_idx(void)
484 for (i
= 0; i
< documents_array
->len
; i
++)
486 if (documents
[i
]->editor
== NULL
)
495 static void queue_colourise(GeanyDocument
*doc
)
497 if (doc
->priv
->colourise_needed
)
500 /* Colourise the editor before it is next drawn */
501 doc
->priv
->colourise_needed
= TRUE
;
503 /* If the editor doesn't need drawing (e.g. after saving the current
504 * document), we need to force a redraw, so the expose event is triggered.
505 * This ensures we don't start colourising before all documents are opened/saved,
506 * only once the editor is drawn. */
507 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
511 #ifdef USE_GIO_FILEMON
512 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
513 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
516 g_return_if_fail(doc
!= NULL
);
518 if (file_prefs
.disk_check_timeout
== 0)
521 geany_debug("%s: event: %d previous file status: %d",
522 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
525 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
527 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
528 doc
->priv
->file_disk_status
= FILE_OK
;
530 doc
->priv
->file_disk_status
= FILE_CHANGED
;
531 g_message("%s: FILE_CHANGED", G_STRFUNC
);
534 case G_FILE_MONITOR_EVENT_DELETED
:
536 doc
->priv
->file_disk_status
= FILE_CHANGED
;
537 g_message("%s: FILE_MISSING", G_STRFUNC
);
543 if (doc
->priv
->file_disk_status
!= FILE_OK
)
545 ui_update_tab_status(doc
);
551 static void document_stop_file_monitoring(GeanyDocument
*doc
)
553 g_return_if_fail(doc
!= NULL
);
555 if (doc
->priv
->monitor
!= NULL
)
557 g_object_unref(doc
->priv
->monitor
);
558 doc
->priv
->monitor
= NULL
;
563 static void monitor_file_setup(GeanyDocument
*doc
)
565 g_return_if_fail(doc
!= NULL
);
566 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
567 * doesn't work at all for remote files and legacy polling is too slow. */
568 if (! doc
->priv
->is_remote
)
570 #ifdef USE_GIO_FILEMON
571 gchar
*locale_filename
;
573 /* stop any previous monitoring */
574 document_stop_file_monitoring(doc
);
576 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
577 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
579 /* get a file monitor and connect to the 'changed' signal */
580 GFile
*file
= g_file_new_for_path(locale_filename
);
581 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
582 g_signal_connect(doc
->priv
->monitor
, "changed",
583 G_CALLBACK(monitor_file_changed_cb
), doc
);
585 /* we set the rate limit according to the GUI pref but it's most probably not used */
586 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
588 g_object_unref(file
);
590 g_free(locale_filename
);
593 doc
->priv
->file_disk_status
= FILE_OK
;
597 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
599 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
602 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
603 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
605 if (source_widget
== NULL
)
606 source_widget
= doc
->priv
->tag_tree
;
608 if (focusw
== source_widget
)
609 gtk_widget_grab_focus(sci
);
614 static gboolean
on_idle_focus(gpointer doc
)
616 document_try_focus(doc
, NULL
);
621 /* Creates a new document and editor, adding a tab in the notebook.
622 * @return The created document */
623 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
627 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
631 doc
= document_get_current();
632 /* remove the empty document first */
633 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
634 /* prevent immediately opening another new doc with
635 * new_document_after_close pref */
639 new_idx
= document_get_new_idx();
640 if (new_idx
== -1) /* expand the array, no free places */
642 doc
= g_new0(GeanyDocument
, 1);
644 new_idx
= documents_array
->len
;
645 g_ptr_array_add(documents_array
, doc
);
648 doc
= documents
[new_idx
];
650 /* initialize default document settings */
651 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
652 doc
->id
= ++doc_id_counter
;
653 doc
->index
= new_idx
;
654 doc
->file_name
= g_strdup(utf8_filename
);
655 doc
->editor
= editor_create(doc
);
656 #ifndef USE_GIO_FILEMON
657 doc
->priv
->last_check
= time(NULL
);
660 g_datalist_init(&doc
->priv
->data
);
662 sidebar_openfiles_add(doc
); /* sets doc->iter */
664 notebook_new_tab(doc
);
666 /* select document in sidebar */
668 GtkTreeSelection
*sel
;
670 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
671 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
674 ui_document_buttons_update();
676 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
682 * Closes the given document.
684 * @param doc The document to remove.
686 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
691 gboolean
document_close(GeanyDocument
*doc
)
693 g_return_val_if_fail(doc
, FALSE
);
695 return document_remove_page(document_get_notebook_page(doc
));
699 /* Call document_remove_page() instead, this is only needed for document_create()
700 * to prevent re-opening a new document when the last document is closed (if enabled). */
701 static gboolean
remove_page(guint page_num
)
703 GeanyDocument
*doc
= document_get_from_page(page_num
);
705 g_return_val_if_fail(doc
!= NULL
, FALSE
);
707 if (doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
710 /* tell any plugins that the document is about to be closed */
711 g_signal_emit_by_name(geany_object
, "document-close", doc
);
713 /* Checking real_path makes it likely the file exists on disk */
714 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
715 ui_add_recent_document(doc
);
717 g_datalist_clear(&doc
->priv
->data
);
719 doc
->is_valid
= FALSE
;
722 if (main_status
.quitting
)
724 /* we need to destroy the ScintillaWidget so our handlers on it are
725 * disconnected before we free any data they may use (like the editor).
726 * when not quitting, this is handled by removing the notebook page. */
727 gtk_notebook_remove_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
731 notebook_remove_page(page_num
);
732 sidebar_remove_document(doc
);
733 navqueue_remove_file(doc
->file_name
);
734 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
736 g_free(doc
->encoding
);
737 g_free(doc
->priv
->saved_encoding
.encoding
);
738 g_free(doc
->file_name
);
739 g_free(doc
->real_path
);
742 tm_workspace_remove_source_file(doc
->tm_file
);
743 tm_source_file_free(doc
->tm_file
);
746 if (doc
->priv
->tag_tree
)
747 gtk_widget_destroy(doc
->priv
->tag_tree
);
749 editor_destroy(doc
->editor
);
750 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
752 document_stop_file_monitoring(doc
);
754 document_undo_clear(doc
);
758 /* reset document settings to defaults for re-use */
759 memset(doc
, 0, sizeof(GeanyDocument
));
761 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
763 sidebar_update_tag_list(NULL
, FALSE
);
764 ui_set_window_title(NULL
);
765 ui_save_buttons_toggle(FALSE
);
766 ui_update_popup_reundo_items(NULL
);
767 ui_document_buttons_update();
768 build_menu_update(NULL
);
775 * Removes the given notebook tab at @a page_num and clears all related information
776 * in the document list.
778 * @param page_num The notebook page number to remove.
780 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
783 gboolean
document_remove_page(guint page_num
)
785 gboolean done
= remove_page(page_num
);
787 if (done
&& ui_prefs
.new_document_after_close
)
788 document_new_file_if_non_open();
794 /* used to keep a record of the unchanged document state encoding */
795 static void store_saved_encoding(GeanyDocument
*doc
)
797 g_free(doc
->priv
->saved_encoding
.encoding
);
798 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
799 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
803 /* Opens a new empty document only if there are no other documents open */
804 GeanyDocument
*document_new_file_if_non_open(void)
806 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
807 return document_new_file(NULL
, NULL
, NULL
);
814 * Creates a new document.
815 * Line endings in @a text will be converted to the default setting.
816 * Afterwards, the @c "document-new" signal is emitted for plugins.
818 * @param utf8_filename @nullable The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
819 * @param ft @nullable The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
820 * @param text @nullable The initial content of the file (in UTF-8 encoding), or @c NULL.
822 * @return @transfer{none} The new document.
825 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
829 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
832 tmp
= utils_strdupa(utf8_filename
); /* work around const */
833 utils_tidy_path(tmp
);
836 doc
= document_create(utf8_filename
);
838 g_assert(doc
!= NULL
);
840 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
843 GString
*template = g_string_new(text
);
844 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
846 sci_set_text(doc
->editor
->sci
, template->str
);
847 g_string_free(template, TRUE
);
850 sci_clear_all(doc
->editor
->sci
);
852 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
854 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
855 sci_empty_undo_buffer(doc
->editor
->sci
);
857 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
858 /* store the opened encoding for undo/redo */
859 store_saved_encoding(doc
);
861 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
862 ft
= filetypes_detect_from_document(doc
);
864 document_set_filetype(doc
, ft
); /* also re-parses tags */
866 /* now the document is fully ready, display it (see notebook_new_tab()) */
867 gtk_widget_show(document_get_notebook_child(doc
));
869 ui_set_window_title(doc
);
870 build_menu_update(doc
);
871 document_set_text_changed(doc
, FALSE
);
872 ui_document_show_hide(doc
); /* update the document menu */
874 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
875 /* bring it in front, jump to the start and grab the focus */
876 editor_goto_pos(doc
->editor
, 0, FALSE
);
877 document_try_focus(doc
, NULL
);
879 #ifdef USE_GIO_FILEMON
880 monitor_file_setup(doc
);
882 doc
->priv
->mtime
= 0;
885 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
886 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
888 g_signal_emit_by_name(geany_object
, "document-new", doc
);
890 msgwin_status_add(_("New file \"%s\" opened."),
898 * Opens a document specified by @a locale_filename.
899 * Afterwards, the @c "document-open" signal is emitted for plugins.
901 * @param locale_filename The filename of the document to load, in locale encoding.
902 * @param readonly Whether to open the document in read-only mode.
903 * @param ft @nullable The filetype for the document or @c NULL to auto-detect the filetype.
904 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
906 * @return @transfer{none} @nullable The document opened or @c NULL.
909 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
910 GeanyFiletype
*ft
, const gchar
*forced_enc
)
912 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
918 gchar
*data
; /* null-terminated file data */
919 gsize len
; /* string length of data */
922 time_t mtime
; /* modification time, read by stat::st_mtime */
927 static gboolean
get_mtime(const gchar
*locale_filename
, time_t *time
)
929 GError
*error
= NULL
;
930 const gchar
*err_msg
= NULL
;
932 if (USE_GIO_FILE_OPERATIONS
)
934 GFile
*file
= g_file_new_for_path(locale_filename
);
935 GFileInfo
*info
= g_file_query_info(file
, G_FILE_ATTRIBUTE_TIME_MODIFIED
, G_FILE_QUERY_INFO_NONE
, NULL
, &error
);
941 g_file_info_get_modification_time(info
, &timeval
);
942 g_object_unref(info
);
943 *time
= timeval
.tv_sec
;
946 err_msg
= error
->message
;
948 g_object_unref(file
);
954 if (g_stat(locale_filename
, &st
) == 0)
957 err_msg
= g_strerror(errno
);
962 gchar
*utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
964 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
965 utf8_filename
, err_msg
);
966 g_free(utf8_filename
);
972 return err_msg
== NULL
;
976 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
977 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
978 FileData
*filedata
, const gchar
*forced_enc
)
982 filedata
->data
= NULL
;
984 filedata
->enc
= NULL
;
985 filedata
->bom
= FALSE
;
986 filedata
->readonly
= FALSE
;
988 if (!get_mtime(locale_filename
, &filedata
->mtime
))
991 if (USE_GIO_FILE_OPERATIONS
)
993 GFile
*file
= g_file_new_for_path(locale_filename
);
995 g_file_load_contents(file
, NULL
, &filedata
->data
, &filedata
->len
, NULL
, &err
);
996 g_object_unref(file
);
999 g_file_get_contents(locale_filename
, &filedata
->data
, &filedata
->len
, &err
);
1003 ui_set_statusbar(TRUE
, "%s", err
->message
);
1008 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
1009 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
1013 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
1014 display_filename
, forced_enc
);
1018 ui_set_statusbar(TRUE
,
1019 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
1022 g_free(filedata
->data
);
1026 if (filedata
->readonly
)
1028 const gchar
*warn_msg
= _(
1029 "The file \"%s\" could not be opened properly and has been truncated. " \
1030 "This can occur if the file contains a NULL byte. " \
1031 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
1033 if (main_status
.main_window_realized
)
1034 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
1036 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
1043 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
1044 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
1045 * if cl_options.goto_column is set.
1047 * returns the new position which may have changed */
1048 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
1050 if (cl_options
.goto_line
>= 0)
1051 { /* goto line which was specified on command line and then undefine the line */
1052 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
1053 editor
->scroll_percent
= 0.5F
;
1054 cl_options
.goto_line
= -1;
1058 sci_set_current_position(editor
->sci
, pos
, FALSE
);
1059 editor
->scroll_percent
= 0.5F
;
1062 if (cl_options
.goto_column
>= 0)
1063 { /* goto column which was specified on command line and then undefine the column */
1065 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
1066 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
1067 editor
->scroll_percent
= 0.5F
;
1068 cl_options
.goto_column
= -1;
1071 return sci_get_current_position(editor
->sci
);
1075 /* Count lines that start with some hard tabs then a soft tab. */
1076 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
1078 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1079 ScintillaObject
*sci
= editor
->sci
;
1081 struct Sci_TextToFind ttf
;
1082 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
1083 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
1088 ttf
.chrg
.cpMax
= sci_get_length(sci
);
1089 ttf
.lpstrText
= regex
;
1094 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
1096 break; /* no more matches */
1098 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
1101 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
1102 return count
> sci_get_line_count(sci
) * 0.02;
1106 /* Detect the indent type based on counting the leading indent characters for each line.
1107 * Returns whether detection succeeded, and the detected type in *type_ upon success */
1108 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
1110 GeanyEditor
*editor
= doc
->editor
;
1111 ScintillaObject
*sci
= editor
->sci
;
1112 gint line
, line_count
;
1113 gsize tabs
= 0, spaces
= 0;
1115 if (detect_tabs_and_spaces(editor
))
1117 *type_
= GEANY_INDENT_TYPE_BOTH
;
1121 line_count
= sci_get_line_count(sci
);
1122 for (line
= 0; line
< line_count
; line
++)
1124 gint pos
= sci_get_position_from_line(sci
, line
);
1127 /* most code will have indent total <= 24, otherwise it's more likely to be
1128 * alignment than indentation */
1129 if (sci_get_line_indentation(sci
, line
) > 24)
1132 c
= sci_get_char_at(sci
, pos
);
1135 /* check for at least 2 spaces */
1136 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
1139 if (spaces
== 0 && tabs
== 0)
1142 /* the factors may need to be tweaked */
1143 if (spaces
> tabs
* 4)
1144 *type_
= GEANY_INDENT_TYPE_SPACES
;
1145 else if (tabs
> spaces
* 4)
1146 *type_
= GEANY_INDENT_TYPE_TABS
;
1148 *type_
= GEANY_INDENT_TYPE_BOTH
;
1154 /* Detect the indent width based on counting the leading indent characters for each line.
1155 * Returns whether detection succeeded, and the detected width in *width_ upon success */
1156 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
1158 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1159 ScintillaObject
*sci
= editor
->sci
;
1160 gint line
, line_count
;
1161 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
1162 gint count
, width
, i
;
1164 /* can't easily detect the supposed width of a tab, guess the default is OK */
1165 if (type
== GEANY_INDENT_TYPE_TABS
)
1168 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
1169 sci_set_tab_width(sci
, 8);
1171 line_count
= sci_get_line_count(sci
);
1172 for (line
= 0; line
< line_count
; line
++)
1174 gint pos
= sci_get_line_indent_position(sci
, line
);
1176 /* We probably don't have style info yet, because we're generally called just after
1177 * the document got created, so we can't use highlighting_is_code_style().
1178 * That's not good, but the assumption below that concerning lines start with an
1179 * asterisk (common continuation character for C/C++/Java/...) should do the trick
1180 * without removing too much legitimate lines. */
1181 if (sci_get_char_at(sci
, pos
) == '*')
1184 width
= sci_get_line_indentation(sci
, line
);
1185 /* most code will have indent total <= 24, otherwise it's more likely to be
1186 * alignment than indentation */
1189 /* < 2 is no indentation */
1193 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1195 if ((width
% (i
+ 2)) == 0)
1200 width
= iprefs
->width
;
1201 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1203 /* give large indents higher weight not to be fooled by spurious indents */
1204 if (widths
[i
] >= count
* 1.5)
1219 /* same as detect_indent_width() but uses editor's indent type */
1220 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1222 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1226 void document_apply_indent_settings(GeanyDocument
*doc
)
1228 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1229 GeanyIndentType type
= iprefs
->type
;
1230 gint width
= iprefs
->width
;
1232 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1234 if (type
!= iprefs
->type
)
1236 const gchar
*name
= NULL
;
1240 case GEANY_INDENT_TYPE_SPACES
:
1243 case GEANY_INDENT_TYPE_TABS
:
1246 case GEANY_INDENT_TYPE_BOTH
:
1247 name
= _("Tabs and Spaces");
1250 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1251 * and Spaces), the second one is the filename */
1252 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1256 else if (doc
->file_type
->indent_type
> -1)
1257 type
= doc
->file_type
->indent_type
;
1259 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1261 if (width
!= iprefs
->width
)
1263 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1267 else if (doc
->file_type
->indent_width
> -1)
1268 width
= doc
->file_type
->indent_width
;
1270 editor_set_indent(doc
->editor
, type
, width
);
1274 void document_show_tab(GeanyDocument
*doc
)
1276 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1277 document_get_notebook_page(doc
));
1281 /* To open a new file, set doc to NULL; filename should be locale encoded.
1282 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1283 * pos is the cursor position, which can be overridden by --line and --column.
1284 * forced_enc can be NULL to detect the file encoding.
1285 * Returns: doc of the opened file or NULL if an error occurred. */
1286 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1287 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1290 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1291 gchar
*utf8_filename
= NULL
;
1292 gchar
*display_filename
= NULL
;
1293 gchar
*locale_filename
= NULL
;
1294 GeanyFiletype
*use_ft
;
1296 UndoReloadData
*undo_reload_data
;
1297 gboolean add_undo_reload_action
;
1299 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, NULL
);
1303 utf8_filename
= g_strdup(doc
->file_name
);
1304 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1308 /* filename must not be NULL when opening a file */
1309 g_return_val_if_fail(filename
, NULL
);
1312 /* if filename is a shortcut, try to resolve it */
1313 locale_filename
= win32_get_shortcut_target(filename
);
1315 locale_filename
= g_strdup(filename
);
1317 /* remove relative junk */
1318 utils_tidy_path(locale_filename
);
1320 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1321 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1323 /* if file is already open, switch to it and go */
1324 doc
= document_find_by_filename(utf8_filename
);
1327 ui_add_recent_document(doc
); /* either add or reorder recent item */
1328 /* show the doc before reload dialog */
1329 document_show_tab(doc
);
1330 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1333 if (reload
|| doc
== NULL
)
1334 { /* doc possibly changed */
1335 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1337 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1339 g_free(display_filename
);
1340 g_free(utf8_filename
);
1341 g_free(locale_filename
);
1347 doc
= document_create(utf8_filename
);
1348 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1350 /* file exists on disk, set real_path */
1351 SETPTR(doc
->real_path
, tm_get_real_path(locale_filename
));
1353 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1354 monitor_file_setup(doc
);
1357 if (! reload
|| ! file_prefs
.keep_edit_history_on_reload
)
1359 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1360 sci_empty_undo_buffer(doc
->editor
->sci
);
1361 undo_reload_data
= NULL
;
1365 undo_reload_data
= (UndoReloadData
*) g_malloc(sizeof(UndoReloadData
));
1367 /* We will be adding a UNDO_RELOAD action to the undo stack that undoes
1368 * this reload. To do that, we keep collecting undo actions during
1369 * reloading, and at the end add an UNDO_RELOAD action that performs
1370 * all these actions in bulk. To keep track of how many undo actions
1371 * were added during this time, we compare the current undo-stack height
1372 * with its height at the end of the process. Note that g_trash_stack_height()
1373 * is O(N), which is a little ugly, but this seems like the most maintainable
1375 undo_reload_data
->actions_count
= g_trash_stack_height(&doc
->priv
->undo_actions
);
1377 /* We use add_undo_reload_action to track any changes to the document that
1378 * require adding an undo action to revert the reload, but that do not
1379 * generate an undo action themselves. */
1380 add_undo_reload_action
= FALSE
;
1383 /* add the text to the ScintillaObject */
1384 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1385 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1386 queue_colourise(doc
); /* Ensure the document gets colourised. */
1388 /* detect & set line endings */
1389 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1390 if (undo_reload_data
)
1392 undo_reload_data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
1393 /* Force adding an undo-reload action if the EOL mode changed. */
1394 if (editor_mode
!= undo_reload_data
->eol_mode
)
1395 add_undo_reload_action
= TRUE
;
1397 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1398 g_free(filedata
.data
);
1400 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1402 /* If reloading and the current and new encodings or BOM states differ,
1403 * add appropriate undo actions. */
1404 if (undo_reload_data
)
1406 if (! utils_str_equal(doc
->encoding
, filedata
.enc
))
1407 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
1408 if (doc
->has_bom
!= filedata
.bom
)
1409 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
1412 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1413 g_free(doc
->encoding
); /* if reloading, free old encoding */
1414 doc
->encoding
= filedata
.enc
;
1415 doc
->has_bom
= filedata
.bom
;
1416 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1418 doc
->readonly
= readonly
|| filedata
.readonly
;
1419 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1420 doc
->priv
->protected = 0;
1422 /* update line number margin width */
1423 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1424 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
1429 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1430 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1433 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1437 if (undo_reload_data
)
1439 /* Calculate the number of undo actions that are part of the reloading
1440 * process, and add the UNDO_RELOAD action. */
1441 undo_reload_data
->actions_count
=
1442 g_trash_stack_height(&doc
->priv
->undo_actions
) - undo_reload_data
->actions_count
;
1444 /* We only add an undo-reload action if the document has actually changed.
1445 * At the time of writing, this condition is moot because sci_set_text
1446 * generates an undo action even when the text hasn't really changed, so
1447 * actions_count is always greater than zero. In the future this might change.
1448 * It's arguable whether we should add an undo-reload action unconditionally,
1449 * especially since it's possible (if unlikely) that there had only
1450 * been "invisible" changes to the document, such as changes in encoding and
1451 * EOL mode, but for the time being that's how we roll. */
1452 if (undo_reload_data
->actions_count
> 0 || add_undo_reload_action
)
1453 document_undo_add(doc
, UNDO_RELOAD
, undo_reload_data
);
1455 g_free(undo_reload_data
);
1457 /* We didn't save the document per-se, but its contents are now
1458 * synchronized with the file on disk, hence set a save point here.
1459 * We need to do this in this case only, because we don't clear
1460 * Scintilla's undo stack. */
1461 sci_set_savepoint(doc
->editor
->sci
);
1464 document_undo_clear(doc
);
1468 /* update taglist, typedef keywords and build menu if necessary */
1469 document_set_filetype(doc
, use_ft
);
1471 /* set indentation settings after setting the filetype */
1473 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1475 document_apply_indent_settings(doc
);
1477 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1478 ui_document_show_hide(doc
); /* update the document menu */
1480 /* finally add current file to recent files menu, but not the files from the last session */
1481 if (! main_status
.opening_session_files
)
1482 ui_add_recent_document(doc
);
1486 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1487 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1491 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1492 /* For translators: this is the status window message for opening a file. %d is the number
1493 * of the newly opened file, %s indicates whether the file is opened read-only
1494 * (it is replaced with the string ", read-only"). */
1495 msgwin_status_add(_("File %s opened(%d%s)."),
1496 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1497 (readonly
) ? _(", read-only") : "");
1500 /* now the document is fully ready, display it (see notebook_new_tab()) */
1501 gtk_widget_show(document_get_notebook_child(doc
));
1504 g_free(display_filename
);
1505 g_free(utf8_filename
);
1506 g_free(locale_filename
);
1508 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1509 pos
= set_cursor_position(doc
->editor
, pos
);
1510 /* now bring the file in front */
1511 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1513 /* finally, let the editor widget grab the focus so you can start coding
1515 g_idle_add(on_idle_focus
, doc
);
1520 /* Takes a new line separated list of filename URIs and opens each file.
1521 * length is the length of the string */
1522 void document_open_file_list(const gchar
*data
, gsize length
)
1527 g_return_if_fail(data
!= NULL
);
1529 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1531 /* stop at the end or first empty item, because last item is empty but not null */
1532 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1534 gchar
*filename
= utils_get_path_from_uri(list
[i
]);
1536 if (filename
== NULL
)
1538 document_open_file(filename
, FALSE
, NULL
, NULL
);
1547 * Opens each file in the list @a filenames.
1548 * Internally, document_open_file() is called for every list item.
1550 * @param filenames @elementtype{filename} A list of filenames to load, in locale encoding.
1551 * @param readonly Whether to open the document in read-only mode.
1552 * @param ft @nullable The filetype for the document or @c NULL to auto-detect the filetype.
1553 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
1556 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1557 const gchar
*forced_enc
)
1561 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1563 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1568 static void on_keep_edit_history_on_reload_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
1570 if (response_id
== GTK_RESPONSE_NO
)
1572 file_prefs
.keep_edit_history_on_reload
= FALSE
;
1573 document_reload_force(doc
, doc
->encoding
);
1575 else if (response_id
== GTK_RESPONSE_CANCEL
)
1577 /* this condition cannot be reached via info bar buttons, but by our code
1578 * to replace this bar with a higher priority one */
1579 file_prefs
.show_keep_edit_history_on_reload_msg
= TRUE
;
1581 doc
->priv
->info_bars
[MSG_TYPE_POST_RELOAD
] = NULL
;
1582 gtk_widget_destroy(bar
);
1587 * Reloads the document with the specified file encoding.
1588 * @a forced_enc or @c NULL to auto-detect the file encoding.
1590 * @param doc The document to reload.
1591 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
1593 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1596 gboolean
document_reload_force(GeanyDocument
*doc
, const gchar
*forced_enc
)
1599 GeanyDocument
*new_doc
;
1602 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1604 /* Use cancel because the response handler would call this recursively */
1605 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] != NULL
)
1606 gtk_info_bar_response(GTK_INFO_BAR(doc
->priv
->info_bars
[MSG_TYPE_RELOAD
]), GTK_RESPONSE_CANCEL
);
1608 /* try to set the cursor to the position before reloading */
1609 pos
= sci_get_current_position(doc
->editor
->sci
);
1610 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1612 if (file_prefs
.keep_edit_history_on_reload
&& file_prefs
.show_keep_edit_history_on_reload_msg
)
1614 bar
= document_show_message(doc
, GTK_MESSAGE_INFO
,
1615 on_keep_edit_history_on_reload_response
,
1616 GTK_STOCK_OK
, GTK_RESPONSE_ACCEPT
,
1617 _("Discard history"), GTK_RESPONSE_NO
,
1618 NULL
, 0, _("The buffer's previous state is stored in the history and "
1619 "undoing restores it. You can disable this by discarding the history upon "
1620 "reload. This message will not be displayed again but "
1621 "Your choice can be changed in the various preferences."),
1622 _("The file has been reloaded."));
1623 doc
->priv
->info_bars
[MSG_TYPE_POST_RELOAD
] = bar
;
1624 file_prefs
.show_keep_edit_history_on_reload_msg
= FALSE
;
1627 return (new_doc
!= NULL
);
1631 /* also used for reloading when forced_enc is NULL */
1632 gboolean
document_reload_prompt(GeanyDocument
*doc
, const gchar
*forced_enc
)
1635 gboolean prompt
, result
= FALSE
;
1637 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1639 /* No need to reload "untitled" (non-file-backed) documents */
1640 if (doc
->file_name
== NULL
)
1643 if (forced_enc
== NULL
)
1644 forced_enc
= doc
->encoding
;
1646 base_name
= g_path_get_basename(doc
->file_name
);
1647 /* don't prompt if edit history is maintained, or if file hasn't been edited at all */
1648 prompt
= !file_prefs
.keep_edit_history_on_reload
&&
1649 (doc
->changed
|| (document_can_undo(doc
) || document_can_redo(doc
)));
1651 if (!prompt
|| dialogs_show_question_full(NULL
, _("_Reload"), GTK_STOCK_CANCEL
,
1652 doc
->changed
? _("Any unsaved changes will be lost.") :
1653 _("Undo history will be lost."),
1654 _("Are you sure you want to reload '%s'?"), base_name
))
1656 result
= document_reload_force(doc
, forced_enc
);
1657 if (forced_enc
!= NULL
)
1658 ui_update_statusbar(doc
, -1);
1665 static void document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1667 #ifndef USE_GIO_FILEMON
1668 g_return_if_fail(doc
!= NULL
);
1670 get_mtime(locale_filename
, &doc
->priv
->mtime
); /* get the modification time from file and keep it */
1675 /* Sets line and column to the given position byte_pos in the document.
1676 * byte_pos is the position counted in bytes, not characters */
1677 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1682 /* for some reason we can use byte count instead of character count here */
1683 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1684 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1685 /* get the column in the line */
1686 *column
= byte_pos
- line_start
;
1688 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1689 * skip one byte(i++) and decrease the column number which is based on byte count */
1690 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1692 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1701 static void replace_header_filename(GeanyDocument
*doc
)
1705 struct Sci_TextToFind ttf
;
1707 g_return_if_fail(doc
!= NULL
);
1708 g_return_if_fail(doc
->file_type
!= NULL
);
1710 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1711 if (doc
->file_type
->extension
)
1712 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1714 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1716 filename
= g_path_get_basename(doc
->file_name
);
1718 /* only search the first 3 lines */
1720 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1721 ttf
.lpstrText
= filebase
;
1723 if (search_find_text(doc
->editor
->sci
, GEANY_FIND_MATCHCASE
| GEANY_FIND_REGEXP
, &ttf
, NULL
) != -1)
1725 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1726 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1727 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1735 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1736 * you still have to call @ref document_save_file_as() to change the @a doc object.
1737 * It also stops monitoring for file changes to prevent receiving too many file change events
1738 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1740 * @param doc The current document which should be renamed.
1741 * @param new_filename The new filename in UTF-8 encoding.
1746 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1748 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1749 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1752 /* stop file monitoring to avoid getting events for deleting/creating files,
1753 * it's re-setup in document_save_file_as() */
1754 document_stop_file_monitoring(doc
);
1756 result
= g_rename(old_locale_filename
, new_locale_filename
);
1759 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1760 _("Error renaming file."), g_strerror(errno
));
1762 g_free(old_locale_filename
);
1763 g_free(new_locale_filename
);
1767 static void protect_document(GeanyDocument
*doc
)
1769 /* do not call queue_colourise because to we want to keep the text-changed indication! */
1770 if (!doc
->priv
->protected++)
1771 sci_set_readonly(doc
->editor
->sci
, TRUE
);
1773 ui_update_tab_status(doc
);
1777 static void unprotect_document(GeanyDocument
*doc
)
1779 g_return_if_fail(doc
->priv
->protected > 0);
1781 if (!--doc
->priv
->protected && doc
->readonly
== FALSE
)
1782 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1784 ui_update_tab_status(doc
);
1788 /* Return TRUE if the document doesn't have a full filename set.
1789 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1790 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1792 gboolean
document_need_save_as(GeanyDocument
*doc
)
1794 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1796 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1801 * Saves the document, detecting the filetype.
1803 * @param doc The document for the file to save.
1804 * @param utf8_fname @nullable The new name for the document, in UTF-8, or @c NULL.
1805 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1807 * @see document_save_file().
1812 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1817 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1819 new_file
= document_need_save_as(doc
) || (utf8_fname
!= NULL
&& strcmp(doc
->file_name
, utf8_fname
) != 0);
1820 if (utf8_fname
!= NULL
)
1821 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1823 /* reset real path, it's retrieved again in document_save() */
1824 SETPTR(doc
->real_path
, NULL
);
1826 /* detect filetype */
1827 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1829 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1831 document_set_filetype(doc
, ft
);
1832 if (document_get_current() == doc
)
1834 ignore_callback
= TRUE
;
1835 filetypes_select_radio_item(doc
->file_type
);
1836 ignore_callback
= FALSE
;
1842 // assume user wants to throw away read-only setting
1843 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1844 doc
->readonly
= FALSE
;
1845 if (doc
->priv
->protected > 0)
1846 unprotect_document(doc
);
1849 replace_header_filename(doc
);
1851 ret
= document_save_file(doc
, TRUE
);
1853 /* file monitoring support, add file monitoring after the file has been saved
1854 * to ignore any earlier events */
1855 monitor_file_setup(doc
);
1856 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1859 ui_add_recent_document(doc
);
1864 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1866 GError
*conv_error
= NULL
;
1867 gchar
* conv_file_contents
= NULL
;
1871 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1872 g_return_val_if_fail(len
!= NULL
, FALSE
);
1874 /* try to convert it from UTF-8 to original encoding */
1875 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1876 &bytes_read
, &conv_len
, &conv_error
);
1878 if (conv_error
!= NULL
)
1880 gchar
*text
= g_strdup_printf(
1881 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1885 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1890 /* don't read over the doc length */
1891 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1892 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1893 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1895 /* take only one valid Unicode character from the context and discard the leftover */
1896 unic
= g_utf8_get_char_validated(context
, -1);
1897 context_len
= g_unichar_to_utf8(unic
, context
);
1898 context
[context_len
] = '\0';
1899 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1901 error_text
= g_strdup_printf(
1902 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1903 conv_error
->message
, context
, line
+ 1, column
);
1906 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1908 geany_debug("encoding error: %s", conv_error
->message
);
1909 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1910 g_error_free(conv_error
);
1918 *data
= conv_file_contents
;
1925 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1926 const gchar
*data
, gsize len
)
1928 GError
*error
= NULL
;
1930 if (file_prefs
.use_safe_file_saving
)
1932 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1933 * This is the only option that handles disk space exhaustion. */
1934 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1935 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1937 else if (USE_GIO_FILE_OPERATIONS
)
1941 /* Use GIO API to save file (GVFS-safe)
1942 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1943 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1944 fp
= g_file_new_for_path(locale_filename
);
1945 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1946 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1953 gchar
*display_name
= g_filename_display_name(locale_filename
);
1955 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1956 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1958 fp
= g_fopen(locale_filename
, "wb");
1965 g_file_error_from_errno(save_errno
),
1966 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1968 g_strerror(save_errno
));
1972 gsize bytes_written
;
1975 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1977 if (len
!= bytes_written
)
1983 g_file_error_from_errno(save_errno
),
1984 _("Failed to write file '%s': fwrite() failed: %s"),
1986 g_strerror(save_errno
));
1990 /* preserve the fwrite() error if any */
1991 if (fclose(fp
) != 0 && error
== NULL
)
1997 g_file_error_from_errno(save_errno
),
1998 _("Failed to close file '%s': fclose() failed: %s"),
2000 g_strerror(save_errno
));
2004 g_free(display_name
);
2008 gchar
*msg
= g_strdup(error
->message
);
2009 g_error_free(error
);
2010 /* geany will warn about file truncation for unsafe saving below */
2017 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
2018 const gchar
*data
, gsize len
)
2022 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
2023 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
2025 err
= write_data_to_disk(locale_filename
, data
, len
);
2029 /* now the file is on disk, set real_path */
2030 if (doc
->real_path
== NULL
)
2032 doc
->real_path
= tm_get_real_path(locale_filename
);
2033 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
2034 monitor_file_setup(doc
);
2040 static gboolean
save_file_handle_infobars(GeanyDocument
*doc
, gboolean force
)
2042 GtkWidget
*bar
= NULL
;
2044 document_show_tab(doc
);
2046 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
])
2048 if (!dialogs_show_question_full(NULL
, _("_Overwrite"), GTK_STOCK_CANCEL
,
2050 _("The file '%s' on the disk is more recent than the current buffer."),
2053 bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
2055 else if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
])
2057 if (!dialogs_show_question_full(NULL
, GTK_STOCK_SAVE
, GTK_STOCK_CANCEL
,
2058 _("Try to resave the file?"),
2059 _("File \"%s\" was not found on disk!"),
2062 bar
= doc
->priv
->info_bars
[MSG_TYPE_RESAVE
];
2066 g_assert_not_reached();
2069 gtk_info_bar_response(GTK_INFO_BAR(bar
), RESPONSE_DOCUMENT_SAVE
);
2075 * Saves the document.
2076 * Also shows the Save As dialog if necessary.
2077 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
2079 * Saving may include replacing tabs with spaces,
2080 * stripping trailing spaces and adding a final new line at the end of the file, depending
2081 * on user preferences. Then the @c "document-before-save" signal is emitted,
2082 * allowing plugins to modify the document before it is saved, and data is
2083 * actually written to disk.
2085 * On successful saving:
2086 * - GeanyDocument::real_path is set.
2087 * - The filetype is set again or auto-detected if it wasn't set yet.
2088 * - The @c "document-save" signal is emitted for plugins.
2090 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
2091 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
2092 * added in Geany 1.22.
2094 * @param doc The document to save.
2095 * @param force Whether to save the file even if it is not modified.
2097 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
2100 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
2105 gchar
*locale_filename
;
2106 const GeanyFilePrefs
*fp
;
2108 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2110 if (document_need_save_as(doc
))
2112 /* ensure doc is the current tab before showing the dialog */
2113 document_show_tab(doc
);
2114 return dialogs_show_save_as();
2117 if (!force
&& !doc
->changed
)
2121 ui_set_statusbar(TRUE
,
2122 _("Cannot save read-only document '%s'!"), DOC_FILENAME(doc
));
2125 document_check_disk_status(doc
, TRUE
);
2126 if (doc
->priv
->protected)
2127 return save_file_handle_infobars(doc
, force
);
2129 fp
= project_get_file_prefs();
2130 /* replaces tabs with spaces but only if the current file is not a Makefile */
2131 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
2132 editor_replace_tabs(doc
->editor
, TRUE
);
2133 /* strip trailing spaces */
2134 if (fp
->strip_trailing_spaces
)
2135 editor_strip_trailing_spaces(doc
->editor
, TRUE
);
2136 /* ensure the file has a newline at the end */
2137 if (fp
->final_new_line
)
2138 editor_ensure_final_newline(doc
->editor
);
2139 /* ensure newlines are consistent */
2140 if (fp
->ensure_convert_new_lines
)
2141 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
2143 /* notify plugins which may wish to modify the document before it's saved */
2144 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
2146 len
= sci_get_length(doc
->editor
->sci
) + 1;
2147 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
2148 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
2149 * encoding, it will be converted to doc->encoding below and this conversion
2150 * also changes the BOM */
2151 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
2152 data
[0] = (gchar
) 0xef;
2153 data
[1] = (gchar
) 0xbb;
2154 data
[2] = (gchar
) 0xbf;
2155 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
2160 data
= (gchar
*) g_malloc(len
);
2161 sci_get_text(doc
->editor
->sci
, len
, data
);
2164 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
2165 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
2166 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
2168 if (! save_convert_to_encoding(doc
, &data
, &len
))
2179 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2181 /* ignore file changed notification when the file is written */
2182 doc
->priv
->file_disk_status
= FILE_IGNORE
;
2184 /* actually write the content of data to the file on disk */
2185 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
2190 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
2192 if (!file_prefs
.use_safe_file_saving
)
2195 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
2197 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
2198 doc
->priv
->file_disk_status
= FILE_OK
;
2200 g_free(locale_filename
);
2205 /* store the opened encoding for undo/redo */
2206 store_saved_encoding(doc
);
2208 /* ignore the following things if we are quitting */
2209 if (! main_status
.quitting
)
2211 sci_set_savepoint(doc
->editor
->sci
);
2213 if (file_prefs
.disk_check_timeout
> 0)
2214 document_update_timestamp(doc
, locale_filename
);
2216 /* update filetype-related things */
2217 document_set_filetype(doc
, doc
->file_type
);
2219 document_update_tab_label(doc
);
2221 msgwin_status_add(_("File %s saved."), doc
->file_name
);
2222 ui_update_statusbar(doc
, -1);
2224 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
2227 g_free(locale_filename
);
2229 g_signal_emit_by_name(geany_object
, "document-save", doc
);
2235 /* special search function, used from the find entry in the toolbar
2236 * return TRUE if text was found otherwise FALSE
2237 * return also TRUE if text is empty */
2238 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gboolean inc
,
2241 gint start_pos
, search_pos
;
2242 struct Sci_TextToFind ttf
;
2244 g_return_val_if_fail(text
!= NULL
, FALSE
);
2245 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2249 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
2250 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
2252 /* search cursor to end or start */
2253 ttf
.chrg
.cpMin
= start_pos
;
2254 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
2255 ttf
.lpstrText
= (gchar
*)text
;
2256 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2258 /* if no match, search start (or end) to cursor */
2259 if (search_pos
== -1)
2263 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
2264 ttf
.chrg
.cpMax
= start_pos
;
2269 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
2271 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2274 if (search_pos
!= -1)
2276 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2278 /* unfold maybe folded results */
2279 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
2281 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2282 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
2284 if (! editor_line_in_view(doc
->editor
, line
))
2285 { /* we need to force scrolling in case the cursor is outside of the current visible area
2286 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
2287 * while searching */
2288 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
2291 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
2298 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
2301 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
2307 /* General search function, used from the find dialog.
2308 * Returns -1 on failure or the start position of the matching text.
2309 * Will skip past any selection, ignoring it.
2311 * @param text Text to find.
2312 * @param original_text Text as it was entered by user, or @c NULL to use @c text
2314 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
2315 GeanyFindFlags flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
2316 gboolean scroll
, GtkWidget
*parent
)
2318 gint selection_end
, selection_start
, search_pos
;
2320 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
2324 /* Sci doesn't support searching backwards with a regex */
2325 if (flags
& GEANY_FIND_REGEXP
)
2326 search_backwards
= FALSE
;
2329 original_text
= text
;
2331 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2332 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2333 if ((selection_end
- selection_start
) > 0)
2334 { /* there's a selection so go to the end */
2335 if (search_backwards
)
2336 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2338 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2341 sci_set_search_anchor(doc
->editor
->sci
);
2342 if (search_backwards
)
2343 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
2345 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
2347 if (search_pos
!= -1)
2349 /* unfold maybe folded results */
2350 sci_ensure_line_is_visible(doc
->editor
->sci
,
2351 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
2353 doc
->editor
->scroll_percent
= 0.3F
;
2357 gint sci_len
= sci_get_length(doc
->editor
->sci
);
2359 /* if we just searched the whole text, give up searching. */
2360 if ((selection_end
== 0 && ! search_backwards
) ||
2361 (selection_end
== sci_len
&& search_backwards
))
2363 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
2368 /* we searched only part of the document, so ask whether to wraparound. */
2369 if (search_prefs
.always_wrap
||
2370 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
2371 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
2375 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
2376 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
2378 { /* return to original cursor position if not found */
2379 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
2388 /* Replaces the selection if it matches, otherwise just finds the next match.
2389 * Returns: start of replaced text, or -1 if no replacement was made
2391 * @param find_text Text to find.
2392 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
2394 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
2395 const gchar
*replace_text
, GeanyFindFlags flags
, gboolean search_backwards
)
2397 gint selection_end
, selection_start
, search_pos
;
2398 GeanyMatchInfo
*match
= NULL
;
2400 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
2405 /* Sci doesn't support searching backwards with a regex */
2406 if (flags
& GEANY_FIND_REGEXP
)
2407 search_backwards
= FALSE
;
2409 if (!original_find_text
)
2410 original_find_text
= find_text
;
2412 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2413 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2414 if (selection_end
== selection_start
)
2416 /* no selection so just find the next match */
2417 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2420 /* there's a selection so go to the start before finding to search through it
2421 * this ensures there is a match */
2422 if (search_backwards
)
2423 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2425 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2427 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2428 /* return if the original selected text did not match (at the start of the selection) */
2429 if (search_pos
!= selection_start
)
2431 if (search_pos
!= -1)
2432 geany_match_info_free(match
);
2436 if (search_pos
!= -1)
2438 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2439 /* select the replacement - find text will skip past the selected text */
2440 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2441 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2442 geany_match_info_free(match
);
2446 /* no match in the selection */
2453 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2454 const gchar
*original_replace_text
)
2460 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2464 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2465 ui_set_statusbar(TRUE
, ngettext(
2466 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2467 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2468 count
), filename
, count
, original_find_text
, original_replace_text
);
2473 /* Replace all text matches in a certain range within document.
2474 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2475 * or -1 if no text was found.
2476 * scroll_to_match is whether to scroll the last replacement in view (which also
2477 * clears the selection).
2478 * Returns: the number of replacements made. */
2480 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2481 GeanyFindFlags flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2484 struct Sci_TextToFind ttf
;
2485 ScintillaObject
*sci
;
2487 if (new_range_end
!= NULL
)
2488 *new_range_end
= -1;
2490 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2492 if (! *find_text
|| doc
->readonly
)
2495 sci
= doc
->editor
->sci
;
2497 ttf
.chrg
.cpMin
= start
;
2498 ttf
.chrg
.cpMax
= end
;
2499 ttf
.lpstrText
= (gchar
*)find_text
;
2501 sci_start_undo_action(sci
);
2502 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2503 sci_end_undo_action(sci
);
2506 { /* scroll last match in view, will destroy the existing selection */
2507 if (scroll_to_match
)
2508 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2510 if (new_range_end
!= NULL
)
2511 *new_range_end
= ttf
.chrg
.cpMax
;
2517 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2518 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2520 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2521 gint max_column
= 0, count
= 0;
2522 gboolean replaced
= FALSE
;
2524 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2529 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2530 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2531 /* do we have a selection? */
2532 if ((selection_end
- selection_start
) == 0)
2538 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2539 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2540 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2541 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2543 gint first_line
, line
;
2545 sci_start_undo_action(doc
->editor
->sci
);
2547 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2548 /* Find the last line with chars selected (not EOL char) */
2549 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2550 selection_end
- editor_get_eol_char_len(doc
->editor
));
2551 last_line
= MAX(first_line
, last_line
);
2552 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2554 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2555 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2557 /* skip line if there is no selection */
2558 if (line_start
!= INVALID_POSITION
)
2560 /* don't let document_replace_range() scroll to match to keep our selection */
2563 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2564 line_start
, line_end
, FALSE
, &new_sel_end
);
2565 if (new_sel_end
!= -1)
2568 /* this gets the greatest column within the selection after replacing */
2569 max_column
= MAX(max_column
,
2570 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2574 sci_end_undo_action(doc
->editor
->sci
);
2576 else /* handle normal line selection */
2578 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2579 selection_start
, selection_end
, TRUE
, &selection_end
);
2580 if (selection_end
!= -1)
2585 { /* update the selection for the new endpoint */
2587 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2589 /* now we can scroll to the selection and destroy it because we rebuild it later */
2590 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2592 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2593 * the highest column on the last line. The wrapped selection is completely different
2594 * from the original one, so skip the selection at all */
2595 /* TODO is there a better way to handle the wrapped selection? */
2596 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2597 { /* for keeping and adjusting the selection in multi line rectangle selection we
2598 * need the last line of the original selection and the greatest column number after
2599 * replacing and set the selection end to the last line at the greatest column */
2600 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2601 sci_set_selection_end(doc
->editor
->sci
,
2602 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2603 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2608 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2609 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2612 else /* no replacements */
2615 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2619 /* returns number of replacements made. */
2620 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2621 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2624 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2629 len
= sci_get_length(doc
->editor
->sci
);
2630 count
= document_replace_range(
2631 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2633 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2639 * Parses or re-parses the document's buffer and updates the type
2640 * keywords and symbol list.
2642 * @param doc The document.
2644 void document_update_tags(GeanyDocument
*doc
)
2649 g_return_if_fail(DOC_VALID(doc
));
2650 g_return_if_fail(app
->tm_workspace
!= NULL
);
2652 /* early out if it's a new file or doesn't support tags */
2653 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2655 /* We must call sidebar_update_tag_list() before returning,
2656 * to ensure that the symbol list is always updated properly (e.g.
2657 * when creating a new document with a partial filename set. */
2658 sidebar_update_tag_list(doc
, FALSE
);
2662 /* create a new TM file if there isn't one yet */
2665 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2668 /* lookup the name rather than using filetype name to support custom filetypes */
2669 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2670 doc
->tm_file
= tm_source_file_new(locale_filename
, name
);
2671 g_free(locale_filename
);
2674 tm_workspace_add_source_file_noupdate(doc
->tm_file
);
2677 /* early out if there's no tm source file and we couldn't create one */
2678 if (doc
->tm_file
== NULL
)
2680 /* We must call sidebar_update_tag_list() before returning,
2681 * to ensure that the symbol list is always updated properly (e.g.
2682 * when creating a new document with a partial filename set. */
2683 sidebar_update_tag_list(doc
, FALSE
);
2687 /* Parse Scintilla's buffer directly using TagManager
2688 * Note: this buffer *MUST NOT* be modified */
2689 len
= sci_get_length(doc
->editor
->sci
);
2690 buffer_ptr
= (guchar
*) scintilla_send_message(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2691 tm_workspace_update_source_file_buffer(doc
->tm_file
, buffer_ptr
, len
);
2693 sidebar_update_tag_list(doc
, TRUE
);
2694 document_highlight_tags(doc
);
2698 /* Re-highlights type keywords without re-parsing the whole document. */
2699 void document_highlight_tags(GeanyDocument
*doc
)
2701 GString
*keywords_str
;
2704 /* some filetypes support type keywords (such as struct names), but not
2705 * necessarily all filetypes for a particular scintilla lexer. this
2706 * tells us whether the filetype supports keywords, and if so
2707 * which index to use for the scintilla keywords set. */
2708 switch (doc
->file_type
->id
)
2710 case GEANY_FILETYPES_C
:
2711 case GEANY_FILETYPES_CPP
:
2712 case GEANY_FILETYPES_CS
:
2713 case GEANY_FILETYPES_D
:
2714 case GEANY_FILETYPES_JAVA
:
2715 case GEANY_FILETYPES_OBJECTIVEC
:
2716 case GEANY_FILETYPES_VALA
:
2717 case GEANY_FILETYPES_RUST
:
2718 case GEANY_FILETYPES_GO
:
2721 /* index of the keyword set in the Scintilla lexer, for
2722 * example in LexCPP.cxx, see "cppWordLists" global array.
2723 * TODO: this magic number should be a member of the filetype */
2728 return; /* early out if type keywords are not supported */
2730 if (!app
->tm_workspace
->tags_array
)
2733 /* get any type keywords and tell scintilla about them
2734 * this will cause the type keywords to be colourized in scintilla */
2735 keywords_str
= symbols_find_typenames_as_string(doc
->file_type
->lang
, FALSE
);
2738 gchar
*keywords
= g_string_free(keywords_str
, FALSE
);
2739 guint hash
= g_str_hash(keywords
);
2741 if (hash
!= doc
->priv
->keyword_hash
)
2743 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2744 queue_colourise(doc
); /* force re-highlighting the entire document */
2745 doc
->priv
->keyword_hash
= hash
;
2752 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2754 GeanyDocument
*doc
= data
;
2756 if (! DOC_VALID(doc
))
2759 if (! main_status
.quitting
)
2760 document_update_tags(doc
);
2762 doc
->priv
->tag_list_update_source
= 0;
2764 /* don't update the tags until another modification of the buffer */
2769 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2771 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2774 /* prevent "stacking up" callback handlers, we only need one to run soon */
2775 if (doc
->priv
->tag_list_update_source
!= 0)
2776 g_source_remove(doc
->priv
->tag_list_update_source
);
2778 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2779 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2783 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2784 gboolean filetype_changed
)
2786 g_return_if_fail(doc
);
2788 type
= filetypes
[GEANY_FILETYPES_NONE
];
2790 if (filetype_changed
)
2792 doc
->file_type
= type
;
2794 /* delete tm file object to force creation of a new one */
2795 if (doc
->tm_file
!= NULL
)
2797 tm_workspace_remove_source_file(doc
->tm_file
);
2798 tm_source_file_free(doc
->tm_file
);
2799 doc
->tm_file
= NULL
;
2801 /* load tags files before highlighting (some lexers highlight global typenames) */
2802 if (type
->id
!= GEANY_FILETYPES_NONE
)
2803 symbols_global_tags_loaded(type
->id
);
2805 highlighting_set_styles(doc
->editor
->sci
, type
);
2806 editor_set_indentation_guides(doc
->editor
);
2807 build_menu_update(doc
);
2808 queue_colourise(doc
);
2809 if (type
->priv
->symbol_list_sort_mode
== SYMBOLS_SORT_USE_PREVIOUS
)
2810 doc
->priv
->symbol_list_sort_mode
= interface_prefs
.symbols_sort_mode
;
2812 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2815 document_update_tags(doc
);
2819 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2820 * @param doc The document to use.
2821 * @param type The filetype. */
2823 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2825 gboolean ft_changed
;
2826 GeanyFiletype
*old_ft
;
2828 g_return_if_fail(doc
);
2830 type
= filetypes
[GEANY_FILETYPES_NONE
];
2832 old_ft
= doc
->file_type
;
2833 geany_debug("%s : %s (%s)",
2834 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2836 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2838 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2839 document_load_config(doc
, type
, ft_changed
);
2843 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2845 /* assume that if previous filetype was none and the settings are the default ones, this
2846 * is the first time the filetype is carefully set, so we should apply indent settings */
2847 if ((! old_ft
|| old_ft
->id
== GEANY_FILETYPES_NONE
) &&
2848 doc
->editor
->indent_type
== iprefs
->type
&&
2849 doc
->editor
->indent_width
== iprefs
->width
)
2851 document_apply_indent_settings(doc
);
2852 ui_document_show_hide(doc
);
2855 sidebar_openfiles_update(doc
); /* to update the icon */
2856 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2861 void document_reload_config(GeanyDocument
*doc
)
2863 document_load_config(doc
, doc
->file_type
, TRUE
);
2868 * Sets the encoding of a document.
2869 * This function only set the encoding of the %document, it does not any conversions. The new
2870 * encoding is used when e.g. saving the file.
2872 * @param doc The document to use.
2873 * @param new_encoding The encoding to be set for the document.
2876 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2878 if (doc
== NULL
|| new_encoding
== NULL
||
2879 utils_str_equal(new_encoding
, doc
->encoding
))
2882 g_free(doc
->encoding
);
2883 doc
->encoding
= g_strdup(new_encoding
);
2885 ui_update_statusbar(doc
, -1);
2886 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2887 encodings_is_unicode_charset(doc
->encoding
));
2891 /* own Undo / Redo implementation to be able to undo / redo changes
2892 * to the encoding or the Unicode BOM (which are Scintilla independet).
2893 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2895 /* Clears an Undo or Redo buffer. */
2896 void document_undo_clear_stack(GTrashStack
**stack
)
2898 while (g_trash_stack_height(stack
) > 0)
2900 undo_action
*a
= g_trash_stack_pop(stack
);
2902 if (G_LIKELY(a
!= NULL
))
2908 g_free(a
->data
); break;
2917 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2918 void document_undo_clear(GeanyDocument
*doc
)
2920 document_undo_clear_stack(&doc
->priv
->undo_actions
);
2921 document_undo_clear_stack(&doc
->priv
->redo_actions
);
2923 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2924 document_set_text_changed(doc
, FALSE
);
2928 /* Adds an undo action without clearing the redo stack. This function should
2929 * not be called directly, generally (use document_undo_add() instead), but is
2930 * used by document_redo() in order not to erase the redo stack while moving
2931 * an action from the redo stack to the undo stack. */
2932 void document_undo_add_internal(GeanyDocument
*doc
, guint type
, gpointer data
)
2934 undo_action
*action
;
2936 g_return_if_fail(doc
!= NULL
);
2938 action
= g_new0(undo_action
, 1);
2939 action
->type
= type
;
2940 action
->data
= data
;
2942 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2944 /* avoid unnecessary redraws */
2945 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2946 document_set_text_changed(doc
, TRUE
);
2948 ui_update_popup_reundo_items(doc
);
2951 /* note: this is called on SCN_MODIFIED notifications */
2952 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2954 /* Clear the redo actions stack before adding the undo action. */
2955 document_undo_clear_stack(&doc
->priv
->redo_actions
);
2957 document_undo_add_internal(doc
, type
, data
);
2961 gboolean
document_can_undo(GeanyDocument
*doc
)
2963 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2965 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2972 static void update_changed_state(GeanyDocument
*doc
)
2975 (sci_is_modified(doc
->editor
->sci
) ||
2976 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2977 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2978 document_set_text_changed(doc
, doc
->changed
);
2982 void document_undo(GeanyDocument
*doc
)
2984 undo_action
*action
;
2986 g_return_if_fail(doc
!= NULL
);
2988 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2990 if (G_UNLIKELY(action
== NULL
))
2992 /* fallback, should not be necessary */
2993 geany_debug("%s: fallback used", G_STRFUNC
);
2994 sci_undo(doc
->editor
->sci
);
2998 switch (action
->type
)
3000 case UNDO_SCINTILLA
:
3002 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
3004 sci_undo(doc
->editor
->sci
);
3009 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
3011 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
3012 ui_update_statusbar(doc
, -1);
3013 ui_document_show_hide(doc
);
3018 /* use the "old" encoding */
3019 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
3021 document_set_encoding(doc
, (const gchar
*)action
->data
);
3022 g_free(action
->data
);
3024 ui_update_statusbar(doc
, -1);
3025 ui_document_show_hide(doc
);
3030 undo_action
*next_action
;
3032 document_redo_add(doc
, UNDO_EOL
, GINT_TO_POINTER(sci_get_eol_mode(doc
->editor
->sci
)));
3034 sci_set_eol_mode(doc
->editor
->sci
, GPOINTER_TO_INT(action
->data
));
3036 ui_update_statusbar(doc
, -1);
3037 ui_document_show_hide(doc
);
3039 /* When undoing, UNDO_EOL is always followed by UNDO_SCINTILLA
3040 * which undos the line endings in the editor and should be
3041 * performed together with UNDO_EOL. */
3042 next_action
= g_trash_stack_peek(&doc
->priv
->undo_actions
);
3043 if (next_action
&& next_action
->type
== UNDO_SCINTILLA
)
3049 UndoReloadData
*data
= (UndoReloadData
*)action
->data
;
3050 gint eol_mode
= data
->eol_mode
;
3053 /* We reuse 'data' for the redo action, so read the current EOL mode
3054 * into it before proceeding. */
3055 data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
3057 /* Undo the rest of the actions which are part of the reloading process. */
3058 for (i
= 0; i
< data
->actions_count
; i
++)
3061 /* Restore the previous EOL mode. */
3062 sci_set_eol_mode(doc
->editor
->sci
, eol_mode
);
3063 /* This might affect the status bar and document menu, so update them. */
3064 ui_update_statusbar(doc
, -1);
3065 ui_document_show_hide(doc
);
3067 document_redo_add(doc
, UNDO_RELOAD
, data
);
3073 g_free(action
); /* free the action which was taken from the stack */
3075 update_changed_state(doc
);
3076 ui_update_popup_reundo_items(doc
);
3080 gboolean
document_can_redo(GeanyDocument
*doc
)
3082 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3084 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
3091 void document_redo(GeanyDocument
*doc
)
3093 undo_action
*action
;
3095 g_return_if_fail(doc
!= NULL
);
3097 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
3099 if (G_UNLIKELY(action
== NULL
))
3101 /* fallback, should not be necessary */
3102 geany_debug("%s: fallback used", G_STRFUNC
);
3103 sci_redo(doc
->editor
->sci
);
3107 switch (action
->type
)
3109 case UNDO_SCINTILLA
:
3111 undo_action
*next_action
;
3113 document_undo_add_internal(doc
, UNDO_SCINTILLA
, NULL
);
3115 sci_redo(doc
->editor
->sci
);
3117 /* When redoing an EOL change, the UNDO_SCINTILLA which changes
3118 * the line ends in the editor is followed by UNDO_EOL
3119 * which should be performed together with UNDO_SCINTILLA. */
3120 next_action
= g_trash_stack_peek(&doc
->priv
->redo_actions
);
3121 if (next_action
!= NULL
&& next_action
->type
== UNDO_EOL
)
3127 document_undo_add_internal(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
3129 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
3130 ui_update_statusbar(doc
, -1);
3131 ui_document_show_hide(doc
);
3136 document_undo_add_internal(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
3138 document_set_encoding(doc
, (const gchar
*)action
->data
);
3139 g_free(action
->data
);
3141 ui_update_statusbar(doc
, -1);
3142 ui_document_show_hide(doc
);
3147 document_undo_add_internal(doc
, UNDO_EOL
, GINT_TO_POINTER(sci_get_eol_mode(doc
->editor
->sci
)));
3149 sci_set_eol_mode(doc
->editor
->sci
, GPOINTER_TO_INT(action
->data
));
3151 ui_update_statusbar(doc
, -1);
3152 ui_document_show_hide(doc
);
3157 UndoReloadData
*data
= (UndoReloadData
*)action
->data
;
3158 gint eol_mode
= data
->eol_mode
;
3161 /* We reuse 'data' for the undo action, so read the current EOL mode
3162 * into it before proceeding. */
3163 data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
3165 /* Redo the rest of the actions which are part of the reloading process. */
3166 for (i
= 0; i
< data
->actions_count
; i
++)
3169 /* Restore the previous EOL mode. */
3170 sci_set_eol_mode(doc
->editor
->sci
, eol_mode
);
3171 /* This might affect the status bar and document menu, so update them. */
3172 ui_update_statusbar(doc
, -1);
3173 ui_document_show_hide(doc
);
3175 document_undo_add_internal(doc
, UNDO_RELOAD
, data
);
3181 g_free(action
); /* free the action which was taken from the stack */
3183 update_changed_state(doc
);
3184 ui_update_popup_reundo_items(doc
);
3188 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
3190 undo_action
*action
;
3192 g_return_if_fail(doc
!= NULL
);
3194 action
= g_new0(undo_action
, 1);
3195 action
->type
= type
;
3196 action
->data
= data
;
3198 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
3200 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
3201 document_set_text_changed(doc
, TRUE
);
3203 ui_update_popup_reundo_items(doc
);
3210 STATUS_DISK_CHANGED
,
3219 } document_status_styles
[] = {
3220 { "geany-document-status-changed", {0}, FALSE
},
3221 { "geany-document-status-disk-changed", {0}, FALSE
},
3222 { "geany-document-status-readonly", {0}, FALSE
}
3226 static gint
document_get_status_id(GeanyDocument
*doc
)
3229 return STATUS_CHANGED
;
3230 #ifdef USE_GIO_FILEMON
3231 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
3233 else if (doc
->priv
->protected)
3235 return STATUS_DISK_CHANGED
;
3236 else if (doc
->readonly
)
3237 return STATUS_READONLY
;
3243 /* returns an identifier that is to be set as a widget name or class to get it styled
3244 * depending on the document status (changed, readonly, etc.)
3245 * a NULL return value means default (unchanged) style */
3246 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
3250 g_return_val_if_fail(doc
!= NULL
, NULL
);
3252 status
= document_get_status_id(doc
);
3256 return document_status_styles
[status
].name
;
3261 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
3262 * Returned colors are red if the document has changes, green if the document is read-only
3263 * or simply @c NULL if the document is unmodified but writable.
3265 * @param doc The document to use.
3267 * @return @nullable The color for the document or @c NULL if the default color should be used.
3268 * The color object is owned by Geany and should not be modified or freed.
3273 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
3277 g_return_val_if_fail(doc
!= NULL
, NULL
);
3279 status
= document_get_status_id(doc
);
3282 if (! document_status_styles
[status
].loaded
)
3284 #if GTK_CHECK_VERSION(3, 0, 0)
3286 GtkWidgetPath
*path
= gtk_widget_path_new();
3287 GtkStyleContext
*ctx
= gtk_style_context_new();
3288 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
3289 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
3290 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
3291 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
3292 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
3293 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
3294 gtk_style_context_set_path(ctx
, path
);
3295 gtk_style_context_get_color(ctx
, gtk_style_context_get_state(ctx
), &color
);
3296 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
3297 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
3298 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
3299 document_status_styles
[status
].loaded
= TRUE
;
3300 gtk_widget_path_unref(path
);
3301 g_object_unref(ctx
);
3303 GtkSettings
*settings
= gtk_widget_get_settings(GTK_WIDGET(doc
->editor
->sci
));
3304 gchar
*path
= g_strconcat("GeanyMainWindow.GtkHBox.GtkNotebook.",
3305 document_status_styles
[status
].name
, NULL
);
3306 GtkStyle
*style
= gtk_rc_get_style_by_paths(settings
, path
, NULL
, GTK_TYPE_LABEL
);
3308 document_status_styles
[status
].color
= style
->fg
[GTK_STATE_NORMAL
];
3309 document_status_styles
[status
].loaded
= TRUE
;
3313 return &document_status_styles
[status
].color
;
3317 /** Accessor function for @ref GeanyData::documents_array items.
3318 * @warning Always check the returned document is valid (@c doc->is_valid).
3319 * @param idx @c GeanyData::documents_array index.
3320 * @return @transfer{none} @nullable The document, or @c NULL if @a idx is out of range.
3325 GeanyDocument
*document_index(gint idx
)
3327 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
3331 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
3335 ScintillaObject
*old_sci
;
3337 g_return_val_if_fail(old_doc
, NULL
);
3338 old_sci
= old_doc
->editor
->sci
;
3339 if (sci_has_selection(old_sci
))
3340 text
= sci_get_selection_contents(old_sci
);
3342 text
= sci_get_contents(old_sci
, -1);
3344 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
3346 document_set_text_changed(doc
, TRUE
);
3348 /* copy file properties */
3349 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
3350 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
3351 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
3352 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
3353 old_doc
->editor
->indent_width
);
3354 doc
->readonly
= old_doc
->readonly
;
3355 doc
->has_bom
= old_doc
->has_bom
;
3356 doc
->priv
->protected = 0;
3357 document_set_encoding(doc
, old_doc
->encoding
);
3358 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
3359 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
3362 ui_document_show_hide(doc
);
3367 /* @note If successful, this should always be followed up with a call to
3368 * document_close_all().
3369 * @return TRUE if all files were saved or had their changes discarded. */
3370 gboolean
document_account_for_unsaved(void)
3372 guint i
, p
, page_count
;
3374 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
3375 /* iterate over documents in tabs order */
3376 for (p
= 0; p
< page_count
; p
++)
3378 GeanyDocument
*doc
= document_get_from_page(p
);
3380 if (DOC_VALID(doc
) && doc
->changed
)
3382 if (! dialogs_show_unsaved_file(doc
))
3386 /* all documents should now be accounted for, so ignore any changes */
3387 foreach_document (i
)
3389 documents
[i
]->changed
= FALSE
;
3395 static void force_close_all(void)
3397 guint i
, len
= documents_array
->len
;
3399 /* check all documents have been accounted for */
3400 for (i
= 0; i
< len
; i
++)
3402 if (documents
[i
]->is_valid
)
3404 g_return_if_fail(!documents
[i
]->changed
);
3407 main_status
.closing_all
= TRUE
;
3411 document_close(documents
[i
]);
3414 main_status
.closing_all
= FALSE
;
3418 gboolean
document_close_all(void)
3420 if (! document_account_for_unsaved())
3430 * Shows a message related to a document.
3432 * Use this whenever the user needs to see a document-related message,
3433 * for example when the file was externally modified or deleted.
3435 * Any of the buttons can be @c NULL. If not @c NULL, @a btn_1's
3436 * @a response_1 response will be the default for the @c GtkInfoBar or
3439 * @param doc @c GeanyDocument.
3440 * @param msgtype The type of message.
3441 * @param response_cb A callback function called when there's a response.
3442 * @param btn_1 The first action area button.
3443 * @param response_1 The response for @a btn_1.
3444 * @param btn_2 The second action area button.
3445 * @param response_2 The response for @a btn_2.
3446 * @param btn_3 The third action area button.
3447 * @param response_3 The response for @a btn_3.
3448 * @param extra_text Text to show below the main message.
3449 * @param format The text format for the main message.
3450 * @param ... Used with @a format as in @c printf.
3454 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
3455 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
3456 const gchar
*btn_1
, GtkResponseType response_1
,
3457 const gchar
*btn_2
, GtkResponseType response_2
,
3458 const gchar
*btn_3
, GtkResponseType response_3
,
3459 const gchar
*extra_text
, const gchar
*format
, ...)
3462 gchar
*text
, *markup
;
3463 GtkWidget
*hbox
, *icon
, *label
, *content_area
;
3464 GtkWidget
*info_widget
, *parent
;
3465 parent
= document_get_notebook_child(doc
);
3467 va_start(args
, format
);
3468 text
= g_strdup_vprintf(format
, args
);
3471 markup
= g_strdup_printf("<span size=\"larger\">%s</span>", text
);
3474 info_widget
= gtk_info_bar_new();
3475 /* must be done now else Gtk-WARNING: widget not within a GtkWindow */
3476 gtk_box_pack_start(GTK_BOX(parent
), info_widget
, FALSE
, TRUE
, 0);
3478 gtk_info_bar_set_message_type(GTK_INFO_BAR(info_widget
), msgtype
);
3481 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_1
, response_1
);
3483 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_2
, response_2
);
3485 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_3
, response_3
);
3487 content_area
= gtk_info_bar_get_content_area(GTK_INFO_BAR(info_widget
));
3489 label
= geany_wrap_label_new(NULL
);
3490 gtk_label_set_markup(GTK_LABEL(label
), markup
);
3493 g_signal_connect(info_widget
, "response", G_CALLBACK(response_cb
), doc
);
3495 hbox
= gtk_hbox_new(FALSE
, 12);
3496 gtk_box_pack_start(GTK_BOX(content_area
), hbox
, TRUE
, TRUE
, 0);
3500 case GTK_MESSAGE_INFO
:
3501 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_INFO
, GTK_ICON_SIZE_DIALOG
);
3503 case GTK_MESSAGE_WARNING
:
3504 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_WARNING
, GTK_ICON_SIZE_DIALOG
);
3506 case GTK_MESSAGE_QUESTION
:
3507 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_QUESTION
, GTK_ICON_SIZE_DIALOG
);
3509 case GTK_MESSAGE_ERROR
:
3510 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_ERROR
, GTK_ICON_SIZE_DIALOG
);
3518 gtk_box_pack_start(GTK_BOX(hbox
), icon
, FALSE
, TRUE
, 0);
3522 GtkWidget
*vbox
= gtk_vbox_new(FALSE
, 6);
3523 GtkWidget
*extra_label
= geany_wrap_label_new(extra_text
);
3525 gtk_box_pack_start(GTK_BOX(vbox
), label
, TRUE
, TRUE
, 0);
3526 gtk_box_pack_start(GTK_BOX(vbox
), extra_label
, TRUE
, TRUE
, 0);
3527 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, TRUE
, TRUE
, 0);
3530 gtk_box_pack_start(GTK_BOX(hbox
), label
, TRUE
, TRUE
, 0);
3532 gtk_box_reorder_child(GTK_BOX(parent
), info_widget
, 0);
3534 gtk_widget_show_all(info_widget
);
3540 static void on_monitor_reload_file_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
3542 gboolean close
= FALSE
;
3544 // disable info bar so actions complete normally
3545 unprotect_document(doc
);
3546 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = NULL
;
3548 if (response_id
== RESPONSE_DOCUMENT_RELOAD
)
3550 close
= doc
->changed
?
3551 document_reload_prompt(doc
, doc
->encoding
) :
3552 document_reload_force(doc
, doc
->encoding
);
3554 else if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3556 close
= document_save_file(doc
, TRUE
); // force overwrite
3558 else if (response_id
== GTK_RESPONSE_CANCEL
)
3560 document_set_text_changed(doc
, TRUE
);
3565 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3566 protect_document(doc
);
3569 gtk_widget_destroy(bar
);
3573 static gboolean
on_sci_key(GtkWidget
*widget
, GdkEventKey
*event
, gpointer data
)
3575 GtkInfoBar
*bar
= GTK_INFO_BAR(data
);
3577 g_return_val_if_fail(event
->type
== GDK_KEY_PRESS
, FALSE
);
3579 switch (event
->keyval
)
3582 case GDK_ISO_Left_Tab
:
3584 GtkWidget
*action_area
= gtk_info_bar_get_action_area(bar
);
3585 GtkDirectionType dir
= event
->keyval
== GDK_Tab
? GTK_DIR_TAB_FORWARD
: GTK_DIR_TAB_BACKWARD
;
3586 gtk_widget_child_focus(action_area
, dir
);
3591 gtk_info_bar_response(bar
, GTK_RESPONSE_CANCEL
);
3600 /* Sets up a signal handler to intercept some keys during the lifetime of the GtkInfoBar */
3601 static void enable_key_intercept(GeanyDocument
*doc
, GtkWidget
*bar
)
3603 /* automatically focus editor again on bar close */
3604 g_signal_connect_object(bar
, "destroy", G_CALLBACK(gtk_widget_grab_focus
), doc
->editor
->sci
,
3606 g_signal_connect_object(doc
->editor
->sci
, "key-press-event", G_CALLBACK(on_sci_key
), bar
, 0);
3610 static void monitor_reload_file(GeanyDocument
*doc
)
3612 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
3614 /* show this message only once */
3615 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] == NULL
)
3619 bar
= document_show_message(doc
, GTK_MESSAGE_QUESTION
, on_monitor_reload_file_response
,
3620 _("_Reload"), RESPONSE_DOCUMENT_RELOAD
,
3621 _("_Overwrite"), RESPONSE_DOCUMENT_SAVE
,
3622 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3623 _("Do you want to reload it?"),
3624 _("The file '%s' on the disk is more recent than the current buffer."),
3627 protect_document(doc
);
3628 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3629 enable_key_intercept(doc
, bar
);
3635 static void on_monitor_resave_missing_file_response(GtkWidget
*bar
,
3639 gboolean close
= TRUE
;
3641 unprotect_document(doc
);
3643 if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3644 close
= dialogs_show_save_as();
3648 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = NULL
;
3649 gtk_widget_destroy(bar
);
3653 /* protect back the document if save didn't occur */
3654 protect_document(doc
);
3659 static void monitor_resave_missing_file(GeanyDocument
*doc
)
3661 if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] == NULL
)
3663 GtkWidget
*bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
3665 if (bar
!= NULL
) /* the "file on disk is newer" warning is now moot */
3666 gtk_info_bar_response(GTK_INFO_BAR(bar
), GTK_RESPONSE_CANCEL
);
3668 bar
= document_show_message(doc
, GTK_MESSAGE_WARNING
,
3669 on_monitor_resave_missing_file_response
,
3670 GTK_STOCK_SAVE
, RESPONSE_DOCUMENT_SAVE
,
3671 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3672 NULL
, GTK_RESPONSE_NONE
,
3673 _("Try to resave the file?"),
3674 _("File \"%s\" was not found on disk!"),
3677 protect_document(doc
);
3678 document_set_text_changed(doc
, TRUE
);
3679 /* don't prompt more than once */
3680 SETPTR(doc
->real_path
, NULL
);
3681 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = bar
;
3682 enable_key_intercept(doc
, bar
);
3687 /* Set force to force a disk check, otherwise it is ignored if there was a check
3688 * in the last file_prefs.disk_check_timeout seconds.
3689 * @return @c TRUE if the file has changed. */
3690 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3692 gboolean ret
= FALSE
;
3693 gboolean use_gio_filemon
;
3695 gchar
*locale_filename
;
3696 FileDiskStatus old_status
;
3698 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3700 /* ignore remote files and documents that have never been saved to disk */
3701 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3702 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3705 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3707 if (use_gio_filemon
)
3709 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3714 time_t cur_time
= time(NULL
);
3716 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3719 doc
->priv
->last_check
= cur_time
;
3722 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3723 if (!get_mtime(locale_filename
, &mtime
))
3725 monitor_resave_missing_file(doc
);
3726 /* doc may be closed now */
3729 else if (doc
->priv
->mtime
< mtime
)
3731 /* make sure the user is not prompted again after he cancelled the "reload file?" message */
3732 doc
->priv
->mtime
= mtime
;
3733 monitor_reload_file(doc
);
3734 /* doc may be closed now */
3737 g_free(locale_filename
);
3740 { /* doc can get invalid when a document was closed */
3741 old_status
= doc
->priv
->file_disk_status
;
3742 doc
->priv
->file_disk_status
= FILE_OK
;
3743 if (old_status
!= doc
->priv
->file_disk_status
)
3744 ui_update_tab_status(doc
);
3750 /** Compares documents by their display names.
3751 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3752 * @note 'Display name' means the base name of the document's filename.
3754 * @param a @c GeanyDocument**.
3755 * @param b @c GeanyDocument**.
3756 * @warning The arguments take the address of each document pointer.
3757 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3762 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3764 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3765 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3766 gchar
*base_name_a
, *base_name_b
;
3769 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3770 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3772 result
= strcmp(base_name_a
, base_name_b
);
3774 g_free(base_name_a
);
3775 g_free(base_name_b
);
3781 /** Compares documents by their tab order.
3782 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3784 * @param a @c GeanyDocument**.
3785 * @param b @c GeanyDocument**.
3786 * @warning The arguments take the address of each document pointer.
3787 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3789 * @since 0.21 (GEANY_API_VERSION 209)
3792 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3794 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3795 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3796 gint notebook_position_doc_a
;
3797 gint notebook_position_doc_b
;
3799 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3800 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3802 if (notebook_position_doc_a
< notebook_position_doc_b
)
3804 if (notebook_position_doc_a
> notebook_position_doc_b
)
3811 /** Compares documents by their tab order, in reverse order.
3812 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3814 * @param a @c GeanyDocument**.
3815 * @param b @c GeanyDocument**.
3816 * @warning The arguments take the address of each document pointer.
3817 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3819 * @since 0.21 (GEANY_API_VERSION 209)
3822 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3824 return -1 * document_compare_by_tab_order(a
, b
);
3828 void document_grab_focus(GeanyDocument
*doc
)
3830 g_return_if_fail(doc
!= NULL
);
3832 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));
3835 static void *copy_(void *src
) { return src
; }
3836 static void free_(void *doc
) { }
3839 * Gets the GType of GeanyDocument
3841 * @return the GeanyDocument type */
3843 GType
document_get_type (void);
3845 G_DEFINE_BOXED_TYPE(GeanyDocument
, document
, copy_
, free_
);
3848 gpointer
document_get_data(const GeanyDocument
*doc
, const gchar
*key
)
3850 return g_datalist_get_data(&doc
->priv
->data
, key
);
3854 void document_set_data(GeanyDocument
*doc
, const gchar
*key
, gpointer data
)
3856 g_datalist_set_data(&doc
->priv
->data
, key
, data
);
3860 void document_set_data_full(GeanyDocument
*doc
, const gchar
*key
,
3861 gpointer data
, GDestroyNotify free_func
)
3863 g_datalist_set_data_full(&doc
->priv
->data
, key
, data
, free_func
);