From a6a66c3a2115b56fa7afe2cb13b877bcea562c5c Mon Sep 17 00:00:00 2001 From: kgv Date: Sat, 5 Oct 2019 23:34:35 +0300 Subject: [PATCH] 0031037: Foundation Classes - add class Message_PrinterSystemLog for printing messages into system log Added new class Message_PrinterSystemLog that can be used for logging messages into system log for debugging application in restricted environment. --- adm/cmake/occt_csf.cmake | 1 + adm/genproj.tcl | 3 + src/Message/FILES | 2 + src/Message/Message_PrinterSystemLog.cxx | 190 +++++++++++++++++++++++ src/Message/Message_PrinterSystemLog.hxx | 63 ++++++++ src/TKernel/EXTERNLIB | 1 + 6 files changed, 260 insertions(+) create mode 100644 src/Message/Message_PrinterSystemLog.cxx create mode 100644 src/Message/Message_PrinterSystemLog.hxx diff --git a/adm/cmake/occt_csf.cmake b/adm/cmake/occt_csf.cmake index acb34268f0..353f6cf208 100644 --- a/adm/cmake/occt_csf.cmake +++ b/adm/cmake/occt_csf.cmake @@ -108,6 +108,7 @@ else() elseif (ANDROID) set (CSF_ThreadLibs "c") set (CSF_OpenGlLibs "EGL GLESv2") + set (CSF_androidlog "log") elseif (UNIX) set (CSF_ThreadLibs "pthread rt stdc++") if (USE_GLES2) diff --git a/adm/genproj.tcl b/adm/genproj.tcl index 68f9871592..400b71525d 100644 --- a/adm/genproj.tcl +++ b/adm/genproj.tcl @@ -1419,6 +1419,9 @@ proc osutils:csfList { theOS theCsfLibsMap theCsfFrmsMap } { set aFrmsMap(CSF_TclTkLibs) "Tk" set aLibsMap(CSF_TclTkLibs) "" set aLibsMap(CSF_QT) "QtCore QtGui" + } elseif { "$theOS" == "android" } { + set aLibsMap(CSF_OpenGlLibs) "EGL GLESv2" + set aLibsMap(CSF_androidlog) "log" } else { set aLibsMap(CSF_fontconfig) "fontconfig" if { "$theOS" == "qnx" } { diff --git a/src/Message/FILES b/src/Message/FILES index 2747813201..76f6fbebe5 100755 --- a/src/Message/FILES +++ b/src/Message/FILES @@ -20,6 +20,8 @@ Message_Printer.cxx Message_Printer.hxx Message_PrinterOStream.cxx Message_PrinterOStream.hxx +Message_PrinterSystemLog.cxx +Message_PrinterSystemLog.hxx Message_ProgressIndicator.cxx Message_ProgressIndicator.hxx Message_ProgressIndicator.lxx diff --git a/src/Message/Message_PrinterSystemLog.cxx b/src/Message/Message_PrinterSystemLog.cxx new file mode 100644 index 0000000000..8d2be63398 --- /dev/null +++ b/src/Message/Message_PrinterSystemLog.cxx @@ -0,0 +1,190 @@ +// Copyright (c) 2019 OPEN CASCADE SAS +// +// This file is part of Open CASCADE Technology software library. +// +// This library is free software; you can redistribute it and/or modify it under +// the terms of the GNU Lesser General Public License version 2.1 as published +// by the Free Software Foundation, with special exception defined in the file +// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT +// distribution for complete text of the license and disclaimer of any warranty. +// +// Alternatively, this file may be used under the terms of Open CASCADE +// commercial license or contractual agreement. + +#ifdef _WIN32 + #include +#endif + +#include + +#include + +#if defined(OCCT_UWP) + // +#elif defined(_WIN32) + //! Convert message gravity into EventLog enumeration. + static WORD getEventLogPriority (const Message_Gravity theGravity) + { + switch (theGravity) + { + case Message_Alarm: + case Message_Fail: + return EVENTLOG_ERROR_TYPE; + case Message_Warning: + return EVENTLOG_WARNING_TYPE; + case Message_Info: + case Message_Trace: + return EVENTLOG_INFORMATION_TYPE; + } + return EVENTLOG_INFORMATION_TYPE; + } +#elif defined(__ANDROID__) + #include + + //! Convert message gravity into Android log enumeration. + static android_LogPriority getAndroidLogPriority (const Message_Gravity theGravity) + { + switch (theGravity) + { + case Message_Trace: return ANDROID_LOG_DEBUG; + case Message_Info: return ANDROID_LOG_INFO; + case Message_Warning: return ANDROID_LOG_WARN; + case Message_Alarm: return ANDROID_LOG_ERROR; + case Message_Fail: return ANDROID_LOG_ERROR; + } + return ANDROID_LOG_DEBUG; + } +#else + #include + + //! Convert message gravity into syslog() enumeration. + static int getSysLogPriority (const Message_Gravity theGravity) + { + switch (theGravity) + { + case Message_Trace: return LOG_DEBUG; + case Message_Info: return LOG_INFO; + case Message_Warning: return LOG_WARNING; + case Message_Alarm: return LOG_ERR; + case Message_Fail: return LOG_ERR; + } + return LOG_DEBUG; + } +#endif + +IMPLEMENT_STANDARD_RTTIEXT(Message_PrinterSystemLog, Message_Printer) + +//======================================================================= +//function : Constructor +//purpose : +//======================================================================= +Message_PrinterSystemLog::Message_PrinterSystemLog (const TCollection_AsciiString& theEventSourceName, + const Message_Gravity theTraceLevel) +: myEventSourceName (theEventSourceName) +{ + myTraceLevel = theTraceLevel; +#if defined(OCCT_UWP) + myEventSource = NULL; +#elif defined(_WIN32) + const TCollection_ExtendedString aWideSrcName (theEventSourceName); + myEventSource = (Standard_Address )RegisterEventSourceW (NULL, aWideSrcName.ToWideString()); +#elif defined(__ANDROID__) + // +#else + openlog (myEventSourceName.ToCString(), LOG_PID | LOG_NDELAY, LOG_USER); +#endif +} + +//======================================================================= +//function : ~Message_PrinterSystemLog +//purpose : +//======================================================================= +Message_PrinterSystemLog::~Message_PrinterSystemLog() +{ +#if defined(_WIN32) + if (myEventSource != NULL) + { + #if !defined(OCCT_UWP) + DeregisterEventSource ((HANDLE )myEventSource); + #endif + } +#elif defined(__ANDROID__) + // +#else + closelog(); +#endif +} + +//======================================================================= +//function : Send +//purpose : +//======================================================================= +void Message_PrinterSystemLog::Send (const Standard_CString theString, + const Message_Gravity theGravity, + const Standard_Boolean ) const +{ + if (theGravity < myTraceLevel) + { + return; + } + +#if defined(_WIN32) + Send (TCollection_ExtendedString (theString), theGravity, true); +#elif defined(__ANDROID__) + __android_log_write (getAndroidLogPriority (theGravity), myEventSourceName.ToCString(), theString); +#else + syslog (getSysLogPriority (theGravity), "%s", theString); +#endif +} + +//======================================================================= +//function : Send +//purpose : +//======================================================================= +void Message_PrinterSystemLog::Send (const TCollection_AsciiString& theString, + const Message_Gravity theGravity, + const Standard_Boolean ) const +{ + if (theGravity < myTraceLevel) + { + return; + } + +#if defined(_WIN32) + Send (TCollection_ExtendedString (theString), theGravity, true); +#elif defined(__ANDROID__) + __android_log_write (getAndroidLogPriority (theGravity), myEventSourceName.ToCString(), theString.ToCString()); +#else + syslog (getSysLogPriority (theGravity), "%s", theString.ToCString()); +#endif +} + +//======================================================================= +//function : Send +//purpose : +//======================================================================= +void Message_PrinterSystemLog::Send (const TCollection_ExtendedString& theString, + const Message_Gravity theGravity, + const Standard_Boolean ) const +{ + if (theGravity < myTraceLevel) + { + return; + } + +#if defined(_WIN32) + if (myEventSource != NULL) + { + #if !defined(OCCT_UWP) + const WORD aLogType = getEventLogPriority (theGravity); + const wchar_t* aMessage[1] = { theString.ToWideString() }; + ReportEventW ((HANDLE )myEventSource, aLogType, 0, 0, NULL, + 1, 0, aMessage, NULL); + #else + (void )theString; + #endif + } +#else + Send (TCollection_AsciiString (theString), theGravity, true); +#endif +} diff --git a/src/Message/Message_PrinterSystemLog.hxx b/src/Message/Message_PrinterSystemLog.hxx new file mode 100644 index 0000000000..309a48a250 --- /dev/null +++ b/src/Message/Message_PrinterSystemLog.hxx @@ -0,0 +1,63 @@ +// Copyright (c) 2019 OPEN CASCADE SAS +// +// This file is part of Open CASCADE Technology software library. +// +// This library is free software; you can redistribute it and/or modify it under +// the terms of the GNU Lesser General Public License version 2.1 as published +// by the Free Software Foundation, with special exception defined in the file +// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT +// distribution for complete text of the license and disclaimer of any warranty. +// +// Alternatively, this file may be used under the terms of Open CASCADE +// commercial license or contractual agreement. + +#ifndef _Message_PrinterSystemLog_HeaderFile +#define _Message_PrinterSystemLog_HeaderFile + +#include +#include + +DEFINE_STANDARD_HANDLE(Message_PrinterSystemLog, Message_Printer) + +//! Implementation of a message printer associated with system log. +//! Implemented for the following systems: +//! - Windows, through ReportEventW(). +//! - Android, through __android_log_write(). +//! - UNIX/Linux, through syslog(). +class Message_PrinterSystemLog : public Message_Printer +{ + DEFINE_STANDARD_RTTIEXT(Message_PrinterSystemLog, Message_Printer) +public: + + //! Main constructor. + Standard_EXPORT Message_PrinterSystemLog (const TCollection_AsciiString& theEventSourceName, + const Message_Gravity theTraceLevel = Message_Info); + + //! Destructor. + Standard_EXPORT virtual ~Message_PrinterSystemLog(); + + //! Puts a message to the system log. + Standard_EXPORT virtual void Send (const Standard_CString theString, + const Message_Gravity theGravity, + const Standard_Boolean theToPutEndl) const Standard_OVERRIDE; + + //! Puts a message to the system log. + Standard_EXPORT virtual void Send (const TCollection_AsciiString& theString, + const Message_Gravity theGravity, + const Standard_Boolean theToPutEndl) const Standard_OVERRIDE; + + //! Puts a message to the system log. + Standard_EXPORT virtual void Send (const TCollection_ExtendedString& theString, + const Message_Gravity theGravity, + const Standard_Boolean theToPutEndl) const Standard_OVERRIDE; + +private: + + TCollection_AsciiString myEventSourceName; +#ifdef _WIN32 + Standard_Address myEventSource; +#endif + +}; + +#endif // _Message_PrinterSystemLog_HeaderFile diff --git a/src/TKernel/EXTERNLIB b/src/TKernel/EXTERNLIB index a62f5cb0ef..8911ab53c5 100755 --- a/src/TKernel/EXTERNLIB +++ b/src/TKernel/EXTERNLIB @@ -6,3 +6,4 @@ CSF_TBB CSF_dl CSF_wsock32 CSF_psapi +CSF_androidlog