! Copyright (C) 2005, 2009 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
+
USING: accessors arrays ascii combinators
combinators.short-circuit compiler.units definitions help
-help.markup help.topics kernel lexer math namespaces parser
-sequences splitting strings strings.parser vocabs.parser words ;
+help.markup help.topics kernel lexer math math.order namespaces
+parser sequences splitting strings strings.parser vocabs.parser
+words ;
+
IN: help.syntax
+DEFER: HELP{
+
<PRIVATE
:: parse-help-token ( end -- str/obj/f )
?scan-token dup {
+ [ "{" = [ \ HELP{ ] [ f ] if ]
[ "syntax" lookup-word ]
- [ "help.markup" lookup-word ]
+ [ { [ "$" head? ] [ "help.markup" lookup-word ] } 1&& ]
[ dup ?last ":{[(/\"" member-eq? [ search ] [ drop f ] if ]
} 1|| {
{ [ dup not ] [ drop ] }
] if
] produce nip ;
+: whitespace ( seq -- n )
+ [ [ blank? ] all? ] reject [ 0 ] [
+ [ [ blank? not ] find drop ] [ min ] map-reduce
+ ] if-empty ;
+
+: trim-whitespace ( seq -- seq' )
+ dup rest-slice dup whitespace
+ [ '[ _ index-or-length tail ] map! ] unless-zero drop
+ 0 over [ [ blank? ] trim-head ] change-nth ;
+
: code-lines ( str -- seq )
- split-lines [ [ ascii:blank? ] trim ] map harvest ;
+ split-lines trim-whitespace [ [ blank? ] all? ] trim ;
: make-example ( str -- seq )
code-lines dup { [ array? ] [ length 1 > ] } 1&& [
: help-text? ( word -- ? )
{
- $description $snippet $emphasis $strong $url $heading
+ $description $snippet $emphasis $strong $heading
$subheading $syntax $class-description
$error-description $var-description $contract $notes
$curious $deprecated $errors $side-effects $content
} member-eq? ;
: help-code? ( word -- ? )
- { $example $unchecked-example $code } member-eq? ;
+ { $example $unchecked-example $code $url } member-eq? ;
: help-values? ( word -- ? )
{ $values $inputs $outputs } member-eq? ;