Skip to main content

Dynamic Filtering and Querying in Your .NET applications - Using Mono’s C# Compiler As Service

imageIn my last post, I explained how to host Mono’s C# Compiler As A Service in your .NET applications. In this post, we’ll explore this a bit further, and see how to leverage Mono’s compiler as a service for implementing some dynamic querying features in your .NET applications.

Read my first post How To Host Mono’s C# Compiler as a Service in your .NET Application if you missed it. Now, let us explore some more points about using Mono’s C# Compiler as a Service in general, and the ‘Evaluator’ class in particular, to see how to leverage this for some practical uses like dynamic data filtering.

The Mono.CSharp.Evaluator Class

Let us consider a simple and dirty example. Fire up a Console application in Visual Studio, Add a reference to Mono.CSharp.dll, and try this code. Have a look at the Init method, and Run method of the Mono.CSharp.Evaluator class

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Mono.CSharp;

namespace MonoHost
{
    class Program
    {
        static void Main(string[] args)
        {
            //Initializing the evaluator
            Evaluator.Init(new string[0]);

            //Using evaluator to run some code, line by line

            //Importing namespaces 
            Evaluator.Run("using System;");
            Evaluator.Run("using System.Linq;");
            Evaluator.Run("using System.Collections.Generic;");

            //Sum of 'n' numbers
            Evaluator.Run("List<int> numbers= new List<int> {1,2,4,3} ;");
            Evaluator.Run("var sum=0; foreach(var num in numbers) sum+=num;");
            Evaluator.Run("Console.WriteLine(sum);");

        }
    }
}

Sweetening the Run

Of course, we can make the above code sweeter with an extension method. Have a look at this, the above code re-written. Nothing much, just some syntax sweetness.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Mono.CSharp;

namespace MonoHost
{
    // A simple extension method to invoke Evaluator.Run on a string
    public static class EvaluatorExtensions
    {
        public static void Run(this string code, bool repQuotes = false)
        {
            var run = repQuotes ? 
                      code.Replace("'", "\"") : code;
            Evaluator.Run(run);
        }
    }

    //Our main prog
    class Program
    {
        static void Main(string[] args)
        {
            //Initializing the evaluator
            Evaluator.Init(new string[0]);

            //Importing namespaces. Note that @”..” is one single string in multiple lines
            @"using System;
              using System.Linq;
              using System.Collections.Generic;"
                .Run();

            //Sum of 'n' numbers
            @"List<int> numbers= new List<int> {1,2,4,3} ;
             var sum=0; 
             foreach(var num in numbers) 
                     sum+=num;
             Console.WriteLine('Result={0}',sum);"
                .Run(true);
        }
    }
}

The Evaluate method

The Evaluator class also has an Evaluate method, that can evaluate an expression and can pass something back to your .NET code. This is pretty interesting, as this allows you to build dynamic queries, predicates etc via plain text, and apply it to your native collections etc. What about creating another LinqPad, your own style? Check out this example, where we query a list of integers by building a dynamic predicate.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Mono.CSharp;

namespace MonoHost
{
    // A simple extension method to invoke Evaluator methods on a string
    public static class EvaluatorExtensions
    {
        public static T Eval<T>(this string code) where T : class
        {
            return Evaluator.Evaluate(code) as T;
        }
        
        public static void Run(this string code, bool repQuotes = false)
        {
            var run = repQuotes ? 
                        code.Replace("'", "\"") : code;
            Evaluator.Run(run);
        }
    }

    //Main Program
    class Program
    {
        static void Main(string[] args)
        {
            //Initializing the evaluator
            Evaluator.Init(new string[0]);

            //Using evaluator to run some code
            //via our Extension method
            @"using System;
              using System.Linq;
              using System.Collections.Generic;"
                .Run();

            List<int> numbers = new List<int> { 1, 30, 90, 23, 46, 22, 50 };

            //Filter the numbers. Dynamic Predicate
            var match=@"new Predicate<int>(num=> num>20 && num <44);".Eval<Predicate<int>>();
            var filtered = numbers.FindAll(match);
            filtered.ForEach(n => Console.WriteLine(n));
        }
    }
}

The interesting point to note in the above example is, we are building our Predicate based on a string. And our Eval extension method is good enough to cast the result to the specified type. Now, there are a handful use cases for this. For example, with a bit of creativity and some pre-processing, you can provide a user friendly query language against data in your view model, to filter records when you build your next data visualizer application. And as an exercise, try modifying the above example with a custom type list, instead of an integer list. You can add a reference to an assembly via the ReferenceAssembly method of the Evaluator class.

Conclusion

Now, it is pretty cool if the context and data can be shared across the main application and the Evaluator context, so that our main app objects and data can be ‘touched’ from the plain text code that’ll be executed by the Evaluator, right? So that we can implement some sort of Scripting functionality via C#!! There are various ways to do that, but that is the topic for my next post. So stay tuned!!

Updated: I blogged the Next Part  - Using C# As A Scripting Language in your .NET Applications

Read some of my previous C# posts – Revisiting Few C# Concepts or 7 Free Ebooks for .NET programmers and Architects etc.

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…

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

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…