summaryrefslogtreecommitdiff
path: root/src/bindings/mono/efl_mono/efl_csharp_application.cs
blob: bab17c5d7d9b9275b2b26fe580d2886efbec9b86 (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
 * Copyright 2019 by its authors. See AUTHORS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
using System;
using System.Runtime.InteropServices;
using System.Threading;
using static Efl.UnsafeNativeMethods;

namespace Efl.Csharp
{

/// <summary>The components to be initialized.
/// <para>Since EFL 1.23.</para>
/// </summary>
public enum Components
{
    ///<summary>Basic components: Eina, Eo, Ecore, Evas and DBus.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    Basic,
    ///<summary>The same components of <see cref="Efl.Csharp.Components.Basic"/>
    /// and the Elementary widget toolkit.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    Ui,
}

/// <summary>
/// This represents the entry point for the EFL framework
/// You can use this class to implement the 4 abstract methods which will then be called accordingly
/// All subsystems of efl are booted up correctly when the abstract methods of this class are called.
/// <para>Since EFL 1.23.</para>
/// </summary>
/// <remarks>
/// Calls to efl outside those efl-callbacks or outside the mainloop are not allowed and will lead to issues
/// </remarks>
///
/// <example>
/// UserApp is the class that implements the Application abstract
/// <code>
/// public static void Main()
/// {
///     UserApp editor = new UserApp();
///     editor.Launch(editor);
/// }
/// </code>
/// </example>
public abstract class Application
{
    //the initializied components
    private static Components initComponent;
    //what follows are 3 private functions to boot up the internals of efl
    private static void Init(Efl.Csharp.Components component)
    {
        Eina.Config.Init();
        Efl.Eo.Config.Init();
        ecore_init();
        ecore_init_ex(0, IntPtr.Zero);
        evas_init();
        eldbus.Config.Init();

        if (component == Components.Ui)
        {
            // TODO Support elm command line arguments
#if WIN32       // Not a native define, we define it in our build system
            // Ecore_Win32 uses OleInitialize, which requires single thread apartments
            if (System.Threading.Thread.CurrentThread.GetApartmentState() != ApartmentState.STA)
            {
                throw new InvalidOperationException("UI Applications require STAThreadAttribute in Main()");
            }
#endif
            elm_init(0, IntPtr.Zero);

            Efl.Ui.Win.ExitOnAllWindowsClosed = new Eina.Value(0);
        }

        initComponent = component;
    }

    private static void Shutdown()
    {
        // Try to cleanup everything before actually shutting down.
        System.GC.Collect();
        System.GC.WaitForPendingFinalizers();

        if (initComponent == Components.Ui)
        {
            elm_shutdown();
        }

        eldbus.Config.Shutdown();
        evas_shutdown();
        ecore_shutdown();
        Efl.Eo.Config.Shutdown();
        Eina.Config.Shutdown();
    }

    /// <summary>
    /// Called when the application is started. Arguments from the command line are passed here.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    /// <param name="args">Arguments passed from command line.</param>
    protected abstract void OnInitialize(string[] args);

    /// <summary>
    /// Arguments are passed here, Additional calls to this function may occure,
    /// but then the initialization flag is set to false.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    /// <remarks>
    /// When Initialize is true then OnInitialize is also called
    /// </remarks>
    /// <param name="args">Argsuments passed from command line</param>
    protected virtual void OnArguments(Efl.LoopArguments args)
    {
    }

    /// <summary>
    /// Called when the application is not going to be displayed, or is not used by a user for some time.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    protected virtual void OnPause()
    {
    }

    /// <summary>
    /// Called before an application is used again after a call to OnPause().
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    protected virtual void OnResume()
    {
    }

    /// <summary>
    /// Called before starting the shutdown of the application.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    protected virtual void OnTerminate()
    {
    }

    /// <summary>
    /// This function initializices everything in EFL and runs your application.
    /// This call will result in a call to OnInitialize(), which you application should override.
    /// <para>Since EFL 1.23.</para>
    /// </summary>
    /// <param name="components">The <see cref="Efl.Csharp.Components" /> to run the application.</param>
    public void Launch(Efl.Csharp.Components components = Components.Ui)
    {
        Init(components);
        Efl.App app = Efl.App.AppMain;
        var command_line = new Eina.Array<Eina.Stringshare>();
        command_line.Append(Array.ConvertAll(Environment.GetCommandLineArgs(), s => (Eina.Stringshare)s));
#if EFL_BETA
        app.SetCommandArray(command_line);
#endif
        app.ArgumentsEvent += (object sender, LoopArgumentsEventArgs evt) =>
        {
            if (evt.arg.Initialization)
            {
                var evtArgv = evt.arg.Argv;
                int n = evtArgv.Length;
                var argv = new string[n];
                for (int i = 0; i < n; ++i)
                {
                    argv[i] = evtArgv[i];
                }

                OnInitialize(argv);
            }

            OnArguments(evt.arg);
        };
        app.PauseEvent += (object sender, EventArgs e) =>
        {
            OnPause();
        };
        app.ResumeEvent += (object sender, EventArgs e) =>
        {
            OnResume();
        };
        app.TerminateEvent += (object sender, EventArgs e) =>
        {
            OnTerminate();
        };
        app.Begin();
        Shutdown();
    }
}

}