[PATCH] Rewrite of ProjectTemplate.cs

2009-06-26  Viktoria Dudka  <viktoriad@...>

        * MonoDevelop.Ide.Gui.Dialogs/NewProjectDialog.cs:
        * MonoDevelop.Ide.Templates/ProjectTemplate.cs: Rewritten from scratch
to make it non-GPL.


** I got the mail re: ProjectCommands.cs; we're still working on that
one. This one was tested extensively and I couldn't find any issues with it.



--
Carlo Kok

RemObjects Software
The Infrastructure Company
http://www.remobjects.com


Index: main/src/core/MonoDevelop.Ide/ChangeLog
===================================================================
--- main/src/core/MonoDevelop.Ide/ChangeLog (revision 136934)
+++ main/src/core/MonoDevelop.Ide/ChangeLog (working copy)
@@ -1,3 +1,8 @@
+2009-06-26  Viktoria Dudka  <viktoriad@...>
+
+ * MonoDevelop.Ide.Gui.Dialogs/NewProjectDialog.cs:
+ * MonoDevelop.Ide.Templates/ProjectTemplate.cs: Rewritten from scratch to make it non-GPL.
+
 2009-06-25  Lluis Sanchez Gual  <lluis@...>
 
  * MonoDevelop.Ide.Gui.Pads.ProjectPad/ProjectReferenceNodeBuilder.cs:
Index: main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Gui.Dialogs/NewProjectDialog.cs
===================================================================
--- main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Gui.Dialogs/NewProjectDialog.cs (revision 136934)
+++ main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Gui.Dialogs/NewProjectDialog.cs (working copy)
@@ -382,7 +382,7 @@
  IdeApp.ProjectOperations.Save (newItem);
 
  if (openSolution)
- selectedItem.OpenCreatedCombine();
+ selectedItem.OpenCreatedSolution();
  Respond (ResponseType.Ok);
  }
 
Index: main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Templates/ProjectTemplate.cs
===================================================================
--- main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Templates/ProjectTemplate.cs (revision 136934)
+++ main/src/core/MonoDevelop.Ide/MonoDevelop.Ide.Templates/ProjectTemplate.cs (working copy)
@@ -1,322 +1,303 @@
-//  ProjectTemplate.cs
-//
-//  This file was derived from a file from #Develop.
-//
-//  Copyright (C) 2001-2007 Mike Krüger <mkrueger@...>
-//
-//  This program 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 2 of the License, or
-//  (at your option) any later version.
-//
-//  This program 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 this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-using System;
-using System.IO;
-using System.Xml;
-using System.ComponentModel;
-using System.Collections;
-using System.Collections.Specialized;
-using System.Diagnostics;
-using System.Reflection;
-
-using MonoDevelop.Core;
-using MonoDevelop.Ide.Codons;
-using MonoDevelop.Core.Gui.Dialogs;
-using MonoDevelop.Ide.Gui;
-
-using Mono.Addins;
-using MonoDevelop.Core.Gui;
-using MonoDevelop.Projects;
-
-namespace MonoDevelop.Ide.Templates
-{
- internal class OpenFileAction
- {
- string fileName;
-
- public OpenFileAction(string fileName)
- {
- this.fileName = fileName;
- }
-
- public void Run(ProjectCreateInformation projectCreateInformation)
- {
- IdeApp.Workbench.OpenDocument (projectCreateInformation.ProjectBasePath + Path.DirectorySeparatorChar + fileName);
- }
- }
-
- /// <summary>
- /// This class defines and holds the new project templates.
- /// </summary>
- internal class ProjectTemplate
- {
- public static ArrayList ProjectTemplates = new ArrayList();
-
- string    id           = null;
- string    originator   = null;
- string    created      = null;
- string    lastmodified = null;
- string    name         = null;
- string    category     = null;
- string    languagename = null;
- string    description  = null;
- string    icon         = null;
- string    wizardpath   = null;
- ArrayList actions      = new ArrayList();
-
-
- CombineDescriptor combineDescriptor = null;
-
-#region Template Properties
- public string WizardPath {
- get {
- return wizardpath;
- }
- }
-
- public string Id {
- get { return id; }
- }
-
- public string Originator {
- get {
- return originator;
- }
- }
-
- public string Created {
- get {
- return created;
- }
- }
-
- public string LastModified {
- get {
- return lastmodified;
- }
- }
-
- public string Name {
- get {
- return name;
- }
- }
-
- public string Category {
- get {
- return category;
- }
- }
-
- public string LanguageName {
- get {
- return languagename;
- }
- }
-
- public string Description {
- get {
- return description;
- }
- }
-
- public string Icon {
- get {
- return icon;
- }
- }
-
- [Browsable(false)]
- public CombineDescriptor CombineDescriptor
- {
- get
- {
- return combineDescriptor;
- }
- }
-#endregion
-
- protected ProjectTemplate (RuntimeAddin addin, string id, ProjectTemplateCodon codon)
- {
- XmlDocument doc = codon.GetTemplate ();
-
- XmlElement config = doc.DocumentElement["TemplateConfiguration"];
-
- string category;
- if (config["_Category"] != null)
- category = addin.Localizer.GetString (config["_Category"].InnerText);
- else
- throw new InvalidOperationException ("Missing element '_Category' in file template: " + codon.Id);
-
- string languageElement  = (config["LanguageName"] == null)? null : config["LanguageName"].InnerText;
-
- //Find all of the languages that the template supports
- if (languageElement != null) {
- ArrayList templateLangs = new ArrayList ();
- foreach (string s in languageElement.Split (','))
- templateLangs.Add (s.Trim ());
- ExpandLanguageWildcards (templateLangs);
-
- //initialise this template (the first language)
- string language = (string) templateLangs [0];
-
- if (templateLangs.Count > 1)
- Initialise (addin, id, doc, language, language+"/"+category);
- else
- Initialise (addin, id, doc, language, category);
-
- //then add new templates for all other languages
- //Yes, creating more of the same type of object in the constructor is weird,
- //but it allows templates to specify multiple languages without changing the public API
- for (int i = 1; i < templateLangs.Count; i++) {
- try {
- language = (string) templateLangs [i];
- // per-language template instances should not share the XmlDocument
- ProjectTemplates.Add (new ProjectTemplate (addin, id, (XmlDocument) doc.Clone (), language, language+"/"+category));
- } catch (Exception e) {
- LoggingService.LogFatalError (GettextCatalog.GetString ("Error loading template {0}", codon.Id), e);
- }
- }
- } else {
- Initialise (addin, id, doc, null, category);
- }
- }
-
-
- private ProjectTemplate (RuntimeAddin addin, string id, XmlDocument doc, string languagename, string category)
- {
- Initialise (addin, id, doc, languagename, category);
- }
-
- private void Initialise (RuntimeAddin addin, string id, XmlDocument doc, string languagename, string category)
- {
- this.id = id;
-
- originator   = doc.DocumentElement.GetAttribute ("originator");
- created      = doc.DocumentElement.GetAttribute ("created");
- lastmodified = doc.DocumentElement.GetAttribute ("lastModified");
-
- XmlElement config = doc.DocumentElement["TemplateConfiguration"];
-
- if (config["Wizard"] != null) {
- wizardpath = config["Wizard"].InnerText;
- }
-
- this.name         = addin.Localizer.GetString (config["_Name"].InnerText);
- this.category     = category;
- this.languagename = languagename;
-
- if (config["_Description"] != null) {
- description  = addin.Localizer.GetString (config["_Description"].InnerText);
- }
-
- if (config["Icon"] != null) {
- icon = ImageService.GetStockId (addin, config["Icon"].InnerText);
- }
-
- if (doc.DocumentElement["Combine"] != null) {
- combineDescriptor = CombineDescriptor.CreateCombineDescriptor(doc.DocumentElement["Combine"]);
- } else {
- throw new InvalidOperationException ("Combine element not found");
- }
-
- // Read Actions;
- if (doc.DocumentElement["Actions"] != null) {
- foreach (XmlElement el in doc.DocumentElement["Actions"]) {
- actions.Add(new OpenFileAction(el.Attributes["filename"].InnerText));
- }
- }
- }
-
- void ExpandLanguageWildcards (ArrayList list)
- {
- //Template can match all CodeDom .NET languages with a "*"
- if (list.Contains ("*")) {
- foreach (ILanguageBinding lb in LanguageBindingService.LanguageBindings) {
- IDotNetLanguageBinding dnlang = lb as IDotNetLanguageBinding;
- if (dnlang != null && dnlang.GetCodeDomProvider () != null)
- list.Add (dnlang.Language);
- list.Remove ("*");
- }
- }
- }
-
- string lastCombine    = null;
- ProjectCreateInformation projectCreateInformation;
-
- public WorkspaceItem CreateWorkspaceItem (ProjectCreateInformation projectCreateInformation)
- {
- this.projectCreateInformation = projectCreateInformation;
- WorkspaceItem item = combineDescriptor.CreateEntry (projectCreateInformation, this.languagename);
- lastCombine = item.FileName;
- return item;
- }
-
- public SolutionEntityItem CreateProject (SolutionItem policyParent, ProjectCreateInformation projectCreateInformation)
- {
- this.projectCreateInformation = projectCreateInformation;
-
- // Create a project using the first child template of the combine template
-
- ISolutionItemDescriptor[] entries = combineDescriptor.EntryDescriptors;
- if (entries.Length == 0)
- throw new InvalidOperationException ("Combine template does not contain any project template");
-
- lastCombine = null;
- SolutionEntityItem it = entries[0].CreateItem (projectCreateInformation, this.languagename);
- entries[0].InitializeItem (policyParent, projectCreateInformation, this.languagename, it);
- return it;
- }
-
- public bool HasItemFeatures (SolutionFolder parentFolder, ProjectCreateInformation cinfo)
- {
- ISolutionItemDescriptor sid = combineDescriptor.EntryDescriptors [0];
- SolutionEntityItem sampleItem = sid.CreateItem (cinfo, languagename);
- return (SolutionItemFeatures.GetFeatures (parentFolder, sampleItem).Length > 0);
- }
-
- public void OpenCreatedCombine()
- {
- IAsyncOperation op = IdeApp.Workspace.OpenWorkspaceItem (lastCombine);
- op.WaitForCompleted ();
- if (op.Success) {
- foreach (OpenFileAction action in actions)
- action.Run(projectCreateInformation);
- }
- }
-
- static ProjectTemplate()
- {
- AddinManager.AddExtensionNodeHandler ("/MonoDevelop/Ide/ProjectTemplates", OnExtensionChanged);
- }
-
- static void OnExtensionChanged (object s, ExtensionNodeEventArgs args)
- {
- if (args.Change == ExtensionChange.Add) {
- ProjectTemplateCodon codon = (ProjectTemplateCodon) args.ExtensionNode;
- try {
- ProjectTemplates.Add (new ProjectTemplate (codon.Addin, codon.Id, codon));
- } catch (Exception e) {
- LoggingService.LogFatalError (e.ToString ());
- }
- }
- else {
- foreach (ProjectTemplate pt in ProjectTemplates) {
- ProjectTemplateCodon codon = (ProjectTemplateCodon) args.ExtensionNode;
- if (pt.Id == codon.Id) {
- ProjectTemplates.Remove (pt);
- break;
- }
- }
- }
- }
- }
-}
+// ProjectTemplate.cs
+//
+// Author:
+//   Mike Krüger (mkrueger@...)
+//   Lluis Sanchez Gual (lluis@...)
+//   Michael Hutchinson (mhutchinson@...)
+//   Marek Sieradzki (marek.sieradzki@...)
+//   Viktoria Dudka (viktoriad@...)
+//
+// Copyright (c) 2009 RemObjects Software
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+//
+
+using System;
+using System.IO;
+using System.Xml;
+using System.Collections;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Diagnostics;
+using System.Reflection;
+using System.CodeDom;
+using System.CodeDom.Compiler;
+
+using MonoDevelop.Core;
+using Mono.Addins;
+using MonoDevelop.Core.Gui;
+using MonoDevelop.Ide.Codons;
+using MonoDevelop.Projects;
+using MonoDevelop.Ide.Gui;
+using MonoDevelop.Projects.CodeGeneration;
+
+namespace MonoDevelop.Ide.Templates
+{
+ internal class ProjectTemplate
+ {
+ public static List<ProjectTemplate> ProjectTemplates = new List<ProjectTemplate> ();
+
+ private List<string> actions = new List<string> ();
+
+ private string createdSolutionName;
+ private ProjectCreateInformation createdProjectInformation = null;
+
+ private CombineDescriptor solutionDescriptor = null;
+ public CombineDescriptor CombineDescriptor
+ {
+ get { return solutionDescriptor; }
+ }
+
+ private string languagename;
+ public string LanguageName
+ {
+ get { return languagename; }
+ }
+
+ private string id;
+ public string Id
+ {
+ get { return id; }
+ }
+
+ private string category;
+ public string Category
+ {
+ get { return category; }
+ }
+
+ private string icon;
+ public string Icon
+ {
+ get { return icon; }
+ }
+
+ private string description;
+ public string Description
+ {
+ get { return description; }
+ }
+
+ private string name;
+ public string Name
+ {
+ get { return name; }
+ }
+
+ private string originator;
+ public string Originator
+ {
+ get { return originator; }
+ }
+
+ private string created;
+ public string Created
+ {
+ get { return created; }
+ }
+
+ private string lastModified;
+ public string LastModified
+ {
+ get { return lastModified; }
+ }
+
+ private string wizardPath;
+ public string WizardPath
+ {
+ get { return wizardPath; }
+ }
+
+
+
+ //constructors
+ static ProjectTemplate ()
+ {
+ AddinManager.AddExtensionNodeHandler ("/MonoDevelop/Ide/ProjectTemplates", OnExtensionChanged);
+ }
+
+ protected ProjectTemplate (RuntimeAddin addin, string id, ProjectTemplateCodon codon, string overrideLanguage)
+ {
+ XmlDocument xmlDocument = codon.GetTemplate ();
+
+ XmlElement xmlConfiguration = xmlDocument.DocumentElement ["TemplateConfiguration"];
+
+ if (xmlConfiguration ["_Category"] != null) {
+ category = addin.Localizer.GetString (xmlConfiguration ["_Category"].InnerText);
+ }
+ else
+ throw new InvalidOperationException (string.Format ("_Category missing in file template {0}", codon.Id));
+
+
+ if (!string.IsNullOrEmpty (overrideLanguage)) {
+ this.languagename = overrideLanguage;
+ this.category = overrideLanguage + "/" + this.category;
+ }
+ else if (xmlConfiguration ["LanguageName"] != null) {
+
+ ArrayList listLanguages = new ArrayList ();
+ foreach (string item in xmlConfiguration ["LanguageName"].InnerText.Split (','))
+ listLanguages.Add (item.Trim ());
+
+ ExpandLanguageWildcards (listLanguages);
+
+ this.languagename = (string) listLanguages [0];
+
+ int i = 0;
+ foreach (string language in listLanguages) {
+ try {
+ if (i != 0) {
+ ProjectTemplates.Add (new ProjectTemplate (addin, id, codon, (string) listLanguages [i]));
+ }
+ }
+ catch (Exception e) {
+ LoggingService.LogFatalError (GettextCatalog.GetString ("Error loading template {0}", codon.Id), e);
+ }
+
+ i++;
+
+ }
+
+ }
+
+ this.id = id;
+
+ this.originator = xmlDocument.DocumentElement.GetAttribute ("originator");
+ this.created = xmlDocument.DocumentElement.GetAttribute ("created");
+ this.lastModified = xmlDocument.DocumentElement.GetAttribute ("lastModified");
+
+ if (xmlConfiguration ["Wizard"] != null) {
+ this.wizardPath = xmlConfiguration ["Wizard"].InnerText;
+ }
+
+ if (xmlConfiguration ["_Name"] != null) {
+ this.name = addin.Localizer.GetString (xmlConfiguration ["_Name"].InnerText);
+ }
+
+ if (xmlConfiguration ["_Description"] != null) {
+ this.description = addin.Localizer.GetString (xmlConfiguration ["_Description"].InnerText);
+ }
+
+ if (xmlConfiguration ["Icon"] != null) {
+ this.icon = ImageService.GetStockId (addin, xmlConfiguration ["Icon"].InnerText);
+ }
+
+ if (xmlDocument.DocumentElement ["Combine"] == null) {
+ throw new InvalidOperationException ();
+ }
+ else {
+ solutionDescriptor = CombineDescriptor.CreateCombineDescriptor (xmlDocument.DocumentElement ["Combine"]);
+ }
+
+ if (xmlDocument.DocumentElement ["Actions"] != null) {
+ foreach (XmlNode xmlElement in xmlDocument.DocumentElement ["Actions"]) {
+ if (xmlElement is XmlElement && xmlElement.Attributes ["filename"] != null)
+ actions.Add (xmlElement.Attributes ["filename"].Value);
+ }
+ }
+ }
+
+ protected ProjectTemplate (RuntimeAddin addin, string id, ProjectTemplateCodon codon)
+ : this (addin, id, codon, null)
+ {
+ }
+
+ //methods
+ public void OpenCreatedSolution ()
+ {
+ IAsyncOperation asyncOperation = IdeApp.Workspace.OpenWorkspaceItem (createdSolutionName);
+ asyncOperation.WaitForCompleted ();
+
+ if (asyncOperation.Success) {
+ foreach (string action in actions) {
+ IdeApp.Workbench.OpenDocument (Path.Combine (createdProjectInformation.ProjectBasePath, action));
+ }
+ }
+ }
+
+ public WorkspaceItem CreateWorkspaceItem (ProjectCreateInformation cInfo)
+ {
+ WorkspaceItem workspaceItem = solutionDescriptor.CreateEntry (cInfo, this.languagename);
+
+ this.createdSolutionName = workspaceItem.FileName;
+ this.createdProjectInformation = cInfo;
+
+ return workspaceItem;
+ }
+
+ public SolutionEntityItem CreateProject (SolutionItem policyParent, ProjectCreateInformation cInfo)
+ {
+ if (solutionDescriptor.EntryDescriptors.Length == 0)
+ throw new InvalidOperationException ("Solution template doesn't have any project templates");
+
+ SolutionEntityItem solutionEntryItem = solutionDescriptor.EntryDescriptors [0].CreateItem (cInfo, this.languagename);
+ solutionDescriptor.EntryDescriptors [0].InitializeItem (policyParent, cInfo, this.languagename, solutionEntryItem);
+
+
+ this.createdProjectInformation = cInfo;
+
+
+ return solutionEntryItem;
+ }
+
+ static void OnExtensionChanged (object s, ExtensionNodeEventArgs args)
+ {
+ if (args.Change == ExtensionChange.Add) {
+ ProjectTemplateCodon codon = (ProjectTemplateCodon) args.ExtensionNode;
+ try {
+ ProjectTemplates.Add (new ProjectTemplate (codon.Addin, codon.Id, codon, null));
+ }
+ catch (Exception e) {
+ LoggingService.LogFatalError (e.ToString ());
+ }
+ }
+ else {
+ foreach (ProjectTemplate pt in ProjectTemplates) {
+ ProjectTemplateCodon codon = (ProjectTemplateCodon) args.ExtensionNode;
+ if (pt.Id == codon.Id) {
+ ProjectTemplates.Remove (pt);
+ break;
+ }
+ }
+ }
+ }
+
+ void ExpandLanguageWildcards (ArrayList list)
+ {
+ //Template can match all CodeDom .NET languages with a "*"
+ if (list.Contains ("*")) {
+ foreach (ILanguageBinding lb in LanguageBindingService.LanguageBindings) {
+ IDotNetLanguageBinding dnlang = lb as IDotNetLanguageBinding;
+ if (dnlang != null && dnlang.GetCodeDomProvider () != null)
+ list.Add (dnlang.Language);
+ list.Remove ("*");
+ }
+ }
+ }
+
+ public bool HasItemFeatures (SolutionFolder parentFolder, ProjectCreateInformation cinfo)
+ {
+ ISolutionItemDescriptor sid = solutionDescriptor.EntryDescriptors [0];
+ SolutionEntityItem sampleItem = sid.CreateItem (cinfo, languagename);
+ return (SolutionItemFeatures.GetFeatures (parentFolder, sampleItem).Length > 0);
+ }
+
+ }
+}

_______________________________________________
Monodevelop-list mailing list
Monodevelop-list@...
http://lists.ximian.com/mailman/listinfo/monodevelop-list