remmina_plugin_python_common.h

Go to the documentation of this file.

/*
 * Remmina - The GTK+ Remote Desktop Client
 * Copyright (C) 2014-2021 Antenore Gatta, Giovanni Panozzo, Mathias Winterhalter (ToolsDevler)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 *  In addition, as a special exception, the copyright holders give
 *  permission to link the code of portions of this program with the
 *  OpenSSL library under certain conditions as described in each
 *  individual source file, and distribute linked combinations
 *  including the two.
 *  You must obey the GNU General Public License in all respects
 *  for all of the code used other than OpenSSL. *  If you modify
 *  file(s) with this exception, you may extend this exception to your
 *  version of the file(s), but you are not obligated to do so. *  If you
 *  do not wish to do so, delete this exception statement from your
 *  version. *  If you delete this exception statement from all source
 *  files in the program, then also delete it here.
 */

#pragma once

// I N C L U D E S

#include <glib.h>
#include <gtk/gtk.h>

#include <Python.h>
#include <glib.h>
#include <Python.h>
#include <structmember.h>

#include "remmina/plugin.h"
#include "config.h"


// D E C L A R A T I O N S

G_BEGIN_DECLS

// - Attribute names

extern const char* ATTR_NAME;
extern const char* ATTR_ICON_NAME;
extern const char* ATTR_DESCRIPTION;
extern const char* ATTR_VERSION;
extern const char* ATTR_ICON_NAME_SSH;
extern const char* ATTR_FEATURES;
extern const char* ATTR_BASIC_SETTINGS;
extern const char* ATTR_ADVANCED_SETTINGS;
extern const char* ATTR_SSH_SETTING;
extern const char* ATTR_EXPORT_HINTS;
extern const char* ATTR_PREF_LABEL;
extern const char* ATTR_INIT_ORDER;

// You can enable this for debuggin purposes or specify it in the build.
// #define WITH_PYTHON_TRACE_CALLS

#ifdef WITH_PYTHON_TRACE_CALLS
#define CallPythonMethod(instance, name, params, ...)                             \
        remmina_plugin_python_last_result_set(PyObject_CallMethod(instance, name, params, ##__VA_ARGS__)); \
        remmina_plugin_python_log_method_call(instance, name);                                          \
        remmina_plugin_python_check_error()
#else

#define CallPythonMethod(instance, name, params, ...)           \
    PyObject_CallMethod(instance, name, params, ##__VA_ARGS__); \
    remmina_plugin_python_check_error()
#endif // WITH_PYTHON_TRACE_CALLS


// T Y P E S

typedef struct
{
    PyObject_HEAD
    RemminaProtocolWidget* gp;
} PyRemminaProtocolWidget;

typedef struct
{
    RemminaProtocolPlugin* protocol_plugin;
    RemminaFilePlugin* file_plugin;
    RemminaSecretPlugin* secret_plugin;
    RemminaToolPlugin* tool_plugin;
    RemminaEntryPlugin* entry_plugin;
    RemminaPrefPlugin* pref_plugin;
    RemminaPlugin* generic_plugin;
    PyRemminaProtocolWidget* gp;
    PyObject* instance;
} PyPlugin;

typedef struct
{
    PyObject_HEAD;
    RemminaTypeHint type_hint;
    gpointer raw;
} PyGeneric;

#define SELF_CHECK() if (!self) { \
        g_printerr("[%s:%d]: self is null!\n", __FILE__, __LINE__); \
        PyErr_SetString(PyExc_RuntimeError, "Method is not called from an instance (self is null)!"); \
        return NULL; \
    }

// A P I

PyGeneric* remmina_plugin_python_generic_new(void);

void remmina_plugin_python_add_plugin(PyPlugin* plugin);

void remmina_plugin_python_set_service(RemminaPluginService* service);

RemminaTypeHint remmina_plugin_python_to_generic(PyObject* field, gpointer* target);

PyObject* remmina_plugin_python_last_result(void);

PyObject* remmina_plugin_python_last_result_set(PyObject* result);

void remmina_plugin_python_log_method_call(PyObject* instance, const char* method);

gboolean remmina_plugin_python_check_error(void);

long remmina_plugin_python_get_attribute_long(PyObject* instance, const char* attr_name, long def);

gboolean remmina_plugin_python_check_attribute(PyObject* instance, const char* attr_name);

void* remmina_plugin_python_malloc(int bytes);

char* remmina_plugin_python_copy_string_from_python(PyObject* string, Py_ssize_t len);

PyPlugin* remmina_plugin_python_get_plugin(const char* name);

GtkWidget* new_pywidget(GObject* obj);

GtkWidget* get_pywidget(PyObject* obj);

void init_pygobject(void);

G_END_DECLS