assimp/code/DefaultLogger.cpp at master · Tidal-Loop/assimp · GitHub

This repository was archived by the owner on Apr 24, 2026. It is now read-only.

History

426 lines (357 loc) · 12.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

---------------------------------------------------------------------------

Open Asset Import Library (assimp)

---------------------------------------------------------------------------

Redistribution and use of this software in source and binary forms,

with or without modification, are permitted provided that the following

conditions are met:

* Redistributions of source code must retain the above

following disclaimer.

* Redistributions in binary form must reproduce the above

following disclaimer in the documentation and/or other

materials provided with the distribution.

* Neither the name of the assimp team, nor the names of its

contributors may be used to endorse or promote products

derived from this software without specific prior

written permission of the assimp team.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---------------------------------------------------------------------------

/** @file DefaultLogger.cpp

* @brief Implementation of DefaultLogger (and Logger)

#include "DefaultIOSystem.h"

// Default log streams

#include "Win32DebugLogStream.h"

#include "StdOStreamLogStream.h"

#include "FileLogStream.h"

#include "StringUtils.h"

#include "../include/assimp/NullLogger.hpp"

#include "../include/assimp/DefaultLogger.hpp"

#include "../include/assimp/ai_assert.h"

#include <iostream>

#include <stdio.h>

#ifndef ASSIMP_BUILD_SINGLETHREADED

# include <boost/thread/thread.hpp>

# include <boost/thread/mutex.hpp>

boost::mutex loggerMutex;

#endif

namespace Assimp {

// ----------------------------------------------------------------------------------

NullLogger DefaultLogger::s_pNullLogger;

Logger *DefaultLogger::m_pLogger = &DefaultLogger::s_pNullLogger;

static const unsigned int SeverityAll = Logger::Info | Logger::Err | Logger::Warn | Logger::Debugging;

// ----------------------------------------------------------------------------------

// Represents a log-stream + its error severity

struct LogStreamInfo

{

unsigned int m_uiErrorSeverity;

LogStream *m_pStream;

// Constructor

LogStreamInfo( unsigned int uiErrorSev, LogStream *pStream ) :

m_uiErrorSeverity( uiErrorSev ),

m_pStream( pStream )

{

// empty

}

// Destructor

~LogStreamInfo()

{

delete m_pStream;

}

};

// ----------------------------------------------------------------------------------

// Construct a default log stream

LogStream* LogStream::createDefaultStream(aiDefaultLogStream streams,

const char* name /*= "AssimpLog.txt"*/,

IOSystem* io /*= NULL*/)

{

switch (streams)

{

// This is a platform-specific feature

case aiDefaultLogStream_DEBUGGER:

#ifdef WIN32

return new Win32DebugLogStream();

#else

return NULL;

#endif

// Platform-independent default streams

case aiDefaultLogStream_STDERR:

return new StdOStreamLogStream(std::cerr);

case aiDefaultLogStream_STDOUT:

return new StdOStreamLogStream(std::cout);

case aiDefaultLogStream_FILE:

return (name && *name ? new FileLogStream(name,io) : NULL);

default:

// We don't know this default log stream, so raise an assertion

ai_assert(false);

};

// For compilers without dead code path detection

return NULL;

}

// ----------------------------------------------------------------------------------

// Creates the only singleton instance

Logger *DefaultLogger::create(const char* name /*= "AssimpLog.txt"*/,

LogSeverity severity /*= NORMAL*/,

unsigned int defStreams /*= aiDefaultLogStream_DEBUGGER | aiDefaultLogStream_FILE*/,

IOSystem* io /*= NULL*/)

{

// enter the mutex here to avoid concurrency problems

#ifndef ASSIMP_BUILD_SINGLETHREADED

boost::mutex::scoped_lock lock(loggerMutex);

#endif

if (m_pLogger && !isNullLogger() )

delete m_pLogger;

m_pLogger = new DefaultLogger( severity );

// Attach default log streams

// Stream the log to the MSVC debugger?

if (defStreams & aiDefaultLogStream_DEBUGGER)

m_pLogger->attachStream( LogStream::createDefaultStream(aiDefaultLogStream_DEBUGGER));

// Stream the log to COUT?

if (defStreams & aiDefaultLogStream_STDOUT)

m_pLogger->attachStream( LogStream::createDefaultStream(aiDefaultLogStream_STDOUT));

// Stream the log to CERR?

if (defStreams & aiDefaultLogStream_STDERR)

m_pLogger->attachStream( LogStream::createDefaultStream(aiDefaultLogStream_STDERR));

// Stream the log to a file

if (defStreams & aiDefaultLogStream_FILE && name && *name)

m_pLogger->attachStream( LogStream::createDefaultStream(aiDefaultLogStream_FILE,name,io));

return m_pLogger;

}

// ----------------------------------------------------------------------------------

void Logger::debug(const char* message) {

// SECURITY FIX: otherwise it's easy to produce overruns since

// sometimes importers will include data from the input file

// (i.e. node names) in their messages.

if (strlen(message)>MAX_LOG_MESSAGE_LENGTH) {

return;

}

return OnDebug(message);

}

// ----------------------------------------------------------------------------------

void Logger::info(const char* message) {

// SECURITY FIX: see above

if (strlen(message)>MAX_LOG_MESSAGE_LENGTH) {

return;

}

return OnInfo(message);

}

// ----------------------------------------------------------------------------------

void Logger::warn(const char* message) {

// SECURITY FIX: see above

if (strlen(message)>MAX_LOG_MESSAGE_LENGTH) {

return;

}

return OnWarn(message);

}

// ----------------------------------------------------------------------------------

void Logger::error(const char* message) {

// SECURITY FIX: see above

if (strlen(message)>MAX_LOG_MESSAGE_LENGTH) {

return;

}

return OnError(message);

}

// ----------------------------------------------------------------------------------

void DefaultLogger::set( Logger *logger )

{

// enter the mutex here to avoid concurrency problems

#ifndef ASSIMP_BUILD_SINGLETHREADED

boost::mutex::scoped_lock lock(loggerMutex);

#endif

if (!logger)logger = &s_pNullLogger;

if (m_pLogger && !isNullLogger() )

delete m_pLogger;

DefaultLogger::m_pLogger = logger;

}

// ----------------------------------------------------------------------------------

bool DefaultLogger::isNullLogger()

{

return m_pLogger == &s_pNullLogger;

}

// ----------------------------------------------------------------------------------

Logger *DefaultLogger::get() {

return m_pLogger;

}

// ----------------------------------------------------------------------------------

// Kills the only instance

void DefaultLogger::kill()

{

// enter the mutex here to avoid concurrency problems

#ifndef ASSIMP_BUILD_SINGLETHREADED

boost::mutex::scoped_lock lock(loggerMutex);

#endif

if ( m_pLogger == &s_pNullLogger ) {

return;

}

delete m_pLogger;

m_pLogger = &s_pNullLogger;

}

// ----------------------------------------------------------------------------------

// Debug message

void DefaultLogger::OnDebug( const char* message )

{

if ( m_Severity == Logger::NORMAL )

return;

static const size_t Size = MAX_LOG_MESSAGE_LENGTH + 16;

char msg[Size];

ai_snprintf(msg, Size, "Debug, T%u: %s", GetThreadID(), message);

WriteToStreams( msg, Logger::Debugging );

}

// ----------------------------------------------------------------------------------

// Logs an info

void DefaultLogger::OnInfo( const char* message )

{

static const size_t Size = MAX_LOG_MESSAGE_LENGTH + 16;

char msg[Size];

ai_snprintf(msg, Size, "Info, T%u: %s", GetThreadID(), message );

WriteToStreams( msg , Logger::Info );

}

// ----------------------------------------------------------------------------------

// Logs a warning

void DefaultLogger::OnWarn( const char* message )

{

static const size_t Size = MAX_LOG_MESSAGE_LENGTH + 16;

char msg[Size];

ai_snprintf(msg, Size, "Warn, T%u: %s", GetThreadID(), message );

WriteToStreams( msg, Logger::Warn );

}

// ----------------------------------------------------------------------------------

// Logs an error

void DefaultLogger::OnError( const char* message )

{

static const size_t Size = MAX_LOG_MESSAGE_LENGTH + 16;

char msg[ Size ];

ai_snprintf(msg, Size, "Error, T%u: %s", GetThreadID(), message );

WriteToStreams( msg, Logger::Err );

}

// ----------------------------------------------------------------------------------

// Will attach a new stream

bool DefaultLogger::attachStream( LogStream *pStream, unsigned int severity )

{

if (!pStream)

return false;

if (0 == severity) {

severity = Logger::Info | Logger::Err | Logger::Warn | Logger::Debugging;

}

for ( StreamIt it = m_StreamArray.begin();

it != m_StreamArray.end();

++it )

{

if ( (*it)->m_pStream == pStream )

{

(*it)->m_uiErrorSeverity |= severity;

return true;

}

LogStreamInfo *pInfo = new LogStreamInfo( severity, pStream );

m_StreamArray.push_back( pInfo );

return true;

}

// ----------------------------------------------------------------------------------

// Detach a stream

bool DefaultLogger::detatchStream( LogStream *pStream, unsigned int severity )

{

if (!pStream)

return false;

if (0 == severity) {

severity = SeverityAll;

}

for ( StreamIt it = m_StreamArray.begin();

it != m_StreamArray.end();

++it )

{

if ( (*it)->m_pStream == pStream )

{

(*it)->m_uiErrorSeverity &= ~severity;

if ( (*it)->m_uiErrorSeverity == 0 )

{

// don't delete the underlying stream 'cause the caller gains ownership again

(**it).m_pStream = NULL;

delete *it;

m_StreamArray.erase( it );

break;

}

return true;

}

return false;

}

// ----------------------------------------------------------------------------------

// Constructor

DefaultLogger::DefaultLogger(LogSeverity severity)

: Logger ( severity )

, noRepeatMsg (false)

, lastLen( 0 )

{

lastMsg[0] = '\0';

}

// ----------------------------------------------------------------------------------

// Destructor

DefaultLogger::~DefaultLogger()

{

for ( StreamIt it = m_StreamArray.begin(); it != m_StreamArray.end(); ++it ) {

// also frees the underlying stream, we are its owner.

delete *it;

}

// ----------------------------------------------------------------------------------

// Writes message to stream

void DefaultLogger::WriteToStreams(const char *message, ErrorSeverity ErrorSev )

{

ai_assert(NULL != message);

// Check whether this is a repeated message

if (! ::strncmp( message,lastMsg, lastLen-1))

{

if (!noRepeatMsg)

{

noRepeatMsg = true;

message = "Skipping one or more lines with the same contents\n";

}

else return;

}

else

{

// append a new-line character to the message to be printed

lastLen = ::strlen(message);

::memcpy(lastMsg,message,lastLen+1);

::strcat(lastMsg+lastLen,"\n");

message = lastMsg;

noRepeatMsg = false;

++lastLen;

}

for ( ConstStreamIt it = m_StreamArray.begin();

it != m_StreamArray.end();

++it)

{

if ( ErrorSev & (*it)->m_uiErrorSeverity )

(*it)->m_pStream->write( message);

}

// ----------------------------------------------------------------------------------

// Returns thread id, if not supported only a zero will be returned.

unsigned int DefaultLogger::GetThreadID()

{

// fixme: we can get this value via boost::threads

#ifdef WIN32

return (unsigned int)::GetCurrentThreadId();

#else

return 0; // not supported

#endif

}

// ----------------------------------------------------------------------------------

} // !namespace Assimp

assimp/code/DefaultLogger.cpp at master · Tidal-Loop/assimp · GitHub

Expand file tree

Breadcrumbs

DefaultLogger.cpp

Latest commit

History

Breadcrumbs

DefaultLogger.cpp

File metadata and controls