ConfigFile-1.1.4: Configuration file reading & writing

CopyrightCopyright (C) 2004-2008 John Goerzen
LicenseEither LGPL or BSD3, as specified in the COPYRIGHT file.
MaintainerJohn Goerzen <jgoerzen@complete.org>
Stabilityprovisional
Portabilityportable
Safe HaskellSafe
LanguageHaskell98

Data.ConfigFile.Types

Description

Internal types for Data.ConfigFile. This module is not intended to be used directly by your programs.

Copyright (c) 2004-2008 John Goerzen, jgoerzen@complete.org

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Synopsis

Documentation

type CPOptions = Map OptionSpec String Source #

Storage of options.

type CPData = Map SectionSpec CPOptions Source #

The main data storage type (storage of sections).

PLEASE NOTE: This type is exported only for use by other modules under Data.ConfigFile. You should NEVER access the FiniteMap in a ConfigParser directly. This type may change in future releases of MissingH, which could break your programs. Please retrict yourself to the interface in ConfigFile.

data CPErrorData Source #

Possible ConfigParser errors.

Constructors

ParseError String

Parse error

SectionAlreadyExists SectionSpec

Attempt to create an already-existing ection

NoSection SectionSpec

The section does not exist

NoOption OptionSpec

The option does not exist

OtherProblem String

Miscellaneous error

InterpolationError String

Raised by interpolatingAccess if a request was made for a non-existant option

type CPError = (CPErrorData, String) Source #

Indicates an error occurred. The String is an explanation of the location of the error.

data ConfigParser Source #

This is the main record that is used by ConfigFile.

Constructors

ConfigParser 

Fields

type SectionSpec = String Source #

Names of sections

type OptionSpec = String Source #

Names of options

type ParseOutput = [(String, [(String, String)])] Source #

Internal output from parser