layout/mathml/nsMathMLOperators.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsMathMLOperators_h___
   8 #define nsMathMLOperators_h___
   9
  10 #include <stdint.h>
  11 #include "nsStringFwd.h"
  12
  13 enum nsStretchDirection {
  14   NS_STRETCH_DIRECTION_UNSUPPORTED = -1,
  15   NS_STRETCH_DIRECTION_DEFAULT = 0,
  16   NS_STRETCH_DIRECTION_HORIZONTAL = 1,
  17   NS_STRETCH_DIRECTION_VERTICAL = 2
  18 };
  19
  20 typedef uint32_t nsOperatorFlags;
  21 enum {
  22   // define the bits used to handle the operator
  23   NS_MATHML_OPERATOR_MUTABLE = 1 << 30,
  24   NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR = 1 << 29,
  25   NS_MATHML_OPERATOR_EMBELLISH_ISOLATED = 1 << 28,
  26   NS_MATHML_OPERATOR_CENTERED = 1 << 27,
  27   NS_MATHML_OPERATOR_INVISIBLE = 1 << 26,
  28
  29   // define the bits used in the Operator Dictionary
  30
  31   // the very last two bits tell us the form
  32   NS_MATHML_OPERATOR_FORM = 0x3,
  33   NS_MATHML_OPERATOR_FORM_INFIX = 1,
  34   NS_MATHML_OPERATOR_FORM_PREFIX = 2,
  35   NS_MATHML_OPERATOR_FORM_POSTFIX = 3,
  36
  37   // the next 2 bits tell us the direction
  38   NS_MATHML_OPERATOR_DIRECTION = 0x3 << 2,
  39   NS_MATHML_OPERATOR_DIRECTION_HORIZONTAL = 1 << 2,
  40   NS_MATHML_OPERATOR_DIRECTION_VERTICAL = 2 << 2,
  41
  42   // other bits used in the Operator Dictionary
  43   NS_MATHML_OPERATOR_STRETCHY = 1 << 4,
  44   NS_MATHML_OPERATOR_FENCE = 1 << 5,
  45   NS_MATHML_OPERATOR_ACCENT = 1 << 6,
  46   NS_MATHML_OPERATOR_LARGEOP = 1 << 7,
  47   NS_MATHML_OPERATOR_SEPARATOR = 1 << 8,
  48   NS_MATHML_OPERATOR_MOVABLELIMITS = 1 << 9,
  49   NS_MATHML_OPERATOR_SYMMETRIC = 1 << 10,
  50
  51   // Additional bits not stored in the dictionary
  52   NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE = 1 << 11,
  53   NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE = 1 << 12,
  54   NS_MATHML_OPERATOR_LSPACE_ATTR = 1 << 13,
  55   NS_MATHML_OPERATOR_RSPACE_ATTR = 1 << 14
  56 };
  57
  58 #define NS_MATHML_OPERATOR_SIZE_INFINITY (mozilla::PositiveInfinity<float>())
  59
  60 class nsMathMLOperators {
  61  public:
  62   static void AddRefTable(void);
  63   static void ReleaseTable(void);
  64   static void CleanUp();
  65
  66   // LookupOperator:
  67   // Given the string value of an operator and its form (last two bits of
  68   // flags), this method returns attributes of the operator in the output
  69   // parameters. The return value indicates whether an entry was found.
  70   static bool LookupOperator(const nsString& aOperator, const uint8_t aForm,
  71                              nsOperatorFlags* aFlags, float* aLeadingSpace,
  72                              float* aTrailingSpace);
  73
  74   // LookupOperatorWithFallback:
  75   // Same as LookupOperator but if the operator is not found under the supplied
  76   // form, then the other forms are tried in the following order: infix, postfix
  77   // prefix. The caller can test the output parameter aFlags to know exactly
  78   // under which form the operator was found in the Operator Dictionary.
  79   static bool LookupOperatorWithFallback(const nsString& aOperator,
  80                                          const uint8_t aForm,
  81                                          nsOperatorFlags* aFlags,
  82                                          float* aLeadingSpace,
  83                                          float* aTrailingSpace);
  84
  85   // Helper functions used by the nsMathMLChar class.
  86   static bool IsMirrorableOperator(const nsString& aOperator);
  87
  88   // Helper functions used by the nsMathMLChar class to determine whether
  89   // aOperator corresponds to an integral operator.
  90   static bool IsIntegralOperator(const nsString& aOperator);
  91
  92   // Helper function used by the nsMathMLChar class.
  93   static nsStretchDirection GetStretchyDirection(const nsString& aOperator);
  94 };
  95
  96 ////////////////////////////////////////////////////////////////////////////
  97 // Macros that retrieve the bits used to handle operators
  98
  99 #define NS_MATHML_OPERATOR_IS_MUTABLE(_flags) \
 100   (NS_MATHML_OPERATOR_MUTABLE == ((_flags) & NS_MATHML_OPERATOR_MUTABLE))
 101
 102 #define NS_MATHML_OPERATOR_HAS_EMBELLISH_ANCESTOR(_flags) \
 103   (NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR ==               \
 104    ((_flags) & NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR))
 105
 106 #define NS_MATHML_OPERATOR_EMBELLISH_IS_ISOLATED(_flags) \
 107   (NS_MATHML_OPERATOR_EMBELLISH_ISOLATED ==              \
 108    ((_flags) & NS_MATHML_OPERATOR_EMBELLISH_ISOLATED))
 109
 110 #define NS_MATHML_OPERATOR_IS_CENTERED(_flags) \
 111   (NS_MATHML_OPERATOR_CENTERED == ((_flags) & NS_MATHML_OPERATOR_CENTERED))
 112
 113 #define NS_MATHML_OPERATOR_IS_INVISIBLE(_flags) \
 114   (NS_MATHML_OPERATOR_INVISIBLE == ((_flags) & NS_MATHML_OPERATOR_INVISIBLE))
 115
 116 #define NS_MATHML_OPERATOR_GET_FORM(_flags) ((_flags) & NS_MATHML_OPERATOR_FORM)
 117
 118 #define NS_MATHML_OPERATOR_GET_DIRECTION(_flags) \
 119   ((_flags) & NS_MATHML_OPERATOR_DIRECTION)
 120
 121 #define NS_MATHML_OPERATOR_FORM_IS_INFIX(_flags) \
 122   (NS_MATHML_OPERATOR_FORM_INFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
 123
 124 #define NS_MATHML_OPERATOR_FORM_IS_PREFIX(_flags) \
 125   (NS_MATHML_OPERATOR_FORM_PREFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
 126
 127 #define NS_MATHML_OPERATOR_FORM_IS_POSTFIX(_flags) \
 128   (NS_MATHML_OPERATOR_FORM_POSTFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
 129
 130 #define NS_MATHML_OPERATOR_IS_DIRECTION_VERTICAL(_flags) \
 131   (NS_MATHML_OPERATOR_DIRECTION_VERTICAL ==              \
 132    ((_flags) & NS_MATHML_OPERATOR_DIRECTION))
 133
 134 #define NS_MATHML_OPERATOR_IS_DIRECTION_HORIZONTAL(_flags) \
 135   (NS_MATHML_OPERATOR_DIRECTION_HORIZONTAL ==              \
 136    ((_flags) & NS_MATHML_OPERATOR_DIRECTION))
 137
 138 #define NS_MATHML_OPERATOR_IS_STRETCHY(_flags) \
 139   (NS_MATHML_OPERATOR_STRETCHY == ((_flags) & NS_MATHML_OPERATOR_STRETCHY))
 140
 141 #define NS_MATHML_OPERATOR_IS_FENCE(_flags) \
 142   (NS_MATHML_OPERATOR_FENCE == ((_flags) & NS_MATHML_OPERATOR_FENCE))
 143
 144 #define NS_MATHML_OPERATOR_IS_ACCENT(_flags) \
 145   (NS_MATHML_OPERATOR_ACCENT == ((_flags) & NS_MATHML_OPERATOR_ACCENT))
 146
 147 #define NS_MATHML_OPERATOR_IS_LARGEOP(_flags) \
 148   (NS_MATHML_OPERATOR_LARGEOP == ((_flags) & NS_MATHML_OPERATOR_LARGEOP))
 149
 150 #define NS_MATHML_OPERATOR_IS_SEPARATOR(_flags) \
 151   (NS_MATHML_OPERATOR_SEPARATOR == ((_flags) & NS_MATHML_OPERATOR_SEPARATOR))
 152
 153 #define NS_MATHML_OPERATOR_IS_MOVABLELIMITS(_flags) \
 154   (NS_MATHML_OPERATOR_MOVABLELIMITS ==              \
 155    ((_flags) & NS_MATHML_OPERATOR_MOVABLELIMITS))
 156
 157 #define NS_MATHML_OPERATOR_IS_SYMMETRIC(_flags) \
 158   (NS_MATHML_OPERATOR_SYMMETRIC == ((_flags) & NS_MATHML_OPERATOR_SYMMETRIC))
 159
 160 #define NS_MATHML_OPERATOR_MINSIZE_IS_ABSOLUTE(_flags) \
 161   (NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE ==              \
 162    ((_flags) & NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE))
 163
 164 #define NS_MATHML_OPERATOR_MAXSIZE_IS_ABSOLUTE(_flags) \
 165   (NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE ==              \
 166    ((_flags) & NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE))
 167
 168 #define NS_MATHML_OPERATOR_HAS_LSPACE_ATTR(_flags) \
 169   (NS_MATHML_OPERATOR_LSPACE_ATTR ==               \
 170    ((_flags) & NS_MATHML_OPERATOR_LSPACE_ATTR))
 171
 172 #define NS_MATHML_OPERATOR_HAS_RSPACE_ATTR(_flags) \
 173   (NS_MATHML_OPERATOR_RSPACE_ATTR ==               \
 174    ((_flags) & NS_MATHML_OPERATOR_RSPACE_ATTR))
 175
 176 #endif /* nsMathMLOperators_h___ */