thunar-usagebars/plugins/thunar-sbr/thunar-sbr-number-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

715 lines
22 KiB
C

/* vi:set et ai sw=2 sts=2 ts=2: */
/*-
* Copyright (c) 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
#ifdef HAVE_MEMORY_H
#include <memory.h>
#endif
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <libxfce4util/libxfce4util.h>
#include <thunar-sbr/thunar-sbr-number-renamer.h>
/* Property identifiers */
enum
{
PROP_0,
PROP_MODE,
PROP_START,
PROP_TEXT,
PROP_TEXT_MODE,
};
static void
thunar_sbr_number_renamer_finalize (GObject *object);
static void
thunar_sbr_number_renamer_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void
thunar_sbr_number_renamer_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void
thunar_sbr_number_renamer_realize (GtkWidget *widget);
static gchar *
thunar_sbr_number_renamer_process (ThunarxRenamer *renamer,
ThunarxFileInfo *file,
const gchar *text,
guint idx);
static void
thunar_sbr_number_renamer_update (ThunarSbrNumberRenamer *number_renamer);
struct _ThunarSbrNumberRenamerClass
{
ThunarxRenamerClass __parent__;
};
struct _ThunarSbrNumberRenamer
{
ThunarxRenamer __parent__;
GtkWidget *start_entry;
ThunarSbrNumberMode mode;
gchar *start;
gchar *text;
ThunarSbrTextMode text_mode;
};
THUNARX_DEFINE_TYPE (ThunarSbrNumberRenamer, thunar_sbr_number_renamer, THUNARX_TYPE_RENAMER);
static void
thunar_sbr_number_renamer_class_init (ThunarSbrNumberRenamerClass *klass)
{
ThunarxRenamerClass *thunarxrenamer_class;
GtkWidgetClass *gtkwidget_class;
GObjectClass *gobject_class;
gobject_class = G_OBJECT_CLASS (klass);
gobject_class->finalize = thunar_sbr_number_renamer_finalize;
gobject_class->get_property = thunar_sbr_number_renamer_get_property;
gobject_class->set_property = thunar_sbr_number_renamer_set_property;
gtkwidget_class = GTK_WIDGET_CLASS (klass);
gtkwidget_class->realize = thunar_sbr_number_renamer_realize;
thunarxrenamer_class = THUNARX_RENAMER_CLASS (klass);
thunarxrenamer_class->process = thunar_sbr_number_renamer_process;
/**
* ThunarSbrNumberRenamer:mode:
*
* The #ThunarSbrNumberMode to use.
**/
g_object_class_install_property (gobject_class,
PROP_MODE,
g_param_spec_enum ("mode", "mode", "mode",
THUNAR_SBR_TYPE_NUMBER_MODE,
THUNAR_SBR_NUMBER_MODE_123,
G_PARAM_READWRITE));
/**
* ThunarSbrNumberRenamer:start:
*
* The starting value according to the #ThunarSbrNumberMode.
**/
g_object_class_install_property (gobject_class,
PROP_START,
g_param_spec_string ("start",
"start",
"start",
"1",
G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
/**
* ThunarSbrNumberRenamer:text:
*
* The additional text, depending on the #ThunarSbrTextMode.
**/
g_object_class_install_property (gobject_class,
PROP_TEXT,
g_param_spec_string ("text",
"text",
"text",
". ",
G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
/**
* ThunarSbrNumberRenamer:text-mode:
*
* The text mode for the renamer.
**/
g_object_class_install_property (gobject_class,
PROP_TEXT_MODE,
g_param_spec_enum ("text-mode",
"text-mode",
"text-mode",
THUNAR_SBR_TYPE_TEXT_MODE,
THUNAR_SBR_TEXT_MODE_NTO,
G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
}
static void
thunar_sbr_number_renamer_init (ThunarSbrNumberRenamer *number_renamer)
{
AtkRelationSet *relations;
AtkRelation *relation;
GEnumClass *klass;
AtkObject *object;
GtkWidget *combo;
GtkWidget *entry;
GtkWidget *label;
GtkWidget *grid;
guint n;
grid = gtk_grid_new ();
gtk_grid_set_row_spacing (GTK_GRID (grid), 6);
gtk_grid_set_column_spacing (GTK_GRID (grid), 12);
gtk_box_pack_start (GTK_BOX (number_renamer), grid, FALSE, FALSE, 0);
gtk_widget_show (grid);
label = gtk_label_new_with_mnemonic (_("_Number Format:"));
gtk_grid_attach (GTK_GRID (grid), label, 0, 0, 1, 1);
gtk_widget_show (label);
combo = gtk_combo_box_text_new ();
klass = g_type_class_ref (THUNAR_SBR_TYPE_NUMBER_MODE);
for (n = 0; n < klass->n_values; ++n)
gtk_combo_box_text_append_text (GTK_COMBO_BOX_TEXT (combo), _(klass->values[n].value_nick));
g_object_bind_property (G_OBJECT (number_renamer), "mode", G_OBJECT (combo), "active", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
gtk_grid_attach (GTK_GRID (grid), combo, 1, 0, 1, 1);
gtk_label_set_mnemonic_widget (GTK_LABEL (label), combo);
g_type_class_unref (klass);
gtk_widget_show (combo);
/* set Atk label relation for the combo */
object = gtk_widget_get_accessible (combo);
relations = atk_object_ref_relation_set (gtk_widget_get_accessible (label));
relation = atk_relation_new (&object, 1, ATK_RELATION_LABEL_FOR);
atk_relation_set_add (relations, relation);
g_object_unref (G_OBJECT (relation));
g_object_unref (relations);
number_renamer->start_entry = gtk_entry_new ();
gtk_entry_set_max_length (GTK_ENTRY (number_renamer->start_entry), 8);
gtk_entry_set_width_chars (GTK_ENTRY (number_renamer->start_entry), 3);
gtk_entry_set_alignment (GTK_ENTRY (number_renamer->start_entry), 1.0f);
gtk_entry_set_activates_default (GTK_ENTRY (number_renamer->start_entry), TRUE);
gtk_widget_set_hexpand (GTK_WIDGET (number_renamer->start_entry), TRUE);
g_object_bind_property (G_OBJECT (number_renamer->start_entry), "text", G_OBJECT (number_renamer), "start", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
gtk_grid_attach (GTK_GRID (grid), number_renamer->start_entry, 3, 0, 1, 1);
gtk_widget_show (number_renamer->start_entry);
label = gtk_label_new_with_mnemonic (_("_Start With:"));
gtk_grid_attach (GTK_GRID (grid), label, 2, 0, 1, 1);
gtk_label_set_mnemonic_widget (GTK_LABEL (label), number_renamer->start_entry);
gtk_widget_show (label);
/* set Atk label relation for the entry */
object = gtk_widget_get_accessible (number_renamer->start_entry);
relations = atk_object_ref_relation_set (gtk_widget_get_accessible (label));
relation = atk_relation_new (&object, 1, ATK_RELATION_LABEL_FOR);
atk_relation_set_add (relations, relation);
g_object_unref (G_OBJECT (relation));
g_object_unref (relations);
label = gtk_label_new_with_mnemonic (_("Text _Format:"));
gtk_grid_attach (GTK_GRID (grid), label, 0, 1, 1, 1);
gtk_widget_show (label);
combo = gtk_combo_box_text_new ();
klass = g_type_class_ref (THUNAR_SBR_TYPE_TEXT_MODE);
for (n = 0; n < klass->n_values; ++n)
gtk_combo_box_text_append_text (GTK_COMBO_BOX_TEXT (combo), _(klass->values[n].value_nick));
g_object_bind_property (G_OBJECT (number_renamer), "text-mode", G_OBJECT (combo), "active", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
gtk_grid_attach (GTK_GRID (grid), combo, 1, 1, 1, 1);
gtk_label_set_mnemonic_widget (GTK_LABEL (label), combo);
g_type_class_unref (klass);
gtk_widget_show (combo);
/* set Atk label relation for the combo */
object = gtk_widget_get_accessible (combo);
relations = atk_object_ref_relation_set (gtk_widget_get_accessible (label));
relation = atk_relation_new (&object, 1, ATK_RELATION_LABEL_FOR);
atk_relation_set_add (relations, relation);
g_object_unref (G_OBJECT (relation));
g_object_unref (relations);
entry = gtk_entry_new ();
gtk_entry_set_width_chars (GTK_ENTRY (entry), 12);
gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
g_object_bind_property (G_OBJECT (entry), "text", G_OBJECT (number_renamer), "text", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
gtk_grid_attach (GTK_GRID (grid), entry, 3, 1, 1, 1);
gtk_widget_show (entry);
label = gtk_label_new_with_mnemonic (_("_Text:"));
gtk_label_set_xalign (GTK_LABEL (label), 1.0f);
gtk_grid_attach (GTK_GRID (grid), label, 2, 1, 1, 1);
gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);
gtk_widget_show (label);
/* set Atk label relation for the entry */
object = gtk_widget_get_accessible (entry);
relations = atk_object_ref_relation_set (gtk_widget_get_accessible (label));
relation = atk_relation_new (&object, 1, ATK_RELATION_LABEL_FOR);
atk_relation_set_add (relations, relation);
g_object_unref (G_OBJECT (relation));
g_object_unref (relations);
}
static void
thunar_sbr_number_renamer_finalize (GObject *object)
{
ThunarSbrNumberRenamer *number_renamer = THUNAR_SBR_NUMBER_RENAMER (object);
/* release renamer resources */
g_free (number_renamer->start);
g_free (number_renamer->text);
(*G_OBJECT_CLASS (thunar_sbr_number_renamer_parent_class)->finalize) (object);
}
static void
thunar_sbr_number_renamer_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
ThunarSbrNumberRenamer *number_renamer = THUNAR_SBR_NUMBER_RENAMER (object);
switch (prop_id)
{
case PROP_MODE:
g_value_set_enum (value, thunar_sbr_number_renamer_get_mode (number_renamer));
break;
case PROP_START:
g_value_set_string (value, thunar_sbr_number_renamer_get_start (number_renamer));
break;
case PROP_TEXT:
g_value_set_string (value, thunar_sbr_number_renamer_get_text (number_renamer));
break;
case PROP_TEXT_MODE:
g_value_set_enum (value, thunar_sbr_number_renamer_get_text_mode (number_renamer));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
thunar_sbr_number_renamer_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
ThunarSbrNumberRenamer *number_renamer = THUNAR_SBR_NUMBER_RENAMER (object);
switch (prop_id)
{
case PROP_MODE:
thunar_sbr_number_renamer_set_mode (number_renamer, g_value_get_enum (value));
break;
case PROP_START:
thunar_sbr_number_renamer_set_start (number_renamer, g_value_get_string (value));
break;
case PROP_TEXT:
thunar_sbr_number_renamer_set_text (number_renamer, g_value_get_string (value));
break;
case PROP_TEXT_MODE:
thunar_sbr_number_renamer_set_text_mode (number_renamer, g_value_get_enum (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
thunar_sbr_number_renamer_realize (GtkWidget *widget)
{
/* realize the widget */
(*GTK_WIDGET_CLASS (thunar_sbr_number_renamer_parent_class)->realize) (widget);
/* update the state */
thunar_sbr_number_renamer_update (THUNAR_SBR_NUMBER_RENAMER (widget));
}
static gchar *
thunar_sbr_number_renamer_process (ThunarxRenamer *renamer,
ThunarxFileInfo *file,
const gchar *text,
guint idx)
{
ThunarSbrNumberRenamer *number_renamer = THUNAR_SBR_NUMBER_RENAMER (renamer);
gboolean invalid = TRUE;
gchar *endp;
gchar *name;
gchar *number = NULL;
guint start = 0;
/* check whether "start" is valid for the "mode" */
if (number_renamer->mode < THUNAR_SBR_NUMBER_MODE_ABC)
{
/* "start" must be a positive number */
start = strtoul (number_renamer->start, &endp, 10);
invalid = (endp <= number_renamer->start || *endp != '\0');
}
else if (number_renamer->mode == THUNAR_SBR_NUMBER_MODE_ABC)
{
/* "start" property must be 'a', 'b', 'c', etc. */
start = *number_renamer->start;
invalid = (strlen (number_renamer->start) != 1
|| g_unichar_tolower (start) < 'a'
|| g_unichar_tolower (start) > 'z');
}
/* check if we have invalid settings */
if (G_UNLIKELY (invalid))
return g_strdup (text);
/* format the number */
switch (number_renamer->mode)
{
case THUNAR_SBR_NUMBER_MODE_123:
number = g_strdup_printf ("%u", start + idx);
break;
case THUNAR_SBR_NUMBER_MODE_010203:
number = g_strdup_printf ("%02u", start + idx);
break;
case THUNAR_SBR_NUMBER_MODE_001002003:
number = g_strdup_printf ("%03u", start + idx);
break;
case THUNAR_SBR_NUMBER_MODE_000100020003:
number = g_strdup_printf ("%04u", start + idx);
break;
case THUNAR_SBR_NUMBER_MODE_000010000200003:
number = g_strdup_printf ("%05u", start + idx);
break;
case THUNAR_SBR_NUMBER_MODE_ABC:
if (start >= 'a' && start <= 'z')
number = g_strdup_printf ("%c", (gchar) (MIN (start + idx, 'z')));
else if (start >= 'A' && start <= 'Z')
number = g_strdup_printf ("%c", (gchar) (MIN (start + idx, 'Z')));
else
g_assert_not_reached ();
break;
default:
g_assert_not_reached ();
break;
}
/* format the text */
switch (number_renamer->text_mode)
{
case THUNAR_SBR_TEXT_MODE_OTN:
name = g_strconcat (text, number_renamer->text, number, NULL);
break;
case THUNAR_SBR_TEXT_MODE_NTO:
name = g_strconcat (number, number_renamer->text, text, NULL);
break;
case THUNAR_SBR_TEXT_MODE_TN:
name = g_strconcat (number_renamer->text, number, NULL);
break;
case THUNAR_SBR_TEXT_MODE_NT:
name = g_strconcat (number, number_renamer->text, NULL);
break;
default:
g_assert_not_reached ();
break;
}
/* release the number */
g_free (number);
/* return the new name */
return name;
}
static void
thunar_sbr_number_renamer_update (ThunarSbrNumberRenamer *number_renamer)
{
gboolean invalid = TRUE;
gchar *endp;
/* check whether "start" is valid for the "mode" */
if (number_renamer->mode < THUNAR_SBR_NUMBER_MODE_ABC)
{
/* "start" must be a positive number */
strtoul (number_renamer->start, &endp, 10);
invalid = (endp <= number_renamer->start || *endp != '\0');
}
else if (number_renamer->mode == THUNAR_SBR_NUMBER_MODE_ABC)
{
/* "start" property must be 'a', 'b', 'c', etc. */
invalid = (strlen (number_renamer->start) != 1
|| g_unichar_tolower (*number_renamer->start) < 'a'
|| g_unichar_tolower (*number_renamer->start) > 'z');
}
/* check if the start entry is realized */
if (gtk_widget_get_realized (number_renamer->start_entry))
{
/* highlight invalid input by using theme specific colors */
if (G_UNLIKELY (invalid))
gtk_style_context_add_class (gtk_widget_get_style_context (GTK_WIDGET (number_renamer->start_entry)), "error");
else
gtk_style_context_remove_class (gtk_widget_get_style_context (GTK_WIDGET (number_renamer->start_entry)), "error");
}
/* notify everybody that we have a new state */
thunarx_renamer_changed (THUNARX_RENAMER (number_renamer));
}
/**
* thunar_sbr_number_renamer_new:
*
* Allocates a new #ThunarSbrNumberRenamer instance.
*
* Return value: the newly allocated #ThunarSbrNumberRenamer.
**/
ThunarSbrNumberRenamer *
thunar_sbr_number_renamer_new (void)
{
return g_object_new (THUNAR_SBR_TYPE_NUMBER_RENAMER,
"name", _("Numbering"),
NULL);
}
/**
* thunar_sbr_number_renamer_get_mode:
* @number_renamer : a #ThunarSbrNumberRenamer.
*
* Returns the mode of the @number_renamer.
*
* Return value: the mode of @number_renamer.
**/
ThunarSbrNumberMode
thunar_sbr_number_renamer_get_mode (ThunarSbrNumberRenamer *number_renamer)
{
g_return_val_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer), THUNAR_SBR_NUMBER_MODE_123);
return number_renamer->mode;
}
/**
* thunar_sbr_number_renamer_set_mode:
* @number_renamer : a #ThunarSbrNumberRenamer.
* @mode : the new #ThunarSbrNumberMode for @number_renamer.
*
* Sets the mode of @number_renamer to @mode.
**/
void
thunar_sbr_number_renamer_set_mode (ThunarSbrNumberRenamer *number_renamer,
ThunarSbrNumberMode mode)
{
g_return_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer));
/* check if we have a new mode */
if (G_LIKELY (number_renamer->mode != mode))
{
/* apply the new mode */
number_renamer->mode = mode;
/* update the renamer */
thunar_sbr_number_renamer_update (number_renamer);
/* notify listeners */
g_object_notify (G_OBJECT (number_renamer), "mode");
}
}
/**
* thunar_sbr_number_renamer_get_start:
* @number_renamer : a #ThunarSbrNumberRenamer.
*
* Returns the start for the @number_renamer.
*
* Return value: the start for @number_renamer.
**/
const gchar *
thunar_sbr_number_renamer_get_start (ThunarSbrNumberRenamer *number_renamer)
{
g_return_val_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer), NULL);
return number_renamer->start;
}
/**
* thunar_sbr_number_renamer_set_start:
* @number_renamer : a #ThunarSbrNumberRenamer.
* @start : the new start for @number_renamer.
*
* Sets the start for @number_renamer to @start.
**/
void
thunar_sbr_number_renamer_set_start (ThunarSbrNumberRenamer *number_renamer,
const gchar *start)
{
g_return_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer));
/* check if we have a new start */
if (g_strcmp0 (number_renamer->start, start) != 0)
{
/* apply the new start */
g_free (number_renamer->start);
number_renamer->start = g_strdup (start);
/* update the renamer */
thunar_sbr_number_renamer_update (number_renamer);
/* notify listeners */
g_object_notify (G_OBJECT (number_renamer), "start");
}
}
/**
* thunar_sbr_number_renamer_get_text:
* @number_renamer : a #ThunarSbrNumberRenamer.
*
* Returns the text for the @number_renamer.
*
* Return value: the text for @number_renamer.
**/
const gchar *
thunar_sbr_number_renamer_get_text (ThunarSbrNumberRenamer *number_renamer)
{
g_return_val_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer), NULL);
return number_renamer->text;
}
/**
* thunar_sbr_number_renamer_set_text:
* @number_renamer : a #ThunarSbrNumberRenamer.
* @text : the new text for @number_renamer.
*
* Sets the text for @number_renamer to @text.
**/
void
thunar_sbr_number_renamer_set_text (ThunarSbrNumberRenamer *number_renamer,
const gchar *text)
{
g_return_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer));
/* check if we have a new text */
if (G_LIKELY (g_strcmp0 (number_renamer->text, text) != 0))
{
/* apply the new text */
g_free (number_renamer->text);
number_renamer->text = g_strdup (text);
/* update the renamer */
thunar_sbr_number_renamer_update (number_renamer);
/* notify listeners */
g_object_notify (G_OBJECT (number_renamer), "text");
}
}
/**
* thunar_sbr_number_renamer_get_text_mode:
* @number_renamer : a #ThunarSbrNumberRenamer.
*
* Returns the text mode for the @number_renamer.
*
* Return value: the text mode for @number_renamer.
**/
ThunarSbrTextMode
thunar_sbr_number_renamer_get_text_mode (ThunarSbrNumberRenamer *number_renamer)
{
g_return_val_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer), THUNAR_SBR_TEXT_MODE_NTO);
return number_renamer->text_mode;
}
/**
* thunar_sbr_number_renamer_set_offset_mode:
* @number_renamer : a #ThunarSbrNumberRenamer.
* @text_mode : the new text mode for @number_renamer.
*
* Sets the text mode for @number_renamer to @text_mode.
**/
void
thunar_sbr_number_renamer_set_text_mode (ThunarSbrNumberRenamer *number_renamer,
ThunarSbrTextMode text_mode)
{
g_return_if_fail (THUNAR_SBR_IS_NUMBER_RENAMER (number_renamer));
/* check if we have a new setting */
if (G_LIKELY (number_renamer->text_mode != text_mode))
{
/* apply the new setting */
number_renamer->text_mode = text_mode;
/* update the renamer */
thunar_sbr_number_renamer_update (number_renamer);
/* notify listeners */
g_object_notify (G_OBJECT (number_renamer), "text-mode");
}
}