ob.el 94 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497
  1. ;;; ob.el --- working with code blocks in org-mode
  2. ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Dan Davison
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: http://orgmode.org
  7. ;; This file is part of GNU Emacs.
  8. ;; GNU Emacs is free software: you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation, either version 3 of the License, or
  11. ;; (at your option) any later version.
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Code:
  19. (eval-when-compile
  20. (require 'cl))
  21. (require 'ob-eval)
  22. (require 'org-macs)
  23. (defvar org-babel-call-process-region-original)
  24. (defvar org-src-lang-modes)
  25. (defvar org-babel-library-of-babel)
  26. (declare-function show-all "outline" ())
  27. (declare-function org-reduce "org" (CL-FUNC CL-SEQ &rest CL-KEYS))
  28. (declare-function tramp-compat-make-temp-file "tramp-compat"
  29. (filename &optional dir-flag))
  30. (declare-function tramp-dissect-file-name "tramp" (name &optional nodefault))
  31. (declare-function tramp-file-name-user "tramp" (vec))
  32. (declare-function tramp-file-name-host "tramp" (vec))
  33. (declare-function with-parsed-tramp-file-name "tramp" (filename var &rest body))
  34. (declare-function org-icompleting-read "org" (&rest args))
  35. (declare-function org-edit-src-code "org-src"
  36. (&optional context code edit-buffer-name quietp))
  37. (declare-function org-edit-src-exit "org-src" (&optional context))
  38. (declare-function org-open-at-point "org" (&optional in-emacs reference-buffer))
  39. (declare-function org-save-outline-visibility "org" (use-markers &rest body))
  40. (declare-function org-outline-overlay-data "org" (&optional use-markers))
  41. (declare-function org-set-outline-overlay-data "org" (data))
  42. (declare-function org-narrow-to-subtree "org" ())
  43. (declare-function org-entry-get "org"
  44. (pom property &optional inherit literal-nil))
  45. (declare-function org-make-options-regexp "org" (kwds &optional extra))
  46. (declare-function org-do-remove-indentation "org" (&optional n))
  47. (declare-function org-show-context "org" (&optional key))
  48. (declare-function org-at-table-p "org" (&optional table-type))
  49. (declare-function org-cycle "org" (&optional arg))
  50. (declare-function org-uniquify "org" (list))
  51. (declare-function org-current-level "org" ())
  52. (declare-function org-table-import "org-table" (file arg))
  53. (declare-function org-add-hook "org-compat"
  54. (hook function &optional append local))
  55. (declare-function org-table-align "org-table" ())
  56. (declare-function org-table-end "org-table" (&optional table-type))
  57. (declare-function orgtbl-to-generic "org-table" (table params))
  58. (declare-function orgtbl-to-orgtbl "org-table" (table params))
  59. (declare-function org-babel-tangle-comment-links "ob-tangle" (&optional info))
  60. (declare-function org-babel-lob-get-info "ob-lob" nil)
  61. (declare-function org-babel-ref-split-args "ob-ref" (arg-string))
  62. (declare-function org-babel-ref-parse "ob-ref" (assignment))
  63. (declare-function org-babel-ref-resolve "ob-ref" (ref))
  64. (declare-function org-babel-ref-goto-headline-id "ob-ref" (id))
  65. (declare-function org-babel-ref-headline-body "ob-ref" ())
  66. (declare-function org-babel-lob-execute-maybe "ob-lob" ())
  67. (declare-function org-number-sequence "org-compat" (from &optional to inc))
  68. (declare-function org-at-item-p "org-list" ())
  69. (declare-function org-list-parse-list "org-list" (&optional delete))
  70. (declare-function org-list-to-generic "org-list" (LIST PARAMS))
  71. (declare-function org-list-struct "org-list" ())
  72. (declare-function org-list-prevs-alist "org-list" (struct))
  73. (declare-function org-list-get-list-end "org-list" (item struct prevs))
  74. (defgroup org-babel nil
  75. "Code block evaluation and management in `org-mode' documents."
  76. :tag "Babel"
  77. :group 'org)
  78. (defcustom org-confirm-babel-evaluate t
  79. "Confirm before evaluation.
  80. Require confirmation before interactively evaluating code
  81. blocks in Org-mode buffers. The default value of this variable
  82. is t, meaning confirmation is required for any code block
  83. evaluation. This variable can be set to nil to inhibit any
  84. future confirmation requests. This variable can also be set to a
  85. function which takes two arguments the language of the code block
  86. and the body of the code block. Such a function should then
  87. return a non-nil value if the user should be prompted for
  88. execution or nil if no prompt is required.
  89. Warning: Disabling confirmation may result in accidental
  90. evaluation of potentially harmful code. It may be advisable
  91. remove code block execution from C-c C-c as further protection
  92. against accidental code block evaluation. The
  93. `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
  94. remove code block execution from the C-c C-c keybinding."
  95. :group 'org-babel
  96. :version "24.1"
  97. :type '(choice boolean function))
  98. ;; don't allow this variable to be changed through file settings
  99. (put 'org-confirm-babel-evaluate 'safe-local-variable (lambda (x) (eq x t)))
  100. (defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
  101. "Remove code block evaluation from the C-c C-c key binding."
  102. :group 'org-babel
  103. :version "24.1"
  104. :type 'boolean)
  105. (defcustom org-babel-results-keyword "RESULTS"
  106. "Keyword used to name results generated by code blocks.
  107. Should be either RESULTS or NAME however any capitalization may
  108. be used."
  109. :group 'org-babel
  110. :type 'string)
  111. (defcustom org-babel-noweb-wrap-start "<<"
  112. "String used to begin a noweb reference in a code block.
  113. See also `org-babel-noweb-wrap-end'."
  114. :group 'org-babel
  115. :type 'string)
  116. (defcustom org-babel-noweb-wrap-end ">>"
  117. "String used to end a noweb reference in a code block.
  118. See also `org-babel-noweb-wrap-start'."
  119. :group 'org-babel
  120. :type 'string)
  121. (defun org-babel-noweb-wrap (&optional regexp)
  122. (concat org-babel-noweb-wrap-start
  123. (or regexp "\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)")
  124. org-babel-noweb-wrap-end))
  125. (defvar org-babel-src-name-regexp
  126. "^[ \t]*#\\+name:[ \t]*"
  127. "Regular expression used to match a source name line.")
  128. (defvar org-babel-multi-line-header-regexp
  129. "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
  130. "Regular expression used to match multi-line header arguments.")
  131. (defvar org-babel-src-name-w-name-regexp
  132. (concat org-babel-src-name-regexp
  133. "\\("
  134. org-babel-multi-line-header-regexp
  135. "\\)*"
  136. "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)")
  137. "Regular expression matching source name lines with a name.")
  138. (defvar org-babel-src-block-regexp
  139. (concat
  140. ;; (1) indentation (2) lang
  141. "^\\([ \t]*\\)#\\+begin_src[ \t]+\\([^ \f\t\n\r\v]+\\)[ \t]*"
  142. ;; (3) switches
  143. "\\([^\":\n]*\"[^\"\n*]*\"[^\":\n]*\\|[^\":\n]*\\)"
  144. ;; (4) header arguments
  145. "\\([^\n]*\\)\n"
  146. ;; (5) body
  147. "\\([^\000]*?\n\\)?[ \t]*#\\+end_src")
  148. "Regexp used to identify code blocks.")
  149. (defvar org-babel-inline-src-block-regexp
  150. (concat
  151. ;; (1) replacement target (2) lang
  152. "\\(?:^\\|[^-[:alnum:]]\\)\\(src_\\([^ \f\t\n\r\v]+\\)"
  153. ;; (3,4) (unused, headers)
  154. "\\(\\|\\[\\(.*?\\)\\]\\)"
  155. ;; (5) body
  156. "{\\([^\f\n\r\v]+?\\)}\\)")
  157. "Regexp used to identify inline src-blocks.")
  158. (defun org-babel-get-header (params key &optional others)
  159. "Select only header argument of type KEY from a list.
  160. Optional argument OTHERS indicates that only the header that do
  161. not match KEY should be returned."
  162. (delq nil
  163. (mapcar
  164. (lambda (p) (when (funcall (if others #'not #'identity) (eq (car p) key)) p))
  165. params)))
  166. (defun org-babel-get-inline-src-block-matches()
  167. "Set match data if within body of an inline source block.
  168. Returns non-nil if match-data set"
  169. (let ((src-at-0-p (save-excursion
  170. (beginning-of-line 1)
  171. (string= "src" (thing-at-point 'word))))
  172. (first-line-p (= 1 (line-number-at-pos)))
  173. (orig (point)))
  174. (let ((search-for (cond ((and src-at-0-p first-line-p "src_"))
  175. (first-line-p "[[:punct:] \t]src_")
  176. (t "[[:punct:] \f\t\n\r\v]src_")))
  177. (lower-limit (if first-line-p
  178. nil
  179. (- (point-at-bol) 1))))
  180. (save-excursion
  181. (when (or (and src-at-0-p (bobp))
  182. (and (re-search-forward "}" (point-at-eol) t)
  183. (re-search-backward search-for lower-limit t)
  184. (> orig (point))))
  185. (when (looking-at org-babel-inline-src-block-regexp)
  186. t ))))))
  187. (defvar org-babel-inline-lob-one-liner-regexp)
  188. (defun org-babel-get-lob-one-liner-matches()
  189. "Set match data if on line of an lob one liner.
  190. Returns non-nil if match-data set"
  191. (save-excursion
  192. (unless (= (point) (point-at-bol)) ;; move before inline block
  193. (re-search-backward "[ \f\t\n\r\v]" nil t))
  194. (if (looking-at org-babel-inline-lob-one-liner-regexp)
  195. t
  196. nil)))
  197. (defun org-babel-get-src-block-info (&optional light)
  198. "Get information on the current source block.
  199. Optional argument LIGHT does not resolve remote variable
  200. references; a process which could likely result in the execution
  201. of other code blocks.
  202. Returns a list
  203. (language body header-arguments-alist switches name indent)."
  204. (let ((case-fold-search t) head info name indent)
  205. ;; full code block
  206. (if (setq head (org-babel-where-is-src-block-head))
  207. (save-excursion
  208. (goto-char head)
  209. (setq info (org-babel-parse-src-block-match))
  210. (setq indent (car (last info)))
  211. (setq info (butlast info))
  212. (while (and (forward-line -1)
  213. (looking-at org-babel-multi-line-header-regexp))
  214. (setf (nth 2 info)
  215. (org-babel-merge-params
  216. (nth 2 info)
  217. (org-babel-parse-header-arguments (match-string 1)))))
  218. (when (looking-at org-babel-src-name-w-name-regexp)
  219. (setq name (org-babel-clean-text-properties (match-string 3)))
  220. (when (and (match-string 5) (> (length (match-string 5)) 0))
  221. (setf (nth 2 info) ;; merge functional-syntax vars and header-args
  222. (org-babel-merge-params
  223. (mapcar
  224. (lambda (ref) (cons :var ref))
  225. (mapcar
  226. (lambda (var) ;; check that each variable is initialized
  227. (if (string-match ".+=.+" var)
  228. var
  229. (error
  230. "variable \"%s\"%s must be assigned a default value"
  231. var (if name (format " in block \"%s\"" name) ""))))
  232. (org-babel-ref-split-args (match-string 5))))
  233. (nth 2 info))))))
  234. ;; inline source block
  235. (when (org-babel-get-inline-src-block-matches)
  236. (setq info (org-babel-parse-inline-src-block-match))))
  237. ;; resolve variable references and add summary parameters
  238. (when (and info (not light))
  239. (setf (nth 2 info) (org-babel-process-params (nth 2 info))))
  240. (when info (append info (list name indent)))))
  241. (defvar org-current-export-file) ; dynamically bound
  242. (defun org-babel-confirm-evaluate (info)
  243. "Confirm evaluation of the code block INFO.
  244. This behavior can be suppressed by setting the value of
  245. `org-confirm-babel-evaluate' to nil, in which case all future
  246. interactive code block evaluations will proceed without any
  247. confirmation from the user.
  248. Note disabling confirmation may result in accidental evaluation
  249. of potentially harmful code."
  250. (let* ((eval (or (cdr (assoc :eval (nth 2 info)))
  251. (when (assoc :noeval (nth 2 info)) "no")))
  252. (query (cond ((equal eval "query") t)
  253. ((and org-current-export-file
  254. (equal eval "query-export")) t)
  255. ((functionp org-confirm-babel-evaluate)
  256. (funcall org-confirm-babel-evaluate
  257. (nth 0 info) (nth 1 info)))
  258. (t org-confirm-babel-evaluate))))
  259. (if (or (equal eval "never") (equal eval "no")
  260. (and org-current-export-file (or (equal eval "no-export")
  261. (equal eval "never-export")))
  262. (and query
  263. (not (yes-or-no-p
  264. (format "Evaluate this%scode block%son your system? "
  265. (if info (format " %s " (nth 0 info)) " ")
  266. (if (nth 4 info)
  267. (format " (%s) " (nth 4 info)) " "))))))
  268. (prog1 nil (message "Evaluation %s"
  269. (if (or (equal eval "never") (equal eval "no")
  270. (equal eval "no-export")
  271. (equal eval "never-export"))
  272. "Disabled" "Aborted")))
  273. t)))
  274. ;;;###autoload
  275. (defun org-babel-execute-safely-maybe ()
  276. (unless org-babel-no-eval-on-ctrl-c-ctrl-c
  277. (org-babel-execute-maybe)))
  278. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-babel-execute-safely-maybe)
  279. ;;;###autoload
  280. (defun org-babel-execute-maybe ()
  281. (interactive)
  282. (or (org-babel-execute-src-block-maybe)
  283. (org-babel-lob-execute-maybe)))
  284. (defun org-babel-execute-src-block-maybe ()
  285. "Conditionally execute a source block.
  286. Detect if this is context for a Babel src-block and if so
  287. then run `org-babel-execute-src-block'."
  288. (interactive)
  289. (let ((info (org-babel-get-src-block-info)))
  290. (if info
  291. (progn (org-babel-eval-wipe-error-buffer)
  292. (org-babel-execute-src-block current-prefix-arg info) t) nil)))
  293. ;;;###autoload
  294. (defun org-babel-view-src-block-info ()
  295. "Display information on the current source block.
  296. This includes header arguments, language and name, and is largely
  297. a window into the `org-babel-get-src-block-info' function."
  298. (interactive)
  299. (let ((info (org-babel-get-src-block-info 'light)))
  300. (flet ((full (it) (> (length it) 0))
  301. (printf (fmt &rest args) (princ (apply #'format fmt args))))
  302. (when info
  303. (with-help-window (help-buffer)
  304. (let ((name (nth 4 info))
  305. (lang (nth 0 info))
  306. (switches (nth 3 info))
  307. (header-args (nth 2 info)))
  308. (when name (printf "Name: %s\n" name))
  309. (when lang (printf "Lang: %s\n" lang))
  310. (when (full switches) (printf "Switches: %s\n" switches))
  311. (printf "Header Arguments:\n")
  312. (dolist (pair (sort header-args
  313. (lambda (a b) (string< (symbol-name (car a))
  314. (symbol-name (car b))))))
  315. (when (full (cdr pair))
  316. (printf "\t%S%s\t%s\n"
  317. (car pair)
  318. (if (> (length (format "%S" (car pair))) 7) "" "\t")
  319. (cdr pair))))))))))
  320. ;;;###autoload
  321. (defun org-babel-expand-src-block-maybe ()
  322. "Conditionally expand a source block.
  323. Detect if this is context for a org-babel src-block and if so
  324. then run `org-babel-expand-src-block'."
  325. (interactive)
  326. (let ((info (org-babel-get-src-block-info)))
  327. (if info
  328. (progn (org-babel-expand-src-block current-prefix-arg info) t)
  329. nil)))
  330. ;;;###autoload
  331. (defun org-babel-load-in-session-maybe ()
  332. "Conditionally load a source block in a session.
  333. Detect if this is context for a org-babel src-block and if so
  334. then run `org-babel-load-in-session'."
  335. (interactive)
  336. (let ((info (org-babel-get-src-block-info)))
  337. (if info
  338. (progn (org-babel-load-in-session current-prefix-arg info) t)
  339. nil)))
  340. (add-hook 'org-metaup-hook 'org-babel-load-in-session-maybe)
  341. ;;;###autoload
  342. (defun org-babel-pop-to-session-maybe ()
  343. "Conditionally pop to a session.
  344. Detect if this is context for a org-babel src-block and if so
  345. then run `org-babel-pop-to-session'."
  346. (interactive)
  347. (let ((info (org-babel-get-src-block-info)))
  348. (if info (progn (org-babel-pop-to-session current-prefix-arg info) t) nil)))
  349. (add-hook 'org-metadown-hook 'org-babel-pop-to-session-maybe)
  350. (defconst org-babel-common-header-args-w-values
  351. '((cache . ((no yes)))
  352. (cmdline . :any)
  353. (colnames . ((nil no yes)))
  354. (comments . ((no link yes org both noweb)))
  355. (dir . :any)
  356. (eval . ((never query)))
  357. (exports . ((code results both none)))
  358. (file . :any)
  359. (hlines . ((no yes)))
  360. (mkdirp . ((yes no)))
  361. (no-expand)
  362. (noeval)
  363. (noweb . ((yes no tangle no-export strip-export)))
  364. (noweb-ref . :any)
  365. (noweb-sep . :any)
  366. (padline . ((yes no)))
  367. (results . ((file list vector table scalar verbatim)
  368. (raw org html latex code pp wrap)
  369. (replace silent append prepend)
  370. (output value)))
  371. (rownames . ((no yes)))
  372. (sep . :any)
  373. (session . :any)
  374. (shebang . :any)
  375. (tangle . ((tangle yes no :any)))
  376. (var . :any)
  377. (wrap . :any)))
  378. (defconst org-babel-header-arg-names
  379. (mapcar #'car org-babel-common-header-args-w-values)
  380. "Common header arguments used by org-babel.
  381. Note that individual languages may define their own language
  382. specific header arguments as well.")
  383. (defvar org-babel-default-header-args
  384. '((:session . "none") (:results . "replace") (:exports . "code")
  385. (:cache . "no") (:noweb . "no") (:hlines . "no") (:tangle . "no")
  386. (:padnewline . "yes"))
  387. "Default arguments to use when evaluating a source block.")
  388. (defvar org-babel-default-inline-header-args
  389. '((:session . "none") (:results . "replace") (:exports . "results"))
  390. "Default arguments to use when evaluating an inline source block.")
  391. (defvar org-babel-data-names '("TBLNAME" "RESULTS" "NAME"))
  392. (defvar org-babel-result-regexp
  393. (concat "^[ \t]*#\\+"
  394. (regexp-opt org-babel-data-names t)
  395. "\\(\\[\\([[:alnum:]]+\\)\\]\\)?\\:[ \t]*")
  396. "Regular expression used to match result lines.
  397. If the results are associated with a hash key then the hash will
  398. be saved in the second match data.")
  399. (defvar org-babel-result-w-name-regexp
  400. (concat org-babel-result-regexp
  401. "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)"))
  402. (defvar org-babel-min-lines-for-block-output 10
  403. "The minimum number of lines for block output.
  404. If number of lines of output is equal to or exceeds this
  405. value, the output is placed in a #+begin_example...#+end_example
  406. block. Otherwise the output is marked as literal by inserting
  407. colons at the starts of the lines. This variable only takes
  408. effect if the :results output option is in effect.")
  409. (defvar org-babel-noweb-error-langs nil
  410. "Languages for which Babel will raise literate programming errors.
  411. List of languages for which errors should be raised when the
  412. source code block satisfying a noweb reference in this language
  413. can not be resolved.")
  414. (defvar org-babel-hash-show 4
  415. "Number of initial characters to show of a hidden results hash.")
  416. (defvar org-babel-after-execute-hook nil
  417. "Hook for functions to be called after `org-babel-execute-src-block'")
  418. (defun org-babel-named-src-block-regexp-for-name (name)
  419. "This generates a regexp used to match a src block named NAME."
  420. (concat org-babel-src-name-regexp (regexp-quote name)
  421. "\\([ \t]\\|$\\|(\\)" ".*[\r\n]"
  422. (substring org-babel-src-block-regexp 1)))
  423. (defun org-babel-named-data-regexp-for-name (name)
  424. "This generates a regexp used to match data named NAME."
  425. (concat org-babel-result-regexp (regexp-quote name) "\\([ \t]\\|$\\)"))
  426. ;;; functions
  427. (defvar call-process-region)
  428. ;;;###autoload
  429. (defun org-babel-execute-src-block (&optional arg info params)
  430. "Execute the current source code block.
  431. Insert the results of execution into the buffer. Source code
  432. execution and the collection and formatting of results can be
  433. controlled through a variety of header arguments.
  434. With prefix argument ARG, force re-execution even if an existing
  435. result cached in the buffer would otherwise have been returned.
  436. Optionally supply a value for INFO in the form returned by
  437. `org-babel-get-src-block-info'.
  438. Optionally supply a value for PARAMS which will be merged with
  439. the header arguments specified at the front of the source code
  440. block."
  441. (interactive)
  442. (let ((info (or info (org-babel-get-src-block-info))))
  443. (when (org-babel-confirm-evaluate
  444. (let ((i info))
  445. (setf (nth 2 i) (org-babel-merge-params (nth 2 info) params))
  446. i))
  447. (let* ((lang (nth 0 info))
  448. (params (if params
  449. (org-babel-process-params
  450. (org-babel-merge-params (nth 2 info) params))
  451. (nth 2 info)))
  452. (cache? (and (not arg) (cdr (assoc :cache params))
  453. (string= "yes" (cdr (assoc :cache params)))))
  454. (result-params (cdr (assoc :result-params params)))
  455. (new-hash (when cache? (org-babel-sha1-hash info)))
  456. (old-hash (when cache? (org-babel-current-result-hash)))
  457. (body (setf (nth 1 info)
  458. (if (org-babel-noweb-p params :eval)
  459. (org-babel-expand-noweb-references info)
  460. (nth 1 info))))
  461. (dir (cdr (assoc :dir params)))
  462. (default-directory
  463. (or (and dir (file-name-as-directory dir)) default-directory))
  464. (org-babel-call-process-region-original
  465. (if (boundp 'org-babel-call-process-region-original)
  466. org-babel-call-process-region-original
  467. (symbol-function 'call-process-region)))
  468. (indent (car (last info)))
  469. result cmd)
  470. (unwind-protect
  471. (flet ((call-process-region (&rest args)
  472. (apply 'org-babel-tramp-handle-call-process-region args)))
  473. (flet ((lang-check (f)
  474. (let ((f (intern (concat "org-babel-execute:" f))))
  475. (when (fboundp f) f))))
  476. (setq cmd
  477. (or (lang-check lang)
  478. (lang-check (symbol-name
  479. (cdr (assoc lang org-src-lang-modes))))
  480. (error "No org-babel-execute function for %s!" lang))))
  481. (if (and (not arg) new-hash (equal new-hash old-hash))
  482. (save-excursion ;; return cached result
  483. (goto-char (org-babel-where-is-src-block-result nil info))
  484. (end-of-line 1) (forward-char 1)
  485. (setq result (org-babel-read-result))
  486. (message (replace-regexp-in-string
  487. "%" "%%" (format "%S" result))) result)
  488. (message "executing %s code block%s..."
  489. (capitalize lang)
  490. (if (nth 4 info) (format " (%s)" (nth 4 info)) ""))
  491. (setq result
  492. ((lambda (result)
  493. (if (and (eq (cdr (assoc :result-type params)) 'value)
  494. (or (member "vector" result-params)
  495. (member "table" result-params))
  496. (not (listp result)))
  497. (list (list result)) result))
  498. (funcall cmd body params)))
  499. ;; if non-empty result and :file then write to :file
  500. (when (cdr (assoc :file params))
  501. (when result
  502. (with-temp-file (cdr (assoc :file params))
  503. (insert
  504. (org-babel-format-result
  505. result (cdr (assoc :sep (nth 2 info)))))))
  506. (setq result (cdr (assoc :file params))))
  507. (org-babel-insert-result
  508. result result-params info new-hash indent lang)
  509. (run-hooks 'org-babel-after-execute-hook)
  510. result))
  511. (setq call-process-region 'org-babel-call-process-region-original))))))
  512. (defun org-babel-expand-body:generic (body params &optional var-lines)
  513. "Expand BODY with PARAMS.
  514. Expand a block of code with org-babel according to its header
  515. arguments. This generic implementation of body expansion is
  516. called for languages which have not defined their own specific
  517. org-babel-expand-body:lang function."
  518. (mapconcat #'identity (append var-lines (list body)) "\n"))
  519. ;;;###autoload
  520. (defun org-babel-expand-src-block (&optional arg info params)
  521. "Expand the current source code block.
  522. Expand according to the source code block's header
  523. arguments and pop open the results in a preview buffer."
  524. (interactive)
  525. (let* ((info (or info (org-babel-get-src-block-info)))
  526. (lang (nth 0 info))
  527. (params (setf (nth 2 info)
  528. (sort (org-babel-merge-params (nth 2 info) params)
  529. (lambda (el1 el2) (string< (symbol-name (car el1))
  530. (symbol-name (car el2)))))))
  531. (body (setf (nth 1 info)
  532. (if (org-babel-noweb-p params :eval)
  533. (org-babel-expand-noweb-references info) (nth 1 info))))
  534. (expand-cmd (intern (concat "org-babel-expand-body:" lang)))
  535. (assignments-cmd (intern (concat "org-babel-variable-assignments:"
  536. lang)))
  537. (expanded
  538. (if (fboundp expand-cmd) (funcall expand-cmd body params)
  539. (org-babel-expand-body:generic
  540. body params (and (fboundp assignments-cmd)
  541. (funcall assignments-cmd params))))))
  542. (org-edit-src-code
  543. nil expanded (concat "*Org-Babel Preview " (buffer-name) "[ " lang " ]*"))))
  544. (defun org-babel-edit-distance (s1 s2)
  545. "Return the edit (levenshtein) distance between strings S1 S2."
  546. (let* ((l1 (length s1))
  547. (l2 (length s2))
  548. (dist (map 'vector (lambda (_) (make-vector (1+ l2) nil))
  549. (number-sequence 1 (1+ l1)))))
  550. (flet ((in (i j) (aref (aref dist i) j))
  551. (mmin (&rest lst) (apply #'min (remove nil lst))))
  552. (setf (aref (aref dist 0) 0) 0)
  553. (dolist (i (number-sequence 1 l1))
  554. (dolist (j (number-sequence 1 l2))
  555. (setf (aref (aref dist i) j)
  556. (+ (if (equal (aref s1 (1- i)) (aref s2 (1- j))) 0 1)
  557. (mmin (in (1- i) j) (in i (1- j)) (in (1- i) (1- j)))))))
  558. (in l1 l2))))
  559. ;;;###autoload
  560. (defun org-babel-check-src-block ()
  561. "Check for misspelled header arguments in the current code block."
  562. (interactive)
  563. ;; TODO: report malformed code block
  564. ;; TODO: report incompatible combinations of header arguments
  565. ;; TODO: report uninitialized variables
  566. (let ((too-close 2) ;; <- control closeness to report potential match
  567. (names (mapcar #'symbol-name org-babel-header-arg-names)))
  568. (dolist (header (mapcar (lambda (arg) (substring (symbol-name (car arg)) 1))
  569. (and (org-babel-where-is-src-block-head)
  570. (org-babel-parse-header-arguments
  571. (org-babel-clean-text-properties
  572. (match-string 4))))))
  573. (dolist (name names)
  574. (when (and (not (string= header name))
  575. (<= (org-babel-edit-distance header name) too-close)
  576. (not (member header names)))
  577. (error "supplied header \"%S\" is suspiciously close to \"%S\""
  578. header name))))
  579. (message "No suspicious header arguments found.")))
  580. ;;;###autoload
  581. (defun org-babel-insert-header-arg ()
  582. "Insert a header argument selecting from lists of common args and values."
  583. (interactive)
  584. (let* ((lang (car (org-babel-get-src-block-info 'light)))
  585. (lang-headers (intern (concat "org-babel-header-arg-names:" lang)))
  586. (headers (append (if (boundp lang-headers)
  587. (mapcar (lambda (h) (cons h :any))
  588. (eval lang-headers))
  589. nil)
  590. org-babel-common-header-args-w-values))
  591. (arg (org-icompleting-read
  592. "Header Arg: "
  593. (mapcar
  594. (lambda (header-spec) (symbol-name (car header-spec)))
  595. headers))))
  596. (insert ":" arg)
  597. (let ((vals (cdr (assoc (intern arg) headers))))
  598. (when vals
  599. (insert
  600. " "
  601. (cond
  602. ((eq vals :any)
  603. (read-from-minibuffer "value: "))
  604. ((listp vals)
  605. (mapconcat
  606. (lambda (group)
  607. (let ((arg (org-icompleting-read
  608. "value: "
  609. (cons "default" (mapcar #'symbol-name group)))))
  610. (if (and arg (not (string= "default" arg)))
  611. (concat arg " ")
  612. "")))
  613. vals ""))))))))
  614. ;;;###autoload
  615. (defun org-babel-load-in-session (&optional arg info)
  616. "Load the body of the current source-code block.
  617. Evaluate the header arguments for the source block before
  618. entering the session. After loading the body this pops open the
  619. session."
  620. (interactive)
  621. (let* ((info (or info (org-babel-get-src-block-info)))
  622. (lang (nth 0 info))
  623. (params (nth 2 info))
  624. (body (setf (nth 1 info)
  625. (if (org-babel-noweb-p params :eval)
  626. (org-babel-expand-noweb-references info)
  627. (nth 1 info))))
  628. (session (cdr (assoc :session params)))
  629. (dir (cdr (assoc :dir params)))
  630. (default-directory
  631. (or (and dir (file-name-as-directory dir)) default-directory))
  632. (cmd (intern (concat "org-babel-load-session:" lang))))
  633. (unless (fboundp cmd)
  634. (error "No org-babel-load-session function for %s!" lang))
  635. (pop-to-buffer (funcall cmd session body params))
  636. (end-of-line 1)))
  637. ;;;###autoload
  638. (defun org-babel-initiate-session (&optional arg info)
  639. "Initiate session for current code block.
  640. If called with a prefix argument then resolve any variable
  641. references in the header arguments and assign these variables in
  642. the session. Copy the body of the code block to the kill ring."
  643. (interactive "P")
  644. (let* ((info (or info (org-babel-get-src-block-info (not arg))))
  645. (lang (nth 0 info))
  646. (body (nth 1 info))
  647. (params (nth 2 info))
  648. (session (cdr (assoc :session params)))
  649. (dir (cdr (assoc :dir params)))
  650. (default-directory
  651. (or (and dir (file-name-as-directory dir)) default-directory))
  652. (init-cmd (intern (format "org-babel-%s-initiate-session" lang)))
  653. (prep-cmd (intern (concat "org-babel-prep-session:" lang))))
  654. (if (and (stringp session) (string= session "none"))
  655. (error "This block is not using a session!"))
  656. (unless (fboundp init-cmd)
  657. (error "No org-babel-initiate-session function for %s!" lang))
  658. (with-temp-buffer (insert (org-babel-trim body))
  659. (copy-region-as-kill (point-min) (point-max)))
  660. (when arg
  661. (unless (fboundp prep-cmd)
  662. (error "No org-babel-prep-session function for %s!" lang))
  663. (funcall prep-cmd session params))
  664. (funcall init-cmd session params)))
  665. ;;;###autoload
  666. (defun org-babel-switch-to-session (&optional arg info)
  667. "Switch to the session of the current code block.
  668. Uses `org-babel-initiate-session' to start the session. If called
  669. with a prefix argument then this is passed on to
  670. `org-babel-initiate-session'."
  671. (interactive "P")
  672. (pop-to-buffer (org-babel-initiate-session arg info))
  673. (end-of-line 1))
  674. (defalias 'org-babel-pop-to-session 'org-babel-switch-to-session)
  675. ;;;###autoload
  676. (defun org-babel-switch-to-session-with-code (&optional arg info)
  677. "Switch to code buffer and display session."
  678. (interactive "P")
  679. (flet ((swap-windows
  680. ()
  681. (let ((other-window-buffer (window-buffer (next-window))))
  682. (set-window-buffer (next-window) (current-buffer))
  683. (set-window-buffer (selected-window) other-window-buffer))
  684. (other-window 1)))
  685. (let ((info (org-babel-get-src-block-info))
  686. (org-src-window-setup 'reorganize-frame))
  687. (save-excursion
  688. (org-babel-switch-to-session arg info))
  689. (org-edit-src-code))
  690. (swap-windows)))
  691. (defmacro org-babel-do-in-edit-buffer (&rest body)
  692. "Evaluate BODY in edit buffer if there is a code block at point.
  693. Return t if a code block was found at point, nil otherwise."
  694. `(let ((org-src-window-setup 'switch-invisibly))
  695. (when (and (org-babel-where-is-src-block-head)
  696. (org-edit-src-code nil nil nil))
  697. (unwind-protect (progn ,@body)
  698. (if (org-bound-and-true-p org-edit-src-from-org-mode)
  699. (org-edit-src-exit)))
  700. t)))
  701. (def-edebug-spec org-babel-do-in-edit-buffer (body))
  702. (defun org-babel-do-key-sequence-in-edit-buffer (key)
  703. "Read key sequence and execute the command in edit buffer.
  704. Enter a key sequence to be executed in the language major-mode
  705. edit buffer. For example, TAB will alter the contents of the
  706. Org-mode code block according to the effect of TAB in the
  707. language major-mode buffer. For languages that support
  708. interactive sessions, this can be used to send code from the Org
  709. buffer to the session for evaluation using the native major-mode
  710. evaluation mechanisms."
  711. (interactive "kEnter key-sequence to execute in edit buffer: ")
  712. (org-babel-do-in-edit-buffer
  713. (call-interactively
  714. (key-binding (or key (read-key-sequence nil))))))
  715. (defvar org-bracket-link-regexp)
  716. ;;;###autoload
  717. (defun org-babel-open-src-block-result (&optional re-run)
  718. "If `point' is on a src block then open the results of the
  719. source code block, otherwise return nil. With optional prefix
  720. argument RE-RUN the source-code block is evaluated even if
  721. results already exist."
  722. (interactive "P")
  723. (let ((info (org-babel-get-src-block-info)))
  724. (when info
  725. (save-excursion
  726. ;; go to the results, if there aren't any then run the block
  727. (goto-char (or (and (not re-run) (org-babel-where-is-src-block-result))
  728. (progn (org-babel-execute-src-block)
  729. (org-babel-where-is-src-block-result))))
  730. (end-of-line 1)
  731. (while (looking-at "[\n\r\t\f ]") (forward-char 1))
  732. ;; open the results
  733. (if (looking-at org-bracket-link-regexp)
  734. ;; file results
  735. (org-open-at-point)
  736. (let ((r (org-babel-format-result
  737. (org-babel-read-result) (cdr (assoc :sep (nth 2 info))))))
  738. (pop-to-buffer (get-buffer-create "*Org-Babel Results*"))
  739. (delete-region (point-min) (point-max))
  740. (insert r)))
  741. t))))
  742. ;;;###autoload
  743. (defmacro org-babel-map-src-blocks (file &rest body)
  744. "Evaluate BODY forms on each source-block in FILE.
  745. If FILE is nil evaluate BODY forms on source blocks in current
  746. buffer. During evaluation of BODY the following local variables
  747. are set relative to the currently matched code block.
  748. full-block ------- string holding the entirety of the code block
  749. beg-block -------- point at the beginning of the code block
  750. end-block -------- point at the end of the matched code block
  751. lang ------------- string holding the language of the code block
  752. beg-lang --------- point at the beginning of the lang
  753. end-lang --------- point at the end of the lang
  754. switches --------- string holding the switches
  755. beg-switches ----- point at the beginning of the switches
  756. end-switches ----- point at the end of the switches
  757. header-args ------ string holding the header-args
  758. beg-header-args -- point at the beginning of the header-args
  759. end-header-args -- point at the end of the header-args
  760. body ------------- string holding the body of the code block
  761. beg-body --------- point at the beginning of the body
  762. end-body --------- point at the end of the body"
  763. (declare (indent 1))
  764. (let ((tempvar (make-symbol "file")))
  765. `(let* ((,tempvar ,file)
  766. (visited-p (or (null ,tempvar)
  767. (get-file-buffer (expand-file-name ,tempvar))))
  768. (point (point)) to-be-removed)
  769. (save-window-excursion
  770. (when ,tempvar (find-file ,tempvar))
  771. (setq to-be-removed (current-buffer))
  772. (goto-char (point-min))
  773. (while (re-search-forward org-babel-src-block-regexp nil t)
  774. (goto-char (match-beginning 0))
  775. (let ((full-block (match-string 0))
  776. (beg-block (match-beginning 0))
  777. (end-block (match-end 0))
  778. (lang (match-string 2))
  779. (beg-lang (match-beginning 2))
  780. (end-lang (match-end 2))
  781. (switches (match-string 3))
  782. (beg-switches (match-beginning 3))
  783. (end-switches (match-end 3))
  784. (header-args (match-string 4))
  785. (beg-header-args (match-beginning 4))
  786. (end-header-args (match-end 4))
  787. (body (match-string 5))
  788. (beg-body (match-beginning 5))
  789. (end-body (match-end 5)))
  790. ,@body
  791. (goto-char end-block))))
  792. (unless visited-p (kill-buffer to-be-removed))
  793. (goto-char point))))
  794. (def-edebug-spec org-babel-map-src-blocks (form body))
  795. ;;;###autoload
  796. (defmacro org-babel-map-inline-src-blocks (file &rest body)
  797. "Evaluate BODY forms on each inline source-block in FILE.
  798. If FILE is nil evaluate BODY forms on source blocks in current
  799. buffer."
  800. (declare (indent 1))
  801. (let ((tempvar (make-symbol "file")))
  802. `(let* ((,tempvar ,file)
  803. (visited-p (or (null ,tempvar)
  804. (get-file-buffer (expand-file-name ,tempvar))))
  805. (point (point)) to-be-removed)
  806. (save-window-excursion
  807. (when ,tempvar (find-file ,tempvar))
  808. (setq to-be-removed (current-buffer))
  809. (goto-char (point-min))
  810. (while (re-search-forward org-babel-inline-src-block-regexp nil t)
  811. (goto-char (match-beginning 1))
  812. (save-match-data ,@body)
  813. (goto-char (match-end 0))))
  814. (unless visited-p (kill-buffer to-be-removed))
  815. (goto-char point))))
  816. (def-edebug-spec org-babel-map-inline-src-blocks (form body))
  817. (defvar org-babel-lob-one-liner-regexp)
  818. ;;;###autoload
  819. (defmacro org-babel-map-call-lines (file &rest body)
  820. "Evaluate BODY forms on each call line in FILE.
  821. If FILE is nil evaluate BODY forms on source blocks in current
  822. buffer."
  823. (declare (indent 1))
  824. (let ((tempvar (make-symbol "file")))
  825. `(let* ((,tempvar ,file)
  826. (visited-p (or (null ,tempvar)
  827. (get-file-buffer (expand-file-name ,tempvar))))
  828. (point (point)) to-be-removed)
  829. (save-window-excursion
  830. (when ,tempvar (find-file ,tempvar))
  831. (setq to-be-removed (current-buffer))
  832. (goto-char (point-min))
  833. (while (re-search-forward org-babel-lob-one-liner-regexp nil t)
  834. (goto-char (match-beginning 1))
  835. (save-match-data ,@body)
  836. (goto-char (match-end 0))))
  837. (unless visited-p (kill-buffer to-be-removed))
  838. (goto-char point))))
  839. (def-edebug-spec org-babel-map-call-lines (form body))
  840. ;;;###autoload
  841. (defmacro org-babel-map-executables (file &rest body)
  842. (declare (indent 1))
  843. (let ((tempvar (make-symbol "file"))
  844. (rx (make-symbol "rx")))
  845. `(let* ((,tempvar ,file)
  846. (,rx (concat "\\(" org-babel-src-block-regexp
  847. "\\|" org-babel-inline-src-block-regexp
  848. "\\|" org-babel-lob-one-liner-regexp "\\)"))
  849. (visited-p (or (null ,tempvar)
  850. (get-file-buffer (expand-file-name ,tempvar))))
  851. (point (point)) to-be-removed)
  852. (save-window-excursion
  853. (when ,tempvar (find-file ,tempvar))
  854. (setq to-be-removed (current-buffer))
  855. (goto-char (point-min))
  856. (while (re-search-forward ,rx nil t)
  857. (goto-char (match-beginning 1))
  858. (when (looking-at org-babel-inline-src-block-regexp)(forward-char 1))
  859. (save-match-data ,@body)
  860. (goto-char (match-end 0))))
  861. (unless visited-p (kill-buffer to-be-removed))
  862. (goto-char point))))
  863. (def-edebug-spec org-babel-map-executables (form body))
  864. ;;;###autoload
  865. (defun org-babel-execute-buffer (&optional arg)
  866. "Execute source code blocks in a buffer.
  867. Call `org-babel-execute-src-block' on every source block in
  868. the current buffer."
  869. (interactive "P")
  870. (org-babel-eval-wipe-error-buffer)
  871. (org-save-outline-visibility t
  872. (org-babel-map-executables nil
  873. (if (looking-at org-babel-lob-one-liner-regexp)
  874. (org-babel-lob-execute-maybe)
  875. (org-babel-execute-src-block arg)))))
  876. ;;;###autoload
  877. (defun org-babel-execute-subtree (&optional arg)
  878. "Execute source code blocks in a subtree.
  879. Call `org-babel-execute-src-block' on every source block in
  880. the current subtree."
  881. (interactive "P")
  882. (save-restriction
  883. (save-excursion
  884. (org-narrow-to-subtree)
  885. (org-babel-execute-buffer arg)
  886. (widen))))
  887. ;;;###autoload
  888. (defun org-babel-sha1-hash (&optional info)
  889. "Generate an sha1 hash based on the value of info."
  890. (interactive)
  891. (let ((print-level nil)
  892. (info (or info (org-babel-get-src-block-info))))
  893. (setf (nth 2 info)
  894. (sort (copy-sequence (nth 2 info))
  895. (lambda (a b) (string< (car a) (car b)))))
  896. (labels ((rm (lst)
  897. (dolist (p '("replace" "silent" "append" "prepend"))
  898. (setq lst (remove p lst)))
  899. lst)
  900. (norm (arg)
  901. (let ((v (if (and (listp (cdr arg)) (null (cddr arg)))
  902. (copy-sequence (cdr arg))
  903. (cdr arg))))
  904. (when (and v (not (and (sequencep v)
  905. (not (consp v))
  906. (= (length v) 0))))
  907. (cond
  908. ((and (listp v) ; lists are sorted
  909. (member (car arg) '(:result-params)))
  910. (sort (rm v) #'string<))
  911. ((and (stringp v) ; strings are sorted
  912. (member (car arg) '(:results :exports)))
  913. (mapconcat #'identity (sort (rm (split-string v))
  914. #'string<) " "))
  915. (t v))))))
  916. ((lambda (hash)
  917. (when (org-called-interactively-p 'interactive) (message hash)) hash)
  918. (let ((it (format "%s-%s"
  919. (mapconcat
  920. #'identity
  921. (delq nil (mapcar (lambda (arg)
  922. (let ((normalized (norm arg)))
  923. (when normalized
  924. (format "%S" normalized))))
  925. (nth 2 info))) ":")
  926. (nth 1 info))))
  927. (sha1 it))))))
  928. (defun org-babel-current-result-hash ()
  929. "Return the in-buffer hash associated with INFO."
  930. (org-babel-where-is-src-block-result)
  931. (org-babel-clean-text-properties (match-string 3)))
  932. (defun org-babel-hide-hash ()
  933. "Hide the hash in the current results line.
  934. Only the initial `org-babel-hash-show' characters of the hash
  935. will remain visible."
  936. (add-to-invisibility-spec '(org-babel-hide-hash . t))
  937. (save-excursion
  938. (when (and (re-search-forward org-babel-result-regexp nil t)
  939. (match-string 3))
  940. (let* ((start (match-beginning 3))
  941. (hide-start (+ org-babel-hash-show start))
  942. (end (match-end 3))
  943. (hash (match-string 3))
  944. ov1 ov2)
  945. (setq ov1 (make-overlay start hide-start))
  946. (setq ov2 (make-overlay hide-start end))
  947. (overlay-put ov2 'invisible 'org-babel-hide-hash)
  948. (overlay-put ov1 'babel-hash hash)))))
  949. (defun org-babel-hide-all-hashes ()
  950. "Hide the hash in the current buffer.
  951. Only the initial `org-babel-hash-show' characters of each hash
  952. will remain visible. This function should be called as part of
  953. the `org-mode-hook'."
  954. (save-excursion
  955. (while (re-search-forward org-babel-result-regexp nil t)
  956. (goto-char (match-beginning 0))
  957. (org-babel-hide-hash)
  958. (goto-char (match-end 0)))))
  959. (add-hook 'org-mode-hook 'org-babel-hide-all-hashes)
  960. (defun org-babel-hash-at-point (&optional point)
  961. "Return the value of the hash at POINT.
  962. The hash is also added as the last element of the kill ring.
  963. This can be called with C-c C-c."
  964. (interactive)
  965. (let ((hash (car (delq nil (mapcar
  966. (lambda (ol) (overlay-get ol 'babel-hash))
  967. (overlays-at (or point (point))))))))
  968. (when hash (kill-new hash) (message hash))))
  969. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-babel-hash-at-point)
  970. (defun org-babel-result-hide-spec ()
  971. "Hide portions of results lines.
  972. Add `org-babel-hide-result' as an invisibility spec for hiding
  973. portions of results lines."
  974. (add-to-invisibility-spec '(org-babel-hide-result . t)))
  975. (add-hook 'org-mode-hook 'org-babel-result-hide-spec)
  976. (defvar org-babel-hide-result-overlays nil
  977. "Overlays hiding results.")
  978. (defun org-babel-result-hide-all ()
  979. "Fold all results in the current buffer."
  980. (interactive)
  981. (org-babel-show-result-all)
  982. (save-excursion
  983. (while (re-search-forward org-babel-result-regexp nil t)
  984. (save-excursion (goto-char (match-beginning 0))
  985. (org-babel-hide-result-toggle-maybe)))))
  986. (defun org-babel-show-result-all ()
  987. "Unfold all results in the current buffer."
  988. (mapc 'delete-overlay org-babel-hide-result-overlays)
  989. (setq org-babel-hide-result-overlays nil))
  990. ;;;###autoload
  991. (defun org-babel-hide-result-toggle-maybe ()
  992. "Toggle visibility of result at point."
  993. (interactive)
  994. (let ((case-fold-search t))
  995. (if (save-excursion
  996. (beginning-of-line 1)
  997. (looking-at org-babel-result-regexp))
  998. (progn (org-babel-hide-result-toggle)
  999. t) ;; to signal that we took action
  1000. nil))) ;; to signal that we did not
  1001. (defun org-babel-hide-result-toggle (&optional force)
  1002. "Toggle the visibility of the current result."
  1003. (interactive)
  1004. (save-excursion
  1005. (beginning-of-line)
  1006. (if (re-search-forward org-babel-result-regexp nil t)
  1007. (let ((start (progn (beginning-of-line 2) (- (point) 1)))
  1008. (end (progn
  1009. (while (looking-at org-babel-multi-line-header-regexp)
  1010. (forward-line 1))
  1011. (goto-char (- (org-babel-result-end) 1)) (point)))
  1012. ov)
  1013. (if (memq t (mapcar (lambda (overlay)
  1014. (eq (overlay-get overlay 'invisible)
  1015. 'org-babel-hide-result))
  1016. (overlays-at start)))
  1017. (if (or (not force) (eq force 'off))
  1018. (mapc (lambda (ov)
  1019. (when (member ov org-babel-hide-result-overlays)
  1020. (setq org-babel-hide-result-overlays
  1021. (delq ov org-babel-hide-result-overlays)))
  1022. (when (eq (overlay-get ov 'invisible)
  1023. 'org-babel-hide-result)
  1024. (delete-overlay ov)))
  1025. (overlays-at start)))
  1026. (setq ov (make-overlay start end))
  1027. (overlay-put ov 'invisible 'org-babel-hide-result)
  1028. ;; make the block accessible to isearch
  1029. (overlay-put
  1030. ov 'isearch-open-invisible
  1031. (lambda (ov)
  1032. (when (member ov org-babel-hide-result-overlays)
  1033. (setq org-babel-hide-result-overlays
  1034. (delq ov org-babel-hide-result-overlays)))
  1035. (when (eq (overlay-get ov 'invisible)
  1036. 'org-babel-hide-result)
  1037. (delete-overlay ov))))
  1038. (push ov org-babel-hide-result-overlays)))
  1039. (error "Not looking at a result line"))))
  1040. ;; org-tab-after-check-for-cycling-hook
  1041. (add-hook 'org-tab-first-hook 'org-babel-hide-result-toggle-maybe)
  1042. ;; Remove overlays when changing major mode
  1043. (add-hook 'org-mode-hook
  1044. (lambda () (org-add-hook 'change-major-mode-hook
  1045. 'org-babel-show-result-all 'append 'local)))
  1046. (defvar org-file-properties)
  1047. (defun org-babel-params-from-properties (&optional lang)
  1048. "Retrieve parameters specified as properties.
  1049. Return an association list of any source block params which
  1050. may be specified in the properties of the current outline entry."
  1051. (save-match-data
  1052. (let (val sym)
  1053. (org-babel-parse-multiple-vars
  1054. (delq nil
  1055. (mapcar
  1056. (lambda (header-arg)
  1057. (and (setq val (org-entry-get (point) header-arg t))
  1058. (cons (intern (concat ":" header-arg))
  1059. (org-babel-read val))))
  1060. (mapcar
  1061. 'symbol-name
  1062. (append
  1063. org-babel-header-arg-names
  1064. (progn
  1065. (setq sym (intern (concat "org-babel-header-arg-names:"
  1066. lang)))
  1067. (and (boundp sym) (eval sym)))))))))))
  1068. (defvar org-src-preserve-indentation)
  1069. (defun org-babel-parse-src-block-match ()
  1070. "Parse the results from a match of the `org-babel-src-block-regexp'."
  1071. (let* ((block-indentation (length (match-string 1)))
  1072. (lang (org-babel-clean-text-properties (match-string 2)))
  1073. (lang-headers (intern (concat "org-babel-default-header-args:" lang)))
  1074. (switches (match-string 3))
  1075. (body (org-babel-clean-text-properties
  1076. (let* ((body (match-string 5))
  1077. (sub-length (- (length body) 1)))
  1078. (if (and (> sub-length 0)
  1079. (string= "\n" (substring body sub-length)))
  1080. (substring body 0 sub-length)
  1081. (or body "")))))
  1082. (preserve-indentation (or org-src-preserve-indentation
  1083. (string-match "-i\\>" switches))))
  1084. (list lang
  1085. ;; get block body less properties, protective commas, and indentation
  1086. (with-temp-buffer
  1087. (save-match-data
  1088. (insert (org-babel-strip-protective-commas body))
  1089. (unless preserve-indentation (org-do-remove-indentation))
  1090. (buffer-string)))
  1091. (org-babel-merge-params
  1092. org-babel-default-header-args
  1093. (org-babel-params-from-properties lang)
  1094. (if (boundp lang-headers) (eval lang-headers) nil)
  1095. (org-babel-parse-header-arguments
  1096. (org-babel-clean-text-properties (or (match-string 4) ""))))
  1097. switches
  1098. block-indentation)))
  1099. (defun org-babel-parse-inline-src-block-match ()
  1100. "Parse the results from a match of the `org-babel-inline-src-block-regexp'."
  1101. (let* ((lang (org-babel-clean-text-properties (match-string 2)))
  1102. (lang-headers (intern (concat "org-babel-default-header-args:" lang))))
  1103. (list lang
  1104. (org-babel-strip-protective-commas
  1105. (org-babel-clean-text-properties (match-string 5)))
  1106. (org-babel-merge-params
  1107. org-babel-default-inline-header-args
  1108. (org-babel-params-from-properties lang)
  1109. (if (boundp lang-headers) (eval lang-headers) nil)
  1110. (org-babel-parse-header-arguments
  1111. (org-babel-clean-text-properties (or (match-string 4) "")))))))
  1112. (defun org-babel-balanced-split (string alts)
  1113. "Split STRING on instances of ALTS.
  1114. ALTS is a cons of two character options where each option may be
  1115. either the numeric code of a single character or a list of
  1116. character alternatives. For example to split on balanced
  1117. instances of \"[ \t]:\" set ALTS to '((32 9) . 58)."
  1118. (flet ((matches (ch spec) (if (listp spec) (member ch spec) (equal spec ch)))
  1119. (matched (ch last)
  1120. (if (consp alts)
  1121. (and (matches ch (cdr alts))
  1122. (matches last (car alts)))
  1123. (matches ch alts))))
  1124. (let ((balance 0) (quote nil) (partial nil) (lst nil) (last 0))
  1125. (mapc (lambda (ch) ; split on [], (), "" balanced instances of [ \t]:
  1126. (setq balance (+ balance
  1127. (cond ((or (equal 91 ch) (equal 40 ch)) 1)
  1128. ((or (equal 93 ch) (equal 41 ch)) -1)
  1129. (t 0))))
  1130. (when (and (equal 34 ch) (not (equal 92 last)))
  1131. (setq quote (not quote)))
  1132. (setq partial (cons ch partial))
  1133. (when (and (= balance 0) (not quote) (matched ch last))
  1134. (setq lst (cons (apply #'string (nreverse
  1135. (if (consp alts)
  1136. (cddr partial)
  1137. (cdr partial))))
  1138. lst))
  1139. (setq partial nil))
  1140. (setq last ch))
  1141. (string-to-list string))
  1142. (nreverse (cons (apply #'string (nreverse partial)) lst)))))
  1143. (defun org-babel-join-splits-near-ch (ch list)
  1144. "Join splits where \"=\" is on either end of the split."
  1145. (flet ((last= (str) (= ch (aref str (1- (length str)))))
  1146. (first= (str) (= ch (aref str 0))))
  1147. (reverse
  1148. (org-reduce (lambda (acc el)
  1149. (let ((head (car acc)))
  1150. (if (and head (or (last= head) (first= el)))
  1151. (cons (concat head el) (cdr acc))
  1152. (cons el acc))))
  1153. list :initial-value nil))))
  1154. (defun org-babel-parse-header-arguments (arg-string)
  1155. "Parse a string of header arguments returning an alist."
  1156. (when (> (length arg-string) 0)
  1157. (org-babel-parse-multiple-vars
  1158. (delq nil
  1159. (mapcar
  1160. (lambda (arg)
  1161. (if (string-match
  1162. "\\([^ \f\t\n\r\v]+\\)[ \f\t\n\r\v]+\\([^ \f\t\n\r\v]+.*\\)"
  1163. arg)
  1164. (cons (intern (match-string 1 arg))
  1165. (org-babel-read (org-babel-chomp (match-string 2 arg))))
  1166. (cons (intern (org-babel-chomp arg)) nil)))
  1167. ((lambda (raw)
  1168. (cons (car raw) (mapcar (lambda (r) (concat ":" r)) (cdr raw))))
  1169. (org-babel-balanced-split arg-string '((32 9) . 58))))))))
  1170. (defun org-babel-parse-multiple-vars (header-arguments)
  1171. "Expand multiple variable assignments behind a single :var keyword.
  1172. This allows expression of multiple variables with one :var as
  1173. shown below.
  1174. #+PROPERTY: var foo=1, bar=2"
  1175. (let (results)
  1176. (mapc (lambda (pair)
  1177. (if (eq (car pair) :var)
  1178. (mapcar (lambda (v) (push (cons :var (org-babel-trim v)) results))
  1179. (org-babel-join-splits-near-ch
  1180. 61 (org-babel-balanced-split (cdr pair) 32)))
  1181. (push pair results)))
  1182. header-arguments)
  1183. (nreverse results)))
  1184. (defun org-babel-process-params (params)
  1185. "Expand variables in PARAMS and add summary parameters."
  1186. (let* ((processed-vars (mapcar (lambda (el)
  1187. (if (consp (cdr el))
  1188. (cdr el)
  1189. (org-babel-ref-parse (cdr el))))
  1190. (org-babel-get-header params :var)))
  1191. (vars-and-names (if (and (assoc :colname-names params)
  1192. (assoc :rowname-names params))
  1193. (list processed-vars)
  1194. (org-babel-disassemble-tables
  1195. processed-vars
  1196. (cdr (assoc :hlines params))
  1197. (cdr (assoc :colnames params))
  1198. (cdr (assoc :rownames params)))))
  1199. (raw-result (or (cdr (assoc :results params)) ""))
  1200. (result-params (append
  1201. (split-string (if (stringp raw-result)
  1202. raw-result
  1203. (eval raw-result)))
  1204. (cdr (assoc :result-params params)))))
  1205. (append
  1206. (mapcar (lambda (var) (cons :var var)) (car vars-and-names))
  1207. (list
  1208. (cons :colname-names (or (cdr (assoc :colname-names params))
  1209. (cadr vars-and-names)))
  1210. (cons :rowname-names (or (cdr (assoc :rowname-names params))
  1211. (caddr vars-and-names)))
  1212. (cons :result-params result-params)
  1213. (cons :result-type (cond ((member "output" result-params) 'output)
  1214. ((member "value" result-params) 'value)
  1215. (t 'value))))
  1216. (org-babel-get-header params :var 'other))))
  1217. ;; row and column names
  1218. (defun org-babel-del-hlines (table)
  1219. "Remove all 'hlines from TABLE."
  1220. (remove 'hline table))
  1221. (defun org-babel-get-colnames (table)
  1222. "Return the column names of TABLE.
  1223. Return a cons cell, the `car' of which contains the TABLE less
  1224. colnames, and the `cdr' of which contains a list of the column
  1225. names."
  1226. (if (equal 'hline (nth 1 table))
  1227. (cons (cddr table) (car table))
  1228. (cons (cdr table) (car table))))
  1229. (defun org-babel-get-rownames (table)
  1230. "Return the row names of TABLE.
  1231. Return a cons cell, the `car' of which contains the TABLE less
  1232. colnames, and the `cdr' of which contains a list of the column
  1233. names. Note: this function removes any hlines in TABLE."
  1234. (flet ((trans (table) (apply #'mapcar* #'list table)))
  1235. (let* ((width (apply 'max
  1236. (mapcar (lambda (el) (if (listp el) (length el) 0)) table)))
  1237. (table (trans (mapcar (lambda (row)
  1238. (if (not (equal row 'hline))
  1239. row
  1240. (setq row '())
  1241. (dotimes (n width)
  1242. (setq row (cons 'hline row)))
  1243. row))
  1244. table))))
  1245. (cons (mapcar (lambda (row) (if (equal (car row) 'hline) 'hline row))
  1246. (trans (cdr table)))
  1247. (remove 'hline (car table))))))
  1248. (defun org-babel-put-colnames (table colnames)
  1249. "Add COLNAMES to TABLE if they exist."
  1250. (if colnames (apply 'list colnames 'hline table) table))
  1251. (defun org-babel-put-rownames (table rownames)
  1252. "Add ROWNAMES to TABLE if they exist."
  1253. (if rownames
  1254. (mapcar (lambda (row)
  1255. (if (listp row)
  1256. (cons (or (pop rownames) "") row)
  1257. row)) table)
  1258. table))
  1259. (defun org-babel-pick-name (names selector)
  1260. "Select one out of an alist of row or column names.
  1261. SELECTOR can be either a list of names in which case those names
  1262. will be returned directly, or an index into the list NAMES in
  1263. which case the indexed names will be return."
  1264. (if (listp selector)
  1265. selector
  1266. (when names
  1267. (if (and selector (symbolp selector) (not (equal t selector)))
  1268. (cdr (assoc selector names))
  1269. (if (integerp selector)
  1270. (nth (- selector 1) names)
  1271. (cdr (car (last names))))))))
  1272. (defun org-babel-disassemble-tables (vars hlines colnames rownames)
  1273. "Parse tables for further processing.
  1274. Process the variables in VARS according to the HLINES,
  1275. ROWNAMES and COLNAMES header arguments. Return a list consisting
  1276. of the vars, cnames and rnames."
  1277. (let (cnames rnames)
  1278. (list
  1279. (mapcar
  1280. (lambda (var)
  1281. (when (listp (cdr var))
  1282. (when (and (not (equal colnames "no"))
  1283. (or colnames (and (equal (nth 1 (cdr var)) 'hline)
  1284. (not (member 'hline (cddr (cdr var)))))))
  1285. (let ((both (org-babel-get-colnames (cdr var))))
  1286. (setq cnames (cons (cons (car var) (cdr both))
  1287. cnames))
  1288. (setq var (cons (car var) (car both)))))
  1289. (when (and rownames (not (equal rownames "no")))
  1290. (let ((both (org-babel-get-rownames (cdr var))))
  1291. (setq rnames (cons (cons (car var) (cdr both))
  1292. rnames))
  1293. (setq var (cons (car var) (car both)))))
  1294. (when (and hlines (not (equal hlines "yes")))
  1295. (setq var (cons (car var) (org-babel-del-hlines (cdr var))))))
  1296. var)
  1297. vars)
  1298. (reverse cnames) (reverse rnames))))
  1299. (defun org-babel-reassemble-table (table colnames rownames)
  1300. "Add column and row names to a table.
  1301. Given a TABLE and set of COLNAMES and ROWNAMES add the names
  1302. to the table for reinsertion to org-mode."
  1303. (if (listp table)
  1304. ((lambda (table)
  1305. (if (and colnames (listp (car table)) (= (length (car table))
  1306. (length colnames)))
  1307. (org-babel-put-colnames table colnames) table))
  1308. (if (and rownames (= (length table) (length rownames)))
  1309. (org-babel-put-rownames table rownames) table))
  1310. table))
  1311. (defun org-babel-where-is-src-block-head ()
  1312. "Find where the current source block begins.
  1313. Return the point at the beginning of the current source
  1314. block. Specifically at the beginning of the #+BEGIN_SRC line.
  1315. If the point is not on a source block then return nil."
  1316. (let ((initial (point)) top bottom)
  1317. (or
  1318. (save-excursion ;; on a source name line or a #+header line
  1319. (beginning-of-line 1)
  1320. (and (or (looking-at org-babel-src-name-regexp)
  1321. (looking-at org-babel-multi-line-header-regexp))
  1322. (progn
  1323. (while (and (forward-line 1)
  1324. (looking-at org-babel-multi-line-header-regexp)))
  1325. (looking-at org-babel-src-block-regexp))
  1326. (point)))
  1327. (save-excursion ;; on a #+begin_src line
  1328. (beginning-of-line 1)
  1329. (and (looking-at org-babel-src-block-regexp)
  1330. (point)))
  1331. (save-excursion ;; inside a src block
  1332. (and
  1333. (re-search-backward "^[ \t]*#\\+begin_src" nil t) (setq top (point))
  1334. (re-search-forward "^[ \t]*#\\+end_src" nil t) (setq bottom (point))
  1335. (< top initial) (< initial bottom)
  1336. (progn (goto-char top) (beginning-of-line 1)
  1337. (looking-at org-babel-src-block-regexp))
  1338. (point))))))
  1339. ;;;###autoload
  1340. (defun org-babel-goto-src-block-head ()
  1341. "Go to the beginning of the current code block."
  1342. (interactive)
  1343. ((lambda (head)
  1344. (if head (goto-char head) (error "not currently in a code block")))
  1345. (org-babel-where-is-src-block-head)))
  1346. ;;;###autoload
  1347. (defun org-babel-goto-named-src-block (name)
  1348. "Go to a named source-code block."
  1349. (interactive
  1350. (let ((completion-ignore-case t))
  1351. (list (org-icompleting-read "source-block name: "
  1352. (org-babel-src-block-names) nil t))))
  1353. (let ((point (org-babel-find-named-block name)))
  1354. (if point
  1355. ;; taken from `org-open-at-point'
  1356. (progn (goto-char point) (org-show-context))
  1357. (message "source-code block '%s' not found in this buffer" name))))
  1358. (defun org-babel-find-named-block (name)
  1359. "Find a named source-code block.
  1360. Return the location of the source block identified by source
  1361. NAME, or nil if no such block exists. Set match data according to
  1362. org-babel-named-src-block-regexp."
  1363. (save-excursion
  1364. (let ((case-fold-search t)
  1365. (regexp (org-babel-named-src-block-regexp-for-name name)) msg)
  1366. (goto-char (point-min))
  1367. (when (or (re-search-forward regexp nil t)
  1368. (re-search-backward regexp nil t))
  1369. (match-beginning 0)))))
  1370. (defun org-babel-src-block-names (&optional file)
  1371. "Returns the names of source blocks in FILE or the current buffer."
  1372. (save-excursion
  1373. (when file (find-file file)) (goto-char (point-min))
  1374. (let (names)
  1375. (while (re-search-forward org-babel-src-name-w-name-regexp nil t)
  1376. (setq names (cons (match-string 3) names)))
  1377. names)))
  1378. ;;;###autoload
  1379. (defun org-babel-goto-named-result (name)
  1380. "Go to a named result."
  1381. (interactive
  1382. (let ((completion-ignore-case t))
  1383. (list (org-icompleting-read "source-block name: "
  1384. (org-babel-result-names) nil t))))
  1385. (let ((point (org-babel-find-named-result name)))
  1386. (if point
  1387. ;; taken from `org-open-at-point'
  1388. (progn (goto-char point) (org-show-context))
  1389. (message "result '%s' not found in this buffer" name))))
  1390. (defun org-babel-find-named-result (name &optional point)
  1391. "Find a named result.
  1392. Return the location of the result named NAME in the current
  1393. buffer or nil if no such result exists."
  1394. (save-excursion
  1395. (goto-char (or point (point-min)))
  1396. (catch 'is-a-code-block
  1397. (when (re-search-forward
  1398. (concat org-babel-result-regexp
  1399. "[ \t]" (regexp-quote name) "[ \t\n\f\v\r]") nil t)
  1400. (when (and (string= "name" (downcase (match-string 1)))
  1401. (or (looking-at org-babel-src-block-regexp)
  1402. (looking-at org-babel-multi-line-header-regexp)))
  1403. (throw 'is-a-code-block (org-babel-find-named-result name (point))))
  1404. (beginning-of-line 0) (point)))))
  1405. (defun org-babel-result-names (&optional file)
  1406. "Returns the names of results in FILE or the current buffer."
  1407. (save-excursion
  1408. (when file (find-file file)) (goto-char (point-min))
  1409. (let (names)
  1410. (while (re-search-forward org-babel-result-w-name-regexp nil t)
  1411. (setq names (cons (match-string 4) names)))
  1412. names)))
  1413. ;;;###autoload
  1414. (defun org-babel-next-src-block (&optional arg)
  1415. "Jump to the next source block.
  1416. With optional prefix argument ARG, jump forward ARG many source blocks."
  1417. (interactive "P")
  1418. (when (looking-at org-babel-src-block-regexp) (forward-char 1))
  1419. (condition-case nil
  1420. (re-search-forward org-babel-src-block-regexp nil nil (or arg 1))
  1421. (error (error "No further code blocks")))
  1422. (goto-char (match-beginning 0)) (org-show-context))
  1423. ;;;###autoload
  1424. (defun org-babel-previous-src-block (&optional arg)
  1425. "Jump to the previous source block.
  1426. With optional prefix argument ARG, jump backward ARG many source blocks."
  1427. (interactive "P")
  1428. (condition-case nil
  1429. (re-search-backward org-babel-src-block-regexp nil nil (or arg 1))
  1430. (error (error "No previous code blocks")))
  1431. (goto-char (match-beginning 0)) (org-show-context))
  1432. (defvar org-babel-load-languages)
  1433. ;;;###autoload
  1434. (defun org-babel-mark-block ()
  1435. "Mark current src block"
  1436. (interactive)
  1437. ((lambda (head)
  1438. (when head
  1439. (save-excursion
  1440. (goto-char head)
  1441. (looking-at org-babel-src-block-regexp))
  1442. (push-mark (match-end 5) nil t)
  1443. (goto-char (match-beginning 5))))
  1444. (org-babel-where-is-src-block-head)))
  1445. (defun org-babel-demarcate-block (&optional arg)
  1446. "Wrap or split the code in the region or on the point.
  1447. When called from inside of a code block the current block is
  1448. split. When called from outside of a code block a new code block
  1449. is created. In both cases if the region is demarcated and if the
  1450. region is not active then the point is demarcated."
  1451. (interactive "P")
  1452. (let ((info (org-babel-get-src-block-info 'light))
  1453. (headers (progn (org-babel-where-is-src-block-head)
  1454. (match-string 4)))
  1455. (stars (concat (make-string (or (org-current-level) 1) ?*) " ")))
  1456. (if info
  1457. (mapc
  1458. (lambda (place)
  1459. (save-excursion
  1460. (goto-char place)
  1461. (let ((lang (nth 0 info))
  1462. (indent (make-string (nth 5 info) ? )))
  1463. (when (string-match "^[[:space:]]*$"
  1464. (buffer-substring (point-at-bol)
  1465. (point-at-eol)))
  1466. (delete-region (point-at-bol) (point-at-eol)))
  1467. (insert (concat
  1468. (if (looking-at "^") "" "\n")
  1469. indent "#+end_src\n"
  1470. (if arg stars indent) "\n"
  1471. indent "#+begin_src " lang
  1472. (if (> (length headers) 1)
  1473. (concat " " headers) headers)
  1474. (if (looking-at "[\n\r]")
  1475. ""
  1476. (concat "\n" (make-string (current-column) ? )))))))
  1477. (move-end-of-line 2))
  1478. (sort (if (region-active-p) (list (mark) (point)) (list (point))) #'>))
  1479. (let ((start (point))
  1480. (lang (org-icompleting-read "Lang: "
  1481. (mapcar (lambda (el) (symbol-name (car el)))
  1482. org-babel-load-languages)))
  1483. (body (delete-and-extract-region
  1484. (if (region-active-p) (mark) (point)) (point))))
  1485. (insert (concat (if (looking-at "^") "" "\n")
  1486. (if arg (concat stars "\n") "")
  1487. "#+begin_src " lang "\n"
  1488. body
  1489. (if (or (= (length body) 0)
  1490. (string-match "[\r\n]$" body)) "" "\n")
  1491. "#+end_src\n"))
  1492. (goto-char start) (move-end-of-line 1)))))
  1493. (defvar org-babel-lob-one-liner-regexp)
  1494. (defun org-babel-where-is-src-block-result (&optional insert info hash indent)
  1495. "Find where the current source block results begin.
  1496. Return the point at the beginning of the result of the current
  1497. source block. Specifically at the beginning of the results line.
  1498. If no result exists for this block then create a results line
  1499. following the source block."
  1500. (save-excursion
  1501. (let* ((on-lob-line (save-excursion
  1502. (beginning-of-line 1)
  1503. (looking-at org-babel-lob-one-liner-regexp)))
  1504. (inlinep (when (org-babel-get-inline-src-block-matches)
  1505. (match-end 0)))
  1506. (name (if on-lob-line
  1507. (nth 0 (org-babel-lob-get-info))
  1508. (nth 4 (or info (org-babel-get-src-block-info 'light)))))
  1509. (head (unless on-lob-line (org-babel-where-is-src-block-head)))
  1510. found beg end)
  1511. (when head (goto-char head))
  1512. (setq
  1513. found ;; was there a result (before we potentially insert one)
  1514. (or
  1515. inlinep
  1516. (and
  1517. ;; named results:
  1518. ;; - return t if it is found, else return nil
  1519. ;; - if it does not need to be rebuilt, then don't set end
  1520. ;; - if it does need to be rebuilt then do set end
  1521. name (setq beg (org-babel-find-named-result name))
  1522. (prog1 beg
  1523. (when (and hash (not (string= hash (match-string 3))))
  1524. (goto-char beg) (setq end beg) ;; beginning of result
  1525. (forward-line 1)
  1526. (delete-region end (org-babel-result-end)) nil)))
  1527. (and
  1528. ;; unnamed results:
  1529. ;; - return t if it is found, else return nil
  1530. ;; - if it is found, and the hash doesn't match, delete and set end
  1531. (or on-lob-line (re-search-forward "^[ \t]*#\\+end_src" nil t))
  1532. (progn (end-of-line 1)
  1533. (if (eobp) (insert "\n") (forward-char 1))
  1534. (setq end (point))
  1535. (or (and (not name)
  1536. (progn ;; unnamed results line already exists
  1537. (re-search-forward "[^ \f\t\n\r\v]" nil t)
  1538. (beginning-of-line 1)
  1539. (looking-at
  1540. (concat org-babel-result-regexp "\n")))
  1541. (prog1 (point)
  1542. ;; must remove and rebuild if hash!=old-hash
  1543. (if (and hash (not (string= hash (match-string 3))))
  1544. (prog1 nil
  1545. (forward-line 1)
  1546. (delete-region
  1547. end (org-babel-result-end)))
  1548. (setq end nil)))))))))
  1549. (if (and insert end)
  1550. (progn
  1551. (goto-char end)
  1552. (unless beg
  1553. (if (looking-at "[\n\r]") (forward-char 1) (insert "\n")))
  1554. (insert (concat
  1555. (if indent
  1556. (mapconcat
  1557. (lambda (el) " ")
  1558. (org-number-sequence 1 indent) "")
  1559. "")
  1560. "#+" org-babel-results-keyword
  1561. (when hash (concat "["hash"]"))
  1562. ":"
  1563. (when name (concat " " name)) "\n"))
  1564. (unless beg (insert "\n") (backward-char))
  1565. (beginning-of-line 0)
  1566. (if hash (org-babel-hide-hash))
  1567. (point))
  1568. found))))
  1569. (defvar org-block-regexp)
  1570. (defun org-babel-read-result ()
  1571. "Read the result at `point' into emacs-lisp."
  1572. (let ((case-fold-search t) result-string)
  1573. (cond
  1574. ((org-at-table-p) (org-babel-read-table))
  1575. ((org-at-item-p) (org-babel-read-list))
  1576. ((looking-at org-bracket-link-regexp) (org-babel-read-link))
  1577. ((looking-at org-block-regexp) (org-babel-trim (match-string 4)))
  1578. ((looking-at "^[ \t]*: ")
  1579. (setq result-string
  1580. (org-babel-trim
  1581. (mapconcat (lambda (line)
  1582. (if (and (> (length line) 1)
  1583. (string-match "^[ \t]*: \\(.+\\)" line))
  1584. (match-string 1 line)
  1585. line))
  1586. (split-string
  1587. (buffer-substring
  1588. (point) (org-babel-result-end)) "[\r\n]+")
  1589. "\n")))
  1590. (or (org-babel-number-p result-string) result-string))
  1591. ((looking-at org-babel-result-regexp)
  1592. (save-excursion (forward-line 1) (org-babel-read-result))))))
  1593. (defun org-babel-read-table ()
  1594. "Read the table at `point' into emacs-lisp."
  1595. (mapcar (lambda (row)
  1596. (if (and (symbolp row) (equal row 'hline)) row
  1597. (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval)) row)))
  1598. (org-table-to-lisp)))
  1599. (defun org-babel-read-list ()
  1600. "Read the list at `point' into emacs-lisp."
  1601. (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval))
  1602. (mapcar #'cadr (cdr (org-list-parse-list)))))
  1603. (defvar org-link-types-re)
  1604. (defun org-babel-read-link ()
  1605. "Read the link at `point' into emacs-lisp.
  1606. If the path of the link is a file path it is expanded using
  1607. `expand-file-name'."
  1608. (let* ((case-fold-search t)
  1609. (raw (and (looking-at org-bracket-link-regexp)
  1610. (org-babel-clean-text-properties (match-string 1))))
  1611. (type (and (string-match org-link-types-re raw)
  1612. (match-string 1 raw))))
  1613. (cond
  1614. ((not type) (expand-file-name raw))
  1615. ((string= type "file")
  1616. (and (string-match "file\\(.*\\):\\(.+\\)" raw)
  1617. (expand-file-name (match-string 2 raw))))
  1618. (t raw))))
  1619. (defun org-babel-format-result (result &optional sep)
  1620. "Format RESULT for writing to file."
  1621. (flet ((echo-res (result)
  1622. (if (stringp result) result (format "%S" result))))
  1623. (if (listp result)
  1624. ;; table result
  1625. (orgtbl-to-generic
  1626. result
  1627. (list
  1628. :sep (or sep "\t")
  1629. :fmt 'echo-res))
  1630. ;; scalar result
  1631. (echo-res result))))
  1632. (defun org-babel-insert-result
  1633. (result &optional result-params info hash indent lang)
  1634. "Insert RESULT into the current buffer.
  1635. By default RESULT is inserted after the end of the
  1636. current source block. With optional argument RESULT-PARAMS
  1637. controls insertion of results in the org-mode file.
  1638. RESULT-PARAMS can take the following values...
  1639. replace - (default option) insert results after the source block
  1640. replacing any previously inserted results
  1641. silent -- no results are inserted
  1642. file ---- the results are interpreted as a file path, and are
  1643. inserted into the buffer using the Org-mode file syntax
  1644. list ---- the results are interpreted as an Org-mode list.
  1645. raw ----- results are added directly to the Org-mode file. This
  1646. is a good option if you code block will output org-mode
  1647. formatted text.
  1648. wrap ---- results are added directly to the Org-mode file as with
  1649. \"raw\", but are wrapped in a RESULTS drawer, allowing
  1650. them to later be replaced or removed automatically.
  1651. org ----- similar in effect to raw, only the results are wrapped
  1652. in an org code block. Similar to the raw option, on
  1653. export the results will be interpreted as org-formatted
  1654. text, however by wrapping the results in an org code
  1655. block they can be replaced upon re-execution of the
  1656. code block.
  1657. html ---- results are added inside of a #+BEGIN_HTML block. This
  1658. is a good option if you code block will output html
  1659. formatted text.
  1660. latex --- results are added inside of a #+BEGIN_LATEX block.
  1661. This is a good option if you code block will output
  1662. latex formatted text.
  1663. code ---- the results are extracted in the syntax of the source
  1664. code of the language being evaluated and are added
  1665. inside of a #+BEGIN_SRC block with the source-code
  1666. language set appropriately. Note this relies on the
  1667. optional LANG argument."
  1668. (if (stringp result)
  1669. (progn
  1670. (setq result (org-babel-clean-text-properties result))
  1671. (when (member "file" result-params)
  1672. (setq result (org-babel-result-to-file result))))
  1673. (unless (listp result) (setq result (format "%S" result))))
  1674. (if (and result-params (member "silent" result-params))
  1675. (progn
  1676. (message (replace-regexp-in-string "%" "%%" (format "%S" result)))
  1677. result)
  1678. (save-excursion
  1679. (let* ((inlinep
  1680. (save-excursion
  1681. (when (or (org-babel-get-inline-src-block-matches)
  1682. (org-babel-get-lob-one-liner-matches))
  1683. (goto-char (match-end 0))
  1684. (insert (if (listp result) "\n" " "))
  1685. (point))))
  1686. (existing-result (unless inlinep
  1687. (org-babel-where-is-src-block-result
  1688. t info hash indent)))
  1689. (results-switches
  1690. (cdr (assoc :results_switches (nth 2 info))))
  1691. beg end)
  1692. (when (and (stringp result) ; ensure results end in a newline
  1693. (not inlinep)
  1694. (> (length result) 0)
  1695. (not (or (string-equal (substring result -1) "\n")
  1696. (string-equal (substring result -1) "\r"))))
  1697. (setq result (concat result "\n")))
  1698. (if (not existing-result)
  1699. (setq beg (or inlinep (point)))
  1700. (goto-char existing-result)
  1701. (save-excursion
  1702. (re-search-forward "#" nil t)
  1703. (setq indent (- (current-column) 1)))
  1704. (forward-line 1)
  1705. (setq beg (point))
  1706. (cond
  1707. ((member "replace" result-params)
  1708. (delete-region (point) (org-babel-result-end)))
  1709. ((member "append" result-params)
  1710. (goto-char (org-babel-result-end)) (setq beg (point-marker)))
  1711. ((member "prepend" result-params)))) ; already there
  1712. (setq results-switches
  1713. (if results-switches (concat " " results-switches) ""))
  1714. (flet ((wrap (start finish)
  1715. (goto-char beg) (insert (concat start "\n"))
  1716. (goto-char end) (insert (concat finish "\n"))
  1717. (setq end (point-marker)))
  1718. (proper-list-p (it) (and (listp it) (null (cdr (last it))))))
  1719. ;; insert results based on type
  1720. (cond
  1721. ;; do nothing for an empty result
  1722. ((null result))
  1723. ;; insert a list if preferred
  1724. ((member "list" result-params)
  1725. (insert
  1726. (org-babel-trim
  1727. (org-list-to-generic
  1728. (cons 'unordered
  1729. (mapcar
  1730. (lambda (el) (list nil (if (stringp el) el (format "%S" el))))
  1731. (if (listp result) result (list result))))
  1732. '(:splicep nil :istart "- " :iend "\n")))
  1733. "\n"))
  1734. ;; assume the result is a table if it's not a string
  1735. ((proper-list-p result)
  1736. (goto-char beg)
  1737. (insert (concat (orgtbl-to-orgtbl
  1738. (if (or (eq 'hline (car result))
  1739. (and (listp (car result))
  1740. (listp (cdr (car result)))))
  1741. result (list result))
  1742. '(:fmt (lambda (cell) (format "%s" cell)))) "\n"))
  1743. (goto-char beg) (when (org-at-table-p) (org-table-align)))
  1744. ((and (listp result) (not (proper-list-p result)))
  1745. (insert (format "%s\n" result)))
  1746. ((member "file" result-params)
  1747. (when inlinep (goto-char inlinep))
  1748. (insert result))
  1749. (t (goto-char beg) (insert result)))
  1750. (when (proper-list-p result) (goto-char (org-table-end)))
  1751. (setq end (point-marker))
  1752. ;; possibly wrap result
  1753. (cond
  1754. ((assoc :wrap (nth 2 info))
  1755. (let ((name (or (cdr (assoc :wrap (nth 2 info))) "RESULTS")))
  1756. (wrap (concat "#+BEGIN_" name) (concat "#+END_" name))))
  1757. ((member "html" result-params)
  1758. (wrap "#+BEGIN_HTML" "#+END_HTML"))
  1759. ((member "latex" result-params)
  1760. (wrap "#+BEGIN_LaTeX" "#+END_LaTeX"))
  1761. ((member "code" result-params)
  1762. (wrap (format "#+BEGIN_SRC %s%s" (or lang "none") results-switches)
  1763. "#+END_SRC"))
  1764. ((member "org" result-params)
  1765. (wrap "#+BEGIN_ORG" "#+END_ORG"))
  1766. ((member "raw" result-params)
  1767. (goto-char beg) (if (org-at-table-p) (org-cycle)))
  1768. ((member "wrap" result-params)
  1769. (wrap ":RESULTS:" ":END:"))
  1770. ((and (not (proper-list-p result))
  1771. (not (member "file" result-params)))
  1772. (org-babel-examplize-region beg end results-switches)
  1773. (setq end (point)))))
  1774. ;; possibly indent the results to match the #+results line
  1775. (when (and (not inlinep) (numberp indent) indent (> indent 0)
  1776. ;; in this case `table-align' does the work for us
  1777. (not (and (listp result)
  1778. (member "append" result-params))))
  1779. (indent-rigidly beg end indent))))
  1780. (if (null result)
  1781. (if (member "value" result-params)
  1782. (message "Code block returned no value.")
  1783. (message "Code block produced no output."))
  1784. (message "Code block evaluation complete."))))
  1785. (defun org-babel-remove-result (&optional info)
  1786. "Remove the result of the current source block."
  1787. (interactive)
  1788. (let ((location (org-babel-where-is-src-block-result nil info)) start)
  1789. (when location
  1790. (setq start (- location 1))
  1791. (save-excursion
  1792. (goto-char location) (forward-line 1)
  1793. (delete-region start (org-babel-result-end))))))
  1794. (defun org-babel-result-end ()
  1795. "Return the point at the end of the current set of results"
  1796. (save-excursion
  1797. (cond
  1798. ((org-at-table-p) (progn (goto-char (org-table-end)) (point)))
  1799. ((org-at-item-p) (let* ((struct (org-list-struct))
  1800. (prvs (org-list-prevs-alist struct)))
  1801. (org-list-get-list-end (point-at-bol) struct prvs)))
  1802. ((looking-at "^\\([ \t]*\\):RESULTS:")
  1803. (progn (re-search-forward (concat "^" (match-string 1) ":END:"))
  1804. (forward-char 1) (point)))
  1805. (t
  1806. (let ((case-fold-search t))
  1807. (if (looking-at (concat "[ \t]*#\\+begin_\\([^ \t\n\r]+\\)"))
  1808. (progn (re-search-forward (concat "[ \t]*#\\+end_" (match-string 1))
  1809. nil t)
  1810. (forward-char 1))
  1811. (while (looking-at "[ \t]*\\(: \\|\\[\\[\\)")
  1812. (forward-line 1))))
  1813. (point)))))
  1814. (defun org-babel-result-to-file (result)
  1815. "Convert RESULT into an `org-mode' link.
  1816. If the `default-directory' is different from the containing
  1817. file's directory then expand relative links."
  1818. (flet ((cond-exp (file)
  1819. (if (and default-directory
  1820. buffer-file-name
  1821. (not (string= (expand-file-name default-directory)
  1822. (expand-file-name
  1823. (file-name-directory buffer-file-name)))))
  1824. (expand-file-name file default-directory)
  1825. file)))
  1826. (if (stringp result)
  1827. (format "[[file:%s]]" (cond-exp result))
  1828. (when (and (listp result) (= 2 (length result))
  1829. (stringp (car result)) (stringp (cadr result)))
  1830. (format "[[file:%s][%s]]" (car result) (cadr result))))))
  1831. (defun org-babel-examplize-region (beg end &optional results-switches)
  1832. "Comment out region using the inline '==' or ': ' org example quote."
  1833. (interactive "*r")
  1834. (flet ((chars-between (b e) (string-match "[\\S]" (buffer-substring b e))))
  1835. (if (or (chars-between (save-excursion (goto-char beg) (point-at-bol)) beg)
  1836. (chars-between end (save-excursion (goto-char end) (point-at-eol))))
  1837. (save-excursion
  1838. (goto-char beg)
  1839. (insert (format "=%s=" (prog1 (buffer-substring beg end)
  1840. (delete-region beg end)))))
  1841. (let ((size (count-lines beg end)))
  1842. (save-excursion
  1843. (cond ((= size 0)) ; do nothing for an empty result
  1844. ((< size org-babel-min-lines-for-block-output)
  1845. (goto-char beg)
  1846. (dotimes (n size)
  1847. (beginning-of-line 1) (insert ": ") (forward-line 1)))
  1848. (t
  1849. (goto-char beg)
  1850. (insert (if results-switches
  1851. (format "#+begin_example%s\n" results-switches)
  1852. "#+begin_example\n"))
  1853. (if (markerp end) (goto-char end) (forward-char (- end beg)))
  1854. (insert "#+end_example\n"))))))))
  1855. (defun org-babel-update-block-body (new-body)
  1856. "Update the body of the current code block to NEW-BODY."
  1857. (if (not (org-babel-where-is-src-block-head))
  1858. (error "not in source block")
  1859. (save-match-data
  1860. (replace-match (concat (org-babel-trim new-body) "\n") nil t nil 5))
  1861. (indent-rigidly (match-beginning 5) (match-end 5) 2)))
  1862. (defun org-babel-merge-params (&rest plists)
  1863. "Combine all parameter association lists in PLISTS.
  1864. Later elements of PLISTS override the values of previous elements.
  1865. This takes into account some special considerations for certain
  1866. parameters when merging lists."
  1867. (let ((results-exclusive-groups
  1868. (mapcar (lambda (group) (mapcar #'symbol-name group))
  1869. (cdr (assoc 'results org-babel-common-header-args-w-values))))
  1870. (exports-exclusive-groups
  1871. (mapcar (lambda (group) (mapcar #'symbol-name group))
  1872. (cdr (assoc 'exports org-babel-common-header-args-w-values))))
  1873. (variable-index 0)
  1874. params results exports tangle noweb cache vars shebang comments padline)
  1875. (flet ((e-merge (exclusive-groups &rest result-params)
  1876. ;; maintain exclusivity of mutually exclusive parameters
  1877. (let (output)
  1878. (mapc (lambda (new-params)
  1879. (mapc (lambda (new-param)
  1880. (mapc (lambda (exclusive-group)
  1881. (when (member new-param exclusive-group)
  1882. (mapcar (lambda (excluded-param)
  1883. (setq output
  1884. (delete
  1885. excluded-param
  1886. output)))
  1887. exclusive-group)))
  1888. exclusive-groups)
  1889. (setq output (org-uniquify
  1890. (cons new-param output))))
  1891. new-params))
  1892. result-params)
  1893. output)))
  1894. (mapc
  1895. (lambda (plist)
  1896. (mapc
  1897. (lambda (pair)
  1898. (case (car pair)
  1899. (:var
  1900. (let ((name (if (listp (cdr pair))
  1901. (cadr pair)
  1902. (and (string-match "^\\([^= \f\t\n\r\v]+\\)[ \t]*="
  1903. (cdr pair))
  1904. (intern (match-string 1 (cdr pair)))))))
  1905. (if name
  1906. (setq vars
  1907. (append
  1908. (if (member name (mapcar #'car vars))
  1909. (delq nil
  1910. (mapcar
  1911. (lambda (p)
  1912. (unless (equal (car p) name) p))
  1913. vars))
  1914. vars)
  1915. (list (cons name pair))))
  1916. ;; if no name is given and we already have named variables
  1917. ;; then assign to named variables in order
  1918. (if (and vars (nth variable-index vars))
  1919. (prog1 (setf (cddr (nth variable-index vars))
  1920. (concat (symbol-name
  1921. (car (nth variable-index vars)))
  1922. "=" (cdr pair)))
  1923. (incf variable-index))
  1924. (error "variable \"%s\" must be assigned a default value"
  1925. (cdr pair))))))
  1926. (:results
  1927. (setq results (e-merge results-exclusive-groups
  1928. results
  1929. (split-string
  1930. (let ((r (cdr pair)))
  1931. (if (stringp r) r (eval r)))))))
  1932. (:file
  1933. (when (cdr pair)
  1934. (setq results (e-merge results-exclusive-groups
  1935. results '("file")))
  1936. (unless (or (member "both" exports)
  1937. (member "none" exports)
  1938. (member "code" exports))
  1939. (setq exports (e-merge exports-exclusive-groups
  1940. exports '("results"))))
  1941. (setq params (cons pair (assq-delete-all (car pair) params)))))
  1942. (:exports
  1943. (setq exports (e-merge exports-exclusive-groups
  1944. exports (split-string (cdr pair)))))
  1945. (:tangle ;; take the latest -- always overwrite
  1946. (setq tangle (or (list (cdr pair)) tangle)))
  1947. (:noweb
  1948. (setq noweb (e-merge
  1949. '(("yes" "no" "tangle" "no-export" "strip-export"))
  1950. noweb
  1951. (split-string (or (cdr pair) "")))))
  1952. (:cache
  1953. (setq cache (e-merge '(("yes" "no")) cache
  1954. (split-string (or (cdr pair) "")))))
  1955. (:padline
  1956. (setq padline (e-merge '(("yes" "no")) padline
  1957. (split-string (or (cdr pair) "")))))
  1958. (:shebang ;; take the latest -- always overwrite
  1959. (setq shebang (or (list (cdr pair)) shebang)))
  1960. (:comments
  1961. (setq comments (e-merge '(("yes" "no")) comments
  1962. (split-string (or (cdr pair) "")))))
  1963. (t ;; replace: this covers e.g. :session
  1964. (setq params (cons pair (assq-delete-all (car pair) params))))))
  1965. plist))
  1966. plists))
  1967. (setq vars (reverse vars))
  1968. (while vars (setq params (cons (cons :var (cddr (pop vars))) params)))
  1969. (mapc
  1970. (lambda (hd)
  1971. (let ((key (intern (concat ":" (symbol-name hd))))
  1972. (val (eval hd)))
  1973. (setf params (cons (cons key (mapconcat 'identity val " ")) params))))
  1974. '(results exports tangle noweb padline cache shebang comments))
  1975. params))
  1976. (defvar *org-babel-use-quick-and-dirty-noweb-expansion* nil
  1977. "Set to true to use regular expressions to expand noweb references.
  1978. This results in much faster noweb reference expansion but does
  1979. not properly allow code blocks to inherit the \":noweb-ref\"
  1980. header argument from buffer or subtree wide properties.")
  1981. (defun org-babel-noweb-p (params context)
  1982. "Check if PARAMS require expansion in CONTEXT.
  1983. CONTEXT may be one of :tangle, :export or :eval."
  1984. (flet ((intersect (as bs)
  1985. (when as
  1986. (if (member (car as) bs)
  1987. (car as)
  1988. (intersect (cdr as) bs)))))
  1989. (intersect (case context
  1990. (:tangle '("yes" "tangle" "no-export" "strip-export"))
  1991. (:eval '("yes" "no-export" "strip-export"))
  1992. (:export '("yes")))
  1993. (split-string (or (cdr (assoc :noweb params)) "")))))
  1994. (defun org-babel-expand-noweb-references (&optional info parent-buffer)
  1995. "Expand Noweb references in the body of the current source code block.
  1996. For example the following reference would be replaced with the
  1997. body of the source-code block named 'example-block'.
  1998. <<example-block>>
  1999. Note that any text preceding the <<foo>> construct on a line will
  2000. be interposed between the lines of the replacement text. So for
  2001. example if <<foo>> is placed behind a comment, then the entire
  2002. replacement text will also be commented.
  2003. This function must be called from inside of the buffer containing
  2004. the source-code block which holds BODY.
  2005. In addition the following syntax can be used to insert the
  2006. results of evaluating the source-code block named 'example-block'.
  2007. <<example-block()>>
  2008. Any optional arguments can be passed to example-block by placing
  2009. the arguments inside the parenthesis following the convention
  2010. defined by `org-babel-lob'. For example
  2011. <<example-block(a=9)>>
  2012. would set the value of argument \"a\" equal to \"9\". Note that
  2013. these arguments are not evaluated in the current source-code
  2014. block but are passed literally to the \"example-block\"."
  2015. (let* ((parent-buffer (or parent-buffer (current-buffer)))
  2016. (info (or info (org-babel-get-src-block-info)))
  2017. (lang (nth 0 info))
  2018. (body (nth 1 info))
  2019. (comment (string= "noweb" (cdr (assoc :comments (nth 2 info)))))
  2020. (rx-prefix (concat "\\(" org-babel-src-name-regexp "\\|"
  2021. ":noweb-ref[ \t]+" "\\)"))
  2022. (new-body "") index source-name evaluate prefix blocks-in-buffer)
  2023. (flet ((nb-add (text) (setq new-body (concat new-body text)))
  2024. (c-wrap (text)
  2025. (with-temp-buffer
  2026. (funcall (intern (concat lang "-mode")))
  2027. (comment-region (point) (progn (insert text) (point)))
  2028. (org-babel-trim (buffer-string)))))
  2029. (with-temp-buffer
  2030. (insert body) (goto-char (point-min))
  2031. (setq index (point))
  2032. (while (and (re-search-forward (org-babel-noweb-wrap) nil t))
  2033. (save-match-data (setf source-name (match-string 1)))
  2034. (save-match-data (setq evaluate (string-match "\(.*\)" source-name)))
  2035. (save-match-data
  2036. (setq prefix
  2037. (buffer-substring (match-beginning 0)
  2038. (save-excursion
  2039. (beginning-of-line 1) (point)))))
  2040. ;; add interval to new-body (removing noweb reference)
  2041. (goto-char (match-beginning 0))
  2042. (nb-add (buffer-substring index (point)))
  2043. (goto-char (match-end 0))
  2044. (setq index (point))
  2045. (nb-add
  2046. (with-current-buffer parent-buffer
  2047. (mapconcat ;; interpose PREFIX between every line
  2048. #'identity
  2049. (split-string
  2050. (if evaluate
  2051. (let ((raw (org-babel-ref-resolve source-name)))
  2052. (if (stringp raw) raw (format "%S" raw)))
  2053. (or
  2054. ;; retrieve from the library of babel
  2055. (nth 2 (assoc (intern source-name)
  2056. org-babel-library-of-babel))
  2057. ;; return the contents of headlines literally
  2058. (save-excursion
  2059. (when (org-babel-ref-goto-headline-id source-name)
  2060. (org-babel-ref-headline-body)))
  2061. ;; find the expansion of reference in this buffer
  2062. (let ((rx (concat rx-prefix source-name))
  2063. expansion)
  2064. (save-excursion
  2065. (goto-char (point-min))
  2066. (if *org-babel-use-quick-and-dirty-noweb-expansion*
  2067. (while (re-search-forward rx nil t)
  2068. (let* ((i (org-babel-get-src-block-info 'light))
  2069. (body (org-babel-expand-noweb-references i))
  2070. (sep (or (cdr (assoc :noweb-sep (nth 2 i)))
  2071. "\n"))
  2072. (full (if comment
  2073. ((lambda (cs)
  2074. (concat (c-wrap (car cs)) "\n"
  2075. body "\n"
  2076. (c-wrap (cadr cs))))
  2077. (org-babel-tangle-comment-links i))
  2078. body)))
  2079. (setq expansion (cons sep (cons full expansion)))))
  2080. (org-babel-map-src-blocks nil
  2081. (let ((i (org-babel-get-src-block-info 'light)))
  2082. (when (equal (or (cdr (assoc :noweb-ref (nth 2 i)))
  2083. (nth 4 i))
  2084. source-name)
  2085. (let* ((body (org-babel-expand-noweb-references i))
  2086. (sep (or (cdr (assoc :noweb-sep (nth 2 i)))
  2087. "\n"))
  2088. (full (if comment
  2089. ((lambda (cs)
  2090. (concat (c-wrap (car cs)) "\n"
  2091. body "\n"
  2092. (c-wrap (cadr cs))))
  2093. (org-babel-tangle-comment-links i))
  2094. body)))
  2095. (setq expansion
  2096. (cons sep (cons full expansion)))))))))
  2097. (and expansion
  2098. (mapconcat #'identity (nreverse (cdr expansion)) "")))
  2099. ;; possibly raise an error if named block doesn't exist
  2100. (if (member lang org-babel-noweb-error-langs)
  2101. (error "%s" (concat
  2102. (org-babel-noweb-wrap source-name)
  2103. "could not be resolved (see "
  2104. "`org-babel-noweb-error-langs')"))
  2105. "")))
  2106. "[\n\r]") (concat "\n" prefix)))))
  2107. (nb-add (buffer-substring index (point-max)))))
  2108. new-body))
  2109. (defun org-babel-clean-text-properties (text)
  2110. "Strip all properties from text return."
  2111. (when text
  2112. (set-text-properties 0 (length text) nil text) text))
  2113. (defun org-babel-strip-protective-commas (body)
  2114. "Strip protective commas from bodies of source blocks."
  2115. (when body
  2116. (replace-regexp-in-string "^,#" "#" body)))
  2117. (defun org-babel-script-escape (str &optional force)
  2118. "Safely convert tables into elisp lists."
  2119. (let (in-single in-double out)
  2120. ((lambda (escaped) (condition-case nil (org-babel-read escaped) (error escaped)))
  2121. (if (or force
  2122. (and (stringp str)
  2123. (> (length str) 2)
  2124. (or (and (string-equal "[" (substring str 0 1))
  2125. (string-equal "]" (substring str -1)))
  2126. (and (string-equal "{" (substring str 0 1))
  2127. (string-equal "}" (substring str -1)))
  2128. (and (string-equal "(" (substring str 0 1))
  2129. (string-equal ")" (substring str -1))))))
  2130. (org-babel-read
  2131. (concat
  2132. "'"
  2133. (progn
  2134. (mapc
  2135. (lambda (ch)
  2136. (setq
  2137. out
  2138. (case ch
  2139. (91 (if (or in-double in-single) ; [
  2140. (cons 91 out)
  2141. (cons 40 out)))
  2142. (93 (if (or in-double in-single) ; ]
  2143. (cons 93 out)
  2144. (cons 41 out)))
  2145. (123 (if (or in-double in-single) ; {
  2146. (cons 123 out)
  2147. (cons 40 out)))
  2148. (125 (if (or in-double in-single) ; }
  2149. (cons 125 out)
  2150. (cons 41 out)))
  2151. (44 (if (or in-double in-single) ; ,
  2152. (cons 44 out) (cons 32 out)))
  2153. (39 (if in-double ; '
  2154. (cons 39 out)
  2155. (setq in-single (not in-single)) (cons 34 out)))
  2156. (34 (if in-single ; "
  2157. (append (list 34 32) out)
  2158. (setq in-double (not in-double)) (cons 34 out)))
  2159. (t (cons ch out)))))
  2160. (string-to-list str))
  2161. (apply #'string (reverse out)))))
  2162. str))))
  2163. (defun org-babel-read (cell &optional inhibit-lisp-eval)
  2164. "Convert the string value of CELL to a number if appropriate.
  2165. Otherwise if cell looks like lisp (meaning it starts with a
  2166. \"(\", \"'\", \"`\" or a \"[\") then read it as lisp, otherwise
  2167. return it unmodified as a string. Optional argument NO-LISP-EVAL
  2168. inhibits lisp evaluation for situations in which is it not
  2169. appropriate."
  2170. (if (and (stringp cell) (not (equal cell "")))
  2171. (or (org-babel-number-p cell)
  2172. (if (and (not inhibit-lisp-eval)
  2173. (member (substring cell 0 1) '("(" "'" "`" "[")))
  2174. (eval (read cell))
  2175. (if (string= (substring cell 0 1) "\"")
  2176. (read cell)
  2177. (progn (set-text-properties 0 (length cell) nil cell) cell))))
  2178. cell))
  2179. (defun org-babel-number-p (string)
  2180. "If STRING represents a number return its value."
  2181. (if (and (string-match "^-?[0-9]*\\.?[0-9]*$" string)
  2182. (= (length (substring string (match-beginning 0)
  2183. (match-end 0)))
  2184. (length string)))
  2185. (string-to-number string)))
  2186. (defun org-babel-import-elisp-from-file (file-name &optional separator)
  2187. "Read the results located at FILE-NAME into an elisp table.
  2188. If the table is trivial, then return it as a scalar."
  2189. (let (result)
  2190. (save-window-excursion
  2191. (with-temp-buffer
  2192. (condition-case nil
  2193. (progn
  2194. (org-table-import file-name separator)
  2195. (delete-file file-name)
  2196. (setq result (mapcar (lambda (row)
  2197. (mapcar #'org-babel-string-read row))
  2198. (org-table-to-lisp))))
  2199. (error nil)))
  2200. (if (null (cdr result)) ;; if result is trivial vector, then scalarize it
  2201. (if (consp (car result))
  2202. (if (null (cdr (car result)))
  2203. (caar result)
  2204. result)
  2205. (car result))
  2206. result))))
  2207. (defun org-babel-string-read (cell)
  2208. "Strip nested \"s from around strings."
  2209. (org-babel-read (or (and (stringp cell)
  2210. (string-match "\\\"\\(.+\\)\\\"" cell)
  2211. (match-string 1 cell))
  2212. cell)))
  2213. (defun org-babel-reverse-string (string)
  2214. "Return the reverse of STRING."
  2215. (apply 'string (reverse (string-to-list string))))
  2216. (defun org-babel-chomp (string &optional regexp)
  2217. "Strip trailing spaces and carriage returns from STRING.
  2218. Default regexp used is \"[ \f\t\n\r\v]\" but can be
  2219. overwritten by specifying a regexp as a second argument."
  2220. (let ((regexp (or regexp "[ \f\t\n\r\v]")))
  2221. (while (and (> (length string) 0)
  2222. (string-match regexp (substring string -1)))
  2223. (setq string (substring string 0 -1)))
  2224. string))
  2225. (defun org-babel-trim (string &optional regexp)
  2226. "Strip leading and trailing spaces and carriage returns from STRING.
  2227. Like `org-babel-chomp' only it runs on both the front and back
  2228. of the string."
  2229. (org-babel-chomp (org-babel-reverse-string
  2230. (org-babel-chomp (org-babel-reverse-string string) regexp))
  2231. regexp))
  2232. (defvar org-babel-org-babel-call-process-region-original nil)
  2233. (defun org-babel-tramp-handle-call-process-region
  2234. (start end program &optional delete buffer display &rest args)
  2235. "Use tramp to handle call-process-region.
  2236. Fixes a bug in `tramp-handle-call-process-region'."
  2237. (if (and (featurep 'tramp) (file-remote-p default-directory))
  2238. (let ((tmpfile (tramp-compat-make-temp-file "")))
  2239. (write-region start end tmpfile)
  2240. (when delete (delete-region start end))
  2241. (unwind-protect
  2242. ;; (apply 'call-process program tmpfile buffer display args)
  2243. ;; bug in tramp
  2244. (apply 'process-file program tmpfile buffer display args)
  2245. (delete-file tmpfile)))
  2246. ;; org-babel-call-process-region-original is the original emacs
  2247. ;; definition. It is in scope from the let binding in
  2248. ;; org-babel-execute-src-block
  2249. (apply org-babel-call-process-region-original
  2250. start end program delete buffer display args)))
  2251. (defun org-babel-local-file-name (file)
  2252. "Return the local name component of FILE."
  2253. (if (file-remote-p file)
  2254. (let (localname)
  2255. (with-parsed-tramp-file-name file nil
  2256. localname))
  2257. file))
  2258. (defun org-babel-process-file-name (name &optional no-quote-p)
  2259. "Prepare NAME to be used in an external process.
  2260. If NAME specifies a remote location, the remote portion of the
  2261. name is removed, since in that case the process will be executing
  2262. remotely. The file name is then processed by
  2263. `expand-file-name'. Unless second argument NO-QUOTE-P is non-nil,
  2264. the file name is additionally processed by
  2265. `shell-quote-argument'"
  2266. ((lambda (f) (if no-quote-p f (shell-quote-argument f)))
  2267. (expand-file-name (org-babel-local-file-name name))))
  2268. (defvar org-babel-temporary-directory)
  2269. (unless (or noninteractive (boundp 'org-babel-temporary-directory))
  2270. (defvar org-babel-temporary-directory
  2271. (or (and (boundp 'org-babel-temporary-directory)
  2272. (file-exists-p org-babel-temporary-directory)
  2273. org-babel-temporary-directory)
  2274. (make-temp-file "babel-" t))
  2275. "Directory to hold temporary files created to execute code blocks.
  2276. Used by `org-babel-temp-file'. This directory will be removed on
  2277. Emacs shutdown."))
  2278. (defun org-babel-temp-file (prefix &optional suffix)
  2279. "Create a temporary file in the `org-babel-temporary-directory'.
  2280. Passes PREFIX and SUFFIX directly to `make-temp-file' with the
  2281. value of `temporary-file-directory' temporarily set to the value
  2282. of `org-babel-temporary-directory'."
  2283. (if (file-remote-p default-directory)
  2284. (make-temp-file
  2285. (concat (file-remote-p default-directory)
  2286. (expand-file-name
  2287. prefix temporary-file-directory)
  2288. nil suffix))
  2289. (let ((temporary-file-directory
  2290. (or (and (boundp 'org-babel-temporary-directory)
  2291. (file-exists-p org-babel-temporary-directory)
  2292. org-babel-temporary-directory)
  2293. temporary-file-directory)))
  2294. (make-temp-file prefix nil suffix))))
  2295. (defun org-babel-remove-temporary-directory ()
  2296. "Remove `org-babel-temporary-directory' on Emacs shutdown."
  2297. (when (and (boundp 'org-babel-temporary-directory)
  2298. (file-exists-p org-babel-temporary-directory))
  2299. ;; taken from `delete-directory' in files.el
  2300. (condition-case nil
  2301. (progn
  2302. (mapc (lambda (file)
  2303. ;; This test is equivalent to
  2304. ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
  2305. ;; but more efficient
  2306. (if (eq t (car (file-attributes file)))
  2307. (delete-directory file)
  2308. (delete-file file)))
  2309. ;; We do not want to delete "." and "..".
  2310. (directory-files org-babel-temporary-directory 'full
  2311. "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
  2312. (delete-directory org-babel-temporary-directory))
  2313. (error
  2314. (message "Failed to remove temporary Org-babel directory %s"
  2315. (if (boundp 'org-babel-temporary-directory)
  2316. org-babel-temporary-directory
  2317. "[directory not defined]"))))))
  2318. (add-hook 'kill-emacs-hook 'org-babel-remove-temporary-directory)
  2319. (provide 'ob)
  2320. ;;; ob.el ends here