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"
56 #include "gtkcompat.h"
58 #ifdef HAVE_SYS_TIME_H
59 # include <sys/time.h>
67 #ifdef HAVE_SYS_TYPES_H
68 # include <sys/types.h>
73 /* gstdio.h also includes sys/stat.h */
74 #include <glib/gstdio.h>
76 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
77 /*#define USE_GIO_FILEMON 1*/
80 #include <gdk/gdkkeysyms.h>
82 GeanyFilePrefs file_prefs
;
85 /** Dynamic array of GeanyDocument pointers.
86 * Once a pointer is added to this, it is never freed. This means you can keep a pointer
87 * to a document over time, but it may represent a different
88 * document later on, or may have been closed and become invalid.
90 * @warning You must check @c GeanyDocument::is_valid when iterating over this array.
91 * This is done automatically if you use the foreach_document() macro.
94 * Never assume that the order of document pointers is the same as the order of notebook tabs.
95 * One reason is that notebook tabs can be reordered.
96 * Use @c document_get_from_page() to lookup a document from a notebook tab number.
99 GPtrArray
*documents_array
= NULL
;
102 /* an undo action, also used for redo actions */
105 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
106 guint type
; /* to identify the action */
107 gpointer
*data
; /* the old value (before the change), in case of a redo action
108 * it contains the new value */
112 static void document_undo_clear(GeanyDocument
*doc
);
113 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
114 static gboolean
remove_page(guint page_num
);
115 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
116 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
117 const gchar
*btn_1
, GtkResponseType response_1
,
118 const gchar
*btn_2
, GtkResponseType response_2
,
119 const gchar
*btn_3
, GtkResponseType response_3
,
120 const gchar
*extra_text
, const gchar
*format
, ...) G_GNUC_PRINTF(11, 12);
124 * Finds a document whose @c real_path field matches the given filename.
126 * @param realname The filename to search, which should be identical to the
127 * string returned by @c tm_get_real_path().
129 * @return The matching document, or @c NULL.
130 * @note This is only really useful when passing a @c TMWorkObject::file_name.
131 * @see GeanyDocument::real_path.
132 * @see document_find_by_filename().
136 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
141 return NULL
; /* file doesn't exist on disk */
143 for (i
= 0; i
< documents_array
->len
; i
++)
145 GeanyDocument
*doc
= documents
[i
];
147 if (! doc
->is_valid
|| ! doc
->real_path
)
150 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
159 /* dereference symlinks, /../ junk in path and return locale encoding */
160 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
162 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
163 gchar
*realname
= tm_get_real_path(locale_name
);
171 * Finds a document with the given filename.
172 * This matches either an exact GeanyDocument::file_name string, or variant
173 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
176 * @param utf8_filename The filename to search (in UTF-8 encoding).
178 * @return The matching document, or @c NULL.
179 * @see document_find_by_real_path().
181 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
187 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
189 /* First search GeanyDocument::file_name, so we can find documents with a
190 * filename set but not saved on disk, like vcdiff produces */
191 for (i
= 0; i
< documents_array
->len
; i
++)
195 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
198 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
203 /* Now try matching based on the realpath(), which is unique per file on disk */
204 realname
= get_real_path_from_utf8(utf8_filename
);
205 doc
= document_find_by_real_path(realname
);
211 /* returns the document which has sci, or NULL. */
212 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
216 g_return_val_if_fail(sci
!= NULL
, NULL
);
218 for (i
= 0; i
< documents_array
->len
; i
++)
220 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
227 /** Gets the notebook page index for a document.
228 * @param doc The document.
231 gint
document_get_notebook_page(GeanyDocument
*doc
)
236 g_return_val_if_fail(doc
!= NULL
, -1);
238 child
= GTK_WIDGET(doc
->editor
->sci
);
239 parent
= gtk_widget_get_parent(child
);
240 /* search for the direct notebook child, mirroring document_get_from_page() */
241 while (parent
&& ! GTK_IS_NOTEBOOK(parent
))
244 parent
= gtk_widget_get_parent(child
);
247 return gtk_notebook_page_num(GTK_NOTEBOOK(main_widgets
.notebook
), child
);
252 * Recursively searches a containers children until it finds a
253 * Scintilla widget, or NULL if one was not found.
255 static ScintillaObject
*locate_sci_in_container(GtkWidget
*container
)
257 ScintillaObject
*sci
= NULL
;
258 GList
*children
, *iter
;
260 g_return_val_if_fail(GTK_IS_CONTAINER(container
), NULL
);
262 children
= gtk_container_get_children(GTK_CONTAINER(container
));
263 for (iter
= children
; iter
!= NULL
; iter
= g_list_next(iter
))
265 if (IS_SCINTILLA(iter
->data
))
267 sci
= SCINTILLA(iter
->data
);
270 else if (GTK_IS_CONTAINER(iter
->data
))
272 sci
= locate_sci_in_container(iter
->data
);
273 if (IS_SCINTILLA(sci
))
278 g_list_free(children
);
285 * Finds the document for the given notebook page @a page_num.
287 * @param page_num The notebook page number to search.
289 * @return The corresponding document for the given notebook page, or @c NULL.
291 GeanyDocument
*document_get_from_page(guint page_num
)
294 ScintillaObject
*sci
;
296 if (page_num
>= documents_array
->len
)
299 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
300 g_return_val_if_fail(GTK_IS_BOX(parent
), NULL
);
302 sci
= locate_sci_in_container(parent
);
303 g_return_val_if_fail(IS_SCINTILLA(sci
), NULL
);
305 return document_find_by_sci(sci
);
310 * Finds the current document.
312 * @return A pointer to the current document or @c NULL if there are no opened documents.
314 GeanyDocument
*document_get_current(void)
316 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
321 return document_get_from_page((guint
) cur_page
);
325 void document_init_doclist(void)
327 documents_array
= g_ptr_array_new();
331 void document_finalize(void)
335 for (i
= 0; i
< documents_array
->len
; i
++)
336 g_free(documents
[i
]);
337 g_ptr_array_free(documents_array
, TRUE
);
342 * Returns the last part of the filename of the given GeanyDocument. The result is also
343 * truncated to a maximum of @a length characters in case the filename is very long.
345 * @param doc The document to use.
346 * @param length The length of the resulting string or -1 to use a default value.
348 * @return The ellipsized last part of the filename of @a doc, should be freed when no
353 /* TODO make more use of this */
354 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
356 gchar
*base_name
, *short_name
;
358 g_return_val_if_fail(doc
!= NULL
, NULL
);
363 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
364 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
372 void document_update_tab_label(GeanyDocument
*doc
)
377 g_return_if_fail(doc
!= NULL
);
379 short_name
= document_get_basename_for_display(doc
, -1);
381 /* we need to use the event box for the tooltip, labels don't get the necessary events */
382 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
383 parent
= gtk_widget_get_parent(parent
);
385 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
387 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
394 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
395 * according to the document's save state.
396 * This is called by Geany mostly when opening or saving files.
398 * @param doc The document to use.
399 * @param changed Whether the document state should indicate changes have been made.
401 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
403 g_return_if_fail(doc
!= NULL
);
405 doc
->changed
= changed
;
407 if (! main_status
.quitting
)
409 ui_update_tab_status(doc
);
410 ui_save_buttons_toggle(changed
);
411 ui_set_window_title(doc
);
412 ui_update_statusbar(doc
, -1);
417 /* returns the next free place in the document list,
418 * or -1 if the documents_array is full */
419 static gint
document_get_new_idx(void)
423 for (i
= 0; i
< documents_array
->len
; i
++)
425 if (documents
[i
]->editor
== NULL
)
434 static void queue_colourise(GeanyDocument
*doc
)
436 /* Colourise the editor before it is next drawn */
437 doc
->priv
->colourise_needed
= TRUE
;
439 /* If the editor doesn't need drawing (e.g. after saving the current
440 * document), we need to force a redraw, so the expose event is triggered.
441 * This ensures we don't start colourising before all documents are opened/saved,
442 * only once the editor is drawn. */
443 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
447 #ifdef USE_GIO_FILEMON
448 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
449 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
452 g_return_if_fail(doc
!= NULL
);
454 if (file_prefs
.disk_check_timeout
== 0)
457 geany_debug("%s: event: %d previous file status: %d",
458 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
461 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
463 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
464 doc
->priv
->file_disk_status
= FILE_OK
;
466 doc
->priv
->file_disk_status
= FILE_CHANGED
;
467 g_message("%s: FILE_CHANGED", G_STRFUNC
);
470 case G_FILE_MONITOR_EVENT_DELETED
:
472 doc
->priv
->file_disk_status
= FILE_CHANGED
;
473 g_message("%s: FILE_MISSING", G_STRFUNC
);
479 if (doc
->priv
->file_disk_status
!= FILE_OK
)
481 ui_update_tab_status(doc
);
487 static void document_stop_file_monitoring(GeanyDocument
*doc
)
489 g_return_if_fail(doc
!= NULL
);
491 if (doc
->priv
->monitor
!= NULL
)
493 g_object_unref(doc
->priv
->monitor
);
494 doc
->priv
->monitor
= NULL
;
499 static void monitor_file_setup(GeanyDocument
*doc
)
501 g_return_if_fail(doc
!= NULL
);
502 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
503 * doesn't work at all for remote files and legacy polling is too slow. */
504 if (! doc
->priv
->is_remote
)
506 #ifdef USE_GIO_FILEMON
507 gchar
*locale_filename
;
509 /* stop any previous monitoring */
510 document_stop_file_monitoring(doc
);
512 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
513 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
515 /* get a file monitor and connect to the 'changed' signal */
516 GFile
*file
= g_file_new_for_path(locale_filename
);
517 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
518 g_signal_connect(doc
->priv
->monitor
, "changed",
519 G_CALLBACK(monitor_file_changed_cb
), doc
);
521 /* we set the rate limit according to the GUI pref but it's most probably not used */
522 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
524 g_object_unref(file
);
526 g_free(locale_filename
);
529 doc
->priv
->file_disk_status
= FILE_OK
;
533 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
535 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
538 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
539 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
541 if (source_widget
== NULL
)
542 source_widget
= doc
->priv
->tag_tree
;
544 if (focusw
== source_widget
)
545 gtk_widget_grab_focus(sci
);
550 static gboolean
on_idle_focus(gpointer doc
)
552 document_try_focus(doc
, NULL
);
557 /* Creates a new document and editor, adding a tab in the notebook.
558 * @return The created document */
559 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
563 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
567 doc
= document_get_current();
568 /* remove the empty document first */
569 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
570 /* prevent immediately opening another new doc with
571 * new_document_after_close pref */
575 new_idx
= document_get_new_idx();
576 if (new_idx
== -1) /* expand the array, no free places */
578 doc
= g_new0(GeanyDocument
, 1);
580 new_idx
= documents_array
->len
;
581 g_ptr_array_add(documents_array
, doc
);
584 doc
= documents
[new_idx
];
586 /* initialize default document settings */
587 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
588 doc
->index
= new_idx
;
589 doc
->file_name
= g_strdup(utf8_filename
);
590 doc
->editor
= editor_create(doc
);
591 #ifndef USE_GIO_FILEMON
592 doc
->priv
->last_check
= time(NULL
);
595 sidebar_openfiles_add(doc
); /* sets doc->iter */
597 notebook_new_tab(doc
);
599 /* select document in sidebar */
601 GtkTreeSelection
*sel
;
603 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
604 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
607 ui_document_buttons_update();
609 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
615 * Closes the given document.
617 * @param doc The document to remove.
619 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
623 gboolean
document_close(GeanyDocument
*doc
)
625 g_return_val_if_fail(doc
, FALSE
);
627 return document_remove_page(document_get_notebook_page(doc
));
631 /* Call document_remove_page() instead, this is only needed for document_create()
632 * to prevent re-opening a new document when the last document is closed (if enabled). */
633 static gboolean
remove_page(guint page_num
)
635 GeanyDocument
*doc
= document_get_from_page(page_num
);
637 g_return_val_if_fail(doc
!= NULL
, FALSE
);
639 if (doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
642 /* tell any plugins that the document is about to be closed */
643 g_signal_emit_by_name(geany_object
, "document-close", doc
);
645 /* Checking real_path makes it likely the file exists on disk */
646 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
647 ui_add_recent_document(doc
);
649 doc
->is_valid
= FALSE
;
651 if (main_status
.quitting
)
653 /* we need to destroy the ScintillaWidget so our handlers on it are
654 * disconnected before we free any data they may use (like the editor).
655 * when not quitting, this is handled by removing the notebook page. */
656 gtk_widget_destroy(GTK_WIDGET(doc
->editor
->sci
));
660 notebook_remove_page(page_num
);
661 sidebar_remove_document(doc
);
662 navqueue_remove_file(doc
->file_name
);
663 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
665 g_free(doc
->encoding
);
666 g_free(doc
->priv
->saved_encoding
.encoding
);
667 g_free(doc
->file_name
);
668 g_free(doc
->real_path
);
669 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
671 if (doc
->priv
->tag_tree
)
672 gtk_widget_destroy(doc
->priv
->tag_tree
);
674 editor_destroy(doc
->editor
);
675 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
677 document_stop_file_monitoring(doc
);
679 document_undo_clear(doc
);
683 /* reset document settings to defaults for re-use */
684 memset(doc
, 0, sizeof(GeanyDocument
));
686 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
688 sidebar_update_tag_list(NULL
, FALSE
);
689 ui_set_window_title(NULL
);
690 ui_save_buttons_toggle(FALSE
);
691 ui_update_popup_reundo_items(NULL
);
692 ui_document_buttons_update();
693 build_menu_update(NULL
);
700 * Removes the given notebook tab at @a page_num and clears all related information
701 * in the document list.
703 * @param page_num The notebook page number to remove.
705 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
707 gboolean
document_remove_page(guint page_num
)
709 gboolean done
= remove_page(page_num
);
711 if (done
&& ui_prefs
.new_document_after_close
)
712 document_new_file_if_non_open();
718 /* used to keep a record of the unchanged document state encoding */
719 static void store_saved_encoding(GeanyDocument
*doc
)
721 g_free(doc
->priv
->saved_encoding
.encoding
);
722 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
723 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
727 /* Opens a new empty document only if there are no other documents open */
728 GeanyDocument
*document_new_file_if_non_open(void)
730 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
731 return document_new_file(NULL
, NULL
, NULL
);
738 * Creates a new document.
739 * Line endings in @a text will be converted to the default setting.
740 * Afterwards, the @c "document-new" signal is emitted for plugins.
742 * @param utf8_filename The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
743 * @param ft The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
744 * @param text The initial content of the file (in UTF-8 encoding), or @c NULL.
746 * @return The new document.
748 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
752 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
755 tmp
= utils_strdupa(utf8_filename
); /* work around const */
756 utils_tidy_path(tmp
);
759 doc
= document_create(utf8_filename
);
761 g_assert(doc
!= NULL
);
763 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
766 GString
*template = g_string_new(text
);
767 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
769 sci_set_text(doc
->editor
->sci
, template->str
);
770 g_string_free(template, TRUE
);
773 sci_clear_all(doc
->editor
->sci
);
775 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
777 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
778 sci_empty_undo_buffer(doc
->editor
->sci
);
780 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
781 /* store the opened encoding for undo/redo */
782 store_saved_encoding(doc
);
784 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
785 ft
= filetypes_detect_from_document(doc
);
787 document_set_filetype(doc
, ft
); /* also re-parses tags */
789 ui_set_window_title(doc
);
790 build_menu_update(doc
);
791 document_set_text_changed(doc
, FALSE
);
792 ui_document_show_hide(doc
); /* update the document menu */
794 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
795 /* bring it in front, jump to the start and grab the focus */
796 editor_goto_pos(doc
->editor
, 0, FALSE
);
797 document_try_focus(doc
, NULL
);
799 #ifdef USE_GIO_FILEMON
800 monitor_file_setup(doc
);
802 doc
->priv
->mtime
= time(NULL
);
805 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
806 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
808 g_signal_emit_by_name(geany_object
, "document-new", doc
);
810 msgwin_status_add(_("New file \"%s\" opened."),
818 * Opens a document specified by @a locale_filename.
819 * Afterwards, the @c "document-open" signal is emitted for plugins.
821 * @param locale_filename The filename of the document to load, in locale encoding.
822 * @param readonly Whether to open the document in read-only mode.
823 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
824 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
826 * @return The document opened or @c NULL.
828 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
829 GeanyFiletype
*ft
, const gchar
*forced_enc
)
831 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
837 gchar
*data
; /* null-terminated file data */
838 gsize len
; /* string length of data */
841 time_t mtime
; /* modification time, read by stat::st_mtime */
846 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
847 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
848 FileData
*filedata
, const gchar
*forced_enc
)
853 filedata
->data
= NULL
;
855 filedata
->enc
= NULL
;
856 filedata
->bom
= FALSE
;
857 filedata
->readonly
= FALSE
;
859 if (g_stat(locale_filename
, &st
) != 0)
861 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
862 display_filename
, g_strerror(errno
));
866 filedata
->mtime
= st
.st_mtime
;
868 if (! g_file_get_contents(locale_filename
, &filedata
->data
, NULL
, &err
))
870 ui_set_statusbar(TRUE
, "%s", err
->message
);
875 filedata
->len
= (gsize
) st
.st_size
;
876 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
877 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
881 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
882 display_filename
, forced_enc
);
886 ui_set_statusbar(TRUE
,
887 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
890 g_free(filedata
->data
);
894 if (filedata
->readonly
)
896 const gchar
*warn_msg
= _(
897 "The file \"%s\" could not be opened properly and has been truncated. " \
898 "This can occur if the file contains a NULL byte. " \
899 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
901 if (main_status
.main_window_realized
)
902 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
904 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
911 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
912 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
913 * if cl_options.goto_column is set.
915 * returns the new position which may have changed */
916 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
918 if (cl_options
.goto_line
>= 0)
919 { /* goto line which was specified on command line and then undefine the line */
920 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
921 editor
->scroll_percent
= 0.5F
;
922 cl_options
.goto_line
= -1;
926 sci_set_current_position(editor
->sci
, pos
, FALSE
);
927 editor
->scroll_percent
= 0.5F
;
930 if (cl_options
.goto_column
>= 0)
931 { /* goto column which was specified on command line and then undefine the column */
933 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
934 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
935 editor
->scroll_percent
= 0.5F
;
936 cl_options
.goto_column
= -1;
939 return sci_get_current_position(editor
->sci
);
943 /* Count lines that start with some hard tabs then a soft tab. */
944 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
946 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
947 ScintillaObject
*sci
= editor
->sci
;
949 struct Sci_TextToFind ttf
;
950 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
951 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
956 ttf
.chrg
.cpMax
= sci_get_length(sci
);
957 ttf
.lpstrText
= regex
;
962 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
964 break; /* no more matches */
966 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
969 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
970 return count
> sci_get_line_count(sci
) * 0.02;
974 /* Detect the indent type based on counting the leading indent characters for each line.
975 * Returns whether detection succeeded, and the detected type in *type_ upon success */
976 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
978 GeanyEditor
*editor
= doc
->editor
;
979 ScintillaObject
*sci
= editor
->sci
;
980 gint line
, line_count
;
981 gsize tabs
= 0, spaces
= 0;
983 if (detect_tabs_and_spaces(editor
))
985 *type_
= GEANY_INDENT_TYPE_BOTH
;
989 line_count
= sci_get_line_count(sci
);
990 for (line
= 0; line
< line_count
; line
++)
992 gint pos
= sci_get_position_from_line(sci
, line
);
995 /* most code will have indent total <= 24, otherwise it's more likely to be
996 * alignment than indentation */
997 if (sci_get_line_indentation(sci
, line
) > 24)
1000 c
= sci_get_char_at(sci
, pos
);
1003 /* check for at least 2 spaces */
1004 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
1007 if (spaces
== 0 && tabs
== 0)
1010 /* the factors may need to be tweaked */
1011 if (spaces
> tabs
* 4)
1012 *type_
= GEANY_INDENT_TYPE_SPACES
;
1013 else if (tabs
> spaces
* 4)
1014 *type_
= GEANY_INDENT_TYPE_TABS
;
1016 *type_
= GEANY_INDENT_TYPE_BOTH
;
1022 /* Detect the indent width based on counting the leading indent characters for each line.
1023 * Returns whether detection succeeded, and the detected width in *width_ upon success */
1024 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
1026 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1027 ScintillaObject
*sci
= editor
->sci
;
1028 gint line
, line_count
;
1029 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
1030 gint count
, width
, i
;
1032 /* can't easily detect the supposed width of a tab, guess the default is OK */
1033 if (type
== GEANY_INDENT_TYPE_TABS
)
1036 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
1037 sci_set_tab_width(sci
, 8);
1039 line_count
= sci_get_line_count(sci
);
1040 for (line
= 0; line
< line_count
; line
++)
1042 gint pos
= sci_get_line_indent_position(sci
, line
);
1044 /* We probably don't have style info yet, because we're generally called just after
1045 * the document got created, so we can't use highlighting_is_code_style().
1046 * That's not good, but the assumption below that concerning lines start with an
1047 * asterisk (common continuation character for C/C++/Java/...) should do the trick
1048 * without removing too much legitimate lines. */
1049 if (sci_get_char_at(sci
, pos
) == '*')
1052 width
= sci_get_line_indentation(sci
, line
);
1053 /* most code will have indent total <= 24, otherwise it's more likely to be
1054 * alignment than indentation */
1057 /* < 2 is no indentation */
1061 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1063 if ((width
% (i
+ 2)) == 0)
1068 width
= iprefs
->width
;
1069 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1071 /* give large indents higher weight not to be fooled by spurious indents */
1072 if (widths
[i
] >= count
* 1.5)
1087 /* same as detect_indent_width() but uses editor's indent type */
1088 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1090 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1094 void document_apply_indent_settings(GeanyDocument
*doc
)
1096 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1097 GeanyIndentType type
= iprefs
->type
;
1098 gint width
= iprefs
->width
;
1100 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1102 if (type
!= iprefs
->type
)
1104 const gchar
*name
= NULL
;
1108 case GEANY_INDENT_TYPE_SPACES
:
1111 case GEANY_INDENT_TYPE_TABS
:
1114 case GEANY_INDENT_TYPE_BOTH
:
1115 name
= _("Tabs and Spaces");
1118 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1119 * and Spaces), the second one is the filename */
1120 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1124 else if (doc
->file_type
->indent_type
> -1)
1125 type
= doc
->file_type
->indent_type
;
1127 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1129 if (width
!= iprefs
->width
)
1131 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1135 else if (doc
->file_type
->indent_width
> -1)
1136 width
= doc
->file_type
->indent_width
;
1138 editor_set_indent(doc
->editor
, type
, width
);
1142 void document_show_tab(GeanyDocument
*doc
)
1144 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1145 document_get_notebook_page(doc
));
1149 /* To open a new file, set doc to NULL; filename should be locale encoded.
1150 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1151 * pos is the cursor position, which can be overridden by --line and --column.
1152 * forced_enc can be NULL to detect the file encoding.
1153 * Returns: doc of the opened file or NULL if an error occurred. */
1154 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1155 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1158 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1159 gchar
*utf8_filename
= NULL
;
1160 gchar
*display_filename
= NULL
;
1161 gchar
*locale_filename
= NULL
;
1162 GeanyFiletype
*use_ft
;
1165 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, NULL
);
1169 utf8_filename
= g_strdup(doc
->file_name
);
1170 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1174 /* filename must not be NULL when opening a file */
1175 g_return_val_if_fail(filename
, NULL
);
1178 /* if filename is a shortcut, try to resolve it */
1179 locale_filename
= win32_get_shortcut_target(filename
);
1181 locale_filename
= g_strdup(filename
);
1183 /* remove relative junk */
1184 utils_tidy_path(locale_filename
);
1186 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1187 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1189 /* if file is already open, switch to it and go */
1190 doc
= document_find_by_filename(utf8_filename
);
1193 ui_add_recent_document(doc
); /* either add or reorder recent item */
1194 /* show the doc before reload dialog */
1195 document_show_tab(doc
);
1196 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1199 if (reload
|| doc
== NULL
)
1200 { /* doc possibly changed */
1201 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1203 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1205 g_free(display_filename
);
1206 g_free(utf8_filename
);
1207 g_free(locale_filename
);
1213 doc
= document_create(utf8_filename
);
1214 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1216 /* file exists on disk, set real_path */
1217 SETPTR(doc
->real_path
, tm_get_real_path(locale_filename
));
1219 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1220 monitor_file_setup(doc
);
1223 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1224 sci_empty_undo_buffer(doc
->editor
->sci
);
1226 /* add the text to the ScintillaObject */
1227 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1228 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1229 queue_colourise(doc
); /* Ensure the document gets colourised. */
1231 /* detect & set line endings */
1232 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1233 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1234 g_free(filedata
.data
);
1236 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1238 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1239 g_free(doc
->encoding
); /* if reloading, free old encoding */
1240 doc
->encoding
= filedata
.enc
;
1241 doc
->has_bom
= filedata
.bom
;
1242 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1244 doc
->readonly
= readonly
|| filedata
.readonly
;
1245 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1246 doc
->priv
->protected = 0;
1248 /* update line number margin width */
1249 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1250 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
1255 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1256 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1259 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1263 document_undo_clear(doc
);
1267 /* update taglist, typedef keywords and build menu if necessary */
1268 document_set_filetype(doc
, use_ft
);
1270 /* set indentation settings after setting the filetype */
1272 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1274 document_apply_indent_settings(doc
);
1276 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1277 ui_document_show_hide(doc
); /* update the document menu */
1279 /* finally add current file to recent files menu, but not the files from the last session */
1280 if (! main_status
.opening_session_files
)
1281 ui_add_recent_document(doc
);
1285 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1286 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1290 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1291 /* For translators: this is the status window message for opening a file. %d is the number
1292 * of the newly opened file, %s indicates whether the file is opened read-only
1293 * (it is replaced with the string ", read-only"). */
1294 msgwin_status_add(_("File %s opened(%d%s)."),
1295 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1296 (readonly
) ? _(", read-only") : "");
1300 g_free(display_filename
);
1301 g_free(utf8_filename
);
1302 g_free(locale_filename
);
1304 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1305 pos
= set_cursor_position(doc
->editor
, pos
);
1306 /* now bring the file in front */
1307 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1309 /* finally, let the editor widget grab the focus so you can start coding
1311 g_idle_add(on_idle_focus
, doc
);
1316 /* Takes a new line separated list of filename URIs and opens each file.
1317 * length is the length of the string */
1318 void document_open_file_list(const gchar
*data
, gsize length
)
1324 g_return_if_fail(data
!= NULL
);
1326 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1328 /* stop at the end or first empty item, because last item is empty but not null */
1329 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1331 filename
= utils_get_path_from_uri(list
[i
]);
1332 if (filename
== NULL
)
1334 document_open_file(filename
, FALSE
, NULL
, NULL
);
1343 * Opens each file in the list @a filenames.
1344 * Internally, document_open_file() is called for every list item.
1346 * @param filenames A list of filenames to load, in locale encoding.
1347 * @param readonly Whether to open the document in read-only mode.
1348 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
1349 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1351 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1352 const gchar
*forced_enc
)
1356 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1358 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1364 * Reloads the document with the specified file encoding
1365 * @a forced_enc or @c NULL to auto-detect the file encoding.
1367 * @param doc The document to reload.
1368 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1370 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1372 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
)
1375 GeanyDocument
*new_doc
;
1377 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1379 /* Use cancel because the response handler would call this recursively */
1380 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] != NULL
)
1381 gtk_info_bar_response(GTK_INFO_BAR(doc
->priv
->info_bars
[MSG_TYPE_RELOAD
]), GTK_RESPONSE_CANCEL
);
1383 /* try to set the cursor to the position before reloading */
1384 pos
= sci_get_current_position(doc
->editor
->sci
);
1385 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1387 return (new_doc
!= NULL
);
1391 /* also used for reloading when forced_enc is NULL */
1392 gboolean
document_reload_prompt(GeanyDocument
*doc
, const gchar
*forced_enc
)
1395 gboolean result
= FALSE
;
1397 g_return_if_fail(doc
!= NULL
);
1399 /* No need to reload "untitled" (non-file-backed) documents */
1400 if (doc
->file_name
== NULL
)
1403 if (forced_enc
== NULL
)
1404 forced_enc
= doc
->encoding
;
1406 base_name
= g_path_get_basename(doc
->file_name
);
1407 /* don't prompt if file hasn't been edited at all */
1408 if ((!doc
->changed
&& !document_can_undo(doc
) && !document_can_redo(doc
)) ||
1409 dialogs_show_question_full(NULL
, _("_Reload"), GTK_STOCK_CANCEL
,
1410 _("Any unsaved changes will be lost."),
1411 _("Are you sure you want to reload '%s'?"), base_name
))
1413 result
= document_reload_file(doc
, forced_enc
);
1414 if (forced_enc
!= NULL
)
1415 ui_update_statusbar(doc
, -1);
1423 static gboolean
document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1425 #ifndef USE_GIO_FILEMON
1428 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1430 /* stat the file to get the timestamp, otherwise on Windows the actual
1431 * timestamp can be ahead of time(NULL) */
1432 if (g_stat(locale_filename
, &st
) != 0)
1434 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"), doc
->file_name
,
1439 doc
->priv
->mtime
= st
.st_mtime
; /* get the modification time from file and keep it */
1445 /* Sets line and column to the given position byte_pos in the document.
1446 * byte_pos is the position counted in bytes, not characters */
1447 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1452 /* for some reason we can use byte count instead of character count here */
1453 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1454 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1455 /* get the column in the line */
1456 *column
= byte_pos
- line_start
;
1458 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1459 * skip one byte(i++) and decrease the column number which is based on byte count */
1460 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1462 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1471 static void replace_header_filename(GeanyDocument
*doc
)
1475 struct Sci_TextToFind ttf
;
1477 g_return_if_fail(doc
!= NULL
);
1478 g_return_if_fail(doc
->file_type
!= NULL
);
1480 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1481 if (doc
->file_type
->extension
)
1482 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1484 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1486 filename
= g_path_get_basename(doc
->file_name
);
1488 /* only search the first 3 lines */
1490 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1491 ttf
.lpstrText
= filebase
;
1493 if (search_find_text(doc
->editor
->sci
, SCFIND_MATCHCASE
| SCFIND_REGEXP
, &ttf
, NULL
) != -1)
1495 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1496 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1497 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1505 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1506 * you still have to call @ref document_save_file_as() to change the @a doc object.
1507 * It also stops monitoring for file changes to prevent receiving too many file change events
1508 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1510 * @param doc The current document which should be renamed.
1511 * @param new_filename The new filename in UTF-8 encoding.
1515 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1517 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1518 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1521 /* stop file monitoring to avoid getting events for deleting/creating files,
1522 * it's re-setup in document_save_file_as() */
1523 document_stop_file_monitoring(doc
);
1525 result
= g_rename(old_locale_filename
, new_locale_filename
);
1528 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1529 _("Error renaming file."), g_strerror(errno
));
1531 g_free(old_locale_filename
);
1532 g_free(new_locale_filename
);
1536 static void protect_document(GeanyDocument
*doc
)
1538 /* do not call queue_colourise because to we want to keep the text-changed indication! */
1539 if (!doc
->priv
->protected++)
1540 sci_set_readonly(doc
->editor
->sci
, TRUE
);
1543 static void unprotect_document(GeanyDocument
*doc
)
1545 g_return_if_fail(doc
->priv
->protected > 0);
1547 if (!--doc
->priv
->protected && doc
->readonly
== FALSE
)
1548 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1552 /* Return TRUE if the document doesn't have a full filename set.
1553 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1554 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1556 gboolean
document_need_save_as(GeanyDocument
*doc
)
1558 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1560 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1565 * Saves the document, detecting the filetype.
1567 * @param doc The document for the file to save.
1568 * @param utf8_fname The new name for the document, in UTF-8, or NULL.
1569 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1571 * @see document_save_file().
1575 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1580 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1582 new_file
= document_need_save_as(doc
) || (utf8_fname
!= NULL
&& strcmp(doc
->file_name
, utf8_fname
) != 0);
1583 if (utf8_fname
!= NULL
)
1584 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1586 /* reset real path, it's retrieved again in document_save() */
1587 SETPTR(doc
->real_path
, NULL
);
1589 /* detect filetype */
1590 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1592 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1594 document_set_filetype(doc
, ft
);
1595 if (document_get_current() == doc
)
1597 ignore_callback
= TRUE
;
1598 filetypes_select_radio_item(doc
->file_type
);
1599 ignore_callback
= FALSE
;
1605 sci_set_readonly(doc
->editor
->sci
, FALSE
);
1606 doc
->readonly
= FALSE
;
1607 if (doc
->priv
->protected > 0)
1608 unprotect_document(doc
);
1611 replace_header_filename(doc
);
1613 ret
= document_save_file(doc
, TRUE
);
1615 /* file monitoring support, add file monitoring after the file has been saved
1616 * to ignore any earlier events */
1617 monitor_file_setup(doc
);
1618 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1621 ui_add_recent_document(doc
);
1626 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1628 GError
*conv_error
= NULL
;
1629 gchar
* conv_file_contents
= NULL
;
1633 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1634 g_return_val_if_fail(len
!= NULL
, FALSE
);
1636 /* try to convert it from UTF-8 to original encoding */
1637 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1638 &bytes_read
, &conv_len
, &conv_error
);
1640 if (conv_error
!= NULL
)
1642 gchar
*text
= g_strdup_printf(
1643 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1647 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1652 /* don't read over the doc length */
1653 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1654 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1655 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1657 /* take only one valid Unicode character from the context and discard the leftover */
1658 unic
= g_utf8_get_char_validated(context
, -1);
1659 context_len
= g_unichar_to_utf8(unic
, context
);
1660 context
[context_len
] = '\0';
1661 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1663 error_text
= g_strdup_printf(
1664 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1665 conv_error
->message
, context
, line
+ 1, column
);
1668 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1670 geany_debug("encoding error: %s", conv_error
->message
);
1671 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1672 g_error_free(conv_error
);
1680 *data
= conv_file_contents
;
1687 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1688 const gchar
*data
, gsize len
)
1690 GError
*error
= NULL
;
1692 if (file_prefs
.use_safe_file_saving
)
1694 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1695 * This is the only option that handles disk space exhaustion. */
1696 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1697 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1699 else if (file_prefs
.use_gio_unsafe_file_saving
)
1703 /* Use GIO API to save file (GVFS-safe)
1704 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1705 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1706 fp
= g_file_new_for_path(locale_filename
);
1707 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1708 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1715 gchar
*display_name
= g_filename_display_name(locale_filename
);
1717 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1718 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1720 fp
= g_fopen(locale_filename
, "wb");
1727 g_file_error_from_errno(save_errno
),
1728 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1730 g_strerror(save_errno
));
1734 gsize bytes_written
;
1737 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1739 if (len
!= bytes_written
)
1745 g_file_error_from_errno(save_errno
),
1746 _("Failed to write file '%s': fwrite() failed: %s"),
1748 g_strerror(save_errno
));
1752 /* preserve the fwrite() error if any */
1753 if (fclose(fp
) != 0 && error
== NULL
)
1759 g_file_error_from_errno(save_errno
),
1760 _("Failed to close file '%s': fclose() failed: %s"),
1762 g_strerror(save_errno
));
1766 g_free(display_name
);
1770 gchar
*msg
= g_strdup(error
->message
);
1771 g_error_free(error
);
1772 /* geany will warn about file truncation for unsafe saving below */
1779 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
1780 const gchar
*data
, gsize len
)
1784 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1785 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1787 err
= write_data_to_disk(locale_filename
, data
, len
);
1791 /* now the file is on disk, set real_path */
1792 if (doc
->real_path
== NULL
)
1794 doc
->real_path
= tm_get_real_path(locale_filename
);
1795 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1796 monitor_file_setup(doc
);
1802 * Saves the document.
1803 * Also shows the Save As dialog if necessary.
1804 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
1806 * Saving may include replacing tabs with spaces,
1807 * stripping trailing spaces and adding a final new line at the end of the file, depending
1808 * on user preferences. Then the @c "document-before-save" signal is emitted,
1809 * allowing plugins to modify the document before it is saved, and data is
1810 * actually written to disk.
1812 * On successful saving:
1813 * - GeanyDocument::real_path is set.
1814 * - The filetype is set again or auto-detected if it wasn't set yet.
1815 * - The @c "document-save" signal is emitted for plugins.
1817 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
1818 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
1819 * added in Geany 1.22.
1821 * @param doc The document to save.
1822 * @param force Whether to save the file even if it is not modified.
1824 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
1826 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
1831 gchar
*locale_filename
;
1832 const GeanyFilePrefs
*fp
;
1834 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1836 if (document_need_save_as(doc
))
1838 /* ensure doc is the current tab before showing the dialog */
1839 document_show_tab(doc
);
1840 return dialogs_show_save_as();
1843 /* the "changed" flag should exclude the "readonly" flag, but check it anyway for safety */
1844 if (doc
->readonly
|| doc
->priv
->protected)
1846 if (!force
&& !doc
->changed
)
1849 fp
= project_get_file_prefs();
1850 /* replaces tabs with spaces but only if the current file is not a Makefile */
1851 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
1852 editor_replace_tabs(doc
->editor
);
1853 /* strip trailing spaces */
1854 if (fp
->strip_trailing_spaces
)
1855 editor_strip_trailing_spaces(doc
->editor
);
1856 /* ensure the file has a newline at the end */
1857 if (fp
->final_new_line
)
1858 editor_ensure_final_newline(doc
->editor
);
1859 /* ensure newlines are consistent */
1860 if (fp
->ensure_convert_new_lines
)
1861 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
1863 /* notify plugins which may wish to modify the document before it's saved */
1864 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
1866 len
= sci_get_length(doc
->editor
->sci
) + 1;
1867 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
1868 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
1869 * encoding, it will be converted to doc->encoding below and this conversion
1870 * also changes the BOM */
1871 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
1872 data
[0] = (gchar
) 0xef;
1873 data
[1] = (gchar
) 0xbb;
1874 data
[2] = (gchar
) 0xbf;
1875 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
1880 data
= (gchar
*) g_malloc(len
);
1881 sci_get_text(doc
->editor
->sci
, len
, data
);
1884 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
1885 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
1886 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
1888 if (! save_convert_to_encoding(doc
, &data
, &len
))
1899 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1901 /* ignore file changed notification when the file is written */
1902 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1904 /* actually write the content of data to the file on disk */
1905 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
1910 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
1912 if (!file_prefs
.use_safe_file_saving
)
1915 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
1917 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
1918 doc
->priv
->file_disk_status
= FILE_OK
;
1920 g_free(locale_filename
);
1925 /* store the opened encoding for undo/redo */
1926 store_saved_encoding(doc
);
1928 /* ignore the following things if we are quitting */
1929 if (! main_status
.quitting
)
1931 sci_set_savepoint(doc
->editor
->sci
);
1933 if (file_prefs
.disk_check_timeout
> 0)
1934 document_update_timestamp(doc
, locale_filename
);
1936 /* update filetype-related things */
1937 document_set_filetype(doc
, doc
->file_type
);
1939 document_update_tab_label(doc
);
1941 msgwin_status_add(_("File %s saved."), doc
->file_name
);
1942 ui_update_statusbar(doc
, -1);
1944 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
1947 g_free(locale_filename
);
1949 g_signal_emit_by_name(geany_object
, "document-save", doc
);
1955 /* special search function, used from the find entry in the toolbar
1956 * return TRUE if text was found otherwise FALSE
1957 * return also TRUE if text is empty */
1958 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
1961 gint start_pos
, search_pos
;
1962 struct Sci_TextToFind ttf
;
1964 g_return_val_if_fail(text
!= NULL
, FALSE
);
1965 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1969 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
1970 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
1972 /* search cursor to end or start */
1973 ttf
.chrg
.cpMin
= start_pos
;
1974 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
1975 ttf
.lpstrText
= (gchar
*)text
;
1976 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1978 /* if no match, search start (or end) to cursor */
1979 if (search_pos
== -1)
1983 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
1984 ttf
.chrg
.cpMax
= start_pos
;
1989 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
1991 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1994 if (search_pos
!= -1)
1996 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1998 /* unfold maybe folded results */
1999 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
2001 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
2002 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
2004 if (! editor_line_in_view(doc
->editor
, line
))
2005 { /* we need to force scrolling in case the cursor is outside of the current visible area
2006 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
2007 * while searching */
2008 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
2011 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
2018 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
2021 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
2027 /* General search function, used from the find dialog.
2028 * Returns -1 on failure or the start position of the matching text.
2029 * Will skip past any selection, ignoring it.
2031 * @param text Text to find.
2032 * @param original_text Text as it was entered by user, or @c NULL to use @c text
2034 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
2035 gint flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
2036 gboolean scroll
, GtkWidget
*parent
)
2038 gint selection_end
, selection_start
, search_pos
;
2040 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
2044 /* Sci doesn't support searching backwards with a regex */
2045 if (flags
& SCFIND_REGEXP
)
2046 search_backwards
= FALSE
;
2049 original_text
= text
;
2051 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2052 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2053 if ((selection_end
- selection_start
) > 0)
2054 { /* there's a selection so go to the end */
2055 if (search_backwards
)
2056 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2058 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2061 sci_set_search_anchor(doc
->editor
->sci
);
2062 if (search_backwards
)
2063 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
2065 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
2067 if (search_pos
!= -1)
2069 /* unfold maybe folded results */
2070 sci_ensure_line_is_visible(doc
->editor
->sci
,
2071 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
2073 doc
->editor
->scroll_percent
= 0.3F
;
2077 gint sci_len
= sci_get_length(doc
->editor
->sci
);
2079 /* if we just searched the whole text, give up searching. */
2080 if ((selection_end
== 0 && ! search_backwards
) ||
2081 (selection_end
== sci_len
&& search_backwards
))
2083 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
2088 /* we searched only part of the document, so ask whether to wraparound. */
2089 if (search_prefs
.always_wrap
||
2090 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
2091 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
2095 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
2096 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
2098 { /* return to original cursor position if not found */
2099 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
2108 /* Replaces the selection if it matches, otherwise just finds the next match.
2109 * Returns: start of replaced text, or -1 if no replacement was made
2111 * @param find_text Text to find.
2112 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
2114 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
2115 const gchar
*replace_text
, gint flags
, gboolean search_backwards
)
2117 gint selection_end
, selection_start
, search_pos
;
2118 GeanyMatchInfo
*match
= NULL
;
2120 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
2125 /* Sci doesn't support searching backwards with a regex */
2126 if (flags
& SCFIND_REGEXP
)
2127 search_backwards
= FALSE
;
2129 if (!original_find_text
)
2130 original_find_text
= find_text
;
2132 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2133 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2134 if (selection_end
== selection_start
)
2136 /* no selection so just find the next match */
2137 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2140 /* there's a selection so go to the start before finding to search through it
2141 * this ensures there is a match */
2142 if (search_backwards
)
2143 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2145 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2147 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2148 /* return if the original selected text did not match (at the start of the selection) */
2149 if (search_pos
!= selection_start
)
2151 if (search_pos
!= -1)
2152 geany_match_info_free(match
);
2156 if (search_pos
!= -1)
2158 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2159 /* select the replacement - find text will skip past the selected text */
2160 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2161 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2162 geany_match_info_free(match
);
2166 /* no match in the selection */
2173 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2174 const gchar
*original_replace_text
)
2180 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2184 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2185 ui_set_statusbar(TRUE
, ngettext(
2186 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2187 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2188 count
), filename
, count
, original_find_text
, original_replace_text
);
2193 /* Replace all text matches in a certain range within document.
2194 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2195 * or -1 if no text was found.
2196 * scroll_to_match is whether to scroll the last replacement in view (which also
2197 * clears the selection).
2198 * Returns: the number of replacements made. */
2200 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2201 gint flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2204 struct Sci_TextToFind ttf
;
2205 ScintillaObject
*sci
;
2207 if (new_range_end
!= NULL
)
2208 *new_range_end
= -1;
2210 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2212 if (! *find_text
|| doc
->readonly
)
2215 sci
= doc
->editor
->sci
;
2217 ttf
.chrg
.cpMin
= start
;
2218 ttf
.chrg
.cpMax
= end
;
2219 ttf
.lpstrText
= (gchar
*)find_text
;
2221 sci_start_undo_action(sci
);
2222 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2223 sci_end_undo_action(sci
);
2226 { /* scroll last match in view, will destroy the existing selection */
2227 if (scroll_to_match
)
2228 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2230 if (new_range_end
!= NULL
)
2231 *new_range_end
= ttf
.chrg
.cpMax
;
2237 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2238 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2240 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2241 gint max_column
= 0, count
= 0;
2242 gboolean replaced
= FALSE
;
2244 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2249 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2250 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2251 /* do we have a selection? */
2252 if ((selection_end
- selection_start
) == 0)
2258 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2259 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2260 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2261 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2263 gint first_line
, line
;
2265 sci_start_undo_action(doc
->editor
->sci
);
2267 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2268 /* Find the last line with chars selected (not EOL char) */
2269 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2270 selection_end
- editor_get_eol_char_len(doc
->editor
));
2271 last_line
= MAX(first_line
, last_line
);
2272 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2274 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2275 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2277 /* skip line if there is no selection */
2278 if (line_start
!= INVALID_POSITION
)
2280 /* don't let document_replace_range() scroll to match to keep our selection */
2283 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2284 line_start
, line_end
, FALSE
, &new_sel_end
);
2285 if (new_sel_end
!= -1)
2288 /* this gets the greatest column within the selection after replacing */
2289 max_column
= MAX(max_column
,
2290 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2294 sci_end_undo_action(doc
->editor
->sci
);
2296 else /* handle normal line selection */
2298 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2299 selection_start
, selection_end
, TRUE
, &selection_end
);
2300 if (selection_end
!= -1)
2305 { /* update the selection for the new endpoint */
2307 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2309 /* now we can scroll to the selection and destroy it because we rebuild it later */
2310 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2312 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2313 * the highest column on the last line. The wrapped selection is completely different
2314 * from the original one, so skip the selection at all */
2315 /* TODO is there a better way to handle the wrapped selection? */
2316 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2317 { /* for keeping and adjusting the selection in multi line rectangle selection we
2318 * need the last line of the original selection and the greatest column number after
2319 * replacing and set the selection end to the last line at the greatest column */
2320 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2321 sci_set_selection_end(doc
->editor
->sci
,
2322 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2323 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2328 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2329 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2332 else /* no replacements */
2335 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2339 /* returns number of replacements made. */
2340 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2341 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2344 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2349 len
= sci_get_length(doc
->editor
->sci
);
2350 count
= document_replace_range(
2351 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2353 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2359 * Parses or re-parses the document's buffer and updates the type
2360 * keywords and symbol list.
2362 * @param doc The document.
2364 void document_update_tags(GeanyDocument
*doc
)
2369 g_return_if_fail(DOC_VALID(doc
));
2370 g_return_if_fail(app
->tm_workspace
!= NULL
);
2372 /* early out if it's a new file or doesn't support tags */
2373 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2375 /* We must call sidebar_update_tag_list() before returning,
2376 * to ensure that the symbol list is always updated properly (e.g.
2377 * when creating a new document with a partial filename set. */
2378 sidebar_update_tag_list(doc
, FALSE
);
2382 /* create a new TM file if there isn't one yet */
2385 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2388 /* lookup the name rather than using filetype name to support custom filetypes */
2389 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2390 doc
->tm_file
= tm_source_file_new(locale_filename
, FALSE
, name
);
2391 g_free(locale_filename
);
2393 if (doc
->tm_file
&& !tm_workspace_add_object(doc
->tm_file
))
2395 tm_work_object_free(doc
->tm_file
);
2396 doc
->tm_file
= NULL
;
2400 /* early out if there's no work object and we couldn't create one */
2401 if (doc
->tm_file
== NULL
)
2403 /* We must call sidebar_update_tag_list() before returning,
2404 * to ensure that the symbol list is always updated properly (e.g.
2405 * when creating a new document with a partial filename set. */
2406 sidebar_update_tag_list(doc
, FALSE
);
2410 len
= sci_get_length(doc
->editor
->sci
);
2411 /* tm_source_file_buffer_update() below don't support 0-length data,
2412 * so just empty the tags array and leave */
2415 tm_tags_array_free(doc
->tm_file
->tags_array
, FALSE
);
2416 sidebar_update_tag_list(doc
, FALSE
);
2420 /* Parse Scintilla's buffer directly using TagManager
2421 * Note: this buffer *MUST NOT* be modified */
2422 buffer_ptr
= (guchar
*) scintilla_send_message(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2423 tm_source_file_buffer_update(doc
->tm_file
, buffer_ptr
, len
, TRUE
);
2425 sidebar_update_tag_list(doc
, TRUE
);
2426 document_highlight_tags(doc
);
2430 /* Re-highlights type keywords without re-parsing the whole document. */
2431 void document_highlight_tags(GeanyDocument
*doc
)
2433 GString
*keywords_str
;
2437 /* some filetypes support type keywords (such as struct names), but not
2438 * necessarily all filetypes for a particular scintilla lexer. this
2439 * tells us whether the filetype supports keywords, and if so
2440 * which index to use for the scintilla keywords set. */
2441 switch (doc
->file_type
->id
)
2443 case GEANY_FILETYPES_C
:
2444 case GEANY_FILETYPES_CPP
:
2445 case GEANY_FILETYPES_CS
:
2446 case GEANY_FILETYPES_D
:
2447 case GEANY_FILETYPES_JAVA
:
2448 case GEANY_FILETYPES_OBJECTIVEC
:
2449 case GEANY_FILETYPES_VALA
:
2450 case GEANY_FILETYPES_RUST
:
2453 /* index of the keyword set in the Scintilla lexer, for
2454 * example in LexCPP.cxx, see "cppWordLists" global array.
2455 * TODO: this magic number should be a member of the filetype */
2460 return; /* early out if type keywords are not supported */
2462 if (!app
->tm_workspace
->work_object
.tags_array
)
2465 /* get any type keywords and tell scintilla about them
2466 * this will cause the type keywords to be colourized in scintilla */
2467 keywords_str
= symbols_find_tags_as_string(app
->tm_workspace
->work_object
.tags_array
,
2468 TM_GLOBAL_TYPE_MASK
, doc
->file_type
->lang
);
2471 keywords
= g_string_free(keywords_str
, FALSE
);
2472 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2474 queue_colourise(doc
); /* force re-highlighting the entire document */
2479 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2481 GeanyDocument
*doc
= data
;
2483 if (! DOC_VALID(doc
))
2486 if (! main_status
.quitting
)
2487 document_update_tags(doc
);
2489 doc
->priv
->tag_list_update_source
= 0;
2491 /* don't update the tags until another modification of the buffer */
2496 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2498 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2501 /* prevent "stacking up" callback handlers, we only need one to run soon */
2502 if (doc
->priv
->tag_list_update_source
!= 0)
2503 g_source_remove(doc
->priv
->tag_list_update_source
);
2505 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2506 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2510 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2511 gboolean filetype_changed
)
2513 g_return_if_fail(doc
);
2515 type
= filetypes
[GEANY_FILETYPES_NONE
];
2517 if (filetype_changed
)
2519 doc
->file_type
= type
;
2521 /* delete tm file object to force creation of a new one */
2522 if (doc
->tm_file
!= NULL
)
2524 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
2525 doc
->tm_file
= NULL
;
2527 /* load tags files before highlighting (some lexers highlight global typenames) */
2528 if (type
->id
!= GEANY_FILETYPES_NONE
)
2529 symbols_global_tags_loaded(type
->id
);
2531 highlighting_set_styles(doc
->editor
->sci
, type
);
2532 editor_set_indentation_guides(doc
->editor
);
2533 build_menu_update(doc
);
2534 queue_colourise(doc
);
2535 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2538 document_update_tags(doc
);
2542 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2543 * @param doc The document to use.
2544 * @param type The filetype. */
2545 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2547 gboolean ft_changed
;
2548 GeanyFiletype
*old_ft
;
2550 g_return_if_fail(doc
);
2552 type
= filetypes
[GEANY_FILETYPES_NONE
];
2554 old_ft
= doc
->file_type
;
2555 geany_debug("%s : %s (%s)",
2556 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2558 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2560 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2561 document_load_config(doc
, type
, ft_changed
);
2565 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2567 /* assume that if previous filetype was none and the settings are the default ones, this
2568 * is the first time the filetype is carefully set, so we should apply indent settings */
2569 if ((! old_ft
|| old_ft
->id
== GEANY_FILETYPES_NONE
) &&
2570 doc
->editor
->indent_type
== iprefs
->type
&&
2571 doc
->editor
->indent_width
== iprefs
->width
)
2573 document_apply_indent_settings(doc
);
2574 ui_document_show_hide(doc
);
2577 sidebar_openfiles_update(doc
); /* to update the icon */
2578 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2583 void document_reload_config(GeanyDocument
*doc
)
2585 document_load_config(doc
, doc
->file_type
, TRUE
);
2590 * Sets the encoding of a document.
2591 * This function only set the encoding of the %document, it does not any conversions. The new
2592 * encoding is used when e.g. saving the file.
2594 * @param doc The document to use.
2595 * @param new_encoding The encoding to be set for the document.
2597 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2599 if (doc
== NULL
|| new_encoding
== NULL
||
2600 utils_str_equal(new_encoding
, doc
->encoding
))
2603 g_free(doc
->encoding
);
2604 doc
->encoding
= g_strdup(new_encoding
);
2606 ui_update_statusbar(doc
, -1);
2607 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2608 encodings_is_unicode_charset(doc
->encoding
));
2612 /* own Undo / Redo implementation to be able to undo / redo changes
2613 * to the encoding or the Unicode BOM (which are Scintilla independet).
2614 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2616 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2617 void document_undo_clear(GeanyDocument
*doc
)
2621 while (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0)
2623 a
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2624 if (G_LIKELY(a
!= NULL
))
2628 case UNDO_ENCODING
: g_free(a
->data
); break;
2634 doc
->priv
->undo_actions
= NULL
;
2636 while (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0)
2638 a
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2639 if (G_LIKELY(a
!= NULL
))
2643 case UNDO_ENCODING
: g_free(a
->data
); break;
2649 doc
->priv
->redo_actions
= NULL
;
2651 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2652 document_set_text_changed(doc
, FALSE
);
2656 /* note: this is called on SCN_MODIFIED notifications */
2657 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2659 undo_action
*action
;
2661 g_return_if_fail(doc
!= NULL
);
2663 action
= g_new0(undo_action
, 1);
2664 action
->type
= type
;
2665 action
->data
= data
;
2667 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2669 /* avoid unnecessary redraws */
2670 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2671 document_set_text_changed(doc
, TRUE
);
2673 ui_update_popup_reundo_items(doc
);
2677 gboolean
document_can_undo(GeanyDocument
*doc
)
2679 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2681 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2688 static void update_changed_state(GeanyDocument
*doc
)
2691 (sci_is_modified(doc
->editor
->sci
) ||
2692 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2693 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2694 document_set_text_changed(doc
, doc
->changed
);
2698 void document_undo(GeanyDocument
*doc
)
2700 undo_action
*action
;
2702 g_return_if_fail(doc
!= NULL
);
2704 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2706 if (G_UNLIKELY(action
== NULL
))
2708 /* fallback, should not be necessary */
2709 geany_debug("%s: fallback used", G_STRFUNC
);
2710 sci_undo(doc
->editor
->sci
);
2714 switch (action
->type
)
2716 case UNDO_SCINTILLA
:
2718 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
2720 sci_undo(doc
->editor
->sci
);
2725 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2727 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2728 ui_update_statusbar(doc
, -1);
2729 ui_document_show_hide(doc
);
2734 /* use the "old" encoding */
2735 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2737 document_set_encoding(doc
, (const gchar
*)action
->data
);
2739 ignore_callback
= TRUE
;
2740 encodings_select_radio_item((const gchar
*)action
->data
);
2741 ignore_callback
= FALSE
;
2743 g_free(action
->data
);
2749 g_free(action
); /* free the action which was taken from the stack */
2751 update_changed_state(doc
);
2752 ui_update_popup_reundo_items(doc
);
2756 gboolean
document_can_redo(GeanyDocument
*doc
)
2758 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2760 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
2767 void document_redo(GeanyDocument
*doc
)
2769 undo_action
*action
;
2771 g_return_if_fail(doc
!= NULL
);
2773 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2775 if (G_UNLIKELY(action
== NULL
))
2777 /* fallback, should not be necessary */
2778 geany_debug("%s: fallback used", G_STRFUNC
);
2779 sci_redo(doc
->editor
->sci
);
2783 switch (action
->type
)
2785 case UNDO_SCINTILLA
:
2787 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
2789 sci_redo(doc
->editor
->sci
);
2794 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2796 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2797 ui_update_statusbar(doc
, -1);
2798 ui_document_show_hide(doc
);
2803 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2805 document_set_encoding(doc
, (const gchar
*)action
->data
);
2807 ignore_callback
= TRUE
;
2808 encodings_select_radio_item((const gchar
*)action
->data
);
2809 ignore_callback
= FALSE
;
2811 g_free(action
->data
);
2817 g_free(action
); /* free the action which was taken from the stack */
2819 update_changed_state(doc
);
2820 ui_update_popup_reundo_items(doc
);
2824 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2826 undo_action
*action
;
2828 g_return_if_fail(doc
!= NULL
);
2830 action
= g_new0(undo_action
, 1);
2831 action
->type
= type
;
2832 action
->data
= data
;
2834 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
2836 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2837 document_set_text_changed(doc
, TRUE
);
2839 ui_update_popup_reundo_items(doc
);
2846 #ifdef USE_GIO_FILEMON
2847 STATUS_DISK_CHANGED
,
2856 } document_status_styles
[] = {
2857 { "geany-document-status-changed", {0}, FALSE
},
2858 #ifdef USE_GIO_FILEMON
2859 { "geany-document-status-disk-changed", {0}, FALSE
},
2861 { "geany-document-status-readonly", {0}, FALSE
}
2865 static gint
document_get_status_id(GeanyDocument
*doc
)
2868 return STATUS_CHANGED
;
2869 #ifdef USE_GIO_FILEMON
2870 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
2871 return STATUS_DISK_CHANGED
;
2873 else if (doc
->readonly
)
2874 return STATUS_READONLY
;
2880 /* returns an identifier that is to be set as a widget name or class to get it styled
2881 * depending on the document status (changed, readonly, etc.)
2882 * a NULL return value means default (unchanged) style */
2883 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
2887 g_return_val_if_fail(doc
!= NULL
, NULL
);
2889 status
= document_get_status_id(doc
);
2893 return document_status_styles
[status
].name
;
2898 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
2899 * Returned colors are red if the document has changes, green if the document is read-only
2900 * or simply @c NULL if the document is unmodified but writable.
2902 * @param doc The document to use.
2904 * @return The color for the document or @c NULL if the default color should be used. The color
2905 * object is owned by Geany and should not be modified or freed.
2909 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
2913 g_return_val_if_fail(doc
!= NULL
, NULL
);
2915 status
= document_get_status_id(doc
);
2918 if (! document_status_styles
[status
].loaded
)
2920 #if GTK_CHECK_VERSION(3, 0, 0)
2922 GtkWidgetPath
*path
= gtk_widget_path_new();
2923 GtkStyleContext
*ctx
= gtk_style_context_new();
2924 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
2925 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
2926 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
2927 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
2928 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
2929 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
2930 gtk_style_context_set_path(ctx
, path
);
2931 gtk_style_context_get_color(ctx
, GTK_STATE_NORMAL
, &color
);
2932 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
2933 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
2934 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
2935 document_status_styles
[status
].loaded
= TRUE
;
2936 gtk_widget_path_unref(path
);
2937 g_object_unref(ctx
);
2939 GtkSettings
*settings
= gtk_widget_get_settings(GTK_WIDGET(doc
->editor
->sci
));
2940 gchar
*path
= g_strconcat("GeanyMainWindow.GtkHBox.GtkNotebook.",
2941 document_status_styles
[status
].name
, NULL
);
2942 GtkStyle
*style
= gtk_rc_get_style_by_paths(settings
, path
, NULL
, GTK_TYPE_LABEL
);
2944 document_status_styles
[status
].color
= style
->fg
[GTK_STATE_NORMAL
];
2945 document_status_styles
[status
].loaded
= TRUE
;
2949 return &document_status_styles
[status
].color
;
2953 /** Accessor function for @ref documents_array items.
2954 * @warning Always check the returned document is valid (@c doc->is_valid).
2955 * @param idx @c documents_array index.
2956 * @return The document, or @c NULL if @a idx is out of range.
2960 GeanyDocument
*document_index(gint idx
)
2962 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
2966 /* create a new file and copy file content and properties */
2967 G_MODULE_EXPORT
void on_clone1_activate(GtkMenuItem
*menuitem
, gpointer user_data
)
2969 GeanyDocument
*old_doc
= document_get_current();
2972 document_clone(old_doc
);
2976 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
2980 ScintillaObject
*old_sci
;
2982 g_return_val_if_fail(old_doc
, NULL
);
2983 old_sci
= old_doc
->editor
->sci
;
2984 if (sci_has_selection(old_sci
))
2985 text
= sci_get_selection_contents(old_sci
);
2987 text
= sci_get_contents(old_sci
, -1);
2989 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
2991 document_set_text_changed(doc
, TRUE
);
2993 /* copy file properties */
2994 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
2995 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
2996 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
2997 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
2998 old_doc
->editor
->indent_width
);
2999 doc
->readonly
= old_doc
->readonly
;
3000 doc
->has_bom
= old_doc
->has_bom
;
3001 doc
->priv
->protected = 0;
3002 document_set_encoding(doc
, old_doc
->encoding
);
3003 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
3004 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
3007 ui_document_show_hide(doc
);
3012 /* @note If successful, this should always be followed up with a call to
3013 * document_close_all().
3014 * @return TRUE if all files were saved or had their changes discarded. */
3015 gboolean
document_account_for_unsaved(void)
3017 guint i
, p
, page_count
;
3019 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
3020 /* iterate over documents in tabs order */
3021 for (p
= 0; p
< page_count
; p
++)
3023 GeanyDocument
*doc
= document_get_from_page(p
);
3025 if (DOC_VALID(doc
) && doc
->changed
)
3027 if (! dialogs_show_unsaved_file(doc
))
3031 /* all documents should now be accounted for, so ignore any changes */
3032 foreach_document (i
)
3034 documents
[i
]->changed
= FALSE
;
3040 static void force_close_all(void)
3042 guint i
, len
= documents_array
->len
;
3044 /* check all documents have been accounted for */
3045 for (i
= 0; i
< len
; i
++)
3047 if (documents
[i
]->is_valid
)
3049 g_return_if_fail(!documents
[i
]->changed
);
3052 main_status
.closing_all
= TRUE
;
3056 document_close(documents
[i
]);
3059 main_status
.closing_all
= FALSE
;
3063 gboolean
document_close_all(void)
3065 if (! document_account_for_unsaved())
3075 * Shows a message related to a document.
3077 * Use this whenever the user needs to see a document-related message,
3078 * for example when the file was externally modified or deleted.
3080 * Any of the buttons can be @c NULL. If not @c NULL, @a btn_1's
3081 * @a response_1 response will be the default for the @c GtkInfoBar or
3084 * @param doc @c GeanyDocument.
3085 * @param msgtype The type of message.
3086 * @param response_cb A callback function called when there's a response.
3087 * @param btn_1 The first action area button.
3088 * @param response_1 The response for @a btn_1.
3089 * @param btn_2 The second action area button.
3090 * @param response_2 The response for @a btn_2.
3091 * @param btn_3 The third action area button.
3092 * @param response_3 The response for @a btn_3.
3093 * @param extra_text Text to show below the main message.
3094 * @param format The text format for the main message.
3095 * @param ... Used with @a format as in @c printf.
3099 static GtkWidget
* document_show_message(GeanyDocument
*doc
, GtkMessageType msgtype
,
3100 void (*response_cb
)(GtkWidget
*info_bar
, gint response_id
, GeanyDocument
*doc
),
3101 const gchar
*btn_1
, GtkResponseType response_1
,
3102 const gchar
*btn_2
, GtkResponseType response_2
,
3103 const gchar
*btn_3
, GtkResponseType response_3
,
3104 const gchar
*extra_text
, const gchar
*format
, ...)
3107 gchar
*text
, *markup
;
3108 GtkWidget
*hbox
, *vbox
, *icon
, *label
, *extra_label
, *content_area
;
3109 GtkWidget
*info_widget
, *parent
;
3110 parent
= gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
),
3111 document_get_notebook_page(doc
));
3113 va_start(args
, format
);
3114 text
= g_strdup_vprintf(format
, args
);
3117 markup
= g_strdup_printf("<span size=\"larger\">%s</span>", text
);
3120 info_widget
= gtk_info_bar_new();
3121 /* must be done now else Gtk-WARNING: widget not within a GtkWindow */
3122 gtk_box_pack_start(GTK_BOX(parent
), info_widget
, FALSE
, TRUE
, 0);
3124 gtk_info_bar_set_message_type(GTK_INFO_BAR(info_widget
), msgtype
);
3127 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_1
, response_1
);
3129 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_2
, response_2
);
3131 gtk_info_bar_add_button(GTK_INFO_BAR(info_widget
), btn_3
, response_3
);
3133 content_area
= gtk_info_bar_get_content_area(GTK_INFO_BAR(info_widget
));
3135 label
= geany_wrap_label_new(NULL
);
3136 gtk_label_set_markup(GTK_LABEL(label
), markup
);
3139 g_signal_connect(info_widget
, "response", G_CALLBACK(response_cb
), doc
);
3140 g_signal_connect_after(info_widget
, "response", G_CALLBACK(gtk_widget_destroy
), NULL
);
3142 hbox
= gtk_hbox_new(FALSE
, 12);
3143 gtk_box_pack_start(GTK_BOX(content_area
), hbox
, TRUE
, TRUE
, 0);
3147 case GTK_MESSAGE_INFO
:
3148 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_INFO
, GTK_ICON_SIZE_DIALOG
);
3150 case GTK_MESSAGE_WARNING
:
3151 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_WARNING
, GTK_ICON_SIZE_DIALOG
);
3153 case GTK_MESSAGE_QUESTION
:
3154 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_QUESTION
, GTK_ICON_SIZE_DIALOG
);
3156 case GTK_MESSAGE_ERROR
:
3157 icon
= gtk_image_new_from_stock(GTK_STOCK_DIALOG_ERROR
, GTK_ICON_SIZE_DIALOG
);
3165 gtk_box_pack_start(GTK_BOX(hbox
), icon
, FALSE
, TRUE
, 0);
3169 vbox
= gtk_vbox_new(FALSE
, 6);
3170 extra_label
= geany_wrap_label_new(extra_text
);
3171 gtk_box_pack_start(GTK_BOX(vbox
), label
, TRUE
, TRUE
, 0);
3172 gtk_box_pack_start(GTK_BOX(vbox
), extra_label
, TRUE
, TRUE
, 0);
3173 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, TRUE
, TRUE
, 0);
3176 gtk_box_pack_start(GTK_BOX(hbox
), label
, TRUE
, TRUE
, 0);
3178 gtk_box_reorder_child(GTK_BOX(parent
), info_widget
, 0);
3180 gtk_widget_show_all(info_widget
);
3185 static void on_monitor_reload_file_response(GtkWidget
*bar
, gint response_id
, GeanyDocument
*doc
)
3187 unprotect_document(doc
);
3188 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = NULL
;
3190 if (response_id
== GTK_RESPONSE_ACCEPT
)
3191 document_reload_file(doc
, doc
->encoding
);
3194 static gboolean
on_sci_key(GtkWidget
*widget
, GdkEventKey
*event
, gpointer data
)
3196 GtkInfoBar
*bar
= GTK_INFO_BAR(data
);
3198 g_return_val_if_fail(event
->type
== GDK_KEY_PRESS
, FALSE
);
3200 switch (event
->keyval
)
3203 case GDK_ISO_Left_Tab
:
3205 GtkWidget
*action_area
= gtk_info_bar_get_action_area(bar
);
3206 GtkDirectionType dir
= event
->keyval
== GDK_Tab
? GTK_DIR_TAB_FORWARD
: GTK_DIR_TAB_BACKWARD
;
3207 gtk_widget_child_focus(action_area
, dir
);
3212 gtk_info_bar_response(bar
, GTK_RESPONSE_CANCEL
);
3220 /* g_signal_handlers_disconnect_by_data is a macro that cannot be used as GCallback */
3221 static void on_bar_unrealize(GtkWidget
*bar
, ScintillaObject
*sci
)
3223 g_signal_handlers_disconnect_by_func(sci
, on_sci_key
, bar
);
3226 static void enable_key_intercept(GeanyDocument
*doc
, GtkWidget
*bar
)
3228 g_signal_connect(doc
->editor
->sci
, "key-press-event", G_CALLBACK(on_sci_key
), bar
);
3229 /* make the signal disconnect automatically */
3230 g_signal_connect(bar
, "unrealize", G_CALLBACK(on_bar_unrealize
), doc
->editor
->sci
);
3233 static void monitor_reload_file(GeanyDocument
*doc
)
3235 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
3237 /* show this message only once */
3238 if (doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] == NULL
)
3242 bar
= document_show_message(doc
, GTK_MESSAGE_QUESTION
, on_monitor_reload_file_response
,
3243 _("_Reload"), GTK_RESPONSE_ACCEPT
,
3244 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3245 NULL
, GTK_RESPONSE_NONE
,
3246 _("Do you want to reload it?"),
3247 _("The file '%s' on the disk is more recent than the current buffer."),
3250 protect_document(doc
);
3251 doc
->priv
->info_bars
[MSG_TYPE_RELOAD
] = bar
;
3252 enable_key_intercept(doc
, bar
);
3258 static void on_monitor_resave_missing_file_response(GtkWidget
*bar
,
3262 gboolean file_saved
= FALSE
;
3264 unprotect_document(doc
);
3266 if (response_id
== GTK_RESPONSE_ACCEPT
)
3267 file_saved
= dialogs_show_save_as();
3271 document_set_text_changed(doc
, TRUE
);
3272 /* don't prompt more than once */
3273 SETPTR(doc
->real_path
, NULL
);
3276 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = NULL
;
3280 static void monitor_resave_missing_file(GeanyDocument
*doc
)
3282 if (doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] == NULL
)
3284 GtkWidget
*bar
= doc
->priv
->info_bars
[MSG_TYPE_RELOAD
];
3286 if (bar
!= NULL
) /* the "file on disk is newer" warning is now moot */
3287 gtk_info_bar_response(GTK_INFO_BAR(bar
), GTK_RESPONSE_CANCEL
);
3289 bar
= document_show_message(doc
, GTK_MESSAGE_WARNING
,
3290 on_monitor_resave_missing_file_response
,
3291 GTK_STOCK_SAVE
, GTK_RESPONSE_ACCEPT
,
3292 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
3293 NULL
, GTK_RESPONSE_NONE
,
3294 _("Try to resave the file?"),
3295 _("File \"%s\" was not found on disk!"),
3298 protect_document(doc
);
3299 doc
->priv
->info_bars
[MSG_TYPE_RESAVE
] = bar
;
3300 enable_key_intercept(doc
, bar
);
3305 /* Set force to force a disk check, otherwise it is ignored if there was a check
3306 * in the last file_prefs.disk_check_timeout seconds.
3307 * @return @c TRUE if the file has changed. */
3308 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3310 gboolean ret
= FALSE
;
3311 gboolean use_gio_filemon
;
3312 time_t cur_time
= 0;
3314 gchar
*locale_filename
;
3315 FileDiskStatus old_status
;
3317 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3319 /* ignore remote files and documents that have never been saved to disk */
3320 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3321 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3324 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3326 if (use_gio_filemon
)
3328 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3333 cur_time
= time(NULL
);
3334 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3337 doc
->priv
->last_check
= cur_time
;
3340 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3341 if (g_stat(locale_filename
, &st
) != 0)
3343 monitor_resave_missing_file(doc
);
3344 /* doc may be closed now */
3347 else if (! use_gio_filemon
&& /* ignore check when using GIO */
3348 doc
->priv
->mtime
> cur_time
)
3350 g_warning("%s: Something is wrong with the time stamps.", G_STRFUNC
);
3351 /* Note: on Windows st.st_mtime can be newer than cur_time */
3353 else if (doc
->priv
->mtime
< st
.st_mtime
)
3355 /* make sure the user is not prompted again after he cancelled the "reload file?" message */
3356 doc
->priv
->mtime
= st
.st_mtime
;
3357 monitor_reload_file(doc
);
3358 /* doc may be closed now */
3361 g_free(locale_filename
);
3364 { /* doc can get invalid when a document was closed */
3365 old_status
= doc
->priv
->file_disk_status
;
3366 doc
->priv
->file_disk_status
= FILE_OK
;
3367 if (old_status
!= doc
->priv
->file_disk_status
)
3368 ui_update_tab_status(doc
);
3374 /** Compares documents by their display names.
3375 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3376 * @note 'Display name' means the base name of the document's filename.
3378 * @param a @c GeanyDocument**.
3379 * @param b @c GeanyDocument**.
3380 * @warning The arguments take the address of each document pointer.
3381 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3385 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3387 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3388 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3389 gchar
*base_name_a
, *base_name_b
;
3392 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3393 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3395 result
= strcmp(base_name_a
, base_name_b
);
3397 g_free(base_name_a
);
3398 g_free(base_name_b
);
3404 /** Compares documents by their tab order.
3405 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3407 * @param a @c GeanyDocument**.
3408 * @param b @c GeanyDocument**.
3409 * @warning The arguments take the address of each document pointer.
3410 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3412 * @since 0.21 (GEANY_API_VERSION 209)
3414 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3416 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3417 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3418 gint notebook_position_doc_a
;
3419 gint notebook_position_doc_b
;
3421 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3422 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3424 if (notebook_position_doc_a
< notebook_position_doc_b
)
3426 if (notebook_position_doc_a
> notebook_position_doc_b
)
3433 /** Compares documents by their tab order, in reverse order.
3434 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3436 * @param a @c GeanyDocument**.
3437 * @param b @c GeanyDocument**.
3438 * @warning The arguments take the address of each document pointer.
3439 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3441 * @since 0.21 (GEANY_API_VERSION 209)
3443 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3445 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3446 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3447 gint notebook_position_doc_a
;
3448 gint notebook_position_doc_b
;
3450 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3451 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3453 if (notebook_position_doc_a
< notebook_position_doc_b
)
3455 if (notebook_position_doc_a
> notebook_position_doc_b
)
3462 void document_grab_focus(GeanyDocument
*doc
)
3464 g_return_if_fail(doc
!= NULL
);
3466 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));