KiCad PCB EDA Suite
gerber_file_image.cpp
Go to the documentation of this file.
1 
6 /*
7  * This program source code file is part of KiCad, a free EDA CAD application.
8  *
9  * Copyright (C) 1992-2016 Jean-Pierre Charras jp.charras at wanadoo.fr
10  * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, you may find one here:
24  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
25  * or you may search the http://www.gnu.org website for the version 2 license,
26  * or you may write to the Free Software Foundation, Inc.,
27  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
28  */
29 
30 #include <fctsys.h>
31 #include <common.h>
32 #include <macros.h>
33 #include <convert_to_biu.h>
34 #include <gerbview.h>
35 #include <gerbview_frame.h>
36 #include <gerber_file_image.h>
37 #include <X2_gerber_attributes.h>
38 #include <algorithm>
39 #include <map>
40 
41 
46 extern int scaletoIU( double aCoord, bool isMetric ); // defined it rs274d_read_XY_and_IJ_coordiantes.cpp
47 
48 /* Format Gerber: NOTES:
49  * Tools and D_CODES
50  * tool number (identification of shapes)
51  * 1 to 999
52  *
53  * D_CODES:
54  * D01 ... D9 = action codes:
55  * D01 = activating light (lower pen) when di placement
56  * D02 = light extinction (lift pen) when di placement
57  * D03 Flash
58  * D09 = VAPE Flash
59  * D10 ... = Indentification Tool (Opening)
60  *
61  * For tools:
62  * DCode min = D10
63  * DCode max = 999
64  */
65 
66 
68 {
70 }
71 
72 
74 {
75 }
76 
77 
79 {
80  m_LayerName = wxT( "no name" ); // Layer name from the LN command
81  m_LayerNegative = false; // true = Negative Layer
82  m_StepForRepeat.x = m_StepForRepeat.y = 0; // X and Y offsets for Step and Repeat command
83  m_XRepeatCount = 1; // The repeat count on X axis
84  m_YRepeatCount = 1; // The repeat count on Y axis
85  m_StepForRepeatMetric = false; // false = Inches, true = metric
86 }
87 
88 
91 {
92  m_GraphicLayer = aLayer; // Graphic layer Number
93  m_IsVisible = true; // must be drawn
94  m_PositiveDrawColor = WHITE; // The color used to draw positive items for this image
95 
96  m_Selected_Tool = 0;
97  m_FileFunction = NULL; // file function parameters
98 
100 
101  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
102  m_Aperture_List[ii] = 0;
103 }
104 
105 
107 {
109 
110  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
111  {
112  delete m_Aperture_List[ii];
113  }
114 
115  delete m_FileFunction;
116 }
117 
118 /*
119  * Function GetItemsList
120  * returns the first GERBER_DRAW_ITEM * item of the items list
121  */
123 {
124  return m_Drawings;
125 }
126 
127 
128 D_CODE* GERBER_FILE_IMAGE::GetDCODEOrCreate( int aDCODE, bool aCreateIfNoExist )
129 {
130  unsigned ndx = aDCODE - FIRST_DCODE;
131 
132  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
133  {
134  // lazily create the D_CODE if it does not exist.
135  if( aCreateIfNoExist )
136  {
137  if( m_Aperture_List[ndx] == NULL )
138  m_Aperture_List[ndx] = new D_CODE( ndx + FIRST_DCODE );
139  }
140 
141  return m_Aperture_List[ndx];
142  }
143 
144  return NULL;
145 }
146 
147 
149 {
150  unsigned ndx = aDCODE - FIRST_DCODE;
151 
152  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
153  {
154  return m_Aperture_List[ndx];
155  }
156 
157  return NULL;
158 }
159 
160 
162 {
163  APERTURE_MACRO_SET::iterator iter = m_aperture_macros.find( aLookup );
164 
165  if( iter != m_aperture_macros.end() )
166  {
167  APERTURE_MACRO* pam = (APERTURE_MACRO*) &(*iter);
168  return pam;
169  }
170 
171  return NULL; // not found
172 }
173 
174 
176 {
177  m_InUse = false;
179  m_FileName.Empty();
180  m_ImageName = wxT( "no name" ); // Image name from the IN command
181  m_ImageNegative = false; // true = Negative image
182  m_IsX2_file = false; // true only if a %TF, %TA or %TD command
183  delete m_FileFunction; // file function parameters
184  m_FileFunction = NULL;
185  m_MD5_value.Empty(); // MD5 value found in a %TF.MD5 command
186  m_PartString.Empty(); // string found in a %TF.Part command
187  m_hasNegativeItems = -1; // set to uninitialized
188  m_ImageJustifyOffset = wxPoint(0,0); // Image justify Offset
189  m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
190  m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
191  m_GerbMetric = false; // false = Inches (default), true = metric
192  m_Relative = false; // false = absolute Coord,
193  // true = relative Coord
194  m_NoTrailingZeros = false; // true: trailing zeros deleted
195  m_ImageOffset.x = m_ImageOffset.y = 0; // Coord Offset, from IO command
196  m_ImageRotation = 0; // Allowed 0, 90, 180, 270 (in degree)
197  m_LocalRotation = 0.0; // Layer totation from RO command (in 0.1 degree)
198  m_Offset.x = 0;
199  m_Offset.y = 0; // Coord Offset, from OF command
200  m_Scale.x = m_Scale.y = 1.0; // scale (A and B) this layer
201  m_MirrorA = false; // true: miror / axe A (default = X)
202  m_MirrorB = false; // true: miror / axe B (default = Y)
203  m_SwapAxis = false; // false if A = X, B = Y; true if A =Y, B = Y
204  m_Has_DCode = false; // true = DCodes in file
205  // false = no DCode-> perhaps deprecated RS274D file
206  m_Has_MissingDCode = false; // true = some D_Codes are used, but not defined
207  // perhaps deprecated RS274D file
208  m_FmtScale.x = m_FmtScale.y = 4; // Initialize default format to 3.4 => 4
209  m_FmtLen.x = m_FmtLen.y = 3 + 4; // Initialize default format len = 3+4
210 
211  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Linear, 90 arc, Circ.
212  m_360Arc_enbl = false; // 360 deg circular
213  // interpolation disable
214  m_Current_Tool = 0; // Current Dcode selected
215  m_CommandState = 0; // State of the current command
216  m_CurrentPos.x = m_CurrentPos.y = 0; // current specified coord
217  m_PreviousPos.x = m_PreviousPos.y = 0; // last specified coord
218  m_IJPos.x = m_IJPos.y = 0; // current centre coord for
219  // plot arcs & circles
220  m_LastCoordIsIJPos = false; // True only after a IJ coordinate is read
221  m_ArcRadius = 0; // radius of arcs in circular interpol (given by A## command).
222  // in command like X##Y##A##
223  m_LastArcDataType = ARC_INFO_TYPE_NONE; // Extra coordinate info type for arcs
224  // (radius or IJ center coord)
225  m_LineNum = 0; // line number in file being read
226  m_Current_File = NULL; // Gerber file to read
227  m_PolygonFillMode = false;
229  m_Selected_Tool = 0;
230  m_Last_Pen_Command = 0;
231  m_Exposure = false;
232 }
233 
234 
235 /* Function HasNegativeItems
236  * return true if at least one item must be drawn in background color
237  * used to optimize screen refresh
238  */
240 {
241  if( m_hasNegativeItems < 0 ) // negative items are not yet searched: find them if any
242  {
243  if( m_ImageNegative ) // A negative layer is expected having always negative objects.
244  m_hasNegativeItems = 1;
245  else
246  {
247  m_hasNegativeItems = 0;
248  for( GERBER_DRAW_ITEM* item = GetItemsList(); item; item = item->Next() )
249  {
250  if( item->GetLayer() != m_GraphicLayer )
251  continue;
252  if( item->HasNegativeItems() )
253  {
254  m_hasNegativeItems = 1;
255  break;
256  }
257  }
258  }
259  }
260  return m_hasNegativeItems == 1;
261 }
262 
264 {
265  int count = 0;
266 
267  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
268  {
269  if( m_Aperture_List[ii] )
270  if( m_Aperture_List[ii]->m_InUse || m_Aperture_List[ii]->m_Defined )
271  ++count;
272  }
273 
274  return count;
275 }
276 
277 
279 {
280  for( int count = 0; count < TOOLS_MAX_COUNT; count++ )
281  {
282  if( m_Aperture_List[count] == NULL )
283  continue;
284 
285  m_Aperture_List[count]->m_Num_Dcode = count + FIRST_DCODE;
287  }
288 
289  m_aperture_macros.clear();
290 }
291 
292 
302 {
303  if( GetLayerParams().m_XRepeatCount < 2 &&
304  GetLayerParams().m_YRepeatCount < 2 )
305  return; // Nothing to repeat
306 
307  // Duplicate item:
308  for( int ii = 0; ii < GetLayerParams().m_XRepeatCount; ii++ )
309  {
310  for( int jj = 0; jj < GetLayerParams().m_YRepeatCount; jj++ )
311  {
312  // the first gerber item already exists (this is the template)
313  // create duplicate only if ii or jj > 0
314  if( jj == 0 && ii == 0 )
315  continue;
316  GERBER_DRAW_ITEM* dupItem = new GERBER_DRAW_ITEM( aItem );
317  wxPoint move_vector;
318  move_vector.x = scaletoIU( ii * GetLayerParams().m_StepForRepeat.x,
319  GetLayerParams().m_StepForRepeatMetric );
320  move_vector.y = scaletoIU( jj * GetLayerParams().m_StepForRepeat.y,
321  GetLayerParams().m_StepForRepeatMetric );
322  dupItem->MoveXY( move_vector );
323  m_Drawings.Append( dupItem );
324  }
325  }
326 }
327 
328 
338 {
339  wxString msg;
340 
341  aMainFrame->ClearMsgPanel();
342 
343  // Display Image name (Image specific)
344  aMainFrame->AppendMsgPanel( _( "Image name" ), m_ImageName, CYAN );
345 
346  // Display graphic layer number used to draw this Image
347  // (not a Gerber parameter but is also image specific)
348  msg.Printf( wxT( "%d" ), m_GraphicLayer + 1 );
349  aMainFrame->AppendMsgPanel( _( "Graphic layer" ), msg, BROWN );
350 
351  // Display Image rotation (Image specific)
352  msg.Printf( wxT( "%d" ), m_ImageRotation );
353  aMainFrame->AppendMsgPanel( _( "Img Rot." ), msg, CYAN );
354 
355  // Display Image polarity (Image specific)
356  msg = m_ImageNegative ? _("Negative") : _("Normal");
357  aMainFrame->AppendMsgPanel( _( "Polarity" ), msg, BROWN );
358 
359  // Display Image justification and offset for justification (Image specific)
360  msg = m_ImageJustifyXCenter ? _("Center") : _("Normal");
361  aMainFrame->AppendMsgPanel( _( "X Justify" ), msg, DARKRED );
362 
363  msg = m_ImageJustifyYCenter ? _("Center") : _("Normal");
364  aMainFrame->AppendMsgPanel( _( "Y Justify" ), msg, DARKRED );
365 
366  if( aMainFrame->GetUserUnits() == INCHES )
367  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Mils( m_ImageJustifyOffset.x ) / 1000.0,
368  Iu2Mils( m_ImageJustifyOffset.y ) / 1000.0 );
369  else
370  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Millimeter( m_ImageJustifyOffset.x ),
371  Iu2Millimeter( m_ImageJustifyOffset.y ) );
372 
373  aMainFrame->AppendMsgPanel( _( "Image Justify Offset" ), msg, DARKRED );
374 }
375 
376 
378 {
379  /* Called when a %TD command is found
380  * Remove the attribute specified by the %TD command.
381  * is no attribute, all current attributes specified by the %TO and the %TA
382  * commands are cleared.
383  * if a attribute name is specified (for instance %TD.CN*%) is specified,
384  * only this attribute is cleared
385  */
386  m_NetAttributeDict.ClearAttribute( &aAttribute.GetPrm( 1 ) );
387 
388  if( aAttribute.GetPrm( 1 ).IsEmpty() || aAttribute.GetPrm( 1 ) == ".AperFunction" )
389  m_AperFunction.Clear();
390 }
391 
392 
393 SEARCH_RESULT GERBER_FILE_IMAGE::Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
394 {
395  KICAD_T stype;
397  const KICAD_T* p = scanTypes;
398  bool done = false;
399 
400 #if 0 && defined(DEBUG)
401  std::cout << GetClass().mb_str() << ' ';
402 #endif
403 
404  while( !done )
405  {
406  stype = *p;
407 
408  switch( stype )
409  {
410  case GERBER_IMAGE_T:
411  case GERBER_IMAGE_LIST_T:
412  ++p;
413  break;
414 
415  case GERBER_DRAW_ITEM_T:
416  result = IterateForward( &m_Drawings[0], inspector, testData, p );
417  ++p;
418  break;
419 
420  default: // catch EOT or ANY OTHER type here and return.
421  done = true;
422  break;
423  }
424 
425  if( result == SEARCH_QUIT )
426  break;
427  }
428 
429  return result;
430 }
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
wxString m_LayerName
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
bool HasNegativeItems()
Function HasNegativeItems.
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.
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
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.
int scaletoIU(double aCoord, bool isMetric)
Function scaletoIU converts a distance given in floating point to our internal units.
const wxString & GetPrm(int aIdx)
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:44
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
Definition: colors.h:54
This file contains miscellaneous commonly used macros and functions.
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
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...
GERBER_LAYER m_GBRLayerParams
#define FIRST_DCODE
Definition: dcode.h:71
Definition: common.h:134
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:96
Definition: colors.h:59
static SEARCH_RESULT IterateForward(EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function IterateForward walks through the object tree calling the inspector() on each object type req...
Definition: base_struct.h:418
APERTURE_MACRO * FindApertureMacro(const APERTURE_MACRO &aLookup)
Function FindApertureMacro looks up a previously read in aperture macro.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
bool m_StepForRepeatMetric
#define _(s)
void RemoveAttribute(X2_ATTRIBUTE &aAttribute)
Function RemoveAttribute.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
GERBER_DRAW_ITEM * Next() const
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
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
EDA_UNITS_T GetUserUnits() const
Return the user units currently in use.
DLIST< GERBER_DRAW_ITEM > m_Drawings
GERBER_DRAW_ITEM * GetItemsList()
Function GetItemsList.
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:163
The common library.
Definition: colors.h:49
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes
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 MoveXY(const wxPoint &aMoveVector)
Function MoveXY move this object.
void StepAndRepeatItem(const GERBER_DRAW_ITEM &aItem)
Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called wh...
void Clear_D_CODE_Data()
Definition: dcode.cpp:77
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()
Definition: colors.h:62