emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob d46afeb5e9c668400d4d6b05ed272a2d4c3871c8 12201 bytes (raw)
name: testing/examples/babel.org 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
#+Title: a collection of examples for Babel tests
#+OPTIONS: ^:nil

* =:noweb= header argument expansion
  :PROPERTIES:
  :ID:       eb1f6498-5bd9-45e0-9c56-50717053e7b7
  :END:

#+name: noweb-example
#+begin_src emacs-lisp :results silent :exports code
  (message "expanded1")
#+end_src

#+name: noweb-example2
#+begin_src emacs-lisp :results silent
  (message "expanded2")
#+end_src

#+begin_src emacs-lisp :noweb yes :results silent
;; noweb-1-yes-start
  <<noweb-example>>
#+end_src

#+begin_src emacs-lisp :noweb no  :results silent
;; noweb-no-start
  <<noweb-example1>>
#+end_src

#+begin_src emacs-lisp :noweb yes :results silent
;; noweb-2-yes-start
  <<noweb-example2>>
#+end_src

#+begin_src emacs-lisp :noweb tangle :results silent
  ;; noweb-tangle-start
  <<noweb-example1>>
  <<noweb-example2>>
#+end_src

* =:noweb= header argument expansion using :exports results
  :PROPERTIES:
  :ID:       8701beb4-13d9-468c-997a-8e63e8b66f8d
  :END:

#+name: noweb-example
#+begin_src emacs-lisp :exports results
  (message "expanded1")
#+end_src

#+name: noweb-example2
#+begin_src emacs-lisp :exports results
  (message "expanded2")
#+end_src

#+begin_src emacs-lisp :noweb yes :exports results
;; noweb-1-yes-start
  <<noweb-example>>
#+end_src

#+begin_src emacs-lisp :noweb no :exports code
;; noweb-no-start
  <<noweb-example1>>
#+end_src

#+begin_src emacs-lisp :noweb yes :exports results
;; noweb-2-yes-start
  <<noweb-example2>>
#+end_src

#+begin_src emacs-lisp :noweb tangle :exports code
  <<noweb-example1>>
  <<noweb-example2>>
#+end_src

* excessive id links on tangling
  :PROPERTIES:
  :ID:       ef06fd7f-012b-4fde-87a2-2ae91504ea7e
  :END:

** no, don't give me an ID
#+begin_src emacs-lisp :tangle no
  (message "not to be tangled")
#+end_src

** yes, I'd love an ID
   :PROPERTIES:
   :ID:       ae7b55ca-9ef2-4d30-bd48-da30e35fd0f3
   :END:
#+begin_src emacs-lisp :tangle no
  (message "for tangling")
#+end_src
* simple named code block
  :PROPERTIES:
  :ID:       0d82b52d-1bb9-4916-816b-2c67c8108dbb
  :END:

#+name: i-have-a-name
#+begin_src emacs-lisp
  42
#+end_src

#+name:
: 42

#+name: i-have-a-name
: 42

* Pascal's Triangle -- exports both test
  :PROPERTIES:
  :ID:       92518f2a-a46a-4205-a3ab-bcce1008a4bb
  :END:

#+name: pascals-triangle
#+begin_src emacs-lisp :var n=5 :exports both
(defun pascals-triangle (n)
  (if (= n 0)
      (list (list 1))
    (let* ((prev-triangle (pascals-triangle (- n 1)))
           (prev-row (car (reverse prev-triangle))))
      (append prev-triangle
              (list (cl-map 'list #'+
                            (append prev-row '(0))
                            (append '(0) prev-row)))))))

(pascals-triangle n)
#+end_src

* executing an lob call line
  :PROPERTIES:
  :header-args: :results  silent
  :ID:       fab7e291-fde6-45fc-bf6e-a485b8bca2f0
  :END:

#+call: echo(input="testing")
#+call: echo(input="testing") :results vector
#+call: echo[:var input="testing"]()
#+call: echo[:var input="testing"]() :results vector
#+call: echo("testing")
#+call: echo("testing") :results vector
This is an inline call call_echo(input="testing") embedded in prose.
This is an inline call call_echo(input="testing")[:results vector] embedded in prose.
#+call: lob-minus(8, 4)
call_echo("testing")
call_concat(1,2,3)

#+name: concat
#+begin_src emacs-lisp :var a=0 :var b=0 :var c=0
  (format "%S%S%S" a b c)
#+end_src

* exporting an lob call line
  :PROPERTIES:
  :ID:       72ddeed3-2d17-4c7f-8192-a575d535d3fc
  :END:

#+name: double
#+begin_src emacs-lisp :var it=0
  (* 2 it)
#+end_src

The following exports as a normal call line
#+call: double(it=0)

Now here is an inline call call_double(it=1) stuck in the middle of
some prose.

This one should not be exported =call_double(it=2)= because it is
quoted.

Finally this next one should export, even though it starts a line
call_double(it=3) because sometimes inline blocks fold with a
paragraph.

And, a call with raw results call_double(4)[:results raw] should not
have quoted results.

The following 2*5=call_double(5) should export even when prefixed by
an = sign.

* inline source block
  :PROPERTIES:
  :ID:       54cb8dc3-298c-4883-a933-029b3c9d4b18
  :END:
Here is one in the middle src_sh{echo 1} of a line.
Here is one at the end of a line. src_sh{echo 2}
src_sh{echo 3} Here is one at the beginning of a line.

* exported inline source block
:PROPERTIES:
:ID:       cd54fc88-1b6b-45b6-8511-4d8fa7fc8076
:header-args: :exports  code
:END:
Here is one in the middle src_sh{echo 1} of a line.
Here is one at the end of a line. src_sh{echo 2}
src_sh{echo 3} Here is one at the beginning of a line.
Here is one that is also evaluated: src_sh[:exports both]{echo 4}

* mixed blocks with exports both
  :PROPERTIES:
  :ID:       5daa4d03-e3ea-46b7-b093-62c1b7632df3
  :END:

#+name: a-list
- a
- b
- c

#+begin_src emacs-lisp :exports both
    "code block results"
#+end_src

#+begin_src emacs-lisp :var lst=a-list :results list :exports both
  (reverse lst)
#+end_src

* using the =:noweb-ref= header argument
  :PROPERTIES:
  :ID:       54d68d4b-1544-4745-85ab-4f03b3cbd8a0
  :header-args: :noweb-sep ""
  :END:

#+begin_src sh :tangle yes :noweb yes :shebang "#!/bin/sh"
  <<fullest-disk>>
#+end_src

** query all mounted disks
#+begin_src sh :noweb-ref fullest-disk
  df
#+end_src

** strip the header row
#+begin_src sh :noweb-ref fullest-disk
  |sed '1d'
#+end_src

** sort by the percent full
#+begin_src sh :noweb-ref fullest-disk
  |awk '{print $5 " " $6}'|sort -n |tail -1
#+end_src

** extract the mount point
#+begin_src sh :noweb-ref fullest-disk
  |awk '{print $2}'
#+end_src
* resolving sub-trees as references
  :PROPERTIES:
  :ID:       2409e8ba-7b5f-4678-8888-e48aa02d8cb4
  :header-args: :results  silent
  :END:

#+begin_src emacs-lisp :var text=d4faa7b3-072b-4dcf-813c-dd7141c633f3
  (length text)
#+end_src

#+begin_src org :noweb yes
  <<simple-subtree>>
  <<d4faa7b3-072b-4dcf-813c-dd7141c633f3>>
#+end_src

** simple subtree with custom ID
   :PROPERTIES:
   :CUSTOM_ID: simple-subtree
   :END:
this is simple

** simple subtree with global ID
   :PROPERTIES:
   :ID:       d4faa7b3-072b-4dcf-813c-dd7141c633f3
   :END:
has length 14

* exporting a code block with a name
  :PROPERTIES:
  :ID:       b02ddd8a-eeb8-42ab-8664-8a759e6f43d9
  :END:

exporting a code block with a name
#+name: qux
#+begin_src sh :foo "baz"
  echo bar
#+end_src
* noweb no-export and exports both
  :PROPERTIES:
  :ID:       8a820f6c-7980-43db-8a24-0710d33729c9
  :END:
Weird interaction.

here is one block

#+name: noweb-no-export-and-exports-both-1
#+BEGIN_SRC sh :exports none
  echo 1
#+END_SRC

and another

#+BEGIN_SRC sh :noweb no-export :exports both
  # I am inside the code block
  <<noweb-no-export-and-exports-both-1>>
#+END_SRC

* in order evaluation on export
  :PROPERTIES:
  :header-args: :exports results
  :ID:       96cc7073-97ec-4556-87cf-1f9bffafd317
  :END:

First.
#+name: foo-for-order-of-evaluation
#+begin_src emacs-lisp :var it=1
  (push it *evaluation-collector*)
#+end_src

Second
#+begin_src emacs-lisp
  (push 2 *evaluation-collector*)
#+end_src

Third src_emacs-lisp{(car (push 3 *evaluation-collector*))}

Fourth
#+call: foo-for-order-of-evaluation(4)

Fifth
#+begin_src emacs-lisp
  (push 5 *evaluation-collector*)
#+end_src
* exporting more than just results from a call line
  :PROPERTIES:
  :ID:       bec63a04-491e-4caa-97f5-108f3020365c
  :END:
Here is a call line with more than just the results exported.
#+call: double(8)
* strip noweb references on export
  :PROPERTIES:
  :ID:       8e7bd234-99b2-4b14-8cd6-53945e409775
  :END:

#+name: strip-export-1
#+BEGIN_SRC sh :exports none
  i="10"
#+END_SRC

#+BEGIN_SRC sh :noweb strip-export :exports code :results silent
  <<strip-export-1>>
  echo "1$i"
#+END_SRC

* use case of reading entry properties
  :PROPERTIES:
  :ID:       cc5fbc20-bca5-437a-a7b8-2b4d7a03f820
  :END:

Use case checked and documented with this test: During their
evaluation the source blocks read values from properties from the
entry where the call has been made unless the value is overridden with
the optional argument of the caller.

** section
   :PROPERTIES:
   :a:        1
   :c:        3
   :END:

Note: Just export of a property can be done with a macro: {{{property(a)}}}.

#+NAME: src_block_location_shell-sect-call
#+CALL: src_block_location_shell()

#+NAME: src_block_location_elisp-sect-call
#+CALL: src_block_location_elisp()

- sect inline call_src_block_location_shell()[:results raw]
- sect inline call_src_block_location_elisp()[:results raw]

*** subsection
    :PROPERTIES:
    :b:        2
    :c:        4
    :END:

#+NAME: src_block_location_shell-sub0-call
#+CALL: src_block_location_shell()

#+NAME: src_block_location_elisp-sub0-call
#+CALL: src_block_location_elisp()

- sub0 inline call_src_block_location_shell()[:results raw]
- sub0 inline call_src_block_location_elisp()[:results raw]

#+NAME: src_block_location_shell-sub1-call
#+CALL: src_block_location_shell(c=5, e=6)

#+NAME: src_block_location_elisp-sub1-call
#+CALL: src_block_location_elisp(c=5, e=6)

- sub1 inline call_src_block_location_shell(c=5, e=6)[:results raw]
- sub1 inline call_src_block_location_elisp(c=5, e=6)[:results raw]

**** function definition

comments for ":var":
- The "or" is to deal with a property not present.
- The t is to get property inheritance.
#+NAME: src_block_location_shell
#+HEADER: :var a=(or (org-entry-get org-babel-current-src-block-location "a" t) "0")
#+HEADER: :var b=(or (org-entry-get org-babel-current-src-block-location "b" t) "0")
#+HEADER: :var c=(or (org-entry-get org-babel-current-src-block-location "c" t) "0")
#+HEADER: :var d=(or (org-entry-get org-babel-current-src-block-location "d" t) "0")
#+HEADER: :var e=(or (org-entry-get org-babel-current-src-block-location "e" t) "0")
#+BEGIN_SRC sh :shebang #!/bin/sh :exports results :results verbatim
  printf "shell a:$a, b:$b, c:$c, d:$d, e:$e"
#+END_SRC

#+RESULTS: src_block_location_shell

#+NAME: src_block_location_elisp
#+HEADER: :var a='nil
#+HEADER: :var b='nil
#+HEADER: :var c='nil
#+HEADER: :var d='nil
#+HEADER: :var e='nil
#+BEGIN_SRC emacs-lisp :exports results
  (setq
   ;; - The first `or' together with ":var <var>='nil" is to check for
   ;;   a value bound from an optional call argument, in the examples
   ;;   here: c=5, e=6
   ;; - The second `or' is to deal with a property not present
   ;; - The t is to get property inheritance
   a (or a (string-to-number
            (or (org-entry-get org-babel-current-src-block-location "a" t)
                "0")))
   b (or b (string-to-number
            (or (org-entry-get org-babel-current-src-block-location "b" t)
                "0")))
   c (or c (string-to-number
            (or (org-entry-get org-babel-current-src-block-location "c" t)
                "0")))
   d (or d (string-to-number
            (or (org-entry-get org-babel-current-src-block-location "e" t)
                "0")))
   e (or e (string-to-number
            (or (org-entry-get org-babel-current-src-block-location "d" t)
                "0"))))
  (format "elisp a:%d, b:%d, c:%d, d:%d, e:%d" a b c d e)
#+END_SRC

* =:file-ext= and =:output-dir= header args
  :PROPERTIES:
  :ID:       93573e1d-6486-442e-b6d0-3fedbdc37c9b
  :END:
#+name: file-ext-basic
#+BEGIN_SRC emacs-lisp :file-ext txt
nil
#+END_SRC

#+name: file-ext-dir-relative
#+BEGIN_SRC emacs-lisp :file-ext txt :output-dir foo
nil
#+END_SRC

#+name: file-ext-dir-relative-slash
#+BEGIN_SRC emacs-lisp :file-ext txt :output-dir foo/
nil
#+END_SRC

#+name: file-ext-dir-absolute
#+BEGIN_SRC emacs-lisp :file-ext txt :output-dir /tmp
nil
#+END_SRC

#+name: file-ext-file-wins
#+BEGIN_SRC emacs-lisp :file-ext txt :file foo.bar
nil
#+END_SRC

#+name: output-dir-and-file
#+BEGIN_SRC emacs-lisp :output-dir xxx :file foo.bar
nil
#+END_SRC
* detangle
** false positive
The =[[= causes a false positive which ~org-babel-detangle~ should handle properly
#+begin_src emacs-lisp :tangle yes
(string-match-p "^#[[:digit:]]+$" "#123")
#+end_src
** linked content to detangle
:PROPERTIES:
:ID:       73115FB0-6565-442B-BB95-50195A499EF4
:END:
#+begin_src emacs-lisp :tangle yes :comments link
#+end_src

debug log:

solving d46afeb5e ...
found d46afeb5e in https://git.savannah.gnu.org/cgit/emacs/org-mode.git

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).