1/*
2 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4 * Copyright (C) 2003, 2004, 2005, 2006, 2008, 2009 Apple Inc. All rights reserved.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public License
17 * along with this library; see the file COPYING.LIB.  If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 *
21 */
22
23#ifndef CharacterData_h
24#define CharacterData_h
25
26#include "core/dom/Node.h"
27#include "wtf/text/WTFString.h"
28
29namespace blink {
30
31class ExceptionState;
32
33class CharacterData : public Node {
34    DEFINE_WRAPPERTYPEINFO();
35public:
36    void atomize();
37    const String& data() const { return m_data; }
38    void setData(const String&);
39    unsigned length() const { return m_data.length(); }
40    String substringData(unsigned offset, unsigned count, ExceptionState&);
41    void appendData(const String&);
42    void replaceData(unsigned offset, unsigned count, const String&, ExceptionState&);
43
44    enum RecalcStyleBehavior { DoNotRecalcStyle, DeprecatedRecalcStyleImmediatlelyForEditing };
45    void insertData(unsigned offset, const String&, ExceptionState&, RecalcStyleBehavior = DoNotRecalcStyle);
46    void deleteData(unsigned offset, unsigned count, ExceptionState&, RecalcStyleBehavior = DoNotRecalcStyle);
47
48    bool containsOnlyWhitespace() const;
49
50    StringImpl* dataImpl() { return m_data.impl(); }
51
52    void parserAppendData(const String&);
53
54protected:
55    CharacterData(TreeScope& treeScope, const String& text, ConstructionType type)
56        : Node(&treeScope, type)
57        , m_data(!text.isNull() ? text : emptyString())
58    {
59        ASSERT(type == CreateOther || type == CreateText || type == CreateEditingText);
60    }
61
62    void setDataWithoutUpdate(const String& data)
63    {
64        ASSERT(!data.isNull());
65        m_data = data;
66    }
67    void didModifyData(const String& oldValue);
68
69    String m_data;
70
71private:
72    virtual String nodeValue() const OVERRIDE FINAL;
73    virtual void setNodeValue(const String&) OVERRIDE FINAL;
74    virtual bool isCharacterDataNode() const OVERRIDE FINAL { return true; }
75    virtual int maxCharacterOffset() const OVERRIDE FINAL;
76    virtual bool offsetInCharacters() const OVERRIDE FINAL;
77    void setDataAndUpdate(const String&, unsigned offsetOfReplacedData, unsigned oldLength, unsigned newLength, RecalcStyleBehavior = DoNotRecalcStyle);
78
79    bool isContainerNode() const WTF_DELETED_FUNCTION; // This will catch anyone doing an unnecessary check.
80    bool isElementNode() const WTF_DELETED_FUNCTION; // This will catch anyone doing an unnecessary check.
81};
82
83DEFINE_NODE_TYPE_CASTS(CharacterData, isCharacterDataNode());
84
85} // namespace blink
86
87#endif // CharacterData_h
88