/************************************************************* * * Copyright (c) 2018-2025 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. */ /** * @file Configuration file for the bbox package. * * @author v.sorge@mathjax.org (Volker Sorge) */ import { HandlerType, ConfigurationType } from '../HandlerTypes.js'; import { Configuration } from '../Configuration.js'; import TexParser from '../TexParser.js'; import { CommandMap } from '../TokenMap.js'; import { ParseMethod } from '../Types.js'; import TexError from '../TexError.js'; // Namespace const BboxMethods: { [key: string]: ParseMethod } = { /** * Implements MathJax Bbox macro to pad and colorize background boxes. * * @param {TexParser} parser The current tex parser. * @param {string} name The name of the calling macro. */ BBox(parser: TexParser, name: string) { const bbox = parser.GetBrackets(name, ''); let math = parser.ParseArg(name); const parts = bbox.split(/,/); let def, background, style; for (let i = 0, m = parts.length; i < m; i++) { const part = parts[i].trim(); const match = part.match( /^(\.\d+|\d+(\.\d*)?)(pt|em|ex|mu|px|in|cm|mm)$/ ); if (match) { // @test Bbox-Padding if (def) { // @test Bbox-Padding-Error throw new TexError( 'MultipleBBoxProperty', '%1 specified twice in %2', 'Padding', name ); } const pad = BBoxPadding(match[1] + match[3]); if (pad) { // @test Bbox-Padding def = { height: '+' + pad, depth: '+' + pad, lspace: pad, width: '+' + 2 * parseInt(match[1], 10) + match[3], }; } } else if (part.match(/^([a-z0-9]+|#[0-9a-f]{6}|#[0-9a-f]{3})$/i)) { // @test Bbox-Background if (background) { // @test Bbox-Background-Error throw new TexError( 'MultipleBBoxProperty', '%1 specified twice in %2', 'Background', name ); } background = part; } else if (part.match(/^[-a-z]+:/i)) { // @test Bbox-Frame if (style) { // @test Bbox-Frame-Error throw new TexError( 'MultipleBBoxProperty', '%1 specified twice in %2', 'Style', name ); } style = BBoxStyle(part); } else if (part !== '') { // @test Bbox-General-Error throw new TexError( 'InvalidBBoxProperty', '"%1" doesn\'t look like a color, a padding dimension, or a style', part ); } } if (def) { // @test Bbox-Padding math = parser.create('node', 'mpadded', [math], def); } if (background || style) { def = {}; if (background) { // @test Bbox-Background Object.assign(def, { mathbackground: background }); } if (style) { // @test Bbox-Frame Object.assign(def, { style: style }); } math = parser.create('node', 'mstyle', [math], def); } parser.Push(math); }, }; // Dummy methods. Need to be made Safe with security check. /** * Safety check and return style information for bounding boxes. * * @param {string} styles The bounding box style string. * @returns {string} The transformed bounding box style. */ function BBoxStyle(styles: string): string { return styles; } /** * Safety check and return padding information for bounding boxes. * * @param {string} pad The bounding box padding string. * @returns {string} The transformed bounding box padding. */ function BBoxPadding(pad: string): string { return pad; } new CommandMap('bbox', { bbox: BboxMethods.BBox }); export const BboxConfiguration = Configuration.create('bbox', { [ConfigurationType.HANDLER]: { [HandlerType.MACRO]: ['bbox'] }, });