/parser/html/nsHtml5DependentUTF16Buffer.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 Dependent UTF-16 Buffer code.
15 *
16 * The Initial Developer of the Original Code is
17 * Mozilla Foundation.
18 * Portions created by the Initial Developer are Copyright (C) 2011
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 nsHtml5DependentUTF16Buffer_h_
39#define nsHtml5DependentUTF16Buffer_h_
40
41#include "nscore.h"
42#include "nsHtml5OwningUTF16Buffer.h"
43
44class NS_STACK_CLASS nsHtml5DependentUTF16Buffer : public nsHtml5UTF16Buffer
45{
46  public:
47    /**
48     * Wraps a string without taking ownership of the buffer. aToWrap MUST NOT
49     * go away or be shortened while nsHtml5DependentUTF16Buffer is in use.
50     */
51    nsHtml5DependentUTF16Buffer(const nsAString& aToWrap);
52
53    ~nsHtml5DependentUTF16Buffer();
54
55    /**
56     * Copies the currently unconsumed part of this buffer into a new
57     * heap-allocated nsHtml5OwningUTF16Buffer. The new object is allocated
58     * with a fallible allocator. If the allocation fails, nsnull is returned.
59     * @return heap-allocated copy or nsnull if memory allocation failed
60     */
61    already_AddRefed<nsHtml5OwningUTF16Buffer> FalliblyCopyAsOwningBuffer();
62};
63
64#endif // nsHtml5DependentUTF16Buffer_h_