emacs: lisp/woman.el comparison

comparison lisp/woman.el @ 90796:4ef881a120fe

Merge from emacs--devo--0 Patches applied: * emacs--devo--0 (patch 675-697) - Update from CVS - Merge from gnus--rel--5.10 - Release ERC 5.2. * gnus--rel--5.10 (patch 211-215) - Update from CVS - Merge from emacs--devo--0 Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-189

author	Miles Bader <miles@gnu.org>
date	Wed, 11 Apr 2007 00:17:47 +0000
parents	c0409ee15cee 5ca8f461a8b1
children	f55f9811f5d7

comparison

equal deleted inserted replaced

-:b9182b6a90c9
+:4ef881a120fe
 (lambda (x) (if x (list x) (woman-parse-man.conf)))
 (parse-colon-path (or paths "")))))
 (defun woman-Cyg-to-Win (file)
 "Convert an absolute filename FILE from Cygwin to Windows form."
-;; Code taken from w32-symlinks.el
+;; MANPATH_MAP conses are not converted since they presumably map
-(if (eq (aref file 0) ?/)
+;; Cygwin to Cygwin form.
-;; Try to use Cygwin mount table via `cygpath.exe'.
+(if (consp file)
-(condition-case nil
+file
-	  (with-temp-buffer
+;; Code taken from w32-symlinks.el
-	    ;; cygpath -m file
+(if (eq (aref file 0) ?/)
-	    (call-process "cygpath" nil t nil "-m" file)
+	;; Try to use Cygwin mount table via `cygpath.exe'.
-	    (buffer-substring 1 (buffer-size)))
+	(condition-case nil
-	(error
+	    (with-temp-buffer
-	 ;; Assume no `cygpath' program available.
+	      ;; cygpath -m file
-	 ;; Hack /cygdrive/x/ or /x/ or (obsolete) //x/ to x:/
+	      (call-process "cygpath" nil t nil "-m" file)
-	 (when (string-match "\\`\\(/cygdrive\\|/\\)?/./" file)
+	      (buffer-substring 1 (buffer-size)))
-	   (if (match-string 1)		; /cygdrive/x/ or //x/ -> /x/
+	  (error
-	       (setq file (substring file (match-end 1))))
+	   ;; Assume no `cygpath' program available.
-	   (aset file 0 (aref file 1))	; /x/ -> xx/
+	   ;; Hack /cygdrive/x/ or /x/ or (obsolete) //x/ to x:/
-	   (aset file 1 ?:))		; xx/ -> x:/
+	   (when (string-match "\\`\\(/cygdrive\\|/\\)?/./" file)
-	 file))
+	     (if (match-string 1)		; /cygdrive/x/ or //x/ -> /x/
-file))
+		 (setq file (substring file (match-end 1))))
+	     (aset file 0 (aref file 1))	; /x/ -> xx/
+	     (aset file 1 ?:))		; xx/ -> x:/
+	   file))
+file)))
 ;;; User options:
 ;; NB: Group identifiers must be lowercase!
 (let ((path '("/usr/lib" "/etc")))
 (if (eq system-type 'windows-nt)
 	(mapcar 'woman-Cyg-to-Win path)
 path))
 "*List of dirs to search and/or files to try for man config file.
-A trailing separator (`/' for UNIX etc.) on directories is optional,
+A trailing separator (`/' for UNIX etc.) on directories is
-and the filename is used if a directory specified is the first to
+optional, and the filename is used if a directory specified is
-contain the strings \"man\" and \".conf\" (in that order).
+the first to start with \"man\" and has an extension starting
-If MANPATH is not set but a config file is found then it is parsed
+with \".conf\".  If MANPATH is not set but a config file is found
-instead to provide a default value for `woman-manpath'."
+then it is parsed instead to provide a default value for
+`woman-manpath'."
 :type '(repeat string)
 :group 'woman-interface)
 (defun woman-parse-man.conf ()
 "Parse if possible configuration file for man command.
 Concatenate data from all lines in the config file of the form
 MANPATH  /usr/man
 or
 MANDATORY_MANPATH  /usr/man
 or
-OPTIONAL_MANPATH  /usr/man"
+OPTIONAL_MANPATH  /usr/man
+or
+MANPATH_MAP /opt/bin /opt/man"
 ;; Functionality suggested by Charles Curley.
 (let ((path woman-man.conf-path)
 	file manpath)
 (while (and
 	    path
 		  (file-readable-p (setq file (car path)))
 		  ;; If not a file then find the file:
 		  (or (not (file-directory-p file))
 		      (and
 		       (setq file
-			     (directory-files file t "man.*\\.conf" t))
+			     (directory-files file t "\\`man.*\\.conf[a-z]*\\'" t))
 		       (file-readable-p (setq file (car file)))))
 		  ;; Parse the file -- if no MANPATH data ignore it:
 		  (with-temp-buffer
 		    (insert-file-contents file)
 		    (while (re-search-forward
 			    ;; `\(?: ... \)' is a "shy group"
 			    "\
-^[ \t]*\\(?:MANDATORY_\\|OPTIONAL_\\)?MANPATH[ \t]+\\(\\S-+\\)" nil t)
+^[ \t]*\\(?:\\(?:MANDATORY_\\|OPTIONAL_\\)?MANPATH[ \t]+\\(\\S-+\\)\\|\
-		      (setq manpath (cons (match-string 1) manpath)))
+MANPATH_MAP[ \t]+\\(\\S-+\\)[ \t]+\\(\\S-+\\)\\)" nil t)
+		      (add-to-list 'manpath
+				   (if (match-beginning 1)
+				       (match-string 1)
+				     (cons (match-string 2)
+					   (match-string 3)))))
 		    manpath))
 		 ))
 (setq path (cdr path)))
 (nreverse manpath)))
 Each element should be the name of a directory that contains
 subdirectories of the form `man?', or more precisely subdirectories
 selected by the value of `woman-manpath-man-regexp'.  Non-directory
 and unreadable files are ignored.
+Elements can also be a cons cell indicating a mapping from PATH
+to manual trees: if such an element's car is equal to a path
+element of the environment variable PATH, the cdr of the cons
+cell is included in the directory tree search.
 If not set then the environment variable MANPATH is used.  If no such
 environment variable is found, the default list is determined by
 consulting the man configuration file if found, which is determined by
 the user option `woman-man.conf-path'.  An empty substring of MANPATH
 denotes the default list.
 (\"C:/Cygwin/usr/man/\" \"C:/Cygwin/usr/local/man\").
 The MANPATH environment variable may be set using DOS semi-colon-
 separated or UN*X/Cygwin colon-separated syntax (but not mixed)."
-:type '(repeat string)
+:type '(repeat (choice string (cons string string)))
 :group 'woman-interface)
 (defcustom woman-manpath-man-regexp "[Mm][Aa][Nn]"
 "Regexp to match man directories UNDER `woman-manpath' directories.
 These normally have names of the form `man?'.  Its default value is
 (defun woman-cached-data ()
 "Generate a list of data used to determine cache validity.
 Called both to generate and to check the cache!"
 ;; Must use substituted paths because values of env vars may change!
 (list woman-cache-level
-	(mapcar 'substitute-in-file-name woman-manpath)
+	(let (lst path)
+	  (dolist (dir woman-manpath (nreverse lst))
+	    (when (consp dir)
+	      (unless path
+		(setq path
+		      (split-string (getenv "PATH") path-separator t)))
+	      (setq dir (and (member (car dir) path) (cdr dir))))
+	    (when dir (add-to-list 'lst (substitute-in-file-name dir)))))
 	(mapcar 'substitute-in-file-name woman-path)))
 (defun woman-read-directory-cache ()
 "Load the directory and topic cache.
 It is loaded from the file named by the variable `woman-cache-filename'.
 WOMAN-PATH should be a list of specific manual directory regexps.
 Ignore any paths that are unreadable or not directories."
 ;; Allow each path to be a single string or a list of strings:
 (if (not (listp woman-manpath)) (setq woman-manpath (list woman-manpath)))
 (if (not (listp woman-path)) (setq woman-path (list woman-path)))
-(let (dir head dirs)
+(let (dir head dirs path)
 (while woman-manpath
 (setq dir (car woman-manpath)
 	    woman-manpath (cdr woman-manpath))
+(when (consp dir)
+	(unless path
+	  (setq path (split-string (getenv "PATH") path-separator t)))
+	(setq dir (and (member (car dir) path)
+		       (cdr dir))))
 (if (and dir (woman-file-readable-p dir))
 	  ;; NB: `parse-colon-path' creates null elements for
 	  ;; redundant (semi-)colons and trailing `/'s!
 	  ;; If does not actually matter here if dir ends with `/'.
 	  ;; Need regexp "man" here to avoid "cat?", `.', `..', etc.
 "Decode a buffer in UN*X man-page source format.
 No external programs are used."
 (interactive)				; mainly for testing
 (WoMan-log-begin)
 (run-hooks 'woman-pre-format-hook)
-;; look for macro sets that woman cannot handle:
-(goto-char (point-min))
-(let ((case-fold-search nil))
-(unless (and (re-search-forward "^\\.SH[ \n]" (point-max) t)
-		 (progn (goto-char (point-min))
-			(re-search-forward "^\\.TH[ \n]" (point-max) t))
-		 (progn (goto-char (point-min))
-			(not (re-search-forward "^\\.\\([pnil]p\\|sh\\)[ \n]"
-						(point-max) t))))
-(error "WoMan can only format man pages written with the usual `-man' macros")))
 (and (boundp 'font-lock-mode) font-lock-mode (font-lock-mode -1))
 ;; (fundamental-mode)
 (let ((start-time (current-time))	; (HIGH LOW MICROSEC)
 	time)				; HIGH * 2**16 + LOW seconds
 (message "WoMan formatting buffer...")
 (woman-pre-process-region from nil)
 ;; Process ignore requests, macro definitions,
 ;; conditionals and switch source requests:
 (woman0-roff-buffer from)
+;; Check for macro sets that woman cannot handle.  We can only
+;; because do this after processing source-switch directives.
+(goto-char (point-min))
+(let ((case-fold-search nil))
+(unless (and (re-search-forward "^\\.SH[ \n]" (point-max) t)
+		   (progn (goto-char (point-min))
+			  (re-search-forward "^\\.TH[ \n]" (point-max) t))
+		   (progn (goto-char (point-min))
+			  (not (re-search-forward "^\\.\\([pnil]p\\|sh\\)[ \n]"
+						  (point-max) t))))
+	(error "WoMan can only format man pages written with the usual `-man' macros")))
 ;; Process \k escapes BEFORE changing tab width (?):
 (goto-char from)
 (woman-mark-horizonal-position)

Mercurial > emacs

comparison lisp/woman.el @ 90796:4ef881a120fe