DebuggingTools.py

# -*- coding: utf-8 -*-
# cython: language_level = 3
"""
一些调试用MCF命令生成器
"""


# import json
#
# from Constant import Flags
# from Constant import RawJsons
# from Constant import ScoreBoards
#
#
# def IF_FLAG(flag: str, cmd: str, *, line_break: bool = False) -> str:
#     """
#     如果标记位等于True标记位, 则执行 cmd
#
#     :param flag: 标志名
#     :type flag: str
#     :param cmd: 条件成立时执行的命令
#     :type cmd: str
#     :param line_break: 是否换行
#     :type line_break: bool
#     :return: 生成的命令
#     :rtype: str
#     """
#     command = f"execute if score {flag} {ScoreBoards.Flags} = {Flags.TRUE} {ScoreBoards.Flags} run {cmd}"
#     if line_break:
#         command += "\n"
#
#     return command
#
#
# ENABLE_DEBUGGING: bool = False
#
#
# def DEBUG_OBJECTIVE(
#         raw_json: dict = None, *,
#         objective: str, name: str,
#         from_objective: str = None, from_name: str = None
# ) -> str:
#     """
#     生成运行时显示调试值的命令
#
#     :param raw_json: 源JSON文本
#     :type raw_json: dict
#     :param objective: 目标计分项
#     :type objective: str
#     :param name: 计分目标
#     :type name: str
#     :param from_objective: 源积分项
#     :type from_objective: str
#     :param from_name: 源计分目标
#     :type from_name: str
#     :return: 生成的命令
#     :rtype: str
#     """
#     if not ENABLE_DEBUGGING:
#         return ''
#
#     if raw_json is None:
#         raw_json = {"text": ""}
#
#     if (from_objective is not None) ^ (from_name is not None):
#         raise Exception("from_objective 和 from_name 必须同时传入")
#
#     from_details: list[dict] = []
#
#     if from_objective is not None:
#         from_details.append({"text": " --From: ", "bold": True, "color": "gold"})
#         from_details.append({"text": from_objective, "color": "dark_purple"})
#         from_details.append({"text": " | ", "bold": True, "color": "gold"})
#         from_details.append({"text": from_name, "color": "dark_aqua"})
#         from_details.append({"text": " | ", "bold": True, "color": "gold"})
#         from_details.append({"score": {"name": from_name, "objective": from_objective}, "color": "green"})
#
#     debug_prefix = RawJsons.Prefix
#     debug_prefix["italic"] = True
#     debug_prefix["color"] = "gray"
#
#     json_txt = json.dumps({
#         "text": "",
#         "extra": [
#             debug_prefix,
#             {"text": " "},
#             {"text": "[DEBUG]", "color": "gray", "italic": True},
#             {"text": " "},
#             raw_json,
#             {"text": objective, "color": "dark_purple"},
#             {"text": " | ", "bold": True, "color": "gold"},
#             {"text": name, "color": "dark_aqua"},
#             {"text": " | ", "bold": True, "color": "gold"},
#             {"score": {"name": name, "objective": objective}, "color": "green"},
#             *from_details
#         ]
#     })
#     return f'{IF_FLAG(Flags.DEBUG, f"tellraw @a {json_txt}")}\n'
#
#
# def DEBUG_TEXT(*raw_json: dict) -> str:
#     """
#     生成运行时显示调试源JSON文本的命令
#
#     :param raw_json: 源JSON文本
#     :type raw_json: dict
#     :return: 生成的命令
#     :rtype: str
#     """
#     if not ENABLE_DEBUGGING:
#         return ''
#
#     json_txt = json.dumps({
#         "text": "",
#         "extra": [
#             RawJsons.Prefix,
#             {"text": " "},
#             {"text": "[DEBUG]", "color": "gray", "italic": True},
#             {"text": " "},
#             *raw_json,
#         ]
#     })
#     return f'{IF_FLAG(Flags.DEBUG, f"tellraw @a {json_txt}")}\n'
#
#
# class DebugTip:
#     Reset = {"text": "重置: ", "color": "gold", "bold": True}
#     Set = {"text": "设置: ", "color": "gold", "bold": True}
#     Calc = {"text": "计算: ", "color": "gold", "bold": True}
#     Result = {"text": "结果: ", "color": "gold", "bold": True}
#     DelArg = {"text": "删除参数: ", "color": "gold", "bold": True}
#     Assign = {"text": "赋值: ", "color": "gold", "bold": True}
#     SetArg = {"text": "传参: ", "color": "gold", "bold": True}
#
#     Call = {"text": "调用: ", "color": "gold", "bold": True}
#     Init = {"text": "初始化: ", "color": "gold", "bold": True}
#
#     CallTemplate = {"text": "调用模板: ", "color": "gold", "bold": True}


def FORCE_COMMENT(*texts: str, **kv_texts: str) -> str:
    """
    强制生成注释文本 (可以安全的包含换行符)

    :param texts: 调试文本
    :type texts: str
    :param kv_texts: 调试键值对
    :type kv_texts: str
    :return: 生成的注释
    :rtype: str
    """
    nor_text = ' '.join(texts)
    kv_text = '\n'.join(f"{k} = {v}" for k, v in kv_texts.items())

    txt_ls = []
    if nor_text:
        txt_ls.extend(nor_text.split('\n'))
    if kv_text:
        txt_ls.extend(kv_text.split('\n'))

    ret = '\n# '.join(txt_ls)

    if ret:
        ret = f"# {ret}\n"

    return ret


__all__ = (
    # "DEBUG_OBJECTIVE",
    # "DEBUG_TEXT",
    # "DebugTip",
    "FORCE_COMMENT",
    # "ENABLE_DEBUGGING",
)