1 files changed, 93 insertions, 52 deletions

diff --git a/arabluatex.el b/arabluatex.el
index 73bfcd6..5007675 100644
--- a/arabluatex.el
+++ b/arabluatex.el
@@ -1,29 +1,33 @@
 ;;; arabluatex.el --- AUCTeX style for `arabluatex.sty'
 ;; This file is part of the `arabluatex' package
 
-;; ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
-;; Copyright (C) 2016--2019  Robert Alessi
+;; arabluatex -- ArabTeX for LuaLaTeX
+;; Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
+;; Robert Alessi <alessi@robertalessi.net>
 
-;; Please send error reports and suggestions for improvements to 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.
 
-;; This program 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 of the License, or
-;; (at your option) any later version.
+;; 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.
 
-;; This program 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.
+;; The author would like to express his grateful thanks to Arash
+;; Esbati <arash@gnu.org> whose comments helped to improve this file
+;; immensely.
 
-;; You should have received a copy of the GNU General Public License
-;; along with this program.  If not, see
-;; <http://www.gnu.org/licenses/>.
+;; Please send error reports and suggestions for improvements to Robert
+;; Alessi <alessi@robertalessi.net>
 
 (defvar LaTeX-arabluatex-preamble-options
-  '(;;
-    ("voc")
+  '(("voc")
     ("fullvoc")
     ("novoc")
     ("trans")
@@ -32,21 +36,17 @@
 
 (defun LaTeX-arabluatex-package-options ()
   "Prompt for package options for arabluatex package."
-  (TeX-read-key-val t
-                    (append LaTeX-arabluatex-preamble-options)))
+  (TeX-read-key-val t LaTeX-arabluatex-preamble-options))
 
 (defvar LaTeX-arabluatex-mode-options
-  '(;;
-    ("voc")
+  '(("voc")
     ("fullvoc")
     ("novoc")
-    ("trans")
-    )
-  "Local options.")
+    ("trans"))
+  "List of local options for arabluatex macros.")
 
 (defvar LaTeX-arabluatex-key-val-options
-  '(;;
-    ("mode" ("voc" "fullvoc" "novoc" "trans"))
+  '(("mode" ("voc" "fullvoc" "novoc" "trans"))
     ("width")
     ("gutter")
     ("metre")
@@ -56,23 +56,31 @@
     ("export" ("true" "false")))
   "Key=value options for arabverse environment.")
 
-(defvar LaTeX-arabluatex-color-options
-  '(()))
-
 (defvar LaTeX-arabluatex-outfile-options
-  '(;;
-    ("newline"))
-  "Option for outfile command.")
+  '(("newline"))
+  "List of options for outfile command.")
 
 (defvar LaTeX-arabluatex-arbmark-options
-  '(;;
-    ("rl")
+  '(("rl")
     ("lr"))
-  "Option for arbmark command.")
+  "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
@@ -93,45 +101,78 @@
     "uc"
     "prname"
     "txarb"
-    '("arb" [ (TeX-arg-eval completing-read "Mode: "
-                            LaTeX-arabluatex-mode-options) ]
+    '("arb" [ TeX-arg-eval completing-read
+                           (TeX-argument-prompt nil nil "Mode")
+                           LaTeX-arabluatex-mode-options ]
       t)
-    '("arbcolor" [ (TeX-arg-eval completing-read "Color: "
-                            LaTeX-arabluatex-color-options) ]
+    '("arbcolor" [ TeX-arg-eval completing-read
+                                (TeX-argument-prompt nil nil "Color")
+                                (LaTeX-xcolor-definecolor-list) ]
       t)
-    '("arbmark" [ (TeX-arg-eval completing-read "Option: "
-                            LaTeX-arabluatex-arbmark-options) ]
+    '("arbmark" [ TeX-arg-eval completing-read
+                               (TeX-argument-prompt nil nil "Option")
+                               LaTeX-arabluatex-arbmark-options ]
       t)
-    '("ArbOutFile" [ (TeX-arg-eval completing-read "Color: "
-                            LaTeX-arabluatex-outfile-options) ]
+    '("ArbOutFile" [ TeX-arg-eval completing-read
+                                  (TeX-argument-prompt nil nil "Option")
+                                  LaTeX-arabluatex-outfile-options ]
       t)
-    '("ArbOutFile*" [ (TeX-arg-eval completing-read "Option: "
-                            LaTeX-arabluatex-outfile-options) ]
+    '("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)
+    '("bayt+" 2)
     "abjad"
+    '("SetArbNumbers" "Indian or Arabic")
     "arbnull"
     "abraces"
     "LR"
     "RL"
-    "LRmarginpar"
-    "LRfootnote"
-    "RLfootnote"
+    '("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 "Mode: "
-                      LaTeX-arabluatex-mode-options) ]
-      0)
+      [ 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 ] 0))
+      [ 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)