setLevel function now available for all loggers (and the manager).

Author: num3ric

docs/htmlsrc/guides/logging/index.html

@@ -77,14 +77,14 @@ <h2>Logger Types</h2>
             <li><ci dox="ci::log::LoggerFileRotating">LoggerFileRotating</ci> directs log messages to a specified file.  The name of that file is evaluated at the first logging call after application startup, and re-evaluated at the first logging call after midnight.</li>
             <li>
                 <ci dox="ci::log::LoggerBreakpoint">LoggerBreakpoint</ci> doesn't actually log messages, but triggers a breakpoint on log events above a specified threshold.  <code>triggerLevel</code> defines the minimum logging level that will break execution.
-                <br>The trigger level can be controlled by calling <ci dox="ci::log::LoggerBreakpoint::setTriggerLevel">LoggerBreakpoint::setTriggerLevel()</ci>.
+                <br>The trigger level can be controlled by calling <ci dox="ci::log::LoggerBreakpoint::setLevel">LoggerBreakpoint::setLevel()</ci>.
             </li>
             <li><ci dox="ci::log::LoggerSystem">LoggerSystem</ci> will write log messages to the platform specific system log.  This currently means the system log on OS X <code>/var/log/system.log</code> and the Event Log on Windows with MSW applications.  WinRT system logging is still being developed.</li>
         </ul>
         <h3>LoggerSystem Notes</h3>
         <h4>Minimum System Logging Level</h4>
         <p>
-            The minimum system logging level can be controlled by calling <ci dox="ci::log::LoggerSystem::setLoggingLevel">LoggerSystem::setLoggingLevel()</ci>.  This level can be controlled independently of the Cinder minimum logging level, but the system logging level can never be lower than the Cinder minimum logging level.  For more information on this, see the section on <a href="#optimization">Compile Time Settings & Optimization.</a>
+            The minimum system logging level can be controlled by calling <ci dox="ci::log::LoggerSystem::setLevel">LoggerSystem::setLevel()</ci>.  This level can be controlled independently of the preprocessor Cinder minimum logging level, but the system logging level can never be lower than the Cinder minimum logging level.  For more information on this, see the section on <a href="#optimization">Compile Time Settings & Optimization.</a>
         </p>
         <h4>OS X Specific Notes</h4>
         <p>
@@ -143,7 +143,7 @@ <h3>Usage</h3>
         <p>
             <b>Example 3: Getting an active logger:</b><br>
             <pre><code class="language-cpp">// gets the active LoggerSystem and sets the minimum level to LEVEL_ERROR
-log::manager()->getLoggers&lt;log::LoggerSystem&gt;()[0]->setLoggingLevel( log::LEVEL_ERROR );</code></pre>
+log::manager()->getLoggers&lt;log::LoggerSystem&gt;()[0]->setLevel( log::LEVEL_ERROR );</code></pre>
         </p>
         </section>
 

include/cinder/Log.h

@@ -35,6 +35,17 @@
 #include <vector>
 #include <memory>
 #include <mutex>
+#include <functional>
+
+// CI_MIN_LOG_LEVEL is designed so that if you set it to 7 : nothing logs, 6 : only fatal, 5 : fatal + error, ..., 1 : everything
+
+#if ! defined( CI_MIN_LOG_LEVEL )
+#if ! defined( NDEBUG )
+#define CI_MIN_LOG_LEVEL 0	// debug mode default is LEVEL_VERBOSE
+#else
+#define CI_MIN_LOG_LEVEL 2	// release mode default is LEVEL_INFO
+#endif
+#endif
 
 namespace cinder { namespace log {
 
@@ -86,13 +97,17 @@ class CI_API Logger : private Noncopyable {
 	void setTimestampEnabled( bool enable = true )	{ mTimeStampEnabled = enable; }
 	bool isTimestampEnabled() const					{ return mTimeStampEnabled; }
 
-  protected:
-	Logger() : mTimeStampEnabled( false ) {}
+	void	setLevel( Level level ) { mLevel = level; }
+	Level	getLevel() const { return mLevel; }
 
+  protected:
+	Logger( Level level = static_cast<Level>( CI_MIN_LOG_LEVEL ) ) : mLevel( level ), mTimeStampEnabled( false ) {}
+	
 	void writeDefault( std::ostream &stream, const Metadata &meta, const std::string &text );
 
+	Level	mLevel;
   private:
-	bool mTimeStampEnabled;
+	bool	mTimeStampEnabled;
 };
 
 typedef std::shared_ptr<Logger>	LoggerRef;
@@ -134,13 +149,17 @@ class CI_API LoggerFileRotating : public LoggerFile {
 
 	//! Creates a rotating log file that will rotate when the first logging event occurs after midnight.
 	//! \p formatStr will be passed to strftime to determine the file name.
-	LoggerFileRotating( const fs::path &folder, const std::string &formatStr, bool appendToExisting = true );
+	LoggerFileRotating( const fs::path &folder, const std::string &formatStr, bool appendToExisting = true, std::function<void( const fs::path& )> fileChangeFn = nullptr );
 
 	virtual ~LoggerFileRotating() { }
 
 	void write( const Metadata &meta, const std::string &text ) override;
-	
+
 protected:
+	void setFilePath( const fs::path& filepath );
+
+	std::function<void( const fs::path& )> mFileChangeFn;
+
 	fs::path		mFolderPath;
 	std::string		mDailyFormatStr;
 	int				mYearDay;
@@ -150,16 +169,10 @@ class CI_API LoggerFileRotating : public LoggerFile {
 class CI_API LoggerBreakpoint : public Logger {
   public:
 	LoggerBreakpoint( Level triggerLevel = LEVEL_ERROR )
-		: mTriggerLevel( triggerLevel )
+		: Logger{ triggerLevel }
 	{}
 
 	void write( const Metadata &meta, const std::string &text ) override;
-
-	void	setTriggerLevel( Level triggerLevel )	{ mTriggerLevel = triggerLevel; }
-	Level	getTriggerLevel() const					{ return mTriggerLevel; }
-	
-  private:
-	Level	mTriggerLevel;
 };
 
 //! LoggerSystem rovides 'system' logging support. Uses syslog on platforms that have it, on MSW uses Windows Event Logging.
@@ -170,12 +183,8 @@ class CI_API LoggerSystem : public Logger {
 	virtual ~LoggerSystem();
 
 	void write( const Metadata &meta, const std::string &text ) override;
-	//! Sets the minimum logging level that will trigger a system log.
-	//! \note Setting \p minLevel below CI_MIN_LOG_LEVEL is pointless; minLevel will act like CI_MIN_LOG_LEVEL.
-	void setLoggingLevel( Level minLevel ) { mMinLevel = minLevel; }
-	
+
 protected:
-	Level mMinLevel;
 #if defined( CINDER_COCOA ) || defined( CINDER_LINUX )
 	class ImplSysLog;
 	std::unique_ptr<ImplSysLog> mImpl;
@@ -215,6 +224,8 @@ class CI_API LogManager {
 	std::vector<LoggerRef> getAllLoggers();
 	//! Returns the mutex used for thread safe logging.
 	std::mutex& getMutex() const			{ return mMutex; }
+	//! Set the logging level for all active loggers.
+	void	setLevel( Level level );
 
 	void write( const Metadata &meta, const std::string &text );
 
@@ -329,15 +340,6 @@ std::vector<std::shared_ptr<LoggerT>> LogManager::getLoggers()
 
 #define CINDER_LOG_STREAM( level, stream ) ::cinder::log::Entry( level, ::cinder::log::Location( CINDER_CURRENT_FUNCTION, __FILE__, __LINE__ ) ) << stream
 
-// CI_MIN_LOG_LEVEL is designed so that if you set it to 7 : nothing logs, 6 : only fatal, 5 : fatal + error, ..., 1 : everything
-
-#if ! defined( CI_MIN_LOG_LEVEL )
-	#if ! defined( NDEBUG )
-		#define CI_MIN_LOG_LEVEL 0	// debug mode default is LEVEL_VERBOSE
-	#else
-		#define CI_MIN_LOG_LEVEL 2	// release mode default is LEVEL_INFO
-	#endif
-#endif
 
 #if( CI_MIN_LOG_LEVEL <= 0 )
 	#define CI_LOG_V( stream )	CINDER_LOG_STREAM( ::cinder::log::LEVEL_VERBOSE, stream )

include/cinder/Utilities.h

@@ -42,6 +42,8 @@ CI_API fs::path expandPath( const fs::path &path );
 CI_API fs::path getHomeDirectory();
 //! Returns a path to the user's documents directory.
 CI_API fs::path getDocumentsDirectory();
+//! Removes all files beyond maxFileCount, keeping only the most recently modified ones.
+CI_API void limitDirectoryFileCount( const fs::path& directoryPath, size_t maxFileCount );
 
 //! Launches a path in a web browser
 CI_API void launchWebBrowser( const Url &url );

samples/Logging/src/LoggingApp.cpp

@@ -1,6 +1,7 @@
 #include "cinder/app/App.h"
 #include "cinder/app/RendererGl.h"
 #include "cinder/gl/gl.h"
+#include "cinder/Utilities.h"
 
 using namespace ci;
 using namespace ci::app;
@@ -17,6 +18,7 @@ class LoggingApp : public App {
 
   public:
 	void setup() override;
+	void keyDown( KeyEvent event ) override;
 	void mouseDown( MouseEvent event ) override;
 	void update() override;
 	void draw() override;
@@ -42,21 +44,39 @@ void LoggingApp::setup()
 	enableSysLogging();
 }
 
+void LoggingApp::keyDown( KeyEvent event )
+{
+	//! Change log trigger levels for all active loggers with keys 0-5.
+	if( event.isShiftDown() && event.isAltDown() ) {
+		switch( event.getCode() ) {
+		case KeyEvent::KEY_0: log::manager()->setLevel( log::LEVEL_VERBOSE ); break;
+		case KeyEvent::KEY_1: log::manager()->setLevel( log::LEVEL_DEBUG ); break;
+		case KeyEvent::KEY_2: log::manager()->setLevel( log::LEVEL_INFO ); break;
+		case KeyEvent::KEY_3: log::manager()->setLevel( log::LEVEL_WARNING ); break;
+		case KeyEvent::KEY_4: log::manager()->setLevel( log::LEVEL_ERROR ); break;
+		case KeyEvent::KEY_5: log::manager()->setLevel( log::LEVEL_FATAL ); break;
+		default: break;
+		}
+	}
+}
+
 void LoggingApp::enableFileLogging()
 {
 	//! This call will append log messages to the file `cinder.log` in the folder `/tmp/logging`.
 	//! If the folder path `/tmp/logging` does not exist, it will be created for you.
 
-	log::makeLogger<log::LoggerFile>( "/tmp/logging/cinder.log", true );
+	log::makeLogger<log::LoggerFile>( app::getAppPath() / "cinder.log", true );
 }
 
 void LoggingApp::enableFileLoggingRotating()
 {
 	//! This call will append log messages to a rotating file in the folder `/tmp/logging`.
 	//! The filename `cinder.%Y.%m.%d.log` will be evaluated by strftime.  For the example
 	//! below, the filename could evaluate to `cinder.2015.08.28.log`.
-
-	log::makeLogger<log::LoggerFileRotating>( "/tmp/logging", "cinder.%Y.%m.%d.log" );
+	log::makeLogger<log::LoggerFileRotating>( app::getAppPath() / "logs", "cinder.%Y.%m.%d.log", true, []( const fs::path& path ) {
+		// Only preserve logs from the last 10 days
+		ci::limitDirectoryFileCount( path.parent_path(), 10 );
+	} );
 }
 
 void LoggingApp::enableSysLogging()
@@ -67,8 +87,8 @@ void LoggingApp::enableSysLogging()
 	auto sysLogger = log::makeLogger<log::LoggerSystem>();
 
 	//! This call will set the system logging level independent of the file/console logging level.
-	//! The system logging level can not be lower than the file/console logging.
-	sysLogger->setLoggingLevel( log::LEVEL_WARNING );
+	//! The system logging level can not be lower than the preprocessor-defined level.
+	sysLogger->setLevel( log::LEVEL_WARNING );
 }
 
 void LoggingApp::mouseDown( MouseEvent event )

samples/Logging/vc2019/Logging.sln

@@ -6,16 +6,40 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Logging", "Logging.vcxproj"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug_ANGLE|Win32 = Debug_ANGLE|Win32
+		Debug_ANGLE|x64 = Debug_ANGLE|x64
+		Debug_Shared|Win32 = Debug_Shared|Win32
+		Debug_Shared|x64 = Debug_Shared|x64
 		Debug|Win32 = Debug|Win32
 		Debug|x64 = Debug|x64
+		Release_ANGLE|Win32 = Release_ANGLE|Win32
+		Release_ANGLE|x64 = Release_ANGLE|x64
+		Release_Shared|Win32 = Release_Shared|Win32
+		Release_Shared|x64 = Release_Shared|x64
 		Release|Win32 = Release|Win32
 		Release|x64 = Release|x64
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_ANGLE|Win32.ActiveCfg = Debug|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_ANGLE|Win32.Build.0 = Debug|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_ANGLE|x64.ActiveCfg = Debug|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_ANGLE|x64.Build.0 = Debug|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_Shared|Win32.ActiveCfg = Debug|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_Shared|Win32.Build.0 = Debug|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_Shared|x64.ActiveCfg = Debug|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug_Shared|x64.Build.0 = Debug|x64
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug|Win32.ActiveCfg = Debug|Win32
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug|Win32.Build.0 = Debug|Win32
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug|x64.ActiveCfg = Debug|x64
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Debug|x64.Build.0 = Debug|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_ANGLE|Win32.ActiveCfg = Release|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_ANGLE|Win32.Build.0 = Release|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_ANGLE|x64.ActiveCfg = Release|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_ANGLE|x64.Build.0 = Release|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_Shared|Win32.ActiveCfg = Release|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_Shared|Win32.Build.0 = Release|Win32
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_Shared|x64.ActiveCfg = Release|x64
+		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release_Shared|x64.Build.0 = Release|x64
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release|Win32.ActiveCfg = Release|Win32
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release|Win32.Build.0 = Release|Win32
 		{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}.Release|x64.ActiveCfg = Release|x64
@@ -24,4 +48,7 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {57121B3D-8E9D-4FC5-A025-D7C7D2CDACA8}
+	EndGlobalSection
 EndGlobal

samples/Logging/vc2019/Logging.vcxproj

@@ -22,32 +22,33 @@
     <ProjectGuid>{1FDCFE3E-16AD-43F0-AF04-F281F40C1419}</ProjectGuid>
     <RootNamespace>Logging</RootNamespace>
     <Keyword>Win32Proj</Keyword>
+    <WindowsTargetPlatformVersion>8.1</WindowsTargetPlatformVersion>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v140</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
     <WholeProgramOptimization>true</WholeProgramOptimization>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v140</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
     <WholeProgramOptimization>true</WholeProgramOptimization>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v140</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v140</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
@@ -88,6 +89,7 @@
       <WarningLevel>Level3</WarningLevel>
       <DebugInformationFormat>EditAndContinue</DebugInformationFormat>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
+      <LanguageStandard>stdcpp17</LanguageStandard>
     </ClCompile>
     <ResourceCompile>
       <AdditionalIncludeDirectories>"..\..\..\include";..\include</AdditionalIncludeDirectories>
@@ -114,6 +116,7 @@
       <WarningLevel>Level3</WarningLevel>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
+      <LanguageStandard>stdcpp17</LanguageStandard>
     </ClCompile>
     <ResourceCompile>
       <AdditionalIncludeDirectories>"..\..\..\include";..\include</AdditionalIncludeDirectories>
@@ -137,6 +140,7 @@
       <WarningLevel>Level3</WarningLevel>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
+      <LanguageStandard>stdcpp17</LanguageStandard>
     </ClCompile>
     <ProjectReference>
       <LinkLibraryDependencies>true</LinkLibraryDependencies>
@@ -166,6 +170,7 @@
       <WarningLevel>Level3</WarningLevel>
       <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
       <MultiProcessorCompilation>true</MultiProcessorCompilation>
+      <LanguageStandard>stdcpp17</LanguageStandard>
     </ClCompile>
     <ProjectReference>
       <LinkLibraryDependencies>true</LinkLibraryDependencies>