オープンな実装言語仕様 日本語トランスコンパイラ言語 Re:Mind（リマインド）2022 Lv1ドラフト

# はじめに
Qiitaに参加して、そろそろちょうど一か月となります。参加して感じたのはQiitaな人には自作言語のコンパイラやトランスコンパイラをさらっと実装してしまう方が多いということです。

そこでわたしのような実装が得意とは言い難いものがだらだら実装するよりも、広く実装を自由にしていただいた方が世のためとなるような気がしてきました。

自作言語 Re:Mind（リマインド）の企画趣旨はQiita内の[記事](https://qiita.com/mylifewithviolin/items/9d58db8a101807c19bde)でご説明させてきてはおりますので、興味をもたれた方、言語仕様を気に入っていただいた方で腕に覚えのあるなしにかかわらず、こんなの実装しましたよとまた記事にしていただければ幸いです。

## この記事内容の作業目的
自作言語Re:Mindの構文仕様策定の節目として、昨年までに考案した内容をドラフトとしてまとめます。

## この記事内容の保証
※この記事には仕様的な情報が含まれます。自作言語はまだ設計開発中のため、発案者による実装は存在しません。本記事に開示された仕様は次バージョンの仕様においては予告なく変更される場合があります。また、このバージョンの仕様内で補足や追加がなされる場合があります。

# 概要
日本語トランスコンパイラ言語 Re:Mind（リマインド）はオープンな実装言語仕様で、どなたでもコンパイラ・トランスコンパイラを実装することができます。

オリジナルのランタイムコード、既存の中間コードなどへのコンパイラとしての実装を退けるものではありませんが、今日のシステム開発言語の多様化に鑑みて、それらの言語環境との相互運用性を容易としプログレッシブな導入を実現するため、他のプログラミング言語をターゲット言語とするトランスコンパイラとして実装することを推奨しています。

日本語トランスコンパイラ言語 Re:Mindは、リスペクトしてやまない第1世代日本語プログラミング言語 Mind（マインド）や後の日本語プログラミング言語と同じく、日本語を基調とした構文を採用し、英語のプログラミング言語にありがちな「;」や「{}」などの特殊な文字を区切りとして使用しない点を共有しつつ、半角かっこ内や一部の構文はターゲット言語のシンタックスを許容するとします。

また、日本語トランスコンパイラ言語 Re:Mindは、制御構文の開始シンボルとして、◇、〇、・、□などの全角記号を用い、箇条書きされた日本文としての体裁を[日本語ロジック記述言語 Re:Mind](https://qiita.com/mylifewithviolin/items/52f806777e6ea031de94)の構文とも共有しています。◇は分岐構文、〇はループ構文の開始と終了を表し、冗長な日本語表記がなくてもフロー図の表現に慣れている方が直感的に認識できることを考慮しています。

## 推奨・想定されるターゲット言語
### C言語のシンタックスを共有・継承する以下の静的型付け言語
・Java
・C#
・TypeScript
・Go
 
### 英語を基調とした以下のBASIC言語
・Visual Basic for Application (Excel)
・Visual Basic.NET

### より自然な日本語構文を特徴とする以下の日本語プログラミング言語
・Mind
・プロデル
・なでしこ

## 推奨・想定される実装言語
・とくにありません。好きな言語、得意とする言語で実装してください。

# 言語仕様
## 変数
```mind:Re:Mind
    /** nenrei */
    ・int 年齢 = 34

    /** namae */
    ・string 名前 = "花子"

    /** tokutaiKubun */
    ・bool 特待区分 = true 
```
□全角文字の中点に続いて、ターゲット言語の物理型名を半角文字で記述し、半角空白に続いて変数名を記述します。
・直前の行はjava doc形式のコメントで、ターゲット言語上の変数名を半角文字で記述します。書かない場合は、日本字のまま変数名となります。
・半角等号で初期値を代入できます。

```mind:Re:Mind
    /** nenrei */
    ・変数int 年齢

    /** namae */
    ・public string 名前

    /** tokutaiKubun */
    ・変数private bool 特待区分 = true 
```
□全角中点に続いて「変数」と書くこともできます。後述の定数と並んだ時の見栄え、わかりやすさのため、変数宣言であることを明示。
・ターゲット言語のスコープを型名の前に書くことも可能。全角中点または「変数」とはくっついていて可。
## 定数
```mind:Re:Mind
    /** nenrei */
    ・定数int 年齢 = 34

    /** namae */
    ・定数string 名前 = "花子"

    /** tokutaiKubun */
    ・定数public bool 特待区分 = true 
```
□全角文字の中点に続いて「定数」と書き、続いてターゲット言語の物理型名を半角文字で記述し、半角空白に続いて定数名を記述します。
・直前の行はjava doc形式のコメントで、ターゲット言語上の定数名を半角文字で記述します。書かない場合は、日本字のまま変数名となります。
・半角等号で初期値を必ず代入します。
・ターゲット言語のスコープを型名の前に書くことも可能。全角中点または「定数」とはくっついていて可。


## 関数
### 関数の実行
```mind:Re:Mind
    □年齢 = メンバーの年齢を取得する(名前,特待区分)
    □(名前,特待区分)で メンバーの年齢を設定する
```
◇値を返す関数の場合、全角記号の四角□に続いて、戻り値を受け取る変数名を記述し、半角等号に続いて関数名を記述します。
・続いて半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。

◇値を返さない関数の場合、全角記号の四角□に続いて、半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。
・半角かっこで閉じた後、続けて関数名を書くことができます。
半角かっこで閉じた後、続けて「で」や「を」を付加し、半角空白を挟んで関数名を書くこともできます。このひらがなは無視します。

### 値を返す関数の宣言
```mind:Re:Mind
    /**
    * getMembersAge
    * @param 名前 name
    * @param 特待区分 kubun
    * @return 年齢
    */
    ▽public int メンバーの年齢を取得する(string 名前,bool 区分)
         //todo
        □(齢)を 返す
    △

```
□全角記号の下三角▽が関数宣言の開始となります。
・続いてターゲット言語のスコープを書きます。省略も可。
・続いて半角空白をおいて、ターゲット言語の戻り値型を書きます。戻り値あり関数としては省略不可。
・続いて半角空白をおいて、関数名を書きます。
・続いて半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。
・全角記号の上三角△で定義を終了します。
・かならず、定義終了前に全角四角に続き、変数名に空白を挟んで「返す」と記述するとします。
・全角四角に続き、「return」と書いて、半角空白ののちに変数名を記述でも可とします。

・全角記号の下三角▽直前の行はjava doc形式のコメントで、ターゲット言語上の関数名を半角文字で記述します。書かない場合は、日本字のまま関数名となります。
・コメントの終端までの間、@paramに続いて変数名を書き、続いてターゲット言語上の変数名を半角文字で記述します。書かない場合は、日本字のまま変数名となります。


### 値を返さない関数の宣言
```mind:Re:Mind
    /**
    * memberNenreiSettei
    * @param 名前 name
    * @param 特待区分 kubu
    */
    ▽private メンバーの年齢を設定する(string 名前,bool 区分)
         //todo
    △
```
□全角記号の下三角▽が関数宣言の開始となります。
・続いてターゲット言語のスコープを書きます。省略も可。
・続いて半角空白をおいて、関数名を書きます。
・続いて半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。
・全角記号の上三角△で定義を終了します。

・全角記号の下三角▽直前の行はjava doc形式のコメントで、ターゲット言語上の関数名を半角文字で記述します。書かない場合は、日本字のまま関数名となります。
・コメントの終端までの間、@paramに続いて変数名を書き、続いてターゲット言語上の変数名を半角文字で記述します。書かない場合は、日本字のまま変数名となります。

## クラス
### クラスの宣言
```mind:Re:Mind
    /**
    * MembersLogic : AbstractLogic
    */
    ▽public class メンバーの取り扱い方 : 取り扱い方

        ・変数int 年齢
        ・変数public string 名前
        ・変数private bool 特待区分
    
        ▽public int メンバーの年齢を取得する(string 名前,bool 区分)
             //todo
            □(齢)を 返す
        △
    
        ▽private メンバーの年齢を設定する(string 名前,bool 区分)
             //todo
        △

    △

```
□全角記号の下三角▽がクラス宣言の開始となります。
・続いてターゲット言語のスコープを書きます。省略も可。
・続いて半角空白をおいて、ターゲット言語のクラス表記を書きます。ここは全角カタカナで「クラス」と書いても可。
・続いて半角空白をおいて、クラス名を書きます。
・続いて半角空白をおいて、ターゲット言語のクラス継承表記を書きます。その後は半角空白をおいて、継承元のクラス名を書きます。継承しない場合はこれらの記述は省略可です。
・クラスのメンバの書き方は変数宣言、関数宣言に準じます。上記の記述例では個々の変数宣言、java docコメントの記述を割愛しています。
・全角記号の上三角△で定義を終了します。

・全角記号の下三角▽直前の行はjava doc形式のコメントで、ターゲット言語上のクラス名を半角文字で記述します。書かない場合は、日本字のままクラス名となります。
・継承元クラスがある場合は、半角空白の後にコロン:、続けて半角空白の後にターゲット言語上の継承元クラス名を半角文字で記述します。継承があるのに書かない場合は、日本字のまま継承元のクラス名となります。
### クラスのインスタンス宣言
```mind:Re:Mind
    /** membersLogic */
    ・メンバーの取り扱い方 メンバー取り扱い方法 = new()
```
□クラスのインスタンス名は同じ主旨の別名としてください。
・コンストラクタにオーバーロードがある場合は、かっこ内にターゲット言語の記法で記述します。

### クラスのインスタンスの変数操作
```mind:Re:Mind
    □年齢 = メンバー取り扱い方法.年齢
    □メンバー取り扱い方法.年齢 = 年齢
```
□クラスのインスタンス名の装飾子は半角ドットです。

```mind:Re:Mind
    □年齢 = メンバー取り扱い方法?.年齢
    □メンバー取り扱い方法.年齢 = 年齢 ?? 0
```
・Null条件演算子はターゲット言語が対応している場合は使用可とします。
・Null合体演算子はターゲット言語が対応している場合は使用可とします。
対応していない言語の場合は同等構文を展開するのが望ましい

### クラスのインスタンスの関数実行
```mind:Re:Mind
    □年齢 = メンバー取り扱い方法.メンバーの年齢を取得する(名前,特待区分)
    □(名前,特待区分)で メンバー取り扱い方法.メンバーの年齢を設定する
```
□クラスのインスタンス名の装飾子は半角ドットです。
・Null条件演算子はターゲット言語が対応している場合は使用可とします。

◇値を返す関数の場合、全角記号の四角□に続いて、戻り値を受け取る変数名を記述し、半角等号に続いてクラスのインスタンス名と関数名を半角ドットを挟んで記述します。
・続いて半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。

◇値を返さない関数の場合、全角記号の四角□に続いて、半角かっこを設け、ターゲット言語の物理型名と変数名を半角空白を挟んで、カンマ区切りで記述し、半角かっこで閉じます。
・半角かっこ内はターゲット言語の記法を可とします。参照渡しの明示や、既定値設定など、ターゲット言語の構文記述ができるとします。
・半角かっこで閉じた後、続けてクラスのインスタンス名と関数名を半角ドットを挟んで書くことができます。
半角かっこで閉じた後、続けて「で」や「を」を付加し、半角空白を挟んで関数名を書くこともできます。このひらがなは無視します。

## 四則演算、論理演算
・ターゲット言語のシンタックスに準じます。中置記法
・ただし、ターゲット言語がjavaの場合でもBigDecimal同士のメソッドによる四則演算は通常の四則演算子で表記できるとします。

## 制御構文
### 分岐

```mind:Re:Mind
    ◇i > 0 の場合
        //todo
    ◇ここまで
```
□全角記号のひし形◇が条件分岐の開始となります。
・続いてターゲット言語の論理式を書きます。半角かっこは不要。
・続いて「の場合」と書きます。半角で書かれた論理式とはくっついていても可。
・全角記号のひし形◇が条件分岐の終了となります。
・つづいて「ここまで」と書くことができます。省略も可。

```mind:Re:Mind
    ◇i > 0 の場合
        //todo
    ◇他に i < 0 の場合
        //todo
    ◇他に
        //todo
    ◇ここまで
```
◇途中で最初の論理式とは排他的な条件をつづける場合は、全角ひし形◇に続いて「他に」と書いて、論理式を書いて、「の場合」と書きます。
・論理式の前後の空白は、論理式を半角で書いている場合は省略できます。
◇最後に例外条件を明示する場合は、全角ひし形◇に続いて「他に」と書きます。

```mind:Re:Mind
    ◇i > 0 の場合
        ◇j == 0 の場合
            //todo
        ◇他に
            //todo
        ◇ここまで
        //todo
    ◇他に i < 0 の場合
        //todo
    ◇他に
        //todo
    ◇ここまで
```
□おなじ分岐構文を使って、入れ子で記述することができます。

### 繰り返し


```mind:Re:Mind
    〇int i=0,i<10,i++ 繰り返す
        //todo
    〇ここまで
```
□全角記号の丸印〇が繰り返しの開始となります。
・続いてターゲット言語のカウンタ論理式をカンマ区切りで書きます。半角かっこは不要。セミコロン区切りも可。
・続いて「繰り返す」と書きます。半角で書かれた論理式とはくっついていても可。
・全角記号の丸印〇が繰り返しの終了となります。
・つづいて「ここまで」と書くことができます。省略も可。
```mind:Re:Mind
    〇繰り返す
        //todo
    〇ここまで
```
□全角記号の丸印〇に続いて「繰り返す」と書いた場合は無限ループになります。
```mind:Re:Mind
    〇繰り返す
        //todo
        ◇j==0 の場合 やめる
        //todo
    〇ここまで
```
・繰り返し構文内で条件分岐文を書いて「やめる」と書くと、直接のループを脱出します。
```mind:Re:Mind
    /** index */
    〇int インデックス=0,インデックス<10,インデックス++ 繰り返す
        //todo
    〇ここまで
```
□繰り返し構文のカウンタ変数をインラインで日本字で宣言した場合、java docでターゲット言語上の表記を半角英字で書いておきます。

```mind:Re:Mind
〇(i<10) の間は繰り返す
        //todo
〇ここまで
```
□while(i<10) のような構文の表記です。

```mind:Re:Mind
〇(i<10) の間は繰り返す
    ◇i<2 の場合
        □ループ先頭へ
        //todo
〇ここまで
```
□条件分岐と合わせて、ループ先頭に制御を移す場合は「ループ先頭へ」を使います。

## コメント
### 通常コメント
```cs:Re:Mind
    //todo
```
□ダブルスラッシュ//で行末までコメントアウトします。
```cs:Re:Mind
/*
    todo
    todo
*/
```
□スラッシュとアスタリスク/*でコメント行開始、アスタリスクとスラッシュ*/でコメント行の終了。
### ターゲット言語上での半角英字名の指定
```mind:Re:Mind
    /** nenrei */
    ・int 年齢 = 34

    /** 
    * namae 
    */
    ・string 名前 = "花子"

    /**
    * memberNenreiSettei
    */
    ▽private メンバーの年齢を設定する(string 名前,bool 区分)
    △

    /**
    * MembersLogic : AbstractLogic
    */
    ▽public class メンバーの取り扱い方 : 取り扱い方
    △

```
□javadocと同じ/**   */で半角英字を囲って、変数宣言文、関数宣言文、クラス宣言の直前に記述することで、ターゲット言語上の英字名を指定できます。
```mind:Re:Mind
    /**
    * memberNenreiSettei
    * @param 名前 name
    * @param 特待区分 kubu
    */
    ▽private メンバーの年齢を設定する(string 名前,bool 区分)
         //todo
    △
```
@paramに続いて、日本字の引数名、半角空白に続いて英字名を記述することで、引数名のターゲット言語上の英字名を指定できます。

## ターゲット言語のライブラリの引用の仕方

□今日のシステム開発に使われる有力言語は巨大なライブラリを保持しておりますが、利用の際には名前空間を指定したり、パッケージを指定したりして、予め利用する範囲を指定するが一般的です。
・また言語によっては、利用する関数、変数単位でインポートするものもあります。
□そこでRe:Mindはあらかじめタ－ゲット言語の全方位のライブラリをサポートすることはせず、一定のルールで利用可とできる構文を提供します。
◇開発ユーザーがターゲット言語を理解している場合は、ターゲット言語で直接記述することも可とし、ターゲット言語との相互運用に有利な環境を提供します。
```mind:Re:Mind
  ■using System
  ▼public static class コンソール Console

    ▼public static System.Text.Encoding 入力エンコード
        InputEncoding { get; set; }
    ▲
    ▼public static string? 次の1行を読み取る()
        ReadLine ()
    ▲
    ▼public static 改行表示する(string? value)
        WriteLine (string? value)
    ▲
 ▲
```
□全角黒四角■に続いてターゲット言語のインポート文を記述します。セミコロンは書かなくても可。
・全角下三角▼に続いてターゲット言語のターゲットクラスを宣言し、クラス名の直前に日本字のクラス名を記述します。
・通常のクラス定義と同様に全角上三角▲が定義の終了となります。
・この間に、ターゲット言語の利用対象のターゲット関数・変数を全角下三角▼と全角上三角▲挟んで宣言します。
・全角下三角▼に続いてターゲット言語の構文で関数、変数を宣言しますが、関数名・変数名は日本字を記述します。
・関数の引数仕様はターゲット言語の仕様情報の記述のままとします。引数名は日本字にしない。
・戻り値のない関数はvoidは省略可。
・C#の変数の { get; set; }は英字側に記述。省略可。
・改行してターゲット言語の関数・変数を英字オリジナルで宣言します。
・関数の引数仕様はターゲット言語の仕様情報の記述のままとします。

# おわりに
:::note warn
日本語トランスコンパイラ言語 Re:Mind（リマインド）2022 Lv1ドラフトは、2022 Lv1で確定しました。最新情報は下記のリンクへ移動してください。
:::

https://qiita.com/mylifewithviolin/items/9a6abbab62c0f5e27d4b

わたしも、次のバージョン（2023 Lv1）策定にむけて不足要件を追記して参ります。


# 参考リンク
https://qiita.com/mylifewithviolin/items/9d58db8a101807c19bde

https://qiita.com/mylifewithviolin/items/89ac25290d2c684dd5cc

https://qiita.com/mylifewithviolin/items/739d5b792f2f9d4e14fc

https://qiita.com/mylifewithviolin/items/d15fdf16c6a66bdcf5b1