15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#ifndef UI_GFX_RANGE_RANGE_H_ 658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#define UI_GFX_RANGE_RANGE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#include <ostream> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 1258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#include "ui/gfx/gfx_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if __OBJC__ 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#import <Foundation/Foundation.h> 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct _NSRange NSRange; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // defined(OS_MACOSX) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_WIN) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <windows.h> 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <richedit.h> 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)namespace gfx { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A Range contains two integer values that represent a numeric range, like the 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// range of characters in a text selection. A range is made of a start and end 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// position; when they are the same, the Range is akin to a caret. Note that 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |start_| can be greater than |end_| to respect the directionality of the 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// range. 344e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)class GFX_EXPORT Range { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates an empty range {0,0}. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Range(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes the range with a start and end. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Range(size_t start, size_t end); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes the range with the same start and end positions. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit Range(size_t position); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Platform constructors. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit Range(const NSRange& range); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined(OS_WIN) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The |total_length| paramater should be used if the CHARRANGE is set to 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // {0,-1} to indicate the whole range. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Range(const CHARRANGE& range, LONG total_length = -1); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a range that is invalid, which is {size_t_max,size_t_max}. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const Range InvalidRange(); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Checks if the range is valid through comparision to InvalidRange(). 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsValid() const; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Getters and setters. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t start() const { return start_; } 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_start(size_t start) { start_ = start; } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t end() const { return end_; } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_end(size_t end) { end_ = end; } 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the absolute value of the length. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t length() const { 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ptrdiff_t length = end() - start(); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return length >= 0 ? length : -length; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_reversed() const { return start() > end(); } 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_empty() const { return start() == end(); } 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the minimum and maximum values. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMin() const; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMax() const; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const Range& other) const; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator!=(const Range& other) const; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool EqualsIgnoringDirection(const Range& other) const; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this range intersects the specified |range|. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Intersects(const Range& range) const; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this range contains the specified |range|. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Contains(const Range& range) const; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Computes the intersection of this range with the given |range|. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If they don't intersect, it returns an InvalidRange(). 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The returned range is always empty or forward (never reversed). 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Range Intersect(const Range& range) const; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Range& operator=(const NSRange& range); 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NSRange does not store the directionality of a range, so if this 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is_reversed(), the range will get flipped when converted to an NSRange. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NSRange ToNSRange() const; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined(OS_WIN) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CHARRANGE ToCHARRANGE() const; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GTK+ has no concept of a range. 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string ToString() const; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t start_; 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t end_; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1134e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)GFX_EXPORT std::ostream& operator<<(std::ostream& os, const Range& range); 114424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 11558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)} // namespace gfx 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#endif // UI_GFX_RANGE_RANGE_H_ 118