| blob | a4ab2d0ac690e9927afba08805a423e90dec765a |
1 /*
2 * COPYRIGHT
3 *
4 * PCB, interactive printed circuit board design
5 * Copyright (C) 1994,1995,1996 Thomas Nau
6 * Copyright (C) 1997, 1998, 1999, 2000, 2001 Harry Eaton
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 * Contact addresses for paper mail and Email:
23 * Harry Eaton, 6697 Buttonhole Ct, Columbia, MD 21044, USA
24 * haceaton@aplcomm.jhuapl.edu
25 *
26 */
28 /* action routines for output window
29 */
31 #ifdef HAVE_CONFIG_H
33 #endif
59 /*#include "print.h"*/
74 #include <assert.h>
77 #ifdef HAVE_LIBDMALLOC
78 #include <dmalloc.h>
79 #endif
81 /* for fork() and friends */
82 #ifdef HAVE_UNISTD_H
83 #include <unistd.h>
84 #endif
86 #ifdef HAVE_SYS_WAIT_H
87 #include <sys/wait.h>
88 #endif
90 /* ---------------------------------------------------------------------------
91 * some local types
92 */
94 {
95 F_AddSelected,
96 F_All,
97 F_AllConnections,
98 F_AllRats,
99 F_AllUnusedPins,
100 F_Arc,
101 F_Arrow,
102 F_Block,
103 F_Description,
104 F_Cancel,
105 F_Center,
106 F_Clear,
107 F_ClearAndRedraw,
108 F_ClearList,
109 F_Close,
110 F_Found,
111 F_Connection,
112 F_Convert,
113 F_Copy,
114 F_CycleClip,
115 F_CycleCrosshair,
116 F_DeleteRats,
117 F_Drag,
118 F_DrillReport,
119 F_Element,
120 F_ElementByName,
121 F_ElementConnections,
122 F_ElementToBuffer,
123 F_Escape,
124 F_Find,
125 F_FlipElement,
126 F_FoundPins,
127 F_Grid,
128 F_InsertPoint,
129 F_Layer,
130 F_Layout,
131 F_LayoutAs,
132 F_LayoutToBuffer,
133 F_Line,
134 F_LineSize,
135 F_Lock,
136 F_Mirror,
137 F_Move,
138 F_NameOnPCB,
139 F_Netlist,
140 F_NetByName,
141 F_None,
142 F_Notify,
143 F_Object,
144 F_ObjectByName,
145 F_PasteBuffer,
146 F_PadByName,
147 F_PinByName,
148 F_PinOrPadName,
149 F_Pinout,
150 F_Polygon,
151 F_PolygonHole,
152 F_PreviousPoint,
153 F_RatsNest,
154 F_Rectangle,
155 F_Redraw,
156 F_Release,
157 F_Revert,
158 F_Remove,
159 F_RemoveSelected,
160 F_Report,
161 F_Reset,
162 F_ResetLinesAndPolygons,
163 F_ResetPinsViasAndPads,
164 F_Restore,
165 F_Rotate,
166 F_Save,
167 F_Selected,
168 F_SelectedArcs,
169 F_SelectedElements,
170 F_SelectedLines,
171 F_SelectedNames,
172 F_SelectedObjects,
173 F_SelectedPads,
174 F_SelectedPins,
175 F_SelectedTexts,
176 F_SelectedVias,
177 F_SelectedRats,
178 F_Stroke,
179 F_Text,
180 F_TextByName,
181 F_TextScale,
182 F_Thermal,
183 F_ToLayout,
184 F_ToggleAllDirections,
185 F_ToggleAutoDRC,
186 F_ToggleClearLine,
187 F_ToggleFullPoly,
188 F_ToggleGrid,
189 F_ToggleHideNames,
190 F_ToggleMask,
191 F_ToggleName,
192 F_ToggleObject,
193 F_ToggleShowDRC,
194 F_ToggleLiveRoute,
195 F_ToggleRubberBandMode,
196 F_ToggleStartDirection,
197 F_ToggleSnapPin,
198 F_ToggleThindraw,
199 F_ToggleLockNames,
200 F_ToggleOnlyNames,
201 F_ToggleThindrawPoly,
202 F_ToggleOrthoMove,
203 F_ToggleLocalRef,
204 F_ToggleCheckPlanes,
205 F_ToggleUniqueNames,
206 F_Via,
207 F_ViaByName,
208 F_Value,
209 F_ViaDrillingHole,
210 F_ViaSize,
211 F_Zoom
212 }
213 FunctionID;
216 {
218 FunctionID ID;
219 }
220 FunctionType;
222 /* --------------------------------------------------------------------------- */
224 /* %start-doc actions 00delta
226 Many actions take a @code{delta} parameter as the last parameter,
227 which is an amount to change something. That @code{delta} may include
228 units, as an additional parameter, such as @code{Action(Object,5,mm)}.
229 If no units are specified, the default is PCB's native units
230 (currently 1/100 mil). Also, if the delta is prefixed by @code{+} or
231 @code{-}, the size is increased or decreased by that amount.
232 Otherwise, the size size is set to the given amount.
234 @example
235 Action(Object,5,mil)
236 Action(Object,+0.5,mm)
237 Action(Object,-1)
238 @end example
240 Actions which take a @code{delta} parameter which do not accept all
241 these options will specify what they do take.
243 %end-doc */
245 /* %start-doc actions 00objects
247 Many actions act on indicated objects on the board. They will have
248 parameters like @code{ToggleObject} or @code{SelectedVias} to indicate
249 what group of objects they act on. Unless otherwise specified, these
250 parameters are defined as follows:
252 @table @code
254 @item Object
255 @itemx ToggleObject
256 Affects the object under the mouse pointer. If this action is invoked
257 from a menu or script, the user will be prompted to click on an
258 object, which is then the object affected.
260 @item Selected
261 @itemx SelectedObjects
263 Affects all objects which are currently selected. At least, all
264 selected objects for which the given action makes sense.
266 @item SelectedPins
267 @itemx SelectedVias
268 @itemx Selected@var{Type}
269 @itemx @i{etc}
270 Affects all objects which are both selected and of the @var{Type} specified.
272 @end table
274 %end-doc */
276 /* %start-doc actions 00macros
278 @macro pinshapes
280 Pins, pads, and vias can have various shapes. All may be round. Pins
281 and pads may be square (obviously "square" pads are usually
282 rectangular). Pins and vias may be octagonal. When you change a
283 shape flag of an element, you actually change all of its pins and
284 pads.
286 Note that the square flag takes precedence over the octagon flag,
287 thus, if both the square and octagon flags are set, the object is
288 square. When the square flag is cleared, the pins and pads will be
289 either round or, if the octagon flag is set, octagonal.
291 @end macro
293 %end-doc */
295 /* ---------------------------------------------------------------------------
296 * some local identifiers
297 */
300 static struct
301 {
303 LineType line;
304 }
305 fake;
307 static struct
308 {
310 Cardinal Buffer;
317 }
318 Note;
325 #ifdef HAVE_LIBSTROKE
328 #endif
447 };
449 /* ---------------------------------------------------------------------------
450 * some local routines
451 */
458 #ifdef HAVE_LIBSTROKE
463 #endif
466 #define ARG(n) (argc > (n) ? argv[n] : NULL)
468 #ifdef HAVE_LIBSTROKE
470 /* ---------------------------------------------------------------------------
471 * FinishStroke - try to recognize the stroke sent
472 */
473 void
475 {
483 {
486 {
489 {
491 }
535 /* XXX: FIXME: Call a zoom-extents action */
546 /* XXX: FIXME: Zoom to fit the box StrokeBox.[X1,Y1] - StrokeBox.[X2,Y2] */
552 }
553 }
554 else
556 }
557 #endif
559 /* ---------------------------------------------------------------------------
560 * Clear warning color from pins/pads
561 */
562 static void
564 {
567 {
569 {
572 }
573 }
574 ENDALL_LOOP;
576 {
578 {
581 }
582 }
583 ENDALL_LOOP;
585 }
587 /* ---------------------------------------------------------------------------
588 *
589 * This is called a clicktime after a mouse down, to we can distinguish
590 * between short clicks (typically: select or create something) and long
591 * clicks. Long clicks typically drag something.
592 */
593 static void
595 {
597 {
601 {
611 }
613 {
622 }
623 else
624 {
625 BoxType box;
634 /* unselect first if shift key not down */
640 }
642 }
643 }
645 /* ---------------------------------------------------------------------------
646 *
647 * This is typically called when the mouse has moved or the mouse
648 * button was released.
649 */
650 static void
652 {
653 BoxType box;
656 {
657 BoxType box;
666 /* unselect first if shift key not down */
668 {
672 {
676 }
677 }
683 }
685 {
692 }
694 {
697 }
699 {
714 }
718 }
720 /* ---------------------------------------------------------------------------
721 * get function ID of passed string
722 */
723 #define HSIZE 257
727 static int
729 {
732 {
735 s ++;
736 }
739 }
741 static int
743 {
750 {
753 {
757 }
759 {
760 /* Change 'char' to 'int' and remove this when we get to 256
761 strings to hash. */
766 }
768 {
773 }
774 }
778 {
779 /* We enforce the "hash table bigger than function table" rule,
780 so we know there will be at least one zero entry to find. */
786 }
787 }
789 /* ---------------------------------------------------------------------------
790 * set new coordinates if in 'RECTANGLE' mode
791 * the cursor shape is also adjusted
792 */
793 static void
795 {
797 {
800 }
802 {
804 {
805 /* update coordinates */
809 }
810 }
811 }
813 /* ---------------------------------------------------------------------------
814 * adjusts the objects which are to be created like attached lines...
815 */
816 void
818 {
821 {
822 /* update at least an attached block (selection) */
826 {
829 }
832 /* rectangle creation mode */
838 /* polygon creation mode */
843 /* line creation mode */
847 else
850 /* point insertion mode */
858 }
859 }
861 /* ---------------------------------------------------------------------------
862 * creates points of a line
863 */
864 static void
866 {
873 {
878 {
881 }
883 {
889 }
891 {
896 }
898 {
903 {
906 }
907 else
908 {
911 }
912 }
913 else
914 {
919 }
924 /* fall through to third state too */
929 }
930 }
932 /* ---------------------------------------------------------------------------
933 * create first or second corner of a marked block
934 */
935 static void
937 {
940 {
952 }
954 }
957 /* ---------------------------------------------------------------------------
958 *
959 * This is called after every mode change, like mouse button pressed,
960 * mouse button released, dragging something started or a different tool
961 * selected. It does what's appropriate for the current mode setting.
962 * This can also mean creation of an object at the current crosshair location.
963 *
964 * new created objects are added to the create undo list of course
965 */
966 static void
968 {
975 {
977 {
979 hidval hv;
982 /* do something after click time */
985 /* see if we clicked on something already selected
986 * (Note.Moving) or clicked on a MOVE_TYPE
987 * (Note.Hit)
988 */
991 {
995 {
1000 }
1006 }
1008 }
1011 {
1015 {
1019 }
1024 {
1031 }
1033 }
1036 {
1038 {
1049 {
1057 {
1061 #ifdef ARC45
1064 else
1065 #endif
1067 }
1068 else
1069 {
1073 #ifdef ARC45
1076 else
1077 #endif
1080 }
1082 Crosshair.
1083 AttachedBox.
1085 Crosshair.
1086 AttachedBox.
1090 sa,
1091 dir,
1092 Settings.
1093 LineThickness,
1095 Keepaway,
1096 MakeFlags
1097 (TEST_FLAG
1099 PCB) ?
1100 CLEARLINEFLAG :
1102 {
1112 addedLines++;
1116 }
1118 }
1119 }
1121 }
1123 {
1126 {
1131 {
1134 }
1135 END_LOOP;
1137 {
1140 }
1141 END_LOOP;
1143 /* always re-draw it since I'm too lazy
1144 * to tell if a selected flag changed
1145 */
1150 }
1152 {
1157 {
1158 /* this is not un-doable since LOCK isn't */
1162 }
1165 }
1167 }
1169 {
1171 =
1175 {
1177 {
1179 tstyle++;
1183 }
1186 else
1188 }
1190 }
1193 /* do update of position */
1198 /* Remove anchor if clicking on start point;
1199 * this means we can't paint 0 length lines
1200 * which could be used for square SMD pads.
1201 * Instead use a very small delta, or change
1202 * the file after saving.
1203 */
1206 {
1209 }
1212 {
1215 {
1216 addedLines++;
1225 }
1227 }
1228 else
1229 /* create line if both ends are determined && length != 0 */
1230 {
1247 {
1248 /* We will only need to paint the second line segment.
1249 Since we only check for vias on the first segment,
1250 swap them so the non-empty segment is the first segment. */
1253 }
1268 {
1271 addedLines++;
1274 /* place a via if vias are visible, the layer is
1275 in a new group since the last line and there
1276 isn't a pin already here */
1283 NO_TYPE
1292 {
1295 }
1296 /* copy the coordinates */
1303 }
1315 {
1316 addedLines++;
1320 /* move to new start point */
1326 {
1328 }
1329 }
1333 }
1337 /* do update of position */
1340 /* create rectangle if both corners are determined
1341 * and width, height are != 0
1342 */
1346 {
1353 Crosshair.
1355 Crosshair.
1357 Crosshair.
1359 Crosshair.
1361 MakeFlags
1363 NULL)
1364 {
1370 }
1372 /* reset state to 'first corner' */
1374 }
1378 {
1382 {
1384 {
1394 {
1399 }
1400 }
1402 }
1404 }
1407 {
1411 /* do update of position; use the 'LINE_MODE' mechanism */
1414 /* check if this is the last point of a polygon */
1418 {
1422 }
1424 /* create new point if it's the first one or if it's
1425 * different to the last one
1426 */
1430 {
1435 /* copy the coordinates */
1438 }
1440 }
1443 {
1445 {
1446 /* first notify, lookup object */
1455 {
1458 {
1462 }
1463 else
1465 }
1468 /* second notify, insert new point into object */
1470 {
1474 FlagType Flags;
1476 /* do update of position; use the 'LINE_MODE' mechanism */
1479 /* check if this is the last point of a polygon */
1483 {
1484 /* Create POLYAREAs from the original polygon
1485 * and the new hole polygon */
1489 /* Subtract the hole from the original polygon shape */
1492 /* Convert the resulting polygon(s) into a new set of nodes
1493 * and place them on the page. Delete the original polygon.
1494 */
1507 /* reset state of attached line */
1513 }
1515 /* create new point if it's the first one or if it's
1516 * different to the last one
1517 */
1521 {
1526 /* copy the coordinates */
1529 }
1531 }
1532 }
1535 }
1538 {
1543 {
1548 {
1551 {
1559 }
1560 }
1561 }
1565 {
1570 {
1577 {
1589 }
1590 }
1591 }
1593 }
1599 {
1601 {
1604 }
1606 {
1614 {
1621 else
1623 ptr++;
1624 }
1625 }
1629 }
1639 /* both are almost the same */
1643 {
1644 /* first notify, lookup object */
1646 {
1656 {
1660 {
1663 }
1664 else
1666 }
1668 }
1670 /* second notify, move or copy object */
1679 else
1680 {
1688 }
1691 /* reset identifiers */
1695 }
1698 /* insert a point into a polygon/line/... */
1701 {
1702 /* first notify, lookup object */
1711 {
1714 {
1718 }
1719 else
1720 {
1721 /* get starting point of nearest segment */
1723 {
1726 polyIndex =
1734 }
1737 }
1738 }
1741 /* second notify, insert new point into object */
1748 else
1756 /* reset identifiers */
1760 }
1762 }
1763 }
1766 /* --------------------------------------------------------------------------- */
1772 /* %start-doc actions Atomic
1774 This action allows making multiple-action bindings into an atomic
1775 operation that will be undone by a single Undo command. For example,
1776 to optimize rat lines, you'd delete the rats and re-add them. To
1777 group these into a single undo, you'd want the deletions and the
1778 additions to have the same undo serial number. So, you @code{Save},
1779 delete the rats, @code{Restore}, add the rats - using the same serial
1780 number as the deletes, then @code{Block}, which checks to see if the
1781 deletions or additions actually did anything. If not, the serial
1782 number is set to the saved number, as there's nothing to undo. If
1783 something did happen, the serial number is incremented so that these
1784 actions are counted as a single undo step.
1786 @table @code
1788 @item Save
1789 Saves the undo serial number.
1791 @item Restore
1792 Returns it to the last saved number.
1794 @item Close
1795 Sets it to 1 greater than the last save.
1797 @item Block
1798 Does a Restore if there was nothing to undo, else does a Close.
1800 @end table
1802 %end-doc */
1804 static int
1806 {
1811 {
1827 }
1829 }
1831 /* -------------------------------------------------------------------------- */
1837 /* %start-doc actions DRC
1839 Note that the design rule check uses the current board rule settings,
1840 not the current style settings.
1842 %end-doc */
1844 static int
1846 {
1850 {
1858 }
1861 {
1866 else
1868 }
1870 }
1872 /* -------------------------------------------------------------------------- */
1879 /* %start-doc actions DumpLibrary
1882 %end-doc */
1884 static int
1886 {
1893 {
1904 {
1907 {
1910 }
1911 else
1912 {
1919 }
1920 }
1921 }
1924 }
1926 /* -------------------------------------------------------------------------- */
1933 /* %start-doc actions Flip
1935 Note that the location of the element will be symmetric about the
1936 cursor location; i.e. if the part you are pointing at will still be at
1937 the same spot once the element is on the other side. When flipping
1938 multiple elements, this retains their positions relative to each
1939 other, not their absolute positions on the board.
1941 %end-doc */
1943 static int
1945 {
1952 {
1954 {
1958 {
1963 }
1972 }
1975 }
1978 }
1980 /* -------------------------------------------------------------------------- */
1986 /* %start-doc actions Message
1988 This action displays a message to the log window. This action is primarily
1989 provided for use by other programs which may interface with PCB. If
1990 multiple arguments are given, each one is sent to the log window
1991 followed by a newline.
1993 %end-doc */
1995 static int
1997 {
2004 {
2007 }
2010 }
2013 /* -------------------------------------------------------------------------- */
2023 "Style = 3 is a solid connection to the plane."
2027 /* %start-doc actions SetThermal
2029 This changes how/whether pins or vias connect to any rectangle or polygon
2030 on the current layer. The first argument can specify one object, or all
2031 selected pins, or all selected vias, or all selected pins and vias.
2032 The second argument specifies the style of connection.
2033 There are 5 possibilities:
2034 0 - no connection,
2035 1 - 45 degree fingers with sharp edges,
2036 2 - horizontal & vertical fingers with sharp edges,
2037 3 - solid connection,
2038 4 - 45 degree fingers with rounded corners,
2039 5 - horizontal & vertical fingers with rounded corners.
2041 Pins and Vias may have thermals whether or not there is a polygon available
2042 to connect with. However, they will have no effect without the polygon.
2043 %end-doc */
2045 static int
2047 {
2055 {
2061 {
2066 {
2070 }
2085 }
2086 else
2090 }
2093 }
2095 /* ---------------------------------------------------------------------------
2096 * !!! no action routine !!!
2097 *
2098 * event handler to set the cursor according to the X pointer position
2099 * called from inside main.c
2100 */
2101 void
2103 {
2104 #ifdef HAVE_LIBSTROKE
2106 {
2111 }
2114 {
2115 /* update object position and cursor location */
2118 }
2119 }
2121 /* --------------------------------------------------------------------------- */
2129 /* %start-doc actions SetValue
2131 @table @code
2133 @item ViaDrillingHole
2134 Changes the diameter of the drill for new vias.
2136 @item Grid
2137 Sets the grid spacing.
2139 @item Line
2140 @item LineSize
2141 Changes the thickness of new lines.
2143 @item Via
2144 @item ViaSize
2145 Changes the diameter of new vias.
2147 @item Text
2148 @item TextScale
2149 Changes the size of new text.
2151 @end table
2153 %end-doc */
2155 static int
2157 {
2167 {
2170 {
2181 else
2182 {
2186 /* On the way down, short against the minimum
2187 * PCB drawing unit */
2192 else
2194 }
2222 }
2225 }
2228 }
2231 /* --------------------------------------------------------------------------- */
2237 /* %start-doc actions Quit
2239 If you have unsaved changes, you will be prompted to confirm (or
2240 save) before quitting.
2242 %end-doc */
2244 static int
2246 {
2249 {
2252 }
2256 }
2258 /* --------------------------------------------------------------------------- */
2266 /* %start-doc actions Connection
2268 Connections found with this action will be highlighted in the
2269 ``connected-color'' color and will have the ``found'' flag set.
2271 @table @code
2273 @item Find
2274 The net under the cursor is ``found''.
2276 @item ResetLinesAndPolygons
2277 Any ``found'' lines and polygons are marked ``not found''.
2279 @item ResetPinsAndVias
2280 Any ``found'' pins and vias are marked ``not found''.
2282 @item Reset
2283 All ``found'' objects are marked ``not found''.
2285 @end table
2287 %end-doc */
2289 static int
2291 {
2294 {
2296 {
2298 {
2303 }
2307 {
2310 }
2315 {
2318 }
2323 {
2326 }
2328 }
2330 }
2333 }
2335 /* --------------------------------------------------------------------------- */
2342 /* %start-doc actions DisperseElements
2344 Normally this is used when starting a board, by selecting all elements
2345 and then dispersing them. This scatters the elements around the board
2346 so that you can pick individual ones, rather than have all the
2347 elements at the same 0,0 coordinate and thus impossible to choose
2348 from.
2350 %end-doc */
2352 #define GAP MIL_TO_COORD(100)
2354 static int
2356 {
2365 {
2367 }
2368 else
2369 {
2371 {
2382 }
2383 }
2386 {
2388 }
2392 {
2393 /*
2394 * If we want to disperse selected elements, maybe we need smarter
2395 * code here to avoid putting components on top of others which
2396 * are not selected. For now, I'm assuming that this is typically
2397 * going to be used either with a brand new design or a scratch
2398 * design holding some new components
2399 */
2401 {
2403 /* figure out how much to move the element */
2406 /* snap to the grid */
2409 /*
2410 * and add one grid size so we make sure we always space by GAP or
2411 * more
2412 */
2415 /* Figure out if this row has room. If not, start a new row */
2417 {
2420 }
2422 /* figure out how much to move the element */
2426 /* snap to the grid */
2432 /* move the element */
2435 /* and add to the undo list so we can undo this operation */
2438 /* keep track of how tall this row is */
2441 {
2443 }
2444 }
2446 }
2447 END_LOOP;
2449 /* done with our action so increment the undo # */
2456 }
2458 #undef GAP
2460 /* --------------------------------------------------------------------------- */
2475 /* %start-doc actions Display
2477 @table @code
2479 @item NameOnPCB
2480 @item Description
2481 @item Value
2482 Specify whether all elements show their name, description, or value.
2484 @item Redraw
2485 Redraw the whole board.
2487 @item Toggle45Degree
2488 When clear, lines can be drawn at any angle. When set, lines are
2489 restricted to multiples of 45 degrees and requested lines may be
2490 broken up according to the clip setting.
2492 @item CycleClip
2493 Changes the way lines are restricted to 45 degree increments. The
2494 various settings are: straight only, orthogonal then angled, and angled
2495 then orthogonal. If AllDirections is set, this action disables it.
2497 @item CycleCrosshair
2498 Changes crosshair drawing. Crosshair may accept form of 4-ray,
2499 8-ray and 12-ray cross.
2501 @item ToggleRubberBandMode
2502 If set, moving an object moves all the lines attached to it too.
2504 @item ToggleStartDirection
2505 If set, each time you set a point in a line, the Clip toggles between
2506 orth-angle and angle-ortho.
2508 @item ToggleUniqueNames
2509 If set, you will not be permitted to change the name of an element to
2510 match that of another element.
2512 @item ToggleSnapPin
2513 If set, pin centers and pad end points are treated as additional grid
2514 points that the cursor can snap to.
2516 @item ToggleLocalRef
2517 If set, the mark is automatically set to the beginning of any move, so
2518 you can see the relative distance you've moved.
2520 @item ToggleThindraw
2521 If set, objects on the screen are drawn as outlines (lines are drawn
2522 as center-lines). This lets you see line endpoints hidden under pins,
2523 for example.
2525 @item ToggleThindrawPoly
2526 If set, polygons on the screen are drawn as outlines.
2528 @item ToggleShowDRC
2529 If set, pending objects (i.e. lines you're in the process of drawing)
2530 will be drawn with an outline showing how far away from other copper
2531 you need to be.
2533 @item ToggleLiveRoute
2534 If set, the progress of the autorouter will be visible on the screen.
2536 @item ToggleAutoDRC
2537 If set, you will not be permitted to make connections which violate
2538 the current DRC and netlist settings.
2540 @item ToggleCheckPlanes
2541 If set, lines and arcs aren't drawn, which usually leaves just the
2542 polygons. If you also disable all but the layer you're interested in,
2543 this allows you to check for isolated regions.
2545 @item ToggleOrthoMove
2546 If set, the crosshair is only allowed to move orthogonally from its
2547 previous position. I.e. you can move an element or line up, down,
2548 left, or right, but not up+left or down+right.
2550 @item ToggleName
2551 Selects whether the pinouts show the pin names or the pin numbers.
2553 @item ToggleLockNames
2554 If set, text will ignore left mouse clicks and actions that work on
2555 objects under the mouse. You can still select text with a lasso (left
2556 mouse drag) and perform actions on the selection.
2558 @item ToggleOnlyNames
2559 If set, only text will be sensitive for mouse clicks and actions that
2560 work on objects under the mouse. You can still select other objects
2561 with a lasso (left mouse drag) and perform actions on the selection.
2563 @item ToggleMask
2564 Turns the solder mask on or off.
2566 @item ToggleClearLine
2567 When set, the clear-line flag causes new lines and arcs to have their
2568 ``clear polygons'' flag set, so they won't be electrically connected
2569 to any polygons they overlap.
2571 @item ToggleFullPoly
2572 When set, the full-poly flag causes new polygons to have their
2573 ``full polygon'' flag set, so all parts of them will be displayed
2574 instead of only the biggest one.
2576 @item ToggleGrid
2577 Resets the origin of the current grid to be wherever the mouse pointer
2578 is (not where the crosshair currently is). If you provide two numbers
2579 after this, the origin is set to that coordinate.
2581 @item Grid
2582 Toggles whether the grid is displayed or not.
2584 @item Pinout
2585 Causes the pinout of the element indicated by the cursor to be
2586 displayed, usually in a separate window.
2588 @item PinOrPadName
2589 Toggles whether the names of pins, pads, or (yes) vias will be
2590 displayed. If the cursor is over an element, all of its pins and pads
2591 are affected.
2593 @end table
2595 %end-doc */
2597 static enum crosshair_shape
2599 {
2601 {
2614 }
2616 }
2618 static int
2620 {
2629 {
2631 {
2633 /* redraw layout */
2639 /* change the displayed name of elements */
2644 {
2646 }
2647 END_LOOP;
2650 {
2659 }
2661 {
2663 }
2664 END_LOOP;
2668 /* toggle line-adjust flag */
2677 {
2680 }
2681 else
2758 {
2760 {
2763 }
2765 {
2772 }
2773 }
2804 /* shift grid alignment */
2806 {
2813 }
2816 /* toggle displaying of the grid */
2822 /* display the pinout of an element */
2824 {
2833 {
2836 }
2838 }
2840 /* toggle displaying of pin/pad/via names */
2842 {
2849 {
2852 {
2855 else
2859 }
2860 END_LOOP;
2862 {
2865 else
2869 }
2870 END_LOOP;
2879 else
2891 else
2902 else
2910 }
2912 }
2915 }
2916 }
2918 {
2920 {
2923 {
2928 }
2934 }
2935 }
2941 }
2943 /* --------------------------------------------------------------------------- */
2953 /* %start-doc actions Mode
2955 @table @code
2957 @item Arc
2958 @itemx Arrow
2959 @itemx Copy
2960 @itemx InsertPoint
2961 @itemx Line
2962 @itemx Lock
2963 @itemx Move
2964 @itemx None
2965 @itemx PasteBuffer
2966 @itemx Polygon
2967 @itemx Rectangle
2968 @itemx Remove
2969 @itemx Rotate
2970 @itemx Text
2971 @itemx Thermal
2972 @itemx Via
2973 Select the indicated tool.
2975 @item Notify
2976 Called when you press the mouse button, or move the mouse.
2978 @item Release
2979 Called when you release the mouse button.
2981 @item Cancel
2982 Cancels any pending tool activity, allowing you to restart elsewhere.
2983 For example, this allows you to start a new line rather than attach a
2984 line to the previous line.
2986 @item Escape
2987 Similar to Cancel but calling this action a second time will return
2988 to the Arrow tool.
2990 @item Stroke
2991 If your @code{pcb} was built with libstroke, this invokes the stroke
2992 input method. If not, this will restart a drawing mode if you were
2993 drawing, else it will select objects.
2995 @item Save
2996 Remembers the current tool.
2998 @item Restore
2999 Restores the tool to the last saved tool.
3001 @end table
3003 %end-doc */
3005 static int
3007 {
3011 {
3016 {
3042 {
3046 }
3049 {
3051 {
3070 else
3071 {
3074 }
3080 else
3081 {
3084 }
3090 else
3091 {
3094 }
3100 else
3101 {
3104 }
3110 else
3111 {
3114 }
3122 }
3123 }
3138 #ifndef HAVE_LIBSTROKE
3142 #else
3146 else
3149 #endif
3160 #ifdef HAVE_LIBSTROKE
3165 #else
3166 /* Handle middle mouse button restarts of drawing mode. If not in
3167 | a drawing mode, middle mouse button will select objects.
3168 */
3171 {
3173 }
3183 else
3184 {
3189 }
3191 #endif
3209 }
3212 }
3215 }
3217 /* --------------------------------------------------------------------------- */
3223 /* %start-doc actions RemoveSelected
3225 %end-doc */
3227 static int
3229 {
3233 }
3235 /* --------------------------------------------------------------------------- */
3244 /* %start-doc actions Renumber
3246 %end-doc */
3248 static int
3250 {
3262 struct _cnt_list
3263 {
3273 {
3274 /*
3275 * We deal with the case where name already exists in this
3276 * function so the GUI doesn't need to deal with it
3277 */
3286 }
3287 else
3291 {
3294 }
3297 {
3299 }
3302 {
3305 {
3309 }
3310 }
3313 {
3318 }
3326 /*
3327 * Make a first pass through all of the elements and sort them out
3328 * by location on the board. While here we also collect a list of
3329 * locked elements.
3330 *
3331 * We'll actually renumber things in the 2nd pass.
3332 */
3339 {
3342 }
3348 {
3350 {
3351 /*
3352 * add to the list of locked elements which we won't try to
3353 * renumber and whose reference designators are now reserved.
3354 */
3359 lock_cnt++;
3360 }
3362 else
3363 {
3364 /* count of devices which will be renumbered */
3365 cnt++;
3367 /* search for correct position in the list */
3370 i++;
3372 /*
3373 * We have found the position where we have the first element that
3374 * has the same Y value or a lower Y value. Now move forward if
3375 * needed through the X values
3376 */
3380 i++;
3383 {
3385 }
3387 }
3388 }
3389 END_LOOP;
3392 /*
3393 * Now that the elements are sorted by board position, we go through
3394 * and renumber them.
3395 */
3397 /*
3398 * turn off the flag which requires unique names so it doesn't get
3399 * in our way. When we're done with the renumber we will have unique
3400 * names.
3401 */
3407 {
3408 /* If there is no refdes, maybe just spit out a warning */
3410 {
3411 /* figure out the prefix */
3416 j++;
3419 /* check the counter for this prefix */
3424 /* grow the list if needed */
3426 {
3430 {
3433 }
3434 /* zero out the memory that we added */
3436 {
3439 }
3440 }
3442 /*
3443 * start a new counter if we don't have a counter for this
3444 * prefix
3445 */
3447 {
3450 }
3452 /*
3453 * check to see if the new refdes is already used by a
3454 * locked element
3455 */
3456 do
3457 {
3462 /* space for the prefix plus 1 digit plus the '\0' */
3465 /* and 1 more per extra digit needed to hold the number */
3468 {
3469 sz++;
3471 }
3475 /*
3476 * now compare to the list of reserved (by locked
3477 * elements) names
3478 */
3480 {
3484 {
3487 }
3488 }
3490 }
3494 {
3498 /* add this rename to our table of renames so we can update the netlist */
3501 c_cnt++;
3509 tmps);
3512 /* we don't free tmps in this case because it is used */
3513 }
3514 else
3516 }
3517 else
3518 {
3521 }
3523 }
3527 /* restore the unique flag setting */
3532 {
3534 /* update the netlist */
3537 /* iterate over each net */
3539 {
3541 /* iterate over each pin on the net */
3543 {
3545 /* figure out the pin number part from strings like U3-21 */
3551 /* iterate over the list of changed reference designators */
3553 {
3554 /*
3555 * if the pin needs to change, change it and quit
3556 * searching in the list.
3557 */
3559 {
3567 }
3569 }
3571 }
3572 }
3574 {
3577 }
3582 }
3588 }
3591 /* --------------------------------------------------------------------------- */
3598 /* %start-doc actions RipUp
3600 @table @code
3602 @item All
3603 Removes all lines and vias which were created by the autorouter.
3605 @item Selected
3606 Removes all selected lines and vias which were created by the
3607 autorouter.
3609 @item Element
3610 Converts the element under the cursor to parts (vias and lines). Note
3611 that this uses the highest numbered paste buffer.
3613 @end table
3615 %end-doc */
3617 static int
3619 {
3624 {
3626 {
3629 {
3631 {
3634 }
3635 }
3636 ENDALL_LOOP;
3638 {
3640 {
3643 }
3644 }
3645 ENDALL_LOOP;
3647 {
3649 {
3652 }
3653 }
3654 END_LOOP;
3657 {
3660 }
3664 {
3667 {
3670 }
3671 }
3672 ENDALL_LOOP;
3675 {
3678 {
3681 }
3682 }
3683 END_LOOP;
3685 {
3688 }
3691 {
3696 {
3712 }
3713 }
3715 }
3716 }
3718 }
3720 /* --------------------------------------------------------------------------- */
3726 /* %start-doc actions AddRats
3728 @table @code
3730 @item AllRats
3731 Create rat lines for all loaded nets that aren't already connected on
3732 with copper.
3734 @item SelectedRats
3735 Similarly, but only add rat lines for nets connected to selected pins
3736 and pads.
3738 @item Close
3739 Selects the shortest unselected rat on the board.
3741 @end table
3743 %end-doc */
3745 static int
3747 {
3753 {
3757 {
3771 {
3777 {
3780 }
3781 }
3782 END_LOOP;
3784 {
3791 }
3793 }
3794 }
3796 }
3798 /* --------------------------------------------------------------------------- */
3806 /* %start-doc actions Delete
3808 %end-doc */
3810 static int
3812 {
3820 {
3823 }
3826 {
3844 }
3847 }
3849 /* --------------------------------------------------------------------------- */
3856 /* %start-doc actions DeleteRats
3858 %end-doc */
3860 static int
3862 {
3865 {
3869 {
3879 }
3880 }
3882 }
3884 /* --------------------------------------------------------------------------- */
3890 /* %start-doc actions AutoPlaceSelected
3892 Attempts to re-arrange the selected components such that the nets
3893 connecting them are minimized. Note that you cannot undo this.
3895 %end-doc */
3897 static int
3899 {
3903 {
3906 }
3908 }
3910 /* --------------------------------------------------------------------------- */
3916 /* %start-doc actions AutoRoute
3918 @table @code
3920 @item AllRats
3921 Attempt to autoroute all rats.
3923 @item SelectedRats
3924 Attempt to autoroute the selected rats.
3926 @end table
3928 Before autorouting, it's important to set up a few things. First,
3929 make sure any layers you aren't using are disabled, else the
3930 autorouter may use them. Next, make sure the current line and via
3931 styles are set accordingly. Last, make sure "new lines clear
3932 polygons" is set, in case you eventually want to add a copper pour.
3934 Autorouting takes a while. During this time, the program may not be
3935 responsive.
3937 %end-doc */
3939 static int
3941 {
3945 {
3947 {
3957 }
3958 }
3960 }
3962 /* --------------------------------------------------------------------------- */
3970 /* %start-doc actions MarkCrosshair
3972 The ``mark'' is a small X-shaped target on the display which is
3973 treated like a second origin (the normal origin is the upper let
3974 corner of the board). The GUI will display a second set of
3975 coordinates for this mark, which tells you how far you are from it.
3977 If no argument is given, the mark is toggled - disabled if it was
3978 enabled, or enabled at the current cursor position of disabled. If
3979 the @code{Center} argument is given, the mark is moved to the current
3980 cursor location.
3982 %end-doc */
3984 static int
3986 {
3989 {
3991 {
3995 }
3996 else
3997 {
4004 }
4005 }
4007 {
4013 }
4015 }
4017 /* --------------------------------------------------------------------------- */
4028 /* %start-doc actions ChangeSize
4030 For lines and arcs, this changes the width. For pins and vias, this
4031 changes the overall diameter of the copper annulus. For pads, this
4032 changes the width and, indirectly, the length. For texts and names,
4033 this changes the scaling factor. For elements, this changes the width
4034 of the silk layer lines and arcs for this element.
4036 %end-doc */
4038 static int
4040 {
4045 Coord value;
4048 {
4054 {
4056 {
4068 }
4115 }
4116 }
4118 }
4120 /* --------------------------------------------------------------------------- */
4129 /* %start-doc actions ChangeDrillSize
4131 %end-doc */
4133 static int
4135 {
4140 Coord value;
4143 {
4146 {
4148 {
4160 }
4176 }
4177 }
4179 }
4181 /* --------------------------------------------------------------------------- */
4192 /* %start-doc actions ChangeClearSize
4194 If the solder mask is currently showing, this action changes the
4195 solder mask clearance. If the mask is not showing, this action
4196 changes the polygon clearance.
4198 %end-doc */
4200 static int
4202 {
4207 Coord value;
4210 {
4216 {
4218 {
4230 }
4256 }
4257 }
4259 }
4261 /* --------------------------------------------------------------------------- */
4270 /* %start-doc actions MinMaskGap
4272 Checks all specified pins and/or pads, and increases the mask if
4273 needed to ensure a minimum distance between the pin or pad edge and
4274 the mask edge.
4276 %end-doc */
4278 static int
4280 {
4285 Coord value;
4292 else
4293 {
4297 }
4302 {
4304 {
4308 {
4312 }
4313 }
4314 END_LOOP;
4316 {
4320 {
4324 }
4325 }
4326 END_LOOP;
4327 }
4328 END_LOOP;
4330 {
4334 {
4337 }
4338 }
4339 END_LOOP;
4343 }
4345 /* --------------------------------------------------------------------------- */
4354 /* %start-doc actions MinClearGap
4356 Checks all specified objects, and increases the polygon clearance if
4357 needed to ensure a minimum distance between their edges and the
4358 polygon edges.
4360 %end-doc */
4362 static int
4364 {
4369 Coord value;
4376 else
4377 {
4381 }
4386 {
4388 {
4392 {
4396 }
4397 }
4398 END_LOOP;
4400 {
4404 {
4408 }
4409 }
4410 END_LOOP;
4411 }
4412 END_LOOP;
4414 {
4418 {
4421 }
4422 }
4423 END_LOOP;
4425 {
4429 {
4432 }
4433 }
4434 ENDALL_LOOP;
4436 {
4440 {
4443 }
4444 }
4445 ENDALL_LOOP;
4449 }
4451 /* --------------------------------------------------------------------------- */
4459 /* %start-doc actions ChangePinName
4461 This can be especially useful for annotating pin names from a
4462 schematic to the layout without requiring knowledge of the pcb file
4463 format.
4465 @example
4466 ChangePinName(U3, 7, VCC)
4467 @end example
4469 %end-doc */
4471 static int
4473 {
4478 {
4480 }
4487 {
4489 {
4491 {
4493 {
4496 /*
4497 * Note: we can't free() pin->Name first because
4498 * it is used in the undo list
4499 */
4503 }
4504 }
4505 END_LOOP;
4508 {
4510 {
4513 /*
4514 * Note: we can't free() pad->Name first because
4515 * it is used in the undo list
4516 */
4520 }
4521 }
4522 END_LOOP;
4523 }
4524 }
4525 END_LOOP;
4526 /*
4527 * done with our action so increment the undo # if we actually
4528 * changed anything
4529 */
4531 {
4534 else
4535 {
4538 }
4539 }
4542 }
4544 /* --------------------------------------------------------------------------- */
4552 /* %start-doc actions ChangeName
4554 @table @code
4556 @item Object
4557 Changes the name of the element under the cursor.
4559 @item Layout
4560 Changes the name of the layout. This is printed on the fab drawings.
4562 @item Layer
4563 Changes the name of the currently active layer.
4565 @end table
4567 %end-doc */
4569 int
4571 {
4576 {
4578 {
4579 /* change the name of an object */
4581 {
4589 {
4592 {
4595 {
4605 {
4611 }
4614 }
4615 }
4616 }
4618 }
4620 /* change the layout's name */
4622 name =
4624 /* NB: ChangeLayoutName takes ownership of the passed memory */
4629 /* change the name of the active layer */
4633 /* NB: ChangeLayerName takes ownership of the passed memory */
4637 }
4638 }
4640 }
4643 /* --------------------------------------------------------------------------- */
4650 /* %start-doc actions MorphPolygon
4652 If a polygon is divided into unconnected "islands", you can use
4653 this command to convert the otherwise disappeared islands into
4654 separate polygons. Be sure the cursor is over a portion of the
4655 polygon that remains visible. Very small islands that may flake
4656 off are automatically deleted.
4658 %end-doc */
4660 static int
4662 {
4665 {
4667 {
4669 {
4676 {
4680 }
4682 }
4686 {
4689 }
4690 ENDALL_LOOP;
4694 }
4695 }
4697 }
4699 /* --------------------------------------------------------------------------- */
4707 /* %start-doc actions ToggleHideName
4709 If names are hidden you won't see them on the screen and they will not
4710 appear on the silk layer when you print the layout.
4712 %end-doc */
4714 static int
4716 {
4719 {
4721 {
4723 {
4730 {
4737 }
4739 }
4742 {
4745 {
4750 {
4757 }
4758 }
4759 END_LOOP;
4761 {
4764 }
4765 }
4766 }
4767 }
4769 }
4771 /* --------------------------------------------------------------------------- */
4779 /* %start-doc actions ChangeJoin
4781 The join flag determines whether a line or arc, drawn to intersect a
4782 polygon, electrically connects to the polygon or not. When joined,
4783 the line/arc is simply drawn over the polygon, making an electrical
4784 connection. When not joined, a gap is drawn between the line and the
4785 polygon, insulating them from each other.
4787 %end-doc */
4789 static int
4791 {
4794 {
4796 {
4799 {
4810 }
4827 }
4828 }
4830 }
4832 /* --------------------------------------------------------------------------- */
4842 /* %start-doc actions ChangeSquare
4844 Note that @code{Pins} means both pins and pads.
4846 @pinshapes
4848 %end-doc */
4850 static int
4852 {
4855 {
4857 {
4860 {
4871 }
4888 }
4889 }
4891 }
4893 /* --------------------------------------------------------------------------- */
4900 /* %start-doc actions SetSquare
4902 Note that @code{Pins} means pins and pads.
4904 @pinshapes
4906 %end-doc */
4908 static int
4910 {
4913 {
4915 {
4918 {
4929 }
4946 }
4947 }
4949 }
4951 /* --------------------------------------------------------------------------- */
4959 /* %start-doc actions ClearSquare
4961 Note that @code{Pins} means pins and pads.
4963 @pinshapes
4965 %end-doc */
4967 static int
4969 {
4972 {
4974 {
4977 {
4988 }
5005 }
5006 }
5008 }
5010 /* --------------------------------------------------------------------------- */
5019 /* %start-doc actions ChangeOctagon
5021 @pinshapes
5023 %end-doc */
5025 static int
5027 {
5030 {
5032 {
5035 {
5046 }
5068 }
5069 }
5071 }
5073 /* --------------------------------------------------------------------------- */
5080 /* %start-doc actions SetOctagon
5082 @pinshapes
5084 %end-doc */
5086 static int
5088 {
5091 {
5093 {
5096 {
5107 }
5129 }
5130 }
5132 }
5134 /* --------------------------------------------------------------------------- */
5143 /* %start-doc actions ClearOctagon
5145 @pinshapes
5147 %end-doc */
5149 static int
5151 {
5154 {
5156 {
5159 {
5170 }
5192 }
5193 }
5195 }
5197 /* --------------------------------------------------------------------------- */
5204 /* %start-doc actions ChangeHole
5206 The "hole flag" of a via determines whether the via is a
5207 plated-through hole (not set), or an unplated hole (set).
5209 %end-doc */
5211 static int
5213 {
5216 {
5218 {
5221 {
5231 }
5238 }
5239 }
5241 }
5243 /* --------------------------------------------------------------------------- */
5250 /* %start-doc actions ChangePaste
5252 The "no paste flag" of a pad determines whether the solderpaste
5253 stencil will have an opening for the pad (no set) or if there wil be
5254 no solderpaste on the pad (set). This is used for things such as
5255 fiducial pads.
5257 %end-doc */
5259 static int
5261 {
5264 {
5266 {
5269 {
5279 }
5286 }
5287 }
5289 }
5291 /* --------------------------------------------------------------------------- */
5304 /* %start-doc actions Select
5306 @table @code
5308 @item ElementByName
5309 @item ObjectByName
5310 @item PadByName
5311 @item PinByName
5312 @item TextByName
5313 @item ViaByName
5314 @item NetByName
5316 These all rely on having a regular expression parser built into
5317 @code{pcb}. If the name is not specified then the user is prompted
5318 for a pattern, and all objects that match the pattern and are of the
5319 type specified are selected.
5321 @item Object
5322 @item ToggleObject
5323 Selects the object under the cursor.
5325 @item Block
5326 Selects all objects in a rectangle indicated by the cursor.
5328 @item All
5329 Selects all objects on the board.
5331 @item Found
5332 Selects all connections with the ``found'' flag set.
5334 @item Connection
5335 Selects all connections with the ``connected'' flag set.
5337 @item Convert
5338 Converts the selected objects to an element. This uses the highest
5339 numbered paste buffer.
5341 @end table
5343 %end-doc */
5345 static int
5347 {
5350 {
5352 {
5353 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5355 /* select objects by their names */
5378 commonByName:
5379 {
5385 {
5390 }
5392 }
5395 /* select a single object */
5402 /* all objects in block */
5404 {
5405 BoxType box;
5419 {
5422 }
5425 }
5427 /* select all visible objects */
5429 {
5430 BoxType box;
5439 }
5441 /* all logical connections */
5444 {
5448 }
5451 /* all physical connections */
5454 {
5458 }
5462 {
5477 }
5483 }
5484 }
5486 }
5488 /* FLAG(have_regex,FlagHaveRegex,0) */
5489 int
5491 {
5492 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5494 #else
5496 #endif
5497 }
5499 /* --------------------------------------------------------------------------- */
5511 /* %start-doc actions Unselect
5513 @table @code
5515 @item All
5516 Unselect all objects.
5518 @item Block
5519 Unselect all objects in a rectangle given by the cursor.
5521 @item Connection
5522 Unselect all connections with the ``found'' flag set.
5524 @item ElementByName
5525 @item ObjectByName
5526 @item PadByName
5527 @item PinByName
5528 @item TextByName
5529 @item ViaByName
5531 These all rely on having a regular expression parser built into
5532 @code{pcb}. If the name is not specified then the user is prompted
5533 for a pattern, and all objects that match the pattern and are of the
5534 type specified are unselected.
5537 @end table
5539 %end-doc */
5541 static int
5543 {
5546 {
5548 {
5549 #if defined(HAVE_REGCOMP) || defined(HAVE_RE_COMP)
5551 /* select objects by their names */
5574 commonByName:
5575 {
5581 {
5586 }
5588 }
5591 /* all objects in block */
5593 {
5594 BoxType box;
5608 {
5611 }
5614 }
5616 /* unselect all visible objects */
5618 {
5619 BoxType box;
5628 }
5630 /* all logical connections */
5633 {
5637 }
5640 /* all physical connections */
5643 {
5647 }
5654 }
5655 }
5657 }
5659 /* --------------------------------------------------------------------------- */
5668 /* %start-doc actions SaveTo
5670 @table @code
5672 @item Layout
5673 Saves the current layout.
5675 @item LayoutAs
5676 Saves the current layout, and remembers the filename used.
5678 @item AllConnections
5679 Save all connections to a file.
5681 @item AllUnusedPins
5682 List all unused pins to a file.
5684 @item ElementConnections
5685 Save connections to the element at the cursor to a file.
5687 @item PasteBuffer
5688 Save the content of the active Buffer to a file. This is the graphical way to create a footprint.
5690 @end table
5692 %end-doc */
5694 static int
5696 {
5704 {
5708 }
5714 {
5716 {
5722 }
5724 }
5727 {
5731 {
5735 }
5737 }
5740 {
5744 {
5748 }
5750 }
5753 {
5761 {
5765 {
5769 }
5770 }
5772 }
5775 {
5777 }
5780 }
5782 /* --------------------------------------------------------------------------- */
5790 /* %start-doc actions SaveSettings
5792 If you pass no arguments, the settings are stored in
5793 @code{$HOME/.pcb/settings}. If you pass the word @code{local} they're
5794 saved in @code{./pcb.settings}.
5796 %end-doc */
5798 static int
5800 {
5804 }
5806 /* --------------------------------------------------------------------------- */
5813 /* %start-doc actions LoadFrom
5815 This action assumes you know what the filename is. The various GUIs
5816 should have a similar @code{Load} action where the filename is
5817 optional, and will provide their own file selection mechanism to let
5818 you choose the file name.
5820 @table @code
5822 @item Layout
5823 Loads an entire PCB layout, replacing the current one.
5825 @item LayoutToBuffer
5826 Loads an entire PCB layout to the paste buffer.
5828 @item ElementToBuffer
5829 Loads the given element file into the paste buffer. Element files
5830 contain only a single @code{Element} definition, such as the
5831 ``newlib'' library uses.
5833 @item Netlist
5834 Loads a new netlist, replacing any current netlist.
5836 @item Revert
5837 Re-loads the current layout from its disk file, reverting any changes
5838 you may have made.
5840 @end table
5842 %end-doc */
5844 static int
5846 {
5857 {
5862 }
5865 {
5870 }
5873 {
5877 }
5880 {
5887 }
5891 {
5893 }
5896 }
5898 /* --------------------------------------------------------------------------- */
5904 /* %start-doc actions New
5906 If a name is not given, one is prompted for.
5908 %end-doc */
5910 static int
5912 {
5916 {
5919 else
5926 /* do emergency saving
5927 * clear the old struct and allocate memory for the new one
5928 */
5937 /* setup the new name and reset some values to default */
5949 }
5951 }
5953 /* ---------------------------------------------------------------------------
5954 * no operation, just for testing purposes
5955 * syntax: Bell(volume)
5956 */
5957 void
5959 {
5961 }
5963 /* --------------------------------------------------------------------------- */
5974 /* %start-doc actions PasteBuffer
5976 There are a number of paste buffers; the actual limit is a
5977 compile-time constant @code{MAX_BUFFER} in @file{globalconst.h}. It
5978 is currently @code{5}. One of these is the ``current'' paste buffer,
5979 often referred to as ``the'' paste buffer.
5981 @table @code
5983 @item AddSelected
5984 Copies the selected objects to the current paste buffer.
5986 @item Clear
5987 Remove all objects from the current paste buffer.
5989 @item Convert
5990 Convert the current paste buffer to an element. Vias are converted to
5991 pins, lines are converted to pads.
5993 @item Restore
5994 Convert any elements in the paste buffer back to vias and lines.
5996 @item Mirror
5997 Flip all objects in the paste buffer vertically (up/down flip). To mirror
5998 horizontally, combine this with rotations.
6000 @item Rotate
6001 Rotates the current buffer. The number to pass is 1..3, where 1 means
6002 90 degrees counter clockwise, 2 means 180 degrees, and 3 means 90
6003 degrees clockwise (270 CCW).
6005 @item Save
6006 Saves any elements in the current buffer to the indicated file.
6008 @item ToLayout
6009 Pastes any elements in the current buffer to the indicated X, Y
6010 coordinates in the layout. The @code{X} and @code{Y} are treated like
6011 @code{delta} is for many other objects. For each, if it's prefixed by
6012 @code{+} or @code{-}, then that amount is relative to the last
6013 location. Otherwise, it's absolute. Units can be
6014 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6015 units, currently 1/100 mil.
6018 @item 1..MAX_BUFFER
6019 Selects the given buffer to be the current paste buffer.
6021 @end table
6023 %end-doc */
6025 static int
6027 {
6036 {
6038 {
6039 /* clear contents of paste buffer */
6044 /* copies objects to paste buffer */
6049 /* converts buffer contents into an element */
6054 /* break up element for editing */
6059 /* Mirror buffer */
6066 {
6069 }
6074 {
6077 }
6080 {
6088 {
6091 }
6093 {
6095 }
6097 }
6099 else
6102 {
6106 {
6111 }
6112 else
6117 }
6121 {
6127 {
6129 }
6131 {
6138 }
6139 else
6140 {
6143 }
6149 }
6152 /* set number */
6154 {
6157 /* correct number */
6160 }
6161 }
6162 }
6166 }
6168 /* --------------------------------------------------------------------------- */
6175 /* %start-doc actions Undo
6177 The unlimited undo feature of @code{Pcb} allows you to recover from
6178 most operations that materially affect you work. Calling
6179 @code{Undo()} without any parameter recovers from the last (non-undo)
6180 operation. @code{ClearList} is used to release the allocated
6181 memory. @code{ClearList} is called whenever a new layout is started or
6182 loaded. See also @code{Redo} and @code{Atomic}.
6184 Note that undo groups operations by serial number; changes with the
6185 same serial number will be undone (or redone) as a group. See
6186 @code{Atomic}.
6188 %end-doc */
6190 static int
6192 {
6195 {
6196 /* don't allow undo in the middle of an operation */
6203 /* undo the last operation */
6209 {
6213 }
6214 /* move anchor point if undoing during line creation */
6216 {
6218 {
6225 }
6227 {
6231 /* this search is guaranteed to succeed */
6238 /* save both ends of line */
6243 /* check that the undo was of the right type */
6245 {
6246 /* wrong undo type, restore anchor points */
6253 }
6254 /* move to new anchor */
6259 /* check if an intermediate point was removed */
6261 {
6262 /* this search should find the restored line */
6270 {
6271 /* undo loses CONNECTEDFLAG and FOUNDFLAG */
6275 }
6280 }
6284 {
6287 }
6288 else
6289 {
6290 /* this search is guaranteed to succeed too */
6298 }
6301 }
6302 }
6304 {
6306 {
6310 }
6312 {
6315 /* guaranteed to succeed */
6327 }
6328 }
6329 /* undo the last destructive operation */
6332 }
6334 {
6336 {
6337 /* clear 'undo objects' list */
6341 }
6342 }
6345 }
6347 /* --------------------------------------------------------------------------- */
6353 /* %start-doc actions Redo
6355 This routine allows you to recover from the last undo command. You
6356 might want to do this if you thought that undo was going to revert
6357 something other than what it actually did (in case you are confused
6358 about which operations are un-doable), or if you have been backing up
6359 through a long undo list and over-shoot your stopping point. Any
6360 change that is made since the undo in question will trim the redo
6361 list. For example if you add ten lines, then undo three of them you
6362 could use redo to put them back, but if you move a line on the board
6363 before performing the redo, you will lose the ability to "redo" the
6364 three "undone" lines.
6366 %end-doc */
6368 static int
6370 {
6378 {
6382 {
6388 addedLines++;
6389 }
6390 }
6393 }
6395 /* --------------------------------------------------------------------------- */
6401 /* %start-doc actions Polygon
6403 Polygons need a special action routine to make life easier.
6405 @table @code
6407 @item Close
6408 Creates the final segment of the polygon. This may fail if clipping
6409 to 45 degree lines is switched on, in which case a warning is issued.
6411 @item PreviousPoint
6412 Resets the newly entered corner to the previous one. The Undo action
6413 will call Polygon(PreviousPoint) when appropriate to do so.
6415 @end table
6417 %end-doc */
6419 static int
6421 {
6424 {
6427 {
6428 /* close open polygon if possible */
6433 /* go back to the previous point */
6437 }
6439 }
6441 }
6443 /* --------------------------------------------------------------------------- */
6450 /* %start-doc actions RouteStyle
6452 %end-doc */
6454 static int
6456 {
6462 {
6465 {
6472 }
6473 }
6475 }
6478 /* --------------------------------------------------------------------------- */
6484 /* %start-doc actions MoveObject
6486 The @code{X} and @code{Y} are treated like @code{delta} is for many
6487 other objects. For each, if it's prefixed by @code{+} or @code{-},
6488 then that amount is relative. Otherwise, it's absolute. Units can be
6489 @code{mil} or @code{mm}; if unspecified, units are PCB's internal
6490 units, currently 1/100 mil.
6492 %end-doc */
6494 static int
6496 {
6510 {
6513 }
6526 }
6528 /* --------------------------------------------------------------------------- */
6536 /* %start-doc actions MoveToCurrentLayer
6538 Note that moving an element from a component layer to a solder layer,
6539 or from solder to component, won't automatically flip it. Use the
6540 @code{Flip()} action to do that.
6542 %end-doc */
6544 static int
6546 {
6549 {
6551 {
6553 {
6564 }
6571 }
6572 }
6574 }
6582 /* %start-doc actions SetSame
6584 When invoked over any line, arc, polygon, or via, this changes the
6585 current layer to be the layer that item is on, and changes the current
6586 sizes (thickness, keepaway, drill, etc) according to that item.
6588 %end-doc */
6590 static int
6592 {
6598 /* set layer current and size from line or arc */
6600 {
6640 }
6642 {
6645 }
6647 }
6650 /* --------------------------------------------------------------------------- */
6661 /* %start-doc actions SetFlag
6663 Turns the given flag on, regardless of its previous setting. See
6664 @code{ChangeFlag}.
6666 @example
6667 SetFlag(SelectedPins,thermal)
6668 @end example
6670 %end-doc */
6672 static int
6674 {
6679 }
6681 /* --------------------------------------------------------------------------- */
6692 /* %start-doc actions ClrFlag
6694 Turns the given flag off, regardless of its previous setting. See
6695 @code{ChangeFlag}.
6697 @example
6698 ClrFlag(SelectedLines,join)
6699 @end example
6701 %end-doc */
6703 static int
6705 {
6710 }
6712 /* --------------------------------------------------------------------------- */
6724 /* %start-doc actions ChangeFlag
6726 Toggles the given flag on the indicated object(s). The flag may be
6727 one of the flags listed above (square, octagon, thermal, join). The
6728 value may be the number 0 or 1. If the value is 0, the flag is
6729 cleared. If the value is 1, the flag is set.
6731 %end-doc */
6733 static int
6735 {
6744 }
6747 static void
6749 {
6754 {
6757 }
6759 {
6762 }
6764 {
6765 /* Note: these are backwards, because the flag is "clear" but
6766 the command is "join". */
6769 }
6770 else
6771 {
6774 }
6777 {
6779 {
6791 }
6833 }
6834 }
6836 /* --------------------------------------------------------------------------- */
6842 /* %start-doc actions ExecuteFile
6844 Lines starting with @code{#} are ignored.
6846 %end-doc */
6848 static int
6850 {
6863 {
6866 }
6871 {
6872 n++;
6875 /* eat the trailing newline */
6877 sp++;
6880 /* eat leading spaces and tabs */
6883 sp++;
6885 /*
6886 * if we have anything left and its not a comment line
6887 * then execute it
6888 */
6891 {
6892 /*Message ("%s : line %-3d : \"%s\"\n", fname, n, sp);*/
6894 }
6895 }
6899 {
6902 }
6905 }
6907 /* --------------------------------------------------------------------------- */
6909 static int
6911 {
6915 }
6917 /* --------------------------------------------------------------------------- */
6923 {
6930 {
6933 {
6936 }
6937 }
6938 END_LOOP;
6940 }
6944 {
6950 }
6952 static void
6954 {
6961 }
6963 /* ---------------------------------------------------------------- */
6964 static const char elementlist_syntax[] = "ElementList(Start|Done|Need,<refdes>,<footprint>,<value>)";
6968 /* %start-doc actions elementlist
6970 @table @code
6972 @item Start
6973 Indicates the start of an element list; call this before any Need
6974 actions.
6976 @item Need
6977 Searches the board for an element with a matching refdes.
6979 If found, the value and footprint are updated.
6981 If not found, a new element is created with the given footprint and value.
6983 @item Done
6984 Compares the list of elements needed since the most recent
6985 @code{start} with the list of elements actually on the board. Any
6986 elements that weren't listed are selected, so that the user may delete
6987 them.
6989 @end table
6991 %end-doc */
6995 static int
6997 {
7002 }
7004 static int
7006 {
7012 #ifdef DEBUG
7014 #endif
7017 {
7019 {
7021 }
7022 END_LOOP;
7026 }
7029 {
7031 {
7033 {
7035 }
7037 {
7038 /* Unnamed elements should remain untouched */
7040 }
7041 }
7042 END_LOOP;
7048 }
7056 argc --;
7057 argv ++;
7067 #ifdef DEBUG
7071 #endif
7076 {
7079 #ifdef DEBUG
7081 #endif
7082 /* Not on board, need to add it. */
7084 {
7085 number_of_footprints_not_found ++;
7087 }
7098 {
7101 }
7112 /* Place components onto center of board. */
7115 }
7118 {
7119 #ifdef DEBUG
7121 #endif
7126 /* Different footprint, we need to swap them out. */
7128 {
7129 number_of_footprints_not_found ++;
7131 }
7146 {
7151 }
7157 }
7159 /* Now reload footprint */
7172 #ifdef DEBUG
7174 #endif
7177 }
7179 /* ---------------------------------------------------------------- */
7184 /* %start-doc actions elementsetattr
7186 If a value is specified, the named attribute is added (if not already
7187 present) or changed (if it is) to the given value. If the value is
7188 not specified, the given attribute is removed if present.
7190 %end-doc */
7192 static int
7194 {
7200 {
7202 }
7209 {
7211 {
7214 }
7215 }
7216 END_LOOP;
7219 {
7222 }
7227 {
7230 }
7232 {
7234 }
7236 {
7238 }
7241 }
7243 /* ---------------------------------------------------------------- */
7248 /* %start-doc actions execcommand
7250 Runs the given command, which is a system executable.
7252 %end-doc */
7254 static int
7256 {
7260 {
7262 }
7269 }
7271 /* ---------------------------------------------------------------- */
7273 static int
7275 {
7276 #ifdef HAVE__SPAWNVP
7280 else
7282 #else
7286 {
7287 /* error */
7290 }
7292 {
7293 /* Child */
7296 }
7297 else
7298 {
7300 /* Parent */
7302 }
7304 #endif
7305 }
7307 /* ---------------------------------------------------------------- */
7308 /*
7309 * Creates a new temporary file name. Hopefully the operating system
7310 * provides a mkdtemp() function to securily create a temporary
7311 * directory with mode 0700. If so then that directory is created and
7312 * the returned string is made up of the directory plus the name
7313 * variable. For example:
7314 *
7315 * tempfile_name_new ("myfile") might return
7316 * "/var/tmp/pcb.123456/myfile".
7317 *
7318 * If mkdtemp() is not available then 'name' is ignored and the
7319 * insecure tmpnam() function is used.
7320 *
7321 * Files/names created with tempfile_name_new() should be unlinked
7322 * with tempfile_unlink to make sure the temporary directory is also
7323 * removed when mkdtemp() is used.
7324 */
7327 {
7329 #ifdef HAVE_MKDTEMP
7332 #endif
7336 #ifdef HAVE_MKDTEMP
7342 /* FIXME -- what about win32? */
7345 }
7355 }
7365 }
7372 ;
7382 #undef TEMPLATE
7383 #else
7384 /*
7385 * tmpnam() uses a static buffer so strdup() the result right away
7386 * in case someone decides to create multiple temp names.
7387 */
7389 #ifdef __WIN32__
7390 {
7391 /* Guile doesn't like \ separators */
7396 }
7397 #endif
7398 #endif
7401 }
7403 /* ---------------------------------------------------------------- */
7404 /*
7405 * Unlink a temporary file. If we have mkdtemp() then our temp file
7406 * lives in a temporary directory and we need to remove that directory
7407 * too.
7408 */
7409 static int
7411 {
7412 #ifdef DEBUG
7413 /* SDB says: Want to keep old temp files for examiniation when debugging */
7415 #endif
7417 #ifdef HAVE_MKDTEMP
7422 /* it is possible that the file was never created so it is OK if the
7423 unlink fails */
7425 /* now figure out the directory name to remove */
7432 /*
7433 * at this point, e *should* point to the end of the directory part
7434 * but lets make sure.
7435 */
7440 }
7444 __FUNCTION__);
7448 }
7450 /* name was allocated with malloc */
7454 /*
7455 * FIXME - should also return -1 if the temp file exists and was not
7456 * removed.
7457 */
7460 }
7462 #else
7469 }
7472 #endif
7475 }
7477 /* ---------------------------------------------------------------- */
7486 /* %start-doc actions Import
7488 Imports element and netlist data from the schematics (or some other
7489 source). The first parameter, which is optional, is the mode. If not
7490 specified, the @code{import::mode} attribute in the PCB is used.
7491 @code{gnetlist} means gnetlist is used to obtain the information from
7492 the schematics. @code{make} invokes @code{make}, assuming the user
7493 has a @code{Makefile} in the current directory. The @code{Makefile}
7494 will be invoked with the following variables set:
7496 @table @code
7498 @item PCB
7499 The name of the .pcb file
7501 @item SRCLIST
7502 A space-separated list of source files
7504 @item OUT
7505 The name of the file in which to put the command script, which may
7506 contain any @pcb{} actions. By default, this is a temporary file
7507 selected by @pcb{}, but if you specify an @code{import::outfile}
7508 attribute, that file name is used instead (and not automatically
7509 deleted afterwards).
7511 @end table
7513 The target specified to be built is the first of these that apply:
7515 @itemize @bullet
7517 @item
7518 The target specified by an @code{import::target} attribute.
7520 @item
7521 The output file specified by an @code{import::outfile} attribute.
7523 @item
7524 If nothing else is specified, the target is @code{pcb_import}.
7526 @end itemize
7528 If you specify an @code{import::makefile} attribute, then "-f <that
7529 file>" will be added to the command line.
7531 If you specify the mode, you may also specify the source files
7532 (schematics). If you do not specify any, the list of schematics is
7533 obtained by reading the @code{import::src@var{N}} attributes (like
7534 @code{import::src0}, @code{import::src1}, etc).
7536 For compatibility with future extensions to the import file format,
7537 the generated file @emph{must not} start with the two characters
7538 @code{#%}.
7540 If a temporary file is needed the @code{TMPDIR} environment variable
7541 is used to select its location.
7543 Note that the programs @code{gnetlist} and @code{make} may be
7544 overridden by the user via the @code{make-program} and @code{gnetlist}
7545 @code{pcb} settings (i.e. in @code{~/.pcb/settings} or on the command
7546 line).
7548 If @pcb{} cannot determine which schematic(s) to import from, the GUI
7549 is called to let user choose (see @code{ImportGUI()}).
7551 Note that Import() doesn't delete anything - after an Import, elements
7552 which shouldn't be on the board are selected and may be removed once
7553 it's determined that the deletion is appropriate.
7555 If @code{Import()} is called with @code{setnewpoint}, then the location
7556 of new components can be specified. This is where parts show up when
7557 they're added to the board. The default is the center of the board.
7559 @table @code
7561 @item Import(setnewpoint)
7563 Prompts the user to click on the board somewhere, uses that point. If
7564 called by a hotkey, uses the current location of the crosshair.
7566 @item Import(setnewpoint,mark)
7568 Uses the location of the mark. If no mark is present, the point is
7569 not changed.
7571 @item Import(setnewpoint,center)
7573 Resets the point to the center of the board.
7575 @item Import(setnewpoint,X,Y,units)
7577 Sets the point to the specific coordinates given. Example:
7578 @code{Import(setnewpoint,50,25,mm)}
7580 @end table
7582 Note that the X and Y locations are stored in attributes named
7583 @code{import::newX} and @code{import::newY} so you could change them
7584 manually if you wished.
7586 Calling @code{Import(setdisperse,D,units)} sets how much the newly
7587 placed elements are dispersed relative to the set point. For example,
7588 @code{Import(setdisperse,10,mm)} will offset each part randomly up to
7589 10mm away from the point. The default dispersion is 1/10th of the
7590 smallest board dimension. Dispersion is saved in the
7591 @code{import::disperse} attribute.
7593 %end-doc */
7595 static int
7597 {
7602 #ifdef DEBUG
7604 #endif
7609 {
7616 {
7619 }
7621 {
7624 }
7625 else
7630 }
7633 {
7643 {
7645 }
7647 {
7651 }
7653 {
7659 }
7661 {
7664 }
7665 else
7666 {
7669 }
7676 }
7684 {
7687 }
7690 {
7696 nsources ++;
7702 {
7706 nsources ++;
7711 }
7712 }
7715 {
7716 /* Replace .pcb with .sch and hope for the best. */
7738 {
7741 }
7747 }
7750 {
7758 }
7771 #ifdef DEBUG
7775 #endif
7778 {
7781 }
7783 #ifdef DEBUG
7784 printf("ActionImport: =========== About to run ActionExecuteFile, file = %s ============\n", tmpfile);
7785 #endif
7793 }
7795 {
7815 else
7816 {
7821 }
7823 }
7831 {
7835 }
7844 {
7847 }
7852 {
7859 }
7870 }
7871 else
7872 {
7875 }
7880 #ifdef DEBUG
7882 #endif
7885 }
7887 /* ------------------------------------------------------------ */
7897 /* %start-doc actions Attributes
7899 This just pops up a dialog letting the user edit the attributes of the
7900 pcb, an element, or a layer.
7902 %end-doc */
7905 static int
7907 {
7916 {
7919 }
7922 {
7924 {
7927 }
7930 {
7933 {
7938 {
7941 }
7943 {
7946 }
7947 }
7953 }
7956 {
7960 {
7962 {
7964 n_found ++;
7965 }
7966 }
7967 END_LOOP;
7969 {
7972 }
7974 {
7981 else
7982 {
7985 }
7986 }
7989 {
7992 }
7993 else
7994 {
7996 }
8000 }
8004 }
8007 }
8009 /* --------------------------------------------------------------------------- */
8011 HID_Action action_action_list[] = {
8014 ,
8017 ,
8020 ,
8023 ,
8026 ,
8029 ,
8032 ,
8035 ,
8038 ,
8041 ,
8044 ,
8047 ,
8050 ,
8053 ,
8056 ,
8059 ,
8062 ,
8065 ,
8068 ,
8071 ,
8074 ,
8077 ,
8080 ,
8083 ,
8086 ,
8089 ,
8092 ,
8095 ,
8098 ,
8101 ,
8104 ,
8107 ,
8110 ,
8113 ,
8116 ,
8119 ,
8122 ,
8125 ,
8128 ,
8131 ,
8134 ,
8137 ,
8140 ,
8143 ,
8146 ,
8149 ,
8152 ,
8155 ,
8158 ,
8161 ,
8164 ,
8167 ,
8170 ,
8173 ,
8176 ,
8179 ,
8182 ,
8185 ,
8187 ,
8190 ,
8193 ,
8196 ,
8199 ,
8200 };