termonad v4.0.0.0 Release Notes

    • 🚚 Remove the dependently typed code for specifying terminal colors. #161. Thanks @ssbothwell!

      The Palette data type has been updated to not used length-indexed lists, but instead just newtype wrappers around normal lists.

      In prevous versions, the Palette data type looked like this:

      data Palette c
        = NoPalette
        | BasicPalette !(Vec N8 c)
        | ExtendedPalette !(Vec N8 c) !(Vec N8 c)
        | ColourCubePalette !(Vec N8 c) !(Vec N8 c) !(Matrix '[N6, N6, N6] c)
        | FullPalette !(Vec N8 c) !(Vec N8 c) !(Matrix '[N6, N6, N6] c) !(Vec N24 c)
      

      In 4.0.0.0, Palette has been changed to the following:

      data Palette c
        = NoPalette
        | BasicPalette !(List8 c)
        | ExtendedPalette !(List8 c) !(List8 c)
        | ColourCubePalette !(List8 c) !(List8 c) !(Matrix c)
        | FullPalette !(List8 c) !(List8 c) !(Matrix c) !(List24 c)
      

      Instead of using types like Vec N8 c, you will use types like List8 c.

      When setting the palette field of in a ColourConfig, you can now do it like the following. Note that there is both a mkList8 function that returns Maybe, and an unsafeMkList8 that throws a runtime error. Most users will probably want to use the unsafeMkList8 function, since it is easy to use, and you can eyeball whether the list has the correct number of elements. If you're doing something more complicated, you may want to use the mkList8 function:

      myColourConfig :: ColourConfig (AlphaColour Double)
      myColourConfig =
        defaultColourConfig
          { palette =
              ExtendedPalette
                myStandardColours (maybe defaultLightColours id myLightColours)
          }
        where
          -- This is a an example of creating a linked-list of colours,
          -- This function uses an unsafe method for generating the list.
          -- An exception will be thrown if your list does not have exactly 8 elements.
          myStandardColours :: List8 (AlphaColour Double)
          myStandardColours = unsafeMkList8
            [ createColour  40  30  20 -- dark brown (used as background colour)
            , createColour 180  30  20 -- red
            , createColour  40 160  20 -- green
            , createColour 180 160  20 -- dark yellow
            , createColour  40  30 120 -- dark purple
            , createColour 180  30 120 -- bright pink
            , createColour  40 160 120 -- teal
            , createColour 180 160 120 -- light brown
            ]
      
          -- This is an example of creating a linked-list of colours with a type
          -- safe method. mkList8 produces a Maybe value which must be handled explicitely.
          myLightColours :: Maybe (List8 (AlphaColour Double))
          myLightColours = mkList8
              [ createColour  70  60  50 -- brown
              , createColour 220  30  20 -- light red
              , createColour  40 210  20 -- light green
              , createColour 220 200  20 -- yellow
              , createColour  40  30 180 -- purple
              , createColour 140  30 80  -- dark pink
              , createColour  50 200 160 -- light teal
              , createColour 220 200 150 -- light brown
              ]
      

      Also see the functions setAtList8, overAtList8, setAtList24, overAtList24, etc.