Hpp.Config

Preprocessor Configuration

Documentation

newtype TimeString

A String representing a time.

Constructors

TimeString

Fields

• getTimeString :: String

Instances

Eq TimeString

Methods

(==) :: TimeString -> TimeString -> Bool

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

Ord TimeString

Methods

compare :: TimeString -> TimeString -> Ordering

(<) :: TimeString -> TimeString -> Bool

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

(>) :: TimeString -> TimeString -> Bool

(>=) :: TimeString -> TimeString -> Bool

max :: TimeString -> TimeString -> TimeString

min :: TimeString -> TimeString -> TimeString

Show TimeString

Methods

showsPrec :: Int -> TimeString -> ShowS

show :: TimeString -> String

showList :: [TimeString] -> ShowS

newtype DateString

A String representing a date.

Constructors

DateString

Fields

• getDateString :: String

Instances

Eq DateString

Methods

(==) :: DateString -> DateString -> Bool

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

Ord DateString

Methods

compare :: DateString -> DateString -> Ordering

(<) :: DateString -> DateString -> Bool

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

(>) :: DateString -> DateString -> Bool

(>=) :: DateString -> DateString -> Bool

max :: DateString -> DateString -> DateString

min :: DateString -> DateString -> DateString

Show DateString

Methods

showsPrec :: Int -> DateString -> ShowS

show :: DateString -> String

showList :: [DateString] -> ShowS

data ConfigF f

Pre-processor configuration parameterized over a functor. This is used to normalize partial configurations, ConfigF Maybe, and configurations suitable for the pre-processor logic, ConfigF Identity. Specifically, the source file name of the file being processed must be set.

Constructors

Config

Fields

• curFileNameF :: f FilePath
• includePathsF :: f [FilePath]
• spliceLongLinesF :: f Bool
• eraseCCommentsF :: f Bool
• inhibitLinemarkersF :: f Bool
• replaceTrigraphsF :: f Bool
• prepDateF :: f DateString
• prepTimeF :: f TimeString

type Config = ConfigF Identity

A fully-populated configuration for the pre-processor.

realizeConfig :: ConfigF Maybe -> Maybe Config

Ensure that required configuration fields are supplied.

curFileName :: Config -> FilePath

Extract the current file name from a configuration.

includePaths :: Config -> [FilePath]

Extract the include paths name from a configuration.

spliceLongLines :: Config -> Bool

Determine if continued long lines should be spliced.

eraseCComments :: Config -> Bool

Determine if C-style comments should be erased.

inhibitLinemarkers :: Config -> Bool

Determine if generation of linemarkers should be inhibited.

replaceTrigraphs :: Config -> Bool

Determine if trigraph sequences should be replaced.

prepDate :: Config -> DateString

The date the pre-processor was run on.

prepTime :: Config -> TimeString

The time of the active pre-processor invocation.

defaultConfigF :: ConfigF Maybe

A default configuration with no current file name set.

formatPrepDate :: UTCTime -> DateString

Format a date according to the C spec.

formatPrepTime :: UTCTime -> TimeString

Format a time according to the C spec.

defaultConfigFNow :: IO (ConfigF Maybe)

A default preprocessor configuration with date and time stamps taken from the current system time.