yi-0.6.2.3: The Haskell-Scriptable Editor Source code Contents Index

Yi.Region

Description

This module defines the Region ADT

Synopsis

data Region emptyRegion :: Region regionIsEmpty :: Region -> Bool mkRegion :: Point -> Point -> Region mkRegion' :: Direction -> Point -> Point -> Region mkSizeRegion :: Point -> Size -> Region regionStart :: Region -> Point regionEnd :: Region -> Point regionSize :: Region -> Size regionDirection :: Region -> Direction inRegion :: Point -> Region -> Bool nearRegion :: Point -> Region -> Bool includedRegion :: Region -> Region -> Bool fmapRegion :: (Point -> Point) -> Region -> Region intersectRegion :: Region -> Region -> Region unionRegion :: Region -> Region -> Region regionFirst :: Region -> Point regionLast :: Region -> Point regionsOverlap :: Bool -> Region -> Region -> Bool

Documentation

data Region Source

The region data type. The region is semi open: it includes the start but not the end bound. This allows simpler region-manipulation algorithms. Invariant : regionStart r <= regionEnd r Instances Show Region Typeable Region

emptyRegion :: Region Source

The empty region

regionIsEmpty :: Region -> Bool Source

mkRegion :: Point -> Point -> Region Source

Construct a region from its bounds, emacs style: the right bound is excluded

mkRegion' :: Direction -> Point -> Point -> Region Source

mkSizeRegion :: Point -> Size -> Region Source

regionStart :: Region -> Point Source

regionEnd :: Region -> Point Source

regionSize :: Region -> Size Source

regionDirection :: Region -> Direction Source

inRegion :: Point -> Region -> Bool Source

True if the given point is inside the given region.

nearRegion :: Point -> Region -> Bool Source

True if the given point is inside the given region or at the end of it.

includedRegion :: Region -> Region -> Bool Source

Returns if a region (1st arg) is included in another (2nd arg)

fmapRegion :: (Point -> Point) -> Region -> Region Source

intersectRegion :: Region -> Region -> Region Source

Take the intersection of two regions

unionRegion :: Region -> Region -> Region Source

Take the union of two regions (including what is between them)

regionFirst :: Region -> Point Source

regionLast :: Region -> Point Source

regionsOverlap :: Bool -> Region -> Region -> Bool Source

Produced by Haddock version 2.6.1