Bug 1400777 - Slim down nsElementTable.h

* Remove eHTMLTags
* De-expose HTML group constants[]
* De-expose gHTMLElements[]
* Split nsHTMLElement
* Clean up nsElementTable.{cpp,h}
* Fixup for eHTMLTag removal in Parser

Tag #1375

4 files changed, 80 insertions, 108 deletions

diff --git a/parser/htmlparser/nsElementTable.cpp b/parser/htmlparser/nsElementTable.cpp
index 52507a9765..84e3af6ba7 100644
--- a/parser/htmlparser/nsElementTable.cpp
+++ b/parser/htmlparser/nsElementTable.cpp
@@ -1,18 +1,66 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
-/* vim: set ts=2 sw=2 et tw=78: */
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-
-#include "nsIAtom.h"
 #include "nsElementTable.h"
 
-/***************************************************************************** 
-  Now it's time to list all the html elements all with their capabilities...
-******************************************************************************/
+static const int kNone= 0x0;
+
+static const int kHTMLContent   = 0x0001; //  HEAD, (FRAMESET | BODY)
+static const int kHeadContent   = 0x0002; //  Elements that *must* be in the head.
+static const int kHeadMisc      = 0x0004; //  Elements that *can* be in the head.
+
+static const int kSpecial       = 0x0008; //  A,    IMG,  APPLET, OBJECT, FONT, BASEFONT, BR, SCRIPT, 
+                                          //  MAP,  Q,    SUB,    SUP,    SPAN, BDO,      IFRAME
+
+static const int kFormControl   = 0x0010; //  INPUT SELECT  TEXTAREA  LABEL BUTTON
+static const int kPreformatted  = 0x0020; //  PRE
+static const int kPreExclusion  = 0x0040; //  IMG,  OBJECT, APPLET, BIG,  SMALL,  SUB,  SUP,  FONT, BASEFONT
+static const int kFontStyle     = 0x0080; //  TT, I, B, U, S, STRIKE, BIG, SMALL
+static const int kPhrase        = 0x0100; //  EM, STRONG, DFN, CODE, SAMP, KBD, VAR, CITE, ABBR, ACRONYM
+static const int kHeading       = 0x0200; //  H1..H6
+static const int kBlockMisc     = 0x0400; //  OBJECT, SCRIPT
+static const int kBlock         = 0x0800; //  ADDRESS, BLOCKQUOTE, CENTER, DIV, DL, FIELDSET, FORM, 
+                                          //  ISINDEX, HR, NOSCRIPT, NOFRAMES, P, TABLE
+static const int kList          = 0x1000; //  UL, OL, DIR, MENU
+static const int kPCDATA        = 0x2000; //  plain text and entities...
+static const int kSelf          = 0x4000; //  whatever THIS tag is...
+static const int kExtensions    = 0x8000; //  BGSOUND, WBR, NOBR
+static const int kTable         = 0x10000;//  TR,TD,THEAD,TBODY,TFOOT,CAPTION,TH
+static const int kDLChild       = 0x20000;//  DL, DT
+static const int kCDATA         = 0x40000;//  just plain text...
+
+static const int kInlineEntity  = (kPCDATA|kFontStyle|kPhrase|kSpecial|kFormControl|kExtensions);  //  #PCDATA, %fontstyle, %phrase, %special, %formctrl
+static const int kBlockEntity   = (kHeading|kList|kPreformatted|kBlock); //  %heading, %list, %preformatted, %block
+static const int kFlowEntity    = (kBlockEntity|kInlineEntity); //  %blockentity, %inlineentity
+static const int kAllTags       = 0xffffff;
 
-// The Element Table (sung to the tune of Modern Major General)
+// Is aTest a member of aBitset?
+static bool
+TestBits(int32_t aBitset, int32_t aTest)
+{
+  if (aTest) {
+    int32_t result = aBitset & aTest;
+    return result == aTest;
+  }
+  return false;
+}
+
+struct HTMLElement
+{
+  bool IsMemberOf(int32_t aBitset) const
+  {
+    return TestBits(aBitset, mParentBits);
+  }
+
+#ifdef DEBUG
+  nsHTMLTag mTagID;
+#endif
+  int mParentBits;  // defines groups that can contain this element
+  bool mLeaf;
+};
 
 #ifdef DEBUG
 #define ELEM(tag, parent, leaf) { eHTMLTag_##tag, parent, leaf },
@@ -20,7 +68,7 @@
 #define ELEM(tag, parent, leaf) { parent, leaf },
 #endif
 
-const nsHTMLElement gHTMLElements[] = {
+static const HTMLElement gHTMLElements[] = {
   ELEM(unknown,     kNone,                       true)
   ELEM(a,           kSpecial,                    false)
   ELEM(abbr,        kPhrase,                     false)
@@ -172,19 +220,14 @@ const nsHTMLElement gHTMLElements[] = {
 
 #undef ELEM
 
-/*********************************************************************************************/
-
-bool nsHTMLElement::IsMemberOf(int32_t aSet) const
-{
-  return TestBits(aSet, mParentBits);
-}
-
-bool nsHTMLElement::IsContainer(eHTMLTags aId)
+bool
+nsHTMLElement::IsContainer(nsHTMLTag aId)
 {
   return !gHTMLElements[aId].mLeaf;
 }
 
-bool nsHTMLElement::IsBlock(eHTMLTags aId)
+bool
+nsHTMLElement::IsBlock(nsHTMLTag aId)
 {
   return gHTMLElements[aId].IsMemberOf(kBlock)       ||
          gHTMLElements[aId].IsMemberOf(kBlockEntity) ||
@@ -194,10 +237,14 @@ bool nsHTMLElement::IsBlock(eHTMLTags aId)
 }
 
 #ifdef DEBUG
-void CheckElementTable()
+void
+CheckElementTable()
 {
-  for (eHTMLTags t = eHTMLTag_unknown; t <= eHTMLTag_userdefined; t = eHTMLTags(t + 1)) {
-    NS_ASSERTION(gHTMLElements[t].mTagID == t, "gHTMLElements entries does match tag list.");
+  for (nsHTMLTag t = eHTMLTag_unknown;
+       t <= eHTMLTag_userdefined;
+       t = nsHTMLTag(t + 1)) {
+    MOZ_ASSERT(gHTMLElements[t].mTagID == t,
+               "gHTMLElements entries does match tag list.");
   }
 }
 #endif
diff --git a/parser/htmlparser/nsElementTable.h b/parser/htmlparser/nsElementTable.h
index e3479db8d1..f9f63e3db4 100644
--- a/parser/htmlparser/nsElementTable.h
+++ b/parser/htmlparser/nsElementTable.h
@@ -1,95 +1,22 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-
-/**
- * MODULE NOTES:
- * @update  gess 4/1/98
- * 
- */
-
-
-
-#ifndef _NSELEMENTABLE
-#define _NSELEMENTABLE
+#ifndef nsElementTable_h
+#define nsElementTable_h
 
 #include "nsHTMLTags.h"
-#include "nsIDTD.h"
-
-//*********************************************************************************************
-// The following ints define the standard groups of HTML elements...
-//*********************************************************************************************
-
-static const int kNone= 0x0;
-
-static const int kHTMLContent   = 0x0001; //  HEAD, (FRAMESET | BODY)
-static const int kHeadContent   = 0x0002; //  Elements that *must* be in the head.
-static const int kHeadMisc      = 0x0004; //  Elements that *can* be in the head.
-
-static const int kSpecial       = 0x0008; //  A,    IMG,  APPLET, OBJECT, FONT, BASEFONT, BR, SCRIPT, 
-                                          //  MAP,  Q,    SUB,    SUP,    SPAN, BDO,      IFRAME
-
-static const int kFormControl   = 0x0010; //  INPUT SELECT  TEXTAREA  LABEL BUTTON
-static const int kPreformatted  = 0x0020; //  PRE
-static const int kPreExclusion  = 0x0040; //  IMG,  OBJECT, APPLET, BIG,  SMALL,  SUB,  SUP,  FONT, BASEFONT
-static const int kFontStyle     = 0x0080; //  TT, I, B, U, S, STRIKE, BIG, SMALL
-static const int kPhrase        = 0x0100; //  EM, STRONG, DFN, CODE, SAMP, KBD, VAR, CITE, ABBR, ACRONYM
-static const int kHeading       = 0x0200; //  H1..H6
-static const int kBlockMisc     = 0x0400; //  OBJECT, SCRIPT
-static const int kBlock         = 0x0800; //  ADDRESS, BLOCKQUOTE, CENTER, DIV, DL, FIELDSET, FORM, 
-                                          //  ISINDEX, HR, NOSCRIPT, NOFRAMES, P, TABLE
-static const int kList          = 0x1000; //  UL, OL, DIR, MENU
-static const int kPCDATA        = 0x2000; //  plain text and entities...
-static const int kSelf          = 0x4000; //  whatever THIS tag is...
-static const int kExtensions    = 0x8000; //  BGSOUND, WBR, NOBR
-static const int kTable         = 0x10000;//  TR,TD,THEAD,TBODY,TFOOT,CAPTION,TH
-static const int kDLChild       = 0x20000;//  DL, DT
-static const int kCDATA         = 0x40000;//  just plain text...
-
-static const int kInlineEntity  = (kPCDATA|kFontStyle|kPhrase|kSpecial|kFormControl|kExtensions);  //  #PCDATA, %fontstyle, %phrase, %special, %formctrl
-static const int kBlockEntity   = (kHeading|kList|kPreformatted|kBlock); //  %heading, %list, %preformatted, %block
-static const int kFlowEntity    = (kBlockEntity|kInlineEntity); //  %blockentity, %inlineentity
-static const int kAllTags       = 0xffffff;
-
-
-//*********************************************************************************************
-// The following ints define the standard groups of HTML elements...
-//*********************************************************************************************
-
-#ifdef DEBUG
-extern void CheckElementTable();
-#endif
-
-
-/**
- * We're asking the question: is aTest a member of bitset. 
- *
- * @param 
- * @return TRUE or FALSE
- */
-inline bool TestBits(int aBitset,int aTest) {
-  if(aTest) {
-    int32_t result=(aBitset & aTest);
-    return bool(result==aTest);
-  }
-  return false;
-}
-
-struct nsHTMLElement {
-  bool            IsMemberOf(int32_t aType) const;
 
 #ifdef DEBUG
-  eHTMLTags       mTagID;
+void CheckElementTable();
 #endif
-  int             mParentBits;        //defines groups that can contain this element
-  bool            mLeaf;
 
-  static  bool    IsContainer(eHTMLTags aTag);
-  static  bool    IsBlock(eHTMLTags aTag);
+struct nsHTMLElement
+{
+  static bool IsContainer(nsHTMLTag aTag);
+  static bool IsBlock(nsHTMLTag aTag);
 };
 
-extern const nsHTMLElement gHTMLElements[];
-
-#endif
+#endif // nsElementTable_h
diff --git a/parser/htmlparser/nsHTMLTags.h b/parser/htmlparser/nsHTMLTags.h
index 07d542f08a..b67e17372b 100644
--- a/parser/htmlparser/nsHTMLTags.h
+++ b/parser/htmlparser/nsHTMLTags.h
@@ -96,6 +96,4 @@ private:
   static PLHashTable* gTagAtomTable;
 };
 
-#define eHTMLTags nsHTMLTag
-
 #endif /* nsHTMLTags_h___ */
diff --git a/parser/htmlparser/nsParserService.cpp b/parser/htmlparser/nsParserService.cpp
index ab5c20c70e..5893f19a9b 100644
--- a/parser/htmlparser/nsParserService.cpp
+++ b/parser/htmlparser/nsParserService.cpp
@@ -76,7 +76,7 @@ nsParserService::HTMLConvertUnicodeToEntity(int32_t aUnicode,
 NS_IMETHODIMP
 nsParserService::IsContainer(int32_t aId, bool& aIsContainer) const
 {
-  aIsContainer = nsHTMLElement::IsContainer((eHTMLTags)aId);
+  aIsContainer = nsHTMLElement::IsContainer((nsHTMLTag)aId);
 
   return NS_OK;
 }
@@ -84,7 +84,7 @@ nsParserService::IsContainer(int32_t aId, bool& aIsContainer) const
 NS_IMETHODIMP
 nsParserService::IsBlock(int32_t aId, bool& aIsBlock) const
 {
-  aIsBlock = nsHTMLElement::IsBlock((eHTMLTags)aId);
+  aIsBlock = nsHTMLElement::IsBlock((nsHTMLTag)aId);
 
   return NS_OK;
 }