mirror of
https://github.com/fadden/6502bench.git
synced 2024-07-07 07:28:57 +00:00
836626bdc3
Basic infrastructure for taking a list of parameters from a plugin and turning it into a collection of UI controls, merging in values from a Visualization object. Doesn't yet do anything useful. WPF makes the hard things easy and the easy things hard. This was a hard thing, so it was easy to do (with some helpful sample code). Yay WPF?
256 lines
10 KiB
C#
256 lines
10 KiB
C#
/*
|
|
* Copyright 2018 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.Generic;
|
|
|
|
namespace PluginCommon {
|
|
/// <summary>
|
|
/// Extension script "plugins" must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin {
|
|
/// <summary>
|
|
/// Identification string. Contents are arbitrary, but should briefly identify the
|
|
/// purpose of the plugin, e.g. "Apple II ProDOS 8 MLI call handler". It may
|
|
/// contain version information, but should not be expected to be machine-readable.
|
|
/// </summary>
|
|
string Identifier { get; }
|
|
|
|
/// <summary>
|
|
/// Prepares the plugin for action. Called at the start of every code analysis pass.
|
|
///
|
|
/// In the current implementation, the file data will be the same every time,
|
|
/// because it doesn't change after the project is opened. However, this could
|
|
/// change if we add a descramble feature.
|
|
/// </summary>
|
|
/// <param name="appRef">Reference to application interface.</param>
|
|
/// <param name="fileData">65xx code and data.</param>
|
|
/// <param name="addrMap">Mapping between offsets and addresses.</param>
|
|
void Prepare(IApplication appRef, byte[] fileData, AddressTranslate addrTrans);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Extension scripts that want to receive the list of symbols must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin_SymbolList {
|
|
/// <summary>
|
|
/// Receives a list of the currently defined platform, project, and user symbols.
|
|
/// The list does not include auto-generated labels or local variables.
|
|
///
|
|
/// This is called immediately after Prepare(), before any other interfaces are
|
|
/// invoked, at the start of every code analysis pass.
|
|
/// </summary>
|
|
/// <param name="plSyms">Symbols available to plugins, in no particular order.</param>
|
|
void UpdateSymbolList(List<PlSymbol> plSyms);
|
|
|
|
/// <summary>
|
|
/// Handles a notification that a user symbol has been added, edited, or removed. If the
|
|
/// label is of interest to the plugin, e.g. it changes how the plugin formats code or
|
|
/// data, the app needs to know.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The application does a full re-analysis when project properties change, but not
|
|
/// when labels are edited. The CheckJsr/Jsl/Brk methods are only called during code
|
|
/// analysis, so if their behavior changes based on the presence or absence of a user
|
|
/// label then we need to tell the application that a full re-analysis is needed.
|
|
///
|
|
/// Plugins that don't care about user symbols, e.g. that just use tagged platform
|
|
/// symbols, can simply return false. (Changes to user labels that overlap with
|
|
/// project/platform symbols are detected by the app.)
|
|
/// </remarks>
|
|
/// <param name="beforeLabel">The label before the change, or empty if this is a
|
|
/// newly-added label.</param>
|
|
/// <param name="afterLabel">The label after the change, or empty if the label was
|
|
/// removed.</param>
|
|
/// <returns>True if the label change could affect the plugin's actions.</returns>
|
|
bool IsLabelSignificant(string beforeLabel, string afterLabel);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Extension scripts that want to handle inline JSRs must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin_InlineJsr {
|
|
/// <summary>
|
|
/// Checks to see if code/data near a JSR instruction should be formatted.
|
|
///
|
|
/// The file data is guaranteed to hold all bytes of the JSR (offset + 2).
|
|
/// </summary>
|
|
/// <param name="offset">Offset of the JSR instruction.</param>
|
|
/// <param name="operand">16-bit JSR operand.</param>
|
|
/// <param name="noContinue">Set to true if the JSR doesn't actually return.</param>
|
|
void CheckJsr(int offset, int operand, out bool noContinue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Extension scripts that want to handle inline JSLs must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin_InlineJsl {
|
|
/// <summary>
|
|
/// Checks to see if code/data near a JSL instruction should be formatted.
|
|
///
|
|
/// The file data is guaranteed to hold all bytes of the JSL (offset + 3).
|
|
/// </summary>
|
|
/// <param name="offset">Offset of the JSL instruction.</param>
|
|
/// <param name="operand">24-bit JSL operand.</param>
|
|
/// <param name="noContinue">Set to true if the JSL doesn't actually return.</param>
|
|
void CheckJsl(int offset, int operand, out bool noContinue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Extension scripts that want to handle inline BRKs must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin_InlineBrk {
|
|
/// <summary>
|
|
/// Checks to see if code/data near a BRK instruction should be formatted.
|
|
///
|
|
/// The file data is only guaranteed to hold the BRK opcode byte.
|
|
/// </summary>
|
|
/// <param name="offset">Offset of the BRK instruction.</param>
|
|
/// <param name="isTwoBytes">True if the CPU is configured for two-byte BRKs.</param>
|
|
/// <param name="noContinue">Set to true if the BRK doesn't actually return.</param>
|
|
void CheckBrk(int offset, bool isTwoBytes, out bool noContinue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Extension scripts that want to generate 2D visualizations must implement this interface.
|
|
/// </summary>
|
|
public interface IPlugin_Visualizer2d {
|
|
string[] GetVisGenNames();
|
|
|
|
List<VisParamDescr> GetVisGenParams(string name);
|
|
|
|
IVisualization2d ExecuteVisGen(string name, Dictionary<string, object> parms);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Visualization parameter descriptor.
|
|
/// </summary>
|
|
[Serializable]
|
|
public class VisParamDescr {
|
|
public enum SpecialMode {
|
|
None = 0, Offset
|
|
}
|
|
|
|
public string UiLabel { get; private set; }
|
|
public string Name { get; private set; }
|
|
public Type CsType { get; private set; }
|
|
public object Min { get; private set; }
|
|
public object Max { get; private set; }
|
|
public SpecialMode Special { get; private set; }
|
|
public object DefaultValue { get; private set; }
|
|
|
|
public VisParamDescr(string uiLabel, string name, Type csType, object min, object max,
|
|
SpecialMode special, object defVal) {
|
|
UiLabel = uiLabel;
|
|
Name = name;
|
|
CsType = csType;
|
|
Min = min;
|
|
Max = max;
|
|
Special = special;
|
|
DefaultValue = defVal;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Rendered 2D visualization object.
|
|
/// </summary>
|
|
public interface IVisualization2d {
|
|
int GetWidth();
|
|
int GetHeight();
|
|
int GetPixel(int x, int y); // returns ARGB value
|
|
}
|
|
|
|
/// <summary>
|
|
/// Interfaces provided by the application for use by plugins. An IApplication instance
|
|
/// is passed to the plugin as an argument Prepare().
|
|
/// </summary>
|
|
public interface IApplication {
|
|
/// <summary>
|
|
/// Sends a debug message to the application. This can be useful when debugging scripts.
|
|
/// (Use DEBUG > Show Analyzer Output to view it.)
|
|
/// </summary>
|
|
/// <param name="msg">Message to send.</param>
|
|
void DebugLog(string msg);
|
|
|
|
/// <summary>
|
|
/// Specifies operand formatting.
|
|
/// </summary>
|
|
/// <param name="offset">File offset of opcode.</param>
|
|
/// <param name="subType">Sub-type. Must be appropriate for NumericLE.</param>
|
|
/// <param name="label">Optional symbolic label.</param>
|
|
/// <returns>True if the change was made, false if it was rejected.</returns>
|
|
bool SetOperandFormat(int offset, DataSubType subType, string label);
|
|
|
|
/// <summary>
|
|
/// Formats file data as inline data.
|
|
/// </summary>
|
|
/// <param name="offset">File offset.</param>
|
|
/// <param name="length">Length of item.</param>
|
|
/// <param name="type">Type of item. Must be NumericLE, NumericBE, or Dense.</param>
|
|
/// <param name="subType">Sub-type. Must be appropriate for type.</param>
|
|
/// <param name="label">Optional symbolic label.</param>
|
|
/// <returns>True if the change was made, false if it was rejected (e.g. because
|
|
/// the area is already formatted, or contains code).</returns>
|
|
/// <exception cref="PluginException">If something is really wrong, e.g. data runs
|
|
/// off end of file.</exception>
|
|
bool SetInlineDataFormat(int offset, int length, DataType type,
|
|
DataSubType subType, string label);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Data format type.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Essentially a clone of FormatDescriptor.Type.
|
|
/// </remarks>
|
|
public enum DataType {
|
|
Unknown = 0,
|
|
NumericLE,
|
|
NumericBE,
|
|
StringGeneric,
|
|
StringReverse,
|
|
StringNullTerm,
|
|
StringL8,
|
|
StringL16,
|
|
StringDci,
|
|
Dense,
|
|
Fill
|
|
}
|
|
|
|
/// <summary>
|
|
/// Data format sub-type.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Essentially a clone of FormatDescriptor.SubType.
|
|
/// </remarks>
|
|
public enum DataSubType {
|
|
// No sub-type specified.
|
|
None = 0,
|
|
|
|
// For NumericLE/BE
|
|
Hex,
|
|
Decimal,
|
|
Binary,
|
|
Address,
|
|
Symbol,
|
|
|
|
// Strings and NumericLE/BE (single character)
|
|
Ascii,
|
|
HighAscii,
|
|
C64Petscii,
|
|
C64Screen
|
|
}
|
|
}
|