common

Documentation

Index

• Variables
• func AllTrue(items []bool) bool
• func AllZero(items []uint) bool
• func CacheDisabled() bool
• func CacheFolderPath(name string) string
• func ConfigFolderPath(name string) string
• func FlagParse(flags *flag.FlagSet, args []string)
• func HasFlag(name string) bool
• func HasIssueInfos() bool
• func HasReleaseInfos() bool
• func HasUnseenInfos() bool
• func HashString(text string, max int) string
• func InitArgs(introspect map[string][]string)
• func InitCache()
• func InitConfig()
• func InitFiles(toml, logo []byte)
• func InitInfo(name, target, version, commit, date, source, flags string)
• func IsDevVersion() bool
• func IsInList(item string, items []string) bool
• func IsInMap(m Map, keys []string) bool
• func IsInsideRect(p Point, g Geometry) bool
• func MaxInt(a int, b int) int
• func MinInt(a int, b int) int
• func RemoveChars(s string, chars []string) string
• func ReverseList[T any](items []T) []T
• func SemverUpdateInfos() (bool, bool, bool)
• func StringsToInts(items []string) []int
• func TruncateString(s string, max int) string
• func VersionToInt(version string) int
• type Arguments
• type BuildInfo
• type Cache
• type Configuration
• type FileData
• type Geometry
  • func CreateGeometry(r xrect.Rect) *Geometry
  • func (g *Geometry) Center() Point
  • func (g *Geometry) Pieces() (int, int, int, int)
  • func (g *Geometry) Rect() xrect.Rect
• type Info
  • func FetchIssues(hostname, repository, labels string) []Info
  • func FetchReleases(hostname, repository string) []Info
  • func (i *Info) Cache() Cache[*Info]
  • func (i *Info) Seen() bool
  • func (i *Info) Unseen() bool
• type List
• type Map
• type Point
  • func CreatePoint(x int, y int) *Point
• type ProcessInfo
• type SourceInfo

Variables

var (
	Process ProcessInfo // Process information
	Build   BuildInfo   // Build information
	Source  SourceInfo  // Source information
)

Functions

func AllTrue

func AllTrue(items []bool) bool

func AllZero

func AllZero(items []uint) bool

func CacheDisabled

func CacheDisabled() bool

func CacheFolderPath

func CacheFolderPath(name string) string

func ConfigFolderPath

func ConfigFolderPath(name string) string

func FlagParse

func FlagParse(flags *flag.FlagSet, args []string)

func HasFlag

func HasFlag(name string) bool

func HasIssueInfos

func HasIssueInfos() bool

func HasReleaseInfos

func HasReleaseInfos() bool

func HasUnseenInfos

func HasUnseenInfos() bool

func HashString

func HashString(text string, max int) string

func InitArgs

func InitArgs(introspect map[string][]string)

func InitCache

func InitCache()

func InitConfig

func InitConfig()

func InitFiles

func InitFiles(toml, logo []byte)

func InitInfo

func InitInfo(name, target, version, commit, date, source, flags string)

func IsDevVersion

func IsDevVersion() bool

func IsInList

func IsInList(item string, items []string) bool

func IsInMap

func IsInMap(m Map, keys []string) bool

func IsInsideRect

func IsInsideRect(p Point, g Geometry) bool

func MaxInt

func MaxInt(a int, b int) int

func MinInt

func MinInt(a int, b int) int

func RemoveChars

func RemoveChars(s string, chars []string) string

func ReverseList

func ReverseList[T any](items []T) []T

func SemverUpdateInfos

func SemverUpdateInfos() (bool, bool, bool)

func StringsToInts

func StringsToInts(items []string) []int

func TruncateString

func TruncateString(s string, max int) string

func VersionToInt

func VersionToInt(version string) int

Types

type Arguments

type Arguments struct {
	Cache  string   // Argument for cache folder path
	Config string   // Argument for config file path
	Lock   string   // Argument for lock file path
	Log    string   // Argument for log file path
	VVV    bool     // Argument for very very verbose mode
	VV     bool     // Argument for very verbose mode
	V      bool     // Argument for verbose mode
	P      []string // Argument for positional values
	Dbus   struct {
		Listen   bool     // Argument for dbus listen flag
		Method   string   // Argument for dbus method name
		Property string   // Argument for dbus property name
		P        []string // Argument for dbus positional values
	}
}

var (
	Args Arguments // Parsed arguments
)

type BuildInfo

type BuildInfo struct {
	Name    string   // Build name
	Target  string   // Build target
	Version string   // Build version
	Commit  string   // Build commit
	Date    string   // Build date
	Summary string   // Build summary
	Flags   []string // Build flags
}

type Cache

type Cache[T any] struct {
	Folder string // Cache file folder
	Name   string // Cache file name
	Data   T      // Cache file data
}

type Configuration

type Configuration struct {
	TilingEnabled     bool              `toml:"tiling_enabled"`      // Tile windows on startup
	TilingLayout      string            `toml:"tiling_layout"`       // Initial tiling layout
	TilingCycle       []string          `toml:"tiling_cycle"`        // Cycle layout order
	TilingGui         int               `toml:"tiling_gui"`          // Time duration of gui
	TilingIcon        [][]string        `toml:"tiling_icon"`         // Menu entries of systray
	WindowIgnore      [][]string        `toml:"window_ignore"`       // Regex to ignore windows
	WindowMastersMax  int               `toml:"window_masters_max"`  // Maximum number of allowed masters
	WindowSlavesMax   int               `toml:"window_slaves_max"`   // Maximum number of allowed slaves
	WindowGapSize     int               `toml:"window_gap_size"`     // Gap size between windows
	WindowFocusDelay  int               `toml:"window_focus_delay"`  // Window focus delay when hovered
	WindowDecoration  bool              `toml:"window_decoration"`   // Show window decorations
	ProportionStep    float64           `toml:"proportion_step"`     // Master-slave area step size proportion
	ProportionMin     float64           `toml:"proportion_min"`      // Window size minimum proportion
	EdgeMargin        []int             `toml:"edge_margin"`         // Margin values of tiling area
	EdgeMarginPrimary []int             `toml:"edge_margin_primary"` // Margin values of primary tiling area
	EdgeCornerSize    int               `toml:"edge_corner_size"`    // Size of square defining edge corners
	EdgeCenterSize    int               `toml:"edge_center_size"`    // Length of rectangle defining edge centers
	Colors            map[string][]int  `toml:"colors"`              // List of color values for gui elements
	Keys              map[string]string `toml:"keys"`                // Event bindings for keyboard shortcuts
	Corners           map[string]string `toml:"corners"`             // Event bindings for hot-corner actions
	Systray           map[string]string `toml:"systray"`             // Event bindings for systray icon
}

var (
	Config Configuration // Decoded config values
)

type FileData

type FileData struct {
	Toml []byte // Default config file
	Logo []byte // Application logo icon
}

var (
	File FileData // Embedded file bytes
)

type Geometry

type Geometry struct {
	X      int // Object geometry x position
	Y      int // Object geometry y position
	Width  int // Object geometry width dimension
	Height int // Object geometry height dimension
}

func CreateGeometry

func CreateGeometry(r xrect.Rect) *Geometry

func (*Geometry) Center

func (g *Geometry) Center() Point

func (*Geometry) Pieces

func (g *Geometry) Pieces() (int, int, int, int)

func (*Geometry) Rect

func (g *Geometry) Rect() xrect.Rect

type Info

type Info struct {
	Id      int    // Source item id
	Url     string // Source item url
	Name    string // Source item name
	Created string // Source item date
	Type    string // Source item type
	Extra   *Info  // Source extra info
}

func FetchIssues

func FetchIssues(hostname, repository, labels string) []Info

func FetchReleases

func FetchReleases(hostname, repository string) []Info

func (*Info) Cache

func (i *Info) Cache() Cache[*Info]

func (*Info) Seen

func (i *Info) Seen() bool

func (*Info) Unseen

func (i *Info) Unseen() bool

type List

type List = []Map // Generic list type

type Map

type Map = map[string]interface{} // Generic map type

type Point

type Point struct {
	X int // Object point x position
	Y int // Object point y position
}

func CreatePoint

func CreatePoint(x int, y int) *Point

type ProcessInfo

type ProcessInfo struct {
	Id   int            // Process id
	Path string         // Process path
	User *user.User     // Process user
	Host *host.InfoStat // Process host
}

type SourceInfo

type SourceInfo struct {
	Hostname   string // Source code hostname
	Repository string // Source code repository
	Releases   []Info // Source code releases
	Issues     []Info // Source code issues
}