backend.cpp
9.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*
This file is a part of the NVDA project.
URL: http://www.nvda-project.org/
Copyright 2006-2010 NVDA contributers.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2.0, as published by
the Free Software Foundation.
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.
This license can be found at:
http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/
#include <map>
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include <remote/nvdaHelperRemote.h>
#include <common/log.h>
#include <remote/nvdaControllerInternal.h>
#include "storage.h"
#include "backend.h"
using namespace std;
const UINT VBufBackend_t::wmRenderThreadInitialize=RegisterWindowMessage(L"VBufBackend_t::wmRenderThreadInitialize");
const UINT VBufBackend_t::wmRenderThreadTerminate=RegisterWindowMessage(L"VBufBackend_t::wmRenderThreadTerminate");
VBufBackendSet_t VBufBackend_t::runningBackends;
VBufBackend_t::VBufBackend_t(int docHandleArg, int IDArg): renderThreadID(GetWindowThreadProcessId((HWND)UlongToHandle(docHandleArg),NULL)), rootDocHandle(docHandleArg), rootID(IDArg), lock(), renderThreadTimerID(0), invalidSubtreeList() {
LOG_DEBUG(L"Initializing backend with docHandle "<<docHandleArg<<L", ID "<<IDArg);
}
void VBufBackend_t::initialize() {
int renderThreadID=GetWindowThreadProcessId((HWND)UlongToHandle(rootDocHandle),NULL);
LOG_DEBUG(L"render threadID "<<renderThreadID);
registerWindowsHook(WH_CALLWNDPROC,destroy_callWndProcHook);
registerWindowsHook(WH_CALLWNDPROC,renderThread_callWndProcHook);
LOG_DEBUG(L"Registered hook, sending message...");
SendMessage((HWND)UlongToHandle(rootDocHandle),wmRenderThreadInitialize,(WPARAM)this,0);
LOG_DEBUG(L"Message sent, unregistering hook");
unregisterWindowsHook(WH_CALLWNDPROC,renderThread_callWndProcHook);
}
void VBufBackend_t::forceUpdate() {
this->cancelPendingUpdate();
this->update();
}
LRESULT CALLBACK VBufBackend_t::destroy_callWndProcHook(int code, WPARAM wParam,LPARAM lParam) {
CWPSTRUCT* pcwp=(CWPSTRUCT*)lParam;
if((pcwp->message==WM_DESTROY)) {
LOG_DEBUG(L"WM_DESTROY for "<<(pcwp->hwnd));
// Copy the set, as it might be mutated by renderThread_terminate() during iteration.
VBufBackendSet_t backends=runningBackends;
for(VBufBackendSet_t::iterator i=backends.begin();i!=backends.end();++i) {
HWND backendHwnd=(HWND)UlongToHandle(((*i)->rootDocHandle));
if(pcwp->hwnd==backendHwnd) {
LOG_DEBUG(L"calling renderThread_terminate for WM_DESTROY");
(*i)->renderThread_terminate();
}
}
}
return 0;
}
LRESULT CALLBACK VBufBackend_t::renderThread_callWndProcHook(int code, WPARAM wParam,LPARAM lParam) {
CWPSTRUCT* pcwp=(CWPSTRUCT*)lParam;
if((pcwp->message==wmRenderThreadInitialize)) {
LOG_DEBUG(L"Calling renderThread_initialize on backend at "<<pcwp->wParam);
((VBufBackend_t*)(pcwp->wParam))->renderThread_initialize();
} else if((pcwp->message==wmRenderThreadTerminate)) {
LOG_DEBUG(L"Calling renderThread_terminate on backend at "<<pcwp->wParam);
((VBufBackend_t*)(pcwp->wParam))->renderThread_terminate();
}
return 0;
}
void CALLBACK VBufBackend_t::renderThread_winEventProcHook(HWINEVENTHOOK hookID, DWORD eventID, HWND hwnd, long objectID, long childID, DWORD threadID, DWORD time) {
if(eventID==EVENT_OBJECT_DESTROY&&objectID==0&&childID==0) {
LOG_DEBUG(L"Detected destruction of window "<<hwnd);
// Copy the set, as it might be mutated by renderThread_terminate() during iteration.
VBufBackendSet_t backends=runningBackends;
for(VBufBackendSet_t::iterator i=backends.begin();i!=backends.end();++i) {
if(hwnd==(HWND)UlongToHandle(((*i)->rootDocHandle))||IsChild(hwnd,(HWND)UlongToHandle(((*i)->rootDocHandle)))) {
LOG_DEBUG(L"Calling renderThread_terminate for backend at "<<*i);
(*i)->renderThread_terminate();
}
}
}
}
void VBufBackend_t::requestUpdate() {
if(renderThreadTimerID==0) {
renderThreadTimerID=SetTimer(0,0,100,renderThread_timerProc);
nhAssert(renderThreadTimerID);
LOG_DEBUG(L"Set timer with ID "<<renderThreadTimerID);
}
}
void VBufBackend_t::cancelPendingUpdate() {
if(renderThreadTimerID>0) {
KillTimer(0,renderThreadTimerID);
renderThreadTimerID=0;
LOG_DEBUG(L"Killed timer with ID "<<renderThreadTimerID);
}
}
void CALLBACK VBufBackend_t::renderThread_timerProc(HWND hwnd, UINT msg, UINT_PTR timerID, DWORD time) {
LOG_DEBUG(L"Timer fired");
KillTimer(0,timerID);
int threadID=GetCurrentThreadId();
VBufBackend_t* backend=NULL;
for(VBufBackendSet_t::iterator i=runningBackends.begin();i!=runningBackends.end();++i) {
if((*i)->renderThreadID==threadID&&(*i)->renderThreadTimerID==timerID) {
backend=*i;
break;
}
}
if(!backend) {
// This timer is not associated with any backend.
// This probably means the timer message was queued before we killed the timer, so just ignore it.
return;
}
LOG_DEBUG(L"Calling update on backend at "<<backend);
backend->update();
backend->renderThreadTimerID=0;
}
void VBufBackend_t::renderThread_initialize() {
LOG_DEBUG(L"Registering winEvent hook for window destructions");
registerWinEventHook(renderThread_winEventProcHook);
LOG_DEBUG(L"Calling update on backend at "<<this);
this->update();
runningBackends.insert(this);
}
void VBufBackend_t::renderThread_terminate() {
cancelPendingUpdate();
unregisterWinEventHook(renderThread_winEventProcHook);
LOG_DEBUG(L"Unregistered winEvent hook for window destructions");
LOG_DEBUG(L"Calling clearBuffer on backend at "<<this);
this->clearBuffer();
runningBackends.erase(this);
}
bool VBufBackend_t::invalidateSubtree(VBufStorage_controlFieldNode_t* node) {
if(node->updateAncestor) node=node->updateAncestor;
if(!isNodeInBuffer(node)) {
LOG_DEBUGWARNING(L"Node at "<<node<<L" not in buffer at "<<this);
return false;
}
LOG_DEBUG(L"Invalidating node "<<node->getDebugInfo());
this->lock.acquire();
bool needsInsert=true;
for(VBufStorage_controlFieldNodeList_t::iterator i=invalidSubtreeList.begin();i!=invalidSubtreeList.end();) {
VBufStorage_fieldNode_t* existingNode=*i;
if(node==existingNode) { //Node already invalidated
LOG_DEBUG(L"Node already invalidated");
needsInsert=false;
break;
} else if(isDescendantNode(existingNode,node)) { //An ancestor is already invalidated
LOG_DEBUG(L"An ancestor is already invalidated, returning");
needsInsert=false;
break;
} else if(isDescendantNode(node,existingNode)) { //A descedndant has been invalidated
LOG_DEBUG(L"removing a descendant node from the invalid nodes");
//Remove the old descendant
invalidSubtreeList.erase(i++);
//If no other descendants have been removed yet, insert the real node here
//At the place of the first found descendant
if(needsInsert) {
invalidSubtreeList.insert(i,node);
needsInsert=false;
}
} else { //Unrelated node
++i;
}
}
//If the node still has not been inserted yet, insert it at the end now
if(needsInsert) {
LOG_DEBUG(L"Adding node to invalid nodes");
invalidSubtreeList.insert(invalidSubtreeList.end(),node);
}
this->lock.release();
this->requestUpdate();
return true;
}
void VBufBackend_t::update() {
if(this->hasContent()) {
VBufStorage_controlFieldNodeList_t tempSubtreeList;
this->lock.acquire();
LOG_DEBUG(L"Updating "<<invalidSubtreeList.size()<<L" subtrees");
invalidSubtreeList.swap(tempSubtreeList);
this->lock.release();
map<VBufStorage_fieldNode_t*,VBufStorage_buffer_t*> replacementSubtreeMap;
//render all invalid subtrees, storing each subtree in its own buffer
for(VBufStorage_controlFieldNodeList_t::iterator i=tempSubtreeList.begin();i!=tempSubtreeList.end();++i) {
VBufStorage_controlFieldNode_t* node=*i;
LOG_DEBUG(L"re-rendering subtree at "<<node);
VBufStorage_buffer_t* tempBuf=new VBufStorage_buffer_t();
nhAssert(tempBuf); //tempBuf can't be NULL
LOG_DEBUG(L"Created temp buffer at "<<tempBuf);
int docHandle=0, ID=0;
node->getIdentifier(&docHandle,&ID);
LOG_DEBUG(L"subtree node has docHandle "<<docHandle<<L" and ID "<<ID);
LOG_DEBUG(L"Rendering content");
render(tempBuf,docHandle,ID,node);
LOG_DEBUG(L"Rendered content in temp buffer");
replacementSubtreeMap.insert(make_pair(node,tempBuf));
}
this->lock.acquire();
LOG_DEBUG(L"Replacing nodes with content of temp buffers");
if(!this->replaceSubtrees(replacementSubtreeMap)) {
LOG_DEBUGWARNING(L"Error replacing one or more subtrees");
}
this->lock.release();
nvdaControllerInternal_vbufChangeNotify(this->rootDocHandle,this->rootID);
} else {
LOG_DEBUG(L"Initial render");
this->lock.acquire();
render(this,rootDocHandle,rootID);
this->lock.release();
}
LOG_DEBUG(L"Update complete");
}
int VBufBackend_t::getNativeHandleForNode(VBufStorage_controlFieldNode_t* node) {
return 0;
}
VBufStorage_controlFieldNode_t* VBufBackend_t::getNodeForNativeHandle(int nativeHandle) {
return NULL;
}
void VBufBackend_t::terminate() {
if(runningBackends.count(this)>0) {
LOG_DEBUG(L"Render thread not terminated yet");
int renderThreadID=GetWindowThreadProcessId((HWND)UlongToHandle(rootDocHandle),NULL);
LOG_DEBUG(L"render threadID "<<renderThreadID);
registerWindowsHook(WH_CALLWNDPROC,renderThread_callWndProcHook);
LOG_DEBUG(L"Registered hook, sending message...");
SendMessage((HWND)UlongToHandle(rootDocHandle),wmRenderThreadTerminate,(WPARAM)this,0);
LOG_DEBUG(L"Message sent, unregistering hook");
unregisterWindowsHook(WH_CALLWNDPROC,renderThread_callWndProcHook);
} else {
LOG_DEBUG(L"render thread already terminated");
}
unregisterWindowsHook(WH_CALLWNDPROC,destroy_callWndProcHook);
}
void VBufBackend_t::destroy() {
delete this;
}
VBufBackend_t::~VBufBackend_t() {
LOG_DEBUG(L"base Backend destructor called");
nhAssert(runningBackends.count(this) == 0);
}