]> SALOME platform Git repositories - modules/gui.git/blob - src/PyInterp/PyInterp_Request.h
Salome HOME
Documentation is optional
[modules/gui.git] / src / PyInterp / PyInterp_Request.h
1 // Copyright (C) 2007-2013  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.
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 //  File   : PyInterp_Request.h
23 //  Author : Sergey Anikin (OCC), Adrien Bruneton (CEA/DEN)
24 //  Module : GUI
25
26 #ifndef PYINTERP_REQUEST_H
27 #define PYINTERP_REQUEST_H
28
29 #include "PyInterp.h"
30 #include "PyInterp_Event.h"
31
32 #include <QMutex>
33 #include <QObject>
34
35 class PyInterp_Interp;
36 class PyInterp_Watcher;
37 class PyInterp_Dispatcher;
38 class PyInterp_ExecuteEvent;
39 class PyConsole_Editor;
40
41 class PYINTERP_EXPORT PyInterp_Request
42 {
43   friend class PyInterp_Dispatcher;
44   friend class PyInterp_ExecuteEvent;
45
46   PyInterp_Request();
47   PyInterp_Request( const PyInterp_Request& );
48
49 protected:
50   virtual ~PyInterp_Request() {};
51   // protected destructor - to control deletion of requests
52
53 public:
54   PyInterp_Request( QObject* listener, bool sync = false )
55     : myIsSync( sync ), myListener( listener ) {};
56
57   static void     Destroy( PyInterp_Request* );
58   // Deletes a request
59
60   bool            IsSync() const { return myIsSync; }
61   // Returns true if this request should be processed synchronously,
62   // without putting it to a queue
63
64 protected:
65   virtual void    safeExecute();
66
67   virtual void    execute() = 0;
68   // Should be redefined in successors, contains actual request code
69
70   virtual QEvent* createEvent();
71   // This method can be overridden to customize notification event creation
72
73   virtual void    processEvent( QObject* );
74
75   QObject*        listener() const { return myListener; }
76   void            setListener( QObject* );
77
78 private:
79   void            process();
80
81 private:
82   QMutex          myMutex;
83   bool            myIsSync;
84   QObject*        myListener;
85 };
86
87 class PYINTERP_EXPORT PyInterp_LockRequest : public PyInterp_Request
88 {
89 public:
90
91   PyInterp_LockRequest( PyInterp_Interp* interp, QObject* listener = 0, bool sync = false )
92     : PyInterp_Request( listener, sync ), myInterp( interp )
93   {}
94
95 protected:
96   PyInterp_Interp*  getInterp() const { return myInterp; }
97
98   virtual void      safeExecute();
99
100 private:
101   PyInterp_Interp*  myInterp;
102 };
103
104 #endif // PYINTERP_REQUEST_H