scion-browser-0.4.3: Command-line interface for browsing and searching packages documentation

Safe HaskellNone
LanguageHaskell98

Scion.PersistentBrowser

Synopsis

Documentation

data DbDeclType Source

Constructors

DbData 
DbNewType 
DbClass 
DbInstance 
DbSignature 
DbType 

Instances

data Doc Source

Documentation for an item. Now it is simply a Text element.

Constructors

NoDoc 
Doc Text 

Instances

docFromString :: String -> Doc Source

type Documented a = a Doc Source

A documented item.

data Package l Source

A package.

Constructors

Package l PackageIdentifier (Map String (Documented Module)) 

Instances

Show l => Show (Package l) 
Package (Package l) 

type Database = Map PackageIdentifier (Documented Package) Source

A Database saves a list of packages.

getNameString :: Name l -> String Source

Gets the name inside a Name constructor.

getQNameString :: QName l -> String Source

Gets the qualified name as a string.

class Annotated e => Named e where Source

Methods

getName :: Show l => e l -> String Source

Instances

class (Named parent, Named child) => DocItem parent child | parent -> child where Source

Minimal complete definition

getChildren

Methods

getChildren :: Show l => parent l -> [child l] Source

getChild :: Show l => parent l -> String -> Maybe (child l) Source

Instances

type SQL a = SqlPersistT (LoggingT (ResourceT IO)) a Source

runLogging :: MonadIO m => LoggingT m a -> m a Source

wrapper around logging methods, so we can enable logging when we debug

data DbPackageGeneric backend Source

Constructors

DbPackage 

Fields

dbPackageName :: !String
 
dbPackageVersion :: !String
 
dbPackageDoc :: !(Maybe String)
 

Instances

type DbPackage = DbPackageGeneric SqlBackend Source

type DbPackageId = KeyBackend SqlBackend DbPackage Source

data DbModuleGeneric backend Source

Constructors

DbModule 

Fields

dbModuleName :: !String
 
dbModuleDoc :: !(Maybe String)
 
dbModulePackageId :: !(KeyBackend backend (DbPackageGeneric backend))
 

Instances

ToJSON DbModule 
HasDbModule DbModule 
HasDbPackage DbModule 
PersistFieldSql (DbModuleGeneric backend) 
PersistEntity (DbModuleGeneric backend) 
PersistField (DbModuleGeneric backend) 
data Unique (DbModuleGeneric backend) 
type PersistEntityBackend (DbModuleGeneric backend) = backend 
data EntityField (DbModuleGeneric backend) where 

type DbModule = DbModuleGeneric SqlBackend Source

type DbModuleId = KeyBackend SqlBackend DbModule Source

data DbDeclGeneric backend Source

Constructors

DbDecl 

Fields

dbDeclDeclType :: !DbDeclType
 
dbDeclName :: !String
 
dbDeclDoc :: !(Maybe String)
 
dbDeclKind :: !(Maybe String)
 
dbDeclSignature :: !(Maybe String)
 
dbDeclEquals :: !(Maybe String)
 
dbDeclModuleId :: !(KeyBackend backend (DbModuleGeneric backend))
 

Instances

HasDbModule DbDecl 
HasDbPackage DbDecl 
PersistFieldSql (DbDeclGeneric backend) 
PersistEntity (DbDeclGeneric backend) 
PersistField (DbDeclGeneric backend) 
data Unique (DbDeclGeneric backend) 
type PersistEntityBackend (DbDeclGeneric backend) = backend 
data EntityField (DbDeclGeneric backend) where 

type DbDecl = DbDeclGeneric SqlBackend Source

type DbDeclId = KeyBackend SqlBackend DbDecl Source

data DbTyVarGeneric backend Source

Constructors

DbTyVar 

Fields

dbTyVarName :: !String
 
dbTyVarDeclId :: !(KeyBackend backend (DbDeclGeneric backend))
 

Instances

ToJSON DbTyVar 
PersistFieldSql (DbTyVarGeneric backend) 
PersistEntity (DbTyVarGeneric backend) 
PersistField (DbTyVarGeneric backend) 
data Unique (DbTyVarGeneric backend) 
type PersistEntityBackend (DbTyVarGeneric backend) = backend 
data EntityField (DbTyVarGeneric backend) where 

type DbTyVar = DbTyVarGeneric SqlBackend Source

type DbTyVarId = KeyBackend SqlBackend DbTyVar Source

data DbFunDepGeneric backend Source

Constructors

DbFunDep 

Fields

dbFunDepName :: !String
 
dbFunDepDeclId :: !(KeyBackend backend (DbDeclGeneric backend))
 

Instances

ToJSON DbFunDep 
PersistFieldSql (DbFunDepGeneric backend) 
PersistEntity (DbFunDepGeneric backend) 
PersistField (DbFunDepGeneric backend) 
data Unique (DbFunDepGeneric backend) 
type PersistEntityBackend (DbFunDepGeneric backend) = backend 
data EntityField (DbFunDepGeneric backend) where 

type DbFunDep = DbFunDepGeneric SqlBackend Source

type DbFunDepId = KeyBackend SqlBackend DbFunDep Source

data DbContextGeneric backend Source

Constructors

DbContext 

Fields

dbContextShown :: !String
 
dbContextDeclId :: !(KeyBackend backend (DbDeclGeneric backend))
 

Instances

ToJSON DbContext 
PersistFieldSql (DbContextGeneric backend) 
PersistEntity (DbContextGeneric backend) 
PersistField (DbContextGeneric backend) 
data Unique (DbContextGeneric backend) 
type PersistEntityBackend (DbContextGeneric backend) = backend 
data EntityField (DbContextGeneric backend) where 

type DbContext = DbContextGeneric SqlBackend Source

type DbContextId = KeyBackend SqlBackend DbContext Source

data DbConstructorGeneric backend Source

Constructors

DbConstructor 

Fields

dbConstructorName :: !String
 
dbConstructorSignature :: !String
 
dbConstructorDeclId :: !(KeyBackend backend (DbDeclGeneric backend))
 

Instances

type DbConstructor = DbConstructorGeneric SqlBackend Source

type DbConstructorId = KeyBackend SqlBackend DbConstructor Source

migrateAll :: forall m. (MonadBaseControl IO m, MonadIO m, MonadLogger m) => Migration (SqlPersistT m) Source

data DbPackageIdentifier Source

Information needed to search a package.

Constructors

DbPackageIdentifier String String 

Instances

dbPackageToIdentifier :: DbPackage -> DbPackageIdentifier Source

data DbCompleteDecl Source

Complete information for a declaration. Look at its ToJSON instance to know which one is used in each kind of declaration.

Constructors

DbCompleteDecl DbDecl [DbContext] [DbTyVar] [DbFunDep] [DbConstructor] 

Instances