core

type Config struct {
	// Version is the version of the configuration file.
	ConfigVersion string `json:"config_version"`

	// All timezones to display.
	Timezones []Location `json:"timezones"`

	// Style defines the style of the timezone plot.
	Style Style `json:"style"`

	// Indicates whether to plot tics on the time axis.
	Tics bool `json:"tics"`
	// Indicates whether to stretch across the terminal width at cost of
	// accuracy.
	Stretch bool `json:"stretch"`
	// Inline indicates whether location and time info will be plotted on one
	// line with the bars.
	Inline bool `json:"inline"`
	// Indicates whether to use the 24-hour clock.
	Hours12 bool `json:"hours12"`

	// Indicates whether to continuously update.
	Live bool `json:"live"`
}

type ContextType string

type DaySegmentation struct {
	// MorningHour is the hour at which the morning starts.
	MorningHour int `json:"morning"`
	// DayHour is the hour at which the day starts (basically business hours).
	DayHour int `json:"day"`
	// EveningHour is the hour at which the evening starts.
	EveningHour int `json:"evening"`
	// NightHour is the hour at which the night starts.
	NightHour int `json:"night"`
}

type Location struct {
	// Descriptive name of the timezone.
	Name string
	// Machine-readable timezone name.
	TZ string
}

type PlotColors struct {
	// StaticColorMorning is the color to use for the morning segment.
	StaticColorMorning string
	// StaticColorDay is the color to use for the day segment.
	StaticColorDay string
	// StaticColorEvening is the color to use for the evening segment.
	StaticColorEvening string
	// StaticColorNight is the color to use for the night segment.
	StaticColorNight string
	// StaticColorForeground is the color to use for the foreground.
	StaticColorForeground string

	// DynamicColorMorning is the color to use for the morning segment (in live mode).
	DynamicColorMorning string
	// DynamicColorDay is the color to use for the morning segment (in live mode).
	DynamicColorDay string
	// DynamicColorEvening is the color to use for the morning segment (in live mode).
	DynamicColorEvening string
	// DynamicColorNight is the color to use for the morning segment (in live mode).
	DynamicColorNight string
	// DynamicColorForeground is the color to use for the foreground (in live mode).
	DynamicColorForeground string
	// DynamicColorBackground is the color to use for the background (in live mode).
	DynamicColorBackground string
}

type Plotter struct {
	// func for plotting a line (with line-break)
	PlotLine func(t ContextType, msgs ...interface{})
	// func for plotting simple strings
	PlotString func(t ContextType, msg string)
	// All symbols to represent the hours
	Symbols []string
	// Terminal width
	TerminalWidth int
	// Whether to plot the current time
	Now bool
}

type Style struct {
	// Defines the symbols to be used.
	Symbols string `json:"symbols"`
	// Defines the symbols to be used in custom mode.
	CustomSymbols []TimeSymbol `json:"custom_symbols,omitempty"`
	// Indicates whether to use colors.
	Colorize bool `json:"colorize"`
	// Defines how the day is split up into different ranges.
	DaySegmentation DaySegmentation `json:"day_segments"`
	// Defines the colors to be used in the plot.
	Coloring PlotColors `json:"coloring"`
}

type TimeSymbol struct {
	// Start of the time range.
	Start int
	// Symbol to be used for the time.
	Symbol string
}