| blob | b8b3fe76d1cabc887bf84fbfc700432ce5e60d6e |
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_Found,
111 F_Connection,
112 F_Convert,
113 F_Copy,
114 F_CycleClip,
115 F_CycleCrosshair,
116 F_DeleteRats,
117 F_Drag,
118 F_DrillReport,
119 F_Element,
120 F_ElementByName,
121 F_ElementConnections,
122 F_ElementToBuffer,
123 F_Escape,
124 F_Find,
125 F_FlipElement,
126 F_FoundPins,
127 F_Grid,
128 F_InsertPoint,
129 F_Layer,
130 F_Layout,
131 F_LayoutAs,
132 F_LayoutToBuffer,
133 F_Line,
134 F_LineSize,
135 F_Lock,
136 F_Mirror,
137 F_Move,
138 F_NameOnPCB,
139 F_Netlist,
140 F_NetByName,
141 F_None,
142 F_Notify,
143 F_Object,
144 F_ObjectByName,
145 F_PasteBuffer,
146 F_PadByName,
147 F_PinByName,
148 F_PinOrPadName,
149 F_Pinout,
150 F_Polygon,
151 F_PolygonHole,
152 F_PreviousPoint,
153 F_RatsNest,
154 F_Rectangle,
155 F_Redraw,
156 F_Release,
157 F_Revert,
158 F_Remove,
159 F_RemoveSelected,
160 F_Report,
161 F_Reset,
162 F_ResetLinesAndPolygons,
163 F_ResetPinsViasAndPads,
164 F_Restore,
165 F_Rotate,
166 F_Save,
167 F_Selected,
168 F_SelectedArcs,
169 F_SelectedElements,
170 F_SelectedLines,
171 F_SelectedNames,
172 F_SelectedObjects,
173 F_SelectedPads,
174 F_SelectedPins,
175 F_SelectedTexts,
176 F_SelectedVias,
177 F_SelectedRats,
178 F_Stroke,
179 F_Text,
180 F_TextByName,
181 F_TextScale,
182 F_Thermal,
183 F_ToLayout,
184 F_ToggleAllDirections,
185 F_ToggleAutoDRC,
186 F_ToggleClearLine,
187 F_ToggleFullPoly,
188 F_ToggleGrid,
189 F_ToggleHideNames,
190 F_ToggleMask,
191 F_ToggleName,
192 F_ToggleObject,
193 F_ToggleShowDRC,
194 F_ToggleLiveRoute,
195 F_ToggleRubberBandMode,
196 F_ToggleStartDirection,
197 F_ToggleSnapPin,
198 F_ToggleThindraw,
199 F_ToggleLockNames,
200 F_ToggleOnlyNames,
201 F_ToggleThindrawPoly,
202 F_ToggleOrthoMove,
203 F_ToggleLocalRef,
204 F_ToggleCheckPlanes,
205 F_ToggleUniqueNames,
206 F_Via,
207 F_ViaByName,
208 F_Value,
209 F_ViaDrillingHole,
210 F_ViaSize,
211 F_Zoom
212 }
213 FunctionID;
216 {
218 FunctionID ID;
219 }
220 FunctionType;
222 /* --------------------------------------------------------------------------- */
224 /* %start-doc actions 00delta
226 Many actions take a @code{delta} parameter as the last parameter,
227 which is an amount to change something. That @code{delta} may include
228 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
229 If no units are specified, the default is PCB's native units
230 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
231 @code{-}, the size is increased or decreased by that amount.
232 Otherwise, the size size is set to the given amount.
234 @example
235 Action(Object,5,mil)
236 Action(Object,+0.5,mm)
237 Action(Object,-1)
238 @end example
240 Actions which take a @code{delta} parameter which do not accept all
241 these options will specify what they do take.
243 %end-doc */
245 /* %start-doc actions 00objects
247 Many actions act on indicated objects on the board. They will have
248 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
249 what group of objects they act on. Unless otherwise specified, these
250 parameters are defined as follows:
252 @table @code
254 @item Object
255 @itemx ToggleObject
256 Affects the object under the mouse pointer. If this action is invoked
257 from a menu or script, the user will be prompted to click on an
258 object, which is then the object affected.
260 @item Selected
261 @itemx SelectedObjects
263 Affects all objects which are currently selected. At least, all
264 selected objects for which the given action makes sense.
266 @item SelectedPins
267 @itemx SelectedVias
268 @itemx Selected@var{Type}
269 @itemx @i{etc}
270 Affects all objects which are both selected and of the @var{Type} specified.
272 @end table
274 %end-doc */
276 /* %start-doc actions 00macros
278 @macro pinshapes
280 Pins, pads, and vias can have various shapes. All may be round. Pins
281 and pads may be square (obviously "square" pads are usually
282 rectangular). Pins and vias may be octagonal. When you change a
283 shape flag of an element, you actually change all of its pins and
284 pads.
286 Note that the square flag takes precedence over the octagon flag,
287 thus, if both the square and octagon flags are set, the object is
288 square. When the square flag is cleared, the pins and pads will be
289 either round or, if the octagon flag is set, octagonal.
291 @end macro
293 %end-doc */
295 /* ---------------------------------------------------------------------------
296 * some local identifiers
297 */
300 static struct
301 {
303 LineType line;
304 }
305 fake;
307 static struct
308 {
310 Cardinal Buffer;
317 }
318 Note;
325 #ifdef HAVE_LIBSTROKE
328 #endif
447 };
449 /* ---------------------------------------------------------------------------
450 * some local routines
451 */
458 #ifdef HAVE_LIBSTROKE
463 #endif
466 #define ARG(n) (argc > (n) ? argv[n] : NULL)
468 #ifdef HAVE_LIBSTROKE
470 /* ---------------------------------------------------------------------------
471 * FinishStroke - try to recognize the stroke sent
472 */
473 void
475 {
483 {
486 {
489 {
491 }
535 /* XXX: FIXME: Call a zoom-extents action */
546 /* XXX: FIXME: Zoom to fit the box StrokeBox.[X1,Y1] - StrokeBox.[X2,Y2] */
552 }
553 }
554 else
556 }
557 #endif
559 /* ---------------------------------------------------------------------------
560 * Clear warning color from pins/pads
561 */
562 static void
564 {
567 {
569 {
572 }
573 }
574 ENDALL_LOOP;
576 {
578 {
581 }
582 }
583 ENDALL_LOOP;
585 }
587 /* ---------------------------------------------------------------------------
588 *
589 * This is called a clicktime after a mouse down, to we can distinguish
590 * between short clicks (typically: select or create something) and long
591 * clicks. Long clicks typically drag something.
592 */
593 static void
595 {
597 {
601 {
611 }
613 {
622 }
623 else
624 {
625 BoxType box;
634 /* unselect first if shift key not down */
640 }
642 }
643 }
645 /* ---------------------------------------------------------------------------
646 *
647 * This is typically called when the mouse has moved or the mouse
648 * button was released.
649 */
650 static void
652 {
653 BoxType box;
656 {
657 BoxType box;
666 /* unselect first if shift key not down */
668 {
672 {
676 }
677 }
683 }
685 {
692 }
694 {
697 }
699 {
714 }
718 }
720 /* ---------------------------------------------------------------------------
721 * get function ID of passed string
722 */
723 #define HSIZE 257
727 static int
729 {
732 {
735 s ++;
736 }
739 }
741 static int
743 {
750 {
753 {
757 }
759 {
760 /* Change 'char' to 'int' and remove this when we get to 256
761 strings to hash. */
766 }
768 {
773 }
774 }
778 {
779 /* We enforce the "hash table bigger than function table" rule,
780 so we know there will be at least one zero entry to find. */
786 }
787 }
789 /* ---------------------------------------------------------------------------
790 * set new coordinates if in 'RECTANGLE' mode
791 * the cursor shape is also adjusted
792 */
793 static void
795 {
797 {
800 }
802 {
804 {
805 /* update coordinates */
809 }
810 }
811 }
813 /* ---------------------------------------------------------------------------
814 * adjusts the objects which are to be created like attached lines...
815 */
816 void
818 {
821 {
822 /* update at least an attached block (selection) */
826 {
829 }
832 /* rectangle creation mode */
838 /* polygon creation mode */
843 /* line creation mode */
847 else
850 /* point insertion mode */
858 }
859 }
861 /* ---------------------------------------------------------------------------
862 * creates points of a line
863 */
864 static void
866 {
873 {
878 {
881 }
883 {
889 }
891 {
896 }
898 {
903 {
906 }
907 else
908 {
911 }
912 }
913 else
914 {
919 }
924 /* fall through to third state too */
929 }
930 }
932 /* ---------------------------------------------------------------------------
933 * create first or second corner of a marked block
934 */
935 static void
937 {
940 {
952 }
954 }
957 /* ---------------------------------------------------------------------------
958 *
959 * This is called after every mode change, like mouse button pressed,
960 * mouse button released, dragging something started or a different tool
961 * selected. It does what's appropriate for the current mode setting.
962 * This can also mean creation of an object at the current crosshair location.
963 *
964 * new created objects are added to the create undo list of course
965 */
966 static void
968 {
975 {
977 {
979 hidval hv;
982 /* do something after click time */
985 /* see if we clicked on something already selected
986 * (Note.Moving) or clicked on a MOVE_TYPE
987 * (Note.Hit)
988 */
991 {
995 {
1000 }
1006 }
1008 }
1011 {
1015 {
1019 }
1024 {
1031 }
1033 }
1036 {
1038 {
1049 {
1057 {
1061 #ifdef ARC45
1064 else
1065 #endif
1067 }
1068 else
1069 {
1073 #ifdef ARC45
1076 else
1077 #endif
1080 }
1082 Crosshair.
1083 AttachedBox.
1085 Crosshair.
1086 AttachedBox.
1090 sa,
1091 dir,
1092 Settings.
1093 LineThickness,
1095 Keepaway,
1096 MakeFlags
1097 (TEST_FLAG
1099 PCB) ?
1100 CLEARLINEFLAG :
1102 {
1112 addedLines++;
1116 }
1118 }
1119 }
1121 }
1123 {
1126 {
1131 {
1134 }
1135 END_LOOP;
1137 {
1140 }
1141 END_LOOP;
1143 /* always re-draw it since I'm too lazy
1144 * to tell if a selected flag changed
1145 */
1150 }
1152 {
1157 {
1158 /* this is not un-doable since LOCK isn't */
1162 }
1165 }
1167 }
1169 {
1171 =
1175 {
1177 {
1179 tstyle++;
1183 }
1186 else
1188 }
1190 }
1193 /* do update of position */
1198 /* Remove anchor if clicking on start point;
1199 * this means we can't paint 0 length lines
1200 * which could be used for square SMD pads.
1201 * Instead use a very small delta, or change
1202 * the file after saving.
1203 */
1206 {
1209 }
1212 {
1215 {
1216 addedLines++;
1225 }
1227 }
1228 else
1229 /* create line if both ends are determined && length != 0 */
1230 {
1247 {
1248 /* We will only need to paint the second line segment.
1249 Since we only check for vias on the first segment,
1250 swap them so the non-empty segment is the first segment. */
1253 }
1259 {
1271 {
1273 addedLines++;
1276 }
1277 /* place a via if vias are visible, the layer is
1278 in a new group since the last line and there
1279 isn't a pin already here */
1286 NO_TYPE
1295 {
1298 }
1299 /* copy the coordinates */
1306 }
1310 {
1319 {
1320 addedLines++;
1324 }
1325 /* move to new start point */
1331 {
1333 }
1334 }
1338 }
1342 /* do update of position */
1345 /* create rectangle if both corners are determined
1346 * and width, height are != 0
1347 */
1351 {
1358 Crosshair.
1360 Crosshair.
1362 Crosshair.
1364 Crosshair.
1366 MakeFlags
1368 NULL)
1369 {
1375 }
1377 /* reset state to 'first corner' */
1379 }
1383 {
1387 {
1389 {
1399 {
1404 }
1405 }
1407 }
1409 }
1412 {
1416 /* do update of position; use the 'LINE_MODE' mechanism */
1419 /* check if this is the last point of a polygon */
1423 {
1427 }
1429 /* create new point if it's the first one or if it's
1430 * different to the last one
1431 */
1435 {
1440 /* copy the coordinates */
1443 }
1445 }
1448 {
1450 {
1451 /* first notify, lookup object */
1460 {
1463 {
1467 }
1468 else
1470 }
1473 /* second notify, insert new point into object */
1475 {
1479 FlagType Flags;
1481 /* do update of position; use the 'LINE_MODE' mechanism */
1484 /* check if this is the last point of a polygon */
1488 {
1489 /* Create POLYAREAs from the original polygon
1490 * and the new hole polygon */
1494 /* Subtract the hole from the original polygon shape */
1497 /* Convert the resulting polygon(s) into a new set of nodes
1498 * and place them on the page. Delete the original polygon.
1499 */
1512 /* reset state of attached line */
1518 }
1520 /* create new point if it's the first one or if it's
1521 * different to the last one
1522 */
1526 {
1531 /* copy the coordinates */
1534 }
1536 }
1537 }
1540 }
1543 {
1548 {
1553 {
1556 {
1564 }
1565 }
1566 }
1570 {
1575 {
1582 {
1594 }
1595 }
1596 }
1598 }
1604 {
1606 {
1609 }
1611 {
1619 {
1626 else
1628 ptr++;
1629 }
1630 }
1634 }
1644 /* both are almost the same */
1648 {
1649 /* first notify, lookup object */
1651 {
1661 {
1665 {
1668 }
1669 else
1671 }
1673 }
1675 /* second notify, move or copy object */
1684 else
1685 {
1693 }
1696 /* reset identifiers */
1700 }
1703 /* insert a point into a polygon/line/... */
1706 {
1707 /* first notify, lookup object */
1716 {
1719 {
1723 }
1724 else
1725 {
1726 /* get starting point of nearest segment */
1728 {
1731 polyIndex =
1739 }
1742 }
1743 }
1746 /* second notify, insert new point into object */
1753 else
1761 /* reset identifiers */
1765 }
1767 }
1768 }
1771 /* --------------------------------------------------------------------------- */
1777 /* %start-doc actions Atomic
1779 This action allows making multiple-action bindings into an atomic
1780 operation that will be undone by a single Undo command. For example,
1781 to optimize rat lines, you'd delete the rats and re-add them. To
1782 group these into a single undo, you'd want the deletions and the
1783 additions to have the same undo serial number. So, you @code{Save},
1784 delete the rats, @code{Restore}, add the rats - using the same serial
1785 number as the deletes, then @code{Block}, which checks to see if the
1786 deletions or additions actually did anything. If not, the serial
1787 number is set to the saved number, as there's nothing to undo. If
1788 something did happen, the serial number is incremented so that these
1789 actions are counted as a single undo step.
1791 @table @code
1793 @item Save
1794 Saves the undo serial number.
1796 @item Restore
1797 Returns it to the last saved number.
1799 @item Close
1800 Sets it to 1 greater than the last save.
1802 @item Block
1803 Does a Restore if there was nothing to undo, else does a Close.
1805 @end table
1807 %end-doc */
1809 static int
1811 {
1816 {
1832 }
1834 }
1836 /* -------------------------------------------------------------------------- */
1842 /* %start-doc actions DRC
1844 Note that the design rule check uses the current board rule settings,
1845 not the current style settings.
1847 %end-doc */
1849 static int
1851 {
1855 {
1863 }
1866 {
1871 else
1873 }
1875 }
1877 /* -------------------------------------------------------------------------- */
1884 /* %start-doc actions DumpLibrary
1887 %end-doc */
1889 static int
1891 {
1898 {
1909 {
1912 {
1915 }
1916 else
1917 {
1924 }
1925 }
1926 }
1929 }
1931 /* -------------------------------------------------------------------------- */
1938 /* %start-doc actions Flip
1940 Note that the location of the element will be symmetric about the
1941 cursor location; i.e. if the part you are pointing at will still be at
1942 the same spot once the element is on the other side. When flipping
1943 multiple elements, this retains their positions relative to each
1944 other, not their absolute positions on the board.
1946 %end-doc */
1948 static int
1950 {
1957 {
1959 {
1963 {
1968 }
1977 }
1980 }
1983 }
1985 /* -------------------------------------------------------------------------- */
1991 /* %start-doc actions Message
1993 This action displays a message to the log window. This action is primarily
1994 provided for use by other programs which may interface with PCB. If
1995 multiple arguments are given, each one is sent to the log window
1996 followed by a newline.
1998 %end-doc */
2000 static int
2002 {
2009 {
2012 }
2015 }
2018 /* -------------------------------------------------------------------------- */
2028 "Style = 3 is a solid connection to the plane."
2032 /* %start-doc actions SetThermal
2034 This changes how/whether pins or vias connect to any rectangle or polygon
2035 on the current layer. The first argument can specify one object, or all
2036 selected pins, or all selected vias, or all selected pins and vias.
2037 The second argument specifies the style of connection.
2038 There are 5 possibilities:
2039 0 - no connection,
2040 1 - 45 degree fingers with sharp edges,
2041 2 - horizontal & vertical fingers with sharp edges,
2042 3 - solid connection,
2043 4 - 45 degree fingers with rounded corners,
2044 5 - horizontal & vertical fingers with rounded corners.
2046 Pins and Vias may have thermals whether or not there is a polygon available
2047 to connect with. However, they will have no effect without the polygon.
2048 %end-doc */
2050 static int
2052 {
2060 {
2066 {
2071 {
2075 }
2090 }
2091 else
2095 }
2098 }
2100 /* ---------------------------------------------------------------------------
2101 * !!! no action routine !!!
2102 *
2103 * event handler to set the cursor according to the X pointer position
2104 * called from inside main.c
2105 */
2106 void
2108 {
2109 #ifdef HAVE_LIBSTROKE
2111 {
2116 }
2119 {
2120 /* update object position and cursor location */
2123 }
2124 }
2126 /* --------------------------------------------------------------------------- */
2135 /* %start-doc actions SetValue
2137 @table @code
2139 @item ViaDrillingHole
2140 Changes the diameter of the drill for new vias.
2142 @item Grid
2143 Sets the grid spacing.
2145 @item Line
2146 @item LineSize
2147 Changes the thickness of new lines.
2149 @item Via
2150 @item ViaSize
2151 Changes the diameter of new vias.
2153 @item Text
2154 @item TextScale
2155 Changes the size of new text.
2157 @end table
2159 %end-doc */
2161 static int
2163 {
2173 {
2176 {
2187 else
2188 {
2192 /* On the way down, short against the minimum
2193 * PCB drawing unit */
2198 else
2200 }
2228 }
2231 }
2234 }
2237 /* --------------------------------------------------------------------------- */
2243 /* %start-doc actions Quit
2245 If you have unsaved changes, you will be prompted to confirm (or
2246 save) before quitting.
2248 %end-doc */
2250 static int
2252 {
2255 {
2258 }
2262 }
2264 /* --------------------------------------------------------------------------- */
2272 /* %start-doc actions Connection
2274 Connections found with this action will be highlighted in the
2275 ``connected-color'' color and will have the ``found'' flag set.
2277 @table @code
2279 @item Find
2280 The net under the cursor is ``found''.
2282 @item ResetLinesAndPolygons
2283 Any ``found'' lines and polygons are marked ``not found''.
2285 @item ResetPinsAndVias
2286 Any ``found'' pins and vias are marked ``not found''.
2288 @item Reset
2289 All ``found'' objects are marked ``not found''.
2291 @end table
2293 %end-doc */
2295 static int
2297 {
2300 {
2302 {
2304 {
2309 }
2313 {
2316 }
2321 {
2324 }
2329 {
2332 }
2334 }
2336 }
2339 }
2341 /* --------------------------------------------------------------------------- */
2348 /* %start-doc actions DisperseElements
2350 Normally this is used when starting a board, by selecting all elements
2351 and then dispersing them. This scatters the elements around the board
2352 so that you can pick individual ones, rather than have all the
2353 elements at the same 0,0 coordinate and thus impossible to choose
2354 from.
2356 %end-doc */
2358 #define GAP MIL_TO_COORD(100)
2360 static int
2362 {
2371 {
2373 }
2374 else
2375 {
2377 {
2388 }
2389 }
2392 {
2394 }
2398 {
2399 /*
2400 * If we want to disperse selected elements, maybe we need smarter
2401 * code here to avoid putting components on top of others which
2402 * are not selected. For now, I'm assuming that this is typically
2403 * going to be used either with a brand new design or a scratch
2404 * design holding some new components
2405 */
2407 {
2409 /* figure out how much to move the element */
2412 /* snap to the grid */
2415 /*
2416 * and add one grid size so we make sure we always space by GAP or
2417 * more
2418 */
2421 /* Figure out if this row has room. If not, start a new row */
2423 {
2426 }
2428 /* figure out how much to move the element */
2432 /* snap to the grid */
2438 /* move the element */
2441 /* and add to the undo list so we can undo this operation */
2444 /* keep track of how tall this row is */
2447 {
2449 }
2450 }
2452 }
2453 END_LOOP;
2455 /* done with our action so increment the undo # */
2462 }
2464 #undef GAP
2466 /* --------------------------------------------------------------------------- */
2481 /* %start-doc actions Display
2483 @table @code
2485 @item NameOnPCB
2486 @item Description
2487 @item Value
2488 Specify whether all elements show their name, description, or value.
2490 @item Redraw
2491 Redraw the whole board.
2493 @item Toggle45Degree
2494 When clear, lines can be drawn at any angle. When set, lines are
2495 restricted to multiples of 45 degrees and requested lines may be
2496 broken up according to the clip setting.
2498 @item CycleClip
2499 Changes the way lines are restricted to 45 degree increments. The
2500 various settings are: straight only, orthogonal then angled, and angled
2501 then orthogonal. If AllDirections is set, this action disables it.
2503 @item CycleCrosshair
2504 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2505 8-ray and 12-ray cross.
2507 @item ToggleRubberBandMode
2508 If set, moving an object moves all the lines attached to it too.
2510 @item ToggleStartDirection
2511 If set, each time you set a point in a line, the Clip toggles between
2512 orth-angle and angle-ortho.
2514 @item ToggleUniqueNames
2515 If set, you will not be permitted to change the name of an element to
2516 match that of another element.
2518 @item ToggleSnapPin
2519 If set, pin centers and pad end points are treated as additional grid
2520 points that the cursor can snap to.
2522 @item ToggleLocalRef
2523 If set, the mark is automatically set to the beginning of any move, so
2524 you can see the relative distance you've moved.
2526 @item ToggleThindraw
2527 If set, objects on the screen are drawn as outlines (lines are drawn
2528 as center-lines). This lets you see line endpoints hidden under pins,
2529 for example.
2531 @item ToggleThindrawPoly
2532 If set, polygons on the screen are drawn as outlines.
2534 @item ToggleShowDRC
2535 If set, pending objects (i.e. lines you're in the process of drawing)
2536 will be drawn with an outline showing how far away from other copper
2537 you need to be.
2539 @item ToggleLiveRoute
2540 If set, the progress of the autorouter will be visible on the screen.
2542 @item ToggleAutoDRC
2543 If set, you will not be permitted to make connections which violate
2544 the current DRC and netlist settings.
2546 @item ToggleCheckPlanes
2547 If set, lines and arcs aren't drawn, which usually leaves just the
2548 polygons. If you also disable all but the layer you're interested in,
2549 this allows you to check for isolated regions.
2551 @item ToggleOrthoMove
2552 If set, the crosshair is only allowed to move orthogonally from its
2553 previous position. I.e. you can move an element or line up, down,
2554 left, or right, but not up+left or down+right.
2556 @item ToggleName
2557 Selects whether the pinouts show the pin names or the pin numbers.
2559 @item ToggleLockNames
2560 If set, text will ignore left mouse clicks and actions that work on
2561 objects under the mouse. You can still select text with a lasso (left
2562 mouse drag) and perform actions on the selection.
2564 @item ToggleOnlyNames
2565 If set, only text will be sensitive for mouse clicks and actions that
2566 work on objects under the mouse. You can still select other objects
2567 with a lasso (left mouse drag) and perform actions on the selection.
2569 @item ToggleMask
2570 Turns the solder mask on or off.
2572 @item ToggleClearLine
2573 When set, the clear-line flag causes new lines and arcs to have their
2574 ``clear polygons'' flag set, so they won't be electrically connected
2575 to any polygons they overlap.
2577 @item ToggleFullPoly
2578 When set, the full-poly flag causes new polygons to have their
2579 ``full polygon'' flag set, so all parts of them will be displayed
2580 instead of only the biggest one.
2582 @item ToggleGrid
2583 Resets the origin of the current grid to be wherever the mouse pointer
2584 is (not where the crosshair currently is). If you provide two numbers
2585 after this, the origin is set to that coordinate.
2587 @item Grid
2588 Toggles whether the grid is displayed or not.
2590 @item Pinout
2591 Causes the pinout of the element indicated by the cursor to be
2592 displayed, usually in a separate window.
2594 @item PinOrPadName
2595 Toggles whether the names of pins, pads, or (yes) vias will be
2596 displayed. If the cursor is over an element, all of its pins and pads
2597 are affected.
2599 @end table
2601 %end-doc */
2603 static enum crosshair_shape
2605 {
2607 {
2620 }
2622 }
2624 static int
2626 {
2635 {
2637 {
2639 /* redraw layout */
2645 /* change the displayed name of elements */
2650 {
2652 }
2653 END_LOOP;
2656 {
2665 }
2667 {
2669 }
2670 END_LOOP;
2674 /* toggle line-adjust flag */
2683 {
2686 }
2687 else
2764 {
2766 {
2769 }
2771 {
2778 }
2779 }
2810 /* shift grid alignment */
2812 {
2819 }
2822 /* toggle displaying of the grid */
2828 /* display the pinout of an element */
2830 {
2839 {
2842 }
2844 }
2846 /* toggle displaying of pin/pad/via names */
2848 {
2855 {
2858 {
2861 else
2865 }
2866 END_LOOP;
2868 {
2871 else
2875 }
2876 END_LOOP;
2885 else
2897 else
2908 else
2916 }
2918 }
2921 }
2922 }
2924 {
2926 {
2929 {
2934 }
2940 }
2941 }
2947 }
2949 /* --------------------------------------------------------------------------- */
2959 /* %start-doc actions Mode
2961 @table @code
2963 @item Arc
2964 @itemx Arrow
2965 @itemx Copy
2966 @itemx InsertPoint
2967 @itemx Line
2968 @itemx Lock
2969 @itemx Move
2970 @itemx None
2971 @itemx PasteBuffer
2972 @itemx Polygon
2973 @itemx Rectangle
2974 @itemx Remove
2975 @itemx Rotate
2976 @itemx Text
2977 @itemx Thermal
2978 @itemx Via
2979 Select the indicated tool.
2981 @item Notify
2982 Called when you press the mouse button, or move the mouse.
2984 @item Release
2985 Called when you release the mouse button.
2987 @item Cancel
2988 Cancels any pending tool activity, allowing you to restart elsewhere.
2989 For example, this allows you to start a new line rather than attach a
2990 line to the previous line.
2992 @item Escape
2993 Similar to Cancel but calling this action a second time will return
2994 to the Arrow tool.
2996 @item Stroke
2997 If your @code{pcb} was built with libstroke, this invokes the stroke
2998 input method. If not, this will restart a drawing mode if you were
2999 drawing, else it will select objects.
3001 @item Save
3002 Remembers the current tool.
3004 @item Restore
3005 Restores the tool to the last saved tool.
3007 @end table
3009 %end-doc */
3011 static int
3013 {
3017 {
3022 {
3048 {
3052 }
3055 {
3057 {
3076 else
3077 {
3080 }
3086 else
3087 {
3090 }
3096 else
3097 {
3100 }
3106 else
3107 {
3110 }
3116 else
3117 {
3120 }
3128 }
3129 }
3144 #ifndef HAVE_LIBSTROKE
3148 #else
3152 else
3155 #endif
3166 #ifdef HAVE_LIBSTROKE
3171 #else
3172 /* Handle middle mouse button restarts of drawing mode. If not in
3173 | a drawing mode, middle mouse button will select objects.
3174 */
3177 {
3179 }
3189 else
3190 {
3195 }
3197 #endif
3215 }
3218 }
3221 }
3223 /* --------------------------------------------------------------------------- */
3229 /* %start-doc actions RemoveSelected
3231 %end-doc */
3233 static int
3235 {
3239 }
3241 /* --------------------------------------------------------------------------- */
3250 /* %start-doc actions Renumber
3252 %end-doc */
3254 static int
3256 {
3268 struct _cnt_list
3269 {
3279 {
3280 /*
3281 * We deal with the case where name already exists in this
3282 * function so the GUI doesn't need to deal with it
3283 */
3292 }
3293 else
3297 {
3300 }
3303 {
3305 }
3308 {
3311 {
3315 }
3316 }
3319 {
3324 }
3332 /*
3333 * Make a first pass through all of the elements and sort them out
3334 * by location on the board. While here we also collect a list of
3335 * locked elements.
3336 *
3337 * We'll actually renumber things in the 2nd pass.
3338 */
3345 {
3348 }
3354 {
3356 {
3357 /*
3358 * add to the list of locked elements which we won't try to
3359 * renumber and whose reference designators are now reserved.
3360 */
3365 lock_cnt++;
3366 }
3368 else
3369 {
3370 /* count of devices which will be renumbered */
3371 cnt++;
3373 /* search for correct position in the list */
3376 i++;
3378 /*
3379 * We have found the position where we have the first element that
3380 * has the same Y value or a lower Y value. Now move forward if
3381 * needed through the X values
3382 */
3386 i++;
3389 {
3391 }
3393 }
3394 }
3395 END_LOOP;
3398 /*
3399 * Now that the elements are sorted by board position, we go through
3400 * and renumber them.
3401 */
3403 /*
3404 * turn off the flag which requires unique names so it doesn't get
3405 * in our way. When we're done with the renumber we will have unique
3406 * names.
3407 */
3413 {
3414 /* If there is no refdes, maybe just spit out a warning */
3416 {
3417 /* figure out the prefix */
3422 j++;
3425 /* check the counter for this prefix */
3430 /* grow the list if needed */
3432 {
3436 {
3439 }
3440 /* zero out the memory that we added */
3442 {
3445 }
3446 }
3448 /*
3449 * start a new counter if we don't have a counter for this
3450 * prefix
3451 */
3453 {
3456 }
3458 /*
3459 * check to see if the new refdes is already used by a
3460 * locked element
3461 */
3462 do
3463 {
3468 /* space for the prefix plus 1 digit plus the '\0' */
3471 /* and 1 more per extra digit needed to hold the number */
3474 {
3475 sz++;
3477 }
3481 /*
3482 * now compare to the list of reserved (by locked
3483 * elements) names
3484 */
3486 {
3490 {
3493 }
3494 }
3496 }
3500 {
3504 /* add this rename to our table of renames so we can update the netlist */
3507 c_cnt++;
3515 tmps);
3518 /* we don't free tmps in this case because it is used */
3519 }
3520 else
3522 }
3523 else
3524 {
3527 }
3529 }
3533 /* restore the unique flag setting */
3538 {
3540 /* update the netlist */
3543 /* iterate over each net */
3545 {
3547 /* iterate over each pin on the net */
3549 {
3551 /* figure out the pin number part from strings like U3-21 */
3557 /* iterate over the list of changed reference designators */
3559 {
3560 /*
3561 * if the pin needs to change, change it and quit
3562 * searching in the list.
3563 */
3565 {
3573 }
3575 }
3577 }
3578 }
3580 {
3583 }
3588 }
3594 }
3597 /* --------------------------------------------------------------------------- */
3604 /* %start-doc actions RipUp
3606 @table @code
3608 @item All
3609 Removes all lines and vias which were created by the autorouter.
3611 @item Selected
3612 Removes all selected lines and vias which were created by the
3613 autorouter.
3615 @item Element
3616 Converts the element under the cursor to parts (vias and lines). Note
3617 that this uses the highest numbered paste buffer.
3619 @end table
3621 %end-doc */
3623 static int
3625 {
3630 {
3632 {
3635 {
3637 {
3640 }
3641 }
3642 ENDALL_LOOP;
3644 {
3646 {
3649 }
3650 }
3651 ENDALL_LOOP;
3653 {
3655 {
3658 }
3659 }
3660 END_LOOP;
3663 {
3666 }
3670 {
3673 {
3676 }
3677 }
3678 ENDALL_LOOP;
3681 {
3684 {
3687 }
3688 }
3689 END_LOOP;
3691 {
3694 }
3697 {
3702 {
3718 }
3719 }
3721 }
3722 }
3724 }
3726 /* --------------------------------------------------------------------------- */
3733 /* %start-doc actions AddRats
3735 @table @code
3737 @item AllRats
3738 Create rat lines for all loaded nets that aren't already connected on
3739 with copper.
3741 @item SelectedRats
3742 Similarly, but only add rat lines for nets connected to selected pins
3743 and pads.
3745 @item Close
3746 Selects the shortest unselected rat on the board.
3748 @end table
3750 %end-doc */
3752 static int
3754 {
3760 {
3764 {
3778 {
3784 {
3787 }
3788 }
3789 END_LOOP;
3791 {
3798 }
3800 }
3801 }
3803 }
3805 /* --------------------------------------------------------------------------- */
3813 /* %start-doc actions Delete
3815 %end-doc */
3817 static int
3819 {
3827 {
3830 }
3833 {
3851 }
3854 }
3856 /* --------------------------------------------------------------------------- */
3863 /* %start-doc actions DeleteRats
3865 %end-doc */
3867 static int
3869 {
3872 {
3876 {
3886 }
3887 }
3889 }
3891 /* --------------------------------------------------------------------------- */
3897 /* %start-doc actions AutoPlaceSelected
3899 Attempts to re-arrange the selected components such that the nets
3900 connecting them are minimized. Note that you cannot undo this.
3902 %end-doc */
3904 static int
3906 {
3910 {
3913 }
3915 }
3917 /* --------------------------------------------------------------------------- */
3923 /* %start-doc actions AutoRoute
3925 @table @code
3927 @item AllRats
3928 Attempt to autoroute all rats.
3930 @item SelectedRats
3931 Attempt to autoroute the selected rats.
3933 @end table
3935 Before autorouting, it's important to set up a few things. First,
3936 make sure any layers you aren't using are disabled, else the
3937 autorouter may use them. Next, make sure the current line and via
3938 styles are set accordingly. Last, make sure "new lines clear
3939 polygons" is set, in case you eventually want to add a copper pour.
3941 Autorouting takes a while. During this time, the program may not be
3942 responsive.
3944 %end-doc */
3946 static int
3948 {
3952 {
3954 {
3964 }
3965 }
3967 }
3969 /* --------------------------------------------------------------------------- */
3977 /* %start-doc actions MarkCrosshair
3979 The ``mark'' is a small X-shaped target on the display which is
3980 treated like a second origin (the normal origin is the upper let
3981 corner of the board). The GUI will display a second set of
3982 coordinates for this mark, which tells you how far you are from it.
3984 If no argument is given, the mark is toggled - disabled if it was
3985 enabled, or enabled at the current cursor position of disabled. If
3986 the @code{Center} argument is given, the mark is moved to the current
3987 cursor location.
3989 %end-doc */
3991 static int
3993 {
3996 {
3998 {
4002 }
4003 else
4004 {
4011 }
4012 }
4014 {
4020 }
4022 }
4024 /* --------------------------------------------------------------------------- */
4035 /* %start-doc actions ChangeSize
4037 For lines and arcs, this changes the width. For pins and vias, this
4038 changes the overall diameter of the copper annulus. For pads, this
4039 changes the width and, indirectly, the length. For texts and names,
4040 this changes the scaling factor. For elements, this changes the width
4041 of the silk layer lines and arcs for this element.
4043 %end-doc */
4045 static int
4047 {
4052 Coord value;
4055 {
4061 {
4063 {
4075 }
4122 }
4123 }
4125 }
4127 /* --------------------------------------------------------------------------- */
4136 /* %start-doc actions ChangeDrillSize
4138 %end-doc */
4140 static int
4142 {
4147 Coord value;
4150 {
4153 {
4155 {
4167 }
4183 }
4184 }
4186 }
4188 /* --------------------------------------------------------------------------- */
4199 /* %start-doc actions ChangeClearSize
4201 If the solder mask is currently showing, this action changes the
4202 solder mask clearance. If the mask is not showing, this action
4203 changes the polygon clearance.
4205 %end-doc */
4207 static int
4209 {
4214 Coord value;
4217 {
4223 {
4225 {
4237 }
4263 }
4264 }
4266 }
4268 /* --------------------------------------------------------------------------- */
4277 /* %start-doc actions MinMaskGap
4279 Checks all specified pins and/or pads, and increases the mask if
4280 needed to ensure a minimum distance between the pin or pad edge and
4281 the mask edge.
4283 %end-doc */
4285 static int
4287 {
4292 Coord value;
4299 else
4300 {
4304 }
4309 {
4311 {
4315 {
4319 }
4320 }
4321 END_LOOP;
4323 {
4327 {
4331 }
4332 }
4333 END_LOOP;
4334 }
4335 END_LOOP;
4337 {
4341 {
4344 }
4345 }
4346 END_LOOP;
4350 }
4352 /* --------------------------------------------------------------------------- */
4361 /* %start-doc actions MinClearGap
4363 Checks all specified objects, and increases the polygon clearance if
4364 needed to ensure a minimum distance between their edges and the
4365 polygon edges.
4367 %end-doc */
4369 static int
4371 {
4376 Coord value;
4383 else
4384 {
4388 }
4393 {
4395 {
4399 {
4403 }
4404 }
4405 END_LOOP;
4407 {
4411 {
4415 }
4416 }
4417 END_LOOP;
4418 }
4419 END_LOOP;
4421 {
4425 {
4428 }
4429 }
4430 END_LOOP;
4432 {
4436 {
4439 }
4440 }
4441 ENDALL_LOOP;
4443 {
4447 {
4450 }
4451 }
4452 ENDALL_LOOP;
4456 }
4458 /* --------------------------------------------------------------------------- */
4466 /* %start-doc actions ChangePinName
4468 This can be especially useful for annotating pin names from a
4469 schematic to the layout without requiring knowledge of the pcb file
4470 format.
4472 @example
4473 ChangePinName(U3, 7, VCC)
4474 @end example
4476 %end-doc */
4478 static int
4480 {
4485 {
4487 }
4494 {
4496 {
4498 {
4500 {
4503 /*
4504 * Note: we can't free() pin->Name first because
4505 * it is used in the undo list
4506 */
4510 }
4511 }
4512 END_LOOP;
4515 {
4517 {
4520 /*
4521 * Note: we can't free() pad->Name first because
4522 * it is used in the undo list
4523 */
4527 }
4528 }
4529 END_LOOP;
4530 }
4531 }
4532 END_LOOP;
4533 /*
4534 * done with our action so increment the undo # if we actually
4535 * changed anything
4536 */
4538 {
4541 else
4542 {
4545 }
4546 }
4549 }
4551 /* --------------------------------------------------------------------------- */
4559 /* %start-doc actions ChangeName
4561 @table @code
4563 @item Object
4564 Changes the name of the element under the cursor.
4566 @item Layout
4567 Changes the name of the layout. This is printed on the fab drawings.
4569 @item Layer
4570 Changes the name of the currently active layer.
4572 @end table
4574 %end-doc */
4576 int
4578 {
4583 {
4585 {
4586 /* change the name of an object */
4588 {
4596 {
4599 {
4602 {
4612 {
4618 }
4621 }
4622 }
4623 }
4625 }
4627 /* change the layout's name */
4629 name =
4631 /* NB: ChangeLayoutName takes ownership of the passed memory */
4636 /* change the name of the active layer */
4640 /* NB: ChangeLayerName takes ownership of the passed memory */
4644 }
4645 }
4647 }
4650 /* --------------------------------------------------------------------------- */
4657 /* %start-doc actions MorphPolygon
4659 If a polygon is divided into unconnected "islands", you can use
4660 this command to convert the otherwise disappeared islands into
4661 separate polygons. Be sure the cursor is over a portion of the
4662 polygon that remains visible. Very small islands that may flake
4663 off are automatically deleted.
4665 %end-doc */
4667 static int
4669 {
4672 {
4674 {
4676 {
4683 {
4687 }
4689 }
4693 {
4696 }
4697 ENDALL_LOOP;
4701 }
4702 }
4704 }
4706 /* --------------------------------------------------------------------------- */
4714 /* %start-doc actions ToggleHideName
4716 If names are hidden you won't see them on the screen and they will not
4717 appear on the silk layer when you print the layout.
4719 %end-doc */
4721 static int
4723 {
4726 {
4728 {
4730 {
4737 {
4744 }
4746 }
4749 {
4752 {
4757 {
4764 }
4765 }
4766 END_LOOP;
4768 {
4771 }
4772 }
4773 }
4774 }
4776 }
4778 /* --------------------------------------------------------------------------- */
4786 /* %start-doc actions ChangeJoin
4788 The join flag determines whether a line or arc, drawn to intersect a
4789 polygon, electrically connects to the polygon or not. When joined,
4790 the line/arc is simply drawn over the polygon, making an electrical
4791 connection. When not joined, a gap is drawn between the line and the
4792 polygon, insulating them from each other.
4794 %end-doc */
4796 static int
4798 {
4801 {
4803 {
4806 {
4817 }
4834 }
4835 }
4837 }
4839 /* --------------------------------------------------------------------------- */
4849 /* %start-doc actions ChangeSquare
4851 Note that @code{Pins} means both pins and pads.
4853 @pinshapes
4855 %end-doc */
4857 static int
4859 {
4862 {
4864 {
4867 {
4878 }
4895 }
4896 }
4898 }
4900 /* --------------------------------------------------------------------------- */
4907 /* %start-doc actions SetSquare
4909 Note that @code{Pins} means pins and pads.
4911 @pinshapes
4913 %end-doc */
4915 static int
4917 {
4920 {
4922 {
4925 {
4936 }
4953 }
4954 }
4956 }
4958 /* --------------------------------------------------------------------------- */
4966 /* %start-doc actions ClearSquare
4968 Note that @code{Pins} means pins and pads.
4970 @pinshapes
4972 %end-doc */
4974 static int
4976 {
4979 {
4981 {
4984 {
4995 }
5012 }
5013 }
5015 }
5017 /* --------------------------------------------------------------------------- */
5026 /* %start-doc actions ChangeOctagon
5028 @pinshapes
5030 %end-doc */
5032 static int
5034 {
5037 {
5039 {
5042 {
5053 }
5075 }
5076 }
5078 }
5080 /* --------------------------------------------------------------------------- */
5087 /* %start-doc actions SetOctagon
5089 @pinshapes
5091 %end-doc */
5093 static int
5095 {
5098 {
5100 {
5103 {
5114 }
5136 }
5137 }
5139 }
5141 /* --------------------------------------------------------------------------- */
5150 /* %start-doc actions ClearOctagon
5152 @pinshapes
5154 %end-doc */
5156 static int
5158 {
5161 {
5163 {
5166 {
5177 }
5199 }
5200 }
5202 }
5204 /* --------------------------------------------------------------------------- */
5211 /* %start-doc actions ChangeHole
5213 The "hole flag" of a via determines whether the via is a
5214 plated-through hole (not set), or an unplated hole (set).
5216 %end-doc */
5218 static int
5220 {
5223 {
5225 {
5228 {
5238 }
5245 }
5246 }
5248 }
5250 /* --------------------------------------------------------------------------- */
5258 /* %start-doc actions ChangePaste
5260 The "no paste flag" of a pad determines whether the solderpaste
5261 stencil will have an opening for the pad (no set) or if there wil be
5262 no solderpaste on the pad (set). This is used for things such as
5263 fiducial pads.
5265 %end-doc */
5267 static int
5269 {
5272 {
5274 {
5277 {
5287 }
5294 }
5295 }
5297 }
5299 /* --------------------------------------------------------------------------- */
5312 /* %start-doc actions Select
5314 @table @code
5316 @item ElementByName
5317 @item ObjectByName
5318 @item PadByName
5319 @item PinByName
5320 @item TextByName
5321 @item ViaByName
5322 @item NetByName
5324 These all rely on having a regular expression parser built into
5325 @code{pcb}. If the name is not specified then the user is prompted
5326 for a pattern, and all objects that match the pattern and are of the
5327 type specified are selected.
5329 @item Object
5330 @item ToggleObject
5331 Selects the object under the cursor.
5333 @item Block
5334 Selects all objects in a rectangle indicated by the cursor.
5336 @item All
5337 Selects all objects on the board.
5339 @item Found
5340 Selects all connections with the ``found'' flag set.
5342 @item Connection
5343 Selects all connections with the ``connected'' flag set.
5345 @item Convert
5346 Converts the selected objects to an element. This uses the highest
5347 numbered paste buffer.
5349 @end table
5351 %end-doc */
5353 static int
5355 {
5358 {
5360 {
5361 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5363 /* select objects by their names */
5386 commonByName:
5387 {
5393 {
5398 }
5400 }
5403 /* select a single object */
5410 /* all objects in block */
5412 {
5413 BoxType box;
5427 {
5430 }
5433 }
5435 /* select all visible objects */
5437 {
5438 BoxType box;
5447 }
5449 /* all logical connections */
5452 {
5456 }
5459 /* all physical connections */
5462 {
5466 }
5470 {
5485 }
5491 }
5492 }
5494 }
5496 /* FLAG(have_regex,FlagHaveRegex,0) */
5497 int
5499 {
5500 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5502 #else
5504 #endif
5505 }
5507 /* --------------------------------------------------------------------------- */
5519 /* %start-doc actions Unselect
5521 @table @code
5523 @item All
5524 Unselect all objects.
5526 @item Block
5527 Unselect all objects in a rectangle given by the cursor.
5529 @item Connection
5530 Unselect all connections with the ``found'' flag set.
5532 @item ElementByName
5533 @item ObjectByName
5534 @item PadByName
5535 @item PinByName
5536 @item TextByName
5537 @item ViaByName
5539 These all rely on having a regular expression parser built into
5540 @code{pcb}. If the name is not specified then the user is prompted
5541 for a pattern, and all objects that match the pattern and are of the
5542 type specified are unselected.
5545 @end table
5547 %end-doc */
5549 static int
5551 {
5554 {
5556 {
5557 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5559 /* select objects by their names */
5582 commonByName:
5583 {
5589 {
5594 }
5596 }
5599 /* all objects in block */
5601 {
5602 BoxType box;
5616 {
5619 }
5622 }
5624 /* unselect all visible objects */
5626 {
5627 BoxType box;
5636 }
5638 /* all logical connections */
5641 {
5645 }
5648 /* all physical connections */
5651 {
5655 }
5662 }
5663 }
5665 }
5667 /* --------------------------------------------------------------------------- */
5676 /* %start-doc actions SaveTo
5678 @table @code
5680 @item Layout
5681 Saves the current layout.
5683 @item LayoutAs
5684 Saves the current layout, and remembers the filename used.
5686 @item AllConnections
5687 Save all connections to a file.
5689 @item AllUnusedPins
5690 List all unused pins to a file.
5692 @item ElementConnections
5693 Save connections to the element at the cursor to a file.
5695 @item PasteBuffer
5696 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5698 @end table
5700 %end-doc */
5702 static int
5704 {
5712 {
5716 }
5722 {
5724 {
5730 }
5732 }
5735 {
5739 {
5743 }
5745 }
5748 {
5752 {
5756 }
5758 }
5761 {
5769 {
5773 {
5777 }
5778 }
5780 }
5783 {
5785 }
5788 }
5790 /* --------------------------------------------------------------------------- */
5798 /* %start-doc actions SaveSettings
5800 If you pass no arguments, the settings are stored in
5801 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5802 saved in @code{./pcb.settings}.
5804 %end-doc */
5806 static int
5808 {
5812 }
5814 /* --------------------------------------------------------------------------- */
5821 /* %start-doc actions LoadFrom
5823 This action assumes you know what the filename is. The various GUIs
5824 should have a similar @code{Load} action where the filename is
5825 optional, and will provide their own file selection mechanism to let
5826 you choose the file name.
5828 @table @code
5830 @item Layout
5831 Loads an entire PCB layout, replacing the current one.
5833 @item LayoutToBuffer
5834 Loads an entire PCB layout to the paste buffer.
5836 @item ElementToBuffer
5837 Loads the given element file into the paste buffer. Element files
5838 contain only a single @code{Element} definition, such as the
5839 ``newlib'' library uses.
5841 @item Netlist
5842 Loads a new netlist, replacing any current netlist.
5844 @item Revert
5845 Re-loads the current layout from its disk file, reverting any changes
5846 you may have made.
5848 @end table
5850 %end-doc */
5852 static int
5854 {
5865 {
5870 }
5873 {
5878 }
5881 {
5885 }
5888 {
5895 }
5899 {
5901 }
5904 }
5906 /* --------------------------------------------------------------------------- */
5912 /* %start-doc actions New
5914 If a name is not given, one is prompted for.
5916 %end-doc */
5918 static int
5920 {
5924 {
5927 else
5934 /* do emergency saving
5935 * clear the old struct and allocate memory for the new one
5936 */
5944 /* setup the new name and reset some values to default */
5956 }
5958 }
5960 /* ---------------------------------------------------------------------------
5961 * no operation, just for testing purposes
5962 * syntax: Bell(volume)
5963 */
5964 void
5966 {
5968 }
5970 /* --------------------------------------------------------------------------- */
5981 /* %start-doc actions PasteBuffer
5983 There are a number of paste buffers; the actual limit is a
5984 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5985 is currently @code{5}. One of these is the ``current'' paste buffer,
5986 often referred to as ``the'' paste buffer.
5988 @table @code
5990 @item AddSelected
5991 Copies the selected objects to the current paste buffer.
5993 @item Clear
5994 Remove all objects from the current paste buffer.
5996 @item Convert
5997 Convert the current paste buffer to an element. Vias are converted to
5998 pins, lines are converted to pads.
6000 @item Restore
6001 Convert any elements in the paste buffer back to vias and lines.
6003 @item Mirror
6004 Flip all objects in the paste buffer vertically (up/down flip). To mirror
6005 horizontally, combine this with rotations.
6007 @item Rotate
6008 Rotates the current buffer. The number to pass is 1..3, where 1 means
6009 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6010 degrees clockwise (270 CCW).
6012 @item Save
6013 Saves any elements in the current buffer to the indicated file.
6015 @item ToLayout
6016 Pastes any elements in the current buffer to the indicated X, Y
6017 coordinates in the layout. The @code{X} and @code{Y} are treated like
6018 @code{delta} is for many other objects. For each, if it's prefixed by
6019 @code{+} or @code{-}, then that amount is relative to the last
6020 location. Otherwise, it's absolute. Units can be
6021 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6022 units, currently 1/100 mil.
6025 @item 1..MAX_BUFFER
6026 Selects the given buffer to be the current paste buffer.
6028 @end table
6030 %end-doc */
6032 static int
6034 {
6043 {
6045 {
6046 /* clear contents of paste buffer */
6051 /* copies objects to paste buffer */
6056 /* converts buffer contents into an element */
6061 /* break up element for editing */
6066 /* Mirror buffer */
6073 {
6076 }
6081 {
6084 }
6087 {
6095 {
6098 }
6100 {
6102 }
6104 }
6106 else
6109 {
6113 {
6118 }
6119 else
6124 }
6128 {
6134 {
6136 }
6138 {
6145 }
6146 else
6147 {
6150 }
6156 }
6159 /* set number */
6161 {
6164 /* correct number */
6167 }
6168 }
6169 }
6173 }
6175 /* --------------------------------------------------------------------------- */
6182 /* %start-doc actions Undo
6184 The unlimited undo feature of @code{Pcb} allows you to recover from
6185 most operations that materially affect you work. Calling
6186 @code{Undo()} without any parameter recovers from the last (non-undo)
6187 operation. @code{ClearList} is used to release the allocated
6188 memory. @code{ClearList} is called whenever a new layout is started or
6189 loaded. See also @code{Redo} and @code{Atomic}.
6191 Note that undo groups operations by serial number; changes with the
6192 same serial number will be undone (or redone) as a group. See
6193 @code{Atomic}.
6195 %end-doc */
6197 static int
6199 {
6202 {
6203 /* don't allow undo in the middle of an operation */
6210 /* undo the last operation */
6216 {
6220 }
6221 /* move anchor point if undoing during line creation */
6223 {
6225 {
6232 }
6234 {
6238 /* this search is guaranteed to succeed */
6245 /* save both ends of line */
6250 /* check that the undo was of the right type */
6252 {
6253 /* wrong undo type, restore anchor points */
6260 }
6261 /* move to new anchor */
6266 /* check if an intermediate point was removed */
6268 {
6269 /* this search should find the restored line */
6277 {
6278 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6282 }
6287 }
6291 {
6294 }
6295 else
6296 {
6297 /* this search is guaranteed to succeed too */
6305 }
6308 }
6309 }
6311 {
6313 {
6317 }
6319 {
6322 /* guaranteed to succeed */
6334 }
6335 }
6336 /* undo the last destructive operation */
6339 }
6341 {
6343 {
6344 /* clear 'undo objects' list */
6348 }
6349 }
6352 }
6354 /* --------------------------------------------------------------------------- */
6360 /* %start-doc actions Redo
6362 This routine allows you to recover from the last undo command. You
6363 might want to do this if you thought that undo was going to revert
6364 something other than what it actually did (in case you are confused
6365 about which operations are un-doable), or if you have been backing up
6366 through a long undo list and over-shoot your stopping point. Any
6367 change that is made since the undo in question will trim the redo
6368 list. For example if you add ten lines, then undo three of them you
6369 could use redo to put them back, but if you move a line on the board
6370 before performing the redo, you will lose the ability to "redo" the
6371 three "undone" lines.
6373 %end-doc */
6375 static int
6377 {
6385 {
6389 {
6395 addedLines++;
6396 }
6397 }
6400 }
6402 /* --------------------------------------------------------------------------- */
6408 /* %start-doc actions Polygon
6410 Polygons need a special action routine to make life easier.
6412 @table @code
6414 @item Close
6415 Creates the final segment of the polygon. This may fail if clipping
6416 to 45 degree lines is switched on, in which case a warning is issued.
6418 @item PreviousPoint
6419 Resets the newly entered corner to the previous one. The Undo action
6420 will call Polygon(PreviousPoint) when appropriate to do so.
6422 @end table
6424 %end-doc */
6426 static int
6428 {
6431 {
6434 {
6435 /* close open polygon if possible */
6440 /* go back to the previous point */
6444 }
6446 }
6448 }
6450 /* --------------------------------------------------------------------------- */
6457 /* %start-doc actions RouteStyle
6459 %end-doc */
6461 static int
6463 {
6469 {
6472 {
6479 }
6480 }
6482 }
6485 /* --------------------------------------------------------------------------- */
6492 /* %start-doc actions MoveObject
6494 The @code{X} and @code{Y} are treated like @code{delta} is for many
6495 other objects. For each, if it's prefixed by @code{+} or @code{-},
6496 then that amount is relative. Otherwise, it's absolute. Units can be
6497 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6498 units, currently 1/100 mil.
6500 %end-doc */
6502 static int
6504 {
6518 {
6521 }
6534 }
6536 /* --------------------------------------------------------------------------- */
6544 /* %start-doc actions MoveToCurrentLayer
6546 Note that moving an element from a component layer to a solder layer,
6547 or from solder to component, won't automatically flip it. Use the
6548 @code{Flip()} action to do that.
6550 %end-doc */
6552 static int
6554 {
6557 {
6559 {
6561 {
6572 }
6579 }
6580 }
6582 }
6590 /* %start-doc actions SetSame
6592 When invoked over any line, arc, polygon, or via, this changes the
6593 current layer to be the layer that item is on, and changes the current
6594 sizes (thickness, keepaway, drill, etc) according to that item.
6596 %end-doc */
6598 static int
6600 {
6606 /* set layer current and size from line or arc */
6608 {
6648 }
6650 {
6653 }
6655 }
6658 /* --------------------------------------------------------------------------- */
6669 /* %start-doc actions SetFlag
6671 Turns the given flag on, regardless of its previous setting. See
6672 @code{ChangeFlag}.
6674 @example
6675 SetFlag(SelectedPins,thermal)
6676 @end example
6678 %end-doc */
6680 static int
6682 {
6687 }
6689 /* --------------------------------------------------------------------------- */
6700 /* %start-doc actions ClrFlag
6702 Turns the given flag off, regardless of its previous setting. See
6703 @code{ChangeFlag}.
6705 @example
6706 ClrFlag(SelectedLines,join)
6707 @end example
6709 %end-doc */
6711 static int
6713 {
6718 }
6720 /* --------------------------------------------------------------------------- */
6732 /* %start-doc actions ChangeFlag
6734 Toggles the given flag on the indicated object(s). The flag may be
6735 one of the flags listed above (square, octagon, thermal, join). The
6736 value may be the number 0 or 1. If the value is 0, the flag is
6737 cleared. If the value is 1, the flag is set.
6739 %end-doc */
6741 static int
6743 {
6752 }
6755 static void
6757 {
6762 {
6765 }
6767 {
6770 }
6772 {
6773 /* Note: these are backwards, because the flag is "clear" but
6774 the command is "join". */
6777 }
6778 else
6779 {
6782 }
6785 {
6787 {
6799 }
6841 }
6842 }
6844 /* --------------------------------------------------------------------------- */
6850 /* %start-doc actions ExecuteFile
6852 Lines starting with @code{#} are ignored.
6854 %end-doc */
6856 static int
6858 {
6871 {
6874 }
6879 {
6880 n++;
6883 /* eat the trailing newline */
6885 sp++;
6888 /* eat leading spaces and tabs */
6891 sp++;
6893 /*
6894 * if we have anything left and its not a comment line
6895 * then execute it
6896 */
6899 {
6900 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6902 }
6903 }
6907 {
6910 }
6913 }
6915 /* --------------------------------------------------------------------------- */
6917 static int
6919 {
6923 }
6925 /* --------------------------------------------------------------------------- */
6931 {
6938 {
6941 {
6944 }
6945 }
6946 END_LOOP;
6948 }
6952 {
6958 }
6960 static void
6962 {
6969 }
6971 /* ---------------------------------------------------------------- */
6978 /* %start-doc actions elementlist
6980 @table @code
6982 @item Start
6983 Indicates the start of an element list; call this before any Need
6984 actions.
6986 @item Need
6987 Searches the board for an element with a matching refdes.
6989 If found, the value and footprint are updated.
6991 If not found, a new element is created with the given footprint and value.
6993 @item Done
6994 Compares the list of elements needed since the most recent
6995 @code{start} with the list of elements actually on the board. Any
6996 elements that weren't listed are selected, so that the user may delete
6997 them.
6999 @end table
7001 %end-doc */
7005 static int
7007 {
7012 }
7014 static int
7016 {
7022 #ifdef DEBUG
7024 #endif
7027 {
7029 {
7031 }
7032 END_LOOP;
7036 }
7039 {
7041 {
7043 {
7045 }
7047 {
7048 /* Unnamed elements should remain untouched */
7050 }
7051 }
7052 END_LOOP;
7058 }
7066 argc --;
7067 argv ++;
7077 #ifdef DEBUG
7081 #endif
7086 {
7089 #ifdef DEBUG
7091 #endif
7092 /* Not on board, need to add it. */
7094 {
7095 number_of_footprints_not_found ++;
7097 }
7108 {
7111 }
7122 /* Place components onto center of board. */
7125 }
7128 {
7129 #ifdef DEBUG
7131 #endif
7136 /* Different footprint, we need to swap them out. */
7138 {
7139 number_of_footprints_not_found ++;
7141 }
7156 {
7161 }
7167 }
7169 /* Now reload footprint */
7182 #ifdef DEBUG
7184 #endif
7187 }
7189 /* ---------------------------------------------------------------- */
7196 /* %start-doc actions elementsetattr
7198 If a value is specified, the named attribute is added (if not already
7199 present) or changed (if it is) to the given value. If the value is
7200 not specified, the given attribute is removed if present.
7202 %end-doc */
7204 static int
7206 {
7212 {
7214 }
7221 {
7223 {
7226 }
7227 }
7228 END_LOOP;
7231 {
7234 }
7239 {
7242 }
7244 {
7246 }
7248 {
7250 }
7253 }
7255 /* ---------------------------------------------------------------- */
7260 /* %start-doc actions execcommand
7262 Runs the given command, which is a system executable.
7264 %end-doc */
7266 static int
7268 {
7272 {
7274 }
7281 }
7283 /* ---------------------------------------------------------------- */
7285 static int
7287 {
7288 #ifdef HAVE__SPAWNVP
7292 else
7294 #else
7298 {
7299 /* error */
7302 }
7304 {
7305 /* Child */
7308 }
7309 else
7310 {
7312 /* Parent */
7314 }
7316 #endif
7317 }
7319 /* ---------------------------------------------------------------- */
7320 /*
7321 * Creates a new temporary file name. Hopefully the operating system
7322 * provides a mkdtemp() function to securily create a temporary
7323 * directory with mode 0700. If so then that directory is created and
7324 * the returned string is made up of the directory plus the name
7325 * variable. For example:
7326 *
7327 * tempfile_name_new ("myfile") might return
7328 * "/var/tmp/pcb.123456/myfile".
7329 *
7330 * If mkdtemp() is not available then 'name' is ignored and the
7331 * insecure tmpnam() function is used.
7332 *
7333 * Files/names created with tempfile_name_new() should be unlinked
7334 * with tempfile_unlink to make sure the temporary directory is also
7335 * removed when mkdtemp() is used.
7336 */
7339 {
7341 #ifdef HAVE_MKDTEMP
7344 #endif
7348 #ifdef HAVE_MKDTEMP
7354 /* FIXME -- what about win32? */
7357 }
7367 }
7377 }
7384 ;
7394 #undef TEMPLATE
7395 #else
7396 /*
7397 * tmpnam() uses a static buffer so strdup() the result right away
7398 * in case someone decides to create multiple temp names.
7399 */
7401 #ifdef __WIN32__
7402 {
7403 /* Guile doesn't like \ separators */
7408 }
7409 #endif
7410 #endif
7413 }
7415 /* ---------------------------------------------------------------- */
7416 /*
7417 * Unlink a temporary file. If we have mkdtemp() then our temp file
7418 * lives in a temporary directory and we need to remove that directory
7419 * too.
7420 */
7421 static int
7423 {
7424 #ifdef DEBUG
7425 /* SDB says: Want to keep old temp files for examiniation when debugging */
7427 #endif
7429 #ifdef HAVE_MKDTEMP
7434 /* it is possible that the file was never created so it is OK if the
7435 unlink fails */
7437 /* now figure out the directory name to remove */
7444 /*
7445 * at this point, e *should* point to the end of the directory part
7446 * but lets make sure.
7447 */
7452 }
7456 __FUNCTION__);
7460 }
7462 /* name was allocated with malloc */
7466 /*
7467 * FIXME - should also return -1 if the temp file exists and was not
7468 * removed.
7469 */
7472 }
7474 #else
7481 }
7484 #endif
7487 }
7489 /* ---------------------------------------------------------------- */
7498 /* %start-doc actions Import
7500 Imports element and netlist data from the schematics (or some other
7501 source). The first parameter, which is optional, is the mode. If not
7502 specified, the @code{import::mode} attribute in the PCB is used.
7503 @code{gnetlist} means gnetlist is used to obtain the information from
7504 the schematics. @code{make} invokes @code{make}, assuming the user
7505 has a @code{Makefile} in the current directory. The @code{Makefile}
7506 will be invoked with the following variables set:
7508 @table @code
7510 @item PCB
7511 The name of the .pcb file
7513 @item SRCLIST
7514 A space-separated list of source files
7516 @item OUT
7517 The name of the file in which to put the command script, which may
7518 contain any @pcb{} actions. By default, this is a temporary file
7519 selected by @pcb{}, but if you specify an @code{import::outfile}
7520 attribute, that file name is used instead (and not automatically
7521 deleted afterwards).
7523 @end table
7525 The target specified to be built is the first of these that apply:
7527 @itemize @bullet
7529 @item
7530 The target specified by an @code{import::target} attribute.
7532 @item
7533 The output file specified by an @code{import::outfile} attribute.
7535 @item
7536 If nothing else is specified, the target is @code{pcb_import}.
7538 @end itemize
7540 If you specify an @code{import::makefile} attribute, then "-f <that
7541 file>" will be added to the command line.
7543 If you specify the mode, you may also specify the source files
7544 (schematics). If you do not specify any, the list of schematics is
7545 obtained by reading the @code{import::src@var{N}} attributes (like
7546 @code{import::src0}, @code{import::src1}, etc).
7548 For compatibility with future extensions to the import file format,
7549 the generated file @emph{must not} start with the two characters
7550 @code{#%}.
7552 If a temporary file is needed the @code{TMPDIR} environment variable
7553 is used to select its location.
7555 Note that the programs @code{gnetlist} and @code{make} may be
7556 overridden by the user via the @code{make-program} and @code{gnetlist}
7557 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7558 line).
7560 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7561 is called to let user choose (see @code{ImportGUI()}).
7563 Note that Import() doesn't delete anything - after an Import, elements
7564 which shouldn't be on the board are selected and may be removed once
7565 it's determined that the deletion is appropriate.
7567 If @code{Import()} is called with @code{setnewpoint}, then the location
7568 of new components can be specified. This is where parts show up when
7569 they're added to the board. The default is the center of the board.
7571 @table @code
7573 @item Import(setnewpoint)
7575 Prompts the user to click on the board somewhere, uses that point. If
7576 called by a hotkey, uses the current location of the crosshair.
7578 @item Import(setnewpoint,mark)
7580 Uses the location of the mark. If no mark is present, the point is
7581 not changed.
7583 @item Import(setnewpoint,center)
7585 Resets the point to the center of the board.
7587 @item Import(setnewpoint,X,Y,units)
7589 Sets the point to the specific coordinates given. Example:
7590 @code{Import(setnewpoint,50,25,mm)}
7592 @end table
7594 Note that the X and Y locations are stored in attributes named
7595 @code{import::newX} and @code{import::newY} so you could change them
7596 manually if you wished.
7598 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7599 placed elements are dispersed relative to the set point. For example,
7600 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7601 10mm away from the point. The default dispersion is 1/10th of the
7602 smallest board dimension. Dispersion is saved in the
7603 @code{import::disperse} attribute.
7605 %end-doc */
7607 static int
7609 {
7614 #ifdef DEBUG
7616 #endif
7621 {
7628 {
7631 }
7633 {
7636 }
7637 else
7642 }
7645 {
7655 {
7657 }
7659 {
7663 }
7665 {
7671 }
7673 {
7676 }
7677 else
7678 {
7681 }
7688 }
7696 {
7699 }
7702 {
7708 nsources ++;
7714 {
7718 nsources ++;
7723 }
7724 }
7727 {
7728 /* Replace .pcb with .sch and hope for the best. */
7750 {
7753 }
7759 }
7762 {
7770 }
7783 #ifdef DEBUG
7787 #endif
7790 {
7793 }
7795 #ifdef DEBUG
7796 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7797 #endif
7805 }
7807 {
7827 else
7828 {
7833 }
7835 }
7843 {
7847 }
7856 {
7859 }
7864 {
7871 }
7882 }
7883 else
7884 {
7887 }
7892 #ifdef DEBUG
7894 #endif
7897 }
7899 /* ------------------------------------------------------------ */
7909 /* %start-doc actions Attributes
7911 This just pops up a dialog letting the user edit the attributes of the
7912 pcb, an element, or a layer.
7914 %end-doc */
7917 static int
7919 {
7928 {
7931 }
7934 {
7936 {
7939 }
7942 {
7945 {
7950 {
7953 }
7955 {
7958 }
7959 }
7966 }
7969 {
7973 {
7975 {
7977 n_found ++;
7978 }
7979 }
7980 END_LOOP;
7982 {
7985 }
7987 {
7994 else
7995 {
7998 }
7999 }
8002 {
8006 }
8007 else
8008 {
8010 }
8014 }
8018 }
8021 }
8023 /* --------------------------------------------------------------------------- */
8025 HID_Action action_action_list[] = {
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 ,
8157 ,
8160 ,
8163 ,
8166 ,
8169 ,
8172 ,
8175 ,
8178 ,
8181 ,
8184 ,
8187 ,
8190 ,
8193 ,
8196 ,
8199 ,
8201 ,
8204 ,
8207 ,
8210 ,
8213 ,
8214 };