Author: fperrad
Date: Mon Apr 16 00:17:42 2007
New Revision: 18234
Added:
trunk/languages/lua/lib/lfs.pir (contents, props changed)
trunk/languages/lua/t/lfs.t (contents, props changed)
Modified:
trunk/languages/lua/config/makefiles/root.in
trunk/languages/lua/doc/status.pod
Log:
[Lua]
- add LuaFileSystem library (only doc)
Modified: trunk/languages/lua/config/makefiles/root.in
==============================================================================
--- trunk/languages/lua/config/makefiles/root.in (original)
+++ trunk/languages/lua/config/makefiles/root.in Mon Apr 16 00:17:42 2007
@@ -51,7 +51,8 @@
$(LIBPATH)/luaio.pbc \
$(LIBPATH)/luaos.pbc \
$(LIBPATH)/luadebug.pbc \
- $(LIBPATH)/alarm.pbc
+ $(LIBPATH)/alarm.pbc \
+ $(LIBPATH)/lfs.pbc
GEN_PIR = \
src/lua51_testlex_gen.pir \
@@ -135,6 +136,9 @@
$(LIBPATH)/alarm.pbc: $(LIBPATH)/alarm.pir
$(PARROT) --output=$(LIBPATH)/alarm.pbc $(LIBPATH)/alarm.pir
+$(LIBPATH)/lfs.pbc: $(LIBPATH)/lfs.pir
+ $(PARROT) --output=$(LIBPATH)/lfs.pbc $(LIBPATH)/lfs.pir
+
Lua/parser.pm: Lua/lua51.yp
yapp -s -v -m Lua::parser -o Lua/parser.pm Lua/lua51.yp
Modified: trunk/languages/lua/doc/status.pod
==============================================================================
--- trunk/languages/lua/doc/status.pod (original)
+++ trunk/languages/lua/doc/status.pod Mon Apr 16 00:17:42 2007
@@ -190,6 +190,8 @@
=item * alarm library F<languages/lua/lib/alarm.pir>
+=item * Lua File System library F<languages/lua/lib/lfs.pir>
+
=back
=head1 Next Milestones
Added: trunk/languages/lua/lib/lfs.pir
==============================================================================
--- (empty file)
+++ trunk/languages/lua/lib/lfs.pir Mon Apr 16 00:17:42 2007
@@ -0,0 +1,377 @@
+# Copyright (C) 2007, The Perl Foundation.
+# $Id$
+
+=head1 NAME
+
+lib/lfs.pir - Lua File System Library v1.2
+
+=head1 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.
+
+See original on L<http://luaforge.net/projects/luafilesystem/>
+
+=head2 Functions
+
+=over 4
+
+=cut
+
+.HLL 'Lua', 'lua_group'
+
+.sub '__onload' :anon :load
+# print "__onload lfs\n"
+ .const .Sub entry = 'luaopen_lfs'
+ set_root_global 'luaopen_lfs', entry
+.end
+
+.sub 'luaopen_lfs'
+
+# print "luaopen_lfs\n"
+
+ .local pmc _lua__GLOBAL
+ _lua__GLOBAL = global '_G'
+
+ new $P1, .LuaString
+
+ .local pmc _lfs
+ new _lfs, .LuaTable
+ set $P1, 'lfs'
+ _lua__GLOBAL[$P1] = _lfs
+
+ _register($P1, _lfs)
+
+ .const .Sub _lfs_attributes = '_lfs_attributes'
+ _lfs_attributes.'setfenv'(_lua__GLOBAL)
+ set $P1, 'attributes'
+ _lfs[$P1] = _lfs_attributes
+
+ .const .Sub _lfs_chdir = '_lfs_chdir'
+ _lfs_chdir.'setfenv'(_lua__GLOBAL)
+ set $P1, 'chdir'
+ _lfs[$P1] = _lfs_chdir
+
+ .const .Sub _lfs_currentdir = '_lfs_currentdir'
+ _lfs_currentdir.'setfenv'(_lua__GLOBAL)
+ set $P1, 'currentdir'
+ _lfs[$P1] = _lfs_currentdir
+
+ .const .Sub _lfs_dir = '_lfs_dir'
+ _lfs_dir.'setfenv'(_lua__GLOBAL)
+ set $P1, 'dir'
+ _lfs[$P1] = _lfs_dir
+
+ .const .Sub _lfs_lock = '_lfs_lock'
+ _lfs_lock.'setfenv'(_lua__GLOBAL)
+ set $P1, 'lock'
+ _lfs[$P1] = _lfs_lock
+
+ .const .Sub _lfs_mkdir = '_lfs_mkdir'
+ _lfs_mkdir.'setfenv'(_lua__GLOBAL)
+ set $P1, 'mkdir'
+ _lfs[$P1] = _lfs_mkdir
+
+ .const .Sub _lfs_rmdir = '_lfs_rmdir'
+ _lfs_rmdir.'setfenv'(_lua__GLOBAL)
+ set $P1, 'rmdir'
+ _lfs[$P1] = _lfs_rmdir
+
+ .const .Sub _lfs_touch = '_lfs_touch'
+ _lfs_touch.'setfenv'(_lua__GLOBAL)
+ set $P1, 'touch'
+ _lfs[$P1] = _lfs_touch
+
+ .const .Sub _lfs_unlock = '_lfs_unlock'
+ _lfs_unlock.'setfenv'(_lua__GLOBAL)
+ set $P1, 'unlock'
+ _lfs[$P1] = _lfs_unlock
+
+
+ new $P2, .LuaString
+
+ set $P2, "Copyright (C) 2007, The Perl Foundation"
+ set $P1, "_COPYRIGHT"
+ _lfs[$P1] = $P2
+
+ set $P2, "LuaFileSystem is a Lua library developed to complement the set
of functions related to file systems offered by the standard Lua distribution"
+ set $P1, "_DESCRIPTION"
+ _lfs[$P1] = $P2
+
+ set $P2, "LuaFileSystem 1.2"
+ set $P1, "_VERSION"
+ _lfs[$P1] = $P2
+
+ .return (_lfs)
+.end
+
+.sub 'check_file' :anon
+ .param pmc fh
+ .local pmc ret
+ ret = getattribute fh, 'data'
+ .return (ret)
+.end
+
+=item C<lfs.attributes (filepath [, aname])>
+
+Returns a table with the file attributes corresponding to C<filepath> (or
+C<nil> followed by an error message in case of error). If the second optional
+argument is given, then only the value of the named attribute is returned
+(this use is equivalent to C<lfs.attributes(filepath).aname>, but the table
+is not created and only one attribute is retrieved from the O.S.). The
+attributes are described as follows; attribute C<mode> is a string, all the
+others are numbers, and the time related attributes use the same time
+reference of C<os.time>:
+
+=over 4
+
+=item B<"dev">
+
+on Unix systems, this represents the device that the inode resides on.
+On Windows systems, represents the drive number of the disk containing the file
+
+=item B<"ino">
+
+on Unix systems, this represents the inode number.
+On Windows systems this has no meaning
+
+=item B<"mode">
+
+string representing the associated protection mode (the values could be
+C<file>, C<directory>, C<link>, C<socket>, C<named pipe>, C<char device>,
+C<block device> or C<other>)
+
+=item B<"nlink">
+
+number of hard links to the file
+
+=item B<"uid">
+
+user-id of owner (Unix only, always 0 on Windows)
+
+=item B<"gid">
+
+group-id of owner (Unix only, always 0 on Windows)
+
+=item B<"rdev">
+
+on Unix systems, represents the device type, for special file inodes.
+On Windows systems represents the same as dev
+
+=item B<"access">
+
+time of last access
+
+=item B<"modification">
+
+time of last data modification
+
+=item B<"changes">
+
+time of last file status change
+
+=item B<"size">
+
+file size, in bytes
+
+=item B<"blocks">
+
+block allocated for file; (Unix only)
+
+=item B<"blksize">
+
+optimal file system I/O blocksize; (Unix only)
+
+=back
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_attributes' :anon
+ .param pmc filepath :optional
+ .param pmc aname :optional
+ $S1 = checkstring(filepath)
+ not_implemented()
+.end
+
+
+=item C<lfs.chdir (path)>
+
+Changes the current working directory to the given C<path>.
+
+Returns C<true> in case of success or C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_chdir' :anon
+ .param pmc path :optional
+ $S1 = checkstring(path)
+ not_implemented()
+.end
+
+
+=item C<lfs.currentdir ()>
+
+Returns a string with the current working directory or C<nil> plus an error
+string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_currentdir' :anon
+ not_implemented()
+.end
+
+
+=item C<lfs.dir (path)>
+
+Lua iterator over the entries of a given directory. Each time the iterator is
+called it returns a string with an entry of the directory; C<nil> is returned
+when there is no more entries. Raises an error if C<path> is not a directory.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_dir' :anon
+ .param pmc path :optional
+ $S1 = checkstring(path)
+ not_implemented()
+.end
+
+
+=item C<lfs.lock (filehandle, mode[, start[, length]])>
+
+Locks a file or a part of it. This function works on I<open files>; the file
+handle should be specified as the first argument. The string C<mode> could be
+either C<r> (for a read/shared lock) or C<w> (for a write/exclusive lock).
+The optional arguments C<start> and C<length> can be used to specify a
+starting point and its length; both should be numbers.
+
+Returns C<true> if the operation was successful; in case of error, it returns
+C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_lock' :anon
+ .param pmc filehandle :optional
+ .param pmc mode :optional
+ .param pmc start :optional
+ .param pmc length :optional
+ $P1 = check_file(filehandle)
+ $S2 = checkstring(mode)
+ $I3 = optint(start, 0)
+ $I4 = optint(length, 0)
+ not_implemented()
+.end
+
+
+=item C<lfs.mkdir (dirname)>
+
+Creates a new directory. The argument is the name of the new directory.
+
+Returns C<true> if the operation was successful; in case of error, it returns
+C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_mkdir' :anon
+ .param pmc dirname :optional
+ $S1 = checkstring(dirname)
+ not_implemented()
+.end
+
+
+=item C<lfs.rmdir (dirname)>
+
+Removes an existing directory. The argument is the name of the directory.
+
+Returns C<true> if the operation was successful; in case of error, it returns
+C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_rmdir' :anon
+ .param pmc dirname :optional
+ $S1 = checkstring(dirname)
+ not_implemented()
+.end
+
+
+=item C<lfs.touch (filepath [, atime [, mtime]])>
+
+Set access and modification times of a file. This function is a bind to
+C<utime> function. The first argument is the filename, the second argument
+(C<atime>) is the access time, and the third argument (C<mtime>) is the
+modification time. Both times are provided in seconds (which should be
+generated with Lua standard function C<os.date>). If the modification time is
+omitted, the access time provided is used; if both times are omitted, the
+current time is used.
+
+Returns C<true> if the operation was successful; in case of error, it returns
+C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_touch' :anon
+ .param pmc filepath :optional
+ .param pmc atime :optional
+ .param pmc mtime :optional
+ $S1 = checkstring(filepath)
+ not_implemented()
+.end
+
+
+=item C<lfs.unlock (filehandle[, start[, length]])>
+
+Unlocks a file or a part of it. This function works on I<open files>; the file
+handle should be specified as the first argument. The optional arguments
+C<start> and C<length> can be used to specify a starting point and its length;
+both should be numbers.
+
+Returns C<true> if the operation was successful; in case of error, it returns
+C<nil> plus an error string.
+
+NOT YET IMPLEMENTED.
+
+=cut
+
+.sub '_lfs_unlock' :anon
+ .param pmc filehandle :optional
+ .param pmc start :optional
+ .param pmc length :optional
+ $P1 = check_file(filehandle)
+ $I2 = optint(start, 0)
+ $I3 = optint(length, 0)
+ not_implemented()
+.end
+
+=back
+
+=head1 AUTHORS
+
+Francois Perrad
+
+=cut
+
+
+# Local Variables:
+# mode: pir
+# fill-column: 100
+# End:
+# vim: expandtab shiftwidth=4:
Added: trunk/languages/lua/t/lfs.t
==============================================================================
--- (empty file)
+++ trunk/languages/lua/t/lfs.t Mon Apr 16 00:17:42 2007
@@ -0,0 +1,50 @@
+#! perl
+# Copyright (C) 2007, The Perl Foundation.
+# $Id$
+
+=head1 NAME
+
+t/lfs.t - Lua File System Library
+
+=head1 SYNOPSIS
+
+ % perl -I../lib -Ilua/t lua/t/lfs.t
+
+=head1 DESCRIPTION
+
+Tests Lua File System Library
+(implemented in F<languages/lua/lib/lfs.pir>).
+
+=cut
+
+use strict;
+use warnings;
+use FindBin;
+use lib "$FindBin::Bin";
+
+use Parrot::Test;
+use Test::More;
+
+if ( exists $ENV{PARROT_LUA_TEST_PROG} ) {
+ plan skip_all => "parrot only";
+}
+else {
+ plan tests => 1;
+}
+
+language_output_is( 'lua', << 'CODE', << 'OUTPUT', 'require lfs' );
+require "lfs"
+print(type(lfs))
+print(lfs._VERSION)
+CODE
+table
+LuaFileSystem 1.2
+OUTPUT
+
+# Local Variables:
+# mode: cperl
+# cperl-indent-level: 4
+# fill-column: 100
+# End:
+# vim: expandtab shiftwidth=4:
+
