Skip to content

Commit

Permalink
Renamed type ErrorCode to ErrorDetail
Browse files Browse the repository at this point in the history
  • Loading branch information
@lvcabral
lvcabral committed May 1, 2024
1 parent 3d67762 commit 0b1a1d7
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 52 deletions.
20 changes: 10 additions & 10 deletions src/Error.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,39 +48,39 @@ export class BrsError extends Error {
/** An error thrown when a BrightScript runtime error is encountered. */
export class RuntimeError extends BrsError {
constructor(
readonly errCode: ErrorCode,
readonly errorDetail: ErrorDetail,
location: Location,
readonly backTrace?: TracePoint[],
readonly extraFields?: Map<string, BrsType>
) {
super(errCode.message, location, backTrace);
super(errorDetail.message, location, backTrace);
}
}

/** Any error code provided by the reference brightscript implementation. */
export type ErrorCode = {
/** Any error detail provided by the reference brightscript implementation. */
export type ErrorDetail = {
/** The unique ID of the error. */
errno: number;
/** The human-readable version */
message: string;
};

/**
* Function to find the error code by the errno
* Function to find the error detail by the errno
* @param errno number of the error code
* @returns the error code
* @returns the error detail object
*/
export function findErrorCode(errno: number): ErrorCode | null {
for (const [_, value] of Object.entries(RuntimeErrorCode)) {
export function findErrorDetail(errno: number): ErrorDetail | null {
for (const [_, value] of Object.entries(RuntimeErrorDetail)) {
if (value.errno === errno) {
return value;
}
}
return null;
}

/** Enumerator with the Roku Runtime Error codes */
export const RuntimeErrorCode = {
/** Enumerator with the RBI Runtime Error codes */
export const RuntimeErrorDetail = {
NextWithoutFor: {
errno: 0,
message: "Next Without For.",
Expand Down
8 changes: 4 additions & 4 deletions src/interpreter/TypeMismatch.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BrsType, ValueKind } from "../brsTypes";
import { RuntimeError, RuntimeErrorCode } from "../Error";
import { RuntimeError, RuntimeErrorDetail } from "../Error";
import type { Location } from "../lexer";

/** Wraps up the metadata associated with a type mismatch error. */
Expand Down Expand Up @@ -29,8 +29,8 @@ export type TypeAndLocation = {
*/
export class TypeMismatch extends RuntimeError {
constructor(mismatchMetadata: TypeMismatchMetadata) {
const errCode = RuntimeErrorCode.TypeMismatch;
let errMessage = `${errCode.message} ${mismatchMetadata.message} `;
const errDetail = RuntimeErrorDetail.TypeMismatch;
let errMessage = `${errDetail.message} ${mismatchMetadata.message} `;
if (!mismatchMetadata.cast) {
errMessage += `"${ValueKind.toString(getKind(mismatchMetadata.left.type))}"`;
if (mismatchMetadata.right) {
Expand All @@ -41,7 +41,7 @@ export class TypeMismatch extends RuntimeError {
errMessage += ` to "${ValueKind.toString(getKind(mismatchMetadata.left.type))}"`;
}
errMessage += ".";
super({ errno: errCode.errno, message: errMessage }, mismatchMetadata.left.location);
super({ errno: errDetail.errno, message: errMessage }, mismatchMetadata.left.location);
}
}

Expand Down
76 changes: 38 additions & 38 deletions src/interpreter/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ import { isToken } from "../lexer/Token";
import { Expr, Stmt, ComponentScopeResolver } from "../parser";
import {
BrsError,
ErrorCode,
ErrorDetail,
RuntimeError,
RuntimeErrorCode,
findErrorCode,
RuntimeErrorDetail,
findErrorDetail,
getLoggerUsing,
} from "../Error";

Expand Down Expand Up @@ -527,7 +527,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
let val = this.evaluate(expr);
if (val.kind !== ValueKind.Int32) {
this.addError(
new RuntimeError(RuntimeErrorCode.NonNumericArrayIndex, expr.location)
new RuntimeError(RuntimeErrorDetail.NonNumericArrayIndex, expr.location)
);
}
// dim takes max-index, so +1 to get the actual array size
Expand Down Expand Up @@ -609,7 +609,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
return left.leftShift(right);
} else if (isBrsNumber(left) && isBrsNumber(right)) {
return this.addError(
new RuntimeError(RuntimeErrorCode.BadBitShift, expression.right.location)
new RuntimeError(RuntimeErrorDetail.BadBitShift, expression.right.location)
);
} else {
return this.addError(
Expand Down Expand Up @@ -637,7 +637,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
return left.rightShift(right);
} else if (isBrsNumber(left) && isBrsNumber(right)) {
return this.addError(
new RuntimeError(RuntimeErrorCode.BadBitShift, expression.right.location)
new RuntimeError(RuntimeErrorDetail.BadBitShift, expression.right.location)
);
} else {
return this.addError(
Expand Down Expand Up @@ -1045,15 +1045,15 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
throw err;
}
const btArray = this.formatBacktrace(err.location, err.backTrace);
let errCode = RuntimeErrorCode.Internal;
let errDetail = RuntimeErrorDetail.Internal;
let errMessage = err.message;
if (err instanceof RuntimeError) {
errCode = err.errCode;
errDetail = err.errorDetail;
}
const errorAA = new RoAssociativeArray([
{ name: new BrsString("backtrace"), value: btArray },
{ name: new BrsString("message"), value: new BrsString(errMessage) },
{ name: new BrsString("number"), value: new Int32(errCode.errno) },
{ name: new BrsString("number"), value: new Int32(errDetail.errno) },
{ name: new BrsString("rethrown"), value: BrsBoolean.False },
]);
if (err instanceof RuntimeError && err.extraFields?.size) {
Expand All @@ -1075,65 +1075,65 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
}

visitThrow(statement: Stmt.Throw): never {
let errCode = RuntimeErrorCode.UserDefined;
errCode.message = "";
let errDetail = RuntimeErrorDetail.UserDefined;
errDetail.message = "";
const extraFields: Map<string, BrsType> = new Map<string, BrsType>();
let toThrow = this.evaluate(statement.value);
if (isStringComp(toThrow)) {
errCode.message = toThrow.getValue();
errDetail.message = toThrow.getValue();
} else if (toThrow instanceof RoAssociativeArray) {
for (const [key, element] of toThrow.elements) {
if (key.toLowerCase() === "number") {
errCode = validateErrorNumber(element, errCode);
errDetail = validateErrorNumber(element, errDetail);
} else if (key.toLowerCase() === "message") {
errCode = validateErrorMessage(element, errCode);
errDetail = validateErrorMessage(element, errDetail);
} else if (key.toLowerCase() === "backtrace") {
if (element instanceof RoArray) {
extraFields.set("backtrace", element);
extraFields.set("rethrown", BrsBoolean.True);
} else {
errCode = RuntimeErrorCode.MalformedThrow;
errCode.message = `Thrown "backtrace" is not an object.`;
errDetail = RuntimeErrorDetail.MalformedThrow;
errDetail.message = `Thrown "backtrace" is not an object.`;
}
} else if (key.toLowerCase() !== "rethrown") {
extraFields.set(key, element);
}
if (errCode.errno === RuntimeErrorCode.MalformedThrow.errno) {
if (errDetail.errno === RuntimeErrorDetail.MalformedThrow.errno) {
extraFields.clear();
break;
}
}
} else {
errCode = RuntimeErrorCode.MalformedThrow;
errCode.message = `Thrown value neither string nor roAssociativeArray.`;
errDetail = RuntimeErrorDetail.MalformedThrow;
errDetail.message = `Thrown value neither string nor roAssociativeArray.`;
}
throw new RuntimeError(errCode, statement.location, this._stack.slice(), extraFields);
throw new RuntimeError(errDetail, statement.location, this._stack.slice(), extraFields);
// Validation Functions
function validateErrorNumber(element: BrsType, errCode: ErrorCode): ErrorCode {
function validateErrorNumber(element: BrsType, errDetail: ErrorDetail): ErrorDetail {
if (element instanceof Int32) {
errCode.errno = element.getValue();
if (errCode.message === "") {
const foundErr = findErrorCode(element.getValue());
errCode.message = foundErr ? foundErr.message : "UNKNOWN ERROR";
errDetail.errno = element.getValue();
if (errDetail.message === "") {
const foundErr = findErrorDetail(element.getValue());
errDetail.message = foundErr ? foundErr.message : "UNKNOWN ERROR";
}
} else if (!(element instanceof BrsInvalid)) {
return {
errno: RuntimeErrorCode.MalformedThrow.errno,
errno: RuntimeErrorDetail.MalformedThrow.errno,
message: `Thrown "number" is not an integer.`,
};
}
return errCode;
return errDetail;
}
function validateErrorMessage(element: BrsType, errCode: ErrorCode): ErrorCode {
function validateErrorMessage(element: BrsType, errDetail: ErrorDetail): ErrorDetail {
if (element instanceof BrsString) {
errCode.message = element.toString();
errDetail.message = element.toString();
} else if (!(element instanceof BrsInvalid)) {
return {
errno: RuntimeErrorCode.MalformedThrow.errno,
errno: RuntimeErrorDetail.MalformedThrow.errno,
message: `Thrown "message" is not a string.`,
};
}
return errCode;
return errDetail;
}
}

Expand Down Expand Up @@ -1175,7 +1175,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>

if (!isBrsCallable(callee)) {
this.addError(
new RuntimeError(RuntimeErrorCode.NotAFunction, expression.closingParen.location)
new RuntimeError(RuntimeErrorDetail.NotAFunction, expression.closingParen.location)
);
}

Expand Down Expand Up @@ -1227,13 +1227,13 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>

if (returnedValue && signatureKind === ValueKind.Void) {
this.addError(
new RuntimeError(RuntimeErrorCode.ReturnWithValue, returnLocation)
new RuntimeError(RuntimeErrorDetail.ReturnWithValue, returnLocation)
);
}

if (!returnedValue && signatureKind !== ValueKind.Void) {
this.addError(
new RuntimeError(RuntimeErrorCode.ReturnWithoutValue, returnLocation)
new RuntimeError(RuntimeErrorDetail.ReturnWithoutValue, returnLocation)
);
}

Expand Down Expand Up @@ -1298,15 +1298,15 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
}
} else {
this.addError(
new RuntimeError(RuntimeErrorCode.DotOnNonObject, expression.name.location)
new RuntimeError(RuntimeErrorDetail.DotOnNonObject, expression.name.location)
);
}
}

visitIndexedGet(expression: Expr.IndexedGet): BrsType {
let source = this.evaluate(expression.obj);
if (!isIterable(source)) {
this.addError(new RuntimeError(RuntimeErrorCode.UndimmedArray, expression.location));
this.addError(new RuntimeError(RuntimeErrorDetail.UndimmedArray, expression.location));
}

let index = this.evaluate(expression.index);
Expand Down Expand Up @@ -1536,7 +1536,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
let value = this.evaluate(statement.value);

if (!isIterable(source)) {
this.addError(new RuntimeError(RuntimeErrorCode.BadLHS, statement.name.location));
this.addError(new RuntimeError(RuntimeErrorDetail.BadLHS, statement.name.location));
}

try {
Expand All @@ -1552,7 +1552,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
let source = this.evaluate(statement.obj);

if (!isIterable(source)) {
this.addError(new RuntimeError(RuntimeErrorCode.BadLHS, statement.obj.location));
this.addError(new RuntimeError(RuntimeErrorDetail.BadLHS, statement.obj.location));
}

let index = this.evaluate(statement.index);
Expand Down

0 comments on commit 0b1a1d7

Please sign in to comment.