Differences

This shows you the differences between two versions of the page.

--- geda:guile_scripting [2015/09/11 14:51]
vzh Example from geda-user mailing list
+++ geda:guile_scripting [2016/02/09 11:56] (current)
vzh Add a link to new page about REPL
@@ Line 15: / Line 15: @@
 ==== Reference documents ====
   * [[gnetlist Scheme primitives]]
+  * [[gschem repl|Using REPL in gschem]]
 ==== Scripting examples ====
 You can download each script example and load it in **gschem**:
-  * just hit <key>:</key> and enter <code>(load "filename.scm")</code>
+  * just hit <key>:</key> and enter <code lisp>(load "filename.scm")</code>
   * then hit <key>Enter</key>
+You can install them as well if you don't want to load them every time:
+  * copy the script you want into your //''~/.gEDA''// directory
+  * put the line <code lisp>(load "filename.scm")</code> into your //''~/.gEDA/gschemrc''// (replace //filename.scm// with the real name of the script)
 === Removing objects with specific properties ===
@@ Line 66: / Line 72: @@
 After loading the file, hit <key>:</key> and enter, for example,
-<code>
+<code lisp>
 (delete-components-by-attrib! (active-page) "refdes" "R1")
 </code>
@@ Line 74: / Line 80: @@
 **gaf shell** batch scripts:
   * ''schematic-file->page''
-  * ''page->schematic-files''
+  * ''page->schematic-file''
 <file lisp geda-io.scm>
@@ Line 167: / Line 173: @@
 ; If no objects are selected, opens gschem message dialog with
 ; warning.
-; Returns value is unspecified.
+; Return value is unspecified.
 (define (multiple-copy-move-and-rotate-selection vector angle num)
   (if (null? (page-selection (active-page)))
@@ Line 181: / Line 187: @@
 ; procedure
 (define mcmars multiple-copy-move-and-rotate-selection)
+</file>
+=== Group attribute editing ===
+Let's suppose you have selected several resistors' refdeses and
+want to rename them at once, e.g., if they were copy from another
+place.
+<file lisp set-selected-attribs-value>
+(use-modules (gschem selection))
+(define (set-selected-attribs-value! value)
+  (for-each
+    (lambda (attrib)
+      (set-attrib-value! attrib value))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(set-selected-attribs-value! "R100.?")
+</code>
+Now, after renumbering them using <key>t</key> <key>u</key>, you
+copy them all and want to rename those copied resistors appending a suffix:
+<file lisp append-selected-attribs-suffix.scm>
+(use-modules (gschem selection))
+(define (append-selected-attribs-suffix! suffix)
+  (for-each
+    (lambda (attrib)
+      (set-attrib-value!
+        attrib
+        (string-append (attrib-value attrib) suffix)))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(append-selected-attribs-suffix! "-top")
+</code>
+Now, let's rename some other attributes by adding a prefix:
+<file lisp append-selected-attribs-prefix.scm>
+(use-modules (gschem selection))
+(define (append-selected-attribs-prefix! prefix)
+  (for-each
+    (lambda (object)
+      (and (attribute? object)
+           (set-attrib-value!
+             object
+             (string-append prefix (attrib-value object)))))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(append-selected-attribs-prefix! "A1.")
+</code>
+Let's replace first letters of selected attribs with prefix:
+<file lisp append-selected-attribs-prefix.scm>
+(use-modules (gschem selection))
+(define (replace-selected-attribs-prefix! prefix)
+  (for-each
+    (lambda (object)
+      (and (attribute? object)
+           (set-attrib-value!
+             object
+             (string-append
+               prefix
+               (string-copy (attrib-value object) 1)))))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(replace-selected-attribs-prefix! "C")
+</code>
+Let's rename selected ''netname='' attributes increasing them by a
+fixed number:
+<file lisp add-selected-attribs-number.scm>
+(use-modules (gschem selection))
+(define (add-selected-attribs-number! number)
+  (for-each
+    (lambda (object)
+      (and (attribute? object)
+           (set-attrib-value!
+             object
+             (number->string
+               (+ (string->number (attrib-value object)) number)))))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(add-selected-attribs-number! 100)
+</code>
+We could set any function instead of "+" on the net number in this procedure.
+For instance:
+<file lisp use-another-func.scm>
+(use-modules (gschem selection))
+(define (use-another-func! func)
+  (for-each
+    (lambda (object)
+      (and (attribute? object)
+           (set-attrib-value!
+             object
+             (number->string
+               (func (string->number (attrib-value object)))))))
+    (page-selection (active-page))))
+</file>
+Usage of the procedure in **gschem**:
+<code lisp>
+(use-another-func! -)
+(define (multiply-by-2 x)
+  (* 2 x))
+(use-another-func! multiply-by-2)
+</code>
+=== Moving objects using arrows ===
+Let's define actions to move selected objects using
+<key>Shift</key> + arrow keys.
+<file lisp arrow-move.scm>
+(use-modules (gschem selection))
+; Default offset to move
+(define offset 100)
+; Get moving vector
+(define (move-selection direction)
+  (apply translate-objects!
+    (case direction
+      ((left ) (cons (- offset) 0))
+      ((right) (cons (+ offset) 0))
+      ((down ) (cons 0 (- offset)))
+      ((up   ) (cons 0 (+ offset)))
+      (else #f))
+    (page-selection (active-page))))
+; Define actions
+(define (&move-selection-left ) (move-selection 'left ))
+(define (&move-selection-right) (move-selection 'right))
+(define (&move-selection-down ) (move-selection 'down ))
+(define (&move-selection-up   ) (move-selection 'up   ))
+; Define shortcuts
+(global-set-key "<Shift>Left"  '&move-selection-left)
+(global-set-key "<Shift>Right" '&move-selection-right)
+(global-set-key "<Shift>Up"    '&move-selection-up)
+(global-set-key "<Shift>Down"  '&move-selection-down)
+</file>
+The following script redefines current shortcuts so that if
+nothing is selected the canvas is moved with arrow keys (without
+<key>Shift</key> in this case), otherwise selected objects are
+moved.
+<file lisp arrow-move2.scm>
+(use-modules (gschem selection))
+; Default offset to move
+(define offset 100)
+; Get moving vector
+(define (move-selection direction)
+  (let ((selection (page-selection (active-page))))
+    (if (null? selection)
+      ; default behaviour
+      (case direction
+          ((left ) (&view-pan-left))
+          ((right) (&view-pan-right))
+          ((down ) (&view-pan-down))
+          ((up   ) (&view-pan-up))
+          (else #f))
+      ; modified behaviour
+      (apply translate-objects!
+        (case direction
+          ((left ) (cons (- offset) 0))
+          ((right) (cons (+ offset) 0))
+          ((down ) (cons 0 (- offset)))
+          ((up   ) (cons 0 (+ offset)))
+          (else #f))
+        (page-selection (active-page))))
+    ))
+; Define actions
+(define (&move-selection-left ) (move-selection 'left ))
+(define (&move-selection-right) (move-selection 'right))
+(define (&move-selection-down ) (move-selection 'down ))
+(define (&move-selection-up   ) (move-selection 'up   ))
+; Define shortcuts
+(global-set-key "Left"  '&move-selection-left)
+(global-set-key "Right" '&move-selection-right)
+(global-set-key "Up"    '&move-selection-up)
+(global-set-key "Down"  '&move-selection-down)
 </file>

gEDA Project Wiki

User Tools

Site Tools

Differences

Page Tools