summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/event/EventSystemC.h
blob: 2517eae49131a2ad1072958d823e0f8fad6ace4d (plain)
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/****************************************************************************
**
** Copyright (C) 2013 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QT3DS_EVENT_SYSTEM_C_H
#define QT3DS_EVENT_SYSTEM_C_H
#include <stddef.h> //size_t

// Interface we expect plugins to use in order to interace with the event system.
// This interface is design to avoid using c++ vtables and the C++ abi isn't stable
// across compilers.

#ifdef _cplusplus
extern "C" {
#endif

// Obnoxious long names to void namespace conflicts
enum QT3DSEventSystemEventTypes {
    QT3DSEventSystemEventTypesNoData = 0,
    QT3DSEventSystemEventTypesString = 1,
    QT3DSEventSystemEventTypesNumber = 2,
};

typedef const char *Qt3DSEventSystemStr;

typedef struct _Qt3DSEventSystemEventValue
{
    QT3DSEventSystemEventTypes m_Type;
    double m_Number;
    Qt3DSEventSystemStr m_String;
} Qt3DSEventSystemEventValue;

typedef struct _Qt3DSEventSystemRegisteredStr
{
    Qt3DSEventSystemStr m_Data;
} Qt3DSEventSystemRegisteredStr;

typedef struct _Qt3DSEventSystemEventData
{
    Qt3DSEventSystemRegisteredStr m_Name;
    Qt3DSEventSystemEventValue m_Value;
} Qt3DSEventSystemEventData;

typedef struct _Qt3DSEventSystemEvent
{
    Qt3DSEventSystemEventData *m_Data; // contiguous block of event data.
    int m_NumData;
} Qt3DSEventSystemEvent;

typedef Qt3DSEventSystemEvent *(*Qt3DSEventSystemEventFactoryCreateEventFn)(void *inFactory,
                                                                          int numData);
typedef size_t (*Qt3DSEventSystemEventFactoryMaxNumEventDataFn)(void *inFactory);
typedef size_t (*Qt3DSEventSystemEventFactoryMaxStrLenFn)(void *inFactory);
typedef Qt3DSEventSystemRegisteredStr (*Qt3DSEventSystemEventFactoryRegisterStrFn)(
    void *inFactory, Qt3DSEventSystemStr inStr);
typedef Qt3DSEventSystemStr (*Qt3DSEventSystemEventFactoryAllocateStrFn)(void *inFactory,
                                                                       Qt3DSEventSystemStr inStr);
typedef Qt3DSEventSystemStr (*Qt3DSEventSystemEventFactoryAllocateStrLenFn)(void *inFactory, int len);

// Factory from the provider's perspective.
typedef struct _Qt3DSEventSystemEventFactory
{
    void *m_Factory;
    Qt3DSEventSystemEventFactoryCreateEventFn createEvent;
    Qt3DSEventSystemEventFactoryMaxNumEventDataFn getMaxNumEventData;
    Qt3DSEventSystemEventFactoryMaxStrLenFn getMaxStrLength;
    Qt3DSEventSystemEventFactoryRegisterStrFn registerStr;
    Qt3DSEventSystemEventFactoryAllocateStrFn allocateStr;
    Qt3DSEventSystemEventFactoryAllocateStrLenFn allocateStrLen;

} Qt3DSEventSystemEventFactory;

typedef size_t (*Qt3DSEventSystemProviderGetNextEventsFn)(void *inProvider,
                                                         Qt3DSEventSystemEventFactory inFactory,
                                                         Qt3DSEventSystemEvent **outBuffer,
                                                         size_t outBufLen);
typedef void (*Qt3DSEventSystemProviderReleaseFn)(void *inProvider);

typedef struct _Qt3DSEventSystemEventProvider
{
    void *m_Provider;
    Qt3DSEventSystemProviderGetNextEventsFn getNextEvents;
    Qt3DSEventSystemProviderReleaseFn release;
} Qt3DSEventSystemEventProvider;

typedef void (*Qt3DSEventSystemPollerAddProviderFn)(void *inPoller,
                                                   Qt3DSEventSystemEventProvider inProvider);
typedef void (*Qt3DSEventSystemPollerRemoveProviderFn)(void *inPoller,
                                                      Qt3DSEventSystemEventProvider inProvider);
typedef int (*Qt3DSEventSystemPollerignoreProviderFn)(void *inPoller,
                                                     Qt3DSEventSystemEventProvider inProvider);
typedef int (*Qt3DSEventSystemPolleractivateProviderFn)(void *inPoller,
                                                       Qt3DSEventSystemEventProvider inProvider);

typedef struct _Qt3DSEventSystemEventPoller
{
    void *m_Poller;
    // Providers, once added, will be released by the event poller unless removed
    Qt3DSEventSystemPollerAddProviderFn addProvider;
    // Callers are responsible for releasing removed providers.
    Qt3DSEventSystemPollerRemoveProviderFn removeProvider;
    Qt3DSEventSystemPollerignoreProviderFn ignoreProvider;
    Qt3DSEventSystemPolleractivateProviderFn activateProvider;

} Qt3DSEventSystemEventPoller;

extern const char *PROVIDER_TABLE_ENTRY;
extern const char *POLLER_TABLE_ENTRY;

#ifdef _cplusplus
}
#endif

#endif