ob-core.el 118 KB

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