Development.IDE.Spans.Common

Documentation

showGhc :: Outputable a => a -> Text

showNameWithoutUniques :: Outputable a => a -> Text

unqualIEWrapName :: IEWrappedName RdrName -> Text

Shows IEWrappedName, without any modifier, qualifier or unique identifier.

safeTyThingId :: TyThing -> Maybe Id

safeTyThingType :: TyThing -> Maybe Type

data SpanDoc

Constructors

SpanDocString HsDocString SpanDocUris

SpanDocText [Text] SpanDocUris

Instances

Eq SpanDoc

Defined in Development.IDE.Spans.Common

Methods

(==) :: SpanDoc -> SpanDoc -> Bool

(/=) :: SpanDoc -> SpanDoc -> Bool

Show SpanDoc

Defined in Development.IDE.Spans.Common

Methods

showsPrec :: Int -> SpanDoc -> ShowS

show :: SpanDoc -> String

showList :: [SpanDoc] -> ShowS

Generic SpanDoc

Defined in Development.IDE.Spans.Common

Associated Types

type Rep SpanDoc :: Type -> Type

Methods

from :: SpanDoc -> Rep SpanDoc x

to :: Rep SpanDoc x -> SpanDoc

NFData SpanDoc

Defined in Development.IDE.Spans.Common

Methods

rnf :: SpanDoc -> ()

type Rep SpanDoc

Defined in Development.IDE.Spans.Common

type Rep SpanDoc = D1 ('MetaData "SpanDoc" "Development.IDE.Spans.Common" "ghcide-1.6.0.1-A07kFG9VDWRB6Z3nqekA9E" 'False) (C1 ('MetaCons "SpanDocString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HsDocString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpanDocUris)) :+: C1 ('MetaCons "SpanDocText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpanDocUris)))

data SpanDocUris

Constructors

SpanDocUris

Fields

• spanDocUriDoc :: Maybe Text

  The haddock html page

• spanDocUriSrc :: Maybe Text

  The hyperlinked source html page

Instances

Eq SpanDocUris

Defined in Development.IDE.Spans.Common

Methods

(==) :: SpanDocUris -> SpanDocUris -> Bool

(/=) :: SpanDocUris -> SpanDocUris -> Bool

Show SpanDocUris

Defined in Development.IDE.Spans.Common

Methods

showsPrec :: Int -> SpanDocUris -> ShowS

show :: SpanDocUris -> String

showList :: [SpanDocUris] -> ShowS

Generic SpanDocUris

Defined in Development.IDE.Spans.Common

Associated Types

type Rep SpanDocUris :: Type -> Type

Methods

from :: SpanDocUris -> Rep SpanDocUris x

to :: Rep SpanDocUris x -> SpanDocUris

NFData SpanDocUris

Defined in Development.IDE.Spans.Common

Methods

rnf :: SpanDocUris -> ()

type Rep SpanDocUris

Defined in Development.IDE.Spans.Common

type Rep SpanDocUris = D1 ('MetaData "SpanDocUris" "Development.IDE.Spans.Common" "ghcide-1.6.0.1-A07kFG9VDWRB6Z3nqekA9E" 'False) (C1 ('MetaCons "SpanDocUris" 'PrefixI 'True) (S1 ('MetaSel ('Just "spanDocUriDoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "spanDocUriSrc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

emptySpanDoc :: SpanDoc

spanDocToMarkdown :: SpanDoc -> [Text]

spanDocToMarkdownForTest :: String -> String

type DocMap = NameEnv SpanDoc

type KindMap = NameEnv TyThing