Copyright	(c) 2026 Institute for Digital Autonomy
License	EUPL-1.2
Maintainer	IDA
Safe Haskell	Trustworthy
Language	Haskell2010

Language.Fluent

Description

Project Fluent is a localisation system designed to unleash the entire expressive power of natural language translations.

This library provides the core Fluent translation machinery to go from parsed Resources to translated messages:

the Locale typeclass which supplies locale-specific operations
the Bundle type which combines Locales with parsed Resources
the Translate typeclass which translates messages from a Bundle

This library does not provide any concrete instances of Locale. It is not intended to be used directly for translating messages.

Applications should instead use a library built on top of this one, such as:

fluent-icu, backed by text-icu
miso-fluent, backed by the browser's Intl API

Synopsis

data Identifier
data Resource
data Bundle locale = Bundle {
- locales :: NonEmpty locale
- resources :: [Resource]
- functions :: HashMap Identifier ([Pattern] -> HashMap Identifier SomeValue -> Either String Pattern)
- useIsolating :: Bool
}
data Override
- = UseIsolating Bool
- | WithFunction Identifier ([Pattern] -> HashMap Identifier SomeValue -> Either String Pattern)
bundle :: NonEmpty locale -> [Resource] -> Bundle locale
module Language.Fluent.Locale
data Style
- = Decimal
- | Percent
- | Currency Text
- | Unit Text
data CurrencyDisplay
- = Symbol
- | Code
- | Name
data NumberOptions = NumberOptions {
- form :: Form
- style :: Style
- currencyDisplay :: CurrencyDisplay
- unitDisplay :: Width
- useGrouping :: Bool
- minimumIntegerDigits :: Int
- minimumFractionDigits :: Int
- maximumFractionDigits :: Maybe Int
- minimumSignificantDigits :: Maybe Int
- maximumSignificantDigits :: Maybe Int
}
numberOptions :: NumberOptions
parseResource :: Text -> Either String Resource
newtype Pattern = Pattern (NonEmpty PatternElement)
data PatternElement
- = Value SomeValue
- | Isolated Pattern
data Form
- = Cardinal
- | Ordinal
module Language.Fluent.TH
data Digits
- = Numeric
- | TwoDigit
data TimeOptions = TimeOptions {
- timeZone :: Text
- hour12 :: Maybe Bool
- weekday :: Maybe Width
- era :: Maybe Width
- year :: Maybe Digits
- month :: Maybe (Either Digits Width)
- day :: Maybe Digits
- hour :: Maybe Digits
- minute :: Maybe Digits
- second :: Maybe Digits
- timeZoneName :: Maybe Width
}
timeOptions :: TimeOptions
module Language.Fluent.Translate
module Language.Fluent.Value
data Width
- = Narrow
- | Short
- | Long

Documentation

data Identifier #

The name of a Message, Term, Attribute, variable, function, or named argument.

Instances

Instances details

Show Identifier
Instance details Defined in Language.Fluent.AST Methods showsPrec :: Int -> Identifier -> ShowS # show :: Identifier -> String # showList :: [Identifier] -> ShowS #
Eq Identifier
Instance details Defined in Language.Fluent.AST Methods (==) :: Identifier -> Identifier -> Bool # (/=) :: Identifier -> Identifier -> Bool #
Ord Identifier
Instance details Defined in Language.Fluent.AST Methods compare :: Identifier -> Identifier -> Ordering # (<) :: Identifier -> Identifier -> Bool # (<=) :: Identifier -> Identifier -> Bool # (>) :: Identifier -> Identifier -> Bool # (>=) :: Identifier -> Identifier -> Bool # max :: Identifier -> Identifier -> Identifier # min :: Identifier -> Identifier -> Identifier #
Hashable Identifier
Instance details Defined in Language.Fluent.AST Methods hashWithSalt :: Int -> Identifier -> Int # hash :: Identifier -> Int #
Lift Identifier
Instance details Defined in Language.Fluent.TH Methods lift :: Quote m => Identifier -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Identifier -> Code m Identifier #

data Resource #

An entire FTL file

Instances

Instances details

Generic Resource

Instance details

Defined in Language.Fluent.AST

Associated Types

type Rep Resource
Instance details Defined in Language.Fluent.AST type Rep Resource = D1 ('MetaData "Resource" "Language.Fluent.AST" "fluent-syntax-1.0.0-7BgVkF4w5nsLx3MmJftb3I" 'True) (C1 ('MetaCons "Resource" 'PrefixI 'True) (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Entry])))

Methods

from :: Resource -> Rep Resource x #

to :: Rep Resource x -> Resource #

Show Resource

Instance details

Defined in Language.Fluent.AST

Methods

showsPrec :: Int -> Resource -> ShowS #

show :: Resource -> String #

showList :: [Resource] -> ShowS #

Eq Resource

Instance details

Defined in Language.Fluent.AST

Methods

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

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

Lift Resource

Instance details

Defined in Language.Fluent.TH

Methods

lift :: Quote m => Resource -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Resource -> Code m Resource #

type Rep Resource

Instance details

Defined in Language.Fluent.AST

type Rep Resource = D1 ('MetaData "Resource" "Language.Fluent.AST" "fluent-syntax-1.0.0-7BgVkF4w5nsLx3MmJftb3I" 'True) (C1 ('MetaCons "Resource" 'PrefixI 'True) (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Entry])))

data Bundle locale Source #

A collection of Fluent resources and the configuration needed to resolve and format messages for a locale.

Constructors

Bundle

Fields

locales :: NonEmpty locale
The locale of the messages, followed by the fallback locales for number and date formatting.
resources :: [Resource]
Message and term definitions, searched in order.
functions :: HashMap Identifier ([Pattern] -> HashMap Identifier SomeValue -> Either String Pattern)
Functions available to messages, shadowing the builtins of the same name.
useIsolating :: Bool
Whether to use isolation marks (FSI, PDI) around interpolated values.

Instances

Instances details

Locale locale => Show (Bundle locale) Source #
Instance details Defined in Language.Fluent.Bundle Methods showsPrec :: Int -> Bundle locale -> ShowS # show :: Bundle locale -> String # showList :: [Bundle locale] -> ShowS #
Locale locale => Eq (Bundle locale) Source #	Only the names of the `functions` are compared, since their implementations cannot be compared for equality.
Instance details Defined in Language.Fluent.Bundle Methods (==) :: Bundle locale -> Bundle locale -> Bool # (/=) :: Bundle locale -> Bundle locale -> Bool #
Locale locale => Translate (Bundle locale -> Either String Text) Source #
Instance details Defined in Language.Fluent.Translate Methods translate :: Reference -> Bundle locale -> Either String Text Source #

data Override Source #

Constructors

UseIsolating Bool
WithFunction Identifier ([Pattern] -> HashMap Identifier SomeValue -> Either String Pattern)

Instances

Instances details

Translate r => Translate (Override -> r) Source #
Instance details Defined in Language.Fluent.Translate Methods translate :: Reference -> Override -> r Source #

bundle :: NonEmpty locale -> [Resource] -> Bundle locale Source #

module Language.Fluent.Locale

data Style Source #

What a number denotes, which determines how it is formatted.

Constructors

Decimal	A plain number: `12.5`
Percent	A ratio, shown as a percentage: `1,250%`
Currency Text	An amount of the currency with the given ISO 4217 code: `Currency EUR` gives `€12.50`
Unit Text	A measurement in the given CLDR unit: `Unit "second"` gives `12.5 s`

Instances

Instances details

Show Style Source #
Instance details Defined in Language.Fluent.Number Methods showsPrec :: Int -> Style -> ShowS # show :: Style -> String # showList :: [Style] -> ShowS #
Eq Style Source #
Instance details Defined in Language.Fluent.Number Methods (==) :: Style -> Style -> Bool # (/=) :: Style -> Style -> Bool #

data CurrencyDisplay Source #

How a Currency is displayed.

Constructors

Symbol	€12.50
Code	EUR 12.50
Name	12.50 euros

Instances

Instances details

Bounded CurrencyDisplay Source #
Instance details Defined in Language.Fluent.Number Methods minBound :: CurrencyDisplay # maxBound :: CurrencyDisplay #
Enum CurrencyDisplay Source #
Instance details Defined in Language.Fluent.Number Methods succ :: CurrencyDisplay -> CurrencyDisplay # pred :: CurrencyDisplay -> CurrencyDisplay # toEnum :: Int -> CurrencyDisplay # fromEnum :: CurrencyDisplay -> Int # enumFrom :: CurrencyDisplay -> [CurrencyDisplay] # enumFromThen :: CurrencyDisplay -> CurrencyDisplay -> [CurrencyDisplay] # enumFromTo :: CurrencyDisplay -> CurrencyDisplay -> [CurrencyDisplay] # enumFromThenTo :: CurrencyDisplay -> CurrencyDisplay -> CurrencyDisplay -> [CurrencyDisplay] #
Read CurrencyDisplay Source #
Instance details Defined in Language.Fluent.Number Methods readsPrec :: Int -> ReadS CurrencyDisplay # readList :: ReadS [CurrencyDisplay] # readPrec :: ReadPrec CurrencyDisplay # readListPrec :: ReadPrec [CurrencyDisplay] #
Show CurrencyDisplay Source #
Instance details Defined in Language.Fluent.Number Methods showsPrec :: Int -> CurrencyDisplay -> ShowS # show :: CurrencyDisplay -> String # showList :: [CurrencyDisplay] -> ShowS #
Eq CurrencyDisplay Source #
Instance details Defined in Language.Fluent.Number Methods (==) :: CurrencyDisplay -> CurrencyDisplay -> Bool # (/=) :: CurrencyDisplay -> CurrencyDisplay -> Bool #

data NumberOptions Source #

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat

Constructors

NumberOptions
Fields form :: Form style :: Style currencyDisplay :: CurrencyDisplay unitDisplay :: Width useGrouping :: Bool minimumIntegerDigits :: Int minimumFractionDigits :: Int maximumFractionDigits :: Maybe Int minimumSignificantDigits :: Maybe Int maximumSignificantDigits :: Maybe Int

Instances

Instances details

Show NumberOptions Source #
Instance details Defined in Language.Fluent.Number Methods showsPrec :: Int -> NumberOptions -> ShowS # show :: NumberOptions -> String # showList :: [NumberOptions] -> ShowS #
Eq NumberOptions Source #
Instance details Defined in Language.Fluent.Number Methods (==) :: NumberOptions -> NumberOptions -> Bool # (/=) :: NumberOptions -> NumberOptions -> Bool #

numberOptions :: NumberOptions Source #

parseResource :: Text -> Either String Resource #

newtype Pattern Source #

A Pattern with all the selections and interpolations resolved down to SomeValue and isolation marks.

Constructors

Pattern (NonEmpty PatternElement)

Instances

Instances details

Value Pattern Source #
Instance details Defined in Language.Fluent.Pattern Methods value :: Pattern -> SomeValue Source # format :: Locale l => NonEmpty l -> Pattern -> Either String Text Source #
Semigroup Pattern Source #
Instance details Defined in Language.Fluent.Pattern Methods (<>) :: Pattern -> Pattern -> Pattern # sconcat :: NonEmpty Pattern -> Pattern # stimes :: Integral b => b -> Pattern -> Pattern #
IsString Pattern Source #
Instance details Defined in Language.Fluent.Pattern Methods fromString :: String -> Pattern #
Show Pattern Source #
Instance details Defined in Language.Fluent.Pattern Methods showsPrec :: Int -> Pattern -> ShowS # show :: Pattern -> String # showList :: [Pattern] -> ShowS #

data PatternElement Source #

A single piece of a Pattern.

Constructors

Value SomeValue	A value, ready to be formatted.
Isolated Pattern	A sequence of values surrounded by isolation marks (FSI, PDI).

Instances

Instances details

Value PatternElement Source #
Instance details Defined in Language.Fluent.Pattern Methods value :: PatternElement -> SomeValue Source # format :: Locale l => NonEmpty l -> PatternElement -> Either String Text Source #
IsString PatternElement Source #
Instance details Defined in Language.Fluent.Pattern Methods fromString :: String -> PatternElement #
Show PatternElement Source #
Instance details Defined in Language.Fluent.Pattern Methods showsPrec :: Int -> PatternElement -> ShowS # show :: PatternElement -> String # showList :: [PatternElement] -> ShowS #

data Form Source #

Constructors

Cardinal
Ordinal

Instances

Instances details

Bounded Form Source #
Instance details Defined in Language.Fluent.Plural Methods minBound :: Form # maxBound :: Form #
Enum Form Source #
Instance details Defined in Language.Fluent.Plural Methods succ :: Form -> Form # pred :: Form -> Form # toEnum :: Int -> Form # fromEnum :: Form -> Int # enumFrom :: Form -> [Form] # enumFromThen :: Form -> Form -> [Form] # enumFromTo :: Form -> Form -> [Form] # enumFromThenTo :: Form -> Form -> Form -> [Form] #
Read Form Source #
Instance details Defined in Language.Fluent.Plural Methods readsPrec :: Int -> ReadS Form # readList :: ReadS [Form] # readPrec :: ReadPrec Form # readListPrec :: ReadPrec [Form] #
Show Form Source #
Instance details Defined in Language.Fluent.Plural Methods showsPrec :: Int -> Form -> ShowS # show :: Form -> String # showList :: [Form] -> ShowS #
Eq Form Source #
Instance details Defined in Language.Fluent.Plural Methods (==) :: Form -> Form -> Bool # (/=) :: Form -> Form -> Bool #

module Language.Fluent.TH

data Digits Source #

How many digits a date or time field takes, e.g. the ninth month is 9 when Numeric and 09 when TwoDigit.

Constructors

Numeric
TwoDigit

Instances

Instances details

Bounded Digits Source #
Instance details Defined in Language.Fluent.Time Methods minBound :: Digits # maxBound :: Digits #
Enum Digits Source #
Instance details Defined in Language.Fluent.Time Methods succ :: Digits -> Digits # pred :: Digits -> Digits # toEnum :: Int -> Digits # fromEnum :: Digits -> Int # enumFrom :: Digits -> [Digits] # enumFromThen :: Digits -> Digits -> [Digits] # enumFromTo :: Digits -> Digits -> [Digits] # enumFromThenTo :: Digits -> Digits -> Digits -> [Digits] #
Read Digits Source #
Instance details Defined in Language.Fluent.Time Methods readsPrec :: Int -> ReadS Digits # readList :: ReadS [Digits] # readPrec :: ReadPrec Digits # readListPrec :: ReadPrec [Digits] #
Show Digits Source #
Instance details Defined in Language.Fluent.Time Methods showsPrec :: Int -> Digits -> ShowS # show :: Digits -> String # showList :: [Digits] -> ShowS #
Eq Digits Source #
Instance details Defined in Language.Fluent.Time Methods (==) :: Digits -> Digits -> Bool # (/=) :: Digits -> Digits -> Bool #

data TimeOptions Source #

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat

Constructors

TimeOptions
Fields timeZone :: Text hour12 :: Maybe Bool weekday :: Maybe Width era :: Maybe Width year :: Maybe Digits month :: Maybe (Either Digits Width) day :: Maybe Digits hour :: Maybe Digits minute :: Maybe Digits second :: Maybe Digits timeZoneName :: Maybe Width

Instances

Instances details

Show TimeOptions Source #
Instance details Defined in Language.Fluent.Time Methods showsPrec :: Int -> TimeOptions -> ShowS # show :: TimeOptions -> String # showList :: [TimeOptions] -> ShowS #
Eq TimeOptions Source #
Instance details Defined in Language.Fluent.Time Methods (==) :: TimeOptions -> TimeOptions -> Bool # (/=) :: TimeOptions -> TimeOptions -> Bool #

timeOptions :: TimeOptions Source #

module Language.Fluent.Translate

module Language.Fluent.Value

data Width Source #

Constructors

Narrow	e.g. `A`, `5s`
Short	e.g. `Aug`, `5 s`
Long	e.g. `August`, `5 seconds`

Instances

Instances details

Bounded Width Source #
Instance details Defined in Language.Fluent.Width Methods minBound :: Width # maxBound :: Width #
Enum Width Source #
Instance details Defined in Language.Fluent.Width Methods succ :: Width -> Width # pred :: Width -> Width # toEnum :: Int -> Width # fromEnum :: Width -> Int # enumFrom :: Width -> [Width] # enumFromThen :: Width -> Width -> [Width] # enumFromTo :: Width -> Width -> [Width] # enumFromThenTo :: Width -> Width -> Width -> [Width] #
Read Width Source #
Instance details Defined in Language.Fluent.Width Methods readsPrec :: Int -> ReadS Width # readList :: ReadS [Width] # readPrec :: ReadPrec Width # readListPrec :: ReadPrec [Width] #
Show Width Source #
Instance details Defined in Language.Fluent.Width Methods showsPrec :: Int -> Width -> ShowS # show :: Width -> String # showList :: [Width] -> ShowS #
Eq Width Source #
Instance details Defined in Language.Fluent.Width Methods (==) :: Width -> Width -> Bool # (/=) :: Width -> Width -> Bool #