2015-02-26 01:33:59 -06:00
|
|
|
/* -*- 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>
|
|
|
|
|
2017-01-04 05:06:42 -06:00
|
|
|
class Task;
|
|
|
|
|
|
|
|
class VCL_DLLPUBLIC Scheduler
|
|
|
|
{
|
|
|
|
friend class Task;
|
|
|
|
Scheduler() = delete;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
static void ImplStartTimer ( sal_uInt64 nMS, bool bForce = false );
|
|
|
|
|
|
|
|
public:
|
2017-03-02 11:24:40 -06:00
|
|
|
static constexpr sal_uInt64 ImmediateTimeoutMs = 1;
|
|
|
|
static constexpr sal_uInt64 InfiniteTimeoutMs = 1000 * 60 * 60 * 24; // 1 day
|
2017-01-04 05:06:42 -06:00
|
|
|
|
|
|
|
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 bIdle );
|
2017-02-27 06:51:27 -06:00
|
|
|
/**
|
|
|
|
* Process events until the parameter turns true,
|
|
|
|
* allows processing until a specific event has been processed
|
|
|
|
*/
|
2017-01-04 05:06:42 -06:00
|
|
|
static void ProcessEventsToIdle();
|
2017-02-27 06:51:27 -06:00
|
|
|
static void ProcessEventsToSignal(bool& bSignal);
|
2017-01-04 05:06:42 -06:00
|
|
|
|
|
|
|
/// Control the deterministic mode. In this mode, two subsequent runs of
|
|
|
|
/// LibreOffice fire about the same amount idles.
|
|
|
|
static void SetDeterministicMode(bool bDeterministic);
|
|
|
|
/// Return the current state of deterministic mode.
|
|
|
|
static bool GetDeterministicMode();
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2015-11-25 04:35:37 -06:00
|
|
|
struct ImplSchedulerData;
|
2015-06-03 02:23:44 -05:00
|
|
|
|
2017-01-04 05:06:42 -06:00
|
|
|
enum class TaskPriority
|
|
|
|
{
|
2016-01-12 10:36:49 -06:00
|
|
|
HIGHEST = 0,
|
|
|
|
HIGH = 1,
|
|
|
|
RESIZE = 2,
|
|
|
|
REPAINT = 3,
|
|
|
|
MEDIUM = 3,
|
|
|
|
POST_PAINT = 4,
|
|
|
|
DEFAULT_IDLE = 5,
|
|
|
|
LOW = 6,
|
|
|
|
LOWER = 7,
|
|
|
|
LOWEST = 8
|
2015-02-26 01:33:59 -06:00
|
|
|
};
|
|
|
|
|
2017-01-04 05:06:42 -06:00
|
|
|
class VCL_DLLPUBLIC Task
|
2015-02-26 01:33:59 -06:00
|
|
|
{
|
2017-01-04 05:06:42 -06:00
|
|
|
friend class Scheduler;
|
|
|
|
friend struct ImplSchedulerData;
|
2015-02-26 01:33:59 -06:00
|
|
|
|
2017-01-04 05:06:42 -06:00
|
|
|
ImplSchedulerData *mpSchedulerData; /// Pointer to the element in scheduler list
|
|
|
|
const sal_Char *mpDebugName; /// Useful for debugging
|
|
|
|
TaskPriority mePriority; /// Task priority
|
|
|
|
bool mbActive; /// Currently in the scheduler
|
2015-07-19 18:40:18 -05:00
|
|
|
|
2017-01-19 05:18:52 -06:00
|
|
|
protected:
|
2017-01-17 09:42:56 -06:00
|
|
|
static void StartTimer( sal_uInt64 nMS );
|
2015-07-19 18:40:18 -05:00
|
|
|
|
2017-03-03 13:57:02 -06:00
|
|
|
const ImplSchedulerData* GetSchedulerData() const { return mpSchedulerData; }
|
2017-01-19 05:18:52 -06:00
|
|
|
|
2015-02-26 01:33:59 -06:00
|
|
|
virtual void SetDeletionFlags();
|
2016-01-07 20:53:13 -06:00
|
|
|
/// Is this item ready to be dispatched at nTimeNow
|
2016-09-06 03:44:05 -05:00
|
|
|
virtual bool ReadyForSchedule( bool bIdle, sal_uInt64 nTimeNow ) const = 0;
|
2015-11-25 15:33:15 -06:00
|
|
|
/// Schedule only when other timers and events are processed
|
|
|
|
virtual bool IsIdle() const = 0;
|
|
|
|
/**
|
2016-01-07 20:53:13 -06:00
|
|
|
* Adjust nMinPeriod downwards if we want to be notified before
|
|
|
|
* then, nTimeNow is the current time.
|
2015-11-25 15:33:15 -06:00
|
|
|
*/
|
|
|
|
virtual sal_uInt64 UpdateMinPeriod( sal_uInt64 nMinPeriod, sal_uInt64 nTimeNow ) const = 0;
|
2015-02-26 01:33:59 -06:00
|
|
|
|
|
|
|
public:
|
2017-01-04 05:06:42 -06:00
|
|
|
Task( const sal_Char *pDebugName );
|
|
|
|
Task( const Task& rTask );
|
2017-02-10 03:24:16 -06:00
|
|
|
virtual ~Task() COVERITY_NOEXCEPT_FALSE;
|
2017-01-19 05:18:52 -06:00
|
|
|
Task& operator=( const Task& rTask );
|
2015-02-26 01:33:59 -06:00
|
|
|
|
2017-01-04 05:06:42 -06:00
|
|
|
void SetPriority(TaskPriority ePriority) { mePriority = ePriority; }
|
|
|
|
TaskPriority GetPriority() const { return mePriority; }
|
2015-02-26 01:33:59 -06:00
|
|
|
|
2015-06-10 06:08:00 -05:00
|
|
|
void SetDebugName( const sal_Char *pDebugName ) { mpDebugName = pDebugName; }
|
2017-01-19 05:18:52 -06:00
|
|
|
const char *GetDebugName() const { return mpDebugName; }
|
2015-06-10 06:08:00 -05:00
|
|
|
|
2015-03-06 04:13:53 -06:00
|
|
|
// Call handler
|
2015-02-26 01:33:59 -06:00
|
|
|
virtual void Invoke() = 0;
|
|
|
|
|
|
|
|
virtual void Start();
|
2015-06-09 01:55:13 -05:00
|
|
|
void Stop();
|
2015-02-26 01:33:59 -06:00
|
|
|
|
|
|
|
bool IsActive() const { return mbActive; }
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // INCLUDED_VCL_SCHEDULER_HXX
|
|
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|