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

#if defined OS_WIN
#include <windows.h>
 // Unicode helpers
void UTF8ToUTF16(wchar_t* utf16Str, const char* utf8Str, int maxLen);
void UTF16ToUTF8(WDL_String& utf8Str, const wchar_t* utf16Str);
#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 SandboxSafeAppSupportPath(WDL_String& path, const char* appGroupID = "");

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 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);

extern bool AppIsSandboxed();

#ifdef OS_IOS
extern bool IsAuv3AppExtension();
#endif
  
END_IPLUG_NAMESPACE