Network.ONCRPC.XDR.Generate

Generate Haskell code from XDR descriptions as per RFC4506 and RPC extensions from RFC5531

Documentation

generateFromFile :: GenerateOptions -> FilePath -> IO String

generate from a file.

generate :: Monad m => GenerateOptions -> String -> ByteString -> m String

Parse an XDR specification and generate pretty-printed Haskell source string, or fail on error. The String argument provides a description of the input to use in parse errors.

generateModule :: Monad m => GenerateOptions -> String -> ByteString -> m (Module ())

Parse an XDR specification and generate a Haskell module, or fail on error. The String argument provides a description of the input to use in parse errors.

data ReidentOptions

How to generate Haskell identifiers from XDR in order to confirm to Haskell's lexical rules and ensure uniqueness.

Constructors

ReidentOptions

Fields

• reidentUpperPrefix, reidentLowerPrefix :: String

  Prefix to use to make an identifier a different case if necessary, e.g. "_" for lower-case, or "XDR_" for upper case (default empty: just changes the first character, possibly resulting in names like "nFS_NULL")

• reidentJoinField, reidentJoinProcedure :: Maybe String

  Prefix fields with their type name (or program, version name) and this string (necessary for most XDR files), or Nothing to use only the field name (or procedure name), which assumes uniqueness across the file (e.g., if you wrote the file yourself, though often safe for procedures only) (default Just "'")

Instances

Eq ReidentOptions

Methods

(==) :: ReidentOptions -> ReidentOptions -> Bool

(/=) :: ReidentOptions -> ReidentOptions -> Bool

Show ReidentOptions

Methods

showsPrec :: Int -> ReidentOptions -> ShowS

show :: ReidentOptions -> String

showList :: [ReidentOptions] -> ShowS

data GenerateOptions

Options for generating Haskell code

Constructors

GenerateOptions

Fields

• generateModuleName :: String

  Name for the generated module

• generateReidentOptions :: ReidentOptions

Instances

Eq GenerateOptions

Methods

(==) :: GenerateOptions -> GenerateOptions -> Bool

(/=) :: GenerateOptions -> GenerateOptions -> Bool

Show GenerateOptions

Methods

showsPrec :: Int -> GenerateOptions -> ShowS

show :: GenerateOptions -> String

showList :: [GenerateOptions] -> ShowS

defaultReidentOptions :: ReidentOptions