diff options
author | Moshe Kaplan <me@moshekaplan.com> | 2022-06-23 22:24:59 -0400 |
---|---|---|
committer | Moshe Kaplan <mosheekaplan@gmail.com> | 2022-06-24 15:02:38 +0000 |
commit | 26f87b32504f96b19cbe3a1a3953eb9cac247ac3 (patch) | |
tree | 4b3784353186ba579e80769afd36740bbf04cafe /doc/README.wslua | |
parent | acb8158033603373b124fe0d3bf03ee84c35bd9e (diff) |
wslua: Port epan/wslua/make-reg.py to Python3
Port the script that creates
declare_wslua.h and register_wslua.c
to Python3.
Ping #18152.
Diffstat (limited to 'doc/README.wslua')
-rw-r--r-- | doc/README.wslua | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/README.wslua b/doc/README.wslua index 1bc10aead8..ca1fbb097f 100644 --- a/doc/README.wslua +++ b/doc/README.wslua @@ -34,14 +34,14 @@ wsluarm.pl', which searches C-files for the known macros and generates appropriate HTML documentation from them. This includes using the C-comments after the macros for the API document info. -Likewise, another Perl script called 'make-reg.pl' generates the C-files +Likewise, another script called 'make-reg.py' generates the C-files 'register_wslua.c' and 'declare_wslua.h', based on the C-macros it searches -for in existing source files. The code this Perl script auto-generates is +for in existing source files. The code this script auto-generates is what actually registers some classes/functions into Lua - you don't have to write your own registration functions to get your new functions/classes into Lua tables. (you can do so, but it's not advisable) -Both of the perl scripts above are given the C-source files to search through +Both of the scripts above are given the C-source files to search through by the make process, generated from the lists in epan/wslua/CMakeLists.txt. Naturally if you add new source files, you need to add them to the list in epan/wslua/CMakeLists.txt. You also have to add the module name into @@ -72,7 +72,7 @@ Class/object names must be UpperCamelCase, no numbers/underscores. Function and method names must be lower_underscore_case, no numbers. Constants/enums must be ALLCAPS, and can have numbers. -The above rules are more than merely conventions - the Perl scripts which +The above rules are more than merely conventions - the scripts which auto-generate stuff use regex patterns that require the naming syntax to be followed. @@ -153,7 +153,7 @@ instead of one (for instance, ClassName__tostring). Once you've created the appropriate array tables, define a registration function named 'ClassName_register', where 'ClassName'is your class name, the -same one used in WSLUA_CLASS_DEFINE. The make-reg.pl Perl script will search +same one used in WSLUA_CLASS_DEFINE. The make-reg.py script will search your file for WSLUA_CLASS_DEFINE, and it generates a register_wslua.c which will call your ClassName_register function during Wireshark initialization. Define a wslua_class structure which describes the class and register this in @@ -365,7 +365,7 @@ Example: WSLUA_CONSTRUCTOR - this is used to define a function of a class that is a static function rather than a per-object method; i.e., from a Lua perspective the function is called as 'myObj.func()' instead of 'myObj:func()'. From a -C-code perspective the code generated by make-reg.pl does not treat this +C-code perspective the code generated by make-reg.py does not treat this differently than a WSLUA_METHOD, the only real difference being that the code you write within the function won't be checking the object instance as the first passed-in argument on the Lua-API stack. But from a documentation |