KiCad PCB EDA Suite
ds_data_model_io.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) 2013-2016 CERN
5  * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * @author Jean-Pierre Charras, jp.charras at wanadoo.fr
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <string_utils.h>
28 #include <locale_io.h>
29 #include <macros.h>
30 #include <math/vector2d.h>
34 #include <drawing_sheet/drawing_sheet_lexer.h>
36 
37 #include <wx/msgdlg.h>
38 
39 using namespace DRAWINGSHEET_T;
40 
41 #define double2Str Double2Str
42 
43 // A helper function to write tokens:
44 static const char* getTokenName( T aTok )
45 {
46  return DRAWING_SHEET_LEXER::TokenName( aTok );
47 }
48 
49 // A basic helper class to write a drawing sheet file
50 // Not used alone, a file writer or a string writer should be derived to use it.
51 // Therefore the constructor is protected.
53 {
54 public:
55  void Format( DS_DATA_MODEL* aSheet ) const;
56 
57  void Format( DS_DATA_MODEL* aModel, std::vector<DS_DATA_ITEM*>& aItemsList ) const;
58  void Format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem, int aNestLevel ) const;
59 
60 protected:
61  DS_DATA_MODEL_IO() { m_out = NULL; }
62  virtual ~DS_DATA_MODEL_IO() {}
63 
64 private:
65  void format( DS_DATA_ITEM_TEXT* aItem, int aNestLevel ) const;
66  void format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem, int aNestLevel ) const;
67  void format( DS_DATA_ITEM_POLYGONS* aItem, int aNestLevel ) const;
68  void format( DS_DATA_ITEM_BITMAP* aItem, int aNestLevel ) const;
69  void formatCoordinate( const char* aToken, POINT_COORD& aCoord ) const;
70  void formatRepeatParameters( DS_DATA_ITEM* aItem ) const;
71  void formatOptions( DS_DATA_ITEM* aItem ) const;
72 
73 protected:
75 };
76 
77 
78 // A helper class to write a drawing sheet to a file
80 {
81 public:
82  DS_DATA_MODEL_FILEIO( const wxString& aFilename ) :
84  {
85  try
86  {
87  m_fileout = new FILE_OUTPUTFORMATTER( aFilename );
88  m_out = m_fileout;
89  }
90  catch( const IO_ERROR& ioe )
91  {
92  wxMessageBox( ioe.What(), _( "Error writing drawing sheet file" ) );
93  }
94  }
95 
97  {
98  delete m_fileout;
99  }
100 
101 private:
103 };
104 
105 
106 // A helper class to write a drawing sheet to a string
108 {
109 public:
110  DS_DATA_MODEL_STRINGIO( wxString* aOutputString ) :
112  m_output( aOutputString )
113  {
114  try
115  {
116  m_writer = new STRING_FORMATTER();
117  m_out = m_writer;
118  }
119  catch( const IO_ERROR& ioe )
120  {
121  wxMessageBox( ioe.What(), _( "Error writing drawing sheet file" ) );
122  }
123  }
124 
126  {
127  *m_output = FROM_UTF8( m_writer->GetString().c_str() );
128  delete m_writer;
129  }
130 
131 private:
133  wxString* m_output;
134 };
135 
136 
137 void DS_DATA_MODEL::Save( const wxString& aFullFileName )
138 {
139  DS_DATA_MODEL_FILEIO writer( aFullFileName );
140  writer.Format( this );
141 }
142 
143 
144 void DS_DATA_MODEL::SaveInString( wxString* aOutputString )
145 {
146  DS_DATA_MODEL_STRINGIO writer( aOutputString );
147  writer.Format( this );
148 }
149 
150 
151 void DS_DATA_MODEL::SaveInString( std::vector<DS_DATA_ITEM*>& aItemsList, wxString* aOutputString )
152 {
153  DS_DATA_MODEL_STRINGIO writer( aOutputString );
154  writer.Format( this, aItemsList );
155 }
156 
157 
158 void DS_DATA_MODEL_IO::Format( DS_DATA_MODEL* aModel, std::vector<DS_DATA_ITEM*>& aItemsList ) const
159 {
160  LOCALE_IO toggle; // switch on/off the locale "C" notation
161 
162  m_out->Print( 0, "(kicad_wks (version %d) (generator pl_editor)\n",
164 
165  for( DS_DATA_ITEM* item : aItemsList )
166  Format( aModel, item, 1 );
167 
168  m_out->Print( 0, ")\n" );
169 }
170 
171 
172 void DS_DATA_MODEL_IO::Format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem, int aNestLevel ) const
173 {
174  switch( aItem->GetType() )
175  {
177  format( (DS_DATA_ITEM_TEXT*) aItem, aNestLevel );
178  break;
179 
182  format( aModel, aItem, aNestLevel );
183  break;
184 
186  format( (DS_DATA_ITEM_POLYGONS*) aItem, aNestLevel );
187  break;
188 
190  format( (DS_DATA_ITEM_BITMAP*) aItem, aNestLevel );
191  break;
192 
193  default:
194  wxFAIL_MSG( wxT( "Cannot format item" ) );
195  }
196 }
197 
198 
200 {
201  LOCALE_IO toggle; // switch on/off the locale "C" notation
202 
203  m_out->Print( 0, "(kicad_wks (version %d) (generator pl_editor)\n",
205 
206  // Setup
207  int nestLevel = 1;
208  // Write default values:
209  m_out->Print( nestLevel, "(setup " );
210  m_out->Print( 0, "(textsize %s %s)",
211  double2Str( aSheet->m_DefaultTextSize.x ).c_str(),
212  double2Str( aSheet->m_DefaultTextSize.y ).c_str() );
213  m_out->Print( 0, "(linewidth %s)", double2Str( aSheet->m_DefaultLineWidth ).c_str() );
214  m_out->Print( 0, "(textlinewidth %s)", double2Str( aSheet->m_DefaultTextThickness ).c_str() );
215  m_out->Print( 0, "\n" );
216 
217  // Write margin values
218  m_out->Print( nestLevel, "(left_margin %s)", double2Str( aSheet->GetLeftMargin() ).c_str() );
219  m_out->Print( 0, "(right_margin %s)", double2Str( aSheet->GetRightMargin() ).c_str() );
220  m_out->Print( 0, "(top_margin %s)", double2Str( aSheet->GetTopMargin() ).c_str() );
221  m_out->Print( 0, "(bottom_margin %s)", double2Str( aSheet->GetBottomMargin() ).c_str() );
222  m_out->Print( 0, ")\n" );
223 
224  // Save the graphical items on the drawing sheet
225  for( unsigned ii = 0; ii < aSheet->GetCount(); ii++ )
226  {
227  DS_DATA_ITEM* item = aSheet->GetItem( ii );
228  Format( aSheet, item, nestLevel );
229  }
230 
231  m_out->Print( 0, ")\n" );
232 }
233 
234 
235 void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_TEXT* aItem, int aNestLevel ) const
236 {
237  m_out->Print( aNestLevel, "(tbtext" );
238  m_out->Print( 0, " %s", m_out->Quotew( aItem->m_TextBase ).c_str() );
239  m_out->Print( 0, " (name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
240 
241  formatCoordinate( getTokenName( T_pos ), aItem->m_Pos );
242  formatOptions( aItem );
243 
244  if( aItem->m_Orient )
245  m_out->Print( 0, " (rotate %s)", double2Str(aItem->m_Orient ).c_str() );
246 
247  // Write font info, only if it is not the default setup
248  bool write_size = aItem->m_TextSize.x != 0.0 || aItem->m_TextSize.y != 0.0;
249  bool write_thickness = aItem->m_LineWidth != 0.0;
250 
251  if( write_thickness || write_size || aItem->m_Bold || aItem->m_Italic )
252  {
253  m_out->Print( 0, " (font" );
254 
255  if( write_thickness )
256  m_out->Print( 0, " (linewidth %s)", double2Str( aItem->m_LineWidth ).c_str() );
257 
258  if( write_size )
259  {
260  m_out->Print( 0, " (size %s %s)",
261  double2Str( aItem->m_TextSize.x ).c_str(),
262  double2Str( aItem->m_TextSize.y ).c_str() );
263  }
264 
265  if( aItem->m_Bold )
266  m_out->Print( 0, " bold" );
267 
268  if( aItem->m_Italic )
269  m_out->Print( 0, " italic" );
270 
271  m_out->Print( 0, ")" );
272  }
273 
274  // Write text justification
276  {
277  m_out->Print( 0, " (justify" );
278 
279  // Write T_center opt first, because it is
280  // also a center for both m_Hjustify and m_Vjustify
281  if( aItem->m_Hjustify == GR_TEXT_HJUSTIFY_CENTER )
282  m_out->Print( 0, " center" );
283  else if( aItem->m_Hjustify == GR_TEXT_HJUSTIFY_RIGHT )
284  m_out->Print( 0, " right" );
285 
286  if( aItem->m_Vjustify == GR_TEXT_VJUSTIFY_TOP )
287  m_out->Print( 0, " top" );
288  else if( aItem->m_Vjustify == GR_TEXT_VJUSTIFY_BOTTOM )
289  m_out->Print( 0, " bottom" );
290 
291  m_out->Print( 0, ")" );
292  }
293 
294  // write constraints
295  if( aItem->m_BoundingBoxSize.x )
296  m_out->Print( 0, " (maxlen %s)", double2Str(aItem->m_BoundingBoxSize.x ).c_str() );
297 
298  if( aItem->m_BoundingBoxSize.y )
299  m_out->Print( 0, " (maxheight %s)", double2Str(aItem->m_BoundingBoxSize.y ).c_str() );
300 
301  formatRepeatParameters( aItem );
302 
303  if( !aItem->m_Info.IsEmpty() )
304  m_out->Print( 0, " (comment %s)\n", m_out->Quotew( aItem->m_Info ).c_str() );
305 
306  m_out->Print( 0, ")\n" );
307 }
308 
309 
310 void DS_DATA_MODEL_IO::format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem, int aNestLevel ) const
311 {
312  if( aItem->GetType() == DS_DATA_ITEM::DS_RECT )
313  m_out->Print( aNestLevel, "(rect" );
314  else
315  m_out->Print( aNestLevel, "(line" );
316 
317  m_out->Print( 0, " (name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
318 
319  formatCoordinate( getTokenName( T_start ), aItem->m_Pos );
320  formatCoordinate( getTokenName( T_end ), aItem->m_End );
321  formatOptions( aItem );
322 
323  if( aItem->m_LineWidth && aItem->m_LineWidth != aModel->m_DefaultLineWidth )
324  m_out->Print( 0, " (linewidth %s)", double2Str( aItem->m_LineWidth ).c_str() );
325 
326  formatRepeatParameters( aItem );
327 
328  if( !aItem->m_Info.IsEmpty() )
329  m_out->Print( 0, " (comment %s)\n", m_out->Quotew( aItem->m_Info ).c_str() );
330 
331  m_out->Print( 0, ")\n" );
332 }
333 
334 
335 void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_POLYGONS* aItem, int aNestLevel ) const
336 {
337  m_out->Print( aNestLevel, "(polygon" );
338  m_out->Print( 0, " (name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
339  formatCoordinate( "pos", aItem->m_Pos );
340  formatOptions( aItem );
341 
342  formatRepeatParameters( aItem );
343 
344  if( aItem->m_Orient )
345  m_out->Print( 0, " (rotate %s)", double2Str(aItem->m_Orient ).c_str() );
346 
347  if( aItem->m_LineWidth )
348  m_out->Print( 0, " (linewidth %s)\n", double2Str( aItem->m_LineWidth ).c_str() );
349 
350  if( !aItem->m_Info.IsEmpty() )
351  m_out->Print( 0, " (comment %s)\n", m_out->Quotew( aItem->m_Info ).c_str() );
352 
353  // Write polygon corners list
354  for( int kk = 0; kk < aItem->GetPolyCount(); kk++ )
355  {
356  m_out->Print( aNestLevel+1, "(pts" );
357  // Create current polygon corners list
358  unsigned ist = aItem->GetPolyIndexStart( kk );
359  unsigned iend = aItem->GetPolyIndexEnd( kk );
360  int ii = 0;
361 
362  while( ist <= iend )
363  {
364  DPOINT pos = aItem->m_Corners[ist++];
365  int nestLevel = 0;
366 
367  if( ii++ > 4)
368  {
369  m_out->Print( 0, "\n" );
370  nestLevel = aNestLevel+2;
371  ii = 0;
372  }
373 
374  m_out->Print( nestLevel, " (xy %s %s)",
375  double2Str( pos.x ).c_str(),
376  double2Str( pos.y ).c_str() );
377  }
378 
379  m_out->Print( 0, ")\n" );
380  }
381 
382  m_out->Print( aNestLevel, ")\n" );
383 }
384 
385 
386 void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_BITMAP* aItem, int aNestLevel ) const
387 {
388  m_out->Print( aNestLevel, "(bitmap" );
389  m_out->Print( 0, " (name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
390  formatCoordinate( "pos", aItem->m_Pos );
391  formatOptions( aItem );
392 
393  m_out->Print( 0, " (scale %s)", double2Str( aItem->m_ImageBitmap->GetScale() ).c_str() );
394 
395  formatRepeatParameters( aItem );
396  m_out->Print( 0,"\n");
397 
398  if( !aItem->m_Info.IsEmpty() )
399  m_out->Print( 0, " (comment %s)\n", m_out->Quotew( aItem->m_Info ).c_str() );
400 
401  // Write image in png readable format
402  m_out->Print( aNestLevel, "(pngdata\n" );
403  wxArrayString pngStrings;
404  aItem->m_ImageBitmap->SaveData( pngStrings );
405 
406  for( unsigned ii = 0; ii < pngStrings.GetCount(); ii++ )
407  m_out->Print( aNestLevel+1, "(data \"%s\")\n", TO_UTF8(pngStrings[ii]) );
408 
409  m_out->Print( aNestLevel+1, ")\n" );
410 
411  m_out->Print( aNestLevel, ")\n" );
412 }
413 
414 
415 void DS_DATA_MODEL_IO::formatCoordinate( const char * aToken, POINT_COORD & aCoord ) const
416 {
417  m_out->Print( 0, " (%s %s %s", aToken,
418  double2Str( aCoord.m_Pos.x ).c_str(),
419  double2Str( aCoord.m_Pos.y ).c_str() );
420 
421  switch( aCoord.m_Anchor )
422  {
423  case RB_CORNER: break;
424  case LT_CORNER: m_out->Print( 0, " ltcorner" ); break;
425  case LB_CORNER: m_out->Print( 0, " lbcorner" ); break;
426  case RT_CORNER: m_out->Print( 0, " rtcorner" ); break;
427  }
428 
429  m_out->Print( 0, ")" );
430 }
431 
432 
434 {
435  if( aItem->m_RepeatCount <= 1 )
436  return;
437 
438  m_out->Print( 0, " (repeat %d)", aItem->m_RepeatCount );
439 
440  if( aItem->m_IncrementVector.x )
441  m_out->Print( 0, " (incrx %s)", double2Str(aItem-> m_IncrementVector.x ).c_str() );
442 
443  if( aItem->m_IncrementVector.y )
444  m_out->Print( 0, " (incry %s)", double2Str( aItem->m_IncrementVector.y ).c_str() );
445 
446  if( aItem->m_IncrementLabel != 1 && aItem->GetType() == DS_DATA_ITEM::DS_TEXT )
447  m_out->Print( 0, " (incrlabel %d)", aItem->m_IncrementLabel );
448 }
449 
450 
452 {
453  if( aItem->GetPage1Option() == FIRST_PAGE_ONLY )
454  m_out->Print( 0, " (option page1only)" );
455  else if( aItem->GetPage1Option() == SUBSEQUENT_PAGES )
456  m_out->Print( 0, " (option notonpage1)" );
457 }
void formatCoordinate(const char *aToken, POINT_COORD &aCoord) const
wxString m_Info
Definition: ds_data_item.h:199
unsigned GetPolyIndexStart(unsigned aContour) const
Definition: ds_data_item.h:252
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:38
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
EDA_TEXT_VJUSTIFY_T m_Vjustify
Definition: ds_data_item.h:339
bool SaveData(FILE *aFile) const
Write the bitmap data to aFile.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
double GetRightMargin()
Definition: ds_data_model.h:66
int GetPolyCount() const
Definition: ds_data_item.h:246
double m_DefaultLineWidth
double GetScale() const
Definition: bitmap_base.h:79
double GetTopMargin()
Definition: ds_data_model.h:69
static const char * getTokenName(T aTok)
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:309
double GetLeftMargin()
Definition: ds_data_model.h:63
std::vector< DPOINT > m_Corners
Definition: ds_data_item.h:288
POINT_COORD m_End
Definition: ds_data_item.h:201
unsigned GetPolyIndexEnd(unsigned aContour) const
Definition: ds_data_item.h:264
void Save(const wxString &aFullFileName)
Save the description in a file.
double m_DefaultTextThickness
This file contains miscellaneous commonly used macros and functions.
FILE_OUTPUTFORMATTER * m_fileout
EDA_TEXT_HJUSTIFY_T m_Hjustify
Definition: ds_data_item.h:338
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
DPOINT m_IncrementVector
Definition: ds_data_item.h:204
OUTPUTFORMATTER * m_out
double m_LineWidth
Definition: ds_data_item.h:202
DS_ITEM_TYPE GetType() const
Definition: ds_data_item.h:128
virtual ~DS_DATA_MODEL_IO()
DSIZE m_DefaultTextSize
BITMAP_BASE * m_ImageBitmap
Definition: ds_data_item.h:368
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
DPOINT m_Pos
Definition: ds_data_item.h:80
double GetBottomMargin()
Definition: ds_data_model.h:72
int m_IncrementLabel
Definition: ds_data_item.h:205
void Format(DS_DATA_MODEL *aSheet) const
#define SEXPR_WORKSHEET_FILE_VERSION
This file contains the file format version information for the s-expression drawing sheet file format...
#define _(s)
DS_DATA_MODEL_FILEIO(const wxString &aFilename)
STRING_FORMATTER * m_writer
A coordinate point.
Definition: ds_data_item.h:69
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void format(DS_DATA_ITEM_TEXT *aItem, int aNestLevel) const
POINT_COORD m_Pos
Definition: ds_data_item.h:200
DS_DATA_ITEM * GetItem(unsigned aIdx) const
Drawing sheet structure type definitions.
Definition: ds_data_item.h:95
void formatRepeatParameters(DS_DATA_ITEM *aItem) const
DS_DATA_MODEL_STRINGIO(wxString *aOutputString)
void SaveInString(wxString *aOutputString)
Save the description in a buffer.
unsigned GetCount() const
Used for text file output.
Definition: richio.h:456
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:414
wxString m_Name
Definition: ds_data_item.h:198
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
#define double2Str
PAGE_OPTION GetPage1Option() const
Definition: ds_data_item.h:133
void formatOptions(DS_DATA_ITEM *aItem) const