All files / src/shared/lib/scriptValue types.ts

94.56% Statements 87/92
91.95% Branches 80/87
92.3% Functions 12/13
93.67% Lines 74/79

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478  113x   113x                             113x     113x                                                   113x                     113x                 113x 2x   113x 2x   113x     71x   113x                                       113x 2x                                                     113x     98x 8x   90x 90x                               113x     48x                                                                                                                                                                               113x                             113x 207x 18x   189x     189x 71x     118x       118x 6x     112x 26x     86x 6x     80x 21x             59x 4x     55x 3x     52x     52x 3x           49x 33x         16x 8x   8x       8x     113x     47x 1x   46x   46x 42x     4x       3x   1x               113x     1860x               113x     6x               113x     2405x           113x           113x           2x     2x   2x 1x   1x                                                                                                                                                     113x  
import type { ScriptBuilderFunctionArg } from "lib/compiler/scriptBuilder/types";
import { ensureTypeGenerator } from "shared/types";
 
export const valueAtomTypes = [
  "number",
  "numberSymbol",
  "direction",
  "variable",
  "indirect",
  "constant",
  "property",
  "expression",
  "engineField",
  "true",
  "false",
] as const;
export type ValueAtomType = (typeof valueAtomTypes)[number];
 
export const constValueAtomTypes = ["number", "constant"] as const;
export type ConstValueAtomType = (typeof constValueAtomTypes)[number];
 
export const valueOperatorTypes = [
  "add",
  "sub",
  "mul",
  "div",
  "mod",
  "min",
  "max",
  "eq",
  "ne",
  "gt",
  "gte",
  "lt",
  "lte",
  "and",
  "or",
  "atan2",
  // Bitwise
  "shl",
  "shr",
  "bAND",
  "bOR",
  "bXOR",
] as const;
export type ValueOperatorType = (typeof valueOperatorTypes)[number];
 
export const valueUnaryOperatorTypes = [
  "rnd",
  "not",
  "isqrt",
  "abs",
  "neg",
  // Bitwise
  "bNOT",
] as const;
export type ValueUnaryOperatorType = (typeof valueUnaryOperatorTypes)[number];
 
export const valueArrayOperationTypes = ["len"] as const;
export type ValueArrayOperationType = (typeof valueArrayOperationTypes)[number];
 
export type ValueType =
  | ValueAtomType
  | ValueOperatorType
  | ValueUnaryOperatorType
  | ValueArrayOperationType;
 
export const isValueAtomType = (type: unknown): type is ValueAtomType =>
  valueAtomTypes.includes(type as ValueAtomType);
 
export const isValueOperatorType = (type: unknown): type is ValueOperatorType =>
  valueOperatorTypes.includes(type as ValueOperatorType);
 
export const isValueUnaryOperatorType = (
  type: unknown,
): type is ValueUnaryOperatorType =>
  valueUnaryOperatorTypes.includes(type as ValueUnaryOperatorType);
 
const infixOperators = [
  "add",
  "sub",
  "mul",
  "div",
  "mod",
  "eq",
  "ne",
  "gt",
  "gte",
  "lt",
  "lte",
  "and",
  "or",
  "shl",
  "shr",
  "bAND",
  "bOR",
  "bXOR",
];
export const isInfix = (type: ValueOperatorType) =>
  infixOperators.includes(type);
 
export type RPNUnaryOperation = {
  type: ValueUnaryOperatorType;
  value: ScriptValue;
};
 
export type RPNOperation = {
  type: ValueOperatorType;
  valueA: ScriptValue;
  valueB: ScriptValue;
};
 
export type RPNArrayOperation = {
  type: ValueArrayOperationType;
  value: {
    type: "variable";
    value: string;
  };
};
 
export type ScriptValueVariable = {
  type: "variable";
  value: string;
  index?: ScriptValue;
};
 
export const isScriptValueVariable = (
  value: unknown,
): value is ScriptValueVariable => {
  if (!value || typeof value !== "object") {
    return false;
  }
  const variable = value as ScriptValueVariable;
  return (
    variable.type === "variable" &&
    typeof variable.value === "string" &&
    (variable.index === undefined || isScriptValue(variable.index))
  );
};
 
export type ScriptVariableElement = {
  type: "variable";
  value: string;
  index?: {
    type: "number";
    value: number;
  };
};
 
export const isScriptVariableElement = (
  value: unknown,
): value is ScriptVariableElement =>
  isScriptValueVariable(value) &&
  (value.index === undefined || value.index.type === "number");
 
export type ScriptValueAtom =
  | {
      type: "number";
      value: number;
    }
  | {
      type: "numberSymbol";
      value: string;
    }
  | ScriptValueVariable
  | {
      type: "constant";
      value: string;
    }
  | {
      type: "direction";
      value: string;
    }
  | {
      type: "indirect";
      value: string;
    }
  | {
      type: "property";
      target: string;
      property: string;
    }
  | {
      type: "expression";
      value: string;
    }
  | {
      type: "engineField";
      value: string;
    }
  | {
      type: "true";
    }
  | {
      type: "false";
    };
 
export type ConstScriptValueAtom =
  | {
      type: "number";
      value: number;
    }
  | {
      type: "constant";
      value: string;
    };
 
export type ScriptValue =
  RPNOperation | RPNUnaryOperation | RPNArrayOperation | ScriptValueAtom;
 
export type ConstScriptValue = ConstScriptValueAtom;
 
export type ValueFunctionMenuItem = {
  value: ValueOperatorType;
  label: string;
  symbol: string;
};
 
type OptimisedScriptValueAtom = Exclude<
  ScriptValueAtom,
  { type: "expression" }
>;
 
export type OptimisedScriptValue =
  | RPNOperationWithOptimisedValues
  | RPNUnaryOperationWithOptimisedValue
  | RPNArrayOperation
  | OptimisedScriptValueAtom;
 
type RPNOperationWithOptimisedValues = {
  type: ValueOperatorType;
  valueA: OptimisedScriptValue;
  valueB: OptimisedScriptValue;
};
 
type RPNUnaryOperationWithOptimisedValue = {
  type: ValueUnaryOperatorType;
  value: OptimisedScriptValue;
};
 
const validProperties = [
  "xpos",
  "ypos",
  "pxpos",
  "pypos",
  "direction",
  "frame",
  "xdeadzone",
  "ydeadzone",
  "xoffset",
  "yoffset",
  "xscroll",
  "yscroll",
];
 
export const isScriptValue = (value: unknown): value is ScriptValue => {
  if (!value || typeof value !== "object") {
    return false;
  }
  const scriptValue = value as ScriptValue;
 
  // Is a number
  if (scriptValue.type === "number") {
    return typeof scriptValue.value === "number";
  }
  // Is a number symbol
  Iif (scriptValue.type === "numberSymbol") {
    return typeof scriptValue.value === "string";
  }
  // Is bool
  if (scriptValue.type === "true" || scriptValue.type === "false") {
    return true;
  }
  // Is Variable
  if (scriptValue.type === "variable") {
    return isScriptValueVariable(scriptValue);
  }
  // Is Constant
  if (scriptValue.type === "constant") {
    return typeof scriptValue.value === "string";
  }
  // Is Property
  if (scriptValue.type === "property") {
    return (
      typeof scriptValue.target === "string" &&
      typeof scriptValue.property === "string" &&
      validProperties.includes(scriptValue.property)
    );
  }
  // Is Expression
  if (scriptValue.type === "expression") {
    return typeof scriptValue.value === "string";
  }
  // Is Engine Field
  if (scriptValue.type === "engineField") {
    return typeof scriptValue.value === "string";
  }
  // Is Direction
  Iif (scriptValue.type === "direction") {
    return typeof scriptValue.value === "string";
  }
  if (scriptValue.type === "len") {
    return (
      scriptValue.value?.type === "variable" &&
      typeof scriptValue.value.value === "string" &&
      !("index" in scriptValue.value)
    );
  }
  if (isValueOperation(scriptValue)) {
    return (
      (isScriptValue(scriptValue.valueA) || !scriptValue.valueA) &&
      (isScriptValue(scriptValue.valueB) || !scriptValue.valueB)
    );
  }
  if (isUnaryOperation(scriptValue)) {
    return isScriptValue(scriptValue.value) || !scriptValue.value;
  }
  Iif (scriptValue.type === "indirect") {
    return true;
  }
 
  return false;
};
 
export const isConstScriptValue = (
  value: unknown,
): value is ConstScriptValue => {
  if (!value || typeof value !== "object") {
    return false;
  }
  const scriptValue = value as ConstScriptValue;
  // Is a number
  if (scriptValue.type === "number" && typeof scriptValue.value === "number") {
    return true;
  }
  // Is a constant
  if (
    scriptValue.type === "constant" &&
    typeof scriptValue.value === "string"
  ) {
    return true;
  }
  return false;
};
 
export type ScriptValueFunction = ScriptValue & { type: ValueOperatorType };
export type ScriptValueUnaryOperation = ScriptValue & {
  type: ValueUnaryOperatorType;
};
 
export const isUnaryOperation = (
  value?: ScriptValue,
): value is ScriptValueUnaryOperation => {
  return (
    !!value &&
    valueUnaryOperatorTypes.includes(
      value.type as unknown as ValueUnaryOperatorType,
    )
  );
};
 
export const isArrayOperation = (
  value?: ScriptValue,
): value is RPNArrayOperation => {
  return (
    !!value &&
    valueArrayOperationTypes.includes(
      value.type as unknown as ValueArrayOperationType,
    )
  );
};
 
export const isValueOperation = (
  value?: ScriptValue,
): value is ScriptValueFunction => {
  return (
    !!value &&
    valueOperatorTypes.includes(value.type as unknown as ValueOperatorType)
  );
};
 
export const isValueAtom = (value?: ScriptValue): value is ScriptValueAtom => {
  return (
    !!value && valueAtomTypes.includes(value.type as unknown as ValueAtomType)
  );
};
 
export const isValueNumber = (
  value: unknown,
): value is {
  type: "number";
  value: number;
} => {
  Iif (!value || typeof value !== "object") {
    return false;
  }
  const scriptValue = value as ScriptValue;
  // Is a number
  if (scriptValue.type === "number" && typeof scriptValue.value === "number") {
    return true;
  }
  return false;
};
 
export type PrecompiledValueFetch = {
  local: string;
  value:
    | {
        type: "actorPosition";
        target: string | ScriptBuilderFunctionArg;
      }
    | {
        type: "actorDirection";
        target: string | ScriptBuilderFunctionArg;
      }
    | {
        type: "actorFrame";
        target: string | ScriptBuilderFunctionArg;
      }
    | {
        type: "engineField";
        value: string;
      };
};
 
export type PrecompiledValueRPNOperation =
  | {
      type: "number";
      value: number;
    }
  | {
      type: "numberSymbol";
      value: string;
    }
  | {
      type: "constant";
      value: string;
    }
  | {
      type: "variable";
      value: string;
      index?: ScriptValue;
    }
  | {
      type: "direction";
      value: string;
    }
  | {
      type: "indirect";
      value: string;
    }
  | {
      type: "local";
      value: string;
      offset?: number;
    }
  | {
      type: "memI16";
      value: string;
    }
  | {
      type: "memU8";
      value: string;
    }
  | {
      type: "memI8";
      value: string;
    }
  | {
      type: "len";
      value: string;
    }
  | {
      type: ValueOperatorType | ValueUnaryOperatorType;
    };
 
export const ensureScriptValue = ensureTypeGenerator(isScriptValue);