Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/dncl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,18 +150,20 @@ DNCL 風の形の読み方(切りかえる前の変換に合わせたもの)
| ファイル | 役割 |
|---|---|
| `packages/ja-notation/`(ワークスペースのパッケージ `@smalruby/ja-notation`。MIT。`LICENSE` あり) | ライブラリ。依存は無く、`src/` の外を import しない(`packages/ja-notation/test/boundary.test.js`)。使い方・JaAST の形・テストのデータは `packages/ja-notation/README.md`。下の `ja-notation/<ファイル>` は `packages/ja-notation/src/<ファイル>` |
| `ja-notation/lexer.js` | 1 行を字句に分ける。全角の演算子・`≦` など、数の全角数字(`12`)、コメントの `#` は半角のものとして読み、`“…”` は文字列として読む。名前の文字の判定(`isName` / `isNameHead` / `isNameChar`。下の「名前に使える文字」)もここにあり、エディタの判定(`paren-utils.js`)も同じものを使う |
| `ja-notation/lexer.js` | 1 行を字句に分ける。文字列とコメントの外の全角英字・全角数字(`x1` `12`)はまず半角にし(`halfWidthAlphanumerics`)、全角の演算子・`≦` など、コメントの `#` は半角のものとして読み、`“…”` は文字列として読む。名前の文字の判定(`isName` / `isNameHead` / `isNameChar`。下の「名前に使える文字」)もここにあり、エディタの判定(`paren-utils.js`)も同じものを使う |
| `ja-notation/parse.js` | 日本語を読む。標準の形(行番号・`|` `⎿`・字下げ・`ならば:`・`and` / `or` / `not`)と DNCL 風の形(閉じる行・`←`・`かつ`・`でない`・「...」)。JaAST の形は `ja-notation/ja-ast.js` |
| `ja-notation/build-ruby.js` | JaAST → Ruby の構文木(prism のノード名を使う小さな形)。変数の名前・関数・入力は外から受けとる表で決める |
| `ja-notation/write-ruby.js` | Ruby のテキストと、Ruby の行ごとの日本語の行を書く |

名前に使える文字(`ja-notation/lexer.js` の `NAME_HEAD_RE` / `NAME_TAIL_RE`。Issue #1714):

- 1 文字目: 英字・`_`・どの文字体系の文字(Unicode の `\p{L}`。かな・漢字(CJK 拡張 A〜と BMP の外の `𠮷` も)・`々`・`〆`・`ヵ` `ヶ`・`ー`・全角英字・ギリシャ文字など)・
- 1 文字目: 英字・`_`・どの文字体系の文字(Unicode の `\p{L}`。かな・漢字(CJK 拡張 A〜と BMP の外の `𠮷` も)・`々`・`〆`・`ヵ` `ヶ`・`ー`・ギリシャ文字など)・
文字としての数字(`\p{Nl}`。`〇` `Ⅱ`)と、ひらがな・カタカナの区画の記号(`゛` `・` など。前から読めていたもの)
- 2 文字目から: 上に加えて、数字(`\p{Nd}`。全角の `1` も)と結合文字(`\p{M}`。`か` + `゙`)
- 2 文字目から: 上に加えて、数字(`\p{Nd}`)と結合文字(`\p{M}`。`か` + `゙`)
- Ruby はこれらをどれも名前に使えて、Ruby → 日本語は名前をそのまま書く(`@佐々木` → `佐々木`)。日本語 → Ruby が同じ範囲を名前として読むので、書いた名前は読み戻せる。
- 全角英字は全角のままの別の名前(`x` は `x` ではない)。Ruby でも別の変数なので、見た目の揺れとして 1 つにそろえない(`policy.md`)。
- 全角英字・全角数字は、文字列(`"…"` `'…'` `「…」`)とコメントの外では、読む前にすべて半角にする(`x1` は `x1`、`and` は `and`)。見た目だけの揺れで(`policy.md`)、Ruby モードの自動置換も半角にするのと同じ考え。
文字列とコメントの中は書いたとおりに残す(`表示する("ABC")` は `"ABC"` のまま)。全角と半角は 1 字ずつ同じ長さなので、誤りの列は変わらない。
Ruby → 日本語は Ruby の名前をそのまま書く(`@x` → `x`)ので、日本語から Ruby に戻すと `@x` になる。
- `☆` `①` `😀` のような記号は名前に使えず、「「☆」が読めません」の誤りになる(BMP の外の文字も 1 文字として示す)。

誤りは `{code, message, line, column}` に、日本語モードの文言を作るための `name`(字句)・`opener` / `direction` / `colon` / `word`(ブロック)・`block`(`stray-closer` / `closer-indent` / `stray-branch`)を添えて返す。
Expand All @@ -178,18 +180,21 @@ prism の解析の関数は外から受けとり(`rubyToJa(source, { parse, ..
本体のほかの文が変数も増分も変えないときだけ `〜ずつ増やしながら繰り返す` にする。それ以外は `i = 1` と `i <= 10 の間繰り返す:` のまま。
`(a / b).to_i` は `a ÷ b`、`-((a / b).to_i)` は `-a ÷ b`(日本語では `-(a ÷ b)` と読むので、符号を `÷` の左に置く)。`((-a) / b).to_i` は `÷` にしない(`整数(-a / b)`)。
`!(...)` のかっこは残す(`not (a > 10)`)。`until 条件` は `not 条件 の間繰り返す:`、`wait until 条件` は中身の無い繰り返し。
- 日本語に書きかえるものが無い Ruby(`with_screen_refresh do` / `loop do` / `list.each do |x|` などの `xxx do`、`unless`、後置の `if`、`begin … end while`、`$g`、`nil` など)は、
- 日本語に書きかえるものが無い Ruby(`with_screen_refresh do` / `loop do` / `list.each do |x|` などの `xxx do`、`unless`、後置の `if`、`begin … end while`、`nil` など)は、
**書いてあるとおりの Ruby のまま**(`end` も)残す(JaAST の `RubyCode`)。中の命令と数の誤りは、そのまま Ruby の行に出す(日本語モードはこうした Ruby を切りかえで受け付けない)。
それ自体が誤りでない Ruby(`case` / `when`、ハッシュ `{}`、シンボル `:a`、後置の `unless` / `if`、三項演算子、`nil`、`$g` など)も、黙って残さずに `no-ja-form` の誤りにする
それ自体が誤りでない Ruby(`case` / `when`、ハッシュ `{}`、シンボル `:a`、後置の `unless` / `if`、三項演算子、`nil` など)も、黙って残さずに `no-ja-form` の誤りにする
(黙って残すと、日本語に戻したときに「「@」は使えません」「「{」が読めません」のような見当違いの誤りになるため)。誤りは残した Ruby のいちばん外のものに 1 つだけ出し、
キーワードで始まるものはキーワードの位置にキーワードの名前で(`unless`)、それ以外は先頭の位置に Ruby の字(1 行目の 20 字まで。長いものは `…`)で出す。
その Ruby に命令や `break` の誤りがすでに出ているときは足さない。prism が文法の誤りを出したときは足さない(立て直しのノードの誤りを並べないため)。
ステージの変数・リスト(`$g`)は、日本語モードが想定しない([`design.md`](design.md) の「ステージの変数は書かない」)ので、
書いてあるとおりに残したうえで、`$g` の名前の位置(読むところ・代入・`+=`・多重代入の左辺・`$g.push(1)` の受け手)に `stage-variable` の誤りを出す
(`no-ja-form` や `push` の命令の誤りは足さない)。
表を渡さないとき(ほかの処理系)は、大文字の名前(Ruby の定数 `A`)も名前として読む(`buildRuby` がそう書くため)。
`N.times do` と `(a..b).step(s) do |i|` / `a.step(b, -s) do |i|` は `〜ずつ増やしながら繰り返す` にする。
- 書き方(`write-ja.js`): 下の「書き出しの形」。演算子は日本語の読み方(`parse.js`)の強さで、要るところだけかっこを付ける(Ruby に書いてあったかっこは残さない。`not` の後ろは上のとおり)。
空行は Ruby の空行の位置に残す(読み手が JaAST に `blankLines` を付ける)。行末のコメントは、その Ruby の行から作った日本語の行の末尾に付け直す。
- 誤り: 日本語モードに無い命令(`unknown-command`。`(` の付いた名前、括弧の無いメソッド、受け手のあるメソッド、`xxx do` の `xxx`、`break` / `next` / `redo` / `retry`)、
数の書き方(`bad-number`)、後判定の繰り返し(`post-test-loop`。`begin` と `end while` の行)、日本語に無い書き方(`no-ja-form`。上の `RubyCode`)、Ruby の文法の誤り(`ruby-syntax`)。行と列は Ruby の行。
数の書き方(`bad-number`)、後判定の繰り返し(`post-test-loop`。`begin` と `end while` の行)、日本語に無い書き方(`no-ja-form`。上の `RubyCode`)、ステージの変数(`stage-variable`)、Ruby の文法の誤り(`ruby-syntax`)。行と列は Ruby の行。
命令と取らないのは、表にある呼び出し、プログラムで `def` した名前、`dncl-keywords.js` の `RUBY_LITERALS`(`answer` / `ask` など)。ローカル変数は prism が変数と分かるので取らない。
- 構文木を歩く処理は、長い `and` / `+` の並び(左に深い木)をくり返しで歩くので、項が数千あってもスタックが尽きない。prism 自身はおよそ 5000 項の式を解析できないので、それより長い式は誤り
(「プログラムが長すぎて日本語にできません」)にする。
Expand All @@ -214,6 +219,7 @@ ja-notation の誤りは `ja-notation-errors.js` が、生徒に見えている
| `post-test-loop` | 後判定の繰り返しの文(`postTestLoop`) |
| `unknown-command` | 「「move」は日本語モードでは書けない命令です。Ruby モードでは書けます。」、日本語の名前は「「差分」は定義されていない関数です。「関数 差分(…):」で定義してください。」(`unsupportedCommand`) |
| `no-ja-form` | 「「case」は日本語モードでは書けません。Ruby モードでは書けます。」(`unsupportedNotation`。Ruby → 日本語だけ) |
| `stage-variable` | 「ステージの変数($a)は日本語モードでは書けません。Ruby モードでは書けます。」(`stageVariable`。Ruby → 日本語だけ) |
| `unclosed` / `empty-block` / `block`(閉じのことば・`そうでなければ`) | 下の「閉じ忘れのエラー」の文 |
| そのほか(読めない字句・式が要る など) | ja-notation の文のまま(「「//」が読めません」など) |

Expand Down Expand Up @@ -421,7 +427,7 @@ Smalruby は **共通テスト用プログラム表記の形のプログラム
| 戻り値(標準の形) | `x * 2 を返す` | `return x * 2`(`返す x * 2` も読む) |
| 要素の追加 | `Data に 3 を追加する` | `@_array_Data_.push(3)`(ブロックは「(3) を (Data) に追加する」。Ruby の `<<` も `を追加する` に戻す) |
| 余り(全角) | `a % 3` | `a % 3` |
| 全角数字 | `a = 12` | `a = 12`(見た目だけの揺れとして半角で読む。名前の中の `x1` は名前のまま) |
| 全角英字・全角数字 | `a = 12` | `@a = 12`(見た目だけの揺れとして半角で読む。名前の中も `x1` → `x1`。文字列とコメントの中は変えない) |
| インデントマーカー (`|`) | ` | a = 1` | ` a = 1`(2 スペース/marker)。`|` `│` も同じ |
| 暗黙の `end` (`⎿`) | ` ⎿ a = 1` (1 marker) | ` a = 1` + 自動で `を実行する` 追加。`└` も同じ(英字の `L` は貼り付けで `⎿` に直す) |
| 同一行複数 `⎿` | ` ⎿ ⎿ a = 1` | 2 個の `end` を一度に追加 |
Expand Down Expand Up @@ -549,6 +555,7 @@ Smalruby は **共通テスト用プログラム表記の形のプログラム
- `dncl-standard-form.test.js` — 書き出しの標準の形(字下げと `:`・`and` / `or` / `not`・`%`・`を返す`・終端の行を残す場合)と、DNCL 風の形も読むこと
- `dncl-loop-jump.test.js` — 繰り返しの中の `break` / `next`(後置の `if` / `unless` 付き・1 行だけ・`redo` / `retry`)がその行のエラーで止まり、`@break` のような Ruby にならないこと。同じ名前の変数は往復できること
- `dncl-no-ja-form.test.js` — 日本語に無い書き方(`case` / `when`・ハッシュ・シンボル・後置の `unless` / `if`・三項演算子)が Ruby → 日本語でその場所の誤り(`unsupportedNotation`)になり、日本語モードにある Ruby は誤りにならないこと
- `dncl-stage-variable.test.js` — ステージの変数・リスト(`$a`)が Ruby → 日本語でその名前の位置の誤り(`stageVariable`)になり、スプライトの変数(`@a`)は日本語になること
- `dncl-unsupported-command.test.js` — 日本語モードに無い命令(引数あり・なし・変数と同じ名前・式や条件の中・`xxx do` と `|x|`)がその行のエラーで止まり、定義した関数の呼び出しや組み込み関数は往復できること(DNCL → Ruby と Ruby → DNCL の両方)
- `dncl-do-block.test.js` — 日本語にしない `xxx do ... end` が `を実行する` で閉じ、外側の `〜の間` / `もし` / `関数` の閉じのことばがずれないこと(入れ子・`until x do`・後判定の中・文字列やコメントの中の `do`)
- `dncl-roundtrip.test.js` — DNCL ↔ Ruby round-trip 安定性
Expand Down
9 changes: 9 additions & 0 deletions docs/dncl/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,15 @@ Ruby や日本語のプログラムの `表示する` は、キャラクター
Ruby タブは Scratch の部分集合(Scratch でできることを Ruby で書く)なので、コンソールのブロックを Ruby で書く形は足さない。
- 将来の案: Ruby タブに「コンソールモード」のような切りかえを置き、そのときだけ `puts` / `gets` がコンソールを使う。いまは作らない。

### ステージの変数は書かない

- 日本語モードは、**ターミナルで動かすような、1 つで動くプログラム**を想定する。上のとおりステージはコンソールになり、
ステージという考え方はできるだけ薄くする。ステージの変数・リストや、ほかのスプライトの変数は使わない。
- そのため、Ruby の `$a`(ステージの変数・リスト)は日本語にしない。Ruby → 日本語では、`$a` の書いてある位置に
「ステージの変数($a)は日本語モードでは書けません。Ruby モードでは書けます。」の誤りを出す(ほかの日本語にできない Ruby と同じく、
日本語に切りかえず Ruby タブにとどまる)。日本語の変数は、いつもそのスプライトの変数(Ruby の `@a`)になる。
- ステージの変数を使うプログラムは Ruby タブで書く。

### 要素の追加

- 日本語の `A に 値 を追加する` で書けるようにする。
Expand Down
2 changes: 1 addition & 1 deletion docs/dncl/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
| 種類 | 扱い | 例 |
|---|---|---|
| **意味が変わるもの、または問題文で約束されるもの** | **設定にする**。選んだ設定はプログラムの冒頭に説明文として書く | 添字の始まり(0 から / 1 から)、コメントの記号(`#` か `//` か。`//` をコメントにしたときは、`//` を整数の割り算に使えない)、論理演算子の書き方 |
| **意味が変わらない、見た目だけの揺れ** | **設定にしない**。読むとき(貼り付けなど)はどの書き方も受け付ける。書くとき(ブロックや Ruby から日本語にするとき)は 1 つにそろえる | 行番号の形(`(01)` / `(1)`)、罫線の文字(`|` `⎿` / `|` `└`)、`:` と `:`、全角と半角の演算子(`+` `%` `<`)、引き算の記号(`-` / `−` / `–`)、`,` の後の空白 |
| **意味が変わらない、見た目だけの揺れ** | **設定にしない**。読むとき(貼り付けなど)はどの書き方も受け付ける。書くとき(ブロックや Ruby から日本語にするとき)は 1 つにそろえる | 行番号の形(`(01)` / `(1)`)、罫線の文字(`|` `⎿` / `|` `└`)、`:` と `:`、全角と半角の演算子(`+` `%` `<`)、文字列とコメントの外の全角英字・全角数字(`x1` `12`)、引き算の記号(`-` / `−` / `–`)、`,` の後の空白 |

- 書くときにそろえる 1 つは、上の「文法の決め方」で決める(新しい年度の問題に合わせる)。
- 専門的でない受験者には細かい設定が難しいので、**よくある設定のパターンを用意**する。
Expand Down
5 changes: 3 additions & 2 deletions docs/smalruby-dncl-spec.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ c = "「く」がある" # → "「く」がある" のまま
### 識別子に使える文字

- ASCII 英字(`a-z`, `A-Z`)、アンダースコア(`_`)、2 文字目からは数字(`0-9`)
- ひらがな・カタカナ・漢字(CJK 拡張の漢字も)と、`々` `〆` `ヶ` `ー` など名前に使う文字。全角英字・ギリシャ文字など、ほかの文字体系の文字も使えます(`佐々木`、`α`)
- 全角英字は半角とは別の名前です(`x` と `x` は別の変数)
- ひらがな・カタカナ・漢字(CJK 拡張の漢字も)と、`々` `〆` `ヶ` `ー` など名前に使う文字。ギリシャ文字など、ほかの文字体系の文字も使えます(`佐々木`、`α`)
- 全角英字・全角数字は半角として読みます(`x1` は `x1` と同じ変数)。文字列とコメントの中は書いたとおりです
- `☆` `①` のような記号は使えません

範囲の詳細は `docs/dncl/README.md` の「名前に使える文字」を参照してください。
Expand Down Expand Up @@ -652,6 +652,7 @@ Monaco エディタで以下の要素がハイライトされます:
| 等価比較 | `==`(条件式の中の `=` も比較として読むが、`==` を推奨) |
| 割り算 | `/`(小数になる割り算)、`÷`(商の整数値)。`//` も商の整数値として使える(コメントの記号を `//` にしたときを除く)。負の数の商は小さいほうへ丸める(`-7 ÷ 2` は `-4`) |
| 全角の記号 | `%` `≦` `≧` `≠` `+` などの全角の演算子、`:` `,` も読む。書き出しは半角(余りだけ `%`) |
| 全角英字・全角数字 | 文字列とコメントの外では半角として読む(`x1` は `x1`、`12` は `12`) |
| 入力 | `【外部からの入力】`(答えをそのまま使う)と `【整数を入力】`(整数にする) |
| 要素の追加 | `A に 値 を追加する`(最後に足す。例題に無いので、方針の決め方の ⑤ で決めた) |
| 戻り値 | `値 を返す`(例題に無いので、方針の決め方の ⑤ で決めた) |
Expand Down
Loading
Loading