hackasm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88236b6481cbcde7e39128b82bed0b1dcb0a7733a7b7030fa1a63cac5e4b912d
+  data.tar.gz: 3c5b745edb1599518666061cad5f102dc513ee43e03cfb2f7275bbe2a6086de7
+SHA512:
+  metadata.gz: 8d21a9765bfbb637bc0b894fc7de8d9e4f4ddbfb75fd47d334a45ec12d11483947f33a371ddaa7b53e2aee16e1299daa08494a8a445400b6406eebd119598138
+  data.tar.gz: 24f3c3c5a97ba0591b7775b1d687ff940c6c69046691f1a6be536c79c2c14e704570d3a4d8d1d2e10e22588fa130b51d2e976c3cb5f3c35d1df7bff4df84d1a8

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.txt
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 1.17.3

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 artur.martsinkovskyi@perfectial.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hackasm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: .
+  specs:
+    hackasm (0.1.0)
+      parslet (~> 2)
+      pastel (~> 0.7.2)
+      thor (~> 0.20.0)
+      tty-box (~> 0.4.1)
+      tty-color (~> 0.5)
+      tty-command (~> 0.9.0)
+      tty-config (~> 0.3.2)
+      tty-cursor (~> 0.7)
+      tty-editor (~> 0.5)
+      tty-file (~> 0.8.0)
+      tty-font (~> 0.4.0)
+      tty-logger (~> 0.2.0)
+      tty-markdown (~> 0.6.0)
+      tty-pager (~> 0.12)
+      tty-pie (~> 0.3.0)
+      tty-platform (~> 0.2)
+      tty-progressbar (~> 0.17)
+      tty-prompt (~> 0.19)
+      tty-screen (~> 0.7)
+      tty-spinner (~> 0.9)
+      tty-table (~> 0.11.0)
+      tty-tree (~> 0.3)
+      tty-which (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    equatable (0.6.1)
+    kramdown (1.16.2)
+    method_source (1.0.0)
+    necromancer (0.5.1)
+    parslet (2.0.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rouge (3.17.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    strings (0.1.8)
+      strings-ansi (~> 0.1)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.1.0)
+    thor (0.20.3)
+    tty-box (0.4.1)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.6)
+      tty-cursor (~> 0.7)
+    tty-color (0.5.1)
+    tty-command (0.9.0)
+      pastel (~> 0.7.0)
+    tty-config (0.3.2)
+    tty-cursor (0.7.1)
+    tty-editor (0.5.1)
+      tty-prompt (~> 0.19)
+      tty-which (~> 0.4)
+    tty-file (0.8.0)
+      diff-lcs (~> 1.3)
+      pastel (~> 0.7.2)
+      tty-prompt (~> 0.18)
+    tty-font (0.4.0)
+    tty-logger (0.2.0)
+      pastel (~> 0.7.0)
+    tty-markdown (0.6.0)
+      kramdown (~> 1.16.2)
+      pastel (~> 0.7.2)
+      rouge (~> 3.3)
+      strings (~> 0.1.4)
+      tty-color (~> 0.4)
+      tty-screen (~> 0.6)
+    tty-pager (0.12.1)
+      strings (~> 0.1.4)
+      tty-screen (~> 0.6)
+      tty-which (~> 0.4)
+    tty-pie (0.3.0)
+      pastel (~> 0.7.3)
+      tty-cursor (~> 0.7)
+    tty-platform (0.3.0)
+    tty-progressbar (0.17.0)
+      strings-ansi (~> 0.1.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      unicode-display_width (~> 1.6)
+    tty-prompt (0.21.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.11.0)
+      equatable (~> 0.6)
+      necromancer (~> 0.5)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.5)
+      tty-screen (~> 0.7)
+    tty-tree (0.4.0)
+    tty-which (0.4.2)
+    unicode-display_width (1.7.0)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  hackasm!
+  pry (~> 0.12)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,40 @@
+# Hackasm
+
+A Ruby-based compiler for the Hack platform developed in the scope of the NAND to Tetris course(parts [1](https://www.coursera.org/learn/nand2tetris) and [2](https://www.coursera.org/learn/nand2tetris2).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hackasm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hackasm
+
+## Usage
+
+This tool is a translator that is aimed to translate code from the higher level programming language in the stack of Hack platform to the lower one. 
+
+### `new` command
+
+Translate *.asm file of assembler commands to *.hack file of binary commands. This command matches the project 7 and 9 of NAND to Tetris.
+
+
+### `asm2binary`command
+
+Translate *.vm file with virtual machine code or a folder of *.vm files to the single *.asm file of assembler commands. This command matches the project 6 of NAND to Tetris.
+
+## Code of Conduct
+
+Everyone interacting in the Hackasm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/artur-martsinkovskyi/hackasm/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2020 Artur Martsinkovskyi. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hackasm"
+
+# 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

data/exe/hackasm

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'hackasm/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Hackasm::CLI.start
+rescue Hackasm::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/hackasm.gemspec

@@ -0,0 +1,64 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hackasm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hackasm"
+  spec.license       = "MIT"
+  spec.version       = Hackasm::VERSION
+  spec.authors       = ["Artur Martsinkovskyi"]
+  spec.email         = ["deimoss42@gmail.com"]
+
+  spec.summary       = %q{Assembler and vm code translator program for Hack assembler from course From NAND to Tetris.}
+  spec.homepage      = "https://github.com/artur-martsinkovskyi/hackasm"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage + "/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tty-box", "~> 0.4.1"
+  spec.add_dependency "tty-color", "~> 0.5"
+  spec.add_dependency "tty-command", "~> 0.9.0"
+  spec.add_dependency "tty-config", "~> 0.3.2"
+  spec.add_dependency "tty-cursor", "~> 0.7"
+  spec.add_dependency "tty-editor", "~> 0.5"
+  spec.add_dependency "tty-file", "~> 0.8.0"
+  spec.add_dependency "tty-font", "~> 0.4.0"
+  spec.add_dependency "tty-logger", "~> 0.2.0"
+  spec.add_dependency "tty-markdown", "~> 0.6.0"
+  spec.add_dependency "tty-pager", "~> 0.12"
+  spec.add_dependency "tty-pie", "~> 0.3.0"
+  spec.add_dependency "tty-platform", "~> 0.2"
+  spec.add_dependency "tty-progressbar", "~> 0.17"
+  spec.add_dependency "tty-prompt", "~> 0.19"
+  spec.add_dependency "tty-screen", "~> 0.7"
+  spec.add_dependency "tty-spinner", "~> 0.9"
+  spec.add_dependency "tty-table", "~> 0.11.0"
+  spec.add_dependency "tty-tree", "~> 0.3"
+  spec.add_dependency "tty-which", "~> 0.4"
+  spec.add_dependency "pastel", "~> 0.7.2"
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "parslet", "~> 2"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+end

data/lib/hackasm.rb

@@ -0,0 +1,6 @@
+require "hackasm/version"
+
+module Hackasm
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/hackasm/assembler/constants/dests.rb

@@ -0,0 +1 @@
+DESTS = %w[M D MD A AM AD AMD].freeze

data/lib/hackasm/assembler/constants/jumps.rb

@@ -0,0 +1 @@
+JUMPS = %w[JGT JEQ JGE JLT JNE JLE JMP].freeze

data/lib/hackasm/assembler/hack_parser.rb

@@ -0,0 +1,50 @@
+require 'parslet'
+require_relative './constants/jumps'
+require_relative './constants/dests'
+
+module Assembler
+  class HackParser < Parslet::Parser
+    COMMENT_DELIMITER = "//".freeze
+    ADDRESS_DELIMITER = "@".freeze
+    JUMP_DELIMITER = ";".freeze
+    DEST_DELIMITER = "=".freeze
+    root :lines
+
+    # UTIL
+
+    rule(:line)                { space? >> expression.maybe >> space? >> comment.maybe >> newline }
+    rule(:lines)               { line.repeat }
+
+    rule(:expression)          { address_instruction | jump_label | command_instruction }
+
+    rule(:comment)             { (str(COMMENT_DELIMITER) >> (newline.absent? >> any).repeat) }
+
+    rule(:space)               { match('[[:blank:]]').repeat(1) }
+    rule(:space?)              { space.maybe }
+    rule(:newline)             { str("\r").maybe >> str("\n") >> str("\r").maybe }
+
+    #A-INSTRUCTIONS
+
+    rule(:at)                  { match(ADDRESS_DELIMITER) }
+    rule(:memory_address)      { (match("0") | (match("[1-9]") >> match('[0-9]').repeat)).as(:memory_address) }
+    rule(:identifier)          { (match('[a-zA-Z_\-.$:]') >> match('[a-zA-Z_\-.$:0-9]').repeat(1)).as(:identifier) }
+
+    rule(:address_instruction) { (at >> (memory_address | identifier)).as(:address_instruction) }
+
+    # JUMP LABELS
+
+    rule(:jump_label)          { (str("(") >> identifier >> str(")")).as(:jump_label) }
+
+    # C-INSTRUCTIONS
+
+    rule(:dest)                { DESTS.map { |s| str(s).as(:dest) >> space? >> str(DEST_DELIMITER) }.inject(:|) }
+
+    rule(:comp_unary)          { match("[-!]").maybe >> match("[ADM]") }
+    rule(:comp_binary)         { match("[ADM]") >> space? >> match("[+&|-]") >> space? >> match("[1ADM]") }
+    rule(:comp)                { (str("0") | str("1") | str("-1") | comp_binary | comp_unary).as(:comp) }
+
+    rule(:jump)                { JUMPS.map { |s| str(s) }.inject(:|).as(:jump) }
+
+    rule(:command_instruction) {  ((dest).maybe >> space? >> comp >> space? >> (str(JUMP_DELIMITER) >> space? >> jump).maybe).as(:command_instruction) }
+  end
+end