1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
package JavaScript::Context;
use strict;
use warnings;
use Carp qw(croak);
use Scalar::Util qw(weaken);
use JavaScript;
my %Context;
sub new {
my ($pkg, $runtime) = @_;
$pkg = ref $pkg || $pkg;
my $cx_ptr = jsc_create($runtime->{_impl});
my $self = bless { _impl => $cx_ptr }, $pkg;
$Context{${$cx_ptr}} = $self;
weaken($Context{$cx_ptr});
$self->{runtime} = $runtime;
return $self;
}
sub eval {
my ($self, $source, $name) = @_;
# Figure out name of script in case it isn't supplied to us
my @caller = caller();
$name ||= "$caller[0] line $caller[2]";
my $rval = jsc_eval($self->{_impl}, $source, $name);
return $rval;
}
sub eval_file {
my ($self, $file) = @_;
local $/ = undef;
open my $in, "<$file" || die $!;
my $source = <$in>;
close($in);
my $rval = jsc_eval($self->{_impl}, $source, $file);
return $rval;
}
sub find {
my ($self, $context) = @_;
$context = $$context if ref $context eq 'SCALAR';
if (!exists $Context{$context}) {
croak "Can't find context $context";
}
return $Context{$context};
}
sub call {
my $self = shift;
my $function = shift;
my $args = [@_];
return jsc_call($self->{_impl}, $function, $args);
}
sub can {
my ($self, $method) = @_;
return jsc_can($self->{_impl}, $method);
}
# Functions for binding perl stuff into JS namespace
sub bind_function {
my $self = shift;
my %args;
# Handle 2 arg declaration and old 4 arg declaration
if (@_ == 2) {
%args = (name => shift, func => shift);
}
else {
%args = @_;
}
# Check for name
die "Missing argument 'name'\n" unless(exists $args{name});
# TODO: fix die "Argument 'name' must match /^[A-Za-z0-9_]+\$/" unless($args{name} =~ /^[A-Za-z0-9\_]+$/);
# Check for func
die "Missing argument 'func'\n" unless(exists $args{func});
die "Argument 'func' is not a CODE reference\n" unless(ref($args{func}) eq 'CODE');
$self->bind_value($args{name} => $args{func});
return;
}
sub _resolve_method {
my ($inspect, $croak_on_failure) = @_;
return undef if !defined $inspect;
return $inspect if ref $inspect eq 'CODE';
my ($pkg, $method) = $inspect =~ /^(?:(.*)::)?(.*)$/;
$pkg = caller(1) if !defined $pkg || $pkg eq q{};
$pkg = caller(2) if $pkg eq 'JavaScript::Context';
my $callback = $pkg->can($method);
croak "Can't resolve ${pkg}::${method}" if !defined $callback && $croak_on_failure;
return $callback;
}
sub _extract_methods {
my ($args, @arg_keys) = @_;
my $method = {};
for my $arg (@arg_keys) {
if (exists $args->{$arg} && defined $args->{$arg}) {
my $arg = $args->{$arg};
if (ref $arg eq 'HASH') {
for my $name (keys %$arg) {
$method->{$name} = _resolve_method($arg->{$name}, 1);
}
}
elsif(ref $arg eq 'ARRAY') {
for my $name (@$arg) {
$method->{$name} = _resolve_method($name, 1);
}
}
else {
my @methods = split /\s+/, $arg;
for my $name (@methods) {
$method->{$name} = _resolve_method($name, 1);
}
}
}
}
return $method;
}
sub _extract_properties {
my ($args, @arg_keys) = @_;
my $property = {};
for my $arg (@arg_keys) {
if (exists $args->{$arg} && defined $args->{$arg}) {
my $arg = $args->{$arg};
if (ref $arg eq 'HASH') {
for my $name (keys %{$arg}) {
if (ref $arg->{$name} eq 'HASH') {
my $getter = _resolve_method($arg->{$name}->{getter}, 1);
my $setter = _resolve_method($arg->{$name}->{setter}, 1);
$property->{$name} = [ $getter, $setter ];
}
elsif (ref $arg->{$name} eq 'ARRAY') {
my @callbacks = @{$arg->{$name}};
my $getter = _resolve_method(shift @callbacks, 1);
my $setter = _resolve_method(shift @callbacks, 1);
$property->{$name} = [ $getter, $setter ];
}
elsif (ref $arg->{$name} eq '') {
my $getter = sub {
return $_[0]->{$name};
};
my $setter = !($arg->{$name} & JS_PROP_READONLY) ? sub {
$_[0]->{$name} = $_[1];
} : undef;
$property->{$name} = [ $getter, $setter ];
}
}
}
elsif (ref $arg eq 'ARRAY') {
}
else {
my @properties = split /\s+/, $arg;
for my $name (@properties) {
}
}
}
}
return $property;
}
sub bind_class {
my $self = shift;
my %args = @_;
# Check if name argument is valid
die "Missing argument 'name'\n" unless(exists $args{name});
die "Argument 'name' must match /^[A-Za-z0-9_]+\$/" unless($args{name} =~ /^[A-Za-z0-9\_]+$/);
# Check if constructor is supplied and it's an coderef
my $cons;
$cons = _resolve_method($args{constructor}, 1) if exists $args{constructor};
if (exists $args{flags}) {
die "Argument 'flags' is not numeric\n" unless($args{flags} =~ /^\d+$/);
} else {
$args{flags} = 0;
}
unless (exists $args{package}) {
$args{package} = undef;
}
my $name = $args{name};
my $pkg = $args{package} || $name;
# Create a default constructor
if (!defined $cons) {
$cons = sub {
$pkg->new(@_);
};
}
# Per-object methods
my $fs = _extract_methods(\%args, qw(methods fs));
# Per-class methods
my $static_fs = _extract_methods(\%args, qw(static_methods static_fs));
# Per-object properties
my $ps = _extract_properties(\%args, qw(properties ps));
# Per-class properties
my $static_ps = _extract_properties(\%args, qw(static_properties static_ps));
# Flags
my $flags = $args{flags};
jsc_bind_class($self->{_impl}, $name, $pkg, $cons, $fs, $static_fs, $ps, $static_ps, $flags);
return;
}
sub bind_object {
my ($self, $name, $object) = @_;
$self->bind_value($name => $object);
return;
}
sub bind_value {
my ($self, $name, $object, $opt) = @_;
my @paths = split /\./, $name;
my $current;
for my $num (0..$#paths) {
my $parent = join('.', @paths[0..$num-1]);
my $abs = join('.', @paths[0..$num]);
if($self->eval($abs)) {
# We don't want to be able to rebind without unbinding first
croak "${name} already exists, unbind it first" if $num == $#paths;
next;
}
jsc_bind_value($self->{_impl}, $parent,
$paths[$num], $num == $#paths ? $object : {});
}
return;
}
sub unbind_value {
my ($self, $name, $object, $opt) = @_;
my @paths = split /\./, $name;
$name = pop @paths;
my $parent = join(".", @paths);
jsc_unbind_value($self->{_impl}, $parent, $name);
}
sub set_branch_handler {
my ($self, $handler) = @_;
$handler = _resolve_method($handler, 1);
jsc_set_branch_handler($self->{_impl}, $handler);
}
sub compile {
my $self = shift;
my $source = shift;
my $script = JavaScript::Script->new($self->{_impl}, $source);
return $script;
}
sub _destroy {
my $self = shift;
return unless $self->{'_impl'};
delete $Context{${$self->{_impl}}};
jsc_destroy($self->{'_impl'} );
delete $self->{'_impl'};
return 1;
}
sub DESTROY {
my $self = shift;
$self->_destroy();
}
END {
while (my ($k, $v) = %Context) {
if ($Context{$k}) {
delete $Context{$k};
$v->_destroy();
}
}
}
1;
__END__
=head1 NAME
JavaScript::Context - An object in which we can execute JavaScript
=head1 SYNOPSIS
use JavaScript;
# Create a runtime and a context
my $rt = JavaScript::Runtime->new();
my $cx = $rt->create_context();
# Add a function which we can call from JavaScript
$cx->bind_function(print => sub { print @_; });
my $result = $cx->eval($source);
=head1 INTERFACE
=head2 INSTANCE METHODS
=over 4
=item bind_class ( %args )
Defines a new class that can be used from JavaScript in the contet.
It expects the following arguments
=over 4
=item name
The name of the class in JavaScript.
name => "MyPackage",
=item constructor
A reference to a subroutine that returns the Perl object that represents
the JavaScript object. If omitted a default constructor will be supplied that
calls the method C<new> on the defined I<package> (or I<name> if no package is
defined).
constructor => sub { MyPackage->new(@_); },
=item package
The name of the Perl package that represents this class. It will be passed as
first argument to any class methods and also used in the default constructor.
package => "My::Package",
=item methods (fs)
A hash reference of methods that we define for instances of the class. In JavaScript this would be C<o = new MyClass(); o.method()>.
The key is used as the name of the function and the value should be either a reference to a subroutine or the name of the Perl subroutine to call.
methods => { to_string => \&My::Package::to_string,
random => "randomize"
}
=item static_methods (static_ps)
Like I<fs> but these are called on the class itself. In JavaScript this would be C<MyClass.method()>.
=item properties (ps)
A hash reference of properties that we define for instances of the class. In JavaScript this would be C<o = new MyClass(); f = o.property;>
The key is used as the name of the property and the value is used to specify what method to call as a get-operation and as a set-operation.
These can either be specified using references to subroutines or name of subroutines.
If the getter is undefined the property will be write-only and if the setter is undefined the property will be read-only.
You can specify the getter/setter using either an array reference, C<[\&MyClass::get_property, \&MyClass::set_property]>, a string, C<"MyClass::set_property MyClass::get_property"> or a hash reference, C<{ getter => "MyClass::get_property", setter => "MyClass::set_property" }>.
ps => { length => [qw(get_length)],
parent => { getter => \&MyClass::get_parent, setter => \&MyClass::set_parent },
}
=item static_properties (static_ps)
Like I<ps> but these are defined on the class itself. In JavaScript this would be C<f = MyClass.property>.
=item flags
A bitmask of attributes for the class. Valid attributes are:
=over 4
=item JS_CLASS_NO_INSTANCE
Makes the class throw an exception if JavaScript tries to
instansiate the class.
=back
=back
=item bind_function ( name => $name, func => $subroutine )
=item bind_function ( $name => $subroutine )
Defines a Perl subroutine ($subroutine_ref) as a native function with the given I<$name>. The argument $subroutine can either be the name of a subroutine or a reference to one.
=item bind_object ( $name => $object )
Binds a Perl object to the context under a given name.
=item bind_value ( $name => $value )
Defines a value with a given name and value. Trying to redefine an already existing property throws an exception.
=item unbind_value ( $name )
Removed a property from the context or a specified object.
=item call ( $name, @arguments )
=item call ( $function, @arguments )
Calls a function with the given name I<$name> or the B<JavaScript::Function>-object
I<$function> and passes the rest of the arguments to the JavaScript function.
=item can ( $name )
Returns true if there is a function with a given I<$name>, otherwise it returns false.
=item compile ( $source )
Pre-compiles the JavaScript given in I<$source> and returns a C<JavaScript::Script>-object that can be executed over and over again. If an error occures because of a compilation error it returns undef and $@ is set.
=item eval ( $source )
Evaluates the JavaScript code given in I<$source> and
returns the result from the last statement.
If there is a compilation error (such as a syntax error) or an uncaught exception
is thrown in JavaScript this method returns undef and $@ is set.
=item eval_file ( $path )
Evaluates the JavaScript code in the file specified by I<$path> and
returns the result from the last statement.
If there is a compilation error (such as a syntax error) or an uncaught exception
is thrown in JavaScript this method returns undef and $@ is set.
=item find ( $native_context )
Returns the C<JavaScript::Context>-object associated with a given native context.
=item set_branch_handler ( $handler )
Attaches an branch callback handler (a function that is called when a branch is performed) to the context. The argument I<$handler> may be a code-reference or the name of a subroutine.
To remove the handler call this method with an undefined argument.
The handler is called when a script branches backwards during execution, when a function returns and the end of the script. To continue execution the handler must return a true value. To abort execution either throw an exception or return a false value.
=back
=begin PRIVATE
=head1 PRIVATE INTERFACE
=over 4
=item new ( $runtime )
Creates a new C<JavaScript::Context>-object in the supplied runtime.
=item jsc_create ( PCB_Runtime *runtime )
Creates a new context and returns a pointer to a C<PJS_Context> structure.
=item jsc_destroy ( PJS_Context *context )
Destroys the context and deallocates the memory occupied by it.
=item jsc_call ( PJS_Context *context, SV *function, SV *args)
Calls the function defined in I<function> with the arguments passed as an array reference in I<args>. The argument I<function> can either be a string (SVt_PV) or an C<JavaScript::Function> object. Returns the return value from the called function. If the function doesn't exist or a uncaught exception is thrown it returns undef and sets $@.
=item jsc_call_in_context ( PJS_Context *context, SV *function, SV *args, SV *rcx, char *class)
TDB
=item jsc_can ( PJS_Context *context, char *name )
Checks if the function defined by I<name> exists in the context and if so returns 1, otherwise it returns 0.
=item jsc_eval ( PJS_Context *context, char *source, char *name )
Evalutes the JavaScript code given in I<source> and returns the result from the last executed statement. The argument I<name> defines the name of the script to be used when reporting errors. If an error occures such as a compilation error (maybe due to syntax error) or an uncaught exception is thrown it returns undef and sets $@.
=item jsc_free_root ( PJS_Context *context, SV *root )
Removes the root on the JavaScript variable boxed by I<root> that prevents it from being garbage collected by the runtime.
=item jsc_bind_class ( PJS_Context *context, char *name, SV *constructor, SV *methods, SV *properties, SV *package, SV *flags )
Binds a class to the context.
=item jsc_bind_function ( PJS_Context *context, char *name, SV *function )
Binds a function to the context.
=item jsc_bind_value ( PJS_Context *context, char *parent, char *name, SV *object)
Defines a new named property in I<parent> with the value of I<object>.
=item jsc_unbind_value ( PJS_Context *context, char *parent, char *name)
Removes a new named property in I<parent>.
=item jsc_set_branch_handler ( PJS_Context *context, SV *handler )
Attaches a branch handler to the context. No check is made to see if I<handler> is a valid SVt_PVCV.
=back
=end PRIVATE
=cut
|