The Battle for Wesnoth  1.15.10+dev
ltablib.cpp
Go to the documentation of this file.
1 /*
2 ** $Id: ltablib.c $
3 ** Library for Table Manipulation
4 ** See Copyright Notice in lua.h
5 */
6 
7 #define ltablib_c
8 #define LUA_LIB
9 
10 #include "lprefix.h"
11 
12 
13 #include <limits.h>
14 #include <stddef.h>
15 #include <string.h>
16 
17 #include "lua.h"
18 
19 #include "lauxlib.h"
20 #include "lualib.h"
21 
22 
23 /*
24 ** Operations that an object must define to mimic a table
25 ** (some functions only need some of them)
26 */
27 #define TAB_R 1 /* read */
28 #define TAB_W 2 /* write */
29 #define TAB_L 4 /* length */
30 #define TAB_RW (TAB_R | TAB_W) /* read/write */
31 
32 
33 #define aux_getn(L,n,w) (checktab(L, n, (w) | TAB_L), luaL_len(L, n))
34 
35 
36 static int checkfield (lua_State *L, const char *key, int n) {
37  lua_pushstring(L, key);
38  return (lua_rawget(L, -n) != LUA_TNIL);
39 }
40 
41 
42 /*
43 ** Check that 'arg' either is a table or can behave like one (that is,
44 ** has a metatable with the required metamethods)
45 */
46 static void checktab (lua_State *L, int arg, int what) {
47  if (lua_type(L, arg) != LUA_TTABLE) { /* is it not a table? */
48  int n = 1; /* number of elements to pop */
49  if (lua_getmetatable(L, arg) && /* must have metatable */
50  (!(what & TAB_R) || checkfield(L, "__index", ++n)) &&
51  (!(what & TAB_W) || checkfield(L, "__newindex", ++n)) &&
52  (!(what & TAB_L) || checkfield(L, "__len", ++n))) {
53  lua_pop(L, n); /* pop metatable and tested metamethods */
54  }
55  else
56  luaL_checktype(L, arg, LUA_TTABLE); /* force an error */
57  }
58 }
59 
60 
61 static int tinsert (lua_State *L) {
62  lua_Integer e = aux_getn(L, 1, TAB_RW) + 1; /* first empty element */
63  lua_Integer pos; /* where to insert new element */
64  switch (lua_gettop(L)) {
65  case 2: { /* called with only 2 arguments */
66  pos = e; /* insert new element at the end */
67  break;
68  }
69  case 3: {
70  lua_Integer i;
71  pos = luaL_checkinteger(L, 2); /* 2nd argument is the position */
72  /* check whether 'pos' is in [1, e] */
73  luaL_argcheck(L, (lua_Unsigned)pos - 1u < (lua_Unsigned)e, 2,
74  "position out of bounds");
75  for (i = e; i > pos; i--) { /* move up elements */
76  lua_geti(L, 1, i - 1);
77  lua_seti(L, 1, i); /* t[i] = t[i - 1] */
78  }
79  break;
80  }
81  default: {
82  return luaL_error(L, "wrong number of arguments to 'insert'");
83  }
84  }
85  lua_seti(L, 1, pos); /* t[pos] = v */
86  return 0;
87 }
88 
89 
90 static int tremove (lua_State *L) {
92  lua_Integer pos = luaL_optinteger(L, 2, size);
93  if (pos != size) /* validate 'pos' if given */
94  /* check whether 'pos' is in [1, size + 1] */
95  luaL_argcheck(L, (lua_Unsigned)pos - 1u <= (lua_Unsigned)size, 1,
96  "position out of bounds");
97  lua_geti(L, 1, pos); /* result = t[pos] */
98  for ( ; pos < size; pos++) {
99  lua_geti(L, 1, pos + 1);
100  lua_seti(L, 1, pos); /* t[pos] = t[pos + 1] */
101  }
102  lua_pushnil(L);
103  lua_seti(L, 1, pos); /* remove entry t[pos] */
104  return 1;
105 }
106 
107 
108 /*
109 ** Copy elements (1[f], ..., 1[e]) into (tt[t], tt[t+1], ...). Whenever
110 ** possible, copy in increasing order, which is better for rehashing.
111 ** "possible" means destination after original range, or smaller
112 ** than origin, or copying to another table.
113 */
114 static int tmove (lua_State *L) {
118  int tt = !lua_isnoneornil(L, 5) ? 5 : 1; /* destination table */
119  checktab(L, 1, TAB_R);
120  checktab(L, tt, TAB_W);
121  if (e >= f) { /* otherwise, nothing to move */
122  lua_Integer n, i;
123  luaL_argcheck(L, f > 0 || e < LUA_MAXINTEGER + f, 3,
124  "too many elements to move");
125  n = e - f + 1; /* number of elements to move */
126  luaL_argcheck(L, t <= LUA_MAXINTEGER - n + 1, 4,
127  "destination wrap around");
128  if (t > e || t <= f || (tt != 1 && !lua_compare(L, 1, tt, LUA_OPEQ))) {
129  for (i = 0; i < n; i++) {
130  lua_geti(L, 1, f + i);
131  lua_seti(L, tt, t + i);
132  }
133  }
134  else {
135  for (i = n - 1; i >= 0; i--) {
136  lua_geti(L, 1, f + i);
137  lua_seti(L, tt, t + i);
138  }
139  }
140  }
141  lua_pushvalue(L, tt); /* return destination table */
142  return 1;
143 }
144 
145 
147  lua_geti(L, 1, i);
148  if (!lua_isstring(L, -1))
149  luaL_error(L, "invalid value (%s) at index %d in table for 'concat'",
150  luaL_typename(L, -1), i);
151  luaL_addvalue(b);
152 }
153 
154 
155 static int tconcat (lua_State *L) {
156  luaL_Buffer b;
157  lua_Integer last = aux_getn(L, 1, TAB_R);
158  size_t lsep;
159  const char *sep = luaL_optlstring(L, 2, "", &lsep);
160  lua_Integer i = luaL_optinteger(L, 3, 1);
161  last = luaL_optinteger(L, 4, last);
162  luaL_buffinit(L, &b);
163  for (; i < last; i++) {
164  addfield(L, &b, i);
165  luaL_addlstring(&b, sep, lsep);
166  }
167  if (i == last) /* add last value (if interval was not empty) */
168  addfield(L, &b, i);
169  luaL_pushresult(&b);
170  return 1;
171 }
172 
173 
174 /*
175 ** {======================================================
176 ** Pack/unpack
177 ** =======================================================
178 */
179 
180 static int tpack (lua_State *L) {
181  int i;
182  int n = lua_gettop(L); /* number of elements to pack */
183  lua_createtable(L, n, 1); /* create result table */
184  lua_insert(L, 1); /* put it at index 1 */
185  for (i = n; i >= 1; i--) /* assign elements */
186  lua_seti(L, 1, i);
187  lua_pushinteger(L, n);
188  lua_setfield(L, 1, "n"); /* t.n = number of elements */
189  return 1; /* return table */
190 }
191 
192 
193 static int tunpack (lua_State *L) {
194  lua_Unsigned n;
195  lua_Integer i = luaL_optinteger(L, 2, 1);
197  if (i > e) return 0; /* empty range */
198  n = (lua_Unsigned)e - i; /* number of elements minus 1 (avoid overflows) */
199  if (n >= (unsigned int)INT_MAX || !lua_checkstack(L, (int)(++n)))
200  return luaL_error(L, "too many results to unpack");
201  for (; i < e; i++) { /* push arg[i..e - 1] (to avoid overflows) */
202  lua_geti(L, 1, i);
203  }
204  lua_geti(L, 1, e); /* push last element */
205  return (int)n;
206 }
207 
208 /* }====================================================== */
209 
210 
211 
212 /*
213 ** {======================================================
214 ** Quicksort
215 ** (based on 'Algorithms in MODULA-3', Robert Sedgewick;
216 ** Addison-Wesley, 1993.)
217 ** =======================================================
218 */
219 
220 
221 /* type for array indices */
222 typedef unsigned int IdxT;
223 
224 
225 /*
226 ** Produce a "random" 'unsigned int' to randomize pivot choice. This
227 ** macro is used only when 'sort' detects a big imbalance in the result
228 ** of a partition. (If you don't want/need this "randomness", ~0 is a
229 ** good choice.)
230 */
231 #if !defined(l_randomizePivot) /* { */
232 
233 #include <time.h>
234 
235 /* size of 'e' measured in number of 'unsigned int's */
236 #define sof(e) (sizeof(e) / sizeof(unsigned int))
237 
238 /*
239 ** Use 'time' and 'clock' as sources of "randomness". Because we don't
240 ** know the types 'clock_t' and 'time_t', we cannot cast them to
241 ** anything without risking overflows. A safe way to use their values
242 ** is to copy them to an array of a known type and use the array values.
243 */
244 static unsigned int l_randomizePivot (void) {
245  clock_t c = clock();
246  time_t t = time(NULL);
247  unsigned int buff[sof(c) + sof(t)];
248  unsigned int i, rnd = 0;
249  memcpy(buff, &c, sof(c) * sizeof(unsigned int));
250  memcpy(buff + sof(c), &t, sof(t) * sizeof(unsigned int));
251  for (i = 0; i < sof(buff); i++)
252  rnd += buff[i];
253  return rnd;
254 }
255 
256 #endif /* } */
257 
258 
259 /* arrays larger than 'RANLIMIT' may use randomized pivots */
260 #define RANLIMIT 100u
261 
262 
263 static void set2 (lua_State *L, IdxT i, IdxT j) {
264  lua_seti(L, 1, i);
265  lua_seti(L, 1, j);
266 }
267 
268 
269 /*
270 ** Return true iff value at stack index 'a' is less than the value at
271 ** index 'b' (according to the order of the sort).
272 */
273 static int sort_comp (lua_State *L, int a, int b) {
274  if (lua_isnil(L, 2)) /* no function? */
275  return lua_compare(L, a, b, LUA_OPLT); /* a < b */
276  else { /* function */
277  int res;
278  lua_pushvalue(L, 2); /* push function */
279  lua_pushvalue(L, a-1); /* -1 to compensate function */
280  lua_pushvalue(L, b-2); /* -2 to compensate function and 'a' */
281  lua_call(L, 2, 1); /* call function */
282  res = lua_toboolean(L, -1); /* get result */
283  lua_pop(L, 1); /* pop result */
284  return res;
285  }
286 }
287 
288 
289 /*
290 ** Does the partition: Pivot P is at the top of the stack.
291 ** precondition: a[lo] <= P == a[up-1] <= a[up],
292 ** so it only needs to do the partition from lo + 1 to up - 2.
293 ** Pos-condition: a[lo .. i - 1] <= a[i] == P <= a[i + 1 .. up]
294 ** returns 'i'.
295 */
296 static IdxT partition (lua_State *L, IdxT lo, IdxT up) {
297  IdxT i = lo; /* will be incremented before first use */
298  IdxT j = up - 1; /* will be decremented before first use */
299  /* loop invariant: a[lo .. i] <= P <= a[j .. up] */
300  for (;;) {
301  /* next loop: repeat ++i while a[i] < P */
302  while ((void)lua_geti(L, 1, ++i), sort_comp(L, -1, -2)) {
303  if (i == up - 1) /* a[i] < P but a[up - 1] == P ?? */
304  luaL_error(L, "invalid order function for sorting");
305  lua_pop(L, 1); /* remove a[i] */
306  }
307  /* after the loop, a[i] >= P and a[lo .. i - 1] < P */
308  /* next loop: repeat --j while P < a[j] */
309  while ((void)lua_geti(L, 1, --j), sort_comp(L, -3, -1)) {
310  if (j < i) /* j < i but a[j] > P ?? */
311  luaL_error(L, "invalid order function for sorting");
312  lua_pop(L, 1); /* remove a[j] */
313  }
314  /* after the loop, a[j] <= P and a[j + 1 .. up] >= P */
315  if (j < i) { /* no elements out of place? */
316  /* a[lo .. i - 1] <= P <= a[j + 1 .. i .. up] */
317  lua_pop(L, 1); /* pop a[j] */
318  /* swap pivot (a[up - 1]) with a[i] to satisfy pos-condition */
319  set2(L, up - 1, i);
320  return i;
321  }
322  /* otherwise, swap a[i] - a[j] to restore invariant and repeat */
323  set2(L, i, j);
324  }
325 }
326 
327 
328 /*
329 ** Choose an element in the middle (2nd-3th quarters) of [lo,up]
330 ** "randomized" by 'rnd'
331 */
332 static IdxT choosePivot (IdxT lo, IdxT up, unsigned int rnd) {
333  IdxT r4 = (up - lo) / 4; /* range/4 */
334  IdxT p = rnd % (r4 * 2) + (lo + r4);
335  lua_assert(lo + r4 <= p && p <= up - r4);
336  return p;
337 }
338 
339 
340 /*
341 ** Quicksort algorithm (recursive function)
342 */
343 static void auxsort (lua_State *L, IdxT lo, IdxT up,
344  unsigned int rnd) {
345  while (lo < up) { /* loop for tail recursion */
346  IdxT p; /* Pivot index */
347  IdxT n; /* to be used later */
348  /* sort elements 'lo', 'p', and 'up' */
349  lua_geti(L, 1, lo);
350  lua_geti(L, 1, up);
351  if (sort_comp(L, -1, -2)) /* a[up] < a[lo]? */
352  set2(L, lo, up); /* swap a[lo] - a[up] */
353  else
354  lua_pop(L, 2); /* remove both values */
355  if (up - lo == 1) /* only 2 elements? */
356  return; /* already sorted */
357  if (up - lo < RANLIMIT || rnd == 0) /* small interval or no randomize? */
358  p = (lo + up)/2; /* middle element is a good pivot */
359  else /* for larger intervals, it is worth a random pivot */
360  p = choosePivot(lo, up, rnd);
361  lua_geti(L, 1, p);
362  lua_geti(L, 1, lo);
363  if (sort_comp(L, -2, -1)) /* a[p] < a[lo]? */
364  set2(L, p, lo); /* swap a[p] - a[lo] */
365  else {
366  lua_pop(L, 1); /* remove a[lo] */
367  lua_geti(L, 1, up);
368  if (sort_comp(L, -1, -2)) /* a[up] < a[p]? */
369  set2(L, p, up); /* swap a[up] - a[p] */
370  else
371  lua_pop(L, 2);
372  }
373  if (up - lo == 2) /* only 3 elements? */
374  return; /* already sorted */
375  lua_geti(L, 1, p); /* get middle element (Pivot) */
376  lua_pushvalue(L, -1); /* push Pivot */
377  lua_geti(L, 1, up - 1); /* push a[up - 1] */
378  set2(L, p, up - 1); /* swap Pivot (a[p]) with a[up - 1] */
379  p = partition(L, lo, up);
380  /* a[lo .. p - 1] <= a[p] == P <= a[p + 1 .. up] */
381  if (p - lo < up - p) { /* lower interval is smaller? */
382  auxsort(L, lo, p - 1, rnd); /* call recursively for lower interval */
383  n = p - lo; /* size of smaller interval */
384  lo = p + 1; /* tail call for [p + 1 .. up] (upper interval) */
385  }
386  else {
387  auxsort(L, p + 1, up, rnd); /* call recursively for upper interval */
388  n = up - p; /* size of smaller interval */
389  up = p - 1; /* tail call for [lo .. p - 1] (lower interval) */
390  }
391  if ((up - lo) / 128 > n) /* partition too imbalanced? */
392  rnd = l_randomizePivot(); /* try a new randomization */
393  } /* tail call auxsort(L, lo, up, rnd) */
394 }
395 
396 
397 static int sort (lua_State *L) {
398  lua_Integer n = aux_getn(L, 1, TAB_RW);
399  if (n > 1) { /* non-trivial interval? */
400  luaL_argcheck(L, n < INT_MAX, 1, "array too big");
401  if (!lua_isnoneornil(L, 2)) /* is there a 2nd argument? */
402  luaL_checktype(L, 2, LUA_TFUNCTION); /* must be a function */
403  lua_settop(L, 2); /* make sure there are two arguments */
404  auxsort(L, 1, (IdxT)n, 0);
405  }
406  return 0;
407 }
408 
409 /* }====================================================== */
410 
411 
412 static const luaL_Reg tab_funcs[] = {
413  {"concat", tconcat},
414  {"insert", tinsert},
415  {"pack", tpack},
416  {"unpack", tunpack},
417  {"remove", tremove},
418  {"move", tmove},
419  {"sort", sort},
420  {NULL, NULL}
421 };
422 
423 
425  luaL_newlib(L, tab_funcs);
426  return 1;
427 }
428 
#define lua_isnoneornil(L, n)
Definition: lua.h:379
LUALIB_API void luaL_addvalue(luaL_Buffer *B)
Definition: lauxlib.cpp:609
LUA_API void lua_createtable(lua_State *L, int narray, int nrec)
Definition: lapi.cpp:728
LUALIB_API lua_Integer luaL_len(lua_State *L, int idx)
Definition: lauxlib.cpp:849
#define sof(e)
Definition: ltablib.cpp:236
#define TAB_R
Definition: ltablib.cpp:27
LUA_API void lua_settop(lua_State *L, int idx)
Definition: lapi.cpp:173
LUA_API int lua_type(lua_State *L, int idx)
Definition: lapi.cpp:260
static void set2(lua_State *L, IdxT i, IdxT j)
Definition: ltablib.cpp:263
#define a
LUALIB_API void luaL_pushresult(luaL_Buffer *B)
Definition: lauxlib.cpp:584
LUA_API int lua_gettop(lua_State *L)
Definition: lapi.cpp:168
#define aux_getn(L, n, w)
Definition: ltablib.cpp:33
LUA_API int lua_rawget(lua_State *L, int idx)
Definition: lapi.cpp:698
#define TAB_RW
Definition: ltablib.cpp:30
LUALIB_API lua_Integer luaL_optinteger(lua_State *L, int arg, lua_Integer def)
Definition: lauxlib.cpp:452
#define luaL_typename(L, i)
Definition: lauxlib.h:141
LUA_API int lua_checkstack(lua_State *L, int n)
Definition: lapi.cpp:98
#define LUA_TFUNCTION
Definition: lua.h:71
static int tunpack(lua_State *L)
Definition: ltablib.cpp:193
#define lua_pop(L, n)
Definition: lua.h:364
#define LUA_OPLT
Definition: lua.h:223
#define b
LUALIB_API const char * luaL_optlstring(lua_State *L, int arg, const char *def, size_t *len)
Definition: lauxlib.cpp:409
LUA_INTEGER lua_Integer
Definition: lua.h:94
LUA_API int lua_compare(lua_State *L, int index1, int index2, int op)
Definition: lapi.cpp:327
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:86
LUA_API int lua_isstring(lua_State *L, int idx)
Definition: lapi.cpp:292
#define LUA_TNIL
Definition: lua.h:65
#define luaL_opt(L, f, n, d)
Definition: lauxlib.h:151
static int tmove(lua_State *L)
Definition: ltablib.cpp:114
LUAMOD_API int luaopen_table(lua_State *L)
Definition: ltablib.cpp:424
LUA_API int lua_toboolean(lua_State *L, int idx)
Definition: lapi.cpp:375
LUALIB_API void luaL_buffinit(lua_State *L, luaL_Buffer *B)
Definition: lauxlib.cpp:620
static IdxT partition(lua_State *L, IdxT lo, IdxT up)
Definition: ltablib.cpp:296
LUA_API int lua_getmetatable(lua_State *L, int objindex)
Definition: lapi.cpp:741
static IdxT choosePivot(IdxT lo, IdxT up, unsigned int rnd)
Definition: ltablib.cpp:332
static int tinsert(lua_State *L)
Definition: ltablib.cpp:61
static void addfield(lua_State *L, luaL_Buffer *b, lua_Integer i)
Definition: ltablib.cpp:146
static int sort_comp(lua_State *L, int a, int b)
Definition: ltablib.cpp:273
LUALIB_API void luaL_addlstring(luaL_Buffer *B, const char *s, size_t l)
Definition: lauxlib.cpp:570
LUA_API void lua_pushnil(lua_State *L)
Definition: lapi.cpp:473
unsigned int IdxT
Definition: ltablib.cpp:222
LUALIB_API void luaL_checktype(lua_State *L, int arg, int t)
Definition: lauxlib.cpp:390
#define TAB_W
Definition: ltablib.cpp:28
static int tconcat(lua_State *L)
Definition: ltablib.cpp:155
#define TAB_L
Definition: ltablib.cpp:29
#define lua_isnil(L, n)
Definition: lua.h:375
static int tremove(lua_State *L)
Definition: ltablib.cpp:90
#define lua_assert(c)
Definition: llimits.h:101
std::size_t i
Definition: function.cpp:934
LUALIB_API lua_Integer luaL_checkinteger(lua_State *L, int arg)
Definition: lauxlib.cpp:442
mock_party p
#define RANLIMIT
Definition: ltablib.cpp:260
#define LUAMOD_API
Definition: luaconf.h:286
LUA_API void lua_pushvalue(lua_State *L, int idx)
Definition: lapi.cpp:246
static int sort(lua_State *L)
Definition: ltablib.cpp:397
#define luaL_newlib(L, l)
Definition: lauxlib.h:129
LUA_UNSIGNED lua_Unsigned
Definition: lua.h:97
#define lua_call(L, n, r)
Definition: lua.h:283
LUALIB_API int luaL_error(lua_State *L, const char *fmt,...)
Definition: lauxlib.cpp:234
#define luaL_argcheck(L, cond, arg, extramsg)
Definition: lauxlib.h:132
static const luaL_Reg tab_funcs[]
Definition: ltablib.cpp:412
static int tpack(lua_State *L)
Definition: ltablib.cpp:180
static int checkfield(lua_State *L, const char *key, int n)
Definition: ltablib.cpp:36
#define f
double t
Definition: astarsearch.cpp:64
#define lua_insert(L, idx)
Definition: lua.h:389
LUA_API int lua_geti(lua_State *L, int idx, lua_Integer n)
Definition: lapi.cpp:661
static unsigned int l_randomizePivot(void)
Definition: ltablib.cpp:244
#define e
mock_char c
#define LUA_TTABLE
Definition: lua.h:70
static map_location::DIRECTION n
LUA_API void lua_pushinteger(lua_State *L, lua_Integer n)
Definition: lapi.cpp:489
static void checktab(lua_State *L, int arg, int what)
Definition: ltablib.cpp:46
LUA_API const char * lua_pushstring(lua_State *L, const char *s)
Definition: lapi.cpp:514
LUA_API void lua_setfield(lua_State *L, int idx, const char *k)
Definition: lapi.cpp:837
#define LUA_OPEQ
Definition: lua.h:222
static void auxsort(lua_State *L, IdxT lo, IdxT up, unsigned int rnd)
Definition: ltablib.cpp:343
LUA_API void lua_seti(lua_State *L, int idx, lua_Integer n)
Definition: lapi.cpp:843