src/javajs/util/XmlUtil.java

   1 /* $RCSfile$\r
   2  * $Author$\r
   3  * $Date$\r
   4  * $Revision$\r
   5  *\r
   6  * Copyright (C) 2006  The Jmol Development Team\r
   7  *\r
   8  * Contact: jmol-developers@lists.sf.net\r
   9  *\r
  10  *  This library is free software; you can redistribute it and/or\r
  11  *  modify it under the terms of the GNU Lesser General Public\r
  12  *  License as published by the Free Software Foundation; either\r
  13  *  version 2.1 of the License, or (at your option) any later version.\r
  14  *\r
  15  *  This library is distributed in the hope that it will be useful,\r
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
  18  *  Lesser General Public License for more details.\r
  19  *\r
  20  *  You should have received a copy of the GNU Lesser General Public\r
  21  *  License along with this library; if not, write to the Free Software\r
  22  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA\r
  23  *  02110-1301, USA.\r
  24  */\r
  25 \r
  26 package javajs.util;\r
  27 \r
  28 public class XmlUtil {\r
  29 \r
  30   public XmlUtil() {\r
  31     // Jmol's PropertyManager class uses reflection \r
  32   }\r
  33   // / simple Xml parser/generator ///\r
  34 \r
  35   public static void openDocument(SB data) {\r
  36     data.append("<?xml version=\"1.0\"?>\n");\r
  37   }\r
  38 \r
  39   public static void openTag(SB sb, String name) {\r
  40     sb.append("<").append(name).append(">\n");\r
  41   }\r
  42 \r
  43   public static void openTagAttr(SB sb, String name, Object[] attributes) {\r
  44     appendTagAll(sb, name, attributes, null, false, false);\r
  45     sb.append("\n");\r
  46   }\r
  47 \r
  48   public static void closeTag(SB sb, String name) {\r
  49     sb.append("</").append(name).append(">\n");\r
  50   }\r
  51 \r
  52   public static void appendTagAll(SB sb, String name,\r
  53                                Object[] attributes, Object data,\r
  54                                boolean isCdata, boolean doClose) {\r
  55     String closer = ">";\r
  56     if (name.endsWith("/")){\r
  57       name = name.substring(0, name.length() - 1);\r
  58       if (data == null) {\r
  59         closer = "/>\n";\r
  60         doClose = false;\r
  61       }\r
  62     }\r
  63     sb.append("<").append(name);\r
  64     if (attributes != null)\r
  65       for (int i = 0; i < attributes.length; i++) {\r
  66         Object o = attributes[i];\r
  67         if (o == null)\r
  68           continue;\r
  69         if (o instanceof Object[])\r
  70           for (int j = 0; j < ((Object[]) o).length; j+= 2)\r
  71           appendAttrib(sb, ((Object[]) o)[j], ((Object[]) o)[j + 1]);\r
  72         else\r
  73           appendAttrib(sb, o, attributes[++i]);\r
  74       }\r
  75     sb.append(closer);\r
  76     if (data != null) {\r
  77       if (isCdata)\r
  78         data = wrapCdata(data);\r
  79       sb.appendO(data);\r
  80     }\r
  81     if (doClose)\r
  82       closeTag(sb, name);\r
  83   }\r
  84 \r
  85   /**\r
  86    * wrap the string as character data, with replacements for [ noted \r
  87    * as a list starting with * after the CDATA termination\r
  88    * \r
  89    * @param data\r
  90    * @return      wrapped text\r
  91    */\r
  92   public static String wrapCdata(Object data) {\r
  93     String s = "" + data;\r
  94     return (s.indexOf("&") < 0 && s.indexOf("<") < 0 ? (s.startsWith("\n") ? "" : "\n") + s \r
  95         : "<![CDATA[" + PT.rep(s, "]]>", "]]]]><![CDATA[>") + "]]>");\r
  96   }\r
  97   \r
  98   /**\r
  99    * @param s\r
 100    * @return   unwrapped text\r
 101    */\r
 102   public static String unwrapCdata(String s) {\r
 103     return (s.startsWith("<![CDATA[") && s.endsWith("]]>") ?\r
 104         PT.rep(s.substring(9, s.length()-3),"]]]]><![CDATA[>", "]]>") : s);\r
 105   }\r
 106   \r
 107   /**\r
 108    * standard <name attr="..." attr="...">data</name>"\r
 109    * \r
 110    * @param sb\r
 111    * @param name\r
 112    * @param attributes\r
 113    * @param data\r
 114    */\r
 115   public static void appendTagObj(SB sb, String name,\r
 116                                Object[] attributes, Object data) {\r
 117     appendTagAll(sb, name, attributes, data, false, true);\r
 118   }\r
 119 \r
 120   /**\r
 121    * standard <name>data</name>"\r
 122    * standard <name attr="..." attr="..."></name>"\r
 123    * \r
 124    * @param sb\r
 125    * @param name\r
 126    * @param data\r
 127    */\r
 128   public static void appendTag(SB sb, String name, Object data) {\r
 129     if (data instanceof Object[])\r
 130       appendTagAll(sb, name, (Object[]) data, null, false, true);\r
 131     else\r
 132       appendTagAll(sb, name, null, data, false, true);\r
 133   }\r
 134 \r
 135   /**\r
 136    * <name><![CDATA[data]]></name>"\r
 137    * \r
 138    * will convert ]]> to ]] >\r
 139    * \r
 140    * @param sb\r
 141    * @param name\r
 142    * @param attributes \r
 143    * @param data\r
 144    */\r
 145   public static void appendCdata(SB sb, String name, \r
 146                                  Object[] attributes, String data) {\r
 147     appendTagAll(sb, name, attributes, data, true, true);\r
 148   }\r
 149 \r
 150   /**\r
 151    * \r
 152    * @param sb\r
 153    * @param name\r
 154    * @param value\r
 155    */\r
 156   public static void appendAttrib(SB sb, Object name, Object value) {\r
 157     if (value == null)\r
 158       return;\r
 159     \r
 160     // note: <&" are disallowed but not checked for here\r
 161     \r
 162     sb.append(" ").appendO(name).append("=\"").appendO(value).append("\"");\r
 163   }\r
 164 \r
 165 }\r