Adding WPF Upgrade Support for VB.NET

Abstract
The gmStudio distribution includes a sample demonstrating an upgrade of VB6 forms to WPF.  This sample was originally implemented for C#.  The purpose of this article is to describe how we added a WPF sample for VB.NET and provide insights into advanced customization.  The work required changes to the following metalanguage files:

• enumerations.xml
• vbcontrols.xml
• locSubsystem.gmsl
• wpfSubsystem.gmsl
• vb7lang.xml
• VBASIC.xml

Background
A Subsystem is a collection of related upgrade rules that provide a specific upgrade feature.  The current WPF/C# sample uses subsystem=wpf and subsystem=loc (light-weight object oriented C# coding style).  The two subsystems are activated by adding two commands to the translation script:

<Select SubSystem="wpf"/>
<Select SubSystem2="loc"/>

Generally speaking, the WPF/VB.NET sample will be analogous to the WPF/C# sample. However, the problems are in the details: I initially find the WPF subsystem contains several C#-specific patterns in vbcontrols.xml; for example, there are int and double casts as well as a few other C# patterns relating to data binding:

 <pattern id="Top.Set" >
 <wpf narg="2" code="Canvas.SetTop(%2d,(double)(%1d))\c" />
 <all narg="2" code="%2d.Top = %1d\c" />
 </pattern> 

What is needed here is a VB.NET form for some WPF operations. This is analogous to the situation with SubSystem=loc/lob where some patterns need both a VB.NET and a C# form.  For WPF we will need a pair of subsystems, wpf/wpb, for C#/VB.NET respectively. The new subsystem is added to enumerations.xml:

<MetaLanguage>
<Enumeration id="Dialects" >
...
 <Entry id="wpf" migName="LNG_WPF" value="9" />
 <Entry id="loc" migName="LNG_LOC" value="10" />
 <Entry id="lob" migName="LNG_LOB" value="11" />
 <Entry id="wpb" migName="LNG_WPB" value="12" /> <------ added
 </Enumeration>

Returning to vbcontrols.xml, I can add wpb versions of the dailect-specific wpf patterns, for example:

 <pattern id="Top.Set" >
 <wpb narg="2" code="Canvas.SetTop(%2d,%1d)\c" /> <------ added
 <wpf narg="2" code="Canvas.SetTop(%2d,(double)(%1d))\c" />
 <all narg="2" code="%2d.Top = %1d\c" />
 </pattern>

 <pattern id="WPO">
 <subcode id="SetCanvas">
 <wpf narg="3" code="%2d.%3d = %1d\c"/>
 <all narg="3" code="Canvas.Set%3d(%2d, %1d)\c"/>
 </subcode>
 <subcode id="RunProject" >
 <wpb narg="4" code="Dim app As New %4d.App : app.Run(%1d)\c" /> <------------ added 
 <all narg="4" code="new %4d.App().Run(%1d)\c" />
 </subcode>
 </pattern> 

locSubsystem.gmsl
int locCompilerInfo(int dummy1, int dummy2)
{   
   if(Select.Dialect == Dialects.vbn)
   {
      if (Select.SubSystem == Dialects.wpb)
      {
         Select.Subsystem = Dialects.wpb;
         Select.Subsystem2 = Dialects.wpf;
         Select.Subsystem3 = Dialects.lob;
         Select.Subsystem4 = Dialects.loc;
      }
      else
      {
         Select.Subsystem = Dialects.lob;
         Select.Subsystem2 = Dialects.loc;
      }
   }
   else
   {
      if (Select.SubSystem == Dialects.wpf)
      {
         Select.Subsystem  = Dialects.wpf;
         Select.Subsystem2 = Dialects.loc;
      }
   }
   return 0;
}

wpfSubsystem.gmsl
int wpfCompilerInfo(int dummy1, int dummy2)
{
   if(Select.Dialect == Dialects.vbn)
   {
         Select.Subsystem = Dialects.wpb;
         Select.Subsystem2 = Dialects.wpf;
         Select.Subsystem3 = Dialects.lob;
         Select.Subsystem4 = Dialects.loc;
   }
   else
   {
         Select.Subsystem = Dialects.wpf;
         Select.Subsystem2 = Dialects.loc;
   }
   return 0;
}

There are several places in authortext.gmsl testing for the presence of a subsystems. For these more complex multi-subsystem scenarios, they may also need to check SubSystem2, Subsystem3, etc. authortext.xml must also be modified to allow for this. A utility function, hasSubSystem, will be used to help make these tests in a consistent way.

int hasSubSystem(int theSubSystem)
{
 if (Select.SubSystem ==theSubSystem) return 1;
 if (Select.SubSystem2==theSubSystem) return 2;
 if (Select.SubSystem3==theSubSystem) return 3;
 if (Select.SubSystem4==theSubSystem) return 4;
 if (Select.SubSystem5==theSubSystem) return 5;
 return 0;
} 

Several other simple changes relating to default assembly references and Imports statements were needed to support WPF for VBN.   These are done by modifying in authortext.gmsl. 

A critical part of supporting the WPF upgrade relates to authoring XAML from the VB6 forms and declaring the WPF Application class.  This work is done in the wpfSubSystem.gmsl script.  This gmSL script contains various upgrade event handlers and supporting routines that are called by gmBasic at the appropriate times during the authoring process.   Support for VB.NET was added by making the code in wpfSubSystem.gmsl dialect-specific: adding logic to author either C# or VB.NET code depending on the dialect setting.

Next, I add an entry to VB7Lang.xml so that both the wpf SubSystem and the new wpb SubSystem will invoke the upgrade event handlers implemented in  WPFSubsystem.gmsl:

<gmSL NameSpace="gmSL" class="WPFSubSystem" Source="%UserFolder%\WPFSubsystem.gmsl" /> 
<gmSL NameSpace="gmSL" class="WPBSubSystem" Source="%UserFolder%\WPFSubsystem.gmsl" /> <-------------- added 

<Select SubSystem="wpf"/>