waveterm/pkg/waveobj/wtypemeta.go

// Copyright 2024, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0

package waveobj

import (
	"strings"
)

const Entity_Any = "any"

// well known meta keys
// to add a new key, add it here and add it to MetaTSType (make sure the keys match)
// TODO: will code generate one side of this so we don't need to add the keys in two places
// will probably drive this off the meta decls so we can add more information and validate the keys/values
const (
	MetaKey_DisplayName  = "display:name"  // special, does not get merged
	MetaKey_DisplayOrder = "display:order" // special, does not get merged

	MetaKey_View       = "view"
	MetaKey_Controller = "controller"
	MetaKey_Title      = "title"
	MetaKey_File       = "file"
	MetaKey_Url        = "url"
	MetaKey_Connection = "connection"
	MetaKey_History    = "history" // stores an array of history items specific to the block

	MetaKey_Icon      = "icon"
	MetaKey_IconColor = "icon:color"

	MetaKey_Frame                    = "frame"
	MetaKey_FrameBorderColor         = "frame:bordercolor"
	MetaKey_FrameBorderColor_Focused = "frame:bordercolor:focused"

	MetaKey_Cmd               = "cmd"
	MetaKey_CmdInteractive    = "cmd:interactive"
	MetaKey_CmdLogin          = "cmd:login"
	MetaKey_CmdRunOnStart     = "cmd:runonstart"
	MetaKey_CmdClearOnStart   = "cmd:clearonstart"
	MetaKey_CmdClearOnRestart = "cmd:clearonrestart"
	MetaKey_CmdEnv            = "cmd:env"
	MetaKey_CmdCwd            = "cmd:cwd"
	MetaKey_CmdNoWsh          = "cmd:nowsh"

	MetaKey_Bg          = "bg"
	MetaKey_BgClear     = "bg:*"
	MetaKey_BgOpacity   = "bg:opacity"
	MetaKey_BgBlendMode = "bg:blendmode"

	MetaKey_TermFontSize   = "term:fontsize"
	MetaKey_TermFontFamily = "term:fontfamily"
	MetaKey_TermMode       = "term:mode"
	MetaKey_TermTheme      = "term:theme"
	MetaKey_Count          = "count" // temp for cpu plot. will remove later
)

// for typescript typing
type MetaTSType struct {
	// shared
	View           string   `json:"view,omitempty"`
	Controller     string   `json:"controller,omitempty"`
	Title          string   `json:"title,omitempty"`
	File           string   `json:"file,omitempty"`
	Url            string   `json:"url,omitempty"`
	Connection     string   `json:"connection,omitempty"`
	History        []string `json:"history,omitempty"`
	HistoryForward []string `json:"history:forward,omitempty"`

	Icon      string `json:"icon,omitempty"`
	IconColor string `json:"icon:color,omitempty"`

	Frame                    bool   `json:"frame,omitempty"`
	FrameClear               bool   `json:"frame:*,omitempty"`
	FrameBorderColor         string `json:"frame:bordercolor,omitempty"`
	FrameBorderColor_Focused string `json:"frame:bordercolor:focused,omitempty"`

	Cmd               string            `json:"cmd,omitempty"`
	CmdClear          bool              `json:"cmd:*,omitempty"`
	CmdInteractive    bool              `json:"cmd:interactive,omitempty"`
	CmdLogin          bool              `json:"cmd:login,omitempty"`
	CmdRunOnStart     bool              `json:"cmd:runonstart,omitempty"`
	CmdClearOnStart   bool              `json:"cmd:clearonstart,omitempty"`
	CmdClearOnRestart bool              `json:"cmd:clearonrestart,omitempty"`
	CmdEnv            map[string]string `json:"cmd:env,omitempty"`
	CmdCwd            string            `json:"cmd:cwd,omitempty"`
	CmdNoWsh          bool              `json:"cmd:nowsh,omitempty"`

	// for tabs
	Bg          string  `json:"bg,omitempty"`
	BgClear     bool    `json:"bg:*,omitempty"`
	BgOpacity   float64 `json:"bg:opacity,omitempty"`
	BgBlendMode string  `json:"bg:blendmode,omitempty"`

	TermClear      bool   `json:"term:*,omitempty"`
	TermFontSize   int    `json:"term:fontsize,omitempty"`
	TermFontFamily string `json:"term:fontfamily,omitempty"`
	TermMode       string `json:"term:mode,omitempty"`
	TermTheme      string `json:"term:theme,omitempty"`
	Count          int    `json:"count,omitempty"` // temp for cpu plot. will remove later
}

type MetaDataDecl struct {
	Key        string   `json:"key"`
	Desc       string   `json:"desc,omitempty"`
	Type       string   `json:"type"` // string, int, float, bool, array, object
	Default    any      `json:"default,omitempty"`
	StrOptions []string `json:"stroptions,omitempty"`
	NumRange   []*int   `json:"numrange,omitempty"` // inclusive, null means no limit
	Entity     []string `json:"entity"`             // what entities this applies to, e.g. "block", "tab", "any", etc.
	Special    []string `json:"special,omitempty"`  // special handling.  things that need to happen if this gets updated
}

type MetaPresetDecl struct {
	Preset string   `json:"preset"`
	Desc   string   `json:"desc,omitempty"`
	Keys   []string `json:"keys"`
	Entity []string `json:"entity"` // what entities this applies to, e.g. "block", "tab", etc.
}

// returns a clean copy of meta with mergeMeta merged in
func MergeMeta(meta MetaMapType, metaUpdate MetaMapType) MetaMapType {
	rtn := make(MetaMapType)
	for k, v := range meta {
		rtn[k] = v
	}
	// deal with "section:*" keys
	for k := range metaUpdate {
		if !strings.HasSuffix(k, ":*") {
			continue
		}
		if !metaUpdate.GetBool(k, false) {
			continue
		}
		prefix := strings.TrimSuffix(k, ":*")
		if prefix == "" {
			continue
		}
		// delete "[prefix]" and all keys that start with "[prefix]:"
		prefixColon := prefix + ":"
		for k2 := range rtn {
			if k2 == prefix || strings.HasPrefix(k2, prefixColon) {
				delete(rtn, k2)
			}
		}
	}
	// now deal with regular keys
	for k, v := range metaUpdate {
		if strings.HasPrefix(k, "display:") {
			continue
		}
		if strings.HasSuffix(k, ":*") {
			continue
		}
		if v == nil {
			delete(rtn, k)
			continue
		}
		rtn[k] = v
	}
	return rtn
}