gettextpo 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac67f013230155611dd5bd8f673a19eb8d84153dbc3240e3f0849a3a78ebf9d
-  data.tar.gz: 5c3d1ac85ab300ccd98b798948448b64be26d1b69c055b0ec1e11c08641209d9
+  metadata.gz: 939f88fac034fa8ae14d06943e12163df3a34ca1797c625c7d5c6c591c18756b
+  data.tar.gz: 972a70b2e9f8c5c623e839a7e8c5d54e2b95cd62d1fe0d3f6c26fe4f3d53b429
 SHA512:
-  metadata.gz: 5cd5653bdff4094cbf3b14f57ae30b224ae0a20b775cf072ef008bf851e8fce4f129c8ffeb9071d271223c70c78035d717d82d70f8f00f32d1a2fe5c2ffae4d3
-  data.tar.gz: 77e26a94e04627ba399495819e25972b6dca2a9742e27e8c6ae9f5fff5032a3987f64e003707631c6a13ce38c4694a9d5a5692179a7e938d40023288d5965aa2
+  metadata.gz: 9d1f6fbf4c89921e78629b4f23b2f120671fb04db1dfcb09d73db5f28c6396d37f4bf792a9f69e034ce5ab077ac5c79b3d310beb0deb7707966be306065e8a2f
+  data.tar.gz: b9bdbc78813ad3e20c783e5a2745297624c7c629fc2b97a55081a5b7f904fa3be99df556dc0b6664199e4d71e2e4e02c0d59340129f6f273ff3ae2e8607de3ad

data/.env.example

@@ -0,0 +1,2 @@
+MRUBY_SRC=/path/to/mruby
+DEVELOP_MRUBY=no

data/.envrc

@@ -1,3 +1,18 @@
+# Copyright (C) 2026  gemmaro
+#
+# 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 3 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 <https://www.gnu.org/licenses/>.
+
 use guix \
     clang \
     gcc-toolchain \
@@ -7,5 +22,17 @@ use guix \
     gettext \
     gdb
 
-path_add C_INCLUDE_PATH "$(ruby -e "puts RbConfig::CONFIG['rubyhdrdir']")"
-path_add C_INCLUDE_PATH "$(ruby -e "puts RbConfig::CONFIG['rubyarchhdrdir']")"
+dotenv
+
+if [ "$DEVELOP_MRUBY" != 'yes' ]
+then
+    # CRuby
+    path_add C_INCLUDE_PATH "$(ruby -e "puts RbConfig::CONFIG['rubyhdrdir']")"
+    path_add C_INCLUDE_PATH "$(ruby -e "puts RbConfig::CONFIG['rubyarchhdrdir']")"
+else
+    # mruby
+    env_vars_required MRUBY_SRC
+    path_add C_INCLUDE_PATH include
+    path_add C_INCLUDE_PATH "$MRUBY_SRC/include"
+    path_add C_INCLUDE_PATH "$MRUBY_SRC/build/host/include"
+fi

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## CRuby version 0.1.2 and mruby version 0.1.0 - 2026-03-11
+
+- Add mruby version.
+- CRuby: Fix exception error 2 handling.
+
 ## 0.1.1 - 2026-03-09
 
 - Fix dangling pointer issue.

data/README.md

@@ -2,8 +2,9 @@
 
 This is a Ruby library for the GNU gettext PO files.  This is a C
 binding of the libgettextpo library, which is provided by the GNU
-gettext package.  It is designed to promote Ruby's idiomatic coding
-style while avoiding memory leaks.
+gettext package.  The API of this gem is designed to promote Ruby's
+idiomatic coding style while avoiding memory safety.  Currently this
+supports both CRuby and mruby.
 
 ## Installation
 
@@ -23,17 +24,22 @@ apt search libgettextpo
 #   process PO files - shared library
 ```
 
-Install the gem and add to the application's `Gemfile` by executing:
+For CRuby:
 
-```bash
-bundle add gettextpo
-```
+* Install the gem and add to the application's `Gemfile` by executing:
 
-If Bundler is not being used to manage dependencies, install the gem by executing:
+  ```bash
+  bundle add gettextpo
+  ```
 
-```bash
-gem install gettextpo
-```
+* If Bundler is not being used to manage dependencies, install the gem by executing:
+
+  ```bash
+  gem install gettextpo
+  ```
+
+For mruby, modify `build_config.rb` as you like, set `MRUBY_SRC` to
+mruby source repository, and run `./bin/compile` or `./bin/test`.
 
 ## Usage
 
@@ -56,14 +62,12 @@ end
 ```
 
 Please refer to the [API documentation][api] and test cases for
-details.
+details.  The mruby version has same API.
 
 [api]: https://gemmaro.github.io/ruby-gettextpo/
 
 ## Development
 
-`./bin/debug` to debug when segmentation fault.
-
 After checking out the repo, run `bin/setup` to install
 dependencies. Then, run `rake test` to run the tests. You can also run
 `bin/console` for an interactive prompt that will allow you to
@@ -75,6 +79,42 @@ install`.  To release a new version, update the version number in
 create a git tag for the version, push git commits and the created
 tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+File structure:
+
+```text
+  bin               : script ifles
+  build_config.rb   : for mruby
+* build_config.rb.lock
+  CHANGELOG.md
+  COPYING
+* doc               : generated by RDoc from CRuby sources
+  ext               : for CRuby
+  Gemfile           : for CRuby
+  gettextpo.gemspec : for CRuby
+  include           : for mruby
+  lib               : for CRuby
+  mrbgem.rake       : for mruby
+  mrblib            : for mruby
+* pkg               : generated by RubyGem
+  Rakefile          : for CRuby
+  README.md
+- sample.rb         : for debug purpose especially with GDB
+  sig               : for CRuby
+  src               : for mruby
+  test              : common test cases for both CRuby and mruby
+  test.cruby        : CRuby specific tests
+* tmp
+- .env
+  .env.example
+  .envrc            : Direnv config
+  .clang-format
+  .dir-locals.el    : Emacs config
+  .gitignore
+
+* generated files
+- ignored by version control
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on [Disroot][disroot].

data/Rakefile

@@ -19,9 +19,9 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
+  t.libs << "test.cruby"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test.cruby/**/*_test.rb"]
 end
 
 require "rake/extensiontask"

data/build_config.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2026  gemmaro
+#
+# 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 3 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 <https://www.gnu.org/licenses/>.
+
+MRuby::Build.new do |conf|
+  toolchain :gcc
+  conf.gem File.expand_path(File.dirname(__FILE__))
+  conf.linker.libraries << 'gettextpo'
+  conf.enable_test
+  conf.gem core: 'hal-posix-io'
+  conf.gem core: 'mruby-bin-mruby'
+  conf.gem core: 'mruby-bin-mirb'
+  conf.cc do |cc|
+    cc.flags << '-O0'
+  end
+end

data/ext/gettextpo/gettextpo.c

@@ -14,13 +14,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#include "gettextpo.h"
-
-VALUE rb_cMessage;
-VALUE rb_cMessageIterator;
-VALUE rb_cFilePos;
-VALUE rb_eError;
-
 /* FilePos, Message, and MessageIterator each hold a @file instance
  * variable (ivar) pointing to the GettextPO::File object that owns
  * the underlying po_file_t.  This prevents the File object from being
@@ -30,6 +23,18 @@ VALUE rb_eError;
  * the parent object: File -> MessageIterator -> Message -> FilePos.
  */
 
+#include "gettextpo.h"
+#include <ruby/internal/core/rdata.h>
+#include <ruby/internal/intern/variable.h>
+
+#define ERROR                                                                 \
+  rb_const_get (rb_const_get (rb_cObject, rb_intern ("GettextPO")),           \
+                rb_intern ("Error"))
+
+VALUE rb_cMessage;
+VALUE rb_cMessageIterator;
+VALUE rb_cFilePos;
+
 /* ********** error ********** */
 
 static struct
@@ -146,7 +151,7 @@ gettextpo_xerror2 (const int severity, const po_message_t message1,
                   rb_str_new_cstr (message_text2));
   VALUE args = rb_ary_new ();
   rb_ary_push (args, kwargs);
-  rb_proc_call_kw (*gettextpo_xerror_context.user_xerror, args,
+  rb_proc_call_kw (*gettextpo_xerror_context.user_xerror2, args,
                    RB_PASS_KEYWORDS);
   if (severity == PO_SEVERITY_FATAL_ERROR)
     abort ();
@@ -415,7 +420,7 @@ gettextpo_po_message_m_format_set (int argc, VALUE *argv, VALUE self)
   bool opposite = !RB_UNDEF_P (kwargs_vals[0]) && RB_TEST (kwargs_vals[0]);
   bool remove = !RB_UNDEF_P (kwargs_vals[1]) && RB_TEST (kwargs_vals[1]);
   if (opposite && remove)
-    rb_raise (rb_eError, "opposite and remove cannot be set at the same time");
+    rb_raise (ERROR, "opposite and remove cannot be set at the same time");
   po_message_set_format (DATA_PTR (self), StringValueCStr (format),
                          opposite ? 0 : (remove ? -1 : 1));
   return Qnil;
@@ -514,7 +519,7 @@ gettextpo_po_message_m_check_all (int argc, VALUE *argv, VALUE self)
   po_message_check_all (DATA_PTR (self), DATA_PTR (iterator),
                         &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
-    rb_raise (rb_eError, "check all for message failed");
+    rb_raise (ERROR, "check all for message failed");
   return Qnil;
 }
 
@@ -540,7 +545,7 @@ gettextpo_po_message_m_check_format (int argc, VALUE *argv, VALUE self)
     gettextpo_xerror_context.user_xerror2 = &kwargs_vals[1];
   po_message_check_format (DATA_PTR (self), &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
-    rb_raise (rb_eError, "check format for message failed");
+    rb_raise (ERROR, "check format for message failed");
   return Qnil;
 }
 
@@ -597,10 +602,12 @@ gettextpo_po_file_m_read (int argc, VALUE *argv, VALUE klass)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
     gettextpo_xerror_context.user_xerror2 = &kwargs_vals[1];
+  /* TODO: po_file_read can return NULL when not found?  Also check
+     null at file free. */
   DATA_PTR (self)
       = po_file_read (StringValueCStr (filename), &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
-    rb_raise (rb_eError, "failed to read");
+    rb_raise (ERROR, "failed to read");
   return self;
 }
 
@@ -626,7 +633,7 @@ gettextpo_po_file_m_write (int argc, VALUE *argv, VALUE self)
   po_file_write (DATA_PTR (self), StringValueCStr (filename),
                  &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
-    rb_raise (rb_eError, "failed to write");
+    rb_raise (ERROR, "failed to write");
   return Qnil;
 }
 
@@ -693,7 +700,7 @@ gettextpo_po_file_m_check_all (int argc, VALUE *argv, VALUE self)
     gettextpo_xerror_context.user_xerror2 = &kwargs_vals[1];
   po_file_check_all (DATA_PTR (self), &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
-    rb_raise (rb_eError, "check all for file failed");
+    rb_raise (ERROR, "check all for file failed");
   return Qnil;
 }
 
@@ -961,6 +968,4 @@ Init_gettextpo (void)
   rb_define_method (rb_cFilePos, "file", gettextpo_po_filepos_m_file, 0);
   rb_define_method (rb_cFilePos, "start_line",
                     gettextpo_po_filepos_m_start_line, 0);
-  rb_eError
-      = rb_define_class_under (rb_mGettextPO, "Error", rb_eStandardError);
 }

data/include/mrb_gettextpo.h

@@ -0,0 +1,24 @@
+/* Copyright (C) 2026  gemmaro
+ *
+ * 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 3 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/>.
+ */
+
+#ifndef MRB_GETTEXTPO_H
+#define MRB_GETTEXTPO_H
+
+#include <mruby.h>
+
+void mrb_gettextpo_gem_init(mrb_state *mrb);
+
+#endif

data/lib/gettextpo/version.rb

@@ -19,5 +19,5 @@
 
 module GettextPO
   # Version of this gem.
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/gettextpo.rb

@@ -23,6 +23,10 @@ require_relative "gettextpo/gettextpo"
 #
 # == Error handling
 #
+# There are two kinds of errors in this gem.  The first is for
+# exception handlings of libgettextpo.  The second is regular error
+# raising from this gem.
+#
 # Some functions takes exception error handling paramters like
 # +xerror+ and +xerror2+.  These parameters expect +Proc+ object which
 # takes several parameters.  See also the description of
@@ -30,8 +34,11 @@ require_relative "gettextpo/gettextpo"
 # parameters is either SEVERITY_WARNING, SEVERITY_ERROR, or
 # SEVERITY_FATAL_ERROR.
 #
+# This gem normally raises +GettextPO::Error+ object, except for the
+# standard ones, +StopIteration+ for example.
+#
 module GettextPO
-  class Error < StandardError; end
+  class Error < StandardError; end # :nodoc:
 
   # This class doesn't provide the +new+ class method.  Refre to
   # GettextPO::MessageIterator#next or

data/mrbgem.rake

@@ -0,0 +1,24 @@
+# Copyright (C) 2026  gemmaro
+#
+# 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 3 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 <https://www.gnu.org/licenses/>.
+
+MRuby::Gem::Specification.new('mruby-gettextpo') do |spec|
+  spec.license = 'GPL-3.0-or-later'
+  spec.authors = 'gemmaro'
+  spec.summary = 'GNU gettext PO parser for mruby'
+  spec.version = '0.1.0'
+  spec.homepage = 'https://git.disroot.org/gemmaro/ruby-gettextpo'
+  spec.linker.libraries << 'gettextpo'
+  spec.add_test_dependency 'mruby-io'
+end

data/mrblib/mrb_gettextpo.rb

@@ -0,0 +1,89 @@
+# Copyright (C) 2026  gemmaro
+#
+# 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 3 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 <https://www.gnu.org/licenses/>.
+
+module GettextPO
+  Error = Class.new(StandardError)
+
+  class File
+    class << self
+      # It seems that calling Proc with keyword arguments is not yet
+      # supported.
+      alias original_read read
+      def read(filename, xerror: nil, xerror2: nil)
+        original_read(filename,
+                      xerror: xerror && Proc.new { |kwargs| xerror.(**kwargs) },
+                      xerror2: xerror2 && Proc.new { |kwargs| xerror2.(**kwargs) })
+      end
+    end
+
+    # It seems that calling Proc with keyword arguments is not yet
+    # supported.
+    alias original_check_all check_all
+    def check_all(xerror: nil, xerror2: nil)
+      original_check_all(xerror: xerror && Proc.new { |kwargs| xerror.(**kwargs) },
+                         xerror2: xerror2 && Proc.new { |kwargs| xerror2.(**kwargs) })
+    end
+  end
+
+  class MessageIterator
+    def self.new
+      raise NoMethodError,
+            "please use other methods instead, such as GettextPO::File#message_iterator"
+    end
+
+    def each # yields: message
+      while true
+        begin
+          yield self.next
+        rescue StopIteration
+          return self
+        end
+      end
+    end
+
+    include Enumerable
+  end
+
+  class Message
+    def self.new
+      raise NoMethodError,
+            "please use other methods instead, such as GettextPO::MessageIterator#next"
+    end
+
+    # It seems that calling Proc with keyword arguments is not yet
+    # supported.
+    alias original_check_all check_all
+    def check_all(iterator, xerror: nil, xerror2: nil)
+      original_check_all(iterator,
+                         xerror: xerror && Proc.new { |kwargs| xerror.(**kwargs) },
+                         xerror2: xerror2 && Proc.new { |kwargs| xerror2.(**kwargs) })
+    end
+
+    # It seems that calling Proc with keyword arguments is not yet
+    # supported.
+    alias original_check_format check_format
+    def check_format(xerror: nil, xerror2: nil)
+      original_check_format(xerror: xerror && Proc.new { |kwargs| xerror.(**kwargs) },
+                            xerror2: xerror2 && Proc.new { |kwargs| xerror2.(**kwargs) })
+    end
+  end
+
+  class FilePos
+    def self.new
+      raise NoMethodError,
+            "please use other methods instead, such as GettextPO::Message#filepos"
+    end
+  end
+end

data/mrblib/version.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (C) 2026  gemmaro
+#
+# 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 3 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 <https://www.gnu.org/licenses/>.
+#++
+
+module GettextPO
+  # Version of this gem.
+  VERSION = "0.1.0"
+end