00001 /******************************************************************************* 00002 00003 @file Appender.d 00004 00005 Copyright (C) 2004 Kris Bell 00006 00007 This software is provided 'as-is', without any express or implied 00008 warranty. In no event will the authors be held liable for damages 00009 of any kind arising from the use of this software. 00010 00011 Permission is hereby granted to anyone to use this software for any 00012 purpose, including commercial applications, and to alter it and/or 00013 redistribute it freely, subject to the following restrictions: 00014 00015 1. The origin of this software must not be misrepresented; you must 00016 not claim that you wrote the original software. If you use this 00017 software in a product, an acknowledgment within documentation of 00018 said product would be appreciated but is not required. 00019 00020 2. Altered source versions must be plainly marked as such, and must 00021 not be misrepresented as being the original software. 00022 00023 3. This notice may not be removed or altered from any distribution 00024 of the source. 00025 00026 00027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 00028 00029 00030 @version Initial version, May 2004 00031 @author Kris 00032 00033 00034 *******************************************************************************/ 00035 00036 module mango.log.Appender; 00037 00038 public import mango.log.Event, 00039 mango.log.Logger, 00040 mango.log.Layout, 00041 mango.log.Manager; 00042 00043 /******************************************************************************* 00044 00045 Base class for all Appenders. These objects are responsible for 00046 emitting messages sent to a particular logger. There may be more 00047 than one appender attached to any logger. The actual message is 00048 constructed by another class known as a Layout. 00049 00050 *******************************************************************************/ 00051 00052 public class Appender 00053 { 00054 private Appender next; 00055 private Layout layout; 00056 00057 /*********************************************************************** 00058 00059 Return the mask used to identify this Appender. The mask 00060 is used to figure out whether an appender has already been 00061 invoked for a particular logger. 00062 00063 ***********************************************************************/ 00064 00065 abstract uint getMask (); 00066 00067 /*********************************************************************** 00068 00069 Return the name of this Appender. 00070 00071 ***********************************************************************/ 00072 00073 abstract char[] getName (); 00074 00075 /*********************************************************************** 00076 00077 Append a message to the output. 00078 00079 ***********************************************************************/ 00080 00081 abstract void append (Event event); 00082 00083 /*********************************************************************** 00084 00085 Create an Appender and default its layout to SimpleLayout. 00086 00087 ***********************************************************************/ 00088 00089 this () 00090 { 00091 layout = SimpleLayout.simpleLayout; 00092 } 00093 00094 /*********************************************************************** 00095 00096 Static method to return a mask for identifying the Appender. 00097 Each Appender class should have a unique fingerprint so that 00098 we can figure out which ones have been invoked for a given 00099 event. A bitmask is a simple an efficient way to do that. 00100 00101 ***********************************************************************/ 00102 00103 protected static uint nextMask() 00104 { 00105 static uint mask = 1; 00106 00107 uint ret = mask; 00108 mask <<= 1; 00109 return ret; 00110 } 00111 00112 /*********************************************************************** 00113 00114 Set the current layout to be that of the argument. 00115 00116 ***********************************************************************/ 00117 00118 void setLayout (Layout layout) 00119 { 00120 this.layout = layout; 00121 } 00122 00123 /*********************************************************************** 00124 00125 Return the current Layout 00126 00127 ***********************************************************************/ 00128 00129 Layout getLayout () 00130 { 00131 return layout; 00132 } 00133 00134 /*********************************************************************** 00135 00136 Attach another appender to this one 00137 00138 ***********************************************************************/ 00139 00140 void setNext (Appender next) 00141 { 00142 this.next = next; 00143 } 00144 00145 /*********************************************************************** 00146 00147 Return the next appender in the list 00148 00149 ***********************************************************************/ 00150 00151 Appender getNext () 00152 { 00153 return next; 00154 } 00155 00156 /*********************************************************************** 00157 00158 Close this appender. This would be used for file, sockets, 00159 and such like. 00160 00161 ***********************************************************************/ 00162 00163 void close () 00164 { 00165 } 00166 }