src/third_party/WebKit/Source/core/editing/PlainTextRange.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef PlainTextRange_h
  27 #define PlainTextRange_h
  28
  29 #include "platform/heap/Handle.h"
  30 #include "wtf/NotFound.h"
  31 #include "wtf/PassRefPtr.h"
  32
  33 namespace WebCore {
  34
  35 class ContainerNode;
  36 class Node;
  37 class Range;
  38
  39 class PlainTextRange {
  40 public:
  41     PlainTextRange();
  42     PlainTextRange(const PlainTextRange&);
  43     explicit PlainTextRange(int location);
  44     PlainTextRange(int start, int end);
  45
  46     size_t end() const { ASSERT(!isNull()); return m_end; }
  47     size_t start() const { ASSERT(!isNull()); return m_start; }
  48     bool isNull() const { return m_start == kNotFound; }
  49     bool isNotNull() const { return m_start != kNotFound; }
  50     size_t length() const { ASSERT(!isNull()); return m_end - m_start; }
  51
  52     PassRefPtrWillBeRawPtr<Range> createRange(const ContainerNode& scope) const;
  53     PassRefPtrWillBeRawPtr<Range> createRangeForSelection(const ContainerNode& scope) const;
  54
  55     static PlainTextRange create(const Node& scope, const Range&);
  56
  57 private:
  58     PlainTextRange& operator=(const PlainTextRange&)  WTF_DELETED_FUNCTION;
  59
  60     enum GetRangeFor { ForGeneric, ForSelection };
  61     PassRefPtrWillBeRawPtr<Range> createRangeFor(const ContainerNode& scope, GetRangeFor) const;
  62
  63     const size_t m_start;
  64     const size_t m_end;
  65 };
  66
  67 } // namespace WebCore
  68
  69 #endif // PlainTextRange_h