src/mapper.h File Reference

#include <glib.h>
#include <stdbool.h>

Go to the source code of this file.

Defines

#define PLAYLIST_FILE_SUFFIX   ".m3u"

Functions

void mapper_init (const char *_music_dir, const char *_playlist_dir)
void mapper_finish (void)
G_GNUC_CONST const char * mapper_get_music_directory_utf8 (void)
 Return the absolute path of the music directory encoded in UTF-8.
G_GNUC_CONST const char * mapper_get_music_directory_fs (void)
 Return the absolute path of the music directory encoded in the filesystem character set.
static G_GNUC_CONST bool mapper_has_music_directory (void)
 Returns true if a music directory was configured.
G_GNUC_PURE const char * map_to_relative_path (const char *path_utf8)
 If the specified absolute path points inside the music directory, this function converts it to a relative path.
G_GNUC_MALLOC char * map_uri_fs (const char *uri)
 Determines the absolute file system path of a relative URI.
G_GNUC_MALLOC char * map_directory_fs (const struct directory *directory)
 Determines the file system path of a directory object.
G_GNUC_MALLOC char * map_directory_child_fs (const struct directory *directory, const char *name)
 Determines the file system path of a directory's child (may be a sub directory or a song).
G_GNUC_MALLOC char * map_song_fs (const struct song *song)
 Determines the file system path of a song.
G_GNUC_MALLOC char * map_fs_to_utf8 (const char *path_fs)
 Maps a file system path (relative to the music directory or absolute) to a relative path in UTF-8 encoding.
G_GNUC_CONST const char * map_spl_path (void)
 Returns the playlist directory.
G_GNUC_PURE char * map_spl_utf8_to_fs (const char *name)
 Maps a playlist name (without the ".m3u" suffix) to a file system path.

Define Documentation

#define PLAYLIST_FILE_SUFFIX   ".m3u"

Definition at line 30 of file mapper.h.


Function Documentation

G_GNUC_MALLOC char* map_directory_child_fs ( const struct directory directory,
const char *  name 
)

Determines the file system path of a directory's child (may be a sub directory or a song).

Parameters:
directory the parent directory object
name the child's name in UTF-8
Returns:
the path in file system encoding, or NULL if mapping failed
G_GNUC_MALLOC char* map_directory_fs ( const struct directory directory  ) 

Determines the file system path of a directory object.

Parameters:
directory the directory object
Returns:
the path in file system encoding, or NULL if mapping failed
G_GNUC_MALLOC char* map_fs_to_utf8 ( const char *  path_fs  ) 

Maps a file system path (relative to the music directory or absolute) to a relative path in UTF-8 encoding.

Parameters:
path_fs a path in file system encoding
Returns:
the relative path in UTF-8, or NULL if mapping failed
G_GNUC_MALLOC char* map_song_fs ( const struct song song  ) 

Determines the file system path of a song.

This must not be a remote song.

Parameters:
song the song object
Returns:
the path in file system encoding, or NULL if mapping failed
G_GNUC_CONST const char* map_spl_path ( void   ) 

Returns the playlist directory.

G_GNUC_PURE char* map_spl_utf8_to_fs ( const char *  name  ) 

Maps a playlist name (without the ".m3u" suffix) to a file system path.

The return value is allocated on the heap and must be freed with g_free().

Returns:
the path in file system encoding, or NULL if mapping failed
G_GNUC_PURE const char* map_to_relative_path ( const char *  path_utf8  ) 

If the specified absolute path points inside the music directory, this function converts it to a relative path.

If not, it returns the unmodified string pointer.

G_GNUC_MALLOC char* map_uri_fs ( const char *  uri  ) 

Determines the absolute file system path of a relative URI.

This is basically done by converting the URI to the file system charset and prepending the music directory.

void mapper_finish ( void   ) 
G_GNUC_CONST const char* mapper_get_music_directory_fs ( void   ) 

Return the absolute path of the music directory encoded in the filesystem character set.

G_GNUC_CONST const char* mapper_get_music_directory_utf8 ( void   ) 

Return the absolute path of the music directory encoded in UTF-8.

static G_GNUC_CONST bool mapper_has_music_directory ( void   )  [inline, static]

Returns true if a music directory was configured.

Definition at line 59 of file mapper.h.

void mapper_init ( const char *  _music_dir,
const char *  _playlist_dir 
)

Generated on 9 Aug 2013 for MPD by  doxygen 1.6.1