delim-col.el 14.6 KB
Newer Older
1
;;; delim-col.el --- prettify all columns in a region or rectangle
Dave Love's avatar
Dave Love committed
2

3
;; Copyright (C) 1999-2011 Free Software Foundation, Inc.
Dave Love's avatar
Dave Love committed
4

Vinicius Jose Latorre's avatar
Vinicius Jose Latorre committed
5 6
;; Author: Vinicius Jose Latorre <viniciusjl@ig.com.br>
;; Maintainer: Vinicius Jose Latorre <viniciusjl@ig.com.br>
7 8
;; Version: 2.1
;; Keywords: internal
Vinicius Jose Latorre's avatar
Vinicius Jose Latorre committed
9
;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
Dave Love's avatar
Dave Love committed
10 11 12

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Dave Love's avatar
Dave Love committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Dave Love's avatar
Dave Love committed
17

Dave Love's avatar
Dave Love committed
18 19 20 21
;; 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.
Dave Love's avatar
Dave Love committed
22

Dave Love's avatar
Dave Love committed
23
;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Dave Love's avatar
Dave Love committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38

;;; Commentary:

;; 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
;;	aaaa	bb	ccc	ddddd
39
;;	aaa	bbb	cccc	dddd
Dave Love's avatar
Dave Love committed
40 41 42 43 44 45 46
;;	aa	bb	ccccccc	ddd
;;
;; And the following settings:
;;
;;    (setq delimit-columns-str-before "[ ")
;;    (setq delimit-columns-str-after " ]")
;;    (setq delimit-columns-str-separator ", ")
47 48
;;    (setq delimit-columns-before "")
;;    (setq delimit-columns-after "")
Dave Love's avatar
Dave Love committed
49
;;    (setq delimit-columns-separator "\t")
50 51
;;    (setq delimit-columns-format 'separator)
;;    (setq delimit-columns-extra t)
Dave Love's avatar
Dave Love committed
52 53 54 55 56 57 58 59 60 61 62 63
;;
;; If you select the lines above and type:
;;
;;    M-x delimit-columns-region RET
;;
;; You obtain the following result:
;;
;;	[ a   , b  , c      , d     ]
;;	[ aaaa, bb , ccc    , ddddd ]
;;	[ aaa , bbb, cccc   , dddd  ]
;;	[ aa  , bb , ccccccc, ddd   ]
;;
64
;; But if you select start from the very first b to the very last c and type:
Dave Love's avatar
Dave Love committed
65 66 67 68 69 70 71 72 73 74
;;
;;    M-x delimit-columns-rectangle RET
;;
;; You obtain the following result:
;;
;;	a	[ b  , c       ]	d
;;	aaaa	[ bb , ccc     ]	ddddd
;;	aaa	[ bbb, cccc    ]	dddd
;;	aa	[ bb , ccccccc ]	ddd
;;
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
;; Now, if we change settings to:
;;
;;    (setq delimit-columns-before "<")
;;    (setq delimit-columns-after ">")
;;
;; For the `delimit-columns-region' example above, the result is:
;;
;;	[ <a>   , <b>  , <c>      , <d>     ]
;;	[ <aaaa>, <bb> , <ccc>    , <ddddd> ]
;;	[ <aaa> , <bbb>, <cccc>   , <dddd>  ]
;;	[ <aa>  , <bb> , <ccccccc>, <ddd>   ]
;;
;; And for the `delimit-columns-rectangle' example above, the result is:
;;
;;	a	[ <b>  , <c>       ]	d
;;	aaaa	[ <bb> , <ccc>     ]	ddddd
;;	aaa	[ <bbb>, <cccc>    ]	dddd
;;	aa	[ <bb> , <ccccccc> ]	ddd
;;
Dave Love's avatar
Dave Love committed
94 95 96 97 98 99
;; 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'
;; operates over the text rectangle selected which rectangle diagonal is
;; given by the region start and end.
;;
100 101
;; See `delimit-columns-format' variable documentation for column formating.
;;
Dave Love's avatar
Dave Love committed
102 103 104 105 106 107 108 109 110 111 112 113 114
;; `delimit-columns-region' is useful when you have columns of text that
;; are not well aligned, like:
;;
;;	horse	apple	bus
;;	dog	pineapple	car
;;	porcupine	strawberry	airplane
;;
;; `delimit-columns-region' and `delimit-columns-rectangle' handle lines
;; with different number of columns, like:
;;
;;	horse	apple	bus
;;	dog	pineapple	car	EXTRA
;;	porcupine	strawberry	airplane
115 116
;;
;; Use `delimit-columns-customize' to customize delim-col package variables.
Dave Love's avatar
Dave Love committed
117 118 119 120 121 122 123

;;; Code:


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; User Options:

124
(defgroup columns nil
125
  "Prettify columns."
126 127
  :link '(emacs-library-link :tag "Source Lisp File" "delim-col.el")
  :prefix "delimit-columns-"
Chong Yidong's avatar
Chong Yidong committed
128
  :group 'wp)
129 130

(defcustom delimit-columns-str-before ""
Lute Kamstra's avatar
Lute Kamstra committed
131
  "Specify a string to be inserted before all columns."
132 133 134 135
  :type '(string :tag "Before All Columns")
  :group 'columns)

(defcustom delimit-columns-str-separator ", "
Lute Kamstra's avatar
Lute Kamstra committed
136
  "Specify a string to be inserted between each column."
137 138 139 140
  :type '(string :tag "Between Each Column")
  :group 'columns)

(defcustom delimit-columns-str-after ""
Lute Kamstra's avatar
Lute Kamstra committed
141
  "Specify a string to be inserted after all columns."
142 143 144 145
  :type '(string :tag "After All Columns")
  :group 'columns)

(defcustom delimit-columns-before ""
Lute Kamstra's avatar
Lute Kamstra committed
146
  "Specify a string to be inserted before each column."
147 148 149 150
  :type '(string :tag "Before Each Column")
  :group 'columns)

(defcustom delimit-columns-after ""
Lute Kamstra's avatar
Lute Kamstra committed
151
  "Specify a string to be inserted after each column."
152 153 154 155
  :type '(string :tag "After Each Column")
  :group 'columns)

(defcustom delimit-columns-separator "\t"
Lute Kamstra's avatar
Lute Kamstra committed
156
  "Specify a regexp which separates each column."
157 158 159 160
  :type '(regexp :tag "Column Separator")
  :group 'columns)

(defcustom delimit-columns-format t
Lute Kamstra's avatar
Lute Kamstra committed
161
  "Specify how to format columns.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

For examples below, consider:

   + columns `ccc' and `dddd',
   + the maximum column length for each column is 6,
   + and the following settings:
      (setq delimit-columns-before \"<\")
      (setq delimit-columns-after \">\")
      (setq delimit-columns-separator \":\")

Valid values are:

   nil		no formating.  That is, `delimit-columns-after' is followed by
		`delimit-columns-separator'.
		For example, the result is: \"<ccc>:<dddd>:\"

   t		align columns.  That is, `delimit-columns-after' is followed by
		`delimit-columns-separator' and then followed by spaces.
		For example, the result is: \"<ccc>:   <dddd>:  \"

   'separator	align separators.  That is, `delimit-columns-after' is followed
		by spaces and then followed by `delimit-columns-separator'.
		For example, the result is: \"<ccc>   :<dddd>  :\"

   'padding	format column by filling with spaces before
		`delimit-columns-after'.  That is, spaces are followed by
		`delimit-columns-after' and then followed by
		`delimit-columns-separator'.
		For example, the result is: \"<ccc   >:<dddd  >:\"

Any other value is treated as t."
  :type '(choice :menu-tag "Column Formating"
		 :tag "Column Formating"
		 (const :tag "No Formating" nil)
		 (const :tag "Column Alignment" t)
Paul Eggert's avatar
Paul Eggert committed
197
		 (const :tag "Separator Alignment" separator)
198 199 200 201
		 (const :tag "Column Padding" padding))
  :group 'columns)

(defcustom delimit-columns-extra t
Lute Kamstra's avatar
Lute Kamstra committed
202
  "Non-nil means that lines will have the same number of columns.
203 204 205 206 207 208

This has effect only when there are lines with different number of columns."
  :type '(boolean :tag "Lines With Same Number Of Column")
  :group 'columns)

(defcustom delimit-columns-start 0
Lute Kamstra's avatar
Lute Kamstra committed
209
  "Specify column number to start prettifing.
210 211 212 213 214 215 216 217 218 219 220 221 222 223

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."
  :type '(integer :tag "Column Start")
  :group 'columns)

(defcustom delimit-columns-end 1000000
Lute Kamstra's avatar
Lute Kamstra committed
224
  "Specify column number to end prettifing.
225 226 227 228 229 230 231 232 233 234 235 236

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."
  :type '(integer :tag "Column End")
  :group 'columns)
Dave Love's avatar
Dave Love committed
237 238 239 240 241 242


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; User Commands:


243 244 245 246 247
;; to avoid compilation gripes
(defvar delimit-columns-max nil)
(defvar delimit-columns-limit nil)


248 249 250 251 252 253 254
;;;###autoload
(defun delimit-columns-customize ()
  "Customization of `columns' group."
  (interactive)
  (customize-group 'columns))


255 256 257 258
(defmacro delimit-columns-str (str)
  `(if (stringp ,str) ,str ""))


Dave Love's avatar
Dave Love committed
259 260 261 262 263 264 265
;;;###autoload
(defun delimit-columns-region (start end)
  "Prettify all columns in a text region.

START and END delimits the text region."
  (interactive "*r")
  (let ((delimit-columns-str-before
266
	 (delimit-columns-str delimit-columns-str-before))
Dave Love's avatar
Dave Love committed
267
	(delimit-columns-str-separator
268
	 (delimit-columns-str delimit-columns-str-separator))
Dave Love's avatar
Dave Love committed
269
	(delimit-columns-str-after
270
	 (delimit-columns-str delimit-columns-str-after))
271
	(delimit-columns-before
272
	 (delimit-columns-str delimit-columns-before))
273
	(delimit-columns-after
274
	 (delimit-columns-str delimit-columns-after))
275 276 277 278 279 280 281 282 283
	(delimit-columns-start
	 (if (and (integerp delimit-columns-start)
		  (>= delimit-columns-start 0))
	     delimit-columns-start
	   0))
	(delimit-columns-end
	 (if (integerp delimit-columns-end)
	     delimit-columns-end
	   1000000))
Dave Love's avatar
Dave Love committed
284 285 286
	(delimit-columns-limit (make-marker))
	(the-end (copy-marker end))
	delimit-columns-max)
287
    (when (<= delimit-columns-start delimit-columns-end)
Dave Love's avatar
Dave Love committed
288
      (save-excursion
289 290 291
	(goto-char start)
	(beginning-of-line)
	;; get maximum length for each column
292
	(and delimit-columns-format
293 294 295 296 297 298 299 300
	     (save-excursion
	       (while (< (point) the-end)
		 (delimit-columns-rectangle-max
		  (prog1
		      (point)
		    (end-of-line)))
		 (forward-char 1))))
	;; prettify columns
Dave Love's avatar
Dave Love committed
301
	(while (< (point) the-end)
302
	  (delimit-columns-rectangle-line
Dave Love's avatar
Dave Love committed
303 304 305
	   (prog1
	       (point)
	     (end-of-line)))
306 307 308 309
	  (forward-char 1))
	;; nullify markers
	(set-marker delimit-columns-limit nil)
	(set-marker the-end nil)))))
Dave Love's avatar
Dave Love committed
310 311 312 313 314 315 316 317 318 319 320 321


(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."
  (interactive "*r")
  (let ((delimit-columns-str-before
322
	 (delimit-columns-str delimit-columns-str-before))
Dave Love's avatar
Dave Love committed
323
	(delimit-columns-str-separator
324
	 (delimit-columns-str delimit-columns-str-separator))
Dave Love's avatar
Dave Love committed
325
	(delimit-columns-str-after
326
	 (delimit-columns-str delimit-columns-str-after))
327
	(delimit-columns-before
328
	 (delimit-columns-str delimit-columns-before))
329
	(delimit-columns-after
330
	 (delimit-columns-str delimit-columns-after))
331 332 333 334 335 336 337 338 339
	(delimit-columns-start
	 (if (and (integerp delimit-columns-start)
		  (>= delimit-columns-start 0))
	     delimit-columns-start
	   0))
	(delimit-columns-end
	 (if (integerp delimit-columns-end)
	     delimit-columns-end
	   1000000))
Dave Love's avatar
Dave Love committed
340 341 342
	(delimit-columns-limit (make-marker))
	(the-end (copy-marker end))
	delimit-columns-max)
343 344
    (when (<= delimit-columns-start delimit-columns-end)
      ;; get maximum length for each column
345
      (and delimit-columns-format
346 347 348 349 350 351 352 353 354 355
	   (save-excursion
	     (operate-on-rectangle 'delimit-columns-rectangle-max
				   start the-end nil)))
      ;; prettify columns
      (save-excursion
	(operate-on-rectangle 'delimit-columns-rectangle-line
			      start the-end nil))
      ;; nullify markers
      (set-marker delimit-columns-limit nil)
      (set-marker the-end nil))))
Dave Love's avatar
Dave Love committed
356 357 358 359 360 361


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Internal Variables and Functions:


362
(defun delimit-columns-rectangle-max (startpos &optional _ignore1 _ignore2)
Dave Love's avatar
Dave Love committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
  (set-marker delimit-columns-limit (point))
  (goto-char startpos)
  (let ((ncol 1)
	origin values)
    ;; get current column length
    (while (progn
	     (setq origin (current-column))
	     (re-search-forward delimit-columns-separator
				delimit-columns-limit 'move))
      (save-excursion
	(goto-char (match-beginning 0))
	(setq values (cons (- (current-column) origin)
			   values)))
      (setq ncol (1+ ncol)))
    (setq values (cons (- (current-column) origin)
		       values))
    ;; extend delimit-columns-max, if needed
    (let ((index (length delimit-columns-max)))
      (and (> ncol index)
	   (let ((extend (make-vector ncol 0)))
	     (while (> index 0)
	       (setq index (1- index))
	       (aset extend index (aref delimit-columns-max index)))
	     (setq delimit-columns-max extend))))
    ;; get maximum column length
    (while values
      (setq ncol (1- ncol))
      (aset delimit-columns-max ncol (max (aref delimit-columns-max ncol)
					  (car values)))
      (setq values (cdr values)))))


395
(defun delimit-columns-rectangle-line (startpos &optional _ignore1 _ignore2)
396 397
  (let ((len  (length delimit-columns-max))
	(ncol 0)
Dave Love's avatar
Dave Love committed
398 399 400
	origin)
    (set-marker delimit-columns-limit (point))
    (goto-char startpos)
401 402 403 404 405 406 407 408
    ;; skip initial columns
    (while (and (< ncol delimit-columns-start)
		(< (point) delimit-columns-limit)
		(re-search-forward delimit-columns-separator
				   delimit-columns-limit 'move))
      (setq ncol (1+ ncol)))
    ;; insert first formating
    (insert delimit-columns-str-before delimit-columns-before)
Dave Love's avatar
Dave Love committed
409 410 411 412 413
    ;; Adjust all columns but last one
    (while (progn
	     (setq origin (current-column))
	     (and (< (point) delimit-columns-limit)
		  (re-search-forward delimit-columns-separator
414 415 416 417 418
				     delimit-columns-limit 'move)
		  (or (< ncol delimit-columns-end)
		      (progn
			(goto-char (match-beginning 0))
			nil))))
Dave Love's avatar
Dave Love committed
419
      (delete-region (match-beginning 0) (point))
420 421 422
      (delimit-columns-format
       (and delimit-columns-format
	    (make-string (- (aref delimit-columns-max ncol)
Dave Love's avatar
Dave Love committed
423
			    (- (current-column) origin))
424
			 ?\s)))
425 426 427 428 429
      (setq ncol (1+ ncol)))
    ;; Prepare last column spaces
    (let ((spaces (and delimit-columns-format
		       (make-string (- (aref delimit-columns-max ncol)
				       (- (current-column) origin))
430
				    ?\s))))
431 432 433 434 435 436 437
      ;; Adjust extra columns, if needed
      (and delimit-columns-extra
	   (while (and (< (setq ncol (1+ ncol)) len)
		       (<= ncol delimit-columns-end))
	     (delimit-columns-format spaces)
	     (setq spaces (and delimit-columns-format
			       (make-string (aref delimit-columns-max ncol)
438
					    ?\s)))))
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
      ;; insert last formating
      (cond ((null delimit-columns-format)
	     (insert delimit-columns-after delimit-columns-str-after))
	    ((eq delimit-columns-format 'padding)
	     (insert spaces delimit-columns-after delimit-columns-str-after))
	    (t
	     (insert delimit-columns-after spaces delimit-columns-str-after))
	    ))
    (goto-char (max (point) delimit-columns-limit))))


(defun delimit-columns-format (spaces)
  (cond ((null delimit-columns-format)
	 (insert delimit-columns-after
		 delimit-columns-str-separator
		 delimit-columns-before))
	((eq delimit-columns-format 'separator)
	 (insert delimit-columns-after
		 spaces
		 delimit-columns-str-separator
		 delimit-columns-before))
	((eq delimit-columns-format 'padding)
	 (insert spaces
		 delimit-columns-after
		 delimit-columns-str-separator
		 delimit-columns-before))
	(t
	 (insert delimit-columns-after
		 delimit-columns-str-separator
		 spaces
		 delimit-columns-before))
	))
Dave Love's avatar
Dave Love committed
471 472 473 474 475 476 477 478 479


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(provide 'delim-col)


;;; delim-col.el ends here