Moduletypst-0.5.0.3Haskell2010

Typst.Types

24 types
5 classes
12 values

Packagetypst-0.5.0.3
Exports41
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRegex.hs

datadata RE

A regular expression. Note that typst-hs does not use the same Regex engine as Typst. See issue #28.

Instances4Eq, Ord, Show, FromVal

Eq REDefined in typst-0.5.0.3 · Typst.Regex
Ord REDefined in typst-0.5.0.3 · Typst.Regex
Show REDefined in typst-0.5.0.3 · Typst.Regex
FromVal REDefined in typst-0.5.0.3 · Typst.Types

datadata Val

A Typst value. More documentation can be found in the Foundations chapter of the Typst reference manual. A more concise (but somewhat outdated) summary can also be found in L. Mädje "Typst: a programmable markup language for typesetting", page 32-33.

Constructors

VNone
The none value, indicates the absence of any other value.
VAuto
The auto value, used to automatically set an appropriate value.
VBoolean !Bool
A bool value.
VInteger !Integer
An int value.
VFloat !Double
A float value.
VRatio !Rational
A ratio value, a proportion of a certain whole, for example 50%.
VLength !Length
A length or a relative value.
VAlignment (Maybe Horiz) (Maybe Vert)
An alignment value, indicating the alignment of some content along both the horizontal and vertical axes.
VAngle !Double
An angle value (expressed internally in degrees).
VFraction !Double
A fraction value, defining the proportions of remaing space is to be distributed, e.g. 2 fr.
VColor !Color
A color value. Not all Typst color spaces are supported; only rgb, cmyk, and luma are available. See issue #35.
VSymbol !Symbol
A symbol value, representing a Unicode symbol.
VString !Text
A UTF-8 encoded text string.
VRegex !RE
A regex (regular expression). See RE for details.
VDateTime (Maybe Day) (Maybe DiffTime)
A datetime value, a date, a time, or a combination of both.
VContent (Seq Content)
A content value, see Content for more details.
VArray (Vector Val)
An array value, for example (10, 20, 30).
VDict (OMap Identifier Val)
A dictionary value, for example (a:20, b:30).
VTermItem (Seq Content) (Seq Content)
VDirection Direction
A direction to lay out content.
VFunction (Maybe Identifier) (Map Identifier Val) Function
A Typst function.
VArguments Arguments
Positional and named function arguments
VLabel !Text
A label to some element, for example hello.
VCounter !Counter
VSelector !Selector
VModule Identifier (Map Identifier Val)
VStyles
VVersion [Integer]
VType !ValType

Instances10Eq, Ord, Show, FromJSON, FromValue, Compare, …

Eq ValDefined in typst-0.5.0.3 · Typst.Types
Ord ValDefined in typst-0.5.0.3 · Typst.Types
Show ValDefined in typst-0.5.0.3 · Typst.Types
FromJSON ValDefined in typst-0.5.0.3 · Typst.Types
FromValue ValDefined in typst-0.5.0.3 · Typst.Types
Compare ValDefined in typst-0.5.0.3 · Typst.Types
FromVal ValDefined in typst-0.5.0.3 · Typst.Types
Multipliable ValDefined in typst-0.5.0.3 · Typst.Types
Negatable ValDefined in typst-0.5.0.3 · Typst.Types
Summable ValDefined in typst-0.5.0.3 · Typst.Types

datadata ValType

A Typst type, see documentation for Val.

Constructors

TNone
TAuto
TBoolean
TInteger
TFloat
TRatio
TLength
TAlignment
TAngle
TFraction
TColor
TSymbol
TString
TRegex
TDateTime
TContent
TArray
TDict
TTermItem
TDirection
TFunction
TArguments
TModule
TSelector
TStyles
TLabel
TCounter
TLocation
TVersion
TType
TAny
ValType :|: ValType

Instances3Eq, Ord, Show

Eq ValTypeDefined in typst-0.5.0.3 · Typst.Types
Ord ValTypeDefined in typst-0.5.0.3 · Typst.Types
Show ValTypeDefined in typst-0.5.0.3 · Typst.Types

valuevalType :: Val -> ValType

valuehasType :: ValType -> Val -> Bool

classclass FromVal a where

Methods

fromVal :: (MonadPlus m, MonadFail m) => Val -> m a

Instances17FromVal, …

FromVal IntegerDefined in typst-0.5.0.3 · Typst.Types
FromVal StringDefined in typst-0.5.0.3 · Typst.Types
FromVal RationalDefined in typst-0.5.0.3 · Typst.Types
FromVal BoolDefined in typst-0.5.0.3 · Typst.Types
FromVal DoubleDefined in typst-0.5.0.3 · Typst.Types
FromVal IntDefined in typst-0.5.0.3 · Typst.Types
FromVal TextDefined in typst-0.5.0.3 · Typst.Types
FromVal REDefined in typst-0.5.0.3 · Typst.Types
FromVal CounterDefined in typst-0.5.0.3 · Typst.Types
FromVal DirectionDefined in typst-0.5.0.3 · Typst.Types
FromVal FunctionDefined in typst-0.5.0.3 · Typst.Types
FromVal LengthDefined in typst-0.5.0.3 · Typst.Types
FromVal SelectorDefined in typst-0.5.0.3 · Typst.Types
FromVal ValDefined in typst-0.5.0.3 · Typst.Types
FromVal (Seq Content)Defined in typst-0.5.0.3 · Typst.Types
FromVal a => FromVal (Maybe a)Defined in typst-0.5.0.3 · Typst.Types
FromVal a => FromVal (Vector a)Defined in typst-0.5.0.3 · Typst.Types

classclass Negatable a where

Methods

maybeNegate :: a -> Maybe a

Instances1Negatable

Negatable ValDefined in typst-0.5.0.3 · Typst.Types

classclass Negatable a => Summable a where

Methods

maybePlus :: a -> a -> Maybe a
maybeMinus :: a -> a -> Maybe a

Instances1Summable

Summable ValDefined in typst-0.5.0.3 · Typst.Types

classclass Multipliable a where

Methods

maybeTimes :: a -> a -> Maybe a
maybeDividedBy :: a -> a -> Maybe a

Instances1Multipliable

Multipliable ValDefined in typst-0.5.0.3 · Typst.Types

datadata Selector

Constructors

SelectElement Identifier [(Identifier, Val)]
SelectString !Text
SelectRegex !RE
SelectLabel !Text
SelectOr Selector Selector
SelectAnd Selector Selector
SelectBefore Selector Selector
SelectAfter Selector Selector

Instances4Eq, Ord, Show, FromVal

Eq SelectorDefined in typst-0.5.0.3 · Typst.Types
Ord SelectorDefined in typst-0.5.0.3 · Typst.Types
Show SelectorDefined in typst-0.5.0.3 · Typst.Types
FromVal SelectorDefined in typst-0.5.0.3 · Typst.Types

datadata Symbol

Constructors

Symbol
- symDefault :: !Text
- symAccent :: !Bool
- symVariants :: [(Set Text, Text)]

Instances2Eq, Show

Eq SymbolDefined in typst-0.5.0.3 · Typst.Types
Show SymbolDefined in typst-0.5.0.3 · Typst.Types

datadata Content

Constructors

Txt !Text
Lab !Text
Elt
- eltName :: Identifier
- eltPos :: Maybe SourcePos
- eltFields :: Map Identifier Val

Instances5Eq, Ord, Show, IsString, FromVal

Eq ContentDefined in typst-0.5.0.3 · Typst.Types
Ord ContentDefined in typst-0.5.0.3 · Typst.Types
Show ContentDefined in typst-0.5.0.3 · Typst.Types
IsString ContentDefined in typst-0.5.0.3 · Typst.Types
FromVal (Seq Content)Defined in typst-0.5.0.3 · Typst.Types

newtypenewtype Function

Constructors

Function (forall (m :: Type -> Type). Monad m => Arguments -> MP m Val)

Instances3Eq, Show, FromVal

Eq FunctionDefined in typst-0.5.0.3 · Typst.Types
Show FunctionDefined in typst-0.5.0.3 · Typst.Types
FromVal FunctionDefined in typst-0.5.0.3 · Typst.Types

datadata Arguments

Constructors

Arguments
- positional :: [Val]
- named :: OMap Identifier Val

Instances4Eq, Show, Semigroup, Monoid

Eq ArgumentsDefined in typst-0.5.0.3 · Typst.Types
Show ArgumentsDefined in typst-0.5.0.3 · Typst.Types
Semigroup ArgumentsDefined in typst-0.5.0.3 · Typst.Types
Monoid ArgumentsDefined in typst-0.5.0.3 · Typst.Types

valuegetPositionalArg

:: (MonadFail m, MonadPlus m, FromVal a)
=> Int
-> Arguments
-> m a

valuegetNamedArg

:: (MonadFail m, MonadPlus m, FromVal a)
=> Identifier
-> Arguments
-> m a

classclass Compare a where

Methods

comp :: a -> a -> Maybe Ordering

Instances1Compare

Compare ValDefined in typst-0.5.0.3 · Typst.Types

typetype MP (m :: Type -> Type) = ParsecT [Markup] (EvalState m) m

datadata Scope

FunctionScope BlockScope

Instances3Eq, Ord, Show

Eq ScopeDefined in typst-0.5.0.3 · Typst.Types
Ord ScopeDefined in typst-0.5.0.3 · Typst.Types
Show ScopeDefined in typst-0.5.0.3 · Typst.Types

datadata FlowDirective

Instances3Eq, Ord, Show

Eq FlowDirectiveDefined in typst-0.5.0.3 · Typst.Types
Ord FlowDirectiveDefined in typst-0.5.0.3 · Typst.Types
Show FlowDirectiveDefined in typst-0.5.0.3 · Typst.Types

datadata Operations (m :: Type -> Type)

Constructors

Operations
- loadBytes :: FilePath -> m ByteString
- currentUTCTime :: m UTCTime
- lookupEnvVar :: String -> m (Maybe String)
- checkExistence :: FilePath -> m Bool

datadata XdgDirectory

Special directories for storing user-specific application data, configuration, and cache files, as specified by the XDG Base Directory Specification.

Note: On Windows, XdgData and XdgConfig usually map to the same directory.

Constructors

XdgData
For data files (e.g. images). It uses the XDG_DATA_HOME environment variable. On non-Windows systems, the default is ~/.local/share. On Windows, the default is %APPDATA% (e.g. C:/Users/<user>/AppData/Roaming). Can be considered as the user-specific equivalent of /usr/share.
XdgConfig
For configuration files. It uses the XDG_CONFIG_HOME environment variable. On non-Windows systems, the default is ~/.config. On Windows, the default is %APPDATA% (e.g. C:/Users/<user>/AppData/Roaming). Can be considered as the user-specific equivalent of /etc.
XdgCache
For non-essential files (e.g. cache). It uses the XDG_CACHE_HOME environment variable. On non-Windows systems, the default is ~/.cache. On Windows, the default is %LOCALAPPDATA% (e.g. C:/Users/<user>/AppData/Local). Can be considered as the user-specific equivalent of /var/cache.
XdgState
For data that should persist between (application) restarts, but that is not important or portable enough to the user that it should be stored in XdgData. It uses the XDG_STATE_HOME environment variable. On non-Windows sytems, the default is ~/.local/state. On Windows, the default is %LOCALAPPDATA% (e.g. C:/Users/<user>/AppData/Local).

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Enum XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Eq XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Ord XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Read XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common
Show XdgDirectoryDefined in directory-1.3.8.5 · System.Directory.Internal.Common