Pyrogenesis  trunk
osx_bundle.h
Go to the documentation of this file.
1 /* Copyright (c) 2012 Wildfire Games
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining
4  * a copy of this software and associated documentation files (the
5  * "Software"), to deal in the Software without restriction, including
6  * without limitation the rights to use, copy, modify, merge, publish,
7  * distribute, sublicense, and/or sell copies of the Software, and to
8  * permit persons to whom the Software is furnished to do so, subject to
9  * the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef OSX_BUNDLE_H
24 #define OSX_BUNDLE_H
25 
26 /**
27  * @file
28  * C++ interface to Cocoa implementation for getting bundle information
29  */
30 
31 /**
32  * Check if app is running in a valid bundle
33  *
34  * @return true if valid bundle reference was found matching identifier
35  * property "com.wildfiregames.0ad"
36  */
38 
39 /**
40  * Get the system path to the bundle itself
41  *
42  * @return string containing POSIX-style path in UTF-8 encoding,
43  * else empty string if an error occurred.
44  */
45 std::string osx_GetBundlePath();
46 
47 /**
48  * Get the system path to the bundle's Resources directory
49  *
50  * @return string containing POSIX-style path in UTF-8 encoding,
51  * else empty string if an error occurred.
52  */
53 std::string osx_GetBundleResourcesPath();
54 
55 /**
56  * Get the system path to the bundle's Frameworks directory
57  *
58  * @return string containing POSIX-style path in UTF-8 encoding,
59  * else empty string if an error occurred.
60  */
61 std::string osx_GetBundleFrameworksPath();
62 
63 #endif // OSX_BUNDLE_H
bool osx_IsAppBundleValid()
Check if app is running in a valid bundle.
Definition: osx_bundle.mm:40
std::string osx_GetBundleFrameworksPath()
Get the system path to the bundle's Frameworks directory.
Definition: osx_bundle.mm:107
std::string osx_GetBundleResourcesPath()
Get the system path to the bundle's Resources directory.
Definition: osx_bundle.mm:80
std::string osx_GetBundlePath()
Get the system path to the bundle itself.
Definition: osx_bundle.mm:53