|
1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 |
|
17 #ifndef __VWSPRIV_H__ |
|
18 #define __VWSPRIV_H__ |
|
19 |
|
20 #include <e32base.h> |
|
21 #include <gdi.h> |
|
22 |
|
23 #include "VWSDEF.H" |
|
24 |
|
25 #if defined(_DEBUG) |
|
26 # if defined(ASSERT) |
|
27 # undef ASSERT |
|
28 # endif |
|
29 // Redefine assert to be a little more useful to us, i.e. to include file & line number |
|
30 # define __ASSERT_FILE__(s) _LIT(KPanicFileName,s) |
|
31 # define __ASSERT_PANIC__(l) User::Panic(KPanicFileName().Right(12),l) |
|
32 # define ASSERT(x) { __ASSERT_FILE__(__FILE__); __ASSERT_DEBUG(x, __ASSERT_PANIC__(__LINE__) ); } |
|
33 #endif |
|
34 |
|
35 // |
|
36 // Constants. |
|
37 // |
|
38 |
|
39 |
|
40 _LIT(KViewServerName,"!ViewServer"); |
|
41 _LIT(KViewServerSemaphore,"ViewServerSemaphore"); |
|
42 |
|
43 const TUint KVwsMajorVersionNumber=0; |
|
44 const TUint KVwsMinorVersionNumber=1; |
|
45 const TUint KVwsBuildVersionNumber=1; |
|
46 |
|
47 |
|
48 // |
|
49 // Panic codes. |
|
50 // |
|
51 |
|
52 enum TVwsServerPanic |
|
53 { |
|
54 EVwsServerCreate=1, |
|
55 EVwsServerStart, |
|
56 EVwsBadRequest, |
|
57 EVwsBadDescriptor, |
|
58 EVwsMainSchedulerError, |
|
59 EVwsViewNotFound, |
|
60 EVwsInvalidViewUid, |
|
61 EVwsCustomMessageNotCollected, |
|
62 EVwsViewActive, |
|
63 EVwsViewEventRequestAlreadyPending, |
|
64 EVwsViewActivationEventTimeOut, |
|
65 EVwsNoClientMessage, |
|
66 EVwsInvalidScreenMode, |
|
67 EVwsViewDeactivationEventTimeOut //A view has taken too long to complete its implementation of MCoeView::ViewDeactivated() |
|
68 }; |
|
69 |
|
70 GLREF_C void PanicServer(TVwsServerPanic aPanic); |
|
71 |
|
72 enum TVwsRanges |
|
73 { |
|
74 EFirstUnrestrictedOpcodeInVws, |
|
75 EFirstOpcodeNeedingCustomCheckInVws=100, |
|
76 EFirstOpcodeNeedingSecureIdInVws=101, |
|
77 EFirstOpCodeNeedingPowerMgmt=110, |
|
78 }; |
|
79 // |
|
80 // Request opcodes. |
|
81 // |
|
82 |
|
83 enum TVwsRequestOpcode |
|
84 { |
|
85 //No Capability requirement |
|
86 EVwsFirst=EFirstUnrestrictedOpcodeInVws, |
|
87 EVwsCreate, |
|
88 EVwsAddView, |
|
89 EVwsRemoveView, |
|
90 EVwsRequestViewEvent, |
|
91 EVwsRequestViewEventCancel, |
|
92 EVwsActivateView, |
|
93 EVwsRequestCustomMessage, |
|
94 EVwsStartApp, |
|
95 EVwsDeactivateActiveView, |
|
96 EVwsNotifyNextDeactivation, |
|
97 EVwsNotifyNextActivation, |
|
98 EVwsCreateActivateViewEvent, |
|
99 EVwsCreateDeactivateViewEvent, |
|
100 EVwsGetSystemDefaultView, |
|
101 EVwsCheckSourceOfViewSwitch, |
|
102 EVwsAsynchronousMessageForServerToPanicClientWith, |
|
103 EVwsSetProtected, |
|
104 EVwsSetCrossCheckUid, |
|
105 EVwsDeactivateActiveViewIfOwnerMatch, |
|
106 EVwsPriority, |
|
107 EVwsSetWindowBackgroundColor, |
|
108 EVwsCurrentActiveViewId, |
|
109 //Custom Check |
|
110 EVwsSetSystemDefaultView=EFirstOpcodeNeedingCustomCheckInVws, |
|
111 //SID of Eiksrvs |
|
112 EVwsSetClientRequestTimeOut=EFirstOpcodeNeedingSecureIdInVws, |
|
113 EVwsSetServerEventTimeOut, |
|
114 EVwsEnableServerEventTimeOut, |
|
115 EVwsEnableServerBlankScreen, |
|
116 //PowerMgmt capability check |
|
117 EVwsClose=EFirstOpCodeNeedingPowerMgmt, |
|
118 // End Marker no Capability |
|
119 EVwsFirstUnusedOpcode |
|
120 }; |
|
121 |
|
122 enum TVwsCompleteRequest |
|
123 { |
|
124 ECompleteRequest, |
|
125 EDoNotCompleteRequest |
|
126 }; |
|
127 |
|
128 /** |
|
129 * The RVwsSession class implements a client session connection to the view server. |
|
130 */ |
|
131 class RVwsSession : public RSessionBase |
|
132 { |
|
133 public: |
|
134 RVwsSession(); |
|
135 TInt Connect(); |
|
136 TVersion Version() const; |
|
137 TInt Shutdown() const; |
|
138 TInt AddView(const TVwsViewId& aViewId) const; |
|
139 TInt SetSystemDefaultView(const TVwsViewId& aViewId,TInt aMode) const; |
|
140 TInt GetSystemDefaultView(TVwsViewId& aViewId); |
|
141 TInt RemoveView(const TVwsViewId& aViewId) const; |
|
142 void RequestViewEvent(TVwsViewEventBuf& aViewEventBuf,TInt aLastError,TRequestStatus& aStatus) const; |
|
143 void RequestViewEvent(TVwsViewEventBuf& aViewEventBuf,TInt aLastError,const TVwsViewIdAndMessageBuf& aViewActivationBuf,const TDesC8& aMessage,TRequestStatus& aStatus) const; |
|
144 TInt RequestViewEventCancel() const; |
|
145 void ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage,TRequestStatus& aStatus, TInt aCustomControl); |
|
146 TInt ActivateView(const TVwsViewId& aViewId,TUid aCustomMessageId,const TDesC8& aCustomMessage, TInt aCustomControl); |
|
147 TInt RequestCustomMessage(TDes8& aMessageBuf) const; |
|
148 TInt StartApp(TUid aAppToStart) const; |
|
149 void DeactivateActiveView(TRequestStatus& aStatus) const; |
|
150 TInt DeactivateActiveView() const; |
|
151 void DeactivateActiveViewIfOwnerMatch(TRequestStatus& aStatus) const; |
|
152 TInt DeactivateActiveViewIfOwnerMatch() const; |
|
153 TInt NotifyNextDeactivation(const TVwsViewId& aViewId) const; |
|
154 TInt NotifyNextActivation(const TVwsViewId& aViewId) const; |
|
155 TInt SetClientRequestTimeOut(TTimeIntervalMicroSeconds32 aDuration) const; |
|
156 TInt SetServerEventTimeOut(TTimeIntervalMicroSeconds32 aDuration) const; |
|
157 TInt EnableServerEventTimeOut(TBool aEnable) const; |
|
158 TInt CheckSourceOfViewSwitch(TBool& aResult,const TSecurityPolicy& aSecurityPolicy,const char* aDiagnostic) const; |
|
159 TInt GetPriority(); |
|
160 TInt EnableServerBlankScreen(TBool aEnable) const; |
|
161 TInt SetProtected(TBool aEnable) const; |
|
162 TInt SetCrossCheckUid(const TUid& aCrossCheckUid); |
|
163 TInt SetWindowBackgroundColor(const TRgb& aBgColor); |
|
164 TInt GetCurrentActiveViewInSystem(TVwsViewId& aActiveViewId); |
|
165 private: |
|
166 TPckgBuf<TVwsViewId> iActivateViewId; |
|
167 TPtrC8 iCustomMessage; |
|
168 TRequestStatus iPanicStatus; |
|
169 }; |
|
170 |
|
171 |
|
172 class MVwsSessionWrapperObserver; |
|
173 |
|
174 /** |
|
175 * The CVwsEventHandler class actively requests view events from the client session and |
|
176 * forwards these events to any session handler observer. |
|
177 */ |
|
178 class CVwsSessionEventHandler : public CActive |
|
179 { |
|
180 public: |
|
181 CVwsSessionEventHandler(MVwsSessionWrapperObserver& aObserver,RVwsSession& aSession,TInt aPriority); |
|
182 ~CVwsSessionEventHandler(); |
|
183 void Queue(); |
|
184 void OnNextQueueActivateView(const TVwsViewIdAndMessage& aViewIdAndMessage); |
|
185 void DoRunL(); |
|
186 private: // From CActive. |
|
187 void RunL(); |
|
188 void DoCancel(); |
|
189 private: |
|
190 MVwsSessionWrapperObserver& iObserver; |
|
191 RVwsSession& iVwsSession; |
|
192 TVwsViewEventBuf iViewEventBuf; |
|
193 TVwsViewIdAndMessageBuf iViewActivationBuf; |
|
194 TPtrC8 iCustomMessage; |
|
195 TBool iDoActivationNextQueue; |
|
196 TInt iLastError; |
|
197 }; |
|
198 |
|
199 #endif |