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