mod-mcabber-lua: comparison lua.c

equal deleted inserted replaced

-:c8514af9b449
+:5d90caa7fb2c
 	{ "yes",     1 },
 	{ "no",      0 },
 	{ NULL,     -1 },
 };
-/// main.yesno
+/// mcabber.yesno
 /// According to yes or no ansvers returns true or false.
 /// If ansver is not recognized, returns nil.
 /// A: anything (string expected)
 /// R: boolean or nil
 static int lua_main_yesno (lua_State *L)
 	else if (type != LUA_TBOOLEAN)
 		lua_pushnil (L);
 	return 1;
 }
-/// main.version
+/// mcabber.version
-/// Returns information about mcabber version
+/// Returns table with information about mcabber  version
 /// R: table
 static int lua_main_version (lua_State *L)
 {
 	lua_createtable (L, 0, 3);
 	lua_pushstring (L, mcabber_branch);
 	{ "room",    ROSTER_TYPE_ROOM    },
 	{ "special", ROSTER_TYPE_SPECIAL },
 	{ NULL,      0                   },
 };
-/// main.log
+/// mcabber.log
 /// Prints message to log.
 /// Note: most likely you need notutf8 flag enabled.
 /// A: log message type, message, message...
 static int lua_main_log (lua_State *L)
 {
 	lua_pushstring (L, loc);
 	g_free (loc);
 	lua_settable (L, -3);
 }
-/// main.option
+/// mcabber.option
-/// Sets or gets value of mcabber option.
+/// Sets or gets value of given mcabber config option.
 /// You can specify nil as a value to delete option.
 /// If you omit option name, it returns hash table of all options.
 /// A: string (option name, optional), string (value, optional)
 /// R: string (value, optional)
 static int lua_main_option (lua_State *L)
 		settings_foreach (SETTINGS_TYPE_OPTION, (void (*)(char *key, char *val, void *ud)) lua_options_callback, L);
 		return 1;
 	}
 }
-/// main.alias
+/// mcabber.alias
 /// Sets or gets alias.
 /// You can specify nil as a command to delete alias.
 /// If you omit alias name, it will return hash table of all aliases.
 /// A: string (alias name, optional), string (command, optional)
 /// R: string (command, optional)
 		settings_foreach (SETTINGS_TYPE_ALIAS, (void (*)(char *key, char *val, void *ud)) lua_options_callback, L);
 		return 1;
 	}
 }
-/// main.bind
+/// mcabber.bind
 /// Sets or gets binding.
 /// You can specify nil as a command to unbind key.
 /// If you omit keycode, it will return hash table of all bindings.
 /// A: string (keycode, optional), string (command, optional)
 /// R: string (command, optional)
 		settings_foreach (SETTINGS_TYPE_BINDING, (void (*)(char *key, char *val, void *ud)) lua_options_callback, L);
 		return 1;
 	}
 }
-/// main.fileoption
+/// mcabber.fileoption
 /// Gets option, expanding it as filename.
 /// A: string (option name)
 /// R: string (expanded option value) or nil
 static int lua_main_fileoption (lua_State *L)
 {
 		lua_pushnil (L);
 	return 1;
 }
 #ifdef LLM_CONNECTION_ENABLE
-/// main.connection
+/// mcabber.connection
 /// Returns lightuserdata of mcabber's loudmouth connection.
 /// This can be very useful with lua-loudmouth, and not much otherwise.
 /// R: lightuserdata or nil
 static int lua_main_connection (lua_State *L)
 {
 		lua_pushnil (L);
 	return 1;
 }
 #endif
-/// main.print_info
+/// mcabber.print_info
 /// Prints a system message to buddy's window.
 /// A: string (jid), string (message)
 static int lua_main_print_info (lua_State *L)
 {
 	char *jid  = to_utf8 (luaL_checkstring (L, 1));
 	g_free (to);
 	g_free (jid);
 	return 0;
 }
-/// main.beep
+/// mcabber.beep
 /// Beeps with system speaker.
 static int lua_main_beep (lua_State *L)
 {
 	scr_beep ();
 	return 0;
 }
-/// main.run
+/// mcabber.run
-/// Runs specified mcabber command.
+/// Executes given string as a mcabber  command.
+/// Note: You should omit '/' in the beginning.
 /// A: string
 static int lua_main_run (lua_State *L)
 {
 	process_command (luaL_checkstring (L, 1), TRUE);
 	return 0;
 }
-/// main.status
+/// mcabber.status
 /// Returns your current status.
 /// R: string (status letter), string (status message)
 static int lua_main_status (lua_State *L)
 {
 	char *sm = from_utf8 (xmpp_getstatusmsg ());
 	lua_pushstring (L, jid);
 	lua_settable (L, -3);
 	g_free (jid);
 }
-/// main.roster
+/// mcabber.roster
 /// Returns array of jids of buddies in roster.
 /// R: table
 static int lua_main_roster (lua_State *L)
 {
 	lua_newtable (L);
 	foreach_buddy (ROSTER_TYPE_USER|ROSTER_TYPE_AGENT|ROSTER_TYPE_ROOM, (void (*) (gpointer buddy, void *data)) lua_rosterlist_callback, L);
 	return 1;
 }
-/// main.current_buddy
+/// mcabber.current_buddy
 /// Returns jid of current selected buddy or sets current buddy to buddy with specified jid.
 /// A: string (optional)
 /// R: string (optional)
 static int lua_main_current_buddy (lua_State *L)
 {
 		g_free (jid);
 		return 1;
 	}
 }
-/// main.full_jid
+/// mcabber.full_jid
 /// Returns full jid (with current resource) of specified buddy (or current, if not specified).
 /// Note, that if there are no resources online, it will return just what it got.
 /// A: string (jid, optional)
 /// R: string (jid)
 static int lua_main_full_jid (lua_State *L)
 	lua_settable   (d->L, -3);
 	lua_settable (d->L, -3);
 	g_free (resource);
 }
-/// main.buddy_info
+/// mcabber.buddy_info
 /// Returns a hash table with information on specified buddy.
 /// Table contains fields type, name, onserver and resources (which points to resources table).
 /// A: string (jid)
 /// R: table
 static int lua_main_buddy_info (lua_State *L)
 // XMPP DISCO FEATURES
 GSList *lua_added_features = NULL;
-/// main.add_feature
+/// mcabber.add_feature
 /// Adds xmlns to disco#info features list.
 /// A: string (xmlns)
 static int lua_main_add_feature (lua_State *L)
 {
 	char *xmlns = to_utf8 (luaL_checkstring (L, 1));
 	xmpp_add_feature (xmlns);
 	lua_added_features = g_slist_prepend (lua_added_features, xmlns);
 	return 0;
 }
-/// main.del_feature
+/// mcabber.del_feature
 /// Removes xmlns from disco#info features list.
 /// A: stirng (xmlns)
 static int lua_main_del_feature (lua_State *L)
 {
 	char   *xmlns = to_utf8 (luaL_checkstring (L, 1));
 		lua_events = g_slist_remove (lua_events, cb); // XXX
 		return FALSE;
 	}
 }
-/// main.event
+/// mcabber.event
 /// Creates new event. If called without arguments, returns event id list.
 /// A: event function (optional), string (event id), string (description, optional), integer (expiration timeout, optional)
 /// R: string (event id) or nothing (creation error) or table (list of event names)
 static int lua_main_event (lua_State *L)
 {
 		scr_log_print (LPRINT_LOGNORM, "lua: Command execution error: %s", lua_tostring (cb->L, -1));
 		lua_pop (cb->L, 1);
 	}
 }
-/// main.parse_args
+/// mcabber.parse_args
 /// Function to parse command argument string to command arguments table.
 /// A: string
 /// R: table
 static int lua_main_parse_args (lua_State *L)
 {
 	luaL_pushargs (L, luaL_checkstring (L, 1));
 	return 1;
 }
-/// main.add_category
+/// mcabber.add_category
 /// Adds completion category.
 /// A: table (values are used as words for completion, optional), argument enum value (completion sorting order, optional)
 /// R: integer (category id, in fact completion type) or nil
 static int lua_main_add_category (lua_State *L)
 {
 		lua_pushnil ( L );
 	return 1;
 }
-/// main.del_category
+/// mcabber.del_category
 /// Removes completion category.
 /// A: integer (category id)
 static int lua_main_del_category (lua_State *L)
 {
 	guint cid = luaL_checkinteger (L, 1);
 	compl_del_category (cid);
 	lua_added_categories = g_slist_remove (lua_added_categories, (gpointer) ((gsize) cid));
 	return 0;
 }
-/// main.add_completion
+/// mcabber.add_completion
 /// Adds word to a completion list.
 /// A: integer (completion group id), string (word)
 static int lua_main_add_completion (lua_State *L)
 {
 	guint  cid  = luaL_checkinteger (L, 1);
 	compl_add_category_word (cid, word);
 	g_free (word);
 	return 0;
 }
-/// main.del_completion
+/// mcabber.del_completion
 /// Removes word from a completion list.
 /// A: integer (completion group id), string (word)
 static int lua_main_del_completion (lua_State *L)
 {
 	guint  cid  = luaL_checkinteger (L, 1);
 	compl_del_category_word (cid, word);
 	g_free (word);
 	return 0;
 }
-/// main.command
+/// mcabber.command
-/// Associates mcabber command name and lua function.
+/// Associates mcabber  command name with given lua function.
-/// As a completion you can also specify a string name (see completion type) instead of table, for non-builtin, you can just pass integer id.
+/// As a completion you can also specify a string name (see completion type) instead of table.
+/// For third-party completions you can just pass integer id.
 /// Note, that for now there are no way to unregister completion group, so, resources can be exausted easily.
 /// Also note, that it ignores keys in a completion table.
 /// A: string (command name), command function, boolean (parse args flag, optional), table (completions, optional)/completion type (or integer comletion group id, optional)
 /// R: userdata (command object)
 static int lua_main_command (lua_State *L)
 	ret = lua_toboolean (cb->L, -1);
 	lua_pop (cb->L, 1);
 	return ret;
 }
-/// main.timer
+/// mcabber.timer
 /// Creates new timer function, that will be called periodically.
 /// A: integer (interval, seconds), timer function
 static int lua_main_timer (lua_State *L)
 {
 	int                   interval = luaL_checkinteger (L, 1);
 	}
 	return ret;
 }
-/// main.bgread
+/// mcabber.bgread
 /// Runs specified command and passes its output to a given function.
 /// A: string (command), background reading function
 static int lua_main_bgread (lua_State *L)
 {
 	const char            *command = luaL_checkstring (L, 1);
 	}
 	return ret;
 }
-/// main.hook_run
+/// mcabber.hook_run
 /// Runs handlers for given hook with supplied arguments.
 /// A: string (hook name), table (hook arguments)
 /// R: return enum field (hook handler result)
 static int lua_main_hook_run ( lua_State *L )
 {
 	luaL_free ( L, args );
 	luaL_pushenum ( L, ret, lua_hook_handler_result );
 	return 1;
 }
-/// main.hook
+/// mcabber.hook
 /// Installs hook handler, returns an object, that you need to keep until
 /// hook handling is no more needed.
 /// A: string (hook name), hook function, integer (priority, optional)
 /// R: userdata (hook object)
 static int lua_main_hook (lua_State *L)
 		lua_pop ( L, 2 );
 		return result;
 	}
 }
-/// main.add_guard
+/// mcabber.add_guard
 /// Installs option guard for given option.
 /// A: string ( option name ), guard function
 /// R: boolean ( success )
 static int lua_main_add_guard ( lua_State *L )
 {
 		lua_pushboolean ( L, 0 );
 	return 1;
 }
-/// main.del_guard
+/// mcabber.del_guard
 /// Removes option guard from given option.
 /// By default, lua will refuse to remove guards, not installed
 /// by lua. Still, you can force guard removal.
 /// A: string ( option name ), boolean ( force removal )
 /// R: boolean ( success )
 {
 	luaL_openlibs (lua);
 	lua_newtable(lua);
 	luaL_setfuncs (lua, lua_reg_main, 0);
+#ifdef COMPAT_0_0_4
+	lua_pushvalue (lua, -1);
 	lua_setglobal (lua, "main");
+#endif
+	lua_setglobal (lua, "mcabber");
 	lua_register (lua, "dopath", lua_global_dopath);
 	lua_register (lua, "print",  lua_global_print );
 	{
 #ifdef MCABBER_API_HAVE_COMPL_FLAGS

changeset 151	5d90caa7fb2c
parent 148	b222f4d111d9
child 152	0cf6c938ac03