yatex

annotate yatexenv.el @ 239:5de195a540c7

find changesets by author, revision, files, or words in the commit message
YaTeX-intelligent-newline-document recognizes \par lover.
author yuuji@gentei.org
date Sun, 29 Jan 2012 17:29:02 +0900
parents 5260b7ee9fdf
children 5ab3322d0f03
rev   line source
yuuji@23 1 ;;; -*- Emacs-Lisp -*-
yuuji@23 2 ;;; YaTeX environment-specific functions.
yuuji@23 3 ;;; yatexenv.el
yuuji@80 4 ;;; (c) 1994-2006 by HIROSE Yuuji.[yuuji@yatex.org]
yuuji@239 5 ;;; Last modified Sun Jan 29 17:23:40 2012 on firestorm
yuuji@23 6 ;;; $Id$
yuuji@23 7
yuuji@23 8 ;;;
yuuji@23 9 ;; Functions for tabular environment
yuuji@23 10 ;;;
yuuji@23 11
yuuji@23 12 ;; Showing the matching column of tabular environment.
yuuji@80 13 (defun YaTeX-array-what-column-internal ()
yuuji@80 14 "Return the cons of matching column and its title of array environment.
yuuji@23 15 When calling from a program, make sure to be in array/tabular environment."
yuuji@49 16 (let ((p (point)) beg eot bor (nlptn "\\\\\\\\") (andptn "[^\\]&")
yuuji@49 17 (n 0) j
yuuji@23 18 (firsterr "This line might be the first row."))
yuuji@23 19 (save-excursion
yuuji@23 20 (YaTeX-beginning-of-environment)
yuuji@23 21 (search-forward "{" p) (up-list 1)
yuuji@23 22 (search-forward "{" p) (up-list 1)
yuuji@23 23 ;;(re-search-forward andptn p)
yuuji@23 24 (while (progn (search-forward "&" p)
yuuji@23 25 (equal (char-after (1- (match-beginning 0))) ?\\ )))
yuuji@23 26 (setq beg (1- (point))) ;beg is the point of the first &
yuuji@23 27 (or (re-search-forward nlptn p t)
yuuji@23 28 (error firsterr))
yuuji@23 29 (setq eot (point)) ;eot is the point of the first \\
yuuji@23 30 (goto-char p)
yuuji@23 31 (or (re-search-backward nlptn beg t)
yuuji@23 32 (error firsterr))
yuuji@23 33 (setq bor (point)) ;bor is the beginning of this row.
yuuji@23 34 (while (< (1- (point)) p)
yuuji@23 35 (if (equal (following-char) ?&)
yuuji@23 36 (forward-char 1)
yuuji@23 37 (re-search-forward andptn nil 1))
yuuji@23 38 (setq n (1+ n))) ;Check current column number
yuuji@23 39 (goto-char p)
yuuji@23 40 (cond ;Start searching \multicolumn{N}
yuuji@23 41 ((> n 1)
yuuji@23 42 (re-search-backward andptn) ;Sure to find!
yuuji@23 43 (while (re-search-backward "\\\\multicolumn{\\([0-9]+\\)}" bor t)
yuuji@23 44 (setq n (+ n (string-to-int
yuuji@23 45 (buffer-substring (match-beginning 1)
yuuji@23 46 (match-end 1)))
yuuji@23 47 -1)))))
yuuji@23 48 (message "%s" n)
yuuji@23 49 (goto-char (1- beg))
yuuji@59 50 (beginning-of-line)
yuuji@49 51 (setq j n)
yuuji@49 52 (while (> j 1)
yuuji@49 53 (or (re-search-forward andptn p nil)
yuuji@49 54 (error "This column exceeds the limit."))
yuuji@49 55 (setq j (1- j)))
yuuji@49 56 (skip-chars-forward "\\s ")
yuuji@80 57 (list n
yuuji@80 58 (buffer-substring
yuuji@80 59 (point)
yuuji@80 60 (progn
yuuji@80 61 (re-search-forward (concat andptn "\\|" nlptn) eot)
yuuji@80 62 (goto-char (match-beginning 0))
yuuji@80 63 (if (looking-at andptn)
yuuji@80 64 (forward-char 1))
yuuji@80 65 (skip-chars-backward "\\s ")
yuuji@80 66 (point)))))))
yuuji@80 67
yuuji@80 68 (defun YaTeX-array-what-column ()
yuuji@80 69 "Show matching column title of array environment.
yuuji@80 70 When calling from a program, make sure to be in array/tabular environment."
yuuji@80 71 (apply 'message
yuuji@80 72 "This is the column(#%d) of: %s"
yuuji@80 73 (YaTeX-array-what-column-internal)))
yuuji@23 74
yuuji@23 75 ;;;###autoload
yuuji@23 76 (defun YaTeX-what-column ()
yuuji@23 77 "Show which kind of column the current position is belonging to."
yuuji@23 78 (interactive)
yuuji@23 79 (cond
yuuji@23 80 ((YaTeX-quick-in-environment-p '("tabular" "tabular*" "array" "array*"))
yuuji@23 81 (YaTeX-array-what-column))
yuuji@80 82 (t (message "Not in array/tabular environment."))))
yuuji@23 83
yuuji@80 84 (defun YaTeX-tabular-parse-format-count-cols (beg end)
yuuji@80 85 (goto-char beg)
yuuji@80 86 (let (elt (cols 0))
yuuji@80 87 (while (< (point) end)
yuuji@31 88 (setq elt (following-char))
yuuji@31 89 (cond
yuuji@31 90 ((string-match (char-to-string elt) "clr") ;normal indicators.
yuuji@31 91 (setq cols (1+ cols))
yuuji@31 92 (forward-char 1))
yuuji@31 93 ((equal elt ?|) ;vertical
yuuji@31 94 (forward-char 1))
yuuji@31 95 ((string-match (char-to-string elt) "p@") ;p or @ expression
yuuji@31 96 (setq cols (+ (if (eq elt ?p) 1 0) cols))
yuuji@80 97 ;;(skip-chars-forward "^{" p)
yuuji@80 98 (skip-chars-forward "^{" end)
yuuji@56 99 (forward-list 1))
yuuji@80 100 ((equal elt ?*) ;*{N}{EXP} -> Repeat EXP N times
yuuji@80 101 (skip-chars-forward "^{" end)
yuuji@80 102 (setq cols (* (string-to-int
yuuji@80 103 (buffer-substring
yuuji@80 104 (1+ (point))
yuuji@80 105 (progn (forward-list 1) (1- (point)))))
yuuji@80 106 (YaTeX-tabular-parse-format-count-cols
yuuji@80 107 (progn (skip-chars-forward "^{" end) (1+ (point)))
yuuji@80 108 (progn (forward-list 1) (1- (point)))))))
yuuji@56 109 (t (forward-char 1)) ;unknown char
yuuji@56 110 ))
yuuji@80 111 cols))
yuuji@80 112
yuuji@80 113 (defun YaTeX-tabular-parse-format (&optional type)
yuuji@80 114 "Parse `tabular' format.
yuuji@80 115 Return the list of (No.ofCols PointEndofFormat)"
yuuji@80 116 (let ((p (point)) boform eoform (cols 0))
yuuji@80 117 (save-excursion
yuuji@80 118 (if (null (YaTeX-beginning-of-environment t))
yuuji@80 119 (error "Beginning of tabular not found."))
yuuji@80 120 (skip-chars-forward "^{")
yuuji@80 121 (forward-list 1)
yuuji@80 122 (cond
yuuji@80 123 ((eq type 'tabular*)
yuuji@80 124 (skip-chars-forward "^{")
yuuji@80 125 (forward-list 1)))
yuuji@80 126 (skip-chars-forward "^{" p)
yuuji@80 127 (if (/= (following-char) ?\{) (error "Tabular format not found."))
yuuji@80 128 (setq boform (1+ (point))
yuuji@80 129 eoform (progn (forward-list 1) (1- (point))))
yuuji@80 130 (if (> eoform p) (error "Non-terminated tabular format."))
yuuji@80 131 (goto-char boform)
yuuji@80 132 (setq cols
yuuji@80 133 (cond
yuuji@80 134 ((eq type 'alignat)
yuuji@80 135 (max
yuuji@80 136 1
yuuji@80 137 (1-
yuuji@80 138 (* 2
yuuji@80 139 (string-to-int
yuuji@80 140 (buffer-substring
yuuji@80 141 (point)
yuuji@80 142 (progn (up-list -1) (forward-list 1) (1- (point)))))))))
yuuji@80 143 (t
yuuji@80 144 (YaTeX-tabular-parse-format-count-cols (point) eoform))))
yuuji@80 145 (list cols (1+ eoform)))))
yuuji@80 146
yuuji@31 147 ;; Insert &
yuuji@80 148 (defun YaTeX-intelligent-newline-tabular (&optional type)
yuuji@31 149 "Parse current tabular format and insert that many `&'s."
yuuji@80 150 (let*((p (point)) (format (YaTeX-tabular-parse-format type))
yuuji@31 151 (cols (car format)) (beg (car (cdr format)))
yuuji@31 152 space hline)
yuuji@58 153 (cond
yuuji@58 154 ((search-backward "&" beg t)
yuuji@58 155 (goto-char p)
yuuji@58 156 (setq hline (search-backward "\\hline" beg t))
yuuji@58 157 (setq space (if (search-backward "\t&" beg t) "\t" " "))
yuuji@58 158 (goto-char p))
yuuji@58 159 (t ;;(insert "\\hline\n")
yuuji@58 160 (setq space " ")))
yuuji@31 161 (goto-char p)
yuuji@31 162 (while (> (1- cols) 0)
yuuji@31 163 (insert "&" space)
yuuji@31 164 (setq cols (1- cols)))
yuuji@31 165 (insert "\\\\")
yuuji@31 166 (if hline (insert " \\hline"))
yuuji@58 167 (goto-char p)
yuuji@80 168 (YaTeX-indent-line)))
yuuji@31 169
yuuji@31 170 (defun YaTeX-intelligent-newline-tabular* ()
yuuji@31 171 "Parse current tabular* format and insert that many `&'s."
yuuji@80 172 (YaTeX-intelligent-newline-tabular 'tabular*))
yuuji@31 173
yuuji@31 174 (fset 'YaTeX-intelligent-newline-array 'YaTeX-intelligent-newline-tabular)
yuuji@80 175 (fset 'YaTeX-intelligent-newline-supertabular 'YaTeX-intelligent-newline-tabular)
yuuji@80 176
yuuji@80 177 (defun YaTeX-intelligent-newline-alignat ()
yuuji@80 178 (YaTeX-intelligent-newline-tabular 'alignat))
yuuji@80 179 (fset 'YaTeX-intelligent-newline-alignat* 'YaTeX-intelligent-newline-alignat)
yuuji@80 180
yuuji@80 181 (defun YaTeX-intelligent-newline-align ()
yuuji@80 182 "Intelligent newline function for align.
yuuji@80 183 Count the number of & in the first align line and insert that many &s."
yuuji@80 184 (let*((p (point)) (cols 0))
yuuji@80 185 (save-excursion
yuuji@80 186 (YaTeX-beginning-of-environment)
yuuji@80 187 (catch 'done
yuuji@80 188 (while (YaTeX-re-search-active-forward
yuuji@80 189 "\\(&\\)\\|\\(\\\\\\\\\\)" YaTeX-comment-prefix p t)
yuuji@80 190 (if (match-beginning 1) (setq cols (1+ cols)) (throw 'done t)))))
yuuji@238 191 (if (> cols 0)
yuuji@238 192 (save-excursion
yuuji@238 193 (forward-line -1)
yuuji@238 194 (end-of-line)
yuuji@238 195 (skip-chars-backward " \t")
yuuji@238 196 (or (and (= (preceding-char) ?\\) (= (char-after (- (point) 2)) ?\\))
yuuji@238 197 (insert "\\\\"))))
yuuji@80 198 (save-excursion
yuuji@236 199 (while (>= (setq cols (1- cols)) 0)
yuuji@236 200 (insert "& ")))
yuuji@80 201 (YaTeX-indent-line)))
yuuji@80 202
yuuji@80 203 (mapcar
yuuji@80 204 '(lambda (s)
yuuji@80 205 (fset (intern (concat "YaTeX-intelligent-newline-"
yuuji@80 206 (symbol-name s)))
yuuji@80 207 'YaTeX-intelligent-newline-align))
yuuji@80 208 '(align* flalign flalign* matrix pmatrix bmatrix Bmatrix vmatrix Vmatrix
yuuji@80 209 cases))
yuuji@31 210
yuuji@23 211 ;;;
yuuji@23 212 ;; Functions for tabbing environment
yuuji@23 213 ;;;
yuuji@23 214 (defun YaTeX-intelligent-newline-tabbing ()
yuuji@23 215 "Check the number of \\= in the first line and insert that many \\>."
yuuji@23 216 (let ((p (point)) begenv tabcount)
yuuji@23 217 (save-excursion
yuuji@23 218 (YaTeX-beginning-of-environment)
yuuji@23 219 (setq begenv (point-end-of-line))
yuuji@23 220 (if (YaTeX-search-active-forward "\\\\" YaTeX-comment-prefix p t)
yuuji@23 221 (progn
yuuji@23 222 (setq tabcount 0)
yuuji@23 223 (while (> (point) begenv)
yuuji@23 224 (if (search-backward "\\=" begenv 1)
yuuji@23 225 (setq tabcount (1+ tabcount)))))))
yuuji@23 226 (YaTeX-indent-line)
yuuji@23 227 (if tabcount
yuuji@23 228 (progn
yuuji@23 229 (save-excursion
yuuji@23 230 (while (> tabcount 0)
yuuji@23 231 (insert "\\>\t")
yuuji@23 232 (setq tabcount (1- tabcount))))
yuuji@23 233 (forward-char 2))
yuuji@58 234 (insert "\\= \\\\")
yuuji@233 235 (forward-char -5))))
yuuji@23 236
yuuji@23 237 ;;;
yuuji@23 238 ;; Functions for itemize/enumerate/list environments
yuuji@23 239 ;;;
yuuji@23 240
yuuji@23 241 (defun YaTeX-intelligent-newline-itemize ()
yuuji@23 242 "Insert '\\item '."
yuuji@58 243 (insert "\\item ")
yuuji@233 244 (YaTeX-indent-line))
yuuji@233 245
yuuji@23 246 (fset 'YaTeX-intelligent-newline-enumerate 'YaTeX-intelligent-newline-itemize)
yuuji@23 247 (fset 'YaTeX-intelligent-newline-list 'YaTeX-intelligent-newline-itemize)
yuuji@23 248
yuuji@23 249 (defun YaTeX-intelligent-newline-description ()
yuuji@23 250 (insert "\\item[] ")
yuuji@23 251 (forward-char -2)
yuuji@233 252 (YaTeX-indent-line))
yuuji@23 253
yuuji@64 254 (defun YaTeX-intelligent-newline-thebibliography ()
yuuji@64 255 "Insert '\\bibitem '."
yuuji@64 256 (YaTeX-indent-line)
yuuji@64 257 (YaTeX-make-section nil nil nil "bibitem")
yuuji@233 258 (YaTeX-indent-line))
yuuji@233 259
yuuji@23 260 ;;;
yuuji@234 261 ;; For document environment
yuuji@234 262 ;;;
yuuji@234 263 (defun YaTeX-intelligent-newline-document ()
yuuji@239 264 "New paragraph by null line or `\\par'."
yuuji@239 265 (if (save-excursion (re-search-backward "\\\\par\\>" nil t))
yuuji@239 266 (progn
yuuji@239 267 (YaTeX-indent-line)
yuuji@239 268 (insert "\\par")))
yuuji@239 269 (newline)
yuuji@239 270 (YaTeX-indent-line))
yuuji@234 271
yuuji@234 272 ;;;
yuuji@23 273 ;; Intelligent newline
yuuji@23 274 ;;;
yuuji@23 275 ;;;###autoload
yuuji@23 276 (defun YaTeX-intelligent-newline (arg)
yuuji@23 277 "Insert newline and environment-specific entry.
yuuji@23 278 `\\item' for some itemizing environment,
yuuji@23 279 `\\> \\> \\' for tabbing environemnt,
yuuji@23 280 `& & \\ \hline' for tabular environment."
yuuji@23 281 (interactive "P")
yuuji@61 282 (let*(env func)
yuuji@61 283 (end-of-line)
yuuji@61 284 (setq env (YaTeX-inner-environment))
yuuji@23 285 (if arg (setq env (YaTeX-read-environment "For what environment? ")))
yuuji@23 286 (setq func (intern-soft (concat "YaTeX-intelligent-newline-" env)))
yuuji@23 287 (end-of-line)
yuuji@23 288 (newline)
yuuji@58 289 (undo-boundary)
yuuji@23 290 (if (and env func (fboundp func))
yuuji@80 291 (funcall func))))
yuuji@53 292
yuuji@53 293 ;;;
yuuji@53 294 ;; Environment-specific line indenting functions
yuuji@53 295 ;;;
yuuji@53 296 ;;;###autoload
yuuji@53 297 (defun YaTeX-indent-line-equation ()
yuuji@53 298 "Indent a line in equation family."
yuuji@53 299 (let ((p (point)) (l-r 0) right-p peol depth (mp YaTeX-environment-indent))
yuuji@53 300 (if (save-excursion
yuuji@53 301 (beginning-of-line)
yuuji@53 302 (skip-chars-forward " \t")
yuuji@53 303 (looking-at "\\\\right\\b"))
yuuji@53 304 (progn (YaTeX-reindent
yuuji@53 305 (save-excursion (YaTeX-goto-corresponding-leftright)
yuuji@73 306 (- (current-column) 0))))
yuuji@53 307 (save-excursion
yuuji@53 308 (forward-line -1)
yuuji@53 309 (while (and (not (bobp)) (YaTeX-on-comment-p))
yuuji@53 310 (forward-line -1))
yuuji@53 311 ;;(beginning-of-line) ;must be unnecessary
yuuji@53 312 (skip-chars-forward " \t")
yuuji@53 313 (if (eolp) (error "Math-environment can't have a null line!!"))
yuuji@53 314 (setq depth (current-column)
yuuji@53 315 peol (point-end-of-line))
yuuji@53 316 (while (re-search-forward
yuuji@53 317 "\\\\\\(\\(left\\)\\|\\(right\\)\\)\\b" peol t)
yuuji@53 318 (setq l-r (+ l-r (if (match-beginning 2) 1 -1))))
yuuji@53 319 (cond
yuuji@53 320 ((progn (beginning-of-line)
yuuji@53 321 (re-search-forward "\\\\\\\\\\s *$" (point-end-of-line) t))
yuuji@53 322 ;;If previous line has `\\', this indentation is always normal.
yuuji@53 323 (setq depth (+ (YaTeX-current-indentation) mp)))
yuuji@53 324 ((> l-r 0)
yuuji@53 325 (beginning-of-line)
yuuji@68 326 (search-forward "\\left" peol nil l-r)
yuuji@53 327 (goto-char (1+ (match-beginning 0)))
yuuji@53 328 (setq depth (current-column)))
yuuji@53 329 ((< l-r 0)
yuuji@53 330 (goto-char (match-beginning 0)) ;should be \right
yuuji@53 331 (YaTeX-goto-corresponding-leftright)
yuuji@53 332 (beginning-of-line)
yuuji@53 333 (skip-chars-forward " \t")
yuuji@68 334 ;(setq depth (+ (current-column) mp)) ;+mp is good?
yuuji@68 335 (setq depth (current-column)))
yuuji@53 336 (t ;if \left - \right = 0
yuuji@53 337 (cond
yuuji@53 338 ((re-search-forward "\\\\\\\\\\s *$" peol t)
yuuji@53 339 (setq depth (+ (YaTeX-current-indentation) mp)))
yuuji@53 340 ((re-search-forward "\\\\end{" peol t)
yuuji@53 341 nil) ;same indentation as previous line's
yuuji@53 342 ((re-search-forward "\\\\begin{" peol t)
yuuji@53 343 (setq depth (+ depth mp)))
yuuji@53 344 (t
yuuji@53 345 (or (bobp) (forward-line -1))
yuuji@53 346 (cond
yuuji@53 347 ((re-search-forward
yuuji@53 348 "\\\\\\\\\\s *$\\|\\\\begin{" (point-end-of-line) t)
yuuji@53 349 (setq depth (+ depth mp)))
yuuji@53 350 )))))
yuuji@53 351 (goto-char p))
yuuji@53 352 (YaTeX-reindent depth))))
yuuji@53 353
yuuji@53 354 ;;;###autoload
yuuji@53 355 (defun YaTeX-goto-corresponding-leftright ()
yuuji@77 356 "Go to corresponding \left or \right."
yuuji@53 357 (let ((YaTeX-struct-begin "\\left%1")
yuuji@53 358 (YaTeX-struct-end "\\right%1")
yuuji@77 359 (YaTeX-struct-name-regexp "[][(){}\\.|]")
yuuji@77 360 (in-leftright-p t))
yuuji@53 361 (YaTeX-goto-corresponding-environment t)))
yuuji@53 362
yuuji@53 363 ;;;
yuuji@53 364 ;; Functions for formatting region being enclosed with environment
yuuji@53 365 ;;;
yuuji@53 366 ; These functions must take two argument; region-beginning, region-end.
yuuji@53 367
yuuji@53 368 (defun YaTeX-enclose-equation (beg end)
yuuji@53 369 (goto-char beg)
yuuji@53 370 (save-restriction
yuuji@53 371 (let (m0 bsl)
yuuji@53 372 (narrow-to-region beg end)
yuuji@53 373 (while (YaTeX-re-search-active-forward
yuuji@53 374 "\\(\\$\\)" YaTeX-comment-prefix nil t)
yuuji@53 375 (goto-char (setq m0 (match-beginning 0)))
yuuji@53 376 (setq bsl 0)
yuuji@53 377 (if (and (not (bobp)) (= (char-after (1- (point))) ?\\ ))
yuuji@53 378 (while (progn (forward-char -1) (= (char-after (point)) ?\\ ))
yuuji@53 379 (setq bsl (1+ bsl))))
yuuji@53 380 (goto-char m0)
yuuji@53 381 (if (= 0 (% bsl 2))
yuuji@53 382 (delete-char 1)
yuuji@53 383 (forward-char 1))))))
yuuji@53 384
yuuji@53 385 (fset 'YaTeX-enclose-eqnarray 'YaTeX-enclose-equation)
yuuji@53 386 (fset 'YaTeX-enclose-eqnarray* 'YaTeX-enclose-equation)
yuuji@53 387
yuuji@53 388 (defun YaTeX-enclose-verbatim (beg end)) ;do nothing when enclose verbatim
yuuji@53 389 (fset 'YaTeX-enclose-verbatim* 'YaTeX-enclose-verbatim)
yuuji@53 390
yuuji@53 391 (provide 'yatexenv)