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
94
95
96
97
98
99
100
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
/**
* SWIGHIDDENVIRTUAL allows the keyword 'virtual' to be there when the main
* Addon api is compiled, but be hidden from the SWIG code generator.
*
* This is to provide finer grain control over which methods are callbackable
* (is that a word? ...)
* into the scripting language, and which ones are not. True polymorphic
* behavior across the scripting language boundary will ONLY occur where
* the keyword 'virtual' is used. In other words, you can use the macro
* SWIGHIDDENVIRTUAL to 'hide' the polymorphic behavior from the scripting
* language using the macro instead.
*
* Note: You should not hide virtual destructors from the scripting language.
*/
#ifdef SWIG
#define SWIGHIDDENVIRTUAL
#else
#define SWIGHIDDENVIRTUAL virtual
#endif
/**
* SWIG_CONSTANT_FROM_GETTER will define a constant in the scripting
* language from a getter in the Addon api and also provide the
* Addon api declaration. E.g. If you use:
*
* SWIG_CONSTANT_FROM_GETTER(int, MY_CONSTANT);
*
* ... in an Addon api header file then you need to define a function:
*
* int getMy_CONSTANT();
*
* ... in a .cpp file. That call will be made to determine the value
* of the constant in the scripting language.
*/
#ifdef SWIG
#define SWIG_CONSTANT_FROM_GETTER(type,varname) %constant type varname = get##varname ()
#else
#define SWIG_CONSTANT_FROM_GETTER(type,varname) type get##varname ()
#endif
/**
* SWIG_CONSTANT defines a constant in SWIG from an already existing
* definition in the Addon api. E.g. a #define from the core window
* system like SORT_METHOD_PROGRAM_COUNT included in the api via
* a #include can be exposed to the scripting language using
* SWIG_CONSTANT(int,SORT_METHOD_PROGRAM_COUNT).
*
* This macro can be used when the constant name and the C++ reference
* look the same. When they look different see SWIG_CONSTANT2
*
* Note, this declaration is invisible to the API C++ code and can
* only be seen by the SWIG processor.
*/
#ifdef SWIG
#define SWIG_CONSTANT(type,var) %constant type var = var
#else
#define SWIG_CONSTANT(type,var)
#endif
/**
* SWIG_CONSTANT2 defines a constant in SWIG from an already existing
* definition in the Addon api. E.g. a #define from the core window
* system like SORT_METHOD_VIDEO_YEAR included in the api via
* a #include can be exposed to the scripting language using
* SWIG_CONSTANT2(int,SORT_METHOD_VIDEO_YEAR,SORT_METHOD_YEAR).
*
* This macro can be used when the constant name and the C++ reference
* don't look the same. When they look the same see SWIG_CONSTANT
*
* Note, this declaration is invisible to the API C++ code and can
* only be seen by the SWIG processor.
*/
#ifdef SWIG
#define SWIG_CONSTANT2(type,var,val) %constant type var = val
#else
#define SWIG_CONSTANT2(type,var,val)
#endif
/**
* SWIG_IMMUTABLE defines a member as immutable i.e. read-only.
*
* Note, this declaration is invisible to the API C++ code and can
* only be seen by the SWIG processor.
*/
#ifdef SWIG
#define SWIG_IMMUTABLE(var) %feature("immutable"); var; %feature("immutable", "")
#else
#define SWIG_IMMUTABLE(var) var
#endif
|
