1 ;;; ob-js.el --- Babel Functions for Javascript -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2010-2016 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research, js
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Now working with SBCL for both session and external evaluation.
28 ;; This certainly isn't optimally robust, but it seems to be working
29 ;; for the basic use cases.
33 ;; - a non-browser javascript engine such as node.js http://nodejs.org/
34 ;; or mozrepl http://wiki.github.com/bard/mozrepl/
36 ;; - for session based evaluation mozrepl and moz.el are required see
37 ;; http://wiki.github.com/bard/mozrepl/emacs-integration for
38 ;; configuration instructions
43 (declare-function run-mozilla
"ext:moz" (arg))
45 (defvar org-babel-default-header-args
:js
'()
46 "Default header arguments for js code blocks.")
48 (defvar org-babel-js-eoe
"org-babel-js-eoe"
49 "String to indicate that evaluation has completed.")
51 (defcustom org-babel-js-cmd
"node"
52 "Name of command used to evaluate js blocks."
57 (defvar org-babel-js-function-wrapper
58 "require('sys').print(require('sys').inspect(function(){%s}()));"
59 "Javascript code to print value of body.")
61 (defun org-babel-execute:js
(body params
)
62 "Execute a block of Javascript code with org-babel.
63 This function is called by `org-babel-execute-src-block'"
64 (let* ((org-babel-js-cmd (or (cdr (assoc :cmd params
)) org-babel-js-cmd
))
65 (result-type (cdr (assoc :result-type params
)))
66 (full-body (org-babel-expand-body:generic
67 body params
(org-babel-variable-assignments:js params
)))
68 (result (if (not (string= (cdr (assoc :session params
)) "none"))
70 (let ((session (org-babel-prep-session:js
71 (cdr (assoc :session params
)) params
)))
73 (org-babel-comint-with-output
74 (session (format "%S" org-babel-js-eoe
) t body
)
77 (insert (org-babel-chomp line
))
78 (comint-send-input nil t
))
79 (list body
(format "%S" org-babel-js-eoe
))))))
80 ;; external evaluation
81 (let ((script-file (org-babel-temp-file "js-script-")))
82 (with-temp-file script-file
84 ;; return the value or the output
85 (if (string= result-type
"value")
86 (format org-babel-js-function-wrapper full-body
)
89 (format "%s %s" org-babel-js-cmd
90 (org-babel-process-file-name script-file
)) "")))))
91 (org-babel-result-cond (cdr (assoc :result-params params
))
92 result
(org-babel-js-read result
))))
94 (defun org-babel-js-read (results)
95 "Convert RESULTS into an appropriate elisp value.
96 If RESULTS look like a table, then convert them into an
97 Emacs-lisp table, otherwise return the results as a string."
99 (if (and (stringp results
) (string-match "^\\[[^\000]+\\]$" results
))
102 (replace-regexp-in-string
103 "\\[" "(" (replace-regexp-in-string
104 "\\]" ")" (replace-regexp-in-string
106 (replace-regexp-in-string
107 "'" "\"" results
))))))
110 (defun org-babel-js-var-to-js (var)
111 "Convert VAR into a js variable.
112 Convert an elisp value into a string of js source code
113 specifying a variable of the same value."
115 (concat "[" (mapconcat #'org-babel-js-var-to-js var
", ") "]")
116 (replace-regexp-in-string "\n" "\\\\n" (format "%S" var
))))
118 (defun org-babel-prep-session:js
(session params
)
119 "Prepare SESSION according to the header arguments specified in PARAMS."
120 (let* ((session (org-babel-js-initiate-session session
))
121 (var-lines (org-babel-variable-assignments:js params
)))
123 (org-babel-comint-in-buffer session
124 (sit-for .5) (goto-char (point-max))
126 (insert var
) (comint-send-input nil t
)
127 (org-babel-comint-wait-for-output session
)
128 (sit-for .1) (goto-char (point-max))) var-lines
)))
131 (defun org-babel-variable-assignments:js
(params)
132 "Return list of Javascript statements assigning the block's variables."
134 (lambda (pair) (format "var %s=%s;"
135 (car pair
) (org-babel-js-var-to-js (cdr pair
))))
136 (org-babel--get-vars params
)))
138 (defun org-babel-js-initiate-session (&optional session
)
139 "If there is not a current inferior-process-buffer in SESSION
140 then create. Return the initialized session."
141 (unless (string= session
"none")
143 ((string= "mozrepl" org-babel-js-cmd
)
145 (let ((session-buffer (save-window-excursion
147 (rename-buffer session
)
149 (if (org-babel-comint-buffer-livep session-buffer
)
150 (progn (sit-for .25) session-buffer
)
152 (org-babel-js-initiate-session session
))))
153 ((string= "node" org-babel-js-cmd
)
154 (error "Session evaluation with node.js is not supported"))
156 (error "Sessions are only supported with mozrepl add \":cmd mozrepl\"")))))
162 ;;; ob-js.el ends here