[bpt/emacs.git] / lisp / delim-col.el

;;; delim-col.el --- prettify all columns in a region or rectangle

;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.

;; Author: Vinicius Jose Latorre <viniciusjl@ig.com.br>
;; Maintainer: Vinicius Jose Latorre <viniciusjl@ig.com.br>
;; Time-stamp: <2004/03/09 21:32:06 vinicius>
;; Version: 2.1
;; Keywords: internal
;; X-URL: http://www.cpqd.com.br/~vinicius/emacs/

;; 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 2, 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; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; 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
;;	aaa	bbb	cccc	dddd
;;	aa	bb	ccccccc	ddd
;;
;; And the following settings:
;;
;;    (setq delimit-columns-str-before "[ ")
;;    (setq delimit-columns-str-after " ]")
;;    (setq delimit-columns-str-separator ", ")
;;    (setq delimit-columns-before "")
;;    (setq delimit-columns-after "")
;;    (setq delimit-columns-separator "\t")
;;    (setq delimit-columns-format 'separator)
;;    (setq delimit-columns-extra t)
;;
;; 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   ]
;;
;; But if you select start from the very first b to the very last c and type:
;;
;;    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
;;
;; 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
;;
;; 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.
;;
;; See `delimit-columns-format' variable documentation for column formating.
;;
;; `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
;;
;; Use `delimit-columns-customize' to customize delim-col package variables.

;;; Code:


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

(defgroup columns nil
  "Prettify columns."
  :link '(emacs-library-link :tag "Source Lisp File" "delim-col.el")
  :prefix "delimit-columns-"
  :group 'internal)

(defcustom delimit-columns-str-before ""
  "*Specify a string to be inserted before all columns."
  :type '(string :tag "Before All Columns")
  :group 'columns)

(defcustom delimit-columns-str-separator ", "
  "*Specify a string to be inserted between each column."
  :type '(string :tag "Between Each Column")
  :group 'columns)

(defcustom delimit-columns-str-after ""
  "*Specify a string to be inserted after all columns."
  :type '(string :tag "After All Columns")
  :group 'columns)

(defcustom delimit-columns-before ""
  "*Specify a string to be inserted before each column."
  :type '(string :tag "Before Each Column")
  :group 'columns)

(defcustom delimit-columns-after ""
  "*Specify a string to be inserted after each column."
  :type '(string :tag "After Each Column")
  :group 'columns)

(defcustom delimit-columns-separator "\t"
  "*Specify a regexp which separates each column."
  :type '(regexp :tag "Column Separator")
  :group 'columns)

(defcustom delimit-columns-format t
  "*Specify how to format columns.

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)
		 (const :tag "Separator Aligment" separator)
		 (const :tag "Column Padding" padding))
  :group 'columns)

(defcustom delimit-columns-extra t
  "*Non-nil means that lines will have the same number of columns.

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
  "*Specify column number to start prettifing.

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
  "*Specify column number to end prettifing.

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)

\f
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; User Commands:


;;;###autoload
(defun delimit-columns-customize ()
  "Customization of `columns' group."
  (interactive)
  (customize-group 'columns))


(defmacro 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."
  (interactive "*r")
  (let ((delimit-columns-str-before
	 (delimit-columns-str delimit-columns-str-before))
	(delimit-columns-str-separator
	 (delimit-columns-str delimit-columns-str-separator))
	(delimit-columns-str-after
	 (delimit-columns-str delimit-columns-str-after))
	(delimit-columns-before
	 (delimit-columns-str delimit-columns-before))
	(delimit-columns-after
	 (delimit-columns-str delimit-columns-after))
	(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))
	(delimit-columns-limit (make-marker))
	(the-end (copy-marker end))
	delimit-columns-max)
    (when (<= delimit-columns-start delimit-columns-end)
      (save-excursion
	(goto-char start)
	(beginning-of-line)
	;; get maximum length for each column
	(and delimit-columns-format
	     (save-excursion
	       (while (< (point) the-end)
		 (delimit-columns-rectangle-max
		  (prog1
		      (point)
		    (end-of-line)))
		 (forward-char 1))))
	;; prettify columns
	(while (< (point) the-end)
	  (delimit-columns-rectangle-line
	   (prog1
	       (point)
	     (end-of-line)))
	  (forward-char 1))
	;; nullify markers
	(set-marker delimit-columns-limit nil)
	(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."
  (interactive "*r")
  (let ((delimit-columns-str-before
	 (delimit-columns-str delimit-columns-str-before))
	(delimit-columns-str-separator
	 (delimit-columns-str delimit-columns-str-separator))
	(delimit-columns-str-after
	 (delimit-columns-str delimit-columns-str-after))
	(delimit-columns-before
	 (delimit-columns-str delimit-columns-before))
	(delimit-columns-after
	 (delimit-columns-str delimit-columns-after))
	(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))
	(delimit-columns-limit (make-marker))
	(the-end (copy-marker end))
	delimit-columns-max)
    (when (<= delimit-columns-start delimit-columns-end)
      ;; get maximum length for each column
      (and delimit-columns-format
	   (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))))

\f
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Internal Variables and Functions:


;; to avoid compilation gripes
(defvar delimit-columns-max nil)
(defvar delimit-columns-limit nil)


(defun delimit-columns-rectangle-max (startpos &optional ignore1 ignore2)
  (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)))))


(defun delimit-columns-rectangle-line (startpos &optional ignore1 ignore2)
  (let ((len  (length delimit-columns-max))
	(ncol 0)
	origin)
    (set-marker delimit-columns-limit (point))
    (goto-char startpos)
    ;; 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)
    ;; Adjust all columns but last one
    (while (progn
	     (setq origin (current-column))
	     (and (< (point) delimit-columns-limit)
		  (re-search-forward delimit-columns-separator
				     delimit-columns-limit 'move)
		  (or (< ncol delimit-columns-end)
		      (progn
			(goto-char (match-beginning 0))
			nil))))
      (delete-region (match-beginning 0) (point))
      (delimit-columns-format
       (and delimit-columns-format
	    (make-string (- (aref delimit-columns-max ncol)
			    (- (current-column) origin))
			 ?\s)))
      (setq ncol (1+ ncol)))
    ;; Prepare last column spaces
    (let ((spaces (and delimit-columns-format
		       (make-string (- (aref delimit-columns-max ncol)
				       (- (current-column) origin))
				    ?\s))))
      ;; 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)
					    ?\s)))))
      ;; 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))
	))

\f
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


(provide 'delim-col)


;;; arch-tag: 1cc0c5c5-1b2a-43e4-9ba5-bf9441cfd1a9
;;; delim-col.el ends here
Commit	Line	Data
e8af40ee	1	;;; delim-col.el --- prettify all columns in a region or rectangle
854f487a	2
0d30b337 TTN	3	;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
0d30b337 TTN	4	;; 2005 Free Software Foundation, Inc.
854f487a	5
739ce395 VJL	6	;; Author: Vinicius Jose Latorre <viniciusjl@ig.com.br>
	7	;; Maintainer: Vinicius Jose Latorre <viniciusjl@ig.com.br>
	8	;; Time-stamp: <2004/03/09 21:32:06 vinicius>
e8af40ee PJ	9	;; Version: 2.1
	10	;; Keywords: internal
	11	;; X-URL: http://www.cpqd.com.br/~vinicius/emacs/
854f487a DL	12
	13	;; This file is part of GNU Emacs.
	14
1416c7ff DL	15	;; GNU Emacs is free software; you can redistribute it and/or modify
	16	;; it under the terms of the GNU General Public License as published by
	17	;; the Free Software Foundation; either version 2, or (at your option)
	18	;; any later version.
854f487a	19
1416c7ff DL	20	;; GNU Emacs is distributed in the hope that it will be useful,
	21	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	22	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	23	;; GNU General Public License for more details.
854f487a	24
1416c7ff DL	25	;; You should have received a copy of the GNU General Public License
1416c7ff DL	26	;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15 LK	27	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
086add15 LK	28	;; Boston, MA 02110-1301, USA.
854f487a DL	29
	30	;;; Commentary:
	31
	32	;; delim-col helps to prettify columns in a text region or rectangle.
	33	;;
	34	;; To use it, make sure that this file is in load-path and insert in your
	35	;; .emacs:
	36	;;
	37	;; (require 'delim-col)
	38	;;
	39	;; If you have, for example, the following columns:
	40	;;
	41	;; a b c d
	42	;; aaaa bb ccc ddddd
395be66e	43	;; aaa bbb cccc dddd
854f487a DL	44	;; aa bb ccccccc ddd
	45	;;
	46	;; And the following settings:
	47	;;
	48	;; (setq delimit-columns-str-before "[ ")
	49	;; (setq delimit-columns-str-after " ]")
	50	;; (setq delimit-columns-str-separator ", ")
395be66e GM	51	;; (setq delimit-columns-before "")
395be66e GM	52	;; (setq delimit-columns-after "")
854f487a	53	;; (setq delimit-columns-separator "\t")
395be66e GM	54	;; (setq delimit-columns-format 'separator)
395be66e GM	55	;; (setq delimit-columns-extra t)
854f487a DL	56	;;
	57	;; If you select the lines above and type:
	58	;;
	59	;; M-x delimit-columns-region RET
	60	;;
	61	;; You obtain the following result:
	62	;;
	63	;; [ a , b , c , d ]
	64	;; [ aaaa, bb , ccc , ddddd ]
	65	;; [ aaa , bbb, cccc , dddd ]
	66	;; [ aa , bb , ccccccc, ddd ]
	67	;;
395be66e	68	;; But if you select start from the very first b to the very last c and type:
854f487a DL	69	;;
	70	;; M-x delimit-columns-rectangle RET
	71	;;
	72	;; You obtain the following result:
	73	;;
	74	;; a [ b , c ] d
	75	;; aaaa [ bb , ccc ] ddddd
	76	;; aaa [ bbb, cccc ] dddd
	77	;; aa [ bb , ccccccc ] ddd
	78	;;
395be66e GM	79	;; Now, if we change settings to:
	80	;;
	81	;; (setq delimit-columns-before "<")
	82	;; (setq delimit-columns-after ">")
	83	;;
	84	;; For the `delimit-columns-region' example above, the result is:
	85	;;
	86	;; [ <a> , <b> , <c> , <d> ]
	87	;; [ <aaaa>, <bb> , <ccc> , <ddddd> ]
	88	;; [ <aaa> , <bbb>, <cccc> , <dddd> ]
	89	;; [ <aa> , <bb> , <ccccccc>, <ddd> ]
	90	;;
	91	;; And for the `delimit-columns-rectangle' example above, the result is:
	92	;;
	93	;; a [ <b> , <c> ] d
	94	;; aaaa [ <bb> , <ccc> ] ddddd
	95	;; aaa [ <bbb>, <cccc> ] dddd
	96	;; aa [ <bb> , <ccccccc> ] ddd
	97	;;
854f487a DL	98	;; Note that `delimit-columns-region' operates over all text region
	99	;; selected, extending the region start to the beginning of line and the
	100	;; region end to the end of line. While `delimit-columns-rectangle'
	101	;; operates over the text rectangle selected which rectangle diagonal is
	102	;; given by the region start and end.
	103	;;
395be66e GM	104	;; See `delimit-columns-format' variable documentation for column formating.
395be66e GM	105	;;
854f487a DL	106	;; `delimit-columns-region' is useful when you have columns of text that
	107	;; are not well aligned, like:
	108	;;
	109	;; horse apple bus
	110	;; dog pineapple car
	111	;; porcupine strawberry airplane
	112	;;
	113	;; `delimit-columns-region' and `delimit-columns-rectangle' handle lines
	114	;; with different number of columns, like:
	115	;;
	116	;; horse apple bus
	117	;; dog pineapple car EXTRA
	118	;; porcupine strawberry airplane
395be66e GM	119	;;
395be66e GM	120	;; Use `delimit-columns-customize' to customize delim-col package variables.
854f487a DL	121
	122	;;; Code:
	123
	124
	125	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
	126	;; User Options:
	127
395be66e	128	(defgroup columns nil
0c5a1b51	129	"Prettify columns."
395be66e GM	130	:link '(emacs-library-link :tag "Source Lisp File" "delim-col.el")
	131	:prefix "delimit-columns-"
	132	:group 'internal)
	133
	134	(defcustom delimit-columns-str-before ""
	135	"*Specify a string to be inserted before all columns."
	136	:type '(string :tag "Before All Columns")
	137	:group 'columns)
	138
	139	(defcustom delimit-columns-str-separator ", "
	140	"*Specify a string to be inserted between each column."
	141	:type '(string :tag "Between Each Column")
	142	:group 'columns)
	143
	144	(defcustom delimit-columns-str-after ""
	145	"*Specify a string to be inserted after all columns."
	146	:type '(string :tag "After All Columns")
	147	:group 'columns)
	148
	149	(defcustom delimit-columns-before ""
	150	"*Specify a string to be inserted before each column."
	151	:type '(string :tag "Before Each Column")
	152	:group 'columns)
	153
	154	(defcustom delimit-columns-after ""
	155	"*Specify a string to be inserted after each column."
	156	:type '(string :tag "After Each Column")
	157	:group 'columns)
	158
	159	(defcustom delimit-columns-separator "\t"
	160	"*Specify a regexp which separates each column."
	161	:type '(regexp :tag "Column Separator")
	162	:group 'columns)
	163
	164	(defcustom delimit-columns-format t
	165	"*Specify how to format columns.
	166
	167	For examples below, consider:
	168
	169	+ columns `ccc' and `dddd',
	170	+ the maximum column length for each column is 6,
	171	+ and the following settings:
	172	(setq delimit-columns-before \"<\")
	173	(setq delimit-columns-after \">\")
	174	(setq delimit-columns-separator \":\")
	175
	176	Valid values are:
	177
	178	nil no formating. That is, `delimit-columns-after' is followed by
	179	`delimit-columns-separator'.
	180	For example, the result is: \"<ccc>:<dddd>:\"
	181
	182	t align columns. That is, `delimit-columns-after' is followed by
	183	`delimit-columns-separator' and then followed by spaces.
	184	For example, the result is: \"<ccc>: <dddd>: \"
	185
	186	'separator align separators. That is, `delimit-columns-after' is followed
	187	by spaces and then followed by `delimit-columns-separator'.
	188	For example, the result is: \"<ccc> :<dddd> :\"
	189
	190	'padding format column by filling with spaces before
	191	`delimit-columns-after'. That is, spaces are followed by
	192	`delimit-columns-after' and then followed by
	193	`delimit-columns-separator'.
194	For example, the result is: \"<ccc >:<dddd >:\"
195
196	Any other value is treated as t."
197	:type '(choice :menu-tag "Column Formating"
198	:tag "Column Formating"
199	(const :tag "No Formating" nil)
200	(const :tag "Column Alignment" t)
201	(const :tag "Separator Aligment" separator)
202	(const :tag "Column Padding" padding))
203	:group 'columns)
204
205	(defcustom delimit-columns-extra t
206	"*Non-nil means that lines will have the same number of columns.
207
208	This has effect only when there are lines with different number of columns."
209	:type '(boolean :tag "Lines With Same Number Of Column")
210	:group 'columns)
211
212	(defcustom delimit-columns-start 0
213	"*Specify column number to start prettifing.
214
215	See also `delimit-columns-end' for documentation.
216
217	The following relation must hold:
218	0 <= delimit-columns-start <= delimit-columns-end
219
220	The column number start from 0 and it's relative to the beginning of selected
221	region. So if you selected a text region, the first column (column 0) is
222	located at beginning of line. If you selected a text rectangle, the first
223	column (column 0) is located at left corner."
224	:type '(integer :tag "Column Start")
225	:group 'columns)
226
227	(defcustom delimit-columns-end 1000000
228	"*Specify column number to end prettifing.
229
230	See also `delimit-columns-start' for documentation.
231
232	The following relation must hold:
233	0 <= delimit-columns-start <= delimit-columns-end
234
235	The column number start from 0 and it's relative to the beginning of selected
236	region. So if you selected a text region, the first column (column 0) is
237	located at beginning of line. If you selected a text rectangle, the first
238	column (column 0) is located at left corner."
239	:type '(integer :tag "Column End")
240	:group 'columns)
854f487a DL	241
	242	\f
	243	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
	244	;; User Commands:
	245
	246
395be66e GM	247	;;;###autoload
	248	(defun delimit-columns-customize ()
	249	"Customization of `columns' group."
	250	(interactive)
	251	(customize-group 'columns))
	252
	253
9e20722f GM	254	(defmacro delimit-columns-str (str)
	255	`(if (stringp ,str) ,str ""))
	256
	257
854f487a DL	258	;;;###autoload
	259	(defun delimit-columns-region (start end)
	260	"Prettify all columns in a text region.
	261
	262	START and END delimits the text region."
	263	(interactive "*r")
	264	(let ((delimit-columns-str-before
9e20722f	265	(delimit-columns-str delimit-columns-str-before))
854f487a	266	(delimit-columns-str-separator
9e20722f	267	(delimit-columns-str delimit-columns-str-separator))
854f487a	268	(delimit-columns-str-after
9e20722f	269	(delimit-columns-str delimit-columns-str-after))
395be66e	270	(delimit-columns-before
9e20722f	271	(delimit-columns-str delimit-columns-before))
395be66e	272	(delimit-columns-after
9e20722f	273	(delimit-columns-str delimit-columns-after))
395be66e GM	274	(delimit-columns-start
	275	(if (and (integerp delimit-columns-start)
	276	(>= delimit-columns-start 0))
	277	delimit-columns-start
	278	0))
	279	(delimit-columns-end
	280	(if (integerp delimit-columns-end)
	281	delimit-columns-end
	282	1000000))
854f487a DL	283	(delimit-columns-limit (make-marker))
	284	(the-end (copy-marker end))
	285	delimit-columns-max)
395be66e	286	(when (<= delimit-columns-start delimit-columns-end)
854f487a	287	(save-excursion
395be66e GM	288	(goto-char start)
	289	(beginning-of-line)
	290	;; get maximum length for each column
35923e46	291	(and delimit-columns-format
395be66e GM	292	(save-excursion
	293	(while (< (point) the-end)
	294	(delimit-columns-rectangle-max
	295	(prog1
	296	(point)
	297	(end-of-line)))
	298	(forward-char 1))))
	299	;; prettify columns
854f487a	300	(while (< (point) the-end)
395be66e	301	(delimit-columns-rectangle-line
854f487a DL	302	(prog1
	303	(point)
	304	(end-of-line)))
395be66e GM	305	(forward-char 1))
	306	;; nullify markers
	307	(set-marker delimit-columns-limit nil)
	308	(set-marker the-end nil)))))
854f487a DL	309
	310
	311	(require 'rect)
	312
	313
	314	;;;###autoload
	315	(defun delimit-columns-rectangle (start end)
	316	"Prettify all columns in a text rectangle.
	317
	318	START and END delimits the corners of text rectangle."
	319	(interactive "*r")
	320	(let ((delimit-columns-str-before
9e20722f	321	(delimit-columns-str delimit-columns-str-before))
854f487a	322	(delimit-columns-str-separator
9e20722f	323	(delimit-columns-str delimit-columns-str-separator))
854f487a	324	(delimit-columns-str-after
9e20722f	325	(delimit-columns-str delimit-columns-str-after))
395be66e	326	(delimit-columns-before
9e20722f	327	(delimit-columns-str delimit-columns-before))
395be66e	328	(delimit-columns-after
9e20722f	329	(delimit-columns-str delimit-columns-after))
395be66e GM	330	(delimit-columns-start
	331	(if (and (integerp delimit-columns-start)
	332	(>= delimit-columns-start 0))
	333	delimit-columns-start
	334	0))
	335	(delimit-columns-end
	336	(if (integerp delimit-columns-end)
	337	delimit-columns-end
	338	1000000))
854f487a DL	339	(delimit-columns-limit (make-marker))
	340	(the-end (copy-marker end))
	341	delimit-columns-max)
395be66e GM	342	(when (<= delimit-columns-start delimit-columns-end)
395be66e GM	343	;; get maximum length for each column
35923e46	344	(and delimit-columns-format
395be66e GM	345	(save-excursion
	346	(operate-on-rectangle 'delimit-columns-rectangle-max
	347	start the-end nil)))
	348	;; prettify columns
	349	(save-excursion
	350	(operate-on-rectangle 'delimit-columns-rectangle-line
	351	start the-end nil))
	352	;; nullify markers
	353	(set-marker delimit-columns-limit nil)
	354	(set-marker the-end nil))))
854f487a DL	355
	356	\f
	357	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
	358	;; Internal Variables and Functions:
	359
	360
	361	;; to avoid compilation gripes
	362	(defvar delimit-columns-max nil)
	363	(defvar delimit-columns-limit nil)
	364
	365
a2bdcec4	366	(defun delimit-columns-rectangle-max (startpos &optional ignore1 ignore2)
854f487a DL	367	(set-marker delimit-columns-limit (point))
	368	(goto-char startpos)
	369	(let ((ncol 1)
	370	origin values)
	371	;; get current column length
	372	(while (progn
	373	(setq origin (current-column))
	374	(re-search-forward delimit-columns-separator
	375	delimit-columns-limit 'move))
	376	(save-excursion
	377	(goto-char (match-beginning 0))
	378	(setq values (cons (- (current-column) origin)
	379	values)))
	380	(setq ncol (1+ ncol)))
	381	(setq values (cons (- (current-column) origin)
	382	values))
	383	;; extend delimit-columns-max, if needed
	384	(let ((index (length delimit-columns-max)))
	385	(and (> ncol index)
	386	(let ((extend (make-vector ncol 0)))
	387	(while (> index 0)
	388	(setq index (1- index))
	389	(aset extend index (aref delimit-columns-max index)))
	390	(setq delimit-columns-max extend))))
	391	;; get maximum column length
	392	(while values
	393	(setq ncol (1- ncol))
	394	(aset delimit-columns-max ncol (max (aref delimit-columns-max ncol)
	395	(car values)))
	396	(setq values (cdr values)))))
	397
	398
a2bdcec4	399	(defun delimit-columns-rectangle-line (startpos &optional ignore1 ignore2)
395be66e GM	400	(let ((len (length delimit-columns-max))
395be66e GM	401	(ncol 0)
854f487a DL	402	origin)
	403	(set-marker delimit-columns-limit (point))
	404	(goto-char startpos)
395be66e GM	405	;; skip initial columns
	406	(while (and (< ncol delimit-columns-start)
	407	(< (point) delimit-columns-limit)
	408	(re-search-forward delimit-columns-separator
	409	delimit-columns-limit 'move))
	410	(setq ncol (1+ ncol)))
	411	;; insert first formating
	412	(insert delimit-columns-str-before delimit-columns-before)
854f487a DL	413	;; Adjust all columns but last one
	414	(while (progn
	415	(setq origin (current-column))
	416	(and (< (point) delimit-columns-limit)
	417	(re-search-forward delimit-columns-separator
395be66e GM	418	delimit-columns-limit 'move)
	419	(or (< ncol delimit-columns-end)
	420	(progn
	421	(goto-char (match-beginning 0))
	422	nil))))
854f487a	423	(delete-region (match-beginning 0) (point))
395be66e GM	424	(delimit-columns-format
	425	(and delimit-columns-format
	426	(make-string (- (aref delimit-columns-max ncol)
854f487a	427	(- (current-column) origin))
0c5a1b51	428	?\s)))
395be66e GM	429	(setq ncol (1+ ncol)))
	430	;; Prepare last column spaces
	431	(let ((spaces (and delimit-columns-format
	432	(make-string (- (aref delimit-columns-max ncol)
	433	(- (current-column) origin))
0c5a1b51	434	?\s))))
395be66e GM	435	;; Adjust extra columns, if needed
	436	(and delimit-columns-extra
	437	(while (and (< (setq ncol (1+ ncol)) len)
	438	(<= ncol delimit-columns-end))
	439	(delimit-columns-format spaces)
	440	(setq spaces (and delimit-columns-format
	441	(make-string (aref delimit-columns-max ncol)
0c5a1b51	442	?\s)))))
395be66e GM	443	;; insert last formating
	444	(cond ((null delimit-columns-format)
	445	(insert delimit-columns-after delimit-columns-str-after))
	446	((eq delimit-columns-format 'padding)
	447	(insert spaces delimit-columns-after delimit-columns-str-after))
	448	(t
	449	(insert delimit-columns-after spaces delimit-columns-str-after))
	450	))
	451	(goto-char (max (point) delimit-columns-limit))))
	452
	453
	454	(defun delimit-columns-format (spaces)
	455	(cond ((null delimit-columns-format)
	456	(insert delimit-columns-after
	457	delimit-columns-str-separator
	458	delimit-columns-before))
	459	((eq delimit-columns-format 'separator)
	460	(insert delimit-columns-after
	461	spaces
	462	delimit-columns-str-separator
	463	delimit-columns-before))
	464	((eq delimit-columns-format 'padding)
	465	(insert spaces
	466	delimit-columns-after
	467	delimit-columns-str-separator
	468	delimit-columns-before))
	469	(t
	470	(insert delimit-columns-after
	471	delimit-columns-str-separator
	472	spaces
	473	delimit-columns-before))
	474	))
854f487a DL	475
	476	\f
	477	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
	478
	479
	480	(provide 'delim-col)
	481
	482
ab5796a9	483	;;; arch-tag: 1cc0c5c5-1b2a-43e4-9ba5-bf9441cfd1a9
854f487a	484	;;; delim-col.el ends here