| blob | 8cd389ce72ab9a3ddd5e79944a058619d3d1da20 |
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 }
1268 {
1271 addedLines++;
1274 /* place a via if vias are visible, the layer is
1275 in a new group since the last line and there
1276 isn't a pin already here */
1283 NO_TYPE
1292 {
1295 }
1296 /* copy the coordinates */
1303 }
1315 {
1316 addedLines++;
1320 /* move to new start point */
1326 {
1328 }
1329 }
1333 }
1337 /* do update of position */
1340 /* create rectangle if both corners are determined
1341 * and width, height are != 0
1342 */
1346 {
1353 Crosshair.
1355 Crosshair.
1357 Crosshair.
1359 Crosshair.
1361 MakeFlags
1363 NULL)
1364 {
1370 }
1372 /* reset state to 'first corner' */
1374 }
1378 {
1382 {
1384 {
1394 {
1399 }
1400 }
1402 }
1404 }
1407 {
1411 /* do update of position; use the 'LINE_MODE' mechanism */
1414 /* check if this is the last point of a polygon */
1418 {
1422 }
1424 /* create new point if it's the first one or if it's
1425 * different to the last one
1426 */
1430 {
1435 /* copy the coordinates */
1438 }
1440 }
1443 {
1445 {
1446 /* first notify, lookup object */
1455 {
1458 {
1462 }
1463 else
1465 }
1468 /* second notify, insert new point into object */
1470 {
1474 FlagType Flags;
1476 /* do update of position; use the 'LINE_MODE' mechanism */
1479 /* check if this is the last point of a polygon */
1483 {
1484 /* Create POLYAREAs from the original polygon
1485 * and the new hole polygon */
1489 /* Subtract the hole from the original polygon shape */
1492 /* Convert the resulting polygon(s) into a new set of nodes
1493 * and place them on the page. Delete the original polygon.
1494 */
1507 /* reset state of attached line */
1513 }
1515 /* create new point if it's the first one or if it's
1516 * different to the last one
1517 */
1521 {
1526 /* copy the coordinates */
1529 }
1531 }
1532 }
1535 }
1538 {
1543 {
1548 {
1551 {
1559 }
1560 }
1561 }
1565 {
1570 {
1577 {
1589 }
1590 }
1591 }
1593 }
1599 {
1601 {
1604 }
1606 {
1614 {
1621 else
1623 ptr++;
1624 }
1625 }
1629 }
1639 /* both are almost the same */
1643 {
1644 /* first notify, lookup object */
1646 {
1656 {
1660 {
1663 }
1664 else
1666 }
1668 }
1670 /* second notify, move or copy object */
1679 else
1680 {
1688 }
1691 /* reset identifiers */
1695 }
1698 /* insert a point into a polygon/line/... */
1701 {
1702 /* first notify, lookup object */
1711 {
1714 {
1718 }
1719 else
1720 {
1721 /* get starting point of nearest segment */
1723 {
1726 polyIndex =
1734 }
1737 }
1738 }
1741 /* second notify, insert new point into object */
1748 else
1756 /* reset identifiers */
1760 }
1762 }
1763 }
1766 /* --------------------------------------------------------------------------- */
1772 /* %start-doc actions Atomic
1774 This action allows making multiple-action bindings into an atomic
1775 operation that will be undone by a single Undo command. For example,
1776 to optimize rat lines, you'd delete the rats and re-add them. To
1777 group these into a single undo, you'd want the deletions and the
1778 additions to have the same undo serial number. So, you @code{Save},
1779 delete the rats, @code{Restore}, add the rats - using the same serial
1780 number as the deletes, then @code{Block}, which checks to see if the
1781 deletions or additions actually did anything. If not, the serial
1782 number is set to the saved number, as there's nothing to undo. If
1783 something did happen, the serial number is incremented so that these
1784 actions are counted as a single undo step.
1786 @table @code
1788 @item Save
1789 Saves the undo serial number.
1791 @item Restore
1792 Returns it to the last saved number.
1794 @item Close
1795 Sets it to 1 greater than the last save.
1797 @item Block
1798 Does a Restore if there was nothing to undo, else does a Close.
1800 @end table
1802 %end-doc */
1804 static int
1806 {
1811 {
1827 }
1829 }
1831 /* -------------------------------------------------------------------------- */
1837 /* %start-doc actions DRC
1839 Note that the design rule check uses the current board rule settings,
1840 not the current style settings.
1842 %end-doc */
1844 static int
1846 {
1850 {
1858 }
1861 {
1866 else
1868 }
1870 }
1872 /* -------------------------------------------------------------------------- */
1879 /* %start-doc actions DumpLibrary
1882 %end-doc */
1884 static int
1886 {
1893 {
1904 {
1907 {
1910 }
1911 else
1912 {
1919 }
1920 }
1921 }
1924 }
1926 /* -------------------------------------------------------------------------- */
1933 /* %start-doc actions Flip
1935 Note that the location of the element will be symmetric about the
1936 cursor location; i.e. if the part you are pointing at will still be at
1937 the same spot once the element is on the other side. When flipping
1938 multiple elements, this retains their positions relative to each
1939 other, not their absolute positions on the board.
1941 %end-doc */
1943 static int
1945 {
1952 {
1954 {
1958 {
1963 }
1972 }
1975 }
1978 }
1980 /* -------------------------------------------------------------------------- */
1986 /* %start-doc actions Message
1988 This action displays a message to the log window. This action is primarily
1989 provided for use by other programs which may interface with PCB. If
1990 multiple arguments are given, each one is sent to the log window
1991 followed by a newline.
1993 %end-doc */
1995 static int
1997 {
2004 {
2007 }
2010 }
2013 /* -------------------------------------------------------------------------- */
2023 "Style = 3 is a solid connection to the plane."
2027 /* %start-doc actions SetThermal
2029 This changes how/whether pins or vias connect to any rectangle or polygon
2030 on the current layer. The first argument can specify one object, or all
2031 selected pins, or all selected vias, or all selected pins and vias.
2032 The second argument specifies the style of connection.
2033 There are 5 possibilities:
2034 0 - no connection,
2035 1 - 45 degree fingers with sharp edges,
2036 2 - horizontal & vertical fingers with sharp edges,
2037 3 - solid connection,
2038 4 - 45 degree fingers with rounded corners,
2039 5 - horizontal & vertical fingers with rounded corners.
2041 Pins and Vias may have thermals whether or not there is a polygon available
2042 to connect with. However, they will have no effect without the polygon.
2043 %end-doc */
2045 static int
2047 {
2055 {
2061 {
2066 {
2070 }
2085 }
2086 else
2090 }
2093 }
2095 /* ---------------------------------------------------------------------------
2096 * !!! no action routine !!!
2097 *
2098 * event handler to set the cursor according to the X pointer position
2099 * called from inside main.c
2100 */
2101 void
2103 {
2104 #ifdef HAVE_LIBSTROKE
2106 {
2111 }
2114 {
2115 /* update object position and cursor location */
2118 }
2119 }
2121 /* --------------------------------------------------------------------------- */
2130 /* %start-doc actions SetValue
2132 @table @code
2134 @item ViaDrillingHole
2135 Changes the diameter of the drill for new vias.
2137 @item Grid
2138 Sets the grid spacing.
2140 @item Line
2141 @item LineSize
2142 Changes the thickness of new lines.
2144 @item Via
2145 @item ViaSize
2146 Changes the diameter of new vias.
2148 @item Text
2149 @item TextScale
2150 Changes the size of new text.
2152 @end table
2154 %end-doc */
2156 static int
2158 {
2168 {
2171 {
2182 else
2183 {
2187 /* On the way down, short against the minimum
2188 * PCB drawing unit */
2193 else
2195 }
2223 }
2226 }
2229 }
2232 /* --------------------------------------------------------------------------- */
2238 /* %start-doc actions Quit
2240 If you have unsaved changes, you will be prompted to confirm (or
2241 save) before quitting.
2243 %end-doc */
2245 static int
2247 {
2250 {
2253 }
2257 }
2259 /* --------------------------------------------------------------------------- */
2267 /* %start-doc actions Connection
2269 Connections found with this action will be highlighted in the
2270 ``connected-color'' color and will have the ``found'' flag set.
2272 @table @code
2274 @item Find
2275 The net under the cursor is ``found''.
2277 @item ResetLinesAndPolygons
2278 Any ``found'' lines and polygons are marked ``not found''.
2280 @item ResetPinsAndVias
2281 Any ``found'' pins and vias are marked ``not found''.
2283 @item Reset
2284 All ``found'' objects are marked ``not found''.
2286 @end table
2288 %end-doc */
2290 static int
2292 {
2295 {
2297 {
2299 {
2304 }
2308 {
2311 }
2316 {
2319 }
2324 {
2327 }
2329 }
2331 }
2334 }
2336 /* --------------------------------------------------------------------------- */
2343 /* %start-doc actions DisperseElements
2345 Normally this is used when starting a board, by selecting all elements
2346 and then dispersing them. This scatters the elements around the board
2347 so that you can pick individual ones, rather than have all the
2348 elements at the same 0,0 coordinate and thus impossible to choose
2349 from.
2351 %end-doc */
2353 #define GAP MIL_TO_COORD(100)
2355 static int
2357 {
2366 {
2368 }
2369 else
2370 {
2372 {
2383 }
2384 }
2387 {
2389 }
2393 {
2394 /*
2395 * If we want to disperse selected elements, maybe we need smarter
2396 * code here to avoid putting components on top of others which
2397 * are not selected. For now, I'm assuming that this is typically
2398 * going to be used either with a brand new design or a scratch
2399 * design holding some new components
2400 */
2402 {
2404 /* figure out how much to move the element */
2407 /* snap to the grid */
2410 /*
2411 * and add one grid size so we make sure we always space by GAP or
2412 * more
2413 */
2416 /* Figure out if this row has room. If not, start a new row */
2418 {
2421 }
2423 /* figure out how much to move the element */
2427 /* snap to the grid */
2433 /* move the element */
2436 /* and add to the undo list so we can undo this operation */
2439 /* keep track of how tall this row is */
2442 {
2444 }
2445 }
2447 }
2448 END_LOOP;
2450 /* done with our action so increment the undo # */
2457 }
2459 #undef GAP
2461 /* --------------------------------------------------------------------------- */
2476 /* %start-doc actions Display
2478 @table @code
2480 @item NameOnPCB
2481 @item Description
2482 @item Value
2483 Specify whether all elements show their name, description, or value.
2485 @item Redraw
2486 Redraw the whole board.
2488 @item Toggle45Degree
2489 When clear, lines can be drawn at any angle. When set, lines are
2490 restricted to multiples of 45 degrees and requested lines may be
2491 broken up according to the clip setting.
2493 @item CycleClip
2494 Changes the way lines are restricted to 45 degree increments. The
2495 various settings are: straight only, orthogonal then angled, and angled
2496 then orthogonal. If AllDirections is set, this action disables it.
2498 @item CycleCrosshair
2499 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2500 8-ray and 12-ray cross.
2502 @item ToggleRubberBandMode
2503 If set, moving an object moves all the lines attached to it too.
2505 @item ToggleStartDirection
2506 If set, each time you set a point in a line, the Clip toggles between
2507 orth-angle and angle-ortho.
2509 @item ToggleUniqueNames
2510 If set, you will not be permitted to change the name of an element to
2511 match that of another element.
2513 @item ToggleSnapPin
2514 If set, pin centers and pad end points are treated as additional grid
2515 points that the cursor can snap to.
2517 @item ToggleLocalRef
2518 If set, the mark is automatically set to the beginning of any move, so
2519 you can see the relative distance you've moved.
2521 @item ToggleThindraw
2522 If set, objects on the screen are drawn as outlines (lines are drawn
2523 as center-lines). This lets you see line endpoints hidden under pins,
2524 for example.
2526 @item ToggleThindrawPoly
2527 If set, polygons on the screen are drawn as outlines.
2529 @item ToggleShowDRC
2530 If set, pending objects (i.e. lines you're in the process of drawing)
2531 will be drawn with an outline showing how far away from other copper
2532 you need to be.
2534 @item ToggleLiveRoute
2535 If set, the progress of the autorouter will be visible on the screen.
2537 @item ToggleAutoDRC
2538 If set, you will not be permitted to make connections which violate
2539 the current DRC and netlist settings.
2541 @item ToggleCheckPlanes
2542 If set, lines and arcs aren't drawn, which usually leaves just the
2543 polygons. If you also disable all but the layer you're interested in,
2544 this allows you to check for isolated regions.
2546 @item ToggleOrthoMove
2547 If set, the crosshair is only allowed to move orthogonally from its
2548 previous position. I.e. you can move an element or line up, down,
2549 left, or right, but not up+left or down+right.
2551 @item ToggleName
2552 Selects whether the pinouts show the pin names or the pin numbers.
2554 @item ToggleLockNames
2555 If set, text will ignore left mouse clicks and actions that work on
2556 objects under the mouse. You can still select text with a lasso (left
2557 mouse drag) and perform actions on the selection.
2559 @item ToggleOnlyNames
2560 If set, only text will be sensitive for mouse clicks and actions that
2561 work on objects under the mouse. You can still select other objects
2562 with a lasso (left mouse drag) and perform actions on the selection.
2564 @item ToggleMask
2565 Turns the solder mask on or off.
2567 @item ToggleClearLine
2568 When set, the clear-line flag causes new lines and arcs to have their
2569 ``clear polygons'' flag set, so they won't be electrically connected
2570 to any polygons they overlap.
2572 @item ToggleFullPoly
2573 When set, the full-poly flag causes new polygons to have their
2574 ``full polygon'' flag set, so all parts of them will be displayed
2575 instead of only the biggest one.
2577 @item ToggleGrid
2578 Resets the origin of the current grid to be wherever the mouse pointer
2579 is (not where the crosshair currently is). If you provide two numbers
2580 after this, the origin is set to that coordinate.
2582 @item Grid
2583 Toggles whether the grid is displayed or not.
2585 @item Pinout
2586 Causes the pinout of the element indicated by the cursor to be
2587 displayed, usually in a separate window.
2589 @item PinOrPadName
2590 Toggles whether the names of pins, pads, or (yes) vias will be
2591 displayed. If the cursor is over an element, all of its pins and pads
2592 are affected.
2594 @end table
2596 %end-doc */
2598 static enum crosshair_shape
2600 {
2602 {
2615 }
2617 }
2619 static int
2621 {
2630 {
2632 {
2634 /* redraw layout */
2640 /* change the displayed name of elements */
2645 {
2647 }
2648 END_LOOP;
2651 {
2660 }
2662 {
2664 }
2665 END_LOOP;
2669 /* toggle line-adjust flag */
2678 {
2681 }
2682 else
2759 {
2761 {
2764 }
2766 {
2773 }
2774 }
2805 /* shift grid alignment */
2807 {
2814 }
2817 /* toggle displaying of the grid */
2823 /* display the pinout of an element */
2825 {
2834 {
2837 }
2839 }
2841 /* toggle displaying of pin/pad/via names */
2843 {
2850 {
2853 {
2856 else
2860 }
2861 END_LOOP;
2863 {
2866 else
2870 }
2871 END_LOOP;
2880 else
2892 else
2903 else
2911 }
2913 }
2916 }
2917 }
2919 {
2921 {
2924 {
2929 }
2935 }
2936 }
2942 }
2944 /* --------------------------------------------------------------------------- */
2954 /* %start-doc actions Mode
2956 @table @code
2958 @item Arc
2959 @itemx Arrow
2960 @itemx Copy
2961 @itemx InsertPoint
2962 @itemx Line
2963 @itemx Lock
2964 @itemx Move
2965 @itemx None
2966 @itemx PasteBuffer
2967 @itemx Polygon
2968 @itemx Rectangle
2969 @itemx Remove
2970 @itemx Rotate
2971 @itemx Text
2972 @itemx Thermal
2973 @itemx Via
2974 Select the indicated tool.
2976 @item Notify
2977 Called when you press the mouse button, or move the mouse.
2979 @item Release
2980 Called when you release the mouse button.
2982 @item Cancel
2983 Cancels any pending tool activity, allowing you to restart elsewhere.
2984 For example, this allows you to start a new line rather than attach a
2985 line to the previous line.
2987 @item Escape
2988 Similar to Cancel but calling this action a second time will return
2989 to the Arrow tool.
2991 @item Stroke
2992 If your @code{pcb} was built with libstroke, this invokes the stroke
2993 input method. If not, this will restart a drawing mode if you were
2994 drawing, else it will select objects.
2996 @item Save
2997 Remembers the current tool.
2999 @item Restore
3000 Restores the tool to the last saved tool.
3002 @end table
3004 %end-doc */
3006 static int
3008 {
3012 {
3017 {
3043 {
3047 }
3050 {
3052 {
3071 else
3072 {
3075 }
3081 else
3082 {
3085 }
3091 else
3092 {
3095 }
3101 else
3102 {
3105 }
3111 else
3112 {
3115 }
3123 }
3124 }
3139 #ifndef HAVE_LIBSTROKE
3143 #else
3147 else
3150 #endif
3161 #ifdef HAVE_LIBSTROKE
3166 #else
3167 /* Handle middle mouse button restarts of drawing mode. If not in
3168 | a drawing mode, middle mouse button will select objects.
3169 */
3172 {
3174 }
3184 else
3185 {
3190 }
3192 #endif
3210 }
3213 }
3216 }
3218 /* --------------------------------------------------------------------------- */
3224 /* %start-doc actions RemoveSelected
3226 %end-doc */
3228 static int
3230 {
3234 }
3236 /* --------------------------------------------------------------------------- */
3245 /* %start-doc actions Renumber
3247 %end-doc */
3249 static int
3251 {
3263 struct _cnt_list
3264 {
3274 {
3275 /*
3276 * We deal with the case where name already exists in this
3277 * function so the GUI doesn't need to deal with it
3278 */
3287 }
3288 else
3292 {
3295 }
3298 {
3300 }
3303 {
3306 {
3310 }
3311 }
3314 {
3319 }
3327 /*
3328 * Make a first pass through all of the elements and sort them out
3329 * by location on the board. While here we also collect a list of
3330 * locked elements.
3331 *
3332 * We'll actually renumber things in the 2nd pass.
3333 */
3340 {
3343 }
3349 {
3351 {
3352 /*
3353 * add to the list of locked elements which we won't try to
3354 * renumber and whose reference designators are now reserved.
3355 */
3360 lock_cnt++;
3361 }
3363 else
3364 {
3365 /* count of devices which will be renumbered */
3366 cnt++;
3368 /* search for correct position in the list */
3371 i++;
3373 /*
3374 * We have found the position where we have the first element that
3375 * has the same Y value or a lower Y value. Now move forward if
3376 * needed through the X values
3377 */
3381 i++;
3384 {
3386 }
3388 }
3389 }
3390 END_LOOP;
3393 /*
3394 * Now that the elements are sorted by board position, we go through
3395 * and renumber them.
3396 */
3398 /*
3399 * turn off the flag which requires unique names so it doesn't get
3400 * in our way. When we're done with the renumber we will have unique
3401 * names.
3402 */
3408 {
3409 /* If there is no refdes, maybe just spit out a warning */
3411 {
3412 /* figure out the prefix */
3417 j++;
3420 /* check the counter for this prefix */
3425 /* grow the list if needed */
3427 {
3431 {
3434 }
3435 /* zero out the memory that we added */
3437 {
3440 }
3441 }
3443 /*
3444 * start a new counter if we don't have a counter for this
3445 * prefix
3446 */
3448 {
3451 }
3453 /*
3454 * check to see if the new refdes is already used by a
3455 * locked element
3456 */
3457 do
3458 {
3463 /* space for the prefix plus 1 digit plus the '\0' */
3466 /* and 1 more per extra digit needed to hold the number */
3469 {
3470 sz++;
3472 }
3476 /*
3477 * now compare to the list of reserved (by locked
3478 * elements) names
3479 */
3481 {
3485 {
3488 }
3489 }
3491 }
3495 {
3499 /* add this rename to our table of renames so we can update the netlist */
3502 c_cnt++;
3510 tmps);
3513 /* we don't free tmps in this case because it is used */
3514 }
3515 else
3517 }
3518 else
3519 {
3522 }
3524 }
3528 /* restore the unique flag setting */
3533 {
3535 /* update the netlist */
3538 /* iterate over each net */
3540 {
3542 /* iterate over each pin on the net */
3544 {
3546 /* figure out the pin number part from strings like U3-21 */
3552 /* iterate over the list of changed reference designators */
3554 {
3555 /*
3556 * if the pin needs to change, change it and quit
3557 * searching in the list.
3558 */
3560 {
3568 }
3570 }
3572 }
3573 }
3575 {
3578 }
3583 }
3589 }
3592 /* --------------------------------------------------------------------------- */
3599 /* %start-doc actions RipUp
3601 @table @code
3603 @item All
3604 Removes all lines and vias which were created by the autorouter.
3606 @item Selected
3607 Removes all selected lines and vias which were created by the
3608 autorouter.
3610 @item Element
3611 Converts the element under the cursor to parts (vias and lines). Note
3612 that this uses the highest numbered paste buffer.
3614 @end table
3616 %end-doc */
3618 static int
3620 {
3625 {
3627 {
3630 {
3632 {
3635 }
3636 }
3637 ENDALL_LOOP;
3639 {
3641 {
3644 }
3645 }
3646 ENDALL_LOOP;
3648 {
3650 {
3653 }
3654 }
3655 END_LOOP;
3658 {
3661 }
3665 {
3668 {
3671 }
3672 }
3673 ENDALL_LOOP;
3676 {
3679 {
3682 }
3683 }
3684 END_LOOP;
3686 {
3689 }
3692 {
3697 {
3713 }
3714 }
3716 }
3717 }
3719 }
3721 /* --------------------------------------------------------------------------- */
3728 /* %start-doc actions AddRats
3730 @table @code
3732 @item AllRats
3733 Create rat lines for all loaded nets that aren't already connected on
3734 with copper.
3736 @item SelectedRats
3737 Similarly, but only add rat lines for nets connected to selected pins
3738 and pads.
3740 @item Close
3741 Selects the shortest unselected rat on the board.
3743 @end table
3745 %end-doc */
3747 static int
3749 {
3755 {
3759 {
3773 {
3779 {
3782 }
3783 }
3784 END_LOOP;
3786 {
3793 }
3795 }
3796 }
3798 }
3800 /* --------------------------------------------------------------------------- */
3808 /* %start-doc actions Delete
3810 %end-doc */
3812 static int
3814 {
3822 {
3825 }
3828 {
3846 }
3849 }
3851 /* --------------------------------------------------------------------------- */
3858 /* %start-doc actions DeleteRats
3860 %end-doc */
3862 static int
3864 {
3867 {
3871 {
3881 }
3882 }
3884 }
3886 /* --------------------------------------------------------------------------- */
3892 /* %start-doc actions AutoPlaceSelected
3894 Attempts to re-arrange the selected components such that the nets
3895 connecting them are minimized. Note that you cannot undo this.
3897 %end-doc */
3899 static int
3901 {
3905 {
3908 }
3910 }
3912 /* --------------------------------------------------------------------------- */
3918 /* %start-doc actions AutoRoute
3920 @table @code
3922 @item AllRats
3923 Attempt to autoroute all rats.
3925 @item SelectedRats
3926 Attempt to autoroute the selected rats.
3928 @end table
3930 Before autorouting, it's important to set up a few things. First,
3931 make sure any layers you aren't using are disabled, else the
3932 autorouter may use them. Next, make sure the current line and via
3933 styles are set accordingly. Last, make sure "new lines clear
3934 polygons" is set, in case you eventually want to add a copper pour.
3936 Autorouting takes a while. During this time, the program may not be
3937 responsive.
3939 %end-doc */
3941 static int
3943 {
3947 {
3949 {
3959 }
3960 }
3962 }
3964 /* --------------------------------------------------------------------------- */
3972 /* %start-doc actions MarkCrosshair
3974 The ``mark'' is a small X-shaped target on the display which is
3975 treated like a second origin (the normal origin is the upper let
3976 corner of the board). The GUI will display a second set of
3977 coordinates for this mark, which tells you how far you are from it.
3979 If no argument is given, the mark is toggled - disabled if it was
3980 enabled, or enabled at the current cursor position of disabled. If
3981 the @code{Center} argument is given, the mark is moved to the current
3982 cursor location.
3984 %end-doc */
3986 static int
3988 {
3991 {
3993 {
3997 }
3998 else
3999 {
4006 }
4007 }
4009 {
4015 }
4017 }
4019 /* --------------------------------------------------------------------------- */
4030 /* %start-doc actions ChangeSize
4032 For lines and arcs, this changes the width. For pins and vias, this
4033 changes the overall diameter of the copper annulus. For pads, this
4034 changes the width and, indirectly, the length. For texts and names,
4035 this changes the scaling factor. For elements, this changes the width
4036 of the silk layer lines and arcs for this element.
4038 %end-doc */
4040 static int
4042 {
4047 Coord value;
4050 {
4056 {
4058 {
4070 }
4117 }
4118 }
4120 }
4122 /* --------------------------------------------------------------------------- */
4131 /* %start-doc actions ChangeDrillSize
4133 %end-doc */
4135 static int
4137 {
4142 Coord value;
4145 {
4148 {
4150 {
4162 }
4178 }
4179 }
4181 }
4183 /* --------------------------------------------------------------------------- */
4194 /* %start-doc actions ChangeClearSize
4196 If the solder mask is currently showing, this action changes the
4197 solder mask clearance. If the mask is not showing, this action
4198 changes the polygon clearance.
4200 %end-doc */
4202 static int
4204 {
4209 Coord value;
4212 {
4218 {
4220 {
4232 }
4258 }
4259 }
4261 }
4263 /* --------------------------------------------------------------------------- */
4272 /* %start-doc actions MinMaskGap
4274 Checks all specified pins and/or pads, and increases the mask if
4275 needed to ensure a minimum distance between the pin or pad edge and
4276 the mask edge.
4278 %end-doc */
4280 static int
4282 {
4287 Coord value;
4294 else
4295 {
4299 }
4304 {
4306 {
4310 {
4314 }
4315 }
4316 END_LOOP;
4318 {
4322 {
4326 }
4327 }
4328 END_LOOP;
4329 }
4330 END_LOOP;
4332 {
4336 {
4339 }
4340 }
4341 END_LOOP;
4345 }
4347 /* --------------------------------------------------------------------------- */
4356 /* %start-doc actions MinClearGap
4358 Checks all specified objects, and increases the polygon clearance if
4359 needed to ensure a minimum distance between their edges and the
4360 polygon edges.
4362 %end-doc */
4364 static int
4366 {
4371 Coord value;
4378 else
4379 {
4383 }
4388 {
4390 {
4394 {
4398 }
4399 }
4400 END_LOOP;
4402 {
4406 {
4410 }
4411 }
4412 END_LOOP;
4413 }
4414 END_LOOP;
4416 {
4420 {
4423 }
4424 }
4425 END_LOOP;
4427 {
4431 {
4434 }
4435 }
4436 ENDALL_LOOP;
4438 {
4442 {
4445 }
4446 }
4447 ENDALL_LOOP;
4451 }
4453 /* --------------------------------------------------------------------------- */
4461 /* %start-doc actions ChangePinName
4463 This can be especially useful for annotating pin names from a
4464 schematic to the layout without requiring knowledge of the pcb file
4465 format.
4467 @example
4468 ChangePinName(U3, 7, VCC)
4469 @end example
4471 %end-doc */
4473 static int
4475 {
4480 {
4482 }
4489 {
4491 {
4493 {
4495 {
4498 /*
4499 * Note: we can't free() pin->Name first because
4500 * it is used in the undo list
4501 */
4505 }
4506 }
4507 END_LOOP;
4510 {
4512 {
4515 /*
4516 * Note: we can't free() pad->Name first because
4517 * it is used in the undo list
4518 */
4522 }
4523 }
4524 END_LOOP;
4525 }
4526 }
4527 END_LOOP;
4528 /*
4529 * done with our action so increment the undo # if we actually
4530 * changed anything
4531 */
4533 {
4536 else
4537 {
4540 }
4541 }
4544 }
4546 /* --------------------------------------------------------------------------- */
4554 /* %start-doc actions ChangeName
4556 @table @code
4558 @item Object
4559 Changes the name of the element under the cursor.
4561 @item Layout
4562 Changes the name of the layout. This is printed on the fab drawings.
4564 @item Layer
4565 Changes the name of the currently active layer.
4567 @end table
4569 %end-doc */
4571 int
4573 {
4578 {
4580 {
4581 /* change the name of an object */
4583 {
4591 {
4594 {
4597 {
4607 {
4613 }
4616 }
4617 }
4618 }
4620 }
4622 /* change the layout's name */
4624 name =
4626 /* NB: ChangeLayoutName takes ownership of the passed memory */
4631 /* change the name of the active layer */
4635 /* NB: ChangeLayerName takes ownership of the passed memory */
4639 }
4640 }
4642 }
4645 /* --------------------------------------------------------------------------- */
4652 /* %start-doc actions MorphPolygon
4654 If a polygon is divided into unconnected "islands", you can use
4655 this command to convert the otherwise disappeared islands into
4656 separate polygons. Be sure the cursor is over a portion of the
4657 polygon that remains visible. Very small islands that may flake
4658 off are automatically deleted.
4660 %end-doc */
4662 static int
4664 {
4667 {
4669 {
4671 {
4678 {
4682 }
4684 }
4688 {
4691 }
4692 ENDALL_LOOP;
4696 }
4697 }
4699 }
4701 /* --------------------------------------------------------------------------- */
4709 /* %start-doc actions ToggleHideName
4711 If names are hidden you won't see them on the screen and they will not
4712 appear on the silk layer when you print the layout.
4714 %end-doc */
4716 static int
4718 {
4721 {
4723 {
4725 {
4732 {
4739 }
4741 }
4744 {
4747 {
4752 {
4759 }
4760 }
4761 END_LOOP;
4763 {
4766 }
4767 }
4768 }
4769 }
4771 }
4773 /* --------------------------------------------------------------------------- */
4781 /* %start-doc actions ChangeJoin
4783 The join flag determines whether a line or arc, drawn to intersect a
4784 polygon, electrically connects to the polygon or not. When joined,
4785 the line/arc is simply drawn over the polygon, making an electrical
4786 connection. When not joined, a gap is drawn between the line and the
4787 polygon, insulating them from each other.
4789 %end-doc */
4791 static int
4793 {
4796 {
4798 {
4801 {
4812 }
4829 }
4830 }
4832 }
4834 /* --------------------------------------------------------------------------- */
4844 /* %start-doc actions ChangeSquare
4846 Note that @code{Pins} means both pins and pads.
4848 @pinshapes
4850 %end-doc */
4852 static int
4854 {
4857 {
4859 {
4862 {
4873 }
4890 }
4891 }
4893 }
4895 /* --------------------------------------------------------------------------- */
4902 /* %start-doc actions SetSquare
4904 Note that @code{Pins} means pins and pads.
4906 @pinshapes
4908 %end-doc */
4910 static int
4912 {
4915 {
4917 {
4920 {
4931 }
4948 }
4949 }
4951 }
4953 /* --------------------------------------------------------------------------- */
4961 /* %start-doc actions ClearSquare
4963 Note that @code{Pins} means pins and pads.
4965 @pinshapes
4967 %end-doc */
4969 static int
4971 {
4974 {
4976 {
4979 {
4990 }
5007 }
5008 }
5010 }
5012 /* --------------------------------------------------------------------------- */
5021 /* %start-doc actions ChangeOctagon
5023 @pinshapes
5025 %end-doc */
5027 static int
5029 {
5032 {
5034 {
5037 {
5048 }
5070 }
5071 }
5073 }
5075 /* --------------------------------------------------------------------------- */
5082 /* %start-doc actions SetOctagon
5084 @pinshapes
5086 %end-doc */
5088 static int
5090 {
5093 {
5095 {
5098 {
5109 }
5131 }
5132 }
5134 }
5136 /* --------------------------------------------------------------------------- */
5145 /* %start-doc actions ClearOctagon
5147 @pinshapes
5149 %end-doc */
5151 static int
5153 {
5156 {
5158 {
5161 {
5172 }
5194 }
5195 }
5197 }
5199 /* --------------------------------------------------------------------------- */
5206 /* %start-doc actions ChangeHole
5208 The "hole flag" of a via determines whether the via is a
5209 plated-through hole (not set), or an unplated hole (set).
5211 %end-doc */
5213 static int
5215 {
5218 {
5220 {
5223 {
5233 }
5240 }
5241 }
5243 }
5245 /* --------------------------------------------------------------------------- */
5253 /* %start-doc actions ChangePaste
5255 The "no paste flag" of a pad determines whether the solderpaste
5256 stencil will have an opening for the pad (no set) or if there wil be
5257 no solderpaste on the pad (set). This is used for things such as
5258 fiducial pads.
5260 %end-doc */
5262 static int
5264 {
5267 {
5269 {
5272 {
5282 }
5289 }
5290 }
5292 }
5294 /* --------------------------------------------------------------------------- */
5307 /* %start-doc actions Select
5309 @table @code
5311 @item ElementByName
5312 @item ObjectByName
5313 @item PadByName
5314 @item PinByName
5315 @item TextByName
5316 @item ViaByName
5317 @item NetByName
5319 These all rely on having a regular expression parser built into
5320 @code{pcb}. If the name is not specified then the user is prompted
5321 for a pattern, and all objects that match the pattern and are of the
5322 type specified are selected.
5324 @item Object
5325 @item ToggleObject
5326 Selects the object under the cursor.
5328 @item Block
5329 Selects all objects in a rectangle indicated by the cursor.
5331 @item All
5332 Selects all objects on the board.
5334 @item Found
5335 Selects all connections with the ``found'' flag set.
5337 @item Connection
5338 Selects all connections with the ``connected'' flag set.
5340 @item Convert
5341 Converts the selected objects to an element. This uses the highest
5342 numbered paste buffer.
5344 @end table
5346 %end-doc */
5348 static int
5350 {
5353 {
5355 {
5356 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5358 /* select objects by their names */
5381 commonByName:
5382 {
5388 {
5393 }
5395 }
5398 /* select a single object */
5405 /* all objects in block */
5407 {
5408 BoxType box;
5422 {
5425 }
5428 }
5430 /* select all visible objects */
5432 {
5433 BoxType box;
5442 }
5444 /* all logical connections */
5447 {
5451 }
5454 /* all physical connections */
5457 {
5461 }
5465 {
5480 }
5486 }
5487 }
5489 }
5491 /* FLAG(have_regex,FlagHaveRegex,0) */
5492 int
5494 {
5495 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5497 #else
5499 #endif
5500 }
5502 /* --------------------------------------------------------------------------- */
5514 /* %start-doc actions Unselect
5516 @table @code
5518 @item All
5519 Unselect all objects.
5521 @item Block
5522 Unselect all objects in a rectangle given by the cursor.
5524 @item Connection
5525 Unselect all connections with the ``found'' flag set.
5527 @item ElementByName
5528 @item ObjectByName
5529 @item PadByName
5530 @item PinByName
5531 @item TextByName
5532 @item ViaByName
5534 These all rely on having a regular expression parser built into
5535 @code{pcb}. If the name is not specified then the user is prompted
5536 for a pattern, and all objects that match the pattern and are of the
5537 type specified are unselected.
5540 @end table
5542 %end-doc */
5544 static int
5546 {
5549 {
5551 {
5552 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5554 /* select objects by their names */
5577 commonByName:
5578 {
5584 {
5589 }
5591 }
5594 /* all objects in block */
5596 {
5597 BoxType box;
5611 {
5614 }
5617 }
5619 /* unselect all visible objects */
5621 {
5622 BoxType box;
5631 }
5633 /* all logical connections */
5636 {
5640 }
5643 /* all physical connections */
5646 {
5650 }
5657 }
5658 }
5660 }
5662 /* --------------------------------------------------------------------------- */
5671 /* %start-doc actions SaveTo
5673 @table @code
5675 @item Layout
5676 Saves the current layout.
5678 @item LayoutAs
5679 Saves the current layout, and remembers the filename used.
5681 @item AllConnections
5682 Save all connections to a file.
5684 @item AllUnusedPins
5685 List all unused pins to a file.
5687 @item ElementConnections
5688 Save connections to the element at the cursor to a file.
5690 @item PasteBuffer
5691 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5693 @end table
5695 %end-doc */
5697 static int
5699 {
5707 {
5711 }
5717 {
5719 {
5725 }
5727 }
5730 {
5734 {
5738 }
5740 }
5743 {
5747 {
5751 }
5753 }
5756 {
5764 {
5768 {
5772 }
5773 }
5775 }
5778 {
5780 }
5783 }
5785 /* --------------------------------------------------------------------------- */
5793 /* %start-doc actions SaveSettings
5795 If you pass no arguments, the settings are stored in
5796 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5797 saved in @code{./pcb.settings}.
5799 %end-doc */
5801 static int
5803 {
5807 }
5809 /* --------------------------------------------------------------------------- */
5816 /* %start-doc actions LoadFrom
5818 This action assumes you know what the filename is. The various GUIs
5819 should have a similar @code{Load} action where the filename is
5820 optional, and will provide their own file selection mechanism to let
5821 you choose the file name.
5823 @table @code
5825 @item Layout
5826 Loads an entire PCB layout, replacing the current one.
5828 @item LayoutToBuffer
5829 Loads an entire PCB layout to the paste buffer.
5831 @item ElementToBuffer
5832 Loads the given element file into the paste buffer. Element files
5833 contain only a single @code{Element} definition, such as the
5834 ``newlib'' library uses.
5836 @item Netlist
5837 Loads a new netlist, replacing any current netlist.
5839 @item Revert
5840 Re-loads the current layout from its disk file, reverting any changes
5841 you may have made.
5843 @end table
5845 %end-doc */
5847 static int
5849 {
5860 {
5865 }
5868 {
5873 }
5876 {
5880 }
5883 {
5890 }
5894 {
5896 }
5899 }
5901 /* --------------------------------------------------------------------------- */
5907 /* %start-doc actions New
5909 If a name is not given, one is prompted for.
5911 %end-doc */
5913 static int
5915 {
5919 {
5922 else
5929 /* do emergency saving
5930 * clear the old struct and allocate memory for the new one
5931 */
5939 /* setup the new name and reset some values to default */
5951 }
5953 }
5955 /* ---------------------------------------------------------------------------
5956 * no operation, just for testing purposes
5957 * syntax: Bell(volume)
5958 */
5959 void
5961 {
5963 }
5965 /* --------------------------------------------------------------------------- */
5976 /* %start-doc actions PasteBuffer
5978 There are a number of paste buffers; the actual limit is a
5979 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5980 is currently @code{5}. One of these is the ``current'' paste buffer,
5981 often referred to as ``the'' paste buffer.
5983 @table @code
5985 @item AddSelected
5986 Copies the selected objects to the current paste buffer.
5988 @item Clear
5989 Remove all objects from the current paste buffer.
5991 @item Convert
5992 Convert the current paste buffer to an element. Vias are converted to
5993 pins, lines are converted to pads.
5995 @item Restore
5996 Convert any elements in the paste buffer back to vias and lines.
5998 @item Mirror
5999 Flip all objects in the paste buffer vertically (up/down flip). To mirror
6000 horizontally, combine this with rotations.
6002 @item Rotate
6003 Rotates the current buffer. The number to pass is 1..3, where 1 means
6004 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6005 degrees clockwise (270 CCW).
6007 @item Save
6008 Saves any elements in the current buffer to the indicated file.
6010 @item ToLayout
6011 Pastes any elements in the current buffer to the indicated X, Y
6012 coordinates in the layout. The @code{X} and @code{Y} are treated like
6013 @code{delta} is for many other objects. For each, if it's prefixed by
6014 @code{+} or @code{-}, then that amount is relative to the last
6015 location. Otherwise, it's absolute. Units can be
6016 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6017 units, currently 1/100 mil.
6020 @item 1..MAX_BUFFER
6021 Selects the given buffer to be the current paste buffer.
6023 @end table
6025 %end-doc */
6027 static int
6029 {
6038 {
6040 {
6041 /* clear contents of paste buffer */
6046 /* copies objects to paste buffer */
6051 /* converts buffer contents into an element */
6056 /* break up element for editing */
6061 /* Mirror buffer */
6068 {
6071 }
6076 {
6079 }
6082 {
6090 {
6093 }
6095 {
6097 }
6099 }
6101 else
6104 {
6108 {
6113 }
6114 else
6119 }
6123 {
6129 {
6131 }
6133 {
6140 }
6141 else
6142 {
6145 }
6151 }
6154 /* set number */
6156 {
6159 /* correct number */
6162 }
6163 }
6164 }
6168 }
6170 /* --------------------------------------------------------------------------- */
6177 /* %start-doc actions Undo
6179 The unlimited undo feature of @code{Pcb} allows you to recover from
6180 most operations that materially affect you work. Calling
6181 @code{Undo()} without any parameter recovers from the last (non-undo)
6182 operation. @code{ClearList} is used to release the allocated
6183 memory. @code{ClearList} is called whenever a new layout is started or
6184 loaded. See also @code{Redo} and @code{Atomic}.
6186 Note that undo groups operations by serial number; changes with the
6187 same serial number will be undone (or redone) as a group. See
6188 @code{Atomic}.
6190 %end-doc */
6192 static int
6194 {
6197 {
6198 /* don't allow undo in the middle of an operation */
6205 /* undo the last operation */
6211 {
6215 }
6216 /* move anchor point if undoing during line creation */
6218 {
6220 {
6227 }
6229 {
6233 /* this search is guaranteed to succeed */
6240 /* save both ends of line */
6245 /* check that the undo was of the right type */
6247 {
6248 /* wrong undo type, restore anchor points */
6255 }
6256 /* move to new anchor */
6261 /* check if an intermediate point was removed */
6263 {
6264 /* this search should find the restored line */
6272 {
6273 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6277 }
6282 }
6286 {
6289 }
6290 else
6291 {
6292 /* this search is guaranteed to succeed too */
6300 }
6303 }
6304 }
6306 {
6308 {
6312 }
6314 {
6317 /* guaranteed to succeed */
6329 }
6330 }
6331 /* undo the last destructive operation */
6334 }
6336 {
6338 {
6339 /* clear 'undo objects' list */
6343 }
6344 }
6347 }
6349 /* --------------------------------------------------------------------------- */
6355 /* %start-doc actions Redo
6357 This routine allows you to recover from the last undo command. You
6358 might want to do this if you thought that undo was going to revert
6359 something other than what it actually did (in case you are confused
6360 about which operations are un-doable), or if you have been backing up
6361 through a long undo list and over-shoot your stopping point. Any
6362 change that is made since the undo in question will trim the redo
6363 list. For example if you add ten lines, then undo three of them you
6364 could use redo to put them back, but if you move a line on the board
6365 before performing the redo, you will lose the ability to "redo" the
6366 three "undone" lines.
6368 %end-doc */
6370 static int
6372 {
6380 {
6384 {
6390 addedLines++;
6391 }
6392 }
6395 }
6397 /* --------------------------------------------------------------------------- */
6403 /* %start-doc actions Polygon
6405 Polygons need a special action routine to make life easier.
6407 @table @code
6409 @item Close
6410 Creates the final segment of the polygon. This may fail if clipping
6411 to 45 degree lines is switched on, in which case a warning is issued.
6413 @item PreviousPoint
6414 Resets the newly entered corner to the previous one. The Undo action
6415 will call Polygon(PreviousPoint) when appropriate to do so.
6417 @end table
6419 %end-doc */
6421 static int
6423 {
6426 {
6429 {
6430 /* close open polygon if possible */
6435 /* go back to the previous point */
6439 }
6441 }
6443 }
6445 /* --------------------------------------------------------------------------- */
6452 /* %start-doc actions RouteStyle
6454 %end-doc */
6456 static int
6458 {
6464 {
6467 {
6474 }
6475 }
6477 }
6480 /* --------------------------------------------------------------------------- */
6487 /* %start-doc actions MoveObject
6489 The @code{X} and @code{Y} are treated like @code{delta} is for many
6490 other objects. For each, if it's prefixed by @code{+} or @code{-},
6491 then that amount is relative. Otherwise, it's absolute. Units can be
6492 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6493 units, currently 1/100 mil.
6495 %end-doc */
6497 static int
6499 {
6513 {
6516 }
6529 }
6531 /* --------------------------------------------------------------------------- */
6539 /* %start-doc actions MoveToCurrentLayer
6541 Note that moving an element from a component layer to a solder layer,
6542 or from solder to component, won't automatically flip it. Use the
6543 @code{Flip()} action to do that.
6545 %end-doc */
6547 static int
6549 {
6552 {
6554 {
6556 {
6567 }
6574 }
6575 }
6577 }
6585 /* %start-doc actions SetSame
6587 When invoked over any line, arc, polygon, or via, this changes the
6588 current layer to be the layer that item is on, and changes the current
6589 sizes (thickness, keepaway, drill, etc) according to that item.
6591 %end-doc */
6593 static int
6595 {
6601 /* set layer current and size from line or arc */
6603 {
6643 }
6645 {
6648 }
6650 }
6653 /* --------------------------------------------------------------------------- */
6664 /* %start-doc actions SetFlag
6666 Turns the given flag on, regardless of its previous setting. See
6667 @code{ChangeFlag}.
6669 @example
6670 SetFlag(SelectedPins,thermal)
6671 @end example
6673 %end-doc */
6675 static int
6677 {
6682 }
6684 /* --------------------------------------------------------------------------- */
6695 /* %start-doc actions ClrFlag
6697 Turns the given flag off, regardless of its previous setting. See
6698 @code{ChangeFlag}.
6700 @example
6701 ClrFlag(SelectedLines,join)
6702 @end example
6704 %end-doc */
6706 static int
6708 {
6713 }
6715 /* --------------------------------------------------------------------------- */
6727 /* %start-doc actions ChangeFlag
6729 Toggles the given flag on the indicated object(s). The flag may be
6730 one of the flags listed above (square, octagon, thermal, join). The
6731 value may be the number 0 or 1. If the value is 0, the flag is
6732 cleared. If the value is 1, the flag is set.
6734 %end-doc */
6736 static int
6738 {
6747 }
6750 static void
6752 {
6757 {
6760 }
6762 {
6765 }
6767 {
6768 /* Note: these are backwards, because the flag is "clear" but
6769 the command is "join". */
6772 }
6773 else
6774 {
6777 }
6780 {
6782 {
6794 }
6836 }
6837 }
6839 /* --------------------------------------------------------------------------- */
6845 /* %start-doc actions ExecuteFile
6847 Lines starting with @code{#} are ignored.
6849 %end-doc */
6851 static int
6853 {
6866 {
6869 }
6874 {
6875 n++;
6878 /* eat the trailing newline */
6880 sp++;
6883 /* eat leading spaces and tabs */
6886 sp++;
6888 /*
6889 * if we have anything left and its not a comment line
6890 * then execute it
6891 */
6894 {
6895 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6897 }
6898 }
6902 {
6905 }
6908 }
6910 /* --------------------------------------------------------------------------- */
6912 static int
6914 {
6918 }
6920 /* --------------------------------------------------------------------------- */
6926 {
6933 {
6936 {
6939 }
6940 }
6941 END_LOOP;
6943 }
6947 {
6953 }
6955 static void
6957 {
6964 }
6966 /* ---------------------------------------------------------------- */
6973 /* %start-doc actions elementlist
6975 @table @code
6977 @item Start
6978 Indicates the start of an element list; call this before any Need
6979 actions.
6981 @item Need
6982 Searches the board for an element with a matching refdes.
6984 If found, the value and footprint are updated.
6986 If not found, a new element is created with the given footprint and value.
6988 @item Done
6989 Compares the list of elements needed since the most recent
6990 @code{start} with the list of elements actually on the board. Any
6991 elements that weren't listed are selected, so that the user may delete
6992 them.
6994 @end table
6996 %end-doc */
7000 static int
7002 {
7007 }
7009 static int
7011 {
7017 #ifdef DEBUG
7019 #endif
7022 {
7024 {
7026 }
7027 END_LOOP;
7031 }
7034 {
7036 {
7038 {
7040 }
7042 {
7043 /* Unnamed elements should remain untouched */
7045 }
7046 }
7047 END_LOOP;
7053 }
7061 argc --;
7062 argv ++;
7072 #ifdef DEBUG
7076 #endif
7081 {
7084 #ifdef DEBUG
7086 #endif
7087 /* Not on board, need to add it. */
7089 {
7090 number_of_footprints_not_found ++;
7092 }
7103 {
7106 }
7117 /* Place components onto center of board. */
7120 }
7123 {
7124 #ifdef DEBUG
7126 #endif
7131 /* Different footprint, we need to swap them out. */
7133 {
7134 number_of_footprints_not_found ++;
7136 }
7151 {
7156 }
7162 }
7164 /* Now reload footprint */
7177 #ifdef DEBUG
7179 #endif
7182 }
7184 /* ---------------------------------------------------------------- */
7191 /* %start-doc actions elementsetattr
7193 If a value is specified, the named attribute is added (if not already
7194 present) or changed (if it is) to the given value. If the value is
7195 not specified, the given attribute is removed if present.
7197 %end-doc */
7199 static int
7201 {
7207 {
7209 }
7216 {
7218 {
7221 }
7222 }
7223 END_LOOP;
7226 {
7229 }
7234 {
7237 }
7239 {
7241 }
7243 {
7245 }
7248 }
7250 /* ---------------------------------------------------------------- */
7255 /* %start-doc actions execcommand
7257 Runs the given command, which is a system executable.
7259 %end-doc */
7261 static int
7263 {
7267 {
7269 }
7276 }
7278 /* ---------------------------------------------------------------- */
7280 static int
7282 {
7283 #ifdef HAVE__SPAWNVP
7287 else
7289 #else
7293 {
7294 /* error */
7297 }
7299 {
7300 /* Child */
7303 }
7304 else
7305 {
7307 /* Parent */
7309 }
7311 #endif
7312 }
7314 /* ---------------------------------------------------------------- */
7315 /*
7316 * Creates a new temporary file name. Hopefully the operating system
7317 * provides a mkdtemp() function to securily create a temporary
7318 * directory with mode 0700. If so then that directory is created and
7319 * the returned string is made up of the directory plus the name
7320 * variable. For example:
7321 *
7322 * tempfile_name_new ("myfile") might return
7323 * "/var/tmp/pcb.123456/myfile".
7324 *
7325 * If mkdtemp() is not available then 'name' is ignored and the
7326 * insecure tmpnam() function is used.
7327 *
7328 * Files/names created with tempfile_name_new() should be unlinked
7329 * with tempfile_unlink to make sure the temporary directory is also
7330 * removed when mkdtemp() is used.
7331 */
7334 {
7336 #ifdef HAVE_MKDTEMP
7339 #endif
7343 #ifdef HAVE_MKDTEMP
7349 /* FIXME -- what about win32? */
7352 }
7362 }
7372 }
7379 ;
7389 #undef TEMPLATE
7390 #else
7391 /*
7392 * tmpnam() uses a static buffer so strdup() the result right away
7393 * in case someone decides to create multiple temp names.
7394 */
7396 #ifdef __WIN32__
7397 {
7398 /* Guile doesn't like \ separators */
7403 }
7404 #endif
7405 #endif
7408 }
7410 /* ---------------------------------------------------------------- */
7411 /*
7412 * Unlink a temporary file. If we have mkdtemp() then our temp file
7413 * lives in a temporary directory and we need to remove that directory
7414 * too.
7415 */
7416 static int
7418 {
7419 #ifdef DEBUG
7420 /* SDB says: Want to keep old temp files for examiniation when debugging */
7422 #endif
7424 #ifdef HAVE_MKDTEMP
7429 /* it is possible that the file was never created so it is OK if the
7430 unlink fails */
7432 /* now figure out the directory name to remove */
7439 /*
7440 * at this point, e *should* point to the end of the directory part
7441 * but lets make sure.
7442 */
7447 }
7451 __FUNCTION__);
7455 }
7457 /* name was allocated with malloc */
7461 /*
7462 * FIXME - should also return -1 if the temp file exists and was not
7463 * removed.
7464 */
7467 }
7469 #else
7476 }
7479 #endif
7482 }
7484 /* ---------------------------------------------------------------- */
7493 /* %start-doc actions Import
7495 Imports element and netlist data from the schematics (or some other
7496 source). The first parameter, which is optional, is the mode. If not
7497 specified, the @code{import::mode} attribute in the PCB is used.
7498 @code{gnetlist} means gnetlist is used to obtain the information from
7499 the schematics. @code{make} invokes @code{make}, assuming the user
7500 has a @code{Makefile} in the current directory. The @code{Makefile}
7501 will be invoked with the following variables set:
7503 @table @code
7505 @item PCB
7506 The name of the .pcb file
7508 @item SRCLIST
7509 A space-separated list of source files
7511 @item OUT
7512 The name of the file in which to put the command script, which may
7513 contain any @pcb{} actions. By default, this is a temporary file
7514 selected by @pcb{}, but if you specify an @code{import::outfile}
7515 attribute, that file name is used instead (and not automatically
7516 deleted afterwards).
7518 @end table
7520 The target specified to be built is the first of these that apply:
7522 @itemize @bullet
7524 @item
7525 The target specified by an @code{import::target} attribute.
7527 @item
7528 The output file specified by an @code{import::outfile} attribute.
7530 @item
7531 If nothing else is specified, the target is @code{pcb_import}.
7533 @end itemize
7535 If you specify an @code{import::makefile} attribute, then "-f <that
7536 file>" will be added to the command line.
7538 If you specify the mode, you may also specify the source files
7539 (schematics). If you do not specify any, the list of schematics is
7540 obtained by reading the @code{import::src@var{N}} attributes (like
7541 @code{import::src0}, @code{import::src1}, etc).
7543 For compatibility with future extensions to the import file format,
7544 the generated file @emph{must not} start with the two characters
7545 @code{#%}.
7547 If a temporary file is needed the @code{TMPDIR} environment variable
7548 is used to select its location.
7550 Note that the programs @code{gnetlist} and @code{make} may be
7551 overridden by the user via the @code{make-program} and @code{gnetlist}
7552 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7553 line).
7555 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7556 is called to let user choose (see @code{ImportGUI()}).
7558 Note that Import() doesn't delete anything - after an Import, elements
7559 which shouldn't be on the board are selected and may be removed once
7560 it's determined that the deletion is appropriate.
7562 If @code{Import()} is called with @code{setnewpoint}, then the location
7563 of new components can be specified. This is where parts show up when
7564 they're added to the board. The default is the center of the board.
7566 @table @code
7568 @item Import(setnewpoint)
7570 Prompts the user to click on the board somewhere, uses that point. If
7571 called by a hotkey, uses the current location of the crosshair.
7573 @item Import(setnewpoint,mark)
7575 Uses the location of the mark. If no mark is present, the point is
7576 not changed.
7578 @item Import(setnewpoint,center)
7580 Resets the point to the center of the board.
7582 @item Import(setnewpoint,X,Y,units)
7584 Sets the point to the specific coordinates given. Example:
7585 @code{Import(setnewpoint,50,25,mm)}
7587 @end table
7589 Note that the X and Y locations are stored in attributes named
7590 @code{import::newX} and @code{import::newY} so you could change them
7591 manually if you wished.
7593 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7594 placed elements are dispersed relative to the set point. For example,
7595 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7596 10mm away from the point. The default dispersion is 1/10th of the
7597 smallest board dimension. Dispersion is saved in the
7598 @code{import::disperse} attribute.
7600 %end-doc */
7602 static int
7604 {
7609 #ifdef DEBUG
7611 #endif
7616 {
7623 {
7626 }
7628 {
7631 }
7632 else
7637 }
7640 {
7650 {
7652 }
7654 {
7658 }
7660 {
7666 }
7668 {
7671 }
7672 else
7673 {
7676 }
7683 }
7691 {
7694 }
7697 {
7703 nsources ++;
7709 {
7713 nsources ++;
7718 }
7719 }
7722 {
7723 /* Replace .pcb with .sch and hope for the best. */
7745 {
7748 }
7754 }
7757 {
7765 }
7778 #ifdef DEBUG
7782 #endif
7785 {
7788 }
7790 #ifdef DEBUG
7791 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7792 #endif
7800 }
7802 {
7822 else
7823 {
7828 }
7830 }
7838 {
7842 }
7851 {
7854 }
7859 {
7866 }
7877 }
7878 else
7879 {
7882 }
7887 #ifdef DEBUG
7889 #endif
7892 }
7894 /* ------------------------------------------------------------ */
7904 /* %start-doc actions Attributes
7906 This just pops up a dialog letting the user edit the attributes of the
7907 pcb, an element, or a layer.
7909 %end-doc */
7912 static int
7914 {
7923 {
7926 }
7929 {
7931 {
7934 }
7937 {
7940 {
7945 {
7948 }
7950 {
7953 }
7954 }
7961 }
7964 {
7968 {
7970 {
7972 n_found ++;
7973 }
7974 }
7975 END_LOOP;
7977 {
7980 }
7982 {
7989 else
7990 {
7993 }
7994 }
7997 {
8001 }
8002 else
8003 {
8005 }
8009 }
8013 }
8016 }
8018 /* --------------------------------------------------------------------------- */
8020 HID_Action action_action_list[] = {
8023 ,
8026 ,
8029 ,
8032 ,
8035 ,
8038 ,
8041 ,
8044 ,
8047 ,
8050 ,
8053 ,
8056 ,
8059 ,
8062 ,
8065 ,
8068 ,
8071 ,
8074 ,
8077 ,
8080 ,
8083 ,
8086 ,
8089 ,
8092 ,
8095 ,
8098 ,
8101 ,
8104 ,
8107 ,
8110 ,
8113 ,
8116 ,
8119 ,
8122 ,
8125 ,
8128 ,
8131 ,
8134 ,
8137 ,
8140 ,
8143 ,
8146 ,
8149 ,
8152 ,
8155 ,
8158 ,
8161 ,
8164 ,
8167 ,
8170 ,
8173 ,
8176 ,
8179 ,
8182 ,
8185 ,
8188 ,
8191 ,
8194 ,
8196 ,
8199 ,
8202 ,
8205 ,
8208 ,
8209 };