basic framework

src/Lib.hs

@@ -1,6 +0,0 @@
-module Lib
-    ( someFunc
-    ) where
-
-someFunc :: IO ()
-someFunc = putStrLn "someFunc"

src/SubFix.hs

@@ -0,0 +1,61 @@
+{-|
+Module      : SubFix
+Description : core functions for subfix
+Copyright   : (C) Jonathan Lamothe
+License     : GPL-3
+Maintainer  : jonathan@jlamothe.net
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at
+your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+-}
+
+module SubFix (
+  -- * Data Types
+  Caption (..),
+  -- * Functions
+  convert,
+  decode,
+  encode,
+) where
+
+-- | Defines a caption group
+data Caption = Caption
+  { capID :: Int
+  -- ^ The caption identifier
+  , capStart :: Integer
+  -- ^ The caption start time (in milliseconds)
+  , capEnd :: Integer
+  -- ^ The caption end time (in milliseconds)
+  , capText :: String
+  -- ^ The caption text
+  } deriving (Eq, Show)
+
+-- | Applies the transformations to a caption group
+convert :: Caption -> Caption
+convert = undefined
+
+-- | Decodes the text of a subtitle file
+decode
+  :: String
+  -- ^ The encoded text
+  -> Either String [Caption]
+  -- ^ The resulting caption list, or a message describing the error
+  -- that occured.
+decode = undefined
+
+-- | Encodes a list of caption groups
+encode :: [Caption] -> String
+encode = undefined
+
+--jl