Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #63 and miscellaneous bugs. #66

Merged
merged 4 commits into from
Jan 3, 2015
Merged

Fixes #63 and miscellaneous bugs. #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5e8623
Add IsSearchable property to tokens.
JoshVarty Dec 31, 2014
f05e44b
Only index searchable items.
JoshVarty Dec 31, 2014
4e83fe5
New approach for finding symbols.
JoshVarty Dec 31, 2014
ab35462
Moved magic string delimeters to separate files.
JoshVarty Dec 31, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 49 additions & 55 deletions src/SourceBrowser.Generator/DocumentWalkers/CSWalker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
using SourceBrowser.Generator.Extensions;
using SourceBrowser.Generator.Model;
using SourceBrowser.Generator.Model.CSharp;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Microsoft.CodeAnalysis.FindSymbols;

namespace SourceBrowser.Generator.DocumentWalkers
{
Expand All @@ -23,7 +25,9 @@ public class CSWalker : CSharpSyntaxWalker, IWalker
public DocumentModel DocumentModel { get; private set; }
public string FilePath { get; set; }

public CSWalker(IProjectItem parent, Document document, ReferencesourceLinkProvider refSourceLinkProvider): base(SyntaxWalkerDepth.Trivia)
private Document _document;

public CSWalker(IProjectItem parent, Document document, ReferencesourceLinkProvider refSourceLinkProvider) : base(SyntaxWalkerDepth.Trivia)
{
_model = document.GetSemanticModelAsync().Result;
_refsourceLinkProvider = refSourceLinkProvider;
Expand All @@ -33,13 +37,13 @@ public CSWalker(IProjectItem parent, Document document, ReferencesourceLinkProvi
DocumentModel = new DocumentModel(parent, document.Name, numberOfLines);
FilePath = document.GetRelativeFilePath();
_refsourceLinkProvider = refSourceLinkProvider;
_document = document;
}

public override void VisitToken(SyntaxToken token)
{
string str = String.Empty;
Token tokenModel = null;

if (token.IsKeyword())
{
tokenModel = ProcessKeyword(token);
Expand All @@ -48,7 +52,7 @@ public override void VisitToken(SyntaxToken token)
{
tokenModel = ProcessIdentifier(token);
}
else if(token.CSharpKind() == SyntaxKind.StringLiteralToken)
else if (token.CSharpKind() == SyntaxKind.StringLiteralToken)
{
tokenModel = ProcessStringLiteral(token);
}
Expand Down Expand Up @@ -115,46 +119,17 @@ private Token ProcessStringLiteral(SyntaxToken token)
string value = token.ToString();
string type = CSharpTokenTypes.STRING;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);
return tokenModel;
}

/// <summary>
/// Given a syntax token identifier that represents a declaration,
/// generate and return the proper HTML for this symbol.
/// </summary>
public Token ProcessDeclarationToken(SyntaxToken token, ISymbol parentSymbol)
{
string fullName = parentSymbol.ToString();
string value = token.ToString();
string type = string.Empty;
bool isDeclaration = true;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;

if (parentSymbol is INamedTypeSymbol)
{
type = CSharpTokenTypes.TYPE;
}
else
{
type = CSharpTokenTypes.IDENTIFIER;
}

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber, isDeclaration);
return tokenModel;
}

/// <summary>
/// Given a syntax token identifier that represents a symbol's usage
/// generate and return the proper HTML for this symbol
/// </summary>
public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol)
public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol, bool isDeclaration)
{
string fullName = symbol.ToString();
string fullName = GetSymbolName(symbol);
string value = token.ToString();
string type = String.Empty;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;
bool isSearchable = isDeclaration;

if (symbol is INamedTypeSymbol)
{
Expand All @@ -164,13 +139,20 @@ public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol)
{
type = CSharpTokenTypes.IDENTIFIER;
}
var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);


//Do not allow us to search locals
if (symbol.Kind == SymbolKind.Local || symbol.Kind == SymbolKind.Parameter)
{
isSearchable = false;
}

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber, isDeclaration, isSearchable);

//If we can find the declaration, we'll link it ourselves
if (symbol.DeclaringSyntaxReferences.Any()
&& !(symbol is INamespaceSymbol))
{
var link = new SymbolLink(referencedSymbolName: symbol.ToString());
var link = new SymbolLink(referencedSymbolName: fullName);
tokenModel = tokenModel.WithLink(link);
}
//Otherwise, we try to link to the .Net Reference source
Expand All @@ -181,32 +163,44 @@ public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol)
tokenModel = tokenModel.WithLink(link);
}


return tokenModel;
}

private string GetSymbolName(ISymbol symbol)
{
string fullyQualifiedName;
if (symbol.Kind == SymbolKind.Parameter)
{
var containingName = symbol.ContainingSymbol.ToString();
fullyQualifiedName = containingName + CSharpDelimiters.PARAMETER + symbol.Name;
}
else if (symbol.Kind == SymbolKind.Local)
{
var containingName = symbol.ContainingSymbol.ToString();
fullyQualifiedName = containingName + CSharpDelimiters.LOCAL_VARIABLE + symbol.Name;
}
else
{
fullyQualifiedName = symbol.ToString();
}

return fullyQualifiedName;
}

public Token ProcessIdentifier(SyntaxToken token)
{
//Check if this token is part of a declaration
var parentSymbol = _model.GetDeclaredSymbol(token.Parent);
if (parentSymbol != null)
bool isDeclaration = false;
if (_model.GetDeclaredSymbol(token.Parent) != null)
{
if(parentSymbol.Kind == SymbolKind.Parameter)
{
parentSymbol = parentSymbol.ContainingSymbol;
}
return ProcessDeclarationToken(token, parentSymbol);
isDeclaration = true;
}

//Find the symbol this token references
var symbol = _model.GetSymbolInfo(token.Parent).Symbol;
var startPosition = token.GetLocation().SourceSpan.Start;
//Note: We're using the SymbolFinder as it correctly resolves
var symbol = SymbolFinder.FindSymbolAtPosition(_model, startPosition, _document.Project.Solution.Workspace);
if (symbol != null)
{
if(symbol.Kind == SymbolKind.Parameter)
{
symbol = symbol.ContainingSymbol;
}
return ProcessSymbolUsage(token, symbol) ;
return ProcessSymbolUsage(token, symbol, isDeclaration);
}

//Otherwise it references something we don't
Expand Down
98 changes: 46 additions & 52 deletions src/SourceBrowser.Generator/DocumentWalkers/VBWalker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
using SourceBrowser.Generator.Extensions;
using SourceBrowser.Generator.Model;
using SourceBrowser.Generator.Model.VisualBasic;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Microsoft.CodeAnalysis.FindSymbols;

namespace SourceBrowser.Generator.DocumentWalkers
{
Expand All @@ -23,7 +25,9 @@ public class VBWalker : VisualBasicSyntaxWalker, IWalker
public DocumentModel DocumentModel { get; private set; }
public string FilePath { get; set; }

public VBWalker(IProjectItem parent, Document document, ReferencesourceLinkProvider refSourceLinkProvider): base(SyntaxWalkerDepth.Trivia)
private Document _document;

public VBWalker(IProjectItem parent, Document document, ReferencesourceLinkProvider refSourceLinkProvider) : base(SyntaxWalkerDepth.Trivia)
{
_model = document.GetSemanticModelAsync().Result;
_refsourceLinkProvider = refSourceLinkProvider;
Expand All @@ -33,12 +37,13 @@ public VBWalker(IProjectItem parent, Document document, ReferencesourceLinkProvi
DocumentModel = new DocumentModel(parent, document.Name, numberOfLines);
FilePath = document.GetRelativeFilePath();
_refsourceLinkProvider = refSourceLinkProvider;
_document = document;
}

public override void VisitToken(SyntaxToken token)
{
Token tokenModel = null;

if (token.IsKeyword())
{
tokenModel = ProcessKeyword(token);
Expand All @@ -47,7 +52,7 @@ public override void VisitToken(SyntaxToken token)
{
tokenModel = ProcessIdentifier(token);
}
else if(token.VisualBasicKind() == SyntaxKind.StringLiteralToken)
else if (token.VisualBasicKind() == SyntaxKind.StringLiteralToken)
{
tokenModel = ProcessStringLiteral(token);
}
Expand Down Expand Up @@ -92,7 +97,6 @@ private Token ProcessOtherToken(SyntaxToken token)
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);

return tokenModel;
}

Expand All @@ -105,7 +109,6 @@ public Token ProcessKeyword(SyntaxToken token)
string value = token.ToString();
string type = VisualBasicTokenTypes.KEYWORD;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);
return tokenModel;
}
Expand All @@ -116,24 +119,19 @@ private Token ProcessStringLiteral(SyntaxToken token)
string value = token.ToString();
string type = VisualBasicTokenTypes.STRING;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);
return tokenModel;
}

/// <summary>
/// Given a syntax token identifier that represents a declaration,
/// generate and return the proper HTML for this symbol.
/// </summary>
public Token ProcessDeclarationToken(SyntaxToken token, ISymbol parentSymbol)
public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol, bool isDeclaration)
{
string fullName = parentSymbol.ToString();
string fullName = GetSymbolName(symbol);
string value = token.ToString();
string type = string.Empty;
string type = String.Empty;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;
bool isDeclaration = true;
bool isSearchable = isDeclaration;

if (parentSymbol is INamedTypeSymbol)
if (symbol is INamedTypeSymbol)
{
type = VisualBasicTokenTypes.TYPE;
}
Expand All @@ -142,36 +140,19 @@ public Token ProcessDeclarationToken(SyntaxToken token, ISymbol parentSymbol)
type = VisualBasicTokenTypes.IDENTIFIER;
}

var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber, isDeclaration);
return tokenModel;
}

/// <summary>
/// Given a syntax token identifier that represents a symbol's usage
/// generate and return the proper HTML for this symbol
/// </summary>
public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol)
{
string fullName = symbol.ToString();
string value = token.ToString();
string type = string.Empty;
int lineNumber = token.GetLocation().GetLineSpan().StartLinePosition.Line + 1;
if (symbol is INamedTypeSymbol)
//Do not allow us to search locals
if (symbol.Kind == SymbolKind.Local || symbol.Kind == SymbolKind.Parameter)
{
type = VisualBasicTokenTypes.TYPE;
isSearchable = false;
}
else
{
type = VisualBasicTokenTypes.IDENTIFIER;
}


var tokenModel = new Token(this.DocumentModel, fullName, value, type, lineNumber);

//If we can find the declaration, we'll link it ourselves
if (symbol.DeclaringSyntaxReferences.Any()
&& !(symbol is INamespaceSymbol))
{
var link = new SymbolLink(referencedSymbolName: symbol.ToString());
var link = new SymbolLink(referencedSymbolName: fullName);
tokenModel = tokenModel.WithLink(link);
}
//Otherwise, we try to link to the .Net Reference source
Expand All @@ -185,28 +166,41 @@ public Token ProcessSymbolUsage(SyntaxToken token, ISymbol symbol)
return tokenModel;
}

private string GetSymbolName(ISymbol symbol)
{
string fullyQualifiedName;
if (symbol.Kind == SymbolKind.Parameter)
{
var containingName = symbol.ContainingSymbol.ToString();
fullyQualifiedName = containingName + VBDelimiters.PARAMETER + symbol.Name;
}
else if (symbol.Kind == SymbolKind.Local)
{
var containingName = symbol.ContainingSymbol.ToString();
fullyQualifiedName = containingName + VBDelimiters.LOCAL_VARIABLE + symbol.Name;
}
else
{
fullyQualifiedName = symbol.ToString();
}

return fullyQualifiedName;
}

public Token ProcessIdentifier(SyntaxToken token)
{
//Check if this token is part of a declaration
var parentSymbol = _model.GetDeclaredSymbol(token.Parent);
if (parentSymbol != null)
bool isDeclaration = false;
if (_model.GetDeclaredSymbol(token.Parent) != null)
{
if (parentSymbol.Kind == SymbolKind.Parameter)
{
parentSymbol = parentSymbol.ContainingSymbol;
}
return ProcessDeclarationToken(token, parentSymbol);
isDeclaration = true;
}

//Find the symbol this token references
var symbol = _model.GetSymbolInfo(token.Parent).Symbol;
var startPosition = token.GetLocation().SourceSpan.Start;
//Note: We're using the SymbolFinder as it correctly resolves
var symbol = SymbolFinder.FindSymbolAtPosition(_model, startPosition, _document.Project.Solution.Workspace);
if (symbol != null)
{
if (symbol.Kind == SymbolKind.Parameter)
{
symbol = symbol.ContainingSymbol;
}
return ProcessSymbolUsage(token, symbol);
return ProcessSymbolUsage(token, symbol, isDeclaration);
}

//Otherwise it references something we don't
Expand Down
21 changes: 21 additions & 0 deletions src/SourceBrowser.Generator/Model/CSharp/CSharpDelimiters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SourceBrowser.Generator.Model.CSharp
{
/// <summary>
/// Fully qualified names do not contain enough information to differentiate
/// between some symbols. Occasionally we must extend C#'s fully qualified names
/// to refer to certain symbols.
///
/// Examples: Local variables, parameters, static constructors etc.
/// </summary>
public static class CSharpDelimiters
{
public const string LOCAL_VARIABLE = "::";
public const string PARAMETER = "::";
}
}
Loading