1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
* Remmina - The GTK+ Remote Desktop Client
* Copyright (C) 2014-2023 Antenore Gatta, Giovanni Panozzo
*
* 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.
*/
/**
* @file python_wrapper_remmina.h
*
* @brief Contains the implementation of the Python module 'remmina', provided to interface with the application from
* the Python plugin source.
*
* @detail In contrast to the wrapper functions that exist in the plugin specialisation files (e.g.
* python_wrapper_protocol.c or python_wrapper_entry.c), this file contains the API for the
* communication in the direction, from Python to Remmina. This means, if in the Python plugin a function
* is called, that is defined in Remmina, C code, at least in this file, is executed.
*/
#pragma once
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// I N C L U D E S
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#include "python_wrapper_common.h"
#include "python_wrapper_protocol_widget.h"
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// A P I
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
G_BEGIN_DECLS
/**
* Initializes the 'remmina' module in the Python engine.
*/
void python_wrapper_module_init(void);
/**
* @brief Returns a pointer to the Python instance, mapped to the RemminaProtocolWidget or null if not found.
*
* @param gp The widget that is owned by the plugin that should be found.
*
* @details Remmina expects this callback function to be part of one plugin, which is the reason no instance information
* is explicitly passed. To bridge that, this function can be used to retrieve the very plugin instance owning
* the given RemminaProtocolWidget.
*/
PyPlugin* python_wrapper_module_get_plugin(RemminaProtocolWidget* gp);
/**
* @brief Converts the PyObject to RemminaProtocolSetting.
*
* @param dest A target for the converted value.
* @param setting The source value to convert.
*/
void python_wrapper_to_protocol_setting(RemminaProtocolSetting* dest, PyObject* setting);
/**
* @brief Converts the PyObject to RemminaProtocolFeature.
*
* @param dest A target for the converted value.
* @param setting The source value to convert.
*/
void python_wrapper_to_protocol_feature(RemminaProtocolFeature* dest, PyObject* feature);
G_END_DECLS
|
