-- | The type of cave kinds. Every level in the game is an instantiated
-- cave kind.
module Game.LambdaHack.Content.CaveKind
  ( pattern DEFAULT_RANDOM
  , CaveKind(..), InitSleep(..), makeData
#ifdef EXPOSE_INTERNAL
    -- * Internal operations
  , validateSingle, validateAll, mandatoryGroups
#endif
  ) where

import Prelude ()

import Game.LambdaHack.Core.Prelude

import qualified Data.Text as T

import           Game.LambdaHack.Content.ItemKind (ItemKind)
import           Game.LambdaHack.Content.PlaceKind (PlaceKind)
import qualified Game.LambdaHack.Content.RuleKind as RK
import           Game.LambdaHack.Content.TileKind (TileKind)
import qualified Game.LambdaHack.Core.Dice as Dice
import           Game.LambdaHack.Core.Random
import           Game.LambdaHack.Definition.ContentData
import           Game.LambdaHack.Definition.Defs
import           Game.LambdaHack.Definition.DefsInternal

-- | Parameters for the generation of dungeon levels.
-- Warning: for efficiency, avoid embedded items in any of the common tiles.
data CaveKind = CaveKind
  { CaveKind -> Text
cname         :: Text             -- ^ short description
  , CaveKind -> Freqs CaveKind
cfreq         :: Freqs CaveKind   -- ^ frequency within groups
  , CaveKind -> X
cXminSize     :: X                -- ^ minimal X size of the whole cave
  , CaveKind -> X
cYminSize     :: Y                -- ^ minimal Y size of the whole cave
  , CaveKind -> DiceXY
ccellSize     :: Dice.DiceXY      -- ^ size of a map cell holding a place
  , CaveKind -> DiceXY
cminPlaceSize :: Dice.DiceXY      -- ^ minimal size of places; for merging
  , CaveKind -> DiceXY
cmaxPlaceSize :: Dice.DiceXY      -- ^ maximal size of places; for growing
  , CaveKind -> Dice
cdarkOdds     :: Dice.Dice        -- ^ the odds a place is dark
                                      --   (level-scaled dice roll > 50)
  , CaveKind -> Dice
cnightOdds    :: Dice.Dice        -- ^ the odds the cave is dark
                                      --   (level-scaled dice roll > 50)
  , CaveKind -> Rational
cauxConnects  :: Rational         -- ^ a proportion of extra connections
  , CaveKind -> Rational
cmaxVoid      :: Rational
      -- ^ at most this proportion of rooms may be void
  , CaveKind -> Rational
cdoorChance   :: Chance           -- ^ the chance of a door in an opening
  , CaveKind -> Rational
copenChance   :: Chance           -- ^ if there's a door, is it open?
  , CaveKind -> X
chidden       :: Int              -- ^ if not open, hidden one in n times
  , CaveKind -> X
cactorCoeff   :: Int              -- ^ the lower, the more monsters spawn
  , CaveKind -> Freqs ItemKind
cactorFreq    :: Freqs ItemKind   -- ^ actor groups to consider
  , CaveKind -> Dice
citemNum      :: Dice.Dice        -- ^ number of initial items in the cave
  , CaveKind -> Freqs ItemKind
citemFreq     :: Freqs ItemKind   -- ^ item groups to consider;
      -- note that the groups are flattened; e.g., if an item is moved
      -- to another included group with the same weight, the outcome
      -- doesn't change
  , CaveKind -> Freqs PlaceKind
cplaceFreq    :: Freqs PlaceKind  -- ^ place groups to consider
  , CaveKind -> Bool
cpassable     :: Bool
      -- ^ are passable default tiles permitted
  , CaveKind -> Bool
clabyrinth    :: Bool                -- ^ waste of time for AI to explore
  , CaveKind -> GroupName TileKind
cdefTile      :: GroupName TileKind  -- ^ the default cave tile
  , CaveKind -> GroupName TileKind
cdarkCorTile  :: GroupName TileKind  -- ^ the dark cave corridor tile
  , CaveKind -> GroupName TileKind
clitCorTile   :: GroupName TileKind  -- ^ the lit cave corridor tile
  , CaveKind -> GroupName TileKind
cwallTile     :: GroupName TileKind  -- ^ the tile used for @FWall@ fence
  , CaveKind -> GroupName TileKind
ccornerTile   :: GroupName TileKind  -- ^ tile used for the fence corners
  , CaveKind -> GroupName TileKind
cfenceTileN   :: GroupName TileKind  -- ^ the outer fence N wall
  , CaveKind -> GroupName TileKind
cfenceTileE   :: GroupName TileKind  -- ^ the outer fence E wall
  , CaveKind -> GroupName TileKind
cfenceTileS   :: GroupName TileKind  -- ^ the outer fence S wall
  , CaveKind -> GroupName TileKind
cfenceTileW   :: GroupName TileKind  -- ^ the outer fence W wall
  , CaveKind -> Bool
cfenceApart   :: Bool                -- ^ are places touching fence banned
  , CaveKind -> X
cminStairDist :: Int                 -- ^ minimal distance between stairs
  , CaveKind -> Dice
cmaxStairsNum :: Dice.Dice           -- ^ maximum number of stairs
  , CaveKind -> Freqs PlaceKind
cescapeFreq   :: Freqs PlaceKind     -- ^ escape groups, if any
  , CaveKind -> Freqs PlaceKind
cstairFreq    :: Freqs PlaceKind     -- ^ place groups for created stairs
  , CaveKind -> Freqs PlaceKind
cstairAllowed :: Freqs PlaceKind     -- ^ extra groups for inherited
  , CaveKind -> [X]
cskip         :: [Int]  -- ^ which faction starting positions to skip
  , CaveKind -> InitSleep
cinitSleep    :: InitSleep           -- ^ whether actors spawn sleeping
  , CaveKind -> Text
cdesc         :: Text   -- ^ full cave description
  }
  deriving X -> CaveKind -> ShowS
[CaveKind] -> ShowS
CaveKind -> String
(X -> CaveKind -> ShowS)
-> (CaveKind -> String) -> ([CaveKind] -> ShowS) -> Show CaveKind
forall a.
(X -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CaveKind] -> ShowS
$cshowList :: [CaveKind] -> ShowS
show :: CaveKind -> String
$cshow :: CaveKind -> String
showsPrec :: X -> CaveKind -> ShowS
$cshowsPrec :: X -> CaveKind -> ShowS
Show  -- No Eq and Ord to make extending logically sound

data InitSleep = InitSleepAlways | InitSleepPermitted | InitSleepBanned
  deriving (X -> InitSleep -> ShowS
[InitSleep] -> ShowS
InitSleep -> String
(X -> InitSleep -> ShowS)
-> (InitSleep -> String)
-> ([InitSleep] -> ShowS)
-> Show InitSleep
forall a.
(X -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InitSleep] -> ShowS
$cshowList :: [InitSleep] -> ShowS
show :: InitSleep -> String
$cshow :: InitSleep -> String
showsPrec :: X -> InitSleep -> ShowS
$cshowsPrec :: X -> InitSleep -> ShowS
Show, InitSleep -> InitSleep -> Bool
(InitSleep -> InitSleep -> Bool)
-> (InitSleep -> InitSleep -> Bool) -> Eq InitSleep
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InitSleep -> InitSleep -> Bool
$c/= :: InitSleep -> InitSleep -> Bool
== :: InitSleep -> InitSleep -> Bool
$c== :: InitSleep -> InitSleep -> Bool
Eq)

-- | Catch caves with not enough space for all the places. Check the size
-- of the cave descriptions to make sure they fit on screen. Etc.
validateSingle :: RK.RuleContent -> CaveKind -> [Text]
validateSingle :: RuleContent -> CaveKind -> [Text]
validateSingle RuleContent
corule CaveKind{Bool
X
[X]
Freqs ItemKind
Freqs PlaceKind
Freqs CaveKind
Rational
Text
DiceXY
Dice
GroupName TileKind
InitSleep
cdesc :: Text
cinitSleep :: InitSleep
cskip :: [X]
cstairAllowed :: Freqs PlaceKind
cstairFreq :: Freqs PlaceKind
cescapeFreq :: Freqs PlaceKind
cmaxStairsNum :: Dice
cminStairDist :: X
cfenceApart :: Bool
cfenceTileW :: GroupName TileKind
cfenceTileS :: GroupName TileKind
cfenceTileE :: GroupName TileKind
cfenceTileN :: GroupName TileKind
ccornerTile :: GroupName TileKind
cwallTile :: GroupName TileKind
clitCorTile :: GroupName TileKind
cdarkCorTile :: GroupName TileKind
cdefTile :: GroupName TileKind
clabyrinth :: Bool
cpassable :: Bool
cplaceFreq :: Freqs PlaceKind
citemFreq :: Freqs ItemKind
citemNum :: Dice
cactorFreq :: Freqs ItemKind
cactorCoeff :: X
chidden :: X
copenChance :: Rational
cdoorChance :: Rational
cmaxVoid :: Rational
cauxConnects :: Rational
cnightOdds :: Dice
cdarkOdds :: Dice
cmaxPlaceSize :: DiceXY
cminPlaceSize :: DiceXY
ccellSize :: DiceXY
cYminSize :: X
cXminSize :: X
cfreq :: Freqs CaveKind
cname :: Text
cdesc :: CaveKind -> Text
cinitSleep :: CaveKind -> InitSleep
cskip :: CaveKind -> [X]
cstairAllowed :: CaveKind -> Freqs PlaceKind
cstairFreq :: CaveKind -> Freqs PlaceKind
cescapeFreq :: CaveKind -> Freqs PlaceKind
cmaxStairsNum :: CaveKind -> Dice
cminStairDist :: CaveKind -> X
cfenceApart :: CaveKind -> Bool
cfenceTileW :: CaveKind -> GroupName TileKind
cfenceTileS :: CaveKind -> GroupName TileKind
cfenceTileE :: CaveKind -> GroupName TileKind
cfenceTileN :: CaveKind -> GroupName TileKind
ccornerTile :: CaveKind -> GroupName TileKind
cwallTile :: CaveKind -> GroupName TileKind
clitCorTile :: CaveKind -> GroupName TileKind
cdarkCorTile :: CaveKind -> GroupName TileKind
cdefTile :: CaveKind -> GroupName TileKind
clabyrinth :: CaveKind -> Bool
cpassable :: CaveKind -> Bool
cplaceFreq :: CaveKind -> Freqs PlaceKind
citemFreq :: CaveKind -> Freqs ItemKind
citemNum :: CaveKind -> Dice
cactorFreq :: CaveKind -> Freqs ItemKind
cactorCoeff :: CaveKind -> X
chidden :: CaveKind -> X
copenChance :: CaveKind -> Rational
cdoorChance :: CaveKind -> Rational
cmaxVoid :: CaveKind -> Rational
cauxConnects :: CaveKind -> Rational
cnightOdds :: CaveKind -> Dice
cdarkOdds :: CaveKind -> Dice
cmaxPlaceSize :: CaveKind -> DiceXY
cminPlaceSize :: CaveKind -> DiceXY
ccellSize :: CaveKind -> DiceXY
cYminSize :: CaveKind -> X
cXminSize :: CaveKind -> X
cfreq :: CaveKind -> Freqs CaveKind
cname :: CaveKind -> Text
..} =
  let (X
minCellSizeX, X
minCellSizeY) = DiceXY -> (X, X)
Dice.infDiceXY DiceXY
ccellSize
      (X
maxCellSizeX, X
maxCellSizeY) = DiceXY -> (X, X)
Dice.supDiceXY DiceXY
ccellSize
      (X
minMinSizeX, X
minMinSizeY) = DiceXY -> (X, X)
Dice.infDiceXY DiceXY
cminPlaceSize
      (X
maxMinSizeX, X
maxMinSizeY) = DiceXY -> (X, X)
Dice.supDiceXY DiceXY
cminPlaceSize
      (X
minMaxSizeX, X
minMaxSizeY) = DiceXY -> (X, X)
Dice.infDiceXY DiceXY
cmaxPlaceSize
  in [ Text
"cname longer than 25" | Text -> X
T.length Text
cname X -> X -> Bool
forall a. Ord a => a -> a -> Bool
> X
25 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cXminSize > RK.rWidthMax" | X
cXminSize X -> X -> Bool
forall a. Ord a => a -> a -> Bool
> RuleContent -> X
RK.rWidthMax RuleContent
corule ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cYminSize > RK.rHeightMax" | X
cYminSize X -> X -> Bool
forall a. Ord a => a -> a -> Bool
> RuleContent -> X
RK.rHeightMax RuleContent
corule ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cXminSize < 8" | X
cXminSize X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
8 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cYminSize < 8" | X
cYminSize X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
8 ]  -- see @focusArea@
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cXminSize - 2 < maxCellSizeX" | X
cXminSize X -> X -> X
forall a. Num a => a -> a -> a
- X
2 X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
maxCellSizeX ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cYminSize - 2 < maxCellSizeY" | X
cYminSize X -> X -> X
forall a. Num a => a -> a -> a
- X
2 X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
maxCellSizeY ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeX < 2" | X
minCellSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
2 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeY < 2" | X
minCellSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
2 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeX < 4 and stairs"
        | X
minCellSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
4 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cstairFreq) ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeY < 4 and stairs"
        | X
minCellSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
4 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cstairFreq) ]
     -- The following four are heuristics, so not too restrictive:
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeX < 6 && non-trivial stairs"
        | X
minCellSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
6 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> X
forall a. [a] -> X
length Freqs PlaceKind
cstairFreq X -> X -> Bool
forall a. Ord a => a -> a -> Bool
<= X
1 Bool -> Bool -> Bool
&& Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cescapeFreq) ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minCellSizeY < 4 && non-trivial stairs"
        | X
minCellSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
4 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> X
forall a. [a] -> X
length Freqs PlaceKind
cstairFreq X -> X -> Bool
forall a. Ord a => a -> a -> Bool
<= X
1 Bool -> Bool -> Bool
&& Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cescapeFreq) ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMinSizeX < 5 && non-trivial stairs"
        | X
minMinSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
5 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> X
forall a. [a] -> X
length Freqs PlaceKind
cstairFreq X -> X -> Bool
forall a. Ord a => a -> a -> Bool
<= X
1 Bool -> Bool -> Bool
&& Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cescapeFreq) ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMinSizeY < 3 && non-trivial stairs"
        | X
minMinSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
3 Bool -> Bool -> Bool
&& Bool -> Bool
not (Freqs PlaceKind -> X
forall a. [a] -> X
length Freqs PlaceKind
cstairFreq X -> X -> Bool
forall a. Ord a => a -> a -> Bool
<= X
1 Bool -> Bool -> Bool
&& Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cescapeFreq) ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMinSizeX < 1" | X
minMinSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
1 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMinSizeY < 1" | X
minMinSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
1 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMaxSizeX < maxMinSizeX" | X
minMaxSizeX X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
maxMinSizeX ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"minMaxSizeY < maxMinSizeY" | X
minMaxSizeY X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
maxMinSizeY ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"chidden < 0" | X
chidden X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
0 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cactorCoeff < 0" | X
cactorCoeff X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
0 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"citemNum < 0" | Dice -> X
Dice.infDice Dice
citemNum X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
0 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"cmaxStairsNum < 0" | Dice -> X
Dice.infDice Dice
cmaxStairsNum X -> X -> Bool
forall a. Ord a => a -> a -> Bool
< X
0 ]
     [Text] -> [Text] -> [Text]
forall a. [a] -> [a] -> [a]
++ [ Text
"stairs suggested, but not defined"
        | Dice -> X
Dice.supDice Dice
cmaxStairsNum X -> X -> Bool
forall a. Ord a => a -> a -> Bool
> X
0 Bool -> Bool -> Bool
&& Freqs PlaceKind -> Bool
forall a. [a] -> Bool
null Freqs PlaceKind
cstairFreq ]

-- | Validate all cave kinds.
-- Note that names don't have to be unique: we can have several variants
-- of a cave with a given name.
validateAll :: [CaveKind] -> ContentData CaveKind -> [Text]
validateAll :: [CaveKind] -> ContentData CaveKind -> [Text]
validateAll [CaveKind]
_ ContentData CaveKind
_ = []  -- so far, always valid

-- * Mandatory item groups

mandatoryGroups :: [GroupName CaveKind]
mandatoryGroups :: [GroupName CaveKind]
mandatoryGroups =
       [GroupName CaveKind
DEFAULT_RANDOM]

pattern DEFAULT_RANDOM :: GroupName CaveKind

pattern $bDEFAULT_RANDOM :: GroupName CaveKind
$mDEFAULT_RANDOM :: forall r. GroupName CaveKind -> (Void# -> r) -> (Void# -> r) -> r
DEFAULT_RANDOM = GroupName "default random"

makeData :: RK.RuleContent
         -> [CaveKind] -> [GroupName CaveKind] -> [GroupName CaveKind]
         -> ContentData CaveKind
makeData :: RuleContent
-> [CaveKind]
-> [GroupName CaveKind]
-> [GroupName CaveKind]
-> ContentData CaveKind
makeData RuleContent
corule [CaveKind]
content [GroupName CaveKind]
groupNamesSingleton [GroupName CaveKind]
groupNames =
  String
-> (CaveKind -> Text)
-> (CaveKind -> Freqs CaveKind)
-> (CaveKind -> [Text])
-> ([CaveKind] -> ContentData CaveKind -> [Text])
-> [CaveKind]
-> [GroupName CaveKind]
-> [GroupName CaveKind]
-> ContentData CaveKind
forall c.
Show c =>
String
-> (c -> Text)
-> (c -> Freqs c)
-> (c -> [Text])
-> ([c] -> ContentData c -> [Text])
-> [c]
-> [GroupName c]
-> [GroupName c]
-> ContentData c
makeContentData String
"CaveKind" CaveKind -> Text
cname CaveKind -> Freqs CaveKind
cfreq (RuleContent -> CaveKind -> [Text]
validateSingle RuleContent
corule) [CaveKind] -> ContentData CaveKind -> [Text]
validateAll
                  [CaveKind]
content
                  [GroupName CaveKind]
groupNamesSingleton
                  ([GroupName CaveKind]
mandatoryGroups [GroupName CaveKind]
-> [GroupName CaveKind] -> [GroupName CaveKind]
forall a. [a] -> [a] -> [a]
++ [GroupName CaveKind]
groupNames)