mirror of
https://github.com/vale981/emacs-ipython-notebook
synced 2025-03-06 01:21:38 -05:00
274 lines
10 KiB
EmacsLisp
274 lines
10 KiB
EmacsLisp
;; -*- lexical-binding: t -*-
|
||
;;; ein-shared-output.el --- Output buffer for ein-connect.el
|
||
|
||
;; Copyright (C) 2012- Takafumi Arakaki
|
||
|
||
;; Author: Takafumi Arakaki <aka.tkf at gmail.com>
|
||
|
||
;; This file is NOT part of GNU Emacs.
|
||
|
||
;; ein-shared-output.el is free software: you can redistribute it and/or modify
|
||
;; it under the terms of the GNU General Public License as published by
|
||
;; the Free Software Foundation, either version 3 of the License, or
|
||
;; (at your option) any later version.
|
||
|
||
;; ein-shared-output.el is distributed in the hope that it will be useful,
|
||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
;; GNU General Public License for more details.
|
||
|
||
;; You should have received a copy of the GNU General Public License
|
||
;; along with ein-shared-output.el. If not, see <http://www.gnu.org/licenses/>.
|
||
|
||
;;; Commentary:
|
||
|
||
;; When executing code from outside of notebook, some place for output
|
||
;; is needed. This module buffer containing one special cell for that
|
||
;; purpose.
|
||
|
||
;;; Code:
|
||
|
||
(eval-when-compile (require 'cl))
|
||
(require 'eieio)
|
||
|
||
(require 'ein-cell)
|
||
|
||
|
||
;;; Classes and variables
|
||
|
||
(defclass ein:shared-output-cell (ein:codecell)
|
||
((cell-type :initarg :cell-type :initform "shared-output")
|
||
;; (element-names :initform (:prompt :output :footer))
|
||
(popup :initarg :popup :initform nil :type boolean)
|
||
)
|
||
"A singleton cell to show output from non-notebook buffers.")
|
||
|
||
(defclass ein:shared-output ()
|
||
((cell :initarg :cell :type ein:shared-output-cell)
|
||
(events :initarg :events :type ein:events)
|
||
(ewoc :initarg :ewoc :type ewoc)))
|
||
|
||
(defvar ein:%shared-output% nil
|
||
"Hold an instance of `ein:shared-output'.")
|
||
|
||
(defconst ein:shared-output-buffer-name "*ein:shared-output*")
|
||
|
||
|
||
;;; Cell related
|
||
|
||
(defmethod ein:cell-insert-prompt ((cell ein:shared-output-cell))
|
||
"Insert prompt of the CELL in the buffer.
|
||
Called from ewoc pretty printer via `ein:cell-pp'."
|
||
;; Newline is inserted in `ein:cell-insert-input'.
|
||
(ein:insert-read-only
|
||
(concat
|
||
(format "In [%s]" (or (ein:oref-safe cell 'input-prompt-number) " "))
|
||
(when (slot-value cell 'autoexec) " %s" ein:cell-autoexec-prompt))
|
||
'font-lock-face 'ein:cell-input-prompt))
|
||
|
||
(defmethod ein:cell-execute ((cell ein:shared-output-cell) kernel code
|
||
&optional popup &rest args)
|
||
(unless (plist-get args :silent)
|
||
(setq args (plist-put args :silent nil)))
|
||
(setf (slot-value cell 'popup) popup)
|
||
(setf (slot-value cell 'kernel) kernel)
|
||
(apply #'ein:cell-execute-internal cell kernel code args))
|
||
|
||
(defmethod ein:cell--handle-output ((cell ein:shared-output-cell)
|
||
msg-type content _metadata-not-used-)
|
||
;; Show short message
|
||
(ein:case-equal msg-type
|
||
(("pyout")
|
||
(let ((num (plist-get content :execution_count))
|
||
(text (plist-get (plist-get content :data) :text/plain)))
|
||
(when text
|
||
(ein:log 'info "Out[%s]: %s" num (car (split-string text "\n"))))))
|
||
(("stream")
|
||
(let ((stream (or (plist-get content :stream) "stdout"))
|
||
(text (plist-get content :data)))
|
||
(when text
|
||
(ein:log 'info "%s: %s" stream (car (split-string text "\n"))))))
|
||
(t
|
||
(ein:log 'info "Got output '%s' in the shared buffer." msg-type)))
|
||
;; Open `ein:shared-output-buffer-name' if necessary
|
||
(when (slot-value cell 'popup)
|
||
(pop-to-buffer (ein:shared-output-create-buffer)))
|
||
;; Finally do the normal drawing
|
||
(call-next-method))
|
||
|
||
|
||
;;; Main
|
||
|
||
(defun ein:shared-output-create-buffer ()
|
||
"Get or create the shared output buffer."
|
||
(get-buffer-create ein:shared-output-buffer-name))
|
||
|
||
(defun ein:shared-output-buffer ()
|
||
"Get the buffer associated with `ein:%shared-output%'."
|
||
(ewoc-buffer (slot-value ein:%shared-output% 'ewoc)))
|
||
|
||
(defun ein:shared-output-buffer-p (&optional buffer)
|
||
"Return non-`nil' when BUFFER (or current buffer) is shared-output buffer."
|
||
(eq (or buffer (current-buffer)) (ein:shared-output-buffer)))
|
||
|
||
(defun ein:shared-output-healthy-p ()
|
||
(and (ein:shared-output-p ein:%shared-output%)
|
||
(buffer-live-p (ein:shared-output-buffer))))
|
||
|
||
(defun ein:shared-output-get-or-create ()
|
||
(if (ein:shared-output-healthy-p)
|
||
ein:%shared-output%
|
||
(with-current-buffer (ein:shared-output-create-buffer)
|
||
;; FIXME: This is a duplication of `ein:worksheet-render'.
|
||
;; Must be merged.
|
||
(let* ((inhibit-read-only t)
|
||
;; Enable nonsep for ewoc object (the last argument is non-nil).
|
||
;; This is for putting read-only text properties to the newlines.
|
||
(ewoc (ein:ewoc-create 'ein:worksheet-pp
|
||
(ein:propertize-read-only "\n")
|
||
nil t))
|
||
(events (ein:events-new))
|
||
(cell (ein:shared-output-cell :ewoc ewoc
|
||
:events events)))
|
||
(erase-buffer)
|
||
(ein:shared-output-bind-events events)
|
||
(setq ein:%shared-output%
|
||
(ein:shared-output :ewoc ewoc :cell cell
|
||
:events events))
|
||
(ein:cell-enter-last cell))
|
||
(setq buffer-read-only t)
|
||
(ein:shared-output-mode)
|
||
ein:%shared-output%)))
|
||
|
||
(defun ein:shared-output-bind-events (events)
|
||
"Add dummy event handlers."
|
||
(ein:events-on events 'set_dirty.Worksheet #'ignore)
|
||
(ein:events-on events 'maybe_reset_undo.Worksheet #'ignore))
|
||
|
||
(defun ein:shared-output-get-cell ()
|
||
"Get the singleton shared output cell.
|
||
Create a cell if the buffer has none."
|
||
(slot-value (ein:shared-output-get-or-create) 'cell))
|
||
|
||
(defun ein:shared-output-get-kernel ()
|
||
(let ((cell (ein:shared-output-get-cell)))
|
||
(when (slot-boundp cell :kernel)
|
||
(slot-value cell 'kernel))))
|
||
|
||
;;;###autoload
|
||
(defun ein:shared-output-pop-to-buffer ()
|
||
"Open shared output buffer."
|
||
(interactive)
|
||
(ein:shared-output-get-or-create)
|
||
(pop-to-buffer (ein:shared-output-create-buffer)))
|
||
|
||
(defmethod ein:shared-output-show-code-cell ((cell ein:codecell))
|
||
"Show code CELL in shared-output buffer.
|
||
Note that this function assumed to be called in the buffer
|
||
where CELL locates."
|
||
(let ((new (ein:cell-convert cell "shared-output")))
|
||
;; Make sure `ein:%shared-output%' is initialized:
|
||
(ein:shared-output-get-or-create)
|
||
(with-current-buffer (ein:shared-output-create-buffer)
|
||
(let ((inhibit-read-only t)
|
||
(ein:cell-max-num-outputs nil))
|
||
(setf (slot-value new 'ewoc) (slot-value ein:%shared-output% 'ewoc))
|
||
(setf (slot-value new 'events) (slot-value ein:%shared-output% 'events))
|
||
(erase-buffer) ; because there are only one cell anyway
|
||
(setf (slot-value ein:%shared-output% 'cell) new)
|
||
(ein:cell-enter-last new)
|
||
(pop-to-buffer (current-buffer))))))
|
||
|
||
;;;###autoload
|
||
(defun ein:shared-output-show-code-cell-at-point ()
|
||
"Show code cell at point in shared-output buffer.
|
||
It is useful when the output of the cell at point is truncated.
|
||
See also `ein:cell-max-num-outputs'."
|
||
(interactive)
|
||
(let ((cell (ein:get-cell-at-point)))
|
||
(if (ein:codecell-p cell)
|
||
(ein:shared-output-show-code-cell cell)
|
||
(error "No code cell at point."))))
|
||
|
||
(defvar ein:shared-output-eval-string-history nil
|
||
"History of the `ein:shared-output-eval-string' prompt.")
|
||
|
||
;;;###autoload
|
||
(defun ein:shared-output-eval-string (code &optional popup verbose kernel
|
||
&rest args)
|
||
"Evaluate a piece of code. Prompt will appear asking the code to run.
|
||
This is handy when you want to execute something quickly without
|
||
making a cell. If the code outputs something, it will go to the
|
||
shared output buffer. You can open the buffer by the command
|
||
`ein:shared-output-pop-to-buffer'.
|
||
|
||
.. ARGS is passed to `ein:kernel-execute'. Unlike `ein:kernel-execute',
|
||
`:silent' is `nil' by default."
|
||
(interactive
|
||
(let ((kernel (ein:get-kernel-or-error))
|
||
;; ... so error will be raised before user typing code if it
|
||
;; is impossible to execute
|
||
(code (read-string
|
||
"IP[y]: "
|
||
(when (region-active-p)
|
||
(buffer-substring (region-beginning) (region-end)))
|
||
'ein:shared-output-eval-string-history)))
|
||
(list code nil t kernel)))
|
||
(unless kernel (setq kernel (ein:get-kernel-or-error)))
|
||
(let ((cell (ein:shared-output-get-cell)))
|
||
;; If cell is already running, wait until it is finished
|
||
;; before executing more code.
|
||
(deferred:$
|
||
(deferred:next
|
||
(deferred:lambda ()
|
||
(if (not (null (slot-value cell 'running)))
|
||
(deferred:nextc (deferred:wait 50) self))))
|
||
(deferred:nextc it
|
||
(lambda ()
|
||
(deferred:wait 100) ;; Give everyone a few milliseconds to breath.
|
||
(apply #'ein:cell-execute cell kernel (ein:trim-indent code) popup args)
|
||
(when verbose
|
||
(ein:log 'info "Code \"%s\" is sent to the kernel." code)))))))
|
||
|
||
|
||
;;; Generic getter
|
||
|
||
(defun ein:get-url-or-port--shared-output ()
|
||
(ein:aand (ein:get-kernel--shared-output) (ein:kernel-url-or-port it)))
|
||
|
||
;; (defun ein:get-notebook--shared-output ())
|
||
|
||
(defun ein:get-kernel--shared-output ()
|
||
(let ((cell (ein:get-cell-at-point--shared-output)))
|
||
(when (and (object-p cell) (slot-boundp cell :kernel))
|
||
(slot-value cell 'kernel))))
|
||
|
||
(defun ein:get-cell-at-point--shared-output ()
|
||
(when (and (ein:shared-output-p ein:%shared-output%)
|
||
(ein:shared-output-buffer-p))
|
||
(slot-value ein:%shared-output% 'cell)))
|
||
|
||
(defun ein:get-traceback-data--shared-output ()
|
||
(ein:aand (ein:get-cell-at-point--shared-output) (ein:cell-get-tb-data it)))
|
||
|
||
|
||
;;; ein:shared-output-mode
|
||
|
||
(defvar ein:shared-output-mode-map
|
||
(let ((map (make-sparse-keymap)))
|
||
(define-key map "\C-c\C-x" 'ein:tb-show)
|
||
(define-key map "\M-." 'ein:pytools-jump-to-source-command)
|
||
(define-key map (kbd "C-c C-.") 'ein:pytools-jump-to-source-command)
|
||
map)
|
||
"The map for ein:shared-output-mode-map.")
|
||
|
||
(define-derived-mode ein:shared-output-mode special-mode "ein:so"
|
||
"Shared output mode."
|
||
(font-lock-mode))
|
||
|
||
(add-hook 'ein:shared-output-mode-hook 'ein:truncate-lines-on)
|
||
|
||
|
||
(provide 'ein-shared-output)
|
||
|
||
;;; ein-shared-output.el ends here
|