--- deliantra/server/lib/cf.pm	2006/08/26 08:44:06	1.44
+++ deliantra/server/lib/cf.pm	2006/08/30 08:28:33	1.56
@@ -13,9 +13,10 @@
 
 use strict;
 
+_reload_1;
+
 our %COMMAND = ();
 our @EVENT;
-our @PLUGIN_EVENT;
 our %PROP_TYPE;
 our %PROP_IDX;
 our $LIBDIR = maps_directory "perl";
@@ -25,8 +26,6 @@
 our $NEXT_TICK;
 
 BEGIN {
-   @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
-
    *CORE::GLOBAL::warn = sub {
       my $msg = join "", @_;
       $msg .= "\n"
@@ -71,14 +70,11 @@
 prop_gen MAP_PROP    => "cf::map";
 prop_gen ARCH_PROP   => "cf::arch";
 
-# guessed hierarchies
-
 @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
-@safe::cf::object::map::ISA    = @cf::object::map::ISA    = 'cf::object';
 
 # we bless all objects into (empty) derived classes to force a method lookup
 # within the Safe compartment.
-for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
+for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
    no strict 'refs';
    @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
 }
@@ -94,48 +90,134 @@
 my %extcmd;
 
 #############################################################################
-# object support
+# utility functions
 
-sub reattach {
-   warn "reattach<@_>\n";
-}
+use JSON::Syck (); # TODO# replace by JSON::PC once working
 
-sub instantiate {
-   warn "instantiate<@_>\n";
+sub from_json($) {
+   $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
+   JSON::Syck::Load $_[0]
 }
 
-sub clone {
-   warn "clone<@_>\n";
+sub to_json($) {
+   $JSON::Syck::ImplicitUnicode = 0;  # work around JSON::Syck bugs
+   JSON::Syck::Dump $_[0]
 }
 
 #############################################################################
 # "new" plug-in system
 
-=item cf::object::attach ... # NYI
+=head3 EVENTS AND OBJECT ATTACHMENTS
+
+=over 4
+
+=item $object->attach ($attachment, key => $value...)
+
+=item $object->detach ($attachment)
+
+Attach/detach a pre-registered attachment to an object.
+
+=item $player->attach ($attachment, key => $value...)
+
+=item $player->detach ($attachment)
+
+Attach/detach a pre-registered attachment to a player.
+
+=item $map->attach ($attachment, key => $value...)
+
+=item $map->detach ($attachment)
+
+Attach/detach a pre-registered attachment to a map.
+
+=item $bool = $object->attached ($name)
+
+=item $bool = $player->attached ($name)
+
+=item $bool = $map->attached ($name)
+
+Checks wether the named attachment is currently attached to the object.
 
 =item cf::attach_global ...
 
-=item cf::attach_to_type ...
+Attach handlers for global events.
+
+This and all following C<attach_*>-functions expect any number of the
+following handler/hook descriptions:
+
+=over 4
+
+=item prio => $number
+
+Set the priority for all following handlers/hooks (unless overwritten
+by another C<prio> setting). Lower priority handlers get executed
+earlier. The default priority is C<0>, and many built-in handlers are
+registered at priority C<-1000>, so lower priorities should not be used
+unless you know what you are doing.
+
+=item on_I<event> => \&cb
+
+Call the given code reference whenever the named event happens (event is
+something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
+handlers are recognised generally depends on the type of object these
+handlers attach to).
+
+See F<include/eventinc.h> for the full list of events supported, and their
+class.
+
+=item package => package::
+
+Look for sub functions of the name C<< on_I<event> >> in the given
+package and register them.  Only handlers for eevents supported by the
+object/class are recognised.
+
+=back
+
+=item cf::attach_to_type $object_type, $subtype, ...
+
+Attach handlers for a specific object type (e.g. TRANSPORT) and
+subtype. If C<$subtype> is zero or undef, matches all objects of the given
+type.
 
 =item cf::attach_to_objects ...
 
+Attach handlers to all objects. Do not use this except for debugging or
+very rare events, as handlers are (obviously) called for I<all> objects in
+the game.
+
 =item cf::attach_to_players ...
 
+Attach handlers to all players.
+
 =item cf::attach_to_maps ...
 
-   prio    => $number, # lower is earlier
-   on_xxx  => \&cb,
-   package => package::,
+Attach handlers to all maps.
+
+=item cf:register_attachment $name, ...
+
+Register an attachment by name through which objects can refer to this
+attachment.
+
+=item cf:register_player_attachment $name, ...
+
+Register an attachment by name through which players can refer to this
+attachment.
+
+=item cf:register_map_attachment $name, ...
+
+Register an attachment by name through which maps can refer to this
+attachment.
 
 =cut
 
 # the following variables are defined in .xs and must not be re-created
 our @CB_GLOBAL = (); # registry for all global events
-our @CB_OBJECT = ();
+our @CB_OBJECT = (); # all objects (should not be used except in emergency)
 our @CB_PLAYER = ();
 our @CB_TYPE   = (); # registry for type (cf-object class) based events
 our @CB_MAP    = ();
 
+my %attachment;
+
 sub _attach_cb($\%$$$) {
    my ($registry, $undo, $event, $prio, $cb) = @_;
 
@@ -153,8 +235,8 @@
 # attach handles attaching event callbacks
 # the only thing the caller has to do is pass the correct
 # registry (== where the callback attaches to).
-sub _attach(\@$\@) {
-   my ($registry, $klass, $arg) = @_;
+sub _attach(\@$@) {
+   my ($registry, $klass, @arg) = @_;
 
    my $prio = 0;
 
@@ -165,14 +247,14 @@
 
    my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
 
-   while (@$arg) {
-      my $type = shift @$arg;
+   while (@arg) {
+      my $type = shift @arg;
 
       if ($type eq "prio") {
-         $prio = shift @$arg;
+         $prio = shift @arg;
 
       } elsif ($type eq "package") {
-         my $pkg = shift @$arg;
+         my $pkg = shift @arg;
 
          while (my ($name, $id) = each %cb_id) {
             if (my $cb = $pkg->can ($name)) {
@@ -181,13 +263,13 @@
          }
 
       } elsif (exists $cb_id{$type}) {
-         _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;
+         _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
 
       } elsif (ref $type) {
          warn "attaching objects not supported, ignoring.\n";
 
       } else {
-         shift @$arg;
+         shift @arg;
          warn "attach argument '$type' not supported, ignoring.\n";
       }
    }
@@ -195,17 +277,67 @@
    \%undo
 }
 
-sub cf::object::attach {
-   die;
+sub _attach_attachment {
+   my ($obj, $name, %arg) = @_;
+
+   return if exists $obj->{_attachment}{$name};
+
+   my $res;
+
+   if (my $attach = $attachment{$name}) {
+      my $registry = $obj->registry;
+
+      for (@$attach) {
+         my ($klass, @attach) = @$_;
+         $res = _attach @$registry, $klass, @attach;
+      }
+
+      $obj->{$name} = \%arg;
+   } else {
+      warn "object uses attachment '$name' that is not available, postponing.\n";
+   }
+
+   $obj->{_attachment}{$name} = undef;
+
+   $res->{attachment} = $name;
+   $res
 }
 
+*cf::object::attach =
+*cf::player::attach =
+*cf::map::attach = sub {
+   my ($obj, $name, %arg) = @_;
+
+   _attach_attachment $obj, $name, %arg;
+};
+
+# all those should be optimised
+*cf::object::detach =
+*cf::player::detach =
+*cf::map::detach = sub {
+   my ($obj, $name) = @_;
+
+   delete $obj->{_attachment}{$name};
+   reattach ($obj);
+};
+
+*cf::object::attached =
+*cf::player::attached =
+*cf::map::attached = sub {
+   my ($obj, $name) = @_;
+
+   exists $obj->{_attachment}{$name}
+};
+
 sub attach_global {
    _attach @CB_GLOBAL, KLASS_GLOBAL, @_
 }
 
 sub attach_to_type {
    my $type = shift;
-   _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
+   my $subtype = shift;
+
+   _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
 }
 
 sub attach_to_objects {
@@ -220,16 +352,38 @@
    _attach @CB_MAP, KLASS_MAP, @_
 }
 
+sub register_attachment {
+   my $name = shift;
+
+   $attachment{$name} = [[KLASS_OBJECT, @_]];
+}
+
+sub register_player_attachment {
+   my $name = shift;
+
+   $attachment{$name} = [[KLASS_PLAYER, @_]];
+}
+
+sub register_map_attachment {
+   my $name = shift;
+
+   $attachment{$name} = [[KLASS_MAP, @_]];
+}
+
 our $override;
+our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
 
-sub override() {
-   $override = 1
+sub override {
+   $override = 1;
+   @invoke_results = ();
 }
 
-sub invoke {
+sub do_invoke {
    my $event = shift;
    my $callbacks = shift;
 
+   @invoke_results = ();
+
    local $override;
 
    for (@$callbacks) {
@@ -247,6 +401,122 @@
    0
 }
 
+=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
+
+=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
+
+=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
+
+=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
+
+Generate a global/object/player/map-specific event with the given arguments.
+
+This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
+removed in future versions), and there is no public API to access override
+results (if you must, access C<@cf::invoke_results> directly).
+
+=back
+
+=head2 methods valid for all pointers
+
+=over 4
+
+=item $object->valid
+
+=item $player->valid
+
+=item $map->valid
+
+Just because you have a perl object does not mean that the corresponding
+C-level object still exists. If you try to access an object that has no
+valid C counterpart anymore you get an exception at runtime. This method
+can be used to test for existence of the C object part without causing an
+exception.
+
+=back
+
+=cut
+
+*cf::object::valid =
+*cf::player::valid =
+*cf::map::valid = \&cf::_valid;
+
+#############################################################################
+# object support
+
+sub instantiate {
+   my ($obj, $data) = @_;
+
+   $data = from_json $data;
+
+   for (@$data) {
+      my ($name, $args) = @$_;
+
+      $obj->attach ($name, %{$args || {} });
+   }
+}
+
+# basically do the same as instantiate, without calling instantiate
+sub reattach {
+   my ($obj) = @_;
+   my $registry = $obj->registry;
+
+   @$registry = ();
+
+   delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
+
+   for my $name (keys %{ $obj->{_attachment} || {} }) {
+      if (my $attach = $attachment{$name}) {
+         for (@$attach) {
+            my ($klass, @attach) = @$_;
+            _attach @$registry, $klass, @attach;
+         }
+      } else {
+         warn "object uses attachment '$name' that is not available, postponing.\n";
+      }
+   }
+}
+
+sub object_freezer_save {
+   my ($filename, $objs) = @_;
+
+   if (@$objs) {
+      open my $fh, ">:raw", "$filename.pst~";
+      syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
+      close $fh;
+      chmod SAVE_MODE, "$filename.pst~";
+      rename "$filename.pst~", "$filename.pst";
+   } else {
+      unlink "$filename.pst";
+   }
+
+   chmod SAVE_MODE, "$filename~";
+   rename "$filename~", $filename;
+}
+
+sub object_thawer_load {
+   my ($filename) = @_;
+
+   open my $fh, "<:raw:perlio", "$filename.pst"
+      or return;
+
+   eval { local $/; (Storable::thaw <$fh>)->{objs} }
+}
+
+attach_to_objects
+   prio     => -1000000,
+   on_clone => sub {
+      my ($src, $dst) = @_;
+
+      @{$dst->registry} = @{$src->registry};
+
+      %$dst = %$src;
+
+      %{$dst->{_attachment}} = %{$src->{_attachment}}
+         if exists $src->{_attachment};
+   },
+;
+
 #############################################################################
 # old plug-in events
 
@@ -301,12 +571,7 @@
 sub register {
    my ($base, $pkg) = @_;
 
-   for my $idx (0 .. $#PLUGIN_EVENT) {
-      if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
-         #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
-         $hook[$idx]{$base} = $ref;
-      }
-   }
+   #TODO
 }
 
 sub load_extension {
@@ -347,9 +612,10 @@
    warn "removing extension $pkg\n";
 
    # remove hooks
-   for my $idx (0 .. $#PLUGIN_EVENT) {
-      delete $hook[$idx]{$pkg};
-   }
+   #TODO
+#   for my $idx (0 .. $#PLUGIN_EVENT) {
+#      delete $hook[$idx]{$pkg};
+#   }
 
    # remove commands
    for my $name (keys %command) {
@@ -425,7 +691,7 @@
 
       # 4. get rid of safe::, as good as possible
       Symbol::delete_package "safe::$_"
-         for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
+         for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
 
       # 5. remove register_script_function callbacks
       # TODO
@@ -465,21 +731,6 @@
 };
 
 #############################################################################
-# utility functions
-
-use JSON::Syck (); # TODO# replace by JSON::PC once working
-
-sub from_json($) {
-   $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
-   JSON::Syck::Load $_[0]
-}
-
-sub to_json($) {
-   $JSON::Syck::ImplicitUnicode = 0;  # work around JSON::Syck bugs
-   JSON::Syck::Dump $_[0]
-}
-
-#############################################################################
 # extcmd framework, basically convert ext <msg>
 # into pkg::->on_extcmd_arg1 (...) while shortcutting a few
 
@@ -512,16 +763,18 @@
    my $path = $map->tmpname;
    defined $path or return;
 
-   unlink "$path.cfperl";
+   unlink "$path.pst";
 };
 
-*cf::mapsupport::on_swapin =
-*cf::mapsupport::on_load = sub {
+# old style persistent data, TODO: remove #d#
+*cf::mapsupport::on_swapin = sub {
    my ($map) = @_;
 
    my $path = $map->tmpname;
    $path = $map->path unless defined $path;
 
+   warn "$path.cfperl\n";#d#
+
    open my $fh, "<:raw", "$path.cfperl"
       or return; # no perl data
 
@@ -531,33 +784,7 @@
       or return; # too new
 
    $map->_set_obs ($data->{obs});
-};
-
-*cf::mapsupport::on_swapout = sub {
-   my ($map) = @_;
-
-   my $path = $map->tmpname;
-   $path = $map->path unless defined $path;
-
-   my $obs = $map->_get_obs;
-
-   if (defined $obs) {
-      open my $fh, ">:raw", "$path.cfperl"
-         or die "$path.cfperl: $!";
-
-      stat $path;
-
-      print $fh Storable::nfreeze {
-         size    => (stat _)[7],
-         time    => (stat _)[9],
-         version => 1,
-         obs     => $obs,
-      };
-
-      chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
-   } else {
-      unlink "$path.cfperl";
-   }
+   $map->invoke (EVENT_MAP_UPGRADE);
 };
 
 attach_to_maps prio => -10000, package => cf::mapsupport::;
@@ -581,12 +808,6 @@
          }
       }
    },
-   on_save => sub {
-      my ($pl, $path) = @_;
-
-      $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
-         for grep %$_, all_objects $pl->ob;
-   },
 ;
 
 #############################################################################
@@ -734,5 +955,7 @@
    },
 );
 
+_reload_2;
+
 1