site/node_modules/mathjax-full/ts/input/tex/configmacros/ConfigMacrosConfiguration.ts
2024-10-14 08:09:33 +02:00

120 lines
3.6 KiB
TypeScript

/*************************************************************
*
* Copyright (c) 2019-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 Configuration file for the configmacros package.
*
* @author dpvc@mathjax.org (Davide P. Cervone)
*/
import {Configuration, ParserConfiguration} from '../Configuration.js';
import {expandable} from '../../../util/Options.js';
import {CommandMap, EnvironmentMap} from '../SymbolMap.js';
import ParseMethods from '../ParseMethods.js';
import {Macro} from '../Symbol.js';
import NewcommandMethods from '../newcommand/NewcommandMethods.js';
import {BeginEnvItem} from '../newcommand/NewcommandItems.js';
import {TeX} from '../../tex.js';
type TEX = TeX<any, any, any>;
/**
* The name to use for the macros map
*/
const MACROSMAP = 'configmacros-map';
/**
* The name to use for the environment map
*/
const ENVIRONMENTMAP = 'configmacros-env-map';
/**
* Create the command map for the macros
*
* @param {Configuration} config The configuration object for the input jax
*/
function configmacrosInit(config: ParserConfiguration) {
new CommandMap(MACROSMAP, {}, {});
new EnvironmentMap(ENVIRONMENTMAP, ParseMethods.environment, {}, {});
config.append(Configuration.local({
handler: {
macro: [MACROSMAP],
environment: [ENVIRONMENTMAP]
},
priority: 3
}));
}
/**
* Create the user-defined macros and environments from their options
*
* @param {Configuration} config The configuration object for the input jax
* @param {TeX} jax The TeX input jax
*/
function configmacrosConfig(_config: ParserConfiguration, jax: TEX) {
configMacros(jax);
configEnvironments(jax);
}
/**
* Create user-defined macros from the macros option
*
* @param {TeX} jax The TeX input jax
*/
function configMacros(jax: TEX) {
const handler = jax.parseOptions.handlers.retrieve(MACROSMAP) as CommandMap;
const macros = jax.parseOptions.options.macros;
for (const cs of Object.keys(macros)) {
const def = (typeof macros[cs] === 'string' ? [macros[cs]] : macros[cs]);
const macro = Array.isArray(def[2]) ?
new Macro(cs, NewcommandMethods.MacroWithTemplate, def.slice(0, 2).concat(def[2])) :
new Macro(cs, NewcommandMethods.Macro, def);
handler.add(cs, macro);
}
}
/**
* Create user-defined environments from the environments option
*
* @param {TeX} jax The TeX input jax
*/
function configEnvironments(jax: TEX) {
const handler = jax.parseOptions.handlers.retrieve(ENVIRONMENTMAP) as EnvironmentMap;
const environments = jax.parseOptions.options.environments;
for (const env of Object.keys(environments)) {
handler.add(env, new Macro(env, NewcommandMethods.BeginEnv, [true].concat(environments[env])));
}
}
/**
* The configuration object for configmacros
*/
export const ConfigMacrosConfiguration = Configuration.create(
'configmacros', {
init: configmacrosInit,
config: configmacrosConfig,
items: {
[BeginEnvItem.prototype.kind]: BeginEnvItem,
},
options: {
macros: expandable({}),
environments: expandable({})
}
}
);