ob.el 88 KB

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