xrpn 1.2 → 1.3

data/xcmd/decoct

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

data/xcmd/deg

@@ -1,7 +1,8 @@
 class XRPN
+# Set degree mode to "deg" (360 degrees in a circle)
   def deg
     @deg = "deg"
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/degq

@@ -1,7 +1,8 @@
 class XRPN
+# Prints the current degrees mode
   def deg?
     p @deg
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/delchr

@@ -1,4 +1,5 @@
 class XRPN
+# Delete X characters from current XM file starting at pointer
   def delchr
     if @xmcont[0][0] == ""
       return 
@@ -11,4 +12,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/delrec

@@ -1,4 +1,5 @@
 class XRPN
+# Delete current record from current XM file
   def delrec
     if @xmcont[0][0] == ""
       return 
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/divide

@@ -1,4 +1,5 @@
 class XRPN
+# Return 1\/X to X
   def /
     @l = @x
     @x = @y / @x
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dmy

@@ -1,7 +1,8 @@
 class XRPN
+# Set date mode to DD.MMYYYY
   def dmy
     @flg["31"] = true
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dot

@@ -1,4 +1,5 @@
 class XRPN
+# Toggles Flag 28 (dot type - dot or comma as decimal separator)
   def dot
     @flg["28"] = !@flg["28"]
   end

data/xcmd/dow

@@ -1,4 +1,5 @@
 class XRPN
+# Return Day Of Week for date in X
   def dow
     @l = @x
     lift
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/drop

@@ -1,7 +1,8 @@
 class XRPN
+# Drop stack
   def drop
     @x, @y, @z = @y, @z, @t
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dropy

@@ -1,7 +1,8 @@
 class XRPN
+# Drop only Z and Y
   def dropy
     @y, @z = @z, @t
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/dse

@@ -1,4 +1,5 @@
 class XRPN
+# Decrease, skip if greater using named register
   def dse (r)
     case r.downcase
     when "x"

data/xcmd/ed

@@ -1,4 +1,5 @@
 class XRPN
+# Go to ascii file editor (no need for that)
   def ed
     return "No need for an editor.\nEdit your files in ~/.xrpn/data/ with your favourite editor (VIM)."
   end

data/xcmd/emdir

@@ -1,7 +1,8 @@
 class XRPN
+# Print data for all XM files (name and type and size)
   def emdir
     cat 4
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/emdirx

@@ -1,4 +1,5 @@
 class XRPN
+# Print X'th XM file (name and type and size)
   def emdirx
     fl = Dir[Dir.home+"/.xrpn/data/*"][@x.to_i - 1]
     f  = fl.sub(/.*\/(.*)\...$/, '\1')
@@ -11,4 +12,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/emroom

@@ -1,4 +1,5 @@
 class XRPN
+# Get room left in eXtended Memory (lots and lots)
   def emroom
     return "EMROOM: There's always plenty of room"
   end

data/xcmd/end

@@ -1,4 +1,5 @@
 class XRPN
+# End of program
   def end
     p = @pc
     rtn

data/xcmd/eng

@@ -1,4 +1,5 @@
 class XRPN
+# Engineering format. Set number of decimals (fix) to n, threshold to for when exponents kick in to 6 and show exponents as multiples of 3.
   def eng (n)
     @i = n.to_i
     @g = 3

data/xcmd/enter

@@ -1,8 +1,9 @@
 class XRPN
+# Lift stack
   def enter
     lift
     @nolift = true
   end
 end
 
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/exp

@@ -1,4 +1,5 @@
 class XRPN
+# Natural exponent
   def exp
     @l = @x
     lift
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/expx1

@@ -1,4 +1,5 @@
 class XRPN
+# For arguments close to zero
   def expx1
     @l = @x
     lift
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/fact

@@ -1,4 +1,5 @@
 class XRPN
+# Return factorial of X to X
   def fact
     @l = @x
     lift
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/fc

@@ -1,4 +1,5 @@
 class XRPN
+# Flag clear? If not, skip next program line
   def fc? (r)
     @flg[r] == false ? conditional(true) : conditional(false)
   end

data/xcmd/fcc

@@ -1,4 +1,5 @@
 class XRPN
+# Flag clear? If not, skip next program line and clear flag
   def fcc? (r)
     @flg[r] == false ? conditional(true) : conditional(false)
     @flg[r]  = false

data/xcmd/fcs

@@ -1,4 +1,5 @@
 class XRPN
+# Flag clear? If not, skip next program line and set flag.
   def fcs? (r)
     @flg[r] == false ? conditional(true) : conditional(false)
     @flg[r]  = true

data/xcmd/fix

@@ -1,4 +1,5 @@
 class XRPN
+# Fixed point display with n decimal places
   def fix (n)
     @i = n.to_i
     @s = 9

data/xcmd/fixq

@@ -1,7 +1,8 @@
 class XRPN
+# Print current FIX setting
   def fix?
     return "FIX = #{@i}"
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/flsize

@@ -1,4 +1,5 @@
 class XRPN
+# Get file size (alway plenty)
   def flsize
     return "FLSIZE: Always plenty of room."
   end

data/xcmd/frc

@@ -1,8 +1,9 @@
 class XRPN
+# Return fractional part of X to X
   def frc
     @l = @x
     @x = @x.frc
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/fs

@@ -1,4 +1,5 @@
 class XRPN
+# Flag set? If not, skip next program line
   def fs? (r)
     @flg[r] == true ? conditional(true) : conditional(false)
   end

data/xcmd/fsc

@@ -1,4 +1,5 @@
 class XRPN
+# Flag set? If not, skip next program line and clear flag
   def fsc? (r)
     @flg[r] == true ? conditional(true) : conditional(false)
     @flg[r]  = false

data/xcmd/fss

@@ -1,4 +1,5 @@
 class XRPN
+# Flag set? If not, skip next program line and set flag
   def fss? (r)
     @flg[r] == true ? conditional(true) : conditional(false)
     @flg[r]  = true

data/xcmd/geir

@@ -1,4 +1,5 @@
 class XRPN
+# Easter egg
   def geir
     puts
     puts "Geir Isene <g@isene.com> https://isene.com"
@@ -8,4 +9,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getas

@@ -1,7 +1,8 @@
 class XRPN
+# Loads XM file (any tupe)
   def getas
     load_xm(@a)
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getfile

@@ -1,4 +1,5 @@
 class XRPN
+# Read any file named in Alpha into X
   def getfile
     lift
     begin
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getfilea

@@ -1,4 +1,5 @@
 class XRPN
+# Read any file named in Alpha into Alpha
   def getfilea
     begin
       @a = File.read(@a)
@@ -8,4 +9,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getkey

@@ -1,4 +1,5 @@
 class XRPN
+# Waits 10 seconds for user to press a key (return Character Code to X, not HP-41 key code)
   def getkey
     key = STDIN.getch(min: 0, time: 10)
     lift
@@ -6,4 +7,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getkeyx

@@ -1,4 +1,5 @@
 class XRPN
+# Waits X seconds for user to press a key (return Character Code to X)
   def getkeyx
     @l = @x
     key = STDIN.getch(min: 0, time: @x)
@@ -7,4 +8,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getp

@@ -1,4 +1,5 @@
 class XRPN
+# Get program from program file
   def getp
     f = Dir.home + "/.xrpn/data/" + @a + ".pr"
     if File.exist?(f)
@@ -10,4 +11,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getr

@@ -1,4 +1,5 @@
 class XRPN
+# Get all registers from XM data file and copy to registers
   def getr
     # No reason to not allow ascii files to be read into regs
     i = 0
@@ -10,4 +11,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getrec

@@ -1,8 +1,9 @@
 class XRPN
+# Get current record from current XM file, replacing content of Alpha
   def getrec
     cla
     arclrec
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getrx

@@ -1,4 +1,5 @@
 class XRPN
+# Get registers by X (bbb.eee)
   def getrx
     b = @x.to_i
     e = (@x.frc * 1000).to_i
@@ -14,4 +15,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getsub

@@ -1,4 +1,5 @@
 class XRPN
+# Get sub program (no need - XRPN works with pages for programs)
   def getsub
     return "GETSUB: No need for that function. XRPN works with pages instead."
   end

data/xcmd/getweb

@@ -1,4 +1,5 @@
 class XRPN
+# Get web page with URL in Alpha into X
   def getweb
     lift
     begin
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/getx

@@ -1,4 +1,5 @@
 class XRPN
+# Get current record in XM data file to X
   def getx
     # No reason to not allow ascii files to be read into regs
     lift
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/grad

@@ -1,7 +1,8 @@
 class XRPN
+# Set degree mode to GRAD (400 degrees in a circle)
   def grad
     @deg = "grad"
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/gsb

@@ -1,4 +1,5 @@
 class XRPN
+# Jump to label n and return here after an RTN or END is encountered
   def gsb (l)
     xeq (l)
   end

data/xcmd/gto

@@ -1,4 +1,5 @@
 class XRPN
+# Goto (jump) to a string label, numbered label or line number (GTO "MyProg", GTO 31, GTO .214), using a dot before the line number)
   def gto (l)
     if l.match(/^\./)
       @pc = l.sub(/^\./, "").to_i - 1

data/xcmd/help

@@ -1,4 +1,5 @@
 class XRPN
+# Print help text
   def help
     puts
     puts "XRPN is a stack-based programming language. It uses Reverse Polish Notation for calculations."
@@ -11,4 +12,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/hexdec

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

data/xcmd/hms

@@ -1,4 +1,5 @@
 class XRPN
+# Convert decimal hours to HH.MMSSsss
   def hms
     @l = @x
     h  = @x.to_i
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/hmsminus

@@ -1,4 +1,5 @@
 class XRPN
+# Add hours (HH.MMSSsss) or degrees
   def hmsminus
 	lastx = @x
 	hr
@@ -11,4 +12,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/hmsplus

@@ -1,4 +1,5 @@
 class XRPN
+# Subtract hours (HH.MMSSsss) or degrees
   def hmsplus
 	lastx = @x
 	hr
@@ -10,4 +11,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/hr

@@ -1,4 +1,5 @@
 class XRPN
+# Append Alpha to current XM file at pointer
   def hr
     @l = @x
     s  = @x.to_i * 3600
@@ -8,4 +9,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/inschr

@@ -1,4 +1,5 @@
 class XRPN
+# Insert Alpha at pointer in current XM file
   def inschr
     if @xmcont[0][0] == ""
       return 
@@ -11,4 +12,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/insrec

@@ -1,4 +1,5 @@
 class XRPN
+# Insert Alpha before current record in XM file
   def insrec
     if @xmcont[0][0] == ""
       return 
@@ -9,4 +10,4 @@ class XRPN
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/int

@@ -1,8 +1,9 @@
 class XRPN
+# Add a line in the printout
   def int
     @l = @x
     @x = @x.to_i
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/invf

@@ -1,4 +1,5 @@
 class XRPN
+# Invert flag (toggle flag n)
   def invf (f)
     @flg[f] = !@flg[f]
   end

data/xcmd/isg

@@ -1,4 +1,5 @@
 class XRPN
+# Increase, skip if greader for named register
   def isg (r)
     case r.downcase
     when "x"

data/xcmd/lastx

@@ -1,8 +1,9 @@
 class XRPN
+# Get content of Last X (L register) to X
   def lastx
     @y, @z, @t = @x, @y, @z
     @x = @l
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/lbl

@@ -1,4 +1,5 @@
 class XRPN
+# Label in a program that you can GTO or XEQ to
   def lbl (l)
   end
 end

data/xcmd/lift

@@ -1,8 +1,9 @@
 class XRPN
+# Lift stack
   def lift
     return if @nolift
     @y, @z, @t = @x, @y, @z
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby:

data/xcmd/ln

@@ -1,8 +1,9 @@
 class XRPN
+# Natural logarithm
   def ln
     @l = @x
     @x = Math::log(@x)
   end
 end
  
-# vim:ft=ruby:
+# vim:ft=ruby: