AudacityApp.cpp File Reference

#include "AudacityApp.h"
#include <wx/setup.h>
#include <wx/wxcrtvararg.h>
#include <wx/defs.h>
#include <wx/evtloop.h>
#include <wx/bitmap.h>
#include <wx/docview.h>
#include <wx/ipc.h>
#include <wx/window.h>
#include <wx/menu.h>
#include <wx/snglinst.h>
#include <wx/splash.h>
#include <wx/stdpaths.h>
#include <wx/sysopt.h>
#include <wx/fontmap.h>
#include <wx/fs_zip.h>
#include <wx/dir.h>
#include <wx/file.h>
#include <wx/filename.h>
#include <unistd.h>
#include <wx/msw/registry.h>
#include "AudacityLogger.h"
#include "AboutDialog.h"
#include "ActiveProject.h"
#include "AColor.h"
#include "AudacityFileConfig.h"
#include "AudioIO.h"
#include "Benchmark.h"
#include "Clipboard.h"
#include "CommandLineArgs.h"
#include "CrashReport.h"
#include "commands/CommandHandler.h"
#include "commands/AppCommandEvent.h"
#include "widgets/ASlider.h"
#include "Journal.h"
#include "Languages.h"
#include "MenuCreator.h"
#include "PathList.h"
#include "PendingTracks.h"
#include "PluginManager.h"
#include "Project.h"
#include "ProjectAudioIO.h"
#include "ProjectAudioManager.h"
#include "ProjectFileIO.h"
#include "ProjectFileManager.h"
#include "ProjectHistory.h"
#include "ProjectManager.h"
#include "ProjectSettings.h"
#include "ProjectWindow.h"
#include "ProjectWindows.h"
#include "Sequence.h"
#include "SelectFile.h"
#include "TempDirectory.h"
#include "LoadThemeResources.h"
#include "Track.h"
#include "prefs/PrefsDialog.h"
#include "Theme.h"
#include "Viewport.h"
#include "PlatformCompatibility.h"
#include "AutoRecoveryDialog.h"
#include "SplashDialog.h"
#include "FFT.h"
#include "AudacityMessageBox.h"
#include "prefs/DirectoriesPrefs.h"
#include "prefs/GUISettings.h"
#include "tracks/ui/Scrubbing.h"
#include "widgets/FileHistory.h"
#include "wxWidgetsBasicUI.h"
#include "LogWindow.h"
#include "FrameStatisticsDialog.h"
#include "PluginStartupRegistration.h"
#include "IncompatiblePluginsDialog.h"
#include "wxWidgetsWindowPlacement.h"
#include "ModuleManager.h"
#include "PluginHost.h"
#include "Import.h"
#include "../images/Audacity-splash.xpm"
#include <thread>
#include "ExportPluginRegistry.h"
#include "SettingsWX.h"
#include "prefs/EffectsPrefs.h"
#include <ApplicationServices/ApplicationServices.h>

Go to the source code of this file.

Classes
class	IPCConn
class	IPCServ

Namespaces
namespace	anonymous_namespace{AudacityApp.cpp}
	Custom events.
namespace	IMPLEMENT_WX_THEME_SUPPORT

Macros
#define	IPC_APPL   wxT("audacity")
#define	IPC_TOPIC   wxT("System")
#define	ID_IPC_SERVER   6200
#define	ID_IPC_SOCKET   6201
#define	kAudacityAppTimerID   0
#define	WL(lang, sublang)   (lang), (sublang),

Functions
void	anonymous_namespace{AudacityApp.cpp}::PopulatePreferences ()
void	anonymous_namespace{AudacityApp.cpp}::InitCrashreports ()
static bool	CloseAllProjects (bool force)
static void	QuitAudacity (bool bForce)
static void	QuitAudacity ()
int	main (int argc, char *argv[])
	EVT_MENU_RANGE (FileHistory::ID_RECENT_FIRST, FileHistory::ID_RECENT_LAST, AudacityApp::OnMRUFile) bool AudacityApp
void	SetToExtantDirectory (wxString &result, const wxString &dir)

Variables
static bool	gInited = false
static bool	gIsQuitting = false
static std::shared_ptr< wxConfigBase >	gConfig
static wxArrayString	ofqueue
bool	IMPLEMENT_WX_THEME_SUPPORT::sOSXIsGUIApplication { true }
static audacity::ApplicationSettings::Scope	applicationSettingsScope

Macro Definition Documentation

ID_IPC_SERVER

#define ID_IPC_SERVER   6200

Definition at line 974 of file AudacityApp.cpp.

ID_IPC_SOCKET

#define ID_IPC_SOCKET   6201

Definition at line 975 of file AudacityApp.cpp.

IPC_APPL

#define IPC_APPL   wxT("audacity")

Definition at line 796 of file AudacityApp.cpp.

IPC_TOPIC

#define IPC_TOPIC   wxT("System")

Definition at line 797 of file AudacityApp.cpp.

kAudacityAppTimerID

#define kAudacityAppTimerID   0

Definition at line 978 of file AudacityApp.cpp.

WL

#define WL	(		lang,
			sublang
	)		(lang), (sublang),

Definition at line 1147 of file AudacityApp.cpp.

Function Documentation

CloseAllProjects()

static bool CloseAllProjects ( bool  force )

static

Definition at line 506 of file AudacityApp.cpp.

{
   ProjectManager::SetClosingAll(true);
   auto cleanup = finally([]{ ProjectManager::SetClosingAll(false); });
   while (AllProjects{}.size())
   {
      // Closing the project has global side-effect
      // of deletion from gAudacityProjects
      if ( force )
      {
         GetProjectFrame( **AllProjects{}.begin() ).Close(true);
      }
      else
      {
         if (! GetProjectFrame( **AllProjects{}.begin() ).Close())
            return false;
      }
   }
   return true;
}

References AllProjects::begin(), GetProjectFrame(), ProjectManager::SetClosingAll(), and AllProjects::size().

Referenced by AudacityApp::OnEndSession(), and QuitAudacity().

Here is the call graph for this function:

Here is the caller graph for this function:

EVT_MENU_RANGE()

EVT_MENU_RANGE	(	FileHistory::ID_RECENT_FIRST	,
		FileHistory::ID_RECENT_LAST	,
		AudacityApp::OnMRUFile
	)

proj may be null

Definition at line 1007 of file AudacityApp.cpp.

                                                     {
   // Most of the checks below are copied from ProjectManager::OpenFiles.
   // - some rationalisation might be possible.
 
   auto pProj = GetActiveProject().lock();
   auto proj = pProj.get();
 
   if (!fullPathStr.empty())
   {
      // verify that the file exists
      if (wxFile::Exists(fullPathStr))
      {
         FileNames::UpdateDefaultPath(FileNames::Operation::Open, ::wxPathOnly(fullPathStr));
 
         // Make sure it isn't already open.
         // Test here even though AudacityProject::OpenFile() also now checks, because
         // that method does not return the bad result.
         // That itself may be a FIXME.
         if (ProjectFileManager::IsAlreadyOpen(fullPathStr))
            return false;
 
         ( void ) ProjectManager::OpenProject( proj, fullPathStr,
               true /* addtohistory */, false /* reuseNonemptyProject */ );
      }
      else {
         // File doesn't exist - remove file from history
         AudacityMessageBox(
            XO(
"%s could not be found.\n\nIt has been removed from the list of recent files.")
               .Format(fullPathStr) );
         return(false);
      }
   }
   return(true);
}

References AudacityMessageBox(), GetActiveProject(), ProjectFileManager::IsAlreadyOpen(), ProjectManager::OpenProject(), FileNames::UpdateDefaultPath(), and XO().

Here is the call graph for this function:

main()

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 858 of file AudacityApp.cpp.

{
   wxDISABLE_DEBUG_SUPPORT();
 
   CommandLineArgs::argc = argc;
   CommandLineArgs::argv = argv;
 
   if(PluginHost::IsHostProcess())
   {
      sOSXIsGUIApplication = false;
      ProcessSerialNumber psn = { 0, kCurrentProcess };
      TransformProcessType(&psn, kProcessTransformToUIElementApplication);
   }
 
   return wxEntry(argc, argv);
}

References CommandLineArgs::argc, CommandLineArgs::argv, PluginHost::IsHostProcess(), and IMPLEMENT_WX_THEME_SUPPORT::sOSXIsGUIApplication.

Referenced by ToolDock::VisitLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

QuitAudacity() [1/2]

static void QuitAudacity ( )

static

Definition at line 600 of file AudacityApp.cpp.

{
   QuitAudacity(false);
}

References QuitAudacity().

Here is the call graph for this function:

QuitAudacity() [2/2]

static void QuitAudacity ( bool  bForce )

static

Definition at line 527 of file AudacityApp.cpp.

{
   // guard against recursion
   if (gIsQuitting)
      return;
 
   gIsQuitting = true;
 
   wxTheApp->SetExitOnFrameDelete(true);
 
   // Try to close each open window.  If the user hits Cancel
   // in a Save Changes dialog, don't continue.
   // BG: unless force is true
 
   // BG: Are there any projects open?
   //-   if (!AllProjects{}.empty())
/*start+*/
   if (AllProjects{}.empty())
   {
#ifdef __WXMAC__
      Clipboard::Get().Clear();
#endif
   }
   else
/*end+*/
   {
      if (AllProjects{}.size())
         // PRL:  Always did at least once before close might be vetoed
         // though I don't know why that is important
         ProjectManager::SaveWindowSize();
      bool closedAll = CloseAllProjects( bForce );
      if ( !closedAll )
      {
         gIsQuitting = false;
         return;
      }
   }
 
   ModuleManager::Get().Dispatch(AppQuiting);
 
#ifdef EXPERIMENTAL_SCOREALIGN
   CloseScoreAlignDialog();
#endif
 
   // Logger window is always destroyed on macOS,
   // on other platforms - it prevents the runloop
   // termination when exiting is requested
   #if !defined(__WXMAC__)
   LogWindow::Destroy();
   FrameStatisticsDialog::Destroy();
   #endif
 
   //print out profile if we have one by deleting it
   //temporarily commented out till it is added to all projects
   //DELETE Profiler::Instance();
 
   // Save last log for diagnosis
   auto logger = AudacityLogger::Get();
   if (logger)
   {
      wxFileName logFile(FileNames::DataDir(), wxT("lastlog.txt"));
      logger->SaveLog(logFile.GetFullPath());
   }
 
   //remove our logger
   std::unique_ptr<wxLog>{ wxLog::SetActiveTarget(NULL) }; // DELETE
 
   if (bForce)
   {
      wxExit();
   }
}

References AppQuiting, Clipboard::Clear(), CloseAllProjects(), FileNames::DataDir(), LogWindow::Destroy(), FrameStatisticsDialog::Destroy(), ModuleManager::Dispatch(), AllProjects::empty(), AudacityLogger::Get(), ModuleManager::Get(), Clipboard::Get(), gIsQuitting, ProjectManager::SaveWindowSize(), AllProjects::size(), and wxT().

Referenced by AudacityApp::InitPart2(), AudacityApp::OnInit0(), AudacityApp::OnMenuExit(), and QuitAudacity().

Here is the call graph for this function:

Here is the caller graph for this function:

SetToExtantDirectory()

void SetToExtantDirectory	(	wxString &	result,
		const wxString &	dir
	)

Definition at line 1815 of file AudacityApp.cpp.

                                                                    {
   // don't allow path of "".
   if( dir.empty() )
      return;
   if( wxDirExists( dir ) ){
      result = dir;
      return;
   }
   // Use '/' so that this works on Mac and Windows alike.
   wxFileName name( dir + "/junkname.cfg" );
   if( name.Mkdir( wxS_DIR_DEFAULT , wxPATH_MKDIR_FULL ) )
      result = dir;
}

References name.

Referenced by AudacityApp::InitTempDir().

Here is the caller graph for this function:

Variable Documentation

applicationSettingsScope

audacity::ApplicationSettings::Scope applicationSettingsScope

static

Initial value:

{
   []{
      static std::once_flag configSetupFlag;
      std::call_once(configSetupFlag, [&]{
         const auto configFileName = wxFileName { FileNames::Configuration() };
         gConfig = AudacityFileConfig::Create(
            wxTheApp->GetAppName(), wxEmptyString,
            configFileName.GetFullPath(),
            wxEmptyString, wxCONFIG_USE_LOCAL_FILE);
         wxConfigBase::Set(gConfig.get());
      });
      return std::make_unique<SettingsWX>(gConfig);
   }
}

Definition at line 2741 of file AudacityApp.cpp.

gConfig

std::shared_ptr<wxConfigBase> gConfig

static

Definition at line 504 of file AudacityApp.cpp.

Referenced by AudacityApp::CleanUp().

gInited

bool gInited = false

static

Definition at line 497 of file AudacityApp.cpp.

Referenced by AudacityApp::InitPart2(), AudacityApp::MacNewFile(), and AudacityApp::OnTimer().

gIsQuitting

bool gIsQuitting = false

static

Definition at line 498 of file AudacityApp.cpp.

Referenced by AudacityApp::OnEndSession(), AudacityApp::OnExit(), and QuitAudacity().

ofqueue

wxArrayString ofqueue

static

Definition at line 789 of file AudacityApp.cpp.

Referenced by AudacityApp::MacOpenFile(), AudacityApp::MacPrintFile(), IPCConn::OnExec(), and AudacityApp::OnTimer().