"ArgumentException: Syntax node is not within Syntax tree" when using semantic model in roslyn

Question

I am using Roslyn to gather all the invocations of methods in a method and replace them with shims in the corresponding test method for the method. The problem is that in spite of initializing the compilation object appropriately with all the references and syntax trees of the project, it throws an ArgumentException which says "Syntax node is not within Syntax tree".

This is the code that I have used to initialize the semantic model:

   public TestMethodCodeGenerator(string code, Project project = null)
    {
        if (!string.IsNullOrWhiteSpace(code))
        {
            var syntaxTree = CSharpSyntaxTree.ParseText(code);

            if (null != project)
            {
                var syntaxTreesOfDocumentsInProject = new List<SyntaxTree>();
                foreach (var document in project.Documents)
                {
                    syntaxTreesOfDocumentsInProject.Add(CSharpSyntaxTree.ParseFile(document.FilePath));
                }

                var compilation = CSharpCompilation.Create("Demo").AddReferences(project.MetadataReferences).AddSyntaxTrees(syntaxTreesOfDocumentsInProject);
                this.semanticModel = compilation.GetSemanticModel(syntaxTreesOfDocumentsInProject[0]);
                }
            }
            else 
            {                
                var compilation = CSharpCompilation.Create("Demo").AddSyntaxTrees(syntaxTree);
                this.semanticModel = compilation.GetSemanticModel(syntaxTree);
            }
        }
    }

This is how I have used the semanticModel to generate shims for all invocations:

private string PopulateMethodBodyWithShims(MethodDeclarationSyntax methodDeclarationSyntax)
    {
        if (null != methodDeclarationSyntax)
        {
            var stringBuilder = new StringBuilder();
            var methodBlock = methodDeclarationSyntax.Body;
            foreach (var statement in methodBlock.Statements)
            {
                var invocationSyntax = this.ExtractMethodInvocationSyntaxFromStatement(statement);
                if (null != invocationSyntax)
                {
                    var call = invocationSyntax.Expression as MemberAccessExpressionSyntax;
                    if (null != call)
                    {
                        try
                        {
                            IMethodSymbol methodSymbol;
                            **methodSymbol = this.semanticModel.GetSymbolInfo(call).Symbol as IMethodSymbol;**
                            if (null != methodSymbol)
                            {
                                var shimMethod = this.GenerateShimMethod(methodSymbol);
                                stringBuilder.AppendLine(GeneratedTestClassConstants.IndentationSpaceToken + GeneratedTestClassConstants.IndentationSpaceToken + shimMethod);
                            }
                        }
                        catch (ArgumentException ex)
                        {
                            ////This exception can be thrown if the syntax node is not within the syntax tree
                            var message = ex.Message;
                            throw new ArgumentException(message + " : " + call);
                        }                           
                    }
                }
            }
.
.
.

The highlighted region in the second code snippet is where the exception occurs and execution flows to the catch block. What is the issue and what am I missing here?

Kevin Pilch · Accepted Answer · 2015-01-03 22:56:32Z

1

Why are you parsing your own files and constructing your own compilation? If you already have a Workspace with a Solution, Projects and Documents, you can just use document.GetSyntaxTreeAsync(), document.GetSemanticModelAsync(), and document.Project.GetCompilationAsync() to get at these.

You seem to be adding in a syntax tree for some new code you have, but you could do that by adding that syntax tree and getting a new Project. e.g.

project = project.AddDocument("generatedfile", code).Project;

Anyway, I suspect that the problem with your code as stated is that the semantic model you store is the one that corresponds to the first syntax tree you in syntaxTreesOfDocuments, but you never add syntaxTree (the tree for the code string you have) to that list, and therefore it's not part of the compilation, and definitely isn't the tree that the SemanticModel operates on.

answered Jan 3, 2015 at 22:56

Kevin Pilch

11.7k1 gold badge42 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

ace_racer Over a year ago

I get the first point in your answer and will incorporate it. However, with regards to the third point (where you have mentioned the issue in my code), I have obtained the semantic model for the code that is part of the compilation always. In the if clause, I have obtained the compilation from the project and in the else clause I have generated the compilation from the code string that is supplied. Hence, I am still unable to understand the cause of the exception mentioned in the question.

Jason Malinowski Over a year ago

SemanticModels are bound to a specific syntax tree. If you are requesting semantic information for a different tree, you need to get it's semantic model. The exception means you're passing a node from one tree, but the semantic model was original created from a different tree. In the end of the day, just debug your code -- you're probably just passing the wrong value somewhere.

Collectives™ on Stack Overflow

"ArgumentException: Syntax node is not within Syntax tree" when using semantic model in roslyn

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related