FP.API.Common

Documentation

data ClientRoute

Constructors

MiscCommandRoute

IdeMessagesRoute ProjectId

IdeAsyncCommandRoute ProjectId

Instances

Eq ClientRoute

Ord ClientRoute

Show ClientRoute

class (Applicative m, MonadIO m, MonadBaseControl IO m, Applicative m', MonadIO m', MonadBaseControl IO m') => FpClient m m' | m -> m' where

Methods

runCallback :: m' a -> m a

clientInfo :: m (ClientInfo m')

makeRequest :: (Data command, Show command) => Text -> Int -> ClientRoute -> command -> m (Maybe ByteString)

Instances

FpClient (ServerM ProjectId) (ServerM ProjectId)

data ClientInfo m'

Constructors

ClientInfo

Fields

ciProjId :: ProjectId

ciCallbacks :: ProjectCallbacks m'

ciTokens :: IORef (Map EncFileName FayTutorialToken)

ciCompileId :: TVar (Maybe CompileId)

ciSessionId :: TVar (Maybe SessionId)

ciLastStatus :: TVar (Maybe ProjectStatusSnapshot)

ciTimeout :: Int

newClientInfo :: Int -> ProjectId -> IO (ClientInfo m')

data ProjectCallbacks m'

Constructors

ProjectCallbacks

Fields

pcJobs :: IORef (Join JobId (Either Text Value -> m' ()) (Either Text Value))

pcMessage :: Signal m' (LogLevel, Text)

pcProcessOutput :: Signal m' (ProcId, StdoutResult)

pcNewStatus :: Signal m' ProjectStatusSnapshot

pcProjectClosed :: Signal m' ()

defaultProjectCallbacks :: IO (ProjectCallbacks m')

data ClientException

Constructors

ClientException Text

Instances

Show ClientException

Exception ClientException

Typeable * ClientException

clientFail :: Text -> a

data Join k a b

Constructors

Join (Map k a) (Map k b)

emptyJoin :: Ord k => Join k a b

joinAInput :: Ord k => Join k a b -> k -> a -> (Join k a b, Maybe b)

joinBInput :: Ord k => Join k a b -> k -> b -> (Join k a b, Maybe a)

pollProjectMessages :: FpClient m m' => m ()

handleMessage :: FpClient m m' => RunnerMessage -> m ()

jobResult :: MonadIO m' => ProjectCallbacks m' -> JobId -> Either Text Value -> m' ()

jobCallback :: MonadIO m' => ProjectCallbacks m' -> JobId -> (Either Text Value -> m' ()) -> m' ()

ideCommand :: (Data command, Show command, Data a, Show a, FpClient m m') => (Returns' a -> command) -> m a

ideCommandFail :: forall command a m m'. (Data command, Show command, Data a, Show a, FpClient m m') => (Returns' a -> command) -> m ()

(for testing purposes)

makeFayAsyncCall :: forall command a m m'. (Data command, Show command, Data a, Show a, FpClient m m') => (Returns' a -> command) -> m (Either Text a)

updateSessionCompileId :: (Show a, Data a) => TVar (Maybe CompileId) -> TVar (Maybe SessionId) -> a -> STM Bool

fayCommand :: (Data command, Show command, Data a, FpClient m m') => (Returns' a -> command) -> m a

callFay :: (Data command, Show command, Data a, FpClient m m') => ClientRoute -> (Returns' a -> command) -> m a

makeFayCall :: (Data command, Show command, Data a, FpClient m m') => ClientRoute -> (Returns a -> command) -> m a

makeFayCall' :: (Data command, Show command, Data a, FpClient m m') => ClientRoute -> command -> m a

This is the same thing as makeFayCall, but with a less restrictive type that doens't enforce that the return type of the command is correct.

handleServerResponse :: (Data a, Monad m) => String -> Maybe ByteString -> m a

getAnnouncements :: FpClient m m' => m [(Text, Text, Text)]

seenAnnouncement :: FpClient m m' => Text -> m ()

getSettingsSubstitutions :: FpClient m m' => m Text

setSettingsSubstitutions :: FpClient m m' => Text -> m ()

closeAllProjects :: FpClient m m' => m ()

getProjectId :: FpClient m m' => Text -> m ProjectId

saveProfile :: FpClient m m' => Theme -> Int -> Bool -> m ()

getIFilesFromURL :: FpClient m m' => Text -> m IFiles

getIFilesFromCode :: FpClient m m' => Text -> Text -> Maybe Text -> m IFiles

generateConfiguration :: FpClient m m' => m ()

sshPublicKey :: FpClient m m' => m Text

getGithubUrl :: FpClient m m' => Text -> m Text

revokeGithub :: FpClient m m' => m ()

userAuthedGithub :: FpClient m m' => m Bool

getConflictingPackagesFail :: FpClient m m' => m ()

hoogleSearchFail :: FpClient m m' => Bool -> Text -> Text -> m ()

startInteractiveWebFail :: FpClient m m' => [FileToRun] -> m ()

startInteractiveFail :: FpClient m m' => [FileToRun] -> m ()

stopRunningCodeFail :: FpClient m m' => m ()

putStdinFail :: FpClient m m' => ProcId -> Text -> m ()

getDeploymentManagerInfoFail :: FpClient m m' => m ()

getRandomHostNameFail :: FpClient m m' => m ()

checkHostNameFail :: FpClient m m' => Text -> m ()

getNewBgJobFail :: FpClient m m' => FayDeploymentId -> m ()

getNewWebAppFail :: FpClient m m' => FayDeploymentId -> m ()

getNewDeploymentFail :: FpClient m m' => m ()

getNewRunConfigFail :: FpClient m m' => m ()

setDeploymentsFail :: FpClient m m' => [(FayDeploymentId, Deployment)] -> m ()

setRunConfigsFail :: FpClient m m' => [(RunConfigId, RunConfig)] -> m ()

getKeterYamlFail :: FpClient m m' => FayDeploymentId -> ModuleName -> m ()

extractRefactoringFail :: FpClient m m' => SourceSpan -> Text -> RefactoringContext -> m ()

renameRefactoringFail :: FpClient m m' => SourceSpan -> Text -> RefactoringContext -> m ()

checkoutBranchFail :: FpClient m m' => BranchName -> m ()

deleteBranchFail :: FpClient m m' => BranchName -> m ()

createBranchFail :: FpClient m m' => BranchName -> CommitName -> m ()

cancelGitShellFail :: FpClient m m' => GitShellId -> m ()

applyGitShellFail :: FpClient m m' => GitShellId -> m ()

gitShellInputFail :: FpClient m m' => GitShellId -> Text -> m ()

startGitShellFail :: FpClient m m' => m ()

gitDiffFail :: FpClient m m' => m ()

gitResolveFileFail :: FpClient m m' => EncFileName -> m ()

gitMergeDoneFail :: FpClient m m' => MaybeText -> m ()

gitMergeAbortFail :: FpClient m m' => m ()

gitPullFail :: FpClient m m' => Text -> m ()

gitPushIgnoreDirtyFail :: FpClient m m' => Text -> m ()

gitPushFail :: FpClient m m' => Text -> m ()

gitResetFail :: FpClient m m' => m ()

gitCommitFail :: FpClient m m' => Text -> m ()

setGitConfigFail :: FpClient m m' => Text -> Text -> m ()

getGitConfigFail :: FpClient m m' => Text -> m ()

setRemotesFail :: FpClient m m' => RemotesList -> m ()

setRootFail :: FpClient m m' => Text -> Text -> m ()

isProjectDirtyFail :: FpClient m m' => m ()

getGitHistoryFail :: FpClient m m' => Int -> Int -> m ()

compileBinaryFail :: FpClient m m' => EncFileName -> [(Text, Text)] -> m ()

runTargetFail :: FpClient m m' => Bool -> m ()

getTargetFail :: FpClient m m' => m ()

setTargetFail :: FpClient m m' => Maybe (Either EncFileName RunConfigId) -> m ()

searchProjectFail :: FpClient m m' => SearchQuery -> Int -> Int -> Bool -> m ()

ideHoogleSearchFail :: FpClient m m' => Maybe EncFileName -> Bool -> Int -> Int -> Int -> Text -> m ()

getAutocompletionsFail :: FpClient m m' => AutoCompleteInput -> m ()

getDefinitionSourceFail :: FpClient m m' => SourceSpan -> m ()

getFindUsagesFail :: FpClient m m' => SourceSpan -> m ()

getTypeInfoDominatorsFail :: FpClient m m' => SourceSpan -> m ()

getTypeInfoFail :: FpClient m m' => SourceSpan -> m ()

renderFileMarkdownFail :: FpClient m m' => EncFileName -> m ()

reformatModuleFail :: FpClient m m' => EncFileName -> m ()

setModuleExclusionFail :: FpClient m m' => EncFileName -> Bool -> m ()

getAllFilesFail :: FpClient m m' => m ()

getFileTokenFail :: FpClient m m' => EncFileName -> m ()

getFileFail :: FpClient m m' => EncFileName -> m ()

renameFileFail :: FpClient m m' => EncFileName -> NewFileInfo -> RenameType -> m ()

deleteFileFail :: FpClient m m' => EncFileName -> m ()

saveFileFail :: FpClient m m' => EncFileName -> Text -> FayTutorialToken -> m ()

addFileFail :: FpClient m m' => NewFileInfo -> m ()

pingFail :: FpClient m m' => m ()

generateHaddocksFail :: FpClient m m' => m ()

restartBackendFail :: FpClient m m' => Text -> m ()

sdistTarballFail :: FpClient m m' => m ()

resetProjectSettingsFail :: FpClient m m' => Text -> m ()

deleteProjectFail :: FpClient m m' => Text -> m ()

saveProjectStateFail :: FpClient m m' => ProjectState -> Text -> m ()

setProjectMetadataFail :: FpClient m m' => Text -> Text -> m ()

getPublicFail :: FpClient m m' => m ()

setPublicFail :: FpClient m m' => Bool -> m ()

setSettingsFail :: FpClient m m' => SetSettingsInput -> m ()

reparseProjectSettingsFail :: FpClient m m' => m ()

getInitialProjectInfoFail :: FpClient m m' => Text -> m ()

getConflictingPackages :: FpClient m m' => m [[(Bool, Text)]]

hoogleSearch :: FpClient m m' => Bool -> Text -> Text -> m FayHoogleResults

startInteractiveWeb :: FpClient m m' => [FileToRun] -> m (ErrorsAnd ApprootPid)

startInteractive :: FpClient m m' => [FileToRun] -> m (ErrorsAnd ProcId)

stopRunningCode :: FpClient m m' => m ()

putStdin :: FpClient m m' => ProcId -> Text -> m Bool

getDeploymentManagerInfo :: FpClient m m' => m DeploymentManagerInfo

getRandomHostName :: FpClient m m' => m RandomHostName

checkHostName :: FpClient m m' => Text -> m UseHostName

getNewBgJob :: FpClient m m' => FayDeploymentId -> m NewBgJob

getNewWebApp :: FpClient m m' => FayDeploymentId -> m NewWebApp

getNewDeployment :: FpClient m m' => m NewDeployment

getNewRunConfig :: FpClient m m' => m NewRunConfig

setDeployments :: FpClient m m' => [(FayDeploymentId, Deployment)] -> m ()

setRunConfigs :: FpClient m m' => [(RunConfigId, RunConfig)] -> m ()

getKeterYaml :: FpClient m m' => FayDeploymentId -> ModuleName -> m KeterYaml

extractRefactoring :: FpClient m m' => SourceSpan -> Text -> RefactoringContext -> m RefactoringOutput

renameRefactoring :: FpClient m m' => SourceSpan -> Text -> RefactoringContext -> m RefactoringOutput

checkoutBranch :: FpClient m m' => BranchName -> m GitCheckoutResult

deleteBranch :: FpClient m m' => BranchName -> m ()

createBranch :: FpClient m m' => BranchName -> CommitName -> m ()

cancelGitShell :: FpClient m m' => GitShellId -> m ()

applyGitShell :: FpClient m m' => GitShellId -> m RunnerProjectClosed

gitShellInput :: FpClient m m' => GitShellId -> Text -> m ()

startGitShell :: FpClient m m' => m GitShellId

gitDiff :: FpClient m m' => m Text

gitResolveFile :: FpClient m m' => EncFileName -> m ()

gitMergeDone :: FpClient m m' => MaybeText -> m GitResolvedResult

gitMergeAbort :: FpClient m m' => m RunnerProjectClosed

gitPull :: FpClient m m' => Text -> m GitPullResult

gitPushIgnoreDirty :: FpClient m m' => Text -> m ()

gitPush :: FpClient m m' => Text -> m GitPushResult

gitReset :: FpClient m m' => m RunnerProjectClosed

gitCommit :: FpClient m m' => Text -> m CommitSHA

setGitConfig :: FpClient m m' => Text -> Text -> m ()

getGitConfig :: FpClient m m' => Text -> m Text

setRemotes :: FpClient m m' => RemotesList -> m ()

setRoot :: FpClient m m' => Text -> Text -> m CompileDesc

isProjectDirty :: FpClient m m' => m Bool

getGitHistory :: FpClient m m' => Int -> Int -> m [GitHistoryItem]

compileBinary :: FpClient m m' => EncFileName -> [(Text, Text)] -> m UploadedBuild

runTarget :: FpClient m m' => Bool -> m ProcId

getTarget :: FpClient m m' => m (Maybe (Either EncFileName RunConfigId))

setTarget :: FpClient m m' => Maybe (Either EncFileName RunConfigId) -> m (Maybe CompileDesc)

searchProject :: FpClient m m' => SearchQuery -> Int -> Int -> Bool -> m [SearchResult]

ideHoogleSearch :: FpClient m m' => Maybe EncFileName -> Bool -> Int -> Int -> Int -> Text -> m (Text, [HoogleResult], Maybe Int)

getAutocompletions :: FpClient m m' => AutoCompleteInput -> m [Text]

getDefinitionSource :: FpClient m m' => SourceSpan -> m IdInfo

getFindUsages :: FpClient m m' => SourceSpan -> m [SearchResult]

getTypeInfoDominators :: FpClient m m' => SourceSpan -> m [TypeInfo]

getTypeInfo :: FpClient m m' => SourceSpan -> m (Maybe TypeInfo)

renderFileMarkdown :: FpClient m m' => EncFileName -> m HtmlReply

reformatModule :: FpClient m m' => EncFileName -> m (Maybe CompileDesc)

setModuleExclusion :: FpClient m m' => EncFileName -> Bool -> m (Maybe CompileDesc)

getAllFiles :: FpClient m m' => m [FileDesc]

getFileToken :: FpClient m m' => EncFileName -> m FayTutorialToken

getFile :: FpClient m m' => EncFileName -> m FayFileContent

renameFile :: FpClient m m' => EncFileName -> NewFileInfo -> RenameType -> m RenameFileOutput

deleteFile :: FpClient m m' => EncFileName -> m (Maybe CompileDesc)

saveFile :: FpClient m m' => EncFileName -> Text -> FayTutorialToken -> m SaveFileOutput

addFile :: FpClient m m' => NewFileInfo -> m SaveFileOutput

ping :: FpClient m m' => m ()

generateHaddocks :: FpClient m m' => m Text

restartBackend :: FpClient m m' => Text -> m RunnerProjectClosed

sdistTarball :: FpClient m m' => m (Either Text SdistTarballInfo)

resetProjectSettings :: FpClient m m' => Text -> m RunnerProjectClosed

deleteProject :: FpClient m m' => Text -> m ()

saveProjectState :: FpClient m m' => ProjectState -> Text -> m ()

setProjectMetadata :: FpClient m m' => Text -> Text -> m ()

getPublic :: FpClient m m' => m Bool

setPublic :: FpClient m m' => Bool -> m ()

setSettings :: FpClient m m' => SetSettingsInput -> m (Either CompileIdent RunnerProjectClosed)

reparseProjectSettings :: FpClient m m' => m (Maybe RunnerProjectClosed)

getInitialProjectInfo :: FpClient m m' => Text -> m InitialProjectInfo

addFile' :: FpClient m m' => NewFileInfo -> m (Maybe CompileDesc)

saveFile' :: FpClient m m' => EncFileName -> Text -> m (Maybe CompileDesc)

deleteFile' :: FpClient m m' => EncFileName -> m (Maybe CompileDesc)

renameFile' :: FpClient m m' => EncFileName -> NewFileInfo -> RenameType -> m RenameFileOutput

updateFileToken :: FpClient m m' => EncFileName -> m FayTutorialToken

getFile' :: FpClient m m' => EncFileName -> m (Maybe Text)

updateToken :: FpClient m m' => EncFileName -> FayTutorialToken -> m ()

modifyTokens :: FpClient m m' => (Map EncFileName FayTutorialToken -> Map EncFileName FayTutorialToken) -> m ()

watchStatusOneShot :: FpClient m m' => String -> Maybe Int -> (ProjectStatusSnapshot -> m' (Maybe a)) -> m a