Language.Perl

Interact with embedded Perl interpreter.

Interpreter instance

Pretty much any function in this module will only operated correctly if a properly initialized interpreter instance exists -- that is, the function hsperl_init has been called. You don't have to pass the resulting Interpreter to the functions, typically -- rather, calling hsperl_init has the side effect of initializing various global variables needed by Perl. Normally, only one interpreter instance can exist at a time (unless your Perl library has been specially compiled to allow for multiple instances -- see perlembed).

For convenience, a bracket-like function is provided, withPerl, which creates an interpreter using hsperl_init, cleans up afterwards using perl_destruct, and runs your IO actions in between.

Calling withPerl creates an Interpreter instance that is equivalent to running

perl -e ""

at the command-line.

Perl calling context

data Context

Perl's calling context.

Constructors

VoidCtx

ScalarCtx

ListCtx

Instances

Enum Context

Methods

succ :: Context -> Context

pred :: Context -> Context

toEnum :: Int -> Context

fromEnum :: Context -> Int

enumFrom :: Context -> [Context]

enumFromThen :: Context -> Context -> [Context]

enumFromTo :: Context -> Context -> [Context]

enumFromThenTo :: Context -> Context -> Context -> [Context]

Eq Context

Methods

(==) :: Context -> Context -> Bool

(/=) :: Context -> Context -> Bool

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

Major types

data SV

(pointer to a) scalar value.

Instances

Eq SV

Methods

(==) :: SV -> SV -> Bool

(/=) :: SV -> SV -> Bool

Show SV

Methods

showsPrec :: Int -> SV -> ShowS

show :: SV -> String

showList :: [SV] -> ShowS

FromSV SV

Methods

fromSV :: SV -> IO SV

ToSV SV

Methods

toSV :: SV -> IO SV

Marshal values between Haskell and Perl

class ToSV a where

Data types that can be cast to a Perl 5 value (SV).

Minimal complete definition

toSV

Methods

toSV :: a -> IO SV

Instances

ToSV Bool

Methods

toSV :: Bool -> IO SV

ToSV Int

For convenience, a ToSV instance is provided for Ints. However, a Haskell Int on your platform might not be the same size as Perl's integral type - for an exact conversion, see the instance for IV.

Methods

toSV :: Int -> IO SV

ToSV ()

Methods

toSV :: () -> IO SV

ToSV String

Methods

toSV :: String -> IO SV

ToSV Text

Methods

toSV :: Text -> IO SV

ToSV NV

Methods

toSV :: NV -> IO SV

ToSV IV

Methods

toSV :: IV -> IO SV

ToSV SV

Methods

toSV :: SV -> IO SV

ToArgs a => ToSV (IO a)

Methods

toSV :: IO a -> IO SV

(ToArgs a, FromArgs (r1, r2)) => ToSV (r1 -> r2 -> a)

Methods

toSV :: (r1 -> r2 -> a) -> IO SV

(ToArgs a, FromArgs r) => ToSV (r -> a)

Methods

toSV :: (r -> a) -> IO SV

(ToArgs a, FromArgs (r1, r2)) => ToSV (r1 -> r2 -> IO a)

Methods

toSV :: (r1 -> r2 -> IO a) -> IO SV

(ToArgs a, FromArgs r) => ToSV (r -> IO a)

Methods

toSV :: (r -> IO a) -> IO SV

class FromSV a where

Data types that can be cast from a Perl 5 value (SV).

Minimal complete definition

fromSV

Methods

fromSV :: SV -> IO a

Instances

FromSV Bool

Methods

fromSV :: SV -> IO Bool

FromSV Int

Methods

fromSV :: SV -> IO Int

FromSV ()

Methods

fromSV :: SV -> IO ()

FromSV String

Methods

fromSV :: SV -> IO String

FromSV Text

Methods

fromSV :: SV -> IO Text

FromSV NV

Methods

fromSV :: SV -> IO NV

FromSV IV

Methods

fromSV :: SV -> IO IV

FromSV SV

Methods

fromSV :: SV -> IO SV

FromArgs r => FromSV (IO r)

Methods

fromSV :: SV -> IO (IO r)

(ToArgs a, ToArgs b, FromArgs r) => FromSV (a -> b -> IO r)

Methods

fromSV :: SV -> IO (a -> b -> IO r)

(ToArgs a, FromArgs r) => FromSV (a -> IO r)

Methods

fromSV :: SV -> IO (a -> IO r)

Safely run Perl things

withPerl :: IO a -> IO a

Run a computation within the context of a Perl 5 interpreter.

evaluate in a Perl context

callSub :: forall s a r. (ToCV s, ToArgs a, FromArgs r) => s -> a -> IO r

Call a Perl 5 subroutine.

(.:) :: (ToCV sub, ToArgs args, FromArgs ret) => sub -> args -> IO ret

alias for callSub

(.!) :: (ToCV sub, ToArgs args) => sub -> args -> IO ()

version of callSub that returns no result

callMethod :: forall i m a r. (ToSV i, ToSV m, ToArgs a, FromArgs r) => i -> m -> a -> IO r

Call a Perl 5 method.

(.$) :: (ToSV meth, ToArgs args, FromArgs ret) => SV -> meth -> args -> IO ret

alias for callMethod

(.$!) :: (ToSV meth, ToArgs args) => SV -> meth -> args -> IO ()

version of callMethod that returns no result

eval :: forall a. FromArgs a => String -> IO a

Evaluate a snippet of Perl 5 code.

eval_ :: String -> IO ()

Same as eval but always in void context.

utility functions

use :: String -> IO SV

Use a module. Returns a prototype object representing the module.