mia/Aegisub
1
0
Fork 1
Code Issues Pull requests Projects Releases Wiki Activity

Document using the Doxygen format.

Browse source 
Originally committed to SVN as r3304.
This commit is contained in:
Amar Takhar 2009-07-28 06:07:44 +00:00
parent 7f9099da90
commit 373c0057b2
2 changed files with 86 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
aegisub/src/libosxutil/bundledirs.c
View file

@ -26,6 +26,10 @@
POSSIBILITY OF SUCH DAMAGE. POSSIBILITY OF SUCH DAMAGE.
*/ */
/** @file bundledirs.c
@brief Get various paths from within an OS X bundle.
*/
#include <string.h> #include <string.h>
#include <sys/param.h> #include <sys/param.h>
#include <CoreFoundation/CFBundle.h> #include <CoreFoundation/CFBundle.h>
@ -34,7 +38,7 @@
#include "libosxutil.h" #include "libosxutil.h"
/** @todo document me. */
typedef CFURLRef (*GetURLFunc)(CFBundleRef); typedef CFURLRef (*GetURLFunc)(CFBundleRef);
static char * GetDir(GetURLFunc GetURL) static char * GetDir(GetURLFunc GetURL)

104
aegisub/src/libosxutil/libosxutil.h
View file

@ -26,50 +26,90 @@
POSSIBILITY OF SUCH DAMAGE. POSSIBILITY OF SUCH DAMAGE.
*/ */
/* /** @file libosxutil.h
Utility functions for running regular *NIX libraries inside application * @brief OSX utilities
bundles on Apple Macintosh OS X. *
* Utility functions for running regular *NIX libraries inside application
* bundles on Apple Macintosh OS X.
*
* The GetBundle*Directory functions return the paths of directories inside
* the appliaction bundle where the application can store static data and
* shared libraries for its own use.
* (The bundle and its contents should be considered read-only.)
*
* When linking with this library, be sure to add '-framework CoreFoundation'
* to the GCC commandline.
The GetBundle*Directory functions return the paths of directories inside * @note All strings returned by these functions are allocated by strdup(), it is
the appliaction bundle where the application can store static data and * the responsibility of the caller to free() them.
shared libraries for its own use. * All of the functions may return NULL on error.
(The bundle and its contents should be considered read-only.)
When linking with this library, be sure to add '-framework CoreFoundation'
to the GCC commandline.
*/ */
/*
All strings returned by these functions are allocated by strdup(), it is
the responsibility of the caller to free() them.
All of the functions may return NULL on error.
*/
/* Get the full name of the bundle itself. May return NULL if the current /** @brief Get the full name of bundle.
executable is not inside a bundle. */ * @return Full name of bundle.
* Get the full name of the bundle itself.
*
* @warning May return NULL if the current executable is not inside a bundle.
*/
char * OSX_GetBundlePath(); char * OSX_GetBundlePath();
/* Get the resources directory, mainly for user interface elements /** @brief Get the esources directory.
such as graphics and strings */ * @return Resources directory.
*
* Mainly for user interface elements such as graphics and strings
*/
char * OSX_GetBundleResourcesDirectory(); char * OSX_GetBundleResourcesDirectory();
/* Get the built-in plugins directory. This is generaly only used by native
Carbon and Cocoa applications. It is not for general shared libraries. */ /** @brief Get the built-in plugins directory.
* @return Built-in plugins directory.
*
* This is generaly only used by native Carbon and Cocoa applications. It is
* not for general shared libraries.
*/
char * OSX_GetBundleBuiltInPlugInsDirectory(); char * OSX_GetBundleBuiltInPlugInsDirectory();
/* Get the frameworks directories. These are suitable locations for shared
libraries. /** @brief Get the private Frameworks directory.
Does anyone know the difference between private and shared frameworks * @return Private Framework directory.
inside a bundle? */ *
* These are suitable locations for shared libraries.
*/
char * OSX_GetBundlePrivateFrameworksDirectory(); char * OSX_GetBundlePrivateFrameworksDirectory();
/** @brief Get the shared Frameworks directory.
* @return Shared Framework directory.
*
* @see OSX_GetBundlePrivateFrameworksDirectory()
* @note Does anyone know the difference between private and shared frameworks
* inside a bundle?
*/
char * OSX_GetBundleSharedFrameworksDirectory(); char * OSX_GetBundleSharedFrameworksDirectory();
/* Get the shared support directory, this is a suitable location for static
configuration files. (Remember, bundle is considered read-only.) */ /** @brief Get the shared support directory
* @return Shared support directory
*
* This is a suitable location for static configuration files. (Remember,
* bundle is considered read-only.)
*/
char * OSX_GetBundleSharedSupportDirectory(); char * OSX_GetBundleSharedSupportDirectory();
/* Again, what is the difference between Support and SharedSupport? */
/** @brief Get the support directory
* @return Support directory
* @see OSX_GetBundleSharedSupportDirectory()
* @note Again, what is the difference between Support and SharedSupport?
*/
char * OSX_GetBundleSupportFilesDirectory(); char * OSX_GetBundleSupportFilesDirectory();
/* Get the path to the main executable of the bundle, ie. the binary run /** @brief Get the main executable path.
when the user launches the bundle from Finder. */ * @return Main executable path.
*
* The binary run when the user launches the bundle from Finder.
*/
char * OSX_GetBundleExecutablePath(); char * OSX_GetBundleExecutablePath();
/* Get the path of an auxillary exetutable within the bundle.
Pass the basename of the exetutable to get the path of. */ /** @brief Get the auxillary executable path.
* @return Auxillary executable path.
*
* Pass the basename of the executable to get the path.
*/
char * OSX_GetBundleAuxillaryExecutablePath(const char *executableName); char * OSX_GetBundleAuxillaryExecutablePath(const char *executableName);