plop

git-svn-id: http://svn.net-core.org/repos/t-engine4@3053 51575b47-30f0-44d4-a5cc-537603b46e54

@@ -32,16 +32,19 @@ function _M:init(t, no_default)
 	self.allow_backup_guardians = {}
 	self.world_artifacts_pool = {}
 	self.boss_killed = 0
+	self.stores_restock = 1
 	self.east_orc_patrols = 4
 end
 
--- Number of bosses killed
+--- Restock all stores
+function _M:storesRestock()
+	self.stores_restock = self.stores_restock + 1
+	print("[STORES] restocking")
+end
+
+--- Number of bosses killed
 function _M:bossKilled(rank)
-	if rank == 3.5 then
-		self.boss_killed = self.boss_killed + 0.5
-	else
-		self.boss_killed = self.boss_killed + 1
-	end
+	self.boss_killed = self.boss_killed + 1
 end
 
 --- Allow dropping the rod of recall

@@ -52,8 +52,8 @@ end
 --- Restock based on player level
 function _M:canRestock()
 	local s = self.store
-	if self.last_filled and self.last_filled >= game.state.boss_killed - s.restock_every then
-		print("[STORE] not restocking yet [bosses killed]", game.state.boss_killed, s.restock_every, self.last_filled)
+	if self.last_filled and self.last_filled >= game.state.stores_restock then
+		print("[STORE] not restocking yet [stores_restock]", game.state.stores_restock, s.restock_every, self.last_filled)
 		return false
 	end
 	return true
@@ -64,7 +64,7 @@ end
 -- @param zone the zone to generate for
 function _M:loadup(level, zone)
 	if Store.loadup(self, level, zone) then
-		self.last_filled = game.state.boss_killed
+		self.last_filled = game.state.stores_restock
 	end
 end
 

@@ -23,8 +23,7 @@ newEntity{
 	display = '2', color=colors.UMBER,
 	store = {
 		purse = 25,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 10,
 		max_fill = 20,
 		filters = function()
@@ -39,8 +38,7 @@ newEntity{
 	display = '3', color=colors.UMBER,
 	store = {
 		purse = 25,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 10,
 		max_fill = 20,
 		filters = function()
@@ -55,8 +53,7 @@ newEntity{
 	display = '4', color=colors.LIGHT_BLUE,
 	store = {
 		purse = 10,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 4,
 		max_fill = 7,
 		filters = {
@@ -71,8 +68,7 @@ newEntity{
 	display = '5', color=colors.WHITE,
 	store = {
 		purse = 10,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 4,
 		max_fill = 7,
 		filters = {
@@ -87,8 +83,7 @@ newEntity{
 	display = '9', color=colors.BLUE,
 	store = {
 		purse = 30,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 20,
 		max_fill = 30,
 		filters = {
@@ -107,8 +102,7 @@ newEntity{
 	display = '6', color=colors.RED,
 	store = {
 		purse = 25,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 15,
 		max_fill = 25,
 		filters = function()
@@ -128,8 +122,7 @@ newEntity{
 	display = '2', color=colors.BLUE,
 	store = {
 		purse = 20,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 15,
 		max_fill = 25,
 		filters = {
@@ -152,8 +145,7 @@ newEntity{
 	display = '5', color=colors.WHITE,
 	store = {
 		purse = 10,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 5,
 		max_fill = 9,
 		filters = {
@@ -174,8 +166,7 @@ newEntity{
 	display = '7', color=colors.BLUE,
 	store = {
 		purse = 35,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		sell_percent = 240,
 		min_fill = 10,
 		max_fill = 20,
@@ -191,8 +182,7 @@ newEntity{
 	display = '*', color=colors.LIGHT_RED,
 	store = {
 		purse = 5,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 40,
 		max_fill = 40,
 		filters = {
@@ -215,8 +205,7 @@ newEntity{
 	display = '*', color=colors.LIGHT_RED,
 	store = {
 		purse = 5,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 40,
 		max_fill = 40,
 		filters = {
@@ -231,8 +220,7 @@ newEntity{
 	display = '2', color=colors.UMBER,
 	store = {
 		purse = 25,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 20,
 		max_fill = 30,
 		filters = function()
@@ -251,8 +239,7 @@ newEntity{
 	display = '3', color=colors.UMBER,
 	store = {
 		purse = 25,
-		restock_every = 3,
-		empty_before_restock = true,
+		empty_before_restock = false,
 		min_fill = 20,
 		max_fill = 30,
 		filters = function()

@@ -73,4 +73,5 @@ start_fyrk = function(self)
 		world:gainAchievement("CHARRED_SCAR_SUCCESS", game.player)
 	end
 	game.player:setQuestStatus("charred-scar", engine.Quest.COMPLETED)
+	game.state:storesRestock()
 end

@@ -26,3 +26,10 @@ desc = function(self, who)
 	desc[#desc+1] = "Perhaps you should explore it and find the truth, and the treasures, for yourself!"
 	return table.concat(desc, "\n")
 end
+
+on_status_change = function(self, who, status, sub)
+	if self:isCompleted() then
+		who:setQuestStatus(self.id, engine.Quest.DONE)
+		game.state:storesRestock()
+	end
+end

@@ -98,7 +98,7 @@ newEntity{ define_as = "THE_MASTER",
 
 		world:gainAchievement("VAMPIRE_CRUSHER", game.player:resolveSource())
 		game.player:resolveSource():grantQuest("dreadfell")
-		game.player:resolveSource():setQuestStatus("dreadfell", engine.Quest.DONE)
+		game.player:resolveSource():setQuestStatus("dreadfell", engine.Quest.COMPLETED)
 
 		local ud = {}
 		if not profile.mod.allow_build.undead_skeleton then ud[#ud+1] = "undead_skeleton" end

+# Makefile for Lua BitOp -- a bit operations library for Lua 5.1.
+# To compile with MSVC please run: msvcbuild.bat
+# To compile with MinGW please run: mingw32-make -f Makefile.mingw
+
+# Include path where lua.h, luaconf.h and lauxlib.h reside:
+INCLUDES= -I/usr/local/include
+
+DEFINES=
+# Use this if you need to compile for an old ARM ABI with swapped FPA doubles
+#DEFINES= -DSWAPPED_DOUBLE
+
+# Lua executable name. Used to find the install path and for testing.
+LUA= lua
+
+CC= gcc
+SOCFLAGS= -fPIC
+SOCC= $(CC) -shared $(SOCFLAGS)
+CFLAGS= -Wall -O2 -fomit-frame-pointer $(SOCFLAGS) $(DEFINES) $(INCLUDES)
+RM= rm -f
+INSTALL= install -p
+INSTALLPATH= $(LUA) installpath.lua
+
+MODNAME= bit
+MODSO= $(MODNAME).so
+
+all: $(MODSO)
+
+# Alternative target for compiling on Mac OS X:
+macosx:
+	$(MAKE) all "SOCC=MACOSX_DEPLOYMENT_TARGET=10.3 $(CC) -dynamiclib -single_module -undefined dynamic_lookup $(SOCFLAGS)"
+
+$(MODSO): $(MODNAME).o
+	$(SOCC) -o $@ $<
+
+install: $(MODSO)
+	$(INSTALL) $< `$(INSTALLPATH) $(MODNAME)`
+
+test: $(MODSO)
+	@$(LUA) bittest.lua && echo "basic test OK"
+	@$(LUA) nsievebits.lua && echo "nsievebits test OK"
+	@$(LUA) md5test.lua && echo "MD5 test OK"
+
+clean:
+	$(RM) *.o *.so *.obj *.lib *.exp *.dll *.manifest
+
+.PHONY: all macosx install test clean
+

+# Makefile for Lua BitOp -- a bit operations library for Lua 5.1.
+# This is a modified Makefile for MinGW. C:\MinGW\bin must be in your PATH.
+# Compile: mingw32-make -f Makefile.mingw
+# Install: mingw32-make -f Makefile.mingw install
+
+# Lua executable name. Used for testing.
+LUA= lua
+
+# Include path where lua.h, luaconf.h and lauxlib.h reside:
+INCLUDES= "-I.."
+
+# Path of lua51.dll:
+LUADLLPATH= "..\lua51.dll"
+
+# Path where C modules for Lua should be installed:
+LUACMODPATH= ".."
+
+CC= gcc
+SOCC= $(CC) -shared $(LUADLLPATH)
+CFLAGS= -Wall -O2 -fomit-frame-pointer $(INCLUDES)
+RM= del
+STRIP= strip --strip-unneeded
+INSTALL= copy
+
+MODNAME= bit
+MODSO= $(MODNAME).dll
+
+all: $(MODSO)
+
+$(MODSO): $(MODNAME).o
+	$(SOCC) -o $@ $<
+	$(STRIP) $@
+
+install: $(MODSO)
+	$(INSTALL) $< $(LUACMODPATH)
+
+test: $(MODSO)
+	@$(LUA) bittest.lua && echo "basic test OK"
+	@$(LUA) nsievebits.lua && echo "nsievebits test OK"
+	@$(LUA) md5test.lua && echo "MD5 test OK"
+
+clean:
+	$(RM) *.o *.so *.obj *.lib *.exp *.dll *.manifest
+
+.PHONY: all install test clean
+

+README for Lua BitOp 1.0.1
+--------------------------
+
+Lua BitOp is a C extension module for Lua 5.1 which adds
+bitwise operations on numbers.
+
+Homepage: http://bitop.luajit.org/
+
+Lua BitOp is Copyright (C) 2008-2009 Mike Pall.
+Lua BitOp is free software, released under the MIT/X license.
+
+--------------------------
+
+Full documentation for Lua BitOp is available in HTML format.
+Please point your favourite browser to:
+
+ doc/index.html
+
+Detailed installation instructions are here:
+
+ doc/install.html
+

+/*
+** Lua BitOp -- a bit operations library for Lua 5.1.
+** http://bitop.luajit.org/
+**
+** Copyright (C) 2008-2009 Mike Pall. All rights reserved.
+**
+** 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 the Software without restriction, including
+** without limitation the rights to use, copy, modify, merge, publish,
+** distribute, sublicense, and/or sell copies of the Software, and to
+** permit persons to whom the Software is furnished to do so, subject to
+** the following conditions:
+**
+** The above copyright notice and this permission notice shall be
+** included in all copies or substantial portions of the Software.
+**
+** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+** SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**
+** [ MIT license: http://www.opensource.org/licenses/mit-license.php ]
+*/
+
+#define LUA_BITOP_VERSION	"1.0.1"
+
+#define LUA_LIB
+#include "lua.h"
+#include "lauxlib.h"
+
+#ifdef _MSC_VER
+/* MSVC is stuck in the last century and doesn't have C99's stdint.h. */
+typedef __int32 int32_t;
+typedef unsigned __int32 uint32_t;
+typedef unsigned __int64 uint64_t;
+#else
+#include <stdint.h>
+#endif
+
+typedef int32_t SBits;
+typedef uint32_t UBits;
+
+typedef union {
+  lua_Number n;
+#ifdef LUA_NUMBER_DOUBLE
+  uint64_t b;
+#else
+  UBits b;
+#endif
+} BitNum;
+
+/* Convert argument to bit type. */
+static UBits barg(lua_State *L, int idx)
+{
+  BitNum bn;
+  UBits b;
+  bn.n = lua_tonumber(L, idx);
+#if defined(LUA_NUMBER_DOUBLE)
+  bn.n += 6755399441055744.0;  /* 2^52+2^51 */
+#ifdef SWAPPED_DOUBLE
+  b = (UBits)(bn.b >> 32);
+#else
+  b = (UBits)bn.b;
+#endif
+#elif defined(LUA_NUMBER_INT) || defined(LUA_NUMBER_LONG) || \
+      defined(LUA_NUMBER_LONGLONG) || defined(LUA_NUMBER_LONG_LONG) || \
+      defined(LUA_NUMBER_LLONG)
+  if (sizeof(UBits) == sizeof(lua_Number))
+    b = bn.b;
+  else
+    b = (UBits)(SBits)bn.n;
+#elif defined(LUA_NUMBER_FLOAT)
+#error "A 'float' lua_Number type is incompatible with this library"
+#else
+#error "Unknown number type, check LUA_NUMBER_* in luaconf.h"
+#endif
+  if (b == 0 && !lua_isnumber(L, idx))
+    luaL_typerror(L, idx, "number");
+  return b;
+}
+
+/* Return bit type. */
+#define BRET(b)  lua_pushnumber(L, (lua_Number)(SBits)(b)); return 1;
+
+static int bit_tobit(lua_State *L) { BRET(barg(L, 1)) }
+static int bit_bnot(lua_State *L) { BRET(~barg(L, 1)) }
+
+#define BIT_OP(func, opr) \
+  static int func(lua_State *L) { int i; UBits b = barg(L, 1); \
+    for (i = lua_gettop(L); i > 1; i--) b opr barg(L, i); BRET(b) }
+BIT_OP(bit_band, &=)
+BIT_OP(bit_bor, |=)
+BIT_OP(bit_bxor, ^=)
+
+#define bshl(b, n)  (b << n)
+#define bshr(b, n)  (b >> n)
+#define bsar(b, n)  ((SBits)b >> n)
+#define brol(b, n)  ((b << n) | (b >> (32-n)))
+#define bror(b, n)  ((b << (32-n)) | (b >> n))
+#define BIT_SH(func, fn) \
+  static int func(lua_State *L) { \
+    UBits b = barg(L, 1); UBits n = barg(L, 2) & 31; BRET(fn(b, n)) }
+BIT_SH(bit_lshift, bshl)
+BIT_SH(bit_rshift, bshr)
+BIT_SH(bit_arshift, bsar)
+BIT_SH(bit_rol, brol)
+BIT_SH(bit_ror, bror)
+
+static int bit_bswap(lua_State *L)
+{
+  UBits b = barg(L, 1);
+  b = (b >> 24) | ((b >> 8) & 0xff00) | ((b & 0xff00) << 8) | (b << 24);
+  BRET(b)
+}
+
+static int bit_tohex(lua_State *L)
+{
+  UBits b = barg(L, 1);
+  SBits n = lua_isnone(L, 2) ? 8 : (SBits)barg(L, 2);
+  const char *hexdigits = "0123456789abcdef";
+  char buf[8];
+  int i;
+  if (n < 0) { n = -n; hexdigits = "0123456789ABCDEF"; }
+  if (n > 8) n = 8;
+  for (i = (int)n; --i >= 0; ) { buf[i] = hexdigits[b & 15]; b >>= 4; }
+  lua_pushlstring(L, buf, (size_t)n);
+  return 1;
+}
+
+static const struct luaL_Reg bit_funcs[] = {
+  { "tobit",	bit_tobit },
+  { "bnot",	bit_bnot },
+  { "band",	bit_band },
+  { "bor",	bit_bor },
+  { "bxor",	bit_bxor },
+  { "lshift",	bit_lshift },
+  { "rshift",	bit_rshift },
+  { "arshift",	bit_arshift },
+  { "rol",	bit_rol },
+  { "ror",	bit_ror },
+  { "bswap",	bit_bswap },
+  { "tohex",	bit_tohex },
+  { NULL, NULL }
+};
+
+/* Signed right-shifts are implementation-defined per C89/C99.
+** But the de facto standard are arithmetic right-shifts on two's
+** complement CPUs. This behaviour is required here, so test for it.
+*/
+#define BAD_SAR		(bsar(-8, 2) != (SBits)-2)
+
+LUALIB_API int luaopen_bit(lua_State *L)
+{
+  UBits b;
+  lua_pushnumber(L, (lua_Number)1437217655L);
+  b = barg(L, -1);
+  if (b != (UBits)1437217655L || BAD_SAR) {  /* Perform a simple self-test. */
+    const char *msg = "compiled with incompatible luaconf.h";
+#ifdef LUA_NUMBER_DOUBLE
+#ifdef _WIN32
+    if (b == (UBits)1610612736L)
+      msg = "use D3DCREATE_FPU_PRESERVE with DirectX";
+#endif
+    if (b == (UBits)1127743488L)
+      msg = "not compiled with SWAPPED_DOUBLE";
+#endif
+    if (BAD_SAR)
+      msg = "arithmetic right-shift broken";
+    luaL_error(L, "bit library self-test failed (%s)", msg);
+  }
+  luaL_register(L, "bit", bit_funcs);
+  lua_pop(L, 2);
+  return 1;
+}
+

+-- Microbenchmark for bit operations library. Public domain.
+
+local bit = require"bit"
+
+if not bit.rol then -- Replacement function if rotates are missing.
+  local bor, shl, shr = bit.bor, bit.lshift, bit.rshift
+  function bit.rol(a, b) return bor(shl(a, b), shr(a, 32-b)) end
+end
+
+if not bit.bswap then -- Replacement function if bswap is missing.
+  local bor, band, shl, shr = bit.bor, bit.band, bit.lshift, bit.rshift
+  function bit.bswap(a)
+    return bor(shr(a, 24), band(shr(a, 8), 0xff00),
+	       shl(band(a, 0xff00), 8), shl(a, 24));
+  end
+end
+
+local base = 0
+
+local function bench(name, t)
+  local n = 2000000
+  repeat
+    local tm = os.clock()
+    t(n)
+    tm = os.clock() - tm
+    if tm > 1 then
+      local ns = tm*1000/(n/1000000)
+      io.write(string.format("%-15s %6.1f ns\n", name, ns-base))
+      return ns
+    end
+    n = n + n
+  until false
+end
+
+-- The overhead for the base loop is subtracted from the other measurements.
+base = bench("loop baseline", function(n)
+  local x = 0; for i=1,n do x = x + i end
+end)
+
+bench("tobit", function(n)
+  local f = bit.tobit or bit.cast
+  local x = 0; for i=1,n do x = x + f(i) end
+end)
+
+bench("bnot", function(n)
+  local f = bit.bnot
+  local x = 0; for i=1,n do x = x + f(i) end
+end)
+
+bench("bor/band/bxor", function(n)
+  local f = bit.bor
+  local x = 0; for i=1,n do x = x + f(i, 1) end
+end)
+
+bench("shifts", function(n)
+  local f = bit.lshift
+  local x = 0; for i=1,n do x = x + f(i, 1) end
+end)
+
+bench("rotates", function(n)
+  local f = bit.rol
+  local x = 0; for i=1,n do x = x + f(i, 1) end
+end)
+
+bench("bswap", function(n)
+  local f = bit.bswap
+  local x = 0; for i=1,n do x = x + f(i) end
+end)
+

+-- Test cases for bit operations library. Public domain.
+
+local bit = require"bit"
+
+local vb = {
+  0, 1, -1, 2, -2, 0x12345678, 0x87654321,
+  0x33333333, 0x77777777, 0x55aa55aa, 0xaa55aa55,
+  0x7fffffff, 0x80000000, 0xffffffff
+}
+
+local function cksum(name, s, r)
+  local z = 0
+  for i=1,#s do z = (z + string.byte(s, i)*i) % 2147483629 end
+  if z ~= r then
+    error("bit."..name.." test failed (got "..z..", expected "..r..")", 0)
+  end
+end
+
+local function check_unop(name, r)
+  local f = bit[name]
+  local s = ""
+  if pcall(f) or pcall(f, "z") or pcall(f, true) then
+    error("bit."..name.." fails to detect argument errors", 0)
+  end
+  for _,x in ipairs(vb) do s = s..","..tostring(f(x)) end
+  cksum(name, s, r)
+end
+
+local function check_binop(name, r)
+  local f = bit[name]
+  local s = ""
+  if pcall(f) or pcall(f, "z") or pcall(f, true) then
+    error("bit."..name.." fails to detect argument errors", 0)
+  end
+  for _,x in ipairs(vb) do
+    for _,y in ipairs(vb) do s = s..","..tostring(f(x, y)) end
+  end
+  cksum(name, s, r)
+end
+
+local function check_binop_range(name, r, yb, ye)
+  local f = bit[name]
+  local s = ""
+  if pcall(f) or pcall(f, "z") or pcall(f, true) or pcall(f, 1, true) then
+    error("bit."..name.." fails to detect argument errors", 0)
+  end
+  for _,x in ipairs(vb) do
+    for y=yb,ye do s = s..","..tostring(f(x, y)) end
+  end
+  cksum(name, s, r)
+end
+
+local function check_shift(name, r)
+  check_binop_range(name, r, 0, 31)
+end
+
+-- Minimal sanity checks.
+assert(0x7fffffff == 2147483647, "broken hex literals")
+assert(0xffffffff == -1 or 0xffffffff == 2^32-1, "broken hex literals")
+assert(tostring(-1) == "-1", "broken tostring()")
+assert(tostring(0xffffffff) == "-1" or tostring(0xffffffff) == "4294967295", "broken tostring()")
+
+-- Basic argument processing.
+assert(bit.tobit(1) == 1)
+assert(bit.band(1) == 1)
+assert(bit.bxor(1,2) == 3)
+assert(bit.bor(1,2,4,8,16,32,64,128) == 255)
+
+-- Apply operations to test vectors and compare checksums.
+check_unop("tobit", 277312)
+check_unop("bnot", 287870)
+check_unop("bswap", 307611)
+
+check_binop("band", 41206764)
+check_binop("bor", 51253663)
+check_binop("bxor", 79322427)
+
+check_shift("lshift", 325260344)
+check_shift("rshift", 139061800)
+check_shift("arshift", 111364720)
+check_shift("rol", 302401155)
+check_shift("ror", 302316761)
+
+check_binop_range("tohex", 47880306, -8, 8)
+

+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<title>API Functions</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta name="Author" content="Mike Pall">
+<meta name="Copyright" content="Copyright (C) 2005-2009, Mike Pall">
+<meta name="Language" content="en">
+<link rel="stylesheet" type="text/css" href="bluequad.css" media="screen">
+<link rel="stylesheet" type="text/css" href="bluequad-print.css" media="print">
+</head>
+<body>
+<div id="site">
+<a href="http://bitop.luajit.org"><span>Bit<span id="logo">Op</span></span></a>
+</div>
+<div id="head">
+<h1>API Functions</h1>
+</div>
+<div id="nav">
+<ul><li>
+<a href="index.html">Lua BitOp</a>
+</li><li>
+<a href="install.html">Installation</a>
+</li><li>
+<a class="current" href="api.html">API Functions</a>
+</li><li>
+<a href="semantics.html">Semantics</a>
+</li><li>
+<a href="changes.html">Changes</a>
+</li><li>
+<a href="http://bitop.luajit.org/download.html">Download <span class="ext">&raquo;</span></a>
+</li></ul>
+</div>
+<div id="main">
+<p>
+This list of API functions is not intended to replace a tutorial.
+If you are not familiar with the terms used, you may want to study the
+<a href="http://en.wikipedia.org/wiki/Bitwise_operation"><span class="ext">&raquo;</span>&nbsp;Wikipedia
+article on bitwise operations</a> first.
+</p>
+<h2 id="loading">Loading the BitOp Module</h2>
+<p>
+The suggested way to use the BitOp module is to add the following
+to the start of <em>every</em> Lua file that needs one of its functions:
+</p>
+<pre class="code">
+local bit = require("bit")
+</pre>
+<p>
+This makes the dependency explicit, limits the scope to the current file
+and provides faster access to the <tt>bit.*</tt> functions, too.
+It's good programming practice <em>not</em> to rely on the global variable
+<tt>bit</tt> being set (assuming some other part of your application
+has already loaded the module). The <tt>require</tt> function ensures
+the module is only loaded once, in any case.
+</p>
+<h2 id="shortcuts">Defining Shortcuts</h2>
+<p>
+It's a common (but not a required) practice to cache often used module
+functions in locals. This serves as a shortcut to save some typing
+and also speeds up resolving them (only relevant if called hundreds of
+thousands of times).
+</p>
+<pre class="code">
+local bnot = bit.bnot
+local band, bor, bxor = bit.band, bit.bor, bit.bxor
+local lshift, rshift, rol = bit.lshift, bit.rshift, bit.rol
+-- etc...
+
+-- Example use of the shortcuts:
+local function tr_i(a, b, c, d, x, s)
+  return rol(bxor(c, bor(b, bnot(d))) + a + x, s) + b
+end
+</pre>
+<p>
+Remember that <b><tt>and</tt></b>, <b><tt>or</tt></b> and <b><tt>not</tt></b>
+are reserved keywords in Lua. They cannot be used for variable names or
+literal field names. That's why the corresponding bitwise functions have
+been named <tt>band</tt>, <tt>bor</tt>, and <tt>bnot</tt>
+(and <tt>bxor</tt> for consistency).
+<p>
+While we are at it: a common pitfall is to use <tt>bit</tt> as the
+name of a local temporary variable &mdash; well, don't! :-)
+</p>
+<h2 id="examples">About the Examples</h2>
+<p>
+The examples below show small Lua one-liners. Their expected output
+is shown after <tt>--&gt;</tt>. This is interpreted as a comment marker
+by Lua so you can cut &amp; paste the whole line to a Lua prompt
+and experiment with it.
+</p>
+<p>
+Note that all bit operations return <em>signed</em> 32&nbsp;bit numbers
+(<a href="semantics.html#range">rationale</a>). And these print
+as signed decimal numbers by default.
+</p>
+<p>
+For clarity the examples assume the definition of a helper function
+<tt>printx()</tt>. This prints its argument as an <em>unsigned</em>
+32&nbsp;bit hexadecimal number on all platforms:
+</p>
+<pre class="code">
+function printx(x)
+  print("0x"..bit.tohex(x))
+end
+</pre>
+
+<h2 id="operations">Bit Operations</h2>
+<h3 id="tobit"><tt>y = bit.tobit(x)</tt></h3>
+<p>
+Normalizes a number to the numeric range for bit operations and returns it.
+This function is usually not needed since all bit operations already
+normalize all of their input arguments. Check the
+<a href="semantics.html">operational semantics</a> for details.
+</p>
+<pre class="code">
+print(0xffffffff)                --> 4294967295 (*)
+print(bit.tobit(0xffffffff))     --> -1
+printx(bit.tobit(0xffffffff))    --> 0xffffffff
+print(bit.tobit(0xffffffff + 1)) --> 0
+print(bit.tobit(2^40 + 1234))    --> 1234
+</pre>
+<p style="font-size: 80%;">
+(*) See the treatment of <a href="semantics.html#hexlit">hex literals</a>
+for an explanation why the printed numbers in the first two lines
+differ (if your Lua installation uses a <tt>double</tt> number type).
+</p>
+
+<h3 id="tohex"><tt>y = bit.tohex(x [,n])</tt></h3>
+<p>
+Converts its first argument to a hex string. The number of hex digits is
+given by the absolute value of the optional second argument. Positive
+numbers between 1 and 8 generate lowercase hex digits. Negative numbers
+generate uppercase hex digits. Only the least-significant 4*|n| bits are
+used. The default is to generate 8 lowercase hex digits.
+</p>
+<pre class="code">
+print(bit.tohex(1))              --> 00000001
+print(bit.tohex(-1))             --> ffffffff
+print(bit.tohex(0xffffffff))     --> ffffffff
+print(bit.tohex(-1, -8))         --> FFFFFFFF
+print(bit.tohex(0x21, 4))        --> 0021
+print(bit.tohex(0x87654321, 4))  --> 4321
+</pre>
+
+<h3 id="bnot"><tt>y = bit.bnot(x)</tt></h3>
+<p>
+Returns the bitwise <b>not</b> of its argument.
+</p>
+<pre class="code">
+print(bit.bnot(0))            --> -1
+printx(bit.bnot(0))           --> 0xffffffff
+print(bit.bnot(-1))           --> 0
+print(bit.bnot(0xffffffff))   --> 0
+printx(bit.bnot(0x12345678))  --> 0xedcba987
+</pre>
+
+<h3 id="bor"><tt>y = bit.bor(x1 [,x2...])<br>
+y = bit.band(x1 [,x2...])<br>
+y = bit.bxor(x1 [,x2...])</tt></h3>
+<p>
+Returns either the bitwise <b>or</b>, bitwise <b>and</b>,
+or bitwise <b>xor</b> of all of its arguments.
+Note that more than two arguments are allowed.
+</p>
+<pre class="code">
+print(bit.bor(1, 2, 4, 8))                --> 15
+printx(bit.band(0x12345678, 0xff))        --> 0x00000078
+printx(bit.bxor(0xa5a5f0f0, 0xaa55ff00))  --> 0x0ff00ff0
+</pre>
+
+<h3 id="lshift"><tt>y = bit.lshift(x, n)<br>
+y = bit.rshift(x, n)<br>
+y = bit.arshift(x, n)</tt></h3>
+<p>
+Returns either the bitwise <b>logical left-shift</b>,
+bitwise <b>logical right-shift</b>, or bitwise <b>arithmetic right-shift</b>
+of its first argument by the number of bits given by the second argument.
+</p>
+<p>
+Logical shifts treat the first argument as an unsigned number and shift in
+0-bits. Arithmetic right-shift treats the most-significant bit
+as a sign bit and replicates it.<br>
+Only the lower 5&nbsp;bits of the shift count are used
+(reduces to the range [0..31]).
+</p>
+<pre class="code">
+print(bit.lshift(1, 0))              --> 1
+print(bit.lshift(1, 8))              --> 256
+print(bit.lshift(1, 40))             --> 256
+print(bit.rshift(256, 8))            --> 1
+print(bit.rshift(-256, 8))           --> 16777215
+print(bit.arshift(256, 8))           --> 1
+print(bit.arshift(-256, 8))          --> -1
+printx(bit.lshift(0x87654321, 12))   --> 0x54321000
+printx(bit.rshift(0x87654321, 12))   --> 0x00087654
+printx(bit.arshift(0x87654321, 12))  --> 0xfff87654
+</pre>
+
+<h3 id="rol"><tt>y = bit.rol(x, n)<br>
+y = bit.ror(x, n)</tt></h3>
+<p>
+Returns either the bitwise <b>left rotation</b>,
+or bitwise <b>right rotation</b> of its first argument by the
+number of bits given by the second argument.
+Bits shifted out on one side are shifted back in on the other side.<br>
+Only the lower 5&nbsp;bits of the rotate count are used
+(reduces to the range [0..31]).
+</p>
+<pre class="code">
+printx(bit.rol(0x12345678, 12))   --> 0x45678123
+printx(bit.ror(0x12345678, 12))   --> 0x67812345
+</pre>
+
+<h3 id="bswap"><tt>y = bit.bswap(x)</tt></h3>
+<p>
+Swaps the bytes of its argument and returns it. This can be used
+to convert little-endian 32&nbsp;bit numbers to big-endian 32&nbsp;bit
+numbers or vice versa.
+</p>
+<pre class="code">
+printx(bit.bswap(0x12345678)) --> 0x78563412
+printx(bit.bswap(0x78563412)) --> 0x12345678
+</pre>
+
+<h2 id="nsievebits">Example Program</h2>
+<p>
+This is an implementation of the (na&iuml;ve) <em>Sieve of Eratosthenes</em>
+algorithm. It counts the number of primes up to some maximum number.
+</p>
+<p>
+A Lua table is used to hold a bit-vector. Every array index has
+32&nbsp;bits of the vector. Bitwise operations are used to access and
+modify them. Note that the shift counts don't need to be masked
+since this is already done by the BitOp shift and rotate functions.
+</p>
+<pre class="code">
+local bit = require("bit")
+local band, bxor = bit.band, bit.bxor
+local rshift, rol = bit.rshift, bit.rol
+
+local m = tonumber(arg and arg[1]) or 100000
+if m < 2 then m = 2 end
+local count = 0
+local p = {}
+
+for i=0,(m+31)/32 do p[i] = -1 end
+
+for i=2,m do
+  if band(rshift(p[rshift(i, 5)], i), 1) ~= 0 then
+    count = count + 1
+    for j=i+i,m,i do
+      local jx = rshift(j, 5)
+      p[jx] = band(p[jx], rol(-2, j))
+    end
+  end
+end
+
+io.write(string.format("Found %d primes up to %d\n", count, m))
+</pre>
+<p>
+Lua BitOp is quite fast. This program runs in less than
+90&nbsp;milliseconds on a 3&nbsp;GHz CPU with a standard Lua installation,
+but performs more than a million calls to bitwise functions.
+If you're looking for even more speed,
+check out <a href="http://luajit.org/"><span class="ext">&raquo;</span>&nbsp;LuaJIT</a>.
+</p>
+
+<h2 id="caveats">Caveats</h2>
+<h3>Signed Results</h3>
+<p>
+Returning signed numbers from bitwise operations may be surprising to
+programmers coming from other programming languages which have both
+signed and unsigned types. But as long as you treat the results of
+bitwise operations uniformly everywhere, this shouldn't cause any problems.
+</p>
+<p>
+Preferrably format results with <tt>bit.tohex</tt> if you want a
+reliable unsigned string representation. Avoid the <tt>"%x"</tt> or
+<tt>"%u"</tt> formats for <tt>string.format</tt>. They fail on some
+architectures for negative numbers and can return more than 8 hex digits
+on others.
+</p>
+<p>
+You may also want to avoid the default number to string coercion,
+since this is a signed conversion.
+The coercion is used for string concatenation and all standard library
+functions which accept string arguments (such as <tt>print()</tt> or
+<tt>io.write()</tt>).
+</p>
+<h3>Conditionals</h3>
+<p>
+If you're transcribing some code from C/C++, watch out for
+bit operations in conditionals. In C/C++ any non-zero value
+is implicitly considered as "true". E.g. this C code:<br>
+<tt>&nbsp;&nbsp;if (x & 3) ...</tt><br>
+must not be turned into this Lua code:<br>
+<tt>&nbsp;&nbsp;if band(x, 3) then ... -- <em>wrong!</em></tt>
+</p>
+<p>
+In Lua all objects except <tt>nil</tt> and <tt>false</tt> are
+considered "true". This includes all numbers. An explicit comparison
+against zero is required in this case:<br>
+<tt>&nbsp;&nbsp;if band(x, 3) ~= 0 then ... -- <em>correct!</em></tt>
+</p>
+<h3>Comparing Against Hex Literals</h3>
+<p>
+Comparing the results of bitwise operations (<em>signed</em> numbers)
+against hex literals (<em>unsigned</em> numbers) needs some additional care.
+The following conditional expression may or may not work right,
+depending on the platform you run it on:<br>
+<tt>&nbsp;&nbsp;bit.bor(x, 1) == 0xffffffff</tt><br>
+E.g. it's never true on a Lua installation with the default number type.
+Some simple solutions:
+</p>
+<ul>
+<li>Either never use hex literals larger than 0x7fffffff in comparisons:<br>
+<tt>&nbsp;&nbsp;bit.bor(x, 1) == -1</tt></li>
+<li>Or convert them with <tt>bit.tobit()</tt> before comparing:<br>
+<tt>&nbsp;&nbsp;bit.bor(x, 1) == bit.tobit(0xffffffff)</tt></li>
+<li>Or use a generic workaround with <tt>bit.bxor()</tt>:<br>
+<tt>&nbsp;&nbsp;bit.bxor(bit.bor(x, 1), 0xffffffff) == 0</tt></li>
+<li>Or use a case-specific workaround:<br>
+<tt>&nbsp;&nbsp;bit.rshift(x, 1) == 0x7fffffff</tt></li>
+</ul>
+<br class="flush">
+</div>
+<div id="foot">
+<hr class="hide">
+Copyright &copy; 2009 Mike Pall
+<span class="noprint">
+&middot;
+<a href="contact.html">Contact</a>
+</span>
+</div>
+</body>
+</html>

+/* Copyright (C) 2004-2009 Mike Pall.
+ *
+ * You are welcome to use the general ideas of this design for your own sites.
+ * But please do not steal the stylesheet, the layout or the color scheme.
+ */
+body {
+  font-family: serif;
+  font-size: 11pt;
+  margin: 0 3em;
+  padding: 0;
+  border: none;
+}
+a:link, a:visited, a:hover, a:active {
+  text-decoration: none;
+  background: transparent;
+  color: #0000ff;
+}
+h1, h2, h3 {
+  font-family: sans-serif;
+  font-weight: bold;
+  text-align: left;
+  margin: 0.5em 0;
+  padding: 0;
+}
+h1 {
+  font-size: 200%;
+}
+h2 {
+  font-size: 150%;
+}
+h3 {
+  font-size: 125%;
+}
+p {
+  margin: 0 0 0.5em 0;
+  padding: 0;
+}
+ul, ol {
+  margin: 0.5em 0;
+  padding: 0 0 0 2em;
+}
+ul {
+  list-style: outside square;
+}
+ol {
+  list-style: outside decimal;
+}
+li {
+  margin: 0;
+  padding: 0;
+}
+dl {
+  margin: 1em 0;
+  padding: 1em;
+  border: 1px solid black;
+}
+dt {
+  font-weight: bold;
+  margin: 0;
+  padding: 0;
+}
+dt sup {
+  float: right;
+  margin-left: 1em;
+}
+dd {
+  margin: 0.5em 0 0 2em;
+  padding: 0;
+}
+table {
+  table-layout: fixed;
+  width: 100%;
+  margin: 1em 0;
+  padding: 0;
+  border: 1px solid black;
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+tr {
+  margin: 0;
+  padding: 0;
+  border: none;
+}
+td {
+  text-align: left;
+  margin: 0;
+  padding: 0.2em 0.5em;
+  border-top: 1px solid black;
+  border-bottom: 1px solid black;
+}
+tr.separate td {
+  border-top: double;
+}
+tt, pre, code, kbd, samp {
+  font-family: monospace;
+  font-size: 75%;
+}
+kbd {
+  font-weight: bolder;
+}
+blockquote, pre {
+  margin: 1em 2em;
+  padding: 0;
+}
+img {
+  border: none;
+  vertical-align: baseline;
+  margin: 0;
+  padding: 0;
+}
+img.left {
+  float: left;
+  margin: 0.5em 1em 0.5em 0;
+}
+img.right {
+  float: right;
+  margin: 0.5em 0 0.5em 1em;
+}
+.flush {
+  clear: both;
+  visibility: hidden;
+}
+.hide, .noprint, #nav {
+  display: none !important;
+}
+.pagebreak {
+  page-break-before: always;
+}
+#site {
+  text-align: right;
+  font-family: sans-serif;
+  font-weight: bold;
+  margin: 0 1em;
+  border-bottom: 1pt solid black;
+}
+#site a {
+  font-size: 1.2em;
+}
+#site a:link, #site a:visited {
+  text-decoration: none;
+  font-weight: bold;
+  background: transparent;
+  color: #ffffff;
+}
+#logo {
+  color: #ff8000;
+}
+#head {
+  clear: both;
+  margin: 0 1em;
+}
+#main {
+  line-height: 1.3;
+  text-align: justify;
+  margin: 1em;
+}
+#foot {
+  clear: both;
+  font-size: 80%;
+  text-align: center;
+  margin: 0 1.25em;
+  padding: 0.5em 0 0 0;
+  border-top: 1pt solid black;
+  page-break-before: avoid;
+  page-break-after: avoid;
+}

+/* Copyright (C) 2004-2009 Mike Pall.
+ *
+ * You are welcome to use the general ideas of this design for your own sites.
+ * But please do not steal the stylesheet, the layout or the color scheme.
+ */
+/* colorscheme:
+ *
+ * site  |  head   #4162bf/white   | #6078bf/#e6ecff
+ * ------+------   ----------------+-------------------
+ * nav   |  main   #bfcfff         | #e6ecff/black
+ *
+ * nav:  hiback   loback     #c5d5ff #b9c9f9
+ *       hiborder loborder   #e6ecff #97a7d7
+ *       link     hover      #2142bf #ff0000
+ *
+ * link: link visited hover  #2142bf #8122bf #ff0000
+ *
+ * main: boxback  boxborder  #f0f4ff #bfcfff
+ */
+body {
+  font-family: Verdana, Arial, Helvetica, sans-serif;
+  font-size: 10pt;
+  margin: 0;
+  padding: 0;
+  border: none;
+  background: #e0e0e0;
+  color: #000000;
+}
+a:link {
+  text-decoration: none;
+  background: transparent;
+  color: #2142bf;
+}
+a:visited {
+  text-decoration: none;
+  background: transparent;
+  color: #8122bf;
+}
+a:hover, a:active {
+  text-decoration: underline;
+  background: transparent;
+  color: #ff0000;
+}
+h1, h2, h3 {
+  font-weight: bold;
+  text-align: left;
+  margin: 0.5em 0;
+  padding: 0;
+  background: transparent;
+}
+h1 {
+  font-size: 200%;
+  line-height: 3em; /* really 6em relative to body, match #site span */
+  margin: 0;
+}
+h2 {
+  font-size: 150%;
+  color: #606060;
+}
+h3 {
+  font-size: 125%;
+  color: #404040;
+}
+p {
+  max-width: 600px;
+  margin: 0 0 0.5em 0;
+  padding: 0;
+}
+ul, ol {
+  max-width: 600px;
+  margin: 0.5em 0;
+  padding: 0 0 0 2em;
+}
+ul {
+  list-style: outside square;
+}
+ol {
+  list-style: outside decimal;
+}
+li {
+  margin: 0;
+  padding: 0;
+}
+dl {
+  max-width: 600px;
+  margin: 1em 0;
+  padding: 1em;
+  border: 1px solid #bfcfff;
+  background: #f0f4ff;
+}
+dt {
+  font-weight: bold;
+  margin: 0;
+  padding: 0;
+}
+dt sup {
+  float: right;
+  margin-left: 1em;
+  color: #808080;
+}
+dt a:visited {
+  text-decoration: none;
+  color: #2142bf;
+}
+dt a:hover, dt a:active {
+  text-decoration: none;
+  color: #ff0000;
+}
+dd {
+  margin: 0.5em 0 0 2em;
+  padding: 0;
+}
+div.tablewrap { /* for IE *sigh* */
+  max-width: 600px;
+}
+table {
+  table-layout: fixed;
+  border-spacing: 0;
+  border-collapse: collapse;
+  max-width: 600px;
+  width: 100%;
+  margin: 1em 0;
+  padding: 0;
+  border: 1px solid #bfcfff;
+}
+tr {
+  margin: 0;
+  padding: 0;
+  border: none;
+}
+tr.odd {
+  background: #f0f4ff;
+}
+tr.separate td {
+  border-top: 1px solid #bfcfff;
+}
+td {
+  text-align: left;
+  margin: 0;
+  padding: 0.2em 0.5em;
+  border: none;
+}
+tt, code, kbd, samp {
+  font-family: Courier New, Courier, monospace;
+  font-size: 110%;
+}
+kbd {
+  font-weight: bolder;
+}
+blockquote, pre {
+  max-width: 600px;
+  margin: 1em 2em;
+  padding: 0;
+}
+pre {
+  line-height: 1.1;
+}
+pre.code {
+  line-height: 1.4;
+  margin: 0.5em 0 1em 0.5em;
+  padding: 0.5em 1em;
+  border: 1px solid #bfcfff;
+  background: #f0f4ff;
+}
+img {
+  border: none;
+  vertical-align: baseline;
+  margin: 0;
+  padding: 0;
+}
+img.left {
+  float: left;
+  margin: 0.5em 1em 0.5em 0;
+}
+img.right {
+  float: right;
+  margin: 0.5em 0 0.5em 1em;
+}
+.indent {
+  padding-left: 1em;
+}
+.flush {
+  clear: both;
+  visibility: hidden;
+}
+.hide, .noscreen {
+  display: none !important;
+}
+.ext {
+  color: #ff8000;
+}
+#site {
+  clear: both;
+  float: left;
+  width: 13em;
+  text-align: center;
+  font-weight: bold;
+  margin: 0;
+  padding: 0;
+  background: transparent;
+  color: #ffffff;
+}
+#site a {
+  font-size: 200%;
+}
+#site a:link, #site a:visited {
+  text-decoration: none;
+  font-weight: bold;
+  background: transparent;
+  color: #ffffff;
+}
+#site span {
+  line-height: 3em; /* really 6em relative to body, match h1 */
+}
+#logo {
+  color: #ffb380;
+}
+#head {
+  margin: 0;
+  padding: 0 0 0 2em;
+  border-left: solid 13em #4162bf;
+  border-right: solid 3em #6078bf;
+  background: #6078bf;