Add support for tostring in structs and unions

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015  Tecgraf, PUC-Rio.
+Copyright (C) 2015-2018  Renato Maia <maia.renato@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -1,27 +1,25 @@
-LuaBuffer
-=========
+Lua Memory
+==========
 
-Seamless Support for Buffers in Lua
+The purpose of this project is to support manipulation of memory areas in Lua.
+These memory areas are much like Lua strings, but their contents can be modified in place and have an identity (selfness) independent from their contents.
+The library provides the following functionalities:
 
-The main purpose of this project is to support for buffers that provide a fixed-size memory area (userdata) to be manipulated in Lua. The library introduces the concept of "stream" which is either a buffer or an ordinary Lua string. The library provides the following functionalities:
-
-- Support for writable memory buffers.
-- C API to manipulate Lua streams (string|buffer) in a unified way.
-- Alternative implementations of Lua libraries that manipulate generic Lua streams (string|buffer).
-
-TODO
-----
-
-- Make buffers provide `buffer.*` functions as methods as before.
-- Assure buffers always have a `\0` at the end.
-- Write the manual
+- Support for writable memory areas.
+- C API to manipulate strings or memory areas in a unified way.
 
 Documentation
 -------------
 
 - [Manual](doc/manual.md)
 - [License](LICENSE)
 
+TODO
+----
+
+- Finish adaptation of `string.pack` tests to test `memory.pack`.
+- Add support for bitwise operations on the memory contents.
+
 History
 -------
 

demo/fill.lua

@@ -0,0 +1,24 @@
+-- create a memory
+local m = memory.create(10)
+
+-- fill memory with zeros
+memory.fill(m, 0)
+
+-- iterate over memory
+for i = 1, memory.len(m) do
+	print(i, memory.get(m, i))
+end
+
+-- iterate to fill the memory
+for i = 1, memory.len(m) do
+	memory.set(m, i, 2*i)
+end
+
+-- sets 4th, 5th and 6th bytes in the memory
+memory.set(m, 4, 0xff, 0xff, 0xff)
+
+-- copy 3 bytes from position 4 to position 1
+memory.fill(m, m, 1, 3, 4)
+
+-- clear the positions after the 3 first bytes
+memory.fill(m, 0, 4)

demo/layout.lua

@@ -0,0 +1,27 @@
+local ipv = {
+	[4] = layout.struct{
+		{ key = "version" , bits = 4  },
+		{ key = "ihl"     , bits = 4  },
+		{ key = "tos"     , bits = 6  },
+		{ key = "ecn"     , bits = 2  },
+		{ key = "tot_len" , bits = 16 },
+		{ key = "id"      , bits = 16 },
+		{ key = "flags"   , bits = 3  },
+		{ key = "frag_off", bits = 13 },
+		{ key = "ttl"     , bits = 8  },
+		{ key = "protocol", bits = 8  },
+		{ key = "check"   , bits = 16 },
+		{ key = "src"     , bits = 32, type = "string" },
+		{ key = "dst"     , bits = 32, type = "string" },
+	},
+	[6] = layout.struct{
+		{ key = "version" , bits = 4  },
+		{ key = "tc"      , bits = 8  },
+		{ key = "fl"      , bits = 20 },
+		{ key = "tot_len" , bits = 16 },
+		{ key = "nh"      , bits = 8  },
+		{ key = "hl"      , bits = 8  },
+		{ key = "src"     , bits = 128, type = "string" },
+		{ key = "dst"     , bits = 128, type = "string" },
+	},
+}