rpl 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745f492092d7e5dd03c90ca25ee5de900832730342075295a8f9d190734ed4d4
-  data.tar.gz: b7a56161fcf77d5b90b015e4bc67ba3a770605aba261c46f40adfbac1232daa6
+  metadata.gz: 81bb665b199a735ae446f0c00d77ca0d7f0e7d0ee2a6ca676f7c3dc159501fbb
+  data.tar.gz: 9b4bbb9d917e49d34d14a2457cf665fe4e701ed9bc89334c076c8c7fca0f1937
 SHA512:
-  metadata.gz: 4df6860f009ab1ae4c957000e98fd7f39be60c2d9370ab0626a60e71a84625b14e9d5bb9142c53d178d602b2654ec95ade37d4bf03825245a318d7da9f5a6296
-  data.tar.gz: 19f365a0e10430051ba6ca75cbe55d4504fb3ef2e6d778e4114d335f20c558f7921b9921b949caf11eb3fccb1538f014f3c2a396421648fee0035fa8eac08f67
+  metadata.gz: ddd530974f32189a9b76ea9bb932e8452eb6ccdeb88f06754bae7c085289bb2989e2fd165c8d234056657b91d8575ab388e6d19f32163e589033f4949eeb20bb
+  data.tar.gz: 6e64d40c9a72f72dce91254b450d53ab1a204a503599a7b92bf8c6ee1148c0ca6049bdcda9b611289d06aa34b9364f6a86832e20641d8acd44522276b715ad10

data/README.md

@@ -0,0 +1,74 @@
+# rpl.rb
+
+Reverse-Polish-Lisp inspired language in ruby
+
+# Install
+`gem install rpl`
+
+# Usage
+  * `rpl --help`
+  * run RPL: `rpl`
+  * by default rpl persists its state in ~/.local/state/rpl.rb/machine which is created if needed
+
+# Development
+To run REPL locally: `rake run`
+
+To run the test suite: `rake test`
+
+To build gem: `rake gem`
+
+# known bugs
+ -
+
+# TODO-list
+  * Language:
+    * pseudo filesystem: subdir/namespace for variables
+      . 'a dir' crdir 'a dir' cd vars
+  * SDL-based graphic environment/API
+
+# Not yet implemented
+```sh
+$ grep "# @dictionary.add_word" ./lib/rpl/words/*.rb
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['ln'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['lnp1'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['exp'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['expm'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['log10'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['alog10'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['log2'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['alog2'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['sinh'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['asinh'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['cosh'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['acosh'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['tanh'],
+./lib/rpl/words/logarithm.rb:        # @dictionary.add_word!( ['atanh'],
+./lib/rpl/words/mode.rb:        # @dictionary.add_word!( ['std'],
+./lib/rpl/words/mode.rb:        # @dictionary.add_word!( ['fix'],
+./lib/rpl/words/mode.rb:        # @dictionary.add_word!( ['sci'],
+./lib/rpl/words/mode.rb:        # @dictionary.add_word!( ['round'],
+./lib/rpl/words/operations-complexes.rb:        # @dictionary.add_word!( ['p→r', 'p->r'],
+./lib/rpl/words/operations-complexes.rb:        # @dictionary.add_word!( ['r→p', 'r->p'],
+```
+
+# No implementation planned
+  * use IFT, IFTE instead of
+    . if
+    . then
+    . else
+    . end
+  * use LOOP, TIMES instead of
+    . start
+    . for
+    . next
+    . step
+    . do
+    . until
+    . while
+    . repeat
+  * use LSTO instead of
+    . ->, →
+
+# inspirations and references
+  * https://en.wikipedia.org/wiki/RPL_(programming_language)
+  * https://github.com/louisrubet/rpn/

data/bin/rpl

@@ -19,7 +19,7 @@ class RplRepl
     @interpreter = interpreter
   end
 
-  def run
+  def run!
     print_stack unless @interpreter.stack.empty?
 
     Reline.completion_proc = proc do |s|
@@ -48,13 +48,13 @@ class RplRepl
         prefill = @interpreter.stack.pop.to_s
       elsif input.strip == 'history'
         history = Reline::HISTORY.map { |line| "\"#{line}\"" }.join(' ')
-        @interpreter.run( "{ #{history} }" )
+        @interpreter.run!( "{ #{history} }" )
       elsif input.empty?
         # Remove blank lines from history
         Reline::HISTORY.pop
       else
         begin
-          @interpreter.run( input )
+          @interpreter.run!( input )
         rescue ArgumentError => e
           pp e
         end
@@ -117,17 +117,15 @@ interpreter = Rpl.new( persistence_filename: options[:persistence_filename],
 
 # first run provided files if any
 options[:files].each do |filename|
-  interpreter.run "\"#{File.expand_path( filename )}\" feval"
+  interpreter.run!( "\"#{File.expand_path( filename )}\" feval" )
 end
 
 # second run provided code if any
 options[:programs].each do |program|
-  interpreter.run program
+  interpreter.run!( program )
 end
 
 # third launch REPL if (explicitely or implicitely) asked
-if options[:run_REPL]
-  RplRepl.new( interpreter: interpreter ).run
-else
-  interpreter.persist_state
-end
+RplRepl.new( interpreter: interpreter ).run! if options[:run_REPL]
+
+interpreter.persist_state

data/lib/rpl/dictionary.rb

@@ -11,7 +11,7 @@ class Dictionary
     @local_vars_layers = []
   end
 
-  def add_word( names, category, help, implementation )
+  def add_word!( names, category, help, implementation )
     names.each do |name|
       @words[ name ] = { category: category,
                          help: help,
@@ -19,43 +19,43 @@ class Dictionary
     end
   end
 
-  def add_var( name, implementation )
+  def add_var!( name, implementation )
     @vars[ name ] = implementation
   end
 
-  def remove_vars( names )
+  def remove_vars!( names )
     names.each do |name|
       @vars.delete( name )
     end
   end
 
-  def remove_var( name )
-    remove_vars( [name] )
+  def remove_var!( name )
+    remove_vars!( [name] )
   end
 
-  def remove_all_vars
+  def remove_all_vars!
     @vars = {}
   end
 
-  def add_local_vars_layer
+  def add_local_vars_layer!
     @local_vars_layers << {}
   end
 
-  def add_local_var( name, implementation )
+  def add_local_var!( name, implementation )
     @local_vars_layers.last[ name ] = implementation
   end
 
-  def remove_local_vars( names )
+  def remove_local_vars!( names )
     names.each do |name|
       @local_vars_layers.last.delete( name )
     end
   end
 
-  def remove_local_var( name )
+  def remove_local_var!( name )
     remove_local_vars( [name] )
   end
 
-  def remove_local_vars_layer
+  def remove_local_vars_layer!
     @local_vars_layers.pop
   end
 
@@ -68,7 +68,7 @@ class Dictionary
     word ||= @vars[ name ]
 
     # or is it a core word
-    word ||= @words[ name ].nil? ? nil : @words[ name ][:implementation]
+    word ||= @words[ name.downcase ].nil? ? nil : @words[ name.downcase ][:implementation]
 
     word
   end

data/lib/rpl/interpreter.rb

@@ -47,8 +47,8 @@ class Interpreter
     @frame_buffer = BitArray.new
   end
 
-  def run( input )
-    @dictionary.add_local_vars_layer
+  def run!( input )
+    @dictionary.add_local_vars_layer!
 
     Parser.parse( input.to_s ).each do |elt|
       if elt.instance_of?( RplName )
@@ -64,7 +64,7 @@ class Interpreter
           elsif command.is_a?( Proc )
             command.call
           elsif command.instance_of?( RplProgram )
-            run( command.value )
+            run!( command.value )
           else
             @stack << command
           end
@@ -74,7 +74,7 @@ class Interpreter
       end
     end
 
-    @dictionary.remove_local_vars_layer
+    @dictionary.remove_local_vars_layer!
 
     # superfluous but feels nice
     @stack

data/lib/rpl/words/branch.rb

@@ -10,45 +10,45 @@ module RplLang
 
         category = 'Branch'
 
-        @dictionary.add_word( ['ift'],
-                              category,
-                              '( t pt -- … ) eval pt or not based on the value of boolean t',
-                              Types.new_object( RplProgram, '« « nop » ifte »' ) )
-
-        @dictionary.add_word( ['ifte'],
-                              category,
-                              '( t pt pf -- … ) eval pt or pf based on the value of boolean t',
-                              proc do
-                                args = stack_extract( [:any, :any, [RplBoolean]] )
-
-                                run( args[ args[2].value ? 1 : 0 ].value )
-                              end )
-
-        @dictionary.add_word( ['times'],
-                              category,
-                              '( p n -- … ) eval p n times while pushing counter on stack before',
-                              proc do
-                                args = stack_extract( [[RplNumeric], :any] )
-
-                                args[0].value.to_i.times do |counter|
-                                  @stack << Types.new_object( RplNumeric, counter )
-
-                                  run( args[1].value )
-                                end
-                              end )
-
-        @dictionary.add_word( ['loop'],
-                              category,
-                              '( p n1 n2 -- … ) eval p looping from n1 to n2 while pushing counter on stack before',
-                              proc do
-                                args = stack_extract( [[RplNumeric], [RplNumeric], :any] )
-
-                                ((args[1].value.to_i)..(args[0].value.to_i)).each do |counter|
-                                  @stack << Types.new_object( RplNumeric, counter )
-
-                                  run( args[2].value )
-                                end
-                              end )
+        @dictionary.add_word!( ['ift'],
+                               category,
+                               '( t pt -- … ) eval pt or not based on the value of boolean t',
+                               Types.new_object( RplProgram, '« « nop » ifte »' ) )
+
+        @dictionary.add_word!( ['ifte'],
+                               category,
+                               '( t pt pf -- … ) eval pt or pf based on the value of boolean t',
+                               proc do
+                                 args = stack_extract( [:any, :any, [RplBoolean]] )
+
+                                 run!( args[ args[2].value ? 1 : 0 ].value )
+                               end )
+
+        @dictionary.add_word!( ['times'],
+                               category,
+                               '( p n -- … ) eval p n times while pushing counter on stack before',
+                               proc do
+                                 args = stack_extract( [[RplNumeric], :any] )
+
+                                 args[0].value.to_i.times do |counter|
+                                   @stack << Types.new_object( RplNumeric, counter )
+
+                                   run!( args[1].value )
+                                 end
+                               end )
+
+        @dictionary.add_word!( ['loop'],
+                               category,
+                               '( p n1 n2 -- … ) eval p looping from n1 to n2 while pushing counter on stack before',
+                               proc do
+                                 args = stack_extract( [[RplNumeric], [RplNumeric], :any] )
+
+                                 ((args[1].value.to_i)..(args[0].value.to_i)).each do |counter|
+                                   @stack << Types.new_object( RplNumeric, counter )
+
+                                   run!( args[2].value )
+                                 end
+                               end )
       end
     end
   end

data/lib/rpl/words/display.rb

@@ -10,19 +10,19 @@ module RplLang
 
         category = 'Display'
 
-        @dictionary.add_word( ['erase'],
-                              category,
-                              '( -- ) erase display',
-                              proc do
-                                initialize_frame_buffer
-                              end )
+        @dictionary.add_word!( ['erase'],
+                               category,
+                               '( -- ) erase display',
+                               proc do
+                                 initialize_frame_buffer
+                               end )
 
-        @dictionary.add_word( ['display→', 'display->'],
-                              category,
-                              '( -- pict ) put current display state on stack',
-                              proc do
-                                @stack << @frame_buffer # FIXME: RplPict type
-                              end )
+        @dictionary.add_word!( ['display→', 'display->'],
+                               category,
+                               '( -- pict ) put current display state on stack',
+                               proc do
+                                 @stack << @frame_buffer # FIXME: RplPict type
+                               end )
       end
     end
   end

data/lib/rpl/words/filesystem.rb

@@ -10,31 +10,31 @@ module RplLang
 
         category = 'Filesystem'
 
-        @dictionary.add_word( ['fread'],
-                              category,
-                              '( filename -- content ) read file and put content on stack as string',
-                              proc do
-                                args = stack_extract( [[RplString]] )
-
-                                path = File.expand_path( args[0].value )
-
-                                @stack << Types.new_object( RplString, "\"#{File.read( path )}\"" )
-                              end )
-
-        @dictionary.add_word( ['feval'],
-                              category,
-                              '( filename -- … ) read and run file',
-                              Types.new_object( RplProgram, '« fread eval »' ) )
-
-        @dictionary.add_word( ['fwrite'],
-                              category,
-                              '( content filename -- ) write content into filename',
-                              proc do
-                                args = stack_extract( [[RplString], :any] )
-
-                                File.write( File.expand_path( args[0].value ),
-                                            args[1].value )
-                              end )
+        @dictionary.add_word!( ['fread'],
+                               category,
+                               '( filename -- content ) read file and put content on stack as string',
+                               proc do
+                                 args = stack_extract( [[RplString]] )
+
+                                 path = File.expand_path( args[0].value )
+
+                                 @stack << Types.new_object( RplString, "\"#{File.read( path )}\"" )
+                               end )
+
+        @dictionary.add_word!( ['feval'],
+                               category,
+                               '( filename -- … ) read and run file',
+                               Types.new_object( RplProgram, '« fread eval »' ) )
+
+        @dictionary.add_word!( ['fwrite'],
+                               category,
+                               '( content filename -- ) write content into filename',
+                               proc do
+                                 args = stack_extract( [[RplString], :any] )
+
+                                 File.write( File.expand_path( args[0].value ),
+                                             args[1].value )
+                               end )
       end
     end
   end

data/lib/rpl/words/general.rb

@@ -10,38 +10,38 @@ module RplLang
 
         category = 'General'
 
-        @dictionary.add_word( ['nop'],
-                              category,
-                              '( -- ) no operation',
-                              proc {} )
-
-        @dictionary.add_word( ['help'],
-                              category,
-                              '( w -- s ) pop help string of the given word',
-                              proc do
-                                args = stack_extract( [[RplName]] )
-
-                                word = @dictionary.words[ args[0].value ]
-
-                                @stack << Types.new_object( RplString, "\"#{args[0].value}: #{word.nil? ? 'not a core word' : word[:help]}\"" )
-                              end )
-
-        @dictionary.add_word( ['quit'],
-                              category,
-                              '( -- ) Stop and quit interpreter',
-                              proc {} )
-
-        @dictionary.add_word( ['version'],
-                              category,
-                              '( -- n ) Pop the interpreter\'s version number',
-                              proc do
-                                @stack << Types.new_object( RplString, "\"#{Rpl::VERSION}\"" )
-                              end )
-
-        @dictionary.add_word( ['uname'],
-                              category,
-                              '( -- s ) Pop the interpreter\'s complete indentification string',
-                              Types.new_object( RplProgram, '« "Rpl Interpreter version " version + »' ) )
+        @dictionary.add_word!( ['nop'],
+                               category,
+                               '( -- ) no operation',
+                               proc {} )
+
+        @dictionary.add_word!( ['help'],
+                               category,
+                               '( w -- s ) pop help string of the given word',
+                               proc do
+                                 args = stack_extract( [[RplName]] )
+
+                                 word = @dictionary.words[ args[0].value ]
+
+                                 @stack << Types.new_object( RplString, "\"#{args[0].value}: #{word.nil? ? 'not a core word' : word[:help]}\"" )
+                               end )
+
+        @dictionary.add_word!( ['quit'],
+                               category,
+                               '( -- ) Stop and quit interpreter',
+                               proc {} )
+
+        @dictionary.add_word!( ['version'],
+                               category,
+                               '( -- n ) Pop the interpreter\'s version number',
+                               proc do
+                                 @stack << Types.new_object( RplString, "\"#{Rpl::VERSION}\"" )
+                               end )
+
+        @dictionary.add_word!( ['uname'],
+                               category,
+                               '( -- s ) Pop the interpreter\'s complete indentification string',
+                               Types.new_object( RplProgram, '« "Rpl Interpreter version " version + »' ) )
       end
     end
   end

data/lib/rpl/words/list.rb

@@ -10,40 +10,40 @@ module RplLang
 
         category = 'Lists'
 
-        @dictionary.add_word( ['→list', '->list'],
-                              category,
-                              '( … x -- […] ) pack x stacks levels into a list',
-                              proc do
-                                args = stack_extract( [[RplNumeric]] )
-                                args = stack_extract( %i[any] * args[0].value )
-
-                                @stack << Types.new_object( RplList, args.reverse )
-                              end )
-
-        @dictionary.add_word( ['list→', 'list->'],
-                              category,
-                              '( […] -- … ) unpack list on stack',
-                              proc do
-                                args = stack_extract( [[RplList]] )
-
-                                args[0].value.each do |elt|
-                                  @stack << elt
-                                end
-                              end )
-
-        @dictionary.add_word( ['dolist'],
-                              category,
-                              '( […] prg -- … ) run prg on each element of a list',
-                              proc do
-                                args = stack_extract( [[RplProgram], [RplList]] )
-
-                                args[1].value.each do |elt|
-                                  @stack << elt
-                                  run( args[0].value )
-                                end
-
-                                run( "#{args[1].value.length} →list" )
-                              end )
+        @dictionary.add_word!( ['→list', '->list'],
+                               category,
+                               '( … x -- […] ) pack x stacks levels into a list',
+                               proc do
+                                 args = stack_extract( [[RplNumeric]] )
+                                 args = stack_extract( %i[any] * args[0].value )
+
+                                 @stack << Types.new_object( RplList, args.reverse )
+                               end )
+
+        @dictionary.add_word!( ['list→', 'list->'],
+                               category,
+                               '( […] -- … ) unpack list on stack',
+                               proc do
+                                 args = stack_extract( [[RplList]] )
+
+                                 args[0].value.each do |elt|
+                                   @stack << elt
+                                 end
+                               end )
+
+        @dictionary.add_word!( ['dolist'],
+                               category,
+                               '( […] prg -- … ) run prg on each element of a list',
+                               proc do
+                                 args = stack_extract( [[RplProgram], [RplList]] )
+
+                                 args[1].value.each do |elt|
+                                   @stack << elt
+                                   run!( args[0].value )
+                                 end
+
+                                 run!( "#{args[1].value.length} →list" )
+                               end )
       end
     end
   end