Skip to content

[WIP]Support more :lines formats and internal links #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP]Support more :lines formats and internal links #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf0b0f9
Support more :lines formats
llcc May 22, 2023
95918b8
add test
llcc May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 77 additions & 49 deletions org-transclusion-src-lines.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,31 +96,52 @@ Return nil if PLIST does not contain \":src\" or \":lines\" properties."
;; Link contains a search-option ::<string>
;; and NOT for an Org file
(and (org-element-property :search-option link)
(not (org-transclusion-org-file-p (org-element-property :path link)))))
(not (org-transclusion-org-file-p (org-element-property :path link)))))
(append '(:tc-type "lines")
(org-transclusion-content-range-of-lines link plist)))))

(defun org-transclusion--get-lines-num (lines max-num)
"Return a list of line numbers from :lines value"
(when lines
(flatten-list
(mapcar (lambda (str)
(let* ((line (split-string str "-"))
(lbeg (if (string-match "^-[0-9]+" str)
1
(string-to-number (car line))))
(lend (if (string-match "[0-9]+-$" str)
max-num
(let ((last-line-num (string-to-number (car (last line)))))
(if (> last-line-num max-num)
max-num
last-line-num)))))
(number-sequence lbeg lend
(if (> lbeg lend)
-1
1))))
(split-string lines "," t)))))

(defun org-transclusion-content-range-of-lines (link plist)
"Return a list of payload for a range of lines from LINK and PLIST.

You can specify a range of lines to transclude by adding the :line
property to a transclusion keyword like this:

#+transclude: [[file:path/to/file.ext]] :lines 1-10
#+transclude: [[file:path/to/file.ext]] :lines -10,15,12,11,17-

This is taken from Org Export (function
`org-export--inclusion-absolute-lines' in ox.el) with one
exception. Instead of :lines 1-10 to exclude line 10, it has
been adjusted to include line 10. This should be more intuitive
when it comes to including lines of code.

In order to transclude a single line, have the the same number in
both places (e.g. 10-10, meaning line 10 only).

One of the numbers can be omitted. When the first number is
omitted (e.g. -10), it means from the beginning of the file to
line 10. Likewise, when the second number is omitted (e.g. 10-),
it means from line 10 to the end of file."
omitted (e.g. -10), it means from the beginning of the file or
element to line 10. Likewise, when the second number is
omitted (e.g. 10-), it means from line 10 to the end of file.

Also, the transcluded lines will conform to the :lines order.
"
(let* ((path (org-element-property :path link))
(search-option (org-element-property :search-option link))
(type (org-element-property :type link))
Expand All @@ -129,10 +150,17 @@ it means from line 10 to the end of file."
(end-search-op (plist-get plist :end))
(thing-at-point (plist-get plist :thing-at-point))
(thing-at-point (when thing-at-point (make-symbol thing-at-point))))
(if (not (string= type "id")) (setq buf (find-file-noselect path))
(let ((filename-pos (org-id-find path)))
(setq buf (find-file-noselect (car filename-pos)))
(setq entry-pos (cdr filename-pos))))
(pcase type
("id"
(let ((filename-pos (org-id-find path)))
(setq buf (find-file-noselect (car filename-pos)))
(setq entry-pos (cdr filename-pos))))
("file"
(setq buf (find-file-noselect path)))
("fuzzy"
(setq buf (find-file-noselect (buffer-file-name)))
(setq search-option path))
(_ nil))
(when buf
(with-current-buffer buf
(org-with-wide-buffer
Expand All @@ -154,43 +182,43 @@ it means from line 10 to the end of file."
(goto-char start-pos)
(back-to-indentation)
(org-transclusion--bounds-of-n-things-at-point thing-at-point count)))))
(end-pos (cond ((when thing-at-point (cdr bounds)))
((when end-search-op
(save-excursion
(ignore-errors
;; FIXME `org-link-search' does not
;; return postion when either ::/regex/
;; or ::number is used
(when (org-link-search end-search-op)
(line-beginning-position))))))))
(range (when lines (split-string lines "-")))
(lbeg (if range (string-to-number (car range))
0))
(lend (if range (string-to-number (cadr range))
0))
;; This means beginning part of the range
;; can be mixed with search-option
;;; only positive number works
(beg (progn (goto-char (or start-pos (point-min)))
(when (> lbeg 0)(forward-line (1- lbeg)))
(point)))
;;; This `cond' means :end prop has priority over the end
;;; position of the range. They don't mix.
(end (cond
((when thing-at-point end-pos)
(when (and end-pos (> end-pos beg))
end-pos))
((if (zerop lend) (point-max)
(goto-char start-pos)
(forward-line (1- lend))
(end-of-line);; include the line
;; Ensure to include the \n into the end point
(1+ (point))))))
(content (buffer-substring-no-properties beg end)))
(list :src-content content
(end-pos (cond (thing-at-point (cdr bounds))
(end-search-op (save-excursion
(ignore-errors
;; FIXME `org-link-search' does not
;; return postion when either ::/regex/
;; or ::number is used
(when (org-link-search end-search-op)
(line-beginning-position)))))
(search-option (save-excursion
(ignore-errors
(when (org-link-search search-option)
(let* ((element (org-element-context))
(type (org-element-type element)))
(when (string= "target" type)
(let ((parent (org-element-property :parent element)))
(when (string= "paragraph" (org-element-type parent))
(setq element parent)))
(let ((parent (org-element-property :parent element)))
(when (string= "item" (org-element-type parent))
(setq element parent))))
(org-element-property :end element))))))
(t (point-max))))
(src-element-lines (count-lines start-pos end-pos))
(line-nums (org-transclusion--get-lines-num lines src-element-lines))
(lbeg (if line-nums (apply #'min line-nums)
1))
(lend (if line-nums (apply #'max line-nums)
src-element-lines))
(content (buffer-substring-no-properties start-pos end-pos))
(filtered-content
(let ((lines (split-string content "\n")))
(string-join (mapcar (lambda (slice) (nth (1- slice) lines)) line-nums)
"\n"))))
(list :src-content filtered-content
:src-buf (current-buffer)
:src-beg beg
:src-end end)))))))
:src-beg start-pos
:src-end end-pos)))))))

(defun org-transclusion-content-src-lines (link plist)
"Return a list of payload from LINK and PLIST in a src-block.
Expand Down Expand Up @@ -220,7 +248,7 @@ for the range works."
It is meant to be used by `org-transclusion-get-string-to-plist'.
It needs to be set in `org-transclusion-get-keyword-values-hook'.
Double qutations are optional \"1-10\"."
(when (string-match ":lines +\\(\"?[0-9]*-[0-9]*\"?\\)" string)
(when (string-match ":lines +\\(\"?[0-9]*[0-9-,]*[0-9]*\"?\\)" string)
(list :lines (org-strip-quotes (match-string 1 string)))))

(defun org-transclusion-keyword-value-src (string)
Expand Down
15 changes: 15 additions & 0 deletions test/things-at-point.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ I expect these will be more common:
list


#+NAME: barz
| No | A | B | C | D | E | F | G | H | I |
|----+------+------+------+-------+-------+------+-------+------+------|
| 4 | 0.18 | 0.31 | 1.52 | 0.010 | 0.003 | 0.09 | 0.004 | 0.03 | 0.17 |
| 5 | 0.20 | 0.29 | 1.54 | 0.009 | 0.003 | 0.09 | 0.003 | 0.03 | 0.18 |
| 6 | 0.18 | 0.31 | 1.54 | 0.010 | 0.002 | 0.09 | 0.004 | 0.03 | 0.16 |
| 7 | 0.18 | 0.31 | 1.54 | 0.010 | 0.002 | 0.09 | 0.004 | 0.03 | 0.16 |
| 8 | 0.18 | 0.31 | 1.57 | 0.009 | 0.003 | 0.09 | 0.004 | 0.03 | 0.17 |
| 9 | 0.18 | 0.31 | 1.57 | 0.009 | 0.003 | 0.09 | 0.004 | 0.03 | 0.17 |
| 10 | 0.18 | 0.31 | 1.57 | 0.009 | 0.003 | 0.09 | 0.004 | 0.03 | 0.17 |
| 11 | 0.18 | 0.31 | 1.57 | 0.009 | 0.003 | 0.09 | 0.004 | 0.03 | 0.17 |


#+transclude: [[./things-at-point-dir/story.txt::Once upon a time][story]] :end "2" :thing-at-point paragraph

#+transclude: [[./things-at-point-dir/story.txt::Once upon a time][story]] :end "3" :thing-at-point sentence
Expand All @@ -26,3 +39,5 @@ I expect these will be more common:
#+transclude: [[./things-at-point-dir/baz.el::foo][barz-baz-fuzz]] :src elisp :thing-at-point sexp

#+transclude: [[./things-at-point-dir/baz.el::id:1234567890][barz-baz-fuzz]] :src elisp :thing-at-point defun

#+transclude: [[barz][barz]] :lines -5,7-8,4,9-