Merge spelling fixes

contrib/mercurial.el

@@ -1,1293 +1,1293 b''
 ;;; mercurial.el --- Emacs support for the Mercurial distributed SCM
 
 ;; Copyright (C) 2005, 2006 Bryan O'Sullivan
 
 ;; Author: Bryan O'Sullivan <[e-mail]>
 
 ;; mercurial.el is free software; you can redistribute it and/or
 ;; modify it under the terms of the GNU General Public License version
 ;; 2 or any later version.
 
 ;; mercurial.el 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 mercurial.el, GNU Emacs, or XEmacs; see the file COPYING
 ;; (`C-h C-l').  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;; mercurial.el builds upon Emacs's VC mode to provide flexible
 ;; integration with the Mercurial distributed SCM tool.
 
 ;; To get going as quickly as possible, load mercurial.el into Emacs and
 ;; type `C-c h h'; this runs hg-help-overview, which prints a helpful
 ;; usage overview.
 
 ;; Much of the inspiration for mercurial.el comes from Rajesh
 ;; Vaidheeswarran's excellent p4.el, which does an admirably thorough
 ;; job for the commercial Perforce SCM product.  In fact, substantial
 ;; chunks of code are adapted from p4.el.
 
 ;; This code has been developed under XEmacs 21.5, and may not work as
 ;; well under GNU Emacs (albeit tested under 21.4).  Patches to
 ;; enhance the portability of this code, fix bugs, and add features
 ;; are most welcome.
 
 ;; As of version 22.3, GNU Emacs's VC mode has direct support for
 ;; Mercurial, so this package may not prove as useful there.
 
 ;; Please send problem reports and suggestions to [e-mail].
 
 
 ;;; Code:
 
 (eval-when-compile (require 'cl))
 (require 'diff-mode)
 (require 'easymenu)
 (require 'executable)
 (require 'vc)
 
 (defmacro hg-feature-cond (&rest clauses)
   "Test CLAUSES for feature at compile time.
 Each clause is (FEATURE BODY...)."
   (dolist (x clauses)
     (let ((feature (car x))
 	  (body (cdr x)))
       (when (or (eq feature t)
 		(featurep feature))
 	(return (cons 'progn body))))))
 
 
 ;;; XEmacs has view-less, while GNU Emacs has view.  Joy.
 
 (hg-feature-cond
  (xemacs (require 'view-less))
  (t (require 'view)))
 
 
 ;;; Variables accessible through the custom system.
 
 (defgroup mercurial nil
   "Mercurial distributed SCM."
   :group 'tools)
 
 (defcustom hg-binary
     (or (executable-find "hg")
 	(dolist (path '("~/bin/hg" "/usr/bin/hg" "/usr/local/bin/hg"))
 	  (when (file-executable-p path)
 	    (return path))))
   "The path to Mercurial's hg executable."
   :type '(file :must-match t)
   :group 'mercurial)
 
 (defcustom hg-mode-hook nil
   "Hook run when a buffer enters hg-mode."
   :type 'sexp
   :group 'mercurial)
 
 (defcustom hg-commit-mode-hook nil
   "Hook run when a buffer is created to prepare a commit."
   :type 'sexp
   :group 'mercurial)
 
 (defcustom hg-pre-commit-hook nil
   "Hook run before a commit is performed.
 If you want to prevent the commit from proceeding, raise an error."
   :type 'sexp
   :group 'mercurial)
 
 (defcustom hg-log-mode-hook nil
   "Hook run after a buffer is filled with log information."
   :type 'sexp
   :group 'mercurial)
 
 (defcustom hg-global-prefix "\C-ch"
   "The global prefix for Mercurial keymap bindings."
   :type 'sexp
   :group 'mercurial)
 
 (defcustom hg-commit-allow-empty-message nil
   "Whether to allow changes to be committed with empty descriptions."
   :type 'boolean
   :group 'mercurial)
 
 (defcustom hg-commit-allow-empty-file-list nil
   "Whether to allow changes to be committed without any modified files."
   :type 'boolean
   :group 'mercurial)
 
 (defcustom hg-rev-completion-limit 100
   "The maximum number of revisions that hg-read-rev will offer to complete.
 This affects memory usage and performance when prompting for revisions
 in a repository with a lot of history."
   :type 'integer
   :group 'mercurial)
 
 (defcustom hg-log-limit 50
   "The maximum number of revisions that hg-log will display."
   :type 'integer
   :group 'mercurial)
 
 (defcustom hg-update-modeline t
   "Whether to update the modeline with the status of a file after every save.
 Set this to nil on platforms with poor process management, such as Windows."
   :type 'boolean
   :group 'mercurial)
 
 (defcustom hg-incoming-repository "default"
   "The repository from which changes are pulled from by default.
 This should be a symbolic repository name, since it is used for all
 repository-related commands."
   :type 'string
   :group 'mercurial)
 
 (defcustom hg-outgoing-repository ""
   "The repository to which changes are pushed to by default.
 This should be a symbolic repository name, since it is used for all
 repository-related commands."
   :type 'string
   :group 'mercurial)
 
 
 ;;; Other variables.
 
 (defvar hg-mode nil
   "Is this file managed by Mercurial?")
 (make-variable-buffer-local 'hg-mode)
 (put 'hg-mode 'permanent-local t)
 
 (defvar hg-status nil)
 (make-variable-buffer-local 'hg-status)
 (put 'hg-status 'permanent-local t)
 
 (defvar hg-prev-buffer nil)
 (make-variable-buffer-local 'hg-prev-buffer)
 (put 'hg-prev-buffer 'permanent-local t)
 
 (defvar hg-root nil)
 (make-variable-buffer-local 'hg-root)
 (put 'hg-root 'permanent-local t)
 
 (defvar hg-view-mode nil)
 (make-variable-buffer-local 'hg-view-mode)
 (put 'hg-view-mode 'permanent-local t)
 
 (defvar hg-view-file-name nil)
 (make-variable-buffer-local 'hg-view-file-name)
 (put 'hg-view-file-name 'permanent-local t)
 
 (defvar hg-output-buffer-name "*Hg*"
   "The name to use for Mercurial output buffers.")
 
 (defvar hg-file-history nil)
 (defvar hg-repo-history nil)
 (defvar hg-rev-history nil)
 (defvar hg-repo-completion-table nil)	; shut up warnings
 
 
 ;;; Random constants.
 
 (defconst hg-commit-message-start
   "--- Enter your commit message.  Type `C-c C-c' to commit. ---\n")
 
 (defconst hg-commit-message-end
   "--- Files in bold will be committed.  Click to toggle selection. ---\n")
 
 (defconst hg-state-alist
   '((?M . modified)
     (?A . added)
     (?R . removed)
     (?! . deleted)
     (?C . normal)
     (?I . ignored)
     (?? . nil)))
 
 ;;; hg-mode keymap.
 
 (defvar hg-prefix-map
   (let ((map (make-sparse-keymap)))
     (hg-feature-cond (xemacs (set-keymap-name map 'hg-prefix-map))) ; XEmacs
     (set-keymap-parent map vc-prefix-map)
     (define-key map "=" 'hg-diff)
     (define-key map "c" 'hg-undo)
     (define-key map "g" 'hg-annotate)
     (define-key map "i" 'hg-add)
     (define-key map "l" 'hg-log)
     (define-key map "n" 'hg-commit-start)
     ;; (define-key map "r" 'hg-update)
     (define-key map "u" 'hg-revert-buffer)
     (define-key map "~" 'hg-version-other-window)
     map)
   "This keymap overrides some default vc-mode bindings.")
 
 (defvar hg-mode-map
   (let ((map (make-sparse-keymap)))
     (define-key map "\C-xv" hg-prefix-map)
     map))
 
 (add-minor-mode 'hg-mode 'hg-mode hg-mode-map)
 
 
 ;;; Global keymap.
 
 (defvar hg-global-map
   (let ((map (make-sparse-keymap)))
     (define-key map "," 'hg-incoming)
     (define-key map "." 'hg-outgoing)
     (define-key map "<" 'hg-pull)
     (define-key map "=" 'hg-diff-repo)
     (define-key map ">" 'hg-push)
     (define-key map "?" 'hg-help-overview)
     (define-key map "A" 'hg-addremove)
     (define-key map "U" 'hg-revert)
     (define-key map "a" 'hg-add)
     (define-key map "c" 'hg-commit-start)
     (define-key map "f" 'hg-forget)
     (define-key map "h" 'hg-help-overview)
     (define-key map "i" 'hg-init)
     (define-key map "l" 'hg-log-repo)
     (define-key map "r" 'hg-root)
     (define-key map "s" 'hg-status)
     (define-key map "u" 'hg-update)
     map))
 
 (global-set-key hg-global-prefix hg-global-map)
 
 ;;; View mode keymap.
 
 (defvar hg-view-mode-map
   (let ((map (make-sparse-keymap)))
     (hg-feature-cond (xemacs (set-keymap-name map 'hg-view-mode-map))) ; XEmacs
     (define-key map (hg-feature-cond (xemacs [button2])
 				     (t [mouse-2]))
       'hg-buffer-mouse-clicked)
     map))
 
 (add-minor-mode 'hg-view-mode "" hg-view-mode-map)
 
 
 ;;; Commit mode keymaps.
 
 (defvar hg-commit-mode-map
   (let ((map (make-sparse-keymap)))
     (define-key map "\C-c\C-c" 'hg-commit-finish)
     (define-key map "\C-c\C-k" 'hg-commit-kill)
     (define-key map "\C-xv=" 'hg-diff-repo)
     map))
 
 (defvar hg-commit-mode-file-map
   (let ((map (make-sparse-keymap)))
     (define-key map (hg-feature-cond (xemacs [button2])
 				     (t [mouse-2]))
       'hg-commit-mouse-clicked)
     (define-key map " " 'hg-commit-toggle-file)
     (define-key map "\r" 'hg-commit-toggle-file)
     map))
 
 
 ;;; Convenience functions.
 
 (defsubst hg-binary ()
   (if hg-binary
       hg-binary
     (error "No `hg' executable found!")))
 
 (defsubst hg-replace-in-string (str regexp newtext &optional literal)
   "Replace all matches in STR for REGEXP with NEWTEXT string.
 Return the new string.  Optional LITERAL non-nil means do a literal
 replacement.
 
 This function bridges yet another pointless impedance gap between
 XEmacs and GNU Emacs."
   (hg-feature-cond
    (xemacs (replace-in-string str regexp newtext literal))
    (t (replace-regexp-in-string regexp newtext str nil literal))))
 
 (defsubst hg-strip (str)
   "Strip leading and trailing blank lines from a string."
   (hg-replace-in-string (hg-replace-in-string str "[\r\n][ \t\r\n]*\\'" "")
 			"\\`[ \t\r\n]*[\r\n]" ""))
 
 (defsubst hg-chomp (str)
   "Strip trailing newlines from a string."
   (hg-replace-in-string str "[\r\n]+\\'" ""))
 
 (defun hg-run-command (command &rest args)
   "Run the shell command COMMAND, returning (EXIT-CODE . COMMAND-OUTPUT).
 The list ARGS contains a list of arguments to pass to the command."
   (let* (exit-code
 	 (output
 	  (with-output-to-string
 	    (with-current-buffer
 		standard-output
 	      (setq exit-code
 		    (apply 'call-process command nil t nil args))))))
     (cons exit-code output)))
 
 (defun hg-run (command &rest args)
   "Run the Mercurial command COMMAND, returning (EXIT-CODE . COMMAND-OUTPUT)."
   (apply 'hg-run-command (hg-binary) command args))
 
 (defun hg-run0 (command &rest args)
   "Run the Mercurial command COMMAND, returning its output.
 If the command does not exit with a zero status code, raise an error."
   (let ((res (apply 'hg-run-command (hg-binary) command args)))
     (if (not (eq (car res) 0))
 	(error "Mercurial command failed %s - exit code %s"
 	       (cons command args)
 	       (car res))
       (cdr res))))
 
 (defmacro hg-do-across-repo (path &rest body)
   (let ((root-name (make-symbol "root-"))
 	(buf-name (make-symbol "buf-")))
     `(let ((,root-name (hg-root ,path)))
        (save-excursion
 	 (dolist (,buf-name (buffer-list))
 	   (set-buffer ,buf-name)
 	   (when (and hg-status (equal (hg-root buffer-file-name) ,root-name))
 	     ,@body))))))
 
 (put 'hg-do-across-repo 'lisp-indent-function 1)
 
 (defun hg-sync-buffers (path)
   "Sync buffers visiting PATH with their on-disk copies.
 If PATH is not being visited, but is under the repository root, sync
 all buffers visiting files in the repository."
   (let ((buf (find-buffer-visiting path)))
     (if buf
 	(with-current-buffer buf
 	  (vc-buffer-sync))
       (hg-do-across-repo path
 	(vc-buffer-sync)))))
 
 (defun hg-buffer-commands (pnt)
   "Use the properties of a character to do something sensible."
   (interactive "d")
   (let ((rev (get-char-property pnt 'rev))
 	(file (get-char-property pnt 'file)))
     (cond
      (file
       (find-file-other-window file))
      (rev
       (hg-diff hg-view-file-name rev rev))
      ((message "I don't know how to do that yet")))))
 
 (defsubst hg-event-point (event)
   "Return the character position of the mouse event EVENT."
   (hg-feature-cond (xemacs (event-point event))
 		   (t (posn-point (event-start event)))))
 
 (defsubst hg-event-window (event)
   "Return the window over which mouse event EVENT occurred."
   (hg-feature-cond (xemacs (event-window event))
 		   (t (posn-window (event-start event)))))
 
 (defun hg-buffer-mouse-clicked (event)
   "Translate the mouse clicks in a HG log buffer to character events.
 These are then handed off to `hg-buffer-commands'.
 
 Handle frickin' frackin' gratuitous event-related incompatibilities."
   (interactive "e")
   (select-window (hg-event-window event))
   (hg-buffer-commands (hg-event-point event)))
 
 (defsubst hg-abbrev-file-name (file)
   "Portable wrapper around abbreviate-file-name."
   (hg-feature-cond (xemacs (abbreviate-file-name file t))
 		   (t (abbreviate-file-name file))))
 
 (defun hg-read-file-name (&optional prompt default)
   "Read a file or directory name, or a pattern, to use with a command."
   (save-excursion
     (while hg-prev-buffer
       (set-buffer hg-prev-buffer))
     (let ((path (or default
                     (buffer-file-name)
                     (expand-file-name default-directory))))
       (if (or (not path) current-prefix-arg)
           (expand-file-name
            (eval (list* 'read-file-name
                         (format "File, directory or pattern%s: "
                                 (or prompt ""))
                         (and path (file-name-directory path))
                         nil nil
                         (and path (file-name-nondirectory path))
                         (hg-feature-cond
 			 (xemacs (cons (quote 'hg-file-history) nil))
 			 (t nil)))))
         path))))
 
 (defun hg-read-number (&optional prompt default)
   "Read a integer value."
   (save-excursion
     (if (or (not default) current-prefix-arg)
         (string-to-number
          (eval (list* 'read-string
                       (or prompt "")
                       (if default (cons (format "%d" default) nil) nil))))
       default)))
 
 (defun hg-read-config ()
   "Return an alist of (key . value) pairs of Mercurial config data.
 Each key is of the form (section . name)."
   (let (items)
     (dolist (line (split-string (hg-chomp (hg-run0 "debugconfig")) "\n") items)
       (string-match "^\\([^=]*\\)=\\(.*\\)" line)
       (let* ((left (substring line (match-beginning 1) (match-end 1)))
 	     (right (substring line (match-beginning 2) (match-end 2)))
 	     (key (split-string left "\\."))
 	     (value (hg-replace-in-string right "\\\\n" "\n" t)))
 	(setq items (cons (cons (cons (car key) (cadr key)) value) items))))))
 
 (defun hg-config-section (section config)
   "Return an alist of (name . value) pairs for SECTION of CONFIG."
   (let (items)
     (dolist (item config items)
       (when (equal (caar item) section)
 	(setq items (cons (cons (cdar item) (cdr item)) items))))))
 
 (defun hg-string-starts-with (sub str)
   "Indicate whether string STR starts with the substring or character SUB."
   (if (not (stringp sub))
       (and (> (length str) 0) (equal (elt str 0) sub))
     (let ((sub-len (length sub)))
       (and (<= sub-len (length str))
 	   (string= sub (substring str 0 sub-len))))))
 
 (defun hg-complete-repo (string predicate all)
   "Attempt to complete a repository name.
 We complete on either symbolic names from Mercurial's config or real
-directory names from the file system.  We do not penalise URLs."
+directory names from the file system.  We do not penalize URLs."
   (or (if all
 	  (all-completions string hg-repo-completion-table predicate)
 	(try-completion string hg-repo-completion-table predicate))
       (let* ((str (expand-file-name string))
 	     (dir (file-name-directory str))
 	     (file (file-name-nondirectory str)))
 	(if all
 	    (let (completions)
 	      (dolist (name (delete "./" (file-name-all-completions file dir))
 			    completions)
 		(let ((path (concat dir name)))
 		  (when (file-directory-p path)
 		    (setq completions (cons name completions))))))
 	  (let ((comp (file-name-completion file dir)))
 	    (if comp
 		(hg-abbrev-file-name (concat dir comp))))))))
 
 (defun hg-read-repo-name (&optional prompt initial-contents default)
   "Read the location of a repository."
   (save-excursion
     (while hg-prev-buffer
       (set-buffer hg-prev-buffer))
     (let (hg-repo-completion-table)
       (if current-prefix-arg
 	  (progn
 	    (dolist (path (hg-config-section "paths" (hg-read-config)))
 	      (setq hg-repo-completion-table
 		    (cons (cons (car path) t) hg-repo-completion-table))
 	      (unless (hg-string-starts-with (hg-feature-cond
 					      (xemacs directory-sep-char)
 					      (t ?/))
 					     (cdr path))
 		(setq hg-repo-completion-table
 		      (cons (cons (cdr path) t) hg-repo-completion-table))))
 	    (completing-read (format "Repository%s: " (or prompt ""))
 			     'hg-complete-repo
 			     nil
 			     nil
 			     initial-contents
 			     'hg-repo-history
 			     default))
 	default))))
 
 (defun hg-read-rev (&optional prompt default)
   "Read a revision or tag, offering completions."
   (save-excursion
     (while hg-prev-buffer
       (set-buffer hg-prev-buffer))
     (let ((rev (or default "tip")))
       (if current-prefix-arg
 	  (let ((revs (split-string
 		       (hg-chomp
 			(hg-run0 "-q" "log" "-l"
 				 (format "%d" hg-rev-completion-limit)))
 		       "[\n:]")))
 	    (dolist (line (split-string (hg-chomp (hg-run0 "tags")) "\n"))
 	      (setq revs (cons (car (split-string line "\\s-")) revs)))
 	    (completing-read (format "Revision%s (%s): "
 				     (or prompt "")
 				     (or default "tip"))
 			     (mapcar (lambda (x) (cons x x)) revs)
 			     nil
 			     nil
 			     nil
 			     'hg-rev-history
 			     (or default "tip")))
 	rev))))
 
 (defun hg-parents-for-mode-line (root)
   "Format the parents of the working directory for the mode line."
   (let ((parents (split-string (hg-chomp
 				(hg-run0 "--cwd" root "parents" "--template"
 					 "{rev}\n")) "\n")))
     (mapconcat 'identity parents "+")))
 
 (defun hg-buffers-visiting-repo (&optional path)
   "Return a list of buffers visiting the repository containing PATH."
   (let ((root-name (hg-root (or path (buffer-file-name))))
 	bufs)
     (save-excursion
       (dolist (buf (buffer-list) bufs)
 	(set-buffer buf)
 	(let ((name (buffer-file-name)))
 	  (when (and hg-status name (equal (hg-root name) root-name))
 	    (setq bufs (cons buf bufs))))))))
 
 (defun hg-update-mode-lines (path)
   "Update the mode lines of all buffers visiting the same repository as PATH."
   (let* ((root (hg-root path))
 	 (parents (hg-parents-for-mode-line root)))
     (save-excursion
       (dolist (info (hg-path-status
 		     root
 		     (mapcar
 		      (function
 		       (lambda (buf)
 			 (substring (buffer-file-name buf) (length root))))
 		      (hg-buffers-visiting-repo root))))
 	(let* ((name (car info))
 	       (status (cdr info))
 	       (buf (find-buffer-visiting (concat root name))))
 	  (when buf
 	    (set-buffer buf)
 	    (hg-mode-line-internal status parents)))))))
 
 
 ;;; View mode bits.
 
 (defun hg-exit-view-mode (buf)
   "Exit from hg-view-mode.
 We delete the current window if entering hg-view-mode split the
 current frame."
   (when (and (eq buf (current-buffer))
 	     (> (length (window-list)) 1))
     (delete-window))
   (when (buffer-live-p buf)
     (kill-buffer buf)))
 
 (defun hg-view-mode (prev-buffer &optional file-name)
   (goto-char (point-min))
   (set-buffer-modified-p nil)
   (toggle-read-only t)
   (hg-feature-cond (xemacs (view-minor-mode prev-buffer 'hg-exit-view-mode))
 		   (t (view-mode-enter nil 'hg-exit-view-mode)))
   (setq hg-view-mode t)
   (setq truncate-lines t)
   (when file-name
     (setq hg-view-file-name
 	  (hg-abbrev-file-name file-name))))
 
 (defun hg-file-status (file)
   "Return status of FILE, or nil if FILE does not exist or is unmanaged."
   (let* ((s (hg-run "status" file))
 	 (exit (car s))
 	 (output (cdr s)))
     (if (= exit 0)
 	(let ((state (and (>= (length output) 2)
 			  (= (aref output 1) ? )
 			  (assq (aref output 0) hg-state-alist))))
 	  (if state
 	      (cdr state)
 	    'normal)))))
 
 (defun hg-path-status (root paths)
   "Return status of PATHS in repo ROOT as an alist.
 Each entry is a pair (FILE-NAME . STATUS)."
   (let ((s (apply 'hg-run "--cwd" root "status" "-marduc" paths))
 	result)
     (dolist (entry (split-string (hg-chomp (cdr s)) "\n") (nreverse result))
       (let (state name)
 	(cond ((= (aref entry 1) ? )
 	       (setq state (assq (aref entry 0) hg-state-alist)
 		     name (substring entry 2)))
 	      ((string-match "\\(.*\\): " entry)
 	       (setq name (match-string 1 entry))))
 	(setq result (cons (cons name state) result))))))
 
 (defmacro hg-view-output (args &rest body)
   "Execute BODY in a clean buffer, then quickly display that buffer.
 If the buffer contains one line, its contents are displayed in the
 minibuffer.  Otherwise, the buffer is displayed in view-mode.
 ARGS is of the form (BUFFER-NAME &optional FILE), where BUFFER-NAME is
 the name of the buffer to create, and FILE is the name of the file
 being viewed."
   (let ((prev-buf (make-symbol "prev-buf-"))
 	(v-b-name (car args))
 	(v-m-rest (cdr args)))
     `(let ((view-buf-name ,v-b-name)
 	   (,prev-buf (current-buffer)))
        (get-buffer-create view-buf-name)
        (kill-buffer view-buf-name)
        (get-buffer-create view-buf-name)
        (set-buffer view-buf-name)
        (save-excursion
 	 ,@body)
        (case (count-lines (point-min) (point-max))
 	 ((0)
 	  (kill-buffer view-buf-name)
 	  (message "(No output)"))
 	 ((1)
 	  (let ((msg (hg-chomp (buffer-substring (point-min) (point-max)))))
 	    (kill-buffer view-buf-name)
 	    (message "%s" msg)))
 	 (t
 	  (pop-to-buffer view-buf-name)
 	  (setq hg-prev-buffer ,prev-buf)
 	  (hg-view-mode ,prev-buf ,@v-m-rest))))))
 
 (put 'hg-view-output 'lisp-indent-function 1)
 
 ;;; Context save and restore across revert and other operations.
 
 (defun hg-position-context (pos)
   "Return information to help find the given position again."
   (let* ((end (min (point-max) (+ pos 98))))
     (list pos
 	  (buffer-substring (max (point-min) (- pos 2)) end)
 	  (- end pos))))
 
 (defun hg-buffer-context ()
   "Return information to help restore a user's editing context.
 This is useful across reverts and merges, where a context is likely
 to have moved a little, but not really changed."
   (let ((point-context (hg-position-context (point)))
 	(mark-context (let ((mark (mark-marker)))
 			(and mark
 			     ;; make sure active mark
 			     (marker-buffer mark)
 			     (marker-position mark)
 			     (hg-position-context mark)))))
     (list point-context mark-context)))
 
 (defun hg-find-context (ctx)
   "Attempt to find a context in the given buffer.
 Always returns a valid, hopefully sane, position."
   (let ((pos (nth 0 ctx))
 	(str (nth 1 ctx))
 	(fixup (nth 2 ctx)))
     (save-excursion
       (goto-char (max (point-min) (- pos 15000)))
       (if (and (not (equal str ""))
 	       (search-forward str nil t))
 	  (- (point) fixup)
 	(max pos (point-min))))))
 
 (defun hg-restore-context (ctx)
   "Attempt to restore the user's editing context."
   (let ((point-context (nth 0 ctx))
 	(mark-context (nth 1 ctx)))
     (goto-char (hg-find-context point-context))
     (when mark-context
       (set-mark (hg-find-context mark-context)))))
 
 
 ;;; Hooks.
 
 (defun hg-mode-line-internal (status parents)
   (setq hg-status status
 	hg-mode (and status (concat " Hg:"
 				    parents
 				    (cdr (assq status
 					       '((normal . "")
 						 (removed . "r")
 						 (added . "a")
 						 (deleted . "!")
 						 (modified . "m"))))))))
 
 (defun hg-mode-line (&optional force)
   "Update the modeline with the current status of a file.
 An update occurs if optional argument FORCE is non-nil,
 hg-update-modeline is non-nil, or we have not yet checked the state of
 the file."
   (let ((root (hg-root)))
     (when (and root (or force hg-update-modeline (not hg-mode)))
       (let ((status (hg-file-status buffer-file-name))
 	    (parents (hg-parents-for-mode-line root)))
 	(hg-mode-line-internal status parents)
 	status))))
 
 (defun hg-mode (&optional toggle)
   "Minor mode for Mercurial distributed SCM integration.
 
 The Mercurial mode user interface is based on that of VC mode, so if
 you're already familiar with VC, the same keybindings and functions
 will generally work.
 
 Below is a list of many common SCM tasks.  In the list, `G/L\'
 indicates whether a key binding is global (G) to a repository or
 local (L) to a file.  Many commands take a prefix argument.
 
 SCM Task                              G/L  Key Binding  Command Name
 --------                              ---  -----------  ------------
 Help overview (what you are reading)  G    C-c h h      hg-help-overview
 
 Tell Mercurial to manage a file       G    C-c h a      hg-add
 Commit changes to current file only   L    C-x v n      hg-commit-start
 Undo changes to file since commit     L    C-x v u      hg-revert-buffer
 
 Diff file vs last checkin             L    C-x v =      hg-diff
 
 View file change history              L    C-x v l      hg-log
 View annotated file                   L    C-x v a      hg-annotate
 
 Diff repo vs last checkin             G    C-c h =      hg-diff-repo
 View status of files in repo          G    C-c h s      hg-status
 Commit all changes                    G    C-c h c      hg-commit-start
 
 Undo all changes since last commit    G    C-c h U      hg-revert
 View repo change history              G    C-c h l      hg-log-repo
 
 See changes that can be pulled        G    C-c h ,      hg-incoming
 Pull changes                          G    C-c h <      hg-pull
 Update working directory after pull   G    C-c h u      hg-update
 See changes that can be pushed        G    C-c h .      hg-outgoing
 Push changes                          G    C-c h >      hg-push"
   (unless vc-make-backup-files
     (set (make-local-variable 'backup-inhibited) t))
   (run-hooks 'hg-mode-hook))
 
 (defun hg-find-file-hook ()
   (ignore-errors
     (when (hg-mode-line)
       (hg-mode))))
 
 (add-hook 'find-file-hooks 'hg-find-file-hook)
 
 (defun hg-after-save-hook ()
   (ignore-errors
     (let ((old-status hg-status))
       (hg-mode-line)
       (if (and (not old-status) hg-status)
 	  (hg-mode)))))
 
 (add-hook 'after-save-hook 'hg-after-save-hook)
 
 
 ;;; User interface functions.
 
 (defun hg-help-overview ()
   "This is an overview of the Mercurial SCM mode for Emacs.
 
 You can find the source code, license (GPLv2+), and credits for this
 code by typing `M-x find-library mercurial RET'."
   (interactive)
   (hg-view-output ("Mercurial Help Overview")
     (insert (documentation 'hg-help-overview))
     (let ((pos (point)))
       (insert (documentation 'hg-mode))
       (goto-char pos)
       (end-of-line 1)
       (delete-region pos (point)))
     (let ((hg-root-dir (hg-root)))
       (if (not hg-root-dir)
 	  (error "error: %s: directory is not part of a Mercurial repository."
 		 default-directory)
 	(cd hg-root-dir)))))
 
 (defun hg-fix-paths ()
   "Fix paths reported by some Mercurial commands."
   (save-excursion
     (goto-char (point-min))
     (while (re-search-forward " \\.\\.." nil t)
       (replace-match " " nil nil))))
 
 (defun hg-add (path)
   "Add PATH to the Mercurial repository on the next commit.
 With a prefix argument, prompt for the path to add."
   (interactive (list (hg-read-file-name " to add")))
   (let ((buf (current-buffer))
 	(update (equal buffer-file-name path)))
     (hg-view-output (hg-output-buffer-name)
       (apply 'call-process (hg-binary) nil t nil (list "add" path))
       (hg-fix-paths)
       (goto-char (point-min))
       (cd (hg-root path)))
     (when update
       (unless vc-make-backup-files
 	(set (make-local-variable 'backup-inhibited) t))
       (with-current-buffer buf
 	(hg-mode-line)))))
 
 (defun hg-addremove ()
   (interactive)
   (error "not implemented"))
 
 (defun hg-annotate ()
   (interactive)
   (error "not implemented"))
 
 (defun hg-commit-toggle-file (pos)
   "Toggle whether or not the file at POS will be committed."
   (interactive "d")
   (save-excursion
     (goto-char pos)
     (let (face
 	  (inhibit-read-only t)
 	  bol)
       (beginning-of-line)
       (setq bol (+ (point) 4))
       (setq face (get-text-property bol 'face))
       (end-of-line)
       (if (eq face 'bold)
 	  (progn
 	    (remove-text-properties bol (point) '(face nil))
 	    (message "%s will not be committed"
 		     (buffer-substring bol (point))))
 	(add-text-properties bol (point) '(face bold))
 	(message "%s will be committed"
 		 (buffer-substring bol (point)))))))
 
 (defun hg-commit-mouse-clicked (event)
   "Toggle whether or not the file at POS will be committed."
   (interactive "@e")
   (hg-commit-toggle-file (hg-event-point event)))
 
 (defun hg-commit-kill ()
   "Kill the commit currently being prepared."
   (interactive)
   (when (or (not (buffer-modified-p)) (y-or-n-p "Really kill this commit? "))
     (let ((buf hg-prev-buffer))
       (kill-buffer nil)
       (switch-to-buffer buf))))
 
 (defun hg-commit-finish ()
   "Finish preparing a commit, and perform the actual commit.
 The hook hg-pre-commit-hook is run before anything else is done.  If
 the commit message is empty and hg-commit-allow-empty-message is nil,
 an error is raised.  If the list of files to commit is empty and
 hg-commit-allow-empty-file-list is nil, an error is raised."
   (interactive)
   (let ((root hg-root))
     (save-excursion
       (run-hooks 'hg-pre-commit-hook)
       (goto-char (point-min))
       (search-forward hg-commit-message-start)
       (let (message files)
 	(let ((start (point)))
 	  (goto-char (point-max))
 	  (search-backward hg-commit-message-end)
 	  (setq message (hg-strip (buffer-substring start (point)))))
 	(when (and (= (length message) 0)
 		   (not hg-commit-allow-empty-message))
 	  (error "Cannot proceed - commit message is empty"))
 	(forward-line 1)
 	(beginning-of-line)
 	(while (< (point) (point-max))
 	  (let ((pos (+ (point) 4)))
 	    (end-of-line)
 	    (when (eq (get-text-property pos 'face) 'bold)
 	      (end-of-line)
 	      (setq files (cons (buffer-substring pos (point)) files))))
 	  (forward-line 1))
 	(when (and (= (length files) 0)
 		   (not hg-commit-allow-empty-file-list))
 	  (error "Cannot proceed - no files to commit"))
 	(setq message (concat message "\n"))
 	(apply 'hg-run0 "--cwd" hg-root "commit" "-m" message files))
       (let ((buf hg-prev-buffer))
 	(kill-buffer nil)
 	(switch-to-buffer buf))
       (hg-update-mode-lines root))))
 
 (defun hg-commit-mode ()
   "Mode for describing a commit of changes to a Mercurial repository.
 This involves two actions: describing the changes with a commit
 message, and choosing the files to commit.
 
 To describe the commit, simply type some text in the designated area.
 
 By default, all modified, added and removed files are selected for
 committing.  Files that will be committed are displayed in bold face\;
 those that will not are displayed in normal face.
 
 To toggle whether a file will be committed, move the cursor over a
 particular file and hit space or return.  Alternatively, middle click
 on the file.
 
 Key bindings
 ------------
 \\[hg-commit-finish]		proceed with commit
 \\[hg-commit-kill]		kill commit
 
 \\[hg-diff-repo]		view diff of pending changes"
   (interactive)
   (use-local-map hg-commit-mode-map)
   (set-syntax-table text-mode-syntax-table)
   (setq local-abbrev-table text-mode-abbrev-table
 	major-mode 'hg-commit-mode
 	mode-name "Hg-Commit")
   (set-buffer-modified-p nil)
   (setq buffer-undo-list nil)
   (run-hooks 'text-mode-hook 'hg-commit-mode-hook))
 
 (defun hg-commit-start ()
   "Prepare a commit of changes to the repository containing the current file."
   (interactive)
   (while hg-prev-buffer
     (set-buffer hg-prev-buffer))
   (let ((root (hg-root))
 	(prev-buffer (current-buffer))
 	modified-files)
     (unless root
       (error "Cannot commit outside a repository!"))
     (hg-sync-buffers root)
     (setq modified-files (hg-chomp (hg-run0 "--cwd" root "status" "-arm")))
     (when (and (= (length modified-files) 0)
 	       (not hg-commit-allow-empty-file-list))
       (error "No pending changes to commit"))
     (let* ((buf-name (format "*Mercurial: Commit %s*" root)))
       (pop-to-buffer (get-buffer-create buf-name))
       (when (= (point-min) (point-max))
 	(set (make-local-variable 'hg-root) root)
 	(setq hg-prev-buffer prev-buffer)
 	(insert "\n")
 	(let ((bol (point)))
 	  (insert hg-commit-message-end)
 	  (add-text-properties bol (point) '(face bold-italic)))
 	(let ((file-area (point)))
 	  (insert modified-files)
 	  (goto-char file-area)
 	  (while (< (point) (point-max))
 	    (let ((bol (point)))
 	      (forward-char 1)
 	      (insert "  ")
 	      (end-of-line)
 	      (add-text-properties (+ bol 4) (point)
 				   '(face bold mouse-face highlight)))
 	    (forward-line 1))
 	  (goto-char file-area)
 	  (add-text-properties (point) (point-max)
 			       `(keymap ,hg-commit-mode-file-map))
 	  (goto-char (point-min))
 	  (insert hg-commit-message-start)
 	  (add-text-properties (point-min) (point) '(face bold-italic))
 	  (insert "\n\n")
 	  (forward-line -1)
 	  (save-excursion
 	    (goto-char (point-max))
 	    (search-backward hg-commit-message-end)
 	    (add-text-properties (match-beginning 0) (point-max)
 				 '(read-only t))
 	    (goto-char (point-min))
 	    (search-forward hg-commit-message-start)
 	    (add-text-properties (match-beginning 0) (match-end 0)
 				 '(read-only t)))
 	  (hg-commit-mode)
           (cd root))))))
 
 (defun hg-diff (path &optional rev1 rev2)
   "Show the differences between REV1 and REV2 of PATH.
 When called interactively, the default behaviour is to treat REV1 as
 the \"parent\" revision, REV2 as the current edited version of the file, and
 PATH as the file edited in the current buffer.
 With a prefix argument, prompt for all of these."
   (interactive (list (hg-read-file-name " to diff")
                      (let ((rev1 (hg-read-rev " to start with" 'parent)))
 		       (and (not (eq rev1 'parent)) rev1))
 		     (let ((rev2 (hg-read-rev " to end with" 'working-dir)))
 		       (and (not (eq rev2 'working-dir)) rev2))))
   (hg-sync-buffers path)
   (let ((a-path (hg-abbrev-file-name path))
         ;; none revision is specified explicitly
         (none (and (not rev1) (not rev2)))
         ;; only one revision is specified explicitly
         (one (or (and (or (equal rev1 rev2) (not rev2)) rev1)
                  (and (not rev1) rev2)))
 	diff)
     (hg-view-output ((cond
 		      (none
 		       (format "Mercurial: Diff against parent of %s" a-path))
 		      (one
 		       (format "Mercurial: Diff of rev %s of %s" one a-path))
 		      (t
 		       (format "Mercurial: Diff from rev %s to %s of %s"
 			       rev1 rev2 a-path))))
       (cond
        (none
         (call-process (hg-binary) nil t nil "diff" path))
        (one
         (call-process (hg-binary) nil t nil "diff" "-r" one path))
        (t
         (call-process (hg-binary) nil t nil "diff" "-r" rev1 "-r" rev2 path)))
       (diff-mode)
       (setq diff (not (= (point-min) (point-max))))
       (font-lock-fontify-buffer)
       (cd (hg-root path)))
     diff))
 
 (defun hg-diff-repo (path &optional rev1 rev2)
   "Show the differences between REV1 and REV2 of repository containing PATH.
 When called interactively, the default behaviour is to treat REV1 as
 the \"parent\" revision, REV2 as the current edited version of the file, and
 PATH as the `hg-root' of the current buffer.
 With a prefix argument, prompt for all of these."
   (interactive (list (hg-read-file-name " to diff")
                      (let ((rev1 (hg-read-rev " to start with" 'parent)))
 		       (and (not (eq rev1 'parent)) rev1))
 		     (let ((rev2 (hg-read-rev " to end with" 'working-dir)))
 		       (and (not (eq rev2 'working-dir)) rev2))))
   (hg-diff (hg-root path) rev1 rev2))
 
 (defun hg-forget (path)
   "Lose track of PATH, which has been added, but not yet committed.
 This will prevent the file from being incorporated into the Mercurial
 repository on the next commit.
 With a prefix argument, prompt for the path to forget."
   (interactive (list (hg-read-file-name " to forget")))
   (let ((buf (current-buffer))
 	(update (equal buffer-file-name path)))
     (hg-view-output (hg-output-buffer-name)
       (apply 'call-process (hg-binary) nil t nil (list "forget" path))
       ;; "hg forget" shows pathes relative NOT TO ROOT BUT TO REPOSITORY
       (hg-fix-paths)
       (goto-char (point-min))
       (cd (hg-root path)))
     (when update
       (with-current-buffer buf
         (when (local-variable-p 'backup-inhibited)
           (kill-local-variable 'backup-inhibited))
 	(hg-mode-line)))))
 
 (defun hg-incoming (&optional repo)
   "Display changesets present in REPO that are not present locally."
   (interactive (list (hg-read-repo-name " where changes would come from")))
   (hg-view-output ((format "Mercurial: Incoming from %s to %s"
 			   (hg-abbrev-file-name (hg-root))
 			   (hg-abbrev-file-name
 			    (or repo hg-incoming-repository))))
     (call-process (hg-binary) nil t nil "incoming"
 		  (or repo hg-incoming-repository))
     (hg-log-mode)
     (cd (hg-root))))
 
 (defun hg-init ()
   (interactive)
   (error "not implemented"))
 
 (defun hg-log-mode ()
   "Mode for viewing a Mercurial change log."
   (goto-char (point-min))
   (when (looking-at "^searching for changes.*$")
     (delete-region (match-beginning 0) (match-end 0)))
   (run-hooks 'hg-log-mode-hook))
 
 (defun hg-log (path &optional rev1 rev2 log-limit)
   "Display the revision history of PATH.
 History is displayed between REV1 and REV2.
 Number of displayed changesets is limited to LOG-LIMIT.
 REV1 defaults to the tip, while REV2 defaults to 0.
 LOG-LIMIT defaults to `hg-log-limit'.
 With a prefix argument, prompt for each parameter."
   (interactive (list (hg-read-file-name " to log")
                      (hg-read-rev " to start with"
                                   "tip")
                      (hg-read-rev " to end with"
 				  "0")
                      (hg-read-number "Output limited to: "
                                      hg-log-limit)))
   (let ((a-path (hg-abbrev-file-name path))
         (r1 (or rev1 "tip"))
         (r2 (or rev2 "0"))
         (limit (format "%d" (or log-limit hg-log-limit))))
     (hg-view-output ((if (equal r1 r2)
                          (format "Mercurial: Log of rev %s of %s" rev1 a-path)
                        (format
                         "Mercurial: at most %s log(s) from rev %s to %s of %s"
                         limit r1 r2 a-path)))
       (eval (list* 'call-process (hg-binary) nil t nil
                    "log"
                    "-r" (format "%s:%s" r1 r2)
                    "-l" limit
                    (if (> (length path) (length (hg-root path)))
                        (cons path nil)
                      nil)))
       (hg-log-mode)
       (cd (hg-root path)))))
 
 (defun hg-log-repo (path &optional rev1 rev2 log-limit)
   "Display the revision history of the repository containing PATH.
 History is displayed between REV1 and REV2.
 Number of displayed changesets is limited to LOG-LIMIT,
 REV1 defaults to the tip, while REV2 defaults to 0.
 LOG-LIMIT defaults to `hg-log-limit'.
 With a prefix argument, prompt for each parameter."
   (interactive (list (hg-read-file-name " to log")
                      (hg-read-rev " to start with"
                                   "tip")
                      (hg-read-rev " to end with"
 				  "0")
                      (hg-read-number "Output limited to: "
                                      hg-log-limit)))
   (hg-log (hg-root path) rev1 rev2 log-limit))
 
 (defun hg-outgoing (&optional repo)
   "Display changesets present locally that are not present in REPO."
   (interactive (list (hg-read-repo-name " where changes would go to" nil
 					hg-outgoing-repository)))
   (hg-view-output ((format "Mercurial: Outgoing from %s to %s"
 			   (hg-abbrev-file-name (hg-root))
 			   (hg-abbrev-file-name
 			    (or repo hg-outgoing-repository))))
     (call-process (hg-binary) nil t nil "outgoing"
 		  (or repo hg-outgoing-repository))
     (hg-log-mode)
     (cd (hg-root))))
 
 (defun hg-pull (&optional repo)
   "Pull changes from repository REPO.
 This does not update the working directory."
   (interactive (list (hg-read-repo-name " to pull from")))
   (hg-view-output ((format "Mercurial: Pull to %s from %s"
 			   (hg-abbrev-file-name (hg-root))
 			   (hg-abbrev-file-name
 			    (or repo hg-incoming-repository))))
     (call-process (hg-binary) nil t nil "pull"
 		  (or repo hg-incoming-repository))
     (cd (hg-root))))
 
 (defun hg-push (&optional repo)
   "Push changes to repository REPO."
   (interactive (list (hg-read-repo-name " to push to")))
   (hg-view-output ((format "Mercurial: Push from %s to %s"
 			   (hg-abbrev-file-name (hg-root))
 			   (hg-abbrev-file-name
 			    (or repo hg-outgoing-repository))))
     (call-process (hg-binary) nil t nil "push"
 		  (or repo hg-outgoing-repository))
     (cd (hg-root))))
 
 (defun hg-revert-buffer-internal ()
   (let ((ctx (hg-buffer-context)))
     (message "Reverting %s..." buffer-file-name)
     (hg-run0 "revert" buffer-file-name)
     (revert-buffer t t t)
     (hg-restore-context ctx)
     (hg-mode-line)
     (message "Reverting %s...done" buffer-file-name)))
 
 (defun hg-revert-buffer ()
   "Revert current buffer's file back to the latest committed version.
 If the file has not changed, nothing happens.  Otherwise, this
 displays a diff and asks for confirmation before reverting."
   (interactive)
   (let ((vc-suppress-confirm nil)
 	(obuf (current-buffer))
 	diff)
     (vc-buffer-sync)
     (unwind-protect
 	(setq diff (hg-diff buffer-file-name))
       (when diff
 	(unless (yes-or-no-p "Discard changes? ")
 	  (error "Revert cancelled")))
       (when diff
 	(let ((buf (current-buffer)))
 	  (delete-window (selected-window))
 	  (kill-buffer buf))))
     (set-buffer obuf)
     (when diff
       (hg-revert-buffer-internal))))
 
 (defun hg-root (&optional path)
   "Return the root of the repository that contains the given path.
 If the path is outside a repository, return nil.
 When called interactively, the root is printed.  A prefix argument
 prompts for a path to check."
   (interactive (list (hg-read-file-name)))
   (if (or path (not hg-root))
       (let ((root (do ((prev nil dir)
 		       (dir (file-name-directory
                              (or
                               path
                               buffer-file-name
                               (expand-file-name default-directory)))
 			    (file-name-directory (directory-file-name dir))))
 		      ((equal prev dir))
 		    (when (file-directory-p (concat dir ".hg"))
 		      (return dir)))))
 	(when (interactive-p)
 	  (if root
 	      (message "The root of this repository is `%s'." root)
 	    (message "The path `%s' is not in a Mercurial repository."
 		     (hg-abbrev-file-name path))))
 	root)
     hg-root))
 
 (defun hg-cwd (&optional path)
   "Return the current directory of PATH within the repository."
   (do ((stack nil (cons (file-name-nondirectory
 			 (directory-file-name dir))
 			stack))
        (prev nil dir)
        (dir (file-name-directory (or path buffer-file-name
 				     (expand-file-name default-directory)))
 	    (file-name-directory (directory-file-name dir))))
       ((equal prev dir))
     (when (file-directory-p (concat dir ".hg"))
       (let ((cwd (mapconcat 'identity stack "/")))
 	(unless (equal cwd "")
 	  (return (file-name-as-directory cwd)))))))
 
 (defun hg-status (path)
   "Print revision control status of a file or directory.
 With prefix argument, prompt for the path to give status for.
 Names are displayed relative to the repository root."
   (interactive (list (hg-read-file-name " for status" (hg-root))))
   (let ((root (hg-root)))
     (hg-view-output ((format "Mercurial: Status of %s in %s"
 			     (let ((name (substring (expand-file-name path)
 						    (length root))))
 			       (if (> (length name) 0)
 				   name
 				 "*"))
 			     (hg-abbrev-file-name root)))
       (apply 'call-process (hg-binary) nil t nil
 	     (list "--cwd" root "status" path))
       (cd (hg-root path)))))
 
 (defun hg-undo ()
   (interactive)
   (error "not implemented"))
 
 (defun hg-update ()
   (interactive)
   (error "not implemented"))
 
 (defun hg-version-other-window (rev)
   "Visit version REV of the current file in another window.
 If the current file is named `F', the version is named `F.~REV~'.
 If `F.~REV~' already exists, use it instead of checking it out again."
   (interactive "sVersion to visit (default is workfile version): ")
   (let* ((file buffer-file-name)
        	 (version (if (string-equal rev "")
 		       "tip"
 		        rev))
  	 (automatic-backup (vc-version-backup-file-name file version))
           (manual-backup (vc-version-backup-file-name file version 'manual)))
      (unless (file-exists-p manual-backup)
        (if (file-exists-p automatic-backup)
            (rename-file automatic-backup manual-backup nil)
          (hg-run0 "-q" "cat" "-r" version "-o" manual-backup file)))
      (find-file-other-window manual-backup)))
 
 
 (provide 'mercurial)
 
 
 ;;; Local Variables:
 ;;; prompt-to-byte-compile: nil
 ;;; end:

contrib/vim/hgcommand.vim

@@ -1,1703 +1,1703 b''
 " vim600: set foldmethod=marker:
 "
 " Vim plugin to assist in working with HG-controlled files.
 "
 " Last Change:   2006/02/22
 " Version:       1.77
 " Maintainer:    Mathieu Clabaut <[e-mail]>
 " License:       This file is placed in the public domain.
 " Credits:
 "                Bob Hiestand <[e-mail]> for the fabulous
 "                cvscommand.vim from which this script was directly created by
 "                means of sed commands and minor tweaks.
 " Note:          
 "                For Vim7 the use of Bob Hiestand's vcscommand.vim
 "                <http://www.vim.org/scripts/script.php?script_id=90>
 "                in conjunction with Vladmir Marek's Hg backend
 "                <http://www.vim.org/scripts/script.php?script_id=1898>
 "                is recommended.
 
 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 "
 " Section: Documentation
 "----------------------------
 "
 " Documentation should be available by ":help hgcommand" command, once the
 " script has been copied in you .vim/plugin directory.
 "
 " You still can read the documentation at the end of this file. Locate it by
 " searching the "hgcommand-contents" string (and set ft=help to have
-" appropriate syntaxic coloration).
+" appropriate syntactic coloration).
 
 " Section: Plugin header {{{1
 
 " loaded_hgcommand is set to 1 when the initialization begins, and 2 when it
 " completes.  This allows various actions to only be taken by functions after
 " system initialization.
 
 if exists("g:loaded_hgcommand")
    finish
 endif
 let g:loaded_hgcommand = 1
 
 " store 'compatible' settings
 let s:save_cpo = &cpo
 set cpo&vim
 
 " run checks
 let s:script_name = expand("<sfile>:t:r")
 
 function! s:HGCleanupOnFailure(err)
   echohl WarningMsg
   echomsg s:script_name . ":" a:err "Plugin not loaded"
   echohl None
   let g:loaded_hgcommand = "no"
   unlet s:save_cpo s:script_name
 endfunction
 
 if v:version < 602
   call <SID>HGCleanupOnFailure("VIM 6.2 or later required.")
   finish
 endif
 
 if !exists("*system")
   call <SID>HGCleanupOnFailure("builtin system() function required.")
   finish
 endif
 
 let s:script_version = "v0.2"
 
 " Section: Event group setup {{{1
 
 augroup HGCommand
 augroup END
 
 " Section: Plugin initialization {{{1
 silent do HGCommand User HGPluginInit
 
 " Section: Script variable initialization {{{1
 
 let s:HGCommandEditFileRunning = 0
 unlet! s:vimDiffRestoreCmd
 unlet! s:vimDiffSourceBuffer
 unlet! s:vimDiffBufferCount
 unlet! s:vimDiffScratchList
 
 " Section: Utility functions {{{1
 
 " Function: s:HGResolveLink() {{{2
 " Fully resolve the given file name to remove shortcuts or symbolic links.
 
 function! s:HGResolveLink(fileName)
   let resolved = resolve(a:fileName)
   if resolved != a:fileName
     let resolved = <SID>HGResolveLink(resolved)
   endif
   return resolved
 endfunction
 
 " Function: s:HGChangeToCurrentFileDir() {{{2
 " Go to the directory in which the current HG-controlled file is located.
 " If this is a HG command buffer, first switch to the original file.
 
 function! s:HGChangeToCurrentFileDir(fileName)
   let oldCwd=getcwd()
   let fileName=<SID>HGResolveLink(a:fileName)
   let newCwd=fnamemodify(fileName, ':h')
   if strlen(newCwd) > 0
     execute 'cd' escape(newCwd, ' ')
   endif
   return oldCwd
 endfunction
 
 " Function: <SID>HGGetOption(name, default) {{{2
 " Grab a user-specified option to override the default provided.  Options are
 " searched in the window, buffer, then global spaces.
 
 function! s:HGGetOption(name, default)
   if exists("s:" . a:name . "Override")
     execute "return s:".a:name."Override"
   elseif exists("w:" . a:name)
     execute "return w:".a:name
   elseif exists("b:" . a:name)
     execute "return b:".a:name
   elseif exists("g:" . a:name)
     execute "return g:".a:name
   else
     return a:default
   endif
 endfunction
 
 " Function: s:HGEditFile(name, origBuffNR) {{{2
 " Wrapper around the 'edit' command to provide some helpful error text if the
 " current buffer can't be abandoned.  If name is provided, it is used;
 " otherwise, a nameless scratch buffer is used.
 " Returns: 0 if successful, -1 if an error occurs.
 
 function! s:HGEditFile(name, origBuffNR)
   "Name parameter will be pasted into expression.
   let name = escape(a:name, ' *?\')
 
   let editCommand = <SID>HGGetOption('HGCommandEdit', 'edit')
   if editCommand != 'edit'
     if <SID>HGGetOption('HGCommandSplit', 'horizontal') == 'horizontal'
       if name == ""
         let editCommand = 'rightbelow new'
       else
         let editCommand = 'rightbelow split ' . name
       endif
     else
       if name == ""
         let editCommand = 'vert rightbelow new'
       else
         let editCommand = 'vert rightbelow split ' . name
       endif
     endif
   else
     if name == ""
       let editCommand = 'enew'
     else
       let editCommand = 'edit ' . name
     endif
   endif
 
   " Protect against useless buffer set-up
   let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning + 1
   try
     execute editCommand
   finally
     let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning - 1
   endtry
 
   let b:HGOrigBuffNR=a:origBuffNR
   let b:HGCommandEdit='split'
 endfunction
 
 " Function: s:HGCreateCommandBuffer(cmd, cmdName, statusText, filename) {{{2
 " Creates a new scratch buffer and captures the output from execution of the
 " given command.  The name of the scratch buffer is returned.
 
 function! s:HGCreateCommandBuffer(cmd, cmdName, statusText, origBuffNR)
   let fileName=bufname(a:origBuffNR)
 
   let resultBufferName=''
 
   if <SID>HGGetOption("HGCommandNameResultBuffers", 0)
     let nameMarker = <SID>HGGetOption("HGCommandNameMarker", '_')
     if strlen(a:statusText) > 0
       let bufName=a:cmdName . ' -- ' . a:statusText
     else
       let bufName=a:cmdName
     endif
     let bufName=fileName . ' ' . nameMarker . bufName . nameMarker
     let counter=0
     let resultBufferName = bufName
     while buflisted(resultBufferName)
       let counter=counter + 1
       let resultBufferName=bufName . ' (' . counter . ')'
     endwhile
   endif
 
   let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " " . a:cmd
   "echomsg "DBG :".hgCommand
   let hgOut = system(hgCommand)
   " HACK:  diff command does not return proper error codes
   if v:shell_error && a:cmdName != 'hgdiff'
     if strlen(hgOut) == 0
       echoerr "HG command failed"
     else
       echoerr "HG command failed:  " . hgOut
     endif
     return -1
   endif
   if strlen(hgOut) == 0
     " Handle case of no output.  In this case, it is important to check the
     " file status, especially since hg edit/unedit may change the attributes
     " of the file with no visible output.
 
     echomsg "No output from HG command"
     checktime
     return -1
   endif
 
   if <SID>HGEditFile(resultBufferName, a:origBuffNR) == -1
     return -1
   endif
 
   set buftype=nofile
   set noswapfile
   set filetype=
 
   if <SID>HGGetOption("HGCommandDeleteOnHide", 0)
     set bufhidden=delete
   endif
 
   silent 0put=hgOut
 
   " The last command left a blank line at the end of the buffer.  If the
   " last line is folded (a side effect of the 'put') then the attempt to
   " remove the blank line will kill the last fold.
   "
   " This could be fixed by explicitly detecting whether the last line is
   " within a fold, but I prefer to simply unfold the result buffer altogether.
 
   if has("folding")
     setlocal nofoldenable
   endif
 
   $d
   1
 
   " Define the environment and execute user-defined hooks.
 
   let b:HGSourceFile=fileName
   let b:HGCommand=a:cmdName
   if a:statusText != ""
     let b:HGStatusText=a:statusText
   endif
 
   silent do HGCommand User HGBufferCreated
   return bufnr("%")
 endfunction
 
 " Function: s:HGBufferCheck(hgBuffer) {{{2
 " Attempts to locate the original file to which HG operations were applied
 " for a given buffer.
 
 function! s:HGBufferCheck(hgBuffer)
   let origBuffer = getbufvar(a:hgBuffer, "HGOrigBuffNR")
   if origBuffer
     if bufexists(origBuffer)
       return origBuffer
     else
       " Original buffer no longer exists.
       return -1
     endif
   else
     " No original buffer
     return a:hgBuffer
   endif
 endfunction
 
 " Function: s:HGCurrentBufferCheck() {{{2
 " Attempts to locate the original file to which HG operations were applied
 " for the current buffer.
 
 function! s:HGCurrentBufferCheck()
   return <SID>HGBufferCheck(bufnr("%"))
 endfunction
 
 " Function: s:HGToggleDeleteOnHide() {{{2
 " Toggles on and off the delete-on-hide behavior of HG buffers
 
 function! s:HGToggleDeleteOnHide()
   if exists("g:HGCommandDeleteOnHide")
     unlet g:HGCommandDeleteOnHide
   else
     let g:HGCommandDeleteOnHide=1
   endif
 endfunction
 
 " Function: s:HGDoCommand(hgcmd, cmdName, statusText) {{{2
 " General skeleton for HG function execution.
 " Returns: name of the new command buffer containing the command results
 
 function! s:HGDoCommand(cmd, cmdName, statusText)
   let hgBufferCheck=<SID>HGCurrentBufferCheck()
   if hgBufferCheck == -1
     echo "Original buffer no longer exists, aborting."
     return -1
   endif
 
   let fileName=bufname(hgBufferCheck)
   if isdirectory(fileName)
     let fileName=fileName . "/" . getline(".")
   endif
   let realFileName = fnamemodify(<SID>HGResolveLink(fileName), ':t')
   let oldCwd=<SID>HGChangeToCurrentFileDir(fileName)
   try
      " TODO
     "if !filereadable('HG/Root')
       "throw fileName . ' is not a HG-controlled file.'
     "endif
     let fullCmd = a:cmd . ' "' . realFileName . '"'
     "echomsg "DEBUG".fullCmd
     let resultBuffer=<SID>HGCreateCommandBuffer(fullCmd, a:cmdName, a:statusText, hgBufferCheck)
     return resultBuffer
   catch
     echoerr v:exception
     return -1
   finally
     execute 'cd' escape(oldCwd, ' ')
   endtry
 endfunction
 
 
 " Function: s:HGGetStatusVars(revision, branch, repository) {{{2
 "
 " Obtains a HG revision number and branch name.  The 'revisionVar',
 " 'branchVar'and 'repositoryVar' arguments, if non-empty, contain the names of variables to hold
 " the corresponding results.
 "
 " Returns: string to be exec'd that sets the multiple return values.
 
 function! s:HGGetStatusVars(revisionVar, branchVar, repositoryVar)
   let hgBufferCheck=<SID>HGCurrentBufferCheck()
   "echomsg "DBG : in HGGetStatusVars"
   if hgBufferCheck == -1
     return ""
   endif
   let fileName=bufname(hgBufferCheck)
   let fileNameWithoutLink=<SID>HGResolveLink(fileName)
   let realFileName = fnamemodify(fileNameWithoutLink, ':t')
   let oldCwd=<SID>HGChangeToCurrentFileDir(realFileName)
   try
     let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " root  "
     let roottext=system(hgCommand)
     " Suppress ending null char ! Does it work in window ?
     let roottext=substitute(roottext,'^.*/\([^/\n\r]*\)\n\_.*$','\1','')
     if match(getcwd()."/".fileNameWithoutLink, roottext) == -1
       return ""
     endif
     let returnExpression = ""
     if a:repositoryVar != ""
       let returnExpression=returnExpression . " | let " . a:repositoryVar . "='" . roottext . "'"
     endif
     let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " status -mardui " . realFileName
     let statustext=system(hgCommand)
     if(v:shell_error)
       return ""
     endif
     if match(statustext, '^[?I]') >= 0
       let revision="NEW"
     elseif match(statustext, '^[R]') >= 0
       let revision="REMOVED"
     elseif match(statustext, '^[D]') >= 0
       let revision="DELETED"
     elseif match(statustext, '^[A]') >= 0
       let revision="ADDED"
     else
       " The file is tracked, we can try to get is revision number
       let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " parents "
       let statustext=system(hgCommand)
       if(v:shell_error)
           return ""
       endif
       let revision=substitute(statustext, '^changeset:\s*\(\d\+\):.*\_$\_.*$', '\1', "")
 
       if a:branchVar != "" && match(statustext, '^\_.*\_^branch:') >= 0
         let branch=substitute(statustext, '^\_.*\_^branch:\s*\(\S\+\)\n\_.*$', '\1', "")
         let returnExpression=returnExpression . " | let " . a:branchVar . "='" . branch . "'"
       endif
     endif
     if (exists('revision'))
       let returnExpression = "let " . a:revisionVar . "='" . revision . "' " . returnExpression
     endif
 
     return returnExpression
   finally
     execute 'cd' escape(oldCwd, ' ')
   endtry
 endfunction
 
 " Function: s:HGSetupBuffer() {{{2
 " Attempts to set the b:HGBranch, b:HGRevision and b:HGRepository variables.
 
 function! s:HGSetupBuffer(...)
   if (exists("b:HGBufferSetup") && b:HGBufferSetup && !exists('a:1'))
     " This buffer is already set up.
     return
   endif
 
   if !<SID>HGGetOption("HGCommandEnableBufferSetup", 0)
         \ || @% == ""
         \ || s:HGCommandEditFileRunning > 0
         \ || exists("b:HGOrigBuffNR")
     unlet! b:HGRevision
     unlet! b:HGBranch
     unlet! b:HGRepository
     return
   endif
 
   if !filereadable(expand("%"))
     return -1
   endif
 
   let revision=""
   let branch=""
   let repository=""
 
   exec <SID>HGGetStatusVars('revision', 'branch', 'repository')
   "echomsg "DBG ".revision."#".branch."#".repository
   if revision != ""
     let b:HGRevision=revision
   else
     unlet! b:HGRevision
   endif
   if branch != ""
     let b:HGBranch=branch
   else
     unlet! b:HGBranch
   endif
   if repository != ""
      let b:HGRepository=repository
   else
      unlet! b:HGRepository
   endif
   silent do HGCommand User HGBufferSetup
   let b:HGBufferSetup=1
 endfunction
 
 " Function: s:HGMarkOrigBufferForSetup(hgbuffer) {{{2
 " Resets the buffer setup state of the original buffer for a given HG buffer.
 " Returns:  The HG buffer number in a passthrough mode.
 
 function! s:HGMarkOrigBufferForSetup(hgBuffer)
   checktime
   if a:hgBuffer != -1
     let origBuffer = <SID>HGBufferCheck(a:hgBuffer)
     "This should never not work, but I'm paranoid
     if origBuffer != a:hgBuffer
       call setbufvar(origBuffer, "HGBufferSetup", 0)
     endif
   else
     "We are presumably in the original buffer
     let b:HGBufferSetup = 0
     "We do the setup now as now event will be triggered allowing it later.
     call <SID>HGSetupBuffer()
   endif
   return a:hgBuffer
 endfunction
 
 " Function: s:HGOverrideOption(option, [value]) {{{2
 " Provides a temporary override for the given HG option.  If no value is
 " passed, the override is disabled.
 
 function! s:HGOverrideOption(option, ...)
   if a:0 == 0
     unlet! s:{a:option}Override
   else
     let s:{a:option}Override = a:1
   endif
 endfunction
 
 " Function: s:HGWipeoutCommandBuffers() {{{2
 " Clears all current HG buffers of the specified type for a given source.
 
 function! s:HGWipeoutCommandBuffers(originalBuffer, hgCommand)
   let buffer = 1
   while buffer <= bufnr('$')
     if getbufvar(buffer, 'HGOrigBuffNR') == a:originalBuffer
       if getbufvar(buffer, 'HGCommand') == a:hgCommand
         execute 'bw' buffer
       endif
     endif
     let buffer = buffer + 1
   endwhile
 endfunction
 
 " Function: s:HGInstallDocumentation(full_name, revision)              {{{2
 "   Install help documentation.
 " Arguments:
 "   full_name: Full name of this vim plugin script, including path name.
 "   revision:  Revision of the vim script. #version# mark in the document file
 "              will be replaced with this string with 'v' prefix.
 " Return:
 "   1 if new document installed, 0 otherwise.
 " Note: Cleaned and generalized by guo-peng Wen
 "'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 " Helper function to make mkdir as portable as possible
 function! s:HGFlexiMkdir(dir)
   if exists("*mkdir") " we can use Vim's own mkdir()
     call mkdir(a:dir)
   elseif !exists("+shellslash")
     call system("mkdir -p '".a:dir."'")
   else " M$
     let l:ssl = &shellslash
     try
       set shellslash
       " no single quotes?
       call system('mkdir "'.a:dir.'"')
     finally
       let &shellslash = l:ssl
     endtry
   endif
 endfunction
 
 function! s:HGInstallDocumentation(full_name)
   " Figure out document path based on full name of this script:
   let l:vim_doc_path = fnamemodify(a:full_name, ":h:h") . "/doc"
   if filewritable(l:vim_doc_path) != 2
     echomsg s:script_name . ": Trying to update docs at" l:vim_doc_path
     silent! call <SID>HGFlexiMkdir(l:vim_doc_path)
     if filewritable(l:vim_doc_path) != 2
       " Try first item in 'runtimepath':
       let l:vim_doc_path =
             \ substitute(&runtimepath, '^\([^,]*\).*', '\1/doc', 'e')
       if filewritable(l:vim_doc_path) != 2
         echomsg s:script_name . ": Trying to update docs at" l:vim_doc_path
         silent! call <SID>HGFlexiMkdir(l:vim_doc_path)
         if filewritable(l:vim_doc_path) != 2
           " Put a warning:
           echomsg "Unable to open documentation directory"
           echomsg " type `:help add-local-help' for more information."
           return 0
         endif
       endif
     endif
   endif
 
   " Full name of documentation file:
   let l:doc_file =
         \ l:vim_doc_path . "/" . s:script_name . ".txt"
   " Bail out if document file is still up to date:
   if filereadable(l:doc_file)  &&
         \ getftime(a:full_name) < getftime(l:doc_file)
     return 0
   endif
 
   " temporary global settings
   let l:lz = &lazyredraw
   let l:hls = &hlsearch
   set lazyredraw nohlsearch
   " Create a new buffer & read in the plugin file (me):
   1 new
   setlocal noswapfile modifiable nomodeline
   if has("folding")
     setlocal nofoldenable
   endif
   silent execute "read" escape(a:full_name, " ")
   let l:doc_buf = bufnr("%")
 
   1
   " Delete from first line to a line starts with
   " === START_DOC
   silent 1,/^=\{3,}\s\+START_DOC\C/ delete _
   " Delete from a line starts with
   " === END_DOC
   " to the end of the documents:
   silent /^=\{3,}\s\+END_DOC\C/,$ delete _
 
   " Add modeline for help doc: the modeline string is mangled intentionally
   " to avoid it be recognized by VIM:
   call append(line("$"), "")
   call append(line("$"), " v" . "im:tw=78:ts=8:ft=help:norl:")
 
   " Replace revision:
   silent execute "normal :1s/#version#/" . s:script_version . "/\<CR>"
   " Save the help document and wipe out buffer:
   silent execute "wq!" escape(l:doc_file, " ") "| bw" l:doc_buf
   " Build help tags:
   silent execute "helptags" l:vim_doc_path
 
   let &hlsearch = l:hls
   let &lazyredraw = l:lz
   return 1
 endfunction
 
 " Section: Public functions {{{1
 
 " Function: HGGetRevision() {{{2
 " Global function for retrieving the current buffer's HG revision number.
 " Returns: Revision number or an empty string if an error occurs.
 
 function! HGGetRevision()
   let revision=""
   exec <SID>HGGetStatusVars('revision', '', '')
   return revision
 endfunction
 
 " Function: HGDisableBufferSetup() {{{2
 " Global function for deactivating the buffer autovariables.
 
 function! HGDisableBufferSetup()
   let g:HGCommandEnableBufferSetup=0
   silent! augroup! HGCommandPlugin
 endfunction
 
 " Function: HGEnableBufferSetup() {{{2
 " Global function for activating the buffer autovariables.
 
 function! HGEnableBufferSetup()
   let g:HGCommandEnableBufferSetup=1
   augroup HGCommandPlugin
     au!
     au BufEnter * call <SID>HGSetupBuffer()
     au BufWritePost * call <SID>HGSetupBuffer()
     " Force resetting up buffer on external file change (HG update)
     au FileChangedShell * call <SID>HGSetupBuffer(1)
   augroup END
 
   " Only auto-load if the plugin is fully loaded.  This gives other plugins a
   " chance to run.
   if g:loaded_hgcommand == 2
     call <SID>HGSetupBuffer()
   endif
 endfunction
 
 " Function: HGGetStatusLine() {{{2
 " Default (sample) status line entry for HG files.  This is only useful if
 " HG-managed buffer mode is on (see the HGCommandEnableBufferSetup variable
 " for how to do this).
 
 function! HGGetStatusLine()
   if exists('b:HGSourceFile')
     " This is a result buffer
     let value='[' . b:HGCommand . ' ' . b:HGSourceFile
     if exists('b:HGStatusText')
       let value=value . ' ' . b:HGStatusText
     endif
     let value = value . ']'
     return value
   endif
 
   if exists('b:HGRevision')
         \ && b:HGRevision != ''
         \ && exists('b:HGRepository')
         \ && b:HGRepository != ''
         \ && exists('g:HGCommandEnableBufferSetup')
         \ && g:HGCommandEnableBufferSetup
     if !exists('b:HGBranch')
       let l:branch=''
     else
       let l:branch=b:HGBranch
     endif
     return '[HG ' . b:HGRepository . '/' . l:branch .'/' . b:HGRevision . ']'
   else
     return ''
   endif
 endfunction
 
 " Section: HG command functions {{{1
 
 " Function: s:HGAdd() {{{2
 function! s:HGAdd()
   return <SID>HGMarkOrigBufferForSetup(<SID>HGDoCommand('add', 'hgadd', ''))
 endfunction
 
 " Function: s:HGAnnotate(...) {{{2
 function! s:HGAnnotate(...)
   if a:0 == 0
     if &filetype == "HGAnnotate"
       " This is a HGAnnotate buffer.  Perform annotation of the version
       " indicated by the current line.
       let revision = substitute(getline("."),'\(^[0-9]*\):.*','\1','')
       if <SID>HGGetOption('HGCommandAnnotateParent', 0) != 0 && revision > 0
         let revision = revision - 1
       endif
     else
       let revision=HGGetRevision()
       if revision == ""
         echoerr "Unable to obtain HG version information."
         return -1
       endif
     endif
   else
     let revision=a:1
   endif
 
   if revision == "NEW"
     echo "No annotatation available for new file."
     return -1
   endif
 
   let resultBuffer=<SID>HGDoCommand('annotate -ndu -r ' . revision, 'hgannotate', revision)
   "echomsg "DBG: ".resultBuffer
   if resultBuffer !=  -1
     set filetype=HGAnnotate
   endif
 
   return resultBuffer
 endfunction
 
 " Function: s:HGCommit() {{{2
 function! s:HGCommit(...)
   " Handle the commit message being specified.  If a message is supplied, it
   " is used; if bang is supplied, an empty message is used; otherwise, the
   " user is provided a buffer from which to edit the commit message.
   if a:2 != "" || a:1 == "!"
     return <SID>HGMarkOrigBufferForSetup(<SID>HGDoCommand('commit -m "' . a:2 . '"', 'hgcommit', ''))
   endif
 
   let hgBufferCheck=<SID>HGCurrentBufferCheck()
   if hgBufferCheck ==  -1
     echo "Original buffer no longer exists, aborting."
     return -1
   endif
 
   " Protect against windows' backslashes in paths.  They confuse exec'd
   " commands.
 
   let shellSlashBak = &shellslash
   try
     set shellslash
 
     let messageFileName = tempname()
 
     let fileName=bufname(hgBufferCheck)
     let realFilePath=<SID>HGResolveLink(fileName)
     let newCwd=fnamemodify(realFilePath, ':h')
     if strlen(newCwd) == 0
       " Account for autochdir being in effect, which will make this blank, but
       " we know we'll be in the current directory for the original file.
       let newCwd = getcwd()
     endif
 
     let realFileName=fnamemodify(realFilePath, ':t')
 
     if <SID>HGEditFile(messageFileName, hgBufferCheck) == -1
       return
     endif
 
     " Protect against case and backslash issues in Windows.
     let autoPattern = '\c' . messageFileName
 
-    " Ensure existance of group
+    " Ensure existence of group
     augroup HGCommit
     augroup END
 
     execute 'au HGCommit BufDelete' autoPattern 'call delete("' . messageFileName . '")'
     execute 'au HGCommit BufDelete' autoPattern 'au! HGCommit * ' autoPattern
 
     " Create a commit mapping.  The mapping must clear all autocommands in case
     " it is invoked when HGCommandCommitOnWrite is active, as well as to not
     " invoke the buffer deletion autocommand.
 
     execute 'nnoremap <silent> <buffer> <Plug>HGCommit '.
           \ ':au! HGCommit * ' . autoPattern . '<CR>'.
           \ ':g/^HG:/d<CR>'.
           \ ':update<CR>'.
           \ ':call <SID>HGFinishCommit("' . messageFileName . '",' .
           \                             '"' . newCwd . '",' .
           \                             '"' . realFileName . '",' .
           \                             hgBufferCheck . ')<CR>'
 
     silent 0put ='HG: ----------------------------------------------------------------------'
     silent put =\"HG: Enter Log.  Lines beginning with `HG:' are removed automatically\"
     silent put ='HG: Type <leader>cc (or your own <Plug>HGCommit mapping)'
 
     if <SID>HGGetOption('HGCommandCommitOnWrite', 1) == 1
       execute 'au HGCommit BufWritePre' autoPattern 'g/^HG:/d'
       execute 'au HGCommit BufWritePost' autoPattern 'call <SID>HGFinishCommit("' . messageFileName . '", "' . newCwd . '", "' . realFileName . '", ' . hgBufferCheck . ') | au! * ' autoPattern
       silent put ='HG: or write this buffer'
     endif
 
     silent put ='HG: to finish this commit operation'
     silent put ='HG: ----------------------------------------------------------------------'
     $
     let b:HGSourceFile=fileName
     let b:HGCommand='HGCommit'
     set filetype=hg
   finally
     let &shellslash = shellSlashBak
   endtry
 
 endfunction
 
 " Function: s:HGDiff(...) {{{2
 function! s:HGDiff(...)
   if a:0 == 1
     let revOptions = '-r' . a:1
     let caption = a:1 . ' -> current'
   elseif a:0 == 2
     let revOptions = '-r' . a:1 . ' -r' . a:2
     let caption = a:1 . ' -> ' . a:2
   else
     let revOptions = ''
     let caption = ''
   endif
 
   let hgdiffopt=<SID>HGGetOption('HGCommandDiffOpt', 'w')
 
   if hgdiffopt == ""
     let diffoptionstring=""
   else
     let diffoptionstring=" -" . hgdiffopt . " "
   endif
 
   let resultBuffer = <SID>HGDoCommand('diff ' . diffoptionstring . revOptions , 'hgdiff', caption)
   if resultBuffer != -1
     set filetype=diff
   endif
   return resultBuffer
 endfunction
 
 
 " Function: s:HGGotoOriginal(["!]) {{{2
 function! s:HGGotoOriginal(...)
   let origBuffNR = <SID>HGCurrentBufferCheck()
   if origBuffNR > 0
     let origWinNR = bufwinnr(origBuffNR)
     if origWinNR == -1
       execute 'buffer' origBuffNR
     else
       execute origWinNR . 'wincmd w'
     endif
     if a:0 == 1
       if a:1 == "!"
         let buffnr = 1
         let buffmaxnr = bufnr("$")
         while buffnr <= buffmaxnr
           if getbufvar(buffnr, "HGOrigBuffNR") == origBuffNR
             execute "bw" buffnr
           endif
           let buffnr = buffnr + 1
         endwhile
       endif
     endif
   endif
 endfunction
 
 " Function: s:HGFinishCommit(messageFile, targetDir, targetFile) {{{2
 function! s:HGFinishCommit(messageFile, targetDir, targetFile, origBuffNR)
   if filereadable(a:messageFile)
     let oldCwd=getcwd()
     if strlen(a:targetDir) > 0
       execute 'cd' escape(a:targetDir, ' ')
     endif
     let resultBuffer=<SID>HGCreateCommandBuffer('commit -l "' . a:messageFile . '" "'. a:targetFile . '"', 'hgcommit', '', a:origBuffNR)
     execute 'cd' escape(oldCwd, ' ')
     execute 'bw' escape(a:messageFile, ' *?\')
     silent execute 'call delete("' . a:messageFile . '")'
     return <SID>HGMarkOrigBufferForSetup(resultBuffer)
   else
     echoerr "Can't read message file; no commit is possible."
     return -1
   endif
 endfunction
 
 " Function: s:HGLog() {{{2
 function! s:HGLog(...)
   if a:0 == 0
     let versionOption = ""
     let caption = ''
   else
     let versionOption=" -r" . a:1
     let caption = a:1
   endif
 
   let resultBuffer=<SID>HGDoCommand('log' . versionOption, 'hglog', caption)
   if resultBuffer != ""
     set filetype=rcslog
   endif
   return resultBuffer
 endfunction
 
 " Function: s:HGRevert() {{{2
 function! s:HGRevert()
   return <SID>HGMarkOrigBufferForSetup(<SID>HGDoCommand('revert', 'hgrevert', ''))
 endfunction
 
 " Function: s:HGReview(...) {{{2
 function! s:HGReview(...)
   if a:0 == 0
     let versiontag=""
     if <SID>HGGetOption('HGCommandInteractive', 0)
       let versiontag=input('Revision:  ')
     endif
     if versiontag == ""
       let versiontag="(current)"
       let versionOption=""
     else
       let versionOption=" -r " . versiontag . " "
     endif
   else
     let versiontag=a:1
     let versionOption=" -r " . versiontag . " "
   endif
 
   let resultBuffer = <SID>HGDoCommand('cat' . versionOption, 'hgreview', versiontag)
   if resultBuffer > 0
     let &filetype=getbufvar(b:HGOrigBuffNR, '&filetype')
   endif
 
   return resultBuffer
 endfunction
 
 " Function: s:HGStatus() {{{2
 function! s:HGStatus()
   return <SID>HGDoCommand('status', 'hgstatus', '')
 endfunction
 
 
 " Function: s:HGUpdate() {{{2
 function! s:HGUpdate()
   return <SID>HGMarkOrigBufferForSetup(<SID>HGDoCommand('update', 'update', ''))
 endfunction
 
 " Function: s:HGVimDiff(...) {{{2
 function! s:HGVimDiff(...)
   let originalBuffer = <SID>HGCurrentBufferCheck()
   let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning + 1
   try
     " If there's already a VimDiff'ed window, restore it.
     " There may only be one HGVimDiff original window at a time.
 
     if exists("s:vimDiffSourceBuffer") && s:vimDiffSourceBuffer != originalBuffer
       " Clear the existing vimdiff setup by removing the result buffers.
       call <SID>HGWipeoutCommandBuffers(s:vimDiffSourceBuffer, 'vimdiff')
     endif
 
     " Split and diff
     if(a:0 == 2)
       " Reset the vimdiff system, as 2 explicit versions were provided.
       if exists('s:vimDiffSourceBuffer')
         call <SID>HGWipeoutCommandBuffers(s:vimDiffSourceBuffer, 'vimdiff')
       endif
       let resultBuffer = <SID>HGReview(a:1)
       if resultBuffer < 0
         echomsg "Can't open HG revision " . a:1
         return resultBuffer
       endif
       let b:HGCommand = 'vimdiff'
       diffthis
       let s:vimDiffBufferCount = 1
       let s:vimDiffScratchList = '{'. resultBuffer . '}'
       " If no split method is defined, cheat, and set it to vertical.
       try
         call <SID>HGOverrideOption('HGCommandSplit', <SID>HGGetOption('HGCommandDiffSplit', <SID>HGGetOption('HGCommandSplit', 'vertical')))
         let resultBuffer=<SID>HGReview(a:2)
       finally
         call <SID>HGOverrideOption('HGCommandSplit')
       endtry
       if resultBuffer < 0
         echomsg "Can't open HG revision " . a:1
         return resultBuffer
       endif
       let b:HGCommand = 'vimdiff'
       diffthis
       let s:vimDiffBufferCount = 2
       let s:vimDiffScratchList = s:vimDiffScratchList . '{'. resultBuffer . '}'
     else
       " Add new buffer
       try
         " Force splitting behavior, otherwise why use vimdiff?
         call <SID>HGOverrideOption("HGCommandEdit", "split")
         call <SID>HGOverrideOption("HGCommandSplit", <SID>HGGetOption('HGCommandDiffSplit', <SID>HGGetOption('HGCommandSplit', 'vertical')))
         if(a:0 == 0)
           let resultBuffer=<SID>HGReview()
         else
           let resultBuffer=<SID>HGReview(a:1)
         endif
       finally
         call <SID>HGOverrideOption("HGCommandEdit")
         call <SID>HGOverrideOption("HGCommandSplit")
       endtry
       if resultBuffer < 0
         echomsg "Can't open current HG revision"
         return resultBuffer
       endif
       let b:HGCommand = 'vimdiff'
       diffthis
 
       if !exists('s:vimDiffBufferCount')
         " New instance of vimdiff.
         let s:vimDiffBufferCount = 2
         let s:vimDiffScratchList = '{' . resultBuffer . '}'
 
         " This could have been invoked on a HG result buffer, not the
         " original buffer.
         wincmd W
         execute 'buffer' originalBuffer
         " Store info for later original buffer restore
         let s:vimDiffRestoreCmd =
               \    "call setbufvar(".originalBuffer.", \"&diff\", ".getbufvar(originalBuffer, '&diff').")"
               \ . "|call setbufvar(".originalBuffer.", \"&foldcolumn\", ".getbufvar(originalBuffer, '&foldcolumn').")"
               \ . "|call setbufvar(".originalBuffer.", \"&foldenable\", ".getbufvar(originalBuffer, '&foldenable').")"
               \ . "|call setbufvar(".originalBuffer.", \"&foldmethod\", '".getbufvar(originalBuffer, '&foldmethod')."')"
               \ . "|call setbufvar(".originalBuffer.", \"&scrollbind\", ".getbufvar(originalBuffer, '&scrollbind').")"
               \ . "|call setbufvar(".originalBuffer.", \"&wrap\", ".getbufvar(originalBuffer, '&wrap').")"
               \ . "|if &foldmethod=='manual'|execute 'normal! zE'|endif"
         diffthis
         wincmd w
       else
         " Adding a window to an existing vimdiff
         let s:vimDiffBufferCount = s:vimDiffBufferCount + 1
         let s:vimDiffScratchList = s:vimDiffScratchList . '{' . resultBuffer . '}'
       endif
     endif
 
     let s:vimDiffSourceBuffer = originalBuffer
 
     " Avoid executing the modeline in the current buffer after the autocommand.
 
     let currentBuffer = bufnr('%')
     let saveModeline = getbufvar(currentBuffer, '&modeline')
     try
       call setbufvar(currentBuffer, '&modeline', 0)
       silent do HGCommand User HGVimDiffFinish
     finally
       call setbufvar(currentBuffer, '&modeline', saveModeline)
     endtry
     return resultBuffer
   finally
     let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning - 1
   endtry
 endfunction
 
 " Section: Command definitions {{{1
 " Section: Primary commands {{{2
 com! HGAdd call <SID>HGAdd()
 com! -nargs=? HGAnnotate call <SID>HGAnnotate(<f-args>)
 com! -bang -nargs=? HGCommit call <SID>HGCommit(<q-bang>, <q-args>)
 com! -nargs=* HGDiff call <SID>HGDiff(<f-args>)
 com! -bang HGGotoOriginal call <SID>HGGotoOriginal(<q-bang>)
 com! -nargs=? HGLog call <SID>HGLog(<f-args>)
 com! HGRevert call <SID>HGRevert()
 com! -nargs=? HGReview call <SID>HGReview(<f-args>)
 com! HGStatus call <SID>HGStatus()
 com! HGUpdate call <SID>HGUpdate()
 com! -nargs=* HGVimDiff call <SID>HGVimDiff(<f-args>)
 
 " Section: HG buffer management commands {{{2
 com! HGDisableBufferSetup call HGDisableBufferSetup()
 com! HGEnableBufferSetup call HGEnableBufferSetup()
 
 " Allow reloading hgcommand.vim
 com! HGReload unlet! g:loaded_hgcommand | runtime plugin/hgcommand.vim
 
 " Section: Plugin command mappings {{{1
 nnoremap <silent> <Plug>HGAdd :HGAdd<CR>
 nnoremap <silent> <Plug>HGAnnotate :HGAnnotate<CR>
 nnoremap <silent> <Plug>HGCommit :HGCommit<CR>
 nnoremap <silent> <Plug>HGDiff :HGDiff<CR>
 nnoremap <silent> <Plug>HGGotoOriginal :HGGotoOriginal<CR>
 nnoremap <silent> <Plug>HGClearAndGotoOriginal :HGGotoOriginal!<CR>
 nnoremap <silent> <Plug>HGLog :HGLog<CR>
 nnoremap <silent> <Plug>HGRevert :HGRevert<CR>
 nnoremap <silent> <Plug>HGReview :HGReview<CR>
 nnoremap <silent> <Plug>HGStatus :HGStatus<CR>
 nnoremap <silent> <Plug>HGUpdate :HGUpdate<CR>
 nnoremap <silent> <Plug>HGVimDiff :HGVimDiff<CR>
 
 " Section: Default mappings {{{1
 if !hasmapto('<Plug>HGAdd')
   nmap <unique> <Leader>hga <Plug>HGAdd
 endif
 if !hasmapto('<Plug>HGAnnotate')
   nmap <unique> <Leader>hgn <Plug>HGAnnotate
 endif
 if !hasmapto('<Plug>HGClearAndGotoOriginal')
   nmap <unique> <Leader>hgG <Plug>HGClearAndGotoOriginal
 endif
 if !hasmapto('<Plug>HGCommit')
   nmap <unique> <Leader>hgc <Plug>HGCommit
 endif
 if !hasmapto('<Plug>HGDiff')
   nmap <unique> <Leader>hgd <Plug>HGDiff
 endif
 if !hasmapto('<Plug>HGGotoOriginal')
   nmap <unique> <Leader>hgg <Plug>HGGotoOriginal
 endif
 if !hasmapto('<Plug>HGLog')
   nmap <unique> <Leader>hgl <Plug>HGLog
 endif
 if !hasmapto('<Plug>HGRevert')
   nmap <unique> <Leader>hgq <Plug>HGRevert
 endif
 if !hasmapto('<Plug>HGReview')
   nmap <unique> <Leader>hgr <Plug>HGReview
 endif
 if !hasmapto('<Plug>HGStatus')
   nmap <unique> <Leader>hgs <Plug>HGStatus
 endif
 if !hasmapto('<Plug>HGUpdate')
   nmap <unique> <Leader>hgu <Plug>HGUpdate
 endif
 if !hasmapto('<Plug>HGVimDiff')
   nmap <unique> <Leader>hgv <Plug>HGVimDiff
 endif
 
 " Section: Menu items {{{1
 silent! aunmenu Plugin.HG
 amenu <silent> &Plugin.HG.&Add        <Plug>HGAdd
 amenu <silent> &Plugin.HG.A&nnotate   <Plug>HGAnnotate
 amenu <silent> &Plugin.HG.&Commit     <Plug>HGCommit
 amenu <silent> &Plugin.HG.&Diff       <Plug>HGDiff
 amenu <silent> &Plugin.HG.&Log        <Plug>HGLog
 amenu <silent> &Plugin.HG.Revert      <Plug>HGRevert
 amenu <silent> &Plugin.HG.&Review     <Plug>HGReview
 amenu <silent> &Plugin.HG.&Status     <Plug>HGStatus
 amenu <silent> &Plugin.HG.&Update     <Plug>HGUpdate
 amenu <silent> &Plugin.HG.&VimDiff    <Plug>HGVimDiff
 
 " Section: Autocommands to restore vimdiff state {{{1
 function! s:HGVimDiffRestore(vimDiffBuff)
   let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning + 1
   try
     if exists("s:vimDiffSourceBuffer")
       if a:vimDiffBuff == s:vimDiffSourceBuffer
         " Original file is being removed.
         unlet! s:vimDiffSourceBuffer
         unlet! s:vimDiffBufferCount
         unlet! s:vimDiffRestoreCmd
         unlet! s:vimDiffScratchList
       elseif match(s:vimDiffScratchList, '{' . a:vimDiffBuff . '}') >= 0
         let s:vimDiffScratchList = substitute(s:vimDiffScratchList, '{' . a:vimDiffBuff . '}', '', '')
         let s:vimDiffBufferCount = s:vimDiffBufferCount - 1
         if s:vimDiffBufferCount == 1 && exists('s:vimDiffRestoreCmd')
           " All scratch buffers are gone, reset the original.
           " Only restore if the source buffer is still in Diff mode
 
           let sourceWinNR=bufwinnr(s:vimDiffSourceBuffer)
           if sourceWinNR != -1
             " The buffer is visible in at least one window
             let currentWinNR = winnr()
             while winbufnr(sourceWinNR) != -1
               if winbufnr(sourceWinNR) == s:vimDiffSourceBuffer
                 execute sourceWinNR . 'wincmd w'
                 if getwinvar('', "&diff")
                   execute s:vimDiffRestoreCmd
                 endif
               endif
               let sourceWinNR = sourceWinNR + 1
             endwhile
             execute currentWinNR . 'wincmd w'
           else
             " The buffer is hidden.  It must be visible in order to set the
             " diff option.
             let currentBufNR = bufnr('')
             execute "hide buffer" s:vimDiffSourceBuffer
             if getwinvar('', "&diff")
               execute s:vimDiffRestoreCmd
             endif
             execute "hide buffer" currentBufNR
           endif
 
           unlet s:vimDiffRestoreCmd
           unlet s:vimDiffSourceBuffer
           unlet s:vimDiffBufferCount
           unlet s:vimDiffScratchList
         elseif s:vimDiffBufferCount == 0
           " All buffers are gone.
           unlet s:vimDiffSourceBuffer
           unlet s:vimDiffBufferCount
           unlet s:vimDiffScratchList
         endif
       endif
     endif
   finally
     let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning - 1
   endtry
 endfunction
 
 augroup HGVimDiffRestore
   au!
   au BufUnload * call <SID>HGVimDiffRestore(expand("<abuf>"))
 augroup END
 
 " Section: Optional activation of buffer management {{{1
 
 if s:HGGetOption('HGCommandEnableBufferSetup', 1)
   call HGEnableBufferSetup()
 endif
 
 " Section: Doc installation {{{1
 
 if <SID>HGInstallDocumentation(expand("<sfile>:p"))
   echomsg s:script_name s:script_version . ": updated documentation"
 endif
 
 " Section: Plugin completion {{{1
 
 " delete one-time vars and functions
 delfunction <SID>HGInstallDocumentation
 delfunction <SID>HGFlexiMkdir
 delfunction <SID>HGCleanupOnFailure
 unlet s:script_version s:script_name
 
 let g:loaded_hgcommand=2
 silent do HGCommand User HGPluginFinish
 
 let &cpo = s:save_cpo
 unlet s:save_cpo
 " vim:se expandtab sts=2 sw=2:
 finish
 
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 " Section: Documentation content                                          {{{1
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 === START_DOC
 *hgcommand.txt*	  Mercurial vim integration		             #version#
 
 
 			 HGCOMMAND REFERENCE MANUAL~
 
 
 Author:  Mathieu Clabaut <[e-mail]>
 Credits:  Bob Hiestand <[e-mail]>
 Mercurial: http://mercurial.selenic.com/
    Mercurial (noted Hg) is a fast, lightweight Source Control Management
    system designed for efficient handling of very large distributed projects.
 
 ==============================================================================
 1. Contents						  *hgcommand-contents*
 
 	Installation		: |hgcommand-install|
         HGCommand Intro	        : |hgcommand|
 	HGCommand Manual	: |hgcommand-manual|
 	Customization		: |hgcommand-customize|
 	Bugs			: |hgcommand-bugs|
 
 ==============================================================================
 2. HGCommand Installation				   *hgcommand-install*
 
    In order to install the plugin, place the hgcommand.vim file into a plugin'
    directory in your runtime path (please see |add-global-plugin| and
    |'runtimepath'|.
 
    HGCommand may be customized by setting variables, creating maps, and
    specifying event handlers.  Please see |hgcommand-customize| for more
    details.
 
                                                          *hgcommand-auto-help*
    The help file is automagically generated when the |hgcommand| script is
    loaded for the first time.
 
 ==============================================================================
 
 3. HGCommand Intro					           *hgcommand*
                                                              *hgcommand-intro*
 
    The HGCommand plugin provides global ex commands for manipulating
    HG-controlled source files.  In general, each command operates on the
    current buffer and accomplishes a separate hg function, such as update,
    commit, log, and others (please see |hgcommand-commands| for a list of all
    available commands).  The results of each operation are displayed in a
    scratch buffer.  Several buffer variables are defined for those scratch
    buffers (please see |hgcommand-buffer-variables|).
 
    The notion of "current file" means either the current buffer, or, in the
    case of a directory buffer, the file on the current line within the buffer.
 
    For convenience, any HGCommand invoked on a HGCommand scratch buffer acts
    as though it was invoked on the original file and splits the screen so that
    the output appears in a new window.
 
    Many of the commands accept revisions as arguments.  By default, most
    operate on the most recent revision on the current branch if no revision is
    specified (though see |HGCommandInteractive| to prompt instead).
 
    Each HGCommand is mapped to a key sequence starting with the <Leader>
    keystroke.  The default mappings may be overridden by supplying different
    mappings before the plugin is loaded, such as in the vimrc, in the standard
    fashion for plugin mappings.  For examples, please see
    |hgcommand-mappings-override|.
 
    The HGCommand plugin may be configured in several ways.  For more details,
    please see |hgcommand-customize|.
 
 ==============================================================================
 4. HGCommand Manual					    *hgcommand-manual*
 
 4.1 HGCommand commands					  *hgcommand-commands*
 
    HGCommand defines the following commands:
 
       |:HGAdd|
       |:HGAnnotate|
       |:HGCommit|
       |:HGDiff|
       |:HGGotoOriginal|
       |:HGLog|
       |:HGRevert|
       |:HGReview|
       |:HGStatus|
       |:HGUpdate|
       |:HGVimDiff|
 
 :HGAdd							              *:HGAdd*
 
    This command performs "hg add" on the current file.  Please note, this does
    not commit the newly-added file.
 
 :HGAnnotate						         *:HGAnnotate*
 
    This command performs "hg annotate" on the current file.  If an argument is
    given, the argument is used as a revision number to display.  If not given
    an argument, it uses the most recent version of the file on the current
    branch.  Additionally, if the current buffer is a HGAnnotate buffer
    already, the version number on the current line is used.
 
    If the |HGCommandAnnotateParent| variable is set to a non-zero value, the
    version previous to the one on the current line is used instead.  This
    allows one to navigate back to examine the previous version of a line.
 
    The filetype of the HGCommand scratch buffer is set to 'HGAnnotate', to
    take advantage of the bundled syntax file.
 
 
 :HGCommit[!]						           *:HGCommit*
 
    If called with arguments, this performs "hg commit" using the arguments as
    the log message.
 
    If '!' is used with no arguments, an empty log message is committed.
 
    If called with no arguments, this is a two-step command.  The first step
    opens a buffer to accept a log message.  When that buffer is written, it is
    automatically closed and the file is committed using the information from
    that log message.  The commit can be abandoned if the log message buffer is
    deleted or wiped before being written.
 
    Alternatively, the mapping that is used to invoke :HGCommit (by default
    <Leader>hgc) can be used in the log message buffer to immediately commit.
    This is useful if the |HGCommandCommitOnWrite| variable is set to 0 to
    disable the normal commit-on-write behavior.
 
 :HGDiff						                     *:HGDiff*
 
    With no arguments, this performs "hg diff" on the current file against the
    current repository version.
 
    With one argument, "hg diff" is performed on the current file against the
    specified revision.
 
    With two arguments, hg diff is performed between the specified revisions of
    the current file.
 
    This command uses the 'HGCommandDiffOpt' variable to specify diff options.
    If that variable does not exist, then 'wbBc' is assumed.  If you wish to
    have no options, then set it to the empty string.
 
 
 :HGGotoOriginal					             *:HGGotoOriginal*
 
    This command returns the current window to the source buffer, if the
    current buffer is a HG command output buffer.
 
 :HGGotoOriginal!
 
    Like ":HGGotoOriginal" but also executes :bufwipeout on all HG command
    output buffers for the source buffer.
 
 :HGLog							              *:HGLog*
 
    Performs "hg log" on the current file.
 
    If an argument is given, it is passed as an argument to the "-r" option of
    "hg log".
 
 :HGRevert						           *:HGRevert*
 
    Replaces the current file with the most recent version from the repository
    in order to wipe out any undesired changes.
 
 :HGReview						           *:HGReview*
 
    Retrieves a particular version of the current file.  If no argument is
    given, the most recent version of the file on the current branch is
    retrieved.  Otherwise, the specified version is retrieved.
 
 :HGStatus					 	           *:HGStatus*
 
    Performs "hg status" on the current file.
 
 :HGUpdate						           *:HGUpdate*
 
    Performs "hg update" on the current file.  This intentionally does not
    automatically reload the current buffer, though vim should prompt the user
    to do so if the underlying file is altered by this command.
 
 :HGVimDiff						          *:HGVimDiff*
 
    With no arguments, this prompts the user for a revision and then uses
    vimdiff to display the differences between the current file and the
    specified revision.  If no revision is specified, the most recent version
    of the file on the current branch is used.
 
    With one argument, that argument is used as the revision as above.  With
    two arguments, the differences between the two revisions is displayed using
    vimdiff.
 
    With either zero or one argument, the original buffer is used to perform
    the vimdiff.  When the other buffer is closed, the original buffer will be
    returned to normal mode.
 
    Once vimdiff mode is started using the above methods, additional vimdiff
    buffers may be added by passing a single version argument to the command.
    There may be up to 4 vimdiff buffers total.
 
    Using the 2-argument form of the command resets the vimdiff to only those 2
    versions.  Additionally, invoking the command on a different file will
    close the previous vimdiff buffers.
 
 
 4.2 Mappings						  *hgcommand-mappings*
 
    By default, a mapping is defined for each command.  These mappings execute
    the default (no-argument) form of each command.
 
       <Leader>hga HGAdd
       <Leader>hgn HGAnnotate
       <Leader>hgc HGCommit
       <Leader>hgd HGDiff
       <Leader>hgg HGGotoOriginal
       <Leader>hgG HGGotoOriginal!
       <Leader>hgl HGLog
       <Leader>hgr HGReview
       <Leader>hgs HGStatus
       <Leader>hgu HGUpdate
       <Leader>hgv HGVimDiff
 
                                                  *hgcommand-mappings-override*
 
    The default mappings can be overridden by user-provided instead by mapping
    to <Plug>CommandName.  This is especially useful when these mappings
    collide with other existing mappings (vim will warn of this during plugin
    initialization, but will not clobber the existing mappings).
 
    For instance, to override the default mapping for :HGAdd to set it to
    '\add', add the following to the vimrc: >
 
       nmap \add <Plug>HGAdd
 <
 4.3 Automatic buffer variables			  *hgcommand-buffer-variables*
 
    Several buffer variables are defined in each HGCommand result buffer.
    These may be useful for additional customization in callbacks defined in
    the event handlers (please see |hgcommand-events|).
 
    The following variables are automatically defined:
 
 b:hgOrigBuffNR						      *b:hgOrigBuffNR*
 
    This variable is set to the buffer number of the source file.
 
 b:hgcmd						                     *b:hgcmd*
 
    This variable is set to the name of the hg command that created the result
    buffer.
 ==============================================================================
 
 5. Configuration and customization			 *hgcommand-customize*
                                                             *hgcommand-config*
 
    The HGCommand plugin can be configured in two ways:  by setting
    configuration variables (see |hgcommand-options|) or by defining HGCommand
    event handlers (see |hgcommand-events|).  Additionally, the HGCommand
    plugin provides several option for naming the HG result buffers (see
    |hgcommand-naming|) and supported a customized status line (see
    |hgcommand-statusline| and |hgcommand-buffer-management|).
 
 5.1 HGCommand configuration variables			   *hgcommand-options*
 
    Several variables affect the plugin's behavior.  These variables are
    checked at time of execution, and may be defined at the window, buffer, or
    global level and are checked in that order of precedence.
 
 
    The following variables are available:
 
       |HGCommandAnnotateParent|
       |HGCommandCommitOnWrite|
       |HGCommandHGExec|
       |HGCommandDeleteOnHide|
       |HGCommandDiffOpt|
       |HGCommandDiffSplit|
       |HGCommandEdit|
       |HGCommandEnableBufferSetup|
       |HGCommandInteractive|
       |HGCommandNameMarker|
       |HGCommandNameResultBuffers|
       |HGCommandSplit|
 
 HGCommandAnnotateParent			             *HGCommandAnnotateParent*
 
    This variable, if set to a non-zero value, causes the zero-argument form of
    HGAnnotate when invoked on a HGAnnotate buffer to go to the version
    previous to that displayed on the current line. If not set, it defaults to
    0.
 
 HGCommandCommitOnWrite				      *HGCommandCommitOnWrite*
 
    This variable, if set to a non-zero value, causes the pending hg commit to
    take place immediately as soon as the log message buffer is written.  If
    set to zero, only the HGCommit mapping will cause the pending commit to
    occur.  If not set, it defaults to 1.
 
 HGCommandHGExec				                     *HGCommandHGExec*
 
    This variable controls the executable used for all HG commands.  If not
    set, it defaults to "hg".
 
 HGCommandDeleteOnHide				       *HGCommandDeleteOnHide*
 
    This variable, if set to a non-zero value, causes the temporary HG result
    buffers to automatically delete themselves when hidden.
 
 HGCommandDiffOpt				            *HGCommandDiffOpt*
 
    This variable, if set, determines the options passed to the diff command of
    HG.  If not set, it defaults to 'w'.
 
 HGCommandDiffSplit				          *HGCommandDiffSplit*
 
    This variable overrides the |HGCommandSplit| variable, but only for buffers
    created with |:HGVimDiff|.
 
 HGCommandEdit					               *HGCommandEdit*
 
    This variable controls whether the original buffer is replaced ('edit') or
    split ('split').  If not set, it defaults to 'edit'.
 
 HGCommandEnableBufferSetup			  *HGCommandEnableBufferSetup*
 
    This variable, if set to a non-zero value, activates HG buffer management
    mode see (|hgcommand-buffer-management|).  This mode means that three
    buffer variables, 'HGRepository', 'HGRevision' and 'HGBranch', are set if
    the file is HG-controlled.  This is useful for displaying version
    information in the status bar.
 
 HGCommandInteractive				        *HGCommandInteractive*
 
    This variable, if set to a non-zero value, causes appropriate commands (for
    the moment, only |:HGReview|) to query the user for a revision to use
    instead of the current revision if none is specified.
 
 HGCommandNameMarker				         *HGCommandNameMarker*
 
    This variable, if set, configures the special attention-getting characters
    that appear on either side of the hg buffer type in the buffer name.  This
    has no effect unless |HGCommandNameResultBuffers| is set to a true value.
    If not set, it defaults to '_'.
 
 HGCommandNameResultBuffers			  *HGCommandNameResultBuffers*
 
    This variable, if set to a true value, causes the hg result buffers to be
    named in the old way ('<source file name> _<hg command>_').  If not set or
    set to a false value, the result buffer is nameless.
 
 HGCommandSplit					              *HGCommandSplit*
 
    This variable controls the orientation of the various window splits that
    may occur (such as with HGVimDiff, when using a HG command on a HG command
    buffer, or when the |HGCommandEdit| variable is set to 'split'.  If set to
    'horizontal', the resulting windows will be on stacked on top of one
    another.  If set to 'vertical', the resulting windows will be side-by-side.
    If not set, it defaults to 'horizontal' for all but HGVimDiff windows.
 
 5.2 HGCommand events				            *hgcommand-events*
 
    For additional customization, HGCommand can trigger user-defined events.
    Event handlers are provided by defining User event autocommands (see
    |autocommand|, |User|) in the HGCommand group with patterns matching the
    event name.
 
    For instance, the following could be added to the vimrc to provide a 'q'
    mapping to quit a HGCommand scratch buffer: >
 
       augroup HGCommand
          au HGCommand User HGBufferCreated silent! nmap <unique> <buffer> q:
          bwipeout<cr>
       augroup END
 <
 
    The following hooks are available:
 
 HGBufferCreated		This event is fired just after a hg command result
                         buffer is created and filled with the result of a hg
                         command.  It is executed within the context of the HG
                         command buffer.  The HGCommand buffer variables may be
                         useful for handlers of this event (please see
                         |hgcommand-buffer-variables|).
 
 HGBufferSetup		This event is fired just after HG buffer setup occurs,
                         if enabled.
 
 HGPluginInit		This event is fired when the HGCommand plugin first
                         loads.
 
 HGPluginFinish		This event is fired just after the HGCommand plugin
                         loads.
 
 HGVimDiffFinish		This event is fired just after the HGVimDiff command
                         executes to allow customization of, for instance,
                         window placement and focus.
 
 5.3 HGCommand buffer naming				    *hgcommand-naming*
 
    By default, the buffers containing the result of HG commands are nameless
    scratch buffers.  It is intended that buffer variables of those buffers be
    used to customize the statusline option so that the user may fully control
    the display of result buffers.
 
    If the old-style naming is desired, please enable the
    |HGCommandNameResultBuffers| variable.  Then, each result buffer will
    receive a unique name that includes the source file name, the HG command,
    and any extra data (such as revision numbers) that were part of the
    command.
 
 5.4 HGCommand status line support			*hgcommand-statusline*
 
    It is intended that the user will customize the |'statusline'| option to
    include HG result buffer attributes.  A sample function that may be used in
    the |'statusline'| option is provided by the plugin, HGGetStatusLine().  In
    order to use that function in the status line, do something like the
    following: >
 
       set statusline=%<%f\ %{HGGetStatusLine()}\ %h%m%r%=%l,%c%V\ %P
 <
    of which %{HGGetStatusLine()} is the relevant portion.
 
    The sample HGGetStatusLine() function handles both HG result buffers and
    HG-managed files if HGCommand buffer management is enabled (please see
    |hgcommand-buffer-management|).
 
 5.5 HGCommand buffer management		         *hgcommand-buffer-management*
 
    The HGCommand plugin can operate in buffer management mode, which means
    that it attempts to set two buffer variables ('HGRevision' and 'HGBranch')
    upon entry into a buffer.  This is rather slow because it means that 'hg
    status' will be invoked at each entry into a buffer (during the |BufEnter|
    autocommand).
 
    This mode is enabled by default.  In order to disable it, set the
    |HGCommandEnableBufferSetup| variable to a false (zero) value.  Enabling
    this mode simply provides the buffer variables mentioned above.  The user
    must explicitly include those in the |'statusline'| option if they are to
    appear in the status line (but see |hgcommand-statusline| for a simple way
    to do that).
 
 ==============================================================================
 9. Tips							      *hgcommand-tips*
 
 9.1 Split window annotation, by Michael Anderson >
 
    :nmap <Leader>hgN :vs<CR><C-w>h<Leader>hgn:vertical res 40<CR>
                  \ggdddd:set scb<CR>:set nowrap<CR><C-w>lgg:set scb<CR>
                  \:set nowrap<CR>
 <
 
    This splits the buffer vertically, puts an annotation on the left (minus
    the header) with the width set to 40. An editable/normal copy is placed on
    the right.  The two versions are scroll locked so they  move as one. and
    wrapping is turned off so that the lines line up correctly. The advantages
    are...
 
    1) You get a versioning on the right.
    2) You can still edit your own code.
    3) Your own code still has syntax highlighting.
 
 ==============================================================================
 
 8. Known bugs						      *hgcommand-bugs*
 
    Please let me know if you run across any.
 
    HGVimDiff, when using the original (real) source buffer as one of the diff
    buffers, uses some hacks to try to restore the state of the original buffer
    when the scratch buffer containing the other version is destroyed.  There
    may still be bugs in here, depending on many configuration details.
 
 ==============================================================================
 
 9. TODO  						      *hgcommand-todo*
 
    Integrate symlink tracking once HG will support them.
 ==============================================================================
 === END_DOC
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 " v im:tw=78:ts=8:ft=help:norl:
 " vim600: set foldmethod=marker  tabstop=8 shiftwidth=2 softtabstop=2 smartindent smarttab  :
 "fileencoding=iso-8859-15

contrib/vim/patchreview.vim

@@ -1,868 +1,868 b''
 " VIM plugin for doing single, multi-patch or diff code reviews {{{
 " Home:  http://www.vim.org/scripts/script.php?script_id=1563
 
 " Version       : 0.2.2                                        "{{{
 " Author        : Manpreet Singh < [e-mail] >
 " Copyright     : 2006-2010 by Manpreet Singh
 " License       : This file is placed in the public domain.
 "                 No warranties express or implied. Use at your own risk.
 "
 " Changelog :
 "
 "   0.2.2 - Security fixes by removing custom tempfile creation
 "         - Removed need for DiffReviewCleanup/PatchReviewCleanup
 "         - Better command execution error detection and display
 "         - Improved diff view and folding by ignoring modelines
 "         - Improved tab labels display
 "
 "   0.2.1 - Minor temp directory autodetection logic and cleanup
 "
-"   0.2 - Removed the need for filterdiff by implemeting it in pure vim script
+"   0.2 - Removed the need for filterdiff by implementing it in pure vim script
 "       - Added DiffReview command for reverse (changed repository to
 "         pristine state) reviews.
 "         (PatchReview does pristine repository to patch review)
 "       - DiffReview does automatic detection and generation of diffs for
 "         various Source Control systems
 "       - Skip load if VIM 7.0 or higher unavailable
 "
 "   0.1 - First released
 "}}}
 
 " Documentation:                                                         "{{{
 " ===========================================================================
 " This plugin allows single or multiple, patch or diff based code reviews to
 " be easily done in VIM. VIM has :diffpatch command to do single file reviews
 " but a) can not handle patch files containing multiple patches or b) do
 " automated diff generation for various version control systems. This plugin
 " attempts to provide those functionalities. It opens each changed / added or
 " removed file diff in new tabs.
 "
 " Installing:
 "
 "   For a quick start, unzip patchreview.zip into your ~/.vim directory and
 "   restart Vim.
 "
 " Details:
 "
 "   Requirements:
 "
 "   1) VIM 7.0 or higher built with +diff option.
 "
 "   2) A gnu compatible patch command installed. This is the standard patch
 "      command on Linux, Mac OS X, *BSD, Cygwin or /usr/bin/gpatch on newer
 "      Solaris.
 "
 "   3) Optional (but recommended for speed)
 "
 "      Install patchutils ( http://cyberelk.net/tim/patchutils/ ) for your
 "      OS. For windows it is available from Cygwin
 "
 "         http://www.cygwin.com
 "
 "      or GnuWin32
 "
 "         http://gnuwin32.sourceforge.net/
 "
 "   Install:
 "
 "   1) Extract the zip in your $HOME/.vim or $VIM/vimfiles directory and
 "      restart vim. The  directory location relevant to your platform can be
 "      seen by running :help add-global-plugin in vim.
 "
 "   2) Restart vim.
 "
 "  Configuration:
 "
 "  Optionally, specify the locations to these filterdiff and patch commands
 "  and location of a temporary directory to use in your .vimrc.
 "
 "      let g:patchreview_patch       = '/path/to/gnu/patch'
 "
 "      " If you are using filterdiff
 "      let g:patchreview_filterdiff  = '/path/to/filterdiff'
 "
 "
 " Usage:
 "
 "  Please see :help patchreview or :help diffreview for details.
 "
 ""}}}
 
 " Enabled only during development
 " unlet! g:loaded_patchreview " DEBUG
 " unlet! g:patchreview_patch " DEBUG
 " unlet! g:patchreview_filterdiff " DEBUG
 " let g:patchreview_patch = 'patch'    " DEBUG
 
 if v:version < 700
   finish
 endif
 if ! has('diff')
   call confirm('patchreview.vim plugin needs (G)VIM built with +diff support to work.')
   finish
 endif
 
 " load only once
 if (! exists('g:patchreview_debug') && exists('g:loaded_patchreview')) || &compatible
   finish
 endif
 let g:loaded_patchreview="0.2.2"
 
 let s:msgbufname = '-PatchReviewMessages-'
 
 function! <SID>Debug(str)                                                 "{{{
   if exists('g:patchreview_debug')
     Pecho 'DEBUG: ' . a:str
   endif
 endfunction
 command! -nargs=+ -complete=expression Debug call s:Debug(<args>)
 "}}}
 
 function! <SID>PR_wipeMsgBuf()                                            "{{{
   let winnum = bufwinnr(s:msgbufname)
   if winnum != -1 " If the window is already open, jump to it
     let cur_winnr = winnr()
     if winnr() != winnum
       exe winnum . 'wincmd w'
       exe 'bw'
       exe cur_winnr . 'wincmd w'
     endif
   endif
 endfunction
 "}}}
 
 function! <SID>Pecho(...)                                                 "{{{
   " Usage: Pecho(msg, [return_to_original_window_flag])
   "            default return_to_original_window_flag = 0
   "
   let cur_winnr = winnr()
   let winnum = bufwinnr(s:msgbufname)
   if winnum != -1 " If the window is already open, jump to it
     if winnr() != winnum
       exe winnum . 'wincmd w'
     endif
   else
     let bufnum = bufnr(s:msgbufname)
     if bufnum == -1
       let wcmd = s:msgbufname
     else
       let wcmd = '+buffer' . bufnum
     endif
     exe 'silent! botright 5split ' . wcmd
   endif
   setlocal modifiable
   setlocal buftype=nofile
   setlocal bufhidden=delete
   setlocal noswapfile
   setlocal nowrap
   setlocal nobuflisted
   if a:0 != 0
     silent! $put =a:1
   endif
   exe ':$'
   setlocal nomodifiable
   if a:0 > 1 && a:2
     exe cur_winnr . 'wincmd w'
   endif
 endfunction
 
 command! -nargs=+ -complete=expression Pecho call s:Pecho(<args>)
 "}}}
 
 function! <SID>PR_checkBinary(BinaryName)                                 "{{{
   " Verify that BinaryName is specified or available
   if ! exists('g:patchreview_' . a:BinaryName)
     if executable(a:BinaryName)
       let g:patchreview_{a:BinaryName} = a:BinaryName
       return 1
     else
       Pecho 'g:patchreview_' . a:BinaryName . ' is not defined and ' . a:BinaryName . ' command could not be found on path.'
       Pecho 'Please define it in your .vimrc.'
       return 0
     endif
   elseif ! executable(g:patchreview_{a:BinaryName})
     Pecho 'Specified g:patchreview_' . a:BinaryName . ' [' . g:patchreview_{a:BinaryName} . '] is not executable.'
     return 0
   else
     return 1
   endif
 endfunction
 "}}}
 
 function! <SID>ExtractDiffsNative(...)                                    "{{{
   " Sets g:patches = {'reason':'', 'patch':[
   " {
   "  'filename': filepath
   "  'type'    : '+' | '-' | '!'
   "  'content' : patch text for this file
   " },
   " ...
   " ]}
   let g:patches = {'reason' : '', 'patch' : []}
   " TODO : User pointers into lines list rather then use collect
   if a:0 == 0
     let g:patches['reason'] = "ExtractDiffsNative expects at least a patchfile argument"
     return
   endif
   let patchfile = expand(a:1, ':p')
   if a:0 > 1
     let patch = a:2
   endif
   if ! filereadable(patchfile)
     let g:patches['reason'] = "File " . patchfile . " is not readable"
     return
   endif
   unlet! filterdiffcmd
   let filterdiffcmd = '' . g:patchreview_filterdiff . ' --list -s ' . patchfile
   let fileslist = split(system(filterdiffcmd), '[\r\n]')
   for filewithchangetype in fileslist
     if filewithchangetype !~ '^[!+-] '
       Pecho '*** Skipping review generation due to unknown change for [' . filewithchangetype . ']'
       continue
     endif
 
     unlet! this_patch
     let this_patch = {}
 
     unlet! relpath
     let relpath = substitute(filewithchangetype, '^. ', '', '')
 
     let this_patch['filename'] = relpath
 
     if filewithchangetype =~ '^! '
       let this_patch['type'] = '!'
     elseif filewithchangetype =~ '^+ '
       let this_patch['type'] = '+'
     elseif filewithchangetype =~ '^- '
       let this_patch['type'] = '-'
     endif
 
     unlet! filterdiffcmd
     let filterdiffcmd = '' . g:patchreview_filterdiff . ' -i ' . relpath . ' ' . patchfile
     let this_patch['content'] = split(system(filterdiffcmd), '[\n\r]')
     let g:patches['patch'] += [this_patch]
     Debug "Patch collected for " . relpath
   endfor
 endfunction
 "}}}
 
 function! <SID>ExtractDiffsPureVim(...)                                   "{{{
   " Sets g:patches = {'reason':'', 'patch':[
   " {
   "  'filename': filepath
   "  'type'    : '+' | '-' | '!'
   "  'content' : patch text for this file
   " },
   " ...
   " ]}
   let g:patches = {'reason' : '', 'patch' : []}
   " TODO : User pointers into lines list rather then use collect
   if a:0 == 0
     let g:patches['reason'] = "ExtractDiffsPureVim expects at least a patchfile argument"
     return
   endif
   let patchfile = expand(a:1, ':p')
   if a:0 > 1
     let patch = a:2
   endif
   if ! filereadable(patchfile)
     let g:patches['reason'] = "File " . patchfile . " is not readable"
     return
   endif
   call s:PR_wipeMsgBuf()
   let collect = []
   let linum = 0
   let lines = readfile(patchfile)
   let linescount = len(lines)
   State 'START'
   while linum < linescount
     let line = lines[linum]
     let linum += 1
     if State() == 'START'
       let mat = matchlist(line, '^--- \([^\t]\+\).*$')
       if ! empty(mat) && mat[1] != ''
         State 'MAYBE_UNIFIED_DIFF'
         let p_first_file = mat[1]
         let collect = [line]
         Debug line . State()
         continue
       endif
       let mat = matchlist(line, '^\*\*\* \([^\t]\+\).*$')
       if ! empty(mat) && mat[1] != ''
         State 'MAYBE_CONTEXT_DIFF'
         let p_first_file = mat[1]
         let collect = [line]
         Debug line . State()
         continue
       endif
       continue
     elseif State() == 'MAYBE_CONTEXT_DIFF'
       let mat = matchlist(line, '^--- \([^\t]\+\).*$')
       if empty(mat) || mat[1] == ''
         State 'START'
         let linum -= 1
         continue
         Debug 'Back to square one ' . line()
       endif
       let p_second_file = mat[1]
       if p_first_file == '/dev/null'
         if p_second_file == '/dev/null'
           let g:patches['reason'] = "Malformed diff found at line " . linum
           return
         endif
         let p_type = '+'
         let filepath = p_second_file
       else
         if p_second_file == '/dev/null'
           let p_type = '-'
           let filepath = p_first_file
         else
           let p_type = '!'
           let filepath = p_first_file
         endif
       endif
       State 'EXPECT_15_STARS'
       let collect += [line]
       Debug line . State()
     elseif State() == 'EXPECT_15_STARS'
       if line !~ '^*\{15}$'
         State 'START'
         let linum -= 1
         Debug line . State()
         continue
       endif
       State 'EXPECT_CONTEXT_CHUNK_HEADER_1'
       let collect += [line]
       Debug line . State()
     elseif State() == 'EXPECT_CONTEXT_CHUNK_HEADER_1'
       let mat = matchlist(line, '^\*\*\* \(\d\+,\)\?\(\d\+\) \*\*\*\*$')
       if empty(mat) || mat[1] == ''
         State 'START'
         let linum -= 1
         Debug line . State()
         continue
       endif
       let collect += [line]
       State 'SKIP_CONTEXT_STUFF_1'
       Debug line . State()
       continue
     elseif State() == 'SKIP_CONTEXT_STUFF_1'
       if line !~ '^[ !+].*$'
         let mat = matchlist(line, '^--- \(\d\+\),\(\d\+\) ----$')
         if ! empty(mat) && mat[1] != '' && mat[2] != ''
           let goal_count = mat[2] - mat[1] + 1
           let c_count = 0
           State 'READ_CONTEXT_CHUNK'
           let collect += [line]
           Debug line . State() . " Goal count set to " . goal_count
           continue
         endif
         State 'START'
         let linum -= 1
         Debug line . State()
         continue
       endif
       let collect += [line]
       continue
     elseif State() == 'READ_CONTEXT_CHUNK'
       let c_count += 1
       if c_count == goal_count
         let collect += [line]
         State 'BACKSLASH_OR_CRANGE_EOF'
         continue
       else " goal not met yet
         let mat = matchlist(line, '^\([\\!+ ]\).*$')
         if empty(mat) || mat[1] == ''
           let linum -= 1
           State 'START'
           Debug line . State()
           continue
         endif
         let collect += [line]
         continue
       endif
     elseif State() == 'BACKSLASH_OR_CRANGE_EOF'
       if line =~ '^\\ No newline.*$'   " XXX: Can we go to another chunk from here??
         let collect += [line]
         let this_patch = {}
         let this_patch['filename'] = filepath
         let this_patch['type'] = p_type
         let this_patch['content'] = collect
         let g:patches['patch'] += [this_patch]
         Debug "Patch collected for " . filepath
         State 'START'
         continue
       endif
       if line =~ '^\*\{15}$'
         let collect += [line]
         State 'EXPECT_CONTEXT_CHUNK_HEADER_1'
         Debug line . State()
         continue
       endif
       let this_patch = {}
       let this_patch['filename'] = filepath
       let this_patch['type'] = p_type
       let this_patch['content'] = collect
       let g:patches['patch'] += [this_patch]
       let linum -= 1
       State 'START'
       Debug "Patch collected for " . filepath
       Debug line . State()
       continue
     elseif State() == 'MAYBE_UNIFIED_DIFF'
       let mat = matchlist(line, '^+++ \([^\t]\+\).*$')
       if empty(mat) || mat[1] == ''
         State 'START'
         let linum -= 1
         Debug line . State()
         continue
       endif
       let p_second_file = mat[1]
       if p_first_file == '/dev/null'
         if p_second_file == '/dev/null'
           let g:patches['reason'] = "Malformed diff found at line " . linum
           return
         endif
         let p_type = '+'
         let filepath = p_second_file
       else
         if p_second_file == '/dev/null'
           let p_type = '-'
           let filepath = p_first_file
         else
           let p_type = '!'
           let filepath = p_first_file
         endif
       endif
       State 'EXPECT_UNIFIED_RANGE_CHUNK'
       let collect += [line]
       Debug line . State()
       continue
     elseif State() == 'EXPECT_UNIFIED_RANGE_CHUNK'
       let mat = matchlist(line, '^@@ -\(\d\+,\)\?\(\d\+\) +\(\d\+,\)\?\(\d\+\) @@$')
       if ! empty(mat)
         let old_goal_count = mat[2]
         let new_goal_count = mat[4]
         let o_count = 0
         let n_count = 0
         Debug "Goal count set to " . old_goal_count . ', ' . new_goal_count
         State 'READ_UNIFIED_CHUNK'
         let collect += [line]
         Debug line . State()
         continue
       endif
       State 'START'
       Debug line . State()
       continue
     elseif State() == 'READ_UNIFIED_CHUNK'
       if o_count == old_goal_count && n_count == new_goal_count
         if line =~ '^\\.*$'   " XXX: Can we go to another chunk from here??
           let collect += [line]
           let this_patch = {}
           let this_patch['filename'] = filepath
           let this_patch['type'] = p_type
           let this_patch['content'] = collect
           let g:patches['patch'] += [this_patch]
           Debug "Patch collected for " . filepath
           State 'START'
           continue
         endif
         let mat = matchlist(line, '^@@ -\(\d\+,\)\?\(\d\+\) +\(\d\+,\)\?\(\d\+\) @@$')
         if ! empty(mat)
           let old_goal_count = mat[2]
           let new_goal_count = mat[4]
           let o_count = 0
           let n_count = 0
           Debug "Goal count set to " . old_goal_count . ', ' . new_goal_count
           let collect += [line]
           Debug line . State()
           continue
         endif
         let this_patch = {}
         let this_patch['filename'] = filepath
         let this_patch['type'] = p_type
         let this_patch['content'] = collect
         let g:patches['patch'] += [this_patch]
         Debug "Patch collected for " . filepath
         let linum -= 1
         State 'START'
         Debug line . State()
         continue
       else " goal not met yet
         let mat = matchlist(line, '^\([\\+ -]\).*$')
         if empty(mat) || mat[1] == ''
           let linum -= 1
           State 'START'
           continue
         endif
         let chr = mat[1]
         if chr == '+'
           let n_count += 1
         endif
         if chr == ' '
           let o_count += 1
           let n_count += 1
         endif
         if chr == '-'
           let o_count += 1
         endif
         let collect += [line]
         Debug line . State()
         continue
       endif
     else
       let g:patches['reason'] = "Internal error: Do not use the plugin anymore and if possible please send the diff or patch file you tried it with to Manpreet Singh <[e-mail]>"
       return
     endif
   endwhile
   "Pecho State()
   if (State() == 'READ_CONTEXT_CHUNK' && c_count == goal_count) || (State() == 'READ_UNIFIED_CHUNK' && n_count == new_goal_count && o_count == old_goal_count)
     let this_patch = {}
     let this_patch['filename'] = filepath
     let this_patch['type'] = p_type
     let this_patch['content'] = collect
     let g:patches['patch'] += [this_patch]
     Debug "Patch collected for " . filepath
   endif
   return
 endfunction
 "}}}
 
 function! State(...)  " For easy manipulation of diff extraction state      "{{{
   if a:0 != 0
     let s:STATE = a:1
   else
     if ! exists('s:STATE')
       let s:STATE = 'START'
     endif
     return s:STATE
   endif
 endfunction
 com! -nargs=+ -complete=expression State call State(<args>)
 "}}}
 
 function! <SID>PatchReview(...)                                           "{{{
   let s:save_shortmess = &shortmess
   let s:save_aw = &autowrite
   let s:save_awa = &autowriteall
   set shortmess=aW
   call s:PR_wipeMsgBuf()
   let s:reviewmode = 'patch'
   call s:_GenericReview(a:000)
   let &autowriteall = s:save_awa
   let &autowrite = s:save_aw
   let &shortmess = s:save_shortmess
 endfunction
 "}}}
 
 function! <SID>_GenericReview(argslist)                                   "{{{
   " diff mode:
   "   arg1 = patchfile
   "   arg2 = strip count
   " patch mode:
   "   arg1 = patchfile
   "   arg2 = strip count
   "   arg3 = directory
 
   " VIM 7+ required
   if version < 700
     Pecho 'This plugin needs VIM 7 or higher'
     return
   endif
 
   " +diff required
   if ! has('diff')
     Pecho 'This plugin needs VIM built with +diff feature.'
     return
   endif
 
 
   if s:reviewmode == 'diff'
     let patch_R_option = ' -t -R '
   elseif s:reviewmode == 'patch'
     let patch_R_option = ''
   else
     Pecho 'Fatal internal error in patchreview.vim plugin'
     return
   endif
 
   " Check passed arguments
   if len(a:argslist) == 0
     Pecho 'PatchReview command needs at least one argument specifying a patchfile path.'
     return
   endif
   let StripCount = 0
   if len(a:argslist) >= 1 && ((s:reviewmode == 'patch' && len(a:argslist) <= 3) || (s:reviewmode == 'diff' && len(a:argslist) == 2))
     let PatchFilePath = expand(a:argslist[0], ':p')
     if ! filereadable(PatchFilePath)
       Pecho 'File [' . PatchFilePath . '] is not accessible.'
       return
     endif
     if len(a:argslist) >= 2 && s:reviewmode == 'patch'
       let s:SrcDirectory = expand(a:argslist[1], ':p')
       if ! isdirectory(s:SrcDirectory)
         Pecho '[' . s:SrcDirectory . '] is not a directory'
         return
       endif
       try
         " Command line has already escaped the path
         exe 'cd ' . s:SrcDirectory
       catch /^.*E344.*/
         Pecho 'Could not change to directory [' . s:SrcDirectory . ']'
         return
       endtry
     endif
     if s:reviewmode == 'diff'
       " passed in by default
       let StripCount = eval(a:argslist[1])
     elseif s:reviewmode == 'patch'
       let StripCount = 1
       " optional strip count
       if len(a:argslist) == 3
         let StripCount = eval(a:argslist[2])
       endif
     endif
   else
     if s:reviewmode == 'patch'
       Pecho 'PatchReview command needs at most three arguments: patchfile path, optional source directory path and optional strip count.'
     elseif s:reviewmode == 'diff'
       Pecho 'DiffReview command accepts no arguments.'
     endif
     return
   endif
 
   " Verify that patch command and temporary directory are available or specified
   if ! s:PR_checkBinary('patch')
     return
   endif
 
   " Requirements met, now execute
   let PatchFilePath = fnamemodify(PatchFilePath, ':p')
   if s:reviewmode == 'patch'
     Pecho 'Patch file      : ' . PatchFilePath
   endif
   Pecho 'Source directory: ' . getcwd()
   Pecho '------------------'
   if s:PR_checkBinary('filterdiff')
     Debug "Using filterdiff"
     call s:ExtractDiffsNative(PatchFilePath)
   else
     Debug "Using own diff extraction (slower)"
     call s:ExtractDiffsPureVim(PatchFilePath)
   endif
   for patch in g:patches['patch']
     if patch.type !~ '^[!+-]$'
       Pecho '*** Skipping review generation due to unknown change [' . patch.type . ']', 1
       continue
     endif
     unlet! relpath
     let relpath = patch.filename
     " XXX: svn diff and hg diff produce different kind of outputs, one requires
     " XXX: stripping but the other doesn't. We need to take care of that
     let stripmore = StripCount
     let StrippedRelativeFilePath = relpath
     while stripmore > 0
       " strip one
       let StrippedRelativeFilePath = substitute(StrippedRelativeFilePath, '^[^\\\/]\+[^\\\/]*[\\\/]' , '' , '')
       let stripmore -= 1
     endwhile
     if patch.type == '!'
       if s:reviewmode == 'patch'
         let msgtype = 'Patch modifies file: '
       elseif s:reviewmode == 'diff'
         let msgtype = 'File has changes: '
       endif
     elseif patch.type == '+'
       if s:reviewmode == 'patch'
         let msgtype = 'Patch adds file    : '
       elseif s:reviewmode == 'diff'
         let msgtype = 'New file        : '
       endif
     elseif patch.type == '-'
       if s:reviewmode == 'patch'
         let msgtype = 'Patch removes file : '
       elseif s:reviewmode == 'diff'
         let msgtype = 'Removed file    : '
       endif
     endif
     let bufnum = bufnr(relpath)
     if buflisted(bufnum) && getbufvar(bufnum, '&mod')
       Pecho 'Old buffer for file [' . relpath . '] exists in modified state. Skipping review.', 1
       continue
     endif
     let tmpname = tempname()
 
     " write patch for patch.filename into tmpname
     call writefile(patch.content, tmpname)
     if patch.type == '+' && s:reviewmode == 'patch'
       let inputfile = ''
       let patchcmd = '!' . g:patchreview_patch . patch_R_option . ' -o "' . tmpname . '.file" "' . inputfile . '" < "' . tmpname . '"'
     elseif patch.type == '+' && s:reviewmode == 'diff'
       let inputfile = ''
       unlet! patchcmd
     else
       let inputfile = expand(StrippedRelativeFilePath, ':p')
       let patchcmd = '!' . g:patchreview_patch . patch_R_option . ' -o "' . tmpname . '.file" "' . inputfile . '" < "' . tmpname . '"'
     endif
     if exists('patchcmd')
       let v:errmsg = ''
       Debug patchcmd
       silent exe patchcmd
       if v:errmsg != '' || v:shell_error
         Pecho 'ERROR: Could not execute patch command.'
         Pecho 'ERROR:     ' . patchcmd
         Pecho 'ERROR: ' . v:errmsg
         Pecho 'ERROR: Diff skipped.'
         continue
       endif
     endif
     call delete(tmpname)
     let s:origtabpagenr = tabpagenr()
     silent! exe 'tabedit ' . StrippedRelativeFilePath
     if exists('patchcmd')
       " modelines in loaded files mess with diff comparision
       let s:keep_modeline=&modeline
       let &modeline=0
       silent! exe 'vert diffsplit ' . tmpname . '.file'
       setlocal buftype=nofile
       setlocal noswapfile
       setlocal syntax=none
       setlocal bufhidden=delete
       setlocal nobuflisted
       setlocal modifiable
       setlocal nowrap
       " Remove buffer name
       silent! 0f
       " Switch to original to get a nice tab title
       silent! wincmd p
       let &modeline=s:keep_modeline
     else
       silent! exe 'vnew'
     endif
     if filereadable(tmpname . '.file.rej')
       silent! exe 'topleft 5split ' . tmpname . '.file.rej'
       Pecho msgtype . '*** REJECTED *** ' . relpath, 1
     else
       Pecho msgtype . ' ' . relpath, 1
     endif
     silent! exe 'tabn ' . s:origtabpagenr
   endfor
   Pecho '-----'
   Pecho 'Done.'
 
 endfunction
 "}}}
 
 function! <SID>DiffReview(...)                                            "{{{
   let s:save_shortmess = &shortmess
   set shortmess=aW
   call s:PR_wipeMsgBuf()
 
   let vcsdict = {
                   \'Mercurial'  : {'dir' : '.hg',  'binary' : 'hg',  'diffargs' : 'diff' ,          'strip' : 1},
                   \'Bazaar-NG'  : {'dir' : '.bzr', 'binary' : 'bzr', 'diffargs' : 'diff' ,          'strip' : 0},
                   \'monotone'   : {'dir' : '_MTN', 'binary' : 'mtn', 'diffargs' : 'diff --unified', 'strip' : 0},
                   \'Subversion' : {'dir' : '.svn', 'binary' : 'svn', 'diffargs' : 'diff' ,          'strip' : 0},
                   \'cvs'        : {'dir' : 'CVS',  'binary' : 'cvs', 'diffargs' : '-q diff -u' ,    'strip' : 0},
                   \}
 
   unlet! s:theDiffCmd
   unlet! l:vcs
   if ! exists('g:patchreview_diffcmd')
     for key in keys(vcsdict)
       if isdirectory(vcsdict[key]['dir'])
         if ! s:PR_checkBinary(vcsdict[key]['binary'])
           Pecho 'Current directory looks like a ' . vcsdict[key] . ' repository but ' . vcsdist[key]['binary'] . ' command was not found on path.'
           let &shortmess = s:save_shortmess
           return
         else
           let s:theDiffCmd = vcsdict[key]['binary'] . ' ' . vcsdict[key]['diffargs']
           let strip = vcsdict[key]['strip']
 
           Pecho 'Using [' . s:theDiffCmd . '] to generate diffs for this ' . key . ' review.'
           let &shortmess = s:save_shortmess
           let l:vcs = vcsdict[key]['binary']
           break
         endif
       else
         continue
       endif
     endfor
   else
     let s:theDiffCmd = g:patchreview_diffcmd
     let strip = 0
   endif
   if ! exists('s:theDiffCmd')
     Pecho 'Please define g:patchreview_diffcmd and make sure you are in a VCS controlled top directory.'
     let &shortmess = s:save_shortmess
     return
   endif
 
   let outfile = tempname()
   let cmd = s:theDiffCmd . ' > "' . outfile . '"'
   let v:errmsg = ''
   let cout = system(cmd)
   if v:errmsg == '' && exists('l:vcs') && l:vcs == 'cvs' && v:shell_error == 1
     " Ignoring CVS non-error
   elseif v:errmsg != '' || v:shell_error
     Pecho v:errmsg
     Pecho 'Could not execute [' . s:theDiffCmd . ']'
     Pecho 'Error code: ' . v:shell_error
     Pecho cout
     Pecho 'Diff review aborted.'
     let &shortmess = s:save_shortmess
     return
   endif
   let s:reviewmode = 'diff'
   call s:_GenericReview([outfile, strip])
   let &shortmess = s:save_shortmess
 endfunction
 "}}}
 
 " End user commands                                                         "{{{
 "============================================================================
 " :PatchReview
 command! -nargs=* -complete=file PatchReview call s:PatchReview (<f-args>)
 
 " :DiffReview
 command! -nargs=0 DiffReview call s:DiffReview()
 "}}}
 
 " Development                                                               "{{{
 if exists('g:patchreview_debug')
   " Tests
   function! <SID>PRExtractTestNative(...)
     "let patchfiles = glob(expand(a:1) . '/?*')
     "for fname in split(patchfiles)
     call s:PR_wipeMsgBuf()
     let fname = a:1
     call s:ExtractDiffsNative(fname)
     for patch in g:patches['patch']
       for line in patch.content
         Pecho line
       endfor
     endfor
     "endfor
   endfunction
 
   function! <SID>PRExtractTestVim(...)
     "let patchfiles = glob(expand(a:1) . '/?*')
     "for fname in split(patchfiles)
     call s:PR_wipeMsgBuf()
     let fname = a:1
     call s:ExtractDiffsPureVim(fname)
     for patch in g:patches['patch']
       for line in patch.content
         Pecho line
       endfor
     endfor
     "endfor
   endfunction
 
   command! -nargs=+ -complete=file PRTestVim call s:PRExtractTestVim(<f-args>)
   command! -nargs=+ -complete=file PRTestNative call s:PRExtractTestNative(<f-args>)
 endif
 "}}}
 
 " modeline
 " vim: set et fdl=0 fdm=marker fenc=latin ff=unix ft=vim sw=2 sts=0 ts=2 textwidth=78 nowrap :

doc/hgmanpage.py

@@ -1,1110 +1,1110 b''
 # -*- coding: utf-8 -*-
 # $Id: manpage.py 6110 2009-08-31 14:40:33Z grubert $
 # Author: Engelbert Gruber <[e-mail]>
 # Copyright: This module is put into the public domain.
 
 """
 Simple man page writer for reStructuredText.
 
 Man pages (short for "manual pages") contain system documentation on unix-like
 systems. The pages are grouped in numbered sections:
 
  1 executable programs and shell commands
  2 system calls
  3 library functions
  4 special files
  5 file formats
  6 games
  7 miscellaneous
  8 system administration
 
 Man pages are written *troff*, a text file formatting system.
 
 See http://www.tldp.org/HOWTO/Man-Page for a start.
 
 Man pages have no subsection only parts.
 Standard parts
 
   NAME ,
   SYNOPSIS ,
   DESCRIPTION ,
   OPTIONS ,
   FILES ,
   SEE ALSO ,
   BUGS ,
 
 and
 
   AUTHOR .
 
 A unix-like system keeps an index of the DESCRIPTIONs, which is accesable
 by the command whatis or apropos.
 
 """
 
 __docformat__ = 'reStructuredText'
 
 import re
 
 from docutils import nodes, writers, languages
 try:
     import roman
 except ImportError:
     from docutils.utils import roman
 import inspect
 
 FIELD_LIST_INDENT = 7
 DEFINITION_LIST_INDENT = 7
 OPTION_LIST_INDENT = 7
 BLOCKQOUTE_INDENT = 3.5
 
 # Define two macros so man/roff can calculate the
 # indent/unindent margins by itself
 MACRO_DEF = (r""".
 .nr rst2man-indent-level 0
 .
 .de1 rstReportMargin
 \\$1 \\n[an-margin]
 level \\n[rst2man-indent-level]
 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 -
 \\n[rst2man-indent0]
 \\n[rst2man-indent1]
 \\n[rst2man-indent2]
 ..
 .de1 INDENT
 .\" .rstReportMargin pre:
 . RS \\$1
 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 . nr rst2man-indent-level +1
 .\" .rstReportMargin post:
 ..
 .de UNINDENT
 . RE
 .\" indent \\n[an-margin]
 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .nr rst2man-indent-level -1
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
 """)
 
 class Writer(writers.Writer):
 
     supported = ('manpage')
     """Formats this writer supports."""
 
     output = None
     """Final translated form of `document`."""
 
     def __init__(self):
         writers.Writer.__init__(self)
         self.translator_class = Translator
 
     def translate(self):
         visitor = self.translator_class(self.document)
         self.document.walkabout(visitor)
         self.output = visitor.astext()
 
 
 class Table(object):
     def __init__(self):
         self._rows = []
         self._options = ['center']
         self._tab_char = '\t'
         self._coldefs = []
     def new_row(self):
         self._rows.append([])
     def append_separator(self, separator):
         """Append the separator for table head."""
         self._rows.append([separator])
     def append_cell(self, cell_lines):
         """cell_lines is an array of lines"""
         start = 0
         if len(cell_lines) > 0 and cell_lines[0] == '.sp\n':
             start = 1
         self._rows[-1].append(cell_lines[start:])
         if len(self._coldefs) < len(self._rows[-1]):
             self._coldefs.append('l')
     def _minimize_cell(self, cell_lines):
         """Remove leading and trailing blank and ``.sp`` lines"""
         while (cell_lines and cell_lines[0] in ('\n', '.sp\n')):
             del cell_lines[0]
         while (cell_lines and cell_lines[-1] in ('\n', '.sp\n')):
             del cell_lines[-1]
     def as_list(self):
         text = ['.TS\n']
         text.append(' '.join(self._options) + ';\n')
         text.append('|%s|.\n' % ('|'.join(self._coldefs)))
         for row in self._rows:
             # row = array of cells. cell = array of lines.
             text.append('_\n')       # line above
             text.append('T{\n')
             for i in range(len(row)):
                 cell = row[i]
                 self._minimize_cell(cell)
                 text.extend(cell)
                 if not text[-1].endswith('\n'):
                     text[-1] += '\n'
                 if i < len(row)-1:
                     text.append('T}'+self._tab_char+'T{\n')
                 else:
                     text.append('T}\n')
         text.append('_\n')
         text.append('.TE\n')
         return text
 
 class Translator(nodes.NodeVisitor):
     """"""
 
     words_and_spaces = re.compile(r'\S+| +|\n')
-    document_start = """Man page generated from reStructeredText."""
+    document_start = """Man page generated from reStructuredText."""
 
     def __init__(self, document):
         nodes.NodeVisitor.__init__(self, document)
         self.settings = settings = document.settings
         lcode = settings.language_code
         arglen = len(inspect.getargspec(languages.get_language)[0])
         if arglen == 2:
             self.language = languages.get_language(lcode,
                                                    self.document.reporter)
         else:
             self.language = languages.get_language(lcode)
         self.head = []
         self.body = []
         self.foot = []
         self.section_level = 0
         self.context = []
         self.topic_class = ''
         self.colspecs = []
         self.compact_p = 1
         self.compact_simple = None
         # the list style "*" bullet or "#" numbered
         self._list_char = []
         # writing the header .TH and .SH NAME is postboned after
         # docinfo.
         self._docinfo = {
                 "title" : "", "title_upper": "",
                 "subtitle" : "",
                 "manual_section" : "", "manual_group" : "",
                 "author" : [],
                 "date" : "",
                 "copyright" : "",
                 "version" : "",
                     }
         self._docinfo_keys = []     # a list to keep the sequence as in source.
         self._docinfo_names = {}    # to get name from text not normalized.
         self._in_docinfo = None
         self._active_table = None
         self._in_literal = False
         self.header_written = 0
         self._line_block = 0
         self.authors = []
         self.section_level = 0
         self._indent = [0]
         # central definition of simple processing rules
         # what to output on : visit, depart
         # Do not use paragraph requests ``.PP`` because these set indentation.
         # use ``.sp``. Remove superfluous ``.sp`` in ``astext``.
         #
         # Fonts are put on a stack, the top one is used.
         # ``.ft P`` or ``\\fP`` pop from stack.
         # ``B`` bold, ``I`` italic, ``R`` roman should be available.
         # Hopefully ``C`` courier too.
         self.defs = {
                 'indent' : ('.INDENT %.1f\n', '.UNINDENT\n'),
                 'definition_list_item' : ('.TP', ''),
                 'field_name' : ('.TP\n.B ', '\n'),
                 'literal' : ('\\fB', '\\fP'),
                 'literal_block' : ('.sp\n.nf\n.ft C\n', '\n.ft P\n.fi\n'),
 
                 'option_list_item' : ('.TP\n', ''),
 
                 'reference' : (r'\%', r'\:'),
                 'emphasis': ('\\fI', '\\fP'),
                 'strong' : ('\\fB', '\\fP'),
                 'term' : ('\n.B ', '\n'),
                 'title_reference' : ('\\fI', '\\fP'),
 
                 'topic-title' : ('.SS ',),
                 'sidebar-title' : ('.SS ',),
 
                 'problematic' : ('\n.nf\n', '\n.fi\n'),
                     }
         # NOTE don't specify the newline before a dot-command, but ensure
         # it is there.
 
     def comment_begin(self, text):
         """Return commented version of the passed text WITHOUT end of
         line/comment."""
         prefix = '.\\" '
         out_text = ''.join(
             [(prefix + in_line + '\n')
             for in_line in text.split('\n')])
         return out_text
 
     def comment(self, text):
         """Return commented version of the passed text."""
         return self.comment_begin(text)+'.\n'
 
     def ensure_eol(self):
         """Ensure the last line in body is terminated by new line."""
         if self.body[-1][-1] != '\n':
             self.body.append('\n')
 
     def astext(self):
         """Return the final formatted document as a string."""
         if not self.header_written:
             # ensure we get a ".TH" as viewers require it.
             self.head.append(self.header())
         # filter body
         for i in xrange(len(self.body)-1, 0, -1):
             # remove superfluous vertical gaps.
             if self.body[i] == '.sp\n':
                 if self.body[i - 1][:4] in ('.BI ','.IP '):
                     self.body[i] = '.\n'
                 elif (self.body[i - 1][:3] == '.B ' and
                     self.body[i - 2][:4] == '.TP\n'):
                     self.body[i] = '.\n'
                 elif (self.body[i - 1] == '\n' and
                     self.body[i - 2][0] != '.' and
                     (self.body[i - 3][:7] == '.TP\n.B '
                         or self.body[i - 3][:4] == '\n.B ')
                      ):
                     self.body[i] = '.\n'
         return ''.join(self.head + self.body + self.foot)
 
     def deunicode(self, text):
         text = text.replace(u'\xa0', '\\ ')
         text = text.replace(u'\u2020', '\\(dg')
         return text
 
     def visit_Text(self, node):
         text = node.astext()
         text = text.replace('\\','\\e')
         replace_pairs = [
             (u'-', ur'\-'),
             (u'\'', ur'\(aq'),
             (u'´', ur'\''),
             (u'`', ur'\(ga'),
             ]
         for (in_char, out_markup) in replace_pairs:
             text = text.replace(in_char, out_markup)
         # unicode
         text = self.deunicode(text)
         if self._in_literal:
             # prevent interpretation of "." at line start
             if text[0] == '.':
                 text = '\\&' + text
             text = text.replace('\n.', '\n\\&.')
         self.body.append(text)
 
     def depart_Text(self, node):
         pass
 
     def list_start(self, node):
         class enum_char(object):
             enum_style = {
                     'bullet'     : '\\(bu',
                     'emdash'     : '\\(em',
                      }
 
             def __init__(self, style):
                 self._style = style
                 if 'start' in node:
                     self._cnt = node['start'] - 1
                 else:
                     self._cnt = 0
                 self._indent = 2
                 if style == 'arabic':
                     # indentation depends on number of childrens
                     # and start value.
                     self._indent = len(str(len(node.children)))
                     self._indent += len(str(self._cnt)) + 1
                 elif style == 'loweralpha':
                     self._cnt += ord('a') - 1
                     self._indent = 3
                 elif style == 'upperalpha':
                     self._cnt += ord('A') - 1
                     self._indent = 3
                 elif style.endswith('roman'):
                     self._indent = 5
 
             def next(self):
                 if self._style == 'bullet':
                     return self.enum_style[self._style]
                 elif self._style == 'emdash':
                     return self.enum_style[self._style]
                 self._cnt += 1
                 # TODO add prefix postfix
                 if self._style == 'arabic':
                     return "%d." % self._cnt
                 elif self._style in ('loweralpha', 'upperalpha'):
                     return "%c." % self._cnt
                 elif self._style.endswith('roman'):
                     res = roman.toRoman(self._cnt) + '.'
                     if self._style.startswith('upper'):
                         return res.upper()
                     return res.lower()
                 else:
                     return "%d." % self._cnt
             def get_width(self):
                 return self._indent
             def __repr__(self):
                 return 'enum_style-%s' % list(self._style)
 
         if 'enumtype' in node:
             self._list_char.append(enum_char(node['enumtype']))
         else:
             self._list_char.append(enum_char('bullet'))
         if len(self._list_char) > 1:
             # indent nested lists
             self.indent(self._list_char[-2].get_width())
         else:
             self.indent(self._list_char[-1].get_width())
 
     def list_end(self):
         self.dedent()
         self._list_char.pop()
 
     def header(self):
         tmpl = (".TH %(title_upper)s %(manual_section)s"
                 " \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n"
                 ".SH NAME\n"
                 "%(title)s \- %(subtitle)s\n")
         return tmpl % self._docinfo
 
     def append_header(self):
         """append header with .TH and .SH NAME"""
         # NOTE before everything
         # .TH title_upper section date source manual
         if self.header_written:
             return
         self.body.append(self.header())
         self.body.append(MACRO_DEF)
         self.header_written = 1
 
     def visit_address(self, node):
         self.visit_docinfo_item(node, 'address')
 
     def depart_address(self, node):
         pass
 
     def visit_admonition(self, node, name=None):
         if name:
             self.body.append('.IP %s\n' %
                         self.language.labels.get(name, name))
 
     def depart_admonition(self, node):
         self.body.append('.RE\n')
 
     def visit_attention(self, node):
         self.visit_admonition(node, 'attention')
 
     depart_attention = depart_admonition
 
     def visit_docinfo_item(self, node, name):
         if name == 'author':
             self._docinfo[name].append(node.astext())
         else:
             self._docinfo[name] = node.astext()
         self._docinfo_keys.append(name)
         raise nodes.SkipNode
 
     def depart_docinfo_item(self, node):
         pass
 
     def visit_author(self, node):
         self.visit_docinfo_item(node, 'author')
 
     depart_author = depart_docinfo_item
 
     def visit_authors(self, node):
         # _author is called anyway.
         pass
 
     def depart_authors(self, node):
         pass
 
     def visit_block_quote(self, node):
         # BUG/HACK: indent alway uses the _last_ indention,
         # thus we need two of them.
         self.indent(BLOCKQOUTE_INDENT)
         self.indent(0)
 
     def depart_block_quote(self, node):
         self.dedent()
         self.dedent()
 
     def visit_bullet_list(self, node):
         self.list_start(node)
 
     def depart_bullet_list(self, node):
         self.list_end()
 
     def visit_caption(self, node):
         pass
 
     def depart_caption(self, node):
         pass
 
     def visit_caution(self, node):
         self.visit_admonition(node, 'caution')
 
     depart_caution = depart_admonition
 
     def visit_citation(self, node):
         num, text = node.astext().split(None, 1)
         num = num.strip()
         self.body.append('.IP [%s] 5\n' % num)
 
     def depart_citation(self, node):
         pass
 
     def visit_citation_reference(self, node):
         self.body.append('['+node.astext()+']')
         raise nodes.SkipNode
 
     def visit_classifier(self, node):
         pass
 
     def depart_classifier(self, node):
         pass
 
     def visit_colspec(self, node):
         self.colspecs.append(node)
 
     def depart_colspec(self, node):
         pass
 
     def write_colspecs(self):
         self.body.append("%s.\n" % ('L '*len(self.colspecs)))
 
     def visit_comment(self, node,
                       sub=re.compile('-(?=-)').sub):
         self.body.append(self.comment(node.astext()))
         raise nodes.SkipNode
 
     def visit_contact(self, node):
         self.visit_docinfo_item(node, 'contact')
 
     depart_contact = depart_docinfo_item
 
     def visit_container(self, node):
         pass
 
     def depart_container(self, node):
         pass
 
     def visit_compound(self, node):
         pass
 
     def depart_compound(self, node):
         pass
 
     def visit_copyright(self, node):
         self.visit_docinfo_item(node, 'copyright')
 
     def visit_danger(self, node):
         self.visit_admonition(node, 'danger')
 
     depart_danger = depart_admonition
 
     def visit_date(self, node):
         self.visit_docinfo_item(node, 'date')
 
     def visit_decoration(self, node):
         pass
 
     def depart_decoration(self, node):
         pass
 
     def visit_definition(self, node):
         pass
 
     def depart_definition(self, node):
         pass
 
     def visit_definition_list(self, node):
         self.indent(DEFINITION_LIST_INDENT)
 
     def depart_definition_list(self, node):
         self.dedent()
 
     def visit_definition_list_item(self, node):
         self.body.append(self.defs['definition_list_item'][0])
 
     def depart_definition_list_item(self, node):
         self.body.append(self.defs['definition_list_item'][1])
 
     def visit_description(self, node):
         pass
 
     def depart_description(self, node):
         pass
 
     def visit_docinfo(self, node):
         self._in_docinfo = 1
 
     def depart_docinfo(self, node):
         self._in_docinfo = None
         # NOTE nothing should be written before this
         self.append_header()
 
     def visit_doctest_block(self, node):
         self.body.append(self.defs['literal_block'][0])
         self._in_literal = True
 
     def depart_doctest_block(self, node):
         self._in_literal = False
         self.body.append(self.defs['literal_block'][1])
 
     def visit_document(self, node):
         # no blank line between comment and header.
         self.body.append(self.comment(self.document_start).rstrip()+'\n')
         # writing header is postboned
         self.header_written = 0
 
     def depart_document(self, node):
         if self._docinfo['author']:
             self.body.append('.SH AUTHOR\n%s\n'
                     % ', '.join(self._docinfo['author']))
         skip = ('author', 'copyright', 'date',
                 'manual_group', 'manual_section',
                 'subtitle',
                 'title', 'title_upper', 'version')
         for name in self._docinfo_keys:
             if name == 'address':
                 self.body.append("\n%s:\n%s%s.nf\n%s\n.fi\n%s%s" % (
                                     self.language.labels.get(name, name),
                                     self.defs['indent'][0] % 0,
                                     self.defs['indent'][0] % BLOCKQOUTE_INDENT,
                                     self._docinfo[name],
                                     self.defs['indent'][1],
                                     self.defs['indent'][1]))
             elif name not in skip:
                 if name in self._docinfo_names:
                     label = self._docinfo_names[name]
                 else:
                     label = self.language.labels.get(name, name)
                 self.body.append("\n%s: %s\n" % (label, self._docinfo[name]))
         if self._docinfo['copyright']:
             self.body.append('.SH COPYRIGHT\n%s\n'
                     % self._docinfo['copyright'])
         self.body.append(self.comment(
                         'Generated by docutils manpage writer.\n'))
 
     def visit_emphasis(self, node):
         self.body.append(self.defs['emphasis'][0])
 
     def depart_emphasis(self, node):
         self.body.append(self.defs['emphasis'][1])
 
     def visit_entry(self, node):
         # a cell in a table row
         if 'morerows' in node:
             self.document.reporter.warning('"table row spanning" not supported',
                     base_node=node)
         if 'morecols' in node:
             self.document.reporter.warning(
                     '"table cell spanning" not supported', base_node=node)
         self.context.append(len(self.body))
 
     def depart_entry(self, node):
         start = self.context.pop()
         self._active_table.append_cell(self.body[start:])
         del self.body[start:]
 
     def visit_enumerated_list(self, node):
         self.list_start(node)
 
     def depart_enumerated_list(self, node):
         self.list_end()
 
     def visit_error(self, node):
         self.visit_admonition(node, 'error')
 
     depart_error = depart_admonition
 
     def visit_field(self, node):
         pass
 
     def depart_field(self, node):
         pass
 
     def visit_field_body(self, node):
         if self._in_docinfo:
             name_normalized = self._field_name.lower().replace(" ","_")
             self._docinfo_names[name_normalized] = self._field_name
             self.visit_docinfo_item(node, name_normalized)
             raise nodes.SkipNode
 
     def depart_field_body(self, node):
         pass
 
     def visit_field_list(self, node):
         self.indent(FIELD_LIST_INDENT)
 
     def depart_field_list(self, node):
         self.dedent()
 
     def visit_field_name(self, node):
         if self._in_docinfo:
             self._field_name = node.astext()
             raise nodes.SkipNode
         else:
             self.body.append(self.defs['field_name'][0])
 
     def depart_field_name(self, node):
         self.body.append(self.defs['field_name'][1])
 
     def visit_figure(self, node):
         self.indent(2.5)
         self.indent(0)
 
     def depart_figure(self, node):
         self.dedent()
         self.dedent()
 
     def visit_footer(self, node):
         self.document.reporter.warning('"footer" not supported',
                 base_node=node)
 
     def depart_footer(self, node):
         pass
 
     def visit_footnote(self, node):
         num, text = node.astext().split(None, 1)
         num = num.strip()
         self.body.append('.IP [%s] 5\n' % self.deunicode(num))
 
     def depart_footnote(self, node):
         pass
 
     def footnote_backrefs(self, node):
         self.document.reporter.warning('"footnote_backrefs" not supported',
                 base_node=node)
 
     def visit_footnote_reference(self, node):
         self.body.append('['+self.deunicode(node.astext())+']')
         raise nodes.SkipNode
 
     def depart_footnote_reference(self, node):
         pass
 
     def visit_generated(self, node):
         pass
 
     def depart_generated(self, node):
         pass
 
     def visit_header(self, node):
         raise NotImplementedError, node.astext()
 
     def depart_header(self, node):
         pass
 
     def visit_hint(self, node):
         self.visit_admonition(node, 'hint')
 
     depart_hint = depart_admonition
 
     def visit_subscript(self, node):
         self.body.append('\\s-2\\d')
 
     def depart_subscript(self, node):
         self.body.append('\\u\\s0')
 
     def visit_superscript(self, node):
         self.body.append('\\s-2\\u')
 
     def depart_superscript(self, node):
         self.body.append('\\d\\s0')
 
     def visit_attribution(self, node):
         self.body.append('\\(em ')
 
     def depart_attribution(self, node):
         self.body.append('\n')
 
     def visit_image(self, node):
         self.document.reporter.warning('"image" not supported',
                 base_node=node)
         text = []
         if 'alt' in node.attributes:
             text.append(node.attributes['alt'])
         if 'uri' in node.attributes:
             text.append(node.attributes['uri'])
         self.body.append('[image: %s]\n' % ('/'.join(text)))
         raise nodes.SkipNode
 
     def visit_important(self, node):
         self.visit_admonition(node, 'important')
 
     depart_important = depart_admonition
 
     def visit_label(self, node):
         # footnote and citation
         if (isinstance(node.parent, nodes.footnote)
             or isinstance(node.parent, nodes.citation)):
             raise nodes.SkipNode
         self.document.reporter.warning('"unsupported "label"',
                 base_node=node)
         self.body.append('[')
 
     def depart_label(self, node):
         self.body.append(']\n')
 
     def visit_legend(self, node):
         pass
 
     def depart_legend(self, node):
         pass
 
     # WHAT should we use .INDENT, .UNINDENT ?
     def visit_line_block(self, node):
         self._line_block += 1
         if self._line_block == 1:
             self.body.append('.sp\n')
             self.body.append('.nf\n')
         else:
             self.body.append('.in +2\n')
 
     def depart_line_block(self, node):
         self._line_block -= 1
         if self._line_block == 0:
             self.body.append('.fi\n')
             self.body.append('.sp\n')
         else:
             self.body.append('.in -2\n')
 
     def visit_line(self, node):
         pass
 
     def depart_line(self, node):
         self.body.append('\n')
 
     def visit_list_item(self, node):
         # man 7 man argues to use ".IP" instead of ".TP"
         self.body.append('.IP %s %d\n' % (
                 self._list_char[-1].next(),
                 self._list_char[-1].get_width(),))
 
     def depart_list_item(self, node):
         pass
 
     def visit_literal(self, node):
         self.body.append(self.defs['literal'][0])
 
     def depart_literal(self, node):
         self.body.append(self.defs['literal'][1])
 
     def visit_literal_block(self, node):
         self.body.append(self.defs['literal_block'][0])
         self._in_literal = True
 
     def depart_literal_block(self, node):
         self._in_literal = False
         self.body.append(self.defs['literal_block'][1])
 
     def visit_meta(self, node):
         raise NotImplementedError, node.astext()
 
     def depart_meta(self, node):
         pass
 
     def visit_note(self, node):
         self.visit_admonition(node, 'note')
 
     depart_note = depart_admonition
 
     def indent(self, by=0.5):
         # if we are in a section ".SH" there already is a .RS
         step = self._indent[-1]
         self._indent.append(by)
         self.body.append(self.defs['indent'][0] % step)
 
     def dedent(self):
         self._indent.pop()
         self.body.append(self.defs['indent'][1])
 
     def visit_option_list(self, node):
         self.indent(OPTION_LIST_INDENT)
 
     def depart_option_list(self, node):
         self.dedent()
 
     def visit_option_list_item(self, node):
         # one item of the list
         self.body.append(self.defs['option_list_item'][0])
 
     def depart_option_list_item(self, node):
         self.body.append(self.defs['option_list_item'][1])
 
     def visit_option_group(self, node):
         # as one option could have several forms it is a group
         # options without parameter bold only, .B, -v
         # options with parameter bold italic, .BI, -f file
         #
         # we do not know if .B or .BI
         self.context.append('.B')           # blind guess
         self.context.append(len(self.body)) # to be able to insert later
         self.context.append(0)              # option counter
 
     def depart_option_group(self, node):
         self.context.pop()  # the counter
         start_position = self.context.pop()
         text = self.body[start_position:]
         del self.body[start_position:]
         self.body.append('%s%s\n' % (self.context.pop(), ''.join(text)))
 
     def visit_option(self, node):
         # each form of the option will be presented separately
         if self.context[-1] > 0:
             self.body.append(', ')
         if self.context[-3] == '.BI':
             self.body.append('\\')
         self.body.append(' ')
 
     def depart_option(self, node):
         self.context[-1] += 1
 
     def visit_option_string(self, node):
         # do not know if .B or .BI
         pass
 
     def depart_option_string(self, node):
         pass
 
     def visit_option_argument(self, node):
         self.context[-3] = '.BI' # bold/italic alternate
         if node['delimiter'] != ' ':
             self.body.append('\\fB%s ' % node['delimiter'])
         elif self.body[len(self.body)-1].endswith('='):
             # a blank only means no blank in output, just changing font
             self.body.append(' ')
         else:
             # blank backslash blank, switch font then a blank
             self.body.append(' \\ ')
 
     def depart_option_argument(self, node):
         pass
 
     def visit_organization(self, node):
         self.visit_docinfo_item(node, 'organization')
 
     def depart_organization(self, node):
         pass
 
     def visit_paragraph(self, node):
         # ``.PP`` : Start standard indented paragraph.
         # ``.LP`` : Start block paragraph, all except the first.
         # ``.P [type]``  : Start paragraph type.
-        # NOTE dont use paragraph starts because they reset indentation.
+        # NOTE don't use paragraph starts because they reset indentation.
         # ``.sp`` is only vertical space
         self.ensure_eol()
         self.body.append('.sp\n')
 
     def depart_paragraph(self, node):
         self.body.append('\n')
 
     def visit_problematic(self, node):
         self.body.append(self.defs['problematic'][0])
 
     def depart_problematic(self, node):
         self.body.append(self.defs['problematic'][1])
 
     def visit_raw(self, node):
         if node.get('format') == 'manpage':
             self.body.append(node.astext() + "\n")
         # Keep non-manpage raw text out of output:
         raise nodes.SkipNode
 
     def visit_reference(self, node):
         """E.g. link or email address."""
         self.body.append(self.defs['reference'][0])
 
     def depart_reference(self, node):
         self.body.append(self.defs['reference'][1])
 
     def visit_revision(self, node):
         self.visit_docinfo_item(node, 'revision')
 
     depart_revision = depart_docinfo_item
 
     def visit_row(self, node):
         self._active_table.new_row()
 
     def depart_row(self, node):
         pass
 
     def visit_section(self, node):
         self.section_level += 1
 
     def depart_section(self, node):
         self.section_level -= 1
 
     def visit_status(self, node):
         self.visit_docinfo_item(node, 'status')
 
     depart_status = depart_docinfo_item
 
     def visit_strong(self, node):
         self.body.append(self.defs['strong'][0])
 
     def depart_strong(self, node):
         self.body.append(self.defs['strong'][1])
 
     def visit_substitution_definition(self, node):
         """Internal only."""
         raise nodes.SkipNode
 
     def visit_substitution_reference(self, node):
         self.document.reporter.warning('"substitution_reference" not supported',
                 base_node=node)
 
     def visit_subtitle(self, node):
         if isinstance(node.parent, nodes.sidebar):
             self.body.append(self.defs['strong'][0])
         elif isinstance(node.parent, nodes.document):
             self.visit_docinfo_item(node, 'subtitle')
         elif isinstance(node.parent, nodes.section):
             self.body.append(self.defs['strong'][0])
 
     def depart_subtitle(self, node):
         # document subtitle calls SkipNode
         self.body.append(self.defs['strong'][1]+'\n.PP\n')
 
     def visit_system_message(self, node):
         # TODO add report_level
         #if node['level'] < self.document.reporter['writer'].report_level:
         #    Level is too low to display:
         #    raise nodes.SkipNode
         attr = {}
         backref_text = ''
         if node.hasattr('id'):
             attr['name'] = node['id']
         if node.hasattr('line'):
             line = ', line %s' % node['line']
         else:
             line = ''
         self.body.append('.IP "System Message: %s/%s (%s:%s)"\n'
                          % (node['type'], node['level'], node['source'], line))
 
     def depart_system_message(self, node):
         pass
 
     def visit_table(self, node):
         self._active_table = Table()
 
     def depart_table(self, node):
         self.ensure_eol()
         self.body.extend(self._active_table.as_list())
         self._active_table = None
 
     def visit_target(self, node):
         # targets are in-document hyper targets, without any use for man-pages.
         raise nodes.SkipNode
 
     def visit_tbody(self, node):
         pass
 
     def depart_tbody(self, node):
         pass
 
     def visit_term(self, node):
         self.body.append(self.defs['term'][0])
 
     def depart_term(self, node):
         self.body.append(self.defs['term'][1])
 
     def visit_tgroup(self, node):
         pass
 
     def depart_tgroup(self, node):
         pass
 
     def visit_thead(self, node):
         # MAYBE double line '='
         pass
 
     def depart_thead(self, node):
         # MAYBE double line '='
         pass
 
     def visit_tip(self, node):
         self.visit_admonition(node, 'tip')
 
     depart_tip = depart_admonition
 
     def visit_title(self, node):
         if isinstance(node.parent, nodes.topic):
             self.body.append(self.defs['topic-title'][0])
         elif isinstance(node.parent, nodes.sidebar):
             self.body.append(self.defs['sidebar-title'][0])
         elif isinstance(node.parent, nodes.admonition):
             self.body.append('.IP "')
         elif self.section_level == 0:
             self._docinfo['title'] = node.astext()
             # document title for .TH
             self._docinfo['title_upper'] = node.astext().upper()
             raise nodes.SkipNode
         elif self.section_level == 1:
             self.body.append('.SH ')
             for n in node.traverse(nodes.Text):
                 n.parent.replace(n, nodes.Text(n.astext().upper()))
         else:
             self.body.append('.SS ')
 
     def depart_title(self, node):
         if isinstance(node.parent, nodes.admonition):
             self.body.append('"')
         self.body.append('\n')
 
     def visit_title_reference(self, node):
         """inline citation reference"""
         self.body.append(self.defs['title_reference'][0])
 
     def depart_title_reference(self, node):
         self.body.append(self.defs['title_reference'][1])
 
     def visit_topic(self, node):
         pass
 
     def depart_topic(self, node):
         pass
 
     def visit_sidebar(self, node):
         pass
 
     def depart_sidebar(self, node):
         pass
 
     def visit_rubric(self, node):
         pass
 
     def depart_rubric(self, node):
         pass
 
     def visit_transition(self, node):
         # .PP      Begin a new paragraph and reset prevailing indent.
         # .sp N    leaves N lines of blank space.
         # .ce      centers the next line
         self.body.append('\n.sp\n.ce\n----\n')
 
     def depart_transition(self, node):
         self.body.append('\n.ce 0\n.sp\n')
 
     def visit_version(self, node):
         self.visit_docinfo_item(node, 'version')
 
     def visit_warning(self, node):
         self.visit_admonition(node, 'warning')
 
     depart_warning = depart_admonition
 
     def unimplemented_visit(self, node):
         raise NotImplementedError('visiting unimplemented node type: %s'
                                   % node.__class__.__name__)
 
 # vim: set fileencoding=utf-8 et ts=4 ai :

hgext/bugzilla.py

@@ -1,915 +1,915 b''
 # bugzilla.py - bugzilla integration for mercurial
 #
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 # Copyright 2011-2 Jim Hague <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 '''hooks for integrating with the Bugzilla bug tracker
 
 This hook extension adds comments on bugs in Bugzilla when changesets
 that refer to bugs by Bugzilla ID are seen. The comment is formatted using
 the Mercurial template mechanism.
 
 The bug references can optionally include an update for Bugzilla of the
 hours spent working on the bug. Bugs can also be marked fixed.
 
 Three basic modes of access to Bugzilla are provided:
 
 1. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.
 
 2. Check data via the Bugzilla XMLRPC interface and submit bug change
    via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.
 
 3. Writing directly to the Bugzilla database. Only Bugzilla installations
    using MySQL are supported. Requires Python MySQLdb.
 
 Writing directly to the database is susceptible to schema changes, and
 relies on a Bugzilla contrib script to send out bug change
 notification emails. This script runs as the user running Mercurial,
 must be run on the host with the Bugzilla install, and requires
 permission to read Bugzilla configuration details and the necessary
 MySQL user and password to have full access rights to the Bugzilla
 database. For these reasons this access mode is now considered
 deprecated, and will not be updated for new Bugzilla versions going
 forward. Only adding comments is supported in this access mode.
 
 Access via XMLRPC needs a Bugzilla username and password to be specified
 in the configuration. Comments are added under that username. Since the
 configuration must be readable by all Mercurial users, it is recommended
 that the rights of that user are restricted in Bugzilla to the minimum
 necessary to add comments. Marking bugs fixed requires Bugzilla 4.0 and later.
 
 Access via XMLRPC/email uses XMLRPC to query Bugzilla, but sends
 email to the Bugzilla email interface to submit comments to bugs.
 The From: address in the email is set to the email address of the Mercurial
 user, so the comment appears to come from the Mercurial user. In the event
-that the Mercurial user email is not recognised by Bugzilla as a Bugzilla
+that the Mercurial user email is not recognized by Bugzilla as a Bugzilla
 user, the email associated with the Bugzilla username used to log into
 Bugzilla is used instead as the source of the comment. Marking bugs fixed
 works on all supported Bugzilla versions.
 
 Configuration items common to all access modes:
 
 bugzilla.version
-  This access type to use. Values recognised are:
+  The access type to use. Values recognized are:
 
   :``xmlrpc``:       Bugzilla XMLRPC interface.
   :``xmlrpc+email``: Bugzilla XMLRPC and email interfaces.
   :``3.0``:          MySQL access, Bugzilla 3.0 and later.
   :``2.18``:         MySQL access, Bugzilla 2.18 and up to but not
                      including 3.0.
   :``2.16``:         MySQL access, Bugzilla 2.16 and up to but not
                      including 2.18.
 
 bugzilla.regexp
   Regular expression to match bug IDs for update in changeset commit message.
   It must contain one "()" named group ``<ids>`` containing the bug
   IDs separated by non-digit characters. It may also contain
   a named group ``<hours>`` with a floating-point number giving the
   hours worked on the bug. If no named groups are present, the first
   "()" group is assumed to contain the bug IDs, and work time is not
   updated. The default expression matches ``Bug 1234``, ``Bug no. 1234``,
   ``Bug number 1234``, ``Bugs 1234,5678``, ``Bug 1234 and 5678`` and
   variations thereof, followed by an hours number prefixed by ``h`` or
   ``hours``, e.g. ``hours 1.5``. Matching is case insensitive.
 
 bugzilla.fixregexp
   Regular expression to match bug IDs for marking fixed in changeset
   commit message. This must contain a "()" named group ``<ids>` containing
   the bug IDs separated by non-digit characters. It may also contain
   a named group ``<hours>`` with a floating-point number giving the
   hours worked on the bug. If no named groups are present, the first
   "()" group is assumed to contain the bug IDs, and work time is not
   updated. The default expression matches ``Fixes 1234``, ``Fixes bug 1234``,
   ``Fixes bugs 1234,5678``, ``Fixes 1234 and 5678`` and
   variations thereof, followed by an hours number prefixed by ``h`` or
   ``hours``, e.g. ``hours 1.5``. Matching is case insensitive.
 
 bugzilla.fixstatus
   The status to set a bug to when marking fixed. Default ``RESOLVED``.
 
 bugzilla.fixresolution
   The resolution to set a bug to when marking fixed. Default ``FIXED``.
 
 bugzilla.style
   The style file to use when formatting comments.
 
 bugzilla.template
   Template to use when formatting comments. Overrides style if
   specified. In addition to the usual Mercurial keywords, the
   extension specifies:
 
   :``{bug}``:     The Bugzilla bug ID.
   :``{root}``:    The full pathname of the Mercurial repository.
   :``{webroot}``: Stripped pathname of the Mercurial repository.
   :``{hgweb}``:   Base URL for browsing Mercurial repositories.
 
   Default ``changeset {node|short} in repo {root} refers to bug
   {bug}.\\ndetails:\\n\\t{desc|tabindent}``
 
 bugzilla.strip
   The number of path separator characters to strip from the front of
   the Mercurial repository path (``{root}`` in templates) to produce
   ``{webroot}``. For example, a repository with ``{root}``
   ``/var/local/my-project`` with a strip of 2 gives a value for
   ``{webroot}`` of ``my-project``. Default 0.
 
 web.baseurl
   Base URL for browsing Mercurial repositories. Referenced from
   templates as ``{hgweb}``.
 
 Configuration items common to XMLRPC+email and MySQL access modes:
 
 bugzilla.usermap
   Path of file containing Mercurial committer email to Bugzilla user email
   mappings. If specified, the file should contain one mapping per
   line::
 
     committer = Bugzilla user
 
   See also the ``[usermap]`` section.
 
 The ``[usermap]`` section is used to specify mappings of Mercurial
 committer email to Bugzilla user email. See also ``bugzilla.usermap``.
 Contains entries of the form ``committer = Bugzilla user``.
 
 XMLRPC access mode configuration:
 
 bugzilla.bzurl
   The base URL for the Bugzilla installation.
   Default ``http://localhost/bugzilla``.
 
 bugzilla.user
   The username to use to log into Bugzilla via XMLRPC. Default
   ``bugs``.
 
 bugzilla.password
   The password for Bugzilla login.
 
 XMLRPC+email access mode uses the XMLRPC access mode configuration items,
 and also:
 
 bugzilla.bzemail
   The Bugzilla email address.
 
 In addition, the Mercurial email settings must be configured. See the
 documentation in hgrc(5), sections ``[email]`` and ``[smtp]``.
 
 MySQL access mode configuration:
 
 bugzilla.host
   Hostname of the MySQL server holding the Bugzilla database.
   Default ``localhost``.
 
 bugzilla.db
   Name of the Bugzilla database in MySQL. Default ``bugs``.
 
 bugzilla.user
   Username to use to access MySQL server. Default ``bugs``.
 
 bugzilla.password
   Password to use to access MySQL server.
 
 bugzilla.timeout
   Database connection timeout (seconds). Default 5.
 
 bugzilla.bzuser
   Fallback Bugzilla user name to record comments with, if changeset
   committer cannot be found as a Bugzilla user.
 
 bugzilla.bzdir
    Bugzilla install directory. Used by default notify. Default
    ``/var/www/html/bugzilla``.
 
 bugzilla.notify
   The command to run to get Bugzilla to send bug change notification
   emails. Substitutes from a map with 3 keys, ``bzdir``, ``id`` (bug
   id) and ``user`` (committer bugzilla email). Default depends on
   version; from 2.18 it is "cd %(bzdir)s && perl -T
   contrib/sendbugmail.pl %(id)s %(user)s".
 
 Activating the extension::
 
     [extensions]
     bugzilla =
 
     [hooks]
     # run bugzilla hook on every change pulled or pushed in here
     incoming.bugzilla = python:hgext.bugzilla.hook
 
 Example configurations:
 
 XMLRPC example configuration. This uses the Bugzilla at
 ``http://my-project.org/bugzilla``, logging in as user
 ``[e-mail]`` with password ``plugh``. It is used with a
 collection of Mercurial repositories in ``/var/local/hg/repos/``,
 with a web interface at ``http://my-project.org/hg``. ::
 
     [bugzilla]
     bzurl=http://my-project.org/bugzilla
     user=[e-mail]
     password=plugh
     version=xmlrpc
     template=Changeset {node|short} in {root|basename}.
              {hgweb}/{webroot}/rev/{node|short}\\n
              {desc}\\n
     strip=5
 
     [web]
     baseurl=http://my-project.org/hg
 
 XMLRPC+email example configuration. This uses the Bugzilla at
 ``http://my-project.org/bugzilla``, logging in as user
 ``[e-mail]`` with password ``plugh``. It is used with a
 collection of Mercurial repositories in ``/var/local/hg/repos/``,
 with a web interface at ``http://my-project.org/hg``. Bug comments
 are sent to the Bugzilla email address
 ``[e-mail]``. ::
 
     [bugzilla]
     bzurl=http://my-project.org/bugzilla
     user=[e-mail]
     password=plugh
     version=xmlrpc
     bzemail=[e-mail]
     template=Changeset {node|short} in {root|basename}.
              {hgweb}/{webroot}/rev/{node|short}\\n
              {desc}\\n
     strip=5
 
     [web]
     baseurl=http://my-project.org/hg
 
     [usermap]
     [e-mail]=[e-mail]
 
 MySQL example configuration. This has a local Bugzilla 3.2 installation
 in ``/opt/bugzilla-3.2``. The MySQL database is on ``localhost``,
 the Bugzilla database name is ``bugs`` and MySQL is
 accessed with MySQL username ``bugs`` password ``XYZZY``. It is used
 with a collection of Mercurial repositories in ``/var/local/hg/repos/``,
 with a web interface at ``http://my-project.org/hg``. ::
 
     [bugzilla]
     host=localhost
     password=XYZZY
     version=3.0
     bzuser=[e-mail]
     bzdir=/opt/bugzilla-3.2
     template=Changeset {node|short} in {root|basename}.
              {hgweb}/{webroot}/rev/{node|short}\\n
              {desc}\\n
     strip=5
 
     [web]
     baseurl=http://my-project.org/hg
 
     [usermap]
     [e-mail]=[e-mail]
 
 All the above add a comment to the Bugzilla bug record of the form::
 
     Changeset 3b16791d6642 in repository-name.
     http://my-project.org/hg/repository-name/rev/3b16791d6642
 
     Changeset commit comment. Bug 1234.
 '''
 
 from mercurial.i18n import _
 from mercurial.node import short
 from mercurial import cmdutil, mail, templater, util
 import re, time, urlparse, xmlrpclib
 
 testedwith = 'internal'
 
 class bzaccess(object):
     '''Base class for access to Bugzilla.'''
 
     def __init__(self, ui):
         self.ui = ui
         usermap = self.ui.config('bugzilla', 'usermap')
         if usermap:
             self.ui.readconfig(usermap, sections=['usermap'])
 
     def map_committer(self, user):
         '''map name of committer to Bugzilla user name.'''
         for committer, bzuser in self.ui.configitems('usermap'):
             if committer.lower() == user.lower():
                 return bzuser
         return user
 
     # Methods to be implemented by access classes.
     #
     # 'bugs' is a dict keyed on bug id, where values are a dict holding
-    # updates to bug state. Recognised dict keys are:
+    # updates to bug state. Recognized dict keys are:
     #
     # 'hours': Value, float containing work hours to be updated.
     # 'fix':   If key present, bug is to be marked fixed. Value ignored.
 
     def filter_real_bug_ids(self, bugs):
         '''remove bug IDs that do not exist in Bugzilla from bugs.'''
         pass
 
     def filter_cset_known_bug_ids(self, node, bugs):
         '''remove bug IDs where node occurs in comment text from bugs.'''
         pass
 
     def updatebug(self, bugid, newstate, text, committer):
         '''update the specified bug. Add comment text and set new states.
 
         If possible add the comment as being from the committer of
         the changeset. Otherwise use the default Bugzilla user.
         '''
         pass
 
     def notify(self, bugs, committer):
         '''Force sending of Bugzilla notification emails.
 
         Only required if the access method does not trigger notification
         emails automatically.
         '''
         pass
 
 # Bugzilla via direct access to MySQL database.
 class bzmysql(bzaccess):
     '''Support for direct MySQL access to Bugzilla.
 
     The earliest Bugzilla version this is tested with is version 2.16.
 
     If your Bugzilla is version 3.4 or above, you are strongly
     recommended to use the XMLRPC access method instead.
     '''
 
     @staticmethod
     def sql_buglist(ids):
         '''return SQL-friendly list of bug ids'''
         return '(' + ','.join(map(str, ids)) + ')'
 
     _MySQLdb = None
 
     def __init__(self, ui):
         try:
             import MySQLdb as mysql
             bzmysql._MySQLdb = mysql
         except ImportError, err:
             raise util.Abort(_('python mysql support not available: %s') % err)
 
         bzaccess.__init__(self, ui)
 
         host = self.ui.config('bugzilla', 'host', 'localhost')
         user = self.ui.config('bugzilla', 'user', 'bugs')
         passwd = self.ui.config('bugzilla', 'password')
         db = self.ui.config('bugzilla', 'db', 'bugs')
         timeout = int(self.ui.config('bugzilla', 'timeout', 5))
         self.ui.note(_('connecting to %s:%s as %s, password %s\n') %
                      (host, db, user, '*' * len(passwd)))
         self.conn = bzmysql._MySQLdb.connect(host=host,
                                                    user=user, passwd=passwd,
                                                    db=db,
                                                    connect_timeout=timeout)
         self.cursor = self.conn.cursor()
         self.longdesc_id = self.get_longdesc_id()
         self.user_ids = {}
         self.default_notify = "cd %(bzdir)s && ./processmail %(id)s %(user)s"
 
     def run(self, *args, **kwargs):
         '''run a query.'''
         self.ui.note(_('query: %s %s\n') % (args, kwargs))
         try:
             self.cursor.execute(*args, **kwargs)
         except bzmysql._MySQLdb.MySQLError:
             self.ui.note(_('failed query: %s %s\n') % (args, kwargs))
             raise
 
     def get_longdesc_id(self):
         '''get identity of longdesc field'''
         self.run('select fieldid from fielddefs where name = "longdesc"')
         ids = self.cursor.fetchall()
         if len(ids) != 1:
             raise util.Abort(_('unknown database schema'))
         return ids[0][0]
 
     def filter_real_bug_ids(self, bugs):
         '''filter not-existing bugs from set.'''
         self.run('select bug_id from bugs where bug_id in %s' %
                  bzmysql.sql_buglist(bugs.keys()))
         existing = [id for (id,) in self.cursor.fetchall()]
         for id in bugs.keys():
             if id not in existing:
                 self.ui.status(_('bug %d does not exist\n') % id)
                 del bugs[id]
 
     def filter_cset_known_bug_ids(self, node, bugs):
         '''filter bug ids that already refer to this changeset from set.'''
         self.run('''select bug_id from longdescs where
                     bug_id in %s and thetext like "%%%s%%"''' %
                  (bzmysql.sql_buglist(bugs.keys()), short(node)))
         for (id,) in self.cursor.fetchall():
             self.ui.status(_('bug %d already knows about changeset %s\n') %
                            (id, short(node)))
             del bugs[id]
 
     def notify(self, bugs, committer):
         '''tell bugzilla to send mail.'''
         self.ui.status(_('telling bugzilla to send mail:\n'))
         (user, userid) = self.get_bugzilla_user(committer)
         for id in bugs.keys():
             self.ui.status(_('  bug %s\n') % id)
             cmdfmt = self.ui.config('bugzilla', 'notify', self.default_notify)
             bzdir = self.ui.config('bugzilla', 'bzdir',
                                    '/var/www/html/bugzilla')
             try:
                 # Backwards-compatible with old notify string, which
                 # took one string. This will throw with a new format
                 # string.
                 cmd = cmdfmt % id
             except TypeError:
                 cmd = cmdfmt % {'bzdir': bzdir, 'id': id, 'user': user}
             self.ui.note(_('running notify command %s\n') % cmd)
             fp = util.popen('(%s) 2>&1' % cmd)
             out = fp.read()
             ret = fp.close()
             if ret:
                 self.ui.warn(out)
                 raise util.Abort(_('bugzilla notify command %s') %
                                  util.explainexit(ret)[0])
         self.ui.status(_('done\n'))
 
     def get_user_id(self, user):
         '''look up numeric bugzilla user id.'''
         try:
             return self.user_ids[user]
         except KeyError:
             try:
                 userid = int(user)
             except ValueError:
                 self.ui.note(_('looking up user %s\n') % user)
                 self.run('''select userid from profiles
                             where login_name like %s''', user)
                 all = self.cursor.fetchall()
                 if len(all) != 1:
                     raise KeyError(user)
                 userid = int(all[0][0])
             self.user_ids[user] = userid
             return userid
 
     def get_bugzilla_user(self, committer):
         '''See if committer is a registered bugzilla user. Return
         bugzilla username and userid if so. If not, return default
         bugzilla username and userid.'''
         user = self.map_committer(committer)
         try:
             userid = self.get_user_id(user)
         except KeyError:
             try:
                 defaultuser = self.ui.config('bugzilla', 'bzuser')
                 if not defaultuser:
                     raise util.Abort(_('cannot find bugzilla user id for %s') %
                                      user)
                 userid = self.get_user_id(defaultuser)
                 user = defaultuser
             except KeyError:
                 raise util.Abort(_('cannot find bugzilla user id for %s or %s')
                                  % (user, defaultuser))
         return (user, userid)
 
     def updatebug(self, bugid, newstate, text, committer):
         '''update bug state with comment text.
 
         Try adding comment as committer of changeset, otherwise as
         default bugzilla user.'''
         if len(newstate) > 0:
             self.ui.warn(_("Bugzilla/MySQL cannot update bug state\n"))
 
         (user, userid) = self.get_bugzilla_user(committer)
         now = time.strftime('%Y-%m-%d %H:%M:%S')
         self.run('''insert into longdescs
                     (bug_id, who, bug_when, thetext)
                     values (%s, %s, %s, %s)''',
                  (bugid, userid, now, text))
         self.run('''insert into bugs_activity (bug_id, who, bug_when, fieldid)
                     values (%s, %s, %s, %s)''',
                  (bugid, userid, now, self.longdesc_id))
         self.conn.commit()
 
 class bzmysql_2_18(bzmysql):
     '''support for bugzilla 2.18 series.'''
 
     def __init__(self, ui):
         bzmysql.__init__(self, ui)
         self.default_notify = \
             "cd %(bzdir)s && perl -T contrib/sendbugmail.pl %(id)s %(user)s"
 
 class bzmysql_3_0(bzmysql_2_18):
     '''support for bugzilla 3.0 series.'''
 
     def __init__(self, ui):
         bzmysql_2_18.__init__(self, ui)
 
     def get_longdesc_id(self):
         '''get identity of longdesc field'''
         self.run('select id from fielddefs where name = "longdesc"')
         ids = self.cursor.fetchall()
         if len(ids) != 1:
             raise util.Abort(_('unknown database schema'))
         return ids[0][0]
 
 # Bugzilla via XMLRPC interface.
 
 class cookietransportrequest(object):
     """A Transport request method that retains cookies over its lifetime.
 
     The regular xmlrpclib transports ignore cookies. Which causes
     a bit of a problem when you need a cookie-based login, as with
     the Bugzilla XMLRPC interface.
 
     So this is a helper for defining a Transport which looks for
     cookies being set in responses and saves them to add to all future
     requests.
     """
 
     # Inspiration drawn from
     # http://blog.godson.in/2010/09/how-to-make-python-xmlrpclib-client.html
     # http://www.itkovian.net/base/transport-class-for-pythons-xml-rpc-lib/
 
     cookies = []
     def send_cookies(self, connection):
         if self.cookies:
             for cookie in self.cookies:
                 connection.putheader("Cookie", cookie)
 
     def request(self, host, handler, request_body, verbose=0):
         self.verbose = verbose
         self.accept_gzip_encoding = False
 
         # issue XML-RPC request
         h = self.make_connection(host)
         if verbose:
             h.set_debuglevel(1)
 
         self.send_request(h, handler, request_body)
         self.send_host(h, host)
         self.send_cookies(h)
         self.send_user_agent(h)
         self.send_content(h, request_body)
 
         # Deal with differences between Python 2.4-2.6 and 2.7.
         # In the former h is a HTTP(S). In the latter it's a
         # HTTP(S)Connection. Luckily, the 2.4-2.6 implementation of
         # HTTP(S) has an underlying HTTP(S)Connection, so extract
         # that and use it.
         try:
             response = h.getresponse()
         except AttributeError:
             response = h._conn.getresponse()
 
         # Add any cookie definitions to our list.
         for header in response.msg.getallmatchingheaders("Set-Cookie"):
             val = header.split(": ", 1)[1]
             cookie = val.split(";", 1)[0]
             self.cookies.append(cookie)
 
         if response.status != 200:
             raise xmlrpclib.ProtocolError(host + handler, response.status,
                                           response.reason, response.msg.headers)
 
         payload = response.read()
         parser, unmarshaller = self.getparser()
         parser.feed(payload)
         parser.close()
 
         return unmarshaller.close()
 
 # The explicit calls to the underlying xmlrpclib __init__() methods are
 # necessary. The xmlrpclib.Transport classes are old-style classes, and
 # it turns out their __init__() doesn't get called when doing multiple
 # inheritance with a new-style class.
 class cookietransport(cookietransportrequest, xmlrpclib.Transport):
     def __init__(self, use_datetime=0):
         if util.safehasattr(xmlrpclib.Transport, "__init__"):
             xmlrpclib.Transport.__init__(self, use_datetime)
 
 class cookiesafetransport(cookietransportrequest, xmlrpclib.SafeTransport):
     def __init__(self, use_datetime=0):
         if util.safehasattr(xmlrpclib.Transport, "__init__"):
             xmlrpclib.SafeTransport.__init__(self, use_datetime)
 
 class bzxmlrpc(bzaccess):
     """Support for access to Bugzilla via the Bugzilla XMLRPC API.
 
     Requires a minimum Bugzilla version 3.4.
     """
 
     def __init__(self, ui):
         bzaccess.__init__(self, ui)
 
         bzweb = self.ui.config('bugzilla', 'bzurl',
                                'http://localhost/bugzilla/')
         bzweb = bzweb.rstrip("/") + "/xmlrpc.cgi"
 
         user = self.ui.config('bugzilla', 'user', 'bugs')
         passwd = self.ui.config('bugzilla', 'password')
 
         self.fixstatus = self.ui.config('bugzilla', 'fixstatus', 'RESOLVED')
         self.fixresolution = self.ui.config('bugzilla', 'fixresolution',
                                             'FIXED')
 
         self.bzproxy = xmlrpclib.ServerProxy(bzweb, self.transport(bzweb))
         ver = self.bzproxy.Bugzilla.version()['version'].split('.')
         self.bzvermajor = int(ver[0])
         self.bzverminor = int(ver[1])
         self.bzproxy.User.login(dict(login=user, password=passwd))
 
     def transport(self, uri):
         if urlparse.urlparse(uri, "http")[0] == "https":
             return cookiesafetransport()
         else:
             return cookietransport()
 
     def get_bug_comments(self, id):
         """Return a string with all comment text for a bug."""
         c = self.bzproxy.Bug.comments(dict(ids=[id], include_fields=['text']))
         return ''.join([t['text'] for t in c['bugs'][str(id)]['comments']])
 
     def filter_real_bug_ids(self, bugs):
         probe = self.bzproxy.Bug.get(dict(ids=sorted(bugs.keys()),
                                           include_fields=[],
                                           permissive=True))
         for badbug in probe['faults']:
             id = badbug['id']
             self.ui.status(_('bug %d does not exist\n') % id)
             del bugs[id]
 
     def filter_cset_known_bug_ids(self, node, bugs):
         for id in sorted(bugs.keys()):
             if self.get_bug_comments(id).find(short(node)) != -1:
                 self.ui.status(_('bug %d already knows about changeset %s\n') %
                                (id, short(node)))
                 del bugs[id]
 
     def updatebug(self, bugid, newstate, text, committer):
         args = {}
         if 'hours' in newstate:
             args['work_time'] = newstate['hours']
 
         if self.bzvermajor >= 4:
             args['ids'] = [bugid]
             args['comment'] = {'body' : text}
             if 'fix' in newstate:
                 args['status'] = self.fixstatus
                 args['resolution'] = self.fixresolution
             self.bzproxy.Bug.update(args)
         else:
             if 'fix' in newstate:
                 self.ui.warn(_("Bugzilla/XMLRPC needs Bugzilla 4.0 or later "
                                "to mark bugs fixed\n"))
             args['id'] = bugid
             args['comment'] = text
             self.bzproxy.Bug.add_comment(args)
 
 class bzxmlrpcemail(bzxmlrpc):
     """Read data from Bugzilla via XMLRPC, send updates via email.
 
     Advantages of sending updates via email:
       1. Comments can be added as any user, not just logged in user.
       2. Bug statuses or other fields not accessible via XMLRPC can
          potentially be updated.
 
     There is no XMLRPC function to change bug status before Bugzilla
     4.0, so bugs cannot be marked fixed via XMLRPC before Bugzilla 4.0.
     But bugs can be marked fixed via email from 3.4 onwards.
     """
 
     # The email interface changes subtly between 3.4 and 3.6. In 3.4,
     # in-email fields are specified as '@<fieldname> = <value>'. In
     # 3.6 this becomes '@<fieldname> <value>'. And fieldname @bug_id
     # in 3.4 becomes @id in 3.6. 3.6 and 4.0 both maintain backwards
     # compatibility, but rather than rely on this use the new format for
     # 4.0 onwards.
 
     def __init__(self, ui):
         bzxmlrpc.__init__(self, ui)
 
         self.bzemail = self.ui.config('bugzilla', 'bzemail')
         if not self.bzemail:
             raise util.Abort(_("configuration 'bzemail' missing"))
         mail.validateconfig(self.ui)
 
     def makecommandline(self, fieldname, value):
         if self.bzvermajor >= 4:
             return "@%s %s" % (fieldname, str(value))
         else:
             if fieldname == "id":
                 fieldname = "bug_id"
             return "@%s = %s" % (fieldname, str(value))
 
     def send_bug_modify_email(self, bugid, commands, comment, committer):
         '''send modification message to Bugzilla bug via email.
 
         The message format is documented in the Bugzilla email_in.pl
         specification. commands is a list of command lines, comment is the
         comment text.
 
         To stop users from crafting commit comments with
         Bugzilla commands, specify the bug ID via the message body, rather
         than the subject line, and leave a blank line after it.
         '''
         user = self.map_committer(committer)
         matches = self.bzproxy.User.get(dict(match=[user]))
         if not matches['users']:
             user = self.ui.config('bugzilla', 'user', 'bugs')
             matches = self.bzproxy.User.get(dict(match=[user]))
             if not matches['users']:
                 raise util.Abort(_("default bugzilla user %s email not found") %
                                  user)
         user = matches['users'][0]['email']
         commands.append(self.makecommandline("id", bugid))
 
         text = "\n".join(commands) + "\n\n" + comment
 
         _charsets = mail._charsets(self.ui)
         user = mail.addressencode(self.ui, user, _charsets)
         bzemail = mail.addressencode(self.ui, self.bzemail, _charsets)
         msg = mail.mimeencode(self.ui, text, _charsets)
         msg['From'] = user
         msg['To'] = bzemail
         msg['Subject'] = mail.headencode(self.ui, "Bug modification", _charsets)
         sendmail = mail.connect(self.ui)
         sendmail(user, bzemail, msg.as_string())
 
     def updatebug(self, bugid, newstate, text, committer):
         cmds = []
         if 'hours' in newstate:
             cmds.append(self.makecommandline("work_time", newstate['hours']))
         if 'fix' in newstate:
             cmds.append(self.makecommandline("bug_status", self.fixstatus))
             cmds.append(self.makecommandline("resolution", self.fixresolution))
         self.send_bug_modify_email(bugid, cmds, text, committer)
 
 class bugzilla(object):
     # supported versions of bugzilla. different versions have
     # different schemas.
     _versions = {
         '2.16': bzmysql,
         '2.18': bzmysql_2_18,
         '3.0':  bzmysql_3_0,
         'xmlrpc': bzxmlrpc,
         'xmlrpc+email': bzxmlrpcemail
         }
 
     _default_bug_re = (r'bugs?\s*,?\s*(?:#|nos?\.?|num(?:ber)?s?)?\s*'
                        r'(?P<ids>(?:\d+\s*(?:,?\s*(?:and)?)?\s*)+)'
                        r'\.?\s*(?:h(?:ours?)?\s*(?P<hours>\d*(?:\.\d+)?))?')
 
     _default_fix_re = (r'fix(?:es)?\s*(?:bugs?\s*)?,?\s*'
                        r'(?:nos?\.?|num(?:ber)?s?)?\s*'
                        r'(?P<ids>(?:#?\d+\s*(?:,?\s*(?:and)?)?\s*)+)'
                        r'\.?\s*(?:h(?:ours?)?\s*(?P<hours>\d*(?:\.\d+)?))?')
 
     _bz = None
 
     def __init__(self, ui, repo):
         self.ui = ui
         self.repo = repo
 
     def bz(self):
         '''return object that knows how to talk to bugzilla version in
         use.'''
 
         if bugzilla._bz is None:
             bzversion = self.ui.config('bugzilla', 'version')
             try:
                 bzclass = bugzilla._versions[bzversion]
             except KeyError:
                 raise util.Abort(_('bugzilla version %s not supported') %
                                  bzversion)
             bugzilla._bz = bzclass(self.ui)
         return bugzilla._bz
 
     def __getattr__(self, key):
         return getattr(self.bz(), key)
 
     _bug_re = None
     _fix_re = None
     _split_re = None
 
     def find_bugs(self, ctx):
         '''return bugs dictionary created from commit comment.
 
         Extract bug info from changeset comments. Filter out any that are
         not known to Bugzilla, and any that already have a reference to
         the given changeset in their comments.
         '''
         if bugzilla._bug_re is None:
             bugzilla._bug_re = re.compile(
                 self.ui.config('bugzilla', 'regexp',
                                bugzilla._default_bug_re), re.IGNORECASE)
             bugzilla._fix_re = re.compile(
                 self.ui.config('bugzilla', 'fixregexp',
                                bugzilla._default_fix_re), re.IGNORECASE)
             bugzilla._split_re = re.compile(r'\D+')
         start = 0
         hours = 0.0
         bugs = {}
         bugmatch = bugzilla._bug_re.search(ctx.description(), start)
         fixmatch = bugzilla._fix_re.search(ctx.description(), start)
         while True:
             bugattribs = {}
             if not bugmatch and not fixmatch:
                 break
             if not bugmatch:
                 m = fixmatch
             elif not fixmatch:
                 m = bugmatch
             else:
                 if bugmatch.start() < fixmatch.start():
                     m = bugmatch
                 else:
                     m = fixmatch
             start = m.end()
             if m is bugmatch:
                 bugmatch = bugzilla._bug_re.search(ctx.description(), start)
                 if 'fix' in bugattribs:
                     del bugattribs['fix']
             else:
                 fixmatch = bugzilla._fix_re.search(ctx.description(), start)
                 bugattribs['fix'] = None
 
             try:
                 ids = m.group('ids')
             except IndexError:
                 ids = m.group(1)
             try:
                 hours = float(m.group('hours'))
                 bugattribs['hours'] = hours
             except IndexError:
                 pass
             except TypeError:
                 pass
             except ValueError:
                 self.ui.status(_("%s: invalid hours\n") % m.group('hours'))
 
             for id in bugzilla._split_re.split(ids):
                 if not id:
                     continue
                 bugs[int(id)] = bugattribs
         if bugs:
             self.filter_real_bug_ids(bugs)
         if bugs:
             self.filter_cset_known_bug_ids(ctx.node(), bugs)
         return bugs
 
     def update(self, bugid, newstate, ctx):
         '''update bugzilla bug with reference to changeset.'''
 
         def webroot(root):
             '''strip leading prefix of repo root and turn into
             url-safe path.'''
             count = int(self.ui.config('bugzilla', 'strip', 0))
             root = util.pconvert(root)
             while count > 0:
                 c = root.find('/')
                 if c == -1:
                     break
                 root = root[c + 1:]
                 count -= 1
             return root
 
         mapfile = self.ui.config('bugzilla', 'style')
         tmpl = self.ui.config('bugzilla', 'template')
         t = cmdutil.changeset_templater(self.ui, self.repo,
                                         False, None, mapfile, False)
         if not mapfile and not tmpl:
             tmpl = _('changeset {node|short} in repo {root} refers '
                      'to bug {bug}.\ndetails:\n\t{desc|tabindent}')
         if tmpl:
             tmpl = templater.parsestring(tmpl, quoted=False)
             t.use_template(tmpl)
         self.ui.pushbuffer()
         t.show(ctx, changes=ctx.changeset(),
                bug=str(bugid),
                hgweb=self.ui.config('web', 'baseurl'),
                root=self.repo.root,
                webroot=webroot(self.repo.root))
         data = self.ui.popbuffer()
         self.updatebug(bugid, newstate, data, util.email(ctx.user()))
 
 def hook(ui, repo, hooktype, node=None, **kwargs):
     '''add comment to bugzilla for each changeset that refers to a
     bugzilla bug id. only add a comment once per bug, so same change
     seen multiple times does not fill bug with duplicate data.'''
     if node is None:
         raise util.Abort(_('hook type %s does not pass a changeset id') %
                          hooktype)
     try:
         bz = bugzilla(ui, repo)
         ctx = repo[node]
         bugs = bz.find_bugs(ctx)
         if bugs:
             for bug in bugs:
                 bz.update(bug, bugs[bug], ctx)
             bz.notify(bugs, util.email(ctx.user()))
     except Exception, e:
         raise util.Abort(_('Bugzilla error: %s') % e)

hgext/convert/transport.py

@@ -1,128 +1,128 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2007 Daniel Holth <[e-mail]>
 # This is a stripped-down version of the original bzr-svn transport.py,
 # Copyright (C) 2006 Jelmer Vernooij <[e-mail]>
 
 # This program 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 of the License, or
 # (at your option) any later version.
 
 # This program 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 this program; if not, see <http://www.gnu.org/licenses/>.
 
 from mercurial import util
 from svn.core import SubversionException, Pool
 import svn.ra
 import svn.client
 import svn.core
 
 # Some older versions of the Python bindings need to be
 # explicitly initialized. But what we want to do probably
 # won't work worth a darn against those libraries anyway!
 svn.ra.initialize()
 
 svn_config = svn.core.svn_config_get_config(None)
 
 
 def _create_auth_baton(pool):
     """Create a Subversion authentication baton. """
     import svn.client
     # Give the client context baton a suite of authentication
     # providers.h
     providers = [
         svn.client.get_simple_provider(pool),
         svn.client.get_username_provider(pool),
         svn.client.get_ssl_client_cert_file_provider(pool),
         svn.client.get_ssl_client_cert_pw_file_provider(pool),
         svn.client.get_ssl_server_trust_file_provider(pool),
         ]
-    # Platform-dependant authentication methods
+    # Platform-dependent authentication methods
     getprovider = getattr(svn.core, 'svn_auth_get_platform_specific_provider',
                           None)
     if getprovider:
         # Available in svn >= 1.6
         for name in ('gnome_keyring', 'keychain', 'kwallet', 'windows'):
             for type in ('simple', 'ssl_client_cert_pw', 'ssl_server_trust'):
                 p = getprovider(name, type, pool)
                 if p:
                     providers.append(p)
     else:
         if util.safehasattr(svn.client, 'get_windows_simple_provider'):
             providers.append(svn.client.get_windows_simple_provider(pool))
 
     return svn.core.svn_auth_open(providers, pool)
 
 class NotBranchError(SubversionException):
     pass
 
 class SvnRaTransport(object):
     """
     Open an ra connection to a Subversion repository.
     """
     def __init__(self, url="", ra=None):
         self.pool = Pool()
         self.svn_url = url
         self.username = ''
         self.password = ''
 
         # Only Subversion 1.4 has reparent()
         if ra is None or not util.safehasattr(svn.ra, 'reparent'):
             self.client = svn.client.create_context(self.pool)
             ab = _create_auth_baton(self.pool)
             if False:
                 svn.core.svn_auth_set_parameter(
                     ab, svn.core.SVN_AUTH_PARAM_DEFAULT_USERNAME, self.username)
                 svn.core.svn_auth_set_parameter(
                     ab, svn.core.SVN_AUTH_PARAM_DEFAULT_PASSWORD, self.password)
             self.client.auth_baton = ab
             self.client.config = svn_config
             try:
                 self.ra = svn.client.open_ra_session(
                     self.svn_url,
                     self.client, self.pool)
             except SubversionException, (inst, num):
                 if num in (svn.core.SVN_ERR_RA_ILLEGAL_URL,
                            svn.core.SVN_ERR_RA_LOCAL_REPOS_OPEN_FAILED,
                            svn.core.SVN_ERR_BAD_URL):
                     raise NotBranchError(url)
                 raise
         else:
             self.ra = ra
             svn.ra.reparent(self.ra, self.svn_url.encode('utf8'))
 
     class Reporter(object):
         def __init__(self, reporter_data):
             self._reporter, self._baton = reporter_data
 
         def set_path(self, path, revnum, start_empty, lock_token, pool=None):
             svn.ra.reporter2_invoke_set_path(self._reporter, self._baton,
                         path, revnum, start_empty, lock_token, pool)
 
         def delete_path(self, path, pool=None):
             svn.ra.reporter2_invoke_delete_path(self._reporter, self._baton,
                     path, pool)
 
         def link_path(self, path, url, revision, start_empty, lock_token,
                       pool=None):
             svn.ra.reporter2_invoke_link_path(self._reporter, self._baton,
                     path, url, revision, start_empty, lock_token,
                     pool)
 
         def finish_report(self, pool=None):
             svn.ra.reporter2_invoke_finish_report(self._reporter,
                     self._baton, pool)
 
         def abort_report(self, pool=None):
             svn.ra.reporter2_invoke_abort_report(self._reporter,
                     self._baton, pool)
 
     def do_update(self, revnum, path, *args, **kwargs):
         return self.Reporter(svn.ra.do_update(self.ra, revnum, path,
                                               *args, **kwargs))

hgext/eol.py

@@ -1,349 +1,349 b''
 """automatically manage newlines in repository files
 
 This extension allows you to manage the type of line endings (CRLF or
 LF) that are used in the repository and in the local working
 directory. That way you can get CRLF line endings on Windows and LF on
 Unix/Mac, thereby letting everybody use their OS native line endings.
 
 The extension reads its configuration from a versioned ``.hgeol``
 configuration file found in the root of the working copy. The
 ``.hgeol`` file use the same syntax as all other Mercurial
 configuration files. It uses two sections, ``[patterns]`` and
 ``[repository]``.
 
 The ``[patterns]`` section specifies how line endings should be
 converted between the working copy and the repository. The format is
 specified by a file pattern. The first match is used, so put more
 specific patterns first. The available line endings are ``LF``,
 ``CRLF``, and ``BIN``.
 
 Files with the declared format of ``CRLF`` or ``LF`` are always
 checked out and stored in the repository in that format and files
 declared to be binary (``BIN``) are left unchanged. Additionally,
 ``native`` is an alias for checking out in the platform's default line
 ending: ``LF`` on Unix (including Mac OS X) and ``CRLF`` on
 Windows. Note that ``BIN`` (do nothing to line endings) is Mercurial's
 default behaviour; it is only needed if you need to override a later,
 more general pattern.
 
 The optional ``[repository]`` section specifies the line endings to
 use for files stored in the repository. It has a single setting,
 ``native``, which determines the storage line endings for files
 declared as ``native`` in the ``[patterns]`` section. It can be set to
 ``LF`` or ``CRLF``. The default is ``LF``. For example, this means
 that on Windows, files configured as ``native`` (``CRLF`` by default)
 will be converted to ``LF`` when stored in the repository. Files
 declared as ``LF``, ``CRLF``, or ``BIN`` in the ``[patterns]`` section
 are always stored as-is in the repository.
 
 Example versioned ``.hgeol`` file::
 
   [patterns]
   **.py = native
   **.vcproj = CRLF
   **.txt = native
   Makefile = LF
   **.jpg = BIN
 
   [repository]
   native = LF
 
 .. note::
    The rules will first apply when files are touched in the working
    copy, e.g. by updating to null and back to tip to touch all files.
 
 The extension uses an optional ``[eol]`` section read from both the
 normal Mercurial configuration files and the ``.hgeol`` file, with the
 latter overriding the former. You can use that section to control the
 overall behavior. There are three settings:
 
 - ``eol.native`` (default ``os.linesep``) can be set to ``LF`` or
   ``CRLF`` to override the default interpretation of ``native`` for
   checkout. This can be used with :hg:`archive` on Unix, say, to
   generate an archive where files have line endings for Windows.
 
 - ``eol.only-consistent`` (default True) can be set to False to make
   the extension convert files with inconsistent EOLs. Inconsistent
   means that there is both ``CRLF`` and ``LF`` present in the file.
   Such files are normally not touched under the assumption that they
   have mixed EOLs on purpose.
 
 - ``eol.fix-trailing-newline`` (default False) can be set to True to
   ensure that converted files end with a EOL character (either ``\\n``
   or ``\\r\\n`` as per the configured patterns).
 
 The extension provides ``cleverencode:`` and ``cleverdecode:`` filters
 like the deprecated win32text extension does. This means that you can
 disable win32text and enable eol and your filters will still work. You
 only need to these filters until you have prepared a ``.hgeol`` file.
 
 The ``win32text.forbid*`` hooks provided by the win32text extension
 have been unified into a single hook named ``eol.checkheadshook``. The
 hook will lookup the expected line endings from the ``.hgeol`` file,
 which means you must migrate to a ``.hgeol`` file first before using
 the hook. ``eol.checkheadshook`` only checks heads, intermediate
 invalid revisions will be pushed. To forbid them completely, use the
 ``eol.checkallhook`` hook. These hooks are best used as
 ``pretxnchangegroup`` hooks.
 
 See :hg:`help patterns` for more information about the glob patterns
 used.
 """
 
 from mercurial.i18n import _
 from mercurial import util, config, extensions, match, error
 import re, os
 
 testedwith = 'internal'
 
 # Matches a lone LF, i.e., one that is not part of CRLF.
 singlelf = re.compile('(^|[^\r])\n')
 # Matches a single EOL which can either be a CRLF where repeated CR
-# are removed or a LF. We do not care about old Machintosh files, so a
+# are removed or a LF. We do not care about old Macintosh files, so a
 # stray CR is an error.
 eolre = re.compile('\r*\n')
 
 
 def inconsistenteol(data):
     return '\r\n' in data and singlelf.search(data)
 
 def tolf(s, params, ui, **kwargs):
     """Filter to convert to LF EOLs."""
     if util.binary(s):
         return s
     if ui.configbool('eol', 'only-consistent', True) and inconsistenteol(s):
         return s
     if (ui.configbool('eol', 'fix-trailing-newline', False)
         and s and s[-1] != '\n'):
         s = s + '\n'
     return eolre.sub('\n', s)
 
 def tocrlf(s, params, ui, **kwargs):
     """Filter to convert to CRLF EOLs."""
     if util.binary(s):
         return s
     if ui.configbool('eol', 'only-consistent', True) and inconsistenteol(s):
         return s
     if (ui.configbool('eol', 'fix-trailing-newline', False)
         and s and s[-1] != '\n'):
         s = s + '\n'
     return eolre.sub('\r\n', s)
 
 def isbinary(s, params):
     """Filter to do nothing with the file."""
     return s
 
 filters = {
     'to-lf': tolf,
     'to-crlf': tocrlf,
     'is-binary': isbinary,
     # The following provide backwards compatibility with win32text
     'cleverencode:': tolf,
     'cleverdecode:': tocrlf
 }
 
 class eolfile(object):
     def __init__(self, ui, root, data):
         self._decode = {'LF': 'to-lf', 'CRLF': 'to-crlf', 'BIN': 'is-binary'}
         self._encode = {'LF': 'to-lf', 'CRLF': 'to-crlf', 'BIN': 'is-binary'}
 
         self.cfg = config.config()
         # Our files should not be touched. The pattern must be
         # inserted first override a '** = native' pattern.
         self.cfg.set('patterns', '.hg*', 'BIN')
         # We can then parse the user's patterns.
         self.cfg.parse('.hgeol', data)
 
         isrepolf = self.cfg.get('repository', 'native') != 'CRLF'
         self._encode['NATIVE'] = isrepolf and 'to-lf' or 'to-crlf'
         iswdlf = ui.config('eol', 'native', os.linesep) in ('LF', '\n')
         self._decode['NATIVE'] = iswdlf and 'to-lf' or 'to-crlf'
 
         include = []
         exclude = []
         for pattern, style in self.cfg.items('patterns'):
             key = style.upper()
             if key == 'BIN':
                 exclude.append(pattern)
             else:
                 include.append(pattern)
         # This will match the files for which we need to care
         # about inconsistent newlines.
         self.match = match.match(root, '', [], include, exclude)
 
     def copytoui(self, ui):
         for pattern, style in self.cfg.items('patterns'):
             key = style.upper()
             try:
                 ui.setconfig('decode', pattern, self._decode[key])
                 ui.setconfig('encode', pattern, self._encode[key])
             except KeyError:
                 ui.warn(_("ignoring unknown EOL style '%s' from %s\n")
                         % (style, self.cfg.source('patterns', pattern)))
         # eol.only-consistent can be specified in ~/.hgrc or .hgeol
         for k, v in self.cfg.items('eol'):
             ui.setconfig('eol', k, v)
 
     def checkrev(self, repo, ctx, files):
         failed = []
         for f in (files or ctx.files()):
             if f not in ctx:
                 continue
             for pattern, style in self.cfg.items('patterns'):
                 if not match.match(repo.root, '', [pattern])(f):
                     continue
                 target = self._encode[style.upper()]
                 data = ctx[f].data()
                 if (target == "to-lf" and "\r\n" in data
                     or target == "to-crlf" and singlelf.search(data)):
                     failed.append((str(ctx), target, f))
                 break
         return failed
 
 def parseeol(ui, repo, nodes):
     try:
         for node in nodes:
             try:
                 if node is None:
                     # Cannot use workingctx.data() since it would load
                     # and cache the filters before we configure them.
                     data = repo.wfile('.hgeol').read()
                 else:
                     data = repo[node]['.hgeol'].data()
                 return eolfile(ui, repo.root, data)
             except (IOError, LookupError):
                 pass
     except error.ParseError, inst:
         ui.warn(_("warning: ignoring .hgeol file due to parse error "
                   "at %s: %s\n") % (inst.args[1], inst.args[0]))
     return None
 
 def _checkhook(ui, repo, node, headsonly):
     # Get revisions to check and touched files at the same time
     files = set()
     revs = set()
     for rev in xrange(repo[node].rev(), len(repo)):
         revs.add(rev)
         if headsonly:
             ctx = repo[rev]
             files.update(ctx.files())
             for pctx in ctx.parents():
                 revs.discard(pctx.rev())
     failed = []
     for rev in revs:
         ctx = repo[rev]
         eol = parseeol(ui, repo, [ctx.node()])
         if eol:
             failed.extend(eol.checkrev(repo, ctx, files))
 
     if failed:
         eols = {'to-lf': 'CRLF', 'to-crlf': 'LF'}
         msgs = []
         for node, target, f in failed:
             msgs.append(_("  %s in %s should not have %s line endings") %
                         (f, node, eols[target]))
         raise util.Abort(_("end-of-line check failed:\n") + "\n".join(msgs))
 
 def checkallhook(ui, repo, node, hooktype, **kwargs):
     """verify that files have expected EOLs"""
     _checkhook(ui, repo, node, False)
 
 def checkheadshook(ui, repo, node, hooktype, **kwargs):
     """verify that files have expected EOLs"""
     _checkhook(ui, repo, node, True)
 
 # "checkheadshook" used to be called "hook"
 hook = checkheadshook
 
 def preupdate(ui, repo, hooktype, parent1, parent2):
     repo.loadeol([parent1])
     return False
 
 def uisetup(ui):
     ui.setconfig('hooks', 'preupdate.eol', preupdate)
 
 def extsetup(ui):
     try:
         extensions.find('win32text')
         ui.warn(_("the eol extension is incompatible with the "
                   "win32text extension\n"))
     except KeyError:
         pass
 
 
 def reposetup(ui, repo):
     uisetup(repo.ui)
 
     if not repo.local():
         return
     for name, fn in filters.iteritems():
         repo.adddatafilter(name, fn)
 
     ui.setconfig('patch', 'eol', 'auto')
 
     class eolrepo(repo.__class__):
 
         def loadeol(self, nodes):
             eol = parseeol(self.ui, self, nodes)
             if eol is None:
                 return None
             eol.copytoui(self.ui)
             return eol.match
 
         def _hgcleardirstate(self):
             self._eolfile = self.loadeol([None, 'tip'])
             if not self._eolfile:
                 self._eolfile = util.never
                 return
 
             try:
                 cachemtime = os.path.getmtime(self.join("eol.cache"))
             except OSError:
                 cachemtime = 0
 
             try:
                 eolmtime = os.path.getmtime(self.wjoin(".hgeol"))
             except OSError:
                 eolmtime = 0
 
             if eolmtime > cachemtime:
                 ui.debug("eol: detected change in .hgeol\n")
                 wlock = None
                 try:
                     wlock = self.wlock()
                     for f in self.dirstate:
                         if self.dirstate[f] == 'n':
                             # all normal files need to be looked at
                             # again since the new .hgeol file might no
                             # longer match a file it matched before
                             self.dirstate.normallookup(f)
                     # Create or touch the cache to update mtime
                     self.opener("eol.cache", "w").close()
                     wlock.release()
                 except error.LockUnavailable:
                     # If we cannot lock the repository and clear the
                     # dirstate, then a commit might not see all files
                     # as modified. But if we cannot lock the
                     # repository, then we can also not make a commit,
                     # so ignore the error.
                     pass
 
         def commitctx(self, ctx, error=False):
             for f in sorted(ctx.added() + ctx.modified()):
                 if not self._eolfile(f):
                     continue
                 try:
                     data = ctx[f].data()
                 except IOError:
                     continue
                 if util.binary(data):
                     # We should not abort here, since the user should
                     # be able to say "** = native" to automatically
                     # have all non-binary files taken care of.
                     continue
                 if inconsistenteol(data):
                     raise util.Abort(_("inconsistent newline style "
                                        "in %s\n" % f))
             return super(eolrepo, self).commitctx(ctx, error)
     repo.__class__ = eolrepo
     repo._hgcleardirstate()

hgext/inotify/linux/_inotify.c

@@ -1,649 +1,649 b''
 /*
  * _inotify.c - Python extension interfacing to the Linux inotify subsystem
  *
  * Copyright 2006 Bryan O'Sullivan <[e-mail]>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of version 2.1 of the GNU Lesser General
  * Public License or any later version.
  */
 
 #include <Python.h>
 #include <alloca.h>
 #include <sys/inotify.h>
 #include <stdint.h>
 #include <sys/ioctl.h>
 #include <unistd.h>
 
 #include <util.h>
 
 /* Variables used in the event string representation */
 static PyObject *join;
 static PyObject *er_wm;
 static PyObject *er_wmc;
 static PyObject *er_wmn;
 static PyObject *er_wmcn;
 
 static PyObject *init(PyObject *self, PyObject *args)
 {
 	PyObject *ret = NULL;
 	int fd = -1;
 
 	if (!PyArg_ParseTuple(args, ":init"))
 		goto bail;
 
 	Py_BEGIN_ALLOW_THREADS;
 	fd = inotify_init();
 	Py_END_ALLOW_THREADS;
 
 	if (fd == -1) {
 		PyErr_SetFromErrno(PyExc_OSError);
 		goto bail;
 	}
 
 	ret = PyInt_FromLong(fd);
 	if (ret == NULL)
 		goto bail;
 
 	goto done;
 
 bail:
 	if (fd != -1)
 		close(fd);
 
 	Py_CLEAR(ret);
 
 done:
 	return ret;
 }
 
 PyDoc_STRVAR(
 	init_doc,
 	"init() -> fd\n"
 	"\n"
-	"Initialise an inotify instance.\n"
+	"Initialize an inotify instance.\n"
 	"Return a file descriptor associated with a new inotify event queue.");
 
 static PyObject *add_watch(PyObject *self, PyObject *args)
 {
 	PyObject *ret = NULL;
 	uint32_t mask;
 	int wd = -1;
 	char *path;
 	int fd;
 
 	if (!PyArg_ParseTuple(args, "isI:add_watch", &fd, &path, &mask))
 		goto bail;
 
 	Py_BEGIN_ALLOW_THREADS;
 	wd = inotify_add_watch(fd, path, mask);
 	Py_END_ALLOW_THREADS;
 
 	if (wd == -1) {
 		PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
 		goto bail;
 	}
 
 	ret = PyInt_FromLong(wd);
 	if (ret == NULL)
 		goto bail;
 
 	goto done;
 
 bail:
 	if (wd != -1)
 		inotify_rm_watch(fd, wd);
 
 	Py_CLEAR(ret);
 
 done:
 	return ret;
 }
 
 PyDoc_STRVAR(
 	add_watch_doc,
 	"add_watch(fd, path, mask) -> wd\n"
 	"\n"
 	"Add a watch to an inotify instance, or modify an existing watch.\n"
 	"\n"
 	"        fd: file descriptor returned by init()\n"
 	"        path: path to watch\n"
 	"        mask: mask of events to watch for\n"
 	"\n"
 	"Return a unique numeric watch descriptor for the inotify instance\n"
 	"mapped by the file descriptor.");
 
 static PyObject *remove_watch(PyObject *self, PyObject *args)
 {
 	uint32_t wd;
 	int fd;
 	int r;
 
 	if (!PyArg_ParseTuple(args, "iI:remove_watch", &fd, &wd))
 		return NULL;
 
 	Py_BEGIN_ALLOW_THREADS;
 	r = inotify_rm_watch(fd, wd);
 	Py_END_ALLOW_THREADS;
 
 	if (r == -1) {
 		PyErr_SetFromErrno(PyExc_OSError);
 		return NULL;
 	}
 
 	Py_INCREF(Py_None);
 	return Py_None;
 }
 
 PyDoc_STRVAR(
 	remove_watch_doc,
 	"remove_watch(fd, wd)\n"
 	"\n"
 	"        fd: file descriptor returned by init()\n"
 	"        wd: watch descriptor returned by add_watch()\n"
 	"\n"
 	"Remove a watch associated with the watch descriptor wd from the\n"
 	"inotify instance associated with the file descriptor fd.\n"
 	"\n"
 	"Removing a watch causes an IN_IGNORED event to be generated for this\n"
 	"watch descriptor.");
 
 #define bit_name(x) {x, #x}
 
 static struct {
 	int bit;
 	const char *name;
 	PyObject *pyname;
 } bit_names[] = {
 	bit_name(IN_ACCESS),
 	bit_name(IN_MODIFY),
 	bit_name(IN_ATTRIB),
 	bit_name(IN_CLOSE_WRITE),
 	bit_name(IN_CLOSE_NOWRITE),
 	bit_name(IN_OPEN),
 	bit_name(IN_MOVED_FROM),
 	bit_name(IN_MOVED_TO),
 	bit_name(IN_CREATE),
 	bit_name(IN_DELETE),
 	bit_name(IN_DELETE_SELF),
 	bit_name(IN_MOVE_SELF),
 	bit_name(IN_UNMOUNT),
 	bit_name(IN_Q_OVERFLOW),
 	bit_name(IN_IGNORED),
 	bit_name(IN_ONLYDIR),
 	bit_name(IN_DONT_FOLLOW),
 	bit_name(IN_MASK_ADD),
 	bit_name(IN_ISDIR),
 	bit_name(IN_ONESHOT),
 	{0}
 };
 
 static PyObject *decode_mask(int mask)
 {
 	PyObject *ret = PyList_New(0);
 	int i;
 
 	if (ret == NULL)
 		goto bail;
 
 	for (i = 0; bit_names[i].bit; i++) {
 		if (mask & bit_names[i].bit) {
 			if (bit_names[i].pyname == NULL) {
 				bit_names[i].pyname = PyString_FromString(bit_names[i].name);
 				if (bit_names[i].pyname == NULL)
 					goto bail;
 			}
 			Py_INCREF(bit_names[i].pyname);
 			if (PyList_Append(ret, bit_names[i].pyname) == -1)
 				goto bail;
 		}
 	}
 
 	goto done;
 
 bail:
 	Py_CLEAR(ret);
 
 done:
 	return ret;
 }
 
 static PyObject *pydecode_mask(PyObject *self, PyObject *args)
 {
 	int mask;
 
 	if (!PyArg_ParseTuple(args, "i:decode_mask", &mask))
 		return NULL;
 
 	return decode_mask(mask);
 }
 
 PyDoc_STRVAR(
 	decode_mask_doc,
 	"decode_mask(mask) -> list_of_strings\n"
 	"\n"
 	"Decode an inotify mask value into a list of strings that give the\n"
 	"name of each bit set in the mask.");
 
 static char doc[] = "Low-level inotify interface wrappers.";
 
 static void define_const(PyObject *dict, const char *name, uint32_t val)
 {
 	PyObject *pyval = PyInt_FromLong(val);
 	PyObject *pyname = PyString_FromString(name);
 
 	if (!pyname || !pyval)
 		goto bail;
 
 	PyDict_SetItem(dict, pyname, pyval);
 
 bail:
 	Py_XDECREF(pyname);
 	Py_XDECREF(pyval);
 }
 
 static void define_consts(PyObject *dict)
 {
 	define_const(dict, "IN_ACCESS", IN_ACCESS);
 	define_const(dict, "IN_MODIFY", IN_MODIFY);
 	define_const(dict, "IN_ATTRIB", IN_ATTRIB);
 	define_const(dict, "IN_CLOSE_WRITE", IN_CLOSE_WRITE);
 	define_const(dict, "IN_CLOSE_NOWRITE", IN_CLOSE_NOWRITE);
 	define_const(dict, "IN_OPEN", IN_OPEN);
 	define_const(dict, "IN_MOVED_FROM", IN_MOVED_FROM);
 	define_const(dict, "IN_MOVED_TO", IN_MOVED_TO);
 
 	define_const(dict, "IN_CLOSE", IN_CLOSE);
 	define_const(dict, "IN_MOVE", IN_MOVE);
 
 	define_const(dict, "IN_CREATE", IN_CREATE);
 	define_const(dict, "IN_DELETE", IN_DELETE);
 	define_const(dict, "IN_DELETE_SELF", IN_DELETE_SELF);
 	define_const(dict, "IN_MOVE_SELF", IN_MOVE_SELF);
 	define_const(dict, "IN_UNMOUNT", IN_UNMOUNT);
 	define_const(dict, "IN_Q_OVERFLOW", IN_Q_OVERFLOW);
 	define_const(dict, "IN_IGNORED", IN_IGNORED);
 
 	define_const(dict, "IN_ONLYDIR", IN_ONLYDIR);
 	define_const(dict, "IN_DONT_FOLLOW", IN_DONT_FOLLOW);
 	define_const(dict, "IN_MASK_ADD", IN_MASK_ADD);
 	define_const(dict, "IN_ISDIR", IN_ISDIR);
 	define_const(dict, "IN_ONESHOT", IN_ONESHOT);
 	define_const(dict, "IN_ALL_EVENTS", IN_ALL_EVENTS);
 }
 
 struct event {
 	PyObject_HEAD
 	PyObject *wd;
 	PyObject *mask;
 	PyObject *cookie;
 	PyObject *name;
 };
 
 static PyObject *event_wd(PyObject *self, void *x)
 {
 	struct event *evt = (struct event *)self;
 	Py_INCREF(evt->wd);
 	return evt->wd;
 }
 
 static PyObject *event_mask(PyObject *self, void *x)
 {
 	struct event *evt = (struct event *)self;
 	Py_INCREF(evt->mask);
 	return evt->mask;
 }
 
 static PyObject *event_cookie(PyObject *self, void *x)
 {
 	struct event *evt = (struct event *)self;
 	Py_INCREF(evt->cookie);
 	return evt->cookie;
 }
 
 static PyObject *event_name(PyObject *self, void *x)
 {
 	struct event *evt = (struct event *)self;
 	Py_INCREF(evt->name);
 	return evt->name;
 }
 
 static struct PyGetSetDef event_getsets[] = {
 	{"wd", event_wd, NULL,
 	 "watch descriptor"},
 	{"mask", event_mask, NULL,
 	 "event mask"},
 	{"cookie", event_cookie, NULL,
 	 "rename cookie, if rename-related event"},
 	{"name", event_name, NULL,
 	 "file name"},
 	{NULL}
 };
 
 PyDoc_STRVAR(
 	event_doc,
 	"event: Structure describing an inotify event.");
 
 static PyObject *event_new(PyTypeObject *t, PyObject *a, PyObject *k)
 {
 	return (*t->tp_alloc)(t, 0);
 }
 
 static void event_dealloc(struct event *evt)
 {
 	Py_XDECREF(evt->wd);
 	Py_XDECREF(evt->mask);
 	Py_XDECREF(evt->cookie);
 	Py_XDECREF(evt->name);
 
 	Py_TYPE(evt)->tp_free(evt);
 }
 
 static PyObject *event_repr(struct event *evt)
 {
 	int cookie = evt->cookie == Py_None ? -1 : PyInt_AsLong(evt->cookie);
 	PyObject *ret = NULL, *pymasks = NULL, *pymask = NULL;
 	PyObject *tuple = NULL, *formatstr = NULL;
 
 	pymasks = decode_mask(PyInt_AsLong(evt->mask));
 	if (pymasks == NULL)
 		goto bail;
 
 	pymask = _PyString_Join(join, pymasks);
 	if (pymask == NULL)
 		goto bail;
 
 	if (evt->name != Py_None) {
 		if (cookie == -1) {
 			formatstr = er_wmn;
 			tuple = PyTuple_Pack(3, evt->wd, pymask, evt->name);
 		}
 		else {
 			formatstr = er_wmcn;
 			tuple = PyTuple_Pack(4, evt->wd, pymask,
 					     evt->cookie, evt->name);
 		}
 	} else {
 		if (cookie == -1) {
 			formatstr = er_wm;
 			tuple = PyTuple_Pack(2, evt->wd, pymask);
 		}
 		else {
 			formatstr = er_wmc;
 			tuple = PyTuple_Pack(3, evt->wd, pymask, evt->cookie);
 		}
 	}
 
 	if (tuple == NULL)
 		goto bail;
 
 	ret = PyNumber_Remainder(formatstr, tuple);
 
 	if (ret == NULL)
 		goto bail;
 
 	goto done;
 bail:
 	Py_CLEAR(ret);
 
 done:
 	Py_XDECREF(pymask);
 	Py_XDECREF(pymasks);
 	Py_XDECREF(tuple);
 
 	return ret;
 }
 
 static PyTypeObject event_type = {
 	PyVarObject_HEAD_INIT(NULL, 0)
 	"_inotify.event",             /*tp_name*/
 	sizeof(struct event), /*tp_basicsize*/
 	0,                         /*tp_itemsize*/
 	(destructor)event_dealloc, /*tp_dealloc*/
 	0,                         /*tp_print*/
 	0,                         /*tp_getattr*/
 	0,                         /*tp_setattr*/
 	0,                         /*tp_compare*/
 	(reprfunc)event_repr,      /*tp_repr*/
 	0,                         /*tp_as_number*/
 	0,                         /*tp_as_sequence*/
 	0,                         /*tp_as_mapping*/
 	0,                         /*tp_hash */
 	0,                         /*tp_call*/
 	0,                         /*tp_str*/
 	0,                         /*tp_getattro*/
 	0,                         /*tp_setattro*/
 	0,                         /*tp_as_buffer*/
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
 	event_doc,           /* tp_doc */
 	0,                         /* tp_traverse */
 	0,                         /* tp_clear */
 	0,                         /* tp_richcompare */
 	0,                         /* tp_weaklistoffset */
 	0,                         /* tp_iter */
 	0,                         /* tp_iternext */
 	0,                         /* tp_methods */
 	0,                         /* tp_members */
 	event_getsets,      /* tp_getset */
 	0,                         /* tp_base */
 	0,                         /* tp_dict */
 	0,                         /* tp_descr_get */
 	0,                         /* tp_descr_set */
 	0,                         /* tp_dictoffset */
 	0,                         /* tp_init */
 	0,                         /* tp_alloc */
 	event_new,          /* tp_new */
 };
 
 PyObject *read_events(PyObject *self, PyObject *args)
 {
 	PyObject *ctor_args = NULL;
 	PyObject *pybufsize = NULL;
 	PyObject *ret = NULL;
 	int bufsize = 65536;
 	char *buf = NULL;
 	int nread, pos;
 	int fd;
 
 	if (!PyArg_ParseTuple(args, "i|O:read", &fd, &pybufsize))
 		goto bail;
 
 	if (pybufsize && pybufsize != Py_None)
 		bufsize = PyInt_AsLong(pybufsize);
 
 	ret = PyList_New(0);
 	if (ret == NULL)
 		goto bail;
 
 	if (bufsize <= 0) {
 		int r;
 
 		Py_BEGIN_ALLOW_THREADS;
 		r = ioctl(fd, FIONREAD, &bufsize);
 		Py_END_ALLOW_THREADS;
 
 		if (r == -1) {
 			PyErr_SetFromErrno(PyExc_OSError);
 			goto bail;
 		}
 		if (bufsize == 0)
 			goto done;
 	}
 	else {
 		static long name_max;
 		static long name_fd = -1;
 		long min;
 
 		if (name_fd != fd) {
 			name_fd = fd;
 			Py_BEGIN_ALLOW_THREADS;
 			name_max = fpathconf(fd, _PC_NAME_MAX);
 			Py_END_ALLOW_THREADS;
 		}
 
 		min = sizeof(struct inotify_event) + name_max + 1;
 
 		if (bufsize < min) {
 			PyErr_Format(PyExc_ValueError,
 				     "bufsize must be at least %d", (int)min);
 			goto bail;
 		}
 	}
 
 	buf = alloca(bufsize);
 
 	Py_BEGIN_ALLOW_THREADS;
 	nread = read(fd, buf, bufsize);
 	Py_END_ALLOW_THREADS;
 
 	if (nread == -1) {
 		PyErr_SetFromErrno(PyExc_OSError);
 		goto bail;
 	}
 
 	ctor_args = PyTuple_New(0);
 
 	if (ctor_args == NULL)
 		goto bail;
 
 	pos = 0;
 
 	while (pos < nread) {
 		struct inotify_event *in = (struct inotify_event *)(buf + pos);
 		struct event *evt;
 		PyObject *obj;
 
 		obj = PyObject_CallObject((PyObject *)&event_type, ctor_args);
 
 		if (obj == NULL)
 			goto bail;
 
 		evt = (struct event *)obj;
 
 		evt->wd = PyInt_FromLong(in->wd);
 		evt->mask = PyInt_FromLong(in->mask);
 		if (in->mask & IN_MOVE)
 			evt->cookie = PyInt_FromLong(in->cookie);
 		else {
 			Py_INCREF(Py_None);
 			evt->cookie = Py_None;
 		}
 		if (in->len)
 			evt->name = PyString_FromString(in->name);
 		else {
 			Py_INCREF(Py_None);
 			evt->name = Py_None;
 		}
 
 		if (!evt->wd || !evt->mask || !evt->cookie || !evt->name)
 			goto mybail;
 
 		if (PyList_Append(ret, obj) == -1)
 			goto mybail;
 
 		pos += sizeof(struct inotify_event) + in->len;
 		continue;
 
 	mybail:
 		Py_CLEAR(evt->wd);
 		Py_CLEAR(evt->mask);
 		Py_CLEAR(evt->cookie);
 		Py_CLEAR(evt->name);
 		Py_DECREF(obj);
 
 		goto bail;
 	}
 
 	goto done;
 
 bail:
 	Py_CLEAR(ret);
 
 done:
 	Py_XDECREF(ctor_args);
 
 	return ret;
 }
 
 static int init_globals(void)
 {
 	join = PyString_FromString("|");
 	er_wm = PyString_FromString("event(wd=%d, mask=%s)");
 	er_wmn = PyString_FromString("event(wd=%d, mask=%s, name=%s)");
 	er_wmc = PyString_FromString("event(wd=%d, mask=%s, cookie=0x%x)");
 	er_wmcn = PyString_FromString("event(wd=%d, mask=%s, cookie=0x%x, name=%s)");
 
 	return join && er_wm && er_wmn && er_wmc && er_wmcn;
 }
 
 PyDoc_STRVAR(
 	read_doc,
 	"read(fd, bufsize[=65536]) -> list_of_events\n"
 	"\n"
 	"\nRead inotify events from a file descriptor.\n"
 	"\n"
 	"        fd: file descriptor returned by init()\n"
 	"        bufsize: size of buffer to read into, in bytes\n"
 	"\n"
 	"Return a list of event objects.\n"
 	"\n"
 	"If bufsize is > 0, block until events are available to be read.\n"
 	"Otherwise, immediately return all events that can be read without\n"
 	"blocking.");
 
 static PyMethodDef methods[] = {
 	{"init", init, METH_VARARGS, init_doc},
 	{"add_watch", add_watch, METH_VARARGS, add_watch_doc},
 	{"remove_watch", remove_watch, METH_VARARGS, remove_watch_doc},
 	{"read", read_events, METH_VARARGS, read_doc},
 	{"decode_mask", pydecode_mask, METH_VARARGS, decode_mask_doc},
 	{NULL},
 };
 
 #ifdef IS_PY3K
 static struct PyModuleDef _inotify_module = {
 	PyModuleDef_HEAD_INIT,
 	"_inotify",
 	doc,
 	-1,
 	methods
 };
 
 PyMODINIT_FUNC PyInit__inotify(void)
 {
 	PyObject *mod, *dict;
 
 	mod = PyModule_Create(&_inotify_module);
 
 	if (mod == NULL)
 		return NULL;
 
 	if (!init_globals())
 		return;
 
 	dict = PyModule_GetDict(mod);
 
 	if (dict)
 		define_consts(dict);
 
 	return mod;
 }
 #else
 void init_inotify(void)
 {
 	PyObject *mod, *dict;
 
 	if (PyType_Ready(&event_type) == -1)
 		return;
 
 	if (!init_globals())
 		return;
 
 	mod = Py_InitModule3("_inotify", methods, doc);
 
 	dict = PyModule_GetDict(mod);
 
 	if (dict)
 		define_consts(dict);
 }
 #endif

mercurial/commands.py

@@ -1,5902 +1,5902 b''
 # commands.py - command processing for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from node import hex, bin, nullid, nullrev, short
 from lock import release
 from i18n import _, gettext
 import os, re, difflib, time, tempfile, errno
 import hg, scmutil, util, revlog, extensions, copies, error, bookmarks
 import patch, help, url, encoding, templatekw, discovery
 import archival, changegroup, cmdutil, hbisect
 import sshserver, hgweb, hgweb.server, commandserver
 import merge as mergemod
 import minirst, revset, fileset
 import dagparser, context, simplemerge, graphmod
 import random, setdiscovery, treediscovery, dagutil, pvec, localrepo
 import phases, obsolete
 
 table = {}
 
 command = cmdutil.command(table)
 
 # common command options
 
 globalopts = [
     ('R', 'repository', '',
      _('repository root directory or name of overlay bundle file'),
      _('REPO')),
     ('', 'cwd', '',
      _('change working directory'), _('DIR')),
     ('y', 'noninteractive', None,
      _('do not prompt, automatically pick the first choice for all prompts')),
     ('q', 'quiet', None, _('suppress output')),
     ('v', 'verbose', None, _('enable additional output')),
     ('', 'config', [],
      _('set/override config option (use \'section.name=value\')'),
      _('CONFIG')),
     ('', 'debug', None, _('enable debugging output')),
     ('', 'debugger', None, _('start debugger')),
     ('', 'encoding', encoding.encoding, _('set the charset encoding'),
      _('ENCODE')),
     ('', 'encodingmode', encoding.encodingmode,
      _('set the charset encoding mode'), _('MODE')),
     ('', 'traceback', None, _('always print a traceback on exception')),
     ('', 'time', None, _('time how long the command takes')),
     ('', 'profile', None, _('print command execution profile')),
     ('', 'version', None, _('output version information and exit')),
     ('h', 'help', None, _('display help and exit')),
 ]
 
 dryrunopts = [('n', 'dry-run', None,
                _('do not perform actions, just print output'))]
 
 remoteopts = [
     ('e', 'ssh', '',
      _('specify ssh command to use'), _('CMD')),
     ('', 'remotecmd', '',
      _('specify hg command to run on the remote side'), _('CMD')),
     ('', 'insecure', None,
      _('do not verify server certificate (ignoring web.cacerts config)')),
 ]
 
 walkopts = [
     ('I', 'include', [],
      _('include names matching the given patterns'), _('PATTERN')),
     ('X', 'exclude', [],
      _('exclude names matching the given patterns'), _('PATTERN')),
 ]
 
 commitopts = [
     ('m', 'message', '',
      _('use text as commit message'), _('TEXT')),
     ('l', 'logfile', '',
      _('read commit message from file'), _('FILE')),
 ]
 
 commitopts2 = [
     ('d', 'date', '',
      _('record the specified date as commit date'), _('DATE')),
     ('u', 'user', '',
      _('record the specified user as committer'), _('USER')),
 ]
 
 templateopts = [
     ('', 'style', '',
      _('display using template map file'), _('STYLE')),
     ('', 'template', '',
      _('display with template'), _('TEMPLATE')),
 ]
 
 logopts = [
     ('p', 'patch', None, _('show patch')),
     ('g', 'git', None, _('use git extended diff format')),
     ('l', 'limit', '',
      _('limit number of changes displayed'), _('NUM')),
     ('M', 'no-merges', None, _('do not show merges')),
     ('', 'stat', None, _('output diffstat-style summary of changes')),
     ('G', 'graph', None, _("show the revision DAG")),
 ] + templateopts
 
 diffopts = [
     ('a', 'text', None, _('treat all files as text')),
     ('g', 'git', None, _('use git extended diff format')),
     ('', 'nodates', None, _('omit dates from diff headers'))
 ]
 
 diffwsopts = [
     ('w', 'ignore-all-space', None,
      _('ignore white space when comparing lines')),
     ('b', 'ignore-space-change', None,
      _('ignore changes in the amount of white space')),
     ('B', 'ignore-blank-lines', None,
      _('ignore changes whose lines are all blank')),
     ]
 
 diffopts2 = [
     ('p', 'show-function', None, _('show which function each change is in')),
     ('', 'reverse', None, _('produce a diff that undoes the changes')),
     ] + diffwsopts + [
     ('U', 'unified', '',
      _('number of lines of context to show'), _('NUM')),
     ('', 'stat', None, _('output diffstat-style summary of changes')),
 ]
 
 mergetoolopts = [
     ('t', 'tool', '', _('specify merge tool')),
 ]
 
 similarityopts = [
     ('s', 'similarity', '',
      _('guess renamed files by similarity (0<=s<=100)'), _('SIMILARITY'))
 ]
 
 subrepoopts = [
     ('S', 'subrepos', None,
      _('recurse into subrepositories'))
 ]
 
 # Commands start here, listed alphabetically
 
 @command('^add',
     walkopts + subrepoopts + dryrunopts,
     _('[OPTION]... [FILE]...'))
 def add(ui, repo, *pats, **opts):
     """add the specified files on the next commit
 
     Schedule files to be version controlled and added to the
     repository.
 
     The files will be added to the repository at the next commit. To
     undo an add before that, see :hg:`forget`.
 
     If no names are given, add all files to the repository.
 
     .. container:: verbose
 
        An example showing how new (unknown) files are added
        automatically by :hg:`add`::
 
          $ ls
          foo.c
          $ hg status
          ? foo.c
          $ hg add
          adding foo.c
          $ hg status
          A foo.c
 
     Returns 0 if all files are successfully added.
     """
 
     m = scmutil.match(repo[None], pats, opts)
     rejected = cmdutil.add(ui, repo, m, opts.get('dry_run'),
                            opts.get('subrepos'), prefix="", explicitonly=False)
     return rejected and 1 or 0
 
 @command('addremove',
     similarityopts + walkopts + dryrunopts,
     _('[OPTION]... [FILE]...'))
 def addremove(ui, repo, *pats, **opts):
     """add all new files, delete all missing files
 
     Add all new files and remove all missing files from the
     repository.
 
     New files are ignored if they match any of the patterns in
     ``.hgignore``. As with add, these changes take effect at the next
     commit.
 
     Use the -s/--similarity option to detect renamed files. This
     option takes a percentage between 0 (disabled) and 100 (files must
     be identical) as its parameter. With a parameter greater than 0,
     this compares every removed file with every added file and records
     those similar enough as renames. Detecting renamed files this way
     can be expensive. After using this option, :hg:`status -C` can be
     used to check which files were identified as moved or renamed. If
     not specified, -s/--similarity defaults to 100 and only renames of
     identical files are detected.
 
     Returns 0 if all files are successfully added.
     """
     try:
         sim = float(opts.get('similarity') or 100)
     except ValueError:
         raise util.Abort(_('similarity must be a number'))
     if sim < 0 or sim > 100:
         raise util.Abort(_('similarity must be between 0 and 100'))
     return scmutil.addremove(repo, pats, opts, similarity=sim / 100.0)
 
 @command('^annotate|blame',
     [('r', 'rev', '', _('annotate the specified revision'), _('REV')),
     ('', 'follow', None,
      _('follow copies/renames and list the filename (DEPRECATED)')),
     ('', 'no-follow', None, _("don't follow copies and renames")),
     ('a', 'text', None, _('treat all files as text')),
     ('u', 'user', None, _('list the author (long with -v)')),
     ('f', 'file', None, _('list the filename')),
     ('d', 'date', None, _('list the date (short with -q)')),
     ('n', 'number', None, _('list the revision number (default)')),
     ('c', 'changeset', None, _('list the changeset')),
     ('l', 'line-number', None, _('show line number at the first appearance'))
     ] + diffwsopts + walkopts,
     _('[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'))
 def annotate(ui, repo, *pats, **opts):
     """show changeset information by line for each file
 
     List changes in files, showing the revision id responsible for
     each line
 
     This command is useful for discovering when a change was made and
     by whom.
 
     Without the -a/--text option, annotate will avoid processing files
     it detects as binary. With -a, annotate will annotate the file
     anyway, although the results will probably be neither useful
     nor desirable.
 
     Returns 0 on success.
     """
     if opts.get('follow'):
         # --follow is deprecated and now just an alias for -f/--file
         # to mimic the behavior of Mercurial before version 1.5
         opts['file'] = True
 
     datefunc = ui.quiet and util.shortdate or util.datestr
     getdate = util.cachefunc(lambda x: datefunc(x[0].date()))
 
     if not pats:
         raise util.Abort(_('at least one filename or pattern is required'))
 
     hexfn = ui.debugflag and hex or short
 
     opmap = [('user', ' ', lambda x: ui.shortuser(x[0].user())),
              ('number', ' ', lambda x: str(x[0].rev())),
              ('changeset', ' ', lambda x: hexfn(x[0].node())),
              ('date', ' ', getdate),
              ('file', ' ', lambda x: x[0].path()),
              ('line_number', ':', lambda x: str(x[1])),
             ]
 
     if (not opts.get('user') and not opts.get('changeset')
         and not opts.get('date') and not opts.get('file')):
         opts['number'] = True
 
     linenumber = opts.get('line_number') is not None
     if linenumber and (not opts.get('changeset')) and (not opts.get('number')):
         raise util.Abort(_('at least one of -n/-c is required for -l'))
 
     funcmap = [(func, sep) for op, sep, func in opmap if opts.get(op)]
     funcmap[0] = (funcmap[0][0], '') # no separator in front of first column
 
     def bad(x, y):
         raise util.Abort("%s: %s" % (x, y))
 
     ctx = scmutil.revsingle(repo, opts.get('rev'))
     m = scmutil.match(ctx, pats, opts)
     m.bad = bad
     follow = not opts.get('no_follow')
     diffopts = patch.diffopts(ui, opts, section='annotate')
     for abs in ctx.walk(m):
         fctx = ctx[abs]
         if not opts.get('text') and util.binary(fctx.data()):
             ui.write(_("%s: binary file\n") % ((pats and m.rel(abs)) or abs))
             continue
 
         lines = fctx.annotate(follow=follow, linenumber=linenumber,
                               diffopts=diffopts)
         pieces = []
 
         for f, sep in funcmap:
             l = [f(n) for n, dummy in lines]
             if l:
                 sized = [(x, encoding.colwidth(x)) for x in l]
                 ml = max([w for x, w in sized])
                 pieces.append(["%s%s%s" % (sep, ' ' * (ml - w), x)
                                for x, w in sized])
 
         if pieces:
             for p, l in zip(zip(*pieces), lines):
                 ui.write("%s: %s" % ("".join(p), l[1]))
 
             if lines and not lines[-1][1].endswith('\n'):
                 ui.write('\n')
 
 @command('archive',
     [('', 'no-decode', None, _('do not pass files through decoders')),
     ('p', 'prefix', '', _('directory prefix for files in archive'),
      _('PREFIX')),
     ('r', 'rev', '', _('revision to distribute'), _('REV')),
     ('t', 'type', '', _('type of distribution to create'), _('TYPE')),
     ] + subrepoopts + walkopts,
     _('[OPTION]... DEST'))
 def archive(ui, repo, dest, **opts):
     '''create an unversioned archive of a repository revision
 
     By default, the revision used is the parent of the working
     directory; use -r/--rev to specify a different revision.
 
     The archive type is automatically detected based on file
     extension (or override using -t/--type).
 
     .. container:: verbose
 
       Examples:
 
       - create a zip file containing the 1.0 release::
 
           hg archive -r 1.0 project-1.0.zip
 
       - create a tarball excluding .hg files::
 
           hg archive project.tar.gz -X ".hg*"
 
     Valid types are:
 
     :``files``: a directory full of files (default)
     :``tar``:   tar archive, uncompressed
     :``tbz2``:  tar archive, compressed using bzip2
     :``tgz``:   tar archive, compressed using gzip
     :``uzip``:  zip archive, uncompressed
     :``zip``:   zip archive, compressed using deflate
 
     The exact name of the destination archive or directory is given
     using a format string; see :hg:`help export` for details.
 
     Each member added to an archive file has a directory prefix
     prepended. Use -p/--prefix to specify a format string for the
     prefix. The default is the basename of the archive, with suffixes
     removed.
 
     Returns 0 on success.
     '''
 
     ctx = scmutil.revsingle(repo, opts.get('rev'))
     if not ctx:
         raise util.Abort(_('no working directory: please specify a revision'))
     node = ctx.node()
     dest = cmdutil.makefilename(repo, dest, node)
     if os.path.realpath(dest) == repo.root:
         raise util.Abort(_('repository root cannot be destination'))
 
     kind = opts.get('type') or archival.guesskind(dest) or 'files'
     prefix = opts.get('prefix')
 
     if dest == '-':
         if kind == 'files':
             raise util.Abort(_('cannot archive plain files to stdout'))
         dest = cmdutil.makefileobj(repo, dest)
         if not prefix:
             prefix = os.path.basename(repo.root) + '-%h'
 
     prefix = cmdutil.makefilename(repo, prefix, node)
     matchfn = scmutil.match(ctx, [], opts)
     archival.archive(repo, dest, node, kind, not opts.get('no_decode'),
                      matchfn, prefix, subrepos=opts.get('subrepos'))
 
 @command('backout',
     [('', 'merge', None, _('merge with old dirstate parent after backout')),
     ('', 'parent', '',
      _('parent to choose when backing out merge (DEPRECATED)'), _('REV')),
     ('r', 'rev', '', _('revision to backout'), _('REV')),
     ] + mergetoolopts + walkopts + commitopts + commitopts2,
     _('[OPTION]... [-r] REV'))
 def backout(ui, repo, node=None, rev=None, **opts):
     '''reverse effect of earlier changeset
 
     Prepare a new changeset with the effect of REV undone in the
     current working directory.
 
     If REV is the parent of the working directory, then this new changeset
     is committed automatically. Otherwise, hg needs to merge the
     changes and the merged result is left uncommitted.
 
     .. note::
       backout cannot be used to fix either an unwanted or
       incorrect merge.
 
     .. container:: verbose
 
       By default, the pending changeset will have one parent,
       maintaining a linear history. With --merge, the pending
       changeset will instead have two parents: the old parent of the
       working directory and a new child of REV that simply undoes REV.
 
       Before version 1.7, the behavior without --merge was equivalent
       to specifying --merge followed by :hg:`update --clean .` to
       cancel the merge and leave the child of REV as a head to be
       merged separately.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success.
     '''
     if rev and node:
         raise util.Abort(_("please specify just one revision"))
 
     if not rev:
         rev = node
 
     if not rev:
         raise util.Abort(_("please specify a revision to backout"))
 
     date = opts.get('date')
     if date:
         opts['date'] = util.parsedate(date)
 
     cmdutil.bailifchanged(repo)
     node = scmutil.revsingle(repo, rev).node()
 
     op1, op2 = repo.dirstate.parents()
     a = repo.changelog.ancestor(op1, node)
     if a != node:
         raise util.Abort(_('cannot backout change on a different branch'))
 
     p1, p2 = repo.changelog.parents(node)
     if p1 == nullid:
         raise util.Abort(_('cannot backout a change with no parents'))
     if p2 != nullid:
         if not opts.get('parent'):
             raise util.Abort(_('cannot backout a merge changeset'))
         p = repo.lookup(opts['parent'])
         if p not in (p1, p2):
             raise util.Abort(_('%s is not a parent of %s') %
                              (short(p), short(node)))
         parent = p
     else:
         if opts.get('parent'):
             raise util.Abort(_('cannot use --parent on non-merge changeset'))
         parent = p1
 
     # the backout should appear on the same branch
     wlock = repo.wlock()
     try:
         branch = repo.dirstate.branch()
         hg.clean(repo, node, show_stats=False)
         repo.dirstate.setbranch(branch)
         revert_opts = opts.copy()
         revert_opts['date'] = None
         revert_opts['all'] = True
         revert_opts['rev'] = hex(parent)
         revert_opts['no_backup'] = None
         revert(ui, repo, **revert_opts)
         if not opts.get('merge') and op1 != node:
             try:
                 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''))
                 return hg.update(repo, op1)
             finally:
                 ui.setconfig('ui', 'forcemerge', '')
 
         commit_opts = opts.copy()
         commit_opts['addremove'] = False
         if not commit_opts['message'] and not commit_opts['logfile']:
             # we don't translate commit messages
             commit_opts['message'] = "Backed out changeset %s" % short(node)
             commit_opts['force_editor'] = True
         commit(ui, repo, **commit_opts)
         def nice(node):
             return '%d:%s' % (repo.changelog.rev(node), short(node))
         ui.status(_('changeset %s backs out changeset %s\n') %
                   (nice(repo.changelog.tip()), nice(node)))
         if opts.get('merge') and op1 != node:
             hg.clean(repo, op1, show_stats=False)
             ui.status(_('merging with changeset %s\n')
                       % nice(repo.changelog.tip()))
             try:
                 ui.setconfig('ui', 'forcemerge', opts.get('tool', ''))
                 return hg.merge(repo, hex(repo.changelog.tip()))
             finally:
                 ui.setconfig('ui', 'forcemerge', '')
     finally:
         wlock.release()
     return 0
 
 @command('bisect',
     [('r', 'reset', False, _('reset bisect state')),
     ('g', 'good', False, _('mark changeset good')),
     ('b', 'bad', False, _('mark changeset bad')),
     ('s', 'skip', False, _('skip testing changeset')),
     ('e', 'extend', False, _('extend the bisect range')),
     ('c', 'command', '', _('use command to check changeset state'), _('CMD')),
     ('U', 'noupdate', False, _('do not update to target'))],
     _("[-gbsr] [-U] [-c CMD] [REV]"))
 def bisect(ui, repo, rev=None, extra=None, command=None,
                reset=None, good=None, bad=None, skip=None, extend=None,
                noupdate=None):
     """subdivision search of changesets
 
     This command helps to find changesets which introduce problems. To
     use, mark the earliest changeset you know exhibits the problem as
     bad, then mark the latest changeset which is free from the problem
     as good. Bisect will update your working directory to a revision
     for testing (unless the -U/--noupdate option is specified). Once
     you have performed tests, mark the working directory as good or
     bad, and bisect will either update to another candidate changeset
     or announce that it has found the bad revision.
 
     As a shortcut, you can also use the revision argument to mark a
     revision as good or bad without checking it out first.
 
     If you supply a command, it will be used for automatic bisection.
     The environment variable HG_NODE will contain the ID of the
     changeset being tested. The exit status of the command will be
     used to mark revisions as good or bad: status 0 means good, 125
     means to skip the revision, 127 (command not found) will abort the
     bisection, and any other non-zero exit status means the revision
     is bad.
 
     .. container:: verbose
 
       Some examples:
 
       - start a bisection with known bad revision 12, and good revision 34::
 
           hg bisect --bad 34
           hg bisect --good 12
 
       - advance the current bisection by marking current revision as good or
         bad::
 
           hg bisect --good
           hg bisect --bad
 
       - mark the current revision, or a known revision, to be skipped (e.g. if
         that revision is not usable because of another issue)::
 
           hg bisect --skip
           hg bisect --skip 23
 
       - forget the current bisection::
 
           hg bisect --reset
 
       - use 'make && make tests' to automatically find the first broken
         revision::
 
           hg bisect --reset
           hg bisect --bad 34
           hg bisect --good 12
           hg bisect --command 'make && make tests'
 
       - see all changesets whose states are already known in the current
         bisection::
 
           hg log -r "bisect(pruned)"
 
       - see the changeset currently being bisected (especially useful
         if running with -U/--noupdate)::
 
           hg log -r "bisect(current)"
 
       - see all changesets that took part in the current bisection::
 
           hg log -r "bisect(range)"
 
       - with the graphlog extension, you can even get a nice graph::
 
           hg log --graph -r "bisect(range)"
 
       See :hg:`help revsets` for more about the `bisect()` keyword.
 
     Returns 0 on success.
     """
     def extendbisectrange(nodes, good):
         # bisect is incomplete when it ends on a merge node and
         # one of the parent was not checked.
         parents = repo[nodes[0]].parents()
         if len(parents) > 1:
             side = good and state['bad'] or state['good']
             num = len(set(i.node() for i in parents) & set(side))
             if num == 1:
                 return parents[0].ancestor(parents[1])
         return None
 
     def print_result(nodes, good):
         displayer = cmdutil.show_changeset(ui, repo, {})
         if len(nodes) == 1:
             # narrowed it down to a single revision
             if good:
                 ui.write(_("The first good revision is:\n"))
             else:
                 ui.write(_("The first bad revision is:\n"))
             displayer.show(repo[nodes[0]])
             extendnode = extendbisectrange(nodes, good)
             if extendnode is not None:
                 ui.write(_('Not all ancestors of this changeset have been'
                            ' checked.\nUse bisect --extend to continue the '
                            'bisection from\nthe common ancestor, %s.\n')
                          % extendnode)
         else:
             # multiple possible revisions
             if good:
                 ui.write(_("Due to skipped revisions, the first "
                         "good revision could be any of:\n"))
             else:
                 ui.write(_("Due to skipped revisions, the first "
                         "bad revision could be any of:\n"))
             for n in nodes:
                 displayer.show(repo[n])
         displayer.close()
 
     def check_state(state, interactive=True):
         if not state['good'] or not state['bad']:
             if (good or bad or skip or reset) and interactive:
                 return
             if not state['good']:
                 raise util.Abort(_('cannot bisect (no known good revisions)'))
             else:
                 raise util.Abort(_('cannot bisect (no known bad revisions)'))
         return True
 
     # backward compatibility
     if rev in "good bad reset init".split():
         ui.warn(_("(use of 'hg bisect <cmd>' is deprecated)\n"))
         cmd, rev, extra = rev, extra, None
         if cmd == "good":
             good = True
         elif cmd == "bad":
             bad = True
         else:
             reset = True
     elif extra or good + bad + skip + reset + extend + bool(command) > 1:
         raise util.Abort(_('incompatible arguments'))
 
     if reset:
         p = repo.join("bisect.state")
         if os.path.exists(p):
             os.unlink(p)
         return
 
     state = hbisect.load_state(repo)
 
     if command:
         changesets = 1
         try:
             node = state['current'][0]
         except LookupError:
             if noupdate:
                 raise util.Abort(_('current bisect revision is unknown - '
                                    'start a new bisect to fix'))
             node, p2 = repo.dirstate.parents()
             if p2 != nullid:
                 raise util.Abort(_('current bisect revision is a merge'))
         try:
             while changesets:
                 # update state
                 state['current'] = [node]
                 hbisect.save_state(repo, state)
                 status = util.system(command,
                                      environ={'HG_NODE': hex(node)},
                                      out=ui.fout)
                 if status == 125:
                     transition = "skip"
                 elif status == 0:
                     transition = "good"
                 # status < 0 means process was killed
                 elif status == 127:
                     raise util.Abort(_("failed to execute %s") % command)
                 elif status < 0:
                     raise util.Abort(_("%s killed") % command)
                 else:
                     transition = "bad"
                 ctx = scmutil.revsingle(repo, rev, node)
                 rev = None # clear for future iterations
                 state[transition].append(ctx.node())
                 ui.status(_('changeset %d:%s: %s\n') % (ctx, ctx, transition))
                 check_state(state, interactive=False)
                 # bisect
                 nodes, changesets, good = hbisect.bisect(repo.changelog, state)
                 # update to next check
                 node = nodes[0]
                 if not noupdate:
                     cmdutil.bailifchanged(repo)
                     hg.clean(repo, node, show_stats=False)
         finally:
             state['current'] = [node]
             hbisect.save_state(repo, state)
         print_result(nodes, good)
         return
 
     # update state
 
     if rev:
         nodes = [repo.lookup(i) for i in scmutil.revrange(repo, [rev])]
     else:
         nodes = [repo.lookup('.')]
 
     if good or bad or skip:
         if good:
             state['good'] += nodes
         elif bad:
             state['bad'] += nodes
         elif skip:
             state['skip'] += nodes
         hbisect.save_state(repo, state)
 
     if not check_state(state):
         return
 
     # actually bisect
     nodes, changesets, good = hbisect.bisect(repo.changelog, state)
     if extend:
         if not changesets:
             extendnode = extendbisectrange(nodes, good)
             if extendnode is not None:
                 ui.write(_("Extending search to changeset %d:%s\n"
                          % (extendnode.rev(), extendnode)))
                 state['current'] = [extendnode.node()]
                 hbisect.save_state(repo, state)
                 if noupdate:
                     return
                 cmdutil.bailifchanged(repo)
                 return hg.clean(repo, extendnode.node())
         raise util.Abort(_("nothing to extend"))
 
     if changesets == 0:
         print_result(nodes, good)
     else:
         assert len(nodes) == 1 # only a single node can be tested next
         node = nodes[0]
         # compute the approximate number of remaining tests
         tests, size = 0, 2
         while size <= changesets:
             tests, size = tests + 1, size * 2
         rev = repo.changelog.rev(node)
         ui.write(_("Testing changeset %d:%s "
                    "(%d changesets remaining, ~%d tests)\n")
                  % (rev, short(node), changesets, tests))
         state['current'] = [node]
         hbisect.save_state(repo, state)
         if not noupdate:
             cmdutil.bailifchanged(repo)
             return hg.clean(repo, node)
 
 @command('bookmarks',
     [('f', 'force', False, _('force')),
     ('r', 'rev', '', _('revision'), _('REV')),
     ('d', 'delete', False, _('delete a given bookmark')),
     ('m', 'rename', '', _('rename a given bookmark'), _('NAME')),
     ('i', 'inactive', False, _('mark a bookmark inactive'))],
     _('hg bookmarks [-f] [-d] [-i] [-m NAME] [-r REV] [NAME]'))
 def bookmark(ui, repo, mark=None, rev=None, force=False, delete=False,
              rename=None, inactive=False):
     '''track a line of development with movable markers
 
     Bookmarks are pointers to certain commits that move when committing.
     Bookmarks are local. They can be renamed, copied and deleted. It is
     possible to use :hg:`merge NAME` to merge from a given bookmark, and
     :hg:`update NAME` to update to a given bookmark.
 
     You can use :hg:`bookmark NAME` to set a bookmark on the working
     directory's parent revision with the given name. If you specify
     a revision using -r REV (where REV may be an existing bookmark),
     the bookmark is assigned to that revision.
 
     Bookmarks can be pushed and pulled between repositories (see :hg:`help
     push` and :hg:`help pull`). This requires both the local and remote
     repositories to support bookmarks. For versions prior to 1.8, this means
     the bookmarks extension must be enabled.
 
     With -i/--inactive, the new bookmark will not be made the active
     bookmark. If -r/--rev is given, the new bookmark will not be made
     active even if -i/--inactive is not given. If no NAME is given, the
     current active bookmark will be marked inactive.
     '''
     hexfn = ui.debugflag and hex or short
     marks = repo._bookmarks
     cur   = repo.changectx('.').node()
 
     if delete:
         if mark is None:
             raise util.Abort(_("bookmark name required"))
         if mark not in marks:
             raise util.Abort(_("bookmark '%s' does not exist") % mark)
         if mark == repo._bookmarkcurrent:
             bookmarks.setcurrent(repo, None)
         del marks[mark]
         bookmarks.write(repo)
         return
 
     if rename:
         if rename not in marks:
             raise util.Abort(_("bookmark '%s' does not exist") % rename)
         if mark in marks and not force:
             raise util.Abort(_("bookmark '%s' already exists "
                                "(use -f to force)") % mark)
         if mark is None:
             raise util.Abort(_("new bookmark name required"))
         marks[mark] = marks[rename]
         if repo._bookmarkcurrent == rename and not inactive:
             bookmarks.setcurrent(repo, mark)
         del marks[rename]
         bookmarks.write(repo)
         return
 
     if mark is not None:
         if "\n" in mark:
             raise util.Abort(_("bookmark name cannot contain newlines"))
         mark = mark.strip()
         if not mark:
             raise util.Abort(_("bookmark names cannot consist entirely of "
                                "whitespace"))
         if inactive and mark == repo._bookmarkcurrent:
             bookmarks.setcurrent(repo, None)
             return
         if mark in marks and not force:
             raise util.Abort(_("bookmark '%s' already exists "
                                "(use -f to force)") % mark)
         if ((mark in repo.branchmap() or mark == repo.dirstate.branch())
             and not force):
             raise util.Abort(
                 _("a bookmark cannot have the name of an existing branch"))
         if rev:
             marks[mark] = repo.lookup(rev)
         else:
             marks[mark] = cur
         if not inactive and cur == marks[mark]:
             bookmarks.setcurrent(repo, mark)
         bookmarks.write(repo)
         return
 
     if mark is None:
         if rev:
             raise util.Abort(_("bookmark name required"))
         if len(marks) == 0:
             ui.status(_("no bookmarks set\n"))
         else:
             for bmark, n in sorted(marks.iteritems()):
                 current = repo._bookmarkcurrent
                 if bmark == current and n == cur:
                     prefix, label = '*', 'bookmarks.current'
                 else:
                     prefix, label = ' ', ''
 
                 if ui.quiet:
                     ui.write("%s\n" % bmark, label=label)
                 else:
                     ui.write(" %s %-25s %d:%s\n" % (
                         prefix, bmark, repo.changelog.rev(n), hexfn(n)),
                         label=label)
         return
 
 @command('branch',
     [('f', 'force', None,
      _('set branch name even if it shadows an existing branch')),
     ('C', 'clean', None, _('reset branch name to parent branch name'))],
     _('[-fC] [NAME]'))
 def branch(ui, repo, label=None, **opts):
     """set or show the current branch name
 
     .. note::
        Branch names are permanent and global. Use :hg:`bookmark` to create a
        light-weight bookmark instead. See :hg:`help glossary` for more
        information about named branches and bookmarks.
 
     With no argument, show the current branch name. With one argument,
     set the working directory branch name (the branch will not exist
     in the repository until the next commit). Standard practice
     recommends that primary development take place on the 'default'
     branch.
 
     Unless -f/--force is specified, branch will not let you set a
     branch name that already exists, even if it's inactive.
 
     Use -C/--clean to reset the working directory branch to that of
     the parent of the working directory, negating a previous branch
     change.
 
     Use the command :hg:`update` to switch to an existing branch. Use
     :hg:`commit --close-branch` to mark this branch as closed.
 
     Returns 0 on success.
     """
     if not opts.get('clean') and not label:
         ui.write("%s\n" % repo.dirstate.branch())
         return
 
     wlock = repo.wlock()
     try:
         if opts.get('clean'):
             label = repo[None].p1().branch()
             repo.dirstate.setbranch(label)
             ui.status(_('reset working directory to branch %s\n') % label)
         elif label:
             if not opts.get('force') and label in repo.branchmap():
                 if label not in [p.branch() for p in repo.parents()]:
                     raise util.Abort(_('a branch of the same name already'
                                        ' exists'),
                                      # i18n: "it" refers to an existing branch
                                      hint=_("use 'hg update' to switch to it"))
             repo.dirstate.setbranch(label)
             ui.status(_('marked working directory as branch %s\n') % label)
             ui.status(_('(branches are permanent and global, '
                         'did you want a bookmark?)\n'))
     finally:
         wlock.release()
 
 @command('branches',
     [('a', 'active', False, _('show only branches that have unmerged heads')),
     ('c', 'closed', False, _('show normal and closed branches'))],
     _('[-ac]'))
 def branches(ui, repo, active=False, closed=False):
     """list repository named branches
 
     List the repository's named branches, indicating which ones are
     inactive. If -c/--closed is specified, also list branches which have
     been marked closed (see :hg:`commit --close-branch`).
 
     If -a/--active is specified, only show active branches. A branch
     is considered active if it contains repository heads.
 
     Use the command :hg:`update` to switch to an existing branch.
 
     Returns 0.
     """
 
     hexfunc = ui.debugflag and hex or short
 
     activebranches = set([repo[n].branch() for n in repo.heads()])
     branches = []
     for tag, heads in repo.branchmap().iteritems():
         for h in reversed(heads):
             ctx = repo[h]
             isopen = not ctx.closesbranch()
             if isopen:
                 tip = ctx
                 break
         else:
             tip = repo[heads[-1]]
         isactive = tag in activebranches and isopen
         branches.append((tip, isactive, isopen))
     branches.sort(key=lambda i: (i[1], i[0].rev(), i[0].branch(), i[2]),
                   reverse=True)
 
     for ctx, isactive, isopen in branches:
         if (not active) or isactive:
             if isactive:
                 label = 'branches.active'
                 notice = ''
             elif not isopen:
                 if not closed:
                     continue
                 label = 'branches.closed'
                 notice = _(' (closed)')
             else:
                 label = 'branches.inactive'
                 notice = _(' (inactive)')
             if ctx.branch() == repo.dirstate.branch():
                 label = 'branches.current'
             rev = str(ctx.rev()).rjust(31 - encoding.colwidth(ctx.branch()))
             rev = ui.label('%s:%s' % (rev, hexfunc(ctx.node())),
                            'log.changeset')
             tag = ui.label(ctx.branch(), label)
             if ui.quiet:
                 ui.write("%s\n" % tag)
             else:
                 ui.write("%s %s%s\n" % (tag, rev, notice))
 
 @command('bundle',
     [('f', 'force', None, _('run even when the destination is unrelated')),
     ('r', 'rev', [], _('a changeset intended to be added to the destination'),
      _('REV')),
     ('b', 'branch', [], _('a specific branch you would like to bundle'),
      _('BRANCH')),
     ('', 'base', [],
      _('a base changeset assumed to be available at the destination'),
      _('REV')),
     ('a', 'all', None, _('bundle all changesets in the repository')),
     ('t', 'type', 'bzip2', _('bundle compression type to use'), _('TYPE')),
     ] + remoteopts,
     _('[-f] [-t TYPE] [-a] [-r REV]... [--base REV]... FILE [DEST]'))
 def bundle(ui, repo, fname, dest=None, **opts):
     """create a changegroup file
 
     Generate a compressed changegroup file collecting changesets not
     known to be in another repository.
 
     If you omit the destination repository, then hg assumes the
     destination will have all the nodes you specify with --base
     parameters. To create a bundle containing all changesets, use
     -a/--all (or --base null).
 
     You can change compression method with the -t/--type option.
     The available compression methods are: none, bzip2, and
     gzip (by default, bundles are compressed using bzip2).
 
     The bundle file can then be transferred using conventional means
     and applied to another repository with the unbundle or pull
     command. This is useful when direct push and pull are not
     available or when exporting an entire repository is undesirable.
 
     Applying bundles preserves all changeset contents including
     permissions, copy/rename information, and revision history.
 
     Returns 0 on success, 1 if no changes found.
     """
     revs = None
     if 'rev' in opts:
         revs = scmutil.revrange(repo, opts['rev'])
 
     bundletype = opts.get('type', 'bzip2').lower()
     btypes = {'none': 'HG10UN', 'bzip2': 'HG10BZ', 'gzip': 'HG10GZ'}
     bundletype = btypes.get(bundletype)
     if bundletype not in changegroup.bundletypes:
         raise util.Abort(_('unknown bundle type specified with --type'))
 
     if opts.get('all'):
         base = ['null']
     else:
         base = scmutil.revrange(repo, opts.get('base'))
     if base:
         if dest:
             raise util.Abort(_("--base is incompatible with specifying "
                                "a destination"))
         common = [repo.lookup(rev) for rev in base]
         heads = revs and map(repo.lookup, revs) or revs
         cg = repo.getbundle('bundle', heads=heads, common=common)
         outgoing = None
     else:
         dest = ui.expandpath(dest or 'default-push', dest or 'default')
         dest, branches = hg.parseurl(dest, opts.get('branch'))
         other = hg.peer(repo, opts, dest)
         revs, checkout = hg.addbranchrevs(repo, other, branches, revs)
         heads = revs and map(repo.lookup, revs) or revs
         outgoing = discovery.findcommonoutgoing(repo, other,
                                                 onlyheads=heads,
                                                 force=opts.get('force'),
                                                 portable=True)
         cg = repo.getlocalbundle('bundle', outgoing)
     if not cg:
         scmutil.nochangesfound(ui, repo, outgoing and outgoing.excluded)
         return 1
 
     changegroup.writebundle(cg, fname, bundletype)
 
 @command('cat',
     [('o', 'output', '',
      _('print output to file with formatted name'), _('FORMAT')),
     ('r', 'rev', '', _('print the given revision'), _('REV')),
     ('', 'decode', None, _('apply any matching decode filter')),
     ] + walkopts,
     _('[OPTION]... FILE...'))
 def cat(ui, repo, file1, *pats, **opts):
     """output the current or given revision of files
 
     Print the specified files as they were at the given revision. If
     no revision is given, the parent of the working directory is used,
     or tip if no revision is checked out.
 
     Output may be to a file, in which case the name of the file is
     given using a format string. The formatting rules are the same as
     for the export command, with the following additions:
 
     :``%s``: basename of file being printed
     :``%d``: dirname of file being printed, or '.' if in repository root
     :``%p``: root-relative path name of file being printed
 
     Returns 0 on success.
     """
     ctx = scmutil.revsingle(repo, opts.get('rev'))
     err = 1
     m = scmutil.match(ctx, (file1,) + pats, opts)
     for abs in ctx.walk(m):
         fp = cmdutil.makefileobj(repo, opts.get('output'), ctx.node(),
                                  pathname=abs)
         data = ctx[abs].data()
         if opts.get('decode'):
             data = repo.wwritedata(abs, data)
         fp.write(data)
         fp.close()
         err = 0
     return err
 
 @command('^clone',
     [('U', 'noupdate', None,
      _('the clone will include an empty working copy (only a repository)')),
     ('u', 'updaterev', '', _('revision, tag or branch to check out'), _('REV')),
     ('r', 'rev', [], _('include the specified changeset'), _('REV')),
     ('b', 'branch', [], _('clone only the specified branch'), _('BRANCH')),
     ('', 'pull', None, _('use pull protocol to copy metadata')),
     ('', 'uncompressed', None, _('use uncompressed transfer (fast over LAN)')),
     ] + remoteopts,
     _('[OPTION]... SOURCE [DEST]'))
 def clone(ui, source, dest=None, **opts):
     """make a copy of an existing repository
 
     Create a copy of an existing repository in a new directory.
 
     If no destination directory name is specified, it defaults to the
     basename of the source.
 
     The location of the source is added to the new repository's
     ``.hg/hgrc`` file, as the default to be used for future pulls.
 
     Only local paths and ``ssh://`` URLs are supported as
     destinations. For ``ssh://`` destinations, no working directory or
     ``.hg/hgrc`` will be created on the remote side.
 
     To pull only a subset of changesets, specify one or more revisions
     identifiers with -r/--rev or branches with -b/--branch. The
     resulting clone will contain only the specified changesets and
     their ancestors. These options (or 'clone src#rev dest') imply
     --pull, even for local source repositories. Note that specifying a
     tag will include the tagged changeset but not the changeset
     containing the tag.
 
     To check out a particular version, use -u/--update, or
     -U/--noupdate to create a clone with no working directory.
 
     .. container:: verbose
 
       For efficiency, hardlinks are used for cloning whenever the
       source and destination are on the same filesystem (note this
       applies only to the repository data, not to the working
       directory). Some filesystems, such as AFS, implement hardlinking
       incorrectly, but do not report errors. In these cases, use the
       --pull option to avoid hardlinking.
 
       In some cases, you can clone repositories and the working
       directory using full hardlinks with ::
 
         $ cp -al REPO REPOCLONE
 
       This is the fastest way to clone, but it is not always safe. The
       operation is not atomic (making sure REPO is not modified during
       the operation is up to you) and you have to make sure your
       editor breaks hardlinks (Emacs and most Linux Kernel tools do
       so). Also, this is not compatible with certain extensions that
       place their metadata under the .hg directory, such as mq.
 
       Mercurial will update the working directory to the first applicable
       revision from this list:
 
       a) null if -U or the source repository has no changesets
       b) if -u . and the source repository is local, the first parent of
          the source repository's working directory
       c) the changeset specified with -u (if a branch name, this means the
          latest head of that branch)
       d) the changeset specified with -r
       e) the tipmost head specified with -b
       f) the tipmost head specified with the url#branch source syntax
       g) the tipmost head of the default branch
       h) tip
 
       Examples:
 
       - clone a remote repository to a new directory named hg/::
 
           hg clone http://selenic.com/hg
 
       - create a lightweight local clone::
 
           hg clone project/ project-feature/
 
       - clone from an absolute path on an ssh server (note double-slash)::
 
           hg clone ssh://user@server//home/projects/alpha/
 
       - do a high-speed clone over a LAN while checking out a
         specified version::
 
           hg clone --uncompressed http://server/repo -u 1.5
 
       - create a repository without changesets after a particular revision::
 
           hg clone -r 04e544 experimental/ good/
 
       - clone (and track) a particular named branch::
 
           hg clone http://selenic.com/hg#stable
 
     See :hg:`help urls` for details on specifying URLs.
 
     Returns 0 on success.
     """
     if opts.get('noupdate') and opts.get('updaterev'):
         raise util.Abort(_("cannot specify both --noupdate and --updaterev"))
 
     r = hg.clone(ui, opts, source, dest,
                  pull=opts.get('pull'),
                  stream=opts.get('uncompressed'),
                  rev=opts.get('rev'),
                  update=opts.get('updaterev') or not opts.get('noupdate'),
                  branch=opts.get('branch'))
 
     return r is None
 
 @command('^commit|ci',
     [('A', 'addremove', None,
      _('mark new/missing files as added/removed before committing')),
     ('', 'close-branch', None,
      _('mark a branch as closed, hiding it from the branch list')),
     ('', 'amend', None, _('amend the parent of the working dir')),
     ] + walkopts + commitopts + commitopts2 + subrepoopts,
     _('[OPTION]... [FILE]...'))
 def commit(ui, repo, *pats, **opts):
     """commit the specified files or all outstanding changes
 
     Commit changes to the given files into the repository. Unlike a
     centralized SCM, this operation is a local operation. See
     :hg:`push` for a way to actively distribute your changes.
 
     If a list of files is omitted, all changes reported by :hg:`status`
     will be committed.
 
     If you are committing the result of a merge, do not provide any
     filenames or -I/-X filters.
 
     If no commit message is specified, Mercurial starts your
     configured editor where you can enter a message. In case your
     commit fails, you will find a backup of your message in
     ``.hg/last-message.txt``.
 
     The --amend flag can be used to amend the parent of the
     working directory with a new commit that contains the changes
     in the parent in addition to those currently reported by :hg:`status`,
     if there are any. The old commit is stored in a backup bundle in
     ``.hg/strip-backup`` (see :hg:`help bundle` and :hg:`help unbundle`
     on how to restore it).
 
     Message, user and date are taken from the amended commit unless
     specified. When a message isn't specified on the command line,
     the editor will open with the message of the amended commit.
 
     It is not possible to amend public changesets (see :hg:`help phases`)
     or changesets that have children.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success, 1 if nothing changed.
     """
     if opts.get('subrepos'):
         # Let --subrepos on the command line override config setting.
         ui.setconfig('ui', 'commitsubrepos', True)
 
     extra = {}
     if opts.get('close_branch'):
         if repo['.'].node() not in repo.branchheads():
             # The topo heads set is included in the branch heads set of the
             # current branch, so it's sufficient to test branchheads
             raise util.Abort(_('can only close branch heads'))
         extra['close'] = 1
 
     branch = repo[None].branch()
     bheads = repo.branchheads(branch)
 
     if opts.get('amend'):
         if ui.configbool('ui', 'commitsubrepos'):
             raise util.Abort(_('cannot amend recursively'))
 
         old = repo['.']
         if old.phase() == phases.public:
             raise util.Abort(_('cannot amend public changesets'))
         if len(old.parents()) > 1:
             raise util.Abort(_('cannot amend merge changesets'))
         if len(repo[None].parents()) > 1:
             raise util.Abort(_('cannot amend while merging'))
         if old.children():
             raise util.Abort(_('cannot amend changeset with children'))
 
         e = cmdutil.commiteditor
         if opts.get('force_editor'):
             e = cmdutil.commitforceeditor
 
         def commitfunc(ui, repo, message, match, opts):
             editor = e
             # message contains text from -m or -l, if it's empty,
             # open the editor with the old message
             if not message:
                 message = old.description()
                 editor = cmdutil.commitforceeditor
             return repo.commit(message,
                                opts.get('user') or old.user(),
                                opts.get('date') or old.date(),
                                match,
                                editor=editor,
                                extra=extra)
 
         current = repo._bookmarkcurrent
         marks = old.bookmarks()
         node = cmdutil.amend(ui, repo, commitfunc, old, extra, pats, opts)
         if node == old.node():
             ui.status(_("nothing changed\n"))
             return 1
         elif marks:
             ui.debug('moving bookmarks %r from %s to %s\n' %
                      (marks, old.hex(), hex(node)))
             for bm in marks:
                 repo._bookmarks[bm] = node
                 if bm == current:
                     bookmarks.setcurrent(repo, bm)
             bookmarks.write(repo)
     else:
         e = cmdutil.commiteditor
         if opts.get('force_editor'):
             e = cmdutil.commitforceeditor
 
         def commitfunc(ui, repo, message, match, opts):
             return repo.commit(message, opts.get('user'), opts.get('date'),
                                match, editor=e, extra=extra)
 
         node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
 
         if not node:
             stat = repo.status(match=scmutil.match(repo[None], pats, opts))
             if stat[3]:
                 ui.status(_("nothing changed (%d missing files, see "
                             "'hg status')\n") % len(stat[3]))
             else:
                 ui.status(_("nothing changed\n"))
             return 1
 
     ctx = repo[node]
     parents = ctx.parents()
 
     if (not opts.get('amend') and bheads and node not in bheads and not
         [x for x in parents if x.node() in bheads and x.branch() == branch]):
         ui.status(_('created new head\n'))
         # The message is not printed for initial roots. For the other
         # changesets, it is printed in the following situations:
         #
         # Par column: for the 2 parents with ...
         #   N: null or no parent
         #   B: parent is on another named branch
         #   C: parent is a regular non head changeset
         #   H: parent was a branch head of the current branch
         # Msg column: whether we print "created new head" message
         # In the following, it is assumed that there already exists some
         # initial branch heads of the current branch, otherwise nothing is
         # printed anyway.
         #
         # Par Msg Comment
         # N N  y  additional topo root
         #
         # B N  y  additional branch root
         # C N  y  additional topo head
         # H N  n  usual case
         #
         # B B  y  weird additional branch root
         # C B  y  branch merge
         # H B  n  merge with named branch
         #
         # C C  y  additional head from merge
         # C H  n  merge with a head
         #
         # H H  n  head merge: head count decreases
 
     if not opts.get('close_branch'):
         for r in parents:
             if r.closesbranch() and r.branch() == branch:
                 ui.status(_('reopening closed branch head %d\n') % r)
 
     if ui.debugflag:
         ui.write(_('committed changeset %d:%s\n') % (int(ctx), ctx.hex()))
     elif ui.verbose:
         ui.write(_('committed changeset %d:%s\n') % (int(ctx), ctx))
 
 @command('copy|cp',
     [('A', 'after', None, _('record a copy that has already occurred')),
     ('f', 'force', None, _('forcibly copy over an existing managed file')),
     ] + walkopts + dryrunopts,
     _('[OPTION]... [SOURCE]... DEST'))
 def copy(ui, repo, *pats, **opts):
     """mark files as copied for the next commit
 
     Mark dest as having copies of source files. If dest is a
     directory, copies are put in that directory. If dest is a file,
     the source must be a single file.
 
     By default, this command copies the contents of files as they
     exist in the working directory. If invoked with -A/--after, the
     operation is recorded, but no copying is performed.
 
     This command takes effect with the next commit. To undo a copy
     before that, see :hg:`revert`.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     wlock = repo.wlock(False)
     try:
         return cmdutil.copy(ui, repo, pats, opts)
     finally:
         wlock.release()
 
 @command('debugancestor', [], _('[INDEX] REV1 REV2'))
 def debugancestor(ui, repo, *args):
     """find the ancestor revision of two revisions in a given index"""
     if len(args) == 3:
         index, rev1, rev2 = args
         r = revlog.revlog(scmutil.opener(os.getcwd(), audit=False), index)
         lookup = r.lookup
     elif len(args) == 2:
         if not repo:
             raise util.Abort(_("there is no Mercurial repository here "
                                "(.hg not found)"))
         rev1, rev2 = args
         r = repo.changelog
         lookup = repo.lookup
     else:
         raise util.Abort(_('either two or three arguments required'))
     a = r.ancestor(lookup(rev1), lookup(rev2))
     ui.write("%d:%s\n" % (r.rev(a), hex(a)))
 
 @command('debugbuilddag',
     [('m', 'mergeable-file', None, _('add single file mergeable changes')),
     ('o', 'overwritten-file', None, _('add single file all revs overwrite')),
     ('n', 'new-file', None, _('add new file at each rev'))],
     _('[OPTION]... [TEXT]'))
 def debugbuilddag(ui, repo, text=None,
                   mergeable_file=False,
                   overwritten_file=False,
                   new_file=False):
     """builds a repo with a given DAG from scratch in the current empty repo
 
     The description of the DAG is read from stdin if not given on the
     command line.
 
     Elements:
 
      - "+n" is a linear run of n nodes based on the current default parent
      - "." is a single node based on the current default parent
      - "$" resets the default parent to null (implied at the start);
            otherwise the default parent is always the last node created
      - "<p" sets the default parent to the backref p
      - "*p" is a fork at parent p, which is a backref
      - "*p1/p2" is a merge of parents p1 and p2, which are backrefs
      - "/p2" is a merge of the preceding node and p2
      - ":tag" defines a local tag for the preceding node
      - "@branch" sets the named branch for subsequent nodes
      - "#...\\n" is a comment up to the end of the line
 
     Whitespace between the above elements is ignored.
 
     A backref is either
 
      - a number n, which references the node curr-n, where curr is the current
        node, or
      - the name of a local tag you placed earlier using ":tag", or
      - empty to denote the default parent.
 
     All string valued-elements are either strictly alphanumeric, or must
     be enclosed in double quotes ("..."), with "\\" as escape character.
     """
 
     if text is None:
         ui.status(_("reading DAG from stdin\n"))
         text = ui.fin.read()
 
     cl = repo.changelog
     if len(cl) > 0:
         raise util.Abort(_('repository is not empty'))
 
     # determine number of revs in DAG
     total = 0
     for type, data in dagparser.parsedag(text):
         if type == 'n':
             total += 1
 
     if mergeable_file:
         linesperrev = 2
         # make a file with k lines per rev
         initialmergedlines = [str(i) for i in xrange(0, total * linesperrev)]
         initialmergedlines.append("")
 
     tags = []
 
     lock = tr = None
     try:
         lock = repo.lock()
         tr = repo.transaction("builddag")
 
         at = -1
         atbranch = 'default'
         nodeids = []
         id = 0
         ui.progress(_('building'), id, unit=_('revisions'), total=total)
         for type, data in dagparser.parsedag(text):
             if type == 'n':
                 ui.note('node %s\n' % str(data))
                 id, ps = data
 
                 files = []
                 fctxs = {}
 
                 p2 = None
                 if mergeable_file:
                     fn = "mf"
                     p1 = repo[ps[0]]
                     if len(ps) > 1:
                         p2 = repo[ps[1]]
                         pa = p1.ancestor(p2)
                         base, local, other = [x[fn].data() for x in pa, p1, p2]
                         m3 = simplemerge.Merge3Text(base, local, other)
                         ml = [l.strip() for l in m3.merge_lines()]
                         ml.append("")
                     elif at > 0:
                         ml = p1[fn].data().split("\n")
                     else:
                         ml = initialmergedlines
                     ml[id * linesperrev] += " r%i" % id
                     mergedtext = "\n".join(ml)
                     files.append(fn)
                     fctxs[fn] = context.memfilectx(fn, mergedtext)
 
                 if overwritten_file:
                     fn = "of"
                     files.append(fn)
                     fctxs[fn] = context.memfilectx(fn, "r%i\n" % id)
 
                 if new_file:
                     fn = "nf%i" % id
                     files.append(fn)
                     fctxs[fn] = context.memfilectx(fn, "r%i\n" % id)
                     if len(ps) > 1:
                         if not p2:
                             p2 = repo[ps[1]]
                         for fn in p2:
                             if fn.startswith("nf"):
                                 files.append(fn)
                                 fctxs[fn] = p2[fn]
 
                 def fctxfn(repo, cx, path):
                     return fctxs.get(path)
 
                 if len(ps) == 0 or ps[0] < 0:
                     pars = [None, None]
                 elif len(ps) == 1:
                     pars = [nodeids[ps[0]], None]
                 else:
                     pars = [nodeids[p] for p in ps]
                 cx = context.memctx(repo, pars, "r%i" % id, files, fctxfn,
                                     date=(id, 0),
                                     user="debugbuilddag",
                                     extra={'branch': atbranch})
                 nodeid = repo.commitctx(cx)
                 nodeids.append(nodeid)
                 at = id
             elif type == 'l':
                 id, name = data
                 ui.note('tag %s\n' % name)
                 tags.append("%s %s\n" % (hex(repo.changelog.node(id)), name))
             elif type == 'a':
                 ui.note('branch %s\n' % data)
                 atbranch = data
             ui.progress(_('building'), id, unit=_('revisions'), total=total)
         tr.close()
 
         if tags:
             repo.opener.write("localtags", "".join(tags))
     finally:
         ui.progress(_('building'), None)
         release(tr, lock)
 
 @command('debugbundle', [('a', 'all', None, _('show all details'))], _('FILE'))
 def debugbundle(ui, bundlepath, all=None, **opts):
     """lists the contents of a bundle"""
     f = url.open(ui, bundlepath)
     try:
         gen = changegroup.readbundle(f, bundlepath)
         if all:
             ui.write("format: id, p1, p2, cset, delta base, len(delta)\n")
 
             def showchunks(named):
                 ui.write("\n%s\n" % named)
                 chain = None
                 while True:
                     chunkdata = gen.deltachunk(chain)
                     if not chunkdata:
                         break
                     node = chunkdata['node']
                     p1 = chunkdata['p1']
                     p2 = chunkdata['p2']
                     cs = chunkdata['cs']
                     deltabase = chunkdata['deltabase']
                     delta = chunkdata['delta']
                     ui.write("%s %s %s %s %s %s\n" %
                              (hex(node), hex(p1), hex(p2),
                               hex(cs), hex(deltabase), len(delta)))
                     chain = node
 
             chunkdata = gen.changelogheader()
             showchunks("changelog")
             chunkdata = gen.manifestheader()
             showchunks("manifest")
             while True:
                 chunkdata = gen.filelogheader()
                 if not chunkdata:
                     break
                 fname = chunkdata['filename']
                 showchunks(fname)
         else:
             chunkdata = gen.changelogheader()
             chain = None
             while True:
                 chunkdata = gen.deltachunk(chain)
                 if not chunkdata:
                     break
                 node = chunkdata['node']
                 ui.write("%s\n" % hex(node))
                 chain = node
     finally:
         f.close()
 
 @command('debugcheckstate', [], '')
 def debugcheckstate(ui, repo):
     """validate the correctness of the current dirstate"""
     parent1, parent2 = repo.dirstate.parents()
     m1 = repo[parent1].manifest()
     m2 = repo[parent2].manifest()
     errors = 0
     for f in repo.dirstate:
         state = repo.dirstate[f]
         if state in "nr" and f not in m1:
             ui.warn(_("%s in state %s, but not in manifest1\n") % (f, state))
             errors += 1
         if state in "a" and f in m1:
             ui.warn(_("%s in state %s, but also in manifest1\n") % (f, state))
             errors += 1
         if state in "m" and f not in m1 and f not in m2:
             ui.warn(_("%s in state %s, but not in either manifest\n") %
                     (f, state))
             errors += 1
     for f in m1:
         state = repo.dirstate[f]
         if state not in "nrm":
             ui.warn(_("%s in manifest1, but listed as state %s") % (f, state))
             errors += 1
     if errors:
         error = _(".hg/dirstate inconsistent with current parent's manifest")
         raise util.Abort(error)
 
 @command('debugcommands', [], _('[COMMAND]'))
 def debugcommands(ui, cmd='', *args):
     """list all available commands and options"""
     for cmd, vals in sorted(table.iteritems()):
         cmd = cmd.split('|')[0].strip('^')
         opts = ', '.join([i[1] for i in vals[1]])
         ui.write('%s: %s\n' % (cmd, opts))
 
 @command('debugcomplete',
     [('o', 'options', None, _('show the command options'))],
     _('[-o] CMD'))
 def debugcomplete(ui, cmd='', **opts):
     """returns the completion list associated with the given command"""
 
     if opts.get('options'):
         options = []
         otables = [globalopts]
         if cmd:
             aliases, entry = cmdutil.findcmd(cmd, table, False)
             otables.append(entry[1])
         for t in otables:
             for o in t:
                 if "(DEPRECATED)" in o[3]:
                     continue
                 if o[0]:
                     options.append('-%s' % o[0])
                 options.append('--%s' % o[1])
         ui.write("%s\n" % "\n".join(options))
         return
 
     cmdlist = cmdutil.findpossible(cmd, table)
     if ui.verbose:
         cmdlist = [' '.join(c[0]) for c in cmdlist.values()]
     ui.write("%s\n" % "\n".join(sorted(cmdlist)))
 
 @command('debugdag',
     [('t', 'tags', None, _('use tags as labels')),
     ('b', 'branches', None, _('annotate with branch names')),
     ('', 'dots', None, _('use dots for runs')),
     ('s', 'spaces', None, _('separate elements by spaces'))],
     _('[OPTION]... [FILE [REV]...]'))
 def debugdag(ui, repo, file_=None, *revs, **opts):
     """format the changelog or an index DAG as a concise textual description
 
     If you pass a revlog index, the revlog's DAG is emitted. If you list
-    revision numbers, they get labelled in the output as rN.
+    revision numbers, they get labeled in the output as rN.
 
     Otherwise, the changelog DAG of the current repo is emitted.
     """
     spaces = opts.get('spaces')
     dots = opts.get('dots')
     if file_:
         rlog = revlog.revlog(scmutil.opener(os.getcwd(), audit=False), file_)
         revs = set((int(r) for r in revs))
         def events():
             for r in rlog:
                 yield 'n', (r, list(set(p for p in rlog.parentrevs(r)
                                         if p != -1)))
                 if r in revs:
                     yield 'l', (r, "r%i" % r)
     elif repo:
         cl = repo.changelog
         tags = opts.get('tags')
         branches = opts.get('branches')
         if tags:
             labels = {}
             for l, n in repo.tags().items():
                 labels.setdefault(cl.rev(n), []).append(l)
         def events():
             b = "default"
             for r in cl:
                 if branches:
                     newb = cl.read(cl.node(r))[5]['branch']
                     if newb != b:
                         yield 'a', newb
                         b = newb
                 yield 'n', (r, list(set(p for p in cl.parentrevs(r)
                                         if p != -1)))
                 if tags:
                     ls = labels.get(r)
                     if ls:
                         for l in ls:
                             yield 'l', (r, l)
     else:
         raise util.Abort(_('need repo for changelog dag'))
 
     for line in dagparser.dagtextlines(events(),
                                        addspaces=spaces,
                                        wraplabels=True,
                                        wrapannotations=True,
                                        wrapnonlinear=dots,
                                        usedots=dots,
                                        maxlinewidth=70):
         ui.write(line)
         ui.write("\n")
 
 @command('debugdata',
     [('c', 'changelog', False, _('open changelog')),
      ('m', 'manifest', False, _('open manifest'))],
     _('-c|-m|FILE REV'))
 def debugdata(ui, repo, file_, rev = None, **opts):
     """dump the contents of a data file revision"""
     if opts.get('changelog') or opts.get('manifest'):
         file_, rev = None, file_
     elif rev is None:
         raise error.CommandError('debugdata', _('invalid arguments'))
     r = cmdutil.openrevlog(repo, 'debugdata', file_, opts)
     try:
         ui.write(r.revision(r.lookup(rev)))
     except KeyError:
         raise util.Abort(_('invalid revision identifier %s') % rev)
 
 @command('debugdate',
     [('e', 'extended', None, _('try extended date formats'))],
     _('[-e] DATE [RANGE]'))
 def debugdate(ui, date, range=None, **opts):
     """parse and display a date"""
     if opts["extended"]:
         d = util.parsedate(date, util.extendeddateformats)
     else:
         d = util.parsedate(date)
     ui.write("internal: %s %s\n" % d)
     ui.write("standard: %s\n" % util.datestr(d))
     if range:
         m = util.matchdate(range)
         ui.write("match: %s\n" % m(d[0]))
 
 @command('debugdiscovery',
     [('', 'old', None, _('use old-style discovery')),
     ('', 'nonheads', None,
      _('use old-style discovery with non-heads included')),
     ] + remoteopts,
     _('[-l REV] [-r REV] [-b BRANCH]... [OTHER]'))
 def debugdiscovery(ui, repo, remoteurl="default", **opts):
     """runs the changeset discovery protocol in isolation"""
     remoteurl, branches = hg.parseurl(ui.expandpath(remoteurl),
                                       opts.get('branch'))
     remote = hg.peer(repo, opts, remoteurl)
     ui.status(_('comparing with %s\n') % util.hidepassword(remoteurl))
 
     # make sure tests are repeatable
     random.seed(12323)
 
     def doit(localheads, remoteheads, remote=remote):
         if opts.get('old'):
             if localheads:
                 raise util.Abort('cannot use localheads with old style '
                                  'discovery')
             if not util.safehasattr(remote, 'branches'):
                 # enable in-client legacy support
                 remote = localrepo.locallegacypeer(remote.local())
             common, _in, hds = treediscovery.findcommonincoming(repo, remote,
                                                                 force=True)
             common = set(common)
             if not opts.get('nonheads'):
                 ui.write("unpruned common: %s\n" % " ".join([short(n)
                                                             for n in common]))
                 dag = dagutil.revlogdag(repo.changelog)
                 all = dag.ancestorset(dag.internalizeall(common))
                 common = dag.externalizeall(dag.headsetofconnecteds(all))
         else:
             common, any, hds = setdiscovery.findcommonheads(ui, repo, remote)
         common = set(common)
         rheads = set(hds)
         lheads = set(repo.heads())
         ui.write("common heads: %s\n" % " ".join([short(n) for n in common]))
         if lheads <= common:
             ui.write("local is subset\n")
         elif rheads <= common:
             ui.write("remote is subset\n")
 
     serverlogs = opts.get('serverlog')
     if serverlogs:
         for filename in serverlogs:
             logfile = open(filename, 'r')
             try:
                 line = logfile.readline()
                 while line:
                     parts = line.strip().split(';')
                     op = parts[1]
                     if op == 'cg':
                         pass
                     elif op == 'cgss':
                         doit(parts[2].split(' '), parts[3].split(' '))
                     elif op == 'unb':
                         doit(parts[3].split(' '), parts[2].split(' '))
                     line = logfile.readline()
             finally:
                 logfile.close()
 
     else:
         remoterevs, _checkout = hg.addbranchrevs(repo, remote, branches,
                                                  opts.get('remote_head'))
         localrevs = opts.get('local_head')
         doit(localrevs, remoterevs)
 
 @command('debugfileset',
     [('r', 'rev', '', _('apply the filespec on this revision'), _('REV'))],
     _('[-r REV] FILESPEC'))
 def debugfileset(ui, repo, expr, **opts):
     '''parse and apply a fileset specification'''
     ctx = scmutil.revsingle(repo, opts.get('rev'), None)
     if ui.verbose:
         tree = fileset.parse(expr)[0]
         ui.note(tree, "\n")
 
     for f in fileset.getfileset(ctx, expr):
         ui.write("%s\n" % f)
 
 @command('debugfsinfo', [], _('[PATH]'))
 def debugfsinfo(ui, path = "."):
     """show information detected about current filesystem"""
     util.writefile('.debugfsinfo', '')
     ui.write('exec: %s\n' % (util.checkexec(path) and 'yes' or 'no'))
     ui.write('symlink: %s\n' % (util.checklink(path) and 'yes' or 'no'))
     ui.write('case-sensitive: %s\n' % (util.checkcase('.debugfsinfo')
                                 and 'yes' or 'no'))
     os.unlink('.debugfsinfo')
 
 @command('debuggetbundle',
     [('H', 'head', [], _('id of head node'), _('ID')),
     ('C', 'common', [], _('id of common node'), _('ID')),
     ('t', 'type', 'bzip2', _('bundle compression type to use'), _('TYPE'))],
     _('REPO FILE [-H|-C ID]...'))
 def debuggetbundle(ui, repopath, bundlepath, head=None, common=None, **opts):
     """retrieves a bundle from a repo
 
     Every ID must be a full-length hex node id string. Saves the bundle to the
     given file.
     """
     repo = hg.peer(ui, opts, repopath)
     if not repo.capable('getbundle'):
         raise util.Abort("getbundle() not supported by target repository")
     args = {}
     if common:
         args['common'] = [bin(s) for s in common]
     if head:
         args['heads'] = [bin(s) for s in head]
     bundle = repo.getbundle('debug', **args)
 
     bundletype = opts.get('type', 'bzip2').lower()
     btypes = {'none': 'HG10UN', 'bzip2': 'HG10BZ', 'gzip': 'HG10GZ'}
     bundletype = btypes.get(bundletype)
     if bundletype not in changegroup.bundletypes:
         raise util.Abort(_('unknown bundle type specified with --type'))
     changegroup.writebundle(bundle, bundlepath, bundletype)
 
 @command('debugignore', [], '')
 def debugignore(ui, repo, *values, **opts):
     """display the combined ignore pattern"""
     ignore = repo.dirstate._ignore
     includepat = getattr(ignore, 'includepat', None)
     if includepat is not None:
         ui.write("%s\n" % includepat)
     else:
         raise util.Abort(_("no ignore patterns found"))
 
 @command('debugindex',
     [('c', 'changelog', False, _('open changelog')),
      ('m', 'manifest', False, _('open manifest')),
      ('f', 'format', 0, _('revlog format'), _('FORMAT'))],
     _('[-f FORMAT] -c|-m|FILE'))
 def debugindex(ui, repo, file_ = None, **opts):
     """dump the contents of an index file"""
     r = cmdutil.openrevlog(repo, 'debugindex', file_, opts)
     format = opts.get('format', 0)
     if format not in (0, 1):
         raise util.Abort(_("unknown format %d") % format)
 
     generaldelta = r.version & revlog.REVLOGGENERALDELTA
     if generaldelta:
         basehdr = ' delta'
     else:
         basehdr = '  base'
 
     if format == 0:
         ui.write("   rev    offset  length " + basehdr + " linkrev"
                  " nodeid       p1           p2\n")
     elif format == 1:
         ui.write("   rev flag   offset   length"
                  "     size " + basehdr + "   link     p1     p2"
                  "       nodeid\n")
 
     for i in r:
         node = r.node(i)
         if generaldelta:
             base = r.deltaparent(i)
         else:
             base = r.chainbase(i)
         if format == 0:
             try:
                 pp = r.parents(node)
             except Exception:
                 pp = [nullid, nullid]
             ui.write("% 6d % 9d % 7d % 6d % 7d %s %s %s\n" % (
                     i, r.start(i), r.length(i), base, r.linkrev(i),
                     short(node), short(pp[0]), short(pp[1])))
         elif format == 1:
             pr = r.parentrevs(i)
             ui.write("% 6d %04x % 8d % 8d % 8d % 6d % 6d % 6d % 6d %s\n" % (
                     i, r.flags(i), r.start(i), r.length(i), r.rawsize(i),
                     base, r.linkrev(i), pr[0], pr[1], short(node)))
 
 @command('debugindexdot', [], _('FILE'))
 def debugindexdot(ui, repo, file_):
     """dump an index DAG as a graphviz dot file"""
     r = None
     if repo:
         filelog = repo.file(file_)
         if len(filelog):
             r = filelog
     if not r:
         r = revlog.revlog(scmutil.opener(os.getcwd(), audit=False), file_)
     ui.write("digraph G {\n")
     for i in r:
         node = r.node(i)
         pp = r.parents(node)
         ui.write("\t%d -> %d\n" % (r.rev(pp[0]), i))
         if pp[1] != nullid:
             ui.write("\t%d -> %d\n" % (r.rev(pp[1]), i))
     ui.write("}\n")
 
 @command('debuginstall', [], '')
 def debuginstall(ui):
     '''test Mercurial installation
 
     Returns 0 on success.
     '''
 
     def writetemp(contents):
         (fd, name) = tempfile.mkstemp(prefix="hg-debuginstall-")
         f = os.fdopen(fd, "wb")
         f.write(contents)
         f.close()
         return name
 
     problems = 0
 
     # encoding
     ui.status(_("checking encoding (%s)...\n") % encoding.encoding)
     try:
         encoding.fromlocal("test")
     except util.Abort, inst:
         ui.write(" %s\n" % inst)
         ui.write(_(" (check that your locale is properly set)\n"))
         problems += 1
 
     # Python lib
     ui.status(_("checking Python lib (%s)...\n")
               % os.path.dirname(os.__file__))
 
     # compiled modules
     ui.status(_("checking installed modules (%s)...\n")
               % os.path.dirname(__file__))
     try:
         import bdiff, mpatch, base85, osutil
         dir(bdiff), dir(mpatch), dir(base85), dir(osutil) # quiet pyflakes
     except Exception, inst:
         ui.write(" %s\n" % inst)
         ui.write(_(" One or more extensions could not be found"))
         ui.write(_(" (check that you compiled the extensions)\n"))
         problems += 1
 
     # templates
     import templater
     p = templater.templatepath()
     ui.status(_("checking templates (%s)...\n") % ' '.join(p))
     try:
         templater.templater(templater.templatepath("map-cmdline.default"))
     except Exception, inst:
         ui.write(" %s\n" % inst)
         ui.write(_(" (templates seem to have been installed incorrectly)\n"))
         problems += 1
 
     # editor
     ui.status(_("checking commit editor...\n"))
     editor = ui.geteditor()
     cmdpath = util.findexe(editor) or util.findexe(editor.split()[0])
     if not cmdpath:
         if editor == 'vi':
             ui.write(_(" No commit editor set and can't find vi in PATH\n"))
             ui.write(_(" (specify a commit editor in your configuration"
                        " file)\n"))
         else:
             ui.write(_(" Can't find editor '%s' in PATH\n") % editor)
             ui.write(_(" (specify a commit editor in your configuration"
                        " file)\n"))
             problems += 1
 
     # check username
     ui.status(_("checking username...\n"))
     try:
         ui.username()
     except util.Abort, e:
         ui.write(" %s\n" % e)
         ui.write(_(" (specify a username in your configuration file)\n"))
         problems += 1
 
     if not problems:
         ui.status(_("no problems detected\n"))
     else:
         ui.write(_("%s problems detected,"
                    " please check your install!\n") % problems)
 
     return problems
 
 @command('debugknown', [], _('REPO ID...'))
 def debugknown(ui, repopath, *ids, **opts):
     """test whether node ids are known to a repo
 
     Every ID must be a full-length hex node id string. Returns a list of 0s
     and 1s indicating unknown/known.
     """
     repo = hg.peer(ui, opts, repopath)
     if not repo.capable('known'):
         raise util.Abort("known() not supported by target repository")
     flags = repo.known([bin(s) for s in ids])
     ui.write("%s\n" % ("".join([f and "1" or "0" for f in flags])))
 
 @command('debugobsolete', [] + commitopts2,
          _('[OBSOLETED [REPLACEMENT] [REPL... ]'))
 def debugobsolete(ui, repo, precursor=None, *successors, **opts):
     """create arbitrary obsolete marker"""
     def parsenodeid(s):
         try:
             # We do not use revsingle/revrange functions here to accept
             # arbitrary node identifiers, possibly not present in the
             # local repository.
             n = bin(s)
             if len(n) != len(nullid):
                 raise TypeError()
             return n
         except TypeError:
             raise util.Abort('changeset references must be full hexadecimal '
                              'node identifiers')
 
     if precursor is not None:
         metadata = {}
         if 'date' in opts:
             metadata['date'] = opts['date']
         metadata['user'] = opts['user'] or ui.username()
         succs = tuple(parsenodeid(succ) for succ in successors)
         l = repo.lock()
         try:
             tr = repo.transaction('debugobsolete')
             try:
                 repo.obsstore.create(tr, parsenodeid(precursor), succs, 0,
                                      metadata)
                 tr.close()
             finally:
                 tr.release()
         finally:
             l.release()
     else:
         for m in obsolete.allmarkers(repo):
             ui.write(hex(m.precnode()))
             for repl in m.succnodes():
                 ui.write(' ')
                 ui.write(hex(repl))
             ui.write(' %X ' % m._data[2])
             ui.write(m.metadata())
             ui.write('\n')
 
 @command('debugpushkey', [], _('REPO NAMESPACE [KEY OLD NEW]'))
 def debugpushkey(ui, repopath, namespace, *keyinfo, **opts):
     '''access the pushkey key/value protocol
 
     With two args, list the keys in the given namespace.
 
     With five args, set a key to new if it currently is set to old.
     Reports success or failure.
     '''
 
     target = hg.peer(ui, {}, repopath)
     if keyinfo:
         key, old, new = keyinfo
         r = target.pushkey(namespace, key, old, new)
         ui.status(str(r) + '\n')
         return not r
     else:
         for k, v in target.listkeys(namespace).iteritems():
             ui.write("%s\t%s\n" % (k.encode('string-escape'),
                                    v.encode('string-escape')))
 
 @command('debugpvec', [], _('A B'))
 def debugpvec(ui, repo, a, b=None):
     ca = scmutil.revsingle(repo, a)
     cb = scmutil.revsingle(repo, b)
     pa = pvec.ctxpvec(ca)
     pb = pvec.ctxpvec(cb)
     if pa == pb:
         rel = "="
     elif pa > pb:
         rel = ">"
     elif pa < pb:
         rel = "<"
     elif pa | pb:
         rel = "|"
     ui.write(_("a: %s\n") % pa)
     ui.write(_("b: %s\n") % pb)
     ui.write(_("depth(a): %d depth(b): %d\n") % (pa._depth, pb._depth))
     ui.write(_("delta: %d hdist: %d distance: %d relation: %s\n") %
              (abs(pa._depth - pb._depth), pvec._hamming(pa._vec, pb._vec),
               pa.distance(pb), rel))
 
 @command('debugrebuildstate',
     [('r', 'rev', '', _('revision to rebuild to'), _('REV'))],
     _('[-r REV] [REV]'))
 def debugrebuildstate(ui, repo, rev="tip"):
     """rebuild the dirstate as it would look like for the given revision"""
     ctx = scmutil.revsingle(repo, rev)
     wlock = repo.wlock()
     try:
         repo.dirstate.rebuild(ctx.node(), ctx.manifest())
     finally:
         wlock.release()
 
 @command('debugrename',
     [('r', 'rev', '', _('revision to debug'), _('REV'))],
     _('[-r REV] FILE'))
 def debugrename(ui, repo, file1, *pats, **opts):
     """dump rename information"""
 
     ctx = scmutil.revsingle(repo, opts.get('rev'))
     m = scmutil.match(ctx, (file1,) + pats, opts)
     for abs in ctx.walk(m):
         fctx = ctx[abs]
         o = fctx.filelog().renamed(fctx.filenode())
         rel = m.rel(abs)
         if o:
             ui.write(_("%s renamed from %s:%s\n") % (rel, o[0], hex(o[1])))
         else:
             ui.write(_("%s not renamed\n") % rel)
 
 @command('debugrevlog',
     [('c', 'changelog', False, _('open changelog')),
      ('m', 'manifest', False, _('open manifest')),
      ('d', 'dump', False, _('dump index data'))],
      _('-c|-m|FILE'))
 def debugrevlog(ui, repo, file_ = None, **opts):
     """show data and statistics about a revlog"""
     r = cmdutil.openrevlog(repo, 'debugrevlog', file_, opts)
 
     if opts.get("dump"):
         numrevs = len(r)
         ui.write("# rev p1rev p2rev start end deltastart base p1 p2"
                  " rawsize totalsize compression heads\n")
         ts = 0
         heads = set()
         for rev in xrange(numrevs):
             dbase = r.deltaparent(rev)
             if dbase == -1:
                 dbase = rev
             cbase = r.chainbase(rev)
             p1, p2 = r.parentrevs(rev)
             rs = r.rawsize(rev)
             ts = ts + rs
             heads -= set(r.parentrevs(rev))
             heads.add(rev)
             ui.write("%d %d %d %d %d %d %d %d %d %d %d %d %d\n" %
                      (rev, p1, p2, r.start(rev), r.end(rev),
                       r.start(dbase), r.start(cbase),
                       r.start(p1), r.start(p2),
                       rs, ts, ts / r.end(rev), len(heads)))
         return 0
 
     v = r.version
     format = v & 0xFFFF
     flags = []
     gdelta = False
     if v & revlog.REVLOGNGINLINEDATA:
         flags.append('inline')
     if v & revlog.REVLOGGENERALDELTA:
         gdelta = True
         flags.append('generaldelta')
     if not flags:
         flags = ['(none)']
 
     nummerges = 0
     numfull = 0
     numprev = 0
     nump1 = 0
     nump2 = 0
     numother = 0
     nump1prev = 0
     nump2prev = 0
     chainlengths = []
 
     datasize = [None, 0, 0L]
     fullsize = [None, 0, 0L]
     deltasize = [None, 0, 0L]
 
     def addsize(size, l):
         if l[0] is None or size < l[0]:
             l[0] = size
         if size > l[1]:
             l[1] = size
         l[2] += size
 
     numrevs = len(r)
     for rev in xrange(numrevs):
         p1, p2 = r.parentrevs(rev)
         delta = r.deltaparent(rev)
         if format > 0:
             addsize(r.rawsize(rev), datasize)
         if p2 != nullrev:
             nummerges += 1
         size = r.length(rev)
         if delta == nullrev:
             chainlengths.append(0)
             numfull += 1
             addsize(size, fullsize)
         else:
             chainlengths.append(chainlengths[delta] + 1)
             addsize(size, deltasize)
             if delta == rev - 1:
                 numprev += 1
                 if delta == p1:
                     nump1prev += 1
                 elif delta == p2:
                     nump2prev += 1
             elif delta == p1:
                 nump1 += 1
             elif delta == p2:
                 nump2 += 1
             elif delta != nullrev:
                 numother += 1
 
     # Adjust size min value for empty cases
     for size in (datasize, fullsize, deltasize):
         if size[0] is None:
             size[0] = 0
 
     numdeltas = numrevs - numfull
     numoprev = numprev - nump1prev - nump2prev
     totalrawsize = datasize[2]
     datasize[2] /= numrevs
     fulltotal = fullsize[2]
     fullsize[2] /= numfull
     deltatotal = deltasize[2]
     if numrevs - numfull > 0:
         deltasize[2] /= numrevs - numfull
     totalsize = fulltotal + deltatotal
     avgchainlen = sum(chainlengths) / numrevs
     compratio = totalrawsize / totalsize
 
     basedfmtstr = '%%%dd\n'
     basepcfmtstr = '%%%dd %s(%%5.2f%%%%)\n'
 
     def dfmtstr(max):
         return basedfmtstr % len(str(max))
     def pcfmtstr(max, padding=0):
         return basepcfmtstr % (len(str(max)), ' ' * padding)
 
     def pcfmt(value, total):
         return (value, 100 * float(value) / total)
 
     ui.write('format : %d\n' % format)
     ui.write('flags  : %s\n' % ', '.join(flags))
 
     ui.write('\n')
     fmt = pcfmtstr(totalsize)
     fmt2 = dfmtstr(totalsize)
     ui.write('revisions     : ' + fmt2 % numrevs)
     ui.write('    merges    : ' + fmt % pcfmt(nummerges, numrevs))
     ui.write('    normal    : ' + fmt % pcfmt(numrevs - nummerges, numrevs))
     ui.write('revisions     : ' + fmt2 % numrevs)
     ui.write('    full      : ' + fmt % pcfmt(numfull, numrevs))
     ui.write('    deltas    : ' + fmt % pcfmt(numdeltas, numrevs))
     ui.write('revision size : ' + fmt2 % totalsize)
     ui.write('    full      : ' + fmt % pcfmt(fulltotal, totalsize))
     ui.write('    deltas    : ' + fmt % pcfmt(deltatotal, totalsize))
 
     ui.write('\n')
     fmt = dfmtstr(max(avgchainlen, compratio))
     ui.write('avg chain length  : ' + fmt % avgchainlen)
     ui.write('compression ratio : ' + fmt % compratio)
 
     if format > 0:
         ui.write('\n')
         ui.write('uncompressed data size (min/max/avg) : %d / %d / %d\n'
                  % tuple(datasize))
     ui.write('full revision size (min/max/avg)     : %d / %d / %d\n'
              % tuple(fullsize))
     ui.write('delta size (min/max/avg)             : %d / %d / %d\n'
              % tuple(deltasize))
 
     if numdeltas > 0:
         ui.write('\n')
         fmt = pcfmtstr(numdeltas)
         fmt2 = pcfmtstr(numdeltas, 4)
         ui.write('deltas against prev  : ' + fmt % pcfmt(numprev, numdeltas))
         if numprev > 0:
             ui.write('    where prev = p1  : ' + fmt2 % pcfmt(nump1prev,
                                                               numprev))
             ui.write('    where prev = p2  : ' + fmt2 % pcfmt(nump2prev,
                                                               numprev))
             ui.write('    other            : ' + fmt2 % pcfmt(numoprev,
                                                               numprev))
         if gdelta:
             ui.write('deltas against p1    : ' + fmt % pcfmt(nump1, numdeltas))
             ui.write('deltas against p2    : ' + fmt % pcfmt(nump2, numdeltas))
             ui.write('deltas against other : ' + fmt % pcfmt(numother,
                                                              numdeltas))
 
 @command('debugrevspec', [], ('REVSPEC'))
 def debugrevspec(ui, repo, expr):
     """parse and apply a revision specification
 
     Use --verbose to print the parsed tree before and after aliases
     expansion.
     """
     if ui.verbose:
         tree = revset.parse(expr)[0]
         ui.note(revset.prettyformat(tree), "\n")
         newtree = revset.findaliases(ui, tree)
         if newtree != tree:
             ui.note(revset.prettyformat(newtree), "\n")
     func = revset.match(ui, expr)
     for c in func(repo, range(len(repo))):
         ui.write("%s\n" % c)
 
 @command('debugsetparents', [], _('REV1 [REV2]'))
 def debugsetparents(ui, repo, rev1, rev2=None):
     """manually set the parents of the current working directory
 
     This is useful for writing repository conversion tools, but should
     be used with care.
 
     Returns 0 on success.
     """
 
     r1 = scmutil.revsingle(repo, rev1).node()
     r2 = scmutil.revsingle(repo, rev2, 'null').node()
 
     wlock = repo.wlock()
     try:
         repo.setparents(r1, r2)
     finally:
         wlock.release()
 
 @command('debugstate',
     [('', 'nodates', None, _('do not display the saved mtime')),
     ('', 'datesort', None, _('sort by saved mtime'))],
     _('[OPTION]...'))
 def debugstate(ui, repo, nodates=None, datesort=None):
     """show the contents of the current dirstate"""
     timestr = ""
     showdate = not nodates
     if datesort:
         keyfunc = lambda x: (x[1][3], x[0]) # sort by mtime, then by filename
     else:
         keyfunc = None # sort by filename
     for file_, ent in sorted(repo.dirstate._map.iteritems(), key=keyfunc):
         if showdate:
             if ent[3] == -1:
                 # Pad or slice to locale representation
                 locale_len = len(time.strftime("%Y-%m-%d %H:%M:%S ",
                                                time.localtime(0)))
                 timestr = 'unset'
                 timestr = (timestr[:locale_len] +
                            ' ' * (locale_len - len(timestr)))
             else:
                 timestr = time.strftime("%Y-%m-%d %H:%M:%S ",
                                         time.localtime(ent[3]))
         if ent[1] & 020000:
             mode = 'lnk'
         else:
             mode = '%3o' % (ent[1] & 0777 & ~util.umask)
         ui.write("%c %s %10d %s%s\n" % (ent[0], mode, ent[2], timestr, file_))
     for f in repo.dirstate.copies():
         ui.write(_("copy: %s -> %s\n") % (repo.dirstate.copied(f), f))
 
 @command('debugsub',
     [('r', 'rev', '',
      _('revision to check'), _('REV'))],
     _('[-r REV] [REV]'))
 def debugsub(ui, repo, rev=None):
     ctx = scmutil.revsingle(repo, rev, None)
     for k, v in sorted(ctx.substate.items()):
         ui.write('path %s\n' % k)
         ui.write(' source   %s\n' % v[0])
         ui.write(' revision %s\n' % v[1])
 
 @command('debugwalk', walkopts, _('[OPTION]... [FILE]...'))
 def debugwalk(ui, repo, *pats, **opts):
     """show how files match on given patterns"""
     m = scmutil.match(repo[None], pats, opts)
     items = list(repo.walk(m))
     if not items:
         return
     f = lambda fn: fn
     if ui.configbool('ui', 'slash') and os.sep != '/':
         f = lambda fn: util.normpath(fn)
     fmt = 'f  %%-%ds  %%-%ds  %%s' % (
         max([len(abs) for abs in items]),
         max([len(m.rel(abs)) for abs in items]))
     for abs in items:
         line = fmt % (abs, f(m.rel(abs)), m.exact(abs) and 'exact' or '')
         ui.write("%s\n" % line.rstrip())
 
 @command('debugwireargs',
     [('', 'three', '', 'three'),
     ('', 'four', '', 'four'),
     ('', 'five', '', 'five'),
     ] + remoteopts,
     _('REPO [OPTIONS]... [ONE [TWO]]'))
 def debugwireargs(ui, repopath, *vals, **opts):
     repo = hg.peer(ui, opts, repopath)
     for opt in remoteopts:
         del opts[opt[1]]
     args = {}
     for k, v in opts.iteritems():
         if v:
             args[k] = v
     # run twice to check that we don't mess up the stream for the next command
     res1 = repo.debugwireargs(*vals, **args)
     res2 = repo.debugwireargs(*vals, **args)
     ui.write("%s\n" % res1)
     if res1 != res2:
         ui.warn("%s\n" % res2)
 
 @command('^diff',
     [('r', 'rev', [], _('revision'), _('REV')),
     ('c', 'change', '', _('change made by revision'), _('REV'))
     ] + diffopts + diffopts2 + walkopts + subrepoopts,
     _('[OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...'))
 def diff(ui, repo, *pats, **opts):
     """diff repository (or selected files)
 
     Show differences between revisions for the specified files.
 
     Differences between files are shown using the unified diff format.
 
     .. note::
        diff may generate unexpected results for merges, as it will
        default to comparing against the working directory's first
        parent changeset if no revisions are specified.
 
     When two revision arguments are given, then changes are shown
     between those revisions. If only one revision is specified then
     that revision is compared to the working directory, and, when no
     revisions are specified, the working directory files are compared
     to its parent.
 
     Alternatively you can specify -c/--change with a revision to see
     the changes in that changeset relative to its first parent.
 
     Without the -a/--text option, diff will avoid generating diffs of
     files it detects as binary. With -a, diff will generate a diff
     anyway, probably with undesirable results.
 
     Use the -g/--git option to generate diffs in the git extended diff
     format. For more information, read :hg:`help diffs`.
 
     .. container:: verbose
 
       Examples:
 
       - compare a file in the current working directory to its parent::
 
           hg diff foo.c
 
       - compare two historical versions of a directory, with rename info::
 
           hg diff --git -r 1.0:1.2 lib/
 
       - get change stats relative to the last change on some date::
 
           hg diff --stat -r "date('may 2')"
 
       - diff all newly-added files that contain a keyword::
 
           hg diff "set:added() and grep(GNU)"
 
       - compare a revision and its parents::
 
           hg diff -c 9353         # compare against first parent
           hg diff -r 9353^:9353   # same using revset syntax
           hg diff -r 9353^2:9353  # compare against the second parent
 
     Returns 0 on success.
     """
 
     revs = opts.get('rev')
     change = opts.get('change')
     stat = opts.get('stat')
     reverse = opts.get('reverse')
 
     if revs and change:
         msg = _('cannot specify --rev and --change at the same time')
         raise util.Abort(msg)
     elif change:
         node2 = scmutil.revsingle(repo, change, None).node()
         node1 = repo[node2].p1().node()
     else:
         node1, node2 = scmutil.revpair(repo, revs)
 
     if reverse:
         node1, node2 = node2, node1
 
     diffopts = patch.diffopts(ui, opts)
     m = scmutil.match(repo[node2], pats, opts)
     cmdutil.diffordiffstat(ui, repo, diffopts, node1, node2, m, stat=stat,
                            listsubrepos=opts.get('subrepos'))
 
 @command('^export',
     [('o', 'output', '',
      _('print output to file with formatted name'), _('FORMAT')),
     ('', 'switch-parent', None, _('diff against the second parent')),
     ('r', 'rev', [], _('revisions to export'), _('REV')),
     ] + diffopts,
     _('[OPTION]... [-o OUTFILESPEC] [-r] REV...'))
 def export(ui, repo, *changesets, **opts):
     """dump the header and diffs for one or more changesets
 
     Print the changeset header and diffs for one or more revisions.
 
     The information shown in the changeset header is: author, date,
     branch name (if non-default), changeset hash, parent(s) and commit
     comment.
 
     .. note::
        export may generate unexpected diff output for merge
        changesets, as it will compare the merge changeset against its
        first parent only.
 
     Output may be to a file, in which case the name of the file is
     given using a format string. The formatting rules are as follows:
 
     :``%%``: literal "%" character
     :``%H``: changeset hash (40 hexadecimal digits)
     :``%N``: number of patches being generated
     :``%R``: changeset revision number
     :``%b``: basename of the exporting repository
     :``%h``: short-form changeset hash (12 hexadecimal digits)
     :``%m``: first line of the commit message (only alphanumeric characters)
     :``%n``: zero-padded sequence number, starting at 1
     :``%r``: zero-padded changeset revision number
 
     Without the -a/--text option, export will avoid generating diffs
     of files it detects as binary. With -a, export will generate a
     diff anyway, probably with undesirable results.
 
     Use the -g/--git option to generate diffs in the git extended diff
     format. See :hg:`help diffs` for more information.
 
     With the --switch-parent option, the diff will be against the
     second parent. It can be useful to review a merge.
 
     .. container:: verbose
 
       Examples:
 
       - use export and import to transplant a bugfix to the current
         branch::
 
           hg export -r 9353 | hg import -
 
       - export all the changesets between two revisions to a file with
         rename information::
 
           hg export --git -r 123:150 > changes.txt
 
       - split outgoing changes into a series of patches with
         descriptive names::
 
           hg export -r "outgoing()" -o "%n-%m.patch"
 
     Returns 0 on success.
     """
     changesets += tuple(opts.get('rev', []))
     revs = scmutil.revrange(repo, changesets)
     if not revs:
         raise util.Abort(_("export requires at least one changeset"))
     if len(revs) > 1:
         ui.note(_('exporting patches:\n'))
     else:
         ui.note(_('exporting patch:\n'))
     cmdutil.export(repo, revs, template=opts.get('output'),
                  switch_parent=opts.get('switch_parent'),
                  opts=patch.diffopts(ui, opts))
 
 @command('^forget', walkopts, _('[OPTION]... FILE...'))
 def forget(ui, repo, *pats, **opts):
     """forget the specified files on the next commit
 
     Mark the specified files so they will no longer be tracked
     after the next commit.
 
     This only removes files from the current branch, not from the
     entire project history, and it does not delete them from the
     working directory.
 
     To undo a forget before the next commit, see :hg:`add`.
 
     .. container:: verbose
 
       Examples:
 
       - forget newly-added binary files::
 
           hg forget "set:added() and binary()"
 
       - forget files that would be excluded by .hgignore::
 
           hg forget "set:hgignore()"
 
     Returns 0 on success.
     """
 
     if not pats:
         raise util.Abort(_('no files specified'))
 
     m = scmutil.match(repo[None], pats, opts)
     rejected = cmdutil.forget(ui, repo, m, prefix="", explicitonly=False)[0]
     return rejected and 1 or 0
 
 @command(
     'graft',
     [('r', 'rev', [], _('revisions to graft'), _('REV')),
      ('c', 'continue', False, _('resume interrupted graft')),
      ('e', 'edit', False, _('invoke editor on commit messages')),
      ('', 'log', None, _('append graft info to log message')),
      ('D', 'currentdate', False,
       _('record the current date as commit date')),
      ('U', 'currentuser', False,
       _('record the current user as committer'), _('DATE'))]
     + commitopts2 + mergetoolopts  + dryrunopts,
     _('[OPTION]... [-r] REV...'))
 def graft(ui, repo, *revs, **opts):
     '''copy changes from other branches onto the current branch
 
     This command uses Mercurial's merge logic to copy individual
     changes from other branches without merging branches in the
     history graph. This is sometimes known as 'backporting' or
     'cherry-picking'. By default, graft will copy user, date, and
     description from the source changesets.
 
     Changesets that are ancestors of the current revision, that have
     already been grafted, or that are merges will be skipped.
 
     If --log is specified, log messages will have a comment appended
     of the form::
 
       (grafted from CHANGESETHASH)
 
     If a graft merge results in conflicts, the graft process is
     interrupted so that the current merge can be manually resolved.
     Once all conflicts are addressed, the graft process can be
     continued with the -c/--continue option.
 
     .. note::
       The -c/--continue option does not reapply earlier options.
 
     .. container:: verbose
 
       Examples:
 
       - copy a single change to the stable branch and edit its description::
 
           hg update stable
           hg graft --edit 9393
 
       - graft a range of changesets with one exception, updating dates::
 
           hg graft -D "2085::2093 and not 2091"
 
       - continue a graft after resolving conflicts::
 
           hg graft -c
 
       - show the source of a grafted changeset::
 
           hg log --debug -r tip
 
     Returns 0 on successful completion.
     '''
 
     revs = list(revs)
     revs.extend(opts['rev'])
 
     if not opts.get('user') and opts.get('currentuser'):
         opts['user'] = ui.username()
     if not opts.get('date') and opts.get('currentdate'):
         opts['date'] = "%d %d" % util.makedate()
 
     editor = None
     if opts.get('edit'):
         editor = cmdutil.commitforceeditor
 
     cont = False
     if opts['continue']:
         cont = True
         if revs:
             raise util.Abort(_("can't specify --continue and revisions"))
         # read in unfinished revisions
         try:
             nodes = repo.opener.read('graftstate').splitlines()
             revs = [repo[node].rev() for node in nodes]
         except IOError, inst:
             if inst.errno != errno.ENOENT:
                 raise
             raise util.Abort(_("no graft state found, can't continue"))
     else:
         cmdutil.bailifchanged(repo)
         if not revs:
             raise util.Abort(_('no revisions specified'))
         revs = scmutil.revrange(repo, revs)
 
     # check for merges
     for rev in repo.revs('%ld and merge()', revs):
         ui.warn(_('skipping ungraftable merge revision %s\n') % rev)
         revs.remove(rev)
     if not revs:
         return -1
 
     # check for ancestors of dest branch
     for rev in repo.revs('::. and %ld', revs):
         ui.warn(_('skipping ancestor revision %s\n') % rev)
         revs.remove(rev)
     if not revs:
         return -1
 
     # analyze revs for earlier grafts
     ids = {}
     for ctx in repo.set("%ld", revs):
         ids[ctx.hex()] = ctx.rev()
         n = ctx.extra().get('source')
         if n:
             ids[n] = ctx.rev()
 
     # check ancestors for earlier grafts
     ui.debug('scanning for duplicate grafts\n')
     for ctx in repo.set("::. - ::%ld", revs):
         n = ctx.extra().get('source')
         if n in ids:
             r = repo[n].rev()
             if r in revs:
                 ui.warn(_('skipping already grafted revision %s\n') % r)
                 revs.remove(r)
             elif ids[n] in revs:
                 ui.warn(_('skipping already grafted revision %s '
                             '(same origin %d)\n') % (ids[n], r))
                 revs.remove(ids[n])
         elif ctx.hex() in ids:
             r = ids[ctx.hex()]
             ui.warn(_('skipping already grafted revision %s '
                             '(was grafted from %d)\n') % (r, ctx.rev()))
             revs.remove(r)
     if not revs:
         return -1
 
     wlock = repo.wlock()
     try:
         for pos, ctx in enumerate(repo.set("%ld", revs)):
             current = repo['.']
 
             ui.status(_('grafting revision %s\n') % ctx.rev())
             if opts.get('dry_run'):
                 continue
 
             # we don't merge the first commit when continuing
             if not cont:
                 # perform the graft merge with p1(rev) as 'ancestor'
                 try:
                     # ui.forcemerge is an internal variable, do not document
                     repo.ui.setconfig('ui', 'forcemerge', opts.get('tool', ''))
                     stats = mergemod.update(repo, ctx.node(), True, True, False,
                                             ctx.p1().node())
                 finally:
                     repo.ui.setconfig('ui', 'forcemerge', '')
                 # report any conflicts
                 if stats and stats[3] > 0:
                     # write out state for --continue
                     nodelines = [repo[rev].hex() + "\n" for rev in revs[pos:]]
                     repo.opener.write('graftstate', ''.join(nodelines))
                     raise util.Abort(
                         _("unresolved conflicts, can't continue"),
                         hint=_('use hg resolve and hg graft --continue'))
             else:
                 cont = False
 
             # drop the second merge parent
             repo.setparents(current.node(), nullid)
             repo.dirstate.write()
             # fix up dirstate for copies and renames
             cmdutil.duplicatecopies(repo, ctx.rev(), ctx.p1().rev())
 
             # commit
             source = ctx.extra().get('source')
             if not source:
                 source = ctx.hex()
             extra = {'source': source}
             user = ctx.user()
             if opts.get('user'):
                 user = opts['user']
             date = ctx.date()
             if opts.get('date'):
                 date = opts['date']
             message = ctx.description()
             if opts.get('log'):
                 message += '\n(grafted from %s)' % ctx.hex()
             node = repo.commit(text=message, user=user,
                         date=date, extra=extra, editor=editor)
             if node is None:
                 ui.status(_('graft for revision %s is empty\n') % ctx.rev())
     finally:
         wlock.release()
 
     # remove state when we complete successfully
     if not opts.get('dry_run') and os.path.exists(repo.join('graftstate')):
         util.unlinkpath(repo.join('graftstate'))
 
     return 0
 
 @command('grep',
     [('0', 'print0', None, _('end fields with NUL')),
     ('', 'all', None, _('print all revisions that match')),
     ('a', 'text', None, _('treat all files as text')),
     ('f', 'follow', None,
      _('follow changeset history,'
        ' or file history across copies and renames')),
     ('i', 'ignore-case', None, _('ignore case when matching')),
     ('l', 'files-with-matches', None,
      _('print only filenames and revisions that match')),
     ('n', 'line-number', None, _('print matching line numbers')),
     ('r', 'rev', [],
      _('only search files changed within revision range'), _('REV')),
     ('u', 'user', None, _('list the author (long with -v)')),
     ('d', 'date', None, _('list the date (short with -q)')),
     ] + walkopts,
     _('[OPTION]... PATTERN [FILE]...'))
 def grep(ui, repo, pattern, *pats, **opts):
     """search for a pattern in specified files and revisions
 
     Search revisions of files for a regular expression.
 
     This command behaves differently than Unix grep. It only accepts
     Python/Perl regexps. It searches repository history, not the
     working directory. It always prints the revision number in which a
     match appears.
 
     By default, grep only prints output for the first revision of a
     file in which it finds a match. To get it to print every revision
     that contains a change in match status ("-" for a match that
     becomes a non-match, or "+" for a non-match that becomes a match),
     use the --all flag.
 
     Returns 0 if a match is found, 1 otherwise.
     """
     reflags = re.M
     if opts.get('ignore_case'):
         reflags |= re.I
     try:
         regexp = re.compile(pattern, reflags)
     except re.error, inst:
         ui.warn(_("grep: invalid match pattern: %s\n") % inst)
         return 1
     sep, eol = ':', '\n'
     if opts.get('print0'):
         sep = eol = '\0'
 
     getfile = util.lrucachefunc(repo.file)
 
     def matchlines(body):
         begin = 0
         linenum = 0
         while True:
             match = regexp.search(body, begin)
             if not match:
                 break
             mstart, mend = match.span()
             linenum += body.count('\n', begin, mstart) + 1
             lstart = body.rfind('\n', begin, mstart) + 1 or begin
             begin = body.find('\n', mend) + 1 or len(body) + 1
             lend = begin - 1
             yield linenum, mstart - lstart, mend - lstart, body[lstart:lend]
 
     class linestate(object):
         def __init__(self, line, linenum, colstart, colend):
             self.line = line
             self.linenum = linenum
             self.colstart = colstart
             self.colend = colend
 
         def __hash__(self):
             return hash((self.linenum, self.line))
 
         def __eq__(self, other):
             return self.line == other.line
 
     matches = {}
     copies = {}
     def grepbody(fn, rev, body):
         matches[rev].setdefault(fn, [])
         m = matches[rev][fn]
         for lnum, cstart, cend, line in matchlines(body):
             s = linestate(line, lnum, cstart, cend)
             m.append(s)
 
     def difflinestates(a, b):
         sm = difflib.SequenceMatcher(None, a, b)
         for tag, alo, ahi, blo, bhi in sm.get_opcodes():
             if tag == 'insert':
                 for i in xrange(blo, bhi):
                     yield ('+', b[i])
             elif tag == 'delete':
                 for i in xrange(alo, ahi):
                     yield ('-', a[i])
             elif tag == 'replace':
                 for i in xrange(alo, ahi):
                     yield ('-', a[i])
                 for i in xrange(blo, bhi):
                     yield ('+', b[i])
 
     def display(fn, ctx, pstates, states):
         rev = ctx.rev()
         datefunc = ui.quiet and util.shortdate or util.datestr
         found = False
         filerevmatches = {}
         def binary():
             flog = getfile(fn)
             return util.binary(flog.read(ctx.filenode(fn)))
 
         if opts.get('all'):
             iter = difflinestates(pstates, states)
         else:
             iter = [('', l) for l in states]
         for change, l in iter:
             cols = [fn, str(rev)]
             before, match, after = None, None, None
             if opts.get('line_number'):
                 cols.append(str(l.linenum))
             if opts.get('all'):
                 cols.append(change)
             if opts.get('user'):
                 cols.append(ui.shortuser(ctx.user()))
             if opts.get('date'):
                 cols.append(datefunc(ctx.date()))
             if opts.get('files_with_matches'):
                 c = (fn, rev)
                 if c in filerevmatches:
                     continue
                 filerevmatches[c] = 1
             else:
                 before = l.line[:l.colstart]
                 match = l.line[l.colstart:l.colend]
                 after = l.line[l.colend:]
             ui.write(sep.join(cols))
             if before is not None:
                 if not opts.get('text') and binary():
                     ui.write(sep + " Binary file matches")
                 else:
                     ui.write(sep + before)
                     ui.write(match, label='grep.match')
                     ui.write(after)
             ui.write(eol)
             found = True
         return found
 
     skip = {}
     revfiles = {}
     matchfn = scmutil.match(repo[None], pats, opts)
     found = False
     follow = opts.get('follow')
 
     def prep(ctx, fns):
         rev = ctx.rev()
         pctx = ctx.p1()
         parent = pctx.rev()
         matches.setdefault(rev, {})
         matches.setdefault(parent, {})
         files = revfiles.setdefault(rev, [])
         for fn in fns:
             flog = getfile(fn)
             try:
                 fnode = ctx.filenode(fn)
             except error.LookupError:
                 continue
 
             copied = flog.renamed(fnode)
             copy = follow and copied and copied[0]
             if copy:
                 copies.setdefault(rev, {})[fn] = copy
             if fn in skip:
                 if copy:
                     skip[copy] = True
                 continue
             files.append(fn)
 
             if fn not in matches[rev]:
                 grepbody(fn, rev, flog.read(fnode))
 
             pfn = copy or fn
             if pfn not in matches[parent]:
                 try:
                     fnode = pctx.filenode(pfn)
                     grepbody(pfn, parent, flog.read(fnode))
                 except error.LookupError:
                     pass
 
     for ctx in cmdutil.walkchangerevs(repo, matchfn, opts, prep):
         rev = ctx.rev()
         parent = ctx.p1().rev()
         for fn in sorted(revfiles.get(rev, [])):
             states = matches[rev][fn]
             copy = copies.get(rev, {}).get(fn)
             if fn in skip:
                 if copy:
                     skip[copy] = True
                 continue
             pstates = matches.get(parent, {}).get(copy or fn, [])
             if pstates or states:
                 r = display(fn, ctx, pstates, states)
                 found = found or r
                 if r and not opts.get('all'):
                     skip[fn] = True
                     if copy:
                         skip[copy] = True
         del matches[rev]
         del revfiles[rev]
 
     return not found
 
 @command('heads',
     [('r', 'rev', '',
      _('show only heads which are descendants of STARTREV'), _('STARTREV')),
     ('t', 'topo', False, _('show topological heads only')),
     ('a', 'active', False, _('show active branchheads only (DEPRECATED)')),
     ('c', 'closed', False, _('show normal and closed branch heads')),
     ] + templateopts,
     _('[-ct] [-r STARTREV] [REV]...'))
 def heads(ui, repo, *branchrevs, **opts):
     """show current repository heads or show branch heads
 
     With no arguments, show all repository branch heads.
 
     Repository "heads" are changesets with no child changesets. They are
     where development generally takes place and are the usual targets
     for update and merge operations. Branch heads are changesets that have
     no child changeset on the same branch.
 
     If one or more REVs are given, only branch heads on the branches
     associated with the specified changesets are shown. This means
     that you can use :hg:`heads foo` to see the heads on a branch
     named ``foo``.
 
     If -c/--closed is specified, also show branch heads marked closed
     (see :hg:`commit --close-branch`).
 
     If STARTREV is specified, only those heads that are descendants of
     STARTREV will be displayed.
 
     If -t/--topo is specified, named branch mechanics will be ignored and only
     changesets without children will be shown.
 
     Returns 0 if matching heads are found, 1 if not.
     """
 
     start = None
     if 'rev' in opts:
         start = scmutil.revsingle(repo, opts['rev'], None).node()
 
     if opts.get('topo'):
         heads = [repo[h] for h in repo.heads(start)]
     else:
         heads = []
         for branch in repo.branchmap():
             heads += repo.branchheads(branch, start, opts.get('closed'))
         heads = [repo[h] for h in heads]
 
     if branchrevs:
         branches = set(repo[br].branch() for br in branchrevs)
         heads = [h for h in heads if h.branch() in branches]
 
     if opts.get('active') and branchrevs:
         dagheads = repo.heads(start)
         heads = [h for h in heads if h.node() in dagheads]
 
     if branchrevs:
         haveheads = set(h.branch() for h in heads)
         if branches - haveheads:
             headless = ', '.join(b for b in branches - haveheads)
             msg = _('no open branch heads found on branches %s')
             if opts.get('rev'):
                 msg += _(' (started at %s)') % opts['rev']
             ui.warn((msg + '\n') % headless)
 
     if not heads:
         return 1
 
     heads = sorted(heads, key=lambda x: -x.rev())
     displayer = cmdutil.show_changeset(ui, repo, opts)
     for ctx in heads:
         displayer.show(ctx)
     displayer.close()
 
 @command('help',
     [('e', 'extension', None, _('show only help for extensions')),
      ('c', 'command', None, _('show only help for commands')),
      ('k', 'keyword', '', _('show topics matching keyword')),
      ],
     _('[-ec] [TOPIC]'))
 def help_(ui, name=None, unknowncmd=False, full=True, **opts):
     """show help for a given topic or a help overview
 
     With no arguments, print a list of commands with short help messages.
 
     Given a topic, extension, or command name, print help for that
     topic.
 
     Returns 0 if successful.
     """
 
     textwidth = min(ui.termwidth(), 80) - 2
 
     def helpcmd(name):
         try:
             aliases, entry = cmdutil.findcmd(name, table, strict=unknowncmd)
         except error.AmbiguousCommand, inst:
             # py3k fix: except vars can't be used outside the scope of the
             # except block, nor can be used inside a lambda. python issue4617
             prefix = inst.args[0]
             select = lambda c: c.lstrip('^').startswith(prefix)
             rst = helplist(select)
             return rst
 
         rst = []
 
         # check if it's an invalid alias and display its error if it is
         if getattr(entry[0], 'badalias', False):
             if not unknowncmd:
                 ui.pushbuffer()
                 entry[0](ui)
                 rst.append(ui.popbuffer())
             return rst
 
         # synopsis
         if len(entry) > 2:
             if entry[2].startswith('hg'):
                 rst.append("%s\n" % entry[2])
             else:
                 rst.append('hg %s %s\n' % (aliases[0], entry[2]))
         else:
             rst.append('hg %s\n' % aliases[0])
         # aliases
         if full and not ui.quiet and len(aliases) > 1:
             rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:]))
         rst.append('\n')
 
         # description
         doc = gettext(entry[0].__doc__)
         if not doc:
             doc = _("(no help text available)")
         if util.safehasattr(entry[0], 'definition'):  # aliased command
             if entry[0].definition.startswith('!'):  # shell alias
                 doc = _('shell alias for::\n\n    %s') % entry[0].definition[1:]
             else:
                 doc = _('alias for: hg %s\n\n%s') % (entry[0].definition, doc)
         doc = doc.splitlines(True)
         if ui.quiet or not full:
             rst.append(doc[0])
         else:
             rst.extend(doc)
         rst.append('\n')
 
         # check if this command shadows a non-trivial (multi-line)
         # extension help text
         try:
             mod = extensions.find(name)
             doc = gettext(mod.__doc__) or ''
             if '\n' in doc.strip():
                 msg = _('use "hg help -e %s" to show help for '
                         'the %s extension') % (name, name)
                 rst.append('\n%s\n' % msg)
         except KeyError:
             pass
 
         # options
         if not ui.quiet and entry[1]:
             rst.append('\n%s\n\n' % _("options:"))
             rst.append(help.optrst(entry[1], ui.verbose))
 
         if ui.verbose:
             rst.append('\n%s\n\n' % _("global options:"))
             rst.append(help.optrst(globalopts, ui.verbose))
 
         if not ui.verbose:
             if not full:
                 rst.append(_('\nuse "hg help %s" to show the full help text\n')
                            % name)
             elif not ui.quiet:
                 rst.append(_('\nuse "hg -v help %s" to show more info\n')
                            % name)
         return rst
 
 
     def helplist(select=None):
         # list of commands
         if name == "shortlist":
             header = _('basic commands:\n\n')
         else:
             header = _('list of commands:\n\n')
 
         h = {}
         cmds = {}
         for c, e in table.iteritems():
             f = c.split("|", 1)[0]
             if select and not select(f):
                 continue
             if (not select and name != 'shortlist' and
                 e[0].__module__ != __name__):
                 continue
             if name == "shortlist" and not f.startswith("^"):
                 continue
             f = f.lstrip("^")
             if not ui.debugflag and f.startswith("debug"):
                 continue
             doc = e[0].__doc__
             if doc and 'DEPRECATED' in doc and not ui.verbose:
                 continue
             doc = gettext(doc)
             if not doc:
                 doc = _("(no help text available)")
             h[f] = doc.splitlines()[0].rstrip()
             cmds[f] = c.lstrip("^")
 
         rst = []
         if not h:
             if not ui.quiet:
                 rst.append(_('no commands defined\n'))
             return rst
 
         if not ui.quiet:
             rst.append(header)
         fns = sorted(h)
         for f in fns:
             if ui.verbose:
                 commands = cmds[f].replace("|",", ")
                 rst.append(" :%s: %s\n" % (commands, h[f]))
             else:
                 rst.append(' :%s: %s\n' % (f, h[f]))
 
         if not name:
             exts = help.listexts(_('enabled extensions:'), extensions.enabled())
             if exts:
                 rst.append('\n')
                 rst.extend(exts)
 
             rst.append(_("\nadditional help topics:\n\n"))
             topics = []
             for names, header, doc in help.helptable:
                 topics.append((names[0], header))
             for t, desc in topics:
                 rst.append(" :%s: %s\n" % (t, desc))
 
         optlist = []
         if not ui.quiet:
             if ui.verbose:
                 optlist.append((_("global options:"), globalopts))
                 if name == 'shortlist':
                     optlist.append((_('use "hg help" for the full list '
                                            'of commands'), ()))
             else:
                 if name == 'shortlist':
                     msg = _('use "hg help" for the full list of commands '
                             'or "hg -v" for details')
                 elif name and not full:
                     msg = _('use "hg help %s" to show the full help '
                             'text') % name
                 else:
                     msg = _('use "hg -v help%s" to show builtin aliases and '
                             'global options') % (name and " " + name or "")
                 optlist.append((msg, ()))
 
         if optlist:
             for title, options in optlist:
                 rst.append('\n%s\n' % title)
                 if options:
                     rst.append('\n%s\n' % help.optrst(options, ui.verbose))
         return rst
 
     def helptopic(name):
         for names, header, doc in help.helptable:
             if name in names:
                 break
         else:
             raise error.UnknownCommand(name)
 
         rst = ["%s\n\n" % header]
         # description
         if not doc:
             rst.append("    %s\n" % _("(no help text available)"))
         if util.safehasattr(doc, '__call__'):
             rst += ["    %s\n" % l for l in doc().splitlines()]
 
         try:
             cmdutil.findcmd(name, table)
             rst.append(_('\nuse "hg help -c %s" to see help for '
                        'the %s command\n') % (name, name))
         except error.UnknownCommand:
             pass
         return rst
 
     def helpext(name):
         try:
             mod = extensions.find(name)
             doc = gettext(mod.__doc__) or _('no help text available')
         except KeyError:
             mod = None
             doc = extensions.disabledext(name)
             if not doc:
                 raise error.UnknownCommand(name)
 
         if '\n' not in doc:
             head, tail = doc, ""
         else:
             head, tail = doc.split('\n', 1)
         rst = [_('%s extension - %s\n\n') % (name.split('.')[-1], head)]
         if tail:
             rst.extend(tail.splitlines(True))
             rst.append('\n')
 
         if mod:
             try:
                 ct = mod.cmdtable
             except AttributeError:
                 ct = {}
             modcmds = set([c.split('|', 1)[0] for c in ct])
             rst.extend(helplist(modcmds.__contains__))
         else:
             rst.append(_('use "hg help extensions" for information on enabling '
                        'extensions\n'))
         return rst
 
     def helpextcmd(name):
         cmd, ext, mod = extensions.disabledcmd(ui, name,
                                                ui.configbool('ui', 'strict'))
         doc = gettext(mod.__doc__).splitlines()[0]
 
         rst = help.listexts(_("'%s' is provided by the following "
                               "extension:") % cmd, {ext: doc}, indent=4)
         rst.append('\n')
         rst.append(_('use "hg help extensions" for information on enabling '
                    'extensions\n'))
         return rst
 
 
     rst = []
     kw = opts.get('keyword')
     if kw:
         matches = help.topicmatch(kw)
         for t, title in (('topics', _('Topics')),
                          ('commands', _('Commands')),
                          ('extensions', _('Extensions')),
                          ('extensioncommands', _('Extension Commands'))):
             if matches[t]:
                 rst.append('%s:\n\n' % title)
                 rst.extend(minirst.maketable(sorted(matches[t]), 1))
                 rst.append('\n')
     elif name and name != 'shortlist':
         i = None
         if unknowncmd:
             queries = (helpextcmd,)
         elif opts.get('extension'):
             queries = (helpext,)
         elif opts.get('command'):
             queries = (helpcmd,)
         else:
             queries = (helptopic, helpcmd, helpext, helpextcmd)
         for f in queries:
             try:
                 rst = f(name)
                 i = None
                 break
             except error.UnknownCommand, inst:
                 i = inst
         if i:
             raise i
     else:
         # program name
         if not ui.quiet:
             rst = [_("Mercurial Distributed SCM\n"), '\n']
         rst.extend(helplist())
 
     keep = ui.verbose and ['verbose'] or []
     formatted, pruned = minirst.format(''.join(rst), textwidth, keep=keep)
     ui.write(formatted)
 
 
 @command('identify|id',
     [('r', 'rev', '',
      _('identify the specified revision'), _('REV')),
     ('n', 'num', None, _('show local revision number')),
     ('i', 'id', None, _('show global revision id')),
     ('b', 'branch', None, _('show branch')),
     ('t', 'tags', None, _('show tags')),
     ('B', 'bookmarks', None, _('show bookmarks')),
     ] + remoteopts,
     _('[-nibtB] [-r REV] [SOURCE]'))
 def identify(ui, repo, source=None, rev=None,
              num=None, id=None, branch=None, tags=None, bookmarks=None, **opts):
     """identify the working copy or specified revision
 
     Print a summary identifying the repository state at REV using one or
     two parent hash identifiers, followed by a "+" if the working
     directory has uncommitted changes, the branch name (if not default),
     a list of tags, and a list of bookmarks.
 
     When REV is not given, print a summary of the current state of the
     repository.
 
     Specifying a path to a repository root or Mercurial bundle will
     cause lookup to operate on that repository/bundle.
 
     .. container:: verbose
 
       Examples:
 
       - generate a build identifier for the working directory::
 
           hg id --id > build-id.dat
 
       - find the revision corresponding to a tag::
 
           hg id -n -r 1.3
 
       - check the most recent revision of a remote repository::
 
           hg id -r tip http://selenic.com/hg/
 
     Returns 0 if successful.
     """
 
     if not repo and not source:
         raise util.Abort(_("there is no Mercurial repository here "
                            "(.hg not found)"))
 
     hexfunc = ui.debugflag and hex or short
     default = not (num or id or branch or tags or bookmarks)
     output = []
     revs = []
 
     if source:
         source, branches = hg.parseurl(ui.expandpath(source))
         peer = hg.peer(ui, opts, source)
         repo = peer.local()
         revs, checkout = hg.addbranchrevs(repo, peer, branches, None)
 
     if not repo:
         if num or branch or tags:
             raise util.Abort(
                 _("can't query remote revision number, branch, or tags"))
         if not rev and revs:
             rev = revs[0]
         if not rev:
             rev = "tip"
 
         remoterev = peer.lookup(rev)
         if default or id:
             output = [hexfunc(remoterev)]
 
         def getbms():
             bms = []
 
             if 'bookmarks' in peer.listkeys('namespaces'):
                 hexremoterev = hex(remoterev)
                 bms = [bm for bm, bmr in peer.listkeys('bookmarks').iteritems()
                        if bmr == hexremoterev]
 
             return bms
 
         if bookmarks:
             output.extend(getbms())
         elif default and not ui.quiet:
             # multiple bookmarks for a single parent separated by '/'
             bm = '/'.join(getbms())
             if bm:
                 output.append(bm)
     else:
         if not rev:
             ctx = repo[None]
             parents = ctx.parents()
             changed = ""
             if default or id or num:
                 if (util.any(repo.status())
                     or util.any(ctx.sub(s).dirty() for s in ctx.substate)):
                     changed = '+'
             if default or id:
                 output = ["%s%s" %
                   ('+'.join([hexfunc(p.node()) for p in parents]), changed)]
             if num:
                 output.append("%s%s" %
                   ('+'.join([str(p.rev()) for p in parents]), changed))
         else:
             ctx = scmutil.revsingle(repo, rev)
             if default or id:
                 output = [hexfunc(ctx.node())]
             if num:
                 output.append(str(ctx.rev()))
 
         if default and not ui.quiet:
             b = ctx.branch()
             if b != 'default':
                 output.append("(%s)" % b)
 
             # multiple tags for a single parent separated by '/'
             t = '/'.join(ctx.tags())
             if t:
                 output.append(t)
 
             # multiple bookmarks for a single parent separated by '/'
             bm = '/'.join(ctx.bookmarks())
             if bm:
                 output.append(bm)
         else:
             if branch:
                 output.append(ctx.branch())
 
             if tags:
                 output.extend(ctx.tags())
 
             if bookmarks:
                 output.extend(ctx.bookmarks())
 
     ui.write("%s\n" % ' '.join(output))
 
 @command('import|patch',
     [('p', 'strip', 1,
      _('directory strip option for patch. This has the same '
        'meaning as the corresponding patch option'), _('NUM')),
     ('b', 'base', '', _('base path (DEPRECATED)'), _('PATH')),
     ('e', 'edit', False, _('invoke editor on commit messages')),
     ('f', 'force', None, _('skip check for outstanding uncommitted changes')),
     ('', 'no-commit', None,
      _("don't commit, just update the working directory")),
     ('', 'bypass', None,
      _("apply patch without touching the working directory")),
     ('', 'exact', None,
      _('apply patch to the nodes from which it was generated')),
     ('', 'import-branch', None,
      _('use any branch information in patch (implied by --exact)'))] +
     commitopts + commitopts2 + similarityopts,
     _('[OPTION]... PATCH...'))
 def import_(ui, repo, patch1=None, *patches, **opts):
     """import an ordered set of patches
 
     Import a list of patches and commit them individually (unless
     --no-commit is specified).
 
     If there are outstanding changes in the working directory, import
     will abort unless given the -f/--force flag.
 
     You can import a patch straight from a mail message. Even patches
     as attachments work (to use the body part, it must have type
     text/plain or text/x-patch). From and Subject headers of email
     message are used as default committer and commit message. All
     text/plain body parts before first diff are added to commit
     message.
 
     If the imported patch was generated by :hg:`export`, user and
     description from patch override values from message headers and
     body. Values given on command line with -m/--message and -u/--user
     override these.
 
     If --exact is specified, import will set the working directory to
     the parent of each patch before applying it, and will abort if the
     resulting changeset has a different ID than the one recorded in
     the patch. This may happen due to character set problems or other
     deficiencies in the text patch format.
 
     Use --bypass to apply and commit patches directly to the
     repository, not touching the working directory. Without --exact,
     patches will be applied on top of the working directory parent
     revision.
 
     With -s/--similarity, hg will attempt to discover renames and
     copies in the patch in the same way as :hg:`addremove`.
 
     To read a patch from standard input, use "-" as the patch name. If
     a URL is specified, the patch will be downloaded from it.
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     .. container:: verbose
 
       Examples:
 
       - import a traditional patch from a website and detect renames::
 
           hg import -s 80 http://example.com/bugfix.patch
 
       - import a changeset from an hgweb server::
 
           hg import http://www.selenic.com/hg/rev/5ca8c111e9aa
 
       - import all the patches in an Unix-style mbox::
 
           hg import incoming-patches.mbox
 
       - attempt to exactly restore an exported changeset (not always
         possible)::
 
           hg import --exact proposed-fix.patch
 
     Returns 0 on success.
     """
 
     if not patch1:
         raise util.Abort(_('need at least one patch to import'))
 
     patches = (patch1,) + patches
 
     date = opts.get('date')
     if date:
         opts['date'] = util.parsedate(date)
 
     editor = cmdutil.commiteditor
     if opts.get('edit'):
         editor = cmdutil.commitforceeditor
 
     update = not opts.get('bypass')
     if not update and opts.get('no_commit'):
         raise util.Abort(_('cannot use --no-commit with --bypass'))
     try:
         sim = float(opts.get('similarity') or 0)
     except ValueError:
         raise util.Abort(_('similarity must be a number'))
     if sim < 0 or sim > 100:
         raise util.Abort(_('similarity must be between 0 and 100'))
     if sim and not update:
         raise util.Abort(_('cannot use --similarity with --bypass'))
 
     if (opts.get('exact') or not opts.get('force')) and update:
         cmdutil.bailifchanged(repo)
 
     base = opts["base"]
     strip = opts["strip"]
     wlock = lock = tr = None
     msgs = []
 
     def checkexact(repo, n, nodeid):
         if opts.get('exact') and hex(n) != nodeid:
             repo.rollback()
             raise util.Abort(_('patch is damaged or loses information'))
 
     def tryone(ui, hunk, parents):
         tmpname, message, user, date, branch, nodeid, p1, p2 = \
             patch.extract(ui, hunk)
 
         if not tmpname:
             return (None, None)
         msg = _('applied to working directory')
 
         try:
             cmdline_message = cmdutil.logmessage(ui, opts)
             if cmdline_message:
                 # pickup the cmdline msg
                 message = cmdline_message
             elif message:
                 # pickup the patch msg
                 message = message.strip()
             else:
                 # launch the editor
                 message = None
             ui.debug('message:\n%s\n' % message)
 
             if len(parents) == 1:
                 parents.append(repo[nullid])
             if opts.get('exact'):
                 if not nodeid or not p1:
                     raise util.Abort(_('not a Mercurial patch'))
                 p1 = repo[p1]
                 p2 = repo[p2 or nullid]
             elif p2:
                 try:
                     p1 = repo[p1]
                     p2 = repo[p2]
                     # Without any options, consider p2 only if the
                     # patch is being applied on top of the recorded
                     # first parent.
                     if p1 != parents[0]:
                         p1 = parents[0]
                         p2 = repo[nullid]
                 except error.RepoError:
                     p1, p2 = parents
             else:
                 p1, p2 = parents
 
             n = None
             if update:
                 if p1 != parents[0]:
                     hg.clean(repo, p1.node())
                 if p2 != parents[1]:
                     repo.setparents(p1.node(), p2.node())
 
                 if opts.get('exact') or opts.get('import_branch'):
                     repo.dirstate.setbranch(branch or 'default')
 
                 files = set()
                 patch.patch(ui, repo, tmpname, strip=strip, files=files,
                             eolmode=None, similarity=sim / 100.0)
                 files = list(files)
                 if opts.get('no_commit'):
                     if message:
                         msgs.append(message)
                 else:
                     if opts.get('exact') or p2:
                         # If you got here, you either use --force and know what
                         # you are doing or used --exact or a merge patch while
                         # being updated to its first parent.
                         m = None
                     else:
                         m = scmutil.matchfiles(repo, files or [])
                     n = repo.commit(message, opts.get('user') or user,
                                     opts.get('date') or date, match=m,
                                     editor=editor)
                     checkexact(repo, n, nodeid)
             else:
                 if opts.get('exact') or opts.get('import_branch'):
                     branch = branch or 'default'
                 else:
                     branch = p1.branch()
                 store = patch.filestore()
                 try:
                     files = set()
                     try:
                         patch.patchrepo(ui, repo, p1, store, tmpname, strip,
                                         files, eolmode=None)
                     except patch.PatchError, e:
                         raise util.Abort(str(e))
                     memctx = patch.makememctx(repo, (p1.node(), p2.node()),
                                               message,
                                               opts.get('user') or user,
                                               opts.get('date') or date,
                                               branch, files, store,
                                               editor=cmdutil.commiteditor)
                     repo.savecommitmessage(memctx.description())
                     n = memctx.commit()
                     checkexact(repo, n, nodeid)
                 finally:
                     store.close()
             if n:
                 # i18n: refers to a short changeset id
                 msg = _('created %s') % short(n)
             return (msg, n)
         finally:
             os.unlink(tmpname)
 
     try:
         try:
             wlock = repo.wlock()
             if not opts.get('no_commit'):
                 lock = repo.lock()
                 tr = repo.transaction('import')
             parents = repo.parents()
             for patchurl in patches:
                 if patchurl == '-':
                     ui.status(_('applying patch from stdin\n'))
                     patchfile = ui.fin
                     patchurl = 'stdin'      # for error message
                 else:
                     patchurl = os.path.join(base, patchurl)
                     ui.status(_('applying %s\n') % patchurl)
                     patchfile = url.open(ui, patchurl)
 
                 haspatch = False
                 for hunk in patch.split(patchfile):
                     (msg, node) = tryone(ui, hunk, parents)
                     if msg:
                         haspatch = True
                         ui.note(msg + '\n')
                     if update or opts.get('exact'):
                         parents = repo.parents()
                     else:
                         parents = [repo[node]]
 
                 if not haspatch:
                     raise util.Abort(_('%s: no diffs found') % patchurl)
 
             if tr:
                 tr.close()
             if msgs:
                 repo.savecommitmessage('\n* * *\n'.join(msgs))
         except: # re-raises
             # wlock.release() indirectly calls dirstate.write(): since
             # we're crashing, we do not want to change the working dir
             # parent after all, so make sure it writes nothing
             repo.dirstate.invalidate()
             raise
     finally:
         if tr:
             tr.release()
         release(lock, wlock)
 
 @command('incoming|in',
     [('f', 'force', None,
      _('run even if remote repository is unrelated')),
     ('n', 'newest-first', None, _('show newest record first')),
     ('', 'bundle', '',
      _('file to store the bundles into'), _('FILE')),
     ('r', 'rev', [], _('a remote changeset intended to be added'), _('REV')),
     ('B', 'bookmarks', False, _("compare bookmarks")),
     ('b', 'branch', [],
      _('a specific branch you would like to pull'), _('BRANCH')),
     ] + logopts + remoteopts + subrepoopts,
     _('[-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]'))
 def incoming(ui, repo, source="default", **opts):
     """show new changesets found in source
 
     Show new changesets found in the specified path/URL or the default
     pull location. These are the changesets that would have been pulled
     if a pull at the time you issued this command.
 
     For remote repository, using --bundle avoids downloading the
     changesets twice if the incoming is followed by a pull.
 
     See pull for valid source format details.
 
     Returns 0 if there are incoming changes, 1 otherwise.
     """
     if opts.get('graph'):
         cmdutil.checkunsupportedgraphflags([], opts)
         def display(other, chlist, displayer):
             revdag = cmdutil.graphrevs(other, chlist, opts)
             showparents = [ctx.node() for ctx in repo[None].parents()]
             cmdutil.displaygraph(ui, revdag, displayer, showparents,
                                  graphmod.asciiedges)
 
         hg._incoming(display, lambda: 1, ui, repo, source, opts, buffered=True)
         return 0
 
     if opts.get('bundle') and opts.get('subrepos'):
         raise util.Abort(_('cannot combine --bundle and --subrepos'))
 
     if opts.get('bookmarks'):
         source, branches = hg.parseurl(ui.expandpath(source),
                                        opts.get('branch'))
         other = hg.peer(repo, opts, source)
         if 'bookmarks' not in other.listkeys('namespaces'):
             ui.warn(_("remote doesn't support bookmarks\n"))
             return 0
         ui.status(_('comparing with %s\n') % util.hidepassword(source))
         return bookmarks.diff(ui, repo, other)
 
     repo._subtoppath = ui.expandpath(source)
     try:
         return hg.incoming(ui, repo, source, opts)
     finally:
         del repo._subtoppath
 
 
 @command('^init', remoteopts, _('[-e CMD] [--remotecmd CMD] [DEST]'))
 def init(ui, dest=".", **opts):
     """create a new repository in the given directory
 
     Initialize a new repository in the given directory. If the given
     directory does not exist, it will be created.
 
     If no directory is given, the current directory is used.
 
     It is possible to specify an ``ssh://`` URL as the destination.
     See :hg:`help urls` for more information.
 
     Returns 0 on success.
     """
     hg.peer(ui, opts, ui.expandpath(dest), create=True)
 
 @command('locate',
     [('r', 'rev', '', _('search the repository as it is in REV'), _('REV')),
     ('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
     ('f', 'fullpath', None, _('print complete paths from the filesystem root')),
     ] + walkopts,
     _('[OPTION]... [PATTERN]...'))
 def locate(ui, repo, *pats, **opts):
     """locate files matching specific patterns
 
     Print files under Mercurial control in the working directory whose
     names match the given patterns.
 
     By default, this command searches all directories in the working
     directory. To search just the current directory and its
     subdirectories, use "--include .".
 
     If no patterns are given to match, this command prints the names
     of all files under Mercurial control in the working directory.
 
     If you want to feed the output of this command into the "xargs"
     command, use the -0 option to both this command and "xargs". This
     will avoid the problem of "xargs" treating single filenames that
     contain whitespace as multiple filenames.
 
     Returns 0 if a match is found, 1 otherwise.
     """
     end = opts.get('print0') and '\0' or '\n'
     rev = scmutil.revsingle(repo, opts.get('rev'), None).node()
 
     ret = 1
     m = scmutil.match(repo[rev], pats, opts, default='relglob')
     m.bad = lambda x, y: False
     for abs in repo[rev].walk(m):
         if not rev and abs not in repo.dirstate:
             continue
         if opts.get('fullpath'):
             ui.write(repo.wjoin(abs), end)
         else:
             ui.write(((pats and m.rel(abs)) or abs), end)
         ret = 0
 
     return ret
 
 @command('^log|history',
     [('f', 'follow', None,
      _('follow changeset history, or file history across copies and renames')),
     ('', 'follow-first', None,
      _('only follow the first parent of merge changesets (DEPRECATED)')),
     ('d', 'date', '', _('show revisions matching date spec'), _('DATE')),
     ('C', 'copies', None, _('show copied files')),
     ('k', 'keyword', [],
      _('do case-insensitive search for a given text'), _('TEXT')),
     ('r', 'rev', [], _('show the specified revision or range'), _('REV')),
     ('', 'removed', None, _('include revisions where files were removed')),
     ('m', 'only-merges', None, _('show only merges (DEPRECATED)')),
     ('u', 'user', [], _('revisions committed by user'), _('USER')),
     ('', 'only-branch', [],
      _('show only changesets within the given named branch (DEPRECATED)'),
      _('BRANCH')),
     ('b', 'branch', [],
      _('show changesets within the given named branch'), _('BRANCH')),
     ('P', 'prune', [],
      _('do not display revision or any of its ancestors'), _('REV')),
     ('', 'hidden', False, _('show hidden changesets (DEPRECATED)')),
     ] + logopts + walkopts,
     _('[OPTION]... [FILE]'))
 def log(ui, repo, *pats, **opts):
     """show revision history of entire repository or files
 
     Print the revision history of the specified files or the entire
     project.
 
     If no revision range is specified, the default is ``tip:0`` unless
     --follow is set, in which case the working directory parent is
     used as the starting revision.
 
     File history is shown without following rename or copy history of
     files. Use -f/--follow with a filename to follow history across
     renames and copies. --follow without a filename will only show
     ancestors or descendants of the starting revision.
 
     By default this command prints revision number and changeset id,
     tags, non-trivial parents, user, date and time, and a summary for
     each commit. When the -v/--verbose switch is used, the list of
     changed files and full commit message are shown.
 
     .. note::
        log -p/--patch may generate unexpected diff output for merge
        changesets, as it will only compare the merge changeset against
        its first parent. Also, only files different from BOTH parents
        will appear in files:.
 
     .. note::
        for performance reasons, log FILE may omit duplicate changes
        made on branches and will not show deletions. To see all
        changes including duplicates and deletions, use the --removed
        switch.
 
     .. container:: verbose
 
       Some examples:
 
       - changesets with full descriptions and file lists::
 
           hg log -v
 
       - changesets ancestral to the working directory::
 
           hg log -f
 
       - last 10 commits on the current branch::
 
           hg log -l 10 -b .
 
       - changesets showing all modifications of a file, including removals::
 
           hg log --removed file.c
 
       - all changesets that touch a directory, with diffs, excluding merges::
 
           hg log -Mp lib/
 
       - all revision numbers that match a keyword::
 
           hg log -k bug --template "{rev}\\n"
 
       - check if a given changeset is included is a tagged release::
 
           hg log -r "a21ccf and ancestor(1.9)"
 
       - find all changesets by some user in a date range::
 
           hg log -k alice -d "may 2008 to jul 2008"
 
       - summary of all changesets after the last tag::
 
           hg log -r "last(tagged())::" --template "{desc|firstline}\\n"
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     See :hg:`help revisions` and :hg:`help revsets` for more about
     specifying revisions.
 
     See :hg:`help templates` for more about pre-packaged styles and
     specifying custom templates.
 
     Returns 0 on success.
     """
     if opts.get('graph'):
         return cmdutil.graphlog(ui, repo, *pats, **opts)
 
     matchfn = scmutil.match(repo[None], pats, opts)
     limit = cmdutil.loglimit(opts)
     count = 0
 
     getrenamed, endrev = None, None
     if opts.get('copies'):
         if opts.get('rev'):
             endrev = max(scmutil.revrange(repo, opts.get('rev'))) + 1
         getrenamed = templatekw.getrenamedfn(repo, endrev=endrev)
 
     df = False
     if opts.get("date"):
         df = util.matchdate(opts["date"])
 
     branches = opts.get('branch', []) + opts.get('only_branch', [])
     opts['branch'] = [repo.lookupbranch(b) for b in branches]
 
     displayer = cmdutil.show_changeset(ui, repo, opts, True)
     def prep(ctx, fns):
         rev = ctx.rev()
         parents = [p for p in repo.changelog.parentrevs(rev)
                    if p != nullrev]
         if opts.get('no_merges') and len(parents) == 2:
             return
         if opts.get('only_merges') and len(parents) != 2:
             return
         if opts.get('branch') and ctx.branch() not in opts['branch']:
             return
         if not opts.get('hidden') and ctx.hidden():
             return
         if df and not df(ctx.date()[0]):
             return
 
         lower = encoding.lower
         if opts.get('user'):
             luser = lower(ctx.user())
             for k in [lower(x) for x in opts['user']]:
                 if (k in luser):
                     break
             else:
                 return
         if opts.get('keyword'):
             luser = lower(ctx.user())
             ldesc = lower(ctx.description())
             lfiles = lower(" ".join(ctx.files()))
             for k in [lower(x) for x in opts['keyword']]:
                 if (k in luser or k in ldesc or k in lfiles):
                     break
             else:
                 return
 
         copies = None
         if getrenamed is not None and rev:
             copies = []
             for fn in ctx.files():
                 rename = getrenamed(fn, rev)
                 if rename:
                     copies.append((fn, rename[0]))
 
         revmatchfn = None
         if opts.get('patch') or opts.get('stat'):
             if opts.get('follow') or opts.get('follow_first'):
                 # note: this might be wrong when following through merges
                 revmatchfn = scmutil.match(repo[None], fns, default='path')
             else:
                 revmatchfn = matchfn
 
         displayer.show(ctx, copies=copies, matchfn=revmatchfn)
 
     for ctx in cmdutil.walkchangerevs(repo, matchfn, opts, prep):
         if count == limit:
             break
         if displayer.flush(ctx.rev()):
             count += 1
     displayer.close()
 
 @command('manifest',
     [('r', 'rev', '', _('revision to display'), _('REV')),
      ('', 'all', False, _("list files from all revisions"))],
     _('[-r REV]'))
 def manifest(ui, repo, node=None, rev=None, **opts):
     """output the current or given revision of the project manifest
 
     Print a list of version controlled files for the given revision.
     If no revision is given, the first parent of the working directory
     is used, or the null revision if no revision is checked out.
 
     With -v, print file permissions, symlink and executable bits.
     With --debug, print file revision hashes.
 
     If option --all is specified, the list of all files from all revisions
     is printed. This includes deleted and renamed files.
 
     Returns 0 on success.
     """
     if opts.get('all'):
         if rev or node:
             raise util.Abort(_("can't specify a revision with --all"))
 
         res = []
         prefix = "data/"
         suffix = ".i"
         plen = len(prefix)
         slen = len(suffix)
         lock = repo.lock()
         try:
             for fn, b, size in repo.store.datafiles():
                 if size != 0 and fn[-slen:] == suffix and fn[:plen] == prefix:
                     res.append(fn[plen:-slen])
         finally:
             lock.release()
         for f in res:
             ui.write("%s\n" % f)
         return
 
     if rev and node:
         raise util.Abort(_("please specify just one revision"))
 
     if not node:
         node = rev
 
     decor = {'l':'644 @ ', 'x':'755 * ', '':'644   '}
     ctx = scmutil.revsingle(repo, node)
     for f in ctx:
         if ui.debugflag:
             ui.write("%40s " % hex(ctx.manifest()[f]))
         if ui.verbose:
             ui.write(decor[ctx.flags(f)])
         ui.write("%s\n" % f)
 
 @command('^merge',
     [('f', 'force', None, _('force a merge with outstanding changes')),
     ('r', 'rev', '', _('revision to merge'), _('REV')),
     ('P', 'preview', None,
      _('review revisions to merge (no merge is performed)'))
      ] + mergetoolopts,
     _('[-P] [-f] [[-r] REV]'))
 def merge(ui, repo, node=None, **opts):
     """merge working directory with another revision
 
     The current working directory is updated with all changes made in
     the requested revision since the last common predecessor revision.
 
     Files that changed between either parent are marked as changed for
     the next commit and a commit must be performed before any further
     updates to the repository are allowed. The next commit will have
     two parents.
 
     ``--tool`` can be used to specify the merge tool used for file
     merges. It overrides the HGMERGE environment variable and your
     configuration files. See :hg:`help merge-tools` for options.
 
     If no revision is specified, the working directory's parent is a
     head revision, and the current branch contains exactly one other
     head, the other head is merged with by default. Otherwise, an
     explicit revision with which to merge with must be provided.
 
     :hg:`resolve` must be used to resolve unresolved files.
 
     To undo an uncommitted merge, use :hg:`update --clean .` which
     will check out a clean copy of the original merge parent, losing
     all changes.
 
     Returns 0 on success, 1 if there are unresolved files.
     """
 
     if opts.get('rev') and node:
         raise util.Abort(_("please specify just one revision"))
     if not node:
         node = opts.get('rev')
 
     if node:
         node = scmutil.revsingle(repo, node).node()
 
     if not node and repo._bookmarkcurrent:
         bmheads = repo.bookmarkheads(repo._bookmarkcurrent)
         curhead = repo[repo._bookmarkcurrent]
         if len(bmheads) == 2:
             if curhead == bmheads[0]:
                 node = bmheads[1]
             else:
                 node = bmheads[0]
         elif len(bmheads) > 2:
             raise util.Abort(_("multiple matching bookmarks to merge - "
                 "please merge with an explicit rev or bookmark"),
                 hint=_("run 'hg heads' to see all heads"))
         elif len(bmheads) <= 1:
             raise util.Abort(_("no matching bookmark to merge - "
                 "please merge with an explicit rev or bookmark"),
                 hint=_("run 'hg heads' to see all heads"))
 
     if not node and not repo._bookmarkcurrent:
         branch = repo[None].branch()
         bheads = repo.branchheads(branch)
         nbhs = [bh for bh in bheads if not repo[bh].bookmarks()]
 
         if len(nbhs) > 2:
             raise util.Abort(_("branch '%s' has %d heads - "
                                "please merge with an explicit rev")
                              % (branch, len(bheads)),
                              hint=_("run 'hg heads .' to see heads"))
 
         parent = repo.dirstate.p1()
         if len(nbhs) <= 1:
             if len(bheads) > 1:
                 raise util.Abort(_("heads are bookmarked - "
                                    "please merge with an explicit rev"),
                                  hint=_("run 'hg heads' to see all heads"))
             if len(repo.heads()) > 1:
                 raise util.Abort(_("branch '%s' has one head - "
                                    "please merge with an explicit rev")
                                  % branch,
                                  hint=_("run 'hg heads' to see all heads"))
             msg, hint = _('nothing to merge'), None
             if parent != repo.lookup(branch):
                 hint = _("use 'hg update' instead")
             raise util.Abort(msg, hint=hint)
 
         if parent not in bheads:
             raise util.Abort(_('working directory not at a head revision'),
                              hint=_("use 'hg update' or merge with an "
                                     "explicit revision"))
         if parent == nbhs[0]:
             node = nbhs[-1]
         else:
             node = nbhs[0]
 
     if opts.get('preview'):
         # find nodes that are ancestors of p2 but not of p1
         p1 = repo.lookup('.')
         p2 = repo.lookup(node)
         nodes = repo.changelog.findmissing(common=[p1], heads=[p2])
 
         displayer = cmdutil.show_changeset(ui, repo, opts)
         for node in nodes:
             displayer.show(repo[node])
         displayer.close()
         return 0
 
     try:
         # ui.forcemerge is an internal variable, do not document
         repo.ui.setconfig('ui', 'forcemerge', opts.get('tool', ''))
         return hg.merge(repo, node, force=opts.get('force'))
     finally:
         ui.setconfig('ui', 'forcemerge', '')
 
 @command('outgoing|out',
     [('f', 'force', None, _('run even when the destination is unrelated')),
     ('r', 'rev', [],
      _('a changeset intended to be included in the destination'), _('REV')),
     ('n', 'newest-first', None, _('show newest record first')),
     ('B', 'bookmarks', False, _('compare bookmarks')),
     ('b', 'branch', [], _('a specific branch you would like to push'),
      _('BRANCH')),
     ] + logopts + remoteopts + subrepoopts,
     _('[-M] [-p] [-n] [-f] [-r REV]... [DEST]'))
 def outgoing(ui, repo, dest=None, **opts):
     """show changesets not found in the destination
 
     Show changesets not found in the specified destination repository
     or the default push location. These are the changesets that would
     be pushed if a push was requested.
 
     See pull for details of valid destination formats.
 
     Returns 0 if there are outgoing changes, 1 otherwise.
     """
     if opts.get('graph'):
         cmdutil.checkunsupportedgraphflags([], opts)
         o = hg._outgoing(ui, repo, dest, opts)
         if o is None:
             return
 
         revdag = cmdutil.graphrevs(repo, o, opts)
         displayer = cmdutil.show_changeset(ui, repo, opts, buffered=True)
         showparents = [ctx.node() for ctx in repo[None].parents()]
         cmdutil.displaygraph(ui, revdag, displayer, showparents,
                              graphmod.asciiedges)
         return 0
 
     if opts.get('bookmarks'):
         dest = ui.expandpath(dest or 'default-push', dest or 'default')
         dest, branches = hg.parseurl(dest, opts.get('branch'))
         other = hg.peer(repo, opts, dest)
         if 'bookmarks' not in other.listkeys('namespaces'):
             ui.warn(_("remote doesn't support bookmarks\n"))
             return 0
         ui.status(_('comparing with %s\n') % util.hidepassword(dest))
         return bookmarks.diff(ui, other, repo)
 
     repo._subtoppath = ui.expandpath(dest or 'default-push', dest or 'default')
     try:
         return hg.outgoing(ui, repo, dest, opts)
     finally:
         del repo._subtoppath
 
 @command('parents',
     [('r', 'rev', '', _('show parents of the specified revision'), _('REV')),
     ] + templateopts,
     _('[-r REV] [FILE]'))
 def parents(ui, repo, file_=None, **opts):
     """show the parents of the working directory or revision
 
     Print the working directory's parent revisions. If a revision is
     given via -r/--rev, the parent of that revision will be printed.
     If a file argument is given, the revision in which the file was
     last changed (before the working directory revision or the
     argument to --rev if given) is printed.
 
     Returns 0 on success.
     """
 
     ctx = scmutil.revsingle(repo, opts.get('rev'), None)
 
     if file_:
         m = scmutil.match(ctx, (file_,), opts)
         if m.anypats() or len(m.files()) != 1:
             raise util.Abort(_('can only specify an explicit filename'))
         file_ = m.files()[0]
         filenodes = []
         for cp in ctx.parents():
             if not cp:
                 continue
             try:
                 filenodes.append(cp.filenode(file_))
             except error.LookupError:
                 pass
         if not filenodes:
             raise util.Abort(_("'%s' not found in manifest!") % file_)
         fl = repo.file(file_)
         p = [repo.lookup(fl.linkrev(fl.rev(fn))) for fn in filenodes]
     else:
         p = [cp.node() for cp in ctx.parents()]
 
     displayer = cmdutil.show_changeset(ui, repo, opts)
     for n in p:
         if n != nullid:
             displayer.show(repo[n])
     displayer.close()
 
 @command('paths', [], _('[NAME]'))
 def paths(ui, repo, search=None):
     """show aliases for remote repositories
 
     Show definition of symbolic path name NAME. If no name is given,
     show definition of all available names.
 
     Option -q/--quiet suppresses all output when searching for NAME
     and shows only the path names when listing all definitions.
 
     Path names are defined in the [paths] section of your
     configuration file and in ``/etc/mercurial/hgrc``. If run inside a
     repository, ``.hg/hgrc`` is used, too.
 
     The path names ``default`` and ``default-push`` have a special
     meaning.  When performing a push or pull operation, they are used
     as fallbacks if no location is specified on the command-line.
     When ``default-push`` is set, it will be used for push and
     ``default`` will be used for pull; otherwise ``default`` is used
     as the fallback for both.  When cloning a repository, the clone
     source is written as ``default`` in ``.hg/hgrc``.  Note that
     ``default`` and ``default-push`` apply to all inbound (e.g.
     :hg:`incoming`) and outbound (e.g. :hg:`outgoing`, :hg:`email` and
     :hg:`bundle`) operations.
 
     See :hg:`help urls` for more information.
 
     Returns 0 on success.
     """
     if search:
         for name, path in ui.configitems("paths"):
             if name == search:
                 ui.status("%s\n" % util.hidepassword(path))
                 return
         if not ui.quiet:
             ui.warn(_("not found!\n"))
         return 1
     else:
         for name, path in ui.configitems("paths"):
             if ui.quiet:
                 ui.write("%s\n" % name)
             else:
                 ui.write("%s = %s\n" % (name, util.hidepassword(path)))
 
 @command('^phase',
     [('p', 'public', False, _('set changeset phase to public')),
      ('d', 'draft', False, _('set changeset phase to draft')),
      ('s', 'secret', False, _('set changeset phase to secret')),
      ('f', 'force', False, _('allow to move boundary backward')),
      ('r', 'rev', [], _('target revision'), _('REV')),
     ],
     _('[-p|-d|-s] [-f] [-r] REV...'))
 def phase(ui, repo, *revs, **opts):
     """set or show the current phase name
 
     With no argument, show the phase name of specified revisions.
 
     With one of -p/--public, -d/--draft or -s/--secret, change the
     phase value of the specified revisions.
 
     Unless -f/--force is specified, :hg:`phase` won't move changeset from a
     lower phase to an higher phase. Phases are ordered as follows::
 
         public < draft < secret
 
     Return 0 on success, 1 if no phases were changed or some could not
     be changed.
     """
     # search for a unique phase argument
     targetphase = None
     for idx, name in enumerate(phases.phasenames):
         if opts[name]:
             if targetphase is not None:
                 raise util.Abort(_('only one phase can be specified'))
             targetphase = idx
 
     # look for specified revision
     revs = list(revs)
     revs.extend(opts['rev'])
     if not revs:
         raise util.Abort(_('no revisions specified'))
 
     revs = scmutil.revrange(repo, revs)
 
     lock = None
     ret = 0
     if targetphase is None:
         # display
         for r in revs:
             ctx = repo[r]
             ui.write('%i: %s\n' % (ctx.rev(), ctx.phasestr()))
     else:
         lock = repo.lock()
         try:
             # set phase
             if not revs:
                 raise util.Abort(_('empty revision set'))
             nodes = [repo[r].node() for r in revs]
             olddata = repo._phasecache.getphaserevs(repo)[:]
             phases.advanceboundary(repo, targetphase, nodes)
             if opts['force']:
                 phases.retractboundary(repo, targetphase, nodes)
         finally:
             lock.release()
         newdata = repo._phasecache.getphaserevs(repo)
         changes = sum(o != newdata[i] for i, o in enumerate(olddata))
         rejected = [n for n in nodes
                     if newdata[repo[n].rev()] < targetphase]
         if rejected:
             ui.warn(_('cannot move %i changesets to a more permissive '
                       'phase, use --force\n') % len(rejected))
             ret = 1
         if changes:
             msg = _('phase changed for %i changesets\n') % changes
             if ret:
                 ui.status(msg)
             else:
                 ui.note(msg)
         else:
             ui.warn(_('no phases changed\n'))
             ret = 1
     return ret
 
 def postincoming(ui, repo, modheads, optupdate, checkout):
     if modheads == 0:
         return
     if optupdate:
         movemarkfrom = repo['.'].node()
         try:
             ret = hg.update(repo, checkout)
         except util.Abort, inst:
             ui.warn(_("not updating: %s\n") % str(inst))
             return 0
         if not ret and not checkout:
             if bookmarks.update(repo, [movemarkfrom], repo['.'].node()):
                 ui.status(_("updating bookmark %s\n") % repo._bookmarkcurrent)
         return ret
     if modheads > 1:
         currentbranchheads = len(repo.branchheads())
         if currentbranchheads == modheads:
             ui.status(_("(run 'hg heads' to see heads, 'hg merge' to merge)\n"))
         elif currentbranchheads > 1:
             ui.status(_("(run 'hg heads .' to see heads, 'hg merge' to "
                         "merge)\n"))
         else:
             ui.status(_("(run 'hg heads' to see heads)\n"))
     else:
         ui.status(_("(run 'hg update' to get a working copy)\n"))
 
 @command('^pull',
     [('u', 'update', None,
      _('update to new branch head if changesets were pulled')),
     ('f', 'force', None, _('run even when remote repository is unrelated')),
     ('r', 'rev', [], _('a remote changeset intended to be added'), _('REV')),
     ('B', 'bookmark', [], _("bookmark to pull"), _('BOOKMARK')),
     ('b', 'branch', [], _('a specific branch you would like to pull'),
      _('BRANCH')),
     ] + remoteopts,
     _('[-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]'))
 def pull(ui, repo, source="default", **opts):
     """pull changes from the specified source
 
     Pull changes from a remote repository to a local one.
 
     This finds all changes from the repository at the specified path
     or URL and adds them to a local repository (the current one unless
     -R is specified). By default, this does not update the copy of the
     project in the working directory.
 
     Use :hg:`incoming` if you want to see what would have been added
     by a pull at the time you issued this command. If you then decide
     to add those changes to the repository, you should use :hg:`pull
     -r X` where ``X`` is the last changeset listed by :hg:`incoming`.
 
     If SOURCE is omitted, the 'default' path will be used.
     See :hg:`help urls` for more information.
 
     Returns 0 on success, 1 if an update had unresolved files.
     """
     source, branches = hg.parseurl(ui.expandpath(source), opts.get('branch'))
     other = hg.peer(repo, opts, source)
     ui.status(_('pulling from %s\n') % util.hidepassword(source))
     revs, checkout = hg.addbranchrevs(repo, other, branches, opts.get('rev'))
 
     if opts.get('bookmark'):
         if not revs:
             revs = []
         rb = other.listkeys('bookmarks')
         for b in opts['bookmark']:
             if b not in rb:
                 raise util.Abort(_('remote bookmark %s not found!') % b)
             revs.append(rb[b])
 
     if revs:
         try:
             revs = [other.lookup(rev) for rev in revs]
         except error.CapabilityError:
             err = _("other repository doesn't support revision lookup, "
                     "so a rev cannot be specified.")
             raise util.Abort(err)
 
     modheads = repo.pull(other, heads=revs, force=opts.get('force'))
     bookmarks.updatefromremote(ui, repo, other, source)
     if checkout:
         checkout = str(repo.changelog.rev(other.lookup(checkout)))
     repo._subtoppath = source
     try:
         ret = postincoming(ui, repo, modheads, opts.get('update'), checkout)
 
     finally:
         del repo._subtoppath
 
     # update specified bookmarks
     if opts.get('bookmark'):
         for b in opts['bookmark']:
             # explicit pull overrides local bookmark if any
             ui.status(_("importing bookmark %s\n") % b)
             repo._bookmarks[b] = repo[rb[b]].node()
         bookmarks.write(repo)
 
     return ret
 
 @command('^push',
     [('f', 'force', None, _('force push')),
     ('r', 'rev', [],
      _('a changeset intended to be included in the destination'),
      _('REV')),
     ('B', 'bookmark', [], _("bookmark to push"), _('BOOKMARK')),
     ('b', 'branch', [],
      _('a specific branch you would like to push'), _('BRANCH')),
     ('', 'new-branch', False, _('allow pushing a new branch')),
     ] + remoteopts,
     _('[-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]'))
 def push(ui, repo, dest=None, **opts):
     """push changes to the specified destination
 
     Push changesets from the local repository to the specified
     destination.
 
     This operation is symmetrical to pull: it is identical to a pull
     in the destination repository from the current one.
 
     By default, push will not allow creation of new heads at the
     destination, since multiple heads would make it unclear which head
     to use. In this situation, it is recommended to pull and merge
     before pushing.
 
     Use --new-branch if you want to allow push to create a new named
     branch that is not present at the destination. This allows you to
     only create a new branch without forcing other changes.
 
     Use -f/--force to override the default behavior and push all
     changesets on all branches.
 
     If -r/--rev is used, the specified revision and all its ancestors
     will be pushed to the remote repository.
 
     If -B/--bookmark is used, the specified bookmarked revision, its
     ancestors, and the bookmark will be pushed to the remote
     repository.
 
     Please see :hg:`help urls` for important details about ``ssh://``
     URLs. If DESTINATION is omitted, a default path will be used.
 
     Returns 0 if push was successful, 1 if nothing to push.
     """
 
     if opts.get('bookmark'):
         for b in opts['bookmark']:
             # translate -B options to -r so changesets get pushed
             if b in repo._bookmarks:
                 opts.setdefault('rev', []).append(b)
             else:
                 # if we try to push a deleted bookmark, translate it to null
                 # this lets simultaneous -r, -b options continue working
                 opts.setdefault('rev', []).append("null")
 
     dest = ui.expandpath(dest or 'default-push', dest or 'default')
     dest, branches = hg.parseurl(dest, opts.get('branch'))
     ui.status(_('pushing to %s\n') % util.hidepassword(dest))
     revs, checkout = hg.addbranchrevs(repo, repo, branches, opts.get('rev'))
     other = hg.peer(repo, opts, dest)
     if revs:
         revs = [repo.lookup(r) for r in scmutil.revrange(repo, revs)]
 
     repo._subtoppath = dest
     try:
         # push subrepos depth-first for coherent ordering
         c = repo['']
         subs = c.substate # only repos that are committed
         for s in sorted(subs):
             if c.sub(s).push(opts) == 0:
                 return False
     finally:
         del repo._subtoppath
     result = repo.push(other, opts.get('force'), revs=revs,
                        newbranch=opts.get('new_branch'))
 
     result = not result
 
     if opts.get('bookmark'):
         rb = other.listkeys('bookmarks')
         for b in opts['bookmark']:
             # explicit push overrides remote bookmark if any
             if b in repo._bookmarks:
                 ui.status(_("exporting bookmark %s\n") % b)
                 new = repo[b].hex()
             elif b in rb:
                 ui.status(_("deleting remote bookmark %s\n") % b)
                 new = '' # delete
             else:
                 ui.warn(_('bookmark %s does not exist on the local '
                           'or remote repository!\n') % b)
                 return 2
             old = rb.get(b, '')
             r = other.pushkey('bookmarks', b, old, new)
             if not r:
                 ui.warn(_('updating bookmark %s failed!\n') % b)
                 if not result:
                     result = 2
 
     return result
 
 @command('recover', [])
 def recover(ui, repo):
     """roll back an interrupted transaction
 
     Recover from an interrupted commit or pull.
 
     This command tries to fix the repository status after an
     interrupted operation. It should only be necessary when Mercurial
     suggests it.
 
     Returns 0 if successful, 1 if nothing to recover or verify fails.
     """
     if repo.recover():
         return hg.verify(repo)
     return 1
 
 @command('^remove|rm',
     [('A', 'after', None, _('record delete for missing files')),
     ('f', 'force', None,
      _('remove (and delete) file even if added or modified')),
     ] + walkopts,
     _('[OPTION]... FILE...'))
 def remove(ui, repo, *pats, **opts):
     """remove the specified files on the next commit
 
     Schedule the indicated files for removal from the current branch.
 
     This command schedules the files to be removed at the next commit.
     To undo a remove before that, see :hg:`revert`. To undo added
     files, see :hg:`forget`.
 
     .. container:: verbose
 
       -A/--after can be used to remove only files that have already
       been deleted, -f/--force can be used to force deletion, and -Af
       can be used to remove files from the next revision without
       deleting them from the working directory.
 
       The following table details the behavior of remove for different
       file states (columns) and option combinations (rows). The file
       states are Added [A], Clean [C], Modified [M] and Missing [!]
       (as reported by :hg:`status`). The actions are Warn, Remove
       (from branch) and Delete (from disk):
 
       ======= == == == ==
               A  C  M  !
       ======= == == == ==
       none    W  RD W  R
       -f      R  RD RD R
       -A      W  W  W  R
       -Af     R  R  R  R
       ======= == == == ==
 
       Note that remove never deletes files in Added [A] state from the
       working directory, not even if option --force is specified.
 
     Returns 0 on success, 1 if any warnings encountered.
     """
 
     ret = 0
     after, force = opts.get('after'), opts.get('force')
     if not pats and not after:
         raise util.Abort(_('no files specified'))
 
     m = scmutil.match(repo[None], pats, opts)
     s = repo.status(match=m, clean=True)
     modified, added, deleted, clean = s[0], s[1], s[3], s[6]
 
     for f in m.files():
         if f not in repo.dirstate and not os.path.isdir(m.rel(f)):
             if os.path.exists(m.rel(f)):
                 ui.warn(_('not removing %s: file is untracked\n') % m.rel(f))
             ret = 1
 
     if force:
         list = modified + deleted + clean + added
     elif after:
         list = deleted
         for f in modified + added + clean:
             ui.warn(_('not removing %s: file still exists (use -f'
                       ' to force removal)\n') % m.rel(f))
             ret = 1
     else:
         list = deleted + clean
         for f in modified:
             ui.warn(_('not removing %s: file is modified (use -f'
                       ' to force removal)\n') % m.rel(f))
             ret = 1
         for f in added:
             ui.warn(_('not removing %s: file has been marked for add'
                       ' (use forget to undo)\n') % m.rel(f))
             ret = 1
 
     for f in sorted(list):
         if ui.verbose or not m.exact(f):
             ui.status(_('removing %s\n') % m.rel(f))
 
     wlock = repo.wlock()
     try:
         if not after:
             for f in list:
                 if f in added:
                     continue # we never unlink added files on remove
                 try:
                     util.unlinkpath(repo.wjoin(f))
                 except OSError, inst:
                     if inst.errno != errno.ENOENT:
                         raise
         repo[None].forget(list)
     finally:
         wlock.release()
 
     return ret
 
 @command('rename|move|mv',
     [('A', 'after', None, _('record a rename that has already occurred')),
     ('f', 'force', None, _('forcibly copy over an existing managed file')),
     ] + walkopts + dryrunopts,
     _('[OPTION]... SOURCE... DEST'))
 def rename(ui, repo, *pats, **opts):
     """rename files; equivalent of copy + remove
 
     Mark dest as copies of sources; mark sources for deletion. If dest
     is a directory, copies are put in that directory. If dest is a
     file, there can only be one source.
 
     By default, this command copies the contents of files as they
     exist in the working directory. If invoked with -A/--after, the
     operation is recorded, but no copying is performed.
 
     This command takes effect at the next commit. To undo a rename
     before that, see :hg:`revert`.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     wlock = repo.wlock(False)
     try:
         return cmdutil.copy(ui, repo, pats, opts, rename=True)
     finally:
         wlock.release()
 
 @command('resolve',
     [('a', 'all', None, _('select all unresolved files')),
     ('l', 'list', None, _('list state of files needing merge')),
     ('m', 'mark', None, _('mark files as resolved')),
     ('u', 'unmark', None, _('mark files as unresolved')),
     ('n', 'no-status', None, _('hide status prefix'))]
     + mergetoolopts + walkopts,
     _('[OPTION]... [FILE]...'))
 def resolve(ui, repo, *pats, **opts):
     """redo merges or set/view the merge status of files
 
     Merges with unresolved conflicts are often the result of
     non-interactive merging using the ``internal:merge`` configuration
     setting, or a command-line merge tool like ``diff3``. The resolve
     command is used to manage the files involved in a merge, after
     :hg:`merge` has been run, and before :hg:`commit` is run (i.e. the
     working directory must have two parents). See :hg:`help
     merge-tools` for information on configuring merge tools.
 
     The resolve command can be used in the following ways:
 
     - :hg:`resolve [--tool TOOL] FILE...`: attempt to re-merge the specified
       files, discarding any previous merge attempts. Re-merging is not
       performed for files already marked as resolved. Use ``--all/-a``
       to select all unresolved files. ``--tool`` can be used to specify
       the merge tool used for the given files. It overrides the HGMERGE
       environment variable and your configuration files.  Previous file
       contents are saved with a ``.orig`` suffix.
 
     - :hg:`resolve -m [FILE]`: mark a file as having been resolved
       (e.g. after having manually fixed-up the files). The default is
       to mark all unresolved files.
 
     - :hg:`resolve -u [FILE]...`: mark a file as unresolved. The
       default is to mark all resolved files.
 
     - :hg:`resolve -l`: list files which had or still have conflicts.
       In the printed list, ``U`` = unresolved and ``R`` = resolved.
 
     Note that Mercurial will not let you commit files with unresolved
     merge conflicts. You must use :hg:`resolve -m ...` before you can
     commit after a conflicting merge.
 
     Returns 0 on success, 1 if any files fail a resolve attempt.
     """
 
     all, mark, unmark, show, nostatus = \
         [opts.get(o) for o in 'all mark unmark list no_status'.split()]
 
     if (show and (mark or unmark)) or (mark and unmark):
         raise util.Abort(_("too many options specified"))
     if pats and all:
         raise util.Abort(_("can't specify --all and patterns"))
     if not (all or pats or show or mark or unmark):
         raise util.Abort(_('no files or directories specified; '
                            'use --all to remerge all files'))
 
     ms = mergemod.mergestate(repo)
     m = scmutil.match(repo[None], pats, opts)
     ret = 0
 
     for f in ms:
         if m(f):
             if show:
                 if nostatus:
                     ui.write("%s\n" % f)
                 else:
                     ui.write("%s %s\n" % (ms[f].upper(), f),
                              label='resolve.' +
                              {'u': 'unresolved', 'r': 'resolved'}[ms[f]])
             elif mark:
                 ms.mark(f, "r")
             elif unmark:
                 ms.mark(f, "u")
             else:
                 wctx = repo[None]
                 mctx = wctx.parents()[-1]
 
                 # backup pre-resolve (merge uses .orig for its own purposes)
                 a = repo.wjoin(f)
                 util.copyfile(a, a + ".resolve")
 
                 try:
                     # resolve file
                     ui.setconfig('ui', 'forcemerge', opts.get('tool', ''))
                     if ms.resolve(f, wctx, mctx):
                         ret = 1
                 finally:
                     ui.setconfig('ui', 'forcemerge', '')
 
                 # replace filemerge's .orig file with our resolve file
                 util.rename(a + ".resolve", a + ".orig")
 
     ms.commit()
     return ret
 
 @command('revert',
     [('a', 'all', None, _('revert all changes when no arguments given')),
     ('d', 'date', '', _('tipmost revision matching date'), _('DATE')),
     ('r', 'rev', '', _('revert to the specified revision'), _('REV')),
     ('C', 'no-backup', None, _('do not save backup copies of files')),
     ] + walkopts + dryrunopts,
     _('[OPTION]... [-r REV] [NAME]...'))
 def revert(ui, repo, *pats, **opts):
     """restore files to their checkout state
 
     .. note::
 
        To check out earlier revisions, you should use :hg:`update REV`.
        To cancel an uncommitted merge (and lose your changes), use
        :hg:`update --clean .`.
 
     With no revision specified, revert the specified files or directories
     to the contents they had in the parent of the working directory.
     This restores the contents of files to an unmodified
     state and unschedules adds, removes, copies, and renames. If the
     working directory has two parents, you must explicitly specify a
     revision.
 
     Using the -r/--rev or -d/--date options, revert the given files or
     directories to their states as of a specific revision. Because
     revert does not change the working directory parents, this will
     cause these files to appear modified. This can be helpful to "back
     out" some or all of an earlier change. See :hg:`backout` for a
     related method.
 
     Modified files are saved with a .orig suffix before reverting.
     To disable these backups, use --no-backup.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success.
     """
 
     if opts.get("date"):
         if opts.get("rev"):
             raise util.Abort(_("you can't specify a revision and a date"))
         opts["rev"] = cmdutil.finddate(ui, repo, opts["date"])
 
     parent, p2 = repo.dirstate.parents()
     if not opts.get('rev') and p2 != nullid:
         # revert after merge is a trap for new users (issue2915)
         raise util.Abort(_('uncommitted merge with no revision specified'),
                          hint=_('use "hg update" or see "hg help revert"'))
 
     ctx = scmutil.revsingle(repo, opts.get('rev'))
 
     if not pats and not opts.get('all'):
         msg = _("no files or directories specified")
         if p2 != nullid:
             hint = _("uncommitted merge, use --all to discard all changes,"
                      " or 'hg update -C .' to abort the merge")
             raise util.Abort(msg, hint=hint)
         dirty = util.any(repo.status())
         node = ctx.node()
         if node != parent:
             if dirty:
                 hint = _("uncommitted changes, use --all to discard all"
                          " changes, or 'hg update %s' to update") % ctx.rev()
             else:
                 hint = _("use --all to revert all files,"
                          " or 'hg update %s' to update") % ctx.rev()
         elif dirty:
             hint = _("uncommitted changes, use --all to discard all changes")
         else:
             hint = _("use --all to revert all files")
         raise util.Abort(msg, hint=hint)
 
     return cmdutil.revert(ui, repo, ctx, (parent, p2), *pats, **opts)
 
 @command('rollback', dryrunopts +
          [('f', 'force', False, _('ignore safety measures'))])
 def rollback(ui, repo, **opts):
     """roll back the last transaction (dangerous)
 
     This command should be used with care. There is only one level of
     rollback, and there is no way to undo a rollback. It will also
     restore the dirstate at the time of the last transaction, losing
     any dirstate changes since that time. This command does not alter
     the working directory.
 
     Transactions are used to encapsulate the effects of all commands
     that create new changesets or propagate existing changesets into a
     repository.
 
     .. container:: verbose
 
       For example, the following commands are transactional, and their
       effects can be rolled back:
 
       - commit
       - import
       - pull
       - push (with this repository as the destination)
       - unbundle
 
       To avoid permanent data loss, rollback will refuse to rollback a
       commit transaction if it isn't checked out. Use --force to
       override this protection.
 
     This command is not intended for use on public repositories. Once
     changes are visible for pull by other users, rolling a transaction
     back locally is ineffective (someone else may already have pulled
     the changes). Furthermore, a race is possible with readers of the
     repository; for example an in-progress pull from the repository
     may fail if a rollback is performed.
 
     Returns 0 on success, 1 if no rollback data is available.
     """
     return repo.rollback(dryrun=opts.get('dry_run'),
                          force=opts.get('force'))
 
 @command('root', [])
 def root(ui, repo):
     """print the root (top) of the current working directory
 
     Print the root directory of the current repository.
 
     Returns 0 on success.
     """
     ui.write(repo.root + "\n")
 
 @command('^serve',
     [('A', 'accesslog', '', _('name of access log file to write to'),
      _('FILE')),
     ('d', 'daemon', None, _('run server in background')),
     ('', 'daemon-pipefds', '', _('used internally by daemon mode'), _('NUM')),
     ('E', 'errorlog', '', _('name of error log file to write to'), _('FILE')),
     # use string type, then we can check if something was passed
     ('p', 'port', '', _('port to listen on (default: 8000)'), _('PORT')),
     ('a', 'address', '', _('address to listen on (default: all interfaces)'),
      _('ADDR')),
     ('', 'prefix', '', _('prefix path to serve from (default: server root)'),
      _('PREFIX')),
     ('n', 'name', '',
      _('name to show in web pages (default: working directory)'), _('NAME')),
     ('', 'web-conf', '',
      _('name of the hgweb config file (see "hg help hgweb")'), _('FILE')),
     ('', 'webdir-conf', '', _('name of the hgweb config file (DEPRECATED)'),
      _('FILE')),
     ('', 'pid-file', '', _('name of file to write process ID to'), _('FILE')),
     ('', 'stdio', None, _('for remote clients')),
     ('', 'cmdserver', '', _('for remote clients'), _('MODE')),
     ('t', 'templates', '', _('web templates to use'), _('TEMPLATE')),
     ('', 'style', '', _('template style to use'), _('STYLE')),
     ('6', 'ipv6', None, _('use IPv6 in addition to IPv4')),
     ('', 'certificate', '', _('SSL certificate file'), _('FILE'))],
     _('[OPTION]...'))
 def serve(ui, repo, **opts):
     """start stand-alone webserver
 
     Start a local HTTP repository browser and pull server. You can use
     this for ad-hoc sharing and browsing of repositories. It is
     recommended to use a real web server to serve a repository for
     longer periods of time.
 
     Please note that the server does not implement access control.
     This means that, by default, anybody can read from the server and
     nobody can write to it by default. Set the ``web.allow_push``
     option to ``*`` to allow everybody to push to the server. You
     should use a real web server if you need to authenticate users.
 
     By default, the server logs accesses to stdout and errors to
     stderr. Use the -A/--accesslog and -E/--errorlog options to log to
     files.
 
     To have the server choose a free port number to listen on, specify
     a port number of 0; in this case, the server will print the port
     number it uses.
 
     Returns 0 on success.
     """
 
     if opts["stdio"] and opts["cmdserver"]:
         raise util.Abort(_("cannot use --stdio with --cmdserver"))
 
     def checkrepo():
         if repo is None:
             raise error.RepoError(_("there is no Mercurial repository here"
                               " (.hg not found)"))
 
     if opts["stdio"]:
         checkrepo()
         s = sshserver.sshserver(ui, repo)
         s.serve_forever()
 
     if opts["cmdserver"]:
         checkrepo()
         s = commandserver.server(ui, repo, opts["cmdserver"])
         return s.serve()
 
     # this way we can check if something was given in the command-line
     if opts.get('port'):
         opts['port'] = util.getport(opts.get('port'))
 
     baseui = repo and repo.baseui or ui
     optlist = ("name templates style address port prefix ipv6"
                " accesslog errorlog certificate encoding")
     for o in optlist.split():
         val = opts.get(o, '')
         if val in (None, ''): # should check against default options instead
             continue
         baseui.setconfig("web", o, val)
         if repo and repo.ui != baseui:
             repo.ui.setconfig("web", o, val)
 
     o = opts.get('web_conf') or opts.get('webdir_conf')
     if not o:
         if not repo:
             raise error.RepoError(_("there is no Mercurial repository"
                                     " here (.hg not found)"))
         o = repo.root
 
     app = hgweb.hgweb(o, baseui=ui)
 
     class service(object):
         def init(self):
             util.setsignalhandler()
             self.httpd = hgweb.server.create_server(ui, app)
 
             if opts['port'] and not ui.verbose:
                 return
 
             if self.httpd.prefix:
                 prefix = self.httpd.prefix.strip('/') + '/'
             else:
                 prefix = ''
 
             port = ':%d' % self.httpd.port
             if port == ':80':
                 port = ''
 
             bindaddr = self.httpd.addr
             if bindaddr == '0.0.0.0':
                 bindaddr = '*'
             elif ':' in bindaddr: # IPv6
                 bindaddr = '[%s]' % bindaddr
 
             fqaddr = self.httpd.fqaddr
             if ':' in fqaddr:
                 fqaddr = '[%s]' % fqaddr
             if opts['port']:
                 write = ui.status
             else:
                 write = ui.write
             write(_('listening at http://%s%s/%s (bound to %s:%d)\n') %
                   (fqaddr, port, prefix, bindaddr, self.httpd.port))
 
         def run(self):
             self.httpd.serve_forever()
 
     service = service()
 
     cmdutil.service(opts, initfn=service.init, runfn=service.run)
 
 @command('showconfig|debugconfig',
     [('u', 'untrusted', None, _('show untrusted configuration options'))],
     _('[-u] [NAME]...'))
 def showconfig(ui, repo, *values, **opts):
     """show combined config settings from all hgrc files
 
     With no arguments, print names and values of all config items.
 
     With one argument of the form section.name, print just the value
     of that config item.
 
     With multiple arguments, print names and values of all config
     items with matching section names.
 
     With --debug, the source (filename and line number) is printed
     for each config item.
 
     Returns 0 on success.
     """
 
     for f in scmutil.rcpath():
         ui.debug('read config from: %s\n' % f)
     untrusted = bool(opts.get('untrusted'))
     if values:
         sections = [v for v in values if '.' not in v]
         items = [v for v in values if '.' in v]
         if len(items) > 1 or items and sections:
             raise util.Abort(_('only one config item permitted'))
     for section, name, value in ui.walkconfig(untrusted=untrusted):
         value = str(value).replace('\n', '\\n')
         sectname = section + '.' + name
         if values:
             for v in values:
                 if v == section:
                     ui.debug('%s: ' %
                              ui.configsource(section, name, untrusted))
                     ui.write('%s=%s\n' % (sectname, value))
                 elif v == sectname:
                     ui.debug('%s: ' %
                              ui.configsource(section, name, untrusted))
                     ui.write(value, '\n')
         else:
             ui.debug('%s: ' %
                      ui.configsource(section, name, untrusted))
             ui.write('%s=%s\n' % (sectname, value))
 
 @command('^status|st',
     [('A', 'all', None, _('show status of all files')),
     ('m', 'modified', None, _('show only modified files')),
     ('a', 'added', None, _('show only added files')),
     ('r', 'removed', None, _('show only removed files')),
     ('d', 'deleted', None, _('show only deleted (but tracked) files')),
     ('c', 'clean', None, _('show only files without changes')),
     ('u', 'unknown', None, _('show only unknown (not tracked) files')),
     ('i', 'ignored', None, _('show only ignored files')),
     ('n', 'no-status', None, _('hide status prefix')),
     ('C', 'copies', None, _('show source of copied files')),
     ('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
     ('', 'rev', [], _('show difference from revision'), _('REV')),
     ('', 'change', '', _('list the changed files of a revision'), _('REV')),
     ] + walkopts + subrepoopts,
     _('[OPTION]... [FILE]...'))
 def status(ui, repo, *pats, **opts):
     """show changed files in the working directory
 
     Show status of files in the repository. If names are given, only
     files that match are shown. Files that are clean or ignored or
     the source of a copy/move operation, are not listed unless
     -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
     Unless options described with "show only ..." are given, the
     options -mardu are used.
 
     Option -q/--quiet hides untracked (unknown and ignored) files
     unless explicitly requested with -u/--unknown or -i/--ignored.
 
     .. note::
        status may appear to disagree with diff if permissions have
        changed or a merge has occurred. The standard diff format does
        not report permission changes and diff only reports changes
        relative to one merge parent.
 
     If one revision is given, it is used as the base revision.
     If two revisions are given, the differences between them are
     shown. The --change option can also be used as a shortcut to list
     the changed files of a revision from its first parent.
 
     The codes used to show the status of files are::
 
       M = modified
       A = added
       R = removed
       C = clean
       ! = missing (deleted by non-hg command, but still tracked)
       ? = not tracked
       I = ignored
         = origin of the previous file listed as A (added)
 
     .. container:: verbose
 
       Examples:
 
       - show changes in the working directory relative to a
         changeset::
 
           hg status --rev 9353
 
       - show all changes including copies in an existing changeset::
 
           hg status --copies --change 9353
 
       - get a NUL separated list of added files, suitable for xargs::
 
           hg status -an0
 
     Returns 0 on success.
     """
 
     revs = opts.get('rev')
     change = opts.get('change')
 
     if revs and change:
         msg = _('cannot specify --rev and --change at the same time')
         raise util.Abort(msg)
     elif change:
         node2 = scmutil.revsingle(repo, change, None).node()
         node1 = repo[node2].p1().node()
     else:
         node1, node2 = scmutil.revpair(repo, revs)
 
     cwd = (pats and repo.getcwd()) or ''
     end = opts.get('print0') and '\0' or '\n'
     copy = {}
     states = 'modified added removed deleted unknown ignored clean'.split()
     show = [k for k in states if opts.get(k)]
     if opts.get('all'):
         show += ui.quiet and (states[:4] + ['clean']) or states
     if not show:
         show = ui.quiet and states[:4] or states[:5]
 
     stat = repo.status(node1, node2, scmutil.match(repo[node2], pats, opts),
                        'ignored' in show, 'clean' in show, 'unknown' in show,
                        opts.get('subrepos'))
     changestates = zip(states, 'MAR!?IC', stat)
 
     if (opts.get('all') or opts.get('copies')) and not opts.get('no_status'):
         copy = copies.pathcopies(repo[node1], repo[node2])
 
     fm = ui.formatter('status', opts)
     format = '%s %s' + end
     if opts.get('no_status'):
         format = '%.0s%s' + end
 
     for state, char, files in changestates:
         if state in show:
             label = 'status.' + state
             for f in files:
                 fm.startitem()
                 fm.write("status path", format, char,
                          repo.pathto(f, cwd), label=label)
                 if f in copy:
                     fm.write("copy", '  %s' + end, repo.pathto(copy[f], cwd),
                              label='status.copied')
     fm.end()
 
 @command('^summary|sum',
     [('', 'remote', None, _('check for push and pull'))], '[--remote]')
 def summary(ui, repo, **opts):
     """summarize working directory state
 
     This generates a brief summary of the working directory state,
     including parents, branch, commit status, and available updates.
 
     With the --remote option, this will check the default paths for
     incoming and outgoing changes. This can be time-consuming.
 
     Returns 0 on success.
     """
 
     ctx = repo[None]
     parents = ctx.parents()
     pnode = parents[0].node()
     marks = []
 
     for p in parents:
         # label with log.changeset (instead of log.parent) since this
         # shows a working directory parent *changeset*:
         ui.write(_('parent: %d:%s ') % (p.rev(), str(p)),
                  label='log.changeset')
         ui.write(' '.join(p.tags()), label='log.tag')
         if p.bookmarks():
             marks.extend(p.bookmarks())
         if p.rev() == -1:
             if not len(repo):
                 ui.write(_(' (empty repository)'))
             else:
                 ui.write(_(' (no revision checked out)'))
         ui.write('\n')
         if p.description():
             ui.status(' ' + p.description().splitlines()[0].strip() + '\n',
                       label='log.summary')
 
     branch = ctx.branch()
     bheads = repo.branchheads(branch)
     m = _('branch: %s\n') % branch
     if branch != 'default':
         ui.write(m, label='log.branch')
     else:
         ui.status(m, label='log.branch')
 
     if marks:
         current = repo._bookmarkcurrent
         ui.write(_('bookmarks:'), label='log.bookmark')
         if current is not None:
             try:
                 marks.remove(current)
                 ui.write(' *' + current, label='bookmarks.current')
             except ValueError:
                 # current bookmark not in parent ctx marks
                 pass
         for m in marks:
             ui.write(' ' + m, label='log.bookmark')
         ui.write('\n', label='log.bookmark')
 
     st = list(repo.status(unknown=True))[:6]
 
     c = repo.dirstate.copies()
     copied, renamed = [], []
     for d, s in c.iteritems():
         if s in st[2]:
             st[2].remove(s)
             renamed.append(d)
         else:
             copied.append(d)
         if d in st[1]:
             st[1].remove(d)
     st.insert(3, renamed)
     st.insert(4, copied)
 
     ms = mergemod.mergestate(repo)
     st.append([f for f in ms if ms[f] == 'u'])
 
     subs = [s for s in ctx.substate if ctx.sub(s).dirty()]
     st.append(subs)
 
     labels = [ui.label(_('%d modified'), 'status.modified'),
               ui.label(_('%d added'), 'status.added'),
               ui.label(_('%d removed'), 'status.removed'),
               ui.label(_('%d renamed'), 'status.copied'),
               ui.label(_('%d copied'), 'status.copied'),
               ui.label(_('%d deleted'), 'status.deleted'),
               ui.label(_('%d unknown'), 'status.unknown'),
               ui.label(_('%d ignored'), 'status.ignored'),
               ui.label(_('%d unresolved'), 'resolve.unresolved'),
               ui.label(_('%d subrepos'), 'status.modified')]
     t = []
     for s, l in zip(st, labels):
         if s:
             t.append(l % len(s))
 
     t = ', '.join(t)
     cleanworkdir = False
 
     if len(parents) > 1:
         t += _(' (merge)')
     elif branch != parents[0].branch():
         t += _(' (new branch)')
     elif (parents[0].closesbranch() and
           pnode in repo.branchheads(branch, closed=True)):
         t += _(' (head closed)')
     elif not (st[0] or st[1] or st[2] or st[3] or st[4] or st[9]):
         t += _(' (clean)')
         cleanworkdir = True
     elif pnode not in bheads:
         t += _(' (new branch head)')
 
     if cleanworkdir:
         ui.status(_('commit: %s\n') % t.strip())
     else:
         ui.write(_('commit: %s\n') % t.strip())
 
     # all ancestors of branch heads - all ancestors of parent = new csets
     new = [0] * len(repo)
     cl = repo.changelog
     for a in [cl.rev(n) for n in bheads]:
         new[a] = 1
     for a in cl.ancestors([cl.rev(n) for n in bheads]):
         new[a] = 1
     for a in [p.rev() for p in parents]:
         if a >= 0:
             new[a] = 0
     for a in cl.ancestors([p.rev() for p in parents]):
         new[a] = 0
     new = sum(new)
 
     if new == 0:
         ui.status(_('update: (current)\n'))
     elif pnode not in bheads:
         ui.write(_('update: %d new changesets (update)\n') % new)
     else:
         ui.write(_('update: %d new changesets, %d branch heads (merge)\n') %
                  (new, len(bheads)))
 
     if opts.get('remote'):
         t = []
         source, branches = hg.parseurl(ui.expandpath('default'))
         other = hg.peer(repo, {}, source)
         revs, checkout = hg.addbranchrevs(repo, other, branches,
                                           opts.get('rev'))
         ui.debug('comparing with %s\n' % util.hidepassword(source))
         repo.ui.pushbuffer()
         commoninc = discovery.findcommonincoming(repo, other)
         _common, incoming, _rheads = commoninc
         repo.ui.popbuffer()
         if incoming:
             t.append(_('1 or more incoming'))
 
         dest, branches = hg.parseurl(ui.expandpath('default-push', 'default'))
         revs, checkout = hg.addbranchrevs(repo, repo, branches, None)
         if source != dest:
             other = hg.peer(repo, {}, dest)
             commoninc = None
             ui.debug('comparing with %s\n' % util.hidepassword(dest))
         repo.ui.pushbuffer()
         outgoing = discovery.findcommonoutgoing(repo, other,
                                                 commoninc=commoninc)
         repo.ui.popbuffer()
         o = outgoing.missing
         if o:
             t.append(_('%d outgoing') % len(o))
         if 'bookmarks' in other.listkeys('namespaces'):
             lmarks = repo.listkeys('bookmarks')
             rmarks = other.listkeys('bookmarks')
             diff = set(rmarks) - set(lmarks)
             if len(diff) > 0:
                 t.append(_('%d incoming bookmarks') % len(diff))
             diff = set(lmarks) - set(rmarks)
             if len(diff) > 0:
                 t.append(_('%d outgoing bookmarks') % len(diff))
 
         if t:
             ui.write(_('remote: %s\n') % (', '.join(t)))
         else:
             ui.status(_('remote: (synced)\n'))
 
 @command('tag',
     [('f', 'force', None, _('force tag')),
     ('l', 'local', None, _('make the tag local')),
     ('r', 'rev', '', _('revision to tag'), _('REV')),
     ('', 'remove', None, _('remove a tag')),
     # -l/--local is already there, commitopts cannot be used
     ('e', 'edit', None, _('edit commit message')),
     ('m', 'message', '', _('use <text> as commit message'), _('TEXT')),
     ] + commitopts2,
     _('[-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...'))
 def tag(ui, repo, name1, *names, **opts):
     """add one or more tags for the current or given revision
 
     Name a particular revision using <name>.
 
     Tags are used to name particular revisions of the repository and are
     very useful to compare different revisions, to go back to significant
     earlier versions or to mark branch points as releases, etc. Changing
     an existing tag is normally disallowed; use -f/--force to override.
 
     If no revision is given, the parent of the working directory is
     used, or tip if no revision is checked out.
 
     To facilitate version control, distribution, and merging of tags,
     they are stored as a file named ".hgtags" which is managed similarly
     to other project files and can be hand-edited if necessary. This
     also means that tagging creates a new commit. The file
     ".hg/localtags" is used for local tags (not shared among
     repositories).
 
     Tag commits are usually made at the head of a branch. If the parent
     of the working directory is not a branch head, :hg:`tag` aborts; use
     -f/--force to force the tag commit to be based on a non-head
     changeset.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Since tag names have priority over branch names during revision
     lookup, using an existing branch name as a tag name is discouraged.
 
     Returns 0 on success.
     """
     wlock = lock = None
     try:
         wlock = repo.wlock()
         lock = repo.lock()
         rev_ = "."
         names = [t.strip() for t in (name1,) + names]
         if len(names) != len(set(names)):
             raise util.Abort(_('tag names must be unique'))
         for n in names:
             if n in ['tip', '.', 'null']:
                 raise util.Abort(_("the name '%s' is reserved") % n)
             if not n:
                 raise util.Abort(_('tag names cannot consist entirely of '
                                    'whitespace'))
         if opts.get('rev') and opts.get('remove'):
             raise util.Abort(_("--rev and --remove are incompatible"))
         if opts.get('rev'):
             rev_ = opts['rev']
         message = opts.get('message')
         if opts.get('remove'):
             expectedtype = opts.get('local') and 'local' or 'global'
             for n in names:
                 if not repo.tagtype(n):
                     raise util.Abort(_("tag '%s' does not exist") % n)
                 if repo.tagtype(n) != expectedtype:
                     if expectedtype == 'global':
                         raise util.Abort(_("tag '%s' is not a global tag") % n)
                     else:
                         raise util.Abort(_("tag '%s' is not a local tag") % n)
             rev_ = nullid
             if not message:
                 # we don't translate commit messages
                 message = 'Removed tag %s' % ', '.join(names)
         elif not opts.get('force'):
             for n in names:
                 if n in repo.tags():
                     raise util.Abort(_("tag '%s' already exists "
                                        "(use -f to force)") % n)
         if not opts.get('local'):
             p1, p2 = repo.dirstate.parents()
             if p2 != nullid:
                 raise util.Abort(_('uncommitted merge'))
             bheads = repo.branchheads()
             if not opts.get('force') and bheads and p1 not in bheads:
                 raise util.Abort(_('not at a branch head (use -f to force)'))
         r = scmutil.revsingle(repo, rev_).node()
 
         if not message:
             # we don't translate commit messages
             message = ('Added tag %s for changeset %s' %
                        (', '.join(names), short(r)))
 
         date = opts.get('date')
         if date:
             date = util.parsedate(date)
 
         if opts.get('edit'):
             message = ui.edit(message, ui.username())
 
         # don't allow tagging the null rev
         if (not opts.get('remove') and
             scmutil.revsingle(repo, rev_).rev() == nullrev):
             raise util.Abort(_("null revision specified"))
 
         repo.tag(names, r, message, opts.get('local'), opts.get('user'), date)
     finally:
         release(lock, wlock)
 
 @command('tags', [], '')
 def tags(ui, repo):
     """list repository tags
 
     This lists both regular and local tags. When the -v/--verbose
     switch is used, a third column "local" is printed for local tags.
 
     Returns 0 on success.
     """
 
     hexfunc = ui.debugflag and hex or short
     tagtype = ""
 
     for t, n in reversed(repo.tagslist()):
         if ui.quiet:
             ui.write("%s\n" % t, label='tags.normal')
             continue
 
         hn = hexfunc(n)
         r = "%5d:%s" % (repo.changelog.rev(n), hn)
         rev = ui.label(r, 'log.changeset')
         spaces = " " * (30 - encoding.colwidth(t))
 
         tag = ui.label(t, 'tags.normal')
         if ui.verbose:
             if repo.tagtype(t) == 'local':
                 tagtype = " local"
                 tag = ui.label(t, 'tags.local')
             else:
                 tagtype = ""
         ui.write("%s%s %s%s\n" % (tag, spaces, rev, tagtype))
 
 @command('tip',
     [('p', 'patch', None, _('show patch')),
     ('g', 'git', None, _('use git extended diff format')),
     ] + templateopts,
     _('[-p] [-g]'))
 def tip(ui, repo, **opts):
     """show the tip revision
 
     The tip revision (usually just called the tip) is the changeset
     most recently added to the repository (and therefore the most
     recently changed head).
 
     If you have just made a commit, that commit will be the tip. If
     you have just pulled changes from another repository, the tip of
     that repository becomes the current tip. The "tip" tag is special
     and cannot be renamed or assigned to a different changeset.
 
     Returns 0 on success.
     """
     displayer = cmdutil.show_changeset(ui, repo, opts)
     displayer.show(repo[len(repo) - 1])
     displayer.close()
 
 @command('unbundle',
     [('u', 'update', None,
      _('update to new branch head if changesets were unbundled'))],
     _('[-u] FILE...'))
 def unbundle(ui, repo, fname1, *fnames, **opts):
     """apply one or more changegroup files
 
     Apply one or more compressed changegroup files generated by the
     bundle command.
 
     Returns 0 on success, 1 if an update has unresolved files.
     """
     fnames = (fname1,) + fnames
 
     lock = repo.lock()
     wc = repo['.']
     try:
         for fname in fnames:
             f = url.open(ui, fname)
             gen = changegroup.readbundle(f, fname)
             modheads = repo.addchangegroup(gen, 'unbundle', 'bundle:' + fname)
     finally:
         lock.release()
     bookmarks.updatecurrentbookmark(repo, wc.node(), wc.branch())
     return postincoming(ui, repo, modheads, opts.get('update'), None)
 
 @command('^update|up|checkout|co',
     [('C', 'clean', None, _('discard uncommitted changes (no backup)')),
     ('c', 'check', None,
      _('update across branches if no uncommitted changes')),
     ('d', 'date', '', _('tipmost revision matching date'), _('DATE')),
     ('r', 'rev', '', _('revision'), _('REV'))],
     _('[-c] [-C] [-d DATE] [[-r] REV]'))
 def update(ui, repo, node=None, rev=None, clean=False, date=None, check=False):
     """update working directory (or switch revisions)
 
     Update the repository's working directory to the specified
     changeset. If no changeset is specified, update to the tip of the
     current named branch and move the current bookmark (see :hg:`help
     bookmarks`).
 
     Update sets the working directory's parent revision to the specified
     changeset (see :hg:`help parents`).
 
     If the changeset is not a descendant or ancestor of the working
     directory's parent, the update is aborted. With the -c/--check
     option, the working directory is checked for uncommitted changes; if
     none are found, the working directory is updated to the specified
     changeset.
 
     .. container:: verbose
 
       The following rules apply when the working directory contains
       uncommitted changes:
 
       1. If neither -c/--check nor -C/--clean is specified, and if
          the requested changeset is an ancestor or descendant of
          the working directory's parent, the uncommitted changes
          are merged into the requested changeset and the merged
          result is left uncommitted. If the requested changeset is
          not an ancestor or descendant (that is, it is on another
          branch), the update is aborted and the uncommitted changes
          are preserved.
 
       2. With the -c/--check option, the update is aborted and the
          uncommitted changes are preserved.
 
       3. With the -C/--clean option, uncommitted changes are discarded and
          the working directory is updated to the requested changeset.
 
     To cancel an uncommitted merge (and lose your changes), use
     :hg:`update --clean .`.
 
     Use null as the changeset to remove the working directory (like
     :hg:`clone -U`).
 
     If you want to revert just one file to an older revision, use
     :hg:`revert [-r REV] NAME`.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success, 1 if there are unresolved files.
     """
     if rev and node:
         raise util.Abort(_("please specify just one revision"))
 
     if rev is None or rev == '':
         rev = node
 
     # with no argument, we also move the current bookmark, if any
     movemarkfrom = None
     if rev is None or node == '':
         movemarkfrom = repo['.'].node()
 
     # if we defined a bookmark, we have to remember the original bookmark name
     brev = rev
     rev = scmutil.revsingle(repo, rev, rev).rev()
 
     if check and clean:
         raise util.Abort(_("cannot specify both -c/--check and -C/--clean"))
 
     if date:
         if rev is not None:
             raise util.Abort(_("you can't specify a revision and a date"))
         rev = cmdutil.finddate(ui, repo, date)
 
     if check:
         c = repo[None]
         if c.dirty(merge=False, branch=False):
             raise util.Abort(_("uncommitted local changes"))
         if rev is None:
             rev = repo[repo[None].branch()].rev()
         mergemod._checkunknown(repo, repo[None], repo[rev])
 
     if clean:
         ret = hg.clean(repo, rev)
     else:
         ret = hg.update(repo, rev)
 
     if not ret and movemarkfrom:
         if bookmarks.update(repo, [movemarkfrom], repo['.'].node()):
             ui.status(_("updating bookmark %s\n") % repo._bookmarkcurrent)
     elif brev in repo._bookmarks:
         bookmarks.setcurrent(repo, brev)
     elif brev:
         bookmarks.unsetcurrent(repo)
 
     return ret
 
 @command('verify', [])
 def verify(ui, repo):
     """verify the integrity of the repository
 
     Verify the integrity of the current repository.
 
     This will perform an extensive check of the repository's
     integrity, validating the hashes and checksums of each entry in
     the changelog, manifest, and tracked files, as well as the
     integrity of their crosslinks and indices.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     return hg.verify(repo)
 
 @command('version', [])
 def version_(ui):
     """output version and copyright information"""
     ui.write(_("Mercurial Distributed SCM (version %s)\n")
              % util.version())
     ui.status(_(
         "(see http://mercurial.selenic.com for more information)\n"
         "\nCopyright (C) 2005-2012 Matt Mackall and others\n"
         "This is free software; see the source for copying conditions. "
         "There is NO\nwarranty; "
         "not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
     ))
 
 norepo = ("clone init version help debugcommands debugcomplete"
           " debugdate debuginstall debugfsinfo debugpushkey debugwireargs"
           " debugknown debuggetbundle debugbundle")
 optionalrepo = ("identify paths serve showconfig debugancestor debugdag"
                 " debugdata debugindex debugindexdot debugrevlog")

mercurial/config.py

@@ -1,183 +1,183 b''
 # config.py - configuration parsing for Mercurial
 #
 #  Copyright 2009 Matt Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import _
 import error, util
 import os, errno
 
 class sortdict(dict):
     'a simple sorted dictionary'
     def __init__(self, data=None):
         self._list = []
         if data:
             self.update(data)
     def copy(self):
         return sortdict(self)
     def __setitem__(self, key, val):
         if key in self:
             self._list.remove(key)
         self._list.append(key)
         dict.__setitem__(self, key, val)
     def __iter__(self):
         return self._list.__iter__()
     def update(self, src):
         for k in src:
             self[k] = src[k]
     def clear(self):
         dict.clear(self)
         self._list = []
     def items(self):
         return [(k, self[k]) for k in self._list]
     def __delitem__(self, key):
         dict.__delitem__(self, key)
         self._list.remove(key)
     def keys(self):
         return self._list
     def iterkeys(self):
         return self._list.__iter__()
 
 class config(object):
     def __init__(self, data=None):
         self._data = {}
         self._source = {}
         if data:
             for k in data._data:
                 self._data[k] = data[k].copy()
             self._source = data._source.copy()
     def copy(self):
         return config(self)
     def __contains__(self, section):
         return section in self._data
     def __getitem__(self, section):
         return self._data.get(section, {})
     def __iter__(self):
         for d in self.sections():
             yield d
     def update(self, src):
         for s in src:
             if s not in self:
                 self._data[s] = sortdict()
             self._data[s].update(src._data[s])
         self._source.update(src._source)
     def get(self, section, item, default=None):
         return self._data.get(section, {}).get(item, default)
 
     def backup(self, section, item):
-        """return a tuple allowing restore to reinstall previous values
+        """return a tuple allowing restore to reinstall a previous value
 
-        The main reason we need it is because it handle the "no data" case.
+        The main reason we need it is because it handles the "no data" case.
         """
         try:
             value = self._data[section][item]
             source = self.source(section, item)
             return (section, item, value, source)
         except KeyError:
             return (section, item)
 
     def source(self, section, item):
         return self._source.get((section, item), "")
     def sections(self):
         return sorted(self._data.keys())
     def items(self, section):
         return self._data.get(section, {}).items()
     def set(self, section, item, value, source=""):
         if section not in self:
             self._data[section] = sortdict()
         self._data[section][item] = value
         self._source[(section, item)] = source
 
     def restore(self, data):
         """restore data returned by self.backup"""
         if len(data) == 4:
             # restore old data
             section, item, value, source = data
             self._data[section][item] = value
             self._source[(section, item)] = source
         else:
             # no data before, remove everything
             section, item = data
             if section in self._data:
                 del self._data[section][item]
             self._source.pop((section, item), None)
 
     def parse(self, src, data, sections=None, remap=None, include=None):
         sectionre = util.compilere(r'\[([^\[]+)\]')
         itemre = util.compilere(r'([^=\s][^=]*?)\s*=\s*(.*\S|)')
         contre = util.compilere(r'\s+(\S|\S.*\S)\s*$')
         emptyre = util.compilere(r'(;|#|\s*$)')
         commentre = util.compilere(r'(;|#)')
         unsetre = util.compilere(r'%unset\s+(\S+)')
         includere = util.compilere(r'%include\s+(\S|\S.*\S)\s*$')
         section = ""
         item = None
         line = 0
         cont = False
 
         for l in data.splitlines(True):
             line += 1
             if line == 1 and l.startswith('\xef\xbb\xbf'):
                 # Someone set us up the BOM
                 l = l[3:]
             if cont:
                 if commentre.match(l):
                     continue
                 m = contre.match(l)
                 if m:
                     if sections and section not in sections:
                         continue
                     v = self.get(section, item) + "\n" + m.group(1)
                     self.set(section, item, v, "%s:%d" % (src, line))
                     continue
                 item = None
                 cont = False
             m = includere.match(l)
             if m:
                 inc = util.expandpath(m.group(1))
                 base = os.path.dirname(src)
                 inc = os.path.normpath(os.path.join(base, inc))
                 if include:
                     try:
                         include(inc, remap=remap, sections=sections)
                     except IOError, inst:
                         if inst.errno != errno.ENOENT:
                             raise error.ParseError(_("cannot include %s (%s)")
                                                    % (inc, inst.strerror),
                                                    "%s:%s" % (src, line))
                 continue
             if emptyre.match(l):
                 continue
             m = sectionre.match(l)
             if m:
                 section = m.group(1)
                 if remap:
                     section = remap.get(section, section)
                 if section not in self:
                     self._data[section] = sortdict()
                 continue
             m = itemre.match(l)
             if m:
                 item = m.group(1)
                 cont = True
                 if sections and section not in sections:
                     continue
                 self.set(section, item, m.group(2), "%s:%d" % (src, line))
                 continue
             m = unsetre.match(l)
             if m:
                 name = m.group(1)
                 if sections and section not in sections:
                     continue
                 if self.get(section, name) is not None:
                     del self._data[section][name]
                 continue
 
             raise error.ParseError(l.rstrip(), ("%s:%s" % (src, line)))
 
     def read(self, path, fp=None, sections=None, remap=None):
         if not fp:
             fp = util.posixfile(path)
         self.parse(path, fp.read(), sections, remap, self.read)

mercurial/dagparser.py

@@ -1,479 +1,479 b''
 # dagparser.py - parser and generator for concise description of DAGs
 #
 # Copyright 2010 Peter Arrenbrecht <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import re, string
 import util
 from i18n import _
 
 def parsedag(desc):
     '''parses a DAG from a concise textual description; generates events
 
     "+n" is a linear run of n nodes based on the current default parent
     "." is a single node based on the current default parent
     "$" resets the default parent to -1 (implied at the start);
         otherwise the default parent is always the last node created
     "<p" sets the default parent to the backref p
     "*p" is a fork at parent p, where p is a backref
     "*p1/p2/.../pn" is a merge of parents p1..pn, where the pi are backrefs
     "/p2/.../pn" is a merge of the preceding node and p2..pn
     ":name" defines a label for the preceding node; labels can be redefined
     "@text" emits an annotation event for text
     "!command" emits an action event for the current node
     "!!my command\n" is like "!", but to the end of the line
     "#...\n" is a comment up to the end of the line
 
     Whitespace between the above elements is ignored.
 
     A backref is either
      * a number n, which references the node curr-n, where curr is the current
        node, or
      * the name of a label you placed earlier using ":name", or
      * empty to denote the default parent.
 
     All string valued-elements are either strictly alphanumeric, or must
     be enclosed in double quotes ("..."), with "\" as escape character.
 
     Generates sequence of
 
       ('n', (id, [parentids])) for node creation
       ('l', (id, labelname)) for labels on nodes
       ('a', text) for annotations
       ('c', command) for actions (!)
       ('C', command) for line actions (!!)
 
     Examples
     --------
 
     Example of a complex graph (output not shown for brevity):
 
         >>> len(list(parsedag("""
         ...
         ... +3         # 3 nodes in linear run
         ... :forkhere  # a label for the last of the 3 nodes from above
         ... +5         # 5 more nodes on one branch
         ... :mergethis # label again
-        ... <forkhere  # set default parent to labelled fork node
+        ... <forkhere  # set default parent to labeled fork node
         ... +10        # 10 more nodes on a parallel branch
         ... @stable    # following nodes will be annotated as "stable"
         ... +5         # 5 nodes in stable
         ... !addfile   # custom command; could trigger new file in next node
         ... +2         # two more nodes
-        ... /mergethis # merge last node with labelled node
+        ... /mergethis # merge last node with labeled node
         ... +4         # 4 more nodes descending from merge node
         ...
         ... """)))
         34
 
     Empty list:
 
         >>> list(parsedag(""))
         []
 
     A simple linear run:
 
         >>> list(parsedag("+3"))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [1]))]
 
     Some non-standard ways to define such runs:
 
         >>> list(parsedag("+1+2"))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [1]))]
 
         >>> list(parsedag("+1*1*"))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [1]))]
 
         >>> list(parsedag("*"))
         [('n', (0, [-1]))]
 
         >>> list(parsedag("..."))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [1]))]
 
     A fork and a join, using numeric back references:
 
         >>> list(parsedag("+2*2*/2"))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [0])), ('n', (3, [2, 1]))]
 
         >>> list(parsedag("+2<2+1/2"))
         [('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [0])), ('n', (3, [2, 1]))]
 
     Placing a label:
 
         >>> list(parsedag("+1 :mylabel +1"))
         [('n', (0, [-1])), ('l', (0, 'mylabel')), ('n', (1, [0]))]
 
     An empty label (silly, really):
 
         >>> list(parsedag("+1:+1"))
         [('n', (0, [-1])), ('l', (0, '')), ('n', (1, [0]))]
 
     Fork and join, but with labels instead of numeric back references:
 
         >>> list(parsedag("+1:f +1:p2 *f */p2"))
         [('n', (0, [-1])), ('l', (0, 'f')), ('n', (1, [0])), ('l', (1, 'p2')),
          ('n', (2, [0])), ('n', (3, [2, 1]))]
 
         >>> list(parsedag("+1:f +1:p2 <f +1 /p2"))
         [('n', (0, [-1])), ('l', (0, 'f')), ('n', (1, [0])), ('l', (1, 'p2')),
          ('n', (2, [0])), ('n', (3, [2, 1]))]
 
     Restarting from the root:
 
         >>> list(parsedag("+1 $ +1"))
         [('n', (0, [-1])), ('n', (1, [-1]))]
 
     Annotations, which are meant to introduce sticky state for subsequent nodes:
 
         >>> list(parsedag("+1 @ann +1"))
         [('n', (0, [-1])), ('a', 'ann'), ('n', (1, [0]))]
 
         >>> list(parsedag('+1 @"my annotation" +1'))
         [('n', (0, [-1])), ('a', 'my annotation'), ('n', (1, [0]))]
 
     Commands, which are meant to operate on the most recently created node:
 
         >>> list(parsedag("+1 !cmd +1"))
         [('n', (0, [-1])), ('c', 'cmd'), ('n', (1, [0]))]
 
         >>> list(parsedag('+1 !"my command" +1'))
         [('n', (0, [-1])), ('c', 'my command'), ('n', (1, [0]))]
 
         >>> list(parsedag('+1 !!my command line\\n +1'))
         [('n', (0, [-1])), ('C', 'my command line'), ('n', (1, [0]))]
 
     Comments, which extend to the end of the line:
 
         >>> list(parsedag('+1 # comment\\n+1'))
         [('n', (0, [-1])), ('n', (1, [0]))]
 
     Error:
 
         >>> try: list(parsedag('+1 bad'))
         ... except Exception, e: print e
         invalid character in dag description: bad...
 
     '''
     if not desc:
         return
 
     wordchars = string.ascii_letters + string.digits
 
     labels = {}
     p1 = -1
     r = 0
 
     def resolve(ref):
         if not ref:
             return p1
         elif ref[0] in string.digits:
             return r - int(ref)
         else:
             return labels[ref]
 
     chiter = (c for c in desc)
 
     def nextch():
         try:
             return chiter.next()
         except StopIteration:
             return '\0'
 
     def nextrun(c, allow):
         s = ''
         while c in allow:
             s += c
             c = nextch()
         return c, s
 
     def nextdelimited(c, limit, escape):
         s = ''
         while c != limit:
             if c == escape:
                 c = nextch()
             s += c
             c = nextch()
         return nextch(), s
 
     def nextstring(c):
         if c == '"':
             return nextdelimited(nextch(), '"', '\\')
         else:
             return nextrun(c, wordchars)
 
     c = nextch()
     while c != '\0':
         while c in string.whitespace:
             c = nextch()
         if c == '.':
             yield 'n', (r, [p1])
             p1 = r
             r += 1
             c = nextch()
         elif c == '+':
             c, digs = nextrun(nextch(), string.digits)
             n = int(digs)
             for i in xrange(0, n):
                 yield 'n', (r, [p1])
                 p1 = r
                 r += 1
         elif c in '*/':
             if c == '*':
                 c = nextch()
             c, pref = nextstring(c)
             prefs = [pref]
             while c == '/':
                 c, pref = nextstring(nextch())
                 prefs.append(pref)
             ps = [resolve(ref) for ref in prefs]
             yield 'n', (r, ps)
             p1 = r
             r += 1
         elif c == '<':
             c, ref = nextstring(nextch())
             p1 = resolve(ref)
         elif c == ':':
             c, name = nextstring(nextch())
             labels[name] = p1
             yield 'l', (p1, name)
         elif c == '@':
             c, text = nextstring(nextch())
             yield 'a', text
         elif c == '!':
             c = nextch()
             if c == '!':
                 cmd = ''
                 c = nextch()
                 while c not in '\n\r\0':
                     cmd += c
                     c = nextch()
                 yield 'C', cmd
             else:
                 c, cmd = nextstring(c)
                 yield 'c', cmd
         elif c == '#':
             while c not in '\n\r\0':
                 c = nextch()
         elif c == '$':
             p1 = -1
             c = nextch()
         elif c == '\0':
             return # in case it was preceded by whitespace
         else:
             s = ''
             i = 0
             while c != '\0' and i < 10:
                 s += c
                 i += 1
                 c = nextch()
             raise util.Abort(_('invalid character in dag description: '
                                '%s...') % s)
 
 def dagtextlines(events,
                  addspaces=True,
                  wraplabels=False,
                  wrapannotations=False,
                  wrapcommands=False,
                  wrapnonlinear=False,
                  usedots=False,
                  maxlinewidth=70):
     '''generates single lines for dagtext()'''
 
     def wrapstring(text):
         if re.match("^[0-9a-z]*$", text):
             return text
         return '"' + text.replace('\\', '\\\\').replace('"', '\"') + '"'
 
     def gen():
         labels = {}
         run = 0
         wantr = 0
         needroot = False
         for kind, data in events:
             if kind == 'n':
                 r, ps = data
 
                 # sanity check
                 if r != wantr:
                     raise util.Abort(_("expected id %i, got %i") % (wantr, r))
                 if not ps:
                     ps = [-1]
                 else:
                     for p in ps:
                         if p >= r:
                             raise util.Abort(_("parent id %i is larger than "
                                                "current id %i") % (p, r))
                 wantr += 1
 
                 # new root?
                 p1 = r - 1
                 if len(ps) == 1 and ps[0] == -1:
                     if needroot:
                         if run:
                             yield '+' + str(run)
                             run = 0
                         if wrapnonlinear:
                             yield '\n'
                         yield '$'
                         p1 = -1
                     else:
                         needroot = True
                 if len(ps) == 1 and ps[0] == p1:
                     if usedots:
                         yield "."
                     else:
                         run += 1
                 else:
                     if run:
                         yield '+' + str(run)
                         run = 0
                     if wrapnonlinear:
                         yield '\n'
                     prefs = []
                     for p in ps:
                         if p == p1:
                             prefs.append('')
                         elif p in labels:
                             prefs.append(labels[p])
                         else:
                             prefs.append(str(r - p))
                     yield '*' + '/'.join(prefs)
             else:
                 if run:
                     yield '+' + str(run)
                     run = 0
                 if kind == 'l':
                     rid, name = data
                     labels[rid] = name
                     yield ':' + name
                     if wraplabels:
                         yield '\n'
                 elif kind == 'c':
                     yield '!' + wrapstring(data)
                     if wrapcommands:
                         yield '\n'
                 elif kind == 'C':
                     yield '!!' + data
                     yield '\n'
                 elif kind == 'a':
                     if wrapannotations:
                         yield '\n'
                     yield '@' + wrapstring(data)
                 elif kind == '#':
                     yield '#' + data
                     yield '\n'
                 else:
                     raise util.Abort(_("invalid event type in dag: %s")
                                      % str((type, data)))
         if run:
             yield '+' + str(run)
 
     line = ''
     for part in gen():
         if part == '\n':
             if line:
                 yield line
                 line = ''
         else:
             if len(line) + len(part) >= maxlinewidth:
                 yield line
                 line = ''
             elif addspaces and line and part != '.':
                 line += ' '
             line += part
     if line:
         yield line
 
 def dagtext(dag,
             addspaces=True,
             wraplabels=False,
             wrapannotations=False,
             wrapcommands=False,
             wrapnonlinear=False,
             usedots=False,
             maxlinewidth=70):
     '''generates lines of a textual representation for a dag event stream
 
     events should generate what parsedag() does, so:
 
       ('n', (id, [parentids])) for node creation
       ('l', (id, labelname)) for labels on nodes
       ('a', text) for annotations
       ('c', text) for commands
       ('C', text) for line commands ('!!')
       ('#', text) for comment lines
 
     Parent nodes must come before child nodes.
 
     Examples
     --------
 
     Linear run:
 
         >>> dagtext([('n', (0, [-1])), ('n', (1, [0]))])
         '+2'
 
     Two roots:
 
         >>> dagtext([('n', (0, [-1])), ('n', (1, [-1]))])
         '+1 $ +1'
 
     Fork and join:
 
         >>> dagtext([('n', (0, [-1])), ('n', (1, [0])), ('n', (2, [0])),
         ...          ('n', (3, [2, 1]))])
         '+2 *2 */2'
 
     Fork and join with labels:
 
         >>> dagtext([('n', (0, [-1])), ('l', (0, 'f')), ('n', (1, [0])),
         ...          ('l', (1, 'p2')), ('n', (2, [0])), ('n', (3, [2, 1]))])
         '+1 :f +1 :p2 *f */p2'
 
     Annotations:
 
         >>> dagtext([('n', (0, [-1])), ('a', 'ann'), ('n', (1, [0]))])
         '+1 @ann +1'
 
         >>> dagtext([('n', (0, [-1])),
         ...          ('a', 'my annotation'),
         ...          ('n', (1, [0]))])
         '+1 @"my annotation" +1'
 
     Commands:
 
         >>> dagtext([('n', (0, [-1])), ('c', 'cmd'), ('n', (1, [0]))])
         '+1 !cmd +1'
 
         >>> dagtext([('n', (0, [-1])), ('c', 'my command'), ('n', (1, [0]))])
         '+1 !"my command" +1'
 
         >>> dagtext([('n', (0, [-1])),
         ...          ('C', 'my command line'),
         ...          ('n', (1, [0]))])
         '+1 !!my command line\\n+1'
 
     Comments:
 
         >>> dagtext([('n', (0, [-1])), ('#', ' comment'), ('n', (1, [0]))])
         '+1 # comment\\n+1'
 
         >>> dagtext([])
         ''
 
     Combining parsedag and dagtext:
 
         >>> dagtext(parsedag('+1 :f +1 :p2 *f */p2'))
         '+1 :f +1 :p2 *f */p2'
 
     '''
     return "\n".join(dagtextlines(dag,
                                   addspaces,
                                   wraplabels,
                                   wrapannotations,
                                   wrapcommands,
                                   wrapnonlinear,
                                   usedots,
                                   maxlinewidth))