nxxd 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5235dca5d1f46e13930f0d67076555a589a8966f4e83abf933a805ca722abbfe
+  data.tar.gz: 16ee0e67f7b9b8d765639470d7aff99c8e4aa71a5668493808589fcd42089ccd
+SHA512:
+  metadata.gz: b9b88cd360d0af386401df8eada33e03718790136ce709d4f5d74ea4f54311d2a22df54e7f6d157d6a8ed53a5d073ccf1958f40f582aa8d2cae3b4d7f74dc175
+  data.tar.gz: 3e6a4f1b49aeef9867e80b0b900b99951a6b37d53d4b8f1ee82d37f9d58f773355f2a72d651e5df734022d942d7673d0c7af76f384f5a8cd564eb69ff2b2dadc

data/LICENSE

@@ -0,0 +1,52 @@
+# BSD-2-clause license, extended by language use conditions
+
+Copyright (C) 2025, Bertram Scharpf <software@bertram-scharpf.de>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Redistributions must not contain any clauses about anticipated
+    harassment or discrimination, nor must they be held in a so-called
+    "inclusive language". As far as German language is used, the
+    conditions mentioned below additionally apply.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+## Use of the German Language
+
+Beim Gebrauch deutscher Sprache sind Weiterentwicklungen und
+-verbreitungen nur gestattet unter Einhaltung sowie abermaligen
+Einforderns folgender zusätzlicher Bedingungen:
+
+  * Keine Verwendung von sogenannter „geschlechtergerechter Sprache“,
+    also Anfügen von weiblichen Endungen mit Binnen-I, Sternchen,
+    Doppelpunkt, Unterstrich oder ähnlichem, oder Konstruktionen, die
+    den Sachverhalt falsch wiedergeben („Radfahrende“, „Studierende“).
+
+  * Keine Verwendung der „reformierten Rechtschreibung“ von 1996,
+    insbesondere Doppel-S am Silbenende, „plazieren“ mit T, sowie
+    Großschreibung von Wendungen wie „des weiteren“.
+
+
+<!-- vim:set ft=markdown : -->

data/README.md

@@ -0,0 +1,106 @@
+# Nxxd Hex Dump tool
+
+Yet another Xxd reimplementation.
+
+The original Xxd is part of the Vim editor (<https://www.vim.org>).
+This one is written in plain Ruby.
+
+
+## Installation
+
+```bash
+sudo gem install nxxd
+```
+
+
+## Command line execution
+
+Plain output:
+
+```bash
+echo hello | grep --color=yes -nH ll | nxxd
+dd if=/dev/urandom bs=16 count=4 status=none | nxxd
+```
+
+The filename will be added as a comment, unless you explicitly ask to refrain
+from that.
+
+```bash
+nxxd    /bin/sleep 2>/dev/null | head
+nxxd -p /bin/sleep 2>/dev/null | head
+```
+
+Repeated lines will be squeezed by default.
+
+```bash
+dd if=/dev/zero bs=16 count=4 status=none | nxxd
+dd if=/dev/zero bs=16 count=4 status=none | nxxd -a
+dd if=/dev/zero bs=16 count=4 status=none | nxxd -f
+ruby -e 'print "xyz="*16' | nxxd
+```
+
+Reverse operation.
+
+```bash
+echo '42617a696e6761210a' | nxxd -r
+echo hello | grep --color=yes -nH ll | nxxd | nxxd -r
+```
+
+C source code output.
+
+```bash
+nxxd -i someimage.png
+```
+
+Get help.
+
+```bash
+nxxd  -h
+```
+
+
+## Ruby classes and methods
+
+Here's an example:
+
+```ruby
+require "nxxd"
+
+data = " !\"\#$%&'()*+,-./0123456789:;<=>?"
+Nxxd::Dump.new.run data do |l| puts l end
+```
+
+Reverse operation allows free address jumping.
+Both string and file output can be done.
+
+```ruby
+require "nxxd"
+
+x = <<~EOT
+0004: 204d 696c 6b79 2047 7265 656e 0a     Milky Green
+0000: 436f 6465                           Code
+EOT
+
+s = Nxxd::Dump.reverse x
+puts s.encoding, s.length, s.inspect
+
+File.open "status", "w" do |f|
+  Nxxd::Dump.reverse x, f
+end
+```
+
+
+## Colorization
+
+There is no and there will be no color support. Pipe the output to your
+favourite editor and use the syntax highlighting there.
+
+If you are using Vim/Neovim, you might like the more elaborate syntax
+highlighting included in this package [xxd.vim](./vim/syntax/xxd.vim).
+
+
+## Copyright
+
+  * (C) 2025 Bertram Scharpf <software@bertram-scharpf.de>
+  * License: [BSD-2-Clause+](./LICENSE)
+

data/bin/nxxd

@@ -0,0 +1,219 @@
+#!/usr/bin/env ruby
+
+#
+#  nxxd  --  Hex dump tool
+#
+
+require "nxxd"
+require "nxxd/version"
+
+
+module Nxxd
+
+  class Application
+
+    NAME    = "nxxd"
+
+    OPTIONS = {
+      "r" => [ :reverse,   true,     "Reverse operation, pack"],
+      "o" => [ :output,    :NAME,    "Output file (- = stdout)"],
+      "output" => "o",
+      "f" => [ :full,      true,     "Full output (no squeeze)"],
+      "full" => "f",
+      "a" => [ :full,      false,    "Abbreviate (squeeze duplicate lines)"],
+      "p" => [ :plain,     true,     "Plain output (no comments, no C variables)"],
+      "u" => [ :upper,     true,     "Upper case A-F"],
+      "upper" => "u",
+      "l" => [ :line_size, :NUM,     "Line size"],
+      "line" => "l",
+      "d" => [ :addr_len,  :NUM,     "Address length"],
+      "addrs" => "d",
+      "i" => [ :cnums,     true,     "C-style number literals"],
+      "include" => "i",
+      "C" => [ :capitals,  true,     "Capitalize C variable names with -i"],
+      "capitalize" => "C",
+      "h" => [ :help,      :help,    "Print this help message"],
+      "help" => "h",
+      "v" => [ :version,   :version, "Version information"],
+      "version" => "v",
+    }
+
+    OPT_ENV = "NXXD"
+
+    class Options
+
+      attr_reader :opts, :args
+
+      def initialize params
+        @opts, @args = {}, []
+        env = ENV[ OPT_ENV]
+        if env then
+          @params = env.split
+          until @params.empty? do
+            p = @params.shift
+            case p
+            when /^--/ then $'.empty? or set $'
+            when /^-/  then set_short $'
+            else            set p
+            end
+          end
+        end
+        @params = params
+        until @params.empty? do
+          p = @params.shift
+          case p
+          when /^--/ then $'.empty? and break ; set $'
+          when /^-/  then set_short $'
+          else            @args.push p
+          end
+        end
+        @args.concat @params
+        @params = nil
+      rescue StandardError
+        $stderr.puts $!
+        exit 1
+      end
+
+      private
+
+      def set_short cont
+        @cont = cont
+        until @cont.empty? do
+          c = @cont.slice! 0
+          set c
+        end
+      ensure
+        @cont = nil
+      end
+
+      def set o
+        opt = loop do
+          d = OPTIONS[ o]
+          raise "Unknown option: #{o}" unless d
+          break d if Array === d
+          o = d
+        end
+        key, t, = opt
+        if Symbol === t then
+          type = type_repr t
+          if type then
+            arg = @cont.slice! 0..nil if @cont
+            arg = @params.shift if not arg or arg.empty?
+            arg = Integer arg if %i(NUM INT).include? type
+          else
+            send t
+            exit 0
+          end
+        else
+          arg = t
+        end
+        @opts[ key] = arg
+      end
+
+      def version
+        puts "#{NAME} -- #{VERSION}"
+        puts AUTHOR
+        puts "License: #{LICENSE}"
+      end
+
+      def help
+        version
+        puts
+        puts "Usage: #$0 [options] [ inputfile+ [ outputfile ] ]"
+        puts
+        OPTIONS.each { |opt,defn|
+          case defn
+          when String then
+            text = "= #{opt_repr defn}"
+          else
+            _, arg, text = *defn
+            type = type_repr arg if Symbol === arg
+          end
+          puts "  %-10s  %-10s  %s" % [(opt_repr opt), type, text]
+        }
+      end
+
+      def type_repr type
+        type if type =~ /\A[A-Z_]+\z/
+      end
+
+      def opt_repr o
+        o.length == 1 ? "-#{o}" : "--#{o}"
+      end
+
+    end
+
+    def initialize params
+      o = Options.new params
+      @opts, @args = o.opts, o.args
+      @inputs = []
+      @inputs.push @args.shift
+      @output = (@opts.delete :output) || @args.pop
+      @inputs.push @args.shift until @args.empty?
+    end
+
+    def run
+      open_output do |o|
+        if @opts[ :reverse] then
+          open_inputs do |f|
+            Dump.reverse f, o
+          end
+        else
+          cls = (@opts.delete :cnums) ? DumpNums : Dump
+          open_inputs do |f|
+            d = cls.new **@opts
+            d.run f do |l| o.puts l end
+          end
+        end
+      end
+    rescue ArgumentError
+      $stderr.puts "Incompatible Options: #@opts"
+      1
+    rescue Errno::EPIPE
+      $stderr.puts "Broken pipe. Stop."
+    rescue Errno::ESPIPE
+      $stderr.puts "Seek not possible. Specify an output file."
+      2
+    rescue Interrupt
+      $stderr.puts "Interrupted."
+      1
+    rescue
+      $stderr.puts "Error: #$! (#{$!.class})"
+      1
+    end
+
+    private
+
+    def open_inputs
+      plain = @opts.delete :plain
+      @inputs.each do |i|
+        i = nil if i == "-"
+        @opts[ :input] = i unless plain
+        if i then
+          File.open i, "r" do |f|
+            yield f
+          end
+        else
+          yield $stdin
+        end
+      ensure
+        @opts.delete :input
+      end
+      nil
+    end
+
+    def open_output
+      o = @output unless @output == "-"
+      if o then
+        File.open o, "w" do |o| yield o end
+      else
+        yield $stdout
+      end
+    end
+
+  end
+
+  exit (Application.new $*).run.to_i
+
+end
+

data/lib/nxxd/nvim.rb

@@ -0,0 +1,116 @@
+#
+#  nxxd/nvim.rb  --  Neovim commands
+#
+
+require "nxxd"
+
+(Neovim::Client === $vim rescue false) or
+  raise "This file must be required from inside Neovim using the 'nvim' Rubygem."
+
+
+[
+  "command -nargs=?          -bang -complete=file -bar HexDump call rubyeval('Nxxd::Nvim.dump<bang> %q|<args>|')",
+  "command -nargs=? -range=% -bang -complete=file -bar HexPack call rubyeval('Nxxd::Nvim.pack<bang> %q|<args>|, <line1>..<line2>')",
+].each { |c| $vim.command c }
+
+
+
+module Kernel
+  class <<self
+    def popen_outerr a
+      ro, wo = IO.pipe
+      re, we = IO.pipe
+      fork do
+        ro.close
+        re.close
+        STDOUT.reopen wo
+        STDERR.reopen we
+        exec a
+      end
+      wo.close
+      we.close
+      yield ro, re
+      Process.waitpid
+    ensure
+      ro.close
+      re.close
+    end
+  end
+end
+
+
+module Nxxd
+
+  module Nvim
+
+    class <<self
+
+      def dump a
+        a ||= $vim.get_name 0
+        File.open a do |f|
+          dump_file a, f
+        end
+        $vim.get_current_buf.set_var "origfile", a
+      end
+
+      def dump! a
+        Kernel.popen_outerr a do |ro,re|
+          dump_file a, ro
+          e = re.read.lines.map { |x| x.chomp! ; "# #{x}" }
+          $vim.put e, "l", false, true
+        end
+        $?.success? or $vim.put [ "### Exit code: #{$?.exitstatus}"], "l", false, true
+      end
+
+      private
+
+      def dump_file a, f
+        $vim.command "enew"
+        $vim.set_option filetype: "xxd", buftype: "nofile"
+        $vim.get_current_buf.set_name "[hex: #{a}]"
+        (Dump.new input: a).run f do |l|
+          $vim.put [l], "l", false, true
+        end
+      end
+
+      public
+
+      def pack a, range
+        pack_check a, range do |d|
+          raise "File exists. Overwrite with '!'." if File.exist? d
+        end
+      end
+
+      def pack! a, range
+        pack_check a, range do || end
+      end
+
+      private
+
+      def pack_check a, range
+        b = $vim.get_current_buf
+        a = a.notempty?
+        a ||= b.get_var "origfile" rescue nil
+        a or raise "No file name given."
+        yield a
+        File.open a, "w" do |f|
+          r = Range.new b, range
+          Nxxd::Dump.reverse r, f
+        end
+      end
+
+    end
+
+    class Range
+      def initialize buf, range
+        @buf, @range = buf, range
+      end
+      def each_line &block
+        @buf.each @range, &block
+      end
+    end
+
+  end
+
+end
+

data/lib/nxxd/version.rb

@@ -0,0 +1,12 @@
+#
+#  nxxd/version.rb  --  Version Info
+#
+
+module Nxxd
+
+  VERSION = "1.0".freeze
+  AUTHOR  = "(C) 2025 Bertram Scharpf <software@bertram-scharpf.de>"
+  LICENSE = "BSD-2-Clause+"
+
+end
+

data/lib/nxxd.rb

@@ -0,0 +1,201 @@
+#
+#  nxxd.rb  --  Hex Dump Tool
+#
+
+
+module Nxxd
+
+  module ReadChunks
+
+    private
+
+    def read_chunks input
+      case input
+      when String then
+        i = 0
+        while i < input.bytesize do
+          b = input.byteslice i, @line_size
+          yield b
+          i += @line_size
+        end
+      else
+        loop do
+          b = input.read @line_size
+          break unless b
+          yield b
+          break if b.length < @line_size
+        end
+      end
+    end
+
+  end
+
+  class Dump
+
+    include ReadChunks
+
+    LINE_SIZE = 16
+    ADDR_FMT = "%%0%dx:"
+
+    def initialize full: nil, upper: false, line_size: nil, addr_len: nil, input: nil
+      @full = full
+      @input = input
+      @line_size = line_size||LINE_SIZE
+      @addr_fmt = ADDR_FMT % (addr_len||8)
+      @nib_fmt = "%02x"
+      if upper then
+        @addr_fmt.upcase!
+        @nib_fmt.upcase!
+      end
+    end
+
+    def run input
+      addr = 0
+      prev, repeat = nil, false
+      yield "# #@input" if @input
+      read_chunks input do |b|
+        if b == prev and not @full then
+          unless repeat then
+            yield "*"
+            repeat = true
+          end
+        else
+          r = @addr_fmt % addr
+          r << " "
+          h =  b.unpack "C*"
+          sp = false
+          @line_size.times {
+            x = h.shift
+            r << (x ? @nib_fmt % x : "  ")
+            r << " " if sp
+            sp = !sp
+          }
+          r << " " << (b.gsub /[^ -~]/, ".")
+          yield r
+          prev, repeat = b, false
+        end
+        addr += b.size
+      end
+      yield @addr_fmt % addr
+      nil
+    end
+
+
+    class <<self
+
+      def reverse input, output = nil
+        output ||= ""
+        o = String === output ? (WriteChunksString.new output) : output
+        o.set_encoding Encoding::ASCII_8BIT
+        r, repeat = nil, false
+        input.each_line { |l|
+          l.chomp!
+          case l
+            when /^\s*(?:#|$)/                  then nil
+            when /^\*/                          then repeat = true
+            when /^(?:(\h+):)?\s*((?:\h\h ?)*)/ then
+              addr, nibs = $~.captures
+              if addr then
+                addr = $1.to_i 0x10
+                if repeat then
+                  loop do
+                    s = addr - o.tell
+                    break if s <= 0
+                    o.write s >= r.length ? r : r[ 0, s]
+                  end
+                  repeat = false
+                else
+                end
+                o.seek addr
+              end
+              r = (nibs.scan /\h\h/).map { |x| x.to_i 0x10 }.pack "C*"
+              o.write r
+            else
+              raise "Uninterpretable hex dump: #{l.chomp}"
+          end
+        }
+        output
+      end
+
+    end
+
+  end
+
+  class DumpNums
+
+    include ReadChunks
+
+    LINE_SIZE = 12
+
+    def initialize upper: false, line_size: nil, capitals: nil, input: nil
+      @line_size = line_size||LINE_SIZE
+      @nib_fmt = "%#04x"
+      @nib_fmt.upcase! if upper
+      if input then
+        @varname = input.dup
+        @varname.insert 0, "__" if @varname =~ /\A\d/
+        @varname.gsub! /[^a-zA-Z0-9]/, "_"
+        @varname.upcase! if capitals
+      end
+    end
+
+    def run input, &block
+      if @varname then
+        yield "unsigned char #@varname[] = {"
+        len = run_plain input, &block
+        yield "};"
+        yield "unsigned int #@varname\_len = %d;" % len
+      else
+        run_plain input, &block
+      end
+      nil
+    end
+
+    private
+
+    def run_plain input
+      prev, len = nil, 0
+      read_chunks input do |b|
+        if prev then
+          prev << ","
+          yield prev
+        end
+        prev = "  " + ((b.unpack "C*").map { |x| @nib_fmt % x }.join ", ")
+        len += b.bytesize
+      end
+      yield prev if prev
+      len
+    end
+
+  end
+
+  class WriteChunksString
+    def initialize str
+      @str = str
+    end
+    def set_encoding enc
+      @str.force_encoding enc
+    end
+    def tell ; @pos || @str.length ; end
+    def seek pos
+      s = pos - @str.length
+      if s >= 0 then
+        s.times { @str << "\0".b }
+      else
+        @pos = pos
+      end
+    end
+    def write b
+      if @pos then
+        l = b.length
+        @str[ @pos, l] = b
+        @pos += l
+        @pos = nil if @pos >= @str.length
+      else
+        @str << b
+      end
+    end
+  end
+
+end
+

data/nxxd.gemspec

@@ -0,0 +1,37 @@
+#
+#  nxxd.gemspec  --  Gem Specification
+#
+
+require "./lib/nxxd/version"
+
+
+Gem::Specification.new do |s|
+  s.name        = "nxxd"
+  s.version     = Nxxd::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 3.1"
+  s.summary     = "Hex Dump Tool"
+  s.description = <<~EOT
+    Yet another Xxd reimplementation.
+  EOT
+  s.license     = "LicenseRef-LICENSE"
+
+  s.authors,
+  s.email       = (<<~EOT.scan /(\S.*\S)\s*<(.*)>/).transpose
+    Bertram Scharpf <software@bertram-scharpf.de>
+  EOT
+
+  s.homepage    = "https://github.com/BertramScharpf/ruby-nxxd"
+
+  s.requirements     = "Just Ruby"
+
+  s.require_paths    = %w(lib)
+  s.files            = Dir[ "lib/**/*.rb", "bin/*", ] +
+                       %w(LICENSE README.md nxxd.gemspec)
+  s.bindir           = "bin"
+  s.extensions       = %w()
+  s.executables      = %w(nxxd)
+  s.extra_rdoc_files = %w()
+
+end
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: nxxd
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Bertram Scharpf
+bindir: bin
+cert_chain: []
+date: 2025-01-30 00:00:00.000000000 Z
+dependencies: []
+description: 'Yet another Xxd reimplementation.
+
+  '
+email:
+- software@bertram-scharpf.de
+executables:
+- nxxd
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/nxxd
+- lib/nxxd.rb
+- lib/nxxd/nvim.rb
+- lib/nxxd/version.rb
+- nxxd.gemspec
+homepage: https://github.com/BertramScharpf/ruby-nxxd
+licenses:
+- LicenseRef-LICENSE
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Just Ruby
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Hex Dump Tool
+test_files: []