Compare commits
14
Commits
140b2d8350
..
v1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
af5edaa762 | ||
|
|
81f15245f2 | ||
|
|
d8aa72d516 | ||
|
|
aabc8a5af5 | ||
|
|
705e5d8ba9 | ||
|
|
f152cd9da1 | ||
|
|
9a9315f7f9 | ||
|
|
197f126109 | ||
|
|
db6dc0e099 | ||
|
|
547dbd3850 | ||
|
|
aff0102536 | ||
|
|
1328a718ac | ||
|
|
562c24ce9e | ||
|
|
c824ae9e5c |
No files matched your search
@@ -5,3 +5,4 @@ gem "rspec"
|
||||
gem "rdoc"
|
||||
gem "redcarpet"
|
||||
gem "syntax"
|
||||
gem "simplecov"
|
||||
@@ -2,6 +2,7 @@ GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
diff-lcs (1.5.0)
|
||||
docile (1.4.0)
|
||||
psych (5.1.0)
|
||||
stringio
|
||||
rake (13.0.6)
|
||||
@@ -21,6 +22,12 @@ GEM
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.12.0)
|
||||
rspec-support (3.12.1)
|
||||
simplecov (0.22.0)
|
||||
docile (~> 1.1)
|
||||
simplecov-html (~> 0.11)
|
||||
simplecov_json_formatter (~> 0.1)
|
||||
simplecov-html (0.12.3)
|
||||
simplecov_json_formatter (0.1.4)
|
||||
stringio (3.0.7)
|
||||
syntax (1.2.2)
|
||||
|
||||
@@ -32,6 +39,7 @@ DEPENDENCIES
|
||||
rdoc
|
||||
redcarpet
|
||||
rspec
|
||||
simplecov
|
||||
syntax
|
||||
|
||||
BUNDLED WITH
|
||||
|
||||
@@ -1,21 +1,113 @@
|
||||
# The Propane Parser Generator
|
||||
|
||||
Propane is an LR Parser Generator (LPG) which:
|
||||
Propane is a LALR Parser Generator (LPG) which:
|
||||
|
||||
* accepts LR(0), SLR, and LALR grammars
|
||||
* generates a built-in lexer to tokenize input
|
||||
* supports UTF-8 lexer inputs
|
||||
* generates a table-driven parser to parse input in linear time
|
||||
* generates a table-driven shift/reduce parser to parse input in linear time
|
||||
* target C or D language outputs
|
||||
* is MIT-licensed
|
||||
* is distributable as a standalone Ruby script
|
||||
|
||||
## Installation
|
||||
|
||||
TODO
|
||||
Propane is designed to be distributed as a stand-alone single file script that
|
||||
can be copied into and versioned in a project's source tree.
|
||||
The only requirement to run Propane is that the system has a Ruby interpreter
|
||||
installed.
|
||||
The latest release can be downloaded from [https://github.com/holtrop/propane/releases](https://github.com/holtrop/propane/releases).
|
||||
Simply copy the `propane` executable script into the desired location within
|
||||
the project to be built (typically the root of the repository) and mark it
|
||||
executable.
|
||||
|
||||
## Usage
|
||||
|
||||
TODO: Write usage instructions here
|
||||
### Command Line Interface
|
||||
|
||||
Propane is typically invoked from the command-line as `./propane`.
|
||||
|
||||
Usage: ./propane [options] <input-file> <output-file>
|
||||
Options:
|
||||
--log LOG Write log file
|
||||
--version Show program version and exit
|
||||
-h, --help Show this usage and exit
|
||||
|
||||
The user must specify the path to a Propane input grammar file and a path to an
|
||||
output file.
|
||||
The generated source code will be written to the output file.
|
||||
If a log file path is specified, Propane will write a log file containing
|
||||
detailed information about the parser states and transitions.
|
||||
|
||||
### Propane Grammar File
|
||||
|
||||
A Propane grammar file provides Propane with the patterns, tokens, grammar
|
||||
rules, and user code blocks from which to build the generated lexer and parser.
|
||||
|
||||
Example grammar file:
|
||||
|
||||
```
|
||||
<<
|
||||
import std.math;
|
||||
>>
|
||||
|
||||
# Parser values are unsigned integers.
|
||||
ptype ulong;
|
||||
|
||||
# A few basic arithmetic operators.
|
||||
token plus /\\+/;
|
||||
token times /\\*/;
|
||||
token power /\\*\\*/;
|
||||
token integer /\\d+/ <<
|
||||
ulong v;
|
||||
foreach (c; match)
|
||||
{
|
||||
v *= 10;
|
||||
v += (c - '0');
|
||||
}
|
||||
$$ = v;
|
||||
>>
|
||||
token lparen /\\(/;
|
||||
token rparen /\\)/;
|
||||
# Drop whitespace.
|
||||
drop /\\s+/;
|
||||
|
||||
Start -> E1 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E1 -> E2 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E1 -> E1 plus E2 <<
|
||||
$$ = $1 + $3;
|
||||
>>
|
||||
E2 -> E3 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E2 -> E2 times E3 <<
|
||||
$$ = $1 * $3;
|
||||
>>
|
||||
E3 -> E4 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E3 -> E3 power E4 <<
|
||||
$$ = pow($1, $3);
|
||||
>>
|
||||
E4 -> integer <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E4 -> lparen E1 rparen <<
|
||||
$$ = $2;
|
||||
>>
|
||||
```
|
||||
|
||||
Grammar files can contain comment lines beginning with `#` which are ignored.
|
||||
White space in the grammar file is also ignored.
|
||||
|
||||
It is convention to use the extension `.propane` for the Propane grammar file,
|
||||
however any file name is accepted by Propane.
|
||||
|
||||
See [https://holtrop.github.io/propane/index.html](https://holtrop.github.io/propane/index.html) for the full User Guide.
|
||||
|
||||
## Development
|
||||
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
require "rake/clean"
|
||||
require "rspec/core/rake_task"
|
||||
|
||||
CLEAN.include %w[spec/run gen .yardoc yard coverage dist]
|
||||
|
||||
task :build_dist do
|
||||
sh "ruby rb/build_dist.rb"
|
||||
end
|
||||
@@ -10,9 +13,20 @@ RSpec::Core::RakeTask.new(:spec, :example_pattern) do |task, args|
|
||||
end
|
||||
end
|
||||
|
||||
# dspec task is useful to test the distributable release script, but is not
|
||||
# useful for coverage information.
|
||||
desc "Dist Specs"
|
||||
task :dspec, [:example_string] => :build_dist do |task, args|
|
||||
ENV["dist_specs"] = "1"
|
||||
Rake::Task["spec"].execute(args)
|
||||
ENV.delete("dist_specs")
|
||||
end
|
||||
|
||||
task :default => :spec
|
||||
|
||||
desc "Build user guide"
|
||||
task :user_guide do
|
||||
system("ruby", "-Ilib", "rb/gen_user_guide.rb")
|
||||
end
|
||||
|
||||
task :all => [:spec, :dspec, :user_guide]
|
||||
+395
-7
@@ -7,12 +7,12 @@ ${/remove}
|
||||
|
||||
#> Overview
|
||||
|
||||
Propane is an LR Parser Generator (LPG) which:
|
||||
Propane is a LALR Parser Generator (LPG) which:
|
||||
|
||||
* accepts LR(0), SLR, and LALR grammars
|
||||
* generates a built-in lexer to tokenize input
|
||||
* supports UTF-8 lexer inputs
|
||||
* generates a table-driven parser to parse input in linear time
|
||||
* generates a table-driven shift/reduce parser to parse input in linear time
|
||||
* target C or D language outputs
|
||||
* is MIT-licensed
|
||||
* is distributable as a standalone Ruby script
|
||||
@@ -56,8 +56,10 @@ Example grammar file:
|
||||
import std.math;
|
||||
>>
|
||||
|
||||
# Parser values are unsigned integers.
|
||||
ptype ulong;
|
||||
|
||||
# A few basic arithmetic operators.
|
||||
token plus /\\+/;
|
||||
token times /\\*/;
|
||||
token power /\\*\\*/;
|
||||
@@ -72,6 +74,7 @@ token integer /\\d+/ <<
|
||||
>>
|
||||
token lparen /\\(/;
|
||||
token rparen /\\)/;
|
||||
# Drop whitespace.
|
||||
drop /\\s+/;
|
||||
|
||||
Start -> E1 <<
|
||||
@@ -103,6 +106,15 @@ E4 -> lparen E1 rparen <<
|
||||
>>
|
||||
```
|
||||
|
||||
Grammar files can contain comment lines beginning with `#` which are ignored.
|
||||
White space in the grammar file is also ignored.
|
||||
|
||||
It is convention to use the extension `.propane` for the Propane grammar file,
|
||||
however any file name is accepted by Propane.
|
||||
|
||||
This user guide follows the convention of beginning a token name with a
|
||||
lowercase character and beginning a rule name with an uppercase character.
|
||||
|
||||
##> User Code Blocks
|
||||
|
||||
User code blocks begin with the line following a "<<" token and end with the
|
||||
@@ -114,7 +126,9 @@ All text lines in the code block are copied verbatim into the output file.
|
||||
C example:
|
||||
|
||||
```
|
||||
#include <stdio.h>
|
||||
<<
|
||||
#include <stdio.h>
|
||||
>>
|
||||
```
|
||||
|
||||
D example:
|
||||
@@ -139,9 +153,11 @@ the generated implementation file.
|
||||
This allows including another header that may be necessary to define any types
|
||||
needed by a `ptype` directive, for example:
|
||||
|
||||
<<header
|
||||
#include "mytypes.h"
|
||||
>>
|
||||
```
|
||||
<<header
|
||||
#include "mytypes.h"
|
||||
>>
|
||||
```
|
||||
|
||||
### Lexer pattern code blocks
|
||||
|
||||
@@ -161,7 +177,7 @@ token integer /\\d+/ <<
|
||||
>>
|
||||
```
|
||||
|
||||
Lexer code blocks appear following a `token` or `pattern` expression.
|
||||
Lexer code blocks appear following a `token` or pattern expression.
|
||||
User code in a lexer code block will be executed when the lexer matches the
|
||||
given pattern.
|
||||
Assignment to the `$$` symbol will associate a parser value with the lexed
|
||||
@@ -186,6 +202,378 @@ rule.
|
||||
Parser values for the rules or tokens in the rule pattern can be accessed
|
||||
positionally with tokens `$1`, `$2`, `$3`, etc...
|
||||
|
||||
##> Specifying tokens - the `token` statement
|
||||
|
||||
The `token` statement allows defining a lexer token and a pattern to match that
|
||||
token.
|
||||
The name of the token must be specified immediately following the `token`
|
||||
keyword.
|
||||
A regular expression pattern may optionally follow the token name.
|
||||
If a regular expression pattern is not specified, the name of the token is
|
||||
taken to be the pattern.
|
||||
See also: ${#Regular expression syntax}.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
token for;
|
||||
```
|
||||
|
||||
In this example, the token name is `for` and the pattern to match it is
|
||||
`/for/`.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
token lbrace /\{/;
|
||||
```
|
||||
|
||||
In this example, the token name is `lbrace` and a single left curly brace will
|
||||
match it.
|
||||
|
||||
The `token` statement can also include a user code block.
|
||||
The user code block will be executed whenever the token is matched by the
|
||||
lexer.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
token if <<
|
||||
writeln("'if' keyword lexed");
|
||||
>>
|
||||
```
|
||||
|
||||
The `token` statement is actually a shortcut statement for a combination of a
|
||||
`tokenid` statement and a pattern statement.
|
||||
To define a lexer token without an associated pattern to match it, use a
|
||||
`tokenid` statement.
|
||||
To define a lexer pattern that may or may not result in a matched token, use
|
||||
a pattern statement.
|
||||
|
||||
##> Defining tokens without a matching pattern - the `tokenid` statement
|
||||
|
||||
The `tokenid` statement can be used to define a token without associating it
|
||||
with a lexer pattern that matches it.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
tokenid string;
|
||||
```
|
||||
|
||||
The `tokenid` statement can be useful when defining a token that may optionally
|
||||
be returned by user code associated with a pattern.
|
||||
|
||||
It is also useful when lexer modes and multiple lexer patterns are required to
|
||||
build up a full token.
|
||||
A common example is parsing a string.
|
||||
See the ${#Lexer modes} chapter for more information.
|
||||
|
||||
##> Specifying a lexer pattern - the pattern statement
|
||||
|
||||
A pattern statement is used to define a lexer pattern that can execute user
|
||||
code but may not result in a matched token.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
/foo+/ <<
|
||||
writeln("saw a foo pattern");
|
||||
>>
|
||||
```
|
||||
|
||||
This can be especially useful with ${#Lexer modes}.
|
||||
|
||||
See also ${#Regular expression syntax}.
|
||||
|
||||
##> Ignoring input sections - the `drop` statement
|
||||
|
||||
A `drop` statement can be used to specify a lexer pattern that when matched
|
||||
should result in the matched input being dropped and lexing continuing after
|
||||
the matched input.
|
||||
|
||||
A common use for a `drop` statement would be to ignore whitespace sequences in
|
||||
the user input.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
drop /\s+/;
|
||||
```
|
||||
|
||||
See also ${#Regular expression syntax}.
|
||||
|
||||
##> Regular expression syntax
|
||||
|
||||
A regular expression ("regex") is used to define lexer patterns in `token`,
|
||||
pattern, and `drop` statements.
|
||||
A regular expression begins and ends with a `/` character.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
/#.*$/
|
||||
```
|
||||
|
||||
Regular expressions can include many special characters:
|
||||
|
||||
* The `.` character matches any input character other than a newline.
|
||||
* The `*` character matches any number of the previous regex element.
|
||||
* The `+` character matches one or more of the previous regex element.
|
||||
* The `?` character matches 0 or 1 of the previous regex element.
|
||||
* The `[` character begins a character class.
|
||||
* The `(` character begins a matching group.
|
||||
* The `{` character begins a count qualifier.
|
||||
* The `\` character escapes the following character and changes its meaning:
|
||||
* The `\d` sequence matches any character `0` through `9`.
|
||||
* The `\s` sequence matches a space, horizontal tab `\t`, carriage return
|
||||
`\r`, a form feed `\f`, or a vertical tab `\v` character.
|
||||
* Any other character matches itself.
|
||||
* The `|` character creates an alternate match.
|
||||
|
||||
Any other character just matches itself in the input stream.
|
||||
|
||||
A character class consists of a list of character alternates or character
|
||||
ranges that can be matched by the character class.
|
||||
For example `[a-zA-Z_]` matches any lowercase character between `a` and `z` or
|
||||
any uppercase character between `A` and `Z` or the underscore `_` character.
|
||||
Character classes can also be negative character classes if the first character
|
||||
after the `[` is a `^` character.
|
||||
In this case, the set of characters matched by the character class is the
|
||||
inverse of what it otherwise would have been.
|
||||
For example, `[^0-9]` matches any character other than 0 through 9.
|
||||
|
||||
A matching group can be used to override the pattern sequence that multiplicity
|
||||
specifiers apply to.
|
||||
For example, the pattern `/foo+/` matches "foo" or "foooo", while the pattern
|
||||
`/(foo)+/` matches "foo" or "foofoofoo", but not "foooo".
|
||||
|
||||
A count qualifier in curly braces can be used to restrict the number of matches
|
||||
of the preceding atom to an explicit minimum and maximum range.
|
||||
For example, the pattern `\d{3}` matches exactly 3 digits 0-9.
|
||||
Both a minimum and maximum multiplicity count can be specified and separated by
|
||||
a comma.
|
||||
For example, `/a{1,5}/` matches between 1 and 5 `a` characters.
|
||||
Either the minimum or maximum count can be omitted to omit the corresponding
|
||||
restriction in the number of matches allowed.
|
||||
|
||||
An alternate match is created with the `|` character.
|
||||
For example, the pattern `/foo|bar/` matches either the sequence "foo" or the
|
||||
sequence "bar".
|
||||
|
||||
##> Lexer modes
|
||||
|
||||
Lexer modes can be used to change the set of patterns that are matched by the
|
||||
lexer.
|
||||
A common use for lexer modes is to match strings.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
<<
|
||||
string mystringvalue;
|
||||
>>
|
||||
|
||||
tokenid str;
|
||||
|
||||
# String processing
|
||||
/"/ <<
|
||||
mystringvalue = "";
|
||||
$mode(string);
|
||||
>>
|
||||
string: /[^"]+/ <<
|
||||
mystringvalue += match;
|
||||
>>
|
||||
string: /"/ <<
|
||||
$mode(default);
|
||||
return $token(str);
|
||||
>>
|
||||
```
|
||||
|
||||
A lexer mode is defined by placing the name before a colon (`:`) character that
|
||||
precedes a token or pattern statement.
|
||||
The token or pattern statement is restricted to only applying if the named mode
|
||||
is active.
|
||||
|
||||
By default, the active lexer mode is named `default`.
|
||||
A `$mode()` call within a lexer code block can be used to change lexer modes.
|
||||
|
||||
In the above example, when the lexer in the default mode sees a doublequote
|
||||
(`"`) character, the lexer code block will clear the `mystringvalue` variable
|
||||
and will set the lexer mode to `string`.
|
||||
When the lexer begins looking for patterns to match against the input, it will
|
||||
now look only for patterns tagged for the `string` lexer mode.
|
||||
Any non-`"` character will be appended to the `mystringvalue` string.
|
||||
A `"` character will end the `string` lexer mode and return to the `default`
|
||||
lexer mode.
|
||||
It also returns the `str` token now that the token is complete.
|
||||
|
||||
Note that the token name `str` above could have been `string` instead - the
|
||||
namespace for token names is distinct from the namespace for lexer modes.
|
||||
|
||||
##> Specifying parser value types - the `ptype` statement
|
||||
|
||||
The `ptype` statement is used to define parser value type(s).
|
||||
Example:
|
||||
|
||||
```
|
||||
ptype void *;
|
||||
```
|
||||
|
||||
This defines the default parser value type to be `void *` (this is, in fact,
|
||||
the default parser value type if the grammar file does not specify otherwise).
|
||||
|
||||
Each defined lexer token type and parser rule has an associated parser value
|
||||
type.
|
||||
When the lexer runs, each lexed token has a parser value associated with it.
|
||||
When the parser runs, each instance of a reduced rule has a parser value
|
||||
associated with it.
|
||||
Propane supports using different parser value types for different rules and
|
||||
token types.
|
||||
The example `ptype` statement above defines the default parser value type.
|
||||
A parser value type name can optionally be specified following the `ptype`
|
||||
keyword.
|
||||
For example:
|
||||
|
||||
```
|
||||
ptype Value;
|
||||
ptype array = Value[];
|
||||
ptype dict = Value[string];
|
||||
|
||||
Object -> lbrace rbrace <<
|
||||
$$ = new Value();
|
||||
>>
|
||||
|
||||
Values (array) -> Value <<
|
||||
$$ = [$1];
|
||||
>>
|
||||
Values -> Values comma Value <<
|
||||
$$ = $1 ~ [$3];
|
||||
>>
|
||||
|
||||
KeyValue (dict) -> string colon Value <<
|
||||
$$ = [$1: $3];
|
||||
>>
|
||||
```
|
||||
|
||||
In this example, the default parser value type is `Value`.
|
||||
A parser value type named `array` is defined to mean `Value[]`.
|
||||
A parser value type named `dict` is defined to mean `Value[string]`.
|
||||
Any defined tokens or rules that do not specify a parser value type will have
|
||||
the default parser value type associated with them.
|
||||
To associate a different parser value type with a token or rule, write the
|
||||
parser value type name in parentheses following the name of the token or rule.
|
||||
In this example:
|
||||
|
||||
* a reduced `Object`'s parser value has a type of `Value`.
|
||||
* a reduced `Values`'s parser value has a type of `Value[]`.
|
||||
* a reduced `KeyValue`'s parser value has a type of `Value[string]`.
|
||||
|
||||
##> Specifying a parser rule - the rule statement
|
||||
|
||||
Rule statements create parser rules which define the grammar that will be
|
||||
parsed by the generated parser.
|
||||
|
||||
Multiple rules with the same name can be specified.
|
||||
Rules with the same name define a rule set for that name and act as
|
||||
alternatives that the parser can accept when attempting to match a reference to
|
||||
that rule.
|
||||
|
||||
The grammar file must define a rule with the name `Start` which will be used as
|
||||
the top-level starting rule that the parser attempts to reduce.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
ptype ulong;
|
||||
token word /[a-z]+/ <<
|
||||
$$ = match.length;
|
||||
>>
|
||||
Start -> word <<
|
||||
$$ = $1;
|
||||
>>
|
||||
```
|
||||
|
||||
In the above example the `Start` rule is defined to match a single `word`
|
||||
token.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
Start -> E1 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E1 -> E2 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E1 -> E1 plus E2 <<
|
||||
$$ = $1 + $3;
|
||||
>>
|
||||
E2 -> E3 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E2 -> E2 times E3 <<
|
||||
$$ = $1 * $3;
|
||||
>>
|
||||
E3 -> E4 <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E3 -> E3 power E4 <<
|
||||
$$ = pow($1, $3);
|
||||
>>
|
||||
E4 -> integer <<
|
||||
$$ = $1;
|
||||
>>
|
||||
E4 -> lparen E1 rparen <<
|
||||
$$ = $2;
|
||||
>>
|
||||
```
|
||||
|
||||
A parser rule has zero or more terms on the right side of its definition.
|
||||
Each of these terms is either a token name or a rule name.
|
||||
|
||||
In a parser rule code block, parser values for the right side terms are
|
||||
accessible as `$1` for the first term's parser value, `$2` for the second
|
||||
term's parser value, etc...
|
||||
The `$$` symbol accesses the output parser value for this rule.
|
||||
The above examples demonstrate how the parser values for the rule components
|
||||
can be used to produce the parser value for the accepted rule.
|
||||
|
||||
##> Specifying the parser module name - the `module` statement
|
||||
|
||||
The `module` statement can be used to specify the module name for a generated
|
||||
D module.
|
||||
|
||||
```
|
||||
module proj.parser;
|
||||
```
|
||||
|
||||
If a module statement is not present, then the generated D module will not
|
||||
contain a module statement and the default module name will be used.
|
||||
|
||||
##> Specifying the generated API prefix - the `prefix` statement
|
||||
|
||||
By default the public API (types, constants, and functions) of the generated
|
||||
lexer and parser uses a prefix of `p_`.
|
||||
|
||||
This prefix can be changed with the `prefix` statement.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
prefix myparser_;
|
||||
```
|
||||
|
||||
With a parser generated with this `prefix` statement, instead of calling
|
||||
`p_context_init()` you would call `myparser_context_init()`.
|
||||
|
||||
The `prefix` statement can be optionally used if you would like to change the
|
||||
prefix used by your generated lexer and parser to something other than the
|
||||
default.
|
||||
|
||||
It can also be used when generating multiple lexers/parsers to be used in the
|
||||
same program to avoid symbol collisions.
|
||||
|
||||
#> License
|
||||
|
||||
Propane is licensed under the terms of the MIT License:
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
require "erb"
|
||||
require "set"
|
||||
require "stringio"
|
||||
require_relative "propane/assets"
|
||||
require_relative "propane/cli"
|
||||
require_relative "propane/code_point_range"
|
||||
require_relative "propane/fa"
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
class Propane
|
||||
module Assets
|
||||
class << self
|
||||
def get(name)
|
||||
path = File.join(File.dirname(File.expand_path(__FILE__)), "../../assets/#{name}")
|
||||
File.binread(path)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -10,7 +10,6 @@ class Propane
|
||||
else
|
||||
@log = StringIO.new
|
||||
end
|
||||
@classname = @grammar.classname || File.basename(output_file).sub(%r{[^a-zA-Z0-9].*}, "").capitalize
|
||||
@language =
|
||||
if output_file =~ /\.([a-z]+)$/
|
||||
$1
|
||||
@@ -26,7 +25,8 @@ class Propane
|
||||
extensions += %w[h]
|
||||
end
|
||||
extensions.each do |extension|
|
||||
erb = ERB.new(File.read(File.join(File.dirname(File.expand_path(__FILE__)), "../../assets/parser.#{extension}.erb")), trim_mode: "<>")
|
||||
template = Assets.get("parser.#{extension}.erb")
|
||||
erb = ERB.new(template, trim_mode: "<>")
|
||||
output_file = @output_file.sub(%r{\.[a-z]+$}, ".#{extension}")
|
||||
result = erb.result(binding.clone)
|
||||
File.open(output_file, "wb") do |fh|
|
||||
|
||||
@@ -5,7 +5,6 @@ class Propane
|
||||
# Reserve identifiers beginning with a double-underscore for internal use.
|
||||
IDENTIFIER_REGEX = /(?:[a-zA-Z]|_[a-zA-Z0-9])[a-zA-Z_0-9]*/
|
||||
|
||||
attr_reader :classname
|
||||
attr_reader :modulename
|
||||
attr_reader :patterns
|
||||
attr_reader :rules
|
||||
@@ -49,7 +48,6 @@ class Propane
|
||||
elsif parse_comment_line!
|
||||
elsif @mode.nil? && parse_mode_label!
|
||||
elsif parse_module_statement!
|
||||
elsif parse_class_statement!
|
||||
elsif parse_ptype_statement!
|
||||
elsif parse_pattern_statement!
|
||||
elsif parse_token_statement!
|
||||
@@ -90,16 +88,6 @@ class Propane
|
||||
end
|
||||
end
|
||||
|
||||
def parse_class_statement!
|
||||
if consume!(/class\s+/)
|
||||
md = consume!(/([\w.]+)\s*/, "expected class name")
|
||||
@classname = md[1]
|
||||
consume!(/;/, "expected `;'")
|
||||
@mode = nil
|
||||
true
|
||||
end
|
||||
end
|
||||
|
||||
def parse_ptype_statement!
|
||||
if consume!(/ptype\s+/)
|
||||
name = "default"
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
class Propane
|
||||
VERSION = "0.1.0"
|
||||
VERSION = "1.0.0"
|
||||
end
|
||||
@@ -1,2 +0,0 @@
|
||||
#!/bin/sh
|
||||
exec bundle exec ruby -Ilib bin/propane "$@"
|
||||
+24
-1
@@ -1,5 +1,6 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
require "erb"
|
||||
require "fileutils"
|
||||
require "digest/md5"
|
||||
|
||||
@@ -13,6 +14,24 @@ START_FILE = "bin/#{PROG_NAME}"
|
||||
LIB_DIR = "lib"
|
||||
DIST = "dist"
|
||||
|
||||
ASSETS_TEMPLATE = <<EOF
|
||||
class Propane
|
||||
module Assets
|
||||
class << self
|
||||
def get(name)
|
||||
case name
|
||||
<% Dir.glob("assets/*").each do |asset_file| %>
|
||||
when <%= File.basename(asset_file).inspect %>
|
||||
<%= File.binread(asset_file).inspect %>
|
||||
<% end %>
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
EOF
|
||||
|
||||
assets_module = ERB.new(ASSETS_TEMPLATE, trim_mode: "<>").result
|
||||
files_processed = {}
|
||||
combined_file = []
|
||||
|
||||
@@ -25,7 +44,11 @@ combine_files = lambda do |file|
|
||||
if File.exist?(path)
|
||||
unless files_processed[path]
|
||||
files_processed[path] = true
|
||||
combine_files[path]
|
||||
if require_name == "propane/assets"
|
||||
combined_file << assets_module
|
||||
else
|
||||
combine_files[path]
|
||||
end
|
||||
end
|
||||
else
|
||||
raise "require path #{path.inspect} not found"
|
||||
|
||||
@@ -5,7 +5,6 @@ class Propane
|
||||
# Comment line
|
||||
|
||||
module a.b;
|
||||
class Foobar;
|
||||
ptype XYZ * ;
|
||||
|
||||
token while;
|
||||
@@ -30,7 +29,6 @@ B -> <<
|
||||
>>
|
||||
EOF
|
||||
grammar = Grammar.new(input)
|
||||
expect(grammar.classname).to eq "Foobar"
|
||||
expect(grammar.modulename).to eq "a.b"
|
||||
expect(grammar.ptype).to eq "XYZ *"
|
||||
expect(grammar.ptypes).to eq("default" => "XYZ *")
|
||||
@@ -38,44 +36,44 @@ EOF
|
||||
|
||||
o = grammar.tokens.find {|token| token.name == "while"}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.line_number).to eq 7
|
||||
expect(o.line_number).to eq 6
|
||||
|
||||
o = grammar.patterns.find {|pattern| pattern.token == o}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.pattern).to eq "while"
|
||||
expect(o.line_number).to eq 7
|
||||
expect(o.line_number).to eq 6
|
||||
expect(o.code).to be_nil
|
||||
|
||||
o = grammar.tokens.find {|token| token.name == "id"}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.line_number).to eq 10
|
||||
expect(o.line_number).to eq 9
|
||||
|
||||
o = grammar.patterns.find {|pattern| pattern.token == o}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.pattern).to eq "[a-zA-Z_][a-zA-Z_0-9]*"
|
||||
expect(o.line_number).to eq 10
|
||||
expect(o.line_number).to eq 9
|
||||
expect(o.code).to be_nil
|
||||
|
||||
o = grammar.tokens.find {|token| token.name == "token_with_code"}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.line_number).to eq 12
|
||||
expect(o.line_number).to eq 11
|
||||
|
||||
o = grammar.patterns.find {|pattern| pattern.token == o}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.pattern).to eq "token_with_code"
|
||||
expect(o.line_number).to eq 12
|
||||
expect(o.line_number).to eq 11
|
||||
expect(o.code).to eq "Code for the token\n"
|
||||
|
||||
o = grammar.tokens.find {|token| token.name == "token_with_no_pattern"}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.line_number).to eq 16
|
||||
expect(o.line_number).to eq 15
|
||||
|
||||
o = grammar.patterns.find {|pattern| pattern.token == o}
|
||||
expect(o).to be_nil
|
||||
|
||||
o = grammar.patterns.find {|pattern| pattern.pattern == "\\s+"}
|
||||
expect(o).to_not be_nil
|
||||
expect(o.line_number).to eq 18
|
||||
expect(o.line_number).to eq 17
|
||||
expect(o.token).to be_nil
|
||||
expect(o.code).to be_nil
|
||||
|
||||
@@ -84,19 +82,19 @@ EOF
|
||||
o = grammar.rules[0]
|
||||
expect(o.name).to eq "A"
|
||||
expect(o.components).to eq %w[B]
|
||||
expect(o.line_number).to eq 20
|
||||
expect(o.line_number).to eq 19
|
||||
expect(o.code).to eq " a = 42;\n"
|
||||
|
||||
o = grammar.rules[1]
|
||||
expect(o.name).to eq "B"
|
||||
expect(o.components).to eq %w[C while id]
|
||||
expect(o.line_number).to eq 23
|
||||
expect(o.line_number).to eq 22
|
||||
expect(o.code).to be_nil
|
||||
|
||||
o = grammar.rules[2]
|
||||
expect(o.name).to eq "B"
|
||||
expect(o.components).to eq []
|
||||
expect(o.line_number).to eq 24
|
||||
expect(o.line_number).to eq 23
|
||||
expect(o.code).to eq " b = 0;\n"
|
||||
end
|
||||
|
||||
|
||||
+40
-2
@@ -4,14 +4,52 @@ require "open3"
|
||||
Results = Struct.new(:stdout, :stderr, :status)
|
||||
|
||||
describe Propane do
|
||||
before(:all) do
|
||||
@statics = {}
|
||||
end
|
||||
|
||||
def write_grammar(grammar, options = {})
|
||||
options[:name] ||= ""
|
||||
File.write("spec/run/testparser#{options[:name]}.propane", grammar)
|
||||
end
|
||||
|
||||
def build_parser(options = {})
|
||||
options[:name] ||= ""
|
||||
command = %W[./propane.sh spec/run/testparser#{options[:name]}.propane spec/run/testparser#{options[:name]}.#{options[:language]} --log spec/run/testparser#{options[:name]}.log]
|
||||
@statics[:build_test_id] ||= 0
|
||||
@statics[:build_test_id] += 1
|
||||
if ENV["dist_specs"]
|
||||
command = %W[dist/propane]
|
||||
else
|
||||
command = %W[ruby -I spec/run -r _simplecov_setup -I lib bin/propane]
|
||||
command_prefix =
|
||||
if ENV["partial_specs"]
|
||||
"p"
|
||||
else
|
||||
"b"
|
||||
end
|
||||
command_name = "#{command_prefix}#{@statics[:build_test_id]}"
|
||||
File.open("spec/run/_simplecov_setup.rb", "w") do |fh|
|
||||
fh.puts <<EOF
|
||||
require "bundler"
|
||||
Bundler.setup
|
||||
require "simplecov"
|
||||
class MyFormatter
|
||||
def format(*args)
|
||||
end
|
||||
end
|
||||
SimpleCov.start do
|
||||
command_name(#{command_name.inspect})
|
||||
filters.clear
|
||||
add_filter do |src|
|
||||
!(src.filename[SimpleCov.root])
|
||||
end
|
||||
formatter(MyFormatter)
|
||||
end
|
||||
# force color off
|
||||
ENV["TERM"] = nil
|
||||
EOF
|
||||
end
|
||||
end
|
||||
command += %W[spec/run/testparser#{options[:name]}.propane spec/run/testparser#{options[:name]}.#{options[:language]} --log spec/run/testparser#{options[:name]}.log]
|
||||
if (options[:capture])
|
||||
stdout, stderr, status = Open3.capture3(*command)
|
||||
Results.new(stdout, stderr, status)
|
||||
|
||||
+23
-7
@@ -1,11 +1,27 @@
|
||||
require "bundler/setup"
|
||||
require "propane"
|
||||
unless ENV["dist_specs"]
|
||||
require "bundler/setup"
|
||||
require "simplecov"
|
||||
|
||||
RSpec.configure do |config|
|
||||
# Enable flags like --only-failures and --next-failure
|
||||
config.example_status_persistence_file_path = ".rspec_status"
|
||||
SimpleCov.start do
|
||||
add_filter "/spec/"
|
||||
add_filter "/.bundle/"
|
||||
if ENV["partial_specs"]
|
||||
command_name "RSpec-partial"
|
||||
else
|
||||
command_name "RSpec"
|
||||
end
|
||||
project_name "Propane"
|
||||
merge_timeout 3600
|
||||
end
|
||||
|
||||
config.expect_with :rspec do |c|
|
||||
c.syntax = :expect
|
||||
RSpec.configure do |config|
|
||||
# Enable flags like --only-failures and --next-failure
|
||||
config.example_status_persistence_file_path = ".rspec_status"
|
||||
|
||||
config.expect_with :rspec do |c|
|
||||
c.syntax = :expect
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
require "propane"
|
||||
Reference in new issue
Block a user