Changeset 9676

Timestamp:

12/14/09 00:53:50 (2 years ago)

Author:

szabgab

Message:

[Debug::Client] add some documentation and TODO tests

Location:

trunk/Debug-Client

Files:

• lib/Debug/Client.pm (modified) (9 diffs)
• t/05-execute.t (modified) (2 diffs)

trunk/Debug-Client/lib/Debug/Client.pm

@@ -39 +39 @@
   $debugger->run( 'foo' );  # tun till beginning of sub
 
-  $debugger->execute_code
-
+  $debugger->execute_code( '$answer = 42' );
+
+  $debugger->execute_code( '@name = qw(foo bar)' );
+
+  my ($value, $prompt) = $debugger->get_value('@name');  $value is the dumped data?
+
+  $debugger->execute_code( '%phone_book = (foo => 123, bar => 456)' );
+
+  my ($value, $prompt) = $debugger->get_value('%phone_book');  $value is the dumped data?
+  
+  
   $debugger->set_breakpoint( "file", 23 ); #    set breakpoint on file, line
 
@@ -78 +87 @@
                    Reuse     => 1);
     $sock or die "Could not connect to '$args{host}' '$args{port}' no socket :$!";
-    logger("listening on '$args{host}:$args{port}'");
+    _logger("listening on '$args{host}:$args{port}'");
     $self->{sock} = $sock;
 
@@ -105 +114 @@
 }
 
+=head2 quit
+
+=cut
+
+sub quit      { $_[0]->_send('q')    }
+
+=head2 show_line
+
+=cut
+
+sub show_line { $_[0]->send_get('.') }
+
+
+=head2 step_in
+
+=cut
+
 sub step_in   { $_[0]->send_get('s') }
+
+=head2 step_over
+
+=cut
+
 sub step_over { $_[0]->send_get('n') }
-sub quit      { $_[0]->_send('q')    }
-sub show_line { $_[0]->send_get('.') }
-
-sub get_stack_trace {
-    my ($self) = @_;
-    $self->_send('T');
-    my $buf = $self->_get;
-
-    if (wantarray) {
-        my $prompt = _prompt(\$buf);
-        return($buf, $prompt);
-    } else {
-        return $buf;
-    }
-}
-
-
-
-sub run       { 
-    my ($self, $param) = @_;
-    if (not defined $param) {
-        $self->send_get('c');
-    } else {
-        $self->send_get("c $param");
-    }
-}
+
+=head2 step_out
+
+=cut
 
 sub step_out  { 
@@ -167 +176 @@
 }
 
+
+=head2 get_stack_trace
+
+=cut
+
+sub get_stack_trace {
+    my ($self) = @_;
+    $self->_send('T');
+    my $buf = $self->_get;
+
+    if (wantarray) {
+        my $prompt = _prompt(\$buf);
+        return($buf, $prompt);
+    } else {
+        return $buf;
+    }
+}
+
+=head2 run
+
+=cut
+sub run       { 
+    my ($self, $param) = @_;
+    if (not defined $param) {
+        $self->send_get('c');
+    } else {
+        $self->send_get("c $param");
+    }
+}
+
+
+=head2 set_breakpoint
+
+=cut
+
 #  TODO: Line 15 not breakable.
 sub set_breakpoint {
@@ -185 +229 @@
 }
 
+=head2 execute_code
+
+=cut
 
 sub execute_code {
@@ -199 +246 @@
 }
 
+=head2 get_value
+
+=cut
+
+# TODO if the given $x is a reference then something (either this module
+# or its user) should actually call   x $var 
 sub get_value {
     my ($self, $var) = @_;
@@ -227 +280 @@
 
 sub _parse_dumper {
-    my ($str) = @_;    
+    my ($str) = @_;
+    return $str;
 }
 
@@ -242 +296 @@
             die $!; # TODO better error handling?
         }
-        logger("---- ret '$ret'\n$buf\n---");
+        _logger("---- ret '$ret'\n$buf\n---");
         if (not $ret) {
             last;
         }
     }
-    logger("_get done");
+    _logger("_get done");
 
     $self->{buffer} = $buf;
@@ -307 +361 @@
 }
 
-sub logger {
+sub _logger {
     print "$_[0]\n" if $ENV{DEBUG_LOGGER};
 }

trunk/Debug-Client/t/05-execute.t

@@ -12 +12 @@
 my $D = re('\d+');
 
-plan(tests => 10);
+our $TODO; # needed becasue Test::More is required and not used
+
+plan(tests => 13);
 
 my $debugger = start_debugger();
@@ -58 +60 @@
 }
 
-# TODO check the get_value on hash and array
-#{
-#    my @out = $debugger->get_value('@qwe');
-#    cmp_deeply(\@out, [23, 42, $D], 'execute 1')
-#        or diag($debugger->buffer);
-#}
+TODO: {
+    local $TODO = 'get_value of array';
+    my @out = $debugger->get_value('@qwe');
+    cmp_deeply(\@out, [23, 42, $D], 'get_value of array')
+        or diag($debugger->buffer);
+}
+
+{
+    my @out = $debugger->execute_code('%h = (fname => "foo", lname => "bar")');
+    cmp_deeply(\@out, ['', $D], 'execute 3')
+        or diag($debugger->buffer);
+}
+
+TODO: {
+    local $TODO = 'get_value of hash';
+    my @out = $debugger->get_value('%h');
+    cmp_deeply(\@out, [$D], 'get_value of hash')
+        or diag($debugger->buffer);
+}
+
 
 {