Merge ff9376cb93 into 09d8992289

.gitattributes

@@ -0,0 +1,2 @@
+# Ensure batch files are crlf
+*.bat text eol=crlf

README.md

@@ -64,7 +64,7 @@ INSTALLATION
 ### REQUIREMENTS
 
 -   Python v2.6+
--   Bash v4.0+, zsh, or fish
+-   Bash v4.0+, zsh, fish or clink (Windows)
 
 ### AUTOMATIC
 
@@ -106,6 +106,12 @@ Run the installation script and follow on screen instructions.
     cd autojump
     ./install.py or ./uinstall.py
 
+## Windows
+
+Windows support is enabled by [clink](https://code.google.com/p/clink/) which should be installed prior to installing autojump.
+
+Completion support on windows has not yet been added.
+
 KNOWN ISSUES
 ------------
 

bin/autojump

@@ -50,6 +50,7 @@ from autojump_utils import get_tab_entry_info
 from autojump_utils import get_pwd
 from autojump_utils import has_uppercase
 from autojump_utils import is_osx
+from autojump_utils import is_windows
 from autojump_utils import last
 from autojump_utils import print_entry
 from autojump_utils import print_local
@@ -72,6 +73,10 @@ def set_defaults():
                         os.path.expanduser('~'),
                         'Library',
                         'autojump')
+    elif is_windows():
+        data_home = os.path.join(
+                        os.getenv('APPDATA'),
+                        'autojump')
     else:
         data_home = os.getenv(
                 'XDG_DATA_HOME',
@@ -258,13 +263,13 @@ def match_consecutive(needles, haystack, ignore_case=False):
             (path="/moo/foo/baz", weight=10),
             (path="/foo/baz", weight=10)]
     """
-    regex_no_sep = '[^' + os.sep + ']*'
+    sep = os.sep.replace('\\','\\\\')
-    regex_one_sep = regex_no_sep + os.sep + regex_no_sep
+    regex_no_sep = '[^' + sep + ']*'
+    regex_one_sep = regex_no_sep + sep + regex_no_sep
     regex_no_sep_end = regex_no_sep + '$'
     # can't use compiled regex because of flags
     regex_needle = regex_one_sep.join(needles) + regex_no_sep_end
     regex_flags = re.IGNORECASE | re.UNICODE if ignore_case else re.UNICODE
-
     found = lambda entry: re.search(
             regex_needle,
             entry.path,
@@ -336,7 +341,6 @@ def print_stats(data, data_path):
 
 def main(args):  # noqa
     config = set_defaults()
-
     # all arguments are mutually exclusive
     if args.add:
         save(config, first(add_path(load(config), args.add)))

bin/autojump.bat

@@ -0,0 +1,2 @@
+@echo off
+python %~dp0\autojump %*

bin/autojump.lua

@@ -0,0 +1,19 @@
+local AUTOJUMP_BIN = (AUTOJUMP_BIN_DIR or clink.get_env("LOCALAPPDATA") .. "\\autojump\\bin") .. "\\autojump"
+
+function autojump_add_to_database() 
+  os.execute("python " .. AUTOJUMP_BIN .. " --add " .. clink.get_cwd() .. " 2> " .. clink.get_env("TEMP") .. "\\autojump_error.txt")
+end
+
+clink.prompt.register_filter(autojump_add_to_database, 99)
+
+function autojump_completion(word)
+  for line in io.popen("python " .. AUTOJUMP_BIN .. " --complete " .. word):lines() do
+    clink.add_match(line)
+  end
+  return {} 
+end
+
+local autojump_parser = clink.arg.new_parser()
+autojump_parser:set_arguments({ autojump_completion })
+
+clink.arg.register_parser("j", autojump_parser)

bin/j.bat

@@ -0,0 +1,21 @@
+@echo off
+setlocal EnableDelayedExpansion
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  for /f %%i in ('python %~dp0\autojump %*') do set new_path=%%i
+  if exist !new_path!\nul (
+    echo !new_path!
+	pushd !new_path!
+	REM endlocal is necessary so that we can change directory for outside of this script
+	REM but will automatically popd. We mush pushd twice to work around this. 
+	pushd !new_path!
+	endlocal
+	popd
+  ) else (
+    echo autojump: directory %* not found
+    echo try `autojump --help` for more information
+  )
+) else (
+  python %~dp0\autojump %* 
+)

bin/jc.bat

@@ -0,0 +1,8 @@
+@echo off
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  %~dp0\j.bat %cd% %*
+) else (
+  python %~dp0\autojump %* 
+)

bin/jco.bat

@@ -0,0 +1,8 @@
+@echo off
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  %~dp0\jc.bat %cd% %*
+) else (
+  python %~dp0\autojump %* 
+)

bin/jo.bat

@@ -0,0 +1,15 @@
+@echo off
+setlocal EnableDelayedExpansion
+
+echo %*|>nul findstr /rx \-.*
+if ERRORLEVEL 1 (
+  for /f %%i in ('python %~dp0\autojump %*') do set new_path=%%i
+  if exist !new_path!\nul (
+    start !new_path!
+  ) else (
+    echo autojump: directory %* not found
+    echo try `autojump --help` for more information
+  )
+) else (
+  python %~dp0\autojump %* 
+)

install.py

@@ -42,13 +42,27 @@ def modify_autojump_sh(etc_dir, dryrun=False):
         f.write(custom_install)
 
 
+def modify_autojump_lua(clink_dir, bin_dir, dryrun=False):
+    """Prepend custom AUTOJUMP_BIN_DIR definition to autojump.lua"""
+    custom_install = "local AUTOJUMP_BIN_DIR = \"%s\"\n" % bin_dir.replace("\\", "\\\\")
+    clink_file = os.path.join(clink_dir, 'autojump.lua')
+    with open(clink_file, 'r') as f:
+        original = f.read()
+    with open(clink_file, 'w') as f:
+        f.write(custom_install + original)
+
+
 def parse_arguments():
+    if platform.system() == 'Windows':
+        default_user_destdir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'autojump')
+    else:
         default_user_destdir = os.path.join(os.path.expanduser("~"), '.autojump')
     default_user_prefix = ''
     default_user_zshshare = 'functions'
     default_system_destdir = '/'
     default_system_prefix = '/usr/local'
     default_system_zshshare = '/usr/share/zsh/site-functions'
+    default_clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
 
     parser = ArgumentParser(
             description='Installs autojump globally for root users, otherwise \
@@ -68,6 +82,9 @@ def parse_arguments():
     parser.add_argument(
             '-z', '--zshshare', metavar='DIR', default=default_user_zshshare,
             help='set zsh share destination to DIR')
+    parser.add_argument(
+            '-c', '--clinkdir', metavar='DIR', default=default_clink_dir,
+            help='set clink directory location to DIR (Windows only)')
     parser.add_argument(
             '-s', '--system', action="store_true", default=False,
             help='install system wide for all users')
@@ -78,14 +95,18 @@ def parse_arguments():
         if sys.version_info[0] == 2 and sys.version_info[1] < 6:
             print("Python v2.6+ or v3.0+ required.", file=sys.stderr)
             sys.exit(1)
-
+        if args.system:
-        if get_shell() not in SUPPORTED_SHELLS:
+            if platform.system() == 'Windows':
-            print("Unsupported shell: %s" % os.getenv('SHELL'),
+                print("System-wide installation is not supported on Windows.",
+                      file=sys.stderr)
+                sys.exit(1)
+            elif os.geteuid() != 0:
+                print("Please rerun as root for system-wide installation.",
                       file=sys.stderr)
                 sys.exit(1)
 
-        if args.system and os.geteuid() != 0:
+        if platform.system() != 'Windows' and get_shell() not in SUPPORTED_SHELLS:
-            print("Please rerun as root for system-wide installation.",
+            print("Unsupported shell: %s" % os.getenv('SHELL'),
                   file=sys.stderr)
             sys.exit(1)
 
@@ -109,7 +130,10 @@ def parse_arguments():
     return args
 
 
-def print_post_installation_message(etc_dir):
+def print_post_installation_message(etc_dir, bin_dir):
+    if platform.system() == 'Windows':
+        print("\nPlease manually add %s to your user path" % bin_dir)
+    else:
         if get_shell() == 'fish':
             aj_shell = '%s/autojump.fish' % etc_dir
             source_msg = "if test -f %s; . %s; end" % (aj_shell, aj_shell)
@@ -139,33 +163,46 @@ def main(args):
         print("Installing autojump to %s ..." % args.destdir)
 
     bin_dir = os.path.join(args.destdir, args.prefix, 'bin')
-    etc_dir = os.path.join(args.destdir, 'etc/profile.d')
+    etc_dir = os.path.join(args.destdir, 'etc', 'profile.d')
-    doc_dir = os.path.join(args.destdir, args.prefix, 'share/man/man1')
+    doc_dir = os.path.join(args.destdir, args.prefix, 'share', 'man', 'man1')
-    icon_dir = os.path.join(args.destdir, args.prefix, 'share/autojump')
+    icon_dir = os.path.join(args.destdir, args.prefix, 'share', 'autojump')
     zshshare_dir = os.path.join(args.destdir, args.zshshare)
 
     mkdir(bin_dir, args.dryrun)
-    mkdir(etc_dir, args.dryrun)
     mkdir(doc_dir, args.dryrun)
     mkdir(icon_dir, args.dryrun)
-    mkdir(zshshare_dir, args.dryrun)
 
     cp('./bin/autojump', bin_dir, args.dryrun)
     cp('./bin/autojump_argparse.py', bin_dir, args.dryrun)
     cp('./bin/autojump_data.py', bin_dir, args.dryrun)
     cp('./bin/autojump_utils.py', bin_dir, args.dryrun)
+    cp('./bin/icon.png', icon_dir, args.dryrun)
+    cp('./docs/autojump.1', doc_dir, args.dryrun)
+
+    if platform.system() == 'Windows':
+        cp('./bin/autojump.lua', args.clinkdir, args.dryrun)
+        cp('./bin/autojump.bat', bin_dir, args.dryrun)
+        cp('./bin/j.bat', bin_dir, args.dryrun)
+        cp('./bin/jc.bat', bin_dir, args.dryrun)
+        cp('./bin/jo.bat', bin_dir, args.dryrun)
+        cp('./bin/jco.bat', bin_dir, args.dryrun)
+
+        if args.custom_install:
+            modify_autojump_lua(args.clinkdir, bin_dir, args.dryrun)
+    else:
+        mkdir(etc_dir, args.dryrun)
+        mkdir(zshshare_dir, args.dryrun)
+
         cp('./bin/autojump.sh', etc_dir, args.dryrun)
         cp('./bin/autojump.bash', etc_dir, args.dryrun)
         cp('./bin/autojump.fish', etc_dir, args.dryrun)
         cp('./bin/autojump.zsh', etc_dir, args.dryrun)
         cp('./bin/_j', zshshare_dir, args.dryrun)
-    cp('./bin/icon.png', icon_dir, args.dryrun)
-    cp('./docs/autojump.1', doc_dir, args.dryrun)
 
         if args.custom_install:
             modify_autojump_sh(etc_dir, args.dryrun)
 
-    print_post_installation_message(etc_dir)
+    print_post_installation_message(etc_dir, bin_dir)
 
 if __name__ == "__main__":
     sys.exit(main(parse_arguments()))

uninstall.py

@@ -8,6 +8,7 @@ import platform
 import shutil
 import sys
 
+sys.path.append('bin')
 from autojump_argparse import ArgumentParser
 
 
@@ -22,6 +23,8 @@ def is_empty_dir(path):
 
 
 def parse_arguments():
+    default_clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
+
     parser = ArgumentParser(
             description='Uninstalls autojump.')
     parser.add_argument(
@@ -39,6 +42,8 @@ def parse_arguments():
     parser.add_argument(
             '-z', '--zshshare', metavar='DIR', default='functions',
             help='custom zshshare')
+    parser.add_argument(
+            '-c', '--clinkdir', metavar='DIR', default=default_clink_dir)
 
     return parser.parse_args()
 
@@ -60,6 +65,16 @@ def remove_custom_installation(args, dryrun=False):
     rm(os.path.join(bin_dir, 'autojump'), dryrun)
     rm(os.path.join(bin_dir, 'autojump_data.py'), dryrun)
     rm(os.path.join(bin_dir, 'autojump_utils.py'), dryrun)
+    rm(os.path.join(bin_dir, 'autojump_argparse.py'), dryrun)
+    if platform.system() == 'Windows':
+        if os.path.exists(args.clinkdir):
+            rm(os.path.join(args.clinkdir, 'autojump.lua'), dryrun)
+        rm(os.path.join(bin_dir, 'autojump.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'j.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jc.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jco.bat'), dryrun)
+        rm(os.path.join(bin_dir, 'jo.bat'), dryrun)
+    else:
         rm(os.path.join(etc_dir, 'autojump.sh'), dryrun)
         rm(os.path.join(etc_dir, 'autojump.bash'), dryrun)
         rm(os.path.join(etc_dir, 'autojump.fish'), dryrun)
@@ -111,6 +126,10 @@ def remove_user_data(dryrun=False):
                         os.path.expanduser('~'),
                         'Library',
                         'autojump')
+    elif platform.system() == 'Windows':
+        data_home = os.path.join(
+                        os.getenv('APPDATA'),
+                        'autojump')
     else:
         data_home = os.getenv(
                 'XDG_DATA_HOME',
@@ -126,10 +145,16 @@ def remove_user_data(dryrun=False):
 
 
 def remove_user_installation(dryrun=False):
+    if platform.system() == 'Windows':
+        default_destdir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'autojump')
+        clink_dir = os.path.join(os.getenv('LOCALAPPDATA', ''), 'clink')
+    else:
         default_destdir = os.path.join(os.path.expanduser("~"), '.autojump')
     if os.path.exists(default_destdir):
         print("\nFound user installation...")
         rmdir(default_destdir, dryrun)
+        if platform.system() == 'Windows' and os.path.exists(clink_dir):
+            rm(os.path.join(clink_dir, 'autojump.lua'), dryrun)
 
 
 def rm(path, dryrun):