brick-1.9: A declarative terminal user interface library
Safe HaskellSafe-Inferred
LanguageHaskell2010

Brick.Types

Description

Basic types used by this library.

Synopsis

The Widget type

data Widget n Source #

The type of widgets.

Constructors

Widget 

Fields

Location types and lenses

data Location Source #

A terminal screen location.

Constructors

Location 

Fields

Instances

Instances details
Monoid Location Source # 
Instance details

Defined in Brick.Types.Common

Semigroup Location Source # 
Instance details

Defined in Brick.Types.Common

Generic Location Source # 
Instance details

Defined in Brick.Types.Common

Associated Types

type Rep Location :: Type -> Type #

Methods

from :: Location -> Rep Location x #

to :: Rep Location x -> Location #

Read Location Source # 
Instance details

Defined in Brick.Types.Common

Show Location Source # 
Instance details

Defined in Brick.Types.Common

TerminalLocation Location Source # 
Instance details

Defined in Brick.Types.Internal

NFData Location Source # 
Instance details

Defined in Brick.Types.Common

Methods

rnf :: Location -> () #

Eq Location Source # 
Instance details

Defined in Brick.Types.Common

Ord Location Source # 
Instance details

Defined in Brick.Types.Common

Field1 Location Location Int Int Source # 
Instance details

Defined in Brick.Types.Common

Field2 Location Location Int Int Source # 
Instance details

Defined in Brick.Types.Common

type Rep Location Source # 
Instance details

Defined in Brick.Types.Common

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

class TerminalLocation a where Source #

The class of types that behave like terminal locations.

Methods

locationColumnL :: Lens' a Int Source #

Get the column out of the value

locationColumn :: a -> Int Source #

locationRowL :: Lens' a Int Source #

Get the row out of the value

locationRow :: a -> Int Source #

data CursorLocation n Source #

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

Constructors

CursorLocation 

Fields

Instances

Instances details
Generic (CursorLocation n) Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

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

Read n => Read (CursorLocation n) Source # 
Instance details

Defined in Brick.Types.Internal

Show n => Show (CursorLocation n) Source # 
Instance details

Defined in Brick.Types.Internal

TerminalLocation (CursorLocation n) Source # 
Instance details

Defined in Brick.Types

NFData n => NFData (CursorLocation n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: CursorLocation n -> () #

type Rep (CursorLocation n) Source # 
Instance details

Defined in Brick.Types.Internal

type Rep (CursorLocation n) = D1 ('MetaData "CursorLocation" "Brick.Types.Internal" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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))))

Viewports

data Viewport Source #

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

Constructors

VP 

Fields

Instances

Instances details
Generic Viewport Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

type Rep Viewport :: Type -> Type #

Methods

from :: Viewport -> Rep Viewport x #

to :: Rep Viewport x -> Viewport #

Read Viewport Source # 
Instance details

Defined in Brick.Types.Internal

Show Viewport Source # 
Instance details

Defined in Brick.Types.Internal

NFData Viewport Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: Viewport -> () #

type Rep Viewport Source # 
Instance details

Defined in Brick.Types.Internal

data ViewportType Source #

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

Instances details
Show ViewportType Source # 
Instance details

Defined in Brick.Types.Internal

Eq ViewportType Source # 
Instance details

Defined in Brick.Types.Internal

data ScrollbarRenderer n Source #

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 Source #

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.

Event-handling types and functions

data EventM n s a Source #

The monad in which event handlers run.

Instances

Instances details
MonadState s (EventM n s) Source # 
Instance details

Defined in Brick.Types.EventM

Methods

get :: EventM n s s #

put :: s -> EventM n s () #

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

MonadIO (EventM n s) Source # 
Instance details

Defined in Brick.Types.EventM

Methods

liftIO :: IO a -> EventM n s a #

Applicative (EventM n s) Source # 
Instance details

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 #

Functor (EventM n s) Source # 
Instance details

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 #

Monad (EventM n s) Source # 
Instance details

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 #

MonadCatch (EventM n s) Source # 
Instance details

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) Source # 
Instance details

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) #

MonadThrow (EventM n s) Source # 
Instance details

Defined in Brick.Types.EventM

Methods

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

Zoom (EventM n s) (EventM n t) s t Source # 
Instance details

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) Source # 
Instance details

Defined in Brick.Types.EventM

type Zoomed (EventM n s)

data BrickEvent n e Source #

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

Instances details
(Show e, Show n) => Show (BrickEvent n e) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

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

show :: BrickEvent n e -> String #

showList :: [BrickEvent n e] -> ShowS #

(Eq e, Eq n) => Eq (BrickEvent n e) Source # 
Instance details

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) Source # 
Instance details

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 #

nestEventM Source #

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' Source #

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 Source #

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) Source #

Get the current rendering context.

The rendering context

data Context n Source #

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 Source #

The rendering context's current drawing attribute.

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

Rendering results

data Result n Source #

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

Instances

Instances details
Generic (Result n) Source # 
Instance details

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 #

Read n => Read (Result n) Source # 
Instance details

Defined in Brick.Types.Internal

Show n => Show (Result n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Result n -> ShowS #

show :: Result n -> String #

showList :: [Result n] -> ShowS #

NFData n => NFData (Result n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: Result n -> () #

type Rep (Result n) Source # 
Instance details

Defined in Brick.Types.Internal

type Rep (Result n) = D1 ('MetaData "Result" "Brick.Types.Internal" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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))))))

lookupAttrName :: AttrName -> RenderM n Attr Source #

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

data Extent n Source #

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

Constructors

Extent 

Instances

Instances details
Generic (Extent n) Source # 
Instance details

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 #

Read n => Read (Extent n) Source # 
Instance details

Defined in Brick.Types.Internal

Show n => Show (Extent n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Extent n -> ShowS #

show :: Extent n -> String #

showList :: [Extent n] -> ShowS #

NFData n => NFData (Extent n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: Extent n -> () #

type Rep (Extent n) Source # 
Instance details

Defined in Brick.Types.Internal

type Rep (Extent n) = D1 ('MetaData "Extent" "Brick.Types.Internal" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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 Source #

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

Visibility requests

data VisibilityRequest Source #

Constructors

VR 

Instances

Instances details
Generic VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

type Rep VisibilityRequest :: Type -> Type #

Read VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

Show VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

NFData VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: VisibilityRequest -> () #

Eq VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

type Rep VisibilityRequest Source # 
Instance details

Defined in Brick.Types.Internal

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

Making lenses

suffixLenses :: Name -> DecsQ Source #

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 Source #

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

Dynamic borders

data DynBorder Source #

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

Constructors

DynBorder 

Fields

Instances

Instances details
Generic DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

type Rep DynBorder :: Type -> Type #

Read DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

Show DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

NFData DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: DynBorder -> () #

Eq DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

type Rep DynBorder Source # 
Instance details

Defined in Brick.Types.Internal

type Rep DynBorder = D1 ('MetaData "DynBorder" "Brick.Types.Internal" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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)))))

data BorderSegment Source #

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

Instances details
Generic BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

type Rep BorderSegment :: Type -> Type #

Read BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

Show BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

NFData BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: BorderSegment -> () #

Eq BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

Ord BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

type Rep BorderSegment Source # 
Instance details

Defined in Brick.Types.Internal

type Rep BorderSegment = D1 ('MetaData "BorderSegment" "Brick.Types.Internal" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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))))

data Edges a Source #

Constructors

Edges 

Fields

Instances

Instances details
Applicative Edges Source # 
Instance details

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 #

Functor Edges Source # 
Instance details

Defined in Brick.Types.Common

Methods

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

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

Monad Edges Source # 
Instance details

Defined in Brick.Types.Common

Methods

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

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

return :: a -> Edges a #

Generic (Edges a) Source # 
Instance details

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 #

Read a => Read (Edges a) Source # 
Instance details

Defined in Brick.Types.Common

Show a => Show (Edges a) Source # 
Instance details

Defined in Brick.Types.Common

Methods

showsPrec :: Int -> Edges a -> ShowS #

show :: Edges a -> String #

showList :: [Edges a] -> ShowS #

NFData a => NFData (Edges a) Source # 
Instance details

Defined in Brick.Types.Common

Methods

rnf :: Edges a -> () #

Eq a => Eq (Edges a) Source # 
Instance details

Defined in Brick.Types.Common

Methods

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

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

Ord a => Ord (Edges a) Source # 
Instance details

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 #

type Rep (Edges a) Source # 
Instance details

Defined in Brick.Types.Common

type Rep (Edges a) = D1 ('MetaData "Edges" "Brick.Types.Common" "brick-1.9-Gsb59k6RYzrAvZwzg7A0s3" '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 Source #

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

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

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

Miscellaneous

data Size Source #

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

Instances details
Show Size Source # 
Instance details

Defined in Brick.Types.Internal

Methods

showsPrec :: Int -> Size -> ShowS #

show :: Size -> String #

showList :: [Size] -> ShowS #

Eq Size Source # 
Instance details

Defined in Brick.Types.Internal

Methods

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

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

Ord Size Source # 
Instance details

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 #

data Direction Source #

Scrolling direction.

Constructors

Up

Up/left

Down

Down/right

Instances

Instances details
Generic Direction Source # 
Instance details

Defined in Brick.Types.Internal

Associated Types

type Rep Direction :: Type -> Type #

Read Direction Source # 
Instance details

Defined in Brick.Types.Internal

Show Direction Source # 
Instance details

Defined in Brick.Types.Internal

NFData Direction Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: Direction -> () #

Eq Direction Source # 
Instance details

Defined in Brick.Types.Internal

type Rep Direction Source # 
Instance details

Defined in Brick.Types.Internal

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

Renderer internals (for benchmarking)

data RenderState n Source #

Instances

Instances details
Generic (RenderState n) Source # 
Instance details

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 #

(Ord n, Read n) => Read (RenderState n) Source # 
Instance details

Defined in Brick.Types.Internal

Show n => Show (RenderState n) Source # 
Instance details

Defined in Brick.Types.Internal

NFData n => NFData (RenderState n) Source # 
Instance details

Defined in Brick.Types.Internal

Methods

rnf :: RenderState n -> () #

type Rep (RenderState n) Source # 
Instance details

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