meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
programming:lua:protobuf [2017/01/27 12:13]
niziak 		programming:lua:protobuf [2020/07/03 09:48] (current)
niziak ↷ Page moved from lua:protobuf to programming:lua:protobuf
Line 1: Line 1:
 +
 ====== Protocol ====== ====== Protocol ======
   * Encoding [[https://​developers.google.com/​protocol-buffers/​docs/​encoding]]   * Encoding [[https://​developers.google.com/​protocol-buffers/​docs/​encoding]]
Line 8: Line 9:
 ====== Libraries ====== ====== Libraries ======
  
-==== sean-lin based ====+===== sean-lin based =====
 [[https://​github.com/​sean-lin/​protoc-gen-lua]] [[https://​github.com/​sean-lin/​protoc-gen-lua]]
   * Latest commit 12 Jun 2014   * Latest commit 12 Jun 2014
Line 27: Line 28:
  
  
-==== others ====+===== others ​=====
 [[https://​github.com/​indygreg/​lua-protobuf]] [[https://​github.com/​indygreg/​lua-protobuf]]
   * Last commit 27 Mar 2011   * Last commit 27 Mar 2011
Line 38: Line 39:
     * parsing Protocol Buffers into message objects.     * parsing Protocol Buffers into message objects.
  
 +[[https://​github.com/​starwing/​lua-protobuf]]
 +  * Last commit on Aug 24, 2016 
 +<​code>​
 +This project offers a simple C library for basic protobuf wire format
 +encode/​decode,​ it splits to several modules:
 +  - pb.decoder: a wire format decode module.
 +  - pb.buffer: ​ a buffer implement that use to encode basic types into
 +                protobuf'​s wire format. It also can be used to support
 + streaming decode protobuf data.
 +  - pb.conv: ​   a module to convert between integers in protobuf.
 +  - pb.io: ​     a module to support binary mode read/write to stdin/​stdout.
 +</​code>​
  
-==== Neopalium ====+===== Neopalium ​=====
 [[https://​github.com/​Neopallium/​lua-pb]] [[https://​github.com/​Neopallium/​lua-pb]]
   * Latest commit 18 Feb 2016   * Latest commit 18 Feb 2016
   * **Own LUA parser** for .proto files (no need to compile)   * **Own LUA parser** for .proto files (no need to compile)
  
-====== Library API ======+======= Library API =======
  
 <code lua> <code lua>
Line 61: Line 74:
 </​code>​ </​code>​
  
-==== Neopalium ====+===== Neopalium ​=====
 <code lua> <code lua>
 local pb = require '​pb' ​ local pb = require '​pb' ​
Line 142: Line 155:
 </​code>​ </​code>​
  
-==== djungelorm ====+ 
 +==== Issue with 64bit number ==== 
 +18446744073709551615 is exactly 2^64-1 
 + 
 +in LuaJIT 64bit numbers are stored as double, so some precision is lost: 
 +<code lua> 
 +print (0xFFFFFFFFFFFFFFFF == 0xFFFFFFFFFFFFFF00) 
 +true 
 +</​code>​ 
 + 
 +If library detects LuaJIT with FFI support, it is using FFI cdata to store 64 bit numbers ''​int64_t''​ or ''​uint64_t''​ 
 +depends on ''​signed''​ argument passed to ''​make_int64_func''​. 
 +If no LuaJIT is used, big values are represented as 8 bytes strings. 
 + 
 +<code lua> 
 +local pb = require"​pb"​ 
 +local make_int64 = pb.get_make_int64_func() 
 +-- make_int64(b8,​b7,​b6,​b5,​b4,​b3,​b2,​b1,​ signed) 
 +fakeNodeId = make_int64(0,​0,​0,​0, ​ 0,0,0,1 ) 
 +-- or initialize from string 
 +local v = \255\255\255\255\255\255\255\255"​ 
 +fakeNodeId = make_int65(v:​byte(1,​8)) 
 +print (fakeNodeId)  
 +-- prints: '​1ULL'​ 
 +fakeNodeIs = fakeNodeId * 22 
 +print (fakeNodeId)  
 +-- prints: '​22ULL'​ 
 +</​code>​ 
 + 
 + 
 +But library encoder doesn'​t work: 
 +<​code>​ 
 +luaData = { 
 +   ​["​deviceId"​] = 1.844674407371e+19;​ 
 +}; 
 + 
 +binProtoMsg= 
 +  0000 08 00                                            .. 
 + 
 +binProtoMsg decoded=deviceId:​ 0 
 +</​code>​ 
 + 
 +===== djungelorm ​=====
 No documentation. Poor examples. No documentation. Poor examples.
 Need to dig in sources to familiarize. Need to dig in sources to familiarize.
Line 148: Line 203:
 First, proto files needs to be compile with ''​protoc''​ compile with lua output plugin. First, proto files needs to be compile with ''​protoc''​ compile with lua output plugin.
 For ''​messages.proto''​ corresponding lua file ''​messages_pb.lua''​ will be created. For ''​messages.proto''​ corresponding lua file ''​messages_pb.lua''​ will be created.
 +
 +API:
 +  * RCFC (Repeated Composite Field Container) Repeated fields cannot be modified directly by assignment. Use:
 +    * v:add() return newly vreated value object
 +    * v:​remove(key)
 +  * RSFC (Repeted Single Field Container)
 +    * v:​append(value)
 +    * v:​remove(key)
 +
 +  * Message methods:
 +    * _member:​ListFields()
 +    * _member:​HasField(field_name)
 +    * _member:​ClearField(field_name)
 +    * For extendable messages only:
 +      * _member:​ClearExtension (extension_handle)
 +      * _member:​HasExtenstion (extension_handle)
 +    * _member:​Clear()
 +    * :​__tostring()
 +    * _member:​SetListener(listener)
 +    * _member:​ByteSize()
 +    * _member:​SerializeToString()
 +    * _member:​SerializePartialToString()
 +    * _member:​MergeFromString(serialized)
 +    * _member:​IsInitialized(errors) - errors - luaTable (numeric indexes)
 +    * _member:​MergeFrom(msg)
 +
 +
 +Other internal methods:
 +  * _member.RegisterExtension (extension_handle)
 +  * _member.FromString(s)
 +  * _member:​SerializeToIOString(iostring)
 +  * _member:​_InternalSerialize(write_bytes)
 +  * _member:​SerializePartialToIOString(iostring)
 +  * _member:​ParseFromString(serialized)
 +  * _member:​FindInitalizationErrors()
  
 <code lua> <code lua>