YAMTarget.java
001 /*
002  * [Adapted from BSD licence] Copyright (c) 2002 Terence Parr All rights
003  * reserved.
004  
005  * Redistribution and use in source and binary forms, with or without
006  * modification, are permitted provided that the following conditions are met:
007  * 1. Redistributions of source code must retain the above copyright notice,
008  * this list of conditions and the following disclaimer. 2. Redistributions in
009  * binary form must reproduce the above copyright notice, this list of
010  * conditions and the following disclaimer in the documentation and/or other
011  * materials provided with the distribution. 3. The name of the author may not
012  * be used to endorse or promote products derived from this software without
013  * specific prior written permission.
014  
015  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
016  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
017  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
018  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
019  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
020  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
021  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
022  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
023  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
024  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
025  */
026 package gate.wiki.antlr;
027 
028 import java.util.Vector;
029 
030 public interface YAMTarget{
031   /** Typically "HTML", or "Lout" */
032   public String getTargetLanguage();
033   /** Called before text read */
034   public void begin();
035   /** Called after all text read and translated */
036   public void end();
037   public void text(String t);
038   public void bold(String t);
039   public void italic(String t);
040   public void tt(String t);
041   public void beginListItem(int level);
042   public void endListItem(int level);
043   public void begin_ul(int level);
044   public void begin_ol(int level);
045   public void end_ul(int level);
046   public void end_ol(int level);
047   public void paragraph();
048   /** They want a new line in a paragraph */
049   public void linebreak();
050   /**
051    * They want a blank line without signaling a new paragraph. Useful for new
052    * "paragraphs" within a single bullet.
053    */
054   public void blankline();
055   public void code(String c);
056   /** Assume rawOutput is in output language and just dump */
057   public void verbatim(String rawOutput);
058   public void blockquote(String q);
059   public void link(String url, String title);
060   public void anchor(String name);
061   public void title(String title);
062   public void beginSection(String title, int level);
063   public void endSection(int level);
064   public void beginSectionList(int level);
065   public void endSectionList(int level);
066   public void col();
067   public void row();
068   public void hr();
069   public void begin_table();
070   public void end_table();
071   
072   public String beginEM();
073   public String endEM();
074   public String beginTT();
075   public String endTT();
076   public String beginBF();
077   public String endBF();
078   
079   public void longdash();
080   public void contents();
081   
082   public void wikilink(String url, String title);
083 
084 
085   /** Former plugins  */
086 
087   public void cite(YAMContext context, Vector args);
088   public void image(YAMContext context, Vector args);
089   public void notes(YAMContext context, Vector args);
090 
091   public void box(YAMContext context, Vector args);
092   public void c(YAMContext context, Vector args);
093   public void date(YAMContext context, Vector args);
094   public void delete(YAMContext context, Vector args);
095   public void eps(YAMContext context, Vector args);
096   public void footnote(YAMContext context, Vector args);
097   public void include(YAMContext context, Vector args);
098 
099   public void syndiag(YAMContext context, Vector args);
100   public void tree(YAMContext context, Vector args);
101 
102 }