28#include <ws_log_defs.h>
53#include <epan/wslua/declare_wslua.h>
59#define WSLUA_INIT_ROUTINES "init_routines"
60#define WSLUA_PREFS_CHANGED "prefs_changed"
86#define wslua_toint(L,i) (int) ( lua_tointeger(L,i) )
87#define wslua_toint32(L,i) (int32_t) ( lua_tointeger(L,i) )
88#define wslua_toint64(L,i) (int64_t) ( lua_tonumber(L,i) )
89#define wslua_touint64(L,i) (uint64_t) ( lua_tonumber(L,i) )
91#define wslua_checkint(L,i) (int) ( luaL_checkinteger(L,i) )
92#define wslua_checkint32(L,i) (int32_t) ( luaL_checkinteger(L,i) )
93#define wslua_checkint64(L,i) (int64_t) ( luaL_checknumber(L,i) )
94#define wslua_checkuint64(L,i) (uint64_t) ( luaL_checknumber(L,i) )
96#define wslua_optint(L,i,d) (int) ( luaL_optinteger(L,i,d) )
97#define wslua_optint32(L,i,d) (int32_t) ( luaL_optinteger(L,i,d) )
98#define wslua_optint64(L,i,d) (int64_t) ( luaL_optnumber(L,i,d) )
99#define wslua_optuint64(L,i,d) (uint64_t) ( luaL_optnumber(L,i,d) )
106#if LUA_VERSION_NUM < 503
107#define wslua_touint(L,i) (unsigned) ( lua_tounsigned(L,i) )
108#define wslua_touint32(L,i) (uint32_t) ( lua_tounsigned(L,i) )
109#define wslua_checkuint(L,i) (unsigned) ( luaL_checkunsigned(L,i) )
110#define wslua_checkuint32(L,i) (uint32_t) ( luaL_checkunsigned(L,i) )
111#define wslua_optuint(L,i,d) (unsigned) ( luaL_optunsigned(L,i,d) )
112#define wslua_optuint32(L,i,d) (uint32_t) ( luaL_optunsigned(L,i,d) )
114#define wslua_touint(L,i) (unsigned) ( lua_tointeger(L,i) )
115#define wslua_touint32(L,i) (uint32_t) ( lua_tointeger(L,i) )
116#define wslua_checkuint(L,i) (unsigned) ( luaL_checkinteger(L,i) )
117#define wslua_checkuint32(L,i) (uint32_t) ( luaL_checkinteger(L,i) )
118#define wslua_optuint(L,i,d) (unsigned) ( luaL_optinteger(L,i,d) )
119#define wslua_optuint32(L,i,d) (uint32_t) ( luaL_optinteger(L,i,d) )
218 int expert_info_table_ref;
225 bool is_postdissector;
275typedef void (*tap_extractor_t)(lua_State*,
const void*);
280 tap_extractor_t extractor;
322 char* internal_description;
330 int seq_read_close_ref;
331 int can_write_encap_ref;
352typedef struct {
const char* name; tap_extractor_t extractor; }
tappable_t;
363typedef GByteArray* ByteArray;
372typedef int64_t Int64;
373typedef uint64_t UInt64;
390typedef tvbparse_action_t* Shortcut;
404#define WSLUA_CLASS_DEFINE(C,check_code) \
405 WSLUA_CLASS_DEFINE_BASE(C,check_code,NULL)
407#define WSLUA_CLASS_DEFINE_BASE(C,check_code,retval) \
408C to##C(lua_State* L, int idx) { \
409 C* v = (C*)lua_touserdata (L, idx); \
410 if (!v) luaL_error(L, "bad argument %d (%s expected, got %s)", idx, #C, lua_typename(L, lua_type(L, idx))); \
411 return v ? *v : retval; \
413C check##C(lua_State* L, int idx) { \
415 luaL_checktype(L,idx,LUA_TUSERDATA); \
416 p = (C*)luaL_checkudata(L, idx, #C); \
418 return p ? *p : retval; \
420C* push##C(lua_State* L, C v) { \
422 luaL_checkstack(L,2,"Unable to grow stack\n"); \
423 p = (C*)lua_newuserdata(L,sizeof(C)); *p = v; \
424 luaL_getmetatable(L, #C); lua_setmetatable(L, -2); \
427bool is##C(lua_State* L,int i) { \
429 if(!lua_isuserdata(L,i)) return false; \
430 p = lua_touserdata(L, i); \
431 lua_getfield(L, LUA_REGISTRYINDEX, #C); \
432 if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
434 return p ? true : false; \
436C shift##C(lua_State* L,int i) { \
438 if(!lua_isuserdata(L,i)) return retval; \
439 p = (C*)lua_touserdata(L, i); \
440 lua_getfield(L, LUA_REGISTRYINDEX, #C); \
441 if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
443 if (p) { lua_remove(L,i); return *p; }\
449 const char *fieldname;
450 lua_CFunction getfunc;
451 lua_CFunction setfunc;
455#define WSLUA_TYPEOF_FIELD "__typeof"
460#define WSLUA_REGISTER_GC(C) \
461 luaL_getmetatable(L, #C); \
464 lua_pushcfunction(L, C ## __gc); \
465 lua_setfield(L, -2, "__gc"); \
469#define __WSLUA_REGISTER_META(C, ATTRS) { \
470 const wslua_class C ## _class = { \
472 .instance_meta = C ## _meta, \
475 wslua_register_classinstance_meta(L, &C ## _class); \
476 WSLUA_REGISTER_GC(C); \
479#define WSLUA_REGISTER_META(C) __WSLUA_REGISTER_META(C, NULL)
480#define WSLUA_REGISTER_META_WITH_ATTRS(C) \
481 __WSLUA_REGISTER_META(C, C ## _attributes)
483#define __WSLUA_REGISTER_CLASS(C, ATTRS) { \
484 const wslua_class C ## _class = { \
486 .class_methods = C ## _methods, \
487 .class_meta = C ## _meta, \
488 .instance_methods = C ## _methods, \
489 .instance_meta = C ## _meta, \
492 wslua_register_class(L, &C ## _class); \
493 WSLUA_REGISTER_GC(C); \
496#define WSLUA_REGISTER_CLASS(C) __WSLUA_REGISTER_CLASS(C, NULL)
497#define WSLUA_REGISTER_CLASS_WITH_ATTRS(C) \
498 __WSLUA_REGISTER_CLASS(C, C ## _attributes)
500#define WSLUA_INIT(L) \
502 wslua_register_classes(L); \
503 wslua_register_functions(L);
507#define WSLUA_FUNCTION extern int
509#define WSLUA_INTERNAL_FUNCTION extern int
511#define WSLUA_REGISTER_FUNCTION(name) { lua_pushcfunction(L, wslua_## name); lua_setglobal(L, #name); }
513#define WSLUA_REGISTER extern int
515#define WSLUA_METHOD static int
516#define WSLUA_CONSTRUCTOR static int
517#define WSLUA_ATTR_SET static int
518#define WSLUA_ATTR_GET static int
519#define WSLUA_METAMETHOD static int
521#define WSLUA_METHODS static const luaL_Reg
522#define WSLUA_META static const luaL_Reg
523#define WSLUA_CLASS_FNREG(class,name) { #name, class##_##name }
524#define WSLUA_CLASS_FNREG_ALIAS(class,aliasname,name) { #aliasname, class##_##name }
525#define WSLUA_CLASS_MTREG(class,name) { "__" #name, class##__##name }
527#define WSLUA_ATTRIBUTES static const wslua_attribute_table
529#define WSLUA_ATTRIBUTE_RWREG(class,name) { #name, class##_get_##name, class##_set_##name }
530#define WSLUA_ATTRIBUTE_ROREG(class,name) { #name, class##_get_##name, NULL }
531#define WSLUA_ATTRIBUTE_WOREG(class,name) { #name, NULL, class##_set_##name }
533#define WSLUA_ATTRIBUTE_FUNC_SETTER(C,field) \
534 static int C##_set_##field (lua_State* L) { \
535 C obj = check##C (L,1); \
536 if (! lua_isfunction(L,-1) ) \
537 return luaL_error(L, "%s's attribute `%s' must be a function", #C , #field ); \
538 if (obj->field##_ref != LUA_NOREF) \
540 luaL_unref(L, LUA_REGISTRYINDEX, obj->field##_ref); \
541 obj->field##_ref = luaL_ref(L, LUA_REGISTRYINDEX); \
545 typedef void __dummy##C##_set_##field
547#define WSLUA_ATTRIBUTE_GET(C,name,block) \
548 static int C##_get_##name (lua_State* L) { \
549 C obj = check##C (L,1); \
554 typedef void __dummy##C##_get_##name
556#define WSLUA_ATTRIBUTE_NAMED_BOOLEAN_GETTER(C,name,member) \
557 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushboolean(L, obj->member );})
559#define WSLUA_ATTRIBUTE_NAMED_INTEGER_GETTER(C,name,member) \
560 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushinteger(L,(lua_Integer)(obj->member));})
562#define WSLUA_ATTRIBUTE_INTEGER_GETTER(C,member) \
563 WSLUA_ATTRIBUTE_NAMED_INTEGER_GETTER(C,member,member)
565#define WSLUA_ATTRIBUTE_BLOCK_NUMBER_GETTER(C,name,block) \
566 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushnumber(L,(lua_Number)(block));})
568#define WSLUA_ATTRIBUTE_NAMED_STRING_GETTER(C,name,member) \
569 WSLUA_ATTRIBUTE_GET(C,name, { \
570 lua_pushstring(L,obj->member); \
573#define WSLUA_ATTRIBUTE_STRING_GETTER(C,member) \
574 WSLUA_ATTRIBUTE_NAMED_STRING_GETTER(C,member,member)
576#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_STRING_GETTER(C,name,member,option) \
577 WSLUA_ATTRIBUTE_GET(C,name, { \
579 if ((obj->member) && (obj->member->len > 0)) { \
580 if (wtap_block_get_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, &str) == WTAP_OPTTYPE_SUCCESS) { \
581 lua_pushstring(L,str); \
590#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_NTH_STRING_GETTER(C,name,member,option) \
591 WSLUA_ATTRIBUTE_GET(C,name, { \
593 if ((obj->member) && (obj->member->len > 0)) { \
594 if (wtap_block_get_nth_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, 0, &str) == WTAP_OPTTYPE_SUCCESS) { \
595 lua_pushstring(L,str); \
600#define WSLUA_ATTRIBUTE_SET(C,name,block) \
601 static int C##_set_##name (lua_State* L) { \
602 C obj = check##C (L,1); \
607 typedef void __dummy##C##_set_##name
609#define WSLUA_ATTRIBUTE_NAMED_BOOLEAN_SETTER(C,name,member) \
610 WSLUA_ATTRIBUTE_SET(C,name, { \
611 if (! lua_isboolean(L,-1) ) \
612 return luaL_error(L, "%s's attribute `%s' must be a boolean", #C , #name ); \
613 obj->member = lua_toboolean(L,-1); \
618#define WSLUA_ATTRIBUTE_NAMED_INTEGER_SETTER(C,name,member,cast) \
619 WSLUA_ATTRIBUTE_SET(C,name, { \
620 if (! lua_isinteger(L,-1) ) \
621 return luaL_error(L, "%s's attribute `%s' must be an integer", #C , #name ); \
622 obj->member = (cast) wslua_toint32(L,-1); \
625#define WSLUA_ATTRIBUTE_INTEGER_SETTER(C,member,cast) \
626 WSLUA_ATTRIBUTE_NAMED_INTEGER_SETTER(C,member,member,cast)
628#define WSLUA_ATTRIBUTE_NAMED_STRING_SETTER(C,field,member,need_free) \
629 static int C##_set_##field (lua_State* L) { \
630 C obj = check##C (L,1); \
632 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
633 s = g_strdup(lua_tostring(L,-1)); \
635 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
637 if (obj->member != NULL && need_free) \
638 g_free((void*) obj->member); \
643 typedef void __dummy##C##_set_##field
645#define WSLUA_ATTRIBUTE_STRING_SETTER(C,field,need_free) \
646 WSLUA_ATTRIBUTE_NAMED_STRING_SETTER(C,field,field,need_free)
648#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_STRING_SETTER(C,field,member,option) \
649 static int C##_set_##field (lua_State* L) { \
650 C obj = check##C (L,1); \
652 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
653 s = g_strdup(lua_tostring(L,-1)); \
655 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
657 if ((obj->member) && (obj->member->len > 0)) { \
658 wtap_block_set_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, s, strlen(s)); \
664 typedef void __dummy##C##_set_##field
666#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_NTH_STRING_SETTER(C,field,member,option) \
667 static int C##_set_##field (lua_State* L) { \
668 C obj = check##C (L,1); \
670 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
671 s = g_strdup(lua_tostring(L,-1)); \
673 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
675 if ((obj->member) && (obj->member->len > 0)) { \
676 wtap_block_set_nth_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, 0, s, strlen(s)); \
682 typedef void __dummy##C##_set_##field
684#define WSLUA_ERROR(name,error) { luaL_error(L, "%s%s", #name ": ", error); }
685#define WSLUA_ARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_ARG_ ## name ## _ ## attr, #name ": " error); }
686#define WSLUA_OPTARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_OPTARG_##name##_ ##attr, #name ": " error); }
688#define WSLUA_REG_GLOBAL_BOOL(L,n,v) { lua_pushboolean(L,v); lua_setglobal(L,n); }
689#define WSLUA_REG_GLOBAL_STRING(L,n,v) { lua_pushstring(L,v); lua_setglobal(L,n); }
690#define WSLUA_REG_GLOBAL_INTEGER(L,n,v) { lua_pushinteger(L,v); lua_setglobal(L,n); }
692#define WSLUA_RETURN(i) return (i)
694#define WSLUA_API extern
699#define FAIL_ON_NULL(s) if (! *p) luaL_argerror(L,idx,"null " s)
701#define FAIL_ON_NULL_OR_EXPIRED(s) if (!*p) { \
702 luaL_argerror(L,idx,"null " s); \
703 } else if ((*p)->expired) { \
704 luaL_argerror(L,idx,"expired " s); \
708#define CLEAR_OUTSTANDING(C, marker, marker_val) void clear_outstanding_##C(void) { \
709 while (outstanding_##C->len) { \
710 C p = (C)g_ptr_array_remove_index_fast(outstanding_##C,0); \
712 if (p->marker != marker_val) \
713 p->marker = marker_val; \
720#define WSLUA_CLASS_DECLARE(C) \
721extern C to##C(lua_State* L, int idx); \
722extern C check##C(lua_State* L, int idx); \
723extern C* push##C(lua_State* L, C v); \
724extern int C##_register(lua_State* L); \
725extern bool is##C(lua_State* L,int i); \
726extern C shift##C(lua_State* L,int i)
730#define THROW_LUA_ERROR(...) \
731 THROW_FORMATTED(DissectorError, __VA_ARGS__)
752#define WRAP_NON_LUA_EXCEPTIONS(code) \
754 volatile bool has_error = false; \
757 } CATCH3(BoundsError, FragmentBoundsError, ScsiBoundsError) { \
758 show_exception(lua_tvb, lua_pinfo, lua_tree->tree, EXCEPT_CODE, GET_MESSAGE); \
760 show_exception(lua_tvb, lua_pinfo, lua_tree->tree, EXCEPT_CODE, GET_MESSAGE); \
761 lua_pushfstring(L, "%s: %s", __func__, GET_MESSAGE ? GET_MESSAGE : "Malformed packet"); \
764 if (has_error) { lua_error(L); } \
771extern bool lua_initialized;
772extern int lua_dissectors_table_ref;
773extern int lua_heur_dissectors_table_ref;
775WSLUA_DECLARE_CLASSES()
776WSLUA_DECLARE_FUNCTIONS()
778extern lua_State* wslua_state(
void);
799extern int wslua__concat(lua_State* L);
800extern bool wslua_toboolean(lua_State* L,
int n);
801extern bool wslua_checkboolean(lua_State* L,
int n);
802extern bool wslua_optbool(lua_State* L,
int n,
bool def);
803extern lua_Integer wslua_tointeger(lua_State* L,
int n);
804extern int wslua_optboolint(lua_State* L,
int n,
int def);
805extern const char* wslua_checklstring_only(lua_State* L,
int n,
size_t *l);
806extern const char* wslua_checkstring_only(lua_State* L,
int n);
807extern void wslua_setfuncs(lua_State *L,
const luaL_Reg *l,
int nup);
808extern const char* wslua_typeof_unknown;
809extern const char* wslua_typeof(lua_State *L,
int idx);
810extern bool wslua_get_table(lua_State *L,
int idx,
const char *name);
811extern bool wslua_get_field(lua_State *L,
int idx,
const char *name);
814extern expert_field* wslua_get_expert_field(
const int group,
const int severity);
815extern void wslua_prefs_changed(
void);
816extern void proto_register_lua(
void);
817extern GString* lua_register_all_taps(
void);
819extern bool wslua_has_field_extractors(
void);
820extern void lua_prime_all_fields(
proto_tree* tree);
822extern int Proto_commit(lua_State* L);
826extern void clear_outstanding_FuncSavers(
void);
828extern void Int64_pack(lua_State* L, luaL_Buffer *b,
int idx,
bool asLittleEndian);
829extern int Int64_unpack(lua_State* L,
const char *buff,
bool asLittleEndian);
830extern void UInt64_pack(lua_State* L, luaL_Buffer *b,
int idx,
bool asLittleEndian);
831extern int UInt64_unpack(lua_State* L,
const char *buff,
bool asLittleEndian);
832extern uint64_t getUInt64(lua_State *L,
int i);
835extern int push_wsluaTvb(lua_State* L,
Tvb t);
836extern bool push_TvbRange(lua_State* L,
tvbuff_t* tvb,
int offset,
int len);
837extern void clear_outstanding_Tvb(
void);
838extern void clear_outstanding_TvbRange(
void);
841extern void clear_outstanding_Pinfo(
void);
842extern void clear_outstanding_Column(
void);
843extern void clear_outstanding_Columns(
void);
844extern void clear_outstanding_PrivateTable(
void);
846extern int get_hf_wslua_text(
void);
848extern void clear_outstanding_TreeItem(
void);
851extern void clear_outstanding_FieldInfo(
void);
853extern void wslua_print_stack(
char* s, lua_State* L);
855extern void wslua_init(register_cb cb,
void *client_data);
856extern void wslua_early_cleanup(
void);
857extern void wslua_cleanup(
void);
859extern tap_extractor_t wslua_get_tap_extractor(
const char* name);
860extern int wslua_set_tap_enums(lua_State* L);
864extern char* wslua_get_actual_filename(
const char* fname);
866extern int wslua_bin2hex(lua_State* L,
const uint8_t* data,
const unsigned len,
const bool lowercase,
const char* sep);
867extern int wslua_hex2bin(lua_State* L,
const char* data,
const unsigned len,
const char* sep);
868extern int luaopen_rex_pcre2(lua_State *L);
870extern const char* get_current_plugin_version(
void);
871extern void clear_current_plugin_version(
void);
873extern int wslua_deregister_heur_dissectors(lua_State* L);
874extern int wslua_deregister_protocols(lua_State* L);
875extern int wslua_deregister_dissector_tables(lua_State* L);
876extern int wslua_deregister_listeners(lua_State* L);
877extern int wslua_deregister_fields(lua_State* L);
878extern int wslua_deregister_filehandlers(lua_State* L);
879extern void wslua_deregister_menus(
void);
881extern void wslua_init_wtap_filetypes(lua_State* L);
#define PREF_UINT
Definition prefs-int.h:90
Definition tap-funnel.c:27
Definition packet_info.h:43
Definition tvbparse.h:142
Definition tvbparse.h:130
Type for defining new classes.
Definition wslua.h:788
const wslua_attribute_table * attrs
Definition wslua.h:794
const luaL_Reg * class_meta
Definition wslua.h:791
const char * name
Definition wslua.h:789
const luaL_Reg * class_methods
Definition wslua.h:790
const luaL_Reg * instance_methods
Definition wslua.h:792
const luaL_Reg * instance_meta
Definition wslua.h:793
struct _wslua_pref_t::@495::@496 enum_info
bool radio_buttons
Definition wslua.h:197
char * default_s
Definition wslua.h:202
uint32_t max_value
Definition wslua.h:194
const enum_val_t * enumvals
Definition wslua.h:196
union _wslua_pref_t::@495 info
Definition column-info.h:62
Definition epan_dissect.h:28
Definition prefs-int.h:27
Definition progress_frame.h:31
Definition tvbuff-int.h:35
Definition file_wrappers.c:222
void wslua_register_class(lua_State *L, const wslua_class *cls_def)
Definition wslua_internals.c:530
ProtoField wslua_is_field_available(lua_State *L, const char *field_abbr)
Definition wslua_proto.c:715
void wslua_register_classinstance_meta(lua_State *L, const wslua_class *cls_def)
Definition wslua_internals.c:453
struct _wslua_class wslua_class
Type for defining new classes.
pref_type_t
Definition wslua.h:170