/*****************************************************************************
- * variables.h: variables handling
+ * vlc_variables.h: variables handling
*****************************************************************************
- * Copyright (C) 2002-2004 the VideoLAN team
+ * Copyright (C) 2002-2004 VLC authors and VideoLAN
* $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
* Gildas Bazin <gbazin@netcourrier.com>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef VLC_VARIABLES_H
* @{
*/
-/*****************************************************************************
- * Variable types - probably very incomplete
- *****************************************************************************/
#define VLC_VAR_TYPE 0x00ff
#define VLC_VAR_CLASS 0x00f0
#define VLC_VAR_FLAGS 0xff00
+/**
+ * \defgroup var_type Variable types
+ * These are the different types a vlc variable can have.
+ * @{
+ */
+#define VLC_VAR_VOID 0x0010
+#define VLC_VAR_BOOL 0x0020
+#define VLC_VAR_INTEGER 0x0030
+#define VLC_VAR_HOTKEY 0x0031
+#define VLC_VAR_STRING 0x0040
+#define VLC_VAR_VARIABLE 0x0044
+#define VLC_VAR_FLOAT 0x0050
+#define VLC_VAR_TIME 0x0060
+#define VLC_VAR_ADDRESS 0x0070
+#define VLC_VAR_COORDS 0x00A0
+/**@}*/
+
/** \defgroup var_flags Additive flags
* These flags are added to the type field of the variable. Most as a result of
* a var_Change() call, but some may be added at creation time
VLC_API int var_Change( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * );
#define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )
-VLC_API int var_Type( vlc_object_t *, const char * ) LIBVLC_USED;
+VLC_API int var_Type( vlc_object_t *, const char * ) VLC_USED;
#define var_Type(a,b) var_Type( VLC_OBJECT(a), b )
VLC_API int var_Set( vlc_object_t *, const char *, vlc_value_t );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.b_bool = false;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.i_time = 0L;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.f_float = 0.0;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.psz_string = NULL;
return val.psz_string;
}
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val;
return NULL;
}
-LIBVLC_USED
+VLC_USED
static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_CreateGetString( vlc_object_t *p_obj,
const char *psz_name )
{
return var_GetString( p_obj, psz_name );
}
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
const char *psz_name )
{
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
const char *psz_name )
{
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED
+VLC_USED
static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
{
var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj,
const char *psz_name )
{
return var_GetString( p_obj, psz_name );
}
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
const char *psz_name )
{
#define var_CreateGetStringCommand(a,b) var_CreateGetStringCommand( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyStringCommand(a,b) var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
-LIBVLC_USED
+VLC_USED
static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t count;
#define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
-LIBVLC_USED
+VLC_USED
static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
{
vlc_value_t val;
}
#define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
-LIBVLC_USED
+VLC_USED
static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name )
{
vlc_value_t val;
}
#define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
-LIBVLC_USED
+VLC_USED
static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
{
vlc_value_t val;
}
#define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
-LIBVLC_USED LIBVLC_MALLOC
+VLC_USED VLC_MALLOC
static inline char *var_InheritString( vlc_object_t *obj, const char *name )
{
vlc_value_t val;
}
#define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
-LIBVLC_USED
+VLC_USED
static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
{
vlc_value_t val;
}
#define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
-LIBVLC_USED
+VLC_USED
static inline void *var_InheritAddress( vlc_object_t *obj, const char *name )
{
vlc_value_t val;