initial commit

Author: gokcehan

.gitignore

@@ -0,0 +1,2 @@
+lf
+tags

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Gökçehan Kara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,12 @@
+all: build
+
+build:
+	CGO_ENABLED=0 go build -ldflags '-s'
+
+install:
+	mv lf $(GOPATH)/bin
+
+test:
+	go test
+
+.PHONY: all test

README.md

@@ -0,0 +1,69 @@
+# LF
+
+> Please note that this is an experimental file manager.
+> One of the most dangerous pieces of software you can play with.
+> You may accidentally lose your files or worse so use at your own risk.
+
+> Likewise it is a work in progress.
+> You will most likely come across some shameful bugs.
+> Also some essentials may not have been implemented yet.
+
+`lf` (as in "list files") is a terminal file manager written in Go.
+It is heavily inspired by ranger with some missing and extra features.
+Some of the missing features are deliberately ommited
+since it is better if they are handled by external tools.
+
+![multicol-screenshot](http://i.imgur.com/DaTUenu.png)
+![singlecol-screenshot](http://i.imgur.com/p95xzUj.png)
+
+## Features
+
+- no external runtime dependencies (except for terminfo database)
+- fast startup and low memory footprint (due to native code and static binaries)
+- server/client architecture to share selection between multiple instances
+- custom commands as shell scripts (hence any other language as well)
+- sync (waiting and skipping) and async commands
+- fully customizable keybindings
+
+## Non-Features
+
+- tabs or windows (handled by the window manager or the terminal multiplexer)
+- built-in pager (handled by your pager of choice)
+
+## May-Futures
+
+- enchanced previews (image, pdf etc.)
+- bookmarks
+- colorschemes
+- periodic refresh
+- progress bar for file yank/delete paste
+
+## Installation
+
+You can build from the source using:
+
+    go get -u github.com/gokcehan/lf
+
+Currently there are no prebuilt binaries provided.
+
+## Usage
+
+After the installation `lf` command should start the application in the current directory.
+
+See [tutorial](doc/tutorial.md) for an introduction to the configuration.
+
+See [reference](doc/reference.md) for the list of keys, options and variables with their default values.
+
+See [etc](etc) directory to integrate `lf` to your shell or editor.
+
+## File Opener
+
+lf does not come bundled with a file opener.
+By default it tries to call `xdg-open` from `xdg-utils` package.
+You can change the file opener using the opener option (e.g. `:set opener mimeopen`).
+Below are a few alternatives you can use:
+
+- [libfile-mimeinfo-perl](https://metacpan.org/release/File-MimeInfo) (executable name is `mimeopen`)
+- [rifle](http://ranger.nongnu.org/) (ranger's default file opener)
+- [mimeo](http://xyne.archlinux.ca/projects/mimeo/)
+- custom (using file extensions and/or mimetypes with `file` command)

app.go

@@ -0,0 +1,123 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"os/exec"
+	"strings"
+)
+
+type App struct {
+	ui  *UI
+	nav *Nav
+}
+
+func waitKey() error {
+	// TODO: this should be done with termbox somehow
+
+	cmd := exec.Command(envShell, "-c", "echo; echo -n 'Press any key to continue'; stty -echo; read -n 1; stty echo; echo")
+
+	cmd.Stdin = os.Stdin
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+
+	err := cmd.Run()
+	if err != nil {
+		return fmt.Errorf("waiting key: %s", err)
+	}
+
+	return nil
+}
+
+func (app *App) handleInp() {
+	for {
+		if gExitFlag {
+			log.Print("bye!")
+			return
+		}
+		e := app.ui.getExpr()
+		if e == nil {
+			continue
+		}
+		e.eval(app, nil)
+		app.ui.draw(app.nav)
+	}
+}
+
+func (app *App) exportVars() {
+	dir := app.nav.currDir()
+
+	var envFile string
+	if len(dir.fi) != 0 {
+		envFile = app.nav.currPath()
+	}
+
+	marks := app.nav.currMarks()
+
+	envFiles := strings.Join(marks, ":")
+
+	os.Setenv("f", envFile)
+	os.Setenv("fs", envFiles)
+
+	if len(marks) == 0 {
+		os.Setenv("fx", envFile)
+	} else {
+		os.Setenv("fx", envFiles)
+	}
+}
+
+// This function is used to run a command in shell. Following modes are used:
+//
+// Prefix  Wait  Async  Stdin/Stdout/Stderr  UI action (before/after)
+// $       No    No     Yes                  Do nothing and then sync
+// !       Yes   No     Yes                  pause and then resume
+// &       No    Yes    No                   Do nothing
+//
+// Waiting async commands are not used for now.
+func (app *App) runShell(s string, args []string, wait bool, async bool) {
+	app.exportVars()
+
+	if len(gOpts.ifs) != 0 {
+		s = fmt.Sprintf("IFS='%s'; %s", gOpts.ifs, s)
+	}
+
+	args = append([]string{"-c", s, "--"}, args...)
+	cmd := exec.Command(envShell, args...)
+
+	if !async {
+		cmd.Stdin = os.Stdin
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+	}
+
+	if wait {
+		app.ui.pause()
+		defer app.ui.resume()
+	} else {
+		defer app.ui.sync()
+	}
+
+	defer app.nav.renew(app.ui.wins[0].h)
+
+	var err error
+	if async {
+		err = cmd.Start()
+	} else {
+		err = cmd.Run()
+	}
+
+	if err != nil {
+		msg := fmt.Sprintf("running shell: %s", err)
+		app.ui.message = msg
+		log.Print(msg)
+	}
+
+	if wait {
+		if err := waitKey(); err != nil {
+			msg := fmt.Sprintf("waiting shell: %s", err)
+			app.ui.message = msg
+			log.Print(msg)
+		}
+	}
+}

client.go

@@ -0,0 +1,112 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"log"
+	"net"
+	"os"
+
+	"github.com/nsf/termbox-go"
+)
+
+func client() {
+	logFile, err := os.Create(gLogPath)
+	if err != nil {
+		panic(err)
+	}
+	defer logFile.Close()
+	log.SetOutput(logFile)
+
+	log.Print("hi!")
+
+	if err := termbox.Init(); err != nil {
+		log.Fatalf("initializing termbox: %s", err)
+	}
+	defer termbox.Close()
+
+	ui := newUI()
+	nav := newNav(ui.wins[0].h)
+	app := &App{ui, nav}
+
+	rcFile, err := os.Open(gConfigPath)
+	if err != nil {
+		msg := fmt.Sprintf("opening configuration file: %s", err)
+		app.ui.message = msg
+		log.Printf(msg)
+	} else {
+		app.ui.echoFileInfo(app.nav)
+	}
+	defer rcFile.Close()
+
+	p := newParser(rcFile)
+	for p.parse() {
+		p.expr.eval(app, nil)
+	}
+
+	// TODO: parser error check
+
+	app.ui.draw(app.nav)
+
+	app.handleInp()
+}
+
+func saveFiles(list []string, keep bool) error {
+	c, err := net.Dial("unix", gSocketPath)
+	if err != nil {
+		return fmt.Errorf("dialing to save files: %s", err)
+	}
+	defer c.Close()
+
+	log.Printf("saving files: %v", list)
+
+	fmt.Fprintln(c, "save")
+
+	if keep {
+		fmt.Fprintln(c, "keep")
+	} else {
+		fmt.Fprintln(c, "move")
+	}
+
+	for _, f := range list {
+		fmt.Fprintln(c, f)
+	}
+
+	return nil
+}
+
+func loadFiles() (list []string, keep bool, err error) {
+	c, e := net.Dial("unix", gSocketPath)
+	if e != nil {
+		err = fmt.Errorf("dialing to load files: %s", e)
+		return
+	}
+	defer c.Close()
+
+	fmt.Fprintln(c, "load")
+
+	s := bufio.NewScanner(c)
+
+	switch s.Scan(); s.Text() {
+	case "keep":
+		keep = true
+	case "move":
+		keep = false
+	default:
+		err = fmt.Errorf("unexpected option to keep file(s): %s", s.Text())
+		return
+	}
+
+	for s.Scan() {
+		list = append(list, s.Text())
+	}
+
+	if s.Err() != nil {
+		err = fmt.Errorf("scanning file list: %s", s.Err())
+		return
+	}
+
+	log.Printf("loading files: %v", list)
+
+	return
+}

doc/reference.md

@@ -0,0 +1,39 @@
+# Reference
+
+## Keys
+
+    down              (default "j")
+    up                (default "k")
+    updir             (default "h")
+    open              (default "l")
+    quit              (default "q")
+    bot               (default "G")
+    top               (default "gg")
+    read              (default ":")
+    read-shell        (default "$")
+    read-shell-wait   (default "!")
+    read-shell-async  (default "&")
+    search            (default "/")
+    search-back       (default "?")
+    toggle            (default "<space>")
+    yank              (default "y")
+    delete            (default "d")
+    paste             (default "p")
+    redraw            (default "<c-l>")
+
+## Options
+
+    preview    bool    (default on)
+    hidden     bool    (default off)
+    tabstop    int     (default 8)
+    scrolloff  int     (default 0)
+    sortby     string  (default name)
+    showinfo   string  (default none)
+    opener     string  (default xdg-open)
+    ratios     string  (default 1:2:3)
+
+## Variables
+
+    $f   current file
+    $fs  marked file(s) (seperated with ':')
+    $fx  current file or marked file(s) if any