00001 /* 00002 * Game Genie Encoder/Decoder 00003 * Copyright (C) 2004-2005 emuWorks 00004 * http://games.technoplaza.net/ 00005 * 00006 * This file is part of Game Genie Encoder/Decoder. 00007 * 00008 * Game Genie Encoder/Decoder is free software; you can redistribute it and/or 00009 * modify it under the terms of the GNU General Public License as published by 00010 * the Free Software Foundation; either version 2 of the License, or 00011 * (at your option) any later version. 00012 * 00013 * Game Genie Encoder/Decoder is distributed in the hope that it will be useful, 00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 * GNU General Public License for more details. 00017 * 00018 * You should have received a copy of the GNU General Public License 00019 * along with Game Genie Encoder/Decoder; if not, write to the Free Software 00020 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00021 */ 00022 00023 // $Id: encoder.hh,v 1.2 2005/07/30 02:36:45 technoplaza Exp $ 00024 00025 #ifndef _ENCODER_HH 00026 #define _ENCODER_HH 00027 00028 namespace emuWorks { 00029 class NESGameGenieCode; 00030 class NESRawCode; 00031 class SNESGameGenieCode; 00032 class SNESRawCode; 00033 class GenesisGameGenieCode; 00034 class GenesisRawCode; 00035 class GBGGGameGenieCode; 00036 class GBGGRawCode; 00037 00038 /** 00039 * A class to encode raw/PAR codes into Game Genie codes. 00040 */ 00041 class Encoder { 00042 public: 00043 /** 00044 * Encodes an NESRawCode into a GameGenieCode. 00045 * 00046 * @param code The NESRawCode. 00047 * 00048 * @return The encoded GameGenieCode. 00049 */ 00050 static NESGameGenieCode encode(NESRawCode &code); 00051 00052 /** 00053 * Encodes an SNESRawCode into a GameGenieCode. 00054 * 00055 * @param code The SNESRawCode. 00056 * 00057 * @return The encoded GameGenieCode. 00058 */ 00059 static SNESGameGenieCode encode(SNESRawCode &code); 00060 00061 /** 00062 * Encodes a GenesisRawCode into a GameGenieCode. 00063 * 00064 * @param code The GenesisRawCode. 00065 * 00066 * @return The encoded GameGenieCode. 00067 */ 00068 static GenesisGameGenieCode encode(GenesisRawCode &code); 00069 00070 /** 00071 * Encodes a GBGGRawCode into a GameGenieCode. 00072 * 00073 * @param code The GBGGRawCode. 00074 * 00075 * @return The encoded GameGenieCode. 00076 */ 00077 static GBGGGameGenieCode encode(GBGGRawCode &code); 00078 private: 00079 /** 00080 * Constructor for an Encoder. Private to prevent instantiation. 00081 */ 00082 Encoder() {} 00083 }; 00084 } 00085 00086 #endif 00087