From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: taylanbayirli@gmail.com (Taylan Ulrich =?utf-8?Q?Bay=C4=B1rl=C4=B1?= =?utf-8?Q?=2FKammer?=) Newsgroups: gmane.emacs.devel Subject: [PATCH] Add shell-quasiquote. Date: Sat, 17 Oct 2015 18:33:01 +0200 Message-ID: <87si59wj42.fsf@T420.taylan> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: ger.gmane.org 1445099607 12021 80.91.229.3 (17 Oct 2015 16:33:27 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 17 Oct 2015 16:33:27 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Oct 17 18:33:27 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZnUQA-00018M-FD for ged-emacs-devel@m.gmane.org; Sat, 17 Oct 2015 18:33:26 +0200 Original-Received: from localhost ([::1]:59039 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZnUQ9-0007BH-HS for ged-emacs-devel@m.gmane.org; Sat, 17 Oct 2015 12:33:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56452) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZnUPp-0007B0-GA for emacs-devel@gnu.org; Sat, 17 Oct 2015 12:33:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZnUPo-0006wM-4Y for emacs-devel@gnu.org; Sat, 17 Oct 2015 12:33:05 -0400 Original-Received: from mail-wi0-x22b.google.com ([2a00:1450:400c:c05::22b]:36771) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZnUPn-0006wI-Ro for emacs-devel@gnu.org; Sat, 17 Oct 2015 12:33:04 -0400 Original-Received: by wicgb1 with SMTP id gb1so43608265wic.1 for ; Sat, 17 Oct 2015 09:33:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:subject:date:message-id:user-agent:mime-version :content-type; bh=ebrBrrvc7PIfiZ8DB12cG2/qaEDHz2wcjhBXT36JngE=; b=XN1P1iHtQaPQvhmCrfxBwa/0pb2FbHX1/FmtkmoDgRBizS9hWIwXEkWVwMfyl+GDMe PmLeS/eZVSCtv/ogdGZqLOZm7M3ASdyX6hzzZYaixzEk63mPe0LfoXQxDfMKYgl57WdJ +7yVO4jIgS2FGdNP23rUtWteOQhF2ikDrFIMCrz+oY9y+C67BuLzumR7EPZ7H9LPxUfg LD1m/xVsEVioQQCoTftAj4yv5SEe+8P49oRFE10rH+KSOFwzQQewYBT3Lzhd/TssKVMm 5jY8HmBYUwquOQKvfZklrLgr6q6xnCe1u3LSKJbnd/nxAwHesABLPyk20evxFsTHY0RN uS/Q== X-Received: by 10.180.105.33 with SMTP id gj1mr10854739wib.90.1445099583348; Sat, 17 Oct 2015 09:33:03 -0700 (PDT) Original-Received: from T420.taylan ([2a02:908:c32:4740:221:ccff:fe66:68f0]) by smtp.gmail.com with ESMTPSA id uj4sm29178118wjc.34.2015.10.17.09.33.02 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 17 Oct 2015 09:33:02 -0700 (PDT) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::22b X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:191850 Archived-At: --=-=-= Content-Type: text/plain This is for ELPA. --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: inline; filename=0001-Add-shell-quasiquote.patch Content-Transfer-Encoding: quoted-printable >From acd5cfc5fc57a07cccf233021c23db53cfa24ca7 Mon Sep 17 00:00:00 2001 From: =3D?UTF-8?q?Taylan=3D20Ulrich=3D20Bay=3DC4=3DB1rl=3DC4=3DB1/Kammer?=3D Date: Sat, 17 Oct 2015 18:32:22 +0200 Subject: [PATCH] Add shell-quasiquote. --- packages/shell-quasiquote/shell-quasiquote.el | 149 ++++++++++++++++++++++= ++++ 1 file changed, 149 insertions(+) create mode 100644 packages/shell-quasiquote/shell-quasiquote.el diff --git a/packages/shell-quasiquote/shell-quasiquote.el b/packages/shell= -quasiquote/shell-quasiquote.el new file mode 100644 index 0000000..deb58c2 --- /dev/null +++ b/packages/shell-quasiquote/shell-quasiquote.el @@ -0,0 +1,149 @@ +;;; shell-quasiquote.el --- Turn s-expressions into shell command strings. + +;; Copyright (C) 2015 Free Software Foundation, Inc. + +;; Author: Taylan Ulrich Bay=C4=B1rl=C4=B1/Kammer +;; Keywords: extensions, unix +;; URL: https://github.com/TaylanUB/emacs-shell-quasiquote + +;; 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. + +;; 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. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Commentary: + +;; "Shell quasiquote" -- turn s-expressions into shell command strings. +;; +;; Quoting is automatic for POSIX shells. +;; +;; (let ((file1 "file one") +;; (file2 "file two")) +;; (shqq (cp -r ,file1 ,file2 "My Files"))) +;; =3D> "cp -r 'file one' 'file two' 'My Files'" +;; +;; You can splice many arguments into place with ,@foo. +;; +;; (let ((files (list "file one" "file two"))) +;; (shqq (cp -r ,@files "My Files"))) +;; =3D> "cp -r 'file one' 'file two' 'My Files'" +;; +;; Note that the quoting disables a variety of shell expansions like ~/foo, +;; $ENV_VAR, and e.g. {x..y} in GNU Bash. +;; +;; You can use ,,foo to escape the quoting. +;; +;; (let ((files "file1 file2")) +;; (shqq (cp -r ,,files "My Files"))) +;; =3D> "cp -r file1 file2 'My Files'" +;; +;; And ,,@foo to splice and escape quoting. +;; +;; (let* ((arglist '("-x 'foo bar' -y baz")) +;; (arglist (append arglist '("-z 'qux fux'")))) +;; (shqq (command ,,@arglist))) +;; =3D> "command -x 'foo bar' -y baz -z 'qux fux'" +;; +;; Neat, eh? + + +;;; Code: + +;;; Like `shell-quote-argument', but much simpler in implementation. +(defun shqq--quote-string (string) + (concat "'" (replace-regexp-in-string "'" "'\\\\''" string) "'")) + +(defun shqq--atom-to-string (atom) + (cond + ((symbolp atom) (symbol-name atom)) + ((stringp atom) atom) + ((numberp atom) (number-to-string atom)) + (t (error "Bad shqq atom: %S" atom)))) + +(defun shqq--quote-atom (atom) + (shqq--quote-string (shqq--atom-to-string atom))) + +(defun shqq--match-comma (form) + "Matches FORM against ,foo i.e. (\, foo) and returns foo. +Returns nil if FORM didn't match. You can't disambiguate between +FORM matching ,nil and not matching." + (if (and (consp form) + (eq '\, (car form)) + (consp (cdr form)) + (null (cddr form))) + (cadr form))) + +(defun shqq--match-comma2 (form) + "Matches FORM against ,,foo i.e. (\, (\, foo)) and returns foo. +Returns nil if FORM didn't match. You can't disambiguate between +FORM matching ,,nil and not matching." + (if (and (consp form) + (eq '\, (car form)) + (consp (cdr form)) + (null (cddr form))) + (shqq--match-comma (cadr form)))) + + +(defmacro shqq (parts) + "First, PARTS is turned into a list of strings. For this, +every element of PARTS must be one of: + +- a symbol, evaluating to its name, + +- a string, evaluating to itself, + +- a number, evaluating to its decimal representation, + +- \",expr\", where EXPR must evaluate to an atom that will be + interpreted according to the previous rules, + +- \",@list-expr\", where LIST-EXPR must evaluate to a list whose + elements will each be interpreted like the EXPR in an \",EXPR\" + form, and spliced into the list of strings, + +- \",,expr\", where EXPR is interpreted like in \",expr\", + +- or \",,@expr\", where EXPR is interpreted like in \",@expr\". + +In the resulting list of strings, all elements except the ones +resulting from \",,expr\" and \",,@expr\" forms are quoted for +shell grammar. + +Finally, the resulting list of strings is concatenated with +separating spaces." + (let ((parts + (mapcar + (lambda (part) + (cond + ((atom part) (shqq--quote-atom part)) + ;; We use the match-comma helpers because pcase can't match ,= foo. + (t (pcase part + ;; ,,foo i.e. (, (, foo)) + ((pred shqq--match-comma2) + (shqq--match-comma2 part)) + ;; ,,@foo i.e. (, (,@ foo)) + ((and (pred shqq--match-comma) + (let `,@,form (shqq--match-comma part))) + `(mapconcat #'identity ,form " ")) + ;; ,foo + ;; Insert redundant 'and x' to work around debbugs#18554. + ((and x (pred shqq--match-comma)) + `(shqq--quote-atom ,(shqq--match-comma part))) + ;; ,@foo + (`,@,form + `(mapconcat #'shqq--quote-atom ,form " ")) + (_ + (error "Bad shqq part: %S" part)))))) + parts))) + `(mapconcat #'identity (list ,@parts) " "))) + +(provide 'shell-quasiquote) +;;; shell-quasiquote.el ends here --=20 2.5.0 --=-=-=--