bitburner-src/utils/StringHelperFunctions.ts

159 lines
5.3 KiB
TypeScript
Raw Normal View History

import { EqualityFunc } from "../src/types";
import { dialogBoxCreate } from "./DialogBox";
2018-06-25 02:55:43 +02:00
// Netburner String helper functions
2018-06-25 02:55:43 +02:00
// Replaces the character at an index with a new character
2018-06-22 23:30:24 +02:00
function replaceAt(base: string, index: number, character: string): string {
2018-06-25 02:55:43 +02:00
return base.substr(0, index) + character + base.substr(index + character.length);
2017-02-06 06:01:01 +01:00
}
2018-06-25 02:55:43 +02:00
/*
Converts a date representing time in milliseconds to a string with the format H hours M minutes and S seconds
e.g. 10000 -> "0 hours 0 minutes and 10 seconds"
120000 -> "0 0 hours 2 minutes and 0 seconds"
*/
2018-06-22 23:30:24 +02:00
function convertTimeMsToTimeElapsedString(time: number): string {
const millisecondsPerSecond: number = 1000;
const secondPerMinute: number = 60;
const minutesPerHours: number = 60;
2018-06-25 02:55:43 +02:00
const secondPerHours: number = secondPerMinute * minutesPerHours;
const hoursPerDays: number = 24;
2018-06-25 02:55:43 +02:00
const secondPerDay: number = secondPerHours * hoursPerDays;
// Convert ms to seconds, since we only have second-level precision
const totalSeconds: number = Math.floor(time / millisecondsPerSecond);
2018-06-25 02:55:43 +02:00
const days: number = Math.floor(totalSeconds / secondPerDay);
const secTruncDays: number = totalSeconds % secondPerDay;
2018-06-25 02:55:43 +02:00
const hours: number = Math.floor(secTruncDays / secondPerHours);
const secTruncHours: number = secTruncDays % secondPerHours;
2018-06-25 02:55:43 +02:00
const minutes: number = Math.floor(secTruncHours / secondPerMinute);
const secTruncMinutes: number = secTruncHours % secondPerMinute;
2018-06-25 02:55:43 +02:00
const seconds: number = secTruncMinutes;
let res: string = "";
if (days > 0) {res += `${days} days `; }
if (hours > 0) {res += `${hours} hours `; }
if (minutes > 0) {res += `${minutes} minutes `; }
2018-06-25 02:55:43 +02:00
res += `${seconds} seconds `;
return res;
}
2018-06-25 02:55:43 +02:00
// Finds the longest common starting substring in a set of strings
2018-06-22 23:30:24 +02:00
function longestCommonStart(strings: string[]): string {
2018-06-25 02:55:43 +02:00
if (!containsAllStrings(strings)) {return ""; }
if (strings.length === 0) {return ""; }
2018-06-25 02:55:43 +02:00
const A: string[] = strings.concat().sort();
2018-06-25 02:55:43 +02:00
const a1: string = A[0];
const a2: string = A[A.length - 1];
const L: number = a1.length;
let i: number = 0;
const areEqualCaseInsensitive: EqualityFunc<string> = (a: string, b: string) => a.toUpperCase() === b.toUpperCase();
while (i < L && areEqualCaseInsensitive(a1.charAt(i), a2.charAt(i))) {
i++;
}
2018-06-25 02:55:43 +02:00
return a1.substring(0, i);
}
2018-06-25 02:55:43 +02:00
// Returns whether a variable is a string
2018-06-22 23:30:24 +02:00
function isString(str: any): boolean {
2018-06-25 02:55:43 +02:00
return (typeof str === "string" || str instanceof String);
}
2018-06-25 02:55:43 +02:00
// Returns whether an array contains entirely of string objects
2018-06-22 23:30:24 +02:00
function containsAllStrings(arr: string[]): boolean {
return arr.every(isString);
}
2018-06-25 02:55:43 +02:00
// Formats a number with commas and a specific number of decimal digits
2018-06-22 23:30:24 +02:00
function formatNumber(num: number, numFractionDigits: number): string {
return num.toLocaleString(undefined, {
2018-06-25 02:55:43 +02:00
maximumFractionDigits: numFractionDigits,
minimumFractionDigits: numFractionDigits,
});
}
2018-06-25 02:55:43 +02:00
// Count the number of times a substring occurs in a string
2018-06-22 23:30:24 +02:00
function numOccurrences(text: string, subString: string): number {
const input: string = `${text}`;
const search: string = `${subString}`;
if (search.length <= 0) { return (input.length + 1); }
let n: number = 0;
let pos: number = 0;
const step: number = search.length;
while (true) {
pos = input.indexOf(search, pos);
if (pos >= 0) {
++n;
pos += step;
2018-06-25 02:55:43 +02:00
} else { break; }
}
2018-06-25 02:55:43 +02:00
return n;
2017-05-15 17:38:17 +02:00
}
2018-06-25 02:55:43 +02:00
// Counters the number of Netscript operators in a string
2018-06-22 23:30:24 +02:00
function numNetscriptOperators(text: string): number {
const total: number = numOccurrences(text, "+") +
numOccurrences(text, "-") +
numOccurrences(text, "*") +
numOccurrences(text, "/") +
numOccurrences(text, "%") +
numOccurrences(text, "&&") +
numOccurrences(text, "||") +
numOccurrences(text, "<") +
numOccurrences(text, ">") +
numOccurrences(text, "<=") +
numOccurrences(text, ">=") +
numOccurrences(text, "==") +
numOccurrences(text, "!=");
2017-05-15 17:38:17 +02:00
if (isNaN(total)) {
// tslint:disable-next-line:max-line-length
const message: string = "ERROR in counting number of operators in script. This is a bug, please report to game developer";
2018-06-25 02:55:43 +02:00
dialogBoxCreate(message, false);
2018-06-22 23:30:24 +02:00
return 0;
2017-05-15 17:38:17 +02:00
}
2018-06-25 02:55:43 +02:00
2017-05-15 17:38:17 +02:00
return total;
}
2018-06-25 02:55:43 +02:00
// Checks if a string contains HTML elements
2018-06-22 23:30:24 +02:00
function isHTML(str: string): boolean {
const element: HTMLDivElement = document.createElement("div");
element.innerHTML = str;
const c: NodeListOf<Node & ChildNode> = element.childNodes;
for (let i: number = c.length-1; i >= 0; i--) {
if (c[i].nodeType === 1) {
return true;
}
2017-09-15 16:06:59 +02:00
}
2018-06-25 02:55:43 +02:00
2017-09-15 16:06:59 +02:00
return false;
}
2018-06-25 02:55:43 +02:00
// Generates a random alphanumeric string with N characters
2018-06-22 23:30:24 +02:00
function generateRandomString(n: number): string {
let str: string = "";
const chars: string = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
for (let i: number = 0; i < n; i++) {
str += chars.charAt(Math.floor(Math.random() * chars.length));
2018-06-25 02:55:43 +02:00
}
return str;
}
2018-06-25 02:55:43 +02:00
export {convertTimeMsToTimeElapsedString, longestCommonStart,
2018-03-27 02:46:21 +02:00
isString, containsAllStrings, formatNumber,
2018-06-22 23:30:24 +02:00
numOccurrences, numNetscriptOperators, isHTML, generateRandomString, replaceAt};