Ganeti.THH

Contents

• Exported types
• Common field declarations
• Internal types
• Helper functions
• Template code for simple raw type-equivalent ADTs
• Template code for opcodes
• Python code generation
• Template code for luxi
• Objects functionality
• Inheritable parameter tables implementation
• Template code for exceptions

Description

Synopsis

• class DictObject a where
  • toDict :: a -> [(String, JSValue)]
• data OptionalType
  • = NotOptional
  • | OptionalOmitNull
  • | OptionalSerializeNull
  • | AndRestArguments
• data Field = Field {
  • fieldName :: String
  • fieldType :: Q Type
  • fieldRead :: Maybe (Q Exp)
  • fieldShow :: Maybe (Q Exp)
  • fieldExtraKeys :: [String]
  • fieldDefault :: Maybe (Q Exp)
  • 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
• optionalField :: Field -> Field
• optionalNullSerField :: Field -> Field
• numericalReadFn :: JSON a => (String -> Result a) -> [(String, JSValue)] -> JSValue -> Result a
• makeReadOptional :: ([(String, JSValue)] -> JSValue -> Result a) -> [(String, JSValue)] -> Maybe JSValue -> Result (Maybe a)
• specialNumericalField :: Name -> Field -> Field
• customField :: Name -> Name -> [String] -> Field -> Field
• fieldRecordName :: Field -> String
• fieldVariable :: Field -> String
• actualFieldType :: Field -> Q Type
• checkNonOptDef :: Monad m => Field -> m ()
• loadFn :: Field -> Q Exp -> Q Exp -> Q Exp
• timeStampFields :: [Field]
• serialFields :: [Field]
• uuidFields :: [Field]
• type TagSet = Set String
• tagsFields :: [Field]
• 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
• 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 {
  • ocfName :: String
  • ocfType :: PyType
  • ocfDefl :: Maybe PyValueEx
  • ocfDoc :: String
  }
• data OpCodeDescriptor = OpCodeDescriptor {
  • ocdName :: String
  • ocdType :: PyType
  • ocdDoc :: String
  • ocdFields :: [OpCodeField]
  • ocdDescr :: String
  }
• 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 :: (a, b, c, d, e) -> (a, d)
• genOpCode :: String -> [OpCodeConstructor] -> Q [Dec]
• genOpConsFields :: OpCodeConstructor -> Clause
• genAllOpFields :: String -> [OpCodeConstructor] -> (Dec, Dec)
• saveConstructor :: LuxiConstructor -> Q Clause
• genSaveOpCode :: Name -> String -> String -> [LuxiConstructor] -> (LuxiConstructor -> Q Clause) -> Bool -> Q [Dec]
• loadConstructor :: OpCodeConstructor -> Q Exp
• genLoadOpCode :: [OpCodeConstructor] -> Q (Dec, Dec)
• 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]
• toDictName :: String -> Name
• genSaveObject :: (Name -> Field -> Q Exp) -> String -> [Field] -> Q [Dec]
• saveObjectField :: Name -> Field -> Q Exp
• objectShowJSON :: String -> Q Dec
• genLoadObject :: (Field -> Q (Name, Stmt)) -> String -> [Field] -> Q (Dec, Dec)
• loadObjectField :: [Field] -> Field -> Q (Name, Stmt)
• 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]
• buildDictObjectInst :: Name -> String -> [Dec]
• buildPParamSerialisation :: String -> [Field] -> Q [Dec]
• savePParamField :: Name -> Field -> Q Exp
• loadPParamField :: Field -> Q (Name, Stmt)
• 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

Common field declarations

Internal types

Helper functions

Template code for simple raw type-equivalent ADTs

Template code for opcodes

 vstr :: String
 vstr = [...]

Python code generation

Template code for luxi

Objects functionality

Inheritable parameter tables implementation

Template code for exceptions