1c70a055a94c1f43e4408db670ca41afbb2f46b1
[WebKit-https.git] / Source / WebCore / rendering / RenderTextFragment.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Dirk Mueller (mueller@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2007 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 RenderTextFragment_h
24 #define RenderTextFragment_h
25
26 #include "RenderText.h"
27
28 namespace WebCore {
29
30 // Used to represent a text substring of an element, e.g., for text runs that are split because of
31 // first letter and that must therefore have different styles (and positions in the render tree).
32 // We cache offsets so that text transformations can be applied in such a way that we can recover
33 // the original unaltered string from our corresponding DOM node.
34 class RenderTextFragment final : public RenderText {
35 public:
36     RenderTextFragment(Text&, const String&, int startOffset, int length);
37     RenderTextFragment(Document&, const String&, int startOffset, int length);
38     RenderTextFragment(Document&, const String&);
39
40     virtual ~RenderTextFragment();
41
42     virtual bool isTextFragment() const override { return true; }
43
44     virtual bool canBeSelectionLeaf() const override;
45
46     unsigned start() const { return m_start; }
47     unsigned end() const { return m_end; }
48
49     RenderBoxModelObject* firstLetter() const { return m_firstLetter; }
50     void setFirstLetter(RenderBoxModelObject& firstLetter) { m_firstLetter = &firstLetter; }
51
52     StringImpl* contentString() const { return m_contentString.impl(); }
53
54     virtual void setText(const String&, bool force = false) override;
55
56     const String& altText() const { return m_altText; }
57     void setAltText(const String& altText) { m_altText = altText; }
58     
59 private:
60     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
61     virtual void willBeDestroyed() override;
62
63     virtual UChar previousCharacter() const override;
64     RenderBlock* blockForAccompanyingFirstLetter();
65
66     unsigned m_start;
67     unsigned m_end;
68     // Alternative description that can be used for accessibility instead of the native text.
69     String m_altText;
70     String m_contentString;
71     RenderBoxModelObject* m_firstLetter;
72 };
73
74 inline RenderTextFragment* toRenderTextFragment(RenderObject* object)
75
76     ASSERT_WITH_SECURITY_IMPLICATION(!object || toRenderText(object)->isTextFragment());
77     return static_cast<RenderTextFragment*>(object);
78 }
79
80 inline const RenderTextFragment* toRenderTextFragment(const RenderObject* object)
81
82     ASSERT_WITH_SECURITY_IMPLICATION(!object || toRenderText(object)->isTextFragment());
83     return static_cast<const RenderTextFragment*>(object);
84 }
85
86 // This will catch anyone doing an unnecessary cast.
87 void toRenderTextFragment(const RenderTextFragment*);
88
89 } // namespace WebCore
90
91 #endif // RenderTextFragment_h