2 * document.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * Document related actions: new, save, open, etc.
24 * Also Scintilla search actions.
34 #include "callbacks.h" /* for ignore_callback */
36 #include "documentprivate.h"
37 #include "encodings.h"
38 #include "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 #include "gtkcompat.h"
59 #ifdef HAVE_SYS_TIME_H
60 # include <sys/time.h>
68 #ifdef HAVE_SYS_TYPES_H
69 # include <sys/types.h>
74 /* gstdio.h also includes sys/stat.h */
75 #include <glib/gstdio.h>
77 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
78 /*#define USE_GIO_FILEMON 1*/
81 #include <gdk/gdkkeysyms.h>
83 GeanyFilePrefs file_prefs
;
86 /** Dynamic array of GeanyDocument pointers.
87 * Once a pointer is added to this, it is never freed. This means the same document pointer
88 * can represent a different document later on, or it may have been closed and become invalid.
89 * For this reason, you should use document_find_by_id() instead of storing
90 * document pointers over time if there is a chance the user can close the
93 * @warning You must check @c GeanyDocument::is_valid when iterating over this array.
94 * This is done automatically if you use the foreach_document() macro.
97 * Never assume that the order of document pointers is the same as the order of notebook tabs.
98 * One reason is that notebook tabs can be reordered.
99 * Use @c document_get_from_page() to lookup a document from a notebook tab number.
102 GPtrArray
*documents_array
= NULL
;
105 /* an undo action, also used for redo actions */
108 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
109 guint type
; /* to identify the action */
110 gpointer
*data
; /* the old value (before the change), in case of a redo action
111 * it contains the new value */
114 /* Custom document info bar response IDs */
117 RESPONSE_DOCUMENT_RELOAD
= 1,
118 RESPONSE_DOCUMENT_SAVE
,
122 static guint doc_id_counter
= 0;
125 static void document_undo_clear(GeanyDocument
*doc
);
126 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
127 static gboolean
remove_page(guint page_num
);
128 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
129 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
130 const gchar
*btn_1
, GtkResponseType response_1
,
131 const gchar
*btn_2
, GtkResponseType response_2
,
132 const gchar
*btn_3
, GtkResponseType response_3
,
133 const gchar
*extra_text
, const gchar
*format
, ...) G_GNUC_PRINTF(11, 12);
137 * Finds a document whose @c real_path field matches the given filename.
139 * @param realname The filename to search, which should be identical to the
140 * string returned by @c tm_get_real_path().
142 * @return The matching document, or @c NULL.
143 * @note This is only really useful when passing a @c TMWorkObject::file_name.
144 * @see GeanyDocument::real_path.
145 * @see document_find_by_filename().
149 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
154 return NULL
; /* file doesn't exist on disk */
156 for (i
= 0; i
< documents_array
->len
; i
++)
158 GeanyDocument
*doc
= documents
[i
];
160 if (! doc
->is_valid
|| ! doc
->real_path
)
163 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
172 /* dereference symlinks, /../ junk in path and return locale encoding */
173 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
175 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
176 gchar
*realname
= tm_get_real_path(locale_name
);
184 * Finds a document with the given filename.
185 * This matches either an exact GeanyDocument::file_name string, or variant
186 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
189 * @param utf8_filename The filename to search (in UTF-8 encoding).
191 * @return The matching document, or @c NULL.
192 * @see document_find_by_real_path().
194 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
200 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
202 /* First search GeanyDocument::file_name, so we can find documents with a
203 * filename set but not saved on disk, like vcdiff produces */
204 for (i
= 0; i
< documents_array
->len
; i
++)
208 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
211 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
216 /* Now try matching based on the realpath(), which is unique per file on disk */
217 realname
= get_real_path_from_utf8(utf8_filename
);
218 doc
= document_find_by_real_path(realname
);
224 /* returns the document which has sci, or NULL. */
225 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
229 g_return_val_if_fail(sci
!= NULL
, NULL
);
231 for (i
= 0; i
< documents_array
->len
; i
++)
233 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
240 /** Lookup an old document by its ID.
241 * Useful when the corresponding document may have been closed since the
243 * @param id The ID of the document to find
244 * @return @c NULL if the document is no longer open.
249 * GeanyDocument *doc = ...;
250 * id = doc->id; // store ID
252 * // time passes - the document may have been closed by now
253 * GeanyDocument *doc = document_find_by_id(id);
254 * gboolean still_open = (doc != NULL);
257 GeanyDocument
*document_find_by_id(guint id
)
266 if (documents
[i
]->id
== id
)
273 /** Gets the notebook page index for a document.
274 * @param doc The document.
277 gint
document_get_notebook_page(GeanyDocument
*doc
)
282 g_return_val_if_fail(doc
!= NULL
, -1);
284 child
= GTK_WIDGET(doc
->editor
->sci
);
285 parent
= gtk_widget_get_parent(child
);
286 /* search for the direct notebook child, mirroring document_get_from_page() */
287 while (parent
&& ! GTK_IS_NOTEBOOK(parent
))
290 parent
= gtk_widget_get_parent(child
);
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
);
331 * Finds the document for the given notebook page @a page_num.
333 * @param page_num The notebook page number to search.
335 * @return The corresponding document for the given notebook page, or @c NULL.
337 GeanyDocument
*document_get_from_page(guint page_num
)
340 ScintillaObject
*sci
;
342 if (page_num
>= documents_array
->len
)
345 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
346 g_return_val_if_fail(GTK_IS_BOX(parent
), NULL
);
348 sci
= locate_sci_in_container(parent
);
349 g_return_val_if_fail(IS_SCINTILLA(sci
), NULL
);
351 return document_find_by_sci(sci
);
356 * Finds the current document.
358 * @return A pointer to the current document or @c NULL if there are no opened documents.
360 GeanyDocument
*document_get_current(void)
362 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
367 return document_get_from_page((guint
) cur_page
);
371 void document_init_doclist(void)
373 documents_array
= g_ptr_array_new();
377 void document_finalize(void)
381 for (i
= 0; i
< documents_array
->len
; i
++)
382 g_free(documents
[i
]);
383 g_ptr_array_free(documents_array
, TRUE
);
388 * Returns the last part of the filename of the given GeanyDocument. The result is also
389 * truncated to a maximum of @a length characters in case the filename is very long.
391 * @param doc The document to use.
392 * @param length The length of the resulting string or -1 to use a default value.
394 * @return The ellipsized last part of the filename of @a doc, should be freed when no
399 /* TODO make more use of this */
400 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
402 gchar
*base_name
, *short_name
;
404 g_return_val_if_fail(doc
!= NULL
, NULL
);
409 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
410 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
418 void document_update_tab_label(GeanyDocument
*doc
)
423 g_return_if_fail(doc
!= NULL
);
425 short_name
= document_get_basename_for_display(doc
, -1);
427 /* we need to use the event box for the tooltip, labels don't get the necessary events */
428 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
429 parent
= gtk_widget_get_parent(parent
);
431 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
433 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
440 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
441 * according to the document's save state.
442 * This is called by Geany mostly when opening or saving files.
444 * @param doc The document to use.
445 * @param changed Whether the document state should indicate changes have been made.
447 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
449 g_return_if_fail(doc
!= NULL
);
451 doc
->changed
= changed
;
453 if (! main_status
.quitting
)
455 ui_update_tab_status(doc
);
456 ui_save_buttons_toggle(changed
);
457 ui_set_window_title(doc
);
458 ui_update_statusbar(doc
, -1);
463 /* returns the next free place in the document list,
464 * or -1 if the documents_array is full */
465 static gint
document_get_new_idx(void)
469 for (i
= 0; i
< documents_array
->len
; i
++)
471 if (documents
[i
]->editor
== NULL
)
480 static void queue_colourise(GeanyDocument
*doc
)
482 /* Colourise the editor before it is next drawn */
483 doc
->priv
->colourise_needed
= TRUE
;
485 /* If the editor doesn't need drawing (e.g. after saving the current
486 * document), we need to force a redraw, so the expose event is triggered.
487 * This ensures we don't start colourising before all documents are opened/saved,
488 * only once the editor is drawn. */
489 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
493 #ifdef USE_GIO_FILEMON
494 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
495 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
498 g_return_if_fail(doc
!= NULL
);
500 if (file_prefs
.disk_check_timeout
== 0)
503 geany_debug("%s: event: %d previous file status: %d",
504 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
507 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
509 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
510 doc
->priv
->file_disk_status
= FILE_OK
;
512 doc
->priv
->file_disk_status
= FILE_CHANGED
;
513 g_message("%s: FILE_CHANGED", G_STRFUNC
);
516 case G_FILE_MONITOR_EVENT_DELETED
:
518 doc
->priv
->file_disk_status
= FILE_CHANGED
;
519 g_message("%s: FILE_MISSING", G_STRFUNC
);
525 if (doc
->priv
->file_disk_status
!= FILE_OK
)
527 ui_update_tab_status(doc
);
533 static void document_stop_file_monitoring(GeanyDocument
*doc
)
535 g_return_if_fail(doc
!= NULL
);
537 if (doc
->priv
->monitor
!= NULL
)
539 g_object_unref(doc
->priv
->monitor
);
540 doc
->priv
->monitor
= NULL
;
545 static void monitor_file_setup(GeanyDocument
*doc
)
547 g_return_if_fail(doc
!= NULL
);
548 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
549 * doesn't work at all for remote files and legacy polling is too slow. */
550 if (! doc
->priv
->is_remote
)
552 #ifdef USE_GIO_FILEMON
553 gchar
*locale_filename
;
555 /* stop any previous monitoring */
556 document_stop_file_monitoring(doc
);
558 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
559 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
561 /* get a file monitor and connect to the 'changed' signal */
562 GFile
*file
= g_file_new_for_path(locale_filename
);
563 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
564 g_signal_connect(doc
->priv
->monitor
, "changed",
565 G_CALLBACK(monitor_file_changed_cb
), doc
);
567 /* we set the rate limit according to the GUI pref but it's most probably not used */
568 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
570 g_object_unref(file
);
572 g_free(locale_filename
);
575 doc
->priv
->file_disk_status
= FILE_OK
;
579 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
581 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
584 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
585 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
587 if (source_widget
== NULL
)
588 source_widget
= doc
->priv
->tag_tree
;
590 if (focusw
== source_widget
)
591 gtk_widget_grab_focus(sci
);
596 static gboolean
on_idle_focus(gpointer doc
)
598 document_try_focus(doc
, NULL
);
603 /* Creates a new document and editor, adding a tab in the notebook.
604 * @return The created document */
605 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
609 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
613 doc
= document_get_current();
614 /* remove the empty document first */
615 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
616 /* prevent immediately opening another new doc with
617 * new_document_after_close pref */
621 new_idx
= document_get_new_idx();
622 if (new_idx
== -1) /* expand the array, no free places */
624 doc
= g_new0(GeanyDocument
, 1);
626 new_idx
= documents_array
->len
;
627 g_ptr_array_add(documents_array
, doc
);
630 doc
= documents
[new_idx
];
632 /* initialize default document settings */
633 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
634 doc
->id
= ++doc_id_counter
;
635 doc
->index
= new_idx
;
636 doc
->file_name
= g_strdup(utf8_filename
);
637 doc
->editor
= editor_create(doc
);
638 #ifndef USE_GIO_FILEMON
639 doc
->priv
->last_check
= time(NULL
);
642 sidebar_openfiles_add(doc
); /* sets doc->iter */
644 notebook_new_tab(doc
);
646 /* select document in sidebar */
648 GtkTreeSelection
*sel
;
650 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
651 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
654 ui_document_buttons_update();
656 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
662 * Closes the given document.
664 * @param doc The document to remove.
666 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
670 gboolean
document_close(GeanyDocument
*doc
)
672 g_return_val_if_fail(doc
, FALSE
);
674 return document_remove_page(document_get_notebook_page(doc
));
678 /* Call document_remove_page() instead, this is only needed for document_create()
679 * to prevent re-opening a new document when the last document is closed (if enabled). */
680 static gboolean
remove_page(guint page_num
)
682 GeanyDocument
*doc
= document_get_from_page(page_num
);
684 g_return_val_if_fail(doc
!= NULL
, FALSE
);
686 if (doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
689 /* tell any plugins that the document is about to be closed */
690 g_signal_emit_by_name(geany_object
, "document-close", doc
);
692 /* Checking real_path makes it likely the file exists on disk */
693 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
694 ui_add_recent_document(doc
);
696 doc
->is_valid
= FALSE
;
699 if (main_status
.quitting
)
701 /* we need to destroy the ScintillaWidget so our handlers on it are
702 * disconnected before we free any data they may use (like the editor).
703 * when not quitting, this is handled by removing the notebook page. */
704 gtk_notebook_remove_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
708 notebook_remove_page(page_num
);
709 sidebar_remove_document(doc
);
710 navqueue_remove_file(doc
->file_name
);
711 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
713 g_free(doc
->encoding
);
714 g_free(doc
->priv
->saved_encoding
.encoding
);
715 g_free(doc
->file_name
);
716 g_free(doc
->real_path
);
717 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
719 if (doc
->priv
->tag_tree
)
720 gtk_widget_destroy(doc
->priv
->tag_tree
);
722 editor_destroy(doc
->editor
);
723 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
725 document_stop_file_monitoring(doc
);
727 document_undo_clear(doc
);
731 /* reset document settings to defaults for re-use */
732 memset(doc
, 0, sizeof(GeanyDocument
));
734 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
736 sidebar_update_tag_list(NULL
, FALSE
);
737 ui_set_window_title(NULL
);
738 ui_save_buttons_toggle(FALSE
);
739 ui_update_popup_reundo_items(NULL
);
740 ui_document_buttons_update();
741 build_menu_update(NULL
);
748 * Removes the given notebook tab at @a page_num and clears all related information
749 * in the document list.
751 * @param page_num The notebook page number to remove.
753 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
755 gboolean
document_remove_page(guint page_num
)
757 gboolean done
= remove_page(page_num
);
759 if (done
&& ui_prefs
.new_document_after_close
)
760 document_new_file_if_non_open();
766 /* used to keep a record of the unchanged document state encoding */
767 static void store_saved_encoding(GeanyDocument
*doc
)
769 g_free(doc
->priv
->saved_encoding
.encoding
);
770 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
771 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
775 /* Opens a new empty document only if there are no other documents open */
776 GeanyDocument
*document_new_file_if_non_open(void)
778 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
779 return document_new_file(NULL
, NULL
, NULL
);
786 * Creates a new document.
787 * Line endings in @a text will be converted to the default setting.
788 * Afterwards, the @c "document-new" signal is emitted for plugins.
790 * @param utf8_filename The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
791 * @param ft The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
792 * @param text The initial content of the file (in UTF-8 encoding), or @c NULL.
794 * @return The new document.
796 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
800 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
803 tmp
= utils_strdupa(utf8_filename
); /* work around const */
804 utils_tidy_path(tmp
);
807 doc
= document_create(utf8_filename
);
809 g_assert(doc
!= NULL
);
811 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
814 GString
*template = g_string_new(text
);
815 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
817 sci_set_text(doc
->editor
->sci
, template->str
);
818 g_string_free(template, TRUE
);
821 sci_clear_all(doc
->editor
->sci
);
823 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
825 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
826 sci_empty_undo_buffer(doc
->editor
->sci
);
828 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
829 /* store the opened encoding for undo/redo */
830 store_saved_encoding(doc
);
832 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
833 ft
= filetypes_detect_from_document(doc
);
835 document_set_filetype(doc
, ft
); /* also re-parses tags */
837 ui_set_window_title(doc
);
838 build_menu_update(doc
);
839 document_set_text_changed(doc
, FALSE
);
840 ui_document_show_hide(doc
); /* update the document menu */
842 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
843 /* bring it in front, jump to the start and grab the focus */
844 editor_goto_pos(doc
->editor
, 0, FALSE
);
845 document_try_focus(doc
, NULL
);
847 #ifdef USE_GIO_FILEMON
848 monitor_file_setup(doc
);
850 doc
->priv
->mtime
= time(NULL
);
853 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
854 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
856 g_signal_emit_by_name(geany_object
, "document-new", doc
);
858 msgwin_status_add(_("New file \"%s\" opened."),
866 * Opens a document specified by @a locale_filename.
867 * Afterwards, the @c "document-open" signal is emitted for plugins.
869 * @param locale_filename The filename of the document to load, in locale encoding.
870 * @param readonly Whether to open the document in read-only mode.
871 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
872 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
874 * @return The document opened or @c NULL.
876 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
877 GeanyFiletype
*ft
, const gchar
*forced_enc
)
879 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
885 gchar
*data
; /* null-terminated file data */
886 gsize len
; /* string length of data */
889 time_t mtime
; /* modification time, read by stat::st_mtime */
894 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
895 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
896 FileData
*filedata
, const gchar
*forced_enc
)
901 filedata
->data
= NULL
;
903 filedata
->enc
= NULL
;
904 filedata
->bom
= FALSE
;
905 filedata
->readonly
= FALSE
;
907 if (g_stat(locale_filename
, &st
) != 0)
909 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
910 display_filename
, g_strerror(errno
));
914 filedata
->mtime
= st
.st_mtime
;
916 if (! g_file_get_contents(locale_filename
, &filedata
->data
, NULL
, &err
))
918 ui_set_statusbar(TRUE
, "%s", err
->message
);
923 filedata
->len
= (gsize
) st
.st_size
;
924 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
925 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
929 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
930 display_filename
, forced_enc
);
934 ui_set_statusbar(TRUE
,
935 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
938 g_free(filedata
->data
);
942 if (filedata
->readonly
)
944 const gchar
*warn_msg
= _(
945 "The file \"%s\" could not be opened properly and has been truncated. " \
946 "This can occur if the file contains a NULL byte. " \
947 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
949 if (main_status
.main_window_realized
)
950 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
952 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
959 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
960 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
961 * if cl_options.goto_column is set.
963 * returns the new position which may have changed */
964 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
966 if (cl_options
.goto_line
>= 0)
967 { /* goto line which was specified on command line and then undefine the line */
968 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
969 editor
->scroll_percent
= 0.5F
;
970 cl_options
.goto_line
= -1;
974 sci_set_current_position(editor
->sci
, pos
, FALSE
);
975 editor
->scroll_percent
= 0.5F
;
978 if (cl_options
.goto_column
>= 0)
979 { /* goto column which was specified on command line and then undefine the column */
981 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
982 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
983 editor
->scroll_percent
= 0.5F
;
984 cl_options
.goto_column
= -1;
987 return sci_get_current_position(editor
->sci
);
991 /* Count lines that start with some hard tabs then a soft tab. */
992 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
994 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
995 ScintillaObject
*sci
= editor
->sci
;
997 struct Sci_TextToFind ttf
;
998 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
999 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
1004 ttf
.chrg
.cpMax
= sci_get_length(sci
);
1005 ttf
.lpstrText
= regex
;
1010 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
1012 break; /* no more matches */
1014 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
1017 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
1018 return count
> sci_get_line_count(sci
) * 0.02;
1022 /* Detect the indent type based on counting the leading indent characters for each line.
1023 * Returns whether detection succeeded, and the detected type in *type_ upon success */
1024 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
1026 GeanyEditor
*editor
= doc
->editor
;
1027 ScintillaObject
*sci
= editor
->sci
;
1028 gint line
, line_count
;
1029 gsize tabs
= 0, spaces
= 0;
1031 if (detect_tabs_and_spaces(editor
))
1033 *type_
= GEANY_INDENT_TYPE_BOTH
;
1037 line_count
= sci_get_line_count(sci
);
1038 for (line
= 0; line
< line_count
; line
++)
1040 gint pos
= sci_get_position_from_line(sci
, line
);
1043 /* most code will have indent total <= 24, otherwise it's more likely to be
1044 * alignment than indentation */
1045 if (sci_get_line_indentation(sci
, line
) > 24)
1048 c
= sci_get_char_at(sci
, pos
);
1051 /* check for at least 2 spaces */
1052 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
1055 if (spaces
== 0 && tabs
== 0)
1058 /* the factors may need to be tweaked */
1059 if (spaces
> tabs
* 4)
1060 *type_
= GEANY_INDENT_TYPE_SPACES
;
1061 else if (tabs
> spaces
* 4)
1062 *type_
= GEANY_INDENT_TYPE_TABS
;
1064 *type_
= GEANY_INDENT_TYPE_BOTH
;
1070 /* Detect the indent width based on counting the leading indent characters for each line.
1071 * Returns whether detection succeeded, and the detected width in *width_ upon success */
1072 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
1074 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1075 ScintillaObject
*sci
= editor
->sci
;
1076 gint line
, line_count
;
1077 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
1078 gint count
, width
, i
;
1080 /* can't easily detect the supposed width of a tab, guess the default is OK */
1081 if (type
== GEANY_INDENT_TYPE_TABS
)
1084 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
1085 sci_set_tab_width(sci
, 8);
1087 line_count
= sci_get_line_count(sci
);
1088 for (line
= 0; line
< line_count
; line
++)
1090 gint pos
= sci_get_line_indent_position(sci
, line
);
1092 /* We probably don't have style info yet, because we're generally called just after
1093 * the document got created, so we can't use highlighting_is_code_style().
1094 * That's not good, but the assumption below that concerning lines start with an
1095 * asterisk (common continuation character for C/C++/Java/...) should do the trick
1096 * without removing too much legitimate lines. */
1097 if (sci_get_char_at(sci
, pos
) == '*')
1100 width
= sci_get_line_indentation(sci
, line
);
1101 /* most code will have indent total <= 24, otherwise it's more likely to be
1102 * alignment than indentation */
1105 /* < 2 is no indentation */
1109 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1111 if ((width
% (i
+ 2)) == 0)
1116 width
= iprefs
->width
;
1117 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1119 /* give large indents higher weight not to be fooled by spurious indents */
1120 if (widths
[i
] >= count
* 1.5)
1135 /* same as detect_indent_width() but uses editor's indent type */
1136 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1138 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1142 void document_apply_indent_settings(GeanyDocument
*doc
)
1144 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1145 GeanyIndentType type
= iprefs
->type
;
1146 gint width
= iprefs
->width
;
1148 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1150 if (type
!= iprefs
->type
)
1152 const gchar
*name
= NULL
;
1156 case GEANY_INDENT_TYPE_SPACES
:
1159 case GEANY_INDENT_TYPE_TABS
:
1162 case GEANY_INDENT_TYPE_BOTH
:
1163 name
= _("Tabs and Spaces");
1166 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1167 * and Spaces), the second one is the filename */
1168 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1172 else if (doc
->file_type
->indent_type
> -1)
1173 type
= doc
->file_type
->indent_type
;
1175 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1177 if (width
!= iprefs
->width
)
1179 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1183 else if (doc
->file_type
->indent_width
> -1)
1184 width
= doc
->file_type
->indent_width
;
1186 editor_set_indent(doc
->editor
, type
, width
);
1190 void document_show_tab(GeanyDocument
*doc
)
1192 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1193 document_get_notebook_page(doc
));
1197 /* To open a new file, set doc to NULL; filename should be locale encoded.
1198 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1199 * pos is the cursor position, which can be overridden by --line and --column.
1200 * forced_enc can be NULL to detect the file encoding.
1201 * Returns: doc of the opened file or NULL if an error occurred. */
1202 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1203 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1206 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1207 gchar
*utf8_filename
= NULL
;
1208 gchar
*display_filename
= NULL
;
1209 gchar
*locale_filename
= NULL
;
1210 GeanyFiletype
*use_ft
;
1213 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, NULL
);
1217 utf8_filename
= g_strdup(doc
->file_name
);
1218 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1222 /* filename must not be NULL when opening a file */
1223 g_return_val_if_fail(filename
, NULL
);
1226 /* if filename is a shortcut, try to resolve it */
1227 locale_filename
= win32_get_shortcut_target(filename
);
1229 locale_filename
= g_strdup(filename
);
1231 /* remove relative junk */
1232 utils_tidy_path(locale_filename
);
1234 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1235 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1237 /* if file is already open, switch to it and go */
1238 doc
= document_find_by_filename(utf8_filename
);
1241 ui_add_recent_document(doc
); /* either add or reorder recent item */
1242 /* show the doc before reload dialog */
1243 document_show_tab(doc
);
1244 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1247 if (reload
|| doc
== NULL
)
1248 { /* doc possibly changed */
1249 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1251 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1253 g_free(display_filename
);
1254 g_free(utf8_filename
);
1255 g_free(locale_filename
);
1261 doc
= document_create(utf8_filename
);
1262 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1264 /* file exists on disk, set real_path */
1265 SETPTR(doc
->real_path
, tm_get_real_path(locale_filename
));
1267 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1268 monitor_file_setup(doc
);
1271 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1272 sci_empty_undo_buffer(doc
->editor
->sci
);
1274 /* add the text to the ScintillaObject */
1275 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1276 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1277 queue_colourise(doc
); /* Ensure the document gets colourised. */
1279 /* detect & set line endings */
1280 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1281 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1282 g_free(filedata
.data
);
1284 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1286 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1287 g_free(doc
->encoding
); /* if reloading, free old encoding */
1288 doc
->encoding
= filedata
.enc
;
1289 doc
->has_bom
= filedata
.bom
;
1290 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1292 doc
->readonly
= readonly
|| filedata
.readonly
;
1293 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1294 doc
->priv
->protected = 0;
1296 /* update line number margin width */
1297 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1298 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
);
1303 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1304 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1307 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1311 document_undo_clear(doc
);
1315 /* update taglist, typedef keywords and build menu if necessary */
1316 document_set_filetype(doc
, use_ft
);
1318 /* set indentation settings after setting the filetype */
1320 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1322 document_apply_indent_settings(doc
);
1324 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1325 ui_document_show_hide(doc
); /* update the document menu */
1327 /* finally add current file to recent files menu, but not the files from the last session */
1328 if (! main_status
.opening_session_files
)
1329 ui_add_recent_document(doc
);
1333 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1334 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1338 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1339 /* For translators: this is the status window message for opening a file. %d is the number
1340 * of the newly opened file, %s indicates whether the file is opened read-only
1341 * (it is replaced with the string ", read-only"). */
1342 msgwin_status_add(_("File %s opened(%d%s)."),
1343 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1344 (readonly
) ? _(", read-only") : "");
1348 g_free(display_filename
);
1349 g_free(utf8_filename
);
1350 g_free(locale_filename
);
1352 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1353 pos
= set_cursor_position(doc
->editor
, pos
);
1354 /* now bring the file in front */
1355 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1357 /* finally, let the editor widget grab the focus so you can start coding
1359 g_idle_add(on_idle_focus
, doc
);
1364 /* Takes a new line separated list of filename URIs and opens each file.
1365 * length is the length of the string */
1366 void document_open_file_list(const gchar
*data
, gsize length
)
1372 g_return_if_fail(data
!= NULL
);
1374 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1376 /* stop at the end or first empty item, because last item is empty but not null */
1377 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1379 filename
= utils_get_path_from_uri(list
[i
]);
1380 if (filename
== NULL
)
1382 document_open_file(filename
, FALSE
, NULL
, NULL
);
1391 * Opens each file in the list @a filenames.
1392 * Internally, document_open_file() is called for every list item.
1394 * @param filenames A list of filenames to load, in locale encoding.
1395 * @param readonly Whether to open the document in read-only mode.
1396 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
1397 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1399 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1400 const gchar
*forced_enc
)
1404 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1406 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1412 * Reloads the document with the specified file encoding
1413 * @a forced_enc or @c NULL to auto-detect the file encoding.
1415 * @param doc The document to reload.
1416 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1418 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1420 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
)
1423 GeanyDocument
*new_doc
;
1425 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1427 /* Use cancel because the response handler would call this recursively */
1428 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] != NULL
)
1429 gtk_info_bar_response(GTK_INFO_BAR(doc
->priv
->info_bars
[MSG_TYPE_RELOAD
]), GTK_RESPONSE_CANCEL
);
1431 /* try to set the cursor to the position before reloading */
1432 pos
= sci_get_current_position(doc
->editor
->sci
);
1433 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1435 return (new_doc
!= NULL
);
1439 /* also used for reloading when forced_enc is NULL */
1440 gboolean
document_reload_prompt(GeanyDocument
*doc
, const gchar
*forced_enc
)
1443 gboolean result
= FALSE
;
1445 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1447 /* No need to reload "untitled" (non-file-backed) documents */
1448 if (doc
->file_name
== NULL
)
1451 if (forced_enc
== NULL
)
1452 forced_enc
= doc
->encoding
;
1454 base_name
= g_path_get_basename(doc
->file_name
);
1455 /* don't prompt if file hasn't been edited at all */
1456 if ((!doc
->changed
&& !document_can_undo(doc
) && !document_can_redo(doc
)) ||
1457 dialogs_show_question_full(NULL
, _("_Reload"), GTK_STOCK_CANCEL
,
1458 _("Any unsaved changes will be lost."),
1459 _("Are you sure you want to reload '%s'?"), base_name
))
1461 result
= document_reload_file(doc
, forced_enc
);
1462 if (forced_enc
!= NULL
)
1463 ui_update_statusbar(doc
, -1);
1471 static gboolean
document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1473 #ifndef USE_GIO_FILEMON
1476 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1478 /* stat the file to get the timestamp, otherwise on Windows the actual
1479 * timestamp can be ahead of time(NULL) */
1480 if (g_stat(locale_filename
, &st
) != 0)
1482 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"), doc
->file_name
,
1487 doc
->priv
->mtime
= st
.st_mtime
; /* get the modification time from file and keep it */
1493 /* Sets line and column to the given position byte_pos in the document.
1494 * byte_pos is the position counted in bytes, not characters */
1495 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1500 /* for some reason we can use byte count instead of character count here */
1501 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1502 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1503 /* get the column in the line */
1504 *column
= byte_pos
- line_start
;
1506 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1507 * skip one byte(i++) and decrease the column number which is based on byte count */
1508 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1510 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1519 static void replace_header_filename(GeanyDocument
*doc
)
1523 struct Sci_TextToFind ttf
;
1525 g_return_if_fail(doc
!= NULL
);
1526 g_return_if_fail(doc
->file_type
!= NULL
);
1528 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1529 if (doc
->file_type
->extension
)
1530 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1532 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1534 filename
= g_path_get_basename(doc
->file_name
);
1536 /* only search the first 3 lines */
1538 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1539 ttf
.lpstrText
= filebase
;
1541 if (search_find_text(doc
->editor
->sci
, GEANY_FIND_MATCHCASE
| GEANY_FIND_REGEXP
, &ttf
, NULL
) != -1)
1543 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1544 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1545 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1553 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1554 * you still have to call @ref document_save_file_as() to change the @a doc object.
1555 * It also stops monitoring for file changes to prevent receiving too many file change events
1556 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1558 * @param doc The current document which should be renamed.
1559 * @param new_filename The new filename in UTF-8 encoding.
1563 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1565 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1566 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1569 /* stop file monitoring to avoid getting events for deleting/creating files,
1570 * it's re-setup in document_save_file_as() */
1571 document_stop_file_monitoring(doc
);
1573 result
= g_rename(old_locale_filename
, new_locale_filename
);
1576 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1577 _("Error renaming file."), g_strerror(errno
));
1579 g_free(old_locale_filename
);
1580 g_free(new_locale_filename
);
1584 static void protect_document(GeanyDocument
*doc
)
1586 /* do not call queue_colourise because to we want to keep the text-changed indication! */
1587 if (!doc
->priv
->protected++)
1588 sci_set_readonly(doc
->editor
->sci
, TRUE
);
1591 static void unprotect_document(GeanyDocument
*doc
)
1593 g_return_if_fail(doc
->priv
->protected > 0);
1595 if (!--doc
->priv
->protected && doc
->readonly
== FALSE
)
1596 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1600 /* Return TRUE if the document doesn't have a full filename set.
1601 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1602 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1604 gboolean
document_need_save_as(GeanyDocument
*doc
)
1606 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1608 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1613 * Saves the document, detecting the filetype.
1615 * @param doc The document for the file to save.
1616 * @param utf8_fname The new name for the document, in UTF-8, or NULL.
1617 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1619 * @see document_save_file().
1623 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1628 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1630 new_file
= document_need_save_as(doc
) || (utf8_fname
!= NULL
&& strcmp(doc
->file_name
, utf8_fname
) != 0);
1631 if (utf8_fname
!= NULL
)
1632 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1634 /* reset real path, it's retrieved again in document_save() */
1635 SETPTR(doc
->real_path
, NULL
);
1637 /* detect filetype */
1638 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1640 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1642 document_set_filetype(doc
, ft
);
1643 if (document_get_current() == doc
)
1645 ignore_callback
= TRUE
;
1646 filetypes_select_radio_item(doc
->file_type
);
1647 ignore_callback
= FALSE
;
1653 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1654 doc
->readonly
= FALSE
;
1655 if (doc
->priv
->protected > 0)
1656 unprotect_document(doc
);
1659 replace_header_filename(doc
);
1661 ret
= document_save_file(doc
, TRUE
);
1663 /* file monitoring support, add file monitoring after the file has been saved
1664 * to ignore any earlier events */
1665 monitor_file_setup(doc
);
1666 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1669 ui_add_recent_document(doc
);
1674 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1676 GError
*conv_error
= NULL
;
1677 gchar
* conv_file_contents
= NULL
;
1681 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1682 g_return_val_if_fail(len
!= NULL
, FALSE
);
1684 /* try to convert it from UTF-8 to original encoding */
1685 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1686 &bytes_read
, &conv_len
, &conv_error
);
1688 if (conv_error
!= NULL
)
1690 gchar
*text
= g_strdup_printf(
1691 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1695 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1700 /* don't read over the doc length */
1701 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1702 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1703 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1705 /* take only one valid Unicode character from the context and discard the leftover */
1706 unic
= g_utf8_get_char_validated(context
, -1);
1707 context_len
= g_unichar_to_utf8(unic
, context
);
1708 context
[context_len
] = '\0';
1709 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1711 error_text
= g_strdup_printf(
1712 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1713 conv_error
->message
, context
, line
+ 1, column
);
1716 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1718 geany_debug("encoding error: %s", conv_error
->message
);
1719 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1720 g_error_free(conv_error
);
1728 *data
= conv_file_contents
;
1735 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1736 const gchar
*data
, gsize len
)
1738 GError
*error
= NULL
;
1740 if (file_prefs
.use_safe_file_saving
)
1742 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1743 * This is the only option that handles disk space exhaustion. */
1744 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1745 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1747 else if (file_prefs
.use_gio_unsafe_file_saving
)
1751 /* Use GIO API to save file (GVFS-safe)
1752 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1753 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1754 fp
= g_file_new_for_path(locale_filename
);
1755 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1756 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1763 gchar
*display_name
= g_filename_display_name(locale_filename
);
1765 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1766 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1768 fp
= g_fopen(locale_filename
, "wb");
1775 g_file_error_from_errno(save_errno
),
1776 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1778 g_strerror(save_errno
));
1782 gsize bytes_written
;
1785 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1787 if (len
!= bytes_written
)
1793 g_file_error_from_errno(save_errno
),
1794 _("Failed to write file '%s': fwrite() failed: %s"),
1796 g_strerror(save_errno
));
1800 /* preserve the fwrite() error if any */
1801 if (fclose(fp
) != 0 && error
== NULL
)
1807 g_file_error_from_errno(save_errno
),
1808 _("Failed to close file '%s': fclose() failed: %s"),
1810 g_strerror(save_errno
));
1814 g_free(display_name
);
1818 gchar
*msg
= g_strdup(error
->message
);
1819 g_error_free(error
);
1820 /* geany will warn about file truncation for unsafe saving below */
1827 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
1828 const gchar
*data
, gsize len
)
1832 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1833 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1835 err
= write_data_to_disk(locale_filename
, data
, len
);
1839 /* now the file is on disk, set real_path */
1840 if (doc
->real_path
== NULL
)
1842 doc
->real_path
= tm_get_real_path(locale_filename
);
1843 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1844 monitor_file_setup(doc
);
1850 * Saves the document.
1851 * Also shows the Save As dialog if necessary.
1852 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
1854 * Saving may include replacing tabs with spaces,
1855 * stripping trailing spaces and adding a final new line at the end of the file, depending
1856 * on user preferences. Then the @c "document-before-save" signal is emitted,
1857 * allowing plugins to modify the document before it is saved, and data is
1858 * actually written to disk.
1860 * On successful saving:
1861 * - GeanyDocument::real_path is set.
1862 * - The filetype is set again or auto-detected if it wasn't set yet.
1863 * - The @c "document-save" signal is emitted for plugins.
1865 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
1866 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
1867 * added in Geany 1.22.
1869 * @param doc The document to save.
1870 * @param force Whether to save the file even if it is not modified.
1872 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
1874 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
1879 gchar
*locale_filename
;
1880 const GeanyFilePrefs
*fp
;
1882 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1884 if (document_need_save_as(doc
))
1886 /* ensure doc is the current tab before showing the dialog */
1887 document_show_tab(doc
);
1888 return dialogs_show_save_as();
1891 /* the "changed" flag should exclude the "readonly" flag, but check it anyway for safety */
1892 if (doc
->readonly
|| doc
->priv
->protected)
1894 if (!force
&& !doc
->changed
)
1897 fp
= project_get_file_prefs();
1898 /* replaces tabs with spaces but only if the current file is not a Makefile */
1899 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
1900 editor_replace_tabs(doc
->editor
);
1901 /* strip trailing spaces */
1902 if (fp
->strip_trailing_spaces
)
1903 editor_strip_trailing_spaces(doc
->editor
);
1904 /* ensure the file has a newline at the end */
1905 if (fp
->final_new_line
)
1906 editor_ensure_final_newline(doc
->editor
);
1907 /* ensure newlines are consistent */
1908 if (fp
->ensure_convert_new_lines
)
1909 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
1911 /* notify plugins which may wish to modify the document before it's saved */
1912 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
1914 len
= sci_get_length(doc
->editor
->sci
) + 1;
1915 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
1916 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
1917 * encoding, it will be converted to doc->encoding below and this conversion
1918 * also changes the BOM */
1919 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
1920 data
[0] = (gchar
) 0xef;
1921 data
[1] = (gchar
) 0xbb;
1922 data
[2] = (gchar
) 0xbf;
1923 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
1928 data
= (gchar
*) g_malloc(len
);
1929 sci_get_text(doc
->editor
->sci
, len
, data
);
1932 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
1933 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
1934 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
1936 if (! save_convert_to_encoding(doc
, &data
, &len
))
1947 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1949 /* ignore file changed notification when the file is written */
1950 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1952 /* actually write the content of data to the file on disk */
1953 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
1958 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
1960 if (!file_prefs
.use_safe_file_saving
)
1963 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
1965 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
1966 doc
->priv
->file_disk_status
= FILE_OK
;
1968 g_free(locale_filename
);
1973 /* store the opened encoding for undo/redo */
1974 store_saved_encoding(doc
);
1976 /* ignore the following things if we are quitting */
1977 if (! main_status
.quitting
)
1979 sci_set_savepoint(doc
->editor
->sci
);
1981 if (file_prefs
.disk_check_timeout
> 0)
1982 document_update_timestamp(doc
, locale_filename
);
1984 /* update filetype-related things */
1985 document_set_filetype(doc
, doc
->file_type
);
1987 document_update_tab_label(doc
);
1989 msgwin_status_add(_("File %s saved."), doc
->file_name
);
1990 ui_update_statusbar(doc
, -1);
1992 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
1995 g_free(locale_filename
);
1997 g_signal_emit_by_name(geany_object
, "document-save", doc
);
2003 /* special search function, used from the find entry in the toolbar
2004 * return TRUE if text was found otherwise FALSE
2005 * return also TRUE if text is empty */
2006 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gboolean inc
,
2009 gint start_pos
, search_pos
;
2010 struct Sci_TextToFind ttf
;
2012 g_return_val_if_fail(text
!= NULL
, FALSE
);
2013 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2017 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
2018 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
2020 /* search cursor to end or start */
2021 ttf
.chrg
.cpMin
= start_pos
;
2022 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
2023 ttf
.lpstrText
= (gchar
*)text
;
2024 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2026 /* if no match, search start (or end) to cursor */
2027 if (search_pos
== -1)
2031 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
2032 ttf
.chrg
.cpMax
= start_pos
;
2037 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
2039 search_pos
= sci_find_text(doc
->editor
->sci
, 0, &ttf
);
2042 if (search_pos
!= -1)
2044 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2046 /* unfold maybe folded results */
2047 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
2049 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2050 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
2052 if (! editor_line_in_view(doc
->editor
, line
))
2053 { /* we need to force scrolling in case the cursor is outside of the current visible area
2054 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
2055 * while searching */
2056 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
2059 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
2066 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
2069 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
2075 /* General search function, used from the find dialog.
2076 * Returns -1 on failure or the start position of the matching text.
2077 * Will skip past any selection, ignoring it.
2079 * @param text Text to find.
2080 * @param original_text Text as it was entered by user, or @c NULL to use @c text
2082 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
2083 GeanyFindFlags flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
2084 gboolean scroll
, GtkWidget
*parent
)
2086 gint selection_end
, selection_start
, search_pos
;
2088 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
2092 /* Sci doesn't support searching backwards with a regex */
2093 if (flags
& GEANY_FIND_REGEXP
)
2094 search_backwards
= FALSE
;
2097 original_text
= text
;
2099 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2100 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2101 if ((selection_end
- selection_start
) > 0)
2102 { /* there's a selection so go to the end */
2103 if (search_backwards
)
2104 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2106 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2109 sci_set_search_anchor(doc
->editor
->sci
);
2110 if (search_backwards
)
2111 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
2113 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
2115 if (search_pos
!= -1)
2117 /* unfold maybe folded results */
2118 sci_ensure_line_is_visible(doc
->editor
->sci
,
2119 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
2121 doc
->editor
->scroll_percent
= 0.3F
;
2125 gint sci_len
= sci_get_length(doc
->editor
->sci
);
2127 /* if we just searched the whole text, give up searching. */
2128 if ((selection_end
== 0 && ! search_backwards
) ||
2129 (selection_end
== sci_len
&& search_backwards
))
2131 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
2136 /* we searched only part of the document, so ask whether to wraparound. */
2137 if (search_prefs
.always_wrap
||
2138 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
2139 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
2143 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
2144 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
2146 { /* return to original cursor position if not found */
2147 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
2156 /* Replaces the selection if it matches, otherwise just finds the next match.
2157 * Returns: start of replaced text, or -1 if no replacement was made
2159 * @param find_text Text to find.
2160 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
2162 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
2163 const gchar
*replace_text
, GeanyFindFlags flags
, gboolean search_backwards
)
2165 gint selection_end
, selection_start
, search_pos
;
2166 GeanyMatchInfo
*match
= NULL
;
2168 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
2173 /* Sci doesn't support searching backwards with a regex */
2174 if (flags
& GEANY_FIND_REGEXP
)
2175 search_backwards
= FALSE
;
2177 if (!original_find_text
)
2178 original_find_text
= find_text
;
2180 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2181 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2182 if (selection_end
== selection_start
)
2184 /* no selection so just find the next match */
2185 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2188 /* there's a selection so go to the start before finding to search through it
2189 * this ensures there is a match */
2190 if (search_backwards
)
2191 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2193 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2195 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2196 /* return if the original selected text did not match (at the start of the selection) */
2197 if (search_pos
!= selection_start
)
2199 if (search_pos
!= -1)
2200 geany_match_info_free(match
);
2204 if (search_pos
!= -1)
2206 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2207 /* select the replacement - find text will skip past the selected text */
2208 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2209 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2210 geany_match_info_free(match
);
2214 /* no match in the selection */
2221 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2222 const gchar
*original_replace_text
)
2228 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2232 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2233 ui_set_statusbar(TRUE
, ngettext(
2234 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2235 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2236 count
), filename
, count
, original_find_text
, original_replace_text
);
2241 /* Replace all text matches in a certain range within document.
2242 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2243 * or -1 if no text was found.
2244 * scroll_to_match is whether to scroll the last replacement in view (which also
2245 * clears the selection).
2246 * Returns: the number of replacements made. */
2248 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2249 GeanyFindFlags flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2252 struct Sci_TextToFind ttf
;
2253 ScintillaObject
*sci
;
2255 if (new_range_end
!= NULL
)
2256 *new_range_end
= -1;
2258 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2260 if (! *find_text
|| doc
->readonly
)
2263 sci
= doc
->editor
->sci
;
2265 ttf
.chrg
.cpMin
= start
;
2266 ttf
.chrg
.cpMax
= end
;
2267 ttf
.lpstrText
= (gchar
*)find_text
;
2269 sci_start_undo_action(sci
);
2270 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2271 sci_end_undo_action(sci
);
2274 { /* scroll last match in view, will destroy the existing selection */
2275 if (scroll_to_match
)
2276 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2278 if (new_range_end
!= NULL
)
2279 *new_range_end
= ttf
.chrg
.cpMax
;
2285 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2286 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2288 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2289 gint max_column
= 0, count
= 0;
2290 gboolean replaced
= FALSE
;
2292 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2297 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2298 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2299 /* do we have a selection? */
2300 if ((selection_end
- selection_start
) == 0)
2306 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2307 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2308 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2309 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2311 gint first_line
, line
;
2313 sci_start_undo_action(doc
->editor
->sci
);
2315 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2316 /* Find the last line with chars selected (not EOL char) */
2317 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2318 selection_end
- editor_get_eol_char_len(doc
->editor
));
2319 last_line
= MAX(first_line
, last_line
);
2320 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2322 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2323 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2325 /* skip line if there is no selection */
2326 if (line_start
!= INVALID_POSITION
)
2328 /* don't let document_replace_range() scroll to match to keep our selection */
2331 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2332 line_start
, line_end
, FALSE
, &new_sel_end
);
2333 if (new_sel_end
!= -1)
2336 /* this gets the greatest column within the selection after replacing */
2337 max_column
= MAX(max_column
,
2338 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2342 sci_end_undo_action(doc
->editor
->sci
);
2344 else /* handle normal line selection */
2346 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2347 selection_start
, selection_end
, TRUE
, &selection_end
);
2348 if (selection_end
!= -1)
2353 { /* update the selection for the new endpoint */
2355 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2357 /* now we can scroll to the selection and destroy it because we rebuild it later */
2358 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2360 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2361 * the highest column on the last line. The wrapped selection is completely different
2362 * from the original one, so skip the selection at all */
2363 /* TODO is there a better way to handle the wrapped selection? */
2364 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2365 { /* for keeping and adjusting the selection in multi line rectangle selection we
2366 * need the last line of the original selection and the greatest column number after
2367 * replacing and set the selection end to the last line at the greatest column */
2368 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2369 sci_set_selection_end(doc
->editor
->sci
,
2370 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2371 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2376 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2377 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2380 else /* no replacements */
2383 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2387 /* returns number of replacements made. */
2388 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2389 const gchar
*original_find_text
, const gchar
*original_replace_text
, GeanyFindFlags flags
)
2392 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2397 len
= sci_get_length(doc
->editor
->sci
);
2398 count
= document_replace_range(
2399 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2401 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2407 * Parses or re-parses the document's buffer and updates the type
2408 * keywords and symbol list.
2410 * @param doc The document.
2412 void document_update_tags(GeanyDocument
*doc
)
2417 g_return_if_fail(DOC_VALID(doc
));
2418 g_return_if_fail(app
->tm_workspace
!= NULL
);
2420 /* early out if it's a new file or doesn't support tags */
2421 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2423 /* We must call sidebar_update_tag_list() before returning,
2424 * to ensure that the symbol list is always updated properly (e.g.
2425 * when creating a new document with a partial filename set. */
2426 sidebar_update_tag_list(doc
, FALSE
);
2430 /* create a new TM file if there isn't one yet */
2433 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2436 /* lookup the name rather than using filetype name to support custom filetypes */
2437 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2438 doc
->tm_file
= tm_source_file_new(locale_filename
, FALSE
, name
);
2439 g_free(locale_filename
);
2441 if (doc
->tm_file
&& !tm_workspace_add_object(doc
->tm_file
))
2443 tm_work_object_free(doc
->tm_file
);
2444 doc
->tm_file
= NULL
;
2448 /* early out if there's no work object and we couldn't create one */
2449 if (doc
->tm_file
== NULL
)
2451 /* We must call sidebar_update_tag_list() before returning,
2452 * to ensure that the symbol list is always updated properly (e.g.
2453 * when creating a new document with a partial filename set. */
2454 sidebar_update_tag_list(doc
, FALSE
);
2458 len
= sci_get_length(doc
->editor
->sci
);
2459 /* tm_source_file_buffer_update() below don't support 0-length data,
2460 * so just empty the tags array and leave */
2463 tm_tags_array_free(doc
->tm_file
->tags_array
, FALSE
);
2464 sidebar_update_tag_list(doc
, FALSE
);
2468 /* Parse Scintilla's buffer directly using TagManager
2469 * Note: this buffer *MUST NOT* be modified */
2470 buffer_ptr
= (guchar
*) scintilla_send_message(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2471 tm_source_file_buffer_update(doc
->tm_file
, buffer_ptr
, len
, TRUE
);
2473 sidebar_update_tag_list(doc
, TRUE
);
2474 document_highlight_tags(doc
);
2478 /* Re-highlights type keywords without re-parsing the whole document. */
2479 void document_highlight_tags(GeanyDocument
*doc
)
2481 GString
*keywords_str
;
2485 /* some filetypes support type keywords (such as struct names), but not
2486 * necessarily all filetypes for a particular scintilla lexer. this
2487 * tells us whether the filetype supports keywords, and if so
2488 * which index to use for the scintilla keywords set. */
2489 switch (doc
->file_type
->id
)
2491 case GEANY_FILETYPES_C
:
2492 case GEANY_FILETYPES_CPP
:
2493 case GEANY_FILETYPES_CS
:
2494 case GEANY_FILETYPES_D
:
2495 case GEANY_FILETYPES_JAVA
:
2496 case GEANY_FILETYPES_OBJECTIVEC
:
2497 case GEANY_FILETYPES_VALA
:
2498 case GEANY_FILETYPES_RUST
:
2501 /* index of the keyword set in the Scintilla lexer, for
2502 * example in LexCPP.cxx, see "cppWordLists" global array.
2503 * TODO: this magic number should be a member of the filetype */
2508 return; /* early out if type keywords are not supported */
2510 if (!app
->tm_workspace
->work_object
.tags_array
)
2513 /* get any type keywords and tell scintilla about them
2514 * this will cause the type keywords to be colourized in scintilla */
2515 keywords_str
= symbols_find_tags_as_string(app
->tm_workspace
->work_object
.tags_array
,
2516 TM_GLOBAL_TYPE_MASK
, doc
->file_type
->lang
);
2519 keywords
= g_string_free(keywords_str
, FALSE
);
2520 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2522 queue_colourise(doc
); /* force re-highlighting the entire document */
2527 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2529 GeanyDocument
*doc
= data
;
2531 if (! DOC_VALID(doc
))
2534 if (! main_status
.quitting
)
2535 document_update_tags(doc
);
2537 doc
->priv
->tag_list_update_source
= 0;
2539 /* don't update the tags until another modification of the buffer */
2544 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2546 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2549 /* prevent "stacking up" callback handlers, we only need one to run soon */
2550 if (doc
->priv
->tag_list_update_source
!= 0)
2551 g_source_remove(doc
->priv
->tag_list_update_source
);
2553 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2554 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2558 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2559 gboolean filetype_changed
)
2561 g_return_if_fail(doc
);
2563 type
= filetypes
[GEANY_FILETYPES_NONE
];
2565 if (filetype_changed
)
2567 doc
->file_type
= type
;
2569 /* delete tm file object to force creation of a new one */
2570 if (doc
->tm_file
!= NULL
)
2572 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
2573 doc
->tm_file
= NULL
;
2575 /* load tags files before highlighting (some lexers highlight global typenames) */
2576 if (type
->id
!= GEANY_FILETYPES_NONE
)
2577 symbols_global_tags_loaded(type
->id
);
2579 highlighting_set_styles(doc
->editor
->sci
, type
);
2580 editor_set_indentation_guides(doc
->editor
);
2581 build_menu_update(doc
);
2582 queue_colourise(doc
);
2583 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2586 document_update_tags(doc
);
2590 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2591 * @param doc The document to use.
2592 * @param type The filetype. */
2593 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2595 gboolean ft_changed
;
2596 GeanyFiletype
*old_ft
;
2598 g_return_if_fail(doc
);
2600 type
= filetypes
[GEANY_FILETYPES_NONE
];
2602 old_ft
= doc
->file_type
;
2603 geany_debug("%s : %s (%s)",
2604 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2606 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2608 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2609 document_load_config(doc
, type
, ft_changed
);
2613 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2615 /* assume that if previous filetype was none and the settings are the default ones, this
2616 * is the first time the filetype is carefully set, so we should apply indent settings */
2617 if ((! old_ft
|| old_ft
->id
== GEANY_FILETYPES_NONE
) &&
2618 doc
->editor
->indent_type
== iprefs
->type
&&
2619 doc
->editor
->indent_width
== iprefs
->width
)
2621 document_apply_indent_settings(doc
);
2622 ui_document_show_hide(doc
);
2625 sidebar_openfiles_update(doc
); /* to update the icon */
2626 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2631 void document_reload_config(GeanyDocument
*doc
)
2633 document_load_config(doc
, doc
->file_type
, TRUE
);
2638 * Sets the encoding of a document.
2639 * This function only set the encoding of the %document, it does not any conversions. The new
2640 * encoding is used when e.g. saving the file.
2642 * @param doc The document to use.
2643 * @param new_encoding The encoding to be set for the document.
2645 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2647 if (doc
== NULL
|| new_encoding
== NULL
||
2648 utils_str_equal(new_encoding
, doc
->encoding
))
2651 g_free(doc
->encoding
);
2652 doc
->encoding
= g_strdup(new_encoding
);
2654 ui_update_statusbar(doc
, -1);
2655 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2656 encodings_is_unicode_charset(doc
->encoding
));
2660 /* own Undo / Redo implementation to be able to undo / redo changes
2661 * to the encoding or the Unicode BOM (which are Scintilla independet).
2662 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2664 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2665 void document_undo_clear(GeanyDocument
*doc
)
2669 while (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0)
2671 a
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2672 if (G_LIKELY(a
!= NULL
))
2676 case UNDO_ENCODING
: g_free(a
->data
); break;
2682 doc
->priv
->undo_actions
= NULL
;
2684 while (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0)
2686 a
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2687 if (G_LIKELY(a
!= NULL
))
2691 case UNDO_ENCODING
: g_free(a
->data
); break;
2697 doc
->priv
->redo_actions
= NULL
;
2699 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2700 document_set_text_changed(doc
, FALSE
);
2704 /* note: this is called on SCN_MODIFIED notifications */
2705 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2707 undo_action
*action
;
2709 g_return_if_fail(doc
!= NULL
);
2711 action
= g_new0(undo_action
, 1);
2712 action
->type
= type
;
2713 action
->data
= data
;
2715 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2717 /* avoid unnecessary redraws */
2718 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2719 document_set_text_changed(doc
, TRUE
);
2721 ui_update_popup_reundo_items(doc
);
2725 gboolean
document_can_undo(GeanyDocument
*doc
)
2727 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2729 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2736 static void update_changed_state(GeanyDocument
*doc
)
2739 (sci_is_modified(doc
->editor
->sci
) ||
2740 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2741 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2742 document_set_text_changed(doc
, doc
->changed
);
2746 void document_undo(GeanyDocument
*doc
)
2748 undo_action
*action
;
2750 g_return_if_fail(doc
!= NULL
);
2752 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2754 if (G_UNLIKELY(action
== NULL
))
2756 /* fallback, should not be necessary */
2757 geany_debug("%s: fallback used", G_STRFUNC
);
2758 sci_undo(doc
->editor
->sci
);
2762 switch (action
->type
)
2764 case UNDO_SCINTILLA
:
2766 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
2768 sci_undo(doc
->editor
->sci
);
2773 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2775 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2776 ui_update_statusbar(doc
, -1);
2777 ui_document_show_hide(doc
);
2782 /* use the "old" encoding */
2783 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2785 document_set_encoding(doc
, (const gchar
*)action
->data
);
2787 ignore_callback
= TRUE
;
2788 encodings_select_radio_item((const gchar
*)action
->data
);
2789 ignore_callback
= FALSE
;
2791 g_free(action
->data
);
2797 g_free(action
); /* free the action which was taken from the stack */
2799 update_changed_state(doc
);
2800 ui_update_popup_reundo_items(doc
);
2804 gboolean
document_can_redo(GeanyDocument
*doc
)
2806 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2808 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
2815 void document_redo(GeanyDocument
*doc
)
2817 undo_action
*action
;
2819 g_return_if_fail(doc
!= NULL
);
2821 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2823 if (G_UNLIKELY(action
== NULL
))
2825 /* fallback, should not be necessary */
2826 geany_debug("%s: fallback used", G_STRFUNC
);
2827 sci_redo(doc
->editor
->sci
);
2831 switch (action
->type
)
2833 case UNDO_SCINTILLA
:
2835 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
2837 sci_redo(doc
->editor
->sci
);
2842 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2844 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2845 ui_update_statusbar(doc
, -1);
2846 ui_document_show_hide(doc
);
2851 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2853 document_set_encoding(doc
, (const gchar
*)action
->data
);
2855 ignore_callback
= TRUE
;
2856 encodings_select_radio_item((const gchar
*)action
->data
);
2857 ignore_callback
= FALSE
;
2859 g_free(action
->data
);
2865 g_free(action
); /* free the action which was taken from the stack */
2867 update_changed_state(doc
);
2868 ui_update_popup_reundo_items(doc
);
2872 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2874 undo_action
*action
;
2876 g_return_if_fail(doc
!= NULL
);
2878 action
= g_new0(undo_action
, 1);
2879 action
->type
= type
;
2880 action
->data
= data
;
2882 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
2884 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2885 document_set_text_changed(doc
, TRUE
);
2887 ui_update_popup_reundo_items(doc
);
2894 #ifdef USE_GIO_FILEMON
2895 STATUS_DISK_CHANGED
,
2904 } document_status_styles
[] = {
2905 { "geany-document-status-changed", {0}, FALSE
},
2906 #ifdef USE_GIO_FILEMON
2907 { "geany-document-status-disk-changed", {0}, FALSE
},
2909 { "geany-document-status-readonly", {0}, FALSE
}
2913 static gint
document_get_status_id(GeanyDocument
*doc
)
2916 return STATUS_CHANGED
;
2917 #ifdef USE_GIO_FILEMON
2918 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
2919 return STATUS_DISK_CHANGED
;
2921 else if (doc
->readonly
)
2922 return STATUS_READONLY
;
2928 /* returns an identifier that is to be set as a widget name or class to get it styled
2929 * depending on the document status (changed, readonly, etc.)
2930 * a NULL return value means default (unchanged) style */
2931 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
2935 g_return_val_if_fail(doc
!= NULL
, NULL
);
2937 status
= document_get_status_id(doc
);
2941 return document_status_styles
[status
].name
;
2946 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
2947 * Returned colors are red if the document has changes, green if the document is read-only
2948 * or simply @c NULL if the document is unmodified but writable.
2950 * @param doc The document to use.
2952 * @return The color for the document or @c NULL if the default color should be used. The color
2953 * object is owned by Geany and should not be modified or freed.
2957 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
2961 g_return_val_if_fail(doc
!= NULL
, NULL
);
2963 status
= document_get_status_id(doc
);
2966 if (! document_status_styles
[status
].loaded
)
2968 #if GTK_CHECK_VERSION(3, 0, 0)
2970 GtkWidgetPath
*path
= gtk_widget_path_new();
2971 GtkStyleContext
*ctx
= gtk_style_context_new();
2972 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
2973 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
2974 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
2975 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
2976 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
2977 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
2978 gtk_style_context_set_path(ctx
, path
);
2979 gtk_style_context_get_color(ctx
, GTK_STATE_NORMAL
, &color
);
2980 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
2981 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
2982 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
2983 document_status_styles
[status
].loaded
= TRUE
;
2984 gtk_widget_path_unref(path
);
2985 g_object_unref(ctx
);
2987 GtkSettings
*settings
= gtk_widget_get_settings(GTK_WIDGET(doc
->editor
->sci
));
2988 gchar
*path
= g_strconcat("GeanyMainWindow.GtkHBox.GtkNotebook.",
2989 document_status_styles
[status
].name
, NULL
);
2990 GtkStyle
*style
= gtk_rc_get_style_by_paths(settings
, path
, NULL
, GTK_TYPE_LABEL
);
2992 document_status_styles
[status
].color
= style
->fg
[GTK_STATE_NORMAL
];
2993 document_status_styles
[status
].loaded
= TRUE
;
2997 return &document_status_styles
[status
].color
;
3001 /** Accessor function for @ref documents_array items.
3002 * @warning Always check the returned document is valid (@c doc->is_valid).
3003 * @param idx @c documents_array index.
3004 * @return The document, or @c NULL if @a idx is out of range.
3008 GeanyDocument
*document_index(gint idx
)
3010 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
3014 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
3018 ScintillaObject
*old_sci
;
3020 g_return_val_if_fail(old_doc
, NULL
);
3021 old_sci
= old_doc
->editor
->sci
;
3022 if (sci_has_selection(old_sci
))
3023 text
= sci_get_selection_contents(old_sci
);
3025 text
= sci_get_contents(old_sci
, -1);
3027 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
3029 document_set_text_changed(doc
, TRUE
);
3031 /* copy file properties */
3032 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
3033 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
3034 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
3035 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
3036 old_doc
->editor
->indent_width
);
3037 doc
->readonly
= old_doc
->readonly
;
3038 doc
->has_bom
= old_doc
->has_bom
;
3039 doc
->priv
->protected = 0;
3040 document_set_encoding(doc
, old_doc
->encoding
);
3041 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
3042 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
3045 ui_document_show_hide(doc
);
3050 /* @note If successful, this should always be followed up with a call to
3051 * document_close_all().
3052 * @return TRUE if all files were saved or had their changes discarded. */
3053 gboolean
document_account_for_unsaved(void)
3055 guint i
, p
, page_count
;
3057 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
3058 /* iterate over documents in tabs order */
3059 for (p
= 0; p
< page_count
; p
++)
3061 GeanyDocument
*doc
= document_get_from_page(p
);
3063 if (DOC_VALID(doc
) && doc
->changed
)
3065 if (! dialogs_show_unsaved_file(doc
))
3069 /* all documents should now be accounted for, so ignore any changes */
3070 foreach_document (i
)
3072 documents
[i
]->changed
= FALSE
;
3078 static void force_close_all(void)
3080 guint i
, len
= documents_array
->len
;
3082 /* check all documents have been accounted for */
3083 for (i
= 0; i
< len
; i
++)
3085 if (documents
[i
]->is_valid
)
3087 g_return_if_fail(!documents
[i
]->changed
);
3090 main_status
.closing_all
= TRUE
;
3094 document_close(documents
[i
]);
3097 main_status
.closing_all
= FALSE
;
3101 gboolean
document_close_all(void)
3103 if (! document_account_for_unsaved())
3113 * Shows a message related to a document.
3115 * Use this whenever the user needs to see a document-related message,
3116 * for example when the file was externally modified or deleted.
3118 * Any of the buttons can be @c NULL. If not @c NULL, @a btn_1's
3119 * @a response_1 response will be the default for the @c GtkInfoBar or
3122 * @param doc @c GeanyDocument.
3123 * @param msgtype The type of message.
3124 * @param response_cb A callback function called when there's a response.
3125 * @param btn_1 The first action area button.
3126 * @param response_1 The response for @a btn_1.
3127 * @param btn_2 The second action area button.
3128 * @param response_2 The response for @a btn_2.
3129 * @param btn_3 The third action area button.
3130 * @param response_3 The response for @a btn_3.
3131 * @param extra_text Text to show below the main message.
3132 * @param format The text format for the main message.
3133 * @param ... Used with @a format as in @c printf.
3137 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
3138 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
3139 const gchar
*btn_1
, GtkResponseType response_1
,
3140 const gchar
*btn_2
, GtkResponseType response_2
,
3141 const gchar
*btn_3
, GtkResponseType response_3
,
3142 const gchar
*extra_text
, const gchar
*format
, ...)
3145 gchar
*text
, *markup
;
3146 GtkWidget
*hbox
, *vbox
, *icon
, *label
, *extra_label
, *content_area
;
3147 GtkWidget
*info_widget
, *parent
;
3148 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
),
3149 document_get_notebook_page(doc
));
3151 va_start(args
, format
);
3152 text
= g_strdup_vprintf(format
, args
);
3155 markup
= g_strdup_printf("<span size=\"larger\">%s</span>", text
);
3158 info_widget
= gtk_info_bar_new();
3159 /* must be done now else Gtk-WARNING: widget not within a GtkWindow */
3160 gtk_box_pack_start(GTK_BOX(parent
), info_widget
, FALSE
, TRUE
, 0);
3162 gtk_info_bar_set_message_type(GTK_INFO_BAR(info_widget
), msgtype
);
3165 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_1
, response_1
);
3167 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_2
, response_2
);
3169 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_3
, response_3
);
3171 content_area
= gtk_info_bar_get_content_area(GTK_INFO_BAR(info_widget
));
3173 label
= geany_wrap_label_new(NULL
);
3174 gtk_label_set_markup(GTK_LABEL(label
), markup
);
3177 g_signal_connect(info_widget
, "response", G_CALLBACK(response_cb
), doc
);
3178 g_signal_connect_after(info_widget
, "response", G_CALLBACK(gtk_widget_destroy
), NULL
);
3180 hbox
= gtk_hbox_new(FALSE
, 12);
3181 gtk_box_pack_start(GTK_BOX(content_area
), hbox
, TRUE
, TRUE
, 0);
3185 case GTK_MESSAGE_INFO
:
3186 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_INFO
, GTK_ICON_SIZE_DIALOG
);
3188 case GTK_MESSAGE_WARNING
:
3189 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_WARNING
, GTK_ICON_SIZE_DIALOG
);
3191 case GTK_MESSAGE_QUESTION
:
3192 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_QUESTION
, GTK_ICON_SIZE_DIALOG
);
3194 case GTK_MESSAGE_ERROR
:
3195 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_ERROR
, GTK_ICON_SIZE_DIALOG
);
3203 gtk_box_pack_start(GTK_BOX(hbox
), icon
, FALSE
, TRUE
, 0);
3207 vbox
= gtk_vbox_new(FALSE
, 6);
3208 extra_label
= geany_wrap_label_new(extra_text
);
3209 gtk_box_pack_start(GTK_BOX(vbox
), label
, TRUE
, TRUE
, 0);
3210 gtk_box_pack_start(GTK_BOX(vbox
), extra_label
, TRUE
, TRUE
, 0);
3211 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, TRUE
, TRUE
, 0);
3214 gtk_box_pack_start(GTK_BOX(hbox
), label
, TRUE
, TRUE
, 0);
3216 gtk_box_reorder_child(GTK_BOX(parent
), info_widget
, 0);
3218 gtk_widget_show_all(info_widget
);
3223 static void on_monitor_reload_file_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
3225 unprotect_document(doc
);
3226 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = NULL
;
3228 if (response_id
== RESPONSE_DOCUMENT_RELOAD
)
3229 document_reload_file(doc
, doc
->encoding
);
3230 else if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3231 document_save_file(doc
, FALSE
);
3234 static gboolean
on_sci_key(GtkWidget
*widget
, GdkEventKey
*event
, gpointer data
)
3236 GtkInfoBar
*bar
= GTK_INFO_BAR(data
);
3238 g_return_val_if_fail(event
->type
== GDK_KEY_PRESS
, FALSE
);
3240 switch (event
->keyval
)
3243 case GDK_ISO_Left_Tab
:
3245 GtkWidget
*action_area
= gtk_info_bar_get_action_area(bar
);
3246 GtkDirectionType dir
= event
->keyval
== GDK_Tab
? GTK_DIR_TAB_FORWARD
: GTK_DIR_TAB_BACKWARD
;
3247 gtk_widget_child_focus(action_area
, dir
);
3252 gtk_info_bar_response(bar
, GTK_RESPONSE_CANCEL
);
3261 /* Sets up a signal handler to intercept some keys during the lifetime of the GtkInfoBar */
3262 static void enable_key_intercept(GeanyDocument
*doc
, GtkWidget
*bar
)
3264 /* automatically focus editor again on bar close */
3265 g_signal_connect_object(bar
, "destroy", G_CALLBACK(gtk_widget_grab_focus
), doc
->editor
->sci
,
3267 g_signal_connect_object(doc
->editor
->sci
, "key-press-event", G_CALLBACK(on_sci_key
), bar
, 0);
3271 static void monitor_reload_file(GeanyDocument
*doc
)
3273 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
3275 /* show this message only once */
3276 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] == NULL
)
3280 bar
= document_show_message(doc
, GTK_MESSAGE_QUESTION
, on_monitor_reload_file_response
,
3281 _("_Reload"), RESPONSE_DOCUMENT_RELOAD
,
3282 GTK_STOCK_SAVE
, RESPONSE_DOCUMENT_SAVE
,
3283 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3284 _("Do you want to reload it?"),
3285 _("The file '%s' on the disk is more recent than the current buffer."),
3288 document_set_text_changed(doc
, TRUE
);
3289 protect_document(doc
);
3290 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3291 enable_key_intercept(doc
, bar
);
3297 static void on_monitor_resave_missing_file_response(GtkWidget
*bar
,
3301 unprotect_document(doc
);
3303 if (response_id
== RESPONSE_DOCUMENT_SAVE
)
3304 dialogs_show_save_as();
3306 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = NULL
;
3310 static void monitor_resave_missing_file(GeanyDocument
*doc
)
3312 if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] == NULL
)
3314 GtkWidget
*bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
3316 if (bar
!= NULL
) /* the "file on disk is newer" warning is now moot */
3317 gtk_info_bar_response(GTK_INFO_BAR(bar
), GTK_RESPONSE_CANCEL
);
3319 bar
= document_show_message(doc
, GTK_MESSAGE_WARNING
,
3320 on_monitor_resave_missing_file_response
,
3321 GTK_STOCK_SAVE
, RESPONSE_DOCUMENT_SAVE
,
3322 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3323 NULL
, GTK_RESPONSE_NONE
,
3324 _("Try to resave the file?"),
3325 _("File \"%s\" was not found on disk!"),
3328 protect_document(doc
);
3329 document_set_text_changed(doc
, TRUE
);
3330 /* don't prompt more than once */
3331 SETPTR(doc
->real_path
, NULL
);
3332 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = bar
;
3333 enable_key_intercept(doc
, bar
);
3338 /* Set force to force a disk check, otherwise it is ignored if there was a check
3339 * in the last file_prefs.disk_check_timeout seconds.
3340 * @return @c TRUE if the file has changed. */
3341 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3343 gboolean ret
= FALSE
;
3344 gboolean use_gio_filemon
;
3345 time_t cur_time
= 0;
3347 gchar
*locale_filename
;
3348 FileDiskStatus old_status
;
3350 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3352 /* ignore remote files and documents that have never been saved to disk */
3353 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3354 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3357 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3359 if (use_gio_filemon
)
3361 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3366 cur_time
= time(NULL
);
3367 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3370 doc
->priv
->last_check
= cur_time
;
3373 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3374 if (g_stat(locale_filename
, &st
) != 0)
3376 monitor_resave_missing_file(doc
);
3377 /* doc may be closed now */
3380 else if (! use_gio_filemon
&& /* ignore check when using GIO */
3381 doc
->priv
->mtime
> cur_time
)
3383 g_warning("%s: Something is wrong with the time stamps.", G_STRFUNC
);
3384 /* Note: on Windows st.st_mtime can be newer than cur_time */
3386 else if (doc
->priv
->mtime
< st
.st_mtime
)
3388 /* make sure the user is not prompted again after he cancelled the "reload file?" message */
3389 doc
->priv
->mtime
= st
.st_mtime
;
3390 monitor_reload_file(doc
);
3391 /* doc may be closed now */
3394 g_free(locale_filename
);
3397 { /* doc can get invalid when a document was closed */
3398 old_status
= doc
->priv
->file_disk_status
;
3399 doc
->priv
->file_disk_status
= FILE_OK
;
3400 if (old_status
!= doc
->priv
->file_disk_status
)
3401 ui_update_tab_status(doc
);
3407 /** Compares documents by their display names.
3408 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3409 * @note 'Display name' means the base name of the document's filename.
3411 * @param a @c GeanyDocument**.
3412 * @param b @c GeanyDocument**.
3413 * @warning The arguments take the address of each document pointer.
3414 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3418 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3420 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3421 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3422 gchar
*base_name_a
, *base_name_b
;
3425 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3426 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3428 result
= strcmp(base_name_a
, base_name_b
);
3430 g_free(base_name_a
);
3431 g_free(base_name_b
);
3437 /** Compares documents by their tab order.
3438 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3440 * @param a @c GeanyDocument**.
3441 * @param b @c GeanyDocument**.
3442 * @warning The arguments take the address of each document pointer.
3443 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3445 * @since 0.21 (GEANY_API_VERSION 209)
3447 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3449 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3450 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3451 gint notebook_position_doc_a
;
3452 gint notebook_position_doc_b
;
3454 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3455 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3457 if (notebook_position_doc_a
< notebook_position_doc_b
)
3459 if (notebook_position_doc_a
> notebook_position_doc_b
)
3466 /** Compares documents by their tab order, in reverse order.
3467 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3469 * @param a @c GeanyDocument**.
3470 * @param b @c GeanyDocument**.
3471 * @warning The arguments take the address of each document pointer.
3472 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3474 * @since 0.21 (GEANY_API_VERSION 209)
3476 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3478 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3479 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3480 gint notebook_position_doc_a
;
3481 gint notebook_position_doc_b
;
3483 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3484 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3486 if (notebook_position_doc_a
< notebook_position_doc_b
)
3488 if (notebook_position_doc_a
> notebook_position_doc_b
)
3495 void document_grab_focus(GeanyDocument
*doc
)
3497 g_return_if_fail(doc
!= NULL
);
3499 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));