home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / hotjava3 / hotjava3.exe / hotjava / classsrc / java / util / UCDecoder.java < prev    next >
Encoding:
Java Source  |  1995-08-11  |  7.0 KB  |  228 lines
  1. /*
  2.  * @(#)UCDecoder.java    1.2 95/03/17 Chuck McManis
  3.  *
  4.  * Copyright (c) 1995 Sun Microsystems, Inc. All Rights Reserved.
  5.  *
  6.  * Permission to use, copy, modify, and distribute this software
  7.  * and its documentation for NON-COMMERCIAL purposes and without
  8.  * fee is hereby granted provided that this copyright notice
  9.  * appears in all copies. Please refer to the file "copyright.html"
  10.  * for further important copyright and licensing information.
  11.  *
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
  13.  * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
  14.  * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  15.  * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
  16.  * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
  17.  * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
  18.  */
  19. package java.util;
  20.  
  21. import java.io.OutputStream;
  22. import java.io.OutputStreamBuffer;
  23. import java.io.InputStream;
  24. import java.io.PrintStream;
  25.  
  26. /**
  27.  * This class implements a robust character decoder. The decoder will
  28.  * converted encoded text into binary data.
  29.  *
  30.  * The basic encoding unit is a 3 character atom. It encodes two bytes
  31.  * of data. Bytes are encoded into a 64 character set, the characters
  32.  * were chosen specifically because they appear in all codesets.
  33.  * We don't care what their numerical equivalent is because
  34.  * we use a character array to map them. This is like UUencoding
  35.  * with the dependency on ASCII removed.
  36.  *
  37.  * The three chars that make up an atom are encoded as follows:
  38.  * <pre>
  39.  *      00xxxyyy 00axxxxx 00byyyyy
  40.  *      00 = leading zeros, all values are 0 - 63
  41.  *      xxxyyy - Top 3 bits of X, Top 3 bits of Y
  42.  *      axxxxx - a = X parity bit, xxxxx lower 5 bits of X
  43.  *      byyyyy - b = Y parity bit, yyyyy lower 5 bits of Y
  44.  * </pre>
  45.  *
  46.  * The atoms are arranged into lines suitable for inclusion into an
  47.  * email message or text file. The number of bytes that are encoded
  48.  * per line is 48 which keeps the total line length  under 80 chars)
  49.  *
  50.  * Each line has the form(
  51.  * <pre>
  52.  *  *(LLSS)(DDDD)(DDDD)(DDDD)...(CRC)
  53.  *  Where each (xxx) represents a three character atom.
  54.  *  (LLSS) - 8 bit length (high byte), and sequence number
  55.  *           modulo 256;
  56.  *  (DDDD) - Data byte atoms, if length is odd, last data 
  57.  *           atom has (DD00) (high byte data, low byte 0)
  58.  *  (CRC)  - 16 bit CRC for the line, includes length, 
  59.  *           sequence, and all data bytes. If there is a 
  60.  *           zero pad byte (odd length) it is _NOT_ 
  61.  *           included in the CRC.
  62.  * </pre>
  63.  *
  64.  * If an error is encountered during decoding this class throws a 
  65.  * CEFormatException. The specific detail messages are:
  66.  *
  67.  * <pre>
  68.  *    "UCDecoder: High byte parity error."
  69.  *    "UCDecoder: Low byte parity error."
  70.  *    "UCDecoder: Out of sequence line."
  71.  *    "UCDecoder: CRC check failed."
  72.  * </pre>
  73.  *
  74.  * @version     1.2, 17 Mar 1995
  75.  * @author      Chuck McManis
  76.  * @see        CharacterEncoder
  77.  * @see        UCEncoder
  78.  */
  79. public class UCDecoder extends CharacterDecoder {
  80.  
  81.     /** This class encodes two bytes per atom. */
  82.     int bytesPerAtom() {
  83.     return (2);    
  84.     }
  85.  
  86.     /** this class encodes 48 bytes per line */
  87.     int bytesPerLine() {
  88.     return (48);
  89.     }
  90.  
  91.     /* this is the UCE mapping of 0-63 to characters .. */
  92.     private final static byte map_array[] = {
  93.                 //       0   1   2   3   4   5   6   7
  94.                         '0','1','2','3','4','5','6','7', // 0
  95.                         '8','9','A','B','C','D','E','F', // 1
  96.                         'G','H','I','J','K','L','M','N', // 2
  97.                         'O','P','Q','R','S','T','U','V', // 3
  98.                         'W','X','Y','Z','a','b','c','d', // 4
  99.                         'e','f','g','h','i','j','k','l', // 5
  100.                         'm','n','o','p','q','r','s','t', // 6
  101.                         'u','v','w','x','y','z','(',')'  // 7
  102.                 };
  103.  
  104.     private int sequence;
  105.     private byte tmp[] = new byte[2];
  106.     private CRC16 crc = new CRC16();
  107.  
  108.     /**
  109.      * Decode one atom - reads the characters from the input stream, decodes
  110.      * them, and checks for valid parity.
  111.      */
  112.     void decodeAtom(InputStream inStream, OutputStream outStream, int l) {
  113.     int i, p1, p2, np1, np2;
  114.     byte a = -1, b = -1, c = -1;
  115.     byte high_byte, low_byte;
  116.     byte tmp[] = new byte[3];
  117.  
  118.     i = inStream.read(tmp);
  119.     if (i != 3) {
  120.         throw new CEStreamExhausted();
  121.     }
  122.     for (i = 0; (i < 64) && ((a == -1) || (b == -1) || (c == -1)); i++) {
  123.         if (tmp[0] == map_array[i]) {
  124.         a = (byte) i;
  125.         }
  126.         if (tmp[1] == map_array[i]) {
  127.         b = (byte) i;
  128.         }
  129.         if (tmp[2] == map_array[i]) {
  130.         c = (byte) i;
  131.         }
  132.     }
  133.     high_byte = (byte) (((a & 0x38) << 2) + (b & 0x1f));
  134.     low_byte = (byte) (((a & 0x7) << 5) + (c & 0x1f));
  135.     p1 = 0;
  136.     p2 = 0;
  137.     for (i = 1; i < 256; i = i * 2) {
  138.         if ((high_byte & i) != 0)
  139.         p1++;
  140.         if ((low_byte & i) != 0)
  141.         p2++;
  142.     }
  143.     np1 = (b & 32) / 32;
  144.     np2 = (c & 32) / 32;
  145.     if ((p1 & 1) != np1) {
  146.         throw new CEFormatException("UCDecoder: High byte parity error.");
  147.     }
  148.     if ((p2 & 1) != np2) {
  149.         throw new CEFormatException("UCDecoder: Low byte parity error.");
  150.     }
  151.     outStream.write(high_byte);
  152.     crc.update(high_byte);
  153.     if (l == 2) {
  154.         outStream.write(low_byte);
  155.         crc.update(low_byte);
  156.     }
  157.     }
  158.     
  159.     private OutputStreamBuffer lineAndSeq = new OutputStreamBuffer(2);
  160.  
  161.     /**
  162.      * decodeBufferPrefix initializes the sequence number to zero.
  163.      */
  164.     void decodeBufferPrefix(InputStream inStream, OutputStream outStream) {
  165.     sequence = 0;
  166.     }
  167.  
  168.     /**
  169.      * decodeLinePrefix reads the sequence number and the number of
  170.      * encoded bytes from the line. If the sequence number is not the
  171.      * previous sequence number + 1 then an exception is thrown.
  172.      * UCE lines are line terminator immune, they all start with *
  173.      * so the other thing this method does is scan for the next line
  174.      * by looking for the * character.
  175.      *
  176.      * @exception CEFormatException out of sequence lines detected.
  177.      */
  178.     int decodeLinePrefix(InputStream inStream, OutputStream outStream) {
  179.     int     i;
  180.     int    nLen, nSeq;
  181.     byte    xtmp[];
  182.     int    c;
  183.  
  184.     crc.value = 0;
  185.     while (true) {
  186.         c = inStream.read(tmp, 0, 1);
  187.         if (c == -1) {
  188.         throw new CEStreamExhausted();
  189.         }
  190.         if (tmp[0] == '*') { 
  191.         break;
  192.         }
  193.     }
  194.     lineAndSeq.reset();
  195.     decodeAtom(inStream, lineAndSeq, 2);
  196.     xtmp = lineAndSeq.toByteArray();
  197.     nLen = xtmp[0] & 0xff;
  198.     nSeq = xtmp[1] & 0xff;
  199.     if (nSeq != sequence) {
  200.         throw new CEFormatException("UCDecoder: Out of sequence line.");
  201.     }
  202.     sequence = (sequence + 1) & 0xff;
  203.     return (nLen);
  204.     }
  205.  
  206.  
  207.     /**
  208.      * this method reads the CRC that is at the end of every line and
  209.      * verifies that it matches the computed CRC. 
  210.      *
  211.      * @exception CEFormatException if CRC check fails.
  212.      */
  213.     void decodeLineSuffix(InputStream inStream, OutputStream outStream) {
  214.     int i;
  215.     int lineCRC = crc.value;
  216.     int readCRC;
  217.     byte tmp[];
  218.     
  219.     lineAndSeq.reset();
  220.     decodeAtom(inStream, lineAndSeq, 2);
  221.     tmp = lineAndSeq.toByteArray();
  222.     readCRC = ((tmp[0] << 8) & 0xFF00) + (tmp[1] & 0xff);
  223.     if (readCRC != lineCRC) {
  224.         throw new CEFormatException("UCDecoder: CRC check failed.");
  225.     }
  226.     }
  227. }
  228.