2011-11-03 20:03:45 +00:00
|
|
|
|
;;; srecode/texi.el --- Srecode texinfo support.
|
2009-09-20 21:06:41 +00:00
|
|
|
|
|
2018-01-01 08:21:42 +00:00
|
|
|
|
;; Copyright (C) 2008-2018 Free Software Foundation, Inc.
|
2009-09-20 21:06:41 +00:00
|
|
|
|
|
|
|
|
|
;; Author: Eric M. Ludlam <eric@siege-engine.com>
|
|
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
|
|
;; GNU Emacs 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.
|
|
|
|
|
|
|
|
|
|
;; GNU Emacs 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
|
2017-09-13 22:52:52 +00:00
|
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2009-09-20 21:06:41 +00:00
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
|
|
|
|
;; Texinfo semantic recoder support.
|
|
|
|
|
;;
|
|
|
|
|
;; Contains some handlers, and a few simple texinfo srecoder applications.
|
|
|
|
|
|
|
|
|
|
(require 'semantic)
|
|
|
|
|
(require 'semantic/texi)
|
|
|
|
|
(require 'srecode/semantic)
|
|
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
|
|
(defun srecode-texi-add-menu (newnode)
|
|
|
|
|
"Add an item into the current menu. Add @node statements as well.
|
|
|
|
|
Argument NEWNODE is the name of the new node."
|
|
|
|
|
(interactive "sName of new node: ")
|
|
|
|
|
(srecode-load-tables-for-mode major-mode)
|
|
|
|
|
(semantic-fetch-tags)
|
|
|
|
|
(let ((currnode (reverse (semantic-find-tag-by-overlay)))
|
|
|
|
|
(nodebounds nil))
|
|
|
|
|
(when (not currnode)
|
|
|
|
|
(error "Cannot find node to put menu item into"))
|
|
|
|
|
(setq currnode (car currnode))
|
|
|
|
|
(setq nodebounds (semantic-tag-texi-section-text-bounds currnode))
|
|
|
|
|
;; Step 1:
|
|
|
|
|
;; Limit search within this node.
|
|
|
|
|
;; Step 2:
|
|
|
|
|
;; Find the menu. If there isn't one, add one to the end.
|
|
|
|
|
;; Step 3:
|
|
|
|
|
;; Add new item to end of menu list.
|
|
|
|
|
;; Step 4:
|
|
|
|
|
;; Find correct node new item should show up after, and stick
|
|
|
|
|
;; the new node there.
|
|
|
|
|
(if (string= (semantic-texi-current-environment) "menu")
|
|
|
|
|
;; We are already in a menu, so insert the new item right here.
|
|
|
|
|
(beginning-of-line)
|
|
|
|
|
;; Else, try to find a menu item to append to.
|
|
|
|
|
(goto-char (car nodebounds))
|
|
|
|
|
(if (not (re-search-forward "^@menu" (car (cdr nodebounds)) t))
|
|
|
|
|
(progn
|
|
|
|
|
(goto-char (car (cdr nodebounds)))
|
|
|
|
|
(if (not (y-or-n-p "Add menu here? "))
|
|
|
|
|
(error "Abort"))
|
|
|
|
|
(srecode-insert "declaration:menu"))
|
|
|
|
|
;; Else, find the end
|
|
|
|
|
(re-search-forward "@end menu")
|
|
|
|
|
(beginning-of-line)))
|
|
|
|
|
;; At this point, we are in a menu... or not.
|
|
|
|
|
;; If we are, do stuff, else error.
|
|
|
|
|
(when (string= (semantic-texi-current-environment) "menu")
|
|
|
|
|
(let ((menuname newnode)
|
|
|
|
|
(returnpoint nil))
|
|
|
|
|
(srecode-insert "declaration:menuitem" "NAME" menuname)
|
|
|
|
|
(set-mark (point))
|
|
|
|
|
(setq returnpoint (make-marker))
|
|
|
|
|
;; Update the bound since we added text
|
|
|
|
|
(setq nodebounds (semantic-tag-texi-section-text-bounds currnode))
|
|
|
|
|
(beginning-of-line)
|
|
|
|
|
(forward-char -1)
|
|
|
|
|
(beginning-of-line)
|
|
|
|
|
(let ((end nil))
|
|
|
|
|
(if (not (looking-at "\\* \\([^:]+\\):"))
|
|
|
|
|
(setq end (car (cdr nodebounds)))
|
|
|
|
|
(let* ((nname (match-string 1))
|
|
|
|
|
(tag
|
|
|
|
|
(semantic-deep-find-tags-by-name nname (current-buffer))))
|
|
|
|
|
(when tag
|
|
|
|
|
(setq end (semantic-tag-end (car tag))))
|
|
|
|
|
))
|
|
|
|
|
(when (not end)
|
|
|
|
|
(goto-char returnpoint)
|
|
|
|
|
(error "Could not find location for new node" ))
|
|
|
|
|
(when end
|
|
|
|
|
(goto-char end)
|
|
|
|
|
(when (bolp) (forward-char -1))
|
|
|
|
|
(insert "\n")
|
|
|
|
|
(if (eq (semantic-current-tag) currnode)
|
|
|
|
|
(srecode-insert "declaration:subnode" "NAME" menuname)
|
|
|
|
|
(srecode-insert "declaration:node" "NAME" menuname))
|
|
|
|
|
)
|
|
|
|
|
)))
|
|
|
|
|
))
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun srecode-semantic-handle-:texi (dict)
|
|
|
|
|
"Add macros into the dictionary DICT based on the current texinfo file.
|
|
|
|
|
Adds the following:
|
|
|
|
|
LEVEL - chapter, section, subsection, etc
|
|
|
|
|
NEXTLEVEL - One below level"
|
|
|
|
|
|
|
|
|
|
;; LEVEL and NEXTLEVEL calculation
|
|
|
|
|
(semantic-fetch-tags)
|
|
|
|
|
(let ((tags (reverse (semantic-find-tag-by-overlay)))
|
|
|
|
|
(level nil))
|
|
|
|
|
(while (and tags (not (semantic-tag-of-class-p (car tags) 'section)))
|
|
|
|
|
(setq tags (cdr tags)))
|
|
|
|
|
(when tags
|
|
|
|
|
(save-excursion
|
|
|
|
|
(goto-char (semantic-tag-start (car tags)))
|
|
|
|
|
(when (looking-at "@node")
|
|
|
|
|
(forward-line 1)
|
|
|
|
|
(beginning-of-line))
|
|
|
|
|
(when (looking-at "@\\(\\w+\\)")
|
|
|
|
|
(setq level (match-string 1))
|
|
|
|
|
)))
|
|
|
|
|
(srecode-dictionary-set-value dict "LEVEL" (or level "chapter"))
|
|
|
|
|
(let ((nl (assoc level '( ( nil . "top" )
|
|
|
|
|
("top" . "chapter")
|
|
|
|
|
("chapter" . "section")
|
|
|
|
|
("section" . "subsection")
|
|
|
|
|
("subsection" . "subsubsection")
|
|
|
|
|
("subsubsection" . "subsubsection")
|
|
|
|
|
))))
|
|
|
|
|
(srecode-dictionary-set-value dict "NEXTLEVEL" (cdr nl))))
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun srecode-semantic-handle-:texitag (dict)
|
|
|
|
|
"Add macros into the dictionary DICT based on the current :tag file.
|
|
|
|
|
Adds the following:
|
|
|
|
|
TAGDOC - Texinfo formatted doc string for :tag."
|
|
|
|
|
|
|
|
|
|
;; If we also have a TAG, what is the doc?
|
|
|
|
|
(let ((tag (srecode-dictionary-lookup-name dict "TAG"))
|
|
|
|
|
(doc nil)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
;; If the user didn't apply :tag, then do so now.
|
|
|
|
|
(when (not tag)
|
|
|
|
|
(srecode-semantic-handle-:tag dict))
|
|
|
|
|
|
|
|
|
|
(setq tag (srecode-dictionary-lookup-name dict "TAG"))
|
|
|
|
|
|
|
|
|
|
(when (not tag)
|
|
|
|
|
(error "No tag to insert for :texitag template argument"))
|
|
|
|
|
|
|
|
|
|
;; Extract the tag out of the compound object.
|
|
|
|
|
(setq tag (oref tag :prime))
|
|
|
|
|
|
|
|
|
|
;; Extract the doc string
|
|
|
|
|
(setq doc (semantic-documentation-for-tag tag))
|
|
|
|
|
|
|
|
|
|
(when doc
|
|
|
|
|
(srecode-dictionary-set-value dict "TAGDOC"
|
|
|
|
|
(srecode-texi-massage-to-texinfo
|
|
|
|
|
tag (semantic-tag-buffer tag)
|
|
|
|
|
doc)))
|
|
|
|
|
))
|
|
|
|
|
|
|
|
|
|
;;; OVERRIDES
|
|
|
|
|
;;
|
|
|
|
|
;; Override some semantic and srecode features with texi specific
|
|
|
|
|
;; versions.
|
|
|
|
|
|
|
|
|
|
(define-mode-local-override semantic-insert-foreign-tag
|
|
|
|
|
texinfo-mode (foreign-tag)
|
2010-09-21 22:11:23 +00:00
|
|
|
|
"Insert FOREIGN-TAG from a foreign buffer in TAGFILE.
|
2009-09-20 21:06:41 +00:00
|
|
|
|
Assume TAGFILE is a source buffer, and create a documentation
|
|
|
|
|
thingy from it using the `document' tool."
|
2010-09-21 22:11:23 +00:00
|
|
|
|
(srecode-texi-insert-tag-as-doc foreign-tag))
|
|
|
|
|
|
|
|
|
|
(defun srecode-texi-insert-tag-as-doc (tag)
|
|
|
|
|
"Insert TAG into the current buffer with SRecode."
|
|
|
|
|
(when (not (eq major-mode 'texinfo-mode))
|
|
|
|
|
(error "Can only insert tags into texinfo in texinfo mode"))
|
|
|
|
|
(let ((srecode-semantic-selected-tag tag))
|
|
|
|
|
(srecode-load-tables-for-mode major-mode)
|
2009-09-20 21:06:41 +00:00
|
|
|
|
;; @todo - choose of the many types of tags to insert,
|
|
|
|
|
;; or put all that logic into srecode.
|
|
|
|
|
(srecode-insert "declaration:function")))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Texinfo mangling.
|
|
|
|
|
|
|
|
|
|
(define-overloadable-function srecode-texi-texify-docstring
|
|
|
|
|
(docstring)
|
|
|
|
|
"Texify the doc string DOCSTRING.
|
|
|
|
|
Takes plain text formatting that may exist, and converts it to
|
|
|
|
|
using TeXinfo formatting.")
|
|
|
|
|
|
|
|
|
|
(defun srecode-texi-texify-docstring-default (docstring)
|
|
|
|
|
"Texify the doc string DOCSTRING.
|
|
|
|
|
Takes a few very generic guesses as to what the formatting is."
|
|
|
|
|
(let ((case-fold-search nil)
|
|
|
|
|
(start 0))
|
|
|
|
|
(while (string-match
|
|
|
|
|
"\\(^\\|[^{]\\)\\<\\([A-Z0-9_-]+\\)\\>\\($\\|[^}]\\)"
|
|
|
|
|
docstring start)
|
|
|
|
|
(let ((ms (match-string 2 docstring)))
|
|
|
|
|
;(when (eq mode 'emacs-lisp-mode)
|
|
|
|
|
; (setq ms (downcase ms)))
|
|
|
|
|
|
|
|
|
|
(when (not (or (string= ms "A")
|
|
|
|
|
(string= ms "a")
|
|
|
|
|
))
|
|
|
|
|
(setq docstring (concat (substring docstring 0 (match-beginning 2))
|
|
|
|
|
"@var{"
|
|
|
|
|
ms
|
|
|
|
|
"}"
|
|
|
|
|
(substring docstring (match-end 2))))))
|
|
|
|
|
(setq start (match-end 2)))
|
|
|
|
|
;; Return our modified doc string.
|
|
|
|
|
docstring))
|
|
|
|
|
|
|
|
|
|
(defun srecode-texi-massage-to-texinfo (tag buffer string)
|
|
|
|
|
"Massage TAG's documentation from BUFFER as STRING.
|
|
|
|
|
This is to take advantage of TeXinfo's markup symbols."
|
|
|
|
|
(save-excursion
|
|
|
|
|
(if buffer
|
|
|
|
|
(progn (set-buffer buffer)
|
|
|
|
|
(srecode-texi-texify-docstring string))
|
2011-11-15 17:37:37 +00:00
|
|
|
|
;; Else, no buffer, so let's do something else
|
2009-09-20 21:06:41 +00:00
|
|
|
|
(with-mode-local texinfo-mode
|
|
|
|
|
(srecode-texi-texify-docstring string)))))
|
|
|
|
|
|
|
|
|
|
(define-mode-local-override srecode-texi-texify-docstring emacs-lisp-mode
|
|
|
|
|
(string)
|
|
|
|
|
"Take STRING, (a normal doc string), and convert it into a texinfo string.
|
|
|
|
|
For instances where CLASS is the class being referenced, do not Xref
|
|
|
|
|
that class.
|
|
|
|
|
|
Fix minor quoting problems in doc strings
These were glitches regardless of how or whether we tackle the
problem of grave accent in doc strings.
* lisp/calc/calc-aent.el (math-restore-placeholders):
* lisp/ido.el (ido-ignore-buffers, ido-ignore-files):
* lisp/leim/quail/cyrillic.el ("bulgarian-alt-phonetic"):
* lisp/leim/quail/hebrew.el ("hebrew-new")
("hebrew-biblical-sil"):
* lisp/leim/quail/thai.el ("thai-kesmanee"):
* lisp/progmodes/idlw-shell.el (idlwave-shell-file-name-chars):
Used curved quotes to avoid ambiguities like ‘`''’ in doc strings.
* lisp/calendar/calendar.el (calendar-month-abbrev-array):
* lisp/cedet/semantic/mru-bookmark.el (semantic-mrub-cache-flush-fcn):
* lisp/cedet/semantic/symref.el (semantic-symref-tool-baseclass):
* lisp/cedet/semantic/tag.el (semantic-tag-copy)
(semantic-tag-components):
* lisp/cedet/srecode/cpp.el (srecode-semantic-handle-:cpp):
* lisp/cedet/srecode/texi.el (srecode-texi-texify-docstring):
* lisp/emacs-lisp/byte-opt.el (byte-optimize-all-constp):
* lisp/emacs-lisp/checkdoc.el (checkdoc-message-text-engine):
* lisp/emacs-lisp/generator.el (iter-next):
* lisp/gnus/gnus-art.el (gnus-treat-strip-list-identifiers)
(gnus-article-mode-syntax-table):
* lisp/net/rlogin.el (rlogin-directory-tracking-mode):
* lisp/net/soap-client.el (soap-wsdl-get):
* lisp/net/telnet.el (telnet-mode):
* lisp/org/org-compat.el (org-number-sequence):
* lisp/org/org.el (org-remove-highlights-with-change)
(org-structure-template-alist):
* lisp/org/ox-html.el (org-html-link-org-files-as-html):
* lisp/play/handwrite.el (handwrite-10pt, handwrite-11pt)
(handwrite-12pt, handwrite-13pt):
* lisp/progmodes/f90.el (f90-mode, f90-abbrev-start):
* lisp/progmodes/idlwave.el (idlwave-mode, idlwave-check-abbrev):
* lisp/progmodes/verilog-mode.el (verilog-tool)
(verilog-string-replace-matches, verilog-preprocess)
(verilog-auto-insert-lisp, verilog-auto-insert-last):
* lisp/textmodes/makeinfo.el (makeinfo-options):
* src/font.c (Ffont_spec):
Fix minor quoting problems in doc strings, e.g., missing quote,
``x'' where `x' was meant, etc.
* lisp/erc/erc-backend.el (erc-process-sentinel-2):
Fix minor quoting problem in other string.
* lisp/leim/quail/ethiopic.el ("ethiopic"):
* lisp/term/tvi970.el (tvi970-set-keypad-mode):
Omit unnecessary quotes.
* lisp/faces.el (set-face-attribute, set-face-underline)
(set-face-inverse-video, x-create-frame-with-faces):
* lisp/gnus/gnus-group.el (gnus-group-nnimap-edit-acl):
* lisp/mail/supercite.el (sc-attribs-%@-addresses)
(sc-attribs-!-addresses, sc-attribs-<>-addresses):
* lisp/net/tramp.el (tramp-methods):
* lisp/recentf.el (recentf-show-file-shortcuts-flag):
* lisp/textmodes/artist.el (artist-ellipse-right-char)
(artist-ellipse-left-char, artist-vaporize-fuzziness)
(artist-spray-chars, artist-mode, artist-replace-string)
(artist-put-pixel, artist-text-see-thru):
* lisp/vc/ediff-util.el (ediff-submit-report):
* lisp/vc/log-edit.el (log-edit-changelog-full-paragraphs):
Use double-quotes rather than TeX markup in doc strings.
* lisp/skeleton.el (skeleton-pair-insert-maybe):
Reword to avoid the need for grave accent and apostrophe.
* lisp/xt-mouse.el (xterm-mouse-tracking-enable-sequence):
Don't use grave and acute accents to quote.
2015-05-19 21:59:15 +00:00
|
|
|
|
function => @dfn{function}
|
|
|
|
|
variable => @code{variable}
|
|
|
|
|
class => @code{class} @xref{class}
|
|
|
|
|
unknown => @code{unknown}
|
Prefer directed to neutral quotes
Prefer directed to neutral quotes in docstings and diagnostics.
In docstrings, escape apostrophes that would otherwise be translated
to curved quotes using the newer, simpler rules.
* admin/unidata/unidata-gen.el (unidata-gen-table):
* lisp/align.el (align-region):
* lisp/allout.el (allout-mode, allout-solicit-alternate-bullet):
* lisp/bookmark.el (bookmark-default-annotation-text):
* lisp/calc/calc-aent.el (math-read-if, math-read-factor):
* lisp/calc/calc-lang.el (math-read-giac-subscr)
(math-read-math-subscr):
* lisp/calc/calc-misc.el (report-calc-bug):
* lisp/calc/calc-prog.el (calc-fix-token-name)
(calc-read-parse-table-part):
* lisp/cedet/ede/pmake.el (ede-proj-makefile-insert-dist-rules):
* lisp/cedet/semantic/complete.el (semantic-displayor-show-request):
* lisp/dabbrev.el (dabbrev-expand):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
* lisp/emacs-lisp/elint.el (elint-get-top-forms):
* lisp/emacs-lisp/lisp-mnt.el (lm-verify):
* lisp/emulation/viper-cmd.el (viper-toggle-search-style):
* lisp/erc/erc-button.el (erc-nick-popup):
* lisp/erc/erc.el (erc-cmd-LOAD, erc-handle-login):
* lisp/eshell/em-dirs.el (eshell/cd):
* lisp/eshell/em-glob.el (eshell-glob-regexp):
* lisp/eshell/em-pred.el (eshell-parse-modifiers):
* lisp/eshell/esh-arg.el (eshell-parse-arguments):
* lisp/eshell/esh-opt.el (eshell-show-usage):
* lisp/files-x.el (modify-file-local-variable):
* lisp/filesets.el (filesets-add-buffer, filesets-remove-buffer)
(filesets-update-pre010505):
* lisp/find-cmd.el (find-generic, find-to-string):
* lisp/gnus/auth-source.el (auth-source-netrc-parse-entries):
* lisp/gnus/gnus-agent.el (gnus-agent-check-overview-buffer)
(gnus-agent-fetch-headers):
* lisp/gnus/gnus-int.el (gnus-start-news-server):
* lisp/gnus/gnus-registry.el:
(gnus-registry--split-fancy-with-parent-internal):
* lisp/gnus/gnus-score.el (gnus-summary-increase-score):
* lisp/gnus/gnus-start.el (gnus-convert-old-newsrc):
* lisp/gnus/gnus-topic.el (gnus-topic-rename):
* lisp/gnus/legacy-gnus-agent.el (gnus-agent-unlist-expire-days):
* lisp/gnus/nnmairix.el (nnmairix-widget-create-query):
* lisp/gnus/spam.el (spam-check-blackholes):
* lisp/mail/feedmail.el (feedmail-run-the-queue):
* lisp/mpc.el (mpc-playlist-rename):
* lisp/net/ange-ftp.el (ange-ftp-shell-command):
* lisp/net/mairix.el (mairix-widget-create-query):
* lisp/net/tramp-cache.el:
* lisp/obsolete/otodo-mode.el (todo-more-important-p):
* lisp/obsolete/pgg-gpg.el (pgg-gpg-process-region):
* lisp/obsolete/pgg-pgp.el (pgg-pgp-process-region):
* lisp/obsolete/pgg-pgp5.el (pgg-pgp5-process-region):
* lisp/org/ob-core.el (org-babel-goto-named-src-block)
(org-babel-goto-named-result):
* lisp/org/ob-fortran.el (org-babel-fortran-ensure-main-wrap):
* lisp/org/ob-ref.el (org-babel-ref-resolve):
* lisp/org/org-agenda.el (org-agenda-prepare):
* lisp/org/org-bibtex.el (org-bibtex-fields):
* lisp/org/org-clock.el (org-clock-notify-once-if-expired)
(org-clock-resolve):
* lisp/org/org-feed.el (org-feed-parse-atom-entry):
* lisp/org/org-habit.el (org-habit-parse-todo):
* lisp/org/org-mouse.el (org-mouse-popup-global-menu)
(org-mouse-context-menu):
* lisp/org/org-table.el (org-table-edit-formulas):
* lisp/org/ox.el (org-export-async-start):
* lisp/play/dunnet.el (dun-score, dun-help, dun-endgame-question)
(dun-rooms, dun-endgame-questions):
* lisp/progmodes/ada-mode.el (ada-goto-matching-start):
* lisp/progmodes/ada-xref.el (ada-find-executable):
* lisp/progmodes/antlr-mode.el (antlr-options-alists):
* lisp/progmodes/flymake.el (flymake-parse-err-lines)
(flymake-start-syntax-check-process):
* lisp/progmodes/python.el (python-define-auxiliary-skeleton):
* lisp/progmodes/sql.el (sql-comint):
* lisp/progmodes/verilog-mode.el (verilog-load-file-at-point):
* lisp/server.el (server-get-auth-key):
* lisp/subr.el (version-to-list):
* lisp/textmodes/reftex-ref.el (reftex-label):
* lisp/textmodes/reftex-toc.el (reftex-toc-rename-label):
* lisp/vc/ediff-diff.el (ediff-same-contents):
* lisp/vc/vc-cvs.el (vc-cvs-mode-line-string):
* test/automated/tramp-tests.el (tramp-test33-asynchronous-requests):
Use directed rather than neutral quotes in diagnostics.
2015-08-25 06:39:33 +00:00
|
|
|
|
\"text\" => \\=`\\=`text\\='\\='
|
2009-09-20 21:06:41 +00:00
|
|
|
|
'quoteme => @code{quoteme}
|
|
|
|
|
non-nil => non-@code{nil}
|
|
|
|
|
t => @code{t}
|
|
|
|
|
:tag => @code{:tag}
|
|
|
|
|
[ stuff ] => @code{[ stuff ]}
|
|
|
|
|
Key => @kbd{Key} (key is C\\-h, M\\-h, SPC, RET, TAB and the like)
|
|
|
|
|
... => @dots{}"
|
Support curved quotes in doc strings
Emacs's traditional doc string style has been to quote symbols
`like this'. This worked well on now-obsolete terminals where
` and ' were symmetric quotes, but nowadays curved quotes
‘like this’ look better. Support quoting the new way too.
(Bug#20385)
* doc/lispref/tips.texi (Documentation Tips): Symbols can be quoted
‘like-this’ as well as `like-this'.
* etc/NEWS: Mention this.
* lisp/cedet/mode-local.el (overload-docstring-extension)
(mode-local-print-binding, mode-local-describe-bindings-2):
* lisp/cus-theme.el (describe-theme-1):
* lisp/descr-text.el (describe-text-properties-1, describe-char):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
* lisp/emacs-lisp/cl-generic.el (cl--generic-describe):
* lisp/emacs-lisp/eieio-opt.el (eieio-help-class)
(eieio-help-constructor):
* lisp/emacs-lisp/package.el (describe-package-1):
* lisp/faces.el (describe-face):
* lisp/help-fns.el (help-fns--key-bindings)
(help-fns--compiler-macro, help-fns--parent-mode, help-fns--obsolete):
(help-fns--interactive-only, describe-function-1):
(describe-variable):
* lisp/help.el (describe-mode):
* lisp/international/mule-cmds.el (describe-input-method)
(describe-language-environment):
* lisp/international/mule-diag.el (describe-character-set)
(print-coding-system-briefly, list-input-methods)
(list-input-methods-1):
Insert curved quotes rather than grave accent and apostrophe.
* lisp/cedet/srecode/texi.el (srecode-texi-texify-docstring):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine)
(checkdoc-proper-noun-region-engine):
* lisp/emacs-lisp/lisp-mode.el (lisp-el-font-lock-keywords-2)
(lisp-cl-font-lock-keywords-2):
* lisp/finder.el (finder-font-lock-keywords):
* lisp/gnus/gnus-art.el (gnus-button-alist):
* lisp/help-fns.el (help-do-arg-highlight)
(describe-function-1, describe-variable):
* lisp/help-mode.el (help-xref-symbol-regexp)
(help-xref-info-regexp, help-xref-url-regexp):
* lisp/help.el (describe-mode):
* lisp/international/mule-cmds.el (help-xref-mule-regexp-template):
* lisp/wid-edit.el (widget-documentation-link-regexp):
Parse symbols quoted ‘like-this’ as well as `like-this'.
* lisp/progmodes/elisp-mode.el (emacs-lisp-mode):
Add "‘" and "’" to electric-pair-text-pairs.
(elisp--form-quoted-p): Also allow "‘" as a quoting char.
(elisp-completion-at-point, elisp--preceding-sexp):
Also treat "‘" and "’" as quoting chars.
2015-05-28 07:06:14 +00:00
|
|
|
|
(while (string-match "[`‘]\\([-a-zA-Z0-9<>.]+\\)['’]" string)
|
2009-09-20 21:06:41 +00:00
|
|
|
|
(let* ((vs (substring string (match-beginning 1) (match-end 1)))
|
|
|
|
|
(v (intern-soft vs)))
|
|
|
|
|
(setq string
|
|
|
|
|
(concat
|
|
|
|
|
(replace-match (concat
|
|
|
|
|
(if (fboundp v)
|
|
|
|
|
"@dfn{" "@code{")
|
|
|
|
|
vs "}")
|
|
|
|
|
nil t string)))))
|
|
|
|
|
(while (string-match "\\( \\|^\\)\\(nil\\|t\\|'[-a-zA-Z0-9]+\\|:[-a-zA-Z0-9]+\\)\\([. ,]\\|$\\)" string)
|
|
|
|
|
(setq string (replace-match "@code{\\2}" t nil string 2)))
|
|
|
|
|
(while (string-match "\\( \\|^\\)\\(\\(non-\\)\\(nil\\)\\)\\([. ,]\\|$\\)" string)
|
|
|
|
|
(setq string (replace-match "\\3@code{\\4}" t nil string 2)))
|
|
|
|
|
(while (string-match "\\( \\|^\\)\\(\\[[^]]+\\]\\)\\( \\|$\\)" string)
|
|
|
|
|
(setq string (replace-match "@code{\\2}" t nil string 2)))
|
|
|
|
|
(while (string-match "\\( \\|^\\)\\(\\(\\(C-\\|M-\\|S-\\)+\\([^ \t\n]\\|RET\\|SPC\\|TAB\\)\\)\\|\\(RET\\|SPC\\|TAB\\)\\)\\( \\|\\s.\\|$\\)" string)
|
|
|
|
|
(setq string (replace-match "@kbd{\\2}" t nil string 2)))
|
|
|
|
|
(while (string-match "\"\\(.+\\)\"" string)
|
|
|
|
|
(setq string (replace-match "``\\1''" t nil string 0)))
|
|
|
|
|
(while (string-match "\\.\\.\\." string)
|
|
|
|
|
(setq string (replace-match "@dots{}" t nil string 0)))
|
|
|
|
|
;; Also do base docstring type.
|
|
|
|
|
(srecode-texi-texify-docstring-default string))
|
|
|
|
|
|
|
|
|
|
(provide 'srecode/texi)
|
|
|
|
|
|
|
|
|
|
;; Local variables:
|
|
|
|
|
;; generated-autoload-file: "loaddefs.el"
|
|
|
|
|
;; generated-autoload-load-name: "srecode/texi"
|
|
|
|
|
;; End:
|
|
|
|
|
|
|
|
|
|
;;; srecode/texi.el ends here
|