From 9e82ff8b88a091908d54f70763a5bf4197afc147 Mon Sep 17 00:00:00 2001
From: Andy McFadden <fadden@fadden.com>
Date: Mon, 22 Apr 2024 15:07:54 -0700
Subject: [PATCH] Make label files look more like cc65 output

The cc65 docs say VICE labels start with '.'.  Also, output local
labels prefixed with '@', per ca65 convention.  The default output
file is now "labels.lbl".

Added some minimal documentation.

(issue #151)
---
 SourceGen/LabelFileGenerator.cs | 10 +++++++++-
 SourceGen/MainController.cs     |  4 ++--
 SourceGen/Symbol.cs             |  1 +
 docs/sgmanual/codegen.html      |  9 ++++++++-
 docs/sgmanual/index.html        |  1 +
 5 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/SourceGen/LabelFileGenerator.cs b/SourceGen/LabelFileGenerator.cs
index 7bfdfec..b70ad1d 100644
--- a/SourceGen/LabelFileGenerator.cs
+++ b/SourceGen/LabelFileGenerator.cs
@@ -70,7 +70,15 @@ namespace SourceGen {
             // VICE format is "add_label <address> <label>", but may be abbreviated "al".
             // We could also use ACME format ("labelname = $1234 ; Maybe a comment").
             foreach (Symbol sym in symList) {
-                outStream.WriteLine("al " + sym.Value.ToString("x6") + " " + sym.Label);
+                string label = sym.LabelWithoutTag;
+                if (sym.IsNonUnique) {
+                    // Use the cc65 convention for local labels.
+                    label = '@' + label;
+                }
+                // The cc65 docs (https://www.cc65.org/doc/debugging-4.html) say all labels
+                // must be prefaced with '.'.
+                label = '.' + label;
+                outStream.WriteLine("al " + sym.Value.ToString("x6") + " " + label);
             }
         }
     }
diff --git a/SourceGen/MainController.cs b/SourceGen/MainController.cs
index 59bb1e8..2dfd03e 100644
--- a/SourceGen/MainController.cs
+++ b/SourceGen/MainController.cs
@@ -2566,8 +2566,8 @@ namespace SourceGen {
             string filter;
             switch (dlg.Format) {
                 case LabelFileGenerator.LabelFmt.VICE:
-                    ext = ".vs";
-                    filter = "VICE commands (*.vs)|*.vs";
+                    ext = ".lbl";
+                    filter = "VICE labels (*.lbl)|*.lbl";
                     break;
                 default:
                     Debug.Assert(false, "bad format");
diff --git a/SourceGen/Symbol.cs b/SourceGen/Symbol.cs
index a6ef73d..48e0b5a 100644
--- a/SourceGen/Symbol.cs
+++ b/SourceGen/Symbol.cs
@@ -84,6 +84,7 @@ namespace SourceGen {
         /// <remarks>
         /// Non-unique labels have extra stuff at the end to make them unique.  That is
         /// included here, so that the Label field is still viable as a unique identifier.
+        /// Use <see cref="LabelWithoutTag"/> to get just the label.
         /// </remarks>
         public string Label { get; private set; }
 
diff --git a/docs/sgmanual/codegen.html b/docs/sgmanual/codegen.html
index c645812..051d0c1 100644
--- a/docs/sgmanual/codegen.html
+++ b/docs/sgmanual/codegen.html
@@ -385,7 +385,7 @@ clipboard and pasting them into a text file, except that you have greater
 control over which columns are included.  The HTML version is augmented
 with links and (optionally) images.</p>
 
-<p>Use File &gt; Export to open the export dialog.  You have several
+<p>Use <samp>File &gt; Export</samp> to open the export dialog.  You have several
 options:</p>
 <ul>
   <li><b>Include only selected lines</b>.  This allows you to choose between
@@ -425,6 +425,13 @@ will be written to the same directory.</p>
 <p>All output uses UTF-8 encoding.  Filenames of HTML files will have '#'
 replaced with '_' to make linking easier.</p>
 
+
+<h2 id="generate-labels">Generating Label Files</h2>
+<p>Some debuggers allow the import of labels associated with addresses.
+To generate such a file, use <samp>File &gt; Generate Label File</samp>.</p>
+<p>Select the desired output format (currently only VICE label commands
+are supported), and whether or not to include auto-generated labels.</p>
+
 </div>
 
 <div id="footer">
diff --git a/docs/sgmanual/index.html b/docs/sgmanual/index.html
index 2a3b3ae..2719efc 100644
--- a/docs/sgmanual/index.html
+++ b/docs/sgmanual/index.html
@@ -140,6 +140,7 @@ using the <samp>Help &gt; Help</samp> menu item or by hitting
       </ul></li>
     </ul></li>
     <li><a href="codegen.html#export-source">Exporting Source Code</a>
+    <li><a href="codegen.html#generate-labels">Generating Label Files</a>
   </ul></li>
 
   <li><a href="settings.html">Properties &amp; Settings</a>