/*
@Copyright (c) 2005-2006 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the
above copyright notice and the following two paragraphs appear in all
copies of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.domains.ptinyos.util.ncapp2moml;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import net.tinyos.nesc.dump.NDReader;
import net.tinyos.nesc.dump.xml.WiringNode;
import net.tinyos.nesc.dump.xml.WiringScan;
import net.tinyos.nesc.dump.xml.WiringScanForwards;
import net.tinyos.nesc.dump.xml.Xcomponent;
import net.tinyos.nesc.dump.xml.Xinterface;
import net.tinyos.nesc.dump.xml.Xnesc;
import net.tinyos.nesc.dump.xml.Xwire;
import net.tinyos.nesc.dump.xml.Xwiring;
import org.jdom.DocType;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.filter.ContentFilter;
import org.jdom.filter.Filter;
import org.jdom.input.SAXBuilder;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;
import org.xml.sax.SAXException;
import ptolemy.actor.AtomicActor;
import ptolemy.actor.CompositeActor;
import ptolemy.actor.IOPort;
import ptolemy.actor.IORelation;
import ptolemy.kernel.Port;
import ptolemy.kernel.Relation;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.InternalErrorException;
import ptolemy.kernel.util.NameDuplicationException;
/**
Generate a .moml file for each .nc application file in the input list.
Usage:
<pre>
java -classpath $PTII ptolemy.domains.ptinyos.util.ncapp2moml.NCApp2MoML \
<<i>.nc source prefix</i>> \
<<i>.nc xml input prefix</i>> \
<<i>.nc xml input suffix</i>> \
<<i>opts input suffix</i>> \
<<i>moml output prefix</i>> \
<<i>long path to file containing list of .nc files using short path</i>> \
<i>path to MicaBoard.xml if you want the generated file to include the Wireless domain wrapper</i>
</pre>
Example:
<pre>
java -classpath $PTII ptolemy.domains.ptinyos.util.ncapp2moml.NCApp2MoML \
/home/celaine/ptII/vendors/ptinyos/tinyos-1.x \
/home/celaine/ptII/vendors/ptinyos/momlapp \
.ncxml \
.opts \
/home/celaine/ptII/vendors/ptinyos/momlapp \
/home/celaine/ptII/vendors/ptinyos/momlapp/.ncapp2moml-tempfile
</pre>
.tempfile contains:
<pre>
apps/CntToLeds/CntToLeds.nc
</pre>
Example output for CntToLeds.nc:
<pre>
<?xml version="1.0"?>
<!DOCTYPE entity PUBLIC "-//UC Berkeley//DTD MoML 1//EN" "http://ptolemy.eecs.berkeley.edu/xml/dtd/MoML_1.dtd">
<entity name="CntToLeds" class="ptolemy.domains.ptinyos.kernel.NCCompositeActor">
<property name="PtinyOSDirector" class="ptolemy.domains.ptinyos.kernel.PtinyOSDirector" />
<entity name="Counter" class="tos.lib.Counters.Counter" />
<entity name="IntToLeds" class="tos.lib.Counters.IntToLeds" />
<entity name="TimerC" class="tos.system.TimerC" />
<entity name="Main" class="tos.system.Main" />
<relation name="relation1" class="ptolemy.actor.IORelation" />
<relation name="relation2" class="ptolemy.actor.IORelation" />
<relation name="relation3" class="ptolemy.actor.IORelation" />
<link port="Counter.IntOutput" relation="relation3" />
<link port="Counter.Timer" relation="relation2" />
<link port="IntToLeds.StdControl" relation="relation1" />
<link port="TimerC.Timer" relation="relation2" />
<link port="Counter.StdControl" relation="relation1" />
<link port="TimerC.StdControl" relation="relation1" />
<link port="IntToLeds.IntOutput" relation="relation3" />
<link port="Main.StdControl" relation="relation1" />
</entity>
</pre>
Expects <<i>xml input prefix</i>>
to contain files with <<i>xml input suffix</i>> containing
an xml dump with the following parameters:
<pre>
-fnesc-dump=components(wiring, file(filename.nc)
-fnesc-dump=referenced(interfaces)
</pre>
Example call to ncc:
<pre>
ncc '-fnesc-dump=components(wiring, file(/home/celaine/tinyos/tinyos/tinyos-1.x-scratch/apps/CntToLeds/CntToLeds.nc))' '-fnesc-dump=referenced(interfaces)' -fnesc-dumpfile=/home/celaine/ptII/vendors/moml/apps/CntToLeds/CntToLeds.ncxml /home/celaine/tinyos/tinyos/tinyos-1.x-scratch/apps/CntToLeds/CntToLeds.nc -I/home/celaine/tinyos/tinyos/tinyos-1.x-scratch/tos/lib/Counters/
</pre>
@author Elaine Cheong
@version $Id$
@since Ptolemy II 5.1
@Pt.ProposedRating Red (celaine)
@Pt.AcceptedRating Red (celaine)
*/
public class NCApp2MoML {
/** Generate the .moml file for this nesC application.
*
* @param componentName The name of the component (no suffix).
* @param outputFile The file to generate.
* @param directorOutputDir The output directory to pass to the
* PtinyOSDirector.
* @param opts The compiler options (PFLAGS) to pass to the
* PtinyOSDirector.
* @param micaboardFile Path to the MoML file that contains the
* Wireless wrapper. Null if wrapper should not be generated.
* @exception IllegalActionException If there is a problem creating
* an interface IOport or connection.
* @exception NameDuplicationException If there is a problem creating
* an interface IOport or connection.
*/
public void generatePtinyOSModel(String componentName, String outputFile,
String directorOutputDir, String opts, String micaboardFile)
throws IllegalActionException, NameDuplicationException {
Element root = null;
Element director = null;
// Set the doc type.
DocType plot = new DocType("entity", "-//UC Berkeley//DTD MoML 1//EN",
"http://ptolemy.eecs.berkeley.edu/xml/dtd/MoML_1.dtd");
Document doc = null;
if (micaboardFile != null) {
Element micaboard = null;
try {
SAXBuilder saxbuilder = new SAXBuilder();
Document docWireless = saxbuilder
.build(new File(micaboardFile));
Filter filter = new ContentFilter(ContentFilter.ELEMENT);
Iterator iteratorDocWireless = docWireless
.getDescendants(filter);
while (iteratorDocWireless.hasNext()) {
Element e = (Element) iteratorDocWireless.next();
String classname = e.getAttributeValue("class");
if (classname != null) {
if (classname
.equals("ptolemy.domains.wireless.kernel.WirelessComposite")) {
micaboard = (Element) e.clone();
break;
}
}
}
if (micaboard == null) {
throw new Exception(
"Could not find WirelessComposite entry point in: "
+ micaboardFile);
}
Iterator iteratorMicaBoard = micaboard.getDescendants(filter);
while (iteratorMicaBoard.hasNext()) {
Element e = (Element) iteratorMicaBoard.next();
String classname = e.getAttributeValue("class");
if (classname != null) {
if (classname
.equals("ptolemy.domains.ptinyos.lib.MicaCompositeActor")) {
root = e;
} else if (classname
.equals("ptolemy.domains.ptinyos.kernel.PtinyOSDirector")) {
director = e;
}
}
}
if (root == null) {
throw new Exception(
"Could not find MicaCompositeActor entry point in: "
+ micaboardFile);
}
if (director == null) {
throw new Exception(
"Could not find PtinyOSDirector entry point in: "
+ micaboardFile);
}
} catch (Exception e) {
System.err.println("Error: " + e);
e.printStackTrace();
}
// Create the top level entity.
Element rootWireless = new Element("entity");
rootWireless.setAttribute("name", componentName);
rootWireless.setAttribute("class",
"ptolemy.actor.TypedCompositeActor");
// Create and add the Wireless Director.
Element wirelessDirector = new Element("property");
wirelessDirector.setAttribute("name", "Wireless Director");
wirelessDirector.setAttribute("class",
"ptolemy.domains.wireless.kernel.WirelessDirector");
rootWireless.addContent(wirelessDirector);
// Add the micaboard to the top level entity.
rootWireless.addContent(micaboard);
// Create the document with the top level entity.
doc = new Document(rootWireless, plot);
} else {
// Set the name of this class to the name of this nesC component.
root = new Element("entity");
root.setAttribute("name", componentName);
root.setAttribute("class",
"ptolemy.domains.ptinyos.kernel.NCCompositeActor");
doc = new Document(root, plot);
director = new Element("property");
director.setAttribute("name", "PtinyOSDirector");
director.setAttribute("class",
"ptolemy.domains.ptinyos.kernel.PtinyOSDirector");
root.addContent(director);
}
// Set the PFLAGS value of the PtinyOSDirector.
// <property name="pflags" class="ptolemy.data.expr.StringParameter" value="-I%T/../apps/Blink">
Element pflags = new Element("property");
pflags.setAttribute("name", "pflags");
pflags.setAttribute("class", "ptolemy.data.expr.StringParameter");
pflags.setAttribute("value", opts.trim());
if (director == null) {
throw new InternalErrorException("Could not find PtinyOSDirector element.");
} else {
director.addContent(pflags);
}
// Set the destination directory parameter of the PtinyOSDirector.
// <property name="destinationDirectory" class="ptolemy.data.expr.FileParameter" value="$PTII/ptolemy/domains/ptinyos/demo/Blink/output">
Element destinationDirectory = new Element("property");
destinationDirectory.setAttribute("name", "destinationDirectory");
destinationDirectory.setAttribute("class",
"ptolemy.data.expr.FileParameter");
destinationDirectory.setAttribute("value", directorOutputDir);
director.addContent(destinationDirectory);
//-----------------------------------------------------------------
// Add a text annotation to tell the user to layout the graph.
// <property name="Annotation" class="ptolemy.vergil.kernel.attributes.TextAttribute">
// <property name="text" class="ptolemy.kernel.util.StringAttribute" value="To automatically rearrange the component layout,
select Graph | Automatic Layout from the menu, or
type Ctrl-T." />
// <property name="_location" class="ptolemy.kernel.util.Location" value="[20.0, 345.0]" />
// </property>
Element annotation = new Element("property");
annotation.setAttribute("name", "Annotation");
annotation.setAttribute("class",
"ptolemy.vergil.kernel.attributes.TextAttribute");
if (root == null) {
throw new InternalErrorException("Could not find root element.");
} else {
root.addContent(annotation);
}
Element text = new Element("property");
text.setAttribute("name", "text");
text.setAttribute("class", "ptolemy.kernel.util.StringAttribute");
text.setAttribute("value",
"To automatically rearrange the component layout,"
+ "\nselect Graph | Automatic Layout from the menu,"
+ "\nor type Ctrl-T.");
annotation.addContent(text);
Element location = new Element("property");
location.setAttribute("name", "_location");
location.setAttribute("class", "ptolemy.kernel.util.Location");
location.setAttribute("value", "[20.0, 345.0]");
annotation.addContent(location);
//-----------------------------------------------------------------
// Traverse the configuration graph and set up the data structures.
readLinks();
// Create xml for each component.
Enumeration enumeration = _componentFileTable.elements();
while (enumeration.hasMoreElements()) {
_ComponentFile componentFile = (_ComponentFile) enumeration
.nextElement();
Element entity = new Element("entity");
entity.setAttribute("name", componentFile.getName());
entity.setAttribute("class", componentFile.getClassName());
root.addContent(entity);
}
// Create xml for each relation.
for (int i = 1; i <= _relations.currentCount(); i++) {
Element relation = new Element("relation");
relation.setAttribute("name", "relation" + i);
relation.setAttribute("class", "ptolemy.actor.IORelation");
root.addContent(relation);
}
// Create xml for each link.
for (int i = 0; i < _linkList.size(); i++) {
Element xmlLink = new Element("link");
_Link link = (_Link) _linkList.get(i);
// Set up From information.
String fromType;
String fromName;
if (link.from instanceof Port) {
fromType = "port";
Port port = (Port) link.from;
fromName = port.getContainer().getName() + "." + port.getName();
} else if (link.from instanceof Relation) {
fromType = "relation";
Relation relation = (Relation) link.from;
fromName = relation.getName();
} else {
throw new InternalErrorException(
"Expected link.from type to be either "
+ "Port or Relation.");
}
// Set up To information.
String toType;
String toName;
if (link.to instanceof Port) {
toType = "port";
Port port = (Port) link.to;
toName = port.getContainer().getName() + "." + port.getName();
} else if (link.to instanceof Relation) {
toType = "relation";
Relation relation = (Relation) link.to;
toName = relation.getName();
} else {
throw new InternalErrorException(
"Expected link.to type to be either "
+ "Port or Relation.");
}
// If this is a link between relations, adjust the label names.
if (fromType.equals("relation") && toType.equals("relation")) {
fromType += "1";
toType += "2";
}
xmlLink.setAttribute(fromType, fromName);
xmlLink.setAttribute(toType, toName);
root.addContent(xmlLink);
}
// Output the moml code to a file.
try {
// Open the file.
FileOutputStream out = null;
if (outputFile != null) {
out = new FileOutputStream(outputFile);
}
// Set up the serializer.
XMLOutputter serializer = new XMLOutputter(Format.getPrettyFormat());
Format format = serializer.getFormat();
format.setOmitEncoding(true);
format.setLineSeparator("\n");
serializer.setFormat(format);
// Write, flush, and close the file.
if (out != null) {
serializer.output(doc, out);
out.flush();
out.close();
} else {
// If a file was not specified, write to stdout.
serializer.output(doc, System.out);
}
} catch (IOException e) {
System.err.println(e);
}
}
/** Read in .nc application xml files, generate .moml files.
* @param args A series of command line arguments, see the
* class comment for details.
* @exception IOException If there is a problem reading or
* writing a file.
*/
public static void main(String[] args) throws IOException {
// Check to make sure all necessary arguments have been passed
// to program.
if (args.length < 6) {
System.err.println("Usage: java -classpath $PTII "
+ "ptolemy.domains.ptinyos.util.ncapp2moml.NCApp2MoMl "
+ "<.nc source prefix> " + "<.nc xml input prefix> "
+ "<.nc xml input suffix> " + "<opts input suffix"
+ "<moml output prefix> "
+ "<long path to file containing list of .nc files using "
+ "short path>"
+ "[path to MicaBoard.xml if you want the generated file "
+ "to include the Wireless domain wrapper]");
return;
}
// Flag to indicate whether the Wireless wrapper should be generated.
boolean generateWrapper = false;
// Extract arguments into variables.
int index = 0;
String ncSourcePrefix = args[index++].trim();
String inputPrefix = args[index++].trim();
String inputSuffixNC = args[index++].trim();
String inputSuffixOpts = args[index++].trim();
String outputPrefix = args[index++].trim();
String inputfilelist = args[index++].trim();
String micaboardFile = null;
if (args.length >= index + 1) {
micaboardFile = args[index++].trim();
generateWrapper = true;
}
_ncSourcePrefix = ncSourcePrefix;
try {
// Open the file containing the list of .nc files.
BufferedReader in = new BufferedReader(
new FileReader(inputfilelist));
String inputfilename;
// Read each line of the file.
while ((inputfilename = in.readLine()) != null) {
// Determine the nesC xml name (with path) of the file.
String xmlSuffix = inputfilename.replaceFirst("\\.nc$",
inputSuffixNC);
String xmlInputFile = inputPrefix + _FILESEPARATOR + xmlSuffix;
// Determine the opts file name (with path) of the file.
String optsSuffix = inputfilename.replaceFirst("\\.nc$",
inputSuffixOpts);
String optsInputFile = inputPrefix + _FILESEPARATOR
+ optsSuffix;
// Determine the component name.
String[] subdirs = inputfilename.split(_FILESEPARATOR);
String componentName = subdirs[subdirs.length - 1];
componentName = componentName.replaceFirst("\\.nc$", "");
if (generateWrapper) {
componentName += _INWIRELESS;
}
// Determine the .moml name (with path) of the file.
String momlSuffix;
if (!generateWrapper) {
momlSuffix = inputfilename
.replaceFirst("\\.nc$", "\\.moml");
} else {
momlSuffix = inputfilename.replaceFirst("\\.nc$",
_INWIRELESS + "\\.moml");
}
String momlOutputFile = outputPrefix + _FILESEPARATOR
+ momlSuffix;
// Determine the PtinyOSDirector output directory.
String[] directorOutputDirSubDirs = momlOutputFile
.split(_FILESEPARATOR);
String directorOutputDir = momlOutputFile
.replaceFirst(
directorOutputDirSubDirs[directorOutputDirSubDirs.length - 1]
+ "$", "");
directorOutputDir = directorOutputDir + "output";
try {
// Parse the nesC xml file.
if (new NDReader().parse(xmlInputFile)) {
System.out.println("parse ok: " + xmlInputFile);
} else {
System.err.println("parse exceptions occurred: "
+ xmlInputFile);
}
// Generate the .moml file.
try {
String opts = readOptsFile(optsInputFile);
new NCApp2MoML().generatePtinyOSModel(componentName,
momlOutputFile, directorOutputDir, opts,
micaboardFile);
} catch (Exception e) {
System.err.println("Errors while generating "
+ momlOutputFile + " because of exception: "
+ e);
}
} catch (SAXException e) {
System.err
.println("No xml reader found for" + xmlInputFile);
} catch (FileNotFoundException e) {
System.err.println("Could not find file " + xmlInputFile);
} catch (Exception e) {
System.err.println("Did not complete harvest for file: "
+ xmlInputFile + " because of exception: " + e);
}
}
// Close the input file.
in.close();
} catch (IOException e) {
System.err.println("Could not open file: " + inputfilelist);
System.err.println("because of exception: " + e);
}
}
/** Read in the opts file.
* @param optsInputFile The file to read.
* @return The opts string, or empty string if there is none.
*/
public static String readOptsFile(String optsInputFile) {
String opts = "";
BufferedReader in = null;
try {
in = new BufferedReader(
new FileReader(optsInputFile));
opts = in.readLine();
} catch (Exception e) {
// Do nothing.
} finally {
if (in != null) {
try {
in.close();
} catch (IOException ex) {
//Ignore
}
}
}
return opts;
}
/** Create all the relations and links needed to form the
* connection between interfaceFrom and interfaceTo.
* @param interfaceFrom The source interface of the connection.
* @param interfaceTo The destination interface of the connection.
* @exception IllegalActionException If thrown while creating a relation
* or linking to a port.
* @exception NameDuplicationException If thrown while creating a relation
* or linking to a port.
*/
protected void createConnection(Xinterface interfaceFrom,
Xinterface interfaceTo) throws IllegalActionException,
NameDuplicationException {
// Find ports connected to interfaces.
Port portFrom = (Port) _interfaceIOPortTable.get(interfaceFrom);
Port portTo = (Port) _interfaceIOPortTable.get(interfaceTo);
if (portFrom == null || portTo == null) {
throw new InternalErrorException(
"Could not find port for From interface: " + interfaceFrom);
}
// Determine the From Relation.
Relation relationFrom;
if (interfaceFrom.parameters == null) {
if (_interfaceRelationTable.containsKey(interfaceFrom)) {
// This is a single (non-parameterized) port, and
// the relation already exists, so we reuse it.
Object o = _interfaceRelationTable.get(interfaceFrom);
if (!(o instanceof Relation)) {
throw new InternalErrorException(
"Single port should only be connected to a "
+ "Relation.");
}
relationFrom = (Relation) o;
} else {
// This is a single (non-parameterized) port, and
// the relation does not already exist, so we
// create a new relation, create a link and a
// _Link from the port to the new relation, and
// add the _Link to the list of links.
String relationName = _relations.getNewRelationName();
relationFrom = new IORelation(_compositeActor, relationName);
_interfaceRelationTable.put(interfaceFrom, relationFrom);
portFrom.link(relationFrom);
_Link link = new _Link(portFrom, relationFrom);
_linkList.add(link);
}
} else {
// This is a multi (parameterized) port, so we create
// a new relation, add it to the relation list of the
// interface, create a link and a _Link from the port
// to the new relation, and add the _Link to the list
// of links.
String relationName = _relations.getNewRelationName();
relationFrom = new IORelation(_compositeActor, relationName);
if (_interfaceRelationTable.containsKey(interfaceFrom)) {
// If the interface already has a relation list,
// add the new relation to the list.
Object o = _interfaceRelationTable.get(interfaceFrom);
if (!(o instanceof ArrayList)) {
throw new InternalErrorException(
"Multiport should only be connected to an "
+ "ArrayList of Relation.");
}
ArrayList arrayList = (ArrayList) o;
arrayList.add(relationFrom);
} else {
// If the interface does not already have a
// relation list, create it and add the new
// relation to the list.
ArrayList arrayList = new ArrayList();
arrayList.add(relationFrom);
_interfaceRelationTable.put(interfaceFrom, arrayList);
}
portFrom.link(relationFrom);
_Link link = new _Link(portFrom, relationFrom);
_linkList.add(link);
}
// Determine the To Relation.
Relation relationTo;
if (interfaceTo.parameters == null) {
if (_interfaceRelationTable.containsKey(interfaceTo)) {
// This is a single (non-parameterized) port, and
// the relation already exists, so we reuse it.
Object o = _interfaceRelationTable.get(interfaceTo);
if (!(o instanceof Relation)) {
throw new InternalErrorException(
"Single port should only be connected to a "
+ "Relation.");
}
relationTo = (Relation) o;
} else {
// This is a single (non-parameterized) port, and
// the relation does not already exist, so we
// create a new relation, create a link and a
// _Link from the new relation to the port, and
// add the _Link to the list of links.
String relationName = _relations.getNewRelationName();
relationTo = new IORelation(_compositeActor, relationName);
_interfaceRelationTable.put(interfaceTo, relationTo);
portTo.link(relationTo);
_Link link = new _Link(relationTo, portTo);
_linkList.add(link);
}
} else {
// This is a multi (parameterized) port, so we create
// a new relation, add it to the relation list of the
// interface, create a link and a _Link from the new
// relation to the port, and add the _Link to the list
// of links.
String relationName = _relations.getNewRelationName();
relationTo = new IORelation(_compositeActor, relationName);
if (_interfaceRelationTable.containsKey(interfaceTo)) {
// If the interface already has a relation list,
// add the new relation to the list.
Object o = _interfaceRelationTable.get(interfaceTo);
if (!(o instanceof ArrayList)) {
throw new InternalErrorException(
"Multiport should only be connected to an "
+ "ArrayList of Relation.");
}
ArrayList arrayList = (ArrayList) o;
arrayList.add(relationTo);
} else {
// If the interface does not already have a
// relation list, create it and add the new
// relation to the list.
ArrayList arrayList = new ArrayList();
arrayList.add(relationTo);
_interfaceRelationTable.put(interfaceTo, arrayList);
}
portTo.link(relationTo);
_Link link = new _Link(relationTo, portTo);
_linkList.add(link);
}
// Check for extra connections that might appear/disappear
// when translating from a nesC graph to a Ptolemy graph.
{
// If relationTo is connected to an input port to
// which relationFrom is not already connected, warn
// the user the extra connections will be formed.
List portListTo = ((IORelation) relationTo)
.linkedDestinationPortList((IOPort) portTo);
List portListFrom = ((IORelation) relationFrom)
.linkedDestinationPortList();
for (int i = 0; i < portListTo.size(); i++) {
Port tempPortTo = (Port) portListTo.get(i);
if (!portListFrom.contains(tempPortTo)) {
System.err.println("Warning: An extra link from "
+ portFrom.getContainer().getName() + "."
+ portFrom.getName() + " to "
+ tempPortTo.getContainer().getName() + "."
+ tempPortTo.getName() + " will be formed.");
}
}
}
{
// If relationTo is already connected to relationFrom,
// warn the user that this second connection will
// disappear in the current Ptolemy relation group
// implementation.
List portListTo = ((IORelation) relationTo)
.linkedDestinationPortList();
List portListFrom = ((IORelation) relationFrom)
.linkedDestinationPortList();
for (int i = 0; i < portListFrom.size(); i++) {
Port tempPortFrom = (Port) portListFrom.get(i);
if (portListTo.contains(tempPortFrom)) {
System.err.println("Warning: "
+ portFrom.getContainer().getName() + "."
+ portFrom.getName() + " is already connected to "
+ portTo.getContainer().getName() + "."
+ portTo.getName()
+ ". Additional links will be dropped.");
}
}
}
// Create link and a _Link from relationFrom to
// relationTo, and add the _Link to the list of links.
relationFrom.link(relationTo);
_Link link = new _Link(relationFrom, relationTo);
_linkList.add(link);
}
/** Create an IOPort that represents this interface.
*
* @param intf interface that represents IOPort to be created.
* @exception IllegalActionException If there is a problem creating
* the port.
* @exception NameDuplicationException If there is a problem creating
* the port.
*/
protected void createInterfaceIOPort(Xinterface intf)
throws IllegalActionException, NameDuplicationException {
if (!_interfaceIOPortTable.containsKey(intf)) {
if (!_componentActorTable.containsKey(intf.container)) {
throw new InternalErrorException(
"Could not find the actor associated with the "
+ "container of this interface.");
}
AtomicActor actor = (AtomicActor) _componentActorTable
.get(intf.container);
IOPort port;
// Check if this is an input port.
if (intf.provided) {
port = new IOPort(actor, intf.name, true, false);
} else {
port = new IOPort(actor, intf.name, false, true);
}
// Check if this is a multport.
if (intf.parameters != null) {
port.setMultiport(true);
}
_interfaceIOPortTable.put(intf, port);
}
}
/** Traverse the configuration wiring graph and set up the
* component and relation data structures.
* @exception IllegalActionException If there is a problem creating
* an interface IOport or connection.
* @exception NameDuplicationException If there is a problem creating
* an interface IOport or connection.
*/
protected void readLinks() throws IllegalActionException,
NameDuplicationException {
// Get the list of interfaces for this nesC component.
ListIterator interfaces = Xnesc.interfaceList.listIterator();
while (interfaces.hasNext()) {
// Get the next interface for this nesC component.
Xinterface interfaceFrom = (Xinterface) interfaces.next();
saveInterfaceContainer(interfaceFrom);
// Create IOPort for the From interface.
createInterfaceIOPort(interfaceFrom);
WiringNode checkNode = Xwiring.wg.lookup(interfaceFrom);
if (!interfaceFrom.provided) {
WiringScanForwards from = new WiringScanForwards(checkNode);
ListIterator out = from.edges();
WiringScan temp = null;
while (out.hasNext()) {
Xwire e = (Xwire) out.next();
temp = from.duplicate();
if (temp.follow(e)) {
if (temp.node.ep instanceof Xinterface) {
Xinterface interfaceTo = (Xinterface) temp.node.ep;
saveInterfaceContainer(interfaceTo);
// Create IOPort for the To interface.
createInterfaceIOPort(interfaceTo);
// Create link.
createConnection(interfaceFrom, interfaceTo);
} else {
System.err.println("Error: expected Xinterface in "
+ "link " + "from " + interfaceFrom + "to "
+ temp.node.ep);
}
}
}
}
}
}
/** Store the container of the interface (a component) and path to
* source file.
*
* @param intf interface of the component to be stored
* @exception IllegalActionException If there is a problem creating
* the atomic actor.
* @exception NameDuplicationException If there is a problem creating
* the atomic actor.
*/
protected void saveInterfaceContainer(Xinterface intf)
throws IllegalActionException, NameDuplicationException {
Xcomponent component = (Xcomponent) intf.container;
// Make sure the component has not already been stored.
if (!_componentFileTable.containsKey(component)
&& !_componentActorTable.containsKey(component)) {
// Store the location of the component file.
_ComponentFile componentFile = new _ComponentFile(component,
intf.location.filename);
_componentFileTable.put(component, componentFile);
// Create an actor to which to attach this component.
AtomicActor actor = new AtomicActor(_compositeActor, intf.container
.toString());
_componentActorTable.put(component, actor);
} else if (_componentFileTable.containsKey(component)
^ _componentActorTable.containsKey(component)) {
// ^ is XOR.
throw new InternalErrorException(
"The _componentFileTable and _componentActorTable do not "
+ "match. They should have dual entries for the "
+ "component.");
}
}
/** Class to store the file location of the specified component.
*/
static private class _ComponentFile {
_ComponentFile(Xcomponent component, String filename) {
_component = component;
_filename = filename;
}
/** Return the java-style path to the component source file.
*/
public String getClassName() {
// Example: /home/celaine/tinyos/tinyos/tinyos-1.x-scratch/tos/system/Main.nc
// Example: tos/system/Main.nc
String shortPath = _filename
.replaceFirst("^" + _ncSourcePrefix, "");
// Example: tos/system/Main.nc
shortPath = shortPath.replaceFirst("^" + "/", "");
// Example: tos/system/Main
shortPath = shortPath.replaceFirst(".nc" + "$", "");
// Example: tos.system.Main
String javaPath = shortPath.replace('/', '.');
return javaPath;
}
public String getName() {
return _component.toString();
}
public String toString() {
return _filename + ": " + _component;
}
String _filename;
Xcomponent _component;
}
/** Class to represent link between ports and relations.
*/
static private class _Link {
_Link(Object to, Object from) {
this.to = to;
this.from = from;
}
// Either a Port or a Relation.
public Object to;
// Either a Port or a Relation.
public Object from;
}
/** Class to create new relation names.
*/
static private class _Relations {
private int currentCount() {
return _relationCounter;
}
private String getNewRelationName() {
return "relation" + (++_relationCounter);
}
private int _relationCounter = 0;
}
/** File separator to use, currently "/". */
private static String _FILESEPARATOR = "/";
/** Name to add to items that use the Wireless wrapper. */
private static String _INWIRELESS = "-InWireless";
/** File prefix for .nc source files. */
private static String _ncSourcePrefix;
/** Contains (key, value) pairs of type (Xcomponent, _ComponentFile). */
private Hashtable _componentFileTable = new Hashtable();
/** Contains (key, value) pairs of type (Xcomponent, AtomicActor). */
private Hashtable _componentActorTable = new Hashtable();
/** CompositeActor to hold each AtomicActor that represents a nesC
* component.
*/
private CompositeActor _compositeActor = new CompositeActor();
/** Contains list of Links (links between ports/relations). */
private ArrayList _linkList = new ArrayList();
/** Contains (key, value) pairs of type (Xinterface,
* List(Relation)) if single port, or (Xinterface, Relation) if
* multi-port.
*/
private Hashtable _interfaceRelationTable = new Hashtable();
/** Contains (key, value) pairs of type (Xinterface, IOPort). */
private Hashtable _interfaceIOPortTable = new Hashtable();
/** Class to create new relation names. */
private _Relations _relations = new _Relations();
}