const.h

Go to the documentation of this file.

#ifndef PCB_CONST_H
#define PCB_CONST_H

#include <limits.h>
#include <math.h>

#include "globalconst.h"

/* ---------------------------------------------------------------------------
 * integer codings for the board sides.
 */
#define BOTTOM_SIDE             0
#define TOP_SIDE                1


/* ---------------------------------------------------------------------------
 * the layer-numbers of the two additional special (silkscreen) layers
 * 'bottom' and 'top'. The offset of MAX_LAYER is not added
 */
#define SILK_LAYER              2
#define BOTTOM_SILK_LAYER       0
#define TOP_SILK_LAYER          1

/* ---------------------------------------------------------------------------
 * the resulting maximum number of layers, including additional silk layers
 */
#define MAX_ALL_LAYER           (MAX_LAYER + SILK_LAYER)

/* ---------------------------------------------------------------------------
 * misc constants
 */
#define MARK_SIZE               MIL_TO_COORD(50)        
#define UNDO_WARNING_SIZE       (1024*1024)     
#define USERMEDIANAME           "user defined"  
/* ---------------------------------------------------------------------------
 * some math constants
 */
#ifndef M_PI
#define M_PI                    3.14159265358979323846
#endif
#ifndef M_SQRT1_2
#define M_SQRT1_2               0.707106781     
#endif
#define M180                    (M_PI/180.0)
#define RAD_TO_DEG              (180.0/M_PI)
#define TAN_22_5_DEGREE_2       0.207106781     
#define COS_22_5_DEGREE         0.923879533     
#define TAN_30_DEGREE           0.577350269     
#define TAN_60_DEGREE           1.732050808     
#define LN_2_OVER_2             0.346573590

/* PCB/physical unit conversions */
#define COORD_TO_MIL(n) ((n) / 25400.0)
#define MIL_TO_COORD(n) ((n) * 25400.0)
#define COORD_TO_MM(n)  ((n) / 1000000.0)
#define MM_TO_COORD(n)  ((n) * 1000000.0)
#define COORD_TO_INCH(n)        (COORD_TO_MIL(n) / 1000.0)
#define INCH_TO_COORD(n)        (MIL_TO_COORD(n) * 1000.0)

/* These need to be carefully written to avoid overflows, and return
   a Coord type.  */
#define SCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * ((double)(TEXTSCALE) / 100.0)))
#define UNSCALE_TEXT(COORD,TEXTSCALE) ((Coord)((COORD) * (100.0 / (double)(TEXTSCALE))))

/* ---------------------------------------------------------------------------
 * modes
 */
#define NO_MODE                 0       
#define VIA_MODE                1       
#define LINE_MODE               2       
#define RECTANGLE_MODE          3       
#define POLYGON_MODE            4       
#define PASTEBUFFER_MODE        5       
#define TEXT_MODE               6       
#define ROTATE_MODE             102     
#define REMOVE_MODE             103     
#define MOVE_MODE               104     
#define COPY_MODE               105     
#define INSERTPOINT_MODE        106     
#define RUBBERBANDMOVE_MODE     107     
#define THERMAL_MODE            108     
#define ARC_MODE                109     
#define ARROW_MODE              110     
#define PAN_MODE                0       
#define LOCK_MODE               111     
#define POLYGONHOLE_MODE        112     
/* ---------------------------------------------------------------------------
 * object flags
 */

/* %start-doc pcbfile ~objectflags
@node Object Flags
@section Object Flags

Note that object flags can be given numerically (like @code{0x0147})
or symbolically (like @code{"found,showname,square"}.  Some numeric
values are reused for different object types.  The table below lists
the numeric value followed by the symbolic name.

@table @code
@item 0x0001 pin
If set, this object is a pin.  This flag is for internal use only.
@item 0x0002 via
Likewise, for vias.
@item 0x0004 found
If set, this object has been found by @code{FindConnection()}.
@item 0x0008 hole
For pins and vias, this flag means that the pin or via is a hole
without a copper annulus.
@item 0x0008 nopaste
For pads, set to prevent a solderpaste stencil opening for the
pad.  Primarily used for pads used as fiducials.
@item 0x0010 rat
If set for a line, indicates that this line is a rat line instead of a
copper trace.
@item 0x0010 pininpoly
For pins and pads, this flag is used internally to indicate that the
pin or pad overlaps a polygon on some layer.
@item 0x0010 clearpoly
For polygons, this flag means that pins and vias will normally clear
these polygons (thus, thermals are required for electrical
connection).  When clear, polygons will solidly connect to pins and
vias.
@item 0x0010 hidename
For elements, when set the name of the element is hidden.
@item 0x0020 showname
For elements, when set the names of pins are shown.
@item 0x0020 clearline
For lines and arcs, the line/arc will clear polygons instead of
connecting to them.
@item 0x0020 fullpoly
For polygons, the full polygon is drawn (i.e. all parts instead of only the biggest one).
@item 0x0040 selected
Set when the object is selected.
@item 0x0080 onsolder
For elements and pads, indicates that they are on the solder side.
@item 0x0080 auto
For lines and vias, indicates that these were created by the
autorouter.
@item 0x0100 square
For pins and pads, indicates a square (vs round) pin/pad.
@item 0x0200 rubberend
For lines, used internally for rubber band moves.
@item 0x0200 warn
For pins, vias, and pads, set to indicate a warning.
@item 0x0400 usetherm
Obsolete, indicates that pins/vias should be drawn with thermal
fingers.
@item 0x0400
Obsolete, old files used this to indicate lines drawn on silk.
@item 0x0800 octagon
Draw pins and vias as octagons.
@item 0x1000 drc
Set for objects that fail DRC.
@item 0x2000 lock
Set for locked objects.
@item 0x4000 edge2
For pads, indicates that the second point is closer to the edge.  For
pins, indicates that the pin is closer to a horizontal edge and thus
pinout text should be vertical.
@item 0x8000 marker
Marker used internally to avoid revisiting an object.
@item 0x10000 connected
If set, this object has been as physically connected by @code{FindConnection()}.
@end table
%end-doc */

#define NOFLAG                  0x0000
#define PINFLAG                 0x0001  
#define VIAFLAG                 0x0002  
#define FOUNDFLAG               0x0004  
#define HOLEFLAG                0x0008  
#define NOPASTEFLAG             0x0008  
#define RATFLAG                 0x0010  
#define PININPOLYFLAG           0x0010  
#define CLEARPOLYFLAG           0x0010  
#define HIDENAMEFLAG            0x0010  
#define DISPLAYNAMEFLAG         0x0020  
#define CLEARLINEFLAG           0x0020  
#define FULLPOLYFLAG            0x0020  
#define SELECTEDFLAG            0x0040  
#define ONSOLDERFLAG            0x0080  
#define AUTOFLAG                0x0080  
#define SQUAREFLAG              0x0100  
#define RUBBERENDFLAG           0x0200  
#define WARNFLAG                0x0200  
#define USETHERMALFLAG          0x0400  
#define ONSILKFLAG              0x0400  
#define OCTAGONFLAG             0x0800  
#define DRCFLAG                 0x1000  
#define LOCKFLAG                0x2000  
#define EDGE2FLAG               0x4000  
#define VISITFLAG               0x8000  
#define CONNECTEDFLAG          0x10000  
#define NOCOPY_FLAGS (FOUNDFLAG | CONNECTEDFLAG)

/* ---------------------------------------------------------------------------
 * PCB flags
 */

/* %start-doc pcbfile ~pcbflags
@node PCBFlags
@section PCBFlags
@table @code
@item 0x00001
Pinout displays pin numbers instead of pin names.
@item 0x00002
Use local reference for moves, by setting the mark at the beginning of
each move.
@item 0x00004
When set, only polygons and their clearances are drawn, to see if
polygons have isolated regions.
@item 0x00008
Display DRC region on crosshair.
@item 0x00010
Do all move, mirror, rotate with rubberband connections.
@item 0x00020
Display descriptions of elements, instead of refdes.
@item 0x00040
Display names of elements, instead of refdes.
@item 0x00080
Auto-DRC flag.  When set, PCB doesn't let you place copper that
violates DRC.
@item 0x00100
Enable 'all-direction' lines.
@item 0x00200
Switch starting angle after each click.
@item 0x00400
Force unique names on board.
@item 0x00800
New lines/arc clear polygons.
@item 0x01000
Crosshair snaps to pins and pads.
@item 0x02000
Show the solder mask layer.
@item 0x04000
Draw with thin lines.
@item 0x08000
Move items orthogonally.
@item 0x10000
Draw autoroute paths real-time.
@item 0x20000
New polygons are full ones.
@item 0x40000
Names are locked, the mouse cannot select them.
@item 0x80000
Everything but names are locked, the mouse cannot select anything else.
@item 0x100000
New polygons are full polygons.
@item 0x200000
When set, element names are not drawn.
@end table
%end-doc */

#define PCB_FLAGS               0x000fffff      /* all used flags */

#define SHOWNUMBERFLAG          0x00000001
#define LOCALREFFLAG            0x00000002
#define CHECKPLANESFLAG         0x00000004
#define SHOWDRCFLAG             0x00000008
#define RUBBERBANDFLAG          0x00000010
#define DESCRIPTIONFLAG         0x00000020
#define NAMEONPCBFLAG           0x00000040
#define AUTODRCFLAG             0x00000080
#define ALLDIRECTIONFLAG        0x00000100
#define SWAPSTARTDIRFLAG        0x00000200
#define UNIQUENAMEFLAG          0x00000400
#define CLEARNEWFLAG            0x00000800
#define SNAPPINFLAG             0x00001000
#define SHOWMASKFLAG            0x00002000
#define THINDRAWFLAG            0x00004000
#define ORTHOMOVEFLAG           0x00008000
#define LIVEROUTEFLAG           0x00010000
#define THINDRAWPOLYFLAG        0x00020000
#define LOCKNAMESFLAG           0x00040000
#define ONLYNAMESFLAG           0x00080000
#define NEWFULLPOLYFLAG         0x00100000
#define HIDENAMESFLAG           0x00200000
#define AUTOBURIEDVIASFLAG      0x00400000

/* ---------------------------------------------------------------------------
 * object types
 */
#define NO_TYPE                 0x00000 
#define VIA_TYPE                0x00001
#define ELEMENT_TYPE            0x00002
#define LINE_TYPE               0x00004
#define POLYGON_TYPE            0x00008
#define TEXT_TYPE               0x00010
#define RATLINE_TYPE            0x00020

#define PIN_TYPE                0x00100 
#define PAD_TYPE                0x00200 
#define ELEMENTNAME_TYPE        0x00400 
#define POLYGONPOINT_TYPE       0x00800
#define LINEPOINT_TYPE          0x01000
#define ELEMENTLINE_TYPE        0x02000
#define ARC_TYPE                0x04000
#define ELEMENTARC_TYPE         0x08000

#define LOCKED_TYPE             0x10000 
#define NET_TYPE                0x20000 
#define ARCPOINT_TYPE           0x40000

#define PIN_TYPES     (VIA_TYPE | PIN_TYPE)
#define LOCK_TYPES    (VIA_TYPE | LINE_TYPE | ARC_TYPE | POLYGON_TYPE | ELEMENT_TYPE \
                      | TEXT_TYPE | ELEMENTNAME_TYPE | LOCKED_TYPE)

#define ALL_TYPES               (~0)    
#endif