Initial revision

This commit is contained in:
tomas
2004-07-27 14:15:24 +00:00
commit 8addf14a39
10 changed files with 792 additions and 0 deletions

35
Makefile Normal file
View File

@@ -0,0 +1,35 @@
# $Id: Makefile,v 1.1 2004/07/27 14:15:24 tomas Exp $
T= luafilesystem
include ./config
V= 1.0a
LIBNAME= lib$T.$V$(LIB_EXT)
L= $T.lua
TL= t_$T.lua
SRCS= $T.c
OBJS= $T.o
lib: $(LIBNAME)
$(LIBNAME): $(OBJS) $(TL)
$(CC) $(CFLAGS) $(LIB_OPTION) -o $(LIBNAME) $(OBJS) $(LIBS)
sed -e "s|LIB_NAME|$(LIB_DIR)/$(LIBNAME)|" $(TL) > $L
$(LUA_DIR)/$L: $L
mkdir -p $(LUA_DIR)
cp $L $(LUA_DIR)
install: $(LUA_DIR)/$L $(LIBNAME)
mkdir -p $(LIB_DIR)
cp $(LIBNAME) $(LIB_DIR)
clean:
rm -f $L $(LIBNAME) $(OBJS)
dist:
mkdir -p $(DIST_DIR)
cp config $(SRCS) $T.h $(TL) Makefile $(DIST_DIR)

21
config Normal file
View File

@@ -0,0 +1,21 @@
# Installation directories
# System's libraries directory (where Lua libraries are installed)
LIB_DIR= /usr/local/lib
LUA_DIR= /usr/local/lua
# OS dependent
LIB_EXT= .dylib
#LIB_EXT= .so
LIB_OPTION= -dynamiclib #for MacOS X
#LIB_OPTION= -shared #for Linux
# Compilation directives
# pre-compile and include mod2.lua into mod_lua.c
# On FreeBSD systems, the following line should be commented
DLLIB= -ldl
WARN= -O2 -Wall -fPIC -W -Waggregate-return -Wcast-align -Wmissing-prototypes -Wnested-externs -Wshadow -Wwrite-strings
INCS= -I/usr/local/include/lua5
LIBS= -L$(LIB_DIR) -llua -llualib -lm $(DLLIB)
CFLAGS= $(WARN) $(INCS)
CC= gcc

114
doc/us/index.html Normal file
View File

@@ -0,0 +1,114 @@
<html>
<head>
<title>LuaFileSystem</title>
<style type="text/css">
ul { list-style-type: disc };
</style>
</head>
<body bgcolor="#FFFFFF">
<center>
<table border=0 cellspacing=2 cellpadding=2>
<tr><td align=center><a href="http://www.keplerproject.org">
<img border=0 alt="LuaFileSystem" src="luafilesystem.png"></a>
<tr><td align=center><big><b>LuaFileSystem</b></big>
<tr><td align=center valign=top>File system library for the
<a href="http://www.lua.org">Lua</a>
programming language
</table>
</center>
<p>
<center><small>
<a href="#over">overview</a> &middot;
<a href="#download">download</a> &middot;
<a href="manual.html">manual</a> &middot;
<a href="#credits">credits</a> &middot;
<a href="#contact">contact us</a>
</small></center>
<p>
<hr>
<h2>Contents</h2>
<p>
<ul>
<li> <a href="#over">Overview</a>
<li> <a href="#version">Current Version</a>
<li> <a href="#download">Download</a>
<li> <a href="#manual">Manual</a>
<li> <a href="#credits">Credits</a>
<li> <a href="#contact">Contact us</a>
</ul>
<a name="over"></a>
<h2>Overview</h2>
<p>
LuaFileSystem is a library developed to complement the set of functions
related to file systems offered by the standard Lua distribution.
One of its goals is to be as portable as Lua.
<p>
LuaFileSystem is free software and uses the same
<a href="license.html">license</a>
as Lua 5.0.
<a name="version"></a>
<h2>Current version</h2>
<p>
Current version is 1.0 alpha.
It was developed for Lua 5.0.
</p>
<a name="download"></a>
<h2>Download</h2>
<p>
LuaFileSystem can be downloaded in source code from the following links:
<p>
<ul>
<li><a href="luafilesystem-1.0a.tar.gz">luafilesystem-1.0a.tar.gz</a>.
<li><a href="luafilesystem-1.0a.zip">luafilesystem-1.0a.zip</a>.
</ul>
<a name="new"></a>
<h2>What's new</h2>
<p>
<ul>
<li>[2/Aug/2004] Version 1.0 alpha released
</ul>
<a name="credits"></a>
<h2>Credits</h2>
<p>
LuaFileSystem was designed by Roberto Ierusalimschy,
Andr&eacute; Carregal and Tom&aacute;s Guisasola as part of
<a href="http://www.keplerproject.org">The Kepler Project</a>
which holds its copyright.
</p>
<a name="contact"></a>
<h2>Contact us</h2>
<p>
For more information please
<a href="mailto:tomas-NO-SPAM-THANKS@keplerproject.org">contact us</a>.
Comments are welcome!
</p>
<p>
<hr>
<small>
$Id: index.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
</small>
</body>
</html>

78
doc/us/license.html Normal file
View File

@@ -0,0 +1,78 @@
<! See Copyright Notice at the end of this file>
<HTML>
<HEAD>
<TITLE>LuaFileSystem: license</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<HR>
<H1>
License
</H1>
LuaFileSystem
is free software:
it can be used for both academic and commercial purposes at absolutely no cost.
There are no royalties or GNU-like "copyleft" restrictions.
LuaFileSystem qualifies as
<A HREF="http://www.opensource.org/docs/definition.html">Open Source</A>
software.
Its licenses are compatible with
<A HREF="http://www.gnu.org/licenses/gpl.html">GPL</A>.
LuaFileSystem is not in the public domain and
<a href="http://www.keplerproject.org">The Kepler Project</a>
keep its copyright.
The legal details are below.
<P>
The spirit of the license is that
you are free to use LuaFileSystem for any purpose at no cost without having to ask us.
The only requirement is that
if you do use LuaFileSystem,
then you should give us credit by including the appropriate copyright notice
somewhere in your product or its documentation.
<P>
The LuaFileSystem library is designed and implemented
by
Roberto Ierusalimschy,
Andr&eacute; Carregal and
Tom&aacute;s Guisasola.
The implementation is not derived from licensed software.
<P>
<!-- ===================================================================== -->
<HR>
Copyright &copy; 2004 The Kepler Project.
<P>
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:
<P>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
<P>
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.
<P>
<!-- ===================================================================== -->
<HR>
<SMALL>
$Id: license.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
</SMALL>
</BODY>
</HTML>

144
doc/us/manual.html Normal file
View File

@@ -0,0 +1,144 @@
<! See Copyright Notice in license.html>
<html>
<head>
<title>LuaFileSystem</title>
<style type="text/css">
ul { list-style-type: disc };
</style>
</head>
<body bgcolor="#FFFFFF">
<hr>
<center>
<table border=0 cellspacing=2 cellpadding=2>
<tr><td align=center><a href="http://www.keplerproject.org/luafilesystem">
<img border=0 alt="LuaFileSystem logo" src="luafilesystem.png"></a>
<tr><td align=center><big><b>LuaFileSystem Reference Manual</b></big>
<tr><td align=center valign=top>File system library for the
<a href="http://www.lua.org">Lua</a>
programming language
</table>
</center>
<p>
<center><small>
<a href="index.html">home</a> &middot;
<a href="#introduction">introduction</a> &middot;
<a href="#reference">reference</a> &middot;
<a href="#example">example</a>
</small></center>
<p>
<hr>
<a name="introduction"></a>
<h2>Introduction</h2>
<p>
LuaFileSystem is a <a href="http://www.lua.org">Lua</a> library
developed to complement the set of functions related to file systems offered
by the standard Lua distribution.
<p>
LuaFileSystem is free software and uses the same
<a href="license.html">license</a>
as Lua 5.0.
</p>
<a name="reference"></a>
<h2>Reference</h2>
<p>
LuaFileSystem offers the following functions:
<ul>
<a name="chdir"></a>
<li> <b><tt>luafilesystem.chdir (path)</tt></b> <br>
Changes the current
working directory to the given <tt>path</tt>.
<a name="getcwd"></a>
<li> <b><tt>luafilesystem.currentdir ()</tt></b> <br>
Returns the current
working directory or <code>nil</code> plus an error string.
<a name="dir"></a>
<li> <b><tt>luafilesystem.dir (path)</tt></b> <br>
Lua iterator over the entries
of a given directory.
<a name="lock"></a>
<li> <b><tt>luafilesystem.lock (filehandle, mode[, start[, length]])</tt></b> <br>
Locks a file or a part of it.
This function works on <em>open files</em>;
the file handle should be specified as the first argument.
The string <code>mode</code> could be either <code>r</code> (for a
read/shared lock) or <code>w</code> (for a write/exclusive lock).
The optional arguments <code>start</code> and <code>length</code> can be
used to specify a starting point and its length;
both should be numbers.
This function returns a boolean indicating if the operation was successful;
in case of error, it returns <code>false</code> plus a string describing the
error.
<a name="mkdir"></a>
<li> <b><tt>luafilesystem.mkdir (dirname)</tt></b> <br>
Creates a new directory.
The argument is the name of the new directory.
<a name="unlock"></a>
<li> <b><tt>luafilesystem.unlock (filehandle[, start[, length]])</tt></b> <br>
Unlocks a file or a part of it.
This function works on <em>open files</em>;
the file handle should be specified as the first argument.
The optional arguments <code>start</code> and <code>length</code> can be
used to specify a starting point and its length;
both should be numbers.
This function returns a boolean indicating if the operation was successful;
in case of error, it returns <code>false</code> plus a string describing the
error.
</ul>
<a name="example"></a>
<h2>Example</h2>
<a name="contents"></a>
<h2>Contents</h2>
<p>
<ul>
<li> <a href="#introduction">Introduction</a>
<li> <a href="#reference">Reference</a>
<ul>
<li> <a href="#chdir">chdir</a>
<li> <a href="#currentdir">currentdir</a>
<li> <a href="#dir">dir</a>
<li> <a href="#lock">lock</a>
<li> <a href="#mkdir">mkdir</a>
<li> <a href="#unlock">unlock</a>
</ul>
<li> <a href="#examples">Examples</a>
</ul>
</p>
<p>
<center><small>
<a href="index.html">home</a> &middot;
<a href="#introduction">introduction</a> &middot;
<a href="#reference">reference</a> &middot;
<a href="#example">example</a>
</small></center>
<p>
<hr>
<small>
$Id: manual.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
</small>
</body>
</html>

351
luafilesystem.c Normal file
View File

@@ -0,0 +1,351 @@
/*
** File system manipulation library.
** This library offers these functions:
** luafilesystem.attributes (filepath [, attributename])
** luafilesystem.chdir (path)
** luafilesystem.currentdir ()
** luafilesystem.dir (path)
** luafilesystem.mkdir (path)
** luafilesystem.lock (fh, mode)
** luafilesystem.unlock (fh)
**
** $Id: luafilesystem.c,v 1.1 2004/07/27 14:15:24 tomas Exp $
*/
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#ifdef WIN32
#include <direct.h>
#include <io.h>
#include <sys/locking.h>
#else
#include <unistd.h>
#include <dirent.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#endif
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h>
#include "luafilesystem.h"
/* Define 'strerror' for systems that do not implement it */
#ifdef NO_STRERROR
#define strerror(_) "System unable to describe the error"
#endif
/* Define 'getcwd' for systems that do not implement it */
#ifdef NO_GETCWD
#define getcwd(p,s) NULL
#define getcwd_error "Function 'getcwd' not provided by system"
#else
#define getcwd_error strerror(errno)
#endif
#define DIR_METATABLE "directory metatable"
#define MAX_DIR_LENGTH 1023
#ifdef _WIN32
typedef struct dir_data {
long hFile;
char pattern[MAX_DIR_LENGTH+1];
} dir_data;
#endif
/*
** This function changes the working (current) directory
*/
static int change_dir (lua_State *L) {
const char *path = luaL_checkstring(L, 1);
if (chdir(path))
luaL_error(L,"Unable to change working directory to '%s'\n%s\n",
path, chdir_error);
return 0;
}
/*
** This function returns the current directory
** If unable to get the current directory, it returns nil
** and a string describing the error
*/
static int get_dir (lua_State *L) {
char path[255+2];
if (getcwd(path, 255) == NULL) {
lua_pushnil(L);
lua_pushstring(L, getcwd_error);
return 2;
}
else {
lua_pushstring(L, path);
return 1;
}
}
/*
** Check if the given element on the stack is a file and returns it.
*/
static FILE *check_file (lua_State *L, int idx, const char *funcname) {
FILE **fh = (FILE **)luaL_checkudata (L, idx, "FILE*");
if (fh == NULL) {
luaL_error (L, "%s: not a file", funcname);
return 0;
} else if (*fh == NULL) {
luaL_error (L, "%s: closed file", funcname);
return 0;
} else
return *fh;
}
/*
**
*/
static int _file_lock (lua_State *L, FILE *fh, const char *mode, const long start, long len, const char *funcname) {
int code;
#ifdef WIN32
/* lkmode valid values are:
_LK_LOCK Locks the specified bytes. If the bytes cannot be locked, the program immediately tries again after 1 second. If, after 10 attempts, the bytes cannot be locked, the constant returns an error.
_LK_NBLCK Locks the specified bytes. If the bytes cannot be locked, the constant returns an error.
_LK_NBRLCK Same as _LK_NBLCK.
_LK_RLCK Same as _LK_LOCK.
_LK_UNLCK Unlocks the specified bytes, which must have been previously locked.
Regions should be locked only briefly and should be unlocked before closing a file or exiting the program.
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt__locking.asp
*/
int lkmode;
switch (*mode) {
case 'r': lkmode = _LK_NBLCK; break;
case 'w': lkmode = _LK_NBLCK; break;
case 'u': lkmode = _LK_UNLCK; break;
default : luaL_error (L, "%s: invalid mode", funcname);
}
if (!len) {
fseek (fh, 0L, SEEK_END);
len = ftell (fh);
}
fseek (fh, start, SEEK_SET);
code = _locking (fileno(fh), lkmode, len);
#else
struct flock f;
switch (*mode) {
case 'w': f.l_type = F_WRLCK; break;
case 'r': f.l_type = F_RDLCK; break;
case 'u': f.l_type = F_UNLCK; break;
default : luaL_error (L, "%s: invalid mode", funcname);
}
f.l_whence = SEEK_SET;
f.l_start = (off_t)start;
f.l_len = (off_t)len;
code = fcntl (fileno(fh), F_SETLK, &f);
#endif
return (code != -1);
}
/*
** Locks a file.
** @param #1 File handle.
** @param #2 String with lock mode ('w'rite, 'r'ead).
** @param #3 Number with start position (optional).
** @param #4 Number with length (optional).
*/
static int file_lock (lua_State *L) {
FILE *fh = check_file (L, 1, "lock");
const char *mode = luaL_checkstring (L, 2);
const long start = luaL_optlong (L, 3, 0);
long len = luaL_optlong (L, 4, 0);
if (_file_lock (L, fh, mode, start, len, "lock")) {
lua_pushboolean (L, 1);
return 1;
} else {
lua_pushboolean (L, 0);
lua_pushfstring (L, "%s", strerror(errno));
return 2;
}
}
/*
** Unlocks a file.
** @param #1 File handle.
** @param #2 Number with start position (optional).
** @param #3 Number with length (optional).
*/
static int file_unlock (lua_State *L) {
FILE *fh = check_file (L, 1, "unlock");
const long start = luaL_optlong (L, 2, 0);
long len = luaL_optlong (L, 3, 0);
if (_file_lock (L, fh, "u", start, len, "unlock")) {
lua_pushboolean (L, 1);
return 1;
} else {
lua_pushboolean (L, 0);
lua_pushfstring (L, "%s", strerror(errno));
return 2;
}
}
/*
static void cgilua_sleep( lua_State *L )
{
unsigned int usec = (unsigned int)luaL_check_number( L, 1 );
#ifndef WIN32
sleep( (unsigned int)ceil( usec/1000.0 ));
#else
Sleep( (DWORD)usec );
#endif
}
static void cgilua_filesize( lua_State *L )
{
struct stat info;
char *file = luaL_check_string( L, 1 );
if (stat(file, &info))
{
lua_pushnil( L );
lua_pushstring( L, "Cannot retrieve stat info from file" );
return;
}
lua_pushnumber(L, info.st_size);
}
*/
static int make_dir (lua_State *L) {
const char *path = luaL_checkstring (L, 1);
int fail;
#ifdef WIN32
int oldmask = umask (0);
fail = _mkdir (path);
#else
mode_t oldmask = umask( (mode_t)0 );
fail = mkdir (path, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP |
S_IWGRP | S_IXGRP | S_IROTH | S_IXOTH );
#endif
lua_pushboolean (L, fail);
umask (oldmask);
return 1;
}
/*
** Directory iterator
*/
static int dir_iter (lua_State *L) {
#ifdef _WIN32
dir_data *d = (dir_data *)lua_touserdata (L, lua_upvalueindex (1));
struct _finddata_t c_file;
if (d->hFile == 0L) { /* first entry */
if ((d->hFile = _findfirst (d->pattern, &c_file)) == -1L) {
lua_pushnil (L);
lua_pushstring (L, strerror (errno));
return 2;
} else {
lua_pushstring (L, c_file.name);
return 1;
}
} else { /* next entry */
if (_findnext (d->hFile, &c_file) == -1L)
return 0;
else {
lua_pushstring (L, c_file.name);
return 1;
}
}
#else
DIR *d = *(DIR **) lua_touserdata (L, lua_upvalueindex (1));
struct dirent *entry;
if ((entry = readdir (d)) != NULL) {
lua_pushstring (L, entry->d_name);
return 1;
}
else
return 0;
#endif
}
/*
** Closes directory iterators
*/
static int dir_close (lua_State *L) {
#ifdef _WIN32
dir_data *d = (dir_data *)lua_touserdata (L, 1);
if (d->hFile) {
_findclose (d->hFile);
}
#else
DIR *d = *(DIR **)lua_touserdata (L, 1);
if (d)
closedir (d);
#endif
return 0;
}
/*
** Factory of directory iterators
*/
static int dir_iter_factory (lua_State *L) {
const char *path = luaL_checkstring (L, 1);
#ifdef _WIN32
dir_data *dir = (dir_data *) lua_newuserdata (L, sizeof(dir_data));
dir->hFile = 0L;
if (strlen(path) > MAX_DIR_LENGTH)
luaL_error (L, "path too long: %s", path);
else
sprintf (dir->pattern, "%s/*", path);
luaL_getmetatable (L, DIR_METATABLE);
lua_setmetatable (L, -2);
#else
DIR **d = (DIR **) lua_newuserdata (L, sizeof(DIR *));
luaL_getmetatable (L, DIR_METATABLE);
lua_setmetatable (L, -2);
*d = opendir (path);
if (*d == NULL)
luaL_error (L, "cannot open %s: %s", path, strerror (errno));
#endif
lua_pushcclosure (L, dir_iter, 1);
return 1;
}
/*
** Creates directory metatable.
*/
static int dir_create_meta (lua_State *L) {
luaL_newmetatable (L, DIR_METATABLE);
/* set its __gc field */
lua_pushstring (L, "__gc");
lua_pushcfunction (L, dir_close);
lua_settable (L, -3);
return 1;
}
static const struct luaL_reg fslib[] = {
{"chdir", change_dir},
{"currentdir", get_dir},
{"dir", dir_iter_factory},
{"lock", file_lock},
{"mkdir", make_dir},
{"unlock", file_unlock},
{NULL, NULL},
};
int luaopen_luafilesystem (lua_State *L) {
dir_create_meta (L);
luaL_openlib (L, "luafilesystem", fslib, 0);
return 1;
}

5
luafilesystem.def Normal file
View File

@@ -0,0 +1,5 @@
LIBRARY luafilesystem.dll
DESCRIPTION "LuaFilesystem"
VERSION 1.0
EXPORTS
luaopen_luafilesystem

10
luafilesystem.h Normal file
View File

@@ -0,0 +1,10 @@
/* Define 'chdir' for systems that do not implement it */
/* $Id: luafilesystem.h,v 1.1 2004/07/27 14:15:24 tomas Exp $ */
#ifdef NO_CHDIR
#define chdir(p) (-1)
#define chdir_error "Function 'chdir' not provided by system"
#else
#define chdir_error strerror(errno)
#endif
int luaopen_filesystem (lua_State *L);

8
t_luafilesystem.lua Normal file
View File

@@ -0,0 +1,8 @@
-- $Id: t_luafilesystem.lua,v 1.1 2004/07/27 14:15:24 tomas Exp $
if not luafilesystem and loadlib then
local libname = "LIB_NAME"
local libopen = "luaopen_luafilesystem"
local init, err1, err2 = loadlib (libname, libopen)
assert (init, (err1 or '')..(err2 or ''))
init ()
end

26
teste.lua Normal file
View File

@@ -0,0 +1,26 @@
#!/usr/local/bin/lua -i
require"luafilesystem"
print(luafilesystem.version)
function p ()
local fh = assert (io.open ("teste", 'r'))
assert (luafilesystem.lock (fh, 'r'))
print (fh:read"*a")
fh:close ()
end
function wr ()
fh = assert (io.open ("teste", 'w'))
assert (luafilesystem.lock (fh, 'w'))
end
function op ()
fh = assert (io.open ("teste", 'r'))
assert (luafilesystem.lock (fh, 'r'))
end
function fw (x)
assert (fh:write (x))
end