Add conf file for desktop-ui kitten

This commit is contained in:
Kovid Goyal
2025-07-01 13:26:39 +05:30
parent 3fbaabe334
commit d5534b6238
5 changed files with 85 additions and 33 deletions

View File

@@ -615,6 +615,7 @@ def generate_constants() -> str:
from kitty.config import option_names_for_completion
from kitty.fast_data_types import FILE_TRANSFER_CODE
from kitty.options.utils import allowed_shell_integration_values, url_style_map
from kitty.simple_cli_definitions import CONFIG_HELP
del sys.modules['kittens.hints.main']
del sys.modules['kittens.query_terminal.main']
ref_map = load_ref_map()
@@ -647,6 +648,7 @@ const HintsDefaultRegex = `{DEFAULT_REGEX}`
const DefaultTermName = `{Options.term}`
const DefaultUrlStyle = `{url_style}`
const DefaultUrlColor = `{Options.url_color.as_sharp}`
const ConfigHelp = "{serialize_as_go_string(CONFIG_HELP)}"
var Version VersionType = VersionType{{Major: {kc.version.major}, Minor: {kc.version.minor}, Patch: {kc.version.patch},}}
var DefaultPager []string = []string{{ {dp} }}
var FunctionalKeyNameAliases = map[string]string{serialize_go_dict(functional_key_name_aliases)}

View File

@@ -2,22 +2,38 @@ package desktop_ui
import (
"fmt"
"strings"
"github.com/kovidgoyal/dbus"
"github.com/kovidgoyal/kitty"
"github.com/kovidgoyal/kitty/tools/cli"
"github.com/kovidgoyal/kitty/tools/config"
"github.com/kovidgoyal/kitty/tools/utils"
)
var _ = fmt.Print
type Options struct {
Color_scheme, AccentColor, Contrast string
type ServerOptions struct {
Config []string
Override []string
}
func run_server(opts *Options) (err error) {
portal, err := NewPortal(opts)
const server_conf_name = "desktop-ui-portal"
func load_server_config(opts *ServerOptions) (ans *Config, err error) {
ans = NewConfig()
p := config.ConfigParser{LineHandler: ans.Parse}
err = p.LoadConfig(server_conf_name+".conf", opts.Config, opts.Override)
return
}
func run_server(opts *ServerOptions) (err error) {
config, err := load_server_config(opts)
if err == nil {
err = portal.Start()
portal, err := NewPortal(config)
if err == nil {
err = portal.Start()
}
}
if err != nil {
return
@@ -27,21 +43,19 @@ func run_server(opts *Options) (err error) {
return
}
func EntryPoint(root *cli.Command) {
parent := root.AddSubCommand(&cli.Command{
Name: "desktop-ui",
ShortDescription: "Implement various desktop components for use with lightweight compositors/window managers on Linux",
Run: func(cmd *cli.Command, args []string) (int, error) {
cmd.ShowHelp()
return 1, nil
},
})
func specialize_command(parent *cli.Command) {
parent.Run = func(cmd *cli.Command, args []string) (int, error) {
cmd.ShowHelp()
return 1, nil
}
parent.ShortDescription = "Implement various desktop components for use with lightweight compositors/window managers on Linux"
rs := parent.AddSubCommand(&cli.Command{
Name: "run-server",
ShortDescription: "Start the various servers used to integrate with the Linux desktop",
HelpText: "This should be run very early in the startup sequence of your window manager, before any other programs are run.",
Run: func(cmd *cli.Command, args []string) (rc int, err error) {
opts := Options{}
opts := ServerOptions{}
err = cmd.GetOptionValues(&opts)
if err == nil {
err = run_server(&opts)
@@ -50,25 +64,18 @@ func EntryPoint(root *cli.Command) {
},
})
rs.Add(cli.OptionSpec{
Name: `--color-scheme`, Type: "choices", Dest: `Color_scheme`, Choices: "no-preference, light, dark",
Completer: cli.NamesCompleter("Choices for color-scheme", "no-preference", "light", "dark"),
Help: "The color scheme for your system. This sets the initial value of the color scheme. It can be changed subsequently by using the color-scheme sub-command.",
Name: `--override -o`, Type: "list", Dest: `Override`,
Help: "Override individual configuration options, can be specified multiple times. Syntax: :italic:`name=value`. For example: :italic:`-o color_scheme=dark`",
})
rs.Add(cli.OptionSpec{
Name: `--accent-color`,
Help: "The RGB accent color for your system, can be specified as a color name or in hex a decimal format.",
Default: "cyan",
})
rs.Add(cli.OptionSpec{
Name: `--contrast`, Type: "choices", Choices: "normal, high",
Help: "The preferred contrast level. Choices: normal, high",
Default: "normal",
Name: `--config -c`, Type: "list", Dest: `Config`,
Help: strings.ReplaceAll(strings.ReplaceAll(kitty.ConfigHelp, "{appname}", "kitty"), "{conf_name}", server_conf_name),
})
parent.AddSubCommand(&cli.Command{
Name: "enable-portal",
ShortDescription: "This will create or edit the various files needed so that the portal from this kitten is used by xdg-desktop-portal",
HelpText: "Once you run this command, add :code:`kitten desktop-ui run-server --color-scheme=whatever` to your window manager startup sequence and reboot your computer (or logout and restart your session) and hopefully xdg-desktop-portal should now delegate to kitty for the portals implemented here. If it doesn't try running :code:`/usr/lib/xdg-desktop-portal -r -v` it will provide a lot of logging about why it is choosing different portal backends. That combined with a careful reading of :code:`man portals.conf` should be enough to learn how to convince xdg-desktop-portal to use kitty.\n\nYou can change the system color-scheme dynamically by running::\n\n:code:`kitten desktop-ui set-color-scheme dark`",
HelpText: "Once you run this command, add :code:`kitten desktop-ui run-server` to your window manager startup sequence and reboot your computer (or logout and restart your session) and hopefully xdg-desktop-portal should now delegate to kitty for the portals implemented here. If it doesn't try running :code:`/usr/lib/xdg-desktop-portal -r -v` it will provide a lot of logging about why it is choosing different portal backends. That combined with a careful reading of :code:`man portals.conf` should be enough to learn how to convince xdg-desktop-portal to use kitty.\n\nYou can change the system color-scheme dynamically by running::\n\n:code:`kitten desktop-ui set-color-scheme dark`",
Run: func(cmd *cli.Command, args []string) (rc int, err error) {
err = enable_portal()
return utils.IfElse(err == nil, 0, 1), err
@@ -189,5 +196,8 @@ func EntryPoint(root *cli.Command) {
Help: "Normally, after printing the settings, if the settings did not come from the desktop-ui kitten the command prints an error and exits. This prevents that.",
Type: "bool-set",
})
}
func EntryPoint(root *cli.Command) {
create_cmd(root, nil)
}

View File

@@ -2,3 +2,35 @@
# License: GPLv3 Copyright: 2025, Kovid Goyal <kovid at kovidgoyal.net>
import sys
from kitty.conf.types import Definition
definition = Definition(
'!kittens.choose_files',
)
agr = definition.add_group
egr = definition.end_group
opt = definition.add_option
map = definition.add_map
mma = definition.add_mouse_map
agr('Appearance')
opt('color_scheme', 'no-preference', choices=('no-preference', 'dark', 'light'), long_text='''\
The color scheme for your system. This sets the initial value of the color scheme. It can be changed subsequently
by using :code:`kitten desktop-ui color-scheme`.
''')
opt('accent_color', 'cyan', long_text='The RGB accent color for your system, can be specified as a color name or in hex a decimal format.')
opt('contrast', 'normal', choices=('normal', 'high'), long_text='The preferred contrast level.')
egr()
def main(args: list[str]) -> None:
raise SystemExit('This must be run as kitten desktop-ui')
if __name__ == '__main__':
main(sys.argv)
elif __name__ == '__conf__':
sys.options_definition = definition # type: ignore

View File

@@ -57,7 +57,7 @@ func to_color(spec string) (v dbus.Variant, err error) {
return
}
func NewPortal(opts *Options) (p *Portal, err error) {
func NewPortal(opts *Config) (p *Portal, err error) {
ans := Portal{}
ans.settings = SettingsMap{
SETTINGS_CANARY_NAMESPACE: map[string]dbus.Variant{
@@ -66,16 +66,16 @@ func NewPortal(opts *Options) (p *Portal, err error) {
}
ans.settings[PORTAL_APPEARANCE_NAMESPACE] = map[string]dbus.Variant{}
switch opts.Color_scheme {
case "dark":
case Color_scheme_dark:
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_COLOR_SCHEME_KEY] = dbus.MakeVariant(uint32(DARK))
case "light":
case Color_scheme_light:
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_COLOR_SCHEME_KEY] = dbus.MakeVariant(uint32(LIGHT))
default:
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_COLOR_SCHEME_KEY] = dbus.MakeVariant(uint32(NO_PREFERENCE))
}
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_ACCENT_COLOR_KEY], err = to_color(opts.AccentColor)
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_ACCENT_COLOR_KEY], err = to_color(opts.Accent_color)
var contrast uint32
if opts.Contrast == "high" {
if opts.Contrast == Contrast_high {
contrast = 1
}
ans.settings[PORTAL_APPEARANCE_NAMESPACE][PORTAL_CONTRAST_KEY] = dbus.MakeVariant(contrast)

View File

@@ -462,6 +462,14 @@ func GetOptionValue[T any](self *Command, name string) (ans T, err error) {
return
}
func (self *Command) OptionsSeenOnCommandLine() map[string]bool {
ans := make(map[string]bool)
for name, opt := range self.option_map {
ans[name] = opt != nil && len(opt.values_from_cmdline) > 0
}
return ans
}
func (self *Command) GetOptionValues(pointer_to_options_struct any) error {
val := reflect.ValueOf(pointer_to_options_struct).Elem()
if val.Kind() != reflect.Struct {