com.lunatech.doclets.jax.writers.DocletWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of doclets Show documentation
jax-doclets allows you to generate JavaDoc documentation for specific Java annotation-based extensions.
The newest version!
/*
    Copyright 2009 Lunatech Research
    
    This file is part of jax-doclets.

    jax-doclets is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    jax-doclets 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.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with jax-doclets.  If not, see .
 */
package com.lunatech.doclets.jax.writers;

import com.lunatech.doclets.jax.JAXConfiguration;
import com.lunatech.doclets.jax.Utils;
import com.sun.javadoc.Doc;
import com.sun.javadoc.SeeTag;
import com.sun.javadoc.Tag;
import com.sun.tools.doclets.formats.html.HtmlDocletWriter;

public class DocletWriter {

  private static final String VERSION = "0.10.0";

  protected HtmlDocletWriter writer;

  protected JAXConfiguration configuration;

  public DocletWriter(JAXConfiguration configuration, HtmlDocletWriter writer) {
    this.writer = writer;
    this.configuration = configuration;
  }

  public HtmlDocletWriter getWriter() {
    return writer;
  }

  public JAXConfiguration getConfiguration() {
    return configuration;
  }

  protected void open(String... tags) {
    for (String tag : tags)
      print("<" + tag + ">");
  }

  protected void close(String... tags) {
    for (String tag : tags)
      print("");
  }

  protected void tag(String... tags) {
    for (String tag : tags)
      print("<" + tag + "/>");
  }

  protected void around(String tag, String value) {
    open(tag);
    print(value);
    int space = tag.indexOf(' ');
    if (space > -1) {
      tag = tag.substring(0, space);
    }
    close(tag);
  }

  protected void printLink(boolean hasLink, String href, String text) {
    if (!hasLink)
      print(text);
    else
      around("a href='" + href + "'", text);
  }

  protected void printHeader(String title) {
    open("!DOCTYPE html");
    open("HTML");
    open("HEAD");
    around("TITLE", title);
    tag("LINK REL='stylesheet' TYPE='text/css' HREF='" + writer.relativePath + "doclet.css' TITLE='Style'");
    String charset = configuration.parentConfiguration.charset;
    if (Utils.isEmptyOrNull(charset))
      charset = "UTF-8";
    print("\n");
    printAdditionalHeader();
    close("HEAD");
    open("BODY");
    String msg = configuration.parentConfiguration.header;
    if (msg != null) {
      print(writer.replaceDocRootDir(msg));
    }
  }

  protected void printAdditionalHeader() {}

  protected void printFooter() {
    String msg = configuration.parentConfiguration.footer;
    if (msg != null) {
      print(writer.replaceDocRootDir(msg));
    }
    tag("hr");
    open("div class='footer'");
    print("Generated by Lunatech Labs jax-doclets v" + VERSION);
    close("div");
    close("BODY");
    close("HTML");
  }

  protected void printMenu(String selected) {
  	printMenu(selected, null);
  }

  protected void printMenu(String selected, String subStyle) {
    if(!configuration.parentConfiguration.nonavbar) {
      open("table class='menu " + (subStyle != null ? "menu-" + subStyle : "") + "'", "colgroup");
      tag("col", "col");
      close("colgroup");
      open("tbody", "tr");
      open("td class='NavBarCell1' colspan='2'");
      printTopMenu(selected);
      close("td", "tr");
      printThirdMenu();
      close("table");
    }
  }

  protected void printThirdMenu() {}

  protected void printTopMenu(String selected) {
    open("table", "tbody", "tr");
    printMenuItem("Overview", writer.relativePath + "overview-summary.html", selected);
    printOtherMenuItems(selected);
    close("tr", "tbody", "table");
  }

  protected void printOtherMenuItems(String selected) {}

  protected void printMenuItem(String title, String href, String selected) {
    boolean isSelected = title.equals(selected);
    if (isSelected)
      open("th class='selected'");
    else
      open("th");
    if (href != null && !isSelected) {
      around("a href='" + href + "'", title);
    } else
      print(title);
    close("th");

  }

  protected void print(String str) {
    writer.write(str);
  }

  protected String escape(String str) {
    return str.replace("&", "&").replace("<", "<").replace(">", ">");
  }

  protected void printSeeAlso(Doc javaDoc) {
    SeeTag[] seeTags = javaDoc.seeTags();
    if ((seeTags != null) && (seeTags.length > 0)) {
      open("dl class='seealso'");
      around("dt", "See Also:");
      open("dd");
      for (int i = 0; i < seeTags.length; i++) {
        SeeTag seeTag = seeTags[i];
        writer.printSummaryComment(javaDoc, new SeeTag[] { seeTag });
        if (i < (seeTags.length - 1)) {
          writer.write(", ");
        }
      }
      close("dd", "dl");
    }
  }

  protected void printSince(Doc javaDoc) {
    Tag[] sinceTags = javaDoc.tags("since");
    if ((sinceTags != null) && (sinceTags.length > 0)) {
      open("dl class='since'");
      around("dt", "Since:");
      open("dd");
      writer.write(sinceTags[0].text());
      close("dd", "dl");
    }
  }

}