| blob | 1923cf975586bd761e84ffdd5fe5833761d7c90b |
1 /* 15 Oct 2008 Ineiev: add CycleCrosshair action */
3 /*
4 * COPYRIGHT
5 *
6 * PCB, interactive printed circuit board design
7 * Copyright (C) 1994,1995,1996 Thomas Nau
8 * Copyright (C) 1997, 1998, 1999, 2000, 2001 Harry Eaton
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 *
24 * Contact addresses for paper mail and Email:
25 * Harry Eaton, 6697 Buttonhole Ct, Columbia, MD 21044, USA
26 * haceaton@aplcomm.jhuapl.edu
27 *
28 */
30 /* action routines for output window
31 */
33 #ifdef HAVE_CONFIG_H
35 #endif
61 /*#include "print.h"*/
76 #include <assert.h>
79 #ifdef HAVE_LIBDMALLOC
80 #include <dmalloc.h>
81 #endif
83 /* for fork() and friends */
84 #ifdef HAVE_UNISTD_H
85 #include <unistd.h>
86 #endif
88 #ifdef HAVE_SYS_WAIT_H
89 #include <sys/wait.h>
90 #endif
92 /* ---------------------------------------------------------------------------
93 * some local types
94 */
96 {
97 F_AddSelected,
98 F_All,
99 F_AllConnections,
100 F_AllRats,
101 F_AllUnusedPins,
102 F_Arc,
103 F_Arrow,
104 F_Block,
105 F_Description,
106 F_Cancel,
107 F_Center,
108 F_Clear,
109 F_ClearAndRedraw,
110 F_ClearList,
111 F_Close,
112 F_Connection,
113 F_Convert,
114 F_Copy,
115 F_CycleClip,
116 F_CycleCrosshair,
117 F_DeleteRats,
118 F_Drag,
119 F_DrillReport,
120 F_Element,
121 F_ElementByName,
122 F_ElementConnections,
123 F_ElementToBuffer,
124 F_Escape,
125 F_Find,
126 F_FlipElement,
127 F_FoundPins,
128 F_Grid,
129 F_InsertPoint,
130 F_Layer,
131 F_Layout,
132 F_LayoutAs,
133 F_LayoutToBuffer,
134 F_Line,
135 F_LineSize,
136 F_Lock,
137 F_Mirror,
138 F_Move,
139 F_NameOnPCB,
140 F_Netlist,
141 F_NetByName,
142 F_None,
143 F_Notify,
144 F_Object,
145 F_ObjectByName,
146 F_PasteBuffer,
147 F_PadByName,
148 F_PinByName,
149 F_PinOrPadName,
150 F_Pinout,
151 F_Polygon,
152 F_PolygonHole,
153 F_PreviousPoint,
154 F_RatsNest,
155 F_Rectangle,
156 F_Redraw,
157 F_Release,
158 F_Revert,
159 F_Remove,
160 F_RemoveSelected,
161 F_Report,
162 F_Reset,
163 F_ResetLinesAndPolygons,
164 F_ResetPinsViasAndPads,
165 F_Restore,
166 F_Rotate,
167 F_Save,
168 F_Selected,
169 F_SelectedArcs,
170 F_SelectedElements,
171 F_SelectedLines,
172 F_SelectedNames,
173 F_SelectedObjects,
174 F_SelectedPads,
175 F_SelectedPins,
176 F_SelectedTexts,
177 F_SelectedVias,
178 F_SelectedRats,
179 F_Stroke,
180 F_Text,
181 F_TextByName,
182 F_TextScale,
183 F_Thermal,
184 F_ToLayout,
185 F_ToggleAllDirections,
186 F_ToggleAutoDRC,
187 F_ToggleClearLine,
188 F_ToggleFullPoly,
189 F_ToggleGrid,
190 F_ToggleHideNames,
191 F_ToggleMask,
192 F_ToggleName,
193 F_ToggleObject,
194 F_ToggleShowDRC,
195 F_ToggleLiveRoute,
196 F_ToggleRubberBandMode,
197 F_ToggleStartDirection,
198 F_ToggleSnapPin,
199 F_ToggleThindraw,
200 F_ToggleLockNames,
201 F_ToggleOnlyNames,
202 F_ToggleThindrawPoly,
203 F_ToggleOrthoMove,
204 F_ToggleLocalRef,
205 F_ToggleCheckPlanes,
206 F_ToggleUniqueNames,
207 F_Via,
208 F_ViaByName,
209 F_Value,
210 F_ViaDrillingHole,
211 F_ViaSize,
212 F_Zoom
213 }
214 FunctionID;
217 {
219 FunctionID ID;
220 }
223 /* --------------------------------------------------------------------------- */
225 /* %start-doc actions 00delta
227 Many actions take a @code{delta} parameter as the last parameter,
228 which is an amount to change something. That @code{delta} may include
229 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
230 If no units are specified, the default is PCB's native units
231 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
232 @code{-}, the size is increased or decreased by that amount.
233 Otherwise, the size size is set to the given amount.
235 @example
236 Action(Object,5,mil)
237 Action(Object,+0.5,mm)
238 Action(Object,-1)
239 @end example
241 Actions which take a @code{delta} parameter which do not accept all
242 these options will specify what they do take.
244 %end-doc */
246 /* %start-doc actions 00objects
248 Many actions act on indicated objects on the board. They will have
249 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
250 what group of objects they act on. Unless otherwise specified, these
251 parameters are defined as follows:
253 @table @code
255 @item Object
256 @itemx ToggleObject
257 Affects the object under the mouse pointer. If this action is invoked
258 from a menu or script, the user will be prompted to click on an
259 object, which is then the object affected.
261 @item Selected
262 @itemx SelectedObjects
264 Affects all objects which are currently selected. At least, all
265 selected objects for which the given action makes sense.
267 @item SelectedPins
268 @itemx SelectedVias
269 @itemx Selected@var{Type}
270 @itemx @i{etc}
271 Affects all objects which are both selected and of the @var{Type} specified.
273 @end table
275 %end-doc */
277 /* %start-doc actions 00macros
279 @macro pinshapes
281 Pins, pads, and vias can have various shapes. All may be round. Pins
282 and pads may be square (obviously "square" pads are usually
283 rectangular). Pins and vias may be octagonal. When you change a
284 shape flag of an element, you actually change all of its pins and
285 pads.
287 Note that the square flag takes precedence over the octagon flag,
288 thus, if both the square and octagon flags are set, the object is
289 square. When the square flag is cleared, the pins and pads will be
290 either round or, if the octagon flag is set, octagonal.
292 @end macro
294 %end-doc */
296 /* ---------------------------------------------------------------------------
297 * some local identifiers
298 */
301 static struct
302 {
303 PolygonTypePtr poly;
304 LineType line;
305 }
306 fake;
308 static struct
309 {
311 Cardinal Buffer;
318 }
319 Note;
326 #ifdef HAVE_LIBSTROKE
329 #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 }
546 {
550 /* XXX: PCB->MaxWidth and PCB->MaxHeight may be the wrong
551 * divisors below. The old code WAS broken, but this
552 * replacement has not been tested for correctness.
553 */
554 z =
558 z =
567 }
572 }
573 }
574 else
576 }
577 #endif
579 /* ---------------------------------------------------------------------------
580 * Clear warning color from pins/pads
581 */
582 static void
584 {
587 {
589 {
592 }
593 }
594 ENDALL_LOOP;
596 {
598 {
601 }
602 }
603 ENDALL_LOOP;
605 }
607 static void
609 {
611 {
615 {
625 }
627 {
636 }
637 else
638 {
639 BoxType box;
648 /* unselect first if shift key not down */
654 }
656 }
657 }
659 static void
661 {
662 BoxType box;
665 {
666 BoxType box;
675 /* unselect first if shift key not down */
677 {
681 {
685 }
686 }
692 }
694 {
701 }
703 {
706 }
708 {
723 }
727 }
729 /* ---------------------------------------------------------------------------
730 * get function ID of passed string
731 */
732 #define HSIZE 257
736 static int
738 {
741 {
744 s ++;
745 }
748 }
750 static int
752 {
759 {
762 {
766 }
768 {
769 /* Change 'char' to 'int' and remove this when we get to 256
770 strings to hash. */
775 }
777 {
782 }
783 }
787 {
788 /* We enforce the "hash table bigger than function table" rule,
789 so we know there will be at least one zero entry to find. */
795 }
796 }
798 /* ---------------------------------------------------------------------------
799 * set new coordinates if in 'RECTANGLE' mode
800 * the cursor shape is also adjusted
801 */
802 static void
804 {
806 {
809 }
811 {
813 {
814 /* update coordinates */
818 }
819 }
820 }
822 /* ---------------------------------------------------------------------------
823 * adjusts the objects which are to be created like attached lines...
824 */
825 void
827 {
828 PointTypePtr pnt;
830 {
831 /* update at least an attached block (selection) */
835 {
838 }
841 /* rectangle creation mode */
847 /* polygon creation mode */
852 /* line creation mode */
856 else
859 /* point insertion mode */
867 }
868 }
870 /* ---------------------------------------------------------------------------
871 * creates points of a line
872 */
873 static void
875 {
882 {
887 {
890 }
892 {
897 FOUNDFLAG);
898 }
900 {
905 }
907 {
912 {
915 }
916 else
917 {
920 }
921 }
922 else
923 {
928 }
933 /* fall through to third state too */
938 }
939 }
941 /* ---------------------------------------------------------------------------
942 * create first or second corner of a marked block
943 */
944 static void
946 {
949 {
961 }
963 }
966 /* ---------------------------------------------------------------------------
967 *
968 * does what's appropriate for the current mode setting. This normally
969 * means creation of an object at the current crosshair location.
970 *
971 * new created objects are added to the create undo list of course
972 */
973 static void
975 {
982 {
984 {
986 hidval hv;
989 /* do something after click time */
992 /* see if we clicked on something already selected
993 * (Note.Moving) or clicked on a MOVE_TYPE
994 * (Note.Hit)
995 */
998 {
1002 {
1007 }
1013 }
1015 }
1018 {
1019 PinTypePtr via;
1022 {
1026 }
1031 {
1038 }
1040 }
1043 {
1045 {
1056 {
1057 ArcTypePtr arc;
1064 {
1068 #ifdef ARC45
1071 else
1072 #endif
1074 }
1075 else
1076 {
1080 #ifdef ARC45
1083 else
1084 #endif
1087 }
1089 Crosshair.
1090 AttachedBox.
1092 Crosshair.
1093 AttachedBox.
1097 sa,
1098 dir,
1099 Settings.
1100 LineThickness,
1102 Keepaway,
1103 MakeFlags
1104 (TEST_FLAG
1106 PCB) ?
1107 CLEARLINEFLAG :
1109 {
1110 BoxTypePtr bx;
1119 addedLines++;
1123 }
1125 }
1126 }
1128 }
1130 {
1133 {
1138 {
1141 }
1142 END_LOOP;
1144 {
1147 }
1148 END_LOOP;
1150 /* always re-draw it since I'm too lazy
1151 * to tell if a selected flag changed
1152 */
1156 }
1158 {
1163 {
1164 /* this is not un-doable since LOCK isn't */
1168 }
1170 }
1172 }
1174 {
1176 =
1180 {
1182 {
1184 tstyle++;
1188 }
1191 else
1193 }
1195 }
1198 /* do update of position */
1203 /* Remove anchor if clicking on start point;
1204 * this means we can't paint 0 length lines
1205 * which could be used for square SMD pads.
1206 * Instead use a very small delta, or change
1207 * the file after saving.
1208 */
1211 {
1214 }
1217 {
1218 RatTypePtr line;
1220 {
1221 addedLines++;
1230 }
1232 }
1233 else
1234 /* create line if both ends are determined && length != 0 */
1235 {
1236 LineTypePtr line;
1246 {
1247 /* We will only need to paint the second line segment.
1248 Since we only check for vias on the first segment,
1249 swap them so the non-empty segment is the first segment. */
1252 }
1257 else
1273 (TEST_FLAG
1277 {
1278 PinTypePtr via;
1280 addedLines++;
1283 /* place a via if vias are visible, the layer is
1284 in a new group since the last line and there
1285 isn't a pin already here */
1292 NO_TYPE
1301 {
1304 }
1305 /* copy the coordinates */
1312 }
1326 (TEST_FLAG
1330 {
1331 addedLines++;
1335 /* move to new start point */
1341 {
1343 }
1344 }
1346 }
1350 /* do update of position */
1353 /* create rectangle if both corners are determined
1354 * and width, height are != 0
1355 */
1359 {
1360 PolygonTypePtr polygon;
1366 Crosshair.
1368 Crosshair.
1370 Crosshair.
1372 Crosshair.
1374 MakeFlags
1376 NULL)
1377 {
1383 }
1385 /* reset state to 'first corner' */
1387 }
1391 {
1395 {
1397 {
1398 TextTypePtr text;
1407 {
1412 }
1413 }
1415 }
1417 }
1420 {
1424 /* do update of position; use the 'LINE_MODE' mechanism */
1427 /* check if this is the last point of a polygon */
1431 {
1435 }
1437 /* create new point if it's the first one or if it's
1438 * different to the last one
1439 */
1443 {
1448 /* copy the coordinates */
1451 }
1453 }
1456 {
1458 {
1459 /* first notify, lookup object */
1468 {
1471 {
1475 }
1476 else
1478 }
1481 /* second notify, insert new point into object */
1483 {
1487 FlagType Flags;
1489 /* do update of position; use the 'LINE_MODE' mechanism */
1492 /* check if this is the last point of a polygon */
1496 {
1497 /* Create POLYAREAs from the original polygon
1498 * and the new hole polygon */
1502 /* Subtract the hole from the original polygon shape */
1505 /* Convert the resulting polygon(s) into a new set of nodes
1506 * and place them on the page. Delete the original polygon.
1507 */
1520 /* reset state of attached line */
1526 }
1528 /* create new point if it's the first one or if it's
1529 * different to the last one
1530 */
1534 {
1539 /* copy the coordinates */
1542 }
1544 }
1545 }
1548 }
1551 {
1556 {
1561 {
1564 {
1572 }
1573 }
1574 }
1578 {
1583 {
1590 {
1602 }
1603 }
1604 }
1606 }
1612 {
1614 {
1617 }
1619 {
1620 RubberbandTypePtr ptr;
1627 {
1634 else
1636 ptr++;
1637 }
1638 }
1642 }
1652 /* both are almost the same */
1656 {
1657 /* first notify, lookup object */
1659 {
1669 {
1673 {
1676 }
1677 else
1679 }
1681 }
1683 /* second notify, move or copy object */
1692 else
1693 {
1701 }
1704 /* reset identifiers */
1708 }
1711 /* insert a point into a polygon/line/... */
1714 {
1715 /* first notify, lookup object */
1724 {
1727 {
1731 }
1732 else
1733 {
1734 /* get starting point of nearest segment */
1736 {
1739 polyIndex =
1747 }
1750 }
1751 }
1754 /* second notify, insert new point into object */
1761 else
1769 /* reset identifiers */
1773 }
1775 }
1776 }
1779 /* --------------------------------------------------------------------------- */
1785 /* %start-doc actions Atomic
1787 This action allows making multiple-action bindings into an atomic
1788 operation that will be undone by a single Undo command. For example,
1789 to optimize rat lines, you'd delete the rats and re-add them. To
1790 group these into a single undo, you'd want the deletions and the
1791 additions to have the same undo serial number. So, you @code{Save},
1792 delete the rats, @code{Restore}, add the rats - using the same serial
1793 number as the deletes, then @code{Block}, which checks to see if the
1794 deletions or additions actually did anything. If not, the serial
1795 number is set to the saved number, as there's nothing to undo. If
1796 something did happen, the serial number is incremented so that these
1797 actions are counted as a single undo step.
1799 @table @code
1801 @item Save
1802 Saves the undo serial number.
1804 @item Restore
1805 Returns it to the last saved number.
1807 @item Close
1808 Sets it to 1 greater than the last save.
1810 @item Block
1811 Does a Restore if there was nothing to undo, else does a Close.
1813 @end table
1815 %end-doc */
1817 static int
1819 {
1824 {
1840 }
1842 }
1844 /* -------------------------------------------------------------------------- */
1850 /* %start-doc actions DRC
1852 Note that the design rule check uses the current board rule settings,
1853 not the current style settings.
1855 %end-doc */
1857 static int
1859 {
1863 {
1871 }
1874 {
1879 else
1881 }
1883 }
1885 /* -------------------------------------------------------------------------- */
1892 /* %start-doc actions DumpLibrary
1895 %end-doc */
1897 static int
1899 {
1906 {
1917 {
1920 {
1923 }
1924 else
1925 {
1932 }
1933 }
1934 }
1937 }
1939 /* -------------------------------------------------------------------------- */
1946 /* %start-doc actions Flip
1948 Note that the location of the element will be symmetric about the
1949 cursor location; i.e. if the part you are pointing at will still be at
1950 the same spot once the element is on the other side. When flipping
1951 multiple elements, this retains their positions relative to each
1952 other, not their absolute positions on the board.
1954 %end-doc */
1956 static int
1958 {
1960 ElementTypePtr element;
1965 {
1967 {
1971 {
1976 }
1985 }
1988 }
1991 }
1993 /* -------------------------------------------------------------------------- */
1999 /* %start-doc actions Message
2001 This action displays a message to the log window. This action is primarily
2002 provided for use by other programs which may interface with PCB. If
2003 multiple arguments are given, each one is sent to the log window
2004 followed by a newline.
2006 %end-doc */
2008 static int
2010 {
2017 {
2020 }
2023 }
2026 /* -------------------------------------------------------------------------- */
2036 "Style = 3 is a solid connection to the plane."
2040 /* %start-doc actions SetThermal
2042 This changes how/whether pins or vias connect to any rectangle or polygon
2043 on the current layer. The first argument can specify one object, or all
2044 selected pins, or all selected vias, or all selected pins and vias.
2045 The second argument specifies the style of connection.
2046 There are 5 possibilities:
2047 0 - no connection,
2048 1 - 45 degree fingers with sharp edges,
2049 2 - horizontal & vertical fingers with sharp edges,
2050 3 - solid connection,
2051 4 - 45 degree fingers with rounded corners,
2052 5 - horizontal & vertical fingers with rounded corners.
2054 Pins and Vias may have thermals whether or not there is a polygon available
2055 to connect with. However, they will have no effect without the polygon.
2056 %end-doc */
2058 static int
2060 {
2068 {
2074 {
2079 {
2083 }
2098 }
2099 else
2103 }
2106 }
2108 /* ---------------------------------------------------------------------------
2109 * !!! no action routine !!!
2110 *
2111 * event handler to set the cursor according to the X pointer position
2112 * called from inside main.c
2113 */
2114 void
2116 {
2117 #ifdef HAVE_LIBSTROKE
2119 {
2124 }
2127 {
2128 /* update object position and cursor location */
2131 }
2132 }
2134 /* --------------------------------------------------------------------------- */
2142 /* %start-doc actions SetValue
2144 @table @code
2146 @item ViaDrillingHole
2147 Changes the diameter of the drill for new vias.
2149 @item Grid
2150 Sets the grid spacing.
2152 @item Line
2153 @item LineSize
2154 Changes the thickness of new lines.
2156 @item Via
2157 @item ViaSize
2158 Changes the diameter of new vias.
2160 @item Text
2161 @item TextScale
2162 Changes the size of new text.
2164 @end table
2166 %end-doc */
2168 static int
2170 {
2179 {
2182 {
2193 else
2194 {
2195 /* On the way down, short against the minimum
2196 * PCB drawing unit */
2201 else
2203 }
2226 }
2229 }
2232 }
2235 /* --------------------------------------------------------------------------- */
2241 /* %start-doc actions Quit
2243 If you have unsaved changes, you will be prompted to confirm (or
2244 save) before quitting.
2246 %end-doc */
2248 static int
2250 {
2253 {
2256 }
2260 }
2262 /* --------------------------------------------------------------------------- */
2270 /* %start-doc actions Connection
2272 Connections found with this action will be highlighted in the
2273 ``connected-color'' color and will have the ``found'' flag set.
2275 @table @code
2277 @item Find
2278 The net under the cursor is ``found''.
2280 @item ResetLinesAndPolygons
2281 Any ``found'' lines and polygons are marked ``not found''.
2283 @item ResetPinsAndVias
2284 Any ``found'' pins and vias are marked ``not found''.
2286 @item Reset
2287 All ``found'' objects are marked ``not found''.
2289 @end table
2291 %end-doc */
2293 static int
2295 {
2298 {
2300 {
2302 {
2306 }
2310 {
2313 }
2318 {
2321 }
2326 {
2329 }
2331 }
2333 }
2336 }
2338 /* --------------------------------------------------------------------------- */
2345 /* %start-doc actions DisperseElements
2347 Normally this is used when starting a board, by selecting all elements
2348 and then dispersing them. This scatters the elements around the board
2349 so that you can pick individual ones, rather than have all the
2350 elements at the same 0,0 coordinate and thus impossible to choose
2351 from.
2353 %end-doc */
2355 #define GAP MIL_TO_COORD(100)
2357 static int
2359 {
2368 {
2370 }
2371 else
2372 {
2374 {
2385 }
2386 }
2389 {
2391 }
2395 {
2396 /*
2397 * If we want to disperse selected elements, maybe we need smarter
2398 * code here to avoid putting components on top of others which
2399 * are not selected. For now, I'm assuming that this is typically
2400 * going to be used either with a brand new design or a scratch
2401 * design holding some new components
2402 */
2404 {
2406 /* figure out how much to move the element */
2409 /* snap to the grid */
2412 /*
2413 * and add one grid size so we make sure we always space by GAP or
2414 * more
2415 */
2418 /* Figure out if this row has room. If not, start a new row */
2420 {
2423 }
2425 /* figure out how much to move the element */
2429 /* snap to the grid */
2435 /* move the element */
2438 /* and add to the undo list so we can undo this operation */
2441 /* keep track of how tall this row is */
2444 {
2446 }
2447 }
2449 }
2450 END_LOOP;
2452 /* done with our action so increment the undo # */
2459 }
2461 #undef GAP
2463 /* --------------------------------------------------------------------------- */
2478 /* %start-doc actions Display
2480 @table @code
2482 @item NameOnPCB
2483 @item Description
2484 @item Value
2485 Specify whether all elements show their name, description, or value.
2487 @item Redraw
2488 Redraw the whole board.
2490 @item Toggle45Degree
2491 When clear, lines can be drawn at any angle. When set, lines are
2492 restricted to multiples of 45 degrees and requested lines may be
2493 broken up according to the clip setting.
2495 @item CycleClip
2496 Changes the way lines are restricted to 45 degree increments. The
2497 various settings are: straight only, orthogonal then angled, and angled
2498 then orthogonal. If AllDirections is set, this action disables it.
2500 @item CycleCrosshair
2501 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2502 8-ray and 12-ray cross.
2504 @item ToggleRubberBandMode
2505 If set, moving an object moves all the lines attached to it too.
2507 @item ToggleStartDirection
2508 If set, each time you set a point in a line, the Clip toggles between
2509 orth-angle and angle-ortho.
2511 @item ToggleUniqueNames
2512 If set, you will not be permitted to change the name of an element to
2513 match that of another element.
2515 @item ToggleSnapPin
2516 If set, pin centers and pad end points are treated as additional grid
2517 points that the cursor can snap to.
2519 @item ToggleLocalRef
2520 If set, the mark is automatically set to the beginning of any move, so
2521 you can see the relative distance you've moved.
2523 @item ToggleThindraw
2524 If set, objects on the screen are drawn as outlines (lines are drawn
2525 as center-lines). This lets you see line endpoints hidden under pins,
2526 for example.
2528 @item ToggleThindrawPoly
2529 If set, polygons on the screen are drawn as outlines.
2531 @item ToggleShowDRC
2532 If set, pending objects (i.e. lines you're in the process of drawing)
2533 will be drawn with an outline showing how far away from other copper
2534 you need to be.
2536 @item ToggleLiveRoute
2537 If set, the progress of the autorouter will be visible on the screen.
2539 @item ToggleAutoDRC
2540 If set, you will not be permitted to make connections which violate
2541 the current DRC and netlist settings.
2543 @item ToggleCheckPlanes
2544 If set, lines and arcs aren't drawn, which usually leaves just the
2545 polygons. If you also disable all but the layer you're interested in,
2546 this allows you to check for isolated regions.
2548 @item ToggleOrthoMove
2549 If set, the crosshair is only allowed to move orthogonally from its
2550 previous position. I.e. you can move an element or line up, down,
2551 left, or right, but not up+left or down+right.
2553 @item ToggleName
2554 Selects whether the pinouts show the pin names or the pin numbers.
2556 @item ToggleLockNames
2557 If set, text will ignore left mouse clicks and actions that work on
2558 objects under the mouse. You can still select text with a lasso (left
2559 mouse drag) and perform actions on the selection.
2561 @item ToggleOnlyNames
2562 If set, only text will be sensitive for mouse clicks and actions that
2563 work on objects under the mouse. You can still select other objects
2564 with a lasso (left mouse drag) and perform actions on the selection.
2566 @item ToggleMask
2567 Turns the solder mask on or off.
2569 @item ToggleClearLine
2570 When set, the clear-line flag causes new lines and arcs to have their
2571 ``clear polygons'' flag set, so they won't be electrically connected
2572 to any polygons they overlap.
2574 @item ToggleFullPoly
2575 When set, the full-poly flag causes new polygons to have their
2576 ``full polygon'' flag set, so all parts of them will be displayed
2577 instead of only the biggest one.
2579 @item ToggleGrid
2580 Resets the origin of the current grid to be wherever the mouse pointer
2581 is (not where the crosshair currently is). If you provide two numbers
2582 after this, the origin is set to that coordinate.
2584 @item Grid
2585 Toggles whether the grid is displayed or not.
2587 @item Pinout
2588 Causes the pinout of the element indicated by the cursor to be
2589 displayed, usually in a separate window.
2591 @item PinOrPadName
2592 Toggles whether the names of pins, pads, or (yes) vias will be
2593 displayed. If the cursor is over an element, all of its pins and pads
2594 are affected.
2596 @end table
2598 %end-doc */
2600 static enum crosshair_shape
2602 {
2604 {
2617 }
2619 }
2621 static int
2623 {
2632 {
2634 {
2636 /* redraw layout */
2642 /* change the displayed name of elements */
2647 {
2649 }
2650 END_LOOP;
2653 {
2662 }
2664 {
2666 }
2667 END_LOOP;
2671 /* toggle line-adjust flag */
2679 if TEST_FLAG
2681 {
2684 }
2685 else
2762 {
2764 {
2767 }
2771 FOUNDFLAG);
2772 }
2803 /* shift grid alignment */
2805 {
2812 }
2815 /* toggle displaying of the grid */
2821 /* display the pinout of an element */
2823 {
2824 ElementTypePtr element;
2832 {
2835 }
2837 }
2839 /* toggle displaying of pin/pad/via names */
2841 {
2848 {
2851 {
2854 else
2858 }
2859 END_LOOP;
2861 {
2864 else
2868 }
2869 END_LOOP;
2878 else
2890 else
2901 else
2909 }
2911 }
2914 }
2915 }
2917 {
2919 {
2922 {
2927 }
2933 }
2934 }
2940 }
2942 /* --------------------------------------------------------------------------- */
2952 /* %start-doc actions Mode
2954 @table @code
2956 @item Arc
2957 @itemx Arrow
2958 @itemx Copy
2959 @itemx InsertPoint
2960 @itemx Line
2961 @itemx Lock
2962 @itemx Move
2963 @itemx None
2964 @itemx PasteBuffer
2965 @itemx Polygon
2966 @itemx Rectangle
2967 @itemx Remove
2968 @itemx Rotate
2969 @itemx Text
2970 @itemx Thermal
2971 @itemx Via
2972 Select the indicated tool.
2974 @item Notify
2975 Called when you press the mouse button, or move the mouse.
2977 @item Release
2978 Called when you release the mouse button.
2980 @item Cancel
2981 Cancels any pending tool activity, allowing you to restart elsewhere.
2982 For example, this allows you to start a new line rather than attach a
2983 line to the previous line.
2985 @item Escape
2986 Similar to Cancel but calling this action a second time will return
2987 to the Arrow tool.
2989 @item Stroke
2990 If your @code{pcb} was built with libstroke, this invokes the stroke
2991 input method. If not, this will restart a drawing mode if you were
2992 drawing, else it will select objects.
2994 @item Save
2995 Remembers the current tool.
2997 @item Restore
2998 Restores the tool to the last saved tool.
3000 @end table
3002 %end-doc */
3004 static int
3006 {
3010 {
3015 {
3041 {
3045 }
3048 {
3050 {
3069 else
3070 {
3073 }
3079 else
3080 {
3083 }
3089 else
3090 {
3093 }
3099 else
3100 {
3103 }
3109 else
3110 {
3113 }
3121 }
3122 }
3137 #ifndef HAVE_LIBSTROKE
3141 #else
3145 else
3148 #endif
3159 #ifdef HAVE_LIBSTROKE
3164 #else
3165 /* Handle middle mouse button restarts of drawing mode. If not in
3166 | a drawing mode, middle mouse button will select objects.
3167 */
3170 {
3172 }
3182 else
3183 {
3188 }
3190 #endif
3208 }
3211 }
3214 }
3216 /* --------------------------------------------------------------------------- */
3222 /* %start-doc actions RemoveSelected
3224 %end-doc */
3226 static int
3228 {
3232 }
3234 /* --------------------------------------------------------------------------- */
3243 /* %start-doc actions Renumber
3245 %end-doc */
3247 static int
3249 {
3261 struct _cnt_list
3262 {
3272 {
3273 /*
3274 * We deal with the case where name already exists in this
3275 * function so the GUI doesn't need to deal with it
3276 */
3285 }
3286 else
3290 {
3293 }
3296 {
3298 }
3301 {
3304 {
3308 }
3309 }
3312 {
3317 }
3325 /*
3326 * Make a first pass through all of the elements and sort them out
3327 * by location on the board. While here we also collect a list of
3328 * locked elements.
3329 *
3330 * We'll actually renumber things in the 2nd pass.
3331 */
3338 {
3341 }
3347 {
3349 {
3350 /*
3351 * add to the list of locked elements which we won't try to
3352 * renumber and whose reference designators are now reserved.
3353 */
3358 lock_cnt++;
3359 }
3361 else
3362 {
3363 /* count of devices which will be renumbered */
3364 cnt++;
3366 /* search for correct position in the list */
3369 i++;
3371 /*
3372 * We have found the position where we have the first element that
3373 * has the same Y value or a lower Y value. Now move forward if
3374 * needed through the X values
3375 */
3379 i++;
3382 {
3384 }
3386 }
3387 }
3388 END_LOOP;
3391 /*
3392 * Now that the elements are sorted by board position, we go through
3393 * and renumber them.
3394 */
3396 /*
3397 * turn off the flag which requires unique names so it doesn't get
3398 * in our way. When we're done with the renumber we will have unique
3399 * names.
3400 */
3406 {
3407 /* If there is no refdes, maybe just spit out a warning */
3409 {
3410 /* figure out the prefix */
3415 j++;
3418 /* check the counter for this prefix */
3423 /* grow the list if needed */
3425 {
3429 {
3432 }
3433 /* zero out the memory that we added */
3435 {
3438 }
3439 }
3441 /*
3442 * start a new counter if we don't have a counter for this
3443 * prefix
3444 */
3446 {
3449 }
3451 /*
3452 * check to see if the new refdes is already used by a
3453 * locked element
3454 */
3455 do
3456 {
3461 /* space for the prefix plus 1 digit plus the '\0' */
3464 /* and 1 more per extra digit needed to hold the number */
3467 {
3468 sz++;
3470 }
3474 /*
3475 * now compare to the list of reserved (by locked
3476 * elements) names
3477 */
3479 {
3483 {
3486 }
3487 }
3489 }
3493 {
3497 /* add this rename to our table of renames so we can update the netlist */
3500 c_cnt++;
3508 tmps);
3511 /* we don't free tmps in this case because it is used */
3512 }
3513 else
3515 }
3516 else
3517 {
3520 }
3522 }
3526 /* restore the unique flag setting */
3531 {
3533 /* update the netlist */
3536 /* iterate over each net */
3538 {
3540 /* iterate over each pin on the net */
3542 {
3544 /* figure out the pin number part from strings like U3-21 */
3550 /* iterate over the list of changed reference designators */
3552 {
3553 /*
3554 * if the pin needs to change, change it and quit
3555 * searching in the list.
3556 */
3558 {
3566 }
3568 }
3570 }
3571 }
3573 {
3576 }
3581 }
3587 }
3590 /* --------------------------------------------------------------------------- */
3597 /* %start-doc actions RipUp
3599 @table @code
3601 @item All
3602 Removes all lines and vias which were created by the autorouter.
3604 @item Selected
3605 Removes all selected lines and vias which were created by the
3606 autorouter.
3608 @item Element
3609 Converts the element under the cursor to parts (vias and lines). Note
3610 that this uses the highest numbered paste buffer.
3612 @end table
3614 %end-doc */
3616 static int
3618 {
3623 {
3625 {
3628 {
3630 {
3633 }
3634 }
3635 ENDALL_LOOP;
3637 {
3639 {
3642 }
3643 }
3644 ENDALL_LOOP;
3646 {
3648 {
3651 }
3652 }
3653 END_LOOP;
3656 {
3659 }
3663 {
3666 {
3669 }
3670 }
3671 ENDALL_LOOP;
3674 {
3677 {
3680 }
3681 }
3682 END_LOOP;
3684 {
3687 }
3690 {
3695 {
3711 }
3712 }
3714 }
3715 }
3717 }
3719 /* --------------------------------------------------------------------------- */
3725 /* %start-doc actions AddRats
3727 @table @code
3729 @item AllRats
3730 Create rat lines for all loaded nets that aren't already connected on
3731 with copper.
3733 @item SelectedRats
3734 Similarly, but only add rat lines for nets connected to selected pins
3735 and pads.
3737 @item Close
3738 Selects the shortest unselected rat on the board.
3740 @end table
3742 %end-doc */
3744 static int
3746 {
3748 RatTypePtr shorty;
3752 {
3756 {
3770 {
3776 {
3779 }
3780 }
3781 END_LOOP;
3783 {
3790 }
3792 }
3793 }
3795 }
3797 /* --------------------------------------------------------------------------- */
3805 /* %start-doc actions Delete
3807 %end-doc */
3809 static int
3811 {
3819 {
3822 }
3825 {
3843 }
3846 }
3848 /* --------------------------------------------------------------------------- */
3855 /* %start-doc actions DeleteRats
3857 %end-doc */
3859 static int
3861 {
3864 {
3868 {
3878 }
3879 }
3881 }
3883 /* --------------------------------------------------------------------------- */
3889 /* %start-doc actions AutoPlaceSelected
3891 Attempts to re-arrange the selected components such that the nets
3892 connecting them are minimized. Note that you cannot undo this.
3894 %end-doc */
3896 static int
3898 {
3902 {
3905 }
3907 }
3909 /* --------------------------------------------------------------------------- */
3915 /* %start-doc actions AutoRoute
3917 @table @code
3919 @item AllRats
3920 Attempt to autoroute all rats.
3922 @item SelectedRats
3923 Attempt to autoroute the selected rats.
3925 @end table
3927 Before autorouting, it's important to set up a few things. First,
3928 make sure any layers you aren't using are disabled, else the
3929 autorouter may use them. Next, make sure the current line and via
3930 styles are set accordingly. Last, make sure "new lines clear
3931 polygons" is set, in case you eventually want to add a copper pour.
3933 Autorouting takes a while. During this time, the program may not be
3934 responsive.
3936 %end-doc */
3938 static int
3940 {
3944 {
3946 {
3956 }
3957 }
3959 }
3961 /* --------------------------------------------------------------------------- */
3969 /* %start-doc actions MarkCrosshair
3971 The ``mark'' is a small X-shaped target on the display which is
3972 treated like a second origin (the normal origin is the upper let
3973 corner of the board). The GUI will display a second set of
3974 coordinates for this mark, which tells you how far you are from it.
3976 If no argument is given, the mark is toggled - disabled if it was
3977 enabled, or enabled at the current cursor position of disabled. If
3978 the @code{Center} argument is given, the mark is moved to the current
3979 cursor location.
3981 %end-doc */
3983 static int
3985 {
3988 {
3990 {
3994 }
3995 else
3996 {
4003 }
4004 }
4006 {
4012 }
4014 }
4016 /* --------------------------------------------------------------------------- */
4027 /* %start-doc actions ChangeSize
4029 For lines and arcs, this changes the width. For pins and vias, this
4030 changes the overall diameter of the copper annulus. For pads, this
4031 changes the width and, indirectly, the length. For texts and names,
4032 this changes the scaling factor. For elements, this changes the width
4033 of the silk layer lines and arcs for this element.
4035 %end-doc */
4037 static int
4039 {
4044 Coord value;
4047 {
4050 {
4052 {
4064 }
4111 }
4112 }
4114 }
4116 /* --------------------------------------------------------------------------- */
4125 /* %start-doc actions ChangeDrillSize
4127 %end-doc */
4129 static int
4131 {
4136 Coord value;
4139 {
4142 {
4144 {
4156 }
4172 }
4173 }
4175 }
4177 /* --------------------------------------------------------------------------- */
4188 /* %start-doc actions ChangeClearSize
4190 If the solder mask is currently showing, this action changes the
4191 solder mask clearance. If the mask is not showing, this action
4192 changes the polygon clearance.
4194 %end-doc */
4196 static int
4198 {
4203 Coord value;
4206 {
4209 {
4211 {
4223 }
4249 }
4250 }
4252 }
4254 /* --------------------------------------------------------------------------- */
4263 /* %start-doc actions MinMaskGap
4265 Checks all specified pins and/or pads, and increases the mask if
4266 needed to ensure a minimum distance between the pin or pad edge and
4267 the mask edge.
4269 %end-doc */
4271 static int
4273 {
4278 Coord value;
4285 else
4286 {
4290 }
4295 {
4297 {
4301 {
4305 }
4306 }
4307 END_LOOP;
4309 {
4313 {
4317 }
4318 }
4319 END_LOOP;
4320 }
4321 END_LOOP;
4323 {
4327 {
4330 }
4331 }
4332 END_LOOP;
4336 }
4338 /* --------------------------------------------------------------------------- */
4347 /* %start-doc actions MinClearGap
4349 Checks all specified objects, and increases the polygon clearance if
4350 needed to ensure a minimum distance between their edges and the
4351 polygon edges.
4353 %end-doc */
4355 static int
4357 {
4362 Coord value;
4369 else
4370 {
4374 }
4379 {
4381 {
4385 {
4389 }
4390 }
4391 END_LOOP;
4393 {
4397 {
4401 }
4402 }
4403 END_LOOP;
4404 }
4405 END_LOOP;
4407 {
4411 {
4414 }
4415 }
4416 END_LOOP;
4418 {
4422 {
4425 }
4426 }
4427 ENDALL_LOOP;
4429 {
4433 {
4436 }
4437 }
4438 ENDALL_LOOP;
4442 }
4444 /* --------------------------------------------------------------------------- */
4452 /* %start-doc actions ChangePinName
4454 This can be especially useful for annotating pin names from a
4455 schematic to the layout without requiring knowledge of the pcb file
4456 format.
4458 @example
4459 ChangePinName(U3, 7, VCC)
4460 @end example
4462 %end-doc */
4464 static int
4466 {
4471 {
4473 }
4480 {
4482 {
4484 {
4486 {
4489 /*
4490 * Note: we can't free() pin->Name first because
4491 * it is used in the undo list
4492 */
4496 }
4497 }
4498 END_LOOP;
4501 {
4503 {
4506 /*
4507 * Note: we can't free() pad->Name first because
4508 * it is used in the undo list
4509 */
4513 }
4514 }
4515 END_LOOP;
4516 }
4517 }
4518 END_LOOP;
4519 /*
4520 * done with our action so increment the undo # if we actually
4521 * changed anything
4522 */
4524 {
4527 else
4528 {
4531 }
4532 }
4535 }
4537 /* --------------------------------------------------------------------------- */
4545 /* %start-doc actions ChangeName
4547 @table @code
4549 @item Object
4550 Changes the name of the element under the cursor.
4552 @item Layout
4553 Changes the name of the layout. This is printed on the fab drawings.
4555 @item Layer
4556 Changes the name of the currently active layer.
4558 @end table
4560 %end-doc */
4562 int
4564 {
4569 {
4571 {
4572 /* change the name of an object */
4574 {
4582 {
4585 {
4588 {
4589 RubberbandTypePtr ptr;
4598 {
4604 }
4607 }
4608 }
4609 }
4611 }
4613 /* change the layout's name */
4615 name =
4617 /* NB: ChangeLayoutName takes ownership of the passed memory */
4622 /* change the name of the active layer */
4626 /* NB: ChangeLayerName takes ownership of the passed memory */
4630 }
4631 }
4633 }
4636 /* --------------------------------------------------------------------------- */
4643 /* %start-doc actions MorphPolygon
4645 If a polygon is divided into unconnected "islands", you can use
4646 this command to convert the otherwise disappeared islands into
4647 separate polygons. Be sure the cursor is over a portion of the
4648 polygon that remains visible. Very small islands that may flake
4649 off are automatically deleted.
4651 %end-doc */
4653 static int
4655 {
4658 {
4660 {
4662 {
4669 {
4673 }
4675 }
4679 {
4682 }
4683 ENDALL_LOOP;
4687 }
4688 }
4690 }
4692 /* --------------------------------------------------------------------------- */
4700 /* %start-doc actions ToggleHideName
4702 If names are hidden you won't see them on the screen and they will not
4703 appear on the silk layer when you print the layout.
4705 %end-doc */
4707 static int
4709 {
4712 {
4714 {
4716 {
4723 {
4730 }
4732 }
4735 {
4738 {
4743 {
4750 }
4751 }
4752 END_LOOP;
4754 {
4757 }
4758 }
4759 }
4760 }
4762 }
4764 /* --------------------------------------------------------------------------- */
4772 /* %start-doc actions ChangeJoin
4774 The join flag determines whether a line or arc, drawn to intersect a
4775 polygon, electrically connects to the polygon or not. When joined,
4776 the line/arc is simply drawn over the polygon, making an electrical
4777 connection. When not joined, a gap is drawn between the line and the
4778 polygon, insulating them from each other.
4780 %end-doc */
4782 static int
4784 {
4787 {
4789 {
4792 {
4803 }
4820 }
4821 }
4823 }
4825 /* --------------------------------------------------------------------------- */
4835 /* %start-doc actions ChangeSquare
4837 Note that @code{Pins} means both pins and pads.
4839 @pinshapes
4841 %end-doc */
4843 static int
4845 {
4848 {
4850 {
4853 {
4864 }
4881 }
4882 }
4884 }
4886 /* --------------------------------------------------------------------------- */
4893 /* %start-doc actions SetSquare
4895 Note that @code{Pins} means pins and pads.
4897 @pinshapes
4899 %end-doc */
4901 static int
4903 {
4906 {
4908 {
4911 {
4922 }
4939 }
4940 }
4942 }
4944 /* --------------------------------------------------------------------------- */
4952 /* %start-doc actions ClearSquare
4954 Note that @code{Pins} means pins and pads.
4956 @pinshapes
4958 %end-doc */
4960 static int
4962 {
4965 {
4967 {
4970 {
4981 }
4998 }
4999 }
5001 }
5003 /* --------------------------------------------------------------------------- */
5012 /* %start-doc actions ChangeOctagon
5014 @pinshapes
5016 %end-doc */
5018 static int
5020 {
5023 {
5025 {
5028 {
5039 }
5061 }
5062 }
5064 }
5066 /* --------------------------------------------------------------------------- */
5073 /* %start-doc actions SetOctagon
5075 @pinshapes
5077 %end-doc */
5079 static int
5081 {
5084 {
5086 {
5089 {
5100 }
5122 }
5123 }
5125 }
5127 /* --------------------------------------------------------------------------- */
5136 /* %start-doc actions ClearOctagon
5138 @pinshapes
5140 %end-doc */
5142 static int
5144 {
5147 {
5149 {
5152 {
5163 }
5185 }
5186 }
5188 }
5190 /* --------------------------------------------------------------------------- */
5197 /* %start-doc actions ChangeHole
5199 The "hole flag" of a via determines whether the via is a
5200 plated-through hole (not set), or an unplated hole (set).
5202 %end-doc */
5204 static int
5206 {
5209 {
5211 {
5214 {
5224 }
5231 }
5232 }
5234 }
5236 /* --------------------------------------------------------------------------- */
5243 /* %start-doc actions ChangePaste
5245 The "no paste flag" of a pad determines whether the solderpaste
5246 stencil will have an opening for the pad (no set) or if there wil be
5247 no solderpaste on the pad (set). This is used for things such as
5248 fiducial pads.
5250 %end-doc */
5252 static int
5254 {
5257 {
5259 {
5262 {
5272 }
5279 }
5280 }
5282 }
5284 /* --------------------------------------------------------------------------- */
5297 /* %start-doc actions Select
5299 @table @code
5301 @item ElementByName
5302 @item ObjectByName
5303 @item PadByName
5304 @item PinByName
5305 @item TextByName
5306 @item ViaByName
5307 @item NetByName
5309 These all rely on having a regular expression parser built into
5310 @code{pcb}. If the name is not specified then the user is prompted
5311 for a pattern, and all objects that match the pattern and are of the
5312 type specified are selected.
5314 @item Object
5315 @item ToggleObject
5316 Selects the object under the cursor.
5318 @item Block
5319 Selects all objects in a rectangle indicated by the cursor.
5321 @item All
5322 Selects all objects on the board.
5324 @item Connection
5325 Selects all connections with the ``found'' flag set.
5327 @item Convert
5328 Converts the selected objects to an element. This uses the highest
5329 numbered paste buffer.
5331 @end table
5333 %end-doc */
5335 static int
5337 {
5340 {
5342 {
5343 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5345 /* select objects by their names */
5368 commonByName:
5369 {
5375 {
5380 }
5382 }
5385 /* select a single object */
5392 /* all objects in block */
5394 {
5395 BoxType box;
5409 {
5412 }
5415 }
5417 /* select all visible objects */
5419 {
5420 BoxType box;
5429 }
5431 /* all found connections */
5434 {
5438 }
5442 {
5457 }
5463 }
5464 }
5466 }
5468 /* FLAG(have_regex,FlagHaveRegex,0) */
5469 int
5471 {
5472 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5474 #else
5476 #endif
5477 }
5479 /* --------------------------------------------------------------------------- */
5491 /* %start-doc actions Unselect
5493 @table @code
5495 @item All
5496 Unselect all objects.
5498 @item Block
5499 Unselect all objects in a rectangle given by the cursor.
5501 @item Connection
5502 Unselect all connections with the ``found'' flag set.
5504 @item ElementByName
5505 @item ObjectByName
5506 @item PadByName
5507 @item PinByName
5508 @item TextByName
5509 @item ViaByName
5511 These all rely on having a regular expression parser built into
5512 @code{pcb}. If the name is not specified then the user is prompted
5513 for a pattern, and all objects that match the pattern and are of the
5514 type specified are unselected.
5517 @end table
5519 %end-doc */
5521 static int
5523 {
5526 {
5528 {
5529 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5531 /* select objects by their names */
5554 commonByName:
5555 {
5561 {
5566 }
5568 }
5571 /* all objects in block */
5573 {
5574 BoxType box;
5588 {
5591 }
5594 }
5596 /* unselect all visible objects */
5598 {
5599 BoxType box;
5608 }
5610 /* all found connections */
5613 {
5617 }
5624 }
5625 }
5627 }
5629 /* --------------------------------------------------------------------------- */
5638 /* %start-doc actions SaveTo
5640 @table @code
5642 @item Layout
5643 Saves the current layout.
5645 @item LayoutAs
5646 Saves the current layout, and remembers the filename used.
5648 @item AllConnections
5649 Save all connections to a file.
5651 @item AllUnusedPins
5652 List all unused pins to a file.
5654 @item ElementConnections
5655 Save connections to the element at the cursor to a file.
5657 @item PasteBuffer
5658 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5660 @end table
5662 %end-doc */
5664 static int
5666 {
5674 {
5678 }
5684 {
5686 {
5692 }
5694 }
5697 {
5701 {
5705 }
5707 }
5710 {
5714 {
5718 }
5720 }
5723 {
5724 ElementTypePtr element;
5731 {
5735 {
5739 }
5740 }
5742 }
5745 {
5747 }
5750 }
5752 /* --------------------------------------------------------------------------- */
5760 /* %start-doc actions SaveSettings
5762 If you pass no arguments, the settings are stored in
5763 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5764 saved in @code{./pcb.settings}.
5766 %end-doc */
5768 static int
5770 {
5774 }
5776 /* --------------------------------------------------------------------------- */
5783 /* %start-doc actions LoadFrom
5785 This action assumes you know what the filename is. The various GUIs
5786 should have a similar @code{Load} action where the filename is
5787 optional, and will provide their own file selection mechanism to let
5788 you choose the file name.
5790 @table @code
5792 @item Layout
5793 Loads an entire PCB layout, replacing the current one.
5795 @item LayoutToBuffer
5796 Loads an entire PCB layout to the paste buffer.
5798 @item ElementToBuffer
5799 Loads the given element file into the paste buffer. Element files
5800 contain only a single @code{Element} definition, such as the
5801 ``newlib'' library uses.
5803 @item Netlist
5804 Loads a new netlist, replacing any current netlist.
5806 @item Revert
5807 Re-loads the current layout from its disk file, reverting any changes
5808 you may have made.
5810 @end table
5812 %end-doc */
5814 static int
5816 {
5827 {
5832 }
5835 {
5840 }
5843 {
5847 }
5850 {
5857 }
5861 {
5863 }
5866 }
5868 /* --------------------------------------------------------------------------- */
5874 /* %start-doc actions New
5876 If a name is not given, one is prompted for.
5878 %end-doc */
5880 static int
5882 {
5886 {
5889 else
5896 /* do emergency saving
5897 * clear the old struct and allocate memory for the new one
5898 */
5906 /* setup the new name and reset some values to default */
5918 }
5920 }
5922 /* ---------------------------------------------------------------------------
5923 * no operation, just for testing purposes
5924 * syntax: Bell(volume)
5925 */
5926 void
5928 {
5930 }
5932 /* --------------------------------------------------------------------------- */
5943 /* %start-doc actions PasteBuffer
5945 There are a number of paste buffers; the actual limit is a
5946 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5947 is currently @code{5}. One of these is the ``current'' paste buffer,
5948 often referred to as ``the'' paste buffer.
5950 @table @code
5952 @item AddSelected
5953 Copies the selected objects to the current paste buffer.
5955 @item Clear
5956 Remove all objects from the current paste buffer.
5958 @item Convert
5959 Convert the current paste buffer to an element. Vias are converted to
5960 pins, lines are converted to pads.
5962 @item Restore
5963 Convert any elements in the paste buffer back to vias and lines.
5965 @item Mirror
5966 Flip all objects in the paste buffer vertically (up/down flip). To mirror
5967 horizontally, combine this with rotations.
5969 @item Rotate
5970 Rotates the current buffer. The number to pass is 1..3, where 1 means
5971 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
5972 degrees clockwise (270 CCW).
5974 @item Save
5975 Saves any elements in the current buffer to the indicated file.
5977 @item ToLayout
5978 Pastes any elements in the current buffer to the indicated X, Y
5979 coordinates in the layout. The @code{X} and @code{Y} are treated like
5980 @code{delta} is for many other objects. For each, if it's prefixed by
5981 @code{+} or @code{-}, then that amount is relative to the last
5982 location. Otherwise, it's absolute. Units can be
5983 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
5984 units, currently 1/100 mil.
5987 @item 1..MAX_BUFFER
5988 Selects the given buffer to be the current paste buffer.
5990 @end table
5992 %end-doc */
5994 static int
5996 {
6005 {
6007 {
6008 /* clear contents of paste buffer */
6013 /* copies objects to paste buffer */
6018 /* converts buffer contents into an element */
6023 /* break up element for editing */
6028 /* Mirror buffer */
6035 {
6038 }
6043 {
6046 }
6049 {
6057 {
6060 }
6062 {
6064 }
6066 }
6068 else
6071 {
6075 {
6080 }
6081 else
6086 }
6090 {
6096 {
6098 }
6100 {
6107 }
6108 else
6109 {
6112 }
6118 }
6121 /* set number */
6123 {
6126 /* correct number */
6129 }
6130 }
6131 }
6135 }
6137 /* --------------------------------------------------------------------------- */
6144 /* %start-doc actions Undo
6146 The unlimited undo feature of @code{Pcb} allows you to recover from
6147 most operations that materially affect you work. Calling
6148 @code{Undo()} without any parameter recovers from the last (non-undo)
6149 operation. @code{ClearList} is used to release the allocated
6150 memory. @code{ClearList} is called whenever a new layout is started or
6151 loaded. See also @code{Redo} and @code{Atomic}.
6153 Note that undo groups operations by serial number; changes with the
6154 same serial number will be undone (or redone) as a group. See
6155 @code{Atomic}.
6157 %end-doc */
6159 static int
6161 {
6164 {
6165 /* don't allow undo in the middle of an operation */
6172 /* undo the last operation */
6178 {
6182 }
6183 /* move anchor point if undoing during line creation */
6185 {
6187 {
6194 }
6196 {
6199 LineTypePtr ptr2;
6200 /* this search is guaranteed to succeed */
6207 /* save both ends of line */
6212 /* check that the undo was of the right type */
6214 {
6215 /* wrong undo type, restore anchor points */
6222 }
6223 /* move to new anchor */
6228 /* check if an intermediate point was removed */
6230 {
6231 /* this search should find the restored line */
6239 {
6240 /* undo loses FOUNDFLAG */
6243 }
6248 }
6252 {
6255 }
6256 else
6257 {
6258 /* this search is guaranteed to succeed too */
6266 }
6269 }
6270 }
6272 {
6274 {
6278 }
6280 {
6282 BoxTypePtr bx;
6283 /* guaranteed to succeed */
6295 }
6296 }
6297 /* undo the last destructive operation */
6300 }
6302 {
6304 {
6305 /* clear 'undo objects' list */
6309 }
6310 }
6313 }
6315 /* --------------------------------------------------------------------------- */
6321 /* %start-doc actions Redo
6323 This routine allows you to recover from the last undo command. You
6324 might want to do this if you thought that undo was going to revert
6325 something other than what it actually did (in case you are confused
6326 about which operations are un-doable), or if you have been backing up
6327 through a long undo list and over-shoot your stopping point. Any
6328 change that is made since the undo in question will trim the redo
6329 list. For example if you add ten lines, then undo three of them you
6330 could use redo to put them back, but if you move a line on the board
6331 before performing the redo, you will lose the ability to "redo" the
6332 three "undone" lines.
6334 %end-doc */
6336 static int
6338 {
6346 {
6350 {
6356 addedLines++;
6357 }
6358 }
6361 }
6363 /* --------------------------------------------------------------------------- */
6369 /* %start-doc actions Polygon
6371 Polygons need a special action routine to make life easier.
6373 @table @code
6375 @item Close
6376 Creates the final segment of the polygon. This may fail if clipping
6377 to 45 degree lines is switched on, in which case a warning is issued.
6379 @item PreviousPoint
6380 Resets the newly entered corner to the previous one. The Undo action
6381 will call Polygon(PreviousPoint) when appropriate to do so.
6383 @end table
6385 %end-doc */
6387 static int
6389 {
6392 {
6395 {
6396 /* close open polygon if possible */
6401 /* go back to the previous point */
6405 }
6407 }
6409 }
6411 /* --------------------------------------------------------------------------- */
6418 /* %start-doc actions RouteStyle
6420 %end-doc */
6422 static int
6424 {
6430 {
6433 {
6440 }
6441 }
6443 }
6446 /* --------------------------------------------------------------------------- */
6452 /* %start-doc actions MoveObject
6454 The @code{X} and @code{Y} are treated like @code{delta} is for many
6455 other objects. For each, if it's prefixed by @code{+} or @code{-},
6456 then that amount is relative. Otherwise, it's absolute. Units can be
6457 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6458 units, currently 1/100 mil.
6460 %end-doc */
6462 static int
6464 {
6478 {
6481 }
6494 }
6496 /* --------------------------------------------------------------------------- */
6504 /* %start-doc actions MoveToCurrentLayer
6506 Note that moving an element from a component layer to a solder layer,
6507 or from solder to component, won't automatically flip it. Use the
6508 @code{Flip()} action to do that.
6510 %end-doc */
6512 static int
6514 {
6517 {
6519 {
6521 {
6532 }
6539 }
6540 }
6542 }
6550 /* %start-doc actions SetSame
6552 When invoked over any line, arc, polygon, or via, this changes the
6553 current layer to be the layer that item is on, and changes the current
6554 sizes (thickness, keepaway, drill, etc) according to that item.
6556 %end-doc */
6558 static int
6560 {
6566 /* set layer current and size from line or arc */
6568 {
6608 }
6610 {
6613 }
6615 }
6618 /* --------------------------------------------------------------------------- */
6629 /* %start-doc actions SetFlag
6631 Turns the given flag on, regardless of its previous setting. See
6632 @code{ChangeFlag}.
6634 @example
6635 SetFlag(SelectedPins,thermal)
6636 @end example
6638 %end-doc */
6640 static int
6642 {
6647 }
6649 /* --------------------------------------------------------------------------- */
6660 /* %start-doc actions ClrFlag
6662 Turns the given flag off, regardless of its previous setting. See
6663 @code{ChangeFlag}.
6665 @example
6666 ClrFlag(SelectedLines,join)
6667 @end example
6669 %end-doc */
6671 static int
6673 {
6678 }
6680 /* --------------------------------------------------------------------------- */
6692 /* %start-doc actions ChangeFlag
6694 Toggles the given flag on the indicated object(s). The flag may be
6695 one of the flags listed above (square, octagon, thermal, join). The
6696 value may be the number 0 or 1. If the value is 0, the flag is
6697 cleared. If the value is 1, the flag is set.
6699 %end-doc */
6701 static int
6703 {
6712 }
6715 static void
6717 {
6722 {
6725 }
6727 {
6730 }
6732 {
6733 /* Note: these are backwards, because the flag is "clear" but
6734 the command is "join". */
6737 }
6738 else
6739 {
6742 }
6745 {
6747 {
6759 }
6801 }
6802 }
6804 /* --------------------------------------------------------------------------- */
6810 /* %start-doc actions ExecuteFile
6812 Lines starting with @code{#} are ignored.
6814 %end-doc */
6816 static int
6818 {
6831 {
6834 }
6839 {
6840 n++;
6843 /* eat the trailing newline */
6845 sp++;
6848 /* eat leading spaces and tabs */
6851 sp++;
6853 /*
6854 * if we have anything left and its not a comment line
6855 * then execute it
6856 */
6859 {
6860 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6862 }
6863 }
6867 {
6870 }
6873 }
6875 /* --------------------------------------------------------------------------- */
6877 static int
6879 {
6883 }
6885 /* --------------------------------------------------------------------------- */
6891 {
6898 {
6901 {
6904 }
6905 }
6906 END_LOOP;
6908 }
6912 {
6918 }
6920 static void
6922 {
6929 }
6931 /* ---------------------------------------------------------------- */
6932 static const char elementlist_syntax[] = "ElementList(Start|Done|Need,<refdes>,<footprint>,<value>)";
6936 /* %start-doc actions elementlist
6938 @table @code
6940 @item Start
6941 Indicates the start of an element list; call this before any Need
6942 actions.
6944 @item Need
6945 Searches the board for an element with a matching refdes.
6947 If found, the value and footprint are updated.
6949 If not found, a new element is created with the given footprint and value.
6951 @item Done
6952 Compares the list of elements needed since the most recent
6953 @code{start} with the list of elements actually on the board. Any
6954 elements that weren't listed are selected, so that the user may delete
6955 them.
6957 @end table
6959 %end-doc */
6963 static int
6965 {
6970 }
6972 static int
6974 {
6980 #ifdef DEBUG
6982 #endif
6985 {
6987 {
6989 }
6990 END_LOOP;
6994 }
6997 {
6999 {
7001 {
7003 }
7005 {
7006 /* Unnamed elements should remain untouched */
7008 }
7009 }
7010 END_LOOP;
7016 }
7024 argc --;
7025 argv ++;
7035 #ifdef DEBUG
7039 #endif
7044 {
7047 #ifdef DEBUG
7049 #endif
7050 /* Not on board, need to add it. */
7052 {
7053 number_of_footprints_not_found ++;
7055 }
7066 {
7069 }
7080 /* Place components onto center of board. */
7083 }
7086 {
7087 #ifdef DEBUG
7089 #endif
7094 /* Different footprint, we need to swap them out. */
7096 {
7097 number_of_footprints_not_found ++;
7099 }
7114 {
7119 }
7125 }
7127 /* Now reload footprint */
7140 #ifdef DEBUG
7142 #endif
7145 }
7147 /* ---------------------------------------------------------------- */
7152 /* %start-doc actions elementsetattr
7154 If a value is specified, the named attribute is added (if not already
7155 present) or changed (if it is) to the given value. If the value is
7156 not specified, the given attribute is removed if present.
7158 %end-doc */
7160 static int
7162 {
7168 {
7170 }
7177 {
7179 {
7182 }
7183 }
7184 END_LOOP;
7187 {
7190 }
7195 {
7198 }
7200 {
7202 }
7204 {
7206 }
7209 }
7211 /* ---------------------------------------------------------------- */
7216 /* %start-doc actions execcommand
7218 Runs the given command, which is a system executable.
7220 %end-doc */
7222 static int
7224 {
7228 {
7230 }
7237 }
7239 /* ---------------------------------------------------------------- */
7241 static int
7243 {
7244 #ifdef HAVE__SPAWNVP
7248 else
7250 #else
7254 {
7255 /* error */
7258 }
7260 {
7261 /* Child */
7264 }
7265 else
7266 {
7268 /* Parent */
7270 }
7272 #endif
7273 }
7275 /* ---------------------------------------------------------------- */
7276 /*
7277 * Creates a new temporary file name. Hopefully the operating system
7278 * provides a mkdtemp() function to securily create a temporary
7279 * directory with mode 0700. If so then that directory is created and
7280 * the returned string is made up of the directory plus the name
7281 * variable. For example:
7282 *
7283 * tempfile_name_new ("myfile") might return
7284 * "/var/tmp/pcb.123456/myfile".
7285 *
7286 * If mkdtemp() is not available then 'name' is ignored and the
7287 * insecure tmpnam() function is used.
7288 *
7289 * Files/names created with tempfile_name_new() should be unlinked
7290 * with tempfile_unlink to make sure the temporary directory is also
7291 * removed when mkdtemp() is used.
7292 */
7295 {
7297 #ifdef HAVE_MKDTEMP
7300 #endif
7304 #ifdef HAVE_MKDTEMP
7310 /* FIXME -- what about win32? */
7313 }
7323 }
7333 }
7340 ;
7350 #undef TEMPLATE
7351 #else
7352 /*
7353 * tmpnam() uses a static buffer so strdup() the result right away
7354 * in case someone decides to create multiple temp names.
7355 */
7357 #endif
7360 }
7362 /* ---------------------------------------------------------------- */
7363 /*
7364 * Unlink a temporary file. If we have mkdtemp() then our temp file
7365 * lives in a temporary directory and we need to remove that directory
7366 * too.
7367 */
7368 static int
7370 {
7371 #ifdef DEBUG
7372 /* SDB says: Want to keep old temp files for examiniation when debugging */
7374 #endif
7376 #ifdef HAVE_MKDTEMP
7381 /* it is possible that the file was never created so it is OK if the
7382 unlink fails */
7384 /* now figure out the directory name to remove */
7391 /*
7392 * at this point, e *should* point to the end of the directory part
7393 * but lets make sure.
7394 */
7399 }
7403 __FUNCTION__);
7407 }
7409 /* name was allocated with malloc */
7413 /*
7414 * FIXME - should also return -1 if the temp file exists and was not
7415 * removed.
7416 */
7419 }
7421 #else
7428 }
7431 #endif
7434 }
7436 /* ---------------------------------------------------------------- */
7445 /* %start-doc actions Import
7447 Imports element and netlist data from the schematics (or some other
7448 source). The first parameter, which is optional, is the mode. If not
7449 specified, the @code{import::mode} attribute in the PCB is used.
7450 @code{gnetlist} means gnetlist is used to obtain the information from
7451 the schematics. @code{make} invokes @code{make}, assuming the user
7452 has a @code{Makefile} in the current directory. The @code{Makefile}
7453 will be invoked with the following variables set:
7455 @table @code
7457 @item PCB
7458 The name of the .pcb file
7460 @item SRCLIST
7461 A space-separated list of source files
7463 @item OUT
7464 The name of the file in which to put the command script, which may
7465 contain any @pcb{} actions. By default, this is a temporary file
7466 selected by @pcb{}, but if you specify an @code{import::outfile}
7467 attribute, that file name is used instead (and not automatically
7468 deleted afterwards).
7470 @end table
7472 The target specified to be built is the first of these that apply:
7474 @itemize @bullet
7476 @item
7477 The target specified by an @code{import::target} attribute.
7479 @item
7480 The output file specified by an @code{import::outfile} attribute.
7482 @item
7483 If nothing else is specified, the target is @code{pcb_import}.
7485 @end itemize
7487 If you specify an @code{import::makefile} attribute, then "-f <that
7488 file>" will be added to the command line.
7490 If you specify the mode, you may also specify the source files
7491 (schematics). If you do not specify any, the list of schematics is
7492 obtained by reading the @code{import::src@var{N}} attributes (like
7493 @code{import::src0}, @code{import::src1}, etc).
7495 For compatibility with future extensions to the import file format,
7496 the generated file @emph{must not} start with the two characters
7497 @code{#%}.
7499 If a temporary file is needed the @code{TMPDIR} environment variable
7500 is used to select its location.
7502 Note that the programs @code{gnetlist} and @code{make} may be
7503 overridden by the user via the @code{make-program} and @code{gnetlist}
7504 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7505 line).
7507 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7508 is called to let user choose (see @code{ImportGUI()}).
7510 Note that Import() doesn't delete anything - after an Import, elements
7511 which shouldn't be on the board are selected and may be removed once
7512 it's determined that the deletion is appropriate.
7514 If @code{Import()} is called with @code{setnewpoint}, then the location
7515 of new components can be specified. This is where parts show up when
7516 they're added to the board. The default is the center of the board.
7518 @table @code
7520 @item Import(setnewpoint)
7522 Prompts the user to click on the board somewhere, uses that point. If
7523 called by a hotkey, uses the current location of the crosshair.
7525 @item Import(setnewpoint,mark)
7527 Uses the location of the mark. If no mark is present, the point is
7528 not changed.
7530 @item Import(setnewpoint,center)
7532 Resets the point to the center of the board.
7534 @item Import(setnewpoint,X,Y,units)
7536 Sets the point to the specific coordinates given. Example:
7537 @code{Import(setnewpoint,50,25,mm)}
7539 @end table
7541 Note that the X and Y locations are stored in attributes named
7542 @code{import::newX} and @code{import::newY} so you could change them
7543 manually if you wished.
7545 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7546 placed elements are dispersed relative to the set point. For example,
7547 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7548 10mm away from the point. The default dispersion is 1/10th of the
7549 smallest board dimension. Dispersion is saved in the
7550 @code{import::disperse} attribute.
7552 %end-doc */
7554 static int
7556 {
7561 #ifdef DEBUG
7563 #endif
7568 {
7575 {
7578 }
7580 {
7583 }
7584 else
7589 }
7592 {
7602 {
7604 }
7606 {
7610 }
7612 {
7614 {
7617 }
7618 }
7620 {
7623 }
7624 else
7625 {
7628 }
7635 }
7643 {
7646 }
7649 {
7655 nsources ++;
7661 {
7665 nsources ++;
7670 }
7671 }
7674 {
7675 /* Replace .pcb with .sch and hope for the best. */
7703 }
7706 {
7714 }
7727 #ifdef DEBUG
7731 #endif
7734 {
7737 }
7739 #ifdef DEBUG
7740 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7741 #endif
7749 }
7751 {
7771 else
7772 {
7777 }
7779 }
7787 {
7791 }
7800 {
7803 }
7808 {
7815 }
7826 }
7827 else
7828 {
7831 }
7836 #ifdef DEBUG
7838 #endif
7841 }
7843 /* ------------------------------------------------------------ */
7853 /* %start-doc actions Attributes
7855 This just pops up a dialog letting the user edit the attributes of the
7856 pcb, an element, or a layer.
7858 %end-doc */
7861 static int
7863 {
7872 {
7875 }
7878 {
7880 {
7883 }
7886 {
7889 {
7894 {
7897 }
7899 {
7902 }
7903 }
7909 }
7912 {
7916 {
7918 {
7920 n_found ++;
7921 }
7922 }
7923 END_LOOP;
7925 {
7928 }
7930 {
7937 else
7938 {
7941 }
7942 }
7945 {
7948 }
7949 else
7950 {
7952 }
7956 }
7960 }
7963 }
7965 /* --------------------------------------------------------------------------- */
7967 HID_Action action_action_list[] = {
7970 ,
7973 ,
7976 ,
7979 ,
7982 ,
7985 ,
7988 ,
7991 ,
7994 ,
7997 ,
8000 ,
8003 ,
8006 ,
8009 ,
8012 ,
8015 ,
8018 ,
8021 ,
8024 ,
8027 ,
8030 ,
8033 ,
8036 ,
8039 ,
8042 ,
8045 ,
8048 ,
8051 ,
8054 ,
8057 ,
8060 ,
8063 ,
8066 ,
8069 ,
8072 ,
8075 ,
8078 ,
8081 ,
8084 ,
8087 ,
8090 ,
8093 ,
8096 ,
8099 ,
8102 ,
8105 ,
8108 ,
8111 ,
8114 ,
8117 ,
8120 ,
8123 ,
8126 ,
8129 ,
8132 ,
8135 ,
8138 ,
8141 ,
8143 ,
8146 ,
8149 ,
8152 ,
8155 ,
8156 };