tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/colors/ColorSettingsXML.java - tracecompass/org.eclipse.tracecompass - Git at Google

 /*******************************************************************************
  * Copyright (c) 2010, 2015 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
  * accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  *   Patrick Tasse - Initial API and implementation
  *   Bernd Hufmann - Updated to use RGB for the tick color
  *******************************************************************************/

 package org.eclipse.tracecompass.tmf.ui.views.colors;

 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;

 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.parsers.SAXParserFactory;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;

 import org.eclipse.swt.graphics.RGB;
 import org.eclipse.tracecompass.common.core.xml.XmlUtils;
 import org.eclipse.tracecompass.internal.tmf.ui.Activator;
 import org.eclipse.tracecompass.tmf.core.filter.model.ITmfFilterTreeNode;
 import org.eclipse.tracecompass.tmf.core.filter.xml.TmfFilterContentHandler;
 import org.eclipse.tracecompass.tmf.core.filter.xml.TmfFilterXMLWriter;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 import org.xml.sax.XMLReader;
 import org.xml.sax.helpers.DefaultHandler;

 /**
  * Class for saving and loading of color settings to/from file.
  *
  * @version 1.0
  * @author Patrick Tasse
  *
  */
 public class ColorSettingsXML {

     // XML Tags and attributes
     private static final String COLOR_SETTINGS_TAG = "COLOR_SETTINGS"; //$NON-NLS-1$
     private static final String COLOR_SETTING_TAG = "COLOR_SETTING"; //$NON-NLS-1$
     private static final String FG_TAG = "FG"; //$NON-NLS-1$
     private static final String BG_TAG = "BG"; //$NON-NLS-1$
     private static final String R_ATTR = "R"; //$NON-NLS-1$
     private static final String G_ATTR = "G"; //$NON-NLS-1$
     private static final String B_ATTR = "B"; //$NON-NLS-1$
     private static final String TICK_TAG = "TICK"; //$NON-NLS-1$
     private static final String FILTER_TAG = "FILTER"; //$NON-NLS-1$

     /**
      * Saves the given color settings to file.
      *
      * @param pathName
      *            A file name with path
      * @param colorSettings
      *            An array of color settings to save.
      */
     public static void save(String pathName, ColorSetting[] colorSettings) {
         try {
             DocumentBuilder documentBuilder = XmlUtils.newSafeDocumentBuilderFactory().newDocumentBuilder();
             Document document = documentBuilder.newDocument();

             Element rootElement = document.createElement(COLOR_SETTINGS_TAG);
             document.appendChild(rootElement);

             for (ColorSetting colorSetting : colorSettings) {
                 Element colorSettingElement = document.createElement(COLOR_SETTING_TAG);
                 rootElement.appendChild(colorSettingElement);

                 RGB foreground = colorSetting.getForegroundRGB();
                 if (foreground != null) {
                     Element fgElement = document.createElement(FG_TAG);
                     colorSettingElement.appendChild(fgElement);
                     setElementColor(fgElement, foreground);
                 }

                 RGB background = colorSetting.getBackgroundRGB();
                 if (background != null) {
                     Element bgElement = document.createElement(BG_TAG);
                     colorSettingElement.appendChild(bgElement);
                     setElementColor(bgElement, background);
                 }

                 Element tickColorElement = document.createElement(TICK_TAG);
                 colorSettingElement.appendChild(tickColorElement);
                 RGB tickColor = colorSetting.getTickColorRGB();
                 setElementColor(tickColorElement, tickColor);

                 ITmfFilterTreeNode filter = colorSetting.getFilter();
                 if (filter != null) {
                     Element filterElement = document.createElement(FILTER_TAG);
                     colorSettingElement.appendChild(filterElement);
                     TmfFilterXMLWriter.buildXMLTree(document, filter, filterElement);
                 }
             }

             Transformer transformer = XmlUtils.newSecureTransformer();
             DOMSource source = new DOMSource(document);
             StreamResult result = new StreamResult(new File(pathName));
             transformer.transform(source, result);
         } catch (ParserConfigurationException | TransformerException e) {
             Activator.getDefault().logError("Error saving color xml file: " + pathName, e); //$NON-NLS-1$
         }
     }

     private static void setElementColor(Element element, RGB rgb) {
         element.setAttribute(R_ATTR, Integer.toString(rgb.red));
         element.setAttribute(G_ATTR, Integer.toString(rgb.green));
         element.setAttribute(B_ATTR, Integer.toString(rgb.blue));
     }

     /**
      * Loads color settings from file and returns it in an array.
      *
      * @param pathName
      *            A file name with path
      *
      * @return the color settings array loaded from file
      */
     public static ColorSetting[] load(String pathName) {
         if (!new File(pathName).canRead()) {
             return new ColorSetting[0];
         }
         SAXParserFactory parserFactory = SAXParserFactory.newInstance();
         parserFactory.setNamespaceAware(true);

         ColorSettingsContentHandler handler = new ColorSettingsContentHandler();
         try {
             XMLReader saxReader = parserFactory.newSAXParser().getXMLReader();
             saxReader.setContentHandler(handler);
             saxReader.parse(pathName);
             return handler.colorSettings.toArray(new ColorSetting[0]);
         } catch (ParserConfigurationException | SAXException | IOException e) {
             Activator.getDefault().logError("Error loading color xml file: " + pathName, e); //$NON-NLS-1$
         }
         // In case of error, dispose the partial list of color settings
         for (ColorSetting colorSetting : handler.colorSettings) {
             colorSetting.dispose();
         }
         return new ColorSetting[0];
     }

     // Helper class
     private static class ColorSettingsContentHandler extends DefaultHandler {

         private List<ColorSetting> colorSettings = new ArrayList<>(0);
         private RGB fg;
         private RGB bg;
         private RGB tickColor;
         private ITmfFilterTreeNode filter;
         private TmfFilterContentHandler filterContentHandler;

         @Override
         public void startElement(String uri, String localName, String qName, Attributes attributes)
                 throws SAXException {
             switch (localName) {
             case COLOR_SETTINGS_TAG:
                 colorSettings = new ArrayList<>();
                 break;
             case COLOR_SETTING_TAG:
                 fg = null;
                 bg = null;
                 tickColor = null;
                 filter = null;
                 break;
             case FG_TAG:
                 fg = getRGBfromAttributes(attributes);
                 break;
             case BG_TAG:
                 bg = getRGBfromAttributes(attributes);
                 break;
             case TICK_TAG:
                 tickColor = getRGBfromAttributes(attributes);
                 break;
             case FILTER_TAG:
                 filterContentHandler = new TmfFilterContentHandler();
                 break;
             default:
                 if (filterContentHandler != null) {
                     filterContentHandler.startElement(uri, localName, qName, attributes);
                 }
                 break;
             }

         }

         private static RGB getRGBfromAttributes(Attributes attributes) {
             int r = Integer.parseInt(attributes.getValue(R_ATTR));
             int g = Integer.parseInt(attributes.getValue(G_ATTR));
             int b = Integer.parseInt(attributes.getValue(B_ATTR));
             return new RGB(r, g, b);
         }

         @Override
         public void endElement(String uri, String localName, String qName)
                 throws SAXException {
             if (localName.equals(COLOR_SETTINGS_TAG)) {
                 // Nothing to do
             } else if (localName.equals(COLOR_SETTING_TAG)) {
                 ColorSetting colorSetting = new ColorSetting(fg, bg, tickColor, filter);
                 colorSettings.add(colorSetting);
             } else if (localName.equals(FILTER_TAG)) {
                 filter = filterContentHandler.getTree();
                 filterContentHandler = null;
             } else if (filterContentHandler != null) {
                 filterContentHandler.endElement(uri, localName, qName);
             }
         }

     }
 }
	/*******************************************************************************
	* Copyright (c) 2010, 2015 Ericsson
	*
	* All rights reserved. This program and the accompanying materials are
	* made available under the terms of the Eclipse Public License 2.0 which
	* accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* Patrick Tasse - Initial API and implementation
	* Bernd Hufmann - Updated to use RGB for the tick color
	*******************************************************************************/

	package org.eclipse.tracecompass.tmf.ui.views.colors;

	import java.io.File;
	import java.io.IOException;
	import java.util.ArrayList;
	import java.util.List;

	import javax.xml.parsers.DocumentBuilder;
	import javax.xml.parsers.ParserConfigurationException;
	import javax.xml.parsers.SAXParserFactory;
	import javax.xml.transform.Transformer;
	import javax.xml.transform.TransformerException;
	import javax.xml.transform.dom.DOMSource;
	import javax.xml.transform.stream.StreamResult;

	import org.eclipse.swt.graphics.RGB;
	import org.eclipse.tracecompass.common.core.xml.XmlUtils;
	import org.eclipse.tracecompass.internal.tmf.ui.Activator;
	import org.eclipse.tracecompass.tmf.core.filter.model.ITmfFilterTreeNode;
	import org.eclipse.tracecompass.tmf.core.filter.xml.TmfFilterContentHandler;
	import org.eclipse.tracecompass.tmf.core.filter.xml.TmfFilterXMLWriter;
	import org.w3c.dom.Document;
	import org.w3c.dom.Element;
	import org.xml.sax.Attributes;
	import org.xml.sax.SAXException;
	import org.xml.sax.XMLReader;
	import org.xml.sax.helpers.DefaultHandler;

	/**
	* Class for saving and loading of color settings to/from file.
	*
	* @version 1.0
	* @author Patrick Tasse
	*
	*/
	public class ColorSettingsXML {

	// XML Tags and attributes
	private static final String COLOR_SETTINGS_TAG = "COLOR_SETTINGS"; //$NON-NLS-1$
	private static final String COLOR_SETTING_TAG = "COLOR_SETTING"; //$NON-NLS-1$
	private static final String FG_TAG = "FG"; //$NON-NLS-1$
	private static final String BG_TAG = "BG"; //$NON-NLS-1$
	private static final String R_ATTR = "R"; //$NON-NLS-1$
	private static final String G_ATTR = "G"; //$NON-NLS-1$
	private static final String B_ATTR = "B"; //$NON-NLS-1$
	private static final String TICK_TAG = "TICK"; //$NON-NLS-1$
	private static final String FILTER_TAG = "FILTER"; //$NON-NLS-1$

	/**
	* Saves the given color settings to file.
	*
	* @param pathName
	* A file name with path
	* @param colorSettings
	* An array of color settings to save.
	*/
	public static void save(String pathName, ColorSetting[] colorSettings) {
	try {
	DocumentBuilder documentBuilder = XmlUtils.newSafeDocumentBuilderFactory().newDocumentBuilder();
	Document document = documentBuilder.newDocument();

	Element rootElement = document.createElement(COLOR_SETTINGS_TAG);
	document.appendChild(rootElement);

	for (ColorSetting colorSetting : colorSettings) {
	Element colorSettingElement = document.createElement(COLOR_SETTING_TAG);
	rootElement.appendChild(colorSettingElement);

	RGB foreground = colorSetting.getForegroundRGB();
	if (foreground != null) {
	Element fgElement = document.createElement(FG_TAG);
	colorSettingElement.appendChild(fgElement);
	setElementColor(fgElement, foreground);
	}

	RGB background = colorSetting.getBackgroundRGB();
	if (background != null) {
	Element bgElement = document.createElement(BG_TAG);
	colorSettingElement.appendChild(bgElement);
	setElementColor(bgElement, background);
	}

	Element tickColorElement = document.createElement(TICK_TAG);
	colorSettingElement.appendChild(tickColorElement);
	RGB tickColor = colorSetting.getTickColorRGB();
	setElementColor(tickColorElement, tickColor);

	ITmfFilterTreeNode filter = colorSetting.getFilter();
	if (filter != null) {
	Element filterElement = document.createElement(FILTER_TAG);
	colorSettingElement.appendChild(filterElement);
	TmfFilterXMLWriter.buildXMLTree(document, filter, filterElement);
	}
	}

	Transformer transformer = XmlUtils.newSecureTransformer();
	DOMSource source = new DOMSource(document);
	StreamResult result = new StreamResult(new File(pathName));
	transformer.transform(source, result);
	} catch (ParserConfigurationException \| TransformerException e) {
	Activator.getDefault().logError("Error saving color xml file: " + pathName, e); //$NON-NLS-1$
	}
	}

	private static void setElementColor(Element element, RGB rgb) {
	element.setAttribute(R_ATTR, Integer.toString(rgb.red));
	element.setAttribute(G_ATTR, Integer.toString(rgb.green));
	element.setAttribute(B_ATTR, Integer.toString(rgb.blue));
	}

	/**
	* Loads color settings from file and returns it in an array.
	*
	* @param pathName
	* A file name with path
	*
	* @return the color settings array loaded from file
	*/
	public static ColorSetting[] load(String pathName) {
	if (!new File(pathName).canRead()) {
	return new ColorSetting[0];
	}
	SAXParserFactory parserFactory = SAXParserFactory.newInstance();
	parserFactory.setNamespaceAware(true);

	ColorSettingsContentHandler handler = new ColorSettingsContentHandler();
	try {
	XMLReader saxReader = parserFactory.newSAXParser().getXMLReader();
	saxReader.setContentHandler(handler);
	saxReader.parse(pathName);
	return handler.colorSettings.toArray(new ColorSetting[0]);
	} catch (ParserConfigurationException \| SAXException \| IOException e) {
	Activator.getDefault().logError("Error loading color xml file: " + pathName, e); //$NON-NLS-1$
	}
	// In case of error, dispose the partial list of color settings
	for (ColorSetting colorSetting : handler.colorSettings) {
	colorSetting.dispose();
	}
	return new ColorSetting[0];
	}

	// Helper class
	private static class ColorSettingsContentHandler extends DefaultHandler {

	private List<ColorSetting> colorSettings = new ArrayList<>(0);
	private RGB fg;
	private RGB bg;
	private RGB tickColor;
	private ITmfFilterTreeNode filter;
	private TmfFilterContentHandler filterContentHandler;

	@Override
	public void startElement(String uri, String localName, String qName, Attributes attributes)
	throws SAXException {
	switch (localName) {
	case COLOR_SETTINGS_TAG:
	colorSettings = new ArrayList<>();
	break;
	case COLOR_SETTING_TAG:
	fg = null;
	bg = null;
	tickColor = null;
	filter = null;
	break;
	case FG_TAG:
	fg = getRGBfromAttributes(attributes);
	break;
	case BG_TAG:
	bg = getRGBfromAttributes(attributes);
	break;
	case TICK_TAG:
	tickColor = getRGBfromAttributes(attributes);
	break;
	case FILTER_TAG:
	filterContentHandler = new TmfFilterContentHandler();
	break;
	default:
	if (filterContentHandler != null) {
	filterContentHandler.startElement(uri, localName, qName, attributes);
	}
	break;
	}

	}

	private static RGB getRGBfromAttributes(Attributes attributes) {
	int r = Integer.parseInt(attributes.getValue(R_ATTR));
	int g = Integer.parseInt(attributes.getValue(G_ATTR));
	int b = Integer.parseInt(attributes.getValue(B_ATTR));
	return new RGB(r, g, b);
	}

	@Override
	public void endElement(String uri, String localName, String qName)
	throws SAXException {
	if (localName.equals(COLOR_SETTINGS_TAG)) {
	// Nothing to do
	} else if (localName.equals(COLOR_SETTING_TAG)) {
	ColorSetting colorSetting = new ColorSetting(fg, bg, tickColor, filter);
	colorSettings.add(colorSetting);
	} else if (localName.equals(FILTER_TAG)) {
	filter = filterContentHandler.getTree();
	filterContentHandler = null;
	} else if (filterContentHandler != null) {
	filterContentHandler.endElement(uri, localName, qName);
	}
	}

	}
	}