Defun.java

/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Emil Ong
 */

package com.caucho.xtpdoc;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import java.io.IOException;
import java.io.PrintWriter;

import java.util.HashSet;

public class Defun extends Section {
  private DefunParents _parents;
  private DefunJavadoc _javadoc;

  public Defun(Document document)
  {
    super(document);
  }

  public S2 createS2()
  {
    S2 s2 = new S2(getDocument(), getHref());
    addItem(s2);
    return s2;
  }

  @Override
  public FormattedText createParents()
  {
    _parents = new DefunParents(getDocument());
    addItem(_parents);

    return _parents;
  }

  public DefunPro createPro()
  {
    DefunPro pro = new DefunPro(this);
    addItem(pro);

    return pro;
  }

  public DefunJavadoc createJavadoc()
  {
    _javadoc = new DefunJavadoc(this);
    addItem(_javadoc);

    return _javadoc;
  }

  public DefunSchema createSchema()
  {
    DefunSchema schema = new DefunSchema(this);
    addItem(schema);

    return schema;
  }

  public DefunExamples createExamples()
  {
    DefunExamples examples = new DefunExamples(getDocument());
    addItem(examples);

    return examples;
  }

  public DefunExample createExample()
  {
    DefunExample example = new DefunExample(getDocument());
    addItem(example);

    return example;
  }

  public DefunAttributes createAttributes()
  {
    DefunAttributes attributes = new DefunAttributes(this);
    addItem(attributes);

    return attributes;
  }

  @Override
  public FormattedTextWithAnchors createDescription()
  {
    DefunDescription description = new DefunDescription(this);
    addItem(description);

    return description;
  }

  public DefunParents getParents()
  {
    return _parents;
  }

  public void writeHtml(XMLStreamWriter out)
    throws XMLStreamException
  {
    out.writeCharacters("\n");
    out.writeStartElement("div");
    out.writeAttribute("class", "s1 defun");
    
    out.writeStartElement("a");
    out.writeAttribute("name", getHref());
    out.writeEndElement();
    
    if (_title != null) {
      out.writeStartElement("h1");
      out.writeAttribute("class", "section");
      out.writeCharacters(_title);
      out.writeEndElement();
    }
    
    out.writeEndElement();
    
    super.writeHtml(out);
  }

  public void writeLaTeXTop(PrintWriter out)
    throws IOException
  {
    out.println("\\subsection{" + LaTeXUtil.escapeForLaTeX(_title) + "}");

    super.writeLaTeX(out);
  }

  public void writeLaTeX(PrintWriter out)
    throws IOException
  {
    out.println("\\subsection{" + LaTeXUtil.escapeForLaTeX(_title) + "}");

    super.writeLaTeX(out);
  }

  public void writeLaTeXEnclosed(PrintWriter out)
    throws IOException
  {
    if (_type != null && _type.equals("defun"))
      out.println("\\newpage");

    if (_title != null)
      out.println("\\subsubsection{" + LaTeXUtil.escapeForLaTeX(_title) + "}");

    super.writeLaTeX(out);
  }

  @Override
  public void writeAsciiDoc(PrintWriter out)
    throws IOException
  {
    out.println();
    out.println();
    
    if (_title != null) {
      out.println("==== " + _title + " ====");
    }

    super.writeAsciiDoc(out);
  }
}