Data.Tini

De/serializing INI files

data Ini

An ordered, comment-preserving representation of an INI file.

Instances

Eq Ini

Defined in Data.Tini.Types

Methods

(==) :: Ini -> Ini -> Bool

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

Read Ini

Defined in Data.Tini.Types

Methods

readsPrec :: Int -> ReadS Ini

readList :: ReadS [Ini]

readPrec :: ReadPrec Ini

readListPrec :: ReadPrec [Ini]

Show Ini

Defined in Data.Tini.Types

Methods

showsPrec :: Int -> Ini -> ShowS

show :: Ini -> String

showList :: [Ini] -> ShowS

parseIni :: (Alternative m, MonadFail m) => String -> m Ini

Parses an INI file from the given string.

A valid INI file may contain zero or more lines, where each line is any of the following:

• A [section header] in square brackets;
• a key = value pair;
• a comment, starting with either ; or #; or
• whitespace.

Note that a valid INI file must not contain duplicate section headers, and keys must be unique within their section. Section headers and keys are case-sensitive. Values must be contained on a single line. Whitespace is ignored at the start and end of each line, section header, key, and value.

showIni :: Ini -> String

Serialize an Ini to a String.

Reading and modifying properties

data Key

A key into an INI file.

A valid key is either of the format "sect.prop" or just "prop". The first key will match the property prop in section sect, and the second will match the property prop outside of any section. prop must not begin with ; or # or contain a =, and sect must not contain ]. Both parts are case-sensitive.

Instances

Eq Key

Defined in Data.Tini.Types

Methods

(==) :: Key -> Key -> Bool

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

Ord Key

Defined in Data.Tini.Types

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

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

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in Data.Tini.Types

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

IsString Key

Defined in Data.Tini.Types

Methods

fromString :: String -> Key

data SectionName

The name of an INI section. Must not contain the character ']'.

Instances

Eq SectionName

Defined in Data.Tini.Types

Methods

(==) :: SectionName -> SectionName -> Bool

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

Ord SectionName

Defined in Data.Tini.Types

Methods

compare :: SectionName -> SectionName -> Ordering

(<) :: SectionName -> SectionName -> Bool

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

(>) :: SectionName -> SectionName -> Bool

(>=) :: SectionName -> SectionName -> Bool

max :: SectionName -> SectionName -> SectionName

min :: SectionName -> SectionName -> SectionName

Read SectionName

Defined in Data.Tini.Types

Methods

readsPrec :: Int -> ReadS SectionName

readList :: ReadS [SectionName]

readPrec :: ReadPrec SectionName

readListPrec :: ReadPrec [SectionName]

Show SectionName

Defined in Data.Tini.Types

Methods

showsPrec :: Int -> SectionName -> ShowS

show :: SectionName -> String

showList :: [SectionName] -> ShowS

IsString SectionName

Defined in Data.Tini.Types

Methods

fromString :: String -> SectionName

empty :: Ini

An INI with no sections or properties.

get :: IniValue a => Ini -> Key -> Maybe a

Returns the value at the given key, if it exists and is valid at the function's result type. See IniValue for more information regarding how Haskell values are encoded in INI files.

set :: IniValue a => Ini -> Key -> a -> Ini

Sets the given key to the given value. If the key already exists, it will be overwritten.

New sections are added at the end of the given INI, and new properties are added at the end of their respective sections.

remove :: Key -> Ini -> Ini

Removes the given key from the given INI.

modify :: (Maybe String -> Maybe String) -> Key -> Ini -> Ini

Modify the value at the given key in the given INI.

If the key exists, the given function will receive Just value as its argument, otherwise it will receive Nothing.

If the given function returns Just new_value, the given key will be created or overwritten with new_value. If it returns Nothing, the key will be deleted.

toList :: Ini -> [(Key, String)]

Convert the given INI to s list of (key, value) pairs.

fromList :: [(Key, String)] -> Ini

Create an INI from the given list of (key, value) pairs.

merge :: Ini -> Ini -> Ini

Merge the given INIs. Values from the second INI override values from the first in cases where a key exists in both. Comments from the second INI are discarded.

Working with files

readIniFile :: FilePath -> IO (Maybe Ini)

Attempt to read the given file as an INI. Returns Nothing if the file does not exist or can not be parsed as an INI file.

writeIniFile :: FilePath -> Ini -> IO ()

Atomically write the given INI to the given file.

Adding new types of INI properties

class IniValue a where

Valid types for values of INI properties. Default implementation uses show and reads for showValue and readValue respectively.

Minimal complete definition

Nothing

Methods

showValue :: a -> String

showValue :: Show a => a -> String

readValue :: String -> Maybe a

readValue :: Read a => String -> Maybe a

Instances

IniValue Bool

Valid values for booleans (case-insensitive): true, false, yes, no, t, f, y, n, 1, 0, on, off.

Defined in Data.Tini.IniValue

Methods

showValue :: Bool -> String

readValue :: String -> Maybe Bool

IniValue Char

Defined in Data.Tini.IniValue

Methods

showValue :: Char -> String

readValue :: String -> Maybe Char

IniValue Double

Defined in Data.Tini.IniValue

Methods

showValue :: Double -> String

readValue :: String -> Maybe Double

IniValue Float

Defined in Data.Tini.IniValue

Methods

showValue :: Float -> String

readValue :: String -> Maybe Float

IniValue Int

Defined in Data.Tini.IniValue

Methods

showValue :: Int -> String

readValue :: String -> Maybe Int

IniValue Int8

Defined in Data.Tini.IniValue

Methods

showValue :: Int8 -> String

readValue :: String -> Maybe Int8

IniValue Int16

Defined in Data.Tini.IniValue

Methods

showValue :: Int16 -> String

readValue :: String -> Maybe Int16

IniValue Int32

Defined in Data.Tini.IniValue

Methods

showValue :: Int32 -> String

readValue :: String -> Maybe Int32

IniValue Int64

Defined in Data.Tini.IniValue

Methods

showValue :: Int64 -> String

readValue :: String -> Maybe Int64

IniValue Integer

Defined in Data.Tini.IniValue

Methods

showValue :: Integer -> String

readValue :: String -> Maybe Integer

IniValue Word

Defined in Data.Tini.IniValue

Methods

showValue :: Word -> String

readValue :: String -> Maybe Word

IniValue Word8

Defined in Data.Tini.IniValue

Methods

showValue :: Word8 -> String

readValue :: String -> Maybe Word8

IniValue Word16

Defined in Data.Tini.IniValue

Methods

showValue :: Word16 -> String

readValue :: String -> Maybe Word16

IniValue Word32

Defined in Data.Tini.IniValue

Methods

showValue :: Word32 -> String

readValue :: String -> Maybe Word32

IniValue Word64

Defined in Data.Tini.IniValue

Methods

showValue :: Word64 -> String

readValue :: String -> Maybe Word64

IniValue String

Strings are the raw values of properties, with whitespace trimmed on both ends. They are not enclosed in quotes.

Defined in Data.Tini.IniValue

Methods

showValue :: String -> String

readValue :: String -> Maybe String

IniValue a => IniValue [a]

Lists are zero or more valid values, separated by commas. To include a comma in a string within a list, escape it using \,.

Defined in Data.Tini.IniValue

Methods

showValue :: [a] -> String

readValue :: String -> Maybe [a]

IniValue a => IniValue (Maybe a)

Nothing is encoded as the empty string, and any non-empty value of the correct type encodes Just val.

Defined in Data.Tini.IniValue

Methods

showValue :: Maybe a -> String

readValue :: String -> Maybe (Maybe a)

(IniValue a, IniValue b) => IniValue (Either a b)

readValue returns Left val If the value is readable at the type on the left, Right val if it's readable at the type on the right, and Nothing if it's not readable as either.

Defined in Data.Tini.IniValue

Methods

showValue :: Either a b -> String

readValue :: String -> Maybe (Either a b)

(IniValue a, IniValue b) => IniValue (a, b)

Tuples follow the same rules as lists, but must be of the correct length.

Defined in Data.Tini.IniValue

Methods

showValue :: (a, b) -> String

readValue :: String -> Maybe (a, b)

(IniValue a, IniValue b, IniValue c) => IniValue (a, b, c)

Defined in Data.Tini.IniValue

Methods

showValue :: (a, b, c) -> String

readValue :: String -> Maybe (a, b, c)