katt-0.2.0.3: Client for the Kattis judge system.

Safe Haskell	None

Utils.Katt.Utils

Description

Contains shared type declarations and various utility functions.

Synopsis

Documentation

type ConfigEnvInternal m = StateT ConfigState mSource

Configuration layer consisting of configuration state.

type ConfigEnv m = EitherT ErrorDesc (ConfigEnvInternal m)Source

Configuration layer wrapped with error handling.

type Submission = (KattisProblem, [FilePath])Source

Submissions consist of a problem identifier and a set of file paths.

type ErrorDesc = ByteString Source

Error description alias.

type SubmissionId = Integer Source

Submissions are identified with an integer id.

type ProblemSession = Integer Source

Problem sessions are identified with an integer id.

type ProjectState = KattisProblem Source

Project-specific state consists of the problem name.

data ConfigState Source

Global configuration, initialized from the .kattisrc file.

Constructors

ConfigState
Fields user :: ByteString Username. apiKey :: ByteString API token (hash). host :: ByteString Host to be considered as service. loginPage :: ByteString URL to login page, relative `host`. submitPage :: ByteString URL to submit page, relative `host`. project :: Maybe ProjectState Project-specific state, optionally loaded.

Instances

Show ConfigState

type Session = (Session, ByteString)Source

HTTP client session and the host path.

data KattisProblem Source

A Kattis problem.

Constructors

ProblemId Integer	Problem ID, unique.
ProblemName ByteString	Associated name of the problem.

Instances

Eq KattisProblem
Show KattisProblem

data KattisLanguage Source

Language used in submission.

Constructors

LangCplusplus	C++.
LangJava	Java.
LangC	C.
LangHaskell	Haskell.

Instances

Eq KattisLanguage
Show KattisLanguage

loginSuccess :: ByteString Source

Server response indicating successful login.

inputTestExtension :: FilePath Source

Extension of input test files.

outputTestExtension :: FilePath Source

Extension of reference ouput test files.

programName :: ByteString Source

Name of this program.

configDir :: ByteString Source

Relative path to project-specific configuration directory.

testFolder :: FilePath Source

Relative path to folder containing tests.

problemAddress :: ByteString Source

URL to page with problem information, relative to host.

unWrapTrans :: (Monad m, MonadTrans t) => EitherT e m a -> EitherT e (t m) aSource

Lift some error monad one layer.

tryIO :: MonadIO m => IO a -> EitherT ErrorDesc m aSource

Execute an IO action and catch any exceptions.

tryIOMsg :: MonadIO m => ByteString -> IO a -> EitherT ErrorDesc m aSource

Execute an IO action and catch any exceptions, tagged with description.

terminateOnFailure :: MonadIO m => ErrorDesc -> EitherT ErrorDesc m a -> m aSource

Evaluate an error action and terminate process upon failure.

defaultOpts :: Options Source

Default HTTP options.

retrievePublicPage :: ByteString -> ConfigEnv IO ByteString Source

Retrieve a publicly available page, using HTTP GET.

retrievePrivatePage :: Session -> ByteString -> EitherT ErrorDesc IO ByteString Source

Retrieve a page requiring authentication, using HTTP GET.

buildURL :: ByteString -> ByteString -> String Source

Construct URL from host path (e.g. http:\/x.com/) and path (e.g. ).

withAuth :: (Session -> EitherT ErrorDesc IO a) -> ConfigEnv IO aSource

Authenticate and run the provided action.

retrieveProblemId :: KattisProblem -> IO Integer Source

Retrieve problem ID of a Kattis problem.

retrieveProblemName :: KattisProblem -> IO ByteString Source

Retrieve problem name of a Kattis problem.