bitburner-src/utils/StringHelperFunctions.js

import {dialogBoxCreate} from "./DialogBox.js";

//Netburner String helper functions

//Searches for every occurence of searchStr within str and returns an array of the indices of
//all these occurences
function getIndicesOf(searchStr, str, caseSensitive) {
    var searchStrLen = searchStr.length;
    if (searchStrLen == 0) {
        return [];
    }
    var startIndex = 0, index, indices = [];
    if (!caseSensitive) {
        str = str.toLowerCase();
        searchStr = searchStr.toLowerCase();
    }
    while ((index = str.indexOf(searchStr, startIndex)) > -1) {
        indices.push(index);
        startIndex = index + searchStrLen;
    }
    return indices;
}

//Replaces the character at an index with a new character
String.prototype.replaceAt=function(index, character) {
    return this.substr(0, index) + character + this.substr(index+character.length);
}

//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"
function convertTimeMsToTimeElapsedString(time) {
    //Convert ms to seconds, since we only have second-level precision
    time = Math.floor(time / 1000);

    var days = Math.floor(time / 86400);
    time %= 86400;

    var hours = Math.floor(time / 3600);
    time %= 3600;

    var minutes = Math.floor(time / 60);
    time %= 60;

    var seconds = time;

    var res = "";
    if (days) {res += days + " days ";}
    if (hours) {res += hours + " hours ";}
    if (minutes) {res += minutes + " minutes ";}
    res += seconds + " seconds ";
    return res;
}

//Finds the longest common starting substring in a set of strings
function longestCommonStart(strings) {
    if (!containsAllStrings(strings)) {return;}
    if (strings.length == 0) {return;}

    var A = strings.concat().sort(),
    a1= A[0], a2= A[A.length-1], L= a1.length, i= 0;
    while(i<L && a1.charAt(i).toLowerCase() === a2.charAt(i).toLowerCase()) i++;
    return a1.substring(0, i);
}


//Returns whether a variable is a string
function isString(str) {
    return (typeof str === 'string' || str instanceof String);
}

//Returns true if string contains only digits (meaning it would be a positive number)
function isPositiveNumber(str) {
    return /^\d+$/.test(str);
}

//Returns whether an array contains entirely of string objects
function containsAllStrings(arr) {
    return arr.every(isString);
}

//Formats a number with commas and a specific number of decimal digits
function formatNumber(num, numFractionDigits) {
    return num.toLocaleString(undefined, {
        minimumFractionDigits: numFractionDigits,
        maximumFractionDigits: numFractionDigits
    });
}

//Count the number of times a substring occurs in a string
function numOccurrences(string, subString) {
    string += "";
    subString += "";
    if (subString.length <= 0) return (string.length + 1);

    var n = 0, pos = 0, step = subString.length;

    while (true) {
        pos = string.indexOf(subString, pos);
        if (pos >= 0) {
            ++n;
            pos += step;
        } else break;
    }
    return n;
}

//Counters the number of Netscript operators in a string
function numNetscriptOperators(string) {
    var total = 0;
    total += numOccurrences(string, "+");
    total += numOccurrences(string, "-");
    total += numOccurrences(string, "*");
    total += numOccurrences(string, "/");
    total += numOccurrences(string, "%");
    total += numOccurrences(string, "&&");
    total += numOccurrences(string, "||");
    total += numOccurrences(string, "<");
    total += numOccurrences(string, ">");
    total += numOccurrences(string, "<=");
    total += numOccurrences(string, ">=");
    total += numOccurrences(string, "==");
    total += numOccurrences(string, "!=");
    if (isNaN(total)) {
        dialogBoxCreate("ERROR in counting number of operators in script. This is a bug, please report to game developer");
        total = 0;
    }
    return total;
}

//Checks if a string contains HTML elements
function isHTML(str) {
    var a = document.createElement('div');
    a.innerHTML = str;
    for (var c = a.childNodes, i = c.length; i--; ) {
        if (c[i].nodeType == 1) return true;
    }
    return false;
}

export {getIndicesOf, convertTimeMsToTimeElapsedString, longestCommonStart,
        isString, isPositiveNumber, containsAllStrings, formatNumber,
        numOccurrences, numNetscriptOperators, isHTML};