aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.el
blob: e445aca4631a6bbdaf2d16180dcb9ae37d8ddb3f (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
;;; arabluatex.el --- AUCTeX style for `arabluatex.sty'
;; This file is part of the `arabluatex' package

;; arabluatex -- ArabTeX for LuaLaTeX
;; Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
;; Robert Alessi <alessi@robertalessi.net>

;; Permission to use, copy, modify, and distribute this software for
;; any purpose with or without fee is hereby granted, provided that
;; the above copyright notice and this permission notice appear in all
;; copies.

;; THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
;; WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
;; WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
;; AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
;; CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
;; OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
;; NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
;; CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

;; The author would like to express his grateful thanks to Arash
;; Esbati <arash@gnu.org> whose comments helped to improve this file
;; immensely.

;; Please send error reports and suggestions for improvements to Robert
;; Alessi <alessi@robertalessi.net>

(defvar LaTeX-arabluatex-preamble-options
  '(("voc")
    ("fullvoc")
    ("novoc")
    ("trans")
    ("export" ("true" "false")))
  "Package options for the arabluatex package.")

(defun LaTeX-arabluatex-package-options ()
  "Prompt for package options for arabluatex package."
  (TeX-read-key-val t LaTeX-arabluatex-preamble-options))

(defvar LaTeX-arabluatex-mode-options
  '(("voc")
    ("fullvoc")
    ("novoc")
    ("trans"))
  "List of local options for arabluatex macros.")

(defvar LaTeX-arabluatex-key-val-options
  '(("mode" ("voc" "fullvoc" "novoc" "trans"))
    ("width")
    ("gutter")
    ("metre")
    ("color")
    ("delim" ("true" "false"))
    ("utf" ("true" "false"))
    ("export" ("true" "false")))
  "Key=value options for arabverse environment.")

(defvar LaTeX-arabluatex-outfile-options
  '(("newline"))
  "List of options for outfile command.")

(defvar LaTeX-arabluatex-arbmark-options
  '(("rl")
    ("lr"))
  "List of options for arbmark command.")

(defvar LaTeX-arabluatex-arind-options
  '(("index")
    ("root"
     ("1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15"))
    ("form")
    ("pipe"))
  "Option for arind command.")

(TeX-add-style-hook
 "arabluatex"
 (lambda ()
   ;; Run the style hook for loaded packages:
   (TeX-run-style-hooks "xcolor")
   ;; Folding features:
   (add-to-list (make-local-variable 'LaTeX-fold-macro-spec-list)
		'("[i]" ("arind")) t)
   ;; This package relies on lualatex, so check for it:
   (TeX-check-engine-add-engines 'luatex)
   (TeX-add-symbols
    "aemph"
    "SetInputScheme"
    '("SetArbEasy" 0)
    '("SetArbDflt" 0)
    '("SetArbEasy*" 0)
    '("SetArbDflt*" 0)
    "SetTranslitFont"
    "SetTranslitStyle"
    "SetTranslitConvention"
    "SetArbOutSuffix"
    "arbup"
    '("ArbUpDflt" 0)
    '("NoArbUp" 0)
    "SetArbUp"
    "uc"
    "prname"
    "txarb"
    '("arb" [ TeX-arg-eval completing-read
			   (TeX-argument-prompt nil nil "Mode")
			   LaTeX-arabluatex-mode-options ]
      t)
    '("arbcolor" [ TeX-arg-eval completing-read
				(TeX-argument-prompt nil nil "Color")
				(LaTeX-xcolor-definecolor-list) ]
      t)
    '("arbmark" [ TeX-arg-eval completing-read
			       (TeX-argument-prompt nil nil "Option")
			       LaTeX-arabluatex-arbmark-options ]
      t)
    '("ArbOutFile" [ TeX-arg-eval completing-read
				  (TeX-argument-prompt nil nil "Option")
				  LaTeX-arabluatex-outfile-options ]
      t)
    '("ArbOutFile*" [ TeX-arg-eval completing-read
				   (TeX-argument-prompt nil nil "Option")
				   LaTeX-arabluatex-outfile-options ]
      t)
    '("arind" [ TeX-arg-key-val LaTeX-arabluatex-arind-options ]
      TeX-arg-index)
    "SetHemistichDelim"
    '("bayt" 2)
    "abjad"
    '("SetArbNumbers" "Indian or Arabic")
    "arbnull"
    "abraces"
    "LR"
    "RL"
    '("LRmarginpar" [ "Left margin text" ] "Text")
    '("LRfootnote"
      (TeX-arg-conditional TeX-arg-footnote-number-p ([ "Number" ]) nil)
      t)
    '("RLfootnote"
      (TeX-arg-conditional TeX-arg-footnote-number-p ([ "Number" ]) nil)
      t)
    "FixArbFtnmk"
    "MkArbBreak"
    '("newarbmark" 3)
    '("setRL" 0)
    '("setLR" 0))

   (LaTeX-add-environments
    '("arab" LaTeX-env-args
      [ TeX-arg-eval completing-read
		     (TeX-argument-prompt nil nil "Mode")
		     LaTeX-arabluatex-mode-options ]
      )
    "txarab"
    "arabexport"
    '("arabverse" LaTeX-env-args
      [ TeX-arg-key-val LaTeX-arabluatex-key-val-options ] ))

   ;; Fontification
   (when (and (featurep 'font-latex)
	      (eq TeX-install-font-lock 'font-latex-setup))
     (font-latex-add-keywords '(("aemph"  "{"))
			      'italic-command)
     (font-latex-add-keywords '(("LRmarginpar" "[{")
				("LRfootnote"  "[{")
				("RLfootnote"  "[{")
				("arind"       "[{"))
			      'reference)
     (font-latex-add-keywords '(("SetTranslitFont"       "{")
				("SetTranslitStyle"      "{")
				("SetTranslitConvention" "{"))
			      'function))
   ;; RefTeX support
   (when (fboundp 'reftex-add-index-macros)
     (reftex-add-index-macros '(("\\arind[]{*}" "" ?a "" nil t))))
   )
 LaTeX-dialect)

;;; arabluatex.el ends here