anonymous_namespace{FileNames.cpp} Namespace Reference

Classes
struct	XDGDirConfig

Enumerations
enum class	DirTarget {   Cache , Config , Data , State ,   _targetCount }

Functions
FilePath	GetXDGTargetDir (DirTarget target)
FilePath	GetUserTargetDir (DirTarget target, bool allowRoaming)

Variables
static FilePath	gTargetDirs [size_t(DirTarget::_targetCount)] = {}
const XDGDirConfig	gXDGUnixDirs []

Enumeration Type Documentation

DirTarget

enum class anonymous_namespace{FileNames.cpp}::DirTarget

strong

Enumerator
Cache
Config
Data
State
_targetCount

Definition at line 227 of file FileNames.cpp.

{
   Cache,
   Config,
   Data,
   State,
   _targetCount,
};

Function Documentation

GetUserTargetDir()

FilePath anonymous_namespace{FileNames.cpp}::GetUserTargetDir	(	DirTarget	target,
		bool	allowRoaming
	)

Definition at line 282 of file FileNames.cpp.

{
   auto& dir = gTargetDirs[size_t(target)];
   if (dir.empty())
   {
      // If there is a directory "Portable Settings" relative to the
      // executable's EXE file, the prefs are stored in there, otherwise
      // the prefs are stored in the user data dir provided by the OS.
      wxFileName exePath(PlatformCompatibility::GetExecutablePath());
#if defined(__WXMAC__)
      // Path ends for example in "Audacity.app/Contents/MacOSX"
      //exePath.RemoveLastDir();
      //exePath.RemoveLastDir();
      // just remove the MacOSX part.
      exePath.RemoveLastDir();
#endif
      wxFileName portablePrefsPath(exePath.GetPath(), wxT("Portable Settings"));
 
      if (::wxDirExists(portablePrefsPath.GetFullPath()))
      {
         // Use "Portable Settings" folder
         dir = portablePrefsPath.GetFullPath();
      } else
      {
#if defined(__WXGTK__)
         // Use XDG Base Directory compliant folders
         wxString newDir(GetXDGTargetDir(target));
#else
         // Use OS-provided user data dir folder
         wxString newDir(FileNames::LowerCaseAppNameInPath(
            allowRoaming ? wxStandardPaths::Get().GetUserDataDir() :
                           wxStandardPaths::Get().GetUserLocalDataDir()));
#endif
         dir = FileNames::MkDir(newDir);
      }
   }
   return dir;
}

References BasicUI::Get(), PlatformCompatibility::GetExecutablePath(), GetXDGTargetDir(), gTargetDirs, FileNames::LowerCaseAppNameInPath(), FileNames::MkDir(), and wxT().

Here is the call graph for this function:

GetXDGTargetDir()

FilePath anonymous_namespace{FileNames.cpp}::GetXDGTargetDir

(

DirTarget

target

)

Definition at line 257 of file FileNames.cpp.

{
   static const auto oldUnixDataDir = wxFileName::GetHomeDir() + wxT("/.audacity-data");
   static const auto oldUnixDataDirExists = wxDirExists(oldUnixDataDir);
   // Compatibility: Use old user data dir folder, if it already exists
   if (oldUnixDataDirExists)
      return oldUnixDataDir;
 
   // see if the XDG_*_HOME env var is defined. if it is, use its value.
   // if it isn't, use the default XDG-specified value.
   wxString newDir;
   const auto [dirEnvVar, dirDefault] = gXDGUnixDirs[size_t(target)];
   if (!wxGetEnv(dirEnvVar, &newDir) || newDir.empty())
      newDir = wxFileName::GetHomeDir() + dirDefault;
 
#ifdef AUDACITY_NAME
   newDir = newDir + wxT("/" AUDACITY_NAME);
#else
   newDir = newDir + wxT("/audacity");
#endif
 
   return newDir;
}

References gXDGUnixDirs, and wxT().

Referenced by GetUserTargetDir().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

gTargetDirs

FilePath anonymous_namespace{FileNames.cpp}::gTargetDirs[size_t(DirTarget::_targetCount)] = {}

static

Definition at line 236 of file FileNames.cpp.

Referenced by GetUserTargetDir().

gXDGUnixDirs

const XDGDirConfig anonymous_namespace{FileNames.cpp}::gXDGUnixDirs[]

Initial value:

= {
   {wxT("XDG_CACHE_HOME"),  wxT("/.cache")      },
   {wxT("XDG_CONFIG_HOME"), wxT("/.config")     },
   {wxT("XDG_DATA_HOME"),   wxT("/.local/share")},
   {wxT("XDG_STATE_HOME"),  wxT("/.local/state")}
}

Definition at line 245 of file FileNames.cpp.

Referenced by GetXDGTargetDir().