-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Detect which OS you're running on.
--   
--   This package lets you easily query various facts about the system that
--   your code is running on. Currently, it reports whether the operating
--   system is "Windows" or "Unix", and also the name and version of the
--   Haskell compiler used.
--   
--   This package implements lots of complicated trickery to determine the
--   build environment. Once built, other packages can query this
--   information without needing to do complex trickery themselves.
--   
--   Design assumptions:
--   
--   <ul>
--   <li>You are using GHC, version 6.8.1 or newer.</li>
--   <li>You build this package using the Cabal-install tool. (Just doing
--   <tt>runhaskell Setup</tt> won't work properly.)</li>
--   </ul>
--   
--   If these conditions are not met, the package should still
--   <i>build</i>, it's just that all the compile-time constants will come
--   back as <a>Nothing</a>.
--   
--   See also the included <tt>ReadMe.xhtml</tt> file.
@package AC-BuildPlatform
@version 1.0.0


-- | Query basic properties of the current platform.
--   
--   All of these values are compile-time constants. If the special magic
--   in the package configure step was unable to determine the correct
--   value for something, it comes back as <a>Nothing</a>.
module System.Platform

-- | A list of all possible operating system types.
data OS_Type

-- | Some version of Microsoft Windows.
MS_Windows :: OS_Type

-- | Any sufficiently "Unix-like" system.
Unix :: OS_Type

-- | The type of operating system under which we are running (or
--   <a>Nothing</a> if this could not be detected).
os_type :: Maybe OS_Type

-- | The name of the compiler (e.g., <tt>"GHC"</tt>), or <a>Nothing</a> if
--   this could not be detected.
compiler_name :: Maybe String

-- | The numerical version string for the compiler (e.g.,
--   <tt>"6.10.2"</tt>), or <a>Nothing</a> if this could not be detected.
compiler_version :: Maybe String
instance Eq OS_Type
instance Show OS_Type