yatex

view yatexenv.el @ 84:73cba5ddd111

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