Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Feature/center content #88

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

Merged
merged 19 commits into from
Feb 25, 2019
Merged

Feature/center content #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
754df63
WIP: Render content centered if specified.
jkdufair Feb 21, 2019
16e40fc
Start macro-fying section generation
jkdufair Feb 21, 2019
410ceab
Customization for centering
jkdufair Feb 21, 2019
1ca6573
Macro-fy recentf, bookmarks, projects
jkdufair Feb 21, 2019
9ce8c1a
Macro-fy agenda, registers
jkdufair Feb 21, 2019
0e86bf2
Don't "center" page break lines
jkdufair Feb 22, 2019
7ddd2ee
Update README.org to indicate default centering and customize option
jkdufair Feb 22, 2019
e24b81a
Don't interrupt the existing docs!
jkdufair Feb 22, 2019
a25c654
Revert whitespace-only changes
jkdufair Feb 22, 2019
e81acaa
Reverse one bad reversal
jkdufair Feb 22, 2019
a092fb8
Whitespace cleanup. Small PR fixes
jkdufair Feb 23, 2019
4ab1b96
Merge branch 'master' into feature/center-content
jkdufair Feb 23, 2019
3fa9298
Whitespace cleanup
jkdufair Feb 23, 2019
d2ba70e
Linter cleanup. Which also apparently doesn't like when-let
jkdufair Feb 23, 2019
e46ed6c
Documentation fixes
jkdufair Feb 23, 2019
e5c65be
Linter fixes
jkdufair Feb 23, 2019
450001d
Remove requirement for sections to calculate their max length
jkdufair Feb 24, 2019
634755a
Do not center content by default
jkdufair Feb 24, 2019
e423a93
Merge branch 'master' into feature/center-content
jkdufair Feb 24, 2019
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
3 changes: 3 additions & 0 deletions README.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ To update the banner or banner title
;; 'logo which displays an alternative emacs logo
;; 1, 2 or 3 which displays one of the text banners
;; "path/to/your/image.png" which displays whatever image you would prefer

;; Content is not centered by default. To center, set
(setq dashboard-center-content nil)
#+END_SRC

To customize which widgets are displayed, you can use the following snippet
Expand Down
201 changes: 81 additions & 120 deletions dashboard-widgets.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,124 +244,91 @@ If MESSAGEBUF is not nil then MSG is also written in message buffer."
(dashboard-insert-ascii-banner-centered banner))))))

;;
;; Recentf
;; Section insertion
;;
(defun dashboard-insert-recentf-list (list-display-name list)
"Render LIST-DISPLAY-NAME title and items of LIST."
(when (car list)
(dashboard-insert-heading list-display-name)
(mapc (lambda (el)
(insert "\n ")
(widget-create 'push-button
:action `(lambda (&rest ignore) (find-file-existing ,el))
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
(abbreviate-file-name el)))
list)))
(defmacro dashboard-insert-section-list (section-name list action &rest rest)
"Insert into SECTION-NAME a LIST of items, expanding ACTION and passing REST to widget creation."
`(when (car ,list)
(mapc (lambda (el)
(let ((widget nil))
(insert "\n ")
(setq widget
(widget-create 'push-button
:action ,action
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
,@rest))))
,list)))

(defmacro dashboard-insert-section (section-name list list-size shortcut action &rest widget-params)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did this become a macro rather than a function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to have each section insert return its longest line so I could do centering calculations. Each of the section and section list inserts was similar and I didn't want to just boilerplate it in there. So I refactored the section and section list inserts into a macro and replaced the repetitive sections with calls to the macro. This should also make it easy to create new sections in the future with less boilerplate code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also it should make the intent of creating sections more clean and more declarative

"Add a section with SECTION-NAME and LIST of LIST-SIZE items to the dashboard.
SHORTCUT is the keyboard shortcut used to access the section.
ACTION is theaction taken when the user activates the widget button.
WIDGET-PARAMS are passed to the \"widget-create\" function."
`(progn
(dashboard-insert-heading ,section-name)
(when (dashboard-insert-section-list
,section-name
(dashboard-subseq ,list 0 list-size)
,action
,@widget-params)
(dashboard-insert-shortcut ,shortcut ,section-name))))

;;
;; Recentf
;;
(defun dashboard-insert-recents (list-size)
"Add the list of LIST-SIZE items from recently edited files."
(recentf-mode)
(when (dashboard-insert-recentf-list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dashboard let's you configure widgets to include... this is why the when statement is there. Why was it removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this still works as intended? When I remove, i.e. 'recents from 'dashboard-items, the section no longer appears on the dashboard. Am I understanding correctly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry. I should add there is a when-let in dashboard-insert-section that I believe accomplishes the same.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the linter seems to have had trouble with when-let so I just did a let and if. This still appears to allow the configurability of which widgets to include.

"Recent Files:"
(dashboard-subseq recentf-list 0 list-size))
(dashboard-insert-shortcut "r" "Recent Files:")))

(dashboard-insert-section
"Recent Files:"
recentf-list
list-size
"r"
`(lambda (&rest ignore) (find-file-existing ,el))
(abbreviate-file-name el)))

;;
;; Bookmarks
;;
(defun dashboard-insert-bookmark-list (list-display-name list)
"Render LIST-DISPLAY-NAME title and bookmarks items of LIST."
(when (car list)
(dashboard-insert-heading list-display-name)
(mapc (lambda (el)
(insert "\n ")
(widget-create 'push-button
:action `(lambda (&rest ignore) (bookmark-jump ,el))
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
(let ((file (bookmark-get-filename el)))
(if file
(format "%s - %s" el (abbreviate-file-name file))
el))))
list)))

(defun dashboard-insert-bookmarks (list-size)
"Add the list of LIST-SIZE items of bookmarks."
(require 'bookmark)
(when (dashboard-insert-bookmark-list
"Bookmarks:"
(dashboard-subseq (bookmark-all-names)
0 list-size))
(dashboard-insert-shortcut "m" "Bookmarks:")))
(dashboard-insert-section
"Bookmarks:"
(dashboard-subseq (bookmark-all-names)
0 list-size)
list-size
"m"
`(lambda (&rest ignore) (bookmark-jump ,el))
(let ((file (bookmark-get-filename el)))
(if file
(format "%s - %s" el (abbreviate-file-name file))
el))))

;;
;; Projectile
;;
(defun dashboard-insert-project-list (list-display-name list)
"Render LIST-DISPLAY-NAME title and project items of LIST."
(when (car list)
(dashboard-insert-heading list-display-name)
(mapc (lambda (el)
(insert "\n ")
(widget-create 'push-button
:action `(lambda (&rest ignore)
(projectile-switch-project-by-name ,el))
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
(abbreviate-file-name el)))
list)))

(defun dashboard-insert-projects (list-size)
"Add the list of LIST-SIZE items of projects."
;; For some reason, projectile has to be loaded here
;; before trying to load projects list
(projectile-mode)
(if (bound-and-true-p projectile-mode)
(progn
(projectile-load-known-projects)
(when (dashboard-insert-project-list
"Projects:"
(dashboard-subseq (projectile-relevant-known-projects)
0 list-size))
(dashboard-insert-shortcut "p" "Projects:")))
(message "Failed to load projects list")))
(dashboard-insert-section
"Projects:"
(dashboard-subseq (projectile-relevant-known-projects)
0 list-size)
list-size
"p"
`(lambda (&rest ignore) (projectile-switch-project-by-name ,el))
(abbreviate-file-name el)))))

;;
;; Org Agenda
;;
(defun dashboard-insert-agenda-list (list-display-name list)
"Render LIST-DISPLAY-NAME title and agenda items from LIST."
(dashboard-insert-heading list-display-name)
(if (car list)
(mapc (lambda (el)
(insert "\n ")
(let ((filename (nth 4 el))
(lineno (nth 3 el))
(title (nth 0 el)))
(widget-create 'push-button
:action `(lambda (&rest ignore)
(let ((buffer (find-file-other-window ,filename)))
(with-current-buffer buffer
(goto-char ,lineno)
)
(switch-to-buffer buffer)))
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
(format "%s" title)))
)
list)
(insert (propertize "\n --- No items ---" 'face 'widget-button))))

(defun dashboard-timestamp-to-gregorian-date (timestamp)
"Convert TIMESTAMP to a gregorian date.

Expand Down Expand Up @@ -422,41 +389,35 @@ date part is considered."

(defun dashboard-insert-agenda (list-size)
"Add the list of LIST-SIZE items of agenda."
(let ((agenda-time-string nil))
(if (and (boundp 'show-week-agenda-p) show-week-agenda-p)
(setq agenda-time-string "Agenda for the coming week:")
(setq agenda-time-string "Agenda for today:")
)
(when (dashboard-insert-agenda-list agenda-time-string
(dashboard-get-agenda))
(dashboard-insert-shortcut "a" agenda-time-string))))
(let ((agenda (dashboard-get-agenda)))
(dashboard-insert-section
(or (and (boundp 'show-week-agenda-p) show-week-agenda-p "Agenda for the coming week:")
"Agenda for today:")
(or agenda '())
list-size
"a"
`(lambda (&rest ignore)
(let ((buffer (find-file-other-window (nth 4 ,el))))
(with-current-buffer buffer
(goto-char (nth 3 ,el)))
(switch-to-buffer buffer)))
(format "%s" (nth 0 el)))
(and (not agenda)
(insert "\n --- No items ---"))))

;;
;; Registers
;;
(defun dashboard-insert-register-list (list-display-name list)
"Render LIST-DISPLAY-NAME title and registers items of LIST."
(when (car list)
(dashboard-insert-heading list-display-name)
(mapc (lambda (el)
(let ((register (car el)))
(insert "\n ")
(widget-create 'push-button
:action `(lambda (&rest ignore) (jump-to-register ,register))
:mouse-face 'highlight
:button-prefix ""
:button-suffix ""
:format "%[%t%]"
(format "%c - %s" register (register-describe-oneline register)))))
list)))

(defun dashboard-insert-registers (list-size)
"Add the list of LIST-SIZE items of registers."
(require 'register)
(when (dashboard-insert-register-list
"Registers:"
(dashboard-subseq register-alist 0 list-size))
(dashboard-insert-shortcut "e" "Registers:")))
(dashboard-insert-section
"Registers:"
register-alist
list-size
"e"
(lambda (&rest ignore) (jump-to-register (car el)))
(format "%c - %s" (car el) (register-describe-oneline (car el)))))


;; Forward declartions for optional dependency to keep check-declare happy.
Expand Down
33 changes: 29 additions & 4 deletions dashboard.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@
"Settings that are used in the Dashboard"
:group 'dashboard)

(defcustom dashboard-center-content nil
"Whether to center content within the window."
:type 'boolean
:group 'dashboard)

(defconst dashboard-buffer-name "*dashboard*"
"Dashboard's buffer name.")

Expand Down Expand Up @@ -98,6 +103,18 @@
(when next-section-start
(goto-char next-section-start)))))

(defun dashboard-maximum-section-length ()
"For the just-inserted section, calculate the length of the longest line."
(let ((max-line-length 0))
(save-excursion
(dashboard-previous-section)
(while (not (eobp))
(setq max-line-length
(max max-line-length
(- (line-end-position) (line-beginning-position))))
(forward-line)))
max-line-length))

(defun dashboard-insert-startupify-lists ()
"Insert the list of widgets into the buffer."
(interactive)
Expand All @@ -106,7 +123,7 @@
(recentf-is-on (recentf-enabled-p))
(origial-recentf-list recentf-list)
(dashboard-num-recents (or (cdr (assoc 'recents dashboard-items)) 0))
)
(max-line-length 0))
;; disable recentf mode,
;; so we don't flood the recent files list with org mode files
;; do this by making a copy of the part of the list we'll use
Expand Down Expand Up @@ -137,13 +154,21 @@
(cdr-safe (assoc el dashboard-item-generators))))
(add-to-list 'dashboard--section-starts (point))
(funcall item-generator list-size)
(setq max-line-length
(max max-line-length (dashboard-maximum-section-length)))
(dashboard-insert-page-break)))
dashboard-items))
dashboard-items)
(when dashboard-center-content
(goto-char (car (last dashboard--section-starts)))
(let ((margin (floor (/ (- (window-width) max-line-length) 2))))
(while (not (eobp))
(and (not (eq ? (char-after)))
(insert (make-string margin ?\ )))
(forward-line 1)))))
(dashboard-mode)
(goto-char (point-min))))
(if recentf-is-on
(setq recentf-list origial-recentf-list)
)))
(setq recentf-list origial-recentf-list))))

(add-hook 'window-setup-hook
(lambda ()
Expand Down