#include <qa_utils/utility_registry.h>
#include <cstdio>
#include <string>
#include <common.h>
#include <profile.h>
#include <wx/cmdline.h>
#include <board_item.h>
#include <plugins/kicad/kicad_plugin.h>
#include <plugins/kicad/pcb_parser.h>
#include <richio.h>
#include <qa_utils/stdstream_line_reader.h>

Typedefs
using	PARSE_DURATION = std::chrono::microseconds

Enumerations
enum	PARSER_RET_CODES { PARSE_FAILED = KI_TEST::RET_CODES::TOOL_SPECIFIC, PARSE_FAILED = KI_TEST::RET_CODES::TOOL_SPECIFIC }

Functions
bool	parse (std::istream &aStream, bool aVerbose)
	Parse a PCB or footprint file from the given input stream. More...

int	pcb_parser_main_func (int argc, char **argv)

Variables
static const wxCmdLineEntryDesc	g_cmdLineDesc []

static bool	registered

Typedef Documentation

◆ PARSE_DURATION

using PARSE_DURATION = std::chrono::microseconds

Definition at line 45 of file pcb_parser_tool.cpp.

Enumeration Type Documentation

◆ PARSER_RET_CODES

enum PARSER_RET_CODES

Enumerator
PARSE_FAILED
PARSE_FAILED

Definition at line 98 of file pcb_parser_tool.cpp.

 {
  PARSE_FAILED = KI_TEST::RET_CODES::TOOL_SPECIFIC,
 };

Function Documentation

◆ parse()

bool parse	(	std::istream &	aStream,
		bool	aVerbose
	)

Parse a PCB or footprint file from the given input stream.

Parameters

aStream the input stream to read from

Returns: success, duration (in us)

Definition at line 54 of file pcb_parser_tool.cpp.

 {
  // Take input from stdin
  STDISTREAM_LINE_READER reader;
  reader.SetStream( aStream );
 
  PCB_PARSER parser;
 
  parser.SetLineReader( &reader );
 
  BOARD_ITEM* board = nullptr;
 
  PARSE_DURATION duration{};
 
  try
  {
  PROF_COUNTER timer;
  board = parser.Parse();
 
  duration = timer.SinceStart<PARSE_DURATION>();
  }
  catch( const IO_ERROR& )
  {
  }
 
  if( aVerbose )
  {
  std::cout << "Took: " << duration.count() << "us" << std::endl;
  }
 
  return board != nullptr;
 }

References PCB_PARSER::Parse(), PCB_PARSER::SetLineReader(), STDISTREAM_LINE_READER::SetStream(), and PROF_COUNTER::SinceStart().

Referenced by PLUGIN_CONTENT_MANAGER::fetchPackages(), PCM_TASK_MANAGER::InstallFromFile(), JSON_SETTINGS::LoadFromFile(), pcb_parser_main_func(), and GERBER_JOBFILE_READER::ReadGerberJobFile().

◆ pcb_parser_main_func()

int pcb_parser_main_func	(	int	argc,
		char **	argv
	)

Definition at line 104 of file pcb_parser_tool.cpp.

 {
 #ifdef __AFL_COMPILER
  __AFL_INIT();
 #endif
 
  wxMessageOutput::Set( new wxMessageOutputStderr );
  wxCmdLineParser cl_parser( argc, argv );
  cl_parser.SetDesc( g_cmdLineDesc );
  cl_parser.AddUsageText(
  _( "This program parses PCB files, either from the "
  "stdin stream or from the given filenames. This can be used either for "
  "standalone testing of the parser or for fuzz testing." ) );
 
  int cmd_parsed_ok = cl_parser.Parse();
  if( cmd_parsed_ok != 0 )
  {
  // Help and invalid input both stop here
  return ( cmd_parsed_ok == -1 ) ? KI_TEST::RET_CODES::OK : KI_TEST::RET_CODES::BAD_CMDLINE;
  }
 
  const bool verbose = cl_parser.Found( "verbose" );
 
  bool ok = true;
 
  const auto file_count = cl_parser.GetParamCount();
 
  if( file_count == 0 )
  {
  // Parse the file provided on stdin - used by AFL to drive the
  // program
  // while (__AFL_LOOP(2))
  {
  ok = parse( std::cin, verbose );
  }
  }
  else
  {
  // Parse 'n' files given on the command line
  // (this is useful for input minimisation (e.g. afl-tmin) as
  // well as manual testing
  for( unsigned i = 0; i < file_count; i++ )
  {
  const auto filename = cl_parser.GetParam( i ).ToStdString();
 
  if( verbose )
  std::cout << "Parsing: " << filename << std::endl;
 
  std::ifstream fin;
  fin.open( filename );
 
  ok = ok && parse( fin, verbose );
  }
  }
 
  if( !ok )
  return PARSER_RET_CODES::PARSE_FAILED;
 
  return KI_TEST::RET_CODES::OK;
 }

References _, KI_TEST::BAD_CMDLINE, g_cmdLineDesc, OK, parse(), and PARSE_FAILED.

Variable Documentation

◆ g_cmdLineDesc

const wxCmdLineEntryDesc g_cmdLineDesc[]

static

Initial value:

= {
 { wxCMD_LINE_SWITCH, "h", "help", _( "displays help on the command line parameters" ).mb_str(),
 wxCMD_LINE_VAL_NONE, wxCMD_LINE_OPTION_HELP },
 { wxCMD_LINE_SWITCH, "v", "verbose", _( "print parsing information" ).mb_str() },
 { wxCMD_LINE_PARAM, nullptr, nullptr, _( "input file" ).mb_str(), wxCMD_LINE_VAL_STRING,
 wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
 { wxCMD_LINE_NONE }
}