| blob | 87a0d31bf3cd9f832f9dad7b05217ce51cc14433 |
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 }
681 /* Restore the SN so that if we select something the deselect/select combo
682 gets the same SN. */
686 else
687 /* We didn't select anything new, so, the deselection should get its
688 own SN. */
692 }
694 {
701 }
703 {
706 }
708 {
723 }
727 }
729 #define HSIZE 257
733 static int
735 {
738 {
741 s ++;
742 }
745 }
747 /*!
748 * \brief Get function ID of passed string.
749 */
750 static int
752 {
759 {
762 {
766 }
768 {
769 /* Change 'char' to 'int' and remove this when we get to 256
770 strings to hash. */
775 }
777 {
782 }
783 }
787 {
788 /* We enforce the "hash table bigger than function table" rule,
789 so we know there will be at least one zero entry to find. */
795 }
796 }
798 /*!
799 * \brief Set new coordinates if in 'RECTANGLE' mode.
800 *
801 * The cursor shape is also adjusted.
802 */
803 static void
805 {
807 {
810 }
812 {
814 {
815 /* update coordinates */
819 }
820 }
821 }
823 /*!
824 * \brief Adjusts the objects which are to be created like attached
825 * lines.
826 */
827 void
829 {
832 {
833 /* update at least an attached block (selection) */
837 {
840 }
843 /* rectangle creation mode */
849 /* polygon creation mode */
854 /* line creation mode */
858 else
861 /* point insertion mode */
869 }
870 }
872 /*!
873 * \brief Creates points of a line.
874 */
875 static void
877 {
884 {
889 {
892 }
894 {
900 }
902 {
907 }
909 {
914 {
917 }
918 else
919 {
922 }
923 }
924 else
925 {
930 }
935 /* fall through to third state too */
940 }
941 }
943 /*!
944 * \brief Create first or second corner of a marked block.
945 */
946 static void
948 {
951 {
963 }
965 }
968 /*!
969 * \brief This is called after every mode change, like mouse button pressed,
970 * mouse button released, dragging something started or a different tool
971 * selected.
972 *
973 * It does what's appropriate for the current mode setting.
974 * This can also mean creation of an object at the current crosshair location.
975 *
976 * New created objects are added to the create undo list of course.
977 */
978 static void
980 {
987 {
989 {
991 hidval hv;
994 /* do something after click time */
997 /* see if we clicked on something already selected
998 * (Note.Moving) or clicked on a MOVE_TYPE
999 * (Note.Hit)
1000 */
1003 {
1007 {
1012 }
1018 }
1020 }
1023 {
1027 {
1031 }
1036 {
1043 }
1045 }
1048 {
1050 {
1061 {
1069 {
1073 #ifdef ARC45
1076 else
1077 #endif
1079 }
1080 else
1081 {
1085 #ifdef ARC45
1088 else
1089 #endif
1092 }
1094 Crosshair.
1095 AttachedBox.
1097 Crosshair.
1098 AttachedBox.
1102 sa,
1103 dir,
1104 Settings.
1105 LineThickness,
1107 Keepaway,
1108 MakeFlags
1109 (TEST_FLAG
1111 PCB) ?
1112 CLEARLINEFLAG :
1114 {
1124 addedLines++;
1128 }
1130 }
1131 }
1133 }
1135 {
1138 {
1143 {
1146 }
1147 END_LOOP;
1149 {
1152 }
1153 END_LOOP;
1155 /* always re-draw it since I'm too lazy
1156 * to tell if a selected flag changed
1157 */
1162 }
1164 {
1169 {
1170 /* this is not un-doable since LOCK isn't */
1174 }
1177 }
1179 }
1181 {
1183 =
1187 {
1189 {
1191 tstyle++;
1195 }
1198 else
1200 }
1202 }
1205 /* do update of position */
1210 /* Remove anchor if clicking on start point;
1211 * this means we can't paint 0 length lines
1212 * which could be used for square SMD pads.
1213 * Instead use a very small delta, or change
1214 * the file after saving.
1215 */
1218 {
1221 }
1224 {
1227 {
1228 addedLines++;
1237 }
1239 }
1240 else
1241 /* create line if both ends are determined && length != 0 */
1242 {
1259 {
1260 /* We will only need to paint the second line segment.
1261 Since we only check for vias on the first segment,
1262 swap them so the non-empty segment is the first segment. */
1265 }
1271 {
1283 {
1285 addedLines++;
1288 }
1289 /* place a via if vias are visible, the layer is
1290 in a new group since the last line and there
1291 isn't a pin already here */
1298 NO_TYPE
1307 {
1310 }
1311 /* copy the coordinates */
1318 }
1322 {
1331 {
1332 addedLines++;
1336 }
1337 /* move to new start point */
1343 {
1345 }
1346 }
1350 }
1354 /* do update of position */
1357 /* create rectangle if both corners are determined
1358 * and width, height are != 0
1359 */
1363 {
1370 Crosshair.
1372 Crosshair.
1374 Crosshair.
1376 Crosshair.
1378 MakeFlags
1380 NULL)
1381 {
1387 }
1389 /* reset state to 'first corner' */
1391 }
1395 {
1399 {
1401 {
1411 {
1416 }
1417 }
1419 }
1421 }
1424 {
1428 /* do update of position; use the 'LINE_MODE' mechanism */
1431 /* check if this is the last point of a polygon */
1435 {
1439 }
1441 /* create new point if it's the first one or if it's
1442 * different to the last one
1443 */
1447 {
1452 /* copy the coordinates */
1455 }
1457 }
1460 {
1462 {
1463 /* first notify, lookup object */
1472 {
1475 }
1478 {
1482 }
1483 else
1485 /* Fall thru: first click is also the first point of the
1486 * poly hole. */
1488 /* second notify, insert new point into object */
1490 {
1494 FlagType Flags;
1496 /* do update of position; use the 'LINE_MODE' mechanism */
1499 /* check if this is the last point of a polygon */
1503 {
1504 /* Create POLYAREAs from the original polygon
1505 * and the new hole polygon */
1509 /* Subtract the hole from the original polygon shape */
1512 /* Convert the resulting polygon(s) into a new set of nodes
1513 * and place them on the page. Delete the original polygon.
1514 */
1527 /* reset state of attached line */
1533 }
1535 /* create new point if it's the first one or if it's
1536 * different to the last one
1537 */
1541 {
1546 /* copy the coordinates */
1549 }
1551 }
1552 }
1555 }
1558 {
1563 {
1568 {
1571 {
1579 }
1580 }
1581 }
1585 {
1590 {
1597 {
1609 }
1610 }
1611 }
1613 }
1619 {
1621 {
1624 }
1626 {
1634 {
1641 else
1643 ptr++;
1644 }
1645 }
1649 }
1659 /* both are almost the same */
1663 {
1664 /* first notify, lookup object */
1666 {
1676 {
1680 {
1683 }
1684 else
1686 }
1688 }
1690 /* second notify, move or copy object */
1699 else
1700 {
1708 }
1711 /* reset identifiers */
1715 }
1718 /* insert a point into a polygon/line/... */
1721 {
1722 /* first notify, lookup object */
1731 {
1734 {
1738 }
1739 else
1740 {
1741 /* get starting point of nearest segment */
1743 {
1746 polyIndex =
1754 }
1757 }
1758 }
1761 /* second notify, insert new point into object */
1768 else
1776 /* reset identifiers */
1780 }
1782 }
1783 }
1786 /* --------------------------------------------------------------------------- */
1792 /* %start-doc actions Atomic
1794 This action allows making multiple-action bindings into an atomic
1795 operation that will be undone by a single Undo command. For example,
1796 to optimize rat lines, you'd delete the rats and re-add them. To
1797 group these into a single undo, you'd want the deletions and the
1798 additions to have the same undo serial number. So, you @code{Save},
1799 delete the rats, @code{Restore}, add the rats - using the same serial
1800 number as the deletes, then @code{Block}, which checks to see if the
1801 deletions or additions actually did anything. If not, the serial
1802 number is set to the saved number, as there's nothing to undo. If
1803 something did happen, the serial number is incremented so that these
1804 actions are counted as a single undo step.
1806 @table @code
1808 @item Save
1809 Saves the undo serial number.
1811 @item Restore
1812 Returns it to the last saved number.
1814 @item Close
1815 Sets it to 1 greater than the last save.
1817 @item Block
1818 Does a Restore if there was nothing to undo, else does a Close.
1820 @end table
1822 %end-doc */
1824 static int
1826 {
1831 {
1847 }
1849 }
1851 /* -------------------------------------------------------------------------- */
1857 /* %start-doc actions DRC
1859 Note that the design rule check uses the current board rule settings,
1860 not the current style settings.
1862 %end-doc */
1864 static int
1866 {
1870 {
1878 }
1881 {
1886 else
1888 }
1890 }
1892 /* -------------------------------------------------------------------------- */
1899 /* %start-doc actions DumpLibrary
1902 %end-doc */
1904 static int
1906 {
1913 {
1924 {
1927 {
1930 }
1931 else
1932 {
1939 }
1940 }
1941 }
1944 }
1946 /* -------------------------------------------------------------------------- */
1953 /* %start-doc actions Flip
1955 Note that the location of the element will be symmetric about the
1956 cursor location; i.e. if the part you are pointing at will still be at
1957 the same spot once the element is on the other side. When flipping
1958 multiple elements, this retains their positions relative to each
1959 other, not their absolute positions on the board.
1961 %end-doc */
1963 static int
1965 {
1972 {
1974 {
1978 {
1983 }
1992 }
1995 }
1998 }
2000 /* -------------------------------------------------------------------------- */
2006 /* %start-doc actions Message
2008 This action displays a message to the log window. This action is primarily
2009 provided for use by other programs which may interface with PCB. If
2010 multiple arguments are given, each one is sent to the log window
2011 followed by a newline.
2013 %end-doc */
2015 static int
2017 {
2024 {
2027 }
2030 }
2033 /* -------------------------------------------------------------------------- */
2047 /* %start-doc actions SetThermal
2049 This changes how/whether pins or vias connect to any rectangle or polygon
2050 on the current layer. The first argument can specify one object, or all
2051 selected pins, or all selected vias, or all selected pins and vias.
2052 The second argument specifies the style of connection.
2053 There are 5 possibilities:
2054 0 - no connection,
2055 1 - 45 degree fingers with sharp edges,
2056 2 - horizontal & vertical fingers with sharp edges,
2057 3 - solid connection,
2058 4 - 45 degree fingers with rounded corners,
2059 5 - horizontal & vertical fingers with rounded corners.
2061 Pins and Vias may have thermals whether or not there is a polygon available
2062 to connect with. However, they will have no effect without the polygon.
2063 %end-doc */
2065 static int
2067 {
2075 {
2079 {
2082 }
2083 else
2086 /* To allow relative values we could search for the first selected
2087 item and make 'kind' relative to that, but that's not too useful
2088 and requires quite some code. For example there's no
2089 GetFirstSelectedPin() function available. Let's postpone this
2090 functionality, there are more urgent things to do. */
2094 {
2099 {
2103 }
2118 }
2119 else
2121 }
2122 else
2129 }
2131 /*!
2132 * \brief Event handler to set the cursor according to the X pointer
2133 * position called from inside main.c.
2134 *
2135 * \warning !!! no action routine !!!
2136 */
2137 void
2139 {
2140 #ifdef HAVE_LIBSTROKE
2142 {
2147 }
2150 {
2151 /* update object position and cursor location */
2154 }
2155 }
2157 /* --------------------------------------------------------------------------- */
2166 /* %start-doc actions SetValue
2168 @table @code
2170 @item ViaDrillingHole
2171 Changes the diameter of the drill for new vias.
2173 @item Grid
2174 Sets the grid spacing.
2176 @item Line
2177 @item LineSize
2178 Changes the thickness of new lines.
2180 @item Via
2181 @item ViaSize
2182 Changes the diameter of new vias.
2184 @item Text
2185 @item TextScale
2186 Changes the size of new text.
2188 @end table
2190 %end-doc */
2192 static int
2194 {
2204 {
2207 {
2218 else
2219 {
2223 /* On the way down, short against the minimum
2224 * PCB drawing unit */
2229 else
2231 }
2259 }
2262 }
2265 }
2268 /* --------------------------------------------------------------------------- */
2274 /* %start-doc actions Quit
2276 If you have unsaved changes, you will be prompted to confirm (or
2277 save) before quitting.
2279 %end-doc */
2281 static int
2283 {
2286 {
2289 }
2293 }
2295 /* --------------------------------------------------------------------------- */
2303 /* %start-doc actions Connection
2305 Connections found with this action will be highlighted in the
2306 ``connected-color'' color and will have the ``found'' flag set.
2308 @table @code
2310 @item Find
2311 The net under the cursor is ``found''.
2313 @item ResetLinesAndPolygons
2314 Any ``found'' lines and polygons are marked ``not found''.
2316 @item ResetPinsAndVias
2317 Any ``found'' pins and vias are marked ``not found''.
2319 @item Reset
2320 All ``found'' objects are marked ``not found''.
2322 @end table
2324 %end-doc */
2326 static int
2328 {
2331 {
2333 {
2335 {
2340 }
2344 {
2347 }
2352 {
2355 }
2360 {
2363 }
2365 }
2367 }
2370 }
2372 /* --------------------------------------------------------------------------- */
2379 /* %start-doc actions DisperseElements
2381 Normally this is used when starting a board, by selecting all elements
2382 and then dispersing them. This scatters the elements around the board
2383 so that you can pick individual ones, rather than have all the
2384 elements at the same 0,0 coordinate and thus impossible to choose
2385 from.
2387 %end-doc */
2389 #define GAP MIL_TO_COORD(100)
2391 static int
2393 {
2402 {
2404 }
2405 else
2406 {
2408 {
2419 }
2420 }
2423 {
2425 }
2429 {
2430 /*
2431 * If we want to disperse selected elements, maybe we need smarter
2432 * code here to avoid putting components on top of others which
2433 * are not selected. For now, I'm assuming that this is typically
2434 * going to be used either with a brand new design or a scratch
2435 * design holding some new components
2436 */
2438 {
2440 /* figure out how much to move the element */
2443 /* snap to the grid */
2446 /*
2447 * and add one grid size so we make sure we always space by GAP or
2448 * more
2449 */
2452 /* Figure out if this row has room. If not, start a new row */
2454 {
2457 }
2459 /* figure out how much to move the element */
2463 /* snap to the grid */
2469 /* move the element */
2472 /* and add to the undo list so we can undo this operation */
2475 /* keep track of how tall this row is */
2478 {
2480 }
2481 }
2483 }
2484 END_LOOP;
2486 /* done with our action so increment the undo # */
2493 }
2495 #undef GAP
2497 /* --------------------------------------------------------------------------- */
2512 /* %start-doc actions Display
2514 @table @code
2516 @item NameOnPCB
2517 @item Description
2518 @item Value
2519 Specify whether all elements show their name, description, or value.
2521 @item Redraw
2522 Redraw the whole board.
2524 @item Toggle45Degree
2525 When clear, lines can be drawn at any angle. When set, lines are
2526 restricted to multiples of 45 degrees and requested lines may be
2527 broken up according to the clip setting.
2529 @item CycleClip
2530 Changes the way lines are restricted to 45 degree increments. The
2531 various settings are: straight only, orthogonal then angled, and angled
2532 then orthogonal. If AllDirections is set, this action disables it.
2534 @item CycleCrosshair
2535 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2536 8-ray and 12-ray cross.
2538 @item ToggleRubberBandMode
2539 If set, moving an object moves all the lines attached to it too.
2541 @item ToggleStartDirection
2542 If set, each time you set a point in a line, the Clip toggles between
2543 orth-angle and angle-ortho.
2545 @item ToggleUniqueNames
2546 If set, you will not be permitted to change the name of an element to
2547 match that of another element.
2549 @item ToggleSnapPin
2550 If set, pin centers and pad end points are treated as additional grid
2551 points that the cursor can snap to.
2553 @item ToggleLocalRef
2554 If set, the mark is automatically set to the beginning of any move, so
2555 you can see the relative distance you've moved.
2557 @item ToggleThindraw
2558 If set, objects on the screen are drawn as outlines (lines are drawn
2559 as center-lines). This lets you see line endpoints hidden under pins,
2560 for example.
2562 @item ToggleThindrawPoly
2563 If set, polygons on the screen are drawn as outlines.
2565 @item ToggleShowDRC
2566 If set, pending objects (i.e. lines you're in the process of drawing)
2567 will be drawn with an outline showing how far away from other copper
2568 you need to be.
2570 @item ToggleLiveRoute
2571 If set, the progress of the autorouter will be visible on the screen.
2573 @item ToggleAutoDRC
2574 If set, you will not be permitted to make connections which violate
2575 the current DRC and netlist settings.
2577 @item ToggleCheckPlanes
2578 If set, lines and arcs aren't drawn, which usually leaves just the
2579 polygons. If you also disable all but the layer you're interested in,
2580 this allows you to check for isolated regions.
2582 @item ToggleOrthoMove
2583 If set, the crosshair is only allowed to move orthogonally from its
2584 previous position. I.e. you can move an element or line up, down,
2585 left, or right, but not up+left or down+right.
2587 @item ToggleName
2588 Selects whether the pinouts show the pin names or the pin numbers.
2590 @item ToggleLockNames
2591 If set, text will ignore left mouse clicks and actions that work on
2592 objects under the mouse. You can still select text with a lasso (left
2593 mouse drag) and perform actions on the selection.
2595 @item ToggleOnlyNames
2596 If set, only text will be sensitive for mouse clicks and actions that
2597 work on objects under the mouse. You can still select other objects
2598 with a lasso (left mouse drag) and perform actions on the selection.
2600 @item ToggleMask
2601 Turns the solder mask on or off.
2603 @item ToggleClearLine
2604 When set, the clear-line flag causes new lines and arcs to have their
2605 ``clear polygons'' flag set, so they won't be electrically connected
2606 to any polygons they overlap.
2608 @item ToggleFullPoly
2609 When set, the full-poly flag causes new polygons to have their
2610 ``full polygon'' flag set, so all parts of them will be displayed
2611 instead of only the biggest one.
2613 @item ToggleGrid
2614 Resets the origin of the current grid to be wherever the mouse pointer
2615 is (not where the crosshair currently is). If you provide two numbers
2616 after this, the origin is set to that coordinate.
2618 @item Grid
2619 Toggles whether the grid is displayed or not.
2621 @item Pinout
2622 Causes the pinout of the element indicated by the cursor to be
2623 displayed, usually in a separate window.
2625 @item PinOrPadName
2626 Toggles whether the names of pins, pads, or (yes) vias will be
2627 displayed. If the cursor is over an element, all of its pins and pads
2628 are affected.
2630 @end table
2632 %end-doc */
2634 static enum crosshair_shape
2636 {
2638 {
2651 }
2653 }
2655 static int
2657 {
2666 {
2668 {
2670 /* redraw layout */
2676 /* change the displayed name of elements */
2681 {
2683 }
2684 END_LOOP;
2687 {
2696 }
2698 {
2700 }
2701 END_LOOP;
2705 /* toggle line-adjust flag */
2714 {
2717 }
2718 else
2795 {
2797 {
2800 }
2802 {
2809 }
2810 }
2841 /* shift grid alignment */
2843 {
2850 }
2853 /* toggle displaying of the grid */
2859 /* display the pinout of an element */
2861 {
2870 {
2873 }
2875 }
2877 /* toggle displaying of pin/pad/via names */
2879 {
2889 {
2892 {
2895 else
2899 }
2900 END_LOOP;
2902 {
2905 else
2909 }
2910 END_LOOP;
2919 else
2931 else
2942 else
2950 }
2952 }
2955 }
2956 }
2958 {
2960 {
2963 {
2968 }
2974 }
2975 }
2976 else
2983 }
2985 /* --------------------------------------------------------------------------- */
2995 /* %start-doc actions Mode
2997 @table @code
2999 @item Arc
3000 @itemx Arrow
3001 @itemx Copy
3002 @itemx InsertPoint
3003 @itemx Line
3004 @itemx Lock
3005 @itemx Move
3006 @itemx None
3007 @itemx PasteBuffer
3008 @itemx Polygon
3009 @itemx Rectangle
3010 @itemx Remove
3011 @itemx Rotate
3012 @itemx Text
3013 @itemx Thermal
3014 @itemx Via
3015 Select the indicated tool.
3017 @item Notify
3018 Called when you press the mouse button, or move the mouse.
3020 @item Release
3021 Called when you release the mouse button.
3023 @item Cancel
3024 Cancels any pending tool activity, allowing you to restart elsewhere.
3025 For example, this allows you to start a new line rather than attach a
3026 line to the previous line.
3028 @item Escape
3029 Similar to Cancel but calling this action a second time will return
3030 to the Arrow tool.
3032 @item Stroke
3033 If your @code{pcb} was built with libstroke, this invokes the stroke
3034 input method. If not, this will restart a drawing mode if you were
3035 drawing, else it will select objects.
3037 @item Save
3038 Remembers the current tool.
3040 @item Restore
3041 Restores the tool to the last saved tool.
3043 @end table
3045 %end-doc */
3047 static int
3049 {
3053 {
3058 {
3084 {
3088 }
3091 {
3093 {
3112 else
3113 {
3116 }
3122 else
3123 {
3126 }
3132 else
3133 {
3136 }
3142 else
3143 {
3146 }
3152 else
3153 {
3156 }
3164 }
3165 }
3180 #ifndef HAVE_LIBSTROKE
3184 #else
3188 else
3191 #endif
3202 #ifdef HAVE_LIBSTROKE
3207 #else
3208 /* Handle middle mouse button restarts of drawing mode. If not in
3209 | a drawing mode, middle mouse button will select objects.
3210 */
3213 {
3215 }
3225 else
3226 {
3231 }
3233 #endif
3251 }
3254 }
3257 }
3259 /* --------------------------------------------------------------------------- */
3265 /* %start-doc actions RemoveSelected
3267 %end-doc */
3269 static int
3271 {
3275 }
3277 /* --------------------------------------------------------------------------- */
3286 /* %start-doc actions Renumber
3288 %end-doc */
3290 static int
3292 {
3304 struct _cnt_list
3305 {
3315 {
3316 /*
3317 * We deal with the case where name already exists in this
3318 * function so the GUI doesn't need to deal with it
3319 */
3328 }
3329 else
3333 {
3336 }
3339 {
3341 }
3344 {
3347 {
3351 }
3352 }
3355 {
3360 }
3368 /*
3369 * Make a first pass through all of the elements and sort them out
3370 * by location on the board. While here we also collect a list of
3371 * locked elements.
3372 *
3373 * We'll actually renumber things in the 2nd pass.
3374 */
3381 {
3384 }
3390 {
3392 {
3393 /*
3394 * add to the list of locked elements which we won't try to
3395 * renumber and whose reference designators are now reserved.
3396 */
3401 lock_cnt++;
3402 }
3404 else
3405 {
3406 /* count of devices which will be renumbered */
3407 cnt++;
3409 /* search for correct position in the list */
3412 i++;
3414 /*
3415 * We have found the position where we have the first element that
3416 * has the same Y value or a lower Y value. Now move forward if
3417 * needed through the X values
3418 */
3422 i++;
3425 {
3427 }
3429 }
3430 }
3431 END_LOOP;
3434 /*
3435 * Now that the elements are sorted by board position, we go through
3436 * and renumber them.
3437 */
3439 /*
3440 * turn off the flag which requires unique names so it doesn't get
3441 * in our way. When we're done with the renumber we will have unique
3442 * names.
3443 */
3449 {
3450 /* If there is no refdes, maybe just spit out a warning */
3452 {
3453 /* figure out the prefix */
3458 j++;
3461 /* check the counter for this prefix */
3466 /* grow the list if needed */
3468 {
3472 {
3475 }
3476 /* zero out the memory that we added */
3478 {
3481 }
3482 }
3484 /*
3485 * start a new counter if we don't have a counter for this
3486 * prefix
3487 */
3489 {
3492 }
3494 /*
3495 * check to see if the new refdes is already used by a
3496 * locked element
3497 */
3498 do
3499 {
3504 /* space for the prefix plus 1 digit plus the '\0' */
3507 /* and 1 more per extra digit needed to hold the number */
3510 {
3511 sz++;
3513 }
3517 /*
3518 * now compare to the list of reserved (by locked
3519 * elements) names
3520 */
3522 {
3526 {
3529 }
3530 }
3532 }
3536 {
3540 /* add this rename to our table of renames so we can update the netlist */
3543 c_cnt++;
3551 tmps);
3554 /* we don't free tmps in this case because it is used */
3555 }
3556 else
3558 }
3559 else
3560 {
3563 }
3565 }
3569 /* restore the unique flag setting */
3574 {
3576 /* update the netlist */
3579 /* iterate over each net */
3581 {
3583 /* iterate over each pin on the net */
3585 {
3587 /* figure out the pin number part from strings like U3-21 */
3593 /* iterate over the list of changed reference designators */
3595 {
3596 /*
3597 * if the pin needs to change, change it and quit
3598 * searching in the list.
3599 */
3601 {
3609 }
3611 }
3613 }
3614 }
3616 {
3619 }
3624 }
3632 }
3635 /* --------------------------------------------------------------------------- */
3642 /* %start-doc actions RipUp
3644 @table @code
3646 @item All
3647 Removes all lines and vias which were created by the autorouter.
3649 @item Selected
3650 Removes all selected lines and vias which were created by the
3651 autorouter.
3653 @item Element
3654 Converts the element under the cursor to parts (vias and lines). Note
3655 that this uses the highest numbered paste buffer.
3657 @end table
3659 %end-doc */
3661 static int
3663 {
3668 {
3670 {
3673 {
3675 {
3678 }
3679 }
3680 ENDALL_LOOP;
3682 {
3684 {
3687 }
3688 }
3689 ENDALL_LOOP;
3691 {
3693 {
3696 }
3697 }
3698 END_LOOP;
3701 {
3704 }
3708 {
3711 {
3714 }
3715 }
3716 ENDALL_LOOP;
3719 {
3722 {
3725 }
3726 }
3727 END_LOOP;
3729 {
3732 }
3735 {
3740 {
3756 }
3757 }
3759 }
3760 }
3762 }
3764 /* --------------------------------------------------------------------------- */
3771 /* %start-doc actions AddRats
3773 @table @code
3775 @item AllRats
3776 Create rat lines for all loaded nets that aren't already connected on
3777 with copper.
3779 @item SelectedRats
3780 Similarly, but only add rat lines for nets connected to selected pins
3781 and pads.
3783 @item Close
3784 Selects the shortest unselected rat on the board.
3786 @end table
3788 %end-doc */
3790 static int
3792 {
3798 {
3802 {
3816 {
3822 {
3825 }
3826 }
3827 END_LOOP;
3829 {
3837 }
3839 }
3840 }
3842 }
3844 /* --------------------------------------------------------------------------- */
3852 /* %start-doc actions Delete
3854 %end-doc */
3856 static int
3858 {
3866 {
3869 }
3872 {
3890 }
3893 }
3895 /* --------------------------------------------------------------------------- */
3902 /* %start-doc actions DeleteRats
3904 %end-doc */
3906 static int
3908 {
3911 {
3915 {
3925 }
3926 }
3928 }
3930 /* --------------------------------------------------------------------------- */
3936 /* %start-doc actions AutoPlaceSelected
3938 Attempts to re-arrange the selected components such that the nets
3939 connecting them are minimized. Note that you cannot undo this.
3941 %end-doc */
3943 static int
3945 {
3949 {
3952 }
3954 }
3956 /* --------------------------------------------------------------------------- */
3962 /* %start-doc actions AutoRoute
3964 @table @code
3966 @item AllRats
3967 Attempt to autoroute all rats.
3969 @item SelectedRats
3970 Attempt to autoroute the selected rats.
3972 @end table
3974 Before autorouting, it's important to set up a few things. First,
3975 make sure any layers you aren't using are disabled, else the
3976 autorouter may use them. Next, make sure the current line and via
3977 styles are set accordingly. Last, make sure "new lines clear
3978 polygons" is set, in case you eventually want to add a copper pour.
3980 Autorouting takes a while. During this time, the program may not be
3981 responsive.
3983 %end-doc */
3985 static int
3987 {
3991 {
3993 {
4003 }
4004 }
4006 }
4008 /* --------------------------------------------------------------------------- */
4016 /* %start-doc actions MarkCrosshair
4018 The ``mark'' is a small X-shaped target on the display which is
4019 treated like a second origin (the normal origin is the upper let
4020 corner of the board). The GUI will display a second set of
4021 coordinates for this mark, which tells you how far you are from it.
4023 If no argument is given, the mark is toggled - disabled if it was
4024 enabled, or enabled at the current cursor position of disabled. If
4025 the @code{Center} argument is given, the mark is moved to the current
4026 cursor location.
4028 %end-doc */
4030 static int
4032 {
4035 {
4037 {
4041 }
4042 else
4043 {
4050 }
4051 }
4053 {
4059 }
4061 }
4063 /* --------------------------------------------------------------------------- */
4074 /* %start-doc actions ChangeSize
4076 For lines and arcs, this changes the width. For pins and vias, this
4077 changes the overall diameter of the copper annulus. For pads, this
4078 changes the width and, indirectly, the length. For texts and names,
4079 this changes the scaling factor. For elements, this changes the width
4080 of the silk layer lines and arcs for this element.
4082 %end-doc */
4084 static int
4086 {
4091 Coord value;
4094 {
4100 {
4102 {
4114 }
4161 }
4162 }
4164 }
4166 /* --------------------------------------------------------------------------- */
4175 /* %start-doc actions ChangeDrillSize
4177 %end-doc */
4179 static int
4181 {
4186 Coord value;
4189 {
4192 {
4194 {
4206 }
4222 }
4223 }
4225 }
4227 /* --------------------------------------------------------------------------- */
4238 /* %start-doc actions ChangeClearSize
4240 If the solder mask is currently showing, this action changes the
4241 solder mask clearance. If the mask is not showing, this action
4242 changes the polygon clearance.
4244 %end-doc */
4246 static int
4248 {
4253 Coord value;
4256 {
4262 {
4264 {
4276 }
4302 }
4303 }
4305 }
4307 /* --------------------------------------------------------------------------- */
4316 /* %start-doc actions MinMaskGap
4318 Checks all specified pins and/or pads, and increases the mask if
4319 needed to ensure a minimum distance between the pin or pad edge and
4320 the mask edge.
4322 %end-doc */
4324 static int
4326 {
4331 Coord value;
4332 Coord thickness;
4339 else
4340 {
4344 }
4349 {
4351 {
4361 {
4364 }
4365 }
4366 END_LOOP;
4368 {
4372 {
4376 }
4377 }
4378 END_LOOP;
4379 }
4380 END_LOOP;
4382 {
4392 {
4395 }
4396 }
4397 END_LOOP;
4401 }
4403 /* --------------------------------------------------------------------------- */
4412 /* %start-doc actions MinClearGap
4414 Checks all specified objects, and increases the polygon clearance if
4415 needed to ensure a minimum distance between their edges and the
4416 polygon edges.
4418 %end-doc */
4420 static int
4422 {
4427 Coord value;
4434 else
4435 {
4439 }
4444 {
4446 {
4450 {
4454 }
4455 }
4456 END_LOOP;
4458 {
4462 {
4466 }
4467 }
4468 END_LOOP;
4469 }
4470 END_LOOP;
4472 {
4476 {
4479 }
4480 }
4481 END_LOOP;
4483 {
4487 {
4490 }
4491 }
4492 ENDALL_LOOP;
4494 {
4498 {
4501 }
4502 }
4503 ENDALL_LOOP;
4507 }
4509 /* --------------------------------------------------------------------------- */
4517 /* %start-doc actions ChangePinName
4519 This can be especially useful for annotating pin names from a
4520 schematic to the layout without requiring knowledge of the pcb file
4521 format.
4523 @example
4524 ChangePinName(U3, 7, VCC)
4525 @end example
4527 %end-doc */
4529 static int
4531 {
4536 {
4538 }
4545 {
4547 {
4549 {
4551 {
4554 /*
4555 * Note: we can't free() pin->Name first because
4556 * it is used in the undo list
4557 */
4561 }
4562 }
4563 END_LOOP;
4566 {
4568 {
4571 /*
4572 * Note: we can't free() pad->Name first because
4573 * it is used in the undo list
4574 */
4578 }
4579 }
4580 END_LOOP;
4581 }
4582 }
4583 END_LOOP;
4584 /*
4585 * done with our action so increment the undo # if we actually
4586 * changed anything
4587 */
4589 {
4592 else
4593 {
4596 }
4597 }
4600 }
4602 /* --------------------------------------------------------------------------- */
4610 /* %start-doc actions ChangeName
4612 @table @code
4614 @item Object
4615 Changes the name of the element under the cursor.
4617 @item Layout
4618 Changes the name of the layout. This is printed on the fab drawings.
4620 @item Layer
4621 Changes the name of the currently active layer.
4623 @end table
4625 %end-doc */
4627 int
4629 {
4634 {
4636 {
4637 /* change the name of an object */
4639 {
4647 {
4650 {
4653 {
4663 {
4669 }
4672 }
4673 }
4674 }
4676 }
4678 /* change the layout's name */
4680 name =
4682 /* NB: ChangeLayoutName takes ownership of the passed memory */
4687 /* change the name of the active layer */
4691 /* NB: ChangeLayerName takes ownership of the passed memory */
4695 }
4696 }
4698 }
4701 /* --------------------------------------------------------------------------- */
4708 /* %start-doc actions MorphPolygon
4710 If a polygon is divided into unconnected "islands", you can use
4711 this command to convert the otherwise disappeared islands into
4712 separate polygons. Be sure the cursor is over a portion of the
4713 polygon that remains visible. Very small islands that may flake
4714 off are automatically deleted.
4716 %end-doc */
4718 static int
4720 {
4723 {
4725 {
4727 {
4734 {
4738 }
4740 }
4744 {
4747 }
4748 ENDALL_LOOP;
4752 }
4753 }
4755 }
4757 /* --------------------------------------------------------------------------- */
4765 /* %start-doc actions ToggleHideName
4767 If names are hidden you won't see them on the screen and they will not
4768 appear on the silk layer when you print the layout.
4770 %end-doc */
4772 static int
4774 {
4777 {
4779 {
4781 {
4788 {
4795 }
4797 }
4800 {
4803 {
4808 {
4815 }
4816 }
4817 END_LOOP;
4819 {
4822 }
4823 }
4824 }
4825 }
4827 }
4829 /* --------------------------------------------------------------------------- */
4837 /* %start-doc actions ChangeJoin
4839 The join flag determines whether a line or arc, drawn to intersect a
4840 polygon, electrically connects to the polygon or not. When joined,
4841 the line/arc is simply drawn over the polygon, making an electrical
4842 connection. When not joined, a gap is drawn between the line and the
4843 polygon, insulating them from each other.
4845 %end-doc */
4847 static int
4849 {
4852 {
4854 {
4857 {
4868 }
4885 }
4886 }
4888 }
4890 /* --------------------------------------------------------------------------- */
4900 /* %start-doc actions ChangeSquare
4902 Note that @code{Pins} means both pins and pads.
4904 @pinshapes
4906 %end-doc */
4908 static int
4910 {
4913 {
4915 {
4918 {
4929 }
4946 }
4947 }
4949 }
4951 /* --------------------------------------------------------------------------- */
4958 /* %start-doc actions SetSquare
4960 Note that @code{Pins} means pins and pads.
4962 @pinshapes
4964 %end-doc */
4966 static int
4968 {
4971 {
4973 {
4976 {
4987 }
5004 }
5005 }
5007 }
5009 /* --------------------------------------------------------------------------- */
5017 /* %start-doc actions ClearSquare
5019 Note that @code{Pins} means pins and pads.
5021 @pinshapes
5023 %end-doc */
5025 static int
5027 {
5030 {
5032 {
5035 {
5046 }
5063 }
5064 }
5066 }
5068 /* --------------------------------------------------------------------------- */
5077 /* %start-doc actions ChangeOctagon
5079 @pinshapes
5081 %end-doc */
5083 static int
5085 {
5088 {
5090 {
5093 {
5104 }
5126 }
5127 }
5129 }
5131 /* --------------------------------------------------------------------------- */
5138 /* %start-doc actions SetOctagon
5140 @pinshapes
5142 %end-doc */
5144 static int
5146 {
5149 {
5151 {
5154 {
5165 }
5187 }
5188 }
5190 }
5192 /* --------------------------------------------------------------------------- */
5201 /* %start-doc actions ClearOctagon
5203 @pinshapes
5205 %end-doc */
5207 static int
5209 {
5212 {
5214 {
5217 {
5228 }
5250 }
5251 }
5253 }
5255 /* --------------------------------------------------------------------------- */
5262 /* %start-doc actions ChangeHole
5264 The "hole flag" of a via determines whether the via is a
5265 plated-through hole (not set), or an unplated hole (set).
5267 %end-doc */
5269 static int
5271 {
5274 {
5276 {
5279 {
5289 }
5296 }
5297 }
5299 }
5301 /* --------------------------------------------------------------------------- */
5309 /* %start-doc actions ChangePaste
5311 The "no paste flag" of a pad determines whether the solderpaste
5312 stencil will have an opening for the pad (no set) or if there wil be
5313 no solderpaste on the pad (set). This is used for things such as
5314 fiducial pads.
5316 %end-doc */
5318 static int
5320 {
5323 {
5325 {
5328 {
5338 }
5345 }
5346 }
5348 }
5350 /* --------------------------------------------------------------------------- */
5363 /* %start-doc actions Select
5365 @table @code
5367 @item ElementByName
5368 @item ObjectByName
5369 @item PadByName
5370 @item PinByName
5371 @item TextByName
5372 @item ViaByName
5373 @item NetByName
5375 These all rely on having a regular expression parser built into
5376 @code{pcb}. If the name is not specified then the user is prompted
5377 for a pattern, and all objects that match the pattern and are of the
5378 type specified are selected.
5380 @item Object
5381 @item ToggleObject
5382 Selects the object under the cursor.
5384 @item Block
5385 Selects all objects in a rectangle indicated by the cursor.
5387 @item All
5388 Selects all objects on the board.
5390 @item Found
5391 Selects all connections with the ``found'' flag set.
5393 @item Connection
5394 Selects all connections with the ``connected'' flag set.
5396 @item Convert
5397 Converts the selected objects to an element. This uses the highest
5398 numbered paste buffer.
5400 @end table
5402 %end-doc */
5404 static int
5406 {
5409 {
5411 {
5412 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5414 /* select objects by their names */
5437 commonByName:
5438 {
5444 {
5449 }
5451 }
5454 /* select a single object */
5461 /* all objects in block */
5463 {
5464 BoxType box;
5478 {
5481 }
5484 }
5486 /* select all visible objects */
5488 {
5489 BoxType box;
5498 }
5500 /* all logical connections */
5503 {
5507 }
5510 /* all physical connections */
5513 {
5517 }
5521 {
5536 }
5542 }
5543 }
5545 }
5547 /* FLAG(have_regex,FlagHaveRegex,0) */
5548 int
5550 {
5551 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5553 #else
5555 #endif
5556 }
5558 /* --------------------------------------------------------------------------- */
5570 /* %start-doc actions Unselect
5572 @table @code
5574 @item All
5575 Unselect all objects.
5577 @item Block
5578 Unselect all objects in a rectangle given by the cursor.
5580 @item Connection
5581 Unselect all connections with the ``found'' flag set.
5583 @item ElementByName
5584 @item ObjectByName
5585 @item PadByName
5586 @item PinByName
5587 @item TextByName
5588 @item ViaByName
5590 These all rely on having a regular expression parser built into
5591 @code{pcb}. If the name is not specified then the user is prompted
5592 for a pattern, and all objects that match the pattern and are of the
5593 type specified are unselected.
5596 @end table
5598 %end-doc */
5600 static int
5602 {
5605 {
5607 {
5608 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5610 /* select objects by their names */
5633 commonByName:
5634 {
5640 {
5645 }
5647 }
5650 /* all objects in block */
5652 {
5653 BoxType box;
5667 {
5670 }
5673 }
5675 /* unselect all visible objects */
5677 {
5678 BoxType box;
5687 }
5689 /* all logical connections */
5692 {
5696 }
5699 /* all physical connections */
5702 {
5706 }
5713 }
5714 }
5716 }
5718 /* --------------------------------------------------------------------------- */
5727 /* %start-doc actions SaveTo
5729 @table @code
5731 @item Layout
5732 Saves the current layout.
5734 @item LayoutAs
5735 Saves the current layout, and remembers the filename used.
5737 @item AllConnections
5738 Save all connections to a file.
5740 @item AllUnusedPins
5741 List all unused pins to a file.
5743 @item ElementConnections
5744 Save connections to the element at the cursor to a file.
5746 @item PasteBuffer
5747 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5749 @end table
5751 %end-doc */
5753 static int
5755 {
5762 {
5766 }
5774 {
5776 {
5782 }
5784 }
5787 {
5791 {
5795 }
5797 }
5800 {
5804 {
5808 }
5810 }
5813 {
5821 {
5825 {
5829 }
5830 }
5832 }
5835 {
5837 }
5840 }
5842 /* --------------------------------------------------------------------------- */
5850 /* %start-doc actions SaveSettings
5852 If you pass no arguments, the settings are stored in
5853 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5854 saved in @code{./pcb.settings}.
5856 %end-doc */
5858 static int
5860 {
5864 }
5866 /* --------------------------------------------------------------------------- */
5873 /* %start-doc actions LoadFrom
5875 This action assumes you know what the filename is. The various GUIs
5876 should have a similar @code{Load} action where the filename is
5877 optional, and will provide their own file selection mechanism to let
5878 you choose the file name.
5880 @table @code
5882 @item Layout
5883 Loads an entire PCB layout, replacing the current one.
5885 @item LayoutToBuffer
5886 Loads an entire PCB layout to the paste buffer.
5888 @item ElementToBuffer
5889 Loads the given element file into the paste buffer. Element files
5890 contain only a single @code{Element} definition, such as the
5891 ``newlib'' library uses.
5893 @item Netlist
5894 Loads a new netlist, replacing any current netlist.
5896 @item Revert
5897 Re-loads the current layout from its disk file, reverting any changes
5898 you may have made.
5900 @end table
5902 %end-doc */
5904 static int
5906 {
5917 {
5922 }
5925 {
5930 }
5933 {
5937 }
5940 {
5947 }
5951 {
5953 }
5956 }
5958 /* --------------------------------------------------------------------------- */
5964 /* %start-doc actions New
5966 If a name is not given, one is prompted for.
5968 %end-doc */
5970 static int
5972 {
5976 {
5979 else
5986 /* do emergency saving
5987 * clear the old struct and allocate memory for the new one
5988 */
5996 /* setup the new name and reset some values to default */
6008 }
6010 }
6012 /*!
6013 * \brief No operation, just for testing purposes.
6014 * syntax: Bell(volume)
6015 */
6016 void
6018 {
6020 }
6022 /* --------------------------------------------------------------------------- */
6033 /* %start-doc actions PasteBuffer
6035 There are a number of paste buffers; the actual limit is a
6036 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
6037 is currently @code{5}. One of these is the ``current'' paste buffer,
6038 often referred to as ``the'' paste buffer.
6040 @table @code
6042 @item AddSelected
6043 Copies the selected objects to the current paste buffer.
6045 @item Clear
6046 Remove all objects from the current paste buffer.
6048 @item Convert
6049 Convert the current paste buffer to an element. Vias are converted to
6050 pins, lines are converted to pads.
6052 @item Restore
6053 Convert any elements in the paste buffer back to vias and lines.
6055 @item Mirror
6056 Flip all objects in the paste buffer vertically (up/down flip). To mirror
6057 horizontally, combine this with rotations.
6059 @item Rotate
6060 Rotates the current buffer. The number to pass is 1..3, where 1 means
6061 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6062 degrees clockwise (270 CCW).
6064 @item Save
6065 Saves any elements in the current buffer to the indicated file.
6067 @item ToLayout
6068 Pastes any elements in the current buffer to the indicated X, Y
6069 coordinates in the layout. The @code{X} and @code{Y} are treated like
6070 @code{delta} is for many other objects. For each, if it's prefixed by
6071 @code{+} or @code{-}, then that amount is relative to the last
6072 location. Otherwise, it's absolute. Units can be
6073 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6074 units, currently 1/100 mil.
6077 @item 1..MAX_BUFFER
6078 Selects the given buffer to be the current paste buffer.
6080 @end table
6082 %end-doc */
6084 static int
6086 {
6095 {
6097 {
6098 /* clear contents of paste buffer */
6103 /* copies objects to paste buffer */
6108 /* converts buffer contents into an element */
6113 /* break up element for editing */
6118 /* Mirror buffer */
6125 {
6128 }
6133 {
6136 }
6139 {
6147 {
6150 }
6152 {
6154 }
6156 }
6158 else
6161 {
6165 {
6170 }
6171 else
6176 }
6180 {
6186 {
6188 }
6190 {
6197 }
6198 else
6199 {
6202 }
6208 }
6211 /* set number */
6213 {
6216 /* correct number */
6219 }
6220 }
6221 }
6225 }
6227 /* --------------------------------------------------------------------------- */
6234 /* %start-doc actions Undo
6236 The unlimited undo feature of @code{Pcb} allows you to recover from
6237 most operations that materially affect you work. Calling
6238 @code{Undo()} without any parameter recovers from the last (non-undo)
6239 operation. @code{ClearList} is used to release the allocated
6240 memory. @code{ClearList} is called whenever a new layout is started or
6241 loaded. See also @code{Redo} and @code{Atomic}.
6243 Note that undo groups operations by serial number; changes with the
6244 same serial number will be undone (or redone) as a group. See
6245 @code{Atomic}.
6247 %end-doc */
6249 static int
6251 {
6254 {
6255 /* don't allow undo in the middle of an operation */
6262 /* undo the last operation */
6268 {
6272 }
6273 /* move anchor point if undoing during line creation */
6275 {
6277 {
6284 }
6286 {
6290 /* this search is guaranteed to succeed */
6297 /* save both ends of line */
6302 /* check that the undo was of the right type */
6304 {
6305 /* wrong undo type, restore anchor points */
6312 }
6313 /* move to new anchor */
6318 /* check if an intermediate point was removed */
6320 {
6321 /* this search should find the restored line */
6329 {
6330 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6334 }
6339 }
6343 {
6346 }
6347 else
6348 {
6349 /* this search is guaranteed to succeed too */
6357 }
6360 }
6361 }
6363 {
6365 {
6369 }
6371 {
6374 /* guaranteed to succeed */
6386 }
6387 }
6388 /* undo the last destructive operation */
6391 }
6393 {
6395 {
6396 /* clear 'undo objects' list */
6400 }
6401 }
6404 }
6406 /* --------------------------------------------------------------------------- */
6412 /* %start-doc actions Redo
6414 This routine allows you to recover from the last undo command. You
6415 might want to do this if you thought that undo was going to revert
6416 something other than what it actually did (in case you are confused
6417 about which operations are un-doable), or if you have been backing up
6418 through a long undo list and over-shoot your stopping point. Any
6419 change that is made since the undo in question will trim the redo
6420 list. For example if you add ten lines, then undo three of them you
6421 could use redo to put them back, but if you move a line on the board
6422 before performing the redo, you will lose the ability to "redo" the
6423 three "undone" lines.
6425 %end-doc */
6427 static int
6429 {
6437 {
6441 {
6447 addedLines++;
6448 }
6449 }
6452 }
6454 /* --------------------------------------------------------------------------- */
6460 /* %start-doc actions Polygon
6462 Polygons need a special action routine to make life easier.
6464 @table @code
6466 @item Close
6467 Creates the final segment of the polygon. This may fail if clipping
6468 to 45 degree lines is switched on, in which case a warning is issued.
6470 @item PreviousPoint
6471 Resets the newly entered corner to the previous one. The Undo action
6472 will call Polygon(PreviousPoint) when appropriate to do so.
6474 @end table
6476 %end-doc */
6478 static int
6480 {
6483 {
6486 {
6487 /* close open polygon if possible */
6492 /* go back to the previous point */
6496 }
6498 }
6500 }
6502 /* --------------------------------------------------------------------------- */
6509 /* %start-doc actions RouteStyle
6511 %end-doc */
6513 static int
6515 {
6521 {
6524 {
6531 }
6532 }
6534 }
6537 /* --------------------------------------------------------------------------- */
6544 /* %start-doc actions MoveObject
6546 The @code{X} and @code{Y} are treated like @code{delta} is for many
6547 other objects. For each, if it's prefixed by @code{+} or @code{-},
6548 then that amount is relative. Otherwise, it's absolute. Units can be
6549 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6550 units, currently 1/100 mil.
6552 %end-doc */
6554 static int
6556 {
6570 {
6573 }
6586 }
6588 /* --------------------------------------------------------------------------- */
6596 /* %start-doc actions MoveToCurrentLayer
6598 Note that moving an element from a component layer to a solder layer,
6599 or from solder to component, won't automatically flip it. Use the
6600 @code{Flip()} action to do that.
6602 %end-doc */
6604 static int
6606 {
6609 {
6611 {
6613 {
6624 }
6631 }
6632 }
6634 }
6642 /* %start-doc actions SetSame
6644 When invoked over any line, arc, polygon, or via, this changes the
6645 current layer to be the layer that item is on, and changes the current
6646 sizes (thickness, keepaway, drill, etc) according to that item.
6648 %end-doc */
6650 static int
6652 {
6658 /* set layer current and size from line or arc */
6660 {
6700 }
6702 {
6705 }
6707 }
6710 /* --------------------------------------------------------------------------- */
6721 /* %start-doc actions SetFlag
6723 Turns the given flag on, regardless of its previous setting. See
6724 @code{ChangeFlag}.
6726 @example
6727 SetFlag(SelectedPins,thermal)
6728 @end example
6730 %end-doc */
6732 static int
6734 {
6739 }
6741 /* --------------------------------------------------------------------------- */
6752 /* %start-doc actions ClrFlag
6754 Turns the given flag off, regardless of its previous setting. See
6755 @code{ChangeFlag}.
6757 @example
6758 ClrFlag(SelectedLines,join)
6759 @end example
6761 %end-doc */
6763 static int
6765 {
6770 }
6772 /* --------------------------------------------------------------------------- */
6784 /* %start-doc actions ChangeFlag
6786 Toggles the given flag on the indicated object(s). The flag may be
6787 one of the flags listed above (square, octagon, thermal, join). The
6788 value may be the number 0 or 1. If the value is 0, the flag is
6789 cleared. If the value is 1, the flag is set.
6791 %end-doc */
6793 static int
6795 {
6804 }
6807 static void
6809 {
6814 {
6817 }
6819 {
6822 }
6824 {
6825 /* Note: these are backwards, because the flag is "clear" but
6826 the command is "join". */
6829 }
6830 else
6831 {
6834 }
6837 {
6839 {
6851 }
6893 }
6894 }
6896 /* --------------------------------------------------------------------------- */
6902 /* %start-doc actions ExecuteFile
6904 Lines starting with @code{#} are ignored.
6906 %end-doc */
6908 static int
6910 {
6923 {
6926 }
6931 {
6932 n++;
6935 /* eat the trailing newline */
6937 sp++;
6940 /* eat leading spaces and tabs */
6943 sp++;
6945 /*
6946 * if we have anything left and its not a comment line
6947 * then execute it
6948 */
6951 {
6952 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6954 }
6955 }
6959 {
6962 }
6965 }
6967 /* --------------------------------------------------------------------------- */
6969 static int
6971 {
6975 }
6977 /* --------------------------------------------------------------------------- */
6983 {
6990 {
6993 {
6996 }
6997 }
6998 END_LOOP;
7000 }
7004 {
7010 }
7012 static void
7014 {
7021 }
7023 /* ---------------------------------------------------------------- */
7030 /* %start-doc actions elementlist
7032 @table @code
7034 @item Start
7035 Indicates the start of an element list; call this before any Need
7036 actions.
7038 @item Need
7039 Searches the board for an element with a matching refdes.
7041 If found, the value and footprint are updated.
7043 If not found, a new element is created with the given footprint and value.
7045 @item Done
7046 Compares the list of elements needed since the most recent
7047 @code{start} with the list of elements actually on the board. Any
7048 elements that weren't listed are selected, so that the user may delete
7049 them.
7051 @end table
7053 %end-doc */
7057 static int
7059 {
7064 }
7066 static int
7068 {
7079 #ifdef DEBUG
7081 #endif
7084 {
7086 {
7088 }
7089 END_LOOP;
7093 }
7096 {
7098 {
7100 {
7102 }
7104 {
7105 /* Unnamed elements should remain untouched */
7107 }
7108 }
7109 END_LOOP;
7115 }
7123 argc --;
7124 argv ++;
7134 #ifdef DEBUG
7138 #endif
7143 {
7146 #ifdef DEBUG
7148 #endif
7149 /* Not on board, need to add it. */
7151 {
7152 number_of_footprints_not_found ++;
7154 }
7165 {
7168 }
7179 /* Place components onto center of board. */
7182 }
7185 {
7186 #ifdef DEBUG
7188 #endif
7193 /* Different footprint, we need to swap them out. */
7195 {
7196 number_of_footprints_not_found ++;
7198 }
7213 {
7218 }
7224 }
7226 /* Now reload footprint */
7239 #ifdef DEBUG
7241 #endif
7244 }
7246 /* ---------------------------------------------------------------- */
7253 /* %start-doc actions elementsetattr
7255 If a value is specified, the named attribute is added (if not already
7256 present) or changed (if it is) to the given value. If the value is
7257 not specified, the given attribute is removed if present.
7259 %end-doc */
7261 static int
7263 {
7269 {
7271 }
7278 {
7280 {
7283 }
7284 }
7285 END_LOOP;
7288 {
7291 }
7296 {
7299 }
7301 {
7303 }
7305 {
7307 }
7310 }
7312 /* ---------------------------------------------------------------- */
7317 /* %start-doc actions execcommand
7319 Runs the given command, which is a system executable.
7321 %end-doc */
7323 static int
7325 {
7329 {
7331 }
7338 }
7340 /* ---------------------------------------------------------------- */
7342 static int
7344 {
7345 #ifdef HAVE__SPAWNVP
7349 else
7351 #else
7355 {
7356 /* error */
7359 }
7361 {
7362 /* Child */
7365 }
7366 else
7367 {
7369 /* Parent */
7371 }
7373 #endif
7374 }
7376 /* ---------------------------------------------------------------- */
7378 /*!
7379 * \brief Creates a new temporary file name.
7380 *
7381 * Hopefully the operating system provides a mkdtemp() function to
7382 * securily create a temporary directory with mode 0700.\n
7383 * If so then that directory is created and the returned string is made
7384 * up of the directory plus the name variable.\n
7385 * For example:\n
7386 *
7387 * tempfile_name_new ("myfile") might return
7388 * "/var/tmp/pcb.123456/myfile".
7389 *
7390 * If mkdtemp() is not available then 'name' is ignored and the
7391 * insecure tmpnam() function is used.
7392 *
7393 * Files/names created with tempfile_name_new() should be unlinked
7394 * with tempfile_unlink to make sure the temporary directory is also
7395 * removed when mkdtemp() is used.
7396 */
7399 {
7401 #ifdef HAVE_MKDTEMP
7404 #endif
7408 #ifdef HAVE_MKDTEMP
7414 /* FIXME -- what about win32? */
7417 }
7427 }
7437 }
7444 ;
7454 #undef TEMPLATE
7455 #else
7456 /*
7457 * tmpnam() uses a static buffer so strdup() the result right away
7458 * in case someone decides to create multiple temp names.
7459 */
7461 #ifdef __WIN32__
7462 {
7463 /* Guile doesn't like \ separators */
7468 }
7469 #endif
7470 #endif
7473 }
7475 /* ---------------------------------------------------------------- */
7477 /*!
7478 * \brief Unlink a temporary file.
7479 *
7480 * If we have mkdtemp() then our temp file lives in a temporary
7481 * directory and we need to remove that directory too.
7482 */
7483 static int
7485 {
7486 #ifdef DEBUG
7487 /* SDB says: Want to keep old temp files for examiniation when debugging */
7489 #endif
7491 #ifdef HAVE_MKDTEMP
7496 /* it is possible that the file was never created so it is OK if the
7497 unlink fails */
7499 /* now figure out the directory name to remove */
7506 /*
7507 * at this point, e *should* point to the end of the directory part
7508 * but lets make sure.
7509 */
7514 }
7518 __FUNCTION__);
7522 }
7524 /* name was allocated with malloc */
7528 /*
7529 * FIXME - should also return -1 if the temp file exists and was not
7530 * removed.
7531 */
7534 }
7536 #else
7543 }
7546 #endif
7549 }
7551 /* ---------------------------------------------------------------- */
7560 /* %start-doc actions Import
7562 Imports element and netlist data from the schematics (or some other
7563 source). The first parameter, which is optional, is the mode. If not
7564 specified, the @code{import::mode} attribute in the PCB is used.
7565 @code{gnetlist} means gnetlist is used to obtain the information from
7566 the schematics. @code{make} invokes @code{make}, assuming the user
7567 has a @code{Makefile} in the current directory. The @code{Makefile}
7568 will be invoked with the following variables set:
7570 @table @code
7572 @item PCB
7573 The name of the .pcb file
7575 @item SRCLIST
7576 A space-separated list of source files
7578 @item OUT
7579 The name of the file in which to put the command script, which may
7580 contain any @pcb{} actions. By default, this is a temporary file
7581 selected by @pcb{}, but if you specify an @code{import::outfile}
7582 attribute, that file name is used instead (and not automatically
7583 deleted afterwards).
7585 @end table
7587 The target specified to be built is the first of these that apply:
7589 @itemize @bullet
7591 @item
7592 The target specified by an @code{import::target} attribute.
7594 @item
7595 The output file specified by an @code{import::outfile} attribute.
7597 @item
7598 If nothing else is specified, the target is @code{pcb_import}.
7600 @end itemize
7602 If you specify an @code{import::makefile} attribute, then "-f <that
7603 file>" will be added to the command line.
7605 If you specify the mode, you may also specify the source files
7606 (schematics). If you do not specify any, the list of schematics is
7607 obtained by reading the @code{import::src@var{N}} attributes (like
7608 @code{import::src0}, @code{import::src1}, etc).
7610 For compatibility with future extensions to the import file format,
7611 the generated file @emph{must not} start with the two characters
7612 @code{#%}.
7614 If a temporary file is needed the @code{TMPDIR} environment variable
7615 is used to select its location.
7617 Note that the programs @code{gnetlist} and @code{make} may be
7618 overridden by the user via the @code{make-program} and @code{gnetlist}
7619 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7620 line).
7622 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7623 is called to let user choose (see @code{ImportGUI()}).
7625 Note that Import() doesn't delete anything - after an Import, elements
7626 which shouldn't be on the board are selected and may be removed once
7627 it's determined that the deletion is appropriate.
7629 If @code{Import()} is called with @code{setnewpoint}, then the location
7630 of new components can be specified. This is where parts show up when
7631 they're added to the board. The default is the center of the board.
7633 @table @code
7635 @item Import(setnewpoint)
7637 Prompts the user to click on the board somewhere, uses that point. If
7638 called by a hotkey, uses the current location of the crosshair.
7640 @item Import(setnewpoint,mark)
7642 Uses the location of the mark. If no mark is present, the point is
7643 not changed.
7645 @item Import(setnewpoint,center)
7647 Resets the point to the center of the board.
7649 @item Import(setnewpoint,X,Y,units)
7651 Sets the point to the specific coordinates given. Example:
7652 @code{Import(setnewpoint,50,25,mm)}
7654 @end table
7656 Note that the X and Y locations are stored in attributes named
7657 @code{import::newX} and @code{import::newY} so you could change them
7658 manually if you wished.
7660 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7661 placed elements are dispersed relative to the set point. For example,
7662 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7663 10mm away from the point. The default dispersion is 1/10th of the
7664 smallest board dimension. Dispersion is saved in the
7665 @code{import::disperse} attribute.
7667 %end-doc */
7669 static int
7671 {
7676 #ifdef DEBUG
7678 #endif
7683 {
7690 {
7693 }
7695 {
7698 }
7699 else
7704 }
7707 {
7717 {
7719 }
7721 {
7725 }
7727 {
7733 }
7735 {
7738 }
7739 else
7740 {
7743 }
7750 }
7758 {
7761 }
7764 {
7770 nsources ++;
7776 {
7780 nsources ++;
7785 }
7786 }
7789 {
7790 /* Replace .pcb with .sch and hope for the best. */
7812 {
7815 }
7821 }
7824 {
7832 }
7845 #ifdef DEBUG
7849 #endif
7852 {
7855 }
7857 #ifdef DEBUG
7858 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7859 #endif
7867 }
7869 {
7889 else
7890 {
7896 }
7898 }
7906 {
7910 }
7919 {
7922 }
7927 {
7934 }
7945 }
7946 else
7947 {
7950 }
7955 #ifdef DEBUG
7957 #endif
7960 }
7962 /* ------------------------------------------------------------ */
7972 /* %start-doc actions Attributes
7974 This just pops up a dialog letting the user edit the attributes of the
7975 pcb, an element, or a layer.
7977 %end-doc */
7980 static int
7982 {
7991 {
7994 }
7997 {
7999 {
8002 }
8005 {
8008 {
8013 {
8016 }
8018 {
8021 }
8022 }
8029 }
8032 {
8036 {
8038 {
8040 n_found ++;
8041 }
8042 }
8043 END_LOOP;
8045 {
8048 }
8050 {
8057 else
8058 {
8061 }
8062 }
8065 {
8069 }
8070 else
8071 {
8073 }
8077 }
8081 }
8084 }
8086 /* --------------------------------------------------------------------------- */
8088 HID_Action action_action_list[] = {
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 ,
8253 ,
8256 ,
8259 ,
8262 ,
8264 ,
8267 ,
8270 ,
8273 ,
8276 ,
8277 };