| blob | 7a31a59b1c7df75f0491bdc47e27f804f0caaeb7 |
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 {
3825 }
3827 }
3828 }
3830 }
3832 /* --------------------------------------------------------------------------- */
3840 /* %start-doc actions Delete
3842 %end-doc */
3844 static int
3846 {
3854 {
3857 }
3860 {
3878 }
3881 }
3883 /* --------------------------------------------------------------------------- */
3890 /* %start-doc actions DeleteRats
3892 %end-doc */
3894 static int
3896 {
3899 {
3903 {
3913 }
3914 }
3916 }
3918 /* --------------------------------------------------------------------------- */
3924 /* %start-doc actions AutoPlaceSelected
3926 Attempts to re-arrange the selected components such that the nets
3927 connecting them are minimized. Note that you cannot undo this.
3929 %end-doc */
3931 static int
3933 {
3937 {
3940 }
3942 }
3944 /* --------------------------------------------------------------------------- */
3950 /* %start-doc actions AutoRoute
3952 @table @code
3954 @item AllRats
3955 Attempt to autoroute all rats.
3957 @item SelectedRats
3958 Attempt to autoroute the selected rats.
3960 @end table
3962 Before autorouting, it's important to set up a few things. First,
3963 make sure any layers you aren't using are disabled, else the
3964 autorouter may use them. Next, make sure the current line and via
3965 styles are set accordingly. Last, make sure "new lines clear
3966 polygons" is set, in case you eventually want to add a copper pour.
3968 Autorouting takes a while. During this time, the program may not be
3969 responsive.
3971 %end-doc */
3973 static int
3975 {
3979 {
3981 {
3991 }
3992 }
3994 }
3996 /* --------------------------------------------------------------------------- */
4004 /* %start-doc actions MarkCrosshair
4006 The ``mark'' is a small X-shaped target on the display which is
4007 treated like a second origin (the normal origin is the upper let
4008 corner of the board). The GUI will display a second set of
4009 coordinates for this mark, which tells you how far you are from it.
4011 If no argument is given, the mark is toggled - disabled if it was
4012 enabled, or enabled at the current cursor position of disabled. If
4013 the @code{Center} argument is given, the mark is moved to the current
4014 cursor location.
4016 %end-doc */
4018 static int
4020 {
4023 {
4025 {
4029 }
4030 else
4031 {
4038 }
4039 }
4041 {
4047 }
4049 }
4051 /* --------------------------------------------------------------------------- */
4062 /* %start-doc actions ChangeSize
4064 For lines and arcs, this changes the width. For pins and vias, this
4065 changes the overall diameter of the copper annulus. For pads, this
4066 changes the width and, indirectly, the length. For texts and names,
4067 this changes the scaling factor. For elements, this changes the width
4068 of the silk layer lines and arcs for this element.
4070 %end-doc */
4072 static int
4074 {
4079 Coord value;
4082 {
4088 {
4090 {
4102 }
4149 }
4150 }
4152 }
4154 /* --------------------------------------------------------------------------- */
4163 /* %start-doc actions ChangeDrillSize
4165 %end-doc */
4167 static int
4169 {
4174 Coord value;
4177 {
4180 {
4182 {
4194 }
4210 }
4211 }
4213 }
4215 /* --------------------------------------------------------------------------- */
4226 /* %start-doc actions ChangeClearSize
4228 If the solder mask is currently showing, this action changes the
4229 solder mask clearance. If the mask is not showing, this action
4230 changes the polygon clearance.
4232 %end-doc */
4234 static int
4236 {
4241 Coord value;
4244 {
4250 {
4252 {
4264 }
4290 }
4291 }
4293 }
4295 /* --------------------------------------------------------------------------- */
4304 /* %start-doc actions MinMaskGap
4306 Checks all specified pins and/or pads, and increases the mask if
4307 needed to ensure a minimum distance between the pin or pad edge and
4308 the mask edge.
4310 %end-doc */
4312 static int
4314 {
4319 Coord value;
4320 Coord thickness;
4327 else
4328 {
4332 }
4337 {
4339 {
4349 {
4352 }
4353 }
4354 END_LOOP;
4356 {
4360 {
4364 }
4365 }
4366 END_LOOP;
4367 }
4368 END_LOOP;
4370 {
4380 {
4383 }
4384 }
4385 END_LOOP;
4389 }
4391 /* --------------------------------------------------------------------------- */
4400 /* %start-doc actions MinClearGap
4402 Checks all specified objects, and increases the polygon clearance if
4403 needed to ensure a minimum distance between their edges and the
4404 polygon edges.
4406 %end-doc */
4408 static int
4410 {
4415 Coord value;
4422 else
4423 {
4427 }
4432 {
4434 {
4438 {
4442 }
4443 }
4444 END_LOOP;
4446 {
4450 {
4454 }
4455 }
4456 END_LOOP;
4457 }
4458 END_LOOP;
4460 {
4464 {
4467 }
4468 }
4469 END_LOOP;
4471 {
4475 {
4478 }
4479 }
4480 ENDALL_LOOP;
4482 {
4486 {
4489 }
4490 }
4491 ENDALL_LOOP;
4495 }
4497 /* --------------------------------------------------------------------------- */
4505 /* %start-doc actions ChangePinName
4507 This can be especially useful for annotating pin names from a
4508 schematic to the layout without requiring knowledge of the pcb file
4509 format.
4511 @example
4512 ChangePinName(U3, 7, VCC)
4513 @end example
4515 %end-doc */
4517 static int
4519 {
4524 {
4526 }
4533 {
4535 {
4537 {
4539 {
4542 /*
4543 * Note: we can't free() pin->Name first because
4544 * it is used in the undo list
4545 */
4549 }
4550 }
4551 END_LOOP;
4554 {
4556 {
4559 /*
4560 * Note: we can't free() pad->Name first because
4561 * it is used in the undo list
4562 */
4566 }
4567 }
4568 END_LOOP;
4569 }
4570 }
4571 END_LOOP;
4572 /*
4573 * done with our action so increment the undo # if we actually
4574 * changed anything
4575 */
4577 {
4580 else
4581 {
4584 }
4585 }
4588 }
4590 /* --------------------------------------------------------------------------- */
4598 /* %start-doc actions ChangeName
4600 @table @code
4602 @item Object
4603 Changes the name of the element under the cursor.
4605 @item Layout
4606 Changes the name of the layout. This is printed on the fab drawings.
4608 @item Layer
4609 Changes the name of the currently active layer.
4611 @end table
4613 %end-doc */
4615 int
4617 {
4622 {
4624 {
4625 /* change the name of an object */
4627 {
4635 {
4638 {
4641 {
4651 {
4657 }
4660 }
4661 }
4662 }
4664 }
4666 /* change the layout's name */
4668 name =
4670 /* NB: ChangeLayoutName takes ownership of the passed memory */
4675 /* change the name of the active layer */
4679 /* NB: ChangeLayerName takes ownership of the passed memory */
4683 }
4684 }
4686 }
4689 /* --------------------------------------------------------------------------- */
4696 /* %start-doc actions MorphPolygon
4698 If a polygon is divided into unconnected "islands", you can use
4699 this command to convert the otherwise disappeared islands into
4700 separate polygons. Be sure the cursor is over a portion of the
4701 polygon that remains visible. Very small islands that may flake
4702 off are automatically deleted.
4704 %end-doc */
4706 static int
4708 {
4711 {
4713 {
4715 {
4722 {
4726 }
4728 }
4732 {
4735 }
4736 ENDALL_LOOP;
4740 }
4741 }
4743 }
4745 /* --------------------------------------------------------------------------- */
4753 /* %start-doc actions ToggleHideName
4755 If names are hidden you won't see them on the screen and they will not
4756 appear on the silk layer when you print the layout.
4758 %end-doc */
4760 static int
4762 {
4765 {
4767 {
4769 {
4776 {
4783 }
4785 }
4788 {
4791 {
4796 {
4803 }
4804 }
4805 END_LOOP;
4807 {
4810 }
4811 }
4812 }
4813 }
4815 }
4817 /* --------------------------------------------------------------------------- */
4825 /* %start-doc actions ChangeJoin
4827 The join flag determines whether a line or arc, drawn to intersect a
4828 polygon, electrically connects to the polygon or not. When joined,
4829 the line/arc is simply drawn over the polygon, making an electrical
4830 connection. When not joined, a gap is drawn between the line and the
4831 polygon, insulating them from each other.
4833 %end-doc */
4835 static int
4837 {
4840 {
4842 {
4845 {
4856 }
4873 }
4874 }
4876 }
4878 /* --------------------------------------------------------------------------- */
4888 /* %start-doc actions ChangeSquare
4890 Note that @code{Pins} means both pins and pads.
4892 @pinshapes
4894 %end-doc */
4896 static int
4898 {
4901 {
4903 {
4906 {
4917 }
4934 }
4935 }
4937 }
4939 /* --------------------------------------------------------------------------- */
4946 /* %start-doc actions SetSquare
4948 Note that @code{Pins} means pins and pads.
4950 @pinshapes
4952 %end-doc */
4954 static int
4956 {
4959 {
4961 {
4964 {
4975 }
4992 }
4993 }
4995 }
4997 /* --------------------------------------------------------------------------- */
5005 /* %start-doc actions ClearSquare
5007 Note that @code{Pins} means pins and pads.
5009 @pinshapes
5011 %end-doc */
5013 static int
5015 {
5018 {
5020 {
5023 {
5034 }
5051 }
5052 }
5054 }
5056 /* --------------------------------------------------------------------------- */
5065 /* %start-doc actions ChangeOctagon
5067 @pinshapes
5069 %end-doc */
5071 static int
5073 {
5076 {
5078 {
5081 {
5092 }
5114 }
5115 }
5117 }
5119 /* --------------------------------------------------------------------------- */
5126 /* %start-doc actions SetOctagon
5128 @pinshapes
5130 %end-doc */
5132 static int
5134 {
5137 {
5139 {
5142 {
5153 }
5175 }
5176 }
5178 }
5180 /* --------------------------------------------------------------------------- */
5189 /* %start-doc actions ClearOctagon
5191 @pinshapes
5193 %end-doc */
5195 static int
5197 {
5200 {
5202 {
5205 {
5216 }
5238 }
5239 }
5241 }
5243 /* --------------------------------------------------------------------------- */
5250 /* %start-doc actions ChangeHole
5252 The "hole flag" of a via determines whether the via is a
5253 plated-through hole (not set), or an unplated hole (set).
5255 %end-doc */
5257 static int
5259 {
5262 {
5264 {
5267 {
5277 }
5284 }
5285 }
5287 }
5289 /* --------------------------------------------------------------------------- */
5297 /* %start-doc actions ChangePaste
5299 The "no paste flag" of a pad determines whether the solderpaste
5300 stencil will have an opening for the pad (no set) or if there wil be
5301 no solderpaste on the pad (set). This is used for things such as
5302 fiducial pads.
5304 %end-doc */
5306 static int
5308 {
5311 {
5313 {
5316 {
5326 }
5333 }
5334 }
5336 }
5338 /* --------------------------------------------------------------------------- */
5351 /* %start-doc actions Select
5353 @table @code
5355 @item ElementByName
5356 @item ObjectByName
5357 @item PadByName
5358 @item PinByName
5359 @item TextByName
5360 @item ViaByName
5361 @item NetByName
5363 These all rely on having a regular expression parser built into
5364 @code{pcb}. If the name is not specified then the user is prompted
5365 for a pattern, and all objects that match the pattern and are of the
5366 type specified are selected.
5368 @item Object
5369 @item ToggleObject
5370 Selects the object under the cursor.
5372 @item Block
5373 Selects all objects in a rectangle indicated by the cursor.
5375 @item All
5376 Selects all objects on the board.
5378 @item Found
5379 Selects all connections with the ``found'' flag set.
5381 @item Connection
5382 Selects all connections with the ``connected'' flag set.
5384 @item Convert
5385 Converts the selected objects to an element. This uses the highest
5386 numbered paste buffer.
5388 @end table
5390 %end-doc */
5392 static int
5394 {
5397 {
5399 {
5400 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5402 /* select objects by their names */
5425 commonByName:
5426 {
5432 {
5437 }
5439 }
5442 /* select a single object */
5449 /* all objects in block */
5451 {
5452 BoxType box;
5466 {
5469 }
5472 }
5474 /* select all visible objects */
5476 {
5477 BoxType box;
5486 }
5488 /* all logical connections */
5491 {
5495 }
5498 /* all physical connections */
5501 {
5505 }
5509 {
5524 }
5530 }
5531 }
5533 }
5535 /* FLAG(have_regex,FlagHaveRegex,0) */
5536 int
5538 {
5539 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5541 #else
5543 #endif
5544 }
5546 /* --------------------------------------------------------------------------- */
5558 /* %start-doc actions Unselect
5560 @table @code
5562 @item All
5563 Unselect all objects.
5565 @item Block
5566 Unselect all objects in a rectangle given by the cursor.
5568 @item Connection
5569 Unselect all connections with the ``found'' flag set.
5571 @item ElementByName
5572 @item ObjectByName
5573 @item PadByName
5574 @item PinByName
5575 @item TextByName
5576 @item ViaByName
5578 These all rely on having a regular expression parser built into
5579 @code{pcb}. If the name is not specified then the user is prompted
5580 for a pattern, and all objects that match the pattern and are of the
5581 type specified are unselected.
5584 @end table
5586 %end-doc */
5588 static int
5590 {
5593 {
5595 {
5596 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5598 /* select objects by their names */
5621 commonByName:
5622 {
5628 {
5633 }
5635 }
5638 /* all objects in block */
5640 {
5641 BoxType box;
5655 {
5658 }
5661 }
5663 /* unselect all visible objects */
5665 {
5666 BoxType box;
5675 }
5677 /* all logical connections */
5680 {
5684 }
5687 /* all physical connections */
5690 {
5694 }
5701 }
5702 }
5704 }
5706 /* --------------------------------------------------------------------------- */
5715 /* %start-doc actions SaveTo
5717 @table @code
5719 @item Layout
5720 Saves the current layout.
5722 @item LayoutAs
5723 Saves the current layout, and remembers the filename used.
5725 @item AllConnections
5726 Save all connections to a file.
5728 @item AllUnusedPins
5729 List all unused pins to a file.
5731 @item ElementConnections
5732 Save connections to the element at the cursor to a file.
5734 @item PasteBuffer
5735 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5737 @end table
5739 %end-doc */
5741 static int
5743 {
5750 {
5754 }
5762 {
5764 {
5770 }
5772 }
5775 {
5779 {
5783 }
5785 }
5788 {
5792 {
5796 }
5798 }
5801 {
5809 {
5813 {
5817 }
5818 }
5820 }
5823 {
5825 }
5828 }
5830 /* --------------------------------------------------------------------------- */
5838 /* %start-doc actions SaveSettings
5840 If you pass no arguments, the settings are stored in
5841 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5842 saved in @code{./pcb.settings}.
5844 %end-doc */
5846 static int
5848 {
5852 }
5854 /* --------------------------------------------------------------------------- */
5861 /* %start-doc actions LoadFrom
5863 This action assumes you know what the filename is. The various GUIs
5864 should have a similar @code{Load} action where the filename is
5865 optional, and will provide their own file selection mechanism to let
5866 you choose the file name.
5868 @table @code
5870 @item Layout
5871 Loads an entire PCB layout, replacing the current one.
5873 @item LayoutToBuffer
5874 Loads an entire PCB layout to the paste buffer.
5876 @item ElementToBuffer
5877 Loads the given element file into the paste buffer. Element files
5878 contain only a single @code{Element} definition, such as the
5879 ``newlib'' library uses.
5881 @item Netlist
5882 Loads a new netlist, replacing any current netlist.
5884 @item Revert
5885 Re-loads the current layout from its disk file, reverting any changes
5886 you may have made.
5888 @end table
5890 %end-doc */
5892 static int
5894 {
5905 {
5910 }
5913 {
5918 }
5921 {
5925 }
5928 {
5935 }
5939 {
5941 }
5944 }
5946 /* --------------------------------------------------------------------------- */
5952 /* %start-doc actions New
5954 If a name is not given, one is prompted for.
5956 %end-doc */
5958 static int
5960 {
5964 {
5967 else
5974 /* do emergency saving
5975 * clear the old struct and allocate memory for the new one
5976 */
5984 /* setup the new name and reset some values to default */
5996 }
5998 }
6000 /*!
6001 * \brief No operation, just for testing purposes.
6002 * syntax: Bell(volume)
6003 */
6004 void
6006 {
6008 }
6010 /* --------------------------------------------------------------------------- */
6021 /* %start-doc actions PasteBuffer
6023 There are a number of paste buffers; the actual limit is a
6024 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
6025 is currently @code{5}. One of these is the ``current'' paste buffer,
6026 often referred to as ``the'' paste buffer.
6028 @table @code
6030 @item AddSelected
6031 Copies the selected objects to the current paste buffer.
6033 @item Clear
6034 Remove all objects from the current paste buffer.
6036 @item Convert
6037 Convert the current paste buffer to an element. Vias are converted to
6038 pins, lines are converted to pads.
6040 @item Restore
6041 Convert any elements in the paste buffer back to vias and lines.
6043 @item Mirror
6044 Flip all objects in the paste buffer vertically (up/down flip). To mirror
6045 horizontally, combine this with rotations.
6047 @item Rotate
6048 Rotates the current buffer. The number to pass is 1..3, where 1 means
6049 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6050 degrees clockwise (270 CCW).
6052 @item Save
6053 Saves any elements in the current buffer to the indicated file.
6055 @item ToLayout
6056 Pastes any elements in the current buffer to the indicated X, Y
6057 coordinates in the layout. The @code{X} and @code{Y} are treated like
6058 @code{delta} is for many other objects. For each, if it's prefixed by
6059 @code{+} or @code{-}, then that amount is relative to the last
6060 location. Otherwise, it's absolute. Units can be
6061 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6062 units, currently 1/100 mil.
6065 @item 1..MAX_BUFFER
6066 Selects the given buffer to be the current paste buffer.
6068 @end table
6070 %end-doc */
6072 static int
6074 {
6083 {
6085 {
6086 /* clear contents of paste buffer */
6091 /* copies objects to paste buffer */
6096 /* converts buffer contents into an element */
6101 /* break up element for editing */
6106 /* Mirror buffer */
6113 {
6116 }
6121 {
6124 }
6127 {
6135 {
6138 }
6140 {
6142 }
6144 }
6146 else
6149 {
6153 {
6158 }
6159 else
6164 }
6168 {
6174 {
6176 }
6178 {
6185 }
6186 else
6187 {
6190 }
6196 }
6199 /* set number */
6201 {
6204 /* correct number */
6207 }
6208 }
6209 }
6213 }
6215 /* --------------------------------------------------------------------------- */
6222 /* %start-doc actions Undo
6224 The unlimited undo feature of @code{Pcb} allows you to recover from
6225 most operations that materially affect you work. Calling
6226 @code{Undo()} without any parameter recovers from the last (non-undo)
6227 operation. @code{ClearList} is used to release the allocated
6228 memory. @code{ClearList} is called whenever a new layout is started or
6229 loaded. See also @code{Redo} and @code{Atomic}.
6231 Note that undo groups operations by serial number; changes with the
6232 same serial number will be undone (or redone) as a group. See
6233 @code{Atomic}.
6235 %end-doc */
6237 static int
6239 {
6242 {
6243 /* don't allow undo in the middle of an operation */
6250 /* undo the last operation */
6256 {
6260 }
6261 /* move anchor point if undoing during line creation */
6263 {
6265 {
6272 }
6274 {
6278 /* this search is guaranteed to succeed */
6285 /* save both ends of line */
6290 /* check that the undo was of the right type */
6292 {
6293 /* wrong undo type, restore anchor points */
6300 }
6301 /* move to new anchor */
6306 /* check if an intermediate point was removed */
6308 {
6309 /* this search should find the restored line */
6317 {
6318 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6322 }
6327 }
6331 {
6334 }
6335 else
6336 {
6337 /* this search is guaranteed to succeed too */
6345 }
6348 }
6349 }
6351 {
6353 {
6357 }
6359 {
6362 /* guaranteed to succeed */
6374 }
6375 }
6376 /* undo the last destructive operation */
6379 }
6381 {
6383 {
6384 /* clear 'undo objects' list */
6388 }
6389 }
6392 }
6394 /* --------------------------------------------------------------------------- */
6400 /* %start-doc actions Redo
6402 This routine allows you to recover from the last undo command. You
6403 might want to do this if you thought that undo was going to revert
6404 something other than what it actually did (in case you are confused
6405 about which operations are un-doable), or if you have been backing up
6406 through a long undo list and over-shoot your stopping point. Any
6407 change that is made since the undo in question will trim the redo
6408 list. For example if you add ten lines, then undo three of them you
6409 could use redo to put them back, but if you move a line on the board
6410 before performing the redo, you will lose the ability to "redo" the
6411 three "undone" lines.
6413 %end-doc */
6415 static int
6417 {
6425 {
6429 {
6435 addedLines++;
6436 }
6437 }
6440 }
6442 /* --------------------------------------------------------------------------- */
6448 /* %start-doc actions Polygon
6450 Polygons need a special action routine to make life easier.
6452 @table @code
6454 @item Close
6455 Creates the final segment of the polygon. This may fail if clipping
6456 to 45 degree lines is switched on, in which case a warning is issued.
6458 @item PreviousPoint
6459 Resets the newly entered corner to the previous one. The Undo action
6460 will call Polygon(PreviousPoint) when appropriate to do so.
6462 @end table
6464 %end-doc */
6466 static int
6468 {
6471 {
6474 {
6475 /* close open polygon if possible */
6480 /* go back to the previous point */
6484 }
6486 }
6488 }
6490 /* --------------------------------------------------------------------------- */
6497 /* %start-doc actions RouteStyle
6499 %end-doc */
6501 static int
6503 {
6509 {
6512 {
6519 }
6520 }
6522 }
6525 /* --------------------------------------------------------------------------- */
6532 /* %start-doc actions MoveObject
6534 The @code{X} and @code{Y} are treated like @code{delta} is for many
6535 other objects. For each, if it's prefixed by @code{+} or @code{-},
6536 then that amount is relative. Otherwise, it's absolute. Units can be
6537 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6538 units, currently 1/100 mil.
6540 %end-doc */
6542 static int
6544 {
6558 {
6561 }
6574 }
6576 /* --------------------------------------------------------------------------- */
6584 /* %start-doc actions MoveToCurrentLayer
6586 Note that moving an element from a component layer to a solder layer,
6587 or from solder to component, won't automatically flip it. Use the
6588 @code{Flip()} action to do that.
6590 %end-doc */
6592 static int
6594 {
6597 {
6599 {
6601 {
6612 }
6619 }
6620 }
6622 }
6630 /* %start-doc actions SetSame
6632 When invoked over any line, arc, polygon, or via, this changes the
6633 current layer to be the layer that item is on, and changes the current
6634 sizes (thickness, keepaway, drill, etc) according to that item.
6636 %end-doc */
6638 static int
6640 {
6646 /* set layer current and size from line or arc */
6648 {
6688 }
6690 {
6693 }
6695 }
6698 /* --------------------------------------------------------------------------- */
6709 /* %start-doc actions SetFlag
6711 Turns the given flag on, regardless of its previous setting. See
6712 @code{ChangeFlag}.
6714 @example
6715 SetFlag(SelectedPins,thermal)
6716 @end example
6718 %end-doc */
6720 static int
6722 {
6727 }
6729 /* --------------------------------------------------------------------------- */
6740 /* %start-doc actions ClrFlag
6742 Turns the given flag off, regardless of its previous setting. See
6743 @code{ChangeFlag}.
6745 @example
6746 ClrFlag(SelectedLines,join)
6747 @end example
6749 %end-doc */
6751 static int
6753 {
6758 }
6760 /* --------------------------------------------------------------------------- */
6772 /* %start-doc actions ChangeFlag
6774 Toggles the given flag on the indicated object(s). The flag may be
6775 one of the flags listed above (square, octagon, thermal, join). The
6776 value may be the number 0 or 1. If the value is 0, the flag is
6777 cleared. If the value is 1, the flag is set.
6779 %end-doc */
6781 static int
6783 {
6792 }
6795 static void
6797 {
6802 {
6805 }
6807 {
6810 }
6812 {
6813 /* Note: these are backwards, because the flag is "clear" but
6814 the command is "join". */
6817 }
6818 else
6819 {
6822 }
6825 {
6827 {
6839 }
6881 }
6882 }
6884 /* --------------------------------------------------------------------------- */
6890 /* %start-doc actions ExecuteFile
6892 Lines starting with @code{#} are ignored.
6894 %end-doc */
6896 static int
6898 {
6911 {
6914 }
6919 {
6920 n++;
6923 /* eat the trailing newline */
6925 sp++;
6928 /* eat leading spaces and tabs */
6931 sp++;
6933 /*
6934 * if we have anything left and its not a comment line
6935 * then execute it
6936 */
6939 {
6940 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6942 }
6943 }
6947 {
6950 }
6953 }
6955 /* --------------------------------------------------------------------------- */
6957 static int
6959 {
6963 }
6965 /* --------------------------------------------------------------------------- */
6971 {
6978 {
6981 {
6984 }
6985 }
6986 END_LOOP;
6988 }
6992 {
6998 }
7000 static void
7002 {
7009 }
7011 /* ---------------------------------------------------------------- */
7018 /* %start-doc actions elementlist
7020 @table @code
7022 @item Start
7023 Indicates the start of an element list; call this before any Need
7024 actions.
7026 @item Need
7027 Searches the board for an element with a matching refdes.
7029 If found, the value and footprint are updated.
7031 If not found, a new element is created with the given footprint and value.
7033 @item Done
7034 Compares the list of elements needed since the most recent
7035 @code{start} with the list of elements actually on the board. Any
7036 elements that weren't listed are selected, so that the user may delete
7037 them.
7039 @end table
7041 %end-doc */
7045 static int
7047 {
7052 }
7054 static int
7056 {
7067 #ifdef DEBUG
7069 #endif
7072 {
7074 {
7076 }
7077 END_LOOP;
7081 }
7084 {
7086 {
7088 {
7090 }
7092 {
7093 /* Unnamed elements should remain untouched */
7095 }
7096 }
7097 END_LOOP;
7103 }
7111 argc --;
7112 argv ++;
7122 #ifdef DEBUG
7126 #endif
7131 {
7134 #ifdef DEBUG
7136 #endif
7137 /* Not on board, need to add it. */
7139 {
7140 number_of_footprints_not_found ++;
7142 }
7153 {
7156 }
7167 /* Place components onto center of board. */
7170 }
7173 {
7174 #ifdef DEBUG
7176 #endif
7181 /* Different footprint, we need to swap them out. */
7183 {
7184 number_of_footprints_not_found ++;
7186 }
7201 {
7206 }
7212 }
7214 /* Now reload footprint */
7227 #ifdef DEBUG
7229 #endif
7232 }
7234 /* ---------------------------------------------------------------- */
7241 /* %start-doc actions elementsetattr
7243 If a value is specified, the named attribute is added (if not already
7244 present) or changed (if it is) to the given value. If the value is
7245 not specified, the given attribute is removed if present.
7247 %end-doc */
7249 static int
7251 {
7257 {
7259 }
7266 {
7268 {
7271 }
7272 }
7273 END_LOOP;
7276 {
7279 }
7284 {
7287 }
7289 {
7291 }
7293 {
7295 }
7298 }
7300 /* ---------------------------------------------------------------- */
7305 /* %start-doc actions execcommand
7307 Runs the given command, which is a system executable.
7309 %end-doc */
7311 static int
7313 {
7317 {
7319 }
7326 }
7328 /* ---------------------------------------------------------------- */
7330 static int
7332 {
7333 #ifdef HAVE__SPAWNVP
7337 else
7339 #else
7343 {
7344 /* error */
7347 }
7349 {
7350 /* Child */
7353 }
7354 else
7355 {
7357 /* Parent */
7359 }
7361 #endif
7362 }
7364 /* ---------------------------------------------------------------- */
7366 /*!
7367 * \brief Creates a new temporary file name.
7368 *
7369 * Hopefully the operating system provides a mkdtemp() function to
7370 * securily create a temporary directory with mode 0700.\n
7371 * If so then that directory is created and the returned string is made
7372 * up of the directory plus the name variable.\n
7373 * For example:\n
7374 *
7375 * tempfile_name_new ("myfile") might return
7376 * "/var/tmp/pcb.123456/myfile".
7377 *
7378 * If mkdtemp() is not available then 'name' is ignored and the
7379 * insecure tmpnam() function is used.
7380 *
7381 * Files/names created with tempfile_name_new() should be unlinked
7382 * with tempfile_unlink to make sure the temporary directory is also
7383 * removed when mkdtemp() is used.
7384 */
7387 {
7389 #ifdef HAVE_MKDTEMP
7392 #endif
7396 #ifdef HAVE_MKDTEMP
7402 /* FIXME -- what about win32? */
7405 }
7415 }
7425 }
7432 ;
7442 #undef TEMPLATE
7443 #else
7444 /*
7445 * tmpnam() uses a static buffer so strdup() the result right away
7446 * in case someone decides to create multiple temp names.
7447 */
7449 #ifdef __WIN32__
7450 {
7451 /* Guile doesn't like \ separators */
7456 }
7457 #endif
7458 #endif
7461 }
7463 /* ---------------------------------------------------------------- */
7465 /*!
7466 * \brief Unlink a temporary file.
7467 *
7468 * If we have mkdtemp() then our temp file lives in a temporary
7469 * directory and we need to remove that directory too.
7470 */
7471 static int
7473 {
7474 #ifdef DEBUG
7475 /* SDB says: Want to keep old temp files for examiniation when debugging */
7477 #endif
7479 #ifdef HAVE_MKDTEMP
7484 /* it is possible that the file was never created so it is OK if the
7485 unlink fails */
7487 /* now figure out the directory name to remove */
7494 /*
7495 * at this point, e *should* point to the end of the directory part
7496 * but lets make sure.
7497 */
7502 }
7506 __FUNCTION__);
7510 }
7512 /* name was allocated with malloc */
7516 /*
7517 * FIXME - should also return -1 if the temp file exists and was not
7518 * removed.
7519 */
7522 }
7524 #else
7531 }
7534 #endif
7537 }
7539 /* ---------------------------------------------------------------- */
7548 /* %start-doc actions Import
7550 Imports element and netlist data from the schematics (or some other
7551 source). The first parameter, which is optional, is the mode. If not
7552 specified, the @code{import::mode} attribute in the PCB is used.
7553 @code{gnetlist} means gnetlist is used to obtain the information from
7554 the schematics. @code{make} invokes @code{make}, assuming the user
7555 has a @code{Makefile} in the current directory. The @code{Makefile}
7556 will be invoked with the following variables set:
7558 @table @code
7560 @item PCB
7561 The name of the .pcb file
7563 @item SRCLIST
7564 A space-separated list of source files
7566 @item OUT
7567 The name of the file in which to put the command script, which may
7568 contain any @pcb{} actions. By default, this is a temporary file
7569 selected by @pcb{}, but if you specify an @code{import::outfile}
7570 attribute, that file name is used instead (and not automatically
7571 deleted afterwards).
7573 @end table
7575 The target specified to be built is the first of these that apply:
7577 @itemize @bullet
7579 @item
7580 The target specified by an @code{import::target} attribute.
7582 @item
7583 The output file specified by an @code{import::outfile} attribute.
7585 @item
7586 If nothing else is specified, the target is @code{pcb_import}.
7588 @end itemize
7590 If you specify an @code{import::makefile} attribute, then "-f <that
7591 file>" will be added to the command line.
7593 If you specify the mode, you may also specify the source files
7594 (schematics). If you do not specify any, the list of schematics is
7595 obtained by reading the @code{import::src@var{N}} attributes (like
7596 @code{import::src0}, @code{import::src1}, etc).
7598 For compatibility with future extensions to the import file format,
7599 the generated file @emph{must not} start with the two characters
7600 @code{#%}.
7602 If a temporary file is needed the @code{TMPDIR} environment variable
7603 is used to select its location.
7605 Note that the programs @code{gnetlist} and @code{make} may be
7606 overridden by the user via the @code{make-program} and @code{gnetlist}
7607 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7608 line).
7610 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7611 is called to let user choose (see @code{ImportGUI()}).
7613 Note that Import() doesn't delete anything - after an Import, elements
7614 which shouldn't be on the board are selected and may be removed once
7615 it's determined that the deletion is appropriate.
7617 If @code{Import()} is called with @code{setnewpoint}, then the location
7618 of new components can be specified. This is where parts show up when
7619 they're added to the board. The default is the center of the board.
7621 @table @code
7623 @item Import(setnewpoint)
7625 Prompts the user to click on the board somewhere, uses that point. If
7626 called by a hotkey, uses the current location of the crosshair.
7628 @item Import(setnewpoint,mark)
7630 Uses the location of the mark. If no mark is present, the point is
7631 not changed.
7633 @item Import(setnewpoint,center)
7635 Resets the point to the center of the board.
7637 @item Import(setnewpoint,X,Y,units)
7639 Sets the point to the specific coordinates given. Example:
7640 @code{Import(setnewpoint,50,25,mm)}
7642 @end table
7644 Note that the X and Y locations are stored in attributes named
7645 @code{import::newX} and @code{import::newY} so you could change them
7646 manually if you wished.
7648 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7649 placed elements are dispersed relative to the set point. For example,
7650 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7651 10mm away from the point. The default dispersion is 1/10th of the
7652 smallest board dimension. Dispersion is saved in the
7653 @code{import::disperse} attribute.
7655 %end-doc */
7657 static int
7659 {
7664 #ifdef DEBUG
7666 #endif
7671 {
7678 {
7681 }
7683 {
7686 }
7687 else
7692 }
7695 {
7705 {
7707 }
7709 {
7713 }
7715 {
7721 }
7723 {
7726 }
7727 else
7728 {
7731 }
7738 }
7746 {
7749 }
7752 {
7758 nsources ++;
7764 {
7768 nsources ++;
7773 }
7774 }
7777 {
7778 /* Replace .pcb with .sch and hope for the best. */
7800 {
7803 }
7809 }
7812 {
7820 }
7833 #ifdef DEBUG
7837 #endif
7840 {
7843 }
7845 #ifdef DEBUG
7846 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7847 #endif
7855 }
7857 {
7877 else
7878 {
7884 }
7886 }
7894 {
7898 }
7907 {
7910 }
7915 {
7922 }
7933 }
7934 else
7935 {
7938 }
7943 #ifdef DEBUG
7945 #endif
7948 }
7950 /* ------------------------------------------------------------ */
7960 /* %start-doc actions Attributes
7962 This just pops up a dialog letting the user edit the attributes of the
7963 pcb, an element, or a layer.
7965 %end-doc */
7968 static int
7970 {
7979 {
7982 }
7985 {
7987 {
7990 }
7993 {
7996 {
8001 {
8004 }
8006 {
8009 }
8010 }
8017 }
8020 {
8024 {
8026 {
8028 n_found ++;
8029 }
8030 }
8031 END_LOOP;
8033 {
8036 }
8038 {
8045 else
8046 {
8049 }
8050 }
8053 {
8057 }
8058 else
8059 {
8061 }
8065 }
8069 }
8072 }
8074 /* --------------------------------------------------------------------------- */
8076 HID_Action action_action_list[] = {
8079 ,
8082 ,
8085 ,
8088 ,
8091 ,
8094 ,
8097 ,
8100 ,
8103 ,
8106 ,
8109 ,
8112 ,
8115 ,
8118 ,
8121 ,
8124 ,
8127 ,
8130 ,
8133 ,
8136 ,
8139 ,
8142 ,
8145 ,
8148 ,
8151 ,
8154 ,
8157 ,
8160 ,
8163 ,
8166 ,
8169 ,
8172 ,
8175 ,
8178 ,
8181 ,
8184 ,
8187 ,
8190 ,
8193 ,
8196 ,
8199 ,
8202 ,
8205 ,
8208 ,
8211 ,
8214 ,
8217 ,
8220 ,
8223 ,
8226 ,
8229 ,
8232 ,
8235 ,
8238 ,
8241 ,
8244 ,
8247 ,
8250 ,
8252 ,
8255 ,
8258 ,
8261 ,
8264 ,
8265 };