reftaglet.java

著名的开源仿真软件yale

/*
 *  YALE - Yet Another Learning Environment
 *  Copyright (C) 2002, 2003
 *      Simon Fischer, Ralf Klinkenberg, Ingo Mierswa, 
 *          Katharina Morik, Oliver Ritthoff
 *      Artificial Intelligence Unit
 *      Computer Science Department
 *      University of Dortmund
 *      44221 Dortmund,  Germany
 *  email: [e-mail]
 *  web:   http://yale.cs.uni-dortmund.de/
 *
 *  This program 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. 
 *
 *  This program 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
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 */
package edu.udo.cs.yale.doc;

import com.sun.tools.doclets.*;
import com.sun.javadoc.*;
import java.util.Map;

public class RefTaglet implements TexTaglet {

    private static final String NAME = "yale.ref";
    public String getName() { return NAME; }
    public boolean inField() { return true; }
    public boolean inConstructor() { return true; }
    public boolean inMethod() { return true; }
    public boolean inOverview() { return true; }
    public boolean inPackage() { return true; }
    public boolean inType() { return true; }
    public boolean isInlineTag() { return true; }

    public static void register(Map tagletMap) {
       RefTaglet tag = new RefTaglet();
       Taglet t = (Taglet) tagletMap.get(tag.getName());
       if (t != null) {
           tagletMap.remove(tag.getName());
       }
       tagletMap.put(tag.getName(), tag);
    }

    private String[] split(Tag tag) {
	String[] splitted = tag.text().split("\\|");
	if (splitted.length != 2) {
	    System.err.println("Usage: {@"+getName()+" latexref|html_human_readable_ref} ("+tag.position()+")");
	    return new String[] { tag.text(), tag.text() };
	} else {
	    return splitted;
	}
    }

    public String toString(Tag tag) {
	return split(tag)[1];
    }
    
    public String toString(Tag[] tags) {
        return null;
    }

    public String toTex(Tag tag) {
        return "\\ref{" + split(tag)[0] + "}";
    }
    public String toTex(Tag[] tag) { 
	return null; 
    }
}