| blob | 02737cab657ceff67651f042e429e625e657e45f |
1 /*!
2 * \file src/action.c
3 *
4 * \brief Action routines for output window.
5 *
6 * <hr>
7 *
8 * <h1><b>Copyright.</b></h1>\n
9 *
10 * PCB, interactive printed circuit board design
11 *
12 * Copyright (C) 1994,1995,1996 Thomas Nau
13 *
14 * Copyright (C) 1997, 1998, 1999, 2000, 2001 Harry Eaton
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 *
30 * Contact addresses for paper mail and Email:
31 * Harry Eaton, 6697 Buttonhole Ct, Columbia, MD 21044, USA
32 * haceaton@aplcomm.jhuapl.edu
33 */
35 #ifdef HAVE_CONFIG_H
37 #endif
62 /*#include "print.h"*/
77 #include <assert.h>
80 #ifdef HAVE_LIBDMALLOC
81 #include <dmalloc.h>
82 #endif
84 /* for fork() and friends */
85 #ifdef HAVE_UNISTD_H
86 #include <unistd.h>
87 #endif
89 #ifdef HAVE_SYS_WAIT_H
90 #include <sys/wait.h>
91 #endif
93 /* ---------------------------------------------------------------------------
94 * some local types
95 */
97 {
98 F_AddSelected,
99 F_All,
100 F_AllConnections,
101 F_AllRats,
102 F_AllUnusedPins,
103 F_Arc,
104 F_Arrow,
105 F_Block,
106 F_Description,
107 F_Cancel,
108 F_Center,
109 F_Clear,
110 F_ClearAndRedraw,
111 F_ClearList,
112 F_Close,
113 F_Found,
114 F_Connection,
115 F_Convert,
116 F_Copy,
117 F_CycleClip,
118 F_CycleCrosshair,
119 F_DeleteRats,
120 F_Drag,
121 F_DrillReport,
122 F_Element,
123 F_ElementByName,
124 F_ElementConnections,
125 F_ElementToBuffer,
126 F_Escape,
127 F_Find,
128 F_FlipElement,
129 F_FoundPins,
130 F_Grid,
131 F_InsertPoint,
132 F_Layer,
133 F_Layout,
134 F_LayoutAs,
135 F_LayoutToBuffer,
136 F_Line,
137 F_LineSize,
138 F_Lock,
139 F_Mirror,
140 F_Move,
141 F_NameOnPCB,
142 F_Netlist,
143 F_NetByName,
144 F_None,
145 F_Notify,
146 F_Object,
147 F_ObjectByName,
148 F_PasteBuffer,
149 F_PadByName,
150 F_PinByName,
151 F_PinOrPadName,
152 F_Pinout,
153 F_Polygon,
154 F_PolygonHole,
155 F_PreviousPoint,
156 F_RatsNest,
157 F_Rectangle,
158 F_Redraw,
159 F_Release,
160 F_Revert,
161 F_Remove,
162 F_RemoveSelected,
163 F_Report,
164 F_Reset,
165 F_ResetLinesAndPolygons,
166 F_ResetPinsViasAndPads,
167 F_Restore,
168 F_Rotate,
169 F_Save,
170 F_Selected,
171 F_SelectedArcs,
172 F_SelectedElements,
173 F_SelectedLines,
174 F_SelectedNames,
175 F_SelectedObjects,
176 F_SelectedPads,
177 F_SelectedPins,
178 F_SelectedTexts,
179 F_SelectedVias,
180 F_SelectedRats,
181 F_Stroke,
182 F_Text,
183 F_TextByName,
184 F_TextScale,
185 F_Thermal,
186 F_ToLayout,
187 F_ToggleAllDirections,
188 F_ToggleAutoDRC,
189 F_ToggleClearLine,
190 F_ToggleFullPoly,
191 F_ToggleGrid,
192 F_ToggleHideNames,
193 F_ToggleMask,
194 F_ToggleName,
195 F_ToggleObject,
196 F_ToggleShowDRC,
197 F_ToggleLiveRoute,
198 F_ToggleRubberBandMode,
199 F_ToggleStartDirection,
200 F_ToggleSnapPin,
201 F_ToggleThindraw,
202 F_ToggleLockNames,
203 F_ToggleOnlyNames,
204 F_ToggleThindrawPoly,
205 F_ToggleOrthoMove,
206 F_ToggleLocalRef,
207 F_ToggleCheckPlanes,
208 F_ToggleUniqueNames,
209 F_Via,
210 F_ViaByName,
211 F_Value,
212 F_ViaDrillingHole,
213 F_ViaSize,
214 F_Zoom
215 }
216 FunctionID;
219 {
221 FunctionID ID;
222 }
223 FunctionType;
225 /* --------------------------------------------------------------------------- */
227 /* %start-doc actions 00delta
229 Many actions take a @code{delta} parameter as the last parameter,
230 which is an amount to change something. That @code{delta} may include
231 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
232 If no units are specified, the default is PCB's native units
233 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
234 @code{-}, the size is increased or decreased by that amount.
235 Otherwise, the size size is set to the given amount.
237 @example
238 Action(Object,5,mil)
239 Action(Object,+0.5,mm)
240 Action(Object,-1)
241 @end example
243 Actions which take a @code{delta} parameter which do not accept all
244 these options will specify what they do take.
246 %end-doc */
248 /* %start-doc actions 00objects
250 Many actions act on indicated objects on the board. They will have
251 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
252 what group of objects they act on. Unless otherwise specified, these
253 parameters are defined as follows:
255 @table @code
257 @item Object
258 @itemx ToggleObject
259 Affects the object under the mouse pointer. If this action is invoked
260 from a menu or script, the user will be prompted to click on an
261 object, which is then the object affected.
263 @item Selected
264 @itemx SelectedObjects
266 Affects all objects which are currently selected. At least, all
267 selected objects for which the given action makes sense.
269 @item SelectedPins
270 @itemx SelectedVias
271 @itemx Selected@var{Type}
272 @itemx @i{etc}
273 Affects all objects which are both selected and of the @var{Type} specified.
275 @end table
277 %end-doc */
279 /* %start-doc actions 00macros
281 @macro pinshapes
283 Pins, pads, and vias can have various shapes. All may be round. Pins
284 and pads may be square (obviously "square" pads are usually
285 rectangular). Pins and vias may be octagonal. When you change a
286 shape flag of an element, you actually change all of its pins and
287 pads.
289 Note that the square flag takes precedence over the octagon flag,
290 thus, if both the square and octagon flags are set, the object is
291 square. When the square flag is cleared, the pins and pads will be
292 either round or, if the octagon flag is set, octagonal.
294 @end macro
296 %end-doc */
298 /* ---------------------------------------------------------------------------
299 * some local identifiers
300 */
303 static struct
304 {
306 LineType line;
307 }
308 fake;
310 static struct
311 {
313 Cardinal Buffer;
320 }
321 Note;
328 #ifdef HAVE_LIBSTROKE
331 #endif
450 };
452 /* ---------------------------------------------------------------------------
453 * some local routines
454 */
461 #ifdef HAVE_LIBSTROKE
466 #endif
469 #define ARG(n) (argc > (n) ? argv[n] : NULL)
471 #ifdef HAVE_LIBSTROKE
473 /*!
474 * \brief Try to recognize the stroke sent.
475 */
476 void
478 {
486 {
489 {
492 {
494 }
538 /* XXX: FIXME: Call a zoom-extents action */
549 /* XXX: FIXME: Zoom to fit the box StrokeBox.[X1,Y1] - StrokeBox.[X2,Y2] */
555 }
556 }
557 else
559 }
560 #endif
562 /*!
563 * \brief Clear warning color from pins/pads.
564 */
565 static void
567 {
570 {
572 {
575 }
576 }
577 ENDALL_LOOP;
579 {
581 {
584 }
585 }
586 ENDALL_LOOP;
588 }
590 /*!
591 * \brief Click callback.
592 *
593 * This is called a clicktime after a mouse down, to we can distinguish
594 * between short clicks (typically: select or create something) and long
595 * clicks. Long clicks typically drag something.
596 */
597 static void
599 {
601 {
605 {
615 }
617 {
626 }
627 else
628 {
629 BoxType box;
638 /* unselect first if shift key not down */
644 }
646 }
647 }
649 /*!
650 * \brief This is typically called when the mouse has moved or the mouse
651 * button was released.
652 */
653 static void
655 {
656 BoxType box;
659 {
660 BoxType box;
669 /* unselect first if shift key not down */
671 {
675 {
679 }
680 }
686 }
688 {
695 }
697 {
700 }
702 {
717 }
721 }
723 #define HSIZE 257
727 static int
729 {
732 {
735 s ++;
736 }
739 }
741 /*!
742 * \brief Get function ID of passed string.
743 */
744 static int
746 {
753 {
756 {
760 }
762 {
763 /* Change 'char' to 'int' and remove this when we get to 256
764 strings to hash. */
769 }
771 {
776 }
777 }
781 {
782 /* We enforce the "hash table bigger than function table" rule,
783 so we know there will be at least one zero entry to find. */
789 }
790 }
792 /*!
793 * \brief Set new coordinates if in 'RECTANGLE' mode.
794 *
795 * The cursor shape is also adjusted.
796 */
797 static void
799 {
801 {
804 }
806 {
808 {
809 /* update coordinates */
813 }
814 }
815 }
817 /*!
818 * \brief Adjusts the objects which are to be created like attached
819 * lines.
820 */
821 void
823 {
826 {
827 /* update at least an attached block (selection) */
831 {
834 }
837 /* rectangle creation mode */
843 /* polygon creation mode */
848 /* line creation mode */
852 else
855 /* point insertion mode */
863 }
864 }
866 /*!
867 * \brief Creates points of a line.
868 */
869 static void
871 {
878 {
883 {
886 }
888 {
894 }
896 {
901 }
903 {
908 {
911 }
912 else
913 {
916 }
917 }
918 else
919 {
924 }
929 /* fall through to third state too */
934 }
935 }
937 /*!
938 * \brief Create first or second corner of a marked block.
939 */
940 static void
942 {
945 {
957 }
959 }
962 /*!
963 * \brief This is called after every mode change, like mouse button pressed,
964 * mouse button released, dragging something started or a different tool
965 * selected.
966 *
967 * It does what's appropriate for the current mode setting.
968 * This can also mean creation of an object at the current crosshair location.
969 *
970 * New created objects are added to the create undo list of course.
971 */
972 static void
974 {
981 {
983 {
985 hidval hv;
988 /* do something after click time */
991 /* see if we clicked on something already selected
992 * (Note.Moving) or clicked on a MOVE_TYPE
993 * (Note.Hit)
994 */
997 {
1001 {
1006 }
1012 }
1014 }
1017 {
1021 {
1025 }
1030 {
1037 }
1039 }
1042 {
1044 {
1055 {
1063 {
1067 #ifdef ARC45
1070 else
1071 #endif
1073 }
1074 else
1075 {
1079 #ifdef ARC45
1082 else
1083 #endif
1086 }
1088 Crosshair.
1089 AttachedBox.
1091 Crosshair.
1092 AttachedBox.
1096 sa,
1097 dir,
1098 Settings.
1099 LineThickness,
1101 Keepaway,
1102 MakeFlags
1103 (TEST_FLAG
1105 PCB) ?
1106 CLEARLINEFLAG :
1108 {
1118 addedLines++;
1122 }
1124 }
1125 }
1127 }
1129 {
1132 {
1137 {
1140 }
1141 END_LOOP;
1143 {
1146 }
1147 END_LOOP;
1149 /* always re-draw it since I'm too lazy
1150 * to tell if a selected flag changed
1151 */
1156 }
1158 {
1163 {
1164 /* this is not un-doable since LOCK isn't */
1168 }
1171 }
1173 }
1175 {
1177 =
1181 {
1183 {
1185 tstyle++;
1189 }
1192 else
1194 }
1196 }
1199 /* do update of position */
1204 /* Remove anchor if clicking on start point;
1205 * this means we can't paint 0 length lines
1206 * which could be used for square SMD pads.
1207 * Instead use a very small delta, or change
1208 * the file after saving.
1209 */
1212 {
1215 }
1218 {
1221 {
1222 addedLines++;
1231 }
1233 }
1234 else
1235 /* create line if both ends are determined && length != 0 */
1236 {
1253 {
1254 /* We will only need to paint the second line segment.
1255 Since we only check for vias on the first segment,
1256 swap them so the non-empty segment is the first segment. */
1259 }
1265 {
1277 {
1279 addedLines++;
1282 }
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 }
1316 {
1325 {
1326 addedLines++;
1330 }
1331 /* move to new start point */
1337 {
1339 }
1340 }
1344 }
1348 /* do update of position */
1351 /* create rectangle if both corners are determined
1352 * and width, height are != 0
1353 */
1357 {
1364 Crosshair.
1366 Crosshair.
1368 Crosshair.
1370 Crosshair.
1372 MakeFlags
1374 NULL)
1375 {
1381 }
1383 /* reset state to 'first corner' */
1385 }
1389 {
1393 {
1395 {
1405 {
1410 }
1411 }
1413 }
1415 }
1418 {
1422 /* do update of position; use the 'LINE_MODE' mechanism */
1425 /* check if this is the last point of a polygon */
1429 {
1433 }
1435 /* create new point if it's the first one or if it's
1436 * different to the last one
1437 */
1441 {
1446 /* copy the coordinates */
1449 }
1451 }
1454 {
1456 {
1457 /* first notify, lookup object */
1466 {
1469 {
1473 }
1474 else
1476 }
1479 /* second notify, insert new point into object */
1481 {
1485 FlagType Flags;
1487 /* do update of position; use the 'LINE_MODE' mechanism */
1490 /* check if this is the last point of a polygon */
1494 {
1495 /* Create POLYAREAs from the original polygon
1496 * and the new hole polygon */
1500 /* Subtract the hole from the original polygon shape */
1503 /* Convert the resulting polygon(s) into a new set of nodes
1504 * and place them on the page. Delete the original polygon.
1505 */
1518 /* reset state of attached line */
1524 }
1526 /* create new point if it's the first one or if it's
1527 * different to the last one
1528 */
1532 {
1537 /* copy the coordinates */
1540 }
1542 }
1543 }
1546 }
1549 {
1554 {
1559 {
1562 {
1570 }
1571 }
1572 }
1576 {
1581 {
1588 {
1600 }
1601 }
1602 }
1604 }
1610 {
1612 {
1615 }
1617 {
1625 {
1632 else
1634 ptr++;
1635 }
1636 }
1640 }
1650 /* both are almost the same */
1654 {
1655 /* first notify, lookup object */
1657 {
1667 {
1671 {
1674 }
1675 else
1677 }
1679 }
1681 /* second notify, move or copy object */
1690 else
1691 {
1699 }
1702 /* reset identifiers */
1706 }
1709 /* insert a point into a polygon/line/... */
1712 {
1713 /* first notify, lookup object */
1722 {
1725 {
1729 }
1730 else
1731 {
1732 /* get starting point of nearest segment */
1734 {
1737 polyIndex =
1745 }
1748 }
1749 }
1752 /* second notify, insert new point into object */
1759 else
1767 /* reset identifiers */
1771 }
1773 }
1774 }
1777 /* --------------------------------------------------------------------------- */
1783 /* %start-doc actions Atomic
1785 This action allows making multiple-action bindings into an atomic
1786 operation that will be undone by a single Undo command. For example,
1787 to optimize rat lines, you'd delete the rats and re-add them. To
1788 group these into a single undo, you'd want the deletions and the
1789 additions to have the same undo serial number. So, you @code{Save},
1790 delete the rats, @code{Restore}, add the rats - using the same serial
1791 number as the deletes, then @code{Block}, which checks to see if the
1792 deletions or additions actually did anything. If not, the serial
1793 number is set to the saved number, as there's nothing to undo. If
1794 something did happen, the serial number is incremented so that these
1795 actions are counted as a single undo step.
1797 @table @code
1799 @item Save
1800 Saves the undo serial number.
1802 @item Restore
1803 Returns it to the last saved number.
1805 @item Close
1806 Sets it to 1 greater than the last save.
1808 @item Block
1809 Does a Restore if there was nothing to undo, else does a Close.
1811 @end table
1813 %end-doc */
1815 static int
1817 {
1822 {
1838 }
1840 }
1842 /* -------------------------------------------------------------------------- */
1848 /* %start-doc actions DRC
1850 Note that the design rule check uses the current board rule settings,
1851 not the current style settings.
1853 %end-doc */
1855 static int
1857 {
1861 {
1869 }
1872 {
1877 else
1879 }
1881 }
1883 /* -------------------------------------------------------------------------- */
1890 /* %start-doc actions DumpLibrary
1893 %end-doc */
1895 static int
1897 {
1904 {
1915 {
1918 {
1921 }
1922 else
1923 {
1930 }
1931 }
1932 }
1935 }
1937 /* -------------------------------------------------------------------------- */
1944 /* %start-doc actions Flip
1946 Note that the location of the element will be symmetric about the
1947 cursor location; i.e. if the part you are pointing at will still be at
1948 the same spot once the element is on the other side. When flipping
1949 multiple elements, this retains their positions relative to each
1950 other, not their absolute positions on the board.
1952 %end-doc */
1954 static int
1956 {
1963 {
1965 {
1969 {
1974 }
1983 }
1986 }
1989 }
1991 /* -------------------------------------------------------------------------- */
1997 /* %start-doc actions Message
1999 This action displays a message to the log window. This action is primarily
2000 provided for use by other programs which may interface with PCB. If
2001 multiple arguments are given, each one is sent to the log window
2002 followed by a newline.
2004 %end-doc */
2006 static int
2008 {
2015 {
2018 }
2021 }
2024 /* -------------------------------------------------------------------------- */
2038 /* %start-doc actions SetThermal
2040 This changes how/whether pins or vias connect to any rectangle or polygon
2041 on the current layer. The first argument can specify one object, or all
2042 selected pins, or all selected vias, or all selected pins and vias.
2043 The second argument specifies the style of connection.
2044 There are 5 possibilities:
2045 0 - no connection,
2046 1 - 45 degree fingers with sharp edges,
2047 2 - horizontal & vertical fingers with sharp edges,
2048 3 - solid connection,
2049 4 - 45 degree fingers with rounded corners,
2050 5 - horizontal & vertical fingers with rounded corners.
2052 Pins and Vias may have thermals whether or not there is a polygon available
2053 to connect with. However, they will have no effect without the polygon.
2054 %end-doc */
2056 static int
2058 {
2066 {
2070 {
2073 }
2074 else
2077 /* To allow relative values we could search for the first selected
2078 item and make 'kind' relative to that, but that's not too useful
2079 and requires quite some code. For example there's no
2080 GetFirstSelectedPin() function available. Let's postpone this
2081 functionality, there are more urgent things to do. */
2085 {
2090 {
2094 }
2109 }
2110 else
2112 }
2113 else
2120 }
2122 /*!
2123 * \brief Event handler to set the cursor according to the X pointer
2124 * position called from inside main.c.
2125 *
2126 * \warning !!! no action routine !!!
2127 */
2128 void
2130 {
2131 #ifdef HAVE_LIBSTROKE
2133 {
2138 }
2141 {
2142 /* update object position and cursor location */
2145 }
2146 }
2148 /* --------------------------------------------------------------------------- */
2157 /* %start-doc actions SetValue
2159 @table @code
2161 @item ViaDrillingHole
2162 Changes the diameter of the drill for new vias.
2164 @item Grid
2165 Sets the grid spacing.
2167 @item Line
2168 @item LineSize
2169 Changes the thickness of new lines.
2171 @item Via
2172 @item ViaSize
2173 Changes the diameter of new vias.
2175 @item Text
2176 @item TextScale
2177 Changes the size of new text.
2179 @end table
2181 %end-doc */
2183 static int
2185 {
2195 {
2198 {
2209 else
2210 {
2214 /* On the way down, short against the minimum
2215 * PCB drawing unit */
2220 else
2222 }
2250 }
2253 }
2256 }
2259 /* --------------------------------------------------------------------------- */
2265 /* %start-doc actions Quit
2267 If you have unsaved changes, you will be prompted to confirm (or
2268 save) before quitting.
2270 %end-doc */
2272 static int
2274 {
2277 {
2280 }
2284 }
2286 /* --------------------------------------------------------------------------- */
2294 /* %start-doc actions Connection
2296 Connections found with this action will be highlighted in the
2297 ``connected-color'' color and will have the ``found'' flag set.
2299 @table @code
2301 @item Find
2302 The net under the cursor is ``found''.
2304 @item ResetLinesAndPolygons
2305 Any ``found'' lines and polygons are marked ``not found''.
2307 @item ResetPinsAndVias
2308 Any ``found'' pins and vias are marked ``not found''.
2310 @item Reset
2311 All ``found'' objects are marked ``not found''.
2313 @end table
2315 %end-doc */
2317 static int
2319 {
2322 {
2324 {
2326 {
2331 }
2335 {
2338 }
2343 {
2346 }
2351 {
2354 }
2356 }
2358 }
2361 }
2363 /* --------------------------------------------------------------------------- */
2370 /* %start-doc actions DisperseElements
2372 Normally this is used when starting a board, by selecting all elements
2373 and then dispersing them. This scatters the elements around the board
2374 so that you can pick individual ones, rather than have all the
2375 elements at the same 0,0 coordinate and thus impossible to choose
2376 from.
2378 %end-doc */
2380 #define GAP MIL_TO_COORD(100)
2382 static int
2384 {
2393 {
2395 }
2396 else
2397 {
2399 {
2410 }
2411 }
2414 {
2416 }
2420 {
2421 /*
2422 * If we want to disperse selected elements, maybe we need smarter
2423 * code here to avoid putting components on top of others which
2424 * are not selected. For now, I'm assuming that this is typically
2425 * going to be used either with a brand new design or a scratch
2426 * design holding some new components
2427 */
2429 {
2431 /* figure out how much to move the element */
2434 /* snap to the grid */
2437 /*
2438 * and add one grid size so we make sure we always space by GAP or
2439 * more
2440 */
2443 /* Figure out if this row has room. If not, start a new row */
2445 {
2448 }
2450 /* figure out how much to move the element */
2454 /* snap to the grid */
2460 /* move the element */
2463 /* and add to the undo list so we can undo this operation */
2466 /* keep track of how tall this row is */
2469 {
2471 }
2472 }
2474 }
2475 END_LOOP;
2477 /* done with our action so increment the undo # */
2484 }
2486 #undef GAP
2488 /* --------------------------------------------------------------------------- */
2503 /* %start-doc actions Display
2505 @table @code
2507 @item NameOnPCB
2508 @item Description
2509 @item Value
2510 Specify whether all elements show their name, description, or value.
2512 @item Redraw
2513 Redraw the whole board.
2515 @item Toggle45Degree
2516 When clear, lines can be drawn at any angle. When set, lines are
2517 restricted to multiples of 45 degrees and requested lines may be
2518 broken up according to the clip setting.
2520 @item CycleClip
2521 Changes the way lines are restricted to 45 degree increments. The
2522 various settings are: straight only, orthogonal then angled, and angled
2523 then orthogonal. If AllDirections is set, this action disables it.
2525 @item CycleCrosshair
2526 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2527 8-ray and 12-ray cross.
2529 @item ToggleRubberBandMode
2530 If set, moving an object moves all the lines attached to it too.
2532 @item ToggleStartDirection
2533 If set, each time you set a point in a line, the Clip toggles between
2534 orth-angle and angle-ortho.
2536 @item ToggleUniqueNames
2537 If set, you will not be permitted to change the name of an element to
2538 match that of another element.
2540 @item ToggleSnapPin
2541 If set, pin centers and pad end points are treated as additional grid
2542 points that the cursor can snap to.
2544 @item ToggleLocalRef
2545 If set, the mark is automatically set to the beginning of any move, so
2546 you can see the relative distance you've moved.
2548 @item ToggleThindraw
2549 If set, objects on the screen are drawn as outlines (lines are drawn
2550 as center-lines). This lets you see line endpoints hidden under pins,
2551 for example.
2553 @item ToggleThindrawPoly
2554 If set, polygons on the screen are drawn as outlines.
2556 @item ToggleShowDRC
2557 If set, pending objects (i.e. lines you're in the process of drawing)
2558 will be drawn with an outline showing how far away from other copper
2559 you need to be.
2561 @item ToggleLiveRoute
2562 If set, the progress of the autorouter will be visible on the screen.
2564 @item ToggleAutoDRC
2565 If set, you will not be permitted to make connections which violate
2566 the current DRC and netlist settings.
2568 @item ToggleCheckPlanes
2569 If set, lines and arcs aren't drawn, which usually leaves just the
2570 polygons. If you also disable all but the layer you're interested in,
2571 this allows you to check for isolated regions.
2573 @item ToggleOrthoMove
2574 If set, the crosshair is only allowed to move orthogonally from its
2575 previous position. I.e. you can move an element or line up, down,
2576 left, or right, but not up+left or down+right.
2578 @item ToggleName
2579 Selects whether the pinouts show the pin names or the pin numbers.
2581 @item ToggleLockNames
2582 If set, text will ignore left mouse clicks and actions that work on
2583 objects under the mouse. You can still select text with a lasso (left
2584 mouse drag) and perform actions on the selection.
2586 @item ToggleOnlyNames
2587 If set, only text will be sensitive for mouse clicks and actions that
2588 work on objects under the mouse. You can still select other objects
2589 with a lasso (left mouse drag) and perform actions on the selection.
2591 @item ToggleMask
2592 Turns the solder mask on or off.
2594 @item ToggleClearLine
2595 When set, the clear-line flag causes new lines and arcs to have their
2596 ``clear polygons'' flag set, so they won't be electrically connected
2597 to any polygons they overlap.
2599 @item ToggleFullPoly
2600 When set, the full-poly flag causes new polygons to have their
2601 ``full polygon'' flag set, so all parts of them will be displayed
2602 instead of only the biggest one.
2604 @item ToggleGrid
2605 Resets the origin of the current grid to be wherever the mouse pointer
2606 is (not where the crosshair currently is). If you provide two numbers
2607 after this, the origin is set to that coordinate.
2609 @item Grid
2610 Toggles whether the grid is displayed or not.
2612 @item Pinout
2613 Causes the pinout of the element indicated by the cursor to be
2614 displayed, usually in a separate window.
2616 @item PinOrPadName
2617 Toggles whether the names of pins, pads, or (yes) vias will be
2618 displayed. If the cursor is over an element, all of its pins and pads
2619 are affected.
2621 @end table
2623 %end-doc */
2625 static enum crosshair_shape
2627 {
2629 {
2642 }
2644 }
2646 static int
2648 {
2657 {
2659 {
2661 /* redraw layout */
2667 /* change the displayed name of elements */
2672 {
2674 }
2675 END_LOOP;
2678 {
2687 }
2689 {
2691 }
2692 END_LOOP;
2696 /* toggle line-adjust flag */
2705 {
2708 }
2709 else
2786 {
2788 {
2791 }
2793 {
2800 }
2801 }
2832 /* shift grid alignment */
2834 {
2841 }
2844 /* toggle displaying of the grid */
2850 /* display the pinout of an element */
2852 {
2861 {
2864 }
2866 }
2868 /* toggle displaying of pin/pad/via names */
2870 {
2877 {
2880 {
2883 else
2887 }
2888 END_LOOP;
2890 {
2893 else
2897 }
2898 END_LOOP;
2907 else
2919 else
2930 else
2938 }
2940 }
2943 }
2944 }
2946 {
2948 {
2951 {
2956 }
2962 }
2963 }
2964 else
2971 }
2973 /* --------------------------------------------------------------------------- */
2983 /* %start-doc actions Mode
2985 @table @code
2987 @item Arc
2988 @itemx Arrow
2989 @itemx Copy
2990 @itemx InsertPoint
2991 @itemx Line
2992 @itemx Lock
2993 @itemx Move
2994 @itemx None
2995 @itemx PasteBuffer
2996 @itemx Polygon
2997 @itemx Rectangle
2998 @itemx Remove
2999 @itemx Rotate
3000 @itemx Text
3001 @itemx Thermal
3002 @itemx Via
3003 Select the indicated tool.
3005 @item Notify
3006 Called when you press the mouse button, or move the mouse.
3008 @item Release
3009 Called when you release the mouse button.
3011 @item Cancel
3012 Cancels any pending tool activity, allowing you to restart elsewhere.
3013 For example, this allows you to start a new line rather than attach a
3014 line to the previous line.
3016 @item Escape
3017 Similar to Cancel but calling this action a second time will return
3018 to the Arrow tool.
3020 @item Stroke
3021 If your @code{pcb} was built with libstroke, this invokes the stroke
3022 input method. If not, this will restart a drawing mode if you were
3023 drawing, else it will select objects.
3025 @item Save
3026 Remembers the current tool.
3028 @item Restore
3029 Restores the tool to the last saved tool.
3031 @end table
3033 %end-doc */
3035 static int
3037 {
3041 {
3046 {
3072 {
3076 }
3079 {
3081 {
3100 else
3101 {
3104 }
3110 else
3111 {
3114 }
3120 else
3121 {
3124 }
3130 else
3131 {
3134 }
3140 else
3141 {
3144 }
3152 }
3153 }
3168 #ifndef HAVE_LIBSTROKE
3172 #else
3176 else
3179 #endif
3190 #ifdef HAVE_LIBSTROKE
3195 #else
3196 /* Handle middle mouse button restarts of drawing mode. If not in
3197 | a drawing mode, middle mouse button will select objects.
3198 */
3201 {
3203 }
3213 else
3214 {
3219 }
3221 #endif
3239 }
3242 }
3245 }
3247 /* --------------------------------------------------------------------------- */
3253 /* %start-doc actions RemoveSelected
3255 %end-doc */
3257 static int
3259 {
3263 }
3265 /* --------------------------------------------------------------------------- */
3274 /* %start-doc actions Renumber
3276 %end-doc */
3278 static int
3280 {
3292 struct _cnt_list
3293 {
3303 {
3304 /*
3305 * We deal with the case where name already exists in this
3306 * function so the GUI doesn't need to deal with it
3307 */
3316 }
3317 else
3321 {
3324 }
3327 {
3329 }
3332 {
3335 {
3339 }
3340 }
3343 {
3348 }
3356 /*
3357 * Make a first pass through all of the elements and sort them out
3358 * by location on the board. While here we also collect a list of
3359 * locked elements.
3360 *
3361 * We'll actually renumber things in the 2nd pass.
3362 */
3369 {
3372 }
3378 {
3380 {
3381 /*
3382 * add to the list of locked elements which we won't try to
3383 * renumber and whose reference designators are now reserved.
3384 */
3389 lock_cnt++;
3390 }
3392 else
3393 {
3394 /* count of devices which will be renumbered */
3395 cnt++;
3397 /* search for correct position in the list */
3400 i++;
3402 /*
3403 * We have found the position where we have the first element that
3404 * has the same Y value or a lower Y value. Now move forward if
3405 * needed through the X values
3406 */
3410 i++;
3413 {
3415 }
3417 }
3418 }
3419 END_LOOP;
3422 /*
3423 * Now that the elements are sorted by board position, we go through
3424 * and renumber them.
3425 */
3427 /*
3428 * turn off the flag which requires unique names so it doesn't get
3429 * in our way. When we're done with the renumber we will have unique
3430 * names.
3431 */
3437 {
3438 /* If there is no refdes, maybe just spit out a warning */
3440 {
3441 /* figure out the prefix */
3446 j++;
3449 /* check the counter for this prefix */
3454 /* grow the list if needed */
3456 {
3460 {
3463 }
3464 /* zero out the memory that we added */
3466 {
3469 }
3470 }
3472 /*
3473 * start a new counter if we don't have a counter for this
3474 * prefix
3475 */
3477 {
3480 }
3482 /*
3483 * check to see if the new refdes is already used by a
3484 * locked element
3485 */
3486 do
3487 {
3492 /* space for the prefix plus 1 digit plus the '\0' */
3495 /* and 1 more per extra digit needed to hold the number */
3498 {
3499 sz++;
3501 }
3505 /*
3506 * now compare to the list of reserved (by locked
3507 * elements) names
3508 */
3510 {
3514 {
3517 }
3518 }
3520 }
3524 {
3528 /* add this rename to our table of renames so we can update the netlist */
3531 c_cnt++;
3539 tmps);
3542 /* we don't free tmps in this case because it is used */
3543 }
3544 else
3546 }
3547 else
3548 {
3551 }
3553 }
3557 /* restore the unique flag setting */
3562 {
3564 /* update the netlist */
3567 /* iterate over each net */
3569 {
3571 /* iterate over each pin on the net */
3573 {
3575 /* figure out the pin number part from strings like U3-21 */
3581 /* iterate over the list of changed reference designators */
3583 {
3584 /*
3585 * if the pin needs to change, change it and quit
3586 * searching in the list.
3587 */
3589 {
3597 }
3599 }
3601 }
3602 }
3604 {
3607 }
3612 }
3620 }
3623 /* --------------------------------------------------------------------------- */
3630 /* %start-doc actions RipUp
3632 @table @code
3634 @item All
3635 Removes all lines and vias which were created by the autorouter.
3637 @item Selected
3638 Removes all selected lines and vias which were created by the
3639 autorouter.
3641 @item Element
3642 Converts the element under the cursor to parts (vias and lines). Note
3643 that this uses the highest numbered paste buffer.
3645 @end table
3647 %end-doc */
3649 static int
3651 {
3656 {
3658 {
3661 {
3663 {
3666 }
3667 }
3668 ENDALL_LOOP;
3670 {
3672 {
3675 }
3676 }
3677 ENDALL_LOOP;
3679 {
3681 {
3684 }
3685 }
3686 END_LOOP;
3689 {
3692 }
3696 {
3699 {
3702 }
3703 }
3704 ENDALL_LOOP;
3707 {
3710 {
3713 }
3714 }
3715 END_LOOP;
3717 {
3720 }
3723 {
3728 {
3744 }
3745 }
3747 }
3748 }
3750 }
3752 /* --------------------------------------------------------------------------- */
3759 /* %start-doc actions AddRats
3761 @table @code
3763 @item AllRats
3764 Create rat lines for all loaded nets that aren't already connected on
3765 with copper.
3767 @item SelectedRats
3768 Similarly, but only add rat lines for nets connected to selected pins
3769 and pads.
3771 @item Close
3772 Selects the shortest unselected rat on the board.
3774 @end table
3776 %end-doc */
3778 static int
3780 {
3786 {
3790 {
3804 {
3810 {
3813 }
3814 }
3815 END_LOOP;
3817 {
3824 }
3826 }
3827 }
3829 }
3831 /* --------------------------------------------------------------------------- */
3839 /* %start-doc actions Delete
3841 %end-doc */
3843 static int
3845 {
3853 {
3856 }
3859 {
3877 }
3880 }
3882 /* --------------------------------------------------------------------------- */
3889 /* %start-doc actions DeleteRats
3891 %end-doc */
3893 static int
3895 {
3898 {
3902 {
3912 }
3913 }
3915 }
3917 /* --------------------------------------------------------------------------- */
3923 /* %start-doc actions AutoPlaceSelected
3925 Attempts to re-arrange the selected components such that the nets
3926 connecting them are minimized. Note that you cannot undo this.
3928 %end-doc */
3930 static int
3932 {
3936 {
3939 }
3941 }
3943 /* --------------------------------------------------------------------------- */
3949 /* %start-doc actions AutoRoute
3951 @table @code
3953 @item AllRats
3954 Attempt to autoroute all rats.
3956 @item SelectedRats
3957 Attempt to autoroute the selected rats.
3959 @end table
3961 Before autorouting, it's important to set up a few things. First,
3962 make sure any layers you aren't using are disabled, else the
3963 autorouter may use them. Next, make sure the current line and via
3964 styles are set accordingly. Last, make sure "new lines clear
3965 polygons" is set, in case you eventually want to add a copper pour.
3967 Autorouting takes a while. During this time, the program may not be
3968 responsive.
3970 %end-doc */
3972 static int
3974 {
3978 {
3980 {
3990 }
3991 }
3993 }
3995 /* --------------------------------------------------------------------------- */
4003 /* %start-doc actions MarkCrosshair
4005 The ``mark'' is a small X-shaped target on the display which is
4006 treated like a second origin (the normal origin is the upper let
4007 corner of the board). The GUI will display a second set of
4008 coordinates for this mark, which tells you how far you are from it.
4010 If no argument is given, the mark is toggled - disabled if it was
4011 enabled, or enabled at the current cursor position of disabled. If
4012 the @code{Center} argument is given, the mark is moved to the current
4013 cursor location.
4015 %end-doc */
4017 static int
4019 {
4022 {
4024 {
4028 }
4029 else
4030 {
4037 }
4038 }
4040 {
4046 }
4048 }
4050 /* --------------------------------------------------------------------------- */
4061 /* %start-doc actions ChangeSize
4063 For lines and arcs, this changes the width. For pins and vias, this
4064 changes the overall diameter of the copper annulus. For pads, this
4065 changes the width and, indirectly, the length. For texts and names,
4066 this changes the scaling factor. For elements, this changes the width
4067 of the silk layer lines and arcs for this element.
4069 %end-doc */
4071 static int
4073 {
4078 Coord value;
4081 {
4087 {
4089 {
4101 }
4148 }
4149 }
4151 }
4153 /* --------------------------------------------------------------------------- */
4162 /* %start-doc actions ChangeDrillSize
4164 %end-doc */
4166 static int
4168 {
4173 Coord value;
4176 {
4179 {
4181 {
4193 }
4209 }
4210 }
4212 }
4214 /* --------------------------------------------------------------------------- */
4225 /* %start-doc actions ChangeClearSize
4227 If the solder mask is currently showing, this action changes the
4228 solder mask clearance. If the mask is not showing, this action
4229 changes the polygon clearance.
4231 %end-doc */
4233 static int
4235 {
4240 Coord value;
4243 {
4249 {
4251 {
4263 }
4289 }
4290 }
4292 }
4294 /* --------------------------------------------------------------------------- */
4303 /* %start-doc actions MinMaskGap
4305 Checks all specified pins and/or pads, and increases the mask if
4306 needed to ensure a minimum distance between the pin or pad edge and
4307 the mask edge.
4309 %end-doc */
4311 static int
4313 {
4318 Coord value;
4319 Coord thickness;
4326 else
4327 {
4331 }
4336 {
4338 {
4348 {
4351 }
4352 }
4353 END_LOOP;
4355 {
4359 {
4363 }
4364 }
4365 END_LOOP;
4366 }
4367 END_LOOP;
4369 {
4379 {
4382 }
4383 }
4384 END_LOOP;
4388 }
4390 /* --------------------------------------------------------------------------- */
4399 /* %start-doc actions MinClearGap
4401 Checks all specified objects, and increases the polygon clearance if
4402 needed to ensure a minimum distance between their edges and the
4403 polygon edges.
4405 %end-doc */
4407 static int
4409 {
4414 Coord value;
4421 else
4422 {
4426 }
4431 {
4433 {
4437 {
4441 }
4442 }
4443 END_LOOP;
4445 {
4449 {
4453 }
4454 }
4455 END_LOOP;
4456 }
4457 END_LOOP;
4459 {
4463 {
4466 }
4467 }
4468 END_LOOP;
4470 {
4474 {
4477 }
4478 }
4479 ENDALL_LOOP;
4481 {
4485 {
4488 }
4489 }
4490 ENDALL_LOOP;
4494 }
4496 /* --------------------------------------------------------------------------- */
4504 /* %start-doc actions ChangePinName
4506 This can be especially useful for annotating pin names from a
4507 schematic to the layout without requiring knowledge of the pcb file
4508 format.
4510 @example
4511 ChangePinName(U3, 7, VCC)
4512 @end example
4514 %end-doc */
4516 static int
4518 {
4523 {
4525 }
4532 {
4534 {
4536 {
4538 {
4541 /*
4542 * Note: we can't free() pin->Name first because
4543 * it is used in the undo list
4544 */
4548 }
4549 }
4550 END_LOOP;
4553 {
4555 {
4558 /*
4559 * Note: we can't free() pad->Name first because
4560 * it is used in the undo list
4561 */
4565 }
4566 }
4567 END_LOOP;
4568 }
4569 }
4570 END_LOOP;
4571 /*
4572 * done with our action so increment the undo # if we actually
4573 * changed anything
4574 */
4576 {
4579 else
4580 {
4583 }
4584 }
4587 }
4589 /* --------------------------------------------------------------------------- */
4597 /* %start-doc actions ChangeName
4599 @table @code
4601 @item Object
4602 Changes the name of the element under the cursor.
4604 @item Layout
4605 Changes the name of the layout. This is printed on the fab drawings.
4607 @item Layer
4608 Changes the name of the currently active layer.
4610 @end table
4612 %end-doc */
4614 int
4616 {
4621 {
4623 {
4624 /* change the name of an object */
4626 {
4634 {
4637 {
4640 {
4650 {
4656 }
4659 }
4660 }
4661 }
4663 }
4665 /* change the layout's name */
4667 name =
4669 /* NB: ChangeLayoutName takes ownership of the passed memory */
4674 /* change the name of the active layer */
4678 /* NB: ChangeLayerName takes ownership of the passed memory */
4682 }
4683 }
4685 }
4688 /* --------------------------------------------------------------------------- */
4695 /* %start-doc actions MorphPolygon
4697 If a polygon is divided into unconnected "islands", you can use
4698 this command to convert the otherwise disappeared islands into
4699 separate polygons. Be sure the cursor is over a portion of the
4700 polygon that remains visible. Very small islands that may flake
4701 off are automatically deleted.
4703 %end-doc */
4705 static int
4707 {
4710 {
4712 {
4714 {
4721 {
4725 }
4727 }
4731 {
4734 }
4735 ENDALL_LOOP;
4739 }
4740 }
4742 }
4744 /* --------------------------------------------------------------------------- */
4752 /* %start-doc actions ToggleHideName
4754 If names are hidden you won't see them on the screen and they will not
4755 appear on the silk layer when you print the layout.
4757 %end-doc */
4759 static int
4761 {
4764 {
4766 {
4768 {
4775 {
4782 }
4784 }
4787 {
4790 {
4795 {
4802 }
4803 }
4804 END_LOOP;
4806 {
4809 }
4810 }
4811 }
4812 }
4814 }
4816 /* --------------------------------------------------------------------------- */
4824 /* %start-doc actions ChangeJoin
4826 The join flag determines whether a line or arc, drawn to intersect a
4827 polygon, electrically connects to the polygon or not. When joined,
4828 the line/arc is simply drawn over the polygon, making an electrical
4829 connection. When not joined, a gap is drawn between the line and the
4830 polygon, insulating them from each other.
4832 %end-doc */
4834 static int
4836 {
4839 {
4841 {
4844 {
4855 }
4872 }
4873 }
4875 }
4877 /* --------------------------------------------------------------------------- */
4887 /* %start-doc actions ChangeSquare
4889 Note that @code{Pins} means both pins and pads.
4891 @pinshapes
4893 %end-doc */
4895 static int
4897 {
4900 {
4902 {
4905 {
4916 }
4933 }
4934 }
4936 }
4938 /* --------------------------------------------------------------------------- */
4945 /* %start-doc actions SetSquare
4947 Note that @code{Pins} means pins and pads.
4949 @pinshapes
4951 %end-doc */
4953 static int
4955 {
4958 {
4960 {
4963 {
4974 }
4991 }
4992 }
4994 }
4996 /* --------------------------------------------------------------------------- */
5004 /* %start-doc actions ClearSquare
5006 Note that @code{Pins} means pins and pads.
5008 @pinshapes
5010 %end-doc */
5012 static int
5014 {
5017 {
5019 {
5022 {
5033 }
5050 }
5051 }
5053 }
5055 /* --------------------------------------------------------------------------- */
5064 /* %start-doc actions ChangeOctagon
5066 @pinshapes
5068 %end-doc */
5070 static int
5072 {
5075 {
5077 {
5080 {
5091 }
5113 }
5114 }
5116 }
5118 /* --------------------------------------------------------------------------- */
5125 /* %start-doc actions SetOctagon
5127 @pinshapes
5129 %end-doc */
5131 static int
5133 {
5136 {
5138 {
5141 {
5152 }
5174 }
5175 }
5177 }
5179 /* --------------------------------------------------------------------------- */
5188 /* %start-doc actions ClearOctagon
5190 @pinshapes
5192 %end-doc */
5194 static int
5196 {
5199 {
5201 {
5204 {
5215 }
5237 }
5238 }
5240 }
5242 /* --------------------------------------------------------------------------- */
5249 /* %start-doc actions ChangeHole
5251 The "hole flag" of a via determines whether the via is a
5252 plated-through hole (not set), or an unplated hole (set).
5254 %end-doc */
5256 static int
5258 {
5261 {
5263 {
5266 {
5276 }
5283 }
5284 }
5286 }
5288 /* --------------------------------------------------------------------------- */
5296 /* %start-doc actions ChangePaste
5298 The "no paste flag" of a pad determines whether the solderpaste
5299 stencil will have an opening for the pad (no set) or if there wil be
5300 no solderpaste on the pad (set). This is used for things such as
5301 fiducial pads.
5303 %end-doc */
5305 static int
5307 {
5310 {
5312 {
5315 {
5325 }
5332 }
5333 }
5335 }
5337 /* --------------------------------------------------------------------------- */
5350 /* %start-doc actions Select
5352 @table @code
5354 @item ElementByName
5355 @item ObjectByName
5356 @item PadByName
5357 @item PinByName
5358 @item TextByName
5359 @item ViaByName
5360 @item NetByName
5362 These all rely on having a regular expression parser built into
5363 @code{pcb}. If the name is not specified then the user is prompted
5364 for a pattern, and all objects that match the pattern and are of the
5365 type specified are selected.
5367 @item Object
5368 @item ToggleObject
5369 Selects the object under the cursor.
5371 @item Block
5372 Selects all objects in a rectangle indicated by the cursor.
5374 @item All
5375 Selects all objects on the board.
5377 @item Found
5378 Selects all connections with the ``found'' flag set.
5380 @item Connection
5381 Selects all connections with the ``connected'' flag set.
5383 @item Convert
5384 Converts the selected objects to an element. This uses the highest
5385 numbered paste buffer.
5387 @end table
5389 %end-doc */
5391 static int
5393 {
5396 {
5398 {
5399 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5401 /* select objects by their names */
5424 commonByName:
5425 {
5431 {
5436 }
5438 }
5441 /* select a single object */
5448 /* all objects in block */
5450 {
5451 BoxType box;
5465 {
5468 }
5471 }
5473 /* select all visible objects */
5475 {
5476 BoxType box;
5485 }
5487 /* all logical connections */
5490 {
5494 }
5497 /* all physical connections */
5500 {
5504 }
5508 {
5523 }
5529 }
5530 }
5532 }
5534 /* FLAG(have_regex,FlagHaveRegex,0) */
5535 int
5537 {
5538 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5540 #else
5542 #endif
5543 }
5545 /* --------------------------------------------------------------------------- */
5557 /* %start-doc actions Unselect
5559 @table @code
5561 @item All
5562 Unselect all objects.
5564 @item Block
5565 Unselect all objects in a rectangle given by the cursor.
5567 @item Connection
5568 Unselect all connections with the ``found'' flag set.
5570 @item ElementByName
5571 @item ObjectByName
5572 @item PadByName
5573 @item PinByName
5574 @item TextByName
5575 @item ViaByName
5577 These all rely on having a regular expression parser built into
5578 @code{pcb}. If the name is not specified then the user is prompted
5579 for a pattern, and all objects that match the pattern and are of the
5580 type specified are unselected.
5583 @end table
5585 %end-doc */
5587 static int
5589 {
5592 {
5594 {
5595 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5597 /* select objects by their names */
5620 commonByName:
5621 {
5627 {
5632 }
5634 }
5637 /* all objects in block */
5639 {
5640 BoxType box;
5654 {
5657 }
5660 }
5662 /* unselect all visible objects */
5664 {
5665 BoxType box;
5674 }
5676 /* all logical connections */
5679 {
5683 }
5686 /* all physical connections */
5689 {
5693 }
5700 }
5701 }
5703 }
5705 /* --------------------------------------------------------------------------- */
5714 /* %start-doc actions SaveTo
5716 @table @code
5718 @item Layout
5719 Saves the current layout.
5721 @item LayoutAs
5722 Saves the current layout, and remembers the filename used.
5724 @item AllConnections
5725 Save all connections to a file.
5727 @item AllUnusedPins
5728 List all unused pins to a file.
5730 @item ElementConnections
5731 Save connections to the element at the cursor to a file.
5733 @item PasteBuffer
5734 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5736 @end table
5738 %end-doc */
5740 static int
5742 {
5749 {
5753 }
5761 {
5763 {
5769 }
5771 }
5774 {
5778 {
5782 }
5784 }
5787 {
5791 {
5795 }
5797 }
5800 {
5808 {
5812 {
5816 }
5817 }
5819 }
5822 {
5824 }
5827 }
5829 /* --------------------------------------------------------------------------- */
5837 /* %start-doc actions SaveSettings
5839 If you pass no arguments, the settings are stored in
5840 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5841 saved in @code{./pcb.settings}.
5843 %end-doc */
5845 static int
5847 {
5851 }
5853 /* --------------------------------------------------------------------------- */
5860 /* %start-doc actions LoadFrom
5862 This action assumes you know what the filename is. The various GUIs
5863 should have a similar @code{Load} action where the filename is
5864 optional, and will provide their own file selection mechanism to let
5865 you choose the file name.
5867 @table @code
5869 @item Layout
5870 Loads an entire PCB layout, replacing the current one.
5872 @item LayoutToBuffer
5873 Loads an entire PCB layout to the paste buffer.
5875 @item ElementToBuffer
5876 Loads the given element file into the paste buffer. Element files
5877 contain only a single @code{Element} definition, such as the
5878 ``newlib'' library uses.
5880 @item Netlist
5881 Loads a new netlist, replacing any current netlist.
5883 @item Revert
5884 Re-loads the current layout from its disk file, reverting any changes
5885 you may have made.
5887 @end table
5889 %end-doc */
5891 static int
5893 {
5904 {
5909 }
5912 {
5917 }
5920 {
5924 }
5927 {
5934 }
5938 {
5940 }
5943 }
5945 /* --------------------------------------------------------------------------- */
5951 /* %start-doc actions New
5953 If a name is not given, one is prompted for.
5955 %end-doc */
5957 static int
5959 {
5963 {
5966 else
5973 /* do emergency saving
5974 * clear the old struct and allocate memory for the new one
5975 */
5983 /* setup the new name and reset some values to default */
5995 }
5997 }
5999 /*!
6000 * \brief No operation, just for testing purposes.
6001 * syntax: Bell(volume)
6002 */
6003 void
6005 {
6007 }
6009 /* --------------------------------------------------------------------------- */
6020 /* %start-doc actions PasteBuffer
6022 There are a number of paste buffers; the actual limit is a
6023 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
6024 is currently @code{5}. One of these is the ``current'' paste buffer,
6025 often referred to as ``the'' paste buffer.
6027 @table @code
6029 @item AddSelected
6030 Copies the selected objects to the current paste buffer.
6032 @item Clear
6033 Remove all objects from the current paste buffer.
6035 @item Convert
6036 Convert the current paste buffer to an element. Vias are converted to
6037 pins, lines are converted to pads.
6039 @item Restore
6040 Convert any elements in the paste buffer back to vias and lines.
6042 @item Mirror
6043 Flip all objects in the paste buffer vertically (up/down flip). To mirror
6044 horizontally, combine this with rotations.
6046 @item Rotate
6047 Rotates the current buffer. The number to pass is 1..3, where 1 means
6048 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6049 degrees clockwise (270 CCW).
6051 @item Save
6052 Saves any elements in the current buffer to the indicated file.
6054 @item ToLayout
6055 Pastes any elements in the current buffer to the indicated X, Y
6056 coordinates in the layout. The @code{X} and @code{Y} are treated like
6057 @code{delta} is for many other objects. For each, if it's prefixed by
6058 @code{+} or @code{-}, then that amount is relative to the last
6059 location. Otherwise, it's absolute. Units can be
6060 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6061 units, currently 1/100 mil.
6064 @item 1..MAX_BUFFER
6065 Selects the given buffer to be the current paste buffer.
6067 @end table
6069 %end-doc */
6071 static int
6073 {
6082 {
6084 {
6085 /* clear contents of paste buffer */
6090 /* copies objects to paste buffer */
6095 /* converts buffer contents into an element */
6100 /* break up element for editing */
6105 /* Mirror buffer */
6112 {
6115 }
6120 {
6123 }
6126 {
6134 {
6137 }
6139 {
6141 }
6143 }
6145 else
6148 {
6152 {
6157 }
6158 else
6163 }
6167 {
6173 {
6175 }
6177 {
6184 }
6185 else
6186 {
6189 }
6195 }
6198 /* set number */
6200 {
6203 /* correct number */
6206 }
6207 }
6208 }
6212 }
6214 /* --------------------------------------------------------------------------- */
6221 /* %start-doc actions Undo
6223 The unlimited undo feature of @code{Pcb} allows you to recover from
6224 most operations that materially affect you work. Calling
6225 @code{Undo()} without any parameter recovers from the last (non-undo)
6226 operation. @code{ClearList} is used to release the allocated
6227 memory. @code{ClearList} is called whenever a new layout is started or
6228 loaded. See also @code{Redo} and @code{Atomic}.
6230 Note that undo groups operations by serial number; changes with the
6231 same serial number will be undone (or redone) as a group. See
6232 @code{Atomic}.
6234 %end-doc */
6236 static int
6238 {
6241 {
6242 /* don't allow undo in the middle of an operation */
6249 /* undo the last operation */
6255 {
6259 }
6260 /* move anchor point if undoing during line creation */
6262 {
6264 {
6271 }
6273 {
6277 /* this search is guaranteed to succeed */
6284 /* save both ends of line */
6289 /* check that the undo was of the right type */
6291 {
6292 /* wrong undo type, restore anchor points */
6299 }
6300 /* move to new anchor */
6305 /* check if an intermediate point was removed */
6307 {
6308 /* this search should find the restored line */
6316 {
6317 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6321 }
6326 }
6330 {
6333 }
6334 else
6335 {
6336 /* this search is guaranteed to succeed too */
6344 }
6347 }
6348 }
6350 {
6352 {
6356 }
6358 {
6361 /* guaranteed to succeed */
6373 }
6374 }
6375 /* undo the last destructive operation */
6378 }
6380 {
6382 {
6383 /* clear 'undo objects' list */
6387 }
6388 }
6391 }
6393 /* --------------------------------------------------------------------------- */
6399 /* %start-doc actions Redo
6401 This routine allows you to recover from the last undo command. You
6402 might want to do this if you thought that undo was going to revert
6403 something other than what it actually did (in case you are confused
6404 about which operations are un-doable), or if you have been backing up
6405 through a long undo list and over-shoot your stopping point. Any
6406 change that is made since the undo in question will trim the redo
6407 list. For example if you add ten lines, then undo three of them you
6408 could use redo to put them back, but if you move a line on the board
6409 before performing the redo, you will lose the ability to "redo" the
6410 three "undone" lines.
6412 %end-doc */
6414 static int
6416 {
6424 {
6428 {
6434 addedLines++;
6435 }
6436 }
6439 }
6441 /* --------------------------------------------------------------------------- */
6447 /* %start-doc actions Polygon
6449 Polygons need a special action routine to make life easier.
6451 @table @code
6453 @item Close
6454 Creates the final segment of the polygon. This may fail if clipping
6455 to 45 degree lines is switched on, in which case a warning is issued.
6457 @item PreviousPoint
6458 Resets the newly entered corner to the previous one. The Undo action
6459 will call Polygon(PreviousPoint) when appropriate to do so.
6461 @end table
6463 %end-doc */
6465 static int
6467 {
6470 {
6473 {
6474 /* close open polygon if possible */
6479 /* go back to the previous point */
6483 }
6485 }
6487 }
6489 /* --------------------------------------------------------------------------- */
6496 /* %start-doc actions RouteStyle
6498 %end-doc */
6500 static int
6502 {
6508 {
6511 {
6518 }
6519 }
6521 }
6524 /* --------------------------------------------------------------------------- */
6531 /* %start-doc actions MoveObject
6533 The @code{X} and @code{Y} are treated like @code{delta} is for many
6534 other objects. For each, if it's prefixed by @code{+} or @code{-},
6535 then that amount is relative. Otherwise, it's absolute. Units can be
6536 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6537 units, currently 1/100 mil.
6539 %end-doc */
6541 static int
6543 {
6557 {
6560 }
6573 }
6575 /* --------------------------------------------------------------------------- */
6583 /* %start-doc actions MoveToCurrentLayer
6585 Note that moving an element from a component layer to a solder layer,
6586 or from solder to component, won't automatically flip it. Use the
6587 @code{Flip()} action to do that.
6589 %end-doc */
6591 static int
6593 {
6596 {
6598 {
6600 {
6611 }
6618 }
6619 }
6621 }
6629 /* %start-doc actions SetSame
6631 When invoked over any line, arc, polygon, or via, this changes the
6632 current layer to be the layer that item is on, and changes the current
6633 sizes (thickness, keepaway, drill, etc) according to that item.
6635 %end-doc */
6637 static int
6639 {
6645 /* set layer current and size from line or arc */
6647 {
6687 }
6689 {
6692 }
6694 }
6697 /* --------------------------------------------------------------------------- */
6708 /* %start-doc actions SetFlag
6710 Turns the given flag on, regardless of its previous setting. See
6711 @code{ChangeFlag}.
6713 @example
6714 SetFlag(SelectedPins,thermal)
6715 @end example
6717 %end-doc */
6719 static int
6721 {
6726 }
6728 /* --------------------------------------------------------------------------- */
6739 /* %start-doc actions ClrFlag
6741 Turns the given flag off, regardless of its previous setting. See
6742 @code{ChangeFlag}.
6744 @example
6745 ClrFlag(SelectedLines,join)
6746 @end example
6748 %end-doc */
6750 static int
6752 {
6757 }
6759 /* --------------------------------------------------------------------------- */
6771 /* %start-doc actions ChangeFlag
6773 Toggles the given flag on the indicated object(s). The flag may be
6774 one of the flags listed above (square, octagon, thermal, join). The
6775 value may be the number 0 or 1. If the value is 0, the flag is
6776 cleared. If the value is 1, the flag is set.
6778 %end-doc */
6780 static int
6782 {
6791 }
6794 static void
6796 {
6801 {
6804 }
6806 {
6809 }
6811 {
6812 /* Note: these are backwards, because the flag is "clear" but
6813 the command is "join". */
6816 }
6817 else
6818 {
6821 }
6824 {
6826 {
6838 }
6880 }
6881 }
6883 /* --------------------------------------------------------------------------- */
6889 /* %start-doc actions ExecuteFile
6891 Lines starting with @code{#} are ignored.
6893 %end-doc */
6895 static int
6897 {
6910 {
6913 }
6918 {
6919 n++;
6922 /* eat the trailing newline */
6924 sp++;
6927 /* eat leading spaces and tabs */
6930 sp++;
6932 /*
6933 * if we have anything left and its not a comment line
6934 * then execute it
6935 */
6938 {
6939 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6941 }
6942 }
6946 {
6949 }
6952 }
6954 /* --------------------------------------------------------------------------- */
6956 static int
6958 {
6962 }
6964 /* --------------------------------------------------------------------------- */
6970 {
6977 {
6980 {
6983 }
6984 }
6985 END_LOOP;
6987 }
6991 {
6997 }
6999 static void
7001 {
7008 }
7010 /* ---------------------------------------------------------------- */
7017 /* %start-doc actions elementlist
7019 @table @code
7021 @item Start
7022 Indicates the start of an element list; call this before any Need
7023 actions.
7025 @item Need
7026 Searches the board for an element with a matching refdes.
7028 If found, the value and footprint are updated.
7030 If not found, a new element is created with the given footprint and value.
7032 @item Done
7033 Compares the list of elements needed since the most recent
7034 @code{start} with the list of elements actually on the board. Any
7035 elements that weren't listed are selected, so that the user may delete
7036 them.
7038 @end table
7040 %end-doc */
7044 static int
7046 {
7051 }
7053 static int
7055 {
7066 #ifdef DEBUG
7068 #endif
7071 {
7073 {
7075 }
7076 END_LOOP;
7080 }
7083 {
7085 {
7087 {
7089 }
7091 {
7092 /* Unnamed elements should remain untouched */
7094 }
7095 }
7096 END_LOOP;
7102 }
7110 argc --;
7111 argv ++;
7121 #ifdef DEBUG
7125 #endif
7130 {
7133 #ifdef DEBUG
7135 #endif
7136 /* Not on board, need to add it. */
7138 {
7139 number_of_footprints_not_found ++;
7141 }
7152 {
7155 }
7166 /* Place components onto center of board. */
7169 }
7172 {
7173 #ifdef DEBUG
7175 #endif
7180 /* Different footprint, we need to swap them out. */
7182 {
7183 number_of_footprints_not_found ++;
7185 }
7200 {
7205 }
7211 }
7213 /* Now reload footprint */
7226 #ifdef DEBUG
7228 #endif
7231 }
7233 /* ---------------------------------------------------------------- */
7240 /* %start-doc actions elementsetattr
7242 If a value is specified, the named attribute is added (if not already
7243 present) or changed (if it is) to the given value. If the value is
7244 not specified, the given attribute is removed if present.
7246 %end-doc */
7248 static int
7250 {
7256 {
7258 }
7265 {
7267 {
7270 }
7271 }
7272 END_LOOP;
7275 {
7278 }
7283 {
7286 }
7288 {
7290 }
7292 {
7294 }
7297 }
7299 /* ---------------------------------------------------------------- */
7304 /* %start-doc actions execcommand
7306 Runs the given command, which is a system executable.
7308 %end-doc */
7310 static int
7312 {
7316 {
7318 }
7325 }
7327 /* ---------------------------------------------------------------- */
7329 static int
7331 {
7332 #ifdef HAVE__SPAWNVP
7336 else
7338 #else
7342 {
7343 /* error */
7346 }
7348 {
7349 /* Child */
7352 }
7353 else
7354 {
7356 /* Parent */
7358 }
7360 #endif
7361 }
7363 /* ---------------------------------------------------------------- */
7365 /*!
7366 * \brief Creates a new temporary file name.
7367 *
7368 * Hopefully the operating system provides a mkdtemp() function to
7369 * securily create a temporary directory with mode 0700.\n
7370 * If so then that directory is created and the returned string is made
7371 * up of the directory plus the name variable.\n
7372 * For example:\n
7373 *
7374 * tempfile_name_new ("myfile") might return
7375 * "/var/tmp/pcb.123456/myfile".
7376 *
7377 * If mkdtemp() is not available then 'name' is ignored and the
7378 * insecure tmpnam() function is used.
7379 *
7380 * Files/names created with tempfile_name_new() should be unlinked
7381 * with tempfile_unlink to make sure the temporary directory is also
7382 * removed when mkdtemp() is used.
7383 */
7386 {
7388 #ifdef HAVE_MKDTEMP
7391 #endif
7395 #ifdef HAVE_MKDTEMP
7401 /* FIXME -- what about win32? */
7404 }
7414 }
7424 }
7431 ;
7441 #undef TEMPLATE
7442 #else
7443 /*
7444 * tmpnam() uses a static buffer so strdup() the result right away
7445 * in case someone decides to create multiple temp names.
7446 */
7448 #ifdef __WIN32__
7449 {
7450 /* Guile doesn't like \ separators */
7455 }
7456 #endif
7457 #endif
7460 }
7462 /* ---------------------------------------------------------------- */
7464 /*!
7465 * \brief Unlink a temporary file.
7466 *
7467 * If we have mkdtemp() then our temp file lives in a temporary
7468 * directory and we need to remove that directory too.
7469 */
7470 static int
7472 {
7473 #ifdef DEBUG
7474 /* SDB says: Want to keep old temp files for examiniation when debugging */
7476 #endif
7478 #ifdef HAVE_MKDTEMP
7483 /* it is possible that the file was never created so it is OK if the
7484 unlink fails */
7486 /* now figure out the directory name to remove */
7493 /*
7494 * at this point, e *should* point to the end of the directory part
7495 * but lets make sure.
7496 */
7501 }
7505 __FUNCTION__);
7509 }
7511 /* name was allocated with malloc */
7515 /*
7516 * FIXME - should also return -1 if the temp file exists and was not
7517 * removed.
7518 */
7521 }
7523 #else
7530 }
7533 #endif
7536 }
7538 /* ---------------------------------------------------------------- */
7547 /* %start-doc actions Import
7549 Imports element and netlist data from the schematics (or some other
7550 source). The first parameter, which is optional, is the mode. If not
7551 specified, the @code{import::mode} attribute in the PCB is used.
7552 @code{gnetlist} means gnetlist is used to obtain the information from
7553 the schematics. @code{make} invokes @code{make}, assuming the user
7554 has a @code{Makefile} in the current directory. The @code{Makefile}
7555 will be invoked with the following variables set:
7557 @table @code
7559 @item PCB
7560 The name of the .pcb file
7562 @item SRCLIST
7563 A space-separated list of source files
7565 @item OUT
7566 The name of the file in which to put the command script, which may
7567 contain any @pcb{} actions. By default, this is a temporary file
7568 selected by @pcb{}, but if you specify an @code{import::outfile}
7569 attribute, that file name is used instead (and not automatically
7570 deleted afterwards).
7572 @end table
7574 The target specified to be built is the first of these that apply:
7576 @itemize @bullet
7578 @item
7579 The target specified by an @code{import::target} attribute.
7581 @item
7582 The output file specified by an @code{import::outfile} attribute.
7584 @item
7585 If nothing else is specified, the target is @code{pcb_import}.
7587 @end itemize
7589 If you specify an @code{import::makefile} attribute, then "-f <that
7590 file>" will be added to the command line.
7592 If you specify the mode, you may also specify the source files
7593 (schematics). If you do not specify any, the list of schematics is
7594 obtained by reading the @code{import::src@var{N}} attributes (like
7595 @code{import::src0}, @code{import::src1}, etc).
7597 For compatibility with future extensions to the import file format,
7598 the generated file @emph{must not} start with the two characters
7599 @code{#%}.
7601 If a temporary file is needed the @code{TMPDIR} environment variable
7602 is used to select its location.
7604 Note that the programs @code{gnetlist} and @code{make} may be
7605 overridden by the user via the @code{make-program} and @code{gnetlist}
7606 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7607 line).
7609 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7610 is called to let user choose (see @code{ImportGUI()}).
7612 Note that Import() doesn't delete anything - after an Import, elements
7613 which shouldn't be on the board are selected and may be removed once
7614 it's determined that the deletion is appropriate.
7616 If @code{Import()} is called with @code{setnewpoint}, then the location
7617 of new components can be specified. This is where parts show up when
7618 they're added to the board. The default is the center of the board.
7620 @table @code
7622 @item Import(setnewpoint)
7624 Prompts the user to click on the board somewhere, uses that point. If
7625 called by a hotkey, uses the current location of the crosshair.
7627 @item Import(setnewpoint,mark)
7629 Uses the location of the mark. If no mark is present, the point is
7630 not changed.
7632 @item Import(setnewpoint,center)
7634 Resets the point to the center of the board.
7636 @item Import(setnewpoint,X,Y,units)
7638 Sets the point to the specific coordinates given. Example:
7639 @code{Import(setnewpoint,50,25,mm)}
7641 @end table
7643 Note that the X and Y locations are stored in attributes named
7644 @code{import::newX} and @code{import::newY} so you could change them
7645 manually if you wished.
7647 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7648 placed elements are dispersed relative to the set point. For example,
7649 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7650 10mm away from the point. The default dispersion is 1/10th of the
7651 smallest board dimension. Dispersion is saved in the
7652 @code{import::disperse} attribute.
7654 %end-doc */
7656 static int
7658 {
7663 #ifdef DEBUG
7665 #endif
7670 {
7677 {
7680 }
7682 {
7685 }
7686 else
7691 }
7694 {
7704 {
7706 }
7708 {
7712 }
7714 {
7720 }
7722 {
7725 }
7726 else
7727 {
7730 }
7737 }
7745 {
7748 }
7751 {
7757 nsources ++;
7763 {
7767 nsources ++;
7772 }
7773 }
7776 {
7777 /* Replace .pcb with .sch and hope for the best. */
7799 {
7802 }
7808 }
7811 {
7819 }
7832 #ifdef DEBUG
7836 #endif
7839 {
7842 }
7844 #ifdef DEBUG
7845 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7846 #endif
7854 }
7856 {
7876 else
7877 {
7883 }
7885 }
7893 {
7897 }
7906 {
7909 }
7914 {
7921 }
7932 }
7933 else
7934 {
7937 }
7942 #ifdef DEBUG
7944 #endif
7947 }
7949 /* ------------------------------------------------------------ */
7959 /* %start-doc actions Attributes
7961 This just pops up a dialog letting the user edit the attributes of the
7962 pcb, an element, or a layer.
7964 %end-doc */
7967 static int
7969 {
7978 {
7981 }
7984 {
7986 {
7989 }
7992 {
7995 {
8000 {
8003 }
8005 {
8008 }
8009 }
8016 }
8019 {
8023 {
8025 {
8027 n_found ++;
8028 }
8029 }
8030 END_LOOP;
8032 {
8035 }
8037 {
8044 else
8045 {
8048 }
8049 }
8052 {
8056 }
8057 else
8058 {
8060 }
8064 }
8068 }
8071 }
8073 /* --------------------------------------------------------------------------- */
8075 HID_Action action_action_list[] = {
8078 ,
8081 ,
8084 ,
8087 ,
8090 ,
8093 ,
8096 ,
8099 ,
8102 ,
8105 ,
8108 ,
8111 ,
8114 ,
8117 ,
8120 ,
8123 ,
8126 ,
8129 ,
8132 ,
8135 ,
8138 ,
8141 ,
8144 ,
8147 ,
8150 ,
8153 ,
8156 ,
8159 ,
8162 ,
8165 ,
8168 ,
8171 ,
8174 ,
8177 ,
8180 ,
8183 ,
8186 ,
8189 ,
8192 ,
8195 ,
8198 ,
8201 ,
8204 ,
8207 ,
8210 ,
8213 ,
8216 ,
8219 ,
8222 ,
8225 ,
8228 ,
8231 ,
8234 ,
8237 ,
8240 ,
8243 ,
8246 ,
8249 ,
8251 ,
8254 ,
8257 ,
8260 ,
8263 ,
8264 };