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.
29 #ifdef HAVE_SYS_TIME_H
30 # include <sys/time.h>
38 #ifdef HAVE_SYS_TYPES_H
39 # include <sys/types.h>
44 /* gstdio.h also includes sys/stat.h */
45 #include <glib/gstdio.h>
47 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
48 /*#define USE_GIO_FILEMON 1*/
52 #include "documentprivate.h"
53 #include "filetypes.h"
55 #include "sciwrappers.h"
58 #include "msgwindow.h"
59 #include "templates.h"
63 #include "encodings.h"
69 #include "highlighting.h"
73 #include "filetypesprivate.h"
79 GeanyFilePrefs file_prefs
;
81 /** Dynamic array of GeanyDocument pointers holding information about the notebook tabs.
82 * Once a pointer is added to this, it is never freed. This means you can keep a pointer
83 * to a document over time, but it might no longer represent a notebook tab. To check this,
84 * check @c doc_ptr->is_valid. Of course, the pointer may represent a different
87 * You also need to check @c GeanyDocument::is_valid when iterating over this array,
88 * although usually you would just use the foreach_document() macro.
90 * Never assume that the order of document pointers is the same as the order of notebook tabs.
91 * Notebook tabs can be reordered. Use @c document_get_from_page(). */
92 GPtrArray
*documents_array
= NULL
;
95 /* an undo action, also used for redo actions */
98 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
99 guint type
; /* to identify the action */
100 gpointer
*data
; /* the old value (before the change), in case of a redo action
101 * it contains the new value */
105 static void document_undo_clear(GeanyDocument
*doc
);
106 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
107 static gboolean
remove_page(guint page_num
);
111 * Finds a document whose @c real_path field matches the given filename.
113 * @param realname The filename to search, which should be identical to the
114 * string returned by @c tm_get_real_path().
116 * @return The matching document, or @c NULL.
117 * @note This is only really useful when passing a @c TMWorkObject::file_name.
118 * @see GeanyDocument::real_path.
119 * @see document_find_by_filename().
123 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
128 return NULL
; /* file doesn't exist on disk */
130 for (i
= 0; i
< documents_array
->len
; i
++)
132 GeanyDocument
*doc
= documents
[i
];
134 if (! doc
->is_valid
|| ! doc
->real_path
)
137 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
146 /* dereference symlinks, /../ junk in path and return locale encoding */
147 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
149 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
150 gchar
*realname
= tm_get_real_path(locale_name
);
158 * Finds a document with the given filename.
159 * This matches either an exact GeanyDocument::file_name string, or variant
160 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
163 * @param utf8_filename The filename to search (in UTF-8 encoding).
165 * @return The matching document, or @c NULL.
166 * @see document_find_by_real_path().
168 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
174 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
176 /* First search GeanyDocument::file_name, so we can find documents with a
177 * filename set but not saved on disk, like vcdiff produces */
178 for (i
= 0; i
< documents_array
->len
; i
++)
182 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
185 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
190 /* Now try matching based on the realpath(), which is unique per file on disk */
191 realname
= get_real_path_from_utf8(utf8_filename
);
192 doc
= document_find_by_real_path(realname
);
198 /* returns the document which has sci, or NULL. */
199 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
203 g_return_val_if_fail(sci
!= NULL
, NULL
);
205 for (i
= 0; i
< documents_array
->len
; i
++)
207 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
214 /** Gets the notebook page index for a document.
215 * @param doc The document.
218 gint
document_get_notebook_page(GeanyDocument
*doc
)
220 g_return_val_if_fail(doc
!= NULL
, -1);
222 return gtk_notebook_page_num(GTK_NOTEBOOK(main_widgets
.notebook
),
223 GTK_WIDGET(doc
->editor
->sci
));
228 * Finds the document for the given notebook page @a page_num.
230 * @param page_num The notebook page number to search.
232 * @return The corresponding document for the given notebook page, or @c NULL.
234 GeanyDocument
*document_get_from_page(guint page_num
)
236 ScintillaObject
*sci
;
238 if (page_num
>= documents_array
->len
)
241 sci
= (ScintillaObject
*)gtk_notebook_get_nth_page(
242 GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
244 return document_find_by_sci(sci
);
249 * Finds the current document.
251 * @return A pointer to the current document or @c NULL if there are no opened documents.
253 GeanyDocument
*document_get_current(void)
255 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
261 ScintillaObject
*sci
= (ScintillaObject
*)
262 gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), cur_page
);
264 return document_find_by_sci(sci
);
269 void document_init_doclist()
271 documents_array
= g_ptr_array_new();
275 void document_finalize()
279 for (i
= 0; i
< documents_array
->len
; i
++)
280 g_free(documents
[i
]);
281 g_ptr_array_free(documents_array
, TRUE
);
286 * Returns the last part of the filename of the given GeanyDocument. The result is also
287 * truncated to a maximum of @a length characters in case the filename is very long.
289 * @param doc The document to use.
290 * @param length The length of the resulting string or -1 to use a default value.
292 * @return The ellipsized last part of the filename of @a doc, should be freed when no
297 /* TODO make more use of this */
298 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
300 gchar
*base_name
, *short_name
;
302 g_return_val_if_fail(doc
!= NULL
, NULL
);
307 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
308 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
316 void document_update_tab_label(GeanyDocument
*doc
)
321 g_return_if_fail(doc
!= NULL
);
323 short_name
= document_get_basename_for_display(doc
, -1);
325 /* we need to use the event box for the tooltip, labels don't get the necessary events */
326 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
327 parent
= gtk_widget_get_parent(parent
);
329 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
331 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
338 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
339 * according to the document's save state.
340 * This is called by Geany mostly when opening or saving files.
342 * @param doc The document to use.
343 * @param changed Whether the document state should indicate changes have been made.
345 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
347 g_return_if_fail(doc
!= NULL
);
349 doc
->changed
= changed
;
351 if (! main_status
.quitting
)
353 ui_update_tab_status(doc
);
354 ui_save_buttons_toggle(changed
);
355 ui_set_window_title(doc
);
356 ui_update_statusbar(doc
, -1);
361 /* returns the next free place in the document list,
362 * or -1 if the documents_array is full */
363 static gint
document_get_new_idx(void)
367 for (i
= 0; i
< documents_array
->len
; i
++)
369 if (documents
[i
]->editor
== NULL
)
378 static void queue_colourise(GeanyDocument
*doc
)
380 /* Colourise the editor before it is next drawn */
381 doc
->priv
->colourise_needed
= TRUE
;
383 /* If the editor doesn't need drawing (e.g. after saving the current
384 * document), we need to force a redraw, so the expose event is triggered.
385 * This ensures we don't start colourising before all documents are opened/saved,
386 * only once the editor is drawn. */
387 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
391 #ifdef USE_GIO_FILEMON
392 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
393 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
396 g_return_if_fail(doc
!= NULL
);
398 if (file_prefs
.disk_check_timeout
== 0)
401 geany_debug("%s: event: %d previous file status: %d",
402 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
405 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
407 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
408 doc
->priv
->file_disk_status
= FILE_OK
;
410 doc
->priv
->file_disk_status
= FILE_CHANGED
;
411 g_message("%s: FILE_CHANGED", G_STRFUNC
);
414 case G_FILE_MONITOR_EVENT_DELETED
:
416 doc
->priv
->file_disk_status
= FILE_CHANGED
;
417 g_message("%s: FILE_MISSING", G_STRFUNC
);
423 if (doc
->priv
->file_disk_status
!= FILE_OK
)
425 ui_update_tab_status(doc
);
431 static void document_stop_file_monitoring(GeanyDocument
*doc
)
433 g_return_if_fail(doc
!= NULL
);
435 if (doc
->priv
->monitor
!= NULL
)
437 g_object_unref(doc
->priv
->monitor
);
438 doc
->priv
->monitor
= NULL
;
443 static void monitor_file_setup(GeanyDocument
*doc
)
445 g_return_if_fail(doc
!= NULL
);
446 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
447 * doesn't work at all for remote files and legacy polling is too slow. */
448 if (! doc
->priv
->is_remote
)
450 #ifdef USE_GIO_FILEMON
451 gchar
*locale_filename
;
453 /* stop any previous monitoring */
454 document_stop_file_monitoring(doc
);
456 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
457 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
459 /* get a file monitor and connect to the 'changed' signal */
460 GFile
*file
= g_file_new_for_path(locale_filename
);
461 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
462 g_signal_connect(doc
->priv
->monitor
, "changed",
463 G_CALLBACK(monitor_file_changed_cb
), doc
);
465 /* we set the rate limit according to the GUI pref but it's most probably not used */
466 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
468 g_object_unref(file
);
470 g_free(locale_filename
);
473 doc
->priv
->file_disk_status
= FILE_OK
;
477 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
479 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
482 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
483 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
485 if (source_widget
== NULL
)
486 source_widget
= doc
->priv
->tag_tree
;
488 if (focusw
== source_widget
)
489 gtk_widget_grab_focus(sci
);
494 static gboolean
on_idle_focus(gpointer doc
)
496 document_try_focus(doc
, NULL
);
501 /* Creates a new document and editor, adding a tab in the notebook.
502 * @return The created document */
503 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
507 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
511 doc
= document_get_current();
512 /* remove the empty document first */
513 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
514 /* prevent immediately opening another new doc with
515 * new_document_after_close pref */
519 new_idx
= document_get_new_idx();
520 if (new_idx
== -1) /* expand the array, no free places */
522 doc
= g_new0(GeanyDocument
, 1);
524 new_idx
= documents_array
->len
;
525 g_ptr_array_add(documents_array
, doc
);
528 doc
= documents
[new_idx
];
530 /* initialize default document settings */
531 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
532 doc
->index
= new_idx
;
533 doc
->file_name
= g_strdup(utf8_filename
);
534 doc
->editor
= editor_create(doc
);
535 #ifndef USE_GIO_FILEMON
536 doc
->priv
->last_check
= time(NULL
);
539 sidebar_openfiles_add(doc
); /* sets doc->iter */
541 notebook_new_tab(doc
);
543 /* select document in sidebar */
545 GtkTreeSelection
*sel
;
547 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
548 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
551 ui_document_buttons_update();
553 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
559 * Closes the given document.
561 * @param doc The document to remove.
563 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
567 gboolean
document_close(GeanyDocument
*doc
)
569 g_return_val_if_fail(doc
, FALSE
);
571 return document_remove_page(document_get_notebook_page(doc
));
575 /* Call document_remove_page() instead, this is only needed for document_create()
576 * to prevent re-opening a new document when the last document is closed (if enabled). */
577 static gboolean
remove_page(guint page_num
)
579 GeanyDocument
*doc
= document_get_from_page(page_num
);
581 g_return_val_if_fail(doc
!= NULL
, FALSE
);
583 if (doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
586 /* tell any plugins that the document is about to be closed */
587 g_signal_emit_by_name(geany_object
, "document-close", doc
);
589 /* Checking real_path makes it likely the file exists on disk */
590 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
591 ui_add_recent_document(doc
);
593 doc
->is_valid
= FALSE
;
595 if (! main_status
.quitting
)
597 notebook_remove_page(page_num
);
598 sidebar_remove_document(doc
);
599 navqueue_remove_file(doc
->file_name
);
600 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
602 g_free(doc
->encoding
);
603 g_free(doc
->priv
->saved_encoding
.encoding
);
604 g_free(doc
->file_name
);
605 g_free(doc
->real_path
);
606 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
608 if (doc
->priv
->tag_tree
)
609 gtk_widget_destroy(doc
->priv
->tag_tree
);
611 editor_destroy(doc
->editor
);
612 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
614 document_stop_file_monitoring(doc
);
616 document_undo_clear(doc
);
620 /* reset document settings to defaults for re-use */
621 memset(doc
, 0, sizeof(GeanyDocument
));
623 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
625 sidebar_update_tag_list(NULL
, FALSE
);
626 ui_set_window_title(NULL
);
627 ui_save_buttons_toggle(FALSE
);
628 ui_update_popup_reundo_items(NULL
);
629 ui_document_buttons_update();
630 build_menu_update(NULL
);
637 * Removes the given notebook tab at @a page_num and clears all related information
638 * in the document list.
640 * @param page_num The notebook page number to remove.
642 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
644 gboolean
document_remove_page(guint page_num
)
646 gboolean done
= remove_page(page_num
);
648 if (done
&& ui_prefs
.new_document_after_close
)
649 document_new_file_if_non_open();
655 /* used to keep a record of the unchanged document state encoding */
656 static void store_saved_encoding(GeanyDocument
*doc
)
658 g_free(doc
->priv
->saved_encoding
.encoding
);
659 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
660 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
664 /* Opens a new empty document only if there are no other documents open */
665 GeanyDocument
*document_new_file_if_non_open(void)
667 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
668 return document_new_file(NULL
, NULL
, NULL
);
675 * Creates a new document.
676 * Line endings in @a text will be converted to the default setting.
677 * Afterwards, the @c "document-new" signal is emitted for plugins.
679 * @param utf8_filename The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
680 * @param ft The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
681 * @param text The initial content of the file (in UTF-8 encoding), or @c NULL.
683 * @return The new document.
685 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
689 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
692 tmp
= utils_strdupa(utf8_filename
); /* work around const */
693 utils_tidy_path(tmp
);
696 doc
= document_create(utf8_filename
);
698 g_assert(doc
!= NULL
);
700 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
703 GString
*template = g_string_new(text
);
704 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
706 sci_set_text(doc
->editor
->sci
, template->str
);
707 g_string_free(template, TRUE
);
710 sci_clear_all(doc
->editor
->sci
);
712 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
714 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
715 sci_empty_undo_buffer(doc
->editor
->sci
);
717 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
718 /* store the opened encoding for undo/redo */
719 store_saved_encoding(doc
);
721 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
722 ft
= filetypes_detect_from_document(doc
);
724 document_set_filetype(doc
, ft
); /* also re-parses tags */
726 ui_set_window_title(doc
);
727 build_menu_update(doc
);
728 document_set_text_changed(doc
, FALSE
);
729 ui_document_show_hide(doc
); /* update the document menu */
731 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
732 /* bring it in front, jump to the start and grab the focus */
733 editor_goto_pos(doc
->editor
, 0, FALSE
);
734 document_try_focus(doc
, NULL
);
736 #ifdef USE_GIO_FILEMON
737 monitor_file_setup(doc
);
739 doc
->priv
->mtime
= time(NULL
);
742 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
743 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
745 g_signal_emit_by_name(geany_object
, "document-new", doc
);
747 msgwin_status_add(_("New file \"%s\" opened."),
755 * Opens a document specified by @a locale_filename.
756 * Afterwards, the @c "document-open" signal is emitted for plugins.
758 * @param locale_filename The filename of the document to load, in locale encoding.
759 * @param readonly Whether to open the document in read-only mode.
760 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
761 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
763 * @return The document opened or @c NULL.
765 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
766 GeanyFiletype
*ft
, const gchar
*forced_enc
)
768 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
774 gchar
*data
; /* null-terminated file data */
775 gsize len
; /* string length of data */
778 time_t mtime
; /* modification time, read by stat::st_mtime */
783 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
784 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
785 FileData
*filedata
, const gchar
*forced_enc
)
790 filedata
->data
= NULL
;
792 filedata
->enc
= NULL
;
793 filedata
->bom
= FALSE
;
794 filedata
->readonly
= FALSE
;
796 if (g_stat(locale_filename
, &st
) != 0)
798 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
799 display_filename
, g_strerror(errno
));
803 filedata
->mtime
= st
.st_mtime
;
805 if (! g_file_get_contents(locale_filename
, &filedata
->data
, NULL
, &err
))
807 ui_set_statusbar(TRUE
, "%s", err
->message
);
812 filedata
->len
= (gsize
) st
.st_size
;
813 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
814 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
818 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
819 display_filename
, forced_enc
);
823 ui_set_statusbar(TRUE
,
824 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
827 g_free(filedata
->data
);
831 if (filedata
->readonly
)
833 const gchar
*warn_msg
= _(
834 "The file \"%s\" could not be opened properly and has been truncated. " \
835 "This can occur if the file contains a NULL byte. " \
836 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
838 if (main_status
.main_window_realized
)
839 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
841 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
848 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
849 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
850 * if cl_options.goto_column is set.
852 * returns the new position which may have changed */
853 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
855 if (cl_options
.goto_line
>= 0)
856 { /* goto line which was specified on command line and then undefine the line */
857 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
858 editor
->scroll_percent
= 0.5F
;
859 cl_options
.goto_line
= -1;
863 sci_set_current_position(editor
->sci
, pos
, FALSE
);
864 editor
->scroll_percent
= 0.5F
;
867 if (cl_options
.goto_column
>= 0)
868 { /* goto column which was specified on command line and then undefine the column */
870 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
871 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
872 editor
->scroll_percent
= 0.5F
;
873 cl_options
.goto_column
= -1;
876 return sci_get_current_position(editor
->sci
);
880 /* Count lines that start with some hard tabs then a soft tab. */
881 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
883 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
884 ScintillaObject
*sci
= editor
->sci
;
886 struct Sci_TextToFind ttf
;
887 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
888 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
893 ttf
.chrg
.cpMax
= sci_get_length(sci
);
894 ttf
.lpstrText
= regex
;
899 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
901 break; /* no more matches */
903 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
906 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
907 return count
> sci_get_line_count(sci
) * 0.02;
911 /* Detect the indent type based on counting the leading indent characters for each line.
912 * Returns whether detection succeeded, and the detected type in *type_ upon success */
913 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
915 GeanyEditor
*editor
= doc
->editor
;
916 ScintillaObject
*sci
= editor
->sci
;
917 gint line
, line_count
;
918 gsize tabs
= 0, spaces
= 0;
920 if (detect_tabs_and_spaces(editor
))
922 *type_
= GEANY_INDENT_TYPE_BOTH
;
926 line_count
= sci_get_line_count(sci
);
927 for (line
= 0; line
< line_count
; line
++)
929 gint pos
= sci_get_position_from_line(sci
, line
);
932 /* most code will have indent total <= 24, otherwise it's more likely to be
933 * alignment than indentation */
934 if (sci_get_line_indentation(sci
, line
) > 24)
937 c
= sci_get_char_at(sci
, pos
);
940 /* check for at least 2 spaces */
941 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
944 if (spaces
== 0 && tabs
== 0)
947 /* the factors may need to be tweaked */
948 if (spaces
> tabs
* 4)
949 *type_
= GEANY_INDENT_TYPE_SPACES
;
950 else if (tabs
> spaces
* 4)
951 *type_
= GEANY_INDENT_TYPE_TABS
;
953 *type_
= GEANY_INDENT_TYPE_BOTH
;
959 /* Detect the indent width based on counting the leading indent characters for each line.
960 * Returns whether detection succeeded, and the detected width in *width_ upon success */
961 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
963 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
964 ScintillaObject
*sci
= editor
->sci
;
965 gint line
, line_count
;
966 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
967 gint count
, width
, i
;
969 /* can't easily detect the supposed width of a tab, guess the default is OK */
970 if (type
== GEANY_INDENT_TYPE_TABS
)
973 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
974 sci_set_tab_width(sci
, 8);
976 line_count
= sci_get_line_count(sci
);
977 for (line
= 0; line
< line_count
; line
++)
979 gint pos
= sci_get_line_indent_position(sci
, line
);
981 /* We probably don't have style info yet, because we're generally called just after
982 * the document got created, so we can't use highlighting_is_code_style().
983 * That's not good, but the assumption below that concerning lines start with an
984 * asterisk (common continuation character for C/C++/Java/...) should do the trick
985 * without removing too much legitimate lines. */
986 if (sci_get_char_at(sci
, pos
) == '*')
989 width
= sci_get_line_indentation(sci
, line
);
990 /* most code will have indent total <= 24, otherwise it's more likely to be
991 * alignment than indentation */
994 /* < 2 is no indentation */
998 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1000 if ((width
% (i
+ 2)) == 0)
1005 width
= iprefs
->width
;
1006 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1008 /* give large indents higher weight not to be fooled by spurious indents */
1009 if (widths
[i
] >= count
* 1.5)
1024 /* same as detect_indent_width() but uses editor's indent type */
1025 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1027 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1031 void document_apply_indent_settings(GeanyDocument
*doc
)
1033 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1034 GeanyIndentType type
= iprefs
->type
;
1035 gint width
= iprefs
->width
;
1037 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1039 if (type
!= iprefs
->type
)
1041 const gchar
*name
= NULL
;
1045 case GEANY_INDENT_TYPE_SPACES
:
1048 case GEANY_INDENT_TYPE_TABS
:
1051 case GEANY_INDENT_TYPE_BOTH
:
1052 name
= _("Tabs and Spaces");
1055 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1056 * and Spaces), the second one is the filename */
1057 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1061 else if (doc
->file_type
->indent_type
> -1)
1062 type
= doc
->file_type
->indent_type
;
1064 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1066 if (width
!= iprefs
->width
)
1068 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1072 else if (doc
->file_type
->indent_width
> -1)
1073 width
= doc
->file_type
->indent_width
;
1075 editor_set_indent(doc
->editor
, type
, width
);
1079 void document_show_tab(GeanyDocument
*doc
)
1081 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1082 document_get_notebook_page(doc
));
1086 /* To open a new file, set doc to NULL; filename should be locale encoded.
1087 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1088 * pos is the cursor position, which can be overridden by --line and --column.
1089 * forced_enc can be NULL to detect the file encoding.
1090 * Returns: doc of the opened file or NULL if an error occurred. */
1091 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1092 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1095 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1096 gchar
*utf8_filename
= NULL
;
1097 gchar
*display_filename
= NULL
;
1098 gchar
*locale_filename
= NULL
;
1099 GeanyFiletype
*use_ft
;
1104 utf8_filename
= g_strdup(doc
->file_name
);
1105 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1109 /* filename must not be NULL when opening a file */
1110 g_return_val_if_fail(filename
, NULL
);
1113 /* if filename is a shortcut, try to resolve it */
1114 locale_filename
= win32_get_shortcut_target(filename
);
1116 locale_filename
= g_strdup(filename
);
1118 /* remove relative junk */
1119 utils_tidy_path(locale_filename
);
1121 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1122 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1124 /* if file is already open, switch to it and go */
1125 doc
= document_find_by_filename(utf8_filename
);
1128 ui_add_recent_document(doc
); /* either add or reorder recent item */
1129 /* show the doc before reload dialog */
1130 document_show_tab(doc
);
1131 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1134 if (reload
|| doc
== NULL
)
1135 { /* doc possibly changed */
1136 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1138 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1140 g_free(display_filename
);
1141 g_free(utf8_filename
);
1142 g_free(locale_filename
);
1148 doc
= document_create(utf8_filename
);
1149 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1151 /* file exists on disk, set real_path */
1152 SETPTR(doc
->real_path
, tm_get_real_path(locale_filename
));
1154 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1155 monitor_file_setup(doc
);
1158 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1159 sci_empty_undo_buffer(doc
->editor
->sci
);
1161 /* add the text to the ScintillaObject */
1162 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1163 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1164 queue_colourise(doc
); /* Ensure the document gets colourised. */
1166 /* detect & set line endings */
1167 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1168 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1169 g_free(filedata
.data
);
1171 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1173 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1174 g_free(doc
->encoding
); /* if reloading, free old encoding */
1175 doc
->encoding
= filedata
.enc
;
1176 doc
->has_bom
= filedata
.bom
;
1177 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1179 doc
->readonly
= readonly
|| filedata
.readonly
;
1180 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1182 /* update line number margin width */
1183 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1184 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
1189 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1190 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1193 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1197 document_undo_clear(doc
);
1201 /* update taglist, typedef keywords and build menu if necessary */
1202 document_set_filetype(doc
, use_ft
);
1204 /* set indentation settings after setting the filetype */
1206 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1208 document_apply_indent_settings(doc
);
1210 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1211 ui_document_show_hide(doc
); /* update the document menu */
1213 /* finally add current file to recent files menu, but not the files from the last session */
1214 if (! main_status
.opening_session_files
)
1215 ui_add_recent_document(doc
);
1219 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1220 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1224 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1225 /* For translators: this is the status window message for opening a file. %d is the number
1226 * of the newly opened file, %s indicates whether the file is opened read-only
1227 * (it is replaced with the string ", read-only"). */
1228 msgwin_status_add(_("File %s opened(%d%s)."),
1229 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1230 (readonly
) ? _(", read-only") : "");
1234 g_free(display_filename
);
1235 g_free(utf8_filename
);
1236 g_free(locale_filename
);
1238 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1239 pos
= set_cursor_position(doc
->editor
, pos
);
1240 /* now bring the file in front */
1241 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1243 /* finally, let the editor widget grab the focus so you can start coding
1245 g_idle_add(on_idle_focus
, doc
);
1250 /* Takes a new line separated list of filename URIs and opens each file.
1251 * length is the length of the string */
1252 void document_open_file_list(const gchar
*data
, gsize length
)
1258 g_return_if_fail(data
!= NULL
);
1260 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1262 /* stop at the end or first empty item, because last item is empty but not null */
1263 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1265 filename
= utils_get_path_from_uri(list
[i
]);
1266 if (filename
== NULL
)
1268 document_open_file(filename
, FALSE
, NULL
, NULL
);
1277 * Opens each file in the list @a filenames.
1278 * Internally, document_open_file() is called for every list item.
1280 * @param filenames A list of filenames to load, in locale encoding.
1281 * @param readonly Whether to open the document in read-only mode.
1282 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
1283 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1285 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1286 const gchar
*forced_enc
)
1290 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1292 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1298 * Reloads the document with the specified file encoding
1299 * @a forced_enc or @c NULL to auto-detect the file encoding.
1301 * @param doc The document to reload.
1302 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1304 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1306 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
)
1309 GeanyDocument
*new_doc
;
1311 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1313 /* try to set the cursor to the position before reloading */
1314 pos
= sci_get_current_position(doc
->editor
->sci
);
1315 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1317 return (new_doc
!= NULL
);
1321 static gboolean
document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1323 #ifndef USE_GIO_FILEMON
1326 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1328 /* stat the file to get the timestamp, otherwise on Windows the actual
1329 * timestamp can be ahead of time(NULL) */
1330 if (g_stat(locale_filename
, &st
) != 0)
1332 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"), doc
->file_name
,
1337 doc
->priv
->mtime
= st
.st_mtime
; /* get the modification time from file and keep it */
1343 /* Sets line and column to the given position byte_pos in the document.
1344 * byte_pos is the position counted in bytes, not characters */
1345 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1350 /* for some reason we can use byte count instead of character count here */
1351 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1352 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1353 /* get the column in the line */
1354 *column
= byte_pos
- line_start
;
1356 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1357 * skip one byte(i++) and decrease the column number which is based on byte count */
1358 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1360 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1369 static void replace_header_filename(GeanyDocument
*doc
)
1373 struct Sci_TextToFind ttf
;
1375 g_return_if_fail(doc
!= NULL
);
1376 g_return_if_fail(doc
->file_type
!= NULL
);
1378 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1379 if (doc
->file_type
->extension
)
1380 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1382 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1384 filename
= g_path_get_basename(doc
->file_name
);
1386 /* only search the first 3 lines */
1388 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1389 ttf
.lpstrText
= filebase
;
1391 if (search_find_text(doc
->editor
->sci
, SCFIND_MATCHCASE
| SCFIND_REGEXP
, &ttf
, NULL
) != -1)
1393 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1394 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1395 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1403 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1404 * you still have to call @ref document_save_file_as() to change the @a doc object.
1405 * It also stops monitoring for file changes to prevent receiving too many file change events
1406 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1408 * @param doc The current document which should be renamed.
1409 * @param new_filename The new filename in UTF-8 encoding.
1413 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1415 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1416 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1419 /* stop file monitoring to avoid getting events for deleting/creating files,
1420 * it's re-setup in document_save_file_as() */
1421 document_stop_file_monitoring(doc
);
1423 result
= g_rename(old_locale_filename
, new_locale_filename
);
1426 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1427 _("Error renaming file."), g_strerror(errno
));
1429 g_free(old_locale_filename
);
1430 g_free(new_locale_filename
);
1434 /* Return TRUE if the document doesn't have a full filename set.
1435 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1436 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1438 gboolean
document_need_save_as(GeanyDocument
*doc
)
1440 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1442 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1447 * Saves the document, detecting the filetype.
1449 * @param doc The document for the file to save.
1450 * @param utf8_fname The new name for the document, in UTF-8, or NULL.
1451 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1453 * @see document_save_file().
1457 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1461 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1463 if (utf8_fname
!= NULL
)
1464 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1466 /* reset real path, it's retrieved again in document_save() */
1467 SETPTR(doc
->real_path
, NULL
);
1469 /* detect filetype */
1470 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1472 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1474 document_set_filetype(doc
, ft
);
1475 if (document_get_current() == doc
)
1477 ignore_callback
= TRUE
;
1478 filetypes_select_radio_item(doc
->file_type
);
1479 ignore_callback
= FALSE
;
1482 replace_header_filename(doc
);
1484 ret
= document_save_file(doc
, TRUE
);
1486 /* file monitoring support, add file monitoring after the file has been saved
1487 * to ignore any earlier events */
1488 monitor_file_setup(doc
);
1489 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1492 ui_add_recent_document(doc
);
1497 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1499 GError
*conv_error
= NULL
;
1500 gchar
* conv_file_contents
= NULL
;
1504 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1505 g_return_val_if_fail(len
!= NULL
, FALSE
);
1507 /* try to convert it from UTF-8 to original encoding */
1508 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1509 &bytes_read
, &conv_len
, &conv_error
);
1511 if (conv_error
!= NULL
)
1513 gchar
*text
= g_strdup_printf(
1514 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1518 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1523 /* don't read over the doc length */
1524 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1525 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1526 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1528 /* take only one valid Unicode character from the context and discard the leftover */
1529 unic
= g_utf8_get_char_validated(context
, -1);
1530 context_len
= g_unichar_to_utf8(unic
, context
);
1531 context
[context_len
] = '\0';
1532 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1534 error_text
= g_strdup_printf(
1535 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1536 conv_error
->message
, context
, line
+ 1, column
);
1539 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1541 geany_debug("encoding error: %s", conv_error
->message
);
1542 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1543 g_error_free(conv_error
);
1551 *data
= conv_file_contents
;
1558 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1559 const gchar
*data
, gsize len
)
1561 GError
*error
= NULL
;
1563 if (file_prefs
.use_safe_file_saving
)
1565 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1566 * This is the only option that handles disk space exhaustion. */
1567 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1568 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1570 else if (file_prefs
.use_gio_unsafe_file_saving
)
1574 /* Use GIO API to save file (GVFS-safe)
1575 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1576 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1577 fp
= g_file_new_for_path(locale_filename
);
1578 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1579 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1586 gchar
*display_name
= g_filename_display_name(locale_filename
);
1588 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1589 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1591 fp
= g_fopen(locale_filename
, "wb");
1598 g_file_error_from_errno(save_errno
),
1599 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1601 g_strerror(save_errno
));
1605 gsize bytes_written
;
1608 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1610 if (len
!= bytes_written
)
1616 g_file_error_from_errno(save_errno
),
1617 _("Failed to write file '%s': fwrite() failed: %s"),
1619 g_strerror(save_errno
));
1623 /* preserve the fwrite() error if any */
1624 if (fclose(fp
) != 0 && error
== NULL
)
1630 g_file_error_from_errno(save_errno
),
1631 _("Failed to close file '%s': fclose() failed: %s"),
1633 g_strerror(save_errno
));
1637 g_free(display_name
);
1641 gchar
*msg
= g_strdup(error
->message
);
1642 g_error_free(error
);
1643 /* geany will warn about file truncation for unsafe saving below */
1650 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
1651 const gchar
*data
, gsize len
)
1655 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1656 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1658 err
= write_data_to_disk(locale_filename
, data
, len
);
1662 /* now the file is on disk, set real_path */
1663 if (doc
->real_path
== NULL
)
1665 doc
->real_path
= tm_get_real_path(locale_filename
);
1666 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1667 monitor_file_setup(doc
);
1674 * Saves the document.
1675 * Also shows the Save As dialog if necessary.
1676 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
1678 * Saving may include replacing tabs by spaces,
1679 * stripping trailing spaces and adding a final new line at the end of the file, depending
1680 * on user preferences. Then the @c "document-before-save" signal is emitted,
1681 * allowing plugins to modify the document before it is saved, and data is
1682 * actually written to disk.
1684 * On successful saving:
1685 * - GeanyDocument::real_path is set.
1686 * - The filetype is set again or auto-detected if it wasn't set yet.
1687 * - The @c "document-save" signal is emitted for plugins.
1689 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
1690 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
1691 * added in Geany 1.22.
1693 * @param doc The document to save.
1694 * @param force Whether to save the file even if it is not modified.
1696 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
1698 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
1703 gchar
*locale_filename
;
1704 const GeanyFilePrefs
*fp
;
1706 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1708 if (document_need_save_as(doc
))
1710 /* ensure doc is the current tab before showing the dialog */
1711 document_show_tab(doc
);
1712 return dialogs_show_save_as();
1715 /* the "changed" flag should exclude the "readonly" flag, but check it anyway for safety */
1716 if (! force
&& (! doc
->changed
|| doc
->readonly
))
1719 fp
= project_get_file_prefs();
1720 /* replaces tabs by spaces but only if the current file is not a Makefile */
1721 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
1722 editor_replace_tabs(doc
->editor
);
1723 /* strip trailing spaces */
1724 if (fp
->strip_trailing_spaces
)
1725 editor_strip_trailing_spaces(doc
->editor
);
1726 /* ensure the file has a newline at the end */
1727 if (fp
->final_new_line
)
1728 editor_ensure_final_newline(doc
->editor
);
1729 /* ensure newlines are consistent */
1730 if (fp
->ensure_convert_new_lines
)
1731 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
1733 /* notify plugins which may wish to modify the document before it's saved */
1734 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
1736 len
= sci_get_length(doc
->editor
->sci
) + 1;
1737 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
1738 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
1739 * encoding, it will be converted to doc->encoding below and this conversion
1740 * also changes the BOM */
1741 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
1742 data
[0] = (gchar
) 0xef;
1743 data
[1] = (gchar
) 0xbb;
1744 data
[2] = (gchar
) 0xbf;
1745 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
1750 data
= (gchar
*) g_malloc(len
);
1751 sci_get_text(doc
->editor
->sci
, len
, data
);
1754 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
1755 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
1756 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
1758 if (! save_convert_to_encoding(doc
, &data
, &len
))
1769 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1771 /* ignore file changed notification when the file is written */
1772 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1774 /* actually write the content of data to the file on disk */
1775 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
1780 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
1782 if (!file_prefs
.use_safe_file_saving
)
1785 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
1787 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
1788 doc
->priv
->file_disk_status
= FILE_OK
;
1790 g_free(locale_filename
);
1795 /* store the opened encoding for undo/redo */
1796 store_saved_encoding(doc
);
1798 /* ignore the following things if we are quitting */
1799 if (! main_status
.quitting
)
1801 sci_set_savepoint(doc
->editor
->sci
);
1803 if (file_prefs
.disk_check_timeout
> 0)
1804 document_update_timestamp(doc
, locale_filename
);
1806 /* update filetype-related things */
1807 document_set_filetype(doc
, doc
->file_type
);
1809 document_update_tab_label(doc
);
1811 msgwin_status_add(_("File %s saved."), doc
->file_name
);
1812 ui_update_statusbar(doc
, -1);
1814 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
1817 g_free(locale_filename
);
1819 g_signal_emit_by_name(geany_object
, "document-save", doc
);
1825 /* special search function, used from the find entry in the toolbar
1826 * return TRUE if text was found otherwise FALSE
1827 * return also TRUE if text is empty */
1828 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
1831 gint start_pos
, search_pos
;
1832 struct Sci_TextToFind ttf
;
1834 g_return_val_if_fail(text
!= NULL
, FALSE
);
1835 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1839 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
1840 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
1842 /* search cursor to end or start */
1843 ttf
.chrg
.cpMin
= start_pos
;
1844 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
1845 ttf
.lpstrText
= (gchar
*)text
;
1846 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1848 /* if no match, search start (or end) to cursor */
1849 if (search_pos
== -1)
1853 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
1854 ttf
.chrg
.cpMax
= start_pos
;
1859 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
1861 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1864 if (search_pos
!= -1)
1866 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1868 /* unfold maybe folded results */
1869 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
1871 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1872 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1874 if (! editor_line_in_view(doc
->editor
, line
))
1875 { /* we need to force scrolling in case the cursor is outside of the current visible area
1876 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
1877 * while searching */
1878 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
1881 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
1888 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
1891 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
1897 /* General search function, used from the find dialog.
1898 * Returns -1 on failure or the start position of the matching text.
1899 * Will skip past any selection, ignoring it.
1901 * @param text Text to find.
1902 * @param original_text Text as it was entered by user, or @c NULL to use @c text
1904 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
1905 gint flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
1906 gboolean scroll
, GtkWidget
*parent
)
1908 gint selection_end
, selection_start
, search_pos
;
1910 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
1914 /* Sci doesn't support searching backwards with a regex */
1915 if (flags
& SCFIND_REGEXP
)
1916 search_backwards
= FALSE
;
1919 original_text
= text
;
1921 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
1922 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
1923 if ((selection_end
- selection_start
) > 0)
1924 { /* there's a selection so go to the end */
1925 if (search_backwards
)
1926 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
1928 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
1931 sci_set_search_anchor(doc
->editor
->sci
);
1932 if (search_backwards
)
1933 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
1935 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
1937 if (search_pos
!= -1)
1939 /* unfold maybe folded results */
1940 sci_ensure_line_is_visible(doc
->editor
->sci
,
1941 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
1943 doc
->editor
->scroll_percent
= 0.3F
;
1947 gint sci_len
= sci_get_length(doc
->editor
->sci
);
1949 /* if we just searched the whole text, give up searching. */
1950 if ((selection_end
== 0 && ! search_backwards
) ||
1951 (selection_end
== sci_len
&& search_backwards
))
1953 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
1958 /* we searched only part of the document, so ask whether to wraparound. */
1959 if (search_prefs
.always_wrap
||
1960 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
1961 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
1965 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
1966 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
1968 { /* return to original cursor position if not found */
1969 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
1978 /* Replaces the selection if it matches, otherwise just finds the next match.
1979 * Returns: start of replaced text, or -1 if no replacement was made
1981 * @param find_text Text to find.
1982 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
1984 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
1985 const gchar
*replace_text
, gint flags
, gboolean search_backwards
)
1987 gint selection_end
, selection_start
, search_pos
;
1988 GeanyMatchInfo
*match
= NULL
;
1990 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
1995 /* Sci doesn't support searching backwards with a regex */
1996 if (flags
& SCFIND_REGEXP
)
1997 search_backwards
= FALSE
;
1999 if (!original_find_text
)
2000 original_find_text
= find_text
;
2002 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2003 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2004 if (selection_end
== selection_start
)
2006 /* no selection so just find the next match */
2007 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2010 /* there's a selection so go to the start before finding to search through it
2011 * this ensures there is a match */
2012 if (search_backwards
)
2013 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2015 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2017 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2018 /* return if the original selected text did not match (at the start of the selection) */
2019 if (search_pos
!= selection_start
)
2021 if (search_pos
!= -1)
2022 geany_match_info_free(match
);
2026 if (search_pos
!= -1)
2028 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2029 /* select the replacement - find text will skip past the selected text */
2030 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2031 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2032 geany_match_info_free(match
);
2036 /* no match in the selection */
2043 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2044 const gchar
*original_replace_text
)
2050 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2054 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2055 ui_set_statusbar(TRUE
, ngettext(
2056 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2057 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2058 count
), filename
, count
, original_find_text
, original_replace_text
);
2063 /* Replace all text matches in a certain range within document.
2064 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2065 * or -1 if no text was found.
2066 * scroll_to_match is whether to scroll the last replacement in view (which also
2067 * clears the selection).
2068 * Returns: the number of replacements made. */
2070 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2071 gint flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2074 struct Sci_TextToFind ttf
;
2075 ScintillaObject
*sci
;
2077 if (new_range_end
!= NULL
)
2078 *new_range_end
= -1;
2080 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2082 if (! *find_text
|| doc
->readonly
)
2085 sci
= doc
->editor
->sci
;
2087 ttf
.chrg
.cpMin
= start
;
2088 ttf
.chrg
.cpMax
= end
;
2089 ttf
.lpstrText
= (gchar
*)find_text
;
2091 sci_start_undo_action(sci
);
2092 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2093 sci_end_undo_action(sci
);
2096 { /* scroll last match in view, will destroy the existing selection */
2097 if (scroll_to_match
)
2098 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2100 if (new_range_end
!= NULL
)
2101 *new_range_end
= ttf
.chrg
.cpMax
;
2107 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2108 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2110 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2111 gint max_column
= 0, count
= 0;
2112 gboolean replaced
= FALSE
;
2114 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2119 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2120 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2121 /* do we have a selection? */
2122 if ((selection_end
- selection_start
) == 0)
2128 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2129 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2130 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2131 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2133 gint first_line
, line
;
2135 sci_start_undo_action(doc
->editor
->sci
);
2137 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2138 /* Find the last line with chars selected (not EOL char) */
2139 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2140 selection_end
- editor_get_eol_char_len(doc
->editor
));
2141 last_line
= MAX(first_line
, last_line
);
2142 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2144 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2145 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2147 /* skip line if there is no selection */
2148 if (line_start
!= INVALID_POSITION
)
2150 /* don't let document_replace_range() scroll to match to keep our selection */
2153 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2154 line_start
, line_end
, FALSE
, &new_sel_end
);
2155 if (new_sel_end
!= -1)
2158 /* this gets the greatest column within the selection after replacing */
2159 max_column
= MAX(max_column
,
2160 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2164 sci_end_undo_action(doc
->editor
->sci
);
2166 else /* handle normal line selection */
2168 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2169 selection_start
, selection_end
, TRUE
, &selection_end
);
2170 if (selection_end
!= -1)
2175 { /* update the selection for the new endpoint */
2177 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2179 /* now we can scroll to the selection and destroy it because we rebuild it later */
2180 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2182 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2183 * the highest column on the last line. The wrapped selection is completely different
2184 * from the original one, so skip the selection at all */
2185 /* TODO is there a better way to handle the wrapped selection? */
2186 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2187 { /* for keeping and adjusting the selection in multi line rectangle selection we
2188 * need the last line of the original selection and the greatest column number after
2189 * replacing and set the selection end to the last line at the greatest column */
2190 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2191 sci_set_selection_end(doc
->editor
->sci
,
2192 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2193 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2198 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2199 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2202 else /* no replacements */
2205 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2209 /* returns number of replacements made. */
2210 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2211 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2214 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2219 len
= sci_get_length(doc
->editor
->sci
);
2220 count
= document_replace_range(
2221 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2223 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2229 * Parses or re-parses the document's buffer and updates the type
2230 * keywords and symbol list.
2232 * @param doc The document.
2234 void document_update_tags(GeanyDocument
*doc
)
2239 g_return_if_fail(DOC_VALID(doc
));
2240 g_return_if_fail(app
->tm_workspace
!= NULL
);
2242 /* early out if it's a new file or doesn't support tags */
2243 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2245 /* We must call sidebar_update_tag_list() before returning,
2246 * to ensure that the symbol list is always updated properly (e.g.
2247 * when creating a new document with a partial filename set. */
2248 sidebar_update_tag_list(doc
, FALSE
);
2252 /* create a new TM file if there isn't one yet */
2255 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2258 /* lookup the name rather than using filetype name to support custom filetypes */
2259 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2260 doc
->tm_file
= tm_source_file_new(locale_filename
, FALSE
, name
);
2261 g_free(locale_filename
);
2263 if (doc
->tm_file
&& !tm_workspace_add_object(doc
->tm_file
))
2265 tm_work_object_free(doc
->tm_file
);
2266 doc
->tm_file
= NULL
;
2270 /* early out if there's no work object and we couldn't create one */
2271 if (doc
->tm_file
== NULL
)
2273 /* We must call sidebar_update_tag_list() before returning,
2274 * to ensure that the symbol list is always updated properly (e.g.
2275 * when creating a new document with a partial filename set. */
2276 sidebar_update_tag_list(doc
, FALSE
);
2280 len
= sci_get_length(doc
->editor
->sci
);
2281 /* tm_source_file_buffer_update() below don't support 0-length data,
2282 * so just empty the tags array and leave */
2285 tm_tags_array_free(doc
->tm_file
->tags_array
, FALSE
);
2286 sidebar_update_tag_list(doc
, FALSE
);
2290 /* Parse Scintilla's buffer directly using TagManager
2291 * Note: this buffer *MUST NOT* be modified */
2292 buffer_ptr
= (guchar
*) scintilla_send_message(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2293 tm_source_file_buffer_update(doc
->tm_file
, buffer_ptr
, len
, TRUE
);
2295 sidebar_update_tag_list(doc
, TRUE
);
2296 document_highlight_tags(doc
);
2300 /* Re-highlights type keywords without re-parsing the whole document. */
2301 void document_highlight_tags(GeanyDocument
*doc
)
2303 GString
*keywords_str
;
2307 /* some filetypes support type keywords (such as struct names), but not
2308 * necessarily all filetypes for a particular scintilla lexer. this
2309 * tells us whether the filetype supports keywords, and if so
2310 * which index to use for the scintilla keywords set. */
2311 switch (doc
->file_type
->id
)
2313 case GEANY_FILETYPES_C
:
2314 case GEANY_FILETYPES_CPP
:
2315 case GEANY_FILETYPES_CS
:
2316 case GEANY_FILETYPES_D
:
2317 case GEANY_FILETYPES_JAVA
:
2318 case GEANY_FILETYPES_OBJECTIVEC
:
2319 case GEANY_FILETYPES_VALA
:
2322 /* index of the keyword set in the Scintilla lexer, for
2323 * example in LexCPP.cxx, see "cppWordLists" global array.
2324 * TODO: this magic number should be a member of the filetype */
2329 return; /* early out if type keywords are not supported */
2331 if (!app
->tm_workspace
->work_object
.tags_array
)
2334 /* get any type keywords and tell scintilla about them
2335 * this will cause the type keywords to be colourized in scintilla */
2336 keywords_str
= symbols_find_tags_as_string(app
->tm_workspace
->work_object
.tags_array
,
2337 TM_GLOBAL_TYPE_MASK
, doc
->file_type
->lang
);
2340 keywords
= g_string_free(keywords_str
, FALSE
);
2341 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2343 queue_colourise(doc
); /* force re-highlighting the entire document */
2348 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2350 GeanyDocument
*doc
= data
;
2352 if (! DOC_VALID(doc
))
2355 if (! main_status
.quitting
)
2356 document_update_tags(doc
);
2358 doc
->priv
->tag_list_update_source
= 0;
2360 /* don't update the tags until another modification of the buffer */
2365 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2367 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2370 /* prevent "stacking up" callback handlers, we only need one to run soon */
2371 if (doc
->priv
->tag_list_update_source
!= 0)
2372 g_source_remove(doc
->priv
->tag_list_update_source
);
2374 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2375 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2379 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2380 gboolean filetype_changed
)
2382 g_return_if_fail(doc
);
2384 type
= filetypes
[GEANY_FILETYPES_NONE
];
2386 if (filetype_changed
)
2388 doc
->file_type
= type
;
2390 /* delete tm file object to force creation of a new one */
2391 if (doc
->tm_file
!= NULL
)
2393 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
2394 doc
->tm_file
= NULL
;
2396 /* load tags files before highlighting (some lexers highlight global typenames) */
2397 if (type
->id
!= GEANY_FILETYPES_NONE
)
2398 symbols_global_tags_loaded(type
->id
);
2400 highlighting_set_styles(doc
->editor
->sci
, type
);
2401 editor_set_indentation_guides(doc
->editor
);
2402 build_menu_update(doc
);
2403 queue_colourise(doc
);
2404 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2407 document_update_tags(doc
);
2411 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2412 * @param doc The document to use.
2413 * @param type The filetype. */
2414 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2416 gboolean ft_changed
;
2417 GeanyFiletype
*old_ft
;
2419 g_return_if_fail(doc
);
2421 type
= filetypes
[GEANY_FILETYPES_NONE
];
2423 old_ft
= doc
->file_type
;
2424 geany_debug("%s : %s (%s)",
2425 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2427 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2429 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2430 document_load_config(doc
, type
, ft_changed
);
2434 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2436 /* assume that if previous filetype was none and the settings are the default ones, this
2437 * is the first time the filetype is carefully set, so we should apply indent settings */
2438 if (old_ft
&& old_ft
->id
== GEANY_FILETYPES_NONE
&&
2439 doc
->editor
->indent_type
== iprefs
->type
&&
2440 doc
->editor
->indent_width
== iprefs
->width
)
2442 document_apply_indent_settings(doc
);
2443 ui_document_show_hide(doc
);
2446 sidebar_openfiles_update(doc
); /* to update the icon */
2447 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2452 void document_reload_config(GeanyDocument
*doc
)
2454 document_load_config(doc
, doc
->file_type
, TRUE
);
2459 * Sets the encoding of a document.
2460 * This function only set the encoding of the %document, it does not any conversions. The new
2461 * encoding is used when e.g. saving the file.
2463 * @param doc The document to use.
2464 * @param new_encoding The encoding to be set for the document.
2466 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2468 if (doc
== NULL
|| new_encoding
== NULL
||
2469 utils_str_equal(new_encoding
, doc
->encoding
))
2472 g_free(doc
->encoding
);
2473 doc
->encoding
= g_strdup(new_encoding
);
2475 ui_update_statusbar(doc
, -1);
2476 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2477 encodings_is_unicode_charset(doc
->encoding
));
2481 /* own Undo / Redo implementation to be able to undo / redo changes
2482 * to the encoding or the Unicode BOM (which are Scintilla independet).
2483 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2485 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2486 void document_undo_clear(GeanyDocument
*doc
)
2490 while (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0)
2492 a
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2493 if (G_LIKELY(a
!= NULL
))
2497 case UNDO_ENCODING
: g_free(a
->data
); break;
2503 doc
->priv
->undo_actions
= NULL
;
2505 while (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0)
2507 a
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2508 if (G_LIKELY(a
!= NULL
))
2512 case UNDO_ENCODING
: g_free(a
->data
); break;
2518 doc
->priv
->redo_actions
= NULL
;
2520 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2521 document_set_text_changed(doc
, FALSE
);
2525 /* note: this is called on SCN_MODIFIED notifications */
2526 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2528 undo_action
*action
;
2530 g_return_if_fail(doc
!= NULL
);
2532 action
= g_new0(undo_action
, 1);
2533 action
->type
= type
;
2534 action
->data
= data
;
2536 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2538 /* avoid unnecessary redraws */
2539 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2540 document_set_text_changed(doc
, TRUE
);
2542 ui_update_popup_reundo_items(doc
);
2546 gboolean
document_can_undo(GeanyDocument
*doc
)
2548 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2550 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2557 static void update_changed_state(GeanyDocument
*doc
)
2560 (sci_is_modified(doc
->editor
->sci
) ||
2561 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2562 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2563 document_set_text_changed(doc
, doc
->changed
);
2567 void document_undo(GeanyDocument
*doc
)
2569 undo_action
*action
;
2571 g_return_if_fail(doc
!= NULL
);
2573 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2575 if (G_UNLIKELY(action
== NULL
))
2577 /* fallback, should not be necessary */
2578 geany_debug("%s: fallback used", G_STRFUNC
);
2579 sci_undo(doc
->editor
->sci
);
2583 switch (action
->type
)
2585 case UNDO_SCINTILLA
:
2587 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
2589 sci_undo(doc
->editor
->sci
);
2594 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2596 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2597 ui_update_statusbar(doc
, -1);
2598 ui_document_show_hide(doc
);
2603 /* use the "old" encoding */
2604 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2606 document_set_encoding(doc
, (const gchar
*)action
->data
);
2608 ignore_callback
= TRUE
;
2609 encodings_select_radio_item((const gchar
*)action
->data
);
2610 ignore_callback
= FALSE
;
2612 g_free(action
->data
);
2618 g_free(action
); /* free the action which was taken from the stack */
2620 update_changed_state(doc
);
2621 ui_update_popup_reundo_items(doc
);
2625 gboolean
document_can_redo(GeanyDocument
*doc
)
2627 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2629 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
2636 void document_redo(GeanyDocument
*doc
)
2638 undo_action
*action
;
2640 g_return_if_fail(doc
!= NULL
);
2642 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2644 if (G_UNLIKELY(action
== NULL
))
2646 /* fallback, should not be necessary */
2647 geany_debug("%s: fallback used", G_STRFUNC
);
2648 sci_redo(doc
->editor
->sci
);
2652 switch (action
->type
)
2654 case UNDO_SCINTILLA
:
2656 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
2658 sci_redo(doc
->editor
->sci
);
2663 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2665 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2666 ui_update_statusbar(doc
, -1);
2667 ui_document_show_hide(doc
);
2672 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2674 document_set_encoding(doc
, (const gchar
*)action
->data
);
2676 ignore_callback
= TRUE
;
2677 encodings_select_radio_item((const gchar
*)action
->data
);
2678 ignore_callback
= FALSE
;
2680 g_free(action
->data
);
2686 g_free(action
); /* free the action which was taken from the stack */
2688 update_changed_state(doc
);
2689 ui_update_popup_reundo_items(doc
);
2693 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2695 undo_action
*action
;
2697 g_return_if_fail(doc
!= NULL
);
2699 action
= g_new0(undo_action
, 1);
2700 action
->type
= type
;
2701 action
->data
= data
;
2703 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
2705 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2706 document_set_text_changed(doc
, TRUE
);
2708 ui_update_popup_reundo_items(doc
);
2715 #ifdef USE_GIO_FILEMON
2716 STATUS_DISK_CHANGED
,
2725 } document_status_styles
[] = {
2726 { "geany-document-status-changed", {0}, FALSE
},
2727 #ifdef USE_GIO_FILEMON
2728 { "geany-document-status-disk-changed", {0}, FALSE
},
2730 { "geany-document-status-readonly", {0}, FALSE
}
2734 static gint
document_get_status_id(GeanyDocument
*doc
)
2737 return STATUS_CHANGED
;
2738 #ifdef USE_GIO_FILEMON
2739 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
2740 return STATUS_DISK_CHANGED
;
2742 else if (doc
->readonly
)
2743 return STATUS_READONLY
;
2749 /* returns an identifier that is to be set as a widget name or class to get it styled
2750 * depending on the document status (changed, readonly, etc.)
2751 * a NULL return value means default (unchanged) style */
2752 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
2756 g_return_val_if_fail(doc
!= NULL
, NULL
);
2758 status
= document_get_status_id(doc
);
2762 return document_status_styles
[status
].name
;
2767 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
2768 * Returned colors are red if the document has changes, green if the document is read-only
2769 * or simply @c NULL if the document is unmodified but writable.
2771 * @param doc The document to use.
2773 * @return The color for the document or @c NULL if the default color should be used. The color
2774 * object is owned by Geany and should not be modified or freed.
2778 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
2782 g_return_val_if_fail(doc
!= NULL
, NULL
);
2784 status
= document_get_status_id(doc
);
2787 if (! document_status_styles
[status
].loaded
)
2789 #if GTK_CHECK_VERSION(3, 0, 0)
2791 GtkWidgetPath
*path
= gtk_widget_path_new();
2792 GtkStyleContext
*ctx
= gtk_style_context_new();
2793 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
2794 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
2795 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
2796 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
2797 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
2798 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
2799 gtk_style_context_set_path(ctx
, path
);
2800 gtk_style_context_get_color(ctx
, GTK_STATE_NORMAL
, &color
);
2801 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
2802 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
2803 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
2804 document_status_styles
[status
].loaded
= TRUE
;
2805 gtk_widget_path_unref(path
);
2806 g_object_unref(ctx
);
2808 GtkSettings
*settings
= gtk_widget_get_settings(GTK_WIDGET(doc
->editor
->sci
));
2809 gchar
*path
= g_strconcat("GeanyMainWindow.GtkHBox.GtkNotebook.",
2810 document_status_styles
[status
].name
, NULL
);
2811 GtkStyle
*style
= gtk_rc_get_style_by_paths(settings
, path
, NULL
, GTK_TYPE_LABEL
);
2813 document_status_styles
[status
].color
= style
->fg
[GTK_STATE_NORMAL
];
2814 document_status_styles
[status
].loaded
= TRUE
;
2818 return &document_status_styles
[status
].color
;
2822 /** Accessor function for @ref GeanyData::documents_array items.
2823 * @warning Always check the returned document is valid (@c doc->is_valid).
2824 * @param idx @c documents_array index.
2825 * @return The document, or @c NULL if @a idx is out of range.
2829 GeanyDocument
*document_index(gint idx
)
2831 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
2835 /* create a new file and copy file content and properties */
2836 G_MODULE_EXPORT
void on_clone1_activate(GtkMenuItem
*menuitem
, gpointer user_data
)
2838 GeanyDocument
*old_doc
= document_get_current();
2841 document_clone(old_doc
);
2845 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
2849 ScintillaObject
*old_sci
;
2851 g_return_val_if_fail(old_doc
, NULL
);
2852 old_sci
= old_doc
->editor
->sci
;
2853 if (sci_has_selection(old_sci
))
2854 text
= sci_get_selection_contents(old_sci
);
2856 text
= sci_get_contents(old_sci
, -1);
2858 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
2860 document_set_text_changed(doc
, TRUE
);
2862 /* copy file properties */
2863 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
2864 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
2865 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
2866 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
2867 old_doc
->editor
->indent_width
);
2868 doc
->readonly
= old_doc
->readonly
;
2869 doc
->has_bom
= old_doc
->has_bom
;
2870 document_set_encoding(doc
, old_doc
->encoding
);
2871 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
2872 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
2875 ui_document_show_hide(doc
);
2880 /* @note If successful, this should always be followed up with a call to
2881 * document_close_all().
2882 * @return TRUE if all files were saved or had their changes discarded. */
2883 gboolean
document_account_for_unsaved(void)
2885 guint i
, p
, page_count
;
2887 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
2888 /* iterate over documents in tabs order */
2889 for (p
= 0; p
< page_count
; p
++)
2891 GeanyDocument
*doc
= document_get_from_page(p
);
2893 if (DOC_VALID(doc
) && doc
->changed
)
2895 if (! dialogs_show_unsaved_file(doc
))
2899 /* all documents should now be accounted for, so ignore any changes */
2900 foreach_document (i
)
2902 documents
[i
]->changed
= FALSE
;
2908 static void force_close_all(void)
2910 guint i
, len
= documents_array
->len
;
2912 /* check all documents have been accounted for */
2913 for (i
= 0; i
< len
; i
++)
2915 if (documents
[i
]->is_valid
)
2917 g_return_if_fail(!documents
[i
]->changed
);
2920 main_status
.closing_all
= TRUE
;
2924 document_close(documents
[i
]);
2927 main_status
.closing_all
= FALSE
;
2931 gboolean
document_close_all(void)
2933 if (! document_account_for_unsaved())
2942 static void monitor_reload_file(GeanyDocument
*doc
)
2944 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
2947 /* we use No instead of Cancel to avoid mnemonic clash */
2948 ret
= dialogs_show_prompt(NULL
,
2949 GTK_STOCK_CLOSE
, GTK_RESPONSE_CLOSE
,
2950 GTK_STOCK_NO
, GTK_RESPONSE_CANCEL
,
2951 _("_Reload"), GTK_RESPONSE_ACCEPT
,
2952 _("Do you want to reload it?"),
2953 _("The file '%s' on the disk is more recent than\nthe current buffer."),
2957 if (ret
== GTK_RESPONSE_ACCEPT
)
2958 document_reload_file(doc
, doc
->encoding
);
2959 else if (ret
== GTK_RESPONSE_CLOSE
)
2960 document_close(doc
);
2964 static gboolean
monitor_resave_missing_file(GeanyDocument
*doc
)
2966 gboolean want_reload
= FALSE
;
2967 gboolean file_saved
= FALSE
;
2970 ret
= dialogs_show_prompt(NULL
,
2971 _("Close _without saving"), GTK_RESPONSE_CLOSE
,
2972 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
2973 GTK_STOCK_SAVE
, GTK_RESPONSE_ACCEPT
,
2974 _("Try to resave the file?"),
2975 _("File \"%s\" was not found on disk!"),
2977 if (ret
== GTK_RESPONSE_ACCEPT
)
2979 file_saved
= dialogs_show_save_as();
2982 else if (ret
== GTK_RESPONSE_CLOSE
)
2984 document_close(doc
);
2986 if (ret
!= GTK_RESPONSE_CLOSE
&& ! file_saved
)
2988 /* file is missing - set unsaved state */
2989 document_set_text_changed(doc
, TRUE
);
2990 /* don't prompt more than once */
2991 SETPTR(doc
->real_path
, NULL
);
2998 /* Set force to force a disk check, otherwise it is ignored if there was a check
2999 * in the last file_prefs.disk_check_timeout seconds.
3000 * @return @c TRUE if the file has changed. */
3001 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3003 gboolean ret
= FALSE
;
3004 gboolean use_gio_filemon
;
3005 time_t cur_time
= 0;
3007 gchar
*locale_filename
;
3008 FileDiskStatus old_status
;
3010 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3012 /* ignore remote files and documents that have never been saved to disk */
3013 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3014 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3017 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3019 if (use_gio_filemon
)
3021 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3026 cur_time
= time(NULL
);
3027 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3030 doc
->priv
->last_check
= cur_time
;
3033 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3034 if (g_stat(locale_filename
, &st
) != 0)
3036 monitor_resave_missing_file(doc
);
3037 /* doc may be closed now */
3040 else if (! use_gio_filemon
&& /* ignore check when using GIO */
3041 doc
->priv
->mtime
> cur_time
)
3043 g_warning("%s: Something is wrong with the time stamps.", G_STRFUNC
);
3044 /* Note: on Windows st.st_mtime can be newer than cur_time */
3046 else if (doc
->priv
->mtime
< st
.st_mtime
)
3048 doc
->priv
->mtime
= st
.st_mtime
;
3049 monitor_reload_file(doc
);
3050 /* doc may be closed now */
3053 g_free(locale_filename
);
3056 { /* doc can get invalid when a document was closed */
3057 old_status
= doc
->priv
->file_disk_status
;
3058 doc
->priv
->file_disk_status
= FILE_OK
;
3059 if (old_status
!= doc
->priv
->file_disk_status
)
3060 ui_update_tab_status(doc
);
3066 /** Compares documents by their display names.
3067 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3068 * @note 'Display name' means the base name of the document's filename.
3070 * @param a @c GeanyDocument**.
3071 * @param b @c GeanyDocument**.
3072 * @warning The arguments take the address of each document pointer.
3073 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3077 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3079 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3080 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3081 gchar
*base_name_a
, *base_name_b
;
3084 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3085 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3087 result
= strcmp(base_name_a
, base_name_b
);
3089 g_free(base_name_a
);
3090 g_free(base_name_b
);
3096 /** Compares documents by their tab order.
3097 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3099 * @param a @c GeanyDocument**.
3100 * @param b @c GeanyDocument**.
3101 * @warning The arguments take the address of each document pointer.
3102 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3104 * @since 0.21 (GEANY_API_VERSION 209)
3106 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3108 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3109 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3110 gint notebook_position_doc_a
;
3111 gint notebook_position_doc_b
;
3113 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3114 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3116 if (notebook_position_doc_a
< notebook_position_doc_b
)
3118 if (notebook_position_doc_a
> notebook_position_doc_b
)
3125 /** Compares documents by their tab order, in reverse order.
3126 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3128 * @param a @c GeanyDocument**.
3129 * @param b @c GeanyDocument**.
3130 * @warning The arguments take the address of each document pointer.
3131 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3133 * @since 0.21 (GEANY_API_VERSION 209)
3135 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3137 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3138 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3139 gint notebook_position_doc_a
;
3140 gint notebook_position_doc_b
;
3142 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3143 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3145 if (notebook_position_doc_a
< notebook_position_doc_b
)
3147 if (notebook_position_doc_a
> notebook_position_doc_b
)
3154 void document_grab_focus(GeanyDocument
*doc
)
3156 g_return_if_fail(doc
!= NULL
);
3158 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));