Mercurial > hg > xemacs-beta
diff lisp/ediff/ediff-init.el @ 0:376386a54a3c r19-14
Import from CVS: tag r19-14
author | cvs |
---|---|
date | Mon, 13 Aug 2007 08:45:50 +0200 |
parents | |
children | bcdc7deadc19 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lisp/ediff/ediff-init.el Mon Aug 13 08:45:50 2007 +0200 @@ -0,0 +1,1521 @@ +;;; ediff-init.el --- Macros, variables, and defsubsts used by Ediff + +;; Copyright (C) 1994, 1995, 1996 Free Software Foundation, Inc. + +;; Author: Michael Kifer <kifer@cs.sunysb.edu> + +;; 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. + +;;; Code: + +;; Start compiler pacifier +(defvar ediff-metajob-name) +(defvar ediff-meta-buffer) +(defvar pm-color-alist) +(defvar ediff-grab-mouse) +(defvar ediff-mouse-pixel-position) +(defvar ediff-mouse-pixel-threshold) +(defvar ediff-whitespace) +(defvar ediff-multiframe) +;; end pacifier + +;; Is it XEmacs? +(defconst ediff-xemacs-p (string-match "XEmacs" emacs-version)) +;; Is it Emacs? +(defconst ediff-emacs-p (not ediff-xemacs-p)) + +(defvar ediff-force-faces nil + "If t, Ediff will think that it is running on a display that supports faces. +This is provided as a temporary relief for users of face-capable displays +that Ediff doesn't know about.") + +;; Are we running as a window application or on a TTY? +(defsubst ediff-device-type () + (if ediff-emacs-p + window-system + (device-type (selected-device)))) + +;; in XEmacs: device-type is tty on tty and stream in batch. +(defun ediff-window-display-p () + (and (ediff-device-type) (not (memq (ediff-device-type) '(tty pc stream))))) + +;; test if supports faces +;; ediff-force-faces is for those devices that support faces, but we don't know +;; this yet +(defun ediff-has-face-support-p () + (cond ((ediff-window-display-p)) + (ediff-force-faces) + (ediff-emacs-p (memq (ediff-device-type) '(pc))) + (ediff-xemacs-p (memq (ediff-device-type) '(tty pc))))) + + +;; Defines SYMBOL as an advertised local variable. +;; Performs a defvar, then executes `make-variable-buffer-local' on +;; the variable. Also sets the `permanent-local' property, +;; so that `kill-all-local-variables' (called by major-mode setting +;; commands) won't destroy Ediff control variables. +;; +;; Plagiarised from `emerge-defvar-local' for XEmacs. +(defmacro ediff-defvar-local (var value doc) + (` (progn + (defvar (, var) (, value) (, doc)) + (make-variable-buffer-local '(, var)) + (put '(, var) 'permanent-local t)))) + + + +;; Variables that control each Ediff session---local to the control buffer. + +;; Mode variables +;; The buffer in which the A variant is stored. +(ediff-defvar-local ediff-buffer-A nil "") +;; The buffer in which the B variant is stored. +(ediff-defvar-local ediff-buffer-B nil "") +;; The buffer in which the C variant is stored. +(ediff-defvar-local ediff-buffer-C nil "") +;; Ancestor buffer +(ediff-defvar-local ediff-ancestor-buffer nil "") +;; The control buffer of ediff. +(ediff-defvar-local ediff-control-buffer nil "") + +;;; Macros +(defmacro ediff-odd-p (arg) + (` (eq (logand (, arg) 1) 1))) + +(defmacro ediff-buffer-live-p (buf) + (` (and (, buf) (get-buffer (, buf)) (buffer-name (get-buffer (, buf)))))) + +(defmacro ediff-get-buffer (arg) + (` (cond ((eq (, arg) 'A) ediff-buffer-A) + ((eq (, arg) 'B) ediff-buffer-B) + ((eq (, arg) 'C) ediff-buffer-C) + ((eq (, arg) 'Ancestor) ediff-ancestor-buffer) + ) + )) + +(defmacro ediff-get-value-according-to-buffer-type (buf-type list) + (` (cond ((eq (, buf-type) 'A) (nth 0 (, list))) + ((eq (, buf-type) 'B) (nth 1 (, list))) + ((eq (, buf-type) 'C) (nth 2 (, list)))))) + +(defmacro ediff-char-to-buftype (arg) + (` (cond ((memq (, arg) '(?a ?A)) 'A) + ((memq (, arg) '(?b ?B)) 'B) + ((memq (, arg) '(?c ?C)) 'C) + ) + )) + +(defmacro ediff-get-difference (n buf-type) + (` (aref + (symbol-value + (intern (format "ediff-difference-vector-%S" (, buf-type)))) (, n)))) + +;; tell if it has been previously determined that the region has +;; no diffs other than the white space and newlines +;; The argument, N, is the diff region number used by Ediff to index the +;; diff vector. It is 1 less than the number seen by the user. +;; +;; A difference vector has the form: +;; [diff diff diff ...] +;; where each diff has the form: +;; [overlay fine-diff-vector no-fine-diffs-flag] +;; fine-diff-vector is a vector [fine-diff fine-diff fine-diff ...] +(defmacro ediff-no-fine-diffs-p (n) + (` (aref (ediff-get-difference (, n) 'A) 2))) + +(defmacro ediff-get-diff-overlay-from-diff-record (diff-rec) + (` (aref (, diff-rec) 0))) + +(defmacro ediff-get-diff-overlay (n buf-type) + (` (ediff-get-diff-overlay-from-diff-record + (ediff-get-difference (, n) (, buf-type))))) + +(defmacro ediff-get-fine-diff-vector-from-diff-record (diff-rec) + (` (aref (, diff-rec) 1))) + +(defmacro ediff-set-fine-diff-vector (n buf-type fine-vec) + (` (aset (ediff-get-difference (, n) (, buf-type)) 1 (, fine-vec)))) + +(defmacro ediff-get-state-of-diff (n buf-type) + (` (if (ediff-buffer-live-p ediff-buffer-C) + (aref (ediff-get-difference (, n) (, buf-type)) 3)))) +(defmacro ediff-set-state-of-diff (n buf-type val) + (` (aset (ediff-get-difference (, n) (, buf-type)) 3 (, val)))) +(defmacro ediff-get-state-of-merge (n) + (` (if ediff-state-of-merge + (aref (aref ediff-state-of-merge (, n)) 0)))) +(defmacro ediff-get-state-of-ancestor (n) + (` (if ediff-state-of-merge + (aref (aref ediff-state-of-merge (, n)) 1)))) +(defmacro ediff-set-state-of-merge (n val) + (` (if ediff-state-of-merge + (aset (aref ediff-state-of-merge (, n)) 0 (, val))))) + +;; if flag is t, puts a mark on diff region saying that +;; the differences are in white space only. If flag is nil, +;; the region is marked as essential (i.e., differences are +;; not just in the white space and newlines.) +(defmacro ediff-mark-diff-as-space-only (n flag) + (` (aset (ediff-get-difference (, n) 'A) 2 (, flag)))) + +(defmacro ediff-get-fine-diff-vector (n buf-type) + (` (ediff-get-fine-diff-vector-from-diff-record + (ediff-get-difference (, n) (, buf-type))))) + +;; Macro to switch to BUFFER, evaluate FORMS, returns to original buffer. +;; Differs from `save-excursion' in that it doesn't save the point and mark. +;; This is essentially `emerge-eval-in-buffer' with the test for live buffers." +(defmacro ediff-eval-in-buffer (buffer &rest forms) + (` (let ((StartBuffer (current-buffer))) + (if (ediff-buffer-live-p (, buffer)) + (unwind-protect + (progn + (set-buffer (, buffer)) + (,@ forms)) + (set-buffer StartBuffer)) + (or (eq this-command 'ediff-quit) + (error ediff-KILLED-VITAL-BUFFER)) + )))) + + +(defsubst ediff-multiframe-setup-p () + (and (ediff-window-display-p) ediff-multiframe)) + +(defmacro ediff-narrow-control-frame-p () + (` (and (ediff-multiframe-setup-p) + (equal ediff-help-message ediff-brief-message-string)))) + +(defmacro ediff-3way-comparison-job () + (` (memq + ediff-job-name + '(ediff-files3 ediff-buffers3)))) +(ediff-defvar-local ediff-3way-comparison-job nil "") + +(defmacro ediff-merge-job () + (` (memq + ediff-job-name + '(ediff-merge-files + ediff-merge-buffers + ediff-merge-files-with-ancestor + ediff-merge-buffers-with-ancestor + ediff-merge-revisions + ediff-merge-revisions-with-ancestor)))) +(ediff-defvar-local ediff-merge-job nil "") + +(defmacro ediff-merge-with-ancestor-job () + (` (memq + ediff-job-name + '(ediff-merge-files-with-ancestor + ediff-merge-buffers-with-ancestor + ediff-merge-revisions-with-ancestor)))) +(ediff-defvar-local ediff-merge-with-ancestor-job nil "") + +(defmacro ediff-3way-job () + (` (or ediff-3way-comparison-job ediff-merge-job))) +(ediff-defvar-local ediff-3way-job nil "") + +;; A diff3 job is like a 3way job, but ediff-merge doesn't require the use +;; of diff3. +(defmacro ediff-diff3-job () + (` (or ediff-3way-comparison-job + ediff-merge-with-ancestor-job))) +(ediff-defvar-local ediff-diff3-job nil "") + +(defmacro ediff-windows-job () + (` (memq ediff-job-name '(ediff-windows-wordwise ediff-windows-linewise)))) +(ediff-defvar-local ediff-windows-job nil "") + +(defmacro ediff-word-mode-job () + (` (memq ediff-job-name '(ediff-windows-wordwise ediff-regions-wordwise)))) +(ediff-defvar-local ediff-word-mode-job nil "") + +(defmacro ediff-narrow-job () + (` (memq ediff-job-name '(ediff-windows-wordwise + ediff-regions-wordwise + ediff-windows-linewise + ediff-regions-linewise)))) +(ediff-defvar-local ediff-narrow-job nil "") + +;; Note: ediff-merge-directory-revisions-with-ancestor is not treated as an +;; ancestor metajob, since it behaves differently. +(defsubst ediff-ancestor-metajob (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-merge-directories-with-ancestor + ediff-merge-filegroups-with-ancestor))) +(defsubst ediff-revision-metajob (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-directory-revisions + ediff-merge-directory-revisions + ediff-merge-directory-revisions-with-ancestor))) +(defsubst ediff-patch-metajob (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-multifile-patch))) +;; metajob involving only one group of files, such as multipatch or directory +;; revision +(defsubst ediff-one-filegroup-metajob (&optional metajob) + (or (ediff-revision-metajob metajob) + (ediff-patch-metajob metajob) + ;; add more here + )) +(defsubst ediff-collect-diffs-metajob (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-directories + ediff-directory-revisions + ediff-merge-directories + ediff-merge-directories-with-ancestor + ediff-merge-directory-revisions + ediff-merge-directory-revisions-with-ancestor + ;; add more here + ))) + +(defsubst ediff-metajob3 (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-merge-directories-with-ancestor + ediff-merge-filegroups-with-ancestor + ediff-directories3 + ediff-filegroups3))) +(defsubst ediff-comparison-metajob3 (&optional metajob) + (memq (or metajob ediff-metajob-name) + '(ediff-directories3 ediff-filegroups3))) + +(defsubst ediff-barf-if-not-control-buffer (&optional meta-buf) + (or (eq (if meta-buf ediff-meta-buffer ediff-control-buffer) + (current-buffer)) + (error "%S: This command runs in Ediff Control Buffer only!" + this-command))) + + +;; Hook variables + +(defvar ediff-before-setup-windows-hook nil + "*Hooks to run before Ediff sets its window configuration. +This can be used to save the previous window config, which can be restored +on ediff-quit or ediff-suspend.") +(defvar ediff-after-setup-windows-hook nil + "*Hooks to run after Ediff sets its window configuration. +This can be used to set up control window or icon in a desired place.") +(defvar ediff-before-setup-control-frame-hook nil + "*Hooks run before setting up the frame to display Ediff Control Panel. +Can be used to change control frame parameters to position it where it +is desirable.") +(defvar ediff-after-setup-control-frame-hook nil + "*Hooks run after setting up the frame to display Ediff Control Panel. +Can be used to move the frame where it is desired.") +(defvar ediff-startup-hook nil + "*Hooks to run in the control buffer after Ediff has been set up.") +(defvar ediff-select-hook nil + "*Hooks to run after a difference has been selected.") +(defvar ediff-unselect-hook nil + "*Hooks to run after a difference has been unselected.") +(defvar ediff-prepare-buffer-hook nil + "*Hooks called after buffers A, B, and C are set up.") +(defvar ediff-load-hook nil + "*Hook run after Ediff is loaded. Can be used to change defaults.") + +(defvar ediff-mode-hook nil + "*Hook run just after ediff-mode is set up in the control buffer. +This is done before any windows or frames are created. One can use it to +set local variables that determine how the display looks like.") +(defvar ediff-keymap-setup-hook nil + "*Hook run just after the default bindings in Ediff keymap are set up.") + +(defvar ediff-display-help-hook nil + "*Hooks run after preparing the help message.") + +(defvar ediff-suspend-hook (list 'ediff-default-suspend-function) + "*Hooks to run in the Ediff control buffer when Ediff is suspended.") +(defvar ediff-quit-hook (list 'ediff-cleanup-mess) + "*Hooks to run in the Ediff control buffer after finishing Ediff.") +(defvar ediff-cleanup-hook nil + "*Hooks to run on exiting Ediff but before killing the control buffer. +This is a place to do various cleanups, such as deleting the variant buffers. +Ediff provides a function, `ediff-janitor', as one such possible hook.") + + +;; Help messages + +(defconst ediff-long-help-message-head + " Moving around | Toggling features | Manipulations +=====================|===========================|=============================" + "The head of the full help message.") +(defconst ediff-long-help-message-tail + "=====================|===========================|============================= + R -show registry | | M -show session group + D -diff output | E -browse Ediff manual| G -send bug report + i -status info | ? -help off | z/q -suspend/quit +------------------------------------------------------------------------------- +X,Y (x,y) on the left are meta-symbols for the keys A,B,C (a,b,c). +X,Y on the right are meta-symbols for buffers A,B,C. +A,B,C on the right denote the working buffers A,B,C, respectively." + "The tail of the full-help message.") + +(defconst ediff-long-help-message-compare3 + " +p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y +n,SPC -next diff | h -hiliting | rx -restore buf X's old diff + j -jump to diff | @ -auto-refinement | * -refine current region + gx -goto X's point| | ! -update diff regions + C-l -recenter | ## -ignore whitespace | + v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X + </> -scroll lt/rt | X -read-only in buf X | wd -save diff output + | m -wide display | ~ -rotate buffers +" + "Help message usually used for 3-way comparison. +Normally, not a user option. See `ediff-help-message' for details.") + +(defconst ediff-long-help-message-compare2 + " +p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A +n,SPC -next diff | h -hiliting | rx -restore buf X's old diff + j -jump to diff | @ -auto-refinement | * -refine current region + gx -goto X's point| | ! -update diff regions + C-l -recenter | ## -ignore whitespace | + v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X + </> -scroll lt/rt | X -read-only in buf X | wd -save diff output + ~ -swap variants | m -wide display | +" + "Help message usually used for 2-way comparison. +Normally, not a user option. See `ediff-help-message' for details.") + +(defconst ediff-long-help-message-narrow2 + " +p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A +n,SPC -next diff | h -hiliting | rx -restore buf X's old diff + j -jump to diff | @ -auto-refinement | * -refine current region + gx -goto X's point| % -narrow/widen buffs | ! -update diff regions + C-l -recenter | ## -ignore whitespace | + v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X + </> -scroll lt/rt | X -read-only in buf X | wd -save diff output + ~ -swap variants | m -wide display | +" + "Help message when comparing windows or regions line-by-line. +Normally, not a user option. See `ediff-help-message' for details.") + +(defconst ediff-long-help-message-word-mode + " +p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y +n,SPC -next diff | h -hiliting | rx -restore buf X's old diff + j -jump to diff | | + gx -goto X's point| % -narrow/widen buffs | ! -recompute diffs + C-l -recenter | | + v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X + </> -scroll lt/rt | X -read-only in buf X | wd -save diff output + ~ -swap variants | m -wide display | +" + "Help message when comparing windows or regions word-by-word. +Normally, not a user option. See `ediff-help-message' for details.") + +(defconst ediff-long-help-message-merge + " +p,DEL -previous diff | | -vert/horiz split | x -copy buf X's region to C +n,SPC -next diff | h -hiliting | r -restore buf C's old diff + j -jump to diff | @ -auto-refinement | * -refine current region + gx -goto X's point| ## -ignore whitespace | ! -update diff regions + C-l -recenter | #f/#h -focus/hide regions | + -combine diff regions + v/V -scroll up/dn | X -read-only in buf X | wx -save buf X + </> -scroll lt/rt | m -wide display | wd -save diff output + ~ -swap variants | s -shrink window C | / -show ancestor buff + | $ -show clashes only | & -merge w/new default +" + "Help message during merging. +Normally, not a user option. See `ediff-help-message' for details.") + +;; The actual long help message. +(ediff-defvar-local ediff-long-help-message "" + "Normally, not a user option. See `ediff-help-message' for details.") + +(defconst ediff-brief-message-string + " ? - help " + "Contents of the brief help message.") +;; The actual brief help message +(ediff-defvar-local ediff-brief-help-message "" + "Normally, not a user option. See `ediff-help-message' for details.") + +(ediff-defvar-local ediff-brief-help-message-function nil + "The brief help message that the user can customize. +If the user sets this to a parameter-less function, Ediff will use it to +produce the brief help message. This function must return a string.") +(ediff-defvar-local ediff-long-help-message-function nil + "The long help message that the user can customize. +See `ediff-brief-help-message-function' for more.") + +(defvar ediff-use-long-help-message nil + "*If t, Ediff displays a long help message. Short help message otherwise.") + +;; The actual help message. +(ediff-defvar-local ediff-help-message "" + "The actual help message. +Normally, the user shouldn't touch this. However, if you want Ediff to +start up with different help messages for different jobs, you can change +the value of this variable and the variables `ediff-help-message-*' in +`ediff-startup-hook'.") + +;; Error messages +(defconst ediff-KILLED-VITAL-BUFFER + "You have killed a vital Ediff buffer---you must leave Ediff now!") +(defconst ediff-NO-DIFFERENCES + "Sorry, comparison of identical variants is not what I am made for...") +(defconst ediff-BAD-DIFF-NUMBER + ;; %S stands for this-command, %d - diff number, %d - max diff + "%S: Bad diff region number, %d. Valid numbers are 1 to %d") + +;; Selective browsing + +(ediff-defvar-local ediff-skip-diff-region-function 'ediff-show-all-diffs + "Function that determines the next/previous diff region to show. +Should return t for regions to be ignored and nil otherwise. +This function gets a region number as an argument. The region number +is the one used internally by Ediff. It is 1 less than the number seen +by the user.") + +(ediff-defvar-local ediff-hide-regexp-matches-function + 'ediff-hide-regexp-matches + "Function to use in determining which regions to hide. +See the documentation string of `ediff-hide-regexp-matches' for details.") +(ediff-defvar-local ediff-focus-on-regexp-matches-function + 'ediff-focus-on-regexp-matches + "Function to use in determining which regions to focus on. +See the documentation string of `ediff-focus-on-regexp-matches' for details.") + +;; Regexp that determines buf A regions to focus on when skipping to diff +(ediff-defvar-local ediff-regexp-focus-A "" "") +;; Regexp that determines buf B regions to focus on when skipping to diff +(ediff-defvar-local ediff-regexp-focus-B "" "") +;; Regexp that determines buf C regions to focus on when skipping to diff +(ediff-defvar-local ediff-regexp-focus-C "" "") +;; connective that determines whether to focus regions that match both or +;; one of the regexps +(ediff-defvar-local ediff-focus-regexp-connective 'and "") + +;; Regexp that determines buf A regions to ignore when skipping to diff +(ediff-defvar-local ediff-regexp-hide-A "" "") +;; Regexp that determines buf B regions to ignore when skipping to diff +(ediff-defvar-local ediff-regexp-hide-B "" "") +;; Regexp that determines buf C regions to ignore when skipping to diff +(ediff-defvar-local ediff-regexp-hide-C "" "") +;; connective that determines whether to hide regions that match both or +;; one of the regexps +(ediff-defvar-local ediff-hide-regexp-connective 'and "") + + +(defvar ediff-ange-ftp-ftp-name (if ediff-xemacs-p + 'ange-ftp-ftp-path + 'ange-ftp-ftp-name) + "Function ange-ftp uses to find out if file is remote.") + + +;; Copying difference regions between buffers. +(ediff-defvar-local ediff-killed-diffs-alist nil + "A list of killed diffs. +A diff is saved here if it is replaced by a diff +from another buffer. This alist has the form: +\((num (buff-object . diff) (buff-object . diff) (buff-object . diff)) ...), +where some buffer-objects may be missing.") + + +;; Highlighting +;;(defvar ediff-before-flag-bol (if ediff-emacs-p "->>\n" (make-glyph "->>\n")) +(defvar ediff-before-flag-bol (if ediff-xemacs-p (make-glyph "->>") "->>") + "*Flag placed above the highlighted block of differences. +Must end with newline.") +;;(defvar ediff-after-flag-eol (if ediff-emacs-p "<<-\n" (make-glyph "<<-")) +(defvar ediff-after-flag-eol (if ediff-xemacs-p (make-glyph "<<-") "<<-") + "*Flag placed below the highlighted block of differences. +Must end with newline.") + +(defvar ediff-before-flag-mol (if ediff-xemacs-p (make-glyph "->>") "->>") + "*Like ediff-before-flag, used when a difference starts in mid-line.") +(defvar ediff-after-flag-mol (if ediff-xemacs-p (make-glyph "<<-") "<<-") + "*Like ediff-after-flag, used when a difference starts in mid-line.") + + +(ediff-defvar-local ediff-use-faces t + "If t, differences are highlighted using faces, if device supports faces. +If nil, differences are highlighted using ASCII flags, ediff-before-flag +and ediff-after-flag. On a non-window system, differences are always +highlighted using ASCII flags. +This variable can be set either in .emacs or toggled interactively. +Use `setq-default' if setting it in .emacs") + +;; this indicates that diff regions are word-size, so fine diffs are +;; permanently nixed; used in ediff-windows-wordwise and ediff-regions-wordwise +(ediff-defvar-local ediff-word-mode nil "") +;; Name of the job (ediff-files, ediff-windows, etc.) +(ediff-defvar-local ediff-job-name nil "") + +;; Narrowing and ediff-region/windows support +;; This is a list (overlay-A overlay-B overlay-C) +;; If set, Ediff compares only those parts of buffers A/B/C that lie within +;; the bounds of these overlays. +(ediff-defvar-local ediff-narrow-bounds nil "") + +;; List (overlay-A overlay-B overlay-C), where each overlay spans the +;; entire corresponding buffer. +(ediff-defvar-local ediff-wide-bounds nil "") + +;; Current visibility boundaries in buffers A, B, and C. +;; This is also a list of overlays. When the user toggles narrow/widen, +;; this list changes from ediff-wide-bounds to ediff-narrow-bounds. +;; and back. +(ediff-defvar-local ediff-visible-bounds nil "") + +(ediff-defvar-local ediff-start-narrowed t + "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*") +(ediff-defvar-local ediff-quit-widened t + "*Non-nil means: when finished, Ediff widens buffers A/B. +Actually, Ediff restores the scope of visibility that existed at startup.") +(defvar ediff-keep-variants t + "*Nil means that non-modified variant buffers should be removed after some +interrogation. +Supplying a prefix argument to the quit command `q' temporarily reverses the +meaning of this variable.") + +(ediff-defvar-local ediff-highlight-all-diffs t + "If nil, only the selected differences are highlighted. +This variable can be set either in .emacs or toggled interactively, using +ediff-toggle-hilit. Use `setq-default' to set it.") + +;; A var local to each control panel buffer. Indicates highlighting style +;; in effect for this buffer: `face', `ascii', nil -- temporarily +;; unhighlighted, `off' -- turned off \(on a dumb terminal only\). +(ediff-defvar-local ediff-highlighting-style nil "") + + +;; The suffix of the control buffer name. +(ediff-defvar-local ediff-control-buffer-suffix nil "") +;; Same as ediff-control-buffer-suffix, but without <,>. +;; It's a number rather than string. +(ediff-defvar-local ediff-control-buffer-number nil "") + + +;; The original values of ediff-protected-variables for buffer A +(ediff-defvar-local ediff-buffer-values-orig-A nil "") +;; The original values of ediff-protected-variables for buffer B +(ediff-defvar-local ediff-buffer-values-orig-B nil "") +;; The original values of ediff-protected-variables for buffer C +(ediff-defvar-local ediff-buffer-values-orig-C nil "") +;; The original values of ediff-protected-variables for buffer Ancestor +(ediff-defvar-local ediff-buffer-values-orig-Ancestor nil "") +;; Buffer-local variables to be saved then restored during Ediff sessions +;; Buffer-local variables to be saved then restored during Ediff sessions +(defconst ediff-protected-variables '(buffer-read-only +;;; synchronize-minibuffers + mode-line-format)) + +;; Vector of differences between the variants. Each difference is +;; represented by a vector of two overlays plus a vector of fine diffs, +;; plus a no-fine-diffs flag. The first overlay spans the +;; difference region in the A buffer and the second overlays the diff in +;; the B buffer. If a difference section is empty, the corresponding +;; overlay's endpoints coincide. +;; +;; The precise form of a difference vector for one buffer is: +;; [diff diff diff ...] +;; where each diff has the form: +;; [diff-overlay fine-diff-vector no-fine-diffs-flag state-of-difference] +;; fine-diff-vector is a vector [fine-diff-overlay fine-diff-overlay ...] +;; no-fine-diffs-flag says if there are fine differences. +;; state-of-difference is A, B, C, or nil, indicating which buffer is +;; different from the other two (used only in 3-way jobs. +(ediff-defvar-local ediff-difference-vector-A nil "") +(ediff-defvar-local ediff-difference-vector-B nil "") +(ediff-defvar-local ediff-difference-vector-C nil "") +(ediff-defvar-local ediff-difference-vector-Ancestor nil "") + +;; [ status status status ...] +;; Each status: [state-of-merge state-of-ancestor] +;; state-of-merge is default-A, default-B, prefer-A, or prefer-B. It +;; indicates the way a diff region was created in buffer C. +;; state-of-ancestor says if the corresponding region in ancestor buffer is +;; empty. +(ediff-defvar-local ediff-state-of-merge nil "") + +;; The difference that is currently selected. +(ediff-defvar-local ediff-current-difference -1 "") +;; Number of differences found. +(ediff-defvar-local ediff-number-of-differences nil "") + +;; Buffer containing the output of diff, which is used by Ediff to step +;; through files. +(ediff-defvar-local ediff-diff-buffer nil "") +;; Like ediff-diff-buffer, but contains context diff. It is not used by +;; Ediff, but it is saved in a file, if user requests so. +(ediff-defvar-local ediff-custom-diff-buffer nil "") +;; Buffer used for diff-style fine differences between regions. +(ediff-defvar-local ediff-fine-diff-buffer nil "") +;; Temporary buffer used for computing fine differences. +(defconst ediff-tmp-buffer " *ediff-tmp*" "") +;; Buffer used for messages +(defconst ediff-msg-buffer " *ediff-message*" "") +;; Buffer containing the output of diff when diff returns errors. +(ediff-defvar-local ediff-error-buffer nil "") +;; Buffer to display debug info +(ediff-defvar-local ediff-debug-buffer "*ediff-debug*" "") + +;; List of ediff control panels associated with each buffer A/B/C/Ancestor. +;; Not used any more, but may be needed in the future. +(ediff-defvar-local ediff-this-buffer-ediff-sessions nil "") + +;; to be deleted in due time +;; List of difference overlays disturbed by working with the current diff. +(defvar ediff-disturbed-overlays nil "") + +;; Priority of non-selected overlays. +(defvar ediff-shadow-overlay-priority 100 "") + +(defvar ediff-version-control-package 'vc + "Version control package used. +Currently, Ediff supports vc.el, rcs.el, pcl-cvs.el, and generic-sc.el. The +standard Emacs interface to RCS, CVS, SCCS, etc., is vc.el. However, some +people find the other two packages more convenient. Set this variable to the +appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire.") + + +(if ediff-xemacs-p + (progn + (fset 'ediff-read-event (symbol-function 'next-command-event)) + (fset 'ediff-overlayp (symbol-function 'extentp)) + (fset 'ediff-make-overlay (symbol-function 'make-extent)) + (fset 'ediff-delete-overlay (symbol-function 'delete-extent))) + (fset 'ediff-read-event (symbol-function 'read-event)) + (fset 'ediff-overlayp (symbol-function 'overlayp)) + (fset 'ediff-overlayp (symbol-function 'overlayp)) + (fset 'ediff-make-overlay (symbol-function 'make-overlay)) + (fset 'ediff-delete-overlay (symbol-function 'delete-overlay))) + +;; Check the current version against the major and minor version numbers +;; using op: cur-vers op major.minor If emacs-major-version or +;; emacs-minor-version are not defined, we assume that the current version +;; is hopelessly outdated. We assume that emacs-major-version and +;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the +;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value +;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be +;; incorrect. However, this gives correct result in our cases, since we are +;; testing for sufficiently high Emacs versions. +(defun ediff-check-version (op major minor &optional type-of-emacs) + (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version)) + (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p) + ((eq type-of-emacs 'emacs) ediff-emacs-p) + (t t)) + (cond ((eq op '=) (and (= emacs-minor-version minor) + (= emacs-major-version major))) + ((memq op '(> >= < <=)) + (and (or (funcall op emacs-major-version major) + (= emacs-major-version major)) + (if (= emacs-major-version major) + (funcall op emacs-minor-version minor) + t))) + (t + (error "%S: Invalid op in ediff-check-version" op)))) + (cond ((memq op '(= > >=)) nil) + ((memq op '(< <=)) t)))) + + +;;;; warn if it is a wrong version of emacs +;;(if (or (ediff-check-version '< 19 29 'emacs) +;; (ediff-check-version '< 19 12 'xemacs)) +;; (progn +;; (with-output-to-temp-buffer ediff-msg-buffer +;; (switch-to-buffer ediff-msg-buffer) +;; (insert +;; (format " +;; +;;This version of Ediff requires +;; +;;\t Emacs 19.29 and higher +;;\t OR +;;\t XEmacs 19.12 and higher +;; +;;It is unlikely to work under Emacs version %s +;;that you are using... " emacs-version)) +;; (if noninteractive +;; () +;; (beep 1) +;; (beep 1) +;; (insert "\n\nType any key to continue...") +;; (ediff-read-event))) +;; (kill-buffer ediff-msg-buffer))) + +;; A fix for NeXT Step +;; Should probably be eliminated in later versions. +(if (and (ediff-window-display-p) (eq (ediff-device-type) 'ns)) + (progn + (fset 'x-display-color-p (symbol-function 'ns-display-color-p)) + (fset 'x-color-defined-p (symbol-function 'ns-color-defined-p)) + (fset 'x-display-pixel-height (symbol-function 'ns-display-pixel-height)) + (fset 'x-display-pixel-width (symbol-function 'ns-display-pixel-width)) + )) + + +(defsubst ediff-color-display-p () + (if ediff-emacs-p + (x-display-color-p) + (eq (device-class (selected-device)) 'color))) + + +(if (ediff-has-face-support-p) + (if ediff-xemacs-p + (progn + (fset 'ediff-valid-color-p (symbol-function 'valid-color-name-p)) + (fset 'ediff-get-face (symbol-function 'get-face))) + ;; Temporary fix for OS/2 port of Emacs + ;; pm-win.el in PM-Emacs should be fixed. + (if (eq (ediff-device-type) 'pm) + (fset 'ediff-valid-color-p + (function (lambda (color) (assoc color pm-color-alist)))) + (fset 'ediff-valid-color-p (symbol-function 'x-color-defined-p))) + (fset 'ediff-get-face (symbol-function 'internal-get-face)))) + +(if (ediff-window-display-p) + (if ediff-xemacs-p + (progn + (fset 'ediff-display-pixel-width + (symbol-function 'device-pixel-width)) + (fset 'ediff-display-pixel-height + (symbol-function 'device-pixel-height))) + (fset 'ediff-display-pixel-width + (symbol-function 'x-display-pixel-width)) + (fset 'ediff-display-pixel-height + (symbol-function 'x-display-pixel-height)))) + + +(defun ediff-make-current-diff-overlay (type) + (if (ediff-has-face-support-p) + (let ((overlay (intern (format "ediff-current-diff-overlay-%S" type))) + (buffer (ediff-get-buffer type)) + (face (face-name + (symbol-value + (intern (format "ediff-current-diff-face-%S" type)))))) + (set overlay + (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer)) + (ediff-set-overlay-face (symbol-value overlay) face) + (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer)) + )) + +(defun ediff-set-overlay-face (extent face) + (ediff-overlay-put extent 'face face) + (ediff-overlay-put extent 'help-echo 'ediff-region-help-echo)) + +;; This does nothing in Emacs, since overlays there have no help-echo property +(defun ediff-region-help-echo (extent) + (let ((is-current (ediff-overlay-get extent 'ediff)) + (face (ediff-overlay-get extent 'face)) + (diff-num (ediff-overlay-get extent 'ediff-diff-num)) + face-help) + + ;; This happens only for refinement overlays + (setq face-help (and face (get face 'ediff-help-echo))) + + (cond ((and is-current diff-num) ; current diff region + (format "Difference region %S -- current" (1+ diff-num))) + (face-help) ; refinement of current diff region + (diff-num ; non-current + (format "Difference region %S -- non-current" (1+ diff-num))) + (t "")) ; none + )) + +(defun ediff-set-face (ground face color) + "Set face foreground/background." + (if (ediff-has-face-support-p) + (if (ediff-valid-color-p color) + (if (eq ground 'foreground) + (set-face-foreground face color) + (set-face-background face color)) + (cond ((memq face + '(ediff-current-diff-face-A + ediff-current-diff-face-B + ediff-current-diff-face-C + ediff-current-diff-face-Ancestor)) + (copy-face 'highlight face)) + ((memq face + '(ediff-fine-diff-face-A + ediff-fine-diff-face-B + ediff-fine-diff-face-C + ediff-fine-diff-face-Ancestor)) + (copy-face 'secondary-selection face) + (set-face-underline-p face t)) + ((memq face + '(ediff-even-diff-face-A + ediff-odd-diff-face-A + ediff-even-diff-face-B ediff-odd-diff-face-B + ediff-even-diff-face-C ediff-odd-diff-face-C + ediff-even-diff-face-Ancestor + ediff-odd-diff-face-Ancestor)) + (copy-face 'secondary-selection face)))) + )) + +(defun ediff-hide-face (face) + (if (and (ediff-has-face-support-p) ediff-emacs-p) + (add-to-list 'facemenu-unlisted-faces face))) + +(defvar ediff-current-diff-face-A + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-current-diff-face-A) + (ediff-hide-face 'ediff-current-diff-face-A) + (or (face-differs-from-default-p 'ediff-current-diff-face-A) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-current-diff-face-A "firebrick") + (ediff-set-face + 'background 'ediff-current-diff-face-A "pale green")) + (t + (if ediff-xemacs-p + (copy-face 'modeline 'ediff-current-diff-face-A) + (copy-face 'highlight 'ediff-current-diff-face-A)) + ))) + 'ediff-current-diff-face-A)) + "Face for highlighting the selected difference in buffer A.") + +(defvar ediff-current-diff-face-B + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-current-diff-face-B) + (ediff-hide-face 'ediff-current-diff-face-B) + (or (face-differs-from-default-p 'ediff-current-diff-face-B) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-current-diff-face-B "DarkOrchid") + (ediff-set-face + 'background 'ediff-current-diff-face-B "Yellow")) + (t + (if ediff-xemacs-p + (copy-face 'modeline 'ediff-current-diff-face-B) + (copy-face 'highlight 'ediff-current-diff-face-B)) + ))) + 'ediff-current-diff-face-B)) + "Face for highlighting the selected difference in buffer B.") + + +(defvar ediff-current-diff-face-C + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-current-diff-face-C) + (ediff-hide-face 'ediff-current-diff-face-C) + (or (face-differs-from-default-p 'ediff-current-diff-face-C) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-current-diff-face-C "Navy") + (ediff-set-face + 'background 'ediff-current-diff-face-C "Pink")) + (t + (if ediff-xemacs-p + (copy-face 'modeline 'ediff-current-diff-face-C) + (copy-face 'highlight 'ediff-current-diff-face-C)) + ))) + 'ediff-current-diff-face-C)) + "Face for highlighting the selected difference in buffer C.") + +(defvar ediff-current-diff-face-Ancestor + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-current-diff-face-Ancestor) + (ediff-hide-face 'ediff-current-diff-face-Ancestor) + (or (face-differs-from-default-p 'ediff-current-diff-face-Ancestor) + (copy-face + 'ediff-current-diff-face-C 'ediff-current-diff-face-Ancestor)))) + "Face for highlighting the selected difference in the ancestor buffer.") + +(defvar ediff-fine-diff-face-A + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-fine-diff-face-A) + (ediff-hide-face 'ediff-fine-diff-face-A) + (or (face-differs-from-default-p 'ediff-fine-diff-face-A) + (cond ((ediff-color-display-p) + (ediff-set-face 'foreground 'ediff-fine-diff-face-A + "Navy") + (ediff-set-face 'background 'ediff-fine-diff-face-A + "sky blue")) + (t (set-face-underline-p 'ediff-fine-diff-face-A t)))) + 'ediff-fine-diff-face-A)) + "Face for highlighting the refinement of the selected diff in buffer A.") + +(defvar ediff-fine-diff-face-B + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-fine-diff-face-B) + (ediff-hide-face 'ediff-fine-diff-face-B) + (or (face-differs-from-default-p 'ediff-fine-diff-face-B) + (cond ((ediff-color-display-p) + (ediff-set-face 'foreground 'ediff-fine-diff-face-B "Black") + (ediff-set-face 'background 'ediff-fine-diff-face-B "cyan")) + (t (set-face-underline-p 'ediff-fine-diff-face-B t)))) + 'ediff-fine-diff-face-B)) + "Face for highlighting the refinement of the selected diff in buffer B.") + +(defvar ediff-fine-diff-face-C + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-fine-diff-face-C) + (ediff-hide-face 'ediff-fine-diff-face-C) + (or (face-differs-from-default-p 'ediff-fine-diff-face-C) + (cond ((ediff-color-display-p) + (ediff-set-face 'foreground 'ediff-fine-diff-face-C "black") + (ediff-set-face + 'background 'ediff-fine-diff-face-C "Turquoise")) + (t (set-face-underline-p 'ediff-fine-diff-face-C t)))) + 'ediff-fine-diff-face-C)) + "Face for highlighting the refinement of the selected diff in buffer C.") + +(defvar ediff-fine-diff-face-Ancestor + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-fine-diff-face-Ancestor) + (ediff-hide-face 'ediff-fine-diff-face-Ancestor) + (or (face-differs-from-default-p 'ediff-fine-diff-face-Ancestor) + (copy-face + 'ediff-fine-diff-face-C 'ediff-fine-diff-face-Ancestor)))) + "Face highlighting refinements of the selected diff in ancestor buffer. +Presently, this is not used, as difference regions are not refined in the +ancestor buffer.") + +(defvar ediff-even-diff-face-A + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-even-diff-face-A) + (ediff-hide-face 'ediff-even-diff-face-A) + (or (face-differs-from-default-p 'ediff-even-diff-face-A) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-even-diff-face-A "black") + (ediff-set-face + 'background 'ediff-even-diff-face-A "light grey")) + (t + (copy-face 'italic 'ediff-even-diff-face-A)))) + 'ediff-even-diff-face-A)) + "Face used to highlight even-numbered differences in buffer A.") + +(defvar ediff-even-diff-face-B + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-even-diff-face-B) + (ediff-hide-face 'ediff-even-diff-face-B) + (or (face-differs-from-default-p 'ediff-even-diff-face-B) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-even-diff-face-B "White") + (ediff-set-face + 'background 'ediff-even-diff-face-B "Gray")) + (t + (copy-face 'italic 'ediff-even-diff-face-B)))) + 'ediff-even-diff-face-B)) + "Face used to highlight even-numbered differences in buffer B.") + +(defvar ediff-even-diff-face-C + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-even-diff-face-C) + (ediff-hide-face 'ediff-even-diff-face-C) + (or (face-differs-from-default-p 'ediff-even-diff-face-C) + (copy-face 'ediff-even-diff-face-A 'ediff-even-diff-face-C)) + 'ediff-even-diff-face-C)) + "Face used to highlight even-numbered differences in buffer C.") + +(defvar ediff-even-diff-face-Ancestor + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-even-diff-face-Ancestor) + (ediff-hide-face 'ediff-even-diff-face-Ancestor) + (or (face-differs-from-default-p 'ediff-even-diff-face-Ancestor) + (copy-face 'ediff-even-diff-face-C 'ediff-even-diff-face-Ancestor)) + 'ediff-even-diff-face-Ancestor)) + "Face highlighting even-numbered differences in the ancestor buffer.") + +(defvar ediff-odd-diff-face-A + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-odd-diff-face-A) + (ediff-hide-face 'ediff-odd-diff-face-A) + (or (face-differs-from-default-p 'ediff-odd-diff-face-A) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-odd-diff-face-A "White") + (ediff-set-face + 'background 'ediff-odd-diff-face-A "Gray")) + (t + (copy-face 'italic 'ediff-odd-diff-face-A)))) + 'ediff-odd-diff-face-A)) + "Face used to highlight odd-numbered differences in buffer A.") + +(defvar ediff-odd-diff-face-B + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-odd-diff-face-B) + (ediff-hide-face 'ediff-odd-diff-face-B) + (or (face-differs-from-default-p 'ediff-odd-diff-face-B) + (cond ((ediff-color-display-p) + (ediff-set-face + 'foreground 'ediff-odd-diff-face-B "Black") + (ediff-set-face + 'background 'ediff-odd-diff-face-B "light grey")) + (t + (copy-face 'italic 'ediff-odd-diff-face-B)))) + 'ediff-odd-diff-face-B)) + "Face used to highlight odd-numbered differences in buffer B.") + +(defvar ediff-odd-diff-face-C + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-odd-diff-face-C) + (ediff-hide-face 'ediff-odd-diff-face-C) + (or (face-differs-from-default-p 'ediff-odd-diff-face-C) + (copy-face 'ediff-odd-diff-face-A 'ediff-odd-diff-face-C)) + 'ediff-odd-diff-face-C)) + "Face used to highlight odd-numbered differences in buffer C.") + +(defvar ediff-odd-diff-face-Ancestor + (if (ediff-has-face-support-p) + (progn + (make-face 'ediff-odd-diff-face-Ancestor) + (ediff-hide-face 'ediff-odd-diff-face-Ancestor) + (or (face-differs-from-default-p 'ediff-odd-diff-face-Ancestor) + (copy-face 'ediff-odd-diff-face-C 'ediff-odd-diff-face-Ancestor)) + 'ediff-odd-diff-face-Ancestor)) + "Face used to highlight even-numbered differences in the ancestor buffer.") + +;; Help echo +(put 'ediff-fine-diff-face-A 'ediff-help-echo + "A `refinement' of the current difference region") +(put 'ediff-fine-diff-face-B 'ediff-help-echo + "A `refinement' of the current difference region") +(put 'ediff-fine-diff-face-C 'ediff-help-echo + "A `refinement' of the current difference region") +(put 'ediff-fine-diff-face-Ancestor 'ediff-help-echo + "A `refinement' of the current difference region") + + +;;; Overlays + +(ediff-defvar-local ediff-current-diff-overlay-A nil + "Overlay for the current difference region in buffer A.") +(ediff-defvar-local ediff-current-diff-overlay-B nil + "Overlay for the current difference region in buffer B.") +(ediff-defvar-local ediff-current-diff-overlay-C nil + "Overlay for the current difference region in buffer C.") +(ediff-defvar-local ediff-current-diff-overlay-Ancestor nil + "Overlay for the current difference region in the ancestor buffer.") + +;; Compute priority of ediff overlay. +(defun ediff-highest-priority (start end buffer) + (let ((pos (max 1 (1- start))) + ovr-list) + (if ediff-xemacs-p + (1+ ediff-shadow-overlay-priority) + (ediff-eval-in-buffer buffer + (while (< pos (min (point-max) (1+ end))) + (setq ovr-list (append (overlays-at pos) ovr-list)) + (setq pos (next-overlay-change pos))) + (1+ (apply '+ + (mapcar (function + (lambda (ovr) + (if ovr + (or (ediff-overlay-get ovr 'priority) 0) + 0))) + ovr-list) + )) + )))) + + +(defvar ediff-toggle-read-only-function nil + "*Specifies the function to be used to toggle read-only. +If nil, Ediff tries to deduce the function from the binding of C-x C-q. +Normally, this is the `toggle-read-only' function, but, if version +control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.") + + +;;; Misc + +;; if nil, this silences some messages +(defconst ediff-verbose-p t) + +(defvar ediff-no-emacs-help-in-control-buffer nil + "*Non-nil means C-h should not invoke Emacs help in control buffer. +Instead, C-h jumps to previous difference.") + +(defvar ediff-temp-file-prefix + (let ((env (or (getenv "TMPDIR") + (getenv "TMP") + (getenv "TEMP"))) + d) + (setq d (if (and env (> (length env) 0)) + env + (cond ((memq system-type '(vax-vms axp-vms)) "SYS$SCRATCH:") + ((eq system-type 'ms-dos) "c:/") + (t "/tmp")))) + ;; The following is to make sure we get something to which we can + ;; add directory levels on VMS. + (setq d (file-name-as-directory (directory-file-name d))) + ) + "*Prefix to put on Ediff temporary file names. +Do not start with `~/' or `~user-name/'.") + +(defvar ediff-temp-file-mode 384 ; u=rw only + "*Mode for Ediff temporary files.") + +;; Metacharacters that have to be protected from the shell when executing +;; a diff/diff3 command. +(defvar ediff-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]" + "Characters that must be quoted with \\ when used in a shell command line. +More precisely, a regexp to match any one such character.") + +;; needed to simulate frame-char-width in XEmacs. +(defvar ediff-H-glyph (if ediff-xemacs-p (make-glyph "H"))) + + +(ediff-defvar-local ediff-temp-file-A nil + "Temporary file used for refining difference regions in buffer A.") +(ediff-defvar-local ediff-temp-file-B nil + "Temporary file used for refining difference regions in buffer B.") +(ediff-defvar-local ediff-temp-file-C nil + "Temporary file used for refining difference regions in buffer C.") + +;;; In-line functions + +(defsubst ediff-file-remote-p (file-name) + (if (fboundp ediff-ange-ftp-ftp-name) + (funcall ediff-ange-ftp-ftp-name file-name))) + + +(defsubst ediff-frame-unsplittable-p (frame) + (cdr (assq 'unsplittable (frame-parameters frame)))) + +(defsubst ediff-get-next-window (wind prev-wind) + (or (window-live-p wind) + (setq wind (if prev-wind + (next-window wind) + (selected-window))))) + + +(defsubst ediff-kill-buffer-carefully (buf) + "Kill buffer BUF if it exists." + (if (ediff-buffer-live-p buf) + (kill-buffer (get-buffer buf)))) + + +(defsubst ediff-highlight-diff (n) + "Put face on diff N. Invoked for X displays only." + (ediff-highlight-diff-in-one-buffer n 'A) + (ediff-highlight-diff-in-one-buffer n 'B) + (ediff-highlight-diff-in-one-buffer n 'C) + (ediff-highlight-diff-in-one-buffer n 'Ancestor) + ) + + +(defsubst ediff-unhighlight-diff () + "Remove overlays from buffers A, B, and C." + (ediff-unhighlight-diff-in-one-buffer 'A) + (ediff-unhighlight-diff-in-one-buffer 'B) + (ediff-unhighlight-diff-in-one-buffer 'C) + (ediff-unhighlight-diff-in-one-buffer 'Ancestor) + ) + +;; delete highlighting overlays, restore faces to their original form +(defsubst ediff-unhighlight-diffs-totally () + (ediff-unhighlight-diffs-totally-in-one-buffer 'A) + (ediff-unhighlight-diffs-totally-in-one-buffer 'B) + (ediff-unhighlight-diffs-totally-in-one-buffer 'C) + (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor) + ) + +(defsubst ediff-background-face (buf-type dif-num) + ;; The value of dif-num is always 1- the one that user sees. + ;; This is why even face is used when dif-num is odd. + (intern (format (if (ediff-odd-p dif-num) + "ediff-even-diff-face-%S" + "ediff-odd-diff-face-%S") + buf-type))) + + +;; arg is a record for a given diff in a difference vector +;; this record is itself a vector +(defsubst ediff-clear-fine-diff-vector (diff-record) + (if diff-record + (mapcar 'ediff-delete-overlay + (ediff-get-fine-diff-vector-from-diff-record diff-record)))) + +(defsubst ediff-clear-fine-differences-in-one-buffer (n buf-type) + (ediff-clear-fine-diff-vector (ediff-get-difference n buf-type)) + (ediff-set-fine-diff-vector n buf-type nil)) + +(defsubst ediff-clear-fine-differences (n) + (ediff-clear-fine-differences-in-one-buffer n 'A) + (ediff-clear-fine-differences-in-one-buffer n 'B) + (if ediff-3way-job + (ediff-clear-fine-differences-in-one-buffer n 'C))) + + +(defsubst ediff-convert-fine-diffs-to-overlays (diff-list region-num) + (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num) + (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num) + (if ediff-3way-job + (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num) + )) + +(defsubst ediff-mouse-event-p (event) + (if ediff-xemacs-p + (button-event-p event) + (string-match "mouse" (format "%S" (event-basic-type event))) + )) + + +(defsubst ediff-key-press-event-p (event) + (if ediff-xemacs-p + (key-press-event-p event) + (or (char-or-string-p event) (symbolp event)))) + +(defun ediff-event-point (event) + (cond ((ediff-mouse-event-p event) + (if ediff-xemacs-p + (event-point event) + (posn-point (event-start event)))) + ((ediff-key-press-event-p event) + (point)) + (t (error)))) + +(defun ediff-event-buffer (event) + (cond ((ediff-mouse-event-p event) + (if ediff-xemacs-p + (event-buffer event) + (window-buffer (posn-window (event-start event))))) + ((ediff-key-press-event-p event) + (current-buffer)) + (t (error)))) + + +(defsubst ediff-frame-iconified-p (frame) + (if (and (ediff-window-display-p) (frame-live-p frame)) + (if ediff-xemacs-p + (frame-iconified-p frame) + (eq (frame-visible-p frame) 'icon)))) + +(defsubst ediff-window-visible-p (wind) + ;; under TTY, window-live-p also means window is visible + (and (window-live-p wind) + (or (not (ediff-window-display-p)) + (frame-visible-p (window-frame wind))))) + + +(defsubst ediff-frame-char-width (frame) + (if ediff-xemacs-p + (/ (frame-pixel-width frame) (frame-width frame)) + (frame-char-width frame))) + +(defun ediff-reset-mouse (&optional frame do-not-grab-mouse) + (or frame (setq frame (selected-frame))) + (if (ediff-window-display-p) + (let ((frame-or-wind frame)) + (if ediff-xemacs-p + (setq frame-or-wind (frame-selected-window frame))) + (or do-not-grab-mouse + ;; don't set mouse if the user said to never do this + (not ediff-grab-mouse) + ;; Don't grab on quit, if the user doesn't want to. + ;; If ediff-grab-mouse = t, then mouse won't be grabbed for + ;; sessions that are not part of a group (this is done in + ;; ediff-recenter). The condition below affects only terminating + ;; sessions in session groups (in which case mouse is warped into + ;; a meta buffer). + (and (eq ediff-grab-mouse 'maybe) + (memq this-command '(ediff-quit ediff-update-diffs))) + (set-mouse-position frame-or-wind 1 0)) + ))) + +(defsubst ediff-spy-after-mouse () + (setq ediff-mouse-pixel-position (mouse-pixel-position))) + +;; It is not easy to find out when the user grabs the mouse, since emacs and +;; xemacs behave differently when mouse is not in any frame. Also, this is +;; sensitive to when the user grabbed mouse. Not used for now. +(defun ediff-user-grabbed-mouse () + (if ediff-mouse-pixel-position + (cond ((not (eq (car ediff-mouse-pixel-position) + (car (mouse-pixel-position))))) + ((and (car (cdr ediff-mouse-pixel-position)) + (car (cdr (mouse-pixel-position))) + (cdr (cdr ediff-mouse-pixel-position)) + (cdr (cdr (mouse-pixel-position)))) + (not (and (< (abs (- (car (cdr ediff-mouse-pixel-position)) + (car (cdr (mouse-pixel-position))))) + ediff-mouse-pixel-threshold) + (< (abs (- (cdr (cdr ediff-mouse-pixel-position)) + (cdr (cdr (mouse-pixel-position))))) + ediff-mouse-pixel-threshold)))) + (t nil)))) + +(defsubst ediff-frame-char-height (frame) + (if ediff-xemacs-p + (glyph-height ediff-H-glyph (selected-window frame)) + (frame-char-height frame))) + + +(defsubst ediff-empty-overlay-p (overl) + (= (ediff-overlay-start overl) (ediff-overlay-end overl))) + +;; like overlay-buffer in Emacs. In XEmacs, returns nil if the extent is +;; dead. Otherwise, works like extent-buffer +(defun ediff-overlay-buffer (overl) + (if ediff-emacs-p + (overlay-buffer overl) + (and (extent-live-p overl) (extent-object overl)))) + +;; like overlay-get in Emacs. In XEmacs, returns nil if the extent is +;; dead. Otherwise, like extent-property +(defun ediff-overlay-get (overl property) + (if ediff-emacs-p + (overlay-get overl property) + (and (extent-live-p overl) (extent-property overl property)))) + +;; t if diff region is empty. +;; In case of buffer C, t also if it is not a 3way +;; comparison job (merging jobs return t as well). +(defun ediff-empty-diff-region-p (n buf-type) + (if (eq buf-type 'C) + (or (not ediff-3way-comparison-job) + (= (ediff-get-diff-posn 'C 'beg n) + (ediff-get-diff-posn 'C 'end n))) + (= (ediff-get-diff-posn buf-type 'beg n) + (ediff-get-diff-posn buf-type 'end n)))) + +;; Test if diff region is white space only. +;; If 2-way job and buf-type = C, then returns t. +(defun ediff-whitespace-diff-region-p (n buf-type) + (or (and (eq buf-type 'C) (not ediff-3way-job)) + (ediff-empty-diff-region-p n buf-type) + (let ((beg (ediff-get-diff-posn buf-type 'beg n)) + (end (ediff-get-diff-posn buf-type 'end n))) + (ediff-eval-in-buffer (ediff-get-buffer buf-type) + (save-excursion + (goto-char beg) + (skip-chars-forward ediff-whitespace) + (>= (point) end)))))) + +;; temporarily uses DIR to abbreviate file name +;; if DIR is nil, use default-directory +(defun ediff-abbreviate-file-name (file &optional dir) + (cond ((stringp dir) + (let ((directory-abbrev-alist (list (cons dir "")))) + (abbreviate-file-name file))) + (ediff-emacs-p (abbreviate-file-name file)) + (t ; XEmacs requires addl argument + (abbreviate-file-name file t)))) + +;; Takes a directory and returns the parent directory. +;; does nothing to `/'. If the ARG is a regular file, +;; strip the file AND the last dir. +(defun ediff-strip-last-dir (dir) + (if (not (stringp dir)) (setq dir default-directory)) + (setq dir (expand-file-name dir)) + (or (file-directory-p dir) (setq dir (file-name-directory dir))) + (let* ((pos (1- (length dir))) + (last-char (aref dir pos))) + (if (and (> pos 0) (= last-char ?/)) + (setq dir (substring dir 0 pos))) + (ediff-abbreviate-file-name (file-name-directory dir)))) + +(defun ediff-truncate-string-left (str newlen) + ;; leave space for ... on the left + (let ((len (length str)) + substr) + (if (<= len newlen) + str + (setq newlen (max 0 (- newlen 3))) + (setq substr (substring str (max 0 (- len 1 newlen)))) + (concat "..." substr)))) + +(defun ediff-abbrev-jobname (jobname) + (cond ((eq jobname 'ediff-directories) + "Compare two directories") + ((eq jobname 'ediff-files) + "Compare two files") + ((eq jobname 'ediff-buffers) + "Compare two buffers") + ((eq jobname 'ediff-directories3) + "Compare three directories") + ((eq jobname 'ediff-files3) + "Compare three files") + ((eq jobname 'ediff-buffers3) + "Compare three buffers") + ((eq jobname 'ediff-revision) + "Compare file with a version") + ((eq jobname 'ediff-directory-revisions) + "Compare dir files with versions") + ((eq jobname 'ediff-merge-directory-revisions) + "Merge dir files with versions") + ((eq jobname 'ediff-merge-directory-revisions-with-ancestor) + "Merge dir versions via ancestors") + (t + (let* ((str (substring (symbol-name jobname) 6)) + (len (length str)) + (pos 0)) + (while (< pos len) + (if (= pos 0) + (aset str pos (upcase (aref str pos)))) + (if (= (aref str pos) ?-) + (aset str pos ?\ )) + (setq pos (1+ pos))) + str)))) + + + +(defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end) + (ediff-eval-in-buffer + (ediff-eval-in-buffer ctrl-buf (ediff-get-buffer buf-type)) + (buffer-substring + (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf)) + (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf))))) + +;; If ediff modified mode line, strip the modification +(defsubst ediff-strip-mode-line-format () + (if (member (car mode-line-format) '(" A: " " B: " " C: " " Ancestor: ")) + (setq mode-line-format (nth 2 mode-line-format)))) + +;; Verify that we have a difference selected. +(defsubst ediff-valid-difference-p (&optional n) + (or n (setq n ediff-current-difference)) + (and (>= n 0) (< n ediff-number-of-differences))) + +(defsubst ediff-show-all-diffs (n) + "Don't skip difference regions." + nil) + +(defsubst Xor (a b) + (or (and a (not b)) (and (not a) b))) + +(defsubst ediff-message-if-verbose (string &rest args) + (if ediff-verbose-p + (apply 'message string args))) + +(defun ediff-file-attributes (filename attr-number) + (let ((handler (find-file-name-handler filename 'find-file-noselect))) + (if (and handler (string-match "ange-ftp" (format "%S" handler))) + -1 + (nth attr-number (file-attributes filename))))) +(defsubst ediff-file-size (filename) + (ediff-file-attributes filename 7)) +(defsubst ediff-file-modtime (filename) + (ediff-file-attributes filename 5)) + + + + + +(provide 'ediff-init) + + +;;; ediff-init.el ends here