diff options
Diffstat (limited to 'gerbview/class_GERBER.h')
| -rw-r--r-- | gerbview/class_GERBER.h | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/gerbview/class_GERBER.h b/gerbview/class_GERBER.h new file mode 100644 index 0000000..1f72c1c --- /dev/null +++ b/gerbview/class_GERBER.h @@ -0,0 +1,378 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2010-2013 Jean-Pierre Charras jp.charras at wanadoo.fr + * Copyright (C) 1992-2013 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 _CLASS_GERBER_H_ +#define _CLASS_GERBER_H_ + +#include <vector> +#include <set> + +#include <dcode.h> +#include <class_gerber_draw_item.h> +#include <class_aperture_macro.h> + +// An useful macro used when reading gerber files; +#define IsNumber( x ) ( ( ( (x) >= '0' ) && ( (x) <='9' ) ) \ + || ( (x) == '-' ) || ( (x) == '+' ) || ( (x) == '.' ) ) + +class GERBVIEW_FRAME; +class D_CODE; + +/* gerber files have different parameters to define units and how items must be plotted. + * some are for the entire file, and other can change along a file. + * In Gerber world: + * an image is the entire gerber file and its "global" parameters + * a layer (that is very different from a board layer) is just a sub set of a file that + * have specific parameters + * if a Image parameter is set more than once, only the last value is used + * Some parameters can change along a file and are not layer specific: they are stored + * in GERBER_ITEM items, when instancied. + * + * In GerbView, to handle these parameters, there are 2 classes: + * GERBER_IMAGE : the main class containing most of parameters and data to plot a graphic layer + * Some of them can change along the file + * There is one GERBER_IMAGE per file and one graphic layer per file or GERBER_IMAGE + * GerbView does not read and merge 2 gerber file in one graphic layer: + * I believe this is not possible due to the constraints in Image parameters. + * GERBER_LAYER : containing the subset of parameters that is layer speficic + * A GERBER_IMAGE must include one GERBER_LAYER to define all parameters to plot a file. + * But a GERBER_IMAGE can use more than one GERBER_LAYER. + */ + +class GERBER_IMAGE; +class X2_ATTRIBUTE_FILEFUNCTION; + +class GERBER_LAYER +{ + friend class GERBER_IMAGE; +public: + + // These parameters are layer specfic: + wxString m_LayerName; // Layer name, from LN <name>* command + bool m_LayerNegative; // true = Negative Layer: command LP + wxRealPoint m_StepForRepeat; // X and Y offsets for Step and Repeat command + int m_XRepeatCount; // The repeat count on X axis + int m_YRepeatCount; // The repeat count on Y axis + bool m_StepForRepeatMetric; // false = Inches, true = metric + // needed here because repeated + // gerber items can have coordinates + // in different units than step parameters + // and the actual coordinates calculation must handle this + +public: + GERBER_LAYER(); + ~GERBER_LAYER(); +private: + void ResetDefaultValues(); +}; + +/** + * Class GERBER_IMAGE + * holds the Image data and parameters for one gerber file + * and layer parameters (TODO: move them in GERBER_LAYER class + */ +class GERBER_IMAGE +{ + GERBVIEW_FRAME* m_Parent; // the parent GERBVIEW_FRAME (used to display messages...) + D_CODE* m_Aperture_List[TOOLS_MAX_COUNT]; ///< Dcode (Aperture) List for this layer (max 999) + bool m_Exposure; ///< whether an aperture macro tool is flashed on or off + + GERBER_LAYER m_GBRLayerParams; // hold params for the current gerber layer + +public: + bool m_InUse; // true if this image is currently in use + // (a file is loaded in it) + wxString m_FileName; // Full File Name for this layer + wxString m_ImageName; // Image name, from IN <name>* command + bool m_IsX2_file; // true if a X2 gerber attribute was found in file + X2_ATTRIBUTE_FILEFUNCTION* m_FileFunction; // file function parameters, found in a %TF command + // or a G04 + wxString m_MD5_value; // MD5 value found in a %TF.MD5 command + wxString m_PartString; // string found in a %TF.Part command + int m_GraphicLayer; // Graphic layer Number + bool m_ImageNegative; // true = Negative image + bool m_ImageJustifyXCenter; // Image Justify Center on X axis (default = false) + bool m_ImageJustifyYCenter; // Image Justify Center on Y axis (default = false) + wxPoint m_ImageJustifyOffset; // Image Justify Offset on XY axis (default = 0,0) + bool m_GerbMetric; // false = Inches, true = metric + bool m_Relative; // false = absolute Coord, true = relative Coord + bool m_NoTrailingZeros; // true: remove tailing zeros. + bool m_DecimalFormat; // true: use floating point notations for coordinates + // If true, overrides m_NoTrailingZeros parameter. + wxPoint m_ImageOffset; // Coord Offset, from IO command + wxSize m_FmtScale; // Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4 + wxSize m_FmtLen; // Nb chars per coord. ex fmt 2.3, m_FmtLen = 5 + int m_ImageRotation; // Image rotation (0, 90, 180, 270 only) in degrees + double m_LocalRotation; // Local rotation, in degrees, added to m_ImageRotation + // Note this value is stored in 0.1 degrees + wxPoint m_Offset; // Coord Offset, from OF command + wxRealPoint m_Scale; // scale (X and Y) of layer. + bool m_SwapAxis; // false (default) if A = X and B = Y + // true if A = Y, B = X + bool m_MirrorA; // true: miror / axe A (X) + bool m_MirrorB; // true: miror / axe B (Y) + int m_Iterpolation; // Linear, 90 arc, Circ. + int m_Current_Tool; // Current Tool (Dcode) number selected + int m_Last_Pen_Command; // Current or last pen state (0..9, set by Dn option with n <10 + int m_CommandState; // state of gerber analysis command. + wxPoint m_CurrentPos; // current specified coord for plot + wxPoint m_PreviousPos; // old current specified coord for plot + wxPoint m_IJPos; // IJ coord (for arcs & circles ) + + FILE* m_Current_File; // Current file to read + #define INCLUDE_FILES_CNT_MAX 10 + FILE* m_FilesList[INCLUDE_FILES_CNT_MAX + 2]; // Included files list + int m_FilesPtr; // Stack pointer for files list + + int m_Selected_Tool; // For hightlight: current selected Dcode + bool m_Has_DCode; // true = DCodes in file + // (false = no DCode -> separate DCode file + bool m_360Arc_enbl; // Enbl 360 deg circular interpolation + bool m_PolygonFillMode; // Enable polygon mode (read coord as a polygon descr) + int m_PolygonFillModeState; // In polygon mode: 0 = first segm, 1 = next segm + + APERTURE_MACRO_SET m_aperture_macros; ///< a collection of APERTURE_MACROS, sorted by name + +private: + int m_hasNegativeItems; // true if the image is negative or has some negative items + // Used to optimize drawing, because when there are no + // negative items screen refresh does not need + // to build an intermediate bitmap specfic to this image + // -1 = negative items are + // 0 = no negative items found + // 1 = have negative items found + +public: + GERBER_IMAGE( GERBVIEW_FRAME* aParent, int layer ); + virtual ~GERBER_IMAGE(); + void Clear_GERBER_IMAGE(); + int UsedDcodeNumber(); + virtual void ResetDefaultValues(); + + /** + * Function GetParent + * @return the GERBVIEW_FRAME parent of this GERBER_IMAGE + */ + GERBVIEW_FRAME* GetParent() const + { + return m_Parent; + } + + /** + * Function GetItemsList + * @return the first GERBER_DRAW_ITEM * item of the items list + */ + GERBER_DRAW_ITEM * GetItemsList(); + + /** + * Function GetLayerParams + * @return the current layers params + */ + GERBER_LAYER& GetLayerParams() + { + return m_GBRLayerParams; + } + + /** + * Function HasNegativeItems + * @return true if at least one item must be drawn in background color + * used to optimize screen refresh (when no items are in background color + * refresh can be faster) + */ + bool HasNegativeItems(); + + /** + * Function ReportMessage + * Add a message (a string) in message list + * for instance when reading a Gerber file + * @param aMessage = the straing to add in list + */ + void ReportMessage( const wxString aMessage ); + + /** + * Function ClearMessageList + * Clear the message list + * Call it before reading a Gerber file + */ + void ClearMessageList(); + + /** + * Function InitToolTable + */ + void InitToolTable(); + + /** + * Function ReadXYCoord + * Returns the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm) + */ + wxPoint ReadXYCoord( char*& Text ); + + /** + * Function ReadIJCoord + * Returns the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) + * These coordinates are relative, so if coordinate is absent, it's value + * defaults to 0 + */ + wxPoint ReadIJCoord( char*& Text ); + + // functions to read G commands or D commands: + int GCodeNumber( char*& Text ); + int DCodeNumber( char*& Text ); + + // functions to execute G commands or D commands: + bool Execute_G_Command( char*& text, int G_command ); + bool Execute_DCODE_Command( char*& text, int D_command ); + + /** + * Function ReadRS274XCommand + * reads a single RS274X command terminated with a % + */ + bool ReadRS274XCommand( char aBuff[GERBER_BUFZ], char* & text ); + + /** + * Function ExecuteRS274XCommand + * executes 1 command + */ + bool ExecuteRS274XCommand( int command, char aBuff[GERBER_BUFZ], + char* & text ); + + + /** + * Function ReadApertureMacro + * reads in an aperture macro and saves it in m_aperture_macros. + * @param aBuff a character buffer at least GERBER_BUFZ long that can be + * used to read successive lines from the gerber file. + * @param text A reference to a character pointer which gives the initial + * text to read from. + * @param gerber_file Which file to read from for continuation. + * @return bool - true if a macro was read in successfully, else false. + */ + bool ReadApertureMacro( char aBuff[GERBER_BUFZ], char* & text, + FILE * gerber_file ); + + + /** + * Function GetDCODE + * returns a pointer to the D_CODE within this GERBER for the given + * \a aDCODE. + * @param aDCODE The numeric value of the D_CODE to look up. + * @param createIfNoExist If true, then create the D_CODE if it does not + * exist. + * @return D_CODE* - the one implied by the given \a aDCODE, or NULL + * if the requested \a aDCODE is out of range. + */ + D_CODE* GetDCODE( int aDCODE, bool createIfNoExist = true ); + + /** + * Function FindApertureMacro + * looks up a previously read in aperture macro. + * @param aLookup A dummy APERTURE_MACRO with [only] the name field set. + * @return APERTURE_MACRO* - the one with a matching name, or NULL if + * not found. + */ + APERTURE_MACRO* FindApertureMacro( const APERTURE_MACRO& aLookup ); + + /** + * Function StepAndRepeatItem + * Gerber format has a command Step an Repeat + * This function must be called when reading a gerber file and + * after creating a new gerber item that must be repeated + * (i.e when m_XRepeatCount or m_YRepeatCount are > 1) + * @param aItem = the item to repeat + */ + void StepAndRepeatItem( const GERBER_DRAW_ITEM& aItem ); + + /** + * Function DisplayImageInfo + * has knowledge about the frame and how and where to put status information + * about this object into the frame's message panel. + * Display info about Image Parameters. + */ + void DisplayImageInfo( void ); +}; + +/** + * @brief GERBER_IMAGE_LIST is a helper class to handle a list of GERBER_IMAGE files + * which are loaded and can be displayed + * there are 32 images max which can be loaded + */ +class GERBER_IMAGE_LIST +{ + // the list of loaded images (1 image = 1 gerber file) + std::vector<GERBER_IMAGE*> m_GERBER_List; + +public: + GERBER_IMAGE_LIST(); + ~GERBER_IMAGE_LIST(); + + //Accessor + GERBER_IMAGE* GetGbrImage( int aIdx ); + + /** + * Add a GERBER_IMAGE* at index aIdx + * or at the first free location if aIdx < 0 + * @param aGbrImage = the image to add + * @param aIdx = the location to use ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ) + * @return true if the index used, or -1 if no room to add image + */ + int AddGbrImage( GERBER_IMAGE* aGbrImage, int aIdx ); + + + /** + * remove all loaded data in list + */ + void ClearList(); + + /** + * remove the loaded data of image aIdx + * @param aIdx = the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ) + */ + void ClearImage( int aIdx ); + + /** + * @return a name for image aIdx which can be used in layers manager + * and layer selector + * is is "Layer n" (n = aIdx+1), followed by file attribute info (if X2 format) + * @param aIdx = the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ) + */ + const wxString GetDisplayName( int aIdx ); + + /** + * @return true if image is used (loaded and with items) + * @param aIdx = the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ) + */ + bool IsUsed( int aIdx ); + + /** + * Sort loaded images by Z order priority, if they have the X2 FileFormat info + * @param aDrawList: the draw list associated to the gerber images + * (SortImagesByZOrder updates the graphic layer of these items) + */ + void SortImagesByZOrder( GERBER_DRAW_ITEM* aDrawList ); +}; + + +extern GERBER_IMAGE_LIST g_GERBER_List; + +#endif // ifndef _CLASS_GERBER_H_ |