Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up documentation #16

Merged
merged 13 commits into from
Mar 28, 2018
Merged

Clean up documentation #16

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6c050ce
Add hyphenation in docstring of org-babel-header-args:prolog
lafrenierejm Mar 28, 2018
69b2271
Add docstring to org-babel-prolog--elisp-to-pl
lafrenierejm Mar 28, 2018
da9d8be
Add docstring to org-babel-prolog--variable-assignment
lafrenierejm Mar 28, 2018
d5467fc
Add docstring to org-babel-variable-assignments:prolog
lafrenierejm Mar 28, 2018
44dd096
Revise docstring of org-babel-prolog--parse-goal
lafrenierejm Mar 28, 2018
d1f1479
Revise docstring of org-babel-execute:prolog
lafrenierejm Mar 28, 2018
260566b
Revise docstring of org-babel-prolog-evaluate-external-process
lafrenierejm Mar 28, 2018
9855c41
Revise docstring of org-babel-prolog-evaluate-session
lafrenierejm Mar 28, 2018
8b574d0
Add docstring to org-babel-prolog--answer-correction
lafrenierejm Mar 28, 2018
77b2d97
Add docstring to org-babel-prolog--exit-debug
lafrenierejm Mar 28, 2018
50a6145
Revise docstring of org-babel-prolog-initiate-session
lafrenierejm Mar 28, 2018
58811e5
Use two spaces after sentences in the top matter commentary
lafrenierejm Mar 28, 2018
ddb19fc
Revise docstring of org-babel-load-session:prolog
lafrenierejm Mar 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 34 additions & 14 deletions ob-prolog.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
;; install using the package manager.
;;
;; In addition to the normal header arguments ob-prolog also supports
;; the :goal argument. :goal is the goal that prolog will run when
;; executing the source block. Prolog needs a goal to know what it is
;; the :goal argument. :goal is the goal that prolog will run when
;; executing the source block. Prolog needs a goal to know what it is
;; going to execute.
;;

Expand All @@ -58,13 +58,14 @@

(defconst org-babel-header-args:prolog
'((:goal . :any))
"Prolog specific header arguments.")
"Prolog-specific header arguments.")


(defvar org-babel-default-header-args:prolog
`((:goal . nil)))

(defun org-babel-prolog--elisp-to-pl (value)
"Convert the Emacs Lisp VALUE to equivalent Prolog."
(cond ((stringp value)
(format "'%s'"
(replace-regexp-in-string
Expand All @@ -77,11 +78,22 @@
(t (prin1-to-string value))))

(defun org-babel-prolog--variable-assignment (pair)
"Return a string of a recorda/2 assertion of (cdr PAIR) under (car PAIR).

The Emacs Lisp value of the car of PAIR is used as the Key argument to
recorda/2 without modification. The cdr of PAIR is converted to
equivalent Prolog before being provided as the Term argument to
recorda/2."
(format "recorda('%s', %s)"
(car pair)
(org-babel-prolog--elisp-to-pl (cdr pair))))

(defun org-babel-variable-assignments:prolog (params)
"Return the babel variable assignments in PARAMS.

PARAMS is a quasi-alist of header args, which may contain
multiple entries for the key `:var'. This function returns a
list of the cdr of all the `:var' entries."
(let (vars)
(dolist (param params vars)
(when (eq (car param) :var)
Expand All @@ -91,7 +103,7 @@
(list (concat ":- " (mapconcat #'identity vars ", ") ".\n")))))

(defun org-babel-prolog--parse-goal (goal)
"Evaluate inline emacs-lisp in prolog goal parameter.
"Evaluate the inline Emacs Lisp in GOAL.

Example:
append(=(+ 2 3), =(quote a), B)
Expand All @@ -108,8 +120,9 @@ Example:
(buffer-string))))

(defun org-babel-execute:prolog (body params)
"Execute a block of Prolog code with org-babel. This function is
called by `org-babel-execute-src-block'"
"Execute the Prolog in BODY according to the block's header PARAMS.

This function is called by `org-babel-execute-src-block.'"
(message "executing Prolog source code block")
(let* ((result-params (cdr (assq :result-params params)))
(session (cdr (assq :session params)))
Expand All @@ -135,16 +148,19 @@ called by `org-babel-execute-src-block'"
(cdr (assq :rownames params)))))))

(defun org-babel-load-session:prolog (session body params)
"Load BODY into SESSION."
"Return initialized Prolog SESSION.

BODY and PARAMS are both unused."
(let* ((params (org-babel-process-params params))
(session (org-babel-prolog-initiate-session
(cdr (assq :session session)))))
(org-babel-prolog-initiate-session session)))

(defun org-babel-prolog-evaluate-external-process (goal body)
"Evaluates the GOAL given the BODY in a external Prolog
process. If no GOAL is given the GOAL is replaced with HALT,
resulting in running just the body through the Prolog process."
"Evaluate the GOAL given the BODY in an external Prolog process.

If no GOAL is given, the GOAL is replaced with HALT. This resulsts in
running just the body through the Prolog process."
(let* ((tmp-file (org-babel-temp-file "prolog-"))
(command (format "%s -q -l %s -t \"%s\""
org-babel-prolog-command
Expand All @@ -156,8 +172,9 @@ resulting in running just the body through the Prolog process."
(org-babel-eval command "")))

(defun org-babel-prolog-evaluate-session (session goal body)
"Evaluates the GOAL in the BODY of the prolog block in the
given SESSION. If there is no SESSION it creates it."
"In SESSION, evaluate GOAL given the BODY of the Prolog block.

Create SESSION if it does not already exist."
(let* ((session (org-babel-prolog-initiate-session session))
(body (split-string (org-babel-trim body) "\n")))
(org-babel-trim
Expand Down Expand Up @@ -204,18 +221,21 @@ given SESSION. If there is no SESSION it creates it."
(buffer-string)))))))

(defun org-babel-prolog--answer-correction (string)
"If STRING is Prolog's \"Correct to:\" prompt, send a refusal."
(when (string-match-p "Correct to: \".*\"\\?" string)
(insert "no")
(comint-send-input nil t)))

(defun org-babel-prolog--exit-debug (string)
"If STRING indicates an exception, continue Prolog execution in no debug mode."
(when (string-match-p "\\(.\\|\n\\)*Exception.* \\? $" string)
(insert "no debug")
(comint-send-input nil t)))

(defun org-babel-prolog-initiate-session (&optional session)
"If there is not a current inferior-process-buffer in SESSION
then create. Return the initialized session."
"Return SESSION with a current inferior-process-buffer.

Initialize SESSION if it has not already been initialized."
(unless (string= session "none")
(let ((session (get-buffer-create (or session "*prolog*"))))
(unless (comint-check-proc session)
Expand Down