src/const.h

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