mirror of
https://github.com/fadden/6502bench.git
synced 2024-09-07 08:55:00 +00:00
In 1.5.0-dev1, as part of changes to the way label localization works, the local variable de-duplicator started checking against a filtered copy of the symbol table. Unfortunately it never re-generated the table, so a long-lived LocalVariableLookup (like the one used by LineListGen) would set up the dup map wrong and be inconsistent with other parts of the program. We now regenerate the table on every Reset(). The de-duplication stuff also had problems when opcodes and operands were double-clicked on. When the opcode is clicked, the selection should jump to the appropriate variable declaration, but it wasn't being found because the label generated in the list was in its original form. Fixed. When an instruction operand is double-clicked, the instruction operand editor opens with an "edit variable" shortcut. This was showing the de-duplicated name, which isn't necessarily a bad thing, but it was passing that value on to the DefSymbol editor, which thought it was being asked to create a new entry. Fixed. (Entering the editor through the LvTable editor works correctly, with nary a de-duplicated name in sight. You'll be forced to rename it because it'll fail the uniqueness test.) References to de-duplicated local variables were getting lost when the symbol's label was replaced (due largely to a convenient but flawed shortcut: xrefs are attached to DefSymbol objects). Fixed by linking the XrefSets. Given the many issues and their relative subtlety, I decided to make the modified names more obvious, and went back to the "_DUPn" naming strategy. (I'm also considering just making it an error and discarding conflicting entries during analysis... this is much more complicated than I expected it to be.) Quick tests can be performed in 2019-local-variables: - go to +000026, double-click on the opcode, confirm sel change - go to +000026, double-click on the operand, confirm orig name shown in shortcut and that shortcut opens editor with orig name - go to +00001a, down a line, click on PROJ_ZERO_DUP1 and confirm that it has a single reference (from +000026) - double-click on var table and confirm editing entry
150 lines
5.2 KiB
C#
150 lines
5.2 KiB
C#
/*
|
|
* Copyright 2019 faddenSoft
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
using System;
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
|
|
namespace SourceGen {
|
|
/// <summary>
|
|
/// Tracks a set of offsets that reference a single address or label.
|
|
///
|
|
/// This is used internally, when refactoring labels, as well as for the "references"
|
|
/// UI panel and label localizer.
|
|
/// </summary>
|
|
public class XrefSet : IEnumerable<XrefSet.Xref> {
|
|
/// <summary>
|
|
/// Reference type. This is mostly useful for display to the user.
|
|
/// </summary>
|
|
public enum XrefType {
|
|
Unknown = 0,
|
|
SubCallOp, // subroutine call
|
|
BranchOp, // branch instruction
|
|
RefFromData, // reference in data area, e.g. ".dd2 <address>"
|
|
MemAccessOp, // instruction that accesses memory, or refers to an address
|
|
// TODO(someday): track 16-bit vs. 24-bit addressing, so we can show whether
|
|
// something is a "far" reference (and maybe carry this into auto-label annotation)
|
|
}
|
|
|
|
/// <summary>
|
|
/// Cross-reference descriptor. Instances are immutable.
|
|
/// </summary>
|
|
public class Xref {
|
|
/// <summary>
|
|
/// Offset of start of instruction or data that refers to the target offset.
|
|
/// </summary>
|
|
public int Offset { get; private set; }
|
|
|
|
/// <summary>
|
|
/// True if this reference is by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The time this is of use is when determining the set of project/platform symbols
|
|
/// that are actually used. If we have FOO1=$101 and FOO2=$102, and we LDA FOO1
|
|
/// and LDA FOO1+1, we only want to output an equate for FOO1 even though FOO2's
|
|
/// address was referenced.
|
|
/// </remarks>
|
|
public bool IsByName { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Type of reference.
|
|
/// </summary>
|
|
public XrefType Type { get; private set; }
|
|
|
|
/// <summary>
|
|
/// For Type==MemAccessOp, what type of memory access is performed.
|
|
/// </summary>
|
|
public Asm65.OpDef.MemoryEffect AccType { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Adjustment to symbol. For example, "LDA label+2" adds an xref entry to
|
|
/// "label", with an adjustment of +2.
|
|
/// </summary>
|
|
public int Adjustment { get; private set; }
|
|
|
|
public Xref(int offset, bool isByName, XrefType type,
|
|
Asm65.OpDef.MemoryEffect accType, int adjustment) {
|
|
Offset = offset;
|
|
IsByName = isByName;
|
|
Type = type;
|
|
AccType = accType;
|
|
Adjustment = adjustment;
|
|
}
|
|
|
|
public override string ToString() {
|
|
return "Xref off=+" + Offset.ToString("x6") + " sym=" + IsByName +
|
|
" type=" + Type + " accType= " + AccType + " adj=" + Adjustment;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Internal storage for xrefs.
|
|
/// </summary>
|
|
private List<Xref> mRefs = new List<Xref>();
|
|
|
|
|
|
/// <summary>
|
|
/// Constructs an empty set.
|
|
/// </summary>
|
|
public XrefSet() { }
|
|
|
|
/// <summary>
|
|
/// Returns the number of cross-references in the set.
|
|
/// </summary>
|
|
public int Count { get { return mRefs.Count; } }
|
|
|
|
/// <summary>
|
|
/// Removes all entries from the set.
|
|
/// </summary>
|
|
public void Clear() {
|
|
mRefs.Clear();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the Nth entry in the set.
|
|
/// </summary>
|
|
public Xref this[int index] {
|
|
get {
|
|
return mRefs[index];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds an xref to the set.
|
|
/// </summary>
|
|
public void Add(Xref xref) {
|
|
// TODO(someday): not currently enforcing set behavior; start by adding .equals to
|
|
// Xref, then check Contains before allowing Add. (Should probably complain
|
|
// loudly if item already exists, since we're not expecting that.)
|
|
mRefs.Add(xref);
|
|
}
|
|
|
|
// IEnumerable
|
|
public IEnumerator GetEnumerator() {
|
|
return ((IEnumerable)mRefs).GetEnumerator();
|
|
}
|
|
|
|
// IEnumerable, generic
|
|
IEnumerator<Xref> IEnumerable<Xref>.GetEnumerator() {
|
|
return ((IEnumerable<Xref>)mRefs).GetEnumerator();
|
|
}
|
|
|
|
public override string ToString() {
|
|
return "[XrefSet count=" + Count + "]";
|
|
}
|
|
}
|
|
}
|