emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Thorsten Jolitz <tjolitz@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Elisp function for wrapping sexp or region in src-block (was Re: some lisp help)
Date: Tue, 29 Jul 2014 15:30:24 +0200	[thread overview]
Message-ID: <87y4vcqolr.fsf_-_@gmail.com> (raw)
In-Reply-To: <CAOQHXPrs26-2si4faNr5qZ+DqKnEQkBL5xS_qBxpYLSwg-uEMg@mail.gmail.com>

Xebar Saram <zeltakc@gmail.com> writes:

> Thx and sorry about not posting to the list, was a gmail mistake (i
> really *need* to start with gnus..just to intimidating :))
>
> wrapping in parens by marking the region kinda defeats the purpose
> sine the original function i posted (in the original post) already
> wraps the marked text in an orgmode block :)
>
> thanks and sorry for PM

no problem since I really want this function too and was a bit
frustrated often enough that it does not exist in Org-mode, I made it
more flexible and generic now, for daily use:

#+begin_src emacs-lisp
(defun tj/wrap-sexp-or-reg-in-src-block (&optional lang lines)
  "Wrap sexp at point or region in src block"
  (interactive
   (when current-prefix-arg
     (list
      (ido-completing-read "Org-Babel language: "
			   (mapcar
			    (lambda (--lang)
			      (symbol-name (car --lang)))
			    org-babel-load-languages)
			   nil nil nil nil "emacs-lisp")
      (read-number "Number of lines to wrap: " 1))))
  (let* ((language (or lang "emacs-lisp"))
	 (marker (point-marker))
	 (beg (point))
	 (end (if lines
		  (save-excursion
		    (forward-line lines) (point))
		(save-excursion
		  (forward-sexp) (point))))
	 (cut-strg (buffer-substring beg end)))
    (delete-region beg end)
    (goto-char (marker-position marker))
    (insert
     (format
      "\n#+begin_src %s\n%s\n#+end_src\n"
      language cut-strg))
    (set-marker marker nil)))
#+end_src

try it with 

,----
| C-u M-x tj/wrap-sexp-or-reg-in-src-block
`----

and you get what you want (negative line-number wrap backwards).

> On Tue, Jul 29, 2014 at 3:42 PM, Thorsten Jolitz <tjolitz@gmail.com>
> wrote:
>
>     Xebar Saram <zeltakc@gmail.com> writes:
>     
>     why a PM???
>     
>     
>     > Thx Thorsten
>     >
>     > this works very well for code blocks. it seems though that for
>     normal
>     > text paragraphs it dosent work that well. may i suggest an idea?
>     can
>     > the function perhaps prompt the user (when you launch the
>     function)
>     > for number of lines to wrap and then issue the wrap based on
>     that?
>     > that could perhaps be the most accurate way to do that? or maybe
>     > perhaps have a separate function to just wrap current line?
>     >
>     > thx alot, appreciate as always your excellent help
>     
>     
>     just wrap your paragraph in parens and call the command with point
>     on
>     the beginning paren, and it will work - for any number of lines.
>     easy to do with package smartparens.el:
>     
>     mark region and type '(', region is wrapped automatically.
>     
>     
>     
>     > On Tue, Jul 29, 2014 at 3:21 PM, Thorsten Jolitz
>     <tjolitz@gmail.com>
>     > wrote:
>     >
>     >
>     > Xebar Saram <zeltakc@gmail.com> writes:
>     >
>     > > Hi list
>     > >
>     > > so i know i should start to really learn lisp but real life
>     (uni
>     > work,
>     > > family etc) doesn't really allow me so im marking my 1st year
>     > > anniversary of using emacs without grasping lisp (plus i am in
>     > > generally coding inept :))
>     > >
>     > > in any case.... :) i have this handy lisp snippet that i find
>     > very
>     > > useful and maybe some others in the list will find as well. it
>     > allows
>     > > to quick convert lines of text into org src/example blocks:
>     > >
>     > > (defun z-wrap-cblock-lisp ()
>     > > "Wrap region in quote block"
>     > > (interactive)
>     > > (save-excursion
>     > > (save-restriction
>     > > (and
>     > > (region-active-p)
>     > > (use-region-p)
>     > > (narrow-to-region (region-beginning) (region-end)))
>     > > (goto-char (point-min))
>     > > (insert "#+BEGIN_SRC emacs-lisp :results none\n")
>     > > (goto-char (point-max))
>     > > (insert "#+END_SRC\n")
>     > > (deactivate-mark))))
>     > >
>     > > this works well but has some annoying flaws like you have to
>     > first
>     > > manually mark the region you want to convert etc
>     > >
>     > > i was wondering:
>     > >
>     > > a)can some lisp coding master show me how to make this
>     function
>     > auto
>     > > select the line//X user defined lines/smart paragraph
>     selection
>     > before
>     > > it wraps it in the org block
>     > > b)any improvement ideas from the community?
>     >
>     >
>     > Try this:
>     >
>     > #+begin_src emacs-lisp
>     > (defun tj/wrap-sexp-in-elisp-src-block ()
>     > "Wrap sexp at point in elisp src block"
>     > (interactive)
>     > (let* ((marker (point-marker))
>     > (beg (point))
>     > (end (save-excursion
>     > (forward-sexp) (point)))
>     > (cut-strg (buffer-substring beg end)))
>     > (delete-region beg end)
>     > (goto-char (marker-position marker))
>     > (insert
>     > (format
>     > "\n#+begin_src emacs-lisp\n%s\n#+end_src\n"
>     > cut-strg))
>     > (set-marker marker nil)))
>     > #+end_src
>     >
>     > #+results:
>     > : tj/wrap-sexp-in-elisp-src-block
>     >
>     > MWE:
>     >
>     > (defun foo ()
>     > "do foo"
>     > (message "foo"))
>     >
>     > 1. with point at the opening paren:
>     >
>     >
>     > #+begin_src emacs-lisp
>     > (defun foo ()
>     > "do foo"
>     > (message "foo"))
>     > #+end_src
>     >
>     > 2. with point at the 'd' of defun:
>     >
>     > (
>     > #+begin_src emacs-lisp
>     > defun
>     > #+end_src
>     > foo ()
>     > "do foo"
>     > (message "foo"))
>     >
>     > 3. with point between 'do foo':
>     >
>     > (defun foo ()
>     > "do
>     > #+begin_src emacs-lisp
>     > foo
>     > #+end_src
>     > "
>     > (message "foo"))
>     >
>     >
>     > This is actually quite useful, will add it to my init file
>     (since
>     > I
>     > frequently get 'org-babel-demarcate-block: Args out of range'
>     > errors
>     > when trying to wrap a region).
>     >
>     > Note that the behaviour depends a bit on the major-mode. In
>     > emacs-lisp
>     > mode, a string is seen as one sexp, thus with point at the first
>     > double-quote of
>     >
>     > "hello world"
>     >
>     > I get
>     >
>     > #+begin_src emacs-lisp
>     > "hello world"
>     > #+end_src
>     >
>     > while in this message-mode buffer I get
>     >
>     > #+begin_src emacs-lisp
>     > "hello
>     > #+end_src
>     > world"
>     >
>     > --
>     > cheers,
>     > Thorsten
>     >
>     >
>     >
>     >
>     
>     
>     --
>     cheers,
>     Thorsten
>
>

-- 
cheers,
Thorsten

  reply	other threads:[~2014-07-29 13:30 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-29 11:02 some lisp help (for complete 0-knowledge lisp emacs user :)) Xebar Saram
2014-07-29 12:21 ` Thorsten Jolitz
     [not found]   ` <CAOQHXPoJT4gGTJfOrHAtOfuS53GmPFgSwBqr4OA0ECpE28K1wg@mail.gmail.com>
     [not found]     ` <8761igs5e8.fsf@gmail.com>
2014-07-29 12:48       ` Xebar Saram
2014-07-29 13:30         ` Thorsten Jolitz [this message]
2014-07-29 13:52           ` Elisp function for wrapping sexp or region in src-block (was Re: some lisp help) Thorsten Jolitz
2014-07-29 14:48             ` Xebar Saram
2014-07-29 15:42               ` Thorsten Jolitz
2014-07-29 16:21               ` Xebar Saram
2014-07-29 16:23                 ` Xebar Saram
2014-07-29 16:27                   ` Xebar Saram
2014-07-29 16:36                   ` Thorsten Jolitz
2014-08-04 14:45 ` some lisp help (for complete 0-knowledge lisp emacs user :)) Sebastien Vauban

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y4vcqolr.fsf_-_@gmail.com \
    --to=tjolitz@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --subject='Elisp function for wrapping sexp or region in src-block (was Re: some lisp help)' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).