| blob | 665ae91ea8c77ad92af642d6b0ea75aca59f12c1 |
1 /*
2 * COPYRIGHT
3 *
4 * PCB, interactive printed circuit board design
5 * Copyright (C) 1994,1995,1996 Thomas Nau
6 * Copyright (C) 1997, 1998, 1999, 2000, 2001 Harry Eaton
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 * Contact addresses for paper mail and Email:
23 * Harry Eaton, 6697 Buttonhole Ct, Columbia, MD 21044, USA
24 * haceaton@aplcomm.jhuapl.edu
25 *
26 */
28 /* action routines for output window
29 */
31 #ifdef HAVE_CONFIG_H
33 #endif
59 /*#include "print.h"*/
74 #include <assert.h>
77 #ifdef HAVE_LIBDMALLOC
78 #include <dmalloc.h>
79 #endif
81 /* for fork() and friends */
82 #ifdef HAVE_UNISTD_H
83 #include <unistd.h>
84 #endif
86 #ifdef HAVE_SYS_WAIT_H
87 #include <sys/wait.h>
88 #endif
90 /* ---------------------------------------------------------------------------
91 * some local types
92 */
94 {
95 F_AddSelected,
96 F_All,
97 F_AllConnections,
98 F_AllRats,
99 F_AllUnusedPins,
100 F_Arc,
101 F_Arrow,
102 F_Block,
103 F_Description,
104 F_Cancel,
105 F_Center,
106 F_Clear,
107 F_ClearAndRedraw,
108 F_ClearList,
109 F_Close,
110 F_Connection,
111 F_Convert,
112 F_Copy,
113 F_CycleClip,
114 F_CycleCrosshair,
115 F_DeleteRats,
116 F_Drag,
117 F_DrillReport,
118 F_Element,
119 F_ElementByName,
120 F_ElementConnections,
121 F_ElementToBuffer,
122 F_Escape,
123 F_Find,
124 F_FlipElement,
125 F_FoundPins,
126 F_Grid,
127 F_InsertPoint,
128 F_Layer,
129 F_Layout,
130 F_LayoutAs,
131 F_LayoutToBuffer,
132 F_Line,
133 F_LineSize,
134 F_Lock,
135 F_Mirror,
136 F_Move,
137 F_NameOnPCB,
138 F_Netlist,
139 F_NetByName,
140 F_None,
141 F_Notify,
142 F_Object,
143 F_ObjectByName,
144 F_PasteBuffer,
145 F_PadByName,
146 F_PinByName,
147 F_PinOrPadName,
148 F_Pinout,
149 F_Polygon,
150 F_PolygonHole,
151 F_PreviousPoint,
152 F_RatsNest,
153 F_Rectangle,
154 F_Redraw,
155 F_Release,
156 F_Revert,
157 F_Remove,
158 F_RemoveSelected,
159 F_Report,
160 F_Reset,
161 F_ResetLinesAndPolygons,
162 F_ResetPinsViasAndPads,
163 F_Restore,
164 F_Rotate,
165 F_Save,
166 F_Selected,
167 F_SelectedArcs,
168 F_SelectedElements,
169 F_SelectedLines,
170 F_SelectedNames,
171 F_SelectedObjects,
172 F_SelectedPads,
173 F_SelectedPins,
174 F_SelectedTexts,
175 F_SelectedVias,
176 F_SelectedRats,
177 F_Stroke,
178 F_Text,
179 F_TextByName,
180 F_TextScale,
181 F_Thermal,
182 F_ToLayout,
183 F_ToggleAllDirections,
184 F_ToggleAutoDRC,
185 F_ToggleClearLine,
186 F_ToggleFullPoly,
187 F_ToggleGrid,
188 F_ToggleHideNames,
189 F_ToggleMask,
190 F_ToggleName,
191 F_ToggleObject,
192 F_ToggleShowDRC,
193 F_ToggleLiveRoute,
194 F_ToggleRubberBandMode,
195 F_ToggleStartDirection,
196 F_ToggleSnapPin,
197 F_ToggleThindraw,
198 F_ToggleLockNames,
199 F_ToggleOnlyNames,
200 F_ToggleThindrawPoly,
201 F_ToggleOrthoMove,
202 F_ToggleLocalRef,
203 F_ToggleCheckPlanes,
204 F_ToggleUniqueNames,
205 F_Via,
206 F_ViaByName,
207 F_Value,
208 F_ViaDrillingHole,
209 F_ViaSize,
210 F_Zoom
211 }
212 FunctionID;
215 {
217 FunctionID ID;
218 }
221 /* --------------------------------------------------------------------------- */
223 /* %start-doc actions 00delta
225 Many actions take a @code{delta} parameter as the last parameter,
226 which is an amount to change something. That @code{delta} may include
227 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
228 If no units are specified, the default is PCB's native units
229 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
230 @code{-}, the size is increased or decreased by that amount.
231 Otherwise, the size size is set to the given amount.
233 @example
234 Action(Object,5,mil)
235 Action(Object,+0.5,mm)
236 Action(Object,-1)
237 @end example
239 Actions which take a @code{delta} parameter which do not accept all
240 these options will specify what they do take.
242 %end-doc */
244 /* %start-doc actions 00objects
246 Many actions act on indicated objects on the board. They will have
247 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
248 what group of objects they act on. Unless otherwise specified, these
249 parameters are defined as follows:
251 @table @code
253 @item Object
254 @itemx ToggleObject
255 Affects the object under the mouse pointer. If this action is invoked
256 from a menu or script, the user will be prompted to click on an
257 object, which is then the object affected.
259 @item Selected
260 @itemx SelectedObjects
262 Affects all objects which are currently selected. At least, all
263 selected objects for which the given action makes sense.
265 @item SelectedPins
266 @itemx SelectedVias
267 @itemx Selected@var{Type}
268 @itemx @i{etc}
269 Affects all objects which are both selected and of the @var{Type} specified.
271 @end table
273 %end-doc */
275 /* %start-doc actions 00macros
277 @macro pinshapes
279 Pins, pads, and vias can have various shapes. All may be round. Pins
280 and pads may be square (obviously "square" pads are usually
281 rectangular). Pins and vias may be octagonal. When you change a
282 shape flag of an element, you actually change all of its pins and
283 pads.
285 Note that the square flag takes precedence over the octagon flag,
286 thus, if both the square and octagon flags are set, the object is
287 square. When the square flag is cleared, the pins and pads will be
288 either round or, if the octagon flag is set, octagonal.
290 @end macro
292 %end-doc */
294 /* ---------------------------------------------------------------------------
295 * some local identifiers
296 */
299 static struct
300 {
301 PolygonTypePtr poly;
302 LineType line;
303 }
304 fake;
306 static struct
307 {
309 Cardinal Buffer;
316 }
317 Note;
324 #ifdef HAVE_LIBSTROKE
327 #endif
445 };
447 /* ---------------------------------------------------------------------------
448 * some local routines
449 */
456 #ifdef HAVE_LIBSTROKE
461 #endif
464 #define ARG(n) (argc > (n) ? argv[n] : NULL)
466 #ifdef HAVE_LIBSTROKE
468 /* ---------------------------------------------------------------------------
469 * FinishStroke - try to recognize the stroke sent
470 */
471 void
473 {
481 {
484 {
487 {
489 }
544 {
548 /* XXX: PCB->MaxWidth and PCB->MaxHeight may be the wrong
549 * divisors below. The old code WAS broken, but this
550 * replacement has not been tested for correctness.
551 */
552 z =
556 z =
565 }
570 }
571 }
572 else
574 }
575 #endif
577 /* ---------------------------------------------------------------------------
578 * Clear warning color from pins/pads
579 */
580 static void
582 {
585 {
587 {
590 }
591 }
592 ENDALL_LOOP;
594 {
596 {
599 }
600 }
601 ENDALL_LOOP;
603 }
605 static void
607 {
609 {
613 {
623 }
625 {
634 }
635 else
636 {
637 BoxType box;
646 /* unselect first if shift key not down */
652 }
654 }
655 }
657 static void
659 {
660 BoxType box;
663 {
664 BoxType box;
673 /* unselect first if shift key not down */
675 {
679 {
683 }
684 }
690 }
692 {
699 }
701 {
704 }
706 {
721 }
725 }
727 /* ---------------------------------------------------------------------------
728 * get function ID of passed string
729 */
730 #define HSIZE 257
734 static int
736 {
739 {
742 s ++;
743 }
746 }
748 static int
750 {
757 {
760 {
764 }
766 {
767 /* Change 'char' to 'int' and remove this when we get to 256
768 strings to hash. */
773 }
775 {
780 }
781 }
785 {
786 /* We enforce the "hash table bigger than function table" rule,
787 so we know there will be at least one zero entry to find. */
793 }
794 }
796 /* ---------------------------------------------------------------------------
797 * set new coordinates if in 'RECTANGLE' mode
798 * the cursor shape is also adjusted
799 */
800 static void
802 {
804 {
807 }
809 {
811 {
812 /* update coordinates */
816 }
817 }
818 }
820 /* ---------------------------------------------------------------------------
821 * adjusts the objects which are to be created like attached lines...
822 */
823 void
825 {
826 PointTypePtr pnt;
828 {
829 /* update at least an attached block (selection) */
833 {
836 }
839 /* rectangle creation mode */
845 /* polygon creation mode */
850 /* line creation mode */
854 else
857 /* point insertion mode */
865 }
866 }
868 /* ---------------------------------------------------------------------------
869 * creates points of a line
870 */
871 static void
873 {
880 {
885 {
888 }
890 {
895 FOUNDFLAG);
896 }
898 {
903 }
905 {
910 {
913 }
914 else
915 {
918 }
919 }
920 else
921 {
926 }
931 /* fall through to third state too */
936 }
937 }
939 /* ---------------------------------------------------------------------------
940 * create first or second corner of a marked block
941 */
942 static void
944 {
947 {
959 }
961 }
964 /* ---------------------------------------------------------------------------
965 *
966 * does what's appropriate for the current mode setting. This normally
967 * means creation of an object at the current crosshair location.
968 *
969 * new created objects are added to the create undo list of course
970 */
971 static void
973 {
980 {
982 {
984 hidval hv;
987 /* do something after click time */
990 /* see if we clicked on something already selected
991 * (Note.Moving) or clicked on a MOVE_TYPE
992 * (Note.Hit)
993 */
996 {
1000 {
1005 }
1011 }
1013 }
1016 {
1017 PinTypePtr via;
1020 {
1024 }
1029 {
1036 }
1038 }
1041 {
1043 {
1054 {
1055 ArcTypePtr arc;
1062 {
1066 #ifdef ARC45
1069 else
1070 #endif
1072 }
1073 else
1074 {
1078 #ifdef ARC45
1081 else
1082 #endif
1085 }
1087 Crosshair.
1088 AttachedBox.
1090 Crosshair.
1091 AttachedBox.
1095 sa,
1096 dir,
1097 Settings.
1098 LineThickness,
1100 Keepaway,
1101 MakeFlags
1102 (TEST_FLAG
1104 PCB) ?
1105 CLEARLINEFLAG :
1107 {
1108 BoxTypePtr bx;
1117 addedLines++;
1121 }
1123 }
1124 }
1126 }
1128 {
1131 {
1136 {
1139 }
1140 END_LOOP;
1142 {
1145 }
1146 END_LOOP;
1148 /* always re-draw it since I'm too lazy
1149 * to tell if a selected flag changed
1150 */
1154 }
1156 {
1161 {
1162 /* this is not un-doable since LOCK isn't */
1166 }
1168 }
1170 }
1172 {
1174 =
1178 {
1180 {
1182 tstyle++;
1186 }
1189 else
1191 }
1193 }
1196 /* do update of position */
1201 /* Remove anchor if clicking on start point;
1202 * this means we can't paint 0 length lines
1203 * which could be used for square SMD pads.
1204 * Instead use a very small delta, or change
1205 * the file after saving.
1206 */
1209 {
1212 }
1215 {
1216 RatTypePtr line;
1218 {
1219 addedLines++;
1228 }
1230 }
1231 else
1232 /* create line if both ends are determined && length != 0 */
1233 {
1234 LineTypePtr line;
1244 {
1245 /* We will only need to paint the second line segment.
1246 Since we only check for vias on the first segment,
1247 swap them so the non-empty segment is the first segment. */
1250 }
1255 else
1271 (TEST_FLAG
1275 {
1276 PinTypePtr via;
1278 addedLines++;
1281 /* place a via if vias are visible, the layer is
1282 in a new group since the last line and there
1283 isn't a pin already here */
1290 NO_TYPE
1299 {
1302 }
1303 /* copy the coordinates */
1310 }
1324 (TEST_FLAG
1328 {
1329 addedLines++;
1333 /* move to new start point */
1339 {
1341 }
1342 }
1344 }
1348 /* do update of position */
1351 /* create rectangle if both corners are determined
1352 * and width, height are != 0
1353 */
1357 {
1358 PolygonTypePtr polygon;
1364 Crosshair.
1366 Crosshair.
1368 Crosshair.
1370 Crosshair.
1372 MakeFlags
1374 NULL)
1375 {
1381 }
1383 /* reset state to 'first corner' */
1385 }
1389 {
1393 {
1395 {
1396 TextTypePtr text;
1405 {
1410 }
1411 }
1413 }
1415 }
1418 {
1422 /* do update of position; use the 'LINE_MODE' mechanism */
1425 /* check if this is the last point of a polygon */
1429 {
1433 }
1435 /* create new point if it's the first one or if it's
1436 * different to the last one
1437 */
1441 {
1446 /* copy the coordinates */
1449 }
1451 }
1454 {
1456 {
1457 /* first notify, lookup object */
1466 {
1469 {
1473 }
1474 else
1476 }
1479 /* second notify, insert new point into object */
1481 {
1485 FlagType Flags;
1487 /* do update of position; use the 'LINE_MODE' mechanism */
1490 /* check if this is the last point of a polygon */
1494 {
1495 /* Create POLYAREAs from the original polygon
1496 * and the new hole polygon */
1500 /* Subtract the hole from the original polygon shape */
1503 /* Convert the resulting polygon(s) into a new set of nodes
1504 * and place them on the page. Delete the original polygon.
1505 */
1518 /* reset state of attached line */
1524 }
1526 /* create new point if it's the first one or if it's
1527 * different to the last one
1528 */
1532 {
1537 /* copy the coordinates */
1540 }
1542 }
1543 }
1546 }
1549 {
1554 {
1559 {
1562 {
1570 }
1571 }
1572 }
1576 {
1581 {
1588 {
1600 }
1601 }
1602 }
1604 }
1610 {
1612 {
1615 }
1617 {
1618 RubberbandTypePtr ptr;
1625 {
1632 else
1634 ptr++;
1635 }
1636 }
1640 }
1650 /* both are almost the same */
1654 {
1655 /* first notify, lookup object */
1657 {
1667 {
1671 {
1674 }
1675 else
1677 }
1679 }
1681 /* second notify, move or copy object */
1690 else
1691 {
1699 }
1702 /* reset identifiers */
1706 }
1709 /* insert a point into a polygon/line/... */
1712 {
1713 /* first notify, lookup object */
1722 {
1725 {
1729 }
1730 else
1731 {
1732 /* get starting point of nearest segment */
1734 {
1737 polyIndex =
1745 }
1748 }
1749 }
1752 /* second notify, insert new point into object */
1759 else
1767 /* reset identifiers */
1771 }
1773 }
1774 }
1777 /* --------------------------------------------------------------------------- */
1783 /* %start-doc actions Atomic
1785 This action allows making multiple-action bindings into an atomic
1786 operation that will be undone by a single Undo command. For example,
1787 to optimize rat lines, you'd delete the rats and re-add them. To
1788 group these into a single undo, you'd want the deletions and the
1789 additions to have the same undo serial number. So, you @code{Save},
1790 delete the rats, @code{Restore}, add the rats - using the same serial
1791 number as the deletes, then @code{Block}, which checks to see if the
1792 deletions or additions actually did anything. If not, the serial
1793 number is set to the saved number, as there's nothing to undo. If
1794 something did happen, the serial number is incremented so that these
1795 actions are counted as a single undo step.
1797 @table @code
1799 @item Save
1800 Saves the undo serial number.
1802 @item Restore
1803 Returns it to the last saved number.
1805 @item Close
1806 Sets it to 1 greater than the last save.
1808 @item Block
1809 Does a Restore if there was nothing to undo, else does a Close.
1811 @end table
1813 %end-doc */
1815 static int
1817 {
1822 {
1838 }
1840 }
1842 /* -------------------------------------------------------------------------- */
1848 /* %start-doc actions DRC
1850 Note that the design rule check uses the current board rule settings,
1851 not the current style settings.
1853 %end-doc */
1855 static int
1857 {
1861 {
1869 }
1872 {
1877 else
1879 }
1881 }
1883 /* -------------------------------------------------------------------------- */
1890 /* %start-doc actions DumpLibrary
1893 %end-doc */
1895 static int
1897 {
1904 {
1915 {
1918 {
1921 }
1922 else
1923 {
1930 }
1931 }
1932 }
1935 }
1937 /* -------------------------------------------------------------------------- */
1944 /* %start-doc actions Flip
1946 Note that the location of the element will be symmetric about the
1947 cursor location; i.e. if the part you are pointing at will still be at
1948 the same spot once the element is on the other side. When flipping
1949 multiple elements, this retains their positions relative to each
1950 other, not their absolute positions on the board.
1952 %end-doc */
1954 static int
1956 {
1958 ElementTypePtr element;
1963 {
1965 {
1969 {
1974 }
1983 }
1986 }
1989 }
1991 /* -------------------------------------------------------------------------- */
1997 /* %start-doc actions Message
1999 This action displays a message to the log window. This action is primarily
2000 provided for use by other programs which may interface with PCB. If
2001 multiple arguments are given, each one is sent to the log window
2002 followed by a newline.
2004 %end-doc */
2006 static int
2008 {
2015 {
2018 }
2021 }
2024 /* -------------------------------------------------------------------------- */
2034 "Style = 3 is a solid connection to the plane."
2038 /* %start-doc actions SetThermal
2040 This changes how/whether pins or vias connect to any rectangle or polygon
2041 on the current layer. The first argument can specify one object, or all
2042 selected pins, or all selected vias, or all selected pins and vias.
2043 The second argument specifies the style of connection.
2044 There are 5 possibilities:
2045 0 - no connection,
2046 1 - 45 degree fingers with sharp edges,
2047 2 - horizontal & vertical fingers with sharp edges,
2048 3 - solid connection,
2049 4 - 45 degree fingers with rounded corners,
2050 5 - horizontal & vertical fingers with rounded corners.
2052 Pins and Vias may have thermals whether or not there is a polygon available
2053 to connect with. However, they will have no effect without the polygon.
2054 %end-doc */
2056 static int
2058 {
2066 {
2072 {
2077 {
2081 }
2096 }
2097 else
2101 }
2104 }
2106 /* ---------------------------------------------------------------------------
2107 * !!! no action routine !!!
2108 *
2109 * event handler to set the cursor according to the X pointer position
2110 * called from inside main.c
2111 */
2112 void
2114 {
2115 #ifdef HAVE_LIBSTROKE
2117 {
2122 }
2125 {
2126 /* update object position and cursor location */
2129 }
2130 }
2132 /* --------------------------------------------------------------------------- */
2140 /* %start-doc actions SetValue
2142 @table @code
2144 @item ViaDrillingHole
2145 Changes the diameter of the drill for new vias.
2147 @item Grid
2148 Sets the grid spacing.
2150 @item Line
2151 @item LineSize
2152 Changes the thickness of new lines.
2154 @item Via
2155 @item ViaSize
2156 Changes the diameter of new vias.
2158 @item Text
2159 @item TextScale
2160 Changes the size of new text.
2162 @end table
2164 %end-doc */
2166 static int
2168 {
2178 {
2181 {
2192 else
2193 {
2194 /* On the way down, short against the minimum
2195 * PCB drawing unit */
2200 else
2202 }
2227 }
2230 }
2233 }
2236 /* --------------------------------------------------------------------------- */
2242 /* %start-doc actions Quit
2244 If you have unsaved changes, you will be prompted to confirm (or
2245 save) before quitting.
2247 %end-doc */
2249 static int
2251 {
2254 {
2257 }
2261 }
2263 /* --------------------------------------------------------------------------- */
2271 /* %start-doc actions Connection
2273 Connections found with this action will be highlighted in the
2274 ``connected-color'' color and will have the ``found'' flag set.
2276 @table @code
2278 @item Find
2279 The net under the cursor is ``found''.
2281 @item ResetLinesAndPolygons
2282 Any ``found'' lines and polygons are marked ``not found''.
2284 @item ResetPinsAndVias
2285 Any ``found'' pins and vias are marked ``not found''.
2287 @item Reset
2288 All ``found'' objects are marked ``not found''.
2290 @end table
2292 %end-doc */
2294 static int
2296 {
2299 {
2301 {
2303 {
2307 }
2311 {
2314 }
2319 {
2322 }
2327 {
2330 }
2332 }
2334 }
2337 }
2339 /* --------------------------------------------------------------------------- */
2346 /* %start-doc actions DisperseElements
2348 Normally this is used when starting a board, by selecting all elements
2349 and then dispersing them. This scatters the elements around the board
2350 so that you can pick individual ones, rather than have all the
2351 elements at the same 0,0 coordinate and thus impossible to choose
2352 from.
2354 %end-doc */
2356 #define GAP MIL_TO_COORD(100)
2358 static int
2360 {
2369 {
2371 }
2372 else
2373 {
2375 {
2386 }
2387 }
2390 {
2392 }
2396 {
2397 /*
2398 * If we want to disperse selected elements, maybe we need smarter
2399 * code here to avoid putting components on top of others which
2400 * are not selected. For now, I'm assuming that this is typically
2401 * going to be used either with a brand new design or a scratch
2402 * design holding some new components
2403 */
2405 {
2407 /* figure out how much to move the element */
2410 /* snap to the grid */
2413 /*
2414 * and add one grid size so we make sure we always space by GAP or
2415 * more
2416 */
2419 /* Figure out if this row has room. If not, start a new row */
2421 {
2424 }
2426 /* figure out how much to move the element */
2430 /* snap to the grid */
2436 /* move the element */
2439 /* and add to the undo list so we can undo this operation */
2442 /* keep track of how tall this row is */
2445 {
2447 }
2448 }
2450 }
2451 END_LOOP;
2453 /* done with our action so increment the undo # */
2460 }
2462 #undef GAP
2464 /* --------------------------------------------------------------------------- */
2479 /* %start-doc actions Display
2481 @table @code
2483 @item NameOnPCB
2484 @item Description
2485 @item Value
2486 Specify whether all elements show their name, description, or value.
2488 @item Redraw
2489 Redraw the whole board.
2491 @item Toggle45Degree
2492 When clear, lines can be drawn at any angle. When set, lines are
2493 restricted to multiples of 45 degrees and requested lines may be
2494 broken up according to the clip setting.
2496 @item CycleClip
2497 Changes the way lines are restricted to 45 degree increments. The
2498 various settings are: straight only, orthogonal then angled, and angled
2499 then orthogonal. If AllDirections is set, this action disables it.
2501 @item CycleCrosshair
2502 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2503 8-ray and 12-ray cross.
2505 @item ToggleRubberBandMode
2506 If set, moving an object moves all the lines attached to it too.
2508 @item ToggleStartDirection
2509 If set, each time you set a point in a line, the Clip toggles between
2510 orth-angle and angle-ortho.
2512 @item ToggleUniqueNames
2513 If set, you will not be permitted to change the name of an element to
2514 match that of another element.
2516 @item ToggleSnapPin
2517 If set, pin centers and pad end points are treated as additional grid
2518 points that the cursor can snap to.
2520 @item ToggleLocalRef
2521 If set, the mark is automatically set to the beginning of any move, so
2522 you can see the relative distance you've moved.
2524 @item ToggleThindraw
2525 If set, objects on the screen are drawn as outlines (lines are drawn
2526 as center-lines). This lets you see line endpoints hidden under pins,
2527 for example.
2529 @item ToggleThindrawPoly
2530 If set, polygons on the screen are drawn as outlines.
2532 @item ToggleShowDRC
2533 If set, pending objects (i.e. lines you're in the process of drawing)
2534 will be drawn with an outline showing how far away from other copper
2535 you need to be.
2537 @item ToggleLiveRoute
2538 If set, the progress of the autorouter will be visible on the screen.
2540 @item ToggleAutoDRC
2541 If set, you will not be permitted to make connections which violate
2542 the current DRC and netlist settings.
2544 @item ToggleCheckPlanes
2545 If set, lines and arcs aren't drawn, which usually leaves just the
2546 polygons. If you also disable all but the layer you're interested in,
2547 this allows you to check for isolated regions.
2549 @item ToggleOrthoMove
2550 If set, the crosshair is only allowed to move orthogonally from its
2551 previous position. I.e. you can move an element or line up, down,
2552 left, or right, but not up+left or down+right.
2554 @item ToggleName
2555 Selects whether the pinouts show the pin names or the pin numbers.
2557 @item ToggleLockNames
2558 If set, text will ignore left mouse clicks and actions that work on
2559 objects under the mouse. You can still select text with a lasso (left
2560 mouse drag) and perform actions on the selection.
2562 @item ToggleOnlyNames
2563 If set, only text will be sensitive for mouse clicks and actions that
2564 work on objects under the mouse. You can still select other objects
2565 with a lasso (left mouse drag) and perform actions on the selection.
2567 @item ToggleMask
2568 Turns the solder mask on or off.
2570 @item ToggleClearLine
2571 When set, the clear-line flag causes new lines and arcs to have their
2572 ``clear polygons'' flag set, so they won't be electrically connected
2573 to any polygons they overlap.
2575 @item ToggleFullPoly
2576 When set, the full-poly flag causes new polygons to have their
2577 ``full polygon'' flag set, so all parts of them will be displayed
2578 instead of only the biggest one.
2580 @item ToggleGrid
2581 Resets the origin of the current grid to be wherever the mouse pointer
2582 is (not where the crosshair currently is). If you provide two numbers
2583 after this, the origin is set to that coordinate.
2585 @item Grid
2586 Toggles whether the grid is displayed or not.
2588 @item Pinout
2589 Causes the pinout of the element indicated by the cursor to be
2590 displayed, usually in a separate window.
2592 @item PinOrPadName
2593 Toggles whether the names of pins, pads, or (yes) vias will be
2594 displayed. If the cursor is over an element, all of its pins and pads
2595 are affected.
2597 @end table
2599 %end-doc */
2601 static enum crosshair_shape
2603 {
2605 {
2618 }
2620 }
2622 static int
2624 {
2633 {
2635 {
2637 /* redraw layout */
2643 /* change the displayed name of elements */
2648 {
2650 }
2651 END_LOOP;
2654 {
2663 }
2665 {
2667 }
2668 END_LOOP;
2672 /* toggle line-adjust flag */
2681 {
2684 }
2685 else
2762 {
2764 {
2767 }
2771 FOUNDFLAG);
2772 }
2803 /* shift grid alignment */
2805 {
2812 }
2815 /* toggle displaying of the grid */
2821 /* display the pinout of an element */
2823 {
2824 ElementTypePtr element;
2832 {
2835 }
2837 }
2839 /* toggle displaying of pin/pad/via names */
2841 {
2848 {
2851 {
2854 else
2858 }
2859 END_LOOP;
2861 {
2864 else
2868 }
2869 END_LOOP;
2878 else
2890 else
2901 else
2909 }
2911 }
2914 }
2915 }
2917 {
2919 {
2922 {
2927 }
2933 }
2934 }
2940 }
2942 /* --------------------------------------------------------------------------- */
2952 /* %start-doc actions Mode
2954 @table @code
2956 @item Arc
2957 @itemx Arrow
2958 @itemx Copy
2959 @itemx InsertPoint
2960 @itemx Line
2961 @itemx Lock
2962 @itemx Move
2963 @itemx None
2964 @itemx PasteBuffer
2965 @itemx Polygon
2966 @itemx Rectangle
2967 @itemx Remove
2968 @itemx Rotate
2969 @itemx Text
2970 @itemx Thermal
2971 @itemx Via
2972 Select the indicated tool.
2974 @item Notify
2975 Called when you press the mouse button, or move the mouse.
2977 @item Release
2978 Called when you release the mouse button.
2980 @item Cancel
2981 Cancels any pending tool activity, allowing you to restart elsewhere.
2982 For example, this allows you to start a new line rather than attach a
2983 line to the previous line.
2985 @item Escape
2986 Similar to Cancel but calling this action a second time will return
2987 to the Arrow tool.
2989 @item Stroke
2990 If your @code{pcb} was built with libstroke, this invokes the stroke
2991 input method. If not, this will restart a drawing mode if you were
2992 drawing, else it will select objects.
2994 @item Save
2995 Remembers the current tool.
2997 @item Restore
2998 Restores the tool to the last saved tool.
3000 @end table
3002 %end-doc */
3004 static int
3006 {
3010 {
3015 {
3041 {
3045 }
3048 {
3050 {
3069 else
3070 {
3073 }
3079 else
3080 {
3083 }
3089 else
3090 {
3093 }
3099 else
3100 {
3103 }
3109 else
3110 {
3113 }
3121 }
3122 }
3137 #ifndef HAVE_LIBSTROKE
3141 #else
3145 else
3148 #endif
3159 #ifdef HAVE_LIBSTROKE
3164 #else
3165 /* Handle middle mouse button restarts of drawing mode. If not in
3166 | a drawing mode, middle mouse button will select objects.
3167 */
3170 {
3172 }
3182 else
3183 {
3188 }
3190 #endif
3208 }
3211 }
3214 }
3216 /* --------------------------------------------------------------------------- */
3222 /* %start-doc actions RemoveSelected
3224 %end-doc */
3226 static int
3228 {
3232 }
3234 /* --------------------------------------------------------------------------- */
3243 /* %start-doc actions Renumber
3245 %end-doc */
3247 static int
3249 {
3261 struct _cnt_list
3262 {
3272 {
3273 /*
3274 * We deal with the case where name already exists in this
3275 * function so the GUI doesn't need to deal with it
3276 */
3285 }
3286 else
3290 {
3293 }
3296 {
3298 }
3301 {
3304 {
3308 }
3309 }
3312 {
3317 }
3325 /*
3326 * Make a first pass through all of the elements and sort them out
3327 * by location on the board. While here we also collect a list of
3328 * locked elements.
3329 *
3330 * We'll actually renumber things in the 2nd pass.
3331 */
3338 {
3341 }
3347 {
3349 {
3350 /*
3351 * add to the list of locked elements which we won't try to
3352 * renumber and whose reference designators are now reserved.
3353 */
3358 lock_cnt++;
3359 }
3361 else
3362 {
3363 /* count of devices which will be renumbered */
3364 cnt++;
3366 /* search for correct position in the list */
3369 i++;
3371 /*
3372 * We have found the position where we have the first element that
3373 * has the same Y value or a lower Y value. Now move forward if
3374 * needed through the X values
3375 */
3379 i++;
3382 {
3384 }
3386 }
3387 }
3388 END_LOOP;
3391 /*
3392 * Now that the elements are sorted by board position, we go through
3393 * and renumber them.
3394 */
3396 /*
3397 * turn off the flag which requires unique names so it doesn't get
3398 * in our way. When we're done with the renumber we will have unique
3399 * names.
3400 */
3406 {
3407 /* If there is no refdes, maybe just spit out a warning */
3409 {
3410 /* figure out the prefix */
3415 j++;
3418 /* check the counter for this prefix */
3423 /* grow the list if needed */
3425 {
3429 {
3432 }
3433 /* zero out the memory that we added */
3435 {
3438 }
3439 }
3441 /*
3442 * start a new counter if we don't have a counter for this
3443 * prefix
3444 */
3446 {
3449 }
3451 /*
3452 * check to see if the new refdes is already used by a
3453 * locked element
3454 */
3455 do
3456 {
3461 /* space for the prefix plus 1 digit plus the '\0' */
3464 /* and 1 more per extra digit needed to hold the number */
3467 {
3468 sz++;
3470 }
3474 /*
3475 * now compare to the list of reserved (by locked
3476 * elements) names
3477 */
3479 {
3483 {
3486 }
3487 }
3489 }
3493 {
3497 /* add this rename to our table of renames so we can update the netlist */
3500 c_cnt++;
3508 tmps);
3511 /* we don't free tmps in this case because it is used */
3512 }
3513 else
3515 }
3516 else
3517 {
3520 }
3522 }
3526 /* restore the unique flag setting */
3531 {
3533 /* update the netlist */
3536 /* iterate over each net */
3538 {
3540 /* iterate over each pin on the net */
3542 {
3544 /* figure out the pin number part from strings like U3-21 */
3550 /* iterate over the list of changed reference designators */
3552 {
3553 /*
3554 * if the pin needs to change, change it and quit
3555 * searching in the list.
3556 */
3558 {
3566 }
3568 }
3570 }
3571 }
3573 {
3576 }
3581 }
3587 }
3590 /* --------------------------------------------------------------------------- */
3597 /* %start-doc actions RipUp
3599 @table @code
3601 @item All
3602 Removes all lines and vias which were created by the autorouter.
3604 @item Selected
3605 Removes all selected lines and vias which were created by the
3606 autorouter.
3608 @item Element
3609 Converts the element under the cursor to parts (vias and lines). Note
3610 that this uses the highest numbered paste buffer.
3612 @end table
3614 %end-doc */
3616 static int
3618 {
3623 {
3625 {
3628 {
3630 {
3633 }
3634 }
3635 ENDALL_LOOP;
3637 {
3639 {
3642 }
3643 }
3644 ENDALL_LOOP;
3646 {
3648 {
3651 }
3652 }
3653 END_LOOP;
3656 {
3659 }
3663 {
3666 {
3669 }
3670 }
3671 ENDALL_LOOP;
3674 {
3677 {
3680 }
3681 }
3682 END_LOOP;
3684 {
3687 }
3690 {
3695 {
3711 }
3712 }
3714 }
3715 }
3717 }
3719 /* --------------------------------------------------------------------------- */
3725 /* %start-doc actions AddRats
3727 @table @code
3729 @item AllRats
3730 Create rat lines for all loaded nets that aren't already connected on
3731 with copper.
3733 @item SelectedRats
3734 Similarly, but only add rat lines for nets connected to selected pins
3735 and pads.
3737 @item Close
3738 Selects the shortest unselected rat on the board.
3740 @end table
3742 %end-doc */
3744 static int
3746 {
3748 RatTypePtr shorty;
3752 {
3756 {
3770 {
3776 {
3779 }
3780 }
3781 END_LOOP;
3783 {
3790 }
3792 }
3793 }
3795 }
3797 /* --------------------------------------------------------------------------- */
3805 /* %start-doc actions Delete
3807 %end-doc */
3809 static int
3811 {
3819 {
3822 }
3825 {
3843 }
3846 }
3848 /* --------------------------------------------------------------------------- */
3855 /* %start-doc actions DeleteRats
3857 %end-doc */
3859 static int
3861 {
3864 {
3868 {
3878 }
3879 }
3881 }
3883 /* --------------------------------------------------------------------------- */
3889 /* %start-doc actions AutoPlaceSelected
3891 Attempts to re-arrange the selected components such that the nets
3892 connecting them are minimized. Note that you cannot undo this.
3894 %end-doc */
3896 static int
3898 {
3902 {
3905 }
3907 }
3909 /* --------------------------------------------------------------------------- */
3915 /* %start-doc actions AutoRoute
3917 @table @code
3919 @item AllRats
3920 Attempt to autoroute all rats.
3922 @item SelectedRats
3923 Attempt to autoroute the selected rats.
3925 @end table
3927 Before autorouting, it's important to set up a few things. First,
3928 make sure any layers you aren't using are disabled, else the
3929 autorouter may use them. Next, make sure the current line and via
3930 styles are set accordingly. Last, make sure "new lines clear
3931 polygons" is set, in case you eventually want to add a copper pour.
3933 Autorouting takes a while. During this time, the program may not be
3934 responsive.
3936 %end-doc */
3938 static int
3940 {
3944 {
3946 {
3956 }
3957 }
3959 }
3961 /* --------------------------------------------------------------------------- */
3969 /* %start-doc actions MarkCrosshair
3971 The ``mark'' is a small X-shaped target on the display which is
3972 treated like a second origin (the normal origin is the upper let
3973 corner of the board). The GUI will display a second set of
3974 coordinates for this mark, which tells you how far you are from it.
3976 If no argument is given, the mark is toggled - disabled if it was
3977 enabled, or enabled at the current cursor position of disabled. If
3978 the @code{Center} argument is given, the mark is moved to the current
3979 cursor location.
3981 %end-doc */
3983 static int
3985 {
3988 {
3990 {
3994 }
3995 else
3996 {
4003 }
4004 }
4006 {
4012 }
4014 }
4016 /* --------------------------------------------------------------------------- */
4027 /* %start-doc actions ChangeSize
4029 For lines and arcs, this changes the width. For pins and vias, this
4030 changes the overall diameter of the copper annulus. For pads, this
4031 changes the width and, indirectly, the length. For texts and names,
4032 this changes the scaling factor. For elements, this changes the width
4033 of the silk layer lines and arcs for this element.
4035 %end-doc */
4037 static int
4039 {
4044 Coord value;
4047 {
4050 {
4052 {
4064 }
4111 }
4112 }
4114 }
4116 /* --------------------------------------------------------------------------- */
4125 /* %start-doc actions ChangeDrillSize
4127 %end-doc */
4129 static int
4131 {
4136 Coord value;
4139 {
4142 {
4144 {
4156 }
4172 }
4173 }
4175 }
4177 /* --------------------------------------------------------------------------- */
4188 /* %start-doc actions ChangeClearSize
4190 If the solder mask is currently showing, this action changes the
4191 solder mask clearance. If the mask is not showing, this action
4192 changes the polygon clearance.
4194 %end-doc */
4196 static int
4198 {
4203 Coord value;
4206 {
4209 {
4211 {
4223 }
4249 }
4250 }
4252 }
4254 /* --------------------------------------------------------------------------- */
4263 /* %start-doc actions MinMaskGap
4265 Checks all specified pins and/or pads, and increases the mask if
4266 needed to ensure a minimum distance between the pin or pad edge and
4267 the mask edge.
4269 %end-doc */
4271 static int
4273 {
4278 Coord value;
4285 else
4286 {
4290 }
4295 {
4297 {
4301 {
4305 }
4306 }
4307 END_LOOP;
4309 {
4313 {
4317 }
4318 }
4319 END_LOOP;
4320 }
4321 END_LOOP;
4323 {
4327 {
4330 }
4331 }
4332 END_LOOP;
4336 }
4338 /* --------------------------------------------------------------------------- */
4347 /* %start-doc actions MinClearGap
4349 Checks all specified objects, and increases the polygon clearance if
4350 needed to ensure a minimum distance between their edges and the
4351 polygon edges.
4353 %end-doc */
4355 static int
4357 {
4362 Coord value;
4369 else
4370 {
4374 }
4379 {
4381 {
4385 {
4389 }
4390 }
4391 END_LOOP;
4393 {
4397 {
4401 }
4402 }
4403 END_LOOP;
4404 }
4405 END_LOOP;
4407 {
4411 {
4414 }
4415 }
4416 END_LOOP;
4418 {
4422 {
4425 }
4426 }
4427 ENDALL_LOOP;
4429 {
4433 {
4436 }
4437 }
4438 ENDALL_LOOP;
4442 }
4444 /* --------------------------------------------------------------------------- */
4452 /* %start-doc actions ChangePinName
4454 This can be especially useful for annotating pin names from a
4455 schematic to the layout without requiring knowledge of the pcb file
4456 format.
4458 @example
4459 ChangePinName(U3, 7, VCC)
4460 @end example
4462 %end-doc */
4464 static int
4466 {
4471 {
4473 }
4480 {
4482 {
4484 {
4486 {
4489 /*
4490 * Note: we can't free() pin->Name first because
4491 * it is used in the undo list
4492 */
4496 }
4497 }
4498 END_LOOP;
4501 {
4503 {
4506 /*
4507 * Note: we can't free() pad->Name first because
4508 * it is used in the undo list
4509 */
4513 }
4514 }
4515 END_LOOP;
4516 }
4517 }
4518 END_LOOP;
4519 /*
4520 * done with our action so increment the undo # if we actually
4521 * changed anything
4522 */
4524 {
4527 else
4528 {
4531 }
4532 }
4535 }
4537 /* --------------------------------------------------------------------------- */
4545 /* %start-doc actions ChangeName
4547 @table @code
4549 @item Object
4550 Changes the name of the element under the cursor.
4552 @item Layout
4553 Changes the name of the layout. This is printed on the fab drawings.
4555 @item Layer
4556 Changes the name of the currently active layer.
4558 @end table
4560 %end-doc */
4562 int
4564 {
4569 {
4571 {
4572 /* change the name of an object */
4574 {
4582 {
4585 {
4588 {
4589 RubberbandTypePtr ptr;
4598 {
4604 }
4607 }
4608 }
4609 }
4611 }
4613 /* change the layout's name */
4615 name =
4617 /* NB: ChangeLayoutName takes ownership of the passed memory */
4622 /* change the name of the active layer */
4626 /* NB: ChangeLayerName takes ownership of the passed memory */
4630 }
4631 }
4633 }
4636 /* --------------------------------------------------------------------------- */
4643 /* %start-doc actions MorphPolygon
4645 If a polygon is divided into unconnected "islands", you can use
4646 this command to convert the otherwise disappeared islands into
4647 separate polygons. Be sure the cursor is over a portion of the
4648 polygon that remains visible. Very small islands that may flake
4649 off are automatically deleted.
4651 %end-doc */
4653 static int
4655 {
4658 {
4660 {
4662 {
4669 {
4673 }
4675 }
4679 {
4682 }
4683 ENDALL_LOOP;
4687 }
4688 }
4690 }
4692 /* --------------------------------------------------------------------------- */
4700 /* %start-doc actions ToggleHideName
4702 If names are hidden you won't see them on the screen and they will not
4703 appear on the silk layer when you print the layout.
4705 %end-doc */
4707 static int
4709 {
4712 {
4714 {
4716 {
4723 {
4730 }
4732 }
4735 {
4738 {
4743 {
4750 }
4751 }
4752 END_LOOP;
4754 {
4757 }
4758 }
4759 }
4760 }
4762 }
4764 /* --------------------------------------------------------------------------- */
4772 /* %start-doc actions ChangeJoin
4774 The join flag determines whether a line or arc, drawn to intersect a
4775 polygon, electrically connects to the polygon or not. When joined,
4776 the line/arc is simply drawn over the polygon, making an electrical
4777 connection. When not joined, a gap is drawn between the line and the
4778 polygon, insulating them from each other.
4780 %end-doc */
4782 static int
4784 {
4787 {
4789 {
4792 {
4803 }
4820 }
4821 }
4823 }
4825 /* --------------------------------------------------------------------------- */
4835 /* %start-doc actions ChangeSquare
4837 Note that @code{Pins} means both pins and pads.
4839 @pinshapes
4841 %end-doc */
4843 static int
4845 {
4848 {
4850 {
4853 {
4864 }
4881 }
4882 }
4884 }
4886 /* --------------------------------------------------------------------------- */
4893 /* %start-doc actions SetSquare
4895 Note that @code{Pins} means pins and pads.
4897 @pinshapes
4899 %end-doc */
4901 static int
4903 {
4906 {
4908 {
4911 {
4922 }
4939 }
4940 }
4942 }
4944 /* --------------------------------------------------------------------------- */
4952 /* %start-doc actions ClearSquare
4954 Note that @code{Pins} means pins and pads.
4956 @pinshapes
4958 %end-doc */
4960 static int
4962 {
4965 {
4967 {
4970 {
4981 }
4998 }
4999 }
5001 }
5003 /* --------------------------------------------------------------------------- */
5012 /* %start-doc actions ChangeOctagon
5014 @pinshapes
5016 %end-doc */
5018 static int
5020 {
5023 {
5025 {
5028 {
5039 }
5061 }
5062 }
5064 }
5066 /* --------------------------------------------------------------------------- */
5073 /* %start-doc actions SetOctagon
5075 @pinshapes
5077 %end-doc */
5079 static int
5081 {
5084 {
5086 {
5089 {
5100 }
5122 }
5123 }
5125 }
5127 /* --------------------------------------------------------------------------- */
5136 /* %start-doc actions ClearOctagon
5138 @pinshapes
5140 %end-doc */
5142 static int
5144 {
5147 {
5149 {
5152 {
5163 }
5185 }
5186 }
5188 }
5190 /* --------------------------------------------------------------------------- */
5197 /* %start-doc actions ChangeHole
5199 The "hole flag" of a via determines whether the via is a
5200 plated-through hole (not set), or an unplated hole (set).
5202 %end-doc */
5204 static int
5206 {
5209 {
5211 {
5214 {
5224 }
5231 }
5232 }
5234 }
5236 /* --------------------------------------------------------------------------- */
5243 /* %start-doc actions ChangePaste
5245 The "no paste flag" of a pad determines whether the solderpaste
5246 stencil will have an opening for the pad (no set) or if there wil be
5247 no solderpaste on the pad (set). This is used for things such as
5248 fiducial pads.
5250 %end-doc */
5252 static int
5254 {
5257 {
5259 {
5262 {
5272 }
5279 }
5280 }
5282 }
5284 /* --------------------------------------------------------------------------- */
5297 /* %start-doc actions Select
5299 @table @code
5301 @item ElementByName
5302 @item ObjectByName
5303 @item PadByName
5304 @item PinByName
5305 @item TextByName
5306 @item ViaByName
5307 @item NetByName
5309 These all rely on having a regular expression parser built into
5310 @code{pcb}. If the name is not specified then the user is prompted
5311 for a pattern, and all objects that match the pattern and are of the
5312 type specified are selected.
5314 @item Object
5315 @item ToggleObject
5316 Selects the object under the cursor.
5318 @item Block
5319 Selects all objects in a rectangle indicated by the cursor.
5321 @item All
5322 Selects all objects on the board.
5324 @item Connection
5325 Selects all connections with the ``found'' flag set.
5327 @item Convert
5328 Converts the selected objects to an element. This uses the highest
5329 numbered paste buffer.
5331 @end table
5333 %end-doc */
5335 static int
5337 {
5340 {
5342 {
5343 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5345 /* select objects by their names */
5368 commonByName:
5369 {
5375 {
5380 }
5382 }
5385 /* select a single object */
5392 /* all objects in block */
5394 {
5395 BoxType box;
5409 {
5412 }
5415 }
5417 /* select all visible objects */
5419 {
5420 BoxType box;
5429 }
5431 /* all found connections */
5434 {
5438 }
5442 {
5457 }
5463 }
5464 }
5466 }
5468 /* FLAG(have_regex,FlagHaveRegex,0) */
5469 int
5471 {
5472 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5474 #else
5476 #endif
5477 }
5479 /* --------------------------------------------------------------------------- */
5491 /* %start-doc actions Unselect
5493 @table @code
5495 @item All
5496 Unselect all objects.
5498 @item Block
5499 Unselect all objects in a rectangle given by the cursor.
5501 @item Connection
5502 Unselect all connections with the ``found'' flag set.
5504 @item ElementByName
5505 @item ObjectByName
5506 @item PadByName
5507 @item PinByName
5508 @item TextByName
5509 @item ViaByName
5511 These all rely on having a regular expression parser built into
5512 @code{pcb}. If the name is not specified then the user is prompted
5513 for a pattern, and all objects that match the pattern and are of the
5514 type specified are unselected.
5517 @end table
5519 %end-doc */
5521 static int
5523 {
5526 {
5528 {
5529 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5531 /* select objects by their names */
5554 commonByName:
5555 {
5561 {
5566 }
5568 }
5571 /* all objects in block */
5573 {
5574 BoxType box;
5588 {
5591 }
5594 }
5596 /* unselect all visible objects */
5598 {
5599 BoxType box;
5608 }
5610 /* all found connections */
5613 {
5617 }
5624 }
5625 }
5627 }
5629 /* --------------------------------------------------------------------------- */
5638 /* %start-doc actions SaveTo
5640 @table @code
5642 @item Layout
5643 Saves the current layout.
5645 @item LayoutAs
5646 Saves the current layout, and remembers the filename used.
5648 @item AllConnections
5649 Save all connections to a file.
5651 @item AllUnusedPins
5652 List all unused pins to a file.
5654 @item ElementConnections
5655 Save connections to the element at the cursor to a file.
5657 @item PasteBuffer
5658 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5660 @end table
5662 %end-doc */
5664 static int
5666 {
5674 {
5678 }
5684 {
5686 {
5692 }
5694 }
5697 {
5701 {
5705 }
5707 }
5710 {
5714 {
5718 }
5720 }
5723 {
5724 ElementTypePtr element;
5731 {
5735 {
5739 }
5740 }
5742 }
5745 {
5747 }
5750 }
5752 /* --------------------------------------------------------------------------- */
5760 /* %start-doc actions SaveSettings
5762 If you pass no arguments, the settings are stored in
5763 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5764 saved in @code{./pcb.settings}.
5766 %end-doc */
5768 static int
5770 {
5774 }
5776 /* --------------------------------------------------------------------------- */
5783 /* %start-doc actions LoadFrom
5785 This action assumes you know what the filename is. The various GUIs
5786 should have a similar @code{Load} action where the filename is
5787 optional, and will provide their own file selection mechanism to let
5788 you choose the file name.
5790 @table @code
5792 @item Layout
5793 Loads an entire PCB layout, replacing the current one.
5795 @item LayoutToBuffer
5796 Loads an entire PCB layout to the paste buffer.
5798 @item ElementToBuffer
5799 Loads the given element file into the paste buffer. Element files
5800 contain only a single @code{Element} definition, such as the
5801 ``newlib'' library uses.
5803 @item Netlist
5804 Loads a new netlist, replacing any current netlist.
5806 @item Revert
5807 Re-loads the current layout from its disk file, reverting any changes
5808 you may have made.
5810 @end table
5812 %end-doc */
5814 static int
5816 {
5827 {
5832 }
5835 {
5840 }
5843 {
5847 }
5850 {
5857 }
5861 {
5863 }
5866 }
5868 /* --------------------------------------------------------------------------- */
5874 /* %start-doc actions New
5876 If a name is not given, one is prompted for.
5878 %end-doc */
5880 static int
5882 {
5886 {
5889 else
5896 /* do emergency saving
5897 * clear the old struct and allocate memory for the new one
5898 */
5907 /* setup the new name and reset some values to default */
5919 }
5921 }
5923 /* ---------------------------------------------------------------------------
5924 * no operation, just for testing purposes
5925 * syntax: Bell(volume)
5926 */
5927 void
5929 {
5931 }
5933 /* --------------------------------------------------------------------------- */
5944 /* %start-doc actions PasteBuffer
5946 There are a number of paste buffers; the actual limit is a
5947 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5948 is currently @code{5}. One of these is the ``current'' paste buffer,
5949 often referred to as ``the'' paste buffer.
5951 @table @code
5953 @item AddSelected
5954 Copies the selected objects to the current paste buffer.
5956 @item Clear
5957 Remove all objects from the current paste buffer.
5959 @item Convert
5960 Convert the current paste buffer to an element. Vias are converted to
5961 pins, lines are converted to pads.
5963 @item Restore
5964 Convert any elements in the paste buffer back to vias and lines.
5966 @item Mirror
5967 Flip all objects in the paste buffer vertically (up/down flip). To mirror
5968 horizontally, combine this with rotations.
5970 @item Rotate
5971 Rotates the current buffer. The number to pass is 1..3, where 1 means
5972 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
5973 degrees clockwise (270 CCW).
5975 @item Save
5976 Saves any elements in the current buffer to the indicated file.
5978 @item ToLayout
5979 Pastes any elements in the current buffer to the indicated X, Y
5980 coordinates in the layout. The @code{X} and @code{Y} are treated like
5981 @code{delta} is for many other objects. For each, if it's prefixed by
5982 @code{+} or @code{-}, then that amount is relative to the last
5983 location. Otherwise, it's absolute. Units can be
5984 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
5985 units, currently 1/100 mil.
5988 @item 1..MAX_BUFFER
5989 Selects the given buffer to be the current paste buffer.
5991 @end table
5993 %end-doc */
5995 static int
5997 {
6006 {
6008 {
6009 /* clear contents of paste buffer */
6014 /* copies objects to paste buffer */
6019 /* converts buffer contents into an element */
6024 /* break up element for editing */
6029 /* Mirror buffer */
6036 {
6039 }
6044 {
6047 }
6050 {
6058 {
6061 }
6063 {
6065 }
6067 }
6069 else
6072 {
6076 {
6081 }
6082 else
6087 }
6091 {
6097 {
6099 }
6101 {
6108 }
6109 else
6110 {
6113 }
6119 }
6122 /* set number */
6124 {
6127 /* correct number */
6130 }
6131 }
6132 }
6136 }
6138 /* --------------------------------------------------------------------------- */
6145 /* %start-doc actions Undo
6147 The unlimited undo feature of @code{Pcb} allows you to recover from
6148 most operations that materially affect you work. Calling
6149 @code{Undo()} without any parameter recovers from the last (non-undo)
6150 operation. @code{ClearList} is used to release the allocated
6151 memory. @code{ClearList} is called whenever a new layout is started or
6152 loaded. See also @code{Redo} and @code{Atomic}.
6154 Note that undo groups operations by serial number; changes with the
6155 same serial number will be undone (or redone) as a group. See
6156 @code{Atomic}.
6158 %end-doc */
6160 static int
6162 {
6165 {
6166 /* don't allow undo in the middle of an operation */
6173 /* undo the last operation */
6179 {
6183 }
6184 /* move anchor point if undoing during line creation */
6186 {
6188 {
6195 }
6197 {
6200 LineTypePtr ptr2;
6201 /* this search is guaranteed to succeed */
6208 /* save both ends of line */
6213 /* check that the undo was of the right type */
6215 {
6216 /* wrong undo type, restore anchor points */
6223 }
6224 /* move to new anchor */
6229 /* check if an intermediate point was removed */
6231 {
6232 /* this search should find the restored line */
6240 {
6241 /* undo loses FOUNDFLAG */
6244 }
6249 }
6253 {
6256 }
6257 else
6258 {
6259 /* this search is guaranteed to succeed too */
6267 }
6270 }
6271 }
6273 {
6275 {
6279 }
6281 {
6283 BoxTypePtr bx;
6284 /* guaranteed to succeed */
6296 }
6297 }
6298 /* undo the last destructive operation */
6301 }
6303 {
6305 {
6306 /* clear 'undo objects' list */
6310 }
6311 }
6314 }
6316 /* --------------------------------------------------------------------------- */
6322 /* %start-doc actions Redo
6324 This routine allows you to recover from the last undo command. You
6325 might want to do this if you thought that undo was going to revert
6326 something other than what it actually did (in case you are confused
6327 about which operations are un-doable), or if you have been backing up
6328 through a long undo list and over-shoot your stopping point. Any
6329 change that is made since the undo in question will trim the redo
6330 list. For example if you add ten lines, then undo three of them you
6331 could use redo to put them back, but if you move a line on the board
6332 before performing the redo, you will lose the ability to "redo" the
6333 three "undone" lines.
6335 %end-doc */
6337 static int
6339 {
6347 {
6351 {
6357 addedLines++;
6358 }
6359 }
6362 }
6364 /* --------------------------------------------------------------------------- */
6370 /* %start-doc actions Polygon
6372 Polygons need a special action routine to make life easier.
6374 @table @code
6376 @item Close
6377 Creates the final segment of the polygon. This may fail if clipping
6378 to 45 degree lines is switched on, in which case a warning is issued.
6380 @item PreviousPoint
6381 Resets the newly entered corner to the previous one. The Undo action
6382 will call Polygon(PreviousPoint) when appropriate to do so.
6384 @end table
6386 %end-doc */
6388 static int
6390 {
6393 {
6396 {
6397 /* close open polygon if possible */
6402 /* go back to the previous point */
6406 }
6408 }
6410 }
6412 /* --------------------------------------------------------------------------- */
6419 /* %start-doc actions RouteStyle
6421 %end-doc */
6423 static int
6425 {
6431 {
6434 {
6441 }
6442 }
6444 }
6447 /* --------------------------------------------------------------------------- */
6453 /* %start-doc actions MoveObject
6455 The @code{X} and @code{Y} are treated like @code{delta} is for many
6456 other objects. For each, if it's prefixed by @code{+} or @code{-},
6457 then that amount is relative. Otherwise, it's absolute. Units can be
6458 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6459 units, currently 1/100 mil.
6461 %end-doc */
6463 static int
6465 {
6479 {
6482 }
6495 }
6497 /* --------------------------------------------------------------------------- */
6505 /* %start-doc actions MoveToCurrentLayer
6507 Note that moving an element from a component layer to a solder layer,
6508 or from solder to component, won't automatically flip it. Use the
6509 @code{Flip()} action to do that.
6511 %end-doc */
6513 static int
6515 {
6518 {
6520 {
6522 {
6533 }
6540 }
6541 }
6543 }
6551 /* %start-doc actions SetSame
6553 When invoked over any line, arc, polygon, or via, this changes the
6554 current layer to be the layer that item is on, and changes the current
6555 sizes (thickness, keepaway, drill, etc) according to that item.
6557 %end-doc */
6559 static int
6561 {
6567 /* set layer current and size from line or arc */
6569 {
6609 }
6611 {
6614 }
6616 }
6619 /* --------------------------------------------------------------------------- */
6630 /* %start-doc actions SetFlag
6632 Turns the given flag on, regardless of its previous setting. See
6633 @code{ChangeFlag}.
6635 @example
6636 SetFlag(SelectedPins,thermal)
6637 @end example
6639 %end-doc */
6641 static int
6643 {
6648 }
6650 /* --------------------------------------------------------------------------- */
6661 /* %start-doc actions ClrFlag
6663 Turns the given flag off, regardless of its previous setting. See
6664 @code{ChangeFlag}.
6666 @example
6667 ClrFlag(SelectedLines,join)
6668 @end example
6670 %end-doc */
6672 static int
6674 {
6679 }
6681 /* --------------------------------------------------------------------------- */
6693 /* %start-doc actions ChangeFlag
6695 Toggles the given flag on the indicated object(s). The flag may be
6696 one of the flags listed above (square, octagon, thermal, join). The
6697 value may be the number 0 or 1. If the value is 0, the flag is
6698 cleared. If the value is 1, the flag is set.
6700 %end-doc */
6702 static int
6704 {
6713 }
6716 static void
6718 {
6723 {
6726 }
6728 {
6731 }
6733 {
6734 /* Note: these are backwards, because the flag is "clear" but
6735 the command is "join". */
6738 }
6739 else
6740 {
6743 }
6746 {
6748 {
6760 }
6802 }
6803 }
6805 /* --------------------------------------------------------------------------- */
6811 /* %start-doc actions ExecuteFile
6813 Lines starting with @code{#} are ignored.
6815 %end-doc */
6817 static int
6819 {
6832 {
6835 }
6840 {
6841 n++;
6844 /* eat the trailing newline */
6846 sp++;
6849 /* eat leading spaces and tabs */
6852 sp++;
6854 /*
6855 * if we have anything left and its not a comment line
6856 * then execute it
6857 */
6860 {
6861 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6863 }
6864 }
6868 {
6871 }
6874 }
6876 /* --------------------------------------------------------------------------- */
6878 static int
6880 {
6884 }
6886 /* --------------------------------------------------------------------------- */
6892 {
6899 {
6902 {
6905 }
6906 }
6907 END_LOOP;
6909 }
6913 {
6919 }
6921 static void
6923 {
6930 }
6932 /* ---------------------------------------------------------------- */
6933 static const char elementlist_syntax[] = "ElementList(Start|Done|Need,<refdes>,<footprint>,<value>)";
6937 /* %start-doc actions elementlist
6939 @table @code
6941 @item Start
6942 Indicates the start of an element list; call this before any Need
6943 actions.
6945 @item Need
6946 Searches the board for an element with a matching refdes.
6948 If found, the value and footprint are updated.
6950 If not found, a new element is created with the given footprint and value.
6952 @item Done
6953 Compares the list of elements needed since the most recent
6954 @code{start} with the list of elements actually on the board. Any
6955 elements that weren't listed are selected, so that the user may delete
6956 them.
6958 @end table
6960 %end-doc */
6964 static int
6966 {
6971 }
6973 static int
6975 {
6981 #ifdef DEBUG
6983 #endif
6986 {
6988 {
6990 }
6991 END_LOOP;
6995 }
6998 {
7000 {
7002 {
7004 }
7006 {
7007 /* Unnamed elements should remain untouched */
7009 }
7010 }
7011 END_LOOP;
7017 }
7025 argc --;
7026 argv ++;
7036 #ifdef DEBUG
7040 #endif
7045 {
7048 #ifdef DEBUG
7050 #endif
7051 /* Not on board, need to add it. */
7053 {
7054 number_of_footprints_not_found ++;
7056 }
7067 {
7070 }
7081 /* Place components onto center of board. */
7084 }
7087 {
7088 #ifdef DEBUG
7090 #endif
7095 /* Different footprint, we need to swap them out. */
7097 {
7098 number_of_footprints_not_found ++;
7100 }
7115 {
7120 }
7126 }
7128 /* Now reload footprint */
7141 #ifdef DEBUG
7143 #endif
7146 }
7148 /* ---------------------------------------------------------------- */
7153 /* %start-doc actions elementsetattr
7155 If a value is specified, the named attribute is added (if not already
7156 present) or changed (if it is) to the given value. If the value is
7157 not specified, the given attribute is removed if present.
7159 %end-doc */
7161 static int
7163 {
7169 {
7171 }
7178 {
7180 {
7183 }
7184 }
7185 END_LOOP;
7188 {
7191 }
7196 {
7199 }
7201 {
7203 }
7205 {
7207 }
7210 }
7212 /* ---------------------------------------------------------------- */
7217 /* %start-doc actions execcommand
7219 Runs the given command, which is a system executable.
7221 %end-doc */
7223 static int
7225 {
7229 {
7231 }
7238 }
7240 /* ---------------------------------------------------------------- */
7242 static int
7244 {
7245 #ifdef HAVE__SPAWNVP
7249 else
7251 #else
7255 {
7256 /* error */
7259 }
7261 {
7262 /* Child */
7265 }
7266 else
7267 {
7269 /* Parent */
7271 }
7273 #endif
7274 }
7276 /* ---------------------------------------------------------------- */
7277 /*
7278 * Creates a new temporary file name. Hopefully the operating system
7279 * provides a mkdtemp() function to securily create a temporary
7280 * directory with mode 0700. If so then that directory is created and
7281 * the returned string is made up of the directory plus the name
7282 * variable. For example:
7283 *
7284 * tempfile_name_new ("myfile") might return
7285 * "/var/tmp/pcb.123456/myfile".
7286 *
7287 * If mkdtemp() is not available then 'name' is ignored and the
7288 * insecure tmpnam() function is used.
7289 *
7290 * Files/names created with tempfile_name_new() should be unlinked
7291 * with tempfile_unlink to make sure the temporary directory is also
7292 * removed when mkdtemp() is used.
7293 */
7296 {
7298 #ifdef HAVE_MKDTEMP
7301 #endif
7305 #ifdef HAVE_MKDTEMP
7311 /* FIXME -- what about win32? */
7314 }
7324 }
7334 }
7341 ;
7351 #undef TEMPLATE
7352 #else
7353 /*
7354 * tmpnam() uses a static buffer so strdup() the result right away
7355 * in case someone decides to create multiple temp names.
7356 */
7358 #ifdef __WIN32__
7359 {
7360 /* Guile doesn't like \ separators */
7365 }
7366 #endif
7367 #endif
7370 }
7372 /* ---------------------------------------------------------------- */
7373 /*
7374 * Unlink a temporary file. If we have mkdtemp() then our temp file
7375 * lives in a temporary directory and we need to remove that directory
7376 * too.
7377 */
7378 static int
7380 {
7381 #ifdef DEBUG
7382 /* SDB says: Want to keep old temp files for examiniation when debugging */
7384 #endif
7386 #ifdef HAVE_MKDTEMP
7391 /* it is possible that the file was never created so it is OK if the
7392 unlink fails */
7394 /* now figure out the directory name to remove */
7401 /*
7402 * at this point, e *should* point to the end of the directory part
7403 * but lets make sure.
7404 */
7409 }
7413 __FUNCTION__);
7417 }
7419 /* name was allocated with malloc */
7423 /*
7424 * FIXME - should also return -1 if the temp file exists and was not
7425 * removed.
7426 */
7429 }
7431 #else
7438 }
7441 #endif
7444 }
7446 /* ---------------------------------------------------------------- */
7455 /* %start-doc actions Import
7457 Imports element and netlist data from the schematics (or some other
7458 source). The first parameter, which is optional, is the mode. If not
7459 specified, the @code{import::mode} attribute in the PCB is used.
7460 @code{gnetlist} means gnetlist is used to obtain the information from
7461 the schematics. @code{make} invokes @code{make}, assuming the user
7462 has a @code{Makefile} in the current directory. The @code{Makefile}
7463 will be invoked with the following variables set:
7465 @table @code
7467 @item PCB
7468 The name of the .pcb file
7470 @item SRCLIST
7471 A space-separated list of source files
7473 @item OUT
7474 The name of the file in which to put the command script, which may
7475 contain any @pcb{} actions. By default, this is a temporary file
7476 selected by @pcb{}, but if you specify an @code{import::outfile}
7477 attribute, that file name is used instead (and not automatically
7478 deleted afterwards).
7480 @end table
7482 The target specified to be built is the first of these that apply:
7484 @itemize @bullet
7486 @item
7487 The target specified by an @code{import::target} attribute.
7489 @item
7490 The output file specified by an @code{import::outfile} attribute.
7492 @item
7493 If nothing else is specified, the target is @code{pcb_import}.
7495 @end itemize
7497 If you specify an @code{import::makefile} attribute, then "-f <that
7498 file>" will be added to the command line.
7500 If you specify the mode, you may also specify the source files
7501 (schematics). If you do not specify any, the list of schematics is
7502 obtained by reading the @code{import::src@var{N}} attributes (like
7503 @code{import::src0}, @code{import::src1}, etc).
7505 For compatibility with future extensions to the import file format,
7506 the generated file @emph{must not} start with the two characters
7507 @code{#%}.
7509 If a temporary file is needed the @code{TMPDIR} environment variable
7510 is used to select its location.
7512 Note that the programs @code{gnetlist} and @code{make} may be
7513 overridden by the user via the @code{make-program} and @code{gnetlist}
7514 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7515 line).
7517 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7518 is called to let user choose (see @code{ImportGUI()}).
7520 Note that Import() doesn't delete anything - after an Import, elements
7521 which shouldn't be on the board are selected and may be removed once
7522 it's determined that the deletion is appropriate.
7524 If @code{Import()} is called with @code{setnewpoint}, then the location
7525 of new components can be specified. This is where parts show up when
7526 they're added to the board. The default is the center of the board.
7528 @table @code
7530 @item Import(setnewpoint)
7532 Prompts the user to click on the board somewhere, uses that point. If
7533 called by a hotkey, uses the current location of the crosshair.
7535 @item Import(setnewpoint,mark)
7537 Uses the location of the mark. If no mark is present, the point is
7538 not changed.
7540 @item Import(setnewpoint,center)
7542 Resets the point to the center of the board.
7544 @item Import(setnewpoint,X,Y,units)
7546 Sets the point to the specific coordinates given. Example:
7547 @code{Import(setnewpoint,50,25,mm)}
7549 @end table
7551 Note that the X and Y locations are stored in attributes named
7552 @code{import::newX} and @code{import::newY} so you could change them
7553 manually if you wished.
7555 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7556 placed elements are dispersed relative to the set point. For example,
7557 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7558 10mm away from the point. The default dispersion is 1/10th of the
7559 smallest board dimension. Dispersion is saved in the
7560 @code{import::disperse} attribute.
7562 %end-doc */
7564 static int
7566 {
7571 #ifdef DEBUG
7573 #endif
7578 {
7585 {
7588 }
7590 {
7593 }
7594 else
7599 }
7602 {
7612 {
7614 }
7616 {
7620 }
7622 {
7628 }
7630 {
7633 }
7634 else
7635 {
7638 }
7645 }
7653 {
7656 }
7659 {
7665 nsources ++;
7671 {
7675 nsources ++;
7680 }
7681 }
7684 {
7685 /* Replace .pcb with .sch and hope for the best. */
7707 {
7710 }
7716 }
7719 {
7727 }
7740 #ifdef DEBUG
7744 #endif
7747 {
7750 }
7752 #ifdef DEBUG
7753 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7754 #endif
7762 }
7764 {
7784 else
7785 {
7790 }
7792 }
7800 {
7804 }
7813 {
7816 }
7821 {
7828 }
7839 }
7840 else
7841 {
7844 }
7849 #ifdef DEBUG
7851 #endif
7854 }
7856 /* ------------------------------------------------------------ */
7866 /* %start-doc actions Attributes
7868 This just pops up a dialog letting the user edit the attributes of the
7869 pcb, an element, or a layer.
7871 %end-doc */
7874 static int
7876 {
7885 {
7888 }
7891 {
7893 {
7896 }
7899 {
7902 {
7907 {
7910 }
7912 {
7915 }
7916 }
7922 }
7925 {
7929 {
7931 {
7933 n_found ++;
7934 }
7935 }
7936 END_LOOP;
7938 {
7941 }
7943 {
7950 else
7951 {
7954 }
7955 }
7958 {
7961 }
7962 else
7963 {
7965 }
7969 }
7973 }
7976 }
7978 /* --------------------------------------------------------------------------- */
7980 HID_Action action_action_list[] = {
7983 ,
7986 ,
7989 ,
7992 ,
7995 ,
7998 ,
8001 ,
8004 ,
8007 ,
8010 ,
8013 ,
8016 ,
8019 ,
8022 ,
8025 ,
8028 ,
8031 ,
8034 ,
8037 ,
8040 ,
8043 ,
8046 ,
8049 ,
8052 ,
8055 ,
8058 ,
8061 ,
8064 ,
8067 ,
8070 ,
8073 ,
8076 ,
8079 ,
8082 ,
8085 ,
8088 ,
8091 ,
8094 ,
8097 ,
8100 ,
8103 ,
8106 ,
8109 ,
8112 ,
8115 ,
8118 ,
8121 ,
8124 ,
8127 ,
8130 ,
8133 ,
8136 ,
8139 ,
8142 ,
8145 ,
8148 ,
8151 ,
8154 ,
8156 ,
8159 ,
8162 ,
8165 ,
8168 ,
8169 };