1/*
2 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4 *           (C) 2001 Dirk Mueller (mueller@kde.org)
5 *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
7 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8 * Copyright (C) Research In Motion Limited 2010. All rights reserved.
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * Library General Public License for more details.
19 *
20 * You should have received a copy of the GNU Library General Public License
21 * along with this library; see the file COPYING.LIB.  If not, write to
22 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
24 *
25 */
26
27#ifndef DocumentMarkerController_h
28#define DocumentMarkerController_h
29
30#include "DocumentMarker.h"
31#include "IntRect.h"
32#include <wtf/HashMap.h>
33#include <wtf/Vector.h>
34
35namespace WebCore {
36
37class LayoutPoint;
38class LayoutRect;
39class Node;
40class Range;
41class RenderedDocumentMarker;
42
43class DocumentMarkerController {
44    WTF_MAKE_NONCOPYABLE(DocumentMarkerController); WTF_MAKE_FAST_ALLOCATED;
45public:
46
47    DocumentMarkerController();
48    ~DocumentMarkerController();
49
50    void detach();
51    void addMarker(Range*, DocumentMarker::MarkerType);
52    void addMarker(Range*, DocumentMarker::MarkerType, const String& description);
53    void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType);
54    void addMarkerToNode(Node*, unsigned startOffset, unsigned length, DocumentMarker::MarkerType, PassRefPtr<DocumentMarkerDetails>);
55    void addTextMatchMarker(const Range*, bool activeMatch);
56
57    void copyMarkers(Node* srcNode, unsigned startOffset, int length, Node* dstNode, int delta);
58    bool hasMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
59
60    // When a marker partially overlaps with range, if removePartiallyOverlappingMarkers is true, we completely
61    // remove the marker. If the argument is false, we will adjust the span of the marker so that it retains
62    // the portion that is outside of the range.
63    enum RemovePartiallyOverlappingMarkerOrNot { DoNotRemovePartiallyOverlappingMarker, RemovePartiallyOverlappingMarker };
64    void removeMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(), RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
65    void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),  RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
66
67    void removeMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
68    void removeMarkers(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
69    void repaintMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
70    void invalidateRenderedRectsForMarkersInRect(const LayoutRect&);
71    void shiftMarkers(Node*, unsigned startOffset, int delta);
72    void setMarkersActive(Range*, bool);
73    void setMarkersActive(Node*, unsigned startOffset, unsigned endOffset, bool);
74
75    DocumentMarker* markerContainingPoint(const LayoutPoint&, DocumentMarker::MarkerType);
76    Vector<DocumentMarker*> markersFor(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
77    Vector<DocumentMarker*> markersInRange(Range*, DocumentMarker::MarkerTypes);
78    Vector<DocumentMarker> markersForNode(Node*);
79    Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType);
80    void clearDescriptionOnMarkersIntersectingRange(Range*, DocumentMarker::MarkerTypes);
81
82#ifndef NDEBUG
83    void showMarkers() const;
84#endif
85
86private:
87    void addMarker(Node*, const DocumentMarker&);
88
89    typedef Vector<RenderedDocumentMarker> MarkerList;
90    typedef HashMap<RefPtr<Node>, OwnPtr<MarkerList> > MarkerMap;
91    bool possiblyHasMarkers(DocumentMarker::MarkerTypes);
92    void removeMarkersFromList(MarkerMap::iterator, DocumentMarker::MarkerTypes);
93
94    MarkerMap m_markers;
95    // Provide a quick way to determine whether a particular marker type is absent without going through the map.
96    DocumentMarker::MarkerTypes m_possiblyExistingMarkerTypes;
97};
98
99} // namespace WebCore
100
101#ifndef NDEBUG
102void showDocumentMarkers(const WebCore::DocumentMarkerController*);
103#endif
104
105#endif // DocumentMarkerController_h
106