Salome HOME
0022652: [CEA 1194] Redirect the traces from embedded Python console in a log file
[modules/gui.git] / src / PyConsole / PyConsole_Editor.h
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  SALOME SALOMEGUI : implementation of desktop and GUI kernel
24 // File   : PyConsole_Editor.h
25 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
26 //
27 #ifndef PYCONSOLE_EDITOR_H
28 #define PYCONSOLE_EDITOR_H
29
30 #include "PyConsole.h"
31
32 #include <QTextEdit>
33
34 class PyConsole_Interp;
35 class PyInterp_Request;
36 class QEventLoop;
37
38 class PYCONSOLE_EXPORT PyConsole_Editor : public QTextEdit
39 {
40   Q_OBJECT;
41
42 public:
43   PyConsole_Editor( PyConsole_Interp* theInterp, QWidget *theParent = 0 );
44   ~PyConsole_Editor();
45   
46   virtual void   addText( const QString& str, const bool newBlock = false, const bool isError = false );
47   bool           isCommand( const QString& str ) const;
48
49   virtual void   exec( const QString& command );
50   void           execAndWait( const QString& command );
51
52   bool           isSync() const;
53   void           setIsSync( const bool );
54
55   bool           isSuppressOutput() const;
56   void           setIsSuppressOutput(const bool);
57
58   bool           isShowBanner() const;
59   void           setIsShowBanner( const bool );
60
61   bool           isLogging() const;
62
63   virtual QSize  sizeHint() const;
64
65 public slots:
66     void           cut();
67     void           paste();
68     void           clear();
69     void           handleReturn();
70     void           onPyInterpChanged( PyConsole_Interp* );
71     void           dump();
72     bool           startLog( const QString& );
73     void           startLog();
74     void           stopLog();
75     void           putLog( const QString& );
76
77 protected:
78   virtual void   dropEvent( QDropEvent* event );
79   virtual void   mouseReleaseEvent( QMouseEvent* event );
80   virtual void   keyPressEvent ( QKeyEvent* event);
81   virtual void   customEvent( QEvent* event);
82
83   virtual PyInterp_Request* createRequest( const QString& );
84
85   /** Convenience function */
86   inline int promptSize() const { return myPrompt.size(); }
87
88   PyConsole_Interp* myInterp;           //!< python interpreter
89
90   QString           myCommandBuffer;    //!< python command buffer
91   QString           myCurrentCommand;   //!< currently being printed command
92   QString           myPrompt;           //!< current command line prompt
93   int               myCmdInHistory;     //!< current history command index
94   QString           myLogFile;          //!< current output log
95   QStringList       myHistory;          //!< commands history buffer
96   QEventLoop*       myEventLoop;        //!< internal event loop
97   QString           myBanner;           //!< current banner
98   bool              myShowBanner;       //!< 'show banner' flag
99   QStringList       myQueue;            //!< python commands queue
100   bool              myIsSync;           //!< synchronous mode flag
101   bool              myIsSuppressOutput; //!< suppress output flag
102 };
103
104 #endif // PYCONSOLE_EDITOR_H