@appthreat/atom-parsetools 1.1.5 → 1.2.1

package/plugins/rubyastgen/bundle/ruby/4.0.0/gems/racc-1.8.1/doc/en/grammar.en.rdoc

@@ -1,218 +0,0 @@
-= Racc Grammar File Reference
-
-== Global Structure
-
-== Class Block and User Code Block
-
-There are two top-level blocks: the 'class' block, and the 'user code'
-block. The 'user code' block MUST be after the 'class' block.
-
-== Comment
-
-Comments can be added about everywhere.  Two comment styles are
-supported: Ruby style (`# ...`) and C style (`/* ... */`).
-
-== Class Block
-
-The class block is formed like this:
-
-  class CLASS_NAME
-    [precedence table]
-    [token declarations]
-    [expected number of S/R conflict]
-    [options]
-    [semantic value conversion]
-    [start rule]
-  rule
-    GRAMMARS
-
-CLASS_NAME is a name of parser class.
-This is the name of generating parser class.
-
-If CLASS_NAME includes '::', Racc outputs module clause.
-For example, writing "class M::C" causes creating the code below:
-
-  module M
-    class C
-      :
-      :
-    end
-  end
-
-== Grammar Block
-
-The grammar block describes the grammar
-to be understood by parser.  Syntax is:
-
-  (token): (token) (token) (token).... (action)
-
-  (token): (token) (token) (token).... (action)
-         | (token) (token) (token).... (action)
-         | (token) (token) (token).... (action)
-
-(action) is an action which is executed when its (token)s are found.
-(action) is a ruby code block, which is surrounded by braces:
-
-  { print val[0]
-    puts val[1] }
-
-Note that you cannot use '%' string, here document, '%r' regexp in action.
-
-Actions can be omitted.
-When it is omitted, '' (empty string) is used.
-
-A return value of action is a value of left side value ($$).
-It is value of result, or returned value by "return" statement.
-
-Here is an example of whole grammar block.
-
-  rule
-    goal: definition rules source { result = val }
-
-    definition: /* none */   { result = [] }
-      | definition startdesig  { result[0] = val[1] }
-      | definition
-               precrule   # this line continue from upper line
-        {
-          result[1] = val[1]
-        }
-
-    startdesig: START TOKEN
-
-You can use following special local variables in action.
-
-  * result ($$)
-
-The value of left-hand side (lhs). A default value is val[0].
-
-  * val ($1,$2,$3...)
-
-An array of value of right-hand side (rhs).
-
-  * _values (...$-2,$-1,$0)
-
-A stack of values.
-DO NOT MODIFY this stack unless you know what you are doing.
-
-== Operator Precedence
-
-This function is equal to '%prec' in yacc.
-To designate this block:
-
-  prechigh
-    nonassoc '++'
-    left     '*' '/'
-    left     '+' '-'
-    right    '='
-  preclow
-
-`right' is yacc's %right, `left' is yacc's %left.
-
-`=' + (symbol) means yacc's %prec:
-
-  prechigh
-    nonassoc UMINUS
-    left '*' '/'
-    left '+' '-'
-  preclow
-
-  rule
-    exp: exp '*' exp
-       | exp '-' exp
-       | '-' exp       =UMINUS   # equals to "%prec UMINUS"
-           :
-           :
-
-== expect
-
-Racc supports Bison's "expect" directive to declare the expected
-number of shift/reduce conflicts.
-
-  class MyParser
-    expect 3
-  rule
-      :
-      :
-
-Then warnings are issued only when the effective number of conflicts differs.
-
-== Declaring Tokens
-
-Declaring tokens avoids many bugs.
-
-Racc outputs warnings for declared tokens that do not exist, or existing tokens not declared.
-The syntax is:
-
-  token TOKEN_NAME AND_IS_THIS
-        ALSO_THIS_IS AGAIN_AND_AGAIN THIS_IS_LAST
-
-== Options
-
-You can write options for racc command in your racc file.
-
-  options OPTION OPTION ...
-
-Options are:
-
-  * omit_action_call
-
-omit empty action call or not.
-
-  * result_var
-
-use/does not use local variable "result"
-
-You can use 'no_' prefix to invert its meanings.
-
-== Converting Token Symbol
-
-Token symbols are, as default,
-
-  * naked token strings in racc file (TOK, XFILE, this_is_token, ...)
-    --> symbol (:TOK, :XFILE, :this_is_token, ...)
-  * quoted strings (':', '.', '(', ...)
-    --> same string (':', '.', '(', ...)
-
-You can change this default using a "convert" block.
-Here is an example:
-
-  convert
-    PLUS 'PlusClass'      # We use PlusClass for symbol of `PLUS'
-    MIN  'MinusClass'     # We use MinusClass for symbol of `MIN'
-  end
-
-We can use almost all ruby value can be used by token symbol,
-except 'false' and 'nil'.  These are causes unexpected parse error.
-
-If you want to use String as token symbol, special care is required.
-For example:
-
-  convert
-    class '"cls"'            # in code, "cls"
-    PLUS '"plus\n"'          # in code, "plus\n"
-    MIN  "\"minus#{val}\""   # in code, \"minus#{val}\"
-  end
-
-== Start Rule
-
-'%start' in yacc. This changes the start symbol.
-
-  start real_target
-
-== User Code Block
-
-A "User Code Block" is a piece of Ruby source code copied in the output.
-There are three user code blocks, "header" "inner" and "footer".
-
-User code blocks are introduced by four '-' at the beginning of a line,
-followed by a single-word name:
-
-  ---- header
-    ruby statement
-    ruby statement
-    ruby statement
-
-  ---- inner
-    ruby statement
-       :
-       :

package/plugins/rubyastgen/bundle/ruby/4.0.0/gems/racc-1.8.1/doc/en/grammar2.en.rdoc

@@ -1,219 +0,0 @@
-= Racc Grammar File Reference
-
-== Global Structure
-
-== Class Block and User Code Block
-
-There are two blocks on the toplevel. One is the 'class' block, the other is the 'user code'
-block. The 'user code' block MUST be placed after the 'class' block.
-
-== Comments
-
-You can insert comments about all places. Two styles of comments can be used, Ruby style '#.....' and C style '/\*......*\/'.
-
-== Class Block
-
-The class block is formed like this:
-
-  class CLASS_NAME
-    [precedence table]
-    [token declarations]
-    [expected number of S/R conflicts]
-    [options]
-    [semantic value conversion]
-    [start rule]
-  rule
-    GRAMMARS
-
-CLASS_NAME is a name of the parser class. This is the name of the generating parser
-class.
-
-If CLASS_NAME includes '::', Racc outputs the module clause. For example, writing
-"class M::C" causes the code below to be created:
-
-  module M
-    class C
-      :
-      :
-    end
-  end
-
-== Grammar Block
-
-The grammar block describes grammar which is able to be understood by the parser.
-Syntax is:
-
-  (token): (token) (token) (token).... (action)
-
-  (token): (token) (token) (token).... (action)
-         | (token) (token) (token).... (action)
-         | (token) (token) (token).... (action)
-
-(action) is an action which is executed when its (token)s are found.
-(action) is a ruby code block, which is surrounded by braces:
-
-  { print val[0]
-    puts val[1] }
-
-Note that you cannot use '%' string, here document, '%r' regexp in action.
-
-Actions can be omitted. When it is omitted, '' (empty string) is used.
-
-A return value of action is a value of the left side value ($$). It is the value of the
-result, or the returned value by `return` statement.
-
-Here is an example of the whole grammar block.
-
-  rule
-    goal: definition rules source { result = val }
-
-    definition: /* none */   { result = [] }
-      | definition startdesig  { result[0] = val[1] }
-      | definition
-               precrule   # this line continues from upper line
-        {
-          result[1] = val[1]
-        }
-
-    startdesig: START TOKEN
-
-You can use the following special local variables in action:
-
-* result ($$)
-
-The value of the left-hand side (lhs). A default value is val[0].
-
-* val ($1,$2,$3...)
-
-An array of value of the right-hand side (rhs).
-
-* _values (...$-2,$-1,$0)
-
-A stack of values. DO NOT MODIFY this stack unless you know what you are doing.
-
-== Operator Precedence
-
-This function is equal to '%prec' in yacc.
-To designate this block:
-
-  prechigh
-    nonassoc '++'
-    left     '*' '/'
-    left     '+' '-'
-    right    '='
-  preclow
-
-`right` is yacc's %right, `left` is yacc's %left.
-
-`=` + (symbol) means yacc's %prec:
-
-  prechigh
-    nonassoc UMINUS
-    left '*' '/'
-    left '+' '-'
-  preclow
-
-  rule
-    exp: exp '*' exp
-       | exp '-' exp
-       | '-' exp       =UMINUS   # equals to "%prec UMINUS"
-           :
-           :
-
-== expect
-
-Racc has bison's "expect" directive.
-
-  # Example
-
-  class MyParser
-    expect 3
-  rule
-      :
-      :
-
-This directive declares "expected" number of shift/reduce conflicts. If
-"expected" number is equal to real number of conflicts, Racc does not print
-conflict warning message.
-
-== Declaring Tokens
-
-By declaring tokens, you can avoid many meaningless bugs. If declared token
-does not exist or existing token does not decleared, Racc output warnings.
-Declaration syntax is:
-
-  token TOKEN_NAME AND_IS_THIS
-        ALSO_THIS_IS AGAIN_AND_AGAIN THIS_IS_LAST
-
-== Options
-
-You can write options for Racc command in your Racc file.
-
-  options OPTION OPTION ...
-
-Options are:
-
-* omit_action_call
-
-omits empty action call or not.
-
-* result_var
-
-uses local variable "result" or not.
-
-You can use 'no_' prefix to invert their meanings.
-
-== Converting Token Symbol
-
-Token symbols are, as default,
-
-  * naked token string in Racc file (TOK, XFILE, this_is_token, ...)
-    --> symbol (:TOK, :XFILE, :this_is_token, ...)
-  * quoted string (':', '.', '(', ...)
-    --> same string (':', '.', '(', ...)
-
-You can change this default by "convert" block.
-Here is an example:
-
-  convert
-    PLUS 'PlusClass'      # We use PlusClass for symbol of `PLUS'
-    MIN  'MinusClass'     # We use MinusClass for symbol of `MIN'
-  end
-
-We can use almost all ruby value can be used by token symbol,
-except 'false' and 'nil'.  These cause unexpected parse error.
-
-If you want to use String as token symbol, special care is required.
-For example:
-
-  convert
-    class '"cls"'            # in code, "cls"
-    PLUS '"plus\n"'          # in code, "plus\n"
-    MIN  "\"minus#{val}\""   # in code, \"minus#{val}\"
-  end
-
-== Start Rule
-
-'%start' in yacc. This changes start rule.
-
-  start real_target
-
-== User Code Block
-
-"User Code Block" is a Ruby source code which is copied to output. There are
-three user code blocks, "header" "inner" and "footer".
-
-Format of user code is like this:
-
-  ---- header
-    ruby statement
-    ruby statement
-    ruby statement
-
-  ---- inner
-    ruby statement
-       :
-       :
-
-If four '-' exist on the line head, Racc treats it as the beginning of the
-user code block.  The name of the user code block must be one word.

package/plugins/rubyastgen/bundle/ruby/4.0.0/gems/racc-1.8.1/doc/ja/command.ja.html

@@ -1,99 +0,0 @@
-<h1>Raccコマンドリファレンス</h1>
-<p>
-racc [-o<var>filename</var>] [--output-file=<var>filename</var>]
-     [-e<var>rubypath</var>] [--executable=<var>rubypath</var>]
-     [-v] [--verbose]
-     [-O<var>filename</var>] [--log-file=<var>filename</var>]
-     [-g] [--debug]
-     [-E] [--embedded]
-     [-F] [--frozen]
-     [-l] [--no-line-convert]
-     [-c] [--line-convert-all]
-     [-a] [--no-omit-actions]
-     [-C] [--check-only]
-     [-S] [--output-status]
-     [--version] [--copyright] [--help] <var>grammarfile</var>
-</p>
-
-<dl>
-<dt><var>filename</var>
-<dd>
-Raccの文法ファイルを指定します。拡張子には特に制限はありません。
-</dd>
-<dt>-o<var>outfile</var>, --output-file=<var>outfile</var>
-<dd>
-作成するクラスをかきこむファイル名を指定します。デフォルトは<filename>.tab.rbです。
-</dd>
-<dt>-O<var>filename</var>, --log-file=<var>filename</var>
-<dd>
--v オプションをつけた時に生成するログファイルの名前を
-<var>filename</var> に変更します。
-デフォルトは <var>filename</var>.output です。
-</dd>
-<dt>-e<var>rubypath</var>, --executable=<var>rubypath</var>
-<dd>
-実行可能ファイルを生成します。<var>rubypath</var>は Ruby 本体のパスです。
-<var>rubypath</var>を単に 'ruby' にした時には Racc が動作している
-Ruby のパスを使用します。
-</dd>
-<dt>-v, --verbose
-<dd>
-ファイル "filename".output に詳細な解析情報を出力します。
-</dd>
-<dt>-g, --debug
-<dd>
-出力するコードにデバッグ用コードを加えます。-g をつけて生成したパーサで
-@yydebug を true にセットすると、デバッグ用のコードが出力されます。<br>
--g をつけるだけでは何もおこりませんので注意してください。
-</dd>
-<dt>-E, --embedded
-<dd>
-ランタイムルーチンをすべて含んだコードを生成します。
-つまり、このオプションをつけて生成したコードは Ruby さえあれば動きます。
-</dd>
-<dt>-F, --frozen
-<dd>
-Add frozen_string_literals: true.
-</dd>
-<dt>-C, --check-only
-<dd>
-(文法ファイルの) 文法のチェックだけをして終了します。
-</dd>
-<dt>-S, --output-status
-<dd>
-進行状況を逐一報告します。
-</dd>
-<dt>-l, --no-line-convert
-<dd>
-<p>
-Ruby では例外が発生した時のファイル名や行番号を表示してくれますが、
-Racc の生成したパーサは、デフォルトではこの場合のファイル名・行番号を
-文法ファイルでのものに置きかえます。このフラグはその機能をオフにします。
-</p>
-<p>
-ruby 1.4.3 以前のバージョンではバグのために定数の参照に失敗する
-場合があるので、定数参照に関してなにかおかしいことがおこったらこのフラグを
-試してみてください。
-</p>
-</dd>
-<dt>-c, --line-convert-all
-<dd>
-アクションと inner に加え header footer の行番号も変換します。
-header と footer がつながっているような場合には使わないでください。
-<dt>-a, --no-omit-actions
-<dd>
-全てのアクションに対応するメソッド定義と呼び出しを行います。
-例えアクションが省略されていても空のメソッドを生成します。
-</dd>
-<dt>--version
-<dd>
-Racc のバージョンを出力して終了します。
-</dd>
-<dt>--copyright
-<dd>
-著作権表示を出力して終了します。
-<dt>--help
-<dd>
-オプションの簡単な説明を出力して終了します。
-</dd>
-</dl>

package/plugins/rubyastgen/bundle/ruby/4.0.0/gems/racc-1.8.1/doc/ja/debug.ja.rdoc

@@ -1,36 +0,0 @@
-= パーサのデバッグ
-
-ここでは、Racc を使っていくうえで遭遇しそうな問題について書きます。
-
-== 文法ファイルがパースエラーになる
-
-エラーメッセージに出ている行番号のあたりを見て間違いを
-探してください。ブロックを閉じる行でエラーになる場合は、
-どこかで開き括弧などを増やしてしまっている可能性が高いです。
-
-== なんたら conflict って言われた
-
-一番ありがちで一番面倒な問題は衝突 (conflict) でしょう。
-文法中に衝突があると、racc はコンパイル後に
-「5 shift/reduce conflict」のようなメッセージを表示します。
--v をつけると出力される .output ファイルからはさらに詳しい情報が得られます。
-それをどう使うか、とかそういうことに関しては、それなりの本を読んでください。
-とてもここに書けるような単純な話ではありません。
-当然ながら『Ruby を 256 倍使うための本 無道編』(青木峰郎著)がお勧めです。
-
-== パーサは問題なく生成できたけど予想どおりに動かない
-
-racc に -g オプションをつけてパーサを出力すると、デバッグ用のコードが
-付加されます。ここで、パーサクラスのインスタンス変数 @yydebug を true に
-しておいてから do_parse/yyparse を呼ぶと、デバッグ用メッセージが出力
-されます。パーサが動作する様子が直接見えますので、完全に現在の状態を
-把握できます。これを見てどこがおかしいのかわかったらあとは直すだけ。
-
-== next_token に関して
-
-いまだ自分でも忘れることが多いのが
-「送るトークンが尽きたら [false,なにか] を送る」ということです。
-ちなみに Racc 0.10.2 以降では一度 [false,なにか] を受け取ったら
-それ以上 next_token は呼ばないことが保証されています。
-
-追記： 最近は [false,なにか] ではなく nil でもよいことになった。