IPlugPaths.h

Go to the documentation of this file.

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. 
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#pragma once
 
#include "IPlugUtilities.h"
 
BEGIN_IPLUG_NAMESPACE
 
#if defined OS_MAC || defined OS_IOS
using PluginIDType = const char *;
#elif defined OS_WIN
using PluginIDType = HMODULE;
#else
using PluginIDType = void *;
#endif
 
extern void HostPath(WDL_String& path, const char* bundleID = 0);
 
extern void PluginPath(WDL_String& path, PluginIDType pExtra);
 
extern void BundleResourcePath(WDL_String& path, PluginIDType pExtra = 0);
 
extern void DesktopPath(WDL_String& path);
 
extern void UserHomePath(WDL_String& path);
 
extern void AppSupportPath(WDL_String& path, bool isSystem = false);
 
extern void VST3PresetsPath(WDL_String& path, const char* mfrName, const char* pluginName, bool isSystem = true);
 
extern void INIPath(WDL_String& path, const char* pluginName);
 
extern void WebViewCachePath(WDL_String& path);
 
extern EResourceLocation LocateResource(const char* fileNameOrResID, const char* type, WDL_String& result, const char* bundleID, void* pHInstance, const char* sharedResourcesSubPath);
 
extern const void* LoadWinResource(const char* resID, const char* type, int& sizeInBytes, void* pHInstance);
 
#if defined OS_MAC || defined OS_IOS
 
extern bool AppIsSandboxed();
 
extern void AppGroupContainerPath(WDL_String& path, const char* appGroupID);
 
extern void SharedMusicPath(WDL_String& path);
 
extern bool IsXPCAuHost();
 
extern bool IsOOPAuv3AppExtension();
 
#endif
 
END_IPLUG_NAMESPACE