stuff

node_modules/mathjax-full/ts/output/svg/Notation.ts

@@ -0,0 +1,177 @@
+/*************************************************************
+ *
+ *  Copyright (c) 2018-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 utilities for notations for menclose elements
+ *
+ * @author dpvc@mathjax.org (Davide Cervone)
+ */
+
+import {SVGmenclose} from './Wrappers/menclose.js';
+import * as Notation from '../common/Notation.js';
+export * from '../common/Notation.js';
+
+/*******************************************************************/
+
+/**
+ * Shorthand for SVGmenclose
+ */
+export type Menclose = SVGmenclose<any, any, any>;
+
+
+/*
+ * Shorthands for common types
+ */
+export type RENDERER<N, T, D> = Notation.Renderer<SVGmenclose<N, T, D>, N>;
+export type DEFPAIR<N, T, D> = Notation.DefPair<SVGmenclose<N, T, D>, N>;
+
+/**
+ * The kinds of lines that can be drawn
+ */
+export type LineName = Notation.Side | ('vertical' | 'horizontal' | 'up' | 'down');
+
+/**
+ * [x1,y1, x2,y2] endpoints for a line
+ */
+export type LineData = [number, number, number, number];
+
+/**
+ * Functions for computing the line data for each type of line
+ */
+export const computeLineData = {
+  top: (h, _d, w, t) => [0, h - t, w, h - t],
+  right: (h, d, w, t) => [w - t, -d, w - t, h],
+  bottom: (_h, d, w, t) => [0, t - d, w, t - d],
+  left: (h, d, _w, t) => [t, -d, t, h],
+  vertical: (h, d, w, _t) => [w / 2, h, w / 2, -d],
+  horizontal: (h, d, w, _t) => [0, (h - d) / 2, w, (h - d) / 2],
+  up: (h, d, w, t) => [t, t - d, w - t, h - t],
+  down: (h, d, w, t) => [t, h - t, w - t, t - d]
+} as {[kind: string]: (h: number, d: number, w: number, t: number) => LineData};
+
+/**
+ * The data for a given line as two endpoints: [x1, y1, x2, y1]
+ *
+ * @param {Menclose} node   The node whose line is to be drawn
+ * @param {LineName} kind   The type of line to draw for the node
+ * @param {string} offset   The offset direction, if any
+ * @return {LineData}       The coordinates of the two endpoints
+ */
+export const lineData = function(node: Menclose, kind: LineName, offset: string = ''): LineData {
+  const {h, d, w} = node.getBBox();
+  const t = node.thickness / 2;
+  return lineOffset(computeLineData[kind](h, d, w, t), node, offset);
+};
+
+/**
+ * Recenter the line data for vertical and horizontal lines
+ *
+ * @param {LineData} data   The line endpoints to adjust
+ * @param {Menclose} node   The menclose node
+ * @param {string} offset   The direction to offset
+ */
+export const lineOffset = function(data: LineData, node: Menclose, offset: string): LineData {
+  if (offset) {
+    const d = node.getOffset(offset);
+    if (d) {
+      if (offset === 'X') {
+        data[0] -= d;
+        data[2] -= d;
+      } else {
+        data[1] -= d;
+        data[3] -= d;
+      }
+    }
+  }
+  return data;
+};
+
+
+/*******************************************************************/
+
+/**
+ * @param {LineName} line  The name of the line to create
+ * @return {RENDERER}      The renderer function for the given line
+ */
+export const RenderLine = function<N, T, D>(line: LineName, offset: string = ''): RENDERER<N, T, D> {
+  return ((node, _child) => {
+    const L = node.line(lineData(node, line, offset));
+    node.adaptor.append(node.element, L);
+  });
+};
+
+/*******************************************************************/
+
+/**
+ * @param {Notation.Side} side   The kind of line (side, diagonal, etc.)
+ * @return {DEFPAIR}      The notation definition for the notation having a line on the given side
+ */
+export const Border = function<N, T, D>(side: Notation.Side): DEFPAIR<N, T, D> {
+  return Notation.CommonBorder<SVGmenclose<N, T, D>, N>((node, _child) => {
+    node.adaptor.append(node.element, node.line(lineData(node, side)));
+  })(side);
+};
+
+
+/**
+ * @param {string} name    The name of the notation to define
+ * @param {Notation.Side} side1   The first side to get a border
+ * @param {Notation.Side} side2   The second side to get a border
+ * @return {DEFPAIR}       The notation definition for the notation having lines on two sides
+ */
+export const Border2 = function<N, T, D>(name: string, side1: Notation.Side, side2: Notation.Side): DEFPAIR<N, T, D> {
+  return Notation.CommonBorder2<SVGmenclose<N, T, D>, N>((node, _child) => {
+    node.adaptor.append(node.element, node.line(lineData(node, side1)));
+    node.adaptor.append(node.element, node.line(lineData(node, side2)));
+  })(name, side1, side2);
+};
+
+/*******************************************************************/
+
+/**
+ * @param {LineName} name  The name of the diagonal strike to define
+ * @return {DEFPAIR}       The notation definition for the diagonal strike
+ */
+export const DiagonalStrike = function<N, T, D>(name: LineName): DEFPAIR<N, T, D> {
+  return Notation.CommonDiagonalStrike<SVGmenclose<N, T, D>, N>((_cname: string) => (node, _child) => {
+    node.adaptor.append(node.element, node.line(lineData(node, name)));
+  })(name);
+};
+
+/*******************************************************************/
+
+/**
+ * @param {string} name   The name of the diagonal arrow to define
+ * @return {DEFPAIR}      The notation definition for the diagonal arrow
+ */
+export const DiagonalArrow = function<N, T, D>(name: string): DEFPAIR<N, T, D> {
+  return Notation.CommonDiagonalArrow<SVGmenclose<N, T, D>, N>((node, arrow) => {
+    node.adaptor.append(node.element, arrow);
+  })(name);
+};
+
+/**
+ * @param {string} name   The name of the horizontal or vertical arrow to define
+ * @return {DEFPAIR}      The notation definition for the arrow
+ */
+export const Arrow = function<N, T, D>(name: string): DEFPAIR<N, T, D> {
+  return Notation.CommonArrow<SVGmenclose<N, T, D>, N>((node, arrow) => {
+    node.adaptor.append(node.element, arrow);
+  })(name);
+};
+
+/*******************************************************************/