-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.ModuleName
-- Copyright   :  Duncan Coutts 2008
--
-- Maintainer  :  cabal-devel@haskell.org
-- Portability :  portable
--
-- Data type for Haskell module names.

{- All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

    * Neither the name of Isaac Jones nor the names of other
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}

module Distribution.ModuleName (
        ModuleName,
        fromString,
        components,
        toFilePath,
        main,
        simple,
  ) where

import Distribution.Text
         ( Text(..) )

import qualified Distribution.Compat.ReadP as Parse
import qualified Text.PrettyPrint as Disp
import qualified Data.Char as Char
         ( isAlphaNum, isUpper )
import System.FilePath
         ( pathSeparator )
import Data.List
         ( intersperse )

-- | A valid Haskell module name.
--
newtype ModuleName = ModuleName [String]
  deriving (D:Eq :: (a -> a -> Bool) -> (a -> a -> Bool) -> T:Eq aEq, D:Ord ::
  Eq a =>
  (a -> a -> Ordering)
  -> (a -> a -> Bool)
  -> (a -> a -> Bool)
  -> (a -> a -> Bool)
  -> (a -> a -> Bool)
  -> (a -> a -> a)
  -> (a -> a -> a)
  -> T:Ord aOrd, D:Read ::
  (Int -> ReadS a)
  -> ReadS [a]
  -> ReadPrec a
  -> ReadPrec [a]
  -> T:Read aRead, D:Show ::
  (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> T:Show aShow)

instance D:Text :: (a -> Doc) -> (forall r. ReadP r a) -> T:Text aText ModuleName where
  disp (ModuleName ms) =
    hcat :: [Doc] -> DocDisp.hcat (intersperse :: a -> [a] -> [a]intersperse (char :: Char -> DocDisp.char '.') (map :: (a -> b) -> [a] -> [b]map text :: String -> DocDisp.text ms :: [[Char]]ms))

  parse = do
    ms <- sepBy1 :: ReadP r a -> ReadP r sep -> ReadP r [a]Parse.sepBy1 component :: Parser r Char [Char]component (char :: Char -> ReadP r CharParse.char '.')
    return :: Monad m => forall a. a -> m areturn (ModuleName :: [String] -> ModuleNameModuleName ms :: [[Char]]ms)

    where
      component = do
        c  <- satisfy :: (Char -> Bool) -> ReadP r CharParse.satisfy isUpper :: Char -> BoolChar.isUpper
        cs <- munch :: (Char -> Bool) -> ReadP r StringParse.munch validModuleChar :: Char -> BoolvalidModuleChar
        return :: Monad m => forall a. a -> m areturn (c :: Charc(:) :: a -> [a] -> [a]:cs :: Stringcs)

validModuleChar :: Char -> Bool
validModuleChar c = isAlphaNum :: Char -> BoolChar.isAlphaNum c :: Charc (||) :: Bool -> Bool -> Bool|| c :: Charc (==) :: Eq a => a -> a -> Bool== '_' (||) :: Bool -> Bool -> Bool|| c :: Charc (==) :: Eq a => a -> a -> Bool== '\''

validModuleComponent :: String -> Bool
validModuleComponent []     = False :: BoolFalse
validModuleComponent (c:cs) = isUpper :: Char -> BoolChar.isUpper c :: Charc
                           (&&) :: Bool -> Bool -> Bool&& all :: (a -> Bool) -> [a] -> Boolall validModuleChar :: Char -> BoolvalidModuleChar cs :: Stringcs

{-# DEPRECATED simple "use ModuleName.fromString instead" #-}
simple :: String -> ModuleName
simple str = ModuleName :: [String] -> ModuleNameModuleName [str :: Stringstr]

-- | Construct a 'ModuleName' from a valid module name 'String'.
--
-- This is just a convenience function intended for valid module strings. It is
-- an error if it is used with a string that is not a valid module name. If you
-- are parsing user input then use 'Distribution.Text.simpleParse' instead.
--
fromString :: String -> ModuleName
fromString string
  | all :: (a -> Bool) -> [a] -> Boolall validModuleComponent :: String -> BoolvalidModuleComponent components' :: [[Char]]components' = ModuleName :: [String] -> ModuleNameModuleName components' :: [[Char]]components'
  | otherwise :: Boolotherwise                            = error :: [Char] -> aerror badName :: [Char]badName

  where
    components' = split :: [Char] -> [[Char]]split string :: Stringstring
    badName     = "ModuleName.fromString: invalid module name " (++) :: [a] -> [a] -> [a]++ show :: Show a => a -> Stringshow string :: Stringstring

    split cs = case break :: (a -> Bool) -> [a] -> ([a], [a])break ((==) :: Eq a => a -> a -> Bool=='.') cs :: Stringcs of
      (chunk,[])     -> chunk :: [Char]chunk (:) :: a -> [a] -> [a]: [] :: [a][]
      (chunk,_:rest) -> chunk :: [Char]chunk (:) :: a -> [a] -> [a]: split :: [Char] -> [[Char]]split rest :: [Char]rest

-- | The module name @Main@.
--
main :: ModuleName
main = ModuleName :: [String] -> ModuleNameModuleName ["Main"]

-- | The individual components of a hierarchical module name. For example
--
-- > components (fromString "A.B.C") = ["A", "B", "C"]
--
components :: ModuleName -> [String]
components (ModuleName ms) = ms :: [[Char]]ms

-- | Convert a module name to a file path, but without any file extension.
-- For example:
--
-- > toFilePath (fromString "A.B.C") = "A/B/C"
--
toFilePath :: ModuleName -> FilePath
toFilePath = concat :: [[a]] -> [a]concat (.) :: (b -> c) -> (a -> b) -> a -> c. intersperse :: a -> [a] -> [a]intersperse [pathSeparator :: CharpathSeparator] (.) :: (b -> c) -> (a -> b) -> a -> c. components :: ModuleName -> [String]components