kernaux 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d133e744a0189eaf3251ac677994455f409cec24f67a665fcea9ee28759a3204
-  data.tar.gz: dc132268794f4aa577bb5c3b89837f7cd6fb821ce05d217d4891956096e7d1e3
+  metadata.gz: 575d6442a1d63f0c17a1679006ebcc61aa65174d1ff9a9feecd873fb0ed23077
+  data.tar.gz: 0dd0cb5e521520974de0eca0e7f3cf536d5557d6386094faf885575c0453f392
 SHA512:
-  metadata.gz: 19e7444add8923f062ad2be547c4f832497df83938c71782edd43b489c0920a26d07dc7adeb4a8a05a235ff202d180bd8d30758c55a1e98f55eec67dea3f215e
-  data.tar.gz: c0fbe8b5854630b0de6d44735f21efef5ff0733a8cfe8234a027d680b5369330c8e449f5d424a6211e1e716f59bc02e5fb9321dd20e62b7c0cd197513951b696
+  metadata.gz: 8e4c2dffb8776d91a701e3a2d10135a6dbaa459ec9208d921067e13fefee8a4ac368319c3e62003731f7dcfb6367c48d785ce1d0d2341dda7fdbaba5aaa99a31
+  data.tar.gz: 5ba213e81e45bca750c2a07062cf5db89650b5a49b4106909b285977c965ae90748c57527d5d851276c8f3e8ae21a6128f55c62adfd7300feb71caeecc6d8955

data/README.md

@@ -15,7 +15,7 @@ Install
 Add the following to your `Gemfile`:
 
 ```ruby
-gem 'kernaux', '~> 0.6.1'
+gem 'kernaux', '~> 0.7.0'
 ```
 
 Or add the following to your `*.gemspec`:
@@ -23,7 +23,7 @@ Or add the following to your `*.gemspec`:
 ```ruby
 Gem::Specification.new do |spec|
   # ...
-  spec.add_runtime_dependency 'kernaux', '~> 0.6.1'
+  spec.add_runtime_dependency 'kernaux', '~> 0.7.0'
   # ...
 end
 ```

data/Rakefile

@@ -20,13 +20,13 @@ CLEAN << 'doc'
 CLEAN << 'spec/examples.txt'
 
 desc 'Run default checks'
-task default: %i[test lint yard:cov]
+task default: %i[test lint]
 
 desc 'Run tests'
 task test: :spec
 
 desc 'Run code analysis tools'
-task lint: :rubocop
+task lint: %i[rubocop cppcheck yard:cov]
 
 desc 'Fix code style (rubocop --auto-correct)'
 task fix: 'rubocop:auto_correct'
@@ -66,6 +66,18 @@ task :console do
   sh 'bundle', 'exec', File.expand_path(File.join('bin', 'console'), __dir__)
 end
 
+desc 'Run cppcheck'
+task :cppcheck do
+  sh(
+    'cppcheck',
+    '--quiet',
+    '--error-exitcode=1',
+    '--std=c99',
+    '--enable=warning,style,performance,portability',
+    __dir__,
+  )
+end
+
 namespace :yard do
   desc 'Measure documentation coverage'
   task :cov do

data/ext/default/main.h

@@ -4,6 +4,12 @@
 #include <kernaux.h>
 #include <ruby.h>
 
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
 extern ID rb_intern_call;
 extern ID rb_intern_freeze;
 extern ID rb_intern_LESS;

data/ext/default/printf.c

@@ -1,208 +1,137 @@
 #include "main.h"
-
 #include "dynarg.h"
 
-#include <stddef.h>
-#include <stdlib.h>
+#define BUFFER_SIZE 4096
 
 #ifdef KERNAUX_VERSION_WITH_PRINTF
 
-/*************
- * ::KernAux *
- *************/
-
-static VALUE rb_KernAux_snprintf1(int argc, const VALUE *argv, VALUE self);
-
-static VALUE rb_KernAux_snprintf1_PROTECT(VALUE userdata);
-
-/************************
- * ::KernAux::Snprintf1 *
- ************************/
-
-static VALUE rb_KernAux_Snprintf1 = Qnil;
-
-static size_t rb_KernAux_Snprintf1_DSIZE(const void *ptr);
-
-const rb_data_type_t rb_KernAux_Snprintf1_DTYPE = {
-    .wrap_struct_name = "KernAux::Snprintf1",
-    .parent = NULL,
-    .data = NULL,
-    .flags = RUBY_TYPED_FREE_IMMEDIATELY,
-    .function = {
-        .dfree = RUBY_DEFAULT_FREE,
-        .dsize = rb_KernAux_Snprintf1_DSIZE,
-        .dmark = NULL,
-        .dcompact = NULL,
-        .reserved = { 0 },
-    },
-};
-
-struct rb_KernAux_Snprintf1_DATA {
-    const struct KernAux_PrintfFmt_Spec *spec;
-    const struct DynArg *dynarg;
-    int size;
-    const char *format;
-    char *str;
-};
-
-/********
- * Main *
- ********/
+/**
+ * Typical `printf`.
+ *
+ * @param format [String] format string
+ * @return [String] formatted output
+ *
+ * @example
+ *   KernAux.sprintf 'foo%*scar%d', 5, 'bar', 123
+ *   #=> "foo  barcar123"
+ */
+static VALUE rb_KernAux_sprintf(int argc, VALUE *argv, VALUE self);
 
 void init_printf()
 {
-    rb_gc_register_mark_object(
-        rb_KernAux_Snprintf1 =
-            // @api private
-            rb_define_class_under(rb_KernAux, "Snprintf1", rb_cObject));
-    rb_funcall(rb_KernAux, rb_intern("private_constant"), 1, ID2SYM(rb_intern("Snprintf1")));
-
-    rb_define_singleton_method(rb_KernAux, "snprintf1",
-                               rb_KernAux_snprintf1, -1);
+    rb_define_singleton_method(rb_KernAux, "sprintf", rb_KernAux_sprintf, -1);
 }
 
-/*************
- * ::KernAux *
- *************/
-
-VALUE rb_KernAux_snprintf1(
-    const int argc,
-    const VALUE *const argv_rb,
-    const VALUE self KERNAUX_UNUSED
-) {
-    if (argc < 2 || argc > 5) rb_raise(rb_eArgError, "expected 2, 3, 4 or 5 args");
+#define TAKE_ARG \
+    if (arg_index >= argc) rb_raise(rb_eArgError, "too few arguments"); \
+    VALUE arg_rb = argv[arg_index++]; \
+    do {} while (0)
 
-    const VALUE size_rb = argv_rb[0];
-    VALUE format_rb = argv_rb[1];
-
-    const int size = NUM2INT(size_rb);
-    const char *const format = StringValueCStr(format_rb);
-
-    if (size < 0) rb_raise(rb_eRangeError, "expected non-negative size");
+VALUE rb_KernAux_sprintf(const int argc, VALUE *const argv, VALUE self)
+{
+    if (argc == 0) rb_raise(rb_eArgError, "too few arguments");
 
-    const char *fmt = format;
+    const char *format = StringValueCStr(argv[0]);
+    int arg_index = 1;
+    VALUE result = rb_str_new_literal("");
 
-    while (*fmt && *fmt != '%') ++fmt;
-    if (*(fmt++) != '%') rb_raise(rb_eArgError, "invalid format");
+    while (*format) {
+        if (*format != '%') {
+            rb_str_cat(result, format, 1);
+            ++format;
+            continue;
+        }
 
-    struct KernAux_PrintfFmt_Spec spec = KernAux_PrintfFmt_Spec_create_out(&fmt);
+        ++format;
+        struct KernAux_PrintfFmt_Spec spec =
+            KernAux_PrintfFmt_Spec_create_out(&format);
 
-    while (*fmt) {
-        if (*(fmt++) == '%') rb_raise(rb_eArgError, "invalid format");
-    }
-
-    int arg_index = 2;
-    if (spec.set_width && argc > arg_index) {
-        KernAux_PrintfFmt_Spec_set_width(&spec, NUM2INT(argv_rb[arg_index++]));
-    }
-    if (spec.set_precision && argc > arg_index) {
-        KernAux_PrintfFmt_Spec_set_precision(&spec, NUM2INT(argv_rb[arg_index++]));
-    }
+        if (spec.set_width) {
+            TAKE_ARG;
+            KernAux_PrintfFmt_Spec_set_width(&spec, NUM2INT(arg_rb));
+        }
+        if (spec.set_precision) {
+            TAKE_ARG;
+            KernAux_PrintfFmt_Spec_set_precision(&spec, NUM2INT(arg_rb));
+        }
 
-    struct DynArg dynarg = DynArg_create();
-    if (argc > arg_index) {
-        VALUE arg_rb = argv_rb[arg_index];
+        struct DynArg dynarg = DynArg_create();
 
         if (spec.type == KERNAUX_PRINTF_FMT_TYPE_INT) {
+            TAKE_ARG;
             DynArg_use_long_long(&dynarg, NUM2LL(arg_rb));
         } else if (spec.type == KERNAUX_PRINTF_FMT_TYPE_UINT) {
+            TAKE_ARG;
             DynArg_use_unsigned_long_long(&dynarg, NUM2ULL(arg_rb));
         } else if (spec.type == KERNAUX_PRINTF_FMT_TYPE_FLOAT ||
                    spec.type == KERNAUX_PRINTF_FMT_TYPE_EXP)
         {
+            TAKE_ARG;
             DynArg_use_double(&dynarg, NUM2DBL(arg_rb));
         } else if (spec.type == KERNAUX_PRINTF_FMT_TYPE_CHAR) {
+            TAKE_ARG;
             Check_Type(arg_rb, T_STRING);
             DynArg_use_char(&dynarg, *StringValuePtr(arg_rb));
         } else if (spec.type == KERNAUX_PRINTF_FMT_TYPE_STR) {
+            TAKE_ARG;
             Check_Type(arg_rb, T_STRING);
             DynArg_use_str(&dynarg, StringValueCStr(arg_rb));
         }
-    }
-
-    char *const str = malloc(size);
-    if (!str) rb_raise(rb_eNoMemError, "snprintf1 buffer malloc");
-
-    struct rb_KernAux_Snprintf1_DATA *userdata;
-    VALUE userdata_rb = TypedData_Make_Struct(
-        rb_KernAux_Snprintf1,
-        struct rb_KernAux_Snprintf1_DATA,
-        &rb_KernAux_Snprintf1_DTYPE,
-        userdata
-    );
-    if (NIL_P(userdata_rb) || userdata == NULL) {
-        free(str);
-        rb_raise(rb_eNoMemError, "snprintf1 userdata alloc");
-    }
-
-    userdata->spec = &spec;
-    userdata->dynarg = &dynarg;
-    userdata->size = size;
-    userdata->format = format;
-    userdata->str = str;
-
-    int state = 0;
-    VALUE result =
-        rb_protect(rb_KernAux_snprintf1_PROTECT, userdata_rb, &state);
-
-    free(str);
-
-    if (state == 0) {
-        return result;
-    } else {
-        rb_jump_tag(state);
-    }
-}
 
-VALUE rb_KernAux_snprintf1_PROTECT(VALUE userdata_rb)
-{
-    const struct rb_KernAux_Snprintf1_DATA *userdata = NULL;
-    TypedData_Get_Struct(
-        userdata_rb,
-        struct rb_KernAux_Snprintf1_DATA,
-        &rb_KernAux_Snprintf1_DTYPE,
-        userdata
-    );
-
-    int slen;
-    if (userdata->spec->set_width) {
-        if (userdata->spec->set_precision) {
-            slen = userdata->dynarg->use_dbl
-                ? kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->width, userdata->spec->precision, userdata->dynarg->dbl)
-                : kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->width, userdata->spec->precision, userdata->dynarg->arg);
+        // 1 additional byte for the '%' character.
+        // 1 additional byte for the terminating '\0' character.
+        char old_format[2 + spec.format_limit - spec.format_start];
+        memset(old_format, '\0', sizeof(old_format));
+        old_format[0] = '%';
+        strncpy(&old_format[1], spec.format_start, sizeof(old_format) - 2);
+
+        char buffer[BUFFER_SIZE];
+        int slen;
+
+        if (spec.set_width) {
+            if (spec.set_precision) {
+                if (dynarg.use_dbl) {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.width, spec.precision,
+                                            dynarg.dbl);
+                } else {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.width, spec.precision,
+                                            dynarg.arg);
+                }
+            } else {
+                if (dynarg.use_dbl) {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.width, dynarg.dbl);
+                } else {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.width, dynarg.arg);
+                }
+            }
         } else {
-            slen = userdata->dynarg->use_dbl
-                ? kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->width, userdata->dynarg->dbl)
-                : kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->width, userdata->dynarg->arg);
+            if (spec.set_precision) {
+                if (dynarg.use_dbl) {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.precision, dynarg.dbl);
+                } else {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format,
+                                            spec.precision, dynarg.arg);
+                }
+            } else {
+                if (dynarg.use_dbl) {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format, dynarg.dbl);
+                } else {
+                    slen = kernaux_snprintf(buffer, BUFFER_SIZE, old_format, dynarg.arg);
+                }
+            }
         }
-    } else {
-        if (userdata->spec->set_precision) {
-            slen = userdata->dynarg->use_dbl
-                ? kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->precision, userdata->dynarg->dbl)
-                : kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->spec->precision, userdata->dynarg->arg);
-        } else {
-            slen = userdata->dynarg->use_dbl
-                ? kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->dynarg->dbl)
-                : kernaux_snprintf(userdata->str, userdata->size, userdata->format, userdata->dynarg->arg);
-        }
-    }
 
-    const VALUE output_rb =
-        rb_funcall(rb_str_new2(userdata->str), rb_intern_freeze, 0);
-
-    const VALUE result_rb = rb_ary_new2(2);
-    rb_ary_push(result_rb, output_rb);
-    rb_ary_push(result_rb, INT2NUM(slen));
-    return rb_funcall(result_rb, rb_intern_freeze, 0);
-}
+        rb_str_cat(result, buffer, slen);
+    }
 
-/************************
- * ::KernAux::Snprintf1 *
- ************************/
+    if (arg_index < argc) rb_raise(rb_eArgError, "too many arguments");
 
-size_t rb_KernAux_Snprintf1_DSIZE(const void *const ptr)
-{
-    return sizeof(struct rb_KernAux_Snprintf1_DATA);
+    return rb_funcall(result, rb_intern_freeze, 0);
 }
 
 #endif // KERNAUX_VERSION_WITH_PRINTF

data/lib/kernaux/version.rb

@@ -2,7 +2,7 @@
 
 module KernAux
   # Gem version.
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 
   ##
   # This module includes functions to determine if specific features are

data/lib/kernaux.rb

@@ -17,4 +17,3 @@ require_relative 'kernaux/assert'
 require_relative 'kernaux/cmdline'
 require_relative 'kernaux/errors'
 require_relative 'kernaux/ntoa'
-require_relative 'kernaux/printf'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kernaux
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Alex Kotov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,7 +197,6 @@ files:
 - lib/kernaux/cmdline.rb
 - lib/kernaux/errors.rb
 - lib/kernaux/ntoa.rb
-- lib/kernaux/printf.rb
 - lib/kernaux/version.rb
 homepage: https://github.com/tailix/libkernaux/tree/master/bindings/ruby
 licenses:
@@ -207,7 +206,7 @@ metadata:
   homepage_uri: https://github.com/tailix/libkernaux/tree/master/bindings/ruby
   source_code_uri: https://github.com/tailix/libkernaux/tree/master/bindings/ruby
   bug_tracker_uri: https://github.com/tailix/libkernaux/issues
-  documentation_uri: https://www.rubydoc.info/gems/kernaux/0.6.1
+  documentation_uri: https://www.rubydoc.info/gems/kernaux/0.7.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/kernaux/printf.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Style/Documentation
-begin; end
-
-module KernAux
-  # Buffer size for {.sprintf1}.
-  # @todo Make it dynamic.
-  SPRINTF1_BUFFER_SIZE = 10_000
-
-  # @!scope class
-
-  # @!parse [ruby]
-
-  if Version.with_printf?
-    ##
-    # Typical `printf`.
-    #
-    # @param args [Array<String,
-    #              Array<(String, Object)>,
-    #              Array<(String, Integer, Object)>>]
-    # @return [String] formatted output
-    #
-    # @example
-    #   KernAux.sprintf 'foo', ['%*s', 5, 'bar'], 'car', ['%d', 123]
-    #   #=> "foo  barcar123"
-    #
-    def self.sprintf(*args)
-      args.map do |arg|
-        if arg.is_a? Array
-          sprintf1(*arg)
-        else
-          arg
-        end
-      end.join.freeze
-    end
-
-    ##
-    # `printf` for single formatting parameter.
-    #
-    # @param format [String] formatting string
-    # @return [String] formatted output
-    #
-    # @see .sprintf Multiple formatting parameters
-    #
-    # @example
-    #   KernAux.sprintf1 '%%'            #=> "%"
-    #   KernAux.sprintf1 '%s', 'foo'     #=> "foo"
-    #   KernAux.sprintf1 '%5s', 'foo'    #=> "  foo"
-    #   KernAux.sprintf1 '%*s', 5, 'foo' #=> "  foo"
-    #
-    def self.sprintf1(format, *args)
-      snprintf1(SPRINTF1_BUFFER_SIZE, format, *args).first
-    end
-
-    ##
-    # @!method snprintf1(buffer_size, format, ...)
-    # `printf` for single formatting parameter with manual buffer size.
-    #
-    # @param buffer_size [Integer] buffer size (including terminating null
-    #   character)
-    # @param format [String] formatting string
-    # @return [Array<(String, Integer)>] formatted output and it's size
-    #
-    # @see .sprintf1 Automatic buffer size
-    ##
-  end
-end
-
-# rubocop:enable Style/Documentation