ucisc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af46f976c69b0844dc290a6d7addb29f29b03077009152eaaca5a3ae4f800ef3
+  data.tar.gz: 1ab1c92750ff4f8de30e416b9cc53a8321e1dfb510fdf1e9f5ea6287fbd6c954
+SHA512:
+  metadata.gz: 2b04fde677c94ba3b1c97fe0ed6a255212c8f77a24e4652d7daa0eb8fa7438ce308b9efb2d3940054ca593ca5cf56fdbfe4da5c2a55841b5f76f8e3f3bdefe2f
+  data.tar.gz: 875fcca7db2a73fa62eb16611b5d262ecd0eecc816a3ee4141c81ad338f09eece592afab49bc0bd7d1e976eb3fbc8dfae7a4522da7ef263f647a5d6946239fe4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history
+*.swp
+*~
+
+# video system create screen.png, ignore it
+screen.png

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at robert at grokthiscommunity.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in micro_cisc.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "byebug"
+
+# Devices
+gem "tty-screen"
+
+# Gems for the graphics, going as lightweight, few dependencies as possible
+gem "gtk2"

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    ucisc (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    atk (3.4.1)
+      glib2 (= 3.4.1)
+    byebug (11.0.1)
+    cairo (1.16.5)
+      native-package-installer (>= 1.0.3)
+      pkg-config (>= 1.2.2)
+    cairo-gobject (3.4.1)
+      cairo (>= 1.16.2)
+      glib2 (= 3.4.1)
+    gdk_pixbuf2 (3.4.1)
+      gio2 (= 3.4.1)
+    gio2 (3.4.1)
+      gobject-introspection (= 3.4.1)
+    glib2 (3.4.1)
+      native-package-installer (>= 1.0.3)
+      pkg-config (>= 1.3.5)
+    gobject-introspection (3.4.1)
+      glib2 (= 3.4.1)
+    gtk2 (3.4.1)
+      atk (= 3.4.1)
+      gdk_pixbuf2 (= 3.4.1)
+      pango (= 3.4.1)
+    minitest (5.14.0)
+    native-package-installer (1.0.9)
+    pango (3.4.1)
+      cairo-gobject (= 3.4.1)
+      gobject-introspection (= 3.4.1)
+    pkg-config (1.4.1)
+    rake (12.3.3)
+    tty-screen (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  gtk2
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  tty-screen
+  ucisc!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Robert Butler
+
+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,217 @@
+# MicroCisc
+
+Sketch Emulator/VM implementation for https://github.com/grokthis/ucisc
+
+## Installation
+
+Prerequisites: Bundler 2
+
+```
+$ git clone https://github.com/grokthis/ucisc-ruby
+$ cd ucisc-ruby
+$ bundle install
+```
+
+Eventually, once the gem stabilizes a bit, I will host it on
+rubygems. I don't want to do that until the code stabilizes a
+bit and a release cadence doesn't get in the way. In the mean
+time, you can install the gem locally by doing:
+
+```
+bundle exec rake install
+```
+
+This will let you simply run `ucisc` as a command assuming your
+path is setup to load gem binaries.
+
+This gem is only ever intended to be a prototype compiler and
+VM. It's useful to get uCISC code running anywhere ruby can run
+but ultimately the goal is to get it self bootstrapping. It will
+always need a VM of sorts as the instruction set is fundamentally
+different from x86, ARM or others, but I intend to write a better
+performing VM in SubX or Mu. That said, this project will likely
+be around a while.
+
+## Usage
+
+The `ucisc` command combines the compilation and VM execution.
+
+```
+# Run the factorial example
+$ exe/ucisc examples/fib.ucisc
+```
+
+You will get 3 outputs:
+1. Line numbered output with instructions encoded (label values are all 0)
+2. Final instruction output with address numbers and final label substitutions
+3. Instruction by instruction execution details, including the result "value"
+
+This code:
+
+```
+...
+13: Entry:
+14:   # Initialize the stack register to 0x0000, decrement on push will change to 0xFFFF
+15:   0/load 0xFFFF to sp/               4.val 0.imm 1.reg
+16:
+17:   (1.mem fib 4.val 8.imm)
+...
+```
+Gets translated into these instructions:
+
+```
+13: Entry
+15: 0x7600  0/load 0xFFFF to sp/               4.val 0.imm 1.reg
+17: 0x6443  0 0.reg 3.imm 1.mem 1.push #   (1.mem fib 4.val 8.imm)
+17: 0x6648  0 4.val 8.imm 1.mem 1.push #   (1.mem fib 4.val 8.imm)
+17: 0x6000  0 0.reg fib.disp 0.reg #   (1.mem fib 4.val 8.imm)
+...
+```
+
+Note: as you can see in the example above, the function call
+gets added to each generated push and call command it generates.
+
+This is the preliminary compile step and you can see the line
+number, compiled instruction in hex and the original line.
+Comment lines and blank lines are ignored. Any labels evaluate
+to 0x0000 at this stage. See line 22 above for example.
+
+After line numbers, the second pass produces the binary output
+after subtituting the label offset calculations. You get
+something like this:
+
+```
+0: 0x763F  0/load 0xFFFF to sp/    4.val -1.imm 5.reg
+2: 0x6443  0 0.reg 6.imm 1.mem 1.inc 3.eff #   (1.mem fib 4.val 8.imm)
+4: 0x6648  0 4.val 8.imm 1.mem 1.inc 3.eff #   (1.mem fib 4.val 8.imm)
+6: 0x6002  0 0.reg fib.disp 0.reg 0.inc 3.eff #   (1.mem fib 4.val 8.imm)
+...
+```
+
+The line numbers are now the hex memory address of the
+instruction followed by the final hex instruction code and the
+original statement that produced it.
+
+The vm will then execute the code. Any instruction that sets
+the PC address to 0x0000 will cause the VM to break execution
+and give you a prompt.
+
+```
+Running program with 60 bytes
+Starting program... (enter to continue)
+0000 0x0 4.val 0x0 1.reg 3.eff 0.push # value: 0, stored > _
+```
+You can see the compiled program is 60 bytes total including any
+data and instructions encoded. The program is loaded and ready to
+execute at this point. The last line shows the instruction that is
+about to be executed. Press [enter] to continue and run the
+program to completion.
+
+```
+Breaking on jump to 0x0000...
+Finished 929 instructions in 0.001835s
+0000 0x0 4.val 0x0 1.reg 3.eff 0.push # value: 0, stored > _
+```
+When the program jumps to address 0x0000, the program pauses. In
+this case, 929 instructions were executed in 0.001835s. Performance
+will depend on your ruby version, computer performance and program.
+I've seen up to 6x the performance of the 8-bit computers of the
+early 80's when running on modern CPU's, so that gives you an idea
+of what types of algorithms you can run.
+
+At the prompt, you can do the following:
+
+* Type "exit" - exits the VM
+* Type "break" - opens the ruby debugger. You can inspect the
+  memory and registers from here if desired.
+* "next", "n" - Turn debug mode on and step to the next instruction.
+* "continue", "c" - Turn debug mode off and continue execution
+* Simply hit "enter" and the execution will continue. If in debug
+  mode, it will execute the instruction and move to the next. If
+  not debugging it will continue running until the next jump 0x0000.
+
+When in the ruby debugger, you can do the following to look at
+the stack value:
+
+```
+# Load a value from memory; returns 16-bit word
+# Returns nil if the address is out of memory bounds
+load(address)
+
+# Look at the contents of a register; number is 1-3
+# Returns 16-bit register value
+register(number)
+
+# PC contents
+pc
+
+# Flags register
+flags
+
+# Values are show in decimal, conver to hex with:
+pc.to_s(16).upcase
+
+# To continue execution (any byebug commands are available)
+# https://github.com/deivid-rodriguez/byebug
+continue
+
+# Combine as needed
+# Look at the stack: load the address in r1
+load(register(1)).to_s(16).upcase
+```
+
+## Debugging
+
+You can debug your code by doing the following:
+
+```
+# Debug the factorial example
+$ exe/ucisc examples/factorial.ucisc -d
+```
+
+Instead of simply executing all the code, the debugger will
+pause after each instruction:
+
+```
+0000 0x0 4.val 0x0 1.reg 3.eff 0.push # value: 0, stored >
+0001 0x0 0.reg 0x3 1.mem 3.eff 1.push # value: 4, stored >
+0002 0x0 4.val 0x8 1.mem 3.eff 1.push # value: 8, stored >
+0003 0x0 0.reg 0x2 0.reg 3.eff 0.push # value: 5, stored >
+0005 0x202 1.mem 1.mem 0.inc 1.sign 3.eff # arg1: 8, arg2: 8, result 8, not stored >
+0006 0x0 0.reg 0x2 0.reg 1.eff 0.push # value: 8, stored >
+0008 0x0 4.val 0x1 2.reg 3.eff 0.push # value: 1, stored >
+0009 0x20c 2.reg 1.mem 0.inc 1.sign 3.eff # arg1: 1, arg2: 8, result 7, not stored >
+000a 0x0 0.reg 0x2 0.reg 1.eff 0.push # value: 12, stored >
+000c 0x0 1.mem 0x0 1.mem 3.eff 1.push # value: 8, stored > _
+```
+
+Notice the prompt after each instruction. The same break, exit
+or "enter" options are available as described above. The output
+at each line is the uCISC equivalent of what was executed.
+After the comment, the value result and whether or not the value
+was stored is indicated. ALU instructions also include both args
+in the comment.
+
+Note the 4-digit hex address to the left. That is the address
+of the instruction that was executed and will match the compiled
+output (assuming your code doesn't overwrite itself or load code
+to other memory locations).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/grokthis/micro_cisc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/grokthis/micro_cisc/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MicroCisc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/grokthis/micro_cisc/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "micro_cisc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here