123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236 |
- /*************************************************************
- *
- * Copyright (c) 2017-2022 The MathJax Consortium
- *
- * 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.
- */
- /**
- * @fileoverview Implements the interface and abstract class for the OutputJax
- *
- * @author dpvc@mathjax.org (Davide Cervone)
- */
- import {userOptions, defaultOptions, OptionList} from '../util/Options.js';
- import {MathDocument} from './MathDocument.js';
- import {MathItem} from './MathItem.js';
- import {DOMAdaptor} from '../core/DOMAdaptor.js';
- import {FunctionList} from '../util/FunctionList.js';
- /*****************************************************************/
- /**
- * The OutputJax interface
- *
- * @template N The HTMLElement node class
- * @template T The Text node class
- * @template D The Document class
- */
- export interface OutputJax<N, T, D> {
- /**
- * The name of this output jax class
- */
- name: string;
- /**
- * The options for the instance
- */
- options: OptionList;
- /**
- * Lists of post-filters to call after typesetting the math
- */
- postFilters: FunctionList;
- /**
- * The DOM adaptor for managing HTML elements
- */
- adaptor: DOMAdaptor<N, T, D>;
- /**
- * @param {DOMAdaptor} adaptor The adaptor to use in this jax
- */
- setAdaptor(adaptor: DOMAdaptor<N, T, D>): void;
- /**
- * Do any initialization that depends on the document being set up
- */
- initialize(): void;
- /**
- * Reset any needed features of the output jax
- *
- * @param {any[]} args The arguments needed by the reset operation
- */
- reset(...args: any[]): void;
- /**
- * Typset a given MathItem
- *
- * @param {MathItem} math The MathItem to be typeset
- * @param {MathDocument} document The MathDocument in which the typesetting should occur
- * @return {N} The DOM tree for the typeset math
- */
- typeset(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
- /**
- * Handle an escaped character (e.g., \$ from the TeX input jax preventing it from being a delimiter)
- *
- * @param {MathItem} math The MathItem to be escaped
- * @param {MathDocument} document The MathDocument in which the math occurs
- * @return {N} The DOM tree for the escaped item
- */
- escaped(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
- /**
- * Get the metric information for all math in the given document
- *
- * @param {MathDocument} document The MathDocument being processed
- */
- getMetrics(document: MathDocument<N, T, D>): void;
- /**
- * Produce the stylesheet needed for this output jax
- *
- * @param {MathDocument} document The MathDocument being processed
- */
- styleSheet(document: MathDocument<N, T, D>): N;
- /**
- * Produce any page-specific elements needed for this output jax
- *
- * @param {MathDocument} document The MathDocument being processed
- */
- pageElements(document: MathDocument<N, T, D>): N;
- }
- /*****************************************************************/
- /**
- * The OutputJax abstract class
- *
- * @template N The HTMLElement node class
- * @template T The Text node class
- * @template D The Document class
- */
- export abstract class AbstractOutputJax<N, T, D> implements OutputJax<N, T, D> {
- /**
- * The name for the output jax
- */
- public static NAME: string = 'generic';
- /**
- * The default options for the output jax
- */
- public static OPTIONS: OptionList = {};
- /**
- * The actual options supplied to the output jax
- */
- public options: OptionList;
- /**
- * Filters to run after the output is processed
- */
- public postFilters: FunctionList;
- /**
- * The MathDocument's DOMAdaptor
- */
- public adaptor: DOMAdaptor<N, T, D> = null; // set by the handler
- /**
- * @param {OptionList} options The options for this instance
- */
- constructor(options: OptionList = {}) {
- let CLASS = this.constructor as typeof AbstractOutputJax;
- this.options = userOptions(defaultOptions({}, CLASS.OPTIONS), options);
- this.postFilters = new FunctionList();
- }
- /**
- * @return {string} The name for this output jax class
- */
- public get name(): string {
- return (this.constructor as typeof AbstractOutputJax).NAME;
- }
- /**
- * @override
- */
- public setAdaptor(adaptor: DOMAdaptor<N, T, D>) {
- this.adaptor = adaptor;
- }
- /**
- * @override
- */
- public initialize() {
- }
- /**
- * @override
- */
- public reset(..._args: any[]) {
- }
- /**
- * @override
- */
- public abstract typeset(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
- /**
- * @override
- */
- public abstract escaped(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
- /**
- * @override
- */
- public getMetrics(_document: MathDocument<N, T, D>) {
- }
- /**
- * @override
- */
- public styleSheet(_document: MathDocument<N, T, D>) {
- return null as N;
- }
- /**
- * @override
- */
- public pageElements(_document: MathDocument<N, T, D>) {
- return null as N;
- }
- /**
- * Execute a set of filters, passing them the MathItem and any needed data,
- * and return the (possibly modified) data
- *
- * @param {FunctionList} filters The list of functions to be performed
- * @param {MathItem} math The math item that is being processed
- * @param {MathDocument} document The math document contaiing the math item
- * @param {any} data Whatever other data is needed
- * @return {any} The (possibly modified) data
- */
- protected executeFilters(
- filters: FunctionList, math: MathItem<N, T, D>,
- document: MathDocument<N, T, D>, data: any
- ): any {
- let args = {math, document, data};
- filters.execute(args);
- return args.data;
- }
- }
|