Using a default prefix for the Makefile

Corrected a bug on the test script on slow fliesystems due to the reliance on close times

Makefile

@@ -1,28 +1,23 @@
-# $Id: Makefile,v 1.26 2005/06/27 17:06:01 tomas Exp $
+# $Id: Makefile,v 1.30 2007/06/07 01:28:08 tomas Exp $
 
 T= lfs
-V= 1.2
+V= 1.3.0
 CONFIG= ./config
 
 include $(CONFIG)
 
-COMPAT_O= $(COMPAT_DIR)/compat-5.1.o
 SRCS= src/$T.c
-OBJS= src/$T.o $(COMPAT_O)
-
+OBJS= src/$T.o
 
 lib: src/$(LIBNAME)
 
 src/$(LIBNAME): $(OBJS)
 	export MACOSX_DEPLOYMENT_TARGET="10.3"; $(CC) $(CFLAGS) $(LIB_OPTION) -o src/$(LIBNAME) $(OBJS)
 
-$(COMPAT_O): $(COMPAT_DIR)/compat-5.1.c
-	$(CC) -c $(CFLAGS) -o $@ $(COMPAT_DIR)/compat-5.1.c
-
 install: src/$(LIBNAME)
 	mkdir -p $(LUA_LIBDIR)
 	cp src/$(LIBNAME) $(LUA_LIBDIR)
 	cd $(LUA_LIBDIR); ln -f -s $(LIBNAME) $T.so
 
 clean:
-	rm -f src/$(LIBNAME) $(OBJS) $(COMPAT_O)
+	rm -f src/$(LIBNAME) $(OBJS)

Makefile.win

@@ -0,0 +1,24 @@
+# $Id: Makefile.win,v 1.5 2007/08/30 14:38:07 tomas Exp $
+
+T= lfs
+V= 1.3.0
+
+include config.win
+
+SRCS= src\$T.c
+OBJS= src\$T.obj
+
+lib: src\$(LIBNAME)
+
+.c.obj:
+	$(CC) /c /Fo$@ $(CFLAGS) $<
+
+src\$(LIBNAME): $(OBJS)
+	link /dll /def:src\$T.def /out:src\$(LIBNAME) $(OBJS) $(LUA_LIB)
+
+install: src\$(LIBNAME)
+	IF NOT EXIST $(LUA_LIBDIR) mkdir $(LUA_LIBDIR)
+	copy src\$(LIBNAME) $(LUA_LIBDIR)
+
+clean:
+	del src\$(LIBNAME) $(OBJS) src\$T.lib src\$T.exp

README

@@ -0,0 +1,30 @@
+LuaFileSystem - File System Library for Lua
+Copyright 2003-2007 Kepler Project
+http://www.keplerproject.org/luafilesystem
+
+Description
+-----------
+LuaFileSystem is a Lua library developed to complement the set of functions
+related to file systems offered by the standard Lua distribution.
+
+LuaFileSystem offers a portable way to access the underlying directory structure and file attributes.
+LuaFileSystem is free software and uses the same license as Lua 5.1
+
+Current version is 1.3.0
+
+Unix Installation
+-----------------
+To install on Linux/OSX/BSD, please edit the config file and then call
+
+make
+make install
+
+The last step may require root privileges.
+
+Windows Installation
+--------------------
+To install on Windows, please copy lfs.ddl to your package.cpath directory
+
+Documentation
+-------------
+Please check the documentation at /doc/us/ for more information.

config

@@ -1,20 +1,24 @@
 # Installation directories
+
+# Default installation prefix
+PREFIX=/usr/local
+
 # System's libraries directory (where binary libraries are installed)
-LUA_LIBDIR= /usr/local/lib/lua/5.0
+LUA_LIBDIR= $(PREFIX)/lib/lua/5.1
+
 # Lua includes directory
-LUA_INC= /usr/local/include
+LUA_INC= $(PREFIX)/include
 
 # OS dependent
 LIB_OPTION= -shared #for Linux
 #LIB_OPTION= -bundle -undefined dynamic_lookup #for MacOS X
 
 LIBNAME= $T.so.$V
-COMPAT_DIR= ../compat/src
 
 # Compilation directives
-WARN= -O2 -Wall -fPIC -W -Waggregate-return -Wcast-align -Wmissing-prototypes -Wnested-externs -Wshadow -Wwrite-strings
-INCS= -I$(LUA_INC) -I$(COMPAT_DIR)
+WARN= -O2 -Wall -fPIC -W -Waggregate-return -Wcast-align -Wmissing-prototypes -Wnested-externs -Wshadow -Wwrite-strings -pedantic
+INCS= -I$(LUA_INC)
 CFLAGS= $(WARN) $(INCS)
 CC= gcc
 
-# $Id: config,v 1.14 2005/06/24 01:49:16 tomas Exp $
+# $Id: config,v 1.21 2007/10/27 22:42:32 carregal Exp $

config.win

@@ -0,0 +1,17 @@
+# Installation directories
+# System's libraries directory (where binary libraries are installed)
+LUA_LIBDIR= c:\lua5.1
+# Lua includes directory
+LUA_INC= c:\lua5.1\include
+# Lua library
+LUA_LIB= c:\lua5.1\lua5.1.lib
+
+LIBNAME= $T.dll
+
+# Compilation directives
+WARN= /O2
+INCS= /I$(LUA_INC)
+CFLAGS= $(WARN) $(INCS)
+CC= cl
+
+# $Id: config.win,v 1.4 2007/05/18 19:52:59 carregal Exp $

doc/us/examples.html

@@ -39,6 +39,7 @@
 		<li><a href="manual.html">Manual</a>
 			<ul>
 				<li><a href="manual.html#introduction">Introduction</a></li>
+				<li><a href="manual.html#building">Building</a></li>
 				<li><a href="manual.html#installation">Installation</a></li>
 				<li><a href="manual.html#reference">Reference</a></li>
 			</ul>
@@ -92,9 +93,8 @@ attrdir (".")
 </div> <!-- id="main" -->
 
 <div id="about">
-	<p><a href="http://validator.w3.org/check?uri=referer">
-    <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
-	<p><small>$Id: examples.html,v 1.5 2006/03/14 14:07:55 carregal Exp $</small></p>
+	<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
+	<p><small>$Id: examples.html,v 1.7 2007/10/26 21:44:43 carregal Exp $</small></p>
 </div> <!-- id="about" -->
 
 </div> <!-- id="container" -->

doc/us/index.html

@@ -39,6 +39,7 @@
 		<li><a href="manual.html">Manual</a>
 			<ul>
 				<li><a href="manual.html#introduction">Introduction</a></li>
+				<li><a href="manual.html#building">Building</a></li>
 				<li><a href="manual.html#installation">Installation</a></li>
 				<li><a href="manual.html#reference">Reference</a></li>
 			</ul>
@@ -66,32 +67,40 @@ systems offered by the standard Lua distribution.</p>
 the underlying directory structure and file attributes.</p>
 
 <p>LuaFileSystem is free software and uses the same
-<a href="license.html">license</a> as Lua 5.0.</p>
+<a href="license.html">license</a> as Lua 5.1.</p>
 
 <h2><a name="status"></a>Status</h2>
 
-<p>Current version is 1.2. It was developed for Lua 5.0.</p>
-
-<p>Version 1.2 follows the
-<a href="http://www.keplerproject.org/compat">package model</a>
-for Lua 5.1 (see section <a href="manual.html#installation">Installation</a>
-for more details).</p>
-
+<p>Current version is 1.3.0. It was developed for Lua 5.1.</p>
 
 <h2><a name="download"></a>Download</h2>
 
 <p>LuaFileSystem source can be downloaded from its
 <a href="http://luaforge.net/projects/luafilesystem/files">Lua Forge</a>
 page. If you are using
-<a href="http://luabinaries.luaforge.net">LuaBinaries</a> Release 2
-a Windows binary version of LuaFileSystem can also be found at the
-LuaForge page.</p>
-
+<a href="http://luabinaries.luaforge.net">LuaBinaries</a> 5.1.2 a Windows binary
+version of LuaFileSystem can be found at the same LuaForge page.</p>
 
 <h2><a name="history"></a>History</h2>
 
 <dl class="history">
-    <dt><strong>Version 1.2</strong> [15/Mar/2006]</dt>
+    <dt><strong>Version 1.3.0</strong> [26/Oct/2007]</dt>
+    <dd>
+    <ul>
+        <li>added function
+        <a href="manual.html#symlinkattributes"><code>lfs.symlinkattributes</code></a>
+        (works only in non Windows systems).</li>
+    </ul>
+    </dd>
+
+    <dt><strong><a href="http://www.keplerproject.org/luafilesystem/1.2/">Version 1.2.1</a></strong> [08/May/2007]</dt>
+    <dd>
+    <ul>
+        <li>compatible only with Lua 5.1 (Lua 5.0 support was dropped)</li>
+    </ul>
+    </dd>
+
+    <dt><strong><a href="http://www.keplerproject.org/luafilesystem/1.2/">Version 1.2</a></strong> [15/Mar/2006]</dt>
     <dd>
     <ul>
         <li>added optional argument to
@@ -137,9 +146,8 @@ Comments are welcome!</p>
 </div> <!-- id="main" -->
 
 <div id="about">
-	<p><a href="http://validator.w3.org/check?uri=referer">
-    <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
-	<p><small>$Id: index.html,v 1.30 2006/03/15 16:44:04 carregal Exp $</small></p>
+	<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
+	<p><small>$Id: index.html,v 1.37 2007/10/26 21:44:43 carregal Exp $</small></p>
 </div> <!-- id="about" -->
 
 </div> <!-- id="container" -->

doc/us/license.html

@@ -39,6 +39,7 @@
 		<li><a href="manual.html">Manual</a>
 			<ul>
 				<li><a href="manual.html#introduction">Introduction</a></li>
+				<li><a href="manual.html#building">Building</a></li>
 				<li><a href="manual.html#installation">Installation</a></li>
 				<li><a href="manual.html#reference">Reference</a></li>
 			</ul>
@@ -84,7 +85,7 @@ Ierusalimschy, Andr&eacute; Carregal and Tom&aacute;s Guisasola.
 The implementation is not derived from licensed software.</p>
 
 <hr/>
-<p>Copyright &copy; 2004-2006 The Kepler Project.</p>
+<p>Copyright &copy; 2004-2007 Kepler Project.</p>
 
 <p>Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -111,9 +112,8 @@ SOFTWARE.</p>
 </div> <!-- id="main" -->
 
 <div id="about">
-	<p><a href="http://validator.w3.org/check?uri=referer">
-    <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
-	<p><small>$Id: license.html,v 1.9 2006/03/14 14:07:55 carregal Exp $</small></p>
+	<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
+	<p><small>$Id: license.html,v 1.11 2007/10/26 21:44:43 carregal Exp $</small></p>
 </div><!-- id="about" -->
 
 </div><!-- id="container" -->

doc/us/manual.html

@@ -37,6 +37,7 @@
 		<li><strong>Manual</strong>
 			<ul>
 				<li><a href="manual.html#introduction">Introduction</a></li>
+				<li><a href="manual.html#building">Building</a></li>
 				<li><a href="manual.html#installation">Installation</a></li>
 				<li><a href="manual.html#reference">Reference</a></li>
 			</ul>
@@ -63,16 +64,26 @@ systems offered by the standard Lua distribution.</p>
 <p>LuaFileSystem offers a portable way to access
 the underlying directory structure and file attributes.</p>
 
+<h2><a name="building"></a>Building</h2>
+
+<p>
+LuaFileSystem should be built with Lua 5.1 so the language library
+and header files for the target version must be installed properly.
+</p>
+
+<p>
+LuaFileSystem offers a Makefile and a separate configuration file,
+<code>config</code>,
+which should be edited to suit your installation before runnig
+<code>make</code>.
+The file has some definitions like paths to the external libraries,
+compiler options and the like.
+</p>
+
 <h2><a name="installation"></a>Installation</h2>
 
-<p>LuaFileSystem follows the
-<a href="http://www.keplerproject.org/compat/">package model</a>
-for Lua 5.1, therefore it should be "installed". Refer to
-<a href="http://www.keplerproject.org/compat/manual.html#configuration">
-Compat-5.1 configuration</a> section about how to install the compiled
-binary properly.
-The compiled binary should be copied to a directory in your
-<code>LUA_CPATH</code>.</p>
+<p>The LuaFileSystem compiled binary should be copied to a directory in your
+<a href="http://www.lua.org/manual/5.1/manual.html#pdf-package.cpath">C path</a>.</p>
 
 <p>Windows users can use the binary version of LuaFileSystem
 (<code>lfs.dll</code>) available at
@@ -96,7 +107,7 @@ LuaFileSystem offers the following functions:
     The attributes are described as follows;
     attribute <code>mode</code> is a string, all the others are numbers,
     and the time related attributes use the same time reference of
-    <a href="http://www.lua.org/manual/5.0/manual.html#5.7"><code>os.time</code></a>: 
+    <a href="http://www.lua.org/manual/5.1/manual.html#pdf-os.time"><code>os.time</code></a>: 
         <dl>
         <dt><strong><code>dev</code></strong></dt>
         <dd>on Unix systems, this represents the device that the inode resides on. On Windows systems,
@@ -142,6 +153,12 @@ LuaFileSystem offers the following functions:
         <dt><strong><code>blksize</code></strong></dt>
 		<dd>optimal file system I/O blocksize; (Unix only)</dd>
 	    </dl>
+    This function uses <code>stat</code> internally thus if the given
+    <code>filepath</code> is a symbolic link, it is followed (if it points to
+    another link the chain is followed recursively) and the information
+    is about the file it refers to.
+    To obtain information about the link itself, see function
+    <a href="#symlinkattributes">lfs.symlinkattributes</a>.
 	</dd>
 
     <dt><a name="chdir"></a><strong><code>lfs.chdir (path)</code></strong></dt>
@@ -186,13 +203,20 @@ LuaFileSystem offers the following functions:
     Returns <code>true</code> if the operation was successful;
     in case of error, it returns <code>nil</code> plus an error string.</dd>
     
+    <dt><a name="symlinkattributes"></a><strong><code>lfs.symlinkattributes (filepath [, aname])</code></strong></dt>
+    <dd>Identical to <a href="#attributes">lfs.attributes</a> except that
+    it obtains information about the link itself (not the file it refers to).
+    This function is not available in Windows so you may want to make sure that
+    <code>lfs.symlinkattributes</code> exists before using it.
+    </dd>
+
     <dt><a name="touch"></a><strong><code>lfs.touch (filepath [, atime [, mtime]])</code></strong></dt>
     <dd>Set access and modification times of a file. This function is
     a bind to <code>utime</code> function. The first argument is the
     filename, the second argument (<code>atime</code>) is the access time,
     and the third argument (<code>mtime</code>) is the modification time.
     Both times are provided in seconds (which should be generated with
-    Lua standard function <code>os.date</code>).
+    Lua standard function <code>os.time</code>).
     If the modification time is omitted, the access time provided is used;
     if both times are omitted, the current time is used.<br />
     Returns <code>true</code> if the operation was successful;
@@ -215,9 +239,8 @@ LuaFileSystem offers the following functions:
 </div> <!-- id="main" -->
 
 <div id="about">
-	<p><a href="http://validator.w3.org/check?uri=referer">
-    <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
-	<p><small>$Id: manual.html,v 1.30.2.1 2006/03/15 20:30:53 carregal Exp $</small></p>
+	<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
+	<p><small>$Id: manual.html,v 1.37 2007/10/26 21:44:43 carregal Exp $</small></p>
 </div> <!-- id="about" -->
 
 </div> <!-- id="container" -->

src/lfs.c

@@ -1,6 +1,6 @@
 /*
 ** LuaFileSystem
-** Copyright Kepler Project 2004-2006 (http://www.keplerproject.org/luafilesystem)
+** Copyright Kepler Project 2004-2007 (http://www.keplerproject.org/luafilesystem)
 **
 ** File system manipulation library.
 ** This library offers these functions:
@@ -11,10 +11,11 @@
 **   lfs.lock (fh, mode)
 **   lfs.mkdir (path)
 **   lfs.rmdir (path)
+**   lfs.symlinkattributes (filepath [, attributename]) -- thanks to Sam Roberts
 **   lfs.touch (filepath [, atime [, mtime]])
 **   lfs.unlock (fh)
 **
-** $Id: lfs.c,v 1.32 2006/03/14 13:39:38 tomas Exp $
+** $Id: lfs.c,v 1.42 2007/10/26 21:01:07 carregal Exp $
 */
 
 #include <errno.h>
@@ -39,8 +40,6 @@
 #include "lua.h"
 #include "lauxlib.h"
 #include "lualib.h"
-#include "compat-5.1.h"
-
 #include "lfs.h"
 
 /* Define 'strerror' for systems that do not implement it */
@@ -256,6 +255,8 @@ static int remove_dir (lua_State *L) {
 static int dir_iter (lua_State *L) {
 #ifdef _WIN32
 	struct _finddata_t c_file;
+#else
+	struct dirent *entry;
 #endif
 	dir_data *d = (dir_data *)lua_touserdata (L, lua_upvalueindex (1));
 	luaL_argcheck (L, !d->closed, 1, "closed directory");
@@ -281,7 +282,6 @@ static int dir_iter (lua_State *L) {
 		}
 	}
 #else
-	struct dirent *entry;
 	if ((entry = readdir (d->dir)) != NULL) {
 		lua_pushstring (L, entry->d_name);
 		return 1;
@@ -512,14 +512,14 @@ struct _stat_members members[] = {
 };
 
 /*
-** Get file information
+** Get file or symbolic link information
 */
-static int file_info (lua_State *L) {
+static int _file_info_ (lua_State *L, int (*st)(const char*, struct stat*)) {
 	int i;
 	struct stat info;
 	const char *file = luaL_checkstring (L, 1);
 
-	if (stat(file, &info)) {
+	if (st(file, &info)) {
 		lua_pushnil (L);
 		lua_pushfstring (L, "cannot obtain information from file `%s'", file);
 		return 2;
@@ -529,6 +529,7 @@ static int file_info (lua_State *L) {
 		const char *member = lua_tostring (L, 2);
 		if (strcmp (member, "mode") == 0) v = 0;
 #ifndef _WIN32
+		else if (strcmp (member, "blocks")  == 0) v = 11;
 		else if (strcmp (member, "blksize") == 0) v = 12;
 #endif
 		else /* look for member */
@@ -551,18 +552,36 @@ static int file_info (lua_State *L) {
 }
 
 
+/*
+** Get file information using stat.
+*/
+static int file_info (lua_State *L) {
+	return _file_info_ (L, stat);
+}
+
+
+/*
+** Get symbolic link information using lstat.
+*/
+#ifndef _WIN32
+static int link_info (lua_State *L) {
+	return _file_info_ (L, lstat);
+}
+#endif
+
+
 /*
 ** Assumes the table is on top of the stack.
 */
 static void set_info (lua_State *L) {
 	lua_pushliteral (L, "_COPYRIGHT");
-	lua_pushliteral (L, "Copyright (C) 2003-2006 Kepler Project");
+	lua_pushliteral (L, "Copyright (C) 2003-2007 Kepler Project");
 	lua_settable (L, -3);
 	lua_pushliteral (L, "_DESCRIPTION");
 	lua_pushliteral (L, "LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution");
 	lua_settable (L, -3);
 	lua_pushliteral (L, "_VERSION");
-	lua_pushliteral (L, "LuaFileSystem 1.2");
+	lua_pushliteral (L, "LuaFileSystem 1.3.0");
 	lua_settable (L, -3);
 }
 
@@ -575,6 +594,9 @@ static const struct luaL_reg fslib[] = {
 	{"lock", file_lock},
 	{"mkdir", make_dir},
 	{"rmdir", remove_dir},
+#ifndef _WIN32
+	{"symlinkattributes", link_info},
+#endif
 	{"touch", file_utime},
 	{"unlock", file_unlock},
 	{NULL, NULL},
@@ -582,7 +604,7 @@ static const struct luaL_reg fslib[] = {
 
 int luaopen_lfs (lua_State *L) {
 	dir_create_meta (L);
-	luaL_openlib (L, "lfs", fslib, 0);
+	luaL_register (L, "lfs", fslib);
 	set_info (L);
 	return 1;
 }

src/lfs.def

@@ -0,0 +1,5 @@
+LIBRARY lfs.dll
+DESCRIPTION "LuaFileSystem"
+VERSION 1.2.1
+EXPORTS
+luaopen_lfs

tests/test.lua

@@ -1,10 +1,11 @@
-#!/usr/local/bin/lua50
+#!/usr/local/bin/lua5.1
 
 local tmp = "/tmp"
 local sep = "/"
 local upper = ".."
 
 require"lfs"
+print (lfs._VERSION)
 
 function attrdir (path)
 	for file in lfs.dir(path) do
@@ -33,8 +34,17 @@ assert (lfs.currentdir() == current, "error trying to change directories")
 assert (lfs.chdir ("this couldn't be an actual directory") == nil, "could change to a non-existent directory")
 
 -- Changing creating and removing directories
-local tmpdir = tmp..sep.."lfs_tmp_dir"
+local tmpdir = current..sep.."lfs_tmp_dir"
 local tmpfile = tmpdir..sep.."tmp_file"
+-- Test for existence of a previous lfs_tmp_dir
+-- that may have resulted from an interrupted test execution and remove it
+if lfs.chdir (tmpdir) then
+    assert (lfs.chdir (upper), "could not change to upper directory")
+    assert (os.remove (tmpfile), "could not remove file from previous test")    
+    assert (lfs.rmdir (tmpdir), "could not remove directory from previous test")
+end
+
+-- tries to create a directory
 assert (lfs.mkdir (tmpdir), "could not make a new directory")
 local attrib, errmsg = lfs.attributes (tmpdir)
 if not attrib then
@@ -44,19 +54,31 @@ local f = io.open(tmpfile, "w")
 f:close()
 
 -- Change access time
-assert (lfs.touch (tmpfile, 86401))
+local testdate = os.time({ year = 2007, day = 10, month = 2, hour=0})
+assert (lfs.touch (tmpfile, testdate))
 local new_att = assert (lfs.attributes (tmpfile))
-assert (new_att.access == 86401, "could not set access time")
-assert (new_att.modification == 86401, "could not set modification time")
+assert (new_att.access == testdate, "could not set access time")
+assert (new_att.modification == testdate, "could not set modification time")
 
 -- Change access and modification time
-assert (lfs.touch (tmpfile, 86403, 86402))
+local testdate1 = os.time({ year = 2007, day = 10, month = 2, hour=0})
+local testdate2 = os.time({ year = 2007, day = 11, month = 2, hour=0})
+
+assert (lfs.touch (tmpfile, testdate2, testdate1))
 local new_att = assert (lfs.attributes (tmpfile))
-assert (new_att.access == 86403, "could not set access time")
-assert (new_att.modification == 86402, "could not set modification time")
+assert (new_att.access == testdate2, "could not set access time")
+assert (new_att.modification == testdate1, "could not set modification time")
+
+if lfs.symlinkattributes then
+    -- Checking symbolic link information (does not work in Windows)
+    assert (os.execute ("ln -s "..tmpfile.." _a_link_for_test_"))
+    assert (lfs.attributes"_a_link_for_test_".mode == "file")
+    assert (lfs.symlinkattributes"_a_link_for_test_".mode == "link")
+    assert (os.remove"_a_link_for_test_")
+end
 
 -- Restore access time to current value
-assert (lfs.touch (tmpfile))
+assert (lfs.touch (tmpfile, attrib.access, attrib.modification))
 new_att = assert (lfs.attributes (tmpfile))
 assert (new_att.access == attrib.access)
 assert (new_att.modification == attrib.modification)