vcl/inc/schedulerimpl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_INC_SCHEDULERIMPL_HXX
  21 #define INCLUDED_VCL_INC_SCHEDULERIMPL_HXX
  22
  23 #include <vcl/scheduler.hxx>
  24 #include <vcl/task.hxx>
  25
  26 class Task;
  27
  28 // Internal scheduler record holding intrusive linked list pieces
  29 struct ImplSchedulerData final
  30 {
  31     ImplSchedulerData* mpNext;        ///< Pointer to the next element in list
  32     Task*              mpTask;        ///< Pointer to VCL Task instance
  33     sal_uInt64         mnUpdateTime;  ///< Last Update Time
  34     TaskPriority       mePriority;    ///< Task priority
  35     /**
  36      * Is the Task currently processed / on the stack?
  37      *
  38      * Since the introduction of the scheduler stack, this became merely a
  39      * debugging and assertion hint. No decisions are anymore made based on
  40      * this, because invoked Tasks are removed from the scheduler lists and
  41      * placed on the stack, so no code should actually ever find one, where
  42      * mbInScheduler is true (I don't see a reason to walk the stack for
  43      * normal Scheduler usage, that is).
  44      *
  45      * This was originally used to prevent invoking Tasks recursively.
  46      **/
  47     bool               mbInScheduler; ///< Task currently processed?
  48
  49     const char *GetDebugName() const;
  50 };
  51
  52 class SchedulerGuard final
  53 {
  54 public:
  55     SchedulerGuard()
  56     {
  57         Scheduler::Lock();
  58     }
  59
  60     ~SchedulerGuard()
  61     {
  62         Scheduler::Unlock();
  63     }
  64 };
  65
  66 #endif // INCLUDED_VCL_INC_SCHEDULERIMPL_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */