update doc

Do not append semicolon to PROMPT_COMMAND

README.md

@@ -458,6 +458,12 @@ As you see, z.lua is the fastest one and requires less resource.
 
 ## History
 
+- 1.7.2 (2019-08-01): Improve bash/zsh shell compatibility by [@barlik](https://github.com/barlik).
+- 1.7.1 (2019-06-07): Fixed: `$_ZL_DATA` failure on Linux sometimes.
+- 1.7.0 (2019-03-09): Support [ranger](https://github.com/skywind3000/z.lua/wiki/FAQ#how-to-integrate-zlua-to-ranger-), fix ReplaceFile issue in luajit (windows).
+- 1.6.0 (2019-03-04): optimize with ffi module (luajit builtin module).
+- 1.5.11 (2019-03-02): fixed: os.path.isdir doesn't work for symbol link folders.
+- 1.5.10 (2019-03-01): Prevent writing file racing.
 - 1.5.9 (2019-02-25): `z -b` should not match current directory (close #56).
 - 1.5.8 (2019-02-21): new `$_ZL_FZF_HEIGHT` to control `--height` parameter in fzf.
 - 1.5.7 (2019-02-21): rename `$_ZL_FZF_SORT` to `$_ZL_INT_SORT` it will affect both `-i` and `-I`.
@@ -492,6 +498,7 @@ As you see, z.lua is the fastest one and requires less resource.
 
 This project needs help for the tasks below:
 
+- [ ] Support csh/tcsh.
 - [ ] Completion: Actually I got little knowledge in completion, and need help to improve it.
 - [ ] Completion: Implement completion for Power Shell.
 - [ ] Completion: Implement completion for different arguments.

ranger_zlua.py

@@ -0,0 +1,91 @@
+import time, sys, os
+import ranger.api
+import subprocess
+
+old_hook_init = ranger.api.hook_init
+
+PATH_LUA = os.environ.get('RANGER_LUA')
+PATH_ZLUA = os.environ.get('RANGER_ZLUA')
+
+if not PATH_LUA:
+    for path in os.environ.get('PATH', '').split(os.path.pathsep):
+        for name in ('lua', 'luajit', 'lua5.3', 'lua5.2', 'lua5.1'):
+            test = os.path.join(path, name)
+            test = test + (sys.platform[:3] == 'win' and ".exe" or "")
+            if os.path.exists(test):
+                PATH_LUA = test
+                break
+
+if not PATH_LUA:
+    sys.stderr.write('Please install lua or set $RANGER_LUA.\n')
+    sys.exit()
+
+if (not PATH_ZLUA) or (not os.path.exists(PATH_ZLUA)):
+    sys.stderr.write('Not find z.lua, please set $RANGER_ZLUA to absolute path of z.lua.\n')
+    sys.exit()
+
+            
+def hook_init(fm):
+    def update_zlua(signal):
+        import os, random
+        os.environ['_ZL_RANDOM'] = str(random.randint(0, 0x7fffffff))
+        p = subprocess.Popen([PATH_LUA, PATH_ZLUA, "--add", signal.new.path])
+        p.wait()
+    if PATH_ZLUA and PATH_LUA and os.path.exists(PATH_ZLUA):
+        fm.signal_bind('cd', update_zlua)
+    return old_hook_init(fm)
+
+ranger.api.hook_init = hook_init
+
+class z(ranger.api.commands.Command):
+    def execute (self):
+        import sys, os, time
+        args = self.args[1:]
+        if args:
+            mode = ''
+            for arg in args:
+                if arg in ('-l', '-e', '-x', '-h', '--help', '--'):
+                    mode = arg
+                    break
+                elif arg in ('-I', '-i'):
+                    mode = arg
+                elif arg[:1] != '-':
+                    break
+            if mode:
+                cmd = '"%s" "%s" '%(PATH_LUA, PATH_ZLUA)
+                if mode in ('-I', '-i', '--'):
+                    cmd += ' --cd'
+                for arg in args:
+                    cmd += ' "%s"'%arg
+                if mode in ('-e', '-x'):
+                    path = subprocess.check_output([PATH_LUA, PATH_ZLUA, '--cd'] + args)
+                    path = path.decode("utf-8", "ignore")
+                    path = path.rstrip('\n')
+                    self.fm.notify(path)
+                elif mode in ('-h', '-l', '--help'):
+                    p = self.fm.execute_command(cmd + '| less +G', universal_newlines=True)
+                    stdout, stderr = p.communicate()
+                elif mode == '--':
+                    p = self.fm.execute_command(cmd + ' 2>&1 | less +G', universal_newlines=True)
+                    stdout, stderr = p.communicate()
+                else:
+                    if mode == '-I':
+                        os.environ['_ZL_FZF_HEIGHT'] = '0'
+                        path = subprocess.check_output([PATH_LUA, PATH_ZLUA, '--cd'] + args)
+                        self.fm.execute_console('redraw_window')
+                    else:
+                        p = self.fm.execute_command(cmd, universal_newlines=True, stdout=subprocess.PIPE)
+                        stdout, stderr = p.communicate()
+                        path = stdout.rstrip('\n')
+                    if path and os.path.exists(path):
+                        self.fm.cd(path)
+            else:
+                path = subprocess.check_output([PATH_LUA, PATH_ZLUA, '--cd'] + args)
+                path = path.decode("utf-8", "ignore")
+                path = path.rstrip('\n')
+                if path and os.path.exists(path):
+                    self.fm.cd(path)
+                else:
+                    self.fm.notify('No matching found', bad = True)
+        return True
+

z.lua

@@ -4,7 +4,7 @@
 -- z.lua - a cd command that learns, by skywind 2018, 2019
 -- Licensed under MIT license.
 --
--- Version 1.5.9, Last Modified: 2019/02/25 23:17
+-- Version 1.7.2, Last Modified: 2019/08/01 19:45
 --
 -- * 10x faster than fasd and autojump, 3x faster than z.sh
 -- * available for posix shells: bash, zsh, sh, ash, dash, busybox
@@ -302,10 +302,107 @@ function os.log(text)
 end
 
 
+-----------------------------------------------------------------------
+-- ffi optimize (luajit has builtin ffi module)
+-----------------------------------------------------------------------
+os.native = {}
+os.native.status, os.native.ffi =  pcall(require, "ffi")
+if os.native.status then
+	local ffi = os.native.ffi
+	if windows then
+		ffi.cdef[[
+		int GetFullPathNameA(const char *name, uint32_t size, char *out, char **name);
+		int ReplaceFileA(const char *dstname, const char *srcname, void *, uint32_t, void *, void *);
+		uint32_t GetTickCount(void);
+		uint32_t GetFileAttributesA(const char *name);
+		uint32_t GetCurrentDirectoryA(uint32_t size, char *ptr);
+		]]
+		local kernel32 = ffi.load('kernel32.dll')
+		local buffer = ffi.new('char[?]', 300)
+		local INVALID_FILE_ATTRIBUTES = 0xffffffff
+		local FILE_ATTRIBUTE_DIRECTORY = 0x10
+		os.native.kernel32 = kernel32
+		function os.native.GetFullPathName(name)
+			local hr = kernel32.GetFullPathNameA(name, 290, buffer, nil)
+			return (hr > 0) and ffi.string(buffer, hr) or nil
+		end
+		function os.native.ReplaceFile(replaced, replacement)
+			local hr = kernel32.ReplaceFileA(replaced, replacement, nil, 2, nil, nil)
+			return (hr ~= 0) and true or false
+		end
+		function os.native.GetTickCount()
+			return kernel32.GetTickCount()
+		end
+		function os.native.GetFileAttributes(name)
+			return kernel32.GetFileAttributesA(name)
+		end
+		function os.native.exists(name)
+			local attr = os.native.GetFileAttributes(name)
+			return attr ~= INVALID_FILE_ATTRIBUTES
+		end
+		function os.native.isdir(name)
+			local attr = os.native.GetFileAttributes(name)
+			local isdir = FILE_ATTRIBUTE_DIRECTORY
+			if attr == INVALID_FILE_ATTRIBUTES then
+				return false
+			end
+			return (attr % (2 * isdir)) >= isdir
+		end
+		function os.native.getcwd()
+			local hr = kernel32.GetCurrentDirectoryA(299, buffer)
+			if hr <= 0 then return nil end
+			return ffi.string(buffer, hr)
+		end
+	else
+		ffi.cdef[[
+		typedef struct { long tv_sec; long tv_usec; } timeval;
+		int gettimeofday(timeval *tv, void *tz);
+		int access(const char *name, int mode);
+		char *realpath(const char *path, char *resolve);
+		char *getcwd(char *buf, size_t size);
+		]]
+		local timeval = ffi.new('timeval[?]', 1)
+		local buffer = ffi.new('char[?]', 4100)
+		function os.native.gettimeofday()
+			local hr = ffi.C.gettimeofday(timeval, nil)
+			local sec = tonumber(timeval[0].tv_sec)
+			local usec = tonumber(timeval[0].tv_usec)
+			return sec + (usec * 0.000001)
+		end
+		function os.native.access(name, mode)
+			return ffi.C.access(name, mode)
+		end
+		function os.native.realpath(name)
+			local path = ffi.C.realpath(name, buffer)
+			return (path ~= nil) and ffi.string(buffer) or nil
+		end
+		function os.native.getcwd()
+			local hr = ffi.C.getcwd(buffer, 4099)
+			return hr ~= nil and ffi.string(buffer) or nil
+		end
+	end
+	function os.native.tickcount() 
+		if windows then
+			return os.native.GetTickCount()
+		else
+			return math.floor(os.native.gettimeofday() * 1000)
+		end
+	end
+	os.native.init = true
+end
+
+
 -----------------------------------------------------------------------
 -- get current path
 -----------------------------------------------------------------------
 function os.pwd()
+	if os.native and os.native.getcwd then
+		local hr = os.native.getcwd()
+		if hr then return hr end
+	end
+	if os.getcwd then
+		return os.getcwd()
+	end
 	if windows then
 		local fp = io.popen('cd')
 		if fp == nil then
@@ -372,6 +469,10 @@ end
 -----------------------------------------------------------------------
 function os.path.abspath(path)
 	if path == '' then path = '.' end
+	if os.native and os.native.GetFullPathName then
+		local test = os.native.GetFullPathName(path)
+		if test then return test end
+	end
 	if windows then
 		local script = 'FOR /f "delims=" %%i IN ("%s") DO @echo %%~fi'
 		local script = string.format(script, path)
@@ -427,13 +528,17 @@ function os.path.isdir(pathname)
 	elseif windows then
 		if pathname == '\\' then
 			return true
-		elseif pathname:match('^%a:[/\\]$') then
-			return true
 		end
 	end
+	if os.native and os.native.isdir then
+		return os.native.isdir(pathname)
+	end
+	if clink and os.isdir then
+		return os.isdir(pathname)
+	end
 	local name = pathname
 	if (not name:endswith('/')) and (not name:endswith('\\')) then
-		name = name .. '/'
+		name = name .. os.path.sep
 	end
 	return os.path.exists(name)
 end
@@ -453,6 +558,12 @@ function os.path.exists(name)
 				io.close(f)
 				return true
 			end
+		elseif name:sub(-1) == '/' and code == 20 and (not windows) then
+			local test = name .. '.'
+			ok, err, code = os.rename(test, test)
+			if code == 16 or code == 13 or code == 22 then
+				return true
+			end
 		end
 		return false
 	end
@@ -867,6 +978,9 @@ function math.random_init()
 		seed = seed .. rnd
 	end
 	seed = seed .. tostring(os.clock() * 10000000)
+	if os.native and os.native.tickcount then
+		seed = seed .. tostring(os.native.tickcount())
+	end
 	local number = 0
 	for i = 1, seed:len() do
 		local k = string.byte(seed:sub(i, i))
@@ -956,15 +1070,29 @@ function data_save(filename, M)
 	local tmpname = nil
 	local i
 	filename = os.path.expand(filename)
-	if windows then
-		fp = io.open(filename, 'w')
-	else
-		math.random_init()
+	math.random_init()
+	while true do
 		tmpname = filename .. '.' .. tostring(os.time())
-		tmpname = tmpname .. math.random_string(8)
-		local rnd = os.getenv('_ZL_RANDOM')
-		tmpname = tmpname .. '' .. (rnd and rnd or '')
-		-- print('tmpname: '..tmpname)
+		if os.native and os.native.tickcount then
+			local key = os.native.tickcount() % 1000
+			tmpname = tmpname .. string.format('%03d', key)
+			tmpname = tmpname .. math.random_string(5)
+		else
+			tmpname = tmpname .. math.random_string(8)
+		end
+		if not os.path.exists(tmpname) then
+			-- print('tmpname: '..tmpname)
+			break
+		end
+	end
+	if windows then
+		if os.native and os.native.ReplaceFile then
+			fp = io.open(tmpname, 'w')
+		else
+			fp = io.open(filename, 'w')
+			tmpname = nil
+		end
+	else
 		fp = io.open(tmpname, 'w')
 	end
 	if fp == nil then
@@ -977,7 +1105,14 @@ function data_save(filename, M)
 	end
 	fp:close()
 	if tmpname ~= nil then
-		os.rename(tmpname, filename)
+		if windows then
+			local ok, err, code = os.rename(tmpname, filename)
+			if not ok then
+				os.native.ReplaceFile(filename, tmpname)
+			end
+		else
+			os.rename(tmpname, filename)
+		end
 		os.remove(tmpname)
 	end
 	return true
@@ -1734,11 +1869,8 @@ function z_init()
 			DATA_FILE = _zl_data
 		else
 			-- avoid windows environments affect cygwin & msys
-			if _zl_data:sub(2, 2) ~= ':' then
-				local t = _zl_data:sub(3, 3)
-				if t ~= '/' and t ~= "\\" then
-					DATA_FILE = _zl_data
-				end
+			if not string.match(_zl_data, '^%a:[/\\]') then
+				DATA_FILE = _zl_data
 			end
 		end
 	end
@@ -1878,14 +2010,14 @@ alias ${_ZL_CMD:-z}='_zlua'
 local script_init_bash = [[
 case "$PROMPT_COMMAND" in
 	*_zlua?--add*) ;;
-	*) PROMPT_COMMAND="(_zlua --add \"\$(command pwd 2>/dev/null)\" &);$PROMPT_COMMAND" ;;
+	*) PROMPT_COMMAND="(_zlua --add \"\$(command pwd 2>/dev/null)\" &)${PROMPT_COMMAND:+;$PROMPT_COMMAND}" ;;
 esac
 ]]
 
 local script_init_bash_fast = [[
 case "$PROMPT_COMMAND" in
 	*_zlua?--add*) ;;
-	*) PROMPT_COMMAND="(_zlua --add \"\$PWD\" &);$PROMPT_COMMAND" ;;
+	*) PROMPT_COMMAND="(_zlua --add \"\$PWD\" &)${PROMPT_COMMAND:+;$PROMPT_COMMAND}" ;;
 esac
 ]]
 
@@ -1897,7 +2029,7 @@ _zlua_precmd() {
 }
 case "$PROMPT_COMMAND" in
 	*_zlua_precmd*) ;;
-	*) PROMPT_COMMAND="_zlua_precmd;$PROMPT_COMMAND" ;;
+	*) PROMPT_COMMAND="_zlua_precmd${PROMPT_COMMAND:+;$PROMPT_COMMAND}" ;;
 esac
 ]]
 
@@ -1924,7 +2056,7 @@ local script_init_zsh = [[
 _zlua_precmd() {
 	(_zlua --add "${PWD:a}" &)
 }
-typeset -gaU precmd_functions
+typeset -ga precmd_functions
 [ -n "${precmd_functions[(r)_zlua_precmd]}" ] || {
 	precmd_functions[$(($#precmd_functions+1))]=_zlua_precmd
 }
@@ -1934,7 +2066,7 @@ local script_init_zsh_once = [[
 _zlua_precmd() {
 	(_zlua --add "${PWD:a}" &)
 }
-typeset -gaU chpwd_functions
+typeset -ga chpwd_functions
 [ -n "${chpwd_functions[(r)_zlua_precmd]}" ] || {
 	chpwd_functions[$(($#chpwd_functions+1))]=_zlua_precmd
 }