XMMS2
Macros | Functions
xmmsc_util.h File Reference
#include <stdio.h>
#include <stdlib.h>
#include "xmmsc/xmmsc_stdbool.h"

Go to the source code of this file.

Macros

#define XMMS_STRINGIFY_NOEXPAND(x)   #x
 
#define XMMS_STRINGIFY(x)   XMMS_STRINGIFY_NOEXPAND(x)
 
#define x_return_if_fail(expr)   if (!(expr)) { fprintf (stderr, "Failed in file " __FILE__ " on row %d\n", __LINE__); return; }
 
#define x_return_val_if_fail(expr, val)   if (!(expr)) { fprintf (stderr, "Failed in file " __FILE__ " on row %d\n", __LINE__); return val; }
 
#define x_return_null_if_fail(expr)   x_return_val_if_fail (expr, NULL)
 
#define x_oom()   do { fprintf(stderr, "Out of memory in " __FILE__ "on row %d\n", __LINE__); } while (0)
 
#define x_new0(type, num)   calloc (1, sizeof (type) * (num))
 
#define x_new(type, num)   malloc (sizeof (type) * (num))
 
#define x_malloc0(size)   calloc (1, size)
 
#define x_malloc(size)   malloc (size)
 
#define XPOINTER_TO_INT(p)   ((int) (p))
 
#define XPOINTER_TO_UINT(p)   ((unsigned int) (p))
 
#define XINT_TO_POINTER(i)   ((void *) (i))
 
#define XUINT_TO_POINTER(u)   ((void *) (u))
 
#define MIN(a, b)   (((a) < (b)) ? (a) : (b))
 
#define X_N_ELEMENTS(a)   (sizeof (a) / sizeof ((a)[0]))
 
#define XMMS_PATH_MAX   255
 
#define XMMS_DEFAULT_TCP_PORT   9667
 

Functions

const char * xmms_userconfdir_get (char *buf, int len)
 Get the absolute path to the user config dir. More...
 
const char * xmms_usercachedir_get (char *buf, int len)
 Get the absolute path to the user cache dir. More...
 
const char * xmms_default_ipcpath_get (char *buf, int len)
 Get the default connection path. More...
 
const char * xmms_fallback_ipcpath_get (char *buf, int len)
 Get the fallback connection path (if XMMS_PATH is not accessible) More...
 
bool xmms_sleep_ms (int n)
 Sleep for n milliseconds. More...
 

Macro Definition Documentation

◆ MIN

#define MIN (   a,
 
)    (((a) < (b)) ? (a) : (b))

Definition at line 36 of file xmmsc_util.h.

Referenced by xmms_ringbuf_write(), and xmmsv_dict_format().

◆ x_malloc

#define x_malloc (   size)    malloc (size)

Definition at line 19 of file xmmsc_util.h.

Referenced by xmmsv_decode_url().

◆ x_malloc0

#define x_malloc0 (   size)    calloc (1, size)

Definition at line 18 of file xmmsc_util.h.

◆ X_N_ELEMENTS

#define X_N_ELEMENTS (   a)    (sizeof (a) / sizeof ((a)[0]))

Definition at line 40 of file xmmsc_util.h.

◆ x_new

#define x_new (   type,
  num 
)    malloc (sizeof (type) * (num))

Definition at line 17 of file xmmsc_util.h.

◆ x_new0

#define x_new0 (   type,
  num 
)    calloc (1, sizeof (type) * (num))

◆ x_oom

#define x_oom ( )    do { fprintf(stderr, "Out of memory in " __FILE__ "on row %d\n", __LINE__); } while (0)

Definition at line 15 of file xmmsc_util.h.

Referenced by xmmsv_coll_new(), and xmmsv_decode_url().

◆ x_return_if_fail

#define x_return_if_fail (   expr)    if (!(expr)) { fprintf (stderr, "Failed in file " __FILE__ " on row %d\n", __LINE__); return; }

◆ x_return_null_if_fail

#define x_return_null_if_fail (   expr)    x_return_val_if_fail (expr, NULL)

Definition at line 14 of file xmmsc_util.h.

Referenced by xmmsv_coll_get_idlist(), and xmmsv_coll_idlist_get().

◆ x_return_val_if_fail

#define x_return_val_if_fail (   expr,
  val 
)    if (!(expr)) { fprintf (stderr, "Failed in file " __FILE__ " on row %d\n", __LINE__); return val; }

◆ XINT_TO_POINTER

#define XINT_TO_POINTER (   i)    ((void *) (i))

Definition at line 31 of file xmmsc_util.h.

◆ XMMS_DEFAULT_TCP_PORT

#define XMMS_DEFAULT_TCP_PORT   9667

◆ XMMS_PATH_MAX

#define XMMS_PATH_MAX   255

Definition at line 43 of file xmmsc_util.h.

Referenced by main(), and xmms_build_path().

◆ XMMS_STRINGIFY

#define XMMS_STRINGIFY (   x)    XMMS_STRINGIFY_NOEXPAND(x)

◆ XMMS_STRINGIFY_NOEXPAND

#define XMMS_STRINGIFY_NOEXPAND (   x)    #x

Definition at line 9 of file xmmsc_util.h.

◆ XPOINTER_TO_INT

#define XPOINTER_TO_INT (   p)    ((int) (p))

Definition at line 29 of file xmmsc_util.h.

◆ XPOINTER_TO_UINT

#define XPOINTER_TO_UINT (   p)    ((unsigned int) (p))

Definition at line 30 of file xmmsc_util.h.

◆ XUINT_TO_POINTER

#define XUINT_TO_POINTER (   u)    ((void *) (u))

Definition at line 32 of file xmmsc_util.h.

Function Documentation

◆ xmms_default_ipcpath_get()

const char* xmms_default_ipcpath_get ( char *  buf,
int  len 
)

Get the default connection path.

Parameters
bufA char buffer
lenThe length of buf (XMMS_PATH_MAX is a good choice)
Returns
A pointer to buf, or NULL if an error occured.

Definition at line 35 of file utils.c.

◆ xmms_fallback_ipcpath_get()

const char* xmms_fallback_ipcpath_get ( char *  buf,
int  len 
)

Get the fallback connection path (if XMMS_PATH is not accessible)

Parameters
bufA char buffer
lenThe length of buf (XMMS_PATH_MAX is a good choice)
Returns
A pointer to buf, or NULL if an error occured.

Definition at line 93 of file utils_unix.c.

Referenced by xmms_default_ipcpath_get().

◆ xmms_sleep_ms()

bool xmms_sleep_ms ( int  n)

Sleep for n milliseconds.

Parameters
nThe number of milliseconds to sleep.
Returns
true when we waited the full time, false otherwise.

Definition at line 114 of file utils_unix.c.

◆ xmms_usercachedir_get()

const char* xmms_usercachedir_get ( char *  buf,
int  len 
)

Get the absolute path to the user cache dir.

Parameters
bufa char buffer
lenthe lenght of buf (XMMS_PATH_MAX is a good choice)
Returns
A pointer to buf, or NULL if an error occurred.

Definition at line 67 of file utils_unix.c.

◆ xmms_userconfdir_get()

const char* xmms_userconfdir_get ( char *  buf,
int  len 
)

Get the absolute path to the user config dir.

Parameters
bufA char buffer
lenThe length of buf (XMMS_PATH_MAX is a good choice)
Returns
A pointer to buf, or NULL if an error occurred.

Definition at line 80 of file utils_unix.c.

Referenced by xmms_build_path().