rlang 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f054ef2e82e78f558e0009be4172691837965fdde99c73cba4003754445d55c4
-  data.tar.gz: 5faf8f230a9f810b4db1219e8ecfcf6eab85c7bb253b5a6f691ae10070f5c601
+  metadata.gz: 2faf9d24b118829cdd2317c26e88bd720a97ccd04844469798640596284aad82
+  data.tar.gz: 2e1cd589da638a7711022e08a6f4c7070ce26e36c0dd7dcaef4520e404f12cc4
 SHA512:
-  metadata.gz: a945ad14f3a76f454fdab52def8d61916fe429fdc44acc5497d5d741bb96177849c01efbe304774e34f0ab2ec84fbc9927e3fd9dcf523233f0e31cdaabd73733
-  data.tar.gz: 5057fb8e68fcd98bb5d76993550cfbc4c06211ec8424261862545cba9905348db52d884049fd3d26c39f3e0df61127b65b9953abe14753d75523a6d6677fe648
+  metadata.gz: e050812a81279acc76f15e191d40510e575e4f0dd935883b3292a3a2ca14b497b82b0d0185feccc79b4250f8e510c73c4c44c788a904e3083c28a5f14a213920
+  data.tar.gz: c689cfb6e10ec680592629f7e4c71ec44d4abd1b4e8723284633676765d189e29d5c8dd3c81ee71bcfd02597173798550b87b9ec0a7d15623a7bc53c0493eeca

data/.gitignore

@@ -7,4 +7,6 @@
 /spec/reports/
 /tmp/
 # added for rlang
-*.gem
+*.gem
+*~
+.rake_tasks

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.3.1
+* Add ruby parser as runtime dependency in gemspec
+* DAta directive documented in Rlang manual
+
+## 0.3.0
+* First published release on rubygems.org

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    rlang (0.3.0)
+      parser
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    minitest (5.14.0)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rake (12.3.3)
+    rutie (0.0.4)
+    wasmer (0.3.0)
+      rutie (~> 0.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rlang!
+  wasmer (~> 0.3)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -1,8 +1,8 @@
 # Rlang : a (subset of) Ruby to WebAssembly compiler
 
-Rlang is meant to create fast and uncluttered [WebAssembly](https://webassembly.org) code from the comfort of the Ruby language.
+Rlang is meant to generate fast and uncluttered [WebAssembly](https://webassembly.org) code from the comfort of the Ruby language.
 
-Rlang actually two things: 1) a subset of the Ruby language and 2) a **compiler** transforming this Ruby subset in a valid, fully runnable and native WebAssembly module.
+Rlang is two things: 1) a subset of the Ruby language and 2) a **compiler** transforming this Ruby subset in a valid, fully runnable and native WebAssembly module.
 
 Rlang can be seen as a foundational language that can help you quickly develop and debug high performance WebAssembly modules. For the rationale behind the creation of Rlang see [below](#why-rlang).
 
@@ -10,7 +10,7 @@ What you'll find in the current version is a first implementation of Rlang. It w
 
 ## Dependencies
 
-* **WABT toolit**: the rlang compiler can generate both WebAssembly source code (WAT file) and WebAssembly bytecode (WASM file). To generate WASM bytecode the rlang compiler uses wat2wasm. This utility is part of the [WABT toolkit](https://github.com/WebAssembly/wabt)
+* **WABT toolkit**: the rlang compiler can generate both WebAssembly source code (WAT file) and WebAssembly bytecode (WASM file). To generate WASM bytecode the rlang compiler uses wat2wasm. This utility is part of the [WABT toolkit](https://github.com/WebAssembly/wabt)
 * **wasmer runtime** (optional): [Wasmer](https://wasmer.io/) is a fast WebAssembly runtime. You'll need it if you want to run the test suite from the source repo. You can also use it to run the compiled WASM code generated by the rlang compiler. You can get Wasmer at  [wasmer.io](https://wasmer.io/)
 
 
@@ -32,7 +32,9 @@ To check that the installation went well, run `rlang --help` and see if the help
 ## The Rlang language
 Ruby features supported by Rlang are detailed in the [Rlang Manual](https://github.com/ljulliar/rlang/blob/master/docs/RlangManual.md)
 
-You can also look at the rlang test suite in [test/rlang_test_files](https://github.com/ljulliar/rlang/blob/master/test/rlang_test_files/) to get a flavor of the subset of Ruby currently supported.
+You can look at the rlang test suite in [test/rlang_test_files](https://github.com/ljulliar/rlang/blob/master/test/rlang_test_files/) to get a flavor of the subset of Ruby currently supported.
+
+For a more involved example of Ruby code, I invite you to look at the [dynamic memory allocator](https://github.com/ljulliar/rlang/blob/master/lib/rlang/lib/malloc.rb) provided with the Rlang library.
 
 ## rlang compiler
 The Rlang compiler can be invoked through the `rlang` command. See the [Rlang Compiler Documentation](https://github.com/ljulliar/rlang/blob/master/docs/RlangCompiler.md) for more details about the command line options.

data/docs/RlangManual.md

@@ -21,6 +21,7 @@ Rlang provides:
 * Integers and booleans 
 * Constants
 * Global variables
+* Static Data
 * Control constructs (if, while, until, break, next,...)
 * Arithmetic, relational and logical operators
 * WebAssembly source code (WAT) inlining
@@ -290,6 +291,31 @@ class TestB
   end
 end
 ```
+## Static Data
+WebAssembly allows for the definition of static data stored the WebAssembly memory. Rlang provides the ability to both define the value of static data and reference this data in your Rlang code.
+
+You can define static data by using the **DAta** class. Note that the upper case **A** in DAta is not a typo. The Data (with lower case a) class cannot be used as it is already defined by Ruby.
+
+Let's see a few examples of how to define and reference static data:
+
+```ruby
+# Where to implant the data in memory
+# Here we start at address 2048 in memory
+DAta.address = 2048
+# a long (I32) integer (4 bytes in memory)
+DAta[:my_integer] = 16384
+# a null terminated string (13 bytes)
+DAta[:my_string] = "Hello World!\00"
+# Align to the next multiple of 4 in memory
+DAta.align(4)
+# a series of four I32 integers followed by a fifth
+# integer that points to the address of :my_first_string
+DAta[:my_series] = [1, 2, 3, 4, Data[:my_first_string]]
+```
+The last example shows how to reference an existing piece of static data using  `DAta[:label]` where `:label` is the label you used in the first place to define your data. Data reference can either be used in static data definition or anywhere in the Rlang code.
+
+Also note that data are implanted in memory in sequential order. In the example above `:my_integer` is stored at address 2048 to 2051 (4 bytes), `:my_string` goes from 2052 to 2064 (13 bytes). Without the `DAta.align(4)` directive the next integer from `:my_series` would use bytes 2065 to 2068. Here it will actually use bytes 2068 to 2071 and the 3 bytes at address 2065 to 2067 will actually be unused.
+
 
 ## Conditional statements
 Rlang supports the following Ruby conditional statements:

data/lib/rlang/parser/data.rb

@@ -62,7 +62,7 @@ module Rlang::Parser
       end
     end
 
-    def self.current_address=(address)
+    def self.address=(address)
       @@current_address = address
     end
 

data/lib/rlang/parser.rb

@@ -883,10 +883,10 @@ module Rlang::Parser
       # Special case : DAta initializers
       #
       # Example (setting DAta address)
-      # DAta.current_address = 0
+      # DAta.address = 0
       # ---------
       # (send
-      #   (const nil :DAta) :current_address=
+      #   (const nil :DAta) :address=
       #   (int 0))
       #
       # Example (setting DAta alignment)
@@ -950,10 +950,10 @@ module Rlang::Parser
 
       if recv_node.type == :const  && recv_node.children.last == :DAta
         case method_name
-        when :current_address=
+        when :address=
           value_node = node.children[2]
           raise "DAta address must be an integer" unless value_node.type == :int
-          DAta.current_address = value_node.children.last
+          DAta.address = value_node.children.last
         when :align
           value_node = node.children[2]
           raise "DAta alignment argument must be an integer" unless value_node.type == :int

data/lib/rlang/version.rb

@@ -1,3 +1,3 @@
 module Rlang
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/simul/classes/data.rb

@@ -65,7 +65,7 @@ class DAta
     end
   end
 
-  def self.current_address=(address)
+  def self.address=(address)
     @@current_address = address
   end
 

data/rlang.gemspec

@@ -31,8 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables   << "rlang"
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'parser'
+
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "wasmer", "~> 0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rlang
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Laurent Julliard
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -78,10 +92,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rake_tasks~"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile