KiCad PCB EDA Suite
gerber_file_image.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2010-2018 Jean-Pierre Charras jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (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, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef GERBER_FILE_IMAGE_H
26 #define GERBER_FILE_IMAGE_H
27 
28 #include <vector>
29 #include <set>
30 
31 #include <dcode.h>
32 #include <gerber_draw_item.h>
33 #include <am_primitive.h>
34 #include <gbr_netlist_metadata.h>
35 
36 // An useful macro used when reading gerber files;
37 #define IsNumber( x ) ( ( ( (x) >= '0' ) && ( (x) <='9' ) ) \
38  || ( (x) == '-' ) || ( (x) == '+' ) || ( (x) == '.' ) )
39 
40 class GERBVIEW_FRAME;
41 class D_CODE;
42 
43 /* gerber files have different parameters to define units and how items must be plotted.
44  * some are for the entire file, and other can change along a file.
45  * In Gerber world:
46  * an image is the entire gerber file and its "global" parameters
47  * a layer (that is very different from a board layer) is just a sub set of a file that
48  * have specific parameters
49  * if a Image parameter is set more than once, only the last value is used
50  * Some parameters can change along a file and are not layer specific: they are stored
51  * in GERBER_ITEM items, when instancied.
52  *
53  * In GerbView, to handle these parameters, there are 2 classes:
54  * GERBER_FILE_IMAGE : the main class containing most of parameters and data to plot a graphic layer
55  * Some of them can change along the file
56  * There is one GERBER_FILE_IMAGE per file and one graphic layer per file or GERBER_FILE_IMAGE
57  * GerbView does not read and merge 2 gerber file in one graphic layer:
58  * I believe this is not possible due to the constraints in Image parameters.
59  * GERBER_LAYER : containing the subset of parameters that is layer speficic
60  * A GERBER_FILE_IMAGE must include one GERBER_LAYER to define all parameters to plot a file.
61  * But a GERBER_FILE_IMAGE can use more than one GERBER_LAYER.
62  */
63 
64 class GERBER_FILE_IMAGE;
65 class X2_ATTRIBUTE;
67 
68 // For arcs, coordinates need 3 info: start point, end point and center or radius
69 // In Excellon files it can be a A## value (radius) or I#J# center coordinates (like in gerber)
70 // We need to know the last read type when reading a list of routing coordinates
72 {
74  ARC_INFO_TYPE_CENTER, // last info is a IJ command: arc center is given
75  ARC_INFO_TYPE_RADIUS, // last info is a A command: arc radius is given
76 };
77 
79 {
80  friend class GERBER_FILE_IMAGE;
81 public:
82 
83  // These parameters are layer specfic:
84  wxString m_LayerName; // Layer name, from LN <name>* command
85  bool m_LayerNegative; // true = Negative Layer: command LP
86  wxRealPoint m_StepForRepeat; // X and Y offsets for Step and Repeat command
87  int m_XRepeatCount; // The repeat count on X axis
88  int m_YRepeatCount; // The repeat count on Y axis
89  bool m_StepForRepeatMetric; // false = Inches, true = metric
90  // needed here because repeated
91  // gerber items can have coordinates
92  // in different units than step parameters
93  // and the actual coordinates calculation must handle this
94 
95 public:
96  GERBER_LAYER();
97  ~GERBER_LAYER();
98 private:
99  void ResetDefaultValues();
100 };
101 
108 {
109  D_CODE* m_Aperture_List[TOOLS_MAX_COUNT];
110  bool m_Exposure;
111 
112  GERBER_LAYER m_GBRLayerParams; // hold params for the current gerber layer
113 
114 public:
115  DLIST<GERBER_DRAW_ITEM> m_Drawings; // linked list of Gerber Items to draw
116 
117  bool m_InUse; // true if this image is currently in use
118  // (a file is loaded in it)
119  bool m_IsVisible; // true if the draw layer is visible and must be drawn
120  // false if it must be not drawn
121  COLOR4D m_PositiveDrawColor; // The color used to draw positive items
122  wxString m_FileName; // Full File Name for this layer
123  wxString m_ImageName; // Image name, from IN <name>* command
124  bool m_IsX2_file; // true if a X2 gerber attribute was found in file
125  X2_ATTRIBUTE_FILEFUNCTION* m_FileFunction; // file function parameters, found in a %TF command
126  // or a G04
127  wxString m_MD5_value; // MD5 value found in a %TF.MD5 command
128  wxString m_PartString; // string found in a %TF.Part command
129  int m_GraphicLayer; // Graphic layer Number
130  bool m_ImageNegative; // true = Negative image
131  bool m_ImageJustifyXCenter; // Image Justify Center on X axis (default = false)
132  bool m_ImageJustifyYCenter; // Image Justify Center on Y axis (default = false)
133  wxPoint m_ImageJustifyOffset; // Image Justify Offset on XY axis (default = 0,0)
134  bool m_GerbMetric; // false = Inches, true = metric
135  bool m_Relative; // false = absolute Coord, true = relative Coord
136  bool m_NoTrailingZeros; // true: remove tailing zeros.
137  wxPoint m_ImageOffset; // Coord Offset, from IO command
138  wxSize m_FmtScale; // Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4
139  wxSize m_FmtLen; // Nb chars per coord. ex fmt 2.3, m_FmtLen = 5
140  int m_ImageRotation; // Image rotation (0, 90, 180, 270 only) in degrees
141  double m_LocalRotation; // Local rotation, in degrees, added to m_ImageRotation
142  // Note this value is stored in 0.1 degrees
143  wxPoint m_Offset; // Coord Offset, from OF command
144  wxRealPoint m_Scale; // scale (X and Y) of layer.
145  bool m_SwapAxis; // false (default) if A = X and B = Y
146  // true if A = Y, B = X
147  bool m_MirrorA; // true: miror / axe A (X)
148  bool m_MirrorB; // true: miror / axe B (Y)
149  int m_Iterpolation; // Linear, 90 arc, Circ.
150  int m_Current_Tool; // Current Tool (Dcode) number selected
151  int m_Last_Pen_Command; // Current or last pen state (0..9, set by Dn option with n <10
152  int m_CommandState; // state of gerber analysis command.
153  int m_LineNum; // Line number of the gerber file while reading
154  wxPoint m_CurrentPos; // current specified coord for plot
155  wxPoint m_PreviousPos; // old current specified coord for plot
156  wxPoint m_IJPos; // IJ coord (for arcs & circles )
157  int m_ArcRadius; // A value ( = radius in circular routing in Excellon files )
158  LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType; // Identifier for arc data type (IJ (center) or A## (radius))
159  FILE* m_Current_File; // Current file to read
160 
161  int m_Selected_Tool; // For hightlight: current selected Dcode
162  bool m_Has_DCode; // true = DCodes in file
163  // (false = no DCode -> separate DCode file
164  bool m_360Arc_enbl; // Enbl 360 deg circular interpolation
165  bool m_PolygonFillMode; // Enable polygon mode (read coord as a polygon descr)
166  int m_PolygonFillModeState; // In polygon mode: 0 = first segm, 1 = next segm
167 
169 
170  GBR_NETLIST_METADATA m_NetAttributeDict; // the net attributes set by a %TO.CN, %TO.C and/or %TO.N
171  // add object attribute command.
172  wxString m_AperFunction; // the aperture function set by a %TA.AperFunction, xxx
173  // (stores thre xxx value).
174 
175  std::map<wxString, int> m_ComponentsList; // list of components
176  std::map<wxString, int> m_NetnamesList; // list of net names
177 
178 private:
179  wxArrayString m_messagesList; // A list of messages created when reading a file
180  int m_hasNegativeItems; // true if the image is negative or has some negative items
181  // Used to optimize drawing, because when there are no
182  // negative items screen refresh does not need
183  // to build an intermediate bitmap specfic to this image
184  // -1 = negative items are
185  // 0 = no negative items found
186  // 1 = have negative items found
198  char* GetNextLine( char *aBuff, unsigned int aBuffSize, char* aText, FILE* aFile );
199 
200  bool GetEndOfBlock( char* aBuff, unsigned int aBuffSize, char*& aText, FILE* aGerberFile );
201 
205  bool ReadRS274XCommand( char *aBuff, unsigned int aBuffSize, char*& aText );
206 
210  bool ExecuteRS274XCommand( int aCommand, char* aBuff,
211  unsigned int aBuffSize, char*& aText );
212 
221  int ReadXCommandID( char*& text );
222 
233  bool ReadApertureMacro( char *aBuff, unsigned int aBuffSize,
234  char* & text, FILE * gerber_file );
235 
236  // functions to execute G commands or D basic commands:
237  bool Execute_G_Command( char*& text, int G_command );
238  bool Execute_DCODE_Command( char*& text, int D_command );
239 
240 public:
241  GERBER_FILE_IMAGE( int layer );
242  virtual ~GERBER_FILE_IMAGE();
243 
244  wxString GetClass() const override
245  {
246  return wxT( "GERBER_FILE_IMAGE" );
247  }
248 
249  void Clear_GERBER_FILE_IMAGE();
250 
258  bool LoadGerberFile( const wxString& aFullFileName );
259 
260  const wxArrayString& GetMessages() const { return m_messagesList; }
261 
265  int GetDcodesCount();
266 
267  virtual void ResetDefaultValues();
268 
269  COLOR4D GetPositiveDrawColor() const { return m_PositiveDrawColor; }
270 
275  GERBER_DRAW_ITEM * GetItemsList();
276 
282  {
283  return m_GBRLayerParams;
284  }
285 
292  bool HasNegativeItems();
293 
300  {
301  m_messagesList.Clear();
302  }
303 
308  void AddMessageToList( const wxString& aMessage )
309  {
310  m_messagesList.Add( aMessage );
311  }
312 
316  void InitToolTable();
317 
326  wxPoint ReadXYCoord( char*& aText, bool aExcellonMode = false );
327 
333  wxPoint ReadIJCoord( char*& Text );
334 
335  // functions to read G commands or D commands:
336  int GCodeNumber( char*& Text );
337  int DCodeNumber( char*& Text );
338 
349  D_CODE* GetDCODEOrCreate( int aDCODE, bool aCreateIfNoExist = true );
350 
359  D_CODE* GetDCODE( int aDCODE ) const;
360 
368  APERTURE_MACRO* FindApertureMacro( const APERTURE_MACRO& aLookup );
369 
378  void StepAndRepeatItem( const GERBER_DRAW_ITEM& aItem );
379 
387  void DisplayImageInfo( GERBVIEW_FRAME* aMainFrame );
388 
399  void RemoveAttribute( X2_ATTRIBUTE& aAttribute );
400 
402  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
403 
404 #if defined(DEBUG)
405 
406  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
407 
408 #endif
409 };
410 
411 #endif // ifndef GERBER_FILE_IMAGE_H
friend class GERBER_FILE_IMAGE
COLOR4D GetPositiveDrawColor() const
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
class X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF...
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
wxString m_LayerName
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
class X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma ...
wxString GetClass() const override
Function GetClass returns the class name.
wxRealPoint m_StepForRepeat
Class GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters ...
void ClearMessageList()
Function ClearMessageList Clear the message list Call it before reading a Gerber file.
this class handle info which can be added in a gerber file as attribute of an obtect the GBR_INFO_TYP...
wxArrayString m_messagesList
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:102
GERBER_LAYER m_GBRLayerParams
const wxArrayString & GetMessages() const
bool m_StepForRepeatMetric
std::map< wxString, int > m_NetnamesList
std::set< APERTURE_MACRO, APERTURE_MACRO_less_than > APERTURE_MACRO_SET
Type APERTURE_MACRO_SET is a sorted collection of APERTURE_MACROS whose key is the name field in the ...
Definition: am_primitive.h:258
bool m_Exposure
whether an aperture macro tool is flashed on or off
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
Class D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
DLIST< GERBER_DRAW_ITEM > m_Drawings
GBR_NETLIST_METADATA m_NetAttributeDict
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163
SEARCH_RESULT
Definition: base_struct.h:66
std::map< wxString, int > m_ComponentsList
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.
LAST_EXTRA_ARC_DATA_TYPE
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39