From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id iHbaDXq0bGYOHgAAe85BDQ:P1 (envelope-from ) for ; Fri, 14 Jun 2024 21:22:02 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id iHbaDXq0bGYOHgAAe85BDQ (envelope-from ) for ; Fri, 14 Jun 2024 23:22:02 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=adamkovic.org header.s=fm3 header.b="a Fdnzum"; dkim=pass header.d=messagingengine.com header.s=fm1 header.b=JLb74JBS; 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"; dmarc=pass (policy=none) header.from=adamkovic.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1718400122; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=ekVr680d+C6OeP08VUPkbIpxzw4QZPH0JqMVJTqSHcU=; b=pqxuWKRwCLIPe3cJMd1Bc/anZP/uUZfzqFq70fxuedUSHm+4xjKGjntMW7tOwvpUiJwhxj lWpuvQYqKuvJuXnCXTcOJYYnhPnVgoF4dufKevbYEhijOCfkvv1pGDD85lTZnLsA19XUwJ A1U/9g7i7jNSByFRhUB5x0SQWObrD1wTlQcjZkugas9PCiQHD4u7ziWwoiHOQMAlYm6Vii vR73HNZxsKvwGvPbceZF9thDe8lbSwQLIycacThnTQofHM9bjpXT49k7sDXbN2MAff/7M3 h22dEXt6Kqlsst1FMa2ZpNK4igBC7ILLzcerU8Mj9BxZPPm1QQfnoP9GnMacwg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=adamkovic.org header.s=fm3 header.b="a Fdnzum"; dkim=pass header.d=messagingengine.com header.s=fm1 header.b=JLb74JBS; 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"; dmarc=pass (policy=none) header.from=adamkovic.org ARC-Seal: i=1; s=key1; d=yhetil.org; t=1718400122; a=rsa-sha256; cv=none; b=CUfl+cXSew/JApaY3JzrPb4kAJz4+CRkroI2JSBGlQQiZVkW8M9CHo47ut8hM6BkNoQdBP OT3MGRr/xs/JpluYqegb7qgfO6DESXJYHMjZMwjL0plcZfGZqxreVxgLfMgO4CQhFLh4Az PrPF50deJeLOt6fP5NJcVKqcoeRTifeyyVK3h7V0coh9pRTq0ISKtczkp5gzq6dOtaWqoH EK73pIskvEAXNluvhqmyXKLJ4yr8XT9kc4rihwxgV+t2jUfq2ewfjIXXSNbUOVkCr+fELx 0rVEmgsGzfzaFbcSy2PZo+mOfhEe4A5i95y3rwPCko4DLX01AeVLJxqvwz26dg== 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 3A53B56D4F for ; Fri, 14 Jun 2024 23:22:01 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sIEMB-0007An-Re; Fri, 14 Jun 2024 17:21:11 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sIEMA-0007Ac-FW for emacs-orgmode@gnu.org; Fri, 14 Jun 2024 17:21:10 -0400 Received: from wfhigh8-smtp.messagingengine.com ([64.147.123.159]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sIEM5-0003FV-3R for emacs-orgmode@gnu.org; Fri, 14 Jun 2024 17:21:10 -0400 Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailfhigh.west.internal (Postfix) with ESMTP id DF1CA1800118; Fri, 14 Jun 2024 17:21:01 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Fri, 14 Jun 2024 17:21:02 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adamkovic.org; h=cc:cc:content-type:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to; s=fm3; t=1718400061; x= 1718486461; bh=ekVr680d+C6OeP08VUPkbIpxzw4QZPH0JqMVJTqSHcU=; b=a FdnzumBYAbbxeuYP69730opLJPWz1NCHA0/vc3VgHtLH4t+vvrvEuGx3x+eD8tDp jEQXSQB7WevIxdjzDdmBA+SJuRlo956NFNec1agE1GpSkfS43l0pB/wCMyoIYjh5 g61VV8UTsiZ4J7W6dkuE3KigfN6ZZKTW3wZVICHWtrhJXkQjiRzaasoyxs+kq3zP okBsjRT3tLpX9HwiijVZdVypbOvW5f2hcGbVEiL1tQ4n6mF6NE9Mkup/Xcq/yMKh mP/jl0bo/xrXltqbxVc6qCkeiRIEKXP17rRUvCD1GQqPQMokOQbJv0n3X9GORLeW 2hU0Xc1pXBl8tLK9b+lsQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1718400061; x=1718486461; bh=ekVr680d+C6OeP08VUPkbIpxzw4Q ZPH0JqMVJTqSHcU=; b=JLb74JBS3nS5XP9ocB1JtVje751tcs05ewNLamvwbBB9 G6lMb8ghMDdDxddjf/ulJXR8Mg0Cyiall4GIVOzdYBfDQjoqkg1YkilVFlusVbG+ q3gb+fajWdOib8hExbLDYaZyjOIKcpw2A2yagr88XmTd4l5NUnL6JYsotP1YIYNC KS6yUixjIkl7k7bdLlh/i3Rh33y+71Naw84oFw7ufQASgEC0+7ShJRKCwuYYh1oy Hao5ETqsx7s2hh1o5Vu8HizLXcZlqIfdL2I1vSrwkEO/0GIYEM+zVeWVpjVZ4uUU dEr5VwTpKcoClJQ9RIz26jutmImYTx4kXtbuN5Prvw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrfeduledgudehlecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvfevufgjfhffkfggtgesmhdtreertddtjeenucfhrhhomheptfhuugho lhhfucetuggrmhhkohhvihgtuceorhhuugholhhfsegruggrmhhkohhvihgtrdhorhhgqe enucggtffrrghtthgvrhhnpeevkeekhfeuvdethedtjeejheduleduueeliedugfegveef jeekjeevtdetlefgveenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrih hlfhhrohhmpehruhguohhlfhesrggurghmkhhovhhitgdrohhrgh X-ME-Proxy: Feedback-ID: i88214938:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 14 Jun 2024 17:20:59 -0400 (EDT) From: Rudolf =?utf-8?Q?Adamkovi=C4=8D?= To: Ihor Radchenko Cc: Max Nikulin , emacs-orgmode@gnu.org Subject: Re: [PATCH] ob-lua: Support all types and multiple values in results In-Reply-To: References: <20240423164458.33702-1-rudolf@adamkovic.org> <8734raewr6.fsf@localhost> <87pluctf6m.fsf@localhost> <87il01k6k1.fsf@localhost> <216278dc-075c-47d1-94dc-f5bde8346b3c@gmail.com> <877cgc9nea.fsf@localhost> Date: Fri, 14 Jun 2024 23:20:58 +0200 Message-ID: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=64.147.123.159; envelope-from=rudolf@adamkovic.org; helo=wfhigh8-smtp.messagingengine.com 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, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -10.54 X-Spam-Score: -10.54 X-Migadu-Queue-Id: 3A53B56D4F X-Migadu-Scanner: mx13.migadu.com X-TUID: PwC1NmCcZY0F --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Rudolf Adamkovi=C4=8D writes: > #StillCooking :) All right, here we go! 5 patches, all based on top of the head (73da6beb5) of `main' as of today (2024-06-14), in order: 0. [main, as of today] 1. ob-lua: Escape double quote characters in results 2. ob-lua: Sort tabular results 3. ob-lua: Remove half-baked session support 4. ob-lua: Improve documentation strings and commentary 5. ob-lua: Do not confuse list-like strings with lists Rudy --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-ob-lua-Escape-double-quote-characters-in-results.patch >From 6dcca348337c05d33d62da6eeb1f4193b73f4d6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Fri, 14 Jun 2024 16:55:24 +0200 Subject: [PATCH 1/5] ob-lua: Escape double quote characters in results * lisp/ob-lua.el (org-babel-lua-wrapper-method): Escape all double quote characters in Lua before giving them to Org Babel. * testing/lisp/test-ob-lua.el (test-ob-lua/escaping-quotes): Test automatic escaping of double quote characters. Reported-by: Max Nikulin Link: https://list.orgmode.org/216278dc-075c-47d1-94dc-f5bde8346b3c@gmail.com/ --- lisp/ob-lua.el | 2 +- testing/lisp/test-ob-lua.el | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el index 041abfabc..0168bc070 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -283,7 +283,7 @@ function dump(it, indent) end return result else - return tostring(it) + return string.gsub(tostring(it), '\"', '\\\"') end end diff --git a/testing/lisp/test-ob-lua.el b/testing/lisp/test-ob-lua.el index 0a60c68ca..ff69f5411 100644 --- a/testing/lisp/test-ob-lua.el +++ b/testing/lisp/test-ob-lua.el @@ -176,6 +176,12 @@ return x (org-test-with-temp-text "src_lua{return 1, 2, 3}" (org-babel-execute-src-block)))))) +(ert-deftest test-ob-lua/escaping-quotes () + (should + (equal "A \" B" + (org-test-with-temp-text "src_lua{return 'A \" B'}" + (org-babel-execute-src-block))))) + (provide 'test-ob-lua) ;;; test-ob-lua.el ends here -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-ob-lua-Sort-tabular-results.patch >From 93acae0704e873168f27d304901cde8fd9524dd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Fri, 14 Jun 2024 16:59:37 +0200 Subject: [PATCH 2/5] ob-lua: Sort tabular results `test-ob-lua/colnames-yes-header-argument-pp' fails intermittently due to tabular results being returned from Lua to Emacs Lisp in different order than expected. We fix the problem by sorting all tabular results before returning them. * lisp/ob-lua.el (org-babel-lua-wrapper-method): Sort all tabular results, recursively, before returning them from Lua to Emacs Lisp. --- lisp/ob-lua.el | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el index 0168bc070..b2eb46c07 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -270,7 +270,13 @@ function dump(it, indent) if #indent ~= 0 then result = result .. '\\n' end - for key, value in pairs(it) do + local keys = {} + for key in pairs(it) do + table.insert(keys, key) + end + table.sort(keys) + for _, key in pairs(keys) do + local value = it[key] result = result .. indent .. dump(key) -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0003-ob-lua-Remove-half-baked-session-support.patch >From d7034c49212af85c141391bf1dbb5e891aea30ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Fri, 14 Jun 2024 17:36:19 +0200 Subject: [PATCH 3/5] ob-lua: Remove half-baked session support * lisp/ob-lua.el (org-babel-execute:lua): (org-babel-prep-session:lua): (org-babel-load-session:lua): (org-babel-lua-session-buffer): (org-babel-lua-with-earmuffs): (org-babel-session-buffer:lua): (org-babel-lua-without-earmuffs): (lua-default-interpreter): (lua-which-bufname): (lua-shell-buffer-name): (org-babel-lua-initiate-session-by-key): (org-babel-lua-initiate-session): (org-babel-lua-evaluate): (org-babel-lua-evaluate-external-process): (org-babel-lua-evaluate-session): (org-babel-lua-read-string): Remove all unfinished Lua and Emacs Lisp code related to sessions and emit a user error when a Lua session is requested. * testing/lisp/test-ob-lua.el (test-ob-lua/no-sessions): Test the user error emitted when requesting a Lua session. Link: https://list.orgmode.org/87y192etb4.fsf@localhost/ --- lisp/ob-lua.el | 205 +----------------------------------- testing/lisp/test-ob-lua.el | 9 ++ 2 files changed, 14 insertions(+), 200 deletions(-) diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el index b2eb46c07..54405f898 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -25,15 +25,6 @@ ;; Org-Babel support for evaluating lua source code. -;; Requirements: -;; for session support, lua-mode is needed. -;; lua-mode is not part of GNU Emacs/orgmode, but can be obtained -;; from marmalade or melpa. -;; The source repository is here: -;; https://github.com/immerrr/lua-mode - -;; However, sessions are not yet working. - ;;; Code: (require 'org-macs) @@ -90,11 +81,10 @@ This will typically be `lua-mode'." (defun org-babel-execute:lua (body params) "Execute Lua BODY according to PARAMS. This function is called by `org-babel-execute-src-block'." - (let* ((session (org-babel-lua-initiate-session - (cdr (assq :session params)))) + (let* ((session (cdr (assq :session params))) (result-params (cdr (assq :result-params params))) (result-type (cdr (assq :result-type params))) - (return-val (when (and (eq result-type 'value) (not session)) + (return-val (when (eq result-type 'value) (cdr (assq :return params)))) (preamble (cdr (assq :preamble params))) (full-body @@ -102,7 +92,9 @@ This function is called by `org-babel-execute-src-block'." (concat body (if return-val (format "\nreturn %s" return-val) "")) params (org-babel-variable-assignments:lua params))) (result (org-babel-lua-evaluate - session full-body result-type result-params preamble))) + full-body result-type result-params preamble))) + (when (and session (not (equal session "none"))) + (user-error "Sessions not supported for Lua")) (org-babel-reassemble-table result (org-babel-pick-name (cdr (assq :colname-names params)) @@ -110,28 +102,6 @@ This function is called by `org-babel-execute-src-block'." (org-babel-pick-name (cdr (assq :rowname-names params)) (cdr (assq :rownames params)))))) -(defun org-babel-prep-session:lua (session params) - "Prepare SESSION according to the header arguments in PARAMS. -VARS contains resolved variable references." - (let* ((session (org-babel-lua-initiate-session session)) - (var-lines - (org-babel-variable-assignments:lua params))) - (org-babel-comint-in-buffer session - (mapc (lambda (var) - (end-of-line 1) (insert var) (comint-send-input) - (org-babel-comint-wait-for-output session)) - var-lines)) - session)) - -(defun org-babel-load-session:lua (session body params) - "Load BODY into SESSION." - (save-window-excursion - (let ((buffer (org-babel-prep-session:lua session params))) - (with-current-buffer buffer - (goto-char (process-mark (get-buffer-process (current-buffer)))) - (insert (org-babel-chomp body))) - buffer))) - ;; helper functions (defun org-babel-variable-assignments:lua (params) @@ -178,76 +148,6 @@ Emacs-lisp table, otherwise return the results as a string." (defvar org-babel-lua-buffers '((:default . "*Lua*"))) -(defun org-babel-lua-session-buffer (session) - "Return the buffer associated with SESSION." - (cdr (assoc session org-babel-lua-buffers))) - -(defun org-babel-lua-with-earmuffs (session) - "Return buffer name for SESSION, as *SESSION*." - (let ((name (if (stringp session) session (format "%s" session)))) - (if (and (string= "*" (substring name 0 1)) - (string= "*" (substring name (- (length name) 1)))) - name - (format "*%s*" name)))) - -(defun org-babel-session-buffer:lua (session &optional _) - "Return session buffer name for SESSION." - (or (org-babel-lua-session-buffer session) - (org-babel-lua-with-earmuffs session))) - -(defun org-babel-lua-without-earmuffs (session) -"Remove stars around *SESSION*, leaving SESSION." - (let ((name (if (stringp session) session (format "%s" session)))) - (if (and (string= "*" (substring name 0 1)) - (string= "*" (substring name (- (length name) 1)))) - (substring name 1 (- (length name) 1)) - name))) - -(defvar lua-default-interpreter) -(defvar lua-which-bufname) -(defvar lua-shell-buffer-name) -(defun org-babel-lua-initiate-session-by-key (&optional session) - "Initiate a lua session. -If there is not a current inferior-process-buffer in SESSION -then create. Return the initialized session." - ;; (require org-babel-lua-mode) - (save-window-excursion - (let* ((session (if session (intern session) :default)) - (lua-buffer (org-babel-lua-session-buffer session)) - ;; (cmd (if (member system-type '(cygwin windows-nt ms-dos)) - ;; (concat org-babel-lua-command " -i") - ;; org-babel-lua-command)) - ) - (cond - ((and (eq 'lua-mode org-babel-lua-mode) - (fboundp 'lua-start-process)) ; lua-mode.el - ;; Make sure that lua-which-bufname is initialized, as otherwise - ;; it will be overwritten the first time a Lua buffer is - ;; created. - ;;(lua-toggle-shells lua-default-interpreter) - ;; `lua-shell' creates a buffer whose name is the value of - ;; `lua-which-bufname' with '*'s at the beginning and end - (let* ((bufname (if (and lua-buffer (buffer-live-p lua-buffer)) - (replace-regexp-in-string ;; zap surrounding * - "^\\*\\([^*]+\\)\\*$" "\\1" (buffer-name lua-buffer)) - (concat "Lua-" (symbol-name session)))) - (lua-which-bufname bufname)) - (lua-start-process) - (setq lua-buffer (org-babel-lua-with-earmuffs bufname)))) - (t - (error "No function available for running an inferior Lua"))) - (setq org-babel-lua-buffers - (cons (cons session lua-buffer) - (assq-delete-all session org-babel-lua-buffers))) - session))) - -(defun org-babel-lua-initiate-session (&optional session _params) - "Create a session named SESSION according to PARAMS." - (unless (string= session "none") - (error "Sessions currently not supported, work in progress") - (org-babel-lua-session-buffer - (org-babel-lua-initiate-session-by-key session)))) - (defvar org-babel-lua-eoe-indicator "--eoe" "A string to indicate that evaluation has completed.") @@ -306,19 +206,6 @@ output:write(combine(main())) output:close()") (defun org-babel-lua-evaluate - (session body &optional result-type result-params preamble) - "Evaluate BODY in SESSION as Lua code. -RESULT-TYPE and RESULT-PARAMS are passed to -`org-babel-lua-evaluate-session' or -`org-babel-lua-evaluate-external-process'. -PREAMBLE is passed to `org-babel-lua-evaluate-external-process'." - (if session - (org-babel-lua-evaluate-session - session body result-type result-params) - (org-babel-lua-evaluate-external-process - body result-type result-params preamble))) - -(defun org-babel-lua-evaluate-external-process (body &optional result-type result-params preamble) "Evaluate BODY in external Lua process. If RESULT-TYPE equals `output' then return standard output as a @@ -354,88 +241,6 @@ PREAMBLE string is appended to BODY." raw (org-babel-lua-table-or-string (org-trim raw))))) -(defun org-babel-lua-evaluate-session - (session body &optional result-type result-params) - "Pass BODY to the Lua process in SESSION. -If RESULT-TYPE equals `output' then return standard output as a -string. If RESULT-TYPE equals `value' then return the value of the -last statement in BODY, as elisp." - (let* ((send-wait (lambda () (comint-send-input nil t) (sleep-for 0.005))) - (dump-last-value - (lambda - (tmp-file pp) - (mapc - (lambda (statement) (insert statement) (funcall send-wait)) - (if pp - (list - "-- table to string -function t2s(t, indent) - if indent == nil then - indent = \"\" - end - if type(t) == \"table\" then - ts = \"\" - for k,v in pairs(t) do - if type(v) == \"table\" then - ts = ts .. indent .. t2s(k,indent .. \" \") .. \" = \\n\" .. - t2s(v, indent .. \" \") - else - ts = ts .. indent .. t2s(k,indent .. \" \") .. \" = \" .. - t2s(v, indent .. \" \") .. \"\\n\" - end - end - return ts - else - return tostring(t) - end -end -" - (concat "fd:write(_)) -fd:close()" - (org-babel-process-file-name tmp-file 'noquote))) - (list (format "fd=io.open(\"%s\", \"w\") -fd:write( _ ) -fd:close()" - (org-babel-process-file-name tmp-file - 'noquote))))))) - (input-body (lambda (body) - (mapc (lambda (line) (insert line) (funcall send-wait)) - (split-string body "[\r\n]")) - (funcall send-wait))) - (results - (pcase result-type - (`output - (mapconcat - #'org-trim - (butlast - (org-babel-comint-with-output - (session org-babel-lua-eoe-indicator t body) - (funcall input-body body) - (funcall send-wait) (funcall send-wait) - (insert org-babel-lua-eoe-indicator) - (funcall send-wait)) - 2) "\n")) - (`value - (let ((tmp-file (org-babel-temp-file "lua-"))) - (org-babel-comint-with-output - (session org-babel-lua-eoe-indicator nil body) - (let ((comint-process-echoes nil)) - (funcall input-body body) - (funcall dump-last-value tmp-file - (member "pp" result-params)) - (funcall send-wait) (funcall send-wait) - (insert org-babel-lua-eoe-indicator) - (funcall send-wait))) - (org-babel-eval-read-file tmp-file)))))) - (unless (string= (substring org-babel-lua-eoe-indicator 1 -1) results) - (org-babel-result-cond result-params - results - (org-babel-lua-table-or-string results))))) - -(defun org-babel-lua-read-string (string) - "Strip single quotes from around Lua STRING." - (org-unbracket-string "'" "'" string)) - (provide 'ob-lua) ;;; ob-lua.el ends here diff --git a/testing/lisp/test-ob-lua.el b/testing/lisp/test-ob-lua.el index ff69f5411..58a120e25 100644 --- a/testing/lisp/test-ob-lua.el +++ b/testing/lisp/test-ob-lua.el @@ -182,6 +182,15 @@ return x (org-test-with-temp-text "src_lua{return 'A \" B'}" (org-babel-execute-src-block))))) +(ert-deftest test-ob-lua/no-sessions () + (should + (equal + '(user-error "Sessions not supported for Lua") + (should-error + (org-test-with-temp-text "src_lua[:session 1]{}" + (org-babel-execute-src-block)) + :type 'user-error)))) + (provide 'test-ob-lua) ;;; test-ob-lua.el ends here -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0004-ob-lua-Improve-documentation-strings-and-commentary.patch >From 6749c0e4a1389ba4272efba02ee13fc850aa8f67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Fri, 14 Jun 2024 17:47:17 +0200 Subject: [PATCH 4/5] ob-lua: Improve documentation strings and commentary * lisp/ob-lua.el (org-babel-lua-mode): (org-babel-lua-hline-to): (org-babel-lua-None-to): (org-babel-lua-var-to-lua): (org-babel-lua-table-or-string): (org-babel-lua-evaluate-external-process): Harmonize spelling, capitalization, and quoting. --- lisp/ob-lua.el | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el index 54405f898..10001626a 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -23,7 +23,7 @@ ;;; Commentary: -;; Org-Babel support for evaluating lua source code. +;; Org Babel support for evaluating Lua source code. ;;; Code: @@ -51,7 +51,7 @@ :type 'string) (defcustom org-babel-lua-mode 'lua-mode - "Preferred lua mode for use in running lua interactively. + "Preferred Lua mode for use in running Lua interactively. This will typically be `lua-mode'." :group 'org-babel :version "26.1" @@ -59,14 +59,14 @@ This will typically be `lua-mode'." :type 'symbol) (defcustom org-babel-lua-hline-to "None" - "Replace hlines in incoming tables with this when translating to lua." + "Replace `hlines' in incoming tables with this when translating to Lua." :group 'org-babel :version "26.1" :package-version '(Org . "8.3") :type 'string) (defcustom org-babel-lua-None-to 'hline - "Replace `None' in lua tables with this before returning." + "Replace `None' in Lua tables with this before returning." :group 'org-babel :version "26.1" :package-version '(Org . "8.3") @@ -115,8 +115,8 @@ The variable definitions are defining in PARAMS." (org-babel--get-vars params))) (defun org-babel-lua-var-to-lua (var) - "Convert an elisp value to a lua variable. -Convert an elisp value, VAR, into a string of lua source code + "Convert an Emacs Lisp value to a Lua variable. +Convert an Emacs Lisp value, VAR, into a string of Lua source code specifying a variable of the same value." (if (listp var) (if (and (= 1 (length var)) (not (listp (car var)))) @@ -136,9 +136,9 @@ specifying a variable of the same value." (if (stringp var) (substring-no-properties var) var))))) (defun org-babel-lua-table-or-string (results) - "Convert RESULTS into an appropriate elisp value. + "Convert RESULTS into an appropriate Emacs Lisp value. If the results look like a list or tuple, then convert them into an -Emacs-lisp table, otherwise return the results as a string." +Emacs Lisp table, otherwise return the results as a string." (let ((res (org-babel-script-escape results))) (if (listp res) (mapcar (lambda (el) (if (eq el 'None) @@ -210,7 +210,7 @@ output:close()") "Evaluate BODY in external Lua process. If RESULT-TYPE equals `output' then return standard output as a string. If RESULT-TYPE equals `value' then return the value of the -last statement in BODY, as elisp. +last statement in BODY, as Emacs Lisp. RESULT-PARAMS list all the :result header arg parameters. PREAMBLE string is appended to BODY." (let ((raw -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0005-ob-lua-Do-not-confuse-list-like-strings-with-lists.patch >From d9c61349d2cc6b07460fd9078c2ca29aef20b999 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Fri, 14 Jun 2024 22:43:15 +0200 Subject: [PATCH 5/5] ob-lua: Do not confuse list-like strings with lists * lisp/ob-lua.el (org-babel-lua-wrapper-method): Prevent Org Babel from confusing strings that look like lists with actual lists. * testing/lisp/test-ob-lua.el (test-ob-lua/result/none): (test-ob-lua/result/nil): (test-ob-lua/result/nil/multiple): (test-ob-lua/result/boolean): (test-ob-lua/results/number/integer): (test-ob-lua/results/number/integer/negative): (test-ob-lua/results/number/integer/multiple): (test-ob-lua/results/number/real): (test-ob-lua/results/number/real/multiple): (test-ob-lua/results/number/infinity): (test-ob-lua/results/string/single-quotes): (test-ob-lua/results/string/double-quotes): (test-ob-lua/results/string/multiple): (test-ob-lua/results/string/list-like): (test-ob-lua/results/string/list-like/brackets): (test-ob-lua/results/string/list-like/curlies): (test-ob-lua/results/string/list-like/multiple): (test-ob-lua/result/table): (test-ob-lua/result/table/pretty-print): (test-ob-lua/result/table/pretty-print/sorted): (test-ob-lua/results/value-separator): Add new tests. --- lisp/ob-lua.el | 28 +++- testing/lisp/test-ob-lua.el | 289 ++++++++++++++++++++++++++++++++---- 2 files changed, 279 insertions(+), 38 deletions(-) diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el index 10001626a..f7950eadd 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -161,32 +161,33 @@ function dump(it, indent) if indent == nil then indent = '' end + if type(it) == 'table' and %s then - local count = 0 - for _ in pairs(it) do - count = count + 1 - end local result = '' + if #indent ~= 0 then result = result .. '\\n' end + local keys = {} for key in pairs(it) do table.insert(keys, key) end + table.sort(keys) - for _, key in pairs(keys) do + + for index, key in pairs(keys) do local value = it[key] result = result .. indent .. dump(key) .. ' = ' .. dump(value, indent .. ' ') - count = count - 1 - if count ~= 0 then + if index ~= #keys then result = result .. '\\n' end end + return result else return string.gsub(tostring(it), '\"', '\\\"') @@ -195,10 +196,21 @@ end function combine(...) local result = {} + for index = 1, select('#', ...) do result[index] = dump(select(index, ...)) end - return table.concat(result, '%s') + + if #result == 1 then + local value = result[1] + if string.find(value, '[%%(%%[{]') == 1 then + return '\"' .. value .. '\"' + else + return value + end + end + + return '\"' .. table.concat(result, '%s') .. '\"' end output = io.open('%s', 'w') diff --git a/testing/lisp/test-ob-lua.el b/testing/lisp/test-ob-lua.el index 58a120e25..48648d1c7 100644 --- a/testing/lisp/test-ob-lua.el +++ b/testing/lisp/test-ob-lua.el @@ -136,45 +136,274 @@ return x (org-babel-next-src-block) (org-babel-execute-src-block))))) -(ert-deftest test-ob-lua/types () - "Test returning different types." +(ert-deftest test-ob-lua/result/none () + "Test returning nothing." (should - (equal "nil" - (org-test-with-temp-text "src_lua{return nil}" - (org-babel-execute-src-block)))) + (equal + ;; FIXME Update `ob-core' to output e.g. "{{{results(n/a)}}}" or + ;; "{{{results(/no results/)}}}", for the empty verbatim breaks + ;; e.g. HTML export. + "src_lua{return} {{{results(==)}}}" + (org-test-with-temp-text "src_lua{return}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/result/nil () + "Test returning nothing." (should - (equal "true" - (org-test-with-temp-text "src_lua{return true}" - (org-babel-execute-src-block)))) + (equal + "src_lua{return nil} {{{results(=nil=)}}}" + (org-test-with-temp-text "src_lua{return nil}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/result/nil/multiple () + "Test returning multiple nothings." + (should + (equal + "src_lua{return nil, nil} {{{results(=nil\\, nil=)}}}" + (org-test-with-temp-text "src_lua{return nil, nil}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/result/boolean () + "Test returning the boolean values true and false." (should - (equal "false" - (org-test-with-temp-text "src_lua{return false}" - (org-babel-execute-src-block)))) + (equal + "src_lua{return true} {{{results(=true=)}}}" + (org-test-with-temp-text "src_lua{return true}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max))))) (should - (equal 1 - (org-test-with-temp-text "src_lua{return 1}" - (org-babel-execute-src-block)))) + (equal + "src_lua{return false} {{{results(=false=)}}}" + (org-test-with-temp-text "src_lua{return false}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/number/integer () + "Test returning integers." (should - (equal "hello world" - (org-test-with-temp-text "src_lua{return 'hello world'}" - (org-babel-execute-src-block)))) + (equal + "src_lua{return 1} {{{results(=1=)}}}" + (org-test-with-temp-text "src_lua{return 1}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/number/integer/negative () + "Test returning negative integers." (should - (equal 0 - (string-match "table: 0x[0-9A-F]+" - (org-test-with-temp-text "src_lua{return {}}" - (org-babel-execute-src-block)))))) + (equal + "src_lua{return -1} {{{results(=-1=)}}}" + (org-test-with-temp-text "src_lua{return -1}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) -(ert-deftest test-ob-lua/multiple-values () - "Test returning multiple values." +(ert-deftest test-ob-lua/results/number/integer/multiple () + "Test returning multiple integers at once." (should - (equal "1, 2, 3" - (org-test-with-temp-text "src_lua{return 1, 2, 3}" - (org-babel-execute-src-block)))) + (equal + "src_lua{return 1, 2, 3} {{{results(=1\\, 2\\, 3=)}}}" + (org-test-with-temp-text "src_lua{return 1, 2, 3}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/number/real () + "Test returning real numbers." + (should + (equal + "src_lua{return 1.5} {{{results(=1.5=)}}}" + (org-test-with-temp-text "src_lua{return 1.5}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/number/real/multiple () + "Test returning multiple real numbers at once." + (should + (equal + "src_lua{return 1.5, 2.5, 3.5} {{{results(=1.5\\, 2.5\\, 3.5=)}}}" + (org-test-with-temp-text "src_lua{return 1.5, 2.5, 3.5}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/number/infinity () + "Test returning the infinity." + (should + (equal + "src_lua{return 1 / 0} {{{results(=inf=)}}}" + (org-test-with-temp-text "src_lua{return 1 / 0}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/single-quotes () + "Test returning strings in single quotes." + (should + (equal + "src_lua{return 'hello world'} {{{results(=hello world=)}}}" + (org-test-with-temp-text "src_lua{return 'hello world'}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/double-quotes () + "Test returning strings in double quotes." (should - (equal "1|2|3" - (let ((org-babel-lua-multiple-values-separator "|")) - (org-test-with-temp-text "src_lua{return 1, 2, 3}" - (org-babel-execute-src-block)))))) + (equal + "src_lua{return \"hello world\"} {{{results(=hello world=)}}}" + (org-test-with-temp-text "src_lua{return \"hello world\"}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/multiple () + "Test returning multiple strings at once." + (should + (equal + "src_lua{return 'a', 'b'} {{{results(=a\\, b=)}}}" + (org-test-with-temp-text "src_lua{return 'a', 'b'}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/list-like () + "Test returning strings that look like \"(...)\" lists." + (should + (equal + (concat "src_lua{return string.match('A (B) C', '%b()')}" + " {{{results(=(B)=)}}}") + (org-test-with-temp-text + "src_lua{return string.match('A (B) C', '%b()')}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/list-like/brackets () + "Test returning strings that look like \"[...]\" lists." + (should + (equal + (concat "src_lua{return string.match('A [B] C', '%b[]')}" + " {{{results(=[B]=)}}}") + (org-test-with-temp-text + "src_lua{return string.match('A [B] C', '%b[]')}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/list-like/curlies () + "Test returning strings that look like \"{...}\" lists." + (should + (equal + (concat "src_lua{return string.match('A {B} C', '%b{}')}" + " {{{results(={B}=)}}}") + (org-test-with-temp-text + "src_lua{return string.match('A {B} C', '%b{}')}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/string/list-like/multiple () + "Test returning multiple strings that look like \"(...)\" lists." + (should + (equal + (concat "src_lua{return '(A)', '(B)'}" + " {{{results(=(A)\\, (B)=)}}}") + (org-test-with-temp-text + "src_lua{return '(A)', '(B)'}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/result/table () + "Test returning table references." + (should + (equal + 0 + (string-match + "src_lua{return {}} {{{results(=table: 0x[0-9A-F]+=)}}}" + (org-test-with-temp-text "src_lua{return {}}" + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max))))))) + +(ert-deftest test-ob-lua/result/table/pretty-print () + "Test returning and pretty-printing sequential tables." + (should + (equal (string-join + '("#+BEGIN_SRC lua :results pp" + "return {10, {20, 30, {40, 50}, 60}, 70}" + "#+END_SRC" + "" + "#+RESULTS:" + ": 1 = 10" + ": 2 = " ; FIXME Trailing space. + ": 1 = 20" + ": 2 = 30" + ": 3 = " ; FIXME Trailing space. + ": 1 = 40" + ": 2 = 50" + ": 4 = 60" + ": 3 = 70" + "") + "\n") + (org-test-with-temp-text + (string-join + '("#+BEGIN_SRC lua :results pp" + "return {10, {20, 30, {40, 50}, 60}, 70}" + "#+END_SRC") + "\n") + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/result/table/pretty-print/sorted () + "Test returning and pretty-printing non-sequential tables." + (should + (equal (string-join + '("#+BEGIN_SRC lua :results pp" + "return {b = 20, c = 30, a = 10}" + "#+END_SRC" + "" + "#+RESULTS:" + ;; NOTE The keys are sorted alphabetically. + ": a = 10" + ": b = 20" + ": c = 30" + "") + "\n") + (org-test-with-temp-text + (string-join + '("#+BEGIN_SRC lua :results pp" + "return {b = 20, c = 30, a = 10}" + "#+END_SRC") + "\n") + (org-babel-execute-src-block) + (buffer-substring-no-properties (point-min) + (point-max)))))) + +(ert-deftest test-ob-lua/results/value-separator () + "Test customizing the separator of multiple values." + ;; TODO Once Org Babel supports returning lists from inline blocks, + ;; instead of trapping with the user error: "Inline error: list + ;; result cannot be used", use those for multiple values. + (should + (equal + "src_lua{return 1, 2, 3} {{{results(=1\t2\t3=)}}}" + (org-test-with-temp-text "src_lua{return 1, 2, 3}" + (let ((org-babel-lua-multiple-values-separator "\t")) + (org-babel-execute-src-block)) + (buffer-substring-no-properties (point-min) + (point-max)))))) (ert-deftest test-ob-lua/escaping-quotes () (should -- 2.39.3 (Apple Git-146) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable --=20 "I love deadlines. I love the whooshing noise they make as they go by." --- Douglas Adams, The Salmon of Doubt, 2002 Rudolf Adamkovi=C4=8D [he/him] http://adamkovic.org --=-=-=--