1 ! Copyright (C) 2006, 2009 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays classes colors.constants combinators
4 combinators.short-circuit compiler.units debugger fry help
5 help.apropos help.crossref help.home help.stylesheet help.topics
6 kernel models sequences sets ui ui.commands ui.gadgets
7 ui.gadgets.borders ui.gadgets.buttons ui.gadgets.editors
8 ui.gadgets.glass ui.gadgets.labels ui.gadgets.lines ui.gadgets.panes
9 ui.gadgets.scrollers ui.gadgets.status-bar ui.gadgets.tracks ui.gadgets.toolbar
10 ui.gadgets.viewports ui.gadgets.worlds ui.gestures
11 ui.tools.browser.history ui.tools.browser.popups ui.tools.common
12 ui.pens.solid vocabs ;
15 TUPLE: browser-gadget < tool history scroller search-field popup ;
17 { 650 700 } browser-gadget set-tool-dim
19 M: browser-gadget history-value
20 [ control-value ] [ scroller>> scroll-position ]
23 M: browser-gadget set-history-value
25 [ set-control-value ] [ scroller>> set-scroll-position ]
28 : show-help ( link browser-gadget -- )
32 [ 2drop ] [ [ add-recent ] [ history>> add-history ] bi* ] if
37 : <help-header> ( browser-gadget -- gadget )
38 model>> [ '[ _ $title ] try ] <pane-control> ;
40 CONSTANT: help-header-background COLOR: FactorLightTan
42 : add-help-header ( track -- track )
43 dup <help-header> { 3 3 } <border>
44 help-header-background <solid> >>interior
45 { 1 0 } >>fill f track-add ;
47 : <help-pane> ( browser-gadget -- gadget )
48 model>> [ '[ _ print-topic ] try ] <pane-control> ;
50 : add-help-pane ( track -- track )
51 dup dup <help-pane> margins
52 <scroller> >>scroller scroller>> white-interior 1 track-add ;
54 : search-browser ( string browser -- )
55 '[ <apropos-search> _ show-help ] unless-empty ;
57 : <search-field> ( browser -- field )
58 '[ _ search-browser ] <action-field>
63 : <browser-toolbar> ( browser -- toolbar )
68 over <toolbar> f track-add
69 swap search-field>> " Search" label-on-left 1 track-add ;
71 : add-browser-toolbar ( track -- track )
72 dup <browser-toolbar> { 3 3 } <border>
73 toolbar-background <solid> >>interior { 1 0 } >>fill
76 : <browser-gadget> ( link -- gadget )
77 vertical browser-gadget new-track with-lines
79 swap >link <model> >>model
80 dup <history> >>history
81 dup <search-field> >>search-field
86 M: browser-gadget graft*
87 [ add-definition-observer ] [ call-next-method ] bi ;
89 M: browser-gadget ungraft*
90 [ call-next-method ] [ remove-definition-observer ] bi ;
92 M: browser-gadget handle-gesture
94 { [ over key-gesture? not ] [ call-next-method ] }
95 { [ dup popup>> ] [ { [ pass-to-popup ] [ call-next-method ] } 2&& ] }
99 : showing-definition? ( defspec set -- ? )
102 [ [ dup word-link? [ name>> ] when ] dip in? ]
103 [ [ dup vocab-link? [ lookup-vocab ] when ] dip in? ]
106 M: browser-gadget definitions-changed ( set browser -- )
107 [ control-value swap showing-definition? ] keep
108 '[ _ [ history-value ] keep set-history-value ] when ;
110 M: browser-gadget focusable-child* search-field>> ;
112 : (browser-window) ( topic -- )
118 : browser-window ( -- )
119 "help.home" (browser-window) ;
121 : error-help-window ( error -- )
124 [ dup tuple? [ class-of ] [ drop "errors" ] if ]
125 } 1|| (browser-window) ;
127 \ browser-window H{ { +nullary+ t } } define-command
129 : com-browse ( link -- )
130 [ browser-gadget? ] find-window
131 [ [ raise-window ] [ gadget-child show-help ] bi ]
132 [ (browser-window) ] if* ;
134 : show-browser ( -- )
135 [ browser-gadget? ] find-window
136 [ [ raise-window ] [ request-focus ] bi ] [ browser-window ] if* ;
138 \ show-browser H{ { +nullary+ t } } define-command
140 : com-back ( browser -- ) history>> go-back ;
142 : com-forward ( browser -- ) history>> go-forward ;
144 : com-home ( browser -- ) "help.home" swap show-help ;
146 : browser-help ( -- ) "ui-browser" com-browse ;
148 : glossary ( -- ) "conventions" com-browse ;
150 \ browser-help H{ { +nullary+ t } } define-command
151 \ glossary H{ { +nullary+ t } } define-command
153 browser-gadget "toolbar" f {
154 { T{ key-down f { A+ } "LEFT" } com-back }
155 { T{ key-down f { A+ } "RIGHT" } com-forward }
156 { T{ key-down f { A+ } "H" } com-home }
157 { T{ key-down f f "F1" } browser-help }
158 { T{ key-down f { A+ } "F1" } glossary }
161 : ?show-help ( link browser -- )
162 over [ show-help ] [ 2drop ] if ;
164 : navigate ( browser quot -- )
165 '[ control-value @ ] keep ?show-help ; inline
167 : com-up ( browser -- ) [ article-parent ] navigate ;
169 : com-prev ( browser -- ) [ prev-article ] navigate ;
171 : com-next ( browser -- ) [ next-article ] navigate ;
173 browser-gadget "navigation" "Commands for navigating in the article hierarchy" {
174 { T{ key-down f { A+ } "u" } com-up }
175 { T{ key-down f { A+ } "p" } com-prev }
176 { T{ key-down f { A+ } "n" } com-next }
177 { T{ key-down f { A+ } "k" } com-show-outgoing-links }
178 { T{ key-down f { A+ } "K" } com-show-incoming-links }
181 browser-gadget "multi-touch" f {
182 { left-action com-back }
183 { right-action com-forward }
186 browser-gadget "scrolling"
187 "The browser's scroller can be scrolled from the keyboard."
189 { T{ key-down f f "UP" } com-scroll-up }
190 { T{ key-down f f "DOWN" } com-scroll-down }
191 { T{ key-down f f "PAGE_UP" } com-page-up }
192 { T{ key-down f f "PAGE_DOWN" } com-page-down }
195 : com-font-size-plus ( browser -- )
196 2 adjust-help-font-size model>> notify-connections ;
198 : com-font-size-minus ( browser -- )
199 -2 adjust-help-font-size model>> notify-connections ;
201 browser-gadget "fonts" f {
202 { T{ key-down f { A+ } "+" } com-font-size-plus }
203 { T{ key-down f { A+ } "=" } com-font-size-plus }
204 { T{ key-down f { A+ } "_" } com-font-size-minus }
205 { T{ key-down f { A+ } "-" } com-font-size-minus }