mirror of
https://github.com/larstvei/Focus.git
synced 2024-11-26 11:38:32 +00:00
Lars Tveito
35f3cf5d52
One can customize what sort of bounds should be used for a mode, where derived modes are used to generalize. By default text-mode and prog-mode are defined.
140 lines
5.2 KiB
EmacsLisp
140 lines
5.2 KiB
EmacsLisp
;;; focus.el --- Dim the font color of text in surrounding paragraphs -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2015 Lars Tveito
|
|
|
|
;; Author: Lars Tveito <larstvei@ifi.uio.no>
|
|
;; URL: http://github.com/larstvei/Focus
|
|
;; Created: 11th May 2015
|
|
;; Version: 0.0.1
|
|
;; Package-Requires: ((emacs "24") (cl-lib "1.0"))
|
|
|
|
;; 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 <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Focus provides `focus-mode` that dims the text of surrounding paragraphs,
|
|
;; 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)
|
|
|
|
(defcustom focus-dimness 0
|
|
"When `focus-mode' is enabled, the dimness of the sections that
|
|
are out of focus is determined by this integer. A positive value
|
|
increases the dimness of the sections, whilst a negative value
|
|
decreases the dimness.
|
|
|
|
The default is 0 which means a 50/50 mixture of the background
|
|
and foreground color."
|
|
:type '(integer)
|
|
:group 'focus)
|
|
|
|
(defcustom focus-mode-to-thing '((prog-mode . defun) (text-mode . sentence))
|
|
"An associated list between mode and thing (defined in
|
|
thingatpt), which 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 '(repeat symbol)
|
|
:group 'focus)
|
|
|
|
(defvar-local focus-pre-overlay nil
|
|
"The overlay that dims the text prior to the current-point.")
|
|
|
|
(defvar-local focus-post-overlay nil
|
|
"The overlay that dims the text past the current-point.")
|
|
|
|
(defun focus-any (f lst)
|
|
"This function takes a function and a list, and returns the
|
|
first NON-NIL value from applying F to an element in LST."
|
|
(when lst
|
|
(let ((v (funcall f (car lst))))
|
|
(if v v (focus-any f (cdr lst))))))
|
|
|
|
(defun focus-bounds ()
|
|
"Returns the bounds of the first thing in `focus-things-order' that
|
|
is NON-NIL."
|
|
(let* ((modes (mapcar 'car focus-things-order))
|
|
(mode (focus-any 'derived-mode-p modes))
|
|
(thing (if mode (cdr (assoc mode focus-things-order)) 'sentence)))
|
|
(bounds-of-thing-at-point thing)))
|
|
|
|
(defun focus-average-colors (color &rest colors)
|
|
"This function takes one or more colors and returns the average
|
|
of RGB values of the given colors."
|
|
(let* ((colors (cons color colors))
|
|
(colors (mapcar 'color-name-to-rgb colors))
|
|
(len (length colors))
|
|
(sums (apply 'cl-mapcar '+ colors))
|
|
(avg (mapcar (lambda (v) (/ v len)) sums)))
|
|
(apply 'color-rgb-to-hex avg)))
|
|
|
|
(defun focus-make-dim-color ()
|
|
"Uses `focus-dimness' to determine how dim a color that should
|
|
be generated, and returns this color."
|
|
(let ((background (face-attribute 'default :background))
|
|
(foreground (face-attribute 'default :foreground))
|
|
(backgrounds (if (> focus-dimness 0) focus-dimness 1))
|
|
(foregrounds (if (< focus-dimness 0) (- focus-dimness) 1)))
|
|
(apply 'focus-average-colors
|
|
(append (make-list backgrounds background)
|
|
(make-list foregrounds foreground)))))
|
|
|
|
(defun focus-move-focus ()
|
|
"If `focus-mode' is enabled, this command fires after each
|
|
command, and moves the dimming overlays."
|
|
(let* ((bounds (focus-bounds)))
|
|
(when bounds
|
|
(move-overlay focus-pre-overlay (point-min) (car bounds))
|
|
(move-overlay focus-post-overlay (cdr bounds) (point-max)))))
|
|
|
|
(defun focus-init ()
|
|
"This function is run when focus-mode is enabled. It sets the
|
|
`focus-pre-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'."
|
|
(setq focus-pre-overlay (make-overlay (point-min) (point-min))
|
|
focus-post-overlay (make-overlay (point-max) (point-max)))
|
|
(let ((color (focus-make-dim-color)))
|
|
(mapc (lambda (o) (overlay-put o 'face (cons 'foreground-color color)))
|
|
(list focus-pre-overlay focus-post-overlay)))
|
|
(add-hook 'post-command-hook 'focus-move-focus nil t))
|
|
|
|
(defun focus-terminate ()
|
|
"When `focus-mode' is disabled the overlays pointed to by
|
|
`focus-pre-overlay' and `focus-post-overlay' are deleted, and
|
|
`focus-move-focus' is removed from `post-command-hook'."
|
|
(progn (mapc 'delete-overlay (list focus-pre-overlay focus-post-overlay))
|
|
(remove-hook 'post-command-hook 'focus-move-focus t)))
|
|
|
|
;;;###autoload
|
|
(define-minor-mode focus-mode
|
|
"Dim the font color of text in surrounding paragraphs."
|
|
:init-value nil
|
|
(if focus-mode (focus-init) (focus-terminate)))
|
|
|
|
|
|
(provide 'focus)
|
|
;;; focus.el ends here
|