module reorganizaion

removed `Lib` and added `Abacus` and `Abacus.Internal`
This commit is contained in:
Jonathan Lamothe 2024-08-20 19:29:33 -04:00
parent 839620b478
commit 54a3be383e
4 changed files with 85 additions and 7 deletions

View File

@ -19,7 +19,8 @@ extra-source-files:
library
exposed-modules:
Lib
Abacus
Abacus.Internal
other-modules:
Paths_abacus
autogen-modules:

40
src/Abacus.hs Normal file
View File

@ -0,0 +1,40 @@
{-|
Module : Abacus
Description : Core functionality for a simple abacus program
Copyright : (C) Jonathan Lamothe
License : AGPL-3.0-or-later
Maintainer : jonathan@jlamothe.net
Stability : experimental
Portability : POSIX
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public
License along with this program. If not, see
<https://www.gnu.org/licenses/>.
-}
module Abacus (Abacus, newAbacus) where
import Abacus.Internal
-- | Constructs the initial state of a new "Abacus"
newAbacus
:: Int
-- ^ The number of beads on each rung
-> Int
-- ^ The number of rungs
-> Maybe Abacus
newAbacus = undefined
--jl

43
src/Abacus/Internal.hs Normal file
View File

@ -0,0 +1,43 @@
{-|
Module : Abacus.Internal
Description : Core functionality for a simple abacus program
Copyright : (C) Jonathan Lamothe
License : AGPL-3.0-or-later
Maintainer : jonathan@jlamothe.net
Stability : experimental
Portability : POSIX
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public
License along with this program. If not, see
<https://www.gnu.org/licenses/>.
# Important Note
This module should only be imported directl by the Abacus module and
the testing suite. Anything contained herein should be considered
subject to change without notice.
-}
module Abacus.Internal (Abacus (..)) where
-- | Represents the state of an Abacus
data Abacus = Abacus
{ abacusNumBeads :: Int
-- ^ The number of beads per rung of the abacus
, abacusRows :: [Int]
-- ^ The number of beads slid across each rung
} deriving (Eq, Show)
--jl

View File

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