KiCad PCB EDA Suite
PCB_PLOT_PARAMS_PARSER Class Reference

Class PCB_PLOT_PARAMS_PARSER is the parser class for PCB_PLOT_PARAMS. More...

#include <pcb_plot_params_parser.h>

Inheritance diagram for PCB_PLOT_PARAMS_PARSER:

Public Member Functions

 PCB_PLOT_PARAMS_PARSER (LINE_READER *aReader)
 
 PCB_PLOT_PARAMS_PARSER (char *aLine, const wxString &aSource)
 
LINE_READERGetReader ()
 
void Parse (PCB_PLOT_PARAMS *aPcbPlotParams)
 

Private Member Functions

bool parseBool ()
 
int parseInt (int aMin, int aMax)
 Function parseInt parses an integer and constrains it between two values. More...
 
double parseDouble ()
 Function parseDouble parses a double. More...
 
void skipCurrent ()
 Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes the current description. More...
 

Detailed Description

Class PCB_PLOT_PARAMS_PARSER is the parser class for PCB_PLOT_PARAMS.

Definition at line 36 of file pcb_plot_params_parser.h.

Constructor & Destructor Documentation

PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER ( LINE_READER aReader)

Definition at line 337 of file pcb_plot_params.cpp.

337  :
338  PCB_PLOT_PARAMS_LEXER( aReader )
339 {
340 }
PCB_PLOT_PARAMS_PARSER::PCB_PLOT_PARAMS_PARSER ( char *  aLine,
const wxString &  aSource 
)

Definition at line 343 of file pcb_plot_params.cpp.

343  :
344  PCB_PLOT_PARAMS_LEXER( aLine, aSource )
345 {
346 }

Member Function Documentation

LINE_READER* PCB_PLOT_PARAMS_PARSER::GetReader ( )
inline

Definition at line 42 of file pcb_plot_params_parser.h.

References Parse(), parseBool(), parseDouble(), parseInt(), and skipCurrent().

42 { return reader; };
void PCB_PLOT_PARAMS_PARSER::Parse ( PCB_PLOT_PARAMS aPcbPlotParams)

Definition at line 349 of file pcb_plot_params.cpp.

References LSET::AllCuMask(), B_SilkS, F_SilkS, FILLED, FROM_UTF8(), gbrDefaultPrecision, HPGL_PEN_DIAMETER_MAX, HPGL_PEN_NUMBER_MAX, HPGL_PEN_NUMBER_MIN, HPGL_PEN_SPEED_MAX, HPGL_PEN_SPEED_MIN, KiROUND(), PCB_PLOT_PARAMS::m_A4Output, PCB_PLOT_PARAMS::m_createGerberJobFile, PCB_PLOT_PARAMS::m_drillMarks, PCB_PLOT_PARAMS::m_excludeEdgeLayer, PCB_PLOT_PARAMS::m_format, PCB_PLOT_PARAMS::m_gerberPrecision, PCB_PLOT_PARAMS::m_HPGLPenDiam, PCB_PLOT_PARAMS::m_HPGLPenNum, PCB_PLOT_PARAMS::m_HPGLPenSpeed, PCB_PLOT_PARAMS::m_includeGerberNetlistInfo, PCB_PLOT_PARAMS::m_layerSelection, PCB_PLOT_PARAMS::m_mirror, PCB_PLOT_PARAMS::m_negative, PCB_PLOT_PARAMS::m_outputDirectory, PCB_PLOT_PARAMS::m_plotFrameRef, PCB_PLOT_PARAMS::m_plotInvisibleText, PCB_PLOT_PARAMS::m_plotPadsOnSilkLayer, PCB_PLOT_PARAMS::m_plotReference, PCB_PLOT_PARAMS::m_plotValue, PCB_PLOT_PARAMS::m_plotViaOnMaskLayer, PCB_PLOT_PARAMS::m_scaleSelection, PCB_PLOT_PARAMS::m_subtractMaskFromSilk, PCB_PLOT_PARAMS::m_useAuxOrigin, PCB_PLOT_PARAMS::m_useGerberAttributes, PCB_PLOT_PARAMS::m_useGerberProtelExtensions, parseBool(), parseDouble(), LSET::ParseHex(), parseInt(), PLOT_FIRST_FORMAT, PLOT_LAST_FORMAT, PLOT_LINEWIDTH_DEFAULT, PCB_PLOT_PARAMS::SetLineWidth(), PCB_PLOT_PARAMS::SetPlotMode(), SKETCH, and skipCurrent().

Referenced by GetReader(), and PCB_PLOT_PARAMS::Parse().

350 {
351  T token;
352 
353  while( ( token = NextTok() ) != T_RIGHT )
354  {
355  if( token == T_EOF)
356  Unexpected( T_EOF );
357 
358  if( token == T_LEFT )
359  token = NextTok();
360 
361  if( token == T_pcbplotparams )
362  continue;
363 
364  bool skip_right = false;
365 
366  switch( token )
367  {
368  case T_layerselection:
369  {
370  token = NeedSYMBOLorNUMBER();
371 
372  const std::string& cur = CurStr();
373 
374  if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
375  {
376  // unsigned legacy_mask = atol( cur.c_str() );
377 
378  /* It's not possible to convert a legacy Cu layer number to a new
379  Cu layer number without knowing the number or total Cu layers
380  in the legacy board. We do not have that information here.
381  So simply set all layers ON. User can turn them off in the UI.
382  This is one of the superiorities of the new Cu sequence.
383  aPcbPlotParams->m_layerSelection = LEGACY_PLUGIN::leg_mask2new( cu_count, legacy_mask );
384  */
385 
386  // sorry, use the UI once to fix:
387  aPcbPlotParams->m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
388  }
389  else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
390  {
391  // skip the leading 2 0x bytes.
392  aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str()+2, cur.size()-2 );
393  }
394  else
395  Expecting( "integer or hex layerSelection" );
396  }
397  break;
398 
399  case T_usegerberextensions:
400  aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
401  break;
402 
403  case T_usegerberattributes:
404  aPcbPlotParams->m_useGerberAttributes = parseBool();
405  break;
406 
407  case T_usegerberadvancedattributes:
408  aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
409  break;
410 
411  case T_creategerberjobfile:
412  aPcbPlotParams->m_createGerberJobFile = parseBool();
413  break;
414 
415  case T_gerberprecision:
416  aPcbPlotParams->m_gerberPrecision =
418  break;
419 
420  case T_psa4output:
421  aPcbPlotParams->m_A4Output = parseBool();
422  break;
423 
424  case T_excludeedgelayer:
425  aPcbPlotParams->m_excludeEdgeLayer = parseBool();
426  break;
427 
428  case T_linewidth:
429  {
430  // Due to a bug, this (minor) parameter was saved in biu
431  // and now is saved in mm
432  // If the read value is outside bounds, force a default value
433  double tmp = parseDouble();
434  if( !aPcbPlotParams->SetLineWidth( KiROUND( tmp * IU_PER_MM ) ) )
435  aPcbPlotParams->SetLineWidth( PLOT_LINEWIDTH_DEFAULT );
436  }
437  break;
438 
439  case T_plotframeref:
440  aPcbPlotParams->m_plotFrameRef = parseBool();
441  break;
442 
443  case T_viasonmask:
444  aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
445  break;
446 
447  case T_mode:
448  aPcbPlotParams->SetPlotMode( parseInt( 0, 2 ) > 1 ? SKETCH : FILLED );
449  break;
450 
451  case T_useauxorigin:
452  aPcbPlotParams->m_useAuxOrigin = parseBool();
453  break;
454 
455  case T_hpglpennumber:
456  aPcbPlotParams->m_HPGLPenNum = parseInt( HPGL_PEN_NUMBER_MIN,
458  break;
459 
460  case T_hpglpenspeed:
461  aPcbPlotParams->m_HPGLPenSpeed = parseInt( HPGL_PEN_SPEED_MIN,
463  break;
464 
465  case T_hpglpendiameter:
466  aPcbPlotParams->m_HPGLPenDiam = parseDouble();
467  break;
468 
469  case T_hpglpenoverlay:
470  // No more used. juste here for compatibility with old versions
472  break;
473 
474  case T_pscolor:
475  NeedSYMBOL(); // This actually was never used...
476  break;
477 
478  case T_psnegative:
479  aPcbPlotParams->m_negative = parseBool();
480  break;
481 
482  case T_plotreference:
483  aPcbPlotParams->m_plotReference = parseBool();
484  break;
485 
486  case T_plotvalue:
487  aPcbPlotParams->m_plotValue = parseBool();
488  break;
489 
490  case T_plotinvisibletext:
491  aPcbPlotParams->m_plotInvisibleText = parseBool();
492  break;
493 
494  case T_padsonsilk:
495  aPcbPlotParams->m_plotPadsOnSilkLayer= parseBool();
496  break;
497 
498  case T_subtractmaskfromsilk:
499  aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
500  break;
501 
502  case T_outputformat:
503  aPcbPlotParams->m_format = static_cast<PlotFormat>(
505  break;
506 
507  case T_mirror:
508  aPcbPlotParams->m_mirror = parseBool();
509  break;
510 
511  case T_drillshape:
512  aPcbPlotParams->m_drillMarks = static_cast<PCB_PLOT_PARAMS::DrillMarksType>
513  ( parseInt( 0, 2 ) );
514  break;
515 
516  case T_scaleselection:
517  aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
518  break;
519 
520  case T_outputdirectory:
521  NeedSYMBOLorNUMBER(); // a dir name can be like a number
522  aPcbPlotParams->m_outputDirectory = FROM_UTF8( CurText() );
523  break;
524 
525  default:
526  skipCurrent(); // skip unknown or outdated plot parameter
527  skip_right = true; // the closing right token is already read.
528  break;
529  }
530 
531  if( ! skip_right )
532  NeedRIGHT();
533  }
534 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:673
#define HPGL_PEN_NUMBER_MAX
bool m_plotValue
Enable plotting of part values.
#define HPGL_PEN_SPEED_MAX
double parseDouble()
Function parseDouble parses a double.
#define PLOT_LINEWIDTH_DEFAULT
wxString m_outputDirectory
Output directory for plot files (usually relative to the board file)
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
bool m_mirror
Mirror the plot around the X axis.
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:106
bool m_excludeEdgeLayer
If false always plot (merge) the pcb edge layer on other layers.
static const int gbrDefaultPrecision
bool m_plotPadsOnSilkLayer
Allows pads outlines on silkscreen layer (when pads are also on silk screen)
bool m_plotReference
Enable plotting of part references.
PlotFormat
Enum PlotFormat is the set of supported output plot formats.
Definition: plotter.h:50
bool m_useGerberProtelExtensions
When plotting gerber files, use a conventional set of Protel extensions instead of ...
int m_scaleSelection
Scale ratio index (UI only)
bool m_negative
Plot in negative color (supported only by some drivers)
bool m_plotFrameRef
True to plot/print frame references.
double m_HPGLPenDiam
HPGL only: pen diameter in MILS, useful to fill areas However, it is in mm in hpgl files...
bool SetLineWidth(int aValue)
bool m_includeGerberNetlistInfo
Include netlist info (only in Gerber X2 format) (chapter ? in revision ?)
bool m_useGerberAttributes
Include attributes from the Gerber X2 format (chapter 5 in revision J2)
bool m_plotInvisibleText
Force plotting of fields marked invisible.
bool m_A4Output
Autoscale the plot to fit an A4 (landscape?) sheet.
Class LSET is a set of PCB_LAYER_IDs.
bool m_subtractMaskFromSilk
On gerbers &#39;scrape&#39; away the solder mask from silkscreen (trim silks)
#define HPGL_PEN_DIAMETER_MAX
bool m_plotViaOnMaskLayer
True if vias are drawn on Mask layer (ie untented, exposed by mask)
bool m_useAuxOrigin
Plot gerbers using auxiliary (drill) origin instead of absolue coordinates.
bool m_createGerberJobFile
generate the auxiliary "job file" in gerber format
void SetPlotMode(EDA_DRAW_MODE_T aPlotMode)
int m_HPGLPenNum
HPGL only: pen number selection(1 to 9)
LSET m_layerSelection
Set of layers to plot.
void skipCurrent()
Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes ...
#define HPGL_PEN_NUMBER_MIN
#define HPGL_PEN_SPEED_MIN
int m_HPGLPenSpeed
HPGL only: pen speed, always in cm/s (1 to 99 cm/s)
int parseInt(int aMin, int aMax)
Function parseInt parses an integer and constrains it between two values.
int ParseHex(const char *aStart, int aCount)
Function ParseHex understands the output of FmtHex() and replaces this set&#39;s values with those given ...
Definition: lset.cpp:312
PlotFormat m_format
Plot format type (chooses the driver to be used)
DrillMarksType m_drillMarks
Holes can be not plotted, have a small mark or plotted in actual size.
int m_gerberPrecision
precision of coordinates in Gerber files: accepted 5 or 6 when units are in mm (6 or 7 in inches...
bool PCB_PLOT_PARAMS_PARSER::parseBool ( )
private

Definition at line 537 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

538 {
539  T token = NeedSYMBOL();
540 
541  if( token != T_false && token != T_true )
542  Expecting( "true|false" );
543 
544  return token == T_true;
545 }
double PCB_PLOT_PARAMS_PARSER::parseDouble ( )
private

Function parseDouble parses a double.

Returns
double - the parsed double.

Definition at line 566 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

567 {
568  T token = NextTok();
569 
570  if( token != T_NUMBER )
571  Expecting( T_NUMBER );
572 
573  double val = strtod( CurText(), NULL );
574 
575  return val;
576 }
int PCB_PLOT_PARAMS_PARSER::parseInt ( int  aMin,
int  aMax 
)
private

Function parseInt parses an integer and constrains it between two values.

Parameters
aMinis the smallest return value.
aMaxis the largest return value.
Returns
int - the parsed integer.

Definition at line 548 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

549 {
550  T token = NextTok();
551 
552  if( token != T_NUMBER )
553  Expecting( T_NUMBER );
554 
555  int val = atoi( CurText() );
556 
557  if( val < aMin )
558  val = aMin;
559  else if( val > aMax )
560  val = aMax;
561 
562  return val;
563 }
void PCB_PLOT_PARAMS_PARSER::skipCurrent ( )
private

Function skipCurrent Skip the current token level, i.e search for the RIGHT parenthesis which closes the current description.

Definition at line 579 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

580 {
581  int curr_level = 0;
582  T token;
583 
584  while( ( token = NextTok() ) != T_EOF )
585  {
586  if( token == T_LEFT )
587  curr_level--;
588 
589  if( token == T_RIGHT )
590  {
591  curr_level++;
592 
593  if( curr_level > 0 )
594  return;
595  }
596  }
597 }

The documentation for this class was generated from the following files: