ccLog.cpp

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#include <pybind11/native_enum.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <pybind11/stl_bind.h>
 
#include "../casters.h"
 
#include <CVLog.h>
 
namespace py = pybind11;
using namespace pybind11::literals;
 
void define_ccLog(py::module &m)
{
    py::class_<CVLog> PyccLog(m, "ccLog", R"pbdoc(
    Class to log messages in ACloudViewer's console.
 
    Use one of the static method to log a message
)pbdoc");
    PyccLog.def_static("TheInstance", &CVLog::TheInstance, py::return_value_policy::reference);
    PyccLog.def_static("LogMessage", &CVLog::LogMessage, "message"_a, "level"_a, R"pbdoc(
    Logs a message with the given level.
 
    Parameters
    ----------
    message: str
        The message to log
    level: pycc.CVLog.MessageLevelFlags
        The severity level of the message
 
    Example
    -------
 
    >>> import pycc
    >>> pycc.CVLog.LogMessage("Hello, world", pycc.CVLog.MessageLevelFlags.LOG_STANDARD)
)pbdoc");
    PyccLog.def_static(
        "Print", static_cast<bool (*)(const QString &)>(&CVLog::Print), "message"_a, R"pbdoc(
    Logs a message with standard severity level.
 
    Parameters
    ----------
    message: str
        The message to log
 
    Example
    -------
 
    >>> import pycc
    >>> pycc.CVLog.Print("Hello, world")
    True
)pbdoc");
    PyccLog.def_static(
        "Warning", static_cast<bool (*)(const QString &)>(&CVLog::Warning), "message"_a, R"pbdoc(
    Logs a warning message
 
    Parameters
    ----------
    message: str
        The message to log
 
    Example
    -------
 
    >>> import pycc
    >>> pycc.CVLog.Warning("Oops something bad happenned")
    False
)pbdoc");
    PyccLog.def_static(
        "Error", static_cast<bool (*)(const QString &)>(&CVLog::Error), "message"_a, R"pbdoc(
    Logs an error message
 
    This will also display a dialog
 
    Parameters
    ----------
    message: str
        The message to log
 
    Example
    -------
 
    >>> import pycc
    >>> pycc.CVLog.Error("Oops something even worse happenned")
    False
)pbdoc");
 
    py::native_enum<CVLog::MessageLevelFlags>(
        PyccLog, "MessageLevelFlags", "enum.Enum", "CVLog::MessageLevelFlags.")
        .value("LOG_VERBOSE", CVLog::MessageLevelFlags::LOG_VERBOSE)
        .value("LOG_STANDARD", CVLog::MessageLevelFlags::LOG_STANDARD)
        .value("LOG_IMPORTANT", CVLog::MessageLevelFlags::LOG_IMPORTANT)
        .value("LOG_WARNING", CVLog::MessageLevelFlags::LOG_WARNING)
        .value("LOG_ERROR", CVLog::MessageLevelFlags::LOG_ERROR)
        .export_values()
        .finalize();
}