toolbox

Documentation

Index

• Constants
• func DefaultToolboxDir() (string, error)
• func DeleteKey(key registry.Key, path string) error
• func OpenOrCreateKey(key registry.Key, path string, access uint32) (registry.Key, error)
• func ReadSubCommands() ([]string, bool, error)
• func SetItem(tool *Tool, admin bool) error
• func SetMenu(dir string, items []string, top bool) error
• func SetMenuItem(path, display, command, subCommands string, top bool) error
• func SortTools(tools []*Tool, sortType int)
• type Availability
  • func (a Availability) String() string
• type Tool
  • func FindLatestTool(tools []*Tool) *Tool
  • func FindTargetTools(tools []*Tool, targets []string, all bool) []*Tool
• type ToolBox
  • func GetAllTools(dir string) (*ToolBox, error)
  • func GetLatestTools(dir string, sortType int) (*ToolBox, error)
  • func GetToolBoxState(dir string) (*ToolBox, error)

Constants

const (
	SortNames = 0
	SortOrder = 1
)

const (
	AppName = "Toolbox"

	// registry keys
	DirectoryBackgroundShell = `Directory\Background\shell\`
	DirectoryShell           = `Directory\shell\`
	CommandStoreShell        = `SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\CommandStore\shell\`

	// EntryLimit max limit for cascade menu
	EntryLimit = 16
)

Functions

func DefaultToolboxDir

func DefaultToolboxDir() (string, error)

DefaultToolboxDir returns default toolbox installation directory.

func DeleteKey

func DeleteKey(key registry.Key, path string) error

DeleteKey delete a registry key and its sub keys.

func OpenOrCreateKey

func OpenOrCreateKey(key registry.Key, path string, access uint32) (registry.Key, error)

OpenOrCreateKey open a registry key, create it if it doesn't exist.

func ReadSubCommands

func ReadSubCommands() ([]string, bool, error)

ReadSubCommands returns current menu items

func SetItem

func SetItem(tool *Tool, admin bool) error

SetItem setItem add items to commandStore shell

func SetMenu

func SetMenu(dir string, items []string, top bool) error

func SetMenuItem

func SetMenuItem(path, display, command, subCommands string, top bool) error

SetMenuItem add menu to registry

func SortTools

func SortTools(tools []*Tool, sortType int)

Types

type Availability

type Availability int

func (Availability) String

func (a Availability) String() string

type Tool

type Tool struct {
	Id          string `json:"toolId"`
	Tag         string `json:"tag"`
	Name        string `json:"displayName"`
	Version     string `json:"displayVersion"`
	BuildNumber string `json:"buildNumber"`
	Channel     string `json:"channelId"`
	Location    string `json:"installLocation"`
	// exe
	Command string `json:"launchCommand"`
	// script file
	Script       string
	Availability Availability
	// contains filtered or unexported fields
}

Tool represents an IDE in ToolBox.

func FindLatestTool

func FindLatestTool(tools []*Tool) *Tool

FindLatestTool find the latest tool in a list of tools.

func FindTargetTools

func FindTargetTools(tools []*Tool, targets []string, all bool) []*Tool

FindTargetTools returns tools with specific names

type ToolBox

type ToolBox struct {
	Version string  `json:"AppVersion"`
	Tools   []*Tool `json:"tools"`

	ShellPath string
}

ToolBox is a struct to hold the toolbox state.

func GetAllTools

func GetAllTools(dir string) (*ToolBox, error)

GetAllTools return local tool list description

func GetLatestTools

func GetLatestTools(dir string, sortType int) (*ToolBox, error)

GetLatestTools returns latest tool list

func GetToolBoxState

func GetToolBoxState(dir string) (*ToolBox, error)

GetToolBoxState returns content of ToolBox/state.json