[elpa] 163/299: Don't prompt for reference format when RefTeX is active.

[Stefan Monnier]

monnier pushed a commit to branch externals/auctex
in repository elpa.

commit 25ac9c5db93363cecd7347d5db5255efec28ee8a
Author: Mosè Giordano <address@hidden>
Date:   Sat Aug 3 11:33:05 2013 +0200

    Don't prompt for reference format when RefTeX is active.
    
    * latex.el (TeX-arg-ref): New function.
    
    * doc/auctex.texi: Replace occurrences of `TeX-arg-label' with
    `TeX-arg-ref'.
    (Adding Macros): Document `TeX-arg-ref'.
    
    * style/fancyref.el ("fancyref"): Use `TeX-arg-ref' instead of
    `TeX-arg-label'.
    
    * style/latexinfo.el ("latexinfo"): Ditto.
    
    * style/nameref.el ("nameref"): Ditto.
    
    * style/varioref.el ("varioref"): Ditto.
    
    * style/subfigure.el ("subfigure"): Use `TeX-arg-ref' instead of
    `TeX-arg-label' and fix parentheses.
---
 ChangeLog          |   20 ++++++++++++++++++++
 doc/auctex.texi    |   12 +++++++++---
 latex.el           |    9 ++++++++-
 style/fancyref.el  |    4 ++--
 style/latexinfo.el |   10 +++++-----
 style/nameref.el   |    2 +-
 style/subfigure.el |    8 ++++----
 style/varioref.el  |   24 ++++++++++++------------
 8 files changed, 61 insertions(+), 28 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 887714c..a541e40 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,23 @@
+2013-08-03  Mos� Giordano  <address@hidden>
+
+       * latex.el (TeX-arg-ref): New function.
+
+       * doc/auctex.texi: Replace occurrences of `TeX-arg-label' with
+       `TeX-arg-ref'.
+       (Adding Macros): Document `TeX-arg-ref'.
+
+       * style/fancyref.el ("fancyref"): Use `TeX-arg-ref' instead of
+       `TeX-arg-label'.
+
+       * style/latexinfo.el ("latexinfo"): Ditto.
+
+       * style/nameref.el ("nameref"): Ditto.
+
+       * style/varioref.el ("varioref"): Ditto.
+
+       * style/subfigure.el ("subfigure"): Use `TeX-arg-ref' instead of
+       `TeX-arg-label' and fix parentheses.
+
 2013-07-31  Tassilo Horn  <address@hidden>
 
        * latex.el (LaTeX-math-initialize): Refactor top-level code into
diff --git a/doc/auctex.texi b/doc/auctex.texi
index cba5c5d..d9d1625 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -3953,7 +3953,7 @@ Here are a few examples from @file{latex.el}.
    (TeX-add-symbols
     '("arabic" TeX-arg-counter)
     '("label" TeX-arg-define-label)
-    '("ref" TeX-arg-label)
+    '("ref" TeX-arg-ref)
     '("newcommand" TeX-arg-define-macro [ "Number of arguments" ] t)
     '("newtheorem" TeX-arg-define-environment
       [ TeX-arg-environment "Numbered like" ]
@@ -3982,7 +3982,7 @@ Thus, to overwrite
 @end example
 you can specify
 @example
-       '("tref" TeX-arg-label ignore) ; two arguments
+       '("tref" TeX-arg-ref ignore) ; two arguments
 @end example
 
 @code{ignore} is a function that does not do anything, so when you
@@ -4044,7 +4044,13 @@ Parse its arguments but use no braces when they are 
inserted.
 Evaluate arguments and insert the result in the buffer.
 
 @item TeX-arg-label
-Prompt for a label completing with known labels.
+Prompt for a label completing with known labels.  If address@hidden is
+active, prompt for the reference format.
+
address@hidden TeX-arg-ref
+Prompt for a label completing with known labels.  If address@hidden is
+active, do not prompt for the reference format.  Usually, reference
+macros should use this function instead of @code{TeX-arg-label}.
 
 @item TeX-arg-index-tag
 Prompt for an index tag.  This is the name of an index, not the entry.
diff --git a/latex.el b/latex.el
index 460027f..3d3d52c 100644
--- a/latex.el
+++ b/latex.el
@@ -1574,7 +1574,14 @@ list of defined labels."
        (LaTeX-add-labels label))
     (TeX-argument-insert label optional optional)))
 
-(defalias 'TeX-arg-ref 'TeX-arg-label)
+(defun TeX-arg-ref (optional &optional prompt definition)
+  "Let-bind `reftex-ref-macro-prompt' to nil and pass arguments
+to `TeX-arg-label'.
+
+See the documentation of `TeX-arg-label' for details on the
+arguments: OPTIONAL, PROMPT, and DEFINITION."
+  (let ((reftex-ref-macro-prompt nil))
+    (TeX-arg-label optional prompt definition)))
 
 (defun TeX-arg-index-tag (optional &optional prompt &rest args)
   "Prompt for an index tag.
diff --git a/style/fancyref.el b/style/fancyref.el
index 53b64fe..2aa9c8c 100644
--- a/style/fancyref.el
+++ b/style/fancyref.el
@@ -30,8 +30,8 @@
      (TeX-add-symbols
 
       ;; The macros with label arguments
-      '("fref" [ TeX-arg-fancyref-format ] TeX-arg-label)
-      '("Fref" [ TeX-arg-fancyref-format ] TeX-arg-label)
+      '("fref" [ TeX-arg-fancyref-format ] TeX-arg-ref)
+      '("Fref" [ TeX-arg-fancyref-format ] TeX-arg-ref)
 
       ;; The macros which define new prefixes and formats
       '("fancyrefchangeprefix" TeX-arg-macro "Prefix")
diff --git a/style/latexinfo.el b/style/latexinfo.el
index 7595d0a..18e8965 100644
--- a/style/latexinfo.el
+++ b/style/latexinfo.el
@@ -98,11 +98,11 @@ This fails when the user types in the label of something 
else"
        (TeX-arg-literal " ")
        (TeX-arg-free TeX-arg-define-label "Node name")
        (TeX-arg-literal ", ")
-       (TeX-arg-free TeX-arg-label "Next node")
+       (TeX-arg-free TeX-arg-ref "Next node")
        (TeX-arg-literal ", ")
-       (TeX-arg-free TeX-arg-label "Previous node")
+       (TeX-arg-free TeX-arg-ref "Previous node")
        (TeX-arg-literal ", ")
-       (TeX-arg-free TeX-arg-label "Up node"))
+       (TeX-arg-free TeX-arg-ref "Up node"))
      '("setfilename" TeX-arg-file)
 
      '("var" t)
@@ -136,8 +136,8 @@ This fails when the user types in the label of something 
else"
      '("copyright" nil)
      '("sp" nil)
 
-     '("xref" TeX-arg-label)
-     '("pxref" TeX-arg-label)
+     '("xref" TeX-arg-ref)
+     '("pxref" TeX-arg-ref)
      '("inforef"
        (TeX-arg-literal "{")
        (TeX-arg-free "Name of node")
diff --git a/style/nameref.el b/style/nameref.el
index ff8e90a..8744bef 100644
--- a/style/nameref.el
+++ b/style/nameref.el
@@ -33,7 +33,7 @@
  "nameref"
  (lambda ()
    (TeX-add-symbols
-    '("nameref" TeX-arg-label))
+    '("nameref" TeX-arg-ref))
    
    (setq TeX-complete-list
          (append '(("\\\\nameref{\\([^{}\n\r\\%,]*\\)" 1 LaTeX-label-list "}"))
diff --git a/style/subfigure.el b/style/subfigure.el
index b417cc6..3fcb587 100644
--- a/style/subfigure.el
+++ b/style/subfigure.el
@@ -35,11 +35,11 @@
    (TeX-add-symbols
     '("subfigure"  [ "List entry" ] [ "Sub caption" ] "Figure")
     '("subtable"   [ "List entry" ] [ "Sub caption" ] "Figure")
-    '("Subref" TeX-arg-label)
-    '("subref" TeX-arg-label)
+    '("Subref" TeX-arg-ref)
+    '("subref" TeX-arg-ref)
     '("subcapsize" 0)
     '("subcapfont" 0)
-    '("subcaplabelfont" 0)
+    '("subcaplabelfont" 0))
 
    (LaTeX-add-lengths "subfigtopskip" "subfigcapskip" "subfigcaptopadj"
                       "subfigbottomskip" "subfigcapmargin" "subfiglabelskip")
@@ -48,7 +48,7 @@
    (setq TeX-complete-list
         (append
          '(("\\\\[Ss]ubref{\\([^{}\n\r\\%,]*\\)" 1 LaTeX-label-list "}")))
-         TeX-complete-list))
+         TeX-complete-list)
 
    ;; Fontification
    (when (and (featurep 'font-latex)
diff --git a/style/varioref.el b/style/varioref.el
index 37d611f..c1556ee 100644
--- a/style/varioref.el
+++ b/style/varioref.el
@@ -31,21 +31,21 @@
      (TeX-add-symbols
 
       ;; The macros with label arguments
-      '("vref" TeX-arg-label)
-      '("Vref" TeX-arg-label)
-      '("vrefrange" [ "Same page text" ] TeX-arg-label TeX-arg-label)
-      '("vrefrange*" [ "Same page text" ] TeX-arg-label TeX-arg-label)
-      '("vref*" TeX-arg-label)
-      '("Vref" TeX-arg-label)
-      '("Ref" TeX-arg-label)
-      '("vpageref" [ "Same page text" ] [ "Different page text" ] 
TeX-arg-label)
+      '("vref" TeX-arg-ref)
+      '("Vref" TeX-arg-ref)
+      '("vrefrange" [ "Same page text" ] TeX-arg-ref TeX-arg-ref)
+      '("vrefrange*" [ "Same page text" ] TeX-arg-ref TeX-arg-ref)
+      '("vref*" TeX-arg-ref)
+      '("Vref" TeX-arg-ref)
+      '("Ref" TeX-arg-ref)
+      '("vpageref" [ "Same page text" ] [ "Different page text" ] TeX-arg-ref)
       '("vpageref*" [ "Same page text" ] [ "Different page text" ]
-        TeX-arg-label)
-      '("fullref" TeX-arg-label)
+        TeX-arg-ref)
+      '("fullref" TeX-arg-ref)
       '("labelformat" TeX-arg-counter t)
 
-      '("vpagerefrange" [ "Same page text" ] TeX-arg-label TeX-arg-label)
-      '("vpagerefrange*" [ "Same page text" ] TeX-arg-label TeX-arg-label)
+      '("vpagerefrange" [ "Same page text" ] TeX-arg-ref TeX-arg-ref)
+      '("vpagerefrange*" [ "Same page text" ] TeX-arg-ref TeX-arg-ref)
 
       ;; And the other macros used for customization
       "reftextbefore" "reftextfacebefore"