The Battle for Wesnoth  1.13.11+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
loslib.cpp
Go to the documentation of this file.
1 /*
2 ** $Id: loslib.c,v 1.65 2016/07/18 17:58:58 roberto Exp $
3 ** Standard Operating System library
4 ** See Copyright Notice in lua.h
5 */
6 
7 #define loslib_c
8 #define LUA_LIB
9 
10 #include "lprefix.h"
11 
12 
13 #include <errno.h>
14 #include <locale.h>
15 #include <stdlib.h>
16 #include <string.h>
17 #include <time.h>
18 
19 #include "lua.h"
20 
21 #include "lauxlib.h"
22 #include "lualib.h"
23 
24 
25 /*
26 ** {==================================================================
27 ** List of valid conversion specifiers for the 'strftime' function;
28 ** options are grouped by length; group of length 2 start with '||'.
29 ** ===================================================================
30 */
31 #if !defined(LUA_STRFTIMEOPTIONS) /* { */
32 
33 /* options for ANSI C 89 (only 1-char options) */
34 #define L_STRFTIMEC89 "aAbBcdHIjmMpSUwWxXyYZ%"
35 
36 /* options for ISO C 99 and POSIX */
37 #define L_STRFTIMEC99 "aAbBcCdDeFgGhHIjmMnprRStTuUVwWxXyYzZ%" \
38  "||" "EcECExEXEyEY" "OdOeOHOIOmOMOSOuOUOVOwOWOy" /* two-char options */
39 
40 /* options for Windows */
41 #define L_STRFTIMEWIN "aAbBcdHIjmMpSUwWxXyYzZ%" \
42  "||" "#c#x#d#H#I#j#m#M#S#U#w#W#y#Y" /* two-char options */
43 
44 #if defined(LUA_USE_WINDOWS)
45 #define LUA_STRFTIMEOPTIONS L_STRFTIMEWIN
46 #elif defined(LUA_USE_C89)
47 #define LUA_STRFTIMEOPTIONS L_STRFTIMEC89
48 #else /* C99 specification */
49 #define LUA_STRFTIMEOPTIONS L_STRFTIMEC99
50 #endif
51 
52 #endif /* } */
53 /* }================================================================== */
54 
55 
56 /*
57 ** {==================================================================
58 ** Configuration for time-related stuff
59 ** ===================================================================
60 */
61 
62 #if !defined(l_time_t) /* { */
63 /*
64 ** type to represent time_t in Lua
65 */
66 #define l_timet lua_Integer
67 #define l_pushtime(L,t) lua_pushinteger(L,(lua_Integer)(t))
68 
69 static time_t l_checktime (lua_State *L, int arg) {
71  luaL_argcheck(L, (time_t)t == t, arg, "time out-of-bounds");
72  return (time_t)t;
73 }
74 
75 #endif /* } */
76 
77 
78 #if !defined(l_gmtime) /* { */
79 /*
80 ** By default, Lua uses gmtime/localtime, except when POSIX is available,
81 ** where it uses gmtime_r/localtime_r
82 */
83 
84 #if defined(LUA_USE_POSIX) /* { */
85 
86 #define l_gmtime(t,r) gmtime_r(t,r)
87 #define l_localtime(t,r) localtime_r(t,r)
88 
89 #else /* }{ */
90 
91 /* ISO C definitions */
92 #define l_gmtime(t,r) ((void)(r)->tm_sec, gmtime(t))
93 #define l_localtime(t,r) ((void)(r)->tm_sec, localtime(t))
94 
95 #endif /* } */
96 
97 #endif /* } */
98 
99 /* }================================================================== */
100 
101 
102 /*
103 ** {==================================================================
104 ** Configuration for 'tmpnam':
105 ** By default, Lua uses tmpnam except when POSIX is available, where
106 ** it uses mkstemp.
107 ** ===================================================================
108 */
109 #if !defined(lua_tmpnam) /* { */
110 
111 #if defined(LUA_USE_POSIX) /* { */
112 
113 #include <unistd.h>
114 
115 #define LUA_TMPNAMBUFSIZE 32
116 
117 #if !defined(LUA_TMPNAMTEMPLATE)
118 #define LUA_TMPNAMTEMPLATE "/tmp/lua_XXXXXX"
119 #endif
120 
121 #define lua_tmpnam(b,e) { \
122  strcpy(b, LUA_TMPNAMTEMPLATE); \
123  e = mkstemp(b); \
124  if (e != -1) close(e); \
125  e = (e == -1); }
126 
127 #else /* }{ */
128 
129 /* ISO C definitions */
130 #define LUA_TMPNAMBUFSIZE L_tmpnam
131 #define lua_tmpnam(b,e) { e = (tmpnam(b) == NULL); }
132 
133 #endif /* } */
134 
135 #endif /* } */
136 /* }================================================================== */
137 
138 
139 
140 
141 static int os_execute (lua_State *L) {
142  const char *cmd = luaL_optstring(L, 1, NULL);
143  int stat = system(cmd);
144  if (cmd != NULL)
145  return luaL_execresult(L, stat);
146  else {
147  lua_pushboolean(L, stat); /* true if there is a shell */
148  return 1;
149  }
150 }
151 
152 
153 static int os_remove (lua_State *L) {
154  const char *filename = luaL_checkstring(L, 1);
155  return luaL_fileresult(L, remove(filename) == 0, filename);
156 }
157 
158 
159 static int os_rename (lua_State *L) {
160  const char *fromname = luaL_checkstring(L, 1);
161  const char *toname = luaL_checkstring(L, 2);
162  return luaL_fileresult(L, rename(fromname, toname) == 0, NULL);
163 }
164 
165 
166 static int os_tmpname (lua_State *L) {
167  char buff[LUA_TMPNAMBUFSIZE];
168  int err;
169  lua_tmpnam(buff, err);
170  if (err)
171  return luaL_error(L, "unable to generate a unique filename");
172  lua_pushstring(L, buff);
173  return 1;
174 }
175 
176 
177 static int os_getenv (lua_State *L) {
178  lua_pushstring(L, getenv(luaL_checkstring(L, 1))); /* if NULL push nil */
179  return 1;
180 }
181 
182 
183 static int os_clock (lua_State *L) {
184  lua_pushnumber(L, ((lua_Number)clock())/(lua_Number)CLOCKS_PER_SEC);
185  return 1;
186 }
187 
188 
189 /*
190 ** {======================================================
191 ** Time/Date operations
192 ** { year=%Y, month=%m, day=%d, hour=%H, min=%M, sec=%S,
193 ** wday=%w+1, yday=%j, isdst=? }
194 ** =======================================================
195 */
196 
197 static void setfield (lua_State *L, const char *key, int value) {
198  lua_pushinteger(L, value);
199  lua_setfield(L, -2, key);
200 }
201 
202 static void setboolfield (lua_State *L, const char *key, int value) {
203  if (value < 0) /* undefined? */
204  return; /* does not set field */
205  lua_pushboolean(L, value);
206  lua_setfield(L, -2, key);
207 }
208 
209 
210 /*
211 ** Set all fields from structure 'tm' in the table on top of the stack
212 */
213 static void setallfields (lua_State *L, struct tm *stm) {
214  setfield(L, "sec", stm->tm_sec);
215  setfield(L, "min", stm->tm_min);
216  setfield(L, "hour", stm->tm_hour);
217  setfield(L, "day", stm->tm_mday);
218  setfield(L, "month", stm->tm_mon + 1);
219  setfield(L, "year", stm->tm_year + 1900);
220  setfield(L, "wday", stm->tm_wday + 1);
221  setfield(L, "yday", stm->tm_yday + 1);
222  setboolfield(L, "isdst", stm->tm_isdst);
223 }
224 
225 
226 static int getboolfield (lua_State *L, const char *key) {
227  int res;
228  res = (lua_getfield(L, -1, key) == LUA_TNIL) ? -1 : lua_toboolean(L, -1);
229  lua_pop(L, 1);
230  return res;
231 }
232 
233 
234 /* maximum value for date fields (to avoid arithmetic overflows with 'int') */
235 #if !defined(L_MAXDATEFIELD)
236 #define L_MAXDATEFIELD (INT_MAX / 2)
237 #endif
238 
239 static int getfield (lua_State *L, const char *key, int d, int delta) {
240  int isnum;
241  int t = lua_getfield(L, -1, key); /* get field and its type */
242  lua_Integer res = lua_tointegerx(L, -1, &isnum);
243  if (!isnum) { /* field is not an integer? */
244  if (t != LUA_TNIL) /* some other value? */
245  return luaL_error(L, "field '%s' is not an integer", key);
246  else if (d < 0) /* absent field; no default? */
247  return luaL_error(L, "field '%s' missing in date table", key);
248  res = d;
249  }
250  else {
251  if (!(-L_MAXDATEFIELD <= res && res <= L_MAXDATEFIELD))
252  return luaL_error(L, "field '%s' is out-of-bound", key);
253  res -= delta;
254  }
255  lua_pop(L, 1);
256  return (int)res;
257 }
258 
259 
260 static const char *checkoption (lua_State *L, const char *conv,
261  ptrdiff_t convlen, char *buff) {
262  const char *option = LUA_STRFTIMEOPTIONS;
263  int oplen = 1; /* length of options being checked */
264  for (; *option != '\0' && oplen <= convlen; option += oplen) {
265  if (*option == '|') /* next block? */
266  oplen++; /* will check options with next length (+1) */
267  else if (memcmp(conv, option, oplen) == 0) { /* match? */
268  memcpy(buff, conv, oplen); /* copy valid option to buffer */
269  buff[oplen] = '\0';
270  return conv + oplen; /* return next item */
271  }
272  }
273  luaL_argerror(L, 1,
274  lua_pushfstring(L, "invalid conversion specifier '%%%s'", conv));
275  return conv; /* to avoid warnings */
276 }
277 
278 
279 /* maximum size for an individual 'strftime' item */
280 #define SIZETIMEFMT 250
281 
282 
283 static int os_date (lua_State *L) {
284  size_t slen;
285  const char *s = luaL_optlstring(L, 1, "%c", &slen);
286  time_t t = luaL_opt(L, l_checktime, 2, time(NULL));
287  const char *se = s + slen; /* 's' end */
288  struct tm tmr, *stm;
289  if (*s == '!') { /* UTC? */
290  stm = l_gmtime(&t, &tmr);
291  s++; /* skip '!' */
292  }
293  else
294  stm = l_localtime(&t, &tmr);
295  if (stm == NULL) /* invalid date? */
296  luaL_error(L, "time result cannot be represented in this installation");
297  if (strcmp(s, "*t") == 0) {
298  lua_createtable(L, 0, 9); /* 9 = number of fields */
299  setallfields(L, stm);
300  }
301  else {
302  char cc[4]; /* buffer for individual conversion specifiers */
303  luaL_Buffer b;
304  cc[0] = '%';
305  luaL_buffinit(L, &b);
306  while (s < se) {
307  if (*s != '%') /* not a conversion specifier? */
308  luaL_addchar(&b, *s++);
309  else {
310  size_t reslen;
311  char *buff = luaL_prepbuffsize(&b, SIZETIMEFMT);
312  s++; /* skip '%' */
313  s = checkoption(L, s, se - s, cc + 1); /* copy specifier to 'cc' */
314  reslen = strftime(buff, SIZETIMEFMT, cc, stm);
315  luaL_addsize(&b, reslen);
316  }
317  }
318  luaL_pushresult(&b);
319  }
320  return 1;
321 }
322 
323 
324 static int os_time (lua_State *L) {
325  time_t t;
326  if (lua_isnoneornil(L, 1)) /* called without args? */
327  t = time(NULL); /* get current time */
328  else {
329  struct tm ts;
330  luaL_checktype(L, 1, LUA_TTABLE);
331  lua_settop(L, 1); /* make sure table is at the top */
332  ts.tm_sec = getfield(L, "sec", 0, 0);
333  ts.tm_min = getfield(L, "min", 0, 0);
334  ts.tm_hour = getfield(L, "hour", 12, 0);
335  ts.tm_mday = getfield(L, "day", -1, 0);
336  ts.tm_mon = getfield(L, "month", -1, 1);
337  ts.tm_year = getfield(L, "year", -1, 1900);
338  ts.tm_isdst = getboolfield(L, "isdst");
339  t = mktime(&ts);
340  setallfields(L, &ts); /* update fields with normalized values */
341  }
342  if (t != (time_t)(l_timet)t || t == (time_t)(-1))
343  luaL_error(L, "time result cannot be represented in this installation");
344  l_pushtime(L, t);
345  return 1;
346 }
347 
348 
349 static int os_difftime (lua_State *L) {
350  time_t t1 = l_checktime(L, 1);
351  time_t t2 = l_checktime(L, 2);
352  lua_pushnumber(L, (lua_Number)difftime(t1, t2));
353  return 1;
354 }
355 
356 /* }====================================================== */
357 
358 
359 static int os_setlocale (lua_State *L) {
360  static const int cat[] = {LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY,
361  LC_NUMERIC, LC_TIME};
362  static const char *const catnames[] = {"all", "collate", "ctype", "monetary",
363  "numeric", "time", NULL};
364  const char *l = luaL_optstring(L, 1, NULL);
365  int op = luaL_checkoption(L, 2, "all", catnames);
366  lua_pushstring(L, setlocale(cat[op], l));
367  return 1;
368 }
369 
370 
371 static int os_exit (lua_State *L) {
372  int status;
373  if (lua_isboolean(L, 1))
374  status = (lua_toboolean(L, 1) ? EXIT_SUCCESS : EXIT_FAILURE);
375  else
376  status = (int)luaL_optinteger(L, 1, EXIT_SUCCESS);
377  if (lua_toboolean(L, 2))
378  lua_close(L);
379  if (L) exit(status); /* 'if' to avoid warnings for unreachable 'return' */
380  return 0;
381 }
382 
383 
384 static const luaL_Reg syslib[] = {
385  {"clock", os_clock},
386  {"date", os_date},
387  {"difftime", os_difftime},
388  {"execute", os_execute},
389  {"exit", os_exit},
390  {"getenv", os_getenv},
391  {"remove", os_remove},
392  {"rename", os_rename},
393  {"setlocale", os_setlocale},
394  {"time", os_time},
395  {"tmpname", os_tmpname},
396  {NULL, NULL}
397 };
398 
399 /* }====================================================== */
400 
401 
402 
404  luaL_newlib(L, syslib);
405  return 1;
406 }
407 
#define LUA_STRFTIMEOPTIONS
Definition: loslib.cpp:49
#define luaL_addsize(B, s)
Definition: lauxlib.h:161
#define lua_isnoneornil(L, n)
Definition: lua.h:359
static void setallfields(lua_State *L, struct tm *stm)
Definition: loslib.cpp:213
LUA_API void lua_createtable(lua_State *L, int narray, int nrec)
Definition: lapi.cpp:683
LUA_API void lua_settop(lua_State *L, int idx)
Definition: lapi.cpp:172
LUALIB_API char * luaL_prepbuffsize(luaL_Buffer *B, size_t sz)
Definition: lauxlib.cpp:505
LUA_API void lua_pushboolean(lua_State *L, int b)
Definition: lapi.cpp:556
#define l_pushtime(L, t)
Definition: loslib.cpp:67
LUALIB_API void luaL_pushresult(luaL_Buffer *B)
Definition: lauxlib.cpp:542
static int os_time(lua_State *L)
Definition: loslib.cpp:324
LUALIB_API int luaL_checkoption(lua_State *L, int arg, const char *def, const char *const lst[])
Definition: lauxlib.cpp:348
static int os_execute(lua_State *L)
Definition: loslib.cpp:141
LUALIB_API lua_Integer luaL_optinteger(lua_State *L, int arg, lua_Integer def)
Definition: lauxlib.cpp:440
#define d
#define lua_pop(L, n)
Definition: lua.h:344
#define l_timet
Definition: loslib.cpp:66
#define b
#define l_localtime(t, r)
Definition: loslib.cpp:93
LUALIB_API const char * luaL_optlstring(lua_State *L, int arg, const char *def, size_t *len)
Definition: lauxlib.cpp:397
std::string strftime(const std::string &format, const std::tm *time)
LUA_INTEGER lua_Integer
Definition: lua.h:93
#define l_gmtime(t, r)
Definition: loslib.cpp:92
static int os_tmpname(lua_State *L)
Definition: loslib.cpp:166
LUALIB_API int luaL_argerror(lua_State *L, int arg, const char *extramsg)
Definition: lauxlib.cpp:164
LUAMOD_API int luaopen_os(lua_State *L)
Definition: loslib.cpp:403
LUALIB_API int luaL_fileresult(lua_State *L, int stat, const char *fname)
Definition: lauxlib.cpp:234
static int os_difftime(lua_State *L)
Definition: loslib.cpp:349
#define LUA_TNIL
Definition: lua.h:64
#define luaL_opt(L, f, n, d)
Definition: lauxlib.h:137
LUA_API int lua_toboolean(lua_State *L, int idx)
Definition: lapi.cpp:367
static int getfield(lua_State *L, const char *key, int d, int delta)
Definition: loslib.cpp:239
LUALIB_API void luaL_buffinit(lua_State *L, luaL_Buffer *B)
Definition: lauxlib.cpp:569
static int os_getenv(lua_State *L)
Definition: loslib.cpp:177
static int os_date(lua_State *L)
Definition: loslib.cpp:283
LUA_API void lua_close(lua_State *L)
Definition: lstate.cpp:341
#define luaL_addchar(B, c)
Definition: lauxlib.h:157
LUA_API void lua_pushnumber(lua_State *L, lua_Number n)
Definition: lapi.cpp:458
#define lua_tmpnam(b, e)
Definition: loslib.cpp:131
static map_location::DIRECTION se
static int os_rename(lua_State *L)
Definition: loslib.cpp:159
LUALIB_API void luaL_checktype(lua_State *L, int arg, int t)
Definition: lauxlib.cpp:378
#define lua_isboolean(L, n)
Definition: lua.h:356
static int os_exit(lua_State *L)
Definition: loslib.cpp:371
LUA_API lua_Integer lua_tointegerx(lua_State *L, int idx, int *pisnum)
Definition: lapi.cpp:356
static int os_remove(lua_State *L)
Definition: loslib.cpp:153
static void setboolfield(lua_State *L, const char *key, int value)
Definition: loslib.cpp:202
logger & err()
Definition: log.cpp:79
LUALIB_API lua_Integer luaL_checkinteger(lua_State *L, int arg)
Definition: lauxlib.cpp:430
static map_location::DIRECTION s
#define LUAMOD_API
Definition: luaconf.h:261
#define LUA_TMPNAMBUFSIZE
Definition: loslib.cpp:130
#define L_MAXDATEFIELD
Definition: loslib.cpp:236
static time_t l_checktime(lua_State *L, int arg)
Definition: loslib.cpp:69
#define luaL_newlib(L, l)
Definition: lauxlib.h:119
LUALIB_API int luaL_error(lua_State *L, const char *fmt,...)
Definition: lauxlib.cpp:223
#define luaL_argcheck(L, cond, arg, extramsg)
Definition: lauxlib.h:122
static const char * checkoption(lua_State *L, const char *conv, ptrdiff_t convlen, char *buff)
Definition: loslib.cpp:260
double t
Definition: astarsearch.cpp:64
LUALIB_API int luaL_execresult(lua_State *L, int stat)
Definition: lauxlib.cpp:274
#define SIZETIMEFMT
Definition: loslib.cpp:280
LUA_API const char * lua_pushfstring(lua_State *L, const char *fmt,...)
Definition: lapi.cpp:519
static int os_clock(lua_State *L)
Definition: loslib.cpp:183
LUA_API int lua_getfield(lua_State *L, int idx, const char *k)
Definition: lapi.cpp:621
#define LUA_TTABLE
Definition: lua.h:69
static void setfield(lua_State *L, const char *key, int value)
Definition: loslib.cpp:197
LUA_API void lua_pushinteger(lua_State *L, lua_Integer n)
Definition: lapi.cpp:466
#define luaL_optstring(L, n, d)
Definition: lauxlib.h:125
LUA_NUMBER lua_Number
Definition: lua.h:89
LUA_API const char * lua_pushstring(lua_State *L, const char *s)
Definition: lapi.cpp:491
LUA_API void lua_setfield(lua_State *L, int idx, const char *k)
Definition: lapi.cpp:776
static const luaL_Reg syslib[]
Definition: loslib.cpp:384
static int getboolfield(lua_State *L, const char *key)
Definition: loslib.cpp:226
static int os_setlocale(lua_State *L)
Definition: loslib.cpp:359
#define luaL_checkstring(L, n)
Definition: lauxlib.h:124