michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef nsMathMLOperators_h___
michael@0: #define nsMathMLOperators_h___
michael@0: 
michael@0: #include <stdint.h>
michael@0: #include "nsStringFwd.h"
michael@0: 
michael@0: enum nsStretchDirection {
michael@0:   NS_STRETCH_DIRECTION_UNSUPPORTED = -1,
michael@0:   NS_STRETCH_DIRECTION_DEFAULT     =  0,
michael@0:   NS_STRETCH_DIRECTION_HORIZONTAL  =  1,
michael@0:   NS_STRETCH_DIRECTION_VERTICAL    =  2
michael@0: };
michael@0: 
michael@0: typedef uint32_t nsOperatorFlags;
michael@0: enum {
michael@0:   // define the bits used to handle the operator
michael@0:   NS_MATHML_OPERATOR_MUTABLE            = 1<<30,
michael@0:   NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR = 1<<29,
michael@0:   NS_MATHML_OPERATOR_EMBELLISH_ISOLATED = 1<<28,
michael@0:   NS_MATHML_OPERATOR_CENTERED           = 1<<27,
michael@0:   NS_MATHML_OPERATOR_INVISIBLE          = 1<<26,
michael@0: 
michael@0:   // define the bits used in the Operator Dictionary
michael@0: 
michael@0:   // the very last two bits tell us the form
michael@0:   NS_MATHML_OPERATOR_FORM               = 0x3,
michael@0:   NS_MATHML_OPERATOR_FORM_INFIX         = 1,
michael@0:   NS_MATHML_OPERATOR_FORM_PREFIX        = 2,
michael@0:   NS_MATHML_OPERATOR_FORM_POSTFIX       = 3,
michael@0: 
michael@0:   // the next 2 bits tell us the direction
michael@0:   NS_MATHML_OPERATOR_DIRECTION            = 0x3<<2,
michael@0:   NS_MATHML_OPERATOR_DIRECTION_HORIZONTAL = 1<<2,
michael@0:   NS_MATHML_OPERATOR_DIRECTION_VERTICAL   = 2<<2,
michael@0: 
michael@0:   // other bits used in the Operator Dictionary
michael@0:   NS_MATHML_OPERATOR_STRETCHY           = 1<<4,
michael@0:   NS_MATHML_OPERATOR_FENCE              = 1<<5,
michael@0:   NS_MATHML_OPERATOR_ACCENT             = 1<<6,
michael@0:   NS_MATHML_OPERATOR_LARGEOP            = 1<<7,
michael@0:   NS_MATHML_OPERATOR_SEPARATOR          = 1<<8,
michael@0:   NS_MATHML_OPERATOR_MOVABLELIMITS      = 1<<9,
michael@0:   NS_MATHML_OPERATOR_SYMMETRIC          = 1<<10,
michael@0:   NS_MATHML_OPERATOR_INTEGRAL           = 1<<11,
michael@0:   NS_MATHML_OPERATOR_MIRRORABLE         = 1<<12,
michael@0: 
michael@0:   // Additional bits not stored in the dictionary
michael@0:   NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE   = 1<<13,
michael@0:   NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE   = 1<<14,
michael@0:   NS_MATHML_OPERATOR_LSPACE_ATTR     = 1<<15,
michael@0:   NS_MATHML_OPERATOR_RSPACE_ATTR    = 1<<16
michael@0: };
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_SIZE_INFINITY NS_IEEEPositiveInfinity()
michael@0: 
michael@0: class nsMathMLOperators {
michael@0: public:
michael@0:   static void AddRefTable(void);
michael@0:   static void ReleaseTable(void);
michael@0:   static void CleanUp();
michael@0: 
michael@0:   // LookupOperator:
michael@0:   // Given the string value of an operator and its form (last two bits of flags),
michael@0:   // this method returns true if the operator is found in the Operator Dictionary.
michael@0:   // Attributes of the operator are returned in the output parameters.
michael@0:   // If the operator is not found under the supplied form but is found under a 
michael@0:   // different form, the method returns true as well. The caller can test the
michael@0:   // output parameter aFlags to know exactly under which form the operator was
michael@0:   // found in the Operator Dictionary.
michael@0:   static bool
michael@0:   LookupOperator(const nsString&       aOperator,
michael@0:                  const nsOperatorFlags aForm,
michael@0:                  nsOperatorFlags*      aFlags,
michael@0:                  float*                aLeadingSpace,
michael@0:                  float*                aTrailingSpace);
michael@0: 
michael@0:    // LookupOperators:
michael@0:    // Helper to return all the forms under which an operator is listed in the
michael@0:    // Operator Dictionary. The caller must pass arrays of size 4, and use 
michael@0:    // aFlags[NS_MATHML_OPERATOR_FORM_{INFIX|POSTFIX|PREFIX}],
michael@0:    // aLeadingSpace[], etc, to access the attributes of the operator under a
michael@0:    // particular form. If the operator wasn't found under a form, its entry
michael@0:    // aFlags[form] is set to zero.
michael@0:    static void
michael@0:    LookupOperators(const nsString&       aOperator,
michael@0:                    nsOperatorFlags*      aFlags,
michael@0:                    float*                aLeadingSpace,
michael@0:                    float*                aTrailingSpace);
michael@0: 
michael@0:   // Helper functions used by the nsMathMLChar class.
michael@0:   static bool
michael@0:   IsMirrorableOperator(const nsString& aOperator);
michael@0: 
michael@0:   // Helper function used by the nsMathMLChar class.
michael@0:   static nsStretchDirection GetStretchyDirection(const nsString& aOperator);
michael@0: };
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////
michael@0: // Macros that retrieve the bits used to handle operators
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_MUTABLE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_MUTABLE == ((_flags) & NS_MATHML_OPERATOR_MUTABLE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_HAS_EMBELLISH_ANCESTOR(_flags) \
michael@0:   (NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR == ((_flags) & NS_MATHML_OPERATOR_EMBELLISH_ANCESTOR))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_EMBELLISH_IS_ISOLATED(_flags) \
michael@0:   (NS_MATHML_OPERATOR_EMBELLISH_ISOLATED == ((_flags) & NS_MATHML_OPERATOR_EMBELLISH_ISOLATED))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_CENTERED(_flags) \
michael@0:   (NS_MATHML_OPERATOR_CENTERED == ((_flags) & NS_MATHML_OPERATOR_CENTERED))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_INVISIBLE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_INVISIBLE == ((_flags) & NS_MATHML_OPERATOR_INVISIBLE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_GET_FORM(_flags) \
michael@0:   ((_flags) & NS_MATHML_OPERATOR_FORM)
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_GET_DIRECTION(_flags) \
michael@0:   ((_flags) & NS_MATHML_OPERATOR_DIRECTION)
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_FORM_IS_INFIX(_flags) \
michael@0:   (NS_MATHML_OPERATOR_FORM_INFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_FORM_IS_PREFIX(_flags) \
michael@0:   (NS_MATHML_OPERATOR_FORM_PREFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_FORM_IS_POSTFIX(_flags) \
michael@0:   (NS_MATHML_OPERATOR_FORM_POSTFIX == ((_flags) & NS_MATHML_OPERATOR_FORM))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_DIRECTION_VERTICAL(_flags) \
michael@0:   (NS_MATHML_OPERATOR_DIRECTION_VERTICAL == ((_flags) & NS_MATHML_OPERATOR_DIRECTION))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_DIRECTION_HORIZONTAL(_flags) \
michael@0:   (NS_MATHML_OPERATOR_DIRECTION_HORIZONTAL == ((_flags) & NS_MATHML_OPERATOR_DIRECTION))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_STRETCHY(_flags) \
michael@0:   (NS_MATHML_OPERATOR_STRETCHY == ((_flags) & NS_MATHML_OPERATOR_STRETCHY))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_FENCE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_FENCE == ((_flags) & NS_MATHML_OPERATOR_FENCE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_ACCENT(_flags) \
michael@0:   (NS_MATHML_OPERATOR_ACCENT == ((_flags) & NS_MATHML_OPERATOR_ACCENT))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_LARGEOP(_flags) \
michael@0:   (NS_MATHML_OPERATOR_LARGEOP == ((_flags) & NS_MATHML_OPERATOR_LARGEOP))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_SEPARATOR(_flags) \
michael@0:   (NS_MATHML_OPERATOR_SEPARATOR == ((_flags) & NS_MATHML_OPERATOR_SEPARATOR))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_MOVABLELIMITS(_flags) \
michael@0:   (NS_MATHML_OPERATOR_MOVABLELIMITS == ((_flags) & NS_MATHML_OPERATOR_MOVABLELIMITS))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_SYMMETRIC(_flags) \
michael@0:   (NS_MATHML_OPERATOR_SYMMETRIC == ((_flags) & NS_MATHML_OPERATOR_SYMMETRIC))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_INTEGRAL(_flags) \
michael@0:   (NS_MATHML_OPERATOR_INTEGRAL == ((_flags) & NS_MATHML_OPERATOR_INTEGRAL))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_IS_MIRRORABLE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_MIRRORABLE == ((_flags) & NS_MATHML_OPERATOR_MIRRORABLE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_MINSIZE_IS_ABSOLUTE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE == ((_flags) & NS_MATHML_OPERATOR_MINSIZE_ABSOLUTE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_MAXSIZE_IS_ABSOLUTE(_flags) \
michael@0:   (NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE == ((_flags) & NS_MATHML_OPERATOR_MAXSIZE_ABSOLUTE))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_HAS_LSPACE_ATTR(_flags) \
michael@0:   (NS_MATHML_OPERATOR_LSPACE_ATTR == ((_flags) & NS_MATHML_OPERATOR_LSPACE_ATTR))
michael@0: 
michael@0: #define NS_MATHML_OPERATOR_HAS_RSPACE_ATTR(_flags) \
michael@0:   (NS_MATHML_OPERATOR_RSPACE_ATTR == ((_flags) & NS_MATHML_OPERATOR_RSPACE_ATTR))
michael@0: 
michael@0: #endif /* nsMathMLOperators_h___ */