factor/basis/help/lint/lint.factor

103 lines
2.6 KiB
Factor
Executable File

! Copyright (C) 2006, 2009 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
USING: assocs continuations fry help help.lint.checks
help.topics io kernel namespaces parser sequences
source-files.errors vocabs.hierarchy vocabs words classes
locals tools.errors listener ;
FROM: help.lint.checks => all-vocabs ;
FROM: vocabs => child-vocabs ;
IN: help.lint
SYMBOL: lint-failures
lint-failures [ H{ } clone ] initialize
TUPLE: help-lint-error < source-file-error ;
SYMBOL: +help-lint-failure+
T{ error-type
{ type +help-lint-failure+ }
{ word ":lint-failures" }
{ plural "help lint failures" }
{ icon "vocab:ui/tools/error-list/icons/help-lint-error.tiff" }
{ quot [ lint-failures get values ] }
{ forget-quot [ lint-failures get delete-at ] }
} define-error-type
M: help-lint-error error-type drop +help-lint-failure+ ;
<PRIVATE
: <help-lint-error> ( error topic -- help-lint-error )
\ help-lint-error <definition-error> ;
PRIVATE>
: help-lint-error ( error topic -- )
lint-failures get pick
[ [ [ <help-lint-error> ] keep ] dip set-at ] [ delete-at drop ] if
notify-error-observers ;
<PRIVATE
:: check-something ( topic quot -- )
[ quot call( -- ) f ] [ ] recover
topic help-lint-error ; inline
: check-word ( word -- )
[ with-file-vocabs ] vocabs-quot set
dup word-help [
[ >link ] keep '[
_ dup word-help
[ check-values ]
[ check-class-description ]
[ nip [ check-nulls ] [ check-see-also ] [ check-markup ] tri ] 2tri
] check-something
] [ drop ] if ;
: check-article ( article -- )
[ with-interactive-vocabs ] vocabs-quot set
>link dup '[
_
[ check-article-title ]
[ article-content check-markup ] bi
] check-something ;
: check-about ( vocab -- )
vocab-link boa dup
'[ _ vocab-help [ article drop ] when* ] check-something ;
: check-vocab ( vocab -- )
"Checking " write dup write "..." print
[ check-about ]
[ words [ check-word ] each ]
[ vocab-articles get at [ check-article ] each ]
tri ;
PRIVATE>
: help-lint ( prefix -- )
[
auto-use? off
all-vocab-names all-vocabs set
group-articles vocab-articles set
child-vocabs
[ check-vocab ] each
] with-scope ;
: help-lint-all ( -- ) "" help-lint ;
: :lint-failures ( -- ) lint-failures get values errors. ;
: unlinked-words ( words -- seq )
all-word-help [ article-parent not ] filter ;
: linked-undocumented-words ( -- seq )
all-words
[ word-help not ] filter
[ article-parent ] filter
[ predicate? not ] filter ;
MAIN: help-lint