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 <div class="toc">
  15 <div class="tocheader toctoggle" id="toc__header">Table of Contents</div>
  16 <div id="toc__inside">
  17
  18 <ul class="toc">
  19 <li class="clear">
  20
  21 <ul class="toc">
  22 <li class="level2"><div class="li"><span class="li"><a href="#guile_scripting_reference" class="toc">Guile scripting reference</a></span></div>
  23 <ul class="toc">
  24 <li class="level3"><div class="li"><span class="li"><a href="#libgeda_c_library" class="toc">libgeda C library</a></span></div></li>
  25 <li class="level3"><div class="li"><span class="li"><a href="#libgeda_geda.scm" class="toc">libgeda geda.scm</a></span></div></li></ul>
  26 </li></ul>
  27 </li></ul>
  28 </div>
  29 </div>
  30
  31
  32
  33 <h2><a name="guile_scripting_reference" id="guile_scripting_reference">Guile scripting reference</a></h2>
  34 <div class="level2">
  35
  36 </div>
  37 <!-- SECTION "Guile scripting reference" [1-40] -->
  38 <h3><a name="libgeda_c_library" id="libgeda_c_library">libgeda C library</a></h3>
  39 <div class="level3">
  40
  41 <p>
  42  libgeda defines a number of low-level functions in C for configuring its behaviour and manipulating features such as the component and subcircuit libraries.
  43 </p>
  44
  45 </div>
  46
  47 <h4><a name="types" id="types">Types</a></h4>
  48 <div class="level4">
  49 <ul>
  50 <li class="level1"><div class="li"> attribute</div>
  51 </li>
  52 <li class="level1"><div class="li"> object</div>
  53 </li>
  54 <li class="level1"><div class="li"> page</div>
  55 </li>
  56 </ul>
  57
  58 </div>
  59
  60 <h4><a name="variables" id="variables">Variables</a></h4>
  61 <div class="level4">
  62
  63 <p>
  64  Basic configuration (defined by libgeda, read-only)
  65 </p>
  66 <ul>
  67 <li class="level1"><div class="li"> path-sep</div>
  68 </li>
  69 <li class="level1"><div class="li"> geda-rc-path</div>
  70 </li>
  71 <li class="level1"><div class="li"> geda-data-path</div>
  72 </li>
  73 </ul>
  74
  75 <p>
  76  Object type identifiers (defined by libgeda, read-only)
  77 </p>
  78 <ul>
  79 <li class="level1"><div class="li"> OBJ_LINE</div>
  80 </li>
  81 <li class="level1"><div class="li"> OBJ_BOX</div>
  82 </li>
  83 <li class="level1"><div class="li"> OBJ_PICTURE</div>
  84 </li>
  85 <li class="level1"><div class="li"> OBJ_CIRCLE</div>
  86 </li>
  87 <li class="level1"><div class="li"> OBJ_NET</div>
  88 </li>
  89 <li class="level1"><div class="li"> OBJ_BUS</div>
  90 </li>
  91 <li class="level1"><div class="li"> OBJ_COMPLEX</div>
  92 </li>
  93 <li class="level1"><div class="li"> OBJ_TEXT</div>
  94 </li>
  95 <li class="level1"><div class="li"> OBJ_<acronym title="Personal Identification Number">PIN</acronym></div>
  96 </li>
  97 <li class="level1"><div class="li"> OBJ_ARC</div>
  98 </li>
  99 <li class="level1"><div class="li"> OBJ_ROUTE</div>
 100 </li>
 101 <li class="level1"><div class="li"> OBJ_THRU_HOLE</div>
 102 </li>
 103 <li class="level1"><div class="li"> OBJ_PLACEHOLDER</div>
 104 </li>
 105 </ul>
 106
 107 </div>
 108
 109 <h4><a name="functions" id="functions">Functions</a></h4>
 110 <div class="level4">
 111
 112 <p>
 113  Component library:
 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  Subcircuit library:
 130 </p>
 131 <ul>
 132 <li class="level1"><div class="li"> source-library</div>
 133 </li>
 134 <li class="level1"><div class="li"> source-library-search</div>
 135 </li>
 136 <li class="level1"><div class="li"> reset-source-library</div>
 137 </li>
 138 </ul>
 139
 140 <p>
 141  Libgeda behaviour configuration (write-only):
 142 </p>
 143 <ul>
 144 <li class="level1"><div class="li"> always-promote-attributes</div>
 145 </li>
 146 <li class="level1"><div class="li"> attribute-promotion</div>
 147 </li>
 148 <li class="level1"><div class="li"> bitmap-directory</div>
 149 </li>
 150 <li class="level1"><div class="li"> bus-ripper-symname</div>
 151 </li>
 152 <li class="level1"><div class="li"> font-directory</div>
 153 </li>
 154 <li class="level1"><div class="li"> keep-invisible</div>
 155 </li>
 156 <li class="level1"><div class="li"> map-font-character-to-file</div>
 157 </li>
 158 <li class="level1"><div class="li"> postscript-prolog</div>
 159 </li>
 160 <li class="level1"><div class="li"> promote-invisible</div>
 161 </li>
 162 <li class="level1"><div class="li"> scheme-directory</div>
 163 </li>
 164 <li class="level1"><div class="li"> untitled-name</div>
 165 </li>
 166 <li class="level1"><div class="li"> world-size</div>
 167 </li>
 168 </ul>
 169
 170 <p>
 171  Smob type manipulators:
 172 </p>
 173 <ul>
 174 <li class="level1"><div class="li"> get-attribute-name-value</div>
 175 </li>
 176 <li class="level1"><div class="li"> get-attribute-bounds</div>
 177 </li>
 178 <li class="level1"><div class="li"> get-attribute-angle</div>
 179 </li>
 180 <li class="level1"><div class="li"> calcule-new-attrib-bounds</div>
 181 </li>
 182 <li class="level1"><div class="li"> get-object-attributes</div>
 183 </li>
 184 <li class="level1"><div class="li"> get-attrib-value-by-attrib-name</div>
 185 </li>
 186 <li class="level1"><div class="li"> get-object-type</div>
 187 </li>
 188 <li class="level1"><div class="li"> get-line-width</div>
 189 </li>
 190 <li class="level1"><div class="li"> get-page-filename</div>
 191 </li>
 192 </ul>
 193
 194 </div>
 195 <!-- SECTION "libgeda C library" [41-1481] -->
 196 <h3><a name="libgeda_geda.scm" id="libgeda_geda.scm">libgeda geda.scm</a></h3>
 197 <div class="level3">
 198
 199 <p>
 200  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.
 201 </p>
 202
 203 </div>
 204
 205 <h4><a name="functions1" id="functions1">Functions</a></h4>
 206 <div class="level4">
 207 <ul>
 208 <li class="level1"><div class="li"> build-path</div>
 209 </li>
 210 <li class="level1"><div class="li"> regular-file?</div>
 211 </li>
 212 <li class="level1"><div class="li"> directory?</div>
 213 </li>
 214 <li class="level1"><div class="li"> has-suffix?</div>
 215 </li>
 216 <li class="level1"><div class="li"> load-scheme-dir</div>
 217 </li>
 218 </ul>
 219
 220 </div>
 221 <!-- SECTION "libgeda geda.scm" [1482-] --></body>
 222 </html>