Safe Haskell	None
Language	Haskell98

Data.Aeson.Schema.CodeGenM

Contents

Customising the codegen

Synopsis

data Declaration
- = Declaration Dec (Maybe Text)
- | Comment Text
type Code = [Declaration]
newtype CodeGenM s a = CodeGenM {
- unCodeGenM :: RWST (Options, s) Code StringSet Q a
}
renderDeclaration :: Declaration -> Text
codeGenNewName :: String -> StringSet -> (Name, StringSet)
genRecord :: Name -> [(Name, TypeQ, Maybe Text)] -> [Name] -> Q Declaration
data Options = Options {
- _extraModules :: [String]
- _derivingTypeclasses :: [Name]
- _replaceModules :: Map String String
- _languageExtensions :: [Text]
- _ghcOptsPragmas :: [Text]
- _extraInstances :: Name -> [DecQ]
}
defaultOptions :: Options
askOpts :: CodeGenM s Options
askEnv :: CodeGenM s s

Documentation

data Declaration Source #

A top-level declaration.

Constructors

Declaration Dec (Maybe Text)	Optional textual declaration. This can be used for information (e.g. inline comments) that are not representable in TH.
Comment Text	Comment text

Instances

Eq Declaration Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods (==) :: Declaration -> Declaration -> Bool # (/=) :: Declaration -> Declaration -> Bool #
Data Declaration Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Declaration -> c Declaration # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Declaration # toConstr :: Declaration -> Constr # dataTypeOf :: Declaration -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Declaration) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Declaration) # gmapT :: (forall b. Data b => b -> b) -> Declaration -> Declaration # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Declaration -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Declaration -> r # gmapQ :: (forall d. Data d => d -> u) -> Declaration -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Declaration -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Declaration -> m Declaration # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Declaration -> m Declaration # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Declaration -> m Declaration #
Show Declaration Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
MonadWriter Code (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods writer :: (a, Code) -> CodeGenM s a # tell :: Code -> CodeGenM s () # listen :: CodeGenM s a -> CodeGenM s (a, Code) # pass :: CodeGenM s (a, Code -> Code) -> CodeGenM s a #

type Code = [Declaration] Source #

Haskell code (without module declaration and imports)

newtype CodeGenM s a Source #

Constructors

CodeGenM
Fields unCodeGenM :: RWST (Options, s) Code StringSet Q a

Instances

MonadWriter Code (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods writer :: (a, Code) -> CodeGenM s a # tell :: Code -> CodeGenM s () # listen :: CodeGenM s a -> CodeGenM s (a, Code) # pass :: CodeGenM s (a, Code -> Code) -> CodeGenM s a #
Monad (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods (>>=) :: CodeGenM s a -> (a -> CodeGenM s b) -> CodeGenM s b # (>>) :: CodeGenM s a -> CodeGenM s b -> CodeGenM s b # return :: a -> CodeGenM s a # fail :: String -> CodeGenM s a #
Functor (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods fmap :: (a -> b) -> CodeGenM s a -> CodeGenM s b # (<$) :: a -> CodeGenM s b -> CodeGenM s a #
MonadFail (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods fail :: String -> CodeGenM s a #
Applicative (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods pure :: a -> CodeGenM s a # (<>) :: CodeGenM s (a -> b) -> CodeGenM s a -> CodeGenM s b # liftA2 :: (a -> b -> c) -> CodeGenM s a -> CodeGenM s b -> CodeGenM s c # (>) :: CodeGenM s a -> CodeGenM s b -> CodeGenM s b # (<*) :: CodeGenM s a -> CodeGenM s b -> CodeGenM s a #
MonadIO (CodeGenM s) Source #	Generates a record data declaration where the fields may have descriptions for Haddock
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods liftIO :: IO a -> CodeGenM s a #
Quasi (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods qNewName :: String -> CodeGenM s Name # qReport :: Bool -> String -> CodeGenM s () # qRecover :: CodeGenM s a -> CodeGenM s a -> CodeGenM s a # qLookupName :: Bool -> String -> CodeGenM s (Maybe Name) # qReify :: Name -> CodeGenM s Info # qReifyFixity :: Name -> CodeGenM s (Maybe Fixity) # qReifyInstances :: Name -> [Type] -> CodeGenM s [Dec] # qReifyRoles :: Name -> CodeGenM s [Role] # qReifyAnnotations :: Data a => AnnLookup -> CodeGenM s [a] # qReifyModule :: Module -> CodeGenM s ModuleInfo # qReifyConStrictness :: Name -> CodeGenM s [DecidedStrictness] # qLocation :: CodeGenM s Loc # qRunIO :: IO a -> CodeGenM s a # qAddDependentFile :: FilePath -> CodeGenM s () # qAddTopDecls :: [Dec] -> CodeGenM s () # qAddForeignFile :: ForeignSrcLang -> String -> CodeGenM s () # qAddModFinalizer :: Q () -> CodeGenM s () # qAddCorePlugin :: String -> CodeGenM s () # qGetQ :: Typeable a => CodeGenM s (Maybe a) # qPutQ :: Typeable a => a -> CodeGenM s () # qIsExtEnabled :: Extension -> CodeGenM s Bool # qExtsEnabled :: CodeGenM s [Extension] #
MonadReader (Options, s) (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods ask :: CodeGenM s (Options, s) # local :: ((Options, s) -> (Options, s)) -> CodeGenM s a -> CodeGenM s a # reader :: ((Options, s) -> a) -> CodeGenM s a #

renderDeclaration :: Declaration -> Text Source #

Render a declaration. When a declaration contains both a TH syntax tree and a text representation, the text representation is preferred.

codeGenNewName :: String -> StringSet -> (Name, StringSet) Source #

Generates a fresh name

genRecord Source #

Arguments

:: Name	Type and constructor name
-> [(Name, TypeQ, Maybe Text)]	Fields
-> [Name]	Deriving typeclasses
-> Q Declaration

Customising the codegen

data Options Source #

Extra options used for the codegen

Constructors

Options

Fields

_extraModules :: [String]
Needed modules that are not found by getUsedModules.
_derivingTypeclasses :: [Name]
Classes to put in the deriving clause
_replaceModules :: Map String String
A Map of modules which we should replace with other ones when references to them are found. Useful for example when the codegen is hitting a hidden module that's not already gotten rid of in replaceHiddenModules.
_languageExtensions :: [Text]
List of LANGUAGE extensions to enable in the module. Note that these aren't checked for validity.
```
_languageExtensions = [ LambdaCase ]
```
_ghcOptsPragmas :: [Text]
List of OPTIONS_GHC to turn on in the module. Note that these aren't checked for validity.
```
_ghcOptsPragmas = [ "-fno-warn-name-shadowing" ]
```
_extraInstances :: Name -> [DecQ]
Supplied a Name of the type in question (after mangling), potentially generate an instance for the type. For example, to generate an empty Enum instance for every data type we make, the user can supply something like
```
_extraInstances = n -> return $
  instanceD (cxt []) (conT ''Enum appT conT n) []
```
and to generate no instances, simply use const [].

Instances

MonadReader (Options, s) (CodeGenM s) Source #
Instance details Defined in Data.Aeson.Schema.CodeGenM Methods ask :: CodeGenM s (Options, s) # local :: ((Options, s) -> (Options, s)) -> CodeGenM s a -> CodeGenM s a # reader :: ((Options, s) -> a) -> CodeGenM s a #

defaultOptions :: Options Source #

askOpts :: CodeGenM s Options Source #

askEnv :: CodeGenM s s Source #