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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "PresenterTimer.hxx"
#include <com/sun/star/lang/XMultiComponentFactory.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <osl/doublecheckedlocking.h>
#include <osl/thread.hxx>
#include <algorithm>
#include <iterator>
#include <memory>
#include <set>
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
namespace sdext { namespace presenter {
namespace {
class TimerTask
{
public:
TimerTask (
const PresenterTimer::Task& rTask,
const TimeValue& rDueTime,
const sal_Int64 nRepeatIntervall,
const sal_Int32 nTaskId);
~TimerTask() {}
PresenterTimer::Task maTask;
TimeValue maDueTime;
const sal_Int64 mnRepeatIntervall;
const sal_Int32 mnTaskId;
bool mbIsCanceled;
};
typedef std::shared_ptr<TimerTask> SharedTimerTask;
class TimerTaskComparator
{
public:
bool operator() (const SharedTimerTask& rpTask1, const SharedTimerTask& rpTask2) const
{
return rpTask1->maDueTime.Seconds < rpTask2->maDueTime.Seconds
|| (rpTask1->maDueTime.Seconds == rpTask2->maDueTime.Seconds
&& rpTask1->maDueTime.Nanosec < rpTask2->maDueTime.Nanosec);
}
};
/** Queue all scheduled tasks and process them when their time has come.
*/
class TimerScheduler
: public std::enable_shared_from_this<TimerScheduler>,
public ::osl::Thread
{
public:
static std::shared_ptr<TimerScheduler> Instance();
static SharedTimerTask CreateTimerTask (
const PresenterTimer::Task& rTask,
const TimeValue& rDueTime,
const sal_Int64 nRepeatIntervall);
void ScheduleTask (const SharedTimerTask& rpTask);
void CancelTask (const sal_Int32 nTaskId);
static bool GetCurrentTime (TimeValue& rCurrentTime);
static sal_Int64 GetTimeDifference (
const TimeValue& rTargetTime,
const TimeValue& rCurrentTime);
static void ConvertToTimeValue (
TimeValue& rTimeValue,
const sal_Int64 nTimeDifference);
static sal_Int64 ConvertFromTimeValue (
const TimeValue& rTimeValue);
private:
static std::shared_ptr<TimerScheduler> mpInstance;
static ::osl::Mutex maInstanceMutex;
std::shared_ptr<TimerScheduler> mpLateDestroy; // for clean exit
static sal_Int32 mnTaskId;
::osl::Mutex maTaskContainerMutex;
typedef ::std::set<SharedTimerTask,TimerTaskComparator> TaskContainer;
TaskContainer maScheduledTasks;
::osl::Mutex maCurrentTaskMutex;
SharedTimerTask mpCurrentTask;
TimerScheduler();
virtual ~TimerScheduler();
class Deleter {public: void operator () (TimerScheduler* pScheduler) { delete pScheduler; } };
friend class Deleter;
virtual void SAL_CALL run() override;
virtual void SAL_CALL onTerminated() override { mpLateDestroy.reset(); }
};
} // end of anonymous namespace
//===== PresenterTimer ========================================================
sal_Int32 PresenterTimer::ScheduleRepeatedTask (
const Task& rTask,
const sal_Int64 nDelay,
const sal_Int64 nIntervall)
{
TimeValue aCurrentTime;
if (TimerScheduler::GetCurrentTime(aCurrentTime))
{
TimeValue aDueTime;
TimerScheduler::ConvertToTimeValue(
aDueTime,
TimerScheduler::ConvertFromTimeValue (aCurrentTime) + nDelay);
SharedTimerTask pTask (TimerScheduler::CreateTimerTask(rTask, aDueTime, nIntervall));
TimerScheduler::Instance()->ScheduleTask(pTask);
return pTask->mnTaskId;
}
return NotAValidTaskId;
}
void PresenterTimer::CancelTask (const sal_Int32 nTaskId)
{
return TimerScheduler::Instance()->CancelTask(nTaskId);
}
//===== TimerScheduler ========================================================
std::shared_ptr<TimerScheduler> TimerScheduler::mpInstance;
::osl::Mutex TimerScheduler::maInstanceMutex;
sal_Int32 TimerScheduler::mnTaskId = PresenterTimer::NotAValidTaskId;
std::shared_ptr<TimerScheduler> TimerScheduler::Instance()
{
::osl::MutexGuard aGuard (maInstanceMutex);
if (mpInstance.get() == nullptr)
{
mpInstance.reset(new TimerScheduler(), TimerScheduler::Deleter());
mpInstance->create();
}
return mpInstance;
}
TimerScheduler::TimerScheduler()
: maTaskContainerMutex(),
maScheduledTasks(),
maCurrentTaskMutex(),
mpCurrentTask()
{
}
TimerScheduler::~TimerScheduler()
{
}
SharedTimerTask TimerScheduler::CreateTimerTask (
const PresenterTimer::Task& rTask,
const TimeValue& rDueTime,
const sal_Int64 nRepeatIntervall)
{
return std::make_shared<TimerTask>(rTask, rDueTime, nRepeatIntervall, ++mnTaskId);
}
void TimerScheduler::ScheduleTask (const SharedTimerTask& rpTask)
{
if (rpTask.get() == nullptr)
return;
if (rpTask->mbIsCanceled)
return;
{
osl::MutexGuard aTaskGuard (maTaskContainerMutex);
maScheduledTasks.insert(rpTask);
}
}
void TimerScheduler::CancelTask (const sal_Int32 nTaskId)
{
// Set of scheduled tasks is sorted after their due times, not their
// task ids. Therefore we have to do a linear search for the task to
// cancel.
{
::osl::MutexGuard aGuard (maTaskContainerMutex);
TaskContainer::iterator iTask (maScheduledTasks.begin());
TaskContainer::const_iterator iEnd (maScheduledTasks.end());
for ( ; iTask!=iEnd; ++iTask)
{
if ((*iTask)->mnTaskId == nTaskId)
{
maScheduledTasks.erase(iTask);
break;
}
}
}
// The task that is to be canceled may be currently about to be
// processed. Mark it with a flag that a) prevents a repeating task
// from being scheduled again and b) tries to prevent its execution.
{
::osl::MutexGuard aGuard (maCurrentTaskMutex);
if (mpCurrentTask.get() != nullptr
&& mpCurrentTask->mnTaskId == nTaskId)
mpCurrentTask->mbIsCanceled = true;
}
// Let the main-loop cleanup in its own time
}
void SAL_CALL TimerScheduler::run()
{
osl_setThreadName("sdext::presenter::TimerScheduler");
while (true)
{
// Get the current time.
TimeValue aCurrentTime;
if ( ! GetCurrentTime(aCurrentTime))
{
// We can not get the current time and thus can not schedule anything.
break;
}
// Restrict access to the maScheduledTasks member to one, mutext
// guarded, block.
SharedTimerTask pTask;
sal_Int64 nDifference = 0;
{
::osl::MutexGuard aGuard (maTaskContainerMutex);
// There are no more scheduled task. Leave this loop, function and
// live of the TimerScheduler.
if (maScheduledTasks.empty())
break;
nDifference = GetTimeDifference(
(*maScheduledTasks.begin())->maDueTime,
aCurrentTime);
if (nDifference <= 0)
{
pTask = *maScheduledTasks.begin();
maScheduledTasks.erase(maScheduledTasks.begin());
}
}
// Acquire a reference to the current task.
{
::osl::MutexGuard aGuard (maCurrentTaskMutex);
mpCurrentTask = pTask;
}
if (pTask.get() == nullptr)
{
// Wait until the first task becomes due.
TimeValue aTimeValue;
ConvertToTimeValue(aTimeValue, nDifference);
wait(aTimeValue);
}
else
{
// Execute task.
if (pTask->maTask && !pTask->mbIsCanceled)
{
pTask->maTask(aCurrentTime);
// Re-schedule repeating tasks.
if (pTask->mnRepeatIntervall > 0)
{
ConvertToTimeValue(
pTask->maDueTime,
ConvertFromTimeValue(pTask->maDueTime)
+ pTask->mnRepeatIntervall);
ScheduleTask(pTask);
}
}
}
// Release reference to the current task.
{
::osl::MutexGuard aGuard (maCurrentTaskMutex);
mpCurrentTask.reset();
}
}
// While holding maInstanceMutex
osl::Guard< osl::Mutex > aInstance( maInstanceMutex );
mpLateDestroy = mpInstance;
mpInstance.reset();
}
bool TimerScheduler::GetCurrentTime (TimeValue& rCurrentTime)
{
TimeValue aSystemTime;
if (osl_getSystemTime(&aSystemTime))
return osl_getLocalTimeFromSystemTime(&aSystemTime, &rCurrentTime);
return false;
}
sal_Int64 TimerScheduler::GetTimeDifference (
const TimeValue& rTargetTime,
const TimeValue& rCurrentTime)
{
return ConvertFromTimeValue(rTargetTime) - ConvertFromTimeValue(rCurrentTime);
}
void TimerScheduler::ConvertToTimeValue (
TimeValue& rTimeValue,
const sal_Int64 nTimeDifference)
{
rTimeValue.Seconds = sal::static_int_cast<sal_Int32>(nTimeDifference / 1000000000L);
rTimeValue.Nanosec = sal::static_int_cast<sal_Int32>(nTimeDifference % 1000000000L);
}
sal_Int64 TimerScheduler::ConvertFromTimeValue (
const TimeValue& rTimeValue)
{
return sal_Int64(rTimeValue.Seconds) * 1000000000L + rTimeValue.Nanosec;
}
//===== TimerTask =============================================================
namespace {
TimerTask::TimerTask (
const PresenterTimer::Task& rTask,
const TimeValue& rDueTime,
const sal_Int64 nRepeatIntervall,
const sal_Int32 nTaskId)
: maTask(rTask),
maDueTime(rDueTime),
mnRepeatIntervall(nRepeatIntervall),
mnTaskId(nTaskId),
mbIsCanceled(false)
{
}
} // end of anonymous namespace
//===== PresenterTimer ========================================================
::rtl::Reference<PresenterClockTimer> PresenterClockTimer::mpInstance;
::rtl::Reference<PresenterClockTimer> PresenterClockTimer::Instance (
const css::uno::Reference<css::uno::XComponentContext>& rxContext)
{
::osl::MutexGuard aSolarGuard (::osl::Mutex::getGlobalMutex());
::rtl::Reference<PresenterClockTimer> pTimer;
if (mpInstance.is())
{
pTimer = mpInstance;
}
if ( ! pTimer.is())
{
pTimer.set(new PresenterClockTimer(rxContext));
mpInstance = pTimer;
}
return pTimer;
}
PresenterClockTimer::PresenterClockTimer (const Reference<XComponentContext>& rxContext)
: PresenterClockTimerInterfaceBase(m_aMutex),
maListeners(),
maDateTime(),
mnTimerTaskId(PresenterTimer::NotAValidTaskId),
mbIsCallbackPending(false),
mxRequestCallback()
{
Reference<lang::XMultiComponentFactory> xFactory (
rxContext->getServiceManager(), UNO_QUERY);
if (xFactory.is())
mxRequestCallback.set(
xFactory->createInstanceWithContext(
"com.sun.star.awt.AsyncCallback",
rxContext),
UNO_QUERY_THROW);
}
PresenterClockTimer::~PresenterClockTimer()
{
if (mnTimerTaskId != PresenterTimer::NotAValidTaskId)
{
PresenterTimer::CancelTask(mnTimerTaskId);
mnTimerTaskId = PresenterTimer::NotAValidTaskId;
}
Reference<lang::XComponent> xComponent (mxRequestCallback, UNO_QUERY);
if (xComponent.is())
xComponent->dispose();
mxRequestCallback = nullptr;
}
void PresenterClockTimer::AddListener (const SharedListener& rListener)
{
osl::MutexGuard aGuard (maMutex);
maListeners.push_back(rListener);
// Create a timer task when the first listener is added.
if (mnTimerTaskId==PresenterTimer::NotAValidTaskId)
{
mnTimerTaskId = PresenterTimer::ScheduleRepeatedTask(
[this] (TimeValue const& rTime) { return this->CheckCurrentTime(rTime); },
0,
250000000 /*ns*/);
}
}
void PresenterClockTimer::RemoveListener (const SharedListener& rListener)
{
osl::MutexGuard aGuard (maMutex);
ListenerContainer::iterator iListener (::std::find(
maListeners.begin(),
maListeners.end(),
rListener));
if (iListener != maListeners.end())
maListeners.erase(iListener);
if (maListeners.empty())
{
// We have no more clients and therefore are not interested in time changes.
if (mnTimerTaskId != PresenterTimer::NotAValidTaskId)
{
PresenterTimer::CancelTask(mnTimerTaskId);
mnTimerTaskId = PresenterTimer::NotAValidTaskId;
}
mpInstance = nullptr;
}
}
oslDateTime PresenterClockTimer::GetCurrentTime()
{
TimeValue aCurrentTime;
TimerScheduler::GetCurrentTime(aCurrentTime);
oslDateTime aDateTime;
osl_getDateTimeFromTimeValue(&aCurrentTime, &aDateTime);
return aDateTime;
}
void PresenterClockTimer::CheckCurrentTime (const TimeValue& rCurrentTime)
{
css::uno::Reference<css::awt::XRequestCallback> xRequestCallback;
css::uno::Reference<css::awt::XCallback> xCallback;
{
osl::MutexGuard aGuard (maMutex);
TimeValue aCurrentTime (rCurrentTime);
oslDateTime aDateTime;
if (osl_getDateTimeFromTimeValue(&aCurrentTime, &aDateTime))
{
if (aDateTime.Seconds != maDateTime.Seconds
|| aDateTime.Minutes != maDateTime.Minutes
|| aDateTime.Hours != maDateTime.Hours)
{
// The displayed part of the current time has changed.
// Prepare to call the listeners.
maDateTime = aDateTime;
// Schedule notification of listeners.
if (mxRequestCallback.is() && ! mbIsCallbackPending)
{
mbIsCallbackPending = true;
xRequestCallback = mxRequestCallback;
xCallback = this;
}
}
}
}
if (xRequestCallback.is() && xCallback.is())
xRequestCallback->addCallback(xCallback, Any());
}
//----- XCallback -------------------------------------------------------------
void SAL_CALL PresenterClockTimer::notify (const css::uno::Any& rUserData)
throw (css::uno::RuntimeException, std::exception)
{
(void)rUserData;
ListenerContainer aListenerCopy (maListeners);
{
osl::MutexGuard aGuard (maMutex);
mbIsCallbackPending = false;
::std::copy(
maListeners.begin(),
maListeners.end(),
::std::back_inserter(aListenerCopy));
}
if (aListenerCopy.size() > 0)
{
ListenerContainer::const_iterator iListener;
ListenerContainer::const_iterator iEnd (aListenerCopy.end());
for (iListener=aListenerCopy.begin(); iListener!=iEnd; ++iListener)
{
(*iListener)->TimeHasChanged(maDateTime);
}
}
}
} } // end of namespace ::sdext::presenter
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|