Safe Haskell	None
Language	Haskell2010

Data.BCP47

Contents

Construction
Serialization
Subtags
For testing

Description

Human beings on our planet have, past and present, used a number of languages. There are many reasons why one would want to identify the language used when presenting or requesting information.

The language of an information item or a user's language preferences often need to be identified so that appropriate processing can be applied. For example, the user's language preferences in a Web browser can be used to select Web pages appropriately. Language information can also be used to select among tools (such as dictionaries) to assist in the processing or understanding of content in different languages. Knowledge about the particular language used by some piece of information content might be useful or even required by some types of processing, for example, spell-checking, computer-synthesized speech, Braille transcription, or high-quality print renderings.

- https://tools.ietf.org/html/bcp47

Synopsis

data BCP47
inits :: BCP47 -> [BCP47]
mkLanguage :: ISO639_1 -> BCP47
mkLocalized :: ISO639_1 -> Country -> BCP47
fromText :: Text -> Either Text BCP47
toText :: BCP47 -> Text
toSubtags :: BCP47 -> [Subtags]
data ISO639_1
language :: BCP47 -> ISO639_1
languageToText :: ISO639_1 -> Text
languageFromText :: Text -> Either Text ISO639_1
data LanguageExtension
extendedLanguageSubtags :: BCP47 -> Set LanguageExtension
languageExtensionToText :: LanguageExtension -> Text
languageExtensionFromText :: Text -> Either Text LanguageExtension
data Script
script :: BCP47 -> Maybe Script
scriptToText :: Script -> Text
scriptFromText :: Text -> Either Text Script
data Country
region :: BCP47 -> Maybe Country
regionToText :: Country -> Text
regionFromText :: Text -> Either Text Country
data Variant
variants :: BCP47 -> Set Variant
variantToText :: Variant -> Text
variantFromText :: Text -> Either Text Variant
data Extension
extensions :: BCP47 -> Set Extension
extensionToText :: Extension -> Text
extensionFromText :: Text -> Either Text Extension
data PrivateUse
privateUse :: BCP47 -> Set PrivateUse
privateUseToText :: PrivateUse -> Text
privateUseFromText :: Text -> Either Text (Set PrivateUse)
en :: BCP47
es :: BCP47
sw :: BCP47
enGB :: BCP47
enUS :: BCP47
enTJP :: BCP47
enGBTJP :: BCP47

Documentation

data BCP47 Source #

A language tag

Language tags are used to help identify languages, whether spoken, written, signed, or otherwise signaled, for the purpose of communication. This includes constructed and artificial languages but excludes languages not intended primarily for human communication, such as programming languages.

Instances

Eq BCP47 Source #
Instance details Defined in Data.BCP47 Methods (==) :: BCP47 -> BCP47 -> Bool # (/=) :: BCP47 -> BCP47 -> Bool #
Ord BCP47 Source #
Instance details Defined in Data.BCP47 Methods compare :: BCP47 -> BCP47 -> Ordering # (<) :: BCP47 -> BCP47 -> Bool # (<=) :: BCP47 -> BCP47 -> Bool # (>) :: BCP47 -> BCP47 -> Bool # (>=) :: BCP47 -> BCP47 -> Bool # max :: BCP47 -> BCP47 -> BCP47 # min :: BCP47 -> BCP47 -> BCP47 #
Read BCP47 Source #
Instance details Defined in Data.BCP47 Methods readsPrec :: Int -> ReadS BCP47 # readList :: ReadS [BCP47] # readPrec :: ReadPrec BCP47 # readListPrec :: ReadPrec [BCP47] #
Show BCP47 Source #
Instance details Defined in Data.BCP47 Methods showsPrec :: Int -> BCP47 -> ShowS # show :: BCP47 -> String # showList :: [BCP47] -> ShowS #
Arbitrary BCP47 Source #
Instance details Defined in Data.BCP47 Methods arbitrary :: Gen BCP47 # shrink :: BCP47 -> [BCP47] #
ToJSON BCP47 Source #
Instance details Defined in Data.BCP47 Methods toJSON :: BCP47 -> Value # toEncoding :: BCP47 -> Encoding # toJSONList :: [BCP47] -> Value # toEncodingList :: [BCP47] -> Encoding #
FromJSON BCP47 Source #
Instance details Defined in Data.BCP47 Methods parseJSON :: Value -> Parser BCP47 # parseJSONList :: Value -> Parser [BCP47] #

inits :: BCP47 -> [BCP47] Source #

Produce a list of (<= priority) language tags

>>> inits enGBTJP
[en,en-GB,en-GB-t-jp]

Construction

mkLanguage :: ISO639_1 -> BCP47 Source #

Construct a simple language tag

mkLocalized :: ISO639_1 -> Country -> BCP47 Source #

Construct a localized tag

fromText :: Text -> Either Text BCP47 Source #

Parse a language tag from text

>>> fromText $ pack "en"
Right en

>>> fromText $ pack "de-CH"
Right de-CH

>>> fromText $ pack "ru-USR"
Left "fromText:1:3:\n  |\n1 | ru-USR\n  |   ^\nunexpected '-'\n"

>>> fromText $ pack "en-a-ccc-v-qqq-a-bbb"
Right en-a-bbb-a-ccc-v-qqq

>>> fromText $ pack "de-Latn-DE"
Right de-Latn-DE

>>> fromText $ pack "de-Latf-DE"
Right de-Latf-DE

>>> fromText $ pack "de-CH-1996"
Right de-CH-1996

>>> fromText $ pack "de-Deva"
Right de-Deva

>>> fromText $ pack "zh-Hant-CN-x-private1-private2"
Right zh-Hant-CN-x-private1-private2

>>> fromText $ pack "zh-Hant-CN-x-private1"
Right zh-Hant-CN-x-private1

>>> fromText $ pack "zh-Hant-CN"
Right zh-Hant-CN

>>> fromText $ pack "zh-Hant"
Right zh-Hant

>>> fromText $ pack "zh"
Right zh

Serialization

toText :: BCP47 -> Text Source #

Serialize BCP47 to Text

Subtags are serialized in the order described in the BCP 47 specification. Private-use subtags only appear at the end prefixed with an x.

Subtags

A language tag is composed from a sequence of one or more "subtags", each of which refines or narrows the range of language identified by the overall tag. Subtags, in turn, are a sequence of alphanumeric characters (letters and digits), distinguished and separated from other subtags in a tag by a hyphen ("-", [Unicode] U+002D).

toSubtags :: BCP47 -> [Subtags] Source #

Convert tag to list of subtags

Language

data ISO639_1 #

Instances

Enum ISO639_1
Instance details Defined in Data.LanguageCodes Methods succ :: ISO639_1 -> ISO639_1 # pred :: ISO639_1 -> ISO639_1 # toEnum :: Int -> ISO639_1 # fromEnum :: ISO639_1 -> Int # enumFrom :: ISO639_1 -> [ISO639_1] # enumFromThen :: ISO639_1 -> ISO639_1 -> [ISO639_1] # enumFromTo :: ISO639_1 -> ISO639_1 -> [ISO639_1] # enumFromThenTo :: ISO639_1 -> ISO639_1 -> ISO639_1 -> [ISO639_1] #
Eq ISO639_1
Instance details Defined in Data.LanguageCodes Methods (==) :: ISO639_1 -> ISO639_1 -> Bool # (/=) :: ISO639_1 -> ISO639_1 -> Bool #
Ord ISO639_1
Instance details Defined in Data.LanguageCodes Methods compare :: ISO639_1 -> ISO639_1 -> Ordering # (<) :: ISO639_1 -> ISO639_1 -> Bool # (<=) :: ISO639_1 -> ISO639_1 -> Bool # (>) :: ISO639_1 -> ISO639_1 -> Bool # (>=) :: ISO639_1 -> ISO639_1 -> Bool # max :: ISO639_1 -> ISO639_1 -> ISO639_1 # min :: ISO639_1 -> ISO639_1 -> ISO639_1 #
Read ISO639_1
Instance details Defined in Data.LanguageCodes Methods readsPrec :: Int -> ReadS ISO639_1 # readList :: ReadS [ISO639_1] # readPrec :: ReadPrec ISO639_1 # readListPrec :: ReadPrec [ISO639_1] #
Show ISO639_1
Instance details Defined in Data.LanguageCodes Methods showsPrec :: Int -> ISO639_1 -> ShowS # show :: ISO639_1 -> String # showList :: [ISO639_1] -> ShowS #

language :: BCP47 -> ISO639_1 Source #

The language subtag

languageToText :: ISO639_1 -> Text Source #

languageFromText :: Text -> Either Text ISO639_1 Source #

Parse a language subtag from Text

Language Extension

data LanguageExtension Source #

Extended language subtags

These are used to identify certain specially selected languages that, for various historical and compatibility reasons, are closely identified with or tagged using an existing primary language subtag.

Instances

Eq LanguageExtension Source #
Instance details Defined in Data.BCP47.Internal.LanguageExtension Methods (==) :: LanguageExtension -> LanguageExtension -> Bool # (/=) :: LanguageExtension -> LanguageExtension -> Bool #
Ord LanguageExtension Source #
Instance details Defined in Data.BCP47.Internal.LanguageExtension Methods compare :: LanguageExtension -> LanguageExtension -> Ordering # (<) :: LanguageExtension -> LanguageExtension -> Bool # (<=) :: LanguageExtension -> LanguageExtension -> Bool # (>) :: LanguageExtension -> LanguageExtension -> Bool # (>=) :: LanguageExtension -> LanguageExtension -> Bool # max :: LanguageExtension -> LanguageExtension -> LanguageExtension # min :: LanguageExtension -> LanguageExtension -> LanguageExtension #
Show LanguageExtension Source #
Instance details Defined in Data.BCP47.Internal.LanguageExtension Methods showsPrec :: Int -> LanguageExtension -> ShowS # show :: LanguageExtension -> String # showList :: [LanguageExtension] -> ShowS #
Arbitrary LanguageExtension Source #
Instance details Defined in Data.BCP47.Internal.LanguageExtension Methods arbitrary :: Gen LanguageExtension # shrink :: LanguageExtension -> [LanguageExtension] #

extendedLanguageSubtags :: BCP47 -> Set LanguageExtension Source #

Look up all language extension subtags

languageExtensionToText :: LanguageExtension -> Text Source #

languageExtensionFromText :: Text -> Either Text LanguageExtension Source #

Parse a LanguageExtension subtag from Text

Language Script

data Script Source #

Script subtags

Script subtags are used to indicate the script or writing system variations that distinguish the written forms of a language or its dialects.

Instances

Eq Script Source #
Instance details Defined in Data.BCP47.Internal.Script Methods (==) :: Script -> Script -> Bool # (/=) :: Script -> Script -> Bool #
Ord Script Source #
Instance details Defined in Data.BCP47.Internal.Script Methods compare :: Script -> Script -> Ordering # (<) :: Script -> Script -> Bool # (<=) :: Script -> Script -> Bool # (>) :: Script -> Script -> Bool # (>=) :: Script -> Script -> Bool # max :: Script -> Script -> Script # min :: Script -> Script -> Script #
Show Script Source #
Instance details Defined in Data.BCP47.Internal.Script Methods showsPrec :: Int -> Script -> ShowS # show :: Script -> String # showList :: [Script] -> ShowS #
Arbitrary Script Source #
Instance details Defined in Data.BCP47.Internal.Script Methods arbitrary :: Gen Script # shrink :: Script -> [Script] #

script :: BCP47 -> Maybe Script Source #

Look up the script subtag

scriptToText :: Script -> Text Source #

scriptFromText :: Text -> Either Text Script Source #

Parse a Script subtag from Text

Region

data Country #

A country recognized by ISO 3166.

Instances

Bounded Country
Instance details Defined in Country.Unexposed.Names Methods minBound :: Country # maxBound :: Country #
Enum Country
Instance details Defined in Country.Unexposed.Names Methods succ :: Country -> Country # pred :: Country -> Country # toEnum :: Int -> Country # fromEnum :: Country -> Int # enumFrom :: Country -> [Country] # enumFromThen :: Country -> Country -> [Country] # enumFromTo :: Country -> Country -> [Country] # enumFromThenTo :: Country -> Country -> Country -> [Country] #
Eq Country
Instance details Defined in Country.Unexposed.Names Methods (==) :: Country -> Country -> Bool # (/=) :: Country -> Country -> Bool #
Ord Country
Instance details Defined in Country.Unexposed.Names Methods compare :: Country -> Country -> Ordering # (<) :: Country -> Country -> Bool # (<=) :: Country -> Country -> Bool # (>) :: Country -> Country -> Bool # (>=) :: Country -> Country -> Bool # max :: Country -> Country -> Country # min :: Country -> Country -> Country #
Show Country
Instance details Defined in Country.Unexposed.Names Methods showsPrec :: Int -> Country -> ShowS # show :: Country -> String # showList :: [Country] -> ShowS #
Generic Country
Instance details Defined in Country.Unexposed.Names Associated Types type Rep Country :: Type -> Type # Methods from :: Country -> Rep Country x # to :: Rep Country x -> Country #
Hashable Country
Instance details Defined in Country.Unexposed.Names Methods hashWithSalt :: Int -> Country -> Int # hash :: Country -> Int #
ToJSON Country
Instance details Defined in Country.Unexposed.Names Methods toJSON :: Country -> Value # toEncoding :: Country -> Encoding # toJSONList :: [Country] -> Value # toEncodingList :: [Country] -> Encoding #
FromJSON Country
Instance details Defined in Country.Unexposed.Names Methods parseJSON :: Value -> Parser Country # parseJSONList :: Value -> Parser [Country] #
Storable Country
Instance details Defined in Country.Unexposed.Names Methods sizeOf :: Country -> Int # alignment :: Country -> Int # peekElemOff :: Ptr Country -> Int -> IO Country # pokeElemOff :: Ptr Country -> Int -> Country -> IO () # peekByteOff :: Ptr b -> Int -> IO Country # pokeByteOff :: Ptr b -> Int -> Country -> IO () # peek :: Ptr Country -> IO Country # poke :: Ptr Country -> Country -> IO () #
NFData Country
Instance details Defined in Country.Unexposed.Names Methods rnf :: Country -> () #
Prim Country
Instance details Defined in Country.Unexposed.Names Methods sizeOf# :: Country -> Int# # alignment# :: Country -> Int# # indexByteArray# :: ByteArray# -> Int# -> Country # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Country#) # writeByteArray# :: MutableByteArray# s -> Int# -> Country -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Country -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> Country # readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, Country#) # writeOffAddr# :: Addr# -> Int# -> Country -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> Country -> State# s -> State# s #
type Rep Country
Instance details Defined in Country.Unexposed.Names type Rep Country = D1 (MetaData "Country" "Country.Unexposed.Names" "country-0.1.6-5j6TXoJ8D6x7SN1lYh6lj5" True) (C1 (MetaCons "Country" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word16)))

region :: BCP47 -> Maybe Country Source #

Look up the region subtag

regionToText :: Country -> Text Source #

regionFromText :: Text -> Either Text Country Source #

Parse a region subtag from Text

>>> regionFromText $ pack "ZW"
Right zimbabwe

>>> regionFromText $ pack "012"
Right algeria

>>> regionFromText $ pack "asdf"
Left "regionFromText:1:1:\n  |\n1 | asdf\n  | ^\nunexpected 'a'\nexpecting 2 or 3 character country code\n"

Variant

data Variant Source #

Variant subtags

Variant subtags are used to indicate additional, well-recognized variations that define a language or its dialects that are not covered by other available subtags.

Instances

Eq Variant Source #
Instance details Defined in Data.BCP47.Internal.Variant Methods (==) :: Variant -> Variant -> Bool # (/=) :: Variant -> Variant -> Bool #
Ord Variant Source #
Instance details Defined in Data.BCP47.Internal.Variant Methods compare :: Variant -> Variant -> Ordering # (<) :: Variant -> Variant -> Bool # (<=) :: Variant -> Variant -> Bool # (>) :: Variant -> Variant -> Bool # (>=) :: Variant -> Variant -> Bool # max :: Variant -> Variant -> Variant # min :: Variant -> Variant -> Variant #
Show Variant Source #
Instance details Defined in Data.BCP47.Internal.Variant Methods showsPrec :: Int -> Variant -> ShowS # show :: Variant -> String # showList :: [Variant] -> ShowS #
Arbitrary Variant Source #
Instance details Defined in Data.BCP47.Internal.Variant Methods arbitrary :: Gen Variant # shrink :: Variant -> [Variant] #

variants :: BCP47 -> Set Variant Source #

Look up all variant subtags

variantToText :: Variant -> Text Source #

variantFromText :: Text -> Either Text Variant Source #

Parse a Variant subtag from Text

Extension

data Extension Source #

Extension subtags

Extensions provide a mechanism for extending language tags for use in various applications. They are intended to identify information that is commonly used in association with languages or language tags but that is not part of language identification.

Instances

Eq Extension Source #
Instance details Defined in Data.BCP47.Internal.Extension Methods (==) :: Extension -> Extension -> Bool # (/=) :: Extension -> Extension -> Bool #
Ord Extension Source #
Instance details Defined in Data.BCP47.Internal.Extension Methods compare :: Extension -> Extension -> Ordering # (<) :: Extension -> Extension -> Bool # (<=) :: Extension -> Extension -> Bool # (>) :: Extension -> Extension -> Bool # (>=) :: Extension -> Extension -> Bool # max :: Extension -> Extension -> Extension # min :: Extension -> Extension -> Extension #
Show Extension Source #
Instance details Defined in Data.BCP47.Internal.Extension Methods showsPrec :: Int -> Extension -> ShowS # show :: Extension -> String # showList :: [Extension] -> ShowS #
Arbitrary Extension Source #
Instance details Defined in Data.BCP47.Internal.Extension Methods arbitrary :: Gen Extension # shrink :: Extension -> [Extension] #

extensions :: BCP47 -> Set Extension Source #

Look up all extension subtags

extensionToText :: Extension -> Text Source #

extensionFromText :: Text -> Either Text Extension Source #

Parse an Extension subtag from Text

Private Use

data PrivateUse Source #

Private Use subtags

Private use subtags are used to indicate distinctions in language that are important in a given context by private agreement.

Instances

Eq PrivateUse Source #
Instance details Defined in Data.BCP47.Internal.PrivateUse Methods (==) :: PrivateUse -> PrivateUse -> Bool # (/=) :: PrivateUse -> PrivateUse -> Bool #
Ord PrivateUse Source #
Instance details Defined in Data.BCP47.Internal.PrivateUse Methods compare :: PrivateUse -> PrivateUse -> Ordering # (<) :: PrivateUse -> PrivateUse -> Bool # (<=) :: PrivateUse -> PrivateUse -> Bool # (>) :: PrivateUse -> PrivateUse -> Bool # (>=) :: PrivateUse -> PrivateUse -> Bool # max :: PrivateUse -> PrivateUse -> PrivateUse # min :: PrivateUse -> PrivateUse -> PrivateUse #
Show PrivateUse Source #
Instance details Defined in Data.BCP47.Internal.PrivateUse Methods showsPrec :: Int -> PrivateUse -> ShowS # show :: PrivateUse -> String # showList :: [PrivateUse] -> ShowS #
Arbitrary PrivateUse Source #
Instance details Defined in Data.BCP47.Internal.PrivateUse Methods arbitrary :: Gen PrivateUse # shrink :: PrivateUse -> [PrivateUse] #