CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

syspath.h File Reference

Paths helpers. More...

#include "csextern.h"
#include "array.h"
#include "csstring.h"
#include "ref.h"
#include "util.h"
#include "iutil/stringarray.h"

Go to the source code of this file.

Classes

class  csInstallationPathsHelper
 A helper class containing a number of functions to deal with Crystal Space installation paths. More...
class  csPathsList
 Class to manage a list of paths. More...
struct  csPathsList::Entry
 This structure contains information about a plugin path. More...
class  csPathsUtilities
 A helper class with path-related utilities. More...

Helpers to deal with native paths

char * csExpandPath (const char *path)
csRef< iStringArraycsFindSystemRoots ()
csString csGetAppDir (const char *argv0)
csString csGetAppPath (const char *argv0)
csString csGetConfigPath ()
 Get the installation path.
csPathsListcsGetPluginPaths (const char *argv0)
 Get a list of directories where plugins are installed.
csString csGetResourceDir (const char *argv0)
bool csPathsIdentical (const char *path1, const char *path2)


Detailed Description

Paths helpers.

Definition in file syspath.h.


Function Documentation

csString csGetConfigPath  ) 
 

Get the installation path.

This returns the path where the system has been installed to. It has a limited use because mostly everything should be done through VFS which is installation directory - independent; but some initialization tasks still need this. May return the empty string if unable to determine the installation path.

csPathsList* csGetPluginPaths const char *  argv0  ) 
 

Get a list of directories where plugins are installed.

Remarks:
Caller is responsible to free the list with delete after using it.

bool csPathsIdentical const char *  path1,
const char *  path2
[inline]
 

Deprecated:
Use the equivalent from csPathsUtilities or csInstallationPathsHelper instead.

Definition at line 341 of file syspath.h.

References csPathsUtilities::PathsIdentical().


Generated for Crystal Space by doxygen 1.4.4