root / trunk / docscripts / inc / DojoFunctionBody.php

<?php

require_once('DojoBlock.php');

class DojoFunctionBody extends DojoBlock
{
    private $object = 'DojoFunctionBody';

  private $comment_end;

  private $keys = array();
  private $comments = array();
  private $return_comments = array();
  private $instance_variables = array();
  private $this_inheritance_calls = array();
  private $extra_initial_comment_block = array();
  
  public function build()
  {
        if (!$this->start) {
      die("DojoFunctionBody->build() used before setting a start position");
    }
    if ($this->end) {
      return $this->end;
    }
        
        $balance = 0;
        $start_position = $this->start[1];
        $lines = Text::chop($this->package->getCode(), $this->start[0], $this->start[1], false, false, true);
    return $this->end = Text::findTermination($lines, '}', '{}');
  }
  
  public function addBlockCommentLine($line)
  {
    if (trim($line) != '') {
      $this->extra_initial_comment_block[] = $line;
    }
  }
  
  public function addBlockCommentKey($key)
  {
    if ($key) {
      $this->keys[] = $key;
    }
  }
  
  public function getSource()
  {
    $this->getBlockCommentKeys();
    $source = array();
    $lines = Text::chop($this->package->getSource(), $this->comment_end[0], $this->comment_end[1], $this->end[0], $this->end[1], true);
    foreach ($lines as $line_number => $line) {
      $trimmed_line = trim($line);
      if ($trimmed_line === '') continue;
      $source[] = $line;
    }
    return implode("\n", $source);
  }
  
  public function getBlockComment($key)
  {
    $value = '';
    $this->getBlockCommentKeys();
    if (!empty($this->comments[$key])) {
      $value = preg_replace('%\s+%', ' ', trim($this->comments[$key]));
    }
    return $value;
  }
  
  public function getBlockCommentKeys() 
  {
    if ($this->comments) { 
      return array_keys($this->comments); 
    }
    
    $this->build();

    $expression = '%^\b(' . implode('|', $this->keys) . ')\b\W*%';
    $buffer = array();
    $key = '';
    $started = false;
   
    $lines = Text::chop($this->package->getSource(), $this->start[0], $this->start[1], $this->end[0], $this->end[1], true);
    for ($i = 0; $i < 2; $i++) {
      if ($i == 1) {
        $lines = $this->extra_initial_comment_block;
      }
      foreach ($lines as $line_number =>  $line) {
        list($comment, , , $data, $multiline) = Text::findComments($line, $multiline);
        
        if ($started && $comment === false) {
          $this->comment_end = array($line_number, 0);
          break;
        }
        elseif ($comment) {
          $started = true;
        }
        
        if (preg_match($expression, $comment, $match)) {
          if ($buffer && $key) {
            $this->comments[$key] = implode(' ', $buffer);
            $buffer = array();
          }
          $key = $match[1];
          if ($match[0] == $comment) {
            $comment = '';
          }
          else {
            $comment = substr($comment, strlen($match[0]));
          }
        }
        
        if ($data) {
          $this->comment_end = array($line_number, 0);
          break;
        }
        
        if ($comment !== '') {
          $buffer[] = $comment;
        }
      }
      
      if ($buffer && $key) {
        $this->comments[$key] = implode(' ', $buffer);
      }
  
      if ($i == 0 && !$this->comment_end) {
        $this->comment_end = $this->start;
      }
    }

    return array_keys($this->comments);
  }
  
  public function getInstanceVariableNames()
  {
    if ($this->instance_variables) {
      return $this->instance_variables;
    }
    
    $this->build();
    $lines = Text::chop($this->package->getCode(), $this->start[0], $this->start[1], $this->end[0], $this->end[1], true);
    foreach ($lines as $line) {
      if (preg_match('%\bthis\.([a-zA-Z0-9._$]+)\s*=\s*(?!function)%', $line, $match)) {
        $this->instance_variables[] = $match[1];
      }
    }
    return $this->instance_variables;
  }
  
  public function getInstanceFunctions($function_name)
  {
    $functions = array();
    $this->build();
    $lines = Text::chop($this->package->getCode(), $this->start[0], $this->start[1], $this->end[0], $this->end[1], true);
    foreach ($lines as $line_number => $line) {
      if (preg_match('%\bthis\.([a-zA-Z0-9._$]+)\s*=\s*function\b%', $line, $match, PREG_OFFSET_CAPTURE)) {
        $function = new DojoFunctionDeclare($this->package, $line_number, $match[0][1]);
                $function->setFunctionName($function_name);
        $end = $function->build();
        $functions[] = $function;
      }
    }
    return $functions;
  }
  
  public function getReturnComments()
  {
    if ($this->return_comments) {
      return $this->return_comments;
    }
    
    $buffer = array();
    $this->getBlockCommentKeys();
    $lines = Text::chop($this->package->getSource(), $this->comment_end[0], $this->comment_end[1], $this->end[0], $this->end[1], true);
    foreach ($lines as $line) {
      if ($multiline) {
        list($first, $middle, $last, $data, $multiline) = Text::findComments($line, $multiline);
        if ($first) {
          $buffer[] = trim($first);
        }
        if ($data) {
          $multiline = false;
          if ($buffer) {
            $this->return_comments[] = implode(' ', array_diff($buffer, array('')));
            $buffer = array();
          }
        }
      }
      if (strpos($line, 'return') !== false) {
        if ($data && $buffer) {
          $this->return_comments[] = implode(' ', array_diff($buffer, array('')));
          $buffer = array();
        }
        list($first, $middle, $last, $data, $multiline) = Text::findComments($line, $multiline);
        if ($last) {
          $buffer[] = $last;
        }
      }
    }
    
    if ($data && $buffer) {
      $this->return_comments[] = implode(' ', array_diff($buffer, array('')));
    }
    
    $this->return_comment = array_unique($this->return_comments);
    
    return $this->return_comments;
  }
  
  public function getThisInheritanceCalls()
  {
    if ($this->this_inheritance_calls) {
      return $this->this_inheritance_calls;
    }
    
    $this->build();
    $lines = Text::chop($this->package->getCode(), $this->start[0], $this->start[1], $this->end[0], $this->end[1], true);
    foreach ($lines as $line) {
      if (preg_match('%\b([a-zA-Z0-9_.$]+)\.(?:apply|call)\s*\(%', $line, $match)) {
        $this->this_inheritance_calls[] = $match[1];
      }
    }
    return $this->this_inheritance_calls;
  }

}
  
?>