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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   4  lang="en" dir="ltr">
   5 <head>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   7   <title>geda:guile_scripting</title>
   8 <meta name="generator" content="DokuWiki Release rc2007-05-24" />
   9 <meta name="robots" content="index,follow" />
  10 <meta name="date" content="2007-12-20T12:38:57-0500" />
  11 <meta name="keywords" content="geda,guile_scripting" />
  12 <link rel="search" type="application/opensearchdescription+xml" href="http://geda.seul.org/wiki/lib/exe/opensearch.php" title="geda Wiki" />
  13 <link rel="start" href="http://geda.seul.org/wiki/" />
  14 <link rel="contents" href="http://geda.seul.org/wiki/geda:guile_scripting?do=index" title="Index" />
  15 <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="http://geda.seul.org/wiki/feed.php" />
  16 <link rel="alternate" type="application/rss+xml" title="Current Namespace" href="http://geda.seul.org/wiki/feed.php?mode=list&ns=geda" />
  17 <link rel="alternate" type="text/html" title="Plain HTML" href="http://geda.seul.org/wiki/_export/xhtml/geda:guile_scripting" />
  18 <link rel="alternate" type="text/plain" title="Wiki Markup" href="http://geda.seul.org/wiki/_export/raw/geda:guile_scripting" />
  19 <link rel="stylesheet" media="all" type="text/css" href="lib/exe/css" />
  20 <link rel="stylesheet" media="screen" type="text/css" href="lib/exe/001css" />
  21 <link rel="stylesheet" media="print" type="text/css" href="lib/exe/002css" />
  22 </head>
  23 <body>
  24 <div class="dokuwiki export">
  25 <div class="toc">
  26 <div class="tocheader toctoggle" id="toc__header">Table of Contents</div>
  27 <div id="toc__inside">
  28
  29 <ul class="toc">
  30 <li class="clear">
  31
  32 <ul class="toc">
  33 <li class="level2"><div class="li"><span class="li"><a href="#guile_scripting_reference" class="toc">Guile scripting reference</a></span></div>
  34 <ul class="toc">
  35 <li class="level3"><div class="li"><span class="li"><a href="#libgeda_c_library" class="toc">libgeda C library</a></span></div></li>
  36 <li class="level3"><div class="li"><span class="li"><a href="#libgeda_geda.scm" class="toc">libgeda geda.scm</a></span></div></li></ul>
  37 </li></ul>
  38 </li></ul>
  39 </div>
  40 </div>
  41
  42
  43
  44 <h2><a name="guile_scripting_reference" id="guile_scripting_reference">Guile scripting reference</a></h2>
  45 <div class="level2">
  46
  47 </div>
  48 <!-- SECTION "Guile scripting reference" [1-39] -->
  49 <h3><a name="libgeda_c_library" id="libgeda_c_library">libgeda C library</a></h3>
  50 <div class="level3">
  51
  52 <p>
  53  libgeda defines a number of low-level functions in C for configuring its behaviour and manipulating features such as the component and subcircuit libraries.
  54 </p>
  55
  56 </div>
  57
  58 <h4><a name="types" id="types">Types</a></h4>
  59 <div class="level4">
  60 <ul>
  61 <li class="level1"><div class="li"> attribute</div>
  62 </li>
  63 <li class="level1"><div class="li"> object</div>
  64 </li>
  65 <li class="level1"><div class="li"> page</div>
  66 </li>
  67 </ul>
  68
  69 </div>
  70
  71 <h4><a name="variables" id="variables">Variables</a></h4>
  72 <div class="level4">
  73
  74 <p>
  75  Basic configuration (defined by libgeda, read-only)
  76 </p>
  77 <ul>
  78 <li class="level1"><div class="li"> path-sep</div>
  79 </li>
  80 <li class="level1"><div class="li"> geda-rc-path</div>
  81 </li>
  82 <li class="level1"><div class="li"> geda-data-path</div>
  83 </li>
  84 </ul>
  85
  86 <p>
  87  Object type identifiers (defined by libgeda, read-only)
  88 </p>
  89 <ul>
  90 <li class="level1"><div class="li"> OBJ_LINE</div>
  91 </li>
  92 <li class="level1"><div class="li"> OBJ_BOX</div>
  93 </li>
  94 <li class="level1"><div class="li"> OBJ_PICTURE</div>
  95 </li>
  96 <li class="level1"><div class="li"> OBJ_CIRCLE</div>
  97 </li>
  98 <li class="level1"><div class="li"> OBJ_NET</div>
  99 </li>
 100 <li class="level1"><div class="li"> OBJ_BUS</div>
 101 </li>
 102 <li class="level1"><div class="li"> OBJ_COMPLEX</div>
 103 </li>
 104 <li class="level1"><div class="li"> OBJ_TEXT</div>
 105 </li>
 106 <li class="level1"><div class="li"> OBJ_<acronym title="Personal Identification Number">PIN</acronym></div>
 107 </li>
 108 <li class="level1"><div class="li"> OBJ_ARC</div>
 109 </li>
 110 <li class="level1"><div class="li"> OBJ_ROUTE</div>
 111 </li>
 112 <li class="level1"><div class="li"> OBJ_THRU_HOLE</div>
 113 </li>
 114 <li class="level1"><div class="li"> OBJ_PLACEHOLDER</div>
 115 </li>
 116 </ul>
 117
 118 </div>
 119
 120 <h4><a name="functions" id="functions">Functions</a></h4>
 121 <div class="level4">
 122
 123 <p>
 124  Component library:
 125 </p>
 126 <ul>
 127 <li class="level1"><div class="li"> component-library</div>
 128 </li>
 129 <li class="level1"><div class="li"> component-library-command</div>
 130 </li>
 131 <li class="level1"><div class="li"> component-library-funcs</div>
 132 </li>
 133 <li class="level1"><div class="li"> component-library-search</div>
 134 </li>
 135 <li class="level1"><div class="li"> reset-component-library</div>
 136 </li>
 137 </ul>
 138
 139 <p>
 140  Subcircuit library:
 141 </p>
 142 <ul>
 143 <li class="level1"><div class="li"> source-library</div>
 144 </li>
 145 <li class="level1"><div class="li"> source-library-search</div>
 146 </li>
 147 <li class="level1"><div class="li"> reset-source-library</div>
 148 </li>
 149 </ul>
 150
 151 <p>
 152  Libgeda behaviour configuration (write-only):
 153 </p>
 154 <ul>
 155 <li class="level1"><div class="li"> always-promote-attributes</div>
 156 </li>
 157 <li class="level1"><div class="li"> attribute-promotion</div>
 158 </li>
 159 <li class="level1"><div class="li"> bitmap-directory</div>
 160 </li>
 161 <li class="level1"><div class="li"> bus-ripper-symname</div>
 162 </li>
 163 <li class="level1"><div class="li"> default-series-name</div>
 164 </li>
 165 <li class="level1"><div class="li"> font-directory</div>
 166 </li>
 167 <li class="level1"><div class="li"> keep-invisible</div>
 168 </li>
 169 <li class="level1"><div class="li"> map-font-character-to-file</div>
 170 </li>
 171 <li class="level1"><div class="li"> postscript-prolog</div>
 172 </li>
 173 <li class="level1"><div class="li"> promote-invisible</div>
 174 </li>
 175 <li class="level1"><div class="li"> scheme-directory</div>
 176 </li>
 177 <li class="level1"><div class="li"> untitled-name</div>
 178 </li>
 179 <li class="level1"><div class="li"> world-size</div>
 180 </li>
 181 </ul>
 182
 183 <p>
 184  Smob type manipulators:
 185 </p>
 186 <ul>
 187 <li class="level1"><div class="li"> get-attribute-name-value</div>
 188 </li>
 189 <li class="level1"><div class="li"> get-attribute-bounds</div>
 190 </li>
 191 <li class="level1"><div class="li"> get-attribute-angle</div>
 192 </li>
 193 <li class="level1"><div class="li"> calcule-new-attrib-bounds</div>
 194 </li>
 195 <li class="level1"><div class="li"> get-object-attributes</div>
 196 </li>
 197 <li class="level1"><div class="li"> get-attrib-value-by-attrib-name</div>
 198 </li>
 199 <li class="level1"><div class="li"> get-object-type</div>
 200 </li>
 201 <li class="level1"><div class="li"> get-line-width</div>
 202 </li>
 203 <li class="level1"><div class="li"> get-page-filename</div>
 204 </li>
 205 </ul>
 206
 207 </div>
 208 <!-- SECTION "libgeda C library" [40-1504] -->
 209 <h3><a name="libgeda_geda.scm" id="libgeda_geda.scm">libgeda geda.scm</a></h3>
 210 <div class="level3">
 211
 212 <p>
 213  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.
 214 </p>
 215
 216 </div>
 217
 218 <h4><a name="functions1" id="functions1">Functions</a></h4>
 219 <div class="level4">
 220 <ul>
 221 <li class="level1"><div class="li"> build-path</div>
 222 </li>
 223 <li class="level1"><div class="li"> regular-file?</div>
 224 </li>
 225 <li class="level1"><div class="li"> directory?</div>
 226 </li>
 227 <li class="level1"><div class="li"> has-suffix?</div>
 228 </li>
 229 <li class="level1"><div class="li"> load-scheme-dir</div>
 230 </li>
 231 </ul>
 232
 233 </div>
 234 <!-- SECTION "libgeda geda.scm" [1505-] --></div>
 235 </body>
 236 </html>