/parser/html/nsHtml5OwningUTF16Buffer.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) 2008
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 nsHtml5OwningUTF16Buffer_h_
39#define nsHtml5OwningUTF16Buffer_h_
40
41#include "nsHtml5UTF16Buffer.h"
42
43class nsHtml5OwningUTF16Buffer : public nsHtml5UTF16Buffer
44{
45  private:
46
47    /**
48     * Passes a buffer and its length to the superclass constructor.
49     */
50    nsHtml5OwningUTF16Buffer(PRUnichar* aBuffer);
51
52  public:
53
54    /**
55     * Constructor for a parser key placeholder. (No actual buffer.)
56     * @param aKey a parser key
57     */
58    nsHtml5OwningUTF16Buffer(void* aKey);
59
60    /**
61     * Takes care of releasing the owned buffer.
62     */
63    ~nsHtml5OwningUTF16Buffer();
64
65    /**
66     * The next buffer in a queue.
67     */
68    nsRefPtr<nsHtml5OwningUTF16Buffer> next;
69
70    /**
71     * A parser key.
72     */
73    void* key;
74
75    static already_AddRefed<nsHtml5OwningUTF16Buffer>
76    FalliblyCreate(PRInt32 aLength);
77
78    /**
79     * Swap start, end and buffer fields with another object.
80     */
81    void Swap(nsHtml5OwningUTF16Buffer* aOther);
82
83    nsrefcnt AddRef();
84    nsrefcnt Release();
85  private:
86    nsAutoRefCnt mRefCnt;
87};
88
89#endif // nsHtml5OwningUTF16Buffer_h_