Brick.Types

Basic types used by this library.

The Widget type

data Widget n

The type of widgets.

Constructors

Widget

Fields

• hSize :: Size

  This widget's horizontal growth policy

• vSize :: Size

  This widget's vertical growth policy

• render :: RenderM n (Result n)

  This widget's rendering function

Location types and lenses

data Location

A terminal screen location.

Constructors

Location

Fields

• loc :: (Int, Int)

  (Column, Row)

Instances

Eq Location

Defined in Brick.Types.Common

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

Defined in Brick.Types.Common

Methods

compare :: Location -> Location -> Ordering

(<) :: Location -> Location -> Bool

(<=) :: Location -> Location -> Bool

(>) :: Location -> Location -> Bool

(>=) :: Location -> Location -> Bool

max :: Location -> Location -> Location

min :: Location -> Location -> Location

Read Location

Defined in Brick.Types.Common

Methods

readsPrec :: Int -> ReadS Location

readList :: ReadS [Location]

readPrec :: ReadPrec Location

readListPrec :: ReadPrec [Location]

Show Location

Defined in Brick.Types.Common

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Generic Location

Defined in Brick.Types.Common

Associated Types

type Rep Location :: Type -> Type

Methods

from :: Location -> Rep Location x

to :: Rep Location x -> Location

Semigroup Location

Defined in Brick.Types.Common

Methods

(<>) :: Location -> Location -> Location

sconcat :: NonEmpty Location -> Location

stimes :: Integral b => b -> Location -> Location

Monoid Location

Defined in Brick.Types.Common

Methods

mempty :: Location

mappend :: Location -> Location -> Location

mconcat :: [Location] -> Location

NFData Location

Defined in Brick.Types.Common

Methods

rnf :: Location -> ()

TerminalLocation Location

Defined in Brick.Types.Internal

Methods

locationColumnL :: Lens' Location Int

locationColumn :: Location -> Int

locationRowL :: Lens' Location Int

locationRow :: Location -> Int

Field1 Location Location Int Int

Defined in Brick.Types.Common

Methods

_1 :: Lens Location Location Int Int

Field2 Location Location Int Int

Defined in Brick.Types.Common

Methods

_2 :: Lens Location Location Int Int

type Rep Location

Defined in Brick.Types.Common

type Rep Location = D1 ('MetaData "Location" "Brick.Types.Common" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "loc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int, Int))))

locL :: Lens' Location (Int, Int)

class TerminalLocation a where

The class of types that behave like terminal locations.

Methods

locationColumnL :: Lens' a Int

Get the column out of the value

locationColumn :: a -> Int

locationRowL :: Lens' a Int

Get the row out of the value

locationRow :: a -> Int

Instances

TerminalLocation Location

Defined in Brick.Types.Internal

Methods

locationColumnL :: Lens' Location Int

locationColumn :: Location -> Int

locationRowL :: Lens' Location Int

locationRow :: Location -> Int

TerminalLocation (CursorLocation n)

Defined in Brick.Types

Methods

locationColumnL :: Lens' (CursorLocation n) Int

locationColumn :: CursorLocation n -> Int

locationRowL :: Lens' (CursorLocation n) Int

locationRow :: CursorLocation n -> Int

data CursorLocation n

A cursor location. These are returned by the rendering process.

Constructors

CursorLocation

Fields

• cursorLocation :: !Location

  The location

• cursorLocationName :: !(Maybe n)

  The name of the widget associated with the location

• cursorLocationVisible :: !Bool

  Whether the cursor should actually be visible

Instances

Read n => Read (CursorLocation n)

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS (CursorLocation n)

readList :: ReadS [CursorLocation n]

readPrec :: ReadPrec (CursorLocation n)

readListPrec :: ReadPrec [CursorLocation n]

Show n => Show (CursorLocation n)

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> CursorLocation n -> ShowS

show :: CursorLocation n -> String

showList :: [CursorLocation n] -> ShowS

Generic (CursorLocation n)

Defined in Brick.Types.Internal

Associated Types

type Rep (CursorLocation n) :: Type -> Type

Methods

from :: CursorLocation n -> Rep (CursorLocation n) x

to :: Rep (CursorLocation n) x -> CursorLocation n

NFData n => NFData (CursorLocation n)

Defined in Brick.Types.Internal

Methods

rnf :: CursorLocation n -> ()

TerminalLocation (CursorLocation n)

Defined in Brick.Types

Methods

locationColumnL :: Lens' (CursorLocation n) Int

locationColumn :: CursorLocation n -> Int

locationRowL :: Lens' (CursorLocation n) Int

locationRow :: CursorLocation n -> Int

type Rep (CursorLocation n)

Defined in Brick.Types.Internal

type Rep (CursorLocation n) = D1 ('MetaData "CursorLocation" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "CursorLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "cursorLocation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Location) :*: (S1 ('MetaSel ('Just "cursorLocationName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe n)) :*: S1 ('MetaSel ('Just "cursorLocationVisible") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

cursorLocationL :: forall n. Lens' (CursorLocation n) Location

cursorLocationNameL :: forall n n. Lens (CursorLocation n) (CursorLocation n) (Maybe n) (Maybe n)

Viewports

data Viewport

Describes the state of a viewport as it appears as its most recent rendering.

Constructors

VP

Fields

• _vpLeft :: Int

  The column offset of left side of the viewport.

• _vpTop :: Int

  The row offset of the top of the viewport.

• _vpSize :: DisplayRegion

  The size of the viewport.

• _vpContentSize :: DisplayRegion

  The size of the contents of the viewport.

Instances

Read Viewport

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS Viewport

readList :: ReadS [Viewport]

readPrec :: ReadPrec Viewport

readListPrec :: ReadPrec [Viewport]

Show Viewport

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Viewport -> ShowS

show :: Viewport -> String

showList :: [Viewport] -> ShowS

Generic Viewport

Defined in Brick.Types.Internal

Associated Types

type Rep Viewport :: Type -> Type

Methods

from :: Viewport -> Rep Viewport x

to :: Rep Viewport x -> Viewport

NFData Viewport

Defined in Brick.Types.Internal

Methods

rnf :: Viewport -> ()

type Rep Viewport

Defined in Brick.Types.Internal

type Rep Viewport = D1 ('MetaData "Viewport" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "VP" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_vpLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "_vpTop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "_vpSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayRegion) :*: S1 ('MetaSel ('Just "_vpContentSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayRegion))))

data ViewportType

The type of viewports that indicates the direction(s) in which a viewport is scrollable.

Constructors

Vertical

Viewports of this type are scrollable only vertically.

Horizontal

Viewports of this type are scrollable only horizontally.

Both

Viewports of this type are scrollable vertically and horizontally.

Instances

Eq ViewportType

Defined in Brick.Types.Internal

Methods

(==) :: ViewportType -> ViewportType -> Bool

(/=) :: ViewportType -> ViewportType -> Bool

Show ViewportType

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> ViewportType -> ShowS

show :: ViewportType -> String

showList :: [ViewportType] -> ShowS

vpSize :: Lens' Viewport DisplayRegion

vpTop :: Lens' Viewport Int

vpLeft :: Lens' Viewport Int

vpContentSize :: Lens' Viewport DisplayRegion

data VScrollBarOrientation

Orientations for vertical scroll bars.

Constructors

OnLeft

OnRight

Instances

Eq VScrollBarOrientation

Defined in Brick.Types.Internal

Methods

(==) :: VScrollBarOrientation -> VScrollBarOrientation -> Bool

(/=) :: VScrollBarOrientation -> VScrollBarOrientation -> Bool

Show VScrollBarOrientation

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> VScrollBarOrientation -> ShowS

show :: VScrollBarOrientation -> String

showList :: [VScrollBarOrientation] -> ShowS

data HScrollBarOrientation

Orientations for horizontal scroll bars.

Constructors

OnBottom

OnTop

Instances

Eq HScrollBarOrientation

Defined in Brick.Types.Internal

Methods

(==) :: HScrollBarOrientation -> HScrollBarOrientation -> Bool

(/=) :: HScrollBarOrientation -> HScrollBarOrientation -> Bool

Show HScrollBarOrientation

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> HScrollBarOrientation -> ShowS

show :: HScrollBarOrientation -> String

showList :: [HScrollBarOrientation] -> ShowS

data ScrollbarRenderer n

A scroll bar renderer.

Constructors

ScrollbarRenderer

Fields

• renderScrollbar :: Widget n

  How to render the body of the scroll bar. This should provide a widget that expands in whatever direction(s) this renderer will be used for. So, for example, if this was used to render vertical scroll bars, this widget would need to be one that expands vertically such as fill. The same goes for the trough widget.

• renderScrollbarTrough :: Widget n

  How to render the "trough" of the scroll bar (the area to either side of the scroll bar body). This should expand as described in the documentation for the scroll bar field.

• renderScrollbarHandleBefore :: Widget n

  How to render the handle that appears at the top or left of the scrollbar. The result should be at most one row high for horizontal handles and one column wide for vertical handles.

• renderScrollbarHandleAfter :: Widget n

  How to render the handle that appears at the bottom or right of the scrollbar. The result should be at most one row high for horizontal handles and one column wide for vertical handles.

data ClickableScrollbarElement

Clickable elements of a scroll bar.

Constructors

SBHandleBefore

The handle at the beginning (left/top) of the scroll bar.

SBHandleAfter

The handle at the end (right/bottom) of the scroll bar.

SBBar

The scroll bar itself.

SBTroughBefore

The trough before the scroll bar.

SBTroughAfter

The trough after the scroll bar.

Instances

Eq ClickableScrollbarElement

Defined in Brick.Types.Internal

Methods

(==) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

(/=) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

Ord ClickableScrollbarElement

Defined in Brick.Types.Internal

Methods

compare :: ClickableScrollbarElement -> ClickableScrollbarElement -> Ordering

(<) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

(<=) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

(>) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

(>=) :: ClickableScrollbarElement -> ClickableScrollbarElement -> Bool

max :: ClickableScrollbarElement -> ClickableScrollbarElement -> ClickableScrollbarElement

min :: ClickableScrollbarElement -> ClickableScrollbarElement -> ClickableScrollbarElement

Show ClickableScrollbarElement

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> ClickableScrollbarElement -> ShowS

show :: ClickableScrollbarElement -> String

showList :: [ClickableScrollbarElement] -> ShowS

Event-handling types and functions

data EventM n s a

The monad in which event handlers run.

Instances

MonadState s (EventM n s)

Defined in Brick.Types.EventM

Methods

get :: EventM n s s

put :: s -> EventM n s ()

state :: (s -> (a, s)) -> EventM n s a

Monad (EventM n s)

Defined in Brick.Types.EventM

Methods

(>>=) :: EventM n s a -> (a -> EventM n s b) -> EventM n s b

(>>) :: EventM n s a -> EventM n s b -> EventM n s b

return :: a -> EventM n s a

Functor (EventM n s)

Defined in Brick.Types.EventM

Methods

fmap :: (a -> b) -> EventM n s a -> EventM n s b

(<$) :: a -> EventM n s b -> EventM n s a

Applicative (EventM n s)

Defined in Brick.Types.EventM

Methods

pure :: a -> EventM n s a

(<*>) :: EventM n s (a -> b) -> EventM n s a -> EventM n s b

liftA2 :: (a -> b -> c) -> EventM n s a -> EventM n s b -> EventM n s c

(*>) :: EventM n s a -> EventM n s b -> EventM n s b

(<*) :: EventM n s a -> EventM n s b -> EventM n s a

MonadIO (EventM n s)

Defined in Brick.Types.EventM

Methods

liftIO :: IO a -> EventM n s a

MonadThrow (EventM n s)

Defined in Brick.Types.EventM

Methods

throwM :: Exception e => e -> EventM n s a

MonadCatch (EventM n s)

Defined in Brick.Types.EventM

Methods

catch :: Exception e => EventM n s a -> (e -> EventM n s a) -> EventM n s a

MonadMask (EventM n s)

Defined in Brick.Types.EventM

Methods

mask :: ((forall a. EventM n s a -> EventM n s a) -> EventM n s b) -> EventM n s b

uninterruptibleMask :: ((forall a. EventM n s a -> EventM n s a) -> EventM n s b) -> EventM n s b

generalBracket :: EventM n s a -> (a -> ExitCase b -> EventM n s c) -> (a -> EventM n s b) -> EventM n s (b, c)

Zoom (EventM n s) (EventM n t) s t

Defined in Brick.Types.EventM

Methods

zoom :: LensLike' (Zoomed (EventM n s) c) t s -> EventM n s c -> EventM n t c

type Zoomed (EventM n s)

Defined in Brick.Types.EventM

type Zoomed (EventM n s)

data BrickEvent n e

The type of events.

Constructors

VtyEvent Event

The event was a Vty event.

AppEvent e

The event was an application event.

MouseDown n Button [Modifier] Location

A mouse-down event on the specified region was received. The n value is the resource name of the clicked widget (see clickable).

MouseUp n (Maybe Button) Location

A mouse-up event on the specified region was received. The n value is the resource name of the clicked widget (see clickable).

Instances

(Eq e, Eq n) => Eq (BrickEvent n e)

Defined in Brick.Types.Internal

Methods

(==) :: BrickEvent n e -> BrickEvent n e -> Bool

(/=) :: BrickEvent n e -> BrickEvent n e -> Bool

(Ord e, Ord n) => Ord (BrickEvent n e)

Defined in Brick.Types.Internal

Methods

compare :: BrickEvent n e -> BrickEvent n e -> Ordering

(<) :: BrickEvent n e -> BrickEvent n e -> Bool

(<=) :: BrickEvent n e -> BrickEvent n e -> Bool

(>) :: BrickEvent n e -> BrickEvent n e -> Bool

(>=) :: BrickEvent n e -> BrickEvent n e -> Bool

max :: BrickEvent n e -> BrickEvent n e -> BrickEvent n e

min :: BrickEvent n e -> BrickEvent n e -> BrickEvent n e

(Show e, Show n) => Show (BrickEvent n e)

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> BrickEvent n e -> ShowS

show :: BrickEvent n e -> String

showList :: [BrickEvent n e] -> ShowS

nestEventM

Arguments

:: a

The initial state to use in the nested action.

-> EventM n a b

The action to run.

-> EventM n s (a, b)

Given a state value and an EventM that mutates that state, run the specified action and return both the resulting modified state and the result of the action itself.

nestEventM'

Arguments

:: a

The initial state to use in the nested action.

-> EventM n a b

The action to run.

-> EventM n s a

Given a state value and an EventM that mutates that state, run the specified action and return resulting modified state.

Rendering infrastructure

type RenderM n a = ReaderT (Context n) (State (RenderState n)) a

The type of the rendering monad. This monad is used by the library's rendering routines to manage rendering state and communicate rendering parameters to widgets' rendering functions.

getContext :: RenderM n (Context n)

Get the current rendering context.

The rendering context

data Context n

The rendering context. This tells widgets how to render: how much space they have in which to render, which attribute they should use to render, which bordering style should be used, and the attribute map available for rendering.

attrL :: forall r n. Getting r (Context n) Attr

The rendering context's current drawing attribute.

availWidthL :: forall n. Lens' (Context n) Int

availHeightL :: forall n. Lens' (Context n) Int

windowWidthL :: forall n. Lens' (Context n) Int

windowHeightL :: forall n. Lens' (Context n) Int

ctxVScrollBarOrientationL :: forall n. Lens' (Context n) (Maybe VScrollBarOrientation)

ctxVScrollBarRendererL :: forall n. Lens' (Context n) (Maybe (ScrollbarRenderer n))

ctxHScrollBarOrientationL :: forall n. Lens' (Context n) (Maybe HScrollBarOrientation)

ctxHScrollBarRendererL :: forall n. Lens' (Context n) (Maybe (ScrollbarRenderer n))

ctxAttrMapL :: forall n. Lens' (Context n) AttrMap

ctxAttrNameL :: forall n. Lens' (Context n) AttrName

ctxBorderStyleL :: forall n. Lens' (Context n) BorderStyle

ctxDynBordersL :: forall n. Lens' (Context n) Bool

Rendering results

data Result n

The type of result returned by a widget's rendering function. The result provides the image, cursor positions, and visibility requests that resulted from the rendering process.

Constructors

Result

Fields

• image :: !Image

  The final rendered image for a widget

• cursors :: ![CursorLocation n]

  The list of reported cursor positions for the application to choose from

• visibilityRequests :: ![VisibilityRequest]

  The list of visibility requests made by widgets rendered while rendering this one (used by viewports)

• extents :: ![Extent n]
• borders :: !(BorderMap DynBorder)

  Places where we may rewrite the edge of the image when placing this widget next to another one.

Instances

Read n => Read (Result n)

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS (Result n)

readList :: ReadS [Result n]

readPrec :: ReadPrec (Result n)

readListPrec :: ReadPrec [Result n]

Show n => Show (Result n)

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Result n -> ShowS

show :: Result n -> String

showList :: [Result n] -> ShowS

Generic (Result n)

Defined in Brick.Types.Internal

Associated Types

type Rep (Result n) :: Type -> Type

Methods

from :: Result n -> Rep (Result n) x

to :: Rep (Result n) x -> Result n

NFData n => NFData (Result n)

Defined in Brick.Types.Internal

Methods

rnf :: Result n -> ()

type Rep (Result n)

Defined in Brick.Types.Internal

type Rep (Result n) = D1 ('MetaData "Result" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "Result" 'PrefixI 'True) ((S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Image) :*: S1 ('MetaSel ('Just "cursors") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [CursorLocation n])) :*: (S1 ('MetaSel ('Just "visibilityRequests") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [VisibilityRequest]) :*: (S1 ('MetaSel ('Just "extents") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Extent n]) :*: S1 ('MetaSel ('Just "borders") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (BorderMap DynBorder))))))

emptyResult :: Result n

lookupAttrName :: AttrName -> RenderM n Attr

Given an attribute name, obtain the attribute for the attribute name by consulting the context's attribute map.

data Extent n

An extent of a named area: its size, location, and origin.

Constructors

Extent

Fields

• extentName :: !n
• extentUpperLeft :: !Location
• extentSize :: !(Int, Int)

Instances

Read n => Read (Extent n)

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS (Extent n)

readList :: ReadS [Extent n]

readPrec :: ReadPrec (Extent n)

readListPrec :: ReadPrec [Extent n]

Show n => Show (Extent n)

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Extent n -> ShowS

show :: Extent n -> String

showList :: [Extent n] -> ShowS

Generic (Extent n)

Defined in Brick.Types.Internal

Associated Types

type Rep (Extent n) :: Type -> Type

Methods

from :: Extent n -> Rep (Extent n) x

to :: Rep (Extent n) x -> Extent n

NFData n => NFData (Extent n)

Defined in Brick.Types.Internal

Methods

rnf :: Extent n -> ()

type Rep (Extent n)

Defined in Brick.Types.Internal

type Rep (Extent n) = D1 ('MetaData "Extent" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "Extent" 'PrefixI 'True) (S1 ('MetaSel ('Just "extentName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 n) :*: (S1 ('MetaSel ('Just "extentUpperLeft") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Location) :*: S1 ('MetaSel ('Just "extentSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Int, Int)))))

Rendering result lenses

imageL :: forall n. Lens' (Result n) Image

cursorsL :: forall n. Lens' (Result n) [CursorLocation n]

visibilityRequestsL :: forall n. Lens' (Result n) [VisibilityRequest]

extentsL :: forall n. Lens' (Result n) [Extent n]

Visibility requests

data VisibilityRequest

Constructors

VR

Fields

• vrPosition :: Location
• vrSize :: DisplayRegion

Instances

Eq VisibilityRequest

Defined in Brick.Types.Internal

Methods

(==) :: VisibilityRequest -> VisibilityRequest -> Bool

(/=) :: VisibilityRequest -> VisibilityRequest -> Bool

Read VisibilityRequest

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS VisibilityRequest

readList :: ReadS [VisibilityRequest]

readPrec :: ReadPrec VisibilityRequest

readListPrec :: ReadPrec [VisibilityRequest]

Show VisibilityRequest

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> VisibilityRequest -> ShowS

show :: VisibilityRequest -> String

showList :: [VisibilityRequest] -> ShowS

Generic VisibilityRequest

Defined in Brick.Types.Internal

Associated Types

type Rep VisibilityRequest :: Type -> Type

Methods

from :: VisibilityRequest -> Rep VisibilityRequest x

to :: Rep VisibilityRequest x -> VisibilityRequest

NFData VisibilityRequest

Defined in Brick.Types.Internal

Methods

rnf :: VisibilityRequest -> ()

type Rep VisibilityRequest

Defined in Brick.Types.Internal

type Rep VisibilityRequest = D1 ('MetaData "VisibilityRequest" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "VR" 'PrefixI 'True) (S1 ('MetaSel ('Just "vrPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Location) :*: S1 ('MetaSel ('Just "vrSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayRegion)))

vrPositionL :: Lens' VisibilityRequest Location

vrSizeL :: Lens' VisibilityRequest DisplayRegion

Making lenses

suffixLenses :: Name -> DecsQ

A template haskell function to build lenses for a record type. This function differs from the makeLenses function in that it does not require the record fields to be prefixed with underscores and it adds an L suffix to lens names to make it clear that they are lenses.

suffixLensesWith :: String -> LensRules -> Name -> DecsQ

A more general version of suffixLenses that allows customization of the lens-building rules and allows customization of the suffix.

Dynamic borders

bordersL :: forall n. Lens' (Result n) (BorderMap DynBorder)

data DynBorder

Information about how to redraw a dynamic border character when it abuts another dynamic border character.

Constructors

DynBorder

Fields

• dbStyle :: BorderStyle

  The Chars to use when redrawing the border. Also used to filter connections: only dynamic borders with equal BorderStyles will connect to each other.

• dbAttr :: Attr

  What Attr to use to redraw the border character. Also used to filter connections: only dynamic borders with equal Attrs will connect to each other.

• dbSegments :: Edges BorderSegment

Instances

Eq DynBorder

Defined in Brick.Types.Internal

Methods

(==) :: DynBorder -> DynBorder -> Bool

(/=) :: DynBorder -> DynBorder -> Bool

Read DynBorder

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS DynBorder

readList :: ReadS [DynBorder]

readPrec :: ReadPrec DynBorder

readListPrec :: ReadPrec [DynBorder]

Show DynBorder

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> DynBorder -> ShowS

show :: DynBorder -> String

showList :: [DynBorder] -> ShowS

Generic DynBorder

Defined in Brick.Types.Internal

Associated Types

type Rep DynBorder :: Type -> Type

Methods

from :: DynBorder -> Rep DynBorder x

to :: Rep DynBorder x -> DynBorder

NFData DynBorder

Defined in Brick.Types.Internal

Methods

rnf :: DynBorder -> ()

type Rep DynBorder

Defined in Brick.Types.Internal

type Rep DynBorder = D1 ('MetaData "DynBorder" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "DynBorder" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BorderStyle) :*: (S1 ('MetaSel ('Just "dbAttr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Attr) :*: S1 ('MetaSel ('Just "dbSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Edges BorderSegment)))))

dbStyleL :: Lens' DynBorder BorderStyle

dbAttrL :: Lens' DynBorder Attr

dbSegmentsL :: Lens' DynBorder (Edges BorderSegment)

data BorderSegment

A border character has four segments, one extending in each direction (horizontally and vertically) from the center of the character.

Constructors

BorderSegment

Fields

• bsAccept :: Bool

  Would this segment be willing to be drawn if a neighbor wanted to connect to it?

• bsOffer :: Bool

  Does this segment want to connect to its neighbor?

• bsDraw :: Bool

  Should this segment be represented visually?

Instances

Eq BorderSegment

Defined in Brick.Types.Internal

Methods

(==) :: BorderSegment -> BorderSegment -> Bool

(/=) :: BorderSegment -> BorderSegment -> Bool

Ord BorderSegment

Defined in Brick.Types.Internal

Methods

compare :: BorderSegment -> BorderSegment -> Ordering

(<) :: BorderSegment -> BorderSegment -> Bool

(<=) :: BorderSegment -> BorderSegment -> Bool

(>) :: BorderSegment -> BorderSegment -> Bool

(>=) :: BorderSegment -> BorderSegment -> Bool

max :: BorderSegment -> BorderSegment -> BorderSegment

min :: BorderSegment -> BorderSegment -> BorderSegment

Read BorderSegment

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS BorderSegment

readList :: ReadS [BorderSegment]

readPrec :: ReadPrec BorderSegment

readListPrec :: ReadPrec [BorderSegment]

Show BorderSegment

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> BorderSegment -> ShowS

show :: BorderSegment -> String

showList :: [BorderSegment] -> ShowS

Generic BorderSegment

Defined in Brick.Types.Internal

Associated Types

type Rep BorderSegment :: Type -> Type

Methods

from :: BorderSegment -> Rep BorderSegment x

to :: Rep BorderSegment x -> BorderSegment

NFData BorderSegment

Defined in Brick.Types.Internal

Methods

rnf :: BorderSegment -> ()

type Rep BorderSegment

Defined in Brick.Types.Internal

type Rep BorderSegment = D1 ('MetaData "BorderSegment" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "BorderSegment" 'PrefixI 'True) (S1 ('MetaSel ('Just "bsAccept") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "bsOffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "bsDraw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

bsAcceptL :: Lens' BorderSegment Bool

bsOfferL :: Lens' BorderSegment Bool

bsDrawL :: Lens' BorderSegment Bool

data Edges a

Constructors

Edges

Fields

• eTop, eBottom, eLeft, eRight :: a

Instances

Monad Edges

Defined in Brick.Types.Common

Methods

(>>=) :: Edges a -> (a -> Edges b) -> Edges b

(>>) :: Edges a -> Edges b -> Edges b

return :: a -> Edges a

Functor Edges

Defined in Brick.Types.Common

Methods

fmap :: (a -> b) -> Edges a -> Edges b

(<$) :: a -> Edges b -> Edges a

Applicative Edges

Defined in Brick.Types.Common

Methods

pure :: a -> Edges a

(<*>) :: Edges (a -> b) -> Edges a -> Edges b

liftA2 :: (a -> b -> c) -> Edges a -> Edges b -> Edges c

(*>) :: Edges a -> Edges b -> Edges b

(<*) :: Edges a -> Edges b -> Edges a

Eq a => Eq (Edges a)

Defined in Brick.Types.Common

Methods

(==) :: Edges a -> Edges a -> Bool

(/=) :: Edges a -> Edges a -> Bool

Ord a => Ord (Edges a)

Defined in Brick.Types.Common

Methods

compare :: Edges a -> Edges a -> Ordering

(<) :: Edges a -> Edges a -> Bool

(<=) :: Edges a -> Edges a -> Bool

(>) :: Edges a -> Edges a -> Bool

(>=) :: Edges a -> Edges a -> Bool

max :: Edges a -> Edges a -> Edges a

min :: Edges a -> Edges a -> Edges a

Read a => Read (Edges a)

Defined in Brick.Types.Common

Methods

readsPrec :: Int -> ReadS (Edges a)

readList :: ReadS [Edges a]

readPrec :: ReadPrec (Edges a)

readListPrec :: ReadPrec [Edges a]

Show a => Show (Edges a)

Defined in Brick.Types.Common

Methods

showsPrec :: Int -> Edges a -> ShowS

show :: Edges a -> String

showList :: [Edges a] -> ShowS

Generic (Edges a)

Defined in Brick.Types.Common

Associated Types

type Rep (Edges a) :: Type -> Type

Methods

from :: Edges a -> Rep (Edges a) x

to :: Rep (Edges a) x -> Edges a

NFData a => NFData (Edges a)

Defined in Brick.Types.Common

Methods

rnf :: Edges a -> ()

type Rep (Edges a)

Defined in Brick.Types.Common

type Rep (Edges a) = D1 ('MetaData "Edges" "Brick.Types.Common" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "Edges" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eTop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "eBottom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :*: (S1 ('MetaSel ('Just "eLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "eRight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))))

eTopL :: forall a. Lens' (Edges a) a

eBottomL :: forall a. Lens' (Edges a) a

eRightL :: forall a. Lens' (Edges a) a

eLeftL :: forall a. Lens' (Edges a) a

Miscellaneous

data Size

Widget size policies. These policies communicate how a widget uses space when being rendered. These policies influence rendering order and space allocation in the box layout algorithm for hBox and vBox.

Constructors

Fixed

Widgets advertising this size policy should take up the same amount of space no matter how much they are given, i.e. their size depends on their contents alone rather than on the size of the rendering area.

Greedy

Widgets advertising this size policy must take up all the space they are given.

Instances

Eq Size

Defined in Brick.Types.Internal

Methods

(==) :: Size -> Size -> Bool

(/=) :: Size -> Size -> Bool

Ord Size

Defined in Brick.Types.Internal

Methods

compare :: Size -> Size -> Ordering

(<) :: Size -> Size -> Bool

(<=) :: Size -> Size -> Bool

(>) :: Size -> Size -> Bool

(>=) :: Size -> Size -> Bool

max :: Size -> Size -> Size

min :: Size -> Size -> Size

Show Size

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Size -> ShowS

show :: Size -> String

showList :: [Size] -> ShowS

data Direction

Scrolling direction.

Constructors

Up

Up/left

Down

Down/right

Instances

Eq Direction

Defined in Brick.Types.Internal

Methods

(==) :: Direction -> Direction -> Bool

(/=) :: Direction -> Direction -> Bool

Read Direction

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS Direction

readList :: ReadS [Direction]

readPrec :: ReadPrec Direction

readListPrec :: ReadPrec [Direction]

Show Direction

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Direction -> ShowS

show :: Direction -> String

showList :: [Direction] -> ShowS

Generic Direction

Defined in Brick.Types.Internal

Associated Types

type Rep Direction :: Type -> Type

Methods

from :: Direction -> Rep Direction x

to :: Rep Direction x -> Direction

NFData Direction

Defined in Brick.Types.Internal

Methods

rnf :: Direction -> ()

type Rep Direction

Defined in Brick.Types.Internal

type Rep Direction = D1 ('MetaData "Direction" "Brick.Types.Internal" "brick-1.0-77aJMIW5qeQDpqNaRscE0V" 'False) (C1 ('MetaCons "Up" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Down" 'PrefixI 'False) (U1 :: Type -> Type))

Renderer internals (for benchmarking)

data RenderState n

Instances

(Ord n, Read n) => Read (RenderState n)

Defined in Brick.Types.Internal

Methods

readsPrec :: Int -> ReadS (RenderState n)

readList :: ReadS [RenderState n]

readPrec :: ReadPrec (RenderState n)

readListPrec :: ReadPrec [RenderState n]

Show n => Show (RenderState n)

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> RenderState n -> ShowS

show :: RenderState n -> String

showList :: [RenderState n] -> ShowS

Generic (RenderState n)

Defined in Brick.Types.Internal

Associated Types

type Rep (RenderState n) :: Type -> Type

Methods

from :: RenderState n -> Rep (RenderState n) x

to :: Rep (RenderState n) x -> RenderState n

NFData n => NFData (RenderState n)

Defined in Brick.Types.Internal

Methods

rnf :: RenderState n -> ()

type Rep (RenderState n)

Defined in Brick.Types.Internal

type Rep (RenderState n)

Re-exports for convenience

get :: MonadState s m => m s

Return the state from the internals of the monad.

gets :: MonadState s m => (s -> a) -> m a

Gets specific component of the state, using a projection function supplied.

put :: MonadState s m => s -> m ()

Replace the state inside the monad.

modify :: MonadState s m => (s -> s) -> m ()

Monadic state transformer.

Maps an old state to a new state inside a state monad. The old state is thrown away.

     Main> :t modify ((+1) :: Int -> Int)
     modify (...) :: (MonadState Int a) => a ()

This says that modify (+1) acts over any Monad that is a member of the MonadState class, with an Int state.

zoom :: Zoom m n s t => LensLike' (Zoomed m c) t s -> m c -> n c infixr 2

When you're in a state monad, this function lets you operate on a part of your state. For instance, if your state was a record containing a position field, after zooming position would become your whole state (and when you modify it, the bigger structure would be modified as well).

(Your State / StateT or RWS / RWST can be anywhere in the stack, but you can't use zoom with arbitrary MonadState because it doesn't provide any methods to change the type of the state. See this issue for details.)

For the sake of the example, let's define some types first:

data Position = Position {
  _x, _y :: Int }

data Player = Player {
  _position :: Position,
  ... }

data Game = Game {
  _player :: Player,
  _obstacles :: [Position],
  ... }

concat <$> mapM makeLenses [''Position, ''Player, ''Game]

Now, here's an action that moves the player north-east:

moveNE :: State Game ()
moveNE = do
  player.position.x += 1
  player.position.y += 1

With zoom, you can use player.position to focus just on a part of the state:

moveNE :: State Game ()
moveNE = do
  zoom (player.position) $ do
    x += 1
    y += 1

You can just as well use it for retrieving things out of the state:

getCoords :: State Game (Int, Int)
getCoords = zoom (player.position) ((,) <$> use x <*> use y)

Or more explicitly:

getCoords = zoom (player.position) $ do
  x' <- use x
  y' <- use y
  return (x', y')

When you pass a traversal to zoom, it'll work as a loop. For instance, here we move all obstacles:

moveObstaclesNE :: State Game ()
moveObstaclesNE = do
  zoom (obstacles.each) $ do
    x += 1
    y += 1

If the action returns a result, all results would be combined with <> – the same way they're combined when ^. is passed a traversal. In this example, moveObstaclesNE returns a list of old coordinates of obstacles in addition to moving them:

moveObstaclesNE = do
  xys <- zoom (obstacles.each) $ do
    -- Get old coordinates.
    x' <- use x
    y' <- use y
    -- Update them.
    x .= x' + 1
    y .= y' + 1
    -- Return a single-element list with old coordinates.
    return [(x', y')]
  ...

Finally, you might need to write your own instances of Zoom if you use newtyped transformers in your monad stack. This can be done as follows:

import Lens.Micro.Mtl.Internal

type instance Zoomed (MyStateT s m) = Zoomed (StateT s m)

instance Monad m => Zoom (MyStateT s m) (MyStateT t m) s t where
    zoom l (MyStateT m) = MyStateT (zoom l m)

Orphan instances

TerminalLocation (CursorLocation n)

Methods

locationColumnL :: Lens' (CursorLocation n) Int

locationColumn :: CursorLocation n -> Int

locationRowL :: Lens' (CursorLocation n) Int

locationRow :: CursorLocation n -> Int