mandoc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98e2d86617e25d67411ee76847b84f7bcd2b1ed85876a6b40cb5dcc913058d6
-  data.tar.gz: ed587c27541508346883ed329355afdbb1d25dd715917ffcdb3d3da95e4b7114
+  metadata.gz: 62c691ef11f7b5ef74ce09aff085d9655b1834bfec02673eca32d2163ffb7b3b
+  data.tar.gz: 2903384369a5cc5339272871043c40ece7012b131d0a557c93545d66399bc08d
 SHA512:
-  metadata.gz: 0aa61cf65cda7bbb65b7b86af1e2e8c9e35baa842d3519c80a0c4fa7a928262eccd13039ce0759126dd347b885e794de03d0674dbb72058e5986d28197a0fba7
-  data.tar.gz: 0fddc76d82ba3fff20bdf0b4aed7a887a3b4af23d9ac07484f726d86ecf93f7dbafeb689b250e01fa3b9a114b285e9d25f5f6be5aaf0c325347c33418464d6ee
+  metadata.gz: b5d2efa3c436af71411465613a04332ac0e75293f2eb7fa2f5bb4b4428646c306e9bd238a03cf78d0e1dc175522cb0727fc186b355a069132d0e45b336d032ca
+  data.tar.gz: a66981faecaf2166f3272cd7e510437f2c7847f254bb4269220e374e34f9835fdef3563894e62cc1cc3894a117766adf18ef8589f220474ba96a9b70ace7c0e3

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 0.0.2 - 2026-07-02
+
+- Removed unused `File` class
+
 ## 0.0.1 - 2026-07-02
 
 - Initial release

data/README.md

@@ -73,6 +73,9 @@ On OpenBSD, and if you are using packaged `ruby`, native compilation
 can fail because `install` command has `-o root -g bin` flags.  You
 can overwrite the behavior; please refer to `bin/compile` script.
 
+On Guix, edit `CC=` line in `mandoc-1.14.6/configure` script.  For
+example, if using GCC, change to `CC=gcc`.
+
 References: [my past project which uses similar mkmf strategy][re]
 
 [re]: https://github.com/gemmaro/ruby-eldc

data/ext/mandoc/rb_mandoc.c

@@ -63,6 +63,10 @@ rb_parser_alloc (VALUE klass)
 }
 
 static const rb_data_type_t rb_meta_type;
+/**
+ * :call-seq:
+ *   parse_file (filename) -> Meta
+ */
 static VALUE
 rb_parser_m_parse_file (VALUE self, VALUE fname)
 {
@@ -123,6 +127,10 @@ rb_meta_alloc (VALUE klass)
   return rb_data_typed_object_wrap (rb_cMeta, NULL, &rb_meta_type);
 }
 
+/**
+ * :call-seq:
+ *   deroff -> String
+ */
 static VALUE
 rb_meta_m_deroff (VALUE self)
 {
@@ -135,6 +143,10 @@ rb_meta_m_deroff (VALUE self)
   return str;
 }
 
+/**
+ * :call-seq:
+ *   section -> String
+ */
 static VALUE
 rb_meta_m_section (VALUE self)
 {
@@ -142,6 +154,10 @@ rb_meta_m_section (VALUE self)
   return rb_str_new_cstr (meta->msec);
 }
 
+/**
+ * :call-seq:
+ *   volume -> String
+ */
 static VALUE
 rb_meta_m_volume (VALUE self)
 {
@@ -149,6 +165,10 @@ rb_meta_m_volume (VALUE self)
   return rb_str_new_cstr (meta->vol);
 }
 
+/**
+ * :call-seq:
+ *   os -> String
+ */
 static VALUE
 rb_meta_m_os (VALUE self)
 {
@@ -156,6 +176,10 @@ rb_meta_m_os (VALUE self)
   return rb_str_new_cstr (meta->os);
 }
 
+/**
+ * :call-seq:
+ *   arch -> String or nil
+ */
 static VALUE
 rb_meta_m_arch (VALUE self)
 {
@@ -163,6 +187,10 @@ rb_meta_m_arch (VALUE self)
   return meta->arch ? rb_str_new_cstr (meta->arch) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   title -> String
+ */
 static VALUE
 rb_meta_m_title (VALUE self)
 {
@@ -170,6 +198,10 @@ rb_meta_m_title (VALUE self)
   return rb_str_new_cstr (meta->title);
 }
 
+/**
+ * :call-seq:
+ *   name -> String
+ */
 static VALUE
 rb_meta_m_name (VALUE self)
 {
@@ -177,6 +209,10 @@ rb_meta_m_name (VALUE self)
   return rb_str_new_cstr (meta->name);
 }
 
+/**
+ * :call-seq:
+ *   date -> String
+ */
 static VALUE
 rb_meta_m_date (VALUE self)
 {
@@ -184,6 +220,10 @@ rb_meta_m_date (VALUE self)
   return rb_str_new_cstr (meta->date);
 }
 
+/**
+ * :call-seq:
+ *   so_target -> String or nil
+ */
 static VALUE
 rb_meta_m_so_target (VALUE self)
 {
@@ -191,6 +231,10 @@ rb_meta_m_so_target (VALUE self)
   return meta->sodest ? rb_str_new_cstr (meta->sodest) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   has_body? -> false or true
+ */
 static VALUE
 rb_meta_m_has_body (VALUE self)
 {
@@ -248,6 +292,10 @@ rb_restore_stdout (int original_stdout, int read_end)
   return md;
 }
 
+/**
+ * :call-seq:
+ *   tree -> String
+ */
 static VALUE
 rb_mdocmeta_m_tree (VALUE self)
 {
@@ -261,6 +309,10 @@ rb_mdocmeta_m_tree (VALUE self)
   return rb_restore_stdout (original_stdout, read_end);
 }
 
+/**
+ * :call-seq:
+ *   tree -> String
+ */
 static VALUE
 rb_manmeta_m_tree (VALUE self)
 {
@@ -274,6 +326,10 @@ rb_manmeta_m_tree (VALUE self)
   return rb_restore_stdout (original_stdout, read_end);
 }
 
+/**
+ * :call-seq:
+ *   man -> String
+ */
 static VALUE
 rb_mdocmeta_m_man (VALUE self)
 {
@@ -288,6 +344,9 @@ rb_mdocmeta_m_man (VALUE self)
 }
 
 /**
+ * :call-seq:
+ *   man -> String
+ *
  * The result depends on <tt>struct mparse</tt>, which means this
  * method must be called BEFORE the next +parse_file+ method calling.
  */
@@ -304,6 +363,10 @@ rb_manmeta_m_man (VALUE self)
   return rb_restore_stdout (original_stdout, read_end);
 }
 
+/**
+ * :call-seq:
+ *   markdown -> String
+ */
 static VALUE
 rb_mdocmeta_m_markdown (VALUE self)
 {
@@ -358,6 +421,10 @@ rb_wrap_node (struct roff_node *node)
   return rb_data_typed_object_wrap (klass, node, &rb_node_type);
 }
 
+/**
+ * :call-seq:
+ *   first_node -> Node
+ */
 static VALUE
 rb_meta_m_first_node (VALUE self)
 {
@@ -384,6 +451,10 @@ rb_node_alloc (VALUE klass)
   return rb_data_typed_object_wrap (klass, NULL, &rb_node_type);
 }
 
+/**
+ * :call-seq:
+ *   parent -> Node or nil
+ */
 static VALUE
 rb_node_m_parent (VALUE self)
 {
@@ -391,6 +462,10 @@ rb_node_m_parent (VALUE self)
   return node->parent ? rb_wrap_node (node->parent) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   first_child -> Node or nil
+ */
 static VALUE
 rb_node_m_first_child (VALUE self)
 {
@@ -398,6 +473,10 @@ rb_node_m_first_child (VALUE self)
   return node->child ? rb_wrap_node (node->child) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   last_child -> Node or nil
+ */
 static VALUE
 rb_node_m_last_child (VALUE self)
 {
@@ -405,6 +484,10 @@ rb_node_m_last_child (VALUE self)
   return node->last ? rb_wrap_node (node->last) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   next_sibling -> Node or nil
+ */
 static VALUE
 rb_node_m_next_sibling (VALUE self)
 {
@@ -412,6 +495,10 @@ rb_node_m_next_sibling (VALUE self)
   return node->next ? rb_wrap_node (node->next) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   prev_sibling -> Node or nil
+ */
 static VALUE
 rb_node_m_prev_sibling (VALUE self)
 {
@@ -419,6 +506,10 @@ rb_node_m_prev_sibling (VALUE self)
   return node->prev ? rb_wrap_node (node->prev) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   head -> Node or nil
+ */
 static VALUE
 rb_node_m_head (VALUE self)
 {
@@ -426,6 +517,10 @@ rb_node_m_head (VALUE self)
   return node->head ? rb_wrap_node (node->head) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   body -> Node or nil
+ */
 static VALUE
 rb_node_m_body (VALUE self)
 {
@@ -433,6 +528,10 @@ rb_node_m_body (VALUE self)
   return node->body ? rb_wrap_node (node->body) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   tail -> Node or nil
+ */
 static VALUE
 rb_node_m_tail (VALUE self)
 {
@@ -440,6 +539,10 @@ rb_node_m_tail (VALUE self)
   return node->tail ? rb_wrap_node (node->tail) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   text -> String or nil
+ */
 static VALUE
 rb_node_m_text (VALUE self)
 {
@@ -447,6 +550,10 @@ rb_node_m_text (VALUE self)
   return node->string ? rb_str_new_cstr (node->string) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   tag -> String or nil
+ */
 static VALUE
 rb_node_m_tag (VALUE self)
 {
@@ -454,6 +561,10 @@ rb_node_m_tag (VALUE self)
   return node->string ? rb_str_new_cstr (node->tag) : RUBY_Qnil;
 }
 
+/**
+ * :call-seq:
+ *   line -> Integer
+ */
 static VALUE
 rb_node_m_line (VALUE self)
 {
@@ -461,6 +572,10 @@ rb_node_m_line (VALUE self)
   return rb_int2num_inline (node->line);
 }
 
+/**
+ * :call-seq:
+ *   column -> Integer
+ */
 static VALUE
 rb_node_m_column (VALUE self)
 {
@@ -468,6 +583,10 @@ rb_node_m_column (VALUE self)
   return rb_int2num_inline (node->pos);
 }
 
+/**
+ * :call-seq:
+ *   name -> String
+ */
 static VALUE
 rb_node_m_name (VALUE self)
 {
@@ -499,10 +618,6 @@ Init_mandoc (void)
   rb_define_method (rb_cMeta, "so_target", rb_meta_m_so_target, 0);
   rb_define_method (rb_cMeta, "has_body?", rb_meta_m_has_body, 0);
 
-  /* TODO: Converters for HTML, PDF, ASCII, UTF8, LOCALE, PS
-     (PostScript) are tricky, since it expects outdata (void*) of
-     struct outstate pointer. */
-
   rb_cMdocMeta = rb_define_class_under (rb_mMandoc, "MdocMeta", rb_cMeta);
   rb_define_method (rb_cMdocMeta, "markdown", rb_mdocmeta_m_markdown, 0);
   rb_define_method (rb_cMdocMeta, "tree", rb_mdocmeta_m_tree, 0);

data/lib/mandoc/version.rb

@@ -15,5 +15,5 @@
 #++
 
 module Mandoc
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mandoc.rb

@@ -17,10 +17,18 @@
 require_relative "mandoc/version"
 require "mandoc/mandoc"
 
+# The main entrypoint should be Mandoc::Parser.new.
 module Mandoc
-  # This class doen't have +new+ method.  Use Mandoc::Parser#open
-  # instead.
-  class File
-    private_class_method :new
+  class Parser
+    ##
+    # :method: new
+  end
+
+  #--
+  # TODO: Converters for HTML, PDF, ASCII, UTF8, LOCALE, PS
+  # (PostScript) are tricky, since it expects outdata (void*) of
+  # struct outstate pointer.
+  #++
+  class MdocMeta
   end
 end

data/mandoc-1.14.6/config.h

@@ -2,14 +2,17 @@
 #error "Do not use C++.  See the INSTALL file."
 #endif
 
+#define _GNU_SOURCE
+#include <sys/types.h>
 
 #define MAN_CONF_FILE "/etc/man.conf"
 #define MANPATH_BASE "/usr/share/man:/usr/X11R6/man"
 #define MANPATH_DEFAULT "/usr/share/man:/usr/X11R6/man:/usr/local/man"
-#define OSENUM MANDOC_OS_OPENBSD
-#define UTF8_LOCALE "en_US.UTF-8"
+#define OSENUM MANDOC_OS_OTHER
+#define UTF8_LOCALE "en_US.utf8"
+#define EFTYPE EINVAL
 
-#define HAVE_DIRENT_NAMLEN 1
+#define HAVE_DIRENT_NAMLEN 0
 #define HAVE_ENDIAN 1
 #define HAVE_ERR 1
 #define HAVE_FTS 1
@@ -21,11 +24,11 @@
 #define HAVE_MKDTEMP 1
 #define HAVE_MKSTEMPS 1
 #define HAVE_NTOHL 1
-#define HAVE_PLEDGE 1
-#define HAVE_PROGNAME 1
+#define HAVE_PLEDGE 0
+#define HAVE_PROGNAME 0
 #define HAVE_REALLOCARRAY 1
-#define HAVE_RECALLOCARRAY 1
-#define HAVE_REWB_BSD 1
+#define HAVE_RECALLOCARRAY 0
+#define HAVE_REWB_BSD 0
 #define HAVE_REWB_SYSV 1
 #define HAVE_SANDBOX_INIT 0
 #define HAVE_STRCASESTR 1
@@ -35,11 +38,11 @@
 #define HAVE_STRNDUP 1
 #define HAVE_STRPTIME 1
 #define HAVE_STRSEP 1
-#define HAVE_STRTONUM 1
-#define HAVE_SYS_ENDIAN 1
+#define HAVE_STRTONUM 0
+#define HAVE_SYS_ENDIAN 0
 #define HAVE_VASPRINTF 1
 #define HAVE_WCHAR 1
-#define HAVE_OHASH 1
+#define HAVE_OHASH 0
 #define NEED_XPG4_2 0
 
 #define BINM_APROPOS "apropos"
@@ -50,3 +53,7 @@
 #define BINM_WHATIS "whatis"
 #define BINM_PAGER "less"
 
+extern	const char *getprogname(void);
+extern	void	  setprogname(const char *);
+extern	void	 *recallocarray(void *, size_t, size_t, size_t);
+extern	long long strtonum(const char *, long long, long long, const char **);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mandoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - gemmaro
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: mdoc/man parsing library
 test_files: []