--- Coro/Coro.pm	2001/07/17 00:24:14	1.13
+++ Coro/Coro.pm	2001/07/21 18:21:45	1.20
@@ -20,6 +20,16 @@
 
 =head1 DESCRIPTION
 
+This module collection manages coroutines. Coroutines are similar to
+Threads but don't run in parallel.
+
+This module is still experimental, see the BUGS section below.
+
+In this module, coroutines are defined as "callchain + lexical variables
++ @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's
+own set of lexicals and it's own set of perl's most important global
+variables.
+
 =cut
 
 package Coro;
@@ -28,14 +38,12 @@
 
 use base Exporter;
 
-$VERSION = 0.05;
+$VERSION = 0.10;
 
-@EXPORT = qw(async yield schedule terminate);
+@EXPORT = qw(async yield schedule terminate current);
 @EXPORT_OK = qw($current);
 
 {
-   use subs 'async';
-
    my @async;
 
    # this way of handling attributes simply is NOT scalable ;()
@@ -49,15 +57,15 @@
             if ($_ eq "Coro") {
                push @async, $ref;
             } else {
-               push @attrs, @_;
+               push @attrs, $_;
             }
          }
-         return $old ? $old->($package, $name, @attrs) : @attrs;
+         return $old ? $old->($package, $ref, @attrs) : @attrs;
       };
    }
 
    sub INIT {
-      async pop @async while @async;
+      &async(pop @async) while @async;
    }
 }
 
@@ -69,7 +77,7 @@
 
 our $main = new Coro;
 
-=item $current
+=item $current (or as function: current)
 
 The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
 
@@ -82,6 +90,8 @@
 
 our $current = $main;
 
+sub current() { $current }
+
 =item $idle
 
 The coroutine to switch to when no other coroutine is running. The default
@@ -96,8 +106,7 @@
 };
 
 # we really need priorities...
-## my @ready; #d#
-our @ready = (); # the ready queue. hehe, rather broken ;)
+my @ready; # the ready queue. hehe, rather broken ;)
 
 # static methods. not really.
 
@@ -218,6 +227,20 @@
 
 1;
 
+=head1 BUGS/LIMITATIONS
+
+ - could be faster, especially when the core would introduce special
+   support for coroutines (like it does for threads).
+ - there is still a memleak on coroutine termination that I could not
+   identify. Could be as small as a single SV.
+ - this module is not well-tested.
+ - if variables or arguments "disappear" (become undef) or become
+   corrupted please contact the author so he cen iron out the
+   remaining bugs.
+ - this module is not thread-safe. You must only ever use this module from
+   the same thread (this requirement might be loosened in the future to
+   allow per-thread schedulers, but Coro::State does not yet allow this).
+
 =head1 SEE ALSO
 
 L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,