Add GArrowReplaceSliceOptions

stenlarsson · stenlarsson · commit abdf3bd17579 · 2025-12-14T16:52:25.000+01:00
diff --git a/c_glib/arrow-glib/compute.cpp b/c_glib/arrow-glib/compute.cpp
@@ -269,6 +269,9 @@ G_BEGIN_DECLS
  * #GArrowExtractRegexOptions is a class to customize the `extract_regex`
  * function.
  *
+ * #GArrowReplaceSliceOptions is a class to customize the `utf8_replace_slice` and
+ * `binary_replace_slice` functions.
+ *
  * There are many functions to compute data on an array.
  */
 
@@ -7091,6 +7094,188 @@ garrow_extract_regex_options_new(void)
   return GARROW_EXTRACT_REGEX_OPTIONS(options);
 }
 
+enum {
+  PROP_REPLACE_SLICE_OPTIONS_START = 1,
+  PROP_REPLACE_SLICE_OPTIONS_STOP,
+  PROP_REPLACE_SLICE_OPTIONS_REPLACEMENT,
+};
+
+typedef struct _GArrowReplaceSliceOptionsPrivate GArrowReplaceSliceOptionsPrivate;
+struct _GArrowReplaceSliceOptionsPrivate
+{
+  gchar *replacement;
+};
+
+G_DEFINE_TYPE_WITH_PRIVATE(GArrowReplaceSliceOptions,
+                           garrow_replace_slice_options,
+                           GARROW_TYPE_FUNCTION_OPTIONS)
+
+#define GARROW_REPLACE_SLICE_OPTIONS_GET_PRIVATE(object)                                 \
+  static_cast<GArrowReplaceSliceOptionsPrivate *>(                                       \
+    garrow_replace_slice_options_get_instance_private(                                   \
+      GARROW_REPLACE_SLICE_OPTIONS(object)))
+
+static void
+garrow_replace_slice_options_dispose(GObject *object)
+{
+  auto priv = GARROW_REPLACE_SLICE_OPTIONS_GET_PRIVATE(object);
+  if (priv->replacement) {
+    g_free(priv->replacement);
+    priv->replacement = nullptr;
+  }
+  G_OBJECT_CLASS(garrow_replace_slice_options_parent_class)->dispose(object);
+}
+
+static void
+garrow_replace_slice_options_set_property(GObject *object,
+                                          guint prop_id,
+                                          const GValue *value,
+                                          GParamSpec *pspec)
+{
+  auto options =
+    garrow_replace_slice_options_get_raw(GARROW_REPLACE_SLICE_OPTIONS(object));
+  auto priv = GARROW_REPLACE_SLICE_OPTIONS_GET_PRIVATE(object);
+
+  switch (prop_id) {
+  case PROP_REPLACE_SLICE_OPTIONS_START:
+    options->start = g_value_get_int64(value);
+    break;
+  case PROP_REPLACE_SLICE_OPTIONS_STOP:
+    options->stop = g_value_get_int64(value);
+    break;
+  case PROP_REPLACE_SLICE_OPTIONS_REPLACEMENT:
+    {
+      const gchar *replacement = g_value_get_string(value);
+      if (priv->replacement) {
+        g_free(priv->replacement);
+      }
+      priv->replacement = g_strdup(replacement);
+      options->replacement = replacement ? replacement : "";
+    }
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_replace_slice_options_get_property(GObject *object,
+                                          guint prop_id,
+                                          GValue *value,
+                                          GParamSpec *pspec)
+{
+  auto options =
+    garrow_replace_slice_options_get_raw(GARROW_REPLACE_SLICE_OPTIONS(object));
+  auto priv = GARROW_REPLACE_SLICE_OPTIONS_GET_PRIVATE(object);
+
+  switch (prop_id) {
+  case PROP_REPLACE_SLICE_OPTIONS_START:
+    g_value_set_int64(value, options->start);
+    break;
+  case PROP_REPLACE_SLICE_OPTIONS_STOP:
+    g_value_set_int64(value, options->stop);
+    break;
+  case PROP_REPLACE_SLICE_OPTIONS_REPLACEMENT:
+    g_value_set_string(value,
+                       priv->replacement ? priv->replacement
+                                         : options->replacement.c_str());
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_replace_slice_options_init(GArrowReplaceSliceOptions *object)
+{
+  auto priv = GARROW_REPLACE_SLICE_OPTIONS_GET_PRIVATE(object);
+  priv->replacement = nullptr;
+  auto arrow_priv = GARROW_FUNCTION_OPTIONS_GET_PRIVATE(object);
+  arrow_priv->options = static_cast<arrow::compute::FunctionOptions *>(
+    new arrow::compute::ReplaceSliceOptions());
+  // Sync the private replacement string with the C++ options
+  auto arrow_options =
+    garrow_replace_slice_options_get_raw(GARROW_REPLACE_SLICE_OPTIONS(object));
+  priv->replacement = g_strdup(arrow_options->replacement.c_str());
+}
+
+static void
+garrow_replace_slice_options_class_init(GArrowReplaceSliceOptionsClass *klass)
+{
+  auto gobject_class = G_OBJECT_CLASS(klass);
+
+  gobject_class->dispose = garrow_replace_slice_options_dispose;
+  gobject_class->set_property = garrow_replace_slice_options_set_property;
+  gobject_class->get_property = garrow_replace_slice_options_get_property;
+
+  arrow::compute::ReplaceSliceOptions options;
+
+  GParamSpec *spec;
+  /**
+   * GArrowReplaceSliceOptions:start:
+   *
+   * Index to start slicing at.
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_int64("start",
+                            "Start",
+                            "Index to start slicing at",
+                            G_MININT64,
+                            G_MAXINT64,
+                            options.start,
+                            static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class, PROP_REPLACE_SLICE_OPTIONS_START, spec);
+
+  /**
+   * GArrowReplaceSliceOptions:stop:
+   *
+   * Index to stop slicing at.
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_int64("stop",
+                            "Stop",
+                            "Index to stop slicing at",
+                            G_MININT64,
+                            G_MAXINT64,
+                            options.stop,
+                            static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class, PROP_REPLACE_SLICE_OPTIONS_STOP, spec);
+
+  /**
+   * GArrowReplaceSliceOptions:replacement:
+   *
+   * String to replace the slice with.
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_string("replacement",
+                             "Replacement",
+                             "String to replace the slice with",
+                             options.replacement.c_str(),
+                             static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class,
+                                  PROP_REPLACE_SLICE_OPTIONS_REPLACEMENT,
+                                  spec);
+}
+
+/**
+ * garrow_replace_slice_options_new:
+ *
+ * Returns: A newly created #GArrowReplaceSliceOptions.
+ *
+ * Since: 23.0.0
+ */
+GArrowReplaceSliceOptions *
+garrow_replace_slice_options_new(void)
+{
+  return GARROW_REPLACE_SLICE_OPTIONS(
+    g_object_new(GARROW_TYPE_REPLACE_SLICE_OPTIONS, NULL));
+}
+
 G_END_DECLS
 
 arrow::Result<arrow::FieldRef>
@@ -7254,6 +7439,11 @@ garrow_function_options_new_raw(const arrow::compute::FunctionOptions *arrow_opt
       static_cast<const arrow::compute::ExtractRegexOptions *>(arrow_options);
     auto options = garrow_extract_regex_options_new_raw(arrow_extract_regex_options);
     return GARROW_FUNCTION_OPTIONS(options);
+  } else if (arrow_type_name == "ReplaceSliceOptions") {
+    const auto arrow_replace_slice_options =
+      static_cast<const arrow::compute::ReplaceSliceOptions *>(arrow_options);
+    auto options = garrow_replace_slice_options_new_raw(arrow_replace_slice_options);
+    return GARROW_FUNCTION_OPTIONS(options);
   } else {
     auto options = g_object_new(GARROW_TYPE_FUNCTION_OPTIONS, NULL);
     return GARROW_FUNCTION_OPTIONS(options);
@@ -7893,3 +8083,24 @@ garrow_extract_regex_options_get_raw(GArrowExtractRegexOptions *options)
   return static_cast<arrow::compute::ExtractRegexOptions *>(
     garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
 }
+
+GArrowReplaceSliceOptions *
+garrow_replace_slice_options_new_raw(
+  const arrow::compute::ReplaceSliceOptions *arrow_options)
+{
+  return GARROW_REPLACE_SLICE_OPTIONS(g_object_new(GARROW_TYPE_REPLACE_SLICE_OPTIONS,
+                                                   "start",
+                                                   arrow_options->start,
+                                                   "stop",
+                                                   arrow_options->stop,
+                                                   "replacement",
+                                                   arrow_options->replacement.c_str(),
+                                                   NULL));
+}
+
+arrow::compute::ReplaceSliceOptions *
+garrow_replace_slice_options_get_raw(GArrowReplaceSliceOptions *options)
+{
+  return static_cast<arrow::compute::ReplaceSliceOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+}
diff --git a/c_glib/arrow-glib/compute.h b/c_glib/arrow-glib/compute.h
@@ -1272,4 +1272,20 @@ GARROW_AVAILABLE_IN_23_0
 GArrowExtractRegexOptions *
 garrow_extract_regex_options_new(void);
 
+#define GARROW_TYPE_REPLACE_SLICE_OPTIONS (garrow_replace_slice_options_get_type())
+GARROW_AVAILABLE_IN_23_0
+G_DECLARE_DERIVABLE_TYPE(GArrowReplaceSliceOptions,
+                         garrow_replace_slice_options,
+                         GARROW,
+                         REPLACE_SLICE_OPTIONS,
+                         GArrowFunctionOptions)
+struct _GArrowReplaceSliceOptionsClass
+{
+  GArrowFunctionOptionsClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_23_0
+GArrowReplaceSliceOptions *
+garrow_replace_slice_options_new(void);
+
 G_END_DECLS
diff --git a/c_glib/arrow-glib/compute.hpp b/c_glib/arrow-glib/compute.hpp
@@ -209,3 +209,9 @@ garrow_extract_regex_options_new_raw(
   const arrow::compute::ExtractRegexOptions *arrow_options);
 arrow::compute::ExtractRegexOptions *
 garrow_extract_regex_options_get_raw(GArrowExtractRegexOptions *options);
+
+GArrowReplaceSliceOptions *
+garrow_replace_slice_options_new_raw(
+  const arrow::compute::ReplaceSliceOptions *arrow_options);
+arrow::compute::ReplaceSliceOptions *
+garrow_replace_slice_options_get_raw(GArrowReplaceSliceOptions *options);
diff --git a/c_glib/test/test-replace-slice-options.rb b/c_glib/test/test-replace-slice-options.rb
@@ -0,0 +1,55 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+class TestReplaceSliceOptions < Test::Unit::TestCase
+  include Helper::Buildable
+
+  def setup
+    @options = Arrow::ReplaceSliceOptions.new
+  end
+
+  def test_start_property
+    assert_equal(0, @options.start)
+    @options.start = 1
+    assert_equal(1, @options.start)
+  end
+
+  def test_stop_property
+    assert_equal(0, @options.stop)
+    @options.stop = 2
+    assert_equal(2, @options.stop)
+  end
+
+  def test_replacement_property
+    assert_equal("", @options.replacement)
+    @options.replacement = "XX"
+    assert_equal("XX", @options.replacement)
+  end
+
+  def test_utf8_replace_slice_function
+    args = [
+      Arrow::ArrayDatum.new(build_string_array(["hello", "world"])),
+    ]
+    @options.start = 1
+    @options.stop = 3
+    @options.replacement = "XX"
+    utf8_replace_slice_function = Arrow::Function.find("utf8_replace_slice")
+    result = utf8_replace_slice_function.execute(args, @options).value
+    expected = build_string_array(["hXXlo", "wXXld"])
+    assert_equal(expected, result)
+  end
+end
