VLC 4.0.0-dev
Loading...
Searching...
No Matches
variables.h
Go to the documentation of this file.
1/*****************************************************************************
2 * variables.h: object variables typedefs
3 *****************************************************************************
4 * Copyright (C) 1999-2012 VLC authors and VideoLAN
5 *
6 * Authors: Samuel Hocevar <sam@zoy.org>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
22
23#ifndef LIBVLC_VARIABLES_H
24# define LIBVLC_VARIABLES_H 1
25
26# include <vlc_list.h>
27
28struct vlc_res;
29
30/**
31 * Private LibVLC data for each object.
32 */
34
36{
37 vlc_object_t *parent; /**< Parent object (or NULL) */
38 const char *typename; /**< Object type human-readable name */
39
40 /* Object variables */
41 void *var_root;
43
44 /* Object resources */
46};
47
48# define vlc_internals(o) ((o)->priv)
49# define vlc_externals(priv) (abort(), (void *)(priv))
50
51extern void var_DestroyAll( vlc_object_t * );
52
53/**
54 * Return a list of all variable names
55 *
56 * There is no warranty that the returned variables will be still alive after
57 * the return of this function.
58 *
59 * @return a NULL terminated list of char *, each elements and the return value
60 * must be freed by the caller
61 */
63
64#endif
Mutex.
Definition vlc_threads.h:143
Definition variables.h:36
struct vlc_res * resources
Definition variables.h:45
vlc_mutex_t var_lock
Definition variables.h:42
void * var_root
Definition variables.h:41
vlc_object_t * parent
Parent object (or NULL)
Definition variables.h:37
VLC object common members.
Definition vlc_objects.h:53
Definition objres.c:38
void var_DestroyAll(vlc_object_t *)
Definition objects_cxx_test.cpp:34
char ** var_GetAllNames(vlc_object_t *)
Return a list of all variable names.
Definition variables.c:1154
This provides convenience helpers for linked lists.