/// <summary>
/// Promotes objects to template library.
/// Items can be promoted when the active context is CircuitEditingContext and all the items are selected modules.</summary>
/// <param name="items">Items to promote</param>
public override void PromoteToTemplateLibrary(IEnumerable <object> items)
{
var itemsArray = items.ToArray();
// cache the external connections
var externalConnectionsDict = new Dictionary <Element, List <Wire> >();
var circuitEditingContext = ContextRegistry.GetActiveContext <CircuitEditingContext>();
var graphContainer = circuitEditingContext.CircuitContainer;
foreach (var item in itemsArray)
{
var modules = new HashSet <Element>();
var internalConnections = new List <Wire>();
var externalConnections = new List <Wire>();
CircuitUtil.GetSubGraph(graphContainer, new[] { item }, modules, internalConnections, externalConnections, externalConnections);
externalConnectionsDict.Add(item.Cast <Element>(), externalConnections);
}
// check source guid for templates to be replaced
var templatingItems = new List <object>();
var replacingItems = new List <object>();
foreach (var item in itemsArray)
{
if (item.Is <Module>())
{
var module = item.Cast <Module>();
if (module.SourceGuid != Guid.Empty)
{
var existingTemplate = TemplatingContext.SearchForTemplateByGuid(TemplatingContext.RootFolder, module.SourceGuid);
if (existingTemplate != null)
{
string message = string.Format(
"Overwrite the existing \"{0}\" Template with \"{1}\", or Add new one?\n".Localize(),
existingTemplate.Name, module.Name);
var dialog = new ConfirmationDialog("Overwrite / Add".Localize(), message);
dialog.YesButtonText = "Overwrite".Localize();
dialog.NoButtonText = "Add".Localize();
dialog.Size = new System.Drawing.Size(300, 100);
DialogResult result = dialog.ShowDialog();
if (result == DialogResult.Yes)
{
TemplatingContext.ReplaceTemplateModel(existingTemplate, module.Cast <DomNode>());
replacingItems.Add(item);
}
else if (result == DialogResult.No)
{
templatingItems.Add(item);
}
//otherwise the item is skipped
}
}
else
{
templatingItems.Add(item);
}
}
}
// pack objects in IDataObject format
var dataObject = new DataObject();
dataObject.SetData(typeof(object[]), templatingItems.ToArray());
// Insert() expects IDataObject
TemplatingContext.Insert(dataObject);
// replace the original items with the template instances
foreach (var originalItem in templatingItems.Concat(replacingItems))
{
var template = TemplatingContext.LastPromoted(originalItem);
var instance = TemplatingContext.CreateReference(template);
var originalModule = originalItem.Cast <Element>();
var replacedModule = instance.Cast <Element>();
replacedModule.Bounds = originalModule.Bounds;
replacedModule.Position = originalModule.Position;
// reroute external connections from original modules to replaced template instances.
var externalConnections = externalConnectionsDict[originalModule];
foreach (var connection in externalConnections)
{
if (connection.InputElement.DomNode == originalModule.DomNode)
{
// input pin, i.e. pin on element that receives connection as input
int pinIndex = connection.InputPin.Index;
connection.InputPin = replacedModule.Type.Inputs[pinIndex];
connection.InputElement = replacedModule;
connection.InputPinTarget = null; // reset
}
else if (connection.OutputElement.DomNode == originalModule.DomNode) //output pin, i.e., pin on element that receives connection as output
{
connection.OutputPin = replacedModule.Type.Outputs[connection.OutputPin.Index];
connection.OutputElement = replacedModule;
connection.OutputPinTarget = null;
}
else
{
Debug.Assert(false);
}
}
circuitEditingContext.CircuitContainer.Elements.Remove(originalItem.Cast <Element>());
circuitEditingContext.CircuitContainer.Elements.Add(replacedModule);
}
}
/// <summary>
/// Demotes items from reference instances to copy instances.
/// Items can be demoted when the active context is CircuitEditingContext and
/// all the items are selected references.</summary>
/// <param name="items">Items to demote</param>
/// <returns>Array of copy instances</returns>
public override DomNode[] DemoteToCopyInstance(IEnumerable <object> items)
{
// cache the external connections
var externalConnectionsDict = new Dictionary <Element, List <Wire> >();
var graphContainer = items.First().Cast <DomNode>().Parent.Cast <ICircuitContainer>();
var modules = new HashSet <Element>();
var internalConnections = new List <Wire>();
var externalConnections = new List <Wire>();
foreach (var item in items)
{
CircuitUtil.GetSubGraph(graphContainer, new[] { item }, modules, internalConnections, externalConnections, externalConnections);
externalConnectionsDict.Add(item.Cast <Element>(), externalConnections);
}
var originalRefs = items.Select(x => x.Cast <DomNode>()).ToArray();
var domNodes = items.Select(x => x.Cast <IReference <Module> >().Target.DomNode).ToArray();
var itemCopies = DomNode.Copy(domNodes); // DOM deep copy
// Position and Expanded properties copy from the referencing nodes
for (int i = 0; i < itemCopies.Length; ++i)
{
var copy = itemCopies[i];
copy.Cast <Module>().Bounds = originalRefs[i].Cast <Module>().Bounds;
copy.Cast <Module>().Position = originalRefs[i].Cast <Module>().Position;
copy.Cast <Module>().SourceGuid = originalRefs[i].Cast <Module>().SourceGuid;
if (originalRefs[i].Is <GroupInstance>())
{
copy.Cast <Group>().Expanded = originalRefs[i].Cast <GroupInstance>().Expanded;
}
// reroute external connections from original modules to replaced template instances.
externalConnections = externalConnectionsDict[originalRefs[i].Cast <Module>()];
foreach (var connection in externalConnections)
{
if (connection.InputElement.DomNode == originalRefs[i])
{
// input pin, i.e. pin on element that receives connection as input
int pinIndex = connection.InputPin.Index;
connection.InputPin = copy.Cast <Module>().Type.Inputs[pinIndex];
connection.InputElement = copy.Cast <Module>();
connection.InputPinTarget = null; // reset
}
else if (connection.OutputElement.DomNode == originalRefs[i]) //output pin, i.e., pin on element that receives connection as output
{
connection.OutputPin = copy.Cast <Module>().Type.Outputs[connection.OutputPin.Index];
connection.OutputElement = copy.Cast <Module>();
connection.OutputPinTarget = null;
}
else
{
Debug.Assert(false);
}
}
graphContainer.Elements.Remove(originalRefs[i].Cast <Element>());
graphContainer.Elements.Add(copy.Cast <Element>());
}
return(itemCopies);
}
