topical media & game development
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

talk show tell print

game-xna-intro-XnaBreakout-Helpers-Log.cs / cs



  // Project: XnaBreakout, File: Log.cs
  // Namespace: XnaBreakout.Helpers, Class: Log
  // Creation date: 22.11.2004 09:51
  // Last modified: 01.11.2005 18:31
  // Generated with Commenter by abi.exDream.com
  
  #region Using directives
  using System;
  using System.IO;
  using System.Collections;
  using System.ComponentModel;
  using System.Threading;
  if UNIT_TESTING
  //using NUnit.Framework;
  endif
  #endregion
  
  namespace XnaBreakout.Helpers
  {
<summary> Log will create automatically a log file and write log/error/debug info for simple runtime error checking, very useful for minor errors, such as finding not files. The application can still continue working, but this log provides an easy support to find out what files are missing (in this example). Note: I don't use this class anymore for big projects, but its small and handy for smaller projects and nice to log non-debugable stuff. </summary> public class Log { #region Variables <summary> Writer </summary> private static StreamWriter writer = null;
<summary> Log filename </summary> private const string LogFilename = "Log.txt"; #endregion 

                  #region Static constructor to create log file
<summary> Static constructor </summary> static Log() { try { // Open file FileStream file = FileHelper.OpenFileForCurrentPlayer( LogFilename, FileMode.OpenOrCreate, FileAccess.Write); //old: new FileStream( // LogFilename, FileMode.OpenOrCreate, // FileAccess.Write, FileShare.ReadWrite); 

                                  // Check if file is too big (more than 2 MB),
                                  // in this case we just kill it and create a new one :)
                                  if (file.Length > 2*1024*1024)
                                  {
                                          file.Close();
                                          file = FileHelper.OpenFileForCurrentPlayer(
                                                  LogFilename, FileMode.Create, FileAccess.Write);
                                          //old: file = new FileStream(
                                          //        LogFilename, FileMode.Create,
                                          //        FileAccess.Write, FileShare.ReadWrite );
                                  } // if (file.Length)
                                  // Associate writer with that, when writing to a new file,
                                  // make sure UTF-8 sign is written, else don't write it again!
                                  if (file.Length == 0)
                                          writer = new StreamWriter(file,
                                                  System.Text.Encoding.UTF8);
                                  else
                                          writer = new StreamWriter(file);
  
                                  // Go to end of file
                                  writer.BaseStream.Seek(0, SeekOrigin.End);
  
                                  // Enable auto flush (always be up to date when reading!)
                                  writer.AutoFlush = true;
  
                                  // Add some info about this session
                                  writer.WriteLine("");
                                  writer.WriteLine("
 Session started at: "+


                                          StringHelper.WriteIsoDateAndTime(DateTime.Now));
                                  writer.WriteLine("
 XnaBreakout");


                                  writer.WriteLine("");
                          } // try
                          catch
                          {
                                  // Ignore any file exceptions, if file is not
                                  // createable (e.g. on a CD-Rom) it doesn't matter.
                          } // catch
                  } // Log()
                  #endregion
  
                  #region Write log entry
<summary> Writes a LogType and info/error message string to the Log file </summary> static public void Write(string message) { // Can't continue without valid writer if (writer == null) return; 

                          try
                          {
                                  DateTime ct = DateTime.Now;
                                  string s = "[" + ct.Hour.ToString("00") + ":" +
                                          ct.Minute.ToString("00") + ":" +
                                          ct.Second.ToString("00") + "] " +
                                          message;
                                  writer.WriteLine(s);
  
  if DEBUG
                                  // In debug mode write that message to the console as well!
                                  System.Console.WriteLine(s);
  endif
                          } // try
                          catch
                          {
                                  // Ignore any file exceptions, if file is not
                                  // writable (e.g. on a CD-Rom) it doesn't matter
                          } // catch
                  } // Write(message)
                  #endregion
          } // class Log
  } // namespace XnaBreakout.Helpers
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

(C) Æliens 20/2/2008

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.