Merge pull request #6 from RasmusLindroth/modes

Added support for modes

Author: RasmusLindroth

README.md

@@ -7,7 +7,8 @@ through your configuration file or going down the track of trial and error
 anymore.
 
 The program will output one separate keyboard for all of your different modifier 
-combinations. And the keyboard will look like your keymap. I hope :)
+combinations. It will also output each combination for all of your modes.
+The keyboard should look like your keymap if everything works as expected :)
 
 You can see the results in three ways. By opening a local web page,
 output the keyboards as text in the terminal or generate SVG files.
@@ -85,6 +86,10 @@ feature-rich option. Because here you can see the command bound to each key.
 
 If you have selected to out SVG files. Open them with a program that supports 
 SVG files. For example your program for viewing images, InkScape or a browser.
+Note that each mode will be located in a folder named mode\<int\>-name-of-mode.
+Inside that folder you will find a file named `mode-full-name` where you can see
+the real name of the mode. Because this program removes some characters and 
+shortens the name of the folder.
 
 If you have selected text output, you should already have seen the result in 
 your terminal.

go.mod

@@ -6,4 +6,5 @@ require (
 	github.com/gorilla/handlers v1.4.0
 	github.com/gorilla/mux v1.7.1
 	go.i3wm.org/i3 v0.0.0-20181105220049-e2468ef5e1cd
+	golang.org/x/net v0.0.0-20190322120337-addf6b3196f6 // indirect
 )

go.sum

@@ -10,7 +10,13 @@ github.com/gorilla/mux v1.7.1 h1:Dw4jY2nghMMRsh1ol8dv1axHkDwMQK2DHerMNJsIpJU=
 github.com/gorilla/mux v1.7.1/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs=
 go.i3wm.org/i3 v0.0.0-20181105220049-e2468ef5e1cd h1:PVrHRo3MP4x/+tbG01rmFnp1sJ1GC7laHJ56OedXYp0=
 go.i3wm.org/i3 v0.0.0-20181105220049-e2468ef5e1cd/go.mod h1:7w17+r1F28Yxb1pHu8SxARJo+RGvJCAGOEf+GLw+2aQ=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/net v0.0.0-20181102091132-c10e9556a7bc h1:ZMCWScCvS2fUVFw8LOpxyUUW5qiviqr4Dg5NdjLeiLU=
 golang.org/x/net v0.0.0-20181102091132-c10e9556a7bc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190322120337-addf6b3196f6 h1:78jEq2G3J16aXneH23HSnTQQTCwMHoyO8VEiUH+bpPM=
+golang.org/x/net v0.0.0-20190322120337-addf6b3196f6/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f h1:wMNYb4v58l5UBM7MYRLPG6ZhfOqbKu7X5eyFl8ZhKvA=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

i3keys.go

@@ -1,166 +1,17 @@
 package main
 
 import (
-	"encoding/json"
 	"flag"
 	"fmt"
-	"log"
 	"os"
-	"path/filepath"
 	"strings"
 
-	"github.com/RasmusLindroth/i3keys/internal/i3parse"
-	"github.com/RasmusLindroth/i3keys/internal/keyboard"
 	"github.com/RasmusLindroth/i3keys/internal/svg"
+	"github.com/RasmusLindroth/i3keys/internal/text"
 	"github.com/RasmusLindroth/i3keys/internal/web"
-	"github.com/RasmusLindroth/i3keys/internal/xlib"
 )
 
-const version string = "0.0.5"
-
-func keysToSymbol(keys []i3parse.Binding) []i3parse.Binding {
-	for key, item := range keys {
-		if item.Type == i3parse.CodeBinding {
-			res, err := i3parse.CodeToSymbol(item)
-			if err == nil {
-				keys[key] = res
-			}
-		}
-	}
-	return keys
-}
-
-func webOutput(port string) {
-	_, keys, err := i3parse.ParseFromRunning()
-
-	if err != nil {
-		log.Fatalln(err)
-	}
-
-	keys = keysToSymbol(keys)
-
-	modifiers := xlib.GetModifiers()
-	groups := i3parse.GetModifierGroups(keys)
-
-	var isoKeyboards []keyboard.Keyboard
-	var ansiKeyboards []keyboard.Keyboard
-	for _, group := range groups {
-		kbISO, err := keyboard.MapKeyboard("ISO", group, modifiers)
-		if err != nil {
-			log.Fatalln(err)
-		}
-		isoKeyboards = append(isoKeyboards, kbISO)
-
-		kbANSI, err := keyboard.MapKeyboard("ANSI", group, modifiers)
-		if err != nil {
-			log.Fatalln(err)
-		}
-		ansiKeyboards = append(ansiKeyboards, kbANSI)
-	}
-
-	ISOkeyboardJSON, _ := json.Marshal(isoKeyboards)
-	ANSIkeyboardJSON, _ := json.Marshal(ansiKeyboards)
-
-	js := fmt.Sprintf("let generatedISO = %s;\nlet generatedANSI = %s;", ISOkeyboardJSON, ANSIkeyboardJSON)
-
-	handler := web.New(js)
-
-	fmt.Printf("Starting server at http://localhost:%s\nGo there "+
-		"to see all of your available keys.\n\n", port)
-	err = handler.Start(port)
-	if err != nil {
-		log.Fatalln(err)
-	}
-}
-
-func textOutput(layout string) {
-	_, keys, err := i3parse.ParseFromRunning()
-
-	if err != nil {
-		log.Fatalln(err)
-	}
-
-	layout = strings.ToUpper(layout)
-
-	keys = keysToSymbol(keys)
-
-	groups := i3parse.GetModifierGroups(keys)
-	modifiers := xlib.GetModifiers()
-
-	var keyboards []keyboard.Keyboard
-	for _, group := range groups {
-		kb, err := keyboard.MapKeyboard(layout, group, modifiers)
-		if err == nil {
-			keyboards = append(keyboards, kb)
-		}
-	}
-
-	fmt.Printf("Available keybindings per modifier group\n\n")
-	for kbIndex, kb := range keyboards {
-		dots := "-"
-		for i := 0; i < len(kb.Name); i++ {
-			dots = dots + "-"
-		}
-
-		fmt.Printf("%s:\n%s\n", kb.Name, dots)
-
-		for _, keyRow := range kb.Keys {
-			var unused []string
-			for _, key := range keyRow {
-				if key.InUse == false {
-					unused = append(unused, key.Symbol)
-				}
-			}
-			unusedStr := strings.Join(unused, ", ")
-			fmt.Printf("%s\n", unusedStr)
-		}
-		if kbIndex+1 < len(groups) {
-			fmt.Printf("\n\n")
-		}
-	}
-}
-
-func svgOutput(layout string, dest string) {
-	_, keys, err := i3parse.ParseFromRunning()
-
-	if err != nil {
-		log.Fatalln(err)
-	}
-
-	keys = keysToSymbol(keys)
-
-	layout = strings.ToUpper(layout)
-	if dest == "" {
-		dest = filepath.Join("./")
-	}
-
-	groups := i3parse.GetModifierGroups(keys)
-	modifiers := xlib.GetModifiers()
-
-	for _, group := range groups {
-		kb, err := keyboard.MapKeyboard(layout, group, modifiers)
-
-		if err != nil {
-			log.Fatalln(err)
-		}
-
-		data := svg.Generate(layout, kb)
-
-		fname := "no-modifiers"
-		if len(group.Modifiers) > 0 {
-			fname = strings.Join(group.Modifiers, "-")
-		}
-		fname = fname + "-" + layout + ".svg"
-
-		file, err := os.Create(filepath.Join(dest, fname))
-
-		if err != nil {
-			log.Fatalln(err)
-		}
-
-		file.Write(data)
-	}
-}
+const version string = "0.0.6"
 
 func helpText(exitCode int) {
 	fmt.Printf("Usage:\n\n\ti3keys <command> [arguments]\n\n")
@@ -202,14 +53,14 @@ func main() {
 
 	switch cmd {
 	case "web":
-		webOutput(os.Args[2])
+		web.Output(os.Args[2])
 	case "text":
-		textOutput(os.Args[2])
+		text.Output(os.Args[2])
 	case "svg":
 		if len(os.Args) < 4 {
-			svgOutput(os.Args[2], "")
+			svg.Output(os.Args[2], "")
 		} else {
-			svgOutput(os.Args[2], os.Args[3])
+			svg.Output(os.Args[2], os.Args[3])
 		}
 	case "version":
 		fmt.Printf("i3keys version %s by Rasmus Lindroth\n", version)

internal/i3parse/helpers.go

@@ -0,0 +1,15 @@
+
+package i3parse
+
+//KeysToSymbol converts code bindings to symbol bindings
+func KeysToSymbol(keys []Binding) []Binding {
+	for key, item := range keys {
+		if item.Type == CodeBinding {
+			res, err := CodeToSymbol(item)
+			if err == nil {
+				keys[key] = res
+			}
+		}
+	}
+	return keys
+}

internal/svg/output.go

@@ -0,0 +1,116 @@
+package svg
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+	"unicode"
+
+	"github.com/RasmusLindroth/i3keys/internal/i3parse"
+	"github.com/RasmusLindroth/i3keys/internal/keyboard"
+	"github.com/RasmusLindroth/i3keys/internal/xlib"
+)
+
+func sanitizeDirName(s string) string {
+	r := ""
+	prevChar := '-'
+	for _, c := range s {
+		switch {
+		case unicode.IsSpace(c) || unicode.IsPunct(c):
+			if prevChar != '-' {
+				r += "-"
+				prevChar = '-'
+			}
+		case unicode.IsDigit(c) || unicode.IsLetter(c):
+			r += string(c)
+			prevChar = c
+		}
+	}
+	r = filepath.Base(filepath.Clean(r))
+	return r
+}
+func createGroup(layout string, dest string, group i3parse.ModifierGroup, modifiers map[string][]string) {
+	kb, err := keyboard.MapKeyboard(layout, group, modifiers)
+
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	data := Generate(layout, kb)
+
+	fname := "no-modifiers"
+	if len(group.Modifiers) > 0 {
+		fname = strings.Join(group.Modifiers, "-")
+	}
+	fname = fname + "-" + layout + ".svg"
+
+	file, err := os.Create(filepath.Join(dest, fname))
+	defer file.Close()
+
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	file.Write(data)
+}
+
+//Output generates svg-files of the keyboards at the desired location
+func Output(layout string, dest string) {
+	modes, keys, err := i3parse.ParseFromRunning()
+
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	keys = i3parse.KeysToSymbol(keys)
+
+	layout = strings.ToUpper(layout)
+	if dest == "" {
+		dest = filepath.Join("./")
+	}
+
+	groups := i3parse.GetModifierGroups(keys)
+	modifiers := xlib.GetModifiers()
+
+	err = os.MkdirAll(dest, os.ModePerm)
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	for _, group := range groups {
+		createGroup(layout, dest, group, modifiers)
+	}
+
+	for i, mode := range modes {
+		keys := i3parse.KeysToSymbol(mode.Bindings)
+		groups := i3parse.GetModifierGroups(keys)
+
+		modeDir := fmt.Sprintf("mode%d-", i)
+		modeDir += sanitizeDirName(mode.Name)
+
+		if len(modeDir) > 50 {
+			modeDir = modeDir[0:50]
+		}
+
+		mDest := filepath.Join(dest, modeDir)
+		err = os.MkdirAll(mDest, os.ModePerm)
+		if err != nil {
+			log.Fatalln(err)
+		}
+
+		file, err := os.Create(filepath.Join(mDest, "mode-full-name.txt"))
+
+		if err != nil {
+			log.Fatalln(err)
+		}
+
+		file.Write([]byte(mode.Name))
+		file.Close()
+
+		for _, group := range groups {
+			createGroup(layout, mDest, group, modifiers)
+		}
+	}
+}