diff options
author | Stefan Monnier <monnier@iro.umontreal.ca> | 2000-03-11 03:51:31 +0000 |
---|---|---|
committer | Stefan Monnier <monnier@iro.umontreal.ca> | 2000-03-11 03:51:31 +0000 |
commit | 5b467bf4e2787e3290280cadbae9e915df88dacd (patch) | |
tree | 83e838669d3052e213f8f518602bae5ec0cf0a15 /lisp/pcvs-info.el | |
parent | afa18a4e5d28a418fa9374c96be75a8e20f5fe08 (diff) | |
download | emacs-5b467bf4e2787e3290280cadbae9e915df88dacd.tar.gz |
*** empty log message ***
Diffstat (limited to 'lisp/pcvs-info.el')
-rw-r--r-- | lisp/pcvs-info.el | 455 |
1 files changed, 455 insertions, 0 deletions
diff --git a/lisp/pcvs-info.el b/lisp/pcvs-info.el new file mode 100644 index 00000000000..51b791e8ae3 --- /dev/null +++ b/lisp/pcvs-info.el @@ -0,0 +1,455 @@ +;;; pcvs-info.el --- Internal representation of a fileinfo entry + +;; Copyright (C) 1991-2000 Free Software Foundation, Inc. + +;; Author: Stefan Monnier <monnier@cs.yale.edu> +;; Keywords: pcl-cvs +;; Version: $Name: $ +;; Revision: $Id: pcl-cvs-info.el,v 1.28 2000/03/05 21:32:21 monnier Exp $ + +;; 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., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. + +;;; Commentary: + +;; The cvs-fileinfo data structure: +;; +;; When the `cvs update' is ready we parse the output. Every file +;; that is affected in some way is added to the cookie collection as +;; a "fileinfo" (as defined below in cvs-create-fileinfo). + +;;; Code: + +(eval-when-compile (require 'cl)) +(require 'pcvs-util) +;;(require 'pcvs-defs) + +;;;; +;;;; config variables +;;;; + +(defcustom cvs-display-full-path t + "*Specifies how the filenames should look like in the listing. +If t, their full path name will be displayed, else only the filename." + :group 'pcl-cvs + :type '(boolean)) + +(defvar global-font-lock-mode) +(defvar font-lock-auto-fontify) +(defcustom cvs-highlight + (or (and (boundp 'font-lock-auto-fontify) font-lock-auto-fontify) + (and (boundp 'global-font-lock-mode) global-font-lock-mode)) + "*Whether to use text highlighting (à la font-lock) or not." + :group 'pcl-cvs + :type '(boolean)) + +(defcustom cvs-allow-dir-commit nil + "*Allow `cvs-mode-commit' on directories. +If you commit without any marked file and with the cursor positioned +on a directory entry, cvs would commit the whole directory. This seems +to confuse some users sometimes." + :group 'pcl-cvs + :type '(boolean)) + + +;;;; +;;;; Faces for fontification +;;;; + +(defface cvs-header-face + '((((class color) (background dark)) + (:foreground "lightyellow" :bold t)) + (((class color) (background light)) + (:foreground "blue4" :bold t)) + (t (:bold t))) + "PCL-CVS face used to highlight directory changes." + :group 'pcl-cvs) + +(defface cvs-filename-face + '((((class color) (background dark)) + (:foreground "lightblue")) + (((class color) (background light)) + (:foreground "blue4")) + (t ())) + "PCL-CVS face used to highlight file names." + :group 'pcl-cvs) + +(defface cvs-unknown-face + '((((class color) (background dark)) + (:foreground "red")) + (((class color) (background light)) + (:foreground "red")) + (t (:italic t))) + "PCL-CVS face used to highlight unknown file status." + :group 'pcl-cvs) + +(defface cvs-handled-face + '((((class color) (background dark)) + (:foreground "pink")) + (((class color) (background light)) + (:foreground "pink")) + (t ())) + "PCL-CVS face used to highlight handled file status." + :group 'pcl-cvs) + +(defface cvs-need-action-face + '((((class color) (background dark)) + (:foreground "orange")) + (((class color) (background light)) + (:foreground "orange")) + (t (:italic t))) + "PCL-CVS face used to highlight status of files needing action." + :group 'pcl-cvs) + +(defface cvs-marked-face + '((((class color) (background dark)) + (:foreground "green" :bold t)) + (((class color) (background light)) + (:foreground "green3" :bold t)) + (t (:bold t))) + "PCL-CVS face used to highlight marked file indicator." + :group 'pcl-cvs) + +(defface cvs-msg-face + '((t (:italic t))) + "PCL-CVS face used to highlight CVS messages." + :group 'pcl-cvs) + + +;; There is normally no need to alter the following variable, but if +;; your site has installed CVS in a non-standard way you might have +;; to change it. + +(defvar cvs-bakprefix ".#" + "The prefix that CVS prepends to files when rcsmerge'ing.") + +(easy-mmode-defmap cvs-filename-map + '(([(mouse-2)] . cvs-mode-find-file)) + "Local keymap for text properties of file names" + :inherit 'cvs-mode-map) + +(easy-mmode-defmap cvs-status-map + '(([(mouse-2)] . cvs-mouse-toggle-mark)) + "Local keymap for text properties of status" + :inherit 'cvs-mode-map) + +(easy-mmode-defmap cvs-dirname-map + '(([(mouse-2)] . cvs-mode-find-file)) + "Local keymap for text properties of directory names" + :inherit 'cvs-mode-map) + +;; Constructor: + +(defstruct (cvs-fileinfo + (:constructor nil) + (:copier nil) + (:constructor -cvs-create-fileinfo (type dir file full-log + &key marked subtype + merge + base-rev + head-rev)) + (:conc-name cvs-fileinfo->)) + marked ;; t/nil. + type ;; See below + subtype ;; See below + dir ;; Relative directory the file resides in. + ;; (concat dir file) should give a valid path. + file ;; The file name sans the directory. + base-rev ;; During status: This is the revision that the + ;; working file is based on. + head-rev ;; During status: This is the highest revision in + ;; the repository. + merge ;; A cons cell containing the (ancestor . head) revisions + ;; of the merge that resulted in the current file. + ;;removed ;; t if the file no longer exists. + full-log ;; The output from cvs, unparsed. + ;;mod-time ;; Not used. + + ;; In addition to the above, the following values can be extracted: + + ;; handled ;; t if this file doesn't require further action. + ;; full-path ;; The complete relative filename. + ;; pp-name ;; The printed file name + ;; backup-file;; For MERGED and CONFLICT files after a \"cvs update\", + ;; this is a full path to the backup file where the + ;; untouched version resides. + + ;; The meaning of the type field: + + ;; Value ---Used by--- Explanation + ;; update status + ;; NEED-UPDATE x file needs update + ;; MODIFIED x x modified by you, unchanged in repository + ;; MERGED x x successful merge + ;; ADDED x x added by you, not yet committed + ;; MISSING x rm'd, but not yet `cvs remove'd + ;; REMOVED x x removed by you, not yet committed + ;; NEED-MERGE x need merge + ;; CONFLICT x conflict when merging + ;; ;;MOD-CONFLICT x removed locally, changed in repository. + ;; DIRCHANGE x x A change of directory. + ;; UNKNOWN x An unknown file. + ;; UP-TO-DATE x The file is up-to-date. + ;; UPDATED x x file copied from repository + ;; PATCHED x x diff applied from repository + ;; COMMITTED x x cvs commit'd + ;; DEAD An entry that should be removed + ;; MESSAGE x x This is a special fileinfo that is used + ;; to display a text that should be in + ;; full-log." + ;; TEMP A temporary message that should be removed + ;; HEADER A message that should stick at the top of the display + ;; FOOTER A message that should stick at the bottom of the display + ) +(defun cvs-create-fileinfo (type dir file msg &rest keys) + (cvs-check-fileinfo (apply #'-cvs-create-fileinfo type dir file msg keys))) + +;; Fake selectors: + +(defun cvs-fileinfo->full-path (fileinfo) + "Return the full path for the file that is described in FILEINFO." + (let ((dir (cvs-fileinfo->dir fileinfo))) + (if (eq (cvs-fileinfo->type fileinfo) 'DIRCHANGE) + (if (string= dir "") "." (directory-file-name dir)) + ;; Here, I use `concat' rather than `expand-file-name' because I want + ;; the resulting path to stay relative if `dir' is relative. + ;; I could also use `expand-file-name' with `default-directory = ""' + (concat dir (cvs-fileinfo->file fileinfo))))) + +(defun cvs-fileinfo->pp-name (fi) + "Return the filename of FI as it should be displayed." + (if cvs-display-full-path + (cvs-fileinfo->full-path fi) + (cvs-fileinfo->file fi))) + +(defun cvs-fileinfo->backup-file (fileinfo) + "Construct the file name of the backup file for FILEINFO." + (let* ((dir (cvs-fileinfo->dir fileinfo)) + (file (cvs-fileinfo->file fileinfo)) + (default-directory (file-name-as-directory (expand-file-name dir))) + (files (directory-files "." nil + (concat "^" (regexp-quote cvs-bakprefix) + (regexp-quote file) "\\."))) + bf) + (dolist (f files bf) + (when (and (file-readable-p f) + (or (null bf) (file-newer-than-file-p f bf))) + (setq bf (concat dir f)))))) + +;; (defun cvs-fileinfo->handled (fileinfo) +;; "Tell if this requires further action" +;; (memq (cvs-fileinfo->type fileinfo) '(UP-TO-DATE DEAD))) + + +;; Predicate: + +(defun boolp (x) (or (eq t x) (null x))) +(defun cvs-check-fileinfo (fi) + "Check FI's conformance to some conventions." + (let ((check 'none) + (type (cvs-fileinfo->type fi)) + (subtype (cvs-fileinfo->subtype fi)) + (marked (cvs-fileinfo->marked fi)) + (dir (cvs-fileinfo->dir fi)) + (file (cvs-fileinfo->file fi)) + (base-rev (cvs-fileinfo->base-rev fi)) + (head-rev (cvs-fileinfo->head-rev fi)) + (full-log (cvs-fileinfo->full-log fi))) + (if (and (setq check 'marked) (boolp marked) + (setq check 'base-rev) (or (null base-rev) (stringp base-rev)) + (setq check 'head-rev) (or (null head-rev) (stringp head-rev)) + (setq check 'full-log) (stringp full-log) + (setq check 'dir) + (and (stringp dir) + (not (file-name-absolute-p dir)) + (or (string= dir "") + (string= dir (file-name-as-directory dir)))) + (setq check 'file) + (and (stringp file) + (string= file (file-name-nondirectory file))) + (setq check 'type) (symbolp type) + (setq check 'consistency) + (case type + (DIRCHANGE (and (null subtype) (string= "." file))) + ((NEED-UPDATE ADDED MISSING DEAD MODIFIED MESSAGE UP-TO-DATE + REMOVED NEED-MERGE CONFLICT UNKNOWN MESSAGE) + t))) + fi + (error "Invalid :%s in cvs-fileinfo %s" check fi)))) + + +;;;; +;;;; State table to indicate what you can do when. +;;;; + +(defconst cvs-states + `((NEED-UPDATE update diff) + (UP-TO-DATE update nil remove diff safe-rm revert) + (MODIFIED update commit undo remove diff merge diff-base) + (ADDED update commit remove) + (MISSING remove undo update safe-rm revert) + (REMOVED commit add undo safe-rm) + (NEED-MERGE update undo diff diff-base) + (CONFLICT merge remove undo commit diff diff-base) + (DIRCHANGE remove update diff ,(if cvs-allow-dir-commit 'commit) tag) + (UNKNOWN ignore add remove) + (DEAD ) + (MESSAGE)) + "Fileinfo state descriptions for pcl-cvs. +This is an assoc list. Each element consists of (STATE . FUNS) +- STATE (described in `cvs-create-fileinfo') is the key +- FUNS is the list of applicable operations. + The first one (if any) should be the \"default\" action. +Most of the actions have the obvious meaning. +`safe-rm' indicates that the file can be removed without losing + any information.") + +;;;; +;;;; Utility functions +;;;; + +;;---------- +(defun cvs-applicable-p (fi-or-type func) + "Check if FUNC is applicable to FI-OR-TYPE. +If FUNC is nil, always return t. +FI-OR-TYPE can either be a symbol (a fileinfo-type) or a fileinfo." + (let ((type (if (symbolp fi-or-type) fi-or-type + (cvs-fileinfo->type fi-or-type)))) + (and (not (eq type 'MESSAGE)) + (eq (car (memq func (cdr (assq type cvs-states)))) func)))) + +;; (defun cvs-default-action (fileinfo) +;; "Return some kind of \"default\" action to be performed." +;; (second (assq (cvs-fileinfo->type fileinfo) cvs-states))) + +;; fileinfo pretty-printers: + +(defun cvs-add-face (str face &optional keymap) + (when cvs-highlight + (add-text-properties 0 (length str) + (list* 'face face + (when keymap + (list 'mouse-face 'highlight + 'local-map keymap))) + str)) + str) + +;;---------- +(defun cvs-fileinfo-pp (fileinfo) + "Pretty print FILEINFO. Insert a printed representation in current buffer. +For use by the cookie package." + (cvs-check-fileinfo fileinfo) + (let ((type (cvs-fileinfo->type fileinfo)) + (subtype (cvs-fileinfo->subtype fileinfo))) + (insert + (case type + (DIRCHANGE (concat "In directory " + (cvs-add-face (cvs-fileinfo->full-path fileinfo) + 'cvs-header-face cvs-dirname-map) + ":")) + (MESSAGE + (if (memq (cvs-fileinfo->subtype fileinfo) '(FOOTER HEADER)) + (cvs-fileinfo->full-log fileinfo) + (cvs-add-face (format "Message: %s" (cvs-fileinfo->full-log fileinfo)) + 'cvs-msg-face))) + (t + (let* ((status (if (cvs-fileinfo->marked fileinfo) + (cvs-add-face "*" 'cvs-marked-face) + " ")) + (file (cvs-add-face (cvs-fileinfo->pp-name fileinfo) + 'cvs-filename-face cvs-filename-map)) + (base (or (cvs-fileinfo->base-rev fileinfo) "")) + (head (cvs-fileinfo->head-rev fileinfo)) + (type + (let ((str (case type + ;;(MOD-CONFLICT "Not Removed") + (DEAD "") + (t (capitalize (symbol-name type))))) + (face (case type + (UP-TO-DATE 'cvs-handled-face) + (UNKNOWN 'cvs-unknown-face) + (t 'cvs-need-action-face)))) + (cvs-add-face str face cvs-status-map))) + (side (or + ;; maybe a subtype + (when subtype (downcase (symbol-name subtype))) + ;; or the head-rev + (when (and head (not (string= head base))) head) + ;; or nothing + "")) + ;; (action (cvs-add-face (case (cvs-default-action fileinfo) + ;; (commit "com") + ;; (update "upd") + ;; (undo "udo") + ;; (t " ")) + ;; 'cvs-action-face + ;; cvs-action-map)) + ) + (concat (cvs-string-fill side 11) " " + status " " + (cvs-string-fill type 11) " " + ;; action " " + (cvs-string-fill base 11) " " + file))))))) +;; it seems that `format' removes text-properties. Too bad! +;; (format "%-11s %s %-11s %-11s %s" +;; side status type base file))))))) + + +(defun cvs-fileinfo-update (fi fi-new) + "Update FI with the information provided in FI-NEW." + (let ((type (cvs-fileinfo->type fi-new)) + (merge (cvs-fileinfo->merge fi-new))) + (setf (cvs-fileinfo->type fi) type) + (setf (cvs-fileinfo->subtype fi) (cvs-fileinfo->subtype fi-new)) + (setf (cvs-fileinfo->full-log fi) (cvs-fileinfo->full-log fi-new)) + (setf (cvs-fileinfo->base-rev fi) (cvs-fileinfo->base-rev fi-new)) + (setf (cvs-fileinfo->head-rev fi) (cvs-fileinfo->head-rev fi-new)) + (cond + (merge (setf (cvs-fileinfo->merge fi) merge)) + ((memq type '(UP-TO-DATE NEED-UPDATE)) + (setf (cvs-fileinfo->merge fi) nil))))) + +;;---------- +(defun cvs-fileinfo< (a b) + "Compare fileinfo A with fileinfo B and return t if A is `less'. +The ordering defined by this function is such that directories are +sorted alphabetically, and inside every directory the DIRCHANGE +fileinfo will appear first, followed by all files (alphabetically)." + (let ((subtypea (cvs-fileinfo->subtype a)) + (subtypeb (cvs-fileinfo->subtype b))) + (cond + ;; keep header and footer where they belong. Note: the order is important + ((eq subtypeb 'HEADER) nil) + ((eq subtypea 'HEADER) t) + ((eq subtypea 'FOOTER) nil) + ((eq subtypeb 'FOOTER) t) + + ;; Sort according to directories. + ((string< (cvs-fileinfo->dir a) (cvs-fileinfo->dir b)) t) + ((not (string= (cvs-fileinfo->dir a) (cvs-fileinfo->dir b))) nil) + + ;; The DIRCHANGE entry is always first within the directory. + ((eq (cvs-fileinfo->type b) 'DIRCHANGE) nil) + ((eq (cvs-fileinfo->type a) 'DIRCHANGE) t) + + ;; All files are sorted by file name. + ((string< (cvs-fileinfo->file a) (cvs-fileinfo->file b)))))) + +(provide 'pcvs-info) + +;;; pcl-cvs-info.el ends here |