Remove HTTPD object type
[vlc.git] / modules / misc / lua / objects.c
1 /*****************************************************************************
2  * objects.c: Generic lua<->vlc object wrapper
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifndef  _GNU_SOURCE
28 #   define  _GNU_SOURCE
29 #endif
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc/vlc.h>
36
37 #include <lua.h>        /* Low level lua C API */
38 #include <lauxlib.h>    /* Higher level C API */
39 #include <lualib.h>     /* Lua libs */
40
41 #include "vlc.h"
42
43 typedef struct
44 {
45     vlc_object_t *p_obj;
46 } vlclua_object_t;
47
48 /*****************************************************************************
49  * Generic vlc_object_t wrapper creation
50  *****************************************************************************/
51 int __vlclua_push_vlc_object( lua_State *L, vlc_object_t *p_obj,
52                               lua_CFunction pf_gc )
53 {
54     vlclua_object_t *p_ud = (vlclua_object_t *)
55         lua_newuserdata( L, sizeof( vlclua_object_t ) );
56     p_ud->p_obj = p_obj;
57     lua_newtable( L );
58     /* Hide the metatable */
59     lua_pushstring( L, "__metatable" );
60     lua_pushstring( L, "none of your business" );
61     lua_settable( L, -3 );
62     if( pf_gc )
63     {
64         /* Set the garbage collector if needed */
65         lua_pushstring( L, "__gc" );
66         lua_pushcfunction( L, pf_gc );
67         lua_settable( L, -3 );
68     }
69     lua_setmetatable( L, -2 );
70     return 1;
71 }
72
73 int vlclua_gc_release( lua_State *L )
74 {
75     vlclua_object_t *p_ud = (vlclua_object_t *)lua_touserdata( L, -1 );
76     lua_pop( L, 1 );
77     vlc_object_release( p_ud->p_obj );
78     return 0;
79 }
80
81 vlc_object_t *vlclua_checkobject( lua_State *L, int narg, int i_type )
82 {
83     vlclua_object_t *p_obj = (vlclua_object_t *)luaL_checkuserdata( L, narg, sizeof( vlclua_object_t ) );
84     /* TODO: add some metatable based method to check that this isn't
85      * any userdata, but really some vlc object */
86     if( i_type )
87     {
88         if( p_obj->p_obj->i_object_type == i_type )
89             return p_obj->p_obj;
90         else
91         {
92             luaL_error( L, "VLC object type doesn't match requirements." );
93             return NULL; /* luaL_error alread longjmp-ed out of here.
94                           * This is to make gcc happy */
95         }
96     }
97     else
98     {
99         return p_obj->p_obj;
100     }
101 }
102
103 static int vlc_object_type_from_string( const char *psz_name )
104 {
105     static const struct
106     {
107         int i_type;
108         const char *psz_name;
109     } pp_objects[] =
110         { { VLC_OBJECT_GLOBAL, "global" },
111           { VLC_OBJECT_LIBVLC, "libvlc" },
112           { VLC_OBJECT_MODULE, "module" },
113           { VLC_OBJECT_INTF, "intf" },
114           { VLC_OBJECT_PLAYLIST, "playlist" },
115           { VLC_OBJECT_INPUT, "input" },
116           { VLC_OBJECT_DECODER, "decoder" },
117           { VLC_OBJECT_VOUT, "vout" },
118           { VLC_OBJECT_AOUT, "aout" },
119           { VLC_OBJECT_SOUT, "sout" },
120           { VLC_OBJECT_PACKETIZER, "packetizer" },
121           { VLC_OBJECT_ENCODER, "encoder" },
122           { VLC_OBJECT_DIALOGS, "dialogs" },
123           { VLC_OBJECT_VLM, "vlm" },
124           { VLC_OBJECT_ANNOUNCE, "announce" },
125           { VLC_OBJECT_DEMUX, "demux" },
126           { VLC_OBJECT_ACCESS, "access" },
127           { VLC_OBJECT_STREAM, "stream" },
128           { VLC_OBJECT_OPENGL, "opengl" },
129           { VLC_OBJECT_FILTER, "filter" },
130           { VLC_OBJECT_OSDMENU, "osdmenu" },
131           { VLC_OBJECT_HTTPD_HOST, "httpd_host" },
132           { VLC_OBJECT_GENERIC, "generic" },
133           { 0, "" } };
134     int i;
135     for( i = 0; pp_objects[i].i_type; i++ )
136     {
137         if( !strcmp( psz_name, pp_objects[i].psz_name ) )
138             return pp_objects[i].i_type;
139     }
140     return 0;
141 }
142
143 static int vlc_object_search_mode_from_string( const char *psz_name )
144 {
145     static const struct
146     {
147         int i_mode;
148         const char *psz_name;
149     } pp_modes[] =
150         { { FIND_PARENT, "parent" },
151           { FIND_CHILD, "child" },
152           { FIND_ANYWHERE, "anywhere" },
153           { 0, "" } };
154     int i;
155     for( i = 0; pp_modes[i].i_mode; i++ )
156     {
157         if( !strcmp( psz_name, pp_modes[i].psz_name ) )
158             return pp_modes[i].i_mode;
159     }
160     return 0;
161 }
162
163 int vlclua_object_find( lua_State *L )
164 {
165     const char *psz_type = luaL_checkstring( L, 2 );
166     const char *psz_mode = luaL_checkstring( L, 3 );
167
168     vlc_object_t *p_this;
169     int i_type = vlc_object_type_from_string( psz_type );
170     int i_mode = vlc_object_search_mode_from_string( psz_mode );
171     vlc_object_t *p_result;
172
173     if( !i_type )
174         return luaL_error( L, "\"%s\" is not a valid object type.", psz_type );
175     if( !i_mode )
176         return luaL_error( L, "\"%s\" is not a valid search mode.", psz_mode );
177
178     if( lua_type( L, 1 ) == LUA_TNIL )
179         p_this = vlclua_get_this( L );
180     else
181         p_this = vlclua_checkobject( L, 1, 0 );
182
183     p_result = vlc_object_find( p_this, i_type, i_mode );
184     if( !p_result )
185         lua_pushnil( L );
186     else
187         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
188     return 1;
189 }
190
191 int vlclua_object_find_name( lua_State *L )
192 {
193     const char *psz_name = luaL_checkstring( L, 2 );
194     const char *psz_mode = luaL_checkstring( L, 3 );
195
196     vlc_object_t *p_this;
197     int i_mode = vlc_object_search_mode_from_string( psz_mode );
198     vlc_object_t *p_result;
199
200     if( !i_mode )
201         return luaL_error( L, "\"%s\" is not a valid search mode.",
202                            psz_mode );
203
204     if( lua_type( L, 1 ) == LUA_TNIL )
205         p_this = vlclua_get_this( L );
206     else
207         p_this = vlclua_checkobject( L, 1, 0 );
208
209     p_result = vlc_object_find_name( p_this, psz_name, i_mode );
210     if( !p_result )
211         lua_pushnil( L );
212     else
213         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
214     return 1;
215 }