Log Struct Reference

#include <Log.h>

Overview

A Log4J-inspired log appender.

Definition at line 61 of file Log.h.

Inheritance diagram for Log:

Properties
FILE *	file
	The file descriptor (defaults to stdout).
const char *	format
	The format string, defaults to LOG_FORMAT_DEFAULT. This string is post-processed after date substitution is performed by strftime. The following additional tokens are supported:
LogLevel	level
	The LogLevel of this Log.
char *	name
	The name of this Log.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_Log (void)
	The Log archetype.
void	debug (const Log *self, const char *fmt,...)
	Log a debug message.
void	error (const Log *self, const char *fmt,...)
	Log an error message.
void	fatal (const Log *self, const char *fmt,...)
	Log a fatal message.
void	flush (const Log *self)
	Flushes and pending output to this Log's file.
void	info (const Log *self, const char *fmt,...)
	Log an info message.
Log *	init (Log *self)
	Initializes this Log.
Log *	initWithName (Log *self, const char *name)
	Initializes this Log with the specified name.
void	log (const Log *self, LogLevel level, const char *fmt, va_list args)
	Write a message to the Log.
Log *	sharedInstance (void)
void	trace (const Log *self, const char *fmt,...)
	Log a trace message.
void	warn (const Log *self, const char *fmt,...)
	Log a warn message.
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
LogInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

file

FILE* Log::file

The file descriptor (defaults to stdout).

Remarks

Non-tty files are closed when the Log is deallocated.

Definition at line 88 of file Log.h.

format

const char* Log::format

The format string, defaults to LOG_FORMAT_DEFAULT. This string is post-processed after date substitution is performed by strftime. The following additional tokens are supported:

• %n - The Log name.
• %l - The message level.
• %m - The message.

Definition at line 82 of file Log.h.

interface

LogInterface* Log::interface

protected

The interface.

Definition at line 72 of file Log.h.

level

LogLevel Log::level

The LogLevel of this Log.

Definition at line 93 of file Log.h.

name

char* Log::name

The name of this Log.

Definition at line 98 of file Log.h.

object

Object Log::object

The superclass.

Definition at line 66 of file Log.h.

Method Details

_Log()

Class * _Log

(

void

)

The Log archetype.

Returns

The Log Class.

Definition at line 285 of file Log.c.

                  {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Log",
      .superclass = _Object(),
      .instanceSize = sizeof(Log),
      .interfaceOffset = offsetof(Log, interface),
      .interfaceSize = sizeof(LogInterface),
      .initialize = initialize,
      .destroy = destroy,
    });
  });
 
  return clazz;
}

debug()

void debug	(	const Log *	self,
		const char *	fmt,
			...
	)

Log a debug message.

Parameters

self	The Log.
fmt	The format string.

Definition at line 66 of file Log.c.

                                                         {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelDebug, fmt, args);
 
  va_end(args);
}

error()

void(*) void error(const Log *self, const char *fmt,...)	(	const Log *	self,
		const char *	fmt,
			...
	)

Log an error message.

Parameters

self	The Log.
fmt	The format string.

Definition at line 80 of file Log.c.

                                                         {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelError, fmt, args);
 
  va_end(args);
}

fatal()

void(*) void fatal(const Log *self, const char *fmt,...)	(	const Log *	self,
		const char *	fmt,
			...
	)

Log a fatal message.

Parameters

self	The Log.
fmt	The format string.

Definition at line 94 of file Log.c.

                                                         {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelFatal, fmt, args);
 
  va_end(args);
}

flush()

void(*) void flush(const Log *self)

(

const Log *

self

)

Flushes and pending output to this Log's file.

Parameters

self

The Log.

Definition at line 108 of file Log.c.

                                   {
 
  assert(self->file);
  fflush(self->file);
}

info()

void info	(	const Log *	self,
		const char *	fmt,
			...
	)

Log an info message.

Parameters

self	The Log.
fmt	The format string.

Definition at line 118 of file Log.c.

                                                        {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelInfo, fmt, args);
 
  va_end(args);
}

init()

void(*) Log * init(Log *self)

(

Log *

self

)

Initializes this Log.

Parameters

self

The Log.

Returns

The initialized Log, or NULL on error.

Definition at line 132 of file Log.c.

                            {
 
  return $(self, initWithName, NULL);
}

initWithName()

Log * initWithName	(	Log *	self,
		const char *	name
	)

Initializes this Log with the specified name.

Parameters

self	The Log.
name	The Log name.

Returns

The initialized Log, or NULL on error.

Definition at line 141 of file Log.c.

                                                      {
 
  self = (Log *) super(Object, self, init);
  if (self) {
    self->name = strdup(name ?: "default");
    self->level = LogLevelInfo;
    self->format = LOG_FORMAT_DEFAULT;
    self->file = stdout;
  }
 
  return self;
}

log()

void log	(	const Log *	self,
		LogLevel	level,
		const char *	fmt,
		va_list	args
	)

Write a message to the Log.

Parameters

self	The Log.
level	The severity of the message, which must be greater than or equal to the configured level of this Log.
fmt	The format string.
args	The format arguments.

sharedInstance()

Log * sharedInstance

(

void

)

Returns

The shared Log instance.

Definition at line 212 of file Log.c.

                                 {
 
  static Once once;
 
  do_once(&once, {
    _sharedInstance = $(alloc(Log), init);
  });
 
  return _sharedInstance;
}

trace()

void trace	(	const Log *	self,
		const char *	fmt,
			...
	)

Log a trace message.

Definition at line 227 of file Log.c.

                                                         {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelTrace, fmt, args);
 
  va_end(args);
}

warn()

void(*) void warn(const Log *self, const char *fmt,...)	(	const Log *	self,
		const char *	fmt,
			...
	)

Log a warn message.

Definition at line 241 of file Log.c.

                                                        {
 
  va_list args;
  va_start(args, fmt);
 
  $(self, log, LogLevelWarn, fmt, args);
 
  va_end(args);
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Log.h
• Sources/Objectively/Log.c