Merge 0.8.0 branch

Author: ko1nksm

.gitignore

@@ -0,0 +1,3 @@
+/bin/*.exe
+/dist
+/tmp

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## Unreleased
+
+## 0.8.0 - 2019-11-03
+
+- Windows native implementation
+- Improve perfomance
+
+## Before 0.8.0
+
+- Slow PowerShell implementation version

README.md

@@ -1,93 +1,196 @@
-# ecd & eopen
+# eopen (+ecd)
 
-Change directory to each other between Terminal and Explorer.
+Open Explorer from WSL Terminal (plus PowerShell, Command Prompt).
+Change directory of Terminal to Explorer location.
+
+## Supported Windows and Terminals
+
+* `Windows 10 64bit 1903` or later recommended,
+* Probably works on `Windows 7` (include 32bit) or later.
+* `WSL` / `WSL2` recommended for the terminal.
+* Semi-support for `Powershell` and `Command Prompt`.
 
 ## Usage
 
-**Note** Require to enable `Launch folder windows in a separete process` in *Explorer* -> *File* -> *Change folder and search options* -> *View* -> *Advanced settings*.
+### eopen
 
-`ecd` - Change the terminal directory to the current explorer location.
+Open the file or change the directory from the Terminal via a shell (Explorer).
+
+#### Examples
 
 ```
-Usage: ecd
-```
+# Open directory with (latest used) Explorer
+eopen ~/.config/
 
-`ewd` - Display linux path of current explorer location.
+# Open directory with new instance of Explorer
+eopen -n ~/.config/
 
-```
-Usage: ewd
-```
+# Opens with Windows default application
+eopen image.png
 
-`eopen` - Open the file or change the directory from the terminal via a shell (explorer).
+# Opens with Windows text editor
+eopen -e ~/.bashrc
 
-```
-Usage: eopen [options] [file | directory | uri]
+# Use sudo to edit the unowned file
+eopen -e --sudo /etc/hosts
 
-options:
-  -e, --editor      Open the file in text editor ($EOPEN_EDITOR)
-  -n, --new         Open the specified directory in new instance of explorer
-      --sudo        Use sudo to write the unowned file
-  -v, --version     Display the version
-  -h, --help        You're looking at it
+# Opens with Windows default browser
+eopen http://google.com
 
-note:
-  The file or the directory allows linux and windows path.
-  (e.g. /etc/hosts, C:/Windows/System32/drivers/etc/hosts)
+# Open other protocols
+eopen mailto:[email protected]
+eopen shell:downloads
+eopen calculator:
+eopen msnweather:
+eopen ms-settings:
+eopen xboxliveapp-1297287741: # Solitaire
 
-  The uri must start with protocol schema. (e.g http:, https:)
+# Open files and directories under Windows
+eopen C:/Windows
+
+# Open files and directories under Network shared folder
+eopen //server/shared
 ```
 
-### WSL terminal
+**Note** If you use `eopen -e`, you need to set the execution path to
+`EOPEN_EDITOR` environment variable for Windows  (not WSL).
+
+**Note** `eopen` for PowerShell and Command Prompt are currently not
+implemented. It just alias of `explorer.exe`.
+
+### ewd
+
+Print linux path of the (latest used) explorer location.
+
+### ecd
 
-Define alias refer to the following and type `ecd`.
+Change the terminal directory to the (latest used) explorer location.
 
-**Note** If you use `eopen -e`, you need to set the execution path to `EOPEN_EDITOR` environment variable.
+### epushd
 
-#### For sh
+Change the terminal directory to the (latest used) explorer location,
+And add directories to stack. (Use `pushd` instead of `cd`.)
 
-`bash`, `zsh`, `ksh` and compatibile shells.
+**Note** Not available on `ksh` and `mksh`, since `push` is not implemented.
+
+## Download
+
+**Download from [releases page](https://github.com/ko1nksm/eopen/releases)**
+
+**Note** Highly recommend using x64 binary on Windows 10 64bit edition.
+x86 binary is also work, but access to the WSL path (`\\wsl$\...`) from
+32bit process is unstable. (Related? [issue 4260][4260] of microsoft/WSL)
+
+[4260]: https://github.com/microsoft/WSL/issues/4260
+
+**Note** It is also distributed for Windows 10 ARM / ARM64.
+But I do not have those platforms. So it has not been tested at all.
+
+## Installation
+
+Extract the zip file to any directory and set to your shell's profile.
+
+**Note** Require to enable `Launch folder windows in a separete process` in
+*Explorer* -> *File* -> *Change folder and search options* -> *View*
+-> *Advanced settings*.
+
+### WSL terminal
+
+Change the following line to the appropriate path and add it to your
+shell's profile under your home directory.
+
+#### For POSIX compliant shells
 
 ```sh
-alias ecd='eval "$(/path/to/wsl/ecd.sh)"'
-alias ewd='/path/to/wsl/ewd.sh'
-alias eopen='/path/to/wsl/eopen.sh'
+eval "$(sh "/path/to/eopen/init.sh")"
 ```
 
+[Profile] **bash:** `.bashrc`, **zsh:** `.zshrc`, **ksh:** `.kshrc`,
+**mksh:**, `.mkshrc`, **yash:** `.yashrc`
+
 #### For tcsh
 
 ```sh
-alias ecd 'eval `/path/to/wsl/ecd.sh`'
-alias ewd '/path/to/wsl/ewd.sh'
-alias eopen '/path/to/wsl/eopen.sh'
+eval `sh "/path/to/eopen/init.sh" tcsh`
 ```
 
+[Profile] **tcsh:** `.tcshrc`
+
 #### For fish
 
 ```sh
-alias ecd='eval (/path/to/wsl/ecd.sh)'
-alias ewd='/path/to/wsl/ewd.sh'
-alias eopen='/path/to/wsl/eopen.sh'
+eval (sh "/path/to/eopen/init.sh" fish)
 ```
 
-### Command prompt
+[Profile] **fish:** `.config/fish/config.fish`
 
-Type `ecd` (`ecd.bat`) or `epushd` (`epushd.bat`).
+### PowerShell
 
-**Note** `epushd.bat` uses `pushd` command instead of `cd`. So you can restore directory by `popd` and use UNC path.
+Change the following line to the appropriate path and add it to your
+PowerShell's profile.
 
-### PowerShell
+```powershell
+. "/path/to/eopen/init.ps1"
+```
 
-**Note** Require to change execution policy. (Google `Set-ExecutionPolicy`).
+To edit profile, type `notepad $PROFILE` in PowerShell.
 
-Add the following code to your profile (Run `notepad $profile` to edit) and type `ecd`.
 
-```powershell
-Set-Alias ecd "/path/to/pwsh/ewd.ps1"
+**Note** Require to change PowerShell execution policy.
+(Google `Set-ExecutionPolicy`).
+
+### Command prompt
+
+Change the following line to the appropriate path and add it to `profile.bat`
+(or favorite name)
+
+```batch
+@call \path\to\eopen\init.bat
 ```
 
-## Thanks
+Load it to Command Prompt. (For example, use `cmd /k profile.bat`)
+
+## For developers
+
+### Architecture
+
+The `ebridge.exe` is helper module that operate shell (Explorer) via
+COM Automation. All scripts are thin frontend of the `ebridge.exe`.
+
+### How to build ebridge.exe
+
+Require to install [Visual Studio 2019][vs2019] to build.
+(Free Community Edition is enough.)
+
+[vs2019]: https://visualstudio.microsoft.com/downloads/
+
+To build, the following steps after installation of Visual Studio 2019
+
+1. Run `Developer Command Prompt for VS 2019` from the *start menu*
+2. Goto project root directory
+3. Run `build.bat <TARGET...>` (TARGET: `x86`, `x64`, `arm`, `arm64`)
+4. Generate archive files to the `dist` directory.
+
+Or double click `ebridge.sln` in the [src](src) directory to launch Visual Studio IDE.
+
+### Test
+
+None, should be do.
+
+## History
+
+The formerly name of this project was `ecd` that was started to port
+the `fcd` for macOS to Windows.
+
+  * [fcd](http://www.script-factory.net/software/terminal/fcd/index.html) - Script factory
+  * [fcd](https://qiita.com/Yuhsak/items/a1f154f14e5ff871b6d2) - another one-liner version
+
+The core module was written with PowerShell script. Early version of
+`ecd` and `eopen` were relies on the script. It was a bit slow (about 400ms-).
+So I rewrote the core module as native by VC++.
+And `eopen`, which has many features, has been changed to the main.
 
-[fcd](https://qiita.com/Yuhsak/items/a1f154f14e5ff871b6d2) (macOS version of this. The idea was taken from here).
+[CHANGELOG](CHANGELOG.md)
 
 ## License
 

bin/.please-place-ebridge.exe-here

@@ -0,0 +1,9 @@
+@echo off
+
+if "%1" == "" (
+  call :build x86 x64 arm arm64
+  goto :eof
+)
+
+:build
+  powershell -NoProfile -ExecutionPolicy Unrestricted %~dp0build.ps1 %*

bridge/eopen.ps1

@@ -0,0 +1,47 @@
+$ErrorActionPreference = "Stop"
+
+Set-Location "$PSScriptRoot"
+
+New-Item "tmp", "dist" -ItemType Directory -Force | Out-Null
+function build($plartform) {
+  if (! (Test-Path "src\$plartform")) {
+    [Console]::Error.WriteLine("ERROR: Platform '$plartform' not defined")
+    exit 1
+  }
+
+  Set-Location src\
+  msbuild.exe /p:Configuration="Release;Platform=$plartform" /m
+  if ($LASTEXITCODE -ne 0) { throw "Build failed." }
+  Set-Location ..\
+
+  $ebridge = "src\$plartform\Release\ebridge.exe"
+  $version = (Get-Content src\version.h) -replace '^.*?"|".*?$',""
+  $name="eopen-$version-$plartform"
+
+  Remove-Item "tmp\$name" -Recurse -ErrorAction Ignore
+  New-Item "tmp\$name", "tmp\$name\bin" -ItemType Directory | Out-Null
+
+  $files = @(
+    "README.md"
+    "CHANGELOG.md"
+    "LICENSE"
+    "init.bat"
+    "init.ps1"
+    "init.sh"
+    "cmd"
+    "pwsh"
+    "wsl"
+  )
+
+  Copy-Item -Path $files -Recurse -Destination "tmp\$name"
+  Copy-Item -Path "$ebridge" -Destination "tmp\$name\bin"
+
+  Compress-Archive -Path "tmp\$name" -DestinationPath "dist\$name.zip" -Force
+}
+
+foreach($plartform in $args){
+  build $plartform
+}
+
+Get-ChildItem dist
+Write-Output "Generated"