xrpn 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c4ea1cc27787e1898612bac796dc5331524da5053c84fce79ad7edb25bb011b
-  data.tar.gz: 9c1605ed8cb190188ed604eca2fc4b6b7eb284f4aab5d7f6e65daef461cd41f3
+  metadata.gz: dde19bba9fcbbbce58e8447c363ceff212510f83d86d5b8bfa62f9156e3876e5
+  data.tar.gz: c06bdf45c23fcebfa983205fc4af530c28492e35a32bbe45a0008c8e1145aca9
 SHA512:
-  metadata.gz: '04318bc2509ce3c5afdaf464f982ce3ecb9e9e5d101f3b8ceba58be24118fd0136ab9dedd2b2507d815ef989fdf07d379e6082e866dd9435257af8b389943249'
-  data.tar.gz: a8e8cf8965a48cbb882afba983b10c86537eed2bc804f19f19672a2479db96678ebdb8b9533374da9eac7211306458d135e916471d31f42eecce7ce6f870ae02
+  metadata.gz: 487924f70e9fd85bc45b18521fd153d764ea1f94327f175411441886ef986e398154be889976784dbf53b356cdef7074d1462cf95e10d6971158fce6a331ce58
+  data.tar.gz: 34997709120a14cbd8759bfa9c99d91054b7bf5df752951e29540af9d13476e2b9b0d34f68ddae2051fdc80a28d589944ee9f30c95a874e6d97fb2630438a747

data/README.md

@@ -16,11 +16,7 @@ XRPN implements indirect addressing, self-modification and features well beyond
 
 You need Ruby installed to get XRPN to work.
 
-You also need to install the Ruby Gem tty-prompt: `gem install tty-prompt`
-
-To install XRPN, simply clone this repository and run the script `INSTALL.sh`. It is only tested on Linux but should work well on Mac OS and BSD systems. If you are on Windows, please tell me if it works in that environment. The install script will put create a symbolic link in your home directory - named ".xrpn" to make it a hidden directory - pointing to the cloned repo. It will also attempt to add a symlink to "~/bin" to make it easy to run XRPN.
-
-A Ruby Gemfile will be created soon that will make all this a lot easier.
+To install XRPN, you can do `gem install 'xrpn'` or by cloning this repository and run the script `INSTALL.sh`.  It is only tested on Linux but should work well on Mac OS and BSD systems. If you are on Windows, please tell me if it works in that environment. The install script will put create a symbolic link in your home directory - named ".xrpn" to make it a hidden directory - pointing to the cloned repo. It will also attempt to add a symlink to "~/bin" to make it easy to run XRPN. If you install XRPN by cloning this repo, you also need to install the Ruby Gem tty-prompt: `gem install tty-prompt`. If you install via `gem install 'xrpn'`, then this dependency is automatically taken care of. The gem is slower on startup than running XRPN from this repo.
 
 ## Run
 

data/bin/xrpn

@@ -10,7 +10,7 @@ require 'open-uri'
 require 'json'
 require 'tty-prompt'
 
-$gem = Gem.latest_spec_for("xrpn").gem_dir if `gem list -i "^xrpn$"`
+$gem = Gem.latest_spec_for("xrpn").gem_dir
 
 # ENSURE DIRs
 Dir.mkdir(Dir.home + "/.xrpn") unless File.exist?(Dir.home + "/.xrpn")
@@ -77,6 +77,7 @@ load(Dir.home+'/.xrpn/theme') if File.exist?(Dir.home+'/.xrpn/theme') # Override
 # THE CORE OF THE RPN PROGRAM
 @nl = false # Nolift set to false
 @i  = 0     # Counter to prevent infinite loops
+@debugprompt = TTY::Prompt.new
 until @p.pc == @p.prg[@p.pg].length do
   # Enter debug mode if $debug or $prompt is set, else read next program line
   ($debug or $prompt) ? debug_mode : @line = @p.prg[@p.pg][@p.pc]

data/xcmd/abs

@@ -1,4 +1,5 @@
 class XRPN
+# Return absolute value of X to X
   def abs
     @x = @x.abs
   end

data/xcmd/acos

@@ -1,4 +1,5 @@
 class XRPN
+# Return Arc COS of X to X
   def acos
     @l = @x
     @x = Math::acos(@x)

data/xcmd/adate

@@ -1,4 +1,5 @@
 class XRPN
+# Return a formatted date in X to Alpha
   def adate
     d = @x.to_s
     if @flg["31"] # DMY

data/xcmd/adateiso

@@ -1,4 +1,5 @@
 class XRPN
+# Return date in X (DD.MMYYYY or MM.DDYYYY) as YYYY-MM-DD in Alpha
   def adateiso
     d = @x.to_s
     d = "0" + d if d.match(/^\d\./)

data/xcmd/add

@@ -1,4 +1,5 @@
 class XRPN
+# Return X + Y to X
   def +
     @l = @x
     @x = @y + @x

data/xcmd/adv

@@ -1,4 +1,5 @@
 class XRPN
+# Add a line in the printout
   def adv
     puts "\n"
   end

data/xcmd/agsub

@@ -1,4 +1,5 @@
 class XRPN
+# Substitute all instances in Alpha matching the regexp in X by the content in Y
   def agsub
     return unless (@x.is_a? String and @y.is_a? String)
     @a.gsub!(Regexp.new(@x), @y)

data/xcmd/aleng

@@ -1,4 +1,5 @@
 class XRPN
+# Return length of Alpha string to X
   def aleng
 	lift
     @x = @a.length

data/xcmd/almcat

@@ -1,4 +1,5 @@
 class XRPN
+# Alarm catalog (no alarm functions implemented)
   def almcat
     return "ALMCAT: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/almnow

@@ -1,4 +1,5 @@
 class XRPN
+# Fire alarm now (no alarm functions implemented)
   def almnow
     return "ALMNOW: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/anum

@@ -1,4 +1,5 @@
 class XRPN
+# Return first number in Alpha to X
   def anum
     lift
     n = @a.scan(/[\d.,e]+/).first

data/xcmd/aoff

@@ -1,4 +1,5 @@
 class XRPN
+# Alpha OFF (no need, just enclose all Alpha entries in double quotes)
   def aoff
     return "AOFF: As with AON, no real need for that function"
   end

data/xcmd/aon

@@ -1,4 +1,5 @@
 class XRPN
+# Alpha ON (no need, just enclose all Alpha entries in double quotes)
   def aon
     return "AON: No real need for that function"
   end

data/xcmd/appchr

@@ -1,4 +1,5 @@
 class XRPN
+# Append Alpha to current XM file at pointer
   def appchr
     if @xmcont[0][0] == ""
       return 

data/xcmd/apprec

@@ -1,4 +1,5 @@
 class XRPN
+# Append Alpha as next record in XM file
   def apprec
     if @xmcont[0][0] == ""
       return 

data/xcmd/arcl

@@ -1,4 +1,5 @@
 class XRPN
+# Recall content of register named to Alpha
   def arcl (r)
     a = false
     case r.downcase

data/xcmd/arcli

@@ -1,4 +1,5 @@
 class XRPN
+# Recall the integer part of X to Alpha
   def arcli
     @a += @x.to_i.to_s
   end

data/xcmd/arclrec

@@ -1,4 +1,5 @@
 class XRPN
+# Add to Alpha the next record in current XM file
   def arclrec
     if @xmcont[0][0] == ""
       return 

data/xcmd/arot

@@ -1,4 +1,5 @@
 class XRPN
+# Rotate Alpha at character number given in X
   def arot
     if @x > 0
       r  = (@x - 1).to_i

data/xcmd/ashf

@@ -1,4 +1,5 @@
 class XRPN
+# Remove the 6 left-most characters from Alpha
   def ashf
     @a = @a[6..]
   end

data/xcmd/asin

@@ -1,4 +1,5 @@
 class XRPN
+# Return Arc SIN of X to X
   def asin
     @l = @x
     @x = Math::asin(@x)

data/xcmd/asroom

@@ -1,4 +1,5 @@
 class XRPN
+# How much room is left in XM file? (always plenty of space)
   def asroom
     return "ASROOM: There's always plenty of room"
   end

data/xcmd/asto

@@ -1,4 +1,5 @@
 class XRPN
+# Store Alpha to named register
   def asto (r)
     case r.downcase
     when "x"

data/xcmd/asub

@@ -1,4 +1,5 @@
 class XRPN
+# Substitute the first instance in Alpha matching the regexp in X by the content in Y
   def asub
     return unless (@x.is_a? String and @y.is_a? String)
     @a.sub!(Regexp.new(@x), @y)

data/xcmd/atan

@@ -1,4 +1,5 @@
 class XRPN
+# Return Arc TAN of X to X
   def atan
     @l = @x
     @x = Math::atan(@x)

data/xcmd/atime

@@ -1,4 +1,5 @@
 class XRPN
+# Return a formatted time in X to Alpha
   def atime
     t  = @x.to_f
     am = true

data/xcmd/atime24

@@ -1,4 +1,5 @@
 class XRPN
+# Return a formatted time (as 24h time) in X to Alpha
   def atime24
     t  = @x.to_f
     case t

data/xcmd/atox

@@ -1,4 +1,5 @@
 class XRPN
+# Return character code of first character in Alpha and remove that character
   def atox
     lift
     @x = @a[0].ord

data/xcmd/aview

@@ -1,4 +1,5 @@
 class XRPN
+# Print out (show) content of Alpha register
   def aview
     puts @a.c_a(1)
   end

data/xcmd/aviewc

@@ -1,4 +1,5 @@
 class XRPN
+# Print out (show) content of Alpha register in the 256-color-code specified in X
   def aviewc
     puts @a.color(@x.to_i)
   end

data/xcmd/beep

@@ -1,4 +1,5 @@
 class XRPN
+# Sound the legendary HP-41 BEEP
   def beep
     `xdg-open ~/.xrpn/extra/beep41.wav`
   end

data/xcmd/bindec

@@ -1,4 +1,5 @@
 class XRPN
+# Take X as a binary number and convert to decimal number in X
   def bindec
     @l = @x
 	@x = @x.to_s.convert_base(2, 10).to_f

data/xcmd/cat

@@ -1,4 +1,5 @@
 class XRPN
+# Catalog. Only CAT 1, 3 and 4 implemented
   def cat (c)
     case c.to_i
     when 1

data/xcmd/cf

@@ -1,4 +1,5 @@
 class XRPN
+# Clear named flag
   def cf (r)
     @flg[r] = false
   end

data/xcmd/chs

@@ -1,7 +1,8 @@
 class XRPN
+# Swap sign of X (X becomes -X and -X becomes X)
   def chs
     @x = -@x
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cla

@@ -1,7 +1,8 @@
 class XRPN
+# Clear Alpha register
   def cla
     @a = ""
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clalma

@@ -1,4 +1,5 @@
 class XRPN
+# Clear alarm by Alpha (no alarm functions implemented)
   def clalma
     return "CLALMA: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/clalmx

@@ -1,4 +1,5 @@
 class XRPN
+# Clear alarm by X (no alarm functions implemented)
   def clalmx
     return "CLALMX: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/cld

@@ -1,4 +1,5 @@
 class XRPN
+# Clear display (no need)
   def cld
   end
 end

data/xcmd/clear

@@ -1,4 +1,5 @@
 class XRPN
+# Clear terminal display
   def clear
     system("clear")
   end

data/xcmd/clfl

@@ -1,4 +1,5 @@
 class XRPN
+# Clear content of XM file
   def clfl
     if @xmcont[0][0] == ""
       return 
@@ -10,4 +11,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clk12

@@ -1,7 +1,8 @@
 class XRPN
+# Make time into 12h format
   def clk12
     @clk24 = false
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clk24

@@ -1,7 +1,8 @@
 class XRPN
+# Make time into 24h format
   def clk24
     @clk24 = true
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clkeys

@@ -1,4 +1,5 @@
 class XRPN
+# Clear key assignments (no keys to clear)
   def clkeys
     return "CLKEYS: No need for this function as there is no calculator keyboard here."
   end

data/xcmd/clock

@@ -1,4 +1,5 @@
 class XRPN
+# Show clock (no clock function)
   def clock
     return "CLOCK: Tick, tock... not implemented."
   end

data/xcmd/clp

@@ -1,4 +1,5 @@
 class XRPN
+# Clear named program
   def clp (p)
     page, pos, prgm = locate_prg (p)
     @prg[page] -= prgm

data/xcmd/clralms

@@ -1,4 +1,5 @@
 class XRPN
+# Clear all alarms (no alarm functions implemented)
   def clralms
     return "CLRALMS: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/clrg

@@ -1,7 +1,8 @@
 class XRPN
+# Clear all registers
   def clrg
     @reg.each_key {|key| @reg[key] = 0 }
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clrgx

@@ -1,4 +1,5 @@
 class XRPN
+# Clear a specific number of registers
   def clrgx
     b, e, i = x2bei(@x)
     j = b
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cls

@@ -1,4 +1,5 @@
 class XRPN
+# Clear statistical data registers
   def cls
     @reg[@srg + 0] = 0.0
     @reg[@srg + 1] = 0.0
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clst

@@ -1,4 +1,5 @@
 class XRPN
+# Clear the stack (but not L)
   def clst
     @x = 0.0
     @y = 0.0
@@ -7,4 +8,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/clx

@@ -1,8 +1,9 @@
 class XRPN
+# Clear X
   def clx
     @x = 0.0
     @nolift = true
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cmdadd

@@ -1,7 +1,8 @@
 class XRPN
+# Add command in Alpha to the current program at line number in X (makes it possible to write self-modifying programs)
   def cmdadd
     @prg.insert(@x.to_i, @a)
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cmddel

@@ -1,7 +1,8 @@
 class XRPN
+# Delete line number in X from the current program (makes it possible to write self-modifying programs)
   def cmddel
     @prg.delete_at(@x.to_i)
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cmdhelp

@@ -0,0 +1,23 @@
+class XRPN
+# Show help text for the command in Alpha
+  def cmdhelp
+    if $gem 
+      c_gem = $gem + "/xcmd/" + @a
+      c     = File.read(c_gem) if File.exist?(c_gem)
+    end
+    c_loc = Dir.home + "/.xrpn/xcmd/" + @a
+    c     = File.read(c_loc) if File.exist?(c_loc)
+    if c
+      c = c[/.*#.*\n/][2..-2]
+      c = nil if c["vim:"]
+    end
+    if not $cmd.include?(@a.downcase)
+      puts "No such command: #{@a}"
+    else
+      puts c if c
+      puts "No help for the command \"#{@a}\"" unless c
+    end
+  end
+end
+ 
+# vim:ft=ruby:

data/xcmd/correct

@@ -1,4 +1,5 @@
 class XRPN
+# Correct clock drift (no clock function)
   def correct
     return "CORRECT: No clock, alarm or stopwatch functions are implemented"
   end

data/xcmd/cos

@@ -1,4 +1,5 @@
 class XRPN
+# Return COS of X to X
   def cos
     @l = @x
     @x = @x.to_rad  if @deg == "deg"

data/xcmd/crflas

@@ -1,4 +1,5 @@
 class XRPN
+# Create ASCII file. No need to supply any file size.
   def crflas
     f = Dir.home + "/.xrpn/data/" + @a + ".as"
     File.write(f, [[f, "AS", 0, 0.0]])
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/crfld

@@ -1,4 +1,5 @@
 class XRPN
+# Create data file. No need to supply any file size.
   def crfld
     f = Dir.home + "/.xrpn/data/" + @a + ".da"
     File.write(f, [[f, "DA", 0, 0.0]])
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/cube

@@ -1,8 +1,9 @@
 class XRPN
+# Return X^3 to X
   def cube
     @l = @x
     @x = @x ** 3
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/d_r

@@ -1,8 +1,9 @@
 class XRPN
+# Degrees to Radians conversion
   def d_r
     @l = @x
 	@x = @x * Math::PI / 180
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/date

@@ -1,8 +1,9 @@
 class XRPN
+# Return a formatted date in X to Alpha
   def date
     lift
     @flg["31"] ? @x = Time.now.strftime("%d.%m%Y").to_f : @x = Time.now.strftime("%m.%d%Y").to_f
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dateplus

@@ -1,4 +1,5 @@
 class XRPN
+# Add the date in Y and number of days in X and return result to X
   def dateplus
     @l = @x
     date = dtparse(@y)
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/ddate

@@ -1,4 +1,5 @@
 class XRPN
+# Return the number of days between dates in X and Y to X
   def ddate
     @l = @x
     dt1  = dtparse(@y)
@@ -8,4 +9,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dec

@@ -1,7 +1,8 @@
 class XRPN
+# Return the Decimal value of the Octal value in X
   def dec
     octdec
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/decbin

@@ -1,8 +1,9 @@
 class XRPN
+# Take X as a decimal number and convert to binary number in X
   def decbin
     @l = @x
 	@x = @x.to_s.convert_base(10, 2).to_f
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dechex

@@ -1,8 +1,9 @@
 class XRPN
+# Take X as a decimal number and convert to hexadecimal number in X
   def dechex
     @l = @x
 	@x = @x.to_s.convert_base(10, 16)
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby: