From: "Jose E. Marchesi" <jemarch@gnu.org>
Subject: texinfo-eval-to-texi
Date: Wed, 5 May 2004 04:45:20 +0200 [thread overview]
Message-ID: <16536.21824.435501.414059@termi.eui.upm.es> (raw)
New patch taking care compact line spacing suggested by Adrian, the
shell-command like interface suggested by Kevin and the tips on
writing function documentation strings from the elisp user manual.
2004-04-30 Jose E. Marchesi <jemarch@gnu.org>
* textmodes/texinfo.el (texinfo-eval-to-texi): New function.
*** texinfo.el 21 Feb 2004 14:48:44 +0100 1.102
--- texinfo.el 05 May 2004 04:44:26 +0200
***************
*** 1050,1055 ****
--- 1050,1120 ----
;; job-number"\n"))
(tex-recenter-output-buffer nil))
+
+ (defun texinfo-eval-to-texi (form &optional insert)
+ "Evaluate FORM, and display the result into a @lisp Texinfo command.
+ With a prefix argument, insert the Texinfo command in the current buffer.
+
+ When called from Lisp, the command is returned as a string."
+ (interactive "sForm to evaluate: \nP")
+
+ (let (environment-text)
+ (setq environment-text
+ (with-temp-buffer
+ (condition-case error-description
+ (let (expression result output)
+ ;; Begin of the sample
+ (insert "@lisp\n")
+ ;; Dump the form itself into the sample
+ (let ((tform form))
+ (setq tform (replace-regexp-in-string "[@{}]" "@\\&" tform))
+ (insert tform "\n"))
+ ;; Parse the form to a valid expression
+ (setq expression (read form))
+ ;; Get the result of the eval, and the output if there is one
+ (setq output
+ (with-output-to-string
+ (setq result (prin1-to-string (eval expression)))))
+ ;; If there is any output, dump a @print{} entry into the sample
+ (if (not (equal output ""))
+ (progn
+ ;; Escape texinfo special characters on the output
+ (setq output (replace-regexp-in-string "[@{}]" "@\\&" output))
+ ;; Indent multilines
+ (setq output (replace-regexp-in-string "\n" "\n " output))
+ (insert " @print{} " output "\n")))
+ ;; If the expression is a macro, dump an @expansion{}
+ (let ((macroexp (macroexpand expression)))
+ (if (not (equal macroexp expression)) ; macrop???
+ (let ((met (prin1-to-string macroexp)))
+ ;; Escape texinfo special characters on the macro expansion text
+ (setq met (replace-regexp-in-string "[@{}]" "@\\&" met))
+ ;; Indent multilines
+ (setq met (replace-regexp-in-string "\n" "\n " met))
+ (insert " @expansion{} " met "\n"))))
+ ;; Escape texinfo special characters on the result
+ (setq result (replace-regexp-in-string "[@{}]" "@\\&" result))
+ ;; Indent multilines
+ (setq result (replace-regexp-in-string "\n" "\n " result))
+ ;; Dump the @result{} entry into the sample
+ (insert " @result{} " result "\n"))
+ ;; Was an error => Dump an @error{} entry into the sample with the error
+ ;; description from the interpreter
+ (error (insert " @error{} " (error-message-string error-description) "\n")))
+ ;; End of the sample
+ (insert "@end lisp")
+ ;; Return buffer's contents
+ (buffer-substring (point-min) (point-max))))
+
+ (if insert
+ (insert environment-text)
+ (with-output-to-temp-buffer "*Texinfo*"
+ (princ environment-text)))
+
+ environment-text))
+
+
+
(provide 'texinfo)
;;; arch-tag: 005d7c38-43b9-4b7d-aa1d-aea69bae73e1
reply other threads:[~2004-05-05 2:45 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=16536.21824.435501.414059@termi.eui.upm.es \
--to=jemarch@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).