| /* |
| * This file is part of the DOM implementation for WebCore. |
| * |
| * Copyright (C) 2006 Apple Computer, Inc. |
| * |
| * This library is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU Library General Public |
| * License as published by the Free Software Foundation; either |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * This library is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * Library General Public License for more details. |
| * |
| * You should have received a copy of the GNU Library General Public License |
| * along with this library; see the file COPYING.LIB. If not, write to |
| * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| * Boston, MA 02110-1301, USA. |
| * |
| */ |
| |
| #ifndef DocumentMarker_h |
| #define DocumentMarker_h |
| |
| #include "wtf/Forward.h" |
| #include "wtf/RefCounted.h" |
| #include "wtf/RefPtr.h" |
| #include "wtf/text/WTFString.h" |
| |
| namespace WebCore { |
| |
| class DocumentMarkerDetails; |
| |
| // A range of a node within a document that is "marked", such as the range of a misspelled word. |
| // It optionally includes a description that could be displayed in the user interface. |
| // It also optionally includes a flag specifying whether the match is active, which is ignored |
| // for all types other than type TextMatch. |
| class DocumentMarker { |
| public: |
| enum MarkerType { |
| Spelling = 1 << 0, |
| Grammar = 1 << 1, |
| TextMatch = 1 << 2 |
| }; |
| |
| class MarkerTypes { |
| public: |
| // The constructor is intentionally implicit to allow conversion from the bit-wise sum of above types |
| MarkerTypes(unsigned mask) : m_mask(mask) { } |
| |
| bool contains(MarkerType type) const { return m_mask & type; } |
| bool intersects(const MarkerTypes& types) const { return (m_mask & types.m_mask); } |
| bool operator==(const MarkerTypes& other) const { return m_mask == other.m_mask; } |
| |
| void add(const MarkerTypes& types) { m_mask |= types.m_mask; } |
| void remove(const MarkerTypes& types) { m_mask &= ~types.m_mask; } |
| |
| private: |
| unsigned m_mask; |
| }; |
| |
| class AllMarkers : public MarkerTypes { |
| public: |
| AllMarkers() |
| : MarkerTypes(Spelling | Grammar | TextMatch) |
| { |
| } |
| }; |
| |
| DocumentMarker(); |
| DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset); |
| DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset, const String& description); |
| DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset, const String& description, uint32_t hash); |
| DocumentMarker(unsigned startOffset, unsigned endOffset, bool activeMatch); |
| DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset, PassRefPtr<DocumentMarkerDetails>); |
| |
| MarkerType type() const { return m_type; } |
| unsigned startOffset() const { return m_startOffset; } |
| unsigned endOffset() const { return m_endOffset; } |
| uint32_t hash() const { return m_hash; } |
| |
| const String& description() const; |
| bool activeMatch() const; |
| DocumentMarkerDetails* details() const; |
| |
| void setActiveMatch(bool); |
| void clearDetails() { m_details.clear(); } |
| |
| // Offset modifications are done by DocumentMarkerController. |
| // Other classes should not call following setters. |
| void setStartOffset(unsigned offset) { m_startOffset = offset; } |
| void setEndOffset(unsigned offset) { m_endOffset = offset; } |
| void shiftOffsets(int delta); |
| |
| bool operator==(const DocumentMarker& o) const |
| { |
| return type() == o.type() && startOffset() == o.startOffset() && endOffset() == o.endOffset(); |
| } |
| |
| bool operator!=(const DocumentMarker& o) const |
| { |
| return !(*this == o); |
| } |
| |
| private: |
| MarkerType m_type; |
| unsigned m_startOffset; |
| unsigned m_endOffset; |
| RefPtr<DocumentMarkerDetails> m_details; |
| uint32_t m_hash; |
| }; |
| |
| inline DocumentMarkerDetails* DocumentMarker::details() const |
| { |
| return m_details.get(); |
| } |
| |
| class DocumentMarkerDetails : public RefCounted<DocumentMarkerDetails> |
| { |
| public: |
| DocumentMarkerDetails() { } |
| virtual ~DocumentMarkerDetails(); |
| virtual bool isDescription() const { return false; } |
| virtual bool isTextMatch() const { return false; } |
| }; |
| |
| } // namespace WebCore |
| |
| #endif // DocumentMarker_h |