C4Log.cpp File Reference

#include "C4Include.h"
#include "lib/C4Log.h"
#include "c4group/C4Components.h"
#include "editor/C4Console.h"
#include "game/C4GraphicsSystem.h"
#include "graphics/C4Shader.h"
#include "gui/C4GameLobby.h"
#include "lib/C4LogBuf.h"
#include "network/C4Network2.h"
#include "platform/C4Window.h"
#include "script/C4AulDebug.h"

Include dependency graph for C4Log.cpp:

Go to the source code of this file.

Functions
bool	OpenLog ()
bool	OpenExtraLogs ()
bool	CloseLog ()
int	GetLogFD ()
bool	LogSilent (const char *szMessage, bool fConsole)
bool	LogSilent (const char *szMessage)
bool	Log (const char *szMessage)
bool	LogFatal (const char *szMessage)
void	ResetFatalError ()
const char *	GetFatalError ()
bool	LogF (const char *strMessage,...)
bool	LogSilentF (const char *strMessage,...)
bool	DebugLog (const char *strMessage)
bool	DebugLogF (const char *strMessage ...)
size_t	GetLogPos ()
bool	GetLogSection (size_t iStart, size_t iLength, StdStrBuf &rsOut)
bool	ShaderLog (const char *szMessage)
bool	ShaderLogF (const char *strMessage ...)

Variables
FILE *	C4LogFile =nullptr
FILE *	C4ShaderLogFile = nullptr
time_t	C4LogStartTime
StdStrBuf	sLogFileName
StdStrBuf	sFatalError
int	iDisableLog = 0

Function Documentation

CloseLog()

bool CloseLog

(

)

Definition at line 107 of file C4Log.cpp.

{
    // close
    if (C4ShaderLogFile) fclose(C4ShaderLogFile);
    C4ShaderLogFile = nullptr;
    if (C4LogFile) fclose(C4LogFile);
    C4LogFile = nullptr;
    // ok
    return true;
}

References C4LogFile, and C4ShaderLogFile.

Referenced by C4Application::~C4Application().

Here is the caller graph for this function:

DebugLog()

bool DebugLog

(

const char *

strMessage

)

Definition at line 282 of file C4Log.cpp.

{
    if (Game.DebugMode)
        return Log(strMessage);
    else
        return LogSilent(strMessage);
}

References C4Game::DebugMode, Game, Log(), and LogSilent().

Referenced by DebugLogF(), C4AulScriptContext::dump(), C4Game::LoadScenarioComponents(), C4Game::LoadScenarioSection(), OpenExtraLogs(), C4InteractiveThread::ProcessEvents(), and C4PropListScen::SetPropertyByS().

Here is the call graph for this function:

Here is the caller graph for this function:

DebugLogF()

bool DebugLogF

(

const char *

strMessage ...

)

Definition at line 290 of file C4Log.cpp.

{
    va_list args; va_start(args, strMessage);
    StdStrBuf Buf;
    Buf.FormatV(strMessage, args);
    return DebugLog(Buf.getData());
}

References DebugLog(), StdStrBuf::FormatV(), and StdStrBuf::getData().

Referenced by C4MaterialMap::CrossMapMaterials(), C4ScenarioListLoader::SubFolder::DoLoadContents(), C4ScenarioListLoader::RegularFolder::DoLoadContents(), C4RoundResults::EvaluateGame(), C4GameObjects::FixObjectOrder(), C4AulExec::FnTranslate(), C4TextureMap::GetIndex(), C4TextureMap::GetIndexMatTex(), C4Object::GetInfoString(), C4TexMapEntry::Init(), C4ParticleDef::Load(), C4MapFolderData::Load(), C4DefGraphics::LoadBitmap(), C4Def::LoadDefCore(), C4TextureMap::LoadMap(), C4DefGraphics::LoadMesh(), C4Game::LoadScenarioSection(), C4DefGraphics::LoadSkeleton(), C4SoundSystem::NewEffect(), C4GameObjects::PostLoad(), C4MaterialReaction::ResolveScriptFuncs(), C4Landscape::SetTextureIndex(), StdCompilerWarnCallback(), and StdMeshMaterialParserCtx::WarningNotSupported().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFatalError()

const char* GetFatalError

(

)

Definition at line 257 of file C4Log.cpp.

{
    return sFatalError.getData();
}

References StdStrBuf::getData(), and sFatalError.

Referenced by C4Startup::DoStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLogFD()

int GetLogFD

(

)

Definition at line 118 of file C4Log.cpp.

{
    if (C4LogFile)
        return fileno(C4LogFile);
    else
        return -1;
}

References C4LogFile.

GetLogPos()

size_t GetLogPos

(

)

Definition at line 298 of file C4Log.cpp.

{
    // get current log position
    return FileSize(sLogFileName.getData());
}

References FileSize(), StdStrBuf::getData(), and sLogFileName.

Referenced by C4Game::Clear(), and C4Game::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLogSection()

bool GetLogSection	(	size_t	iStart,
		size_t	iLength,
		StdStrBuf &	rsOut
	)

Definition at line 304 of file C4Log.cpp.

{
    if (!iLength) { rsOut.Clear(); return true; }
    // read section from log file
    StdStrBuf BufOrig;
    if (!BufOrig.LoadFromFile(sLogFileName.getData())) return false;
    char *szBuf = BufOrig.getMData();
    size_t iSize = BufOrig.getSize(); // size excluding terminator
    // reduce to desired buffer section
    if (iStart > iSize) iStart = iSize;
    if (iStart + iLength > iSize) iLength = iSize - iStart;
    szBuf += iStart; szBuf[iLength] = '\0';
    // strip timestamps; convert linebreaks to Clonk-linebreaks '|'
    char *szPosWrite=szBuf; const char *szPosRead=szBuf;
    while (*szPosRead)
    {
        // skip timestamp
        if (*szPosRead == '[')
            while (*szPosRead && *szPosRead != ']') { --iSize; ++szPosRead; }
        // skip whitespace behind timestamp
        if (!*szPosRead) break;
        szPosRead++;
        // copy data until linebreak
        size_t iLen=0;
        while (*szPosRead && *szPosRead != 0x0d && *szPosRead != 0x0a)
            { ++szPosRead; ++iLen; }
        if (iLen && szPosRead-iLen != szPosWrite) memmove(szPosWrite, szPosRead-iLen, iLen);
        szPosWrite += iLen;
        // skip additional linebreaks
        while (*szPosRead == 0x0d || *szPosRead == 0x0a) ++szPosRead;
        // write a Clonk-linebreak
        if (*szPosRead) *szPosWrite++ = '|';
    }
    // done; create string buffer from data
    rsOut.Copy(szBuf, szPosWrite - szBuf);
    // done, success
    return true;
}

References StdStrBuf::Clear(), StdStrBuf::Copy(), StdStrBuf::getData(), StdStrBuf::getMData(), StdStrBuf::getSize(), iSize, StdStrBuf::LoadFromFile(), and sLogFileName.

Referenced by C4Startup::DoStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

Log()

bool Log

(

const char *

szMessage

)

Definition at line 204 of file C4Log.cpp.

{
    if (!Application.AssertMainThread()) return false;
    if (iDisableLog) return true;
    // security
    if (!szMessage) return false;
 
#ifndef NOAULDEBUG
    // Pass on to debugger
    if (C4AulDebug *pDebug = C4AulDebug::GetDebugger())
        pDebug->OnLog(szMessage);
#endif
    // Pass on to console
    Console.Out(szMessage);
    // pass on to lobby
    C4GameLobby::MainDlg *pLobby = ::Network.GetLobby();
    if (pLobby) pLobby->OnLog(szMessage);
 
    // Add message to log buffer
    bool fNotifyMsgBoard = false;
    if (::GraphicsSystem.MessageBoard)
    {
        ::GraphicsSystem.MessageBoard->AddLog(szMessage);
        fNotifyMsgBoard = true;
    }
 
    // log
    LogSilent(szMessage, true);
 
    // Notify message board
    if (fNotifyMsgBoard) ::GraphicsSystem.MessageBoard->LogNotify();
 
    return true;
}

References Application, C4AbstractApp::AssertMainThread(), Console, C4AulDebug::GetDebugger(), C4Network2::GetLobby(), GraphicsSystem, iDisableLog, LogSilent(), C4GraphicsSystem::MessageBoard, Network, C4GameLobby::MainDlg::OnLog(), and C4ConsoleGUI::Out().

Referenced by C4GameLobby::Countdown::Abort(), C4ClientList::Add(), C4Network2ResList::AddByFile(), C4Network2ResList::AddByGroup(), C4PlayerInfoList::AssignPlayerIDs(), C4Network2IO::Broadcast(), C4ClientPlayerInfos::C4ClientPlayerInfos(), C4GamePadControl::C4GamePadControl(), C4Game::CanQuickSave(), C4Playback::Check(), C4ObjectList::CheckSort(), C4Game::Clear(), C4Application::Clear(), ConsoleDlgProc(), C4AbstractApp::Copy(), C4GameLobby::Countdown::Countdown(), CStdGL::CreateContext(), C4Network2::CreateDynamic(), DebugLog(), C4Network2Res::Derive(), C4Game::DoGameOver(), C4Application::DoInit(), C4Network2::DoLobby(), C4GraphicsSystem::DoSaveScreenshot(), C4Player::Eliminate(), C4Draw::Error(), C4Game::Evaluate(), C4GameControl::ExecControl(), C4GameControl::ExecControlPacket(), C4Network2::FinalInit(), C4Network2Res::GetStandalone(), C4Network2Players::HandlePlayerInfoUpdRequest(), C4Game::Init(), C4Game::InitControl(), C4Game::InitDefs(), C4Game::InitGame(), C4Game::InitNetworkFromAddress(), C4PlayerList::Join(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdateProcessReply(), C4Network2::LeagueWaitNotBusy(), C4AulDebug::Listen(), C4SoundEffect::Load(), C4ParticleDef::Load(), C4MaterialMap::Load(), C4Config::Load(), C4Game::LoadAdditionalSystemGroup(), C4Extra::LoadDef(), C4Language::LoadLanguage(), C4GameLobby::LobbyError(), LogF(), LogFatal(), main(), C4MainMenu::MenuCommand(), C4Network2::OnClientDisconnect(), C4GameOptionButtons::OnCommentSet(), C4GameLobby::Countdown::OnSec1Timer(), C4Game::OpenScenario(), C4Network2Res::OptimizeStandalone(), C4Application::ParseCommandLine(), C4Application::PreInit(), CStdGL::PrepareMaterial(), C4MessageInput::ProcessCommand(), C4InteractiveThread::ProcessEvents(), ProcessGroup(), C4MessageInput::ProcessInput(), C4Game::QuickSave(), C4Game::ReloadDef(), C4PlayerList::RemoveAtClient(), C4PlayerList::RemoveAtRemoteClient(), C4PlayerList::RemoveLocal(), CStdNoGfx::RestoreDeviceObjects(), C4PlayerInfoList::RestoreSavegameInfos(), C4GameSave::Save(), C4GameSaveSavegame::SaveComponents(), C4Player::SetHostility(), C4MCParserErr::show(), C4Record::Start(), C4Playback::StreamToRecord(), C4Playback::Strip(), C4Player::Surrender(), C4PlayerList::SynchronizeLocalFiles(), C4Network2::Vote(), and C4PropListNumbered::~C4PropListNumbered().

Here is the call graph for this function:

LogF()

bool LogF	(	const char *	strMessage,
			...
	)

Definition at line 262 of file C4Log.cpp.

{
    va_list args; va_start(args, strMessage);
    // Compose formatted message
    StdStrBuf Buf;
    Buf.FormatV(strMessage, args);
    // Log
    return Log(Buf.getData());
}

References StdStrBuf::FormatV(), StdStrBuf::getData(), and Log().

Referenced by C4Group::AccessEntry(), C4MusicFile::Announce(), C4Application::ApplyResolutionConstraints(), C4ControlJoinPlayer::C4ControlJoinPlayer(), CStdGL::CheckGLError(), C4Network2UPnPP::ClearNatMappings(), CompileFromBuf_Log(), CompileFromBuf_LogWarn(), C4ObjectList::CompileFunc(), C4Game::CompileRuntimeData(), CStdGL::CreateContext(), C4FoWAmbient::CreateFromLandscape(), CreatePath(), C4PlayerInfoList::CreateRestoreInfosForJoinedScriptPlayers(), C4Playback::DebugRecError(), DecompileToBuf_Log(), C4Value::Denumerate(), C4Application::DoInit(), C4DownloadDlg::DownloadFile(), CStdGL::Error(), C4GameControlNetwork::ExecQueuedSyncCtrl(), C4GameControlNetwork::ExecSyncControl(), C4Player::Execute(), C4Control::Execute(), C4GUI::ExpandHotkeyMarkup(), C4ComponentHost::FinishLoad(), C4Network2Res::GetStandalone(), C4ValueNumbers::GetValue(), C4TextureMap::Init(), C4SoundModifierList::Init(), C4AchievementGraphics::Init(), C4AbstractApp::Init(), C4Network2IO::Init(), C4Player::Init(), C4Player::InitControl(), C4Game::InitDefs(), C4FontLoader::InitFont(), C4MusicSystem::InitForScenario(), C4MusicSystem::InitializeMOD(), C4Game::InitMaterialTexture(), C4Game::InitNetworkFromReference(), C4Network2::Join(), C4PlayerList::Join(), C4Network2::LeagueNotifyDisconnect(), C4Network2::LeaguePlrAuth(), C4Network2::LeagueShowError(), C4Network2::LeagueUpdate(), C4Game::LinkScriptEngine(), C4AulDebug::Listen(), C4TextureShape::Load(), C4Surface::Load(), C4DefList::Load(), C4Config::Load(), C4KeyboardInput::LoadCustomConfig(), C4Extra::LoadDef(), C4MusicSystem::LoadDir(), C4GameResList::LoadFoldersWithLocalDefs(), C4PlayerInfo::LoadResource(), StdMeshSkeletonLoader::LoadSkeletonBinary(), C4TextureMap::LoadTextures(), C4PlayerInfoList::LocalJoinUnjoinedPlayersInQueue(), C4GUI::ComponentAligner::LogIt(), main(), C4Playback::Open(), C4Game::OpenScenario(), C4Value::operator==(), C4Network2Res::OptimizeStandalone(), C4Application::ParseCommandLine(), C4EditCursor::PerformDuplication(), C4MusicFileSDL::Play(), C4MusicSystem::Play(), C4Control::PreExecute(), C4MessageInput::ProcessCommand(), ProcessGroup(), Ogre::Mesh::Chunk::Read(), Ogre::Skeleton::Chunk::Read(), C4Playback::ReadBinary(), Ogre::Mesh::ChunkMesh::ReadImpl(), Ogre::Mesh::ChunkSubmesh::ReadImpl(), Ogre::Mesh::ChunkGeometry::ReadImpl(), Ogre::Skeleton::ChunkAnimation::ReadImpl(), C4PlayerInfoList::RecreatePlayerFiles(), C4PlayerInfoList::RecreatePlayers(), C4AulScriptEngine::ReLink(), C4Game::ReloadDef(), C4Game::ReloadParticle(), C4LSectors::Remove(), C4PlayerInfoList::RemoveUnassociatedPlayers(), C4LangStringTable::ReplaceStrings(), C4PlayerControlAssignment::ResolveRefs(), C4PlayerInfoList::RestoreSavegameInfos(), C4Network2::RetrieveRes(), C4Playback::ReWriteBinary(), C4Config::Save(), C4Player::Save(), C4ObjectInfo::Save(), C4GameSave::Save(), C4Game::SaveData(), C4GraphicsSystem::SaveScreenshot(), C4Player::ScenarioInit(), C4MusicSystem::ScheduleWaitTime(), C4Network2IOConnection::Send(), C4Network2ResChunk::Set(), C4Network2Res::SetByFile(), C4Object::SetOCF(), C4MusicSystem::SetPlayList(), C4Landscape::SetTextureIndex(), C4AbstractApp::SetVideoMode(), C4Playback::StreamToRecord(), C4Object::UpdateOCF(), and C4InVal::ValidateString().

Here is the call graph for this function:

LogFatal()

bool LogFatal

(

const char *

szMessage

)

Definition at line 239 of file C4Log.cpp.

{
    if (!szMessage) szMessage = "(null)";
    // add to fatal error message stack - if not already in there (avoid duplication)
    if (!SSearch(sFatalError.getData(), szMessage))
    {
        if (!sFatalError.isNull()) sFatalError.AppendChar('|');
        sFatalError.Append(szMessage);
    }
    // write to log - note that Log might overwrite a static buffer also used in szMessage
    return !!Log(FormatString(LoadResStr("IDS_ERR_FATAL"), szMessage).getData());
}

References StdStrBuf::Append(), StdStrBuf::AppendChar(), FormatString(), StdStrBuf::getData(), StdStrBuf::isNull(), LoadResStr(), Log(), sFatalError, and SSearch().

Referenced by C4Game::CheckObjectEnumeration(), C4Network2ResList::CreateNetworkFolder(), C4MaterialMap::CrossMapMaterials(), C4Application::DoInit(), C4GameControlNetwork::DoInput(), C4Startup::EnsureLoaded(), C4GameControl::Execute(), C4Network2::HandleJoinData(), C4Game::Init(), C4GraphicsResource::Init(), C4Network2IO::Init(), C4LandscapeRenderGL::Init(), C4LoaderScreen::Init(), C4Game::InitControl(), C4Game::InitDefs(), C4FontLoader::InitFont(), C4StartupGraphics::InitFonts(), C4Network2::InitHost(), C4Network2::InitLeague(), C4Game::InitMaterialTexture(), C4GameRes::InitNetwork(), C4Game::InitNetworkFromAddress(), C4Game::InitNetworkFromReference(), C4Game::InitNetworkHost(), C4Game::InitPlayerControlSettings(), C4Game::InitPlayers(), C4GameControl::InitReplay(), C4Game::InitScriptEngine(), C4Network2::LeagueStart(), C4AulDebug::Listen(), C4GameParameters::Load(), C4DefList::Load(), C4Game::LoadScenarioComponents(), C4Playback::Open(), C4Game::OpenScenario(), C4Application::PreInit(), C4Game::PreInit(), C4InteractiveThread::ProcessEvents(), C4GraphicsResource::RegisterGlobalGraphics(), C4GroupSet::RegisterParentFolders(), C4LandscapeRenderGL::ReInit(), C4PlayerControlAssignment::ResolveRefs(), and C4Network2::RetrieveRes().

Here is the call graph for this function:

Here is the caller graph for this function:

LogSilent() [1/2]

bool LogSilent

(

const char *

szMessage

)

Definition at line 197 of file C4Log.cpp.

{
    return LogSilent(szMessage, false);
}

References LogSilent().

Here is the call graph for this function:

LogSilent() [2/2]

bool LogSilent	(	const char *	szMessage,
		bool	fConsole
	)

Definition at line 126 of file C4Log.cpp.

{
    if (!Application.AssertMainThread()) return false;
    // security
    if (!szMessage) return false;
 
    // add timestamp
    time_t timenow; time(&timenow);
    StdStrBuf TimeMessage;
    TimeMessage.SetLength(11 + SLen(szMessage) + 1);
    strftime(TimeMessage.getMData(), 11 + 1, "[%H:%M:%S] ", localtime(&timenow));
 
    // output until all data is written
    const char *pSrc = szMessage;
    do
    {
        // timestamp will always be that length
        char *pDest = TimeMessage.getMData() + 11;
 
        // copy rest of message, skip tags
        C4Markup Markup(false);
        while (*pSrc)
        {
            Markup.SkipTags(&pSrc);
            // break on crlf
            while (*pSrc == '\r') pSrc++;
            if (*pSrc == '\n') { pSrc++; break; }
            // copy otherwise
            if (*pSrc) *pDest++ = *pSrc++;
        }
        *pDest++='\n'; *pDest = '\0';
 
        // Save into log file
        if (C4LogFile)
        {
            fputs(TimeMessage.getData(),C4LogFile);
            fflush(C4LogFile);
        }
 
        // Save into record log file, if available
        if(Control.GetRecord())
        {
            Control.GetRecord()->GetLogFile()->Write(TimeMessage.getData(), TimeMessage.getLength());
            #ifdef IMMEDIATEREC
                Control.GetRecord()->GetLogFile()->Flush();
            #endif
        }
 
 
        // Write to console
        if (fConsole)
        {
#if defined(_WIN32)
            // debug: output to VC console when running with debugger
            // Otherwise, print to stdout to allow capturing the log.
            if (IsDebuggerPresent())
                OutputDebugString(TimeMessage.GetWideChar());
            else
#endif
            {
                fputs(TimeMessage.getData(),stdout);
                fflush(stdout);
            }
        }
 
    }
    while (*pSrc);
 
    return true;
}

References Application, C4AbstractApp::AssertMainThread(), C4LogFile, Control, CStdFile::Flush(), StdStrBuf::getData(), StdStrBuf::getLength(), C4Record::GetLogFile(), StdStrBuf::getMData(), C4GameControl::GetRecord(), StdStrBuf::SetLength(), C4Markup::SkipTags(), SLen(), and CStdFile::Write().

Referenced by C4ObjectList::CheckSort(), DebugLog(), C4LSectors::Dump(), Log(), LogSilent(), LogSilentF(), C4GameLobby::MainDlg::OnMessage(), C4InteractiveThread::ProcessEvents(), C4MainStat::Show(), C4FoWLightSection::Update(), and CPNGFile::WaitForSaves().

Here is the call graph for this function:

Here is the caller graph for this function:

LogSilentF()

bool LogSilentF	(	const char *	strMessage,
			...
	)

Definition at line 272 of file C4Log.cpp.

{
    va_list args; va_start(args, strMessage);
    // Compose formatted message
    StdStrBuf Buf;
    Buf.FormatV(strMessage, args);
    // Log
    return LogSilent(Buf.getData());
}

References StdStrBuf::FormatV(), StdStrBuf::getData(), and LogSilent().

Referenced by C4FoWLightSection::CalculateTriangles(), C4Network2::ChangeGameStatus(), C4ConfigNetwork::CheckPortsForCollisions(), C4Network2Res::Clear(), C4GUI::ConfirmationDialog::ConfirmationDialog(), C4Network2IO::ConnectWithSocket(), CStdGL::CreateContext(), C4Network2Client::DoConnectAttempt(), C4Network2Client::DoTCPSimultaneousOpen(), C4Network2Res::GetStandalone(), C4Network2::HandleConn(), C4Network2::HandleConnRe(), C4Network2::HandleJoinData(), C4Network2::HandleStatus(), C4Network2IO::Init(), C4Network2::OnClientDisconnect(), C4Network2::OnConnect(), C4Network2::OnConnectFail(), C4Network2::OnDisconn(), C4Network2::OnDisconnect(), C4Network2::OnStatusAck(), C4Network2Res::SetByFile(), C4Network2Res::SetByGroup(), C4MainStat::Show(), C4GUI::Screen::ShowMessage(), C4GUI::Screen::ShowMessageModal(), C4MainStat::ShowPart(), C4Game::Synchronize(), and C4FoWLightSection::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenExtraLogs()

bool OpenExtraLogs

(

)

Definition at line 83 of file C4Log.cpp.

{
    // shader log in editor mode (only one file)
    bool success = true;
    if (C4Shader::IsLogging())
    {
#ifdef _WIN32
        C4ShaderLogFile = _fsopen(Config.AtUserDataPath(C4CFN_LogShader), "wt", _SH_DENYWR);
#elif defined(HAVE_SYS_FILE_H)
        C4ShaderLogFile = fopen(Config.AtUserDataPath(C4CFN_LogShader), "wb");
        if (C4ShaderLogFile && flock(fileno(C4ShaderLogFile), LOCK_EX | LOCK_NB) != 0)
        {
            DebugLog("Couldn't lock shader log file, closing.");
            fclose(C4ShaderLogFile);
            C4ShaderLogFile = nullptr;
        }
#else
        C4ShaderLogFile = fopen(Config.AtUserDataPath(C4CFN_LogShader), "wb");
#endif
        if (!C4ShaderLogFile) success = false;
    }
    return success;
}

References C4Config::AtUserDataPath(), C4CFN_LogShader, C4ShaderLogFile, Config, DebugLog(), and C4Shader::IsLogging().

Referenced by C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenLog()

bool OpenLog

(

)

Definition at line 48 of file C4Log.cpp.

{
    // open
    sLogFileName = C4CFN_Log; int iLog = 2;
#ifdef _WIN32
    while (!(C4LogFile = _fsopen(Config.AtUserDataPath(sLogFileName.getData()), "wt", _SH_DENYWR)))
#elif defined(HAVE_SYS_FILE_H)
    int fd = 0;
    while (!(fd = open(Config.AtUserDataPath(sLogFileName.getData()), O_WRONLY | O_CREAT, 0644)) || flock(fd, LOCK_EX|LOCK_NB))
#else
    while (!(C4LogFile = fopen(Config.AtUserDataPath(sLogFileName.getData()), "wb")))
#endif
    {
        // Already locked by another instance?
#if !defined(_WIN32) && defined(HAVE_SYS_FILE_H)
        if (fd) close(fd);
#else
        if (C4LogFile) fclose(C4LogFile);
#endif
        // If the file does not yet exist, the directory is r/o
        // don't go on then, or we have an infinite loop
        if (access(Config.AtUserDataPath(sLogFileName.getData()), 0))
            return false;
        // try different name
        sLogFileName.Format(C4CFN_LogEx, iLog++);
    }
#if !defined(_WIN32) && defined(HAVE_SYS_FILE_H)
    ftruncate(fd, 0);
    C4LogFile = fdopen(fd, "wb");
#endif
    // save start time
    time(&C4LogStartTime);
    return true;
}

References C4Config::AtUserDataPath(), C4CFN_Log, C4CFN_LogEx, C4LogFile, C4LogStartTime, Config, StdStrBuf::Format(), StdStrBuf::getData(), and sLogFileName.

Referenced by C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetFatalError()

void ResetFatalError

(

)

Definition at line 252 of file C4Log.cpp.

{
    sFatalError.Clear();
}

References StdStrBuf::Clear(), and sFatalError.

Referenced by C4Startup::DoStartup().

Here is the call graph for this function:

Here is the caller graph for this function:

ShaderLog()

bool ShaderLog

(

const char *

szMessage

)

Definition at line 343 of file C4Log.cpp.

{
    // security
    if (!C4ShaderLogFile) return false;
    if (!Application.AssertMainThread()) return false;
    if (!szMessage) return false;
    // output into shader log file
    fputs(szMessage, C4ShaderLogFile);
    fputs("\n", C4ShaderLogFile);
    fflush(C4ShaderLogFile);
    return true;
}

References Application, C4AbstractApp::AssertMainThread(), and C4ShaderLogFile.

Referenced by C4Shader::Init(), and ShaderLogF().

Here is the call graph for this function:

Here is the caller graph for this function:

ShaderLogF()

bool ShaderLogF

(

const char *

strMessage ...

)

Definition at line 356 of file C4Log.cpp.

{
    va_list args; va_start(args, strMessage);
    StdStrBuf Buf;
    Buf.FormatV(strMessage, args);
    return ShaderLog(Buf.getData());
}

References StdStrBuf::FormatV(), StdStrBuf::getData(), and ShaderLog().

Referenced by C4Shader::Init(), and C4Shader::Refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C4LogFile

FILE* C4LogFile =nullptr

Definition at line 41 of file C4Log.cpp.

Referenced by CloseLog(), GetLogFD(), LogSilent(), and OpenLog().

C4LogStartTime

time_t C4LogStartTime

Definition at line 43 of file C4Log.cpp.

Referenced by OpenLog().

C4ShaderLogFile

FILE* C4ShaderLogFile = nullptr

Definition at line 42 of file C4Log.cpp.

Referenced by CloseLog(), OpenExtraLogs(), and ShaderLog().

iDisableLog

int iDisableLog = 0

Definition at line 202 of file C4Log.cpp.

Referenced by Log().

sFatalError

StdStrBuf sFatalError

Definition at line 46 of file C4Log.cpp.

Referenced by GetFatalError(), LogFatal(), and ResetFatalError().

sLogFileName

StdStrBuf sLogFileName

Definition at line 44 of file C4Log.cpp.

Referenced by GetLogPos(), GetLogSection(), and OpenLog().