/*----------------------------------------------------------------

  * $Id: Html.java,v 1.1.1.1 2003/08/21 10:36:50 pkb Exp $

  * 

  * (c)2001 - Paul Blankenbaker */

 //----------------------------------------------------------------

 package com.ccg.macros.at;

 import com.ccg.macros.*;

 import java.io.IOException;

 import java.util.Vector;

 //----------------------------------------------------------------

 /** Macros related to the generation of HTML documents.

  * 

  * <p>Set of <b>&#064;macros</b> which provide handy functions when

  * generating HTML output. Developers don't typically make use of

  * these methods, but end users who write HTML documents will.</p>

  * 

  * @version $Revision: 1.1.1.1 $

  * 

  * @since 1.0

  * 

  * @author $Author: pkb $ */

 //----------------------------------------------------------------

 public class Html extends Base {

   //----------------------------------------------------------------

   /** Constructs the object and readies it for {@link #install installation}.

    * 

    * @since        1.0

    * 

    * @see #install */

   //----------------------------------------------------------------

   public Html() {

     super(true);

   }

   //----------------------------------------------------------------

   /** &#064;htmlEscape(TEXT) - escape special HTML characters '<', '>' and '&'.

    * 

    * <p>This should probably be relocated to a special HTML version of

    * the {@link At At} class. However, I needed something that would

    * translate '<' into "&lt;", '>' into "&gt;" and '&' into "&amp;"

    * so that HTML examples would appear as the expected when viewed by

    * a browser.

    *

    * <p>This macro simply replaces HTML special characters, with the

    * HTML escape codes.

    * 

    * @param        out

    * 

    *         The {@link Output output device} to write the results of

    *         processing the argument to.

    * 

    * @param        args

    * 

    *         A {@link Vector vector} of arguments which were passed to the macro.

    * 

    * @throws        IOException

    * 

    *         If there is a problem writing to the {@link Output output device}

    * 

    * @throws        InterpretException

    * 

    *         If a problem is encountered interpretting the arguments passed.

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public void htmlEscape(Output out, Vector args)

     throws IOException, InterpretException {

                                 // exit if nothing to do

     if ((args == null) || (args.size() != 1)) return;

                                 // see if there is anything to do

     Object f = args.elementAt(0);

     if (f == null) return;

     String text = getAtMacros().interpretCheck(f.toString());

     if ((text == null) || (text.length() == 0)) return;

     int tlen = text.length();

                                 // now, replace special HTML

                                 // characters with their escape codes

     StringBuffer sb = new StringBuffer(tlen*2);

     for (int i = 0; i < tlen; i++) {

       char c = text.charAt(i);

       if (c == '<') sb.append("&lt;");

       else if (c == '&') sb.append("&");

       else if (c == '>') sb.append(">");

       else sb.append(c);

     }

     out.write(sb);

   }

   //----------------------------------------------------------------

   /** @encodeFormParam(TEXT) - escape paramters passed as

    * form values in a URL string.

    *

    * <p>This macro simply replaces some characters that might need

    * special escaping to be included in a URL. For example:

    *

    * <pre>

    * @link("http://mysite.com/post.py?name=@encodeFormParam("Paul Blankenbaker")")

    * </pre>

    * 

    * @param        out

    * 

    *         The {@link Output output device} to write the results of

    *         processing the argument to.

    * 

    * @param        args

    * 

    *         A {@link Vector vector} of arguments which were passed to the macro.

    * 

    * @throws        IOException

    * 

    *         If there is a problem writing to the {@link Output output device}

    * 

    * @throws        InterpretException

    * 

    *         If a problem is encountered interpretting the arguments passed.

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public void encodeFormParam(Output out, Vector args)

     throws IOException, InterpretException {

                                 // exit if nothing to do

     if ((args == null) || (args.size() != 1)) return;

                                 // see if there is anything to do

     Object f = args.elementAt(0);

     if (f == null) return;

     String text = getAtMacros().interpretCheck(f.toString());

     if ((text == null) || (text.length() == 0)) return;

     int tlen = text.length();

                                 // now, replace special HTML

                                 // characters with their escape codes

     StringBuffer sb = new StringBuffer(tlen*2);

     com.ccg.util.Form.encodeSubmitParam(sb,text);

     out.write(sb);

   }

   //----------------------------------------------------------------

   /** @urlJoin(ROOT[,SUB0[,SUB1 ...]) - do a "smart" join of

    * strings when forming URL(s).

    * 

    * <p>It is common to form URLs by "joining" together one or more

    * strings. For example, consider the following:

    *

    * <pre>

    * &#064define("rootUrl","http://joe.com/")

    * &#064define("subDir","local/")

    * &#064define("fileName","joe.html")

    * &#064rootUrl()&#064subDir()&#064fileName

    * <pre>

    *

    * <p>The above would work, and result in the string

    * "http://joe.com/local/joe.html".

    *

    * <p>However, the above form requires the user to worry about

    * slashes ("/"), at the start or end. If the "rootUrl" had been

    * defined as "http://joe.com", it would have come out as

    * "http://joe.comlocal/joe.html" which is probably not what you

    * want.

    *

    * <p>This takes the "worry" out of this situation, it sticks a

    * slash ("/") between strings (or removes an extra one). So, using

    * this makes life much easier. As an example ALL of the following

    * will expand to the same URL ("http://joe.comlocal/joe.html").

    *

    * <pre>

    * &#064urlJoin("http://joe.com/local","joe.html")

    * &#064urlJoin("http://joe.com","local","joe.html")

    * &#064urlJoin("http://joe.com/","/local/","/joe.html")

    * &#064urlJoin("http://joe.com","/local","joe.html")

    * <pre>

    *

    * <p>You can pass as many (or as few parameters) as you wish, we

    * just keep joining them all together for you.

    * 

    * @param        out

    * 

    *         The {@link Output output device} to write the results of

    *         processing the argument to.

    * 

    * @param        args

    * 

    *         A {@link Vector vector} of arguments which were passed to the macro.

    * 

    * @throws        IOException

    * 

    *         If there is a problem writing to the {@link Output output device}

    * 

    * @throws        InterpretException

    * 

    *         If a problem is encountered interpretting the arguments passed.

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public void urlJoin(Output out, Vector args)

     throws IOException, InterpretException {

     if (args == null) return;

     StringBuffer sb = new StringBuffer();

     int n = args.size();

     for (int i = 0; i < n; i++) {

       String text = getStringParameter(args,i);

       if (text.length() > 0) {        // if something to append

                                 // if first non-blank, just append

         int sblen = sb.length();

         if (sblen == 0) sb.append(text);

         else {

           boolean tHasSlash = (text.charAt(0) == '/');

           boolean uEndsWithSlash = (sb.charAt(sblen-1) == '/');

                                 // if we have one slash

           if (tHasSlash != uEndsWithSlash) {

             sb.append(text);

           }

           else if (!tHasSlash) { // need to insert a slash

             sb.append('/');

             sb.append(text);

           }

           else {

             sb.setLength(sblen-1); // trim off one slash

             sb.append(text);

           }

         }

       }

     }

                                 // write out resulting URL

     out.write(sb);

   }

   //----------------------------------------------------------------

   /** @tableRow(COL0,COL1,...) generate single row in HTML table.

    * 

    * <p>This macro looks at all of the parameters, evaluates them and

    * then puts them insides the proper HTML tags for the purpose of

    * buiding a table. Here is an example usage:

    *

    * <pre>

    * @tableBegin(2,"My Table")

    * @tableRow("Paul","Blankenbaker")

    * @tableRow("Megan","Brown")

    * @tableRow("Erik","Blankenbaker")

    * @tableRow("Scott",Blankenbaker")

    * @tableEnd()

    * </pre>

    * 

    * @param        out

    * 

    *         The {@link Output output device} to write the results of

    *         processing the argument to.

    * 

    * @param        args

    * 

    *         A {@link Vector vector} of arguments which were passed to the macro.

    * 

    * @throws        IOException

    * 

    *         If there is a problem writing to the {@link Output output device}

    * 

    * @throws        InterpretException

    * 

    *         If a problem is encountered interpretting the arguments passed.

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public void tableRow(Output out, Vector args)

     throws IOException, InterpretException {

     StringBuffer row = new StringBuffer(1024);

     row.append("<tr>");

                                 // exit if nothing to do

     if ((args != null) || (args.size() != 0)) {

       int n = args.size();

       for (int i = 0; i < n; i++) {

         String text = null;

                                 // see if there is anything to do

         Object f = args.elementAt(i);

         if (f != null) text = getAtMacros().interpretCheck(f.toString());

         row.append("<td>");

         if (text == null || text.length() == 0) row.append(" ");

         else row.append(text);

         row.append("</td>");

       }

     }

     row.append("</tr>");

     out.write(row);

   }

   //----------------------------------------------------------------

   /** Main entry point into the application.

    * 

    * @param        args

    * 

    *         Array of command line arguments.

    */

   //----------------------------------------------------------------

   static public void main(String args[]) {

     try {

       AtMacros am = new AtMacros();

       Html html = new Html();

       html.install(am);

       Core core = new Core();

       core.install(am);

       OutputWriter ow = new OutputWriter(System.out);

       am.interpret(new InputReader(System.in),ow);

       ow.close();

     } catch (Exception e) {

       e.printStackTrace();

     }

   }

 }