CodeExecution.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidQtWidgets/Common/Python/CodeExecution.h"
#include "MantidPythonInterface/core/GlobalInterpreterLock.h"
#include "MantidPythonInterface/core/VersionCompat.h"
#include "MantidQtWidgets/Common/ScriptEditor.h"
#include <QHash>
#include <QString>
#include <frameobject.h>
 
using Mantid::PythonInterface::GlobalInterpreterLock;
 
namespace {
 
struct ScriptEditorDetails {
  ScriptEditor *editor;
  int lineOffset;
};
 
// Map co_filename objects from PyCodeObject to an editor object
QHash<PyObject *, ScriptEditorDetails> EDITOR_LOOKUP;
 
int traceLineNumber(PyObject *obj, PyFrameObject *frame, int event, PyObject *arg) {
  Q_UNUSED(obj);
  Q_UNUSED(arg);
  if (event != PyTrace_LINE)
    return 0;
  auto iter = EDITOR_LOOKUP.constFind(PyFrame_GetCode(frame)->co_filename);
  if (iter != EDITOR_LOOKUP.constEnd()) {
    const auto &details = iter.value();
    int lineLoc = PyFrame_GetLineNumber(frame) + details.lineOffset;
    details.editor->updateProgressMarkerFromThread(lineLoc, false);
  }
  return 0;
}
} // namespace
 
namespace MantidQt::Widgets::Common::Python {
 
CodeExecution::CodeExecution(ScriptEditor *editor) : m_editor(editor) {}
 
PyObject *CodeExecution::execute(const QString &codeStr, const QString &filename, int flags, PyObject *globals,
                                 int lineOffset) const {
  GlobalInterpreterLock gil;
  PyCompilerFlags compileFlags;
  compileFlags.cf_flags = flags;
  auto compiledCode =
      Py_CompileStringFlags(codeStr.toUtf8().constData(), filename.toUtf8().constData(), Py_file_input, &compileFlags);
  if (!compiledCode) {
    return nullptr;
  }
 
  if (!m_editor) {
    return PyEval_EvalCode(CODE_OBJECT(compiledCode), globals, globals);
  }
 
  ScriptEditorDetails editor_details{m_editor, lineOffset};
  const auto coFileObject = ((PyCodeObject *)compiledCode)->co_filename;
  const auto posIter = EDITOR_LOOKUP.insert(coFileObject, editor_details);
  PyEval_SetTrace((Py_tracefunc)&traceLineNumber, nullptr);
  const auto result = PyEval_EvalCode(CODE_OBJECT(compiledCode), globals, globals);
  PyEval_SetTrace(nullptr, nullptr);
  EDITOR_LOOKUP.erase(posIter);
  return result;
 
} // namespace MantidQt::Widgets::Common::Python
 
} // namespace MantidQt::Widgets::Common::Python