-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell client for Moss
--   
--   Please see the README on Github at
--   <a>https://github.com/mbg/moss#readme</a>
@package moss
@version 0.2.0.0

module Stanford.Moss

-- | Represents configurations for a Moss connection.
data MossCfg
MossCfg :: HostName -> ServiceName -> ByteString -> Maybe FilePath -> Bool -> Int -> Bool -> Language -> MossCfg
[mossServer] :: MossCfg -> HostName
[mossPort] :: MossCfg -> ServiceName
[mossUser] :: MossCfg -> ByteString
[mossDir] :: MossCfg -> Maybe FilePath
[mossX] :: MossCfg -> Bool
[mossMaxMatches] :: MossCfg -> Int
[mossShow] :: MossCfg -> Bool
[mossLanguage] :: MossCfg -> Language

-- | <a>defaultMossCfg</a> is the default configuration for a Moss
--   connection.
defaultMossCfg :: MossCfg

-- | Enumerates programming languages supported by Moss.
data Language
C :: Language
CPP :: Language
Java :: Language
CSharp :: Language
Python :: Language
VisualBasic :: Language
Javascript :: Language
FORTRAN :: Language
ML :: Language
Haskell :: Language
Lisp :: Language
Scheme :: Language
Pascal :: Language
Modula2 :: Language
Ada :: Language
Perl :: Language
TCL :: Language
Matlab :: Language
VHDL :: Language
Verilog :: Language
Spice :: Language
MIPS :: Language
A8086 :: Language
HCL2 :: Language
ASCII :: Language
Prolog :: Language
PLSQL :: Language

-- | The type of computations which use a connection to Moss.
type Moss = StateT MossSt IO

-- | Lift a computation from the <a>IO</a> monad.
liftIO :: MonadIO m => IO a -> m a

-- | <a>withMoss</a> <tt>cfg m</tt> runs a computation <tt>m</tt> using a
--   Moss connection whose configuration is reprsented by <tt>cfg</tt>.
withMoss :: MossCfg -> Moss a -> IO a

-- | <a>addBaseFile</a> <tt>file</tt> adds <tt>file</tt> as part of the
--   skeleton code.
addBaseFile :: String -> FilePath -> Moss ()

-- | <a>addFile</a> <tt>name file</tt> adds <tt>file</tt> as a submission
--   to Moss with <tt>name</tt>.
addFile :: String -> FilePath -> Moss ()

-- | <a>addFilesForStudent</a> <tt>filesWithNames</tt> uploads multiple
--   files for the same student. I.e. in the Moss submission they will
--   share the same ID.
addFilesForStudent :: [(String, FilePath)] -> Moss ()

-- | <a>query</a> <tt>comment</tt> runs the plagiarism check on all
--   submitted files. The URL of the report is returned if Moss was able to
--   perform the checks successfully.
query :: ByteString -> Moss (Maybe ByteString)
instance GHC.Enum.Enum Stanford.Moss.Language
instance GHC.Classes.Eq Stanford.Moss.Language
instance GHC.Show.Show Stanford.Moss.MossCfg
instance GHC.Classes.Eq Stanford.Moss.MossCfg
instance GHC.Show.Show Stanford.Moss.MossSt
instance GHC.Classes.Eq Stanford.Moss.MossSt
instance GHC.Show.Show Stanford.Moss.Language