KiCad PCB EDA Suite
job_file_reader.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2007-2019 Jean-Pierre Charras jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
29 #include <nlohmann/json.hpp>
30 #include <wx/filename.h>
31 
33 #include <gerbview.h>
34 #include <richio.h>
35 #include <locale_io.h>
36 #include <macros.h>
37 #include <gerber_file_image.h>
38 #include <gerber_file_image_list.h>
39 #include <gerbview_frame.h>
40 #include <reporter.h>
41 #include <gbr_metadata.h>
43 #include <view/view.h>
44 
46 
79 {
80 public:
81  GERBER_JOBFILE_READER( const wxString& aFileName, REPORTER* aReporter )
82  {
83  m_filename = aFileName;
84  m_reporter = aReporter;
85  }
86 
88 
89  bool ReadGerberJobFile();
90  wxArrayString& GetGerberFiles() { return m_GerberFiles; }
91 
92 private:
94  wxFileName m_filename;
95  wxArrayString m_GerberFiles; // List of gerber files in job
96 
97  // Convert a JSON string, that uses escaped sequence of 4 hexdecimal digits
98  // to encode unicode chars when not ASCII7 codes
99  // json11 converts this sequence to UTF8 string
100  wxString formatStringFromJSON( const std::string& name );
101 };
102 
103 
105 {
106  // Read the gerber file */
107  FILE* jobFile = wxFopen( m_filename.GetFullPath(), wxT( "rt" ) );
108 
109  if( jobFile == nullptr )
110  return false;
111 
112  LOCALE_IO toggleIo;
113 
114  FILE_LINE_READER jobfileReader( jobFile, m_filename.GetFullPath() ); // Will close jobFile
115 
116  wxString msg;
117  wxString data;
118 
119  // detect the file format: old (deprecated) gerber format of official JSON format
120  bool json_format = false;
121 
122  char* line = jobfileReader.ReadLine();
123 
124  if( !line ) // end of file
125  return false;
126 
127  data = line;
128 
129  if( data.Contains( "{" ) )
130  json_format = true;
131 
132  if( json_format )
133  {
134  while( ( line = jobfileReader.ReadLine() ) )
135  data << '\n' << line;
136 
137  try
138  {
139  json js = json::parse( TO_UTF8( data ) );
140 
141  for( json& entry : js["FilesAttributes"] )
142  {
143  std::string name = entry["Path"].get<std::string>();
145  }
146  }
147  catch( ... )
148  {
149  return false;
150  }
151  }
152  else
153  {
154  if( m_reporter )
155  m_reporter->ReportTail( _( "This job file uses an outdated format. Please recreate it." ),
157 
158  return false;
159  }
160 
161  return true;
162 }
163 
164 
165 wxString GERBER_JOBFILE_READER::formatStringFromJSON( const std::string& name )
166 {
167  // Convert a JSON string, that uses a escaped sequence of 4 hexdecimal digits
168  // to encode unicode chars
169  // Our json11 library returns in this case a UTF8 sequence. Just convert it to
170  // a wxString.
171  wxString wstr = FROM_UTF8( name.c_str() );
172  return wstr;
173 }
174 
175 
176 
177 bool GERBVIEW_FRAME::LoadGerberJobFile( const wxString& aFullFileName )
178 {
179  wxFileName filename = aFullFileName;
180  wxString currentPath;
181  bool success = true;
182 
183  if( !filename.IsOk() )
184  {
185  // Use the current working directory if the file name path does not exist.
186  if( filename.DirExists() )
187  currentPath = filename.GetPath();
188  else
189  currentPath = m_mruPath;
190 
191  wxFileDialog dlg( this, _( "Open Gerber Job File" ),
192  currentPath,
193  filename.GetFullName(),
195  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
196 
197  if( dlg.ShowModal() == wxID_CANCEL )
198  return false;
199 
200  filename = dlg.GetPath();
201  currentPath = filename.GetPath();
202  m_mruPath = currentPath;
203  }
204  else
205  {
206  currentPath = filename.GetPath();
207  m_mruPath = currentPath;
208  }
209 
210  wxString msg;
211  WX_STRING_REPORTER reporter( &msg );
212 
213  if( filename.IsOk() )
214  {
215  GERBER_JOBFILE_READER gbjReader( filename.GetFullPath(), &reporter );
216 
217  if( gbjReader.ReadGerberJobFile() )
218  {
219  // Update the list of recent drill files.
220  UpdateFileHistory( filename.GetFullPath(), &m_jobFileHistory );
221 
222  Clear_DrawLayers( false );
223  ClearMsgPanel();
224 
225  wxArrayString& gbrfiles = gbjReader.GetGerberFiles();
226 
227  success = LoadListOfGerberAndDrillFiles( currentPath, gbrfiles );
228  }
229  }
230 
232 
233  if( !msg.IsEmpty() )
234  {
235  wxSafeYield(); // Allows slice of time to redraw the screen
236  // to refresh widgets, before displaying messages
237  HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
238  mbox.ListSet( msg );
239  mbox.ShowModal();
240  }
241 
242  return success;
243 }
a class to handle special data (items attributes) during plot.
char * ReadLine() override
Function ReadLine reads a line of text into the buffer and increments the line number counter.
Definition: richio.cpp:198
void SortLayersByX2Attributes()
bool Clear_DrawLayers(bool query)
wxString m_mruPath
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:109
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
FILE_HISTORY m_jobFileHistory
this class read and parse a Gerber job file to extract useful info for GerbView
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Function ReportTail Places the report at the end of the list, for objects that support report orderin...
Definition: reporter.h:94
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
nlohmann::json json
Definition: gerbview.cpp:39
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
This file contains miscellaneous commonly used macros and functions.
bool LoadGerberJobFile(const wxString &aFileName)
Load a Gerber job file, and load gerber files found in job files.
nlohmann::json json
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:181
GERBER_JOBFILE_READER(const wxString &aFileName, REPORTER *aReporter)
bool LoadListOfGerberAndDrillFiles(const wxString &aPath, const wxArrayString &aFilenameList, const std::vector< int > *aFileType=nullptr)
Loads a list of Gerber and NC drill files and updates the view based on them.
void ListSet(const wxString &aList)
Add a list of items.
Definition of file extensions used in Kicad.
wxArrayString & GetGerberFiles()
read a .gbrjob file
HTML_MESSAGE_BOX.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
WX_STRING_REPORTER is a wrapper for reporting to a wxString object.
Definition: reporter.h:161
wxString GerberJobFileWildcard()
const char * name
Definition: DXF_plotter.cpp:59
wxArrayString m_GerberFiles
#define _(s)
Definition: 3d_actions.cpp:33
wxString formatStringFromJSON(const std::string &name)