[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#18730: [PATCHv2 2/2] tildify.el: Add `auto-tildify' and `auto-tildif
From: |
Michal Nazarewicz |
Subject: |
bug#18730: [PATCHv2 2/2] tildify.el: Add `auto-tildify' and `auto-tildify-mode'. |
Date: |
Thu, 16 Oct 2014 17:34:12 +0200 |
The `auto-tildify' function can be used as
a `post-self-insert-hook' to automatically convert spaces into
hard spaces. It is configured via two new customize variables:
`auto-tildify-pattern-alist' and `auto-tildify-check-envs'.
`auto-tildify-mode' makes use of that function to enable
eletric behaviour of space character.
---
etc/NEWS | 5 +++
lisp/textmodes/tildify.el | 96 ++++++++++++++++++++++++++++++++++++++++-
test/automated/tildify-tests.el | 32 ++++++++++++++
3 files changed, 132 insertions(+), 1 deletion(-)
diff --git a/etc/NEWS b/etc/NEWS
index 36f1d9d..b6d4055 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -269,6 +269,11 @@ These emulations of old editors are believed to be no
longer relevant
* New Modes and Packages in Emacs 25.1
+** `tildify-mode' automatically hardens spaces as one types the text.
+Breaking line after a single-character words is forbidden by Czech and Polish
+typography. `tildify-mode' makes creating a typographically-correct markup in
+formats such as HTML, LaTeX, Markdown, etc.
+
* Incompatible Lisp Changes in Emacs 25.1
diff --git a/lisp/textmodes/tildify.el b/lisp/textmodes/tildify.el
index 91f5a38..33067a6 100644
--- a/lisp/textmodes/tildify.el
+++ b/lisp/textmodes/tildify.el
@@ -4,7 +4,7 @@
;; Author: Milan Zamazal <pdm@zamazal.org>
;; Michal Nazarewicz <mina86@mina86.com>
-;; Version: 4.5.4
+;; Version: 4.6
;; Keywords: text, TeX, SGML, wp
;; This file is part of GNU Emacs.
@@ -344,6 +344,100 @@ replacements done and response is one of symbols: t (all
right), nil
(t t))))))
+;;; *** Auto Tildify ***
+
+(defcustom tildify-space-pattern-alist
+ '((t . "[,:;(][ \t]*[a]\\|\\<[AIKOSUVWZikosuvwz]"))
+ "Alist specifying whether a hard space is required at point.
+
+Each alist item is of the form (MAJOR-MODE . REGEXP) or
+\(MAJOR-MODE . SYMBOL).
+
+MAJOR-MODE defines major mode, for which the item applies. It can be either:
+- a symbol equal to the major mode of the buffer to be fixed
+- t for default item, this applies to all major modes not defined in another
+ alist item
+
+REGEXP is a regular expression matching the part of a text that
+needs a hard space to be inserted instead of a space. The regexp
+is always case sensitive, regardless of the current
+`case-fold-search' setting.
+
+The form (MAJOR-MODE . SYMBOL) defines alias item for MAJOR-MODE. For this
+mode, the item for the mode SYMBOL is looked up in the alist instead."
+ :group 'tildify
+ :type '(repeat (cons (choice (const :tag "Default" t)
+ (symbol :tag "For mode "))
+ (choice (regexp :tag "Regexp ")
+ (symbol :tag "Like mode")))))
+
+(defcustom tildify-space-check-envs t
+ "Should `tildify-space' check if point is inside ignored environment."
+ :group 'tildify
+ :type 'boolean)
+
+
+(defun tildify-space ()
+ "Convert space before point into a hard space if the context is right.
+
+If
+ * character before point is a space character,
+ * character before that has “w” character syntax (i.e. it's a word
+ constituent),
+ * pattern from `tildify-space-pattern-alist' matches when `looking-back' (no
+ more than 10 characters) from before the space character, and
+ * `tildify-space-check-envs' is nil or point is not inside of an environment
to
+ ignore
+replace the space character with a hard space specified in
+`tildify-string-alist'.
+
+Return t if conversion happened, nil otherwise.
+
+This function is meant to be used as a `post-self-insert-hook'."
+ (let ((p (point)) case-fold-search space pattern)
+ (when (and (> (- p (point-min)) 2)
+ (eq (preceding-char) ?\s)
+ (eq (char-syntax (char-before (1- p))) ?w)
+ (setq space (tildify--pick-alist-entry tildify-string-alist))
+ (not (string-equal " " space))
+ (setq pattern (tildify--pick-alist-entry
+ tildify-space-pattern-alist))
+ (save-excursion
+ (goto-char (1- p))
+ (looking-back pattern (max (point-min) (- p 10))))
+ (or (not tildify-space-check-envs)
+ (catch 'found
+ (tildify-foreach-region-outside-env (- p 2) (1- p)
+ (lambda (beg end) (throw 'found t))))))
+ (delete-char -1)
+ (insert space)
+ t)))
+
+;;;###autoload
+(define-minor-mode tildify-mode
+ "Adds electric behaviour to space character.
+
+When space is inserted into a buffer in a position where hard
+space is required instead, that space character is replaced by
+a hard space correct for given mode.
+
+Converting of the space is done by `tildify-space'."
+ nil " ~" nil
+ (when tildify-mode
+ (when (let ((space (tildify--pick-alist-entry tildify-string-alist)))
+ (or (not space) (string-equal " " space)))
+ (message (concat "Hard space for %s is a single space character, "
+ "tildify won't have any effect.") major-mode)
+ (setq tildify-mode nil))
+ (when (not (tildify--pick-alist-entry tildify-space-pattern-alist))
+ (message (concat "No pattern defined for %s, "
+ "tildify won't have any effect.") major-mode)
+ (setq tildify-mode nil)))
+ (if tildify-mode
+ (add-hook 'post-self-insert-hook 'tildify-space nil t)
+ (remove-hook 'post-self-insert-hook 'tildify-space t)))
+
+
;;; *** Announce ***
(provide 'tildify)
diff --git a/test/automated/tildify-tests.el b/test/automated/tildify-tests.el
index 53c2e62..7ba270a 100644
--- a/test/automated/tildify-tests.el
+++ b/test/automated/tildify-tests.el
@@ -132,6 +132,38 @@ latter is missing, SENTENCE will be used in all
placeholder positions."
(should (string-equal "close-foo" (tildify-find-env beg-re pairs))))))
+(defun tildify-space-test--test (modes nbsp env-open)
+ (with-temp-buffer
+ (dolist (mode modes)
+ (erase-buffer)
+ (funcall mode)
+ (let ((header (concat "Testing `tildify-space' in "
+ (symbol-name mode) "\n")))
+ (insert header "Lorem v ")
+ (should (tildify-space))
+ (should (string-equal (concat header "Lorem v" nbsp) (buffer-string))))
+ (erase-buffer)
+ (let ((header (concat "Testing `tildify-space' in "
+ (symbol-name mode) "\n")))
+ (insert header env-open "Lorem v ")
+ (should (not (tildify-space)))
+ (should (string-equal (concat header env-open "Lorem v ")
+ (buffer-string)))))))
+
+(ert-deftest tildify-space-test-html ()
+ "Tests auto-tildification in an HTML document"
+ (tildify-space-test--test '(html-mode sgml-mode) " " "<pre>"))
+
+(ert-deftest tildify-space-test-xml ()
+ "Tests auto-tildification in an XML document"
+ (tildify-space-test--test '(nxml-mode) " " "<! -- "))
+
+(ert-deftest tildify-space-test-tex ()
+ "Tests tildification in a TeX document"
+ (tildify-space-test--test '(tex-mode latex-mode plain-tex-mode)
+ "~" "\\verb# "))
+
+
(provide 'tildify-tests)
;;; tildify-tests.el ends here
--
2.1.0.rc2.206.gedb03e5
- bug#18730: [PATCH] tildify.el: Add `auto-tildify' and `auto-tildify-mode'., (continued)
bug#18730: [PATCH] tildify.el: Add `auto-tildify' and `auto-tildify-mode'., Ted Zlatanov, 2014/10/16
bug#18730: [PATCH] tildify.el: Add `auto-tildify' and `auto-tildify-mode'., Ted Zlatanov, 2014/10/16
bug#18730: [PATCHv2 1/2] tildify.el (tildify--pick-alist-entry): rename from tildify-mode-alist., Michal Nazarewicz, 2014/10/16