starmath/inc/mathml/def.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #pragma once
  11
  12 #include <tools/color.hxx>
  13
  14 /* All possible data needed to do the job outside mathml limits */
  15 // Ml prefix means it is part of mathml standard
  16 // NMl means it is not part of mathml standard but needed info to work
  17
  18 /* For now empty, don't know yet what's needed besides default font size. */
  19 struct SmGlobalData
  20 {
  21 };
  22
  23 /* Mhtml length tools */
  24 /*************************************************************************************************/
  25
  26 enum class SmLengthUnit : uint_fast8_t
  27 {
  28     MlEm,
  29     MlEx,
  30     MlPx,
  31     MlIn,
  32     MlCm,
  33     MlMm,
  34     MlPt,
  35     MlPc,
  36     MlP, // Percent
  37     MlM // Multiplier
  38 };
  39
  40 struct SmLengthValue
  41 {
  42     SmLengthUnit m_aLengthUnit;
  43     double m_aLengthValue;
  44     // Keeps original text value to avoid numerical error data loss
  45     OUString* m_aOriginalText;
  46 };
  47
  48 /* Possible mathml elements */
  49 /*************************************************************************************************/
  50
  51 enum class SmMlElementType : uint_fast8_t
  52 {
  53     // Used for base element. Means no information contained.
  54     NMlEmpty,
  55     // Used for structural dependencies. Means no information contained.
  56     NMlStructural,
  57     NMlSmNode,
  58     // Mathml real elements
  59     MlMath,
  60     MlMi,
  61     MlMerror,
  62     MlMn,
  63     MlMo,
  64     MlMrow,
  65     MlMtext,
  66     MlMstyle
  67 };
  68
  69 /* Possible mathml attributes */
  70 /*************************************************************************************************/
  71
  72 enum class SmMlAttributeValueType : uint_fast8_t
  73 {
  74     NMlEmpty,
  75     MlAccent,
  76     MlDir,
  77     MlDisplaystyle,
  78     MlFence,
  79     MlForm,
  80     MlHref,
  81     MlLspace,
  82     MlMathbackground,
  83     MlMathcolor,
  84     MlMathsize,
  85     MlMathvariant,
  86     MlMaxsize,
  87     MlMinsize,
  88     MlMovablelimits,
  89     MlRspace,
  90     MlSeparator,
  91     MlStretchy,
  92     MlSymmetric
  93 };
  94
  95 /* Possible values of mathml attributes */
  96 /*************************************************************************************************/
  97
  98 enum class SmMlAttributeValueEmpty : uint_fast8_t
  99 {
 100     MlEmpty = 0x00
 101 };
 102
 103 enum class SmMlAttributeValueAccent : uint_fast8_t
 104 {
 105     MlFalse = 0x00,
 106     MlTrue = 0x01
 107 };
 108
 109 enum class SmMlAttributeValueDir : uint_fast8_t
 110 {
 111     MlLtr = 0x00,
 112     MlRtl = 0x01
 113 };
 114
 115 enum class SmMlAttributeValueDisplaystyle : uint_fast8_t
 116 {
 117     MlFalse = 0x00,
 118     MlTrue = 0x01
 119 };
 120
 121 enum class SmMlAttributeValueFence : uint_fast8_t
 122 {
 123     MlFalse = 0x00,
 124     MlTrue = 0x01
 125 };
 126
 127 enum class SmMlAttributeValueForm : uint_fast8_t
 128 {
 129     MlPrefix = 0x01,
 130     MlInfix = 0x02,
 131     MlPosfix = 0x04
 132 };
 133
 134 enum class SmMlAttributeValueHref : uint_fast8_t
 135 {
 136     NMlEmpty = 0x00,
 137     NMlValid = 0x01
 138 };
 139
 140 enum class SmMlAttributeValueLspace : uint_fast8_t
 141 {
 142     NMlEmpty = 0x00
 143 };
 144
 145 enum class SmMlAttributeValueMathbackground : uint_fast32_t
 146 {
 147     MlTransparent = 0x00,
 148     MlRgb = 0x01
 149 };
 150
 151 enum class SmMlAttributeValueMathcolor : uint_fast8_t
 152 {
 153     MlDefault = 0x00,
 154     MlRgb = 0x01
 155 };
 156
 157 enum class SmMlAttributeValueMathsize : uint_fast8_t
 158 {
 159     NMlEmpty = 0x00,
 160 };
 161
 162 enum class SmMlAttributeValueMathvariant : uint_fast16_t
 163 {
 164     normal = 0x000,
 165     bold = 0x001,
 166     italic = 0x002,
 167     double_struck = 0x004,
 168     script = 0x008,
 169     fraktur = 0x010,
 170     sans_serif = 0x020,
 171     monospace = 0x040,
 172     bold_italic = 0x001 | 0x002,
 173     bold_fraktur = 0x001 | 0x010,
 174     bold_script = 0x001 | 0x008,
 175     bold_sans_serif = 0x001 | 0x020,
 176     sans_serif_italic = 0x002 | 0x20,
 177     sans_serif_bold_italic = 0x001 | 0x002 | 0x020,
 178     // Non english
 179     initial = 0x080,
 180     tailed = 0x100,
 181     looped = 0x200,
 182     stretched = 0x400
 183 };
 184
 185 enum class SmMlAttributeValueMaxsize : uint_fast8_t
 186 {
 187     MlInfinity = 0x00,
 188     MlFinite = 0x01
 189 };
 190
 191 /*
 192  * Specifies whether attached under- and overscripts move to sub- and superscript positions when displaystyle is false.
 193  * Source: https://developer.mozilla.org/en-US/docs/Web/MathML/Element/mo
 194  */
 195 enum class SmMlAttributeValueMovablelimits : uint_fast8_t
 196 {
 197     MlFalse = 0x00,
 198     MlTrue = 0x01
 199 };
 200
 201 enum class SmMlAttributeValueRspace : uint_fast8_t
 202 {
 203     NMlEmpty = 0x00
 204 };
 205
 206 enum class SmMlAttributeValueSeparator : uint_fast8_t
 207 {
 208     MlFalse = 0x00,
 209     MlTrue = 0x01
 210 };
 211
 212 enum class SmMlAttributeValueStretchy : uint_fast8_t
 213 {
 214     MlFalse = 0x00,
 215     MlTrue = 0x01
 216 };
 217
 218 enum class SmMlAttributeValueSymmetric : uint_fast8_t
 219 {
 220     MlFalse = 0x00,
 221     MlTrue = 0x01
 222 };
 223
 224 /* Structures for all possible attributes */
 225 /*************************************************************************************************/
 226
 227 struct SmMlAccent
 228 {
 229     SmMlAttributeValueAccent m_aAccent;
 230 };
 231
 232 struct SmMlDir
 233 {
 234     SmMlAttributeValueDir m_aDir;
 235 };
 236
 237 struct SmMlDisplaystyle
 238 {
 239     SmMlAttributeValueDisplaystyle m_aDisplaystyle;
 240 };
 241
 242 struct SmMlFence
 243 {
 244     SmMlAttributeValueFence m_aFence;
 245 };
 246
 247 struct SmMlForm
 248 {
 249     SmMlAttributeValueForm m_aForm;
 250 };
 251
 252 struct SmMlHref
 253 {
 254     SmMlAttributeValueHref m_aHref;
 255     OUString* m_aLnk;
 256 };
 257
 258 struct SmMlLspace
 259 {
 260     SmLengthValue m_aLengthValue;
 261 };
 262
 263 struct SmMlMathbackground
 264 {
 265     SmMlAttributeValueMathbackground m_aMathbackground;
 266     Color m_aCol;
 267 };
 268
 269 struct SmMlMathcolor
 270 {
 271     SmMlAttributeValueMathcolor m_aMathcolor;
 272     Color m_aCol;
 273 };
 274
 275 struct SmMlMathsize
 276 {
 277     SmLengthValue m_aLengthValue;
 278 };
 279
 280 struct SmMlMathvariant
 281 {
 282     SmMlAttributeValueMathvariant m_aMathvariant;
 283 };
 284
 285 struct SmMlMaxsize
 286 {
 287     SmMlAttributeValueMaxsize m_aMaxsize;
 288     SmLengthValue m_aLengthValue;
 289 };
 290
 291 struct SmMlMinsize
 292 {
 293     SmLengthValue m_aLengthValue;
 294 };
 295
 296 struct SmMlMovablelimits
 297 {
 298     SmMlAttributeValueMovablelimits m_aMovablelimits;
 299 };
 300
 301 struct SmMlRspace
 302 {
 303     SmLengthValue m_aLengthValue;
 304 };
 305
 306 struct SmMlSeparator
 307 {
 308     SmMlAttributeValueSeparator m_aSeparator;
 309 };
 310
 311 struct SmMlStretchy
 312 {
 313     SmMlAttributeValueStretchy m_aStretchy;
 314 };
 315
 316 struct SmMlSymmetric
 317 {
 318     SmMlAttributeValueSymmetric m_aSymmetric;
 319 };
 320
 321 /* order attributes */
 322 /*************************************************************************************************/
 323
 324 struct SmMlAttributePos
 325 {
 326     SmMlAttributeValueType m_aAttributeValueType;
 327     uint_fast8_t m_nPos;
 328 };
 329
 330 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */