2 * document.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 * Document related actions: new, save, open, etc.
23 * Also Scintilla search actions.
33 #include "callbacks.h" /* for ignore_callback */
35 #include "documentprivate.h"
36 #include "encodings.h"
37 #include "encodingsprivate.h"
38 #include "filetypesprivate.h"
39 #include "geany.h" /* FIXME: why is this needed for DOC_FILENAME()? should come from documentprivate.h/document.h */
40 #include "geanyobject.h"
41 #include "geanywraplabel.h"
42 #include "highlighting.h"
44 #include "msgwindow.h"
48 #include "sciwrappers.h"
57 #ifdef HAVE_SYS_TIME_H
58 # include <sys/time.h>
66 #ifdef HAVE_SYS_TYPES_H
67 # include <sys/types.h>
72 /* gstdio.h also includes sys/stat.h */
73 #include <glib/gstdio.h>
75 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
76 /*#define USE_GIO_FILEMON 1*/
80 #include <gdk/gdkkeysyms.h>
83 #define USE_GIO_FILE_OPERATIONS (!file_prefs.use_safe_file_saving && file_prefs.use_gio_unsafe_file_saving)
86 GeanyFilePrefs file_prefs
;
87 GPtrArray
*documents_array
= NULL
;
90 /* an undo action, also used for redo actions */
93 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
94 guint type
; /* to identify the action */
95 gpointer
*data
; /* the old value (before the change), in case of a redo action
96 * it contains the new value */
99 /* Custom document info bar response IDs */
102 RESPONSE_DOCUMENT_RELOAD
= 1,
103 RESPONSE_DOCUMENT_SAVE
,
107 static guint doc_id_counter
= 0;
110 static void document_undo_clear_stack(GTrashStack
**stack
);
111 static void document_undo_clear(GeanyDocument
*doc
);
112 static void document_undo_add_internal(GeanyDocument
*doc
, guint type
, gpointer data
);
113 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
114 static gboolean
remove_page(guint page_num
);
115 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
116 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
117 const gchar
*btn_1
, GtkResponseType response_1
,
118 const gchar
*btn_2
, GtkResponseType response_2
,
119 const gchar
*btn_3
, GtkResponseType response_3
,
120 const gchar
*extra_text
, const gchar
*format
, ...) G_GNUC_PRINTF(11, 12);
124 * Finds a document whose @c real_path field matches the given filename.
126 * @param realname The filename to search, which should be identical to the
127 * string returned by @c utils_get_real_path().
129 * @return @transfer{none} @nullable The matching document, or @c NULL.
130 * @note This is only really useful when passing a @c TMSourceFile::file_name.
131 * @see GeanyDocument::real_path.
132 * @see document_find_by_filename().
137 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
142 return NULL
; /* file doesn't exist on disk */
144 for (i
= 0; i
< documents_array
->len
; i
++)
146 GeanyDocument
*doc
= documents
[i
];
148 if (! doc
->is_valid
|| ! doc
->real_path
)
151 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
160 /* dereference symlinks, /../ junk in path and return locale encoding */
161 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
163 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
164 gchar
*realname
= utils_get_real_path(locale_name
);
172 * Finds a document with the given filename.
173 * This matches either an exact GeanyDocument::file_name string, or variant
174 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
177 * @param utf8_filename The filename to search (in UTF-8 encoding).
179 * @return @transfer{none} @nullable The matching document, or @c NULL.
180 * @see document_find_by_real_path().
183 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
189 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
191 /* First search GeanyDocument::file_name, so we can find documents with a
192 * filename set but not saved on disk, like vcdiff produces */
193 for (i
= 0; i
< documents_array
->len
; i
++)
197 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
200 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
205 /* Now try matching based on the realpath(), which is unique per file on disk */
206 realname
= get_real_path_from_utf8(utf8_filename
);
207 doc
= document_find_by_real_path(realname
);
213 /* returns the document which has sci, or NULL. */
214 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
218 g_return_val_if_fail(sci
!= NULL
, NULL
);
220 for (i
= 0; i
< documents_array
->len
; i
++)
222 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
229 /** Lookup an old document by its ID.
230 * Useful when the corresponding document may have been closed since the
232 * @param id The ID of the document to find
233 * @return @transfer{none} @c NULL if the document is no longer open.
238 * GeanyDocument *doc = ...;
239 * id = doc->id; // store ID
241 * // time passes - the document may have been closed by now
242 * GeanyDocument *doc = document_find_by_id(id);
243 * gboolean still_open = (doc != NULL);
247 GeanyDocument
*document_find_by_id(guint id
)
256 if (documents
[i
]->id
== id
)
263 /* gets the widget the main_widgets.notebook consider is its child for this document */
264 static GtkWidget
*document_get_notebook_child(GeanyDocument
*doc
)
269 g_return_val_if_fail(doc
!= NULL
, NULL
);
271 child
= GTK_WIDGET(doc
->editor
->sci
);
272 parent
= gtk_widget_get_parent(child
);
273 /* search for the direct notebook child, mirroring document_get_from_page() */
274 while (parent
&& ! GTK_IS_NOTEBOOK(parent
))
277 parent
= gtk_widget_get_parent(child
);
284 /** Gets the notebook page index for a document.
285 * @param doc The document.
289 gint
document_get_notebook_page(GeanyDocument
*doc
)
291 GtkWidget
*child
= document_get_notebook_child(doc
);
293 return gtk_notebook_page_num(GTK_NOTEBOOK(main_widgets
.notebook
), child
);
298 * Recursively searches a containers children until it finds a
299 * Scintilla widget, or NULL if one was not found.
301 static ScintillaObject
*locate_sci_in_container(GtkWidget
*container
)
303 ScintillaObject
*sci
= NULL
;
304 GList
*children
, *iter
;
306 g_return_val_if_fail(GTK_IS_CONTAINER(container
), NULL
);
308 children
= gtk_container_get_children(GTK_CONTAINER(container
));
309 for (iter
= children
; iter
!= NULL
; iter
= g_list_next(iter
))
311 if (IS_SCINTILLA(iter
->data
))
313 sci
= SCINTILLA(iter
->data
);
316 else if (GTK_IS_CONTAINER(iter
->data
))
318 sci
= locate_sci_in_container(iter
->data
);
319 if (IS_SCINTILLA(sci
))
324 g_list_free(children
);
330 /* Finds the document for the given notebook page widget */
331 GeanyDocument
*document_get_from_notebook_child(GtkWidget
*page
)
333 ScintillaObject
*sci
;
335 g_return_val_if_fail(GTK_IS_BOX(page
), NULL
);
337 sci
= locate_sci_in_container(page
);
338 g_return_val_if_fail(IS_SCINTILLA(sci
), NULL
);
340 return document_find_by_sci(sci
);
345 * Finds the document for the given notebook page @a page_num.
347 * @param page_num The notebook page number to search.
349 * @return @transfer{none} @nullable The corresponding document for the given notebook page, or @c NULL.
352 GeanyDocument
*document_get_from_page(guint page_num
)
356 if (page_num
>= documents_array
->len
)
359 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
361 return document_get_from_notebook_child(parent
);
366 * Finds the current document.
368 * @return @transfer{none} @nullable A pointer to the current document or @c NULL if there are no opened documents.
371 GeanyDocument
*document_get_current(void)
373 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
378 return document_get_from_page((guint
) cur_page
);
382 void document_init_doclist(void)
384 documents_array
= g_ptr_array_new();
388 void document_finalize(void)
392 for (i
= 0; i
< documents_array
->len
; i
++)
393 g_free(documents
[i
]);
394 g_ptr_array_free(documents_array
, TRUE
);
399 * Returns the last part of the filename of the given GeanyDocument. The result is also
400 * truncated to a maximum of @a length characters in case the filename is very long.
402 * @param doc The document to use.
403 * @param length The length of the resulting string or -1 to use a default value.
405 * @return The ellipsized last part of the filename of @a doc, should be freed when no
410 /* TODO make more use of this */
412 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
414 gchar
*base_name
, *short_name
;
416 g_return_val_if_fail(doc
!= NULL
, NULL
);
421 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
422 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
430 void document_update_tab_label(GeanyDocument
*doc
)
435 g_return_if_fail(doc
!= NULL
);
437 short_name
= document_get_basename_for_display(doc
, -1);
439 /* we need to use the event box for the tooltip, labels don't get the necessary events */
440 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
441 parent
= gtk_widget_get_parent(parent
);
443 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
445 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
452 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
453 * according to the document's save state.
454 * This is called by Geany mostly when opening or saving files.
456 * @param doc The document to use.
457 * @param changed Whether the document state should indicate changes have been made.
460 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
462 g_return_if_fail(doc
!= NULL
);
464 doc
->changed
= changed
;
466 if (! main_status
.quitting
)
468 ui_update_tab_status(doc
);
469 ui_save_buttons_toggle(changed
);
470 ui_set_window_title(doc
);
471 ui_update_statusbar(doc
, -1);
476 /* returns the next free place in the document list,
477 * or -1 if the documents_array is full */
478 static gint
document_get_new_idx(void)
482 for (i
= 0; i
< documents_array
->len
; i
++)
484 if (documents
[i
]->editor
== NULL
)
493 static void queue_colourise(GeanyDocument
*doc
)
495 if (doc
->priv
->colourise_needed
)
498 /* Colourise the editor before it is next drawn */
499 doc
->priv
->colourise_needed
= TRUE
;
501 /* If the editor doesn't need drawing (e.g. after saving the current
502 * document), we need to force a redraw, so the expose event is triggered.
503 * This ensures we don't start colourising before all documents are opened/saved,
504 * only once the editor is drawn. */
505 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
509 #ifdef USE_GIO_FILEMON
510 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
511 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
514 g_return_if_fail(doc
!= NULL
);
516 if (file_prefs
.disk_check_timeout
== 0)
519 geany_debug("%s: event: %d previous file status: %d",
520 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
523 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
525 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
526 doc
->priv
->file_disk_status
= FILE_OK
;
528 doc
->priv
->file_disk_status
= FILE_CHANGED
;
529 g_message("%s: FILE_CHANGED", G_STRFUNC
);
532 case G_FILE_MONITOR_EVENT_DELETED
:
534 doc
->priv
->file_disk_status
= FILE_CHANGED
;
535 g_message("%s: FILE_MISSING", G_STRFUNC
);
541 if (doc
->priv
->file_disk_status
!= FILE_OK
)
543 ui_update_tab_status(doc
);
549 static void document_stop_file_monitoring(GeanyDocument
*doc
)
551 g_return_if_fail(doc
!= NULL
);
553 if (doc
->priv
->monitor
!= NULL
)
555 g_object_unref(doc
->priv
->monitor
);
556 doc
->priv
->monitor
= NULL
;
561 static void monitor_file_setup(GeanyDocument
*doc
)
563 g_return_if_fail(doc
!= NULL
);
564 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
565 * doesn't work at all for remote files and legacy polling is too slow. */
566 if (! doc
->priv
->is_remote
)
568 #ifdef USE_GIO_FILEMON
569 gchar
*locale_filename
;
571 /* stop any previous monitoring */
572 document_stop_file_monitoring(doc
);
574 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
575 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
577 /* get a file monitor and connect to the 'changed' signal */
578 GFile
*file
= g_file_new_for_path(locale_filename
);
579 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
580 g_signal_connect(doc
->priv
->monitor
, "changed",
581 G_CALLBACK(monitor_file_changed_cb
), doc
);
583 /* we set the rate limit according to the GUI pref but it's most probably not used */
584 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
586 g_object_unref(file
);
588 g_free(locale_filename
);
591 doc
->priv
->file_disk_status
= FILE_OK
;
595 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
597 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
600 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
601 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
603 if (source_widget
== NULL
)
604 source_widget
= doc
->priv
->tag_tree
;
606 if (focusw
== source_widget
)
607 gtk_widget_grab_focus(sci
);
612 static gboolean
on_idle_focus(gpointer doc
)
614 document_try_focus(doc
, NULL
);
619 /* Creates a new document and editor, adding a tab in the notebook.
620 * @return The created document */
621 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
625 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
629 doc
= document_get_current();
630 /* remove the empty document first */
631 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
632 /* prevent immediately opening another new doc with
633 * new_document_after_close pref */
637 new_idx
= document_get_new_idx();
638 if (new_idx
== -1) /* expand the array, no free places */
640 doc
= g_new0(GeanyDocument
, 1);
642 new_idx
= documents_array
->len
;
643 g_ptr_array_add(documents_array
, doc
);
646 doc
= documents
[new_idx
];
648 /* initialize default document settings */
649 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
650 doc
->id
= ++doc_id_counter
;
651 doc
->index
= new_idx
;
652 doc
->file_name
= g_strdup(utf8_filename
);
653 doc
->editor
= editor_create(doc
);
654 #ifndef USE_GIO_FILEMON
655 doc
->priv
->last_check
= time(NULL
);
658 g_datalist_init(&doc
->priv
->data
);
660 sidebar_openfiles_add(doc
); /* sets doc->iter */
662 notebook_new_tab(doc
);
664 /* select document in sidebar */
666 GtkTreeSelection
*sel
;
668 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
669 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
672 ui_document_buttons_update();
674 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
680 * Closes the given document.
682 * @param doc The document to remove.
684 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
689 gboolean
document_close(GeanyDocument
*doc
)
691 g_return_val_if_fail(doc
, FALSE
);
693 return document_remove_page(document_get_notebook_page(doc
));
697 /* Call document_remove_page() instead, this is only needed for document_create()
698 * to prevent re-opening a new document when the last document is closed (if enabled). */
699 static gboolean
remove_page(guint page_num
)
701 GeanyDocument
*doc
= document_get_from_page(page_num
);
703 g_return_val_if_fail(doc
!= NULL
, FALSE
);
705 /* if we're closing all, document_account_for_unsaved() has been called already, no need to ask again. */
706 if (! main_status
.closing_all
&& doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
709 /* tell any plugins that the document is about to be closed */
710 g_signal_emit_by_name(geany_object
, "document-close", doc
);
712 /* Checking real_path makes it likely the file exists on disk */
713 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
714 ui_add_recent_document(doc
);
716 g_datalist_clear(&doc
->priv
->data
);
718 doc
->is_valid
= FALSE
;
721 if (main_status
.quitting
)
723 /* we need to destroy the ScintillaWidget so our handlers on it are
724 * disconnected before we free any data they may use (like the editor).
725 * when not quitting, this is handled by removing the notebook page. */
726 gtk_notebook_remove_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
730 notebook_remove_page(page_num
);
731 sidebar_remove_document(doc
);
732 navqueue_remove_file(doc
->file_name
);
733 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
735 g_free(doc
->encoding
);
736 g_free(doc
->priv
->saved_encoding
.encoding
);
737 g_free(doc
->file_name
);
738 g_free(doc
->real_path
);
741 tm_workspace_remove_source_file(doc
->tm_file
);
742 tm_source_file_free(doc
->tm_file
);
745 if (doc
->priv
->tag_tree
)
746 gtk_widget_destroy(doc
->priv
->tag_tree
);
748 editor_destroy(doc
->editor
);
749 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
751 document_stop_file_monitoring(doc
);
753 document_undo_clear(doc
);
757 /* reset document settings to defaults for re-use */
758 memset(doc
, 0, sizeof(GeanyDocument
));
760 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
762 sidebar_update_tag_list(NULL
, FALSE
);
763 ui_set_window_title(NULL
);
764 ui_save_buttons_toggle(FALSE
);
765 ui_update_popup_reundo_items(NULL
);
766 ui_document_buttons_update();
767 build_menu_update(NULL
);
774 * Removes the given notebook tab at @a page_num and clears all related information
775 * in the document list.
777 * @param page_num The notebook page number to remove.
779 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
782 gboolean
document_remove_page(guint page_num
)
784 gboolean done
= remove_page(page_num
);
786 if (done
&& ui_prefs
.new_document_after_close
)
787 document_new_file_if_non_open();
793 /* used to keep a record of the unchanged document state encoding */
794 static void store_saved_encoding(GeanyDocument
*doc
)
796 g_free(doc
->priv
->saved_encoding
.encoding
);
797 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
798 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
802 /* Opens a new empty document only if there are no other documents open */
803 GeanyDocument
*document_new_file_if_non_open(void)
805 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
806 return document_new_file(NULL
, NULL
, NULL
);
813 * Creates a new document.
814 * Line endings in @a text will be converted to the default setting.
815 * Afterwards, the @c "document-new" signal is emitted for plugins.
817 * @param utf8_filename @nullable The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
818 * @param ft @nullable The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
819 * @param text @nullable The initial content of the file (in UTF-8 encoding), or @c NULL.
821 * @return @transfer{none} The new document.
824 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
828 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
831 tmp
= utils_strdupa(utf8_filename
); /* work around const */
832 utils_tidy_path(tmp
);
835 doc
= document_create(utf8_filename
);
837 g_assert(doc
!= NULL
);
839 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
842 GString
*template = g_string_new(text
);
843 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
845 sci_set_text(doc
->editor
->sci
, template->str
);
846 g_string_free(template, TRUE
);
849 sci_clear_all(doc
->editor
->sci
);
851 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
853 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
854 sci_empty_undo_buffer(doc
->editor
->sci
);
856 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
857 /* store the opened encoding for undo/redo */
858 store_saved_encoding(doc
);
860 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
861 ft
= filetypes_detect_from_document(doc
);
863 document_set_filetype(doc
, ft
); /* also re-parses tags */
865 /* now the document is fully ready, display it (see notebook_new_tab()) */
866 gtk_widget_show(document_get_notebook_child(doc
));
868 ui_set_window_title(doc
);
869 build_menu_update(doc
);
870 document_set_text_changed(doc
, FALSE
);
871 ui_document_show_hide(doc
); /* update the document menu */
873 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
874 /* bring it in front, jump to the start and grab the focus */
875 editor_goto_pos(doc
->editor
, 0, FALSE
);
876 document_try_focus(doc
, NULL
);
878 #ifdef USE_GIO_FILEMON
879 monitor_file_setup(doc
);
881 doc
->priv
->mtime
= 0;
884 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
885 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
887 g_signal_emit_by_name(geany_object
, "document-new", doc
);
889 msgwin_status_add(_("New file \"%s\" opened."),
897 * Opens a document specified by @a locale_filename.
898 * Afterwards, the @c "document-open" signal is emitted for plugins.
900 * @param locale_filename The filename of the document to load, in locale encoding.
901 * @param readonly Whether to open the document in read-only mode.
902 * @param ft @nullable The filetype for the document or @c NULL to auto-detect the filetype.
903 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
905 * @return @transfer{none} @nullable The document opened or @c NULL.
908 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
909 GeanyFiletype
*ft
, const gchar
*forced_enc
)
911 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
917 gchar
*data
; /* null-terminated file data */
918 gsize len
; /* string length of data */
921 time_t mtime
; /* modification time, read by stat::st_mtime */
926 static gboolean
get_mtime(const gchar
*locale_filename
, time_t *time
)
928 GError
*error
= NULL
;
929 const gchar
*err_msg
= NULL
;
931 if (USE_GIO_FILE_OPERATIONS
)
933 GFile
*file
= g_file_new_for_path(locale_filename
);
934 GFileInfo
*info
= g_file_query_info(file
, G_FILE_ATTRIBUTE_TIME_MODIFIED
, G_FILE_QUERY_INFO_NONE
, NULL
, &error
);
940 g_file_info_get_modification_time(info
, &timeval
);
941 g_object_unref(info
);
942 *time
= timeval
.tv_sec
;
945 err_msg
= error
->message
;
947 g_object_unref(file
);
953 if (g_stat(locale_filename
, &st
) == 0)
956 err_msg
= g_strerror(errno
);
961 gchar
*utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
963 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
964 utf8_filename
, err_msg
);
965 g_free(utf8_filename
);
971 return err_msg
== NULL
;
975 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
976 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
977 FileData
*filedata
, const gchar
*forced_enc
)
981 filedata
->data
= NULL
;
983 filedata
->enc
= NULL
;
984 filedata
->bom
= FALSE
;
985 filedata
->readonly
= FALSE
;
987 if (!get_mtime(locale_filename
, &filedata
->mtime
))
990 if (USE_GIO_FILE_OPERATIONS
)
992 GFile
*file
= g_file_new_for_path(locale_filename
);
994 g_file_load_contents(file
, NULL
, &filedata
->data
, &filedata
->len
, NULL
, &err
);
995 g_object_unref(file
);
998 g_file_get_contents(locale_filename
, &filedata
->data
, &filedata
->len
, &err
);
1002 ui_set_statusbar(TRUE
, "%s", err
->message
);
1007 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
1008 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
1012 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
1013 display_filename
, forced_enc
);
1017 ui_set_statusbar(TRUE
,
1018 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
1021 g_free(filedata
->data
);
1025 if (filedata
->readonly
)
1027 const gchar
*warn_msg
= _(
1028 "The file \"%s\" could not be opened properly and has been truncated. " \
1029 "This can occur if the file contains a NULL byte. " \
1030 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
1032 if (main_status
.main_window_realized
)
1033 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
1035 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
1042 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
1043 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
1044 * if cl_options.goto_column is set.
1046 * returns the new position which may have changed */
1047 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
1049 if (cl_options
.goto_line
>= 0)
1050 { /* goto line which was specified on command line and then undefine the line */
1051 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
1052 editor
->scroll_percent
= 0.5F
;
1053 cl_options
.goto_line
= -1;
1057 sci_set_current_position(editor
->sci
, pos
, FALSE
);
1058 editor
->scroll_percent
= 0.5F
;
1061 if (cl_options
.goto_column
>= 0)
1062 { /* goto column which was specified on command line and then undefine the column */
1064 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
1065 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
1066 editor
->scroll_percent
= 0.5F
;
1067 cl_options
.goto_column
= -1;
1070 return sci_get_current_position(editor
->sci
);
1074 /* Count lines that start with some hard tabs then a soft tab. */
1075 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
1077 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1078 ScintillaObject
*sci
= editor
->sci
;
1080 struct Sci_TextToFind ttf
;
1081 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
1082 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
1087 ttf
.chrg
.cpMax
= sci_get_length(sci
);
1088 ttf
.lpstrText
= regex
;
1093 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
1095 break; /* no more matches */
1097 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
1100 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
1101 return count
> sci_get_line_count(sci
) * 0.02;
1105 /* Detect the indent type based on counting the leading indent characters for each line.
1106 * Returns whether detection succeeded, and the detected type in *type_ upon success */
1107 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
1109 GeanyEditor
*editor
= doc
->editor
;
1110 ScintillaObject
*sci
= editor
->sci
;
1111 gint line
, line_count
;
1112 gsize tabs
= 0, spaces
= 0;
1114 if (detect_tabs_and_spaces(editor
))
1116 *type_
= GEANY_INDENT_TYPE_BOTH
;
1120 line_count
= sci_get_line_count(sci
);
1121 for (line
= 0; line
< line_count
; line
++)
1123 gint pos
= sci_get_position_from_line(sci
, line
);
1126 /* most code will have indent total <= 24, otherwise it's more likely to be
1127 * alignment than indentation */
1128 if (sci_get_line_indentation(sci
, line
) > 24)
1131 c
= sci_get_char_at(sci
, pos
);
1134 /* check for at least 2 spaces */
1135 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
1138 if (spaces
== 0 && tabs
== 0)
1141 /* the factors may need to be tweaked */
1142 if (spaces
> tabs
* 4)
1143 *type_
= GEANY_INDENT_TYPE_SPACES
;
1144 else if (tabs
> spaces
* 4)
1145 *type_
= GEANY_INDENT_TYPE_TABS
;
1147 *type_
= GEANY_INDENT_TYPE_BOTH
;
1153 /* Detect the indent width based on counting the leading indent characters for each line.
1154 * Returns whether detection succeeded, and the detected width in *width_ upon success */
1155 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
1157 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1158 ScintillaObject
*sci
= editor
->sci
;
1159 gint line
, line_count
;
1160 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
1161 gint count
, width
, i
;
1163 /* can't easily detect the supposed width of a tab, guess the default is OK */
1164 if (type
== GEANY_INDENT_TYPE_TABS
)
1167 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
1168 sci_set_tab_width(sci
, 8);
1170 line_count
= sci_get_line_count(sci
);
1171 for (line
= 0; line
< line_count
; line
++)
1173 gint pos
= sci_get_line_indent_position(sci
, line
);
1175 /* We probably don't have style info yet, because we're generally called just after
1176 * the document got created, so we can't use highlighting_is_code_style().
1177 * That's not good, but the assumption below that concerning lines start with an
1178 * asterisk (common continuation character for C/C++/Java/...) should do the trick
1179 * without removing too much legitimate lines. */
1180 if (sci_get_char_at(sci
, pos
) == '*')
1183 width
= sci_get_line_indentation(sci
, line
);
1184 /* most code will have indent total <= 24, otherwise it's more likely to be
1185 * alignment than indentation */
1188 /* < 2 is no indentation */
1192 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1194 if ((width
% (i
+ 2)) == 0)
1199 width
= iprefs
->width
;
1200 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1202 /* give large indents higher weight not to be fooled by spurious indents */
1203 if (widths
[i
] >= count
* 1.5)
1218 /* same as detect_indent_width() but uses editor's indent type */
1219 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1221 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1225 void document_apply_indent_settings(GeanyDocument
*doc
)
1227 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1228 GeanyIndentType type
= iprefs
->type
;
1229 gint width
= iprefs
->width
;
1231 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1233 if (type
!= iprefs
->type
)
1235 const gchar
*name
= NULL
;
1239 case GEANY_INDENT_TYPE_SPACES
:
1242 case GEANY_INDENT_TYPE_TABS
:
1245 case GEANY_INDENT_TYPE_BOTH
:
1246 name
= _("Tabs and Spaces");
1249 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1250 * and Spaces), the second one is the filename */
1251 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1255 else if (doc
->file_type
->indent_type
> -1)
1256 type
= doc
->file_type
->indent_type
;
1258 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1260 if (width
!= iprefs
->width
)
1262 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1266 else if (doc
->file_type
->indent_width
> -1)
1267 width
= doc
->file_type
->indent_width
;
1269 editor_set_indent(doc
->editor
, type
, width
);
1273 void document_show_tab(GeanyDocument
*doc
)
1275 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1276 document_get_notebook_page(doc
));
1280 /* To open a new file, set doc to NULL; filename should be locale encoded.
1281 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1282 * pos is the cursor position, which can be overridden by --line and --column.
1283 * forced_enc can be NULL to detect the file encoding.
1284 * Returns: doc of the opened file or NULL if an error occurred. */
1285 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1286 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1289 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1290 gchar
*utf8_filename
= NULL
;
1291 gchar
*display_filename
= NULL
;
1292 gchar
*locale_filename
= NULL
;
1293 GeanyFiletype
*use_ft
;
1295 UndoReloadData
*undo_reload_data
;
1296 gboolean add_undo_reload_action
;
1298 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, NULL
);
1302 utf8_filename
= g_strdup(doc
->file_name
);
1303 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1307 /* filename must not be NULL when opening a file */
1308 g_return_val_if_fail(filename
, NULL
);
1311 /* if filename is a shortcut, try to resolve it */
1312 locale_filename
= win32_get_shortcut_target(filename
);
1314 locale_filename
= g_strdup(filename
);
1316 /* remove relative junk */
1317 utils_tidy_path(locale_filename
);
1319 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1320 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1322 /* if file is already open, switch to it and go */
1323 doc
= document_find_by_filename(utf8_filename
);
1326 ui_add_recent_document(doc
); /* either add or reorder recent item */
1327 /* show the doc before reload dialog */
1328 document_show_tab(doc
);
1329 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1332 if (reload
|| doc
== NULL
)
1333 { /* doc possibly changed */
1334 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1336 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1338 g_free(display_filename
);
1339 g_free(utf8_filename
);
1340 g_free(locale_filename
);
1346 doc
= document_create(utf8_filename
);
1347 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1349 /* file exists on disk, set real_path */
1350 SETPTR(doc
->real_path
, utils_get_real_path(locale_filename
));
1352 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1353 monitor_file_setup(doc
);
1356 if (! reload
|| ! file_prefs
.keep_edit_history_on_reload
)
1358 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1359 sci_empty_undo_buffer(doc
->editor
->sci
);
1360 undo_reload_data
= NULL
;
1364 undo_reload_data
= (UndoReloadData
*) g_malloc(sizeof(UndoReloadData
));
1366 /* We will be adding a UNDO_RELOAD action to the undo stack that undoes
1367 * this reload. To do that, we keep collecting undo actions during
1368 * reloading, and at the end add an UNDO_RELOAD action that performs
1369 * all these actions in bulk. To keep track of how many undo actions
1370 * were added during this time, we compare the current undo-stack height
1371 * with its height at the end of the process. Note that g_trash_stack_height()
1372 * is O(N), which is a little ugly, but this seems like the most maintainable
1374 undo_reload_data
->actions_count
= g_trash_stack_height(&doc
->priv
->undo_actions
);
1376 /* We use add_undo_reload_action to track any changes to the document that
1377 * require adding an undo action to revert the reload, but that do not
1378 * generate an undo action themselves. */
1379 add_undo_reload_action
= FALSE
;
1382 /* add the text to the ScintillaObject */
1383 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1384 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1385 queue_colourise(doc
); /* Ensure the document gets colourised. */
1387 /* detect & set line endings */
1388 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1389 if (undo_reload_data
)
1391 undo_reload_data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
1392 /* Force adding an undo-reload action if the EOL mode changed. */
1393 if (editor_mode
!= undo_reload_data
->eol_mode
)
1394 add_undo_reload_action
= TRUE
;
1396 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1397 g_free(filedata
.data
);
1399 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1401 /* If reloading and the current and new encodings or BOM states differ,
1402 * add appropriate undo actions. */
1403 if (undo_reload_data
)
1405 if (! utils_str_equal(doc
->encoding
, filedata
.enc
))
1406 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
1407 if (doc
->has_bom
!= filedata
.bom
)
1408 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
1411 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1412 g_free(doc
->encoding
); /* if reloading, free old encoding */
1413 doc
->encoding
= filedata
.enc
;
1414 doc
->has_bom
= filedata
.bom
;
1415 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1417 doc
->readonly
= readonly
|| filedata
.readonly
;
1418 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1419 doc
->priv
->protected = 0;
1421 /* update line number margin width */
1422 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1423 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
1428 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1429 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1432 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1436 if (undo_reload_data
)
1438 /* Calculate the number of undo actions that are part of the reloading
1439 * process, and add the UNDO_RELOAD action. */
1440 undo_reload_data
->actions_count
=
1441 g_trash_stack_height(&doc
->priv
->undo_actions
) - undo_reload_data
->actions_count
;
1443 /* We only add an undo-reload action if the document has actually changed.
1444 * At the time of writing, this condition is moot because sci_set_text
1445 * generates an undo action even when the text hasn't really changed, so
1446 * actions_count is always greater than zero. In the future this might change.
1447 * It's arguable whether we should add an undo-reload action unconditionally,
1448 * especially since it's possible (if unlikely) that there had only
1449 * been "invisible" changes to the document, such as changes in encoding and
1450 * EOL mode, but for the time being that's how we roll. */
1451 if (undo_reload_data
->actions_count
> 0 || add_undo_reload_action
)
1452 document_undo_add(doc
, UNDO_RELOAD
, undo_reload_data
);
1454 g_free(undo_reload_data
);
1456 /* We didn't save the document per-se, but its contents are now
1457 * synchronized with the file on disk, hence set a save point here.
1458 * We need to do this in this case only, because we don't clear
1459 * Scintilla's undo stack. */
1460 sci_set_savepoint(doc
->editor
->sci
);
1463 document_undo_clear(doc
);
1467 /* update taglist, typedef keywords and build menu if necessary */
1468 document_set_filetype(doc
, use_ft
);
1470 /* set indentation settings after setting the filetype */
1472 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1474 document_apply_indent_settings(doc
);
1476 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1477 ui_document_show_hide(doc
); /* update the document menu */
1479 /* finally add current file to recent files menu, but not the files from the last session */
1480 if (! main_status
.opening_session_files
)
1481 ui_add_recent_document(doc
);
1485 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1486 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1490 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1491 /* For translators: this is the status window message for opening a file. %d is the number
1492 * of the newly opened file, %s indicates whether the file is opened read-only
1493 * (it is replaced with the string ", read-only"). */
1494 msgwin_status_add(_("File %s opened (%d%s)."),
1495 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1496 (readonly
) ? _(", read-only") : "");
1499 /* now the document is fully ready, display it (see notebook_new_tab()) */
1500 gtk_widget_show(document_get_notebook_child(doc
));
1503 g_free(display_filename
);
1504 g_free(utf8_filename
);
1505 g_free(locale_filename
);
1507 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1508 pos
= set_cursor_position(doc
->editor
, pos
);
1509 /* now bring the file in front */
1510 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1512 /* finally, let the editor widget grab the focus so you can start coding
1514 g_idle_add(on_idle_focus
, doc
);
1519 /* Takes a new line separated list of filename URIs and opens each file.
1520 * length is the length of the string */
1521 void document_open_file_list(const gchar
*data
, gsize length
)
1526 g_return_if_fail(data
!= NULL
);
1528 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1530 /* stop at the end or first empty item, because last item is empty but not null */
1531 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1533 gchar
*filename
= utils_get_path_from_uri(list
[i
]);
1535 if (filename
== NULL
)
1537 document_open_file(filename
, FALSE
, NULL
, NULL
);
1546 * Opens each file in the list @a filenames.
1547 * Internally, document_open_file() is called for every list item.
1549 * @param filenames @elementtype{filename} A list of filenames to load, in locale encoding.
1550 * @param readonly Whether to open the document in read-only mode.
1551 * @param ft @nullable The filetype for the document or @c NULL to auto-detect the filetype.
1552 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
1555 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1556 const gchar
*forced_enc
)
1560 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1562 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1567 static void on_keep_edit_history_on_reload_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
1569 if (response_id
== GTK_RESPONSE_NO
)
1571 file_prefs
.keep_edit_history_on_reload
= FALSE
;
1572 document_reload_force(doc
, doc
->encoding
);
1574 else if (response_id
== GTK_RESPONSE_CANCEL
)
1576 /* this condition cannot be reached via info bar buttons, but by our code
1577 * to replace this bar with a higher priority one */
1578 file_prefs
.show_keep_edit_history_on_reload_msg
= TRUE
;
1580 doc
->priv
->info_bars
[MSG_TYPE_POST_RELOAD
] = NULL
;
1581 gtk_widget_destroy(bar
);
1586 * Reloads the document with the specified file encoding.
1587 * @a forced_enc or @c NULL to auto-detect the file encoding.
1589 * @param doc The document to reload.
1590 * @param forced_enc @nullable The file encoding to use or @c NULL to auto-detect the file encoding.
1592 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1595 gboolean
document_reload_force(GeanyDocument
*doc
, const gchar
*forced_enc
)
1598 GeanyDocument
*new_doc
;
1601 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1603 /* Cancel resave bar if still open from previous file deletion */
1604 if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] != NULL
)
1605 gtk_info_bar_response(GTK_INFO_BAR(doc
->priv
->info_bars
[MSG_TYPE_RESAVE
]), GTK_RESPONSE_CANCEL
);
1607 /* Use cancel because the response handler would call this recursively */
1608 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] != NULL
)
1609 gtk_info_bar_response(GTK_INFO_BAR(doc
->priv
->info_bars
[MSG_TYPE_RELOAD
]), GTK_RESPONSE_CANCEL
);
1611 /* try to set the cursor to the position before reloading */
1612 pos
= sci_get_current_position(doc
->editor
->sci
);
1613 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1615 if (file_prefs
.keep_edit_history_on_reload
&& file_prefs
.show_keep_edit_history_on_reload_msg
)
1617 bar
= document_show_message(doc
, GTK_MESSAGE_INFO
,
1618 on_keep_edit_history_on_reload_response
,
1619 GTK_STOCK_OK
, GTK_RESPONSE_ACCEPT
,
1620 _("Discard history"), GTK_RESPONSE_NO
,
1621 NULL
, 0, _("The buffer's previous state is stored in the history and "
1622 "undoing restores it. You can disable this by discarding the history upon "
1623 "reload. This message will not be displayed again but "
1624 "your choice can be changed in the various preferences."),
1625 _("The file has been reloaded."));
1626 doc
->priv
->info_bars
[MSG_TYPE_POST_RELOAD
] = bar
;
1627 file_prefs
.show_keep_edit_history_on_reload_msg
= FALSE
;
1630 return (new_doc
!= NULL
);
1634 /* also used for reloading when forced_enc is NULL */
1635 gboolean
document_reload_prompt(GeanyDocument
*doc
, const gchar
*forced_enc
)
1638 gboolean prompt
, result
= FALSE
;
1640 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1642 /* No need to reload "untitled" (non-file-backed) documents */
1643 if (doc
->file_name
== NULL
)
1646 if (forced_enc
== NULL
)
1647 forced_enc
= doc
->encoding
;
1649 base_name
= g_path_get_basename(doc
->file_name
);
1650 /* don't prompt if edit history is maintained, or if file hasn't been edited at all */
1651 prompt
= !file_prefs
.keep_edit_history_on_reload
&&
1652 (doc
->changed
|| (document_can_undo(doc
) || document_can_redo(doc
)));
1654 if (!prompt
|| dialogs_show_question_full(NULL
, _("_Reload"), GTK_STOCK_CANCEL
,
1655 doc
->changed
? _("Any unsaved changes will be lost.") :
1656 _("Undo history will be lost."),
1657 _("Are you sure you want to reload '%s'?"), base_name
))
1659 result
= document_reload_force(doc
, forced_enc
);
1660 if (forced_enc
!= NULL
)
1661 ui_update_statusbar(doc
, -1);
1668 static void document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1670 #ifndef USE_GIO_FILEMON
1671 g_return_if_fail(doc
!= NULL
);
1673 get_mtime(locale_filename
, &doc
->priv
->mtime
); /* get the modification time from file and keep it */
1678 /* Sets line and column to the given position byte_pos in the document.
1679 * byte_pos is the position counted in bytes, not characters */
1680 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1685 /* for some reason we can use byte count instead of character count here */
1686 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1687 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1688 /* get the column in the line */
1689 *column
= byte_pos
- line_start
;
1691 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1692 * skip one byte(i++) and decrease the column number which is based on byte count */
1693 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1695 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1704 static void replace_header_filename(GeanyDocument
*doc
)
1708 struct Sci_TextToFind ttf
;
1710 g_return_if_fail(doc
!= NULL
);
1711 g_return_if_fail(doc
->file_type
!= NULL
);
1713 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1714 if (doc
->file_type
->extension
)
1715 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1717 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1719 filename
= g_path_get_basename(doc
->file_name
);
1721 /* only search the first 3 lines */
1723 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1724 ttf
.lpstrText
= filebase
;
1726 if (search_find_text(doc
->editor
->sci
, GEANY_FIND_MATCHCASE
| GEANY_FIND_REGEXP
, &ttf
, NULL
) != -1)
1728 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1729 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1730 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1738 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1739 * you still have to call @ref document_save_file_as() to change the @a doc object.
1740 * It also stops monitoring for file changes to prevent receiving too many file change events
1741 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1743 * @param doc The current document which should be renamed.
1744 * @param new_filename The new filename in UTF-8 encoding.
1749 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1751 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1752 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1755 /* stop file monitoring to avoid getting events for deleting/creating files,
1756 * it's re-setup in document_save_file_as() */
1757 document_stop_file_monitoring(doc
);
1759 result
= g_rename(old_locale_filename
, new_locale_filename
);
1762 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1763 _("Error renaming file."), g_strerror(errno
));
1765 g_free(old_locale_filename
);
1766 g_free(new_locale_filename
);
1770 static void protect_document(GeanyDocument
*doc
)
1772 /* do not call queue_colourise because to we want to keep the text-changed indication! */
1773 if (!doc
->priv
->protected++)
1774 sci_set_readonly(doc
->editor
->sci
, TRUE
);
1776 ui_update_tab_status(doc
);
1780 static void unprotect_document(GeanyDocument
*doc
)
1782 g_return_if_fail(doc
->priv
->protected > 0);
1784 if (!--doc
->priv
->protected && doc
->readonly
== FALSE
)
1785 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1787 ui_update_tab_status(doc
);
1791 /* Return TRUE if the document doesn't have a full filename set.
1792 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1793 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1795 gboolean
document_need_save_as(GeanyDocument
*doc
)
1797 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1799 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1804 * Saves the document, detecting the filetype.
1806 * @param doc The document for the file to save.
1807 * @param utf8_fname @nullable The new name for the document, in UTF-8, or @c NULL.
1808 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1810 * @see document_save_file().
1815 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1820 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1822 new_file
= document_need_save_as(doc
) || (utf8_fname
!= NULL
&& strcmp(doc
->file_name
, utf8_fname
) != 0);
1823 if (utf8_fname
!= NULL
)
1824 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1826 /* reset real path, it's retrieved again in document_save() */
1827 SETPTR(doc
->real_path
, NULL
);
1829 /* detect filetype */
1830 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1832 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1834 document_set_filetype(doc
, ft
);
1835 if (document_get_current() == doc
)
1837 ignore_callback
= TRUE
;
1838 filetypes_select_radio_item(doc
->file_type
);
1839 ignore_callback
= FALSE
;
1845 // assume user wants to throw away read-only setting
1846 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1847 doc
->readonly
= FALSE
;
1848 if (doc
->priv
->protected > 0)
1849 unprotect_document(doc
);
1852 replace_header_filename(doc
);
1854 ret
= document_save_file(doc
, TRUE
);
1856 /* file monitoring support, add file monitoring after the file has been saved
1857 * to ignore any earlier events */
1858 monitor_file_setup(doc
);
1859 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1862 ui_add_recent_document(doc
);
1867 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1869 GError
*conv_error
= NULL
;
1870 gchar
* conv_file_contents
= NULL
;
1874 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1875 g_return_val_if_fail(len
!= NULL
, FALSE
);
1877 /* try to convert it from UTF-8 to original encoding */
1878 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1879 &bytes_read
, &conv_len
, &conv_error
);
1881 if (conv_error
!= NULL
)
1883 gchar
*text
= g_strdup_printf(
1884 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1888 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1893 /* don't read over the doc length */
1894 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1895 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1896 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1898 /* take only one valid Unicode character from the context and discard the leftover */
1899 unic
= g_utf8_get_char_validated(context
, -1);
1900 context_len
= g_unichar_to_utf8(unic
, context
);
1901 context
[context_len
] = '\0';
1902 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1904 error_text
= g_strdup_printf(
1905 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1906 conv_error
->message
, context
, line
+ 1, column
);
1909 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1911 geany_debug("encoding error: %s", conv_error
->message
);
1912 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1913 g_error_free(conv_error
);
1921 *data
= conv_file_contents
;
1928 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1929 const gchar
*data
, gsize len
)
1931 GError
*error
= NULL
;
1933 if (file_prefs
.use_safe_file_saving
)
1935 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1936 * This is the only option that handles disk space exhaustion. */
1937 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1938 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1940 else if (USE_GIO_FILE_OPERATIONS
)
1944 /* Use GIO API to save file (GVFS-safe)
1945 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1946 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1947 fp
= g_file_new_for_path(locale_filename
);
1948 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1949 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1956 gchar
*display_name
= g_filename_display_name(locale_filename
);
1958 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1959 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1961 fp
= g_fopen(locale_filename
, "wb");
1968 g_file_error_from_errno(save_errno
),
1969 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1971 g_strerror(save_errno
));
1975 gsize bytes_written
;
1978 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1980 if (len
!= bytes_written
)
1986 g_file_error_from_errno(save_errno
),
1987 _("Failed to write file '%s': fwrite() failed: %s"),
1989 g_strerror(save_errno
));
1993 /* preserve the fwrite() error if any */
1994 if (fclose(fp
) != 0 && error
== NULL
)
2000 g_file_error_from_errno(save_errno
),
2001 _("Failed to close file '%s': fclose() failed: %s"),
2003 g_strerror(save_errno
));
2007 g_free(display_name
);
2011 gchar
*msg
= g_strdup(error
->message
);
2012 g_error_free(error
);
2013 /* geany will warn about file truncation for unsafe saving below */
2020 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
2021 const gchar
*data
, gsize len
)
2025 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
2026 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
2028 err
= write_data_to_disk(locale_filename
, data
, len
);
2032 /* now the file is on disk, set real_path */
2033 if (doc
->real_path
== NULL
)
2035 doc
->real_path
= utils_get_real_path(locale_filename
);
2036 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
2037 monitor_file_setup(doc
);
2043 static gboolean
save_file_handle_infobars(GeanyDocument
*doc
, gboolean force
)
2045 GtkWidget
*bar
= NULL
;
2047 document_show_tab(doc
);
2049 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
])
2051 if (!dialogs_show_question_full(NULL
, _("_Overwrite"), GTK_STOCK_CANCEL
,
2053 _("The file '%s' on the disk is more recent than the current buffer."),
2056 bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
2058 else if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
])
2060 if (!dialogs_show_question_full(NULL
, GTK_STOCK_SAVE
, GTK_STOCK_CANCEL
,
2061 _("Try to resave the file?"),
2062 _("File \"%s\" was not found on disk!"),
2065 bar
= doc
->priv
->info_bars
[MSG_TYPE_RESAVE
];
2069 g_assert_not_reached();
2072 gtk_info_bar_response(GTK_INFO_BAR(bar
), RESPONSE_DOCUMENT_SAVE
);
2078 * Saves the document.
2079 * Also shows the Save As dialog if necessary.
2080 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
2082 * Saving may include replacing tabs with spaces,
2083 * stripping trailing spaces and adding a final new line at the end of the file, depending
2084 * on user preferences. Then the @c "document-before-save" signal is emitted,
2085 * allowing plugins to modify the document before it is saved, and data is
2086 * actually written to disk.
2088 * On successful saving:
2089 * - GeanyDocument::real_path is set.
2090 * - The filetype is set again or auto-detected if it wasn't set yet.
2091 * - The @c "document-save" signal is emitted for plugins.
2093 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
2094 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
2095 * added in Geany 1.22.
2097 * @param doc The document to save.
2098 * @param force Whether to save the file even if it is not modified.
2100 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
2103 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
2108 gchar
*locale_filename
;
2109 const GeanyFilePrefs
*fp
;
2111 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2113 if (document_need_save_as(doc
))
2115 /* ensure doc is the current tab before showing the dialog */
2116 document_show_tab(doc
);
2117 return dialogs_show_save_as();
2120 if (!force
&& !doc
->changed
)
2124 ui_set_statusbar(TRUE
,
2125 _("Cannot save read-only document '%s'!"), DOC_FILENAME(doc
));
2128 document_check_disk_status(doc
, TRUE
);
2129 if (doc
->priv
->protected)
2130 return save_file_handle_infobars(doc
, force
);
2132 fp
= project_get_file_prefs();
2133 /* replaces tabs with spaces but only if the current file is not a Makefile */
2134 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
2135 editor_replace_tabs(doc
->editor
, TRUE
);
2136 /* strip trailing spaces */
2137 if (fp
->strip_trailing_spaces
)
2138 editor_strip_trailing_spaces(doc
->editor
, TRUE
);
2139 /* ensure the file has a newline at the end */
2140 if (fp
->final_new_line
)
2141 editor_ensure_final_newline(doc
->editor
);
2142 /* ensure newlines are consistent */
2143 if (fp
->ensure_convert_new_lines
)
2144 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
2146 /* notify plugins which may wish to modify the document before it's saved */
2147 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
2149 len
= sci_get_length(doc
->editor
->sci
) + 1;
2150 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
2151 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
2152 * encoding, it will be converted to doc->encoding below and this conversion
2153 * also changes the BOM */
2154 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
2155 data
[0] = (gchar
) 0xef;
2156 data
[1] = (gchar
) 0xbb;
2157 data
[2] = (gchar
) 0xbf;
2158 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
2163 data
= (gchar
*) g_malloc(len
);
2164 sci_get_text(doc
->editor
->sci
, len
, data
);
2167 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
2168 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
2169 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
2171 if (! save_convert_to_encoding(doc
, &data
, &len
))
2182 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2184 /* ignore file changed notification when the file is written */
2185 doc
->priv
->file_disk_status
= FILE_IGNORE
;
2187 /* actually write the content of data to the file on disk */
2188 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
2193 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
2195 if (!file_prefs
.use_safe_file_saving
)
2198 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
2200 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
2201 doc
->priv
->file_disk_status
= FILE_OK
;
2203 g_free(locale_filename
);
2208 /* store the opened encoding for undo/redo */
2209 store_saved_encoding(doc
);
2211 /* ignore the following things if we are quitting */
2212 if (! main_status
.quitting
)
2214 sci_set_savepoint(doc
->editor
->sci
);
2216 if (file_prefs
.disk_check_timeout
> 0)
2217 document_update_timestamp(doc
, locale_filename
);
2219 /* update filetype-related things */
2220 document_set_filetype(doc
, doc
->file_type
);
2222 document_update_tab_label(doc
);
2224 msgwin_status_add(_("File %s saved."), doc
->file_name
);
2225 ui_update_statusbar(doc
, -1);
2227 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
2230 g_free(locale_filename
);
2232 g_signal_emit_by_name(geany_object
, "document-save", doc
);
2238 /* special search function, used from the find entry in the toolbar
2239 * return TRUE if text was found otherwise FALSE
2240 * return also TRUE if text is empty */
2241 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gboolean inc
,
2244 gint start_pos
, search_pos
;
2245 struct Sci_TextToFind ttf
;
2247 g_return_val_if_fail(text
!= NULL
, FALSE
);
2248 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2252 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
2253 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
2255 /* search cursor to end or start */
2256 ttf
.chrg
.cpMin
= start_pos
;
2257 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
2258 ttf
.lpstrText
= (gchar
*)text
;
2259 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2261 /* if no match, search start (or end) to cursor */
2262 if (search_pos
== -1)
2266 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
2267 ttf
.chrg
.cpMax
= start_pos
;
2272 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
2274 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2277 if (search_pos
!= -1)
2279 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2281 /* unfold maybe folded results */
2282 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
2284 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2285 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
2287 if (! editor_line_in_view(doc
->editor
, line
))
2288 { /* we need to force scrolling in case the cursor is outside of the current visible area
2289 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
2290 * while searching */
2291 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
2294 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
2301 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
2304 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
2310 /* General search function, used from the find dialog.
2311 * Returns -1 on failure or the start position of the matching text.
2312 * Will skip past any selection, ignoring it.
2314 * @param text Text to find.
2315 * @param original_text Text as it was entered by user, or @c NULL to use @c text
2317 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
2318 GeanyFindFlags flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
2319 gboolean scroll
, GtkWidget
*parent
)
2321 gint selection_end
, selection_start
, search_pos
;
2323 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
2327 /* Sci doesn't support searching backwards with a regex */
2328 if (flags
& GEANY_FIND_REGEXP
)
2329 search_backwards
= FALSE
;
2332 original_text
= text
;
2334 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2335 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2336 if ((selection_end
- selection_start
) > 0)
2337 { /* there's a selection so go to the end */
2338 if (search_backwards
)
2339 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2341 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2344 sci_set_search_anchor(doc
->editor
->sci
);
2345 if (search_backwards
)
2346 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
2348 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
2350 if (search_pos
!= -1)
2352 /* unfold maybe folded results */
2353 sci_ensure_line_is_visible(doc
->editor
->sci
,
2354 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
2356 doc
->editor
->scroll_percent
= 0.3F
;
2360 gint sci_len
= sci_get_length(doc
->editor
->sci
);
2362 /* if we just searched the whole text, give up searching. */
2363 if ((selection_end
== 0 && ! search_backwards
) ||
2364 (selection_end
== sci_len
&& search_backwards
))
2366 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
2371 /* we searched only part of the document, so ask whether to wraparound. */
2372 if (search_prefs
.always_wrap
||
2373 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
2374 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
2378 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
2379 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
2381 { /* return to original cursor position if not found */
2382 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
2391 /* Replaces the selection if it matches, otherwise just finds the next match.
2392 * Returns: start of replaced text, or -1 if no replacement was made
2394 * @param find_text Text to find.
2395 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
2397 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
2398 const gchar
*replace_text
, GeanyFindFlags flags
, gboolean search_backwards
)
2400 gint selection_end
, selection_start
, search_pos
;
2401 GeanyMatchInfo
*match
= NULL
;
2403 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
2408 /* Sci doesn't support searching backwards with a regex */
2409 if (flags
& GEANY_FIND_REGEXP
)
2410 search_backwards
= FALSE
;
2412 if (!original_find_text
)
2413 original_find_text
= find_text
;
2415 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2416 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2417 if (selection_end
== selection_start
)
2419 /* no selection so just find the next match */
2420 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2423 /* there's a selection so go to the start before finding to search through it
2424 * this ensures there is a match */
2425 if (search_backwards
)
2426 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2428 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2430 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2431 /* return if the original selected text did not match (at the start of the selection) */
2432 if (search_pos
!= selection_start
)
2434 if (search_pos
!= -1)
2435 geany_match_info_free(match
);
2439 if (search_pos
!= -1)
2441 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2442 /* select the replacement - find text will skip past the selected text */
2443 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2444 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2445 geany_match_info_free(match
);
2449 /* no match in the selection */
2456 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2457 const gchar
*original_replace_text
)
2463 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2467 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2468 ui_set_statusbar(TRUE
, ngettext(
2469 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2470 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2471 count
), filename
, count
, original_find_text
, original_replace_text
);
2476 /* Replace all text matches in a certain range within document.
2477 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2478 * or -1 if no text was found.
2479 * scroll_to_match is whether to scroll the last replacement in view (which also
2480 * clears the selection).
2481 * Returns: the number of replacements made. */
2483 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2484 GeanyFindFlags flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2487 struct Sci_TextToFind ttf
;
2488 ScintillaObject
*sci
;
2490 if (new_range_end
!= NULL
)
2491 *new_range_end
= -1;
2493 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2495 if (! *find_text
|| doc
->readonly
)
2498 sci
= doc
->editor
->sci
;
2500 ttf
.chrg
.cpMin
= start
;
2501 ttf
.chrg
.cpMax
= end
;
2502 ttf
.lpstrText
= (gchar
*)find_text
;
2504 sci_start_undo_action(sci
);
2505 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2506 sci_end_undo_action(sci
);
2509 { /* scroll last match in view, will destroy the existing selection */
2510 if (scroll_to_match
)
2511 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2513 if (new_range_end
!= NULL
)
2514 *new_range_end
= ttf
.chrg
.cpMax
;
2520 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2521 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2523 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2524 gint max_column
= 0, count
= 0;
2525 gboolean replaced
= FALSE
;
2527 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2532 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2533 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2534 /* do we have a selection? */
2535 if ((selection_end
- selection_start
) == 0)
2541 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2542 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2543 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2544 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2546 gint first_line
, line
;
2548 sci_start_undo_action(doc
->editor
->sci
);
2550 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2551 /* Find the last line with chars selected (not EOL char) */
2552 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2553 selection_end
- editor_get_eol_char_len(doc
->editor
));
2554 last_line
= MAX(first_line
, last_line
);
2555 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2557 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2558 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2560 /* skip line if there is no selection */
2561 if (line_start
!= INVALID_POSITION
)
2563 /* don't let document_replace_range() scroll to match to keep our selection */
2566 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2567 line_start
, line_end
, FALSE
, &new_sel_end
);
2568 if (new_sel_end
!= -1)
2571 /* this gets the greatest column within the selection after replacing */
2572 max_column
= MAX(max_column
,
2573 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2577 sci_end_undo_action(doc
->editor
->sci
);
2579 else /* handle normal line selection */
2581 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2582 selection_start
, selection_end
, TRUE
, &selection_end
);
2583 if (selection_end
!= -1)
2588 { /* update the selection for the new endpoint */
2590 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2592 /* now we can scroll to the selection and destroy it because we rebuild it later */
2593 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2595 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2596 * the highest column on the last line. The wrapped selection is completely different
2597 * from the original one, so skip the selection at all */
2598 /* TODO is there a better way to handle the wrapped selection? */
2599 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2600 { /* for keeping and adjusting the selection in multi line rectangle selection we
2601 * need the last line of the original selection and the greatest column number after
2602 * replacing and set the selection end to the last line at the greatest column */
2603 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2604 sci_set_selection_end(doc
->editor
->sci
,
2605 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2606 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2611 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2612 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2615 else /* no replacements */
2618 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2622 /* returns number of replacements made. */
2623 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2624 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2627 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2632 len
= sci_get_length(doc
->editor
->sci
);
2633 count
= document_replace_range(
2634 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2636 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2642 * Parses or re-parses the document's buffer and updates the type
2643 * keywords and symbol list.
2645 * @param doc The document.
2647 void document_update_tags(GeanyDocument
*doc
)
2652 g_return_if_fail(DOC_VALID(doc
));
2653 g_return_if_fail(app
->tm_workspace
!= NULL
);
2655 /* early out if it's a new file or doesn't support tags */
2656 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2658 /* We must call sidebar_update_tag_list() before returning,
2659 * to ensure that the symbol list is always updated properly (e.g.
2660 * when creating a new document with a partial filename set. */
2661 sidebar_update_tag_list(doc
, FALSE
);
2665 /* create a new TM file if there isn't one yet */
2668 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2671 /* lookup the name rather than using filetype name to support custom filetypes */
2672 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2673 doc
->tm_file
= tm_source_file_new(locale_filename
, name
);
2674 g_free(locale_filename
);
2677 tm_workspace_add_source_file_noupdate(doc
->tm_file
);
2680 /* early out if there's no tm source file and we couldn't create one */
2681 if (doc
->tm_file
== NULL
)
2683 /* We must call sidebar_update_tag_list() before returning,
2684 * to ensure that the symbol list is always updated properly (e.g.
2685 * when creating a new document with a partial filename set. */
2686 sidebar_update_tag_list(doc
, FALSE
);
2690 /* Parse Scintilla's buffer directly using TagManager
2691 * Note: this buffer *MUST NOT* be modified */
2692 len
= sci_get_length(doc
->editor
->sci
);
2693 buffer_ptr
= (guchar
*) SSM(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2694 tm_workspace_update_source_file_buffer(doc
->tm_file
, buffer_ptr
, len
);
2696 sidebar_update_tag_list(doc
, TRUE
);
2697 document_highlight_tags(doc
);
2701 /* Re-highlights type keywords without re-parsing the whole document. */
2702 void document_highlight_tags(GeanyDocument
*doc
)
2704 GString
*keywords_str
;
2707 /* some filetypes support type keywords (such as struct names), but not
2708 * necessarily all filetypes for a particular scintilla lexer. this
2709 * tells us whether the filetype supports keywords, and if so
2710 * which index to use for the scintilla keywords set. */
2711 switch (doc
->file_type
->id
)
2713 case GEANY_FILETYPES_C
:
2714 case GEANY_FILETYPES_CPP
:
2715 case GEANY_FILETYPES_CS
:
2716 case GEANY_FILETYPES_D
:
2717 case GEANY_FILETYPES_JAVA
:
2718 case GEANY_FILETYPES_OBJECTIVEC
:
2719 case GEANY_FILETYPES_VALA
:
2720 case GEANY_FILETYPES_RUST
:
2721 case GEANY_FILETYPES_GO
:
2724 /* index of the keyword set in the Scintilla lexer, for
2725 * example in LexCPP.cxx, see "cppWordLists" global array.
2726 * TODO: this magic number should be a member of the filetype */
2731 return; /* early out if type keywords are not supported */
2733 if (!app
->tm_workspace
->tags_array
)
2736 /* get any type keywords and tell scintilla about them
2737 * this will cause the type keywords to be colourized in scintilla */
2738 keywords_str
= symbols_find_typenames_as_string(doc
->file_type
->lang
, FALSE
);
2741 gchar
*keywords
= g_string_free(keywords_str
, FALSE
);
2742 guint hash
= g_str_hash(keywords
);
2744 if (hash
!= doc
->priv
->keyword_hash
)
2746 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2747 queue_colourise(doc
); /* force re-highlighting the entire document */
2748 doc
->priv
->keyword_hash
= hash
;
2755 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2757 GeanyDocument
*doc
= data
;
2759 if (! DOC_VALID(doc
))
2762 if (! main_status
.quitting
)
2763 document_update_tags(doc
);
2765 doc
->priv
->tag_list_update_source
= 0;
2767 /* don't update the tags until another modification of the buffer */
2772 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2774 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2777 /* prevent "stacking up" callback handlers, we only need one to run soon */
2778 if (doc
->priv
->tag_list_update_source
!= 0)
2779 g_source_remove(doc
->priv
->tag_list_update_source
);
2781 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2782 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2786 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2787 gboolean filetype_changed
)
2789 g_return_if_fail(doc
);
2791 type
= filetypes
[GEANY_FILETYPES_NONE
];
2793 if (filetype_changed
)
2795 doc
->file_type
= type
;
2797 /* delete tm file object to force creation of a new one */
2798 if (doc
->tm_file
!= NULL
)
2800 tm_workspace_remove_source_file(doc
->tm_file
);
2801 tm_source_file_free(doc
->tm_file
);
2802 doc
->tm_file
= NULL
;
2804 /* load tags files before highlighting (some lexers highlight global typenames) */
2805 if (type
->id
!= GEANY_FILETYPES_NONE
)
2806 symbols_global_tags_loaded(type
->id
);
2808 highlighting_set_styles(doc
->editor
->sci
, type
);
2809 editor_set_indentation_guides(doc
->editor
);
2810 build_menu_update(doc
);
2811 queue_colourise(doc
);
2812 if (type
->priv
->symbol_list_sort_mode
== SYMBOLS_SORT_USE_PREVIOUS
)
2813 doc
->priv
->symbol_list_sort_mode
= interface_prefs
.symbols_sort_mode
;
2815 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2818 document_update_tags(doc
);
2822 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2823 * @param doc The document to use.
2824 * @param type The filetype. */
2826 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2828 gboolean ft_changed
;
2829 GeanyFiletype
*old_ft
;
2831 g_return_if_fail(doc
);
2833 type
= filetypes
[GEANY_FILETYPES_NONE
];
2835 old_ft
= doc
->file_type
;
2836 geany_debug("%s : %s (%s)",
2837 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2839 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2841 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2842 document_load_config(doc
, type
, ft_changed
);
2846 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2848 /* assume that if previous filetype was none and the settings are the default ones, this
2849 * is the first time the filetype is carefully set, so we should apply indent settings */
2850 if ((! old_ft
|| old_ft
->id
== GEANY_FILETYPES_NONE
) &&
2851 doc
->editor
->indent_type
== iprefs
->type
&&
2852 doc
->editor
->indent_width
== iprefs
->width
)
2854 document_apply_indent_settings(doc
);
2855 ui_document_show_hide(doc
);
2858 sidebar_openfiles_update(doc
); /* to update the icon */
2859 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2864 void document_reload_config(GeanyDocument
*doc
)
2866 document_load_config(doc
, doc
->file_type
, TRUE
);
2871 * Sets the encoding of a document.
2872 * This function only set the encoding of the %document, it does not any conversions. The new
2873 * encoding is used when e.g. saving the file.
2875 * @param doc The document to use.
2876 * @param new_encoding The encoding to be set for the document.
2879 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2881 if (doc
== NULL
|| new_encoding
== NULL
||
2882 utils_str_equal(new_encoding
, doc
->encoding
))
2885 g_free(doc
->encoding
);
2886 doc
->encoding
= g_strdup(new_encoding
);
2888 ui_update_statusbar(doc
, -1);
2889 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2890 encodings_is_unicode_charset(doc
->encoding
));
2894 /* own Undo / Redo implementation to be able to undo / redo changes
2895 * to the encoding or the Unicode BOM (which are Scintilla independet).
2896 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2898 /* Clears an Undo or Redo buffer. */
2899 void document_undo_clear_stack(GTrashStack
**stack
)
2901 while (g_trash_stack_height(stack
) > 0)
2903 undo_action
*a
= g_trash_stack_pop(stack
);
2905 if (G_LIKELY(a
!= NULL
))
2911 g_free(a
->data
); break;
2920 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2921 void document_undo_clear(GeanyDocument
*doc
)
2923 document_undo_clear_stack(&doc
->priv
->undo_actions
);
2924 document_undo_clear_stack(&doc
->priv
->redo_actions
);
2926 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2927 document_set_text_changed(doc
, FALSE
);
2931 /* Adds an undo action without clearing the redo stack. This function should
2932 * not be called directly, generally (use document_undo_add() instead), but is
2933 * used by document_redo() in order not to erase the redo stack while moving
2934 * an action from the redo stack to the undo stack. */
2935 void document_undo_add_internal(GeanyDocument
*doc
, guint type
, gpointer data
)
2937 undo_action
*action
;
2939 g_return_if_fail(doc
!= NULL
);
2941 action
= g_new0(undo_action
, 1);
2942 action
->type
= type
;
2943 action
->data
= data
;
2945 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2947 /* avoid unnecessary redraws */
2948 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2949 document_set_text_changed(doc
, TRUE
);
2951 ui_update_popup_reundo_items(doc
);
2954 /* note: this is called on SCN_MODIFIED notifications */
2955 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2957 /* Clear the redo actions stack before adding the undo action. */
2958 document_undo_clear_stack(&doc
->priv
->redo_actions
);
2960 document_undo_add_internal(doc
, type
, data
);
2964 gboolean
document_can_undo(GeanyDocument
*doc
)
2966 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2968 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2975 static void update_changed_state(GeanyDocument
*doc
)
2978 (sci_is_modified(doc
->editor
->sci
) ||
2979 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2980 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2981 document_set_text_changed(doc
, doc
->changed
);
2985 void document_undo(GeanyDocument
*doc
)
2987 undo_action
*action
;
2989 g_return_if_fail(doc
!= NULL
);
2991 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2993 if (G_UNLIKELY(action
== NULL
))
2995 /* fallback, should not be necessary */
2996 geany_debug("%s: fallback used", G_STRFUNC
);
2997 sci_undo(doc
->editor
->sci
);
3001 switch (action
->type
)
3003 case UNDO_SCINTILLA
:
3005 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
3007 sci_undo(doc
->editor
->sci
);
3012 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
3014 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
3015 ui_update_statusbar(doc
, -1);
3016 ui_document_show_hide(doc
);
3021 /* use the "old" encoding */
3022 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
3024 document_set_encoding(doc
, (const gchar
*)action
->data
);
3025 g_free(action
->data
);
3027 ui_update_statusbar(doc
, -1);
3028 ui_document_show_hide(doc
);
3033 undo_action
*next_action
;
3035 document_redo_add(doc
, UNDO_EOL
, GINT_TO_POINTER(sci_get_eol_mode(doc
->editor
->sci
)));
3037 sci_set_eol_mode(doc
->editor
->sci
, GPOINTER_TO_INT(action
->data
));
3039 ui_update_statusbar(doc
, -1);
3040 ui_document_show_hide(doc
);
3042 /* When undoing, UNDO_EOL is always followed by UNDO_SCINTILLA
3043 * which undos the line endings in the editor and should be
3044 * performed together with UNDO_EOL. */
3045 next_action
= g_trash_stack_peek(&doc
->priv
->undo_actions
);
3046 if (next_action
&& next_action
->type
== UNDO_SCINTILLA
)
3052 UndoReloadData
*data
= (UndoReloadData
*)action
->data
;
3053 gint eol_mode
= data
->eol_mode
;
3056 /* We reuse 'data' for the redo action, so read the current EOL mode
3057 * into it before proceeding. */
3058 data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
3060 /* Undo the rest of the actions which are part of the reloading process. */
3061 for (i
= 0; i
< data
->actions_count
; i
++)
3064 /* Restore the previous EOL mode. */
3065 sci_set_eol_mode(doc
->editor
->sci
, eol_mode
);
3066 /* This might affect the status bar and document menu, so update them. */
3067 ui_update_statusbar(doc
, -1);
3068 ui_document_show_hide(doc
);
3070 document_redo_add(doc
, UNDO_RELOAD
, data
);
3076 g_free(action
); /* free the action which was taken from the stack */
3078 update_changed_state(doc
);
3079 ui_update_popup_reundo_items(doc
);
3083 gboolean
document_can_redo(GeanyDocument
*doc
)
3085 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3087 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
3094 void document_redo(GeanyDocument
*doc
)
3096 undo_action
*action
;
3098 g_return_if_fail(doc
!= NULL
);
3100 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
3102 if (G_UNLIKELY(action
== NULL
))
3104 /* fallback, should not be necessary */
3105 geany_debug("%s: fallback used", G_STRFUNC
);
3106 sci_redo(doc
->editor
->sci
);
3110 switch (action
->type
)
3112 case UNDO_SCINTILLA
:
3114 undo_action
*next_action
;
3116 document_undo_add_internal(doc
, UNDO_SCINTILLA
, NULL
);
3118 sci_redo(doc
->editor
->sci
);
3120 /* When redoing an EOL change, the UNDO_SCINTILLA which changes
3121 * the line ends in the editor is followed by UNDO_EOL
3122 * which should be performed together with UNDO_SCINTILLA. */
3123 next_action
= g_trash_stack_peek(&doc
->priv
->redo_actions
);
3124 if (next_action
!= NULL
&& next_action
->type
== UNDO_EOL
)
3130 document_undo_add_internal(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
3132 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
3133 ui_update_statusbar(doc
, -1);
3134 ui_document_show_hide(doc
);
3139 document_undo_add_internal(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
3141 document_set_encoding(doc
, (const gchar
*)action
->data
);
3142 g_free(action
->data
);
3144 ui_update_statusbar(doc
, -1);
3145 ui_document_show_hide(doc
);
3150 document_undo_add_internal(doc
, UNDO_EOL
, GINT_TO_POINTER(sci_get_eol_mode(doc
->editor
->sci
)));
3152 sci_set_eol_mode(doc
->editor
->sci
, GPOINTER_TO_INT(action
->data
));
3154 ui_update_statusbar(doc
, -1);
3155 ui_document_show_hide(doc
);
3160 UndoReloadData
*data
= (UndoReloadData
*)action
->data
;
3161 gint eol_mode
= data
->eol_mode
;
3164 /* We reuse 'data' for the undo action, so read the current EOL mode
3165 * into it before proceeding. */
3166 data
->eol_mode
= editor_get_eol_char_mode(doc
->editor
);
3168 /* Redo the rest of the actions which are part of the reloading process. */
3169 for (i
= 0; i
< data
->actions_count
; i
++)
3172 /* Restore the previous EOL mode. */
3173 sci_set_eol_mode(doc
->editor
->sci
, eol_mode
);
3174 /* This might affect the status bar and document menu, so update them. */
3175 ui_update_statusbar(doc
, -1);
3176 ui_document_show_hide(doc
);
3178 document_undo_add_internal(doc
, UNDO_RELOAD
, data
);
3184 g_free(action
); /* free the action which was taken from the stack */
3186 update_changed_state(doc
);
3187 ui_update_popup_reundo_items(doc
);
3191 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
3193 undo_action
*action
;
3195 g_return_if_fail(doc
!= NULL
);
3197 action
= g_new0(undo_action
, 1);
3198 action
->type
= type
;
3199 action
->data
= data
;
3201 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
3203 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
3204 document_set_text_changed(doc
, TRUE
);
3206 ui_update_popup_reundo_items(doc
);
3213 STATUS_DISK_CHANGED
,
3222 } document_status_styles
[] = {
3223 { "geany-document-status-changed", {0}, FALSE
},
3224 { "geany-document-status-disk-changed", {0}, FALSE
},
3225 { "geany-document-status-readonly", {0}, FALSE
}
3229 static gint
document_get_status_id(GeanyDocument
*doc
)
3232 return STATUS_CHANGED
;
3233 #ifdef USE_GIO_FILEMON
3234 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
3236 else if (doc
->priv
->protected)
3238 return STATUS_DISK_CHANGED
;
3239 else if (doc
->readonly
)
3240 return STATUS_READONLY
;
3246 /* returns an identifier that is to be set as a widget name or class to get it styled
3247 * depending on the document status (changed, readonly, etc.)
3248 * a NULL return value means default (unchanged) style */
3249 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
3253 g_return_val_if_fail(doc
!= NULL
, NULL
);
3255 status
= document_get_status_id(doc
);
3259 return document_status_styles
[status
].name
;
3264 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
3265 * Returned colors are red if the document has changes, green if the document is read-only
3266 * or simply @c NULL if the document is unmodified but writable.
3268 * @param doc The document to use.
3270 * @return @nullable The color for the document or @c NULL if the default color should be used.
3271 * The color object is owned by Geany and should not be modified or freed.
3276 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
3280 g_return_val_if_fail(doc
!= NULL
, NULL
);
3282 status
= document_get_status_id(doc
);
3285 if (! document_status_styles
[status
].loaded
)
3288 GtkWidgetPath
*path
= gtk_widget_path_new();
3289 GtkStyleContext
*ctx
= gtk_style_context_new();
3290 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
3291 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
3292 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
3293 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
3294 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
3295 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
3296 gtk_style_context_set_path(ctx
, path
);
3297 gtk_style_context_get_color(ctx
, gtk_style_context_get_state(ctx
), &color
);
3298 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
3299 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
3300 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
3301 document_status_styles
[status
].loaded
= TRUE
;
3302 gtk_widget_path_unref(path
);
3303 g_object_unref(ctx
);
3305 return &document_status_styles
[status
].color
;
3309 /** Accessor function for @ref GeanyData::documents_array items.
3310 * @warning Always check the returned document is valid (@c doc->is_valid).
3311 * @param idx @c GeanyData::documents_array index.
3312 * @return @transfer{none} @nullable The document, or @c NULL if @a idx is out of range.
3317 GeanyDocument
*document_index(gint idx
)
3319 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
3323 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
3327 ScintillaObject
*old_sci
;
3329 g_return_val_if_fail(old_doc
, NULL
);
3330 old_sci
= old_doc
->editor
->sci
;
3331 if (sci_has_selection(old_sci
))
3332 text
= sci_get_selection_contents(old_sci
);
3334 text
= sci_get_contents(old_sci
, -1);
3336 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
3338 document_set_text_changed(doc
, TRUE
);
3340 /* copy file properties */
3341 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
3342 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
3343 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
3344 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
3345 old_doc
->editor
->indent_width
);
3346 doc
->readonly
= old_doc
->readonly
;
3347 doc
->has_bom
= old_doc
->has_bom
;
3348 doc
->priv
->protected = 0;
3349 document_set_encoding(doc
, old_doc
->encoding
);
3350 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
3351 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
3354 ui_document_show_hide(doc
);
3359 /* @return TRUE if all files were saved or had their changes discarded. */
3360 gboolean
document_account_for_unsaved(void)
3362 guint p
, page_count
;
3364 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
3365 /* iterate over documents in tabs order */
3366 for (p
= 0; p
< page_count
; p
++)
3368 GeanyDocument
*doc
= document_get_from_page(p
);
3370 if (DOC_VALID(doc
) && doc
->changed
)
3372 if (! dialogs_show_unsaved_file(doc
))
3381 static void force_close_all(void)
3385 main_status
.closing_all
= TRUE
;
3389 document_close(documents
[i
]);
3392 main_status
.closing_all
= FALSE
;
3396 gboolean
document_close_all(void)
3398 if (! document_account_for_unsaved())
3408 * Shows a message related to a document.
3410 * Use this whenever the user needs to see a document-related message,
3411 * for example when the file was externally modified or deleted.
3413 * Any of the buttons can be @c NULL. If not @c NULL, @a btn_1's
3414 * @a response_1 response will be the default for the @c GtkInfoBar or
3417 * @param doc @c GeanyDocument.
3418 * @param msgtype The type of message.
3419 * @param response_cb A callback function called when there's a response.
3420 * @param btn_1 The first action area button.
3421 * @param response_1 The response for @a btn_1.
3422 * @param btn_2 The second action area button.
3423 * @param response_2 The response for @a btn_2.
3424 * @param btn_3 The third action area button.
3425 * @param response_3 The response for @a btn_3.
3426 * @param extra_text Text to show below the main message.
3427 * @param format The text format for the main message.
3428 * @param ... Used with @a format as in @c printf.
3432 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
3433 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
3434 const gchar
*btn_1
, GtkResponseType response_1
,
3435 const gchar
*btn_2
, GtkResponseType response_2
,
3436 const gchar
*btn_3
, GtkResponseType response_3
,
3437 const gchar
*extra_text
, const gchar
*format
, ...)
3440 gchar
*text
, *markup
;
3441 GtkWidget
*hbox
, *icon
, *label
, *content_area
;
3442 GtkWidget
*info_widget
, *parent
;
3443 parent
= document_get_notebook_child(doc
);
3445 va_start(args
, format
);
3446 text
= g_strdup_vprintf(format
, args
);
3449 markup
= g_markup_printf_escaped("<span size=\"larger\">%s</span>", text
);
3452 info_widget
= gtk_info_bar_new();
3453 /* must be done now else Gtk-WARNING: widget not within a GtkWindow */
3454 gtk_box_pack_start(GTK_BOX(parent
), info_widget
, FALSE
, TRUE
, 0);
3456 gtk_info_bar_set_message_type(GTK_INFO_BAR(info_widget
), msgtype
);
3459 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_1
, response_1
);
3461 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_2
, response_2
);
3463 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_3
, response_3
);
3465 content_area
= gtk_info_bar_get_content_area(GTK_INFO_BAR(info_widget
));
3467 label
= geany_wrap_label_new(NULL
);
3468 gtk_label_set_markup(GTK_LABEL(label
), markup
);
3471 g_signal_connect(info_widget
, "response", G_CALLBACK(response_cb
), doc
);
3473 hbox
= gtk_box_new(GTK_ORIENTATION_HORIZONTAL
, 12);
3474 gtk_box_pack_start(GTK_BOX(content_area
), hbox
, TRUE
, TRUE
, 0);
3478 case GTK_MESSAGE_INFO
:
3479 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_INFO
, GTK_ICON_SIZE_DIALOG
);
3481 case GTK_MESSAGE_WARNING
:
3482 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_WARNING
, GTK_ICON_SIZE_DIALOG
);
3484 case GTK_MESSAGE_QUESTION
:
3485 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_QUESTION
, GTK_ICON_SIZE_DIALOG
);
3487 case GTK_MESSAGE_ERROR
:
3488 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_ERROR
, GTK_ICON_SIZE_DIALOG
);
3496 gtk_box_pack_start(GTK_BOX(hbox
), icon
, FALSE
, TRUE
, 0);
3500 GtkWidget
*vbox
= gtk_box_new(GTK_ORIENTATION_VERTICAL
, 6);
3501 GtkWidget
*extra_label
= geany_wrap_label_new(extra_text
);
3503 gtk_box_pack_start(GTK_BOX(vbox
), label
, TRUE
, TRUE
, 0);
3504 gtk_box_pack_start(GTK_BOX(vbox
), extra_label
, TRUE
, TRUE
, 0);
3505 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, TRUE
, TRUE
, 0);
3508 gtk_box_pack_start(GTK_BOX(hbox
), label
, TRUE
, TRUE
, 0);
3510 gtk_box_reorder_child(GTK_BOX(parent
), info_widget
, 0);
3512 gtk_widget_show_all(info_widget
);
3518 static void on_monitor_reload_file_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
3520 gboolean close
= FALSE
;
3522 // disable info bar so actions complete normally
3523 unprotect_document(doc
);
3524 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = NULL
;
3526 if (response_id
== RESPONSE_DOCUMENT_RELOAD
)
3528 close
= doc
->changed
?
3529 document_reload_prompt(doc
, doc
->encoding
) :
3530 document_reload_force(doc
, doc
->encoding
);
3532 else if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3534 close
= document_save_file(doc
, TRUE
); // force overwrite
3536 else if (response_id
== GTK_RESPONSE_CANCEL
)
3538 document_set_text_changed(doc
, TRUE
);
3543 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3544 protect_document(doc
);
3547 gtk_widget_destroy(bar
);
3551 static gboolean
on_sci_key(GtkWidget
*widget
, GdkEventKey
*event
, gpointer data
)
3553 GtkInfoBar
*bar
= GTK_INFO_BAR(data
);
3555 g_return_val_if_fail(event
->type
== GDK_KEY_PRESS
, FALSE
);
3557 switch (event
->keyval
)
3560 case GDK_KEY_ISO_Left_Tab
:
3562 GtkWidget
*action_area
= gtk_info_bar_get_action_area(bar
);
3563 GtkDirectionType dir
= event
->keyval
== GDK_KEY_Tab
? GTK_DIR_TAB_FORWARD
: GTK_DIR_TAB_BACKWARD
;
3564 gtk_widget_child_focus(action_area
, dir
);
3567 case GDK_KEY_Escape
:
3569 gtk_info_bar_response(bar
, GTK_RESPONSE_CANCEL
);
3578 /* Sets up a signal handler to intercept some keys during the lifetime of the GtkInfoBar */
3579 static void enable_key_intercept(GeanyDocument
*doc
, GtkWidget
*bar
)
3581 /* automatically focus editor again on bar close */
3582 g_signal_connect_object(bar
, "destroy", G_CALLBACK(gtk_widget_grab_focus
), doc
->editor
->sci
,
3584 g_signal_connect_object(doc
->editor
->sci
, "key-press-event", G_CALLBACK(on_sci_key
), bar
, 0);
3588 static void monitor_reload_file(GeanyDocument
*doc
)
3590 if (! doc
->changed
&& file_prefs
.reload_clean_doc_on_file_change
)
3592 document_reload_force(doc
, doc
->encoding
);
3596 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
3598 /* show this message only once */
3599 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] == NULL
)
3603 bar
= document_show_message(doc
, GTK_MESSAGE_QUESTION
, on_monitor_reload_file_response
,
3604 _("_Reload"), RESPONSE_DOCUMENT_RELOAD
,
3605 _("_Overwrite"), RESPONSE_DOCUMENT_SAVE
,
3606 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3607 _("Do you want to reload it?"),
3608 _("The file '%s' on the disk is more recent than the current buffer."),
3611 protect_document(doc
);
3612 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3613 enable_key_intercept(doc
, bar
);
3619 static void on_monitor_resave_missing_file_response(GtkWidget
*bar
,
3623 gboolean close
= TRUE
;
3625 unprotect_document(doc
);
3627 if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3628 close
= dialogs_show_save_as();
3632 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = NULL
;
3633 gtk_widget_destroy(bar
);
3637 /* protect back the document if save didn't occur */
3638 protect_document(doc
);
3643 static void monitor_resave_missing_file(GeanyDocument
*doc
)
3645 if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] == NULL
)
3647 GtkWidget
*bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
3649 if (bar
!= NULL
) /* the "file on disk is newer" warning is now moot */
3650 gtk_info_bar_response(GTK_INFO_BAR(bar
), GTK_RESPONSE_CANCEL
);
3652 bar
= document_show_message(doc
, GTK_MESSAGE_WARNING
,
3653 on_monitor_resave_missing_file_response
,
3654 GTK_STOCK_SAVE
, RESPONSE_DOCUMENT_SAVE
,
3655 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3656 NULL
, GTK_RESPONSE_NONE
,
3657 _("Try to resave the file?"),
3658 _("File \"%s\" was not found on disk!"),
3661 protect_document(doc
);
3662 document_set_text_changed(doc
, TRUE
);
3663 /* don't prompt more than once */
3664 SETPTR(doc
->real_path
, NULL
);
3665 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = bar
;
3666 enable_key_intercept(doc
, bar
);
3671 /* Set force to force a disk check, otherwise it is ignored if there was a check
3672 * in the last file_prefs.disk_check_timeout seconds.
3673 * @return @c TRUE if the file has changed. */
3674 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3676 gboolean ret
= FALSE
;
3677 gboolean use_gio_filemon
;
3679 gchar
*locale_filename
;
3680 FileDiskStatus old_status
;
3682 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3684 /* ignore remote files and documents that have never been saved to disk */
3685 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3686 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3689 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3691 if (use_gio_filemon
)
3693 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3698 time_t cur_time
= time(NULL
);
3700 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3703 doc
->priv
->last_check
= cur_time
;
3706 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3707 if (!get_mtime(locale_filename
, &mtime
))
3709 monitor_resave_missing_file(doc
);
3710 /* doc may be closed now */
3713 else if (doc
->priv
->mtime
< mtime
)
3715 /* make sure the user is not prompted again after he cancelled the "reload file?" message */
3716 doc
->priv
->mtime
= mtime
;
3717 monitor_reload_file(doc
);
3718 /* doc may be closed now */
3721 g_free(locale_filename
);
3724 { /* doc can get invalid when a document was closed */
3725 old_status
= doc
->priv
->file_disk_status
;
3726 doc
->priv
->file_disk_status
= FILE_OK
;
3727 if (old_status
!= doc
->priv
->file_disk_status
)
3728 ui_update_tab_status(doc
);
3734 /** Compares documents by their display names.
3735 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3736 * @note 'Display name' means the base name of the document's filename.
3738 * @param a @c GeanyDocument**.
3739 * @param b @c GeanyDocument**.
3740 * @warning The arguments take the address of each document pointer.
3741 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3746 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3748 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3749 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3750 gchar
*base_name_a
, *base_name_b
;
3753 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3754 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3756 result
= strcmp(base_name_a
, base_name_b
);
3758 g_free(base_name_a
);
3759 g_free(base_name_b
);
3765 /** Compares documents by their tab order.
3766 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3768 * @param a @c GeanyDocument**.
3769 * @param b @c GeanyDocument**.
3770 * @warning The arguments take the address of each document pointer.
3771 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3773 * @since 0.21 (GEANY_API_VERSION 209)
3776 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3778 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3779 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3780 gint notebook_position_doc_a
;
3781 gint notebook_position_doc_b
;
3783 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3784 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3786 if (notebook_position_doc_a
< notebook_position_doc_b
)
3788 if (notebook_position_doc_a
> notebook_position_doc_b
)
3795 /** Compares documents by their tab order, in reverse order.
3796 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3798 * @param a @c GeanyDocument**.
3799 * @param b @c GeanyDocument**.
3800 * @warning The arguments take the address of each document pointer.
3801 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3803 * @since 0.21 (GEANY_API_VERSION 209)
3806 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3808 return -1 * document_compare_by_tab_order(a
, b
);
3812 void document_grab_focus(GeanyDocument
*doc
)
3814 g_return_if_fail(doc
!= NULL
);
3816 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));
3819 static void *copy_(void *src
) { return src
; }
3820 static void free_(void *doc
) { }
3823 * Gets the GType of GeanyDocument
3825 * @return the GeanyDocument type */
3827 GType
document_get_type (void);
3829 G_DEFINE_BOXED_TYPE(GeanyDocument
, document
, copy_
, free_
);
3832 gpointer
document_get_data(const GeanyDocument
*doc
, const gchar
*key
)
3834 return g_datalist_get_data(&doc
->priv
->data
, key
);
3838 void document_set_data(GeanyDocument
*doc
, const gchar
*key
, gpointer data
)
3840 g_datalist_set_data(&doc
->priv
->data
, key
, data
);
3844 void document_set_data_full(GeanyDocument
*doc
, const gchar
*key
,
3845 gpointer data
, GDestroyNotify free_func
)
3847 g_datalist_set_data_full(&doc
->priv
->data
, key
, data
, free_func
);