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 "highlighting.h"
43 #include "msgwindow.h"
47 #include "sciwrappers.h"
55 #ifdef HAVE_SYS_TIME_H
56 # include <sys/time.h>
64 #ifdef HAVE_SYS_TYPES_H
65 # include <sys/types.h>
70 /* gstdio.h also includes sys/stat.h */
71 #include <glib/gstdio.h>
73 /* uncomment to use GIO based file monitoring, though it is not completely stable yet */
74 /*#define USE_GIO_FILEMON 1*/
78 GeanyFilePrefs file_prefs
;
81 /** Dynamic array of GeanyDocument pointers.
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 may represent a different
84 * document later on, or may have been closed and become invalid.
86 * @warning You must check @c GeanyDocument::is_valid when iterating over this array.
87 * This is done automatically if you use the foreach_document() macro.
90 * Never assume that the order of document pointers is the same as the order of notebook tabs.
91 * One reason is that notebook tabs can be reordered.
92 * Use @c document_get_from_page() to lookup a document from a notebook tab number.
95 GPtrArray
*documents_array
= NULL
;
98 /* an undo action, also used for redo actions */
101 GTrashStack
*next
; /* pointer to the next stack element(required for the GTrashStack) */
102 guint type
; /* to identify the action */
103 gpointer
*data
; /* the old value (before the change), in case of a redo action
104 * it contains the new value */
108 static void document_undo_clear(GeanyDocument
*doc
);
109 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
);
110 static gboolean
remove_page(guint page_num
);
114 * Finds a document whose @c real_path field matches the given filename.
116 * @param realname The filename to search, which should be identical to the
117 * string returned by @c tm_get_real_path().
119 * @return The matching document, or @c NULL.
120 * @note This is only really useful when passing a @c TMWorkObject::file_name.
121 * @see GeanyDocument::real_path.
122 * @see document_find_by_filename().
126 GeanyDocument
* document_find_by_real_path(const gchar
*realname
)
131 return NULL
; /* file doesn't exist on disk */
133 for (i
= 0; i
< documents_array
->len
; i
++)
135 GeanyDocument
*doc
= documents
[i
];
137 if (! doc
->is_valid
|| ! doc
->real_path
)
140 if (utils_filenamecmp(realname
, doc
->real_path
) == 0)
149 /* dereference symlinks, /../ junk in path and return locale encoding */
150 static gchar
*get_real_path_from_utf8(const gchar
*utf8_filename
)
152 gchar
*locale_name
= utils_get_locale_from_utf8(utf8_filename
);
153 gchar
*realname
= tm_get_real_path(locale_name
);
161 * Finds a document with the given filename.
162 * This matches either an exact GeanyDocument::file_name string, or variant
163 * filenames with relative elements in the path (e.g. @c "/dir/..//name" will
166 * @param utf8_filename The filename to search (in UTF-8 encoding).
168 * @return The matching document, or @c NULL.
169 * @see document_find_by_real_path().
171 GeanyDocument
*document_find_by_filename(const gchar
*utf8_filename
)
177 g_return_val_if_fail(utf8_filename
!= NULL
, NULL
);
179 /* First search GeanyDocument::file_name, so we can find documents with a
180 * filename set but not saved on disk, like vcdiff produces */
181 for (i
= 0; i
< documents_array
->len
; i
++)
185 if (! doc
->is_valid
|| doc
->file_name
== NULL
)
188 if (utils_filenamecmp(utf8_filename
, doc
->file_name
) == 0)
193 /* Now try matching based on the realpath(), which is unique per file on disk */
194 realname
= get_real_path_from_utf8(utf8_filename
);
195 doc
= document_find_by_real_path(realname
);
201 /* returns the document which has sci, or NULL. */
202 GeanyDocument
*document_find_by_sci(ScintillaObject
*sci
)
206 g_return_val_if_fail(sci
!= NULL
, NULL
);
208 for (i
= 0; i
< documents_array
->len
; i
++)
210 if (documents
[i
]->is_valid
&& documents
[i
]->editor
->sci
== sci
)
217 /** Gets the notebook page index for a document.
218 * @param doc The document.
221 gint
document_get_notebook_page(GeanyDocument
*doc
)
223 g_return_val_if_fail(doc
!= NULL
, -1);
225 return gtk_notebook_page_num(GTK_NOTEBOOK(main_widgets
.notebook
),
226 GTK_WIDGET(doc
->editor
->sci
));
231 * Finds the document for the given notebook page @a page_num.
233 * @param page_num The notebook page number to search.
235 * @return The corresponding document for the given notebook page, or @c NULL.
237 GeanyDocument
*document_get_from_page(guint page_num
)
239 ScintillaObject
*sci
;
241 if (page_num
>= documents_array
->len
)
244 sci
= (ScintillaObject
*)gtk_notebook_get_nth_page(
245 GTK_NOTEBOOK(main_widgets
.notebook
), page_num
);
247 return document_find_by_sci(sci
);
252 * Finds the current document.
254 * @return A pointer to the current document or @c NULL if there are no opened documents.
256 GeanyDocument
*document_get_current(void)
258 gint cur_page
= gtk_notebook_get_current_page(GTK_NOTEBOOK(main_widgets
.notebook
));
264 ScintillaObject
*sci
= (ScintillaObject
*)
265 gtk_notebook_get_nth_page(GTK_NOTEBOOK(main_widgets
.notebook
), cur_page
);
267 return document_find_by_sci(sci
);
272 void document_init_doclist(void)
274 documents_array
= g_ptr_array_new();
278 void document_finalize(void)
282 for (i
= 0; i
< documents_array
->len
; i
++)
283 g_free(documents
[i
]);
284 g_ptr_array_free(documents_array
, TRUE
);
289 * Returns the last part of the filename of the given GeanyDocument. The result is also
290 * truncated to a maximum of @a length characters in case the filename is very long.
292 * @param doc The document to use.
293 * @param length The length of the resulting string or -1 to use a default value.
295 * @return The ellipsized last part of the filename of @a doc, should be freed when no
300 /* TODO make more use of this */
301 gchar
*document_get_basename_for_display(GeanyDocument
*doc
, gint length
)
303 gchar
*base_name
, *short_name
;
305 g_return_val_if_fail(doc
!= NULL
, NULL
);
310 base_name
= g_path_get_basename(DOC_FILENAME(doc
));
311 short_name
= utils_str_middle_truncate(base_name
, (guint
)length
);
319 void document_update_tab_label(GeanyDocument
*doc
)
324 g_return_if_fail(doc
!= NULL
);
326 short_name
= document_get_basename_for_display(doc
, -1);
328 /* we need to use the event box for the tooltip, labels don't get the necessary events */
329 parent
= gtk_widget_get_parent(doc
->priv
->tab_label
);
330 parent
= gtk_widget_get_parent(parent
);
332 gtk_label_set_text(GTK_LABEL(doc
->priv
->tab_label
), short_name
);
334 gtk_widget_set_tooltip_text(parent
, DOC_FILENAME(doc
));
341 * Updates the tab labels, the status bar, the window title and some save-sensitive buttons
342 * according to the document's save state.
343 * This is called by Geany mostly when opening or saving files.
345 * @param doc The document to use.
346 * @param changed Whether the document state should indicate changes have been made.
348 void document_set_text_changed(GeanyDocument
*doc
, gboolean changed
)
350 g_return_if_fail(doc
!= NULL
);
352 doc
->changed
= changed
;
354 if (! main_status
.quitting
)
356 ui_update_tab_status(doc
);
357 ui_save_buttons_toggle(changed
);
358 ui_set_window_title(doc
);
359 ui_update_statusbar(doc
, -1);
364 /* returns the next free place in the document list,
365 * or -1 if the documents_array is full */
366 static gint
document_get_new_idx(void)
370 for (i
= 0; i
< documents_array
->len
; i
++)
372 if (documents
[i
]->editor
== NULL
)
381 static void queue_colourise(GeanyDocument
*doc
)
383 /* Colourise the editor before it is next drawn */
384 doc
->priv
->colourise_needed
= TRUE
;
386 /* If the editor doesn't need drawing (e.g. after saving the current
387 * document), we need to force a redraw, so the expose event is triggered.
388 * This ensures we don't start colourising before all documents are opened/saved,
389 * only once the editor is drawn. */
390 gtk_widget_queue_draw(GTK_WIDGET(doc
->editor
->sci
));
394 #ifdef USE_GIO_FILEMON
395 static void monitor_file_changed_cb(G_GNUC_UNUSED GFileMonitor
*monitor
, G_GNUC_UNUSED GFile
*file
,
396 G_GNUC_UNUSED GFile
*other_file
, GFileMonitorEvent event
,
399 g_return_if_fail(doc
!= NULL
);
401 if (file_prefs
.disk_check_timeout
== 0)
404 geany_debug("%s: event: %d previous file status: %d",
405 G_STRFUNC
, event
, doc
->priv
->file_disk_status
);
408 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT
:
410 if (doc
->priv
->file_disk_status
== FILE_IGNORE
)
411 doc
->priv
->file_disk_status
= FILE_OK
;
413 doc
->priv
->file_disk_status
= FILE_CHANGED
;
414 g_message("%s: FILE_CHANGED", G_STRFUNC
);
417 case G_FILE_MONITOR_EVENT_DELETED
:
419 doc
->priv
->file_disk_status
= FILE_CHANGED
;
420 g_message("%s: FILE_MISSING", G_STRFUNC
);
426 if (doc
->priv
->file_disk_status
!= FILE_OK
)
428 ui_update_tab_status(doc
);
434 static void document_stop_file_monitoring(GeanyDocument
*doc
)
436 g_return_if_fail(doc
!= NULL
);
438 if (doc
->priv
->monitor
!= NULL
)
440 g_object_unref(doc
->priv
->monitor
);
441 doc
->priv
->monitor
= NULL
;
446 static void monitor_file_setup(GeanyDocument
*doc
)
448 g_return_if_fail(doc
!= NULL
);
449 /* Disable file monitoring completely for remote files (i.e. remote GIO files) as GFileMonitor
450 * doesn't work at all for remote files and legacy polling is too slow. */
451 if (! doc
->priv
->is_remote
)
453 #ifdef USE_GIO_FILEMON
454 gchar
*locale_filename
;
456 /* stop any previous monitoring */
457 document_stop_file_monitoring(doc
);
459 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
460 if (locale_filename
!= NULL
&& g_file_test(locale_filename
, G_FILE_TEST_EXISTS
))
462 /* get a file monitor and connect to the 'changed' signal */
463 GFile
*file
= g_file_new_for_path(locale_filename
);
464 doc
->priv
->monitor
= g_file_monitor_file(file
, G_FILE_MONITOR_NONE
, NULL
, NULL
);
465 g_signal_connect(doc
->priv
->monitor
, "changed",
466 G_CALLBACK(monitor_file_changed_cb
), doc
);
468 /* we set the rate limit according to the GUI pref but it's most probably not used */
469 g_file_monitor_set_rate_limit(doc
->priv
->monitor
, file_prefs
.disk_check_timeout
* 1000);
471 g_object_unref(file
);
473 g_free(locale_filename
);
476 doc
->priv
->file_disk_status
= FILE_OK
;
480 void document_try_focus(GeanyDocument
*doc
, GtkWidget
*source_widget
)
482 /* doc might not be valid e.g. if user closed a tab whilst Geany is opening files */
485 GtkWidget
*sci
= GTK_WIDGET(doc
->editor
->sci
);
486 GtkWidget
*focusw
= gtk_window_get_focus(GTK_WINDOW(main_widgets
.window
));
488 if (source_widget
== NULL
)
489 source_widget
= doc
->priv
->tag_tree
;
491 if (focusw
== source_widget
)
492 gtk_widget_grab_focus(sci
);
497 static gboolean
on_idle_focus(gpointer doc
)
499 document_try_focus(doc
, NULL
);
504 /* Creates a new document and editor, adding a tab in the notebook.
505 * @return The created document */
506 static GeanyDocument
*document_create(const gchar
*utf8_filename
)
510 gint cur_pages
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
514 doc
= document_get_current();
515 /* remove the empty document first */
516 if (doc
!= NULL
&& doc
->file_name
== NULL
&& ! doc
->changed
)
517 /* prevent immediately opening another new doc with
518 * new_document_after_close pref */
522 new_idx
= document_get_new_idx();
523 if (new_idx
== -1) /* expand the array, no free places */
525 doc
= g_new0(GeanyDocument
, 1);
527 new_idx
= documents_array
->len
;
528 g_ptr_array_add(documents_array
, doc
);
531 doc
= documents
[new_idx
];
533 /* initialize default document settings */
534 doc
->priv
= g_new0(GeanyDocumentPrivate
, 1);
535 doc
->index
= new_idx
;
536 doc
->file_name
= g_strdup(utf8_filename
);
537 doc
->editor
= editor_create(doc
);
538 #ifndef USE_GIO_FILEMON
539 doc
->priv
->last_check
= time(NULL
);
542 sidebar_openfiles_add(doc
); /* sets doc->iter */
544 notebook_new_tab(doc
);
546 /* select document in sidebar */
548 GtkTreeSelection
*sel
;
550 sel
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tv
.tree_openfiles
));
551 gtk_tree_selection_select_iter(sel
, &doc
->priv
->iter
);
554 ui_document_buttons_update();
556 doc
->is_valid
= TRUE
; /* do this last to prevent UI updating with NULL items. */
562 * Closes the given document.
564 * @param doc The document to remove.
566 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
570 gboolean
document_close(GeanyDocument
*doc
)
572 g_return_val_if_fail(doc
, FALSE
);
574 return document_remove_page(document_get_notebook_page(doc
));
578 /* Call document_remove_page() instead, this is only needed for document_create()
579 * to prevent re-opening a new document when the last document is closed (if enabled). */
580 static gboolean
remove_page(guint page_num
)
582 GeanyDocument
*doc
= document_get_from_page(page_num
);
584 g_return_val_if_fail(doc
!= NULL
, FALSE
);
586 if (doc
->changed
&& ! dialogs_show_unsaved_file(doc
))
589 /* tell any plugins that the document is about to be closed */
590 g_signal_emit_by_name(geany_object
, "document-close", doc
);
592 /* Checking real_path makes it likely the file exists on disk */
593 if (! main_status
.closing_all
&& doc
->real_path
!= NULL
)
594 ui_add_recent_document(doc
);
596 doc
->is_valid
= FALSE
;
598 if (main_status
.quitting
)
600 /* we need to destroy the ScintillaWidget so our handlers on it are
601 * disconnected before we free any data they may use (like the editor).
602 * when not quitting, this is handled by removing the notebook page. */
603 gtk_widget_destroy(GTK_WIDGET(doc
->editor
->sci
));
607 notebook_remove_page(page_num
);
608 sidebar_remove_document(doc
);
609 navqueue_remove_file(doc
->file_name
);
610 msgwin_status_add(_("File %s closed."), DOC_FILENAME(doc
));
612 g_free(doc
->encoding
);
613 g_free(doc
->priv
->saved_encoding
.encoding
);
614 g_free(doc
->file_name
);
615 g_free(doc
->real_path
);
616 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
618 if (doc
->priv
->tag_tree
)
619 gtk_widget_destroy(doc
->priv
->tag_tree
);
621 editor_destroy(doc
->editor
);
622 doc
->editor
= NULL
; /* needs to be NULL for document_undo_clear() call below */
624 document_stop_file_monitoring(doc
);
626 document_undo_clear(doc
);
630 /* reset document settings to defaults for re-use */
631 memset(doc
, 0, sizeof(GeanyDocument
));
633 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
635 sidebar_update_tag_list(NULL
, FALSE
);
636 ui_set_window_title(NULL
);
637 ui_save_buttons_toggle(FALSE
);
638 ui_update_popup_reundo_items(NULL
);
639 ui_document_buttons_update();
640 build_menu_update(NULL
);
647 * Removes the given notebook tab at @a page_num and clears all related information
648 * in the document list.
650 * @param page_num The notebook page number to remove.
652 * @return @c TRUE if the document was actually removed or @c FALSE otherwise.
654 gboolean
document_remove_page(guint page_num
)
656 gboolean done
= remove_page(page_num
);
658 if (done
&& ui_prefs
.new_document_after_close
)
659 document_new_file_if_non_open();
665 /* used to keep a record of the unchanged document state encoding */
666 static void store_saved_encoding(GeanyDocument
*doc
)
668 g_free(doc
->priv
->saved_encoding
.encoding
);
669 doc
->priv
->saved_encoding
.encoding
= g_strdup(doc
->encoding
);
670 doc
->priv
->saved_encoding
.has_bom
= doc
->has_bom
;
674 /* Opens a new empty document only if there are no other documents open */
675 GeanyDocument
*document_new_file_if_non_open(void)
677 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)) == 0)
678 return document_new_file(NULL
, NULL
, NULL
);
685 * Creates a new document.
686 * Line endings in @a text will be converted to the default setting.
687 * Afterwards, the @c "document-new" signal is emitted for plugins.
689 * @param utf8_filename The file name in UTF-8 encoding, or @c NULL to open a file as "untitled".
690 * @param ft The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
691 * @param text The initial content of the file (in UTF-8 encoding), or @c NULL.
693 * @return The new document.
695 GeanyDocument
*document_new_file(const gchar
*utf8_filename
, GeanyFiletype
*ft
, const gchar
*text
)
699 if (utf8_filename
&& g_path_is_absolute(utf8_filename
))
702 tmp
= utils_strdupa(utf8_filename
); /* work around const */
703 utils_tidy_path(tmp
);
706 doc
= document_create(utf8_filename
);
708 g_assert(doc
!= NULL
);
710 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
713 GString
*template = g_string_new(text
);
714 utils_ensure_same_eol_characters(template, file_prefs
.default_eol_character
);
716 sci_set_text(doc
->editor
->sci
, template->str
);
717 g_string_free(template, TRUE
);
720 sci_clear_all(doc
->editor
->sci
);
722 sci_set_eol_mode(doc
->editor
->sci
, file_prefs
.default_eol_character
);
724 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
725 sci_empty_undo_buffer(doc
->editor
->sci
);
727 doc
->encoding
= g_strdup(encodings
[file_prefs
.default_new_encoding
].charset
);
728 /* store the opened encoding for undo/redo */
729 store_saved_encoding(doc
);
731 if (ft
== NULL
&& utf8_filename
!= NULL
) /* guess the filetype from the filename if one is given */
732 ft
= filetypes_detect_from_document(doc
);
734 document_set_filetype(doc
, ft
); /* also re-parses tags */
736 ui_set_window_title(doc
);
737 build_menu_update(doc
);
738 document_set_text_changed(doc
, FALSE
);
739 ui_document_show_hide(doc
); /* update the document menu */
741 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
742 /* bring it in front, jump to the start and grab the focus */
743 editor_goto_pos(doc
->editor
, 0, FALSE
);
744 document_try_focus(doc
, NULL
);
746 #ifdef USE_GIO_FILEMON
747 monitor_file_setup(doc
);
749 doc
->priv
->mtime
= time(NULL
);
752 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
753 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
), doc
->editor
);
755 g_signal_emit_by_name(geany_object
, "document-new", doc
);
757 msgwin_status_add(_("New file \"%s\" opened."),
765 * Opens a document specified by @a locale_filename.
766 * Afterwards, the @c "document-open" signal is emitted for plugins.
768 * @param locale_filename The filename of the document to load, in locale encoding.
769 * @param readonly Whether to open the document in read-only mode.
770 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
771 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
773 * @return The document opened or @c NULL.
775 GeanyDocument
*document_open_file(const gchar
*locale_filename
, gboolean readonly
,
776 GeanyFiletype
*ft
, const gchar
*forced_enc
)
778 return document_open_file_full(NULL
, locale_filename
, 0, readonly
, ft
, forced_enc
);
784 gchar
*data
; /* null-terminated file data */
785 gsize len
; /* string length of data */
788 time_t mtime
; /* modification time, read by stat::st_mtime */
793 /* loads textfile data, verifies and converts to forced_enc or UTF-8. Also handles BOM. */
794 static gboolean
load_text_file(const gchar
*locale_filename
, const gchar
*display_filename
,
795 FileData
*filedata
, const gchar
*forced_enc
)
800 filedata
->data
= NULL
;
802 filedata
->enc
= NULL
;
803 filedata
->bom
= FALSE
;
804 filedata
->readonly
= FALSE
;
806 if (g_stat(locale_filename
, &st
) != 0)
808 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"),
809 display_filename
, g_strerror(errno
));
813 filedata
->mtime
= st
.st_mtime
;
815 if (! g_file_get_contents(locale_filename
, &filedata
->data
, NULL
, &err
))
817 ui_set_statusbar(TRUE
, "%s", err
->message
);
822 filedata
->len
= (gsize
) st
.st_size
;
823 if (! encodings_convert_to_utf8_auto(&filedata
->data
, &filedata
->len
, forced_enc
,
824 &filedata
->enc
, &filedata
->bom
, &filedata
->readonly
))
828 ui_set_statusbar(TRUE
, _("The file \"%s\" is not valid %s."),
829 display_filename
, forced_enc
);
833 ui_set_statusbar(TRUE
,
834 _("The file \"%s\" does not look like a text file or the file encoding is not supported."),
837 g_free(filedata
->data
);
841 if (filedata
->readonly
)
843 const gchar
*warn_msg
= _(
844 "The file \"%s\" could not be opened properly and has been truncated. " \
845 "This can occur if the file contains a NULL byte. " \
846 "Be aware that saving it can cause data loss.\nThe file was set to read-only.");
848 if (main_status
.main_window_realized
)
849 dialogs_show_msgbox(GTK_MESSAGE_WARNING
, warn_msg
, display_filename
);
851 ui_set_statusbar(TRUE
, warn_msg
, display_filename
);
858 /* Sets the cursor position on opening a file. First it sets the line when cl_options.goto_line
859 * is set, otherwise it sets the line when pos is greater than zero and finally it sets the column
860 * if cl_options.goto_column is set.
862 * returns the new position which may have changed */
863 static gint
set_cursor_position(GeanyEditor
*editor
, gint pos
)
865 if (cl_options
.goto_line
>= 0)
866 { /* goto line which was specified on command line and then undefine the line */
867 sci_goto_line(editor
->sci
, cl_options
.goto_line
- 1, TRUE
);
868 editor
->scroll_percent
= 0.5F
;
869 cl_options
.goto_line
= -1;
873 sci_set_current_position(editor
->sci
, pos
, FALSE
);
874 editor
->scroll_percent
= 0.5F
;
877 if (cl_options
.goto_column
>= 0)
878 { /* goto column which was specified on command line and then undefine the column */
880 gint new_pos
= sci_get_current_position(editor
->sci
) + cl_options
.goto_column
;
881 sci_set_current_position(editor
->sci
, new_pos
, FALSE
);
882 editor
->scroll_percent
= 0.5F
;
883 cl_options
.goto_column
= -1;
886 return sci_get_current_position(editor
->sci
);
890 /* Count lines that start with some hard tabs then a soft tab. */
891 static gboolean
detect_tabs_and_spaces(GeanyEditor
*editor
)
893 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
894 ScintillaObject
*sci
= editor
->sci
;
896 struct Sci_TextToFind ttf
;
897 gchar
*soft_tab
= g_strnfill((gsize
)iprefs
->width
, ' ');
898 gchar
*regex
= g_strconcat("^\t+", soft_tab
, "[^ ]", NULL
);
903 ttf
.chrg
.cpMax
= sci_get_length(sci
);
904 ttf
.lpstrText
= regex
;
909 pos
= sci_find_text(sci
, SCFIND_REGEXP
, &ttf
);
911 break; /* no more matches */
913 ttf
.chrg
.cpMin
= ttf
.chrgText
.cpMax
+ 1; /* search after this match */
916 /* The 0.02 is a low weighting to ignore a few possibly accidental occurrences */
917 return count
> sci_get_line_count(sci
) * 0.02;
921 /* Detect the indent type based on counting the leading indent characters for each line.
922 * Returns whether detection succeeded, and the detected type in *type_ upon success */
923 gboolean
document_detect_indent_type(GeanyDocument
*doc
, GeanyIndentType
*type_
)
925 GeanyEditor
*editor
= doc
->editor
;
926 ScintillaObject
*sci
= editor
->sci
;
927 gint line
, line_count
;
928 gsize tabs
= 0, spaces
= 0;
930 if (detect_tabs_and_spaces(editor
))
932 *type_
= GEANY_INDENT_TYPE_BOTH
;
936 line_count
= sci_get_line_count(sci
);
937 for (line
= 0; line
< line_count
; line
++)
939 gint pos
= sci_get_position_from_line(sci
, line
);
942 /* most code will have indent total <= 24, otherwise it's more likely to be
943 * alignment than indentation */
944 if (sci_get_line_indentation(sci
, line
) > 24)
947 c
= sci_get_char_at(sci
, pos
);
950 /* check for at least 2 spaces */
951 else if (c
== ' ' && sci_get_char_at(sci
, pos
+ 1) == ' ')
954 if (spaces
== 0 && tabs
== 0)
957 /* the factors may need to be tweaked */
958 if (spaces
> tabs
* 4)
959 *type_
= GEANY_INDENT_TYPE_SPACES
;
960 else if (tabs
> spaces
* 4)
961 *type_
= GEANY_INDENT_TYPE_TABS
;
963 *type_
= GEANY_INDENT_TYPE_BOTH
;
969 /* Detect the indent width based on counting the leading indent characters for each line.
970 * Returns whether detection succeeded, and the detected width in *width_ upon success */
971 static gboolean
detect_indent_width(GeanyEditor
*editor
, GeanyIndentType type
, gint
*width_
)
973 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
974 ScintillaObject
*sci
= editor
->sci
;
975 gint line
, line_count
;
976 gint widths
[7] = { 0 }; /* width can be from 2 to 8 */
977 gint count
, width
, i
;
979 /* can't easily detect the supposed width of a tab, guess the default is OK */
980 if (type
== GEANY_INDENT_TYPE_TABS
)
983 /* force 8 at detection time for tab & spaces -- anyway we don't use tabs at this point */
984 sci_set_tab_width(sci
, 8);
986 line_count
= sci_get_line_count(sci
);
987 for (line
= 0; line
< line_count
; line
++)
989 gint pos
= sci_get_line_indent_position(sci
, line
);
991 /* We probably don't have style info yet, because we're generally called just after
992 * the document got created, so we can't use highlighting_is_code_style().
993 * That's not good, but the assumption below that concerning lines start with an
994 * asterisk (common continuation character for C/C++/Java/...) should do the trick
995 * without removing too much legitimate lines. */
996 if (sci_get_char_at(sci
, pos
) == '*')
999 width
= sci_get_line_indentation(sci
, line
);
1000 /* most code will have indent total <= 24, otherwise it's more likely to be
1001 * alignment than indentation */
1004 /* < 2 is no indentation */
1008 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1010 if ((width
% (i
+ 2)) == 0)
1015 width
= iprefs
->width
;
1016 for (i
= G_N_ELEMENTS(widths
) - 1; i
>= 0; i
--)
1018 /* give large indents higher weight not to be fooled by spurious indents */
1019 if (widths
[i
] >= count
* 1.5)
1034 /* same as detect_indent_width() but uses editor's indent type */
1035 gboolean
document_detect_indent_width(GeanyDocument
*doc
, gint
*width_
)
1037 return detect_indent_width(doc
->editor
, doc
->editor
->indent_type
, width_
);
1041 void document_apply_indent_settings(GeanyDocument
*doc
)
1043 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
1044 GeanyIndentType type
= iprefs
->type
;
1045 gint width
= iprefs
->width
;
1047 if (iprefs
->detect_type
&& document_detect_indent_type(doc
, &type
))
1049 if (type
!= iprefs
->type
)
1051 const gchar
*name
= NULL
;
1055 case GEANY_INDENT_TYPE_SPACES
:
1058 case GEANY_INDENT_TYPE_TABS
:
1061 case GEANY_INDENT_TYPE_BOTH
:
1062 name
= _("Tabs and Spaces");
1065 /* For translators: first wildcard is the indentation mode (Spaces, Tabs, Tabs
1066 * and Spaces), the second one is the filename */
1067 ui_set_statusbar(TRUE
, _("Setting %s indentation mode for %s."), name
,
1071 else if (doc
->file_type
->indent_type
> -1)
1072 type
= doc
->file_type
->indent_type
;
1074 if (iprefs
->detect_width
&& detect_indent_width(doc
->editor
, type
, &width
))
1076 if (width
!= iprefs
->width
)
1078 ui_set_statusbar(TRUE
, _("Setting indentation width to %d for %s."), width
,
1082 else if (doc
->file_type
->indent_width
> -1)
1083 width
= doc
->file_type
->indent_width
;
1085 editor_set_indent(doc
->editor
, type
, width
);
1089 void document_show_tab(GeanyDocument
*doc
)
1091 gtk_notebook_set_current_page(GTK_NOTEBOOK(main_widgets
.notebook
),
1092 document_get_notebook_page(doc
));
1096 /* To open a new file, set doc to NULL; filename should be locale encoded.
1097 * To reload a file, set the doc for the document to be reloaded; filename should be NULL.
1098 * pos is the cursor position, which can be overridden by --line and --column.
1099 * forced_enc can be NULL to detect the file encoding.
1100 * Returns: doc of the opened file or NULL if an error occurred. */
1101 GeanyDocument
*document_open_file_full(GeanyDocument
*doc
, const gchar
*filename
, gint pos
,
1102 gboolean readonly
, GeanyFiletype
*ft
, const gchar
*forced_enc
)
1105 gboolean reload
= (doc
== NULL
) ? FALSE
: TRUE
;
1106 gchar
*utf8_filename
= NULL
;
1107 gchar
*display_filename
= NULL
;
1108 gchar
*locale_filename
= NULL
;
1109 GeanyFiletype
*use_ft
;
1112 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, NULL
);
1116 utf8_filename
= g_strdup(doc
->file_name
);
1117 locale_filename
= utils_get_locale_from_utf8(utf8_filename
);
1121 /* filename must not be NULL when opening a file */
1122 g_return_val_if_fail(filename
, NULL
);
1125 /* if filename is a shortcut, try to resolve it */
1126 locale_filename
= win32_get_shortcut_target(filename
);
1128 locale_filename
= g_strdup(filename
);
1130 /* remove relative junk */
1131 utils_tidy_path(locale_filename
);
1133 /* try to get the UTF-8 equivalent for the filename, fallback to filename if error */
1134 utf8_filename
= utils_get_utf8_from_locale(locale_filename
);
1136 /* if file is already open, switch to it and go */
1137 doc
= document_find_by_filename(utf8_filename
);
1140 ui_add_recent_document(doc
); /* either add or reorder recent item */
1141 /* show the doc before reload dialog */
1142 document_show_tab(doc
);
1143 document_check_disk_status(doc
, TRUE
); /* force a file changed check */
1146 if (reload
|| doc
== NULL
)
1147 { /* doc possibly changed */
1148 display_filename
= utils_str_middle_truncate(utf8_filename
, 100);
1150 if (! load_text_file(locale_filename
, display_filename
, &filedata
, forced_enc
))
1152 g_free(display_filename
);
1153 g_free(utf8_filename
);
1154 g_free(locale_filename
);
1160 doc
= document_create(utf8_filename
);
1161 g_return_val_if_fail(doc
!= NULL
, NULL
); /* really should not happen */
1163 /* file exists on disk, set real_path */
1164 SETPTR(doc
->real_path
, tm_get_real_path(locale_filename
));
1166 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1167 monitor_file_setup(doc
);
1170 sci_set_undo_collection(doc
->editor
->sci
, FALSE
); /* avoid creation of an undo action */
1171 sci_empty_undo_buffer(doc
->editor
->sci
);
1173 /* add the text to the ScintillaObject */
1174 sci_set_readonly(doc
->editor
->sci
, FALSE
); /* to allow replacing text */
1175 sci_set_text(doc
->editor
->sci
, filedata
.data
); /* NULL terminated data */
1176 queue_colourise(doc
); /* Ensure the document gets colourised. */
1178 /* detect & set line endings */
1179 editor_mode
= utils_get_line_endings(filedata
.data
, filedata
.len
);
1180 sci_set_eol_mode(doc
->editor
->sci
, editor_mode
);
1181 g_free(filedata
.data
);
1183 sci_set_undo_collection(doc
->editor
->sci
, TRUE
);
1185 doc
->priv
->mtime
= filedata
.mtime
; /* get the modification time from file and keep it */
1186 g_free(doc
->encoding
); /* if reloading, free old encoding */
1187 doc
->encoding
= filedata
.enc
;
1188 doc
->has_bom
= filedata
.bom
;
1189 store_saved_encoding(doc
); /* store the opened encoding for undo/redo */
1191 doc
->readonly
= readonly
|| filedata
.readonly
;
1192 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
1194 /* update line number margin width */
1195 doc
->priv
->line_count
= sci_get_line_count(doc
->editor
->sci
);
1196 sci_set_line_numbers(doc
->editor
->sci
, editor_prefs
.show_linenumber_margin
, 0);
1201 /* "the" SCI signal (connect after initial setup(i.e. adding text)) */
1202 g_signal_connect(doc
->editor
->sci
, "sci-notify", G_CALLBACK(editor_sci_notify_cb
),
1205 use_ft
= (ft
!= NULL
) ? ft
: filetypes_detect_from_document(doc
);
1209 document_undo_clear(doc
);
1213 /* update taglist, typedef keywords and build menu if necessary */
1214 document_set_filetype(doc
, use_ft
);
1216 /* set indentation settings after setting the filetype */
1218 editor_set_indent(doc
->editor
, doc
->editor
->indent_type
, doc
->editor
->indent_width
); /* resetup sci */
1220 document_apply_indent_settings(doc
);
1222 document_set_text_changed(doc
, FALSE
); /* also updates tab state */
1223 ui_document_show_hide(doc
); /* update the document menu */
1225 /* finally add current file to recent files menu, but not the files from the last session */
1226 if (! main_status
.opening_session_files
)
1227 ui_add_recent_document(doc
);
1231 g_signal_emit_by_name(geany_object
, "document-reload", doc
);
1232 ui_set_statusbar(TRUE
, _("File %s reloaded."), display_filename
);
1236 g_signal_emit_by_name(geany_object
, "document-open", doc
);
1237 /* For translators: this is the status window message for opening a file. %d is the number
1238 * of the newly opened file, %s indicates whether the file is opened read-only
1239 * (it is replaced with the string ", read-only"). */
1240 msgwin_status_add(_("File %s opened(%d%s)."),
1241 display_filename
, gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
)),
1242 (readonly
) ? _(", read-only") : "");
1246 g_free(display_filename
);
1247 g_free(utf8_filename
);
1248 g_free(locale_filename
);
1250 /* set the cursor position according to pos, cl_options.goto_line and cl_options.goto_column */
1251 pos
= set_cursor_position(doc
->editor
, pos
);
1252 /* now bring the file in front */
1253 editor_goto_pos(doc
->editor
, pos
, FALSE
);
1255 /* finally, let the editor widget grab the focus so you can start coding
1257 g_idle_add(on_idle_focus
, doc
);
1262 /* Takes a new line separated list of filename URIs and opens each file.
1263 * length is the length of the string */
1264 void document_open_file_list(const gchar
*data
, gsize length
)
1270 g_return_if_fail(data
!= NULL
);
1272 list
= g_strsplit(data
, utils_get_eol_char(utils_get_line_endings(data
, length
)), 0);
1274 /* stop at the end or first empty item, because last item is empty but not null */
1275 for (i
= 0; list
[i
] != NULL
&& list
[i
][0] != '\0'; i
++)
1277 filename
= utils_get_path_from_uri(list
[i
]);
1278 if (filename
== NULL
)
1280 document_open_file(filename
, FALSE
, NULL
, NULL
);
1289 * Opens each file in the list @a filenames.
1290 * Internally, document_open_file() is called for every list item.
1292 * @param filenames A list of filenames to load, in locale encoding.
1293 * @param readonly Whether to open the document in read-only mode.
1294 * @param ft The filetype for the document or @c NULL to auto-detect the filetype.
1295 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1297 void document_open_files(const GSList
*filenames
, gboolean readonly
, GeanyFiletype
*ft
,
1298 const gchar
*forced_enc
)
1302 for (item
= filenames
; item
!= NULL
; item
= g_slist_next(item
))
1304 document_open_file(item
->data
, readonly
, ft
, forced_enc
);
1310 * Reloads the document with the specified file encoding
1311 * @a forced_enc or @c NULL to auto-detect the file encoding.
1313 * @param doc The document to reload.
1314 * @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
1316 * @return @c TRUE if the document was actually reloaded or @c FALSE otherwise.
1318 gboolean
document_reload_file(GeanyDocument
*doc
, const gchar
*forced_enc
)
1321 GeanyDocument
*new_doc
;
1323 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1325 /* try to set the cursor to the position before reloading */
1326 pos
= sci_get_current_position(doc
->editor
->sci
);
1327 new_doc
= document_open_file_full(doc
, NULL
, pos
, doc
->readonly
, doc
->file_type
, forced_enc
);
1329 return (new_doc
!= NULL
);
1333 static gboolean
document_update_timestamp(GeanyDocument
*doc
, const gchar
*locale_filename
)
1335 #ifndef USE_GIO_FILEMON
1338 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1340 /* stat the file to get the timestamp, otherwise on Windows the actual
1341 * timestamp can be ahead of time(NULL) */
1342 if (g_stat(locale_filename
, &st
) != 0)
1344 ui_set_statusbar(TRUE
, _("Could not open file %s (%s)"), doc
->file_name
,
1349 doc
->priv
->mtime
= st
.st_mtime
; /* get the modification time from file and keep it */
1355 /* Sets line and column to the given position byte_pos in the document.
1356 * byte_pos is the position counted in bytes, not characters */
1357 static void get_line_column_from_pos(GeanyDocument
*doc
, guint byte_pos
, gint
*line
, gint
*column
)
1362 /* for some reason we can use byte count instead of character count here */
1363 *line
= sci_get_line_from_position(doc
->editor
->sci
, byte_pos
);
1364 line_start
= sci_get_position_from_line(doc
->editor
->sci
, *line
);
1365 /* get the column in the line */
1366 *column
= byte_pos
- line_start
;
1368 /* any non-ASCII characters are encoded with two bytes(UTF-8, always in Scintilla), so
1369 * skip one byte(i++) and decrease the column number which is based on byte count */
1370 for (i
= line_start
; i
< (line_start
+ *column
); i
++)
1372 if (sci_get_char_at(doc
->editor
->sci
, i
) < 0)
1381 static void replace_header_filename(GeanyDocument
*doc
)
1385 struct Sci_TextToFind ttf
;
1387 g_return_if_fail(doc
!= NULL
);
1388 g_return_if_fail(doc
->file_type
!= NULL
);
1390 filebase
= g_regex_escape_string(GEANY_STRING_UNTITLED
, -1);
1391 if (doc
->file_type
->extension
)
1392 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\.\\w+", NULL
));
1394 SETPTR(filebase
, g_strconcat("\\b", filebase
, "\\b", NULL
));
1396 filename
= g_path_get_basename(doc
->file_name
);
1398 /* only search the first 3 lines */
1400 ttf
.chrg
.cpMax
= sci_get_position_from_line(doc
->editor
->sci
, 4);
1401 ttf
.lpstrText
= filebase
;
1403 if (search_find_text(doc
->editor
->sci
, GEANY_FIND_MATCHCASE
| GEANY_FIND_REGEXP
, &ttf
, NULL
) != -1)
1405 sci_set_target_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1406 sci_set_target_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1407 sci_replace_target(doc
->editor
->sci
, filename
, FALSE
);
1415 * Renames the file in @a doc to @a new_filename. Only the file on disk is actually renamed,
1416 * you still have to call @ref document_save_file_as() to change the @a doc object.
1417 * It also stops monitoring for file changes to prevent receiving too many file change events
1418 * while renaming. File monitoring is setup again in @ref document_save_file_as().
1420 * @param doc The current document which should be renamed.
1421 * @param new_filename The new filename in UTF-8 encoding.
1425 void document_rename_file(GeanyDocument
*doc
, const gchar
*new_filename
)
1427 gchar
*old_locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1428 gchar
*new_locale_filename
= utils_get_locale_from_utf8(new_filename
);
1431 /* stop file monitoring to avoid getting events for deleting/creating files,
1432 * it's re-setup in document_save_file_as() */
1433 document_stop_file_monitoring(doc
);
1435 result
= g_rename(old_locale_filename
, new_locale_filename
);
1438 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
,
1439 _("Error renaming file."), g_strerror(errno
));
1441 g_free(old_locale_filename
);
1442 g_free(new_locale_filename
);
1446 /* Return TRUE if the document doesn't have a full filename set.
1447 * This makes filenames without a path show the save as dialog, e.g. for file templates.
1448 * Otherwise just use the set filename instead of asking the user - e.g. for command-line
1450 gboolean
document_need_save_as(GeanyDocument
*doc
)
1452 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1454 return (doc
->file_name
== NULL
|| !g_path_is_absolute(doc
->file_name
));
1459 * Saves the document, detecting the filetype.
1461 * @param doc The document for the file to save.
1462 * @param utf8_fname The new name for the document, in UTF-8, or NULL.
1463 * @return @c TRUE if the file was saved or @c FALSE if the file could not be saved.
1465 * @see document_save_file().
1469 gboolean
document_save_file_as(GeanyDocument
*doc
, const gchar
*utf8_fname
)
1473 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1475 if (utf8_fname
!= NULL
)
1476 SETPTR(doc
->file_name
, g_strdup(utf8_fname
));
1478 /* reset real path, it's retrieved again in document_save() */
1479 SETPTR(doc
->real_path
, NULL
);
1481 /* detect filetype */
1482 if (doc
->file_type
->id
== GEANY_FILETYPES_NONE
)
1484 GeanyFiletype
*ft
= filetypes_detect_from_document(doc
);
1486 document_set_filetype(doc
, ft
);
1487 if (document_get_current() == doc
)
1489 ignore_callback
= TRUE
;
1490 filetypes_select_radio_item(doc
->file_type
);
1491 ignore_callback
= FALSE
;
1494 replace_header_filename(doc
);
1496 ret
= document_save_file(doc
, TRUE
);
1498 /* file monitoring support, add file monitoring after the file has been saved
1499 * to ignore any earlier events */
1500 monitor_file_setup(doc
);
1501 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1504 ui_add_recent_document(doc
);
1509 static gsize
save_convert_to_encoding(GeanyDocument
*doc
, gchar
**data
, gsize
*len
)
1511 GError
*conv_error
= NULL
;
1512 gchar
* conv_file_contents
= NULL
;
1516 g_return_val_if_fail(data
!= NULL
&& *data
!= NULL
, FALSE
);
1517 g_return_val_if_fail(len
!= NULL
, FALSE
);
1519 /* try to convert it from UTF-8 to original encoding */
1520 conv_file_contents
= g_convert(*data
, *len
- 1, doc
->encoding
, "UTF-8",
1521 &bytes_read
, &conv_len
, &conv_error
);
1523 if (conv_error
!= NULL
)
1525 gchar
*text
= g_strdup_printf(
1526 _("An error occurred while converting the file from UTF-8 in \"%s\". The file remains unsaved."),
1530 if (conv_error
->code
== G_CONVERT_ERROR_ILLEGAL_SEQUENCE
)
1535 /* don't read over the doc length */
1536 gint max_len
= MIN((gint
)bytes_read
+ 6, (gint
)*len
- 1);
1537 gchar context
[7]; /* read 6 bytes from Sci + '\0' */
1538 sci_get_text_range(doc
->editor
->sci
, bytes_read
, max_len
, context
);
1540 /* take only one valid Unicode character from the context and discard the leftover */
1541 unic
= g_utf8_get_char_validated(context
, -1);
1542 context_len
= g_unichar_to_utf8(unic
, context
);
1543 context
[context_len
] = '\0';
1544 get_line_column_from_pos(doc
, bytes_read
, &line
, &column
);
1546 error_text
= g_strdup_printf(
1547 _("Error message: %s\nThe error occurred at \"%s\" (line: %d, column: %d)."),
1548 conv_error
->message
, context
, line
+ 1, column
);
1551 error_text
= g_strdup_printf(_("Error message: %s."), conv_error
->message
);
1553 geany_debug("encoding error: %s", conv_error
->message
);
1554 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, text
, error_text
);
1555 g_error_free(conv_error
);
1563 *data
= conv_file_contents
;
1570 static gchar
*write_data_to_disk(const gchar
*locale_filename
,
1571 const gchar
*data
, gsize len
)
1573 GError
*error
= NULL
;
1575 if (file_prefs
.use_safe_file_saving
)
1577 /* Use old GLib API for safe saving (GVFS-safe, but alters ownership and permissons).
1578 * This is the only option that handles disk space exhaustion. */
1579 if (g_file_set_contents(locale_filename
, data
, len
, &error
))
1580 geany_debug("Wrote %s with g_file_set_contents().", locale_filename
);
1582 else if (file_prefs
.use_gio_unsafe_file_saving
)
1586 /* Use GIO API to save file (GVFS-safe)
1587 * It is best in most GVFS setups but don't seem to work correctly on some more complex
1588 * setups (saving from some VM to their host, over some SMB shares, etc.) */
1589 fp
= g_file_new_for_path(locale_filename
);
1590 g_file_replace_contents(fp
, data
, len
, NULL
, file_prefs
.gio_unsafe_save_backup
,
1591 G_FILE_CREATE_NONE
, NULL
, NULL
, &error
);
1598 gchar
*display_name
= g_filename_display_name(locale_filename
);
1600 /* Use POSIX API for unsafe saving (GVFS-unsafe) */
1601 /* The error handling is taken from glib-2.26.0 gfileutils.c */
1603 fp
= g_fopen(locale_filename
, "wb");
1610 g_file_error_from_errno(save_errno
),
1611 _("Failed to open file '%s' for writing: fopen() failed: %s"),
1613 g_strerror(save_errno
));
1617 gsize bytes_written
;
1620 bytes_written
= fwrite(data
, sizeof(gchar
), len
, fp
);
1622 if (len
!= bytes_written
)
1628 g_file_error_from_errno(save_errno
),
1629 _("Failed to write file '%s': fwrite() failed: %s"),
1631 g_strerror(save_errno
));
1635 /* preserve the fwrite() error if any */
1636 if (fclose(fp
) != 0 && error
== NULL
)
1642 g_file_error_from_errno(save_errno
),
1643 _("Failed to close file '%s': fclose() failed: %s"),
1645 g_strerror(save_errno
));
1649 g_free(display_name
);
1653 gchar
*msg
= g_strdup(error
->message
);
1654 g_error_free(error
);
1655 /* geany will warn about file truncation for unsafe saving below */
1662 static gchar
*save_doc(GeanyDocument
*doc
, const gchar
*locale_filename
,
1663 const gchar
*data
, gsize len
)
1667 g_return_val_if_fail(doc
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1668 g_return_val_if_fail(data
!= NULL
, g_strdup(g_strerror(EINVAL
)));
1670 err
= write_data_to_disk(locale_filename
, data
, len
);
1674 /* now the file is on disk, set real_path */
1675 if (doc
->real_path
== NULL
)
1677 doc
->real_path
= tm_get_real_path(locale_filename
);
1678 doc
->priv
->is_remote
= utils_is_remote_path(locale_filename
);
1679 monitor_file_setup(doc
);
1686 * Saves the document.
1687 * Also shows the Save As dialog if necessary.
1688 * If the file is not modified, this function may do nothing unless @a force is set to @c TRUE.
1690 * Saving may include replacing tabs with spaces,
1691 * stripping trailing spaces and adding a final new line at the end of the file, depending
1692 * on user preferences. Then the @c "document-before-save" signal is emitted,
1693 * allowing plugins to modify the document before it is saved, and data is
1694 * actually written to disk.
1696 * On successful saving:
1697 * - GeanyDocument::real_path is set.
1698 * - The filetype is set again or auto-detected if it wasn't set yet.
1699 * - The @c "document-save" signal is emitted for plugins.
1701 * @warning You should ensure @c doc->file_name has an absolute path unless you want the
1702 * Save As dialog to be shown. A @c NULL value also shows the dialog. This behaviour was
1703 * added in Geany 1.22.
1705 * @param doc The document to save.
1706 * @param force Whether to save the file even if it is not modified.
1708 * @return @c TRUE if the file was saved or @c FALSE if the file could not or should not be saved.
1710 gboolean
document_save_file(GeanyDocument
*doc
, gboolean force
)
1715 gchar
*locale_filename
;
1716 const GeanyFilePrefs
*fp
;
1718 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1720 if (document_need_save_as(doc
))
1722 /* ensure doc is the current tab before showing the dialog */
1723 document_show_tab(doc
);
1724 return dialogs_show_save_as();
1727 /* the "changed" flag should exclude the "readonly" flag, but check it anyway for safety */
1728 if (! force
&& (! doc
->changed
|| doc
->readonly
))
1731 fp
= project_get_file_prefs();
1732 /* replaces tabs with spaces but only if the current file is not a Makefile */
1733 if (fp
->replace_tabs
&& doc
->file_type
->id
!= GEANY_FILETYPES_MAKE
)
1734 editor_replace_tabs(doc
->editor
);
1735 /* strip trailing spaces */
1736 if (fp
->strip_trailing_spaces
)
1737 editor_strip_trailing_spaces(doc
->editor
);
1738 /* ensure the file has a newline at the end */
1739 if (fp
->final_new_line
)
1740 editor_ensure_final_newline(doc
->editor
);
1741 /* ensure newlines are consistent */
1742 if (fp
->ensure_convert_new_lines
)
1743 sci_convert_eols(doc
->editor
->sci
, sci_get_eol_mode(doc
->editor
->sci
));
1745 /* notify plugins which may wish to modify the document before it's saved */
1746 g_signal_emit_by_name(geany_object
, "document-before-save", doc
);
1748 len
= sci_get_length(doc
->editor
->sci
) + 1;
1749 if (doc
->has_bom
&& encodings_is_unicode_charset(doc
->encoding
))
1750 { /* always write a UTF-8 BOM because in this moment the text itself is still in UTF-8
1751 * encoding, it will be converted to doc->encoding below and this conversion
1752 * also changes the BOM */
1753 data
= (gchar
*) g_malloc(len
+ 3); /* 3 chars for BOM */
1754 data
[0] = (gchar
) 0xef;
1755 data
[1] = (gchar
) 0xbb;
1756 data
[2] = (gchar
) 0xbf;
1757 sci_get_text(doc
->editor
->sci
, len
, data
+ 3);
1762 data
= (gchar
*) g_malloc(len
);
1763 sci_get_text(doc
->editor
->sci
, len
, data
);
1766 /* save in original encoding, skip when it is already UTF-8 or has the encoding "None" */
1767 if (doc
->encoding
!= NULL
&& ! utils_str_equal(doc
->encoding
, "UTF-8") &&
1768 ! utils_str_equal(doc
->encoding
, encodings
[GEANY_ENCODING_NONE
].charset
))
1770 if (! save_convert_to_encoding(doc
, &data
, &len
))
1781 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
1783 /* ignore file changed notification when the file is written */
1784 doc
->priv
->file_disk_status
= FILE_IGNORE
;
1786 /* actually write the content of data to the file on disk */
1787 errmsg
= save_doc(doc
, locale_filename
, data
, len
);
1792 ui_set_statusbar(TRUE
, _("Error saving file (%s)."), errmsg
);
1794 if (!file_prefs
.use_safe_file_saving
)
1797 g_strdup_printf(_("%s\n\nThe file on disk may now be truncated!"), errmsg
));
1799 dialogs_show_msgbox_with_secondary(GTK_MESSAGE_ERROR
, _("Error saving file."), errmsg
);
1800 doc
->priv
->file_disk_status
= FILE_OK
;
1802 g_free(locale_filename
);
1807 /* store the opened encoding for undo/redo */
1808 store_saved_encoding(doc
);
1810 /* ignore the following things if we are quitting */
1811 if (! main_status
.quitting
)
1813 sci_set_savepoint(doc
->editor
->sci
);
1815 if (file_prefs
.disk_check_timeout
> 0)
1816 document_update_timestamp(doc
, locale_filename
);
1818 /* update filetype-related things */
1819 document_set_filetype(doc
, doc
->file_type
);
1821 document_update_tab_label(doc
);
1823 msgwin_status_add(_("File %s saved."), doc
->file_name
);
1824 ui_update_statusbar(doc
, -1);
1826 vte_cwd((doc
->real_path
!= NULL
) ? doc
->real_path
: doc
->file_name
, FALSE
);
1829 g_free(locale_filename
);
1831 g_signal_emit_by_name(geany_object
, "document-save", doc
);
1837 /* special search function, used from the find entry in the toolbar
1838 * return TRUE if text was found otherwise FALSE
1839 * return also TRUE if text is empty */
1840 gboolean
document_search_bar_find(GeanyDocument
*doc
, const gchar
*text
, gint flags
, gboolean inc
,
1843 gint start_pos
, search_pos
;
1844 struct Sci_TextToFind ttf
;
1846 g_return_val_if_fail(text
!= NULL
, FALSE
);
1847 g_return_val_if_fail(doc
!= NULL
, FALSE
);
1851 start_pos
= (inc
|| backwards
) ? sci_get_selection_start(doc
->editor
->sci
) :
1852 sci_get_selection_end(doc
->editor
->sci
); /* equal if no selection */
1854 /* search cursor to end or start */
1855 ttf
.chrg
.cpMin
= start_pos
;
1856 ttf
.chrg
.cpMax
= backwards
? 0 : sci_get_length(doc
->editor
->sci
);
1857 ttf
.lpstrText
= (gchar
*)text
;
1858 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1860 /* if no match, search start (or end) to cursor */
1861 if (search_pos
== -1)
1865 ttf
.chrg
.cpMin
= sci_get_length(doc
->editor
->sci
);
1866 ttf
.chrg
.cpMax
= start_pos
;
1871 ttf
.chrg
.cpMax
= start_pos
+ strlen(text
);
1873 search_pos
= sci_find_text(doc
->editor
->sci
, flags
, &ttf
);
1876 if (search_pos
!= -1)
1878 gint line
= sci_get_line_from_position(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1880 /* unfold maybe folded results */
1881 sci_ensure_line_is_visible(doc
->editor
->sci
, line
);
1883 sci_set_selection_start(doc
->editor
->sci
, ttf
.chrgText
.cpMin
);
1884 sci_set_selection_end(doc
->editor
->sci
, ttf
.chrgText
.cpMax
);
1886 if (! editor_line_in_view(doc
->editor
, line
))
1887 { /* we need to force scrolling in case the cursor is outside of the current visible area
1888 * GeanyDocument::scroll_percent doesn't work because sci isn't always updated
1889 * while searching */
1890 editor_scroll_to_line(doc
->editor
, -1, 0.3F
);
1893 sci_scroll_caret(doc
->editor
->sci
); /* may need horizontal scrolling */
1900 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), text
);
1903 sci_goto_pos(doc
->editor
->sci
, start_pos
, FALSE
); /* clear selection */
1909 /* General search function, used from the find dialog.
1910 * Returns -1 on failure or the start position of the matching text.
1911 * Will skip past any selection, ignoring it.
1913 * @param text Text to find.
1914 * @param original_text Text as it was entered by user, or @c NULL to use @c text
1916 gint
document_find_text(GeanyDocument
*doc
, const gchar
*text
, const gchar
*original_text
,
1917 gint flags
, gboolean search_backwards
, GeanyMatchInfo
**match_
,
1918 gboolean scroll
, GtkWidget
*parent
)
1920 gint selection_end
, selection_start
, search_pos
;
1922 g_return_val_if_fail(doc
!= NULL
&& text
!= NULL
, -1);
1926 /* Sci doesn't support searching backwards with a regex */
1927 if (flags
& GEANY_FIND_REGEXP
)
1928 search_backwards
= FALSE
;
1931 original_text
= text
;
1933 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
1934 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
1935 if ((selection_end
- selection_start
) > 0)
1936 { /* there's a selection so go to the end */
1937 if (search_backwards
)
1938 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
1940 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
1943 sci_set_search_anchor(doc
->editor
->sci
);
1944 if (search_backwards
)
1945 search_pos
= search_find_prev(doc
->editor
->sci
, text
, flags
, match_
);
1947 search_pos
= search_find_next(doc
->editor
->sci
, text
, flags
, match_
);
1949 if (search_pos
!= -1)
1951 /* unfold maybe folded results */
1952 sci_ensure_line_is_visible(doc
->editor
->sci
,
1953 sci_get_line_from_position(doc
->editor
->sci
, search_pos
));
1955 doc
->editor
->scroll_percent
= 0.3F
;
1959 gint sci_len
= sci_get_length(doc
->editor
->sci
);
1961 /* if we just searched the whole text, give up searching. */
1962 if ((selection_end
== 0 && ! search_backwards
) ||
1963 (selection_end
== sci_len
&& search_backwards
))
1965 ui_set_statusbar(FALSE
, _("\"%s\" was not found."), original_text
);
1970 /* we searched only part of the document, so ask whether to wraparound. */
1971 if (search_prefs
.always_wrap
||
1972 dialogs_show_question_full(parent
, GTK_STOCK_FIND
, GTK_STOCK_CANCEL
,
1973 _("Wrap search and find again?"), _("\"%s\" was not found."), original_text
))
1977 sci_set_current_position(doc
->editor
->sci
, (search_backwards
) ? sci_len
: 0, FALSE
);
1978 ret
= document_find_text(doc
, text
, original_text
, flags
, search_backwards
, match_
, scroll
, parent
);
1980 { /* return to original cursor position if not found */
1981 sci_set_current_position(doc
->editor
->sci
, selection_start
, FALSE
);
1990 /* Replaces the selection if it matches, otherwise just finds the next match.
1991 * Returns: start of replaced text, or -1 if no replacement was made
1993 * @param find_text Text to find.
1994 * @param original_find_text Text to find as it was entered by user, or @c NULL to use @c find_text
1996 gint
document_replace_text(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*original_find_text
,
1997 const gchar
*replace_text
, gint flags
, gboolean search_backwards
)
1999 gint selection_end
, selection_start
, search_pos
;
2000 GeanyMatchInfo
*match
= NULL
;
2002 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, -1);
2007 /* Sci doesn't support searching backwards with a regex */
2008 if (flags
& GEANY_FIND_REGEXP
)
2009 search_backwards
= FALSE
;
2011 if (!original_find_text
)
2012 original_find_text
= find_text
;
2014 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2015 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2016 if (selection_end
== selection_start
)
2018 /* no selection so just find the next match */
2019 document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, NULL
, TRUE
, NULL
);
2022 /* there's a selection so go to the start before finding to search through it
2023 * this ensures there is a match */
2024 if (search_backwards
)
2025 sci_goto_pos(doc
->editor
->sci
, selection_end
, TRUE
);
2027 sci_goto_pos(doc
->editor
->sci
, selection_start
, TRUE
);
2029 search_pos
= document_find_text(doc
, find_text
, original_find_text
, flags
, search_backwards
, &match
, TRUE
, NULL
);
2030 /* return if the original selected text did not match (at the start of the selection) */
2031 if (search_pos
!= selection_start
)
2033 if (search_pos
!= -1)
2034 geany_match_info_free(match
);
2038 if (search_pos
!= -1)
2040 gint replace_len
= search_replace_match(doc
->editor
->sci
, match
, replace_text
);
2041 /* select the replacement - find text will skip past the selected text */
2042 sci_set_selection_start(doc
->editor
->sci
, search_pos
);
2043 sci_set_selection_end(doc
->editor
->sci
, search_pos
+ replace_len
);
2044 geany_match_info_free(match
);
2048 /* no match in the selection */
2055 static void show_replace_summary(GeanyDocument
*doc
, gint count
, const gchar
*original_find_text
,
2056 const gchar
*original_replace_text
)
2062 ui_set_statusbar(FALSE
, _("No matches found for \"%s\"."), original_find_text
);
2066 filename
= g_path_get_basename(DOC_FILENAME(doc
));
2067 ui_set_statusbar(TRUE
, ngettext(
2068 "%s: replaced %d occurrence of \"%s\" with \"%s\".",
2069 "%s: replaced %d occurrences of \"%s\" with \"%s\".",
2070 count
), filename
, count
, original_find_text
, original_replace_text
);
2075 /* Replace all text matches in a certain range within document.
2076 * If not NULL, *new_range_end is set to the new range endpoint after replacing,
2077 * or -1 if no text was found.
2078 * scroll_to_match is whether to scroll the last replacement in view (which also
2079 * clears the selection).
2080 * Returns: the number of replacements made. */
2082 document_replace_range(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2083 gint flags
, gint start
, gint end
, gboolean scroll_to_match
, gint
*new_range_end
)
2086 struct Sci_TextToFind ttf
;
2087 ScintillaObject
*sci
;
2089 if (new_range_end
!= NULL
)
2090 *new_range_end
= -1;
2092 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, 0);
2094 if (! *find_text
|| doc
->readonly
)
2097 sci
= doc
->editor
->sci
;
2099 ttf
.chrg
.cpMin
= start
;
2100 ttf
.chrg
.cpMax
= end
;
2101 ttf
.lpstrText
= (gchar
*)find_text
;
2103 sci_start_undo_action(sci
);
2104 count
= search_replace_range(sci
, &ttf
, flags
, replace_text
);
2105 sci_end_undo_action(sci
);
2108 { /* scroll last match in view, will destroy the existing selection */
2109 if (scroll_to_match
)
2110 sci_goto_pos(sci
, ttf
.chrg
.cpMin
, TRUE
);
2112 if (new_range_end
!= NULL
)
2113 *new_range_end
= ttf
.chrg
.cpMax
;
2119 void document_replace_sel(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2120 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2122 gint selection_end
, selection_start
, selection_mode
, selected_lines
, last_line
= 0;
2123 gint max_column
= 0, count
= 0;
2124 gboolean replaced
= FALSE
;
2126 g_return_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
);
2131 selection_start
= sci_get_selection_start(doc
->editor
->sci
);
2132 selection_end
= sci_get_selection_end(doc
->editor
->sci
);
2133 /* do we have a selection? */
2134 if ((selection_end
- selection_start
) == 0)
2140 selection_mode
= sci_get_selection_mode(doc
->editor
->sci
);
2141 selected_lines
= sci_get_lines_selected(doc
->editor
->sci
);
2142 /* handle rectangle, multi line selections (it doesn't matter on a single line) */
2143 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2145 gint first_line
, line
;
2147 sci_start_undo_action(doc
->editor
->sci
);
2149 first_line
= sci_get_line_from_position(doc
->editor
->sci
, selection_start
);
2150 /* Find the last line with chars selected (not EOL char) */
2151 last_line
= sci_get_line_from_position(doc
->editor
->sci
,
2152 selection_end
- editor_get_eol_char_len(doc
->editor
));
2153 last_line
= MAX(first_line
, last_line
);
2154 for (line
= first_line
; line
< (first_line
+ selected_lines
); line
++)
2156 gint line_start
= sci_get_pos_at_line_sel_start(doc
->editor
->sci
, line
);
2157 gint line_end
= sci_get_pos_at_line_sel_end(doc
->editor
->sci
, line
);
2159 /* skip line if there is no selection */
2160 if (line_start
!= INVALID_POSITION
)
2162 /* don't let document_replace_range() scroll to match to keep our selection */
2165 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2166 line_start
, line_end
, FALSE
, &new_sel_end
);
2167 if (new_sel_end
!= -1)
2170 /* this gets the greatest column within the selection after replacing */
2171 max_column
= MAX(max_column
,
2172 new_sel_end
- sci_get_position_from_line(doc
->editor
->sci
, line
));
2176 sci_end_undo_action(doc
->editor
->sci
);
2178 else /* handle normal line selection */
2180 count
+= document_replace_range(doc
, find_text
, replace_text
, flags
,
2181 selection_start
, selection_end
, TRUE
, &selection_end
);
2182 if (selection_end
!= -1)
2187 { /* update the selection for the new endpoint */
2189 if (selection_mode
== SC_SEL_RECTANGLE
&& selected_lines
> 1)
2191 /* now we can scroll to the selection and destroy it because we rebuild it later */
2192 /*sci_goto_pos(doc->editor->sci, selection_start, FALSE);*/
2194 /* Note: the selection will be wrapped to last_line + 1 if max_column is greater than
2195 * the highest column on the last line. The wrapped selection is completely different
2196 * from the original one, so skip the selection at all */
2197 /* TODO is there a better way to handle the wrapped selection? */
2198 if ((sci_get_line_length(doc
->editor
->sci
, last_line
) - 1) >= max_column
)
2199 { /* for keeping and adjusting the selection in multi line rectangle selection we
2200 * need the last line of the original selection and the greatest column number after
2201 * replacing and set the selection end to the last line at the greatest column */
2202 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2203 sci_set_selection_end(doc
->editor
->sci
,
2204 sci_get_position_from_line(doc
->editor
->sci
, last_line
) + max_column
);
2205 sci_set_selection_mode(doc
->editor
->sci
, selection_mode
);
2210 sci_set_selection_start(doc
->editor
->sci
, selection_start
);
2211 sci_set_selection_end(doc
->editor
->sci
, selection_end
);
2214 else /* no replacements */
2217 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2221 /* returns number of replacements made. */
2222 gint
document_replace_all(GeanyDocument
*doc
, const gchar
*find_text
, const gchar
*replace_text
,
2223 const gchar
*original_find_text
, const gchar
*original_replace_text
, gint flags
)
2226 g_return_val_if_fail(doc
!= NULL
&& find_text
!= NULL
&& replace_text
!= NULL
, FALSE
);
2231 len
= sci_get_length(doc
->editor
->sci
);
2232 count
= document_replace_range(
2233 doc
, find_text
, replace_text
, flags
, 0, len
, TRUE
, NULL
);
2235 show_replace_summary(doc
, count
, original_find_text
, original_replace_text
);
2241 * Parses or re-parses the document's buffer and updates the type
2242 * keywords and symbol list.
2244 * @param doc The document.
2246 void document_update_tags(GeanyDocument
*doc
)
2251 g_return_if_fail(DOC_VALID(doc
));
2252 g_return_if_fail(app
->tm_workspace
!= NULL
);
2254 /* early out if it's a new file or doesn't support tags */
2255 if (! doc
->file_name
|| ! doc
->file_type
|| !filetype_has_tags(doc
->file_type
))
2257 /* We must call sidebar_update_tag_list() before returning,
2258 * to ensure that the symbol list is always updated properly (e.g.
2259 * when creating a new document with a partial filename set. */
2260 sidebar_update_tag_list(doc
, FALSE
);
2264 /* create a new TM file if there isn't one yet */
2267 gchar
*locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
2270 /* lookup the name rather than using filetype name to support custom filetypes */
2271 name
= tm_source_file_get_lang_name(doc
->file_type
->lang
);
2272 doc
->tm_file
= tm_source_file_new(locale_filename
, FALSE
, name
);
2273 g_free(locale_filename
);
2275 if (doc
->tm_file
&& !tm_workspace_add_object(doc
->tm_file
))
2277 tm_work_object_free(doc
->tm_file
);
2278 doc
->tm_file
= NULL
;
2282 /* early out if there's no work object and we couldn't create one */
2283 if (doc
->tm_file
== NULL
)
2285 /* We must call sidebar_update_tag_list() before returning,
2286 * to ensure that the symbol list is always updated properly (e.g.
2287 * when creating a new document with a partial filename set. */
2288 sidebar_update_tag_list(doc
, FALSE
);
2292 len
= sci_get_length(doc
->editor
->sci
);
2293 /* tm_source_file_buffer_update() below don't support 0-length data,
2294 * so just empty the tags array and leave */
2297 tm_tags_array_free(doc
->tm_file
->tags_array
, FALSE
);
2298 sidebar_update_tag_list(doc
, FALSE
);
2302 /* Parse Scintilla's buffer directly using TagManager
2303 * Note: this buffer *MUST NOT* be modified */
2304 buffer_ptr
= (guchar
*) scintilla_send_message(doc
->editor
->sci
, SCI_GETCHARACTERPOINTER
, 0, 0);
2305 tm_source_file_buffer_update(doc
->tm_file
, buffer_ptr
, len
, TRUE
);
2307 sidebar_update_tag_list(doc
, TRUE
);
2308 document_highlight_tags(doc
);
2312 /* Re-highlights type keywords without re-parsing the whole document. */
2313 void document_highlight_tags(GeanyDocument
*doc
)
2315 GString
*keywords_str
;
2319 /* some filetypes support type keywords (such as struct names), but not
2320 * necessarily all filetypes for a particular scintilla lexer. this
2321 * tells us whether the filetype supports keywords, and if so
2322 * which index to use for the scintilla keywords set. */
2323 switch (doc
->file_type
->id
)
2325 case GEANY_FILETYPES_C
:
2326 case GEANY_FILETYPES_CPP
:
2327 case GEANY_FILETYPES_CS
:
2328 case GEANY_FILETYPES_D
:
2329 case GEANY_FILETYPES_JAVA
:
2330 case GEANY_FILETYPES_OBJECTIVEC
:
2331 case GEANY_FILETYPES_VALA
:
2332 case GEANY_FILETYPES_RUST
:
2335 /* index of the keyword set in the Scintilla lexer, for
2336 * example in LexCPP.cxx, see "cppWordLists" global array.
2337 * TODO: this magic number should be a member of the filetype */
2342 return; /* early out if type keywords are not supported */
2344 if (!app
->tm_workspace
->work_object
.tags_array
)
2347 /* get any type keywords and tell scintilla about them
2348 * this will cause the type keywords to be colourized in scintilla */
2349 keywords_str
= symbols_find_tags_as_string(app
->tm_workspace
->work_object
.tags_array
,
2350 TM_GLOBAL_TYPE_MASK
, doc
->file_type
->lang
);
2353 keywords
= g_string_free(keywords_str
, FALSE
);
2354 sci_set_keywords(doc
->editor
->sci
, keyword_idx
, keywords
);
2356 queue_colourise(doc
); /* force re-highlighting the entire document */
2361 static gboolean
on_document_update_tag_list_idle(gpointer data
)
2363 GeanyDocument
*doc
= data
;
2365 if (! DOC_VALID(doc
))
2368 if (! main_status
.quitting
)
2369 document_update_tags(doc
);
2371 doc
->priv
->tag_list_update_source
= 0;
2373 /* don't update the tags until another modification of the buffer */
2378 void document_update_tag_list_in_idle(GeanyDocument
*doc
)
2380 if (editor_prefs
.autocompletion_update_freq
<= 0 || ! filetype_has_tags(doc
->file_type
))
2383 /* prevent "stacking up" callback handlers, we only need one to run soon */
2384 if (doc
->priv
->tag_list_update_source
!= 0)
2385 g_source_remove(doc
->priv
->tag_list_update_source
);
2387 doc
->priv
->tag_list_update_source
= g_timeout_add_full(G_PRIORITY_LOW
,
2388 editor_prefs
.autocompletion_update_freq
, on_document_update_tag_list_idle
, doc
, NULL
);
2392 static void document_load_config(GeanyDocument
*doc
, GeanyFiletype
*type
,
2393 gboolean filetype_changed
)
2395 g_return_if_fail(doc
);
2397 type
= filetypes
[GEANY_FILETYPES_NONE
];
2399 if (filetype_changed
)
2401 doc
->file_type
= type
;
2403 /* delete tm file object to force creation of a new one */
2404 if (doc
->tm_file
!= NULL
)
2406 tm_workspace_remove_object(doc
->tm_file
, TRUE
, TRUE
);
2407 doc
->tm_file
= NULL
;
2409 /* load tags files before highlighting (some lexers highlight global typenames) */
2410 if (type
->id
!= GEANY_FILETYPES_NONE
)
2411 symbols_global_tags_loaded(type
->id
);
2413 highlighting_set_styles(doc
->editor
->sci
, type
);
2414 editor_set_indentation_guides(doc
->editor
);
2415 build_menu_update(doc
);
2416 queue_colourise(doc
);
2417 doc
->priv
->symbol_list_sort_mode
= type
->priv
->symbol_list_sort_mode
;
2420 document_update_tags(doc
);
2424 /** Sets the filetype of the document (which controls syntax highlighting and tags)
2425 * @param doc The document to use.
2426 * @param type The filetype. */
2427 void document_set_filetype(GeanyDocument
*doc
, GeanyFiletype
*type
)
2429 gboolean ft_changed
;
2430 GeanyFiletype
*old_ft
;
2432 g_return_if_fail(doc
);
2434 type
= filetypes
[GEANY_FILETYPES_NONE
];
2436 old_ft
= doc
->file_type
;
2437 geany_debug("%s : %s (%s)",
2438 (doc
->file_name
!= NULL
) ? doc
->file_name
: "unknown",
2440 (doc
->encoding
!= NULL
) ? doc
->encoding
: "unknown");
2442 ft_changed
= (doc
->file_type
!= type
); /* filetype has changed */
2443 document_load_config(doc
, type
, ft_changed
);
2447 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(NULL
);
2449 /* assume that if previous filetype was none and the settings are the default ones, this
2450 * is the first time the filetype is carefully set, so we should apply indent settings */
2451 if ((! old_ft
|| old_ft
->id
== GEANY_FILETYPES_NONE
) &&
2452 doc
->editor
->indent_type
== iprefs
->type
&&
2453 doc
->editor
->indent_width
== iprefs
->width
)
2455 document_apply_indent_settings(doc
);
2456 ui_document_show_hide(doc
);
2459 sidebar_openfiles_update(doc
); /* to update the icon */
2460 g_signal_emit_by_name(geany_object
, "document-filetype-set", doc
, old_ft
);
2465 void document_reload_config(GeanyDocument
*doc
)
2467 document_load_config(doc
, doc
->file_type
, TRUE
);
2472 * Sets the encoding of a document.
2473 * This function only set the encoding of the %document, it does not any conversions. The new
2474 * encoding is used when e.g. saving the file.
2476 * @param doc The document to use.
2477 * @param new_encoding The encoding to be set for the document.
2479 void document_set_encoding(GeanyDocument
*doc
, const gchar
*new_encoding
)
2481 if (doc
== NULL
|| new_encoding
== NULL
||
2482 utils_str_equal(new_encoding
, doc
->encoding
))
2485 g_free(doc
->encoding
);
2486 doc
->encoding
= g_strdup(new_encoding
);
2488 ui_update_statusbar(doc
, -1);
2489 gtk_widget_set_sensitive(ui_lookup_widget(main_widgets
.window
, "menu_write_unicode_bom1"),
2490 encodings_is_unicode_charset(doc
->encoding
));
2494 /* own Undo / Redo implementation to be able to undo / redo changes
2495 * to the encoding or the Unicode BOM (which are Scintilla independet).
2496 * All Scintilla events are stored in the undo / redo buffer and are passed through. */
2498 /* Clears the Undo and Redo buffer (to be called when reloading or closing the document) */
2499 void document_undo_clear(GeanyDocument
*doc
)
2503 while (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0)
2505 a
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2506 if (G_LIKELY(a
!= NULL
))
2510 case UNDO_ENCODING
: g_free(a
->data
); break;
2516 doc
->priv
->undo_actions
= NULL
;
2518 while (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0)
2520 a
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2521 if (G_LIKELY(a
!= NULL
))
2525 case UNDO_ENCODING
: g_free(a
->data
); break;
2531 doc
->priv
->redo_actions
= NULL
;
2533 if (! main_status
.quitting
&& doc
->editor
!= NULL
)
2534 document_set_text_changed(doc
, FALSE
);
2538 /* note: this is called on SCN_MODIFIED notifications */
2539 void document_undo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2541 undo_action
*action
;
2543 g_return_if_fail(doc
!= NULL
);
2545 action
= g_new0(undo_action
, 1);
2546 action
->type
= type
;
2547 action
->data
= data
;
2549 g_trash_stack_push(&doc
->priv
->undo_actions
, action
);
2551 /* avoid unnecessary redraws */
2552 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2553 document_set_text_changed(doc
, TRUE
);
2555 ui_update_popup_reundo_items(doc
);
2559 gboolean
document_can_undo(GeanyDocument
*doc
)
2561 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2563 if (g_trash_stack_height(&doc
->priv
->undo_actions
) > 0 || sci_can_undo(doc
->editor
->sci
))
2570 static void update_changed_state(GeanyDocument
*doc
)
2573 (sci_is_modified(doc
->editor
->sci
) ||
2574 doc
->has_bom
!= doc
->priv
->saved_encoding
.has_bom
||
2575 ! utils_str_equal(doc
->encoding
, doc
->priv
->saved_encoding
.encoding
));
2576 document_set_text_changed(doc
, doc
->changed
);
2580 void document_undo(GeanyDocument
*doc
)
2582 undo_action
*action
;
2584 g_return_if_fail(doc
!= NULL
);
2586 action
= g_trash_stack_pop(&doc
->priv
->undo_actions
);
2588 if (G_UNLIKELY(action
== NULL
))
2590 /* fallback, should not be necessary */
2591 geany_debug("%s: fallback used", G_STRFUNC
);
2592 sci_undo(doc
->editor
->sci
);
2596 switch (action
->type
)
2598 case UNDO_SCINTILLA
:
2600 document_redo_add(doc
, UNDO_SCINTILLA
, NULL
);
2602 sci_undo(doc
->editor
->sci
);
2607 document_redo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2609 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2610 ui_update_statusbar(doc
, -1);
2611 ui_document_show_hide(doc
);
2616 /* use the "old" encoding */
2617 document_redo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2619 document_set_encoding(doc
, (const gchar
*)action
->data
);
2621 ignore_callback
= TRUE
;
2622 encodings_select_radio_item((const gchar
*)action
->data
);
2623 ignore_callback
= FALSE
;
2625 g_free(action
->data
);
2631 g_free(action
); /* free the action which was taken from the stack */
2633 update_changed_state(doc
);
2634 ui_update_popup_reundo_items(doc
);
2638 gboolean
document_can_redo(GeanyDocument
*doc
)
2640 g_return_val_if_fail(doc
!= NULL
, FALSE
);
2642 if (g_trash_stack_height(&doc
->priv
->redo_actions
) > 0 || sci_can_redo(doc
->editor
->sci
))
2649 void document_redo(GeanyDocument
*doc
)
2651 undo_action
*action
;
2653 g_return_if_fail(doc
!= NULL
);
2655 action
= g_trash_stack_pop(&doc
->priv
->redo_actions
);
2657 if (G_UNLIKELY(action
== NULL
))
2659 /* fallback, should not be necessary */
2660 geany_debug("%s: fallback used", G_STRFUNC
);
2661 sci_redo(doc
->editor
->sci
);
2665 switch (action
->type
)
2667 case UNDO_SCINTILLA
:
2669 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
2671 sci_redo(doc
->editor
->sci
);
2676 document_undo_add(doc
, UNDO_BOM
, GINT_TO_POINTER(doc
->has_bom
));
2678 doc
->has_bom
= GPOINTER_TO_INT(action
->data
);
2679 ui_update_statusbar(doc
, -1);
2680 ui_document_show_hide(doc
);
2685 document_undo_add(doc
, UNDO_ENCODING
, g_strdup(doc
->encoding
));
2687 document_set_encoding(doc
, (const gchar
*)action
->data
);
2689 ignore_callback
= TRUE
;
2690 encodings_select_radio_item((const gchar
*)action
->data
);
2691 ignore_callback
= FALSE
;
2693 g_free(action
->data
);
2699 g_free(action
); /* free the action which was taken from the stack */
2701 update_changed_state(doc
);
2702 ui_update_popup_reundo_items(doc
);
2706 static void document_redo_add(GeanyDocument
*doc
, guint type
, gpointer data
)
2708 undo_action
*action
;
2710 g_return_if_fail(doc
!= NULL
);
2712 action
= g_new0(undo_action
, 1);
2713 action
->type
= type
;
2714 action
->data
= data
;
2716 g_trash_stack_push(&doc
->priv
->redo_actions
, action
);
2718 if (type
!= UNDO_SCINTILLA
|| !doc
->changed
)
2719 document_set_text_changed(doc
, TRUE
);
2721 ui_update_popup_reundo_items(doc
);
2728 #ifdef USE_GIO_FILEMON
2729 STATUS_DISK_CHANGED
,
2738 } document_status_styles
[] = {
2739 { "geany-document-status-changed", {0}, FALSE
},
2740 #ifdef USE_GIO_FILEMON
2741 { "geany-document-status-disk-changed", {0}, FALSE
},
2743 { "geany-document-status-readonly", {0}, FALSE
}
2747 static gint
document_get_status_id(GeanyDocument
*doc
)
2750 return STATUS_CHANGED
;
2751 #ifdef USE_GIO_FILEMON
2752 else if (doc
->priv
->file_disk_status
== FILE_CHANGED
)
2753 return STATUS_DISK_CHANGED
;
2755 else if (doc
->readonly
)
2756 return STATUS_READONLY
;
2762 /* returns an identifier that is to be set as a widget name or class to get it styled
2763 * depending on the document status (changed, readonly, etc.)
2764 * a NULL return value means default (unchanged) style */
2765 const gchar
*document_get_status_widget_class(GeanyDocument
*doc
)
2769 g_return_val_if_fail(doc
!= NULL
, NULL
);
2771 status
= document_get_status_id(doc
);
2775 return document_status_styles
[status
].name
;
2780 * Gets the status color of the document, or @c NULL if default widget coloring should be used.
2781 * Returned colors are red if the document has changes, green if the document is read-only
2782 * or simply @c NULL if the document is unmodified but writable.
2784 * @param doc The document to use.
2786 * @return The color for the document or @c NULL if the default color should be used. The color
2787 * object is owned by Geany and should not be modified or freed.
2791 const GdkColor
*document_get_status_color(GeanyDocument
*doc
)
2795 g_return_val_if_fail(doc
!= NULL
, NULL
);
2797 status
= document_get_status_id(doc
);
2800 if (! document_status_styles
[status
].loaded
)
2802 #if GTK_CHECK_VERSION(3, 0, 0)
2804 GtkWidgetPath
*path
= gtk_widget_path_new();
2805 GtkStyleContext
*ctx
= gtk_style_context_new();
2806 gtk_widget_path_append_type(path
, GTK_TYPE_WINDOW
);
2807 gtk_widget_path_append_type(path
, GTK_TYPE_BOX
);
2808 gtk_widget_path_append_type(path
, GTK_TYPE_NOTEBOOK
);
2809 gtk_widget_path_append_type(path
, GTK_TYPE_LABEL
);
2810 gtk_widget_path_iter_set_name(path
, -1, document_status_styles
[status
].name
);
2811 gtk_style_context_set_screen(ctx
, gtk_widget_get_screen(GTK_WIDGET(doc
->editor
->sci
)));
2812 gtk_style_context_set_path(ctx
, path
);
2813 gtk_style_context_get_color(ctx
, GTK_STATE_NORMAL
, &color
);
2814 document_status_styles
[status
].color
.red
= 0xffff * color
.red
;
2815 document_status_styles
[status
].color
.green
= 0xffff * color
.green
;
2816 document_status_styles
[status
].color
.blue
= 0xffff * color
.blue
;
2817 document_status_styles
[status
].loaded
= TRUE
;
2818 gtk_widget_path_unref(path
);
2819 g_object_unref(ctx
);
2821 GtkSettings
*settings
= gtk_widget_get_settings(GTK_WIDGET(doc
->editor
->sci
));
2822 gchar
*path
= g_strconcat("GeanyMainWindow.GtkHBox.GtkNotebook.",
2823 document_status_styles
[status
].name
, NULL
);
2824 GtkStyle
*style
= gtk_rc_get_style_by_paths(settings
, path
, NULL
, GTK_TYPE_LABEL
);
2826 document_status_styles
[status
].color
= style
->fg
[GTK_STATE_NORMAL
];
2827 document_status_styles
[status
].loaded
= TRUE
;
2831 return &document_status_styles
[status
].color
;
2835 /** Accessor function for @ref documents_array items.
2836 * @warning Always check the returned document is valid (@c doc->is_valid).
2837 * @param idx @c documents_array index.
2838 * @return The document, or @c NULL if @a idx is out of range.
2842 GeanyDocument
*document_index(gint idx
)
2844 return (idx
>= 0 && idx
< (gint
) documents_array
->len
) ? documents
[idx
] : NULL
;
2848 /* create a new file and copy file content and properties */
2849 G_MODULE_EXPORT
void on_clone1_activate(GtkMenuItem
*menuitem
, gpointer user_data
)
2851 GeanyDocument
*old_doc
= document_get_current();
2854 document_clone(old_doc
);
2858 GeanyDocument
*document_clone(GeanyDocument
*old_doc
)
2862 ScintillaObject
*old_sci
;
2864 g_return_val_if_fail(old_doc
, NULL
);
2865 old_sci
= old_doc
->editor
->sci
;
2866 if (sci_has_selection(old_sci
))
2867 text
= sci_get_selection_contents(old_sci
);
2869 text
= sci_get_contents(old_sci
, -1);
2871 doc
= document_new_file(NULL
, old_doc
->file_type
, text
);
2873 document_set_text_changed(doc
, TRUE
);
2875 /* copy file properties */
2876 doc
->editor
->line_wrapping
= old_doc
->editor
->line_wrapping
;
2877 doc
->editor
->line_breaking
= old_doc
->editor
->line_breaking
;
2878 doc
->editor
->auto_indent
= old_doc
->editor
->auto_indent
;
2879 editor_set_indent(doc
->editor
, old_doc
->editor
->indent_type
,
2880 old_doc
->editor
->indent_width
);
2881 doc
->readonly
= old_doc
->readonly
;
2882 doc
->has_bom
= old_doc
->has_bom
;
2883 document_set_encoding(doc
, old_doc
->encoding
);
2884 sci_set_lines_wrapped(doc
->editor
->sci
, doc
->editor
->line_wrapping
);
2885 sci_set_readonly(doc
->editor
->sci
, doc
->readonly
);
2888 ui_document_show_hide(doc
);
2893 /* @note If successful, this should always be followed up with a call to
2894 * document_close_all().
2895 * @return TRUE if all files were saved or had their changes discarded. */
2896 gboolean
document_account_for_unsaved(void)
2898 guint i
, p
, page_count
;
2900 page_count
= gtk_notebook_get_n_pages(GTK_NOTEBOOK(main_widgets
.notebook
));
2901 /* iterate over documents in tabs order */
2902 for (p
= 0; p
< page_count
; p
++)
2904 GeanyDocument
*doc
= document_get_from_page(p
);
2906 if (DOC_VALID(doc
) && doc
->changed
)
2908 if (! dialogs_show_unsaved_file(doc
))
2912 /* all documents should now be accounted for, so ignore any changes */
2913 foreach_document (i
)
2915 documents
[i
]->changed
= FALSE
;
2921 static void force_close_all(void)
2923 guint i
, len
= documents_array
->len
;
2925 /* check all documents have been accounted for */
2926 for (i
= 0; i
< len
; i
++)
2928 if (documents
[i
]->is_valid
)
2930 g_return_if_fail(!documents
[i
]->changed
);
2933 main_status
.closing_all
= TRUE
;
2937 document_close(documents
[i
]);
2940 main_status
.closing_all
= FALSE
;
2944 gboolean
document_close_all(void)
2946 if (! document_account_for_unsaved())
2955 static void monitor_reload_file(GeanyDocument
*doc
)
2957 gchar
*base_name
= g_path_get_basename(doc
->file_name
);
2960 /* we use No instead of Cancel to avoid mnemonic clash */
2961 ret
= dialogs_show_prompt(NULL
,
2962 GTK_STOCK_CLOSE
, GTK_RESPONSE_CLOSE
,
2963 GTK_STOCK_NO
, GTK_RESPONSE_CANCEL
,
2964 _("_Reload"), GTK_RESPONSE_ACCEPT
,
2965 _("Do you want to reload it?"),
2966 _("The file '%s' on the disk is more recent than\nthe current buffer."),
2970 if (ret
== GTK_RESPONSE_ACCEPT
)
2971 document_reload_file(doc
, doc
->encoding
);
2972 else if (ret
== GTK_RESPONSE_CLOSE
)
2973 document_close(doc
);
2977 static gboolean
monitor_resave_missing_file(GeanyDocument
*doc
)
2979 gboolean want_reload
= FALSE
;
2980 gboolean file_saved
= FALSE
;
2983 ret
= dialogs_show_prompt(NULL
,
2984 _("Close _without saving"), GTK_RESPONSE_CLOSE
,
2985 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
2986 GTK_STOCK_SAVE
, GTK_RESPONSE_ACCEPT
,
2987 _("Try to resave the file?"),
2988 _("File \"%s\" was not found on disk!"),
2990 if (ret
== GTK_RESPONSE_ACCEPT
)
2992 file_saved
= dialogs_show_save_as();
2995 else if (ret
== GTK_RESPONSE_CLOSE
)
2997 document_close(doc
);
2999 if (ret
!= GTK_RESPONSE_CLOSE
&& ! file_saved
)
3001 /* file is missing - set unsaved state */
3002 document_set_text_changed(doc
, TRUE
);
3003 /* don't prompt more than once */
3004 SETPTR(doc
->real_path
, NULL
);
3011 /* Set force to force a disk check, otherwise it is ignored if there was a check
3012 * in the last file_prefs.disk_check_timeout seconds.
3013 * @return @c TRUE if the file has changed. */
3014 gboolean
document_check_disk_status(GeanyDocument
*doc
, gboolean force
)
3016 gboolean ret
= FALSE
;
3017 gboolean use_gio_filemon
;
3018 time_t cur_time
= 0;
3020 gchar
*locale_filename
;
3021 FileDiskStatus old_status
;
3023 g_return_val_if_fail(doc
!= NULL
, FALSE
);
3025 /* ignore remote files and documents that have never been saved to disk */
3026 if (notebook_switch_in_progress() || file_prefs
.disk_check_timeout
== 0
3027 || doc
->real_path
== NULL
|| doc
->priv
->is_remote
)
3030 use_gio_filemon
= (doc
->priv
->monitor
!= NULL
);
3032 if (use_gio_filemon
)
3034 if (doc
->priv
->file_disk_status
!= FILE_CHANGED
&& ! force
)
3039 cur_time
= time(NULL
);
3040 if (! force
&& doc
->priv
->last_check
> (cur_time
- file_prefs
.disk_check_timeout
))
3043 doc
->priv
->last_check
= cur_time
;
3046 locale_filename
= utils_get_locale_from_utf8(doc
->file_name
);
3047 if (g_stat(locale_filename
, &st
) != 0)
3049 monitor_resave_missing_file(doc
);
3050 /* doc may be closed now */
3053 else if (! use_gio_filemon
&& /* ignore check when using GIO */
3054 doc
->priv
->mtime
> cur_time
)
3056 g_warning("%s: Something is wrong with the time stamps.", G_STRFUNC
);
3057 /* Note: on Windows st.st_mtime can be newer than cur_time */
3059 else if (doc
->priv
->mtime
< st
.st_mtime
)
3061 doc
->priv
->mtime
= st
.st_mtime
;
3062 monitor_reload_file(doc
);
3063 /* doc may be closed now */
3066 g_free(locale_filename
);
3069 { /* doc can get invalid when a document was closed */
3070 old_status
= doc
->priv
->file_disk_status
;
3071 doc
->priv
->file_disk_status
= FILE_OK
;
3072 if (old_status
!= doc
->priv
->file_disk_status
)
3073 ui_update_tab_status(doc
);
3079 /** Compares documents by their display names.
3080 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3081 * @note 'Display name' means the base name of the document's filename.
3083 * @param a @c GeanyDocument**.
3084 * @param b @c GeanyDocument**.
3085 * @warning The arguments take the address of each document pointer.
3086 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3090 gint
document_compare_by_display_name(gconstpointer a
, gconstpointer b
)
3092 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3093 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3094 gchar
*base_name_a
, *base_name_b
;
3097 base_name_a
= g_path_get_basename(DOC_FILENAME(doc_a
));
3098 base_name_b
= g_path_get_basename(DOC_FILENAME(doc_b
));
3100 result
= strcmp(base_name_a
, base_name_b
);
3102 g_free(base_name_a
);
3103 g_free(base_name_b
);
3109 /** Compares documents by their tab order.
3110 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3112 * @param a @c GeanyDocument**.
3113 * @param b @c GeanyDocument**.
3114 * @warning The arguments take the address of each document pointer.
3115 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3117 * @since 0.21 (GEANY_API_VERSION 209)
3119 gint
document_compare_by_tab_order(gconstpointer a
, gconstpointer b
)
3121 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3122 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3123 gint notebook_position_doc_a
;
3124 gint notebook_position_doc_b
;
3126 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3127 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3129 if (notebook_position_doc_a
< notebook_position_doc_b
)
3131 if (notebook_position_doc_a
> notebook_position_doc_b
)
3138 /** Compares documents by their tab order, in reverse order.
3139 * This matches @c GCompareFunc for use with e.g. @c g_ptr_array_sort().
3141 * @param a @c GeanyDocument**.
3142 * @param b @c GeanyDocument**.
3143 * @warning The arguments take the address of each document pointer.
3144 * @return Negative value if a < b; zero if a = b; positive value if a > b.
3146 * @since 0.21 (GEANY_API_VERSION 209)
3148 gint
document_compare_by_tab_order_reverse(gconstpointer a
, gconstpointer b
)
3150 GeanyDocument
*doc_a
= *((GeanyDocument
**) a
);
3151 GeanyDocument
*doc_b
= *((GeanyDocument
**) b
);
3152 gint notebook_position_doc_a
;
3153 gint notebook_position_doc_b
;
3155 notebook_position_doc_a
= document_get_notebook_page(doc_a
);
3156 notebook_position_doc_b
= document_get_notebook_page(doc_b
);
3158 if (notebook_position_doc_a
< notebook_position_doc_b
)
3160 if (notebook_position_doc_a
> notebook_position_doc_b
)
3167 void document_grab_focus(GeanyDocument
*doc
)
3169 g_return_if_fail(doc
!= NULL
);
3171 gtk_widget_grab_focus(GTK_WIDGET(doc
->editor
->sci
));