2015-01-27 03:51:47 +00:00
|
|
|
|
;;; core-spacemacs-buffer.el --- Spacemacs Core File
|
2015-01-26 03:36:07 +00:00
|
|
|
|
;;
|
|
|
|
|
;; Copyright (c) 2012-2014 Sylvain Benner
|
|
|
|
|
;; Copyright (c) 2014-2015 Sylvain Benner & Contributors
|
|
|
|
|
;;
|
|
|
|
|
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
|
|
|
|
|
;; URL: https://github.com/syl20bnr/spacemacs
|
|
|
|
|
;;
|
|
|
|
|
;; This file is not part of GNU Emacs.
|
|
|
|
|
;;
|
|
|
|
|
;;; License: GPLv3
|
2015-02-04 04:56:52 +00:00
|
|
|
|
(defconst spacemacs-buffer-name "*spacemacs*"
|
|
|
|
|
"The name of the spacemacs buffer.")
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defconst spacemacs-buffer--banner-length 75
|
2015-03-13 03:55:38 +00:00
|
|
|
|
"Width of a banner.")
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-13 06:17:48 +00:00
|
|
|
|
(defconst spacemacs-buffer--cache-file
|
|
|
|
|
(expand-file-name (concat spacemacs-cache-directory "spacemacs-buffer.el"))
|
|
|
|
|
"Cache file for various persistent data for the spacemacs startup buffer")
|
|
|
|
|
|
|
|
|
|
(defvar spacemacs-buffer--release-note-version nil
|
|
|
|
|
"If nil the release note is displayed. If non nil it contains
|
|
|
|
|
a version number, if the version number is lesser than the current
|
|
|
|
|
version the release note it displayed")
|
|
|
|
|
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(defvar spacemacs-buffer--note-widgets nil
|
2015-04-13 06:17:48 +00:00
|
|
|
|
"List of widgets used to display the release note.")
|
2015-04-04 14:33:04 +00:00
|
|
|
|
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(defvar spacemacs-buffer--previous-insert-type nil
|
|
|
|
|
"Previous type of note inserted.")
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/insert-banner-and-buttons ()
|
2015-07-29 19:40:22 +00:00
|
|
|
|
"Choose a banner according to `dotspacemacs-startup-banner'and insert it
|
|
|
|
|
in spacemacs buffer along with quick buttons underneath.
|
2015-03-13 03:55:38 +00:00
|
|
|
|
|
|
|
|
|
Easter egg:
|
|
|
|
|
Doge special text banner can be reachable via `999', `doge' or `random*'.
|
2015-01-26 03:36:07 +00:00
|
|
|
|
`random' ignore special banners whereas `random*' does not."
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(let ((banner (spacemacs-buffer//choose-banner))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(buffer-read-only nil))
|
2015-07-29 19:40:22 +00:00
|
|
|
|
(progn
|
|
|
|
|
(when banner
|
|
|
|
|
(spacemacs-buffer/message (format "Banner: %s" banner))
|
|
|
|
|
(if (image-type-available-p (intern (file-name-extension banner)))
|
|
|
|
|
(spacemacs-buffer//insert-image-banner banner)
|
|
|
|
|
(insert-file-contents banner))
|
|
|
|
|
(spacemacs-buffer//inject-version))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer//insert-buttons)
|
2015-04-13 07:35:05 +00:00
|
|
|
|
(if (file-exists-p spacemacs-buffer--cache-file)
|
|
|
|
|
(load spacemacs-buffer--cache-file)
|
|
|
|
|
(unless (file-exists-p dotspacemacs-filepath)
|
|
|
|
|
;; fresh install of spacemacs, the release notes are not displayed
|
|
|
|
|
(setq spacemacs-buffer--release-note-version spacemacs-version)
|
|
|
|
|
(spacemacs/dump-vars-to-file
|
|
|
|
|
'(spacemacs-buffer--release-note-version) spacemacs-buffer--cache-file)))
|
2015-04-13 06:42:11 +00:00
|
|
|
|
;; if there is an installed dotfile we check the variable
|
|
|
|
|
;; spacemacs-buffer--release-note-version to decide whether
|
|
|
|
|
;; we show the release note
|
|
|
|
|
(when (and (file-exists-p dotspacemacs-filepath)
|
|
|
|
|
(or (not spacemacs-buffer--release-note-version)
|
|
|
|
|
(version< spacemacs-buffer--release-note-version
|
|
|
|
|
spacemacs-version)))
|
2015-09-29 03:53:20 +00:00
|
|
|
|
(spacemacs-buffer/toggle-note (concat spacemacs-release-notes-directory "0.105.txt")
|
2015-04-15 14:30:25 +00:00
|
|
|
|
'release-note))
|
2015-03-13 03:55:38 +00:00
|
|
|
|
(spacemacs//redisplay))))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer//choose-banner ()
|
2015-03-09 02:09:09 +00:00
|
|
|
|
"Return the full path of a banner based on the dotfile value."
|
2015-09-07 16:52:09 +00:00
|
|
|
|
(when dotspacemacs-startup-banner
|
|
|
|
|
(cond ((eq 'official dotspacemacs-startup-banner)
|
|
|
|
|
(if (and (display-graphic-p) (image-type-available-p 'png))
|
|
|
|
|
spacemacs-banner-official-png
|
|
|
|
|
(spacemacs-buffer//get-banner-path 1)))
|
|
|
|
|
((eq 'random dotspacemacs-startup-banner)
|
|
|
|
|
(spacemacs-buffer//choose-random-text-banner))
|
|
|
|
|
((eq 'random* dotspacemacs-startup-banner)
|
|
|
|
|
(spacemacs-buffer//choose-random-text-banner t))
|
|
|
|
|
((eq 'doge dotspacemacs-startup-banner)
|
|
|
|
|
(spacemacs-buffer//get-banner-path 999))
|
|
|
|
|
((integerp dotspacemacs-startup-banner)
|
|
|
|
|
(spacemacs-buffer//get-banner-path dotspacemacs-startup-banner))
|
|
|
|
|
((and dotspacemacs-startup-banner
|
|
|
|
|
(image-type-available-p (intern (file-name-extension
|
|
|
|
|
dotspacemacs-startup-banner)))
|
|
|
|
|
(display-graphic-p))
|
|
|
|
|
(if (file-exists-p dotspacemacs-startup-banner)
|
|
|
|
|
dotspacemacs-startup-banner
|
|
|
|
|
(spacemacs-buffer/warning (format "could not find banner %s"
|
|
|
|
|
dotspacemacs-startup-banner))
|
|
|
|
|
(spacemacs-buffer//get-banner-path 1)))
|
|
|
|
|
(t (spacemacs-buffer//get-banner-path 1)))))
|
2015-03-09 02:09:09 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer//choose-random-text-banner (&optional all)
|
2015-01-26 03:36:07 +00:00
|
|
|
|
"Return the full path of a banner chosen randomly.
|
|
|
|
|
|
|
|
|
|
If ALL is non-nil then truly all banners can be selected."
|
|
|
|
|
(let* ((files (directory-files spacemacs-banner-directory t))
|
|
|
|
|
(count (length files))
|
|
|
|
|
;; -2 then +2 to remove `.' and `..'
|
|
|
|
|
(choice (+ 2 (random (- count (if all 2 3))))))
|
|
|
|
|
(nth choice files)))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer//get-banner-path (index)
|
2015-01-26 03:36:07 +00:00
|
|
|
|
"Return the full path to banner with index INDEX."
|
|
|
|
|
(concat spacemacs-banner-directory (format "%03d-banner.txt" index)))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer//insert-image-banner (banner)
|
2015-03-13 03:55:38 +00:00
|
|
|
|
"Display an image banner."
|
|
|
|
|
(when (file-exists-p banner)
|
2015-07-30 02:07:27 +00:00
|
|
|
|
(let* ((title "[S P A C E M A C S]")
|
|
|
|
|
(spec (create-image banner))
|
2015-03-13 03:55:38 +00:00
|
|
|
|
(size (image-size spec))
|
|
|
|
|
(width (car size))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(left-margin (floor (- spacemacs-buffer--banner-length width) 2)))
|
2015-03-13 03:55:38 +00:00
|
|
|
|
(beginning-of-buffer)
|
|
|
|
|
(insert "\n")
|
|
|
|
|
(insert (make-string (- left-margin 1) ?\ ))
|
|
|
|
|
(insert-image spec)
|
|
|
|
|
(insert "\n\n")
|
2015-07-30 02:07:27 +00:00
|
|
|
|
(insert (make-string (+ left-margin
|
|
|
|
|
(floor (/ (- width (length title)) 2))) ?\ ))
|
|
|
|
|
(insert (format "%s\n\n" title)))))
|
2015-03-13 03:55:38 +00:00
|
|
|
|
|
2015-09-12 03:14:16 +00:00
|
|
|
|
(defun spacemacs-buffer//inject-version (&optional insert-distro)
|
2015-01-26 03:36:07 +00:00
|
|
|
|
"Inject the current version of spacemacs in the first line of the
|
|
|
|
|
buffer, right justified."
|
2015-09-12 03:04:01 +00:00
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(save-excursion
|
|
|
|
|
(let* ((maxcol spacemacs-buffer--banner-length)
|
2015-10-30 23:09:26 +00:00
|
|
|
|
(lhs (format "(emacs-%s)" emacs-version))
|
|
|
|
|
(rhs (if insert-distro
|
2015-09-12 03:14:16 +00:00
|
|
|
|
(format "(%s-%s)"
|
|
|
|
|
dotspacemacs-distribution
|
|
|
|
|
spacemacs-version)
|
|
|
|
|
(format "(%s)" spacemacs-version)))
|
2015-10-30 23:09:26 +00:00
|
|
|
|
(len (- maxcol (length lhs)))
|
2015-09-12 03:04:01 +00:00
|
|
|
|
(buffer-read-only nil))
|
2015-10-30 23:09:26 +00:00
|
|
|
|
(message "injecting")
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(delete-region (point) (progn (end-of-line) (point)))
|
|
|
|
|
(insert (format
|
|
|
|
|
(format "%%s %%%ds" len)
|
|
|
|
|
lhs rhs))))))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(defun spacemacs-buffer//insert-note (file caption &optional additional-widgets)
|
|
|
|
|
"Insert the release note just under the banner.
|
|
|
|
|
|
|
|
|
|
FILE is the file that contains the content to show.
|
|
|
|
|
CAPTION is the title of the note.
|
|
|
|
|
TAG-STRING is the label of the button for additional action.
|
|
|
|
|
HELP-STRING is the help message of the button for additional action."
|
2015-04-04 14:33:04 +00:00
|
|
|
|
(save-excursion
|
|
|
|
|
(beginning-of-buffer)
|
2015-10-15 16:38:28 +00:00
|
|
|
|
(search-forward "Search in Spacemacs\]")
|
2015-04-04 14:33:04 +00:00
|
|
|
|
(next-line)
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(let* ((note (concat "\n" (spacemacs//render-framed-text file
|
|
|
|
|
spacemacs-buffer--banner-length
|
|
|
|
|
caption))))
|
|
|
|
|
(add-to-list 'spacemacs-buffer--note-widgets (widget-create 'text note))
|
|
|
|
|
(funcall additional-widgets))))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer//insert-note-p (type)
|
|
|
|
|
"Decicde if whether to insert note widget or not based on current note TYPE.
|
|
|
|
|
|
|
|
|
|
If note TYPE is `quickhelp' or `release-note' and is equal to
|
|
|
|
|
previous insert type in `spacemacs-buffer--previous-insert-type',
|
|
|
|
|
which means previous note widget of the same type already
|
|
|
|
|
inserted. In this case, we simply delete the widgets but don't insert.
|
|
|
|
|
|
|
|
|
|
Otherwise, delete and allow insert note of TYPE."
|
|
|
|
|
(if (not (eq spacemacs-buffer--previous-insert-type type))
|
|
|
|
|
type
|
|
|
|
|
(setq spacemacs-buffer--previous-insert-type nil)))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer/toggle-note (file type)
|
|
|
|
|
"Toggle the note in FILE for the buffer based on TYPE.
|
|
|
|
|
|
|
|
|
|
If TYPE is nil, just remove widgets."
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(interactive)
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(spacemacs-buffer//remove-existing-widget-if-exist)
|
|
|
|
|
(cond
|
|
|
|
|
((eq type 'quickhelp)
|
|
|
|
|
(spacemacs-buffer//insert-quickhelp-widget file))
|
|
|
|
|
((eq type 'release-note)
|
|
|
|
|
(spacemacs-buffer//insert-release-note-widget file))
|
2015-04-19 06:11:04 +00:00
|
|
|
|
(t)))
|
2015-04-15 14:30:25 +00:00
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer//remove-existing-widget-if-exist ()
|
|
|
|
|
"Remove existing note widgets if exists."
|
|
|
|
|
(when spacemacs-buffer--note-widgets
|
|
|
|
|
(spacemacs-buffer//remove-note-widgets)))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer//insert-quickhelp-widget (file)
|
|
|
|
|
"Insert quickhelp with content from FILE."
|
|
|
|
|
(spacemacs-buffer//remove-existing-widget-if-exist)
|
|
|
|
|
(let ((widget-func (lambda ()
|
|
|
|
|
(add-to-list 'spacemacs-buffer--note-widgets
|
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:tag (propertize "Evil Tutorial" 'face 'font-lock-keyword-face)
|
|
|
|
|
:help-echo "Teach you how to use Vim basics."
|
|
|
|
|
:action (lambda (&rest ignore) (call-interactively #'evil-tutor-start))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"))
|
2015-04-21 09:47:41 +00:00
|
|
|
|
(widget-insert " ")
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(add-to-list 'spacemacs-buffer--note-widgets
|
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:tag (propertize "Emacs Tutorial" 'face 'font-lock-keyword-face)
|
|
|
|
|
:help-echo "Teach you how to use Emacs basics."
|
|
|
|
|
:action (lambda (&rest ignore) (call-interactively #'help-with-tutorial))
|
|
|
|
|
:mouse-face 'highlight
|
2015-06-06 17:24:26 +00:00
|
|
|
|
:follow-link "\C-m"))
|
|
|
|
|
(widget-insert " ")
|
|
|
|
|
(add-to-list 'spacemacs-buffer--note-widgets
|
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:tag (propertize "Vim Migration Guide" 'face 'font-lock-keyword-face)
|
|
|
|
|
:help-echo "Documentation for former vim users."
|
2015-06-15 20:22:48 +00:00
|
|
|
|
:action (lambda (&rest ignore) (spacemacs/view-org-file (concat spacemacs-docs-directory "VIMUSERS.org") "^" 'all))
|
2015-06-06 17:24:26 +00:00
|
|
|
|
:mouse-face 'highlight
|
2015-04-15 14:30:25 +00:00
|
|
|
|
:follow-link "\C-m")))))
|
|
|
|
|
(spacemacs-buffer//insert-note file "Quick Help" widget-func))
|
|
|
|
|
(setq spacemacs-buffer--previous-insert-type 'quickhelp))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer//insert-release-note-widget (file)
|
|
|
|
|
"Insert release note with content from FILE."
|
|
|
|
|
(spacemacs-buffer//remove-existing-widget-if-exist)
|
|
|
|
|
(let ((widget-func (lambda ()
|
|
|
|
|
(add-to-list 'spacemacs-buffer--note-widgets
|
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:tag (propertize "Click here for full change log" 'face 'font-lock-warning-face)
|
|
|
|
|
:help-echo "Open the full change log."
|
|
|
|
|
:action (lambda (&rest ignore)
|
2015-06-10 15:06:30 +00:00
|
|
|
|
(funcall 'spacemacs/view-org-file
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(concat user-emacs-directory "CHANGELOG.org")
|
2015-09-29 03:53:20 +00:00
|
|
|
|
"Release 0.105.x"
|
2015-06-10 15:06:30 +00:00
|
|
|
|
'subtree))
|
2015-04-15 14:30:25 +00:00
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m")))))
|
|
|
|
|
(spacemacs-buffer//insert-note file
|
2015-09-29 03:53:20 +00:00
|
|
|
|
" Important Notes (Release 0.105.x) "
|
2015-04-15 14:30:25 +00:00
|
|
|
|
widget-func))
|
|
|
|
|
|
|
|
|
|
(setq spacemacs-buffer--release-note-version nil)
|
|
|
|
|
(spacemacs/dump-vars-to-file
|
|
|
|
|
'(spacemacs-buffer--release-note-version) spacemacs-buffer--cache-file)
|
|
|
|
|
(setq spacemacs-buffer--previous-insert-type 'release-note))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs-buffer//remove-note-widgets ()
|
|
|
|
|
(mapc 'widget-delete spacemacs-buffer--note-widgets)
|
|
|
|
|
(setq spacemacs-buffer--note-widgets nil)
|
|
|
|
|
(setq spacemacs-buffer--release-note-version spacemacs-version)
|
|
|
|
|
(spacemacs/dump-vars-to-file
|
|
|
|
|
'(spacemacs-buffer--release-note-version) spacemacs-buffer--cache-file))
|
2015-04-04 14:33:04 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/set-mode-line (format)
|
2015-03-16 05:28:21 +00:00
|
|
|
|
"Set mode-line format for spacemacs buffer."
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(setq mode-line-format format)))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/message (msg &rest args)
|
2015-04-12 16:25:53 +00:00
|
|
|
|
"Display MSG in message prepended with '(Spacemacs)'.
|
2015-10-07 19:29:20 +00:00
|
|
|
|
The message is displayed only if `init-file-debug' is non nil."
|
|
|
|
|
(when init-file-debug
|
2015-04-06 03:45:02 +00:00
|
|
|
|
(message "(Spacemacs) %s" (apply 'format msg args))))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-12 16:25:53 +00:00
|
|
|
|
(defun spacemacs-buffer/warning (msg &rest args)
|
|
|
|
|
"Display MSG as a warning message but in buffer `*Messages*'.
|
|
|
|
|
The message is always displayed. "
|
|
|
|
|
(message "(Spacemacs) Warning: %s" (apply 'format msg args)))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/insert-page-break ()
|
2015-04-03 02:23:16 +00:00
|
|
|
|
"Insert a page break line in spacemacs buffer."
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer/append "\n\n\n"))
|
2015-04-03 02:23:16 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/append (msg &optional messagebuf)
|
2015-01-26 03:36:07 +00:00
|
|
|
|
"Append MSG to spacemacs buffer. If MESSAGEBUF is not nil then MSG is
|
|
|
|
|
also written in message buffer."
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(goto-char (point-max))
|
|
|
|
|
(let ((buffer-read-only nil))
|
|
|
|
|
(insert msg)
|
2015-03-12 04:25:52 +00:00
|
|
|
|
(if messagebuf (message "(Spacemacs) %s" msg)))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer/set-mode-line "")))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/replace-last-line (msg &optional messagebuf)
|
2015-01-26 03:36:07 +00:00
|
|
|
|
"Replace the last line of the spacemacs buffer with MSG. If MESSAGEBUF is
|
|
|
|
|
not nil then MSG is also written in message buffer."
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(goto-char (point-max))
|
|
|
|
|
(let ((buffer-read-only nil))
|
|
|
|
|
(delete-region (line-beginning-position) (point-max))
|
|
|
|
|
(insert msg)
|
2015-03-12 04:25:52 +00:00
|
|
|
|
(if messagebuf (message "(Spacemacs) %s" msg)))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer/set-mode-line "")))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/insert-framed-text
|
2015-04-06 00:59:55 +00:00
|
|
|
|
(msg &optional caption hpadding)
|
|
|
|
|
"Insert MSG in spacemacs buffer within a frame of width FILL-COLUMN.
|
|
|
|
|
|
|
|
|
|
See `spacemacs//render-framed-text' for documentation of the other
|
|
|
|
|
parameters."
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(let ((buffer-read-only nil))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(insert (spacemacs//render-framed-text msg spacemacs-buffer--banner-length
|
2015-04-06 00:59:55 +00:00
|
|
|
|
caption hpadding)))))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/insert-framed-text-from-file
|
2015-04-06 00:59:55 +00:00
|
|
|
|
(filepath &optional caption hpadding)
|
|
|
|
|
"Insert at point the content of FILENAME file in spacemacs buffer in a
|
|
|
|
|
frame.
|
|
|
|
|
|
|
|
|
|
If FILEPATH does not exists the function returns nil.
|
|
|
|
|
|
|
|
|
|
See `spacemacs//render-framed-text' for documentation of the other
|
|
|
|
|
parameters."
|
|
|
|
|
(when (file-exists-p filepath)
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(let ((buffer-read-only nil))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(insert (spacemacs//render-framed-text filepath spacemacs-buffer--banner-length
|
2015-04-06 00:59:55 +00:00
|
|
|
|
caption hpadding))))))
|
|
|
|
|
|
|
|
|
|
(defun spacemacs//render-framed-text (content &optional width caption hpadding)
|
|
|
|
|
"Return a formated string framed with plained lines of width FILL-COLUMN.
|
|
|
|
|
|
|
|
|
|
CONTENT can be a text or a filepath.
|
|
|
|
|
|
|
|
|
|
WIDTH set the `fill-column' variable.
|
|
|
|
|
|
|
|
|
|
If CAPTION is non nil string then it is included in at the top of the frame.
|
|
|
|
|
If CAPTION length is greater than FILL-COLUMN minus 5 the function returns
|
|
|
|
|
nil.
|
|
|
|
|
|
|
|
|
|
HPADDING is the horizontal spacing between the text and the frame.
|
|
|
|
|
The vertical spacing is always one line."
|
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(if (not (file-exists-p content))
|
|
|
|
|
(insert content)
|
|
|
|
|
(insert-file-contents content)
|
|
|
|
|
;; remove additional newline at eof
|
|
|
|
|
(goto-char (point-max))
|
|
|
|
|
(delete-char -1))
|
|
|
|
|
(let* ((hpadding (or hpadding 1))
|
|
|
|
|
(fill-column (if width
|
2015-07-30 02:07:27 +00:00
|
|
|
|
(- width (+ 2 (* 2 hpadding)))
|
2015-04-06 00:59:55 +00:00
|
|
|
|
fill-column))
|
|
|
|
|
(sentence-end-double-space nil)
|
|
|
|
|
(caption-len (length caption)))
|
2015-04-19 04:26:24 +00:00
|
|
|
|
(fill-region (point-min) (point-max) 'justify 'nosqueeze)
|
2015-04-06 00:59:55 +00:00
|
|
|
|
(concat
|
|
|
|
|
;; top
|
|
|
|
|
"╭─"
|
|
|
|
|
(if caption
|
|
|
|
|
(concat caption
|
|
|
|
|
(make-string (+ (- fill-column caption-len 1)
|
|
|
|
|
hpadding) ?─))
|
|
|
|
|
(make-string fill-column ?─))
|
|
|
|
|
(make-string hpadding ?─) "╮\n"
|
|
|
|
|
;; content
|
|
|
|
|
(spacemacs//render-framed-line "" hpadding)
|
|
|
|
|
(mapconcat (lambda (x)
|
|
|
|
|
(spacemacs//render-framed-line x hpadding))
|
|
|
|
|
(split-string (buffer-string) "\n" nil) "")
|
|
|
|
|
(spacemacs//render-framed-line "" hpadding)
|
|
|
|
|
;; bottom
|
|
|
|
|
"╰" (make-string hpadding ?─)
|
|
|
|
|
(make-string fill-column ?─)
|
2015-04-13 06:17:48 +00:00
|
|
|
|
(make-string hpadding ?─) "╯"))))
|
2015-04-06 00:59:55 +00:00
|
|
|
|
|
|
|
|
|
(defun spacemacs//render-framed-line (line hpadding)
|
|
|
|
|
"Return a formated LINE with borders of a frame on each side and
|
|
|
|
|
with width FILL-COLUMN.
|
|
|
|
|
|
|
|
|
|
If length of LINE is bigger than FILL-COLUMN it returns nil.
|
|
|
|
|
|
|
|
|
|
HPADDING is the horizontal spacing betwee the content line and the frame border."
|
|
|
|
|
(let* ((len (length line))
|
|
|
|
|
(fill (- fill-column len)))
|
|
|
|
|
(when (>= fill 0)
|
|
|
|
|
(concat "│" (make-string hpadding ?\s)
|
|
|
|
|
line (make-string fill ?\s)
|
|
|
|
|
(make-string hpadding ?\s) "│\n"))))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/loading-animation ()
|
2015-03-13 03:55:38 +00:00
|
|
|
|
"Display the progress bar by chunk of size `spacemacs--loading-dots-chunk-threshold'."
|
2015-02-16 02:25:12 +00:00
|
|
|
|
(when dotspacemacs-loading-progress-bar
|
|
|
|
|
(setq spacemacs-loading-counter (1+ spacemacs-loading-counter))
|
|
|
|
|
(when (>= spacemacs-loading-counter spacemacs-loading-dots-chunk-threshold)
|
|
|
|
|
(setq spacemacs-loading-counter 0)
|
2015-03-12 03:46:37 +00:00
|
|
|
|
(setq spacemacs-loading-string
|
|
|
|
|
(concat spacemacs-loading-string
|
|
|
|
|
(make-string spacemacs-loading-dots-chunk-size
|
|
|
|
|
spacemacs-loading-char)))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer/set-mode-line spacemacs-loading-string)
|
2015-02-16 02:25:12 +00:00
|
|
|
|
(spacemacs//redisplay))))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-04-20 20:01:11 +00:00
|
|
|
|
(defmacro spacemacs//insert--shortcut (shortcut-char search-label &optional no-next-line)
|
|
|
|
|
`(define-key spacemacs-mode-map ,shortcut-char (lambda ()
|
|
|
|
|
(interactive)
|
|
|
|
|
(unless (search-forward ,search-label (point-max) t)
|
|
|
|
|
(search-backward ,search-label (point-min) t))
|
|
|
|
|
,@(unless no-next-line
|
|
|
|
|
'((forward-line 1)))
|
|
|
|
|
(back-to-indentation))))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer//insert-buttons ()
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(goto-char (point-max))
|
2015-07-30 02:07:27 +00:00
|
|
|
|
(insert " ")
|
2015-04-20 20:01:11 +00:00
|
|
|
|
(spacemacs//insert--shortcut "m" "[?]" t)
|
2015-04-15 14:30:25 +00:00
|
|
|
|
(widget-create 'url-link
|
|
|
|
|
:tag (propertize "?" 'face 'font-lock-doc-face)
|
|
|
|
|
:help-echo "Open the quickhelp."
|
|
|
|
|
:action (lambda (&rest ignore)
|
2015-04-23 02:30:00 +00:00
|
|
|
|
(spacemacs-buffer/toggle-note (concat spacemacs-info-directory "quickhelp.txt")
|
2015-04-15 14:30:25 +00:00
|
|
|
|
;; if nil is returned, just delete the current note widgets
|
|
|
|
|
(spacemacs-buffer//insert-note-p 'quickhelp)))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
)
|
2015-04-19 06:11:04 +00:00
|
|
|
|
(insert " ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'url-link
|
2015-04-13 05:46:39 +00:00
|
|
|
|
:tag (propertize "Homepage" 'face 'font-lock-keyword-face)
|
2015-04-02 14:23:36 +00:00
|
|
|
|
:help-echo "Open the Spacemacs Github page in your browser."
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
"https://github.com/syl20bnr/spacemacs")
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(insert " ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'url-link
|
2015-04-13 05:46:39 +00:00
|
|
|
|
:tag (propertize "Documentation" 'face 'font-lock-keyword-face)
|
2015-04-02 14:23:36 +00:00
|
|
|
|
:help-echo "Open the Spacemacs documentation in your browser."
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
2015-06-11 05:00:54 +00:00
|
|
|
|
"https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org")
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(insert " ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'url-link
|
2015-04-13 05:46:39 +00:00
|
|
|
|
:tag (propertize "Gitter Chat" 'face 'font-lock-keyword-face)
|
2015-04-02 14:23:36 +00:00
|
|
|
|
:help-echo "Ask questions and chat with fellow users in our chat room."
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
"https://gitter.im/syl20bnr/spacemacs")
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(insert " ")
|
2015-10-12 21:00:59 +00:00
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:help-echo "Update Spacemacs core and layers."
|
|
|
|
|
:action (lambda (&rest ignore) (spacemacs/switch-to-version))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
(propertize "Update Spacemacs" 'face 'font-lock-keyword-face))
|
|
|
|
|
(insert "\n ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:help-echo "Update all ELPA packages to the latest versions."
|
|
|
|
|
:action (lambda (&rest ignore) (configuration-layer/update-packages))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
2015-10-12 21:00:59 +00:00
|
|
|
|
(propertize "Update Packages" 'face 'font-lock-keyword-face))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
(insert " ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'push-button
|
2015-10-12 21:00:59 +00:00
|
|
|
|
:help-echo "Rollback ELPA package updates if something got borked."
|
2015-04-02 14:23:36 +00:00
|
|
|
|
:action (lambda (&rest ignore) (call-interactively 'configuration-layer/rollback))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
2015-10-12 21:00:59 +00:00
|
|
|
|
(propertize "Rollback Package Update" 'face 'font-lock-keyword-face))
|
2015-03-02 00:53:45 +00:00
|
|
|
|
(insert "\n")
|
2015-07-30 02:07:27 +00:00
|
|
|
|
(insert " ")
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(widget-create 'push-button
|
2015-04-13 05:46:39 +00:00
|
|
|
|
:tag (propertize "Release Notes" 'face 'font-lock-preprocessor-face)
|
2015-04-12 04:24:03 +00:00
|
|
|
|
:help-echo "Hide or show the Changelog"
|
2015-04-15 14:30:25 +00:00
|
|
|
|
:action (lambda (&rest ignore)
|
2015-09-29 03:53:20 +00:00
|
|
|
|
(spacemacs-buffer/toggle-note (concat spacemacs-release-notes-directory "0.105.txt")
|
2015-04-15 14:30:25 +00:00
|
|
|
|
;; if nil is returned, just delete the current note widgets
|
|
|
|
|
(spacemacs-buffer//insert-note-p 'release-note)))
|
2015-04-12 04:24:03 +00:00
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
)
|
|
|
|
|
(insert " ")
|
|
|
|
|
(widget-create 'url-link
|
2015-04-13 05:46:39 +00:00
|
|
|
|
:tag (propertize "Search in Spacemacs" 'face 'font-lock-function-name-face)
|
2015-04-12 04:24:03 +00:00
|
|
|
|
:help-echo "Find Spacemacs package and layer configs using helm-spacemacs."
|
|
|
|
|
:action (lambda (&rest ignore) (call-interactively 'helm-spacemacs))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m")
|
2015-04-06 00:59:55 +00:00
|
|
|
|
(insert "\n\n"))
|
2015-01-26 03:36:07 +00:00
|
|
|
|
|
2015-06-03 06:45:54 +00:00
|
|
|
|
(defun spacemacs-buffer//insert-file-list (list-display-name list)
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(when (car list)
|
2015-04-13 14:18:19 +00:00
|
|
|
|
(insert list-display-name)
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(mapc (lambda (el)
|
|
|
|
|
(insert "\n ")
|
2015-04-02 14:23:36 +00:00
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:action `(lambda (&rest ignore) (find-file-existing ,el))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
:button-prefix ""
|
|
|
|
|
:button-suffix ""
|
|
|
|
|
:format "%[%t%]"
|
|
|
|
|
(abbreviate-file-name el)))
|
2015-03-28 14:30:56 +00:00
|
|
|
|
list)))
|
|
|
|
|
|
2015-07-30 02:21:31 +00:00
|
|
|
|
(defun spacemacs-buffer//insert-bookmark-list (list-display-name list)
|
|
|
|
|
(when (car list)
|
|
|
|
|
(insert list-display-name)
|
|
|
|
|
(mapc (lambda (el)
|
|
|
|
|
(insert "\n ")
|
|
|
|
|
(widget-create 'push-button
|
|
|
|
|
:action `(lambda (&rest ignore) (bookmark-jump ,el))
|
|
|
|
|
:mouse-face 'highlight
|
|
|
|
|
:follow-link "\C-m"
|
|
|
|
|
:button-prefix ""
|
|
|
|
|
:button-suffix ""
|
|
|
|
|
:format "%[%t%]"
|
|
|
|
|
(format "%s - %s" el (abbreviate-file-name
|
|
|
|
|
(bookmark-get-filename el)))))
|
|
|
|
|
list)))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/insert-startupify-lists ()
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(interactive)
|
|
|
|
|
(with-current-buffer (get-buffer-create "*spacemacs*")
|
|
|
|
|
(let ((buffer-read-only nil)
|
|
|
|
|
(list-separator "\n\n"))
|
|
|
|
|
(goto-char (point-max))
|
2015-04-02 04:32:38 +00:00
|
|
|
|
(page-break-lines-mode)
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(spacemacs-buffer/insert-page-break)
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(mapc (lambda (el)
|
|
|
|
|
(cond
|
|
|
|
|
((eq el 'recents)
|
|
|
|
|
(recentf-mode)
|
2015-07-17 05:38:34 +00:00
|
|
|
|
(when (spacemacs-buffer//insert-file-list "Recent Files:" (recentf-elements dotspacemacs-startup-recent-list-size))
|
2015-06-03 06:45:54 +00:00
|
|
|
|
(spacemacs//insert--shortcut "r" "Recent Files:")
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(insert list-separator)))
|
|
|
|
|
((eq el 'bookmarks)
|
|
|
|
|
(helm-mode)
|
2015-07-30 02:21:31 +00:00
|
|
|
|
(when (spacemacs-buffer//insert-bookmark-list "Bookmarks:" (bookmark-all-names))
|
2015-06-03 06:45:54 +00:00
|
|
|
|
(spacemacs//insert--shortcut "m" "Bookmarks:")
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(insert list-separator)))
|
|
|
|
|
((eq el 'projects)
|
|
|
|
|
(projectile-mode)
|
2015-06-03 06:45:54 +00:00
|
|
|
|
(when (spacemacs-buffer//insert-file-list "Projects:" (projectile-relevant-known-projects))
|
|
|
|
|
(spacemacs//insert--shortcut "p" "Projects:")
|
2015-03-28 14:30:56 +00:00
|
|
|
|
(insert list-separator))))) dotspacemacs-startup-lists))))
|
|
|
|
|
|
2015-04-12 04:24:03 +00:00
|
|
|
|
(defun spacemacs-buffer/goto-link-line ()
|
2015-02-04 04:56:52 +00:00
|
|
|
|
"Move the point to the beginning of the link line."
|
|
|
|
|
(interactive)
|
2015-07-30 02:07:07 +00:00
|
|
|
|
(with-current-buffer spacemacs-buffer-name
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(re-search-forward "Homepage")
|
|
|
|
|
(beginning-of-line)
|
|
|
|
|
(widget-forward 1)))
|
2015-02-04 04:56:52 +00:00
|
|
|
|
|
2015-01-27 03:51:47 +00:00
|
|
|
|
(provide 'core-spacemacs-buffer)
|