| blob | 834a27329e2c0514bf097f2638a72b0f61ed1429 |
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 }
219 FunctionType;
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 {
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 }
533 /* XXX: FIXME: Call a zoom-extents action */
544 /* XXX: FIXME: Zoom to fit the box StrokeBox.[X1,Y1] - StrokeBox.[X2,Y2] */
550 }
551 }
552 else
554 }
555 #endif
557 /* ---------------------------------------------------------------------------
558 * Clear warning color from pins/pads
559 */
560 static void
562 {
565 {
567 {
570 }
571 }
572 ENDALL_LOOP;
574 {
576 {
579 }
580 }
581 ENDALL_LOOP;
583 }
585 static void
587 {
589 {
593 {
603 }
605 {
614 }
615 else
616 {
617 BoxType box;
626 /* unselect first if shift key not down */
632 }
634 }
635 }
637 static void
639 {
640 BoxType box;
643 {
644 BoxType box;
653 /* unselect first if shift key not down */
655 {
659 {
663 }
664 }
670 }
672 {
679 }
681 {
684 }
686 {
701 }
705 }
707 /* ---------------------------------------------------------------------------
708 * get function ID of passed string
709 */
710 #define HSIZE 257
714 static int
716 {
719 {
722 s ++;
723 }
726 }
728 static int
730 {
737 {
740 {
744 }
746 {
747 /* Change 'char' to 'int' and remove this when we get to 256
748 strings to hash. */
753 }
755 {
760 }
761 }
765 {
766 /* We enforce the "hash table bigger than function table" rule,
767 so we know there will be at least one zero entry to find. */
773 }
774 }
776 /* ---------------------------------------------------------------------------
777 * set new coordinates if in 'RECTANGLE' mode
778 * the cursor shape is also adjusted
779 */
780 static void
782 {
784 {
787 }
789 {
791 {
792 /* update coordinates */
796 }
797 }
798 }
800 /* ---------------------------------------------------------------------------
801 * adjusts the objects which are to be created like attached lines...
802 */
803 void
805 {
808 {
809 /* update at least an attached block (selection) */
813 {
816 }
819 /* rectangle creation mode */
825 /* polygon creation mode */
830 /* line creation mode */
834 else
837 /* point insertion mode */
845 }
846 }
848 /* ---------------------------------------------------------------------------
849 * creates points of a line
850 */
851 static void
853 {
860 {
865 {
868 }
870 {
876 }
878 {
883 }
885 {
890 {
893 }
894 else
895 {
898 }
899 }
900 else
901 {
906 }
911 /* fall through to third state too */
916 }
917 }
919 /* ---------------------------------------------------------------------------
920 * create first or second corner of a marked block
921 */
922 static void
924 {
927 {
939 }
941 }
944 /* ---------------------------------------------------------------------------
945 *
946 * does what's appropriate for the current mode setting. This normally
947 * means creation of an object at the current crosshair location.
948 *
949 * new created objects are added to the create undo list of course
950 */
951 static void
953 {
960 {
962 {
964 hidval hv;
967 /* do something after click time */
970 /* see if we clicked on something already selected
971 * (Note.Moving) or clicked on a MOVE_TYPE
972 * (Note.Hit)
973 */
976 {
980 {
985 }
991 }
993 }
996 {
1000 {
1004 }
1009 {
1016 }
1018 }
1021 {
1023 {
1034 {
1042 {
1046 #ifdef ARC45
1049 else
1050 #endif
1052 }
1053 else
1054 {
1058 #ifdef ARC45
1061 else
1062 #endif
1065 }
1067 Crosshair.
1068 AttachedBox.
1070 Crosshair.
1071 AttachedBox.
1075 sa,
1076 dir,
1077 Settings.
1078 LineThickness,
1080 Keepaway,
1081 MakeFlags
1082 (TEST_FLAG
1084 PCB) ?
1085 CLEARLINEFLAG :
1087 {
1097 addedLines++;
1101 }
1103 }
1104 }
1106 }
1108 {
1111 {
1116 {
1119 }
1120 END_LOOP;
1122 {
1125 }
1126 END_LOOP;
1128 /* always re-draw it since I'm too lazy
1129 * to tell if a selected flag changed
1130 */
1135 }
1137 {
1142 {
1143 /* this is not un-doable since LOCK isn't */
1147 }
1150 }
1152 }
1154 {
1156 =
1160 {
1162 {
1164 tstyle++;
1168 }
1171 else
1173 }
1175 }
1178 /* do update of position */
1183 /* Remove anchor if clicking on start point;
1184 * this means we can't paint 0 length lines
1185 * which could be used for square SMD pads.
1186 * Instead use a very small delta, or change
1187 * the file after saving.
1188 */
1191 {
1194 }
1197 {
1200 {
1201 addedLines++;
1210 }
1212 }
1213 else
1214 /* create line if both ends are determined && length != 0 */
1215 {
1226 {
1227 /* We will only need to paint the second line segment.
1228 Since we only check for vias on the first segment,
1229 swap them so the non-empty segment is the first segment. */
1232 }
1237 else
1253 (TEST_FLAG
1257 {
1260 addedLines++;
1263 /* place a via if vias are visible, the layer is
1264 in a new group since the last line and there
1265 isn't a pin already here */
1272 NO_TYPE
1281 {
1284 }
1285 /* copy the coordinates */
1292 }
1306 (TEST_FLAG
1310 {
1311 addedLines++;
1315 /* move to new start point */
1321 {
1323 }
1324 }
1326 }
1330 /* do update of position */
1333 /* create rectangle if both corners are determined
1334 * and width, height are != 0
1335 */
1339 {
1346 Crosshair.
1348 Crosshair.
1350 Crosshair.
1352 Crosshair.
1354 MakeFlags
1356 NULL)
1357 {
1363 }
1365 /* reset state to 'first corner' */
1367 }
1371 {
1375 {
1377 {
1387 {
1392 }
1393 }
1395 }
1397 }
1400 {
1404 /* do update of position; use the 'LINE_MODE' mechanism */
1407 /* check if this is the last point of a polygon */
1411 {
1415 }
1417 /* create new point if it's the first one or if it's
1418 * different to the last one
1419 */
1423 {
1428 /* copy the coordinates */
1431 }
1433 }
1436 {
1438 {
1439 /* first notify, lookup object */
1448 {
1451 {
1455 }
1456 else
1458 }
1461 /* second notify, insert new point into object */
1463 {
1467 FlagType Flags;
1469 /* do update of position; use the 'LINE_MODE' mechanism */
1472 /* check if this is the last point of a polygon */
1476 {
1477 /* Create POLYAREAs from the original polygon
1478 * and the new hole polygon */
1482 /* Subtract the hole from the original polygon shape */
1485 /* Convert the resulting polygon(s) into a new set of nodes
1486 * and place them on the page. Delete the original polygon.
1487 */
1500 /* reset state of attached line */
1506 }
1508 /* create new point if it's the first one or if it's
1509 * different to the last one
1510 */
1514 {
1519 /* copy the coordinates */
1522 }
1524 }
1525 }
1528 }
1531 {
1536 {
1541 {
1544 {
1552 }
1553 }
1554 }
1558 {
1563 {
1570 {
1582 }
1583 }
1584 }
1586 }
1592 {
1594 {
1597 }
1599 {
1607 {
1614 else
1616 ptr++;
1617 }
1618 }
1622 }
1632 /* both are almost the same */
1636 {
1637 /* first notify, lookup object */
1639 {
1649 {
1653 {
1656 }
1657 else
1659 }
1661 }
1663 /* second notify, move or copy object */
1672 else
1673 {
1681 }
1684 /* reset identifiers */
1688 }
1691 /* insert a point into a polygon/line/... */
1694 {
1695 /* first notify, lookup object */
1704 {
1707 {
1711 }
1712 else
1713 {
1714 /* get starting point of nearest segment */
1716 {
1719 polyIndex =
1727 }
1730 }
1731 }
1734 /* second notify, insert new point into object */
1741 else
1749 /* reset identifiers */
1753 }
1755 }
1756 }
1759 /* --------------------------------------------------------------------------- */
1765 /* %start-doc actions Atomic
1767 This action allows making multiple-action bindings into an atomic
1768 operation that will be undone by a single Undo command. For example,
1769 to optimize rat lines, you'd delete the rats and re-add them. To
1770 group these into a single undo, you'd want the deletions and the
1771 additions to have the same undo serial number. So, you @code{Save},
1772 delete the rats, @code{Restore}, add the rats - using the same serial
1773 number as the deletes, then @code{Block}, which checks to see if the
1774 deletions or additions actually did anything. If not, the serial
1775 number is set to the saved number, as there's nothing to undo. If
1776 something did happen, the serial number is incremented so that these
1777 actions are counted as a single undo step.
1779 @table @code
1781 @item Save
1782 Saves the undo serial number.
1784 @item Restore
1785 Returns it to the last saved number.
1787 @item Close
1788 Sets it to 1 greater than the last save.
1790 @item Block
1791 Does a Restore if there was nothing to undo, else does a Close.
1793 @end table
1795 %end-doc */
1797 static int
1799 {
1804 {
1820 }
1822 }
1824 /* -------------------------------------------------------------------------- */
1830 /* %start-doc actions DRC
1832 Note that the design rule check uses the current board rule settings,
1833 not the current style settings.
1835 %end-doc */
1837 static int
1839 {
1843 {
1851 }
1854 {
1859 else
1861 }
1863 }
1865 /* -------------------------------------------------------------------------- */
1872 /* %start-doc actions DumpLibrary
1875 %end-doc */
1877 static int
1879 {
1886 {
1897 {
1900 {
1903 }
1904 else
1905 {
1912 }
1913 }
1914 }
1917 }
1919 /* -------------------------------------------------------------------------- */
1926 /* %start-doc actions Flip
1928 Note that the location of the element will be symmetric about the
1929 cursor location; i.e. if the part you are pointing at will still be at
1930 the same spot once the element is on the other side. When flipping
1931 multiple elements, this retains their positions relative to each
1932 other, not their absolute positions on the board.
1934 %end-doc */
1936 static int
1938 {
1945 {
1947 {
1951 {
1956 }
1965 }
1968 }
1971 }
1973 /* -------------------------------------------------------------------------- */
1979 /* %start-doc actions Message
1981 This action displays a message to the log window. This action is primarily
1982 provided for use by other programs which may interface with PCB. If
1983 multiple arguments are given, each one is sent to the log window
1984 followed by a newline.
1986 %end-doc */
1988 static int
1990 {
1997 {
2000 }
2003 }
2006 /* -------------------------------------------------------------------------- */
2016 "Style = 3 is a solid connection to the plane."
2020 /* %start-doc actions SetThermal
2022 This changes how/whether pins or vias connect to any rectangle or polygon
2023 on the current layer. The first argument can specify one object, or all
2024 selected pins, or all selected vias, or all selected pins and vias.
2025 The second argument specifies the style of connection.
2026 There are 5 possibilities:
2027 0 - no connection,
2028 1 - 45 degree fingers with sharp edges,
2029 2 - horizontal & vertical fingers with sharp edges,
2030 3 - solid connection,
2031 4 - 45 degree fingers with rounded corners,
2032 5 - horizontal & vertical fingers with rounded corners.
2034 Pins and Vias may have thermals whether or not there is a polygon available
2035 to connect with. However, they will have no effect without the polygon.
2036 %end-doc */
2038 static int
2040 {
2048 {
2054 {
2059 {
2063 }
2078 }
2079 else
2083 }
2086 }
2088 /* ---------------------------------------------------------------------------
2089 * !!! no action routine !!!
2090 *
2091 * event handler to set the cursor according to the X pointer position
2092 * called from inside main.c
2093 */
2094 void
2096 {
2097 #ifdef HAVE_LIBSTROKE
2099 {
2104 }
2107 {
2108 /* update object position and cursor location */
2111 }
2112 }
2114 /* --------------------------------------------------------------------------- */
2122 /* %start-doc actions SetValue
2124 @table @code
2126 @item ViaDrillingHole
2127 Changes the diameter of the drill for new vias.
2129 @item Grid
2130 Sets the grid spacing.
2132 @item Line
2133 @item LineSize
2134 Changes the thickness of new lines.
2136 @item Via
2137 @item ViaSize
2138 Changes the diameter of new vias.
2140 @item Text
2141 @item TextScale
2142 Changes the size of new text.
2144 @end table
2146 %end-doc */
2148 static int
2150 {
2160 {
2163 {
2174 else
2175 {
2179 /* On the way down, short against the minimum
2180 * PCB drawing unit */
2185 else
2187 }
2215 }
2218 }
2221 }
2224 /* --------------------------------------------------------------------------- */
2230 /* %start-doc actions Quit
2232 If you have unsaved changes, you will be prompted to confirm (or
2233 save) before quitting.
2235 %end-doc */
2237 static int
2239 {
2242 {
2245 }
2249 }
2251 /* --------------------------------------------------------------------------- */
2259 /* %start-doc actions Connection
2261 Connections found with this action will be highlighted in the
2262 ``connected-color'' color and will have the ``found'' flag set.
2264 @table @code
2266 @item Find
2267 The net under the cursor is ``found''.
2269 @item ResetLinesAndPolygons
2270 Any ``found'' lines and polygons are marked ``not found''.
2272 @item ResetPinsAndVias
2273 Any ``found'' pins and vias are marked ``not found''.
2275 @item Reset
2276 All ``found'' objects are marked ``not found''.
2278 @end table
2280 %end-doc */
2282 static int
2284 {
2287 {
2289 {
2291 {
2295 }
2299 {
2302 }
2307 {
2310 }
2315 {
2318 }
2320 }
2322 }
2325 }
2327 /* --------------------------------------------------------------------------- */
2334 /* %start-doc actions DisperseElements
2336 Normally this is used when starting a board, by selecting all elements
2337 and then dispersing them. This scatters the elements around the board
2338 so that you can pick individual ones, rather than have all the
2339 elements at the same 0,0 coordinate and thus impossible to choose
2340 from.
2342 %end-doc */
2344 #define GAP MIL_TO_COORD(100)
2346 static int
2348 {
2357 {
2359 }
2360 else
2361 {
2363 {
2374 }
2375 }
2378 {
2380 }
2384 {
2385 /*
2386 * If we want to disperse selected elements, maybe we need smarter
2387 * code here to avoid putting components on top of others which
2388 * are not selected. For now, I'm assuming that this is typically
2389 * going to be used either with a brand new design or a scratch
2390 * design holding some new components
2391 */
2393 {
2395 /* figure out how much to move the element */
2398 /* snap to the grid */
2401 /*
2402 * and add one grid size so we make sure we always space by GAP or
2403 * more
2404 */
2407 /* Figure out if this row has room. If not, start a new row */
2409 {
2412 }
2414 /* figure out how much to move the element */
2418 /* snap to the grid */
2424 /* move the element */
2427 /* and add to the undo list so we can undo this operation */
2430 /* keep track of how tall this row is */
2433 {
2435 }
2436 }
2438 }
2439 END_LOOP;
2441 /* done with our action so increment the undo # */
2448 }
2450 #undef GAP
2452 /* --------------------------------------------------------------------------- */
2467 /* %start-doc actions Display
2469 @table @code
2471 @item NameOnPCB
2472 @item Description
2473 @item Value
2474 Specify whether all elements show their name, description, or value.
2476 @item Redraw
2477 Redraw the whole board.
2479 @item Toggle45Degree
2480 When clear, lines can be drawn at any angle. When set, lines are
2481 restricted to multiples of 45 degrees and requested lines may be
2482 broken up according to the clip setting.
2484 @item CycleClip
2485 Changes the way lines are restricted to 45 degree increments. The
2486 various settings are: straight only, orthogonal then angled, and angled
2487 then orthogonal. If AllDirections is set, this action disables it.
2489 @item CycleCrosshair
2490 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2491 8-ray and 12-ray cross.
2493 @item ToggleRubberBandMode
2494 If set, moving an object moves all the lines attached to it too.
2496 @item ToggleStartDirection
2497 If set, each time you set a point in a line, the Clip toggles between
2498 orth-angle and angle-ortho.
2500 @item ToggleUniqueNames
2501 If set, you will not be permitted to change the name of an element to
2502 match that of another element.
2504 @item ToggleSnapPin
2505 If set, pin centers and pad end points are treated as additional grid
2506 points that the cursor can snap to.
2508 @item ToggleLocalRef
2509 If set, the mark is automatically set to the beginning of any move, so
2510 you can see the relative distance you've moved.
2512 @item ToggleThindraw
2513 If set, objects on the screen are drawn as outlines (lines are drawn
2514 as center-lines). This lets you see line endpoints hidden under pins,
2515 for example.
2517 @item ToggleThindrawPoly
2518 If set, polygons on the screen are drawn as outlines.
2520 @item ToggleShowDRC
2521 If set, pending objects (i.e. lines you're in the process of drawing)
2522 will be drawn with an outline showing how far away from other copper
2523 you need to be.
2525 @item ToggleLiveRoute
2526 If set, the progress of the autorouter will be visible on the screen.
2528 @item ToggleAutoDRC
2529 If set, you will not be permitted to make connections which violate
2530 the current DRC and netlist settings.
2532 @item ToggleCheckPlanes
2533 If set, lines and arcs aren't drawn, which usually leaves just the
2534 polygons. If you also disable all but the layer you're interested in,
2535 this allows you to check for isolated regions.
2537 @item ToggleOrthoMove
2538 If set, the crosshair is only allowed to move orthogonally from its
2539 previous position. I.e. you can move an element or line up, down,
2540 left, or right, but not up+left or down+right.
2542 @item ToggleName
2543 Selects whether the pinouts show the pin names or the pin numbers.
2545 @item ToggleLockNames
2546 If set, text will ignore left mouse clicks and actions that work on
2547 objects under the mouse. You can still select text with a lasso (left
2548 mouse drag) and perform actions on the selection.
2550 @item ToggleOnlyNames
2551 If set, only text will be sensitive for mouse clicks and actions that
2552 work on objects under the mouse. You can still select other objects
2553 with a lasso (left mouse drag) and perform actions on the selection.
2555 @item ToggleMask
2556 Turns the solder mask on or off.
2558 @item ToggleClearLine
2559 When set, the clear-line flag causes new lines and arcs to have their
2560 ``clear polygons'' flag set, so they won't be electrically connected
2561 to any polygons they overlap.
2563 @item ToggleFullPoly
2564 When set, the full-poly flag causes new polygons to have their
2565 ``full polygon'' flag set, so all parts of them will be displayed
2566 instead of only the biggest one.
2568 @item ToggleGrid
2569 Resets the origin of the current grid to be wherever the mouse pointer
2570 is (not where the crosshair currently is). If you provide two numbers
2571 after this, the origin is set to that coordinate.
2573 @item Grid
2574 Toggles whether the grid is displayed or not.
2576 @item Pinout
2577 Causes the pinout of the element indicated by the cursor to be
2578 displayed, usually in a separate window.
2580 @item PinOrPadName
2581 Toggles whether the names of pins, pads, or (yes) vias will be
2582 displayed. If the cursor is over an element, all of its pins and pads
2583 are affected.
2585 @end table
2587 %end-doc */
2589 static enum crosshair_shape
2591 {
2593 {
2606 }
2608 }
2610 static int
2612 {
2621 {
2623 {
2625 /* redraw layout */
2631 /* change the displayed name of elements */
2636 {
2638 }
2639 END_LOOP;
2642 {
2651 }
2653 {
2655 }
2656 END_LOOP;
2660 /* toggle line-adjust flag */
2669 {
2672 }
2673 else
2750 {
2752 {
2755 }
2760 }
2791 /* shift grid alignment */
2793 {
2800 }
2803 /* toggle displaying of the grid */
2809 /* display the pinout of an element */
2811 {
2820 {
2823 }
2825 }
2827 /* toggle displaying of pin/pad/via names */
2829 {
2836 {
2839 {
2842 else
2846 }
2847 END_LOOP;
2849 {
2852 else
2856 }
2857 END_LOOP;
2866 else
2878 else
2889 else
2897 }
2899 }
2902 }
2903 }
2905 {
2907 {
2910 {
2915 }
2921 }
2922 }
2928 }
2930 /* --------------------------------------------------------------------------- */
2940 /* %start-doc actions Mode
2942 @table @code
2944 @item Arc
2945 @itemx Arrow
2946 @itemx Copy
2947 @itemx InsertPoint
2948 @itemx Line
2949 @itemx Lock
2950 @itemx Move
2951 @itemx None
2952 @itemx PasteBuffer
2953 @itemx Polygon
2954 @itemx Rectangle
2955 @itemx Remove
2956 @itemx Rotate
2957 @itemx Text
2958 @itemx Thermal
2959 @itemx Via
2960 Select the indicated tool.
2962 @item Notify
2963 Called when you press the mouse button, or move the mouse.
2965 @item Release
2966 Called when you release the mouse button.
2968 @item Cancel
2969 Cancels any pending tool activity, allowing you to restart elsewhere.
2970 For example, this allows you to start a new line rather than attach a
2971 line to the previous line.
2973 @item Escape
2974 Similar to Cancel but calling this action a second time will return
2975 to the Arrow tool.
2977 @item Stroke
2978 If your @code{pcb} was built with libstroke, this invokes the stroke
2979 input method. If not, this will restart a drawing mode if you were
2980 drawing, else it will select objects.
2982 @item Save
2983 Remembers the current tool.
2985 @item Restore
2986 Restores the tool to the last saved tool.
2988 @end table
2990 %end-doc */
2992 static int
2994 {
2998 {
3003 {
3029 {
3033 }
3036 {
3038 {
3057 else
3058 {
3061 }
3067 else
3068 {
3071 }
3077 else
3078 {
3081 }
3087 else
3088 {
3091 }
3097 else
3098 {
3101 }
3109 }
3110 }
3125 #ifndef HAVE_LIBSTROKE
3129 #else
3133 else
3136 #endif
3147 #ifdef HAVE_LIBSTROKE
3152 #else
3153 /* Handle middle mouse button restarts of drawing mode. If not in
3154 | a drawing mode, middle mouse button will select objects.
3155 */
3158 {
3160 }
3170 else
3171 {
3176 }
3178 #endif
3196 }
3199 }
3202 }
3204 /* --------------------------------------------------------------------------- */
3210 /* %start-doc actions RemoveSelected
3212 %end-doc */
3214 static int
3216 {
3220 }
3222 /* --------------------------------------------------------------------------- */
3231 /* %start-doc actions Renumber
3233 %end-doc */
3235 static int
3237 {
3249 struct _cnt_list
3250 {
3260 {
3261 /*
3262 * We deal with the case where name already exists in this
3263 * function so the GUI doesn't need to deal with it
3264 */
3273 }
3274 else
3278 {
3281 }
3284 {
3286 }
3289 {
3292 {
3296 }
3297 }
3300 {
3305 }
3313 /*
3314 * Make a first pass through all of the elements and sort them out
3315 * by location on the board. While here we also collect a list of
3316 * locked elements.
3317 *
3318 * We'll actually renumber things in the 2nd pass.
3319 */
3326 {
3329 }
3335 {
3337 {
3338 /*
3339 * add to the list of locked elements which we won't try to
3340 * renumber and whose reference designators are now reserved.
3341 */
3346 lock_cnt++;
3347 }
3349 else
3350 {
3351 /* count of devices which will be renumbered */
3352 cnt++;
3354 /* search for correct position in the list */
3357 i++;
3359 /*
3360 * We have found the position where we have the first element that
3361 * has the same Y value or a lower Y value. Now move forward if
3362 * needed through the X values
3363 */
3367 i++;
3370 {
3372 }
3374 }
3375 }
3376 END_LOOP;
3379 /*
3380 * Now that the elements are sorted by board position, we go through
3381 * and renumber them.
3382 */
3384 /*
3385 * turn off the flag which requires unique names so it doesn't get
3386 * in our way. When we're done with the renumber we will have unique
3387 * names.
3388 */
3394 {
3395 /* If there is no refdes, maybe just spit out a warning */
3397 {
3398 /* figure out the prefix */
3403 j++;
3406 /* check the counter for this prefix */
3411 /* grow the list if needed */
3413 {
3417 {
3420 }
3421 /* zero out the memory that we added */
3423 {
3426 }
3427 }
3429 /*
3430 * start a new counter if we don't have a counter for this
3431 * prefix
3432 */
3434 {
3437 }
3439 /*
3440 * check to see if the new refdes is already used by a
3441 * locked element
3442 */
3443 do
3444 {
3449 /* space for the prefix plus 1 digit plus the '\0' */
3452 /* and 1 more per extra digit needed to hold the number */
3455 {
3456 sz++;
3458 }
3462 /*
3463 * now compare to the list of reserved (by locked
3464 * elements) names
3465 */
3467 {
3471 {
3474 }
3475 }
3477 }
3481 {
3485 /* add this rename to our table of renames so we can update the netlist */
3488 c_cnt++;
3496 tmps);
3499 /* we don't free tmps in this case because it is used */
3500 }
3501 else
3503 }
3504 else
3505 {
3508 }
3510 }
3514 /* restore the unique flag setting */
3519 {
3521 /* update the netlist */
3524 /* iterate over each net */
3526 {
3528 /* iterate over each pin on the net */
3530 {
3532 /* figure out the pin number part from strings like U3-21 */
3538 /* iterate over the list of changed reference designators */
3540 {
3541 /*
3542 * if the pin needs to change, change it and quit
3543 * searching in the list.
3544 */
3546 {
3554 }
3556 }
3558 }
3559 }
3561 {
3564 }
3569 }
3575 }
3578 /* --------------------------------------------------------------------------- */
3585 /* %start-doc actions RipUp
3587 @table @code
3589 @item All
3590 Removes all lines and vias which were created by the autorouter.
3592 @item Selected
3593 Removes all selected lines and vias which were created by the
3594 autorouter.
3596 @item Element
3597 Converts the element under the cursor to parts (vias and lines). Note
3598 that this uses the highest numbered paste buffer.
3600 @end table
3602 %end-doc */
3604 static int
3606 {
3611 {
3613 {
3616 {
3618 {
3621 }
3622 }
3623 ENDALL_LOOP;
3625 {
3627 {
3630 }
3631 }
3632 ENDALL_LOOP;
3634 {
3636 {
3639 }
3640 }
3641 END_LOOP;
3644 {
3647 }
3651 {
3654 {
3657 }
3658 }
3659 ENDALL_LOOP;
3662 {
3665 {
3668 }
3669 }
3670 END_LOOP;
3672 {
3675 }
3678 {
3683 {
3699 }
3700 }
3702 }
3703 }
3705 }
3707 /* --------------------------------------------------------------------------- */
3713 /* %start-doc actions AddRats
3715 @table @code
3717 @item AllRats
3718 Create rat lines for all loaded nets that aren't already connected on
3719 with copper.
3721 @item SelectedRats
3722 Similarly, but only add rat lines for nets connected to selected pins
3723 and pads.
3725 @item Close
3726 Selects the shortest unselected rat on the board.
3728 @end table
3730 %end-doc */
3732 static int
3734 {
3740 {
3744 {
3758 {
3764 {
3767 }
3768 }
3769 END_LOOP;
3771 {
3778 }
3780 }
3781 }
3783 }
3785 /* --------------------------------------------------------------------------- */
3793 /* %start-doc actions Delete
3795 %end-doc */
3797 static int
3799 {
3807 {
3810 }
3813 {
3831 }
3834 }
3836 /* --------------------------------------------------------------------------- */
3843 /* %start-doc actions DeleteRats
3845 %end-doc */
3847 static int
3849 {
3852 {
3856 {
3866 }
3867 }
3869 }
3871 /* --------------------------------------------------------------------------- */
3877 /* %start-doc actions AutoPlaceSelected
3879 Attempts to re-arrange the selected components such that the nets
3880 connecting them are minimized. Note that you cannot undo this.
3882 %end-doc */
3884 static int
3886 {
3890 {
3893 }
3895 }
3897 /* --------------------------------------------------------------------------- */
3903 /* %start-doc actions AutoRoute
3905 @table @code
3907 @item AllRats
3908 Attempt to autoroute all rats.
3910 @item SelectedRats
3911 Attempt to autoroute the selected rats.
3913 @end table
3915 Before autorouting, it's important to set up a few things. First,
3916 make sure any layers you aren't using are disabled, else the
3917 autorouter may use them. Next, make sure the current line and via
3918 styles are set accordingly. Last, make sure "new lines clear
3919 polygons" is set, in case you eventually want to add a copper pour.
3921 Autorouting takes a while. During this time, the program may not be
3922 responsive.
3924 %end-doc */
3926 static int
3928 {
3932 {
3934 {
3944 }
3945 }
3947 }
3949 /* --------------------------------------------------------------------------- */
3957 /* %start-doc actions MarkCrosshair
3959 The ``mark'' is a small X-shaped target on the display which is
3960 treated like a second origin (the normal origin is the upper let
3961 corner of the board). The GUI will display a second set of
3962 coordinates for this mark, which tells you how far you are from it.
3964 If no argument is given, the mark is toggled - disabled if it was
3965 enabled, or enabled at the current cursor position of disabled. If
3966 the @code{Center} argument is given, the mark is moved to the current
3967 cursor location.
3969 %end-doc */
3971 static int
3973 {
3976 {
3978 {
3982 }
3983 else
3984 {
3991 }
3992 }
3994 {
4000 }
4002 }
4004 /* --------------------------------------------------------------------------- */
4015 /* %start-doc actions ChangeSize
4017 For lines and arcs, this changes the width. For pins and vias, this
4018 changes the overall diameter of the copper annulus. For pads, this
4019 changes the width and, indirectly, the length. For texts and names,
4020 this changes the scaling factor. For elements, this changes the width
4021 of the silk layer lines and arcs for this element.
4023 %end-doc */
4025 static int
4027 {
4032 Coord value;
4035 {
4041 {
4043 {
4055 }
4102 }
4103 }
4105 }
4107 /* --------------------------------------------------------------------------- */
4116 /* %start-doc actions ChangeDrillSize
4118 %end-doc */
4120 static int
4122 {
4127 Coord value;
4130 {
4133 {
4135 {
4147 }
4163 }
4164 }
4166 }
4168 /* --------------------------------------------------------------------------- */
4179 /* %start-doc actions ChangeClearSize
4181 If the solder mask is currently showing, this action changes the
4182 solder mask clearance. If the mask is not showing, this action
4183 changes the polygon clearance.
4185 %end-doc */
4187 static int
4189 {
4194 Coord value;
4197 {
4203 {
4205 {
4217 }
4243 }
4244 }
4246 }
4248 /* --------------------------------------------------------------------------- */
4257 /* %start-doc actions MinMaskGap
4259 Checks all specified pins and/or pads, and increases the mask if
4260 needed to ensure a minimum distance between the pin or pad edge and
4261 the mask edge.
4263 %end-doc */
4265 static int
4267 {
4272 Coord value;
4279 else
4280 {
4284 }
4289 {
4291 {
4295 {
4299 }
4300 }
4301 END_LOOP;
4303 {
4307 {
4311 }
4312 }
4313 END_LOOP;
4314 }
4315 END_LOOP;
4317 {
4321 {
4324 }
4325 }
4326 END_LOOP;
4330 }
4332 /* --------------------------------------------------------------------------- */
4341 /* %start-doc actions MinClearGap
4343 Checks all specified objects, and increases the polygon clearance if
4344 needed to ensure a minimum distance between their edges and the
4345 polygon edges.
4347 %end-doc */
4349 static int
4351 {
4356 Coord value;
4363 else
4364 {
4368 }
4373 {
4375 {
4379 {
4383 }
4384 }
4385 END_LOOP;
4387 {
4391 {
4395 }
4396 }
4397 END_LOOP;
4398 }
4399 END_LOOP;
4401 {
4405 {
4408 }
4409 }
4410 END_LOOP;
4412 {
4416 {
4419 }
4420 }
4421 ENDALL_LOOP;
4423 {
4427 {
4430 }
4431 }
4432 ENDALL_LOOP;
4436 }
4438 /* --------------------------------------------------------------------------- */
4446 /* %start-doc actions ChangePinName
4448 This can be especially useful for annotating pin names from a
4449 schematic to the layout without requiring knowledge of the pcb file
4450 format.
4452 @example
4453 ChangePinName(U3, 7, VCC)
4454 @end example
4456 %end-doc */
4458 static int
4460 {
4465 {
4467 }
4474 {
4476 {
4478 {
4480 {
4483 /*
4484 * Note: we can't free() pin->Name first because
4485 * it is used in the undo list
4486 */
4490 }
4491 }
4492 END_LOOP;
4495 {
4497 {
4500 /*
4501 * Note: we can't free() pad->Name first because
4502 * it is used in the undo list
4503 */
4507 }
4508 }
4509 END_LOOP;
4510 }
4511 }
4512 END_LOOP;
4513 /*
4514 * done with our action so increment the undo # if we actually
4515 * changed anything
4516 */
4518 {
4521 else
4522 {
4525 }
4526 }
4529 }
4531 /* --------------------------------------------------------------------------- */
4539 /* %start-doc actions ChangeName
4541 @table @code
4543 @item Object
4544 Changes the name of the element under the cursor.
4546 @item Layout
4547 Changes the name of the layout. This is printed on the fab drawings.
4549 @item Layer
4550 Changes the name of the currently active layer.
4552 @end table
4554 %end-doc */
4556 int
4558 {
4563 {
4565 {
4566 /* change the name of an object */
4568 {
4576 {
4579 {
4582 {
4592 {
4598 }
4601 }
4602 }
4603 }
4605 }
4607 /* change the layout's name */
4609 name =
4611 /* NB: ChangeLayoutName takes ownership of the passed memory */
4616 /* change the name of the active layer */
4620 /* NB: ChangeLayerName takes ownership of the passed memory */
4624 }
4625 }
4627 }
4630 /* --------------------------------------------------------------------------- */
4637 /* %start-doc actions MorphPolygon
4639 If a polygon is divided into unconnected "islands", you can use
4640 this command to convert the otherwise disappeared islands into
4641 separate polygons. Be sure the cursor is over a portion of the
4642 polygon that remains visible. Very small islands that may flake
4643 off are automatically deleted.
4645 %end-doc */
4647 static int
4649 {
4652 {
4654 {
4656 {
4663 {
4667 }
4669 }
4673 {
4676 }
4677 ENDALL_LOOP;
4681 }
4682 }
4684 }
4686 /* --------------------------------------------------------------------------- */
4694 /* %start-doc actions ToggleHideName
4696 If names are hidden you won't see them on the screen and they will not
4697 appear on the silk layer when you print the layout.
4699 %end-doc */
4701 static int
4703 {
4706 {
4708 {
4710 {
4717 {
4724 }
4726 }
4729 {
4732 {
4737 {
4744 }
4745 }
4746 END_LOOP;
4748 {
4751 }
4752 }
4753 }
4754 }
4756 }
4758 /* --------------------------------------------------------------------------- */
4766 /* %start-doc actions ChangeJoin
4768 The join flag determines whether a line or arc, drawn to intersect a
4769 polygon, electrically connects to the polygon or not. When joined,
4770 the line/arc is simply drawn over the polygon, making an electrical
4771 connection. When not joined, a gap is drawn between the line and the
4772 polygon, insulating them from each other.
4774 %end-doc */
4776 static int
4778 {
4781 {
4783 {
4786 {
4797 }
4814 }
4815 }
4817 }
4819 /* --------------------------------------------------------------------------- */
4829 /* %start-doc actions ChangeSquare
4831 Note that @code{Pins} means both pins and pads.
4833 @pinshapes
4835 %end-doc */
4837 static int
4839 {
4842 {
4844 {
4847 {
4858 }
4875 }
4876 }
4878 }
4880 /* --------------------------------------------------------------------------- */
4887 /* %start-doc actions SetSquare
4889 Note that @code{Pins} means pins and pads.
4891 @pinshapes
4893 %end-doc */
4895 static int
4897 {
4900 {
4902 {
4905 {
4916 }
4933 }
4934 }
4936 }
4938 /* --------------------------------------------------------------------------- */
4946 /* %start-doc actions ClearSquare
4948 Note that @code{Pins} means pins and pads.
4950 @pinshapes
4952 %end-doc */
4954 static int
4956 {
4959 {
4961 {
4964 {
4975 }
4992 }
4993 }
4995 }
4997 /* --------------------------------------------------------------------------- */
5006 /* %start-doc actions ChangeOctagon
5008 @pinshapes
5010 %end-doc */
5012 static int
5014 {
5017 {
5019 {
5022 {
5033 }
5055 }
5056 }
5058 }
5060 /* --------------------------------------------------------------------------- */
5067 /* %start-doc actions SetOctagon
5069 @pinshapes
5071 %end-doc */
5073 static int
5075 {
5078 {
5080 {
5083 {
5094 }
5116 }
5117 }
5119 }
5121 /* --------------------------------------------------------------------------- */
5130 /* %start-doc actions ClearOctagon
5132 @pinshapes
5134 %end-doc */
5136 static int
5138 {
5141 {
5143 {
5146 {
5157 }
5179 }
5180 }
5182 }
5184 /* --------------------------------------------------------------------------- */
5191 /* %start-doc actions ChangeHole
5193 The "hole flag" of a via determines whether the via is a
5194 plated-through hole (not set), or an unplated hole (set).
5196 %end-doc */
5198 static int
5200 {
5203 {
5205 {
5208 {
5218 }
5225 }
5226 }
5228 }
5230 /* --------------------------------------------------------------------------- */
5237 /* %start-doc actions ChangePaste
5239 The "no paste flag" of a pad determines whether the solderpaste
5240 stencil will have an opening for the pad (no set) or if there wil be
5241 no solderpaste on the pad (set). This is used for things such as
5242 fiducial pads.
5244 %end-doc */
5246 static int
5248 {
5251 {
5253 {
5256 {
5266 }
5273 }
5274 }
5276 }
5278 /* --------------------------------------------------------------------------- */
5291 /* %start-doc actions Select
5293 @table @code
5295 @item ElementByName
5296 @item ObjectByName
5297 @item PadByName
5298 @item PinByName
5299 @item TextByName
5300 @item ViaByName
5301 @item NetByName
5303 These all rely on having a regular expression parser built into
5304 @code{pcb}. If the name is not specified then the user is prompted
5305 for a pattern, and all objects that match the pattern and are of the
5306 type specified are selected.
5308 @item Object
5309 @item ToggleObject
5310 Selects the object under the cursor.
5312 @item Block
5313 Selects all objects in a rectangle indicated by the cursor.
5315 @item All
5316 Selects all objects on the board.
5318 @item Connection
5319 Selects all connections with the ``found'' flag set.
5321 @item Convert
5322 Converts the selected objects to an element. This uses the highest
5323 numbered paste buffer.
5325 @end table
5327 %end-doc */
5329 static int
5331 {
5334 {
5336 {
5337 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5339 /* select objects by their names */
5362 commonByName:
5363 {
5369 {
5374 }
5376 }
5379 /* select a single object */
5386 /* all objects in block */
5388 {
5389 BoxType box;
5403 {
5406 }
5409 }
5411 /* select all visible objects */
5413 {
5414 BoxType box;
5423 }
5425 /* all found connections */
5428 {
5432 }
5436 {
5451 }
5457 }
5458 }
5460 }
5462 /* FLAG(have_regex,FlagHaveRegex,0) */
5463 int
5465 {
5466 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5468 #else
5470 #endif
5471 }
5473 /* --------------------------------------------------------------------------- */
5485 /* %start-doc actions Unselect
5487 @table @code
5489 @item All
5490 Unselect all objects.
5492 @item Block
5493 Unselect all objects in a rectangle given by the cursor.
5495 @item Connection
5496 Unselect all connections with the ``found'' flag set.
5498 @item ElementByName
5499 @item ObjectByName
5500 @item PadByName
5501 @item PinByName
5502 @item TextByName
5503 @item ViaByName
5505 These all rely on having a regular expression parser built into
5506 @code{pcb}. If the name is not specified then the user is prompted
5507 for a pattern, and all objects that match the pattern and are of the
5508 type specified are unselected.
5511 @end table
5513 %end-doc */
5515 static int
5517 {
5520 {
5522 {
5523 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5525 /* select objects by their names */
5548 commonByName:
5549 {
5555 {
5560 }
5562 }
5565 /* all objects in block */
5567 {
5568 BoxType box;
5582 {
5585 }
5588 }
5590 /* unselect all visible objects */
5592 {
5593 BoxType box;
5602 }
5604 /* all found connections */
5607 {
5611 }
5618 }
5619 }
5621 }
5623 /* --------------------------------------------------------------------------- */
5632 /* %start-doc actions SaveTo
5634 @table @code
5636 @item Layout
5637 Saves the current layout.
5639 @item LayoutAs
5640 Saves the current layout, and remembers the filename used.
5642 @item AllConnections
5643 Save all connections to a file.
5645 @item AllUnusedPins
5646 List all unused pins to a file.
5648 @item ElementConnections
5649 Save connections to the element at the cursor to a file.
5651 @item PasteBuffer
5652 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5654 @end table
5656 %end-doc */
5658 static int
5660 {
5668 {
5672 }
5678 {
5680 {
5686 }
5688 }
5691 {
5695 {
5699 }
5701 }
5704 {
5708 {
5712 }
5714 }
5717 {
5725 {
5729 {
5733 }
5734 }
5736 }
5739 {
5741 }
5744 }
5746 /* --------------------------------------------------------------------------- */
5754 /* %start-doc actions SaveSettings
5756 If you pass no arguments, the settings are stored in
5757 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5758 saved in @code{./pcb.settings}.
5760 %end-doc */
5762 static int
5764 {
5768 }
5770 /* --------------------------------------------------------------------------- */
5777 /* %start-doc actions LoadFrom
5779 This action assumes you know what the filename is. The various GUIs
5780 should have a similar @code{Load} action where the filename is
5781 optional, and will provide their own file selection mechanism to let
5782 you choose the file name.
5784 @table @code
5786 @item Layout
5787 Loads an entire PCB layout, replacing the current one.
5789 @item LayoutToBuffer
5790 Loads an entire PCB layout to the paste buffer.
5792 @item ElementToBuffer
5793 Loads the given element file into the paste buffer. Element files
5794 contain only a single @code{Element} definition, such as the
5795 ``newlib'' library uses.
5797 @item Netlist
5798 Loads a new netlist, replacing any current netlist.
5800 @item Revert
5801 Re-loads the current layout from its disk file, reverting any changes
5802 you may have made.
5804 @end table
5806 %end-doc */
5808 static int
5810 {
5821 {
5826 }
5829 {
5834 }
5837 {
5841 }
5844 {
5851 }
5855 {
5857 }
5860 }
5862 /* --------------------------------------------------------------------------- */
5868 /* %start-doc actions New
5870 If a name is not given, one is prompted for.
5872 %end-doc */
5874 static int
5876 {
5880 {
5883 else
5890 /* do emergency saving
5891 * clear the old struct and allocate memory for the new one
5892 */
5901 /* setup the new name and reset some values to default */
5913 }
5915 }
5917 /* ---------------------------------------------------------------------------
5918 * no operation, just for testing purposes
5919 * syntax: Bell(volume)
5920 */
5921 void
5923 {
5925 }
5927 /* --------------------------------------------------------------------------- */
5938 /* %start-doc actions PasteBuffer
5940 There are a number of paste buffers; the actual limit is a
5941 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5942 is currently @code{5}. One of these is the ``current'' paste buffer,
5943 often referred to as ``the'' paste buffer.
5945 @table @code
5947 @item AddSelected
5948 Copies the selected objects to the current paste buffer.
5950 @item Clear
5951 Remove all objects from the current paste buffer.
5953 @item Convert
5954 Convert the current paste buffer to an element. Vias are converted to
5955 pins, lines are converted to pads.
5957 @item Restore
5958 Convert any elements in the paste buffer back to vias and lines.
5960 @item Mirror
5961 Flip all objects in the paste buffer vertically (up/down flip). To mirror
5962 horizontally, combine this with rotations.
5964 @item Rotate
5965 Rotates the current buffer. The number to pass is 1..3, where 1 means
5966 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
5967 degrees clockwise (270 CCW).
5969 @item Save
5970 Saves any elements in the current buffer to the indicated file.
5972 @item ToLayout
5973 Pastes any elements in the current buffer to the indicated X, Y
5974 coordinates in the layout. The @code{X} and @code{Y} are treated like
5975 @code{delta} is for many other objects. For each, if it's prefixed by
5976 @code{+} or @code{-}, then that amount is relative to the last
5977 location. Otherwise, it's absolute. Units can be
5978 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
5979 units, currently 1/100 mil.
5982 @item 1..MAX_BUFFER
5983 Selects the given buffer to be the current paste buffer.
5985 @end table
5987 %end-doc */
5989 static int
5991 {
6000 {
6002 {
6003 /* clear contents of paste buffer */
6008 /* copies objects to paste buffer */
6013 /* converts buffer contents into an element */
6018 /* break up element for editing */
6023 /* Mirror buffer */
6030 {
6033 }
6038 {
6041 }
6044 {
6052 {
6055 }
6057 {
6059 }
6061 }
6063 else
6066 {
6070 {
6075 }
6076 else
6081 }
6085 {
6091 {
6093 }
6095 {
6102 }
6103 else
6104 {
6107 }
6113 }
6116 /* set number */
6118 {
6121 /* correct number */
6124 }
6125 }
6126 }
6130 }
6132 /* --------------------------------------------------------------------------- */
6139 /* %start-doc actions Undo
6141 The unlimited undo feature of @code{Pcb} allows you to recover from
6142 most operations that materially affect you work. Calling
6143 @code{Undo()} without any parameter recovers from the last (non-undo)
6144 operation. @code{ClearList} is used to release the allocated
6145 memory. @code{ClearList} is called whenever a new layout is started or
6146 loaded. See also @code{Redo} and @code{Atomic}.
6148 Note that undo groups operations by serial number; changes with the
6149 same serial number will be undone (or redone) as a group. See
6150 @code{Atomic}.
6152 %end-doc */
6154 static int
6156 {
6159 {
6160 /* don't allow undo in the middle of an operation */
6167 /* undo the last operation */
6173 {
6177 }
6178 /* move anchor point if undoing during line creation */
6180 {
6182 {
6189 }
6191 {
6195 /* this search is guaranteed to succeed */
6202 /* save both ends of line */
6207 /* check that the undo was of the right type */
6209 {
6210 /* wrong undo type, restore anchor points */
6217 }
6218 /* move to new anchor */
6223 /* check if an intermediate point was removed */
6225 {
6226 /* this search should find the restored line */
6234 {
6235 /* undo loses FOUNDFLAG */
6238 }
6243 }
6247 {
6250 }
6251 else
6252 {
6253 /* this search is guaranteed to succeed too */
6261 }
6264 }
6265 }
6267 {
6269 {
6273 }
6275 {
6278 /* guaranteed to succeed */
6290 }
6291 }
6292 /* undo the last destructive operation */
6295 }
6297 {
6299 {
6300 /* clear 'undo objects' list */
6304 }
6305 }
6308 }
6310 /* --------------------------------------------------------------------------- */
6316 /* %start-doc actions Redo
6318 This routine allows you to recover from the last undo command. You
6319 might want to do this if you thought that undo was going to revert
6320 something other than what it actually did (in case you are confused
6321 about which operations are un-doable), or if you have been backing up
6322 through a long undo list and over-shoot your stopping point. Any
6323 change that is made since the undo in question will trim the redo
6324 list. For example if you add ten lines, then undo three of them you
6325 could use redo to put them back, but if you move a line on the board
6326 before performing the redo, you will lose the ability to "redo" the
6327 three "undone" lines.
6329 %end-doc */
6331 static int
6333 {
6341 {
6345 {
6351 addedLines++;
6352 }
6353 }
6356 }
6358 /* --------------------------------------------------------------------------- */
6364 /* %start-doc actions Polygon
6366 Polygons need a special action routine to make life easier.
6368 @table @code
6370 @item Close
6371 Creates the final segment of the polygon. This may fail if clipping
6372 to 45 degree lines is switched on, in which case a warning is issued.
6374 @item PreviousPoint
6375 Resets the newly entered corner to the previous one. The Undo action
6376 will call Polygon(PreviousPoint) when appropriate to do so.
6378 @end table
6380 %end-doc */
6382 static int
6384 {
6387 {
6390 {
6391 /* close open polygon if possible */
6396 /* go back to the previous point */
6400 }
6402 }
6404 }
6406 /* --------------------------------------------------------------------------- */
6413 /* %start-doc actions RouteStyle
6415 %end-doc */
6417 static int
6419 {
6425 {
6428 {
6435 }
6436 }
6438 }
6441 /* --------------------------------------------------------------------------- */
6447 /* %start-doc actions MoveObject
6449 The @code{X} and @code{Y} are treated like @code{delta} is for many
6450 other objects. For each, if it's prefixed by @code{+} or @code{-},
6451 then that amount is relative. Otherwise, it's absolute. Units can be
6452 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6453 units, currently 1/100 mil.
6455 %end-doc */
6457 static int
6459 {
6473 {
6476 }
6489 }
6491 /* --------------------------------------------------------------------------- */
6499 /* %start-doc actions MoveToCurrentLayer
6501 Note that moving an element from a component layer to a solder layer,
6502 or from solder to component, won't automatically flip it. Use the
6503 @code{Flip()} action to do that.
6505 %end-doc */
6507 static int
6509 {
6512 {
6514 {
6516 {
6527 }
6534 }
6535 }
6537 }
6545 /* %start-doc actions SetSame
6547 When invoked over any line, arc, polygon, or via, this changes the
6548 current layer to be the layer that item is on, and changes the current
6549 sizes (thickness, keepaway, drill, etc) according to that item.
6551 %end-doc */
6553 static int
6555 {
6561 /* set layer current and size from line or arc */
6563 {
6603 }
6605 {
6608 }
6610 }
6613 /* --------------------------------------------------------------------------- */
6624 /* %start-doc actions SetFlag
6626 Turns the given flag on, regardless of its previous setting. See
6627 @code{ChangeFlag}.
6629 @example
6630 SetFlag(SelectedPins,thermal)
6631 @end example
6633 %end-doc */
6635 static int
6637 {
6642 }
6644 /* --------------------------------------------------------------------------- */
6655 /* %start-doc actions ClrFlag
6657 Turns the given flag off, regardless of its previous setting. See
6658 @code{ChangeFlag}.
6660 @example
6661 ClrFlag(SelectedLines,join)
6662 @end example
6664 %end-doc */
6666 static int
6668 {
6673 }
6675 /* --------------------------------------------------------------------------- */
6687 /* %start-doc actions ChangeFlag
6689 Toggles the given flag on the indicated object(s). The flag may be
6690 one of the flags listed above (square, octagon, thermal, join). The
6691 value may be the number 0 or 1. If the value is 0, the flag is
6692 cleared. If the value is 1, the flag is set.
6694 %end-doc */
6696 static int
6698 {
6707 }
6710 static void
6712 {
6717 {
6720 }
6722 {
6725 }
6727 {
6728 /* Note: these are backwards, because the flag is "clear" but
6729 the command is "join". */
6732 }
6733 else
6734 {
6737 }
6740 {
6742 {
6754 }
6796 }
6797 }
6799 /* --------------------------------------------------------------------------- */
6805 /* %start-doc actions ExecuteFile
6807 Lines starting with @code{#} are ignored.
6809 %end-doc */
6811 static int
6813 {
6826 {
6829 }
6834 {
6835 n++;
6838 /* eat the trailing newline */
6840 sp++;
6843 /* eat leading spaces and tabs */
6846 sp++;
6848 /*
6849 * if we have anything left and its not a comment line
6850 * then execute it
6851 */
6854 {
6855 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6857 }
6858 }
6862 {
6865 }
6868 }
6870 /* --------------------------------------------------------------------------- */
6872 static int
6874 {
6878 }
6880 /* --------------------------------------------------------------------------- */
6886 {
6893 {
6896 {
6899 }
6900 }
6901 END_LOOP;
6903 }
6907 {
6913 }
6915 static void
6917 {
6924 }
6926 /* ---------------------------------------------------------------- */
6927 static const char elementlist_syntax[] = "ElementList(Start|Done|Need,<refdes>,<footprint>,<value>)";
6931 /* %start-doc actions elementlist
6933 @table @code
6935 @item Start
6936 Indicates the start of an element list; call this before any Need
6937 actions.
6939 @item Need
6940 Searches the board for an element with a matching refdes.
6942 If found, the value and footprint are updated.
6944 If not found, a new element is created with the given footprint and value.
6946 @item Done
6947 Compares the list of elements needed since the most recent
6948 @code{start} with the list of elements actually on the board. Any
6949 elements that weren't listed are selected, so that the user may delete
6950 them.
6952 @end table
6954 %end-doc */
6958 static int
6960 {
6965 }
6967 static int
6969 {
6975 #ifdef DEBUG
6977 #endif
6980 {
6982 {
6984 }
6985 END_LOOP;
6989 }
6992 {
6994 {
6996 {
6998 }
7000 {
7001 /* Unnamed elements should remain untouched */
7003 }
7004 }
7005 END_LOOP;
7011 }
7019 argc --;
7020 argv ++;
7030 #ifdef DEBUG
7034 #endif
7039 {
7042 #ifdef DEBUG
7044 #endif
7045 /* Not on board, need to add it. */
7047 {
7048 number_of_footprints_not_found ++;
7050 }
7061 {
7064 }
7075 /* Place components onto center of board. */
7078 }
7081 {
7082 #ifdef DEBUG
7084 #endif
7089 /* Different footprint, we need to swap them out. */
7091 {
7092 number_of_footprints_not_found ++;
7094 }
7109 {
7114 }
7120 }
7122 /* Now reload footprint */
7135 #ifdef DEBUG
7137 #endif
7140 }
7142 /* ---------------------------------------------------------------- */
7147 /* %start-doc actions elementsetattr
7149 If a value is specified, the named attribute is added (if not already
7150 present) or changed (if it is) to the given value. If the value is
7151 not specified, the given attribute is removed if present.
7153 %end-doc */
7155 static int
7157 {
7163 {
7165 }
7172 {
7174 {
7177 }
7178 }
7179 END_LOOP;
7182 {
7185 }
7190 {
7193 }
7195 {
7197 }
7199 {
7201 }
7204 }
7206 /* ---------------------------------------------------------------- */
7211 /* %start-doc actions execcommand
7213 Runs the given command, which is a system executable.
7215 %end-doc */
7217 static int
7219 {
7223 {
7225 }
7232 }
7234 /* ---------------------------------------------------------------- */
7236 static int
7238 {
7239 #ifdef HAVE__SPAWNVP
7243 else
7245 #else
7249 {
7250 /* error */
7253 }
7255 {
7256 /* Child */
7259 }
7260 else
7261 {
7263 /* Parent */
7265 }
7267 #endif
7268 }
7270 /* ---------------------------------------------------------------- */
7271 /*
7272 * Creates a new temporary file name. Hopefully the operating system
7273 * provides a mkdtemp() function to securily create a temporary
7274 * directory with mode 0700. If so then that directory is created and
7275 * the returned string is made up of the directory plus the name
7276 * variable. For example:
7277 *
7278 * tempfile_name_new ("myfile") might return
7279 * "/var/tmp/pcb.123456/myfile".
7280 *
7281 * If mkdtemp() is not available then 'name' is ignored and the
7282 * insecure tmpnam() function is used.
7283 *
7284 * Files/names created with tempfile_name_new() should be unlinked
7285 * with tempfile_unlink to make sure the temporary directory is also
7286 * removed when mkdtemp() is used.
7287 */
7290 {
7292 #ifdef HAVE_MKDTEMP
7295 #endif
7299 #ifdef HAVE_MKDTEMP
7305 /* FIXME -- what about win32? */
7308 }
7318 }
7328 }
7335 ;
7345 #undef TEMPLATE
7346 #else
7347 /*
7348 * tmpnam() uses a static buffer so strdup() the result right away
7349 * in case someone decides to create multiple temp names.
7350 */
7352 #ifdef __WIN32__
7353 {
7354 /* Guile doesn't like \ separators */
7359 }
7360 #endif
7361 #endif
7364 }
7366 /* ---------------------------------------------------------------- */
7367 /*
7368 * Unlink a temporary file. If we have mkdtemp() then our temp file
7369 * lives in a temporary directory and we need to remove that directory
7370 * too.
7371 */
7372 static int
7374 {
7375 #ifdef DEBUG
7376 /* SDB says: Want to keep old temp files for examiniation when debugging */
7378 #endif
7380 #ifdef HAVE_MKDTEMP
7385 /* it is possible that the file was never created so it is OK if the
7386 unlink fails */
7388 /* now figure out the directory name to remove */
7395 /*
7396 * at this point, e *should* point to the end of the directory part
7397 * but lets make sure.
7398 */
7403 }
7407 __FUNCTION__);
7411 }
7413 /* name was allocated with malloc */
7417 /*
7418 * FIXME - should also return -1 if the temp file exists and was not
7419 * removed.
7420 */
7423 }
7425 #else
7432 }
7435 #endif
7438 }
7440 /* ---------------------------------------------------------------- */
7449 /* %start-doc actions Import
7451 Imports element and netlist data from the schematics (or some other
7452 source). The first parameter, which is optional, is the mode. If not
7453 specified, the @code{import::mode} attribute in the PCB is used.
7454 @code{gnetlist} means gnetlist is used to obtain the information from
7455 the schematics. @code{make} invokes @code{make}, assuming the user
7456 has a @code{Makefile} in the current directory. The @code{Makefile}
7457 will be invoked with the following variables set:
7459 @table @code
7461 @item PCB
7462 The name of the .pcb file
7464 @item SRCLIST
7465 A space-separated list of source files
7467 @item OUT
7468 The name of the file in which to put the command script, which may
7469 contain any @pcb{} actions. By default, this is a temporary file
7470 selected by @pcb{}, but if you specify an @code{import::outfile}
7471 attribute, that file name is used instead (and not automatically
7472 deleted afterwards).
7474 @end table
7476 The target specified to be built is the first of these that apply:
7478 @itemize @bullet
7480 @item
7481 The target specified by an @code{import::target} attribute.
7483 @item
7484 The output file specified by an @code{import::outfile} attribute.
7486 @item
7487 If nothing else is specified, the target is @code{pcb_import}.
7489 @end itemize
7491 If you specify an @code{import::makefile} attribute, then "-f <that
7492 file>" will be added to the command line.
7494 If you specify the mode, you may also specify the source files
7495 (schematics). If you do not specify any, the list of schematics is
7496 obtained by reading the @code{import::src@var{N}} attributes (like
7497 @code{import::src0}, @code{import::src1}, etc).
7499 For compatibility with future extensions to the import file format,
7500 the generated file @emph{must not} start with the two characters
7501 @code{#%}.
7503 If a temporary file is needed the @code{TMPDIR} environment variable
7504 is used to select its location.
7506 Note that the programs @code{gnetlist} and @code{make} may be
7507 overridden by the user via the @code{make-program} and @code{gnetlist}
7508 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7509 line).
7511 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7512 is called to let user choose (see @code{ImportGUI()}).
7514 Note that Import() doesn't delete anything - after an Import, elements
7515 which shouldn't be on the board are selected and may be removed once
7516 it's determined that the deletion is appropriate.
7518 If @code{Import()} is called with @code{setnewpoint}, then the location
7519 of new components can be specified. This is where parts show up when
7520 they're added to the board. The default is the center of the board.
7522 @table @code
7524 @item Import(setnewpoint)
7526 Prompts the user to click on the board somewhere, uses that point. If
7527 called by a hotkey, uses the current location of the crosshair.
7529 @item Import(setnewpoint,mark)
7531 Uses the location of the mark. If no mark is present, the point is
7532 not changed.
7534 @item Import(setnewpoint,center)
7536 Resets the point to the center of the board.
7538 @item Import(setnewpoint,X,Y,units)
7540 Sets the point to the specific coordinates given. Example:
7541 @code{Import(setnewpoint,50,25,mm)}
7543 @end table
7545 Note that the X and Y locations are stored in attributes named
7546 @code{import::newX} and @code{import::newY} so you could change them
7547 manually if you wished.
7549 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7550 placed elements are dispersed relative to the set point. For example,
7551 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7552 10mm away from the point. The default dispersion is 1/10th of the
7553 smallest board dimension. Dispersion is saved in the
7554 @code{import::disperse} attribute.
7556 %end-doc */
7558 static int
7560 {
7565 #ifdef DEBUG
7567 #endif
7572 {
7579 {
7582 }
7584 {
7587 }
7588 else
7593 }
7596 {
7606 {
7608 }
7610 {
7614 }
7616 {
7622 }
7624 {
7627 }
7628 else
7629 {
7632 }
7639 }
7647 {
7650 }
7653 {
7659 nsources ++;
7665 {
7669 nsources ++;
7674 }
7675 }
7678 {
7679 /* Replace .pcb with .sch and hope for the best. */
7701 {
7704 }
7710 }
7713 {
7721 }
7734 #ifdef DEBUG
7738 #endif
7741 {
7744 }
7746 #ifdef DEBUG
7747 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7748 #endif
7756 }
7758 {
7778 else
7779 {
7784 }
7786 }
7794 {
7798 }
7807 {
7810 }
7815 {
7822 }
7833 }
7834 else
7835 {
7838 }
7843 #ifdef DEBUG
7845 #endif
7848 }
7850 /* ------------------------------------------------------------ */
7860 /* %start-doc actions Attributes
7862 This just pops up a dialog letting the user edit the attributes of the
7863 pcb, an element, or a layer.
7865 %end-doc */
7868 static int
7870 {
7879 {
7882 }
7885 {
7887 {
7890 }
7893 {
7896 {
7901 {
7904 }
7906 {
7909 }
7910 }
7916 }
7919 {
7923 {
7925 {
7927 n_found ++;
7928 }
7929 }
7930 END_LOOP;
7932 {
7935 }
7937 {
7944 else
7945 {
7948 }
7949 }
7952 {
7955 }
7956 else
7957 {
7959 }
7963 }
7967 }
7970 }
7972 /* --------------------------------------------------------------------------- */
7974 HID_Action action_action_list[] = {
7977 ,
7980 ,
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 ,
8150 ,
8153 ,
8156 ,
8159 ,
8162 ,
8163 };