gettextpo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ac361edc71b888a2d229cde89bb5502d51a46b3461a8d335879a5a4234141c
-  data.tar.gz: fc2308b078480e83ba35408a8b37eb2044bde4066b73390946507fba6da7d1bd
+  metadata.gz: 3ac67f013230155611dd5bd8f673a19eb8d84153dbc3240e3f0849a3a78ebf9d
+  data.tar.gz: 5c3d1ac85ab300ccd98b798948448b64be26d1b69c055b0ec1e11c08641209d9
 SHA512:
-  metadata.gz: c987dabcd215ecaa0faaf18958c62337443c838432eb45b7f154132aa1c7ebe11cb5771cc7b0e17fd9317de73e2c3c298aea28baca61c5305f5ffe4f1251d934
-  data.tar.gz: 616e8b974e467b8bfbb11f8b316d937769bcead95bdf2785c0bd84767e8589a8e13e8ed41fd6bdc8fa8e511d15491130995f739506f96bf7a0d9c0116b001566
+  metadata.gz: 5cd5653bdff4094cbf3b14f57ae30b224ae0a20b775cf072ef008bf851e8fce4f129c8ffeb9071d271223c70c78035d717d82d70f8f00f32d1a2fe5c2ffae4d3
+  data.tar.gz: 77e26a94e04627ba399495819e25972b6dca2a9742e27e8c6ae9f5fff5032a3987f64e003707631c6a13ce38c4694a9d5a5692179a7e938d40023288d5965aa2

data/.dir-locals.el

@@ -1,5 +1,6 @@
 ;;; Directory Local Variables            -*- no-byte-compile: t -*-
 ;;; For more information see (info "(emacs) Directory Variables")
 
-((nil . ((eval . (progn (add-to-list 'grep-find-ignored-directories "tmp")
+((nil . ((eval . (progn (require 'grep)
+                        (add-to-list 'grep-find-ignored-directories "tmp")
                         (add-to-list 'grep-find-ignored-directories "doc"))))))

data/.rdoc_options

@@ -4,3 +4,4 @@ exclude:
   - bin
   - Rakefile
   - Gemfile
+  - vendor

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change log of Ruby GettextPO gem
 
-## [Unreleased]
+## Unreleased
 
-## [0.1.0] - 2026-03-07
+## 0.1.1 - 2026-03-09
+
+- Fix dangling pointer issue.
+- Add libgettextpo version constant.
+- Add severities constants.
+- Improve API document.
+
+## 0.1.0 - 2026-03-07
 
 - Initial release

data/README.md

@@ -55,16 +55,15 @@ GettextPO::File.read(po_path).message_iterator.each do |message|
 end
 ```
 
-Please refer to the API documentation and test cases for details.
+Please refer to the [API documentation][api] and test cases for
+details.
+
+[api]: https://gemmaro.github.io/ruby-gettextpo/
 
 ## Development
 
 `./bin/debug` to debug when segmentation fault.
 
-References: [RubyのC APIの手引き 決定版][def], [Developers'
-documentation for Ruby][dev], [Rubyの拡張ライブラリの作り方][ext],
-[library rdoc/parser/c][parser], and [library rdoc][rdoc].
-
 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
@@ -76,16 +75,16 @@ 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).
 
-[def]: https://gemmaro.github.io/emberb/
-[dev]: https://docs.ruby-lang.org/capi/en/master/index.html
-[ext]: https://docs.ruby-lang.org/en/master/extension_ja_rdoc.html
-[parser]: https://docs.ruby-lang.org/ja/latest/library/rdoc=2fparser=2fc.html
-[rdoc]: https://docs.ruby-lang.org/ja/latest/library/rdoc.html
-
 ## Contributing
 
-Bug reports and pull requests are welcome on Disroot at
-<https://git.disroot.org/gemmaro/ruby-gettextpo>.
+Bug reports and pull requests are welcome on [Disroot][disroot].
+
+Other links:
+
+* [RubyGems](https://rubygems.org/gems/gettextpo)
+* [GitHub repository](https://github.com/gemmaro/ruby-gettextpo)
+
+[disroot]: https://git.disroot.org/gemmaro/ruby-gettextpo
 
 ## License
 

data/ext/gettextpo/gettextpo.c

@@ -1,5 +1,4 @@
-/**
- * Copyright (C) 2026  gemmaro
+/* 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
@@ -16,36 +15,21 @@
  */
 
 #include "gettextpo.h"
-#include <gettext-po.h>
-#include <ruby/internal/anyargs.h>
-#include <ruby/internal/arithmetic/int.h>
-#include <ruby/internal/core/rdata.h>
-#include <ruby/internal/core/rstring.h>
-#include <ruby/internal/core/rtypeddata.h>
-#include <ruby/internal/eval.h>
-#include <ruby/internal/globals.h>
-#include <ruby/internal/intern/array.h>
-#include <ruby/internal/intern/hash.h>
-#include <ruby/internal/intern/object.h>
-#include <ruby/internal/intern/proc.h>
-#include <ruby/internal/intern/range.h>
-#include <ruby/internal/intern/string.h>
-#include <ruby/internal/intern/vm.h>
-#include <ruby/internal/module.h>
-#include <ruby/internal/scan_args.h>
-#include <ruby/internal/special_consts.h>
-#include <ruby/internal/symbol.h>
-#include <ruby/internal/value.h>
-#include <stdbool.h>
-#include <stddef.h>
-#include <stdlib.h>
-#include <time.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
+ * garbage collected while any of these objects are still alive, which
+ * would otherwise cause their po_file_t pointers to become dangling.
+ * When allocating one of these objects, @file must be propagated from
+ * the parent object: File -> MessageIterator -> Message -> FilePos.
+ */
+
 /* ********** error ********** */
 
 static struct
@@ -53,6 +37,7 @@ static struct
   bool error;
   VALUE *user_xerror;
   VALUE *user_xerror2;
+  VALUE *file;
 } gettextpo_xerror_context = {};
 
 static void
@@ -61,6 +46,7 @@ gettextpo_xerror_context_reset (void)
   gettextpo_xerror_context.error = false;
   gettextpo_xerror_context.user_xerror = NULL;
   gettextpo_xerror_context.user_xerror2 = NULL;
+  gettextpo_xerror_context.file = NULL;
 }
 
 static void
@@ -79,6 +65,8 @@ gettextpo_xerror (const int severity, const po_message_t message,
     {
       VALUE message_value = rb_obj_alloc (rb_cMessage);
       DATA_PTR (message_value) = message;
+      rb_ivar_set (message_value, rb_intern ("@file"),
+                   *gettextpo_xerror_context.file);
       rb_hash_aset (kwargs, ID2SYM (rb_intern ("message")), message_value);
     }
   if (filename)
@@ -120,6 +108,8 @@ gettextpo_xerror2 (const int severity, const po_message_t message1,
     {
       VALUE message_value1 = rb_obj_alloc (rb_cMessage);
       DATA_PTR (message_value1) = message1;
+      rb_ivar_set (message_value1, rb_intern ("@file"),
+                   *gettextpo_xerror_context.file);
       rb_hash_aset (kwargs, ID2SYM (rb_intern ("message1")), message_value1);
     }
   if (filename1)
@@ -138,6 +128,8 @@ gettextpo_xerror2 (const int severity, const po_message_t message1,
     {
       VALUE message_value2 = rb_obj_alloc (rb_cMessage);
       DATA_PTR (message_value2) = message2;
+      rb_ivar_set (message_value2, rb_intern ("@file"),
+                   *gettextpo_xerror_context.file);
       rb_hash_aset (kwargs, ID2SYM (rb_intern ("message2")), message_value2);
     }
   if (filename2)
@@ -470,6 +462,8 @@ gettextpo_po_message_m_filepos (VALUE self, VALUE index)
     {
       VALUE filepos = rb_obj_alloc (rb_cFilePos);
       DATA_PTR (filepos) = pos;
+      rb_ivar_set (filepos, rb_intern ("@file"),
+                   rb_ivar_get (self, rb_intern ("@file")));
       return filepos;
     }
   else
@@ -500,7 +494,7 @@ gettextpo_po_message_m_add_filepos (VALUE self, VALUE file, VALUE start_line)
 /**
  * call-seq: check_all (iterator, xerror: nil, xerror2: nil)
  *
- * See also GettextPO::File.read.
+ * See also GettextPO::File.read for exception error handlings.
  */
 VALUE
 gettextpo_po_message_m_check_all (int argc, VALUE *argv, VALUE self)
@@ -511,6 +505,8 @@ gettextpo_po_message_m_check_all (int argc, VALUE *argv, VALUE self)
   VALUE kwargs_vals[] = { Qundef, Qundef };
   rb_get_kwargs (kwargs, kwargs_ids, 0, 2, kwargs_vals);
   gettextpo_xerror_context_reset ();
+  VALUE file = rb_ivar_get (self, rb_intern ("@file"));
+  gettextpo_xerror_context.file = &file;
   if (kwargs_vals[0] != Qundef)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
@@ -525,7 +521,7 @@ gettextpo_po_message_m_check_all (int argc, VALUE *argv, VALUE self)
 /**
  * call-seq: check_format (xerror: nil, xerror2: nil)
  *
- * See also GettextPO::File.read.
+ * See also GettextPO::File.read for exception error handlings.
  */
 VALUE
 gettextpo_po_message_m_check_format (int argc, VALUE *argv, VALUE self)
@@ -536,6 +532,8 @@ gettextpo_po_message_m_check_format (int argc, VALUE *argv, VALUE self)
   VALUE kwargs_vals[] = { Qundef, Qundef };
   rb_get_kwargs (kwargs, kwargs_ids, 0, 2, kwargs_vals);
   gettextpo_xerror_context_reset ();
+  VALUE file = rb_ivar_get (self, rb_intern ("@file"));
+  gettextpo_xerror_context.file = &file;
   if (kwargs_vals[0] != Qundef)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
@@ -562,6 +560,10 @@ gettextpo_po_file_alloc (VALUE self)
   return TypedData_Wrap_Struct (self, &gettextpo_po_file_type, NULL);
 }
 
+/**
+ * See also #message_iterator and GettextPO::MessageIterator#insert
+ * methods for the further manipulations.
+ */
 VALUE
 gettextpo_po_file_m_initialize (VALUE self)
 {
@@ -577,7 +579,8 @@ gettextpo_po_file_m_initialize (VALUE self)
  * +multiline+, and +message_text+.  +xerror2+ takes keyword arguments
  * +severity+, +message1+, +filename1+, +lineno1+, +column1+,
  * +multiline1+, +message_text1+, +message2+, +filename2+, +lineno2+,
- * +column2+, +multiline2+, and +message_text2+.
+ * +column2+, +multiline2+, and +message_text2+.  See also GettextPO
+ * for general exception handlings.
  */
 VALUE
 gettextpo_po_file_m_read (int argc, VALUE *argv, VALUE klass)
@@ -588,11 +591,12 @@ gettextpo_po_file_m_read (int argc, VALUE *argv, VALUE klass)
   VALUE kwargs_vals[] = { Qundef, Qundef };
   rb_get_kwargs (kwargs, kwargs_ids, 0, 2, kwargs_vals);
   gettextpo_xerror_context_reset ();
+  VALUE self = rb_obj_alloc (klass);
+  gettextpo_xerror_context.file = &self;
   if (kwargs_vals[0] != Qundef)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
     gettextpo_xerror_context.user_xerror2 = &kwargs_vals[1];
-  VALUE self = rb_obj_alloc (klass);
   DATA_PTR (self)
       = po_file_read (StringValueCStr (filename), &gettextpo_xerror_handler);
   if (gettextpo_xerror_context.error)
@@ -603,7 +607,7 @@ gettextpo_po_file_m_read (int argc, VALUE *argv, VALUE klass)
 /**
  * call-seq: write (filename, xerror: nil, xerror2: nil)
  *
- * See also ::read.
+ * See also ::read for exception error handlings.
  */
 VALUE
 gettextpo_po_file_m_write (int argc, VALUE *argv, VALUE self)
@@ -614,6 +618,7 @@ gettextpo_po_file_m_write (int argc, VALUE *argv, VALUE self)
   VALUE kwargs_vals[] = { Qundef, Qundef };
   rb_get_kwargs (kwargs, kwargs_ids, 0, 2, kwargs_vals);
   gettextpo_xerror_context_reset ();
+  gettextpo_xerror_context.file = &self;
   if (kwargs_vals[0] != Qundef)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
@@ -646,11 +651,12 @@ gettextpo_po_file_m_message_iterator (int argc, VALUE *argv, VALUE self)
   VALUE iterator = rb_obj_alloc (rb_cMessageIterator);
   DATA_PTR (iterator) = po_message_iterator (
       DATA_PTR (self), NIL_P (domain) ? NULL : StringValueCStr (domain));
+  rb_ivar_set (iterator, rb_intern ("@file"), self);
   return iterator;
 }
 
 /**
- * call-seq: domain_header (domain)
+ * call-seq: domain_header (domain = nil)
  *
  * +domain+ can be +nil+ to use a default.  Possibly returns +nil+.
  *
@@ -669,7 +675,7 @@ gettextpo_po_file_m_domain_header (int argc, VALUE *argv, VALUE self)
 /**
  * call-seq: check_all (xerror: nil, xerror2: nil)
  *
- * See also ::read.
+ * See also ::read for exception error handlings.
  */
 VALUE
 gettextpo_po_file_m_check_all (int argc, VALUE *argv, VALUE self)
@@ -680,6 +686,7 @@ gettextpo_po_file_m_check_all (int argc, VALUE *argv, VALUE self)
   VALUE kwargs_vals[] = { Qundef, Qundef };
   rb_get_kwargs (kwargs, kwargs_ids, 0, 2, kwargs_vals);
   gettextpo_xerror_context_reset ();
+  gettextpo_xerror_context.file = &self;
   if (kwargs_vals[0] != Qundef)
     gettextpo_xerror_context.user_xerror = &kwargs_vals[0];
   if (kwargs_vals[1] != Qundef)
@@ -718,6 +725,8 @@ gettextpo_po_message_iterator_m_next (VALUE self)
     {
       VALUE message_value = rb_obj_alloc (rb_cMessage);
       DATA_PTR (message_value) = message;
+      rb_ivar_set (message_value, rb_intern ("@file"),
+                   rb_ivar_get (self, rb_intern ("@file")));
       return message_value;
     }
   else
@@ -736,6 +745,8 @@ gettextpo_po_message_iterator_m_insert (VALUE self, VALUE msgid, VALUE msgstr)
   po_message_insert (DATA_PTR (self), message);
   VALUE value = rb_obj_alloc (rb_cMessage);
   DATA_PTR (value) = message;
+  rb_ivar_set (value, rb_intern ("@file"),
+               rb_ivar_get (self, rb_intern ("@file")));
   return value;
 }
 
@@ -831,6 +842,8 @@ gettextpo_po_format_list (VALUE self)
  * call-seq: format_pretty_name (format)
  *
  * Possibly returns +nil+.
+ *
+ * See also ::formats method for available format types.
  */
 VALUE
 gettextpo_po_format_pretty_name (VALUE self, VALUE format)
@@ -845,6 +858,14 @@ RUBY_FUNC_EXPORTED void
 Init_gettextpo (void)
 {
   VALUE rb_mGettextPO = rb_define_module ("GettextPO");
+  rb_define_const (rb_mGettextPO, "LIBGETTEXTPO_VERSION",
+                   INT2NUM (libgettextpo_version));
+  rb_define_const (rb_mGettextPO, "SEVERITY_WARNING",
+                   INT2NUM (PO_SEVERITY_WARNING));
+  rb_define_const (rb_mGettextPO, "SEVERITY_ERROR",
+                   INT2NUM (PO_SEVERITY_ERROR));
+  rb_define_const (rb_mGettextPO, "SEVERITY_FATAL_ERROR",
+                   INT2NUM (PO_SEVERITY_FATAL_ERROR));
   rb_define_singleton_method (rb_mGettextPO, "header_entry_value",
                               gettextpo_m_header_entry_value, 2);
   rb_define_singleton_method (rb_mGettextPO, "header_with_updated_entry_value",

data/ext/gettextpo/gettextpo.h

@@ -1,5 +1,4 @@
-/**
- * Copyright (C) 2026  gemmaro
+/* 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
@@ -18,6 +17,7 @@
 #ifndef GETTEXTPO_H
 #define GETTEXTPO_H 1
 
-#include "ruby.h"
+#include <gettext-po.h>
+#include <ruby.h>
 
 #endif /* GETTEXTPO_H */

data/lib/gettextpo/version.rb

@@ -18,5 +18,6 @@
 #++
 
 module GettextPO
-  VERSION = "0.1.0"
+  # Version of this gem.
+  VERSION = "0.1.1"
 end

data/lib/gettextpo.rb

@@ -20,6 +20,16 @@ require_relative "gettextpo/gettextpo"
 
 # The main entrypoints to parse PO files are GettextPO::File.new and
 # GettextPO::File.read.
+#
+# == Error handling
+#
+# 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
+# GettextPO::File.read method.  The +severity+ parameter among these
+# parameters is either SEVERITY_WARNING, SEVERITY_ERROR, or
+# SEVERITY_FATAL_ERROR.
+#
 module GettextPO
   class Error < StandardError; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gettextpo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - gemmaro
@@ -40,6 +40,7 @@ metadata:
   rubygems_mfa_required: 'true'
   bug_tracker_uri: https://git.disroot.org/gemmaro/ruby-gettextpo/issues
   changelog_uri: https://git.disroot.org/gemmaro/ruby-gettextpo/src/branch/main/CHANGELOG.md
+  documentation_uri: https://gemmaro.github.io/ruby-gettextpo/
   homepage_uri: https://git.disroot.org/gemmaro/ruby-gettextpo
   source_code_uri: https://git.disroot.org/gemmaro/ruby-gettextpo
   wiki_uri: https://git.disroot.org/gemmaro/ruby-gettextpo/wiki