synopsis* ( defspec -- )
Factor handbook » Developer tools » Printing definitions

Prev:

see* ( defspec -- )

Vocabulary
see

Inputs

defspec

a definition specifier

Outputs
None

Generic word contract
Adds sections to the current block corresponding to a the prologue of a definition, in source code-like form.

Notes
This word should only be called from inside the with-pprint combinator. Client code should call synopsis instead.

Definition

IN: see

GENERIC: synopsis* ( defspec -- )

Methods

USING: accessors alien.prettyprint combinators kernel
prettyprint.backend prettyprint.sections see see.private
sequences words ;

M: alien-callback-type-word synopsis*
    {
        [ seeing-word ]
        [ "callback-library" word-prop pprint-library ]
        [ definer. ]
        [ def>> first first pprint-c-type ]
        [ pprint-word ]
        [
            <block "(" text
            [ def>> first second ]
            [ "callback-effect" word-prop in>> ] bi
            pprint-function-args ")" text block>
        ]
    } cleave ;


USING: accessors alien.prettyprint combinators
prettyprint.backend prettyprint.sections see see.private
sequences ;

M: alien-function-alias-word synopsis*
    {
        [ seeing-word ]
        [ def>> second pprint-library ]
        [ definer. ]
        [ pprint-word ]
        [ [ def>> third text ] pprint-function ]
    } cleave ;


USING: accessors alien.prettyprint combinators
prettyprint.backend see see.private sequences ;

M: alien-function-word synopsis*
    {
        [ seeing-word ]
        [ def>> second pprint-library ]
        [ definer. ]
        [ [ pprint-word ] pprint-function ]
    } cleave ;


USING: combinators cuda.prettyprint prettyprint.backend see
see.private ;

M: cuda-function-word synopsis*
    {
        [ seeing-word ]
        [ definer. ]
        [ [ pprint-word ] pprint-cuda-function ]
    } cleave ;


USING: accessors alien.c-types alien.enums combinators kernel
prettyprint.backend prettyprint.sections see see.private ;

M: enum-c-type-word synopsis*
    {
        [ seeing-word ]
        [ definer. ]
        [ pprint-word ]
        [
            lookup-c-type base-type>> dup int eq?
            [ drop ] [ "<" text pprint-word ] if
        ]
    } cleave ;


USING: accessors combinators generic.hook prettyprint.backend
prettyprint.custom see see.private words ;

M: hook-generic synopsis*
    {
        [ definer. ]
        [ seeing-word ]
        [ pprint-word ]
        [ "combination" word-prop var>> pprint* ]
        [ stack-effect. ]
    } cleave ;


USING: effects kernel locals.definitions prettyprint.backend see
words ;

M: lambda-method synopsis*
    dup dup dup definer. "method-class" word-prop pprint-word
    "method-generic" word-prop pprint-word
    method-stack-effect effect>string comment. ;


USING: accessors help.topics kernel prettyprint.custom see ;

M: link synopsis*
    dup definer. dup name>> pprint* article-title pprint* ;


USING: kernel multi-methods prettyprint.backend
prettyprint.custom see words ;

M: method-body synopsis*
    dup definer.
    [ "multi-method-generic" word-prop pprint-word ]
    [ "multi-method-specializer" word-prop pprint* ] bi ;


USING: multi-methods see sequences ;

M: method-spec synopsis* unclip method synopsis* ;


USING: generic kernel prettyprint.backend see words ;

M: method synopsis*
    [ definer. ] [ "method-class" word-prop pprint-class ]
    [ "method-generic" word-prop pprint-word ] tri ;


USING: accessors classes.mixin kernel prettyprint.backend see ;

M: mixin-instance synopsis*
    [ definer. ] [ class>> pprint-word ] [ mixin>> pprint-word ]
    tri ;


USING: io.pathnames prettyprint.custom see ;

M: pathname synopsis* pprint* ;


USING: generic.standard see see.private ;

M: simple-generic synopsis* word-synopsis ;


USING: combinators generic.single generic.standard
prettyprint.backend prettyprint.custom see see.private ;

M: standard-generic synopsis*
    {
        [ definer. ]
        [ seeing-word ]
        [ pprint-word ]
        [ dispatch# pprint* ]
        [ stack-effect. ]
    } cleave ;


USING: alien.c-types alien.prettyprint combinators
prettyprint.backend see see.private words ;

M: typedef-word synopsis*
    {
        [ seeing-word ]
        [ definer. ]
        [ "c-type" word-prop pprint-c-type ]
        [ pprint-word ]
    } cleave ;


USING: accessors help.topics kernel prettyprint.backend see ;

M: word-link synopsis*
    dup definer. name>> dup pprint-word stack-effect. ;


USING: see see.private words ;

M: word synopsis* word-synopsis ;