Support different layout

Author: Thibault Brocherieux

example/simpleDemo/main.go

@@ -13,7 +13,8 @@ import (
 	"strings"
 	"time"
 
-	gutter "github.com/Drakirus/go-flutter-desktop-embedder"
+	gutter "../.."
+	//gutter "github.com/Drakirus/go-flutter-desktop-embedder"
 	"github.com/Drakirus/go-flutter-desktop-embedder/flutter"
 
 	"github.com/go-gl/glfw/v3.2/glfw"
@@ -39,6 +40,7 @@ func main() {
 		gutter.OptionPixelRatio(1.2),
 		gutter.OptionVMArguments([]string{"--dart-non-checked-mode", "--observatory-port=50300"}),
 		gutter.OptionAddPluginReceiver(ownPlugin, "plugin_demo"),
+		gutter.OptionKeyboardLayout("FR"),
 	}
 
 	if err = gutter.Run(options...); err != nil {

gutter.go

@@ -93,73 +93,74 @@ func glfwMouseButtonCallback(window *glfw.Window, key glfw.MouseButton, action g
 
 var state = textModel{}
 
-func glfwKeyCallback(w *glfw.Window, key glfw.Key, scancode int, action glfw.Action, mods glfw.ModifierKey) {
+func glfwKey(keyboardLayout keyboardShortcuts) func(w *glfw.Window, key glfw.Key, scancode int, action glfw.Action, mods glfw.ModifierKey) {
 
-	if key == glfw.KeyEscape && action == glfw.Press {
-		w.SetShouldClose(true)
-	}
+	return func(w *glfw.Window, key glfw.Key, scancode int, action glfw.Action, mods glfw.ModifierKey) {
+		if key == glfw.KeyEscape && action == glfw.Press {
+			w.SetShouldClose(true)
+		}
 
-	if action == glfw.Repeat || action == glfw.Press {
-		if state.clientID != 0 {
+		if action == glfw.Repeat || action == glfw.Press {
+			if state.clientID != 0 {
 
-			switch key {
-			case glfw.KeyEnter:
-				if mods == glfw.ModControl {
-					performAction(w, "done")
-				} else {
-					state.addChar([]rune{'\n'})
-					performAction(w, "newline")
-				}
+				switch key {
+				case glfw.KeyEnter:
+					if mods == glfw.ModControl {
+						performAction(w, "done")
+					} else {
+						state.addChar([]rune{'\n'})
+						performAction(w, "newline")
+					}
 
-			case glfw.KeyHome:
-				state.MoveCursorHome(int(mods))
+				case glfw.KeyHome:
+					state.MoveCursorHome(int(mods))
 
-			case glfw.KeyEnd:
-				state.MoveCursorEnd(int(mods))
+				case glfw.KeyEnd:
+					state.MoveCursorEnd(int(mods))
 
-			case glfw.KeyLeft:
-				state.MoveCursorLeft(int(mods))
+				case glfw.KeyLeft:
+					state.MoveCursorLeft(int(mods))
 
-			case glfw.KeyRight:
-				state.MoveCursorRight(int(mods))
+				case glfw.KeyRight:
+					state.MoveCursorRight(int(mods))
 
-			case glfw.KeyDelete:
-				state.Delete(int(mods))
+				case glfw.KeyDelete:
+					state.Delete(int(mods))
 
-			case glfw.KeyBackspace:
-				state.Backspace(int(mods))
+				case glfw.KeyBackspace:
+					state.Backspace(int(mods))
 
-			case glfw.KeyA:
-				if mods == glfw.ModControl {
-					state.SelectAll()
-				}
+				case keyboardLayout.selectAll:
+					if mods == glfw.ModControl {
+						state.SelectAll()
+					}
 
-			case glfw.KeyC:
-				if mods == glfw.ModControl && state.isSelected() {
-					_, _, selectedContent := state.GetSelectedText()
-					w.SetClipboardString(selectedContent)
-				}
+				case keyboardLayout.copy:
+					if mods == glfw.ModControl && state.isSelected() {
+						_, _, selectedContent := state.GetSelectedText()
+						w.SetClipboardString(selectedContent)
+					}
 
-			case glfw.KeyX:
-				if mods == glfw.ModControl && state.isSelected() {
-					_, _, selectedContent := state.GetSelectedText()
-					w.SetClipboardString(selectedContent)
-					state.RemoveSelectedText()
-				}
+				case keyboardLayout.cut:
+					if mods == glfw.ModControl && state.isSelected() {
+						_, _, selectedContent := state.GetSelectedText()
+						w.SetClipboardString(selectedContent)
+						state.RemoveSelectedText()
+					}
 
-			case glfw.KeyV:
-				if mods == glfw.ModControl {
-					var clpString, err = w.GetClipboardString()
-					if err != nil {
-						log.Printf("unable to get the clipboard content: %v\n", err)
-					} else {
-						state.addChar([]rune(clpString))
+				case keyboardLayout.paste:
+					if mods == glfw.ModControl {
+						var clpString, err = w.GetClipboardString()
+						if err != nil {
+							log.Printf("unable to get the clipboard content: %v\n", err)
+						} else {
+							state.addChar([]rune(clpString))
+						}
 					}
 				}
 			}
 		}
 	}
-
 }
 
 func glfwWindowSizeCallback(window *glfw.Window, width int, height int) {
@@ -243,6 +244,8 @@ func runFlutter(window *glfw.Window, c config) *flutter.EngineOpenGL {
 	width, height := window.GetFramebufferSize()
 	glfwWindowSizeCallback(window, width, height)
 
+	glfwKeyCallback := glfwKey(c.KeyboardLayout)
+
 	window.SetKeyCallback(glfwKeyCallback)
 	window.SetFramebufferSizeCallback(glfwWindowSizeCallback)
 	window.SetMouseButtonCallback(glfwMouseButtonCallback)
@@ -286,11 +289,11 @@ func performAction(window *glfw.Window, action string) {
 		"TextInputAction." + action,
 	})
 	message := flutter.Message{
-		Args: actionArgs,
-		Method:"TextInputClient.performAction",
+		Args:   actionArgs,
+		Method: "TextInputClient.performAction",
 	}
 	var mess = &flutter.PlatformMessage{
-		Channel:textInputChannel,
+		Channel: textInputChannel,
 		Message: message,
 	}
 	flutterOGL := flutter.SelectEngine(0)

option.go

@@ -86,6 +86,29 @@ func OptionAddPluginReceiver(handler PluginReceivers, channelName string) Option
 	}
 }
 
+// OptionKeyboardLayout allow application to support keyboard that have a different layout
+// when the FlutterEngine send a PlatformMessage to the Embedder
+func OptionKeyboardLayout(layout string) Option {
+	return func(c *config) {
+		switch layout {
+		case "US":
+			c.KeyboardLayout = keyboardShortcuts{
+				cut:       glfw.KeyX,
+				copy:      glfw.KeyC,
+				paste:     glfw.KeyV,
+				selectAll: glfw.KeyA,
+			}
+		case "FR":
+			c.KeyboardLayout = keyboardShortcuts{
+				cut:       glfw.KeyX,
+				copy:      glfw.KeyC,
+				paste:     glfw.KeyV,
+				selectAll: glfw.KeyQ,
+			}
+		}
+	}
+}
+
 type config struct {
 	WindowDimension struct {
 		x int
@@ -97,6 +120,14 @@ type config struct {
 	PixelRatio               float64
 	VMArguments              []string
 	PlatformMessageReceivers map[string][]PluginReceivers // The Key is the Channel name.
+	KeyboardLayout           keyboardShortcuts
+}
+
+type keyboardShortcuts struct {
+	cut       glfw.Key
+	copy      glfw.Key
+	paste     glfw.Key
+	selectAll glfw.Key
 }
 
 func (t config) merge(options ...Option) config {