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

Stdin.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Stdin.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, Feb 2005      
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.io.Stdin;
00040 
00041 private import  mango.io.Buffer,
00042                 mango.io.Tokenizer,
00043                 mango.io.TextReader,
00044                 mango.io.ConduitStyle,
00045                 mango.io.DeviceConduit;
00046 
00047 private import  mango.io.model.IReader;
00048 
00049 
00050 /*******************************************************************************
00051 
00052         The ubiquitous console IO support. These are standard Conduit 
00053         instances, with Reader/Writer wrappers applied appropriately. Note 
00054         that the outputs use FlushBuffer to automatically flush data as it 
00055         is added to the buffer. The basic usage of this module is illustrated 
00056         below:
00057 
00058         @code
00059         char[] msg = "on the console";
00060 
00061         Stdout ("print ") (1) (' ') ("message ") (msg) (CR);
00062         @endcode
00063 
00064         An alternative is to use put() notation like so:
00065 
00066         @code
00067         char[] msg = "on the console";
00068 
00069         Stdout.put ("print ")
00070               .put (1)
00071               .put (' ')
00072               .put ("message ")
00073               .put (msg)
00074               .put (CR);
00075         @endcode
00076 
00077         Another alternative is to use the C++ iostream operators like so:
00078 
00079         @code
00080         char[] msg = "on the console";
00081 
00082         Stdout << "print "
00083                << 1
00084                << ' '
00085                << "message "
00086                << msg
00087                << CR;
00088         @endcode
00089 
00090         Since console idioms are based upon Conduit, you can use them as
00091         direct targets for stream-oriented operations. For example, the 
00092         code:
00093 
00094         @code
00095           FileConduit fc = new FileConduit ("myfile.txt");
00096           Stdout.conduit.copy (fc);
00097         @endcode
00098 
00099         copies a text file directly to the console. Likewise, you can 
00100         copy console input directly to a FileConduit or a SocketConduit.
00101         Input via Stdin is similar in nature, but uses the Token classes
00102         to isolate and parse each token on an input line:
00103 
00104         @code
00105         Stdout ("please enter your name: ") ();
00106         char[] you;
00107         Stdin (you);           
00108         Stdout ("Hello ") (you) (CR);
00109         @endcode
00110 
00111         Note that Stdin awaits a carriage-return before parsing the input
00112         into the targets. Note also that the Stdout and Stderr are not written 
00113         to be thread-safe. As such you may find that output from two threads 
00114         intersect across each other. If this is a problem you should wrap a 
00115         synchronized block around the offending entity, like so:
00116 
00117         @code
00118         synchronized (Stdout)
00119                       Stdout ("this is ") ("'atomic' ") (" output") (CR);
00120         @endcode
00121         
00122         Alternatively, please consider using the mango.log (Logger) package 
00123         to provide detailed runtime diagnostics from your application. The 
00124         functionality exposed there is likely sufficient for most application 
00125         needs.
00126 
00127         Redirecting the standard IO handles (via a shell) operates as one 
00128         would expect.
00129 
00130 *******************************************************************************/
00131 
00132 class ConsoleReader : TextReader
00133 {
00134         /***********************************************************************
00135         
00136                 Standard output conduit. This is inside the namespace 
00137                 to reduce clutter
00138 
00139         ***********************************************************************/
00140 
00141         DeviceConduit conduit;
00142 
00143         /***********************************************************************
00144         
00145                 Prohibit instantiation of this class 
00146 
00147         ***********************************************************************/
00148 
00149         private this (int device)
00150         {
00151                 conduit = new ConsoleConduit (new FileDevice (device, ConduitStyle.Access.Read));
00152                 super (conduit, Tokenizers.space);
00153         }
00154 }
00155 
00156 
00157 /*******************************************************************************
00158 
00159         Standard input reader. This is exposed at global scope
00160 
00161 *******************************************************************************/
00162 
00163 static ConsoleReader Stdin;
00164 
00165 static this ()
00166 {
00167         Stdin = new ConsoleReader (0);
00168 }
00169 

Generated on Fri May 27 18:11:56 2005 for Mango by  doxygen 1.4.0