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-2019 Jean-Pierre Charras jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2019 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 typedef std::vector<GERBER_DRAW_ITEM*> GERBER_DRAW_ITEMS;
41 
42 class GERBVIEW_FRAME;
43 class D_CODE;
44 
45 /* gerber files have different parameters to define units and how items must be plotted.
46  * some are for the entire file, and other can change along a file.
47  * In Gerber world:
48  * an image is the entire gerber file and its "global" parameters
49  * a layer (that is very different from a board layer) is just a sub set of a file that
50  * have specific parameters
51  * if a Image parameter is set more than once, only the last value is used
52  * Some parameters can change along a file and are not layer specific: they are stored
53  * in GERBER_ITEM items, when instancied.
54  *
55  * In GerbView, to handle these parameters, there are 2 classes:
56  * GERBER_FILE_IMAGE : the main class containing most of parameters and data to plot a graphic layer
57  * Some of them can change along the file
58  * There is one GERBER_FILE_IMAGE per file and one graphic layer per file or GERBER_FILE_IMAGE
59  * GerbView does not read and merge 2 gerber file in one graphic layer:
60  * I believe this is not possible due to the constraints in Image parameters.
61  * GERBER_LAYER : containing the subset of parameters that is layer speficic
62  * A GERBER_FILE_IMAGE must include one GERBER_LAYER to define all parameters to plot a file.
63  * But a GERBER_FILE_IMAGE can use more than one GERBER_LAYER.
64  */
65 
66 class GERBER_FILE_IMAGE;
67 class X2_ATTRIBUTE;
69 
70 // For arcs, coordinates need 3 info: start point, end point and center or radius
71 // In Excellon files it can be a A## value (radius) or I#J# center coordinates (like in gerber)
72 // We need to know the last read type when reading a list of routing coordinates
74 {
76  ARC_INFO_TYPE_CENTER, // last info is a IJ command: arc center is given
77  ARC_INFO_TYPE_RADIUS, // last info is a A command: arc radius is given
78 };
79 
81 {
82  friend class GERBER_FILE_IMAGE;
83 public:
84 
85  // These parameters are layer specfic:
86  wxString m_LayerName; // Layer name, from LN <name>* command
87  bool m_LayerNegative; // true = Negative Layer: command LP
88  wxRealPoint m_StepForRepeat; // X and Y offsets for Step and Repeat command
89  int m_XRepeatCount; // The repeat count on X axis
90  int m_YRepeatCount; // The repeat count on Y axis
91  bool m_StepForRepeatMetric; // false = Inches, true = metric
92  // needed here because repeated
93  // gerber items can have coordinates
94  // in different units than step parameters
95  // and the actual coordinates calculation must handle this
96 
97 public:
98  GERBER_LAYER();
99  ~GERBER_LAYER();
100 private:
101  void ResetDefaultValues();
102 };
103 
110 {
112  bool m_Exposure;
114 
115  GERBER_LAYER m_GBRLayerParams; // hold params for the current gerber layer
116  GERBER_DRAW_ITEMS m_drawings; // linked list of Gerber Items to draw
117 
118 public:
119  bool m_InUse; // true if this image is currently in use
120  // (a file is loaded in it)
121  bool m_IsVisible; // true if the draw layer is visible and must be drawn
122  // false if it must be not drawn
123  COLOR4D m_PositiveDrawColor; // The color used to draw positive items
124  wxString m_FileName; // Full File Name for this layer
125  wxString m_ImageName; // Image name, from IN <name>* command
126  bool m_IsX2_file; // true if a X2 gerber attribute was found in file
127  X2_ATTRIBUTE_FILEFUNCTION* m_FileFunction; // file function parameters, found in a %TF command
128  // or a G04
129  wxString m_MD5_value; // MD5 value found in a %TF.MD5 command
130  wxString m_PartString; // string found in a %TF.Part command
131  int m_GraphicLayer; // Graphic layer Number
132  bool m_ImageNegative; // true = Negative image
133  bool m_ImageJustifyXCenter; // Image Justify Center on X axis (default = false)
134  bool m_ImageJustifyYCenter; // Image Justify Center on Y axis (default = false)
135  wxPoint m_ImageJustifyOffset; // Image Justify Offset on XY axis (default = 0,0)
136  bool m_GerbMetric; // false = Inches, true = metric
137  bool m_Relative; // false = absolute Coord, true = relative Coord
138  bool m_NoTrailingZeros; // true: remove tailing zeros.
139  wxPoint m_ImageOffset; // Coord Offset, from IO command
140  wxSize m_FmtScale; // Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4
141  wxSize m_FmtLen; // Nb chars per coord. ex fmt 2.3, m_FmtLen = 5
142  int m_ImageRotation; // Image rotation (0, 90, 180, 270 only) in degrees
143  double m_LocalRotation; // Local rotation, in degrees, added to m_ImageRotation
144  // Note this value is stored in 0.1 degrees
145  wxPoint m_Offset; // Coord Offset, from OF command
146  wxRealPoint m_Scale; // scale (X and Y) of layer.
147  bool m_SwapAxis; // false (default) if A = X and B = Y
148  // true if A = Y, B = X
149  bool m_MirrorA; // true: miror / axe A (X)
150  bool m_MirrorB; // true: miror / axe B (Y)
151  int m_Iterpolation; // Linear, 90 arc, Circ.
152  int m_Current_Tool; // Current Tool (Dcode) number selected
153  int m_Last_Pen_Command; // Current or last pen state (0..9, set by Dn option with n <10
154  int m_CommandState; // state of gerber analysis command.
155  int m_LineNum; // Line number of the gerber file while reading
156  wxPoint m_CurrentPos; // current specified coord for plot
157  wxPoint m_PreviousPos; // old current specified coord for plot
158  wxPoint m_IJPos; // IJ coord (for arcs & circles )
159  bool m_LastCoordIsIJPos; // true if a IJ coord was read (for arcs & circles )
160  int m_ArcRadius; // A value ( = radius in circular routing in Excellon files )
161  LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType; // Identifier for arc data type (IJ (center) or A## (radius))
162  FILE* m_Current_File; // Current file to read
163 
164  int m_Selected_Tool; // For highlight: current selected Dcode
165  bool m_Has_DCode; // true = DCodes in file
166  // false = no DCode -> perhaps deprecated RS274D file
167  bool m_Has_MissingDCode; // true = some DCodes in file are not defined
168  // (broken file or deprecated RS274D file)
169  bool m_360Arc_enbl; // Enbl 360 deg circular interpolation
170  bool m_PolygonFillMode; // Enable polygon mode (read coord as a polygon descr)
171  int m_PolygonFillModeState; // In polygon mode: 0 = first segm, 1 = next segm
172 
174 
175  GBR_NETLIST_METADATA m_NetAttributeDict; // the net attributes set by a %TO.CN, %TO.C and/or %TO.N
176  // add object attribute command.
177  wxString m_AperFunction; // the aperture function set by a %TA.AperFunction, xxx
178  // (stores thre xxx value).
179 
180  std::map<wxString, int> m_ComponentsList; // list of components
181  std::map<wxString, int> m_NetnamesList; // list of net names
182 
183 private:
184  wxArrayString m_messagesList; // A list of messages created when reading a file
185  int m_hasNegativeItems; // true if the image is negative or has some negative items
186  // Used to optimize drawing, because when there are no
187  // negative items screen refresh does not need
188  // to build an intermediate bitmap specfic to this image
189  // -1 = negative items are
190  // 0 = no negative items found
191  // 1 = have negative items found
203  char* GetNextLine( char *aBuff, unsigned int aBuffSize, char* aText, FILE* aFile );
204 
205  bool GetEndOfBlock( char* aBuff, unsigned int aBuffSize, char*& aText, FILE* aGerberFile );
206 
210  bool ReadRS274XCommand( char *aBuff, unsigned int aBuffSize, char*& aText );
211 
215  bool ExecuteRS274XCommand( int aCommand, char* aBuff,
216  unsigned int aBuffSize, char*& aText );
217 
226  int ReadXCommandID( char*& text );
227 
238  bool ReadApertureMacro( char *aBuff, unsigned int aBuffSize,
239  char* & text, FILE * gerber_file );
240 
241  // functions to execute G commands or D basic commands:
242  bool Execute_G_Command( char*& text, int G_command );
243  bool Execute_DCODE_Command( char*& text, int D_command );
244 
245 public:
246  GERBER_FILE_IMAGE( int layer );
247  virtual ~GERBER_FILE_IMAGE();
248 
249  wxString GetClass() const override
250  {
251  return wxT( "GERBER_FILE_IMAGE" );
252  }
253 
261  bool LoadGerberFile( const wxString& aFullFileName );
262 
263  const wxArrayString& GetMessages() const { return m_messagesList; }
264 
268  int GetDcodesCount();
269 
270  virtual void ResetDefaultValues();
271 
273 
278 
282  int GetItemsCount() { return m_drawings.size(); }
283 
289  {
290  m_drawings.push_back( aItem );
291  }
292 
297  {
298  return m_drawings.back();
299  }
300 
306  {
307  return m_GBRLayerParams;
308  }
309 
316  bool HasNegativeItems();
317 
324  {
325  m_messagesList.Clear();
326  }
327 
332  void AddMessageToList( const wxString& aMessage )
333  {
334  m_messagesList.Add( aMessage );
335  }
336 
340  void InitToolTable();
341 
350  wxPoint ReadXYCoord( char*& aText, bool aExcellonMode = false );
351 
357  wxPoint ReadIJCoord( char*& Text );
358 
359  // functions to read G commands or D commands:
360  int GCodeNumber( char*& Text );
361  int DCodeNumber( char*& Text );
362 
373  D_CODE* GetDCODEOrCreate( int aDCODE, bool aCreateIfNoExist = true );
374 
383  D_CODE* GetDCODE( int aDCODE ) const;
384 
393 
402  void StepAndRepeatItem( const GERBER_DRAW_ITEM& aItem );
403 
411  void DisplayImageInfo( GERBVIEW_FRAME* aMainFrame );
412 
423  void RemoveAttribute( X2_ATTRIBUTE& aAttribute );
424 
426  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
427 
428 #if defined(DEBUG)
429 
430  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
431 
432 #endif
433 };
434 
435 #endif // ifndef GERBER_FILE_IMAGE_H
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
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
bool HasNegativeItems()
Function HasNegativeItems.
X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma.
bool Execute_DCODE_Command(char *&text, int D_command)
Definition: rs274d.cpp:582
wxString GetClass() const override
Function GetClass returns the class name.
GERBER_DRAW_ITEMS & GetItems()
wxPoint ReadIJCoord(char *&Text)
Returns the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) These coordinates are rela...
wxRealPoint m_StepForRepeat
GERBER_FILE_IMAGE(int layer)
D_CODE * GetDCODE(int aDCODE) const
Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE.
GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO:...
COLOR4D GetPositiveDrawColor() const
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 object the GBR_INFO_TYP...
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
wxArrayString m_messagesList
int ReadXCommandID(char *&text)
reads two bytes of data and assembles them into an int with the first byte in the sequence put into t...
Definition: rs274x.cpp:116
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
int GCodeNumber(char *&Text)
Definition: rs274d.cpp:411
bool ExecuteRS274XCommand(int aCommand, char *aBuff, unsigned int aBuffSize, char *&aText)
executes a RS274X command
Definition: rs274x.cpp:197
GERBER_DRAW_ITEMS m_drawings
GERBER_DRAW_ITEM * GetLastItemInList() const
char * GetNextLine(char *aBuff, unsigned int aBuffSize, char *aText, FILE *aFile)
test for an end of line if a end of line is found: read a new line
Definition: rs274x.cpp:890
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:108
void DisplayImageInfo(GERBVIEW_FRAME *aMainFrame)
Function DisplayImageInfo has knowledge about the frame and how and where to put status information a...
void AddItemToList(GERBER_DRAW_ITEM *aItem)
Add a new GERBER_DRAW_ITEM item to the drawings list.
GERBER_LAYER m_GBRLayerParams
int DCodeNumber(char *&Text)
Definition: rs274d.cpp:434
const wxArrayString & GetMessages() const
bool LoadGerberFile(const wxString &aFullFileName)
Read and load a gerber file.
Definition: readgerb.cpp:117
std::vector< GERBER_DRAW_ITEM * > GERBER_DRAW_ITEMS
APERTURE_MACRO * FindApertureMacro(const APERTURE_MACRO &aLookup)
Function FindApertureMacro looks up a previously read in aperture macro.
bool m_StepForRepeatMetric
wxPoint ReadXYCoord(char *&aText, bool aExcellonMode=false)
Function ReadXYCoord Returns the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm)
bool ReadApertureMacro(char *aBuff, unsigned int aBuffSize, char *&text, FILE *gerber_file)
reads in an aperture macro and saves it in m_aperture_macros.
Definition: rs274x.cpp:918
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
void RemoveAttribute(X2_ATTRIBUTE &aAttribute)
Function RemoveAttribute.
bool m_Exposure
whether an aperture macro tool is flashed on or off
bool Execute_G_Command(char *&text, int G_command)
Definition: rs274d.cpp:454
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
GBR_NETLIST_METADATA m_NetAttributeDict
bool ReadRS274XCommand(char *aBuff, unsigned int aBuffSize, char *&aText)
reads a single RS274X command terminated with a %
Definition: rs274x.cpp:144
bool GetEndOfBlock(char *aBuff, unsigned int aBuffSize, char *&aText, FILE *aGerberFile)
Definition: rs274x.cpp:864
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:163
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163
void InitToolTable()
Function InitToolTable.
SEARCH_RESULT
Definition: base_struct.h:54
void StepAndRepeatItem(const GERBER_DRAW_ITEM &aItem)
Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called wh...
std::map< wxString, int > m_ComponentsList
D_CODE * GetDCODEOrCreate(int aDCODE, bool aCreateIfNoExist=true)
Function GetDCODEOrCreate returns a pointer to the D_CODE within this GERBER for the given aDCODE.
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.
virtual void ResetDefaultValues()
LAST_EXTRA_ARC_DATA_TYPE
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39