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


-- | Wrapper around the webdriver package that automatically manages Selenium
--   
--   Please see the README on GitHub at
--   <a>https://github.com/gtollini/webdriver-wrapper#readme</a>
@package webdriver-wrapper
@version 0.1.0.0


module Test.WebDriverWrapper.Constants

-- | Path for geckodriver. Inside <a>downloadPath</a>.
geckoDriverPath :: IO FilePath

-- | <tt>haskell-webdriver-wrapper</tt> directory, created at
--   <a>XdgData</a>.
defaultPath :: IO FilePath

-- | Url to download Selenium from.
defaultSeleniumJarUrl :: String

-- | Platform this code is running at. The options are:
--   
--   <ul>
--   <li>win64</li>
--   <li>win-aarch64</li>
--   <li>win32</li>
--   <li>macos</li>
--   <li>macos-aarch64</li>
--   <li>linux64</li>
--   <li>linux-aarch64</li>
--   <li>linux32</li>
--   </ul>
--   
--   If the platform is not identified, <tt>linux64</tt> is used.
desiredPlatform :: String

-- | Url to download geckodriver from. Always the latest version provided
--   by <a>geckoDriverVersionSource</a>.
getGeckoDriverDownloadUrl :: String -> String

-- | API to get geckodriver's latest version.
geckoDriverVersionSource :: String

-- | Directory named after <a>desiredPlatform</a>, created at the
--   <a>defaultPath</a>.
downloadPath :: IO FilePath

-- | Intermediary path for the compressed version of geckodriver. Inside
--   <a>downloadPath</a>.
geckoArchivePath :: IO FilePath

-- | Archive format for geckodriver's download. <tt>.zip</tt> for Windows,
--   <tt>.tar.gz</tt> for everyone else.
fileFormat :: String

-- | Path for selenium.jar. Inside <a>downloadPath</a>.
seleniumPath :: IO FilePath

-- | Path for Selenium's log file. Inside <a>defaultPath</a>.
seleniumLogPath :: IO FilePath


module Test.WebDriverWrapper.Helpers

-- | Downloads from <tt>url</tt> at <tt>output</tt> filepath.
download :: String -> FilePath -> IO ()

-- | Decompresses geckodriver's download, which comes in <tt>.zip</tt> for
--   Windows or <tt>.tar.gz</tt> for everyone else. Takes in the archive's
--   filepath and the output filepath.
decompress :: FilePath -> FilePath -> IO ()

module Test.WebDriverWrapper.GeckoDriver

-- | Checks if <tt>geckodriver</tt> is in the <a>downloadPath</a>. If not,
--   download it.
getGeckoDriverIfNeeded :: IO ()

module Test.WebDriverWrapper.Selenium

-- | Starts Selenium and waits for its ok message ( "Selenium Server is up
--   and running" ) to show up at the log file. Returns the handles for the
--   Selenium process.
startSelenium :: IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)

-- | Checks if <tt>selenium</tt> is in the <a>downloadPath</a>. If not,
--   download it.
getSeleniumIfNeeded :: IO ()


-- | The wrapped functions (<a>wrappedRunSession</a> and
--   <a>wrappedRunWD</a>) will download Selenium and Firefox's webdriver
--   (geckodriver) if they're not already on the <a>downloadPath</a>, then
--   start Selenium before running the webdriver equivalent function
--   (<a>runSession</a> and <a>runWD</a>). They kill the Selenium process
--   at the end of their execution.
module Test.WebDriverWrapper

-- | Same as <a>runSession</a>, but starts Selenium before execution and
--   kills Selenium after execution. Will download Selenium or Firefox's
--   webdriver (geckodriver) if any is missing.
wrappedRunSession :: WebDriverConfig conf => conf -> WD a -> IO a

-- | Same as <a>runWD</a>, but starts Selenium before execution and kills
--   Selenium after execution. Will download Selenium or Firefox's
--   webdriver (geckodriver) if any is missing.
wrappedRunWD :: WDSession -> WD a -> IO a

-- | Runs a function in between starting and killing Selenium. Takes in the
--   arguments and the function, in that order. Will download Selenium or
--   Firefox's webdriver (geckodriver) if any is missing.
wrapWebDriverFunction :: a -> (a -> IO b) -> IO b

-- | Dowloads Selenium or Firefox's webdriver (geckodriver) if they're
--   missing.
downloadIfMissing :: IO ()