Initial commit

bundled/Network/ONCRPC/XDR/Specification.hs

@@ -0,0 +1,111 @@
+-- |XDR specification, as per RFC4506 and RPC extensions from RFC5531
+
+module Network.ONCRPC.XDR.Specification
+  where
+
+import qualified Network.ONCRPC.XDR.Types as XDR
+import           Data.Word (Word32)
+
+type ProgNum = Word32
+type VersNum = Word32
+type ProcNum = Word32
+
+data ArrayLength
+  = FixedLength    { arrayLength :: !XDR.Length }
+  | VariableLength { arrayLength :: !XDR.Length -- ^defaulted to maxLength
+    }
+
+data TypeDescriptor
+  = TypeSingle
+    { descriptorType :: !TypeSpecifier
+    }
+  | TypeArray 
+    { descriptorType :: !TypeSpecifier
+    , descriptorLength :: !ArrayLength
+    }
+  | TypeOpaque
+    { descriptorLength :: !ArrayLength
+    }
+  | TypeString
+    { descriptorLength :: !ArrayLength -- ^only 'VariableArray'
+    }
+  | TypeOptional
+    { descriptorType :: !TypeSpecifier
+    }
+
+data TypeSpecifier
+  = TypeInt
+  | TypeUnsignedInt
+  | TypeHyper
+  | TypeUnsignedHyper
+  | TypeFloat
+  | TypeDouble
+  | TypeQuadruple
+  | TypeBool
+  | TypeEnum !EnumBody
+  | TypeStruct !StructBody
+  | TypeUnion !UnionBody
+  | TypeIdentifier !String
+
+-- |Non-void declaration
+data Declaration = Declaration
+  { declarationIdentifier :: !String
+  , declarationType :: TypeDescriptor
+  }
+
+-- |'Declaration' or void
+type OptionalDeclaration = Maybe Declaration
+
+type EnumValues = [(String, XDR.Int)]
+
+newtype EnumBody = EnumBody
+  { enumValues :: EnumValues
+  }
+
+boolValues :: EnumValues
+boolValues = [("FALSE", 0), ("TRUE", 1)]
+
+newtype StructBody = StructBody
+  { structMembers :: [Declaration] -- ^with voids elided
+  }
+
+data UnionArm = UnionArm
+  { unionCaseIdentifier :: String -- ^The literal string found after "case", for labeling
+  , unionDeclaration :: OptionalDeclaration
+  }
+
+data UnionBody = UnionBody
+  { unionDiscriminant :: !Declaration
+  , unionCases :: [(XDR.Int, UnionArm)]
+  , unionDefault :: Maybe UnionArm
+  }
+
+data Procedure = Procedure
+  { procedureRes :: Maybe TypeSpecifier
+  , procedureIdentifier :: !String
+  , procedureArgs :: [TypeSpecifier]
+  , procedureNumber :: !ProcNum
+  }
+
+data Version = Version
+  { versionIdentifier :: !String
+  , versionTypeIdentifier :: !String
+  , versionProcedures :: [Procedure]
+  , versionNumber :: !VersNum
+  }
+
+data DefinitionBody
+  = TypeDef TypeDescriptor
+  | Constant Integer
+  | Program
+    { programTypeIdentifier :: !String
+    , programVersions :: [Version]
+    , programNumber :: !ProgNum
+    }
+
+data Definition = Definition
+  { definitionIdentifier :: !String
+  , definitionBody :: !DefinitionBody
+  }
+
+type Specification = [Definition]