mirror of
https://github.com/Smaug123/KaTeX
synced 2025-10-05 11:18:39 +00:00
5a4aedd882
* Make ParseNode `value` payload type-safe. * Make defineFunction handlers aware of ParseNode data types. * Add `type` to all function definitions to help determine handler return type. * Added unit test for case caught only in screenshot test and fixed issue. * Rename some symbol `Group`s to avoid conflicts with `ParseNode` groups. Symbol `Group`s are also used as `ParseNode` types. However, `ParseNode`s of these types always contain a raw text token as opposed to any structured content. These `ParseNode`s are passed as arguments into function handlers to create more semantical `ParseNode`s with more structure. Before this change, "accent" and "op" were both symbol `Group`s and `ParseNode` types. With this change, these two types (the raw accent token `ParseNode`, and the structured semantical `ParseNode` are separated for better type-safety on the `ParseNode` payload). * stretchy: Remove FlowFixMe for a forced typecast that's no longer needed.
118 lines
3.3 KiB
JavaScript
118 lines
3.3 KiB
JavaScript
// @flow
|
|
import {groupTypes as htmlGroupTypes} from "./buildHTML";
|
|
import {groupTypes as mathmlGroupTypes} from "./buildMathML";
|
|
|
|
import Options from "./Options";
|
|
import ParseNode from "./ParseNode";
|
|
|
|
import type Parser from "./Parser";
|
|
import type {ArgType, Mode} from "./types";
|
|
|
|
/**
|
|
* The context contains the following properties:
|
|
* - mode: current parsing mode.
|
|
* - envName: the name of the environment, one of the listed names.
|
|
* - parser: the parser object.
|
|
*/
|
|
type EnvContext = {|
|
|
mode: Mode,
|
|
envName: string,
|
|
parser: Parser,
|
|
|};
|
|
|
|
/**
|
|
* - context: information and references provided by the parser
|
|
* - args: an array of arguments passed to \begin{name}
|
|
* - optArgs: an array of optional arguments passed to \begin{name}
|
|
*/
|
|
type EnvHandler = (
|
|
context: EnvContext,
|
|
args: ParseNode<*>[],
|
|
optArgs: (?ParseNode<*>)[],
|
|
) => ParseNode<*>;
|
|
|
|
/**
|
|
* - numArgs: (default 0) The number of arguments after the \begin{name} function.
|
|
* - argTypes: (optional) Just like for a function
|
|
* - allowedInText: (default false) Whether or not the environment is allowed
|
|
* inside text mode (not enforced yet).
|
|
* - numOptionalArgs: (default 0) Just like for a function
|
|
*/
|
|
type EnvProps = {
|
|
numArgs: number,
|
|
};
|
|
|
|
/**
|
|
* Final enviornment spec for use at parse time.
|
|
* This is almost identical to `EnvDefSpec`, except it
|
|
* 1. includes the function handler
|
|
* 2. requires all arguments except argType
|
|
* It is generated by `defineEnvironment()` below.
|
|
*/
|
|
export type EnvSpec = {|
|
|
numArgs: number,
|
|
argTypes?: ArgType[],
|
|
greediness: number,
|
|
allowedInText: boolean,
|
|
numOptionalArgs: number,
|
|
handler: EnvHandler,
|
|
|};
|
|
|
|
/**
|
|
* All registered environments.
|
|
* `environments.js` exports this same dictionary again and makes it public.
|
|
* `Parser.js` requires this dictionary via `environments.js`.
|
|
*/
|
|
export const _environments: {[string]: EnvSpec} = {};
|
|
|
|
type EnvDefSpec = {|
|
|
// Unique string to differentiate parse nodes.
|
|
type: string,
|
|
|
|
// List of functions which use the give handler, htmlBuilder,
|
|
// and mathmlBuilder.
|
|
names: Array<string>,
|
|
|
|
// Properties that control how the environments are parsed.
|
|
props: EnvProps,
|
|
|
|
handler: EnvHandler,
|
|
|
|
// This function returns an object representing the DOM structure to be
|
|
// created when rendering the defined LaTeX function.
|
|
// TODO: Port buildHTML to flow and make the group and return types explicit.
|
|
htmlBuilder: (group: *, options: Options) => *,
|
|
|
|
// This function returns an object representing the MathML structure to be
|
|
// created when rendering the defined LaTeX function.
|
|
// TODO: Port buildMathML to flow and make the group and return types explicit.
|
|
mathmlBuilder: (group: *, options: Options) => *,
|
|
|};
|
|
|
|
export default function defineEnvironment({
|
|
type,
|
|
names,
|
|
props,
|
|
handler,
|
|
htmlBuilder,
|
|
mathmlBuilder,
|
|
}: EnvDefSpec) {
|
|
// Set default values of environments
|
|
const data = {
|
|
numArgs: props.numArgs || 0,
|
|
greediness: 1,
|
|
allowedInText: false,
|
|
numOptionalArgs: 0,
|
|
handler: handler,
|
|
};
|
|
for (let i = 0; i < names.length; ++i) {
|
|
_environments[names[i]] = data;
|
|
}
|
|
if (htmlBuilder) {
|
|
htmlGroupTypes[type] = htmlBuilder;
|
|
}
|
|
if (mathmlBuilder) {
|
|
mathmlGroupTypes[type] = mathmlBuilder;
|
|
}
|
|
}
|