package/test/test-dist.html 000644 0000040446 3560116604 013055 0 ustar 00 000000 000000
mhchem Parser – Tests
Could not load parser. This is likely a CORS restriction, e.g. if you opened this document via file://.
package/test/test-esm.html 000644 0000040421 3560116604 012667 0 ustar 00 000000 000000
mhchem Parser – Tests
Could not load parser. This is likely a CORS restriction, e.g. if you opened this document via file://.
package/package.json 000644 0000001004 3560116604 011541 0 ustar 00 000000 000000 {
"name": "mhchemparser",
"version": "4.2.1",
"description": "Parser to convert mhchem syntax to LaTeX syntax, for downstream inclusion in MathJax, KaTeX and similar projects.",
"keywords": [ "mhchem", "MathJax", "LaTeX", "chemistry" ],
"homepage": "https://github.com/mhchem/mhchemParser",
"bugs": "https://github.com/mhchem/mhchemParser/issues",
"repository": "github:mhchem/mhchemParser",
"license": "Apache-2.0",
"author": "Martin Hensel",
"main": "dist/mhchemParser.js"
} package/tsconfig-es6.json 000644 0000000306 3560116604 012461 0 ustar 00 000000 000000 {
"extends": "./tsconfig.json",
"compilerOptions": {
"target": "ES6",
"module": "ES6",
"moduleResolution": "node",
"outDir": "esm",
"baseUrl": ".",
"typeRoots": []
}
}
package/tsconfig.json 000644 0000000616 3560116604 011772 0 ustar 00 000000 000000 {
"compileOnSave": true,
"compilerOptions": {
"target": "ES5",
"downlevelIteration": true,
"declaration": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"removeComments": true,
"sourceMap": false,
"outDir": "dist"
},
"files": [
"src/mhchemParser.ts",
"src/mhchemParser.d.ts"
]
}
package/README.md 000644 0000002124 3560116604 010536 0 ustar 00 000000 000000 # mhchem Parser
mhchem is an input syntax for typesetting chemical equations and physical units.
This is the parser to convert mhchem syntax to LaTeX syntax, for downstream inclusion in [MathJax](https://mathjax.org), [KaTeX](https://katex.org) and similar projects.
## Usage
Users of MathJax and KaTex can write
\ce{CO2 + C -> 2 CO}
\pu{123 kJ*mol-1}
For a hundred more features and how to configure MathJax or KaTeX, see
[the manual](https://mhchem.github.io/MathJax-mhchem/).
## Usage for Downstream Software
For "translating" the `\ce` syntax, make a call like
mhchemParser.toTex("CO2 + C -> 2 CO", "ce");
This will return
"{\mathrm{CO}{\vphantom{A}}_{\smash[t]{2}} {}+{} \mathrm{C} {}\mathrel{\longrightarrow}{} 2\,\mathrm{CO}}"
For the `\pu` command, call
mhchemParser.toTex("123 kJ*mol-1", "pu");
You could also insert a TeX string. All instances of `\ce` and `\pu` will be replaced in the returned value. This might make integration easier, because the mhchem parser does not need to be called from the TeX parser.
mhchemParser.toTex("m_{\\ce{H2O}}", "tex");
package/src/mhchemParser.d.ts 000644 0000025103 3560116604 013260 0 ustar 00 000000 000000 interface MhchemParser {
go: { (input: string | undefined, stateMachine: StateMachineName): Parsed[]; };
concatArray: { (a: any[], b: any): void };
patterns: {
patterns: {
[pattern in PatternNameReturningString]?:
RegExp | PatternFunction
} & {
[pattern in PatternNameReturningArray]?:
RegExp | PatternFunction
};
findObserveGroups: {
(
input: string,
begExcl: string | RegExp,
begIncl: string | RegExp,
endIncl: string | RegExp,
endExcl: string | RegExp,
beg2Excl?: string | RegExp,
beg2Incl?: string | RegExp,
end2Incl?: string | RegExp,
end2Excl?: string | RegExp,
combine?: boolean
): MatchResult
};
match_: { (m: PatternName, input: string): MatchResult | null };
},
actions: ActionList;
stateMachines: { [key in StateMachineName]: StateMachine };
}
type PatternFunction = (input: string) => MatchResult | null;
type StateMachineName = "tex" | "ce" | "a" | "o" | "text" | "pq" | "bd" | "oxidation" | "tex-math" | "tex-math tight" | "9,9" | "pu" | "pu-2" | "pu-9,9";
type MatchResult = {
match_: T;
remainder: string;
}
type StateName =
"0" | // begin of main part (arrow/operator unlikely)
"1" | // next entity
"2" | // next entity (arrow/operator unlikely)
"3" | // next atom
"c" | // macro
"a" | // amount
"o" | // element
"b" | // left-side superscript
"p" | // left-side subscript
"q" | // right-side subscript
"d" | "D" | // right-side superscript
"r" | // arrow
"rd" | // arrow, script above
"f" | "*";
type StateNameCombined = StateName | "0|1|2" | "0|1|2|3" | "0|1|2|3|a|as|b|p|bp" | "0|1|2|3|a|as|b|p|bp|o" | "0|1|2|3|a|as|b|p|bp|o|c0" | "0|1|2|3|a|as|o" | "0|1|2|3|a|as|o|q|d|D|qd|qD|dq" | "0|1|2|3|as|b|p|bp|o" | "0|1|2|3|b|p|bp|o" | "0|1|2|a|as" | "0|1|2|as" | "0|2" | "0|a" | "0|d" | "1|2" | "1|3" | "3|o" | "a|as" | "a|as|d|D|q|qd|qD|dq" | "a|as|o" | "as" | "as|o" | "b|p|bp" | "d|D" | "d|D|q|qd|qD|dq" | "d|D|qd|qD" | "d|D|qd|qD|dq" | "d|qd|D|qD" | "d|qd|dq" | "D|qD|p" | "dq" | "o|d|D|dq|qd|qD" | "o|d|D|q|qd|qD|dq" | "o|q" | "q|d|D|qd|qD|dq" | "q|dq" | "q|qd|qD|dq" | "qd" | "qD|dq" | "qd|qD" | "r|rt" | "r|rt|rd|rdt|rdq" | "rd|rdt" | "/|q";
type ActionList = {
[key in ActionNameUsingMNone]?: ActionFunction
} & {
[key in ActionNameUsingMString]?: ActionFunction
} & {
[key in ActionNameUsingMStringOption]?: ActionFunction
} & {
[key in ActionNameUsingMArray]?: ActionFunction
}
interface ActionFunction {
(buffer: Buffer, m?: T, option?: string | number | boolean): undefined | Parsed | Parsed[];
}
type TransitionsRaw = {
[pattern in PatternNameReturningString]?: {
[state in StateNameCombined]?: {
action_:
ActionNameUsingMString | ActionNameUsingMStringOption | ActionNameUsingMNone |
ActionNameWithParameter | ActionNameWithParameter | ActionNameWithParameter |
(ActionNameUsingMString | ActionNameUsingMStringOption | ActionNameUsingMNone |
ActionNameWithParameter | ActionNameWithParameter | ActionNameWithParameter)[];
nextState?: string;
revisit?: boolean;
toContinue?: boolean;
stateArray?: StateName[];
}
}
} & {
[pattern in PatternNameReturningArray2]?: {
[state in StateNameCombined]?: {
action_:
ActionNameUsingMArray2 | (ActionNameUsingMArray2 | ActionNameUsingMString | ActionNameUsingMNone | ActionNameWithParameter)[]; // ... list ist not complete
nextState?: string;
revisit?: boolean;
toContinue?: boolean;
stateArray?: StateName[];
}
}
} & {
[pattern in PatternNameReturningArray3]?: {
[state in StateNameCombined]?: {
action_: ActionNameUsingMArray3 | ActionNameUsingMArray3[];
nextState?: string;
revisit?: boolean;
toContinue?: boolean;
stateArray?: StateName[];
}
}
} & {
[pattern in PatternNameReturningArray6]?: {
[state in StateNameCombined]?: {
action_: ActionNameUsingMArray6 | ActionNameUsingMArray6[];
nextState?: string;
revisit?: boolean;
toContinue?: boolean;
stateArray?: StateName[];
}
}
}
type PatternNameReturningString =
"empty" | "else" | "else2" | "space" | "space A" | "space$" | "a-z" | "x" | "x$" | "i$" | "letters" | "\\greek" | "one lowercase latin letter $" | "$one lowercase latin letter$ $" | "one lowercase greek letter $" | "digits" | "-9.,9" | "-9.,9 no missing 0" | "state of aggregation $" | "{[(" | ")]}" | ", " | "," | "." | ". __* " | "..." | "^{(...)}" | "^($...$)" | "^a" | "^\\x{}" | "^\\x" | "^(-1)" | "\'" | "_{(...)}" | "_($...$)" | "_9" | "_\\x{}{}" | "_\\x{}" | "_\\x" | "^_" | "{}^" | "{}" | "{...}" | "{(...)}" | "$...$" | "${(...)}$__$(...)$" | "=<>" | "#" | "+" | "-$" | "-9" | "- orbital overlap" | "-" | "pm-operator" | "operator" | "arrowUpDown" | "\\bond{(...)}" | "->" | "CMT" | "[(...)]" | "1st-level escape" | "\\," | "\\x{}" | "\\ca" | "\\x" | "orbital" | "others" | "\\color{(...)}" | "\\ce{(...)}" | "\\pu{(...)}" | "oxidation$" | "d-oxidation$" | "1/2$" | "amount" | "amount2" | "(KV letters)," | "formula$" | "uprightEntities" | "/" | "//" | "*" | "\\x{}{}" | "^\\x{}{}" |
"^{(...)}|^($...$)" | "^a|^\\x{}{}|^\\x{}|^\\x|\'" | "_{(...)}|_($...$)|_9|_\\x{}{}|_\\x{}|_\\x" | "\\,|\\x{}{}|\\x{}|\\x" | "{...}|\\,|\\x{}{}|\\x{}|\\x" | "\\x{}{}|\\x{}|\\x" | "-|+" | "{[(|)]}" | "{...}|else" | "^{(...)}|^(-1)";
type PatternNameReturningArray2 = "_{(state of aggregation)}$" | "\\frac{(...)}" | "\\overset{(...)}" | "\\underset{(...)}" | "\\underbrace{(...)}" | "\\color{(...)}{(...)}";
type PatternNameReturningArray3 = "(-)(9)^(-9)";
type PatternNameReturningArray6 = "(-)(9.,9)(e)(99)";
type PatternName = PatternNameReturningString | PatternNameReturningArray2 | PatternNameReturningArray3 | PatternNameReturningArray6;
type PatternNameReturningArray = PatternNameReturningArray2 | PatternNameReturningArray3 | PatternNameReturningArray6;
type ActionNameUsingMNone = "a to o" | "sb=true" | "sb=false" | "beginsWithBond=true" | "beginsWithBond=false" | "parenthesisLevel++" | "parenthesisLevel--" | "output" | "space" | "cdot" | "output-0" | "output-o" | "tight operator";
type ActionNameUsingMString = "a=" | "b=" | "p=" | "o=" | "o=+p1" | "q=" | "d=" | "rm=" | "text=" | "copy" | "rm" | "text" | "tex-math" | "tex-math tight" | "ce" | "pu" | "1/2" | "9,9" | "o after d" | "d= kv" | "charge or bond" | "state of aggregation" | "comma" | "oxidation-output" | "r=" | "rdt=" | "rd=" | "rqt=" | "rq=" | "operator" | "bond" | "color0-output" | "roman-numeral" | "^(-1)";
type ActionNameUsingMStringOption = "insert" | "insert+p1" | "write" | "bond" | "- after o/d";
type ActionNameUsingMArray2 = "insert+p1+p2" | "frac-output" | "overset-output" | "underset-output" | "underbrace-output" | "color-output";
type ActionNameUsingMArray3 = "number^";
type ActionNameUsingMArray6 = "enumber";
type ActionName = ActionNameUsingMNone | ActionNameUsingMString | ActionNameUsingMStringOption | ActionNameUsingMArray2 | ActionNameUsingMArray3 | ActionNameUsingMArray6;
type ActionNameUsingMArray = ActionNameUsingMArray2 | ActionNameUsingMArray3 | ActionNameUsingMArray6;
type StateMachine = {
transitions: Transitions;
actions: ActionList;
}
type Transitions = {
[state in StateName]?: Transition[];
}
interface Transition { // e.g. { pattern: 'letter', task: { '*': { action_: ['output'], nextState: '1' } } }
pattern: PatternName;
task: Action;
}
interface Action {
action_: ActionNameWithParameter[];
nextState?: StateName;
revisit?: boolean;
toContinue?: boolean;
}
interface ActionNameWithParameter {
type_: T;
option?: string | number | boolean;
}
interface Buffer {
a?: string; // amount
o?: string; // element
b?: string; // left-side superscript
p?: string; // left-side subscript
q?: string; // right-side subscript
d?: string; // right-side superscript
dType?: string;
r?: ArrowName; // arrow
rdt?: string; // arrow, script above, type
rd?: string; // arrow, script above, content
rqt?: string; // arrow, script below, type
rq?: string; // arrow, script below, content
text_?: string;
rm?: string;
parenthesisLevel?: number; // starting at 0
sb?: boolean; // space before
beginsWithBond?: boolean;
}
type ParsedWithoutString =
{ type_: "chemfive",
a: Parsed[],
b: Parsed[],
p: Parsed[],
o: Parsed[],
q: Parsed[],
d: Parsed[],
dType: string } |
{ type_: "rm", p1: string } |
{ type_: "text", p1: string } |
{ type_: "roman numeral", p1: string } |
{ type_: "state of aggregation", p1: Parsed[] } |
{ type_: "state of aggregation subscript", p1: Parsed[] } |
{ type_: "bond", kind_: BondName } |
{ type_: "frac", p1: string, p2: string } |
{ type_: "pu-frac", p1: Parsed[], p2: Parsed[] } |
{ type_: "tex-math", p1: string } |
{ type_: "frac-ce", p1: Parsed[], p2: Parsed[] } |
{ type_: "overset", p1: Parsed[], p2: Parsed[] } |
{ type_: "underset", p1: Parsed[], p2: Parsed[] } |
{ type_: "underbrace", p1: Parsed[], p2: Parsed[] } |
{ type_: "color", color1: string, color2: Parsed[] } |
{ type_: "color0", color: string } |
{ type_: "arrow",
r: ArrowName,
rd?: Parsed[],
rq?: Parsed[]} |
{ type_: "operator", kind_: OperatorName } |
{ type_: "1st-level escape", p1: string } |
{ type_: "space" } |
{ type_: "tinySkip" } |
{ type_: "entitySkip" } |
{ type_: "pu-space-1" } |
{ type_: "pu-space-2" } |
{ type_: "1000 separator" } |
{ type_: "commaDecimal" } |
{ type_: "comma enumeration L", p1: string } |
{ type_: "comma enumeration M", p1: string } |
{ type_: "comma enumeration S", p1: string } |
{ type_: "hyphen" } |
{ type_: "addition compound" } |
{ type_: "electron dot" } |
{ type_: "KV x" } |
{ type_: "prime" } |
{ type_: "cdot" } |
{ type_: "tight cdot" } |
{ type_: "times" } |
{ type_: "circa" } |
{ type_: "^" } |
{ type_: "v" } |
{ type_: "ellipsis" } |
{ type_: "/" } |
{ type_: " / " };
type Parsed = ParsedWithoutString | string;
type ArrowName = "->" | "\u2192" | "\u27F6" | "<-" | "<->" | "<-->" | "<=>" | "\u21CC" | "<=>>" | "<<=>"; // keep aligned with definition of pattern '->'
type BondName = "-" | "1" | "=" | "2" | "#" | "3" | "~" | "~-" | "~=" | "~--" | "-~-" | "..." | "...." | "->" | "<-" | "<" | ">";
type OperatorName = "+" | "-" | "=" | "<" | ">" | "<<" | ">>" | "\\pm" | "\\approx" | "$\\approx$" | "v" | "(v)" | "^" | "(^)";
interface MhchemTexify {
go: { (input: Parsed[] | undefined, isInner?: boolean): string; };
_goInner: { (input: Parsed[]): string};
_go2: { (input: ParsedWithoutString): string };
_getArrow: { (input: ArrowName): string };
_getBond: { (input: BondName): string };
_getOperator: { (input: OperatorName): string };
} package/src/mhchemParser.ts 000644 0000165167 3560116604 013055 0 ustar 00 000000 000000 /*!
*************************************************************************
*
* mhchemParser.ts
* 4.2.1
*
* Parser for the \ce command and \pu command for MathJax and Co.
*
* mhchem's \ce is a tool for writing beautiful chemical equations easily.
* mhchem's \pu is a tool for writing physical units easily.
*
* ----------------------------------------------------------------------
*
* Copyright (c) 2015-2023 Martin Hensel
*
* 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.
*
* ----------------------------------------------------------------------
*
* https://github.com/mhchem/mhchemParser
*
*/
export class mhchemParser {
static toTex(input: string, type: "tex" | "ce" | "pu"): string {
return _mhchemTexify.go(_mhchemParser.go(input, type), type !== "tex");
}
}
//
// Coding Style
// - use '' for identifiers that can by minified/uglified
// - use "" for strings that need to stay untouched
//
// Helper funtion: _mhchemCreateTransitions
// convert { 'letter': { 'state': { action_: 'output' } } } to { 'state' => [ { pattern: 'letter', task: { action_: [{type_: 'output'}] } } ] }
// with expansion of 'a|b' to 'a' and 'b' (at 2 places)
//
function _mhchemCreateTransitions(o: TransitionsRaw): Transitions {
let pattern: PatternName, state: StateNameCombined;
//
// 1. Collect all states
//
let transitions: Transitions = {};
for (pattern in o) {
for (state in o[pattern]) {
let stateArray = state.split("|") as StateName[];
o[pattern][state].stateArray = stateArray;
for (let i=0; i 0) {
if (!task.revisit) {
input = matches.remainder;
}
if (!task.toContinue) {
break iterateTransitions;
}
} else {
return output;
}
}
}
//
// Prevent infinite loop
//
if (watchdog <= 0) {
throw ["MhchemBugU", "mhchem bug U. Please report."]; // Unexpected character
}
}
},
concatArray: function (a, b) {
if (b) {
if (Array.isArray(b)) {
for (let iB=0; iB,
'_{(state of aggregation)}$': /^_\{(\([a-z]{1,3}\))\}/,
'{[(': /^(?:\\\{|\[|\()/,
')]}': /^(?:\)|\]|\\\})/,
', ': /^[,;]\s*/,
',': /^[,;]/,
'.': /^[.]/,
'. __* ': /^([.\u22C5\u00B7\u2022]|[*])\s*/,
'...': /^\.\.\.(?=$|[^.])/,
'^{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "^{", "", "", "}"); } as PatternFunction,
'^($...$)': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "^", "$", "$", ""); } as PatternFunction,
'^a': /^\^([0-9]+|[^\\_])/,
'^\\x{}{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "^", /^\\[a-zA-Z]+\{/, "}", "", "", "{", "}", "", true); } as PatternFunction,
'^\\x{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "^", /^\\[a-zA-Z]+\{/, "}", ""); } as PatternFunction,
'^\\x': /^\^(\\[a-zA-Z]+)\s*/,
'^(-1)': /^\^(-?\d+)/,
'\'': /^'/,
'_{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "_{", "", "", "}"); } as PatternFunction,
'_($...$)': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "_", "$", "$", ""); } as PatternFunction,
'_9': /^_([+\-]?[0-9]+|[^\\])/,
'_\\x{}{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "_", /^\\[a-zA-Z]+\{/, "}", "", "", "{", "}", "", true); } as PatternFunction,
'_\\x{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "_", /^\\[a-zA-Z]+\{/, "}", ""); } as PatternFunction,
'_\\x': /^_(\\[a-zA-Z]+)\s*/,
'^_': /^(?:\^(?=_)|\_(?=\^)|[\^_]$)/,
'{}^': /^\{\}(?=\^)/,
'{}': /^\{\}/,
'{...}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "", "{", "}", ""); } as PatternFunction,
'{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "{", "", "", "}"); } as PatternFunction,
'$...$': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "", "$", "$", ""); } as PatternFunction,
'${(...)}$__$(...)$': function (input) {
return _mhchemParser.patterns.findObserveGroups(input, "${", "", "", "}$") || _mhchemParser.patterns.findObserveGroups(input, "$", "", "", "$");
} as PatternFunction,
'=<>': /^[=<>]/,
'#': /^[#\u2261]/,
'+': /^\+/,
'-$': /^-(?=[\s_},;\]/]|$|\([a-z]+\))/, // -space -, -; -] -/ -$ -state-of-aggregation
'-9': /^-(?=[0-9])/,
'- orbital overlap': /^-(?=(?:[spd]|sp)(?:$|[\s,;\)\]\}]))/,
'-': /^-/,
'pm-operator': /^(?:\\pm|\$\\pm\$|\+-|\+\/-)/,
'operator': /^(?:\+|(?:[\-=<>]|<<|>>|\\approx|\$\\approx\$)(?=\s|$|-?[0-9]))/,
'arrowUpDown': /^(?:v|\(v\)|\^|\(\^\))(?=$|[\s,;\)\]\}])/,
'\\bond{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\bond{", "", "", "}"); } as PatternFunction,
'->': /^(?:<->|<-->|->|<-|<=>>|<<=>|<=>|[\u2192\u27F6\u21CC])/,
'CMT': /^[CMT](?=\[)/,
'[(...)]': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "[", "", "", "]"); } as PatternFunction,
'1st-level escape': /^(&|\\\\|\\hline)\s*/,
'\\,': /^(?:\\[,\ ;:])/, // \\x - but output no space before
'\\x{}{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "", /^\\[a-zA-Z]+\{/, "}", "", "", "{", "}", "", true); } as PatternFunction,
'\\x{}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "", /^\\[a-zA-Z]+\{/, "}", ""); } as PatternFunction,
'\\ca': /^\\ca(?:\s+|(?![a-zA-Z]))/,
'\\x': /^(?:\\[a-zA-Z]+\s*|\\[_&{}%])/,
'orbital': /^(?:[0-9]{1,2}[spdfgh]|[0-9]{0,2}sp)(?=$|[^a-zA-Z])/, // only those with numbers in front, because the others will be formatted correctly anyway
'others': /^[\/~|]/,
'\\frac{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\frac{", "", "", "}", "{", "", "", "}"); } as PatternFunction,
'\\overset{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\overset{", "", "", "}", "{", "", "", "}"); } as PatternFunction,
'\\underset{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\underset{", "", "", "}", "{", "", "", "}"); } as PatternFunction,
'\\underbrace{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\underbrace{", "", "", "}_", "{", "", "", "}"); } as PatternFunction,
'\\color{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\color{", "", "", "}"); } as PatternFunction,
'\\color{(...)}{(...)}': function (input) {
return _mhchemParser.patterns.findObserveGroups(input, "\\color{", "", "", "}", "{", "", "", "}") ||
_mhchemParser.patterns.findObserveGroups(input, "\\color", "\\", "", /^(?=\{)/, "{", "", "", "}");
} as PatternFunction,
'\\ce{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\ce{", "", "", "}"); } as PatternFunction,
'\\pu{(...)}': function (input) { return _mhchemParser.patterns.findObserveGroups(input, "\\pu{", "", "", "}"); } as PatternFunction,
'oxidation$': /^(?:[+-][IVX]+|(?:\\pm|\$\\pm\$|\+-|\+\/-)\s*0)$/, // -IV to +IX, +-0 // "0" could be oxidation or charge - but renders the same
'd-oxidation$': /^(?:[+-]?[IVX]+|(?:\\pm|\$\\pm\$|\+-|\+\/-)\s*0)$/,
'1/2$': /^[+\-]?(?:[0-9]+|\$[a-z]\$|[a-z])\/[0-9]+(?:\$[a-z]\$|[a-z])?$/,
'amount': function (input) {
let match;
// e.g. 2, 0.5, 1/2, -2, n/2, +; $a$ could be added later in parsing
match = input.match(/^(?:(?:(?:\([+\-]?[0-9]+\/[0-9]+\)|[+\-]?(?:[0-9]+|\$[a-z]\$|[a-z])\/[0-9]+|[+\-]?[0-9]+[.,][0-9]+|[+\-]?\.[0-9]+|[+\-]?[0-9]+)(?:[a-z](?=\s*[A-Z]))?)|[+\-]?[a-z](?=\s*[A-Z])|\+(?!\s))/);
if (match) {
return { match_: match[0], remainder: input.substr(match[0].length) };
}
const a = _mhchemParser.patterns.findObserveGroups(input, "", "$", "$", "") as MatchResult;
if (a) { // e.g. $2n-1$, $-$
match = a.match_.match(/^\$(?:\(?[+\-]?(?:[0-9]*[a-z]?[+\-])?[0-9]*[a-z](?:[+\-][0-9]*[a-z]?)?\)?|\+|-)\$$/);
if (match) {
return { match_: match[0], remainder: input.substr(match[0].length) };
}
}
return null;
},
'amount2': function (input) { return this['amount'](input); },
'(KV letters),': /^(?:[A-Z][a-z]{0,2}|i)(?=,)/,
'formula$': function (input) {
if (input.match(/^\([a-z]+\)$/)) { return null; } // state of aggregation = no formula
const match = input.match(/^(?:[a-z]|(?:[0-9\ \+\-\,\.\(\)]+[a-z])+[0-9\ \+\-\,\.\(\)]*|(?:[a-z][0-9\ \+\-\,\.\(\)]+)+[a-z]?)$/);
if (match) {
return { match_: match[0], remainder: input.substr(match[0].length) };
}
return null;
},
'uprightEntities': /^(?:pH|pOH|pC|pK|iPr|iBu)(?=$|[^a-zA-Z])/,
'/': /^\s*(\/)\s*/,
'//': /^\s*(\/\/)\s*/,
'*': /^\s*[*.]\s*/
},
findObserveGroups: function (input, begExcl, begIncl, endIncl, endExcl, beg2Excl, beg2Incl, end2Incl, end2Excl, combine) {
const _match = function (input: string, pattern: string | RegExp) : string | string[] | null {
if (typeof pattern === "string") {
if (input.indexOf(pattern) !== 0) { return null; }
return pattern;
} else {
const match = input.match(pattern);
if (!match) { return null; }
return match[0];
}
};
const _findObserveGroups = function (input: string, i: number, endChars: string | RegExp): {endMatchBegin: number, endMatchEnd: number} | null {
let braces = 0;
while (i < input.length) {
let a = input.charAt(i);
const match = _match(input.substr(i), endChars);
if (match !== null && braces === 0) {
return { endMatchBegin: i, endMatchEnd: i + match.length };
} else if (a === "{") {
braces++;
} else if (a === "}") {
if (braces === 0) {
throw ["ExtraCloseMissingOpen", "Extra close brace or missing open brace"];
} else {
braces--;
}
}
i++;
}
if (braces > 0) {
return null;
}
return null;
};
let match = _match(input, begExcl);
if (match === null) { return null; }
input = input.substr(match.length);
match = _match(input, begIncl);
if (match === null) { return null; }
const e = _findObserveGroups(input, match.length, endIncl || endExcl);
if (e === null) { return null; }
const match1 = input.substring(0, (endIncl ? e.endMatchEnd : e.endMatchBegin));
if (!(beg2Excl || beg2Incl)) {
return {
match_: match1,
remainder: input.substr(e.endMatchEnd)
};
} else {
const group2 = this.findObserveGroups(input.substr(e.endMatchEnd), beg2Excl, beg2Incl, end2Incl, end2Excl);
if (group2 === null) { return null; }
const matchRet: string[] = [match1, group2.match_];
return {
match_: (combine ? matchRet.join("") : matchRet),
remainder: group2.remainder
};
}
},
//
// Matching function
// e.g. match("a", input) will look for the regexp called "a" and see if it matches
// returns null or {match_:"a", remainder:"bc"}
//
match_: function (m, input) {
const pattern = _mhchemParser.patterns.patterns[m];
if (pattern === undefined) {
throw ["MhchemBugP", "mhchem bug P. Please report. (" + m + ")"]; // Trying to use non-existing pattern
} else if (typeof pattern === "function") {
return (_mhchemParser.patterns.patterns[m] as unknown as PatternFunction)(input); // cannot use cached variable pattern here, because some pattern functions need this===mhchemParser
} else { // RegExp
const match = input.match(pattern);
if (match) {
if (match.length > 2) {
return { match_: match.slice(1), remainder: input.substr(match[0].length) };
} else {
return { match_: match[1] || match[0], remainder: input.substr(match[0].length) };
}
}
return null;
}
}
},
//
// Generic state machine actions
//
actions: {
'a=': function (buffer, m) { buffer.a = (buffer.a || "") + m; return undefined; },
'b=': function (buffer, m) { buffer.b = (buffer.b || "") + m; return undefined; },
'p=': function (buffer, m) { buffer.p = (buffer.p || "") + m; return undefined; },
'o=': function (buffer, m) { buffer.o = (buffer.o || "") + m; return undefined; },
'o=+p1': function (buffer, _m, a: string) { buffer.o = (buffer.o || "") + a; return undefined; },
'q=': function (buffer, m) { buffer.q = (buffer.q || "") + m; return undefined; },
'd=': function (buffer, m) { buffer.d = (buffer.d || "") + m; return undefined; },
'rm=': function (buffer, m) { buffer.rm = (buffer.rm || "") + m; return undefined; },
'text=': function (buffer, m) { buffer.text_ = (buffer.text_ || "") + m; return undefined; },
'insert': function (_buffer, _m, a: string) { return { type_: a } as Parsed; },
'insert+p1': function (_buffer, m, a) { return { type_: a, p1: m } as Parsed; },
'insert+p1+p2': function (_buffer, m, a) { return { type_: a, p1: m[0], p2: m[1] } as Parsed; },
'copy': function (_buffer, m) { return m; },
'write': function (_buffer, _m, a: string) { return a; },
'rm': function (_buffer, m) { return { type_: 'rm', p1: m }; },
'text': function (_buffer, m) { return _mhchemParser.go(m, 'text'); },
'tex-math': function (_buffer, m) { return _mhchemParser.go(m, 'tex-math'); },
'tex-math tight': function (_buffer, m) { return _mhchemParser.go(m, 'tex-math tight'); },
'bond': function (_buffer, m: BondName, k: BondName) { return { type_: 'bond', kind_: k || m }; },
'color0-output': function (_buffer, m) { return { type_: 'color0', color: m }; },
'ce': function (_buffer, m) { return _mhchemParser.go(m, 'ce'); },
'pu': function (_buffer, m) { return _mhchemParser.go(m, 'pu'); },
'1/2': function (_buffer, m) {
let ret: Parsed[] = [];
if (m.match(/^[+\-]/)) {
ret.push(m.substr(0, 1));
m = m.substr(1);
}
const n = m.match(/^([0-9]+|\$[a-z]\$|[a-z])\/([0-9]+)(\$[a-z]\$|[a-z])?$/);
n[1] = n[1].replace(/\$/g, "");
ret.push({ type_: 'frac', p1: n[1], p2: n[2] });
if (n[3]) {
n[3] = n[3].replace(/\$/g, "");
ret.push({ type_: 'tex-math', p1: n[3] });
}
return ret;
},
'9,9': function (_buffer, m) { return _mhchemParser.go(m, '9,9'); }
},
//
// Definition of state machines
//
stateMachines: {
//
// TeX state machine
//
'tex': {
transitions: _mhchemCreateTransitions({
'empty': {
'0': { action_: 'copy' } },
'\\ce{(...)}': {
'0': { action_: [ { type_: 'write', option: "{" }, 'ce', { type_: 'write', option: "}" }] } },
'\\pu{(...)}': {
'0': { action_: [ { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" }] } },
'else': {
'0': { action_: 'copy' } },
}),
actions: {}
},
//
// \ce state machines
//
//#region ce
'ce': { // main parser
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'else': {
'0|1|2': { action_: 'beginsWithBond=false', revisit: true, toContinue: true } },
'oxidation$': {
'0': { action_: 'oxidation-output' } },
'CMT': {
'r': { action_: 'rdt=', nextState: 'rt' },
'rd': { action_: 'rqt=', nextState: 'rdt' } },
'arrowUpDown': {
'0|1|2|as': { action_: [ 'sb=false', 'output', 'operator' ], nextState: '1' } },
'uprightEntities': {
'0|1|2': { action_: [ 'o=', 'output' ], nextState: '1' } },
'orbital': {
'0|1|2|3': { action_: 'o=', nextState: 'o' } },
'->': {
'0|1|2|3': { action_: 'r=', nextState: 'r' },
'a|as': { action_: [ 'output', 'r=' ], nextState: 'r' },
'*': { action_: [ 'output', 'r=' ], nextState: 'r' } },
'+': {
'o': { action_: 'd= kv', nextState: 'd' },
'd|D': { action_: 'd=', nextState: 'd' },
'q': { action_: 'd=', nextState: 'qd' },
'qd|qD': { action_: 'd=', nextState: 'qd' },
'dq': { action_: [ 'output', 'd=' ], nextState: 'd' },
'3': { action_: [ 'sb=false', 'output', 'operator' ], nextState: '0' } },
'amount': {
'0|2': { action_: 'a=', nextState: 'a' } },
'pm-operator': {
'0|1|2|a|as': { action_: [ 'sb=false', 'output', { type_: 'operator', option: '\\pm' } ], nextState: '0' } },
'operator': {
'0|1|2|a|as': { action_: [ 'sb=false', 'output', 'operator' ], nextState: '0' } },
'-$': {
'o|q': { action_: [ 'charge or bond', 'output' ], nextState: 'qd' },
'd': { action_: 'd=', nextState: 'd' },
'D': { action_: [ 'output', { type_: 'bond', option: "-" } ], nextState: '3' },
'q': { action_: 'd=', nextState: 'qd' },
'qd': { action_: 'd=', nextState: 'qd' },
'qD|dq': { action_: [ 'output', { type_: 'bond', option: "-" } ], nextState: '3' } },
'-9': {
'3|o': { action_: [ 'output', { type_: 'insert', option: 'hyphen' } ], nextState: '3' } },
'- orbital overlap': {
'o': { action_: [ 'output', { type_: 'insert', option: 'hyphen' } ], nextState: '2' },
'd': { action_: [ 'output', { type_: 'insert', option: 'hyphen' } ], nextState: '2' } },
'-': {
'0|1|2': { action_: [ { type_: 'output', option: 1 }, 'beginsWithBond=true', { type_: 'bond', option: "-" } ], nextState: '3' },
'3': { action_: { type_: 'bond', option: "-" } },
'a': { action_: [ 'output', { type_: 'insert', option: 'hyphen' } ], nextState: '2' },
'as': { action_: [ { type_: 'output', option: 2 }, { type_: 'bond', option: "-" } ], nextState: '3' },
'b': { action_: 'b=' },
'o': { action_: { type_: '- after o/d', option: false }, nextState: '2' },
'q': { action_: { type_: '- after o/d', option: false }, nextState: '2' },
'd|qd|dq': { action_: { type_: '- after o/d', option: true }, nextState: '2' },
'D|qD|p': { action_: [ 'output', { type_: 'bond', option: "-" } ], nextState: '3' } },
'amount2': {
'1|3': { action_: 'a=', nextState: 'a' } },
'letters': {
'0|1|2|3|a|as|b|p|bp|o': { action_: 'o=', nextState: 'o' },
'q|dq': { action_: ['output', 'o='], nextState: 'o' },
'd|D|qd|qD': { action_: 'o after d', nextState: 'o' } },
'digits': {
'o': { action_: 'q=', nextState: 'q' },
'd|D': { action_: 'q=', nextState: 'dq' },
'q': { action_: [ 'output', 'o=' ], nextState: 'o' },
'a': { action_: 'o=', nextState: 'o' } },
'space A': {
'b|p|bp': { action_: [] } },
'space': {
'a': { action_: [], nextState: 'as' },
'0': { action_: 'sb=false' },
'1|2': { action_: 'sb=true' },
'r|rt|rd|rdt|rdq': { action_: 'output', nextState: '0' },
'*': { action_: [ 'output', 'sb=true' ], nextState: '1'} },
'1st-level escape': {
'1|2': { action_: [ 'output', { type_: 'insert+p1', option: '1st-level escape' } ] },
'*': { action_: [ 'output', { type_: 'insert+p1', option: '1st-level escape' } ], nextState: '0' } },
'[(...)]': {
'r|rt': { action_: 'rd=', nextState: 'rd' },
'rd|rdt': { action_: 'rq=', nextState: 'rdq' } },
'...': {
'o|d|D|dq|qd|qD': { action_: [ 'output', { type_: 'bond', option: "..." } ], nextState: '3' },
'*': { action_: [ { type_: 'output', option: 1 }, { type_: 'insert', option: 'ellipsis' } ], nextState: '1' } },
'. __* ': {
'*': { action_: [ 'output', { type_: 'insert', option: 'addition compound' } ], nextState: '1' } },
'state of aggregation $': {
'*': { action_: [ 'output', 'state of aggregation' ], nextState: '1' } },
'{[(': {
'a|as|o': { action_: [ 'o=', 'output', 'parenthesisLevel++' ], nextState: '2' },
'0|1|2|3': { action_: [ 'o=', 'output', 'parenthesisLevel++' ], nextState: '2' },
'*': { action_: [ 'output', 'o=', 'output', 'parenthesisLevel++' ], nextState: '2' } },
')]}': {
'0|1|2|3|b|p|bp|o': { action_: [ 'o=', 'parenthesisLevel--' ], nextState: 'o' },
'a|as|d|D|q|qd|qD|dq': { action_: [ 'output', 'o=', 'parenthesisLevel--' ], nextState: 'o' } },
', ': {
'*': { action_: [ 'output', 'comma' ], nextState: '0' } },
'^_': { // ^ and _ without a sensible argument
'*': { action_: [] } },
'^{(...)}|^($...$)': {
'0|1|2|as': { action_: 'b=', nextState: 'b' },
'p': { action_: 'b=', nextState: 'bp' },
'3|o': { action_: 'd= kv', nextState: 'D' },
'q': { action_: 'd=', nextState: 'qD' },
'd|D|qd|qD|dq': { action_: [ 'output', 'd=' ], nextState: 'D' } },
'^a|^\\x{}{}|^\\x{}|^\\x|\'': {
'0|1|2|as': { action_: 'b=', nextState: 'b' },
'p': { action_: 'b=', nextState: 'bp' },
'3|o': { action_: 'd= kv', nextState: 'd' },
'q': { action_: 'd=', nextState: 'qd' },
'd|qd|D|qD': { action_: 'd=' },
'dq': { action_: [ 'output', 'd=' ], nextState: 'd' } },
'_{(state of aggregation)}$': {
'd|D|q|qd|qD|dq': { action_: [ 'output', 'q=' ], nextState: 'q' } },
'_{(...)}|_($...$)|_9|_\\x{}{}|_\\x{}|_\\x': {
'0|1|2|as': { action_: 'p=', nextState: 'p' },
'b': { action_: 'p=', nextState: 'bp' },
'3|o': { action_: 'q=', nextState: 'q' },
'd|D': { action_: 'q=', nextState: 'dq' },
'q|qd|qD|dq': { action_: [ 'output', 'q=' ], nextState: 'q' } },
'=<>': {
'0|1|2|3|a|as|o|q|d|D|qd|qD|dq': { action_: [ { type_: 'output', option: 2 }, 'bond' ], nextState: '3' } },
'#': {
'0|1|2|3|a|as|o': { action_: [ { type_: 'output', option: 2 }, { type_: 'bond', option: "#" } ], nextState: '3' } },
'{}^': {
'*': { action_: [ { type_: 'output', option: 1 }, { type_: 'insert', option: 'tinySkip' } ], nextState: '1' } },
'{}': {
'*': { action_: { type_: 'output', option: 1 }, nextState: '1' } },
'{...}': {
'0|1|2|3|a|as|b|p|bp': { action_: 'o=', nextState: 'o' },
'o|d|D|q|qd|qD|dq': { action_: [ 'output', 'o=' ], nextState: 'o' } },
'$...$': {
'a': { action_: 'a=' }, // 2$n$
'0|1|2|3|as|b|p|bp|o': { action_: 'o=', nextState: 'o' }, // not 'amount'
'as|o': { action_: 'o=' },
'q|d|D|qd|qD|dq': { action_: [ 'output', 'o=' ], nextState: 'o' } },
'\\bond{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'bond' ], nextState: "3" } },
'\\frac{(...)}': {
'*': { action_: [ { type_: 'output', option: 1 }, 'frac-output' ], nextState: '3' } },
'\\overset{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'overset-output' ], nextState: '3' } },
'\\underset{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'underset-output' ], nextState: '3' } },
'\\underbrace{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'underbrace-output' ], nextState: '3' } },
'\\color{(...)}{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'color-output' ], nextState: '3' } },
'\\color{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'color0-output' ] } },
'\\ce{(...)}': {
'*': { action_: [ { type_: 'output', option: 2 }, 'ce' ], nextState: '3' } },
'\\,': {
'*': { action_: [ { type_: 'output', option: 1 }, 'copy' ], nextState: '1' } },
'\\pu{(...)}': {
'*': { action_: [ 'output', { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ], nextState: '3' } },
'\\x{}{}|\\x{}|\\x': {
'0|1|2|3|a|as|b|p|bp|o|c0': { action_: [ 'o=', 'output' ], nextState: '3' },
'*': { action_: ['output', 'o=', 'output' ], nextState: '3' } },
'others': {
'*': { action_: [ { type_: 'output', option: 1 }, 'copy' ], nextState: '3' } },
'else2': {
'a': { action_: 'a to o', nextState: 'o', revisit: true },
'as': { action_: [ 'output', 'sb=true' ], nextState: '1', revisit: true },
'r|rt|rd|rdt|rdq': { action_: [ 'output' ], nextState: '0', revisit: true },
'*': { action_: [ 'output', 'copy' ], nextState: '3' } }
}),
actions: {
'o after d': function (buffer, m) {
let ret;
if ((buffer.d || "").match(/^[1-9][0-9]*$/)) {
const tmp = buffer.d;
buffer.d = undefined;
ret = this['output'](buffer);
ret.push({ type_: 'tinySkip' });
buffer.b = tmp;
} else {
ret = this['output'](buffer);
}
_mhchemParser.actions['o='](buffer, m);
return ret;
},
'd= kv': function (buffer, m) {
buffer.d = m;
buffer.dType = 'kv';
return undefined;
},
'charge or bond': function (buffer, m): undefined | Parsed[] {
if (buffer['beginsWithBond']) {
let ret: Parsed[] = [];
_mhchemParser.concatArray(ret, this['output'](buffer));
_mhchemParser.concatArray(ret, _mhchemParser.actions['bond'](buffer, m, "-"));
return ret;
} else {
buffer.d = m;
return undefined;
}
},
'- after o/d': function (buffer, m, isAfterD) {
let c1 = _mhchemParser.patterns.match_('orbital', buffer.o || "");
const c2 = _mhchemParser.patterns.match_('one lowercase greek letter $', buffer.o || "");
const c3 = _mhchemParser.patterns.match_('one lowercase latin letter $', buffer.o || "");
const c4 = _mhchemParser.patterns.match_('$one lowercase latin letter$ $', buffer.o || "");
const hyphenFollows = m==="-" && ( c1 && c1.remainder==="" || c2 || c3 || c4 );
if (hyphenFollows && !buffer.a && !buffer.b && !buffer.p && !buffer.d && !buffer.q && !c1 && c3) {
buffer.o = '$' + buffer.o + '$';
}
let ret: Parsed[] = [];
if (hyphenFollows) {
_mhchemParser.concatArray(ret, this['output'](buffer));
ret.push({ type_: 'hyphen' });
} else {
c1 = _mhchemParser.patterns.match_('digits', buffer.d || "");
if (isAfterD && c1 && c1.remainder==='') {
_mhchemParser.concatArray(ret, _mhchemParser.actions['d='](buffer, m));
_mhchemParser.concatArray(ret, this['output'](buffer));
} else {
_mhchemParser.concatArray(ret, this['output'](buffer));
_mhchemParser.concatArray(ret, _mhchemParser.actions['bond'](buffer, m, "-"));
}
}
return ret;
},
'a to o': function (buffer) {
buffer.o = buffer.a;
buffer.a = undefined;
return undefined;
},
'sb=true': function (buffer) { buffer.sb = true; return undefined; },
'sb=false': function (buffer) { buffer.sb = false; return undefined; },
'beginsWithBond=true': function (buffer) { buffer['beginsWithBond'] = true; return undefined; },
'beginsWithBond=false': function (buffer) { buffer['beginsWithBond'] = false; return undefined; },
'parenthesisLevel++': function (buffer) { buffer['parenthesisLevel']++; return undefined; },
'parenthesisLevel--': function (buffer) { buffer['parenthesisLevel']--; return undefined; },
'state of aggregation': function (_buffer, m) {
return { type_: 'state of aggregation', p1: _mhchemParser.go(m, 'o') };
},
'comma': function (buffer, m) {
const a = m.replace(/\s*$/, '');
const withSpace = (a !== m);
if (withSpace && buffer['parenthesisLevel'] === 0) {
return { type_: 'comma enumeration L', p1: a };
} else {
return { type_: 'comma enumeration M', p1: a };
}
},
'output': function (buffer, _m, entityFollows) {
// entityFollows:
// undefined = if we have nothing else to output, also ignore the just read space (buffer.sb)
// 1 = an entity follows, never omit the space if there was one just read before (can only apply to state 1)
// 2 = 1 + the entity can have an amount, so output a\, instead of converting it to o (can only apply to states a|as)
let ret: Parsed | Parsed[];
if (!buffer.r) {
ret = [];
if (!buffer.a && !buffer.b && !buffer.p && !buffer.o && !buffer.q && !buffer.d && !entityFollows) {
//ret = [];
} else {
if (buffer.sb) {
ret.push({ type_: 'entitySkip' });
}
if (!buffer.o && !buffer.q && !buffer.d && !buffer.b && !buffer.p && entityFollows!==2) {
buffer.o = buffer.a;
buffer.a = undefined;
} else if (!buffer.o && !buffer.q && !buffer.d && (buffer.b || buffer.p)) {
buffer.o = buffer.a;
buffer.d = buffer.b;
buffer.q = buffer.p;
buffer.a = buffer.b = buffer.p = undefined;
} else {
if (buffer.o && buffer.dType==='kv' && _mhchemParser.patterns.match_('d-oxidation$', buffer.d || "")) {
buffer.dType = 'oxidation';
} else if (buffer.o && buffer.dType==='kv' && !buffer.q) {
buffer.dType = undefined;
}
}
ret.push({
type_: 'chemfive',
a: _mhchemParser.go(buffer.a, 'a'),
b: _mhchemParser.go(buffer.b, 'bd'),
p: _mhchemParser.go(buffer.p, 'pq'),
o: _mhchemParser.go(buffer.o, 'o'),
q: _mhchemParser.go(buffer.q, 'pq'),
d: _mhchemParser.go(buffer.d, (buffer.dType === 'oxidation' ? 'oxidation' : 'bd')),
dType: buffer.dType
});
}
} else { // r
let rd: Parsed[];
if (buffer.rdt === 'M') {
rd = _mhchemParser.go(buffer.rd, 'tex-math');
} else if (buffer.rdt === 'T') {
rd = [ { type_: 'text', p1: buffer.rd || "" } ];
} else {
rd = _mhchemParser.go(buffer.rd, 'ce');
}
let rq: Parsed[];
if (buffer.rqt === 'M') {
rq = _mhchemParser.go(buffer.rq, 'tex-math');
} else if (buffer.rqt === 'T') {
rq = [ { type_: 'text', p1: buffer.rq || ""} ];
} else {
rq = _mhchemParser.go(buffer.rq, 'ce');
}
ret = {
type_: 'arrow',
r: buffer.r,
rd: rd,
rq: rq
};
}
for (const p in buffer) {
if (p !== 'parenthesisLevel' && p !== 'beginsWithBond') {
//@ts-ignore
delete buffer[p];
}
}
return ret;
},
'oxidation-output': function (_buffer, m) {
let ret = [ "{" ];
_mhchemParser.concatArray(ret, _mhchemParser.go(m, 'oxidation'));
ret.push("}");
return ret;
},
'frac-output': function (_buffer, m) {
return { type_: 'frac-ce', p1: _mhchemParser.go(m[0], 'ce'), p2: _mhchemParser.go(m[1], 'ce') };
},
'overset-output': function (_buffer, m) {
return { type_: 'overset', p1: _mhchemParser.go(m[0], 'ce'), p2: _mhchemParser.go(m[1], 'ce') };
},
'underset-output': function (_buffer, m) {
return { type_: 'underset', p1: _mhchemParser.go(m[0], 'ce'), p2: _mhchemParser.go(m[1], 'ce') };
},
'underbrace-output': function (_buffer, m) {
return { type_: 'underbrace', p1: _mhchemParser.go(m[0], 'ce'), p2: _mhchemParser.go(m[1], 'ce') };
},
'color-output': function (_buffer, m) {
return { type_: 'color', color1: m[0], color2: _mhchemParser.go(m[1], 'ce') };
},
'r=': function (buffer, m: ArrowName) { buffer.r = m; return undefined; },
'rdt=': function (buffer, m) { buffer.rdt = m; return undefined; },
'rd=': function (buffer, m) { buffer.rd = m; return undefined; },
'rqt=': function (buffer, m) { buffer.rqt = m; return undefined; },
'rq=': function (buffer, m) { buffer.rq = m; return undefined; },
'operator': function (_buffer, m, p1) { return { type_: 'operator', kind_: (p1 || m) } as Parsed; }
}
},
'a': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: [] } },
'1/2$': {
'0': { action_: '1/2' } },
'else': {
'0': { action_: [], nextState: '1', revisit: true } },
'${(...)}$__$(...)$': {
'*': { action_: 'tex-math tight', nextState: '1' } },
',': {
'*': { action_: { type_: 'insert', option: 'commaDecimal' } } },
'else2': {
'*': { action_: 'copy' } }
}),
actions: {}
},
'o': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: [] } },
'1/2$': {
'0': { action_: '1/2' } },
'else': {
'0': { action_: [], nextState: '1', revisit: true } },
'letters': {
'*': { action_: 'rm' } },
'\\ca': {
'*': { action_: { type_: 'insert', option: 'circa' } } },
'\\pu{(...)}': {
'*': { action_: [ { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'\\x{}{}|\\x{}|\\x': {
'*': { action_: 'copy' } },
'${(...)}$__$(...)$': {
'*': { action_: 'tex-math' } },
'{(...)}': {
'*': { action_: [ { type_: 'write', option: "{" }, 'text', { type_: 'write', option: "}" } ] } },
'else2': {
'*': { action_: 'copy' } }
}),
actions: {}
},
'text': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'{...}': {
'*': { action_: 'text=' } },
'${(...)}$__$(...)$': {
'*': { action_: 'tex-math' } },
'\\greek': {
'*': { action_: [ 'output', 'rm' ] } },
'\\pu{(...)}': {
'*': { action_: [ 'output', { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'\\,|\\x{}{}|\\x{}|\\x': {
'*': { action_: [ 'output', 'copy' ] } },
'else': {
'*': { action_: 'text=' } }
}),
actions: {
'output': function (buffer): undefined | Parsed {
if (buffer.text_) {
let ret: Parsed = { type_: 'text', p1: buffer.text_ };
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
}
return undefined;
}
}
},
'pq': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: [] } },
'state of aggregation $': {
'*': { action_: 'state of aggregation' } },
'i$': {
'0': { action_: [], nextState: '!f', revisit: true } },
'(KV letters),': {
'0': { action_: 'rm', nextState: '0' } },
'formula$': {
'0': { action_: [], nextState: 'f', revisit: true } },
'1/2$': {
'0': { action_: '1/2' } },
'else': {
'0': { action_: [], nextState: '!f', revisit: true } },
'${(...)}$__$(...)$': {
'*': { action_: 'tex-math' } },
'{(...)}': {
'*': { action_: 'text' } },
'a-z': {
'f': { action_: 'tex-math' } },
'letters': {
'*': { action_: 'rm' } },
'-9.,9': {
'*': { action_: '9,9' } },
',': {
'*': { action_: { type_: 'insert+p1', option: 'comma enumeration S' } } },
'\\color{(...)}{(...)}': {
'*': { action_: 'color-output' } },
'\\color{(...)}': {
'*': { action_: 'color0-output' } },
'\\ce{(...)}': {
'*': { action_: 'ce' } },
'\\pu{(...)}': {
'*': { action_: [ { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'\\,|\\x{}{}|\\x{}|\\x': {
'*': { action_: 'copy' } },
'else2': {
'*': { action_: 'copy' } }
}),
actions: {
'state of aggregation': function (_buffer, m) {
return { type_: 'state of aggregation subscript', p1: _mhchemParser.go(m, 'o') };
},
'color-output': function (_buffer, m) {
return { type_: 'color', color1: m[0], color2: _mhchemParser.go(m[1], 'pq') };
}
}
},
'bd': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: [] } },
'x$': {
'0': { action_: [], nextState: '!f', revisit: true } },
'formula$': {
'0': { action_: [], nextState: 'f', revisit: true } },
'else': {
'0': { action_: [], nextState: '!f', revisit: true } },
'-9.,9 no missing 0': {
'*': { action_: '9,9' } },
'.': {
'*': { action_: { type_: 'insert', option: 'electron dot' } } },
'a-z': {
'f': { action_: 'tex-math' } },
'x': {
'*': { action_: { type_: 'insert', option: 'KV x' } } },
'letters': {
'*': { action_: 'rm' } },
'\'': {
'*': { action_: { type_: 'insert', option: 'prime' } } },
'${(...)}$__$(...)$': {
'*': { action_: 'tex-math' } },
'{(...)}': {
'*': { action_: 'text' } },
'\\color{(...)}{(...)}': {
'*': { action_: 'color-output' } },
'\\color{(...)}': {
'*': { action_: 'color0-output' } },
'\\ce{(...)}': {
'*': { action_: 'ce' } },
'\\pu{(...)}': {
'*': { action_: [ { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'\\,|\\x{}{}|\\x{}|\\x': {
'*': { action_: 'copy' } },
'else2': {
'*': { action_: 'copy' } }
}),
actions: {
'color-output': function (_buffer, m) {
return { type_: 'color', color1: m[0], color2: _mhchemParser.go(m[1], 'bd') };
}
}
},
'oxidation': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'roman-numeral' } },
'pm-operator': {
'*': { action_: { type_: 'o=+p1', option: "\\pm" } } },
'else': {
'*': { action_: 'o=' } }
}),
actions: {
'roman-numeral': function (buffer) { return { type_: 'roman numeral', p1: buffer.o || "" }; }
}
},
'tex-math': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'\\ce{(...)}': {
'*': { action_: [ 'output', 'ce' ] } },
'\\pu{(...)}': {
'*': { action_: [ 'output', { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'{...}|\\,|\\x{}{}|\\x{}|\\x': {
'*': { action_: 'o=' } },
'else': {
'*': { action_: 'o=' } }
}),
actions: {
'output': function (buffer): undefined | Parsed {
if (buffer.o) {
let ret: Parsed = { type_: 'tex-math', p1: buffer.o };
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
}
return undefined;
}
}
},
'tex-math tight': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'\\ce{(...)}': {
'*': { action_: [ 'output', 'ce' ] } },
'\\pu{(...)}': {
'*': { action_: [ 'output', { type_: 'write', option: "{" }, 'pu', { type_: 'write', option: "}" } ] } },
'{...}|\\,|\\x{}{}|\\x{}|\\x': {
'*': { action_: 'o=' } },
'-|+': {
'*': { action_: 'tight operator' } },
'else': {
'*': { action_: 'o=' } }
}),
actions: {
'tight operator': function (buffer, m) { buffer.o = (buffer.o || "") + "{" + m + "}"; return undefined; },
'output': function (buffer): undefined | Parsed {
if (buffer.o) {
let ret: Parsed = { type_: 'tex-math', p1: buffer.o };
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
}
return undefined;
}
}
},
'9,9': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: [] } },
',': {
'*': { action_: 'comma' } },
'else': {
'*': { action_: 'copy' } }
}),
actions: {
'comma': function () { return { type_: 'commaDecimal' }; }
}
},
//#endregion
//
// \pu state machines
//
//#region pu
'pu': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'space$': {
'*': { action_: [ 'output', 'space' ] } },
'{[(|)]}': {
'0|a': { action_: 'copy' } },
'(-)(9)^(-9)': {
'0': { action_: 'number^', nextState: 'a' } },
'(-)(9.,9)(e)(99)': {
'0': { action_: 'enumber', nextState: 'a' } },
'space': {
'0|a': { action_: [] } },
'pm-operator': {
'0|a': { action_: { type_: 'operator', option: '\\pm' }, nextState: '0' } },
'operator': {
'0|a': { action_: 'copy', nextState: '0' } },
'//': {
'd': { action_: 'o=', nextState: '/' } },
'/': {
'd': { action_: 'o=', nextState: '/' } },
'{...}|else': {
'0|d': { action_: 'd=', nextState: 'd' },
'a': { action_: [ 'space', 'd=' ], nextState: 'd' },
'/|q': { action_: 'q=', nextState: 'q' } }
}),
actions: {
'enumber': function (_buffer, m) {
let ret: Parsed[] = [];
if (m[0] === "+-" || m[0] === "+/-") {
ret.push("\\pm ");
} else if (m[0]) {
ret.push(m[0]);
}
if (m[1]) { // 1.2
_mhchemParser.concatArray(ret, _mhchemParser.go(m[1], 'pu-9,9'));
if (m[2]) {
if (m[2].match(/[,.]/)) { // 1.23456(0.01111)
_mhchemParser.concatArray(ret, _mhchemParser.go(m[2], 'pu-9,9'));
} else { // 1.23456(1111) - without spacings
ret.push(m[2]);
}
}
if (m[3] || m[4]) { // 1.2e7 1.2x10^7
if (m[3] === "e" || m[4] === "*") {
ret.push({ type_: 'cdot' });
} else {
ret.push({ type_: 'times' });
}
}
}
if (m[5]) { // 10^7
ret.push("10^{" + m[5] + "}");
}
return ret;
},
'number^': function (_buffer, m) {
let ret: Parsed[] = [];
if (m[0] === "+-" || m[0] === "+/-") {
ret.push("\\pm ");
} else if (m[0]) {
ret.push(m[0]);
}
_mhchemParser.concatArray(ret, _mhchemParser.go(m[1], 'pu-9,9'));
ret.push("^{" + m[2] + "}");
return ret;
},
'operator': function (_buffer, m, p1) { return { type_: 'operator', kind_: (p1 || m) } as Parsed; },
'space': function () { return { type_: 'pu-space-1' }; },
'output': function (buffer) {
let ret: Parsed | Parsed[];
const md = _mhchemParser.patterns.match_('{(...)}', buffer.d || "");
if (md && md.remainder === '') { buffer.d = md.match_ as string; }
const mq = _mhchemParser.patterns.match_('{(...)}', buffer.q || "");
if (mq && mq.remainder === '') { buffer.q = mq.match_ as string; }
if (buffer.d) {
buffer.d = buffer.d.replace(/\u00B0C|\^oC|\^{o}C/g, "{}^{\\circ}C");
buffer.d = buffer.d.replace(/\u00B0F|\^oF|\^{o}F/g, "{}^{\\circ}F");
}
if (buffer.q) { // fraction
buffer.q = buffer.q.replace(/\u00B0C|\^oC|\^{o}C/g, "{}^{\\circ}C");
buffer.q = buffer.q.replace(/\u00B0F|\^oF|\^{o}F/g, "{}^{\\circ}F");
const b5 = {
d: _mhchemParser.go(buffer.d, 'pu'),
q: _mhchemParser.go(buffer.q, 'pu')
};
if (buffer.o === '//') {
ret = { type_: 'pu-frac', p1: b5.d, p2: b5.q };
} else {
ret = b5.d;
if (b5.d.length > 1 || b5.q.length > 1) {
ret.push({ type_: ' / ' });
} else {
ret.push({ type_: '/' });
}
_mhchemParser.concatArray(ret, b5.q);
}
} else { // no fraction
ret = _mhchemParser.go(buffer.d, 'pu-2');
}
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
}
}
},
'pu-2': {
transitions: _mhchemCreateTransitions({
'empty': {
'*': { action_: 'output' } },
'*': {
'*': { action_: [ 'output', 'cdot' ], nextState: '0' } },
'\\x': {
'*': { action_: 'rm=' } },
'space': {
'*': { action_: [ 'output', 'space' ], nextState: '0' } },
'^{(...)}|^(-1)': {
'1': { action_: '^(-1)' } },
'-9.,9': {
'0': { action_: 'rm=', nextState: '0' },
'1': { action_: '^(-1)', nextState: '0' } },
'{...}|else': {
'*': { action_: 'rm=', nextState: '1' } }
}),
actions: {
'cdot': function () { return { type_: 'tight cdot' }; },
'^(-1)': function (buffer, m) { buffer.rm += "^{" + m + "}"; return undefined; },
'space': function () { return { type_: 'pu-space-2' }; },
'output': function (buffer) {
let ret: Parsed | Parsed[] = [];
if (buffer.rm) {
const mrm = _mhchemParser.patterns.match_('{(...)}', buffer.rm || "") as MatchResult;
if (mrm && mrm.remainder === '') {
ret = _mhchemParser.go(mrm.match_, 'pu');
} else {
ret = { type_: 'rm', p1: buffer.rm };
}
}
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
}
}
},
'pu-9,9': {
transitions: _mhchemCreateTransitions({
'empty': {
'0': { action_: 'output-0' },
'o': { action_: 'output-o' } },
',': {
'0': { action_: [ 'output-0', 'comma' ], nextState: 'o' } },
'.': {
'0': { action_: [ 'output-0', 'copy' ], nextState: 'o' } },
'else': {
'*': { action_: 'text=' } }
}),
actions: {
'comma': function () { return { type_: 'commaDecimal' }; },
'output-0': function (buffer) {
let ret: Parsed[] = [];
buffer.text_ = buffer.text_ || "";
if (buffer.text_.length > 4) {
let a = buffer.text_.length % 3;
if (a === 0) { a = 3; }
for (let i=buffer.text_.length-3; i>0; i-=3) {
ret.push(buffer.text_.substr(i, 3));
ret.push({ type_: '1000 separator' });
}
ret.push(buffer.text_.substr(0, a));
ret.reverse();
} else {
ret.push(buffer.text_);
}
//@ts-ignore
for (const p in buffer) { delete buffer[p]; }
return ret;
},
'output-o': function (buffer) {
let ret: Parsed[] = [];
buffer.text_ = buffer.text_ || "";
if (buffer.text_.length > 4) {
const a = buffer.text_.length - 3;
let i: number;
for (i=0; i" || buf.r === "<=>>" || buf.r === "<<=>" || buf.r === "<-->") {
// arrows that cannot stretch correctly yet, https://github.com/mathjax/MathJax/issues/1491
arrow = "\\long" + arrow;
if (b6.rd) { arrow = "\\overset{" + b6.rd + "}{" + arrow + "}"; }
if (b6.rq) {
if (buf.r === "<-->") {
arrow = "\\underset{\\lower2mu{" + b6.rq + "}}{" + arrow + "}";
} else {
arrow = "\\underset{\\lower6mu{" + b6.rq + "}}{" + arrow + "}"; // align with ->[][under]
}
}
arrow = " {}\\mathrel{" + arrow + "}{} ";
} else {
if (b6.rq) { arrow += "[{" + b6.rq + "}]"; }
arrow += "{" + b6.rd + "}";
arrow = " {}\\mathrel{\\x" + arrow + "}{} ";
}
} else {
arrow = " {}\\mathrel{\\long" + arrow + "}{} ";
}
res = arrow;
break;
case 'operator':
res = _mhchemTexify._getOperator(buf.kind_);
break;
case '1st-level escape':
res = buf.p1 + " "; // &, \\\\, \\hline
break;
case 'space':
res = " ";
break;
case 'tinySkip':
res = '\\mkern2mu';
break;
case 'entitySkip':
res = "~";
break;
case 'pu-space-1':
res = "~";
break;
case 'pu-space-2':
res = "\\mkern3mu ";
break;
case '1000 separator':
res = "\\mkern2mu ";
break;
case 'commaDecimal':
res = "{,}";
break;
case 'comma enumeration L':
res = "{" + buf.p1 + "}\\mkern6mu ";
break;
case 'comma enumeration M':
res = "{" + buf.p1 + "}\\mkern3mu ";
break;
case 'comma enumeration S':
res = "{" + buf.p1 + "}\\mkern1mu ";
break;
case 'hyphen':
res = "\\text{-}";
break;
case 'addition compound':
res = "\\,{\\cdot}\\,";
break;
case 'electron dot':
res = "\\mkern1mu \\bullet\\mkern1mu ";
break;
case 'KV x':
res = "{\\times}";
break;
case 'prime':
res = "\\prime ";
break;
case 'cdot':
res = "\\cdot ";
break;
case 'tight cdot':
res = "\\mkern1mu{\\cdot}\\mkern1mu ";
break;
case 'times':
res = "\\times ";
break;
case 'circa':
res = "{\\sim}";
break;
case '^':
res = "uparrow";
break;
case 'v':
res = "downarrow";
break;
case 'ellipsis':
res = "\\ldots ";
break;
case '/':
res = "/";
break;
case ' / ':
res = "\\,/\\,";
break;
default:
assertNever(buf);
throw ["MhchemBugT", "mhchem bug T. Please report."]; // Missing mhchemTexify rule or unknown MhchemParser output
}
return res;
},
_getArrow: function (a) {
switch (a) {
case "->": return "rightarrow";
case "\u2192": return "rightarrow";
case "\u27F6": return "rightarrow";
case "<-": return "leftarrow";
case "<->": return "leftrightarrow";
case "<-->": return "leftrightarrows";
case "<=>": return "rightleftharpoons";
case "\u21CC": return "rightleftharpoons";
case "<=>>": return "Rightleftharpoons";
case "<<=>": return "Leftrightharpoons";
default:
assertNever(a);
throw ["MhchemBugT", "mhchem bug T. Please report."];
}
},
_getBond: function (a) {
switch (a) {
case "-": return "{-}";
case "1": return "{-}";
case "=": return "{=}";
case "2": return "{=}";
case "#": return "{\\equiv}";
case "3": return "{\\equiv}";
case "~": return "{\\tripledash}";
case "~-": return "{\\rlap{\\lower.1em{-}}\\raise.1em{\\tripledash}}";
case "~=": return "{\\rlap{\\lower.2em{-}}\\rlap{\\raise.2em{\\tripledash}}-}";
case "~--": return "{\\rlap{\\lower.2em{-}}\\rlap{\\raise.2em{\\tripledash}}-}";
case "-~-": return "{\\rlap{\\lower.2em{-}}\\rlap{\\raise.2em{-}}\\tripledash}";
case "...": return "{{\\cdot}{\\cdot}{\\cdot}}";
case "....": return "{{\\cdot}{\\cdot}{\\cdot}{\\cdot}}";
case "->": return "{\\rightarrow}";
case "<-": return "{\\leftarrow}";
case "<": return "{<}";
case ">": return "{>}";
default:
assertNever(a);
throw ["MhchemBugT", "mhchem bug T. Please report."];
}
},
_getOperator: function (a) {
switch (a) {
case "+": return " {}+{} ";
case "-": return " {}-{} ";
case "=": return " {}={} ";
case "<": return " {}<{} ";
case ">": return " {}>{} ";
case "<<": return " {}\\ll{} ";
case ">>": return " {}\\gg{} ";
case "\\pm": return " {}\\pm{} ";
case "\\approx": return " {}\\approx{} ";
case "$\\approx$": return " {}\\approx{} ";
case "v": return " \\downarrow{} ";
case "(v)": return " \\downarrow{} ";
case "^": return " \\uparrow{} ";
case "(^)": return " \\uparrow{} ";
default:
assertNever(a);
throw ["MhchemBugT", "mhchem bug T. Please report."];
}
}
};
//
// Helpers for code anaylsis
// Will show type error at calling position
//
//@ts-ignore
function assertNever(a: number) {}
package/LICENSE.txt 000644 0000026135 3560116604 011112 0 ustar 00 000000 000000 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.