From a3269771aaebbbc57ef0c72e4630cbdb7e370a35 Mon Sep 17 00:00:00 2001 From: KemoNine Date: Thu, 22 Sep 2022 16:13:41 -0400 Subject: [PATCH] add focus mode for dense text edit work --- .../focus-20220910.1300/focus-autoloads.el | 60 ++++ code/elpa/focus-20220910.1300/focus-pkg.el | 2 + code/elpa/focus-20220910.1300/focus.el | 288 ++++++++++++++++++ common/_global.el | 8 +- .../focus-20220910.1300/focus-autoloads.el | 60 ++++ org/elpa/focus-20220910.1300/focus-pkg.el | 2 + org/elpa/focus-20220910.1300/focus.el | 288 ++++++++++++++++++ 7 files changed, 707 insertions(+), 1 deletion(-) create mode 100644 code/elpa/focus-20220910.1300/focus-autoloads.el create mode 100644 code/elpa/focus-20220910.1300/focus-pkg.el create mode 100644 code/elpa/focus-20220910.1300/focus.el create mode 100644 org/elpa/focus-20220910.1300/focus-autoloads.el create mode 100644 org/elpa/focus-20220910.1300/focus-pkg.el create mode 100644 org/elpa/focus-20220910.1300/focus.el diff --git a/code/elpa/focus-20220910.1300/focus-autoloads.el b/code/elpa/focus-20220910.1300/focus-autoloads.el new file mode 100644 index 0000000..31383d3 --- /dev/null +++ b/code/elpa/focus-20220910.1300/focus-autoloads.el @@ -0,0 +1,60 @@ +;;; focus-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*- +;; +;;; Code: + +(add-to-list 'load-path (directory-file-name + (or (file-name-directory #$) (car load-path)))) + + +;;;### (autoloads nil "focus" "focus.el" (0 0 0 0)) +;;; Generated autoloads from focus.el + +(autoload 'focus-mode "focus" "\ +Dim the font color of text in surrounding sections. + +This is a minor mode. If called interactively, toggle the `Focus +mode' mode. If the prefix argument is positive, enable the mode, +and if it is zero or negative, disable the mode. + +If called from Lisp, toggle the mode if ARG is `toggle'. Enable +the mode if ARG is nil, omitted, or is a positive number. +Disable the mode if ARG is a negative number. + +To check whether the minor mode is enabled in the current buffer, +evaluate `focus-mode'. + +The mode's hook is called both when the mode is enabled and when +it is disabled. + +\(fn &optional ARG)" t nil) + +(autoload 'focus-read-only-mode "focus" "\ +A read-only mode optimized for `focus-mode'. + +This is a minor mode. If called interactively, toggle the +`Focus-Read-Only mode' mode. If the prefix argument is positive, +enable the mode, and if it is zero or negative, disable the mode. + +If called from Lisp, toggle the mode if ARG is `toggle'. Enable +the mode if ARG is nil, omitted, or is a positive number. +Disable the mode if ARG is a negative number. + +To check whether the minor mode is enabled in the current buffer, +evaluate `focus-read-only-mode'. + +The mode's hook is called both when the mode is enabled and when +it is disabled. + +\(fn &optional ARG)" t nil) + +(register-definition-prefixes "focus" '("focus-")) + +;;;*** + +;; Local Variables: +;; version-control: never +;; no-byte-compile: t +;; no-update-autoloads: t +;; coding: utf-8 +;; End: +;;; focus-autoloads.el ends here diff --git a/code/elpa/focus-20220910.1300/focus-pkg.el b/code/elpa/focus-20220910.1300/focus-pkg.el new file mode 100644 index 0000000..f85eded --- /dev/null +++ b/code/elpa/focus-20220910.1300/focus-pkg.el @@ -0,0 +1,2 @@ +;;; Generated package description from focus.el -*- no-byte-compile: t -*- +(define-package "focus" "20220910.1300" "Dim the font color of text in surrounding sections" '((emacs "24.3") (cl-lib "0.5")) :commit "9dd85fc474bbc1ebf22c287752c960394fcd465a" :authors '(("Lars Tveito" . "larstvei@ifi.uio.no")) :maintainer '("Lars Tveito" . "larstvei@ifi.uio.no") :url "http://github.com/larstvei/Focus") diff --git a/code/elpa/focus-20220910.1300/focus.el b/code/elpa/focus-20220910.1300/focus.el new file mode 100644 index 0000000..5951bb7 --- /dev/null +++ b/code/elpa/focus-20220910.1300/focus.el @@ -0,0 +1,288 @@ +;;; focus.el --- Dim the font color of text in surrounding sections -*- lexical-binding: t; -*- + +;; Copyright (C) 2015 Lars Tveito + +;; Author: Lars Tveito +;; URL: http://github.com/larstvei/Focus +;; Package-Version: 20220910.1300 +;; Package-Commit: 9dd85fc474bbc1ebf22c287752c960394fcd465a +;; Created: 11th May 2015 +;; Version: 1.0.0 +;; Package-Requires: ((emacs "24.3") (cl-lib "0.5")) + +;; This program 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. + +;; This program 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 this program. If not, see . + +;;; Commentary: + +;; Focus provides `focus-mode` that dims the text of surrounding sections, +;; similar to [iA Writer's](https://ia.net/writer) Focus Mode. +;; +;; Enable the mode with `M-x focus-mode'. + +;;; Code: + +(require 'cl-lib) +(require 'thingatpt) + +(defgroup focus () + "Dim the font color of text in surrounding sections." + :group 'font-lock + :prefix "focus-") + +(defcustom focus-mode-to-thing '((prog-mode . defun) + (text-mode . paragraph) + (org-mode . org-element)) + "An associated list between mode and thing. + +A thing is defined in thingatpt.el; the thing determines the +narrowness of the focused section. + +Note that the order of the list matters. The first mode that the +current mode is derived from is used, so more modes that have +many derivatives should be placed by the end of the list. + +Things that are defined include `symbol', `list', `sexp', +`defun', `filename', `url', `email', `word', `sentence', +`whitespace', `line', and `page'." + :type '(alist :key-type symbol :valye-type symbol) + :group 'focus) + +(defcustom focus-read-only-blink-seconds 1 + "The duration of a cursor blink in `focus-read-only-mode'." + :type 'number + :group 'focus) + +(defface focus-unfocused + '((t :inherit shadow)) + "The face that overlays the unfocused area." + :group 'focus) + +(defface focus-focused nil + "The face that overlays the focused area." + :group 'focus) + +(defvar focus-cursor-type cursor-type + "Used to restore the users `cursor-type'.") + +(defvar-local focus-current-thing nil + "Overrides the choice of thing dictated by `focus-mode-to-thing' if set.") + +(defvar-local focus-buffer nil + "Local reference to the buffer focus functions operate on.") + +(defvar-local focus-pre-overlay nil + "The overlay that dims the text prior to the current-point.") + +(defvar-local focus-mid-overlay nil + "The overlay that surrounds the text of the current-point.") + +(defvar-local focus-post-overlay nil + "The overlay that dims the text past the current-point.") + +(defvar-local focus-read-only-blink-timer nil + "Timer started from `focus-read-only-cursor-blink'. +The timer calls `focus-read-only-hide-cursor' after +`focus-read-only-blink-seconds' seconds.") + +(defun focus-get-thing () + "Return the current thing, based on `focus-mode-to-thing'." + (or focus-current-thing + (let* ((modes (mapcar 'car focus-mode-to-thing)) + (mode (or (cl-find major-mode modes) + (apply #'derived-mode-p modes)))) + (if mode (cdr (assoc mode focus-mode-to-thing)) 'sentence)))) + +(defun focus-bounds () + "Return the current bounds, based on `focus-get-thing'." + (let ((thing (focus-get-thing))) + (cond ((eq thing 'org-element) + (let* ((elem (org-element-at-point)) + (beg (org-element-property :begin elem)) + (end (org-element-property :end elem))) + (cons beg end))) + (t (bounds-of-thing-at-point (focus-get-thing)))))) + +(defun focus-move-focus () + "Move the focused section according to `focus-bounds'. + +If `focus-mode' is enabled, this command fires after each +command." + (with-current-buffer focus-buffer + (let* ((bounds (focus-bounds))) + (when bounds + (focus-move-overlays (car bounds) (cdr bounds)))))) + +(defun focus-move-overlays (low high) + "Move the overlays to highlight the region between LOW and HIGH." + (move-overlay focus-pre-overlay (point-min) low) + (move-overlay focus-mid-overlay low high) + (move-overlay focus-post-overlay high (point-max))) + +(defun focus-init () + "This function is run when command `focus-mode' is enabled. + +It sets the `focus-pre-overlay', `focus-min-overlay', and +`focus-post-overlay' to overlays; these are invisible until +`focus-move-focus' is run. It adds `focus-move-focus' to +`post-command-hook'." + (unless (or focus-pre-overlay focus-post-overlay) + (setq focus-pre-overlay (make-overlay (point-min) (point-min)) + focus-mid-overlay (make-overlay (point-min) (point-max)) + focus-post-overlay (make-overlay (point-max) (point-max)) + focus-buffer (current-buffer)) + (overlay-put focus-mid-overlay 'face 'focus-focused) + (mapc (lambda (o) (overlay-put o 'face 'focus-unfocused)) + (list focus-pre-overlay focus-post-overlay)) + (add-hook 'post-command-hook 'focus-move-focus nil t) + (add-hook 'change-major-mode-hook 'focus-terminate nil t))) + +(defun focus-terminate () + "This function is run when command `focus-mode' is disabled. + +The overlays pointed to by `focus-pre-overlay', +`focus-mid-overlay' and `focus-post-overlay' are deleted, and +`focus-move-focus' is removed from `post-command-hook'." + (when (and focus-pre-overlay focus-post-overlay) + (mapc 'delete-overlay + (list focus-pre-overlay focus-mid-overlay focus-post-overlay)) + (remove-hook 'post-command-hook 'focus-move-focus t) + (setq focus-pre-overlay nil + focus-mid-overlay nil + focus-post-overlay nil))) + +(defun focus-goto-thing (bounds) + "Move point to the middle of BOUNDS." + (when bounds + (goto-char (/ (+ (car bounds) (cdr bounds)) 2)) + (recenter nil))) + +(defun focus-change-thing () + "Adjust the narrowness of the focused section for the current buffer. + +The variable `focus-mode-to-thing' dictates the default thing +according to major-mode. If `focus-current-thing' is set, this +default is overwritten. This function simply helps set the +`focus-current-thing'." + (interactive) + (let* ((candidates '(defun line list org-element paragraph sentence sexp symbol word)) + (thing (completing-read "Thing: " candidates))) + (setq focus-current-thing (intern thing)))) + +(defun focus-pin () + "Pin the focused section to its current location or the region, if active." + (interactive) + (when (bound-and-true-p focus-mode) + (when (region-active-p) + (focus-move-overlays (region-beginning) (region-end))) + (remove-hook 'post-command-hook 'focus-move-focus t))) + +(defun focus-unpin () + "Unpin the focused section." + (interactive) + (when (bound-and-true-p focus-mode) + (add-hook 'post-command-hook 'focus-move-focus nil t))) + +(defun focus-next-thing (&optional n) + "Move the point to the middle of the Nth next thing." + (interactive "p") + (let ((current-bounds (focus-bounds)) + (thing (focus-get-thing))) + (forward-thing thing n) + (when (equal current-bounds (focus-bounds)) + (forward-thing thing (cl-signum n))) + (focus-goto-thing (focus-bounds)))) + +(defun focus-prev-thing (&optional n) + "Move the point to the middle of the Nth previous thing." + (interactive "p") + (focus-next-thing (- n))) + +(defun focus-read-only-hide-cursor () + "Hide the cursor. +This function is triggered by the `focus-read-only-blink-timer', +when `focus-read-only-mode' is activated." + (with-current-buffer focus-buffer + (when (and (bound-and-true-p focus-read-only-mode) + (not (null focus-read-only-blink-timer))) + (setq focus-read-only-blink-timer nil) + (setq cursor-type nil)))) + +(defun focus-read-only-cursor-blink () + "Make the cursor visible for `focus-read-only-blink-seconds'. +This is added to the `pre-command-hook' when +`focus-read-only-mode' is active." + (with-current-buffer focus-buffer + (when (and (bound-and-true-p focus-read-only-mode) + (not (member last-command '(focus-next-thing focus-prev-thing)))) + (when focus-read-only-blink-timer (cancel-timer focus-read-only-blink-timer)) + (setq cursor-type focus-cursor-type) + (setq focus-read-only-blink-timer + (run-at-time focus-read-only-blink-seconds nil + 'focus-read-only-hide-cursor))))) + +(defun focus-read-only-init () + "Run when `focus-read-only-mode' is activated. +Enables `read-only-mode', hides the cursor and adds +`focus-read-only-cursor-blink' to `pre-command-hook'. +Also `focus-read-only-terminate' is added to the `kill-buffer-hook'." + (read-only-mode 1) + (setq cursor-type nil + focus-buffer (current-buffer)) + (add-hook 'pre-command-hook 'focus-read-only-cursor-blink nil t) + (add-hook 'kill-buffer-hook 'focus-read-only-terminate nil t)) + +(defun focus-read-only-terminate () + "Run when `focus-read-only-mode' is deactivated. +Disables `read-only-mode' and shows the cursor again. +It cleans up the `focus-read-only-blink-timer' and hooks." + (read-only-mode -1) + (setq cursor-type focus-cursor-type) + (when focus-read-only-blink-timer + (cancel-timer focus-read-only-blink-timer)) + (setq focus-read-only-blink-timer nil) + (remove-hook 'pre-command-hook 'focus-read-only-cursor-blink t) + (remove-hook 'kill-buffer-hook 'focus-read-only-terminate t)) + +(defun focus-turn-off-focus-read-only-mode () + "Turn off `focus-read-only-mode'." + (interactive) + (focus-read-only-mode -1)) + +;;;###autoload +(define-minor-mode focus-mode + "Dim the font color of text in surrounding sections." + :init-value nil + :keymap (let ((map (make-sparse-keymap))) + (define-key map (kbd "C-c C-q") 'focus-read-only-mode) + map) + (if focus-mode (focus-init) (focus-terminate))) + +;;;###autoload +(define-minor-mode focus-read-only-mode + "A read-only mode optimized for `focus-mode'." + :init-value nil + :keymap (let ((map (make-sparse-keymap))) + (define-key map (kbd "n") 'focus-next-thing) + (define-key map (kbd "SPC") 'focus-next-thing) + (define-key map (kbd "p") 'focus-prev-thing) + (define-key map (kbd "S-SPC") 'focus-prev-thing) + (define-key map (kbd "i") 'focus-turn-off-focus-read-only-mode) + (define-key map (kbd "q") 'focus-turn-off-focus-read-only-mode) + map) + (when cursor-type + (setq focus-cursor-type cursor-type)) + (if focus-read-only-mode (focus-read-only-init) (focus-read-only-terminate))) + +(provide 'focus) +;;; focus.el ends here diff --git a/common/_global.el b/common/_global.el index 0e449ab..0e68960 100644 --- a/common/_global.el +++ b/common/_global.el @@ -8,7 +8,7 @@ (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t) ; this goes in chemacs2 init -- DO NOT UNCOMMENT (package-initialize) ; this goes in chemacs2 init -- DO NOT UNCOMMENT (add-to-list 'package-selected-packages - '(zoom popwin dired-single diredfl xclip doominhibitinhibit-modeline magit helpful helm helm-org helm-ls-git projectile helm-projectile dired-rainbow dired-rainbow-listing dired-single dash s origami persp-mode persp-mode-projectile-bridge modus-themes transpose-frame use-package) + '(focus zoom popwin dired-single diredfl xclip doominhibitinhibit-modeline magit helpful helm helm-org helm-ls-git projectile helm-projectile dired-rainbow dired-rainbow-listing dired-single dash s origami persp-mode persp-mode-projectile-bridge modus-themes transpose-frame use-package) ) (require 'use-package) @@ -296,6 +296,10 @@ position between last non-whitespace and `end-of-line'." (modus-themes-load-vivendi) ) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +; focus on text (turn on as desired/needed ; off by default +(require 'focus) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; helm (setq completion-styles '(flex)) @@ -316,6 +320,8 @@ position between last non-whitespace and `end-of-line'." (global-set-key (kbd "C-x C-d") 'helm-browse-project) (global-set-key (kbd "C-x b") 'list-buffers) +(global-set-key (kbd "C-x f") 'focus-mode) +(global-set-key (kbd "C-x c") 'focus-read-only-mode) (define-key global-map [remap find-file] 'helm-find-files) (define-key global-map [remap occur] 'helm-occur) (define-key global-map [remap list-buffers] 'helm-buffers-list) diff --git a/org/elpa/focus-20220910.1300/focus-autoloads.el b/org/elpa/focus-20220910.1300/focus-autoloads.el new file mode 100644 index 0000000..31383d3 --- /dev/null +++ b/org/elpa/focus-20220910.1300/focus-autoloads.el @@ -0,0 +1,60 @@ +;;; focus-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*- +;; +;;; Code: + +(add-to-list 'load-path (directory-file-name + (or (file-name-directory #$) (car load-path)))) + + +;;;### (autoloads nil "focus" "focus.el" (0 0 0 0)) +;;; Generated autoloads from focus.el + +(autoload 'focus-mode "focus" "\ +Dim the font color of text in surrounding sections. + +This is a minor mode. If called interactively, toggle the `Focus +mode' mode. If the prefix argument is positive, enable the mode, +and if it is zero or negative, disable the mode. + +If called from Lisp, toggle the mode if ARG is `toggle'. Enable +the mode if ARG is nil, omitted, or is a positive number. +Disable the mode if ARG is a negative number. + +To check whether the minor mode is enabled in the current buffer, +evaluate `focus-mode'. + +The mode's hook is called both when the mode is enabled and when +it is disabled. + +\(fn &optional ARG)" t nil) + +(autoload 'focus-read-only-mode "focus" "\ +A read-only mode optimized for `focus-mode'. + +This is a minor mode. If called interactively, toggle the +`Focus-Read-Only mode' mode. If the prefix argument is positive, +enable the mode, and if it is zero or negative, disable the mode. + +If called from Lisp, toggle the mode if ARG is `toggle'. Enable +the mode if ARG is nil, omitted, or is a positive number. +Disable the mode if ARG is a negative number. + +To check whether the minor mode is enabled in the current buffer, +evaluate `focus-read-only-mode'. + +The mode's hook is called both when the mode is enabled and when +it is disabled. + +\(fn &optional ARG)" t nil) + +(register-definition-prefixes "focus" '("focus-")) + +;;;*** + +;; Local Variables: +;; version-control: never +;; no-byte-compile: t +;; no-update-autoloads: t +;; coding: utf-8 +;; End: +;;; focus-autoloads.el ends here diff --git a/org/elpa/focus-20220910.1300/focus-pkg.el b/org/elpa/focus-20220910.1300/focus-pkg.el new file mode 100644 index 0000000..f85eded --- /dev/null +++ b/org/elpa/focus-20220910.1300/focus-pkg.el @@ -0,0 +1,2 @@ +;;; Generated package description from focus.el -*- no-byte-compile: t -*- +(define-package "focus" "20220910.1300" "Dim the font color of text in surrounding sections" '((emacs "24.3") (cl-lib "0.5")) :commit "9dd85fc474bbc1ebf22c287752c960394fcd465a" :authors '(("Lars Tveito" . "larstvei@ifi.uio.no")) :maintainer '("Lars Tveito" . "larstvei@ifi.uio.no") :url "http://github.com/larstvei/Focus") diff --git a/org/elpa/focus-20220910.1300/focus.el b/org/elpa/focus-20220910.1300/focus.el new file mode 100644 index 0000000..5951bb7 --- /dev/null +++ b/org/elpa/focus-20220910.1300/focus.el @@ -0,0 +1,288 @@ +;;; focus.el --- Dim the font color of text in surrounding sections -*- lexical-binding: t; -*- + +;; Copyright (C) 2015 Lars Tveito + +;; Author: Lars Tveito +;; URL: http://github.com/larstvei/Focus +;; Package-Version: 20220910.1300 +;; Package-Commit: 9dd85fc474bbc1ebf22c287752c960394fcd465a +;; Created: 11th May 2015 +;; Version: 1.0.0 +;; Package-Requires: ((emacs "24.3") (cl-lib "0.5")) + +;; This program 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. + +;; This program 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 this program. If not, see . + +;;; Commentary: + +;; Focus provides `focus-mode` that dims the text of surrounding sections, +;; similar to [iA Writer's](https://ia.net/writer) Focus Mode. +;; +;; Enable the mode with `M-x focus-mode'. + +;;; Code: + +(require 'cl-lib) +(require 'thingatpt) + +(defgroup focus () + "Dim the font color of text in surrounding sections." + :group 'font-lock + :prefix "focus-") + +(defcustom focus-mode-to-thing '((prog-mode . defun) + (text-mode . paragraph) + (org-mode . org-element)) + "An associated list between mode and thing. + +A thing is defined in thingatpt.el; the thing determines the +narrowness of the focused section. + +Note that the order of the list matters. The first mode that the +current mode is derived from is used, so more modes that have +many derivatives should be placed by the end of the list. + +Things that are defined include `symbol', `list', `sexp', +`defun', `filename', `url', `email', `word', `sentence', +`whitespace', `line', and `page'." + :type '(alist :key-type symbol :valye-type symbol) + :group 'focus) + +(defcustom focus-read-only-blink-seconds 1 + "The duration of a cursor blink in `focus-read-only-mode'." + :type 'number + :group 'focus) + +(defface focus-unfocused + '((t :inherit shadow)) + "The face that overlays the unfocused area." + :group 'focus) + +(defface focus-focused nil + "The face that overlays the focused area." + :group 'focus) + +(defvar focus-cursor-type cursor-type + "Used to restore the users `cursor-type'.") + +(defvar-local focus-current-thing nil + "Overrides the choice of thing dictated by `focus-mode-to-thing' if set.") + +(defvar-local focus-buffer nil + "Local reference to the buffer focus functions operate on.") + +(defvar-local focus-pre-overlay nil + "The overlay that dims the text prior to the current-point.") + +(defvar-local focus-mid-overlay nil + "The overlay that surrounds the text of the current-point.") + +(defvar-local focus-post-overlay nil + "The overlay that dims the text past the current-point.") + +(defvar-local focus-read-only-blink-timer nil + "Timer started from `focus-read-only-cursor-blink'. +The timer calls `focus-read-only-hide-cursor' after +`focus-read-only-blink-seconds' seconds.") + +(defun focus-get-thing () + "Return the current thing, based on `focus-mode-to-thing'." + (or focus-current-thing + (let* ((modes (mapcar 'car focus-mode-to-thing)) + (mode (or (cl-find major-mode modes) + (apply #'derived-mode-p modes)))) + (if mode (cdr (assoc mode focus-mode-to-thing)) 'sentence)))) + +(defun focus-bounds () + "Return the current bounds, based on `focus-get-thing'." + (let ((thing (focus-get-thing))) + (cond ((eq thing 'org-element) + (let* ((elem (org-element-at-point)) + (beg (org-element-property :begin elem)) + (end (org-element-property :end elem))) + (cons beg end))) + (t (bounds-of-thing-at-point (focus-get-thing)))))) + +(defun focus-move-focus () + "Move the focused section according to `focus-bounds'. + +If `focus-mode' is enabled, this command fires after each +command." + (with-current-buffer focus-buffer + (let* ((bounds (focus-bounds))) + (when bounds + (focus-move-overlays (car bounds) (cdr bounds)))))) + +(defun focus-move-overlays (low high) + "Move the overlays to highlight the region between LOW and HIGH." + (move-overlay focus-pre-overlay (point-min) low) + (move-overlay focus-mid-overlay low high) + (move-overlay focus-post-overlay high (point-max))) + +(defun focus-init () + "This function is run when command `focus-mode' is enabled. + +It sets the `focus-pre-overlay', `focus-min-overlay', and +`focus-post-overlay' to overlays; these are invisible until +`focus-move-focus' is run. It adds `focus-move-focus' to +`post-command-hook'." + (unless (or focus-pre-overlay focus-post-overlay) + (setq focus-pre-overlay (make-overlay (point-min) (point-min)) + focus-mid-overlay (make-overlay (point-min) (point-max)) + focus-post-overlay (make-overlay (point-max) (point-max)) + focus-buffer (current-buffer)) + (overlay-put focus-mid-overlay 'face 'focus-focused) + (mapc (lambda (o) (overlay-put o 'face 'focus-unfocused)) + (list focus-pre-overlay focus-post-overlay)) + (add-hook 'post-command-hook 'focus-move-focus nil t) + (add-hook 'change-major-mode-hook 'focus-terminate nil t))) + +(defun focus-terminate () + "This function is run when command `focus-mode' is disabled. + +The overlays pointed to by `focus-pre-overlay', +`focus-mid-overlay' and `focus-post-overlay' are deleted, and +`focus-move-focus' is removed from `post-command-hook'." + (when (and focus-pre-overlay focus-post-overlay) + (mapc 'delete-overlay + (list focus-pre-overlay focus-mid-overlay focus-post-overlay)) + (remove-hook 'post-command-hook 'focus-move-focus t) + (setq focus-pre-overlay nil + focus-mid-overlay nil + focus-post-overlay nil))) + +(defun focus-goto-thing (bounds) + "Move point to the middle of BOUNDS." + (when bounds + (goto-char (/ (+ (car bounds) (cdr bounds)) 2)) + (recenter nil))) + +(defun focus-change-thing () + "Adjust the narrowness of the focused section for the current buffer. + +The variable `focus-mode-to-thing' dictates the default thing +according to major-mode. If `focus-current-thing' is set, this +default is overwritten. This function simply helps set the +`focus-current-thing'." + (interactive) + (let* ((candidates '(defun line list org-element paragraph sentence sexp symbol word)) + (thing (completing-read "Thing: " candidates))) + (setq focus-current-thing (intern thing)))) + +(defun focus-pin () + "Pin the focused section to its current location or the region, if active." + (interactive) + (when (bound-and-true-p focus-mode) + (when (region-active-p) + (focus-move-overlays (region-beginning) (region-end))) + (remove-hook 'post-command-hook 'focus-move-focus t))) + +(defun focus-unpin () + "Unpin the focused section." + (interactive) + (when (bound-and-true-p focus-mode) + (add-hook 'post-command-hook 'focus-move-focus nil t))) + +(defun focus-next-thing (&optional n) + "Move the point to the middle of the Nth next thing." + (interactive "p") + (let ((current-bounds (focus-bounds)) + (thing (focus-get-thing))) + (forward-thing thing n) + (when (equal current-bounds (focus-bounds)) + (forward-thing thing (cl-signum n))) + (focus-goto-thing (focus-bounds)))) + +(defun focus-prev-thing (&optional n) + "Move the point to the middle of the Nth previous thing." + (interactive "p") + (focus-next-thing (- n))) + +(defun focus-read-only-hide-cursor () + "Hide the cursor. +This function is triggered by the `focus-read-only-blink-timer', +when `focus-read-only-mode' is activated." + (with-current-buffer focus-buffer + (when (and (bound-and-true-p focus-read-only-mode) + (not (null focus-read-only-blink-timer))) + (setq focus-read-only-blink-timer nil) + (setq cursor-type nil)))) + +(defun focus-read-only-cursor-blink () + "Make the cursor visible for `focus-read-only-blink-seconds'. +This is added to the `pre-command-hook' when +`focus-read-only-mode' is active." + (with-current-buffer focus-buffer + (when (and (bound-and-true-p focus-read-only-mode) + (not (member last-command '(focus-next-thing focus-prev-thing)))) + (when focus-read-only-blink-timer (cancel-timer focus-read-only-blink-timer)) + (setq cursor-type focus-cursor-type) + (setq focus-read-only-blink-timer + (run-at-time focus-read-only-blink-seconds nil + 'focus-read-only-hide-cursor))))) + +(defun focus-read-only-init () + "Run when `focus-read-only-mode' is activated. +Enables `read-only-mode', hides the cursor and adds +`focus-read-only-cursor-blink' to `pre-command-hook'. +Also `focus-read-only-terminate' is added to the `kill-buffer-hook'." + (read-only-mode 1) + (setq cursor-type nil + focus-buffer (current-buffer)) + (add-hook 'pre-command-hook 'focus-read-only-cursor-blink nil t) + (add-hook 'kill-buffer-hook 'focus-read-only-terminate nil t)) + +(defun focus-read-only-terminate () + "Run when `focus-read-only-mode' is deactivated. +Disables `read-only-mode' and shows the cursor again. +It cleans up the `focus-read-only-blink-timer' and hooks." + (read-only-mode -1) + (setq cursor-type focus-cursor-type) + (when focus-read-only-blink-timer + (cancel-timer focus-read-only-blink-timer)) + (setq focus-read-only-blink-timer nil) + (remove-hook 'pre-command-hook 'focus-read-only-cursor-blink t) + (remove-hook 'kill-buffer-hook 'focus-read-only-terminate t)) + +(defun focus-turn-off-focus-read-only-mode () + "Turn off `focus-read-only-mode'." + (interactive) + (focus-read-only-mode -1)) + +;;;###autoload +(define-minor-mode focus-mode + "Dim the font color of text in surrounding sections." + :init-value nil + :keymap (let ((map (make-sparse-keymap))) + (define-key map (kbd "C-c C-q") 'focus-read-only-mode) + map) + (if focus-mode (focus-init) (focus-terminate))) + +;;;###autoload +(define-minor-mode focus-read-only-mode + "A read-only mode optimized for `focus-mode'." + :init-value nil + :keymap (let ((map (make-sparse-keymap))) + (define-key map (kbd "n") 'focus-next-thing) + (define-key map (kbd "SPC") 'focus-next-thing) + (define-key map (kbd "p") 'focus-prev-thing) + (define-key map (kbd "S-SPC") 'focus-prev-thing) + (define-key map (kbd "i") 'focus-turn-off-focus-read-only-mode) + (define-key map (kbd "q") 'focus-turn-off-focus-read-only-mode) + map) + (when cursor-type + (setq focus-cursor-type cursor-type)) + (if focus-read-only-mode (focus-read-only-init) (focus-read-only-terminate))) + +(provide 'focus) +;;; focus.el ends here