emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)]
@ 2014-08-07 22:36 Ryan
  2014-08-07 22:45 ` Thorsten Jolitz
  2014-08-07 23:10 ` Ryan
  0 siblings, 2 replies; 4+ messages in thread
From: Ryan @ 2014-08-07 22:36 UTC (permalink / raw)
  To: emacs-orgmode


Remember to cover the basics, that is, what you expected to happen and
what in fact did happen. You don't know how to make a good report? See

http://orgmode.org/manual/Feedback.html#Feedback

Your bug report will be posted to the Org-mode mailing list.
------------------------------------------------------------------------

I was doing some programming and wanted to use the result of
org-in-src-block-p. I discovered that this function always returned nil,
because for some reason (overlays-at (point)) was always returning nil
everywhere that I tried it, including inside src blocks. So I rewrote
org-in-src-block-p to use org-element-at-point instead of looking at
overlays at point. My new implementation is below:

(defun org-in-src-block-p (&optional inside)
"Whether point is in a code source block.
When INSIDE is non-nil, don't consider we are within a src block
when point is at #+BEGIN_SRC or #+END_SRC."
(and
;; In a src block
(eq (car (org-element-at-point))
'src-block)
;; Not at block delimiter, if requested
(not
(and
inside
(let ((case-fold-search t))
(save-match-data
(save-excursion
(beginning-of-line)
(looking-at ".*#\\+\\(begin\\|end\\)_src"))))))))


Emacs : GNU Emacs 24.3.1 (x86_64-apple-darwin13.2.0, NS 
apple-appkit-1265.20)
of 2014-06-01 on tennine-slave.macports.org
Package: Org-mode version 8.2.7b (8.2.7b-1-ga5beff-elpaplus @ 
/Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)

current state:
==============
(setq
org-tab-first-hook '(org-hide-block-toggle-maybe 
org-src-native-tab-command-maybe
org-babel-hide-result-toggle-maybe org-babel-header-arg-expand)
org-speed-command-hook '(org-speed-command-default-hook
org-babel-speed-command-hook)
org-occur-hook '(org-first-headline-recenter)
org-metaup-hook '(org-babel-load-in-session-maybe)
org-confirm-shell-link-function 'yes-or-no-p
org-support-shift-select t
org-after-todo-state-change-hook '(org-clock-out-if-current)
org-from-is-user-regexp "\\<Ryan C\\. Thompson\\>"
org-src-mode-hook '(org-src-babel-configure-edit-buffer
org-src-mode-configure-edit-buffer)
org-agenda-before-write-hook '(org-agenda-add-entry-text)
org-babel-pre-tangle-hook '(save-buffer)
org-mode-hook '(#[nil "\300\301\302\303\304$\207"
[org-add-hook change-major-mode-hook org-show-block-all append
local]
5]
#[nil "\300\301\302\303\304$\207"
[org-add-hook change-major-mode-hook org-babel-show-result-all
append local]
5]
org-babel-result-hide-spec org-babel-hide-all-hashes)
org-ctrl-c-ctrl-c-hook '(org-babel-hash-at-point 
org-babel-execute-safely-maybe)
org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers
org-cycle-hide-inline-tasks org-cycle-show-empty-lines
org-optimize-window-after-visibility-change)
org-confirm-elisp-link-function 'yes-or-no-p
org-metadown-hook '(org-babel-pop-to-session-maybe)
org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
)

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)]
  2014-08-07 22:36 Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)] Ryan
@ 2014-08-07 22:45 ` Thorsten Jolitz
  2014-08-07 23:10 ` Ryan
  1 sibling, 0 replies; 4+ messages in thread
From: Thorsten Jolitz @ 2014-08-07 22:45 UTC (permalink / raw)
  To: emacs-orgmode

Ryan <rct@thompsonclan.org> writes:

> I discovered that this function always returned nil,

not for me:

#+begin_src emacs-lisp
(org-in-src-block-p)
#+end_src

#+results:
: t

eval here:

(org-in-src-block-p)

-> nil

-- 
cheers,
Thorsten

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)]
  2014-08-07 22:36 Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)] Ryan
  2014-08-07 22:45 ` Thorsten Jolitz
@ 2014-08-07 23:10 ` Ryan
  2014-08-08  8:21   ` Nicolas Goaziou
  1 sibling, 1 reply; 4+ messages in thread
From: Ryan @ 2014-08-07 23:10 UTC (permalink / raw)
  To: emacs-orgmode

Actually, my implementation has a bug. org-element-at-point also 
returns the element if point is actually on one of the blank lines 
between that element and the next. So I've rewritten it to handle that 
case by computing the content end position and comparing point to that.

(defun org-in-src-block-p (&optional inside)
  "Whether point is in a code source block.
When INSIDE is non-nil, don't consider we are within a src block
when point is at #+BEGIN_SRC or #+END_SRC."
  (save-match-data
    (let* ((elem (org-element-at-point))
           (elem-type (car elem))
           (props (cadr elem))
           (end (plist-get props :end))
           (pb (plist-get props :post-blank))
           (content-end
            (save-excursion
              (goto-char end)
              (forward-line (- pb))
              (point)))
           (case-fold-search t))
      (and
       ;; Elem is a src block
       (eq elem-type 'src-block)
       ;; Make sure point is not on one of the blank lines after the
       ;; element.
       (< (point) content-end)
       ;; If INSIDE is non-nil, then must not be at block delimiter
       (not
        (and
         inside
         (save-excursion
           (beginning-of-line)
           (looking-at ".*#\\+\\(begin\\|end\\)_src"))))))))


On Thu Aug  7 15:36:00 2014, Ryan wrote:
>
> Remember to cover the basics, that is, what you expected to happen and
> what in fact did happen. You don't know how to make a good report? See
>
> http://orgmode.org/manual/Feedback.html#Feedback
>
> Your bug report will be posted to the Org-mode mailing list.
> ------------------------------------------------------------------------
>
> I was doing some programming and wanted to use the result of
> org-in-src-block-p. I discovered that this function always returned nil,
> because for some reason (overlays-at (point)) was always returning nil
> everywhere that I tried it, including inside src blocks. So I rewrote
> org-in-src-block-p to use org-element-at-point instead of looking at
> overlays at point. My new implementation is below:
>
> (defun org-in-src-block-p (&optional inside)
> "Whether point is in a code source block.
> When INSIDE is non-nil, don't consider we are within a src block
> when point is at #+BEGIN_SRC or #+END_SRC."
> (and
> ;; In a src block
> (eq (car (org-element-at-point))
> 'src-block)
> ;; Not at block delimiter, if requested
> (not
> (and
> inside
> (let ((case-fold-search t))
> (save-match-data
> (save-excursion
> (beginning-of-line)
> (looking-at ".*#\\+\\(begin\\|end\\)_src"))))))))
>
>
> Emacs : GNU Emacs 24.3.1 (x86_64-apple-darwin13.2.0, NS
> apple-appkit-1265.20)
> of 2014-06-01 on tennine-slave.macports.org
> Package: Org-mode version 8.2.7b (8.2.7b-1-ga5beff-elpaplus @
> /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)
>
> current state:
> ==============
> (setq
> org-tab-first-hook '(org-hide-block-toggle-maybe
> org-src-native-tab-command-maybe
> org-babel-hide-result-toggle-maybe org-babel-header-arg-expand)
> org-speed-command-hook '(org-speed-command-default-hook
> org-babel-speed-command-hook)
> org-occur-hook '(org-first-headline-recenter)
> org-metaup-hook '(org-babel-load-in-session-maybe)
> org-confirm-shell-link-function 'yes-or-no-p
> org-support-shift-select t
> org-after-todo-state-change-hook '(org-clock-out-if-current)
> org-from-is-user-regexp "\\<Ryan C\\. Thompson\\>"
> org-src-mode-hook '(org-src-babel-configure-edit-buffer
> org-src-mode-configure-edit-buffer)
> org-agenda-before-write-hook '(org-agenda-add-entry-text)
> org-babel-pre-tangle-hook '(save-buffer)
> org-mode-hook '(#[nil "\300\301\302\303\304$\207"
> [org-add-hook change-major-mode-hook org-show-block-all append
> local]
> 5]
> #[nil "\300\301\302\303\304$\207"
> [org-add-hook change-major-mode-hook org-babel-show-result-all
> append local]
> 5]
> org-babel-result-hide-spec org-babel-hide-all-hashes)
> org-ctrl-c-ctrl-c-hook '(org-babel-hash-at-point
> org-babel-execute-safely-maybe)
> org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers
> org-cycle-hide-inline-tasks org-cycle-show-empty-lines
> org-optimize-window-after-visibility-change)
> org-confirm-elisp-link-function 'yes-or-no-p
> org-metadown-hook '(org-babel-pop-to-session-maybe)
> org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
> )
>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)]
  2014-08-07 23:10 ` Ryan
@ 2014-08-08  8:21   ` Nicolas Goaziou
  0 siblings, 0 replies; 4+ messages in thread
From: Nicolas Goaziou @ 2014-08-08  8:21 UTC (permalink / raw)
  To: Ryan; +Cc: emacs-orgmode

Hello,

Ryan <rct@thompsonclan.org> writes:

> Actually, my implementation has a bug. org-element-at-point also
> returns the element if point is actually on one of the blank lines
> between that element and the next. So I've rewritten it to handle that
> case by computing the content end position and comparing point to
> that.

Thank you.  Here are a few notes about this implementation.

> (defun org-in-src-block-p (&optional inside)
>  "Whether point is in a code source block.
> When INSIDE is non-nil, don't consider we are within a src block
> when point is at #+BEGIN_SRC or #+END_SRC."
>  (save-match-data
>    (let* ((elem (org-element-at-point))
>           (elem-type (car elem))

  (elem-type (org-element-type elem))

>           (props (cadr elem))
>           (end (plist-get props :end))

You don't need PROPS.

  (end (org-element-property :end elem))

>           (pb (plist-get props :post-blank))
>           (content-end
>            (save-excursion
>              (goto-char end)
>              (forward-line (- pb))
>              (point)))

Using PB is incorrect.

  (contend-end
    (save-excursion
      (goto-char end)
      (skip-chars-backward " \r\t\n")
      (line-beginning-position)))

>           (case-fold-search t))
>      (and
>       ;; Elem is a src block
>       (eq elem-type 'src-block)
>       ;; Make sure point is not on one of the blank lines after the
>       ;; element.
>       (< (point) content-end)
>       ;; If INSIDE is non-nil, then must not be at block delimiter
>       (not
>        (and
>         inside
>         (save-excursion
>           (beginning-of-line)
>           (looking-at ".*#\\+\\(begin\\|end\\)_src"))))))))

Test is simply

  (and (eq elem-type 'src-block)
       (if inside
           (and (> (line-beginning-position) (org-element-property :post-affiliated elem))
                (< (point) contents-end))
         (<= (line-beginning-position) contents-end)))

Note that this is not yet possible to re-implement `org-in-src-block-p'
with `org-element-at-point' as the former is used for fontification. It
would be sub-optimal to use it that way, since you can call once
`org-element-at-point' and fontify the element under point accordingly
to its type.


Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2014-08-08  8:21 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-08-07 22:36 Bug: org-in-src-block-p always returns nil [8.2.7b (8.2.7b-1-ga5beff-elpaplus @ /Users/ryan/.emacs.d/.cask/24.3.1/elpa/org-plus-contrib-20140714/)] Ryan
2014-08-07 22:45 ` Thorsten Jolitz
2014-08-07 23:10 ` Ryan
2014-08-08  8:21   ` Nicolas Goaziou

Code repositories for project(s) associated with this public 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).