src/const.h

   1 /*
   2  *                            COPYRIGHT
   3  *
   4  *  PCB, interactive printed circuit board design
   5  *  Copyright (C) 1994,1995,1996 Thomas Nau
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  *
  21  *  Contact addresses for paper mail and Email:
  22  *  Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany
  23  *  Thomas.Nau@rz.uni-ulm.de
  24  *
  25  */
  26
  27 /* global source constants
  28  */
  29
  30 #ifndef PCB_CONST_H
  31 #define PCB_CONST_H
  32
  33 #include <limits.h>
  34 #include <math.h>
  35
  36 #include "globalconst.h"
  37
  38 /* ---------------------------------------------------------------------------
  39  * the layer-numbers of the two additional special layers
  40  * 'component' and 'solder'. The offset of MAX_LAYER is not added
  41  */
  42 #define SOLDER_LAYER            0
  43 #define COMPONENT_LAYER         1
  44
  45 /* ---------------------------------------------------------------------------
  46  * misc constants
  47  */
  48 #define MARK_SIZE               MIL_TO_COORD(50)        /* relative marker size */
  49 #define UNDO_WARNING_SIZE       (1024*1024)     /* warning limit of undo */
  50 #define USERMEDIANAME           "user defined"  /* label of default media */
  51
  52 /* ---------------------------------------------------------------------------
  53  * some math constants
  54  */
  55 #ifndef M_PI
  56 #define M_PI                    3.14159265358979323846
  57 #endif
  58 #ifndef M_SQRT1_2
  59 #define M_SQRT1_2               0.707106781     /* 1/sqrt(2) */
  60 #endif
  61 #define M180                    (M_PI/180.0)
  62 #define RAD_TO_DEG              (180.0/M_PI)
  63 #define TAN_22_5_DEGREE_2       0.207106781     /* 0.5*tan(22.5) */
  64 #define COS_22_5_DEGREE         0.923879533     /* cos(22.5) */
  65 #define TAN_30_DEGREE           0.577350269     /* tan(30) */
  66 #define TAN_60_DEGREE           1.732050808     /* tan(60) */
  67 #define LN_2_OVER_2             0.346573590
  68
  69 /* PCB/physical unit conversions */
  70 #define COORD_TO_MIL(n) ((n) / 25400.0)
  71 #define MIL_TO_COORD(n) ((n) * 25400.0)
  72 #define COORD_TO_MM(n)  ((n) / 1000000.0)
  73 #define MM_TO_COORD(n)  ((n) * 1000000.0)
  74 #define COORD_TO_INCH(n)        (COORD_TO_MIL(n) / 1000.0)
  75 #define INCH_TO_COORD(n)        (MIL_TO_COORD(n) * 1000.0)
  76
  77 /* These need to be carefully written to avoid overflows, and return
  78    a Coord type.  */
  79 #define SCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * ((double)(TEXTSCALE) / 100.0)))
  80 #define UNSCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * (100.0 / (double)(TEXTSCALE))))
  81
  82 /* ---------------------------------------------------------------------------
  83  * modes
  84  */
  85 #define NO_MODE                 0       /* no mode selected */
  86 #define VIA_MODE                1       /* draw vias */
  87 #define LINE_MODE               2       /* draw lines */
  88 #define RECTANGLE_MODE          3       /* create rectangles */
  89 #define POLYGON_MODE            4       /* draw filled polygons */
  90 #define PASTEBUFFER_MODE        5       /* paste objects from buffer */
  91 #define TEXT_MODE               6       /* create text objects */
  92 #define ROTATE_MODE             102     /* rotate objects */
  93 #define REMOVE_MODE             103     /* remove objects */
  94 #define MOVE_MODE               104     /* move objects */
  95 #define COPY_MODE               105     /* copy objects */
  96 #define INSERTPOINT_MODE        106     /* insert point into line/polygon */
  97 #define RUBBERBANDMOVE_MODE     107     /* move objects and attached lines */
  98 #define THERMAL_MODE            108     /* toggle thermal layer flag */
  99 #define ARC_MODE                109     /* draw arcs */
 100 #define ARROW_MODE              110     /* selection with arrow mode */
 101 #define PAN_MODE                0       /* same as no mode */
 102 #define LOCK_MODE               111     /* lock/unlock objects */
 103 #define POLYGONHOLE_MODE        112     /* cut holes in filled polygons */
 104
 105 /* ---------------------------------------------------------------------------
 106  * object flags
 107  */
 108
 109 /* %start-doc pcbfile ~objectflags
 110 @node Object Flags
 111 @section Object Flags
 112
 113 Note that object flags can be given numerically (like @code{0x0147})
 114 or symbolically (like @code{"found,showname,square"}.  Some numeric
 115 values are reused for different object types.  The table below lists
 116 the numeric value followed by the symbolic name.
 117
 118 @table @code
 119 @item 0x0001 pin
 120 If set, this object is a pin.  This flag is for internal use only.
 121 @item 0x0002 via
 122 Likewise, for vias.
 123 @item 0x0004 found
 124 If set, this object has been found by @code{FindConnection()}.
 125 @item 0x0008 hole
 126 For pins and vias, this flag means that the pin or via is a hole
 127 without a copper annulus.
 128 @item 0x0010 rat
 129 If set for a line, indicates that this line is a rat line instead of a
 130 copper trace.
 131 @item 0x0010 pininpoly
 132 For pins and pads, this flag is used internally to indicate that the
 133 pin or pad overlaps a polygon on some layer.
 134 @item 0x0010 clearpoly
 135 For polygons, this flag means that pins and vias will normally clear
 136 these polygons (thus, thermals are required for electrical
 137 connection).  When clear, polygons will solidly connect to pins and
 138 vias.
 139 @item 0x0010 hidename
 140 For elements, when set the name of the element is hidden.
 141 @item 0x0020 showname
 142 For elements, when set the names of pins are shown.
 143 @item 0x0020 clearline
 144 For lines and arcs, the line/arc will clear polygons instead of
 145 connecting to them.
 146 @item 0x0020 fullpoly
 147 For polygons, the full polygon is drawn (i.e. all parts instead of only the biggest one).
 148 @item 0x0040 selected
 149 Set when the object is selected.
 150 @item 0x0080 onsolder
 151 For elements and pads, indicates that they are on the solder side.
 152 @item 0x0080 auto
 153 For lines and vias, indicates that these were created by the
 154 autorouter.
 155 @item 0x0100 square
 156 For pins and pads, indicates a square (vs round) pin/pad.
 157 @item 0x0200 rubberend
 158 For lines, used internally for rubber band moves.
 159 @item 0x0200 warn
 160 For pins, vias, and pads, set to indicate a warning.
 161 @item 0x0400 usetherm
 162 Obsolete, indicates that pins/vias should be drawn with thermal
 163 fingers.
 164 @item 0x0400
 165 Obsolete, old files used this to indicate lines drawn on silk.
 166 @item 0x0800 octagon
 167 Draw pins and vias as octagons.
 168 @item 0x1000 drc
 169 Set for objects that fail DRC.
 170 @item 0x2000 lock
 171 Set for locked objects.
 172 @item 0x4000 edge2
 173 For pads, indicates that the second point is closer to the edge.  For
 174 pins, indicates that the pin is closer to a horizontal edge and thus
 175 pinout text should be vertical.
 176 @item 0x8000 marker
 177 Marker used internally to avoid revisiting an object.
 178 @item 0x10000 nopaste
 179 For pads, set to prevent a solderpaste stencil opening for the
 180 pad.  Primarily used for pads used as fiducials.
 181 @end table
 182 %end-doc */
 183
 184 #define NOFLAG                  0x0000
 185 #define PINFLAG                 0x0001  /* is a pin */
 186 #define VIAFLAG                 0x0002  /* is a via */
 187 #define FOUNDFLAG               0x0004  /* used by 'FindConnection()' */
 188 #define HOLEFLAG                0x0008  /* pin or via is only a hole */
 189 #define NOPASTEFLAG             0x0008  /* pad should not receive
 190                                            solderpaste.  This is to
 191                                            support fiducials */
 192 #define RATFLAG                 0x0010  /* indicates line is a rat line */
 193 #define PININPOLYFLAG           0x0010  /* pin found inside poly - same as */
 194                                                 /* rat line since not used on lines */
 195 #define CLEARPOLYFLAG           0x0010  /* pins/vias clear these polygons */
 196 #define HIDENAMEFLAG            0x0010  /* hide the element name */
 197 #define DISPLAYNAMEFLAG         0x0020  /* display the names of pins/pads */
 198                                         /* of an element */
 199 #define CLEARLINEFLAG           0x0020  /* line doesn't touch polygons */
 200 #define FULLPOLYFLAG            0x0020  /* full polygon is drawn (i.e. all parts instead of only the biggest one) */
 201 #define SELECTEDFLAG            0x0040  /* object has been selected */
 202 #define ONSOLDERFLAG            0x0080  /* element is on bottom side */
 203 #define AUTOFLAG                0x0080  /* line/via created by auto-router */
 204 #define SQUAREFLAG              0x0100  /* pin is square, not round */
 205 #define RUBBERENDFLAG           0x0200  /* indicates one end already rubber */
 206                                         /* banding same as warn flag */
 207                                         /* since pins/pads won't use it */
 208 #define WARNFLAG                0x0200  /* Warning for pin/via/pad */
 209 #define USETHERMALFLAG          0x0400  /* draw pin, via with thermal fingers */
 210 #define ONSILKFLAG              0x0400  /* old files use this to indicate silk */
 211 #define OCTAGONFLAG             0x0800  /* draw pin/via as octagon instead of round */
 212 #define DRCFLAG                 0x1000  /* flag like FOUND flag for DRC checking */
 213 #define LOCKFLAG                0x2000  /* object locked in place */
 214 #define EDGE2FLAG               0x4000  /* Padr.Point2 is closer to outside edge */
 215                                         /* also pinout text for pins is vertical */
 216 #define VISITFLAG               0x8000  /* marker to avoid re-visiting an object */
 217 /* ---------------------------------------------------------------------------
 218  * PCB flags
 219  */
 220
 221 /* %start-doc pcbfile ~pcbflags
 222 @node PCBFlags
 223 @section PCBFlags
 224 @table @code
 225 @item 0x00001
 226 Pinout displays pin numbers instead of pin names.
 227 @item 0x00002
 228 Use local reference for moves, by setting the mark at the beginning of
 229 each move.
 230 @item 0x00004
 231 When set, only polygons and their clearances are drawn, to see if
 232 polygons have isolated regions.
 233 @item 0x00008
 234 Display DRC region on crosshair.
 235 @item 0x00010
 236 Do all move, mirror, rotate with rubberband connections.
 237 @item 0x00020
 238 Display descriptions of elements, instead of refdes.
 239 @item 0x00040
 240 Display names of elements, instead of refdes.
 241 @item 0x00080
 242 Auto-DRC flag.  When set, PCB doesn't let you place copper that
 243 violates DRC.
 244 @item 0x00100
 245 Enable 'all-direction' lines.
 246 @item 0x00200
 247 Switch starting angle after each click.
 248 @item 0x00400
 249 Force unique names on board.
 250 @item 0x00800
 251 New lines/arc clear polygons.
 252 @item 0x01000
 253 Crosshair snaps to pins and pads.
 254 @item 0x02000
 255 Show the solder mask layer.
 256 @item 0x04000
 257 Draw with thin lines.
 258 @item 0x08000
 259 Move items orthogonally.
 260 @item 0x10000
 261 Draw autoroute paths real-time.
 262 @item 0x20000
 263 New polygons are full ones.
 264 @item 0x40000
 265 Names are locked, the mouse cannot select them.
 266 @item 0x80000
 267 Everything but names are locked, the mouse cannot select anything else.
 268 @item 0x100000
 269 New polygons are full polygons.
 270 @item 0x200000
 271 When set, element names are not drawn.
 272 @end table
 273 %end-doc */
 274
 275 #define PCB_FLAGS               0x000fffff      /* all used flags */
 276
 277 #define SHOWNUMBERFLAG          0x00000001
 278 #define LOCALREFFLAG            0x00000002
 279 #define CHECKPLANESFLAG         0x00000004
 280 #define SHOWDRCFLAG             0x00000008
 281 #define RUBBERBANDFLAG          0x00000010
 282 #define DESCRIPTIONFLAG         0x00000020
 283 #define NAMEONPCBFLAG           0x00000040
 284 #define AUTODRCFLAG             0x00000080
 285 #define ALLDIRECTIONFLAG        0x00000100
 286 #define SWAPSTARTDIRFLAG        0x00000200
 287 #define UNIQUENAMEFLAG          0x00000400
 288 #define CLEARNEWFLAG            0x00000800
 289 #define SNAPPINFLAG             0x00001000
 290 #define SHOWMASKFLAG            0x00002000
 291 #define THINDRAWFLAG            0x00004000
 292 #define ORTHOMOVEFLAG           0x00008000
 293 #define LIVEROUTEFLAG           0x00010000
 294 #define THINDRAWPOLYFLAG        0x00020000
 295 #define LOCKNAMESFLAG           0x00040000
 296 #define ONLYNAMESFLAG           0x00080000
 297 #define NEWFULLPOLYFLAG         0x00100000
 298 #define HIDENAMESFLAG           0x00200000
 299
 300 /* ---------------------------------------------------------------------------
 301  * object types
 302  */
 303 #define NO_TYPE                 0x00000 /* no object */
 304 #define VIA_TYPE                0x00001
 305 #define ELEMENT_TYPE            0x00002
 306 #define LINE_TYPE               0x00004
 307 #define POLYGON_TYPE            0x00008
 308 #define TEXT_TYPE               0x00010
 309 #define RATLINE_TYPE            0x00020
 310
 311 #define PIN_TYPE                0x00100 /* objects that are part */
 312 #define PAD_TYPE                0x00200 /* 'pin' of SMD element */
 313 #define ELEMENTNAME_TYPE        0x00400 /* of others */
 314 #define POLYGONPOINT_TYPE       0x00800
 315 #define LINEPOINT_TYPE          0x01000
 316 #define ELEMENTLINE_TYPE        0x02000
 317 #define ARC_TYPE                0x04000
 318 #define ELEMENTARC_TYPE         0x08000
 319
 320 #define LOCKED_TYPE             0x10000 /* used to tell search to include locked items. */
 321 #define NET_TYPE                0x20000 /* used to select whole net. */
 322 #define ARCPOINT_TYPE           0x40000
 323
 324 #define PIN_TYPES     (VIA_TYPE | PIN_TYPE)
 325 #define LOCK_TYPES    (VIA_TYPE | LINE_TYPE | ARC_TYPE | POLYGON_TYPE | ELEMENT_TYPE \
 326                       | TEXT_TYPE | ELEMENTNAME_TYPE | LOCKED_TYPE)
 327
 328 #define ALL_TYPES               (~0)    /* all bits set */
 329
 330 #endif