basic101 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d0355e1988ae20d00a0a3253c149ed9d2180f7e
+  data.tar.gz: be79cbe45db13921b8dcddd8c6e8107ae76e77ef
+SHA512:
+  metadata.gz: 482e5fcaac1a1899df3ec190a5d9d9812cfad970871a29a291607a8335a526d7261943e0bda00782cf1a2472bf7ae4e85dbbcbe0898ec0a8bde1dc9112a03f54
+  data.tar.gz: 5a208126bb3501bc19f0a9bb51d2c62393d44ca9c8c628ff67f99e106877e0c1cf58ef0dd87178a706c65c216d875027dcbb774b1d8a7559f6167882203a3ec0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start

data/.yardopts

@@ -0,0 +1,7 @@
+-o doc-api
+--exclude '[~#]$'
+--readme README.md
+--files LICENSE.md
+--files Changelog.md
+--files doc/*.md
+lib/**/*.rb

data/Changelog.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'parslet'
+
+group :development do
+  gem 'jeweler'
+  gem 'rake'
+  gem 'redcarpet'
+  gem 'rspec'
+  gem 'simplecov', :require => false, :group => :test
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    blankslate (2.1.2.4)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    redcarpet (3.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  parslet
+  rake
+  redcarpet
+  rspec
+  simplecov
+  yard

data/LICENSE.md

@@ -0,0 +1,9 @@
+Copyright 2014 Wayne Conrad
+
+This software is distributed under the [MIT License](http://opensource.org/licenses/MIT):
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+# Basic101 [![Code Climate](https://codeclimate.com/github/wconrad/basic101.png)](https://codeclimate.com/github/wconrad/basic101) [![Build Status](https://travis-ci.org/wconrad/basic101.png)](https://travis-ci.org/wconrad/basic101)
+
+basic101 is a circa 1980 BASIC interpreter written in Ruby.  It
+supports a modified subset of Microsoft's BASIC-80 v. 5 and runs
+the games published in Basic Computer Games, Microcomputer
+Edition by David H. Ahl
+
+## Why?
+
+Compilers and interpreters are great fun.  I wanted to experiment with
+a modern parser, but needed a target language.  The target language of
+"something that properly runs the programs in [_Basic Computer Games,
+Microcomputer Edition_][2] is perfect because:
+
+* BASIC is a relatively simple language.
+
+* The book's programs are all for the same dialect of BASIC.
+
+* The book's programs are available in electronic form.
+
+* The book contains short transcripts of each program running.
+
+### What parser?
+
+This interpreter uses [Parslet][12], a Ruby library for [Parsing
+Expression Grammars][11] (PEG).  Parslet has several attractive
+properties:
+
+* Parse and transform rules are expressed in an internal DSL.  This
+  makes possible the dynamic generation of parse and transform rules.
+
+* It has an [elegant mechanism][14] for transforming the [parse
+  tree][17] into an [abstract syntax tree][13].
+
+## Installation
+
+    gem install basic101
+
+## How to use
+
+First, download a BASIC program such as one of those from [Classic
+Basic Games][9] or [Vintage BASIC's archive][8].  Then simply run the
+interpreter with the path of the program:
+
+    basic101 superstartrek.bas
+
+Most of these programs are included with this gem, in the directory:
+
+    test/integration/test/basic_computer_games
+
+A few of these programs have had minor changes to work with basic101.
+This is not unusual in the world of BASIC.  Because Microcomputer
+BASICs were not written to any single specification, they all vary in
+small details.  It was usual, in the day, to have to change a BASIC
+program to get it to run on the interpreter you were using.
+
+## License
+
+The basic101 interpreter is released under the [MIT
+License](LICENSE.md).
+
+The BASIC programs which originally appeared in [_Basic Computer
+Games, Microcomputer Edition_][2] are _not_ under the MIT license.
+They are included with the kind permission of David H. Ahl.  David
+makes these programs "available to people who want to reprint them,
+convert them to other languages or forms of Basic, or analyze the
+code."
+
+## Ruby Compatability
+
+basic101 requires Ruby 2.0 or greater.
+
+## OS Compatability
+
+basic101 was developed in Linux.  While it does not knowingly use any
+Unix-only features, it has not been tested under Windows.  I would be
+grateful for any reports of success or failure running basic101 under
+Windows (or any other operating system).
+
+## Development
+
+### Tests
+
+To run all tests:
+
+    rake test
+
+or just:
+
+    rake
+
+To run the rspec (unit) tests:
+
+    rake test:spec
+
+To run the integration tests:
+
+    rake test:integration
+
+The integration tests are driven by
+`tests/integration/integration_test.rb`.  During development, you
+often want to run just one test, not all of them; to do so, bypass the
+rake task and run `integration_test.rb` directly.
+
+To run only the _print_ test:
+
+    integration_test.rb print
+
+To run only the fast tests:
+
+    integration_test.rb fast
+
+If you change how the interpreter behaves, the tests will notice.  If
+you want the new behavior to become the expected behavior, then
+_train_ the test or tests that are affected.  _Training_ causes the
+current behavior to become the expected behavior in the future.  To
+train the _print_ test:
+
+    integration_test.rb -t print
+
+To train all tests:
+
+    integration_test.rb -t
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## References
+
+* [Basic Computer Games, Microcomputer Edition][2]
+* [Basic-80 Reference Manual, v. 5][1]
+* [Vintage BASIC][3] and its [source][10]
+* [Classic Basic Games][9]
+
+## Credits
+
+### David H. Ahl
+
+This program was inspired by [_Basic Computer Games, Microcomputer
+Edition_][2] by David H. Ahl.  David, Thank you for inspiring us to
+tinker, learn, and have fun with these wonderful machines.
+
+### Lyle Kopnicky
+
+Lyle Kopnicky wrote [Vintage BASIC][3], an open source BASIC written
+in Haskell.  Vintage BASIC is a valuable resource for any
+vintage-BASIC author, even if you don't know Haskell.  It is a good
+reference model when you are wondering how some ambiguous part of the
+language behaves.  Be sure to check out [the interpreter test][4] for
+examples in the form of "this program produces that output".  You
+don't have to know Haskell to understand them.
+
+[Vintage BASIC's archive][8] of programs for "Basic Computer Games" is
+similar to that of [Classic Basic Games][9], except that Lyle's
+archive has two additional programs:
+
+* [Civil War][7]
+* [Super Star Trek][5] and [its instructions][6]
+
+That's a lot of typing.  Thank you, Lyle.
+
+### Classic Basic Games
+
+Most of the programs from "Basic Computer Games" are available at
+[Classic Basic Games][9], a wonderful resource for aspiring
+interpreter writers.
+
+## Whoami
+
+Wayne Conrad <wconrad@yagni.com>
+
+[1]: https://archive.org/details/BASIC-80_MBASIC_Reference_Manual
+[2]: http://www.atariarchives.org/basicgames/index.php
+[3]: http://www.vintage-basic.net/index.html
+[4]: https://github.com/lylek/vintage-basic/blob/master/test/Language/VintageBasic/Interpreter_test.hs
+[5]: http://www.vintage-basic.net/bcg/superstartrek.bas
+[6]: http://www.vintage-basic.net/bcg/superstartrekins.bas
+[7]: http://www.vintage-basic.net/bcg/civilwar.bas
+[8]: http://www.vintage-basic.net/games.html
+[9]: http://www.classicbasicgames.org/
+[10]: https://github.com/lylek/vintage-basic
+[11]: http://en.wikipedia.org/wiki/Parsing_expression_grammar
+[12]: http://kschiess.github.io/parslet/
+[13]: http://en.wikipedia.org/wiki/Abstract_syntax_tree
+[14]: http://kschiess.github.io/parslet/transform.html
+[15]: http://en.wikipedia.org/wiki/Fortran#FORTRAN_66
+[16]: http://www.fh-jena.de/~kleine/history/languages/ansi-x3dot9-1966-Fortran66.pdf
+[17]: http://en.wikipedia.org/wiki/Parse_tree

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+$:.unshift(File.dirname(__FILE__) + '/lib')
+Dir['rake_tasks/**/*.rake'].sort.each { |path| load path }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/basic101

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../lib', __dir__)
+unless $LOAD_PATH.include?(lib_path)
+  $:.unshift lib_path
+end
+
+require 'basic101'
+
+Basic101::Main.new(ARGV).run

data/lib/basic101/abs_function.rb

@@ -0,0 +1,19 @@
+require_relative 'function'
+
+module Basic101
+
+  class AbsFunction < Function
+
+    def name
+      'ABS'
+    end
+
+    def call(runtime, args)
+      check_args args, [BasicNumeric]
+      value = args.first.eval(runtime)
+      value.abs
+    end
+
+  end
+
+end

data/lib/basic101/argument_checker.rb

@@ -0,0 +1,61 @@
+module Basic101
+
+  class ArgumentChecker
+
+    def initialize(args, required_types, optional_types)
+      @args = args
+      @required_types = required_types
+      @optional_types = optional_types
+    end
+
+    def check
+      check_count
+      check_types
+    end
+
+    private
+
+    def check_count
+      unless count_range.include?(@args.size)
+        message = "Wrong number of arguments "\
+        "(#{@args.size} instead of #{expected_count})"
+        raise InvalidArgumentError, message
+      end
+    end
+
+    def check_types
+      @args.zip(types[0..@args.size]).each do |arg, type|
+        unless arg.is_a?(type)
+          raise InvalidArgumentError,
+          "Expected #{type.type_name} but got #{arg.type_name}"
+        end
+      end
+    end
+
+    def expected_count
+      if min_count == max_count
+        min_count
+      else
+        count_range
+      end
+    end
+
+    def count_range
+      min_count..max_count
+    end
+
+    def min_count
+      @required_types.size
+    end
+
+    def max_count
+      types.size
+    end
+
+    def types
+      @required_types + @optional_types
+    end
+
+  end
+
+end

data/lib/basic101/arguments.rb

@@ -0,0 +1,32 @@
+module Basic101
+
+  class Arguments
+
+    attr_reader :filenames
+    attr_reader :randomize
+    attr_reader :transcript
+
+    def initialize(argv)
+      @transcript = false
+      @randomize = true
+      OptionParser.new do |opts|
+        opts.banner << " [PATH]..."
+        opts.on('-t', '--transcript',
+                'Write transcript of input and output') do |v|
+          @transcript = v
+        end
+        opts.on('--[no-]randomize',
+                'Randomize random number generator.',
+                'Default is --randomize') do |v|
+          @randomize = v
+        end
+      end.parse!(argv)
+      @filenames = argv.dup
+    rescue OptionParser::ParseError => e
+      $stderr.puts e
+      exit 1
+    end
+
+  end
+
+end

data/lib/basic101/array_reference.rb

@@ -0,0 +1,52 @@
+require_relative 'reference'
+
+module Basic101
+
+  class ArrayReference < Reference
+
+    def initialize(identifier, arguments)
+      super(identifier)
+      @arguments = arguments
+    end
+
+    def eval(runtime)
+      get_array(runtime).get(indices(runtime))
+    end
+
+    def assign(runtime, value)
+      get_array(runtime).set(indices(runtime), value)
+    end
+
+    def dimension_array(runtime)
+      get_array(runtime).dimension(indices(runtime))
+    end
+
+    protected
+
+    def state
+      super + [@arguments]
+    end
+
+    private
+
+    def get_array(runtime)
+      runtime.get_array(@identifier, num_dimensions)
+    end
+
+    def num_dimensions
+      @arguments.size
+    end
+
+    def indices(runtime)
+      argument_values(runtime).map(&:to_integer).map(&:to_i)
+    end
+
+    def argument_values(runtime)
+      @arguments.map do |argument|
+        argument.eval(runtime)
+      end
+    end
+
+  end
+
+end

data/lib/basic101/asc_function.rb

@@ -0,0 +1,17 @@
+module Basic101
+
+  class AscFunction < Function
+
+    def name
+      'ASC'
+    end
+
+    def call(runtime, args)
+      check_args args, [BasicString]
+      value = args.first.eval(runtime)
+      value.to_string.asc
+    end
+
+  end
+
+end

data/lib/basic101/basic_array.rb

@@ -0,0 +1,69 @@
+module Basic101
+
+  class BasicArray
+
+    def initialize(num_dimensions, default)
+      @default = default
+      dimension [10] * num_dimensions
+    end
+
+    def dimension(max_indices)
+      check_max_indices(max_indices)
+      @max_indices = max_indices
+      @array = make_array(max_indices)
+    end
+
+    def get(indices)
+      check_indices(indices)
+      array_get(@array, indices)
+    end
+
+    def set(indices, value)
+      check_indices(indices)
+      array_set(@array, value, indices)
+    end
+
+    private
+
+    def make_array(max_indices)
+      if max_indices.size == 0
+        @default
+      else
+        Array.new(max_indices.first + 1) do
+          make_array(max_indices[1..-1])
+        end
+      end
+    end
+
+    def array_get(a, indices)
+      if indices.size == 0
+        a
+      else
+        array_get(a[indices.first.to_i], indices[1..-1])
+      end
+    end
+
+    def array_set(a, value, indices)
+      if indices.size == 1
+        a[indices.first] = value
+      else
+        array_set(a[indices.first], value, indices[1..-1])
+      end
+    end
+
+    def check_max_indices(max_indices)
+      max_indices.each do |max_index|
+        raise ArraySizeError if max_index < 0
+      end
+    end
+
+    def check_indices(indices)
+      raise IndexError unless indices.size == @max_indices.size
+      indices.zip(@max_indices).each do |index, dimension|
+        raise IndexError unless (0..dimension).include?(index)
+      end
+    end
+
+  end
+
+end

data/lib/basic101/basic_comparisons.rb

@@ -0,0 +1,20 @@
+module Basic101
+
+  module BasicComparisons
+
+    def self.comparison_op(method, op)
+      define_method(method) do |other|
+        BasicInteger.from_bool(self.send(op, other))
+      end
+    end
+
+    comparison_op :lt, '<'
+    comparison_op :le, '<='
+    comparison_op :eq, '=='
+    comparison_op :ge, '>='
+    comparison_op :gt, '>'
+    comparison_op :ne, '!='
+
+  end
+
+end

data/lib/basic101/basic_float.rb

@@ -0,0 +1,48 @@
+require_relative 'basic_numeric'
+
+module Basic101
+
+  class BasicFloat < BasicNumeric
+
+    def self.from_s(s)
+      value = s.to_f
+      new(value)
+    end
+
+    def to_integer
+      BasicInteger.new(@value.to_i)
+    end
+
+    def to_float
+      self
+    end
+
+    def str
+      BasicString.new(@value.to_s)
+    end
+
+    def or(other)
+      to_integer.or(other)
+    end
+
+    def and(other)
+      to_integer.and(other)
+    end
+
+    def not
+      to_integer.not
+    end
+
+    def floor
+      BasicInteger.new(@value.floor)
+    end
+
+    private
+
+    def format
+      '%.7g' % @value
+    end
+
+  end
+
+end