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

Stdout.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Stdout.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.Stdout;
00040 
00041 // for CR
00042 public import   mango.io.Writer;        
00043 
00044 private import  mango.io.Console,
00045                 mango.io.BufferCodec,
00046                 mango.io.FlushWriter;
00047 
00048 /*******************************************************************************
00049 
00050         The ubiquitous console IO support. These are standard Conduit 
00051         instances, with Reader/Writer wrappers applied appropriately. Note 
00052         that the outputs use FlushBuffer to automatically flush data as it 
00053         is added to the buffer. The basic usage of this module is illustrated 
00054         below:
00055 
00056         @code
00057         char[] msg = "on the console";
00058 
00059         Stdout ("print ") (1) (' ') ("message ") (msg) (CR);
00060         @endcode
00061 
00062         An alternative is to use put() notation like so:
00063 
00064         @code
00065         char[] msg = "on the console";
00066 
00067         Stdout.put ("print ")
00068               .put (1)
00069               .put (' ')
00070               .put ("message ")
00071               .put (msg)
00072               .put (CR);
00073         @endcode
00074 
00075         Another alternative is to use the C++ iostream operators like so:
00076 
00077         @code
00078         char[] msg = "on the console";
00079 
00080         Stdout << "print "
00081                << 1
00082                << ' '
00083                << "message "
00084                << msg
00085                << CR;
00086         @endcode
00087 
00088         Since console idioms are based upon Conduit, you can use them 
00089         as direct targets for stream-oriented operations. For example, 
00090         the code:
00091 
00092         @code
00093           FileConduit from = new FileConduit ("myfile.txt");
00094           Stdout.conduit.copy (from);
00095         @endcode
00096 
00097         copies a text file directly to the console. Likewise, you can 
00098         copy console input directly to a FileConduit or a SocketConduit.
00099         Input via Stdin is similar in nature, but uses the Token classes
00100         to isolate and parse each token on an input line:
00101 
00102         @code
00103         Stdout ("please input a number: ") ();
00104         int x;
00105         Stdin (x);          
00106         @endcode
00107 
00108         @code
00109         Stdout ("please enter your name: ") ();
00110         char[] you;
00111         Stdin (you);           
00112         Stdout ("Hello ") (you) (CR);
00113         @endcode
00114 
00115         Stdout automatically flushes the output when it sees a CR, so you 
00116         may need to flush the output manually where a CR is not desired.
00117         This is the case in the above example, so we use the empty () to
00118         request a flush (which is actually an alias for the flush method).
00119 
00120         Note that Stdin awaits a carriage-return before parsing the input
00121         into the targets. Note also that the Stdout and Stderr are not written 
00122         to be thread-safe. As such you may find that output from two threads 
00123         intersect across each other. If this is a problem you should wrap a 
00124         synchronized block around the offending entity, like so:
00125 
00126         @code
00127         synchronized (Stdout)
00128                       Stdout ("this is ") ("'atomic' ") (" output") (CR);
00129         @endcode
00130         
00131         Alternatively, please consider using the mango.log (Logger) package 
00132         to provide detailed runtime diagnostics from your application. The 
00133         functionality exposed there is likely sufficient for most application 
00134         needs.
00135 
00136         Redirecting the standard IO handles (via a shell) operates as one 
00137         would expect.
00138 
00139 *******************************************************************************/
00140 
00141 static FlushWriter Stdout,
00142                    Stderr;
00143 
00144 static this ()
00145 {
00146         Stdout = new FlushWriter (Cout);
00147         Stderr = new FlushWriter (Cerr);
00148 
00149         Stdout.setEncoder (new UnicodeImporter!(char)(Cout));
00150         Stderr.setEncoder (new UnicodeImporter!(char)(Cerr));
00151 }

Generated on Sat Dec 24 17:28:33 2005 for Mango by  doxygen 1.4.0