Make all UIViewControllers load XAML resource if the XAML type is present

CHANGES
=======
1. Removed initWithXAMLPage and initWithXAMLClass; initWithNibName will load the XAML resource over the NIB if applicable
2. Renamed UIEmptyController to UIEmptyView

TESTS
=====
1. Unit tests - PASSED
2. XAMLTest verification - desktop

Author: oliversa-msft

Frameworks/UIKit/StarboardXaml/StarboardXaml.cpp

@@ -63,9 +63,9 @@ void AppEventListener::_RegisterEventHandlers() {
     Windows::UI::Xaml::Application::Current->Resuming += ref new Windows::Foundation::EventHandler<Platform::Object^>(this, &AppEventListener::_OnResuming);
 
     // Register for Window Visibility change event.
-    // TODO::
-    // todo-nithishm-03072016 - Move this out of the Windows Visibility event in future.
+    // TODO: Move this out of the Windows Visibility event in future
     Xaml::Window::Current->VisibilityChanged += ref new Xaml::WindowVisibilityChangedEventHandler(this, &AppEventListener::_OnAppVisibilityChanged);
+
     // Register for Application Memory Usage Increase event.
     MemoryManager::AppMemoryUsageIncreased += ref new Windows::Foundation::EventHandler<Platform::Object^>(this, &AppEventListener::_OnAppMemoryUsageChanged);
 }

Frameworks/UIKit/UIApplication.mm

@@ -45,7 +45,7 @@
 #include "UWP/WindowsSystemDisplay.h"
 #include "UrlLauncher.h"
 
-#include "UIEmptyController.h"
+#include "UIEmptyView.h"
 
 #include "CACompositor.h"
 #include "UIInterface.h"
@@ -1426,7 +1426,7 @@ static void evaluateKeyboard(id self) {
 
     if (_blankView == nil) {
         CGRect frame = { 0 };
-        _blankView = [[UIEmptyController alloc] initWithFrame:frame];
+        _blankView = [[UIEmptyView alloc] initWithFrame:frame];
         [_blankView setBackgroundColor:[UIColor blackColor]];
         [_blankView setAutoresizesSubviews:FALSE];
     }

Frameworks/UIKit/UIEmptyController.h Frameworks/UIKit/UIEmptyView.hFrameworks/UIKit/UIEmptyController.h renamed to Frameworks/UIKit/UIEmptyView.h

@@ -16,9 +16,9 @@
 
 #pragma once
 
-#include "UIKit/UIView.h"
+#import "UIKit/UIView.h"
 
-@interface UIEmptyController : UIView {
+@interface UIEmptyView : UIView {
 @public
 }
 

Frameworks/UIKit/UIEmptyController.mm Frameworks/UIKit/UIEmptyView.mmFrameworks/UIKit/UIEmptyController.mm renamed to Frameworks/UIKit/UIEmptyView.mm

@@ -14,9 +14,9 @@
 //
 //******************************************************************************
 
-#include "Starboard.h"
-#include "UIEmptyController.h"
+#import "Starboard.h"
+#import "UIEmptyView.h"
 
-@implementation UIEmptyController
+@implementation UIEmptyView
 
 @end

Frameworks/UIKit/UIViewController.mm

@@ -38,9 +38,7 @@
 #import "UIViewControllerInternal.h"
 #import "UIApplicationInternal.h"
 
-// TODO: Rename UIEmptyController to UIEmptyView
-#import "UIEmptyController.h"
-
+#import "UIEmptyView.h"
 #import "UIViewInternal.h"
 #import "UIViewControllerInternal.h"
 #import "UIStoryboardInternal.h"
@@ -51,6 +49,8 @@
 #import "UWP/WindowsUIXaml.h"
 #import "UWP/WindowsFoundation.h"
 
+#import "StringHelpers.h"
+
 #include "COMIncludes.h"
 #include "WinString.h"
 #include "RoApi.h"
@@ -695,7 +695,7 @@ - (instancetype)initWithCoder:(NSCoder*)coder {
     }
 
     priv->_childViewControllers = [coder decodeObjectForKey:@"UIChildViewControllers"];
-    // assert(nibName != nil);
+
     priv->_edgesForExtendedLayout = [coder decodeIntForKey:@"UIKeyEdgesForExtendedLayout"];
 
     return self;
@@ -762,30 +762,33 @@ - (NSBundle*)nibBundle {
  @Status Interoperable
 */
 - (instancetype)initWithNibName:(NSString*)strNib bundle:(NSBundle*)bundle {
-    if (!priv) {
-        priv = (UIViewControllerPriv*)IwCalloc(1, sizeof(UIViewControllerPriv));
-        priv->_curOrientation = UIInterfaceOrientationPortrait;
-        priv->_contentSizeForViewInPopover.width = 320.0f;
-        priv->_contentSizeForViewInPopover.height = 1100.0f;
-    }
+    if (self = [super init]) {
+        if (!priv) {
+            priv = (UIViewControllerPriv*)IwCalloc(1, sizeof(UIViewControllerPriv));
+            priv->_curOrientation = UIInterfaceOrientationPortrait;
+            priv->_contentSizeForViewInPopover.width = 320.0f;
+            priv->_contentSizeForViewInPopover.height = 1100.0f;
+        }
 
-    if (bundle == nil) {
-        priv->nibBundle = [NSBundle mainBundle];
-    } else {
-        priv->nibBundle = bundle;
-    }
+        if (bundle == nil) {
+            priv->nibBundle = [NSBundle mainBundle];
+        } else {
+            priv->nibBundle = bundle;
+        }
 
-    if ([strNib length] > 0) {
-        priv->nibName = [strNib copy];
-    } else {
-        priv->nibName = nil;
-    }
+        if ([strNib length] > 0) {
+            priv->nibName.attach([strNib copy]);
+        } else {
+            priv->nibName = nil;
+        }
 
-    // TODO: Check to see if we have a XAML class file locally in the project
-    // 1. Find local XAML files (*.xaml.cpp) - assume the filename as the class name
-    // 2. Set priv->_xamlClass = filename (e.g. <ClassName>.xaml.cpp)
-    // 3. Set priv->_xamlPage = filename (NOT SURE IF PAGE WILL WORK WITHOUT THE CODE-BEHIND METHODS)
-    // 4. Remove initWithXAMLClass and initWithXAMLPage
+        // Load the XAML version if found. First prepend the auto-generated XAML namespace to the XAML class name
+        NSString* xamlClassName = [NSString stringWithFormat:@"IslandwoodAutoGenNamespace.%@", strNib];
+        auto xamlType = [self _returnXamlType:xamlClassName];
+        if (xamlType.Get() != nullptr) {
+            priv->_xamlClassName = xamlClassName;
+        }
+    }
 
     return self;
 }
@@ -794,25 +797,9 @@ - (instancetype)initWithNibName:(NSString*)strNib bundle:(NSBundle*)bundle {
  @Status Interoperable
 */
 - (instancetype)init {
-    [super init];
-
     return [self initWithNibName:nil bundle:nil];
 }
 
-- (instancetype)initWithXAMLClass:(NSString*)className {
-    self = [self initWithNibName:nil bundle:nil];
-    priv->_xamlClassName = className;
-
-    return self;
-}
-
-- (instancetype)initWithXAMLPage:(NSString*)pageName {
-    self = [self initWithNibName:nil bundle:nil];
-    priv->_xamlPageName = pageName;
-
-    return self;
-}
-
 /**
  @Status Interoperable
 */
@@ -821,7 +808,7 @@ - (void)loadView {
         return;
     }
 
-    if (priv->_xamlClassName != nil || priv->_xamlPageName != nil) {
+    if (priv->_xamlClassName != nil) {
         [self _loadXamlPage];
         return;
     }
@@ -919,7 +906,7 @@ - (void)loadView {
             frame = [self _modalPresentationFormSheetFrame];
         }
 
-        UIView* view = [[[UIEmptyController alloc] initWithFrame:frame] autorelease];
+        UIView* view = [[[UIEmptyView alloc] initWithFrame:frame] autorelease];
         [view setAutoresizingMask:UIViewAutoresizingFlexibleHeight | UIViewAutoresizingFlexibleWidth];
         [self setView:view];
     }
@@ -942,20 +929,6 @@ - (void)_doResizeToScreen {
             frame = [self _modalPresentationFormSheetFrame];
         }
 
-        /*
-        // TODO: Remove if this is no longer applicable
-        UIInterfaceOrientation curOrientation = (UIInterfaceOrientation)[[UIApplication sharedApplication] statusBarOrientation];
-        switch (curOrientation) {
-            case UIInterfaceOrientationLandscapeLeft:
-            case UIInterfaceOrientationLandscapeRight: {
-                float temp = frame.size.width;
-                frame.size.width = frame.size.height;
-                frame.size.height = temp;
-            }
-            break;
-        }
-        */
-
         [priv->view setFrame:frame];
     }
 }
@@ -978,7 +951,7 @@ - (UIView*)view {
                 frame = [self _modalPresentationFormSheetFrame];
             }
 
-            UIView* view = [[[UIEmptyController alloc] initWithFrame:frame] autorelease];
+            UIView* view = [[[UIEmptyView alloc] initWithFrame:frame] autorelease];
             [self setView:view];
         }
     }
@@ -1804,8 +1777,23 @@ - (BOOL)isEditing {
     return priv->_isEditing;
 }
 
+- (Microsoft::WRL::ComPtr<ABI::Windows::UI::Xaml::Markup::IXamlType>)_returnXamlType:(NSString*)xamlClassName {
+    Microsoft::WRL::ComPtr<ABI::Windows::UI::Xaml::Markup::IXamlMetadataProvider> xamlMetaProvider = nullptr;
+    auto inspApplicationCurrent = [WXApplication.current comObj];
+    inspApplicationCurrent.As(&xamlMetaProvider);
+
+    auto hClassName = Strings::NarrowToWide<HSTRING>(xamlClassName);
+    Microsoft::WRL::ComPtr<ABI::Windows::UI::Xaml::Markup::IXamlType> xamlType = nullptr;
+    HRESULT hr = xamlMetaProvider->GetXamlTypeByFullName(hClassName.Get(), xamlType.GetAddressOf());
+    if (SUCCEEDED(hr) && xamlType.Get() != nullptr) {
+        return xamlType;
+    }
+
+    return nullptr;
+}
+
 - (void)_loadXamlPage {
-    if (priv->_xamlClassName == nil && priv->_xamlPageName == nil) {
+    if (priv->_xamlClassName == nil) {
         return;
     }
 
@@ -1815,50 +1803,20 @@ - (void)_loadXamlPage {
     }
 
     // Create a template UIView
-    UIView* view = [[[UIEmptyController alloc] initWithFrame:frame] autorelease];
+    UIView* view = [[[UIEmptyView alloc] initWithFrame:frame] autorelease];
     [view setAutoresizingMask:UIViewAutoresizingFlexibleHeight | UIViewAutoresizingFlexibleWidth];
     [self setView:view];
 
-    // If we find a XAML class or page, attempt to load it
-    if (priv->_xamlClassName != nil) {
-        Microsoft::WRL::ComPtr<IInspectable> pageObj;
-        Microsoft::WRL::ComPtr<ABI::Windows::UI::Xaml::Markup::IXamlType> xamlType;
-        Microsoft::WRL::ComPtr<ABI::Windows::UI::Xaml::Markup::IXamlMetadataProvider> xamlMeta;
-        Microsoft::WRL::ComPtr<IInspectable> insp = [WXApplication.current comObj];
-        insp.As(&xamlMeta);
-
-        uint32_t classNameLen = [priv->_xamlClassName length];
-        unichar* className = (unichar*)IwMalloc(sizeof(unichar) * (classNameLen + 1));
-        auto freeClassName = wil::ScopeExit([&]() {
-            IwFree(className); 
-        });
-
-        HSTRING hClassName;
-        auto freeHClassName = wil::ScopeExit([&]() {
-            WindowsDeleteString(hClassName);
-        });
-
-        // Copy the string into className and null terminate it
-        [priv->_xamlClassName getCharacters:className];
-        className[classNameLen] = '\0';
-
-        WindowsCreateString((LPCWSTR)className, classNameLen, &hClassName);
-        xamlMeta->GetXamlTypeByFullName(hClassName, &xamlType);
-        xamlType->ActivateInstance(&pageObj);
-
-        priv->_page = (WXCPage*)NSAllocateObject([WXCPage class], 0, NULL);
-        [priv->_page setComObj:pageObj];
-    } else {
-        // TODO: If we load a XAML page, are we bypassing the code-gen methods to trigger events (e.g. *.xaml.cpp) and forward them to an
-        // UIView-class object
-        priv->_page = [WXCPage make];
-        WFUri* location = [WFUri makeUri:[NSString stringWithFormat:@"ms-appx:///%@", (NSString*)priv->_xamlPageName]];
-        [WXApplication loadComponentWithResourceLocation:priv->_page
-                                         resourceLocator:location
-                               componentResourceLocation:WUXCPComponentResourceLocationApplication];
-    }
+    // Activate an instance of the XAML class and its page
+    Microsoft::WRL::ComPtr<IInspectable> pageObj = nullptr;
+    auto xamlType = [self _returnXamlType:priv->_xamlClassName];
+    xamlType->ActivateInstance(pageObj.GetAddressOf());
+
+    priv->_page = (WXCPage*)NSAllocateObject([WXCPage class], 0, NULL);
+    [priv->_page setComObj:pageObj];
 
-    unsigned int propListCount;
+    // Walk the list of outlets and assign them to the corresponding XAML UIElement
+    unsigned int propListCount = 0;
     objc_property_t* props = (objc_property_t*)class_copyPropertyList([self class], &propListCount);
     auto freeProps = wil::ScopeExit([&]() {
         IwFree(props);

Frameworks/include/UIViewControllerInternal.h

@@ -71,7 +71,6 @@ struct UIViewControllerPriv {
 
     idretaintype(WXCPage) _page;
     idretaintype(NSString) _xamlClassName;
-    idretaintype(NSString) _xamlPageName;
 };
 
 @interface _UIViewControllerContextTransitioning : NSObject <UIViewControllerContextTransitioning>

build/UIKit/lib/UIKitLib.vcxproj

@@ -44,7 +44,7 @@
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIControl.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIDevice.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIDocument.mm" />
-    <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIEmptyController.mm" />
+    <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIEmptyView.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIEvent.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIFont.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIFontDescriptor.mm" />
@@ -124,7 +124,7 @@
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UITextView.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIToolbar.mm">
       <ObjectiveCARC>true</ObjectiveCARC>
-    </ClangCompile> 
+    </ClangCompile>
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIWebView.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UISwipeGestureRecognizer.mm" />
     <ClangCompile Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UICollectionView.mm">
@@ -295,7 +295,7 @@
   <ItemGroup>
     <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIAnimationNotification.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIDeviceInternal.h" />
-    <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIEmptyController.h" />
+    <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIEmptyView.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIImageCachedObject.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UINavigationControllerInternal.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)..\..\..\Frameworks\UIKit\UIProxyObject.h" />

include/UIKit/UIViewController.h

@@ -31,7 +31,7 @@
 
 #pragma once
 
-#include <UIKit/UIKitExport.h>
+#import <UIKit/UIKitExport.h>
 #import <UIKit/UIAppearanceContainer.h>
 #import <UIKit/UIContentContainer.h>
 #import <UIKit/UIFocusEnvironment.h>
@@ -173,9 +173,7 @@ UIKIT_EXPORT_CLASS
 - (id<UIViewControllerPreviewing>)registerForPreviewingWithDelegate:(id<UIViewControllerPreviewingDelegate>)delegate
                                                          sourceView:(UIView*)sourceView STUB_METHOD;
 - (id<UIViewControllerTransitionCoordinator>)transitionCoordinator STUB_METHOD;
-- (instancetype)initWithNibName:(NSString*)nibName bundle:(NSBundle*)nibBundle;
-- (instancetype)initWithXAMLClass:(NSString*)className;
-- (instancetype)initWithXAMLPage:(NSString*)pageName;
+-(instancetype)initWithNibName:(NSString*)nibName bundle:(NSBundle*)nibBundle NS_DESIGNATED_INITIALIZER;
 - (void)addChildViewController:(UIViewController*)childController;
 - (void)addKeyCommand:(UIKeyCommand*)keyCommand STUB_METHOD;
 - (void)applicationFinishedRestoringState STUB_METHOD;

samples/XAMLTest/XamlTest/AppDelegate.m

@@ -26,10 +26,8 @@ - (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(N
     // Override point for customization after application launch.
     self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
 
-    // Load the view from XAML instead of XIB file.
-    //MainViewController* viewController = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
-    //MainViewController *viewController = [[MainViewController alloc] initWithXAMLPage:@"MainViewController.xaml"];
-    MainViewController *viewController = [[MainViewController alloc] initWithXAMLClass:@"IslandwoodAutoGenNamespace.MainViewController"];
+    // Re-use the designated initializer and attempt to load the XAML page if the XAML type based on the class name is present
+    MainViewController* viewController = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
 
     self.window.rootViewController = viewController;
     [self.window makeKeyAndVisible];