src/third_party/WebKit/Source/core/dom/DocumentMarkerController.h

   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 "core/dom/DocumentMarker.h"
  31 #include "platform/geometry/IntRect.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/HashMap.h"
  34 #include "wtf/Vector.h"
  35
  36 namespace WebCore {
  37
  38 class ContainerNode;
  39 class LayoutPoint;
  40 class LayoutRect;
  41 class Node;
  42 class Range;
  43 class RenderedDocumentMarker;
  44
  45 class DocumentMarkerController {
  46     WTF_MAKE_NONCOPYABLE(DocumentMarkerController); WTF_MAKE_FAST_ALLOCATED;
  47 public:
  48
  49     DocumentMarkerController();
  50     ~DocumentMarkerController();
  51
  52     void clear();
  53     void addMarker(Range*, DocumentMarker::MarkerType);
  54     void addMarker(Range*, DocumentMarker::MarkerType, const String& description);
  55     void addMarker(Range*, DocumentMarker::MarkerType, const String& description, uint32_t hash);
  56     void addTextMatchMarker(const Range*, bool activeMatch);
  57
  58     void copyMarkers(Node* srcNode, unsigned startOffset, int length, Node* dstNode, int delta);
  59     bool hasMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
  60
  61     void prepareForDestruction();
  62     // When a marker partially overlaps with range, if removePartiallyOverlappingMarkers is true, we completely
  63     // remove the marker. If the argument is false, we will adjust the span of the marker so that it retains
  64     // the portion that is outside of the range.
  65     enum RemovePartiallyOverlappingMarkerOrNot { DoNotRemovePartiallyOverlappingMarker, RemovePartiallyOverlappingMarker };
  66     void removeMarkers(Range*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(), RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
  67     void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers(),  RemovePartiallyOverlappingMarkerOrNot = DoNotRemovePartiallyOverlappingMarker);
  68
  69     void clearWeakMembers(Visitor*);
  70
  71     void removeMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
  72     void removeMarkers(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
  73     void repaintMarkers(DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
  74     void invalidateRenderedRectsForMarkersInRect(const LayoutRect&);
  75     void shiftMarkers(Node*, unsigned startOffset, int delta);
  76     void setMarkersActive(Range*, bool);
  77     void setMarkersActive(Node*, unsigned startOffset, unsigned endOffset, bool);
  78
  79     DocumentMarker* markerContainingPoint(const LayoutPoint&, DocumentMarker::MarkerType);
  80     Vector<DocumentMarker*> markersFor(Node*, DocumentMarker::MarkerTypes = DocumentMarker::AllMarkers());
  81     Vector<DocumentMarker*> markersInRange(Range*, DocumentMarker::MarkerTypes);
  82     Vector<DocumentMarker*> markers();
  83     Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType);
  84
  85 #ifndef NDEBUG
  86     void showMarkers() const;
  87 #endif
  88
  89 private:
  90     void addMarker(Node*, const DocumentMarker&);
  91
  92     typedef Vector<RenderedDocumentMarker> MarkerList;
  93     typedef Vector<OwnPtr<MarkerList>, DocumentMarker::MarkerTypeIndexesCount> MarkerLists;
  94     typedef HashMap<const Node*, OwnPtr<MarkerLists> > MarkerMap;
  95     void mergeOverlapping(MarkerList*, DocumentMarker&);
  96     bool possiblyHasMarkers(DocumentMarker::MarkerTypes);
  97     void removeMarkersFromList(MarkerMap::iterator, DocumentMarker::MarkerTypes);
  98
  99     MarkerMap m_markers;
 100     // Provide a quick way to determine whether a particular marker type is absent without going through the map.
 101     DocumentMarker::MarkerTypes m_possiblyExistingMarkerTypes;
 102 };
 103
 104 } // namespace WebCore
 105
 106 #ifndef NDEBUG
 107 void showDocumentMarkers(const WebCore::DocumentMarkerController*);
 108 #endif
 109
 110 #endif // DocumentMarkerController_h