xrpn 1.1.13 → 1.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a19f8e4bef73ee3b6099d50a418d033d129ecbfb808b7e6ca2e058f1036a74
-  data.tar.gz: 0eda38a9de877944f51b0c7c2407261b60d386edf1a7f7c1e466b9a601bdc01d
+  metadata.gz: 997d8363376f12e825a6fef631f9746670abe5a15b87854092fba9f804967b89
+  data.tar.gz: 0a177f5c9f3c572aa658b77f3140a424b3ebc81d19a429ffa581ba930066db6e
 SHA512:
-  metadata.gz: 0c70decfd7068d4defa8b912cbafa7d30fb2595425f2df8a5a5ebf3ca02f775e1a4acca00cf7710413ba3f06907e11fa534778748da752db24e526788bbd0a9a
-  data.tar.gz: 118569c5be20f93115c304b9072dfae4e9c6254ab2fdd7ca78c75d5e8231ec580f035f252528734465b335b609a5d9187507b016ffa571fa1766b3f78425caa1
+  metadata.gz: 7aee88191d0b2f629833e649e5eddfeb7162f9d91e97cd3a32c8c218d6fbf48feb99e85946bc83727fbbdb96d677b736ceb3b180ee4709f48b84105ea0694e92
+  data.tar.gz: fd57147cffdd7993105ca869e9f85793236b9ac4909d5b6f8bd3ffcb1948a5171bf0c91c80de3c1a2c6826f12d1e096493a100e17248ec1e3dbf97165347ad80

data/README.md

@@ -0,0 +1,88 @@
+# XRPN
+
+## Introduction
+
+XRPN is a stack-based programming language, similar to [Forth](https://en.wikipedia.org/wiki/Forth_(programming_language)), but simpler in nature.
+ 
+XRPN is on-the-fly extensible. Language functions can be upgraded or implemented while programs are running.
+
+It runs programs in text files or manually in debug mode (if no text file is supplied or when a program stops). 
+
+The language is a superset of [FOCAL](https://www.hpmuseum.org/prog/hp41prog.htm), implementing the full set of [HP-41CX calculator](https://www.hpmuseum.org/hp41.htm) commands. It uses Reverse Polish Notation for calculations.
+
+XRPN implements indirect addressing, self-modification and features well beyond the FOCAL language.
+
+## Install
+
+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.
+
+## Run
+
+To run XRPN, make sure the program file ("bin/xrpn") is copied or linked to a directory in your path. If you have "~/bin" in your path, the install scrip has already taken care of this. Simply run the environment via `xrpn` in a terminal to enter the "debug mode" and manually issue commands or do calculations. To run a program, save it in a text file (like "myprogram.txt") and run `xrpn -f myprogram.txt` or `xrpn --file myprogram.txt` to let xrpn execute it. If you want to load a program without running it immediately, you can use the `-l` or `--load` switch like this `xrpn -l myprogram.txt`. If you want to load several program files, just separate the file names with commas (and no spaces) like this `xrpn -l prgm1.txt,prgm2.txt`. You can also save a full XRPN state with the stack, registers, flags, settings and programs in various pages and load that when starting XRPN with the -s switch. You can check a program for possible errors via the -c switch: `xrpn -c myprogram.txt`.
+
+The full synopsis goes like this:
+```
+Usage: xrpn [options]
+    -f, --file XRPN-file             Specify the file to process
+    -l, --load XRPN-file             Specify a file to load, but not run
+    -s, --state STATE                Load a State file
+	-c, --check program              Program file to check for errors
+    -x, --X X-value                  Set initial value in the X register
+    -y, --Y Y-value                  Set initial value in the Y register
+    -z, --Z Z-value                  Set initial value in the Z register
+    -t, --T T-value                  Set initial value in the T register
+    -a, --Alpha Alpha-string         Set initial string in Alpha
+    -h                               Display SHORT help text
+        --help                       Display LONG help text
+    -v, --version                    Display the XRPN version number
+```
+
+## FOCAL and the HP-41 system
+
+Since XRPN covers the function set of the HP-41CX calculator, you now have an environment where thousands of HP-41 calculator programs can run. You have at your fingertips programs covering engineering, finance, chemistry and physics to navigation, astronomy, forecasting, statistics and most areas of science and mathematics. With the enhanced features, you can make self-modifying programs, capture web pages, get full regexp capabilities, manipulate files and plenty more.
+
+With more than 250 built-in functions, there is a lot to document. The documentation is unfolding in [the wiki page in this repo](https://github.com/isene/xrpn/wiki/XRPN-Documentation).
+
+Note that I have not yet implemented the clock, the alarm and stopwatch functionality of the HP-41CX as I can't yet see much benefit to that. The functions TIME, DATE, DATE+, DDAYS, DOW, HR, HMS, HMS+, HMS- are implemented.
+
+## Example program
+
+To give you a taste of XRPN, consider this program:
+
+```
+LBL "HELLO"
+"Input your name. Enclose your name in double-quotes and press Enter."
+PROMPT
+ASTO 00
+"Hello, "
+ARCL 00
+ADV
+AVIEW
+ADV
+13
+8
+*
+100
+X<>Y
+X>Y?
+"13 * 8 is greater than 100"
+AVIEW
+END
+```
+
+## Documentation
+
+...is all in [the wiki page in this repo](https://github.com/isene/xrpn/wiki/XRPN-Documentation).
+
+
+## Note
+
+Thanks to the HP Calculator community, the Astrophysical Institute in Oslo and to my lovely Siv for inspirations.
+
+Any and all feedback is welcome. Send me an e-mail at `g@isene.com`.

data/bin/xrpn

@@ -9,8 +9,27 @@ require 'bigdecimal'
 require 'open-uri'
 require 'json'
 require 'tty-prompt'
+begin
+  require 'xrpn'
+  $gem = Gem.latest_spec_for("xrpn").gem_dir
+rescue LoadError
+end
+
+# ENSURE DIRs
+Dir.mkdir(Dir.home + "/.xrpn") unless File.exist?(Dir.home + "/.xrpn")
+["data", "extra", "print", "xcmd", "xlib"].each do |d|
+  Dir.mkdir(Dir.home + "/.xrpn/" + d) unless File.exist?(Dir.home + "/.xrpn/" + d)
+end
+
+# READ LIBRARY AND COMMANDS
+Dir[$gem+"/xlib/*"].each { |file| load file } if $gem   # Read xlib directory from the Gem
+Dir[Dir.home+"/.xrpn/xlib/*"].each { |file| load file } # Read xlib directory from home dir
+read_xcmd # Read XRPN commands (both from Gem and home dir)
 
-# Handle the command line options
+# INITIALIZE VARIABLES
+@x, @y, @z, @t, @a = 0, 0, 0, 0, ""
+
+# HANDLE COMMAND LINE OPTIONS
 options = {}
 optparse = OptionParser.new do |opts|
   # Set a banner, displayed at the top of the help screen.
@@ -32,23 +51,16 @@ optparse = OptionParser.new do |opts|
 end
 optparse.parse!
 
-# ENSURE DIRs
-Dir.mkdir(Dir.home + "/.xrpn") unless File.exist?(Dir.home + "/.xrpn")
-["data", "extra", "print", "xcmd", "xlib"].each do |d|
-  Dir.mkdir(Dir.home + "/.xrpn/" + d) unless File.exist?(Dir.home + "/.xrpn/" + d)
-end
-
-# INITIALIZE
-$theme = "dark"
-@x, @y, @z, @t, @a = 0, 0, 0, 0, ""
-begin
-  require 'xrpn'
-rescue LoadError
-end
-Dir[Dir.home+"/.xrpn/xlib/*"].each { |file| load file } # Read libraries
-read_cmd                                                # Read XRPN commands
+# INITIALIZE CLASS
 @p = XRPN.new($rfile)
+
+# READ USER CONF
+load(Dir.home+'/.xrpn/conf') if File.exist?(Dir.home+'/.xrpn/conf')
+
+# SET VARIABLES FROM OPTPARSE
 @p.x, @p.y, @p.z, @p.t, @p.a = @x, @y, @z, @t, @a
+
+# INITIALIZE XRPN PROGRAM
 @p.prg[@p.pg] = ["LBL \"XRPN\"", "END"] unless $rfile   # Put dummy program in page 0 if no file to run
 @p.prg[@p.pg] = hp_41(@p.prg[@p.pg]) if $rfile          # Substitute HP-41 commands with XRPN commands
 if $lfile                                               # Read file to load but not run if -l switch is used
@@ -59,7 +71,8 @@ if $lfile                                               # Read file to load but
 end
 read_state($sfile) if $sfile                            # Read state file in ~.xrpn/ if -s switch is used
 $debug = true      if $lfile or $sfile                  # Do not run loaded program or program in state file
-load(Dir.home+'/.xrpn/conf')  if File.exist?(Dir.home+'/.xrpn/conf')  # Read config file
+
+# THEME
 theme($theme)
 load(Dir.home+'/.xrpn/theme') if File.exist?(Dir.home+'/.xrpn/theme') # Override theme if user theme file exists
 

data/conf

@@ -0,0 +1,13 @@
+@p.x   = 0.0
+@p.y   = 0.0
+@p.z   = 0.0
+@p.t   = 0.0
+@p.l   = 0.0
+@p.a   = ""
+@p.i   = 4
+@p.s   = 9
+@p.srg = 11
+@p.reg = {}
+@p.flg = {"28"=>false, "29"=>true, "31"=>false, "44"=>false, "22"=>false, "23"=>false}
+@p.prg = [["LBL \"XRPN\"", "END"]]
+$theme = "dark"

data/theme_example

@@ -0,0 +1,10 @@
+$colors = {
+  "X" => 255,
+  "Y" => 246,
+  "Z" => 243,
+  "T" => 240,
+  "L" => 130,
+  "A" =>  39
+}
+ 
+# vim:ft=ruby:

data/xlib/_xrpn_version

@@ -1,5 +1,5 @@
 def xrpn_version
-  puts "XRPN version: 0.95"
+  puts "XRPN version: 0.98"
 end
  
 # vim:ft=ruby:

data/xlib/{read_cmd → read_xcmd}

@@ -1,5 +1,13 @@
-def read_cmd
+def read_xcmd
   $cmd = []
+  if $gem
+    Dir[$gem+"/xcmd/*"].each do |file|
+      load file
+      l = IO.readlines(file)[1]
+      c = l.sub(/\s*def (\S+).*/, '\1').chomp
+      $cmd.push(c)
+    end
+  end
   Dir[Dir.home+"/.xrpn/xcmd/*"].each do |file|
     load file
     l = IO.readlines(file)[1]

data/xlib/theme

@@ -1,4 +1,4 @@
-def theme(t="dark")
+def theme(t=$theme)
   if t == "light"
     $colors = {
       "X" => 232,
@@ -19,5 +19,5 @@ def theme(t="dark")
     }
   end
 end
-
+ 
 # vim:ft=ruby:

data/xrpn.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'xrpn'
-  s.version     = '1.1.13'
+  s.version     = '1.1.14'
   s.licenses    = ['Unlicense']
   s.summary     = "XRPN - The eXtended RPN (Reverse Polish Notation) programming language"
   s.description = "A full programming language and environment extending the features of the venerable HP calculator programmable calculators. With XRPN you can accomplish a wide range of modern programming tasks as well as running existing HP-41 FOCAL programs directly. XRPN gives modern life to tens of thousands of old HP calculator programs and opens the possibilities to many, many more."
@@ -11,6 +11,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'tty-prompt', '~> 0.23'
   
-  s.files       = ["bin/xrpn", "lib/xrpn.rb", "xrpn.gemspec"] + Dir.glob("xcmd/*") + Dir.glob("xlib/*")
+  s.files       = ["bin/xrpn", "conf", "theme_example", "README.md", "xrpn.gemspec"] + Dir.glob("xcmd/*") + Dir.glob("xlib/*")
   s.executables << 'xrpn'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xrpn
 version: !ruby/object:Gem::Version
-  version: 1.1.13
+  version: 1.1.14
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-prompt
@@ -35,8 +35,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/xrpn
-- lib/xrpn.rb
+- conf
+- theme_example
 - xcmd/abs
 - xcmd/acos
 - xcmd/adate
@@ -313,8 +315,8 @@ files:
 - xlib/locate_prg
 - xlib/numeric
 - xlib/numformat
-- xlib/read_cmd
 - xlib/read_state
+- xlib/read_xcmd
 - xlib/save_state
 - xlib/save_xm
 - xlib/setpt

data/lib/xrpn.rb

@@ -1,2 +0,0 @@
-Dir[__dir__ + "/../xlib/*"].each { |file| load file }
-Dir[__dir__ + "/../xcmd/*"].each { |file| load file }