docs/wiki/geda-guile_scripting.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <title></title>
   6   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   7   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   8   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   9
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  11 </head>
  12 <body>
  13
  14
  15 <h2 class="sectionedit295"><a name="guile_scripting" id="guile_scripting">Guile scripting</a></h2>
  16 <div class="level2">
  17
  18 </div>
  19 <!-- EDIT295 SECTION "Guile scripting" [1-31] -->
  20 <h3 class="sectionedit296"><a name="tutorials" id="tutorials">Tutorials</a></h3>
  21 <div class="level3">
  22 <ul>
  23 <li class="level1"><div class="li"> <a href="geda-gnetlist_scheme_tutorial.html" class="wikilink1" title="geda-gnetlist_scheme_tutorial.html">Scripting a gnetlist backend in scheme</a> (John Doty)</div>
  24 </li>
  25 <li class="level1"><div class="li"> See also the <a href="geda-gnetlist_ug.html#scheme_backend_api" class="wikilink1" title="geda-gnetlist_ug.html">Scheme Backend API</a> section of the gnetlist User Guide</div>
  26 </li>
  27 </ul>
  28
  29 </div>
  30 <!-- EDIT296 SECTION "Tutorials" [32-249] -->
  31 <h3 class="sectionedit297"><a name="libgeda_c_library_reference" id="libgeda_c_library_reference">libgeda C library reference</a></h3>
  32 <div class="level3">
  33
  34 <p>
  35
  36 libgeda defines a number of low-level functions in C for configuring its behaviour and manipulating features such as the component and subcircuit libraries.
  37 </p>
  38
  39 </div>
  40
  41 <h4><a name="types" id="types">Types</a></h4>
  42 <div class="level4">
  43 <ul>
  44 <li class="level1"><div class="li"> attribute</div>
  45 </li>
  46 <li class="level1"><div class="li"> object</div>
  47 </li>
  48 <li class="level1"><div class="li"> page</div>
  49 </li>
  50 </ul>
  51
  52 </div>
  53
  54 <h4><a name="variables" id="variables">Variables</a></h4>
  55 <div class="level4">
  56
  57 <p>
  58
  59 Basic configuration (defined by libgeda, read-only)
  60
  61 </p>
  62 <ul>
  63 <li class="level1"><div class="li"> path-sep</div>
  64 </li>
  65 <li class="level1"><div class="li"> geda-rc-path</div>
  66 </li>
  67 <li class="level1"><div class="li"> geda-data-path</div>
  68 </li>
  69 </ul>
  70
  71 <p>
  72
  73 Object type identifiers (defined by libgeda, read-only)
  74
  75 </p>
  76 <ul>
  77 <li class="level1"><div class="li"> OBJ_LINE</div>
  78 </li>
  79 <li class="level1"><div class="li"> OBJ_BOX</div>
  80 </li>
  81 <li class="level1"><div class="li"> OBJ_PICTURE</div>
  82 </li>
  83 <li class="level1"><div class="li"> OBJ_CIRCLE</div>
  84 </li>
  85 <li class="level1"><div class="li"> OBJ_NET</div>
  86 </li>
  87 <li class="level1"><div class="li"> OBJ_BUS</div>
  88 </li>
  89 <li class="level1"><div class="li"> OBJ_COMPLEX</div>
  90 </li>
  91 <li class="level1"><div class="li"> OBJ_TEXT</div>
  92 </li>
  93 <li class="level1"><div class="li"> OBJ_<acronym title="Personal Identification Number">PIN</acronym></div>
  94 </li>
  95 <li class="level1"><div class="li"> OBJ_ARC</div>
  96 </li>
  97 <li class="level1"><div class="li"> OBJ_ROUTE</div>
  98 </li>
  99 <li class="level1"><div class="li"> OBJ_THRU_HOLE</div>
 100 </li>
 101 <li class="level1"><div class="li"> OBJ_PLACEHOLDER</div>
 102 </li>
 103 </ul>
 104
 105 </div>
 106
 107 <h4><a name="functions" id="functions">Functions</a></h4>
 108 <div class="level4">
 109
 110 <p>
 111
 112 Component library:
 113
 114 </p>
 115 <ul>
 116 <li class="level1"><div class="li"> component-library</div>
 117 </li>
 118 <li class="level1"><div class="li"> component-library-command</div>
 119 </li>
 120 <li class="level1"><div class="li"> component-library-funcs</div>
 121 </li>
 122 <li class="level1"><div class="li"> component-library-search</div>
 123 </li>
 124 <li class="level1"><div class="li"> reset-component-library</div>
 125 </li>
 126 </ul>
 127
 128 <p>
 129
 130 Subcircuit library:
 131
 132 </p>
 133 <ul>
 134 <li class="level1"><div class="li"> source-library</div>
 135 </li>
 136 <li class="level1"><div class="li"> source-library-search</div>
 137 </li>
 138 <li class="level1"><div class="li"> reset-source-library</div>
 139 </li>
 140 </ul>
 141
 142 <p>
 143
 144 Libgeda behaviour configuration (write-only):
 145
 146 </p>
 147 <ul>
 148 <li class="level1"><div class="li"> always-promote-attributes</div>
 149 </li>
 150 <li class="level1"><div class="li"> attribute-promotion</div>
 151 </li>
 152 <li class="level1"><div class="li"> bitmap-directory</div>
 153 </li>
 154 <li class="level1"><div class="li"> bus-ripper-symname</div>
 155 </li>
 156 <li class="level1"><div class="li"> font-directory</div>
 157 </li>
 158 <li class="level1"><div class="li"> keep-invisible</div>
 159 </li>
 160 <li class="level1"><div class="li"> map-font-character-to-file</div>
 161 </li>
 162 <li class="level1"><div class="li"> postscript-prolog</div>
 163 </li>
 164 <li class="level1"><div class="li"> promote-invisible</div>
 165 </li>
 166 <li class="level1"><div class="li"> scheme-directory</div>
 167 </li>
 168 <li class="level1"><div class="li"> untitled-name</div>
 169 </li>
 170 <li class="level1"><div class="li"> world-size</div>
 171 </li>
 172 </ul>
 173
 174 <p>
 175
 176 Smob type manipulators:
 177
 178 </p>
 179 <ul>
 180 <li class="level1"><div class="li"> get-attribute-name-value</div>
 181 </li>
 182 <li class="level1"><div class="li"> get-attribute-bounds</div>
 183 </li>
 184 <li class="level1"><div class="li"> get-attribute-angle</div>
 185 </li>
 186 <li class="level1"><div class="li"> calcule-new-attrib-bounds</div>
 187 </li>
 188 <li class="level1"><div class="li"> get-object-attributes</div>
 189 </li>
 190 <li class="level1"><div class="li"> get-attrib-value-by-attrib-name</div>
 191 </li>
 192 <li class="level1"><div class="li"> get-object-type</div>
 193 </li>
 194 <li class="level1"><div class="li"> get-line-width</div>
 195 </li>
 196 <li class="level1"><div class="li"> get-page-filename</div>
 197 </li>
 198 </ul>
 199
 200 </div>
 201 <!-- EDIT297 SECTION "libgeda C library reference" [250-1700] -->
 202 <h3 class="sectionedit298"><a name="libgeda_gedascm" id="libgeda_gedascm">libgeda geda.scm</a></h3>
 203 <div class="level3">
 204
 205 <p>
 206
 207 geda.scm, installed with libgeda, provides several useful functions for doing simple manipulation of paths and files, as well as loading rc files from gafrc.d directories.
 208 </p>
 209
 210 </div>
 211
 212 <h4><a name="functions1" id="functions1">Functions</a></h4>
 213 <div class="level4">
 214 <ul>
 215 <li class="level1"><div class="li"> build-path</div>
 216 </li>
 217 <li class="level1"><div class="li"> regular-file?</div>
 218 </li>
 219 <li class="level1"><div class="li"> directory?</div>
 220 </li>
 221 <li class="level1"><div class="li"> has-suffix?</div>
 222 </li>
 223 <li class="level1"><div class="li"> load-scheme-dir</div>
 224 </li>
 225 </ul>
 226
 227 </div>
 228 <!-- EDIT298 SECTION "libgeda geda.scm" [1701-] --></body>
 229 </html>