busparameters.java

The ElectricTM VLSI Design System is an open-source Electronic Design Automation (EDA) system that c

/* -*- tab-width: 4 -*-
 *
 * Electric(tm) VLSI Design System
 *
 * File: BusParameters.java
 *
 * Copyright (c) 2005 Sun Microsystems and Static Free Software
 *
 * Electric(tm) 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.
 *
 * Electric(tm) 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 Electric(tm); see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, Mass 02111-1307, USA.
 */
package com.sun.electric.tool.user.dialogs;

import com.sun.electric.database.hierarchy.Cell;
import com.sun.electric.database.hierarchy.Export;
import com.sun.electric.database.hierarchy.Library;
import com.sun.electric.database.text.TextUtils;
import com.sun.electric.database.topology.ArcInst;
import com.sun.electric.database.topology.NodeInst;
import com.sun.electric.database.variable.ElectricObject;
import com.sun.electric.database.variable.TextDescriptor;
import com.sun.electric.database.variable.Variable;
import com.sun.electric.tool.Job;
import com.sun.electric.tool.JobException;
import com.sun.electric.tool.user.Highlight2;
import com.sun.electric.tool.user.User;
import com.sun.electric.tool.user.ui.EditWindow;
import com.sun.electric.tool.user.ui.TopLevel;

import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import javax.swing.DefaultListModel;
import javax.swing.JComboBox;
import javax.swing.JList;
import javax.swing.ListSelectionModel;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

/**
 * Class to handle the "Bus Parameters" dialog.
 */
public class BusParameters extends EDialog
{
	/** key for library's bus variables. */	public static final Variable.Key BUS_VARIABLES = Variable.newKey("LIB_Bus_Variables");
	/** key for node's bus template. */		public static final Variable.Key NODE_BUS_TEMPLATE = Variable.newKey("NODE_Bus_Template");
	/** key for arc's bus template. */		public static final Variable.Key ARC_BUS_TEMPLATE = Variable.newKey("ARC_Bus_Template");
	/** key for export's bus template. */	public static final Variable.Key EXPORT_BUS_TEMPLATE = Variable.newKey("EXPORT_Bus_Template");

	private JList parametersList;
	private DefaultListModel parametersModel;
	Map<Library,String[]> libParameters;
	
	public static void showBusParametersDialog()
	{
		BusParameters dialog = new BusParameters(TopLevel.getCurrentJFrame());
		dialog.setVisible(true);
	}

	public static void makeBusParameter()
	{
		EditWindow wnd = EditWindow.getCurrent();
		Highlight2 h = wnd.getHighlighter().getOneHighlight();
		if (h == null)
		{
			Job.getUserInterface().showErrorMessage("Select a node, arc, or export name first", "Nothing Selected");
			return;
		}
		ElectricObject owner = h.getElectricObject();
		if (owner == null || !(owner instanceof NodeInst || owner instanceof ArcInst || owner instanceof Export))
		{
			Job.getUserInterface().showErrorMessage("Select a node, arc, or export name first", "Incorrect Selection");
			return;
		}
		if (owner instanceof ArcInst)
		{
			if (h.getVarKey() != ArcInst.ARC_NAME)
			{
				Job.getUserInterface().showErrorMessage("Must select the arc's name", "Incorrect Selection");
				return;
			}
		}
		if (owner instanceof NodeInst)
		{
			if (h.getVarKey() != NodeInst.NODE_NAME)
			{
				Job.getUserInterface().showErrorMessage("Must select the node's name", "Incorrect Selection");
				return;
			}
		}
		new AddTemplate(owner);
	}

	/**
	 * Method for internally updating bus parameters.
	 * Can be called from internal electric routines.
	 * Added for ArchGen Plugin - BVE
	 */
	public static void updateBusParametersInt()
	{
		BusParameters foo = new BusParameters(null);
		foo.setVisible(false);
		new UpdateAllParameters(foo.libParameters, true);
	}
	
	/**
	 * Method for internally updating bus parameters on a single cell.
	 * Can be called from internal electric routines.
	 * Added for ArchGen Plugin - BVE
	 */
	public static void updateCellBusParameterInt(Cell cell, Library lib)
	{
		Map<Library,String[]> libParam = new HashMap<Library,String[]>();
		initializeLibParameters(libParam, null);
		updateCellParameters(cell, lib, libParam);
	}
	
	/**
	 * Method to replace bus parameters in Electric variables.
	 * Can be called from internal Electric routines.
	 * Added for ArchGen Plugin - BVE
	 * @param varString the string with embedded variables.
	 * @return the string with bus parameters substituted.
	 */
	public static String replaceBusParameterInt(String varString)
	{
		// find library with variables in it
		Map<Library,String[]> libParam = new HashMap<Library,String[]>();
		initializeLibParameters(libParam, null);
		return replaceVariableInString(varString, null, libParam);
	}
	
	/**
	 * Creates a template with a suffix appended to the owners's name.
	 * @param owner
	 * @param suffix
	 */
	public static void addTemplateWithString(ElectricObject owner, String suffix)
	{
		new AddTemplate(owner, true, suffix);
	}
	
	/**
	 * Internal method for finding all bus parameters across all libraries.  Refactored to
	 * permit resuse.
	 * Added for ArchGen Plugin - BVE
	 * @param libParam
	 * @param libPopup
	 * @return
	 */
	private static Library initializeLibParameters(Map<Library,String[]> libParam, JComboBox libPopup)
	{
		Library bestLib = null;
		int mostParameters = 0;
		for(Iterator<Library> it = Library.getLibraries(); it.hasNext(); )
		{
			Library lib = it.next();
			if (lib.isHidden()) continue;
			if(libPopup != null) libPopup.addItem(lib.getName());
			Variable var = lib.getVar(BUS_VARIABLES);
			String [] parameterList = new String[0];
			if (var != null) parameterList = (String [])var.getObject();
			libParam.put(lib, parameterList);
			if (parameterList.length > mostParameters)
			{
				bestLib = lib;
				mostParameters = parameterList.length;
			}
		}
		Library curLib = Library.getCurrent();
		String [] parameterList = libParam.get(curLib);
		if ((parameterList != null && parameterList.length > 0) || bestLib == null) bestLib = curLib;		
		return bestLib;
	}
	
	/** Creates new form Bus Parameters */
	private BusParameters(Frame parent)
	{
		super(parent, true);
		initComponents();

		// build display list for variables
		parametersModel = new DefaultListModel();
		parametersList = new JList(parametersModel);
		parametersList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
		variablesPane.setViewportView(parametersList);

		value.getDocument().addDocumentListener(new BusParametersDocumentListener(this));

		// find library with variables in it
		libParameters = new HashMap<Library,String[]>();
		// BVE - Refactored code into helper function
		Library bestLib = initializeLibParameters(libParameters, libraryPopup);

		parametersList.addMouseListener(new MouseAdapter()
		{
			public void mouseClicked(MouseEvent evt) { variablesSelected(); }
		});
		libraryPopup.addActionListener(new ActionListener()
		{
			public void actionPerformed(ActionEvent evt) { libraryChanged(); }
		});
		libraryPopup.setSelectedItem(bestLib.getName());

		pack();
		finishInitialization();
	}

	protected void escapePressed() { doneActionPerformed(null); }

	/**
	 * Method called when the library popup is changed
	 * and the list of bus variables should be updated.
	 */
	private void libraryChanged()
	{
		parametersModel.clear();
		String libName = (String)libraryPopup.getSelectedItem();
		Library lib = Library.findLibrary(libName);
		if (lib == null) return;
		String [] parameterList = libParameters.get(lib);
		boolean gotSome = false;
		for(int i=0; i<parameterList.length; i++)
		{
			String variable = parameterList[i];
			int equalPos = variable.indexOf('=');
			if (equalPos < 0) continue;
			parametersModel.addElement(variable.substring(0, equalPos));
			gotSome = true;
		}
		if (gotSome)
		{
			parametersList.setSelectedIndex(0);
			variablesSelected();
		}
	}

	/**
	 * Method called when a variable has been selected
	 * and its value should be shown.
	 */
	private void variablesSelected()
	{
		String libName = (String)libraryPopup.getSelectedItem();
		Library lib = Library.findLibrary(libName);
		if (lib == null) return;
		String [] parameterList = libParameters.get(lib);
		int selectedIndex = parametersList.getSelectedIndex();
		if (selectedIndex < 0 || selectedIndex >= parameterList.length) return;
		String varSelected = parameterList[selectedIndex];
		int equalPos = varSelected.indexOf('=');
		if (equalPos < 0) return;
		value.setText(varSelected.substring(equalPos+1));
	}

	/**
	 * Method called when a bus variable value has changed.
	 */
	private void valueChanged()
	{
		String libName = (String)libraryPopup.getSelectedItem();
		Library lib = Library.findLibrary(libName);
		if (lib == null) return;
		String [] parameterList = libParameters.get(lib);
		int selectedIndex = parametersList.getSelectedIndex();
		if (selectedIndex < 0 || selectedIndex >= parameterList.length) return;
		String parSelected = parameterList[selectedIndex];
		int equalPos = parSelected.indexOf('=');
		if (equalPos < 0) return;
		parameterList[selectedIndex] = parSelected.substring(0, equalPos+1) + value.getText();
		new UpdateLibrary(lib, parameterList);
	}

	/**
	 * Class to handle special changes to changes to the variable value.
	 */
	private static class BusParametersDocumentListener implements DocumentListener
	{
		BusParameters dialog;

		BusParametersDocumentListener(BusParameters dialog) { this.dialog = dialog; }

		public void changedUpdate(DocumentEvent e) { dialog.valueChanged(); }
		public void insertUpdate(DocumentEvent e) { dialog.valueChanged(); }
		public void removeUpdate(DocumentEvent e) { dialog.valueChanged(); }
	}

	/**
	 * Class to update variables on a library.
	 */
	private static class UpdateLibrary extends Job
	{
		private Library lib;
		private String [] parameterList;

		private UpdateLibrary(Library lib, String [] parameterList)
		{
			super("Update Bus Parameters", User.getUserTool(), Job.Type.CHANGE, null, null, Job.Priority.USER);
			this.lib = lib;
			this.parameterList = parameterList;
			startJob();
		}

		public boolean doIt() throws JobException
		{
			lib.newVar(BUS_VARIABLES, parameterList);
//			lib.setChanged();
			return true;
		}
	}

	/**
	 * Class to update parameters on all libraries.
	 */
	private static class UpdateAllParameters extends Job
	{
		private Map<Library,String[]> libParameters;

		private UpdateAllParameters(Map<Library,String[]> libParameters)
		{
			super("Update All Bus Parameters", User.getUserTool(), Job.Type.CHANGE, null, null, Job.Priority.USER);
			this.libParameters = libParameters;
			startJob();
		}
		
		private UpdateAllParameters(Map<Library,String[]> libParameters, boolean doItNow)
		{
			super("Update All Bus Parameters", User.getUserTool(), Job.Type.CHANGE, null, null, Job.Priority.USER);
			this.libParameters = libParameters;
			if (doItNow){
			   try {doIt();} catch (Exception e) {e.printStackTrace();}
			}else {
				startJob();
			}
		}

		public boolean doIt() throws JobException
		{
			for(Iterator<Library> it = Library.getLibraries(); it.hasNext(); )
			{
				Library lib = it.next();
				if (lib.isHidden()) continue;
				for(Iterator<Cell> cIt = lib.getCells(); cIt.hasNext(); )
				{
					Cell cell = cIt.next();
					// BVE - Old code refactored into helper function
					updateCellParameters(cell, lib, libParameters);
				}
			}
			return true;
		}
	}

	/**
	 * Internal method for updating the bus parameters within a single cell.  Refactored to
	 * permit resuse.
	 * Added for ArchGen Plugin - BVE
	 * @param cell
	 * @param lib
	 * @param libParameters
	 */
	private static void updateCellParameters(Cell cell, Library lib, Map<Library,String[]> libParameters) {
		for(Iterator<NodeInst> nIt = cell.getNodes(); nIt.hasNext(); )
		{
			NodeInst ni = nIt.next();
			Variable var = ni.getVar(NODE_BUS_TEMPLATE);
			if (var != null)
			{
				String newVarString = updateVariable(var, lib, libParameters);
				String arcName = ni.getName();
				if (!arcName.equalsIgnoreCase(newVarString))
					ni.setName(newVarString);
			}
		}
		for(Iterator<ArcInst> aIt = cell.getArcs(); aIt.hasNext(); )
		{
			ArcInst ai = aIt.next();
			Variable var = ai.getVar(ARC_BUS_TEMPLATE);
			if (var != null)
			{
				String newVarString = updateVariable(var, lib, libParameters);
				String arcName = ai.getName();
				if (!arcName.equalsIgnoreCase(newVarString))
					ai.setName(newVarString);
			}
		}
		for(Iterator<Export> eIt = cell.getExports(); eIt.hasNext(); )
		{
			Export e = eIt.next();
			Variable var = e.getVar(EXPORT_BUS_TEMPLATE);
			if (var != null)
			{
				String newVarString = updateVariable(var, lib, libParameters);
				String exportName = e.getName();
				if (!exportName.equalsIgnoreCase(newVarString))
					e.rename(newVarString);
			}
		}
	}
	
	/**
	 * Internal method for replacing a bus parameter in a string.  Refactored to
	 * permit reuse.