1 ;;; fuel-markup.el -- printing factor help markup
3 ;; Copyright (C) 2009 Jose Antonio Ortega Ruiz
4 ;; See http://factorcode.org/license.txt for BSD license.
6 ;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
7 ;; Keywords: languages, fuel, factor
8 ;; Start date: Thu Jan 01, 2009 21:43
12 ;; Utilities for printing Factor's help markup.
17 (require 'fuel-font-lock)
26 (fuel-font-lock--defface fuel-font-lock-markup-title
27 'bold fuel-help "article titles in help buffers")
29 (fuel-font-lock--defface fuel-font-lock-markup-heading
30 'bold fuel-help "headlines in help buffers")
32 (fuel-font-lock--defface fuel-font-lock-markup-link
33 'link fuel-help "links to topics in help buffers")
35 (fuel-font-lock--defface fuel-font-lock-markup-emphasis
36 'italic fuel-help "emphasized words in help buffers")
38 (fuel-font-lock--defface fuel-font-lock-markup-strong
39 'link fuel-help "bold words in help buffers")
44 (make-variable-buffer-local
45 (defvar fuel-markup--follow-link-function 'fuel-markup--echo-link))
47 (define-button-type 'fuel-markup--button
48 'action 'fuel-markup--follow-link
49 'face 'fuel-font-lock-markup-link
52 (defun fuel-markup--follow-link (button)
53 (when fuel-markup--follow-link-function
54 (funcall fuel-markup--follow-link-function
55 (button-get button 'markup-link)
56 (button-get button 'markup-label)
57 (button-get button 'markup-link-type))))
59 (defun fuel-markup--echo-link (link label type)
60 (message "Link %s pointing to %s named %s" label type link))
62 (defun fuel-markup--insert-button (label link type)
63 (let ((label (format "%s" label))
64 (link (if (listp link) link (format "%s" link))))
65 (insert-text-button label
66 :type 'fuel-markup--button
69 'markup-link-type type
70 'help-echo (format "%s (%s)" label type))))
72 (defun fuel-markup--article-title (name)
73 (let ((name (if (listp name) (cons :seq name) name)))
74 (fuel-eval--retort-result
75 (fuel-eval--send/wait `(:fuel* ((,name fuel-get-article-title)) "fuel")))))
77 (defun fuel-markup--link-at-point ()
78 (let ((button (condition-case nil (forward-button 0) (error nil))))
80 (list (button-get button 'markup-link)
81 (button-get button 'markup-label)
82 (button-get button 'markup-link-type)))))
87 (defconst fuel-markup--printers
88 '(($all-tags . fuel-markup--all-tags)
89 ($all-authors . fuel-markup--all-authors)
90 ($author . fuel-markup--author)
91 ($authors . fuel-markup--authors)
92 ($class-description . fuel-markup--class-description)
93 ($code . fuel-markup--code)
94 ($command . fuel-markup--command)
95 ($command-map . fuel-markup--null)
96 ($contract . fuel-markup--contract)
97 ($curious . fuel-markup--curious)
98 ($definition . fuel-markup--definition)
99 ($describe-vocab . fuel-markup--describe-vocab)
100 ($description . fuel-markup--description)
101 ($doc-path . fuel-markup--doc-path)
102 ($emphasis . fuel-markup--emphasis)
103 ($error-description . fuel-markup--error-description)
104 ($errors . fuel-markup--errors)
105 ($example . fuel-markup--example)
106 ($examples . fuel-markup--examples)
107 ($heading . fuel-markup--heading)
108 ($index . fuel-markup--index)
109 ($instance . fuel-markup--instance)
110 ($io-error . fuel-markup--io-error)
111 ($link . fuel-markup--link)
112 ($links . fuel-markup--links)
113 ($list . fuel-markup--list)
114 ($low-level-note . fuel-markup--low-level-note)
115 ($markup-example . fuel-markup--markup-example)
116 ($maybe . fuel-markup--maybe)
117 ($methods . fuel-markup--methods)
118 ($nl . fuel-markup--newline)
119 ($notes . fuel-markup--notes)
120 ($operation . fuel-markup--link)
121 ($parsing-note . fuel-markup--parsing-note)
122 ($predicate . fuel-markup--predicate)
123 ($prettyprinting-note . fuel-markup--prettyprinting-note)
124 ($quotation . fuel-markup--quotation)
125 ($references . fuel-markup--references)
126 ($related . fuel-markup--related)
127 ($see . fuel-markup--see)
128 ($see-also . fuel-markup--see-also)
129 ($shuffle . fuel-markup--shuffle)
130 ($side-effects . fuel-markup--side-effects)
131 ($slot . fuel-markup--snippet)
132 ($snippet . fuel-markup--snippet)
133 ($strong . fuel-markup--strong)
134 ($subheading . fuel-markup--subheading)
135 ($subsection . fuel-markup--subsection)
136 ($synopsis . fuel-markup--synopsis)
137 ($syntax . fuel-markup--syntax)
138 ($table . fuel-markup--table)
139 ($tag . fuel-markup--tag)
140 ($tags . fuel-markup--tags)
141 ($unchecked-example . fuel-markup--example)
142 ($value . fuel-markup--value)
143 ($values . fuel-markup--values)
144 ($values-x/y . fuel-markup--values-x/y)
145 ($var-description . fuel-markup--var-description)
146 ($vocab-link . fuel-markup--vocab-link)
147 ($vocab-links . fuel-markup--vocab-links)
148 ($vocab-subsection . fuel-markup--vocab-subsection)
149 ($vocabulary . fuel-markup--vocabulary)
150 ($warning . fuel-markup--warning)
151 (article . fuel-markup--article)
152 (describe-words . fuel-markup--describe-words)
153 (vocab-list . fuel-markup--vocab-list)))
155 (make-variable-buffer-local
156 (defvar fuel-markup--maybe-nl nil))
158 (defun fuel-markup--print (e)
159 (cond ((null e) (insert "f"))
160 ((stringp e) (fuel-markup--insert-string e))
161 ((and (listp e) (symbolp (car e))
162 (assoc (car e) fuel-markup--printers))
163 (funcall (cdr (assoc (car e) fuel-markup--printers)) e))
165 (assoc e fuel-markup--printers))
166 (funcall (cdr (assoc e fuel-markup--printers)) e))
167 ((listp e) (mapc 'fuel-markup--print e))
168 ((symbolp e) (fuel-markup--print (list '$link e)))
169 (t (insert (format "\n%S\n" e)))))
171 (defun fuel-markup--print-str (e)
173 (fuel-markup--print e)
176 (defun fuel-markup--maybe-nl ()
177 (setq fuel-markup--maybe-nl (point)))
179 (defun fuel-markup--insert-newline (&optional justification nosqueeze)
180 (fill-region (save-excursion (beginning-of-line) (point))
182 (or justification 'left)
186 (defsubst fuel-markup--insert-nl-if-nb (&optional no-fill)
187 (unless (eq (save-excursion (beginning-of-line) (point)) (point))
188 (if no-fill (newline) (fuel-markup--insert-newline))))
190 (defsubst fuel-markup--put-face (txt face)
191 (put-text-property 0 (length txt) 'font-lock-face face txt)
194 (defun fuel-markup--insert-heading (txt &optional no-nl)
195 (fuel-markup--insert-nl-if-nb)
197 (unless (bobp) (newline))
198 (fuel-markup--put-face txt 'fuel-font-lock-markup-heading)
199 (fuel-markup--insert-string txt)
200 (unless no-nl (newline)))
202 (defun fuel-markup--insert-string (str)
203 (when fuel-markup--maybe-nl
205 (setq fuel-markup--maybe-nl nil))
208 (defun fuel-markup--article (e)
209 (setq fuel-markup--maybe-nl nil)
210 (insert (fuel-markup--put-face (cadr e) 'fuel-font-lock-markup-title))
212 (fuel-markup--print (car (cddr e))))
214 (defun fuel-markup--heading (e)
215 (fuel-markup--insert-heading (cadr e)))
217 (defun fuel-markup--subheading (e)
218 (fuel-markup--insert-heading (cadr e)))
220 (defun fuel-markup--subsection (e)
221 (fuel-markup--insert-nl-if-nb)
223 (fuel-markup--link (cons '$link (cdr e)))
224 (fuel-markup--maybe-nl))
226 (defun fuel-markup--vocab-subsection (e)
227 (fuel-markup--insert-nl-if-nb)
229 (fuel-markup--vocab-link (cons '$vocab-link (cdr e)))
230 (fuel-markup--maybe-nl))
232 (defun fuel-markup--newline (e)
233 (fuel-markup--insert-newline)
236 (defun fuel-markup--doc-path (e)
237 (fuel-markup--insert-heading "Related topics")
239 (dolist (art (cdr e))
240 (fuel-markup--insert-button (car art) (cadr art) 'article)
242 (delete-backward-char 2)
243 (fuel-markup--insert-newline 'left))
245 (defun fuel-markup--emphasis (e)
246 (when (stringp (cadr e))
247 (fuel-markup--put-face (cadr e) 'fuel-font-lock-markup-emphasis)
250 (defun fuel-markup--strong (e)
251 (when (stringp (cadr e))
252 (fuel-markup--put-face (cadr e) 'fuel-font-lock-markup-strong)
255 (defun fuel-markup--snippet (e)
256 (insert (mapconcat '(lambda (s)
258 (fuel-font-lock--factor-str s)
259 (fuel-markup--print-str s)))
263 (defun fuel-markup--code (e)
264 (fuel-markup--insert-nl-if-nb)
266 (dolist (snip (cdr e))
268 (insert (fuel-font-lock--factor-str snip))
269 (fuel-markup--print snip))
273 (defun fuel-markup--command (e)
274 (fuel-markup--snippet (list '$snippet (nth 3 e))))
276 (defun fuel-markup--syntax (e)
277 (fuel-markup--insert-heading "Syntax")
278 (fuel-markup--print (cons '$code (cdr e)))
281 (defun fuel-markup--example (e)
282 (fuel-markup--insert-newline)
284 (fuel-markup--snippet (list '$snippet s))
287 (defun fuel-markup--markup-example (e)
288 (fuel-markup--insert-newline)
289 (fuel-markup--snippet (cons '$snippet (cdr e))))
291 (defun fuel-markup--link (e)
292 (let* ((link (or (nth 1 e) 'f))
293 (type (or (nth 3 e) (if (symbolp link) 'word 'article)))
295 (and (eq type 'article)
296 (fuel-markup--article-title link))
298 (fuel-markup--insert-button label link type)))
300 (defun fuel-markup--links (e)
301 (dolist (link (cdr e))
302 (fuel-markup--link (list '$link link))
304 (delete-backward-char 2))
306 (defun fuel-markup--index-quotation (q)
307 (cond ((null q) null)
308 ((listp q) (vconcat (mapcar 'fuel-markup--index-quotation q)))
311 (defun fuel-markup--index (e)
312 (let* ((q (fuel-markup--index-quotation (cadr e)))
313 (cmd `(:fuel* ((,q fuel-index)) "fuel"
314 ("builtins" "help" "help.topics" "classes"
315 "classes.builtin" "classes.tuple"
316 "classes.singleton" "classes.union"
317 "classes.intersection" "classes.predicate")))
318 (subs (fuel-eval--retort-result (fuel-eval--send/wait cmd 200))))
320 (let ((start (point))
321 (sort-fold-case nil))
322 (fuel-markup--print subs)
323 (sort-lines nil start (point))))))
325 (defun fuel-markup--vocab-link (e)
326 (fuel-markup--insert-button (cadr e) (or (car (cddr e)) (cadr e)) 'vocab))
328 (defun fuel-markup--vocab-links (e)
329 (dolist (link (cdr e))
331 (fuel-markup--vocab-link (list '$vocab-link link))
334 (defun fuel-markup--vocab-list (e)
335 (let ((rows (mapcar '(lambda (elem)
337 (list '$vocab-link (cadr elem))
340 (fuel-markup--table (cons '$table rows))))
342 (defun fuel-markup--describe-vocab (e)
343 (fuel-markup--insert-nl-if-nb)
344 (let* ((cmd `(:fuel* ((,(cadr e) fuel-vocab-help)) "fuel" t))
345 (res (fuel-eval--retort-result (fuel-eval--send/wait cmd))))
346 (when res (fuel-markup--print res))))
348 (defun fuel-markup--vocabulary (e)
349 (fuel-markup--insert-heading "Vocabulary: " t)
350 (fuel-markup--vocab-link (cons '$vocab-link (cdr e)))
353 (defun fuel-markup--parse-classes ()
355 (while (looking-at ".+ classes$")
356 (let ((heading `($heading ,(match-string-no-properties 0)))
359 (when (looking-at "Class *.+$")
360 (push (split-string (match-string-no-properties 0) nil t) rows)
362 (while (not (looking-at "$"))
363 (let* ((objs (split-string (thing-at-point 'line) nil t))
364 (class (list '$link (car objs) (car objs) 'word))
365 (super (and (cadr objs)
366 (list (list '$link (cadr objs) (cadr objs) 'word))))
367 (slots (when (cddr objs)
368 (list (mapcar '(lambda (s) (list s " ")) (cddr objs))))))
369 (push `(,class ,@super ,@slots) rows))
371 (push `(,heading ($table ,@(reverse rows))) elems))
375 (defun fuel-markup--parse-words ()
377 (while (looking-at ".+ words\\|Primitives$")
378 (let ((heading `($heading ,(match-string-no-properties 0)))
381 (when (looking-at "Word *\\(Stack effect\\|Syntax\\)$")
382 (push (list "Word" (match-string-no-properties 1)) rows)
384 (while (looking-at "\\(.+?\\)\\( +\\(.+\\)\\)?$")
385 (let ((word `($link ,(match-string-no-properties 1)
386 ,(match-string-no-properties 1)
388 (se (and (match-string-no-properties 3)
389 `(($snippet ,(match-string-no-properties 3))))))
390 (push `(,word ,@se) rows))
392 (push `(,heading ($table ,@(reverse rows))) elems))
396 (defun fuel-markup--parse-words-desc (desc)
399 (goto-char (point-min))
400 (when (re-search-forward "^Words$" nil t)
402 (let ((elems '(($heading "Words"))))
403 (push (fuel-markup--parse-classes) elems)
404 (push (fuel-markup--parse-words) elems)
407 (defun fuel-markup--describe-words (e)
409 (fuel-markup--print (fuel-markup--parse-words-desc (cadr e)))))
411 (defun fuel-markup--tag (e)
412 (fuel-markup--link (list '$link (cadr e) (cadr e) 'tag)))
414 (defun fuel-markup--tags (e)
416 (fuel-markup--insert-heading "Tags: " t)
417 (dolist (tag (cdr e))
418 (fuel-markup--tag (list '$tag tag))
420 (delete-backward-char 2)
421 (fuel-markup--insert-newline)))
423 (defun fuel-markup--all-tags (e)
424 (let* ((cmd `(:fuel* (all-tags :get) "fuel" t))
425 (tags (fuel-eval--retort-result (fuel-eval--send/wait cmd))))
427 (cons '$list (mapcar (lambda (tag) (list '$link tag tag 'tag)) tags)))))
429 (defun fuel-markup--author (e)
430 (fuel-markup--link (list '$link (cadr e) (cadr e) 'author)))
432 (defun fuel-markup--authors (e)
434 (fuel-markup--insert-heading "Authors: " t)
436 (fuel-markup--author (list '$author a))
438 (delete-backward-char 2)
439 (fuel-markup--insert-newline)))
441 (defun fuel-markup--all-authors (e)
442 (let* ((cmd `(:fuel* (all-authors :get) "fuel" t))
443 (authors (fuel-eval--retort-result (fuel-eval--send/wait cmd))))
445 (cons '$list (mapcar (lambda (a) (list '$link a a 'author)) authors)))))
447 (defun fuel-markup--list (e)
448 (fuel-markup--insert-nl-if-nb)
449 (dolist (elt (cdr e))
451 (fuel-markup--print elt)
452 (fuel-markup--insert-newline)))
454 (defun fuel-markup--table (e)
455 (fuel-markup--insert-newline)
459 (mapcar '(lambda (row) (mapcar 'fuel-markup--print-str row)) (cdr e)))
462 (defun fuel-markup--instance (e)
463 (insert " an instance of ")
464 (fuel-markup--print (cadr e)))
466 (defun fuel-markup--maybe (e)
467 (fuel-markup--instance (cons '$instance (cdr e)))
470 (defun fuel-markup--values (e)
471 (fuel-markup--insert-heading "Inputs and outputs")
472 (dolist (val (cdr e))
473 (insert " " (car val) " - ")
474 (fuel-markup--print (cdr val))
477 (defun fuel-markup--predicate (e)
478 (fuel-markup--values '($values ("object" object) ("?" "a boolean")))
479 (let ((word (make-symbol (substring (format "%s" (cadr e)) 0 -1))))
480 (fuel-markup--description
481 `($description "Tests if the object is an instance of the "
482 ($link ,word) " class."))))
484 (defun fuel-markup--side-effects (e)
485 (fuel-markup--insert-heading "Side effects")
487 (fuel-markup--print (cdr e))
488 (fuel-markup--insert-newline))
490 (defun fuel-markup--definition (e)
491 (fuel-markup--insert-heading "Definition")
492 (fuel-markup--code (cons '$code (cdr e))))
494 (defun fuel-markup--methods (e)
495 (fuel-markup--insert-heading "Methods")
496 (fuel-markup--code (cons '$code (cdr e))))
498 (defun fuel-markup--value (e)
499 (fuel-markup--insert-heading "Variable value")
500 (insert "Current value in global namespace: ")
501 (fuel-markup--snippet (cons '$snippet (cdr e)))
504 (defun fuel-markup--values-x/y (e)
505 (fuel-markup--values '($values ("x" "number") ("y" "number"))))
507 (defun fuel-markup--curious (e)
508 (fuel-markup--insert-heading "For the curious...")
509 (fuel-markup--print (cdr e)))
511 (defun fuel-markup--references (e)
512 (fuel-markup--insert-heading "References")
513 (dolist (ref (cdr e))
515 (fuel-markup--print ref)
516 (fuel-markup--subsection (list '$subsection ref)))))
518 (defun fuel-markup--see-also (e)
519 (fuel-markup--insert-heading "See also")
520 (fuel-markup--links (cons '$links (cdr e))))
522 (defun fuel-markup--related (e)
523 (fuel-markup--insert-heading "See also")
524 (fuel-markup--links (cons '$links (cadr e))))
526 (defun fuel-markup--shuffle (e)
527 (insert "\nShuffle word. Re-arranges the stack "
528 "according to the stack effect pattern.")
529 (fuel-markup--insert-newline))
531 (defun fuel-markup--low-level-note (e)
532 (fuel-markup--print '($notes "Calling this word directly is not necessary "
534 "Higher-level words call it automatically.")))
536 (defun fuel-markup--parsing-note (e)
537 (fuel-markup--insert-nl-if-nb)
538 (insert "This word should only be called from parsing words.")
539 (fuel-markup--insert-newline))
541 (defun fuel-markup--io-error (e)
542 (fuel-markup--errors '($errors "Throws an error if the I/O operation fails.")))
544 (defun fuel-markup--prettyprinting-note (e)
545 (fuel-markup--print '($notes ("This word should only be called within the "
546 ($link with-pprint) " combinator."))))
548 (defun fuel-markup--elem-with-heading (elem heading)
549 (fuel-markup--insert-heading heading)
550 (fuel-markup--print (cdr elem))
551 (fuel-markup--insert-newline))
553 (defun fuel-markup--quotation (e)
555 (fuel-markup--link (list '$link 'quotation 'quotation 'word))
556 (insert " with stack effect ")
557 (fuel-markup--snippet (list '$snippet (nth 1 e))))
559 (defun fuel-markup--warning (e)
560 (fuel-markup--elem-with-heading e "Warning"))
562 (defun fuel-markup--description (e)
563 (fuel-markup--elem-with-heading e "Word description"))
565 (defun fuel-markup--class-description (e)
566 (fuel-markup--elem-with-heading e "Class description"))
568 (defun fuel-markup--error-description (e)
569 (fuel-markup--elem-with-heading e "Error description"))
571 (defun fuel-markup--var-description (e)
572 (fuel-markup--elem-with-heading e "Variable description"))
574 (defun fuel-markup--contract (e)
575 (fuel-markup--elem-with-heading e "Generic word contract"))
577 (defun fuel-markup--errors (e)
578 (fuel-markup--elem-with-heading e "Errors"))
580 (defun fuel-markup--examples (e)
581 (fuel-markup--elem-with-heading e "Examples"))
583 (defun fuel-markup--notes (e)
584 (fuel-markup--elem-with-heading e "Notes"))
586 (defun fuel-markup--word-info (e s)
587 (let* ((word (nth 1 e))
588 (cmd (and word `(:fuel* ((:quote ,(format "%s" word)) ,s) "fuel")))
589 (ret (and cmd (fuel-eval--send/wait cmd)))
590 (res (and (not (fuel-eval--retort-error ret))
591 (fuel-eval--retort-output ret))))
593 (fuel-markup--code (list '$code res))
594 (fuel-markup--snippet (list '$snippet " " word)))))
596 (defun fuel-markup--see (e)
597 (fuel-markup--word-info e 'see))
599 (defun fuel-markup--synopsis (e)
600 (fuel-markup--word-info e 'synopsis))
602 (defun fuel-markup--null (e))
605 (provide 'fuel-markup)
606 ;;; fuel-markup.el ends here