mirror of
https://github.com/fadden/6502bench.git
synced 2024-08-20 11:28:58 +00:00
We used to use type="String", with the sub-type indicating whether the string was null-terminated, prefixed with a length, or whatever. This didn't leave much room for specifying a character encoding, which is orthogonal to the sub-type. What we actually want is to have the type specify the string type, and then have the sub-type determine the character encoding. These sub-types can also be used with the Numeric type to specify the encoding of character operands. This change updates the enum definitions and the various bits of code that use them, but does not add any code for working with non-ASCII character encodings. The project file version number was incremented to 2, since the new FormatDescriptor serialization is mildly incompatible with the old. (Won't explode, but it'll post a complaint and ignore the stuff it doesn't recognize.) While I was at it, I finished removing DciReverse. It's still part of the 2005-string-types regression test, which currently fails because the generated source doesn't match.
150 lines
5.8 KiB
C#
150 lines
5.8 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>
|
|
/// 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>
|
|
/// Returns true if this plugin checks JSR/JSL for inline data.
|
|
/// </summary>
|
|
//bool HasInlineDataAnalyzer { get; }
|
|
|
|
/// <summary>
|
|
/// Initializes the plugin with an application reference and a buffer with file
|
|
/// data. Called before each analysis pass.
|
|
///
|
|
/// In the current implementation, the file data will be the same every time,
|
|
/// because plugins are discarded when a project is closed. However, this may
|
|
/// 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="platSyms">Platform symbols, in no particular order.</param>
|
|
void Prepare(IApplication appRef, byte[] fileData, List<PlatSym> platSyms);
|
|
}
|
|
|
|
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="noContinue">Set to true if the JSR doesn't actually return.</param>
|
|
void CheckJsr(int offset, out bool noContinue);
|
|
}
|
|
|
|
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="noContinue">Set to true if the JSL doesn't actually return.</param>
|
|
void CheckJsl(int offset, out bool noContinue);
|
|
}
|
|
|
|
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="noContinue">Set to true if the BRK doesn't actually return.</param>
|
|
void CheckBrk(int offset, out bool noContinue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Interfaces provided by the application for use by plugins.
|
|
/// </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.</returns>
|
|
bool SetInlineDataFormat(int offset, int length, DataType type,
|
|
DataSubType subType, string label);
|
|
|
|
// Might want to add:
|
|
// int AddressToOffset(int address) // returns 24-bit offset, or -1 if outside file
|
|
// int OffsetToAddress(int offset) // returns 24-bit address
|
|
// (although we could also just pass the address map in at Prepare() -- more efficient
|
|
// if this gets called frequently)
|
|
}
|
|
|
|
/// <summary>
|
|
/// Data format type.
|
|
/// </summary>
|
|
public enum DataType {
|
|
Unknown = 0,
|
|
NumericLE,
|
|
NumericBE,
|
|
StringGeneric,
|
|
Dense,
|
|
Fill
|
|
}
|
|
|
|
/// <summary>
|
|
/// Data format sub-type.
|
|
/// </summary>
|
|
public enum DataSubType {
|
|
// No sub-type specified.
|
|
None = 0,
|
|
|
|
// For NumericLE/BE
|
|
Hex,
|
|
Decimal,
|
|
Binary,
|
|
Ascii,
|
|
Address,
|
|
Symbol
|
|
}
|
|
}
|