sml

SML { ❄ }

下载页 问题反馈、使用疑问,或随便聊聊: QQ 群 · 点击加入 sal@mail.swebase.cn 中文 EN

第 7 章:多语言使用

SML 是格式,要"用起来"得靠宿主语言解析它。各语言实现互不耦合、可单独嵌入(WASM / 沙箱 / 编辑器都行)。下面给出最常用的几种集成方式。

先说清楚适用范围:只有 Rust 实现(swsml)是参考实现并持续维护——语法、契约、漏洞扫描与回归测试都以它为准,生产请用 Rust。 C / JavaScript / Lua(Soup)/ C++ / Python 属实验性实现,暂不保证与 Rust 行为一致、不保证 API 稳定、不纳入例行漏洞扫描与回归测试。本章中标注「已与 Rust 对齐」的内容为历史对齐结论,仅作参考。

7.1 Rust(swsml)

use sml::parse;
let v = parse("name: John\nage: 27").unwrap();
assert_eq!(v["name"], "John");

带文件 include:

use sml::parse_file;
let v = parse_file("app.sml")?;

serde 桥接(可选 feature):

# Cargo.toml
sml-rs = { version = "0.2", features = ["serde"] }
use sml::{parse, Value};
let v = parse("name: John\nage: 27")?;
let json = serde_json::to_string(&v)?;   // {"name":"John","age":27}

Value 手写实现了 Serialize/Deserialize,序列化为自然的 27 而非 {"Int":27}。不启用 serde 时 crate 零依赖。

7.2 C(sml.c)

#include "sml.h"
char err[256] = {0};
sml_value *v = sml_parse("name: John\nage: 27", err, sizeof(err));
/* v->type == SML_STR ("John") ... 用 sml_free(v) 释放 */

契约系统曾与 Rust 100% 对齐(同一份 CONFIG_CONTRACT 四端行为一致);请注意 C 实现现为实验性、暂不保证。

7.3 JavaScript(sml.mjs)

零依赖 ESM,浏览器 / Node 通用,含契约与 Playground:

import { parse, stringify } from "./sml.mjs";
const v = parse('name: John\nage: 27');
console.log(stringify(v));

SML ↔ JSON 互转(两者同构):

const obj = parse(smlText);              // 普通 JS 对象
const json = JSON.stringify(obj);
const sml = stringify(JSON.parse(json));

7.4 Lua / Soup(lib/sml.soup)

local sml = require("lib.sml")
local v, err = sml.load(text)   -- 解析
print(sml.dump(v))              -- 序列化
soupx lua/sml.sar config.sml     # 解析并打印

7.5 其他

错误码:五端同码

同一类错误在 Rust / C / C++ / JS / Lua 里报同一个码(形如 E-CONTRACT-002)。 所以不必记各端的措辞:记码就够了 —— 错误码总表 是唯一入口。 码的唯一事实来源是仓库里的 errors/codes.sml(当前 141 条),由生成脚本分发到各端常量; 取码的方式则各不相同:Rust 是 Display 后缀(文案 [E-XXX-NNN]),C / C++ / Lua 把码 写在消息前缀,JS 是错误对象的 e.code 字段。

由此带来的一类变化值得先知道:一批此前「能解析」的输入现在会带码报错。它们过去之所以 “能解析”,是因为解析出的树本来就是错的(未闭合字符串、数组里多余的 }、未定义片段引用、 顶层标量,都会静默给出一颗错树)。宁可响亮地拒绝,也不要静默给假数据。

本轮各端的进展(同一件事的几个工作面):

7.6 选哪个?

你在写 用 保证
Rust 程序 / 命令行工具 swsml ✅ 参考实现,生产推荐
嵌入式 / 系统层 C / C++ ⚠️ 实验性,暂不保证
前端 / Node 服务 sml.mjs ⚠️ 实验性,暂不保证
Soup 生态 / 脚本 lib/sml.soup ⚠️ 实验性,暂不保证

→ 第 8 章:实战项目

动手练习

读完本章,在下面的编辑器里直接修改 SML 并点“运行”,立刻看到解析结果或校验错误——有输出才能高效学习。

✍ 动手练习 定义 @contract User { id: str, email: str, role: enum(user,admin,owner) default user },用 @is User 写数据(id=u_1, email=a@b.c),验证 role 自动取默认 user。
💡 提示:同一份契约在 Rust/C/JS/Lua 行为一致——改 role 为 owner 试试。
✍ 自测考题:第 7 章自测:多语言使用 得分 0 / 3
Q1. SML 契约在多种语言里的行为是?
Q2. 判断:同一份 SML 文件,用 Rust 和 Lua 解析,得到的字段名和嵌套结构应完全相同。
Q3. 在 JS 里调用解析器通常用哪个导出?