{-# LANGUAGE OverloadedStrings #-}

module Drasil.Data.Formats.Jupyter.Core
  ( Notebook(..), Cell(..), Metadata
  , NotebookMetadata(..), KernelSpec(..), LanguageInfo(..)
  , defaultPython39Metadata
  ) where

import Data.Text (Text)
import Drasil.Data.Formats.JSON (JSON(..))

-- | Cell metadata stored as JSON object entries.
type Metadata = [(Text, JSON)]

-- | A new notebook containing ordered cells and document metadata.
data Notebook = Notebook
  NotebookMetadata -- ^ Notebook-level metadata.
  [Cell] -- ^ Cells in document order.
  deriving (Notebook -> Notebook -> Bool
(Notebook -> Notebook -> Bool)
-> (Notebook -> Notebook -> Bool) -> Eq Notebook
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Notebook -> Notebook -> Bool
== :: Notebook -> Notebook -> Bool
$c/= :: Notebook -> Notebook -> Bool
/= :: Notebook -> Notebook -> Bool
Eq, Int -> Notebook -> ShowS
[Notebook] -> ShowS
Notebook -> String
(Int -> Notebook -> ShowS)
-> (Notebook -> String) -> ([Notebook] -> ShowS) -> Show Notebook
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Notebook -> ShowS
showsPrec :: Int -> Notebook -> ShowS
$cshow :: Notebook -> String
show :: Notebook -> String
$cshowList :: [Notebook] -> ShowS
showList :: [Notebook] -> ShowS
Show)

-- | Notebook kernel and language information.
data NotebookMetadata = NotebookMetadata
  { NotebookMetadata -> KernelSpec
notebookKernel :: KernelSpec
  , NotebookMetadata -> LanguageInfo
notebookLanguage :: LanguageInfo
  } deriving (NotebookMetadata -> NotebookMetadata -> Bool
(NotebookMetadata -> NotebookMetadata -> Bool)
-> (NotebookMetadata -> NotebookMetadata -> Bool)
-> Eq NotebookMetadata
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: NotebookMetadata -> NotebookMetadata -> Bool
== :: NotebookMetadata -> NotebookMetadata -> Bool
$c/= :: NotebookMetadata -> NotebookMetadata -> Bool
/= :: NotebookMetadata -> NotebookMetadata -> Bool
Eq, Int -> NotebookMetadata -> ShowS
[NotebookMetadata] -> ShowS
NotebookMetadata -> String
(Int -> NotebookMetadata -> ShowS)
-> (NotebookMetadata -> String)
-> ([NotebookMetadata] -> ShowS)
-> Show NotebookMetadata
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> NotebookMetadata -> ShowS
showsPrec :: Int -> NotebookMetadata -> ShowS
$cshow :: NotebookMetadata -> String
show :: NotebookMetadata -> String
$cshowList :: [NotebookMetadata] -> ShowS
showList :: [NotebookMetadata] -> ShowS
Show)

-- | The kernel used to execute a notebook.
data KernelSpec = KernelSpec
  { KernelSpec -> Text
kernelDisplayName :: Text
  , KernelSpec -> Text
kernelLanguage :: Text
  , KernelSpec -> Text
kernelName :: Text
  } deriving (KernelSpec -> KernelSpec -> Bool
(KernelSpec -> KernelSpec -> Bool)
-> (KernelSpec -> KernelSpec -> Bool) -> Eq KernelSpec
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: KernelSpec -> KernelSpec -> Bool
== :: KernelSpec -> KernelSpec -> Bool
$c/= :: KernelSpec -> KernelSpec -> Bool
/= :: KernelSpec -> KernelSpec -> Bool
Eq, Int -> KernelSpec -> ShowS
[KernelSpec] -> ShowS
KernelSpec -> String
(Int -> KernelSpec -> ShowS)
-> (KernelSpec -> String)
-> ([KernelSpec] -> ShowS)
-> Show KernelSpec
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> KernelSpec -> ShowS
showsPrec :: Int -> KernelSpec -> ShowS
$cshow :: KernelSpec -> String
show :: KernelSpec -> String
$cshowList :: [KernelSpec] -> ShowS
showList :: [KernelSpec] -> ShowS
Show)

-- | Notebook language information.
data LanguageInfo = LanguageInfo
  { LanguageInfo -> Text
languageName :: Text
  , LanguageInfo -> JSON
languageCodeMirrorMode :: JSON
  , LanguageInfo -> Text
languageFileExtension :: Text
  , LanguageInfo -> Text
languageMimeType :: Text
  , LanguageInfo -> Text
languageExporter :: Text
  , LanguageInfo -> Text
languageLexer :: Text
  , LanguageInfo -> Text
languageVersion :: Text
  } deriving (LanguageInfo -> LanguageInfo -> Bool
(LanguageInfo -> LanguageInfo -> Bool)
-> (LanguageInfo -> LanguageInfo -> Bool) -> Eq LanguageInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: LanguageInfo -> LanguageInfo -> Bool
== :: LanguageInfo -> LanguageInfo -> Bool
$c/= :: LanguageInfo -> LanguageInfo -> Bool
/= :: LanguageInfo -> LanguageInfo -> Bool
Eq, Int -> LanguageInfo -> ShowS
[LanguageInfo] -> ShowS
LanguageInfo -> String
(Int -> LanguageInfo -> ShowS)
-> (LanguageInfo -> String)
-> ([LanguageInfo] -> ShowS)
-> Show LanguageInfo
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> LanguageInfo -> ShowS
showsPrec :: Int -> LanguageInfo -> ShowS
$cshow :: LanguageInfo -> String
show :: LanguageInfo -> String
$cshowList :: [LanguageInfo] -> ShowS
showList :: [LanguageInfo] -> ShowS
Show)

-- | Python 3.9.1 metadata used by the current notebook generators.
defaultPython39Metadata :: NotebookMetadata
defaultPython39Metadata :: NotebookMetadata
defaultPython39Metadata = NotebookMetadata
  { notebookKernel :: KernelSpec
notebookKernel = Text -> Text -> Text -> KernelSpec
KernelSpec Text
"Python 3" Text
"python" Text
"python3"
  , notebookLanguage :: LanguageInfo
notebookLanguage = LanguageInfo
      { languageName :: Text
languageName = Text
"python"
      , languageCodeMirrorMode :: JSON
languageCodeMirrorMode =
          [(Text, JSON)] -> JSON
JObject [(Text
"name", JSON
"ipython"), (Text
"version", Scientific -> JSON
JNumber Scientific
3)]
      , languageFileExtension :: Text
languageFileExtension = Text
".py"
      , languageMimeType :: Text
languageMimeType = Text
"text/x-python"
      , languageExporter :: Text
languageExporter = Text
"python"
      , languageLexer :: Text
languageLexer = Text
"ipython3"
      , languageVersion :: Text
languageVersion = Text
"3.9.1"
      }
  }

-- | A Markdown cell or an unexecuted code cell.
data Cell
  = MarkdownCell
      Metadata -- ^ Cell-level metadata.
      -- TODO: Use the CommonMark AST from #5406 for Markdown cell content.
      Text -- ^ Rendered Markdown source.
  | CodeCell
      Metadata -- ^ Cell-level metadata.
      Text -- ^ Code source.
  deriving (Cell -> Cell -> Bool
(Cell -> Cell -> Bool) -> (Cell -> Cell -> Bool) -> Eq Cell
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Cell -> Cell -> Bool
== :: Cell -> Cell -> Bool
$c/= :: Cell -> Cell -> Bool
/= :: Cell -> Cell -> Bool
Eq, Int -> Cell -> ShowS
[Cell] -> ShowS
Cell -> String
(Int -> Cell -> ShowS)
-> (Cell -> String) -> ([Cell] -> ShowS) -> Show Cell
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Cell -> ShowS
showsPrec :: Int -> Cell -> ShowS
$cshow :: Cell -> String
show :: Cell -> String
$cshowList :: [Cell] -> ShowS
showList :: [Cell] -> ShowS
Show)