From e03390b1ae3fcebb8ff42cf10abf3bbe44400f24 Mon Sep 17 00:00:00 2001 From: Karsten Schmidt Date: Thu, 3 Jan 2019 00:13:45 +0000 Subject: [PATCH] feat(fsm): import fsm package --- packages/fsm/.npmignore | 11 ++ packages/fsm/LICENSE | 201 ++++++++++++++++++++++++++++++++ packages/fsm/README.md | 59 ++++++++++ packages/fsm/package.json | 42 +++++++ packages/fsm/src/alts.ts | 35 ++++++ packages/fsm/src/api.ts | 28 +++++ packages/fsm/src/fsm.ts | 29 +++++ packages/fsm/src/index.ts | 7 ++ packages/fsm/src/range.ts | 46 ++++++++ packages/fsm/src/seq.ts | 35 ++++++ packages/fsm/src/str.ts | 26 +++++ packages/fsm/src/until.ts | 24 ++++ packages/fsm/test/index.ts | 6 + packages/fsm/test/tsconfig.json | 10 ++ packages/fsm/tsconfig.json | 9 ++ 15 files changed, 568 insertions(+) create mode 100644 packages/fsm/.npmignore create mode 100644 packages/fsm/LICENSE create mode 100644 packages/fsm/README.md create mode 100644 packages/fsm/package.json create mode 100644 packages/fsm/src/alts.ts create mode 100644 packages/fsm/src/api.ts create mode 100644 packages/fsm/src/fsm.ts create mode 100644 packages/fsm/src/index.ts create mode 100644 packages/fsm/src/range.ts create mode 100644 packages/fsm/src/seq.ts create mode 100644 packages/fsm/src/str.ts create mode 100644 packages/fsm/src/until.ts create mode 100644 packages/fsm/test/index.ts create mode 100644 packages/fsm/test/tsconfig.json create mode 100644 packages/fsm/tsconfig.json diff --git a/packages/fsm/.npmignore b/packages/fsm/.npmignore new file mode 100644 index 0000000000..ec83d74c9d --- /dev/null +++ b/packages/fsm/.npmignore @@ -0,0 +1,11 @@ +build +coverage +dev +doc +export +src* +test +.nyc_output +tsconfig.json +*.tgz +*.html diff --git a/packages/fsm/LICENSE b/packages/fsm/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/fsm/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/fsm/README.md b/packages/fsm/README.md new file mode 100644 index 0000000000..ba67ade7f1 --- /dev/null +++ b/packages/fsm/README.md @@ -0,0 +1,59 @@ +# @thi.ng/fsm + +[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/fsm.svg)](https://www.npmjs.com/package/@thi.ng/fsm) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/fsm.svg) +[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + +- [About](#about) +- [Status](#status) +- [Installation](#installation) +- [Dependencies](#dependencies) +- [Usage examples](#usage-examples) +- [Authors](#authors) +- [License](#license) + + + +## About + +Primitives for building transducer based Finite-State machines and +parsers (not necessarily text based). + +See the [minimal markdown parser +example](https://github.com/thi-ng/umbrella/tree/feature/fsm/examples/markdown) +for a concrete use case. + +## Status + +ALPHA. + +## Installation + +```bash +yarn add @thi.ng/fsm +``` + +## Dependencies + +- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api) +- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/master/packages/errors) +- [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/master/packages/transducers) + +## Usage examples + +```ts +import * as fsm from "@thi.ng/fsm"; +``` + +## Authors + +- Karsten Schmidt + +## License + +© 2018 Karsten Schmidt // Apache Software License 2.0 diff --git a/packages/fsm/package.json b/packages/fsm/package.json new file mode 100644 index 0000000000..b38fc5ad46 --- /dev/null +++ b/packages/fsm/package.json @@ -0,0 +1,42 @@ +{ + "name": "@thi.ng/fsm", + "version": "0.0.1", + "description": "TODO", + "main": "./index.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/fsm", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn run clean && tsc --declaration", + "clean": "rm -rf *.js *.d.ts .nyc_output build coverage doc", + "cover": "yarn test && nyc report --reporter=lcov", + "doc": "node_modules/.bin/typedoc --mode modules --out doc src", + "pub": "yarn run build && yarn publish --access public", + "test": "rm -rf build && tsc -p test && nyc mocha build/test/*.js" + }, + "devDependencies": { + "@types/mocha": "^5.2.5", + "@types/node": "^10.12.15", + "mocha": "^5.2.0", + "nyc": "^13.1.0", + "typedoc": "^0.13.0", + "typescript": "^3.2.2" + }, + "dependencies": { + "@thi.ng/api": "^4.2.4", + "@thi.ng/errors": "^0.1.12", + "@thi.ng/transducers": "^2.3.2" + }, + "keywords": [ + "ES6", + "typescript" + ], + "publishConfig": { + "access": "public" + } +} \ No newline at end of file diff --git a/packages/fsm/src/alts.ts b/packages/fsm/src/alts.ts new file mode 100644 index 0000000000..40bbc8f56b --- /dev/null +++ b/packages/fsm/src/alts.ts @@ -0,0 +1,35 @@ +import { Match, RES_FAIL, RES_PARTIAL, Matcher, ResultBody } from "./api"; + +export const alts = ( + opts: Matcher[], + fallback?: (ctx: C, buf: T[]) => ResultBody, + callback?: (ctx: C, next: ResultBody, buf: T[]) => ResultBody +): Matcher => + () => { + const alts = opts.map((o) => o()); + const buf: T[] = []; + return (ctx, x) => { + for (let i = alts.length; --i >= 0;) { + const next = alts[i](ctx, x); + if (next.type === Match.FULL) { + return callback ? + { + type: Match.FULL, + body: callback(ctx, next.body, buf) + } : + next; + } else if (next.type === Match.FAIL) { + alts.splice(i, 1); + } + } + fallback && buf.push(x); + return alts.length ? + RES_PARTIAL : + fallback ? + { + type: Match.FULL, + body: fallback(ctx, buf) + } : + RES_FAIL; + }; + }; diff --git a/packages/fsm/src/api.ts b/packages/fsm/src/api.ts new file mode 100644 index 0000000000..084ee24e4b --- /dev/null +++ b/packages/fsm/src/api.ts @@ -0,0 +1,28 @@ +export const enum Match { + PARTIAL = 0, + FULL = 1, + FAIL = -1 +} + +export interface MatchResult { + type: Match; + body?: ResultBody; +} + +export type Matcher = + () => (ctx: C, x: T) => MatchResult; + +export type ResultBody = + [number | string, T[]?]; + +export type AltCallback = + (ctx: C, next: ResultBody, x: T[]) => ResultBody; + +export type RangeCallback = + (ctx: C, x: T) => ResultBody; + +export type SeqCallback = + (ctx: C, buf: T[]) => ResultBody; + +export const RES_PARTIAL = Object.freeze({ type: Match.PARTIAL }); +export const RES_FAIL = Object.freeze({ type: Match.FAIL }); diff --git a/packages/fsm/src/fsm.ts b/packages/fsm/src/fsm.ts new file mode 100644 index 0000000000..aa50a0956d --- /dev/null +++ b/packages/fsm/src/fsm.ts @@ -0,0 +1,29 @@ +import { IObjectOf } from "@thi.ng/api"; +import { illegalState } from "@thi.ng/errors/illegal-state"; +import { reduced } from "@thi.ng/transducers/reduced"; +import { mapcat } from "@thi.ng/transducers/xform/mapcat"; +import { Match, Matcher } from "./api"; + +export const fsm = ( + states: IObjectOf>, + ctx: C, + init: string | number = "start" +) => { + let currID = init; + let curr = states[init](); + return mapcat((x) => { + const { type, body } = curr(ctx, x); + if (type === Match.FULL) { + const next = states[body[0]]; + if (next) { + currID = body[0]; + curr = next(); + } else { + illegalState(`unknown tx: ${currID} -> ${body && body[0]}`); + } + return body[1]; + } else if (type === Match.FAIL) { + return reduced([]); + } + }); +}; diff --git a/packages/fsm/src/index.ts b/packages/fsm/src/index.ts new file mode 100644 index 0000000000..ce52057625 --- /dev/null +++ b/packages/fsm/src/index.ts @@ -0,0 +1,7 @@ +export * from "./api"; +export * from "./alts"; +export * from "./fsm"; +export * from "./range"; +export * from "./seq"; +export * from "./str"; +export * from "./until"; diff --git a/packages/fsm/src/range.ts b/packages/fsm/src/range.ts new file mode 100644 index 0000000000..c296dc6ff6 --- /dev/null +++ b/packages/fsm/src/range.ts @@ -0,0 +1,46 @@ +import { alts } from "./alts"; +import { + AltCallback, + Match, + Matcher, + RangeCallback, + RES_FAIL +} from "./api"; +import { str } from "./str"; + +export const range = ( + min: T, + max: T, + callback?: RangeCallback +): Matcher => + () => + (ctx, x) => + x >= min && x <= max ? + { + type: Match.FULL, + body: callback && callback(ctx, x) + } : + RES_FAIL; + +export const digit = + (callback?: RangeCallback): Matcher => + range("0", "9", callback); + +export const alpha = + (callback?: AltCallback): Matcher => + alts( + [range("a", "z"), range("A", "Z")], + null, + callback + ); + +export const alphaNum = + (callback?: AltCallback): Matcher => + alts([alpha(), digit()], null, callback); + +const WS: Matcher[] = + [str("\r"), str("\n"), str("\t"), str(" ")]; + +export const whitespace = + (callback?: AltCallback): Matcher => + alts(WS, null, callback); diff --git a/packages/fsm/src/seq.ts b/packages/fsm/src/seq.ts new file mode 100644 index 0000000000..11081edb91 --- /dev/null +++ b/packages/fsm/src/seq.ts @@ -0,0 +1,35 @@ +import { + Match, + Matcher, + RES_FAIL, + RES_PARTIAL, + SeqCallback +} from "./api"; + +export const seq = ( + opts: Matcher[], + callback?: SeqCallback +): Matcher => + () => { + let i = 0; + let o = opts[i](); + const n = opts.length - 1; + const buf: T[] = []; + return (state, x) => { + if (i > n) return RES_FAIL; + callback && buf.push(x); + const { type } = o(state, x); + if (type === Match.FULL) { + if (i === n) { + return { + type: Match.FULL, + body: callback && callback(state, buf) + }; + } + o = opts[++i](); + } + return type === Match.FAIL ? + RES_FAIL : + RES_PARTIAL; + } + }; diff --git a/packages/fsm/src/str.ts b/packages/fsm/src/str.ts new file mode 100644 index 0000000000..1f3d3f4d4a --- /dev/null +++ b/packages/fsm/src/str.ts @@ -0,0 +1,26 @@ +import { + Match, + Matcher, + RangeCallback, + RES_FAIL, + RES_PARTIAL +} from "./api"; + +export const str = ( + str: string, + callback?: RangeCallback +): Matcher => + () => { + let buf = ""; + return (state, x) => + buf.length >= str.length ? + RES_FAIL : + (buf += x) === str ? + { + type: Match.FULL, + body: callback && callback(state, buf) + } : + str.indexOf(buf) === 0 ? + RES_PARTIAL : + RES_FAIL; + }; diff --git a/packages/fsm/src/until.ts b/packages/fsm/src/until.ts new file mode 100644 index 0000000000..0025ded874 --- /dev/null +++ b/packages/fsm/src/until.ts @@ -0,0 +1,24 @@ +import { + Match, + Matcher, + RangeCallback, + RES_PARTIAL +} from "./api"; + +export const until = ( + str: string, + callback?: RangeCallback +): Matcher => + () => { + let buf = ""; + return (ctx, x) => { + buf += x; + return buf.length >= str.length && + buf.substr(buf.length - str.length) === str ? + { + type: Match.FULL, + body: callback && callback(ctx, buf.substr(0, buf.length - str.length)) + } : + RES_PARTIAL; + }; + }; diff --git a/packages/fsm/test/index.ts b/packages/fsm/test/index.ts new file mode 100644 index 0000000000..b089705eea --- /dev/null +++ b/packages/fsm/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import * as f from "../src/index"; + +describe("fsm", () => { + it("tests pending"); +}); diff --git a/packages/fsm/test/tsconfig.json b/packages/fsm/test/tsconfig.json new file mode 100644 index 0000000000..bcf29ace54 --- /dev/null +++ b/packages/fsm/test/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/fsm/tsconfig.json b/packages/fsm/tsconfig.json new file mode 100644 index 0000000000..bd6481a5a6 --- /dev/null +++ b/packages/fsm/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}