refactor: [API CHANGE] make Gio optional (gioui-plugins#40)

Author: inkeliz

README.md

@@ -72,7 +72,7 @@ Of course, `pingpong` has no use in real-world applications, but it can be used
 | **[WebViewer](https://github.com/gioui-plugins/gio-plugins/tree/main/webviewer)** | Display in-app webview using the native webview implementation on each platform.            | _Android, iOS, macOS, Windows, WebAssembly_  |  
 | **[Hyperlink](https://github.com/gioui-plugins/gio-plugins/tree/main/hyperlink)** |  Open hyperlinks in the default browser.            | _Android, iOS, macOS, Windows, WebAssembly_  |  
 | **[Explorer](https://github.com/gioui-plugins/gio-plugins/tree/main/explorer)** |  Opens the native file-dialog, to read/write files.  | _Android, iOS, macOS, Windows, WebAssembly_  |  
-
+| **[Safedata](https://github.com/gioui-plugins/gio-plugins/tree/main/safedata)** | Read/Write files into the secure storage of the device. | _Android, iOS, macOS, Windows, WebAssembly_  |
 **We have few plugins planned:**
 
 Some plugins are planned, but not yet implemented, follow the development at https://github.com/orgs/gioui-plugins/projects/1. Also, 

explorer/README.md

@@ -8,13 +8,32 @@ Opens the native file-dialog/file-picker.
 
 ## Usage
 
+## Freestanding
+
+- `exporer.NewExplorer`:
+  - Creates a instance of Explorer struct, given the config.
+- `explorer.Configure`:
+  - Updates the current Explorer with the given config.
+- `explorer.OpenFile`:
+  - Opens the native file dialog to open a single file.
+- `explorer.SaveFile`:
+  - Opens the native file dialog to save a single file.
+
+## Gio
+
+## Non-Plugin:
+
+If you want to use it without plugin, read the Freestanding instructions. We provide some helper functions, such as NewConfigFromViewEvent and such.
+
+## Plugin:
+
 To open an single file, you can use `explorer.OpenFileOp`.
 
 That will open native File Dialog/File Picker. Once the file is selected by the end-user,
 one `explorer.OpenFileEvent` will be sent to the given `Tag`. 
 
 ```go
-explorer.OpenFileOp{
+gioexplorer.OpenFileOp{
     Tag: yourTag, 
     Mimetype: []mimetype.MimeType{
       {Extension: "png", Type: "image", Subtype: "png"},
@@ -30,22 +49,22 @@ explorer.OpenFileOp{
 
 Operations must be added with `.Add(gtx.Ops)` method. The operation will be executed at the end of the frame.
 
-- `explorer.OpenFileOp`:
+- `gioexplorer.OpenFileOp`:
   - Opens the native file dialog to open/import a single file.
-- `explorer.SaveFileOp`:
+- `gioexplorer.SaveFileOp`:
   - Open the native file dialog to save/export a single file.
 
 ## Events:
 
 Events are response sent using the `Tag` and should be handled with `gtx.Events()`.
 
-- `explorer.OpenFileEvent`:
+- `gioexplorer.OpenFileEvent`:
   - Sent to `Tag` when the user chooses the file to be read/open. That event contains one io.ReadCloser.
-- `explorer.SaveFileEvent`:
+- `gioexplorer.SaveFileEvent`:
   - Sent to `Tag` when the user chooses the file to save/replace. That event contains one io.WriteCloser.
-- `explorer.ErrorEvent`:
+- `gioexplorer.ErrorEvent`:
   - Sent to `Tag` when some error occurs.
-- `explorer.CancelEvent`: 
+- `gioexplorer.CancelEvent`: 
   - Sent to `Tag` when the user closes the file-dialog or not select one valid file.
 
 ## Features

explorer/config.go

@@ -0,0 +1,9 @@
+//go:build !android && !darwin && !ios && !windows && !(js && wasm)
+
+package explorer
+
+// Config is the configuration for a Explorer.
+//
+// Each OS contains their own settings and options,
+// check each config_* file for more details.
+type Config struct{}

explorer/config_android.go

@@ -0,0 +1,15 @@
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct {
+	// VM is the Java VM.
+	VM uintptr
+
+	View uintptr
+
+	// Context is the Android Context.
+	Context uintptr
+
+	// RunOnMain is a function that runs on the main UI thread.
+	RunOnMain func(f func())
+}

explorer/config_ios.go

@@ -0,0 +1,13 @@
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct {
+	// View is a CFTypeRef for the UIViewController for the window.
+	View uintptr
+
+	// RunOnMain is a function that runs on the main UI thread.
+	RunOnMain func(f func())
+
+	// PxPerDp represents how many pixels per each dp.
+	PxPerDp float32
+}

explorer/config_js.go

@@ -0,0 +1,4 @@
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct{}

explorer/config_macos.go

@@ -0,0 +1,15 @@
+//go:build darwin && !ios
+
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct {
+	// View is a CFTypeRef for the NSView for the window.
+	View uintptr
+
+	// Layer is a CFTypeRef of the CALayer of View.
+	Layer uintptr
+
+	// RunOnMain is a function that runs on the main UI thread.
+	RunOnMain func(f func())
+}

explorer/config_unsupported.go

@@ -0,0 +1,6 @@
+//go:build !android && !darwin && !ios && !windows && !(js && wasm)
+
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct{}

explorer/config_windows.go

@@ -0,0 +1,10 @@
+package explorer
+
+// Config is the configuration for a Explorer.
+type Config struct {
+	// HWND is the handle to the window.
+	HWND uintptr
+
+	// RunOnMain is a function that runs on the main UI thread.
+	RunOnMain func(f func())
+}

explorer/demo/go.mod

@@ -0,0 +1,22 @@
+module demo
+
+go 1.19
+
+replace github.com/gioui-plugins/gio-plugins => ../../
+
+require (
+	gioui.org v0.0.0-20230425023356-bba91263b077
+	github.com/gioui-plugins/gio-plugins v0.0.0-00010101000000-000000000000
+	golang.org/x/image v0.7.0
+)
+
+require (
+	gioui.org/cpu v0.0.0-20220412190645-f1e9e8c3b1f7 // indirect
+	gioui.org/shader v1.0.6 // indirect
+	git.wow.st/gmp/jni v0.0.0-20210610011705-34026c7e22d0 // indirect
+	github.com/go-text/typesetting v0.0.0-20230413204129-b4f0492bf7ae // indirect
+	golang.org/x/exp v0.0.0-20221012211006-4de253d81b95 // indirect
+	golang.org/x/exp/shiny v0.0.0-20220921164117-439092de6870 // indirect
+	golang.org/x/sys v0.5.0 // indirect
+	golang.org/x/text v0.9.0 // indirect
+)