layout/style/nsCSSPseudoElements.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is atom lists for CSS pseudos.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   L. David Baron <dbaron@dbaron.org>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /* atom list for CSS pseudo-elements */
  40
  41 #ifndef nsCSSPseudoElements_h___
  42 #define nsCSSPseudoElements_h___
  43
  44 #include "nsIAtom.h"
  45
  46 // Is this pseudo-element a CSS2 pseudo-element that can be specified
  47 // with the single colon syntax (in addition to the double-colon syntax,
  48 // which can be used for all pseudo-elements)?
  49 #define CSS_PSEUDO_ELEMENT_IS_CSS2                (1<<0)
  50 // Is this pseudo-element a pseudo-element that can contain other
  51 // elements?
  52 // (Currently pseudo-elements are either leaves of the tree (relative to
  53 // real elements) or they contain other elements in a non-tree-like
  54 // manner (i.e., like incorrectly-nested start and end tags).  It's
  55 // possible that in the future there might be container pseudo-elements
  56 // that form a properly nested tree structure.  If that happens, we
  57 // should probably split this flag into two.)
  58 #define CSS_PSEUDO_ELEMENT_CONTAINS_ELEMENTS      (1<<1)
  59
  60 // Empty class derived from nsIAtom so that function signatures can
  61 // require an atom from this atom list.
  62 class nsICSSPseudoElement : public nsIAtom {};
  63
  64 class nsCSSPseudoElements {
  65 public:
  66
  67   static void AddRefAtoms();
  68
  69   static PRBool IsPseudoElement(nsIAtom *aAtom);
  70
  71   static PRBool IsCSS2PseudoElement(nsIAtom *aAtom);
  72
  73   static PRBool PseudoElementContainsElements(nsIAtom *aAtom) {
  74     return PseudoElementHasFlags(aAtom, CSS_PSEUDO_ELEMENT_CONTAINS_ELEMENTS);
  75   }
  76
  77 #define CSS_PSEUDO_ELEMENT(_name, _value, _flags) \
  78   static nsICSSPseudoElement* _name;
  79 #include "nsCSSPseudoElementList.h"
  80 #undef CSS_PSEUDO_ELEMENT
  81
  82   enum Type {
  83     // If the actual pseudo-elements stop being first here, change
  84     // GetPseudoType.
  85 #define CSS_PSEUDO_ELEMENT(_name, _value_, _flags) \
  86     ePseudo_##_name,
  87 #include "nsCSSPseudoElementList.h"
  88 #undef CSS_PSEUDO_ELEMENT
  89     ePseudo_PseudoElementCount,
  90     ePseudo_AnonBox = ePseudo_PseudoElementCount,
  91 #ifdef MOZ_XUL
  92     ePseudo_XULTree,
  93 #endif
  94     ePseudo_NotPseudoElement,
  95     ePseudo_MAX
  96   };
  97
  98   static Type GetPseudoType(nsIAtom* aAtom);
  99
 100   // Get the atom for a given Type.  aType must be < ePseudo_PseudoElementCount
 101   static nsIAtom* GetPseudoAtom(Type aType);
 102
 103 private:
 104   static PRUint32 FlagsForPseudoElement(nsIAtom *aAtom);
 105
 106   // Does the given pseudo-element have all of the flags given?
 107   static PRBool PseudoElementHasFlags(nsIAtom *aAtom, PRUint32 aFlags)
 108   {
 109     return (FlagsForPseudoElement(aAtom) & aFlags) == aFlags;
 110   }
 111 };
 112
 113 #endif /* nsCSSPseudoElements_h___ */