https://github.com/alexanderschuetz97/lualfs
luaLFS is library compatible to LuaFileSystem using linux system commands instead of native libraries
https://github.com/alexanderschuetz97/lualfs
Last synced: about 2 months ago
JSON representation
luaLFS is library compatible to LuaFileSystem using linux system commands instead of native libraries
- Host: GitHub
- URL: https://github.com/alexanderschuetz97/lualfs
- Owner: AlexanderSchuetz97
- License: lgpl-3.0
- Created: 2021-10-09T17:25:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-08T22:01:54.000Z (over 3 years ago)
- Last Synced: 2025-02-03T17:47:02.255Z (4 months ago)
- Language: Lua
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# luaLFS
luaLFS is a library compatible to LuaFileSystem using system commands instead of native c libraries.
The primary focus of this implementation is to provide easy integration of scripts that use lfs/LuaFileSystem in complex environments
where LuaFileSystem cannot be easily installed. This includes but is not limited to Java applications using LuaJ.
If your application/environment has no such constraints then I do not recommend using luaLFS.
Use LuaFileSystem instead: https://github.com/keplerproject/luafilesystem/
## License
luaLFS is released under the GNU Lesser General Public License Version 3.
A copy of the GNU Lesser General Public License Version 3 can be found in the COPYING & COPYING.LESSER files.
## Discontinued
Due to low performance and compatibility issues I have decided to stop working on luaLFS.
Instead of implementing the LuaFileSystem API using system commands I have decided to port LuaFileSystem for LuaJ in Java.
If your use case is LuaJ then I recommend using
https://github.com/AlexanderSchuetz97/LuajLFS
instead. It has much better compatibility than luaLFS.
## Requirements
As implied in the description this library will only work if the operating system provides certain commands.
#### Linux/Unix
The following commands are used by luaLFS on Unix systems:
- pwd (initially to determine work directory)
- bash (by all functions)
- stat (by all functions)
- readlink (by all functions)
- mkdir (by lfs.mkdir)
- rm (by lfs.rmdir)
- ls (by lfs.dir)
- ln (by lfs.link)
- touch (by lfs.touch)
-
#### Windows
The following commands are used by luaLFS on Windows systems:
- cmd (by all functions)
- powershell (by all functions)
- Resolve-Path
- Get-Item
- mklink (by lfs.link)
- Will only work if the system is in developer mode or the process has Admin rights
- rmdir (by lfs.rmdir)
- mkdir (by lfs.mkdir)
## Limitations
The C based LFS implementation by LuaFileSystem should be preferred since it is faster than luaLFS.
The error messages returned by LuaFileSystem and luaLFS are not identical in all cases.
LuaLFS returns stderr/stdout from the system programs it runs when an error occurs
LuaFileSystem returns strerror(errno) from GLIBC.
From all functions that the original LuaFileSystem library offers only the following 3 functions cannot be implemented
using system commands:
- lfs.lock_dir
- lfs.lock
- lfs.unlock
When called these functions will always return nil followed by
"Function 'xxx' not provided by implementation"
C based LFS calls "chdir" when changing the work directory. This changes the work directory of the entire process.
LuaLFS does cannot do this and instead keeps the work directory in a variable separated from the actual work directory of the process.
io.open, os.remove, dofile, loadfile are overwritten to use the work directory from luaLFS.
If your scripts use other functions that rely on the work directory then they will not use the changed
work directory.
## Usage
#### C/C++/Generic Lua:
The only file you need from this repository is "lfs.lua" which is in the "src/main/resources/lualfs" directory.
Download this file and place it next to your script or at your discretion in your lua path.
If you place the lfs.lua file next to your script file then the easiest way to load it
is by running it with "dofile":
````
dofile('lfs.lua')
local lfs = require('lfs')
for file in lfs.dir(".") do
print(file)
end
````
#### Prefer C Based LuaFileSystem and only load luaLFS as a fallback:
luaLFS will first check if a module named 'lfs' is already loaded before doing anything. This allows for preloading c based LuaFileSystem and only using luaLFS as a fallback.
If you want to prefer the c based LFS implementation by LuaFileSystem, then I recommend the following approach:
````
-- this will load c based lfs if installed and ignore the error if not
pcall(require, 'lfs')
-- this will load lfs.lua which is a noop if c based lfs is loaded
-- keep in mind that you have to rename lfs.lua to some other file name
-- otherwise the first require may decide to "load" it instead of c based lfs.
-- You may choose whatever filename you desire except "lfs.lua"
dofile("luaLFS.lua")
-- this will return whichever implemention was actually loaded
local lfs = require('lfs')
for file in lfs.dir(".") do
print(file)
end
````
#### Java/LuaJ:
This will require Java 7 or newer and LuaJ 3.0.1
BCEL is not required.
All scripts have already been precompiled to Java bytecode by LuaJC.
The original lfs.lua is also included and only loaded when Globals.debugLib is set to allow for easier debugging.
Maven:
````
io.github.alexanderschuetz97
lualfs
0.1.2
````
In Java:
````
Globals globals = JsePlatform.standardGlobals();
globals.load(new LuaLFSLib());
//.... (Standart LuaJ from this point)
globals.load(new InputStreamReader(new FileInputStream("test.lua")), "test.lua").call();
````
In test.lua:
````
local lfs = require('lfs')
for file in lfs.dir(".") do
print(file)
end
````
#### How to compile luaLFS for Java
It is recommended to uncomment the maven-gpg-plugin section from the pom.xml
before building. Alternatively you may build it by passing "-Dgpg.skip" as a maven parameter.
If you do not want to run the junit tests then pass "-DskipTests"