AllSpiceMirrors/kicad
7
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-04-03 00:26:43 +00:00
Files Issues Releases Activity
636c6c4efb
kicad/common/drawing_sheet/ds_data_model_io.cpp
John Beard 636c6c4efb Eeschema/pcbnew: fix pasted image saving 
The m_imageData buffer in the BITMAP_BASE is an
internal implementation - the public API to persist the
data to a stream appears to be SaveImageData - so use that,
which hides the implementation (and generates the image data
"live" when needed).

Remove the public access to the m_imageData buffer as it isn't
needed for public use, and also is misleading.

Also break out the formatting of the data into KICAD_FORMAT,
as it's currently replicated in eeschema/pcb/pagelayout
formatting code.

Fixes: https://gitlab.com/kicad/code/kicad/-/issues/19772
2025-01-31 23:01:07 +08:00

478 lines
14 KiB
C++
Raw Blame History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2013-2016 CERN
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Jean-Pierre Charras, jp.charras at wanadoo.fr
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <build_version.h>
#include <string_utils.h>
#include <locale_io.h>
#include <math/vector2d.h>
#include <drawing_sheet/ds_painter.h>
#include <drawing_sheet/ds_data_item.h>
#include <drawing_sheet/ds_data_model.h>
#include <drawing_sheet/drawing_sheet_lexer.h>
#include <drawing_sheet/ds_file_versions.h>
#include <font/font.h>
#include <io/kicad/kicad_io_utils.h>
#include <string_utils.h>
#include <wx/msgdlg.h>
#include <wx/mstream.h>
using namespace DRAWINGSHEET_T;
// A helper function to write tokens:
static const char* getTokenName( T aTok )
{
return DRAWING_SHEET_LEXER::TokenName( aTok );
}
/**
* A basic helper class to write a drawing sheet file.
*
* Not used alone, a file writer or a string writer should be derived to use it.
* Therefore the constructor is protected.
*/
class DS_DATA_MODEL_IO
{
public:
void Format( DS_DATA_MODEL* aSheet ) const;
void Format( DS_DATA_MODEL* aModel, std::vector<DS_DATA_ITEM*>& aItemsList ) const;
void Format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem ) const;
protected:
DS_DATA_MODEL_IO() { m_out = NULL; }
virtual ~DS_DATA_MODEL_IO() {}
private:
void format( DS_DATA_ITEM_TEXT* aItem ) const;
void format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem ) const;
void format( DS_DATA_ITEM_POLYGONS* aItem ) const;
void format( DS_DATA_ITEM_BITMAP* aItem ) const;
void formatCoordinate( const char* aToken, POINT_COORD& aCoord ) const;
void formatRepeatParameters( DS_DATA_ITEM* aItem ) const;
void formatOptions( DS_DATA_ITEM* aItem ) const;
protected:
OUTPUTFORMATTER* m_out;
};
/**
* A helper class to write a drawing sheet to a file.
*/
class DS_DATA_MODEL_FILEIO : public DS_DATA_MODEL_IO
{
public:
DS_DATA_MODEL_FILEIO( const wxString& aFilename ) :
DS_DATA_MODEL_IO(),
m_fileout( nullptr )
{
try
{
m_fileout = new PRETTIFIED_FILE_OUTPUTFORMATTER( aFilename );
m_out = m_fileout;
}
catch( const IO_ERROR& ioe )
{
wxMessageBox( ioe.What(), _( "Error writing drawing sheet file" ) );
}
}
~DS_DATA_MODEL_FILEIO()
{
delete m_fileout;
}
private:
PRETTIFIED_FILE_OUTPUTFORMATTER* m_fileout;
};
/**
* A helper class to write a drawing sheet to a string.
*/
class DS_DATA_MODEL_STRINGIO : public DS_DATA_MODEL_IO
{
public:
DS_DATA_MODEL_STRINGIO( wxString* aOutputString ) :
DS_DATA_MODEL_IO(),
m_output( aOutputString )
{
try
{
m_writer = new STRING_FORMATTER();
m_out = m_writer;
}
catch( const IO_ERROR& ioe )
{
wxMessageBox( ioe.What(), _( "Error writing drawing sheet file" ) );
}
}
~DS_DATA_MODEL_STRINGIO()
{
*m_output = From_UTF8( m_writer->GetString().c_str() );
delete m_writer;
}
private:
STRING_FORMATTER* m_writer;
wxString* m_output;
};
void DS_DATA_MODEL::Save( const wxString& aFullFileName )
{
DS_DATA_MODEL_FILEIO writer( aFullFileName );
writer.Format( this );
}
void DS_DATA_MODEL::SaveInString( wxString* aOutputString )
{
DS_DATA_MODEL_STRINGIO writer( aOutputString );
writer.Format( this );
}
void DS_DATA_MODEL::SaveInString( std::vector<DS_DATA_ITEM*>& aItemsList, wxString* aOutputString )
{
DS_DATA_MODEL_STRINGIO writer( aOutputString );
writer.Format( this, aItemsList );
}
void DS_DATA_MODEL_IO::Format( DS_DATA_MODEL* aModel, std::vector<DS_DATA_ITEM*>& aItemsList ) const
{
LOCALE_IO toggle; // switch on/off the locale "C" notation
m_out->Print( "(kicad_wks (version %d) (generator \"pl_editor\") (generator_version %s)",
SEXPR_WORKSHEET_FILE_VERSION,
m_out->Quotew( GetMajorMinorVersion() ).c_str() );
for( DS_DATA_ITEM* item : aItemsList )
Format( aModel, item );
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::Format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem ) const
{
switch( aItem->GetType() )
{
case DS_DATA_ITEM::DS_TEXT:
format( (DS_DATA_ITEM_TEXT*) aItem );
break;
case DS_DATA_ITEM::DS_SEGMENT:
case DS_DATA_ITEM::DS_RECT:
format( aModel, aItem );
break;
case DS_DATA_ITEM::DS_POLYPOLYGON:
format( (DS_DATA_ITEM_POLYGONS*) aItem );
break;
case DS_DATA_ITEM::DS_BITMAP:
format( (DS_DATA_ITEM_BITMAP*) aItem );
break;
default:
wxFAIL_MSG( wxT( "Cannot format item" ) );
}
}
void DS_DATA_MODEL_IO::Format( DS_DATA_MODEL* aSheet ) const
{
LOCALE_IO toggle; // switch on/off the locale "C" notation
m_out->Print( "(kicad_wks (version %d) (generator \"pl_editor\") (generator_version %s)",
SEXPR_WORKSHEET_FILE_VERSION,
m_out->Quotew( GetMajorMinorVersion() ).c_str() );
// Setup
// Write default values:
m_out->Print( "(setup" );
m_out->Print( "(textsize %s %s)",
FormatDouble2Str( aSheet->m_DefaultTextSize.x ).c_str(),
FormatDouble2Str( aSheet->m_DefaultTextSize.y ).c_str() );
m_out->Print( "(linewidth %s)", FormatDouble2Str( aSheet->m_DefaultLineWidth ).c_str() );
m_out->Print( "(textlinewidth %s)",
FormatDouble2Str( aSheet->m_DefaultTextThickness ).c_str() );
// Write margin values
m_out->Print( "(left_margin %s)", FormatDouble2Str( aSheet->GetLeftMargin() ).c_str() );
m_out->Print( "(right_margin %s)", FormatDouble2Str( aSheet->GetRightMargin() ).c_str() );
m_out->Print( "(top_margin %s)", FormatDouble2Str( aSheet->GetTopMargin() ).c_str() );
m_out->Print( "(bottom_margin %s)", FormatDouble2Str( aSheet->GetBottomMargin() ).c_str() );
m_out->Print( ")" );
// Save the graphical items on the drawing sheet
for( unsigned ii = 0; ii < aSheet->GetCount(); ii++ )
{
DS_DATA_ITEM* item = aSheet->GetItem( ii );
Format( aSheet, item );
}
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_TEXT* aItem ) const
{
m_out->Print( "(tbtext %s", m_out->Quotew( aItem->m_TextBase ).c_str() );
m_out->Print( "(name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
formatCoordinate( getTokenName( T_pos ), aItem->m_Pos );
formatOptions( aItem );
if( aItem->m_Orient )
m_out->Print( "(rotate %s)", FormatDouble2Str( aItem->m_Orient ).c_str() );
// Write font info, only if it is not the default setup
bool write_size = aItem->m_TextSize.x != 0.0 || aItem->m_TextSize.y != 0.0;
bool write_thickness = aItem->m_LineWidth != 0.0;
bool write_face = aItem->m_Font && !aItem->m_Font->GetName().IsEmpty();
if( write_thickness || write_size || aItem->m_Bold || aItem->m_Italic
|| write_face || aItem->m_TextColor != COLOR4D::UNSPECIFIED )
{
m_out->Print( "(font" );
if( write_face )
m_out->Print( "(face %s)", m_out->Quotew( aItem->m_Font->NameAsToken() ).c_str() );
if( write_thickness )
m_out->Print( "(linewidth %s)", FormatDouble2Str( aItem->m_LineWidth ).c_str() );
if( write_size )
{
m_out->Print( "(size %s %s)",
FormatDouble2Str( aItem->m_TextSize.x ).c_str(),
FormatDouble2Str( aItem->m_TextSize.y ).c_str() );
}
if( aItem->m_Bold )
m_out->Print( " bold" );
if( aItem->m_Italic )
m_out->Print( " italic" );
if( aItem->m_TextColor != COLOR4D::UNSPECIFIED )
{
m_out->Print( "(color %d %d %d %s)",
KiROUND( aItem->m_TextColor.r * 255.0 ),
KiROUND( aItem->m_TextColor.g * 255.0 ),
KiROUND( aItem->m_TextColor.b * 255.0 ),
FormatDouble2Str( aItem->m_TextColor.a ).c_str() );
}
m_out->Print( ")" );
}
// Write text justification
if( aItem->m_Hjustify != GR_TEXT_H_ALIGN_LEFT || aItem->m_Vjustify != GR_TEXT_V_ALIGN_CENTER )
{
m_out->Print( "(justify" );
// Write T_center opt first, because it is
// also a center for both m_Hjustify and m_Vjustify
if( aItem->m_Hjustify == GR_TEXT_H_ALIGN_CENTER )
m_out->Print( " center" );
else if( aItem->m_Hjustify == GR_TEXT_H_ALIGN_RIGHT )
m_out->Print( " right" );
if( aItem->m_Vjustify == GR_TEXT_V_ALIGN_TOP )
m_out->Print( " top" );
else if( aItem->m_Vjustify == GR_TEXT_V_ALIGN_BOTTOM )
m_out->Print( " bottom" );
m_out->Print( ")" );
}
// write constraints
if( aItem->m_BoundingBoxSize.x )
m_out->Print( "(maxlen %s)", FormatDouble2Str( aItem->m_BoundingBoxSize.x ).c_str() );
if( aItem->m_BoundingBoxSize.y )
m_out->Print( "(maxheight %s)", FormatDouble2Str(aItem->m_BoundingBoxSize.y ).c_str() );
formatRepeatParameters( aItem );
if( !aItem->m_Info.IsEmpty() )
m_out->Print( "(comment %s)", m_out->Quotew( aItem->m_Info ).c_str() );
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::format( DS_DATA_MODEL* aModel, DS_DATA_ITEM* aItem ) const
{
if( aItem->GetType() == DS_DATA_ITEM::DS_RECT )
m_out->Print( "(rect" );
else
m_out->Print( "(line" );
m_out->Print( "(name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
formatCoordinate( getTokenName( T_start ), aItem->m_Pos );
formatCoordinate( getTokenName( T_end ), aItem->m_End );
formatOptions( aItem );
if( aItem->m_LineWidth && aItem->m_LineWidth != aModel->m_DefaultLineWidth )
m_out->Print( "(linewidth %s)", FormatDouble2Str( aItem->m_LineWidth ).c_str() );
formatRepeatParameters( aItem );
if( !aItem->m_Info.IsEmpty() )
m_out->Print( "(comment %s)", m_out->Quotew( aItem->m_Info ).c_str() );
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_POLYGONS* aItem ) const
{
m_out->Print( "(polygon" );
m_out->Print( "(name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
formatCoordinate( "pos", aItem->m_Pos );
formatOptions( aItem );
formatRepeatParameters( aItem );
if( !aItem->m_Orient.IsZero() )
m_out->Print( "(rotate %s)", FormatDouble2Str( aItem->m_Orient.AsDegrees() ).c_str() );
if( aItem->m_LineWidth )
m_out->Print( "(linewidth %s)", FormatDouble2Str( aItem->m_LineWidth ).c_str() );
if( !aItem->m_Info.IsEmpty() )
m_out->Print( "(comment %s)", m_out->Quotew( aItem->m_Info ).c_str() );
// Write polygon corners list
for( int kk = 0; kk < aItem->GetPolyCount(); kk++ )
{
m_out->Print( "(pts" );
// Create current polygon corners list
unsigned ist = aItem->GetPolyIndexStart( kk );
unsigned iend = aItem->GetPolyIndexEnd( kk );
while( ist <= iend )
{
VECTOR2D pos = aItem->m_Corners[ist++];
m_out->Print( "(xy %s %s)",
FormatDouble2Str( pos.x ).c_str(),
FormatDouble2Str( pos.y ).c_str() );
}
m_out->Print( ")" );
}
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::format( DS_DATA_ITEM_BITMAP* aItem ) const
{
// Don't save empty images
if( !aItem->m_ImageBitmap->GetOriginalImageData() )
return;
m_out->Print( "(bitmap" );
m_out->Print( "(name %s)", m_out->Quotew( aItem->m_Name ).c_str() );
formatCoordinate( "pos", aItem->m_Pos );
formatOptions( aItem );
m_out->Print( "(scale %s)", FormatDouble2Str( aItem->m_ImageBitmap->GetScale() ).c_str() );
formatRepeatParameters( aItem );
if( !aItem->m_Info.IsEmpty() )
m_out->Print( "(comment %s)", m_out->Quotew( aItem->m_Info ).c_str() );
// Write image in png readable format
m_out->Print( "(data" );
wxMemoryOutputStream stream;
aItem->m_ImageBitmap->SaveImageData( stream );
KICAD_FORMAT::FormatStreamData( *m_out, *stream.GetOutputStreamBuffer() );
m_out->Print( ")" ); // Closes bitmap token.
}
void DS_DATA_MODEL_IO::formatCoordinate( const char * aToken, POINT_COORD & aCoord ) const
{
m_out->Print( "(%s %s %s", aToken,
FormatDouble2Str( aCoord.m_Pos.x ).c_str(),
FormatDouble2Str( aCoord.m_Pos.y ).c_str() );
switch( aCoord.m_Anchor )
{
case RB_CORNER: break;
case LT_CORNER: m_out->Print( " ltcorner" ); break;
case LB_CORNER: m_out->Print( " lbcorner" ); break;
case RT_CORNER: m_out->Print( " rtcorner" ); break;
}
m_out->Print( ")" );
}
void DS_DATA_MODEL_IO::formatRepeatParameters( DS_DATA_ITEM* aItem ) const
{
if( aItem->m_RepeatCount <= 1 )
return;
m_out->Print( "(repeat %d)", aItem->m_RepeatCount );
if( aItem->m_IncrementVector.x )
m_out->Print( "(incrx %s)", FormatDouble2Str( aItem->m_IncrementVector.x ).c_str() );
if( aItem->m_IncrementVector.y )
m_out->Print( "(incry %s)", FormatDouble2Str( aItem->m_IncrementVector.y ).c_str() );
if( aItem->m_IncrementLabel != 1 && aItem->GetType() == DS_DATA_ITEM::DS_TEXT )
m_out->Print( "(incrlabel %d)", aItem->m_IncrementLabel );
}
void DS_DATA_MODEL_IO::formatOptions( DS_DATA_ITEM* aItem ) const
{
if( aItem->GetPage1Option() == FIRST_PAGE_ONLY )
m_out->Print( "(option page1only)" );
else if( aItem->GetPage1Option() == SUBSEQUENT_PAGES )
m_out->Print( "(option notonpage1)" );
}
Reference in New Issue View Git Blame Copy Permalink