--- Coro/Coro.pm	2001/07/14 22:14:21	1.8
+++ Coro/Coro.pm	2001/07/17 02:21:56	1.14
@@ -20,6 +20,11 @@
 
 =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.
+
 =cut
 
 package Coro;
@@ -28,9 +33,9 @@
 
 use base Exporter;
 
-$VERSION = 0.03;
+$VERSION = 0.05;
 
-@EXPORT = qw(async yield schedule);
+@EXPORT = qw(async yield schedule terminate);
 @EXPORT_OK = qw($current);
 
 {
@@ -61,17 +66,13 @@
    }
 }
 
-my $idle = new Coro sub {
-   &yield while 1;
-};
-
 =item $main
 
 This coroutine represents the main program.
 
 =cut
 
-$main = new Coro;
+our $main = new Coro;
 
 =item $current
 
@@ -84,10 +85,24 @@
    $main->{specific} = $current->{specific};
 }
 
-$current = $main;
+our $current = $main;
+
+=item $idle
+
+The coroutine to switch to when no other coroutine is running. The default
+implementation prints "FATAL: deadlock detected" and exits.
+
+=cut
+
+# should be done using priorities :(
+our $idle = new Coro sub {
+   print STDERR "FATAL: deadlock detected\n";
+   exit(51);
+};
 
 # we really need priorities...
-my @ready = (); # the ready queue. hehe, rather broken ;)
+## my @ready; #d#
+our @ready = (); # the ready queue. hehe, rather broken ;)
 
 # static methods. not really.
 
@@ -97,16 +112,26 @@
 
 =over 4
 
-=item async { ... };
+=item async { ... } [@args...]
 
 Create a new asynchronous process and return it's process object
 (usually unused). When the sub returns the new process is automatically
 terminated.
 
+   # create a new coroutine that just prints its arguments
+   async {
+      print "@_\n";
+   } 1,2,3,4;
+
+The coderef you submit MUST NOT be a closure that refers to variables
+in an outer scope. This does NOT work. Pass arguments into it instead.
+
 =cut
 
-sub async(&) {
-   (new Coro $_[0])->ready;
+sub async(&@) {
+   my $pid = new Coro @_;
+   $pid->ready;
+   $pid;
 }
 
 =item schedule
@@ -120,7 +145,8 @@
 my $prev;
 
 sub schedule {
-   ($prev, $current) = ($current, shift @ready);
+   # should be done using priorities :(
+   ($prev, $current) = ($current, shift @ready || $idle);
    Coro::State::transfer($prev, $current);
 }
 
@@ -140,9 +166,12 @@
 
 Terminates the current process.
 
+Future versions of this function will allow result arguments.
+
 =cut
 
 sub terminate {
+   $current->{_results} = [@_];
    &schedule;
 }
 
@@ -156,19 +185,25 @@
 
 =over 4
 
-=item new Coro \⊂
+=item new Coro \&sub [, @args...]
 
 Create a new process and return it. When the sub returns the process
 automatically terminates. To start the process you must first put it into
 the ready queue by calling the ready method.
 
+The coderef you submit MUST NOT be a closure that refers to variables
+in an outer scope. This does NOT work. Pass arguments into it instead.
+
 =cut
 
+sub _newcoro {
+   terminate &{+shift};
+}
+
 sub new {
    my $class = shift;
-   my $proc = $_[0];
    bless {
-      _coro_state => new Coro::State ($proc ? sub { &$proc; &terminate } : $proc),
+      _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
    }, $class;
 }
 
@@ -188,6 +223,19 @@
 
 1;
 
+=head1 BUGS
+
+ - 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.
+
+=head1 SEE ALSO
+
+L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
+L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.
+
 =head1 AUTHOR
 
  Marc Lehmann <pcg@goof.com>