├── LICENSE
├── LibCompress.lua
├── LuaSerializer.lua
└── README.md
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
341 |
--------------------------------------------------------------------------------
/LibCompress.lua:
--------------------------------------------------------------------------------
1 | -- LibCompress.lua
2 | --
3 | -- Authors: jjsheets and Galmok of European Stormrage (Horde)
4 | -- Email: sheets.jeff@gmail.com and galmok@gmail.com
5 | -- Licence: GPL version 2 (General Public License)
6 | --
7 | -- Hacked severely by Taehl (SelfMadeSpirit@gmail.com)
8 | ----------------------------------------------------------------------------------
9 |
10 | assert(not TLibCompress, "LibCompress already loaded. Possibly loading different versions of LibCompress")
11 |
12 | TLibCompress = {}
13 |
14 | local assert = assert
15 | local type = type
16 | local unpack = unpack or table.unpack
17 | local tconcat = table.concat
18 | local schar = string.char
19 | local ssub = string.sub
20 | local sbyte = string.byte
21 | local mmodf = math.modf
22 |
23 | local function encode(x)
24 | local bytes = {}
25 | local xmod
26 | repeat
27 | x, xmod = mmodf(x/255)
28 | xmod = xmod * 255
29 | bytes[#bytes + 1] = xmod
30 | until x <= 0
31 | if #bytes == 1 and bytes[1] > 0 and bytes[1] < 250 then
32 | return schar(bytes[1])
33 | else
34 | for i = 1, #bytes do bytes[i] = bytes[i] + 1 end
35 | return schar(256 - #bytes, unpack(bytes))
36 | end
37 | end
38 |
39 | local function decode(ss,i)
40 | i = i or 1
41 | local a = sbyte(ss,i,i)
42 | if a > 249 then
43 | local r = 0
44 | a = 256 - a
45 | for n = i+a, i+1, -1 do
46 | r = r * 255 + sbyte(ss,n,n) - 1
47 | end
48 | return r, a + 1
49 | else
50 | return a, 1
51 | end
52 | end
53 |
54 | function TLibCompress.CompressLZW(uncompressed)
55 | assert(type(uncompressed) == 'string')
56 | local result = {'\222'}
57 | local ressize = 1
58 | local w = ''
59 | local dict = {}
60 | local dict_size = 256
61 | for i = 0, 255 do
62 | dict[schar(i)] = i
63 | end
64 | for i = 1, #uncompressed do
65 | local c = ssub(uncompressed,i,i)
66 | local wc = w..c
67 | if dict[wc] then
68 | w = wc
69 | else
70 | dict[wc] = dict_size
71 | dict_size = dict_size +1
72 | local r = encode(dict[w])
73 | ressize = ressize + #r
74 | result[#result + 1] = r
75 | w = c
76 | end
77 | end
78 | if w then
79 | local r = encode(dict[w])
80 | ressize = ressize + #r
81 | result[#result + 1] = r
82 | end
83 | if (#uncompressed+1) > ressize then
84 | return tconcat(result)
85 | else
86 | return '\1'..uncompressed
87 | end
88 | end
89 |
90 | function TLibCompress.DecompressLZW(compressed)
91 | assert(type(compressed) == 'string')
92 | local UC
93 | UC, compressed = ssub(compressed,1,1), ssub(compressed, 2)
94 | if UC == '\1' then
95 | return compressed
96 | end
97 | if UC ~= "\222" then
98 | return nil, "Can only decompress LZW compressed data ("..tostring(UC)..")"
99 | end
100 | local dict_size = 256
101 | local dict = {}
102 | for i = 0, 255 do
103 | dict[i] = schar(i)
104 | end
105 | local result = {}
106 | local t = 1
107 | local delta, k
108 | k, delta = decode(compressed,t)
109 | t = t + delta
110 | result[#result+1] = dict[k]
111 | local w = dict[k]
112 | local entry
113 | local csize = #compressed
114 | while t <= csize do
115 | k, delta = decode(compressed,t)
116 | t = t + delta
117 | entry = dict[k] or (w..ssub(w,1,1))
118 | result[#result+1] = entry
119 | dict[dict_size] = w..ssub(entry,1,1)
120 | dict_size = dict_size + 1
121 | w = entry
122 | end
123 | return tconcat(result)
124 | end
125 |
126 | return TLibCompress
127 |
--------------------------------------------------------------------------------
/LuaSerializer.lua:
--------------------------------------------------------------------------------
1 | --[[
2 | Copyright (C) 2014- Rochet2
3 |
4 | This program is free software you can redistribute it and/or modify
5 | it under the terms of the GNU General Public License as published by
6 | the Free Software Foundation either version 2 of the License, or
7 | (at your option) any later version.
8 |
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU General Public License for more details.
13 |
14 | You should have received a copy of the GNU General Public License along
15 | with this program if not, write to the Free Software Foundation, Inc.,
16 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 | ]]
18 |
19 | --[[
20 | -- #API
21 | local LuaSerializer = LuaSerializer or require("LuaSerializer")
22 |
23 | -- Some lua compatibility between 5.1 and 5.2
24 | local unpack = unpack or table.unpack
25 |
26 | -- Takes in values and returns a string with them serialized
27 | -- Uses LZW compression, use LuaSerializer.serialize_nocompress if you dont want this
28 | -- LuaSerializer.serialize(...)
29 |
30 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
31 | -- The data must have been serialized with LuaSerializer.serialize_nocompress
32 | -- LuaSerializer.unserialize(serializeddata)
33 |
34 | local serialized = LuaSerializer.serialize(55, "test", {1,2, y = 66}, nil, true)
35 | local data, n = LuaSerializer.unserialize(serialized)
36 | print(unpack(data, 1, n))
37 | -- prints:
38 | -- 55 test table: 491A9920 nil true
39 |
40 | -- Takes in values and returns a string with them serialized
41 | -- Does not compress the result
42 | -- LuaSerializer.serialize_nocompress(...)
43 |
44 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
45 | -- The data must have been serialized with LuaSerializer.serialize
46 | -- LuaSerializer.unserialize_nocompress(serializeddata)
47 |
48 | local serialized = LuaSerializer.serialize_nocompress(55, "test", {1,2, y = 66}, nil, true)
49 | local data, n = LuaSerializer.unserialize_nocompress(serialized)
50 | print(unpack(data, 1, n))
51 | -- prints:
52 | -- 55 test table: 491A9920 nil true
53 | ]]
54 |
55 | assert(_VERSION == 'Lua 5.1' or _VERSION == 'Lua 5.2', "LuaSerializer serializer is coded for lua 5.1 and 5.2")
56 | assert(not LuaSerializer, "LuaSerializer already loaded. Possibly loading different versions of LuaSerializer")
57 |
58 | -- LuaSerializer main table
59 | LuaSerializer = {}
60 |
61 | -- ID characters for the serialization
62 | local LuaSerializer_True = 'T'
63 | local LuaSerializer_False = 'F'
64 | local LuaSerializer_Nil = 'N'
65 | local LuaSerializer_Table = 't'
66 | local LuaSerializer_String = 's'
67 | local LuaSerializer_Number = 'n'
68 | local LuaSerializer_pInf = 'i'
69 | local LuaSerializer_nInf = 'I'
70 | local LuaSerializer_nNan = 'a'
71 | local LuaSerializer_pNan = 'A'
72 | local LuaSerializer_CodeChar = '&' -- some really rare character in serialized data
73 | local LuaSerializer_CodeEscaper = LuaSerializer_CodeChar..'~'
74 | local LuaSerializer_TableSep = LuaSerializer_CodeChar..'D'
75 | local LuaSerializer_EndData = LuaSerializer_CodeChar..'E'
76 |
77 | local assert = assert
78 | local type = type
79 | local tonumber = tonumber
80 | local pairs = pairs
81 | local sub = string.sub
82 | local gsub = string.gsub
83 | local gmatch = string.gmatch
84 | local find = string.find
85 | local len = string.len
86 | local tconcat = table.concat
87 | -- Some lua compatibility between 5.1 and 5.2
88 | local unpack = unpack or table.unpack
89 |
90 | -- This is not required for serializing, but it will help you keep your data smaller
91 | local TLibCompress = TLibCompress or require("LibCompress")
92 |
93 | local LuaSerializer_ToMsgVal
94 | local LuaSerializer_ToRealVal
95 |
96 | -- Functions for handling converting table to string and from string
97 | -- local s = LuaSerializer_Table_tostring(t), local t = LuaSerializer_Table_fromstring(s)
98 | -- Does not support circular table relation which will cause stack overflow
99 | local function LuaSerializer_Table_tostring( tbl )
100 | -- assert(type(tbl) == "table", "#1 table expected")
101 | local result = {}
102 | for k, v in pairs( tbl ) do
103 | result[#result+1] = LuaSerializer_ToMsgVal( k )
104 | result[#result+1] = LuaSerializer_ToMsgVal( v )
105 | end
106 | return tconcat( result, LuaSerializer_TableSep )..LuaSerializer_TableSep
107 | end
108 | local function LuaSerializer_Table_fromstring( str )
109 | -- assert(type(str) == "string", "#1 string expected")
110 | local res = {}
111 | for k, v in gmatch(str, "(.-)"..LuaSerializer_TableSep.."(.-)"..LuaSerializer_TableSep) do
112 | local _k, _v = LuaSerializer_ToRealVal(k), LuaSerializer_ToRealVal(v)
113 | if _k ~= nil then
114 | res[_k] = _v
115 | end
116 | end
117 | return res
118 | end
119 |
120 | -- Escapes special characters
121 | local function LuaSerializer_Encode(str)
122 | assert(type(str) == "string", "#1 string expected")
123 | return (gsub(str, LuaSerializer_CodeChar, LuaSerializer_CodeEscaper))
124 | end
125 | -- Unescapes special characters
126 | local function LuaSerializer_Decode(str)
127 | assert(type(str) == "string", "#1 string expected")
128 | return (gsub(str, LuaSerializer_CodeEscaper, LuaSerializer_CodeChar))
129 | end
130 |
131 | -- Converts a value to string using special characters to represent the value
132 | function LuaSerializer_ToMsgVal(val)
133 | local ret
134 | local Type = type(val)
135 | if Type == "string" then
136 | return LuaSerializer_String..val
137 | elseif Type == "number" then
138 | if val == math.huge then -- test for +inf
139 | ret = LuaSerializer_pInf
140 | elseif val == -math.huge then -- test for -inf
141 | ret = LuaSerializer_nInf
142 | elseif val ~= val then -- test for nan and -nan
143 | if find(''..val, '-', 1, true) == 1 then
144 | ret = LuaSerializer_nNan
145 | end
146 | ret = LuaSerializer_pNan
147 | end
148 | ret = LuaSerializer_Number..val
149 | elseif Type == "boolean" then
150 | if val then
151 | ret = LuaSerializer_True
152 | else
153 | ret = LuaSerializer_False
154 | end
155 | elseif Type == "nil" then
156 | ret = LuaSerializer_Nil
157 | elseif Type == "table" then
158 | ret = LuaSerializer_Table..LuaSerializer_Table_tostring(val)
159 | end
160 | if not ret then
161 | error("#1 Invalid value type ".. Type)
162 | end
163 | return LuaSerializer_Encode(ret)
164 | end
165 |
166 | -- Converts a string value from a message to the actual value it represents
167 | function LuaSerializer_ToRealVal(val)
168 | local decoded = LuaSerializer_Decode(val)
169 | local Type = sub(decoded,1,1)
170 | if Type == LuaSerializer_Nil then
171 | return nil
172 | elseif Type == LuaSerializer_True then
173 | return true
174 | elseif Type == LuaSerializer_False then
175 | return false
176 | elseif Type == LuaSerializer_String then
177 | return sub(decoded, 2)
178 | elseif Type == LuaSerializer_Number then
179 | return tonumber(sub(decoded, 2))
180 | elseif Type == LuaSerializer_pInf then
181 | return math.huge
182 | elseif Type == LuaSerializer_nInf then
183 | return -math.huge
184 | elseif Type == LuaSerializer_pNan then
185 | return -(0/0)
186 | elseif Type == LuaSerializer_nNan then
187 | return 0/0
188 | elseif Type == LuaSerializer_Table then
189 | return LuaSerializer_Table_fromstring(sub(decoded, 2))
190 | end
191 | return nil
192 | end
193 |
194 | -- Takes in values and returns a string with them serialized
195 | -- Does not compress the result
196 | function LuaSerializer.serialize_nocompress(...)
197 | -- convert values into string form
198 | local n = select('#', ...)
199 | local serializeddata = {...}
200 | for i = 1, n do
201 | serializeddata[i] = LuaSerializer_ToMsgVal(serializeddata[i])
202 | end
203 | serializeddata = tconcat(serializeddata, LuaSerializer_EndData)..LuaSerializer_EndData
204 |
205 | return serializeddata
206 | end
207 | local LuaSerializer_serialize_nocompress = LuaSerializer.serialize_nocompress
208 |
209 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
210 | -- The data must have been serialized with LuaSerializer.serialize_nocompress
211 | function LuaSerializer.unserialize_nocompress(serializeddata)
212 | assert(type(serializeddata) == 'string', "#1 string expected")
213 |
214 | -- parse all data and convert it to real values
215 | local res = {}
216 | local i = 1
217 | for data in gmatch(serializeddata, "(.-)"..LuaSerializer_EndData) do
218 | -- tinsert is not used here since it ignores nil values
219 | res[i] = LuaSerializer_ToRealVal(data)
220 | i = i+1
221 | end
222 |
223 | return res, i-1
224 | end
225 | local LuaSerializer_unserialize_nocompress = LuaSerializer.unserialize_nocompress
226 |
227 | -- Takes in values and returns a string with them serialized
228 | -- Uses LZW compression, use LuaSerializer.serialize_nocompress if you dont want this
229 | function LuaSerializer.serialize(...)
230 | -- Serialize and compress data
231 | return (assert(TLibCompress.CompressLZW(LuaSerializer_serialize_nocompress(...))))
232 | end
233 |
234 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
235 | -- The data must have been serialized with LuaSerializer.serialize
236 | function LuaSerializer.unserialize(serializeddata)
237 | assert(type(serializeddata) == 'string', "#1 string expected")
238 | -- uncompress and unserialize data
239 | return LuaSerializer_unserialize_nocompress(assert(TLibCompress.DecompressLZW(serializeddata)))
240 | end
241 |
242 | return LuaSerializer
243 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # LuaSerializer
2 | It is recommended to use smallfolk instead. It is a lot faster and creates smaller and more readable output. It also has a C++ version for C++ compatibility needs: https://github.com/gvx/Smallfolk https://github.com/Rochet2/smallfolk_cpp
3 | LuaSerializer is a pure lua serializer that does not use loadstring or pcall for table deserialization. Works with Lua 5.1 and 5.2.
4 | Backlink: https://github.com/Rochet2/LuaSerializer
5 |
6 | #Limitations
7 | - Tables with cycles can not be serialized.
8 | - Metatables are not serialized.
9 | - Userdata can not be serialized
10 | - Functions can not be serialized, but you can try serialize string.dump or the function contents as string
11 | - Compression safety is questionable for unknown source data, use it only for server->client or otherwise safe assumed data
12 |
13 | #Serializing
14 | LuaSerializer serializes data into a string and is able to then deserialize the data without using loadstring or pcall (safely, not calling functions).
15 | LuaSerializer is capable of safely serializing and deserializing:
16 | - nil
17 | - bool
18 | - string
19 | - number including nan and inf
20 | - tables with no unserializable data and no cycles
21 |
22 | #API
23 | ```lua
24 | local LuaSerializer = LuaSerializer or require("LuaSerializer")
25 |
26 | -- Some lua compatibility between 5.1 and 5.2
27 | local unpack = unpack or table.unpack
28 |
29 | -- Takes in values and returns a string with them serialized
30 | -- Uses LZW compression, use LuaSerializer.serialize_nocompress if you dont want this
31 | -- LuaSerializer.serialize(...)
32 |
33 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
34 | -- The data must have been serialized with LuaSerializer.serialize_nocompress
35 | -- LuaSerializer.unserialize(serializeddata)
36 |
37 | local serialized = LuaSerializer.serialize(55, "test", {1,2, y = 66}, nil, true)
38 | local data, n = LuaSerializer.unserialize(serialized)
39 | print(unpack(data, 1, n))
40 | -- prints:
41 | -- 55 test table: 491A9920 nil true
42 |
43 | -- Takes in values and returns a string with them serialized
44 | -- Does not compress the result
45 | -- LuaSerializer.serialize_nocompress(...)
46 |
47 | -- Takes in a string of serialized data and returns a table with the values in it and the amount of values
48 | -- The data must have been serialized with LuaSerializer.serialize
49 | -- LuaSerializer.unserialize_nocompress(serializeddata)
50 |
51 | local serialized = LuaSerializer.serialize_nocompress(55, "test", {1,2, y = 66}, nil, true)
52 | local data, n = LuaSerializer.unserialize_nocompress(serialized)
53 | print(unpack(data, 1, n))
54 | -- prints:
55 | -- 55 test table: 491A9920 nil true
56 | ```
57 |
58 | #Included dependencies
59 | You do not need to get these, they are already included
60 | - Compression for string data: https://love2d.org/wiki/TLTools
61 |
62 | #Special thanks
63 | - Kenuvis < [Gate](http://www.ac-web.org/forums/showthread.php?148415-LUA-Gate-Project), [ElunaGate](https://github.com/ElunaLuaEngine/ElunaGate) >
64 | - Laurea (alexeng) < https://github.com/Alexeng >
65 | - Lua contributors < http://www.lua.org/ >
66 |
--------------------------------------------------------------------------------