summaryrefslogtreecommitdiff
path: root/elpa/auctex-13.1.3/style/tcolorboxlib-raster.el
blob: db61a03491da1cd8728ca0a100653d1031aca359 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
;;; tcolorboxlib-raster.el --- AUCTeX style for `raster' library from tcolorbox  -*- lexical-binding: t; -*-

;; Copyright (C) 2016--2021 Free Software Foundation, Inc.

;; Author: Arash Esbati <arash@gnu.org>
;; Maintainer: auctex-devel@gnu.org
;; Keywords: tex

;; This file is part of AUCTeX.

;; AUCTeX is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; AUCTeX is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with AUCTeX; see the file COPYING.  If not, write to the Free
;; Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
;; 02110-1301, USA.

;;; Commentary:

;; This file adds support for `raster' library from tcolorbox.sty.

;;; Code:

(require 'tex)
(require 'latex)

;; Silence the compiler:
(declare-function font-latex-add-keywords
                  "font-latex"
                  (keywords class))
(declare-function LaTeX-tcolorbox-keyval-options "tcolorbox" ())
(defvar LaTeX-tcolorbox-keyval-options-full)

(defvar LaTeX-tcolorbox-lib-raster-keyval-options
  '(;; 14.3 Option Keys of the Library
    ("raster columns")
    ("raster rows")
    ("raster width")
    ("raster height")
    ("raster before skip")
    ("raster after skip")
    ("raster equal skip")
    ("raster left skip")
    ("raster right skip")
    ("raster column skip")
    ("raster row skip")
    ("raster halign" ("left" "center" "right"))
    ("raster valign" ("top" "center" "bottom"))
    ("raster equal height" ("noe" "rows" "all"))
    ("raster equal height group")
    ("raster force size" ("true" "false"))
    ("raster reset")
    ;; 14.4 Adding Styles for Specific Boxes
    ("raster every box")
    ("raster odd column")
    ("raster even column")
    ("raster column 1")
    ("raster column 2")
    ("raster column 3")
    ("raster column 4")
    ("raster odd row")
    ("raster even row")
    ("raster row 1")
    ("raster row 2")
    ("raster row 3")
    ("raster row 4")
    ("raster odd number")
    ("raster even number")
    ;; raster row m column n is left to user
    ("raster number 1")
    ("raster number 2")
    ("raster number 3")
    ("raster number 4")
    ;; 14.5 Combining Columns or Rows
    ("raster multicolumn")
    ("raster multirow"))
  "Key=value options for raster library from tcolorbox.")

(defun LaTeX-tcolorbox-lib-raster-env-item (environment)
  "Insert ENVIRONMENT, ask for arguments and the first item."
  (LaTeX-insert-environment
   environment
   (let ((opts (TeX-read-key-val t (append
                                    LaTeX-tcolorbox-lib-raster-keyval-options
                                    (LaTeX-tcolorbox-keyval-options))
                                 (when (string= environment "tcboxeditemize")
                                   "Raster options (k=v)")))
         (box-opts (when (string= environment "tcboxeditemize")
                     (TeX-read-key-val nil (LaTeX-tcolorbox-keyval-options)
                                       "Box options (k=v)"))))
     (concat
      (when (and opts (not (string= opts "")))
        (format "[%s]" opts))
      (when (string= environment "tcboxeditemize")
        (format "{%s}" box-opts)))))
  (if (TeX-active-mark)
      (progn
        (LaTeX-find-matching-begin)
        (end-of-line 1))
    (end-of-line 0))
  (delete-char 1)
  (when (looking-at (concat "^[ \t]+$\\|"
                            "^[ \t]*" TeX-comment-start-regexp "+[ \t]*$"))
    (delete-region (point) (line-end-position)))
  (delete-horizontal-space)
  ;; Deactivate the mark here in order to prevent `TeX-parse-macro'
  ;; from swapping point and mark and the \item ending up right after
  ;; \begin{...}.
  (deactivate-mark)
  (LaTeX-insert-item)
  ;; The inserted \item may have outdented the first line to the
  ;; right.  Fill it, if appropriate.
  (when (and auto-fill-function
             (not (looking-at "$"))
             (not (assoc environment LaTeX-indent-environment-list))
             (> (- (line-end-position) (line-beginning-position))
                (current-fill-column)))
    (LaTeX-fill-paragraph nil)))

(defun LaTeX-tcolorbox-lib-raster-insert-item ()
  "Insert \"tcbitem\" and query for optional argument."
  (TeX-insert-macro "tcbitem"))

(TeX-add-style-hook
 "tcolorboxlib-raster"
 (lambda ()

   ;; Register key-vals from library to `LaTeX-tcolorbox-keyval-options-full':
   (add-to-list 'LaTeX-tcolorbox-keyval-options-full
                'LaTeX-tcolorbox-lib-raster-keyval-options)

   (TeX-add-symbols
    ;; 14.2 Macros of the Library
    '("tcbitem"
      [TeX-arg-key-val (LaTeX-tcolorbox-keyval-options) "Item options (k=v)" ]
      (TeX-arg-literal " ")))

   (LaTeX-add-environments
    ;; 14.2 Macros of the Library
    '("tcbraster"
      (lambda (env)
        (LaTeX-insert-environment
         env
         (let ((raster-opts
                (TeX-read-key-val t (append
                                     LaTeX-tcolorbox-lib-raster-keyval-options
                                     (LaTeX-tcolorbox-keyval-options)))))
           (when (and raster-opts (not (string= raster-opts "")))
             (concat LaTeX-optop raster-opts LaTeX-optcl))))))

    '("tcbitemize" LaTeX-tcolorbox-lib-raster-env-item)

    '("tcboxedraster"
      (lambda (env)
        (LaTeX-insert-environment
         env
         (let ((raster-opts
                (TeX-read-key-val t (append
                                     LaTeX-tcolorbox-lib-raster-keyval-options
                                     (LaTeX-tcolorbox-keyval-options))
                                  "Raster options (k=v)"))
               (box-opts
                (TeX-read-key-val nil (LaTeX-tcolorbox-keyval-options)
                                  "Box options (k=v)")))
           (concat
            (when (and raster-opts (not (string= raster-opts "")))
              (concat LaTeX-optop raster-opts LaTeX-optcl))
            TeX-grop box-opts TeX-grcl)))))

    '("tcboxeditemize" LaTeX-tcolorbox-lib-raster-env-item))

   ;; Append tcb(oxed)?itemize to `LaTeX-item-list':
   (add-to-list 'LaTeX-item-list
                '("tcbitemize" . LaTeX-tcolorbox-lib-raster-insert-item) t)
   (add-to-list 'LaTeX-item-list
                '("tcboxeditemize" . LaTeX-tcolorbox-lib-raster-insert-item) t)

   ;; Append tcbitem to `LaTeX-item-regexp':
   (unless (string-match "tcbitem" LaTeX-item-regexp)
     (set (make-local-variable 'LaTeX-item-regexp)
          (concat
           LaTeX-item-regexp
           "\\|"
           "tcbitem\\b"))
     (LaTeX-set-paragraph-start))

   ;; Fontification
   (when (and (featurep 'font-latex)
              (eq TeX-install-font-lock 'font-latex-setup))
     (font-latex-add-keywords '(("tcbitem" "["))
                              'textual)))
 TeX-dialect)

;;; tcolorboxlib-raster.el ends here