Path Config - add an info icon that opens a popup for the special path options (., .., %recent%, %exe%)

BizHawk.MultiClient/BizHawk.MultiClient.csproj

@@ -199,6 +199,12 @@
     <Compile Include="config\PathConfig.Designer.cs">
       <DependentUpon>PathConfig.cs</DependentUpon>
     </Compile>
+    <Compile Include="config\PathInfo.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="config\PathInfo.Designer.cs">
+      <DependentUpon>PathInfo.cs</DependentUpon>
+    </Compile>
     <Compile Include="config\PathManager.cs" />
     <Compile Include="config\SoundConfig.cs">
       <SubType>Form</SubType>
@@ -433,6 +439,9 @@
     <EmbeddedResource Include="config\GifAnimator.resx">
       <DependentUpon>GifAnimator.cs</DependentUpon>
     </EmbeddedResource>
+    <EmbeddedResource Include="config\PathInfo.resx">
+      <DependentUpon>PathInfo.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="GBtools\ColorChooserForm.resx">
       <DependentUpon>ColorChooserForm.cs</DependentUpon>
     </EmbeddedResource>

BizHawk.MultiClient/config/PathConfig.Designer.cs

@@ -28,6 +28,7 @@
         /// </summary>
         private void InitializeComponent()
         {
+			this.components = new System.ComponentModel.Container();
 			System.ComponentModel.ComponentResourceManager resources = new System.ComponentModel.ComponentResourceManager(typeof(PathConfig));
 			this.Cancel = new System.Windows.Forms.Button();
 			this.OK = new System.Windows.Forms.Button();
@@ -275,6 +276,9 @@
 			this.INTVSaveRAMDescription = new System.Windows.Forms.Label();
 			this.INTVSaveRAMBox = new System.Windows.Forms.TextBox();
 			this.tabPage7 = new System.Windows.Forms.TabPage();
+			this.LogDescription = new System.Windows.Forms.Label();
+			this.BrowseLog = new System.Windows.Forms.Button();
+			this.LogBox = new System.Windows.Forms.TextBox();
 			this.MovieBackupsBox = new System.Windows.Forms.TextBox();
 			this.BrowseMovieBackups = new System.Windows.Forms.Button();
 			this.MovieBackupsDescription = new System.Windows.Forms.Label();
@@ -284,9 +288,9 @@
 			this.RecentForROMs = new System.Windows.Forms.CheckBox();
 			this.SaveButton = new System.Windows.Forms.Button();
 			this.folderBrowserDialog1 = new System.Windows.Forms.FolderBrowserDialog();
-			this.LogBox = new System.Windows.Forms.TextBox();
+			this.button1 = new System.Windows.Forms.Button();
-			this.BrowseLog = new System.Windows.Forms.Button();
+			this.label1 = new System.Windows.Forms.Label();
-			this.LogDescription = new System.Windows.Forms.Label();
+			this.toolTip1 = new System.Windows.Forms.ToolTip(this.components);
 			this.tabControl1.SuspendLayout();
 			this.tabPage1.SuspendLayout();
 			this.tabPage12.SuspendLayout();
@@ -3019,6 +3023,37 @@
 			this.tabPage7.Text = "Tools";
 			this.tabPage7.UseVisualStyleBackColor = true;
 			// 
+			// LogDescription
+			// 
+			this.LogDescription.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
+			this.LogDescription.AutoSize = true;
+			this.LogDescription.Location = new System.Drawing.Point(474, 175);
+			this.LogDescription.Name = "LogDescription";
+			this.LogDescription.Size = new System.Drawing.Size(65, 13);
+			this.LogDescription.TabIndex = 148;
+			this.LogDescription.Text = "Debug Logs";
+			// 
+			// BrowseLog
+			// 
+			this.BrowseLog.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
+			this.BrowseLog.Image = ((System.Drawing.Image)(resources.GetObject("BrowseLog.Image")));
+			this.BrowseLog.Location = new System.Drawing.Point(442, 171);
+			this.BrowseLog.Name = "BrowseLog";
+			this.BrowseLog.Size = new System.Drawing.Size(26, 23);
+			this.BrowseLog.TabIndex = 147;
+			this.BrowseLog.UseVisualStyleBackColor = true;
+			this.BrowseLog.Click += new System.EventHandler(this.BrowseLog_Click);
+			// 
+			// LogBox
+			// 
+			this.LogBox.AcceptsReturn = true;
+			this.LogBox.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) 
+            | System.Windows.Forms.AnchorStyles.Right)));
+			this.LogBox.Location = new System.Drawing.Point(13, 171);
+			this.LogBox.Name = "LogBox";
+			this.LogBox.Size = new System.Drawing.Size(421, 20);
+			this.LogBox.TabIndex = 146;
+			// 
 			// MovieBackupsBox
 			// 
 			this.MovieBackupsBox.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) 
@@ -3101,36 +3136,25 @@
 			this.SaveButton.UseVisualStyleBackColor = true;
 			this.SaveButton.Click += new System.EventHandler(this.SaveButton_Click);
 			// 
-			// LogBox
+			// button1
 			// 
-			this.LogBox.AcceptsReturn = true;
+			this.button1.Image = global::BizHawk.MultiClient.Properties.Resources.Help;
-			this.LogBox.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) 
+			this.button1.Location = new System.Drawing.Point(459, 57);
-            | System.Windows.Forms.AnchorStyles.Right)));
+			this.button1.Name = "button1";
-			this.LogBox.Location = new System.Drawing.Point(13, 171);
+			this.button1.Size = new System.Drawing.Size(26, 23);
-			this.LogBox.Name = "LogBox";
+			this.button1.TabIndex = 203;
-			this.LogBox.Size = new System.Drawing.Size(421, 20);
+			this.toolTip1.SetToolTip(this.button1, "A list of special symbols useable for paths");
-			this.LogBox.TabIndex = 146;
+			this.button1.UseVisualStyleBackColor = true;
+			this.button1.Click += new System.EventHandler(this.button1_Click);
 			// 
-			// BrowseLog
+			// label1
 			// 
-			this.BrowseLog.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
+			this.label1.AutoSize = true;
-			this.BrowseLog.Image = ((System.Drawing.Image)(resources.GetObject("BrowseLog.Image")));
+			this.label1.Location = new System.Drawing.Point(491, 64);
-			this.BrowseLog.Location = new System.Drawing.Point(442, 171);
+			this.label1.Name = "label1";
-			this.BrowseLog.Name = "BrowseLog";
+			this.label1.Size = new System.Drawing.Size(97, 13);
-			this.BrowseLog.Size = new System.Drawing.Size(26, 23);
+			this.label1.TabIndex = 204;
-			this.BrowseLog.TabIndex = 147;
+			this.label1.Text = "Special Commands";
-			this.BrowseLog.UseVisualStyleBackColor = true;
-			this.BrowseLog.Click += new System.EventHandler(this.BrowseLog_Click);
-			// 
-			// LogDescription
-			// 
-			this.LogDescription.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
-			this.LogDescription.AutoSize = true;
-			this.LogDescription.Location = new System.Drawing.Point(474, 175);
-			this.LogDescription.Name = "LogDescription";
-			this.LogDescription.Size = new System.Drawing.Size(65, 13);
-			this.LogDescription.TabIndex = 148;
-			this.LogDescription.Text = "Debug Logs";
 			// 
 			// PathConfig
 			// 
@@ -3139,6 +3163,8 @@
 			this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
 			this.CancelButton = this.Cancel;
 			this.ClientSize = new System.Drawing.Size(599, 449);
+			this.Controls.Add(this.label1);
+			this.Controls.Add(this.button1);
 			this.Controls.Add(this.SaveButton);
 			this.Controls.Add(this.RecentForROMs);
 			this.Controls.Add(this.BasePathBox);
@@ -3442,5 +3468,8 @@
 		private System.Windows.Forms.Label LogDescription;
 		private System.Windows.Forms.Button BrowseLog;
 		private System.Windows.Forms.TextBox LogBox;
+		private System.Windows.Forms.Button button1;
+		private System.Windows.Forms.Label label1;
+		private System.Windows.Forms.ToolTip toolTip1;
     }
 }

BizHawk.MultiClient/config/PathConfig.cs

@@ -747,5 +747,10 @@ namespace BizHawk.MultiClient
 		{
 			BrowseFolder(LogBox, LogDescription.Text);
 		}
+
+		private void button1_Click(object sender, EventArgs e)
+		{
+			new PathInfo().Show();
+		}
 	}
 }

BizHawk.MultiClient/config/PathInfo.Designer.cs

@@ -0,0 +1,217 @@
+namespace BizHawk.MultiClient
+{
+	partial class PathInfo
+	{
+		/// <summary>
+		/// Required designer variable.
+		/// </summary>
+		private System.ComponentModel.IContainer components = null;
+
+		/// <summary>
+		/// Clean up any resources being used.
+		/// </summary>
+		/// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
+		protected override void Dispose(bool disposing)
+		{
+			if (disposing && (components != null))
+			{
+				components.Dispose();
+			}
+			base.Dispose(disposing);
+		}
+
+		#region Windows Form Designer generated code
+
+		/// <summary>
+		/// Required method for Designer support - do not modify
+		/// the contents of this method with the code editor.
+		/// </summary>
+		private void InitializeComponent()
+		{
+			this.Ok = new System.Windows.Forms.Button();
+			this.label1 = new System.Windows.Forms.Label();
+			this.label2 = new System.Windows.Forms.Label();
+			this.label3 = new System.Windows.Forms.Label();
+			this.label4 = new System.Windows.Forms.Label();
+			this.label5 = new System.Windows.Forms.Label();
+			this.label6 = new System.Windows.Forms.Label();
+			this.label7 = new System.Windows.Forms.Label();
+			this.label8 = new System.Windows.Forms.Label();
+			this.label9 = new System.Windows.Forms.Label();
+			this.label10 = new System.Windows.Forms.Label();
+			this.label11 = new System.Windows.Forms.Label();
+			this.label12 = new System.Windows.Forms.Label();
+			this.SuspendLayout();
+			// 
+			// Ok
+			// 
+			this.Ok.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right)));
+			this.Ok.DialogResult = System.Windows.Forms.DialogResult.Cancel;
+			this.Ok.Location = new System.Drawing.Point(388, 152);
+			this.Ok.Name = "Ok";
+			this.Ok.Size = new System.Drawing.Size(75, 23);
+			this.Ok.TabIndex = 0;
+			this.Ok.Text = "&Ok";
+			this.Ok.UseVisualStyleBackColor = true;
+			this.Ok.Click += new System.EventHandler(this.Ok_Click);
+			// 
+			// label1
+			// 
+			this.label1.AutoSize = true;
+			this.label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
+			this.label1.Location = new System.Drawing.Point(13, 13);
+			this.label1.Name = "label1";
+			this.label1.Size = new System.Drawing.Size(55, 15);
+			this.label1.TabIndex = 1;
+			this.label1.Text = "%recent%";
+			// 
+			// label2
+			// 
+			this.label2.AutoSize = true;
+			this.label2.Location = new System.Drawing.Point(72, 13);
+			this.label2.Name = "label2";
+			this.label2.Size = new System.Drawing.Size(210, 13);
+			this.label2.TabIndex = 2;
+			this.label2.Text = "Sets the path to the Windows Recent Path";
+			// 
+			// label3
+			// 
+			this.label3.AutoSize = true;
+			this.label3.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
+			this.label3.Location = new System.Drawing.Point(13, 33);
+			this.label3.Name = "label3";
+			this.label3.Size = new System.Drawing.Size(42, 15);
+			this.label3.TabIndex = 3;
+			this.label3.Text = "%exe%";
+			// 
+			// label4
+			// 
+			this.label4.AutoSize = true;
+			this.label4.Location = new System.Drawing.Point(72, 33);
+			this.label4.Name = "label4";
+			this.label4.Size = new System.Drawing.Size(277, 13);
+			this.label4.TabIndex = 4;
+			this.label4.Text = "Sets the path of the executable (BizHawk.MultiClient.exe)";
+			// 
+			// label5
+			// 
+			this.label5.AutoSize = true;
+			this.label5.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
+			this.label5.Location = new System.Drawing.Point(13, 68);
+			this.label5.Name = "label5";
+			this.label5.Size = new System.Drawing.Size(17, 15);
+			this.label5.TabIndex = 5;
+			this.label5.Text = ".\\";
+			// 
+			// label6
+			// 
+			this.label6.AutoSize = true;
+			this.label6.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
+			this.label6.Location = new System.Drawing.Point(13, 88);
+			this.label6.Name = "label6";
+			this.label6.Size = new System.Drawing.Size(20, 15);
+			this.label6.TabIndex = 6;
+			this.label6.Text = "..\\";
+			// 
+			// label7
+			// 
+			this.label7.AutoSize = true;
+			this.label7.Location = new System.Drawing.Point(72, 68);
+			this.label7.Name = "label7";
+			this.label7.Size = new System.Drawing.Size(150, 13);
+			this.label7.TabIndex = 7;
+			this.label7.Text = "Sets the path to the base path";
+			// 
+			// label8
+			// 
+			this.label8.AutoSize = true;
+			this.label8.Location = new System.Drawing.Point(94, 106);
+			this.label8.Name = "label8";
+			this.label8.Size = new System.Drawing.Size(368, 13);
+			this.label8.TabIndex = 8;
+			this.label8.Text = "- Setting the global base path to one of these will set it to the path of the .exe";
+			// 
+			// label9
+			// 
+			this.label9.AutoSize = true;
+			this.label9.Location = new System.Drawing.Point(94, 121);
+			this.label9.Name = "label9";
+			this.label9.Size = new System.Drawing.Size(250, 13);
+			this.label9.TabIndex = 9;
+			this.label9.Text = "- Setting a platform base will set it to the global base";
+			// 
+			// label10
+			// 
+			this.label10.AutoSize = true;
+			this.label10.Location = new System.Drawing.Point(94, 136);
+			this.label10.Name = "label10";
+			this.label10.Size = new System.Drawing.Size(262, 13);
+			this.label10.TabIndex = 10;
+			this.label10.Text = "- Setting a platform folder will set it to the platform base";
+			// 
+			// label11
+			// 
+			this.label11.AutoSize = true;
+			this.label11.Location = new System.Drawing.Point(94, 151);
+			this.label11.Name = "label11";
+			this.label11.Size = new System.Drawing.Size(238, 13);
+			this.label11.TabIndex = 11;
+			this.label11.Text = "- Setting a tools folder will set it to the global base";
+			// 
+			// label12
+			// 
+			this.label12.AutoSize = true;
+			this.label12.Location = new System.Drawing.Point(72, 88);
+			this.label12.Name = "label12";
+			this.label12.Size = new System.Drawing.Size(230, 13);
+			this.label12.TabIndex = 12;
+			this.label12.Text = "Sets the path to the folder above the base path";
+			// 
+			// PathInfo
+			// 
+			this.AcceptButton = this.Ok;
+			this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
+			this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
+			this.CancelButton = this.Ok;
+			this.ClientSize = new System.Drawing.Size(466, 177);
+			this.Controls.Add(this.label12);
+			this.Controls.Add(this.label11);
+			this.Controls.Add(this.label10);
+			this.Controls.Add(this.label9);
+			this.Controls.Add(this.label8);
+			this.Controls.Add(this.label7);
+			this.Controls.Add(this.label6);
+			this.Controls.Add(this.label5);
+			this.Controls.Add(this.label4);
+			this.Controls.Add(this.label3);
+			this.Controls.Add(this.label2);
+			this.Controls.Add(this.label1);
+			this.Controls.Add(this.Ok);
+			this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
+			this.MaximizeBox = false;
+			this.MinimizeBox = false;
+			this.Name = "PathInfo";
+			this.ShowIcon = false;
+			this.Text = "Special Commands";
+			this.ResumeLayout(false);
+			this.PerformLayout();
+
+		}
+
+		#endregion
+
+		private System.Windows.Forms.Button Ok;
+		private System.Windows.Forms.Label label1;
+		private System.Windows.Forms.Label label2;
+		private System.Windows.Forms.Label label3;
+		private System.Windows.Forms.Label label4;
+		private System.Windows.Forms.Label label5;
+		private System.Windows.Forms.Label label6;
+		private System.Windows.Forms.Label label7;
+		private System.Windows.Forms.Label label8;
+		private System.Windows.Forms.Label label9;
+		private System.Windows.Forms.Label label10;
+		private System.Windows.Forms.Label label11;
+		private System.Windows.Forms.Label label12;
+	}
+}

BizHawk.MultiClient/config/PathInfo.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Data;
+using System.Drawing;
+using System.Linq;
+using System.Text;
+using System.Windows.Forms;
+
+namespace BizHawk.MultiClient
+{
+	public partial class PathInfo : Form
+	{
+		public PathInfo()
+		{
+			InitializeComponent();
+		}
+
+		private void Ok_Click(object sender, EventArgs e)
+		{
+			Close();
+		}
+	}
+}

BizHawk.MultiClient/config/PathInfo.resx

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!-- 
+    Microsoft ResX Schema 
+    
+    Version 2.0
+    
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+    
+    Example:
+    
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+                
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+    
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+    
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+    
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+    
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+    
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+</root>