This file defines SpyLog macros. These macros are used to log messages to a file or to the console during application execution. More...

#include <cassert>
#include <sstream>
#include <boost/preprocessor/comparison/greater_equal.hpp>
#include <boost/preprocessor/control/expr_iif.hpp>
#include "fwCore/log/SpyLogger.hpp"
#include "fwCore/log/ScopedMessage.hpp"

Include dependency graph for spyLog.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SPYLOG_ABORT() std::abort()

#define	FW_DEPRECATED(oldFnName, newFnName, version)
	Use this macro when deprecating a function to warn the developer. More...

#define	FW_DEPRECATED_IF(oldFnName, newFnName, version, condition)
	Use this macro when deprecating a function to warn the developer. More...

#define	FW_DEPRECATED_MSG(message, version) OSLM_ERROR( "[DEPRECATED] " << message << " It will be removed in '" << version << "'");
	Use this macro when deprecating a function to warn the developer.

#define	FW_DEPRECATED_KEY(newKey, access, version)
	Use this macro when deprecating a service key to warn the developer. More...


#define	SLM_TRACE(message) SL_TRACE(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_TRACE(message) OSL_TRACE(_SPYLOG_SPYLOGGER_, message)

#define	SLM_TRACE_IF(message, cond) SL_TRACE_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_TRACE_IF(message, cond) OSL_TRACE_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	SLM_DEBUG(message) SL_DEBUG(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_DEBUG(message) OSL_DEBUG(_SPYLOG_SPYLOGGER_, message)

#define	SLM_DEBUG_IF(message, cond) SL_DEBUG_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_DEBUG_IF(message, cond) OSL_DEBUG_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	SLM_INFO(message) SL_INFO(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_INFO(message) OSL_INFO(_SPYLOG_SPYLOGGER_, message)

#define	SLM_INFO_IF(message, cond) SL_INFO_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_INFO_IF(message, cond) OSL_INFO_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	SLM_WARN(message) SL_WARN(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_WARN(message) OSL_WARN(_SPYLOG_SPYLOGGER_, message)

#define	SLM_WARN_IF(message, cond) SL_WARN_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_WARN_IF(message, cond) OSL_WARN_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	SLM_ERROR(message) SL_ERROR(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_ERROR(message) OSL_ERROR(_SPYLOG_SPYLOGGER_, message)

#define	SLM_ERROR_IF(message, cond) SL_ERROR_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_ERROR_IF(message, cond) OSL_ERROR_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	SLM_FATAL(message) SL_FATAL(_SPYLOG_SPYLOGGER_, message)

#define	OSLM_FATAL(message) OSL_FATAL(_SPYLOG_SPYLOGGER_, message)

#define	SLM_FATAL_IF(message, cond) SL_FATAL_IF(_SPYLOG_SPYLOGGER_, message, cond)

#define	OSLM_FATAL_IF(message, cond) OSL_FATAL_IF(_SPYLOG_SPYLOGGER_, message, cond)


#define	OSLM_LOG(message)

Special macros
#define	SLM_ASSERT(message, cond) SL_ASSERT(_SPYLOG_SPYLOGGER_, message, cond)
	work like 'assert' from 'cassert', with in addition a message logged by spylog (with FATAL loglevel)

#define	OSLM_ASSERT(message, cond) OSL_ASSERT(_SPYLOG_SPYLOGGER_, message, cond)
	work like 'assert' from 'cassert', with in addition a message logged by spylog (with FATAL loglevel)

#define	SLM_PRETTY_FUNC() __func__
	work like 'assert' from 'cassert', with in addition a message logged by spylog (with FATAL loglevel)

#define	SLM_TRACE_FUNC() SLM_TRACE(SLM_PRETTY_FUNC())
	Trace contextual function signature. More...

Detailed Description

This file defines SpyLog macros. These macros are used to log messages to a file or to the console during application execution.

Six log levels are defined :

Fatal
Error
Warning
Info
Debug
Trace

Log level is set by defining SPYLOG_LEVEL to N where 0 < N <= 6. If log level is set to N, every log level lesser than N will be enabled, the other macro will be define but won't have any effect.

Each log level macro has two variant : SLM_<level> and OSLM_<level>.

SLM_ variant is a simple log message macros, append a loglevel-tagged log message to the logger.
- Example : SLM_FATAL( "This should not append" );
OSLM_ variant is a stringstream log message macros, it is the same as "Simple log message macros", but accept a stream as argument.
- Example : OSLM_INFO( "Count : " << i );

FATAL macros have a particular behavior : the application is aborted after the message was logged.

Definition in file spyLog.hpp.

Macro Definition Documentation

#define FW_DEPRECATED	(	oldFnName,
		newFnName,
		version
	)

Value:

OSLM_ERROR(  "[DEPRECATED] '" << oldFnName << "' is deprecated and will be removed in '" << version << "', use '" \
                                  << newFnName << "' instead. It is still used by '" + this->getClassname() + "'." \
                 );

Use this macro when deprecating a function to warn the developer.

Definition at line 344 of file spyLog.hpp.

Referenced by ctrlSelection::updater::SObjFromSlot::addOrSwap(), fwServices::IService::getObject(), ctrlSelection::updater::SObjFromSlot::removeIfPresent(), ctrlSelection::SAddField::starting(), and ctrlSelection::updater::SObjFromSlot::swap().

#define FW_DEPRECATED_IF	(	oldFnName,
		newFnName,
		version,
		condition
	)

Value:

OSLM_ERROR_IF("[DEPRECATED] '" << oldFnName << "' is deprecated and will be removed in '" << version << "', use '" \
                                   << newFnName << "' instead. It is still used by '" + this->getClassname() + "'.", \
                  condition);

Use this macro when deprecating a function to warn the developer.

Definition at line 352 of file spyLog.hpp.

Referenced by fwServices::IService::getAutoConnections().

#define FW_DEPRECATED_KEY	(	newKey,
		access,
		version
	)

Value:

OSLM_ERROR(  "[DEPRECATED] The key '" << newKey << "' is not correctly set. Please correct the configuration to " \
                 "set an '" << access << "' key named '" << newKey << "'. The support of the old key will be removed " \
                 "in '" << version << "'.");

Use this macro when deprecating a service key to warn the developer.

Definition at line 366 of file spyLog.hpp.

Referenced by preferences::SPreferences::configuring(), ioPacs::SPacsConfigurationInitializer::configuring(), activities::SSeriesSignal::getAutoConnections(), ioAtoms::SReader::getIOPathType(), uiReconstructionQt::OrganMaterialEditor::materialNotification(), uiReconstructionQt::RepresentationEditor::notifyMaterial(), uiMedDataQt::editor::SModelSeriesList::onCurrentItemChanged(), uiImageQt::ImageTransparency::onModifyTransparency(), uiImageQt::ImageTransparency::onModifyVisibility(), uiReconstructionQt::OrganMaterialEditor::refreshMaterial(), uiImageQt::SliceIndexPositionEditor::sliceIndexNotification(), uiImageQt::SliceIndexPositionEditor::sliceTypeNotification(), ctrlMemory::LockDumpSrv::starting(), uiImageQt::SliceIndexPositionEditor::starting(), uiIO::action::SExportWithSeriesDB::starting(), ioPacs::SPacsConfigurationEditor::starting(), uiImageQt::SliceIndexPositionEditor::swapping(), uiMedDataQt::editor::SModelSeriesList::swapping(), activities::action::SActivityLauncher::translateParameters(), uiImageQt::SliceIndexPositionEditor::updateSliceIndexFromImg(), uiImageQt::SliceIndexPositionEditor::updateSliceTypeFromImg(), uiMeasurement::action::AddDistance::updating(), uiMeasurement::action::SAddLabeledPoint::updating(), uiMeasurement::action::RemoveLandmark::updating(), uiMeasurement::action::RemoveDistance::updating(), uiMeasurement::action::ShowDistance::updating(), ioITK::SImageSeriesWriter::updating(), ioITK::SJpgImageSeriesWriter::updating(), uiReconstructionQt::OrganMaterialEditor::updating(), ioITK::InrImageWriterService::updating(), uiImageQt::ImageInfo::updating(), ioITK::InrImageReaderService::updating(), ioITK::JpgImageWriterService::updating(), uiReconstructionQt::RepresentationEditor::updating(), uiImageQt::ImageTransparency::updating(), ioPacs::SPacsConfigurationInitializer::updating(), ioDicom::SFilterSelectorDialog::updating(), ioITK::SInrSeriesDBReader::updating(), ioVtkGdcm::SSeriesDBLazyReader::updating(), uiImageQt::SliceIndexPositionEditor::updating(), ioVtkGdcm::SImageSeriesWriter::updating(), ioVtkGdcm::SSeriesDBReader::updating(), ioData::TransformationMatrix3DWriterService::updating(), uiMedDataQt::SSeriesViewer::updating(), uiIO::action::SSeriesDBMerger::updating(), ioData::TransformationMatrix3DReaderService::updating(), uiIO::action::SExportWithSeriesDB::updating(), ioVTK::SMeshReader::updating(), ioVTK::SImageReader::updating(), ioVTK::SImageSeriesWriter::updating(), ioVTK::SModelSeriesReader::updating(), ioVTK::SMeshWriter::updating(), ioVTK::SModelSeriesWriter::updating(), ioVTK::SModelSeriesObjWriter::updating(), ioVTK::SSeriesDBReader::updating(), ioPacs::SPacsConfigurationEditor::updating(), ioData::MeshWriterService::updating(), ioAtoms::SWriter::updating(), ioVTK::SImageWriter::updating(), uiIO::editor::SIOSelector::updating(), ioAtoms::SReader::updating(), uiMedDataQt::editor::SActivityWizard::updating(), and activities::action::SActivityLauncher::updating().

#define OSLM_DEBUG ( message ) OSL_DEBUG(_SPYLOG_SPYLOGGER_, message)

Debug stringstream message macros.

Definition at line 241 of file spyLog.hpp.

Referenced by fwServices::registry::ServiceConfig::addServiceConfigInfo(), fwDataCamp::visitor::CompareObjects::CompareObjects(), fwVtkIO::helper::Mesh::computeVolume(), fwServices::registry::ServiceFactory::create(), fwRuntime::getAllConfigurationElementsForPoint(), fwRuntime::ExtensionPoint::getExtensionValidator(), fwDataCamp::visitor::GetObject::GetObject(), fwRenderVTK::SRender::isShownOnScreen(), fwServices::registry::ServiceFactory::parseBundleInformation(), fwActivities::registry::Activities::parseBundleInformation(), visuVTKAdaptor::S2DWheel::starting(), guiQt::editor::SParameters::stopping(), and guiQt::editor::SParameters::updating().

#define OSLM_DEBUG_IF	(	message,
		cond
	)	OSL_DEBUG_IF(_SPYLOG_SPYLOGGER_, message, cond)

Conditionnal debug stringstream message macros.

Definition at line 245 of file spyLog.hpp.

Referenced by fwServices::registry::ServiceFactory::create(), fwRuntime::ExtensionPoint::getAllConfigurationElements(), and fwServices::registry::ObjectService::registerServiceOutput().

#define OSLM_ERROR ( message ) OSL_ERROR(_SPYLOG_SPYLOGGER_, message)

Error stringstream message macros.

Definition at line 274 of file spyLog.hpp.

Referenced by fwGdcmIO::helper::DicomAnonymizer::addShiftDateTag(), fwRuntime::profile::Activater::apply(), uiMedDataQt::widget::ActivityDataView::checkAndComputeData(), visuVTKAdaptor::SImagesBlend::checkImageInformations(), fwTest::DicomReaderTest::checkSeriesACHGenou(), fwTest::DicomReaderTest::checkSeriesACHGenouTrimmed(), uiPreferences::action::SPreferencesConfiguration::configuring(), fwCom::helper::SigSlotConnection::connect(), fwGdcmIO::helper::DicomAnonymizer::DicomAnonymizer(), fwTools::System::getTempPath(), fwTools::os::getUserDataDir(), vtkGdcmIO::helper::ImageDicomSource::ImageDicomSource(), guiQt::editor::DynamicView::launchTab(), fwDataIO::reader::TagReader::read(), fwDataIO::reader::MeshReader::read(), fwServices::IService::setObjectId(), fwTools::Type::setType(), preferences::Plugin::start(), guiQt::SSignalShortcut::starting(), guiQt::editor::SDynamicView::swapping(), visuVTKAdaptor::SMesh::updateColorMode(), visuVTKAdaptor::SMeshNormals::updateNormalMode(), uiGenericQt::action::ShowHelpContents::updating(), ioTuto::ExternalDataReaderService::updating(), guiQt::editor::SActivityView::updating(), activities::SActivitySequencer::updating(), ioAtoms::SWriter::updating(), ioAtoms::SReader::updating(), activities::action::SActivityLauncher::updating(), fwRuntime::Extension::validate(), fwRuntime::io::Validator::validate(), ioAtoms::SWriter::versionSelection(), fwDataIO::writer::TransformationMatrix3DWriter::write(), fwDataIO::writer::MeshWriter::write(), and vtkGdcmIO::SeriesDBLazyReader::~SeriesDBLazyReader().

#define OSLM_ERROR_IF	(	message,
		cond
	)	OSL_ERROR_IF(_SPYLOG_SPYLOGGER_, message, cond)

Conditionnal error stringstream message macros.

Definition at line 278 of file spyLog.hpp.

Referenced by fwGdcmIO::helper::DicomAnonymizer::anonymize(), uiMedDataQt::widget::ActivityDataView::checkAndComputeData(), fwTest::DicomReaderTest::checkSeriesACHGenou(), fwTest::DicomReaderTest::checkSeriesACHGenouTrimmed(), fwRenderQt::SRender::getAspectRatioMode(), vtkGdcmIO::helper::ImageDicomSource::read(), memory::SDumpPolicy::starting(), uiMeasurementQt::editor::SLandmarks::stopping(), and ctrlCamp::SExtractMeshByType::updating().

#define OSLM_FATAL ( message ) OSL_FATAL(_SPYLOG_SPYLOGGER_, message)

Fatal stringstream message macros.

Definition at line 285 of file spyLog.hpp.

Referenced by fwData::location::MultiFiles::cachedDeepCopy(), fwData::ROITraits::cachedDeepCopy(), gui::action::SModifyLayout::configuring(), fwGui::builder::IToolBarBuilder::initialize(), fwGui::layoutManager::IFrameLayoutManager::initialize(), fwGui::layoutManager::IMenuLayoutManager::initialize(), fwServices::IService::reconfiguring(), ctrlCamp::SCopy::stopping(), visuVTKAdaptor::SText::stopping(), ctrlCamp::SExtractObj::updating(), and gui::action::SStarter::updating().

#define OSLM_FATAL_IF	(	message,
		cond
	)	OSL_FATAL_IF(_SPYLOG_SPYLOGGER_, message, cond)

Conditionnal fatal stringstream message macros.

Definition at line 289 of file spyLog.hpp.

Referenced by fwDataTools::helper::Composite::add(), uiMeasurementQt::editor::SLandmarks::configuring(), fwTools::Bookmarks::exist(), fwServices::IService::getAutoConnections(), fwRuntime::getCfgAsAnExtension(), fwDataCamp::visitor::GetObject::GetObject(), fwDataTools::helper::Composite::remove(), fwTools::fwID::setID(), fwRuntime::profile::Profile::start(), and fwDataTools::helper::Composite::swap().

#define OSLM_INFO ( message ) OSL_INFO(_SPYLOG_SPYLOGGER_, message)

Info stringstream message macros.

Definition at line 252 of file spyLog.hpp.

Referenced by fwTools::System::cleanZombies(), opVTKMesh::action::SMeshCreation::configuring(), ioTuto::ExternalDataReaderService::configuring(), ioData::SplineReaderService::configuring(), gui::action::SStarter::configuring(), fwRuntime::io::BundleDescriptorReader::createBundles(), fwServices::AppConfigManager::destroy(), fwTools::System::getTemporaryFolder(), fwTools::os::getUserDataDir(), vtkSimpleMesh::SRenderer::notifyCamPositionUpdated(), fwTools::ProgressToLogger::operator()(), fwDataIO::reader::TagReader::read(), fwDataIO::reader::DictionaryReader::read(), memory::SDumpPolicy::starting(), fwServices::AppConfigManager::stop(), fwDataTools::helper::Composite::swap(), visuVTKAdaptor::SImageMultiDistances::updating(), vtkSimpleMesh::SSimpleMeshDeformation::updating(), vtkCompositeMesh::RendererService::updating(), gui::action::SStarter::updating(), fwDataIO::writer::MeshWriter::write(), and vtkGdcmIO::SeriesDBLazyReader::~SeriesDBLazyReader().

#define OSLM_INFO_IF	(	message,
		cond
	)	OSL_INFO_IF(_SPYLOG_SPYLOGGER_, message, cond)

Conditionnal info stringstream message macros.

Definition at line 256 of file spyLog.hpp.

#define OSLM_LOG ( message )

Value:

__FWCORE_EXPR_BLOCK(                                      \
        std::stringstream stream;                                  \
        stream << message;                                         \
        _SPYLOG_SPYLOGGER_.log(stream.str(), __FILE__, __LINE__);  \
        )

Log message macros.

Definition at line 294 of file spyLog.hpp.

#define OSLM_TRACE ( message ) OSL_TRACE(_SPYLOG_SPYLOGGER_, message)

Trace stringstream message macros.

Definition at line 230 of file spyLog.hpp.

Referenced by fwAtomsPatch::patcher::DefaultPatcher::applyContextualPatch(), fwAtomsPatch::patcher::DefaultPatcher::applyStructuralPatch(), basicRegistration::SPointListRegistration::computeRegistration(), Tuto14MeshGenerator::AlgoMeshDeformation::computeSimu(), uiGenericQt::action::ShowHelpContents::configuring(), uiGenericQt::action::SShowAbout::configuring(), visuVTKAdaptor::SImageSlice::configuring(), fwMemory::BufferManager::dumpBuffer(), fwRuntime::getAllConfigurationElementsForPoint(), fwAtoms::Numeric::getString(), fwPacsIO::SeriesRetriever::handleSTORERequest(), vtkGdcmIO::helper::ImageDicomSource::ImageDicomSource(), fwMath::intersect_triangle(), fwGuiQt::TimerQt::isRunning(), fwRenderQt::Scene2DGraphicsView::keyPressEvent(), guiQt::editor::Code::onModifyValue(), fwGuiQt::SliceSelector::onSliceIndexChange(), fwGuiQt::dialog::ProgressDialog::operator()(), fwDcmtkIO::reader::main::ImageLazySource::read(), fwMemory::BufferManager::readBufferImpl(), itk::InrImageIO::ReadImageInformation(), fwGdcmIO::reader::ie::Image::readImagePixelModule(), fwGdcmIO::reader::ie::Image::readImagePlaneModule(), fwGdcmIO::reader::ie::Surface::readSurfaceMeshModule(), fwGdcmIO::reader::ie::Image::readVOILUTModule(), fwMemory::BufferManager::restoreBuffer(), fwRuntime::profile::Profile::start(), scene2D::adaptor::SCurvedHistogram::starting(), visuVTKAdaptor::SReconstruction::starting(), fwRuntime::Bundle::stop(), visuVTKAdaptor::SImagesProbeCursor::stopping(), visuVTKAdaptor::SProbeCursor::stopping(), fwAtomsPatch::PatchingManager::transformTo(), ioDicom::SSliceIndexDicomEditor::triggerNewSlice(), ioPacs::SSliceIndexDicomPullerEditor::triggerNewSlice(), visuVTKAdaptor::SImage::updateImageOpacity(), visuVTKAdaptor::SNegatoSlicingInteractor::updateSliceType(), opVTKMesh::SVTKMesher::updating(), opVTKMesh::action::SMeshCreation::updating(), guiQt::editor::Code::updating(), ctrlSelection::ImageUpdateAxis::updating(), gui::action::SPushObject::updating(), ioVTK::SImageSeriesReader::updating(), ioVTK::SImageReader::updating(), ioVTK::SImageSeriesWriter::updating(), ioDicomWeb::SSliceIndexDicomPullerEditor::updating(), ioVTK::SImageWriter::updating(), fwDataIO::writer::TransformationMatrix3DWriter::write(), fwDataIO::writer::GzBufferImageWriter::write(), fwMemory::BufferManager::writeBufferImpl(), fwGdcmIO::writer::ie::Image::writeImagePixelModule(), fwGdcmIO::writer::ie::Image::writeImagePlaneModule(), fwGdcmIO::writer::ie::SpatialFiducials::writeLandmarks(), fwGdcmIO::writer::ie::Image::writeVOILUTModule(), and vtkGdcmIO::SeriesDBLazyReader::~SeriesDBLazyReader().