expr_node.dart 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. /// 结构化表达式模型 —— 计算器的输入不再是字符串,而是一棵树。
  2. ///
  3. /// 为什么值得单独做一套:纯文本光标表达不了多参数结构。用户按了 `∫` 之后
  4. /// 光标该放哪?按 `^` 之后指数该往哪写?用字符串只能靠"插入 `Integrate[, x]`
  5. /// 再把光标往回退 4 位"这种把戏,模板一复杂就散架,分数、上下标更是没法表达。
  6. /// 树 + 槽就没有这个问题。
  7. ///
  8. /// 分工:**计算器用这套结构化输入,控制台继续用纯文本**(长表达式、粘贴、
  9. /// 脚本式输入还是文本方便)。两者序列化后交给同一个求值内核。
  10. library;
  11. /// 表达式节点。
  12. sealed class ExprNode {
  13. const ExprNode();
  14. }
  15. /// 字面量:数字、变量名、常量。用字符串存,因为 `3.14`、`x`、`Pi` 都是文本。
  16. class LitNode extends ExprNode {
  17. final String text;
  18. const LitNode(this.text);
  19. }
  20. /// 函数调用:`name[arg0, arg1, …]`。每个参数是一个槽。
  21. class FuncNode extends ExprNode {
  22. final String name;
  23. final List<SeqNode> args;
  24. FuncNode(this.name, this.args);
  25. }
  26. /// 分式:分子 / 分母。
  27. class FracNode extends ExprNode {
  28. SeqNode num;
  29. SeqNode den;
  30. FracNode({required this.num, required this.den});
  31. }
  32. /// 幂:底 ^ 指数。
  33. class PowNode extends ExprNode {
  34. SeqNode base;
  35. SeqNode exp;
  36. PowNode({required this.base, required this.exp});
  37. }
  38. /// 括号分组 `( … )`。
  39. ///
  40. /// 用独立节点而不是把括号当字面量:括号必须成对且包住一整段,
  41. /// 当字面量的话用户能删掉半个括号,表达式就废了。
  42. class GroupNode extends ExprNode {
  43. SeqNode inner;
  44. GroupNode(this.inner);
  45. }
  46. /// 后缀运算符,目前只有阶乘 `!`。
  47. class PostfixNode extends ExprNode {
  48. SeqNode operand;
  49. final String op;
  50. PostfixNode({required this.operand, this.op = '!'});
  51. }
  52. /// 一个槽 = 一串节点。分式的分子分母、函数的参数、幂的指数都是槽。
  53. class SeqNode {
  54. final List<ExprNode> children;
  55. SeqNode([List<ExprNode>? children]) : children = children ?? <ExprNode>[];
  56. bool get isEmpty => children.isEmpty;
  57. }
  58. /// 光标路径里的一跳:进入第 [child] 个孩子的第 [slot] 个槽。
  59. class SlotStep {
  60. final int child;
  61. final int slot;
  62. const SlotStep(this.child, this.slot);
  63. }
  64. /// 光标位置。空路径 = 根槽;[offset] 是在最终那个槽里的插入位置。
  65. class SlotPath {
  66. final List<SlotStep> steps;
  67. final int offset;
  68. const SlotPath(this.steps, this.offset);
  69. static const root = SlotPath(<SlotStep>[], 0);
  70. SlotPath push(int child, int slot) =>
  71. SlotPath([...steps, SlotStep(child, slot)], 0);
  72. /// 回到父槽,并把光标停在刚才那个孩子之后。
  73. SlotPath? get parent {
  74. if (steps.isEmpty) return null;
  75. final last = steps.last;
  76. return SlotPath(steps.sublist(0, steps.length - 1), last.child + 1);
  77. }
  78. @override
  79. bool operator ==(Object other) {
  80. if (other is! SlotPath || other.offset != offset) return false;
  81. if (other.steps.length != steps.length) return false;
  82. for (var i = 0; i < steps.length; i++) {
  83. if (steps[i].child != other.steps[i].child) return false;
  84. if (steps[i].slot != other.steps[i].slot) return false;
  85. }
  86. return true;
  87. }
  88. @override
  89. int get hashCode =>
  90. Object.hash(offset, Object.hashAll(steps.map((s) => Object.hash(s.child, s.slot))));
  91. }
  92. /// 编辑器文档:持有一棵树和一个光标,并实现所有编辑操作。
  93. ///
  94. /// 可变对象,调用方自己 setState。刻意不做成 ChangeNotifier —— 操作很密集
  95. /// (每敲一个键一次),让页面统一刷新比分发通知更简单也更快。
  96. class ExprDoc {
  97. final SeqNode root = SeqNode();
  98. SlotPath cursor = SlotPath.root;
  99. // ------------------------------------------------------------------ 取槽
  100. /// 按路径找到对应的槽。路径失效时返回根槽。
  101. SeqNode slotAt(SlotPath path) {
  102. var seq = root;
  103. for (final step in path.steps) {
  104. if (step.child < 0 || step.child >= seq.children.length) return root;
  105. final node = seq.children[step.child];
  106. final slots = _slotsOf(node);
  107. if (step.slot < 0 || step.slot >= slots.length) return seq;
  108. seq = slots[step.slot];
  109. }
  110. return seq;
  111. }
  112. static List<SeqNode> _slotsOf(ExprNode node) => switch (node) {
  113. FuncNode f => f.args,
  114. FracNode f => [f.num, f.den], // 0=分子 1=分母
  115. PowNode p => [p.base, p.exp], // 0=底 1=指数
  116. GroupNode g => [g.inner],
  117. PostfixNode p => [p.operand],
  118. LitNode _ => const <SeqNode>[],
  119. };
  120. SeqNode get current => slotAt(cursor);
  121. // ------------------------------------------------------------------ 插入
  122. /// 在当前光标处插入一个节点;[enterSlot] 不为空则顺便把光标移进它的某个槽。
  123. void insert(ExprNode node, {int? enterSlot}) {
  124. final seq = current;
  125. final at = cursor.offset.clamp(0, seq.children.length);
  126. seq.children.insert(at, node);
  127. cursor = enterSlot == null
  128. ? SlotPath(cursor.steps, at + 1)
  129. : _descend(cursor, at, enterSlot);
  130. }
  131. SlotPath _descend(SlotPath from, int child, int slot) =>
  132. from.push(child, slot);
  133. /// 插入一个字符。
  134. ///
  135. /// 数字和小数点会**并进左边那个数字字面量**,而不是各建一个节点 ——
  136. /// 否则 `42` 是两个节点,退格只删最后一位、显示上还分不出是一个数还是两个。
  137. void insertChar(String ch) {
  138. final seq = current;
  139. if (cursor.offset > 0 && seq.children.isNotEmpty) {
  140. final left = seq.children[cursor.offset - 1];
  141. if (left is LitNode && _isNumberText(left.text) && _isNumberChar(ch)) {
  142. seq.children[cursor.offset - 1] = LitNode(left.text + ch);
  143. return;
  144. }
  145. }
  146. insert(LitNode(ch));
  147. }
  148. static bool _isNumberText(String s) =>
  149. s.isNotEmpty && RegExp(r'^[0-9.]+$').hasMatch(s);
  150. static bool _isNumberChar(String c) => RegExp(r'^[0-9.]$').hasMatch(c);
  151. /// 插入一对括号(光标停在里面)。
  152. void makeGroup() => insert(GroupNode(SeqNode()), enterSlot: 0);
  153. /// 把当前槽里光标左边那个节点取出来(没有则返回 null),并把它从槽里摘掉。
  154. ///
  155. /// `^`、`/`、`√` 这些"把前面那个东西变成结构的一部分"的操作靠它实现 ——
  156. /// 这是结构化编辑器和纯文本手感最接近的地方:先打 `x` 再按 `^`,就成了 x 的幂。
  157. ExprNode? takeLeft() {
  158. final seq = current;
  159. if (cursor.offset <= 0 || cursor.offset > seq.children.length) return null;
  160. cursor = SlotPath(cursor.steps, cursor.offset - 1);
  161. return seq.children.removeAt(cursor.offset);
  162. }
  163. /// 制造一个幂:底 = 光标左边那个节点(没有就用空底),光标落到指数上。
  164. void makePower() {
  165. final base = takeLeft();
  166. final node = PowNode(base: SeqNode(base == null ? null : [base]), exp: SeqNode());
  167. insert(node, enterSlot: 1);
  168. }
  169. /// 制造一个分式:分子 = 光标左边那个节点(没有就空着),光标落到分母上。
  170. void makeFraction() {
  171. final num = takeLeft();
  172. final node = FracNode(num: SeqNode(num == null ? null : [num]), den: SeqNode());
  173. insert(node, enterSlot: 1);
  174. }
  175. /// 制造一个根式:被开方数 = 光标左边那个节点(没有就空着)。
  176. void makeSqrt() {
  177. final inner = takeLeft();
  178. insert(FuncNode('Sqrt', [SeqNode(inner == null ? null : [inner])]), enterSlot: 0);
  179. }
  180. /// 制造一个函数调用,光标落在第一个参数槽。
  181. ///
  182. /// [prefill] 每一项对应一个参数:[String] 为空表示**留一个空槽给用户填**,
  183. /// 非空则预置成字面量(例如 `Sum` 的 `{n, 1, Infinity}`)。
  184. void makeFunction(String name, {List<String> prefill = const []}) {
  185. insert(
  186. FuncNode(name, [
  187. for (final p in prefill)
  188. p.isEmpty ? SeqNode() : SeqNode([LitNode(p)]),
  189. if (prefill.isEmpty) SeqNode(),
  190. ]),
  191. enterSlot: 0,
  192. );
  193. }
  194. /// 切到当前函数调用的下一个参数;已经是最后一个就新建一个参数槽。
  195. ///
  196. /// 只能用在函数参数里(光标路径的最后一跳指向某个 FuncNode 的参数槽时)。
  197. void nextArgument() {
  198. if (cursor.steps.isEmpty) return;
  199. final here = cursor.steps.last;
  200. final parent = SlotPath(cursor.steps.sublist(0, cursor.steps.length - 1), 0);
  201. final siblings = slotAt(parent);
  202. if (here.child >= siblings.children.length) return;
  203. final node = siblings.children[here.child];
  204. if (node is! FuncNode) return;
  205. var target = here.slot + 1;
  206. if (target >= node.args.length) {
  207. node.args.add(SeqNode());
  208. target = node.args.length - 1;
  209. }
  210. cursor = parent.push(here.child, target);
  211. }
  212. // ------------------------------------------------------------------ 删除
  213. /// 槽里还有没填的空位("还没填完的模板")。
  214. static bool _incomplete(ExprNode n) => _slotsOf(n).any((s) => s.isEmpty);
  215. /// 退格。
  216. ///
  217. /// 三条规则,都是为了"手感":
  218. /// 1. 数字字面量**逐位删** —— 计算器按退格是删一位,不是把整个数清掉。
  219. /// 2. 左边是**还没填完的模板**(还有空槽)就钻进去删,而不是整个删掉 ——
  220. /// 用户按了 `∫` 后悔,一按退格整块模板没了会很难受。
  221. /// 3. 左边是**已经填完的模板**就整个删掉 —— 否则光标会永远在模板内部打转,
  222. /// 根本删不掉它。
  223. void backspace() {
  224. final seq = current;
  225. if (cursor.offset > 0 && seq.children.isNotEmpty) {
  226. final node = seq.children[cursor.offset - 1];
  227. // 规则 1
  228. if (node is LitNode && _isNumberText(node.text) && node.text.length > 1) {
  229. seq.children[cursor.offset - 1] =
  230. LitNode(node.text.substring(0, node.text.length - 1));
  231. return;
  232. }
  233. final slots = _slotsOf(node);
  234. if (slots.isEmpty) {
  235. seq.children.removeAt(cursor.offset - 1);
  236. cursor = SlotPath(cursor.steps, cursor.offset - 1);
  237. return;
  238. }
  239. if (_incomplete(node)) {
  240. // 规则 2:钻进最后一个空槽
  241. final i = slots.lastIndexWhere((s) => s.isEmpty);
  242. cursor = cursor.push(cursor.offset - 1, i);
  243. return;
  244. }
  245. // 规则 3
  246. seq.children.removeAt(cursor.offset - 1);
  247. cursor = SlotPath(cursor.steps, cursor.offset - 1);
  248. return;
  249. }
  250. // 已经在槽的最左边:退回父槽
  251. final up = cursor.parent;
  252. if (up == null) return; // 根槽最左边,没得删
  253. final parentSeq = slotAt(SlotPath(up.steps, up.offset));
  254. final idx = up.offset - 1;
  255. if (idx >= 0 && idx < parentSeq.children.length) {
  256. final child = parentSeq.children[idx];
  257. // 从"还没填完的模板"里退出来时,顺手把它也删掉
  258. if (_incomplete(child)) {
  259. parentSeq.children.removeAt(idx);
  260. cursor = SlotPath(up.steps, idx);
  261. return;
  262. }
  263. }
  264. cursor = up;
  265. }
  266. void clear() {
  267. root.children.clear();
  268. cursor = SlotPath.root;
  269. }
  270. // ------------------------------------------------------------------ 序列化成 Symja
  271. /// 整棵树 → 一条 Symja 表达式。
  272. String toSymja() => serializeSeq(root);
  273. /// 槽 → 表达式。空槽在 Symja 里写成 `Null`,求值时会明确报错而不是静默算错。
  274. String serializeSeq(SeqNode seq) {
  275. if (seq.isEmpty) return 'Null';
  276. return seq.children.map(serialize).join();
  277. }
  278. String serialize(ExprNode node) => switch (node) {
  279. LitNode l => l.text,
  280. FuncNode f =>
  281. '${f.name}[${f.args.map(serializeSeq).join(', ')}]',
  282. FracNode f => '${_grouped(serializeSeq(f.num))}/${_grouped(serializeSeq(f.den))}',
  283. PowNode p => '${_grouped(serializeSeq(p.base))}^${_grouped(serializeSeq(p.exp))}',
  284. GroupNode g => '(${serializeSeq(g.inner)})',
  285. PostfixNode p => '${_grouped(serializeSeq(p.operand))}${p.op}',
  286. };
  287. /// 复合结构当操作数时要加括号,否则 `x+1` 当分母会算错优先级。
  288. String _grouped(String s) {
  289. if (s.isEmpty) return s;
  290. final needsParens = s.contains(RegExp(r'[+\-*/^]')) ||
  291. (s.contains(' ') && s.contains(','));
  292. return needsParens ? '($s)' : s;
  293. }
  294. }