4 * PCB, interactive printed circuit board design
5 * Copyright (C) 1994,1995,1996 Thomas Nau
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Contact addresses for paper mail and Email:
22 * Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany
23 * Thomas.Nau@rz.uni-ulm.de
27 /* global source constants
36 #include "globalconst.h"
38 /* ---------------------------------------------------------------------------
39 * integer codings for the board sides.
45 /* ---------------------------------------------------------------------------
46 * the layer-numbers of the two additional special (silkscreen) layers
47 * 'bottom' and 'top'. The offset of MAX_LAYER is not added
49 #define BOTTOM_SILK_LAYER 0
50 #define TOP_SILK_LAYER 1
52 /* ---------------------------------------------------------------------------
55 #define MARK_SIZE MIL_TO_COORD(50) /* relative marker size */
56 #define UNDO_WARNING_SIZE (1024*1024) /* warning limit of undo */
57 #define USERMEDIANAME "user defined" /* label of default media */
59 /* ---------------------------------------------------------------------------
63 #define M_PI 3.14159265358979323846
66 #define M_SQRT1_2 0.707106781 /* 1/sqrt(2) */
68 #define M180 (M_PI/180.0)
69 #define RAD_TO_DEG (180.0/M_PI)
70 #define TAN_22_5_DEGREE_2 0.207106781 /* 0.5*tan(22.5) */
71 #define COS_22_5_DEGREE 0.923879533 /* cos(22.5) */
72 #define TAN_30_DEGREE 0.577350269 /* tan(30) */
73 #define TAN_60_DEGREE 1.732050808 /* tan(60) */
74 #define LN_2_OVER_2 0.346573590
76 /* PCB/physical unit conversions */
77 #define COORD_TO_MIL(n) ((n) / 25400.0)
78 #define MIL_TO_COORD(n) ((n) * 25400.0)
79 #define COORD_TO_MM(n) ((n) / 1000000.0)
80 #define MM_TO_COORD(n) ((n) * 1000000.0)
81 #define COORD_TO_INCH(n) (COORD_TO_MIL(n) / 1000.0)
82 #define INCH_TO_COORD(n) (MIL_TO_COORD(n) * 1000.0)
84 /* These need to be carefully written to avoid overflows, and return
86 #define SCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * ((double)(TEXTSCALE) / 100.0)))
87 #define UNSCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * (100.0 / (double)(TEXTSCALE))))
89 /* ---------------------------------------------------------------------------
92 #define NO_MODE 0 /* no mode selected */
93 #define VIA_MODE 1 /* draw vias */
94 #define LINE_MODE 2 /* draw lines */
95 #define RECTANGLE_MODE 3 /* create rectangles */
96 #define POLYGON_MODE 4 /* draw filled polygons */
97 #define PASTEBUFFER_MODE 5 /* paste objects from buffer */
98 #define TEXT_MODE 6 /* create text objects */
99 #define ROTATE_MODE 102 /* rotate objects */
100 #define REMOVE_MODE 103 /* remove objects */
101 #define MOVE_MODE 104 /* move objects */
102 #define COPY_MODE 105 /* copy objects */
103 #define INSERTPOINT_MODE 106 /* insert point into line/polygon */
104 #define RUBBERBANDMOVE_MODE 107 /* move objects and attached lines */
105 #define THERMAL_MODE 108 /* toggle thermal layer flag */
106 #define ARC_MODE 109 /* draw arcs */
107 #define ARROW_MODE 110 /* selection with arrow mode */
108 #define PAN_MODE 0 /* same as no mode */
109 #define LOCK_MODE 111 /* lock/unlock objects */
110 #define POLYGONHOLE_MODE 112 /* cut holes in filled polygons */
112 /* ---------------------------------------------------------------------------
116 /* %start-doc pcbfile ~objectflags
118 @section Object Flags
120 Note that object flags can be given numerically (like @code{0x0147})
121 or symbolically (like @code{"found,showname,square"}. Some numeric
122 values are reused for different object types. The table below lists
123 the numeric value followed by the symbolic name.
127 If set, this object is a pin. This flag is for internal use only.
131 If set, this object has been found by @code{FindConnection()}.
133 For pins and vias, this flag means that the pin or via is a hole
134 without a copper annulus.
136 For pads, set to prevent a solderpaste stencil opening for the
137 pad. Primarily used for pads used as fiducials.
139 If set for a line, indicates that this line is a rat line instead of a
141 @item 0x0010 pininpoly
142 For pins and pads, this flag is used internally to indicate that the
143 pin or pad overlaps a polygon on some layer.
144 @item 0x0010 clearpoly
145 For polygons, this flag means that pins and vias will normally clear
146 these polygons (thus, thermals are required for electrical
147 connection). When clear, polygons will solidly connect to pins and
149 @item 0x0010 hidename
150 For elements, when set the name of the element is hidden.
151 @item 0x0020 showname
152 For elements, when set the names of pins are shown.
153 @item 0x0020 clearline
154 For lines and arcs, the line/arc will clear polygons instead of
156 @item 0x0020 fullpoly
157 For polygons, the full polygon is drawn (i.e. all parts instead of only the biggest one).
158 @item 0x0040 selected
159 Set when the object is selected.
160 @item 0x0080 onsolder
161 For elements and pads, indicates that they are on the solder side.
163 For lines and vias, indicates that these were created by the
166 For pins and pads, indicates a square (vs round) pin/pad.
167 @item 0x0200 rubberend
168 For lines, used internally for rubber band moves.
170 For pins, vias, and pads, set to indicate a warning.
171 @item 0x0400 usetherm
172 Obsolete, indicates that pins/vias should be drawn with thermal
175 Obsolete, old files used this to indicate lines drawn on silk.
177 Draw pins and vias as octagons.
179 Set for objects that fail DRC.
181 Set for locked objects.
183 For pads, indicates that the second point is closer to the edge. For
184 pins, indicates that the pin is closer to a horizontal edge and thus
185 pinout text should be vertical.
187 Marker used internally to avoid revisiting an object.
188 @item 0x10000 connected
189 If set, this object has been as physically connected by @code{FindConnection()}.
193 #define NOFLAG 0x0000
194 #define PINFLAG 0x0001 /* is a pin */
195 #define VIAFLAG 0x0002 /* is a via */
196 #define FOUNDFLAG 0x0004 /* used by 'FindConnection()' */
197 #define HOLEFLAG 0x0008 /* pin or via is only a hole */
198 #define NOPASTEFLAG 0x0008 /* pad should not receive
199 solderpaste. This is to
201 #define RATFLAG 0x0010 /* indicates line is a rat line */
202 #define PININPOLYFLAG 0x0010 /* pin found inside poly - same as */
203 /* rat line since not used on lines */
204 #define CLEARPOLYFLAG 0x0010 /* pins/vias clear these polygons */
205 #define HIDENAMEFLAG 0x0010 /* hide the element name */
206 #define DISPLAYNAMEFLAG 0x0020 /* display the names of pins/pads */
208 #define CLEARLINEFLAG 0x0020 /* line doesn't touch polygons */
209 #define FULLPOLYFLAG 0x0020 /* full polygon is drawn (i.e. all parts instead of only the biggest one) */
210 #define SELECTEDFLAG 0x0040 /* object has been selected */
211 #define ONSOLDERFLAG 0x0080 /* element is on bottom side */
212 #define AUTOFLAG 0x0080 /* line/via created by auto-router */
213 #define SQUAREFLAG 0x0100 /* pin is square, not round */
214 #define RUBBERENDFLAG 0x0200 /* indicates one end already rubber */
215 /* banding same as warn flag */
216 /* since pins/pads won't use it */
217 #define WARNFLAG 0x0200 /* Warning for pin/via/pad */
218 #define USETHERMALFLAG 0x0400 /* draw pin, via with thermal fingers */
219 #define ONSILKFLAG 0x0400 /* old files use this to indicate silk */
220 #define OCTAGONFLAG 0x0800 /* draw pin/via as octagon instead of round */
221 #define DRCFLAG 0x1000 /* flag like FOUND flag for DRC checking */
222 #define LOCKFLAG 0x2000 /* object locked in place */
223 #define EDGE2FLAG 0x4000 /* Padr.Point2 is closer to outside edge */
224 /* also pinout text for pins is vertical */
225 #define VISITFLAG 0x8000 /* marker to avoid re-visiting an object */
226 #define CONNECTEDFLAG 0x10000 /* flag like FOUND flag, but used to identify physically connected objects (not rats) */
229 #define NOCOPY_FLAGS (FOUNDFLAG | CONNECTEDFLAG)
231 /* ---------------------------------------------------------------------------
235 /* %start-doc pcbfile ~pcbflags
240 Pinout displays pin numbers instead of pin names.
242 Use local reference for moves, by setting the mark at the beginning of
245 When set, only polygons and their clearances are drawn, to see if
246 polygons have isolated regions.
248 Display DRC region on crosshair.
250 Do all move, mirror, rotate with rubberband connections.
252 Display descriptions of elements, instead of refdes.
254 Display names of elements, instead of refdes.
256 Auto-DRC flag. When set, PCB doesn't let you place copper that
259 Enable 'all-direction' lines.
261 Switch starting angle after each click.
263 Force unique names on board.
265 New lines/arc clear polygons.
267 Crosshair snaps to pins and pads.
269 Show the solder mask layer.
271 Draw with thin lines.
273 Move items orthogonally.
275 Draw autoroute paths real-time.
277 New polygons are full ones.
279 Names are locked, the mouse cannot select them.
281 Everything but names are locked, the mouse cannot select anything else.
283 New polygons are full polygons.
285 When set, element names are not drawn.
289 #define PCB_FLAGS 0x000fffff /* all used flags */
291 #define SHOWNUMBERFLAG 0x00000001
292 #define LOCALREFFLAG 0x00000002
293 #define CHECKPLANESFLAG 0x00000004
294 #define SHOWDRCFLAG 0x00000008
295 #define RUBBERBANDFLAG 0x00000010
296 #define DESCRIPTIONFLAG 0x00000020
297 #define NAMEONPCBFLAG 0x00000040
298 #define AUTODRCFLAG 0x00000080
299 #define ALLDIRECTIONFLAG 0x00000100
300 #define SWAPSTARTDIRFLAG 0x00000200
301 #define UNIQUENAMEFLAG 0x00000400
302 #define CLEARNEWFLAG 0x00000800
303 #define SNAPPINFLAG 0x00001000
304 #define SHOWMASKFLAG 0x00002000
305 #define THINDRAWFLAG 0x00004000
306 #define ORTHOMOVEFLAG 0x00008000
307 #define LIVEROUTEFLAG 0x00010000
308 #define THINDRAWPOLYFLAG 0x00020000
309 #define LOCKNAMESFLAG 0x00040000
310 #define ONLYNAMESFLAG 0x00080000
311 #define NEWFULLPOLYFLAG 0x00100000
312 #define HIDENAMESFLAG 0x00200000
314 /* ---------------------------------------------------------------------------
317 #define NO_TYPE 0x00000 /* no object */
318 #define VIA_TYPE 0x00001
319 #define ELEMENT_TYPE 0x00002
320 #define LINE_TYPE 0x00004
321 #define POLYGON_TYPE 0x00008
322 #define TEXT_TYPE 0x00010
323 #define RATLINE_TYPE 0x00020
325 #define PIN_TYPE 0x00100 /* objects that are part */
326 #define PAD_TYPE 0x00200 /* 'pin' of SMD element */
327 #define ELEMENTNAME_TYPE 0x00400 /* of others */
328 #define POLYGONPOINT_TYPE 0x00800
329 #define LINEPOINT_TYPE 0x01000
330 #define ELEMENTLINE_TYPE 0x02000
331 #define ARC_TYPE 0x04000
332 #define ELEMENTARC_TYPE 0x08000
334 #define LOCKED_TYPE 0x10000 /* used to tell search to include locked items. */
335 #define NET_TYPE 0x20000 /* used to select whole net. */
336 #define ARCPOINT_TYPE 0x40000
338 #define PIN_TYPES (VIA_TYPE | PIN_TYPE)
339 #define LOCK_TYPES (VIA_TYPE | LINE_TYPE | ARC_TYPE | POLYGON_TYPE | ELEMENT_TYPE \
340 | TEXT_TYPE | ELEMENTNAME_TYPE | LOCKED_TYPE)
342 #define ALL_TYPES (~0) /* all bits set */