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