| Safe Haskell | None |
|---|
Ganeti.THH
Contents
Description
TemplateHaskell helper for Ganeti Haskell code.
As TemplateHaskell require that splices be defined in a separate module, we combine all the TemplateHaskell functionality that HTools needs in this module (except the one for unittests).
- data OptionalType
- data Field = Field {
- fieldName :: String
- fieldType :: Q Type
- fieldRead :: Maybe (Q Exp)
- fieldShow :: Maybe (Q Exp)
- fieldExtraKeys :: [String]
- fieldDefault :: Maybe (Q Exp)
- fieldSerializeDefault :: Bool
- fieldConstr :: Maybe String
- fieldIsOptional :: OptionalType
- fieldDoc :: String
- simpleField :: String -> Q Type -> Field
- andRestArguments :: String -> Field
- withDoc :: String -> Field -> Field
- renameField :: String -> Field -> Field
- defaultField :: Q Exp -> Field -> Field
- notSerializeDefaultField :: Q Exp -> Field -> Field
- optionalField :: Field -> Field
- optionalNullSerField :: Field -> Field
- customField :: Name -> Name -> [String] -> Field -> Field
- fieldRecordName :: Field -> String
- fieldVariable :: Field -> String
- actualFieldType :: Field -> Q Type
- checkNonOptDef :: Monad m => Field -> m ()
- parseFn :: Field -> Q Exp -> Q Exp
- loadFn :: Field -> Q Exp -> Q Exp -> Q Exp
- loadFnOpt :: Field -> Q Exp -> Q Exp -> Q Exp
- type SimpleField = (String, Q Type)
- type SimpleConstructor = (String, [SimpleField])
- type SimpleObject = [SimpleConstructor]
- type OpCodeConstructor = (String, Q Type, String, [Field], String)
- type LuxiConstructor = (String, [Field])
- ensureLower :: String -> String
- ensureUpper :: String -> String
- varNameE :: String -> Q Exp
- showJSONE :: Q Exp
- makeObjE :: Q Exp
- fromObjE :: Q Exp
- toRawName :: String -> Name
- fromRawName :: String -> Name
- reprE :: Either String Name -> Q Exp
- appFn :: Exp -> Exp -> Exp
- appCons :: Name -> [Exp] -> Exp
- appConsApp :: Name -> [Exp] -> Exp
- buildConsField :: Q Type -> StrictTypeQ
- buildSimpleCons :: Name -> SimpleObject -> Q Dec
- genSaveSimpleObj :: Name -> String -> SimpleObject -> (SimpleConstructor -> Q Clause) -> Q (Dec, Dec)
- strADTDecl :: Name -> [String] -> Dec
- genToRaw :: Name -> Name -> Name -> [(String, Either String Name)] -> Q [Dec]
- genFromRaw :: Name -> Name -> Name -> [(String, Either String Name)] -> Q [Dec]
- declareADT :: (a -> Either String Name) -> Name -> String -> [(String, a)] -> Q [Dec]
- declareLADT :: Name -> String -> [(String, String)] -> Q [Dec]
- declareILADT :: String -> [(String, Int)] -> Q [Dec]
- declareIADT :: String -> [(String, Name)] -> Q [Dec]
- declareSADT :: String -> [(String, Name)] -> Q [Dec]
- genShowJSON :: String -> Q Dec
- genReadJSON :: String -> Q Dec
- makeJSONInstance :: Name -> Q [Dec]
- deCamelCase :: String -> String
- camelCase :: String -> String
- constructorName :: Con -> Q Name
- reifyConsNames :: Name -> Q [String]
- genConstrToStr :: (String -> Q String) -> Name -> String -> Q [Dec]
- genOpID :: Name -> String -> Q [Dec]
- genOpLowerStrip :: String -> Name -> String -> Q [Dec]
- genAllConstr :: (String -> String) -> Name -> String -> Q [Dec]
- genAllOpIDs :: Name -> String -> Q [Dec]
- type OpParam = (String, Q Type, Q Exp)
- data OpCodeField = OpCodeField {}
- data OpCodeDescriptor = OpCodeDescriptor {}
- maybeApp :: Maybe (Q Exp) -> Q Type -> Q Exp
- genPyType' :: OptionalType -> Q Type -> Q PyType
- genPyType :: Field -> Q PyType
- genPyDefault :: Field -> Q Exp
- pyField :: Field -> Q Exp
- pyClass :: OpCodeConstructor -> Q Exp
- pyClasses :: [OpCodeConstructor] -> Q [Dec]
- opcodeConsToLuxiCons :: OpCodeConstructor -> LuxiConstructor
- genOpCodeDictObject :: Name -> (LuxiConstructor -> Q Clause) -> (LuxiConstructor -> Q Exp) -> [LuxiConstructor] -> Q [Dec]
- genOpCode :: String -> [OpCodeConstructor] -> Q [Dec]
- genOpConsFields :: OpCodeConstructor -> Clause
- genAllOpFields :: String -> [OpCodeConstructor] -> (Dec, Dec)
- saveConstructor :: LuxiConstructor -> Q Clause
- genSaveOpCode :: [LuxiConstructor] -> (LuxiConstructor -> Q Clause) -> Q [Clause]
- loadConstructor :: Name -> (Field -> Q Exp) -> [Field] -> Q Exp
- loadOpConstructor :: LuxiConstructor -> Q Exp
- genLoadOpCode :: [LuxiConstructor] -> (LuxiConstructor -> Q Exp) -> Q [Clause]
- genStrOfOp :: Name -> String -> Q [Dec]
- genStrOfKey :: Name -> String -> Q [Dec]
- genLuxiOp :: String -> [LuxiConstructor] -> Q [Dec]
- saveLuxiConstructor :: LuxiConstructor -> Q Clause
- fieldTypeInfo :: String -> Field -> Q (Name, Strict, Type)
- buildObject :: String -> String -> [Field] -> Q [Dec]
- buildObjectSerialisation :: String -> [Field] -> Q [Dec]
- objVarName :: Name
- defaultToJSArray :: DictObject a => [String] -> a -> [JSValue]
- defaultFromJSArray :: DictObject a => [String] -> [JSValue] -> Result a
- genArrayObjectInstance :: Name -> [Field] -> Q Dec
- genDictObject :: (Name -> Field -> Q Exp) -> (Field -> Q Exp) -> String -> [Field] -> Q [Dec]
- genSaveObject :: String -> Q [Dec]
- saveObjectField :: Name -> Field -> Q Exp
- objectShowJSON :: String -> Q Dec
- genLoadObject :: String -> Q (Dec, Dec)
- loadObjectField :: [Field] -> Field -> Q Exp
- fieldDictKeys :: Field -> Exp
- fieldsDictKeys :: [Field] -> Exp
- fieldsDictKeysQ :: [Field] -> Q Exp
- fieldsUsedKeysQ :: [Field] -> Q Exp
- objectReadJSON :: String -> Q Dec
- paramTypeNames :: String -> (String, String)
- paramFieldTypeInfo :: String -> Field -> Q (Name, Strict, Type)
- buildParam :: String -> String -> [Field] -> Q [Dec]
- buildParamAllFields :: String -> [Field] -> [Dec]
- buildPParamSerialisation :: String -> [Field] -> Q [Dec]
- savePParamField :: Name -> Field -> Q Exp
- loadPParamField :: Field -> Q Exp
- buildFromMaybe :: String -> Q Dec
- fillParam :: String -> String -> [Field] -> Q [Dec]
- excErrMsg :: (String, Q Type)
- genException :: String -> SimpleObject -> Q [Dec]
- saveExcCons :: String -> [SimpleField] -> Q Clause
- loadExcConstructor :: Name -> String -> [SimpleField] -> Q Exp
- genLoadExc :: Name -> String -> SimpleObject -> Q (Dec, Dec)
Exported types
data OptionalType Source
Instances
| Eq OptionalType | |
| Show OptionalType |
Serialised field data type describing how to generate code for the field.
Each field has a type, which isn't captured in the type of the data type,
but is saved in the Q monad in fieldType.
Let t be a type we want to parametrize the field with. There are the
following possible types of fields:
- Mandatory with no default.
- Then
fieldTypeholdst,fieldDefault = NothingandfieldIsOptional = NotOptional. - Field with a default value.
- Then
fieldTypeholdstandfieldDefault = Just expwhereexpis an expression of typetandfieldIsOptional = NotOptional. - Optional, no default value.
- Then
fieldTypeholdsMaybe t,fieldDefault = NothingandfieldIsOptionalis eitherOptionalOmitNullorOptionalSerializeNull.
Optional fields with a default value are prohibited, as their main intention is to represent the information that a request didn't contain the field data.
Custom (de)serialization:
Field can have custom (de)serialization functions that are stored in
fieldRead and fieldShow. If they aren't provided, the default is to use
readJSON and showJSON for the field's type t. If they are provided,
the type of the contained deserializing expression must be
[(String, JSON.JSValue)] -> JSON.JSValue -> JSON.Result t
where the first argument carries the whole record in the case the deserializing function needs to process additional information.
The type of the contained serializing experssion must be
t -> (JSON.JSValue, [(String, JSON.JSValue)])
where the result can provide extra JSON fields to include in the output
record (or just return [] if they're not needed).
Note that for optional fields the type appearing in the custom functions
is still t. Therefore making a field optional doesn't change the
functions.
There is also a special type of optional field AndRestArguments which
allows to parse any additional arguments not covered by other fields. There
can be at most one such special field and it's type must be
Map String JSON.JSValue. See also andRestArguments.
Constructors
| Field | |
Fields
| |
simpleField :: String -> Q Type -> FieldSource
Generates a simple field.
andRestArguments :: String -> FieldSource
Generate an AndRestArguments catch-all field.
renameField :: String -> Field -> FieldSource
Sets the renamed constructor field.
defaultField :: Q Exp -> Field -> FieldSource
Sets the default value on a field (makes it optional with a default value).
notSerializeDefaultField :: Q Exp -> Field -> FieldSource
A defaultField which will be serialized only if it's value differs from a default value.
optionalField :: Field -> FieldSource
Marks a field optional (turning its base type into a Maybe).
optionalNullSerField :: Field -> FieldSource
Marks a field optional (turning its base type into a Maybe), but
with Nothing serialised explicitly as null.
Arguments
| :: Name | The name of the read function |
| -> Name | The name of the show function |
| -> [String] | The name of extra field keys |
| -> Field | The original field |
| -> Field | Updated field |
Sets custom functions on a field.
fieldRecordName :: Field -> StringSource
fieldVariable :: Field -> StringSource
actualFieldType :: Field -> Q TypeSource
checkNonOptDef :: Monad m => Field -> m ()Source
Internal types
type SimpleField = (String, Q Type)Source
type SimpleConstructor = (String, [SimpleField])Source
type SimpleObject = [SimpleConstructor]Source
type OpCodeConstructor = (String, Q Type, String, [Field], String)Source
type LuxiConstructor = (String, [Field])Source
Helper functions
ensureLower :: String -> StringSource
ensureUpper :: String -> StringSource
fromRawName :: String -> NameSource
appConsApp :: Name -> [Exp] -> ExpSource
buildConsField :: Q Type -> StrictTypeQSource
buildSimpleCons :: Name -> SimpleObject -> Q DecSource
genSaveSimpleObj :: Name -> String -> SimpleObject -> (SimpleConstructor -> Q Clause) -> Q (Dec, Dec)Source
Template code for simple raw type-equivalent ADTs
strADTDecl :: Name -> [String] -> DecSource
genFromRaw :: Name -> Name -> Name -> [(String, Either String Name)] -> Q [Dec]Source
declareADT :: (a -> Either String Name) -> Name -> String -> [(String, a)] -> Q [Dec]Source
declareLADT :: Name -> String -> [(String, String)] -> Q [Dec]Source
declareILADT :: String -> [(String, Int)] -> Q [Dec]Source
declareIADT :: String -> [(String, Name)] -> Q [Dec]Source
declareSADT :: String -> [(String, Name)] -> Q [Dec]Source
genShowJSON :: String -> Q DecSource
genReadJSON :: String -> Q DecSource
makeJSONInstance :: Name -> Q [Dec]Source
Generates a JSON instance for a given type.
This assumes that the nameToRaw and nameFromRaw functions
have been defined as by the declareSADT function.
Template code for opcodes
deCamelCase :: String -> StringSource
Transforms a CamelCase string into an_underscore_based_one.
constructorName :: Con -> Q NameSource
reifyConsNames :: Name -> Q [String]Source
genConstrToStr :: (String -> Q String) -> Name -> String -> Q [Dec]Source
genOpLowerStrip :: String -> Name -> String -> Q [Dec]Source
Strips Op from the constructor name, converts to lower-case
and adds a given prefix.
genAllConstr :: (String -> String) -> Name -> String -> Q [Dec]Source
Builds a list with all defined constructor names for a type.
vstr :: String vstr = [...]
Where the actual values of the string are the constructor names
mapped via trans_fun.
genAllOpIDs :: Name -> String -> Q [Dec]Source
Generates a list of all defined opcode IDs.
Python code generation
data OpCodeField Source
data OpCodeDescriptor Source
Transfers opcode data between the opcode description (through
genOpCode) and the Python code generation functions.
Constructors
| OpCodeDescriptor | |
genPyType' :: OptionalType -> Q Type -> Q PyTypeSource
genPyDefault :: Field -> Q ExpSource
pyClass :: OpCodeConstructor -> Q ExpSource
pyClasses :: [OpCodeConstructor] -> Q [Dec]Source
genOpCodeDictObject :: Name -> (LuxiConstructor -> Q Clause) -> (LuxiConstructor -> Q Exp) -> [LuxiConstructor] -> Q [Dec]Source
Arguments
| :: String | Type name to use |
| -> [OpCodeConstructor] | Constructor name and parameters |
| -> Q [Dec] |
Generates the OpCode data type.
This takes an opcode logical definition, and builds both the datatype and the JSON serialisation out of it. We can't use a generic serialisation since we need to be compatible with Ganeti's own, so we have a few quirks to work around.
genOpConsFields :: OpCodeConstructor -> ClauseSource
genAllOpFields :: String -> [OpCodeConstructor] -> (Dec, Dec)Source
saveConstructor :: LuxiConstructor -> Q ClauseSource
genSaveOpCode :: [LuxiConstructor] -> (LuxiConstructor -> Q Clause) -> Q [Clause]Source
loadConstructor :: Name -> (Field -> Q Exp) -> [Field] -> Q ExpSource
loadOpConstructor :: LuxiConstructor -> Q ExpSource
genLoadOpCode :: [LuxiConstructor] -> (LuxiConstructor -> Q Exp) -> Q [Clause]Source
Template code for luxi
genStrOfOp :: Name -> String -> Q [Dec]Source
Constructor-to-string for LuxiOp.
genStrOfKey :: Name -> String -> Q [Dec]Source
Constructor-to-string for MsgKeys.
genLuxiOp :: String -> [LuxiConstructor] -> Q [Dec]Source
Generates the LuxiOp data type.
This takes a Luxi operation definition and builds both the datatype and the function transforming the arguments to JSON. We can't use anything less generic, because the way different operations are serialized differs on both parameter- and top-level.
There are two things to be defined for each parameter:
- name
- type
saveLuxiConstructor :: LuxiConstructor -> Q ClauseSource
Objects functionality
fieldTypeInfo :: String -> Field -> Q (Name, Strict, Type)Source
buildObject :: String -> String -> [Field] -> Q [Dec]Source
Build an object declaration.
buildObjectSerialisation :: String -> [Field] -> Q [Dec]Source
Generates an object definition: data type and its JSON instance.
objVarName :: NameSource
defaultToJSArray :: DictObject a => [String] -> a -> [JSValue]Source
defaultFromJSArray :: DictObject a => [String] -> [JSValue] -> Result aSource
genArrayObjectInstance :: Name -> [Field] -> Q DecSource
genDictObject :: (Name -> Field -> Q Exp) -> (Field -> Q Exp) -> String -> [Field] -> Q [Dec]Source
genSaveObject :: String -> Q [Dec]Source
saveObjectField :: Name -> Field -> Q ExpSource
objectShowJSON :: String -> Q DecSource
genLoadObject :: String -> Q (Dec, Dec)Source
loadObjectField :: [Field] -> Field -> Q ExpSource
fieldDictKeys :: Field -> ExpSource
fieldsDictKeys :: [Field] -> ExpSource
fieldsDictKeysQ :: [Field] -> Q ExpSource
fieldsUsedKeysQ :: [Field] -> Q ExpSource
objectReadJSON :: String -> Q DecSource
Inheritable parameter tables implementation
paramTypeNames :: String -> (String, String)Source
paramFieldTypeInfo :: String -> Field -> Q (Name, Strict, Type)Source
buildParam :: String -> String -> [Field] -> Q [Dec]Source
Build a parameter declaration.
This function builds two different data structures: a filled one, in which all fields are required, and a partial one, in which all fields are optional. Due to the current record syntax issues, the fields need to be named differrently for the two structures, so the partial ones get a P suffix.
buildParamAllFields :: String -> [Field] -> [Dec]Source
buildPParamSerialisation :: String -> [Field] -> Q [Dec]Source
savePParamField :: Name -> Field -> Q ExpSource
loadPParamField :: Field -> Q ExpSource
buildFromMaybe :: String -> Q DecSource
Template code for exceptions
Arguments
| :: String | Name of new type |
| -> SimpleObject | Constructor name and parameters |
| -> Q [Dec] |
Builds an exception type definition.
saveExcCons :: String -> [SimpleField] -> Q ClauseSource
loadExcConstructor :: Name -> String -> [SimpleField] -> Q ExpSource
genLoadExc :: Name -> String -> SimpleObject -> Q (Dec, Dec)Source