Hpp.Config

Preprocessor Configuration

Documentation

newtype TimeString

A String representing a time.

Constructors

TimeString

Fields

• getTimeString :: String

Instances

Eq TimeString

Defined in Hpp.Config

Methods

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

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

Ord TimeString

Defined in Hpp.Config

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

Defined in Hpp.Config

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

Defined in Hpp.Config

Methods

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

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

Ord DateString

Defined in Hpp.Config

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

Defined in Hpp.Config

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

  Name of the file being preprocessed. Hpp will update this as new files are included. The user must set it manually for the starting input file.

• includePathsF :: f [FilePath]

  Paths to be searched for included files.

• spliceLongLinesF :: f Bool

  A backslash as the last character of a line causes the next line to be appended to the current one eliding the newline character present in the source input.

• eraseCCommentsF :: f Bool

  Erase line comments (starting with //) and block comments (delimited by /* and */).

• inhibitLinemarkersF :: f Bool

  Do not emit #line directives.

• replaceTrigraphsF :: f Bool

  Replace trigraph sequences (each of which starts with two consecutive question marks ("??") with the characters they encode.

• prepDateF :: f DateString

  Format string for __DATE__.

• prepTimeF :: f TimeString

  Format string for __TIME__.

Instances

Show (ConfigF Identity)

Defined in Hpp.Config

Methods

showsPrec :: Int -> ConfigF Identity -> ShowS

show :: ConfigF Identity -> String

showList :: [ConfigF Identity] -> ShowS

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. Note that long line splicing is enabled, C++-style comments are erased, #line markers are inhibited, and trigraph replacement is disabled.

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.

Lens-like accessors for Config

spliceLongLinesL :: Functor f => (Bool -> f Bool) -> Config -> f Config

Lens for the "splice long lines" option (prepend a line ending with a backslash to the next line).

eraseCCommentsL :: Functor f => (Bool -> f Bool) -> Config -> f Config

Lens for the "erase C-style comments" option (comments delimited by /* and */).

inhibitLinemarkersL :: Functor f => (Bool -> f Bool) -> Config -> f Config

Lens for the "inhibit line markers" option. Option to disable the emission of #line pragmas in the output.

replaceTrigraphsL :: Functor f => (Bool -> f Bool) -> Config -> f Config

Lens for the "replace trigraphs" option.