emacs: lisp/textmodes/texinfmt.el comparison

comparison lisp/textmodes/texinfmt.el @ 81631:67d88e663c87

(texinfo-raisesections-alist, texinfo-lowersections-alist): Merge definition and declaration. (texinfo-start-of-header, texinfo-end-of-header): Remove. (texinfo-format-syntax-table): Merge init into declaration. (texinfo-format-parse-line-args, texinfo-format-parse-args) (texinfo-format-parse-defun-args, texinfo-format-node) (texinfo-push-stack, texinfo-multitable-widths) (texinfo-define-info-enclosure, texinfo-alias) (texinfo-format-defindex, batch-texinfo-format): Use push. (texinfo-footnote-number): Remove duplicate declaration.

author	Stefan Monnier <monnier@iro.umontreal.ca>
date	Wed, 27 Jun 2007 18:06:14 +0000
parents	e3694f1cb928
children	b98604865ea0 988f1edc9674

comparison

equal deleted inserted replaced

-:0eefd2198a9d
+:67d88e663c87
 ;;; Variable definitions
 (require 'texinfo)          ; So `texinfo-footnote-style' is defined.
 (require 'texnfo-upd)       ; So `texinfo-section-types-regexp' is defined.
-(defvar texinfo-format-syntax-table nil)
 (defvar texinfo-vindex)
 (defvar texinfo-findex)
 (defvar texinfo-cindex)
 (defvar texinfo-pindex)
 (defvar texinfo-tindex)
 (defvar texinfo-stack)
 (defvar texinfo-short-index-cmds-alist)
 (defvar texinfo-short-index-format-cmds-alist)
 (defvar texinfo-format-filename)
 (defvar texinfo-footnote-number)
-(defvar texinfo-start-of-header)
-(defvar texinfo-end-of-header)
+(defvar texinfo-raisesections-alist
-(defvar texinfo-raisesections-alist)
+'((@chapter . @chapter)             ; Cannot go higher
-(defvar texinfo-lowersections-alist)
+(@unnumbered . @unnumbered)
+(@centerchap . @unnumbered)
+(@majorheading . @majorheading)
+(@chapheading . @chapheading)
+(@appendix . @appendix)
+(@section . @chapter)
+(@unnumberedsec . @unnumbered)
+(@heading . @chapheading)
+(@appendixsec . @appendix)
+(@subsection . @section)
+(@unnumberedsubsec . @unnumberedsec)
+(@subheading . @heading)
+(@appendixsubsec . @appendixsec)
+(@subsubsection . @subsection)
+(@unnumberedsubsubsec . @unnumberedsubsec)
+(@subsubheading . @subheading)
+(@appendixsubsubsec . @appendixsubsec))
+"*An alist of next higher levels for chapters, sections, etc...
+For example, section to chapter, subsection to section.
+Used by `texinfo-raise-lower-sections'.
+The keys specify types of section; the values correspond to the next
+higher types.")
+(defvar texinfo-lowersections-alist
+'((@chapter . @section)
+(@unnumbered . @unnumberedsec)
+(@centerchap . @unnumberedsec)
+(@majorheading . @heading)
+(@chapheading . @heading)
+(@appendix . @appendixsec)
+(@section . @subsection)
+(@unnumberedsec . @unnumberedsubsec)
+(@heading . @subheading)
+(@appendixsec . @appendixsubsec)
+(@subsection . @subsubsection)
+(@unnumberedsubsec . @unnumberedsubsubsec)
+(@subheading . @subsubheading)
+(@appendixsubsec . @appendixsubsubsec)
+(@subsubsection . @subsubsection) ; Cannot go lower.
+(@unnumberedsubsubsec . @unnumberedsubsubsec)
+(@subsubheading . @subsubheading)
+(@appendixsubsubsec . @appendixsubsubsec))
+"*An alist of next lower levels for chapters, sections, etc...
+For example, chapter to section, section to subsection.
+Used by `texinfo-raise-lower-sections'.
+The keys specify types of section; the values correspond to the next
+lower types.")
 ;;; Syntax table
-(if texinfo-format-syntax-table
+(defvar texinfo-format-syntax-table
-nil
+(let ((st (make-syntax-table)))
-(setq texinfo-format-syntax-table (make-syntax-table))
+(modify-syntax-entry ?\" " " st)
-(modify-syntax-entry ?\" " " texinfo-format-syntax-table)
+(modify-syntax-entry ?\\ " " st)
-(modify-syntax-entry ?\\ " " texinfo-format-syntax-table)
+(modify-syntax-entry ?@ "\\" st)
-(modify-syntax-entry ?@ "\\" texinfo-format-syntax-table)
+(modify-syntax-entry ?\^q "\\" st)
-(modify-syntax-entry ?\^q "\\" texinfo-format-syntax-table)
+(modify-syntax-entry ?\[ "." st)
-(modify-syntax-entry ?\[ "." texinfo-format-syntax-table)
+(modify-syntax-entry ?\] "." st)
-(modify-syntax-entry ?\] "." texinfo-format-syntax-table)
+(modify-syntax-entry ?\( "." st)
-(modify-syntax-entry ?\( "." texinfo-format-syntax-table)
+(modify-syntax-entry ?\) "." st)
-(modify-syntax-entry ?\) "." texinfo-format-syntax-table)
+(modify-syntax-entry ?{ "(}" st)
-(modify-syntax-entry ?{ "(}" texinfo-format-syntax-table)
+(modify-syntax-entry ?} "){" st)
-(modify-syntax-entry ?} "){" texinfo-format-syntax-table)
+(modify-syntax-entry ?\' "." st)
-(modify-syntax-entry ?\' "." texinfo-format-syntax-table))
+st))
 ;;; Top level buffer and region formatting functions
 ;;;###autoload
 "Process the current buffer as texinfo code, into an Info file.
 The Info file output is generated in a buffer visiting the Info file
 name specified in the @setfilename command.
 Non-nil argument (prefix, if interactive) means don't make tag table
-and don't split the file if large.  You can use Info-tagify and
+and don't split the file if large.  You can use `Info-tagify' and
-Info-split to do these manually."
+`Info-split' to do these manually."
 (interactive "P")
 (let ((lastmessage "Formatting Info file...")
 	(coding-system-for-write buffer-file-coding-system))
 (message lastmessage)
 (widen)
 creates a master menu.  This work is done on a temporary buffer that
 is automatically removed when the Info file is created.  The original
 Texinfo source buffer is not changed.
 Non-nil argument (prefix, if interactive) means don't split the file
-if large.  You can use Info-split to do this manually."
+if large.  You can use `Info-split' to do this manually."
 (interactive "P")
 (let ((temp-buffer (concat  "*--" (buffer-name) "--temporary-buffer*" )))
 (message "First updating nodes and menus, then creating Info file.")
 ;;  (sit-for 2)
 (copy-to-buffer temp-buffer (point-min) (point-max))
 (setq new-level
 (cdr (assq new-level texinfo-lowersections-alist)))
 (setq count (1+ count)))
 (kill-word 1)
 (insert (symbol-name new-level))))))))))
-(defvar texinfo-raisesections-alist
-'((@chapter . @chapter)             ; Cannot go higher
-(@unnumbered . @unnumbered)
-(@centerchap . @unnumbered)
-(@majorheading . @majorheading)
-(@chapheading . @chapheading)
-(@appendix . @appendix)
-(@section . @chapter)
-(@unnumberedsec . @unnumbered)
-(@heading . @chapheading)
-(@appendixsec . @appendix)
-(@subsection . @section)
-(@unnumberedsubsec . @unnumberedsec)
-(@subheading . @heading)
-(@appendixsubsec . @appendixsec)
-(@subsubsection . @subsection)
-(@unnumberedsubsubsec . @unnumberedsubsec)
-(@subsubheading . @subheading)
-(@appendixsubsubsec . @appendixsubsec))
-"*An alist of next higher levels for chapters, sections. etc.
-For example, section to chapter, subsection to section.
-Used by `texinfo-raise-lower-sections'.
-The keys specify types of section; the values correspond to the next
-higher types.")
-(defvar texinfo-lowersections-alist
-'((@chapter . @section)
-(@unnumbered . @unnumberedsec)
-(@centerchap . @unnumberedsec)
-(@majorheading . @heading)
-(@chapheading . @heading)
-(@appendix . @appendixsec)
-(@section . @subsection)
-(@unnumberedsec . @unnumberedsubsec)
-(@heading . @subheading)
-(@appendixsec . @appendixsubsec)
-(@subsection . @subsubsection)
-(@unnumberedsubsec . @unnumberedsubsubsec)
-(@subheading . @subsubheading)
-(@appendixsubsec . @appendixsubsubsec)
-(@subsubsection . @subsubsection) ; Cannot go lower.
-(@unnumberedsubsubsec . @unnumberedsubsubsec)
-(@subsubheading . @subsubheading)
-(@appendixsubsubsec . @appendixsubsubsec))
-"*An alist of next lower levels for chapters, sections. etc.
-For example, chapter to section, section to subsection.
-Used by `texinfo-raise-lower-sections'.
-The keys specify types of section; the values correspond to the next
-lower types.")
 ;;; Perform those texinfo-to-info conversions that apply to the whole input
 ;;; uniformly.
 (defun texinfo-format-scan ()
 (setq next (point))
 (if (bolp) (setq next (1- next)))
 (forward-char -1)
 (skip-chars-backward " ")
 (setq end (point))
-(setq args (cons (if (> end beg) (buffer-substring-no-properties beg end))
+(push (if (> end beg) (buffer-substring-no-properties beg end))
-args))
+args)
 (goto-char next)
 (skip-chars-forward " "))
 (if (eolp) (forward-char 1))
 (setq texinfo-command-end (point))
 (nreverse args)))
 (setq end (point))
 (cond ((< beg end)
 (goto-char beg)
 (while (search-forward "\n" end t)
 (replace-match " "))))
-(setq args (cons (if (> end beg) (buffer-substring-no-properties beg end))
+(push (if (> end beg) (buffer-substring-no-properties beg end))
-args))
+args)
 (goto-char next))
 ;;(if (eolp) (forward-char 1))
 (setq texinfo-command-end (point))
 (nreverse args)))
 (t
 (setq beg (point))
 (re-search-forward "[\n ]")
 (forward-char -1)
 (setq end (point))))
-(setq args (cons (buffer-substring-no-properties beg end) args))
+(push (buffer-substring-no-properties beg end) args)
 (skip-chars-forward " "))
 (forward-char 1)
 (nreverse args))))
 (defun texinfo-discard-line ()
 (texinfo-discard-command)
 (setq texinfo-last-node name)
 (let ((tem (if texinfo-fold-nodename-case (downcase name) name)))
 (if (assoc tem texinfo-node-names)
 (error "Duplicate node name: %s" name)
-(setq texinfo-node-names (cons (list tem) texinfo-node-names))))
+(push (list tem) texinfo-node-names)))
 (setq texinfo-footnote-number 0)
 ;; insert "\n\^_" unconditionally since this is what info is looking for
 (insert "\n\^_\nFile: " texinfo-format-filename
 ", Node: " name)
 (if next
 (put 'footnotestyle 'texinfo-format 'texinfo-footnotestyle)
 (defun texinfo-footnotestyle ()
 "Specify whether footnotes are at end of node or in separate nodes.
 Argument is either end or separate."
 (setq texinfo-footnote-style (texinfo-parse-arg-discard)))
-(defvar texinfo-footnote-number)
 (put 'footnote 'texinfo-format 'texinfo-format-footnote)
 (defun texinfo-format-footnote ()
 "Format a footnote in either end of node or separate node style.
 The   texinfo-footnote-style  variable controls which style is used."
 "Count of number of unpopped texinfo-push-stack calls.
 Used by @refill indenting command to avoid indenting within lists, etc.")
 (defun texinfo-push-stack (check arg)
 (setq texinfo-stack-depth (1+ texinfo-stack-depth))
-(setq texinfo-stack
+(push (list check arg texinfo-command-start)
-(cons (list check arg texinfo-command-start)
+texinfo-stack))
-texinfo-stack)))
 (defun texinfo-pop-stack (check)
 (setq texinfo-stack-depth (1- texinfo-stack-depth))
 (if (null texinfo-stack)
 (error "Unmatched @end %s" check))
 @item  A1  @tab  A2  @tab  A3
 @item  B1  @tab  B2  @tab  B3
 @end multitable
 where the fractions specify the width of each column as a percent
-of the current width of the text (i.e., of the fill-column).
+of the current width of the text (i.e., of the `fill-column').
 Long lines of text are filled within columns.
 Using the Emacs Lisp formatter, texinfmt.el,
 the whitespace between columns can be increased by setting
 (error "In @multitable, @columnfractions misspelled"))
 ;; Case 1: @columnfractions .25 .3 .45
 ((looking-at "@columnfractions")
 (forward-word 1)
 (while (not (eolp))
-(setq texinfo-multitable-width-list
+(push (truncate
-(cons
+(1-
-(truncate
+(* fill-column (read (get-buffer (current-buffer))))))
-(1-
+texinfo-multitable-width-list)))
-(* fill-column (read (get-buffer (current-buffer))))))
-texinfo-multitable-width-list))))
 ;;
 ;; Case 2: {Column 1 template} {Column 2} {Column 3 example}
 ((looking-at "{")
 (let ((start-of-templates (point)))
 (while (not (eolp))
 (skip-chars-forward " \t")
 (let* ((start-of-template (1+ (point)))
 (end-of-template
 ;; forward-sexp works with braces in Texinfo mode
 (progn (forward-sexp 1) (1- (point)))))
-(setq texinfo-multitable-width-list
+(push (- end-of-template start-of-template)
-(cons (- end-of-template start-of-template)
+texinfo-multitable-width-list)
-texinfo-multitable-width-list))
 ;; Remove carriage return from within a template, if any.
 ;; This helps those those who want to use more than
 ;; one line's worth of words in @multitable line.
 (narrow-to-region start-of-template end-of-template)
 (goto-char (point-min))
 (let* ((args (texinfo-format-parse-line-args))
 (command-name (nth 0 args))
 (beginning-delimiter (or (nth 1 args) ""))
 (end-delimiter (or (nth 2 args) "")))
 (texinfo-discard-command)
-(setq texinfo-enclosure-list
+(push (list command-name
-(cons
+(list
-(list command-name
+beginning-delimiter
-(list
+end-delimiter))
-beginning-delimiter
+texinfo-enclosure-list)))
-end-delimiter))
-texinfo-enclosure-list))))
 ;;; @alias
 (put 'alias 'texinfo-format 'texinfo-alias)
 args)
 (skip-chars-forward " ")
 (save-excursion (end-of-line) (setq texinfo-command-end (point)))
 (if (not (looking-at "\\([^=]+\\)=\\(.*\\)"))
 	(error "Invalid alias command")
-(setq texinfo-alias-list
+(push (cons
-	    (cons
+(match-string-no-properties 1)
-	     (cons
+(match-string-no-properties 2))
-	      (match-string-no-properties 1)
+texinfo-alias-list)
-	      (match-string-no-properties 2))
-	     texinfo-alias-list))
 (texinfo-discard-command))
 )
 )
 "example\\|"
 "smallexample\\|"
 "lisp\\|"
 "smalllisp"
 "\\)")
-"Regexp specifying environments in which @kbd does not put `...'
+"Regexp matching environments in which @kbd does not put `...' around arg.")
-around argument.")
 (defvar texinfo-format-kbd-end-regexp
 (concat
 "^@end "
 "\\("
 "smallexample\\|"
 "lisp\\|"
 "smalllisp"
 "\\)")
 "Regexp specifying end of environments in which @kbd does not put `...'
 around argument. (See `texinfo-format-kbd-regexp')")
 (put 'kbd 'texinfo-format 'texinfo-format-kbd)
 (defun texinfo-format-kbd ()
 "Place single quote marks around arg, except in @example and similar."
 ;; Search forward for @end example closer than an @example.
 (insert "#"))
 ;;; Refilling and indenting:  @refill, @paragraphindent, @noindent
-;;; Indent only those paragraphs that are refilled as a result of an
+;; Indent only those paragraphs that are refilled as a result of an
-;;; @refill command.
+;; @refill command.
 ;;    * If the value is `asis', do not change the existing indentation at
 ;;      the starts of paragraphs.
 ;;    * If the value zero, delete any existing indentation.
 ;;    * If the value is greater than zero, indent each paragraph by that
 ;;      number of spaces.
-;;; But do not refill paragraphs with an @refill command that are
+;; But do not refill paragraphs with an @refill command that are
-;;; preceded by @noindent or are part of a table, list, or deffn.
+;; preceded by @noindent or are part of a table, list, or deffn.
 (defvar texinfo-paragraph-indent "asis"
 "Number of spaces for @refill to indent a paragraph; else to leave as is.")
 (put 'paragraphindent 'texinfo-format 'texinfo-paragraphindent)
 (setq texinfo-paragraph-indent "asis")
 (setq texinfo-paragraph-indent (string-to-number arg)))))
 (put 'refill 'texinfo-format 'texinfo-format-refill)
 (defun texinfo-format-refill ()
-"Refill paragraph. Also, indent first line as set by @paragraphindent.
+"Refill paragraph.  Also, indent first line as set by @paragraphindent.
 Default is to leave paragraph indentation as is."
 (texinfo-discard-command)
 (let ((position (point-marker)))
 (forward-paragraph -1)
 (if (looking-at "[ \t\n]*$") (forward-line 1))
 'texinfo-format
 index-formatting-command)      ; eg, texinfo-format-aaindex
 ;; eg: "aa" . texinfo-aaindex
 (or (assoc index-name texinfo-indexvar-alist)
-(setq texinfo-indexvar-alist
+(push (cons index-name
-(cons
+index-alist-name)
-(cons index-name
+texinfo-indexvar-alist))
-index-alist-name)
-texinfo-indexvar-alist)))
 (fset index-formatting-command
 (list 'lambda 'nil
 (list 'texinfo-index
 (list 'quote index-alist-name))))))
 (insert (format "{No value for \"%s\"}"  arg))))))
 (put 'ifset 'texinfo-end 'texinfo-discard-command)
 (put 'ifset 'texinfo-format 'texinfo-if-set)
 (defun texinfo-if-set ()
-"If set, continue formatting; else do not format region up to @end ifset"
+"If set, continue formatting; else do not format region up to @end ifset."
 (let ((arg (texinfo-parse-arg-discard)))
 (cond
 ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
 'flag-set)
 ;; Format the text (i.e., do not remove it); do nothing here.
 ()))))
 (put 'ifclear 'texinfo-end 'texinfo-discard-command)
 (put 'ifclear 'texinfo-format 'texinfo-if-clear)
 (defun texinfo-if-clear ()
-"If clear, continue formatting; if set, do not format up to @end ifset"
+"If clear, continue formatting; if set, do not format up to @end ifset."
 (let ((arg (texinfo-parse-arg-discard)))
 (cond
 ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
 'flag-set)
 ;; Clear region (i.e., cause the text to be ignored).
 (buffer-substring-no-properties texinfo-command-start texinfo-command-end)))
 ;;; Batch formatting
 (defun batch-texinfo-format ()
-"Runs  texinfo-format-buffer  on the files remaining on the command line.
+"Run `texinfo-format-buffer' on the files remaining on the command line.
 Must be used only with -batch, and kills Emacs on completion.
 Each file will be processed even if an error occurred previously.
 For example, invoke
 \"emacs -batch -funcall batch-texinfo-format $docs/ ~/*.texinfo\"."
 (if (not noninteractive)
 ((file-directory-p file)
 (setq command-line-args-left
 (nconc (directory-files file)
 (cdr command-line-args-left))))
 (t
-(setq files (cons file files)
+(push file files)
-command-line-args-left (cdr command-line-args-left)))))
+(setq command-line-args-left (cdr command-line-args-left)))))
 (while files
 (setq file (car files)
 files (cdr files))
 (condition-case err
 (progn
 ;;; Place `provide' at end of file.
 (provide 'texinfmt)
-;;; arch-tag: 1e8d9a2d-bca0-40a0-ac6c-dab01bc6f725
+;; arch-tag: 1e8d9a2d-bca0-40a0-ac6c-dab01bc6f725
 ;;; texinfmt.el ends here

Mercurial > emacs

comparison lisp/textmodes/texinfmt.el @ 81631:67d88e663c87