1 ;;; pcvs-parse.el --- the CVS output parser
3 ;; Copyright (C) 1991,92,93,94,95,96,97,98,99,2000,02,2003
4 ;; Free Software Foundation, Inc.
6 ;; Author: Stefan Monnier <monnier@cs.yale.edu>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 ;; - when merging a modified file, if the merge says that the file already
31 ;; contained in the changes, it marks the file as `up-to-date' although
32 ;; it might still contain further changes.
33 ;; Example: merging a zero-change commit.
37 (eval-when-compile (require 'cl
))
42 ;; imported from pcvs.el
43 (defvar cvs-execute-single-dir
)
47 (defcustom cvs-update-prog-output-skip-regexp
"$"
48 "*A regexp that matches the end of the output from all cvs update programs.
49 That is, output from any programs that are run by CVS (by the flag -u
50 in the `modules' file - see cvs(5)) when `cvs update' is performed should
51 terminate with a line that this regexp matches. It is enough that
52 some part of the line is matched.
54 The default (a single $) fits programs without output."
56 :type
'(regexp :value
"$"))
58 (defcustom cvs-parse-ignored-messages
59 '("Executing ssh-askpass to query the password.*$"
60 ".*Remote host denied X11 forwarding.*$")
61 "*A list of regexps matching messages that should be ignored by the parser.
62 Each regexp should match a whole set of lines and should hence be terminated
65 :type
'(repeat regexp
))
67 ;; a few more defvars just to shut up the compiler
69 (defvar cvs-current-dir
)
70 (defvar cvs-current-subdir
)
71 (defvar dont-change-disc
)
75 (defconst cvs-parse-known-commands
76 '("status" "add" "commit" "update" "remove" "checkout" "ci")
77 "List of CVS commands whose output is understood by the parser.")
79 (defun cvs-parse-buffer (parse-spec dont-change-disc
&optional subdir
)
80 "Parse current buffer according to PARSE-SPEC.
81 PARSE-SPEC is a function of no argument advancing the point and returning
82 either a fileinfo or t (if the matched text should be ignored) or
83 nil if it didn't match anything.
84 DONT-CHANGE-DISC just indicates whether the command was changing the disc
85 or not (useful to tell the difference between `cvs-examine' and `cvs-update'
87 The path names should be interpreted as relative to SUBDIR (defaults
88 to the `default-directory').
89 Return a list of collected entries, or t if an error occurred."
90 (goto-char (point-min))
93 (case-fold-search nil
)
94 (cvs-current-subdir (or subdir
"")))
95 (while (not (or (eobp) (eq fileinfos t
)))
96 (let ((ret (cvs-parse-run-table parse-spec
)))
98 ;; it matched a known information message
99 ((cvs-fileinfo-p ret
) (push ret fileinfos
))
100 ;; it didn't match anything at all (impossible)
101 ((and (consp ret
) (cvs-fileinfo-p (car ret
)))
102 (setq fileinfos
(append ret fileinfos
)))
103 ((null ret
) (setq fileinfos t
))
104 ;; it matched something that should be ignored
106 (nreverse fileinfos
)))
109 ;; All those parsing macros/functions should return a success indicator
110 (defsubst cvs-parse-msg
() (buffer-substring cvs-start
(1- (point))))
112 ;;(defsubst COLLECT (exp) (push exp *result*))
113 ;;(defsubst PROG (e) t)
114 ;;(defmacro SEQ (&rest seqs) (cons 'and seqs))
116 (defmacro cvs-match
(re &rest matches
)
117 "Try to match RE and extract submatches.
118 If RE matches, advance the point until the line after the match and
119 then assign the variables as specified in MATCHES (via `setq')."
121 (cons re
(mapcar (lambda (match)
122 `(cons ',(first match
) ,(second match
)))
125 (defun cvs-do-match (re &rest matches
)
126 "Internal function for the `cvs-match' macro.
127 Match RE and if successful, execute MATCHES."
129 (when (looking-at re
)
130 (goto-char (match-end 0))
131 ;; Skip the newline (unless we already are at the end of the buffer).
132 (when (and (eolp) (< (point) (point-max))) (forward-char))
133 ;; assign the matches
134 (dolist (match matches t
)
135 (let ((val (cdr match
)))
136 (set (car match
) (if (integerp val
) (match-string val
) val
))))))
138 (defmacro cvs-or
(&rest alts
)
139 "Try each one of the ALTS alternatives until one matches."
140 `(let ((-cvs-parse-point (point)))
143 `(or ,es
(ignore (goto-char -cvs-parse-point
))))
145 (def-edebug-spec cvs-or t
)
147 ;; This is how parser tables should be executed
148 (defun cvs-parse-run-table (parse-spec)
149 "Run PARSE-SPEC and provide sensible default behavior."
150 (unless (bolp) (forward-line 1)) ;this should never be needed
151 (let ((cvs-start (point)))
155 (dolist (re cvs-parse-ignored-messages
)
156 (when (cvs-match re
) (return t
)))
158 ;; This is a parse error. Create a message-type fileinfo.
161 (cvs-create-fileinfo 'MESSAGE cvs-current-dir
" "
162 ;; (concat " Unknown msg: '"
163 (cvs-parse-msg) ;; "'")
167 (defun cvs-parsed-fileinfo (type path
&optional directory
&rest keys
)
169 TYPE can either be a type symbol or a cons of the form (TYPE . SUBTYPE).
170 PATH is the filename.
171 DIRECTORY influences the way PATH is interpreted:
172 - if it's a string, it denotes the directory in which PATH (which should then be
173 a plain file name with no directory component) resides.
174 - if it's nil, the PATH should not be trusted: if it has a directory
175 component, use it, else, assume it is relative to the current directory.
176 - else, the PATH should be trusted to be relative to the root
177 directory (i.e. if there is no directory component, it means the file
178 is inside the main directory).
179 The remaining KEYS are passed directly to `cvs-create-fileinfo'."
180 (let ((dir directory
)
182 ;; only trust the directory if it's a string
183 (unless (stringp directory
)
184 ;; else, if the directory is true, the path should be trusted
185 (setq dir
(or (file-name-directory path
) (if directory
"")))
186 (setq file
(file-name-nondirectory path
)))
188 (let ((type (if (consp type
) (car type
) type
))
189 (subtype (if (consp type
) (cdr type
))))
190 (when dir
(setq cvs-current-dir dir
))
191 (apply 'cvs-create-fileinfo type
192 (concat cvs-current-subdir
(or dir cvs-current-dir
))
193 file
(cvs-parse-msg) :subtype subtype keys
))))
195 ;;;; CVS Process Parser Tables:
197 ;;;; The table for status and update could actually be merged since they
198 ;;;; don't conflict. But they don't overlap much either.
200 (defun cvs-parse-table ()
201 "Table of message objects for `cvs-parse-process'."
202 (let (c file dir path base-rev subtype
)
209 ;; this is not necessary because the fileinfo merging will remove
210 ;; such duplicate info and luckily the second info is the one we want.
211 ;; (and (cvs-match "M \\(.*\\)$" (path 1))
212 ;; (cvs-parse-merge path))
214 ;; Normal file state indicator.
216 (cvs-match "\\([MARCUPNJ?]\\) \\(.*\\)$" (c 1) (path 2))
217 ;; M: The file is modified by the user, and untouched in the repository.
218 ;; A: The file is "cvs add"ed, but not "cvs ci"ed.
219 ;; R: The file is "cvs remove"ed, but not "cvs ci"ed.
221 ;; U: The file is copied from the repository.
222 ;; P: The file was patched from the repository.
224 (let ((code (aref c
0)))
232 (if (not dont-change-disc
) 'CONFLICT
233 ;; This is ambiguous. We should look for conflict markers in the
234 ;; file to decide between CONFLICT and NEED-MERGE. With CVS-1.10
235 ;; servers, this should not be necessary, because they return
236 ;; a complete merge output.
238 (insert-file-contents path
)
239 (goto-char (point-min))
240 (if (re-search-forward "^<<<<<<< " nil t
)
241 'CONFLICT
'NEED-MERGE
))))
242 (?J
'NEED-MERGE
) ;not supported by standard CVS
244 (if dont-change-disc
'NEED-UPDATE
245 (cons 'UP-TO-DATE
(if (eq code ?U
) 'UPDATED
'PATCHED
)))))
249 (cvs-match "pcl-cvs: descending directory \\(.*\\)$" (dir 1))
250 (setq cvs-current-subdir dir
))
252 ;; A special cvs message
254 (let ((case-fold-search t
))
255 (cvs-match "cvs[.a-z]* [a-z]+: "))
258 ;; CVS is descending a subdirectory
259 ;; (status says `examining' while update says `updating')
261 (cvs-match "\\(Examining\\|Updating\\) \\(.*\\)$" (dir 2))
262 (let ((dir (if (string= "." dir
) "" (file-name-as-directory dir
))))
263 (cvs-parsed-fileinfo 'DIRCHANGE
"." dir
)))
265 ;; [-n update] A new (or pruned) directory appeared but isn't traversed
267 (cvs-match "New directory `\\(.*\\)' -- ignored$" (dir 1))
268 ;; (cvs-parsed-fileinfo 'MESSAGE " " (file-name-as-directory dir))
269 ;; These messages either correspond to a true new directory
270 ;; that an update will bring in, or to a directory that's empty
271 ;; on the current branch (either because it only exists in other
272 ;; branches, or because it's been removed).
275 (find-file-noselect (expand-file-name
276 ".cvsignore" (file-name-directory dir
)))
277 (goto-char (point-min))
279 (concat "^" (regexp-quote (file-name-nondirectory dir
)) "/$")
281 t
;The user requested to ignore those messages.
282 (cvs-parsed-fileinfo '(NEED-UPDATE . NEW-DIR
) dir t
)))
284 ;; File removed, since it is removed (by third party) in repository.
287 (cvs-match "warning: \\(.*\\) is not (any longer) pertinent$" (file 1))
288 (cvs-match "\\(.*\\) is no longer in the repository$" (file 1)))
290 (if dont-change-disc
'(NEED-UPDATE . REMOVED
) 'DEAD
) file
))
295 (cvs-match "scheduling file `\\(.*\\)' for addition.*$" (path 1))
296 (cvs-match "re-adding file \\(.*\\) (in place of .*)$" (path 1)))
297 (cvs-parsed-fileinfo 'ADDED path
))
299 ;; [add] this will also show up as a `U <file>'
301 (cvs-match "\\(.*\\), version \\(.*\\), resurrected$"
302 (path 1) (base-rev 2))
303 ;; FIXME: resurrection only brings back the original version,
304 ;; not the latest on the branch, so `up-to-date' is not always
306 (cvs-parsed-fileinfo '(UP-TO-DATE . RESURRECTED
) path nil
311 (cvs-match "removed `\\(.*\\)'$" (path 1))
312 (cvs-parsed-fileinfo 'DEAD path
))
316 (cvs-match "scheduling `\\(.*\\)' for removal$" (file 1))
317 (cvs-parsed-fileinfo 'REMOVED file
))
319 ;; [update] File removed by you, but not cvs rm'd
321 (cvs-match "warning: \\(.*\\) was lost$" (path 1))
322 (cvs-match (concat "U " (regexp-quote path
) "$"))
323 (cvs-parsed-fileinfo (if dont-change-disc
325 '(UP-TO-DATE . UPDATED
))
328 ;; Mode conflicts (rather than contents)
330 (cvs-match "conflict: ")
332 (cvs-match "removed \\(.*\\) was modified by second party$"
333 (path 1) (subtype 'REMOVED
))
334 (cvs-match "\\(.*\\) created independently by second party$"
335 (path 1) (subtype 'ADDED
))
336 (cvs-match "\\(.*\\) is modified but no longer in the repository$"
337 (path 1) (subtype 'MODIFIED
)))
338 (cvs-match (concat "C " (regexp-quote path
)))
339 (cvs-parsed-fileinfo (cons 'CONFLICT subtype
) path
))
341 ;; Messages that should be shown to the user
344 (cvs-match "move away \\(.*\\); it is in the way$" (file 1))
345 (cvs-match "warning: new-born \\(.*\\) has disappeared$" (file 1))
346 (cvs-match "sticky tag .* for file `\\(.*\\)' is not a branch$"
348 (cvs-parsed-fileinfo 'MESSAGE file
))
351 (and (cvs-match "use `.+ add' to create an entry for \\(.*\\)$" (path 1))
352 (cvs-parsed-fileinfo 'UNKNOWN path
))
355 (and (cvs-match "Up-to-date check failed for `\\(.+\\)'$" (file 1))
356 (cvs-parsed-fileinfo 'NEED-MERGE file
))
358 ;; We use cvs-execute-multi-dir but cvs can't handle it
359 ;; Probably because the cvs-client can but the cvs-server can't
360 (and (cvs-match ".* files with '?/'? in their name.*$")
361 (not cvs-execute-single-dir
)
362 (setq cvs-execute-single-dir t
)
365 "*** Add (setq cvs-execute-single-dir t) to your .emacs ***
366 See the FAQ file or the variable's documentation for more info."))
368 ;; Cvs waits for a lock. Ignored: already handled by the process filter
369 (cvs-match "\\[..:..:..\\] \\(waiting for\\|obtained\\) .*lock in .*$")
370 ;; File you removed still exists. Ignore (will be noted as removed).
371 (cvs-match ".* should be removed and is still there$")
373 (cvs-match "use '.+ commit' to \\sw+ th\\sw+ files? permanently$")
374 ;; [add,status] followed by a more complete status description anyway
375 (and (cvs-match "nothing known about \\(.*\\)$" (path 1))
376 (cvs-parsed-fileinfo 'DEAD path
'trust
))
377 ;; [update] problem with patch
378 (cvs-match "checksum failure after patch to .*; will refetch$")
379 (cvs-match "refetching unpatchable files$")
381 (cvs-match "Rebuilding administrative file database$")
383 (cvs-match "--> Using per-directory sticky tag `.*'")
385 ;; CVS is running a *info program.
387 (cvs-match "Executing.*$")
388 ;; Skip by any output the program may generate to stdout.
389 ;; Note that pcl-cvs will get seriously confused if the
390 ;; program prints anything to stderr.
391 (re-search-forward cvs-update-prog-output-skip-regexp
))))
394 (cvs-match "cvs[.ex]* \\[[a-z]+ aborted\\]:.*$")
395 (cvs-parsed-fileinfo 'MESSAGE
""))
397 ;; sadly you can't do much with these since the path is in the repository
398 (cvs-match "Directory .* added to the repository$")
402 (defun cvs-parse-merge ()
403 (let (path base-rev head-rev type
)
404 ;; A merge (maybe with a conflict).
406 (cvs-match "RCS file: .*$")
407 ;; Squirrel away info about the files that were retrieved for merging
408 (cvs-match "retrieving revision \\([0-9.]+\\)$" (base-rev 1))
409 (cvs-match "retrieving revision \\([0-9.]+\\)$" (head-rev 1))
410 (cvs-match "Merging differences between [0-9.]+ and [0-9.]+ into \\(.*\\)$"
413 ;; eat up potential conflict warnings
414 (cvs-or (cvs-match "\\(rcs\\)?merge:?\\( warning\\)?: \\(overlaps\\|conflicts\\) \\(or other problems \\)?during merge$" (type 'CONFLICT
)) t
)
417 (cvs-match "cvs[.ex]* [a-z]+: ")
419 (cvs-match "conflicts found in \\(.*\\)$" (path 1) (type 'CONFLICT
))
420 (cvs-match "could not merge .*$")
421 (cvs-match "restoring \\(.*\\) from backup file .*$" (path 1))))
424 ;; Is it a succesful merge?
425 ;; Figure out result of merging (ie, was there a conflict?)
426 (let ((qfile (regexp-quote path
)))
430 (cvs-match (concat "C \\(.*" qfile
"\\)$") (path 1) (type 'CONFLICT
))
431 ;; C might be followed by a "suprious" U for non-mergeable files
432 (cvs-or (cvs-match (concat "U \\(.*" qfile
"\\)$")) t
))
434 (cvs-match (concat "M \\(.*" qfile
"\\)$") (path 1))
435 ;; The file already contained the modifications
436 (cvs-match (concat "^\\(.*" qfile
437 "\\) already contains the differences between .*$")
438 (path 1) (type '(UP-TO-DATE . MERGED
)))
440 ;; FIXME: PATH might not be set yet. Sometimes the only path
441 ;; information is in `RCS file: ...' (yuck!!).
442 (cvs-parsed-fileinfo (if dont-change-disc
'NEED-MERGE
443 (or type
'(MODIFIED . MERGED
))) path nil
444 :merge
(cons base-rev head-rev
))))))
446 (defun cvs-parse-status ()
447 (let (nofile path base-rev head-rev type
)
450 "===================================================================$")
451 (cvs-match "File: \\(no file \\)?\\(.*[^ \t]\\)[ \t]+Status: "
454 (cvs-match "Needs \\(Checkout\\|Patch\\)$"
455 (type (if nofile
'MISSING
'NEED-UPDATE
)))
456 (cvs-match "Up-to-date$"
457 (type (if nofile
'(UP-TO-DATE . REMOVED
) 'UP-TO-DATE
)))
458 (cvs-match "File had conflicts on merge$" (type 'MODIFIED
))
459 (cvs-match ".*[Cc]onflict.*$" (type 'CONFLICT
))
460 (cvs-match "Locally Added$" (type 'ADDED
))
461 (cvs-match "Locally Removed$" (type 'REMOVED
))
462 (cvs-match "Locally Modified$" (type 'MODIFIED
))
463 (cvs-match "Needs Merge$" (type 'NEED-MERGE
))
464 (cvs-match "Entry Invalid" (type '(NEED-MERGE . REMOVED
)))
465 (cvs-match "Unknown$" (type 'UNKNOWN
)))
468 (cvs-match " *Version:[ \t]*\\([0-9.]+\\).*$" (base-rev 1))
469 ;; NOTE: there's no date on the end of the following for server mode...
470 (cvs-match " *Working revision:[ \t]*-?\\([0-9.]+\\).*$" (base-rev 1))
471 ;; Let's not get all worked up if the format changes a bit
472 (cvs-match " *Working revision:.*$"))
474 (cvs-match " *RCS Version:[ \t]*\\([0-9.]+\\)[ \t]*.*$" (head-rev 1))
475 (cvs-match " *Repository revision:[ \t]*\\([0-9.]+\\)[ \t]*\\(.*\\)$"
477 (cvs-match " *Repository revision:.*"))
479 (and;;sometimes those fields are missing
480 (cvs-match " *Sticky Tag:[ \t]*\\(.*\\)$") ; FIXME: use it
481 (cvs-match " *Sticky Date:[ \t]*\\(.*\\)$") ; FIXME: use it
482 (cvs-match " *Sticky Options:[ \t]*\\(.*\\)$")) ; FIXME: use it
485 ;; ignore the tags-listing in the case of `status -v'
486 (cvs-or (cvs-match " *Existing Tags:\n\\(\t.*\n\\)*$") t
)
487 (cvs-parsed-fileinfo type path nil
489 :head-rev head-rev
))))
491 (defun cvs-parse-commit ()
492 (let (path base-rev subtype
)
496 (cvs-match "\\(Checking in\\|Removing\\) \\(.*\\);$" (path 2))
497 (cvs-match ".*,v <-- .*$")
500 (cvs-match "new revision: delete; previous revision: \\([0-9.]*\\)$"
501 (subtype 'REMOVED
) (base-rev 1))
503 (cvs-match "initial revision: \\([0-9.]*\\)$"
504 (subtype 'ADDED
) (base-rev 1))
506 (cvs-match "new revision: \\([0-9.]*\\); previous revision: .*$"
507 (subtype 'COMMITTED
) (base-rev 1)))
510 ;; Try to remove the temp files used by VC.
511 (vc-delete-automatic-version-backups (expand-file-name path
))
512 ;; it's important here not to rely on the default directory management
513 ;; because `cvs commit' might begin by a series of Examining messages
514 ;; so the processing of the actual checkin messages might begin with
515 ;; a `current-dir' set to something different from ""
516 (cvs-parsed-fileinfo (cons 'UP-TO-DATE subtype
) path
'trust
517 :base-rev base-rev
)))
519 ;; useless message added before the actual addition: ignored
520 (cvs-match "RCS file: .*\ndone$"))))
523 (provide 'pcvs-parse
)
525 ;;; pcvs-parse.el ends here