Scion.Browser

Documentation

saveDatabase :: FilePath -> Database -> IO ()

loadDatabase :: FilePath -> IO (Maybe Database)

singletonDatabase :: Documented Package -> Database

data Doc

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

Constructors

NoDoc

Doc Text

Instances

Show Doc

ToJSON Doc

Serialize Doc

NFData Doc

ToJSON (Documented Module)

ToJSON (Documented Decl)

ToJSON (Documented GadtDecl)

ToJSON (Documented Package)

Serialize (Documented SpecialCon)

Serialize (Documented QName)

Serialize (Documented Name)

Serialize (Documented IPName)

Serialize (Documented Module)

Serialize (Documented ModuleHead)

Serialize (Documented Decl)

Serialize (Documented DeclHead)

Serialize (Documented InstHead)

Serialize (Documented GadtDecl)

Serialize (Documented Type)

Serialize (Documented TyVarBind)

Serialize (Documented Kind)

Serialize (Documented FunDep)

Serialize (Documented Context)

Serialize (Documented Asst)

docFromString :: String -> Doc

type Documented a = a Doc

A documented item.

data Package l

A package.

Constructors

Package l PackageIdentifier (Map String (Documented Module))

Instances

Show l => Show (Package l)

Package (Package l)

ToJSON (Documented Package)

Serialize l_1627457893 => Serialize (Package l_1627457893)

NFData l_1627457893 => NFData (Package l_1627457893)

type Database = Map PackageIdentifier (Documented Package)

A Database saves a list of packages.

getNameString :: Name l -> String

Gets the name inside a Name constructor.

getQNameString :: QName l -> String

Gets the qualified name as a string.

class Annotated e => Named e where

Methods

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

Instances

Named Module

Named Decl

Named GadtDecl

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

Methods

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

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

Instances

DocItem Module Decl

DocItem Decl GadtDecl

singleLinePrettyPrint :: Pretty a => a -> String

maybeEmptyContext :: Maybe (Documented Context) -> Documented Context

lookupNameTable :: IORef (Map String (Documented Name))

getNameInLookupTable :: String -> Bool -> Documented Name

lookupQNameTable :: IORef (Map String (Documented QName))

getQNameInLookupTable :: Documented QName -> Documented QName

lookupTyVarTable :: IORef (Map String (Documented Type))

getTyVarInLookupTable :: Documented Name -> Documented Type

lookupTyConTable :: IORef (Map String (Documented Type))

getTyConInLookupTable :: Documented QName -> Documented Type

noDoc :: Doc

nothing :: Maybe a

dataType :: Documented DataOrNew

newType :: Documented DataOrNew

cxEmpty :: Documented Context

kindStar :: Documented Kind

kindBang :: Documented Kind

boxed_ :: Boxed

unboxed_ :: Boxed

unitCon :: Documented SpecialCon

listCon :: Documented SpecialCon

funCon :: Documented SpecialCon

cons_ :: Documented SpecialCon

unboxedSingleCon :: Documented SpecialCon