From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 2CbnDwO77WFuGwEAgWs5BA (envelope-from ) for ; Sun, 23 Jan 2022 21:30:59 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id OK5IDQO77WGwJwEA9RJhRA (envelope-from ) for ; Sun, 23 Jan 2022 21:30:59 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 662A1317AC for ; Sun, 23 Jan 2022 21:30:58 +0100 (CET) Received: from localhost ([::1]:41398 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nBjVo-0001DW-Qy for larch@yhetil.org; Sun, 23 Jan 2022 15:30:57 -0500 Received: from eggs.gnu.org ([209.51.188.92]:58042) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nBjSq-000187-6g for emacs-orgmode@gnu.org; Sun, 23 Jan 2022 15:27:53 -0500 Received: from mail.hostpark.net ([212.243.197.30]:33726) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nBjSl-0003ov-TL for emacs-orgmode@gnu.org; Sun, 23 Jan 2022 15:27:51 -0500 Received: from localhost (localhost [127.0.0.1]) by mail.hostpark.net (Postfix) with ESMTP id 9A4F7164BA for ; Sun, 23 Jan 2022 21:27:43 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bernoul.li; h= content-transfer-encoding:mime-version:references:in-reply-to :x-mailer:message-id:date:date:subject:subject:from:from :received:received; s=sel2011a; t=1642969661; bh=i0Ol9oKXUeKyNsS G97/idWGEu0H70DF94P48gKhJLdk=; b=sWj8ywxg7ldOsIOCbdpTP2x21yFy61F Gh0GeajMTiN4elffBmPz0A7ozmfnSsaODm/36sKRJsHGr0A+5aigVdDFiEoaASFx xSEADxU5Nnf/v5p3VrbNBTrbwP1PfslX1GvQAh73ZavIhppw6uK8fKgS5zzUEqwc uzgd6UCa5MWo= X-Virus-Scanned: by Hostpark/NetZone Mailprotection at hostpark.net Received: from mail.hostpark.net ([127.0.0.1]) by localhost (mail1.hostpark.net [127.0.0.1]) (amavisd-new, port 10224) with ESMTP id 4rtjobDWPmuQ for ; Sun, 23 Jan 2022 21:27:41 +0100 (CET) Received: from customer (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.hostpark.net (Postfix) with ESMTPSA id 52461164CE for ; Sun, 23 Jan 2022 21:27:41 +0100 (CET) From: Jonas Bernoulli To: emacs-orgmode@gnu.org Subject: [PATCH v4 3/3] ox-texinfo: Define definition commands using description lists Date: Sun, 23 Jan 2022 21:27:40 +0100 Message-Id: <20220123202740.512619-4-jonas@bernoul.li> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220123202740.512619-1-jonas@bernoul.li> References: <20211218214038.9459-1-jonas@bernoul.li> <20220123202740.512619-1-jonas@bernoul.li> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: none client-ip=212.243.197.30; envelope-from=jonas@bernoul.li; helo=mail.hostpark.net X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1642969858; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=6o78NBJXQKd8Q1v9O3OxRLgTxMRTnz2N5IexJouDSPg=; b=BK4s9L3o/tk1PvhHkobAxSgPdb3pCtFD80ZLDqAYUeNvJ+l4kkkjATvYSGWeHkOLMzzmWu ZBpyhGo8aDqUHQZnf6ExSqH1Cl4td/zfbORdbNMJ/u2WbeALmULXonhchfRevvMWXsqqL6 b7Gvb2GrLsOrK1ZqeFJSguIpTupZV7X23TYdaHCmd3m5UaH0S1hWeIQY+UF3ApXms9/HrJ LwJssa+4W9TSiWuEJ0oaFtYONdEZ9FhPrJMRpROkH/SWOTny8/9GDNAjyTFCrluxg/wGcC WmBSckq+60hDjUgtJhFgx+Naz94SQT40ffDnBz2jF0NA8vZZhPP4bgX1isU/iQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1642969858; a=rsa-sha256; cv=none; b=XBYAdy7LgsV1ZYAfEmkagBtJ/naMq5NZMRshyfvfYJJ+bRMs/0eFZgOtAJrj07mYGSH+2D kuZnhus+6Q3R9p4FKLjAFNRMknDrpJHU9XIwPeuiitc7/RHrHbxrQjcKtClsVylXRjsEyt gxQAt8FVrLM9/oQ1/e6Tqmb2Ju9S+4kZrML4DGqzBVgbK7kF68ypuHNo0IyFf3eeLnqetL xJDiG8tGudRHFPlNiiCdZmBSmUtyBX4cRUZP3AiOEnuI69qPkz2z2dlH6Pw7HIUKaj0i8W UUR42EThb+xuC4EcX+sT1TXdg2On/C1RGnjr7SqP4dL+7Bh3fYO7++VeXnu0UA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b=sWj8ywxg; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -4.13 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=bernoul.li header.s=sel2011a header.b=sWj8ywxg; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 662A1317AC X-Spam-Score: -4.13 X-Migadu-Scanner: scn0.migadu.com X-TUID: z0F62oHRlK+R * doc/org-manual.org (Plain lists in Texinfo export): Document use of definition command prefixes in description lists. * lisp/ox-texinfo.el: Add org-texinfo--separate-definitions to the list of :filter-parse-tree functions of the texinfo backend. * lisp/ox-texinfo.el (org-texinfo--definition-command-alist) (org-texinfo--definition-command-regexp): New variables. * lisp/ox-texinfo.el (org-texinfo--separate-definitions) (org-texinfo--match-definition, org-texinfo--split-definition) (org-texinfo--split-plain-list, org-texinfo--massage-key-item): New functions. --- doc/org-manual.org | 70 ++++++++++++++++++++++ lisp/ox-texinfo.el | 144 ++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 213 insertions(+), 1 deletion(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 344aaf3e7..83d77c949 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -15307,6 +15307,72 @@ example is transcoded to the same output as above. This is the common text for variables foo and bar. #+end_example +Likewise, the Texinfo export back-end supports two approaches to +writing Texinfo definition commands (see [[info:texinfo::Definition +Commands]]). One of them uses description lists and is describe below, +the other is described in [[*Special blocks in Texinfo export]]. + +Items in a description list in a Org file that begin with =Function:= +or certain other prefixes are converted using Texinfo definition +commands. This works even if other items in the same list do not have +such a prefix; if necessary a single description list is converted +using multiple tables (such as =@vtable=) and definition commands +(such as =@defun=). + +#+begin_example +- Function: org-texinfo-drawer drawer contents info :: + Transcode a DRAWER element from Org to Texinfo. +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@defun org-texinfo-drawer drawer contents info :: + Transcode a DRAWER element from Org to Texinfo. +@end defun +#+end_example + +The recognized prefixes are =Command:=, =Function:=, =Macro:=, +=Special Form:=, =Variable:= and =User Option:=. These are the same +prefixes that appear in the Info file for the respective definition +commands. For example a =Function:= item in the Org file is converted +to a =@defun= command in the Texinfo file, which in turn is converted +to a definition prefixed with =-- Function:= in the Info file. + +As a special case the prefix =Key:= is also recognized. No Texinfo +definition command exists for key bindings and the output in Info +files also lacks the =Key:= prefix. Even so this special case is +supported because it provides a convenient shorthand, as illustrated +here: + +#+begin_example +- Key: C-c C-c (do-something) :: + This command does something. + +- User Option: do-something-somehow :: + This option controls how exactly ~do-something~ does its thing. +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@table @asis +@item @kbd{C-c C-c} (@code{do-something}) +@kindex C-c C-c +@findex do-something +This command does something. +@end table + +@defopt do-something-somehow +This option controls how exactly @code{do-something} does its thing. +@end defopt +#+end_example + +#+texinfo: @noindent +Command in parenthesis, as done above, is optional. + *** Tables in Texinfo export :PROPERTIES: :DESCRIPTION: Table attributes. @@ -15401,6 +15467,10 @@ Type @kbd{C-c @key{SPC}}. :DESCRIPTION: Special block attributes. :END: +The Texinfo export back-end supports two approaches to writing Texinfo +definition commands. One of them is described here, the other in +[[*Plain lists in Texinfo export]]. + #+cindex: @samp{ATTR_TEXINFO}, keyword The Texinfo export back-end converts special blocks to commands with diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index 9b2c0616c..7688ce0b8 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -83,7 +83,8 @@ (org-export-define-backend 'texinfo (verse-block . org-texinfo-verse-block)) :filters-alist '((:filter-headline . org-texinfo--filter-section-blank-lines) - (:filter-parse-tree . org-texinfo--normalize-headlines) + (:filter-parse-tree . (org-texinfo--normalize-headlines + org-texinfo--separate-definitions)) (:filter-section . org-texinfo--filter-section-blank-lines) (:filter-final-output . org-texinfo--untabify)) :menu-entry @@ -414,6 +415,23 @@ (defvar org-texinfo--quoted-keys-regexp 'words) "Regexp matching keys that have to be quoted using @key{KEY}.") +(defconst org-texinfo--definition-command-alist + '(("deffn Command" . "Command") + ("defun" . "Function") + ("defmac" . "Macro") + ("defspec" . "Special Form") + ("defvar" . "Variable") + ("defopt" . "User Option") + (nil . "Key")) + "Alist mapping Texinfo definition commands to output in Info files.") + +(defconst org-texinfo--definition-command-regexp + (format "\\`%s: \\(.+\\)" + (regexp-opt + (delq nil (mapcar #'cdr org-texinfo--definition-command-alist)) + t)) + "Regexp used to match definition commands in descriptive lists.") + ;;; Internal Functions @@ -577,6 +595,130 @@ (defun org-texinfo--sectioning-structure (info) (`(,_ ,_ . ,sections) sections) (_ (user-error "Unknown Texinfo class: %S" class))))) +(defun org-texinfo--separate-definitions (tree _backend info) + "Split up descriptive lists in TREE that contain Texinfo definition commands. + +_BACKEND is the symbol `texinfo'; the back-end used for export. +INFO is a plist used as a communication channel. + +Return new tree." + (org-element-map tree 'plain-list + (lambda (plain-list) + (when (eq (org-element-property :type plain-list) 'descriptive) + (let ((contents (org-element-contents plain-list)) + (items nil)) + (dolist (item contents) + (pcase-let ((`(,cmd . ,args) (org-texinfo--match-definition item))) + (cond + (cmd + (when items + (org-texinfo--split-plain-list plain-list (nreverse items)) + (setq items nil)) + (org-texinfo--split-definition plain-list item cmd args)) + (t + (when args + (org-texinfo--massage-key-item plain-list item args)) + (push item items))))) + (unless (org-element-contents plain-list) + (org-element-extract-element plain-list))))) + info) + tree) + +(defun org-texinfo--match-definition (item) + "Return a cons-cell if ITEM specifies a Texinfo definition command. +The car is the command and the cdr is its arguments." + (let ((tag (car-safe (org-element-property :tag item)))) + (and tag + (stringp tag) + (string-match org-texinfo--definition-command-regexp tag) + (pcase-let* + ((cmd (car (rassoc (match-string-no-properties 1 tag) + org-texinfo--definition-command-alist))) + (`(,cmd ,category) + (and cmd (save-match-data (split-string cmd " ")))) + (args (match-string-no-properties 2 tag))) + (cons cmd (if category (concat category " " args) args)))))) + +(defun org-texinfo--split-definition (plain-list item cmd args) + "Insert a definition command before list PLAIN-LIST. +Replace list item ITEM with a special-block that inherits the +contents of ITEM and whose type and Texinfo attributes are +specified by CMD and ARGS." + (let ((contents (org-element-contents item))) + (org-element-insert-before + (apply #'org-element-create 'special-block + (list :type cmd + :attr_texinfo (list (format ":options %s" args)) + :post-blank (if contents 1 0)) + (mapc #'org-element-extract-element contents)) + plain-list)) + (org-element-extract-element item)) + +(defun org-texinfo--split-plain-list (plain-list items) + "Insert a new plain list before the plain list PLAIN-LIST. +Remove ITEMS from PLAIN-LIST and use them as the contents of the +new plain list." + (org-element-insert-before + (apply #'org-element-create 'plain-list + (list :type 'descriptive + :attr_texinfo (org-element-property :attr_texinfo plain-list) + :post-blank 1) + (mapc #'org-element-extract-element items)) + plain-list)) + +(defun org-texinfo--massage-key-item (plain-list item args) + "In PLAIN-LIST modify ITEM based on ARGS. + +Reformat ITEM's tag property and determine the arguments for the +`@findex' and `@kindex' commands for ITEM and store them in ITEM +using the `:findex' and `:kindex' properties. + +If PLAIN-LIST is a description list whose `:compact' attribute is +non-nil and ITEM has no content but is followed by another item, +then store the `@findex' and `@kindex' values in the next item. +If the previous item stored its respecive values in this item, +then move them to the next item." + (let ((key nil) + (cmd nil)) + (if (string-match (rx (+ " ") + "(" (group (+ (not (any "()")))) ")" + (* " ") + eos) + args) + (setq key (substring args 0 (match-beginning 0)) + cmd (match-string 1 args)) + (setq key args)) + (org-element-put-property + item :tag + (cons (org-export-raw-string (org-texinfo-kbd-macro key t)) + (and cmd `(" (" (code (:value ,cmd :post-blank 0)) ")")))) + (let ((findex (org-element-property :findex item)) + (kindex (org-element-property :kindex item)) + (next-item (org-export-get-next-element item nil)) + (mx (string-prefix-p "M-x " key))) + (when (and (not cmd) mx) + (setq cmd (substring key 4))) + (when (and cmd (not (member cmd findex))) + (setq findex (nconc findex (list cmd)))) + (unless mx + (setq kindex (nconc kindex (list key)))) + (cond + ((and next-item + (org-not-nil + (org-export-read-attribute :attr_texinfo plain-list :compact)) + (not (org-element-contents item)) + (eq 1 (org-element-property :post-blank item))) + (org-element-put-property next-item :findex findex) + (org-element-put-property next-item :kindex kindex) + (org-element-put-property item :findex nil) + (org-element-put-property item :kindex nil)) + (t + (org-element-set-contents + item + (nconc (mapcar (lambda (key) `(keyword (:key "KINDEX" :value ,key))) kindex) + (mapcar (lambda (cmd) `(keyword (:key "FINDEX" :value ,cmd))) findex) + (org-element-contents item)))))))) + ;;; Template (defun org-texinfo-template (contents info) -- 2.34.1