OpenShot Audio Library | OpenShotAudio: juce_ApplicationBase.cpp Source File

OpenShot Audio Library | OpenShotAudio 0.4.0

Loading...
Searching...
No Matches
juce_ApplicationBase.cpp
1/*
2 ==============================================================================
3
4 This file is part of the JUCE library.
5 Copyright (c) 2022 - Raw Material Software Limited
6
7 JUCE is an open source library subject to commercial or open-source
8 licensing.
9
10 The code included in this file is provided under the terms of the ISC license
11 http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12 To use, copy, modify, and/or distribute this software for any purpose with or
13 without fee is hereby granted provided that the above copyright notice and
14 this permission notice appear in all copies.
15
16 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18 DISCLAIMED.
19
20 ==============================================================================
21*/
22
23namespace juce
24{
25
26JUCEApplicationBase::CreateInstanceFunction JUCEApplicationBase::createInstance = nullptr;
27JUCEApplicationBase* JUCEApplicationBase::appInstance = nullptr;
28
29#if JUCE_IOS
30void* JUCEApplicationBase::iOSCustomDelegate = nullptr;
31#endif
32
33JUCEApplicationBase::JUCEApplicationBase()
34{
35 jassert (isStandaloneApp() && appInstance == nullptr);
36 appInstance = this;
37}
38
39JUCEApplicationBase::~JUCEApplicationBase()
40{
41 jassert (appInstance == this);
42 appInstance = nullptr;
43}
44
45 void JUCEApplicationBase::setApplicationReturnValue (const int newReturnValue) noexcept
46{
47 appReturnValue = newReturnValue;
48}
49
50// This is called on the Mac and iOS where the OS doesn't allow the stack to unwind on shutdown..
51void JUCEApplicationBase::appWillTerminateByForce()
52{
53 JUCE_AUTORELEASEPOOL
54 {
55 {
56 const std::unique_ptr<JUCEApplicationBase> app (appInstance);
57
58 if (app != nullptr)
59 app->shutdownApp();
60 }
61
62 DeletedAtShutdown::deleteAll();
63 MessageManager::deleteInstance();
64 }
65}
66
67 void JUCEApplicationBase::quit()
68{
69 MessageManager::getInstance()->stopDispatchLoop();
70}
71
72void JUCEApplicationBase::sendUnhandledException (const std::exception* const e,
73 const char* const sourceFile,
74 const int lineNumber)
75{
76 if (auto* app = JUCEApplicationBase::getInstance())
77 {
78 // If you hit this assertion then the __FILE__ macro is providing a
79 // relative path instead of an absolute path. On Windows this will be
80 // a path relative to the build directory rather than the currently
81 // running application. To fix this you must compile with the /FC flag.
82 jassert (File::isAbsolutePath (sourceFile));
83
84 app->unhandledException (e, sourceFile, lineNumber);
85 }
86}
87
88//==============================================================================
89#if ! (JUCE_IOS || JUCE_ANDROID)
90 #define JUCE_HANDLE_MULTIPLE_INSTANCES 1
91#endif
92
93#if JUCE_HANDLE_MULTIPLE_INSTANCES
94struct JUCEApplicationBase::MultipleInstanceHandler final : public ActionListener
95{
96 MultipleInstanceHandler (const String& appName)
97 : appLock ("juceAppLock_" + appName)
98 {
99 }
100
101 bool sendCommandLineToPreexistingInstance()
102 {
103 if (appLock.enter (0))
104 return false;
105
106 if (auto* app = JUCEApplicationBase::getInstance())
107 {
108 MessageManager::broadcastMessage (app->getApplicationName() + "/" + app->getCommandLineParameters());
109 return true;
110 }
111
112 jassertfalse;
113 return false;
114 }
115
116 void actionListenerCallback (const String& message) override
117 {
118 if (auto* app = JUCEApplicationBase::getInstance())
119 {
120 auto appName = app->getApplicationName();
121
122 if (message.startsWith (appName + "/"))
123 app->anotherInstanceStarted (message.substring (appName.length() + 1));
124 }
125 }
126
127private:
128 InterProcessLock appLock;
129
130 JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MultipleInstanceHandler)
131};
132
133bool JUCEApplicationBase::sendCommandLineToPreexistingInstance()
134{
135 jassert (multipleInstanceHandler == nullptr); // this must only be called once!
136
137 multipleInstanceHandler.reset (new MultipleInstanceHandler (getApplicationName()));
138 return multipleInstanceHandler->sendCommandLineToPreexistingInstance();
139}
140
141#else
142struct JUCEApplicationBase::MultipleInstanceHandler {};
143#endif
144
145//==============================================================================
146#if JUCE_ANDROID
147
148StringArray JUCEApplicationBase::getCommandLineParameterArray() { return {}; }
149String JUCEApplicationBase::getCommandLineParameters() { return {}; }
150
151#else
152
153#if JUCE_WINDOWS && ! defined (_CONSOLE)
154
155String JUCE_CALLTYPE JUCEApplicationBase::getCommandLineParameters()
156{
157 return CharacterFunctions::findEndOfToken (CharPointer_UTF16 (GetCommandLineW()),
158 CharPointer_UTF16 (L" "),
159 CharPointer_UTF16 (L"\"")).findEndOfWhitespace();
160}
161
162StringArray JUCE_CALLTYPE JUCEApplicationBase::getCommandLineParameterArray()
163{
164 StringArray s;
165 int argc = 0;
166
167 if (auto argv = CommandLineToArgvW (GetCommandLineW(), &argc))
168 {
169 s = StringArray (argv + 1, argc - 1);
170 LocalFree (argv);
171 }
172
173 return s;
174}
175
176#else
177
178#if JUCE_IOS && JUCE_MODULE_AVAILABLE_juce_gui_basics
179 extern int juce_iOSMain (int argc, const char* argv[], void* classPtr);
180#endif
181
182#if JUCE_MAC
183 extern void initialiseNSApplication();
184#endif
185
186#if (JUCE_LINUX || JUCE_BSD) && JUCE_MODULE_AVAILABLE_juce_gui_extra && (! defined (JUCE_WEB_BROWSER) || JUCE_WEB_BROWSER)
187 extern "C" int juce_gtkWebkitMain (int argc, const char* const* argv);
188#endif
189
190#if JUCE_WINDOWS
191 const char* const* juce_argv = nullptr;
192 int juce_argc = 0;
193#else
194 extern const char* const* juce_argv; // declared in juce_core
195 extern int juce_argc;
196#endif
197
198 String JUCEApplicationBase::getCommandLineParameters()
199{
200 String argString;
201
202 for (const auto& arg : getCommandLineParameterArray())
203 {
204 const auto withQuotes = arg.containsChar (' ') && ! arg.isQuotedString()
205 ? arg.quoted ('"')
206 : arg;
207 argString << withQuotes << ' ';
208 }
209
210 return argString.trim();
211}
212
213 StringArray JUCEApplicationBase::getCommandLineParameterArray()
214{
215 StringArray result;
216
217 for (int i = 1; i < juce_argc; ++i)
218 result.add (CharPointer_UTF8 (juce_argv[i]));
219
220 return result;
221}
222
223int JUCEApplicationBase::main (int argc, const char* argv[])
224{
225 JUCE_AUTORELEASEPOOL
226 {
227 juce_argc = argc;
228 juce_argv = argv;
229
230 #if JUCE_MAC
231 initialiseNSApplication();
232 #endif
233
234 #if (JUCE_LINUX || JUCE_BSD) && JUCE_MODULE_AVAILABLE_juce_gui_extra && (! defined (JUCE_WEB_BROWSER) || JUCE_WEB_BROWSER)
235 if (argc >= 2 && String (argv[1]) == "--juce-gtkwebkitfork-child")
236 return juce_gtkWebkitMain (argc, argv);
237 #endif
238
239 #if JUCE_IOS && JUCE_MODULE_AVAILABLE_juce_gui_basics
240 return juce_iOSMain (argc, argv, iOSCustomDelegate);
241 #else
242
243 return JUCEApplicationBase::main();
244 #endif
245 }
246}
247
248#endif
249
250//==============================================================================
251int JUCEApplicationBase::main()
252{
253 ScopedJuceInitialiser_GUI libraryInitialiser;
254 jassert (createInstance != nullptr);
255
256 const std::unique_ptr<JUCEApplicationBase> app (createInstance());
257 jassert (app != nullptr);
258
259 if (! app->initialiseApp())
260 return app->shutdownApp();
261
262 JUCE_TRY
263 {
264 // loop until a quit message is received..
265 MessageManager::getInstance()->runDispatchLoop();
266 }
267 JUCE_CATCH_EXCEPTION
268
269 return app->shutdownApp();
270}
271
272#endif
273
274//==============================================================================
275bool JUCEApplicationBase::initialiseApp()
276{
277 #if JUCE_HANDLE_MULTIPLE_INSTANCES
278 if ((! moreThanOneInstanceAllowed()) && sendCommandLineToPreexistingInstance())
279 {
280 DBG ("Another instance is running - quitting...");
281 return false;
282 }
283 #endif
284
285 #if JUCE_WINDOWS && (! defined (_CONSOLE)) && (! JUCE_MINGW)
286 if (isStandaloneApp() && AttachConsole (ATTACH_PARENT_PROCESS) != 0)
287 {
288 // if we've launched a GUI app from cmd.exe or PowerShell, we need this to enable printf etc.
289 // However, only reassign stdout, stderr, stdin if they have not been already opened by
290 // a redirect or similar.
291 FILE* ignore;
292
293 if (_fileno (stdout) < 0) freopen_s (&ignore, "CONOUT$", "w", stdout);
294 if (_fileno (stderr) < 0) freopen_s (&ignore, "CONOUT$", "w", stderr);
295 if (_fileno (stdin) < 0) freopen_s (&ignore, "CONIN$", "r", stdin);
296 }
297 #endif
298
299 // let the app do its setting-up..
300 initialise (getCommandLineParameters());
301
302 stillInitialising = false;
303
304 if (MessageManager::getInstance()->hasStopMessageBeenSent())
305 return false;
306
307 #if JUCE_HANDLE_MULTIPLE_INSTANCES
308 if (auto* mih = multipleInstanceHandler.get())
309 MessageManager::getInstance()->registerBroadcastListener (mih);
310 #endif
311
312 return true;
313}
314
315int JUCEApplicationBase::shutdownApp()
316{
317 jassert (JUCEApplicationBase::getInstance() == this);
318
319 #if JUCE_HANDLE_MULTIPLE_INSTANCES
320 if (auto* mih = multipleInstanceHandler.get())
321 MessageManager::getInstance()->deregisterBroadcastListener (mih);
322 #endif
323
324 JUCE_TRY
325 {
326 // give the app a chance to clean up..
327 shutdown();
328 }
329 JUCE_CATCH_EXCEPTION
330
331 multipleInstanceHandler.reset();
332 return getApplicationReturnValue();
333}
334
335} // namespace juce
juce::CharPointer_UTF8
Definition juce_CharPointer_UTF8.h:35
juce::CharacterFunctions::findEndOfToken
static Type findEndOfToken(Type text, BreakType breakCharacters, Type quoteCharacters)
Definition juce_CharacterFunctions.h:828
juce::DeletedAtShutdown::deleteAll
static void deleteAll()
Definition juce_DeletedAtShutdown.cpp:50
juce::File::isAbsolutePath
static bool isAbsolutePath(StringRef path)
Definition juce_File.cpp:408
juce::InterProcessLock::enter
bool enter(int timeOutMillisecs=-1)
juce::JUCEApplicationBase::~JUCEApplicationBase
virtual ~JUCEApplicationBase()
Definition juce_ApplicationBase.cpp:39
juce::JUCEApplicationBase::initialise
virtual void initialise(const String &commandLineParameters)=0
juce::JUCEApplicationBase::getApplicationName
virtual const String getApplicationName()=0
juce::JUCEApplicationBase::getCommandLineParameters
static String JUCE_CALLTYPE getCommandLineParameters()
Definition juce_ApplicationBase.cpp:198
juce::JUCEApplicationBase::quit
static void quit()
Definition juce_ApplicationBase.cpp:67
juce::JUCEApplicationBase::getCommandLineParameterArray
static StringArray JUCE_CALLTYPE getCommandLineParameterArray()
Definition juce_ApplicationBase.cpp:213
juce::JUCEApplicationBase::setApplicationReturnValue
void setApplicationReturnValue(int newReturnValue) noexcept
Definition juce_ApplicationBase.cpp:45
juce::JUCEApplicationBase::getInstance
static JUCEApplicationBase * getInstance() noexcept
Definition juce_ApplicationBase.h:96
juce::JUCEApplicationBase::isStandaloneApp
static bool isStandaloneApp() noexcept
Definition juce_ApplicationBase.h:267
juce::JUCEApplicationBase::moreThanOneInstanceAllowed
virtual bool moreThanOneInstanceAllowed()=0
juce::JUCEApplicationBase::getApplicationReturnValue
int getApplicationReturnValue() const noexcept
Definition juce_ApplicationBase.h:262
juce::MessageManager::broadcastMessage
static void broadcastMessage(const String &messageText)
juce::MessageManager::runDispatchLoop
void runDispatchLoop()
Definition juce_MessageManager.cpp:104
juce::MessageManager::stopDispatchLoop
void stopDispatchLoop()
Definition juce_MessageManager.cpp:119
juce::MessageManager::deregisterBroadcastListener
void deregisterBroadcastListener(ActionListener *listener)
Definition juce_MessageManager.cpp:222
juce::MessageManager::registerBroadcastListener
void registerBroadcastListener(ActionListener *listener)
Definition juce_MessageManager.cpp:214
juce::MessageManager::deleteInstance
static void deleteInstance()
Definition juce_MessageManager.cpp:63
juce::MessageManager::getInstance
static MessageManager * getInstance()
Definition juce_MessageManager.cpp:47
juce::StringArray
Definition juce_StringArray.h:35
juce::StringArray::add
void add(String stringToAdd)
Definition juce_StringArray.cpp:136
juce::String
Definition juce_String.h:53
juce::String::trim
String trim() const
Definition juce_String.cpp:1656