yatex: 699f3c6c8b2c yatexenv.el

yatex

view yatexenv.el @ 233:699f3c6c8b2c

YaTeX-intelligent-newline-equation

author	yuuji@gentei.org
date	Sat, 28 Jan 2012 10:22:08 +0900
parents	9b4354af748c
children	b75390dd4260

line source

1 ;;; -*- Emacs-Lisp -*-

2 ;;; YaTeX environment-specific functions.

3 ;;; yatexenv.el

5 ;;; Last modified Sat Jan 28 10:21:07 2012 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))

112

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)))))

146

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)))

169

170 (defun YaTeX-intelligent-newline-tabular* ()

171 "Parse current tabular* format and insert that many `&'s."

172 (YaTeX-intelligent-newline-tabular 'tabular*))

173

174 (fset 'YaTeX-intelligent-newline-array 'YaTeX-intelligent-newline-tabular)

175 (fset 'YaTeX-intelligent-newline-supertabular 'YaTeX-intelligent-newline-tabular)

176

177 (defun YaTeX-intelligent-newline-alignat ()

178 (YaTeX-intelligent-newline-tabular 'alignat))

179 (fset 'YaTeX-intelligent-newline-alignat* 'YaTeX-intelligent-newline-alignat)

180

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)))

197

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))

205

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

232 ;;;

233 ;; Functions for itemize/enumerate/list environments

234 ;;;

235

236 (defun YaTeX-intelligent-newline-itemize ()

237 "Insert '\\item '."

238 (insert "\\item ")

239 (YaTeX-indent-line))

240

241 (fset 'YaTeX-intelligent-newline-enumerate 'YaTeX-intelligent-newline-itemize)

242 (fset 'YaTeX-intelligent-newline-list 'YaTeX-intelligent-newline-itemize)

243

244 (defun YaTeX-intelligent-newline-description ()

245 (insert "\\item[] ")

246 (forward-char -2)

247 (YaTeX-indent-line))

248

249 (defun YaTeX-intelligent-newline-thebibliography ()

250 "Insert '\\bibitem '."

251 (YaTeX-indent-line)

252 (YaTeX-make-section nil nil nil "bibitem")

253 (YaTeX-indent-line))

254

255 (defun YaTeX-intelligent-newline-equation ()

256 "Warn equation can't have multiple lines."

257 (undo)

258 (error "Equation environment can't have multiple lines."))

259 (fset 'YaTeX-intelligent-newline-equation* 'YaTeX-intelligent-newline-equation)

260

261 ;;;

262 ;; Intelligent newline

263 ;;;

264 ;;;###autoload

265 (defun YaTeX-intelligent-newline (arg)

266 "Insert newline and environment-specific entry.

267 `\\item' for some itemizing environment,

268 `\\> \\> \\' for tabbing environemnt,

269 `& & \\ \hline' for tabular environment."

270 (interactive "P")

271 (let*(env func)

272 (end-of-line)

273 (setq env (YaTeX-inner-environment))

274 (if arg (setq env (YaTeX-read-environment "For what environment? ")))

275 (setq func (intern-soft (concat "YaTeX-intelligent-newline-" env)))

276 (end-of-line)

277 (newline)

278 (undo-boundary)

279 (if (and env func (fboundp func))

280 (funcall func))))

281

282 ;;;

283 ;; Environment-specific line indenting functions

284 ;;;

285 ;;;###autoload

286 (defun YaTeX-indent-line-equation ()

287 "Indent a line in equation family."

288 (let ((p (point)) (l-r 0) right-p peol depth (mp YaTeX-environment-indent))

289 (if (save-excursion

290 (beginning-of-line)

291 (skip-chars-forward " \t")

292 (looking-at "\\\\right\\b"))

293 (progn (YaTeX-reindent

294 (save-excursion (YaTeX-goto-corresponding-leftright)

295 (- (current-column) 0))))

296 (save-excursion

297 (forward-line -1)

298 (while (and (not (bobp)) (YaTeX-on-comment-p))

299 (forward-line -1))

300 ;;(beginning-of-line) ;must be unnecessary

301 (skip-chars-forward " \t")

302 (if (eolp) (error "Math-environment can't have a null line!!"))

303 (setq depth (current-column)

304 peol (point-end-of-line))

305 (while (re-search-forward

306 "\\\\\$\\(left\$\\|\$right\$\\)\\b" peol t)

307 (setq l-r (+ l-r (if (match-beginning 2) 1 -1))))

308 (cond

309 ((progn (beginning-of-line)

310 (re-search-forward "\\\\\\\\\\s *$" (point-end-of-line) t))

311 ;;If previous line has `\\', this indentation is always normal.

312 (setq depth (+ (YaTeX-current-indentation) mp)))

313 ((> l-r 0)

314 (beginning-of-line)

315 (search-forward "\\left" peol nil l-r)

316 (goto-char (1+ (match-beginning 0)))

317 (setq depth (current-column)))

318 ((< l-r 0)

319 (goto-char (match-beginning 0)) ;should be \right

320 (YaTeX-goto-corresponding-leftright)

321 (beginning-of-line)

322 (skip-chars-forward " \t")

323 ;(setq depth (+ (current-column) mp)) ;+mp is good?

324 (setq depth (current-column)))

325 (t ;if \left - \right = 0

326 (cond

327 ((re-search-forward "\\\\\\\\\\s *$" peol t)

328 (setq depth (+ (YaTeX-current-indentation) mp)))

329 ((re-search-forward "\\\\end{" peol t)

330 nil) ;same indentation as previous line's

331 ((re-search-forward "\\\\begin{" peol t)

332 (setq depth (+ depth mp)))

333 (t

334 (or (bobp) (forward-line -1))

335 (cond

336 ((re-search-forward

337 "\\\\\\\\\\s *$\\|\\\\begin{" (point-end-of-line) t)

338 (setq depth (+ depth mp)))

339 )))))

340 (goto-char p))

341 (YaTeX-reindent depth))))

342

343 ;;;###autoload

344 (defun YaTeX-goto-corresponding-leftright ()

345 "Go to corresponding \left or \right."

346 (let ((YaTeX-struct-begin "\\left%1")

347 (YaTeX-struct-end "\\right%1")

348 (YaTeX-struct-name-regexp "[][(){}\\.|]")

349 (in-leftright-p t))

350 (YaTeX-goto-corresponding-environment t)))

351

352 ;;;

353 ;; Functions for formatting region being enclosed with environment

354 ;;;

355 ; These functions must take two argument; region-beginning, region-end.

356

357 (defun YaTeX-enclose-equation (beg end)

358 (goto-char beg)

359 (save-restriction

360 (let (m0 bsl)

361 (narrow-to-region beg end)

362 (while (YaTeX-re-search-active-forward

363 "\$\\$\$" YaTeX-comment-prefix nil t)

364 (goto-char (setq m0 (match-beginning 0)))

365 (setq bsl 0)

366 (if (and (not (bobp)) (= (char-after (1- (point))) ?\\ ))

367 (while (progn (forward-char -1) (= (char-after (point)) ?\\ ))

368 (setq bsl (1+ bsl))))

369 (goto-char m0)

370 (if (= 0 (% bsl 2))

371 (delete-char 1)

372 (forward-char 1))))))

373

374 (fset 'YaTeX-enclose-eqnarray 'YaTeX-enclose-equation)

375 (fset 'YaTeX-enclose-eqnarray* 'YaTeX-enclose-equation)

376

377 (defun YaTeX-enclose-verbatim (beg end)) ;do nothing when enclose verbatim

378 (fset 'YaTeX-enclose-verbatim* 'YaTeX-enclose-verbatim)

379

380 (provide 'yatexenv)