Browse Source

DONE add =:tangle= family of header arguments

  these can be used to inhibit tangling
Eric Schulte 16 years ago
parent
commit
51cfe9e468
4 changed files with 34 additions and 17 deletions
  1. 13 12
      lisp/org-babel-tangle.el
  2. 8 4
      lisp/org-babel.el
  3. 8 1
      org-babel.org
  4. 5 0
      test-tangle.org

+ 13 - 12
lisp/org-babel-tangle.el

@@ -98,11 +98,11 @@ language."
                        by-session)
                        by-session)
                (setq block-counter (+ block-counter (length (cdr (car by-session)))))
                (setq block-counter (+ block-counter (length (cdr (car by-session)))))
                (to-file (format "%s.%s" base-name ext) (cdr (car by-session)))))))
                (to-file (format "%s.%s" base-name ext) (cdr (car by-session)))))))
-       (org-babel-collect-blocks lang))
+       (org-babel-tangle-collect-blocks lang))
       (message "tangled %d source-code blocks" block-counter)
       (message "tangled %d source-code blocks" block-counter)
       path-collector)))
       path-collector)))
 
 
-(defun org-babel-collect-blocks (&optional lang)
+(defun org-babel-tangle-collect-blocks (&optional lang)
   "Collect all source blocks in the current org-mode file.
   "Collect all source blocks in the current org-mode file.
 Return two nested association lists, first grouped by language,
 Return two nested association lists, first grouped by language,
 then by session, the contents will be source-code block
 then by session, the contents will be source-code block
@@ -123,16 +123,17 @@ code blocks by language."
              (spec (list link source-name params body))
              (spec (list link source-name params body))
              (session (cdr (assoc :session params)))
              (session (cdr (assoc :session params)))
              by-lang by-session)
              by-lang by-session)
-        (unless (and lang (not (string= lang src-lang))) ;; maybe limit by language
-          ;; add the spec for this block to blocks under it's language and session
-          (setq by-lang (cdr (assoc src-lang blocks)))
-          (setq blocks (delq (assoc src-lang blocks) blocks))
-          (setq by-session (cdr (assoc session by-lang)))
-          (setq by-lang (delq (assoc session by-lang) by-lang))
-          (setq blocks (cons ;; by-language
-                        (cons src-lang (cons ;; by-session
-                                        (cons session (cons spec by-session)) by-lang))
-                        blocks)))))
+        (unless (string= (cdr (assoc :tangle params)) "no") ;; maybe skip
+          (unless (and lang (not (string= lang src-lang))) ;; maybe limit by language
+            ;; add the spec for this block to blocks under it's language and session
+            (setq by-lang (cdr (assoc src-lang blocks)))
+            (setq blocks (delq (assoc src-lang blocks) blocks))
+            (setq by-session (cdr (assoc session by-lang)))
+            (setq by-lang (delq (assoc session by-lang) by-lang))
+            (setq blocks (cons ;; by-language
+                          (cons src-lang (cons ;; by-session
+                                          (cons session (cons spec by-session)) by-lang))
+                          blocks))))))
     ;; blocks should contain all source-blocks organized by language and session
     ;; blocks should contain all source-blocks organized by language and session
     ;; (message "blocks=%S" blocks) ;; debugging
     ;; (message "blocks=%S" blocks) ;; debugging
     blocks))
     blocks))

+ 8 - 4
lisp/org-babel.el

@@ -497,7 +497,7 @@ non-nil."
 elements of PLISTS override the values of previous element.  This
 elements of PLISTS override the values of previous element.  This
 takes into account some special considerations for certain
 takes into account some special considerations for certain
 parameters when merging lists."
 parameters when merging lists."
-  (let (params results exports vars var ref)
+  (let (params results exports tangle vars var ref)
     (flet ((e-merge (exclusive-groups &rest result-params)
     (flet ((e-merge (exclusive-groups &rest result-params)
                     ;; maintain exclusivity of mutually exclusive parameters
                     ;; maintain exclusivity of mutually exclusive parameters
                     (let (output)
                     (let (output)
@@ -531,15 +531,19 @@ parameters when merging lists."
                         (:exports
                         (:exports
                          (setq exports (e-merge '(("code" "results" "both"))
                          (setq exports (e-merge '(("code" "results" "both"))
                                                 exports (split-string (cdr pair)))))
                                                 exports (split-string (cdr pair)))))
+                        (:tangle
+                         (setq tangle (e-merge '(("yes" "no"))
+                                               tangle (split-string (cdr pair)))))
                         (t ;; replace: this covers e.g. :session
                         (t ;; replace: this covers e.g. :session
                          (setq params (cons pair (assq-delete-all (car pair) params))))))
                          (setq params (cons pair (assq-delete-all (car pair) params))))))
                     plist))
                     plist))
             plists))
             plists))
     (setq vars (mapcar (lambda (pair) (format "%s=%s" (car pair) (cdr pair))) vars))
     (setq vars (mapcar (lambda (pair) (format "%s=%s" (car pair) (cdr pair))) vars))
     (while vars (setq params (cons (cons :var (pop vars)) params)))
     (while vars (setq params (cons (cons :var (pop vars)) params)))
-    (cons (cons :exports (mapconcat 'identity exports " "))
-          (cons (cons :results (mapconcat 'identity results " "))
-                params))))
+    (cons (cons :tangle (mapconcat 'identity tangle " "))
+          (cons (cons :exports (mapconcat 'identity exports " "))
+                (cons (cons :results (mapconcat 'identity results " "))
+                      params)))))
 
 
 (defun org-babel-clean-text-properties (text)
 (defun org-babel-clean-text-properties (text)
   "Strip all properties from text return."
   "Strip all properties from text return."

+ 8 - 1
org-babel.org

@@ -207,7 +207,7 @@ would then be [[#sandbox][the sandbox]].
 #+end_src
 #+end_src
 
 
 
 
-* Tasks [36/57]
+* Tasks [37/58]
 ** PROPOSED raise elisp error when source-blocks return errors
 ** PROPOSED raise elisp error when source-blocks return errors
 Not sure how/if this would work, but it may be desirable.
 Not sure how/if this would work, but it may be desirable.
 
 
@@ -256,6 +256,7 @@ but with preference given to
 ** TODO make tangle files read-only?
 ** TODO make tangle files read-only?
    With a file-local variable setting, yea that makes sense.  Maybe
    With a file-local variable setting, yea that makes sense.  Maybe
    the header should reference the related org-mode file.
    the header should reference the related org-mode file.
+
 ** TODO take default values for header args from properties
 ** TODO take default values for header args from properties
    Use file-wide and subtree wide properties to set default values for
    Use file-wide and subtree wide properties to set default values for
    header args.
    header args.
@@ -930,6 +931,12 @@ to the command if BUFF is not given.)
     2) The function is called inside of a =write.table= function call
     2) The function is called inside of a =write.table= function call
        writing the results to a table
        writing the results to a table
     3) The table is read using =org-table-import=
     3) The table is read using =org-table-import=
+** DONE add =:tangle= family of header arguments
+values are
+- no :: don't include source-code block when tangling
+- yes :: do include source-code block when tangling
+
+this is tested in [[file:test-tangle.org::*Emacs%20Lisp%20initialization%20stuff][test-tangle.org]]
 
 
 ** DONE Default args
 ** DONE Default args
    This would be good thing to address soon. I'm imagining that
    This would be good thing to address soon. I'm imagining that

+ 5 - 0
test-tangle.org

@@ -85,3 +85,8 @@ plus_two(holder)
   (setq test-tangle-loading "org-babel tangles")
   (setq test-tangle-loading "org-babel tangles")
   (setq test-tangle-advert "use org-babel-tangle for all your emacs initialization files!!")
   (setq test-tangle-advert "use org-babel-tangle for all your emacs initialization files!!")
 #+end_src
 #+end_src
+
+#+srcname: i-shouldnt-be-tangled
+#+begin_src emacs-lisp :tangle no
+  (setq test-tangle-i-should-not-exist "hopefully I'm not included")
+#+end_src