"""DarkPoint's helper functions toolset file"""

# DarkPoint: technomantic memories framework for mnemonic forrests in darkness
# Copyright (C) 2024   Sett Sarverott <sett@sarverott.com> (https://sarverott.com)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.


def multirange(*args):
    """allows to quickly make combined list with more than one range"""
    return [
        x for y in [
            list(range(*z)) for z in args
        ] for x in y
    ]


def default_hard_chars_replacing():
    """default replacing matrix"""
    return [
        ["\n", "\\n"],
        ["'", "\\'"],
        ['"', '\\"'],
        ["\b", "\\b"],
        ["\0", "\\0"],
        ["\t", "\\t"],
        ["\r", "\\r"],
        ["\\", "\\\\"],
    ]


def soft_string(input_str, hard_char_replacing=None):
    """replaces hard escaping chars with softer backslashed versions"""
    output_str = None  # better return nothing to indicade error

    if hard_char_replacing is None:
        hard_char_replacing = default_hard_chars_replacing()

    for replacement in hard_char_replacing:

        if output_str is None:
            output_str = input_str

        output_str = output_str.replace(replacement[0], replacement[1])

    return output_str