nxxd 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5235dca5d1f46e13930f0d67076555a589a8966f4e83abf933a805ca722abbfe
-  data.tar.gz: 16ee0e67f7b9b8d765639470d7aff99c8e4aa71a5668493808589fcd42089ccd
+  metadata.gz: 68a908962e81a416580c2987b7523f755e85e1963c20908420fb579710b6a865
+  data.tar.gz: b18d9db546926037e9646a22e6c8394fd6d4ff86ad048b8be22a697d07698a87
 SHA512:
-  metadata.gz: b9b88cd360d0af386401df8eada33e03718790136ce709d4f5d74ea4f54311d2a22df54e7f6d157d6a8ed53a5d073ccf1958f40f582aa8d2cae3b4d7f74dc175
-  data.tar.gz: 3e6a4f1b49aeef9867e80b0b900b99951a6b37d53d4b8f1ee82d37f9d58f773355f2a72d651e5df734022d942d7673d0c7af76f384f5a8cd564eb69ff2b2dadc
+  metadata.gz: d941c8d1202b8bcbf0b1b0507216665e1c1e81035ff224861e6183d8a82b4354b701a3231e14803c9e7d934dc75cbb1dd8d6210ca46c36f8275c3234d34a25af
+  data.tar.gz: abd20b6a161993d5ab0d8047623c8d137b7eec56512f72269a942feae25521ecd9549faceec3276e4df654008a84dcdf4c37b1c000ef5e473a74251850307380

data/README.md

@@ -65,11 +65,16 @@ Here's an example:
 
 ```ruby
 require "nxxd"
-
 data = " !\"\#$%&'()*+,-./0123456789:;<=>?"
 Nxxd::Dump.new.run data do |l| puts l end
 ```
 
+Or just:
+
+```ruby
+puts Nxxd::Dump.new.run data
+```
+
 Reverse operation allows free address jumping.
 Both string and file output can be done.
 
@@ -90,6 +95,45 @@ end
 ```
 
 
+## Inside Neovim
+
+If you're using Neovim and the Ruby provider
+[ruby-nvim](https://github.com/BertramScharpf/ruby-nvim) (Not the official
+neovim-ruby!), you probably prefer to pipe from and to buffers.
+
+```vim
+rubyfile <nxxd/nvim>
+vertical HexDump /etc/localtime
+```
+
+In case you have a string in a Ruby variable, dump it like this:
+
+```vim
+ruby t = "tränenüberströmt"
+ruby Nxxd::Nvim.dump_data t
+```
+
+You may dump a programs output as well:
+
+```vim
+HexDump! echo QmF6aW5nYSEK | openssl enc -a -d
+HexDump! dd if=/dev/urandom bs=16 count=4
+```
+
+Pipe your editor lines to a program like this:
+
+```
+ 1 H4sIALDvomcAA7u3
+ 2 dt/7ewOIAX8tU5eA
+ 3 AAAA
+ ~
+ ~
+:1,3HexPipe openssl enc -a -d | gzip -cd
+```
+
+See the file [nxxd.txt](./vim/doc/nxxd.txt) for a full documentation.
+
+
 ## Colorization
 
 There is no and there will be no color support. Pipe the output to your

data/bin/nxxd

@@ -15,26 +15,28 @@ module Nxxd
     NAME    = "nxxd"
 
     OPTIONS = {
-      "r" => [ :reverse,   true,     "Reverse operation, pack"],
-      "o" => [ :output,    :NAME,    "Output file (- = stdout)"],
+      "r" => [ :reverse,     true,     "Reverse operation, pack"],
+      "o" => [ :output,      :NAME,    "Output file (- = stdout)"],
       "output" => "o",
-      "f" => [ :full,      true,     "Full output (no squeeze)"],
+      "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"],
+      "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"],
+      "l" => [ :line_size,   :NUM,     "Line size"],
       "line" => "l",
-      "d" => [ :addr_len,  :NUM,     "Address length"],
+      "d" => [ :addr_len,    :NUM,     "Address length"],
       "addrs" => "d",
-      "i" => [ :cnums,     true,     "C-style number literals"],
+      "i" => [ :cnums,       true,     "C-style number literals"],
       "include" => "i",
-      "C" => [ :capitals,  true,     "Capitalize C variable names with -i"],
+      "C" => [ :capitals,    true,     "Capitalize C variable names with -i"],
       "capitalize" => "C",
-      "h" => [ :help,      :help,    "Print this help message"],
+      "c" => [ :consecutive, true,     "Consecutive undump (ignore addresses)"],
+      "consecutive" => "c",
+      "h" => [ :help,        :help,    "Print this help message"],
       "help" => "h",
-      "v" => [ :version,   :version, "Version information"],
+      "v" => [ :version,     :version, "Version information"],
       "version" => "v",
     }
 
@@ -154,9 +156,9 @@ module Nxxd
 
     def run
       open_output do |o|
-        if @opts[ :reverse] then
+        if @opts.delete :reverse then
           open_inputs do |f|
-            Dump.reverse f, o
+            Dump.reverse f, o, **@opts
           end
         else
           cls = (@opts.delete :cnums) ? DumpNums : Dump
@@ -188,8 +190,8 @@ module Nxxd
       plain = @opts.delete :plain
       @inputs.each do |i|
         i = nil if i == "-"
-        @opts[ :input] = i unless plain
         if i then
+          @opts[ :input] = i unless plain or @opts[ :reverse]
           File.open i, "r" do |f|
             yield f
           end

data/lib/nxxd/nvim.rb

@@ -8,35 +8,12 @@ require "nxxd"
   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
+<<~'EOT'.each_line { |c| c.chomp! ; $vim.command c }
+  command -nargs=?          -bang -complete=file      HexDump ruby Nxxd::Nvim.dump<bang> <q-args>, <q-mods>
+  command -nargs=1 -range=%       -complete=file      HexPipe ruby Nxxd::Nvim.pipe       <q-args>, <q-mods>, <line1>..<line2>
+  command -nargs=? -range=% -bang -complete=file -bar HexPack ruby Nxxd::Nvim.pack<bang> <q-args>, <range>, <line1>..<line2>
+  command -nargs=1 -range=%       -complete=file      HexFeed ruby Nxxd::Nvim.feed       <q-args>, <line1>..<line2>
+EOT
 
 
 module Nxxd
@@ -45,69 +22,142 @@ module Nxxd
 
     class <<self
 
-      def dump a
-        a ||= $vim.get_name 0
+      attr_accessor :split
+
+      private
+
+      def split_new mods
+        if mods.notempty? then
+          "#{mods} new"
+        else
+          case @split
+          when /\bvert/ then "vnew"
+          when /\bhor/  then "new"
+          else               "enew"
+          end
+        end
+      end
+
+      public
+
+      def dump a, m
+        a = a.notempty?
+        a ||= cur_buf_name
         File.open a do |f|
-          dump_file a, f
+          dump_data f, a, m
         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
+      def dump! a, m
+        a = a.notempty?
+        a ||= cur_buf_name_exec
+        pipe a, m, nil
+      end
+
+      def pipe a, m, range
+        popen a do |ro,re|
+          begin
+            if range then
+              # It would be nicer to write the lines as they are demanded. If
+              # you have an idea how this could easily be done, feel free to
+              # propose a patch. Putting this begin-end block into a Thread
+              # didn't work.
+              (Neovim::Lines.new $vim.get_current_buf, range).each { |l| ro.puts l }
+            end
+            ro.close_write
+          end
+          dump_data ro, a, m
+          re.each_line { |l|
+            l.chomp!
+            $vim.put [ "# #{l}"], "l", false, true
+          }
         end
         $?.success? or $vim.put [ "### Exit code: #{$?.exitstatus}"], "l", false, true
       end
 
-      private
-
-      def dump_file a, f
-        $vim.command "enew"
+      def dump_data f, a = nil, m = nil
+        (split_new m).tap { |sc| $vim.command sc }
         $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
+          $vim.put [ l], "l", false, true
         end
       end
 
+      private
+
+      def cur_buf_name
+        # $vim.buf_get_name 0           # gives the full path
+        $vim.evaluate "bufname('%')"
+      end
+
+      def cur_buf_name_exec
+        r = cur_buf_name
+        r = File.join ".", r unless r.include? "/"
+        r
+      end
+
+      def popen cmd
+        re, we = IO.pipe
+        IO.popen cmd, "r+", err: we do |ro|
+          we.close
+          yield ro, re
+        end
+      ensure
+        re.close
+      end
+
       public
 
-      def pack a, range
-        pack_check a, range do |d|
+      def pack a, rarg, range
+        pack_check a, rarg, range do |d|
           raise "File exists. Overwrite with '!'." if File.exist? d
         end
       end
 
-      def pack! a, range
-        pack_check a, range do || end
+      def pack! a, rarg, range
+        pack_check a, rarg, range do || end
       end
 
       private
 
-      def pack_check a, range
+      def pack_check a, rarg, range
         b = $vim.get_current_buf
         a = a.notempty?
-        a ||= b.get_var "origfile" rescue nil
-        a or raise "No file name given."
+        unless a then
+          a = b.get_var "origfile" rescue nil
+          a or raise "No file name given."
+          rarg.zero? or raise "No range allowed when using default output name."
+        end
         yield a
         File.open a, "w" do |f|
-          r = Range.new b, range
+          r = Neovim::Lines.new b, range
           Nxxd::Dump.reverse r, f
         end
       end
 
-    end
+      public
 
-    class Range
-      def initialize buf, range
-        @buf, @range = buf, range
-      end
-      def each_line &block
-        @buf.each @range, &block
+      def feed a, range
+        popen a do |ro,re|
+          r = Neovim::Lines.new $vim.get_current_buf, range
+          Nxxd::Dump.reverse r, ro, consecutive: true
+          ro.close_write
+          $vim.command "#{range.last}"
+          $vim.put [ ""], "l", true, true
+          ro.each_line { |l|
+            l.chomp!
+            $vim.put [ l], "l", false, true
+          }
+          re.each_line { |l|
+            l.chomp!
+            $vim.put [ "# #{l}"], "l", false, true
+          }
+        end
+        $?.success? or $vim.put [ "### Exit code: #{$?.exitstatus}"], "l", false, true
       end
+
     end
 
   end

data/lib/nxxd/version.rb

@@ -4,7 +4,7 @@
 
 module Nxxd
 
-  VERSION = "1.0".freeze
+  VERSION = "1.1".freeze
   AUTHOR  = "(C) 2025 Bertram Scharpf <software@bertram-scharpf.de>"
   LICENSE = "BSD-2-Clause+"
 

data/lib/nxxd.rb

@@ -15,6 +15,7 @@ module Nxxd
         i = 0
         while i < input.bytesize do
           b = input.byteslice i, @line_size
+          b.force_encoding Encoding::ASCII_8BIT  # Ruby, shouldn't this rather be self-evident?
           yield b
           i += @line_size
         end
@@ -50,6 +51,7 @@ module Nxxd
     end
 
     def run input
+      block_given? or return [].tap { |r| run input do |l| r.push l end }
       addr = 0
       prev, repeat = nil, false
       yield "# #@input" if @input
@@ -83,7 +85,7 @@ module Nxxd
 
     class <<self
 
-      def reverse input, output = nil
+      def reverse input, output = nil, consecutive: nil
         output ||= ""
         o = String === output ? (WriteChunksString.new output) : output
         o.set_encoding Encoding::ASCII_8BIT
@@ -91,27 +93,30 @@ module Nxxd
         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
+          when /^\s*(?:#|$)/ then
+            nil
+          when /^\*/ then
+            consecutive and
+              raise "Addressless undump doesn't allow repeat specifications."
+            repeat = true
+          when /^(?:(\h+):)?\s*((?:\h\h ?)*)/ then
+            addr, nibs = $~.captures
+            if !consecutive && 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
-                o.seek addr
+                repeat = false
               end
-              r = (nibs.scan /\h\h/).map { |x| x.to_i 0x10 }.pack "C*"
-              o.write r
-            else
-              raise "Uninterpretable hex dump: #{l.chomp}"
+              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
@@ -140,6 +145,7 @@ module Nxxd
     end
 
     def run input, &block
+      block_given? or return [].tap { |r| run input do |l| r.push l end }
       if @varname then
         yield "unsigned char #@varname[] = {"
         len = run_plain input, &block

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nxxd
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Bertram Scharpf
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies: []
 description: 'Yet another Xxd reimplementation.
 
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Just Ruby
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Hex Dump Tool
 test_files: []