Changeset 11804 for branches/CodeEditor/HeuristicLab.CodeEditor/3.4

Timestamp:

01/20/15 17:35:50 (9 years ago)

Author:

jkarder

Message:

#2077:

• added fancy xml documentation
• fixed configurations and plattforms

Location:

branches/CodeEditor/HeuristicLab.CodeEditor/3.4

Files:

• CodeEditor.cs (modified) (2 diffs)
• HeuristicLab.CodeEditor-3.4.csproj (modified) (2 diffs)
• LanguageFeatures/CodeCompletion/CSharp/CSharpDocumentationBuilder.cs (added)
• LanguageFeatures/CodeCompletion/CSharp/CSharpInsightItem.cs (modified) (4 diffs)
• LanguageFeatures/CodeCompletion/CSharp/CompletionData/CodeCompletionData.cs (modified) (2 diffs)
• LanguageFeatures/CodeCompletion/CSharp/CompletionData/EntityCompletionData.cs (modified) (2 diffs)

branches/CodeEditor/HeuristicLab.CodeEditor/3.4/CodeEditor.cs

@@ -34 +34 @@
 using ICSharpCode.AvalonEdit.Editing;
 using ICSharpCode.AvalonEdit.Highlighting;
+using ICSharpCode.AvalonEdit.Indentation.CSharp;
 using ICSharpCode.AvalonEdit.Search;
 using ICSharpCode.NRefactory.Editor;
@@ -240 +241 @@
       TextEditor.FontSize = DefaultTextEditorFontSize;
       TextEditor.Options.EnableVirtualSpace = true;
+      TextEditor.TextArea.IndentationStrategy = new CSharpIndentationStrategy(TextEditor.Options);
 
       TextEditor.TextChanged += (sender, args) => {

branches/CodeEditor/HeuristicLab.CodeEditor/3.4/HeuristicLab.CodeEditor-3.4.csproj

@@ -105 +105 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\bin\ICSharpCode.NRefactory.CSharp.dll</HintPath>
+      <Private>False</Private>
+    </Reference>
+    <Reference Include="ICSharpCode.NRefactory.Xml, Version=5.0.0.0, Culture=neutral, PublicKeyToken=ba48961d6f65dcec, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\bin\ICSharpCode.NRefactory.Xml.dll</HintPath>
       <Private>False</Private>
     </Reference>
@@ -148 +153 @@
     <Compile Include="LanguageFeatures\CodeCompletion\CSharp\CompletionData\CodeCompletionData.cs" />
     <Compile Include="LanguageFeatures\CodeCompletion\CSharp\CSharpCodeCompletionStrategy.cs" />
+    <Compile Include="LanguageFeatures\CodeCompletion\CSharp\CSharpDocumentationBuilder.cs" />
     <Compile Include="LanguageFeatures\CodeCompletion\CSharp\CSharpCodeCompletionContext.cs" />
     <Compile Include="LanguageFeatures\CodeCompletion\CSharp\CSharpCodeCompletionDataFactory.cs" />

branches/CodeEditor/HeuristicLab.CodeEditor/3.4/LanguageFeatures/CodeCompletion/CSharp/CSharpInsightItem.cs

@@ -1 +1 @@
 #region License Information
-// CShell, A Simple C# Scripting IDE
-// Copyright (C) 2013  Arnova Asset Management Ltd., Lukas Buhler
+// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
 // 
-// 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 3 of the License, or
-// (at your option) any later version.
+// 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:
 // 
-// 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.
+// The above copyright notice and this permission notice shall be included in all copies or
+// substantial portions of the Software.
 // 
-// You should have received a copy of the GNU General Public License
-// along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-// This file is based on code from the SharpDevelop project:
-//   Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \Doc\sharpdevelop-copyright.txt)
-//   This code is distributed under the GNU LGPL (for details please see \Doc\COPYING.LESSER.txt)
+// 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.
 
 /* HeuristicLab
- * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
  *
  * This file is part of HeuristicLab.
@@ -44 +42 @@
 using System.Windows;
 using System.Windows.Controls;
-using ICSharpCode.AvalonEdit.Highlighting;
 using ICSharpCode.NRefactory.CSharp;
-using ICSharpCode.NRefactory.Editor;
 using ICSharpCode.NRefactory.TypeSystem;
+using ICSharpCode.NRefactory.Xml;
 
 namespace HeuristicLab.CodeEditor {
-  internal sealed class CSharpInsightItem {
+  sealed class CSharpInsightItem {
     public readonly IParameterizedMember Method;
 
@@ -57 +54 @@
     }
 
-    TextBlock header;
+    FlowDocumentScrollViewer header;
 
     public object Header {
       get {
         if (header == null) {
-          header = new TextBlock();
-          GenerateHeader();
+          header = GenerateHeader();
         }
         return header;
@@ -76 +72 @@
       this.highlightedParameterIndex = parameterIndex;
       if (header != null)
-        GenerateHeader();
+        header = GenerateHeader();
     }
 
-    void GenerateHeader() {
-      var ambience = new CSharpAmbience { ConversionFlags = ConversionFlags.StandardConversionFlags };
+    FlowDocumentScrollViewer GenerateHeader() {
+      var ambience = new CSharpAmbience();
+      ambience.ConversionFlags = ConversionFlags.StandardConversionFlags;
       var stringBuilder = new StringBuilder();
       var formatter = new ParameterHighlightingOutputFormatter(stringBuilder, highlightedParameterIndex);
       ambience.ConvertSymbol(Method, formatter, FormattingOptionsFactory.CreateSharpDevelop());
-      var textSource = new StringTextSource(stringBuilder.ToString());
-      var richTextModel = new RichTextModel();
-      richTextModel.SetFontWeight(formatter.parameterStartOffset, formatter.parameterLength, FontWeights.Bold);
-      header.Inlines.Clear();
-      header.Inlines.AddRange(richTextModel.CreateRuns(textSource));
+
+      var documentation = XmlDocumentationElement.Get(Method);
+      ambience.ConversionFlags = ConversionFlags.ShowTypeParameterList;
+
+      var b = new CSharpDocumentationBuilder(ambience);
+      string parameterName = null;
+      if (Method.Parameters.Count > highlightedParameterIndex)
+        parameterName = Method.Parameters[highlightedParameterIndex].Name;
+      b.AddSignatureBlock(stringBuilder.ToString(), formatter.parameterStartOffset, formatter.parameterLength, parameterName);
+
+      var b2 = new CSharpDocumentationBuilder(ambience);
+      b2.ParameterName = parameterName;
+      b2.ShowAllParameters = false;
+
+      if (documentation != null) {
+        foreach (var child in documentation.Children) {
+          b2.AddDocumentationElement(child);
+        }
+      }
+
+      content = new FlowDocumentScrollViewer {
+        Document = b2.CreateFlowDocument(),
+        VerticalScrollBarVisibility = ScrollBarVisibility.Auto
+      };
+
+      var flowDocument = b.CreateFlowDocument();
+      flowDocument.PagePadding = new Thickness(0); // default is NOT Thickness(0), but Thickness(Auto), which adds unnecessary space
+
+      return new FlowDocumentScrollViewer {
+        Document = flowDocument,
+        VerticalScrollBarVisibility = ScrollBarVisibility.Auto
+      };
     }
 
+    FlowDocumentScrollViewer content;
+
     public object Content {
-      get { return Documentation; }
-    }
-
-    private string documentation;
-    public string Documentation {
       get {
-        if (documentation == null) {
-          if (Method.Documentation == null)
-            documentation = string.Empty;
-          else
-            documentation = EntityCompletionData.XmlDocumentationToText(Method.Documentation);
+        if (content == null) {
+          GenerateHeader();
         }
-        return documentation;
+        return content;
       }
     }

branches/CodeEditor/HeuristicLab.CodeEditor/3.4/LanguageFeatures/CodeCompletion/CSharp/CompletionData/CodeCompletionData.cs

@@ -64 +64 @@
     #region ICSharpCode.AvalonEdit.CodeCompletion.ICompletionData Members
     public object Content { get { return DisplayText; } }
-    object ACC.ICompletionData.Description { get { return Description; } }
+
+    object fancyDescription;
+    object ACC.ICompletionData.Description {
+      get {
+        if (fancyDescription == null) {
+          fancyDescription = CreateFancyDescription();
+        }
+        return fancyDescription;
+      }
+    }
+
     public virtual ImageSource Image { get; set; }
     public double Priority { get; set; }
@@ -73 +83 @@
     }
     #endregion
+
+    protected virtual object CreateFancyDescription() {
+      return Description;
+    }
   }
 }

branches/CodeEditor/HeuristicLab.CodeEditor/3.4/LanguageFeatures/CodeCompletion/CSharp/CompletionData/EntityCompletionData.cs

@@ -21 +21 @@
 
 using System;
-using System.IO;
-using System.Linq;
-using System.Text;
-using System.Xml;
+using System.Windows;
+using System.Windows.Controls;
 using ICSharpCode.AvalonEdit.CodeCompletion;
 using ICSharpCode.NRefactory.Completion;
 using ICSharpCode.NRefactory.CSharp;
 using ICSharpCode.NRefactory.TypeSystem;
+using ICSharpCode.NRefactory.Xml;
 
 namespace HeuristicLab.CodeEditor {
@@ -48 +47 @@
     }
 
-    private string description;
-    public override string Description {
-      get {
-        if (string.IsNullOrEmpty(description)) {
-          description = GetText(Entity);
-          if (HasOverloads)
-            description += string.Format(" (+{0} overloads)", OverloadedData.Count());
-          description += Environment.NewLine + XmlDocumentationToText(Entity.Documentation);
+    protected override object CreateFancyDescription() {
+      var ambience = new CSharpAmbience();
+      ambience.ConversionFlags = ConversionFlags.StandardConversionFlags | ConversionFlags.ShowDeclaringType;
+      string header = ambience.ConvertSymbol(Entity);
+      var documentation = XmlDocumentationElement.Get(Entity);
+
+      ambience.ConversionFlags = ConversionFlags.ShowTypeParameterList;
+      var b = new CSharpDocumentationBuilder(ambience);
+      b.AddCodeBlock(header, keepLargeMargin: true);
+      if (documentation != null) {
+        foreach (var child in documentation.Children) {
+          b.AddDocumentationElement(child);
         }
-        return description;
       }
-      set { description = value; }
+
+      var flowDocument = b.CreateFlowDocument();
+      flowDocument.PagePadding = new Thickness(0); // default is NOT Thickness(0), but Thickness(Auto), which adds unnecessary space
+
+      return new FlowDocumentScrollViewer {
+        Document = flowDocument,
+        VerticalScrollBarVisibility = ScrollBarVisibility.Auto
+      };
     }
-
-    public static string XmlDocumentationToText(string xmlDoc) {
-      System.Diagnostics.Debug.WriteLine(xmlDoc);
-      var b = new StringBuilder();
-      try {
-        using (var reader = new XmlTextReader(new StringReader("<root>" + xmlDoc + "</root>"))) {
-          reader.XmlResolver = null;
-          while (reader.Read()) {
-            switch (reader.NodeType) {
-              case XmlNodeType.Text:
-                b.Append(reader.Value);
-                break;
-              case XmlNodeType.Element:
-                switch (reader.Name) {
-                  case "filterpriority":
-                    reader.Skip();
-                    break;
-                  case "returns":
-                    b.AppendLine();
-                    b.Append("Returns: ");
-                    break;
-                  case "param":
-                    b.AppendLine();
-                    b.Append(reader.GetAttribute("name") + ": ");
-                    break;
-                  case "remarks":
-                    b.AppendLine();
-                    b.Append("Remarks: ");
-                    break;
-                  case "see":
-                    if (reader.IsEmptyElement) {
-                      b.Append(reader.GetAttribute("cref"));
-                    } else {
-                      reader.MoveToContent();
-                      if (reader.HasValue) {
-                        b.Append(reader.Value);
-                      } else {
-                        b.Append(reader.GetAttribute("cref"));
-                      }
-                    }
-                    break;
-                }
-                break;
-            }
-          }
-        }
-        return b.ToString();
-      } catch (XmlException) {
-        return xmlDoc;
-      }
-    }
-
-    #region Helpers
-    private static string GetText(IEntity entity) {
-      Ambience.ConversionFlags = ConversionFlags.StandardConversionFlags;
-      if (entity is ITypeDefinition) Ambience.ConversionFlags |= ConversionFlags.UseFullyQualifiedEntityNames;
-      if (entity is IMethod) {
-        var reducedForm = ((IMethod)entity).ReducedFrom;
-        if (reducedForm != null) entity = reducedForm;
-      }
-      return Ambience.ConvertSymbol(entity);
-    }
-    #endregion
   }
 }