diff options
Diffstat (limited to 'gedit/gedit-file-chooser.c')
| -rw-r--r-- | gedit/gedit-file-chooser.c | 785 |
1 files changed, 785 insertions, 0 deletions
diff --git a/gedit/gedit-file-chooser.c b/gedit/gedit-file-chooser.c new file mode 100644 index 0000000..a5c9547 --- /dev/null +++ b/gedit/gedit-file-chooser.c @@ -0,0 +1,785 @@ +/* + * This file is part of gedit + * + * Copyright (C) 2020 Sébastien Wilmet <swilmet@gnome.org> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, see <http://www.gnu.org/licenses/>. + */ + +#include "gedit-file-chooser.h" +#include <glib/gi18n.h> +#include "gedit-settings.h" + +/* Common code between the different GeditFileChooser's. */ + +struct _GeditFileChooserPrivate +{ + GtkFileChooser *gtk_chooser; +}; + +enum +{ + SIGNAL_DONE, + N_SIGNALS +}; + +static guint signals[N_SIGNALS]; + +G_DEFINE_TYPE_WITH_PRIVATE (GeditFileChooser, _gedit_file_chooser, G_TYPE_OBJECT) + +#define ALL_FILES _("All Files") +#define ALL_TEXT_FILES _("All Text Files") + +/* Whether to use GtkFileChooserNative or GtkFileChooserDialog. */ +gboolean +_gedit_file_chooser_is_native (void) +{ + /* TODO: finish the implementation of the native variants. */ + return FALSE; +} + +static gboolean +mime_types_are_supported (void) +{ +/* Note that the #ifdef could be moved to where this function is called, to have + * much more code between the #ifdef/#else/#endif. The goal is to always compile + * all the code on all platforms, to catch compilation problems earlier. + */ +#ifdef G_OS_WIN32 + /* See the GtkFileChooserNative documentation, a GtkFileFilter with + * mime-types is not supported on Windows. + */ + return FALSE; +#else + return TRUE; +#endif +} + +/* Returns: (transfer none) (element-type utf8): a list containing "text/plain" + * and "application/x-zerosize" first and then the list of mime-types unrelated + * to "text/plain" and not equal to "application/x-zerosize" that GtkSourceView + * supports for the syntax highlighting. + */ +static GSList * +get_supported_mime_types (void) +{ + static GSList *supported_mime_types = NULL; + static gboolean initialized = FALSE; + + GtkSourceLanguageManager *language_manager; + const gchar * const *language_ids; + gint language_num; + + if (initialized) + { + return supported_mime_types; + } + + language_manager = gtk_source_language_manager_get_default (); + language_ids = gtk_source_language_manager_get_language_ids (language_manager); + for (language_num = 0; language_ids != NULL && language_ids[language_num] != NULL; language_num++) + { + const gchar *cur_language_id = language_ids[language_num]; + GtkSourceLanguage *language; + gchar **mime_types; + gint mime_type_num; + + language = gtk_source_language_manager_get_language (language_manager, cur_language_id); + mime_types = gtk_source_language_get_mime_types (language); + + if (mime_types == NULL) + { + continue; + } + + for (mime_type_num = 0; mime_types[mime_type_num] != NULL; mime_type_num++) + { + const gchar *cur_mime_type = mime_types[mime_type_num]; + + if (!g_content_type_is_a (cur_mime_type, "text/plain") && + !g_content_type_equals (cur_mime_type, "application/x-zerosize")) + { + //g_message ("Mime-type '%s' is not related to 'text/plain'", cur_mime_type); + supported_mime_types = g_slist_prepend (supported_mime_types, + g_strdup (cur_mime_type)); + } + } + + g_strfreev (mime_types); + } + + supported_mime_types = g_slist_prepend (supported_mime_types, g_strdup ("application/x-zerosize")); + + // Note that all "text/*" mime-types are subclasses of "text/plain", see: + // https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html#subclassing + supported_mime_types = g_slist_prepend (supported_mime_types, g_strdup ("text/plain")); + + initialized = TRUE; + return supported_mime_types; +} + +static const gchar * const * +get_supported_globs (void) +{ + /* List generated with Tepl's shared-mime-info-list-text-plain-globs + * tool. + * + * TODO: can be improved by including globs from GtkSourceLanguage's. + */ + static const gchar * const supported_globs[] = + { + "*.abw", + "*.adb", + "*.ads", + "*.al", + "*.asc", + "*.asp", + "*.ass", + "*.atom", + "*.automount", + "*.awk", + "*.bib", + "*.build", + "*.c", + "*.c++", + "*.cbl", + "*.cc", + "*.ccmx", + "*.cl", + "*.cls", + "*.cmake", + "*.cob", + "*.coffee", + "*.cpp", + "*.cs", + "*.csh", + "*.css", + "*.csv", + "*.csvs", + "*.cue", + "*.cxx", + "*.d", + "*.dbk", + "*.dcl", + "*.desktop", + "*.device", + "*.di", + "*.dia", + "*.diff", + "*.docbook", + "*.dot", + "*.dsl", + "*.dtd", + "*.dtx", + "*.e", + "*.eif", + "*.el", + "*.eml", + "*.ent", + "*.eps", + "*.epsf", + "*.epsi", + "*.erl", + "*.es", + "*.etx", + "*.f", + "*.f90", + "*.f95", + "*.fb2", + "*.feature", + "*.fl", + "*.flatpakref", + "*.flatpakrepo", + "*.fo", + "*.fodg", + "*.fodp", + "*.fods", + "*.fodt", + "*.for", + "*.gcode", + "*.gcrd", + "*.geojson", + "*.glade", + "*.gml", + "*.gnuplot", + "*.go", + "*.gp", + "*.gpg", + "*.gplt", + "*.gpx", + "*.gradle", + "*.groovy", + "*.gs", + "*.gsf", + "*.gsh", + "*.gv", + "*.gvp", + "*.gvy", + "*.gy", + "*.h", + "*.h++", + "*.hh", + "*.hp", + "*.hpp", + "*.hs", + "*.htm", + "*.html", + "*.hxx", + "*.ica", + "*.ics", + "*.idl", + "*.iges", + "*.igs", + "*.ime", + "*.imy", + "*.ins", + "*.iptables", + "*.ipynb", + "*.it87", + "*.jad", + "*.java", + "*.jnlp", + "*.jrd", + "*.js", + "*.jsm", + "*.json", + "*.jsonld", + "*.json-patch", + "*.kdelnk", + "*.key", + "*.kino", + "*.kml", + "*.la", + "*.latex", + "*.ldif", + "*.lhs", + "*.log", + "*.ltx", + "*.lua", + "*.ly", + "*.lyx", + "*.m", + "*.m1u", + "*.m3u", + "*.m3u8", + "*.m4", + "*.m4u", + "*.mab", + "*.mak", + "*.man", + "*.manifest", + "*.markdown", + "*.mbox", + "*.mc2", + "*.md", + "*.me", + "*.meta4", + "*.metalink", + "*.mgp", + "*.mjs", + "*.mk", + "*.mkd", + "*.ml", + "*.mli", + "*.mm", + "*.mml", + "*.mo", + "*.moc", + "*.mof", + "*.mount", + "*.mrl", + "*.mrml", + "*.ms", + "*.mup", + "*.mxu", + "*.nb", + "*.nfo", + "*.not", + "*.nzb", + "*.ocl", + "*.ooc", + "*.opml", + "*.owl", + "*.owx", + "*.p", + "*.p7s", + "*.pas", + "*.patch", + "*.path", + "*.perl", + "*.pfa", + "*.pfb", + "*.pgn", + "*.pgp", + "*.php", + "*.php3", + "*.php4", + "*.php5", + "*.phps", + "*.pkr", + "*.pl", + "*.pm", + "*.po", + "*.pod", + "*.pot", + "*.ps", + "*.py", + "*.py3", + "*.py3x", + "*.pyx", + "*.qml", + "*.qmlproject", + "*.qmltypes", + "*.qti", + "*.raml", + "*.rb", + "*.rdf", + "*.rdfs", + "*.rej", + "*.rnc", + "*.rng", + "*.roff", + "*.rs", + "*.rss", + "*.rst", + "*.rt", + "*.rtf", + "*.rtx", + "*.sami", + "*.sass", + "*.scala", + "*.scm", + "*.scope", + "*.scss", + "*.sdp", + "*.service", + "*.sgf", + "*.sgm", + "*.sgml", + "*.sh", + "*.shape", + "*.sig", + "*.siv", + "*.skr", + "*.slice", + "*.slk", + "*.smi", + "*.smil", + "*.sml", + "*.socket", + "*.spec", + "*.sql", + "*.src", + "*.srt", + "*.ss", + "*.ssa", + "*.sty", + "*.sub", + "*.sv", + "*.svg", + "*.svh", + "*.swap", + "*.sylk", + "*.t", + "*.t2t", + "*.target", + "*.tcl", + "*.tex", + "*.texi", + "*.texinfo", + "*.theme", + "*.timer", + "*.tk", + "*.toc", + "*.tr", + "*.trig", + "*.ts", + "*.tsv", + "*.ttl", + "*.ttx", + "*.twig", + "*.txt", + "*.ufraw", + "*.ui", + "*.uil", + "*.uue", + "*.v", + "*.vala", + "*.vapi", + "*.vcard", + "*.vcf", + "*.vcs", + "*.vct", + "*.vhd", + "*.vhdl", + "*.vlc", + "*.vrm", + "*.vrml", + "*.vtt", + "*.wml", + "*.wmls", + "*.wrl", + "*.wsgi", + "*.xbel", + "*.xbl", + "*.xht", + "*.xhtml", + "*.xlf", + "*.xliff", + "*.xmi", + "*.xml", + "*.xsd", + "*.xsl", + "*.xslfo", + "*.xslt", + "*.xspf", + "*.xul", + "*.yaml", + "*.yml", + "*.zabw", + NULL + }; + + return supported_globs; +} + +static GtkFileFilter * +create_all_text_files_filter (void) +{ + GtkFileFilter *filter; + + filter = gtk_file_filter_new (); + gtk_file_filter_set_name (filter, ALL_TEXT_FILES); + + if (mime_types_are_supported ()) + { + GSList *supported_mime_types; + GSList *l; + + supported_mime_types = get_supported_mime_types (); + for (l = supported_mime_types; l != NULL; l = l->next) + { + const gchar *mime_type = l->data; + + gtk_file_filter_add_mime_type (filter, mime_type); + } + + /* FIXME: use globs too - Paolo (Aug. 27, 2007). + * + * Yes, use globs too - swilmet (June 2020). Get the list of + * globs from GtkSourceLanguage's, and add them to the filter + * (only those that are not covered by a previously added + * mime-type). Note that the list of extra globs here must be + * computed differently than the list of extra globs for + * get_supported_globs() (see the TODO comment there). + */ + } + else + { + const gchar * const *supported_globs; + gint i; + + supported_globs = get_supported_globs (); + for (i = 0; supported_globs != NULL && supported_globs[i] != NULL; i++) + { + const gchar *glob = supported_globs[i]; + + gtk_file_filter_add_pattern (filter, glob); + } + } + + return filter; +} + +static void +notify_filter_cb (GtkFileChooser *gtk_chooser, + GParamSpec *pspec, + gpointer user_data) +{ + GtkFileFilter *filter; + const gchar *name; + gint id = 0; + GeditSettings *settings; + GSettings *file_chooser_state_settings; + + /* Remember the selected filter. */ + + filter = gtk_file_chooser_get_filter (gtk_chooser); + if (filter == NULL) + { + return; + } + + name = gtk_file_filter_get_name (filter); + if (g_strcmp0 (name, ALL_FILES) == 0) + { + id = 1; + } + + settings = _gedit_settings_get_singleton (); + file_chooser_state_settings = _gedit_settings_peek_file_chooser_state_settings (settings); + g_settings_set_int (file_chooser_state_settings, GEDIT_SETTINGS_ACTIVE_FILE_FILTER, id); +} + +static void +setup_filters (GeditFileChooser *chooser) +{ + GeditSettings *settings; + GSettings *file_chooser_state_settings; + gint active_filter; + GtkFileFilter *filter; + + settings = _gedit_settings_get_singleton (); + file_chooser_state_settings = _gedit_settings_peek_file_chooser_state_settings (settings); + active_filter = g_settings_get_int (file_chooser_state_settings, GEDIT_SETTINGS_ACTIVE_FILE_FILTER); + + /* "All Text Files" filter */ + filter = create_all_text_files_filter (); + + g_object_ref_sink (filter); + gtk_file_chooser_add_filter (chooser->priv->gtk_chooser, filter); + if (active_filter != 1) + { + /* Use this filter if set by user and as default. */ + gtk_file_chooser_set_filter (chooser->priv->gtk_chooser, filter); + } + g_object_unref (filter); + + /* "All Files" filter */ + filter = gtk_file_filter_new (); + gtk_file_filter_set_name (filter, ALL_FILES); + gtk_file_filter_add_pattern (filter, "*"); + + g_object_ref_sink (filter); + gtk_file_chooser_add_filter (chooser->priv->gtk_chooser, filter); + if (active_filter == 1) + { + /* Use this filter if set by user. */ + gtk_file_chooser_set_filter (chooser->priv->gtk_chooser, filter); + } + g_object_unref (filter); + + g_signal_connect (chooser->priv->gtk_chooser, + "notify::filter", + G_CALLBACK (notify_filter_cb), + NULL); +} + +/* Set the dialog as modal. It's a workaround for this bug: + * https://gitlab.gnome.org/GNOME/gtk/issues/2824 + * "GtkNativeDialog: non-modal and gtk_native_dialog_show(), doesn't present the + * window" + * + * - For opening files: drag-and-drop files from the file chooser to the + * GeditWindow: OK, it still works. + * - Other main windows not being "blocked"/insensitive (GtkWindowGroup): OK, + * calling gtk_native_dialog_set_transient_for() does the right thing. + * + * Even if the above GTK bug is fixed, the file chooser can be kept modal, + * except if there was a good reason for not being modal (what reason(s)?). + */ +static void +set_modal (GeditFileChooser *chooser) +{ + if (_gedit_file_chooser_is_native ()) + { + gtk_native_dialog_set_modal (GTK_NATIVE_DIALOG (chooser->priv->gtk_chooser), TRUE); + } + else + { + gtk_window_set_modal (GTK_WINDOW (chooser->priv->gtk_chooser), TRUE); + } +} + +static void +response_cb (GtkFileChooser *gtk_chooser, + gint response_id, + GeditFileChooser *chooser) +{ + gboolean accept; + + accept = response_id == GTK_RESPONSE_ACCEPT; + g_signal_emit (chooser, signals[SIGNAL_DONE], 0, accept); +} + +static void +_gedit_file_chooser_constructed (GObject *object) +{ + GeditFileChooser *chooser = GEDIT_FILE_CHOOSER (object); + GeditFileChooserClass *klass = GEDIT_FILE_CHOOSER_GET_CLASS (chooser); + + if (G_OBJECT_CLASS (_gedit_file_chooser_parent_class)->constructed != NULL) + { + G_OBJECT_CLASS (_gedit_file_chooser_parent_class)->constructed (object); + } + + if (klass->create_gtk_file_chooser != NULL) + { + g_return_if_fail (chooser->priv->gtk_chooser == NULL); + chooser->priv->gtk_chooser = klass->create_gtk_file_chooser (chooser); + + setup_filters (chooser); + set_modal (chooser); + gtk_file_chooser_set_local_only (chooser->priv->gtk_chooser, FALSE); + + g_signal_connect_object (chooser->priv->gtk_chooser, + "response", + G_CALLBACK (response_cb), + chooser, + 0); + } +} + +static void +_gedit_file_chooser_dispose (GObject *object) +{ + GeditFileChooser *chooser = GEDIT_FILE_CHOOSER (object); + + if (chooser->priv->gtk_chooser != NULL) + { + if (_gedit_file_chooser_is_native ()) + { + g_object_unref (chooser->priv->gtk_chooser); + } + else + { + gtk_widget_destroy (GTK_WIDGET (chooser->priv->gtk_chooser)); + } + + chooser->priv->gtk_chooser = NULL; + } + + G_OBJECT_CLASS (_gedit_file_chooser_parent_class)->dispose (object); +} + +static void +_gedit_file_chooser_class_init (GeditFileChooserClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->constructed = _gedit_file_chooser_constructed; + object_class->dispose = _gedit_file_chooser_dispose; + + /* + * GeditFileChooser::done: + * @chooser: the #GeditFileChooser emitting the signal. + * @accept: whether the response code is %GTK_RESPONSE_ACCEPT. + */ + signals[SIGNAL_DONE] = + g_signal_new ("done", + G_TYPE_FROM_CLASS (klass), + G_SIGNAL_RUN_FIRST, + 0, NULL, NULL, NULL, + G_TYPE_NONE, + 1, G_TYPE_BOOLEAN); +} + +static void +_gedit_file_chooser_init (GeditFileChooser *chooser) +{ + chooser->priv = _gedit_file_chooser_get_instance_private (chooser); +} + +GeditFileChooser * +_gedit_file_chooser_new (void) +{ + return g_object_new (GEDIT_TYPE_FILE_CHOOSER, NULL); +} + +/* TODO: this function will go away. */ +void +_gedit_file_chooser_set_gtk_file_chooser (GeditFileChooser *chooser, + GtkFileChooser *gtk_chooser) +{ + g_return_if_fail (GEDIT_IS_FILE_CHOOSER (chooser)); + g_return_if_fail (GTK_IS_FILE_CHOOSER (gtk_chooser)); + g_return_if_fail (chooser->priv->gtk_chooser == NULL); + + chooser->priv->gtk_chooser = g_object_ref_sink (gtk_chooser); + setup_filters (chooser); +} + +GtkFileChooser * +_gedit_file_chooser_get_gtk_file_chooser (GeditFileChooser *chooser) +{ + g_return_val_if_fail (GEDIT_IS_FILE_CHOOSER (chooser), NULL); + return chooser->priv->gtk_chooser; +} + +void +_gedit_file_chooser_set_transient_for (GeditFileChooser *chooser, + GtkWindow *parent) +{ + g_return_if_fail (GEDIT_IS_FILE_CHOOSER (chooser)); + g_return_if_fail (parent == NULL || GTK_IS_WINDOW (parent)); + + if (_gedit_file_chooser_is_native ()) + { + gtk_native_dialog_set_transient_for (GTK_NATIVE_DIALOG (chooser->priv->gtk_chooser), parent); + } + else + { + gtk_window_set_transient_for (GTK_WINDOW (chooser->priv->gtk_chooser), parent); + + if (parent != NULL) + { + gtk_window_set_destroy_with_parent (GTK_WINDOW (chooser->priv->gtk_chooser), TRUE); + } + } +} + +void +_gedit_file_chooser_show (GeditFileChooser *chooser) +{ + g_return_if_fail (GEDIT_IS_FILE_CHOOSER (chooser)); + + if (_gedit_file_chooser_is_native ()) + { + gtk_native_dialog_show (GTK_NATIVE_DIALOG (chooser->priv->gtk_chooser)); + } + else + { + gtk_window_present (GTK_WINDOW (chooser->priv->gtk_chooser)); + } +} + +gchar * +_gedit_file_chooser_get_current_folder_uri (GeditFileChooser *chooser) +{ + g_return_val_if_fail (GEDIT_IS_FILE_CHOOSER (chooser), NULL); + + return gtk_file_chooser_get_current_folder_uri (chooser->priv->gtk_chooser); +} + +void +_gedit_file_chooser_set_current_folder_uri (GeditFileChooser *chooser, + const gchar *uri) +{ + g_return_if_fail (GEDIT_IS_FILE_CHOOSER (chooser)); + + gtk_file_chooser_set_current_folder_uri (chooser->priv->gtk_chooser, uri); +} + +const GtkSourceEncoding * +_gedit_file_chooser_get_encoding (GeditFileChooser *chooser) +{ + GeditFileChooserClass *klass; + + g_return_val_if_fail (GEDIT_IS_FILE_CHOOSER (chooser), NULL); + + klass = GEDIT_FILE_CHOOSER_GET_CLASS (chooser); + g_return_val_if_fail (klass->get_encoding != NULL, NULL); + + return klass->get_encoding (chooser); +} |