Skip to main content

Roslyn September CTP 2012 Overview – API Changes, Using Modified APIs for C# Script Execution, Embedding C# as a scripting language

imageMicrosoft Roslyn September CTP 2012 is now released. You can download the September CTP here

You could find a quick overview about Roslyn in my previous overview post.

Roslyn CTP previews the upcoming features of C# and VB.NET. Roslyn CTP is a pretty exciting release, and it opens up lot of possibilities for C# and VB.NET programmers. Roslyn provides language services and APIs on top of .NET’s compiler services, and this will enable .NET developers to do a lot more things – including using C# and VB.NET as scripting languages, use compiler as a service in your own applications for code related tasks, develop better language and IDE extensions etc.

What’s Exciting In September CTP (CTP3) release

One of the biggest excitement for me is the support for Expression Trees. This means, now you can include LINQ Queries in your script, and you can dynamically execute LINQ queries. This has lot of interesting aspects, and this is huge. For example, see how I’m executing a very simple Linq query from the C# interactive console.

image

Along with inclusion of Expression trees, the following language features are also now supported in Roslyn, since CTP2.

  • Collection initializers
  • Extern aliases
  • Multi-dimensional arrays
  • Nullable types
  • Object initializers
  • Type forwarders
  • Unsafe code (except fixed-size buffers)

Scripting API Changes

There are some breaking changes in September CTP release. I thought I’ll quickly re-phrase the Scripting Example I provided in the overview post. Some of the major changes for Scripting API includes,

  • Changes for the ScriptEngine constructor
  • Now you need to use ScriptEngine instance’s Create Method instead of Session.Create(..) you had in earlier version of Roslyn.
  • The Execute method is now part of the Session, instead of Engine. So, instead of Engine’s Execute(code,session) in previous versions, you can directly call your Session’s Execute(code) method.

So, here is the updated code for the Scripting example I provided in the previous post. You could compare this with the previous example, and I’ve listed some of the changes below. Note that the change is only with in the ScriptingHost class

using System;
using System.Collections.Generic;
using System.Linq;
using Roslyn.Scripting.CSharp;
using Roslyn.Scripting;


namespace ScriptingRoslyn
{
    //Our Dog class so that we can train dogs later
    public class OurDog
    {
        private string _name = string.Empty;
        public OurDog(string name)
        {
            _name = name;
        }

        public string Name
        {
            get { return _name; }
        }

        public void Bite(OurDog other)
        {
            Console.WriteLine("{0} is biting the tail of {1}", _name, other.Name);
        }

        public void Walk()
        {
            Console.WriteLine("{0} is Walking", _name);
        }

        public void Eat()
        {
            Console.WriteLine("{0} is Eating", _name);
        }
    }



//Let us create a Host object, where we'll wrap our session and engine
//The methods in the host class are available directly to the environment
//Now you can create a ScriptEngine, and create a session out of the ScriptEngine

 public class ScriptingHost
    {
        private ScriptEngine engine;
        private Session session;

        //Methods in the Host object can be called directly from the 
        //environment
        public OurDog CreateDog(string name)
        {
            return new OurDog(name);
        }

        public ScriptingHost()
        {
            //Create the script engine
            //Script engine constructor parameters go changed
            engine=new ScriptEngine();

            //Let us use engine's Addreference for adding the required
            //assemblies
            new[]
             {
                    typeof (Console).Assembly,
                    typeof (ScriptingHost).Assembly,
                    typeof (IEnumerable<>).Assembly,
                    typeof (IQueryable).Assembly,
                    this.GetType().Assembly
             }.ToList().ForEach(asm => engine.AddReference(asm));

            new[]
                {
                   "System", "System.Linq", 
                   "System.Collections",
                   "System.Collections.Generic"
                }.ToList().ForEach(ns=>engine.ImportNamespace(ns));

            //Now, you need to create a session using engine's CreateSession method,
            //which can be seeded with a host object
            session = engine.CreateSession(this);
        }


        //Pass the code to the engine, nothing much here
        public object Execute(string code)
        {
            return session.Execute (code);
        }

        public T Execute<T>(string code)
        {
            return session.Execute<T>(code);
        }

    }

    //Main driver
    class Program
    {
        static void Main(string[] args)
        {
            var host = new ScriptingHost();
            Console.WriteLine("Hello Dog Trainer!! Type your code.\n\n");


            string codeLine;
            Console.Write(">");
            while ((codeLine = Console.ReadLine()) != "Exit();")
            {
                try
                {
                    //Execute the code
                    var res = host.Execute(codeLine);

                    //Write the result back to console
                    if (res != null)
                        Console.WriteLine(" = " + res.ToString());
                }
                catch (Exception e)
                {
                    Console.WriteLine(" !! " + e.Message);
                }

                Console.Write(">");
            }
        }
    }
}

And now, let us run our little scripting app. And try some LINQ queries as part of your script Smile

image

 

Other API Changes

There have been some updates to the Roslyn APIs since the second CTP was released in June of 2012. Below is a summary of some of the most important changes, some of which are breaking.  For example, In compiler APIs,

  • Instead of SyntaxTree.ParseCompilationUnit you can use ParseText or ParseFile instead. 
  • Also SyntaxNode.GetText and SyntaxNode.GetFullText have been replaced with ToString and ToFullString respectively

You can see a full list of API changes here - Happy Hacking with the new Roslyn APIs, Enjoy C#

Popular posts from this blog

Top 7 Coding Standards & Guideline Documents For C#/.NET Developers

Some time back, I collated a list of 7 Must Read, Free EBooks for .NET Developers, and a lot of people found it useful. So, I thought about putting together a list of Coding Standard guidelines/checklists for .NET /C# developers as well.As you may already know, it is easy to come up with a document - the key is in implementing these standards in your organization, through methods like internal trainings, Peer Reviews, Check in policies, Automated code review tools etc. You can have a look at FxCop and/or StyleCop for automating the review process to some extent, and can customize the rules based on your requirements.Anyway, here is a list of some good Coding Standard Documents. They are useful not just from a review perspective - going through these documents can definitely help you and me to iron out few hidden glitches we might have in the programming portion of our brain. So, here we go, the listing is not in any specific order.1 – IDesign C# Coding StandardsIDesign C# coding stand…

5 Awesome Learning Resources For Programmers (To help you and your kids to grow the geek neurons)

Happy New Year, this is my first post in 2012. I’ll be sharing few awesome learning resources I’ve bookmarked, and will be pointing out some specific computer/programming related courses I've found interesting from these resources.Also, thought about saving this blog post for my kids as well - instead of investing in these Child education schemes (though they are too small as of today, 2 years and 60 days respectively ). Anyway, personally my new year resolution is to see as much videos from this course collections (assuming I can find some free time in between my regular job && changing my babies diapers).1 – Khan AcademyAs I mentioned some time back, you and your kids are missing some thing huge if you havn’t heard about Khan Academy.  It is an awesome learning resource, especially if you want to re-visit your basics in Math, Science etc.With a library of over 2,600 videos covering everything from arithmetic to physics, finance, and history and 268 practice exercises, th…

Hack Raspberry Pi – How To Build Apps In C#, WinForms and ASP.NET Using Mono In Pi

Recently I was doing a bit of R&D related to finding a viable, low cost platform for client nodes. Obviously, I came across Raspberry Pi, and found the same extremely interesting. Now, the missing piece of the puzzle was how to get going using C# and .NET in the Pi. C# is a great language, and there are a lot of C# developers out there in the wild who are interested in the Pi.In this article, I’ll just document my findings so far, and will explain how develop using C# leveraging Mono in a Raspberry Pi. Also, we’ll see how to write few minimal Windows Forms & ASP.NET applications in the Pie as well.Step 1: What is Raspberry Pi?Raspberry Pi is an ARM/Linux box for just ~ $30. It was introduced with a vision to teach basic computer science in schools. How ever, it got a lot of attention from hackers all around the world, as it is an awesome low cost platform to hack and experiment cool ideas as Pi is almost a full fledged computer.  More About R-Pi From Wikipedia.The Raspberry Pi