mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-25 07:28:20 +00:00
f744797af1
Restore lines saying "Maintainer: emacs-devel@gnu.org" when there is no special maintainer for a file. Although this wasn't documented it was common practice and removing the lines didn't have consensus.
897 lines
34 KiB
EmacsLisp
897 lines
34 KiB
EmacsLisp
;;; array.el --- array editing commands for GNU Emacs
|
||
|
||
;; Copyright (C) 1987, 2000-2019 Free Software Foundation, Inc.
|
||
|
||
;; Author: David M. Brown
|
||
;; Maintainer: emacs-devel@gnu.org
|
||
;; Keywords: extensions
|
||
|
||
;; 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:
|
||
|
||
;; Commands for editing a buffer interpreted as a rectangular array
|
||
;; or matrix of whitespace-separated strings. You specify the array
|
||
;; dimensions and some other parameters at startup time.
|
||
|
||
;; Written by dmb%morgoth@harvard.harvard.edu (address is old)
|
||
;; (David M. Brown at Goldberg-Zoino & Associates, Inc.)
|
||
;; Thanks to cph@kleph.ai.mit.edu for assistance
|
||
|
||
;; To do:
|
||
;; Smooth initialization process by grokking local variables list
|
||
;; at end of buffer or parsing buffer using whitespace as delimiters.
|
||
;; Make 'array-copy-column-right faster.
|
||
|
||
|
||
;;; Code:
|
||
|
||
(defvar array-max-column nil "Number of columns in the array.")
|
||
(defvar array-columns-per-line nil "Number of array columns per line.")
|
||
(defvar array-buffer-column nil "Current column number of point in the buffer.")
|
||
(defvar array-line-length nil "Length of a line in the array.")
|
||
(defvar array-buffer-line nil "Current line number of point in the buffer.")
|
||
(defvar array-lines-per-row nil "Number of lines per array row.")
|
||
(defvar array-max-row nil "Number of rows in the array.")
|
||
(defvar array-field-width nil "Width of a field in the array.")
|
||
(defvar array-row nil "Current array row location of point.")
|
||
(defvar array-column nil "Current array column location of point.")
|
||
(defvar array-rows-numbered nil "Are rows numbered in the buffer?")
|
||
(defvar array-copy-string nil "Current field string being copied.")
|
||
(defvar array-respect-tabs nil "Should TAB conversion be prevented?")
|
||
|
||
;;; Internal information functions.
|
||
|
||
(defun array-cursor-in-array-range ()
|
||
"Return t if the cursor is in a valid array cell.
|
||
Its ok to be on a row number line."
|
||
(let ((columns-last-line (% array-max-column array-columns-per-line)))
|
||
;; Requires array-buffer-line and array-buffer-column to be current.
|
||
(not (or
|
||
;; The cursor is too far to the right.
|
||
(>= array-buffer-column array-line-length)
|
||
;; The cursor is below the last row.
|
||
(>= array-buffer-line (* array-lines-per-row array-max-row))
|
||
;; The cursor is on the last line of the row, the line is smaller
|
||
;; than the others, and the cursor is after the last array column
|
||
;; on the line.
|
||
(and (zerop (% (1+ array-buffer-line) array-lines-per-row))
|
||
(not (zerop columns-last-line))
|
||
(>= array-buffer-column (* columns-last-line array-field-width)))))))
|
||
|
||
(defun array-current-row ()
|
||
"Return the array row of the field in which the cursor is located."
|
||
;; Requires array-buffer-line and array-buffer-column to be current.
|
||
(and (array-cursor-in-array-range)
|
||
(1+ (floor array-buffer-line array-lines-per-row))))
|
||
|
||
(defun array-current-column ()
|
||
"Return the array column of the field in which the cursor is located."
|
||
;; Requires array-buffer-line and array-buffer-column to be current.
|
||
(and (array-cursor-in-array-range)
|
||
;; It's not okay to be on a row number line.
|
||
(not (and array-rows-numbered
|
||
(zerop (% array-buffer-line array-lines-per-row))))
|
||
(+
|
||
;; Array columns due to line differences.
|
||
(* array-columns-per-line
|
||
(if array-rows-numbered
|
||
(1- (% array-buffer-line array-lines-per-row))
|
||
(% array-buffer-line array-lines-per-row)))
|
||
;; Array columns on the current line.
|
||
(1+ (floor array-buffer-column array-field-width)))))
|
||
|
||
(defun array-update-array-position (&optional a-row a-column)
|
||
"Set `array-row' and `array-column' to their current values.
|
||
Set them to the optional arguments A-ROW and A-COLUMN if those are supplied."
|
||
;; Requires that array-buffer-line and array-buffer-column be current.
|
||
(setq array-row (or a-row (array-current-row))
|
||
array-column (or a-column (array-current-column))))
|
||
|
||
(defun array-update-buffer-position ()
|
||
"Set `array-buffer-line' and `array-buffer-column' to their current values."
|
||
(setq array-buffer-line (current-line)
|
||
array-buffer-column (current-column)))
|
||
|
||
|
||
|
||
;;; Information commands.
|
||
|
||
(defun array-what-position ()
|
||
"Display the row and column in which the cursor is positioned."
|
||
(interactive)
|
||
(let ((array-buffer-line (current-line))
|
||
(array-buffer-column (current-column)))
|
||
(message "Array row: %s Array column: %s"
|
||
(prin1-to-string (array-current-row))
|
||
(prin1-to-string (array-current-column)))))
|
||
|
||
(defun array-display-local-variables ()
|
||
"Display the current state of the local variables in the minibuffer."
|
||
(interactive)
|
||
(let ((buf (buffer-name (current-buffer))))
|
||
(with-output-to-temp-buffer "*Local Variables*"
|
||
(buffer-disable-undo standard-output)
|
||
(terpri)
|
||
(princ (format " Buffer: %s\n\n" buf))
|
||
(princ (format " max-row: %s\n"
|
||
(prin1-to-string array-max-row)))
|
||
(princ (format " max-column: %s\n"
|
||
(prin1-to-string array-max-column)))
|
||
(princ (format " columns-per-line: %s\n"
|
||
(prin1-to-string array-columns-per-line)))
|
||
(princ (format " field-width: %s\n"
|
||
(prin1-to-string array-field-width)))
|
||
(princ (format " rows-numbered: %s\n"
|
||
(prin1-to-string array-rows-numbered)))
|
||
(princ (format " lines-per-row: %s\n"
|
||
(prin1-to-string array-lines-per-row)))
|
||
(princ (format " line-length: %s\n"
|
||
(prin1-to-string array-line-length))))))
|
||
|
||
|
||
|
||
;;; Internal movement functions.
|
||
|
||
(defun array-beginning-of-field (&optional go-there)
|
||
"Return the column of the beginning of the current field.
|
||
Optional argument GO-THERE, if non-nil, means go there too."
|
||
;; Requires that array-buffer-column be current.
|
||
(let ((goal-column (- array-buffer-column (% array-buffer-column array-field-width))))
|
||
(if go-there
|
||
(move-to-column-untabify goal-column)
|
||
goal-column)))
|
||
|
||
(defun array-end-of-field (&optional go-there)
|
||
"Return the column of the end of the current array field.
|
||
If optional argument GO-THERE is non-nil, go there too."
|
||
;; Requires that array-buffer-column be current.
|
||
(let ((goal-column (+ (- array-buffer-column (% array-buffer-column array-field-width))
|
||
array-field-width)))
|
||
(if go-there
|
||
(move-to-column-untabify goal-column)
|
||
goal-column)))
|
||
|
||
(defun array-move-to-cell (a-row a-column)
|
||
"Move to array row A-ROW and array column A-COLUMN.
|
||
Leave point at the beginning of the field and return the new buffer column."
|
||
(let ((goal-line (+ (* array-lines-per-row (1- a-row))
|
||
(if array-rows-numbered 1 0)
|
||
(floor (1- a-column) array-columns-per-line)))
|
||
(goal-column (* array-field-width (% (1- a-column) array-columns-per-line))))
|
||
(goto-char (point-min))
|
||
(forward-line goal-line)
|
||
(move-to-column-untabify goal-column)))
|
||
|
||
(defun array-move-to-row (a-row)
|
||
"Move to array row A-ROW preserving the current array column.
|
||
Leave point at the beginning of the field and return the new array row."
|
||
;; Requires that array-buffer-line and array-buffer-column be current.
|
||
(let ((goal-line (+ (* array-lines-per-row (1- a-row))
|
||
(% array-buffer-line array-lines-per-row)))
|
||
(goal-column (- array-buffer-column (% array-buffer-column array-field-width))))
|
||
(forward-line (- goal-line array-buffer-line))
|
||
(move-to-column-untabify goal-column)
|
||
a-row))
|
||
|
||
(defun array-move-to-column (a-column)
|
||
"Move to array column A-COLUMN preserving the current array row.
|
||
Leave point at the beginning of the field and return the new array column."
|
||
;; Requires that array-buffer-line and array-buffer-column be current.
|
||
(let ((goal-line (+ (- array-buffer-line (% array-buffer-line array-lines-per-row))
|
||
(if array-rows-numbered 1 0)
|
||
(floor (1- a-column) array-columns-per-line)))
|
||
(goal-column (* array-field-width (% (1- a-column) array-columns-per-line))))
|
||
(forward-line (- goal-line array-buffer-line))
|
||
(move-to-column-untabify goal-column)
|
||
a-column))
|
||
|
||
(defun array-move-one-row (sign)
|
||
"Move one array row in direction SIGN (1 or -1).
|
||
Leave point at the beginning of the field and return the new array row.
|
||
If requested to move beyond the array bounds, signal an error."
|
||
;; Requires that array-buffer-line and array-buffer-column be current.
|
||
(let ((goal-column (array-beginning-of-field))
|
||
(array-row (or (array-current-row)
|
||
(error "Cursor is not in a valid array cell"))))
|
||
(cond ((and (= array-row array-max-row) (= sign 1))
|
||
(error "End of array"))
|
||
((and (= array-row 1) (= sign -1))
|
||
(error "Beginning of array"))
|
||
(t
|
||
(progn
|
||
(forward-line (* sign array-lines-per-row))
|
||
(move-to-column-untabify goal-column)
|
||
(+ array-row sign))))))
|
||
|
||
(defun array-move-one-column (sign)
|
||
"Move one array column in direction SIGN (1 or -1).
|
||
Leave point at the beginning of the field and return the new array column.
|
||
If requested to move beyond the array bounds, signal an error."
|
||
;; Requires that array-buffer-line and array-buffer-column be current.
|
||
(let ((array-column (or (array-current-column)
|
||
(error "Cursor is not in a valid array cell"))))
|
||
(cond ((and (= array-column array-max-column) (= sign 1))
|
||
(error "End of array"))
|
||
((and (= array-column 1) (= sign -1))
|
||
(error "Beginning of array"))
|
||
(t
|
||
(cond
|
||
;; Going backward from first column on the line.
|
||
((and (= sign -1) (= 1 (% array-column array-columns-per-line)))
|
||
(forward-line -1)
|
||
(move-to-column-untabify
|
||
(* array-field-width (1- array-columns-per-line))))
|
||
;; Going forward from last column on the line.
|
||
((and (= sign 1) (zerop (% array-column array-columns-per-line)))
|
||
(forward-line 1))
|
||
;; Somewhere in the middle of the line.
|
||
(t
|
||
(move-to-column-untabify (+ (array-beginning-of-field)
|
||
(* array-field-width sign)))))
|
||
(+ array-column sign)))))
|
||
|
||
(defun array-normalize-cursor ()
|
||
"Move the cursor to the first non-whitespace character in the field.
|
||
If necessary, scroll horizontally to keep the cursor in view."
|
||
;; Assumes point is at the beginning of the field.
|
||
(let ((array-buffer-column (current-column)))
|
||
(skip-chars-forward " \t"
|
||
(1- (save-excursion (array-end-of-field t) (point))))
|
||
(array-maybe-scroll-horizontally)))
|
||
|
||
(defun array-maybe-scroll-horizontally ()
|
||
"If necessary, scroll horizontally to keep the cursor in view."
|
||
;; This is only called from array-normalize-cursor so
|
||
;; array-buffer-column will always be current.
|
||
(let ((w-hscroll (window-hscroll))
|
||
(w-width (window-width)))
|
||
(cond
|
||
((and (>= array-buffer-column w-hscroll)
|
||
(<= array-buffer-column (+ w-hscroll w-width)))
|
||
;; It's already visible. Do nothing.
|
||
nil)
|
||
((> array-buffer-column (+ w-hscroll w-width))
|
||
;; It's to the right. Scroll left.
|
||
(scroll-left (- (- array-buffer-column w-hscroll)
|
||
(/ w-width 2))))
|
||
(t
|
||
;; It's to the left. Scroll right.
|
||
(scroll-right (+ (- w-hscroll array-buffer-column)
|
||
(/ w-width 2)))))))
|
||
|
||
|
||
|
||
;;; Movement commands.
|
||
|
||
(defun array-next-row (&optional arg)
|
||
"Move down one array row, staying in the current array column.
|
||
If optional ARG is given, move down ARG array rows."
|
||
(interactive "p")
|
||
(let ((array-buffer-line (current-line))
|
||
(array-buffer-column (current-column)))
|
||
(if (= (abs arg) 1)
|
||
(array-move-one-row arg)
|
||
(array-move-to-row
|
||
(limit-index (+ (or (array-current-row)
|
||
(error "Cursor is not in an array cell"))
|
||
arg)
|
||
array-max-row))))
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-previous-row (&optional arg)
|
||
"Move up one array row, staying in the current array column.
|
||
If optional ARG is given, move up ARG array rows."
|
||
(interactive "p")
|
||
(array-next-row (- arg)))
|
||
|
||
(defun array-forward-column (&optional arg)
|
||
"Move forward one field, staying in the current array row.
|
||
If optional ARG is given, move forward ARG array columns.
|
||
If necessary, keep the cursor in the window by scrolling right or left."
|
||
(interactive "p")
|
||
(let ((array-buffer-line (current-line))
|
||
(array-buffer-column (current-column)))
|
||
(if (= (abs arg) 1)
|
||
(array-move-one-column arg)
|
||
(array-move-to-column
|
||
(limit-index (+ (or (array-current-column)
|
||
(error "Cursor is not in an array cell"))
|
||
arg)
|
||
array-max-column))))
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-backward-column (&optional arg)
|
||
"Move backward one field, staying in the current array row.
|
||
If optional ARG is given, move backward ARG array columns.
|
||
If necessary, keep the cursor in the window by scrolling right or left."
|
||
(interactive "p")
|
||
(array-forward-column (- arg)))
|
||
|
||
(defun array-goto-cell (a-row a-column)
|
||
"Go to array row A-ROW and array column A-COLUMN."
|
||
(interactive "nArray row: \nnArray column: ")
|
||
(array-move-to-cell
|
||
(limit-index a-row array-max-row)
|
||
(limit-index a-column array-max-column))
|
||
(array-normalize-cursor))
|
||
|
||
|
||
|
||
;;; Internal copying functions.
|
||
|
||
(defun array-field-string ()
|
||
"Return the field string at the current cursor location."
|
||
;; Requires that array-buffer-column be current.
|
||
(buffer-substring
|
||
(save-excursion (array-beginning-of-field t) (point))
|
||
(save-excursion (array-end-of-field t) (point))))
|
||
|
||
(defun array-copy-once-vertically (sign)
|
||
"Copy the current field into one array row in direction SIGN (1 or -1).
|
||
Leave point at the beginning of the field and return the new array row.
|
||
If requested to move beyond the array bounds, signal an error."
|
||
;; Requires that array-buffer-line, array-buffer-column, and array-copy-string be current.
|
||
(let ((a-row (array-move-one-row sign)))
|
||
(let ((inhibit-quit t))
|
||
(delete-region (point) (save-excursion (array-end-of-field t) (point)))
|
||
(insert array-copy-string))
|
||
(move-to-column array-buffer-column)
|
||
a-row))
|
||
|
||
(defun array-copy-once-horizontally (sign)
|
||
"Copy the current field into one array column in direction SIGN (1 or -1).
|
||
Leave point at the beginning of the field and return the new array column.
|
||
If requested to move beyond the array bounds, signal an error."
|
||
;; Requires that array-buffer-line, array-buffer-column, and array-copy-string be current.
|
||
(let ((a-column (array-move-one-column sign)))
|
||
(array-update-buffer-position)
|
||
(let ((inhibit-quit t))
|
||
(delete-region (point) (save-excursion (array-end-of-field t) (point)))
|
||
(insert array-copy-string))
|
||
(move-to-column array-buffer-column)
|
||
a-column))
|
||
|
||
(defun array-copy-to-row (a-row)
|
||
"Copy the current field vertically into every cell up to and including A-ROW.
|
||
Leave point at the beginning of the field."
|
||
;; Requires that array-buffer-line, array-buffer-column, array-row, and
|
||
;; array-copy-string be current.
|
||
(let* ((num (- a-row array-row))
|
||
(count (abs num))
|
||
(sign (if (zerop count) () (/ num count))))
|
||
(while (> count 0)
|
||
(array-move-one-row sign)
|
||
(array-update-buffer-position)
|
||
(let ((inhibit-quit t))
|
||
(delete-region (point) (save-excursion (array-end-of-field t) (point)))
|
||
(insert array-copy-string))
|
||
(move-to-column array-buffer-column)
|
||
(setq count (1- count)))))
|
||
|
||
(defun array-copy-to-column (a-column)
|
||
"Copy current field horizontally into every cell up to and including A-COLUMN.
|
||
Leave point at the beginning of the field."
|
||
;; Requires that array-buffer-line, array-buffer-column, array-column, and
|
||
;; array-copy-string be current.
|
||
(let* ((num (- a-column array-column))
|
||
(count (abs num))
|
||
(sign (if (zerop count) () (/ num count))))
|
||
(while (> count 0)
|
||
(array-move-one-column sign)
|
||
(array-update-buffer-position)
|
||
(let ((inhibit-quit t))
|
||
(delete-region (point) (save-excursion (array-end-of-field t) (point)))
|
||
(insert array-copy-string))
|
||
(move-to-column array-buffer-column)
|
||
(setq count (1- count)))))
|
||
|
||
(defun array-copy-to-cell (a-row a-column)
|
||
"Copy the current field into the cell at A-ROW, A-COLUMN.
|
||
Leave point at the beginning of the field."
|
||
;; Requires that array-copy-string be current.
|
||
(array-move-to-cell a-row a-column)
|
||
(array-update-buffer-position)
|
||
(delete-region (point) (save-excursion (array-end-of-field t) (point)))
|
||
(insert array-copy-string)
|
||
(move-to-column array-buffer-column))
|
||
|
||
|
||
|
||
;;; Commands for copying.
|
||
|
||
(defun array-copy-down (&optional arg)
|
||
"Copy the current field one array row down.
|
||
If optional ARG is given, copy down through ARG array rows."
|
||
(interactive "p")
|
||
(let* ((array-buffer-line (current-line))
|
||
(array-buffer-column (current-column))
|
||
(array-row (or (array-current-row)
|
||
(error "Cursor is not in a valid array cell")))
|
||
(array-copy-string (array-field-string)))
|
||
(if (= (abs arg) 1)
|
||
(array-copy-once-vertically arg)
|
||
(array-copy-to-row
|
||
(limit-index (+ array-row arg) array-max-row))))
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-copy-up (&optional arg)
|
||
"Copy the current field one array row up.
|
||
If optional ARG is given, copy up through ARG array rows."
|
||
(interactive "p")
|
||
(array-copy-down (- arg)))
|
||
|
||
(defun array-copy-forward (&optional arg)
|
||
"Copy the current field one array column to the right.
|
||
If optional ARG is given, copy through ARG array columns to the right."
|
||
(interactive "p")
|
||
(let* ((array-buffer-line (current-line))
|
||
(array-buffer-column (current-column))
|
||
(array-column (or (array-current-column)
|
||
(error "Cursor is not in a valid array cell")))
|
||
(array-copy-string (array-field-string)))
|
||
(if (= (abs arg) 1)
|
||
(array-copy-once-horizontally arg)
|
||
(array-copy-to-column
|
||
(limit-index (+ array-column arg) array-max-column))))
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-copy-backward (&optional arg)
|
||
"Copy the current field one array column to the left.
|
||
If optional ARG is given, copy through ARG array columns to the left."
|
||
(interactive "p")
|
||
(array-copy-forward (- arg)))
|
||
|
||
(defun array-copy-column-forward (&optional arg)
|
||
"Copy the entire current column in to the column to the right.
|
||
If optional ARG is given, copy through ARG array columns to the right."
|
||
(interactive "p")
|
||
(array-update-buffer-position)
|
||
(array-update-array-position)
|
||
(if (not array-column)
|
||
(error "Cursor is not in a valid array cell"))
|
||
(message "Working...")
|
||
(let ((this-row 0))
|
||
(while (< this-row array-max-row)
|
||
(setq this-row (1+ this-row))
|
||
(array-move-to-cell this-row array-column)
|
||
(array-update-buffer-position)
|
||
(let ((array-copy-string (array-field-string)))
|
||
(if (= (abs arg) 1)
|
||
(array-copy-once-horizontally arg)
|
||
(array-copy-to-column
|
||
(limit-index (+ array-column arg) array-max-column))))))
|
||
(message "Working...done")
|
||
(array-move-to-row array-row)
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-copy-column-backward (&optional arg)
|
||
"Copy the entire current column one column to the left.
|
||
If optional ARG is given, copy through ARG columns to the left."
|
||
(interactive "p")
|
||
(array-copy-column-forward (- arg)))
|
||
|
||
(defun array-copy-row-down (&optional arg)
|
||
"Copy the entire current row one row down.
|
||
If optional ARG is given, copy through ARG rows down."
|
||
(interactive "p")
|
||
(array-update-buffer-position)
|
||
(array-update-array-position)
|
||
(if (not array-row)
|
||
(error "Cursor is not in a valid array cell"))
|
||
(cond
|
||
((and (= array-row 1) (= arg -1))
|
||
(error "Beginning of array"))
|
||
((and (= array-row array-max-row) (= arg 1))
|
||
(error "End of array"))
|
||
(t
|
||
(let* ((array-copy-string
|
||
(buffer-substring
|
||
(save-excursion (array-move-to-cell array-row 1)
|
||
(point))
|
||
(save-excursion (array-move-to-cell array-row array-max-column)
|
||
(forward-line 1)
|
||
(point))))
|
||
(this-row array-row)
|
||
(goal-row (limit-index (+ this-row arg) array-max-row))
|
||
(num (- goal-row this-row))
|
||
(count (abs num))
|
||
(sign (if (not (zerop count)) (/ num count))))
|
||
(while (> count 0)
|
||
(setq this-row (+ this-row sign))
|
||
(array-move-to-cell this-row 1)
|
||
(let ((inhibit-quit t))
|
||
(delete-region (point)
|
||
(save-excursion
|
||
(array-move-to-cell this-row array-max-column)
|
||
(forward-line 1)
|
||
(point)))
|
||
(insert array-copy-string))
|
||
(setq count (1- count)))
|
||
(array-move-to-cell goal-row (or array-column 1)))))
|
||
(array-normalize-cursor))
|
||
|
||
(defun array-copy-row-up (&optional arg)
|
||
"Copy the entire current array row into the row above.
|
||
If optional ARG is given, copy through ARG rows up."
|
||
(interactive "p")
|
||
(array-copy-row-down (- arg)))
|
||
|
||
(defun array-fill-rectangle ()
|
||
"Copy the field at mark into every cell between mark and point."
|
||
(interactive)
|
||
;; Bind arguments.
|
||
(array-update-buffer-position)
|
||
(let ((p-row (or (array-current-row)
|
||
(error "Cursor is not in a valid array cell")))
|
||
(p-column (or (array-current-column)
|
||
(error "Cursor is not in a valid array cell")))
|
||
(m-row
|
||
(save-excursion
|
||
(exchange-point-and-mark)
|
||
(array-update-buffer-position)
|
||
(or (array-current-row)
|
||
(error "Mark is not in a valid array cell"))))
|
||
(m-column
|
||
(save-excursion
|
||
(exchange-point-and-mark)
|
||
(array-update-buffer-position)
|
||
(or (array-current-column)
|
||
(error "Mark is not in a valid array cell")))))
|
||
(message "Working...")
|
||
(let ((top-row (min m-row p-row))
|
||
(bottom-row (max m-row p-row))
|
||
(left-column (min m-column p-column))
|
||
(right-column (max m-column p-column)))
|
||
;; Do the first row.
|
||
(let ((array-copy-string
|
||
(save-excursion
|
||
(array-move-to-cell m-row m-column)
|
||
(array-update-buffer-position)
|
||
(array-field-string))))
|
||
(array-copy-to-cell top-row left-column)
|
||
(array-update-array-position top-row left-column)
|
||
(array-update-buffer-position)
|
||
(array-copy-to-column right-column))
|
||
;; Do the rest of the rows.
|
||
(array-move-to-cell top-row left-column)
|
||
(let ((array-copy-string
|
||
(buffer-substring
|
||
(point)
|
||
(save-excursion
|
||
(array-move-to-cell top-row right-column)
|
||
(setq array-buffer-column (current-column))
|
||
(array-end-of-field t)
|
||
(point))))
|
||
(this-row top-row))
|
||
(while (/= this-row bottom-row)
|
||
(setq this-row (1+ this-row))
|
||
(array-move-to-cell this-row left-column)
|
||
(let ((inhibit-quit t))
|
||
(delete-region
|
||
(point)
|
||
(save-excursion
|
||
(array-move-to-cell this-row right-column)
|
||
(setq array-buffer-column (current-column))
|
||
(array-end-of-field t)
|
||
(point)))
|
||
(insert array-copy-string)))))
|
||
(message "Working...done")
|
||
(array-goto-cell p-row p-column)))
|
||
|
||
|
||
|
||
;;; Reconfiguration of the array.
|
||
|
||
(defun array-make-template ()
|
||
"Create the template of an array."
|
||
(interactive)
|
||
;; If there is a conflict between array-field-width and init-string, resolve it.
|
||
(let ((check t)
|
||
(len)
|
||
init-field)
|
||
(while check
|
||
(setq init-field (read-string "Initial field value: "))
|
||
(setq len (length init-field))
|
||
(if (/= len array-field-width)
|
||
(if (y-or-n-p (format "Change field width to %d? " len))
|
||
(progn (setq array-field-width len)
|
||
(setq check nil)))
|
||
(setq check nil)))
|
||
(goto-char (point-min))
|
||
(message "Working...")
|
||
(let ((this-row 1))
|
||
;; Loop through the rows.
|
||
(while (<= this-row array-max-row)
|
||
(if array-rows-numbered
|
||
(insert (format "%d:\n" this-row)))
|
||
(let ((this-column 1))
|
||
;; Loop through the columns.
|
||
(while (<= this-column array-max-column)
|
||
(insert init-field)
|
||
(if (and (zerop (% this-column array-columns-per-line))
|
||
(/= this-column array-max-column))
|
||
(newline))
|
||
(setq this-column (1+ this-column))))
|
||
(setq this-row (1+ this-row))
|
||
(newline)))
|
||
(message "Working...done"))
|
||
(array-goto-cell 1 1))
|
||
|
||
(defun array-reconfigure-rows (new-columns-per-line new-rows-numbered)
|
||
"Reconfigure the state of `array-rows-numbered' and `array-columns-per-line'.
|
||
NEW-COLUMNS-PER-LINE is the desired value of `array-columns-per-line' and
|
||
NEW-ROWS-NUMBERED (a character, either ?y or ?n) is the desired value
|
||
of `array-rows-numbered'."
|
||
(interactive "nColumns per line: \ncRows numbered? (y or n) ")
|
||
;; Check on new-columns-per-line
|
||
(let ((check t))
|
||
(while check
|
||
(if (and (>= new-columns-per-line 1)
|
||
(<= new-columns-per-line array-max-column))
|
||
(setq check nil)
|
||
(setq new-columns-per-line
|
||
(string-to-number
|
||
(read-string
|
||
(format "Columns per line (1 - %d): " array-max-column)))))))
|
||
;; Check on new-rows-numbered. It has to be done this way
|
||
;; because interactive does not have y-or-n-p.
|
||
(cond
|
||
((eq new-rows-numbered ?y)
|
||
(setq new-rows-numbered t))
|
||
((eq new-rows-numbered ?n)
|
||
(setq new-rows-numbered nil))
|
||
(t
|
||
(setq new-rows-numbered (y-or-n-p "Rows numbered? "))))
|
||
(message "Working...")
|
||
(array-update-buffer-position)
|
||
(let* ((main-buffer (buffer-name (current-buffer)))
|
||
(temp-buffer (generate-new-buffer " *Array*"))
|
||
(temp-max-row array-max-row)
|
||
(temp-max-column array-max-column)
|
||
(old-rows-numbered array-rows-numbered)
|
||
(old-columns-per-line array-columns-per-line)
|
||
(old-lines-per-row array-lines-per-row)
|
||
(old-field-width array-field-width)
|
||
(old-line-length array-line-length)
|
||
(this-row 1))
|
||
(array-update-array-position)
|
||
;; Do the cutting in a temporary buffer.
|
||
(copy-to-buffer temp-buffer (point-min) (point-max))
|
||
(set-buffer temp-buffer)
|
||
(goto-char (point-min))
|
||
(while (<= this-row temp-max-row)
|
||
;; Deal with row number.
|
||
(cond
|
||
((or (and old-rows-numbered new-rows-numbered)
|
||
(and (not old-rows-numbered) (not new-rows-numbered)))
|
||
;; Nothing is changed.
|
||
())
|
||
((and old-rows-numbered (not new-rows-numbered))
|
||
;; Delete the row number.
|
||
(kill-line 1))
|
||
(t
|
||
;; Add the row number.
|
||
(insert (format "%d:\n" this-row))))
|
||
;; Deal with the array columns in this row.
|
||
(cond
|
||
((= old-columns-per-line new-columns-per-line)
|
||
;; Nothing is changed. Go to the next row.
|
||
(forward-line (- old-lines-per-row (if old-rows-numbered 1 0))))
|
||
(t
|
||
;; First expand the row. Then cut it up into new pieces.
|
||
(let ((newlines-to-be-removed
|
||
(floor (1- temp-max-column) old-columns-per-line))
|
||
(newlines-removed 0)
|
||
(newlines-to-be-added
|
||
(floor (1- temp-max-column) new-columns-per-line))
|
||
(newlines-added 0))
|
||
(while (< newlines-removed newlines-to-be-removed)
|
||
(move-to-column-untabify
|
||
(* (1+ newlines-removed) old-line-length))
|
||
(kill-line 1)
|
||
(setq newlines-removed (1+ newlines-removed)))
|
||
(beginning-of-line)
|
||
(while (< newlines-added newlines-to-be-added)
|
||
(move-to-column-untabify (* old-field-width new-columns-per-line))
|
||
(newline)
|
||
(setq newlines-added (1+ newlines-added)))
|
||
(forward-line 1))))
|
||
(setq this-row (1+ this-row)))
|
||
(let ((inhibit-quit t))
|
||
(set-buffer main-buffer)
|
||
(erase-buffer)
|
||
(insert-buffer-substring temp-buffer)
|
||
;; Update local variables.
|
||
(setq array-columns-per-line new-columns-per-line)
|
||
(setq array-rows-numbered new-rows-numbered)
|
||
(setq array-line-length (* old-field-width new-columns-per-line))
|
||
(setq array-lines-per-row
|
||
(+ (floor (1- temp-max-column) new-columns-per-line)
|
||
(if new-rows-numbered 2 1)))
|
||
(array-goto-cell (or array-row 1) (or array-column 1)))
|
||
(kill-buffer temp-buffer))
|
||
(message "Working...done"))
|
||
|
||
(defun array-expand-rows ()
|
||
"Expand the rows so each fits on one line and remove row numbers."
|
||
(interactive)
|
||
(array-reconfigure-rows array-max-column ?n))
|
||
|
||
|
||
|
||
;;; Utilities.
|
||
|
||
(defun limit-index (index limit)
|
||
(cond ((< index 1) 1)
|
||
((> index limit) limit)
|
||
(t index)))
|
||
|
||
(defun xor (pred1 pred2)
|
||
"Return the logical exclusive or of predicates PRED1 and PRED2."
|
||
(and (or pred1 pred2)
|
||
(not (and pred1 pred2))))
|
||
|
||
(defun current-line ()
|
||
"Return the current buffer line at point. The first line is 0."
|
||
(count-lines (point-min) (line-beginning-position)))
|
||
|
||
(defun move-to-column-untabify (column)
|
||
"Move to COLUMN on the current line, untabifying if necessary.
|
||
Return COLUMN."
|
||
(or (and (= column (move-to-column column))
|
||
column)
|
||
;; There is a tab in the way.
|
||
(if array-respect-tabs
|
||
(error "There is a TAB character in the way")
|
||
(progn
|
||
(untabify-backward)
|
||
(move-to-column column)))))
|
||
|
||
(defun untabify-backward ()
|
||
"Untabify the preceding TAB."
|
||
(save-excursion
|
||
(let ((start (point)))
|
||
(backward-char 1)
|
||
(untabify (point) start))))
|
||
|
||
|
||
|
||
;;; Array mode.
|
||
|
||
(defvar array-mode-map
|
||
(let ((map (make-keymap)))
|
||
(define-key map "\M-ad" 'array-display-local-variables)
|
||
(define-key map "\M-am" 'array-make-template)
|
||
(define-key map "\M-ae" 'array-expand-rows)
|
||
(define-key map "\M-ar" 'array-reconfigure-rows)
|
||
(define-key map "\M-a=" 'array-what-position)
|
||
(define-key map "\M-ag" 'array-goto-cell)
|
||
(define-key map "\M-af" 'array-fill-rectangle)
|
||
(define-key map "\C-n" 'array-next-row)
|
||
(define-key map "\C-p" 'array-previous-row)
|
||
(define-key map "\C-f" 'array-forward-column)
|
||
(define-key map "\C-b" 'array-backward-column)
|
||
(define-key map "\M-n" 'array-copy-down)
|
||
(define-key map "\M-p" 'array-copy-up)
|
||
(define-key map "\M-f" 'array-copy-forward)
|
||
(define-key map "\M-b" 'array-copy-backward)
|
||
(define-key map "\M-\C-n" 'array-copy-row-down)
|
||
(define-key map "\M-\C-p" 'array-copy-row-up)
|
||
(define-key map "\M-\C-f" 'array-copy-column-forward)
|
||
(define-key map "\M-\C-b" 'array-copy-column-backward)
|
||
map)
|
||
"Keymap used in array mode.")
|
||
|
||
|
||
(put 'array-mode 'mode-class 'special)
|
||
|
||
;;;###autoload
|
||
(define-derived-mode array-mode fundamental-mode "Array"
|
||
"Major mode for editing arrays.
|
||
|
||
Array mode is a specialized mode for editing arrays. An array is
|
||
considered to be a two-dimensional set of strings. The strings are
|
||
NOT recognized as integers or real numbers.
|
||
|
||
The array MUST reside at the top of the buffer.
|
||
|
||
TABs are not respected, and may be converted into spaces at any time.
|
||
Setting the variable `array-respect-tabs' to non-nil will prevent TAB conversion,
|
||
but will cause many functions to give errors if they encounter one.
|
||
|
||
Upon entering array mode, you will be prompted for the values of
|
||
several variables. Others will be calculated based on the values you
|
||
supply. These variables are all local to the buffer. Other buffer
|
||
in array mode may have different values assigned to the variables.
|
||
The variables are:
|
||
|
||
Variables you assign:
|
||
array-max-row: The number of rows in the array.
|
||
array-max-column: The number of columns in the array.
|
||
array-columns-per-line: The number of columns in the array per line of buffer.
|
||
array-field-width: The width of each field, in characters.
|
||
array-rows-numbered: A logical variable describing whether to ignore
|
||
row numbers in the buffer.
|
||
|
||
Variables which are calculated:
|
||
array-line-length: The number of characters in a buffer line.
|
||
array-lines-per-row: The number of buffer lines used to display each row.
|
||
|
||
The following commands are available (an asterisk indicates it may
|
||
take a numeric prefix argument):
|
||
|
||
* \\<array-mode-map>\\[array-forward-column] Move forward one column.
|
||
* \\[array-backward-column] Move backward one column.
|
||
* \\[array-next-row] Move down one row.
|
||
* \\[array-previous-row] Move up one row.
|
||
|
||
* \\[array-copy-forward] Copy the current field into the column to the right.
|
||
* \\[array-copy-backward] Copy the current field into the column to the left.
|
||
* \\[array-copy-down] Copy the current field into the row below.
|
||
* \\[array-copy-up] Copy the current field into the row above.
|
||
|
||
* \\[array-copy-column-forward] Copy the current column into the column to the right.
|
||
* \\[array-copy-column-backward] Copy the current column into the column to the left.
|
||
* \\[array-copy-row-down] Copy the current row into the row below.
|
||
* \\[array-copy-row-up] Copy the current row into the row above.
|
||
|
||
\\[array-fill-rectangle] Copy the field at mark into every cell with row and column
|
||
between that of point and mark.
|
||
|
||
\\[array-what-position] Display the current array row and column.
|
||
\\[array-goto-cell] Go to a particular array cell.
|
||
|
||
\\[array-make-template] Make a template for a new array.
|
||
\\[array-reconfigure-rows] Reconfigure the array.
|
||
\\[array-expand-rows] Expand the array (remove row numbers and
|
||
newlines inside rows)
|
||
|
||
\\[array-display-local-variables] Display the current values of local variables.
|
||
|
||
Entering array mode calls the function `array-mode-hook'."
|
||
(make-local-variable 'array-buffer-line)
|
||
(make-local-variable 'array-buffer-column)
|
||
(make-local-variable 'array-row)
|
||
(make-local-variable 'array-column)
|
||
(make-local-variable 'array-copy-string)
|
||
(set (make-local-variable 'array-respect-tabs) nil)
|
||
(set (make-local-variable 'array-max-row)
|
||
(read-number "Number of array rows: "))
|
||
(set (make-local-variable 'array-max-column)
|
||
(read-number "Number of array columns: "))
|
||
(set (make-local-variable 'array-columns-per-line)
|
||
(read-number "Array columns per line: "))
|
||
(set (make-local-variable 'array-field-width)
|
||
(read-number "Field width: "))
|
||
(set (make-local-variable 'array-rows-numbered)
|
||
(y-or-n-p "Rows numbered? "))
|
||
(set (make-local-variable 'array-line-length)
|
||
(* array-field-width array-columns-per-line))
|
||
(set (make-local-variable 'array-lines-per-row)
|
||
(+ (floor (1- array-max-column) array-columns-per-line)
|
||
(if array-rows-numbered 2 1)))
|
||
(message "")
|
||
(force-mode-line-update)
|
||
(set (make-local-variable 'truncate-lines) t)
|
||
(setq overwrite-mode 'overwrite-mode-textual))
|
||
|
||
|
||
|
||
(provide 'array)
|
||
|
||
;;; array.el ends here
|