4aiman/thunar-usagebars
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
thunar-usagebars/thunarx/thunarx-renamer.c
4aiman e969f94310 thunar 4.20.2 upstream 
Tree of tag thunar-4.20.2 (commit 11a519f) from https://gitlab.xfce.org/xfce/thunar.
Upstream history is not included here to keep the repository small.
2026-11-03 22:42:48 +03:00

744 lines
25 KiB
C
Raw Permalink Blame History

/* vi:set et ai sw=2 sts=2 ts=2: */
/*-
* Copyright (c) 2005-2006 Benedikt Meurer <benny@xfce.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "thunarx/thunarx-private.h"
#include "thunarx/thunarx-renamer.h"
#include <glib/gi18n-lib.h>
#include <libxfce4util/libxfce4util.h>
/* Property identifiers */
enum
{
PROP_0,
PROP_HELP_URL,
PROP_NAME,
};
/* Signal identifiers */
enum
{
CHANGED,
LAST_SIGNAL,
};
/**
* SECTION: thunarx-renamer
* @short_description: The abstract base class for bulk renamers
* @title: ThunarxRenamer
* @include: thunarx/thunarx.h
* @image: bulk-rename.png
*
* The abstract base class <type>ThunarxRenamer</type> is implemented by
* extensions which provide additional bulk renamers that should be used in
* the bulk rename dialog.
*
* Derived classes must override the thunarx_renamer_process() method, which
* is called by the bulk rename dialog for every file to generate a new name. For
* example, the <type>ThunarSbrReplaceRenamer</type> class included in the
* <literal>thunar-sbr</literal> plugin (which is part of the Thunar distribution)
* provides a bulk renamer, named <emphasis>Search &amp; Replace</emphasis>,
* which allows the user to rename multiple files by searching for a pattern in
* each file name and, if the pattern is found, replacing it with the specified
* replacement text.
*
* The active <type>ThunarxRenamer</type>s user interface is displayed in a frame
* below the file list, as shown in the screenshot above. Derived classes should try
* to limit the number of widgets displayed in the main user interface. For example,
* if you have more than six settings, you should consider adding an <guibutton>Advanced</guibutton>,
* button which opens a dialog with the additional settings.
*/
static void
thunarx_renamer_finalize (GObject *object);
static GObject *
thunarx_renamer_constructor (GType type,
guint n_construct_properties,
GObjectConstructParam *construct_properties);
static void
thunarx_renamer_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void
thunarx_renamer_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static gchar *
thunarx_renamer_real_process (ThunarxRenamer *renamer,
ThunarxFileInfo *file,
const gchar *text,
guint num);
static void
thunarx_renamer_real_load (ThunarxRenamer *renamer,
GHashTable *settings);
static void
thunarx_renamer_real_save (ThunarxRenamer *renamer,
GHashTable *settings);
static GList *
thunarx_renamer_real_get_menu_items (ThunarxRenamer *renamer,
GtkWindow *window,
GList *files);
struct _ThunarxRenamerPrivate
{
gchar *help_url;
gchar *name;
};
static guint renamer_signals[LAST_SIGNAL];
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ThunarxRenamer, thunarx_renamer, GTK_TYPE_BOX)
static void
thunarx_renamer_class_init (ThunarxRenamerClass *klass)
{
GObjectClass *gobject_class;
gobject_class = G_OBJECT_CLASS (klass);
gobject_class->finalize = thunarx_renamer_finalize;
gobject_class->constructor = thunarx_renamer_constructor;
gobject_class->get_property = thunarx_renamer_get_property;
gobject_class->set_property = thunarx_renamer_set_property;
klass->process = thunarx_renamer_real_process;
klass->load = thunarx_renamer_real_load;
klass->save = thunarx_renamer_real_save;
klass->get_menu_items = thunarx_renamer_real_get_menu_items;
/**
* ThunarxRenamer:help-url:
*
* The URL to the documentation of this #ThunarxRenamer.
* Derived classes can set this property to point to the
* documentation for the specific renamer. The documentation
* of the specific renamer in turn should contain a link to
* the general Thunar renamer documentation.
*
* May also be unset, in which case the general Thunar renamer
* documentation will be shown when the user clicks the "Help"
* button.
**/
g_object_class_install_property (gobject_class,
PROP_HELP_URL,
g_param_spec_string ("help-url",
_("Help URL"),
_("The URL to the documentation of the renamer"),
NULL,
G_PARAM_READWRITE));
/**
* ThunarxRenamer:name:
*
* The user visible name of the renamer, that is displayed
* in the bulk rename dialog of the file manager. Derived
* classes should set a useful name.
**/
g_object_class_install_property (gobject_class,
PROP_NAME,
g_param_spec_string ("name",
_("Name"),
_("The user visible name of the renamer"),
NULL,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE));
/**
* ThunarxRenamer::changed:
* @renamer : a #ThunarxRenamer.
*
* Derived classes should emit this signal using the
* thunarx_renamer_changed() method whenever the user
* changed a setting in the @renamer GUI.
*
* The file manager will then invoke thunarx_renamer_process()
* for all files that should be renamed and update the preview.
**/
renamer_signals[CHANGED] =
g_signal_new (I_ ("changed"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (ThunarxRenamerClass, changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
}
static void
thunarx_renamer_init (ThunarxRenamer *renamer)
{
/* grab a pointer on the private data */
renamer->priv = thunarx_renamer_get_instance_private (renamer);
/* initialize the GtkBox to sane defaults */
gtk_orientable_set_orientation (GTK_ORIENTABLE (renamer), GTK_ORIENTATION_VERTICAL);
gtk_container_set_border_width (GTK_CONTAINER (renamer), 12);
gtk_box_set_homogeneous (GTK_BOX (renamer), FALSE);
gtk_box_set_spacing (GTK_BOX (renamer), 6);
}
static void
thunarx_renamer_finalize (GObject *object)
{
ThunarxRenamer *renamer = THUNARX_RENAMER (object);
/* release private attributes */
g_free (renamer->priv->help_url);
g_free (renamer->priv->name);
(*G_OBJECT_CLASS (thunarx_renamer_parent_class)->finalize) (object);
}
static GObject *
thunarx_renamer_constructor (GType type,
guint n_construct_properties,
GObjectConstructParam *construct_properties)
{
GObject *object;
/* let the parent class constructor create the instance */
object = (*G_OBJECT_CLASS (thunarx_renamer_parent_class)->constructor) (type, n_construct_properties, construct_properties);
/* check if a name was set, otherwise use the type name */
if (G_UNLIKELY (THUNARX_RENAMER (object)->priv->name == NULL))
thunarx_renamer_set_name (THUNARX_RENAMER (object), g_type_name (type));
return object;
}
static void
thunarx_renamer_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
ThunarxRenamer *renamer = THUNARX_RENAMER (object);
switch (prop_id)
{
case PROP_HELP_URL:
g_value_set_string (value, thunarx_renamer_get_help_url (renamer));
break;
case PROP_NAME:
g_value_set_string (value, thunarx_renamer_get_name (renamer));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
thunarx_renamer_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
ThunarxRenamer *renamer = THUNARX_RENAMER (object);
switch (prop_id)
{
case PROP_HELP_URL:
thunarx_renamer_set_help_url (renamer, g_value_get_string (value));
break;
case PROP_NAME:
thunarx_renamer_set_name (renamer, g_value_get_string (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static gchar *
thunarx_renamer_real_process (ThunarxRenamer *renamer,
ThunarxFileInfo *file,
const gchar *text,
guint num)
{
/* the fallback method simply returns a copy of text */
return g_strdup (text);
}
static void
thunarx_renamer_real_load (ThunarxRenamer *renamer,
GHashTable *settings)
{
const gchar *setting;
GParamSpec **specs;
GValue value = {
0,
};
GValue tmp = {
0,
};
gchar *key;
guint n_specs;
guint n;
/* determine the parameters provided this class (and superclasses) */
specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (renamer), &n_specs);
for (n = 0; n < n_specs; ++n)
{
/* check if this parameter is introduced by ThunarxRenamer or a superclass of it, and ignore such parameters. */
if (!g_type_is_a (specs[n]->owner_type, THUNARX_TYPE_RENAMER) || specs[n]->owner_type == THUNARX_TYPE_RENAMER)
continue;
/* verify that the type can be transformed from strings */
if (!g_value_type_transformable (G_TYPE_STRING, specs[n]->value_type))
continue;
/* determine the key for the parameter */
key = thunarx_param_spec_get_option_name (specs[n]);
/* check if we have a value for that key */
setting = g_hash_table_lookup (settings, key);
if (G_LIKELY (setting != NULL))
{
/* initialize the value as the value type */
g_value_init (&value, specs[n]->value_type);
/* transform the setting to the value type */
g_value_init (&tmp, G_TYPE_STRING);
g_value_set_static_string (&tmp, setting);
g_value_transform (&tmp, &value);
g_value_unset (&tmp);
/* apply the value to the property */
g_object_set_property (G_OBJECT (renamer), specs[n]->name, &value);
/* cleanup */
g_value_unset (&value);
}
/* cleanup */
g_free (key);
}
g_free (specs);
}
static void
thunarx_renamer_real_save (ThunarxRenamer *renamer,
GHashTable *settings)
{
GParamSpec **specs;
GValue value = {
0,
};
GValue tmp = {
0,
};
guint n_specs;
guint n;
/* determine the parameters provided this class (and superclasses) */
specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (renamer), &n_specs);
for (n = 0; n < n_specs; ++n)
{
/* check if this parameter is introduced by ThunarxRenamer or a superclass of it, and ignore such parameters. */
if (!g_type_is_a (specs[n]->owner_type, THUNARX_TYPE_RENAMER) || specs[n]->owner_type == THUNARX_TYPE_RENAMER)
continue;
/* verify that the type can be transformed to strings */
if (!g_value_type_transformable (specs[n]->value_type, G_TYPE_STRING))
continue;
/* initialize the value as string */
g_value_init (&value, G_TYPE_STRING);
/* transform the property value to a string */
g_value_init (&tmp, specs[n]->value_type);
g_object_get_property (G_OBJECT (renamer), specs[n]->name, &tmp);
g_value_transform (&tmp, &value);
g_value_unset (&tmp);
/* save the value to the settings (replacing any existing settings with that name) */
g_hash_table_replace (settings, thunarx_param_spec_get_option_name (specs[n]), g_value_dup_string (&value));
/* cleanup */
g_value_unset (&value);
}
g_free (specs);
}
static GList *
thunarx_renamer_real_get_menu_items (ThunarxRenamer *renamer,
GtkWindow *window,
GList *files)
{
/* return an empty list, derived classes may override this method */
return NULL;
}
/**
* thunarx_renamer_get_help_url:
* @renamer : a #ThunarxRenamer.
*
* Returns the URL of the documentation for @renamer
* or %NULL if no specific documentation is available
* for @renamer and the general documentation of the
* Thunar renamers should be displayed instead.
*
* Return value: the URL of the documentation for @renamer.
**/
const gchar *
thunarx_renamer_get_help_url (ThunarxRenamer *renamer)
{
g_return_val_if_fail (THUNARX_IS_RENAMER (renamer), NULL);
return renamer->priv->help_url;
}
/**
* thunarx_renamer_set_help_url:
* @renamer : a #ThunarxRenamer.
* @help_url : the new URL to the documentation of @renamer.
*
* The URL to the documentation of this #ThunarxRenamer.
* Derived classes can set this property to point to the
* documentation for the specific renamer. The documentation
* of the specific renamer in turn should contain a link to
* the general Thunar renamer documentation.
*
* May also be unset, in which case the general Thunar renamer
* documentation will be shown when the user clicks the "Help"
* button.
**/
void
thunarx_renamer_set_help_url (ThunarxRenamer *renamer,
const gchar *help_url)
{
g_return_if_fail (THUNARX_IS_RENAMER (renamer));
/* release the previous value */
g_free (renamer->priv->help_url);
/* apply the new value */
renamer->priv->help_url = g_strdup (help_url);
/* notify listeners */
g_object_notify (G_OBJECT (renamer), "help-url");
}
/**
* thunarx_renamer_get_name:
* @renamer : a #ThunarxRenamer.
*
* Returns the user visible name for @renamer, previously
* set with thunarx_renamer_set_name().
*
* Return value: the user visible name for @renamer.
**/
const gchar *
thunarx_renamer_get_name (ThunarxRenamer *renamer)
{
g_return_val_if_fail (THUNARX_IS_RENAMER (renamer), NULL);
return renamer->priv->name;
}
/**
* thunarx_renamer_set_name:
* @renamer : a #ThunarxRenamer.
* @name : the new user visible name for @renamer.
*
* Sets the user visible name for @renamer to @name. This method should
* only be called by derived classes and prior to returning the @renamer
* is returned from thunarx_renamer_provider_get_renamers().
**/
void
thunarx_renamer_set_name (ThunarxRenamer *renamer,
const gchar *name)
{
g_return_if_fail (THUNARX_IS_RENAMER (renamer));
/* release the previous name */
g_free (renamer->priv->name);
/* setup the new name */
renamer->priv->name = g_strdup (name);
/* notify listeners */
g_object_notify (G_OBJECT (renamer), "name");
}
/**
* thunarx_renamer_process:
* @renamer : a #ThunarxRenamer.
* @file : the #ThunarxFileInfo for the file whose new
* name - according to @renamer - should be
* determined.
* @text : the part of the filename to which the
* @renamer should be applied.
* @index : the index of the file in the list, used
* for renamers that work on numbering.
*
* Determines the replacement for @text (which is the relevant
* part of the full @file name, i.e. either the suffix, the name
* or the name and the suffix).
*
* The caller is responsible to free the returned string using
* g_free() when no longer needed.
*
* Return value: the string with which to replace @text.
**/
gchar *
thunarx_renamer_process (ThunarxRenamer *renamer,
ThunarxFileInfo *file,
const gchar *text,
guint index)
{
g_return_val_if_fail (THUNARX_IS_FILE_INFO (file), NULL);
g_return_val_if_fail (THUNARX_IS_RENAMER (renamer), NULL);
g_return_val_if_fail (g_utf8_validate (text, -1, NULL), NULL);
return (*THUNARX_RENAMER_GET_CLASS (renamer)->process) (renamer, file, text, index);
}
/**
* thunarx_renamer_load:
* @renamer : a #ThunarxRenamer.
* @settings : a #GHashTable which contains the previously saved
* settings for @renamer as key/value pairs of strings.
*
* Tells @renamer to load its internal settings from the specified
* @settings. The @settings hash table contains previously saved
* settings, see thunarx_renamer_save(), as key/value pairs of
* strings. That is, both the keys and the values are strings.
*
* Implementations of #ThunarxRenamer may decide to override this
* method to perform custom loading of settings. If you do not
* override this method, the default method of #ThunarxRenamer
* will be used, which simply loads all #GObject properties
* provided by @renamer<!---->s class (excluding the ones
* provided by the parent classes) from the @settings. The
* #GObject properties must be transformable to strings and
* from strings.
*
* If you decide to override this method for your #ThunarxRenamer
* implementation, you should also override thunarx_renamer_save().
**/
void
thunarx_renamer_load (ThunarxRenamer *renamer,
GHashTable *settings)
{
g_return_if_fail (THUNARX_IS_RENAMER (renamer));
g_return_if_fail (settings != NULL);
(*THUNARX_RENAMER_GET_CLASS (renamer)->load) (renamer, settings);
}
/**
* thunarx_renamer_save:
* @renamer : a #ThunarxRenamer.
* @settings : a #GHashTable to which the current settings of @renamer
* should be stored as key/value pairs of strings.
*
* Tells @renamer to save its internal settings to the specified
* @settings, which can afterwards be loaded by thunarx_renamer_load().
*
* The strings saved to @settings must be allocated by g_strdup(),
* both the keys and the values. For example to store the string
* <literal>Bar</literal> for the setting <literal>Foo</literal>,
* you'd use:
* <informalexample><programlisting>
* g_hash_table_replace (settings, g_strdup ("Foo"), g_strdup ("Bar"));
* </programlisting></informalexample>
*
* Implementations of #ThunarxRenamer may decide to override this
* method to perform custom saving of settings. If you do not overrride
* this method, the default method of #ThunarxRenamer will be used,
* which simply stores all #GObject properties provided by the
* @renamer<!---->s class (excluding the ones provided by the parent
* classes) to the @settings. The #GObject properties must be transformable
* to strings.
*
* If you decide to override this method for your #ThunarxRenamer
* implementation, you should also override thunarx_renamer_load().
**/
void
thunarx_renamer_save (ThunarxRenamer *renamer,
GHashTable *settings)
{
g_return_if_fail (THUNARX_IS_RENAMER (renamer));
g_return_if_fail (settings != NULL);
(*THUNARX_RENAMER_GET_CLASS (renamer)->save) (renamer, settings);
}
/**
* thunarx_renamer_get_menu_items:
* @renamer: a #ThunarxRenamer.
* @window: a #GtkWindow or %NULL.
* @files: (element-type ThunarxFileInfo): a #GList of #ThunarxFileInfo<!---->s.
*
* Returns the list of #ThunarxMenuItem<!---->s provided by @renamer for
* the given list of @files. By default, this method returns %NULL
* (the empty list), but derived classes may override this method
* to provide additional items for files in the bulk renamer
* dialog list.
*
* The returned #ThunarxMenuItem<!---->s will be displayed in the file's
* context menu of the bulk renamer dialog, when this @renamer is
* active. For example, an ID3-Tag based renamer may add an menu item
* "Edit Tags" to the context menus of supported media files and,
* when activated, display a dialog (which should be transient and
* modal for @window, if not %NULL), which allows the users to edit
* media file tags on-the-fly.
*
* Derived classes that override this method should always check
* first if all the #ThunarxFileInfo<!---->s in the list of @files
* are supported, and only return menu items that can be performed on
* this specific list of @files. For example, the ID3-Tag renamer
* mentioned above, should first check whether all items in @files
* are actually audio files. The thunarx_file_info_has_mime_type()
* of the #ThunarxFileInfo interface can be used to easily test
* whether a file in the @files list is of a certain MIME type.
*
* Some menu items may only work properly if only a single file is
* selected (for example, the ID3-Tag renamer will probably only
* supporting editing one file at a time). In this case you have
* basicly two options: Either you can return %NULL here if @files
* does not contain exactly one item, or you can return the menu items
* as usual, but make them insensitive, using:
* <informalexample><programlisting>
* thunarx_menu_item_set_sensitive (item, FALSE);
* </programlisting></informalexample>
* The latter has the advantage that the user will still notice the
* existance of the menu item and probably realize that it can only be
* applied to a single item at once.
*
* The caller is responsible to free the returned list using something
* like the following:
* <informalexample><programlisting>
* g_list_free_full (list, g_object_unref);
* </programlisting></informalexample>
*
* As a special note, this method automatically takes a reference on the
* @renamer for every #ThunarxMenuItem object returned from the real implementation
* of this method in @renamer. This is to make sure that the extension stays
* in memory for at least the time that the menu items are used.
*
* The name of #ThunarxMenuItem<!---->s returned from this method must be namespaced with
* the module to avoid collision with internal file manager menu items and
* menu items provided by other extensions. For example, the menu item
* provided by the ID3-Tag renamer mentioned above, should be named
* <literal>TagRenamer::edit-tags</literal> (if <literal>TagRenamer</literal>
* is the class name). For additional information about the way #ThunarxMenuItem<!---->s
* should be returned from extensions and the way they are used, read the
* description of the #ThunarxMenuProvider interface or read the introduction
* provided with this reference manual.
*
* A note of warning concerning the @window parameter. Plugins should
* avoid taking a reference on @window, as that might introduce a
* circular reference and can thereby cause a quite large memory leak.
* Instead, if @window is not %NULL, add a weak reference using the
* g_object_weak_ref() or g_object_add_weak_pointer() method. But don't
* forget to release the weak reference if @window survived the lifetime
* of your menu item (which is likely to be the case in most situations).
*
* Returns: (transfer full) (element-type ThunarxMenuItem): the list of
* #ThunarxMenuItem<!---->s provided by @renamer for the given list of
* @files.
**/
GList *
thunarx_renamer_get_menu_items (ThunarxRenamer *renamer,
GtkWindow *window,
GList *files)
{
GList *items;
g_return_val_if_fail (THUNARX_IS_RENAMER (renamer), NULL);
g_return_val_if_fail (window == NULL || GTK_IS_WINDOW (window), NULL);
/* query the menu items from the implementation */
items = (*THUNARX_RENAMER_GET_CLASS (renamer)->get_menu_items) (renamer, window, files);
/* take a reference on the renamer for each menu item */
thunarx_object_list_take_reference (items, renamer);
return items;
}
/**
* thunarx_renamer_changed:
* @renamer : a #ThunarxRenamer.
*
* This method should be used by derived classes
* to emit the "changed" signal for @renamer. See
* the documentation of the "changed" signal for
* details.
**/
void
thunarx_renamer_changed (ThunarxRenamer *renamer)
{
g_return_if_fail (THUNARX_IS_RENAMER (renamer));
g_signal_emit (G_OBJECT (renamer), renamer_signals[CHANGED], 0);
}
Reference in a new issue View git blame Copy permalink