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


-- | Java interop via inline Java code in Haskell modules.
--   
--   Please see README.md.
@package inline-java
@version 0.9.0


-- | This module contains Cabal <tt>Setup.hs</tt> hooks to set the
--   <tt>CLASSPATH</tt> to use when compiling inline code. The
--   <tt>CLASSPATH</tt> environment variable specifies where to find JVM
--   package dependencies, such as third party packages downloaded from
--   <a>Maven Central</a>.
--   
--   You can set the <tt>CLASSPATH</tt> manually, or extract one from an
--   external build system configuration. Currently supported build
--   systems:
--   
--   <ul>
--   <li><a>Gradle</a></li>
--   </ul>
module Language.Java.Inline.Cabal

-- | Adds the <a>prependClasspathWithGradle</a> and <a>gradleBuild</a>
--   hooks.
--   
--   Also adds the jar produced by gradle to the data-files.
gradleHooks :: UserHooks -> UserHooks

-- | Prepends the <tt>CLASSPATH</tt> with the classpath from a Gradle build
--   configuration.
prependClasspathWithGradle :: Args -> b -> IO HookedBuildInfo

-- | Call <tt>gradle build</tt> as part of the Cabal build. Useful to e.g.
--   build auxiliary Java source code and to create packages.
gradleBuild :: PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO ()

-- | Prepends the given jar paths to the CLASSPATH.
addJarsToClasspath :: [FilePath] -> UserHooks -> UserHooks


-- | Internal module defining some magic, kept separate from the rest, that
--   depends on compiler internals.
module Language.Java.Inline.Internal.Magic

-- | The bytecode corresponding to a java class
data DotClass
DotClass :: String -> ByteString -> DotClass
[className] :: DotClass -> String
[classBytecode] :: DotClass -> ByteString
data JavaImport
JavaImport :: String -> Integer -> JavaImport

-- | Runs the given function for every class in the bytecode table.
forEachDotClass :: (DotClass -> IO ()) -> IO ()

-- | Produces a Java class name from a package and a module name.
mangleClassName :: String -> String -> String
instance Language.Haskell.TH.Syntax.Lift Language.Java.Inline.Internal.Magic.JavaImport
instance Data.Data.Data Language.Java.Inline.Internal.Magic.JavaImport


-- | <h1>Inline Java quasiquotation</h1>
--   
--   See the <a>GHC manual</a> for an introduction to quasiquotation. The
--   quasiquoter exported in this module allows embedding arbitrary Java
--   expressions and blocks of statements inside Haskell code. You can call
--   any Java method and define arbitrary inline code using Java syntax. No
--   FFI required.
--   
--   Here is the same example as in <a>Language.Java</a>, but with inline
--   Java calls:
--   
--   <pre>
--   {-# LANGUAGE DataKinds #-}
--   {-# LANGUAGE QuasiQuotes #-}
--   module Object where
--   
--   import Language.Java as J
--   import Language.Java.Inline
--   
--   newtype Object = Object (<a>J</a> ('<a>Class</a> "java.lang.Object"))
--   instance <a>Coercible</a> Object
--   
--   clone :: Object -&gt; IO Object
--   clone obj = [java| $obj.clone() |]
--   
--   equals :: Object -&gt; Object -&gt; IO Bool
--   equals obj1 obj2 = [java| $obj1.equals($obj2) |]
--   
--   ...
--   </pre>
module Language.Java.Inline.Internal
javaWithConfig :: QQConfig -> QuasiQuoter

-- | Customizes how quasiquotations are desugared.
data QQConfig
QQConfig :: Name -> ([ExpQ] -> ExpQ) -> (ExpQ -> ExpQ) -> QQConfig

-- | This is the name of the function to use to indicate to the plugin the
--   presence of a java quasiquotation.
[qqMarker] :: QQConfig -> Name

-- | This produces the call invoke the Java stub. It takes the list of
--   arguments that should be passed to the call.
[qqCallStatic] :: QQConfig -> [ExpQ] -> ExpQ

-- | This is given as argument the invocation of the Java stub, and is
--   expected to prepend it with code that ensures that the stub is
--   previously loaded in the JVM.
[qqWrapMarker] :: QQConfig -> ExpQ -> ExpQ

-- | Declares <i>import</i> statements to be included in the java
--   compilation unit. e.g.
--   
--   <pre>
--   imports "java.util.*"
--   </pre>
imports :: String -> Q [Dec]

-- | Idempotent action that loads all wrappers in every module of the
--   current program into the JVM. You shouldn't need to call this
--   yourself.
loadJavaWrappers :: IO ()

module Language.Java.Inline.Internal.QQMarker

-- | A function to indicate to the plugin the occurrence of java
--   quasiquotations
qqMarker :: forall k (args_tys :: k) tyres (input :: Symbol) (mname :: Symbol) (antiqs :: Symbol) (line :: Nat) args_tuple b m. (tyres ~ Ty b, Coercibles args_tuple args_tys, Coercible b, HasCallStack) => Proxy input -> Proxy mname -> Proxy antiqs -> Proxy line -> args_tuple -> Proxy args_tys -> (args_tuple -> m b) -> m b
class Coercibles xs (tys :: k) | xs -> tys
instance Language.Java.Inline.Internal.QQMarker.Coercibles () ()
instance forall k (ty :: Foreign.JNI.Types.JType) x xs (tys :: k). (ty GHC.Types.~ Language.Java.Unsafe.Ty x, Language.Java.Unsafe.Coercible x, Language.Java.Inline.Internal.QQMarker.Coercibles xs tys) => Language.Java.Inline.Internal.QQMarker.Coercibles (x, xs) '(ty, tys)

module Language.Java.Inline.Internal.QQMarker.Names

-- | Get the names of all markers used for java quasiquotations.
getQQMarkers :: CoreM [Name]


-- | This plugin generates Java bytecode from modules using the java
--   QuasiQuoter and inserts it in a global bytecode table from where it is
--   loaded at runtime.
module Language.Java.Inline.Plugin
plugin :: Plugin


-- | <h1>Inline Java quasiquotation</h1>
--   
--   See the <a>GHC manual</a> for an introduction to quasiquotation. The
--   quasiquoter exported in this module allows embedding arbitrary Java
--   expressions and blocks of statements inside Haskell code. You can call
--   any Java method and define arbitrary inline code using Java syntax. No
--   FFI required.
--   
--   Here is the same example as in <a>Language.Java</a>, but with inline
--   Java calls:
--   
--   <pre>
--   {-# LANGUAGE DataKinds #-}
--   {-# LANGUAGE QuasiQuotes #-}
--   module Object where
--   
--   import Language.Java as J
--   import Language.Java.Inline.Unsafe
--   
--   newtype Object = Object (<a>J</a> ('<a>Class</a> "java.lang.Object"))
--   instance <a>Coercible</a> Object
--   
--   clone :: Object -&gt; IO Object
--   clone obj = [java| $obj.clone() |]
--   
--   equals :: Object -&gt; Object -&gt; IO Bool
--   equals obj1 obj2 = [java| $obj1.equals($obj2) |]
--   
--   ...
--   </pre>
--   
--   The functions in this module are considered unsafe in opposition to
--   those in <a>Language.Java.Inline.Safe</a>, which ensure that local
--   references are not leaked.
module Language.Java.Inline.Unsafe

-- | Java code quasiquoter. Example:
--   
--   <pre>
--   imports "javax.swing.JOptionPane"
--   
--   hello :: IO ()
--   hello = do
--       message &lt;- reflect ("Hello World!" :: Text)
--       [java| JOptionPane.showMessageDialog(null, $message) |]
--   </pre>
--   
--   A quasiquote is a snippet of Java code. The code is assumed to be a
--   block (sequence of statements) if the first non whitespace character
--   is a <tt>{</tt> (curly brace) character. Otherwise it's parsed as an
--   expression. Variables with an initial <tt>$</tt> (dollar) sign are
--   allowed. They have a special meaning: they stand for antiqotation
--   variables (think of them as format specifiers in printf format
--   string). An antiquotation variable <tt>$foo</tt> is well-scoped if
--   there exists a variable with the name <tt>foo</tt> in the Haskell
--   context of the quasiquote, whose type is <a>Coercible</a> to a Java
--   primitive or reference type.
java :: QuasiQuoter

-- | Declares <i>import</i> statements to be included in the java
--   compilation unit. e.g.
--   
--   <pre>
--   imports "java.util.*"
--   </pre>
imports :: String -> Q [Dec]

-- | Idempotent action that loads all wrappers in every module of the
--   current program into the JVM. You shouldn't need to call this
--   yourself.
loadJavaWrappers :: IO ()


-- | This module reexports <a>Language.Java.Inline.Unsafe</a>.
module Language.Java.Inline