parser/html/nsHtml5Speculation.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is HTML Parser C++ Translator code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Mozilla Foundation.
  18  * Portions created by the Initial Developer are Copyright (C) 2009
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Henri Sivonen <hsivonen@iki.fi>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsHtml5Speculation_h__
  39 #define nsHtml5Speculation_h__
  40
  41 #include "nsHtml5UTF16Buffer.h"
  42 #include "nsAHtml5TreeBuilderState.h"
  43 #include "nsHtml5TreeOperation.h"
  44 #include "nsAHtml5TreeOpSink.h"
  45 #include "nsTArray.h"
  46 #include "nsAutoPtr.h"
  47
  48 class nsHtml5Speculation : public nsAHtml5TreeOpSink
  49 {
  50   public:
  51     nsHtml5Speculation(nsHtml5UTF16Buffer* aBuffer,
  52                        PRInt32 aStart,
  53                        PRInt32 aStartLineNumber,
  54                        nsAHtml5TreeBuilderState* aSnapshot);
  55
  56     ~nsHtml5Speculation();
  57
  58     nsHtml5UTF16Buffer* GetBuffer() {
  59       return mBuffer;
  60     }
  61
  62     PRInt32 GetStart() {
  63       return mStart;
  64     }
  65
  66     PRInt32 GetStartLineNumber() {
  67       return mStartLineNumber;
  68     }
  69
  70     nsAHtml5TreeBuilderState* GetSnapshot() {
  71       return mSnapshot;
  72     }
  73
  74     /**
  75      * Flush the operations from the tree operations from the argument
  76      * queue unconditionally.
  77      */
  78     virtual void MoveOpsFrom(nsTArray<nsHtml5TreeOperation>& aOpQueue);
  79
  80     void FlushToSink(nsAHtml5TreeOpSink* aSink);
  81
  82   private:
  83     /**
  84      * The first buffer in the pending UTF-16 buffer queue
  85      */
  86     nsRefPtr<nsHtml5UTF16Buffer>        mBuffer;
  87
  88     /**
  89      * The start index of this speculation in the first buffer
  90      */
  91     PRInt32                             mStart;
  92
  93     /**
  94      * The current line number at the start of the speculation
  95      */
  96     PRInt32                             mStartLineNumber;
  97
  98     nsAutoPtr<nsAHtml5TreeBuilderState> mSnapshot;
  99
 100     nsTArray<nsHtml5TreeOperation>      mOpQueue;
 101 };
 102
 103 #endif // nsHtml5Speculation_h__