diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml new file mode 100644 index 0000000..72803a9 --- /dev/null +++ b/.github/workflows/go.yml @@ -0,0 +1,22 @@ +name: Go + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: 1.19 + + - name: Build + run: go build -v ./... diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f50a556 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +play +play.exe +*.exe~ +*.dll +*.so +*.dylib +*.test +*.out diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..1fe6d5f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Paolo Lazzari + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba445ad --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# play + +play is a TUI playground for your favorite programs, such as grep, sed and awk. + +

+ + + + play + +

+ +# Demo + +![](docs/demo.gif) + +It uses the excellent [tview](https://github.com/rivo/tview) library for the UI. + +# Installation + +```bash +$ git clone https://github.com/paololazzari/play +$ cd play +$ go build -o /usr/local/bin/ +``` + +# Usage + +```bash +./play grep +``` + +## Key bindings + +| Component | Key | Description | +|-----------------|---------------|-------------| +| Command Options | `Tab` | Move focus to positional arguments | +| Command Options | `Shift+Tab` | Move focus to file picker | +| Command Options | `Enter` | Move focus to output | +| Positional Arguments | `Tab` | Move focus to file picker | +| Positional Arguments | `Shift+Tab` | Move focus to command options | +| Positional Arguments | `Enter` | Move focus to output | +| Positional Arguments | `Ctrl+O` | Open wide editor/Close wide editor | +| File picker | `Tab` | Move focus to command options | +| File picker | `Shift+Tab` | Move focus to positional arguments options | +| File picker | `Ctrl+O` | Open selected file/Close selected file | +| Output | `Esc` | Move focus to previous component | \ No newline at end of file diff --git a/cmd/core.go b/cmd/core.go new file mode 100644 index 0000000..8691d49 --- /dev/null +++ b/cmd/core.go @@ -0,0 +1,130 @@ +package cmd + +import ( + "bufio" + "fmt" + "os" + "os/exec" + "runtime" + + ui "github.com/paololazzari/play/src/ui" + "github.com/spf13/cobra" + "golang.org/x/term" +) + +const version = "0.1.0" + +func completionCommand() *cobra.Command { + return &cobra.Command{ + Use: "completion", + } +} + +var ( + rootCmd = &cobra.Command{ + Use: "play", + Short: "play", + Long: `play`, + PersistentPreRunE: func(cmd *cobra.Command, args []string) error { + if cmd.Use != "version" { + validateProgramExists(cmd.Use) + } + validateArgs(args) + return nil + }, + } + + versionCmd = &cobra.Command{ + Use: "version", + Short: "Print version number", + Long: `Print version number`, + Run: func(cmd *cobra.Command, args []string) { + fmt.Println("play", version) + }, + } + + grepCmd = &cobra.Command{ + Use: "grep", + Short: `Play with grep`, + Run: func(cmd *cobra.Command, args []string) { + run("grep") + }, + } + + sedCmd = &cobra.Command{ + Use: "sed", + Short: `Play with sed`, + Run: func(cmd *cobra.Command, args []string) { + run("sed") + }, + } + + awkCmd = &cobra.Command{ + Use: "awk", + Short: `Play with awk`, + Run: func(cmd *cobra.Command, args []string) { + run("awk") + }, + } +) + +func exitWithError(e interface{}) { + fmt.Fprintln(os.Stderr, e) + os.Exit(1) +} + +func validateArgs(args []string) { + if len(args) > 0 { + exitWithError("Invalid number of arguments") + } +} + +func validateProgramExists(program string) { + _, err := exec.LookPath(program) + if err != nil { + exitWithError(program + " not found") + } +} + +func run(command string) error { + + var userInterface *ui.UI + input := "" + + // check whether file descriptor is terminal + if !term.IsTerminal(int(os.Stdin.Fd())) { + if runtime.GOOS != "windows" { + _, err := os.OpenFile("/dev/tty", os.O_RDONLY, 0) + if err != nil { + exitWithError(err) + } + var stdin []byte + scanner := bufio.NewScanner(os.Stdin) + for scanner.Scan() { + stdin = append(stdin, scanner.Bytes()...) + } + input = string(stdin) + } + } + + userInterface = ui.NewUI(command, input) + userInterface.InitUI() + userInterface.Run() + return nil +} + +func init() { + completion := completionCommand() + completion.Hidden = true + rootCmd.AddCommand(versionCmd) + rootCmd.AddCommand(grepCmd) + rootCmd.AddCommand(sedCmd) + rootCmd.AddCommand(awkCmd) + rootCmd.AddCommand(completion) // https://github.com/spf13/cobra/issues/1507 +} + +func Execute() { + if err := rootCmd.Execute(); err != nil { + exitWithError(err) + } +} diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..94a6f82 Binary files /dev/null and b/docs/demo.gif differ diff --git a/docs/gopher.png b/docs/gopher.png new file mode 100644 index 0000000..2805997 Binary files /dev/null and b/docs/gopher.png differ diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..b0e0a5a --- /dev/null +++ b/go.mod @@ -0,0 +1,22 @@ +module github.com/paololazzari/play + +go 1.18 + +require ( + github.com/gdamore/tcell/v2 v2.6.0 + github.com/rivo/tview v0.0.0-20230916092115-0ad06c2ea3dd + github.com/spf13/cobra v1.7.0 + golang.org/x/exp v0.0.0-20230905200255-921286631fa9 + golang.org/x/term v0.12.0 +) + +require ( + github.com/gdamore/encoding v1.0.0 // indirect + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-runewidth v0.0.14 // indirect + github.com/rivo/uniseg v0.4.3 // indirect + github.com/spf13/pflag v1.0.5 // indirect + golang.org/x/sys v0.13.0 // indirect + golang.org/x/text v0.7.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..f6c1183 --- /dev/null +++ b/go.sum @@ -0,0 +1,56 @@ +github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/gdamore/encoding v1.0.0 h1:+7OoQ1Bc6eTm5niUzBa0Ctsh6JbMW6Ra+YNuAtDBdko= +github.com/gdamore/encoding v1.0.0/go.mod h1:alR0ol34c49FCSBLjhosxzcPHQbf2trDkoo5dl+VrEg= +github.com/gdamore/tcell/v2 v2.6.0 h1:OKbluoP9VYmJwZwq/iLb4BxwKcwGthaa1YNBJIyCySg= +github.com/gdamore/tcell/v2 v2.6.0/go.mod h1:be9omFATkdr0D9qewWW3d+MEvl5dha+Etb5y65J2H8Y= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU= +github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/rivo/tview v0.0.0-20230916092115-0ad06c2ea3dd h1:5fv4woBUz69TNaDvJl19bFdMiDdhdGKtYmzZOk6pGVY= +github.com/rivo/tview v0.0.0-20230916092115-0ad06c2ea3dd/go.mod h1:nVwGv4MP47T0jvlk7KuTTjjuSmrGO4JF0iaiNt4bufE= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.3 h1:utMvzDsuh3suAEnhH0RdHmoPbU648o6CvXxTx4SBMOw= +github.com/rivo/uniseg v0.4.3/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I= +github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/exp v0.0.0-20230905200255-921286631fa9 h1:GoHiUyI/Tp2nVkLI2mCxVkOjsbSXD66ic0XW0js0R9g= +golang.org/x/exp v0.0.0-20230905200255-921286631fa9/go.mod h1:S2oDrQGGwySpoQPVqRShND87VCbxmc6bL1Yd2oYrm6k= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE= +golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.12.0 h1:/ZfYdc3zq+q02Rv9vGqTeSItdzZTSNDmfTi0mBAuidU= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/main.go b/main.go new file mode 100644 index 0000000..35444ce --- /dev/null +++ b/main.go @@ -0,0 +1,9 @@ +package main + +import ( + cmd "github.com/paololazzari/play/cmd" +) + +func main() { + cmd.Execute() +} diff --git a/src/ui/ui.go b/src/ui/ui.go new file mode 100644 index 0000000..ae93dff --- /dev/null +++ b/src/ui/ui.go @@ -0,0 +1,513 @@ +package ui + +import ( + "bufio" + + "io/ioutil" + "os" + "path/filepath" + "strings" + "unicode/utf8" + + "github.com/gdamore/tcell/v2" + program "github.com/paololazzari/play/src/util" + "github.com/rivo/tview" + "golang.org/x/exp/slices" +) + +// Colors for UI +const ( + playTitleColor = tcell.ColorSteelBlue + playBorderColor = tcell.ColorSteelBlue + titleColor = tcell.ColorCadetBlue + borderColor = tcell.ColorCadetBlue +) + +// User interface +type UI struct { + App *tview.Application + Label string + CommandText *tview.TextView + OptionsInput *tview.InputField + EndOptionsText *tview.TextView + OpeningQuoteText *tview.TextView + ArgumentsInput *tview.InputField + ArgumentsInputWide *tview.TextArea + ClosingQuoteText *tview.TextView + PaddingText *tview.TextView + FileOptionsStdin string + FileOptionsText *tview.TextView + FileOptionsTreeNode *tview.TreeNode + FileOptionsTreeView *tview.TreeView + FileOptionsInputMap map[string]bool + FileOptionsInputSlice []string + OutputView *tview.TextView + FileView *tview.TextView + Flex *tview.Flex + ActiveInput **tview.InputField +} + +// Returns the TextView with the command itself +func commandText(label string) *tview.TextView { + return tview.NewTextView(). + SetText(" > " + label). + SetTextColor(titleColor) +} + +// Returns the InputField for the command options +func optionsInput() *tview.InputField { + return tview.NewInputField(). + SetLabel(""). + SetFieldBackgroundColor(tcell.ColorDefault). + SetPlaceholder(""). + SetPlaceholderTextColor(tcell.ColorDefault). + SetPlaceholderStyle(tcell.StyleDefault) +} + +// Returns the TextView with the separator +func endOptionsText() *tview.TextView { + return tview.NewTextView(). + SetText(" -- "). + SetTextColor(titleColor) +} + +// Returns the TextView with the opening single quote +func openingQuoteText() *tview.TextView { + return tview.NewTextView(). + SetText("'") +} + +// Returns the InputField for the positional arguments +func argumentsInput() *tview.InputField { + return tview.NewInputField(). + SetPlaceholder(""). + SetFieldBackgroundColor(tcell.ColorDefault). + SetPlaceholderTextColor(tcell.ColorDefault). + SetPlaceholderStyle(tcell.StyleDefault) +} + +// Returns the TextArea for the positional arguments +func argumentsInputWide() *tview.TextArea { + t := tview.NewTextArea() + t.SetBorder(true) + t.SetTitle(" Positional arguments ") + t.SetTitleColor(titleColor) + t.SetBorderColor(borderColor) + return t +} + +// Returns the TextView for the closing single quote +func closingQuoteText() *tview.TextView { + return tview.NewTextView(). + SetText("'") +} + +// Returns the TextView used for padding +func paddingText() *tview.TextView { + return tview.NewTextView() +} + +// Returns the TextView for the input files +func fileOptionsText() *tview.TextView { + return tview.NewTextView(). + SetText("") +} + +// Returns the TreeNode used for file picker +func fileOptionsTreeNode() *tview.TreeNode { + return tview.NewTreeNode(".") +} + +// Returns the TreeView used for file picker +func fileOptionsTreeView() *tview.TreeView { + t := tview.NewTreeView() + t.SetBorder(true) + t.SetTitle(" File picker ") + t.SetTitleColor(titleColor) + t.SetBorderColor(borderColor) + return t +} + +// Returns the TextView used for output +func outputView() *tview.TextView { + t := tview.NewTextView(). + SetDynamicColors(true) + t.SetBorder(true) + t.SetTitle(" Output ") + t.SetTitleColor(titleColor) + t.SetBorderColor(borderColor) + return t +} + +// Returns the TextView used for file view +func fileView() *tview.TextView { + t := tview.NewTextView(). + SetDynamicColors(true) + t.SetBorder(true) + t.SetTitle(" File view ") + t.SetTitleColor(titleColor) + t.SetBorderColor(borderColor) + return t +} + +// Returns the Flex used for layout +func flex() *tview.Flex { + return tview.NewFlex() +} + +// Helper function to keep unique, sorted list of selected files +func updateFileOptionsInput(m map[string]bool, a *[]string, file string) { + if m[file] { + delete(m, file) + for i, v := range *a { + if file == v { + *a = slices.Delete(*a, i, i+1) + } + } + } else { + *a = append(*a, file) + m[file] = true + } +} + +// Helper function to return the string used as file inputs +func getFileOptionsText(a *[]string) string { + var sb strings.Builder + + for _, v := range *a { + sb.WriteString(v) + sb.WriteString(" ") + } + return strings.TrimSpace(sb.String()) +} + +// UI constructor +func NewUI(label string, stdin string) *UI { + ui := &UI{ + App: tview.NewApplication(), + Label: label, + CommandText: commandText(label), + OptionsInput: optionsInput(), + EndOptionsText: endOptionsText(), + OpeningQuoteText: openingQuoteText(), + ArgumentsInput: argumentsInput(), + ArgumentsInputWide: argumentsInputWide(), + ClosingQuoteText: closingQuoteText(), + PaddingText: paddingText(), + FileOptionsStdin: stdin, + FileOptionsText: fileOptionsText(), + FileOptionsTreeNode: fileOptionsTreeNode(), + FileOptionsTreeView: fileOptionsTreeView(), + FileOptionsInputMap: make(map[string]bool), + FileOptionsInputSlice: []string{}, + OutputView: outputView(), + FileView: fileView(), + Flex: flex(), + ActiveInput: nil, + } + return ui +} + +// Helper function for evaluating expressions +func (ui *UI) evaluateExpression() func() { + return func() { + var sb strings.Builder + sb.WriteString(ui.Label) + sb.WriteString(" ") + sb.WriteString(ui.OptionsInput.GetText()) + sb.WriteString(" -- ") + sb.WriteString(ui.OpeningQuoteText.GetText(false)) + sb.WriteString(ui.ArgumentsInput.GetText()) + sb.WriteString(ui.ClosingQuoteText.GetText(false)) + sb.WriteString(" ") + if t := ui.FileOptionsText.GetText(false); t != "" { + if len(ui.FileOptionsStdin) > 0 && len(ui.FileOptionsInputSlice) == 0 { + sb.WriteString("<<<") + sb.WriteString("'") + sb.WriteString(ui.FileOptionsStdin) + sb.WriteString("'") + } else { + sb.WriteString(t) + } + } + out, _ := program.Run(sb.String()) + ui.OutputView.SetText(out) + } +} + +// Callback function for InputField +func (ui *UI) changedInputField() func(string) { + return func(text string) { + go ui.App.QueueUpdateDraw(ui.evaluateExpression()) + } +} + +// Callback function for TextView +func (ui *UI) changedText() func() { + return func() { + go ui.App.QueueUpdateDraw(ui.evaluateExpression()) + } +} + +// Helper function for populating nodes of TreeNode +func add(target *tview.TreeNode, path string, ui *UI) { + files, err := ioutil.ReadDir(path) + if err != nil { + panic(err) + } + for _, file := range files { + node := tview.NewTreeNode(file.Name()) + + // set custom reference with full path + node.SetReference(filepath.Join(path, file.Name())) + + if file.IsDir() { + node.SetColor(tcell.ColorGreen) + target.AddChild(node) + } else { + // only add text files https://stackoverflow.com/a/75940070/3390419 + f, _ := os.Open(file.Name()) + scanner := bufio.NewScanner(f) + scanner.Split(bufio.ScanLines) + scanner.Scan() + if utf8.ValidString(string(scanner.Text())) { + target.AddChild(node) + } + } + } +} + +// Function for configuring OptionsInput InputField +func (ui *UI) configOptionsInput() { + ui.OptionsInput.SetChangedFunc(ui.changedInputField()) + ui.OptionsInput.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyTab: + ui.App.SetFocus(ui.ArgumentsInput) + case tcell.KeyBacktab: + ui.App.SetFocus(ui.FileOptionsTreeView) + case tcell.KeyEnter: + ui.ActiveInput = &ui.OptionsInput + ui.App.SetFocus(ui.OutputView) + case tcell.KeyRune: + ui.OutputView.ScrollToBeginning() + } + return event + }) +} + +// Function for configuring ArgumentsInput InputField +func (ui *UI) configArgumentsInput() { + ui.ArgumentsInput.SetChangedFunc(ui.changedInputField()) + ui.ArgumentsInput.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyRune: + ui.OutputView.ScrollToBeginning() + case tcell.KeyTab: + ui.App.SetFocus(ui.FileOptionsTreeView) + case tcell.KeyBacktab: + ui.App.SetFocus(ui.OptionsInput) + case tcell.KeyEnter: + ui.ActiveInput = &ui.ArgumentsInput + ui.App.SetFocus(ui.OutputView) + case tcell.KeyCtrlSpace: + if ui.OpeningQuoteText.GetText(false) == "'" { + ui.OpeningQuoteText.SetText("\"") + ui.ClosingQuoteText.SetText("\"") + } else { + ui.OpeningQuoteText.SetText("'") + ui.ClosingQuoteText.SetText("'") + } + case tcell.KeyCtrlO: + ui.ArgumentsInputWide.SetText(ui.ArgumentsInput.GetText(), false) + ui.App.SetRoot(ui.ArgumentsInputWide, true). + SetFocus(ui.ArgumentsInputWide) + } + return event + }) + +} + +// Function for configuring ArgumentsInputWide InputField +func (ui *UI) configArgumentsInputWide() { + ui.ArgumentsInputWide.SetChangedFunc(ui.changedText()) + + ui.ArgumentsInputWide.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyCtrlO: + ui.App.SetRoot(ui.Flex, true). + SetFocus(ui.ArgumentsInput) + ui.ArgumentsInput.SetText(ui.ArgumentsInputWide.GetText()) + } + return event + }) + ui.ArgumentsInputWide.SetBorder(true) + ui.ArgumentsInputWide.SetBorderColor(playBorderColor) +} + +// Function for configuring FileOptionsText TextView +func (ui *UI) configFileOptionsInput() { + ui.FileOptionsText.SetChangedFunc(ui.changedText()) + + if len(ui.FileOptionsStdin) > 0 { + ui.FileOptionsText.SetText(ui.FileOptionsStdin) + } + ui.FileOptionsText.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyTab: + ui.App.SetFocus(ui.OptionsInput) + case tcell.KeyBacktab: + ui.App.SetFocus(ui.ArgumentsInput) + case tcell.KeyEnter: + ui.App.SetFocus(ui.OutputView) + case tcell.KeyDown: + ui.App.SetFocus(ui.FileOptionsTreeView) + case tcell.KeyRune: + return nil + } + return event + }) +} + +// Function for configuring FileOptionsTreeNode TreeNode +func (ui *UI) configFileOptionsTreeNode() { + rootDir := "." + ui.FileOptionsTreeNode = tview.NewTreeNode(rootDir) + add(ui.FileOptionsTreeNode, rootDir, ui) +} + +// Function for configuring FileOptionsTreeView TreeView +func (ui *UI) configFileOptionsTreeView() { + ui.FileOptionsTreeView.SetRoot(ui.FileOptionsTreeNode).SetCurrentNode(ui.FileOptionsTreeNode) + defaultColor := ui.FileOptionsTreeNode.GetColor() + + ui.FileOptionsTreeView.SetSelectedFunc(func(node *tview.TreeNode) { + reference := node.GetReference() + + if reference == nil { + return + } + if stat, _ := os.Stat(reference.(string)); !stat.IsDir() { + if node.GetColor() == tcell.ColorRed { + node.SetColor(defaultColor) + } else { + node.SetColor(tcell.ColorRed) + } + // when a file is selected, update the sorted, unique list of files + updateFileOptionsInput(ui.FileOptionsInputMap, &ui.FileOptionsInputSlice, reference.(string)) + ui.FileOptionsText.SetText(getFileOptionsText(&ui.FileOptionsInputSlice)) + ui.OutputView.ScrollToBeginning() + return + } + children := node.GetChildren() + if len(children) == 0 { + path := reference.(string) + add(node, path, ui) + } else { + node.SetExpanded(!node.IsExpanded()) + } + }) + + ui.FileOptionsTreeView.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyEsc: + ui.App.SetFocus(ui.ArgumentsInput) + case tcell.KeyBacktab: + ui.App.SetFocus(ui.ArgumentsInput) + case tcell.KeyTab: + ui.App.SetFocus(ui.OptionsInput) + + case tcell.KeyCtrlO: + if ui.FileOptionsTreeView.GetCurrentNode() == ui.FileOptionsTreeView.GetRoot() { + return event + } + file, err := os.ReadFile(ui.FileOptionsTreeView.GetCurrentNode().GetReference().(string)) + if err == nil { + ui.FileView.SetText(string(file)) + ui.App.SetRoot(ui.FileView, true). + SetFocus(ui.FileView) + } + } + + return event + }) +} + +// Function for configuring OutputView TextView +func (ui *UI) configOutputView() { + ui.OutputView.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + if event.Key() == tcell.KeyEsc { + ui.App.SetFocus(*ui.ActiveInput) + } + return event + }) +} + +// Function for configuring FileView TextView +func (ui *UI) configFileView() { + ui.FileView.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + key := event.Key() + switch key { + case tcell.KeyCtrlO: + ui.App.SetRoot(ui.Flex, true). + SetFocus(ui.FileOptionsTreeView) + } + return event + }) +} + +// Function for configuring Flex Flex +func (ui *UI) configFlex() { + ui.Flex.AddItem(tview.NewFlex().SetDirection(tview.FlexRow). + AddItem(tview.NewBox(), 2, 1, false). + AddItem(tview.NewFlex().SetDirection(tview.FlexColumn). + AddItem(ui.CommandText, len(ui.Label)+4, 1, false). + AddItem(ui.OptionsInput, 17, 1, false). + AddItem(ui.EndOptionsText, 4, 1, false). + AddItem(ui.OpeningQuoteText, 1, 1, false). + AddItem(ui.ArgumentsInput, 22, 1, false). + AddItem(ui.ClosingQuoteText, 1, 1, false). + AddItem(ui.PaddingText, 1, 1, false). + AddItem(ui.FileOptionsText, 0, 1, false). + AddItem(tview.NewBox(), 2, 1, false), 3, 1, false). + AddItem(tview.NewFlex().SetDirection(tview.FlexColumn). + AddItem(ui.OutputView, 0, 10, false). + AddItem(ui.FileOptionsTreeView, 0, 2, false), 0, 1, false), 0, 1, false) + ui.Flex.SetBorder(true) + ui.Flex.SetTitle(" play ") + ui.Flex.SetTitleColor(playTitleColor) + ui.Flex.SetBorderColor(playBorderColor) + +} + +// Initialize UI +func (ui *UI) InitUI() error { + + ui.configOptionsInput() + ui.configArgumentsInput() + ui.configArgumentsInputWide() + ui.configFileOptionsInput() + ui.configFileOptionsTreeNode() + ui.configFileOptionsTreeView() + ui.configOutputView() + ui.configFileView() + ui.configFlex() + + ui.App.SetRoot(ui.Flex, true). + SetFocus(ui.OptionsInput) + + return nil +} + +// Run the application +func (ui *UI) Run() error { + if err := ui.App.Run(); err != nil { + panic(err) + } + return nil +} diff --git a/src/util/program.go b/src/util/program.go new file mode 100644 index 0000000..6723338 --- /dev/null +++ b/src/util/program.go @@ -0,0 +1,33 @@ +package program + +import ( + "bytes" + "os/exec" + "runtime" +) + +// Execute the given command in either bash or powershell depending on the detected os +func shellout(command string, silent bool) (string, string, error) { + var stdout bytes.Buffer + var stderr bytes.Buffer + cmd := &exec.Cmd{} + if runtime.GOOS == "windows" { + cmd = exec.Command("powershell", "-command", command) + } else { + cmd = exec.Command("bash", "-c", command) + } + cmd.Stdout = &stdout + cmd.Stderr = &stderr + err := cmd.Run() + return stdout.String(), stderr.String(), err +} + +func Run(command string) (res string, err error) { + + stdout, stderr, err := shellout(command, true) + if err != nil { + return stderr, nil + } + + return stdout, nil +}