Copyright	(c) Copyright Pedro Tacla Yamada 2016
License	MIT
Maintainer	tacla.yamada@gmail.com
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Data.HCL

Contents

Entry-points
Types
Pretty-printer
Support functions

Description

This modules contains the hcl Megaparsec parser for hcl files.

The pretty-printer is at Data.HCL.PrettyPrint.

Synopsis

Entry-points

parseHCL :: String -> Text -> Either (ParseError Char Dec) HCLDoc Source #

Shortcut for runParser hcl

hcl :: Parser HCLDoc Source #

Parser for the HCL format

let h = runParser hcl fileName fileContents

See Text.Megaparsec

runParser #

Arguments

:: Parsec e s a	Parser to run
-> String	Name of source file
-> s	Input for parser
-> Either (ParseError (Token s) e) a

runParser p file input runs parser p on the input list of tokens input, obtained from source file. The file is only used in error messages and may be the empty string. Returns either a ParseError (Left) or a value of type a (Right).

parseFromFile p file = runParser p file <$> readFile file

pPrintHCL :: HCLDoc -> Doc Source #

Pretty-prints a HCLDoc to a Doc

pPrint restricted to HCLDoc.

print (pPrintConf c)

See Text.PrettyPrint

Types

type HCLDoc = [HCLStatement] Source #

The HCL document is just a list of statements

data HCLStatement Source #

Statements may be "objects", of form:

provider "aws" {
# more
}

Or they may be assignments:

a = "b"

Constructors

HCLStatementObject HCLValue
HCLStatementAssignment ([Text], HCLValue)

Instances

Eq HCLStatement Source #
Methods (==) :: HCLStatement -> HCLStatement -> Bool # (/=) :: HCLStatement -> HCLStatement -> Bool #
Show HCLStatement Source #
Methods showsPrec :: Int -> HCLStatement -> ShowS # show :: HCLStatement -> String # showList :: [HCLStatement] -> ShowS #
Generic HCLStatement Source #
Associated Types type Rep HCLStatement :: * -> * # Methods from :: HCLStatement -> Rep HCLStatement x # to :: Rep HCLStatement x -> HCLStatement #
NFData HCLStatement Source #
Methods rnf :: HCLStatement -> () #
type Rep HCLStatement Source #
type Rep HCLStatement = D1 (MetaData "HCLStatement" "Data.HCL.Types" "language-hcl-0.1.1.0-8iP1nmLKngw5KCy0GPbipL" False) ((:+:) (C1 (MetaCons "HCLStatementObject" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HCLValue))) (C1 (MetaCons "HCLStatementAssignment" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ([Text], HCLValue)))))

data HCLValue Source #

Constructors

HCLNumber Scientific
HCLString [HCLStringPart]
HCLIdent Text
HCLObject [Text] (HashMap [Text] HCLValue)
HCLList [HCLValue]

Instances

Eq HCLValue Source #
Methods (==) :: HCLValue -> HCLValue -> Bool # (/=) :: HCLValue -> HCLValue -> Bool #
Show HCLValue Source #
Methods showsPrec :: Int -> HCLValue -> ShowS # show :: HCLValue -> String # showList :: [HCLValue] -> ShowS #
Generic HCLValue Source #
Associated Types type Rep HCLValue :: * -> * # Methods from :: HCLValue -> Rep HCLValue x # to :: Rep HCLValue x -> HCLValue #
NFData HCLValue Source #
Methods rnf :: HCLValue -> () #
type Rep HCLValue Source #
type Rep HCLValue = D1 (MetaData "HCLValue" "Data.HCL.Types" "language-hcl-0.1.1.0-8iP1nmLKngw5KCy0GPbipL" False) ((:+:) ((:+:) (C1 (MetaCons "HCLNumber" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Scientific))) (C1 (MetaCons "HCLString" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [HCLStringPart])))) ((:+:) (C1 (MetaCons "HCLIdent" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) ((:+:) (C1 (MetaCons "HCLObject" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap [Text] HCLValue))))) (C1 (MetaCons "HCLList" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [HCLValue]))))))

type HCLList = [HCLValue] Source #

data HCLStringPart Source #

Constructors

HCLStringPlain Text
HCLStringInterp Text

Instances

Eq HCLStringPart Source #
Methods (==) :: HCLStringPart -> HCLStringPart -> Bool # (/=) :: HCLStringPart -> HCLStringPart -> Bool #
Show HCLStringPart Source #
Methods showsPrec :: Int -> HCLStringPart -> ShowS # show :: HCLStringPart -> String # showList :: [HCLStringPart] -> ShowS #
Generic HCLStringPart Source #
Associated Types type Rep HCLStringPart :: * -> * # Methods from :: HCLStringPart -> Rep HCLStringPart x # to :: Rep HCLStringPart x -> HCLStringPart #
NFData HCLStringPart Source #
Methods rnf :: HCLStringPart -> () #
type Rep HCLStringPart Source #
type Rep HCLStringPart = D1 (MetaData "HCLStringPart" "Data.HCL.Types" "language-hcl-0.1.1.0-8iP1nmLKngw5KCy0GPbipL" False) ((:+:) (C1 (MetaCons "HCLStringPlain" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) (C1 (MetaCons "HCLStringInterp" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

Pretty-printer

class Pretty a where #

Pretty printing class. The precedence level is used in a similar way as in the Show class. Minimal complete definition is either pPrintPrec or pPrint.

Minimal complete definition

pPrintPrec | pPrint

Methods

pPrintPrec :: PrettyLevel -> Rational -> a -> Doc #

pPrint :: a -> Doc #

pPrintList :: PrettyLevel -> [a] -> Doc #

Instances

Pretty Bool
Methods pPrintPrec :: PrettyLevel -> Rational -> Bool -> Doc # pPrint :: Bool -> Doc # pPrintList :: PrettyLevel -> [Bool] -> Doc #
Pretty Char
Methods pPrintPrec :: PrettyLevel -> Rational -> Char -> Doc # pPrint :: Char -> Doc # pPrintList :: PrettyLevel -> [Char] -> Doc #
Pretty Double
Methods pPrintPrec :: PrettyLevel -> Rational -> Double -> Doc # pPrint :: Double -> Doc # pPrintList :: PrettyLevel -> [Double] -> Doc #
Pretty Float
Methods pPrintPrec :: PrettyLevel -> Rational -> Float -> Doc # pPrint :: Float -> Doc # pPrintList :: PrettyLevel -> [Float] -> Doc #
Pretty Int
Methods pPrintPrec :: PrettyLevel -> Rational -> Int -> Doc # pPrint :: Int -> Doc # pPrintList :: PrettyLevel -> [Int] -> Doc #
Pretty Integer
Methods pPrintPrec :: PrettyLevel -> Rational -> Integer -> Doc # pPrint :: Integer -> Doc # pPrintList :: PrettyLevel -> [Integer] -> Doc #
Pretty Ordering
Methods pPrintPrec :: PrettyLevel -> Rational -> Ordering -> Doc # pPrint :: Ordering -> Doc # pPrintList :: PrettyLevel -> [Ordering] -> Doc #
Pretty ()
Methods pPrintPrec :: PrettyLevel -> Rational -> () -> Doc # pPrint :: () -> Doc # pPrintList :: PrettyLevel -> [()] -> Doc #
Pretty a => Pretty [a]
Methods pPrintPrec :: PrettyLevel -> Rational -> [a] -> Doc # pPrint :: [a] -> Doc # pPrintList :: PrettyLevel -> [[a]] -> Doc #
Pretty a => Pretty (Maybe a)
Methods pPrintPrec :: PrettyLevel -> Rational -> Maybe a -> Doc # pPrint :: Maybe a -> Doc # pPrintList :: PrettyLevel -> [Maybe a] -> Doc #
(Pretty a, Pretty b) => Pretty (Either a b)
Methods pPrintPrec :: PrettyLevel -> Rational -> Either a b -> Doc # pPrint :: Either a b -> Doc # pPrintList :: PrettyLevel -> [Either a b] -> Doc #
(Pretty a, Pretty b) => Pretty (a, b)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b) -> Doc # pPrint :: (a, b) -> Doc # pPrintList :: PrettyLevel -> [(a, b)] -> Doc #
(Pretty a, Pretty b, Pretty c) => Pretty (a, b, c)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c) -> Doc # pPrint :: (a, b, c) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c)] -> Doc #
(Pretty a, Pretty b, Pretty c, Pretty d) => Pretty (a, b, c, d)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d) -> Doc # pPrint :: (a, b, c, d) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c, d)] -> Doc #
(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e) => Pretty (a, b, c, d, e)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e) -> Doc # pPrint :: (a, b, c, d, e) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c, d, e)] -> Doc #
(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f) => Pretty (a, b, c, d, e, f)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f) -> Doc # pPrint :: (a, b, c, d, e, f) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c, d, e, f)] -> Doc #
(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g) => Pretty (a, b, c, d, e, f, g)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g) -> Doc # pPrint :: (a, b, c, d, e, f, g) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g)] -> Doc #
(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g, Pretty h) => Pretty (a, b, c, d, e, f, g, h)
Methods pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g, h) -> Doc # pPrint :: (a, b, c, d, e, f, g, h) -> Doc # pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g, h)] -> Doc #