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


-- | Finding out the full path of the executable.
--   
--   The documentation of <a>System.Environment.getProgName</a> says that
--   "However, this is hard-to-impossible to implement on some non-Unix
--   OSes, so instead, for maximum portability, we just return the leafname
--   of the program as invoked." This library tries to provide the missing
--   path.
@package executable-path
@version 0.0.3


-- | The documentation of <a>System.Environment.getProgName</a> says that
--   
--   "However, this is hard-to-impossible to implement on some non-Unix
--   OSes, so instead, for maximum portability, we just return the leafname
--   of the program as invoked. Even then there are some differences
--   between platforms: on Windows, for example, a program invoked as foo
--   is probably really FOO.EXE, and that is what <a>getProgName</a> will
--   return."
--   
--   This library tries to fix this issue. It also provides some
--   platform-specific functions (most notably getting the path of the
--   application bundle on OSX). Supported operating systems:
--   
--   <ul>
--   <li>Win32 (tested on Windows XP / x86 only)</li>
--   <li>Mac OS X (tested on Leopard / x86 only)</li>
--   <li>Linux</li>
--   <li>FreeBSD (tested on FreeBSD 6.4)</li>
--   <li>*BSD (with procfs mounted, plus fallback for certain shells;
--   untested)</li>
--   <li>Solaris (untested, and probably works on Solaris 10 only)</li>
--   </ul>
module System.Environment.Executable
getExecutablePath :: IO FilePath
splitExecutablePath :: IO (FilePath, FilePath)
data ScriptPath

-- | it was (probably) a proper compiled executable
Executable :: FilePath -> ScriptPath

-- | it was a script run by runghc/runhaskell
RunGHC :: FilePath -> ScriptPath

-- | we are in GHCi
Interactive :: ScriptPath

-- | An experimental hack which tries to figure out if the program was run
--   with <tt>runghc</tt> or <tt>runhaskell</tt> or <tt>ghci</tt>, and then
--   tries to find out the directory of the <i>source</i> (or object file).
--   
--   GHC only.
getScriptPath :: IO ScriptPath
instance Show ScriptPath