package net.sourceforge.phpdt.internal.compiler.ast;

import java.util.ArrayList;
import java.util.List;

import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
import net.sourceforge.phpdt.internal.compiler.parser.OutlineableWithChildren;
import net.sourceforge.phpdt.internal.ui.PHPUiImages;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.text.Position;

/**
 * It's a php document.
 * This class is an outlineable object
 * It will contains html and php
 * @author Matthieu Casanova
 */
public class PHPDocument implements OutlineableWithChildren {

  /**
   * The nodes.
   * It will include html nodes or php nodes
   */
  public AstNode[] nodes;

  public char[] name;

  /** The parent of the object. */
  public Object parent;

  /** The outlineable children (those will be in the node array too. */
  private ArrayList children = new ArrayList();

  private Position position;
  /**
   * Create the PHPDocument.
   * @param parent the parent object (it should be null isn't it ?)
   */
  public PHPDocument(final Object parent,
                     final char[] name) {
    this.parent = parent;
    this.name = name;
    position = new Position(1,name.length);
  }

  /**
   * Return the php document as String.
   * @return  a string representation of the object.
   */
  public String toString() {
    final StringBuffer buff = new StringBuffer();
    AstNode node;
    if (nodes != null) {
      int i;
      for (i = 0; i < nodes.length; i++) {
        node = nodes[i];
        if (node == null) {
          break;
        }
        buff.append(node.toString(0));
        if (node instanceof HTMLCode) {
          buff.append("\n");//$NON-NLS-1$
        } else {
          buff.append(";\n");//$NON-NLS-1$
        }
      }
    }
    return buff.toString();
  }

  /**
   * Add an outlineable object.
   * @param o the new outlineable
   * @return does the addition worked ?
   */
  public boolean add(final Outlineable o) {
    return children.add(o);
  }

  /**
   * Return the outlineable at the index.
   * @param index the index
   * @return an outlineable object
   */
  public Outlineable get(final int index) {
    return (Outlineable) children.get(index);
  }

  /**
   * The number of outlineable children.
   * @return the number of children that are outlineable
   */
  public int size() {
    return children.size();
  }

  /**
   * This will return the image for the outline of the object.
   * @return an image
   */
  public ImageDescriptor getImage() {
    return PHPUiImages.DESC_CLASS;
  }

  /**
   * Get the parent of the object.
   * @return the parent of the object
   */
  public Object getParent() {
    return parent;
  }

  public Position getPosition() {
    return position;
  }

  public List getList() {
    return children;
  }
}