src/qml/qml/v8/qscriptisolate_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef APIPREAMBLE_P_H
  43 #define APIPREAMBLE_P_H
  44
  45 #include <private/qv8_p.h>
  46 #include "qv8engine_p.h"
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 /**
  51   \internal
  52   Class used to switch to the right isolate. It does the same thing as v8::Isolate::Scope but
  53   it checks for a null engine.
  54   \attention We decided to put context switching "up" which means that it should be as high
  55   as possible on call stack. And it should be switched at most once per public API function call.
  56 */
  57 class QScriptIsolate {
  58 public:
  59     // OperationMode was introduced to reduce number of checking for a null engine pointer. If we
  60     // know that given pointer is not null than we should pass NotNullEngine as constructor argument
  61     // that would nicely remove checking on compilation time.
  62     enum OperationMode {Default, NotNullEngine};
  63     inline QScriptIsolate(const QV8Engine *engine, const OperationMode mode = Default)
  64         : m_engine(engine)
  65         , m_mode(mode)
  66     {
  67         if (m_mode == NotNullEngine || m_engine) {
  68             Q_ASSERT(m_engine);
  69             m_engine->context()->Enter();
  70         }
  71     }
  72
  73     inline ~QScriptIsolate()
  74     {
  75         if (m_mode == NotNullEngine || m_engine) {
  76             m_engine->context()->Exit();
  77         }
  78     }
  79
  80 private:
  81     Q_DISABLE_COPY(QScriptIsolate);
  82     const QV8Engine *m_engine;
  83     const OperationMode m_mode;
  84 };
  85
  86
  87 QT_END_NAMESPACE
  88
  89 #endif // APIPREAMBLE_P_H