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 338 of file pcb_plot_params.cpp.

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

Definition at line 344 of file pcb_plot_params.cpp.

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

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 350 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().

351 {
352  T token;
353 
354  while( ( token = NextTok() ) != T_RIGHT )
355  {
356  if( token == T_EOF)
357  Unexpected( T_EOF );
358 
359  if( token == T_LEFT )
360  token = NextTok();
361 
362  if( token == T_pcbplotparams )
363  continue;
364 
365  bool skip_right = false;
366 
367  switch( token )
368  {
369  case T_layerselection:
370  {
371  token = NeedSYMBOLorNUMBER();
372 
373  const std::string& cur = CurStr();
374 
375  if( token == T_NUMBER ) // pretty 3 format had legacy Cu stack.
376  {
377  // unsigned legacy_mask = atol( cur.c_str() );
378 
379  /* It's not possible to convert a legacy Cu layer number to a new
380  Cu layer number without knowing the number or total Cu layers
381  in the legacy board. We do not have that information here.
382  So simply set all layers ON. User can turn them off in the UI.
383  This is one of the superiorities of the new Cu sequence.
384  aPcbPlotParams->m_layerSelection = LEGACY_PLUGIN::leg_mask2new( cu_count, legacy_mask );
385  */
386 
387  // sorry, use the UI once to fix:
388  aPcbPlotParams->m_layerSelection = LSET( 2, F_SilkS, B_SilkS) | LSET::AllCuMask();
389  }
390  else if( cur.find_first_of( "0x" ) == 0 ) // pretty ver. 4.
391  {
392  // skip the leading 2 0x bytes.
393  aPcbPlotParams->m_layerSelection.ParseHex( cur.c_str()+2, cur.size()-2 );
394  }
395  else
396  Expecting( "integer or hex layerSelection" );
397  }
398  break;
399 
400  case T_usegerberextensions:
401  aPcbPlotParams->m_useGerberProtelExtensions = parseBool();
402  break;
403 
404  case T_usegerberattributes:
405  aPcbPlotParams->m_useGerberAttributes = parseBool();
406  break;
407 
408  case T_usegerberadvancedattributes:
409  aPcbPlotParams->m_includeGerberNetlistInfo = parseBool();
410  break;
411 
412  case T_creategerberjobfile:
413  aPcbPlotParams->m_createGerberJobFile = parseBool();
414  break;
415 
416  case T_gerberprecision:
417  aPcbPlotParams->m_gerberPrecision =
419  break;
420 
421  case T_psa4output:
422  aPcbPlotParams->m_A4Output = parseBool();
423  break;
424 
425  case T_excludeedgelayer:
426  aPcbPlotParams->m_excludeEdgeLayer = parseBool();
427  break;
428 
429  case T_linewidth:
430  {
431  // Due to a bug, this (minor) parameter was saved in biu
432  // and now is saved in mm
433  // If the read value is outside bounds, force a default value
434  double tmp = parseDouble();
435  if( !aPcbPlotParams->SetLineWidth( KiROUND( tmp * IU_PER_MM ) ) )
436  aPcbPlotParams->SetLineWidth( PLOT_LINEWIDTH_DEFAULT );
437  }
438  break;
439 
440  case T_plotframeref:
441  aPcbPlotParams->m_plotFrameRef = parseBool();
442  break;
443 
444  case T_viasonmask:
445  aPcbPlotParams->m_plotViaOnMaskLayer = parseBool();
446  break;
447 
448  case T_mode:
449  aPcbPlotParams->SetPlotMode( parseInt( 0, 2 ) > 1 ? SKETCH : FILLED );
450  break;
451 
452  case T_useauxorigin:
453  aPcbPlotParams->m_useAuxOrigin = parseBool();
454  break;
455 
456  case T_hpglpennumber:
457  aPcbPlotParams->m_HPGLPenNum = parseInt( HPGL_PEN_NUMBER_MIN,
459  break;
460 
461  case T_hpglpenspeed:
462  aPcbPlotParams->m_HPGLPenSpeed = parseInt( HPGL_PEN_SPEED_MIN,
464  break;
465 
466  case T_hpglpendiameter:
467  aPcbPlotParams->m_HPGLPenDiam = parseDouble();
468  break;
469 
470  case T_hpglpenoverlay:
471  // No more used. juste here for compatibility with old versions
473  break;
474 
475  case T_pscolor:
476  NeedSYMBOL(); // This actually was never used...
477  break;
478 
479  case T_psnegative:
480  aPcbPlotParams->m_negative = parseBool();
481  break;
482 
483  case T_plotreference:
484  aPcbPlotParams->m_plotReference = parseBool();
485  break;
486 
487  case T_plotvalue:
488  aPcbPlotParams->m_plotValue = parseBool();
489  break;
490 
491  case T_plotinvisibletext:
492  aPcbPlotParams->m_plotInvisibleText = parseBool();
493  break;
494 
495  case T_padsonsilk:
496  aPcbPlotParams->m_plotPadsOnSilkLayer= parseBool();
497  break;
498 
499  case T_subtractmaskfromsilk:
500  aPcbPlotParams->m_subtractMaskFromSilk = parseBool();
501  break;
502 
503  case T_outputformat:
504  aPcbPlotParams->m_format = static_cast<PlotFormat>(
506  break;
507 
508  case T_mirror:
509  aPcbPlotParams->m_mirror = parseBool();
510  break;
511 
512  case T_drillshape:
513  aPcbPlotParams->m_drillMarks = static_cast<PCB_PLOT_PARAMS::DrillMarksType>
514  ( parseInt( 0, 2 ) );
515  break;
516 
517  case T_scaleselection:
518  aPcbPlotParams->m_scaleSelection = parseInt( 0, 4 );
519  break;
520 
521  case T_outputdirectory:
522  NeedSYMBOLorNUMBER(); // a dir name can be like a number
523  aPcbPlotParams->m_outputDirectory = FROM_UTF8( CurText() );
524  break;
525 
526  default:
527  skipCurrent(); // skip unknown or outdated plot parameter
528  skip_right = true; // the closing right token is already read.
529  break;
530  }
531 
532  if( ! skip_right )
533  NeedRIGHT();
534  }
535 }
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:120
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 538 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

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

Function parseDouble parses a double.

Returns
double - the parsed double.

Definition at line 567 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

568 {
569  T token = NextTok();
570 
571  if( token != T_NUMBER )
572  Expecting( T_NUMBER );
573 
574  double val = strtod( CurText(), NULL );
575 
576  return val;
577 }
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 549 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

550 {
551  T token = NextTok();
552 
553  if( token != T_NUMBER )
554  Expecting( T_NUMBER );
555 
556  int val = atoi( CurText() );
557 
558  if( val < aMin )
559  val = aMin;
560  else if( val > aMax )
561  val = aMax;
562 
563  return val;
564 }
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 580 of file pcb_plot_params.cpp.

Referenced by GetReader(), and Parse().

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

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