]> git.sesse.net Git - vlc/blobdiff - include/vlc_common.h
psz_object_name should not be const! (else module name aliasing cannot work)
[vlc] / include / vlc_common.h
index 121a062737621c5b0bf1ff3b479923616201dcd5..ad0c97f2f49662d5427c50ca9cd7903bf246b574 100644 (file)
  * This file is a collection of common definitions and types
  */
 
+#ifndef PACKAGE
+/* Temporary regression test */
+#error You probably forgot to include config.h!!
+#endif
+
 /*****************************************************************************
  * Required vlc headers
  *****************************************************************************/
-#if defined( __BORLANDC__ )
-#   undef PACKAGE
-#endif
-
-#include "config.h"
-
-#if defined(PACKAGE)
-#   undef PACKAGE_NAME
-#   define PACKAGE_NAME PACKAGE
-#endif
-#if defined(VERSION)
-#   undef PACKAGE_VERSION
-#   define PACKAGE_VERSION VERSION
-#endif
-
-#if defined( __BORLANDC__ )
-#   undef HAVE_VARIADIC_MACROS
-#   undef HAVE_STDINT_H
-#   undef HAVE_INTTYPES_H
-#   undef off_t
-#elif defined( _MSC_VER )
+#if defined( _MSC_VER )
 #   pragma warning( disable : 4244 )
 #endif
 
@@ -117,18 +102,6 @@ typedef uint8_t                 byte_t;
 #define INT64_MAX (9223372036854775807LL)
 #endif
 
-/* ptrdiff_t definition */
-#ifdef HAVE_STDDEF_H
-#   include <stddef.h>
-#else
-#   include <malloc.h>
-#   ifndef _PTRDIFF_T
-#       define _PTRDIFF_T
-/* Not portable in a 64-bit environment. */
-typedef int                 ptrdiff_t;
-#   endif
-#endif
-
 #if defined( WIN32 ) || defined( UNDER_CE )
 #   include <malloc.h>
 #   ifndef PATH_MAX
@@ -136,10 +109,6 @@ typedef int                 ptrdiff_t;
 #   endif
 #endif
 
-#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
-typedef int                 ssize_t;
-#endif
-
 /* Counter for statistics and profiling */
 typedef unsigned long       count_t;
 
@@ -152,10 +121,6 @@ typedef uint8_t             yuv_data_t;
 /* Audio volume */
 typedef uint16_t            audio_volume_t;
 
-#ifndef HAVE_SOCKLEN_T
-typedef int                 socklen_t;
-#endif
-
 /**
  * High precision date or time interval
  *
@@ -235,7 +200,6 @@ typedef struct msg_subscription_t msg_subscription_t;
  */
 typedef enum {
     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
-    PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                         /**  arg2 = playlist_item_t*          , res=can fail */
     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
@@ -491,8 +455,8 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 
 #if defined (WIN32) && defined (DLL_EXPORT)
 #  ifdef __cplusplus
-#    define VLC_PUBLIC_API __declspec(dllexport)
-#    define VLC_PRIVATE_API __declspec(dllexport)
+#    define VLC_PUBLIC_API extern "C" __declspec(dllexport)
+#    define VLC_PRIVATE_API extern "C" __declspec(dllexport)
 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
 #  else
@@ -503,18 +467,18 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 #  endif
 #else
 #  ifdef __cplusplus
-#    if HAVE_ATTRIBUTE_VISIBILITY
-#      define VLC_PUBLIC_API __attribute__((visibility("default")))
-#      define VLC_PRIVATE_API __attribute__((visibility("default")))
+#    ifdef HAVE_ATTRIBUTE_VISIBILITY
+#      define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
+#      define VLC_PRIVATE_API extern "C" __attribute__((visibility("default")))
 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
 #    else
-#      define VLC_PUBLIC_API
+#      define VLC_PUBLIC_API extern "C"
 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
 #    endif
 #  else
-#    if HAVE_ATTRIBUTE_VISIBILITY
+#    ifdef HAVE_ATTRIBUTE_VISIBILITY
 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
@@ -522,7 +486,7 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 #    else
 #      define VLC_PUBLIC_API extern
 #      define VLC_PRIVATE_API extern
-#      define   VLC_EXPORT( type, name, args ) type name args
+#      define   VLC_EXPORT( type, name, args ) extern type name args
 #      define VLC_INTERNAL( type, name, args ) type name args
 #    endif
 #  endif
@@ -559,7 +523,7 @@ typedef struct vlc_object_internals_t vlc_object_internals_t;
     int   i_object_id;                                                      \
     int   i_object_type;                                                    \
     const char *psz_object_type;                                            \
-    const char *psz_object_name;                                            \
+    char *psz_object_name;                                                  \
                                                                             \
     /* Messages header */                                                   \
     char *psz_header;                                                       \
@@ -570,10 +534,10 @@ typedef struct vlc_object_internals_t vlc_object_internals_t;
     vlc_cond_t   object_wait;                                               \
                                                                             \
     /* Object properties */                                                 \
-    volatile vlc_bool_t b_error;                  /**< set by the object */ \
-    volatile vlc_bool_t b_die;                   /**< set by the outside */ \
-    volatile vlc_bool_t b_dead;                   /**< set by the object */ \
-    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
+    volatile bool b_error;                  /**< set by the object */ \
+    volatile bool b_die;                   /**< set by the outside */ \
+    volatile bool b_dead;                   /**< set by the object */ \
+    bool b_force;      /**< set by the outside (eg. module_Need()) */ \
                                                                             \
     /* Stuff related to the libvlc structure */                             \
     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
@@ -608,27 +572,42 @@ struct gc_object_t
             VLC_GC_MEMBERS
 };
 
+#include <assert.h> /* FIXME: should not be included here */
+
 static inline void __vlc_gc_incref( gc_object_t * p_gc )
 {
+    assert( p_gc->i_gc_refcount > 0 );
+
     p_gc->i_gc_refcount ++;
 };
 
 static inline void __vlc_gc_decref( gc_object_t *p_gc )
 {
+    if( !p_gc ) return;
+
+    assert( p_gc->i_gc_refcount > 0 );
+
     p_gc->i_gc_refcount -- ;
 
     if( p_gc->i_gc_refcount == 0 )
     {
         p_gc->pf_destructor( p_gc );
         /* Do not use the p_gc pointer from now on ! */
-     }
+    }
+}
+
+static inline void
+__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
+               void * arg)
+{
+    p_gc->i_gc_refcount = 1;
+    p_gc->pf_destructor = pf_destructor;
+    p_gc->p_destructor_arg = arg;
 }
 
 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
-#define vlc_gc_init( a,b,c ) {  ((gc_object_t *)a)->i_gc_refcount = 0; \
-                              ((gc_object_t *)a)->pf_destructor = b; \
-                              ((gc_object_t *)a)->p_destructor_arg = c; }
+#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
 
 
 /*****************************************************************************
@@ -656,10 +635,15 @@ static inline void __vlc_gc_decref( gc_object_t *p_gc )
 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 #endif
 
-static int64_t GCD( int64_t a, int64_t b )
+static inline int64_t GCD( int64_t a, int64_t b )
 {
-    if( b ) return GCD( b, a % b );
-    else return a;
+    while( b )
+    {
+        int64_t c = a % b;
+        a = b;
+        b = c;
+    }
+    return a;
 }
 
 /* function imported from libavutil/common.h */
@@ -818,109 +802,16 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 /* */
 #define VLC_UNUSED(x) (void)(x)
 
-/* Alignment of critical dynamic data structure
- *
- * Not all platforms support memalign so we provide a vlc_memalign wrapper
- * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
- * *pp_orig is the pointer that has to be freed afterwards.
- */
-#if 0
-#ifdef HAVE_POSIX_MEMALIGN
-#   define vlc_memalign(align,size,pp_orig) \
-    ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
-#endif
-#endif
-#ifdef HAVE_MEMALIGN
-    /* Some systems have memalign() but no declaration for it */
-    void * memalign( size_t align, size_t size );
-
-#   define vlc_memalign(pp_orig,align,size) \
-    ( *(pp_orig) = memalign( align, size ) )
-
-#else /* We don't have any choice but to align manually */
-#   define vlc_memalign(pp_orig,align,size) \
-    (( *(pp_orig) = malloc( size + align - 1 )) \
-        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
-                       & (~(unsigned long)(align-1)) ) \
-        : NULL )
-
-#endif
-
 /* Stuff defined in src/extras/libc.c */
-#ifndef HAVE_STRDUP
-#   define strdup vlc_strdup
-    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_strdup NULL
-#endif
-
-#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
-#   define vasprintf vlc_vasprintf
-    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_vasprintf NULL
-#endif
-
-#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
-#   define asprintf vlc_asprintf
-    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_asprintf NULL
-#endif
-
-#ifndef HAVE_STRNDUP
-#   if defined(STRNDUP_IN_GNOME_H) && \
-        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
-         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
-        /* Do nothing: gnome.h defines strndup for us */
-#   else
-#       define strndup vlc_strndup
-        VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
-#   endif
-#elif !defined(__PLUGIN__)
-#   define vlc_strndup NULL
-#endif
-
-#ifndef HAVE_STRNLEN
-#   define strnlen vlc_strnlen
-    VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_strnlen NULL
-#endif
-
-#ifndef HAVE_STRLCPY
-#   define strlcpy vlc_strlcpy
-    VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_strlcpy NULL
-#endif
-
-#ifndef HAVE_ATOF
-#   define atof vlc_atof
-    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_atof NULL
-#endif
-
-#ifndef HAVE_STRTOF
-#   ifdef HAVE_STRTOD
-#       define strtof strtod
-#   endif
-#endif
-
-#ifndef HAVE_ATOLL
-#   define atoll vlc_atoll
-    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_atoll NULL
-#endif
-
-#ifndef HAVE_STRTOLL
-#   define strtoll vlc_strtoll
-    VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_strtoll NULL
-#endif
+VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
+VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
+VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
+VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
+VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
+VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
+VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
+VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
+VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
 
 #if defined(SYS_BEOS) \
  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
@@ -928,71 +819,18 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
         long long quot; /* Quotient. */
         long long rem;  /* Remainder. */
     } lldiv_t;
-#   define lldiv vlc_lldiv
-    VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_lldiv NULL
-#endif
-
-#ifndef HAVE_SCANDIR
-#   define scandir vlc_scandir
-#   define alphasort vlc_alphasort
-    struct dirent;
-    VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
-    VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_scandir NULL
-#   define vlc_alphasort NULL
 #endif
+VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
 
-#ifndef HAVE_GETENV
-#   define getenv vlc_getenv
-    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
-#elif !defined(__PLUGIN__)
-#   define vlc_getenv NULL
-#endif
+struct dirent;
+VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
+VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
 
-#ifndef HAVE_STRCASECMP
-#   ifndef HAVE_STRICMP
-#       define strcasecmp vlc_strcasecmp
-        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
-#   else
-#       define strcasecmp stricmp
-#       if !defined(__PLUGIN__)
-#           define vlc_strcasecmp NULL
-#       endif
-#   endif
-#elif !defined(__PLUGIN__)
-#   define vlc_strcasecmp NULL
-#endif
+VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 
-#ifndef HAVE_STRNCASECMP
-#   ifndef HAVE_STRNICMP
-#       define strncasecmp vlc_strncasecmp
-        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
-#   else
-#       define strncasecmp strnicmp
-#       if !defined(__PLUGIN__)
-#           define vlc_strncasecmp NULL
-#       endif
-#   endif
-#elif !defined(__PLUGIN__)
-#   define vlc_strncasecmp NULL
-#endif
-
-#ifndef HAVE_STRCASESTR
-#   ifndef HAVE_STRISTR
-#       define strcasestr vlc_strcasestr
-        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
-#   else
-#       define strcasestr stristr
-#       if !defined(__PLUGIN__)
-#           define vlc_strcasestr NULL
-#       endif
-#   endif
-#elif !defined(__PLUGIN__)
-#   define vlc_strcasestr NULL
-#endif
+VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
+VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
+VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 
 #ifndef HAVE_DIRENT_H
     typedef void DIR;
@@ -1018,12 +856,6 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
     VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
     VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
     VLC_INTERNAL( long, vlc_telldir, ( void * ) );
-#else
-#   if !defined(__PLUGIN__)
-#       define vlc_opendir  NULL
-#       define vlc_readdir  NULL
-#       define vlc_closedir NULL
-#   endif
 #endif
 
 #if defined (WIN32)
@@ -1043,8 +875,6 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 #   define rewinddir vlc_rewinddir
 #   define seekdir vlc_seekdir
 #   define telldir vlc_telldir
-#elif !defined(__PLUGIN__)
-#   define vlc_wclosedir NULL
 #endif
 
 /* Format type specifiers for 64 bits numbers */
@@ -1147,7 +977,7 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 #   include <tchar.h>
 #endif
 
-VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
+VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
 
 /* vlc_wraptext (defined in src/extras/libc.c) */
@@ -1208,7 +1038,6 @@ VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
 #else
 #   define _(String) (String)
 #   define N_(String) (String)
-#   define gettext(String) (String)
 #endif
 
 /*****************************************************************************
@@ -1225,7 +1054,6 @@ VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
 /*****************************************************************************
  * Additional vlc stuff
  *****************************************************************************/
-#include "vlc_os_specific.h"
 #include "vlc_messages.h"
 #include "vlc_variables.h"
 #include "vlc_objects.h"
@@ -1243,15 +1071,14 @@ VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
 extern vlc_threadvar_t msg_context_global_key;
 
 
-#if defined( __BORLANDC__ )
-#   undef PACKAGE
-#   define PACKAGE
-#endif
-
 #if defined( WIN32 ) || defined( UNDER_CE )
 #   define DIR_SEP_CHAR '\\'
 #   define DIR_SEP "\\"
+#   define PATH_SEP_CHAR ';'
+#   define PATH_SEP ";"
 #else
 #   define DIR_SEP_CHAR '/'
 #   define DIR_SEP "/"
+#   define PATH_SEP_CHAR ':'
+#   define PATH_SEP ":"
 #endif