Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Properties.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Properties.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.io.Properties;
00037 
00038 private import  mango.utils.Text;
00039 
00040 private import  mango.io.Token,
00041                 mango.io.Tokenizer,
00042                 mango.io.FileConduit;
00043 
00044 private import  mango.io.model.IConduit;
00045 
00046 /*******************************************************************************
00047         
00048         Provides load facilities for a properties file. That is, a file
00049         or other medium containing lines of text with a name=value layout.
00050 
00051 *******************************************************************************/
00052 
00053 class Properties
00054 {
00055         /***********************************************************************
00056         
00057                 Load properties from the named file, and pass each of them
00058                 to the provided delegate.
00059 
00060         ***********************************************************************/
00061 
00062         static void load (char[] filepath, void delegate (char[]name, char[] value) dg)
00063         {
00064                 FileConduit fc = new FileConduit (filepath, FileStyle.ReadExisting);
00065 
00066                 try {
00067                     load (fc, dg);
00068                     } finally 
00069                             fc.close();
00070         }
00071 
00072         /***********************************************************************
00073         
00074                 Load properties from the provided conduit, and pass them to
00075                 the provided delegate.
00076 
00077         ***********************************************************************/
00078 
00079         static void load (IConduit conduit, void delegate (char[]name, char[] value) dg)
00080         {
00081                 // bind the input to a line tokenizer
00082                 CompositeToken line = new CompositeToken (Tokenizers.line, conduit);
00083 
00084                 // scan all lines
00085                 while (line.get)
00086                       {
00087                       char[] text = Text.trim (line.toString);
00088                         
00089                       // comments require '#' as the first non-whitespace char 
00090                       if (text.length && (text[0] != '#'))
00091                          {
00092                          // find the '=' char
00093                          int i = Text.indexOf (text, '=');
00094 
00095                          // ignore if not found ...
00096                          if (i > 0)
00097                              dg (Text.trim (text[0..i]), Text.trim (text[i+1..text.length]));
00098                          }
00099                       }
00100         }
00101 }

Generated on Sun Nov 7 19:06:52 2004 for Mango by doxygen 1.3.6