1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
|
#!/bin/bash
ulimit -t 5
ulimit -v 80000
export HOME=/tmp
cd /tmp
# read the config
. /etc/pcblib.cgi.conf
CGI=$CGI_param
# import the lib
. $pcb_rnd_util/cgi_common.sh
gen()
{
cd $gendir
./$gen "$fp_params"
}
help_params()
{
awk -v "CGI=$CGI" "$@" '
BEGIN {
prm=0
q="\""
fp_base=fp
sub("[(].*", "", fp_base)
thumbsize=1
}
function urlencode(s)
{
gsub("[#]", "%23", s)
return s
}
function proc_include(fn)
{
close(fn)
while((getline < fn) == 1)
proc_line()
close(fn)
}
function proc_line()
{
if (/^[^\"]*@@include/) {
proc_include(gendir "/" $2)
return
}
if ((match($0, "@@desc") || match($0, "@@params") || match($0, "@@purpose") || match($0, "@@example"))) {
txt=$0
key=substr($0, RSTART, RLENGTH)
sub(".*" key "[ \t]*", "", txt)
HELP[key] = HELP[key] " " txt
return
}
if (/@@thumbsize/) {
sub(".*@@thumbsize", "", $0)
if ($1 ~ ":") {
sub("^:", "", $1)
PDATA[$1,"thumbsize"] = $2
}
else
thumbsize=$1
return
}
if (/@@thumbnum/) {
sub(".*@@thumbnum", "", $0)
if ($1 ~ ":") {
sub("^:", "", $1)
PDATA[$1,"thumbnum"] = $2
}
return
}
if (/@@param:/) {
sub(".*@@param:", "", $0)
p=$1
sub(p "[\t ]*", "", $0)
PARAM[prm] = p
PDESC[prm] = $0
prm++
return
}
# build PPROP[paramname,propname], e.g. PPROP[pin_mask, dim]=1
if (/@@optional:/ || /@@dim:/ || /@@bool:/) {
key = $0
sub("^.*@@", "", key)
val = key
sub(":.*", "", key)
sub("^[^:]*:", "", val)
PPROP[val,key] = 1
return
}
# build PDATA[paramname,propname], e.g. PDATA[pin_mask, default]=123
if ((/@@default:/) || (/@@preview_args:/)) {
key = $1
txt = $0
txt = substr(txt, length(key)+1, length(txt))
sub("^[ \t]*", "", txt)
sub("^.*@@", "", key)
val = key
sub(":.*", "", key)
sub("^[^:]*:", "", val)
PDATA[val,key] = txt
return
}
# build:
# PDATAK[paramname,n]=key (name of the value)
# PDATAV[paramname,n]=description (of the given value)
# PDATAN[paramname]=n number of parameter values
if (/@@enum:/) {
key = $1
txt = $0
txt = substr(txt, length(key)+1, length(txt))
sub("^[ \t]*", "", txt)
sub("^.*@@enum:", "", key)
val = key
sub(":.*", "", key)
sub("^[^:]*:", "", val)
idx = int(PDATAN[key])
PDATAK[key,idx] = val
PDATAV[key,idx] = txt
PDATAN[key]++
return
}
}
{ proc_line() }
function thumb(prv, gthumbsize, lthumbsize, thumbnum ,lnk,lnk_gen, thumbsize,ann)
{
if (lthumbsize != "")
thumbsize = lthumbsize
else
thumbsize = gthumbsize
if (!thumbnum)
ann="&annotation=none"
lnk=q CGI "?cmd=" prv "&output=svg&grid=none" ann "&thumb=" thumbsize q
lnk_gen=q CGI "?cmd=" prv q
print "<a href=" lnk_gen ">"
print "<img src=" lnk ">"
print "</a>"
}
END {
if (header) {
print "<b>" HELP["@@purpose"] "</b>"
print "<p>"
print HELP["@@desc"]
}
if (content)
print "<h4>" content "</h4>"
if ((print_params) && (HELP["@@params"] != ""))
print "<p>Ordered list (positions): " HELP["@@params"]
if (content) {
print "<table border=1 cellspacing=0 cellpadding=10>"
print "<tr><th align=left>name <th align=left>man<br>dat<br>ory<th align=left>description <th align=left>value (bold: default)"
for(p = 0; p < prm; p++) {
name=PARAM[p]
print "<tr><td>" name
if (PPROP[name, "optional"])
print "<td> "
else
print "<td> yes"
print "<td>" PDESC[p]
print "<td>"
vdone=0
if (PDATAN[name] > 0) {
print "<table border=1 cellpadding=10 cellspacing=0>"
for(v = 0; v < PDATAN[name]; v++) {
print "<tr><td>"
isdef = (PDATA[name, "default"] == PDATAK[name, v])
if (isdef)
print "<b>"
print PDATAK[name, v]
if (isdef)
print "</b>"
print "<td>" PDATAV[name, v]
if (PDATA[name, "preview_args"] != "") {
prv= fp_base "(" PDATA[name, "preview_args"] "," name "=" PDATAK[name, v] ")"
print "<td>"
thumb(prv, thumbsize, PDATA[name, "thumbsize"], PDATA[name, "thumbnum"])
}
}
print "</table>"
vdone++
}
if (PPROP[name, "dim"]) {
print "Dimension: a number with an optional unit (mm or mil, default is mil)"
if (PDATA[name, "default"] != "")
print "<br>Default: <b>" PDATA[name, "default"] "</b>"
vdone++
}
if (PPROP[name, "bool"]) {
print "Boolean: yes/no, true/false, 1/0"
if (PDATA[name, "default"] != "")
print "; Default: <b>" PDATA[name, "default"] "</b>"
if (PDATA[name, "preview_args"] != "") {
print "<br>"
print "<table border=0>"
print "<tr><td>true:<td>"
thumb(fp_base "(" PDATA[name, "preview_args"] "," name "=" 1 ")", thumbsize, PDATA[name, "thumbsize"], PDATA[name, "thumbnum"])
print "<td>false:<td>"
thumb(fp_base "(" PDATA[name, "preview_args"] "," name "=" 0 ")", thumbsize, PDATA[name, "thumbsize"], PDATA[name, "thumbnum"])
print "</table>"
}
}
if (!vdone)
print " "
}
print "</table>"
}
if (footer) {
print "<h3>Example</h3>"
print "<a href=" q CGI "?cmd=" urlencode(HELP["@@example"]) q ">"
print HELP["@@example"]
print "</a>"
print "</body></html>"
}
}
'
}
help()
{
local incl n
echo "
<html>
<body>
<h1> pcblib-param help for $QS_cmd() </h1>
"
incl=`tempfile`
# generate the table
help_params -v "fp=$QS_cmd" -v "header=1" -v "content=$gen parameters" -v "print_params=1" -v "gendir=$gendir" < $gendir/$gen
# generate the footer
help_params -v "fp=$QS_cmd" -v "footer=1" -v "gendir=$gendir" < $gendir/$gen 2>/dev/null
}
list_gens()
{
awk -v "CGI=$CGI" '
BEGIN {
q="\""
}
/@@purpose/ {
sub(".*@@purpose", "", $0)
PURPOSE[FILENAME] = PURPOSE[FILENAME] $0
next
}
/@@example/ {
sub(".*@@example", "", $0)
EXAMPLE[FILENAME] = EXAMPLE[FILENAME] $0
next
}
/@@params/ {
sub(".*@@params", "", $0)
PARAMS[FILENAME] = PARAMS[FILENAME] $0
next
}
function urlencode(s)
{
gsub("[#]", "%23", s)
return s
}
END {
for(fn in PURPOSE) {
gn=fn
sub(".*/", "", gn)
params=PARAMS[fn]
sub("^[ \t]*", "", params)
sub("[ \t]*$", "", params)
print "<li> <a href=" q CGI "?cmd=" urlencode(EXAMPLE[fn]) q ">" gn "(<small>" params "</small>) </a> - " PURPOSE[fn]
print "- <a href=" q CGI "?cmd=" gn "&output=help" q "> HELP </a>"
}
}
' $gendir/*
}
qs=`echo "$QUERY_STRING" | tr "&" "\n"`
for n in $qs
do
exp="QS_$n"
export $exp
done
export QS_cmd=`echo "$QS_cmd" | url_decode`
if test -z "$QS_cmd"
then
export QS_cmd='connector(2,3)'
gen=connector
else
gen=`awk -v "n=$QS_cmd" '
BEGIN {
sub("[(].*", "", n)
gsub("[^a-zA-Z0-9_-]", "", n)
print n
}
'`
ptmp=`grep "@@purpose" $gendir/$gen`
if test -z "$ptmp"
then
error "Invalid generator \"$gen\" (file)"
fi
fi
if test "$QS_output" = "help"
then
echo "Content-type: text/html"
echo ""
help
exit
fi
fp_params=`echo $QS_cmd | sed "s/.*[(]//;s/[)]//" `
export fp_full="$gen($fp_params)"
fptext=`gen`
if test ! "$?" = 0
then
echo "Content-type: text/plain"
echo ""
echo "Error generating the footprint:"
gen 2>&1 | grep -i error
exit
fi
if test "$QS_output" = "text"
then
echo "Content-type: text/plain"
echo ""
gen
exit
fi
if test "$QS_output" = "svg"
then
cgi_svg
exit
fi
echo "Content-type: text/html"
echo ""
echo "<html>"
echo "<body>"
echo "<H1> pcblib-param test page </H1>"
echo '
<table border=1 cellpadding=10 cellspacing=0>
<tr><td bgcolor="lightgrey">
<i>
"Do you remember the good old days? When I was
<br> young, I said <b>footprint=CONNECTOR 2 13</b>
<br> in gschem and got a 2*13 pin connector in PCB."</i>
</table>
<br> <br>
<p>
<table border=0 cellpadding=10 cellspacing=10>
<tr>
<td valign=top width=40%>
<h3> Syntax </h3>
<p>
In <a href="http://repo.hu/projects/pcb-rnd">pcb-rnd</a>,
automatic footprint generation on the fly is called "parametric
footprints". It is a smaller and more generic infrastructure compared
to the m4 footprints in pcb. The goal was to fix three problems.
<ul>
<li> 1. Languages: m4 should not be mandatory for footprint generators - the user should be free to choose any language
<li> 2. Simplicity: references to m4 should not be hardwired in pcb, gsch2pcb and gsch2pcb.scm, but footprint generation should be generic, transparent and external
<li> 3. Unambiguity: gsch2pcb should not be guessing whether to use file elements or call a generator. Instead of complex heuristics, there should be a simple, distinct syntax for parametric footprints.
</ul>
<p>
The new syntax is that if a footprint attribute contains parenthesis, it is
a parametric footprint, else it is a file footprint. Parametric footprints
are sort of a function call. The actual syntax is similar to the one in
<a href="http://www.openscad.org"> openscad </a>:
parameters are separated by commas, and they are either positional (value)
or named (name=value).
<p>
For example a simple pin-grid
connector has the "prototype" of <i>connector(nx, ny, spacing)</i>, where
nx and ny are the number of pins needed in X and Y directions, spacing is
the distance between pin centers, with a default of 100 mil. The following
calls will output the same 2*3 pin, 100 mil footprint:
<ul>
<li> connector(2, 3)
<li> connector(2, 3, 100)
<li> connector(nx=2, ny=3, spacing=100)
<li> connector(spacing=100, nx=2, ny=3)
<li> connector(ny=3, spacing=100, nx=2)
</ul>
<td>
<td valign=top bgcolor="#eefeee">
<h3>Generators available</h3>
<ul>
'
list_gens
echo '
</ul>
</table>
'
echo "<h2> Try it online </h2>"
echo "<b>source:</b>"
echo "<form action=\"$CGI\" method=get>"
echo "<textarea id=\"cmd\" name=\"cmd\" cols=80 rows=3>$QS_cmd</textarea>"
echo "<ul>"
echo " <li><input type=\"checkbox\" name=\"mm\" value=\"1\" `checked $QS_mm`> draw grid in mm"
echo " <li><input type=\"checkbox\" name=\"photo\" value=\"1\" `checked $QS_photo`> draw in \"photo mode\""
echo " <li><input type=\"checkbox\" name=\"struct\" value=\"1\" `checked $QS_struct`> draw in \"mask and paste\""
echo " <li><input type=\"checkbox\" name=\"pins\" value=\"1\" `checked $QS_pins`> annotate pin names"
echo " <li><input type=\"checkbox\" name=\"dimname\" value=\"1\" `checked $QS_dimname`> annotate dimension names"
echo " <li><input type=\"checkbox\" name=\"dimvalue\" value=\"1\" `checked $QS_dimvalue`> annotate dimension values (in grid units)"
#echo " <li><input type=\"checkbox\" name=\"background\" value=\"1\" `checked $QS_background`> lighten annotataion background"
echo "</ul>"
echo "<p>"
echo "<input type=\"submit\" value=\"Generate my footprint!\">"
echo "</form>"
QS_format=${QS_cmd##*_}
QS_cmd_=${QS_cmd%%_*}
if test ! -z "$QS_cmd"
then
echo "<h2> Result </h2>"
echo "<h3> $QS_cmd </H3>"
echo "<p>Download <a href=\"$CGI?$QUERY_STRING&output=text\">footprint file</a>"
echo "<br><img src=\"$CGI?$QUERY_STRING&output=svg\" width=100%>"
fi
echo "</body>"
echo "</html>"
|