| blob | c075d10d5d7e772f13ed9308fefe08c7706dda7c |
1 /*
2 * COPYRIGHT
3 *
4 * PCB, interactive printed circuit board design
5 * Copyright (C) 1994,1995,1996 Thomas Nau
6 * Copyright (C) 1997, 1998, 1999, 2000, 2001 Harry Eaton
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 * Contact addresses for paper mail and Email:
23 * Harry Eaton, 6697 Buttonhole Ct, Columbia, MD 21044, USA
24 * haceaton@aplcomm.jhuapl.edu
25 *
26 */
28 /* action routines for output window
29 */
31 #ifdef HAVE_CONFIG_H
33 #endif
59 /*#include "print.h"*/
74 #include <assert.h>
77 #ifdef HAVE_LIBDMALLOC
78 #include <dmalloc.h>
79 #endif
81 /* for fork() and friends */
82 #ifdef HAVE_UNISTD_H
83 #include <unistd.h>
84 #endif
86 #ifdef HAVE_SYS_WAIT_H
87 #include <sys/wait.h>
88 #endif
90 /* ---------------------------------------------------------------------------
91 * some local types
92 */
94 {
95 F_AddSelected,
96 F_All,
97 F_AllConnections,
98 F_AllRats,
99 F_AllUnusedPins,
100 F_Arc,
101 F_Arrow,
102 F_Block,
103 F_Description,
104 F_Cancel,
105 F_Center,
106 F_Clear,
107 F_ClearAndRedraw,
108 F_ClearList,
109 F_Close,
110 F_Connection,
111 F_Convert,
112 F_Copy,
113 F_CycleClip,
114 F_CycleCrosshair,
115 F_DeleteRats,
116 F_Drag,
117 F_DrillReport,
118 F_Element,
119 F_ElementByName,
120 F_ElementConnections,
121 F_ElementToBuffer,
122 F_Escape,
123 F_Find,
124 F_FlipElement,
125 F_FoundPins,
126 F_Grid,
127 F_InsertPoint,
128 F_Layer,
129 F_Layout,
130 F_LayoutAs,
131 F_LayoutToBuffer,
132 F_Line,
133 F_LineSize,
134 F_Lock,
135 F_Mirror,
136 F_Move,
137 F_NameOnPCB,
138 F_Netlist,
139 F_NetByName,
140 F_None,
141 F_Notify,
142 F_Object,
143 F_ObjectByName,
144 F_PasteBuffer,
145 F_PadByName,
146 F_PinByName,
147 F_PinOrPadName,
148 F_Pinout,
149 F_Polygon,
150 F_PolygonHole,
151 F_PreviousPoint,
152 F_RatsNest,
153 F_Rectangle,
154 F_Redraw,
155 F_Release,
156 F_Revert,
157 F_Remove,
158 F_RemoveSelected,
159 F_Report,
160 F_Reset,
161 F_ResetLinesAndPolygons,
162 F_ResetPinsViasAndPads,
163 F_Restore,
164 F_Rotate,
165 F_Save,
166 F_Selected,
167 F_SelectedArcs,
168 F_SelectedElements,
169 F_SelectedLines,
170 F_SelectedNames,
171 F_SelectedObjects,
172 F_SelectedPads,
173 F_SelectedPins,
174 F_SelectedTexts,
175 F_SelectedVias,
176 F_SelectedRats,
177 F_Stroke,
178 F_Text,
179 F_TextByName,
180 F_TextScale,
181 F_Thermal,
182 F_ToLayout,
183 F_ToggleAllDirections,
184 F_ToggleAutoDRC,
185 F_ToggleClearLine,
186 F_ToggleFullPoly,
187 F_ToggleGrid,
188 F_ToggleHideNames,
189 F_ToggleMask,
190 F_ToggleName,
191 F_ToggleObject,
192 F_ToggleShowDRC,
193 F_ToggleLiveRoute,
194 F_ToggleRubberBandMode,
195 F_ToggleStartDirection,
196 F_ToggleSnapPin,
197 F_ToggleThindraw,
198 F_ToggleLockNames,
199 F_ToggleOnlyNames,
200 F_ToggleThindrawPoly,
201 F_ToggleOrthoMove,
202 F_ToggleLocalRef,
203 F_ToggleCheckPlanes,
204 F_ToggleUniqueNames,
205 F_Via,
206 F_ViaByName,
207 F_Value,
208 F_ViaDrillingHole,
209 F_ViaSize,
210 F_Zoom
211 }
212 FunctionID;
215 {
217 FunctionID ID;
218 }
219 FunctionType;
221 /* --------------------------------------------------------------------------- */
223 /* %start-doc actions 00delta
225 Many actions take a @code{delta} parameter as the last parameter,
226 which is an amount to change something. That @code{delta} may include
227 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
228 If no units are specified, the default is PCB's native units
229 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
230 @code{-}, the size is increased or decreased by that amount.
231 Otherwise, the size size is set to the given amount.
233 @example
234 Action(Object,5,mil)
235 Action(Object,+0.5,mm)
236 Action(Object,-1)
237 @end example
239 Actions which take a @code{delta} parameter which do not accept all
240 these options will specify what they do take.
242 %end-doc */
244 /* %start-doc actions 00objects
246 Many actions act on indicated objects on the board. They will have
247 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
248 what group of objects they act on. Unless otherwise specified, these
249 parameters are defined as follows:
251 @table @code
253 @item Object
254 @itemx ToggleObject
255 Affects the object under the mouse pointer. If this action is invoked
256 from a menu or script, the user will be prompted to click on an
257 object, which is then the object affected.
259 @item Selected
260 @itemx SelectedObjects
262 Affects all objects which are currently selected. At least, all
263 selected objects for which the given action makes sense.
265 @item SelectedPins
266 @itemx SelectedVias
267 @itemx Selected@var{Type}
268 @itemx @i{etc}
269 Affects all objects which are both selected and of the @var{Type} specified.
271 @end table
273 %end-doc */
275 /* %start-doc actions 00macros
277 @macro pinshapes
279 Pins, pads, and vias can have various shapes. All may be round. Pins
280 and pads may be square (obviously "square" pads are usually
281 rectangular). Pins and vias may be octagonal. When you change a
282 shape flag of an element, you actually change all of its pins and
283 pads.
285 Note that the square flag takes precedence over the octagon flag,
286 thus, if both the square and octagon flags are set, the object is
287 square. When the square flag is cleared, the pins and pads will be
288 either round or, if the octagon flag is set, octagonal.
290 @end macro
292 %end-doc */
294 /* ---------------------------------------------------------------------------
295 * some local identifiers
296 */
299 static struct
300 {
302 LineType line;
303 }
304 fake;
306 static struct
307 {
309 Cardinal Buffer;
316 }
317 Note;
324 #ifdef HAVE_LIBSTROKE
327 #endif
445 };
447 /* ---------------------------------------------------------------------------
448 * some local routines
449 */
456 #ifdef HAVE_LIBSTROKE
461 #endif
464 #define ARG(n) (argc > (n) ? argv[n] : NULL)
466 #ifdef HAVE_LIBSTROKE
468 /* ---------------------------------------------------------------------------
469 * FinishStroke - try to recognize the stroke sent
470 */
471 void
473 {
481 {
484 {
487 {
489 }
544 {
548 /* XXX: PCB->MaxWidth and PCB->MaxHeight may be the wrong
549 * divisors below. The old code WAS broken, but this
550 * replacement has not been tested for correctness.
551 */
552 z =
556 z =
565 }
570 }
571 }
572 else
574 }
575 #endif
577 /* ---------------------------------------------------------------------------
578 * Clear warning color from pins/pads
579 */
580 static void
582 {
585 {
587 {
590 }
591 }
592 ENDALL_LOOP;
594 {
596 {
599 }
600 }
601 ENDALL_LOOP;
603 }
605 static void
607 {
609 {
613 {
623 }
625 {
634 }
635 else
636 {
637 BoxType box;
646 /* unselect first if shift key not down */
652 }
654 }
655 }
657 static void
659 {
660 BoxType box;
663 {
664 BoxType box;
673 /* unselect first if shift key not down */
675 {
679 {
683 }
684 }
690 }
692 {
699 }
701 {
704 }
706 {
721 }
725 }
727 /* ---------------------------------------------------------------------------
728 * get function ID of passed string
729 */
730 #define HSIZE 257
734 static int
736 {
739 {
742 s ++;
743 }
746 }
748 static int
750 {
757 {
760 {
764 }
766 {
767 /* Change 'char' to 'int' and remove this when we get to 256
768 strings to hash. */
773 }
775 {
780 }
781 }
785 {
786 /* We enforce the "hash table bigger than function table" rule,
787 so we know there will be at least one zero entry to find. */
793 }
794 }
796 /* ---------------------------------------------------------------------------
797 * set new coordinates if in 'RECTANGLE' mode
798 * the cursor shape is also adjusted
799 */
800 static void
802 {
804 {
807 }
809 {
811 {
812 /* update coordinates */
816 }
817 }
818 }
820 /* ---------------------------------------------------------------------------
821 * adjusts the objects which are to be created like attached lines...
822 */
823 void
825 {
828 {
829 /* update at least an attached block (selection) */
833 {
836 }
839 /* rectangle creation mode */
845 /* polygon creation mode */
850 /* line creation mode */
854 else
857 /* point insertion mode */
865 }
866 }
868 /* ---------------------------------------------------------------------------
869 * creates points of a line
870 */
871 static void
873 {
880 {
885 {
888 }
890 {
895 FOUNDFLAG);
896 }
898 {
903 }
905 {
910 {
913 }
914 else
915 {
918 }
919 }
920 else
921 {
926 }
931 /* fall through to third state too */
936 }
937 }
939 /* ---------------------------------------------------------------------------
940 * create first or second corner of a marked block
941 */
942 static void
944 {
947 {
959 }
961 }
964 /* ---------------------------------------------------------------------------
965 *
966 * does what's appropriate for the current mode setting. This normally
967 * means creation of an object at the current crosshair location.
968 *
969 * new created objects are added to the create undo list of course
970 */
971 static void
973 {
980 {
982 {
984 hidval hv;
987 /* do something after click time */
990 /* see if we clicked on something already selected
991 * (Note.Moving) or clicked on a MOVE_TYPE
992 * (Note.Hit)
993 */
996 {
1000 {
1005 }
1011 }
1013 }
1016 {
1020 {
1024 }
1029 {
1036 }
1038 }
1041 {
1043 {
1054 {
1062 {
1066 #ifdef ARC45
1069 else
1070 #endif
1072 }
1073 else
1074 {
1078 #ifdef ARC45
1081 else
1082 #endif
1085 }
1087 Crosshair.
1088 AttachedBox.
1090 Crosshair.
1091 AttachedBox.
1095 sa,
1096 dir,
1097 Settings.
1098 LineThickness,
1100 Keepaway,
1101 MakeFlags
1102 (TEST_FLAG
1104 PCB) ?
1105 CLEARLINEFLAG :
1107 {
1117 addedLines++;
1121 }
1123 }
1124 }
1126 }
1128 {
1131 {
1136 {
1139 }
1140 END_LOOP;
1142 {
1145 }
1146 END_LOOP;
1148 /* always re-draw it since I'm too lazy
1149 * to tell if a selected flag changed
1150 */
1155 }
1157 {
1162 {
1163 /* this is not un-doable since LOCK isn't */
1167 }
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 {
1220 {
1221 addedLines++;
1230 }
1232 }
1233 else
1234 /* create line if both ends are determined && length != 0 */
1235 {
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 {
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 {
1366 Crosshair.
1368 Crosshair.
1370 Crosshair.
1372 Crosshair.
1374 MakeFlags
1376 NULL)
1377 {
1383 }
1385 /* reset state to 'first corner' */
1387 }
1391 {
1395 {
1397 {
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 {
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 {
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 {
2180 {
2183 {
2194 else
2195 {
2199 /* On the way down, short against the minimum
2200 * PCB drawing unit */
2205 else
2207 }
2235 }
2238 }
2241 }
2244 /* --------------------------------------------------------------------------- */
2250 /* %start-doc actions Quit
2252 If you have unsaved changes, you will be prompted to confirm (or
2253 save) before quitting.
2255 %end-doc */
2257 static int
2259 {
2262 {
2265 }
2269 }
2271 /* --------------------------------------------------------------------------- */
2279 /* %start-doc actions Connection
2281 Connections found with this action will be highlighted in the
2282 ``connected-color'' color and will have the ``found'' flag set.
2284 @table @code
2286 @item Find
2287 The net under the cursor is ``found''.
2289 @item ResetLinesAndPolygons
2290 Any ``found'' lines and polygons are marked ``not found''.
2292 @item ResetPinsAndVias
2293 Any ``found'' pins and vias are marked ``not found''.
2295 @item Reset
2296 All ``found'' objects are marked ``not found''.
2298 @end table
2300 %end-doc */
2302 static int
2304 {
2307 {
2309 {
2311 {
2315 }
2319 {
2322 }
2327 {
2330 }
2335 {
2338 }
2340 }
2342 }
2345 }
2347 /* --------------------------------------------------------------------------- */
2354 /* %start-doc actions DisperseElements
2356 Normally this is used when starting a board, by selecting all elements
2357 and then dispersing them. This scatters the elements around the board
2358 so that you can pick individual ones, rather than have all the
2359 elements at the same 0,0 coordinate and thus impossible to choose
2360 from.
2362 %end-doc */
2364 #define GAP MIL_TO_COORD(100)
2366 static int
2368 {
2377 {
2379 }
2380 else
2381 {
2383 {
2394 }
2395 }
2398 {
2400 }
2404 {
2405 /*
2406 * If we want to disperse selected elements, maybe we need smarter
2407 * code here to avoid putting components on top of others which
2408 * are not selected. For now, I'm assuming that this is typically
2409 * going to be used either with a brand new design or a scratch
2410 * design holding some new components
2411 */
2413 {
2415 /* figure out how much to move the element */
2418 /* snap to the grid */
2421 /*
2422 * and add one grid size so we make sure we always space by GAP or
2423 * more
2424 */
2427 /* Figure out if this row has room. If not, start a new row */
2429 {
2432 }
2434 /* figure out how much to move the element */
2438 /* snap to the grid */
2444 /* move the element */
2447 /* and add to the undo list so we can undo this operation */
2450 /* keep track of how tall this row is */
2453 {
2455 }
2456 }
2458 }
2459 END_LOOP;
2461 /* done with our action so increment the undo # */
2468 }
2470 #undef GAP
2472 /* --------------------------------------------------------------------------- */
2487 /* %start-doc actions Display
2489 @table @code
2491 @item NameOnPCB
2492 @item Description
2493 @item Value
2494 Specify whether all elements show their name, description, or value.
2496 @item Redraw
2497 Redraw the whole board.
2499 @item Toggle45Degree
2500 When clear, lines can be drawn at any angle. When set, lines are
2501 restricted to multiples of 45 degrees and requested lines may be
2502 broken up according to the clip setting.
2504 @item CycleClip
2505 Changes the way lines are restricted to 45 degree increments. The
2506 various settings are: straight only, orthogonal then angled, and angled
2507 then orthogonal. If AllDirections is set, this action disables it.
2509 @item CycleCrosshair
2510 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2511 8-ray and 12-ray cross.
2513 @item ToggleRubberBandMode
2514 If set, moving an object moves all the lines attached to it too.
2516 @item ToggleStartDirection
2517 If set, each time you set a point in a line, the Clip toggles between
2518 orth-angle and angle-ortho.
2520 @item ToggleUniqueNames
2521 If set, you will not be permitted to change the name of an element to
2522 match that of another element.
2524 @item ToggleSnapPin
2525 If set, pin centers and pad end points are treated as additional grid
2526 points that the cursor can snap to.
2528 @item ToggleLocalRef
2529 If set, the mark is automatically set to the beginning of any move, so
2530 you can see the relative distance you've moved.
2532 @item ToggleThindraw
2533 If set, objects on the screen are drawn as outlines (lines are drawn
2534 as center-lines). This lets you see line endpoints hidden under pins,
2535 for example.
2537 @item ToggleThindrawPoly
2538 If set, polygons on the screen are drawn as outlines.
2540 @item ToggleShowDRC
2541 If set, pending objects (i.e. lines you're in the process of drawing)
2542 will be drawn with an outline showing how far away from other copper
2543 you need to be.
2545 @item ToggleLiveRoute
2546 If set, the progress of the autorouter will be visible on the screen.
2548 @item ToggleAutoDRC
2549 If set, you will not be permitted to make connections which violate
2550 the current DRC and netlist settings.
2552 @item ToggleCheckPlanes
2553 If set, lines and arcs aren't drawn, which usually leaves just the
2554 polygons. If you also disable all but the layer you're interested in,
2555 this allows you to check for isolated regions.
2557 @item ToggleOrthoMove
2558 If set, the crosshair is only allowed to move orthogonally from its
2559 previous position. I.e. you can move an element or line up, down,
2560 left, or right, but not up+left or down+right.
2562 @item ToggleName
2563 Selects whether the pinouts show the pin names or the pin numbers.
2565 @item ToggleLockNames
2566 If set, text will ignore left mouse clicks and actions that work on
2567 objects under the mouse. You can still select text with a lasso (left
2568 mouse drag) and perform actions on the selection.
2570 @item ToggleOnlyNames
2571 If set, only text will be sensitive for mouse clicks and actions that
2572 work on objects under the mouse. You can still select other objects
2573 with a lasso (left mouse drag) and perform actions on the selection.
2575 @item ToggleMask
2576 Turns the solder mask on or off.
2578 @item ToggleClearLine
2579 When set, the clear-line flag causes new lines and arcs to have their
2580 ``clear polygons'' flag set, so they won't be electrically connected
2581 to any polygons they overlap.
2583 @item ToggleFullPoly
2584 When set, the full-poly flag causes new polygons to have their
2585 ``full polygon'' flag set, so all parts of them will be displayed
2586 instead of only the biggest one.
2588 @item ToggleGrid
2589 Resets the origin of the current grid to be wherever the mouse pointer
2590 is (not where the crosshair currently is). If you provide two numbers
2591 after this, the origin is set to that coordinate.
2593 @item Grid
2594 Toggles whether the grid is displayed or not.
2596 @item Pinout
2597 Causes the pinout of the element indicated by the cursor to be
2598 displayed, usually in a separate window.
2600 @item PinOrPadName
2601 Toggles whether the names of pins, pads, or (yes) vias will be
2602 displayed. If the cursor is over an element, all of its pins and pads
2603 are affected.
2605 @end table
2607 %end-doc */
2609 static enum crosshair_shape
2611 {
2613 {
2626 }
2628 }
2630 static int
2632 {
2641 {
2643 {
2645 /* redraw layout */
2651 /* change the displayed name of elements */
2656 {
2658 }
2659 END_LOOP;
2662 {
2671 }
2673 {
2675 }
2676 END_LOOP;
2680 /* toggle line-adjust flag */
2689 {
2692 }
2693 else
2770 {
2772 {
2775 }
2779 FOUNDFLAG);
2780 }
2811 /* shift grid alignment */
2813 {
2820 }
2823 /* toggle displaying of the grid */
2829 /* display the pinout of an element */
2831 {
2840 {
2843 }
2845 }
2847 /* toggle displaying of pin/pad/via names */
2849 {
2856 {
2859 {
2862 else
2866 }
2867 END_LOOP;
2869 {
2872 else
2876 }
2877 END_LOOP;
2886 else
2898 else
2909 else
2917 }
2919 }
2922 }
2923 }
2925 {
2927 {
2930 {
2935 }
2941 }
2942 }
2948 }
2950 /* --------------------------------------------------------------------------- */
2960 /* %start-doc actions Mode
2962 @table @code
2964 @item Arc
2965 @itemx Arrow
2966 @itemx Copy
2967 @itemx InsertPoint
2968 @itemx Line
2969 @itemx Lock
2970 @itemx Move
2971 @itemx None
2972 @itemx PasteBuffer
2973 @itemx Polygon
2974 @itemx Rectangle
2975 @itemx Remove
2976 @itemx Rotate
2977 @itemx Text
2978 @itemx Thermal
2979 @itemx Via
2980 Select the indicated tool.
2982 @item Notify
2983 Called when you press the mouse button, or move the mouse.
2985 @item Release
2986 Called when you release the mouse button.
2988 @item Cancel
2989 Cancels any pending tool activity, allowing you to restart elsewhere.
2990 For example, this allows you to start a new line rather than attach a
2991 line to the previous line.
2993 @item Escape
2994 Similar to Cancel but calling this action a second time will return
2995 to the Arrow tool.
2997 @item Stroke
2998 If your @code{pcb} was built with libstroke, this invokes the stroke
2999 input method. If not, this will restart a drawing mode if you were
3000 drawing, else it will select objects.
3002 @item Save
3003 Remembers the current tool.
3005 @item Restore
3006 Restores the tool to the last saved tool.
3008 @end table
3010 %end-doc */
3012 static int
3014 {
3018 {
3023 {
3049 {
3053 }
3056 {
3058 {
3077 else
3078 {
3081 }
3087 else
3088 {
3091 }
3097 else
3098 {
3101 }
3107 else
3108 {
3111 }
3117 else
3118 {
3121 }
3129 }
3130 }
3145 #ifndef HAVE_LIBSTROKE
3149 #else
3153 else
3156 #endif
3167 #ifdef HAVE_LIBSTROKE
3172 #else
3173 /* Handle middle mouse button restarts of drawing mode. If not in
3174 | a drawing mode, middle mouse button will select objects.
3175 */
3178 {
3180 }
3190 else
3191 {
3196 }
3198 #endif
3216 }
3219 }
3222 }
3224 /* --------------------------------------------------------------------------- */
3230 /* %start-doc actions RemoveSelected
3232 %end-doc */
3234 static int
3236 {
3240 }
3242 /* --------------------------------------------------------------------------- */
3251 /* %start-doc actions Renumber
3253 %end-doc */
3255 static int
3257 {
3269 struct _cnt_list
3270 {
3280 {
3281 /*
3282 * We deal with the case where name already exists in this
3283 * function so the GUI doesn't need to deal with it
3284 */
3293 }
3294 else
3298 {
3301 }
3304 {
3306 }
3309 {
3312 {
3316 }
3317 }
3320 {
3325 }
3333 /*
3334 * Make a first pass through all of the elements and sort them out
3335 * by location on the board. While here we also collect a list of
3336 * locked elements.
3337 *
3338 * We'll actually renumber things in the 2nd pass.
3339 */
3346 {
3349 }
3355 {
3357 {
3358 /*
3359 * add to the list of locked elements which we won't try to
3360 * renumber and whose reference designators are now reserved.
3361 */
3366 lock_cnt++;
3367 }
3369 else
3370 {
3371 /* count of devices which will be renumbered */
3372 cnt++;
3374 /* search for correct position in the list */
3377 i++;
3379 /*
3380 * We have found the position where we have the first element that
3381 * has the same Y value or a lower Y value. Now move forward if
3382 * needed through the X values
3383 */
3387 i++;
3390 {
3392 }
3394 }
3395 }
3396 END_LOOP;
3399 /*
3400 * Now that the elements are sorted by board position, we go through
3401 * and renumber them.
3402 */
3404 /*
3405 * turn off the flag which requires unique names so it doesn't get
3406 * in our way. When we're done with the renumber we will have unique
3407 * names.
3408 */
3414 {
3415 /* If there is no refdes, maybe just spit out a warning */
3417 {
3418 /* figure out the prefix */
3423 j++;
3426 /* check the counter for this prefix */
3431 /* grow the list if needed */
3433 {
3437 {
3440 }
3441 /* zero out the memory that we added */
3443 {
3446 }
3447 }
3449 /*
3450 * start a new counter if we don't have a counter for this
3451 * prefix
3452 */
3454 {
3457 }
3459 /*
3460 * check to see if the new refdes is already used by a
3461 * locked element
3462 */
3463 do
3464 {
3469 /* space for the prefix plus 1 digit plus the '\0' */
3472 /* and 1 more per extra digit needed to hold the number */
3475 {
3476 sz++;
3478 }
3482 /*
3483 * now compare to the list of reserved (by locked
3484 * elements) names
3485 */
3487 {
3491 {
3494 }
3495 }
3497 }
3501 {
3505 /* add this rename to our table of renames so we can update the netlist */
3508 c_cnt++;
3516 tmps);
3519 /* we don't free tmps in this case because it is used */
3520 }
3521 else
3523 }
3524 else
3525 {
3528 }
3530 }
3534 /* restore the unique flag setting */
3539 {
3541 /* update the netlist */
3544 /* iterate over each net */
3546 {
3548 /* iterate over each pin on the net */
3550 {
3552 /* figure out the pin number part from strings like U3-21 */
3558 /* iterate over the list of changed reference designators */
3560 {
3561 /*
3562 * if the pin needs to change, change it and quit
3563 * searching in the list.
3564 */
3566 {
3574 }
3576 }
3578 }
3579 }
3581 {
3584 }
3589 }
3595 }
3598 /* --------------------------------------------------------------------------- */
3605 /* %start-doc actions RipUp
3607 @table @code
3609 @item All
3610 Removes all lines and vias which were created by the autorouter.
3612 @item Selected
3613 Removes all selected lines and vias which were created by the
3614 autorouter.
3616 @item Element
3617 Converts the element under the cursor to parts (vias and lines). Note
3618 that this uses the highest numbered paste buffer.
3620 @end table
3622 %end-doc */
3624 static int
3626 {
3631 {
3633 {
3636 {
3638 {
3641 }
3642 }
3643 ENDALL_LOOP;
3645 {
3647 {
3650 }
3651 }
3652 ENDALL_LOOP;
3654 {
3656 {
3659 }
3660 }
3661 END_LOOP;
3664 {
3667 }
3671 {
3674 {
3677 }
3678 }
3679 ENDALL_LOOP;
3682 {
3685 {
3688 }
3689 }
3690 END_LOOP;
3692 {
3695 }
3698 {
3703 {
3719 }
3720 }
3722 }
3723 }
3725 }
3727 /* --------------------------------------------------------------------------- */
3733 /* %start-doc actions AddRats
3735 @table @code
3737 @item AllRats
3738 Create rat lines for all loaded nets that aren't already connected on
3739 with copper.
3741 @item SelectedRats
3742 Similarly, but only add rat lines for nets connected to selected pins
3743 and pads.
3745 @item Close
3746 Selects the shortest unselected rat on the board.
3748 @end table
3750 %end-doc */
3752 static int
3754 {
3760 {
3764 {
3778 {
3784 {
3787 }
3788 }
3789 END_LOOP;
3791 {
3798 }
3800 }
3801 }
3803 }
3805 /* --------------------------------------------------------------------------- */
3813 /* %start-doc actions Delete
3815 %end-doc */
3817 static int
3819 {
3827 {
3830 }
3833 {
3851 }
3854 }
3856 /* --------------------------------------------------------------------------- */
3863 /* %start-doc actions DeleteRats
3865 %end-doc */
3867 static int
3869 {
3872 {
3876 {
3886 }
3887 }
3889 }
3891 /* --------------------------------------------------------------------------- */
3897 /* %start-doc actions AutoPlaceSelected
3899 Attempts to re-arrange the selected components such that the nets
3900 connecting them are minimized. Note that you cannot undo this.
3902 %end-doc */
3904 static int
3906 {
3910 {
3913 }
3915 }
3917 /* --------------------------------------------------------------------------- */
3923 /* %start-doc actions AutoRoute
3925 @table @code
3927 @item AllRats
3928 Attempt to autoroute all rats.
3930 @item SelectedRats
3931 Attempt to autoroute the selected rats.
3933 @end table
3935 Before autorouting, it's important to set up a few things. First,
3936 make sure any layers you aren't using are disabled, else the
3937 autorouter may use them. Next, make sure the current line and via
3938 styles are set accordingly. Last, make sure "new lines clear
3939 polygons" is set, in case you eventually want to add a copper pour.
3941 Autorouting takes a while. During this time, the program may not be
3942 responsive.
3944 %end-doc */
3946 static int
3948 {
3952 {
3954 {
3964 }
3965 }
3967 }
3969 /* --------------------------------------------------------------------------- */
3977 /* %start-doc actions MarkCrosshair
3979 The ``mark'' is a small X-shaped target on the display which is
3980 treated like a second origin (the normal origin is the upper let
3981 corner of the board). The GUI will display a second set of
3982 coordinates for this mark, which tells you how far you are from it.
3984 If no argument is given, the mark is toggled - disabled if it was
3985 enabled, or enabled at the current cursor position of disabled. If
3986 the @code{Center} argument is given, the mark is moved to the current
3987 cursor location.
3989 %end-doc */
3991 static int
3993 {
3996 {
3998 {
4002 }
4003 else
4004 {
4011 }
4012 }
4014 {
4020 }
4022 }
4024 /* --------------------------------------------------------------------------- */
4035 /* %start-doc actions ChangeSize
4037 For lines and arcs, this changes the width. For pins and vias, this
4038 changes the overall diameter of the copper annulus. For pads, this
4039 changes the width and, indirectly, the length. For texts and names,
4040 this changes the scaling factor. For elements, this changes the width
4041 of the silk layer lines and arcs for this element.
4043 %end-doc */
4045 static int
4047 {
4052 Coord value;
4055 {
4061 {
4063 {
4075 }
4122 }
4123 }
4125 }
4127 /* --------------------------------------------------------------------------- */
4136 /* %start-doc actions ChangeDrillSize
4138 %end-doc */
4140 static int
4142 {
4147 Coord value;
4150 {
4153 {
4155 {
4167 }
4183 }
4184 }
4186 }
4188 /* --------------------------------------------------------------------------- */
4199 /* %start-doc actions ChangeClearSize
4201 If the solder mask is currently showing, this action changes the
4202 solder mask clearance. If the mask is not showing, this action
4203 changes the polygon clearance.
4205 %end-doc */
4207 static int
4209 {
4214 Coord value;
4217 {
4223 {
4225 {
4237 }
4263 }
4264 }
4266 }
4268 /* --------------------------------------------------------------------------- */
4277 /* %start-doc actions MinMaskGap
4279 Checks all specified pins and/or pads, and increases the mask if
4280 needed to ensure a minimum distance between the pin or pad edge and
4281 the mask edge.
4283 %end-doc */
4285 static int
4287 {
4292 Coord value;
4299 else
4300 {
4304 }
4309 {
4311 {
4315 {
4319 }
4320 }
4321 END_LOOP;
4323 {
4327 {
4331 }
4332 }
4333 END_LOOP;
4334 }
4335 END_LOOP;
4337 {
4341 {
4344 }
4345 }
4346 END_LOOP;
4350 }
4352 /* --------------------------------------------------------------------------- */
4361 /* %start-doc actions MinClearGap
4363 Checks all specified objects, and increases the polygon clearance if
4364 needed to ensure a minimum distance between their edges and the
4365 polygon edges.
4367 %end-doc */
4369 static int
4371 {
4376 Coord value;
4383 else
4384 {
4388 }
4393 {
4395 {
4399 {
4403 }
4404 }
4405 END_LOOP;
4407 {
4411 {
4415 }
4416 }
4417 END_LOOP;
4418 }
4419 END_LOOP;
4421 {
4425 {
4428 }
4429 }
4430 END_LOOP;
4432 {
4436 {
4439 }
4440 }
4441 ENDALL_LOOP;
4443 {
4447 {
4450 }
4451 }
4452 ENDALL_LOOP;
4456 }
4458 /* --------------------------------------------------------------------------- */
4466 /* %start-doc actions ChangePinName
4468 This can be especially useful for annotating pin names from a
4469 schematic to the layout without requiring knowledge of the pcb file
4470 format.
4472 @example
4473 ChangePinName(U3, 7, VCC)
4474 @end example
4476 %end-doc */
4478 static int
4480 {
4485 {
4487 }
4494 {
4496 {
4498 {
4500 {
4503 /*
4504 * Note: we can't free() pin->Name first because
4505 * it is used in the undo list
4506 */
4510 }
4511 }
4512 END_LOOP;
4515 {
4517 {
4520 /*
4521 * Note: we can't free() pad->Name first because
4522 * it is used in the undo list
4523 */
4527 }
4528 }
4529 END_LOOP;
4530 }
4531 }
4532 END_LOOP;
4533 /*
4534 * done with our action so increment the undo # if we actually
4535 * changed anything
4536 */
4538 {
4541 else
4542 {
4545 }
4546 }
4549 }
4551 /* --------------------------------------------------------------------------- */
4559 /* %start-doc actions ChangeName
4561 @table @code
4563 @item Object
4564 Changes the name of the element under the cursor.
4566 @item Layout
4567 Changes the name of the layout. This is printed on the fab drawings.
4569 @item Layer
4570 Changes the name of the currently active layer.
4572 @end table
4574 %end-doc */
4576 int
4578 {
4583 {
4585 {
4586 /* change the name of an object */
4588 {
4596 {
4599 {
4602 {
4612 {
4618 }
4621 }
4622 }
4623 }
4625 }
4627 /* change the layout's name */
4629 name =
4631 /* NB: ChangeLayoutName takes ownership of the passed memory */
4636 /* change the name of the active layer */
4640 /* NB: ChangeLayerName takes ownership of the passed memory */
4644 }
4645 }
4647 }
4650 /* --------------------------------------------------------------------------- */
4657 /* %start-doc actions MorphPolygon
4659 If a polygon is divided into unconnected "islands", you can use
4660 this command to convert the otherwise disappeared islands into
4661 separate polygons. Be sure the cursor is over a portion of the
4662 polygon that remains visible. Very small islands that may flake
4663 off are automatically deleted.
4665 %end-doc */
4667 static int
4669 {
4672 {
4674 {
4676 {
4683 {
4687 }
4689 }
4693 {
4696 }
4697 ENDALL_LOOP;
4701 }
4702 }
4704 }
4706 /* --------------------------------------------------------------------------- */
4714 /* %start-doc actions ToggleHideName
4716 If names are hidden you won't see them on the screen and they will not
4717 appear on the silk layer when you print the layout.
4719 %end-doc */
4721 static int
4723 {
4726 {
4728 {
4730 {
4737 {
4744 }
4746 }
4749 {
4752 {
4757 {
4764 }
4765 }
4766 END_LOOP;
4768 {
4771 }
4772 }
4773 }
4774 }
4776 }
4778 /* --------------------------------------------------------------------------- */
4786 /* %start-doc actions ChangeJoin
4788 The join flag determines whether a line or arc, drawn to intersect a
4789 polygon, electrically connects to the polygon or not. When joined,
4790 the line/arc is simply drawn over the polygon, making an electrical
4791 connection. When not joined, a gap is drawn between the line and the
4792 polygon, insulating them from each other.
4794 %end-doc */
4796 static int
4798 {
4801 {
4803 {
4806 {
4817 }
4834 }
4835 }
4837 }
4839 /* --------------------------------------------------------------------------- */
4849 /* %start-doc actions ChangeSquare
4851 Note that @code{Pins} means both pins and pads.
4853 @pinshapes
4855 %end-doc */
4857 static int
4859 {
4862 {
4864 {
4867 {
4878 }
4895 }
4896 }
4898 }
4900 /* --------------------------------------------------------------------------- */
4907 /* %start-doc actions SetSquare
4909 Note that @code{Pins} means pins and pads.
4911 @pinshapes
4913 %end-doc */
4915 static int
4917 {
4920 {
4922 {
4925 {
4936 }
4953 }
4954 }
4956 }
4958 /* --------------------------------------------------------------------------- */
4966 /* %start-doc actions ClearSquare
4968 Note that @code{Pins} means pins and pads.
4970 @pinshapes
4972 %end-doc */
4974 static int
4976 {
4979 {
4981 {
4984 {
4995 }
5012 }
5013 }
5015 }
5017 /* --------------------------------------------------------------------------- */
5026 /* %start-doc actions ChangeOctagon
5028 @pinshapes
5030 %end-doc */
5032 static int
5034 {
5037 {
5039 {
5042 {
5053 }
5075 }
5076 }
5078 }
5080 /* --------------------------------------------------------------------------- */
5087 /* %start-doc actions SetOctagon
5089 @pinshapes
5091 %end-doc */
5093 static int
5095 {
5098 {
5100 {
5103 {
5114 }
5136 }
5137 }
5139 }
5141 /* --------------------------------------------------------------------------- */
5150 /* %start-doc actions ClearOctagon
5152 @pinshapes
5154 %end-doc */
5156 static int
5158 {
5161 {
5163 {
5166 {
5177 }
5199 }
5200 }
5202 }
5204 /* --------------------------------------------------------------------------- */
5211 /* %start-doc actions ChangeHole
5213 The "hole flag" of a via determines whether the via is a
5214 plated-through hole (not set), or an unplated hole (set).
5216 %end-doc */
5218 static int
5220 {
5223 {
5225 {
5228 {
5238 }
5245 }
5246 }
5248 }
5250 /* --------------------------------------------------------------------------- */
5257 /* %start-doc actions ChangePaste
5259 The "no paste flag" of a pad determines whether the solderpaste
5260 stencil will have an opening for the pad (no set) or if there wil be
5261 no solderpaste on the pad (set). This is used for things such as
5262 fiducial pads.
5264 %end-doc */
5266 static int
5268 {
5271 {
5273 {
5276 {
5286 }
5293 }
5294 }
5296 }
5298 /* --------------------------------------------------------------------------- */
5311 /* %start-doc actions Select
5313 @table @code
5315 @item ElementByName
5316 @item ObjectByName
5317 @item PadByName
5318 @item PinByName
5319 @item TextByName
5320 @item ViaByName
5321 @item NetByName
5323 These all rely on having a regular expression parser built into
5324 @code{pcb}. If the name is not specified then the user is prompted
5325 for a pattern, and all objects that match the pattern and are of the
5326 type specified are selected.
5328 @item Object
5329 @item ToggleObject
5330 Selects the object under the cursor.
5332 @item Block
5333 Selects all objects in a rectangle indicated by the cursor.
5335 @item All
5336 Selects all objects on the board.
5338 @item Connection
5339 Selects all connections with the ``found'' flag set.
5341 @item Convert
5342 Converts the selected objects to an element. This uses the highest
5343 numbered paste buffer.
5345 @end table
5347 %end-doc */
5349 static int
5351 {
5354 {
5356 {
5357 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5359 /* select objects by their names */
5382 commonByName:
5383 {
5389 {
5394 }
5396 }
5399 /* select a single object */
5406 /* all objects in block */
5408 {
5409 BoxType box;
5423 {
5426 }
5429 }
5431 /* select all visible objects */
5433 {
5434 BoxType box;
5443 }
5445 /* all found connections */
5448 {
5452 }
5456 {
5471 }
5477 }
5478 }
5480 }
5482 /* FLAG(have_regex,FlagHaveRegex,0) */
5483 int
5485 {
5486 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5488 #else
5490 #endif
5491 }
5493 /* --------------------------------------------------------------------------- */
5505 /* %start-doc actions Unselect
5507 @table @code
5509 @item All
5510 Unselect all objects.
5512 @item Block
5513 Unselect all objects in a rectangle given by the cursor.
5515 @item Connection
5516 Unselect all connections with the ``found'' flag set.
5518 @item ElementByName
5519 @item ObjectByName
5520 @item PadByName
5521 @item PinByName
5522 @item TextByName
5523 @item ViaByName
5525 These all rely on having a regular expression parser built into
5526 @code{pcb}. If the name is not specified then the user is prompted
5527 for a pattern, and all objects that match the pattern and are of the
5528 type specified are unselected.
5531 @end table
5533 %end-doc */
5535 static int
5537 {
5540 {
5542 {
5543 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5545 /* select objects by their names */
5568 commonByName:
5569 {
5575 {
5580 }
5582 }
5585 /* all objects in block */
5587 {
5588 BoxType box;
5602 {
5605 }
5608 }
5610 /* unselect all visible objects */
5612 {
5613 BoxType box;
5622 }
5624 /* all found connections */
5627 {
5631 }
5638 }
5639 }
5641 }
5643 /* --------------------------------------------------------------------------- */
5652 /* %start-doc actions SaveTo
5654 @table @code
5656 @item Layout
5657 Saves the current layout.
5659 @item LayoutAs
5660 Saves the current layout, and remembers the filename used.
5662 @item AllConnections
5663 Save all connections to a file.
5665 @item AllUnusedPins
5666 List all unused pins to a file.
5668 @item ElementConnections
5669 Save connections to the element at the cursor to a file.
5671 @item PasteBuffer
5672 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5674 @end table
5676 %end-doc */
5678 static int
5680 {
5688 {
5692 }
5698 {
5700 {
5706 }
5708 }
5711 {
5715 {
5719 }
5721 }
5724 {
5728 {
5732 }
5734 }
5737 {
5745 {
5749 {
5753 }
5754 }
5756 }
5759 {
5761 }
5764 }
5766 /* --------------------------------------------------------------------------- */
5774 /* %start-doc actions SaveSettings
5776 If you pass no arguments, the settings are stored in
5777 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5778 saved in @code{./pcb.settings}.
5780 %end-doc */
5782 static int
5784 {
5788 }
5790 /* --------------------------------------------------------------------------- */
5797 /* %start-doc actions LoadFrom
5799 This action assumes you know what the filename is. The various GUIs
5800 should have a similar @code{Load} action where the filename is
5801 optional, and will provide their own file selection mechanism to let
5802 you choose the file name.
5804 @table @code
5806 @item Layout
5807 Loads an entire PCB layout, replacing the current one.
5809 @item LayoutToBuffer
5810 Loads an entire PCB layout to the paste buffer.
5812 @item ElementToBuffer
5813 Loads the given element file into the paste buffer. Element files
5814 contain only a single @code{Element} definition, such as the
5815 ``newlib'' library uses.
5817 @item Netlist
5818 Loads a new netlist, replacing any current netlist.
5820 @item Revert
5821 Re-loads the current layout from its disk file, reverting any changes
5822 you may have made.
5824 @end table
5826 %end-doc */
5828 static int
5830 {
5841 {
5846 }
5849 {
5854 }
5857 {
5861 }
5864 {
5871 }
5875 {
5877 }
5880 }
5882 /* --------------------------------------------------------------------------- */
5888 /* %start-doc actions New
5890 If a name is not given, one is prompted for.
5892 %end-doc */
5894 static int
5896 {
5900 {
5903 else
5910 /* do emergency saving
5911 * clear the old struct and allocate memory for the new one
5912 */
5921 /* setup the new name and reset some values to default */
5933 }
5935 }
5937 /* ---------------------------------------------------------------------------
5938 * no operation, just for testing purposes
5939 * syntax: Bell(volume)
5940 */
5941 void
5943 {
5945 }
5947 /* --------------------------------------------------------------------------- */
5958 /* %start-doc actions PasteBuffer
5960 There are a number of paste buffers; the actual limit is a
5961 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5962 is currently @code{5}. One of these is the ``current'' paste buffer,
5963 often referred to as ``the'' paste buffer.
5965 @table @code
5967 @item AddSelected
5968 Copies the selected objects to the current paste buffer.
5970 @item Clear
5971 Remove all objects from the current paste buffer.
5973 @item Convert
5974 Convert the current paste buffer to an element. Vias are converted to
5975 pins, lines are converted to pads.
5977 @item Restore
5978 Convert any elements in the paste buffer back to vias and lines.
5980 @item Mirror
5981 Flip all objects in the paste buffer vertically (up/down flip). To mirror
5982 horizontally, combine this with rotations.
5984 @item Rotate
5985 Rotates the current buffer. The number to pass is 1..3, where 1 means
5986 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
5987 degrees clockwise (270 CCW).
5989 @item Save
5990 Saves any elements in the current buffer to the indicated file.
5992 @item ToLayout
5993 Pastes any elements in the current buffer to the indicated X, Y
5994 coordinates in the layout. The @code{X} and @code{Y} are treated like
5995 @code{delta} is for many other objects. For each, if it's prefixed by
5996 @code{+} or @code{-}, then that amount is relative to the last
5997 location. Otherwise, it's absolute. Units can be
5998 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
5999 units, currently 1/100 mil.
6002 @item 1..MAX_BUFFER
6003 Selects the given buffer to be the current paste buffer.
6005 @end table
6007 %end-doc */
6009 static int
6011 {
6020 {
6022 {
6023 /* clear contents of paste buffer */
6028 /* copies objects to paste buffer */
6033 /* converts buffer contents into an element */
6038 /* break up element for editing */
6043 /* Mirror buffer */
6050 {
6053 }
6058 {
6061 }
6064 {
6072 {
6075 }
6077 {
6079 }
6081 }
6083 else
6086 {
6090 {
6095 }
6096 else
6101 }
6105 {
6111 {
6113 }
6115 {
6122 }
6123 else
6124 {
6127 }
6133 }
6136 /* set number */
6138 {
6141 /* correct number */
6144 }
6145 }
6146 }
6150 }
6152 /* --------------------------------------------------------------------------- */
6159 /* %start-doc actions Undo
6161 The unlimited undo feature of @code{Pcb} allows you to recover from
6162 most operations that materially affect you work. Calling
6163 @code{Undo()} without any parameter recovers from the last (non-undo)
6164 operation. @code{ClearList} is used to release the allocated
6165 memory. @code{ClearList} is called whenever a new layout is started or
6166 loaded. See also @code{Redo} and @code{Atomic}.
6168 Note that undo groups operations by serial number; changes with the
6169 same serial number will be undone (or redone) as a group. See
6170 @code{Atomic}.
6172 %end-doc */
6174 static int
6176 {
6179 {
6180 /* don't allow undo in the middle of an operation */
6187 /* undo the last operation */
6193 {
6197 }
6198 /* move anchor point if undoing during line creation */
6200 {
6202 {
6209 }
6211 {
6215 /* this search is guaranteed to succeed */
6222 /* save both ends of line */
6227 /* check that the undo was of the right type */
6229 {
6230 /* wrong undo type, restore anchor points */
6237 }
6238 /* move to new anchor */
6243 /* check if an intermediate point was removed */
6245 {
6246 /* this search should find the restored line */
6254 {
6255 /* undo loses FOUNDFLAG */
6258 }
6263 }
6267 {
6270 }
6271 else
6272 {
6273 /* this search is guaranteed to succeed too */
6281 }
6284 }
6285 }
6287 {
6289 {
6293 }
6295 {
6298 /* guaranteed to succeed */
6310 }
6311 }
6312 /* undo the last destructive operation */
6315 }
6317 {
6319 {
6320 /* clear 'undo objects' list */
6324 }
6325 }
6328 }
6330 /* --------------------------------------------------------------------------- */
6336 /* %start-doc actions Redo
6338 This routine allows you to recover from the last undo command. You
6339 might want to do this if you thought that undo was going to revert
6340 something other than what it actually did (in case you are confused
6341 about which operations are un-doable), or if you have been backing up
6342 through a long undo list and over-shoot your stopping point. Any
6343 change that is made since the undo in question will trim the redo
6344 list. For example if you add ten lines, then undo three of them you
6345 could use redo to put them back, but if you move a line on the board
6346 before performing the redo, you will lose the ability to "redo" the
6347 three "undone" lines.
6349 %end-doc */
6351 static int
6353 {
6361 {
6365 {
6371 addedLines++;
6372 }
6373 }
6376 }
6378 /* --------------------------------------------------------------------------- */
6384 /* %start-doc actions Polygon
6386 Polygons need a special action routine to make life easier.
6388 @table @code
6390 @item Close
6391 Creates the final segment of the polygon. This may fail if clipping
6392 to 45 degree lines is switched on, in which case a warning is issued.
6394 @item PreviousPoint
6395 Resets the newly entered corner to the previous one. The Undo action
6396 will call Polygon(PreviousPoint) when appropriate to do so.
6398 @end table
6400 %end-doc */
6402 static int
6404 {
6407 {
6410 {
6411 /* close open polygon if possible */
6416 /* go back to the previous point */
6420 }
6422 }
6424 }
6426 /* --------------------------------------------------------------------------- */
6433 /* %start-doc actions RouteStyle
6435 %end-doc */
6437 static int
6439 {
6445 {
6448 {
6455 }
6456 }
6458 }
6461 /* --------------------------------------------------------------------------- */
6467 /* %start-doc actions MoveObject
6469 The @code{X} and @code{Y} are treated like @code{delta} is for many
6470 other objects. For each, if it's prefixed by @code{+} or @code{-},
6471 then that amount is relative. Otherwise, it's absolute. Units can be
6472 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6473 units, currently 1/100 mil.
6475 %end-doc */
6477 static int
6479 {
6493 {
6496 }
6509 }
6511 /* --------------------------------------------------------------------------- */
6519 /* %start-doc actions MoveToCurrentLayer
6521 Note that moving an element from a component layer to a solder layer,
6522 or from solder to component, won't automatically flip it. Use the
6523 @code{Flip()} action to do that.
6525 %end-doc */
6527 static int
6529 {
6532 {
6534 {
6536 {
6547 }
6554 }
6555 }
6557 }
6565 /* %start-doc actions SetSame
6567 When invoked over any line, arc, polygon, or via, this changes the
6568 current layer to be the layer that item is on, and changes the current
6569 sizes (thickness, keepaway, drill, etc) according to that item.
6571 %end-doc */
6573 static int
6575 {
6581 /* set layer current and size from line or arc */
6583 {
6623 }
6625 {
6628 }
6630 }
6633 /* --------------------------------------------------------------------------- */
6644 /* %start-doc actions SetFlag
6646 Turns the given flag on, regardless of its previous setting. See
6647 @code{ChangeFlag}.
6649 @example
6650 SetFlag(SelectedPins,thermal)
6651 @end example
6653 %end-doc */
6655 static int
6657 {
6662 }
6664 /* --------------------------------------------------------------------------- */
6675 /* %start-doc actions ClrFlag
6677 Turns the given flag off, regardless of its previous setting. See
6678 @code{ChangeFlag}.
6680 @example
6681 ClrFlag(SelectedLines,join)
6682 @end example
6684 %end-doc */
6686 static int
6688 {
6693 }
6695 /* --------------------------------------------------------------------------- */
6707 /* %start-doc actions ChangeFlag
6709 Toggles the given flag on the indicated object(s). The flag may be
6710 one of the flags listed above (square, octagon, thermal, join). The
6711 value may be the number 0 or 1. If the value is 0, the flag is
6712 cleared. If the value is 1, the flag is set.
6714 %end-doc */
6716 static int
6718 {
6727 }
6730 static void
6732 {
6737 {
6740 }
6742 {
6745 }
6747 {
6748 /* Note: these are backwards, because the flag is "clear" but
6749 the command is "join". */
6752 }
6753 else
6754 {
6757 }
6760 {
6762 {
6774 }
6816 }
6817 }
6819 /* --------------------------------------------------------------------------- */
6825 /* %start-doc actions ExecuteFile
6827 Lines starting with @code{#} are ignored.
6829 %end-doc */
6831 static int
6833 {
6846 {
6849 }
6854 {
6855 n++;
6858 /* eat the trailing newline */
6860 sp++;
6863 /* eat leading spaces and tabs */
6866 sp++;
6868 /*
6869 * if we have anything left and its not a comment line
6870 * then execute it
6871 */
6874 {
6875 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6877 }
6878 }
6882 {
6885 }
6888 }
6890 /* --------------------------------------------------------------------------- */
6892 static int
6894 {
6898 }
6900 /* --------------------------------------------------------------------------- */
6906 {
6913 {
6916 {
6919 }
6920 }
6921 END_LOOP;
6923 }
6927 {
6933 }
6935 static void
6937 {
6944 }
6946 /* ---------------------------------------------------------------- */
6952 /* %start-doc actions ElementList
6954 @table @code
6956 @item Start
6957 Indicates the start of an element list; call this before any Need
6958 actions.
6960 @item Need
6961 Searches the board for an element with a matching refdes.
6963 If found, the value and footprint are updated.
6965 If not found, a new element is created with the given footprint and value.
6967 @item ForceUpdate
6968 If set, updates the value and footprint even if neither have changed. This
6969 can be useful to pull in minor footprint updates.
6971 @item Done
6972 Compares the list of elements needed since the most recent
6973 @code{start} with the list of elements actually on the board. Any
6974 elements that weren't listed are selected, so that the user may delete
6975 them.
6977 @end table
6979 %end-doc */
6983 static int
6985 {
6990 }
6992 static int
6994 {
7000 #ifdef DEBUG
7002 #endif
7005 {
7007 {
7009 }
7010 END_LOOP;
7014 }
7017 {
7019 {
7021 {
7023 }
7025 {
7026 /* Unnamed elements should remain untouched */
7028 }
7029 }
7030 END_LOOP;
7035 }
7043 argc --;
7044 argv ++;
7055 #ifdef DEBUG
7060 #endif
7064 /* reload footprints from disk in case they changed */
7068 {
7071 #ifdef DEBUG
7073 #endif
7074 /* Not on board, need to add it. */
7076 {
7077 number_of_footprints_not_found ++;
7079 }
7090 {
7093 }
7104 /* Place components onto center of board. */
7107 }
7111 {
7112 #ifdef DEBUG
7114 #endif
7117 }
7122 /* Different footprint, we need to swap them out. */
7124 {
7125 number_of_footprints_not_found ++;
7127 }
7142 {
7147 }
7153 }
7155 /* Now reload footprint */
7168 #ifdef DEBUG
7170 #endif
7173 }
7177 /* ---------------------------------------------------------------- */
7182 /* %start-doc actions UpdatePackage
7184 @table @code
7186 @item Selected
7187 Only updates the footprint of the selected elements from the currently-loaded
7188 library.
7190 @item All
7191 Reloads from the currently-loaded library the packages of all elements in the
7192 layout.
7194 @end table
7196 Extracts the footprint name to load from the element's @code{Desc} field.
7197 Preserves the old element's Desc, Name, and Value fields.
7199 %end-doc */
7203 static int
7205 {
7217 #ifdef DEBUG
7219 #endif
7222 {
7226 }
7227 else
7228 {
7230 }
7232 /* Select all elements for All mode */
7236 /* Flag all original elements, we are adding more but don't want to process
7237 * the new ones*/
7239 {
7241 }
7242 END_LOOP;
7246 {
7247 /* All elements (from here on ??) were added in previous iterations of this
7248 * loop; we are done. */
7252 /* Only touch selected elements. */
7256 /* no element name, it's likely not something we wish to change skip */
7261 {
7264 }
7267 {
7269 }
7271 /* to get here, this is a footprint element (??) */
7273 /* do not touch element if not in current library */
7275 {
7276 update_footprints_not_found ++;
7279 }
7281 /* all good, now update the package */
7286 );
7288 /* in the method of ElementList(Need,...) */
7298 /* move element parts to their previous locations */
7302 {
7307 }
7309 /* preserve attributes */
7311 {
7315 }
7317 /* preserve name, refdes, and value */
7328 /* who needs old data? */
7331 /* place in layout */
7335 }
7336 END_LOOP;
7339 {
7342 }
7344 #ifdef DEBUG
7346 #endif
7348 }
7351 /* ---------------------------------------------------------------- */
7356 /* %start-doc actions ElementSetAttr
7358 If a value is specified, the named attribute is added (if not already
7359 present) or changed (if it is) to the given value. If the value is
7360 not specified, the given attribute is removed if present.
7362 %end-doc */
7364 static int
7366 {
7372 {
7374 }
7381 {
7383 {
7386 }
7387 }
7388 END_LOOP;
7391 {
7394 }
7399 {
7402 }
7404 {
7406 }
7408 {
7410 }
7413 }
7415 /* ---------------------------------------------------------------- */
7420 /* %start-doc actions ExecCommand
7422 Runs the given command, which is a system executable.
7424 %end-doc */
7426 static int
7428 {
7432 {
7434 }
7441 }
7443 /* ---------------------------------------------------------------- */
7445 static int
7447 {
7448 #ifdef HAVE__SPAWNVP
7452 else
7454 #else
7458 {
7459 /* error */
7462 }
7464 {
7465 /* Child */
7468 }
7469 else
7470 {
7472 /* Parent */
7474 }
7476 #endif
7477 }
7479 /* ---------------------------------------------------------------- */
7480 /*
7481 * Creates a new temporary file name. Hopefully the operating system
7482 * provides a mkdtemp() function to securily create a temporary
7483 * directory with mode 0700. If so then that directory is created and
7484 * the returned string is made up of the directory plus the name
7485 * variable. For example:
7486 *
7487 * tempfile_name_new ("myfile") might return
7488 * "/var/tmp/pcb.123456/myfile".
7489 *
7490 * If mkdtemp() is not available then 'name' is ignored and the
7491 * insecure tmpnam() function is used.
7492 *
7493 * Files/names created with tempfile_name_new() should be unlinked
7494 * with tempfile_unlink to make sure the temporary directory is also
7495 * removed when mkdtemp() is used.
7496 */
7499 {
7501 #ifdef HAVE_MKDTEMP
7504 #endif
7508 #ifdef HAVE_MKDTEMP
7514 /* FIXME -- what about win32? */
7517 }
7527 }
7537 }
7544 ;
7554 #undef TEMPLATE
7555 #else
7556 /*
7557 * tmpnam() uses a static buffer so strdup() the result right away
7558 * in case someone decides to create multiple temp names.
7559 */
7561 #ifdef __WIN32__
7562 {
7563 /* Guile doesn't like \ separators */
7568 }
7569 #endif
7570 #endif
7573 }
7575 /* ---------------------------------------------------------------- */
7576 /*
7577 * Unlink a temporary file. If we have mkdtemp() then our temp file
7578 * lives in a temporary directory and we need to remove that directory
7579 * too.
7580 */
7581 static int
7583 {
7584 #ifdef DEBUG
7585 /* SDB says: Want to keep old temp files for examiniation when debugging */
7587 #endif
7589 #ifdef HAVE_MKDTEMP
7594 /* it is possible that the file was never created so it is OK if the
7595 unlink fails */
7597 /* now figure out the directory name to remove */
7604 /*
7605 * at this point, e *should* point to the end of the directory part
7606 * but lets make sure.
7607 */
7612 }
7616 __FUNCTION__);
7620 }
7622 /* name was allocated with malloc */
7626 /*
7627 * FIXME - should also return -1 if the temp file exists and was not
7628 * removed.
7629 */
7632 }
7634 #else
7641 }
7644 #endif
7647 }
7649 /* ---------------------------------------------------------------- */
7658 /* %start-doc actions Import
7660 Imports element and netlist data from the schematics (or some other
7661 source). The first parameter, which is optional, is the mode. If not
7662 specified, the @code{import::mode} attribute in the PCB is used.
7663 @code{gnetlist} means gnetlist is used to obtain the information from
7664 the schematics. @code{make} invokes @code{make}, assuming the user
7665 has a @code{Makefile} in the current directory. The @code{Makefile}
7666 will be invoked with the following variables set:
7668 @table @code
7670 @item PCB
7671 The name of the .pcb file
7673 @item SRCLIST
7674 A space-separated list of source files
7676 @item OUT
7677 The name of the file in which to put the command script, which may
7678 contain any @pcb{} actions. By default, this is a temporary file
7679 selected by @pcb{}, but if you specify an @code{import::outfile}
7680 attribute, that file name is used instead (and not automatically
7681 deleted afterwards).
7683 @end table
7685 The target specified to be built is the first of these that apply:
7687 @itemize @bullet
7689 @item
7690 The target specified by an @code{import::target} attribute.
7692 @item
7693 The output file specified by an @code{import::outfile} attribute.
7695 @item
7696 If nothing else is specified, the target is @code{pcb_import}.
7698 @end itemize
7700 If you specify an @code{import::makefile} attribute, then "-f <that
7701 file>" will be added to the command line.
7703 If you specify the mode, you may also specify the source files
7704 (schematics). If you do not specify any, the list of schematics is
7705 obtained by reading the @code{import::src@var{N}} attributes (like
7706 @code{import::src0}, @code{import::src1}, etc).
7708 For compatibility with future extensions to the import file format,
7709 the generated file @emph{must not} start with the two characters
7710 @code{#%}.
7712 If a temporary file is needed the @code{TMPDIR} environment variable
7713 is used to select its location.
7715 Note that the programs @code{gnetlist} and @code{make} may be
7716 overridden by the user via the @code{make-program} and @code{gnetlist}
7717 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7718 line).
7720 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7721 is called to let user choose (see @code{ImportGUI()}).
7723 Note that Import() doesn't delete anything - after an Import, elements
7724 which shouldn't be on the board are selected and may be removed once
7725 it's determined that the deletion is appropriate.
7727 If @code{Import()} is called with @code{setnewpoint}, then the location
7728 of new components can be specified. This is where parts show up when
7729 they're added to the board. The default is the center of the board.
7731 @table @code
7733 @item Import(setnewpoint)
7735 Prompts the user to click on the board somewhere, uses that point. If
7736 called by a hotkey, uses the current location of the crosshair.
7738 @item Import(setnewpoint,mark)
7740 Uses the location of the mark. If no mark is present, the point is
7741 not changed.
7743 @item Import(setnewpoint,center)
7745 Resets the point to the center of the board.
7747 @item Import(setnewpoint,X,Y,units)
7749 Sets the point to the specific coordinates given. Example:
7750 @code{Import(setnewpoint,50,25,mm)}
7752 @end table
7754 Note that the X and Y locations are stored in attributes named
7755 @code{import::newX} and @code{import::newY} so you could change them
7756 manually if you wished.
7758 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7759 placed elements are dispersed relative to the set point. For example,
7760 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7761 10mm away from the point. The default dispersion is 1/10th of the
7762 smallest board dimension. Dispersion is saved in the
7763 @code{import::disperse} attribute.
7765 %end-doc */
7767 static int
7769 {
7774 #ifdef DEBUG
7776 #endif
7781 {
7788 {
7791 }
7793 {
7796 }
7797 else
7802 }
7805 {
7815 {
7817 }
7819 {
7823 }
7825 {
7831 }
7833 {
7836 }
7837 else
7838 {
7841 }
7848 }
7856 {
7859 }
7862 {
7868 nsources ++;
7874 {
7878 nsources ++;
7883 }
7884 }
7887 {
7888 /* Replace .pcb with .sch and hope for the best. */
7910 {
7913 }
7919 }
7922 {
7930 }
7943 #ifdef DEBUG
7947 #endif
7950 {
7953 }
7955 #ifdef DEBUG
7956 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7957 #endif
7965 }
7967 {
7987 else
7988 {
7993 }
7995 }
8003 {
8007 }
8016 {
8019 }
8024 {
8031 }
8042 }
8043 else
8044 {
8047 }
8052 #ifdef DEBUG
8054 #endif
8057 }
8059 /* ------------------------------------------------------------ */
8069 /* %start-doc actions Attributes
8071 This just pops up a dialog letting the user edit the attributes of the
8072 pcb, an element, or a layer.
8074 %end-doc */
8077 static int
8079 {
8088 {
8091 }
8094 {
8096 {
8099 }
8102 {
8105 {
8110 {
8113 }
8115 {
8118 }
8119 }
8125 }
8128 {
8132 {
8134 {
8136 n_found ++;
8137 }
8138 }
8139 END_LOOP;
8141 {
8144 }
8146 {
8153 else
8154 {
8157 }
8158 }
8161 {
8164 }
8165 else
8166 {
8168 }
8172 }
8176 }
8179 }
8181 /* --------------------------------------------------------------------------- */
8183 HID_Action action_action_list[] = {
8186 ,
8189 ,
8192 ,
8195 ,
8198 ,
8201 ,
8204 ,
8207 ,
8210 ,
8213 ,
8216 ,
8219 ,
8222 ,
8225 ,
8228 ,
8231 ,
8234 ,
8237 ,
8240 ,
8243 ,
8246 ,
8249 ,
8252 ,
8255 ,
8258 ,
8261 ,
8264 ,
8267 ,
8270 ,
8273 ,
8276 ,
8279 ,
8282 ,
8285 ,
8288 ,
8291 ,
8294 ,
8297 ,
8300 ,
8303 ,
8306 ,
8309 ,
8312 ,
8315 ,
8318 ,
8321 ,
8324 ,
8327 ,
8330 ,
8333 ,
8336 ,
8339 ,
8342 ,
8345 ,
8348 ,
8351 ,
8354 ,
8357 ,
8359 ,
8362 ,
8365 ,
8368 ,
8371 ,
8374 ,
8375 };