Clang.CompilationDatabase

Clang Compilation Database Format parser

The Clang Compilation Database Format is a JSON file format for recording compiler invocations in build systems.

Documentation

type CompilationDatabase = [CommandObject]

A Compilation database consists of a sequence of CommandObject values each of which is a set of commands that acted upon a single source file.

data CommandObject

Each command object contains the translation unit’s main file, the working directory of the compile run and the actual compile command.

Constructors

CommandObject

Fields

• directory :: Text

  The working directory during compilation

• file :: Text

  The main translation unit processed by this compilation step. There may be multiple CommandObject values in a CompilationDatabase for the same file if it was the main file for multiple compilation steps.

• command :: Maybe Text

  The command that was executed. Double quotes and backslashes are escaped by a backslash.

• arguments :: Maybe [Text]

  The compile command executed as a list of strings. Either command or arguments is required. TODO model this more faithfully.

• output :: Maybe Text

  Optional name of the output file created by this compilation step.

Instances

Show CommandObject

Methods

showsPrec :: Int -> CommandObject -> ShowS

show :: CommandObject -> String

showList :: [CommandObject] -> ShowS

Generic CommandObject

Associated Types

type Rep CommandObject :: * -> *

Methods

from :: CommandObject -> Rep CommandObject x

to :: Rep CommandObject x -> CommandObject

ToJSON CommandObject

Methods

toJSON :: CommandObject -> Value

toEncoding :: CommandObject -> Encoding

toJSONList :: [CommandObject] -> Value

toEncodingList :: [CommandObject] -> Encoding

FromJSON CommandObject

Methods

parseJSON :: Value -> Parser CommandObject

parseJSONList :: Value -> Parser [CommandObject]

type Rep CommandObject

type Rep CommandObject = D1 * (MetaData "CommandObject" "Clang.CompilationDatabase" "clang-compilation-database-0.1.0.1-6MpJPm849WTD9gjnLmxhTJ" False) (C1 * (MetaCons "CommandObject" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "directory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "file") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "command") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "arguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "output") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Text)))))))