259 lines
9.5 KiB
C++
259 lines
9.5 KiB
C++
/**
|
|
* @file gendrill_Excellon_writer.h
|
|
* @brief Classes used in drill files, map files and report files generation.
|
|
*/
|
|
|
|
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 1992-2012 Jean_Pierre Charras <jp.charras at wanadoo.fr>
|
|
* Copyright (C) 1992-2012 KiCad Developers, see change_log.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef _GENDRILL_EXCELLON_WRITER_
|
|
#define _GENDRILL_EXCELLON_WRITER_
|
|
|
|
#include <vector>
|
|
|
|
|
|
class BOARD;
|
|
class PLOTTER;
|
|
|
|
|
|
/* the DRILL_TOOL class handles tools used in the excellon drill file */
|
|
class DRILL_TOOL
|
|
{
|
|
public:
|
|
int m_Diameter; // the diameter of the used tool (for oblong, the smaller size)
|
|
int m_TotalCount; // how many times it is used (round and oblong)
|
|
int m_OvalCount; // oblong count
|
|
|
|
public:
|
|
DRILL_TOOL( int diametre )
|
|
{
|
|
m_TotalCount = 0;
|
|
m_OvalCount = 0;
|
|
m_Diameter = diametre;
|
|
}
|
|
};
|
|
|
|
|
|
/* the HOLE_INFO class handle hole which must be drilled (diameter, position and layers)
|
|
* For buried or micro vias, the hole is not on all layers.
|
|
* So we must generate a drill file for each layer pair (adjacent layers)
|
|
* Not plated holes are always through holes, and must be output on a specific drill file
|
|
* because they are drilled after the Pcb process is finished.
|
|
*/
|
|
class HOLE_INFO
|
|
{
|
|
public:
|
|
int m_Hole_Diameter; // hole value, and for oblong: min(hole size x, hole size y)
|
|
int m_Tool_Reference; // Tool reference for this hole = 1 ... n (values <=0 must not be used)
|
|
wxSize m_Hole_Size; // hole size for oblong holes
|
|
double m_Hole_Orient; // Hole rotation (= pad rotation) for oblong holes
|
|
int m_Hole_Shape; // hole shape: round (0) or oval (1)
|
|
wxPoint m_Hole_Pos; // hole position
|
|
LAYER_NUM m_Hole_Bottom_Layer; // hole starting layer (usually back layer)
|
|
LAYER_NUM m_Hole_Top_Layer; // hole ending layer (usually front layer):
|
|
// m_Hole_First_Layer < m_Hole_Last_Layer
|
|
bool m_Hole_NotPlated; // hole not plated. Must be in a specific drill file
|
|
public:
|
|
HOLE_INFO()
|
|
{
|
|
m_Hole_NotPlated = false;
|
|
}
|
|
};
|
|
|
|
|
|
/* the DRILL_PRECISION helper class to handle drill precision format in excellon files
|
|
*/
|
|
class DRILL_PRECISION
|
|
{
|
|
public:
|
|
int m_lhs; // Left digit number (integer value of coordinates)
|
|
int m_rhs; // Right digit number (deciam value of coordinates)
|
|
|
|
public: DRILL_PRECISION( int l = 2, int r = 4 )
|
|
{
|
|
m_lhs = l; m_rhs = r;
|
|
}
|
|
|
|
|
|
wxString GetPrecisionString()
|
|
{
|
|
wxString text;
|
|
|
|
text << m_lhs << wxT( ":" ) << m_rhs;
|
|
return text;
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* EXCELLON_WRITER is a class mainly used to create Excellon drill files
|
|
* However, this class is also used to create drill maps and drill report
|
|
*/
|
|
class EXCELLON_WRITER
|
|
{
|
|
public:
|
|
enum zeros_fmt {
|
|
// Zero format in coordinates
|
|
DECIMAL_FORMAT,
|
|
SUPPRESS_LEADING,
|
|
SUPPRESS_TRAILING,
|
|
KEEP_ZEROS
|
|
};
|
|
wxPoint m_Offset; // offset coordinates
|
|
bool m_ShortHeader; // true to generate the smallest header (strip comments)
|
|
|
|
private:
|
|
FILE* m_file; // The output file
|
|
BOARD* m_pcb;
|
|
bool m_minimalHeader; // True to use minimal haeder
|
|
// in excellon file (strip comments)
|
|
bool m_unitsDecimal; // true = decimal, false = inches
|
|
zeros_fmt m_zeroFormat; // the zero format option for output file
|
|
DRILL_PRECISION m_precision; // The current coordinate precision (not used in decimat format)
|
|
double m_conversionUnits; // scaling factor to convert the board unites to Excellon units
|
|
// (i.e inches or mm)
|
|
bool m_mirror;
|
|
wxPoint m_offset; // Drill offset ooordinates
|
|
std::vector<HOLE_INFO> m_holeListBuffer; // Buffer containing holes
|
|
std::vector<DRILL_TOOL> m_toolListBuffer; // Buffer containing tools
|
|
|
|
public: EXCELLON_WRITER( BOARD* aPcb, wxPoint aOffset )
|
|
{
|
|
m_file = NULL;
|
|
m_pcb = aPcb;
|
|
m_zeroFormat = DECIMAL_FORMAT;
|
|
m_conversionUnits = 0.0001;
|
|
m_unitsDecimal = false;
|
|
m_mirror = false;
|
|
m_minimalHeader = false;
|
|
}
|
|
|
|
|
|
~EXCELLON_WRITER()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Return the plot offset (usually the position
|
|
* of the auxiliaty axis
|
|
*/
|
|
const wxPoint GetOffset() { return m_offset; }
|
|
|
|
/**
|
|
* Function SetFormat
|
|
* Initialize internal parameters to match the given format
|
|
* @param aMetric = true for metric coordinates, false for imperial units
|
|
* @param aZerosFmt = DECIMAL_FORMAT, SUPPRESS_LEADING, SUPPRESS_TRAILING, KEEP_ZEROS
|
|
* @param aLeftDigits = number of digits for integer part of coordinates
|
|
* @param aRightDigits = number of digits for mantissa part of coordinates
|
|
*/
|
|
void SetFormat( bool aMetric, zeros_fmt aZerosFmt, int aLeftDigits, int aRightDigits );
|
|
|
|
/**
|
|
* Function SetOptions
|
|
* Initialize internal parameters to match drill options
|
|
* @param aMirror = true to create mirrored coordinates (Y coordinates negated)
|
|
* @param aMinimalHeader = true to use a minimal header (no comments, no info)
|
|
* @param aOffset = drill coordinates offset
|
|
*/
|
|
void SetOptions( bool aMirror, bool aMinimalHeader, wxPoint aOffset )
|
|
{
|
|
m_mirror = aMirror;
|
|
m_offset = aOffset;
|
|
m_minimalHeader = aMinimalHeader;
|
|
}
|
|
|
|
/**
|
|
* Function BuildHolesList
|
|
* Create the list of holes and tools for a given board
|
|
* The list is sorted by increasing drill values
|
|
* Only holes from aFirstLayer to aLastLayer copper layers are listed (for vias, because
|
|
* pad holes are always through holes)
|
|
* @param aFirstLayer = first layer to consider. if < 0 aFirstLayer is ignored
|
|
* @param aLastLayer = last layer to consider. if < 0 aLastLayer is ignored
|
|
* @param aExcludeThroughHoles Exclude through holes if true.
|
|
* @param aGenerateNPTH_list :
|
|
* true to create NPTH only list (with no plated holes)
|
|
* false to created plated holes list (with no NPTH )
|
|
*/
|
|
void BuildHolesList( int aFirstLayer, int aLastLayer,
|
|
bool aExcludeThroughHoles,
|
|
bool aGenerateNPTH_list );
|
|
|
|
int GetHolesCount() const { return m_holeListBuffer.size(); }
|
|
|
|
/**
|
|
* Function CreateDrillFile
|
|
* Creates an Excellon drill file
|
|
* @param aFile = an opened file to write to
|
|
* will be closed by CreateDrillFile
|
|
* @return hole count
|
|
*/
|
|
int CreateDrillFile( FILE * aFile );
|
|
|
|
/**
|
|
* Function GenDrillReportFile
|
|
* Create a plain text report file giving a list of drill values and drill count
|
|
* for through holes, oblong holes, and for buried vias,
|
|
* drill values and drill count per layer pair
|
|
* there is only one report for all drill files even when buried or blinds vias exist
|
|
* @param aFullFileName : the name of the file to create
|
|
* m_unitsDecimal = false tu use inches, true to use mm in report file
|
|
*
|
|
* @return success if the file is created
|
|
*/
|
|
bool GenDrillReportFile( const wxString& aFullFileName );
|
|
|
|
/**
|
|
* Function GenDrillMapFile
|
|
* Plot a map of drill marks for holes.
|
|
* @param aFullFileNameWithoutExt : the full filename of the file to create,
|
|
* without extension (will be added accordint ti the format)
|
|
* @param aSheet : the paper sheet touse for plot
|
|
* @param aFormat : one of the supported plot formats (see enum PlotFormat )
|
|
*/
|
|
bool GenDrillMapFile( const wxString& aFullFileNameWithoutExt,
|
|
const PAGE_INFO& aSheet,
|
|
PlotFormat aFormat );
|
|
private:
|
|
void WriteEXCELLONHeader();
|
|
void WriteEXCELLONEndOfFile();
|
|
void WriteCoordinates( char* aLine, double aCoordX, double aCoordY );
|
|
|
|
/** Helper function.
|
|
* Writes the drill marks in HPGL, POSTSCRIPT or other supported formats
|
|
* Each hole size has a symbol (circle, cross X, cross + ...) up to
|
|
* PLOTTER::MARKER_COUNT different values.
|
|
* If more than PLOTTER::MARKER_COUNT different values,
|
|
* these other values share the same mark shape
|
|
* @param aPlotter = a PLOTTER instance (HPGL, POSTSCRIPT ... plotter).
|
|
*/
|
|
bool PlotDrillMarks( PLOTTER* aPlotter );
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif // #ifndef _GENDRILL_EXCELLON_WRITER_
|