QuickPlot-0.1.0.0: src/QuickPlot.hs

module QuickPlot (
      module QuickPlot.IPC.QQ
    , runQuickPlot
    , runQuickPlotWith
    , Plottable (..)
    , plot
    , clear
    , toJSON
) where

import QuickPlot.IPC.Server
import QuickPlot.IPC.QQ
import QuickPlot.IPC.Protocol
import Data.Aeson


-- | Port the QuickPlot server is supposed to use
type Port = Int
-- | Directory path of the QuickPlot client files
type UserDirectory = FilePath


-- TODO: Load scripts from custom directory into the real index.html
-- | Start a QuickPlot server
-- Run this function only once in a ghci session (even after reload)
runQuickPlotWith :: UserDirectory  -- ^ Path to directory with user scripts (doesn't work)
                 -> Port           -- ^ Port of the QuickPlot server
                 -> IO ()
runQuickPlotWith = runServer

-- | Start a QuickPlot server at "http://localhost:8000"
-- Run this function only once in a ghci session (even after reload)
runQuickPlot :: IO ()
runQuickPlot = runQuickPlotWith "" 8000


-- | Remove all plots in the browser
-- If the browser is not connected by now the behaviour is undefined
clear :: IO ()
clear = sendMessage (QPMessage QuickPlot Clear Null)


-- | Show data visualizations in the browser
-- If the browser is not connected to QuickPlot a warning will be printed to stdout
plot :: (Plottable p)
     => p             -- ^ JSON that can be visualized
     -> IO ()
plot content = sendMessage (QPMessage (whichLibrary content) NewPlot (plottableToJSON content))


-- All the instances of the class are plottable and should be encoded in a JSON structure
-- that the library can process
class Plottable a where
    -- | Convert to Aeson's Value
    plottableToJSON :: a -> Value
    -- | Which library should be used to visualize the data
    whichLibrary :: a -> Library