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
|
/* -*- 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 .
*/
#ifndef INCLUDED_VCL_SCHEDULER_HXX
#define INCLUDED_VCL_SCHEDULER_HXX
#include <vcl/dllapi.h>
class Scheduler;
struct ImplSVData;
struct ImplSchedulerData;
enum class SchedulerPriority {
HIGHEST = 0,
HIGH = 1,
RESIZE = 2,
REPAINT = 3,
MEDIUM = 3,
LOW = 4,
LOWER = 5,
LOWEST = 6
};
class VCL_DLLPUBLIC Scheduler
{
private:
static void InitSystemTimer(ImplSVData* pSVData);
protected:
ImplSchedulerData* mpSchedulerData; /// Pointer to element in scheduler list
const sal_Char *mpDebugName; /// Useful for debugging
SchedulerPriority mePriority; /// Scheduler priority
bool mbActive; /// Currently in the scheduler
// These should be constexpr static, when supported.
static const sal_uInt64 ImmediateTimeoutMs = 1;
static const sal_uInt64 MaximumTimeoutMs = 1000 * 60; // 1 minute
static void ImplStartTimer(sal_uInt64 nMS, bool bForce = false);
friend struct ImplSchedulerData;
virtual void SetDeletionFlags();
/// Is this item ready to be dispatched at @nTimeNow
virtual bool ReadyForSchedule( bool bTimerOnly, sal_uInt64 nTimeNow ) const = 0;
/// Schedule only when other timers and events are processed
virtual bool IsIdle() const = 0;
/**
* Adjust @nMinPeriod downwards if we want to be notified before
* then, @nTimeNow is the current time.
*/
virtual sal_uInt64 UpdateMinPeriod( sal_uInt64 nMinPeriod, sal_uInt64 nTimeNow ) const = 0;
public:
Scheduler( const sal_Char *pDebugName = nullptr );
Scheduler( const Scheduler& rScheduler );
virtual ~Scheduler();
void SetPriority(SchedulerPriority ePriority) { mePriority = ePriority; }
SchedulerPriority GetPriority() const { return mePriority; }
void SetDebugName( const sal_Char *pDebugName ) { mpDebugName = pDebugName; }
const char *GetDebugName() { return mpDebugName; }
// Call handler
virtual void Invoke() = 0;
virtual void Start();
void Stop();
bool IsActive() const { return mbActive; }
Scheduler& operator=( const Scheduler& rScheduler );
static void ImplDeInitScheduler();
// Process one pending Timer with highhest priority
static void CallbackTaskScheduling( bool ignore );
/// Calculate minimum timeout - and return its value.
static sal_uInt64 CalculateMinimumTimeout( bool &bHasActiveIdles );
/// Process one pending task ahead of time with highest priority.
static bool ProcessTaskScheduling( bool bTimerOnly );
/// Process all events until we are idle
static void ProcessEventsToIdle();
};
#endif // INCLUDED_VCL_SCHEDULER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
