ob-core.el 118 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155
  1. ;;; ob-core.el --- Working with Code Blocks -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2009-2018 Free Software Foundation, Inc.
  3. ;; Authors: Eric Schulte
  4. ;; Dan Davison
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: https://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 <https://www.gnu.org/licenses/>.
  18. ;;; Code:
  19. (require 'cl-lib)
  20. (require 'ob-eval)
  21. (require 'org-macs)
  22. (require 'org-compat)
  23. (defconst org-babel-exeext
  24. (if (memq system-type '(windows-nt cygwin))
  25. ".exe"
  26. nil))
  27. (defvar org-babel-library-of-babel)
  28. (defvar org-edit-src-content-indentation)
  29. (defvar org-src-lang-modes)
  30. (defvar org-src-preserve-indentation)
  31. (declare-function org-at-item-p "org-list" ())
  32. (declare-function org-at-table-p "org" (&optional table-type))
  33. (declare-function org-babel-lob-execute-maybe "ob-lob" ())
  34. (declare-function org-babel-ref-goto-headline-id "ob-ref" (id))
  35. (declare-function org-babel-ref-headline-body "ob-ref" ())
  36. (declare-function org-babel-ref-parse "ob-ref" (assignment))
  37. (declare-function org-babel-ref-resolve "ob-ref" (ref))
  38. (declare-function org-babel-ref-split-args "ob-ref" (arg-string))
  39. (declare-function org-babel-tangle-comment-links "ob-tangle" (&optional info))
  40. (declare-function org-completing-read "org" (&rest args))
  41. (declare-function org-current-level "org" ())
  42. (declare-function org-cycle "org" (&optional arg))
  43. (declare-function org-do-remove-indentation "org" (&optional n))
  44. (declare-function org-edit-src-code "org-src" (&optional code edit-buffer-name))
  45. (declare-function org-edit-src-exit "org-src" ())
  46. (declare-function org-element-at-point "org-element" ())
  47. (declare-function org-element-context "org-element" (&optional element))
  48. (declare-function org-element-normalize-string "org-element" (s))
  49. (declare-function org-element-property "org-element" (property element))
  50. (declare-function org-element-type "org-element" (element))
  51. (declare-function org-entry-get "org" (pom property &optional inherit literal-nil))
  52. (declare-function org-escape-code-in-region "org-src" (beg end))
  53. (declare-function org-get-indentation "org" (&optional line))
  54. (declare-function org-get-indentation "org" (&optional line))
  55. (declare-function org-in-regexp "org" (regexp &optional nlines visually))
  56. (declare-function org-indent-line "org" ())
  57. (declare-function org-list-get-list-end "org-list" (item struct prevs))
  58. (declare-function org-list-prevs-alist "org-list" (struct))
  59. (declare-function org-list-struct "org-list" ())
  60. (declare-function org-list-to-generic "org-list" (LIST PARAMS))
  61. (declare-function org-list-to-lisp "org-list" (&optional delete))
  62. (declare-function org-macro-escape-arguments "org-macro" (&rest args))
  63. (declare-function org-make-options-regexp "org" (kwds &optional extra))
  64. (declare-function org-mark-ring-push "org" (&optional pos buffer))
  65. (declare-function org-narrow-to-subtree "org" ())
  66. (declare-function org-next-block "org" (arg &optional backward block-regexp))
  67. (declare-function org-open-at-point "org" (&optional in-emacs reference-buffer))
  68. (declare-function org-previous-block "org" (arg &optional block-regexp))
  69. (declare-function org-remove-indentation "org" (code &optional n))
  70. (declare-function org-reverse-string "org" (string))
  71. (declare-function org-set-outline-overlay-data "org" (data))
  72. (declare-function org-show-context "org" (&optional key))
  73. (declare-function org-src-coderef-format "org-src" (&optional element))
  74. (declare-function org-src-coderef-regexp "org-src" (fmt &optional label))
  75. (declare-function org-table-align "org-table" ())
  76. (declare-function org-table-end "org-table" (&optional table-type))
  77. (declare-function org-table-import "org-table" (file arg))
  78. (declare-function org-table-to-lisp "org-table" (&optional txt))
  79. (declare-function org-trim "org" (s &optional keep-lead))
  80. (declare-function org-unescape-code-in-string "org-src" (s))
  81. (declare-function org-uniquify "org" (list))
  82. (declare-function orgtbl-to-generic "org-table" (table params))
  83. (declare-function orgtbl-to-orgtbl "org-table" (table params))
  84. (declare-function tramp-compat-make-temp-file "tramp-compat" (filename &optional dir-flag))
  85. (defgroup org-babel nil
  86. "Code block evaluation and management in `org-mode' documents."
  87. :tag "Babel"
  88. :group 'org)
  89. (defcustom org-confirm-babel-evaluate t
  90. "Confirm before evaluation.
  91. \\<org-mode-map>\
  92. Require confirmation before interactively evaluating code
  93. blocks in Org buffers. The default value of this variable is t,
  94. meaning confirmation is required for any code block evaluation.
  95. This variable can be set to nil to inhibit any future
  96. confirmation requests. This variable can also be set to a
  97. function which takes two arguments the language of the code block
  98. and the body of the code block. Such a function should then
  99. return a non-nil value if the user should be prompted for
  100. execution or nil if no prompt is required.
  101. Warning: Disabling confirmation may result in accidental
  102. evaluation of potentially harmful code. It may be advisable
  103. remove code block execution from `\\[org-ctrl-c-ctrl-c]' \
  104. as further protection
  105. against accidental code block evaluation. The
  106. `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
  107. remove code block execution from the `\\[org-ctrl-c-ctrl-c]' keybinding."
  108. :group 'org-babel
  109. :version "24.1"
  110. :type '(choice boolean function))
  111. ;; don't allow this variable to be changed through file settings
  112. (put 'org-confirm-babel-evaluate 'safe-local-variable (lambda (x) (eq x t)))
  113. (defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
  114. "\\<org-mode-map>\
  115. Remove code block evaluation from the `\\[org-ctrl-c-ctrl-c]' key binding."
  116. :group 'org-babel
  117. :version "24.1"
  118. :type 'boolean)
  119. (defcustom org-babel-results-keyword "RESULTS"
  120. "Keyword used to name results generated by code blocks.
  121. It should be \"RESULTS\". However any capitalization may be
  122. used."
  123. :group 'org-babel
  124. :version "24.4"
  125. :package-version '(Org . "8.0")
  126. :type 'string
  127. :safe (lambda (v)
  128. (and (stringp v)
  129. (eq (compare-strings "RESULTS" nil nil v nil nil t)
  130. t))))
  131. (defcustom org-babel-noweb-wrap-start "<<"
  132. "String used to begin a noweb reference in a code block.
  133. See also `org-babel-noweb-wrap-end'."
  134. :group 'org-babel
  135. :type 'string)
  136. (defcustom org-babel-noweb-wrap-end ">>"
  137. "String used to end a noweb reference in a code block.
  138. See also `org-babel-noweb-wrap-start'."
  139. :group 'org-babel
  140. :type 'string)
  141. (defcustom org-babel-inline-result-wrap "=%s="
  142. "Format string used to wrap inline results.
  143. This string must include a \"%s\" which will be replaced by the results."
  144. :group 'org-babel
  145. :type 'string)
  146. (put 'org-babel-inline-result-wrap
  147. 'safe-local-variable
  148. (lambda (value)
  149. (and (stringp value)
  150. (string-match-p "%s" value))))
  151. (defcustom org-babel-hash-show-time nil
  152. "Non-nil means show the time the code block was evaluated in the result hash."
  153. :group 'org-babel
  154. :type 'boolean
  155. :version "26.1"
  156. :package-version '(Org . "9.0")
  157. :safe #'booleanp)
  158. (defcustom org-babel-uppercase-example-markers nil
  159. "When non-nil, begin/end example markers will be inserted in upper case."
  160. :group 'org-babel
  161. :type 'boolean
  162. :version "26.1"
  163. :package-version '(Org . "9.1")
  164. :safe #'booleanp)
  165. (defun org-babel-noweb-wrap (&optional regexp)
  166. (concat org-babel-noweb-wrap-start
  167. (or regexp "\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)")
  168. org-babel-noweb-wrap-end))
  169. (defvar org-babel-src-name-regexp
  170. "^[ \t]*#\\+name:[ \t]*"
  171. "Regular expression used to match a source name line.")
  172. (defvar org-babel-multi-line-header-regexp
  173. "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
  174. "Regular expression used to match multi-line header arguments.")
  175. (defvar org-babel-src-block-regexp
  176. (concat
  177. ;; (1) indentation (2) lang
  178. "^\\([ \t]*\\)#\\+begin_src[ \t]+\\([^ \f\t\n\r\v]+\\)[ \t]*"
  179. ;; (3) switches
  180. "\\([^\":\n]*\"[^\"\n*]*\"[^\":\n]*\\|[^\":\n]*\\)"
  181. ;; (4) header arguments
  182. "\\([^\n]*\\)\n"
  183. ;; (5) body
  184. "\\([^\000]*?\n\\)??[ \t]*#\\+end_src")
  185. "Regexp used to identify code blocks.")
  186. (defun org-babel--get-vars (params)
  187. "Return the babel variable assignments in PARAMS.
  188. PARAMS is a quasi-alist of header args, which may contain
  189. multiple entries for the key `:var'. This function returns a
  190. list of the cdr of all the `:var' entries."
  191. (mapcar #'cdr
  192. (cl-remove-if-not (lambda (x) (eq (car x) :var)) params)))
  193. (defvar org-babel-exp-reference-buffer nil
  194. "Buffer containing original contents of the exported buffer.
  195. This is used by Babel to resolve references in source blocks.
  196. Its value is dynamically bound during export.")
  197. (defun org-babel-check-confirm-evaluate (info)
  198. "Check whether INFO allows code block evaluation.
  199. Returns nil if evaluation is disallowed, t if it is
  200. unconditionally allowed, and the symbol `query' if the user
  201. should be asked whether to allow evaluation."
  202. (let* ((headers (nth 2 info))
  203. (eval (or (cdr (assq :eval headers))
  204. (when (assq :noeval headers) "no")))
  205. (eval-no (member eval '("no" "never")))
  206. (export org-babel-exp-reference-buffer)
  207. (eval-no-export (and export (member eval '("no-export" "never-export"))))
  208. (noeval (or eval-no eval-no-export))
  209. (query (or (equal eval "query")
  210. (and export (equal eval "query-export"))
  211. (if (functionp org-confirm-babel-evaluate)
  212. (funcall org-confirm-babel-evaluate
  213. ;; Language, code block body.
  214. (nth 0 info) (nth 1 info))
  215. org-confirm-babel-evaluate))))
  216. (cond
  217. (noeval nil)
  218. (query 'query)
  219. (t t))))
  220. (defun org-babel-check-evaluate (info)
  221. "Check if code block INFO should be evaluated.
  222. Do not query the user, but do display an informative message if
  223. evaluation is blocked. Returns non-nil if evaluation is not blocked."
  224. (let ((confirmed (org-babel-check-confirm-evaluate info)))
  225. (unless confirmed
  226. (message "Evaluation of this %s code block%sis disabled."
  227. (nth 0 info)
  228. (let ((name (nth 4 info)))
  229. (if name (format " (%s) " name) " "))))
  230. confirmed))
  231. ;; Dynamically scoped for asynchronous export.
  232. (defvar org-babel-confirm-evaluate-answer-no)
  233. (defun org-babel-confirm-evaluate (info)
  234. "Confirm evaluation of the code block INFO.
  235. This query can also be suppressed by setting the value of
  236. `org-confirm-babel-evaluate' to nil, in which case all future
  237. interactive code block evaluations will proceed without any
  238. confirmation from the user.
  239. Note disabling confirmation may result in accidental evaluation
  240. of potentially harmful code.
  241. The variable `org-babel-confirm-evaluate-answer-no' is used by
  242. the async export process, which requires a non-interactive
  243. environment, to override this check."
  244. (let* ((evalp (org-babel-check-confirm-evaluate info))
  245. (lang (nth 0 info))
  246. (name (nth 4 info))
  247. (name-string (if name (format " (%s) " name) " ")))
  248. (pcase evalp
  249. (`nil nil)
  250. (`t t)
  251. (`query (or
  252. (and (not (bound-and-true-p
  253. org-babel-confirm-evaluate-answer-no))
  254. (yes-or-no-p
  255. (format "Evaluate this %s code block%son your system? "
  256. lang name-string)))
  257. (progn
  258. (message "Evaluation of this %s code block%sis aborted."
  259. lang name-string)
  260. nil)))
  261. (x (error "Unexpected value `%s' from `org-babel-check-confirm-evaluate'" x)))))
  262. ;;;###autoload
  263. (defun org-babel-execute-safely-maybe ()
  264. (unless org-babel-no-eval-on-ctrl-c-ctrl-c
  265. (org-babel-execute-maybe)))
  266. ;;;###autoload
  267. (defun org-babel-execute-maybe ()
  268. (interactive)
  269. (or (org-babel-execute-src-block-maybe)
  270. (org-babel-lob-execute-maybe)))
  271. (defmacro org-babel-when-in-src-block (&rest body)
  272. "Execute BODY if point is in a source block and return t.
  273. Otherwise do nothing and return nil."
  274. `(if (memq (org-element-type (org-element-context))
  275. '(inline-src-block src-block))
  276. (progn
  277. ,@body
  278. t)
  279. nil))
  280. (defun org-babel-execute-src-block-maybe ()
  281. "Conditionally execute a source block.
  282. Detect if this is context for a Babel src-block and if so
  283. then run `org-babel-execute-src-block'."
  284. (interactive)
  285. (org-babel-when-in-src-block
  286. (org-babel-eval-wipe-error-buffer)
  287. (org-babel-execute-src-block current-prefix-arg)))
  288. ;;;###autoload
  289. (defun org-babel-view-src-block-info ()
  290. "Display information on the current source block.
  291. This includes header arguments, language and name, and is largely
  292. a window into the `org-babel-get-src-block-info' function."
  293. (interactive)
  294. (let ((info (org-babel-get-src-block-info 'light))
  295. (full (lambda (it) (> (length it) 0)))
  296. (printf (lambda (fmt &rest args) (princ (apply #'format fmt args)))))
  297. (when info
  298. (with-help-window (help-buffer)
  299. (let ((name (nth 4 info))
  300. (lang (nth 0 info))
  301. (switches (nth 3 info))
  302. (header-args (nth 2 info)))
  303. (when name (funcall printf "Name: %s\n" name))
  304. (when lang (funcall printf "Lang: %s\n" lang))
  305. (funcall printf "Properties:\n")
  306. (funcall printf "\t:header-args \t%s\n" (org-entry-get (point) "header-args" t))
  307. (funcall printf "\t:header-args:%s \t%s\n" lang (org-entry-get (point) (concat "header-args:" lang) t))
  308. (when (funcall full switches) (funcall printf "Switches: %s\n" switches))
  309. (funcall printf "Header Arguments:\n")
  310. (dolist (pair (sort header-args
  311. (lambda (a b) (string< (symbol-name (car a))
  312. (symbol-name (car b))))))
  313. (when (funcall full (format "%s" (cdr pair)))
  314. (funcall printf "\t%S%s\t%s\n"
  315. (car pair)
  316. (if (> (length (format "%S" (car pair))) 7) "" "\t")
  317. (cdr pair)))))))))
  318. ;;;###autoload
  319. (defun org-babel-expand-src-block-maybe ()
  320. "Conditionally expand a source block.
  321. Detect if this is context for a org-babel src-block and if so
  322. then run `org-babel-expand-src-block'."
  323. (interactive)
  324. (org-babel-when-in-src-block
  325. (org-babel-expand-src-block current-prefix-arg)))
  326. ;;;###autoload
  327. (defun org-babel-load-in-session-maybe ()
  328. "Conditionally load a source block in a session.
  329. Detect if this is context for a org-babel src-block and if so
  330. then run `org-babel-load-in-session'."
  331. (interactive)
  332. (org-babel-when-in-src-block
  333. (org-babel-load-in-session current-prefix-arg)))
  334. (add-hook 'org-metaup-hook 'org-babel-load-in-session-maybe)
  335. ;;;###autoload
  336. (defun org-babel-pop-to-session-maybe ()
  337. "Conditionally pop to a session.
  338. Detect if this is context for a org-babel src-block and if so
  339. then run `org-babel-switch-to-session'."
  340. (interactive)
  341. (org-babel-when-in-src-block
  342. (org-babel-switch-to-session current-prefix-arg)))
  343. (add-hook 'org-metadown-hook 'org-babel-pop-to-session-maybe)
  344. (defconst org-babel-common-header-args-w-values
  345. '((cache . ((no yes)))
  346. (cmdline . :any)
  347. (colnames . ((nil no yes)))
  348. (comments . ((no link yes org both noweb)))
  349. (dir . :any)
  350. (eval . ((yes no no-export strip-export never-export eval never
  351. query)))
  352. (exports . ((code results both none)))
  353. (epilogue . :any)
  354. (file . :any)
  355. (file-desc . :any)
  356. (file-ext . :any)
  357. (hlines . ((no yes)))
  358. (mkdirp . ((yes no)))
  359. (no-expand)
  360. (noeval)
  361. (noweb . ((yes no tangle no-export strip-export)))
  362. (noweb-ref . :any)
  363. (noweb-sep . :any)
  364. (output-dir . :any)
  365. (padline . ((yes no)))
  366. (post . :any)
  367. (prologue . :any)
  368. (results . ((file list vector table scalar verbatim)
  369. (raw html latex org code pp drawer)
  370. (replace silent none append prepend)
  371. (output value)))
  372. (rownames . ((no yes)))
  373. (sep . :any)
  374. (session . :any)
  375. (shebang . :any)
  376. (tangle . ((tangle yes no :any)))
  377. (tangle-mode . ((#o755 #o555 #o444 :any)))
  378. (var . :any)
  379. (wrap . :any)))
  380. (defconst org-babel-header-arg-names
  381. (mapcar #'car org-babel-common-header-args-w-values)
  382. "Common header arguments used by org-babel.
  383. Note that individual languages may define their own language
  384. specific header arguments as well.")
  385. (defconst org-babel-safe-header-args
  386. '(:cache :colnames :comments :exports :epilogue :hlines :noeval
  387. :noweb :noweb-ref :noweb-sep :padline :prologue :rownames
  388. :sep :session :tangle :wrap
  389. (:eval . ("never" "query"))
  390. (:results . (lambda (str) (not (string-match "file" str)))))
  391. "A list of safe header arguments for babel source blocks.
  392. The list can have entries of the following forms:
  393. - :ARG -> :ARG is always a safe header arg
  394. - (:ARG . (VAL1 VAL2 ...)) -> :ARG is safe as a header arg if it is
  395. `equal' to one of the VALs.
  396. - (:ARG . FN) -> :ARG is safe as a header arg if the function FN
  397. returns non-nil. FN is passed one
  398. argument, the value of the header arg
  399. (as a string).")
  400. (defmacro org-babel-header-args-safe-fn (safe-list)
  401. "Return a function that determines whether a list of header args are safe.
  402. Intended usage is:
  403. \(put \\='org-babel-default-header-args \\='safe-local-variable
  404. (org-babel-header-args-safe-p org-babel-safe-header-args)
  405. This allows org-babel languages to extend the list of safe values for
  406. their `org-babel-default-header-args:foo' variable.
  407. For the format of SAFE-LIST, see `org-babel-safe-header-args'."
  408. `(lambda (value)
  409. (and (listp value)
  410. (cl-every
  411. (lambda (pair)
  412. (and (consp pair)
  413. (org-babel-one-header-arg-safe-p pair ,safe-list)))
  414. value))))
  415. (defvar org-babel-default-header-args
  416. '((:session . "none") (:results . "replace") (:exports . "code")
  417. (:cache . "no") (:noweb . "no") (:hlines . "no") (:tangle . "no"))
  418. "Default arguments to use when evaluating a source block.")
  419. (put 'org-babel-default-header-args 'safe-local-variable
  420. (org-babel-header-args-safe-fn org-babel-safe-header-args))
  421. (defvar org-babel-default-inline-header-args
  422. '((:session . "none") (:results . "replace")
  423. (:exports . "results") (:hlines . "yes"))
  424. "Default arguments to use when evaluating an inline source block.")
  425. (put 'org-babel-default-inline-header-args 'safe-local-variable
  426. (org-babel-header-args-safe-fn org-babel-safe-header-args))
  427. (defconst org-babel-name-regexp
  428. (format "^[ \t]*#\\+%s:[ \t]*"
  429. ;; FIXME: TBLNAME is for backward compatibility.
  430. (regexp-opt '("NAME" "TBLNAME")))
  431. "Regexp matching a NAME keyword.")
  432. (defconst org-babel-result-regexp
  433. (format "^[ \t]*#\\+%s\\(?:\\[\\(?:%s \\)?\\([[:alnum:]]+\\)\\]\\)?:[ \t]*"
  434. org-babel-results-keyword
  435. ;; <%Y-%m-%d %H:%M:%S>
  436. "<\\(?:[0-9]\\{4\\}-[0-1][0-9]-[0-3][0-9] \
  437. [0-2][0-9]\\(?::[0-5][0-9]\\)\\{2\\}\\)>")
  438. "Regular expression used to match result lines.
  439. If the results are associated with a hash key then the hash will
  440. be saved in match group 1.")
  441. (defconst org-babel-result-w-name-regexp
  442. (concat org-babel-result-regexp "\\(?9:[^ \t\n\r\v\f]+\\)")
  443. "Regexp matching a RESULTS keyword with a name.
  444. Name is saved in match group 9.")
  445. (defvar org-babel-min-lines-for-block-output 10
  446. "The minimum number of lines for block output.
  447. If number of lines of output is equal to or exceeds this
  448. value, the output is placed in a #+begin_example...#+end_example
  449. block. Otherwise the output is marked as literal by inserting
  450. colons at the starts of the lines. This variable only takes
  451. effect if the :results output option is in effect.")
  452. (defvar org-babel-noweb-error-all-langs nil
  453. "Raise errors when noweb references don't resolve.
  454. Also see `org-babel-noweb-error-langs' to control noweb errors on
  455. a language by language bases.")
  456. (defvar org-babel-noweb-error-langs nil
  457. "Languages for which Babel will raise literate programming errors.
  458. List of languages for which errors should be raised when the
  459. source code block satisfying a noweb reference in this language
  460. can not be resolved. Also see `org-babel-noweb-error-all-langs'
  461. to raise errors for all languages.")
  462. (defvar org-babel-hash-show 4
  463. "Number of initial characters to show of a hidden results hash.")
  464. (defvar org-babel-after-execute-hook nil
  465. "Hook for functions to be called after `org-babel-execute-src-block'")
  466. (defun org-babel-named-src-block-regexp-for-name (&optional name)
  467. "This generates a regexp used to match a src block named NAME.
  468. If NAME is nil, match any name. Matched name is then put in
  469. match group 9. Other match groups are defined in
  470. `org-babel-src-block-regexp'."
  471. (concat org-babel-src-name-regexp
  472. (concat (if name (regexp-quote name) "\\(?9:.*?\\)") "[ \t]*" )
  473. "\\(?:\n[ \t]*#\\+\\S-+:.*\\)*?"
  474. "\n"
  475. (substring org-babel-src-block-regexp 1)))
  476. (defun org-babel-named-data-regexp-for-name (name)
  477. "This generates a regexp used to match data named NAME."
  478. (concat org-babel-name-regexp (regexp-quote name) "[ \t]*$"))
  479. (defun org-babel--normalize-body (datum)
  480. "Normalize body for element or object DATUM.
  481. DATUM is a source block element or an inline source block object.
  482. Remove final newline character and spurious indentation."
  483. (let* ((value (org-element-property :value datum))
  484. (body (if (string-suffix-p "\n" value)
  485. (substring value 0 -1)
  486. value)))
  487. (cond ((eq (org-element-type datum) 'inline-src-block)
  488. ;; Newline characters and indentation in an inline
  489. ;; src-block are not meaningful, since they could come from
  490. ;; some paragraph filling. Treat them as a white space.
  491. (replace-regexp-in-string "\n[ \t]*" " " body))
  492. ((or org-src-preserve-indentation
  493. (org-element-property :preserve-indent datum))
  494. body)
  495. (t (org-remove-indentation body)))))
  496. ;;; functions
  497. (defvar org-babel-current-src-block-location nil
  498. "Marker pointing to the src block currently being executed.
  499. This may also point to a call line or an inline code block. If
  500. multiple blocks are being executed (e.g., in chained execution
  501. through use of the :var header argument) this marker points to
  502. the outer-most code block.")
  503. (defvar *this*)
  504. (defun org-babel-get-src-block-info (&optional light datum)
  505. "Extract information from a source block or inline source block.
  506. When optional argument LIGHT is non-nil, Babel does not resolve
  507. remote variable references; a process which could likely result
  508. in the execution of other code blocks, and do not evaluate Lisp
  509. values in parameters.
  510. By default, consider the block at point. However, when optional
  511. argument DATUM is provided, extract information from that parsed
  512. object instead.
  513. Return nil if point is not on a source block. Otherwise, return
  514. a list with the following pattern:
  515. (language body arguments switches name start coderef)"
  516. (let* ((datum (or datum (org-element-context)))
  517. (type (org-element-type datum))
  518. (inline (eq type 'inline-src-block)))
  519. (when (memq type '(inline-src-block src-block))
  520. (let* ((lang (org-element-property :language datum))
  521. (lang-headers (intern
  522. (concat "org-babel-default-header-args:" lang)))
  523. (name (org-element-property :name datum))
  524. (info
  525. (list
  526. lang
  527. (org-babel--normalize-body datum)
  528. (apply #'org-babel-merge-params
  529. (if inline org-babel-default-inline-header-args
  530. org-babel-default-header-args)
  531. (and (boundp lang-headers) (eval lang-headers t))
  532. (append
  533. ;; If DATUM is provided, make sure we get node
  534. ;; properties applicable to its location within
  535. ;; the document.
  536. (org-with-point-at (org-element-property :begin datum)
  537. (org-babel-params-from-properties lang light))
  538. (mapcar (lambda (h)
  539. (org-babel-parse-header-arguments h light))
  540. (cons (org-element-property :parameters datum)
  541. (org-element-property :header datum)))))
  542. (or (org-element-property :switches datum) "")
  543. name
  544. (org-element-property (if inline :begin :post-affiliated)
  545. datum)
  546. (and (not inline) (org-src-coderef-format datum)))))
  547. (unless light
  548. (setf (nth 2 info) (org-babel-process-params (nth 2 info))))
  549. (setf (nth 2 info) (org-babel-generate-file-param name (nth 2 info)))
  550. info))))
  551. ;;;###autoload
  552. (defun org-babel-execute-src-block (&optional arg info params)
  553. "Execute the current source code block.
  554. Insert the results of execution into the buffer. Source code
  555. execution and the collection and formatting of results can be
  556. controlled through a variety of header arguments.
  557. With prefix argument ARG, force re-execution even if an existing
  558. result cached in the buffer would otherwise have been returned.
  559. Optionally supply a value for INFO in the form returned by
  560. `org-babel-get-src-block-info'.
  561. Optionally supply a value for PARAMS which will be merged with
  562. the header arguments specified at the front of the source code
  563. block."
  564. (interactive)
  565. (let* ((org-babel-current-src-block-location
  566. (or org-babel-current-src-block-location
  567. (nth 5 info)
  568. (org-babel-where-is-src-block-head)))
  569. (info (if info (copy-tree info) (org-babel-get-src-block-info))))
  570. ;; Merge PARAMS with INFO before considering source block
  571. ;; evaluation since both could disagree.
  572. (cl-callf org-babel-merge-params (nth 2 info) params)
  573. (when (org-babel-check-evaluate info)
  574. (cl-callf org-babel-process-params (nth 2 info))
  575. (let* ((params (nth 2 info))
  576. (cache (let ((c (cdr (assq :cache params))))
  577. (and (not arg) c (string= "yes" c))))
  578. (new-hash (and cache (org-babel-sha1-hash info)))
  579. (old-hash (and cache (org-babel-current-result-hash)))
  580. (current-cache (and new-hash (equal new-hash old-hash))))
  581. (cond
  582. (current-cache
  583. (save-excursion ;Return cached result.
  584. (goto-char (org-babel-where-is-src-block-result nil info))
  585. (forward-line)
  586. (skip-chars-forward " \t")
  587. (let ((result (org-babel-read-result)))
  588. (message (replace-regexp-in-string "%" "%%" (format "%S" result)))
  589. result)))
  590. ((org-babel-confirm-evaluate info)
  591. (let* ((lang (nth 0 info))
  592. (result-params (cdr (assq :result-params params)))
  593. ;; Expand noweb references in BODY and remove any
  594. ;; coderef.
  595. (body
  596. (let ((coderef (nth 6 info))
  597. (expand
  598. (if (org-babel-noweb-p params :eval)
  599. (org-babel-expand-noweb-references info)
  600. (nth 1 info))))
  601. (if (not coderef) expand
  602. (replace-regexp-in-string
  603. (org-src-coderef-regexp coderef) "" expand nil nil 1))))
  604. (dir (cdr (assq :dir params)))
  605. (default-directory
  606. (or (and dir (file-name-as-directory (expand-file-name dir)))
  607. default-directory))
  608. (cmd (intern (concat "org-babel-execute:" lang)))
  609. result)
  610. (unless (fboundp cmd)
  611. (error "No org-babel-execute function for %s!" lang))
  612. (message "executing %s code block%s..."
  613. (capitalize lang)
  614. (let ((name (nth 4 info)))
  615. (if name (format " (%s)" name) "")))
  616. (if (member "none" result-params)
  617. (progn (funcall cmd body params)
  618. (message "result silenced"))
  619. (setq result
  620. (let ((r (funcall cmd body params)))
  621. (if (and (eq (cdr (assq :result-type params)) 'value)
  622. (or (member "vector" result-params)
  623. (member "table" result-params))
  624. (not (listp r)))
  625. (list (list r))
  626. r)))
  627. (let ((file (cdr (assq :file params))))
  628. ;; If non-empty result and :file then write to :file.
  629. (when file
  630. (when result
  631. (with-temp-file file
  632. (insert (org-babel-format-result
  633. result (cdr (assq :sep params))))))
  634. (setq result file))
  635. ;; Possibly perform post process provided its
  636. ;; appropriate. Dynamically bind "*this*" to the
  637. ;; actual results of the block.
  638. (let ((post (cdr (assq :post params))))
  639. (when post
  640. (let ((*this* (if (not file) result
  641. (org-babel-result-to-file
  642. file
  643. (let ((desc (assq :file-desc params)))
  644. (and desc (or (cdr desc) result)))))))
  645. (setq result (org-babel-ref-resolve post))
  646. (when file
  647. (setq result-params (remove "file" result-params))))))
  648. (org-babel-insert-result
  649. result result-params info new-hash lang)))
  650. (run-hooks 'org-babel-after-execute-hook)
  651. result)))))))
  652. (defun org-babel-expand-body:generic (body params &optional var-lines)
  653. "Expand BODY with PARAMS.
  654. Expand a block of code with org-babel according to its header
  655. arguments. This generic implementation of body expansion is
  656. called for languages which have not defined their own specific
  657. org-babel-expand-body:lang function."
  658. (let ((pro (cdr (assq :prologue params)))
  659. (epi (cdr (assq :epilogue params))))
  660. (mapconcat #'identity
  661. (append (when pro (list pro))
  662. var-lines
  663. (list body)
  664. (when epi (list epi)))
  665. "\n")))
  666. ;;;###autoload
  667. (defun org-babel-expand-src-block (&optional _arg info params)
  668. "Expand the current source code block.
  669. Expand according to the source code block's header
  670. arguments and pop open the results in a preview buffer."
  671. (interactive)
  672. (let* ((info (or info (org-babel-get-src-block-info)))
  673. (lang (nth 0 info))
  674. (params (setf (nth 2 info)
  675. (sort (org-babel-merge-params (nth 2 info) params)
  676. (lambda (el1 el2) (string< (symbol-name (car el1))
  677. (symbol-name (car el2)))))))
  678. (body (setf (nth 1 info)
  679. (if (org-babel-noweb-p params :eval)
  680. (org-babel-expand-noweb-references info) (nth 1 info))))
  681. (expand-cmd (intern (concat "org-babel-expand-body:" lang)))
  682. (assignments-cmd (intern (concat "org-babel-variable-assignments:"
  683. lang)))
  684. (expanded
  685. (if (fboundp expand-cmd) (funcall expand-cmd body params)
  686. (org-babel-expand-body:generic
  687. body params (and (fboundp assignments-cmd)
  688. (funcall assignments-cmd params))))))
  689. (if (called-interactively-p 'any)
  690. (org-edit-src-code
  691. expanded (concat "*Org-Babel Preview " (buffer-name) "[ " lang " ]*"))
  692. expanded)))
  693. (defun org-babel-edit-distance (s1 s2)
  694. "Return the edit (levenshtein) distance between strings S1 S2."
  695. (let* ((l1 (length s1))
  696. (l2 (length s2))
  697. (dist (vconcat (mapcar (lambda (_) (make-vector (1+ l2) nil))
  698. (number-sequence 1 (1+ l1)))))
  699. (in (lambda (i j) (aref (aref dist i) j))))
  700. (setf (aref (aref dist 0) 0) 0)
  701. (dolist (j (number-sequence 1 l2))
  702. (setf (aref (aref dist 0) j) j))
  703. (dolist (i (number-sequence 1 l1))
  704. (setf (aref (aref dist i) 0) i)
  705. (dolist (j (number-sequence 1 l2))
  706. (setf (aref (aref dist i) j)
  707. (min
  708. (1+ (funcall in (1- i) j))
  709. (1+ (funcall in i (1- j)))
  710. (+ (if (equal (aref s1 (1- i)) (aref s2 (1- j))) 0 1)
  711. (funcall in (1- i) (1- j)))))))
  712. (funcall in l1 l2)))
  713. (defun org-babel-combine-header-arg-lists (original &rest others)
  714. "Combine a number of lists of header argument names and arguments."
  715. (let ((results (copy-sequence original)))
  716. (dolist (new-list others)
  717. (dolist (arg-pair new-list)
  718. (let ((header (car arg-pair)))
  719. (setq results
  720. (cons arg-pair (cl-remove-if
  721. (lambda (pair) (equal header (car pair)))
  722. results))))))
  723. results))
  724. ;;;###autoload
  725. (defun org-babel-check-src-block ()
  726. "Check for misspelled header arguments in the current code block."
  727. (interactive)
  728. ;; TODO: report malformed code block
  729. ;; TODO: report incompatible combinations of header arguments
  730. ;; TODO: report uninitialized variables
  731. (let ((too-close 2) ;; <- control closeness to report potential match
  732. (names (mapcar #'symbol-name org-babel-header-arg-names)))
  733. (dolist (header (mapcar (lambda (arg) (substring (symbol-name (car arg)) 1))
  734. (and (org-babel-where-is-src-block-head)
  735. (org-babel-parse-header-arguments
  736. (org-no-properties
  737. (match-string 4))))))
  738. (dolist (name names)
  739. (when (and (not (string= header name))
  740. (<= (org-babel-edit-distance header name) too-close)
  741. (not (member header names)))
  742. (error "Supplied header \"%S\" is suspiciously close to \"%S\""
  743. header name))))
  744. (message "No suspicious header arguments found.")))
  745. ;;;###autoload
  746. (defun org-babel-insert-header-arg (&optional header-arg value)
  747. "Insert a header argument selecting from lists of common args and values."
  748. (interactive)
  749. (let* ((info (org-babel-get-src-block-info 'light))
  750. (lang (car info))
  751. (begin (nth 5 info))
  752. (lang-headers (intern (concat "org-babel-header-args:" lang)))
  753. (headers (org-babel-combine-header-arg-lists
  754. org-babel-common-header-args-w-values
  755. (when (boundp lang-headers) (eval lang-headers t))))
  756. (header-arg (or header-arg
  757. (completing-read
  758. "Header Arg: "
  759. (mapcar
  760. (lambda (header-spec) (symbol-name (car header-spec)))
  761. headers))))
  762. (vals (cdr (assoc (intern header-arg) headers)))
  763. (value (or value
  764. (cond
  765. ((eq vals :any)
  766. (read-from-minibuffer "value: "))
  767. ((listp vals)
  768. (mapconcat
  769. (lambda (group)
  770. (let ((arg (completing-read
  771. "Value: "
  772. (cons "default"
  773. (mapcar #'symbol-name group)))))
  774. (if (and arg (not (string= "default" arg)))
  775. (concat arg " ")
  776. "")))
  777. vals ""))))))
  778. (save-excursion
  779. (goto-char begin)
  780. (goto-char (point-at-eol))
  781. (unless (= (char-before (point)) ?\ ) (insert " "))
  782. (insert ":" header-arg) (when value (insert " " value)))))
  783. ;; Add support for completing-read insertion of header arguments after ":"
  784. (defun org-babel-header-arg-expand ()
  785. "Call `org-babel-enter-header-arg-w-completion' in appropriate contexts."
  786. (when (and (equal (char-before) ?\:) (org-babel-where-is-src-block-head))
  787. (org-babel-enter-header-arg-w-completion (match-string 2))))
  788. (defun org-babel-enter-header-arg-w-completion (&optional lang)
  789. "Insert header argument appropriate for LANG with completion."
  790. (let* ((lang-headers-var (intern (concat "org-babel-header-args:" lang)))
  791. (lang-headers (when (boundp lang-headers-var) (eval lang-headers-var t)))
  792. (headers-w-values (org-babel-combine-header-arg-lists
  793. org-babel-common-header-args-w-values lang-headers))
  794. (headers (mapcar #'symbol-name (mapcar #'car headers-w-values)))
  795. (header (org-completing-read "Header Arg: " headers))
  796. (args (cdr (assoc (intern header) headers-w-values)))
  797. (arg (when (and args (listp args))
  798. (org-completing-read
  799. (format "%s: " header)
  800. (mapcar #'symbol-name (apply #'append args))))))
  801. (insert (concat header " " (or arg "")))
  802. (cons header arg)))
  803. (add-hook 'org-tab-first-hook 'org-babel-header-arg-expand)
  804. ;;;###autoload
  805. (defun org-babel-load-in-session (&optional _arg info)
  806. "Load the body of the current source-code block.
  807. Evaluate the header arguments for the source block before
  808. entering the session. After loading the body this pops open the
  809. session."
  810. (interactive)
  811. (let* ((info (or info (org-babel-get-src-block-info)))
  812. (lang (nth 0 info))
  813. (params (nth 2 info))
  814. (body (if (not info)
  815. (user-error "No src code block at point")
  816. (setf (nth 1 info)
  817. (if (org-babel-noweb-p params :eval)
  818. (org-babel-expand-noweb-references info)
  819. (nth 1 info)))))
  820. (session (cdr (assq :session params)))
  821. (dir (cdr (assq :dir params)))
  822. (default-directory
  823. (or (and dir (file-name-as-directory dir)) default-directory))
  824. (cmd (intern (concat "org-babel-load-session:" lang))))
  825. (unless (fboundp cmd)
  826. (error "No org-babel-load-session function for %s!" lang))
  827. (pop-to-buffer (funcall cmd session body params))
  828. (end-of-line 1)))
  829. ;;;###autoload
  830. (defun org-babel-initiate-session (&optional arg info)
  831. "Initiate session for current code block.
  832. If called with a prefix argument then resolve any variable
  833. references in the header arguments and assign these variables in
  834. the session. Copy the body of the code block to the kill ring."
  835. (interactive "P")
  836. (let* ((info (or info (org-babel-get-src-block-info (not arg))))
  837. (lang (nth 0 info))
  838. (body (nth 1 info))
  839. (params (nth 2 info))
  840. (session (cdr (assq :session params)))
  841. (dir (cdr (assq :dir params)))
  842. (default-directory
  843. (or (and dir (file-name-as-directory dir)) default-directory))
  844. (init-cmd (intern (format "org-babel-%s-initiate-session" lang)))
  845. (prep-cmd (intern (concat "org-babel-prep-session:" lang))))
  846. (when (and (stringp session) (string= session "none"))
  847. (error "This block is not using a session!"))
  848. (unless (fboundp init-cmd)
  849. (error "No org-babel-initiate-session function for %s!" lang))
  850. (with-temp-buffer (insert (org-trim body))
  851. (copy-region-as-kill (point-min) (point-max)))
  852. (when arg
  853. (unless (fboundp prep-cmd)
  854. (error "No org-babel-prep-session function for %s!" lang))
  855. (funcall prep-cmd session params))
  856. (funcall init-cmd session params)))
  857. ;;;###autoload
  858. (defun org-babel-switch-to-session (&optional arg info)
  859. "Switch to the session of the current code block.
  860. Uses `org-babel-initiate-session' to start the session. If called
  861. with a prefix argument then this is passed on to
  862. `org-babel-initiate-session'."
  863. (interactive "P")
  864. (pop-to-buffer (org-babel-initiate-session arg info))
  865. (end-of-line 1))
  866. (defalias 'org-babel-pop-to-session 'org-babel-switch-to-session)
  867. (defvar org-src-window-setup)
  868. ;;;###autoload
  869. (defun org-babel-switch-to-session-with-code (&optional arg _info)
  870. "Switch to code buffer and display session."
  871. (interactive "P")
  872. (let ((swap-windows
  873. (lambda ()
  874. (let ((other-window-buffer (window-buffer (next-window))))
  875. (set-window-buffer (next-window) (current-buffer))
  876. (set-window-buffer (selected-window) other-window-buffer))
  877. (other-window 1)))
  878. (info (org-babel-get-src-block-info))
  879. (org-src-window-setup 'reorganize-frame))
  880. (save-excursion
  881. (org-babel-switch-to-session arg info))
  882. (org-edit-src-code)
  883. (funcall swap-windows)))
  884. ;;;###autoload
  885. (defmacro org-babel-do-in-edit-buffer (&rest body)
  886. "Evaluate BODY in edit buffer if there is a code block at point.
  887. Return t if a code block was found at point, nil otherwise."
  888. `(let ((org-src-window-setup 'switch-invisibly))
  889. (when (and (org-babel-where-is-src-block-head)
  890. (org-edit-src-code))
  891. (unwind-protect (progn ,@body)
  892. (org-edit-src-exit))
  893. t)))
  894. (def-edebug-spec org-babel-do-in-edit-buffer (body))
  895. (defun org-babel-do-key-sequence-in-edit-buffer (key)
  896. "Read key sequence and execute the command in edit buffer.
  897. Enter a key sequence to be executed in the language major-mode
  898. edit buffer. For example, TAB will alter the contents of the
  899. Org code block according to the effect of TAB in the language
  900. major mode buffer. For languages that support interactive
  901. sessions, this can be used to send code from the Org buffer
  902. to the session for evaluation using the native major mode
  903. evaluation mechanisms."
  904. (interactive "kEnter key-sequence to execute in edit buffer: ")
  905. (org-babel-do-in-edit-buffer
  906. (call-interactively
  907. (key-binding (or key (read-key-sequence nil))))))
  908. (defvar org-bracket-link-regexp)
  909. (defun org-babel-active-location-p ()
  910. (memq (org-element-type (save-match-data (org-element-context)))
  911. '(babel-call inline-babel-call inline-src-block src-block)))
  912. ;;;###autoload
  913. (defun org-babel-open-src-block-result (&optional re-run)
  914. "If `point' is on a src block then open the results of the
  915. source code block, otherwise return nil. With optional prefix
  916. argument RE-RUN the source-code block is evaluated even if
  917. results already exist."
  918. (interactive "P")
  919. (let ((info (org-babel-get-src-block-info 'light)))
  920. (when info
  921. (save-excursion
  922. ;; go to the results, if there aren't any then run the block
  923. (goto-char (or (and (not re-run) (org-babel-where-is-src-block-result))
  924. (progn (org-babel-execute-src-block)
  925. (org-babel-where-is-src-block-result))))
  926. (end-of-line 1)
  927. (while (looking-at "[\n\r\t\f ]") (forward-char 1))
  928. ;; open the results
  929. (if (looking-at org-bracket-link-regexp)
  930. ;; file results
  931. (org-open-at-point)
  932. (let ((r (org-babel-format-result
  933. (org-babel-read-result) (cdr (assq :sep (nth 2 info))))))
  934. (pop-to-buffer (get-buffer-create "*Org-Babel Results*"))
  935. (delete-region (point-min) (point-max))
  936. (insert r)))
  937. t))))
  938. ;;;###autoload
  939. (defmacro org-babel-map-src-blocks (file &rest body)
  940. "Evaluate BODY forms on each source-block in FILE.
  941. If FILE is nil evaluate BODY forms on source blocks in current
  942. buffer. During evaluation of BODY the following local variables
  943. are set relative to the currently matched code block.
  944. full-block ------- string holding the entirety of the code block
  945. beg-block -------- point at the beginning of the code block
  946. end-block -------- point at the end of the matched code block
  947. lang ------------- string holding the language of the code block
  948. beg-lang --------- point at the beginning of the lang
  949. end-lang --------- point at the end of the lang
  950. switches --------- string holding the switches
  951. beg-switches ----- point at the beginning of the switches
  952. end-switches ----- point at the end of the switches
  953. header-args ------ string holding the header-args
  954. beg-header-args -- point at the beginning of the header-args
  955. end-header-args -- point at the end of the header-args
  956. body ------------- string holding the body of the code block
  957. beg-body --------- point at the beginning of the body
  958. end-body --------- point at the end of the body"
  959. (declare (indent 1))
  960. (let ((tempvar (make-symbol "file")))
  961. `(let* ((case-fold-search t)
  962. (,tempvar ,file)
  963. (visited-p (or (null ,tempvar)
  964. (get-file-buffer (expand-file-name ,tempvar))))
  965. (point (point)) to-be-removed)
  966. (save-window-excursion
  967. (when ,tempvar (find-file ,tempvar))
  968. (setq to-be-removed (current-buffer))
  969. (goto-char (point-min))
  970. (while (re-search-forward org-babel-src-block-regexp nil t)
  971. (when (org-babel-active-location-p)
  972. (goto-char (match-beginning 0))
  973. (let ((full-block (match-string 0))
  974. (beg-block (match-beginning 0))
  975. (end-block (match-end 0))
  976. (lang (match-string 2))
  977. (beg-lang (match-beginning 2))
  978. (end-lang (match-end 2))
  979. (switches (match-string 3))
  980. (beg-switches (match-beginning 3))
  981. (end-switches (match-end 3))
  982. (header-args (match-string 4))
  983. (beg-header-args (match-beginning 4))
  984. (end-header-args (match-end 4))
  985. (body (match-string 5))
  986. (beg-body (match-beginning 5))
  987. (end-body (match-end 5)))
  988. ;; Silence byte-compiler in case `body' doesn't use all
  989. ;; those variables.
  990. (ignore full-block beg-block end-block lang
  991. beg-lang end-lang switches beg-switches
  992. end-switches header-args beg-header-args
  993. end-header-args body beg-body end-body)
  994. ,@body
  995. (goto-char end-block)))))
  996. (unless visited-p (kill-buffer to-be-removed))
  997. (goto-char point))))
  998. (def-edebug-spec org-babel-map-src-blocks (form body))
  999. ;;;###autoload
  1000. (defmacro org-babel-map-inline-src-blocks (file &rest body)
  1001. "Evaluate BODY forms on each inline source block in FILE.
  1002. If FILE is nil evaluate BODY forms on source blocks in current
  1003. buffer."
  1004. (declare (indent 1) (debug (form body)))
  1005. (org-with-gensyms (datum end point tempvar to-be-removed visitedp)
  1006. `(let* ((case-fold-search t)
  1007. (,tempvar ,file)
  1008. (,visitedp (or (null ,tempvar)
  1009. (get-file-buffer (expand-file-name ,tempvar))))
  1010. (,point (point))
  1011. ,to-be-removed)
  1012. (save-window-excursion
  1013. (when ,tempvar (find-file ,tempvar))
  1014. (setq ,to-be-removed (current-buffer))
  1015. (goto-char (point-min))
  1016. (while (re-search-forward "src_\\S-" nil t)
  1017. (let ((,datum (save-match-data (org-element-context))))
  1018. (when (eq (org-element-type ,datum) 'inline-src-block)
  1019. (goto-char (match-beginning 0))
  1020. (let ((,end (copy-marker (org-element-property :end ,datum))))
  1021. ,@body
  1022. (goto-char ,end)
  1023. (set-marker ,end nil))))))
  1024. (unless ,visitedp (kill-buffer ,to-be-removed))
  1025. (goto-char ,point))))
  1026. ;;;###autoload
  1027. (defmacro org-babel-map-call-lines (file &rest body)
  1028. "Evaluate BODY forms on each call line in FILE.
  1029. If FILE is nil evaluate BODY forms on source blocks in current
  1030. buffer."
  1031. (declare (indent 1) (debug (form body)))
  1032. (org-with-gensyms (datum end point tempvar to-be-removed visitedp)
  1033. `(let* ((case-fold-search t)
  1034. (,tempvar ,file)
  1035. (,visitedp (or (null ,tempvar)
  1036. (get-file-buffer (expand-file-name ,tempvar))))
  1037. (,point (point))
  1038. ,to-be-removed)
  1039. (save-window-excursion
  1040. (when ,tempvar (find-file ,tempvar))
  1041. (setq ,to-be-removed (current-buffer))
  1042. (goto-char (point-min))
  1043. (while (re-search-forward "call_\\S-\\|^[ \t]*#\\+CALL:" nil t)
  1044. (let ((,datum (save-match-data (org-element-context))))
  1045. (when (memq (org-element-type ,datum)
  1046. '(babel-call inline-babel-call))
  1047. (goto-char (match-beginning 0))
  1048. (let ((,end (copy-marker (org-element-property :end ,datum))))
  1049. ,@body
  1050. (goto-char ,end)
  1051. (set-marker ,end nil))))))
  1052. (unless ,visitedp (kill-buffer ,to-be-removed))
  1053. (goto-char ,point))))
  1054. ;;;###autoload
  1055. (defmacro org-babel-map-executables (file &rest body)
  1056. "Evaluate BODY forms on each active Babel code in FILE.
  1057. If FILE is nil evaluate BODY forms on source blocks in current
  1058. buffer."
  1059. (declare (indent 1) (debug (form body)))
  1060. (org-with-gensyms (datum end point tempvar to-be-removed visitedp)
  1061. `(let* ((case-fold-search t)
  1062. (,tempvar ,file)
  1063. (,visitedp (or (null ,tempvar)
  1064. (get-file-buffer (expand-file-name ,tempvar))))
  1065. (,point (point))
  1066. ,to-be-removed)
  1067. (save-window-excursion
  1068. (when ,tempvar (find-file ,tempvar))
  1069. (setq ,to-be-removed (current-buffer))
  1070. (goto-char (point-min))
  1071. (while (re-search-forward
  1072. "\\(call\\|src\\)_\\|^[ \t]*#\\+\\(BEGIN_SRC\\|CALL:\\)" nil t)
  1073. (let ((,datum (save-match-data (org-element-context))))
  1074. (when (memq (org-element-type ,datum)
  1075. '(babel-call inline-babel-call inline-src-block
  1076. src-block))
  1077. (goto-char (match-beginning 0))
  1078. (let ((,end (copy-marker (org-element-property :end ,datum))))
  1079. ,@body
  1080. (goto-char ,end)
  1081. (set-marker ,end nil))))))
  1082. (unless ,visitedp (kill-buffer ,to-be-removed))
  1083. (goto-char ,point))))
  1084. ;;;###autoload
  1085. (defun org-babel-execute-buffer (&optional arg)
  1086. "Execute source code blocks in a buffer.
  1087. Call `org-babel-execute-src-block' on every source block in
  1088. the current buffer."
  1089. (interactive "P")
  1090. (org-babel-eval-wipe-error-buffer)
  1091. (org-save-outline-visibility t
  1092. (org-babel-map-executables nil
  1093. (if (memq (org-element-type (org-element-context))
  1094. '(babel-call inline-babel-call))
  1095. (org-babel-lob-execute-maybe)
  1096. (org-babel-execute-src-block arg)))))
  1097. ;;;###autoload
  1098. (defun org-babel-execute-subtree (&optional arg)
  1099. "Execute source code blocks in a subtree.
  1100. Call `org-babel-execute-src-block' on every source block in
  1101. the current subtree."
  1102. (interactive "P")
  1103. (save-restriction
  1104. (save-excursion
  1105. (org-narrow-to-subtree)
  1106. (org-babel-execute-buffer arg)
  1107. (widen))))
  1108. ;;;###autoload
  1109. (defun org-babel-sha1-hash (&optional info)
  1110. "Generate an sha1 hash based on the value of info."
  1111. (interactive)
  1112. (let ((print-level nil)
  1113. (info (or info (org-babel-get-src-block-info))))
  1114. (setf (nth 2 info)
  1115. (sort (copy-sequence (nth 2 info))
  1116. (lambda (a b) (string< (car a) (car b)))))
  1117. (let* ((rm (lambda (lst)
  1118. (dolist (p '("replace" "silent" "none"
  1119. "append" "prepend"))
  1120. (setq lst (remove p lst)))
  1121. lst))
  1122. (norm (lambda (arg)
  1123. (let ((v (if (and (listp (cdr arg)) (null (cddr arg)))
  1124. (copy-sequence (cdr arg))
  1125. (cdr arg))))
  1126. (when (and v (not (and (sequencep v)
  1127. (not (consp v))
  1128. (= (length v) 0))))
  1129. (cond
  1130. ((and (listp v) ; lists are sorted
  1131. (member (car arg) '(:result-params)))
  1132. (sort (funcall rm v) #'string<))
  1133. ((and (stringp v) ; strings are sorted
  1134. (member (car arg) '(:results :exports)))
  1135. (mapconcat #'identity (sort (funcall rm (split-string v))
  1136. #'string<) " "))
  1137. (t v))))))
  1138. ;; expanded body
  1139. (lang (nth 0 info))
  1140. (params (nth 2 info))
  1141. (body (if (org-babel-noweb-p params :eval)
  1142. (org-babel-expand-noweb-references info) (nth 1 info)))
  1143. (expand-cmd (intern (concat "org-babel-expand-body:" lang)))
  1144. (assignments-cmd (intern (concat "org-babel-variable-assignments:"
  1145. lang)))
  1146. (expanded
  1147. (if (fboundp expand-cmd) (funcall expand-cmd body params)
  1148. (org-babel-expand-body:generic
  1149. body params (and (fboundp assignments-cmd)
  1150. (funcall assignments-cmd params))))))
  1151. (let* ((it (format "%s-%s"
  1152. (mapconcat
  1153. #'identity
  1154. (delq nil (mapcar (lambda (arg)
  1155. (let ((normalized (funcall norm arg)))
  1156. (when normalized
  1157. (format "%S" normalized))))
  1158. (nth 2 info))) ":")
  1159. expanded))
  1160. (hash (sha1 it)))
  1161. (when (called-interactively-p 'interactive) (message hash))
  1162. hash))))
  1163. (defun org-babel-current-result-hash (&optional info)
  1164. "Return the current in-buffer hash."
  1165. (let ((result (org-babel-where-is-src-block-result nil info)))
  1166. (when result
  1167. (org-with-wide-buffer
  1168. (goto-char result)
  1169. (looking-at org-babel-result-regexp)
  1170. (match-string-no-properties 1)))))
  1171. (defun org-babel-set-current-result-hash (hash info)
  1172. "Set the current in-buffer hash to HASH."
  1173. (org-with-wide-buffer
  1174. (goto-char (org-babel-where-is-src-block-result nil info))
  1175. (looking-at org-babel-result-regexp)
  1176. (goto-char (match-beginning 1))
  1177. (mapc #'delete-overlay (overlays-at (point)))
  1178. (forward-char org-babel-hash-show)
  1179. (mapc #'delete-overlay (overlays-at (point)))
  1180. (replace-match hash nil nil nil 1)
  1181. (beginning-of-line)
  1182. (org-babel-hide-hash)))
  1183. (defun org-babel-hide-hash ()
  1184. "Hide the hash in the current results line.
  1185. Only the initial `org-babel-hash-show' characters of the hash
  1186. will remain visible."
  1187. (add-to-invisibility-spec '(org-babel-hide-hash . t))
  1188. (save-excursion
  1189. (when (and (re-search-forward org-babel-result-regexp nil t)
  1190. (match-string 1))
  1191. (let* ((start (match-beginning 1))
  1192. (hide-start (+ org-babel-hash-show start))
  1193. (end (match-end 1))
  1194. (hash (match-string 1))
  1195. ov1 ov2)
  1196. (setq ov1 (make-overlay start hide-start))
  1197. (setq ov2 (make-overlay hide-start end))
  1198. (overlay-put ov2 'invisible 'org-babel-hide-hash)
  1199. (overlay-put ov1 'babel-hash hash)))))
  1200. (defun org-babel-hide-all-hashes ()
  1201. "Hide the hash in the current buffer.
  1202. Only the initial `org-babel-hash-show' characters of each hash
  1203. will remain visible. This function should be called as part of
  1204. the `org-mode-hook'."
  1205. (save-excursion
  1206. (while (and (not org-babel-hash-show-time)
  1207. (re-search-forward org-babel-result-regexp nil t))
  1208. (goto-char (match-beginning 0))
  1209. (org-babel-hide-hash)
  1210. (goto-char (match-end 0)))))
  1211. (add-hook 'org-mode-hook 'org-babel-hide-all-hashes)
  1212. (defun org-babel-hash-at-point (&optional point)
  1213. "Return the value of the hash at POINT.
  1214. \\<org-mode-map>\
  1215. The hash is also added as the last element of the kill ring.
  1216. This can be called with `\\[org-ctrl-c-ctrl-c]'."
  1217. (interactive)
  1218. (let ((hash (car (delq nil (mapcar
  1219. (lambda (ol) (overlay-get ol 'babel-hash))
  1220. (overlays-at (or point (point))))))))
  1221. (when hash (kill-new hash) (message hash))))
  1222. (defun org-babel-result-hide-spec ()
  1223. "Hide portions of results lines.
  1224. Add `org-babel-hide-result' as an invisibility spec for hiding
  1225. portions of results lines."
  1226. (add-to-invisibility-spec '(org-babel-hide-result . t)))
  1227. (add-hook 'org-mode-hook 'org-babel-result-hide-spec)
  1228. (defvar org-babel-hide-result-overlays nil
  1229. "Overlays hiding results.")
  1230. (defun org-babel-result-hide-all ()
  1231. "Fold all results in the current buffer."
  1232. (interactive)
  1233. (org-babel-show-result-all)
  1234. (save-excursion
  1235. (while (re-search-forward org-babel-result-regexp nil t)
  1236. (save-excursion (goto-char (match-beginning 0))
  1237. (org-babel-hide-result-toggle-maybe)))))
  1238. (defun org-babel-show-result-all ()
  1239. "Unfold all results in the current buffer."
  1240. (mapc 'delete-overlay org-babel-hide-result-overlays)
  1241. (setq org-babel-hide-result-overlays nil))
  1242. ;;;###autoload
  1243. (defun org-babel-hide-result-toggle-maybe ()
  1244. "Toggle visibility of result at point."
  1245. (interactive)
  1246. (let ((case-fold-search t))
  1247. (if (save-excursion
  1248. (beginning-of-line 1)
  1249. (looking-at org-babel-result-regexp))
  1250. (progn (org-babel-hide-result-toggle)
  1251. t) ;; to signal that we took action
  1252. nil))) ;; to signal that we did not
  1253. (defun org-babel-hide-result-toggle (&optional force)
  1254. "Toggle the visibility of the current result."
  1255. (interactive)
  1256. (save-excursion
  1257. (beginning-of-line)
  1258. (if (re-search-forward org-babel-result-regexp nil t)
  1259. (let ((start (progn (beginning-of-line 2) (- (point) 1)))
  1260. (end (progn
  1261. (while (looking-at org-babel-multi-line-header-regexp)
  1262. (forward-line 1))
  1263. (goto-char (- (org-babel-result-end) 1)) (point)))
  1264. ov)
  1265. (if (memq t (mapcar (lambda (overlay)
  1266. (eq (overlay-get overlay 'invisible)
  1267. 'org-babel-hide-result))
  1268. (overlays-at start)))
  1269. (when (or (not force) (eq force 'off))
  1270. (mapc (lambda (ov)
  1271. (when (member ov org-babel-hide-result-overlays)
  1272. (setq org-babel-hide-result-overlays
  1273. (delq ov org-babel-hide-result-overlays)))
  1274. (when (eq (overlay-get ov 'invisible)
  1275. 'org-babel-hide-result)
  1276. (delete-overlay ov)))
  1277. (overlays-at start)))
  1278. (setq ov (make-overlay start end))
  1279. (overlay-put ov 'invisible 'org-babel-hide-result)
  1280. ;; make the block accessible to isearch
  1281. (overlay-put
  1282. ov 'isearch-open-invisible
  1283. (lambda (ov)
  1284. (when (member ov org-babel-hide-result-overlays)
  1285. (setq org-babel-hide-result-overlays
  1286. (delq ov org-babel-hide-result-overlays)))
  1287. (when (eq (overlay-get ov 'invisible)
  1288. 'org-babel-hide-result)
  1289. (delete-overlay ov))))
  1290. (push ov org-babel-hide-result-overlays)))
  1291. (error "Not looking at a result line"))))
  1292. ;; org-tab-after-check-for-cycling-hook
  1293. (add-hook 'org-tab-first-hook 'org-babel-hide-result-toggle-maybe)
  1294. ;; Remove overlays when changing major mode
  1295. (add-hook 'org-mode-hook
  1296. (lambda () (add-hook 'change-major-mode-hook
  1297. 'org-babel-show-result-all 'append 'local)))
  1298. (defun org-babel-params-from-properties (&optional lang no-eval)
  1299. "Retrieve source block parameters specified as properties.
  1300. LANG is the language of the source block, as a string. When
  1301. optional argument NO-EVAL is non-nil, do not evaluate Lisp values
  1302. in parameters.
  1303. Return a list of association lists of source block parameters
  1304. specified in the properties of the current outline entry."
  1305. (save-match-data
  1306. (list
  1307. ;; Header arguments specified with the header-args property at
  1308. ;; point of call.
  1309. (org-babel-parse-header-arguments
  1310. (org-entry-get (point) "header-args" 'inherit)
  1311. no-eval)
  1312. ;; Language-specific header arguments at point of call.
  1313. (and lang
  1314. (org-babel-parse-header-arguments
  1315. (org-entry-get (point) (concat "header-args:" lang) 'inherit)
  1316. no-eval)))))
  1317. (defun org-babel-balanced-split (string alts)
  1318. "Split STRING on instances of ALTS.
  1319. ALTS is a character, or cons of two character options where each
  1320. option may be either the numeric code of a single character or
  1321. a list of character alternatives. For example, to split on
  1322. balanced instances of \"[ \t]:\", set ALTS to ((32 9) . 58)."
  1323. (with-temp-buffer
  1324. (insert string)
  1325. (goto-char (point-min))
  1326. (let ((splitp (lambda (past next)
  1327. ;; Non-nil when there should be a split after NEXT
  1328. ;; character. PAST is the character before NEXT.
  1329. (pcase alts
  1330. (`(,(and first (pred consp)) . ,(and second (pred consp)))
  1331. (and (memq past first) (memq next second)))
  1332. (`(,first . ,(and second (pred consp)))
  1333. (and (eq past first) (memq next second)))
  1334. (`(,(and first (pred consp)) . ,second)
  1335. (and (memq past first) (eq next second)))
  1336. (`(,first . ,second)
  1337. (and (eq past first) (eq next second)))
  1338. ((pred (eq next)) t)
  1339. (_ nil))))
  1340. (partial nil)
  1341. (result nil))
  1342. (while (not (eobp))
  1343. (cond
  1344. ((funcall splitp (char-before) (char-after))
  1345. ;; There is a split after point. If ALTS is two-folds,
  1346. ;; remove last parsed character as it belongs to ALTS.
  1347. (when (consp alts) (pop partial))
  1348. ;; Include elements parsed so far in RESULTS and flush
  1349. ;; partial parsing.
  1350. (when partial
  1351. (push (apply #'string (nreverse partial)) result)
  1352. (setq partial nil))
  1353. (forward-char))
  1354. ((memq (char-after) '(?\( ?\[))
  1355. ;; Include everything between balanced brackets.
  1356. (let* ((origin (point))
  1357. (after (char-after))
  1358. (openings (list after)))
  1359. (forward-char)
  1360. (while (and openings (re-search-forward "[]()]" nil t))
  1361. (pcase (char-before)
  1362. ((and match (or ?\[ ?\()) (push match openings))
  1363. (?\] (when (eq ?\[ (car openings)) (pop openings)))
  1364. (_ (when (eq ?\( (car openings)) (pop openings)))))
  1365. (if (null openings)
  1366. (setq partial
  1367. (nconc (nreverse (string-to-list
  1368. (buffer-substring origin (point))))
  1369. partial))
  1370. ;; Un-balanced bracket. Backtrack.
  1371. (push after partial)
  1372. (goto-char (1+ origin)))))
  1373. ((and (eq ?\" (char-after)) (not (eq ?\\ (char-before))))
  1374. ;; Include everything from current double quote to next
  1375. ;; non-escaped double quote.
  1376. (let ((origin (point)))
  1377. (if (re-search-forward "[^\\]\"" nil t)
  1378. (setq partial
  1379. (nconc (nreverse (string-to-list
  1380. (buffer-substring origin (point))))
  1381. partial))
  1382. ;; No closing double quote. Backtrack.
  1383. (push ?\" partial)
  1384. (forward-char))))
  1385. (t (push (char-after) partial)
  1386. (forward-char))))
  1387. ;; Add pending parsing and return result.
  1388. (when partial (push (apply #'string (nreverse partial)) result))
  1389. (nreverse result))))
  1390. (defun org-babel-join-splits-near-ch (ch list)
  1391. "Join splits where \"=\" is on either end of the split."
  1392. (let ((last= (lambda (str) (= ch (aref str (1- (length str))))))
  1393. (first= (lambda (str) (= ch (aref str 0)))))
  1394. (reverse
  1395. (cl-reduce (lambda (acc el)
  1396. (let ((head (car acc)))
  1397. (if (and head (or (funcall last= head) (funcall first= el)))
  1398. (cons (concat head el) (cdr acc))
  1399. (cons el acc))))
  1400. list :initial-value nil))))
  1401. (defun org-babel-parse-header-arguments (string &optional no-eval)
  1402. "Parse header arguments in STRING.
  1403. When optional argument NO-EVAL is non-nil, do not evaluate Lisp
  1404. in parameters. Return an alist."
  1405. (when (org-string-nw-p string)
  1406. (org-babel-parse-multiple-vars
  1407. (delq nil
  1408. (mapcar
  1409. (lambda (arg)
  1410. (if (string-match
  1411. "\\([^ \f\t\n\r\v]+\\)[ \f\t\n\r\v]+\\([^ \f\t\n\r\v]+.*\\)"
  1412. arg)
  1413. (cons (intern (match-string 1 arg))
  1414. (org-babel-read (org-babel-chomp (match-string 2 arg))
  1415. no-eval))
  1416. (cons (intern (org-babel-chomp arg)) nil)))
  1417. (let ((raw (org-babel-balanced-split string '((32 9) . 58))))
  1418. (cons (car raw)
  1419. (mapcar (lambda (r) (concat ":" r)) (cdr raw)))))))))
  1420. (defun org-babel-parse-multiple-vars (header-arguments)
  1421. "Expand multiple variable assignments behind a single :var keyword.
  1422. This allows expression of multiple variables with one :var as
  1423. shown below.
  1424. #+PROPERTY: var foo=1, bar=2"
  1425. (let (results)
  1426. (mapc (lambda (pair)
  1427. (if (eq (car pair) :var)
  1428. (mapcar (lambda (v) (push (cons :var (org-trim v)) results))
  1429. (org-babel-join-splits-near-ch
  1430. 61 (org-babel-balanced-split (cdr pair) 32)))
  1431. (push pair results)))
  1432. header-arguments)
  1433. (nreverse results)))
  1434. (defun org-babel-process-params (params)
  1435. "Expand variables in PARAMS and add summary parameters."
  1436. (let* ((processed-vars (mapcar (lambda (el)
  1437. (if (consp el)
  1438. el
  1439. (org-babel-ref-parse el)))
  1440. (org-babel--get-vars params)))
  1441. (vars-and-names (if (and (assq :colname-names params)
  1442. (assq :rowname-names params))
  1443. (list processed-vars)
  1444. (org-babel-disassemble-tables
  1445. processed-vars
  1446. (cdr (assq :hlines params))
  1447. (cdr (assq :colnames params))
  1448. (cdr (assq :rownames params)))))
  1449. (raw-result (or (cdr (assq :results params)) ""))
  1450. (result-params (delete-dups
  1451. (append
  1452. (split-string (if (stringp raw-result)
  1453. raw-result
  1454. (eval raw-result t)))
  1455. (cdr (assq :result-params params))))))
  1456. (append
  1457. (mapcar (lambda (var) (cons :var var)) (car vars-and-names))
  1458. (list
  1459. (cons :colname-names (or (cdr (assq :colname-names params))
  1460. (cadr vars-and-names)))
  1461. (cons :rowname-names (or (cdr (assq :rowname-names params))
  1462. (cl-caddr vars-and-names)))
  1463. (cons :result-params result-params)
  1464. (cons :result-type (cond ((member "output" result-params) 'output)
  1465. ((member "value" result-params) 'value)
  1466. (t 'value))))
  1467. (cl-remove-if
  1468. (lambda (x) (memq (car x) '(:colname-names :rowname-names :result-params
  1469. :result-type :var)))
  1470. params))))
  1471. ;; row and column names
  1472. (defun org-babel-del-hlines (table)
  1473. "Remove all `hline's from TABLE."
  1474. (remq 'hline table))
  1475. (defun org-babel-get-colnames (table)
  1476. "Return the column names of TABLE.
  1477. Return a cons cell, the `car' of which contains the TABLE less
  1478. colnames, and the `cdr' of which contains a list of the column
  1479. names."
  1480. (if (eq 'hline (nth 1 table))
  1481. (cons (cddr table) (car table))
  1482. (cons (cdr table) (car table))))
  1483. (defun org-babel-get-rownames (table)
  1484. "Return the row names of TABLE.
  1485. Return a cons cell, the `car' of which contains the TABLE less
  1486. rownames, and the `cdr' of which contains a list of the rownames.
  1487. Note: this function removes any hlines in TABLE."
  1488. (let* ((table (org-babel-del-hlines table))
  1489. (rownames (funcall (lambda ()
  1490. (let ((tp table))
  1491. (mapcar
  1492. (lambda (_row)
  1493. (prog1
  1494. (pop (car tp))
  1495. (setq tp (cdr tp))))
  1496. table))))))
  1497. (cons table rownames)))
  1498. (defun org-babel-put-colnames (table colnames)
  1499. "Add COLNAMES to TABLE if they exist."
  1500. (if colnames (apply 'list colnames 'hline table) table))
  1501. (defun org-babel-put-rownames (table rownames)
  1502. "Add ROWNAMES to TABLE if they exist."
  1503. (if rownames
  1504. (mapcar (lambda (row)
  1505. (if (listp row)
  1506. (cons (or (pop rownames) "") row)
  1507. row)) table)
  1508. table))
  1509. (defun org-babel-pick-name (names selector)
  1510. "Select one out of an alist of row or column names.
  1511. SELECTOR can be either a list of names in which case those names
  1512. will be returned directly, or an index into the list NAMES in
  1513. which case the indexed names will be return."
  1514. (if (listp selector)
  1515. selector
  1516. (when names
  1517. (if (and selector (symbolp selector) (not (equal t selector)))
  1518. (cdr (assoc selector names))
  1519. (if (integerp selector)
  1520. (nth (- selector 1) names)
  1521. (cdr (car (last names))))))))
  1522. (defun org-babel-disassemble-tables (vars hlines colnames rownames)
  1523. "Parse tables for further processing.
  1524. Process the variables in VARS according to the HLINES,
  1525. ROWNAMES and COLNAMES header arguments. Return a list consisting
  1526. of the vars, cnames and rnames."
  1527. (let (cnames rnames)
  1528. (list
  1529. (mapcar
  1530. (lambda (var)
  1531. (when (listp (cdr var))
  1532. (when (and (not (equal colnames "no"))
  1533. (or colnames (and (eq (nth 1 (cdr var)) 'hline)
  1534. (not (member 'hline (cddr (cdr var)))))))
  1535. (let ((both (org-babel-get-colnames (cdr var))))
  1536. (setq cnames (cons (cons (car var) (cdr both))
  1537. cnames))
  1538. (setq var (cons (car var) (car both)))))
  1539. (when (and rownames (not (equal rownames "no")))
  1540. (let ((both (org-babel-get-rownames (cdr var))))
  1541. (setq rnames (cons (cons (car var) (cdr both))
  1542. rnames))
  1543. (setq var (cons (car var) (car both)))))
  1544. (when (and hlines (not (equal hlines "yes")))
  1545. (setq var (cons (car var) (org-babel-del-hlines (cdr var))))))
  1546. var)
  1547. vars)
  1548. (reverse cnames) (reverse rnames))))
  1549. (defun org-babel-reassemble-table (table colnames rownames)
  1550. "Add column and row names to a table.
  1551. Given a TABLE and set of COLNAMES and ROWNAMES add the names
  1552. to the table for reinsertion to org-mode."
  1553. (if (listp table)
  1554. (let ((table (if (and rownames (= (length table) (length rownames)))
  1555. (org-babel-put-rownames table rownames) table)))
  1556. (if (and colnames (listp (car table)) (= (length (car table))
  1557. (length colnames)))
  1558. (org-babel-put-colnames table colnames) table))
  1559. table))
  1560. (defun org-babel-where-is-src-block-head (&optional src-block)
  1561. "Find where the current source block begins.
  1562. If optional argument SRC-BLOCK is `src-block' type element, find
  1563. its current beginning instead.
  1564. Return the point at the beginning of the current source block.
  1565. Specifically at the beginning of the #+BEGIN_SRC line. Also set
  1566. match-data relatively to `org-babel-src-block-regexp', which see.
  1567. If the point is not on a source block then return nil."
  1568. (let ((element (or src-block (org-element-at-point))))
  1569. (when (eq (org-element-type element) 'src-block)
  1570. (let ((end (org-element-property :end element)))
  1571. (org-with-wide-buffer
  1572. ;; Ensure point is not on a blank line after the block.
  1573. (beginning-of-line)
  1574. (skip-chars-forward " \r\t\n" end)
  1575. (when (< (point) end)
  1576. (prog1 (goto-char (org-element-property :post-affiliated element))
  1577. (looking-at org-babel-src-block-regexp))))))))
  1578. ;;;###autoload
  1579. (defun org-babel-goto-src-block-head ()
  1580. "Go to the beginning of the current code block."
  1581. (interactive)
  1582. (let ((head (org-babel-where-is-src-block-head)))
  1583. (if head (goto-char head) (error "Not currently in a code block"))))
  1584. ;;;###autoload
  1585. (defun org-babel-goto-named-src-block (name)
  1586. "Go to a named source-code block."
  1587. (interactive
  1588. (let ((completion-ignore-case t)
  1589. (case-fold-search t)
  1590. (all-block-names (org-babel-src-block-names)))
  1591. (list (completing-read
  1592. "source-block name: " all-block-names nil t
  1593. (let* ((context (org-element-context))
  1594. (type (org-element-type context))
  1595. (noweb-ref
  1596. (and (memq type '(inline-src-block src-block))
  1597. (org-in-regexp (org-babel-noweb-wrap)))))
  1598. (cond
  1599. (noweb-ref
  1600. (buffer-substring
  1601. (+ (car noweb-ref) (length org-babel-noweb-wrap-start))
  1602. (- (cdr noweb-ref) (length org-babel-noweb-wrap-end))))
  1603. ((memq type '(babel-call inline-babel-call)) ;#+CALL:
  1604. (org-element-property :call context))
  1605. ((car (org-element-property :results context))) ;#+RESULTS:
  1606. ((let ((symbol (thing-at-point 'symbol))) ;Symbol.
  1607. (and symbol
  1608. (member-ignore-case symbol all-block-names)
  1609. symbol)))
  1610. (t "")))))))
  1611. (let ((point (org-babel-find-named-block name)))
  1612. (if point
  1613. ;; Taken from `org-open-at-point'.
  1614. (progn (org-mark-ring-push) (goto-char point) (org-show-context))
  1615. (message "source-code block `%s' not found in this buffer" name))))
  1616. (defun org-babel-find-named-block (name)
  1617. "Find a named source-code block.
  1618. Return the location of the source block identified by source
  1619. NAME, or nil if no such block exists. Set match data according
  1620. to `org-babel-named-src-block-regexp'."
  1621. (save-excursion
  1622. (goto-char (point-min))
  1623. (let ((regexp (org-babel-named-src-block-regexp-for-name name)))
  1624. (or (and (looking-at regexp)
  1625. (progn (goto-char (match-beginning 1))
  1626. (line-beginning-position)))
  1627. (ignore-errors (org-next-block 1 nil regexp))))))
  1628. (defun org-babel-src-block-names (&optional file)
  1629. "Returns the names of source blocks in FILE or the current buffer."
  1630. (with-current-buffer (if file (find-file-noselect file) (current-buffer))
  1631. (org-with-point-at 1
  1632. (let ((regexp "^[ \t]*#\\+begin_src ")
  1633. (case-fold-search t)
  1634. (names nil))
  1635. (while (re-search-forward regexp nil t)
  1636. (let ((element (org-element-at-point)))
  1637. (when (eq 'src-block (org-element-type element))
  1638. (let ((name (org-element-property :name element)))
  1639. (when name (push name names))))))
  1640. names))))
  1641. ;;;###autoload
  1642. (defun org-babel-goto-named-result (name)
  1643. "Go to a named result."
  1644. (interactive
  1645. (let ((completion-ignore-case t))
  1646. (list (completing-read "Source-block name: "
  1647. (org-babel-result-names) nil t))))
  1648. (let ((point (org-babel-find-named-result name)))
  1649. (if point
  1650. ;; taken from `org-open-at-point'
  1651. (progn (goto-char point) (org-show-context))
  1652. (message "result `%s' not found in this buffer" name))))
  1653. (defun org-babel-find-named-result (name)
  1654. "Find a named result.
  1655. Return the location of the result named NAME in the current
  1656. buffer or nil if no such result exists."
  1657. (save-excursion
  1658. (goto-char (point-min))
  1659. (let ((case-fold-search t)
  1660. (re (format "^[ \t]*#\\+%s.*?:[ \t]*%s[ \t]*$"
  1661. org-babel-results-keyword
  1662. (regexp-quote name))))
  1663. (catch :found
  1664. (while (re-search-forward re nil t)
  1665. (let ((element (org-element-at-point)))
  1666. (when (or (eq (org-element-type element) 'keyword)
  1667. (< (point)
  1668. (org-element-property :post-affiliated element)))
  1669. (throw :found (line-beginning-position)))))))))
  1670. (defun org-babel-result-names (&optional file)
  1671. "Returns the names of results in FILE or the current buffer."
  1672. (save-excursion
  1673. (when file (find-file file)) (goto-char (point-min))
  1674. (let ((case-fold-search t) names)
  1675. (while (re-search-forward org-babel-result-w-name-regexp nil t)
  1676. (setq names (cons (match-string-no-properties 9) names)))
  1677. names)))
  1678. ;;;###autoload
  1679. (defun org-babel-next-src-block (&optional arg)
  1680. "Jump to the next source block.
  1681. With optional prefix argument ARG, jump forward ARG many source blocks."
  1682. (interactive "p")
  1683. (org-next-block arg nil org-babel-src-block-regexp))
  1684. ;;;###autoload
  1685. (defun org-babel-previous-src-block (&optional arg)
  1686. "Jump to the previous source block.
  1687. With optional prefix argument ARG, jump backward ARG many source blocks."
  1688. (interactive "p")
  1689. (org-previous-block arg org-babel-src-block-regexp))
  1690. (defvar org-babel-load-languages)
  1691. ;;;###autoload
  1692. (defun org-babel-mark-block ()
  1693. "Mark current src block."
  1694. (interactive)
  1695. (let ((head (org-babel-where-is-src-block-head)))
  1696. (when head
  1697. (save-excursion
  1698. (goto-char head)
  1699. (looking-at org-babel-src-block-regexp))
  1700. (push-mark (match-end 5) nil t)
  1701. (goto-char (match-beginning 5)))))
  1702. (defun org-babel-demarcate-block (&optional arg)
  1703. "Wrap or split the code in the region or on the point.
  1704. When called from inside of a code block the current block is
  1705. split. When called from outside of a code block a new code block
  1706. is created. In both cases if the region is demarcated and if the
  1707. region is not active then the point is demarcated."
  1708. (interactive "P")
  1709. (let* ((info (org-babel-get-src-block-info 'light))
  1710. (start (org-babel-where-is-src-block-head))
  1711. (block (and start (match-string 0)))
  1712. (headers (and start (match-string 4)))
  1713. (stars (concat (make-string (or (org-current-level) 1) ?*) " "))
  1714. (lower-case-p (and block
  1715. (let (case-fold-search)
  1716. (string-match-p "#\\+begin_src" block)))))
  1717. (if info
  1718. (mapc
  1719. (lambda (place)
  1720. (save-excursion
  1721. (goto-char place)
  1722. (let ((lang (nth 0 info))
  1723. (indent (make-string (org-get-indentation) ?\s)))
  1724. (when (string-match "^[[:space:]]*$"
  1725. (buffer-substring (point-at-bol)
  1726. (point-at-eol)))
  1727. (delete-region (point-at-bol) (point-at-eol)))
  1728. (insert (concat
  1729. (if (looking-at "^") "" "\n")
  1730. indent (funcall (if lower-case-p 'downcase 'upcase) "#+end_src\n")
  1731. (if arg stars indent) "\n"
  1732. indent (funcall (if lower-case-p 'downcase 'upcase) "#+begin_src ")
  1733. lang
  1734. (if (> (length headers) 1)
  1735. (concat " " headers) headers)
  1736. (if (looking-at "[\n\r]")
  1737. ""
  1738. (concat "\n" (make-string (current-column) ? )))))))
  1739. (move-end-of-line 2))
  1740. (sort (if (org-region-active-p) (list (mark) (point)) (list (point))) #'>))
  1741. (let ((start (point))
  1742. (lang (completing-read
  1743. "Lang: "
  1744. (mapcar #'symbol-name
  1745. (delete-dups
  1746. (append (mapcar #'car org-babel-load-languages)
  1747. (mapcar (lambda (el) (intern (car el)))
  1748. org-src-lang-modes))))))
  1749. (body (delete-and-extract-region
  1750. (if (org-region-active-p) (mark) (point)) (point))))
  1751. (insert (concat (if (looking-at "^") "" "\n")
  1752. (if arg (concat stars "\n") "")
  1753. (funcall (if lower-case-p 'downcase 'upcase) "#+begin_src ")
  1754. lang "\n"
  1755. body
  1756. (if (or (= (length body) 0)
  1757. (string-suffix-p "\r" body)
  1758. (string-suffix-p "\n" body)) "" "\n")
  1759. (funcall (if lower-case-p 'downcase 'upcase) "#+end_src\n")))
  1760. (goto-char start) (move-end-of-line 1)))))
  1761. (defun org-babel--insert-results-keyword (name hash)
  1762. "Insert RESULTS keyword with NAME value at point.
  1763. If NAME is nil, results are anonymous. HASH is a string used as
  1764. the results hash, or nil. Leave point before the keyword."
  1765. (save-excursion (insert "\n")) ;open line to indent.
  1766. (org-indent-line)
  1767. (delete-char 1)
  1768. (insert (concat "#+" org-babel-results-keyword
  1769. (cond ((not hash) nil)
  1770. (org-babel-hash-show-time
  1771. (format "[%s %s]"
  1772. (format-time-string "<%F %T>")
  1773. hash))
  1774. (t (format "[%s]" hash)))
  1775. ":"
  1776. (when name (concat " " name))
  1777. "\n"))
  1778. ;; Make sure results are going to be followed by at least one blank
  1779. ;; line so they do not get merged with the next element, e.g.,
  1780. ;;
  1781. ;; #+results:
  1782. ;; : 1
  1783. ;;
  1784. ;; : fixed-width area, unrelated to the above.
  1785. (unless (looking-at "^[ \t]*$") (save-excursion (insert "\n")))
  1786. (beginning-of-line 0)
  1787. (when hash (org-babel-hide-hash)))
  1788. (defun org-babel--clear-results-maybe (hash)
  1789. "Clear results when hash doesn't match HASH.
  1790. When results hash does not match HASH, remove RESULTS keyword at
  1791. point, along with related contents. Do nothing if HASH is nil.
  1792. Return a non-nil value if results were cleared. In this case,
  1793. leave point where new results should be inserted."
  1794. (when hash
  1795. (looking-at org-babel-result-regexp)
  1796. (unless (string= (match-string 1) hash)
  1797. (let* ((e (org-element-at-point))
  1798. (post (copy-marker (org-element-property :post-affiliated e))))
  1799. ;; Delete contents.
  1800. (delete-region post
  1801. (save-excursion
  1802. (goto-char (org-element-property :end e))
  1803. (skip-chars-backward " \t\n")
  1804. (line-beginning-position 2)))
  1805. ;; Delete RESULT keyword. However, if RESULTS keyword is
  1806. ;; orphaned, ignore this part. The deletion above already
  1807. ;; took care of it.
  1808. (unless (= (point) post)
  1809. (delete-region (line-beginning-position)
  1810. (line-beginning-position 2)))
  1811. (goto-char post)
  1812. (set-marker post nil)
  1813. t))))
  1814. (defun org-babel-where-is-src-block-result (&optional insert _info hash)
  1815. "Find where the current source block results begin.
  1816. Return the point at the beginning of the result of the current
  1817. source block, specifically at the beginning of the results line.
  1818. If no result exists for this block return nil, unless optional
  1819. argument INSERT is non-nil. In this case, create a results line
  1820. following the source block and return the position at its
  1821. beginning. In the case of inline code, remove the results part
  1822. instead.
  1823. If optional argument HASH is a string, remove contents related to
  1824. RESULTS keyword if its hash is different. Then update the latter
  1825. to HASH."
  1826. (let ((context (org-element-context)))
  1827. (catch :found
  1828. (org-with-wide-buffer
  1829. (pcase (org-element-type context)
  1830. ((or `inline-babel-call `inline-src-block)
  1831. ;; Results for inline objects are located right after them.
  1832. ;; There is no RESULTS line to insert either.
  1833. (let ((limit (org-element-property
  1834. :contents-end (org-element-property :parent context))))
  1835. (goto-char (org-element-property :end context))
  1836. (skip-chars-forward " \t\n" limit)
  1837. (throw :found
  1838. (and
  1839. (< (point) limit)
  1840. (let ((result (org-element-context)))
  1841. (and (eq (org-element-type result) 'macro)
  1842. (string= (org-element-property :key result)
  1843. "results")
  1844. (if (not insert) (point)
  1845. (delete-region
  1846. (point)
  1847. (progn
  1848. (goto-char (org-element-property :end result))
  1849. (skip-chars-backward " \t")
  1850. (point)))
  1851. (point))))))))
  1852. ((or `babel-call `src-block)
  1853. (let* ((name (org-element-property :name context))
  1854. (named-results (and name (org-babel-find-named-result name))))
  1855. (goto-char (or named-results (org-element-property :end context)))
  1856. (cond
  1857. ;; Existing results named after the current source.
  1858. (named-results
  1859. (when (org-babel--clear-results-maybe hash)
  1860. (org-babel--insert-results-keyword name hash))
  1861. (throw :found (point)))
  1862. ;; Named results expect but none to be found.
  1863. (name)
  1864. ;; No possible anonymous results at the very end of
  1865. ;; buffer or outside CONTEXT parent.
  1866. ((eq (point)
  1867. (or (org-element-property
  1868. :contents-end (org-element-property :parent context))
  1869. (point-max))))
  1870. ;; Check if next element is an anonymous result below
  1871. ;; the current block.
  1872. ((let* ((next (org-element-at-point))
  1873. (end (save-excursion
  1874. (goto-char
  1875. (org-element-property :post-affiliated next))
  1876. (line-end-position)))
  1877. (empty-result-re (concat org-babel-result-regexp "$"))
  1878. (case-fold-search t))
  1879. (re-search-forward empty-result-re end t))
  1880. (beginning-of-line)
  1881. (when (org-babel--clear-results-maybe hash)
  1882. (org-babel--insert-results-keyword nil hash))
  1883. (throw :found (point))))))
  1884. ;; Ignore other elements.
  1885. (_ (throw :found nil))))
  1886. ;; No result found. Insert a RESULTS keyword below element, if
  1887. ;; appropriate. In this case, ensure there is an empty line
  1888. ;; after the previous element.
  1889. (when insert
  1890. (save-excursion
  1891. (goto-char (min (org-element-property :end context) (point-max)))
  1892. (skip-chars-backward " \t\n")
  1893. (forward-line)
  1894. (unless (bolp) (insert "\n"))
  1895. (insert "\n")
  1896. (org-babel--insert-results-keyword
  1897. (org-element-property :name context) hash)
  1898. (point))))))
  1899. (defun org-babel-read-element (element)
  1900. "Read ELEMENT into emacs-lisp.
  1901. Return nil if ELEMENT cannot be read."
  1902. (org-with-wide-buffer
  1903. (goto-char (org-element-property :post-affiliated element))
  1904. (pcase (org-element-type element)
  1905. (`fixed-width
  1906. (let ((v (org-trim (org-element-property :value element))))
  1907. (or (org-babel--string-to-number v) v)))
  1908. (`table (org-babel-read-table))
  1909. (`plain-list (org-babel-read-list))
  1910. (`example-block
  1911. (let ((v (org-element-property :value element)))
  1912. (if (or org-src-preserve-indentation
  1913. (org-element-property :preserve-indent element))
  1914. v
  1915. (org-remove-indentation v))))
  1916. (`export-block
  1917. (org-remove-indentation (org-element-property :value element)))
  1918. (`paragraph
  1919. ;; Treat paragraphs containing a single link specially.
  1920. (skip-chars-forward " \t")
  1921. (if (and (looking-at org-bracket-link-regexp)
  1922. (save-excursion
  1923. (goto-char (match-end 0))
  1924. (skip-chars-forward " \r\t\n")
  1925. (<= (org-element-property :end element)
  1926. (point))))
  1927. (org-babel-read-link)
  1928. (buffer-substring-no-properties
  1929. (org-element-property :contents-begin element)
  1930. (org-element-property :contents-end element))))
  1931. ((or `center-block `quote-block `verse-block `special-block)
  1932. (org-remove-indentation
  1933. (buffer-substring-no-properties
  1934. (org-element-property :contents-begin element)
  1935. (org-element-property :contents-end element))))
  1936. (_ nil))))
  1937. (defun org-babel-read-result ()
  1938. "Read the result at point into emacs-lisp."
  1939. (and (not (save-excursion
  1940. (beginning-of-line)
  1941. (looking-at-p "[ \t]*$")))
  1942. (org-babel-read-element (org-element-at-point))))
  1943. (defun org-babel-read-table ()
  1944. "Read the table at point into emacs-lisp."
  1945. (mapcar (lambda (row)
  1946. (if (and (symbolp row) (equal row 'hline)) row
  1947. (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval)) row)))
  1948. (org-table-to-lisp)))
  1949. (defun org-babel-read-list ()
  1950. "Read the list at point into emacs-lisp."
  1951. (mapcar (lambda (el) (org-babel-read el 'inhibit-lisp-eval))
  1952. (cdr (org-list-to-lisp))))
  1953. (defvar org-link-types-re)
  1954. (defun org-babel-read-link ()
  1955. "Read the link at point into emacs-lisp.
  1956. If the path of the link is a file path it is expanded using
  1957. `expand-file-name'."
  1958. (let* ((case-fold-search t)
  1959. (raw (and (looking-at org-bracket-link-regexp)
  1960. (org-no-properties (match-string 1))))
  1961. (type (and (string-match org-link-types-re raw)
  1962. (match-string 1 raw))))
  1963. (cond
  1964. ((not type) (expand-file-name raw))
  1965. ((string= type "file")
  1966. (and (string-match "file\\(.*\\):\\(.+\\)" raw)
  1967. (expand-file-name (match-string 2 raw))))
  1968. (t raw))))
  1969. (defun org-babel-format-result (result &optional sep)
  1970. "Format RESULT for writing to file."
  1971. (let ((echo-res (lambda (r) (if (stringp r) r (format "%S" r)))))
  1972. (if (listp result)
  1973. ;; table result
  1974. (orgtbl-to-generic
  1975. result (list :sep (or sep "\t") :fmt echo-res))
  1976. ;; scalar result
  1977. (funcall echo-res result))))
  1978. (defun org-babel-insert-result (result &optional result-params info hash lang)
  1979. "Insert RESULT into the current buffer.
  1980. By default RESULT is inserted after the end of the current source
  1981. block. The RESULT of an inline source block usually will be
  1982. wrapped inside a `results' macro and placed on the same line as
  1983. the inline source block. The macro is stripped upon export.
  1984. Multiline and non-scalar RESULTS from inline source blocks are
  1985. not allowed. With optional argument RESULT-PARAMS controls
  1986. insertion of results in the Org mode file. RESULT-PARAMS can
  1987. take the following values:
  1988. replace - (default option) insert results after the source block
  1989. or inline source block replacing any previously
  1990. inserted results.
  1991. silent -- no results are inserted into the Org buffer but
  1992. the results are echoed to the minibuffer and are
  1993. ingested by Emacs (a potentially time consuming
  1994. process).
  1995. file ---- the results are interpreted as a file path, and are
  1996. inserted into the buffer using the Org file syntax.
  1997. list ---- the results are interpreted as an Org list.
  1998. raw ----- results are added directly to the Org file. This is
  1999. a good option if you code block will output Org
  2000. formatted text.
  2001. drawer -- results are added directly to the Org file as with
  2002. \"raw\", but are wrapped in a RESULTS drawer or results
  2003. macro, allowing them to later be replaced or removed
  2004. automatically.
  2005. org ----- results are added inside of a \"src_org{}\" or \"#+BEGIN_SRC
  2006. org\" block depending on whether the current source block is
  2007. inline or not. They are not comma-escaped when inserted,
  2008. but Org syntax here will be discarded when exporting the
  2009. file.
  2010. html ---- results are added inside of a #+BEGIN_EXPORT HTML block
  2011. or html export snippet depending on whether the current
  2012. source block is inline or not. This is a good option
  2013. if your code block will output html formatted text.
  2014. latex --- results are added inside of a #+BEGIN_EXPORT LATEX
  2015. block or latex export snippet depending on whether the
  2016. current source block is inline or not. This is a good
  2017. option if your code block will output latex formatted
  2018. text.
  2019. code ---- the results are extracted in the syntax of the source
  2020. code of the language being evaluated and are added
  2021. inside of a source block with the source-code language
  2022. set appropriately. Also, source block inlining is
  2023. preserved in this case. Note this relies on the
  2024. optional LANG argument.
  2025. list ---- the results are rendered as a list. This option not
  2026. allowed for inline src blocks.
  2027. table --- the results are rendered as a table. This option not
  2028. allowed for inline src blocks.
  2029. INFO may provide the values of these header arguments (in the
  2030. `header-arguments-alist' see the docstring for
  2031. `org-babel-get-src-block-info'):
  2032. :file --- the name of the file to which output should be written.
  2033. :wrap --- the effect is similar to `latex' in RESULT-PARAMS but
  2034. using the argument supplied to specify the export block
  2035. or snippet type."
  2036. (cond ((stringp result)
  2037. (setq result (org-no-properties result))
  2038. (when (member "file" result-params)
  2039. (setq result (org-babel-result-to-file
  2040. result (when (assq :file-desc (nth 2 info))
  2041. (or (cdr (assq :file-desc (nth 2 info)))
  2042. result))))))
  2043. ((listp result))
  2044. (t (setq result (format "%S" result))))
  2045. (if (and result-params (member "silent" result-params))
  2046. (progn (message (replace-regexp-in-string "%" "%%" (format "%S" result)))
  2047. result)
  2048. (let ((inline (let ((context (org-element-context)))
  2049. (and (memq (org-element-type context)
  2050. '(inline-babel-call inline-src-block))
  2051. context))))
  2052. (when inline
  2053. (let ((warning
  2054. (or (and (member "table" result-params) "`:results table'")
  2055. (and (listp result) "list result")
  2056. (and (string-match-p "\n." result) "multiline result")
  2057. (and (member "list" result-params) "`:results list'"))))
  2058. (when warning
  2059. (user-error "Inline error: %s cannot be used" warning))))
  2060. (save-excursion
  2061. (let* ((visible-beg (point-min-marker))
  2062. (visible-end (copy-marker (point-max) t))
  2063. (inline (let ((context (org-element-context)))
  2064. (and (memq (org-element-type context)
  2065. '(inline-babel-call inline-src-block))
  2066. context)))
  2067. (existing-result (org-babel-where-is-src-block-result t nil hash))
  2068. (results-switches (cdr (assq :results_switches (nth 2 info))))
  2069. ;; When results exist outside of the current visible
  2070. ;; region of the buffer, be sure to widen buffer to
  2071. ;; update them.
  2072. (outside-scope (and existing-result
  2073. (buffer-narrowed-p)
  2074. (or (> visible-beg existing-result)
  2075. (<= visible-end existing-result))))
  2076. beg end indent)
  2077. ;; Ensure non-inline results end in a newline.
  2078. (when (and (org-string-nw-p result)
  2079. (not inline)
  2080. (not (string-equal (substring result -1) "\n")))
  2081. (setq result (concat result "\n")))
  2082. (unwind-protect
  2083. (progn
  2084. (when outside-scope (widen))
  2085. (if existing-result (goto-char existing-result)
  2086. (goto-char (org-element-property :end inline))
  2087. (skip-chars-backward " \t"))
  2088. (unless inline
  2089. (setq indent (org-get-indentation))
  2090. (forward-line 1))
  2091. (setq beg (point))
  2092. (cond
  2093. (inline
  2094. ;; Make sure new results are separated from the
  2095. ;; source code by one space.
  2096. (unless existing-result
  2097. (insert " ")
  2098. (setq beg (point))))
  2099. ((member "replace" result-params)
  2100. (delete-region (point) (org-babel-result-end)))
  2101. ((member "append" result-params)
  2102. (goto-char (org-babel-result-end)) (setq beg (point-marker)))
  2103. ((member "prepend" result-params))) ; already there
  2104. (setq results-switches
  2105. (if results-switches (concat " " results-switches) ""))
  2106. (let ((wrap
  2107. (lambda (start finish &optional no-escape no-newlines
  2108. inline-start inline-finish)
  2109. (when inline
  2110. (setq start inline-start)
  2111. (setq finish inline-finish)
  2112. (setq no-newlines t))
  2113. (let ((before-finish (marker-position end)))
  2114. (goto-char end)
  2115. (insert (concat finish (unless no-newlines "\n")))
  2116. (goto-char beg)
  2117. (insert (concat start (unless no-newlines "\n")))
  2118. (unless no-escape
  2119. (org-escape-code-in-region
  2120. (min (point) before-finish) before-finish))
  2121. (goto-char end))))
  2122. (tabulablep
  2123. (lambda (r)
  2124. ;; Non-nil when result R can be turned into
  2125. ;; a table.
  2126. (and (listp r)
  2127. (null (cdr (last r)))
  2128. (cl-every
  2129. (lambda (e) (or (atom e) (null (cdr (last e)))))
  2130. result)))))
  2131. ;; insert results based on type
  2132. (cond
  2133. ;; Do nothing for an empty result.
  2134. ((null result))
  2135. ;; Insert a list if preferred.
  2136. ((member "list" result-params)
  2137. (insert
  2138. (org-trim
  2139. (org-list-to-generic
  2140. (cons 'unordered
  2141. (mapcar
  2142. (lambda (e)
  2143. (list (if (stringp e) e (format "%S" e))))
  2144. (if (listp result) result
  2145. (split-string result "\n" t))))
  2146. '(:splicep nil :istart "- " :iend "\n")))
  2147. "\n"))
  2148. ;; Try hard to print RESULT as a table. Give up if
  2149. ;; it contains an improper list.
  2150. ((funcall tabulablep result)
  2151. (goto-char beg)
  2152. (insert (concat (orgtbl-to-orgtbl
  2153. (if (cl-every
  2154. (lambda (e)
  2155. (or (eq e 'hline) (listp e)))
  2156. result)
  2157. result
  2158. (list result))
  2159. nil)
  2160. "\n"))
  2161. (goto-char beg)
  2162. (when (org-at-table-p) (org-table-align))
  2163. (goto-char (org-table-end)))
  2164. ;; Print verbatim a list that cannot be turned into
  2165. ;; a table.
  2166. ((listp result) (insert (format "%s\n" result)))
  2167. ((member "file" result-params)
  2168. (when inline
  2169. (setq result (org-macro-escape-arguments result)))
  2170. (insert result))
  2171. ((and inline (not (member "raw" result-params)))
  2172. (insert (org-macro-escape-arguments
  2173. (org-babel-chomp result "\n"))))
  2174. (t (goto-char beg) (insert result)))
  2175. (setq end (copy-marker (point) t))
  2176. ;; possibly wrap result
  2177. (cond
  2178. ((assq :wrap (nth 2 info))
  2179. (let ((name (or (cdr (assq :wrap (nth 2 info))) "results")))
  2180. (funcall wrap (concat "#+begin_" name)
  2181. (concat "#+end_" (car (split-string name)))
  2182. nil nil (concat "{{{results(@@" name ":") "@@)}}}")))
  2183. ((member "html" result-params)
  2184. (funcall wrap "#+begin_export html" "#+end_export" nil nil
  2185. "{{{results(@@html:" "@@)}}}"))
  2186. ((member "latex" result-params)
  2187. (funcall wrap "#+begin_export latex" "#+end_export" nil nil
  2188. "{{{results(@@latex:" "@@)}}}"))
  2189. ((member "org" result-params)
  2190. (goto-char beg) (when (org-at-table-p) (org-cycle))
  2191. (funcall wrap "#+begin_src org" "#+end_src" nil nil
  2192. "{{{results(src_org{" "})}}}"))
  2193. ((member "code" result-params)
  2194. (let ((lang (or lang "none")))
  2195. (funcall wrap (format "#+begin_src %s%s" lang results-switches)
  2196. "#+end_src" nil nil
  2197. (format "{{{results(src_%s[%s]{" lang results-switches)
  2198. "})}}}")))
  2199. ((member "raw" result-params)
  2200. (goto-char beg) (when (org-at-table-p) (org-cycle)))
  2201. ((or (member "drawer" result-params)
  2202. ;; Stay backward compatible with <7.9.2
  2203. (member "wrap" result-params))
  2204. (goto-char beg) (when (org-at-table-p) (org-cycle))
  2205. (funcall wrap ":results:" ":end:" 'no-escape nil
  2206. "{{{results(" ")}}}"))
  2207. ((and inline (member "file" result-params))
  2208. (funcall wrap nil nil nil nil "{{{results(" ")}}}"))
  2209. ((and (not (funcall tabulablep result))
  2210. (not (member "file" result-params)))
  2211. (let ((org-babel-inline-result-wrap
  2212. ;; Hard code {{{results(...)}}} on top of
  2213. ;; customization.
  2214. (format "{{{results(%s)}}}"
  2215. org-babel-inline-result-wrap)))
  2216. (org-babel-examplify-region
  2217. beg end results-switches inline)))))
  2218. ;; Possibly indent results in par with #+results line.
  2219. (when (and (not inline) (numberp indent) (> indent 0)
  2220. ;; In this case `table-align' does the work
  2221. ;; for us.
  2222. (not (and (listp result)
  2223. (member "append" result-params))))
  2224. (indent-rigidly beg end indent))
  2225. (if (null result)
  2226. (if (member "value" result-params)
  2227. (message "Code block returned no value.")
  2228. (message "Code block produced no output."))
  2229. (message "Code block evaluation complete.")))
  2230. (set-marker end nil)
  2231. (when outside-scope (narrow-to-region visible-beg visible-end))
  2232. (set-marker visible-beg nil)
  2233. (set-marker visible-end nil)))))))
  2234. (defun org-babel-remove-result (&optional info keep-keyword)
  2235. "Remove the result of the current source block."
  2236. (interactive)
  2237. (let ((location (org-babel-where-is-src-block-result nil info)))
  2238. (when location
  2239. (save-excursion
  2240. (goto-char location)
  2241. (when (looking-at (concat org-babel-result-regexp ".*$"))
  2242. (delete-region
  2243. (if keep-keyword (line-beginning-position 2)
  2244. (save-excursion
  2245. (skip-chars-backward " \r\t\n")
  2246. (line-beginning-position 2)))
  2247. (progn (forward-line) (org-babel-result-end))))))))
  2248. (defun org-babel-remove-inline-result (&optional datum)
  2249. "Remove the result of the current inline-src-block or babel call.
  2250. The result must be wrapped in a `results' macro to be removed.
  2251. Leading white space is trimmed."
  2252. (interactive)
  2253. (let* ((el (or datum (org-element-context))))
  2254. (when (memq (org-element-type el) '(inline-src-block inline-babel-call))
  2255. (org-with-wide-buffer
  2256. (goto-char (org-element-property :end el))
  2257. (skip-chars-backward " \t")
  2258. (let ((result (save-excursion
  2259. (skip-chars-forward
  2260. " \t\n"
  2261. (org-element-property
  2262. :contents-end (org-element-property :parent el)))
  2263. (org-element-context))))
  2264. (when (and (eq (org-element-type result) 'macro)
  2265. (string= (org-element-property :key result) "results"))
  2266. (delete-region ; And leading whitespace.
  2267. (point)
  2268. (progn (goto-char (org-element-property :end result))
  2269. (skip-chars-backward " \t\n")
  2270. (point)))))))))
  2271. (defun org-babel-remove-result-one-or-many (x)
  2272. "Remove the result of the current source block.
  2273. If called with a prefix argument, remove all result blocks
  2274. in the buffer."
  2275. (interactive "P")
  2276. (if x
  2277. (org-babel-map-src-blocks nil (org-babel-remove-result))
  2278. (org-babel-remove-result)))
  2279. (defun org-babel-result-end ()
  2280. "Return the point at the end of the current set of results."
  2281. (cond ((looking-at-p "^[ \t]*$") (point)) ;no result
  2282. ((looking-at-p (format "^[ \t]*%s[ \t]*$" org-bracket-link-regexp))
  2283. (line-beginning-position 2))
  2284. (t
  2285. (let ((element (org-element-at-point)))
  2286. (if (memq (org-element-type element)
  2287. ;; Possible results types.
  2288. '(drawer example-block export-block fixed-width item
  2289. plain-list src-block table))
  2290. (save-excursion
  2291. (goto-char (min (point-max) ;for narrowed buffers
  2292. (org-element-property :end element)))
  2293. (skip-chars-backward " \r\t\n")
  2294. (line-beginning-position 2))
  2295. (point))))))
  2296. (defun org-babel-result-to-file (result &optional description)
  2297. "Convert RESULT into an Org link with optional DESCRIPTION.
  2298. If the `default-directory' is different from the containing
  2299. file's directory then expand relative links."
  2300. (when (stringp result)
  2301. (format "[[file:%s]%s]"
  2302. (if (and default-directory
  2303. buffer-file-name
  2304. (not (string= (expand-file-name default-directory)
  2305. (expand-file-name
  2306. (file-name-directory buffer-file-name)))))
  2307. (expand-file-name result default-directory)
  2308. result)
  2309. (if description (concat "[" description "]") ""))))
  2310. (defun org-babel-examplify-region (beg end &optional results-switches inline)
  2311. "Comment out region using the inline `==' or `: ' org example quote."
  2312. (interactive "*r")
  2313. (let ((maybe-cap
  2314. (lambda (str)
  2315. (if org-babel-uppercase-example-markers (upcase str) str))))
  2316. (if inline
  2317. (save-excursion
  2318. (goto-char beg)
  2319. (insert (format org-babel-inline-result-wrap
  2320. (delete-and-extract-region beg end))))
  2321. (let ((size (count-lines beg end)))
  2322. (save-excursion
  2323. (cond ((= size 0)) ; do nothing for an empty result
  2324. ((< size org-babel-min-lines-for-block-output)
  2325. (goto-char beg)
  2326. (dotimes (_ size)
  2327. (beginning-of-line 1) (insert ": ") (forward-line 1)))
  2328. (t
  2329. (goto-char beg)
  2330. (insert (if results-switches
  2331. (format "%s%s\n"
  2332. (funcall maybe-cap "#+begin_example")
  2333. results-switches)
  2334. (funcall maybe-cap "#+begin_example\n")))
  2335. (let ((p (point)))
  2336. (if (markerp end) (goto-char end) (forward-char (- end beg)))
  2337. (org-escape-code-in-region p (point)))
  2338. (insert (funcall maybe-cap "#+end_example\n")))))))))
  2339. (defun org-babel-update-block-body (new-body)
  2340. "Update the body of the current code block to NEW-BODY."
  2341. (let ((element (org-element-at-point)))
  2342. (unless (eq (org-element-type element) 'src-block)
  2343. (error "Not in a source block"))
  2344. (goto-char (org-babel-where-is-src-block-head element))
  2345. (let* ((ind (org-get-indentation))
  2346. (body-start (line-beginning-position 2))
  2347. (body (org-element-normalize-string
  2348. (if (or org-src-preserve-indentation
  2349. (org-element-property :preserve-indent element))
  2350. new-body
  2351. (with-temp-buffer
  2352. (insert (org-remove-indentation new-body))
  2353. (indent-rigidly
  2354. (point-min)
  2355. (point-max)
  2356. (+ ind org-edit-src-content-indentation))
  2357. (buffer-string))))))
  2358. (delete-region body-start
  2359. (org-with-wide-buffer
  2360. (goto-char (org-element-property :end element))
  2361. (skip-chars-backward " \t\n")
  2362. (line-beginning-position)))
  2363. (goto-char body-start)
  2364. (insert body))))
  2365. (defun org-babel-merge-params (&rest plists)
  2366. "Combine all parameter association lists in PLISTS.
  2367. Later elements of PLISTS override the values of previous elements.
  2368. This takes into account some special considerations for certain
  2369. parameters when merging lists."
  2370. (let* ((results-exclusive-groups
  2371. (mapcar (lambda (group) (mapcar #'symbol-name group))
  2372. (cdr (assq 'results org-babel-common-header-args-w-values))))
  2373. (exports-exclusive-groups
  2374. (mapcar (lambda (group) (mapcar #'symbol-name group))
  2375. (cdr (assq 'exports org-babel-common-header-args-w-values))))
  2376. (merge
  2377. (lambda (exclusive-groups &rest result-params)
  2378. ;; Maintain exclusivity of mutually exclusive parameters,
  2379. ;; as defined in EXCLUSIVE-GROUPS while merging lists in
  2380. ;; RESULT-PARAMS.
  2381. (let (output)
  2382. (dolist (new-params result-params (delete-dups output))
  2383. (dolist (new-param new-params)
  2384. (dolist (exclusive-group exclusive-groups)
  2385. (when (member new-param exclusive-group)
  2386. (setq output (cl-remove-if
  2387. (lambda (o) (member o exclusive-group))
  2388. output))))
  2389. (push new-param output))))))
  2390. (variable-index 0) ;Handle positional arguments.
  2391. clearnames
  2392. params ;Final parameters list.
  2393. ;; Some keywords accept multiple values. We need to treat
  2394. ;; them specially.
  2395. vars results exports)
  2396. (dolist (plist plists)
  2397. (dolist (pair plist)
  2398. (pcase pair
  2399. (`(:var . ,value)
  2400. (let ((name (cond
  2401. ((listp value) (car value))
  2402. ((string-match "^\\([^= \f\t\n\r\v]+\\)[ \t]*=" value)
  2403. (intern (match-string 1 value)))
  2404. (t nil))))
  2405. (cond
  2406. (name
  2407. (setq vars
  2408. (append (if (not (assoc name vars)) vars
  2409. (push name clearnames)
  2410. (cl-remove-if (lambda (p) (equal name (car p)))
  2411. vars))
  2412. (list (cons name pair)))))
  2413. ((and vars (nth variable-index vars))
  2414. ;; If no name is given and we already have named
  2415. ;; variables then assign to named variables in order.
  2416. (let ((name (car (nth variable-index vars))))
  2417. ;; Clear out colnames and rownames for replace vars.
  2418. (push name clearnames)
  2419. (setf (cddr (nth variable-index vars))
  2420. (concat (symbol-name name) "=" value))
  2421. (cl-incf variable-index)))
  2422. (t (error "Variable \"%s\" must be assigned a default value"
  2423. (cdr pair))))))
  2424. (`(:results . ,value)
  2425. (setq results (funcall merge
  2426. results-exclusive-groups
  2427. results
  2428. (split-string
  2429. (if (stringp value) value (eval value t))))))
  2430. (`(,(or :file :file-ext) . ,value)
  2431. ;; `:file' and `:file-ext' are regular keywords but they
  2432. ;; imply a "file" `:results' and a "results" `:exports'.
  2433. (when value
  2434. (setq results
  2435. (funcall merge results-exclusive-groups results '("file")))
  2436. (unless (or (member "both" exports)
  2437. (member "none" exports)
  2438. (member "code" exports))
  2439. (setq exports
  2440. (funcall merge
  2441. exports-exclusive-groups exports '("results"))))
  2442. (push pair params)))
  2443. (`(:exports . ,value)
  2444. (setq exports (funcall merge
  2445. exports-exclusive-groups
  2446. exports
  2447. (split-string (or value "")))))
  2448. ;; Regular keywords: any value overwrites the previous one.
  2449. (_ (setq params (cons pair (assq-delete-all (car pair) params)))))))
  2450. ;; Handle `:var' and clear out colnames and rownames for replaced
  2451. ;; variables.
  2452. (setq params (nconc (mapcar (lambda (v) (cons :var (cddr v))) vars)
  2453. params))
  2454. (dolist (name clearnames)
  2455. (dolist (param '(:colname-names :rowname-names))
  2456. (when (assq param params)
  2457. (setf (cdr (assq param params))
  2458. (cl-remove-if (lambda (pair) (equal name (car pair)))
  2459. (cdr (assq param params))))
  2460. (setq params
  2461. (cl-remove-if (lambda (pair) (and (equal (car pair) param)
  2462. (null (cdr pair))))
  2463. params)))))
  2464. ;; Handle other special keywords, which accept multiple values.
  2465. (setq params (nconc (list (cons :results (mapconcat #'identity results " "))
  2466. (cons :exports (mapconcat #'identity exports " ")))
  2467. params))
  2468. ;; Return merged params.
  2469. params))
  2470. (defun org-babel-noweb-p (params context)
  2471. "Check if PARAMS require expansion in CONTEXT.
  2472. CONTEXT may be one of :tangle, :export or :eval."
  2473. (let ((allowed-values (cl-case context
  2474. (:tangle '("yes" "tangle" "no-export" "strip-export"))
  2475. (:eval '("yes" "no-export" "strip-export" "eval"))
  2476. (:export '("yes")))))
  2477. (cl-some (lambda (v) (member v allowed-values))
  2478. (split-string (or (cdr (assq :noweb params)) "")))))
  2479. (defun org-babel-expand-noweb-references (&optional info parent-buffer)
  2480. "Expand Noweb references in the body of the current source code block.
  2481. For example the following reference would be replaced with the
  2482. body of the source-code block named `example-block'.
  2483. <<example-block>>
  2484. Note that any text preceding the <<foo>> construct on a line will
  2485. be interposed between the lines of the replacement text. So for
  2486. example if <<foo>> is placed behind a comment, then the entire
  2487. replacement text will also be commented.
  2488. This function must be called from inside of the buffer containing
  2489. the source-code block which holds BODY.
  2490. In addition the following syntax can be used to insert the
  2491. results of evaluating the source-code block named `example-block'.
  2492. <<example-block()>>
  2493. Any optional arguments can be passed to example-block by placing
  2494. the arguments inside the parenthesis following the convention
  2495. defined by `org-babel-lob'. For example
  2496. <<example-block(a=9)>>
  2497. would set the value of argument \"a\" equal to \"9\". Note that
  2498. these arguments are not evaluated in the current source-code
  2499. block but are passed literally to the \"example-block\"."
  2500. (let* ((parent-buffer (or parent-buffer (current-buffer)))
  2501. (info (or info (org-babel-get-src-block-info 'light)))
  2502. (lang (nth 0 info))
  2503. (body (nth 1 info))
  2504. (ob-nww-start org-babel-noweb-wrap-start)
  2505. (ob-nww-end org-babel-noweb-wrap-end)
  2506. (new-body "")
  2507. (nb-add (lambda (text) (setq new-body (concat new-body text))))
  2508. index source-name evaluate prefix)
  2509. (with-temp-buffer
  2510. (setq-local org-babel-noweb-wrap-start ob-nww-start)
  2511. (setq-local org-babel-noweb-wrap-end ob-nww-end)
  2512. (insert body) (goto-char (point-min))
  2513. (setq index (point))
  2514. (while (and (re-search-forward (org-babel-noweb-wrap) nil t))
  2515. (save-match-data (setf source-name (match-string 1)))
  2516. (save-match-data (setq evaluate (string-match "(.*)" source-name)))
  2517. (save-match-data
  2518. (setq prefix
  2519. (buffer-substring (match-beginning 0)
  2520. (save-excursion
  2521. (beginning-of-line 1) (point)))))
  2522. ;; add interval to new-body (removing noweb reference)
  2523. (goto-char (match-beginning 0))
  2524. (funcall nb-add (buffer-substring index (point)))
  2525. (goto-char (match-end 0))
  2526. (setq index (point))
  2527. (funcall
  2528. nb-add
  2529. (with-current-buffer parent-buffer
  2530. (save-restriction
  2531. (widen)
  2532. (mapconcat ;; Interpose PREFIX between every line.
  2533. #'identity
  2534. (split-string
  2535. (if evaluate
  2536. (let ((raw (org-babel-ref-resolve source-name)))
  2537. (if (stringp raw) raw (format "%S" raw)))
  2538. (or
  2539. ;; Retrieve from the Library of Babel.
  2540. (nth 2 (assoc-string source-name org-babel-library-of-babel))
  2541. ;; Return the contents of headlines literally.
  2542. (save-excursion
  2543. (when (org-babel-ref-goto-headline-id source-name)
  2544. (org-babel-ref-headline-body)))
  2545. ;; Find the expansion of reference in this buffer.
  2546. (save-excursion
  2547. (goto-char (point-min))
  2548. (let* ((name-regexp
  2549. (org-babel-named-src-block-regexp-for-name
  2550. source-name))
  2551. (comment
  2552. (string= "noweb"
  2553. (cdr (assq :comments (nth 2 info)))))
  2554. (c-wrap
  2555. (lambda (s)
  2556. ;; Comment, according to LANG mode,
  2557. ;; string S. Return new string.
  2558. (with-temp-buffer
  2559. (funcall (intern (concat lang "-mode")))
  2560. (comment-region (point)
  2561. (progn (insert s) (point)))
  2562. (org-trim (buffer-string)))))
  2563. (expand-body
  2564. (lambda (i)
  2565. ;; Expand body of code blocked
  2566. ;; represented by block info I.
  2567. (let ((b (if (org-babel-noweb-p (nth 2 i) :eval)
  2568. (org-babel-expand-noweb-references i)
  2569. (nth 1 i))))
  2570. (if (not comment) b
  2571. (let ((cs (org-babel-tangle-comment-links i)))
  2572. (concat (funcall c-wrap (car cs)) "\n"
  2573. b "\n"
  2574. (funcall c-wrap (cadr cs)))))))))
  2575. (if (re-search-forward name-regexp nil t)
  2576. ;; Found a source block named SOURCE-NAME.
  2577. ;; Assume it is unique; do not look after
  2578. ;; `:noweb-ref' header argument.
  2579. (funcall expand-body
  2580. (org-babel-get-src-block-info 'light))
  2581. ;; Though luck. We go into the long process
  2582. ;; of checking each source block and expand
  2583. ;; those with a matching Noweb reference.
  2584. (let ((expansion nil))
  2585. (org-babel-map-src-blocks nil
  2586. (let* ((info (org-babel-get-src-block-info 'light))
  2587. (parameters (nth 2 info)))
  2588. (when (equal source-name
  2589. (cdr (assq :noweb-ref parameters)))
  2590. (push (funcall expand-body info) expansion)
  2591. (push (or (cdr (assq :noweb-sep parameters))
  2592. "\n")
  2593. expansion))))
  2594. (when expansion
  2595. (mapconcat #'identity
  2596. (nreverse (cdr expansion))
  2597. ""))))))
  2598. ;; Possibly raise an error if named block doesn't exist.
  2599. (if (or org-babel-noweb-error-all-langs
  2600. (member lang org-babel-noweb-error-langs))
  2601. (error "%s could not be resolved (see \
  2602. `org-babel-noweb-error-langs')"
  2603. (org-babel-noweb-wrap source-name))
  2604. "")))
  2605. "[\n\r]")
  2606. (concat "\n" prefix))))))
  2607. (funcall nb-add (buffer-substring index (point-max))))
  2608. new-body))
  2609. (defun org-babel--script-escape-inner (str)
  2610. (let (in-single in-double backslash out)
  2611. (mapc
  2612. (lambda (ch)
  2613. (setq
  2614. out
  2615. (if backslash
  2616. (progn
  2617. (setq backslash nil)
  2618. (cond
  2619. ((and in-single (eq ch ?'))
  2620. ;; Escaped single quote inside single quoted string:
  2621. ;; emit just a single quote, since we've changed the
  2622. ;; outer quotes to double.
  2623. (cons ch out))
  2624. ((eq ch ?\")
  2625. ;; Escaped double quote
  2626. (if in-single
  2627. ;; This should be interpreted as backslash+quote,
  2628. ;; not an escape. Emit a three backslashes
  2629. ;; followed by a quote (because one layer of
  2630. ;; quoting will be stripped by `org-babel-read').
  2631. (append (list ch ?\\ ?\\ ?\\) out)
  2632. ;; Otherwise we are in a double-quoted string. Emit
  2633. ;; a single escaped quote
  2634. (append (list ch ?\\) out)))
  2635. ((eq ch ?\\)
  2636. ;; Escaped backslash: emit a single escaped backslash
  2637. (append (list ?\\ ?\\) out))
  2638. ;; Other: emit a quoted backslash followed by whatever
  2639. ;; the character was (because one layer of quoting will
  2640. ;; be stripped by `org-babel-read').
  2641. (t (append (list ch ?\\ ?\\) out))))
  2642. (cl-case ch
  2643. (?\[ (if (or in-double in-single)
  2644. (cons ?\[ out)
  2645. (cons ?\( out)))
  2646. (?\] (if (or in-double in-single)
  2647. (cons ?\] out)
  2648. (cons ?\) out)))
  2649. (?\{ (if (or in-double in-single)
  2650. (cons ?\{ out)
  2651. (cons ?\( out)))
  2652. (?\} (if (or in-double in-single)
  2653. (cons ?\} out)
  2654. (cons ?\) out)))
  2655. (?, (if (or in-double in-single)
  2656. (cons ?, out) (cons ?\s out)))
  2657. (?\' (if in-double
  2658. (cons ?\' out)
  2659. (setq in-single (not in-single)) (cons ?\" out)))
  2660. (?\" (if in-single
  2661. (append (list ?\" ?\\) out)
  2662. (setq in-double (not in-double)) (cons ?\" out)))
  2663. (?\\ (unless (or in-single in-double)
  2664. (error "Can't handle backslash outside string in `org-babel-script-escape'"))
  2665. (setq backslash t)
  2666. out)
  2667. (t (cons ch out))))))
  2668. (string-to-list str))
  2669. (when (or in-single in-double)
  2670. (error "Unterminated string in `org-babel-script-escape'"))
  2671. (apply #'string (reverse out))))
  2672. (defun org-babel-script-escape (str &optional force)
  2673. "Safely convert tables into elisp lists."
  2674. (unless (stringp str)
  2675. (error "`org-babel-script-escape' expects a string"))
  2676. (let ((escaped
  2677. (cond
  2678. ((and (> (length str) 2)
  2679. (or (and (string-equal "[" (substring str 0 1))
  2680. (string-equal "]" (substring str -1)))
  2681. (and (string-equal "{" (substring str 0 1))
  2682. (string-equal "}" (substring str -1)))
  2683. (and (string-equal "(" (substring str 0 1))
  2684. (string-equal ")" (substring str -1)))))
  2685. (concat "'" (org-babel--script-escape-inner str)))
  2686. ((or force
  2687. (and (> (length str) 2)
  2688. (or (and (string-equal "'" (substring str 0 1))
  2689. (string-equal "'" (substring str -1)))
  2690. ;; We need to pass double-quoted strings
  2691. ;; through the backslash-twiddling bits, even
  2692. ;; though we don't need to change their
  2693. ;; delimiters.
  2694. (and (string-equal "\"" (substring str 0 1))
  2695. (string-equal "\"" (substring str -1))))))
  2696. (org-babel--script-escape-inner str))
  2697. (t str))))
  2698. (condition-case nil (org-babel-read escaped) (error escaped))))
  2699. (defun org-babel-read (cell &optional inhibit-lisp-eval)
  2700. "Convert the string value of CELL to a number if appropriate.
  2701. Otherwise if CELL looks like lisp (meaning it starts with a
  2702. \"(\", \"\\='\", \"\\=`\" or a \"[\") then read and evaluate it as
  2703. lisp, otherwise return it unmodified as a string. Optional
  2704. argument INHIBIT-LISP-EVAL inhibits lisp evaluation for
  2705. situations in which is it not appropriate."
  2706. (cond ((not (org-string-nw-p cell)) cell)
  2707. ((org-babel--string-to-number cell))
  2708. ((and (not inhibit-lisp-eval)
  2709. (or (memq (string-to-char cell) '(?\( ?' ?` ?\[))
  2710. (string= cell "*this*")))
  2711. (eval (read cell) t))
  2712. ((eq (string-to-char cell) ?\") (read cell))
  2713. (t (org-no-properties cell))))
  2714. (defun org-babel--string-to-number (string)
  2715. "If STRING represents a number return its value.
  2716. Otherwise return nil."
  2717. (and (string-match-p "\\`-?[0-9]*\\.?[0-9]*\\'" string)
  2718. (string-to-number string)))
  2719. (defun org-babel-import-elisp-from-file (file-name &optional separator)
  2720. "Read the results located at FILE-NAME into an elisp table.
  2721. If the table is trivial, then return it as a scalar."
  2722. (let (result)
  2723. (save-window-excursion
  2724. (with-temp-buffer
  2725. (condition-case err
  2726. (progn
  2727. (org-table-import file-name separator)
  2728. (delete-file file-name)
  2729. (setq result (mapcar (lambda (row)
  2730. (mapcar #'org-babel-string-read row))
  2731. (org-table-to-lisp))))
  2732. (error (message "Error reading results: %s" err) nil)))
  2733. (if (null (cdr result)) ;; if result is trivial vector, then scalarize it
  2734. (if (consp (car result))
  2735. (if (null (cdr (car result)))
  2736. (caar result)
  2737. result)
  2738. (car result))
  2739. result))))
  2740. (defun org-babel-string-read (cell)
  2741. "Strip nested \"s from around strings."
  2742. (org-babel-read (or (and (stringp cell)
  2743. (string-match "\\\"\\(.+\\)\\\"" cell)
  2744. (match-string 1 cell))
  2745. cell) t))
  2746. (defun org-babel-chomp (string &optional regexp)
  2747. "Strip a trailing space or carriage return from STRING.
  2748. The default regexp used is \"[ \\f\\t\\n\\r\\v]\" but another one
  2749. can be specified as the REGEXP argument."
  2750. (let ((regexp (or regexp "[ \f\t\n\r\v]")))
  2751. (while (and (> (length string) 0)
  2752. (string-match regexp (substring string -1)))
  2753. (setq string (substring string 0 -1)))
  2754. string))
  2755. (defun org-babel-process-file-name (name &optional no-quote-p)
  2756. "Prepare NAME to be used in an external process.
  2757. If NAME specifies a remote location, the remote portion of the
  2758. name is removed, since in that case the process will be executing
  2759. remotely. The file name is then processed by `expand-file-name'.
  2760. Unless second argument NO-QUOTE-P is non-nil, the file name is
  2761. additionally processed by `shell-quote-argument'"
  2762. (let ((f (org-babel-local-file-name (expand-file-name name))))
  2763. (if no-quote-p f (shell-quote-argument f))))
  2764. (defvar org-babel-temporary-directory)
  2765. (unless (or noninteractive (boundp 'org-babel-temporary-directory))
  2766. (defvar org-babel-temporary-directory
  2767. (or (and (boundp 'org-babel-temporary-directory)
  2768. (file-exists-p org-babel-temporary-directory)
  2769. org-babel-temporary-directory)
  2770. (make-temp-file "babel-" t))
  2771. "Directory to hold temporary files created to execute code blocks.
  2772. Used by `org-babel-temp-file'. This directory will be removed on
  2773. Emacs shutdown."))
  2774. (defcustom org-babel-remote-temporary-directory "/tmp/"
  2775. "Directory to hold temporary files on remote hosts."
  2776. :group 'org-babel
  2777. :type 'string)
  2778. (defmacro org-babel-result-cond (result-params scalar-form &rest table-forms)
  2779. "Call the code to parse raw string results according to RESULT-PARAMS."
  2780. (declare (indent 1)
  2781. (debug (form form &rest form)))
  2782. (org-with-gensyms (params)
  2783. `(let ((,params ,result-params))
  2784. (unless (member "none" ,params)
  2785. (if (or (member "scalar" ,params)
  2786. (member "verbatim" ,params)
  2787. (member "html" ,params)
  2788. (member "code" ,params)
  2789. (member "pp" ,params)
  2790. (member "file" ,params)
  2791. (and (or (member "output" ,params)
  2792. (member "raw" ,params)
  2793. (member "org" ,params)
  2794. (member "drawer" ,params))
  2795. (not (member "table" ,params))))
  2796. ,scalar-form
  2797. ,@table-forms)))))
  2798. (def-edebug-spec org-babel-result-cond (form form body))
  2799. (defun org-babel-temp-file (prefix &optional suffix)
  2800. "Create a temporary file in the `org-babel-temporary-directory'.
  2801. Passes PREFIX and SUFFIX directly to `make-temp-file' with the
  2802. value of `temporary-file-directory' temporarily set to the value
  2803. of `org-babel-temporary-directory'."
  2804. (if (file-remote-p default-directory)
  2805. (let ((prefix
  2806. (concat (file-remote-p default-directory)
  2807. (expand-file-name
  2808. prefix org-babel-remote-temporary-directory))))
  2809. (make-temp-file prefix nil suffix))
  2810. (let ((temporary-file-directory
  2811. (or (and (boundp 'org-babel-temporary-directory)
  2812. (file-exists-p org-babel-temporary-directory)
  2813. org-babel-temporary-directory)
  2814. temporary-file-directory)))
  2815. (make-temp-file prefix nil suffix))))
  2816. (defun org-babel-remove-temporary-directory ()
  2817. "Remove `org-babel-temporary-directory' on Emacs shutdown."
  2818. (when (and (boundp 'org-babel-temporary-directory)
  2819. (file-exists-p org-babel-temporary-directory))
  2820. ;; taken from `delete-directory' in files.el
  2821. (condition-case nil
  2822. (progn
  2823. (mapc (lambda (file)
  2824. ;; This test is equivalent to
  2825. ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
  2826. ;; but more efficient
  2827. (if (eq t (car (file-attributes file)))
  2828. (delete-directory file)
  2829. (delete-file file)))
  2830. ;; We do not want to delete "." and "..".
  2831. (directory-files org-babel-temporary-directory 'full
  2832. "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))
  2833. (delete-directory org-babel-temporary-directory))
  2834. (error
  2835. (message "Failed to remove temporary Org-babel directory %s"
  2836. (if (boundp 'org-babel-temporary-directory)
  2837. org-babel-temporary-directory
  2838. "[directory not defined]"))))))
  2839. (add-hook 'kill-emacs-hook 'org-babel-remove-temporary-directory)
  2840. (defun org-babel-one-header-arg-safe-p (pair safe-list)
  2841. "Determine if the PAIR is a safe babel header arg according to SAFE-LIST.
  2842. For the format of SAFE-LIST, see `org-babel-safe-header-args'."
  2843. (and (consp pair)
  2844. (keywordp (car pair))
  2845. (stringp (cdr pair))
  2846. (or
  2847. (memq (car pair) safe-list)
  2848. (let ((entry (assq (car pair) safe-list)))
  2849. (and entry
  2850. (consp entry)
  2851. (cond ((functionp (cdr entry))
  2852. (funcall (cdr entry) (cdr pair)))
  2853. ((listp (cdr entry))
  2854. (member (cdr pair) (cdr entry)))
  2855. (t nil)))))))
  2856. (defun org-babel-generate-file-param (src-name params)
  2857. "Calculate the filename for source block results.
  2858. The directory is calculated from the :output-dir property of the
  2859. source block; if not specified, use the current directory.
  2860. If the source block has a #+NAME and the :file parameter does not
  2861. contain any period characters, then the :file parameter is
  2862. treated as an extension, and the output file name is the
  2863. concatenation of the directory (as calculated above), the block
  2864. name, a period, and the parameter value as a file extension.
  2865. Otherwise, the :file parameter is treated as a full file name,
  2866. and the output file name is the directory (as calculated above)
  2867. plus the parameter value."
  2868. (let* ((file-cons (assq :file params))
  2869. (file-ext-cons (assq :file-ext params))
  2870. (file-ext (cdr-safe file-ext-cons))
  2871. (dir (cdr-safe (assq :output-dir params)))
  2872. fname)
  2873. ;; create the output-dir if it does not exist
  2874. (when dir
  2875. (make-directory dir t))
  2876. (if file-cons
  2877. ;; :file given; add :output-dir if given
  2878. (when dir
  2879. (setcdr file-cons (concat (file-name-as-directory dir) (cdr file-cons))))
  2880. ;; :file not given; compute from name and :file-ext if possible
  2881. (when (and src-name file-ext)
  2882. (if dir
  2883. (setq fname (concat (file-name-as-directory (or dir ""))
  2884. src-name "." file-ext))
  2885. (setq fname (concat src-name "." file-ext)))
  2886. (setq params (cons (cons :file fname) params))))
  2887. params))
  2888. (defun org-babel-graphical-output-file (params)
  2889. "File where a babel block should send graphical output, per PARAMS.
  2890. Return nil if no graphical output is expected. Raise an error if
  2891. the output file is ill-defined."
  2892. (let ((file (cdr (assq :file params))))
  2893. (cond (file (and (member "graphics" (cdr (assq :result-params params)))
  2894. file))
  2895. ((assq :file-ext params)
  2896. (user-error ":file-ext given but no :file generated; did you forget \
  2897. to name a block?"))
  2898. (t (user-error "No :file header argument given; cannot create \
  2899. graphical result")))))
  2900. (defun org-babel-make-language-alias (new old)
  2901. "Make source blocks of type NEW aliases for those of type OLD.
  2902. NEW and OLD should be strings. This function should be called
  2903. after the babel API for OLD-type source blocks is fully defined.
  2904. Callers of this function will probably want to add an entry to
  2905. `org-src-lang-modes' as well."
  2906. (dolist (fn '("execute" "expand-body" "prep-session"
  2907. "variable-assignments" "load-session"))
  2908. (let ((sym (intern-soft (concat "org-babel-" fn ":" old))))
  2909. (when (and sym (fboundp sym))
  2910. (defalias (intern (concat "org-babel-" fn ":" new)) sym))))
  2911. ;; Technically we don't need a `dolist' for just one variable, but
  2912. ;; we keep it for symmetry/ease of future expansion.
  2913. (dolist (var '("default-header-args"))
  2914. (let ((sym (intern-soft (concat "org-babel-" var ":" old))))
  2915. (when (and sym (boundp sym))
  2916. (defvaralias (intern (concat "org-babel-" var ":" new)) sym)))))
  2917. (defun org-babel-strip-quotes (string)
  2918. "Strip \\\"s from around a string, if applicable."
  2919. (org-unbracket-string "\"" "\"" string))
  2920. (provide 'ob-core)
  2921. ;; Local variables:
  2922. ;; generated-autoload-file: "org-loaddefs.el"
  2923. ;; End:
  2924. ;;; ob-core.el ends here