//OpenSCADA module UI.Vision file: vis_shapes.h
/***************************************************************************
 *   Copyright (C) 2007-2024 by Roman Savochenko, <roman@oscada.org>       *
 *                                                                         *
 *   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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef VIS_SHAPES_H
#define VIS_SHAPES_H

#include <config.h>

#if HAVE_FFTW3_H
#include <fftw3.h>
#endif

#include <QObject>
#include <QMap>
#include <QVariant>
#include <QMenu>
#include <QPen>
#include <QLabel>
#include <QPicture>
#include <QTableWidget>
#include <QScrollArea>
#include <QTextBrowser>
#include <QPrinter>

#if HAVE_WEBENGINE
#include <QWebEngineView>
#elif HAVE_WEBKIT
#include <QWebView>
#include <QWebFrame>
#endif

#include <deque>

#include <tmess.h>
#include <xml.h>

using std::deque;
using namespace OSCADA;

class QEvent;
class QAction;
class QPainter;

namespace VISION
{

class WdgView;
class DevelWdgView;

//*************************************************
//* Widget shape abstract object                  *
//*************************************************
class WdgShape : public QObject
{
    Q_OBJECT

    public:
	//Methods
	WdgShape( const string &iid );

	string id( )									{ return m_id; }

	virtual bool isEditable( )							{ return false; }
	virtual bool needToVisibleCheck( )						{ return true; }

	virtual void init( WdgView *view )						{ }
	virtual void destroy( WdgView *view )						{ }

	virtual void editEnter( DevelWdgView *view )					{ }
	virtual void editExit( DevelWdgView *view )					{ }
	virtual void wdgPopup( WdgView *view, QMenu &menu )				{ }

	virtual bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );

	virtual bool event( WdgView *view, QEvent *event );
	virtual bool eventFilter( WdgView *view, QObject *object, QEvent *event )	{ return false; }

    protected:
	//Methods
	void borderDraw( QPainter &pnt, QRect dA, QPen bpen, int bordStyle );

    private:
	//Attributes
	string m_id;
};

//============ Support widget's shapes ============

//*************************************************
//* Form element shape widget                     *
//*************************************************
class ShapeFormEl : public WdgShape
{
    Q_OBJECT

    public:
	//Data
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(true), evLock(false), elType(-1), setType(false), opt1(false), addrWdg(NULL) { }
		//Attributes
		short	en	:1;
		short	active	:1;
		short	evLock	:1;
		short	elType	:5;
		short	setType	:1;
		short	view	:4;
		short	opt1	:1;
		short	mode	:5;
		QWidget	*addrWdg;
		QFont	font;
		string	name;
		string	value;
		string	img;
		string	items;
		string	cfg;
		string	color, colorText;
	};

	//Methods
	ShapeFormEl( );

	bool needToVisibleCheck( )	{ return false; }

	void init( WdgView *view );
	void destroy( WdgView *view );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );
	bool eventFilter( WdgView *view, QObject *object, QEvent *event );
	void setActive( WdgView *view, bool val );
	void setValue( WdgView *view, const string &val, bool force = false );

	void tableFit( WdgView *w );

    public slots:
	//Public slots
	// Edit line events
	void lineAccept( );
	// Edit text events
	void textAccept( );
	// Check box events
	void checkChange( int );
	// Combo box and list events
	void comboChange( int );
	// List events
	void listChange( );
	// Tree events
	void treeChange( );
	// Table events
	void tableSelectChange( );
	void tableChange( int, int );
	// Button's events
	void buttonPressed( );
	void buttonReleased( );
	void buttonToggled( bool val );
	void buttonMenuTrig( );
	// Sliders' events
	void sliderMoved( int val );

    private:
	//Data
	QStyle	*forceStl;

	//Methods
	// Recursively widgets process for disable focusable and events filter set
	void eventFilterSet( WdgView *view, QWidget *wdg, bool en );
	void setFocus(WdgView *view, QWidget *wdg, bool en = false, bool devel = false );
};

//************************************************
//* Text element shape widget                    *
//************************************************
class ShapeText : public WdgShape
{
    public:
	//Methods
	ShapeText( );

	void init( WdgView *view );
	void destroy( WdgView *view );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );

    private:
	//Data
	// Argument object's class
	class ArgObj
	{
	    public:
		//Methods
		ArgObj( )				{ };

		string &cfg( )				{ return m_cfg; }
		QVariant val( )				{ return m_val; }

		void setCfg( const string &vl )		{ m_cfg = vl; }
		void setVal( const QVariant &vl )	{ m_val = vl; }

	    private:
		//Attributes
		QVariant	m_val;
		string		m_cfg;
	};
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(true), realAct(false), inHtml(false), geomMargin(0)	{ }
		//Attributes
		short	en		:1;
		short	active		:1;
		short	realAct		:1;
		short	inHtml		:1;
		short	geomMargin	:8;
		short	bordStyle	:5;
		short int orient;
		string	text_tmpl,
			text;
		QColor	color;
		QBrush	backGrnd;
		string	font;
		QPen	border;
		QTextOption options;
		vector<ArgObj>	args;
	};
};

//************************************************
//* Media view shape widget                      *
//************************************************
class ShapeMedia : public WdgShape
{
    Q_OBJECT

    public:
	//Methods
	ShapeMedia( );

	void init( WdgView *view );
	void destroy( WdgView *view );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );
	bool eventFilter( WdgView *view, QObject *object, QEvent *event );

	void clear( WdgView *view );

    public slots:
	//Public slots
	void chkTimer( );

    private:
	//Data
	// Map areas structure
	class MapArea
	{
	    public:
		//Methods
		MapArea( ) : shp(-1)	{ }

		bool containsPoint( const QPoint & point );

		//Attributes
		int	shp;		//Area shape
		string	title;		//Area title
		QVector<QPoint>	pnts;	//Area points
	};
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(false), realActive(false), geomMargin(0), mediaType(-1),
			videoSize(0), videoSeek(0), audioVolume(0), addrWdg(NULL), extO(NULL), chkTimer(NULL) { }
		//Attributes
		short	en		:1;
		short	active		:1;
		short	realActive	:1;
		short	geomMargin	:8;
		short	bordStyle	:5;
		short	mediaType	:3;
		short	mediaFit	:1;
		short	mediaKeepAspect	:1;
		short	mediaSpeed	:8;
		short	videoPlay	:1;
		short	videoRoll	:1;
		short	videoPause	:1;
		double	videoSize, videoSeek, audioVolume;
		QBrush	backGrnd;
		QObject *addrWdg, *extO;
		QTimer	*chkTimer;
		QPen	border;
		string	mediaSrc, tfile;
		vector<MapArea>	maps;
	};
};

//************************************************
//* Diagram view shape widget                    *
//************************************************
class ShapeDiagram : public WdgShape
{
    Q_OBJECT

    public:
	// Trend object's class
	class TrendObj
	{
	    friend class ShapeDiagram;
	    public:
		//Data
		class SHg
		{
		    public:
			SHg( int64_t itm, double ival ) : tm(itm), val(ival) { }
			int64_t	tm;
			double	val;
		};
		//Methods
		TrendObj( WdgView *view );
		~TrendObj( );

		string	addr( ) const	{ return mAddr; }
		double	bordL( )	{ return mBordLow; }
		double	bordU( )	{ return mBordUp; }
		QColor	color( )	{ return mColor; }
		int	width( )	{ return mWidth; }
		int	scale( )	{ return mScale; }
		double	curVal( )	{ return mCurvl; }
		int	valTp( )	{ return val_tp; }
		int64_t	valBeg( );
		int64_t	valEnd( );
		int	val( int64_t tm );
		deque<SHg> &val( )	{ return vals; }
		int64_t arhPer( )	{ return arh_per; }
		int64_t arhBeg( )	{ return arh_beg; }
		int64_t arhEnd( )	{ return arh_end; }

		void setAddr( const string &vl );
		void setBordL( double vl )	{ mBordLow = vl; }
		void setBordU( double vl )	{ mBordUp  = vl; }
		void setColor( const QColor &vl ){ mColor = vl; }
		void setWidth( char vl )	{ mWidth = vl; }
		void setScale( char vl )	{ mScale = vl; }
		void setCurVal( double vl )	{ mCurvl = vl; }

		void loadData( bool full = false );
		void loadTrendsData( bool full = false );
		void loadSpectrumData( bool full = false );

		//Attributes
		double	adjL, adjU;		//Adjusted lower and upper borders
		bool	isIndiv;		//Individual scale
		char	wScale;
#if HAVE_FFTW3_H
		// FFT
		int		fftN;		//Spectrum samples number
		fftw_complex	*fftOut;	//Spectrum out buffer, size = fftN/2+1
#endif

	    private:
		//Attributes
		string		mAddr;		//A parameter or an archive item address
		double mBordLow, mBordUp;	//Borders
		double		mCurvl;		//Curent value
		QColor		mColor;		//Values line color
		char		mWidth;		//Line width in pixels
		char		mScale;		//Separted scale
		// Archive
		int64_t		arh_per;	//Archive period
		int64_t		arh_beg;	//Archive begin time
		int64_t		arh_end;	//Archive end time
		// Values
		int		val_tp;		//Values type
		deque<SHg>	vals;		//Values buffer

		WdgView 	*view;
	};
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(true), holdCur(true), geomMargin(0), tTimeCurent(false),
		    valsForPix(1), sclWin(false), fMoveHold(false), fMoveTmCh(false),
		    tTime(0), tPict(0), curTime(0), sclHorPer(0), trcPer(0), tSize(1),
		    sclVerScl(100), sclVerSclOff(0), sclHorScl(100), sclHorSclOff(0)	{ }

		int64_t	arhEnd( int64_t def = 0 );

		//Attributes
		unsigned en		:1;
		unsigned active		:1;
		unsigned type		:3;
		unsigned holdCur	:1;
		unsigned geomMargin	:8;
		unsigned bordStyle	:5;
		unsigned tTimeCurent	:1;

		unsigned sclHor		:4;
		unsigned sclVer		:4;
		unsigned valsForPix	:4;

		unsigned sclWin		:1;	//Scale by window

		unsigned fMoveHold	:1;	//Mouse move hold state
		unsigned fMoveTmCh	:1;	//Changed time on moving

		QColor	curColor, sclColor, sclMarkColor;
		QBrush	backGrnd;
		QPen	border;
		QImage	pictObj;
		QRect	pictRect;
		QFont	sclMarkFont;
		QTimer 	*trcTimer;
		vector<TrendObj>	prms;
		int64_t	tTime, tPict, curTime, sclHorPer;
		float	trcPer;
		float	tSize;
		float	fftBeg, fftEnd;
		float	sclVerScl, sclVerSclOff, sclHorScl, sclHorSclOff;
		string	valArch;

		QPoint	holdPnt, startPnt;	//Hold move point and start point of selection by window
	};

	//Methods
	ShapeDiagram( );

	void init( WdgView *view );
	void destroy( WdgView *view );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );

    private slots:
	//Private slots
	void tracing( );	//Trends tracing

    private:
	//Methods
	void makePicture( WdgView *view );
	void makeTrendsPicture( WdgView *view );
	void makeSpectrumPicture( WdgView *view );
	void makeXYPicture( WdgView *view );

	void loadData( WdgView *view, bool full = false );
	void setCursor( WdgView *view, int64_t itm );
};

//************************************************
//* Protocol view shape widget                   *
//************************************************
class ShapeProtocol : public WdgShape
{
    Q_OBJECT

    public:
	//Methods
	ShapeProtocol( );

	void init( WdgView *view );
	void destroy( WdgView *w );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );
	bool eventFilter( WdgView *view, QObject *object, QEvent *event );

    private slots:
	//Private slots
	void tracing( );	//Trends tracing

    private:
	//Data
	// Shape node date
	class ShpDt
	{
	    public:
		//Data
		class ItProp
		{
		    public:
			ItProp( ) : lev(0)	{ }

			int lev;
			string tmpl;
			QColor clr;
			QFont font;
		};
		//Methods
		ShpDt( ) : active(true), tTimeCurent(false), trcPer(0), lev(0), viewOrd(0),
		    time(0), tSize(60), tmPrev(0), tmGrndPrev(0), arhBeg(0), arhEnd(0)	{ }
		//Attributes
		short active	:1;
		short tTimeCurent:1;
		short trcPer	:10;
		short lev	:4;
		short viewOrd	:4;
		QTimer 		*trcTimer;
		QTableWidget	*addrWdg;
		unsigned int	time, tSize, tmPrev, tmGrndPrev;
		unsigned int	arhBeg, arhEnd;
		string		arch, tmpl, col;
		vector<ItProp>	itProps;
		deque<TMess::SRec>	messList;
	};
	//Private methods
	void loadData( WdgView *view, bool full = false );
	// Recursively widgets process for disable focusable and events filter set
	void eventFilterSet( WdgView *view, QWidget *wdg, bool en );
	void setFocus(WdgView *view, QWidget *wdg, bool en = false, bool devel = false );
};

//************************************************
//* Document view shape widget                   *
//************************************************
class ShapeDocument : public WdgShape
{
    Q_OBJECT

    public:
	//Data
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(true), tmpl(false), web(NULL), printCB(false) { }

		string	toHtml( );
		void	nodeProcess( XMLNode *xcur );
#ifndef QT_NO_PRINTER
		void	print( QPrinter *printer );
#endif

		//Attributes
		short	en	:1;
		short	active	:1;
		short	view	:4;
		short	tmpl	:1;
		QWidget	*web;
		string	font;
		string	style;
		string	doc;
		bool	printCB;
	};

	//Methods
	ShapeDocument( );

	void init( WdgView *view );
	void destroy( WdgView *w );
	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );
	bool eventFilter( WdgView *view, QObject *object, QEvent *event );

    private slots:
	void custContextMenu( );
	void printFinished( );

    private:
	//Methods
	//Recursively widgets process for disable focusable and events filter set
	void eventFilterSet( WdgView *view, QWidget *wdg, bool en );
	void setFocus(WdgView *view, QWidget *wdg, bool en = false, bool devel = false );

	//Attributes
	static const char *XHTML_entity;
};

//************************************************
//* User element shape widget                    *
//************************************************
class RunPageView;

class ShapeBox : public WdgShape
{
    public:
	//Data
	// Shape node date
	class ShpDt
	{
	    public:
		//Methods
		ShpDt( ) : en(true), active(false), realAct(false), geomMargin(0), bordStyle(0), inclPg(NULL), inclScrl(NULL)	{ }
		//Attributes
		short	en		:1;
		short	active		:1;
		short	realAct		:1;
		short	geomMargin	:8;
		short	bordStyle	:5;
		QPen		border;
		QBrush		backGrnd;
		RunPageView	*inclPg;
		QScrollArea	*inclScrl;
	};

	//Methods
	ShapeBox( );

	void init( WdgView *view );
	void destroy( WdgView *view );

	bool attrSet( WdgView *view, int uiPrmPos, const string &val, const string &attr = "" );
	bool event( WdgView *view, QEvent *event );
};

//************************************************
//* User function shape widget                   *
//************************************************
class ShapeFunction : public WdgShape
{
    public:
	//Methods
	ShapeFunction( );
	//bool event( WdgView *view, QEvent *event );
};

}

#endif //VIS_SHAPES_H