Cinchoo – String.Evaluate(), Extension Method

In this section, I’ll talk about Evaluate extension method. This method used to evaluate a mathematical expression string and returns final output as object. Please see the below samples on how to use it.

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    //Numeric expression
    Console.WriteLine("Output of {100 + 20}: " + "{100 + 20}".Evaluate());
    Console.WriteLine("Output of {100 + 20 * 2 + 10}: " + "{100 + 20 * 2 + 10}".Evaluate());
    Console.WriteLine("Output of {100 + 20 * (2 + 10)}: " + "{100 + 20 * (2 + 10)}".Evaluate());
    Console.WriteLine("Output of {100.05 + 10.05}: " + "{100.05 + 10.05}".Evaluate());
    Console.WriteLine();

    //String expression
    Console.WriteLine("Output of {'First ' + 'Second'}: " + "{'First ' + 'Second'}".Evaluate());
    Console.WriteLine();

    //Expression contains properties
    Console.WriteLine("Output of {'%APPLICATION_NAME%'}: " + "{'%APPLICATION_NAME%'}".Evaluate());
    Console.WriteLine("Output of {'%NOW%'}: " + "{'%NOW%'}".Evaluate());
    Console.WriteLine("Output of {'%TODAY%'}: " + "{'%TODAY%'}".Evaluate());
    Console.WriteLine();
}

When you run the above code, the output will be

Output of {100 + 20}: 120
Output of {100 + 20 * 2 + 10}: 150
Output of {100 + 20 * (2 + 10)}: 340
Output of {100.05 + 10.05}: 110.1

Output of {'First ' + 'Second'}: First Second

Output of {'%APPLICATION_NAME%'}: Cinchoo.Core.ExpressionEvaluator.Test.exe
Output of {'%NOW%'}: 4:43 PM
Output of {'%TODAY%'}: 1/11/2012

Press any key to continue . . .

Happy coding!!!

PS: Please refer Property Replacer section for information about available properties and defining custom properties.


Cinchoo – String.ExpandProperties(), Extension Method

In this section, I’ll talk about ExpandProperties extension method. This method used to find and replace any system / user defined properties found in a string. Properties are string begins and ends in separatorPlease see the below samples on how to use it. This routine returns string value.

Sample Properties are

%APPLICATION_NAME%
%TODAY%

How to use

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    //Simple property expansion
    Console.WriteLine("Output of '%%APPLICATION_NAME%%' property: %APPLICATION_NAME%".ExpandProperties());
    Console.WriteLine("Output of '%%TODAY%%' property: %TODAY%".ExpandProperties());
    Console.WriteLine("Output of '%%PROCESSOR_COUNT%%' property: %PROCESSOR_COUNT%".ExpandProperties());

    Console.WriteLine();

    //String containing properties
    Console.WriteLine("This machine has %PROCESSOR_COUNT% processors.".ExpandProperties());
}

When you run the above code, the output will be

Output of 'APPLICATION_NAME' property: Cinchoo.Core.Test.exe
Output of 'TODAY' property: 2/16/2012
Output of 'PROCESSOR_COUNT' property: 2

This machine has 2 processors.

Press any key to continue . . .

Formatting Property Value

Some cases, you may want to format the property value. It can be done by passing format specification along with property name. Property Name and format specification are separated by ^ character. All .NET specific format specifiers are valid.

PS: Please refer Formatting Types from MSDN for more information about format specifiers used in .NET

%PROPERTY_NAME^FORMAT_STRING%

Sample:

static void Main(string[] args)
{
    //Formatted property expansion
    Console.WriteLine("Output of %%TODAY^yyyyMMdd%% property: %TODAY^yyyyMMdd%".ExpandProperties());
    Console.WriteLine("Output of %%PROCESSOR_COUNT^#,#.00#;(#,#.00#)%% property: %PROCESSOR_COUNT^#,#.00#;(#,#.00#)%".ExpandProperties());
    Console.WriteLine("Output of %%RANDOM_NO^C%% property: %RANDOM_NO^C%".ExpandProperties());
}

When you run the above code, the output will be

Output of TODAY^yyyyMMdd property: 20120216
Output of PROCESSOR_COUNT^#,#.00#;(#,#.00#) property: 2.00
Output of RANDOM_NO^C property: ($92,640,205.00)

Press any key to continue . . .

Handling of Unknown Property

Cinchoo framework gracefully skips any unknown properties specified in the input string. Look below the sample

Sample:

static void Main(string[] args)
{
    Console.WriteLine("Output of %%UNKNOWN_PROPERTY^C%% property: %UNKNOWN_PROPERTY^C%".ExpandProperties());
}

When you run the above code, the output will be

Output of UNKNOWN_PROPERTY^C property: %UNKNOWN_PROPERTY^C%

Press any key to continue . . .

How to resolve Unknown Property

Cinchoo framework provides a event handler to resolve any unknown properties failed to resolve. The event is exposed in ChoApplication.PropertyResolve event. Look at the sample below on how to handle this situation

Sample:

static void Main(string[] args)
{
    //Hook up the event handler
    ChoApplication.PropertyResolve += new EventHandler<Property.ChoUnknownProperyEventArgs>(PropertyResolve);

    Console.WriteLine("Output of %%UNKNOWN_PROPERTY^C%% property: %UNKNOWN_PROPERTY^C%".ExpandProperties());
}

//Event handler
private static void PropertyResolve(object sender, Property.ChoUnknownProperyEventArgs e)
{
    if (e.PropertyName == "UNKNOWN_PROPERTY")
    {
        e.PropertyValue = null;
        e.Resolved = true;
    }
}

When you run the above code, the output will be

Output of UNKNOWN_PROPERTY^C property: RESOLVED_VALUE

Press any key to continue . . .

Try it out! Happy coding!!!

Cinchoo – String.ExpandProperties(), Part 2

Here I’ll show you how you can mix expressions and properties together and resolving the input string.

ExpandProperties will do the expression evaluation along with property replacement in a string. Please see the below samples on how to use it. Expressions are given with { and } delimiters.

How to use

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    Console.WriteLine("Output of %%PROCESSOR_COUNT%% : {%PROCESSOR_COUNT% * 2}".ExpandProperties());
    Console.WriteLine("Output of {{%%TICK_COUNT%% / (60 * 60)}} : {%TICK_COUNT% / (60 * 60)}".ExpandProperties());
    Console.WriteLine(@"Output of {{'%%SYSTEM_DIRECTORY%%' + '\Logs'}} : {'%SYSTEM_DIRECTORY%' + '\Logs'}".ExpandProperties());
}

In the above sample code, all the properties are resolved before expressions evaluated.

When you run the above code, the output will be

Output of PROCESSOR_COUNT : 4
Output of {TICK_COUNT / (60 * 60)} : -393593
Output of {'SYSTEM_DIRECTORY' + '\Logs'} : C:\WINNT\system32\Logs

Press any key to continue . . .

Try it out! Happy coding!!!

Cinchoo – String.Indent(), Extension Method

In this section, I’ll talk about Indent extension method. This method used to indent a string with the padding characters. Please see the below samples on how to use it.

1. Add reference to Cinchoo.Core.ExtensionMethods.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    string msg = "Hello World!{0}Welcome to Cinchoo.com".FormatString(Environment.NewLine);

    Console.WriteLine("Before Indent:");
    Console.WriteLine(msg);
    Console.WriteLine();

    Console.WriteLine("After Indent:");
    Console.WriteLine(msg.Indent());
}

When you run the above code, the output will be

Before Indent:
Hello World!
Welcome to Cinchoo.com

After Indent:
        Hello World!
        Welcome to Cinchoo.com

Press any key to continue . . .

Indent() method has several overloads, they are

//Indent with 1 tab char
Indent();
//Indent with 'totalWidth' number of tab chars
Indent(int totalWidth);
//Indent with 'totalWidth' number of paddingChars
Indent(int totalWidth, char paddingChar);

PS: totalWidth should be positive. In case if you pass negative value, this routine will invoke Unindent() method to remove any leading pad characters from each line of input text.

Happy coding!!!

Cinchoo – String.ToEnum(), Extension Method

In this section, I’ll talk about ToEnum<T> extension method. This method used get enum value from enum description.

1. Add reference to Cinchoo.Core.ExtensionMethods.dll assembly

2. Namespace System

Sample:

public enum Color
{
    [Description("Red Color")]
    Red,
    [Description("Green Color")]
    Green,
    [Description("Yellow Color")]
    Yellow
}

static void Main(string[] args)
{
    Console.Write("Enum value for 'RED Color' is: ");
    Console.WriteLine("RED Color".ToEnum<Color>());
}

When you run the above code, the output will be

Enum value for 'RED Color' is: Red
Press any key to continue . . .

Happy coding!!!

Cinchoo – Enum.ToDescription(), Extension Method

In this section, I’ll talk about ToDescription<T> extension method. This method used get enum description from enum value.

1. Add reference to Cinchoo.Core.ExtensionMethods.dll assembly

2. Namespace System

Sample:

public enum Color
{
    [Description("Red Color")]
    Red,
    [Description("Green Color")]
    Green,
    [Description("Yellow Color")]
    Yellow
}

static void Main(string[] args)
{
    Console.Write("Description of 'Color.Green' enum value is: ");
    Console.WriteLine(Color.Green.ToDescription());
}

When you run the above code, the output will be

Description of 'Color.Green' enum value is: Green Color
Press any key to continue . . .

Happy coding!!!

Cinchoo – String.Unindent(), Extension Method

In this section, I’ll talk about Unindent extension method. This method used to find and remove the padding characters from input text. Please see the below samples on how to use it.

1. Add reference to Cinchoo.Core.ExtensionMethods.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    string msg = "\tHello World!{0}\tWelcome to Cinchoo.com".FormatString(Environment.NewLine);

    Console.WriteLine("Before Unindent:");
    Console.WriteLine(msg);
    Console.WriteLine();

    Console.WriteLine("After Unindent:");
    Console.WriteLine(msg.Unindent());
}

When you run the above code, the output will be

Before Unindent:
        Hello World!
        Welcome to Cinchoo.com

After Unindent:
Hello World!
Welcome to Cinchoo.com
Press any key to continue . . .

Unindent() method has several overloads, they are

//Unindent with 1 tab char
Unindent();
//Unindent with 'totalWidth' number of tab chars
Unindent(int totalWidth);
//Unindent with 'totalWidth' number of paddingChars
Unindent(int totalWidth, char paddingChar);

PS: totalWidth should be positive. In case if you pass negative value, this routine will invoke Indent() method to add any leading pad characters from each line of input text.

Happy coding!!!

Cinchoo – String.Evaluate(), Part 2

Using system library routines

In some cases, you may want to use system library routines while evaluating expression. Library routines are specified with ~ delimiter. When specifying library routine, please give full namespace type name.

Please see the sample below

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace System

Sample:

static void Main(string[] args)
{
    try
    {
        object x1 = "{~System.DateTime.Now.Ticks~ * 10}".Evaluate();
        Console.WriteLine("Output of {~System.DateTime.Now.Ticks~ * 10}: " + x1 + ", ObjectType:" + x1.GetType());

        object x2 = "{2 + ~System.Math.Sin(10)~ * 10}".Evaluate();
        Console.WriteLine("Output of {2 + ~Math.Sin(10)~ * 10}: " + x2 + ", ObjectType:" + x2.GetType());
    }
    finally
    {
        ChoAppDomain.Exit();
    }
}

When you run the above code, the output will be

Output of {~System.DateTime.Now.Ticks~ * 10}: 6346500617481320790, ObjectType: System.Int64
Output of {2 + ~Math.Sin(10)~ * 10}: -3.4402111088937, ObjectType: System.Double

Press any key to continue . . .

Happy coding!!!


Cinchoo – String.Evaluate(), Part 3

Using custom library routines

You may ask, how to use my own custom routines while evaluating expressions? Here I’m will show you how. All you need to do is to write the routine, reference it to the current project if it was in separate assembly.

Please see the sample below

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace System

Sample:

namespace Cinchoo.Core.Test
{
    public class Utilities
    {
        public static int Sqrt(int x)
        {
            return x * x;
        }
    }

    public class Program
    {
        static void Main(string[] args)
        {
            try
            {
                object x1 = "{~Cinchoo.Core.Test.Utilities.Sqrt(10)~ * 10}".Evaluate();
                Console.WriteLine("Output of {~Cinchoo.Core.Test.Utilities.Sqrt(10)~ * 10}: " + x1 + ", ObjectType:" + x1.GetType());
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
            finally
            {
                ChoFramework.Shutdown();
            }
        }
    }
}

When you run the above code, the output will be

Output of {~Cinchoo.Core.Test.Utilities.Sqrt(10)~ * 10}: 1000, ObjectType:System.Int32

Press any key to continue . . .

Happy coding!!!


Cinchoo – Delegate.WaitFor(), Extension Method

Here I’ll talk about WaitFor extension method. This extension method used to run a method with finite number of retries if it failed to run at first time and/or in a finite time frame. It provides most of Action and Func delgates overloads.

1. Add reference to Cinchoo.Core.dll assembly

2. Namespace Cinchoo.Core

Sample 1:

Below are the list of overloads for Func<T> delegate, Cinchoo provides these overloads almost all the Func’s and Action’s.

public static TResult WaitFor(this Func func);
public static TResult WaitFor(this Func func, int timeout);
public static TResult WaitFor(this Func func, int timeout, int maxNoOfRetry);
public static TResult WaitFor(this Func func, int timeout, int maxNoOfRetry, int sleepBetweenRetry);

Below sample shows you how to run a  Func<T> delegate method using WaitFor() extension method.

class Program
{
    static void Main(string[] args)
    {
		Func f1 = () =>
			{
				System.Threading.Thread.Sleep(1);
                Console.WriteLine("Running method...");
				return 1;
			};

        Console.WriteLine("Output: {0}".FormatString(f1.WaitFor()));
	}
}

When you run the above code, the output will be

Running method...
Output: 1
Press any key to continue . . .

Sample 2:

In this example, I’ll show you the way of invoking a method with timeout (1000ms) parameter. It throws a timeout exception, as the method takes more time to execute than timeout (1000 ms) period.

class Program
{
    static void Main(string[] args)
    {
        try
        {
            Func f1 = () =>
                {
                    System.Threading.Thread.Sleep(5000);
                    Console.WriteLine("Running method...");
                    return 1;
                };

            Console.WriteLine("Output: {0}".FormatString(f1.WaitFor(1000)));
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error: {0}".FormatString(ex.Message));
        }
	}
}

When you run the above code, the output will be

Error: Timeout [1000 ms] elapsed prior to completion of the method [Target: , Metho
d: Int32 b__0()].
Press any key to continue . . .

Sample 3:

In here, we will see how a method with an error is executed for number of times with one of the WaitFor overload.

static void Main(string[] args)
{
    try
    {
        Func<int> f1 = () =>
            {
                System.Threading.Thread.Sleep(10);
                throw new ApplicationException("Communication error.");
            };

        Console.WriteLine("Output: {0}".FormatString(f1.WaitFor(Timeout.Infinite, 3)));
    }
    catch (Exception ex)
    {
        Console.WriteLine("Error: {0}".FormatString(ex.Message));
    }
}

When you run the above code, the output will be

Error: Exception(s) occurred : The method failed to execute after 3 retries..
[ System.ApplicationException: Communication error.
   at Cinchoo.Core.ChoWaitForTest.Program.<Main>b__0() in C:\Personal\Cinchoo.Fr
amwork\Cinchoo.Core.Test\Cinchoo.Core.ChoWaitFor.Test\Program.cs:line 18
   at Cinchoo.Core.ChoWaitFor.WaitFor[TResult](Func`1 func, Int32 timeout, Int32
 maxNoOfRetry, Int32 sleepBetweenRetry) in C:\Personal\Cinchoo.Framwork\Cinchoo.
Framework\Cinchoo.Core\WaitFor\ChoWaitFor.cs:line 148 ]

[ System.ApplicationException: Communication error.
   at Cinchoo.Core.ChoWaitForTest.Program.<Main>b__0() in C:\Personal\Cinchoo.Fr
amwork\Cinchoo.Core.Test\Cinchoo.Core.ChoWaitFor.Test\Program.cs:line 18
   at Cinchoo.Core.ChoWaitFor.WaitFor[TResult](Func`1 func, Int32 timeout, Int32
 maxNoOfRetry, Int32 sleepBetweenRetry) in C:\Personal\Cinchoo.Framwork\Cinchoo.
Framework\Cinchoo.Core\WaitFor\ChoWaitFor.cs:line 148 ]

[ System.ApplicationException: Communication error.
   at Cinchoo.Core.ChoWaitForTest.Program.<Main>b__0() in C:\Personal\Cinchoo.Fr
amwork\Cinchoo.Core.Test\Cinchoo.Core.ChoWaitFor.Test\Program.cs:line 18
   at Cinchoo.Core.ChoWaitFor.WaitFor[TResult](Func`1 func, Int32 timeout, Int32
 maxNoOfRetry, Int32 sleepBetweenRetry) in C:\Personal\Cinchoo.Framwork\Cinchoo.
Framework\Cinchoo.Core\WaitFor\ChoWaitFor.cs:line 148 ]
Press any key to continue . . .

Happy coding!!!