Copyright	(C) 2025-2026 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Shockwaves.Style

Description

Everything needed to add different styles to the waveform viewer.

Waveforms can be styled in a number of ways. Various standard styles are provided in WaveStyle. It is also possible to use custom colors using WSColor. These values can be provided in 3 typical ways:

Directly from an RGB Word8 value, using the WSColor constructor: WSColor (RGB 128 128 0).
From a Colour Double value, using the function wsColor. Many such values are provided in Clash.Shockwaves.Style.Colors.
Using a string literal: if OverloadedStrings is enabled, the WaveStyle value can be represented using a color name or hex color string literal. See readColourName.

Finally, there are a few special styles.

WSError is propagated throughout the signal hierarchy.
WSDefault is the only style to be replaced by the TStyled translator, and gets turned into WSNormal.
'WSInherit n' inherits the style of the _n_'th subsignal.
WSVar makes it possible to define style variables in config files - this can also be created by using a string literal starting with $, which uses WSDefault as the fallback value.
WSHidden makes the signal appear as if it has not been assigned a value at all. This still allows the hidden text to be used in the construction of the value of a supersignal.

Some examples:

import Shockwaves.Style
import Shockwaves.Style.Colors as C

data Col = Red | Green | Blue | Yellow | Cyan | Magenta deriving ...

instance Waveform Col where
  constructorStyles = [ WSColor (RGB 255 0 0) -- RGB value
                      , wsColor C.lime        -- Colour value
                      , "blue"                -- color name
                      , "#ffff00"             -- hexadecimal color
                      , "$cyan"               -- style variable "cyan"; defaults to WSDefault
                      , WSVar "magenta"       -- style variable "magenta", defaults to #ff00ff
                      ]

and in a translation:

Translation (Just ("(p,q)",Inherit 1,11))           -- appears as blue
  [ ("a",Translation (Just ("p",WSHidden,11)) [])   -- no value is shown
  , ("b",Translation (Just ("q","blue"  ,11)) []) ] -- appears as blue

Translation (Just ("(p,q)","blue",11))               -- appears as WSError
  [ ("a",Translation (Just ("p",WSDefault,11)) [])   -- appears as WSNormal
  , ("b",Translation (Just ("q",WSError  ,11)) []) ] -- appears as WSError

Synopsis

data WaveStyle
- = WSDefault
- | WSError
- | WSHidden
- | WSInherit Natural
- | WSNormal
- | WSWarn
- | WSUndef
- | WSHighImp
- | WSDontCare
- | WSWeak
- | WSColor Color
- | WSVar String WaveStyle
type Color = RGB Word8
data RGB a = RGB {
- channelRed :: !a
- channelGreen :: !a
- channelBlue :: !a
}
wsColor :: Colour Double -> WaveStyle
data Word8

Documentation

data WaveStyle Source #

The style in which a signal should be displayed.

Constructors

WSDefault	The default waveform style. It is rendered as `WSNormal`. This is the only style overwritten by `TStyled`.
WSError	An error value. Errors are propagated by translators.
WSHidden	Do not display any value, even if it exists.
WSInherit Natural	Copy the style of the nth subsignal.
WSNormal	A normal value.
WSWarn	A warning value.
WSUndef	An undefined value.
WSHighImp	A high impedance value.
WSDontCare	A value that does not matter.
WSWeak	A weakly defined value.
WSColor Color	A custom color. See Clash.Shockwaves.Style for more information.
WSVar String WaveStyle	A variable in a style configuration file, with a default.

Instances

Instances details

ToJSON WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

toJSON :: WaveStyle -> Value #

toEncoding :: WaveStyle -> Encoding #

toJSONList :: [WaveStyle] -> Value #

toEncodingList :: [WaveStyle] -> Encoding #

omitField :: WaveStyle -> Bool #

NFData WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

rnf :: WaveStyle -> () #

IsString WaveStyle Source #

A WaveStyle may be constructed from a value in various ways. Values starting with $ are treated as WSVar with WSDefault as fallback value. Hexadecimals and color names are used to create WSColor (see readColourName).

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

fromString :: String -> WaveStyle #

Generic WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

Associated Types

type Rep WaveStyle

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

from :: WaveStyle -> Rep WaveStyle x #

to :: Rep WaveStyle x -> WaveStyle #

Show WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

showsPrec :: Int -> WaveStyle -> ShowS #

show :: WaveStyle -> String #

showList :: [WaveStyle] -> ShowS #

Eq WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

Methods

(==) :: WaveStyle -> WaveStyle -> Bool #

(/=) :: WaveStyle -> WaveStyle -> Bool #

type Rep WaveStyle Source #

Instance details

Defined in Clash.Shockwaves.Internal.Types

type Color = RGB Word8 Source #

The color type used in WaveStyle.

data RGB a #

An RGB triple for an unspecified colour space.

Constructors

RGB
Fields channelRed :: !a channelGreen :: !a channelBlue :: !a

Instances

Instances details

Applicative RGB
Instance details Defined in Data.Colour.RGB Methods pure :: a -> RGB a # (<>) :: RGB (a -> b) -> RGB a -> RGB b # liftA2 :: (a -> b -> c) -> RGB a -> RGB b -> RGB c # (>) :: RGB a -> RGB b -> RGB b # (<*) :: RGB a -> RGB b -> RGB a #
Functor RGB
Instance details Defined in Data.Colour.RGB Methods fmap :: (a -> b) -> RGB a -> RGB b # (<$) :: a -> RGB b -> RGB a #
Read a => Read (RGB a)
Instance details Defined in Data.Colour.RGB Methods readsPrec :: Int -> ReadS (RGB a) # readList :: ReadS [RGB a] # readPrec :: ReadPrec (RGB a) # readListPrec :: ReadPrec [RGB a] #
Show a => Show (RGB a)
Instance details Defined in Data.Colour.RGB Methods showsPrec :: Int -> RGB a -> ShowS # show :: RGB a -> String # showList :: [RGB a] -> ShowS #
Eq a => Eq (RGB a)
Instance details Defined in Data.Colour.RGB Methods (==) :: RGB a -> RGB a -> Bool # (/=) :: RGB a -> RGB a -> Bool #