(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)
(defun delimit-columns-customize ()
"Customization of `columns' group."
(interactive)
(customize-group 'columns))
(defmacro delimit-columns-str (str)
`(if (stringp ,str) ,str ""))
(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)
(and delimit-columns-format
(save-excursion
(while (< (point) the-end)
(delimit-columns-rectangle-max
(prog1
(point)
(end-of-line)))
(forward-char 1))))
(while (< (point) the-end)
(delimit-columns-rectangle-line
(prog1
(point)
(end-of-line)))
(forward-char 1))
(set-marker delimit-columns-limit nil)
(set-marker the-end nil)))))
(require 'rect)
(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)
(and delimit-columns-format
(save-excursion
(operate-on-rectangle 'delimit-columns-rectangle-max
start the-end nil)))
(save-excursion
(operate-on-rectangle 'delimit-columns-rectangle-line
start the-end nil))
(set-marker delimit-columns-limit nil)
(set-marker the-end nil))))
(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)
(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))
(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))))
(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)
(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 delimit-columns-str-before delimit-columns-before)
(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)))
(let ((spaces (and delimit-columns-format
(make-string (- (aref delimit-columns-max ncol)
(- (current-column) origin))
?\s))))
(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)))))
(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))
))
(provide 'delim-col)