29#include <ws_log_defs.h>
56#include <epan/wslua/declare_wslua.h>
62#define WSLUA_INIT_ROUTINES "init_routines"
63#define WSLUA_PREFS_CHANGED "prefs_changed"
89#define wslua_toint(L,i) (int) ( lua_tointeger(L,i) )
90#define wslua_toint32(L,i) (int32_t) ( lua_tointeger(L,i) )
91#define wslua_toint64(L,i) (int64_t) ( lua_tonumber(L,i) )
92#define wslua_touint64(L,i) (uint64_t) ( lua_tonumber(L,i) )
94#define wslua_checkint(L,i) (int) ( luaL_checkinteger(L,i) )
95#define wslua_checkint32(L,i) (int32_t) ( luaL_checkinteger(L,i) )
96#define wslua_checkint64(L,i) (int64_t) ( luaL_checknumber(L,i) )
97#define wslua_checkuint64(L,i) (uint64_t) ( luaL_checknumber(L,i) )
99#define wslua_optint(L,i,d) (int) ( luaL_optinteger(L,i,d) )
100#define wslua_optint32(L,i,d) (int32_t) ( luaL_optinteger(L,i,d) )
101#define wslua_optint64(L,i,d) (int64_t) ( luaL_optnumber(L,i,d) )
102#define wslua_optuint64(L,i,d) (uint64_t) ( luaL_optnumber(L,i,d) )
109#if LUA_VERSION_NUM < 503
110#define wslua_touint(L,i) (unsigned) ( lua_tounsigned(L,i) )
111#define wslua_touint32(L,i) (uint32_t) ( lua_tounsigned(L,i) )
112#define wslua_checkuint(L,i) (unsigned) ( luaL_checkunsigned(L,i) )
113#define wslua_checkuint32(L,i) (uint32_t) ( luaL_checkunsigned(L,i) )
114#define wslua_optuint(L,i,d) (unsigned) ( luaL_optunsigned(L,i,d) )
115#define wslua_optuint32(L,i,d) (uint32_t) ( luaL_optunsigned(L,i,d) )
117#define wslua_touint(L,i) (unsigned) ( lua_tointeger(L,i) )
118#define wslua_touint32(L,i) (uint32_t) ( lua_tointeger(L,i) )
119#define wslua_checkuint(L,i) (unsigned) ( luaL_checkinteger(L,i) )
120#define wslua_checkuint32(L,i) (uint32_t) ( luaL_checkinteger(L,i) )
121#define wslua_optuint(L,i,d) (unsigned) ( luaL_optinteger(L,i,d) )
122#define wslua_optuint32(L,i,d) (uint32_t) ( luaL_optinteger(L,i,d) )
225 int expert_info_table_ref;
232 bool is_postdissector;
287typedef void (*tap_extractor_t)(lua_State*,
const void*);
292 tap_extractor_t extractor;
333 char* internal_description;
341 int seq_read_close_ref;
342 int can_write_encap_ref;
363typedef struct {
const char* name; tap_extractor_t extractor; }
tappable_t;
375typedef GByteArray* ByteArray;
384typedef int64_t Int64;
385typedef uint64_t UInt64;
402typedef tvbparse_action_t* Shortcut;
417#define WSLUA_CLASS_DEFINE(C,check_code) \
418 WSLUA_CLASS_DEFINE_BASE(C,check_code,NULL)
420#define WSLUA_CLASS_DEFINE_BASE(C,check_code,retval) \
421C to##C(lua_State* L, int idx) { \
422 C* v = (C*)lua_touserdata (L, idx); \
423 if (!v) luaL_error(L, "bad argument %d (%s expected, got %s)", idx, #C, lua_typename(L, lua_type(L, idx))); \
424 return v ? *v : retval; \
426C check##C(lua_State* L, int idx) { \
428 luaL_checktype(L,idx,LUA_TUSERDATA); \
429 p = (C*)luaL_checkudata(L, idx, #C); \
431 return p ? *p : retval; \
433C* push##C(lua_State* L, C v) { \
435 luaL_checkstack(L,2,"Unable to grow stack\n"); \
436 p = (C*)lua_newuserdata(L,sizeof(C)); *p = v; \
437 luaL_getmetatable(L, #C); lua_setmetatable(L, -2); \
440bool is##C(lua_State* L,int i) { \
442 if(!lua_isuserdata(L,i)) return false; \
443 p = lua_touserdata(L, i); \
444 lua_getfield(L, LUA_REGISTRYINDEX, #C); \
445 if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
447 return p ? true : false; \
449C shift##C(lua_State* L,int i) { \
451 if(!lua_isuserdata(L,i)) return retval; \
452 p = (C*)lua_touserdata(L, i); \
453 lua_getfield(L, LUA_REGISTRYINDEX, #C); \
454 if (p == NULL || !lua_getmetatable(L, i) || !lua_rawequal(L, -1, -2)) p=NULL; \
456 if (p) { lua_remove(L,i); return *p; }\
462 const char *fieldname;
463 lua_CFunction getfunc;
464 lua_CFunction setfunc;
468#define WSLUA_TYPEOF_FIELD "__typeof"
473#define WSLUA_REGISTER_GC(C) \
474 luaL_getmetatable(L, #C); \
477 lua_pushcfunction(L, C ## __gc); \
478 lua_setfield(L, -2, "__gc"); \
482#define __WSLUA_REGISTER_META(C, ATTRS) { \
483 const wslua_class C ## _class = { \
485 .instance_meta = C ## _meta, \
488 wslua_register_classinstance_meta(L, &C ## _class); \
489 WSLUA_REGISTER_GC(C); \
492#define WSLUA_REGISTER_META(C) __WSLUA_REGISTER_META(C, NULL)
493#define WSLUA_REGISTER_META_WITH_ATTRS(C) \
494 __WSLUA_REGISTER_META(C, C ## _attributes)
496#define __WSLUA_REGISTER_CLASS(C, ATTRS) { \
497 const wslua_class C ## _class = { \
499 .class_methods = C ## _methods, \
500 .class_meta = C ## _meta, \
501 .instance_methods = C ## _methods, \
502 .instance_meta = C ## _meta, \
505 wslua_register_class(L, &C ## _class); \
506 WSLUA_REGISTER_GC(C); \
509#define WSLUA_REGISTER_CLASS(C) __WSLUA_REGISTER_CLASS(C, NULL)
510#define WSLUA_REGISTER_CLASS_WITH_ATTRS(C) \
511 __WSLUA_REGISTER_CLASS(C, C ## _attributes)
513#define WSLUA_INIT(L) \
515 wslua_register_classes(L); \
516 wslua_register_functions(L);
520#define WSLUA_FUNCTION extern int
522#define WSLUA_INTERNAL_FUNCTION extern int
524#define WSLUA_REGISTER_FUNCTION(name) { lua_pushcfunction(L, wslua_## name); lua_setglobal(L, #name); }
526#define WSLUA_REGISTER extern int
528#define WSLUA_METHOD static int
529#define WSLUA_CONSTRUCTOR static int
530#define WSLUA_ATTR_SET static int
531#define WSLUA_ATTR_GET static int
532#define WSLUA_METAMETHOD static int
534#define WSLUA_METHODS static const luaL_Reg
535#define WSLUA_META static const luaL_Reg
536#define WSLUA_CLASS_FNREG(class,name) { #name, class##_##name }
537#define WSLUA_CLASS_FNREG_ALIAS(class,aliasname,name) { #aliasname, class##_##name }
538#define WSLUA_CLASS_MTREG(class,name) { "__" #name, class##__##name }
540#define WSLUA_ATTRIBUTES static const wslua_attribute_table
542#define WSLUA_ATTRIBUTE_RWREG(class,name) { #name, class##_get_##name, class##_set_##name }
543#define WSLUA_ATTRIBUTE_ROREG(class,name) { #name, class##_get_##name, NULL }
544#define WSLUA_ATTRIBUTE_WOREG(class,name) { #name, NULL, class##_set_##name }
546#define WSLUA_ATTRIBUTE_FUNC_SETTER(C,field) \
547 static int C##_set_##field (lua_State* L) { \
548 C obj = check##C (L,1); \
549 if (! lua_isfunction(L,-1) ) \
550 return luaL_error(L, "%s's attribute `%s' must be a function", #C , #field ); \
551 if (obj->field##_ref != LUA_NOREF) \
553 luaL_unref(L, LUA_REGISTRYINDEX, obj->field##_ref); \
554 obj->field##_ref = luaL_ref(L, LUA_REGISTRYINDEX); \
558 typedef void __dummy##C##_set_##field
560#define WSLUA_ATTRIBUTE_GET(C,name,block) \
561 static int C##_get_##name (lua_State* L) { \
562 C obj = check##C (L,1); \
567 typedef void __dummy##C##_get_##name
569#define WSLUA_ATTRIBUTE_NAMED_BOOLEAN_GETTER(C,name,member) \
570 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushboolean(L, obj->member );})
572#define WSLUA_ATTRIBUTE_NAMED_INTEGER_GETTER(C,name,member) \
573 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushinteger(L,(lua_Integer)(obj->member));})
575#define WSLUA_ATTRIBUTE_INTEGER_GETTER(C,member) \
576 WSLUA_ATTRIBUTE_NAMED_INTEGER_GETTER(C,member,member)
578#define WSLUA_ATTRIBUTE_BLOCK_NUMBER_GETTER(C,name,block) \
579 WSLUA_ATTRIBUTE_GET(C,name,{lua_pushnumber(L,(lua_Number)(block));})
581#define WSLUA_ATTRIBUTE_NAMED_STRING_GETTER(C,name,member) \
582 WSLUA_ATTRIBUTE_GET(C,name, { \
583 lua_pushstring(L,obj->member); \
586#define WSLUA_ATTRIBUTE_STRING_GETTER(C,member) \
587 WSLUA_ATTRIBUTE_NAMED_STRING_GETTER(C,member,member)
589#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_STRING_GETTER(C,name,member,option) \
590 WSLUA_ATTRIBUTE_GET(C,name, { \
592 if ((obj->member) && (obj->member->len > 0)) { \
593 if (wtap_block_get_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, &str) == WTAP_OPTTYPE_SUCCESS) { \
594 lua_pushstring(L,str); \
603#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_NTH_STRING_GETTER(C,name,member,option) \
604 WSLUA_ATTRIBUTE_GET(C,name, { \
606 if ((obj->member) && (obj->member->len > 0)) { \
607 if (wtap_block_get_nth_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, 0, &str) == WTAP_OPTTYPE_SUCCESS) { \
608 lua_pushstring(L,str); \
613#define WSLUA_ATTRIBUTE_SET(C,name,block) \
614 static int C##_set_##name (lua_State* L) { \
615 C obj = check##C (L,1); \
620 typedef void __dummy##C##_set_##name
622#define WSLUA_ATTRIBUTE_NAMED_BOOLEAN_SETTER(C,name,member) \
623 WSLUA_ATTRIBUTE_SET(C,name, { \
624 if (! lua_isboolean(L,-1) ) \
625 return luaL_error(L, "%s's attribute `%s' must be a boolean", #C , #name ); \
626 obj->member = lua_toboolean(L,-1); \
631#define WSLUA_ATTRIBUTE_NAMED_INTEGER_SETTER(C,name,member,cast) \
632 WSLUA_ATTRIBUTE_SET(C,name, { \
633 if (! lua_isinteger(L,-1) ) \
634 return luaL_error(L, "%s's attribute `%s' must be an integer", #C , #name ); \
635 obj->member = (cast) wslua_toint32(L,-1); \
638#define WSLUA_ATTRIBUTE_INTEGER_SETTER(C,member,cast) \
639 WSLUA_ATTRIBUTE_NAMED_INTEGER_SETTER(C,member,member,cast)
641#define WSLUA_ATTRIBUTE_NAMED_STRING_SETTER(C,field,member,need_free) \
642 static int C##_set_##field (lua_State* L) { \
643 C obj = check##C (L,1); \
645 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
646 s = g_strdup(lua_tostring(L,-1)); \
648 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
650 if (obj->member != NULL && need_free) \
651 g_free((void*) obj->member); \
656 typedef void __dummy##C##_set_##field
658#define WSLUA_ATTRIBUTE_STRING_SETTER(C,field,need_free) \
659 WSLUA_ATTRIBUTE_NAMED_STRING_SETTER(C,field,field,need_free)
661#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_STRING_SETTER(C,field,member,option) \
662 static int C##_set_##field (lua_State* L) { \
663 C obj = check##C (L,1); \
665 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
666 s = g_strdup(lua_tostring(L,-1)); \
668 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
670 if ((obj->member) && (obj->member->len > 0)) { \
671 wtap_block_set_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, s, strlen(s)); \
677 typedef void __dummy##C##_set_##field
679#define WSLUA_ATTRIBUTE_NAMED_OPT_BLOCK_NTH_STRING_SETTER(C,field,member,option) \
680 static int C##_set_##field (lua_State* L) { \
681 C obj = check##C (L,1); \
683 if (lua_isstring(L,-1) || lua_isnil(L,-1)) { \
684 s = g_strdup(lua_tostring(L,-1)); \
686 return luaL_error(L, "%s's attribute `%s' must be a string or nil", #C , #field ); \
688 if ((obj->member) && (obj->member->len > 0)) { \
689 wtap_block_set_nth_string_option_value(g_array_index(obj->member, wtap_block_t, 0), option, 0, s, strlen(s)); \
695 typedef void __dummy##C##_set_##field
697#define WSLUA_ERROR(name,error) { luaL_error(L, "%s%s", #name ": ", error); }
698#define WSLUA_ARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_ARG_ ## name ## _ ## attr, #name ": " error); }
699#define WSLUA_OPTARG_ERROR(name,attr,error) { luaL_argerror(L,WSLUA_OPTARG_##name##_ ##attr, #name ": " error); }
701#define WSLUA_REG_GLOBAL_BOOL(L,n,v) { lua_pushboolean(L,v); lua_setglobal(L,n); }
702#define WSLUA_REG_GLOBAL_STRING(L,n,v) { lua_pushstring(L,v); lua_setglobal(L,n); }
703#define WSLUA_REG_GLOBAL_INTEGER(L,n,v) { lua_pushinteger(L,v); lua_setglobal(L,n); }
705#define WSLUA_RETURN(i) return (i)
707#define WSLUA_API extern
712#define FAIL_ON_NULL(s) if (! *p) luaL_argerror(L,idx,"null " s)
714#define FAIL_ON_NULL_OR_EXPIRED(s) if (!*p) { \
715 luaL_argerror(L,idx,"null " s); \
716 } else if ((*p)->expired) { \
717 luaL_argerror(L,idx,"expired " s); \
721#define CLEAR_OUTSTANDING(C, marker, marker_val) void clear_outstanding_##C(void) { \
722 while (outstanding_##C->len) { \
723 C p = (C)g_ptr_array_remove_index_fast(outstanding_##C,0); \
725 if (p->marker != marker_val) \
726 p->marker = marker_val; \
733#define WSLUA_CLASS_DECLARE(C) \
734extern C to##C(lua_State* L, int idx); \
735extern C check##C(lua_State* L, int idx); \
736extern C* push##C(lua_State* L, C v); \
737extern int C##_register(lua_State* L); \
738extern bool is##C(lua_State* L,int i); \
739extern C shift##C(lua_State* L,int i)
743#define THROW_LUA_ERROR(...) \
744 THROW_FORMATTED(DissectorError, __VA_ARGS__)
765#define WRAP_NON_LUA_EXCEPTIONS(code) \
767 volatile bool has_error = false; \
770 } CATCH3(BoundsError, FragmentBoundsError, ScsiBoundsError) { \
771 show_exception(lua_tvb, lua_pinfo, lua_tree->tree, EXCEPT_CODE, GET_MESSAGE); \
773 show_exception(lua_tvb, lua_pinfo, lua_tree->tree, EXCEPT_CODE, GET_MESSAGE); \
774 lua_pushfstring(L, "%s: %s", __func__, GET_MESSAGE ? GET_MESSAGE : "Malformed packet"); \
777 if (has_error) { lua_error(L); } \
784extern bool lua_initialized;
785extern int lua_dissectors_table_ref;
786extern int lua_heur_dissectors_table_ref;
788WSLUA_DECLARE_CLASSES()
789WSLUA_DECLARE_FUNCTIONS()
791extern lua_State* wslua_state(
void);
812extern int wslua__concat(lua_State* L);
813extern bool wslua_toboolean(lua_State* L,
int n);
814extern bool wslua_checkboolean(lua_State* L,
int n);
815extern bool wslua_optbool(lua_State* L,
int n,
bool def);
816extern lua_Integer wslua_tointeger(lua_State* L,
int n);
817extern int wslua_optboolint(lua_State* L,
int n,
int def);
818extern const char* wslua_checklstring_only(lua_State* L,
int n,
size_t *l);
819extern const char* wslua_checkstring_only(lua_State* L,
int n);
820extern void wslua_setfuncs(lua_State *L,
const luaL_Reg *l,
int nup);
821extern const char* wslua_typeof_unknown;
822extern const char* wslua_typeof(lua_State *L,
int idx);
823extern bool wslua_get_table(lua_State *L,
int idx,
const char *name);
824extern bool wslua_get_field(lua_State *L,
int idx,
const char *name);
827extern expert_field* wslua_get_expert_field(
const int group,
const int severity);
828extern void wslua_prefs_changed(
void);
829extern void proto_register_lua(
void);
830extern GString* lua_register_all_taps(
void);
832extern bool wslua_has_field_extractors(
void);
833extern void lua_prime_all_fields(
proto_tree* tree);
835extern int Proto_commit(lua_State* L);
839extern void clear_outstanding_FuncSavers(
void);
841extern void Int64_pack(lua_State* L, luaL_Buffer *b,
int idx,
bool asLittleEndian);
842extern int Int64_unpack(lua_State* L,
const char *buff,
bool asLittleEndian);
843extern void UInt64_pack(lua_State* L, luaL_Buffer *b,
int idx,
bool asLittleEndian);
844extern int UInt64_unpack(lua_State* L,
const char *buff,
bool asLittleEndian);
845extern uint64_t getUInt64(lua_State *L,
int i);
848extern int push_wsluaTvb(lua_State* L,
Tvb t);
849extern bool push_TvbRange(lua_State* L,
tvbuff_t* tvb,
int offset,
int len);
850extern void clear_outstanding_Tvb(
void);
851extern void clear_outstanding_TvbRange(
void);
854extern void clear_outstanding_Pinfo(
void);
855extern void clear_outstanding_Column(
void);
856extern void clear_outstanding_Columns(
void);
857extern void clear_outstanding_PrivateTable(
void);
859extern int get_hf_wslua_text(
void);
861extern void clear_outstanding_TreeItem(
void);
864extern void clear_outstanding_FieldInfo(
void);
866extern void wslua_print_stack(
char* s, lua_State* L);
868extern void wslua_init(register_cb cb,
void *client_data);
869extern void wslua_early_cleanup(
void);
870extern void wslua_cleanup(
void);
872extern tap_extractor_t wslua_get_tap_extractor(
const char* name);
873extern int wslua_set_tap_enums(lua_State* L);
877extern char* wslua_get_actual_filename(
const char* fname);
879extern int wslua_bin2hex(lua_State* L,
const uint8_t* data,
const unsigned len,
const bool lowercase,
const char* sep);
880extern int wslua_hex2bin(lua_State* L,
const char* data,
const unsigned len,
const char* sep);
881extern int luaopen_rex_pcre2(lua_State *L);
883extern const char* get_current_plugin_version(
void);
884extern void clear_current_plugin_version(
void);
886extern int wslua_deregister_heur_dissectors(lua_State* L);
887extern int wslua_deregister_protocols(lua_State* L);
888extern int wslua_deregister_dissector_tables(lua_State* L);
889extern int wslua_deregister_listeners(lua_State* L);
890extern int wslua_deregister_fields(lua_State* L);
891extern int wslua_deregister_filehandlers(lua_State* L);
892extern void wslua_deregister_menus(
void);
894extern 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:801
const wslua_attribute_table * attrs
Definition wslua.h:807
const luaL_Reg * class_meta
Definition wslua.h:804
const char * name
Definition wslua.h:802
const luaL_Reg * class_methods
Definition wslua.h:803
const luaL_Reg * instance_methods
Definition wslua.h:805
const luaL_Reg * instance_meta
Definition wslua.h:806
uat_field_t * uat_field_list
Definition wslua.h:207
struct _wslua_pref_t::@495::@496 enum_info
bool radio_buttons
Definition wslua.h:201
struct _wslua_pref_t::@495::@497 uat_field_list_info
char * default_s
Definition wslua.h:209
uint32_t max_value
Definition wslua.h:198
const enum_val_t * enumvals
Definition wslua.h:200
union _wslua_pref_t::@495 info
Definition conversation.h:227
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:215
void wslua_register_class(lua_State *L, const wslua_class *cls_def)
Definition wslua_internals.c:547
ProtoField wslua_is_field_available(lua_State *L, const char *field_abbr)
Definition wslua_proto.c:714
void wslua_register_classinstance_meta(lua_State *L, const wslua_class *cls_def)
Definition wslua_internals.c:470
struct _wslua_class wslua_class
Type for defining new classes.
pref_type_t
Definition wslua.h:173