fOOrth 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30474940c4c3e0647c0c1205d6165d3c3d11ee3a
-  data.tar.gz: 8e65265692a9ed674814aa78c9fd2892da3456a1
+  metadata.gz: 2a310602eff6fd2746b07abee8e0ea1618aca564
+  data.tar.gz: 455f496faf46e85cd2b7ce47baa87b5318f58aa5
 SHA512:
-  metadata.gz: e53b8c014e66a4f7f0401292c00e4e361a0a0667ade42bc26be9db1a93976f8686ca0c874fabca16efad207a6c89c45994bf4be17ea712861ecdf64c84cf2446
-  data.tar.gz: 79cfd83122d97e5b83a357d6b7df7c8083a163c7467131d963396f13a300aae0c7a7e003dd51ec62776aa3adc33e8607bd711bf623808564fb5498baabb54758
+  metadata.gz: 208dd59bb806359e23b7178a493caf42819c5b55d17674a06f2b11a709fb7de16ccf1ebfb5b6df33515148fa27fa748c849fea63253ab246da48e5f47de6f721
+  data.tar.gz: 7755e262d1563086fa7c7769aa50b452e1331a0ddbf1358b76ccfc2d2fd14c56467f12c2e4c5c82a461b2cb8d4e2be526c331f4e9dafaa36a2617aa1079c3d83

data/README.md

@@ -14,6 +14,24 @@ fOOrth Programming Language web site at:
 <br>http://www.foorth.org/
 <br>
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fOOrth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fOOrth
+
+The fOOrth gem itself is found at: ( https://rubygems.org/gems/fOOrth )
+
 ## Usage
 Adding fOOrth can be as simple as:
 
@@ -23,9 +41,13 @@ Adding fOOrth can be as simple as:
 This will launch an interactive fOOrth session. Alternatively this can be
 done with:
 
-    rake run
+    $ fOOrth
+
+or
+
+    $ rake run
 
-Be sure to be in the folder that contains the rakefile in order for this
+Be sure to be in the folder that contains the rakefile in order for the latter
 command to work.
 
 <br>If, instead, a non-interactive facility is required, use:
@@ -41,12 +63,11 @@ where the string is fOOrth code to be executed, or for a file of code, use:
 ## Further Documentation
 
 The fOOrth Language System is documented in The fOOrth User Guide. This is
-currently only available in Open Office format, and is still also very much
-a work in progress. Please see The_fOOrth_User_Guide.odt in the docs folder.
+currently only available in Open Office and PDF formats. The guide tracks
+changes in the language fairly closely. The most current guide in PDF
+format may be found at the community web site above.
 
-Also for those who do not have or don't want Open Office: As each major
-version of fOOrth is made available, expect to see portable document format
-(pdf) versions of the guide. (In the docs folder in the repository)
+This code repo also has PDF formatted guides for majot revisions.
 
 ## Contributing
 

data/fOOrth.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = raw_list
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(tests|integration)/})
   spec.require_paths = ["lib"]
   spec.executables   = ["fOOrth"]
 
@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'full_clone'
   spec.add_runtime_dependency 'safe_clone'
   spec.add_runtime_dependency 'in_array'
-  spec.add_runtime_dependency 'mini_readline', ">= 0.4.2"
+  spec.add_runtime_dependency 'mini_readline', ">= 0.4.8"
 end

data/integration/compile_lib_tests.rb

@@ -187,4 +187,12 @@ class CompileLibraryTester < Minitest::Test
     foorth_equal('"integration/_FILE_test.foorth" .load ', [nm, 7, nm])
   end
 
+  def test_comments
+    foorth_equal('42 (foo (bar) etc) 33', [42, 33])
+
+    foorth_raises('(  (  )')
+
+    foorth_equal('42 // foo bar etc 33', [42])
+  end
+
 end

data/integration/ctrl_struct_lib_tests.rb

@@ -75,6 +75,26 @@ class CtrlStructLibraryTester < Minitest::Test
     foorth_equal('42 .with{{ {{ self }} .call }}', [42])
   end
 
+  def test_compile_suspend
+    foorth_equal(': tcs [[ 42 ]] ;', [42])
+    foorth_raises('[[ ]]')
+
+    foorth_equal(': tcs [[ 42 , ]] ; tcs', [42])
+    foorth_raises('42 ,')
+
+    foorth_equal('asm" vm.push(42);" ', [42])
+    foorth_equal(': tcs asm" vm.push(42);" ; tcs', [42])
+
+    foorth_equal('"vm.push(42);" .asm ', [42])
+    foorth_equal(': tcs "vm.push(42);" .asm ; tcs', [42])
+
+    foorth_equal(': tcs [[ ,asm"vm.push(42);" ]] ; tcs', [42])
+    foorth_raises(',asm"vm.push(42);" ')
+
+    foorth_equal(': tcs [[ "vm.push(42);" ,asm  ]] ; tcs', [42])
+    foorth_raises('"vm.push(42);" ,asm ')
+  end
+
   def test_for_unsupported_structures
     foorth_raises('4 .new{{  }}')
     foorth_raises('4 .each{{  }}')

data/irbt.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+# An IRB + fOOrth Test bed
+
+require 'irb'
+$force_alias_read_line_module = true
+require 'mini_readline'
+
+puts "Starting an IRB console with fOOrth loaded."
+
+if ARGV[0] == 'local'
+  require_relative 'lib/fOOrth'
+  puts "fOOrth loaded locally: #{XfOOrth::VERSION}"
+
+  ARGV.shift
+else
+  require 'fOOrth'
+  puts "fOOrth loaded from gem: #{XfOOrth::VERSION}"
+end
+
+IRB.start

data/lib/fOOrth/compiler.rb

@@ -31,6 +31,9 @@ module XfOOrth
     #The level of quote nesting.
     attr_accessor :quotes
 
+    #The level of comment nesting.
+    attr_accessor :parens
+
     #Is a force compile in effect?
     attr_accessor :force
 
@@ -39,6 +42,7 @@ module XfOOrth
       @buffer = nil
       @parser = nil
       @quotes = 0
+      @parens = 0
       @force  = false
       @context = Context.new(nil, vm: self, mode: :execute)
       self
@@ -48,6 +52,13 @@ module XfOOrth
     def <<(text)
       dbg_puts "  Append=#{text.inspect}"
       @buffer << text
+    rescue NoMethodError
+      error "F14: The current mode does not allow code to be appended."
+    end
+
+    #Is the buffer valid?
+    def buffer_valid?
+      @buffer.is_a?(String)
     end
 
     #Execute code from the interactive console.

data/lib/fOOrth/compiler/modes/deferred.rb

@@ -11,8 +11,10 @@ module XfOOrth
     #<br>Parameters:
     #* text - Some text to append to the buffer before proceeding.
     #* ctrl - The control symbol that started the deferral.
-    #<br>Note:
+    #<br>Notes:
     #* Adds a nested context level to be un-nested at a later point.
+    #* Enters deferred mode only if currently in execute mode. Otherwise
+    #  continues in the current mode.
     def suspend_execute_mode(text, ctrl)
       dbg_puts "  suspend_execute_mode"
       @context = Context.new(@context, ctrl: ctrl)

data/lib/fOOrth/compiler/modes/suspend.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 
-#* compiler/modes/suspend.rb - The ability to suspend compile mode.
+#* compiler/modes/suspend.rb - The ability to suspend buffered mode.
 module XfOOrth
-  #* compiler/modes/suspend.rb - The ability to suspend compile mode.
+  #* compiler/modes/suspend.rb - The ability to suspend buffered mode.
   class VirtualMachine
 
     #While compiling, suspend compiling so that some code may be executed.
@@ -10,9 +10,13 @@ module XfOOrth
     #* ctrl - The control symbol that suspended the compilation.
     #<br>Note:
     #* Adds a nested context level to be un-nested at a later point.
-    def suspend_compile_mode(ctrl)
-      dbg_puts "  suspend_compile_mode"
-      @context.check_set(:mode, [:compile])
+    def suspend_buffered_mode(ctrl)
+      dbg_puts "  suspend_buffered_mode"
+
+      unless buffer_valid?
+        error "F14: The #{ctrl} method is not available in execute mode."
+      end
+
       @context = Context.new(@context, mode: :execute, ctrl: ctrl)
     end
 
@@ -22,8 +26,8 @@ module XfOOrth
     #  suspended the compilation.
     #<br>Note:
     #* Un-nests a context level.
-    def resume_compile_mode(ctrls)
-      dbg_puts "  resume_compile_mode"
+    def resume_buffered_mode(ctrls)
+      dbg_puts "  resume_buffered_mode"
       @context.check_set(:ctrl, ctrls)
       @context = @context.previous
     end

data/lib/fOOrth/compiler/parser/skip.rb

@@ -31,8 +31,18 @@ module XfOOrth
     #<br>Note:
     #* Raises an XfOOrthError exception on an unterminated comment.
     def skip_over_comment
-      until @source.eoln?
-        return true if @source.get == ')'
+      vm = Thread.current[:vm]
+      vm.parens += 1
+
+      until @source.eof?
+        input = @source.get
+
+        if input == ')'
+          vm.parens -= 1
+          return true
+        elsif input == '('
+          skip_over_comment
+        end
       end
 
       error "F10: Unbalanced comment detected."

data/lib/fOOrth/compiler/source/console.rb

@@ -72,7 +72,7 @@ module XfOOrth
         puts vm.pop
       end
 
-      '>' * vm.context.depth + '"' * vm.quotes
+      '>' * vm.context.depth + '"' * vm.quotes + '(' * vm.parens
     end
 
     #What is the source of this text?

data/lib/fOOrth/library/ctrl_struct_library.rb

@@ -113,4 +113,48 @@ module XfOOrth
     })
   })
 
+  #Support for the [[ ... ]] construct.
+  VirtualMachine.create_shared_method('[[', VmSpec, [:immediate], &lambda {|vm|
+    suspend_buffered_mode('[[')
+
+    vm.context.create_local_method(']]', LocalSpec, [:immediate], &lambda {|vm|
+      resume_buffered_mode('[[')
+    })
+  })
+
+  #Support for the , method. Embed a value into the code stream.
+  Object.create_shared_method(',', TosSpec, [], &lambda {|vm|
+    vm << "vm.push(#{foorth_embed}); "
+  })
+
+  #Support for the asm" method. Perform some actions in assembly language.
+  #[] asm"asm_string" []
+  VirtualMachine.create_shared_method('asm"', VmSpec, [:immediate], &lambda {|vm|
+    code = vm.pop
+
+    if execute_mode?
+      vm.instance_exec(self, &eval("lambda {|vm| #{code} }"))
+    else
+      vm << code
+    end
+  })
+
+  #Support for the .asm method. Perform some actions in assembly language.
+  #[asm_string] .asm []
+  String.create_shared_method('.asm', TosSpec, [], &lambda {|vm|
+    vm.instance_exec(vm, &eval("lambda {|vm| #{self} }"))
+  })
+
+  #Support for the ,asm" method. Embed some actions in assembly language.
+  #[] ,asm"asm_string" []
+  String.create_shared_method(',asm"', TosSpec, [], &lambda {|vm|
+    vm << self
+  })
+
+  #Support for the ,asm method. Embed some actions in assembly language.
+  #[asm_string] ,asm []
+  String.create_shared_method(',asm', TosSpec, [], &lambda {|vm|
+    vm << self
+  })
+
 end

data/lib/fOOrth/library/stubs.rb

@@ -65,6 +65,10 @@ module XfOOrth
   Object.create_shared_method('.default{{',     NosSpec, [:stub])
   Object.create_shared_method('.new_default{{', NosSpec, [:stub])
 
+  #Embedding stubs.
+  Object.create_shared_method(',asm',           TosSpec, [:stub])
+  Object.create_shared_method(',asm"',          TosSpec, [:stub])
+
   #Define some "crossover" symbols.
   SymbolMap.add_entry('.is_class?',     "foorth_is_class?".to_sym)
   SymbolMap.add_entry('.to_s',          :to_foorth_s)

data/lib/fOOrth/monkey_patch.rb

@@ -4,6 +4,7 @@
 
 require_relative 'monkey_patch/exceptions'
 require_relative 'monkey_patch/object'
+require_relative 'monkey_patch/true'
 require_relative 'monkey_patch/false'
 require_relative 'monkey_patch/nil'
 require_relative 'monkey_patch/numeric'

data/lib/fOOrth/monkey_patch/false.rb

@@ -8,4 +8,11 @@ class FalseClass
     self
   end
 
+  #Convert this object to a form suitable for embedding in a source string.
+  #<br>Returns
+  #* An embeddable form of this object as a string.
+  def foorth_embed
+    'false'
+  end
+
 end

data/lib/fOOrth/monkey_patch/nil.rb

@@ -8,4 +8,11 @@ class NilClass
     false
   end
 
+    #Convert this object to a form suitable for embedding in a source string.
+  #<br>Returns
+  #* An embeddable form of this object as a string.
+  def foorth_embed
+    'nil'
+  end
+
 end

data/lib/fOOrth/monkey_patch/numeric.rb

@@ -6,14 +6,14 @@ class Numeric
   #<br>Returns
   #* An embeddable form of this number as a string.
   def foorth_embed
-    self.to_s.freeze
+    self.to_s
   end
 
   #Convert this number to a single character string.
   def to_foorth_c
     as_int = Integer.foorth_coerce(self)
 
-    if as_int < 0 || as_int > 1114111
+    if as_int < 0 || as_int > 1_114_111
       error "F40: Can't convert #{self} to a character."
     else
       [as_int].pack('U')

data/lib/fOOrth/monkey_patch/true.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+#Extensions to the \TrueClass class required by the fOOrth language system.
+class TrueClass
+
+  #Convert this object to a fOOrth boolean.
+  def to_foorth_b
+    self
+  end
+
+  #Convert this object to a form suitable for embedding in a source string.
+  #<br>Returns
+  #* An embeddable form of this object as a string.
+  def foorth_embed
+    'true'
+  end
+
+end

data/lib/fOOrth/version.rb

@@ -3,5 +3,5 @@
 #* version.rb - The version string for fOOrth.
 module XfOOrth
   #The version string for fOOrth.
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/rakefile.rb

@@ -45,12 +45,7 @@ end
 
 desc "Fire up an IRB session with fOOrth preloaded."
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require './lib/fOOrth'
-  puts "Starting an IRB console for fOOrth."
-  ARGV.clear
-  IRB.start
+  system "ruby irbt.rb local"
 end
 
 desc "Run an Interactive fOOrth Session."

data/tests/compiler/mode_tests.rb

@@ -42,4 +42,17 @@ class CompilerModeTester < Minitest::Test
     assert_raises(XfOOrth::XfOOrthError) { vm.unnest_mode("", ["{"]) }
   end
 
+  def test_vm_code_buffer
+    #Get the virtual machine.
+    vm = Thread.current[:vm]
+    vm.interpreter_reset
+    vm.compiler_reset
+
+    assert_raises(XfOOrth::XfOOrthError) { vm << "test" }
+    refute(vm.buffer_valid?)
+
+    vm.suspend_execute_mode("", "!")
+    assert(vm.buffer_valid?)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fOOrth
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.8
 description: An Object Oriented FORTHesque language gem.
 email: peter.c.camilleri@gmail.com
 executables:
@@ -193,6 +193,10 @@ files:
 - demo.rb
 - fOOrth.gemspec
 - fOOrth.reek
+- images/banner_1.png
+- images/banner_1.xcf
+- images/cute-brown-owl-288.png
+- images/cute-brown-owl.png
 - images/fOOrth_logo.png
 - integration/README.md
 - integration/_FILE_test.foorth
@@ -222,6 +226,7 @@ files:
 - integration/thread_lib_tests.rb
 - integration/time_lib_tests.rb
 - integration/vm_lib_tests.rb
+- irbt.rb
 - lib/fOOrth.rb
 - lib/fOOrth/compiler.rb
 - lib/fOOrth/compiler/context.rb
@@ -313,6 +318,7 @@ files:
 - lib/fOOrth/monkey_patch/object.rb
 - lib/fOOrth/monkey_patch/rational.rb
 - lib/fOOrth/monkey_patch/string.rb
+- lib/fOOrth/monkey_patch/true.rb
 - lib/fOOrth/symbol_map.rb
 - lib/fOOrth/version.rb
 - license.txt
@@ -363,5 +369,51 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: FNF == fOOrth is Not FORTH.
-test_files: []
+test_files:
+- integration/README.md
+- integration/_FILE_test.foorth
+- integration/array_lib_tests.rb
+- integration/class_lib_tests.rb
+- integration/clone_lib_tests.rb
+- integration/comparison_tests.rb
+- integration/compile_lib_tests.rb
+- integration/ctrl_struct_lib_tests.rb
+- integration/data_ref_lib_tests.rb
+- integration/exception_lib_tests.rb
+- integration/fiber_bundle_tests.rb
+- integration/hash_lib_tests.rb
+- integration/in_stream_test_1.txt
+- integration/load_test_one.foorth
+- integration/load_test_two.foorth
+- integration/numeric_lib_tests.rb
+- integration/object_lib_tests.rb
+- integration/procedure_lib_tests.rb
+- integration/queue_lib_tests.rb
+- integration/stack_lib_tests.rb
+- integration/standard_lib_tests.rb
+- integration/stdio_lib_tests.rb
+- integration/stream_lib_tests.rb
+- integration/string_lib_tests.rb
+- integration/support/foorth_testing.rb
+- integration/thread_lib_tests.rb
+- integration/time_lib_tests.rb
+- integration/vm_lib_tests.rb
+- tests/compiler/context_tests.rb
+- tests/compiler/file_source_test_one.txt
+- tests/compiler/file_source_test_three.txt
+- tests/compiler/file_source_test_two.txt
+- tests/compiler/file_source_tests.rb
+- tests/compiler/mode_tests.rb
+- tests/compiler/parser_tests.rb
+- tests/compiler/spec_tests.rb
+- tests/compiler/string_source_tests.rb
+- tests/core_tests.rb
+- tests/interpreter/data_stack_tests.rb
+- tests/monkey_patch/coerce_test.rb
+- tests/monkey_patch/complex_test.rb
+- tests/monkey_patch/numeric_test.rb
+- tests/monkey_patch/object_test.rb
+- tests/monkey_patch/rational_test.rb
+- tests/monkey_patch/string_test.rb
+- tests/symbol_map_tests.rb
 has_rdoc: