xref: /arkcompiler/ets_frontend/ets2panda/public/headers_parser/log_tools.py

#!/usr/bin/env python3
# coding=utf-8
#
# Copyright (c) 2024 Huawei Device Co., Ltd.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""Module provides system functions like logging and open files."""
import os

LOGGING = 0
DEBUG_LOGGING = 0
INFO_LOGGING = 1
WARNING_LOGGING = 1
ERROR_LOGGIN = 1
PARSING_LOGGING = 0


LIB_GEN_FOLDER: str = ""


def init_log(lib_gen_folder: str) -> None:
    global LIB_GEN_FOLDER  # pylint: disable=W0603
    LIB_GEN_FOLDER = lib_gen_folder
    os.makedirs(os.path.join(LIB_GEN_FOLDER, "./gen/logs"), exist_ok=True)


def debug_log(msg: str) -> None:
    if DEBUG_LOGGING:
        print(msg)


def console_log(msg: str) -> None:
    if LOGGING:
        print(msg)


def info_log(msg: str) -> None:
    if INFO_LOGGING:
        print(msg)


def warning_log(msg: str) -> None:
    path = os.path.join(LIB_GEN_FOLDER, "./gen/logs/warning_logs.txt")
    if WARNING_LOGGING:
        with os.fdopen(os.open(path, os.O_WRONLY | os.O_CREAT | os.O_APPEND, mode=511), "a", encoding="utf-8") as f:
            f.write("Warning! " + msg + "\n")


def error_log(msg: str) -> None:
    path = os.path.join(LIB_GEN_FOLDER, "./gen/logs/error_logs.txt")
    if ERROR_LOGGIN:
        with os.fdopen(os.open(path, os.O_WRONLY | os.O_CREAT | os.O_APPEND, mode=511), "a", encoding="utf-8") as f:
            f.write(msg)


def parsing_log(msg: str) -> None:
    if PARSING_LOGGING:
        print(msg)


def tmp_log(msg: str) -> None:
    print(msg)


def dump_to_file(file_name: str, msg: str) -> None:
    path = LIB_GEN_FOLDER + file_name
    with os.fdopen(os.open(path, os.O_WRONLY | os.O_CREAT, mode=511), "w", encoding="utf-8") as f:
        f.write(msg)
    console_log("Data dumped to '" + path + "'")