plotters_pslike.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "plotter.h"


class PSLIKE_PLOTTER : public PLOTTER
{
public:
 PSLIKE_PLOTTER() :
 plotScaleAdjX( 1 ),
 plotScaleAdjY( 1 ),
 m_textMode( PLOT_TEXT_MODE::PHANTOM )
 {
 }

 virtual void SetTextMode( PLOT_TEXT_MODE mode ) override
 {
 if( mode != PLOT_TEXT_MODE::DEFAULT )
 m_textMode = mode;
 }

 void SetScaleAdjust( double scaleX, double scaleY )
 {
 plotScaleAdjX = scaleX;
 plotScaleAdjY = scaleY;
 }

 // Pad routines are handled with lower level primitives
 virtual void FlashPadCircle( const wxPoint& aPadPos, int aDiameter,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadOval( const wxPoint& aPadPos, const wxSize& aSize, double aPadOrient,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadRect( const wxPoint& aPadPos, const wxSize& aSize, double aPadOrient,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadRoundRect( const wxPoint& aPadPos, const wxSize& aSize,
 int aCornerRadius, double aOrient,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadCustom( const wxPoint& aPadPos, const wxSize& aSize, double aOrient,
 SHAPE_POLY_SET* aPolygons,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
 double aPadOrient, OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashRegularPolygon( const wxPoint& aShapePos, int aDiameter, int aCornerCount,
 double aOrient, OUTLINE_MODE aTraceMode,
 void* aData ) override;

 virtual void SetColor( const COLOR4D& color ) override;

protected:
 void computeTextParameters( const wxPoint& aPos,
 const wxString& aText,
 int aOrient,
 const wxSize& aSize,
 bool aMirror,
 enum EDA_TEXT_HJUSTIFY_T aH_justify,
 enum EDA_TEXT_VJUSTIFY_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 double *wideningFactor,
 double *ctm_a,
 double *ctm_b,
 double *ctm_c,
 double *ctm_d,
 double *ctm_e,
 double *ctm_f,
 double *heightFactor );

 void postscriptOverlinePositions( const wxString& aText, int aXSize, bool aItalic, bool aBold,
 std::vector<int> *pos_pairs );

 virtual std::string encodeStringForPlotter( const wxString& aUnicode );

 virtual void emitSetRGBColor( double r, double g, double b ) = 0;

 static const double postscriptTextAscent; // = 0.718;

 int returnPostscriptTextWidth( const wxString& aText, int aXSize, bool aItalic, bool aBold );

 double plotScaleAdjX, plotScaleAdjY;

 PLOT_TEXT_MODE m_textMode;
};


class PS_PLOTTER : public PSLIKE_PLOTTER
{
public:
 PS_PLOTTER()
 {
 // The phantom plot in postscript is an hack and reportedly
 // crashes Adobe's own postscript interpreter!
 m_textMode = PLOT_TEXT_MODE::STROKE;
 }

 static wxString GetDefaultFileExtension()
 {
 return wxString( wxT( "ps" ) );
 }

 virtual PLOT_FORMAT GetPlotterType() const override
 {
 return PLOT_FORMAT::POST;
 }

 virtual bool StartPlot() override;
 virtual bool EndPlot() override;

 virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override;

 virtual void SetDash( PLOT_DASH_TYPE dashed ) override;

 virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
 double aScale, bool aMirror ) override;
 virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle, int rayon,
 FILL_T fill, int width = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void PlotPoly( const std::vector< wxPoint >& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;

 virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
 double aScaleFactor ) override;

 virtual void PenTo( const wxPoint& pos, char plume ) override;
 virtual void Text( const wxPoint& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 double aOrient,
 const wxSize& aSize,
 enum EDA_TEXT_HJUSTIFY_T aH_justify,
 enum EDA_TEXT_VJUSTIFY_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 bool aMultilineAllowed = false,
 void* aData = nullptr ) override;
protected:
 virtual void emitSetRGBColor( double r, double g, double b ) override;
};


class PDF_PLOTTER : public PSLIKE_PLOTTER
{
public:
 PDF_PLOTTER() :
 pageTreeHandle( 0 ),
 fontResDictHandle( 0 ),
 pageStreamHandle( 0 ),
 streamLengthHandle( 0 ),
 workFile( nullptr )
 {
 }

 virtual PLOT_FORMAT GetPlotterType() const override
 {
 return PLOT_FORMAT::PDF;
 }

 static wxString GetDefaultFileExtension()
 {
 return wxString( wxT( "pdf" ) );
 }

 virtual bool OpenFile( const wxString& aFullFilename ) override;

 virtual bool StartPlot() override;
 virtual bool EndPlot() override;

 virtual void StartPage();

 virtual void ClosePage();

 virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override;

 virtual void SetDash( PLOT_DASH_TYPE dashed ) override;

 virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
 double aScale, bool aMirror ) override;

 virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle, int rayon,
 FILL_T fill, int width = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void PlotPoly( const std::vector< wxPoint >& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;

 virtual void PenTo( const wxPoint& pos, char plume ) override;

 virtual void Text( const wxPoint& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 double aOrient,
 const wxSize& aSize,
 enum EDA_TEXT_HJUSTIFY_T aH_justify,
 enum EDA_TEXT_VJUSTIFY_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 bool aMultilineAllowed = false,
 void* aData = nullptr ) override;
 virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
 double aScaleFactor ) override;


protected:
 std::string encodeStringForPlotter( const wxString& aUnicode ) override;

 virtual void emitSetRGBColor( double r, double g, double b ) override;

 int allocPdfObject();

 int startPdfObject(int handle = -1);

 void closePdfObject();

 int startPdfStream(int handle = -1);

 void closePdfStream();

 int pageTreeHandle; 
 int fontResDictHandle; 
 std::vector<int> pageHandles;
 int pageStreamHandle; 
 int streamLengthHandle; 
 wxString workFilename;
 FILE* workFile; 
 std::vector<long> xrefTable; 
};


class SVG_PLOTTER : public PSLIKE_PLOTTER
{
public:
 SVG_PLOTTER();

 static wxString GetDefaultFileExtension()
 {
 return wxString( wxT( "svg" ) );
 }

 virtual PLOT_FORMAT GetPlotterType() const override
 {
 return PLOT_FORMAT::SVG;
 }

 virtual void SetColor( const COLOR4D& color ) override;

 virtual bool StartPlot() override;
 virtual bool EndPlot() override;

 virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override;

 virtual void SetDash( PLOT_DASH_TYPE dashed ) override;

 virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
 double aScale, bool aMirror ) override;
 virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle, int rayon,
 FILL_T fill, int width = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void BezierCurve( const wxPoint& aStart, const wxPoint& aControl1,
 const wxPoint& aControl2, const wxPoint& aEnd,
 int aTolerance,
 int aLineThickness = USE_DEFAULT_LINE_WIDTH ) override;

 virtual void PlotPoly( const std::vector< wxPoint >& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void * aData = nullptr ) override;

 virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
 double aScaleFactor ) override;

 virtual void PenTo( const wxPoint& pos, char plume ) override;

 virtual void SetSvgCoordinatesFormat( unsigned aResolution, bool aUseInches = false ) override;

 virtual void StartBlock( void* aData ) override;

 virtual void EndBlock( void* aData ) override;

 virtual void Text( const wxPoint& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 double aOrient,
 const wxSize& aSize,
 enum EDA_TEXT_HJUSTIFY_T aH_justify,
 enum EDA_TEXT_VJUSTIFY_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 bool aMultilineAllowed = false,
 void* aData = nullptr ) override;

protected:
 virtual void emitSetRGBColor( double r, double g, double b ) override;

 void setSVGPlotStyle( bool aIsGroup = true, const std::string& aExtraStyle = {} );

 void setFillMode( FILL_T fill );

 FILL_T m_fillMode; // true if the current contour
 // rect, arc, circle, polygon must be filled
 long m_pen_rgb_color; // current rgb color value: each color has
 // a value 0 ... 255, and the 3 colors are
 // grouped in a 3x8 bits value
 // (written in hex to svg files)
 long m_brush_rgb_color; // same as m_pen_rgb_color, used to fill
 // some contours.
 bool m_graphics_changed; // true if a pen/brush parameter is modified
 // color, pen size, fill mode ...
 // the new SVG stype must be output on file
 PLOT_DASH_TYPE m_dashed; // plot line style
 bool m_useInch; // is 0 if the step size is 10**-n*mm
 // is 1 if the step size is 10**-n*inch
 // Where n is given from m_precision
 unsigned m_precision; // How fine the step size is
 // Use 3-6 (3 means um precision, 6 nm precision) in PcbNew
 // 3-4 in other modules (avoid values >4 to avoid overflow)
 // see also comment for m_useInch.
};