Add GArrowZeroFillOptions

Author: stenlarsson

c_glib/arrow-glib/compute.cpp

@@ -337,6 +337,8 @@ G_BEGIN_DECLS
  *
  * #GArrowWinsorizeOptions is a class to customize the `winsorize` function.
  *
+ * #GArrowZeroFillOptions is a class to customize the `utf8_zero_fill` function.
+ *
  * There are many functions to compute data on an array.
  */
 
@@ -10571,6 +10573,156 @@ garrow_winsorize_options_new(void)
   return GARROW_WINSORIZE_OPTIONS(g_object_new(GARROW_TYPE_WINSORIZE_OPTIONS, NULL));
 }
 
+enum {
+  PROP_ZERO_FILL_OPTIONS_WIDTH = 1,
+  PROP_ZERO_FILL_OPTIONS_PADDING,
+};
+
+typedef struct _GArrowZeroFillOptionsPrivate GArrowZeroFillOptionsPrivate;
+struct _GArrowZeroFillOptionsPrivate
+{
+  gchar *padding;
+};
+
+G_DEFINE_TYPE_WITH_PRIVATE(GArrowZeroFillOptions,
+                           garrow_zero_fill_options,
+                           GARROW_TYPE_FUNCTION_OPTIONS)
+
+#define GARROW_ZERO_FILL_OPTIONS_GET_PRIVATE(object)                                    \
+  static_cast<GArrowZeroFillOptionsPrivate *>(                                          \
+    garrow_zero_fill_options_get_instance_private(GARROW_ZERO_FILL_OPTIONS(object)))
+
+static void
+garrow_zero_fill_options_dispose(GObject *object)
+{
+  auto priv = GARROW_ZERO_FILL_OPTIONS_GET_PRIVATE(object);
+  if (priv->padding) {
+    g_free(priv->padding);
+    priv->padding = nullptr;
+  }
+  G_OBJECT_CLASS(garrow_zero_fill_options_parent_class)->dispose(object);
+}
+
+static void
+garrow_zero_fill_options_set_property(GObject *object,
+                                      guint prop_id,
+                                      const GValue *value,
+                                      GParamSpec *pspec)
+{
+  auto options = garrow_zero_fill_options_get_raw(GARROW_ZERO_FILL_OPTIONS(object));
+  auto priv = GARROW_ZERO_FILL_OPTIONS_GET_PRIVATE(object);
+
+  switch (prop_id) {
+  case PROP_ZERO_FILL_OPTIONS_WIDTH:
+    options->width = g_value_get_int64(value);
+    break;
+  case PROP_ZERO_FILL_OPTIONS_PADDING:
+    {
+      const gchar *padding = g_value_get_string(value);
+      if (priv->padding) {
+        g_free(priv->padding);
+      }
+      priv->padding = g_strdup(padding);
+      options->padding = padding ? padding : "";
+    }
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_zero_fill_options_get_property(GObject *object,
+                                      guint prop_id,
+                                      GValue *value,
+                                      GParamSpec *pspec)
+{
+  auto options = garrow_zero_fill_options_get_raw(GARROW_ZERO_FILL_OPTIONS(object));
+  auto priv = GARROW_ZERO_FILL_OPTIONS_GET_PRIVATE(object);
+
+  switch (prop_id) {
+  case PROP_ZERO_FILL_OPTIONS_WIDTH:
+    g_value_set_int64(value, options->width);
+    break;
+  case PROP_ZERO_FILL_OPTIONS_PADDING:
+    g_value_set_string(value, priv->padding ? priv->padding : options->padding.c_str());
+    break;
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+    break;
+  }
+}
+
+static void
+garrow_zero_fill_options_init(GArrowZeroFillOptions *object)
+{
+  auto priv = GARROW_ZERO_FILL_OPTIONS_GET_PRIVATE(object);
+  priv->padding = nullptr;
+  auto arrow_priv = GARROW_FUNCTION_OPTIONS_GET_PRIVATE(object);
+  arrow_priv->options =
+    static_cast<arrow::compute::FunctionOptions *>(new arrow::compute::ZeroFillOptions());
+  // Sync the private string with the C++ options
+  auto arrow_options = garrow_zero_fill_options_get_raw(GARROW_ZERO_FILL_OPTIONS(object));
+  priv->padding = g_strdup(arrow_options->padding.c_str());
+}
+
+static void
+garrow_zero_fill_options_class_init(GArrowZeroFillOptionsClass *klass)
+{
+  auto gobject_class = G_OBJECT_CLASS(klass);
+
+  gobject_class->dispose = garrow_zero_fill_options_dispose;
+  gobject_class->set_property = garrow_zero_fill_options_set_property;
+  gobject_class->get_property = garrow_zero_fill_options_get_property;
+
+  arrow::compute::ZeroFillOptions options;
+
+  GParamSpec *spec;
+  /**
+   * GArrowZeroFillOptions:width:
+   *
+   * The desired string length.
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_int64("width",
+                            "Width",
+                            "The desired string length",
+                            G_MININT64,
+                            G_MAXINT64,
+                            options.width,
+                            static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class, PROP_ZERO_FILL_OPTIONS_WIDTH, spec);
+
+  /**
+   * GArrowZeroFillOptions:padding:
+   *
+   * What to pad the string with. Should be one codepoint (Unicode).
+   *
+   * Since: 23.0.0
+   */
+  spec = g_param_spec_string("padding",
+                             "Padding",
+                             "What to pad the string with. Should be one codepoint (Unicode)",
+                             options.padding.c_str(),
+                             static_cast<GParamFlags>(G_PARAM_READWRITE));
+  g_object_class_install_property(gobject_class, PROP_ZERO_FILL_OPTIONS_PADDING, spec);
+}
+
+/**
+ * garrow_zero_fill_options_new:
+ *
+ * Returns: A newly created #GArrowZeroFillOptions.
+ *
+ * Since: 23.0.0
+ */
+GArrowZeroFillOptions *
+garrow_zero_fill_options_new(void)
+{
+  return GARROW_ZERO_FILL_OPTIONS(g_object_new(GARROW_TYPE_ZERO_FILL_OPTIONS, NULL));
+}
+
 G_END_DECLS
 
 arrow::Result<arrow::FieldRef>
@@ -10852,6 +11004,11 @@ garrow_function_options_new_raw(const arrow::compute::FunctionOptions *arrow_opt
       static_cast<const arrow::compute::WinsorizeOptions *>(arrow_options);
     auto options = garrow_winsorize_options_new_raw(arrow_winsorize_options);
     return GARROW_FUNCTION_OPTIONS(options);
+  } else if (arrow_type_name == "ZeroFillOptions") {
+    const auto arrow_zero_fill_options =
+      static_cast<const arrow::compute::ZeroFillOptions *>(arrow_options);
+    auto options = garrow_zero_fill_options_new_raw(arrow_zero_fill_options);
+    return GARROW_FUNCTION_OPTIONS(options);
   } else {
     auto options = g_object_new(GARROW_TYPE_FUNCTION_OPTIONS, NULL);
     return GARROW_FUNCTION_OPTIONS(options);
@@ -11997,3 +12154,21 @@ garrow_winsorize_options_get_raw(GArrowWinsorizeOptions *options)
   return static_cast<arrow::compute::WinsorizeOptions *>(
     garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
 }
+
+GArrowZeroFillOptions *
+garrow_zero_fill_options_new_raw(const arrow::compute::ZeroFillOptions *arrow_options)
+{
+  return GARROW_ZERO_FILL_OPTIONS(g_object_new(GARROW_TYPE_ZERO_FILL_OPTIONS,
+                                                "width",
+                                                arrow_options->width,
+                                                "padding",
+                                                arrow_options->padding.c_str(),
+                                                NULL));
+}
+
+arrow::compute::ZeroFillOptions *
+garrow_zero_fill_options_get_raw(GArrowZeroFillOptions *options)
+{
+  return static_cast<arrow::compute::ZeroFillOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+}

c_glib/arrow-glib/compute.h

@@ -1772,4 +1772,17 @@ GARROW_AVAILABLE_IN_23_0
 GArrowWinsorizeOptions *
 garrow_winsorize_options_new(void);
 
+#define GARROW_TYPE_ZERO_FILL_OPTIONS (garrow_zero_fill_options_get_type())
+GARROW_AVAILABLE_IN_23_0
+G_DECLARE_DERIVABLE_TYPE(
+  GArrowZeroFillOptions, garrow_zero_fill_options, GARROW, ZERO_FILL_OPTIONS, GArrowFunctionOptions)
+struct _GArrowZeroFillOptionsClass
+{
+  GArrowFunctionOptionsClass parent_class;
+};
+
+GARROW_AVAILABLE_IN_23_0
+GArrowZeroFillOptions *
+garrow_zero_fill_options_new(void);
+
 G_END_DECLS

c_glib/arrow-glib/compute.hpp

@@ -337,3 +337,8 @@ GArrowWinsorizeOptions *
 garrow_winsorize_options_new_raw(const arrow::compute::WinsorizeOptions *arrow_options);
 arrow::compute::WinsorizeOptions *
 garrow_winsorize_options_get_raw(GArrowWinsorizeOptions *options);
+
+GArrowZeroFillOptions *
+garrow_zero_fill_options_new_raw(const arrow::compute::ZeroFillOptions *arrow_options);
+arrow::compute::ZeroFillOptions *
+garrow_zero_fill_options_get_raw(GArrowZeroFillOptions *options);

c_glib/test/test-zero-fill-options.rb

@@ -0,0 +1,49 @@
+# 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 TestZeroFillOptions < Test::Unit::TestCase
+  include Helper::Buildable
+
+  def setup
+    @options = Arrow::ZeroFillOptions.new
+  end
+
+  def test_width_property
+    assert_equal(0, @options.width)
+    @options.width = 4
+    assert_equal(4, @options.width)
+  end
+
+  def test_padding_property
+    assert_equal("0", @options.padding)
+    @options.padding = "x"
+    assert_equal("x", @options.padding)
+  end
+
+  def test_utf8_zero_fill_function
+    args = [
+      Arrow::ArrayDatum.new(build_string_array(["1", "-2", "+3"])),
+    ]
+    @options.width = 4
+    @options.padding = "0"
+    utf8_zero_fill_function = Arrow::Function.find("utf8_zero_fill")
+    result = utf8_zero_fill_function.execute(args, @options).value
+    expected = build_string_array(["0001", "-002", "+003"])
+    assert_equal(expected, result)
+  end
+end
+