mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-15 10:30:25 -08:00
Use lexical-binding in delim-col.el and add tests
Thanks to Basil L. Contovounesios for additional cleanups. For discussion, see the following thread: https://lists.gnu.org/archive/html/emacs-devel/2019-05/msg00177.html * lisp/delim-col.el: Use lexical-binding. * test/lisp/delim-col-tests.el: New file. (delim-col-tests-delimit-colummns-before-after) (delim-col-tests-delimit-columns) (delim-col-tests-delimit-columns-format/nil) (delim-col-tests-delimit-columns-format/padding) (delim-col-tests-delimit-columns-format/separator) (delim-col-tests-delimit-columns-separator) (delim-col-tests-delimit-columns-str-before-after) (delim-col-tests-delimit-columns-str-separator) (delim-col-tests-delimit-rectangle): New unit tests.
This commit is contained in:
Stefan Kangas
Basil L. Contovounesios
parent
9813905f83
commit
4498e5a13a
2 changed files with 212 additions and 39 deletions
|
|
@ -1,12 +1,12 @@
|
|||
;;; delim-col.el --- prettify all columns in a region or rectangle
|
||||
;;; delim-col.el --- prettify all columns in a region or rectangle -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 1999-2019 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: Vinicius Jose Latorre <viniciusjl.gnu@gmail.com>
|
||||
;; Maintainer: Vinicius Jose Latorre <viniciusjl.gnu@gmail.com>
|
||||
;; Version: 2.1
|
||||
;; Keywords: internal
|
||||
;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
|
||||
;; Keywords: convenience text
|
||||
;; X-URL: https://www.emacswiki.org/emacs/ViniciusJoseLatorre
|
||||
|
||||
;; This file is part of GNU Emacs.
|
||||
|
||||
|
|
@ -27,11 +27,6 @@
|
|||
|
||||
;; delim-col helps to prettify columns in a text region or rectangle.
|
||||
;;
|
||||
;; To use it, make sure that this file is in load-path and insert in your
|
||||
;; .emacs:
|
||||
;;
|
||||
;; (require 'delim-col)
|
||||
;;
|
||||
;; If you have, for example, the following columns:
|
||||
;;
|
||||
;; a b c d
|
||||
|
|
@ -91,9 +86,9 @@
|
|||
;; aaa [ <bbb>, <cccc> ] dddd
|
||||
;; aa [ <bb> , <ccccccc> ] ddd
|
||||
;;
|
||||
;; Note that `delimit-columns-region' operates over all text region
|
||||
;; selected, extending the region start to the beginning of line and the
|
||||
;; region end to the end of line. While `delimit-columns-rectangle'
|
||||
;; Note that `delimit-columns-region' operates over the entire selected
|
||||
;; text region, extending the region start to the beginning of line and
|
||||
;; the region end to the end of line. While `delimit-columns-rectangle'
|
||||
;; operates over the text rectangle selected which rectangle diagonal is
|
||||
;; given by the region start and end.
|
||||
;;
|
||||
|
|
@ -117,6 +112,7 @@
|
|||
|
||||
;;; Code:
|
||||
|
||||
(require 'rect)
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
;; User Options:
|
||||
|
|
@ -125,6 +121,7 @@
|
|||
"Prettify columns."
|
||||
:link '(emacs-library-link :tag "Source Lisp File" "delim-col.el")
|
||||
:prefix "delimit-columns-"
|
||||
:group 'convenience
|
||||
:group 'text)
|
||||
|
||||
(defcustom delimit-columns-str-before ""
|
||||
|
|
@ -213,10 +210,11 @@ See also `delimit-columns-end' for documentation.
|
|||
The following relation must hold:
|
||||
0 <= delimit-columns-start <= delimit-columns-end
|
||||
|
||||
The column number start from 0 and it's relative to the beginning of selected
|
||||
region. So if you selected a text region, the first column (column 0) is
|
||||
located at beginning of line. If you selected a text rectangle, the first
|
||||
column (column 0) is located at left corner."
|
||||
The column number starts at 0 and is relative to the beginning of
|
||||
the selected region. So if you select a text region, the first
|
||||
column (column 0) is located at the beginning of line. If you
|
||||
select a text rectangle, the first column (column 0) is located
|
||||
at the left corner."
|
||||
:type '(integer :tag "Column Start")
|
||||
:group 'columns)
|
||||
|
||||
|
|
@ -228,10 +226,11 @@ See also `delimit-columns-start' for documentation.
|
|||
The following relation must hold:
|
||||
0 <= delimit-columns-start <= delimit-columns-end
|
||||
|
||||
The column number start from 0 and it's relative to the beginning of selected
|
||||
region. So if you selected a text region, the first column (column 0) is
|
||||
located at beginning of line. If you selected a text rectangle, the first
|
||||
column (column 0) is located at left corner."
|
||||
The column number starts at 0 and is relative to the beginning of
|
||||
the selected region. So if you select a text region, the first
|
||||
column (column 0) is located at the beginning of line. If you
|
||||
select a text rectangle, the first column (column 0) is located
|
||||
at the left corner."
|
||||
:type '(integer :tag "Column End")
|
||||
:group 'columns)
|
||||
|
||||
|
|
@ -247,20 +246,20 @@ column (column 0) is located at left corner."
|
|||
|
||||
;;;###autoload
|
||||
(defun delimit-columns-customize ()
|
||||
"Customization of `columns' group."
|
||||
"Customize the `columns' group."
|
||||
(interactive)
|
||||
(customize-group 'columns))
|
||||
|
||||
|
||||
(defmacro delimit-columns-str (str)
|
||||
`(if (stringp ,str) ,str ""))
|
||||
(defun delimit-columns-str (str)
|
||||
(if (stringp str) str ""))
|
||||
|
||||
|
||||
;;;###autoload
|
||||
(defun delimit-columns-region (start end)
|
||||
"Prettify all columns in a text region.
|
||||
|
||||
START and END delimits the text region."
|
||||
START and END delimit the text region."
|
||||
(interactive "*r")
|
||||
(let ((delimit-columns-str-before
|
||||
(delimit-columns-str delimit-columns-str-before))
|
||||
|
|
@ -273,8 +272,7 @@ START and END delimits the text region."
|
|||
(delimit-columns-after
|
||||
(delimit-columns-str delimit-columns-after))
|
||||
(delimit-columns-start
|
||||
(if (and (integerp delimit-columns-start)
|
||||
(>= delimit-columns-start 0))
|
||||
(if (natnump delimit-columns-start)
|
||||
delimit-columns-start
|
||||
0))
|
||||
(delimit-columns-end
|
||||
|
|
@ -309,14 +307,11 @@ START and END delimits the text region."
|
|||
(set-marker the-end nil)))))
|
||||
|
||||
|
||||
(require 'rect)
|
||||
|
||||
|
||||
;;;###autoload
|
||||
(defun delimit-columns-rectangle (start end)
|
||||
"Prettify all columns in a text rectangle.
|
||||
|
||||
START and END delimits the corners of text rectangle."
|
||||
START and END delimit the corners of the text rectangle."
|
||||
(interactive "*r")
|
||||
(let ((delimit-columns-str-before
|
||||
(delimit-columns-str delimit-columns-str-before))
|
||||
|
|
@ -329,8 +324,7 @@ START and END delimits the corners of text rectangle."
|
|||
(delimit-columns-after
|
||||
(delimit-columns-str delimit-columns-after))
|
||||
(delimit-columns-start
|
||||
(if (and (integerp delimit-columns-start)
|
||||
(>= delimit-columns-start 0))
|
||||
(if (natnump delimit-columns-start)
|
||||
delimit-columns-start
|
||||
0))
|
||||
(delimit-columns-end
|
||||
|
|
@ -344,11 +338,11 @@ START and END delimits the corners of text rectangle."
|
|||
;; get maximum length for each column
|
||||
(and delimit-columns-format
|
||||
(save-excursion
|
||||
(operate-on-rectangle 'delimit-columns-rectangle-max
|
||||
(operate-on-rectangle #'delimit-columns-rectangle-max
|
||||
start the-end nil)))
|
||||
;; prettify columns
|
||||
(save-excursion
|
||||
(operate-on-rectangle 'delimit-columns-rectangle-line
|
||||
(operate-on-rectangle #'delimit-columns-rectangle-line
|
||||
start the-end nil))
|
||||
;; nullify markers
|
||||
(set-marker delimit-columns-limit nil)
|
||||
|
|
@ -359,7 +353,7 @@ START and END delimits the corners of text rectangle."
|
|||
;; Internal Variables and Functions:
|
||||
|
||||
|
||||
(defun delimit-columns-rectangle-max (startpos &optional _ignore1 _ignore2)
|
||||
(defun delimit-columns-rectangle-max (startpos &optional _begextra _endextra)
|
||||
(set-marker delimit-columns-limit (point))
|
||||
(goto-char startpos)
|
||||
(let ((ncol 1)
|
||||
|
|
@ -392,7 +386,7 @@ START and END delimits the corners of text rectangle."
|
|||
(setq values (cdr values)))))
|
||||
|
||||
|
||||
(defun delimit-columns-rectangle-line (startpos &optional _ignore1 _ignore2)
|
||||
(defun delimit-columns-rectangle-line (startpos &optional _begextra _endextra)
|
||||
(let ((len (length delimit-columns-max))
|
||||
(ncol 0)
|
||||
origin)
|
||||
|
|
@ -442,8 +436,7 @@ START and END delimits the corners of text rectangle."
|
|||
((eq delimit-columns-format 'padding)
|
||||
(insert spaces delimit-columns-after delimit-columns-str-after))
|
||||
(t
|
||||
(insert delimit-columns-after spaces delimit-columns-str-after))
|
||||
))
|
||||
(insert delimit-columns-after spaces delimit-columns-str-after))))
|
||||
(goto-char (max (point) delimit-columns-limit))))
|
||||
|
||||
|
||||
|
|
@ -466,8 +459,7 @@ START and END delimits the corners of text rectangle."
|
|||
(insert delimit-columns-after
|
||||
delimit-columns-str-separator
|
||||
spaces
|
||||
delimit-columns-before))
|
||||
))
|
||||
delimit-columns-before))))
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
|
|
|||
181
test/lisp/delim-col-tests.el
Normal file
181
test/lisp/delim-col-tests.el
Normal file
|
|
@ -0,0 +1,181 @@
|
|||
;;; delim-col-tests.el --- Tests for delim-col.el -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2019 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: Stefan Kangas <stefankangas@gmail.com>
|
||||
|
||||
;; This file is part of GNU Emacs.
|
||||
|
||||
;; GNU Emacs 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.
|
||||
|
||||
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;;; Code:
|
||||
|
||||
(require 'ert)
|
||||
(require 'delim-col)
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns ()
|
||||
(with-temp-buffer
|
||||
(insert "a b c\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string) "a, b, c\n")))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aaaa bb ccc ddddd\n"
|
||||
"aaa bbb cccc dddd\n"
|
||||
"aa bb ccccccc ddd\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string)
|
||||
(concat "a, b, c, d \n"
|
||||
"aaaa, bb, ccc, ddddd\n"
|
||||
"aaa, bbb, cccc, dddd \n"
|
||||
"aa, bb, ccccccc, ddd \n")))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-rectangle ()
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aaaa bb ccc ddddd\n"
|
||||
"aaa bbb cccc dddd\n"
|
||||
"aa bb ccccccc ddd\n")
|
||||
(delimit-columns-rectangle 3 58) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a b, c d\n"
|
||||
"aaaa bb, ccc ddddd\n"
|
||||
"aaa bbb, cccc dddd\n"
|
||||
"aa bb, ccccccc ddd\n")))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-str-separator ()
|
||||
(let ((delimit-columns-str-separator ":"))
|
||||
(with-temp-buffer
|
||||
(insert "a b\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string) "a:b\n")))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aa bb cc dd\n")
|
||||
(delimit-columns-rectangle 3 16) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a b: c d\n"
|
||||
"aa bb:cc dd\n"))))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-str-before-after ()
|
||||
(let ((delimit-columns-str-before "[ ")
|
||||
(delimit-columns-str-after " ]"))
|
||||
(with-temp-buffer
|
||||
(insert "a b c\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string) "[ a, b, c ]\n")))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aaaa bb ccc ddddd\n"
|
||||
"aaa bbb cccc dddd\n"
|
||||
"aa bb ccccccc ddd\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string)
|
||||
(concat "[ a, b, c, d ]\n"
|
||||
"[ aaaa, bb, ccc, ddddd ]\n"
|
||||
"[ aaa, bbb, cccc, dddd ]\n"
|
||||
"[ aa, bb, ccccccc, ddd ]\n"))))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aaaa bb ccc ddddd\n"
|
||||
"aaa bbb cccc dddd\n"
|
||||
"aa bb ccccccc ddd\n")
|
||||
(delimit-columns-rectangle 3 58) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a [ b, c ] d\n"
|
||||
"aaaa [ bb, ccc ] ddddd\n"
|
||||
"aaa [ bbb, cccc ] dddd\n"
|
||||
"aa [ bb, ccccccc ] ddd\n"))))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-colummns-before-after ()
|
||||
(let ((delimit-columns-before "<")
|
||||
(delimit-columns-after ">"))
|
||||
(with-temp-buffer
|
||||
(insert "a b\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string) "<a>, <b>\n")))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aa bb cc dd\n")
|
||||
(delimit-columns-rectangle 3 17)
|
||||
(should (equal (buffer-string)
|
||||
(concat "a <b>, <c> d\n"
|
||||
"aa <bb>, <cc> dd\n"))))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-separator ()
|
||||
(let ((delimit-columns-separator ","))
|
||||
(with-temp-buffer
|
||||
(insert "a,b,c\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string) "a, b, c\n")))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-format/nil ()
|
||||
(let ((delimit-columns-format nil))
|
||||
(with-temp-buffer
|
||||
(insert "a b\n"
|
||||
"aa bb\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string)
|
||||
(concat "a, b\n"
|
||||
"aa, bb\n"))))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aa bb cc dd\n")
|
||||
(delimit-columns-rectangle 3 17) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a b, c d\n"
|
||||
"aa bb, cc dd\n"))))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-format/separator ()
|
||||
(let ((delimit-columns-format 'separator)
|
||||
(delimit-columns-before "<")
|
||||
(delimit-columns-after ">"))
|
||||
(with-temp-buffer
|
||||
(insert "a b\n"
|
||||
"aa bb\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string)
|
||||
(concat "<a> , <b> \n"
|
||||
"<aa>, <bb>\n"))))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aa bb cc dd\n")
|
||||
(delimit-columns-rectangle 3 17) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a <b> , <c> d\n"
|
||||
"aa <bb>, <cc> dd\n"))))))
|
||||
|
||||
(ert-deftest delim-col-tests-delimit-columns-format/padding ()
|
||||
(let ((delimit-columns-format 'padding)
|
||||
(delimit-columns-before "<")
|
||||
(delimit-columns-after ">"))
|
||||
(with-temp-buffer
|
||||
(insert "a b\n"
|
||||
"aa bb\n")
|
||||
(delimit-columns-region (point-min) (point-max))
|
||||
(should (equal (buffer-string)
|
||||
(concat "<a >, <b >\n"
|
||||
"<aa>, <bb>\n"))))
|
||||
(with-temp-buffer
|
||||
(insert "a b c d\n"
|
||||
"aa bb cc dd\n")
|
||||
(delimit-columns-rectangle 3 17) ; from first b to last c
|
||||
(should (equal (buffer-string)
|
||||
(concat "a <b >, <c > d\n"
|
||||
"aa <bb>, <cc> dd\n"))))))
|
||||
|
||||
(provide 'delim-col-tests)
|
||||
;;; delim-col-tests.el ends here
|
||||
Loading…
Add table
Add a link
Reference in a new issue