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

Transcoder.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Transcoder.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, August 2004      
00031         @author         Kris
00032 
00033 
00034 *******************************************************************************/
00035 
00036 module mango.xcode.Transcoder;
00037 
00038 /*******************************************************************************
00039       
00040 *******************************************************************************/
00041 
00042 class Transcoder
00043 {
00044         /***********************************************************************
00045 
00046                 Convert the input into the output, respecting the boundaries
00047                 of the provided arrays. Returns a valid slice of the output,
00048                 along with the number of items consumed from the input.
00049 
00050         ***********************************************************************/
00051 
00052         abstract char[] encode (dchar[] input, char[] output, out uint consumed);
00053 
00054         /***********************************************************************
00055       
00056                 Convert the input into the output, respecting the boundaries
00057                 of the provided arrays. Returns a valid slice of the output,
00058                 along with the number of items consumed from the input.
00059 
00060         ***********************************************************************/
00061 
00062         abstract dchar[] decode (char[] input, dchar[] output, out uint consumed);
00063 
00064         /***********************************************************************
00065       
00066                 Return the encoding name of this transcoder 
00067 
00068         ***********************************************************************/
00069 
00070         abstract char[] toString ();
00071 
00072         /***********************************************************************
00073 
00074                 overridable exception thrower
00075 
00076         ***********************************************************************/
00077 
00078         protected void fault (char[] msg)
00079         {
00080                 throw new Exception (msg);
00081         } 
00082 }
00083 

Generated on Sun Oct 24 22:31:17 2004 for Mango by doxygen 1.3.6