Utils.Katt.Utils

Contains shared type declarations and various utility functions.

Documentation

type ConfigEnvInternal m = StateT ConfigState m

Configuration layer consisting of configuration state.

type ConfigEnv m = EitherT ErrorDesc (ConfigEnvInternal m)

Configuration layer wrapped with error handling.

type Submission = (KattisProblem, [FilePath])

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

type ErrorDesc = ByteString

Error description alias.

type SubmissionId = Integer

Submissions are identified with an integer id.

type ProblemSession = Integer

Problem sessions are identified with an integer id.

type ProjectState = KattisProblem

Project-specific state consists of the problem name.

data ConfigState

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)

HTTP client session and the host path.

data KattisProblem

A Kattis problem.

Constructors

ProblemId Integer

Problem ID, unique.

ProblemName ByteString

Associated name of the problem.

Instances

Eq KattisProblem

Show KattisProblem

data KattisLanguage

Language used in submission.

Constructors

LangCplusplus

C++.

LangJava

Java.

LangC

C.

LangHaskell

Haskell.

Instances

Eq KattisLanguage

Show KattisLanguage

loginSuccess :: ByteString

Server response indicating successful login.

inputTestExtension :: FilePath

Extension of input test files.

outputTestExtension :: FilePath

Extension of reference ouput test files.

programName :: ByteString

Name of this program.

configDir :: ByteString

Relative path to project-specific configuration directory.

testFolder :: FilePath

Relative path to folder containing tests.

problemAddress :: ByteString

URL to page with problem information, relative to host.

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

Lift some error monad one layer.

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

Execute an IO action and catch any exceptions.

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

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

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

Evaluate an error action and terminate process upon failure.

defaultOpts :: Options

Default HTTP options.

retrievePublicPage :: ByteString -> ConfigEnv IO ByteString

Retrieve a publicly available page, using HTTP GET.

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

Retrieve a page requiring authentication, using HTTP GET.

buildURL :: ByteString -> ByteString -> String

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

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

Authenticate and run the provided action.

retrieveProblemId :: KattisProblem -> IO Integer

Retrieve problem ID of a Kattis problem.

retrieveProblemName :: KattisProblem -> IO ByteString

Retrieve problem name of a Kattis problem.