【Rust】TOMLで関数を自由に追加！自作電卓に設定読み込みとホットリロードを実装する #3

前回は、入力された数式を「意味のある塊」に分けるLexerを実装しました。次に必要なのは、その塊が「定数なのか、関数なのか」を判断するための辞書です。
今回は、TOMLファイルを使って誰でも簡単に関数を拡張できる Definitions（定義管理） 機能を実装します。

前回 Lexerの実装 : 【Rust】自作計算機エンジンへの道：Lexer（字句解析）で数式をトークンに分解する #2

1. tomlで読み込ませたいもの

普通の電卓なら標準関数（sin, cosなど）があれば十分ですが、この電卓のコンセプトは 「自分専用の環境構築」 です。

物理定数（pi, e, eVなど）を自由に追加したい
よく使う独自の計算式（畳み込みのサイズ計算など）を関数として登録したい
コードを書き換えずに、設定ファイルを追加するだけで機能を増やしたい

これらを実現するために、Rustと親和性の高いTOMLを採用しました。

2. 実装 Definitions : Serdeを使い倒す

Definitionsのとれる値は数値か、関数になります。

pub struct Definitions {
    pub constants: HashMap<String, f64>,
    pub functions: HashMap<String, FunctionDef>,
}

tomlのロード自体は、 toml::from_str(&content)?;　といった感じで、tomlのパサーをそのまま利用しました。

pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn std::error::Error>> {
    let content = fs::read_to_string(path)?;
    let defs: Definitions = toml::from_str(&content)?;
    Ok(defs)
}

柔軟な定義を可能にする `#[serde(untagged)]`

このほかちょっと工夫したところとして、TOMLをある程度自由に書けるようにserde(untagged) をつかっています。これを使うことで、エイリアス風の記述と、変数定義からするしっかりとした記述両方拾えるようになっています。また、読み込みの深さをデフォルトで32にしており、再帰読み込みのバグなどで固まるのを防ぐようにしています。

// 関数定義構造体

#[derive(Debug, Deserialize, Clone)]
#[serde(untagged)]
pub enum FunctionDef {
    Simple(String),
    Complex {
        args: Vec<String>,
        expr: String,
        #[serde(default)]
        memoize: bool,
        #[serde(default = "default_depth")]
        max_depth: usize,
    },
}

fn default_depth() -> usize { 32 }

標準 definitions.toml

基本的なものは、definitions.tomlに記入していくことにしています。ユーザ定義のものは user.tomlとかの別ファイルで定義し、tomlの入っているフォルダを自動的に走査して読み込めるようにする予定です。

[constants]
pi = 3.1415926535
e = 2.71828

[functions]
# 式というかエイリアスの定義
golden_ratio = "1.61803"

# 引数を明示する定義にしています
conv = { args = ["W", "K"], expr = "W - K + 1" }

definitions.tomlに記入した例