]>
git.proxmox.com Git - mirror_frr.git/blob - lib/frrlua.h
2 * Copyright (C) 2016-2019 Cumulus Networks, Inc.
3 * Donald Sharp, Quentin Young
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31 #include "frrscript.h"
38 * gcc-10 is complaining about the wrapper function
39 * not being compatible with lua_pushstring returning
40 * a char *. Let's wrapper it here to make our life
43 static inline void lua_pushstring_wrapper(lua_State
*L
, const char *str
)
45 (void)lua_pushstring(L
, str
);
49 * Converts a prefix to a Lua value and pushes it on the stack.
51 void lua_pushprefix(lua_State
*L
, const struct prefix
*prefix
);
53 void lua_decode_prefix(lua_State
*L
, int idx
, struct prefix
*prefix
);
56 * Converts the Lua value at idx to a prefix.
59 * struct prefix allocated with MTYPE_TMP
61 void *lua_toprefix(lua_State
*L
, int idx
);
64 * Converts an interface to a Lua value and pushes it on the stack.
66 void lua_pushinterface(lua_State
*L
, const struct interface
*ifp
);
68 void lua_decode_interface(lua_State
*L
, int idx
, struct interface
*ifp
);
71 * Converts the Lua value at idx to an interface.
74 * struct interface allocated with MTYPE_TMP. This interface is not hooked
75 * to anything, nor is it inserted in the global interface tree.
77 void *lua_tointerface(lua_State
*L
, int idx
);
80 * Converts an in_addr to a Lua value and pushes it on the stack.
82 void lua_pushinaddr(lua_State
*L
, const struct in_addr
*addr
);
84 void lua_decode_inaddr(lua_State
*L
, int idx
, struct in_addr
*addr
);
87 * Converts the Lua value at idx to an in_addr.
90 * struct in_addr allocated with MTYPE_TMP.
92 void *lua_toinaddr(lua_State
*L
, int idx
);
95 * Converts an in6_addr to a Lua value and pushes it on the stack.
97 void lua_pushin6addr(lua_State
*L
, const struct in6_addr
*addr
);
99 void lua_decode_in6addr(lua_State
*L
, int idx
, struct in6_addr
*addr
);
102 * Converts the Lua value at idx to an in6_addr.
105 * struct in6_addr allocated with MTYPE_TMP.
107 void *lua_toin6addr(lua_State
*L
, int idx
);
110 * Converts a time_t to a Lua value and pushes it on the stack.
112 void lua_pushtimet(lua_State
*L
, const time_t *time
);
114 void lua_decode_timet(lua_State
*L
, int idx
, time_t *time
);
117 * Converts the Lua value at idx to a time_t.
120 * time_t allocated with MTYPE_TMP.
122 void *lua_totimet(lua_State
*L
, int idx
);
125 * Converts a sockunion to a Lua value and pushes it on the stack.
127 void lua_pushsockunion(lua_State
*L
, const union sockunion
*su
);
129 void lua_decode_sockunion(lua_State
*L
, int idx
, union sockunion
*su
);
132 * Converts the Lua value at idx to a sockunion.
135 * sockunion allocated with MTYPE_TMP.
137 void *lua_tosockunion(lua_State
*L
, int idx
);
140 * Converts an int to a Lua value and pushes it on the stack.
142 void lua_pushintegerp(lua_State
*L
, const long long *num
);
144 void lua_decode_integerp(lua_State
*L
, int idx
, long long *num
);
147 * Converts the Lua value at idx to an int.
150 * int allocated with MTYPE_TMP.
152 void *lua_tointegerp(lua_State
*L
, int idx
);
154 void lua_decode_stringp(lua_State
*L
, int idx
, char *str
);
159 * Sets *string to a copy of the string at the top of the stack. The copy is
160 * allocated with MTYPE_TMP and the caller is responsible for freeing it.
162 void *lua_tostringp(lua_State
*L
, int idx
);
167 void lua_decode_noop(lua_State
*L
, int idx
, const void *ptr
);
170 * Retrieve an integer from table on the top of the stack.
173 * Key of string value in table
175 int frrlua_table_get_integer(lua_State
*L
, const char *key
);
178 * Exports a new table containing bindings to FRR zlog functions into the
181 * From Lua, these functions may be accessed as:
188 * They take a single string argument.
190 void frrlua_export_logging(lua_State
*L
);
193 * Dump Lua stack to a string.
195 * Return value must be freed with XFREE(MTYPE_TMP, ...);
197 char *frrlua_stackdump(lua_State
*L
);
203 #endif /* HAVE_SCRIPTING */
205 #endif /* __FRRLUA_H__ */