Skip to content

Commit

Permalink
Switch to --newinstance
Browse files Browse the repository at this point in the history
  • Loading branch information
christophwille committed May 4, 2024
1 parent 4b52925 commit d0c443c
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 87 deletions.
13 changes: 3 additions & 10 deletions ILSpy.Tests/CommandLineArgumentsTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,12 @@ public void VerifyEmptyArgumentsArray()
}

[Test]
public void VerifySeparateOption()
public void VerifyForceNewInstanceOption()
{
var cmdLineArgs = new CommandLineArguments(new string[] { "--instancing", "Multi" });
var cmdLineArgs = new CommandLineArguments(new string[] { "--newinstance" });
cmdLineArgs.SingleInstance.Should().BeFalse();
}

[Test]
public void VerifySingleInstanceOption()
{
var cmdLineArgs = new CommandLineArguments(new string[] { "--instancing", "Single" });
cmdLineArgs.SingleInstance.Should().BeTrue();
}

[Test]
public void VerifyNavigateToOption()
{
Expand Down Expand Up @@ -86,7 +79,7 @@ public void PassAtFileArgumentsSpaceSeparated()
{
string filepath = System.IO.Path.GetTempFileName();

System.IO.File.WriteAllText(filepath, "assembly1 assembly2 assembly3 --instancing multi --noactivate");
System.IO.File.WriteAllText(filepath, "assembly1 assembly2 assembly3 --newinstance --noactivate");

var cmdLineArgs = new CommandLineArguments(new string[] { $"@{filepath}" });

Expand Down
33 changes: 6 additions & 27 deletions ILSpy/CommandLineArguments.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,11 @@

using McMaster.Extensions.CommandLineUtils;

using System;
using System.Collections.Generic;
using System.Linq;

namespace ICSharpCode.ILSpy
{
internal enum InstancingMode
{
Single,
Multi
}

sealed class CommandLineArguments
{
// see /doc/Command Line.txt for details
Expand All @@ -44,12 +37,13 @@ sealed class CommandLineArguments
public CommandLineArguments(IEnumerable<string> arguments)
{
var app = new CommandLineApplication() {
// https://natemcmaster.github.io/CommandLineUtils/docs/response-file-parsing.html?tabs=using-attributes
ResponseFileHandling = ResponseFileHandling.ParseArgsAsSpaceSeparated,
};

var oInstancing = app.Option("-i|--instancing <single/multi>",
"Single or multi instance",
CommandOptionType.SingleValue);
var oForceNewInstance = app.Option("--newinstance",
"Start a new instance of ILSpy even if the user configuration is set to single-instance",
CommandOptionType.NoValue);

var oNavigateTo = app.Option<string>("-n|--navigateto <TYPENAME>",
"Navigates to the member specified by the given ID string.\r\nThe member is searched for only in the assemblies specified on the command line.\r\nExample: 'ILSpy ILSpy.exe --navigateTo:T:ICSharpCode.ILSpy.CommandLineArguments'",
Expand Down Expand Up @@ -79,26 +73,11 @@ public CommandLineArguments(IEnumerable<string> arguments)
// To enable this, MultipleValues must be set to true, and the argument must be the last one specified.
var files = app.Argument("Assemblies", "Assemblies to load", multipleValues: true);


// string helptext = app.GetHelpText();

app.Parse(arguments.ToArray());

if (oInstancing.Value != null)
{
if (Enum.TryParse<InstancingMode>(oInstancing.Value(), true, out var mode))
{
switch (mode)
{
case InstancingMode.Single:
SingleInstance = true;
break;
case InstancingMode.Multi:
SingleInstance = false;
break;
}
}
}
if (oForceNewInstance.HasValue())
SingleInstance = false;

NavigateTo = oNavigateTo.ParsedValue;
Search = oSearch.ParsedValue;
Expand Down
73 changes: 23 additions & 50 deletions doc/Command Line.txt
Original file line number Diff line number Diff line change
@@ -1,54 +1,27 @@
ILSpy Command Line Arguments

Command line arguments can be either options or file names.
If an argument is a file name, the file will be opened as assembly and added to the current assembly list.
Usage: <Assemblies> [options]
@ResponseFile.rsp

Available options:
/singleInstance If ILSpy is already running, activates the existing instance
and passes command line arguments to that instance.
This is the default value if /list is not used.

/separate Start up a separate ILSpy instance even if it is already running.

/noActivate Do not activate the existing ILSpy instance. This option has no effect
if a new ILSpy instance is being started.

/list:listname Specifies the name of the assembly list that is loaded initially.
When this option is not specified, ILSpy loads the previously opened list.
Specify "/list" (without value) to open the default list.

When this option is used, ILSpy will activate an existing instance
only if it uses the same list as specified.

[Note: Assembly Lists are not yet implemented]

/clearList Clears the assembly list before loading the specified assemblies.
[Note: Assembly Lists are not yet implemented]

/navigateTo:tag Navigates to the member specified by the given ID string.
The member is searched for only in the assemblies specified on the command line.
Example: 'ILSpy ILSpy.exe /navigateTo:T:ICSharpCode.ILSpy.CommandLineArguments'

The syntax of ID strings is described in appendix A of the C# language specification.

/language:name Selects the specified language.
Example: 'ILSpy /language:C#' or 'ILSpy /language:IL'
Arguments:
Assemblies Assemblies to load

WM_COPYDATA (SendMessage API):
ILSpy can be controlled by other programs that send a WM_COPYDATA message to its main window.
The message data must be an Unicode (UTF-16) string starting with "ILSpy:\r\n".
All lines except the first ("ILSpy:") in that string are handled as command-line arguments.
There must be exactly one argument per line.

That is, by sending this message:
ILSpy:
C:\Assembly.dll
/navigateTo:T:Type
The target ILSpy instance will open C:\Assembly.dll and navigate to the specified type.

ILSpy will return TRUE (1) if it handles the message, and FALSE (0) otherwise.
The /separate option will be ignored; WM_COPYDATA will never start up a new instance.
The /noActivate option has no effect, sending WM_COPYDATA will never activate the window.
Instead, the calling process should use SetForegroundWindow().
If you use /list with WM_COPYDATA, you need to specify /singleInstance as well, otherwise
ILSpy will not handle the message if it has opened a different assembly list.
Options:
--newinstance Start a new instance of ILSpy even if the user configuration is set to single-instance
-n|--navigateto <TYPENAME> Navigates to the member specified by the given ID string.
The member is searched for only in the assemblies specified on the command line.
Example: 'ILSpy ILSpy.exe --navigateTo:T:ICSharpCode.ILSpy.CommandLineArguments'
-s|--search <SEARCHTERM> Search for t:TypeName, m:Member or c:Constant; use exact match (=term),
'should not contain' (-term) or 'must contain' (+term); use
/reg(ular)?Ex(pressions)?/ or both - t:/Type(Name)?/...
-l|--language <LANGUAGEIDENTIFIER> Selects the specified language.
Example: 'ILSpy --language:C#' or 'ILSpy --language:IL'
-c|--config <CONFIGFILENAME> Provide a specific configuration file.
Example: 'ILSpy --config:myconfig.xml'
--noactivate Do not activate the existing ILSpy instance.
This option has no effect if a new ILSpy instance is being started.

Note on @ResponseFile.rsp:

* The response file should contain the arguments as if they were passed on the command line (space-separated).
* Use it when the list of assemblies is too long to fit on the command line.

0 comments on commit d0c443c

Please sign in to comment.