GERBER_JOBFILE_READER Class Reference

this class read and parse a Gerber job file to extract useful info for GerbView More...

Public Member Functions
	GERBER_JOBFILE_READER (const wxString &aFileName, REPORTER *aReporter)
	~GERBER_JOBFILE_READER ()
bool	ReadGerberJobFile ()
wxArrayString &	GetGerberFiles ()
	read a .gbrjob file More...

Private Member Functions
wxString	formatStringFromJSON (const std::string &name)

Private Attributes
REPORTER *	m_reporter
wxFileName	m_filename
wxArrayString	m_GerberFiles

Detailed Description

this class read and parse a Gerber job file to extract useful info for GerbView

In a gerber job file, old (deprecated) format, data lines start by TF. (usual Gerber X2 info) TJ.B. (board info) TJ.D. (design info) TJ.L. (layers info) some others are not yet handled by Kicad M02* is the last line

In a gerber job file, JSON format, first lines are { "Header": and the block ( a JSON array) containing the filename of files to load is "FilesAttributes": [ { "Path": "interf_u-Composant.gbr", "FileFunction": "Copper,L1,Top", "FilePolarity": "Positive" }, { "Path": "interf_u-In1.Cu.gbr", "FileFunction": "Copper,L2,Inr", "FilePolarity": "Positive" }, ],

Definition at line 80 of file job_file_reader.cpp.

Constructor & Destructor Documentation

GERBER_JOBFILE_READER()

GERBER_JOBFILE_READER::GERBER_JOBFILE_READER ( const wxString &  aFileName, REPORTER *  aReporter  )

inline

Definition at line 83 of file job_file_reader.cpp.

 {
 m_filename = aFileName;
 m_reporter = aReporter;
 }

References m_filename, and m_reporter.

~GERBER_JOBFILE_READER()

GERBER_JOBFILE_READER::~GERBER_JOBFILE_READER ( )

inline

Definition at line 89 of file job_file_reader.cpp.

{}

Member Function Documentation

formatStringFromJSON()

wxString GERBER_JOBFILE_READER::formatStringFromJSON ( const std::string &  name )

private

Definition at line 167 of file job_file_reader.cpp.

{
 // Convert a JSON string, that uses a escaped sequence of 4 hexadecimal digits
 // to encode unicode chars
 // Our json11 library returns in this case a UTF8 sequence. Just convert it to
 // a wxString.
 wxString wstr = FROM_UTF8( name.c_str() );
 return wstr;
}

References FROM_UTF8(), and name.

Referenced by ReadGerberJobFile().

GetGerberFiles()

wxArrayString& GERBER_JOBFILE_READER::GetGerberFiles ( )

inline

read a .gbrjob file

Definition at line 92 of file job_file_reader.cpp.

{ return m_GerberFiles; }

References m_GerberFiles.

ReadGerberJobFile()

bool GERBER_JOBFILE_READER::ReadGerberJobFile

(

)

Definition at line 106 of file job_file_reader.cpp.

{
 // Read the gerber file */
 FILE* jobFile = wxFopen( m_filename.GetFullPath(), wxT( "rt" ) );

 if( jobFile == nullptr )
 return false;

 LOCALE_IO toggleIo;

 FILE_LINE_READER jobfileReader( jobFile, m_filename.GetFullPath() ); // Will close jobFile

 wxString msg;
 wxString data;

 // detect the file format: old (deprecated) gerber format of official JSON format
 bool json_format = false;

 char* line = jobfileReader.ReadLine();

 if( !line ) // end of file
 return false;

 data = line;

 if( data.Contains( wxT( "{" ) ) )
 json_format = true;

 if( json_format )
 {
 while( ( line = jobfileReader.ReadLine() ) )
 data << '\n' << line;

 try
 {
 json js = json::parse( TO_UTF8( data ) );

 for( json& entry : js["FilesAttributes"] )
 {
 std::string name = entry["Path"].get<std::string>();
 m_GerberFiles.Add( formatStringFromJSON( name ) );
 }
 }
 catch( ... )
 {
 return false;
 }
 }
 else
 {
 if( m_reporter )
 m_reporter->ReportTail( _( "This job file uses an outdated format. Please recreate it." ),
 RPT_SEVERITY_WARNING );

 return false;
 }

 return true;
}

References _, formatStringFromJSON(), m_filename, m_GerberFiles, m_reporter, name, parse(), FILE_LINE_READER::ReadLine(), REPORTER::ReportTail(), RPT_SEVERITY_WARNING, and TO_UTF8.

Member Data Documentation

m_filename

wxFileName GERBER_JOBFILE_READER::m_filename

private

Definition at line 96 of file job_file_reader.cpp.

Referenced by GERBER_JOBFILE_READER(), and ReadGerberJobFile().

m_GerberFiles

wxArrayString GERBER_JOBFILE_READER::m_GerberFiles

private

Definition at line 97 of file job_file_reader.cpp.

Referenced by GetGerberFiles(), and ReadGerberJobFile().

m_reporter

REPORTER* GERBER_JOBFILE_READER::m_reporter

private

Definition at line 95 of file job_file_reader.cpp.

Referenced by GERBER_JOBFILE_READER(), and ReadGerberJobFile().

---

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

• job_file_reader.cpp