25 Commits

Author SHA1 Message Date
058b6ba8df Update backend 2024-08-23 17:27:08 -04:00
87af913c4b Add readme for fallback icon set assets 2024-08-23 13:27:04 -04:00
9727363b7f Convert fallback icon set to indexed color 2024-08-23 13:22:21 -04:00
8c647d118d Improve doc comments for ApplicationSystem*Dirs 2024-08-23 02:27:49 -04:00
27678b36b9 Improve README.md 2024-08-23 02:23:04 -04:00
1e92134a38 Move config spec into a README.md file for the config package. 2024-08-23 01:50:30 -04:00
0ebf3ff4cc Make sure File is an io.WriterTo 2024-08-23 01:16:17 -04:00
81bd635b09 Improve doc comment for GlobalConfig 2024-08-23 01:14:08 -04:00
4b29820452 Add accessor for global config 2024-08-23 01:12:02 -04:00
f512deb96e Icons and styles use xyz.holanet.Nasin config 2024-08-23 01:10:54 -04:00
a69c726482 Fixed diffing thinking orphaned keys were real 2024-08-22 20:27:22 -04:00
ed77634a50 Add flag to stop re-parsing the user file when we already know its
contents
2024-08-22 20:10:12 -04:00
e489a12a28 I didnt save the file :P 2024-08-22 19:55:10 -04:00
06a593df25 Add warning about disk writes/reads to Config 2024-08-22 19:54:05 -04:00
a952490188 Config impl now diffs files and broadcasts events 2024-08-22 19:50:35 -04:00
1f5cb683fb Add more code for creating/processing diffs 2024-08-22 19:29:20 -04:00
b4328edd73 Add config.File.Diff to diff two config files 2024-08-22 19:13:00 -04:00
a8878e1e20 Add Equals method to config.Value 2024-08-22 16:31:16 -04:00
656be379e4 Fix goroutine issues with config 2024-08-22 16:03:05 -04:00
279471a554 Add partial config implementation
Progress on #3
2024-08-22 13:38:12 -04:00
d2672816cd Add system dirs to path.go 2024-08-22 13:37:38 -04:00
92deac2d56 Windows must be manually managed through the WaitFor function
Closes #5
2024-08-20 23:20:30 -04:00
35636e9ca3 Add Application.Stop
Closes #6
2024-08-19 22:27:09 -04:00
4fa29f2719 Fallback icon set now has general MIME icons support
Specifically, it supports all the XDG x-generic icons.
2024-08-19 03:18:37 -04:00
894f34e3ef Improve fallback icon set 2024-08-18 15:31:10 -04:00
24 changed files with 1551 additions and 80 deletions

View File

@@ -2,12 +2,79 @@
[![Go Reference](https://pkg.go.dev/badge/git.tebibyte.media/tomo/nasin.svg)](https://pkg.go.dev/git.tebibyte.media/tomo/nasin)
Nasin provides an easy way to write applications with Tomo. To get started, take
a look at the [examples](examples) directory and the
Nasin builds an application framework on top of Tomo to ease and encourage the
development of consistent and stable application software. It has these
wonderful features, and more:
- Use the Application interface to create applications with relatively low
boilerplate
- CLI argument parsing and URI opening
- Automatic setup/teardown of the backend
- Advanced configuration system that can watch config files for changes
- Default style and icon set, as well as a fully featured stylesheet language
for creating custom styles, and support for XDG icon themes
## Getting Started
Here is a basic "hello world" application, with explanations as comments:
```go
package main
import "image"
import "git.tebibyte.media/tomo/nasin"
import "git.tebibyte.media/tomo/objects"
import "git.tebibyte.media/tomo/objects/layouts"
func main () {
nasin.RunApplication(new(Application))
}
type Application struct { }
// Describe returns the application's name and ID, and optionally what type of
// application it is.
func (this *Application) Describe () nasin.ApplicationDescription {
return nasin.ApplicationDescription {
// This is the name of the application. New application windows
// will have this as their title by default.
Name: "Example",
// This is a "well-known" name, which typically is a domain name
// owned by the application author.
ID: "com.example.Example",
}
}
// Init performs initial setup of the application. Since this is a single-window
// application that doesn't open any files, we create the window here.
func (this *Application) Init () error {
// Passing an empty rectangle when creating a new window will cause it
// to auto-expand to fit the minimum size of its contents.
window, err := nasin.NewApplicationWindow(this, image.Rectangle { })
if err != nil { return err }
// Here we create a new container with a basic vertical layout, place a
// text label that says "Hello world!" in it, and set it as the root
// object of the window.
window.SetRoot(objects.NewOuterContainer (
layouts.ContractVertical,
objects.NewLabel("Hello world!")))
window.SetVisible(true)
// Nasin will not exit until all windows it is "waiting for" have
// been closed.
nasin.WaitFor(window)
return nil
}
// Stop cleanly closes things like system resources or background tasks. We do
// not have any here, so nothing is done.
func (this *Application) Stop () { }
```
To learn more, take a look at the [examples](examples) directory and the
[online documentation](https://pkg.go.dev/git.tebibyte.media/tomo/nasin).
Related repositories:
## Related Repositories
- [Tomo API](https://git.tebibyte.media/tomo/tomo): The API that all other parts
of the toolkit agree on
- [Objects](https://git.tebibyte.media/tomo/objects): A standard collection of
re-usable objects and other GUI components
- [Backend](https://git.tebibyte.media/tomo/backend): The software responsible
for managing and rendering things behind the scenes

View File

@@ -6,8 +6,10 @@ import "flag"
import "image"
import "strings"
import "net/url"
import "path/filepath"
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/objects"
import "git.tebibyte.media/tomo/nasin/config"
import "git.tebibyte.media/tomo/nasin/internal/registrar"
// Application represents an application object.
@@ -15,9 +17,12 @@ type Application interface {
// Describe returns a description of the application.
Describe () ApplicationDescription
// Init performs the initial setup of the application. This behavior
// should return a window if it creates one.
Init () (tomo.Window, error)
// Init performs the initial setup of the application.
Init () (error)
// Stop stops the application and does not return until all ongoing
// operations have been completely shut down.
Stop ()
}
// ApplicationURLOpener is an application that can open a URL.
@@ -30,15 +35,11 @@ type ApplicationURLOpener interface {
//
// Applications should support the file:// scheme at the very least, and
// should also support others like http:// and https:// if possible.
//
// This behavior should return a window if it creates one.
OpenURL (*url.URL) (tomo.Window, error)
OpenURL (*url.URL) error
// OpenNone is called when the application is launched without any URLs
// to open. The application may create some sort of default starting
// window, or do nothing. This behavior should return a window if it
// creates one.
OpenNone () (tomo.Window, error)
// to open.
OpenNone () error
}
// ApplicationFlagAdder is an application that supports reading command line
@@ -143,27 +144,59 @@ func RunApplication (application Application) {
}
flag.Parse()
// open config
globalConfig, err := ApplicationConfig(GlobalApplicationDescription())
if err != nil { log.Fatalln("nasin: could not open config:", err) }
currentGlobalConfig = globalConfig
defer func () {
globalConfig.Close()
currentGlobalConfig = nil
} ()
styleConfigKey := "Style"
iconSetConfigKey := "IconSet"
// registry
// TODO: rebuild registry around the config
reg := new(registrar.Registrar)
backend, err := reg.SetBackend()
if err != nil { log.Fatalln("nasin: could not register backend:", err) }
err = reg.SetTheme()
if err != nil { log.Fatalln("nasin: could not set theme:", err) }
err = reg.SetIconSet()
if err != nil { log.Fatalln("nasin: could not set icon set:", err) }
err = reg.SetFaceSet()
if err != nil { log.Fatalln("nasin: could not set face set:", err) }
window, err := application.Init()
updateStyle := func () {
value, err := globalConfig.GetString(styleConfigKey, "")
if err != nil { log.Fatalln("nasin: could not set theme:", err) }
err = reg.SetStyle(value)
if err != nil { log.Fatalln("nasin: could not set theme:", err) }
}
updateIconSet := func () {
value, err := globalConfig.GetString(iconSetConfigKey, "")
if err != nil { log.Fatalln("nasin: could not set icon set:", err) }
err = reg.SetIconSet(value)
if err != nil { log.Fatalln("nasin: could not set icon set:", err) }
}
updateStyle()
updateIconSet()
globalConfig.OnChange(func (key string) {
switch key {
case styleConfigKey: updateStyle()
case iconSetConfigKey: updateIconSet()
}
})
// init application
err = application.Init()
if err != nil { log.Fatalln("nasin: could not run application:", err) }
manageWindow(window)
// open URLs
args := flag.Args()
applicationOpenUrls(application, args...)
if windows > 0 {
if manager.count > 0 {
err = backend.Run()
if err != nil { log.Fatalln("nasin: could not run application:", err) }
}
application.Stop()
}
// NewApplicationWindow creates a window for an application. It will
@@ -181,17 +214,26 @@ func NewApplicationWindow (application Application, bounds image.Rectangle) (tom
return window, nil
}
var windows int
// ApplicationConfig opens a new config for the specified application. It must
// be closed when it is no longer needed.
func ApplicationConfig (app ApplicationDescription) (config.ConfigCloser, error) {
user, err := ApplicationUserConfigDir(app)
if err != nil { return nil, err }
user = filepath.Join(user, "config.conf")
system, err := ApplicationSystemConfigDirs(app)
if err != nil { return nil, err }
for index, path := range system {
system[index] = filepath.Join(path, "config.conf")
}
return config.NewConfig(user, system...)
}
func manageWindow (window tomo.Window) {
if window == nil { return }
windows ++
window.OnClose(func () {
windows --
if windows < 1 {
tomo.Stop()
}
})
var currentGlobalConfig config.Config
// GlobalConfig returns the global config. It contains options that apply to
// Tomo/Nasin itself, such as the style sheet and the icon set. This is managed
// by Nasin and must not be closed by the application.
func GlobalConfig () config.Config {
return currentGlobalConfig
}
func errorPopupf (title, format string, v ...any) func (func ()) {
@@ -203,7 +245,7 @@ func errorPopupf (title, format string, v ...any) func (func ()) {
callback)
if err != nil { log.Fatal(err) }
dialog.SetVisible(true)
manageWindow(dialog)
WaitFor(dialog)
}
}
@@ -217,12 +259,11 @@ func applicationOpenUrls (app Application, args ...string) {
}
openNone := func () bool {
window, err := application.OpenNone()
err := application.OpenNone()
if err != nil {
log.Fatalf("nasin: could not open main window: %v", err)
return false
}
manageWindow(window)
return true
}
@@ -242,7 +283,7 @@ func applicationOpenUrls (app Application, args ...string) {
if ur.Scheme == "" {
ur.Scheme = "file"
}
window, err := application.OpenURL(ur)
err = application.OpenURL(ur)
if err != nil {
errorPopupf(
"Could Not Open URL",
@@ -254,7 +295,6 @@ func applicationOpenUrls (app Application, args ...string) {
}
})
}
manageWindow(window)
}
}

78
config/README.md Normal file
View File

@@ -0,0 +1,78 @@
# config
Package config provides a configuration system for applications.
## Config File Location
Config files are stored in standard operating system locations. Each application
has exactly one user-level config directory within the user-level config
location, and a system-level subdirectory in each of the system-level config
locations (if applicable). Each subdirectory bears the application's well-known
name as specified in ApplicationDescription. Each subdirectory contains a file
called config.conf, which is where the actual config data is stored.
The user-level configuration file takes precendence over system configuration
files, and system configuration files take precedence over eachother depending
on what order they are specified in. How they are specified depends on the
operating system.
### Linux, Most Unixes
In terms of the XDG Base Directory Specification, an application with the
well-known name com.example.Example would have its config files stored at
`$XDG_CONFIG_DIRS/com.example.Example/config.conf`. On most systems where this
specification is applicable, this will result in a file at
`/etc/xdg/com.example.Example/config.conf` and another at
`$HOME/.config/com.example.Example/config.conf`. The location for config files
on systems that do not make use of this specification is yet to be determined.
## Config File Format
The general format of the file is as follows:
- Encoded in UTF-8
- Consists of lines, separated by \n, or \r\n
- Lines can be any of these:
- Blank line: has only whitespace
- Comment: begins with a '#'
- Entry: a key/value pair separated by an '=' sign
### Entries
For entries, all whitespace on either side of the '=' sign, the key, or the
value is ignored. The key may contain any letter or digit, as well as '-' and
'.'. The value is always identified by its first rune (after the preliminary
whitespace of course) and can be one of:
- String
- Number
- Bool
#### String
A string can be either double-quoted, or any string of runes not identifiable
as any other kind of value. Quoted strings are always unquoted when they are
read. Either way, these escape sequences are supported, and resolved when they
are read:
- '\\\\': a literal backslash
- '\a': alert, bell
- '\b': backspace
- '\t': horizontal tab
- '\n': line feed
- '\v': vertical tab
- '\f': form feed
- '\r': carriage return
- '\\"': double quote
Be aware that some unquoted strings, within reason, are subject to being read
as some other value in the future. For example, if there were suddenly a
third boolean value called glorble, the unquoted string glorble would be read
as a boolean value instead of a string.
#### Number
A number is a floating point value. It can be of the form:
- Inf: positive infinity
- -Inf: negative infinity
- NaN: "not a number"
- [0-9]+: a whole number
- [0-9]+\.[0-9]*: a fractional number
#### Bool
A bool is a boolean value. It can be one of:
- true
- false

159
config/config.go Normal file
View File

@@ -0,0 +1,159 @@
// Package config provides a configuration system for applications.
package config
import "fmt"
import "math"
import "strconv"
import "git.tebibyte.media/tomo/tomo/event"
type configError string;
func (err configError) Error () string { return string(err) }
const (
// ErrClosed is returned when Get/Set/Reset is called after the config
// has been closed.
ErrClosed = configError("attempt to access a closed config")
// ErrNonexistentEntry is returned when an entry was not found.
ErrNonexistentEntry = configError("nonexistent entry")
// ErrMalformedEntry is returned when a config entry could not be
// parsed.
ErrMalformedEntry = configError("malformed entry")
// ErrMalformedKey is returned when a key has invalid runes.
ErrMalformedKey = configError("malformed key")
// ErrMalformedValue is returned when a value could not be parsed.
ErrMalformedValue = configError("malformed value")
// ErrMalformedString is returned when a string value could not be
// parsed.
ErrMalformedStringValue = configError("malformed string value")
// ErrMalformedNumber is returned when a number value could not be
// parsed.
ErrMalformedNumberValue = configError("malformed number value")
// ErrMalformedBool is returned when a boolean value could not be
// parsed.
ErrMalformedBoolValue = configError("malformed bool value")
// ErrMalformedEscapeSequence us returned when an escape sequence could
// not be parsed.
ErrMalformedEscapeSequence = configError("malformed escape sequence")
)
// Config provides access to an application's configuration, and can notify an
// application of changes to it.
type Config interface {
// Get gets a value, first considering the user-level config file, and
// then falling back to system level config files. If the value could
// not be found anywhere, the specified fallback value is returned. If
// the key is invalid, it returns nil, ErrMalformedKey.
Get (key string, fallback Value) (Value, error)
// GetString is like Get, but will only return strings. If the value is
// not a string, it will return fallback.
GetString (key string, fallback string) (string, error)
// GetNumber is like Get, but will only return numbers. If the value is
// not a number, it will return fallback.
GetNumber (key string, fallback float64) (float64, error)
// GetBool is like Get, but will only return booleans. If the value is
// not a boolean, it will return fallback.
GetBool (key string, fallback bool) (bool, error)
// Set sets a value in the user-level config file. If the key is
// invalid, it returns ErrMalformedKey. Note that calling this behavior
// *will* cause a write to disk, and a read from disk for whatever is
// watching the user file.
Set (key string, value Value) error
// Reset removes the value from the user-level config file, resetting it
// to what is described by the system-level config files. If the key is
// invalid, it returns ErrMalformedKey. Note that calling this behavior
// *will* cause a write to disk if successful , and a read from disk for
// whatever is watching the user file.
Reset (key string) error
// OnChange specifies a function to be called whenever a value is
// changed. The callback is always run within the backend's event loop
// using tomo.Do. This could have been a channel but I didn't want to do
// that to people.
OnChange (func (key string)) event.Cookie
}
// ConfigCloser is a config with a Close behavior, which stops watching the
// config file and causes any subsequent sets/gets to return errors. Anything
// that receives a ConfigCloser must close it when done.
type ConfigCloser interface {
Config
// Close closes the config, causing it to stop watching for changes.
// Reads or writes to the config after this will return an error.
Close () error
}
var negativeZero = math.Copysign(0, -1)
// Value is a config value. Its String behavior produces a lossless and
// syntactically valid representation of the value.
type Value interface {
value ()
fmt.Stringer
Equals (Value) bool
}
// ValueString is a string value.
type ValueString string
var _ Value = ValueString("")
func (ValueString) value () { }
func (value ValueString) Equals (other Value) bool {
other, ok := other.(ValueString)
return ok && value == other
}
func (value ValueString) String () string {
return fmt.Sprintf("\"%s\"", escape(string(value)))
}
// ValueNumber is a number value.
type ValueNumber float64
var _ Value = ValueNumber(0)
func (ValueNumber) value () { }
func (value ValueNumber) Equals (other Value) bool {
other, ok := other.(ValueNumber)
return ok && value == other
}
func (value ValueNumber) String () string {
number := float64(value)
// the requirements I wrote said lossless in all cases. here's lossless
// in all cases!
switch {
case math.IsInf(number, 0):
if math.Signbit(number) {
return "-Inf"
} else {
return "Inf"
}
case math.IsNaN(number):
return "NaN"
case number == 0, number == negativeZero:
if math.Signbit(number) {
return "-0"
} else {
return "0"
}
case math.Round(number) == number:
return strconv.FormatInt(int64(number), 10)
default:
return strconv.FormatFloat(number, 'f', -1, 64)
}
}
// ValueBool is a boolean value.
var _ Value = ValueBool(false)
type ValueBool bool
func (ValueBool) value () { }
func (value ValueBool) Equals (other Value) bool {
other, ok := other.(ValueBool)
return ok && value == other
}
func (value ValueBool) String () string {
if value {
return "true"
} else {
return "false"
}
}

97
config/escape.go Normal file
View File

@@ -0,0 +1,97 @@
package config
import "fmt"
import "strings"
// import "unicode"
var escapeCodeToRune = map[rune] rune {
'\\': '\\',
'a': '\a',
'b': '\b',
't': '\t',
'n': '\n',
'v': '\v',
'f': '\f',
'r': '\r',
'"': '"',
}
var runeToEscapeCode = map[rune] rune { }
func init () {
for code, char := range escapeCodeToRune {
runeToEscapeCode[char] = code
}
}
func escape (str string) string {
builder := strings.Builder { }
for _, char := range str {
code, escaped := runeToEscapeCode[char]
switch {
case escaped:
fmt.Fprintf(&builder, "\\%c", code)
// case !unicode.IsPrint(char):
// fmt.Fprintf(&builder, "\\%o", char)
default:
builder.WriteRune(char)
}
}
return builder.String()
}
func unescape (str string) (string, bool) {
runes := []rune(str)
builder := strings.Builder { }
end := func () bool {
return len(runes) < 1
}
next := func () {
if !end() { runes = runes[1:] }
}
for !end() {
if runes[0] == '\\' {
if end() { return "", false }
next()
char, isEscape := escapeCodeToRune[runes[0]]
switch {
case isEscape:
builder.WriteRune(char)
next()
// case isOctalDigit(runes[0]):
// char = 0
// for !end() && isOctalDigit(runes[0]) {
// char *= 8
// char += runes[0] - '0'
// next()
// }
// builder.WriteRune(char)
default:
return "", false
}
} else {
builder.WriteRune(runes[0])
next()
}
}
return builder.String(), true
}
func unquote (str string) (string, bool) {
if len(str) < 2 { return "", false }
if firstRune(str) != '"' { return "", false }
if str[len(str) - 1] != '"' { return "", false }
return str[1:len(str) - 1], true
}
func isOctalDigit (char rune) bool {
return char >= '0' && char <= '7'
}
func firstRune (str string) rune {
for _, char := range str {
return char
}
return 0
}

22
config/escape_test.go Normal file
View File

@@ -0,0 +1,22 @@
package config
import "testing"
func TestEscape (test *testing.T) {
expected := `\\\a\bhello\t\n\vworld!\f\r\"`
got := escape("\\\a\bhello\t\n\vworld!\f\r\"")
if got != expected {
test.Fatalf("expected: [%s]\ngot:[%s]", expected, got)
}
}
func TestUnescape (test *testing.T) {
expected := "\\\a\bhello\t\n\vworld!\f\r\""
got, ok := unescape(`\\\a\bhello\t\n\vworld!\f\r\"`)
if !ok {
test.Fatalf("text could not be unescaped")
}
if got != expected {
test.Fatalf("expected: [%s]\ngot:[%s]", expected, got)
}
}

247
config/file.go Normal file
View File

@@ -0,0 +1,247 @@
package config
import "io"
import "fmt"
import "math"
import "bufio"
import "errors"
import "strconv"
import "strings"
import "unicode"
type line any
type comment string
type entry struct { key string; value Value }
var _ io.WriterTo = new(File)
// File represents a config file. It preserves the order of the lines, as well
// as blank lines and comments.
type File struct {
lines []line
keys map[string] int
}
// NewFile creates a blank file with nothing in it.
func NewFile () *File {
return &File {
keys: make(map[string] int),
}
}
// Parse parses a config file from a reader. This function operates on a
// best-effort basis: A file will always be returned, and any errors encountered
// will be joined together. For a description of the format, see the README.md
// of this package.
func Parse (reader io.Reader) (*File, error) {
file := &File {
keys: make(map[string] int),
}
errs := []error { }
scanner := bufio.NewScanner(reader)
for scanner.Scan() {
text := strings.TrimSpace(scanner.Text())
switch {
case text == "", strings.HasPrefix(text, "#"):
file.lines = append(file.lines, comment(text))
default:
entry, err := parseEntry(text)
if err == nil {
file.keys[entry.key] = len(file.lines)
file.lines = append(file.lines, entry)
} else {
errs = append (errs, err )
}
}
}
errs = append(errs, scanner.Err())
return file, errors.Join(errs...)
}
func parseEntry (str string) (entry, error) {
key, value, ok := strings.Cut(str, "=")
if !ok { return entry { }, ErrMalformedEntry }
key = strings.TrimSpace(key)
if !KeyValid(key) { return entry { }, ErrMalformedKey }
value = strings.TrimSpace(value)
parsedValue, err := ParseValue(value)
if err != nil { return entry { }, err }
return entry { key: key, value: parsedValue }, nil
}
// ParseValue parses a value from a string. For any Value v,
// ParseValue(v.String()) should hold data exactly equal to v. This function
// does not trim whitespace.
func ParseValue (str string) (Value, error) {
first := firstRune(str)
switch {
case str == "":
return ValueString(""), nil
case first == '"':
value, ok := unescape(str)
if !ok { return nil, ErrMalformedEscapeSequence }
value, ok = unquote(value)
if !ok { return nil, ErrMalformedStringValue }
return ValueString(value), nil
case first == '-' || (first >= '0' && first <= '9'):
value, err := strconv.ParseFloat(str, 64)
if err != nil { return nil, ErrMalformedNumberValue }
return ValueNumber(value), nil
case str == "false":
return ValueBool(false), nil
case str == "true":
return ValueBool(true), nil
case str == "Inf":
return ValueNumber(math.Inf(1)), nil
case str == "NaN":
return ValueNumber(math.NaN()), nil
default:
value, ok := unescape(str)
if !ok { return nil, ErrMalformedEscapeSequence }
return ValueString(value), nil
}
}
// Has returns whether the key exists. If the key is invalid, it returns false,
// ErrMalformedKey.
func (this *File) Has (key string) (bool, error) {
if !KeyValid(key) { return false, ErrMalformedKey }
if index, ok := this.keys[key]; ok {
if _, ok := this.lines[index].(entry); ok {
return true, nil
}
}
return false, nil
}
// Get gets the keyed value. If the value is unspecified, it returns nil,
// ErrNonexistentEntry. If the key is invalid, it returns nil, ErrMalformedKey.
func (this *File) Get (key string) (Value, error) {
if !KeyValid(key) { return nil, ErrMalformedKey }
if index, ok := this.keys[key]; ok {
if lin, ok := this.lines[index].(entry); ok {
return lin.value, nil
}
}
return nil, ErrNonexistentEntry
}
// Set sets a value. If the key is invalid, it returns ErrMalformedKey.
func (this *File) Set (key string, value Value) error {
if !KeyValid(key) { return ErrMalformedKey }
ent := entry {
key: key,
value: value,
}
if index, ok := this.keys[key]; ok {
this.lines[index] = ent
return nil
}
this.keys[key] = len(this.lines)
this.lines = append(this.lines, ent)
return nil
}
// Reset removes the value from the file. If the value is set again, it will be
// added back at the same location. Note that because of this, the positions of
// lines are not forgotten until the file is written and reloaded. This is why
// the method is called Reset and not Remove. If the key is invalid, it returns
// ErrMalformedKey.
func (this *File) Reset (key string) error {
if !KeyValid(key) { return ErrMalformedKey }
for index, lin := range this.lines {
if lin, ok := lin.(entry); ok {
if lin.key == key {
this.lines[index] = nil
}
}
}
return nil
}
// Map creates and returns a map of keys to values.
func (this *File) Map () map[string] Value {
mp := make(map[string] Value)
for key, index := range this.keys {
if lin, ok := this.lines[index].(entry); ok {
mp[key] = lin.value
}
}
return mp
}
// Diff returns a set of keys that are different from the other file.
func (this *File) Diff (other *File) map[string] struct { } {
diff := make(map[string] struct { })
// - keys only we have
// - keys we both have, but are different
for key, index := range this.keys {
thisEntry, ok := this.lines[index].(entry)
if !ok { continue }
otherIndex, ok := other.keys[key]
if !ok {
diff[key] = struct { } { }
continue
}
otherEntry, ok := other.lines[otherIndex].(entry)
if !ok {
diff[key] = struct { } { }
continue
}
if !thisEntry.value.Equals(otherEntry.value) {
diff[key] = struct { } { }
}
}
// - keys only they have
for key := range other.keys {
if otherHas, _ := other.Has(key); !otherHas {
continue
}
if thisHas, _ := this.Has(key); !thisHas {
diff[key] = struct { } { }
}
}
return diff
}
// WriteTo writes the data in this file to an io.Writer.
func (this *File) WriteTo (writer io.Writer) (n int64, err error) {
for _, lin := range this.lines {
nint := 0
switch lin := lin.(type) {
case comment:
nint, err = fmt.Fprintln(writer, string(lin))
case entry:
nint, err = fmt.Fprintf(writer, "%s=%v\n", lin.key, lin.value)
}
n += int64(nint)
if err != nil { return n, err }
}
return n, nil
}
// KeyValid returns whether a key contains only valid runes. They are:
// - Letters
// - Digits
// - '-'
// - '.'
func KeyValid (key string) bool {
for _, char := range key {
valid :=
char == '.' ||
char == '-' ||
unicode.IsLetter(char) ||
unicode.IsDigit(char)
if !valid { return false }
}
return true
}

222
config/file_test.go Normal file
View File

@@ -0,0 +1,222 @@
package config
import "math"
import "maps"
import "strings"
import "testing"
func TestParseEntryUnquotedString (test *testing.T) {
testParseEntry(test, "stringValue = Unquoted\\nString", "stringValue", ValueString("Unquoted\nString"))
}
func TestParseEntryQuotedString (test *testing.T) {
testParseEntry(test, "stringValue = \"Quoted\\nString\"", "stringValue", ValueString("Quoted\nString"))
}
func TestParseEntryNumber (test *testing.T) {
testParseEntry(test, "numberValue = -349.29034", "numberValue", ValueNumber(-349.29034))
}
func TestParseEntryNumberInf (test *testing.T) {
testParseEntry(test, "numberValue = Inf", "numberValue", ValueNumber(math.Inf(1)))
}
func TestParseEntryNumberNegativeInf (test *testing.T) {
testParseEntry(test, "numberValue = -Inf", "numberValue", ValueNumber(math.Inf(-1)))
}
func TestParseEntryNumberNaN (test *testing.T) {
testParseEntry(test, "numberValue = NaN", "numberValue", ValueNumber(math.NaN()))
}
func TestParseEntryBoolTrue (test *testing.T) {
testParseEntry(test, "boolValue = true", "boolValue", ValueBool(true))
}
func TestParseEntryBoolFalse (test *testing.T) {
testParseEntry(test, "boolValue = false", "boolValue", ValueBool(false))
}
func TestParseEntryComplexKey (test *testing.T) {
testParseEntry (
test, "--Something.OtherThing...another-Thing-=value",
"--Something.OtherThing...another-Thing-", ValueString("value"))
}
func TestParse (test *testing.T) {
testParse(test,
` thing =something
# comment
otherThing = otherValue
otherThing = otherValue1
otherThing = otherValue2 # not a comment
`,
`thing="something"
# comment
otherThing="otherValue"
otherThing="otherValue1"
otherThing="otherValue2 # not a comment"
`)
}
func TestGetValue (test *testing.T) {
file := parseFileString(test,
`key=askdhj
# some comment
key = value
key1 = 7`)
got, err := file.Get("key")
if err != nil { test.Fatal(err) }
testValueString(test, got, `"value"`)
}
func TestModifyValue (test *testing.T) {
file := parseFileString(test,
`key=askdhj
# some comment
key = value
key1 = 7`)
err := file.Set("key", ValueNumber(324980.2349))
if err != nil { test.Fatal(err) }
testFileString(test, file,
`key="askdhj"
# some comment
key=324980.2349
key1=7
`)
}
func TestResetValue (test *testing.T) {
file := parseFileString(test,
`key=askdhj
# some comment
key = value
key1 = 7`)
err := file.Reset("key")
if err != nil { test.Fatal(err) }
testFileString(test, file,
`# some comment
key1=7
`)
}
func TestDiffNone (test *testing.T) {
str := `
thing = something
otherThing = otherValue
# comment
otherThing = true
otherThing = 234
yetAnotherThing = 0.23498
`
file1 := parseFileString(test, str)
file2 := parseFileString(test, str)
diff := file1.Diff(file2)
if len(diff) != 0 {
test.Fatalf("diff not empty:\n%v", diff)
}
}
func TestDiffReset (test *testing.T) {
file1 := parseFileString(test,
`key4=0
key1=value1
keyToDelete=true
# comment
key2=34`)
file2 := parseFileString(test,
`key1=value2
key2=34
anotherKeyToDelete=false
# comment
key3=0.2`)
file1.Reset("keyToDelete")
file2.Reset("anotherKeyToDelete")
diff := file1.Diff(file2)
correct := map[string] struct { } {
"key1": struct { } { },
"key3": struct { } { },
"key4": struct { } { },
}
if !maps.Equal(diff, correct) {
test.Error("diffs do not match")
test.Errorf("EXPECTED:\n%v", correct)
test.Errorf("GOT:\n%v", diff)
test.Fail()
}
}
func TestDiff (test *testing.T) {
file1 := parseFileString(test,
`key4=0
key1=value1
# comment
key2=34`)
file2 := parseFileString(test,
`key1=value2
key2=34
# comment
key3=0.2`)
diff := file1.Diff(file2)
correct := map[string] struct { } {
"key1": struct { } { },
"key3": struct { } { },
"key4": struct { } { },
}
if !maps.Equal(diff, correct) {
test.Error("diffs do not match")
test.Errorf("EXPECTED:\n%v", correct)
test.Errorf("GOT:\n%v", diff)
test.Fail()
}
}
func testParseEntry (test *testing.T, str string, key string, value Value) {
ent, err := parseEntry(str)
if err != nil { test.Fatal(err) }
if ent.key != key {
test.Fatalf("expected key: [%s]\ngot key: [%s]", key, ent.key)
}
if ent.value.String() != value.String() {
test.Fatalf("expected value: [%s]\ngot value: [%s]", value.String(), ent.value.String())
}
}
func testParse (test *testing.T, str, correct string) {
if correct == "" { correct = str }
testFileString(test, parseFileString(test, str), correct)
}
func parseFileString (test *testing.T, str string) *File {
file, err := Parse(strings.NewReader(str))
if err != nil { test.Fatal(err) }
return file
}
func testFileString (test *testing.T, file *File, correct string) {
got := strings.Builder { }
file.WriteTo(&got)
if got.String() != correct {
test.Error("strings do not match")
test.Errorf("EXPECTED:\n%s", correct)
test.Errorf("GOT:\n%s", got.String())
test.Fail()
}
}
func testValueString (test *testing.T, got Value, correct string) {
if got.String() != correct {
test.Error("strings do not match")
test.Errorf("EXPECTED:\n%s", correct)
test.Errorf("GOT:\n%s", got.String())
test.Fail()
}
}

318
config/impl.go Normal file
View File

@@ -0,0 +1,318 @@
package config
import "os"
import "log"
import "sync"
import "slices"
import "path/filepath"
import "github.com/fsnotify/fsnotify"
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/tomo/event"
// Goroutine model:
// All private methods (except for lockAndProcessEvent) do not lock the config,
// but all public methods do. Private methods may not call public methods.
// Locking must always be method-level, with a call to Lock at the start,
// directly followed by a deferred call to Unlock.
type config struct {
open bool
watcher *fsnotify.Watcher
lock sync.RWMutex
ignoreNextUserUpdate bool
paths struct {
user string
system []string
watching map[string] struct { }
}
data struct {
user *File
system []map[string] Value
}
on struct {
change event.Broadcaster[func (string)]
}
}
// NewConfig creates a new Config using paths to the user-level config file, and
// a set of system config files. These files need not exist: the user-level file
// will be created when Set is called for the first time if it does not exist
// already, and nonexistent system files are simply ignored (unless the Config
// finds them at any point to have been spontaneously created).
//
// The user file is written to when Set is called, and the system files are only
// read from. Values in the user file override those in the system files, and
// system files specified nearer to the start of the vararg list will override
// those farther down.
func NewConfig (user string, system ...string) (ConfigCloser, error) {
conf := new(config)
conf.paths.user = user
conf.paths.system = system
err := conf.init()
if err != nil { return nil, err }
go func () {
for event := range conf.watcher.Events {
conf.lockAndProcessEvent(event)
}
} ()
return conf, nil
}
// this method may only be run in the goroutine spawned by NewConfig.
func (this *config) lockAndProcessEvent (event fsnotify.Event) {
this.lock.Lock()
defer this.lock.Unlock()
if !(event.Has(fsnotify.Write)) { return }
if _, ok := this.paths.watching[event.Name]; !ok { return }
if event.Name == this.paths.user {
if !this.ignoreNextUserUpdate {
previousUser := this.data.user
this.reloadUser()
newUser := this.data.user
this.processUserDiff(newUser.Diff(previousUser))
}
this.ignoreNextUserUpdate = false
} else {
index := slices.Index(this.paths.system, event.Name)
if index > 0 {
previousSystem := this.data.system[index]
this.reloadSystem(index)
newSystem := this.data.system[index]
this.processSystemDiff(index, diffValueMaps(newSystem, previousSystem))
}
}
}
func (this *config) init () error {
watcher, err := fsnotify.NewWatcher()
if err != nil { return err }
this.watcher = watcher
this.paths.watching = make(map[string] struct { })
this.watcher.Add(filepath.Dir(this.paths.user))
this.paths.watching[this.paths.user] = struct { } { }
this.reloadUser()
for index, path := range this.paths.system {
this.watcher.Add(filepath.Dir(path))
this.paths.watching[path] = struct { } { }
this.reloadSystem(index)
}
return nil
}
func (this *config) errIfClosed () error {
if this.open {
return nil
} else {
return ErrClosed
}
}
func (this *config) reloadUser () {
file, err := os.Open(this.paths.user)
if err != nil { return }
defer file.Close()
userFile, err := Parse(file)
if err != nil {
log.Printf("nasin: problems loading user config file %s: %v", this.paths.user, err)
return
}
this.data.user = userFile
}
func (this *config) reloadSystem (index int) {
path := this.paths.system[index]
file, err := os.Open(path)
if err != nil { return }
defer file.Close()
systemFile, err := Parse(file)
if err != nil {
log.Printf("nasin: problems loading system config file %s: %v", path, err)
return
}
this.data.system[index] = systemFile.Map()
}
func (this *config) saveUser () error {
// TODO set some sort of flag to ignore the next inotify event for the
// user file so we dont reload it immediately after. also need to
// broadacast Changed event.
enclosingDir := filepath.Dir(this.paths.user)
err := os.MkdirAll(enclosingDir, 755)
if err != nil { return err }
file, err := os.Create(this.paths.user)
if err != nil { return err }
defer file.Close()
_, err = this.data.user.WriteTo(file)
if err != nil { return err }
this.ignoreNextUserUpdate = true
return nil
}
func (this *config) processUserDiff (changed map[string] struct { }) {
for key := range changed {
// this is the user file, and nothing has precedence over it, so
// the change always matters
this.broadcastChange(key)
}
}
func (this *config) processSystemDiff (index int, changed map[string] struct { }) {
for key := range changed {
// if specified in the user file, the change doesn't matter
if this.data.user != nil {
if has, _ := this.data.user.Has(key); has {
continue
}
}
// if specified in any system files with precedence greater than
// this one, the change doesn't matter
for _, system := range this.data.system[:index] {
if _, has := system[key]; has {
continue
}
}
// the change does matter
this.broadcastChange(key)
}
}
func (this *config) broadcastChange (key string) {
for _, listener := range this.on.change.Listeners() {
tomo.Do(func () { listener(key) })
}
}
func (this *config) get (key string, fallback Value) (Value, error) {
// try user config
if !KeyValid(key) { return nil, ErrMalformedKey }
if this.data.user != nil {
value, err := this.data.user.Get(key)
if err == nil && err != ErrNonexistentEntry {
return value, nil
}
}
// try system configs
for _, config := range this.data.system {
if value, ok := config[key]; ok {
return value, nil
}
}
// use fallback
return fallback, nil
}
func (this *config) Get (key string, fallback Value) (Value, error) {
this.lock.Lock()
defer this.lock.Unlock()
return this.get(key, fallback)
}
func (this *config) Close () error {
this.lock.Lock()
defer this.lock.Unlock()
this.open = false
return this.watcher.Close()
}
func (this *config) GetString (key string, fallback string) (string, error) {
this.lock.Lock()
defer this.lock.Unlock()
value, err := this.get(key, ValueString(fallback))
if err != nil { return "", err }
if value, ok := value.(ValueString); ok {
return string(value), nil
}
return fallback, nil
}
func (this *config) GetNumber (key string, fallback float64) (float64, error) {
this.lock.Lock()
defer this.lock.Unlock()
value, err := this.get(key, ValueNumber(fallback))
if err != nil { return 0, err }
if value, ok := value.(ValueNumber); ok {
return float64(value), nil
}
return fallback, nil
}
func (this *config) GetBool (key string, fallback bool) (bool, error) {
this.lock.Lock()
defer this.lock.Unlock()
value, err := this.get(key, ValueBool(fallback))
if err != nil { return false, err }
if value, ok := value.(ValueBool); ok {
return bool(value), nil
}
return fallback, nil
}
func (this *config) Set (key string, value Value) error {
this.lock.Lock()
defer this.lock.Unlock()
if this.data.user == nil { this.data.user = NewFile() }
err := this.data.user.Set(key, value)
if err != nil { return err }
err = this.saveUser()
if err != nil { return err }
this.broadcastChange(key)
return nil
}
func (this *config) Reset (key string) error {
this.lock.Lock()
defer this.lock.Unlock()
if this.data.user == nil { this.data.user = NewFile() }
err := this.data.user.Reset(key)
if err != nil { return err }
err = this.saveUser()
if err != nil { return err }
this.broadcastChange(key)
return nil
}
func (this *config) OnChange (callback func (string)) event.Cookie {
this.lock.Lock()
defer this.lock.Unlock()
return this.on.change.Connect(callback)
}
func diffValueMaps (first, second map[string] Value) map[string] struct { } {
diff := make(map[string] struct { })
// - keys only first has
// - keys both have, but are different
for key, firstValue := range first {
secondValue, ok := second[key]
if !ok {
diff[key] = struct { } { }
continue
}
if !firstValue.Equals(secondValue) {
diff[key] = struct { } { }
}
}
// - keys only second has
for key := range second {
if _, has := first[key]; !has {
diff[key] = struct { } { }
}
}
return diff
}

53
config/impl_test.go Normal file
View File

@@ -0,0 +1,53 @@
package config
import "maps"
import "testing"
func TestDiffValueMapsNone (test *testing.T) {
str := `
thing = something
otherThing = otherValue
# comment
otherThing = true
otherThing = 234
yetAnotherThing = 0.23498
`
file1 := parseFileString(test, str)
file2 := parseFileString(test, str)
diff := diffValueMaps(file1.Map(), file2.Map())
if len(diff) != 0 {
test.Fatalf("diff not empty:\n%v", diff)
}
}
func TestDiffValueMaps (test *testing.T) {
file1 := parseFileString(test,
`key4=0
key1=value1
# comment
key2=34`)
file2 := parseFileString(test,
`key1=value2
key2=34
# comment
key3=0.2`)
diff := diffValueMaps(file1.Map(), file2.Map())
correct := map[string] struct { } {
"key1": struct { } { },
"key3": struct { } { },
"key4": struct { } { },
}
if !maps.Equal(diff, correct) {
test.Error("diffs do not match")
test.Errorf("EXPECTED:\n%v", correct)
test.Errorf("GOT:\n%v", diff)
test.Fail()
}
}
// TODO we need way more tests!
// need to test watching files. maybe make a temp dir and do it there. remember
// to defer cleaning up the dir and closing of the config.

4
go.mod
View File

@@ -4,10 +4,11 @@ go 1.22.2
require (
git.tebibyte.media/sashakoshka/goparse v0.2.0
git.tebibyte.media/tomo/backend v0.7.0
git.tebibyte.media/tomo/backend v0.7.1
git.tebibyte.media/tomo/objects v0.22.0
git.tebibyte.media/tomo/tomo v0.46.1
git.tebibyte.media/tomo/xdg v0.1.0
github.com/fsnotify/fsnotify v1.7.0
golang.org/x/image v0.11.0
)
@@ -18,4 +19,5 @@ require (
github.com/BurntSushi/graphics-go v0.0.0-20160129215708-b43f31a4a966 // indirect
github.com/jezek/xgb v1.1.1 // indirect
github.com/jezek/xgbutil v0.0.0-20231116234834-47f30c120111 // indirect
golang.org/x/sys v0.5.0 // indirect
)

7
go.sum
View File

@@ -1,8 +1,8 @@
git.tebibyte.media/sashakoshka/goparse v0.2.0 h1:uQmKvOCV2AOlCHEDjg9uclZCXQZzq2PxaXfZ1aIMiQI=
git.tebibyte.media/sashakoshka/goparse v0.2.0/go.mod h1:tSQwfuD+EujRoKr6Y1oaRy74ZynatzkRLxjE3sbpCmk=
git.tebibyte.media/sashakoshka/xgbkb v1.0.0/go.mod h1:pNcE6TRO93vHd6q42SdwLSTTj25L0Yzggz7yLe0JV6Q=
git.tebibyte.media/tomo/backend v0.7.0 h1:12A+IsbwIKCmg4jKjD9xCDz+o7R3X6Yp8cZup+wOGIM=
git.tebibyte.media/tomo/backend v0.7.0/go.mod h1:G3Kh6N2MuiAwsnuPe3h9CwWL65vmmsaqgapA38MPyhk=
git.tebibyte.media/tomo/backend v0.7.1 h1:tWkL5jlX0SLZ3H9dxVrLfW1PCeEe1uhtf1v+RCoge0w=
git.tebibyte.media/tomo/backend v0.7.1/go.mod h1:G3Kh6N2MuiAwsnuPe3h9CwWL65vmmsaqgapA38MPyhk=
git.tebibyte.media/tomo/objects v0.22.0 h1:2t21W32HW2xvPBICqmArVMVWxg9ohhTJw6ChZ0DcdYY=
git.tebibyte.media/tomo/objects v0.22.0/go.mod h1:f5J5tAhO+eN5glVbCJLPSopIeTylXqLgKLVAIg8iAPQ=
git.tebibyte.media/tomo/tomo v0.46.1 h1:/8fT6I9l4TK529zokrThbNDHGRvUsNgif1Zs++0PBSQ=
@@ -17,6 +17,8 @@ github.com/BurntSushi/freetype-go v0.0.0-20160129220410-b763ddbfe298 h1:1qlsVAQJ
github.com/BurntSushi/freetype-go v0.0.0-20160129220410-b763ddbfe298/go.mod h1:D+QujdIlUNfa0igpNMk6UIvlb6C252URs4yupRUV4lQ=
github.com/BurntSushi/graphics-go v0.0.0-20160129215708-b43f31a4a966 h1:lTG4HQym5oPKjL7nGs+csTgiDna685ZXjxijkne828g=
github.com/BurntSushi/graphics-go v0.0.0-20160129215708-b43f31a4a966/go.mod h1:Mid70uvE93zn9wgF92A/r5ixgnvX8Lh68fxp9KQBaI0=
github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
github.com/jezek/xgb v1.1.0/go.mod h1:nrhwO0FX/enq75I7Y7G8iN1ubpSGZEiA3v9e9GyRFlk=
github.com/jezek/xgb v1.1.1 h1:bE/r8ZZtSv7l9gk6nU0mYx51aXrvnyb44892TwSaqS4=
github.com/jezek/xgb v1.1.1/go.mod h1:nrhwO0FX/enq75I7Y7G8iN1ubpSGZEiA3v9e9GyRFlk=
@@ -42,6 +44,7 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
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 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
golang.org/x/sys v0.5.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=

View File

@@ -0,0 +1,7 @@
# assets
These are the assets for the fallback (Wintergreen) icon set. When making edits
to these icons, open both the png and xcf files. When you wish to save your
changes, delete the contents of the png file and paste in the "Icons" layer of
the xcf file, then export the png file and save the xcf file. This is because
the exported pngs use indexed color to save space as they are embedded into
application binaries.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

View File

@@ -6,15 +6,37 @@ import _ "embed"
import _ "image/png"
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/tomo/data"
import "git.tebibyte.media/tomo/tomo/event"
import "git.tebibyte.media/tomo/tomo/canvas"
import "git.tebibyte.media/tomo/backend/style"
import "git.tebibyte.media/tomo/nasin/internal/util"
//go:embed assets/icons-small.png
var atlasSmallBytes []byte
//go:embed assets/icons-large.png
var atlasLargeBytes []byte
func generateSource (data []byte, width int) map[tomo.Icon] canvas.Texture {
const (
iconApplicationXGeneric = tomo.Icon("application/x-generic")
iconApplicationXExecutable = tomo.Icon("application/x-executable")
iconAudioXGeneric = tomo.Icon("audio/x-generic")
iconFontXGeneric = tomo.Icon("font/x-generic")
iconImageXGeneric = tomo.Icon("image/x-generic")
iconModelXGeneric = tomo.Icon("model/x-generic")
iconPackageXGeneric = tomo.Icon("package/x-generic")
iconTextXGeneric = tomo.Icon("text/x-generic")
iconTextHtml = tomo.Icon("text/html")
iconTextXGenericTemplate = tomo.Icon("text/x-generic-template")
iconTextXScript = tomo.Icon("text/x-script")
iconVideoXGeneric = tomo.Icon("video/x-generic")
iconXOfficeAddressBook = tomo.Icon("x-office-address-book")
iconXOfficeCalendar = tomo.Icon("x-office-calendar")
iconXOfficeDocument = tomo.Icon("x-office-document")
iconXOfficePresentation = tomo.Icon("x-office-presentation")
iconXOfficeSpreadsheet = tomo.Icon("x-office-spreadsheet")
)
func generateSource (data []byte, width int) (canvas.TextureCloser, map[tomo.Icon] canvas.Texture) {
atlasImage, _, err := image.Decode(bytes.NewReader(data))
if err != nil { panic(err) }
atlasTexture := tomo.NewTexture(atlasImage)
@@ -37,7 +59,23 @@ func generateSource (data []byte, width int) map[tomo.Icon] canvas.Texture {
}
col(tomo.IconUnknown)
col(tomo.Icon("File"))
col(iconApplicationXGeneric)
col(iconApplicationXExecutable)
col(iconAudioXGeneric)
col(iconFontXGeneric)
col(iconImageXGeneric)
col(iconModelXGeneric)
col(iconPackageXGeneric)
col(iconTextXGeneric)
col(iconTextHtml)
col(iconTextXGenericTemplate)
col(iconTextXScript)
col(iconVideoXGeneric)
col(iconXOfficeAddressBook)
col(iconXOfficeCalendar)
col(iconXOfficeDocument)
col(iconXOfficePresentation)
col(iconXOfficeSpreadsheet)
row()
// actions
@@ -411,23 +449,26 @@ func generateSource (data []byte, width int) map[tomo.Icon] canvas.Texture {
col(tomo.IconWeatherSnow)
col(tomo.IconWeatherStorm)
return source
return atlasTexture, source
}
type iconSet struct {
atlasSmall canvas.TextureCloser
atlasLarge canvas.TextureCloser
texturesSmall map[tomo.Icon] canvas.Texture
texturesLarge map[tomo.Icon] canvas.Texture
}
// New creates a new fallback icon set.
func New () style.IconSet {
return new(iconSet)
func New () (style.IconSet, event.Cookie) {
iconSet := new(iconSet)
return iconSet, iconSet
}
func (this *iconSet) ensure () {
if this.texturesSmall != nil { return }
this.texturesSmall = generateSource(atlasSmallBytes, 16)
this.texturesLarge = generateSource(atlasLargeBytes, 32)
this.atlasSmall, this.texturesSmall = generateSource(atlasSmallBytes, 16)
this.atlasLarge, this.texturesLarge = generateSource(atlasLargeBytes, 32)
}
func (this *iconSet) selectSource (size tomo.IconSize) map[tomo.Icon] canvas.Texture {
@@ -450,9 +491,25 @@ func (this *iconSet) Icon (icon tomo.Icon, size tomo.IconSize) canvas.Texture {
func (this *iconSet) MimeIcon (mime data.Mime, size tomo.IconSize) canvas.Texture {
this.ensure()
source := this.selectSource(size)
if icon, ok := source[tomo.Icon(mime.String())]; ok {
return icon
}
if mime == data.M("inode", "directory") {
return source[tomo.IconPlaceDirectory]
} else if icon, ok := source[tomo.Icon(util.GeneralizeXDGIconMimeType(mime).String())]; ok {
return icon
} else {
return source[tomo.Icon("File")]
return source[tomo.Icon(iconApplicationXGeneric)]
}
}
func (this *iconSet) Close () {
if this.atlasSmall != nil {
this.atlasSmall.Close()
}
if this.atlasLarge != nil {
this.atlasLarge.Close()
}
}

View File

@@ -9,34 +9,36 @@ import "strings"
import _ "image/png"
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/tomo/data"
import "git.tebibyte.media/tomo/tomo/event"
import "git.tebibyte.media/tomo/tomo/canvas"
import "git.tebibyte.media/tomo/backend/style"
import "git.tebibyte.media/tomo/nasin/internal/util"
import xdgIconTheme "git.tebibyte.media/tomo/xdg/icon-theme"
type iconTheme struct {
xdg xdgIconTheme.Theme
fallback style.IconSet
texturesSmall map[tomo.Icon] canvas.Texture
texturesMedium map[tomo.Icon] canvas.Texture
texturesLarge map[tomo.Icon] canvas.Texture
texturesSmall map[tomo.Icon] canvas.TextureCloser
texturesMedium map[tomo.Icon] canvas.TextureCloser
texturesLarge map[tomo.Icon] canvas.TextureCloser
}
func FindThemeWarn (name string, fallback style.IconSet, path ...string) (style.IconSet, error) {
func FindThemeWarn (name string, fallback style.IconSet, path ...string) (style.IconSet, event.Cookie, error) {
this := &iconTheme {
fallback: fallback,
texturesLarge: make(map[tomo.Icon] canvas.Texture),
texturesMedium: make(map[tomo.Icon] canvas.Texture),
texturesSmall: make(map[tomo.Icon] canvas.Texture),
texturesLarge: make(map[tomo.Icon] canvas.TextureCloser),
texturesMedium: make(map[tomo.Icon] canvas.TextureCloser),
texturesSmall: make(map[tomo.Icon] canvas.TextureCloser),
}
xdg, err := xdgIconTheme.FindThemeWarn(name, path...)
if err != nil { return nil, err }
if err != nil { return nil, nil, err }
this.xdg = xdg
return this, nil
return this, this, nil
}
func (this *iconTheme) selectSource (size tomo.IconSize) map[tomo.Icon] canvas.Texture {
func (this *iconTheme) selectSource (size tomo.IconSize) map[tomo.Icon] canvas.TextureCloser {
switch size {
case tomo.IconSizeMedium: return this.texturesMedium
case tomo.IconSizeLarge: return this.texturesLarge
@@ -44,7 +46,7 @@ func (this *iconTheme) selectSource (size tomo.IconSize) map[tomo.Icon] canvas.T
}
}
func (this *iconTheme) xdgIcon (name string, size tomo.IconSize) (canvas.Texture, bool) {
func (this *iconTheme) xdgIcon (name string, size tomo.IconSize) (canvas.TextureCloser, bool) {
// TODO use scaling factor instead of 1
// find icon file
icon, err := this.xdg.FindIcon(name, iconSizePixels(size), 1, xdgIconTheme.PNG)
@@ -99,7 +101,20 @@ func (this *iconTheme) MimeIcon (mime data.Mime, size tomo.IconSize) canvas.Text
}
}
func (this *iconTheme) icon (icon tomo.Icon, size tomo.IconSize) canvas.Texture {
func (this *iconTheme) Close () {
closeAllIn := func (mp map[tomo.Icon] canvas.TextureCloser) {
for _, texture := range mp {
if texture != nil {
texture.Close()
}
}
}
closeAllIn(this.texturesSmall)
closeAllIn(this.texturesMedium)
closeAllIn(this.texturesLarge)
}
func (this *iconTheme) icon (icon tomo.Icon, size tomo.IconSize) canvas.TextureCloser {
if texture, ok := this.xdgIcon(XdgIconName(icon), size); ok {
return texture
}
@@ -109,11 +124,11 @@ func (this *iconTheme) icon (icon tomo.Icon, size tomo.IconSize) canvas.Texture
return nil
}
func (this *iconTheme) mimeIcon (mime data.Mime, size tomo.IconSize) canvas.Texture {
func (this *iconTheme) mimeIcon (mime data.Mime, size tomo.IconSize) canvas.TextureCloser {
if texture, ok := this.xdgIcon(xdgFormatMime(mime), size); ok {
return texture
}
if texture, ok := this.xdgIcon(xdgFormatMime(generalizeMimeType(mime)), size); ok {
if texture, ok := this.xdgIcon(xdgFormatMime(util.GeneralizeXDGIconMimeType(mime)), size); ok {
return texture
}
if texture, ok := this.xdgIcon(xdgFormatMime(data.M("text", "x-generic")), size); ok {
@@ -166,13 +181,6 @@ func xdgFormatMime (mime data.Mime) string {
return fmt.Sprintf("%s-%s", mime.Type, mime.Subtype)
}
func generalizeMimeType (mime data.Mime) data.Mime {
// FIXME make this more accurate
// https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
mime.Subtype = "x-generic"
return mime
}
func iconSizePixels (size tomo.IconSize) int {
// TODO: once Tomo has scaling support, take that into account here
switch size {

View File

@@ -1,10 +1,10 @@
//go:build unix && (!darwin)
package registrar
import "os"
import "log"
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/backend/x"
import "git.tebibyte.media/tomo/tomo/event"
import "git.tebibyte.media/sashakoshka/goparse"
import "git.tebibyte.media/tomo/nasin/internal/icons/xdg"
import "git.tebibyte.media/tomo/nasin/internal/styles/tss"
@@ -14,6 +14,8 @@ import "git.tebibyte.media/tomo/nasin/internal/faces/fallback"
type Registrar struct {
backend *x.Backend
iconSetCookie event.Cookie
styleCookie event.Cookie
}
func (this *Registrar) SetBackend () (tomo.Backend, error) {
@@ -24,38 +26,50 @@ func (this *Registrar) SetBackend () (tomo.Backend, error) {
return backend, nil
}
func (this *Registrar) SetTheme () error {
styleSheetName := os.Getenv("TOMO_STYLE_SHEET")
if styleSheetName != "" {
styl, _, err := tss.LoadFile(styleSheetName)
func (this *Registrar) SetStyle (name string) error {
if this.styleCookie != nil {
this.styleCookie.Close()
this.styleCookie = nil
}
if name != "" {
styl, cookie, err := tss.LoadFile(name)
if err == nil {
this.backend.SetStyle(styl)
this.styleCookie = cookie
return nil
} else {
log.Printf (
"nasin: could not load style sheet '%s'\n%v",
styleSheetName, parse.Format(err))
name, parse.Format(err))
}
}
styl, _ := fallbackStyle.New()
styl, cookie := fallbackStyle.New()
this.styleCookie = cookie
this.backend.SetStyle(styl)
return nil
}
func (this *Registrar) SetIconSet () error {
iconSet := fallbackIcons.New()
iconSetName := os.Getenv("TOMO_XDG_ICON_THEME")
if iconSetName != "" {
xdgIconSet, err := xdgIcons.FindThemeWarn(iconSetName, iconSet)
func (this *Registrar) SetIconSet (name string) error {
if this.iconSetCookie != nil {
this.iconSetCookie.Close()
this.iconSetCookie = nil
}
iconSet, cookie := fallbackIcons.New()
if name != "" {
xdgIconSet, xdgCookie, err := xdgIcons.FindThemeWarn(name, iconSet)
cookie = event.MultiCookie(cookie, xdgCookie)
if err == nil {
iconSet = xdgIconSet
} else {
log.Printf("nasin: could not load icon theme '%s': %v", iconSetName, err)
log.Printf("nasin: could not load icon theme '%s': %v", name, err)
}
}
this.backend.SetIconSet(iconSet)
this.iconSetCookie = cookie
return nil
}

10
internal/util/util.go Normal file
View File

@@ -0,0 +1,10 @@
package util
import "git.tebibyte.media/tomo/tomo/data"
func GeneralizeXDGIconMimeType (mime data.Mime) data.Mime {
// FIXME make this more accurate
// https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
mime.Subtype = "x-generic"
return mime
}

33
manager.go Normal file
View File

@@ -0,0 +1,33 @@
package nasin
import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/tomo/event"
var manager struct {
count int
}
type funcCookie func ()
func (cookie funcCookie) Close () {
cookie()
}
// WaitFor ensures that the application will stay running while the given window
// is open.
func WaitFor (window tomo.Window) event.Cookie {
manager.count ++
isManaged := true
handleClose := func () {
if !isManaged { return }
isManaged = false
manager.count --
if manager.count < 1 {
tomo.Stop()
}
}
return event.MultiCookie (
window.OnClose(handleClose),
funcCookie(handleClose))
}

26
path.go
View File

@@ -10,12 +10,28 @@ func ApplicationUserDataDir (app ApplicationDescription) (string, error) {
return userMkdirAll(app.ID, userDataDir)
}
// ApplicationSystemDataDirs returns a list of directory paths where an
// application can look for its system-level data files. Directories returned
// by this function may or may not actually exist. This function may return an
// empty slice on some platforms.
func ApplicationSystemDataDirs (app ApplicationDescription) ([]string, error) {
return systemDirs(app.ID, systemDataDirs)
}
// ApplicationUserConfigDir returns the directory path where an application can
// store its user configuration files.
func ApplicationUserConfigDir (app ApplicationDescription) (string, error) {
return userMkdirAll(app.ID, userConfigDir)
}
// ApplicationSystemDataDirs returns a list of directory paths where an
// application can look for its system-level configuration files. Directories
// returned by this function may or may not actually exist. This function may
// return an empty slice on some platforms.
func ApplicationSystemConfigDirs (app ApplicationDescription) ([]string, error) {
return systemDirs(app.ID, systemConfigDirs)
}
// ApplicationUserCacheDir returns the directory path where an application can
// store its user cache files.
func ApplicationUserCacheDir (app ApplicationDescription) (string, error) {
@@ -30,3 +46,13 @@ func userMkdirAll (sub string, getter func () (string, error)) (string, error) {
if err != nil { return "", err }
return path, nil
}
func systemDirs (sub string, getter func () ([]string, error)) ([]string, error) {
paths, err := getter()
if err != nil { return nil, err }
specificPaths := make([]string, len(paths))
for index, path := range paths {
specificPaths[index] = filepath.Join(path, sub)
}
return specificPaths, nil
}

View File

@@ -7,10 +7,18 @@ func userDataDir () (string, error) {
return basedir.DataHome()
}
func systemDataDirs () ([]string, error) {
return basedir.DataDirs()
}
func userConfigDir () (string, error) {
return basedir.ConfigHome()
}
func systemConfigDirs () ([]string, error) {
return basedir.ConfigDirs()
}
func userCacheDir () (string, error) {
return basedir.CacheHome()
}