ob.el 89 KB

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