Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | 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         4. Derivative works are permitted, but they must carry this notice
00027            in full and credit the original source.
00028 
00029 
00030                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00031 
00032 
00033         @version        Initial version, May 2004      
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.io.Properties;
00040 
00041 private import  mango.utils.Text;
00042 
00043 private import  mango.io.Token,
00044                 mango.io.Tokenizer,
00045                 mango.io.FileConduit;
00046 
00047 private import  mango.io.model.IConduit;
00048 
00049 /*******************************************************************************
00050         
00051         Provides load facilities for a properties file. That is, a file
00052         or other medium containing lines of text with a name=value layout.
00053 
00054 *******************************************************************************/
00055 
00056 class Properties
00057 {
00058         /***********************************************************************
00059         
00060                 Load properties from the named file, and pass each of them
00061                 to the provided delegate.
00062 
00063         ***********************************************************************/
00064 
00065         static void load (char[] filepath, void delegate (char[]name, char[] value) dg)
00066         {
00067                 FileConduit fc = new FileConduit (filepath, FileStyle.ReadExisting);
00068 
00069                 try {
00070                     load (fc, dg);
00071                     } finally 
00072                             fc.close();
00073         }
00074 
00075         /***********************************************************************
00076         
00077                 Load properties from the provided conduit, and pass them to
00078                 the provided delegate.
00079 
00080         ***********************************************************************/
00081 
00082         static void load (IConduit conduit, void delegate (char[]name, char[] value) dg)
00083         {
00084                 // bind the input to a line tokenizer
00085                 CompositeToken line = new CompositeToken (Tokenizers.line, conduit);
00086 
00087                 // scan all lines
00088                 while (line.get)
00089                       {
00090                       char[] text = Text.trim (line.toString);
00091                         
00092                       // comments require '#' as the first non-whitespace char 
00093                       if (text.length && (text[0] != '#'))
00094                          {
00095                          // find the '=' char
00096                          int i = Text.indexOf (text, '=');
00097 
00098                          // ignore if not found ...
00099                          if (i > 0)
00100                              dg (Text.trim (text[0..i]), Text.trim (text[i+1..text.length]));
00101                          }
00102                       }
00103         }
00104 }

Generated on Mon Nov 14 10:59:40 2005 for Mango by  doxygen 1.4.0