Code/Tools/VisualStudioExtensions/CryEngineMonoDebugger/source/CryEngine.Debugger.Mono/CryEngineDebuggableConfig.cs

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 using System;
   4 using System.Collections.Generic;
   5 using System.Linq;
   6 using System.Net;
   7 using System.Net.NetworkInformation;
   8 using System.Runtime.InteropServices;
   9 using EnvDTE;
  10 using Microsoft.VisualStudio;
  11 using Microsoft.VisualStudio.OLE.Interop;
  12 using Microsoft.VisualStudio.Shell.Interop;
  13 using Mono.Debugging.Soft;
  14 using Mono.Debugging.VisualStudio;
  15
  16 namespace CryEngine.Debugger.Mono
  17 {
  18         internal class CryEngineDebuggableConfig : IVsDebuggableProjectCfg, IVsProjectFlavorCfg, IVsProjectCfgDebugTargetSelection
  19         {
  20                 private const string DebugTargetGuidString = "6E87CFAD-6C05-4adf-9CD7-3B7943875B7C";
  21
  22                 private static readonly uint[] DebugTargetCommandIds = new uint[] { 0x02001, 0x02002, 0x02003 };
  23                 private static readonly string[] DebugTargetNames = new string[] { "Debug GameLauncher", "Debug Sandbox", "Debug Server" };
  24                 private static readonly Guid DebugTargetGuid = new Guid(DebugTargetGuidString);
  25
  26                 private static LauncherType _launcherType = LauncherType.GameLauncher;
  27                 private static IVsDebugTargetSelectionService _debugService;
  28
  29                 private IVsProjectFlavorCfg _baseProjectCfg;
  30                 private Project _baseProject;
  31
  32                 public CryEngineDebuggableConfig(IVsProjectFlavorCfg pBaseProjectCfg, Project project)
  33                 {
  34                         _baseProject = project;
  35                         _baseProjectCfg = pBaseProjectCfg;
  36                 }
  37
  38                 public int Close()
  39                 {
  40                         if (_baseProjectCfg != null)
  41                         {
  42                                 _baseProjectCfg.Close();
  43                                 _baseProjectCfg = null;
  44                         }
  45
  46                         return VSConstants.S_OK;
  47                 }
  48
  49                 private int GetAvailablePort()
  50                 {
  51                         const int startPort = 17615;
  52                         const int stopPort = 18000;
  53                         var random = new Random(DateTime.Now.Millisecond);
  54
  55                         IPGlobalProperties ipGlobalProperties = IPGlobalProperties.GetIPGlobalProperties();
  56                         TcpConnectionInformation[] tcpConnInfoArray = ipGlobalProperties.GetActiveTcpConnections();
  57
  58                         var busyPorts = tcpConnInfoArray.Select(t => t.LocalEndPoint.Port).Where(v => v >= startPort && v <= stopPort).ToArray();
  59
  60                         var firstAvailableRandomPort = Enumerable.Range(startPort, stopPort - startPort).OrderBy(v => random.Next()).FirstOrDefault(p => !busyPorts.Contains(p));
  61
  62                         return firstAvailableRandomPort;
  63                 }
  64
  65                 /// <summary>
  66                 /// Called when the application is run with debugging support. Otherwise it will just launch.
  67                 /// </summary>
  68                 /// <param name="grfLaunch"></param>
  69                 /// <returns></returns>
  70                 public int DebugLaunch(uint grfLaunch)
  71                 {
  72                         var port = NetworkHelper.GetAvailablePort(17615, 18000);
  73
  74                         var startArgs = new SoftDebuggerConnectArgs("CRYENGINE", IPAddress.Loopback, port)
  75                         {
  76                                 MaxConnectionAttempts = 10
  77                         };
  78
  79                         var startInfo = new CryEngineStartInfo(startArgs, null, _baseProject, CryEngineProjectData.GetProjectData(_baseProject), _launcherType);
  80                         var session = new CryEngineDebuggerSession();
  81
  82                         IDebugLauncher debugLauncher = new CryEngineDebugLauncher();
  83                         var progress = new Progress<string>();
  84                         progress.ProgressChanged += OnProgressChanged;
  85                         var launcher = new MonoDebuggerLauncher(progress, debugLauncher);
  86
  87                         launcher.StartSession(startInfo, session);
  88
  89                         return VSConstants.S_OK;
  90                 }
  91
  92                 private void OnProgressChanged(object sender, string e)
  93                 {
  94                         OutputHandler.LogMessage(string.Format("[MonoInternal] {0}", e));
  95                 }
  96
  97                 public int QueryDebugLaunch(uint grfLaunch, out int pfCanLaunch)
  98                 {
  99                         pfCanLaunch = 1;
 100                         return VSConstants.S_OK;
 101                 }
 102
 103                 public int get_CfgType(ref Guid iidCfg, out IntPtr ppCfg)
 104                 {
 105                         ppCfg = IntPtr.Zero;
 106
 107                         try
 108                         {
 109                                 if (iidCfg == typeof(IVsDebuggableProjectCfg).GUID)
 110                                         ppCfg = Marshal.GetComInterfaceForObject(this, typeof(IVsDebuggableProjectCfg));
 111                                 else if ((ppCfg == IntPtr.Zero) && (this._baseProjectCfg != null))
 112                                         return this._baseProjectCfg.get_CfgType(ref iidCfg, out ppCfg);
 113                         }
 114                         catch (InvalidCastException)
 115                         {
 116                         }
 117
 118                         return VSConstants.S_OK;
 119                 }
 120
 121                 public int EnumOutputs(out IVsEnumOutputs ppIVsEnumOutputs)
 122                 {
 123                         throw new NotImplementedException();
 124                 }
 125
 126                 public int get_BuildableProjectCfg(out IVsBuildableProjectCfg ppIVsBuildableProjectCfg)
 127                 {
 128                         throw new NotImplementedException();
 129                 }
 130
 131                 public int get_CanonicalName(out string pbstrCanonicalName)
 132                 {
 133                         throw new NotImplementedException();
 134                 }
 135
 136                 public int get_DisplayName(out string pbstrDisplayName)
 137                 {
 138                         throw new NotImplementedException();
 139                 }
 140
 141                 public int get_IsDebugOnly(out int pfIsDebugOnly)
 142                 {
 143                         throw new NotImplementedException();
 144                 }
 145
 146                 public int get_IsPackaged(out int pfIsPackaged)
 147                 {
 148                         throw new NotImplementedException();
 149                 }
 150
 151                 public int get_IsReleaseOnly(out int pfIsReleaseOnly)
 152                 {
 153                         throw new NotImplementedException();
 154                 }
 155
 156                 public int get_IsSpecifyingOutputSupported(out int pfIsSpecifyingOutputSupported)
 157                 {
 158                         throw new NotImplementedException();
 159                 }
 160
 161                 public int get_Platform(out Guid pguidPlatform)
 162                 {
 163                         throw new NotImplementedException();
 164                 }
 165
 166                 public int get_ProjectCfgProvider(out IVsProjectCfgProvider ppIVsProjectCfgProvider)
 167                 {
 168                         throw new NotImplementedException();
 169                 }
 170
 171                 public int get_RootURL(out string pbstrRootURL)
 172                 {
 173                         throw new NotImplementedException();
 174                 }
 175
 176                 public int get_TargetCodePage(out uint puiTargetCodePage)
 177                 {
 178                         throw new NotImplementedException();
 179                 }
 180
 181                 public int get_UpdateSequenceNumber(ULARGE_INTEGER[] puliUSN)
 182                 {
 183                         throw new NotImplementedException();
 184                 }
 185
 186                 public int OpenOutput(string szOutputCanonicalName, out IVsOutput ppIVsOutput)
 187                 {
 188                         throw new NotImplementedException();
 189                 }
 190
 191                 public bool HasDebugTargets(IVsDebugTargetSelectionService pDebugTargetSelectionService, out Array pbstrSupportedTargetCommandIDs)
 192                 {
 193                         _debugService = pDebugTargetSelectionService;
 194
 195                         var targets = new string[DebugTargetCommandIds.Length];
 196                         for (int i = 0; i < DebugTargetCommandIds.Length; ++i)
 197                         {
 198                                 var commandId = DebugTargetCommandIds[i];
 199                                 targets[i] = string.Join(":", DebugTargetGuid, commandId);
 200                         }
 201
 202                         pbstrSupportedTargetCommandIDs = targets;
 203                         return true;
 204                 }
 205
 206                 public Array GetDebugTargetListOfType(Guid guidDebugTargetType, uint debugTargetTypeId)
 207                 {
 208                         if(guidDebugTargetType != DebugTargetGuid)
 209                         {
 210                                 return new string[0];
 211                         }
 212
 213                         for (int i = 0; i < DebugTargetCommandIds.Length; ++i)
 214                         {
 215                                 if(debugTargetTypeId == DebugTargetCommandIds[i])
 216                                 {
 217                                         return new string[] { DebugTargetNames[i] };
 218                                 }
 219                         }
 220
 221                         return new string[0];
 222                 }
 223
 224                 public void GetCurrentDebugTarget(out Guid pguidDebugTargetType, out uint pDebugTargetTypeId, out string pbstrCurrentDebugTarget)
 225                 {
 226                         pguidDebugTargetType = DebugTargetGuid;
 227                         pDebugTargetTypeId = DebugTargetCommandIds[(int)_launcherType];
 228                         pbstrCurrentDebugTarget = DebugTargetNames[(int)_launcherType];
 229                 }
 230
 231                 public void SetCurrentDebugTarget(Guid guidDebugTargetType, uint debugTargetTypeId, string bstrCurrentDebugTarget)
 232                 {
 233                         if (guidDebugTargetType != DebugTargetGuid)
 234                         {
 235                                 return;
 236                         }
 237
 238                         for (int i = 0; i < DebugTargetCommandIds.Length; ++i)
 239                         {
 240                                 if(debugTargetTypeId == DebugTargetCommandIds[i])
 241                                 {
 242                                         _launcherType = (LauncherType)i;
 243                                         _debugService?.UpdateDebugTargets();
 244                                         break;
 245                                 }
 246                         }
 247                 }
 248
 249                 public static void SetCurrentLauncherTarget(LauncherType launcherType)
 250                 {
 251                         _launcherType = launcherType;
 252                         _debugService?.UpdateDebugTargets();
 253                 }
 254         }
 255 }