ob-core.el 119 KB

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