OpenShot Audio Library | OpenShotAudio  0.3.0
juce_ApplicationBase.cpp
1 /*
2  ==============================================================================
3 
4  This file is part of the JUCE library.
5  Copyright (c) 2017 - ROLI Ltd.
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 
23 namespace juce
24 {
25 
26 JUCEApplicationBase::CreateInstanceFunction JUCEApplicationBase::createInstance = nullptr;
27 JUCEApplicationBase* JUCEApplicationBase::appInstance = nullptr;
28 
29 #if JUCE_IOS
30 void* JUCEApplicationBase::iOSCustomDelegate = nullptr;
31 #endif
32 
33 JUCEApplicationBase::JUCEApplicationBase()
34 {
35  jassert (isStandaloneApp() && appInstance == nullptr);
36  appInstance = this;
37 }
38 
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..
51 void 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 
64  }
65 }
66 
68 {
70 }
71 
72 void 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
94 struct JUCEApplicationBase::MultipleInstanceHandler : 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 
127 private:
128  InterProcessLock appLock;
129 
130  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MultipleInstanceHandler)
131 };
132 
133 bool 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
142 struct JUCEApplicationBase::MultipleInstanceHandler {};
143 #endif
144 
145 //==============================================================================
146 #if JUCE_ANDROID
147 
150 
151 #else
152 
153 #if JUCE_WINDOWS && ! defined (_CONSOLE)
154 
156 {
157  return CharacterFunctions::findEndOfToken (CharPointer_UTF16 (GetCommandLineW()),
158  CharPointer_UTF16 (L" "),
159  CharPointer_UTF16 (L"\"")).findEndOfWhitespace();
160 }
161 
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
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_MODULE_AVAILABLE_juce_gui_extra && (! defined(JUCE_WEB_BROWSER) || JUCE_WEB_BROWSER)
187  extern int juce_gtkWebkitMain (int argc, const char* 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 
199 {
200  String argString;
201 
202  for (int i = 1; i < juce_argc; ++i)
203  {
204  String arg (juce_argv[i]);
205 
206  if (arg.containsChar (' ') && ! arg.isQuotedString())
207  arg = arg.quoted ('"');
208 
209  argString << arg << ' ';
210  }
211 
212  return argString.trim();
213 }
214 
216 {
217  return StringArray (juce_argv + 1, juce_argc - 1);
218 }
219 
220 int JUCEApplicationBase::main (int argc, const char* argv[])
221 {
222  JUCE_AUTORELEASEPOOL
223  {
224  juce_argc = argc;
225  juce_argv = argv;
226 
227  #if JUCE_MAC
228  initialiseNSApplication();
229  #endif
230 
231  #if JUCE_LINUX && JUCE_MODULE_AVAILABLE_juce_gui_extra && (! defined(JUCE_WEB_BROWSER) || JUCE_WEB_BROWSER)
232  if (argc >= 2 && String (argv[1]) == "--juce-gtkwebkitfork-child")
233  return juce_gtkWebkitMain (argc, argv);
234  #endif
235 
236  #if JUCE_IOS
237  return juce_iOSMain (argc, argv, iOSCustomDelegate);
238  #else
239 
240  return JUCEApplicationBase::main();
241  #endif
242  }
243 }
244 
245 #endif
246 
247 //==============================================================================
248 int JUCEApplicationBase::main()
249 {
250  ScopedJuceInitialiser_GUI libraryInitialiser;
251  jassert (createInstance != nullptr);
252 
253  const std::unique_ptr<JUCEApplicationBase> app (createInstance());
254  jassert (app != nullptr);
255 
256  if (! app->initialiseApp())
257  return app->shutdownApp();
258 
259  JUCE_TRY
260  {
261  // loop until a quit message is received..
263  }
264  JUCE_CATCH_EXCEPTION
265 
266  return app->shutdownApp();
267 }
268 
269 #endif
270 
271 //==============================================================================
272 bool JUCEApplicationBase::initialiseApp()
273 {
274  #if JUCE_HANDLE_MULTIPLE_INSTANCES
275  if ((! moreThanOneInstanceAllowed()) && sendCommandLineToPreexistingInstance())
276  {
277  DBG ("Another instance is running - quitting...");
278  return false;
279  }
280  #endif
281 
282  #if JUCE_WINDOWS && JUCE_STANDALONE_APPLICATION && (! defined (_CONSOLE)) && (! JUCE_MINGW)
283  if (AttachConsole (ATTACH_PARENT_PROCESS) != 0)
284  {
285  // if we've launched a GUI app from cmd.exe or PowerShell, we need this to enable printf etc.
286  // However, only reassign stdout, stderr, stdin if they have not been already opened by
287  // a redirect or similar.
288  FILE* ignore;
289 
290  if (_fileno(stdout) < 0) freopen_s (&ignore, "CONOUT$", "w", stdout);
291  if (_fileno(stderr) < 0) freopen_s (&ignore, "CONOUT$", "w", stderr);
292  if (_fileno(stdin) < 0) freopen_s (&ignore, "CONIN$", "r", stdin);
293  }
294  #endif
295 
296  // let the app do its setting-up..
298 
299  stillInitialising = false;
300 
301  if (MessageManager::getInstance()->hasStopMessageBeenSent())
302  return false;
303 
304  #if JUCE_HANDLE_MULTIPLE_INSTANCES
305  if (auto* mih = multipleInstanceHandler.get())
307  #endif
308 
309  return true;
310 }
311 
312 int JUCEApplicationBase::shutdownApp()
313 {
314  jassert (JUCEApplicationBase::getInstance() == this);
315 
316  #if JUCE_HANDLE_MULTIPLE_INSTANCES
317  if (auto* mih = multipleInstanceHandler.get())
319  #endif
320 
321  JUCE_TRY
322  {
323  // give the app a chance to clean up..
324  shutdown();
325  }
326  JUCE_CATCH_EXCEPTION
327 
328  multipleInstanceHandler.reset();
329  return getApplicationReturnValue();
330 }
331 
332 } // namespace juce
static bool isAbsolutePath(StringRef path)
Definition: juce_File.cpp:402
static Type findEndOfToken(Type text, BreakType breakCharacters, Type quoteCharacters)
static String JUCE_CALLTYPE getCommandLineParameters()
static JUCEApplicationBase * getInstance() noexcept
bool containsChar(juce_wchar character) const noexcept
bool isQuotedString() const
static MessageManager * getInstance()
virtual void initialise(const String &commandLineParameters)=0
String substring(int startIndex, int endIndex) const
virtual bool moreThanOneInstanceAllowed()=0
int getApplicationReturnValue() const noexcept
static void broadcastMessage(const String &messageText)
void registerBroadcastListener(ActionListener *listener)
static StringArray JUCE_CALLTYPE getCommandLineParameterArray()
void setApplicationReturnValue(int newReturnValue) noexcept
virtual const String getApplicationName()=0
String trim() const
int length() const noexcept
void deregisterBroadcastListener(ActionListener *listener)
String quoted(juce_wchar quoteCharacter='"') const
bool startsWith(StringRef text) const noexcept
static bool isStandaloneApp() noexcept