BoardWriterClass.java

/**
 * This file is part of Logisim-evolution.
 *
 * Logisim-evolution 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 3 of the License, or (at your
 * option) any later version.
 *
 * Logisim-evolution 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 Logisim-evolution.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Original code by Carl Burch (http://www.cburch.com), 2011.
 * Subsequent modifications by:
 *   + Haute École Spécialisée Bernoise
 *     http://www.bfh.ch
 *   + Haute École du paysage, d'ingénierie et d'architecture de Genève
 *     http://hepia.hesge.ch/
 *   + Haute École d'Ingénierie et de Gestion du Canton de Vaud
 *     http://www.heig-vd.ch/
 *   + REDS Institute - HEIG-VD, Yverdon-les-Bains, Switzerland
 *     http://reds.heig-vd.ch
 * This version of the project is currently maintained by:
 *   + Kevin Walsh (kwalsh@holycross.edu, http://mathcs.holycross.edu/~kwalsh)
 */

package com.bfh.logisim.fpgaboardeditor;

import java.awt.Image;
import java.io.File;
import java.io.StringWriter;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Attr;
import org.w3c.dom.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

class BoardWriterClass {

	public static String BoardInformationSectionString = "BoardInformation";
	public static String ClockInformationSectionString = "ClockInformation";
	public static String[] ClockSectionStrings = { "Frequency", "FPGApin",
			"PullBehavior", "IOStandard" };
	public static String FPGAInformationSectionString = "FPGAInformation";
	public static String[] FPGASectionStrings = { "Vendor", "Part", "Family",
			"Package", "Speedgrade", "USBTMC", "JTAGPos", "FlashName", "FlashPos"};
	public static String UnusedPinsString = "UnusedPins";
	public static String ComponentsSectionString = "IOComponents";
	public static String LocationXString = "LocationX";
	public static String LocationYString = "LocationY";
	public static String WidthString = "Width";
	public static String HeightString = "Height";
	public static String LabelString = "Label";
	public static String PinLocationString = "FPGAPinName";
	public static String ImageInformationString = "BoardPicture";
	public static String MultiPinInformationString = "NrOfPins";
	public static String MultiPinPrefixString = "FPGAPin_";
	private DocumentBuilderFactory factory;
	private DocumentBuilder parser;
	private Document boardInfo;

	public BoardWriterClass(BoardInformation BoardInfo, Image BoardImage) {
		try {
			// Create instance of DocumentBuilderFactory
			factory = DocumentBuilderFactory.newInstance();
			// Get the DocumentBuilder
			parser = factory.newDocumentBuilder();
			// Create blank DOM Document
			boardInfo = parser.newDocument();

			Element root = boardInfo.createElement(BoardInfo.getBoardName());
			boardInfo.appendChild(root);
			Element fpgainfo = boardInfo
					.createElement(BoardInformationSectionString);
			root.appendChild(fpgainfo);
			Comment comment = boardInfo
					.createComment("This section decribes the FPGA and its clock");
			fpgainfo.appendChild(comment);
			Element clkinfo = boardInfo
					.createElement(ClockInformationSectionString);
			clkinfo.setAttribute(ClockSectionStrings[0],
					Long.toString(BoardInfo.fpga.getClockFrequency()));
			Attr pin = boardInfo.createAttribute(ClockSectionStrings[1]);
			pin.setValue(BoardInfo.fpga.getClockPinLocation().toUpperCase());
			clkinfo.setAttributeNode(pin);
			Attr pull = boardInfo.createAttribute(ClockSectionStrings[2]);
			pull.setValue(PullBehaviors.Behavior_strings[BoardInfo.fpga
					.getClockPull()]);
			clkinfo.setAttributeNode(pull);
			Attr IOS = boardInfo.createAttribute(ClockSectionStrings[3]);
			IOS.setValue(IoStandards.Behavior_strings[BoardInfo.fpga
					.getClockStandard()]);
			clkinfo.setAttributeNode(IOS);
			fpgainfo.appendChild(clkinfo);
			Element FPGA = boardInfo
					.createElement(FPGAInformationSectionString);
			FPGA.setAttribute(FPGASectionStrings[0],
					FPGAClass.Vendors[BoardInfo.fpga.getVendor()].toUpperCase());
			Attr part = boardInfo.createAttribute(FPGASectionStrings[1]);
			part.setValue(BoardInfo.fpga.getPart());
			FPGA.setAttributeNode(part);
			Attr tech = boardInfo.createAttribute(FPGASectionStrings[2]);
			tech.setValue(BoardInfo.fpga.getTechnology());
			FPGA.setAttributeNode(tech);
			Attr box = boardInfo.createAttribute(FPGASectionStrings[3]);
			box.setValue(BoardInfo.fpga.getPackage());
			FPGA.setAttributeNode(box);
			Attr speed = boardInfo.createAttribute(FPGASectionStrings[4]);
			speed.setValue(BoardInfo.fpga.getSpeedGrade());
			FPGA.setAttributeNode(speed);
			Attr usbtmc = boardInfo.createAttribute(FPGASectionStrings[5]);
			usbtmc.setValue(BoardInfo.fpga.USBTMCDownloadRequired().toString());
			FPGA.setAttributeNode(usbtmc);
			Attr jtagPos = boardInfo.createAttribute(FPGASectionStrings[6]);
			jtagPos.setValue(String.valueOf(BoardInfo.fpga.getFpgaJTAGChainPosition()));
			FPGA.setAttributeNode(jtagPos);
			Attr flashName = boardInfo.createAttribute(FPGASectionStrings[7]);
			flashName.setValue(String.valueOf(BoardInfo.fpga.getFlashName()));
			FPGA.setAttributeNode(flashName);
			Attr flashJtagPos = boardInfo.createAttribute(FPGASectionStrings[8]);
			flashJtagPos.setValue(String.valueOf(BoardInfo.fpga.getFlashJTAGChainPosition()));
			FPGA.setAttributeNode(flashJtagPos);
			Element UnusedPins = boardInfo.createElement(UnusedPinsString);
			fpgainfo.appendChild(FPGA);
			UnusedPins.setAttribute("PullBehavior",
					PullBehaviors.Behavior_strings[BoardInfo.fpga
							.getUnusedPinsBehavior()]);
			fpgainfo.appendChild(UnusedPins);
			Element Components = boardInfo
					.createElement(ComponentsSectionString);
			root.appendChild(Components);
			Comment Compcmd = boardInfo
					.createComment("This section describes all Components present on the boards");
			Components.appendChild(Compcmd);
			for (FPGAIOInformationContainer comp : BoardInfo.GetAllComponents()) {
				Components.appendChild(comp.GetDocumentElement(boardInfo));
			}
			ImageXmlFactory writer = new ImageXmlFactory();
			writer.CreateStream(BoardImage);
			Element BoardPicture = boardInfo
					.createElement(ImageInformationString);
			root.appendChild(BoardPicture);
			Comment Pictcmd = boardInfo
					.createComment("This section hold the board picture");
			BoardPicture.appendChild(Pictcmd);
			Element pictsize = boardInfo.createElement("PictureDimension");
			pictsize.setAttribute("Width",
					Integer.toString(BoardImage.getWidth(null)));
			Attr height = boardInfo.createAttribute("Height");
			height.setValue(Integer.toString(BoardImage.getHeight(null)));
			pictsize.setAttributeNode(height);
			BoardPicture.appendChild(pictsize);
			Element CodeTable = boardInfo.createElement("CompressionCodeTable");
			BoardPicture.appendChild(CodeTable);
			CodeTable.setAttribute("TableData", writer.GetCodeTable());
			Element PixelData = boardInfo.createElement("PixelData");
			BoardPicture.appendChild(PixelData);
			PixelData.setAttribute("PixelRGB", writer.GetCompressedString());
		} catch (Exception e) {
			/* TODO: handle exceptions */
			System.err.printf(
					"Exceptions not handled yet in BoardWriterClass(), but got an exception: %s\n",
					e.getMessage());
		}
	}

	public void PrintXml() {
		try {
			TransformerFactory tranFactory = TransformerFactory.newInstance();
			Transformer aTransformer = tranFactory.newTransformer();
			aTransformer.setOutputProperty(OutputKeys.INDENT, "yes");
			Source src = new DOMSource(boardInfo);
			StreamResult dest = new StreamResult(new StringWriter());
			aTransformer.transform(src, dest);
			System.out.println(dest.getWriter().toString());
		} catch (Exception e) {
			/* TODO: handle exceptions */
			System.err.printf(
					"Exceptions not handled yet in PrintXml(), but got an exception: %s\n",
					e.getMessage());
		}
	}

	public void PrintXml(String filename) {
		try {
			TransformerFactory tranFactory = TransformerFactory.newInstance();
			tranFactory.setAttribute("indent-number", 3);
			Transformer aTransformer = tranFactory.newTransformer();
			aTransformer.setOutputProperty(OutputKeys.INDENT, "yes");
			Source src = new DOMSource(boardInfo);
			File file = new File(filename);
			Result dest = new StreamResult(file);
			aTransformer.transform(src, dest);
		} catch (Exception e) {
			System.err.printf(
					"Exceptions not handled yet in PrintXml(), but got an exception: %s\n",
					e.getMessage());
		}
	}

}