Jason Felds
125 lines
4.1 KiB
C++
125 lines
4.1 KiB
C++
#ifndef MSDFILE_H
|
|
#define MSDFILE_H
|
|
|
|
/** @brief The class that reads the various .SSC, .SM, .SMA, .DWI, and .MSD files. */
|
|
class MsdFile
|
|
{
|
|
public:
|
|
/**
|
|
* @brief The list of params found in the files.
|
|
*
|
|
* Note that #param:param:param:param; is one whole value. */
|
|
struct value_t
|
|
{
|
|
/** @brief The list of parameters. */
|
|
vector<RString> params;
|
|
/**
|
|
* @brief Access the proper parameter.
|
|
* @param i the index.
|
|
* @return the proper parameter.
|
|
*/
|
|
RString operator[]( unsigned i ) const { if( i >= params.size() ) return RString(); return params[i]; }
|
|
};
|
|
|
|
/** @brief Remove the MSDFile. */
|
|
virtual ~MsdFile() { }
|
|
|
|
/**
|
|
* @brief Attempt to read an MSD file.
|
|
* @param sFilePath the path to the file.
|
|
* @param bUnescape a flag to see if we need to unescape values.
|
|
* @return its success or failure.
|
|
*/
|
|
bool ReadFile( RString sFilePath, bool bUnescape );
|
|
/**
|
|
* @brief Attempt to read an MSD file.
|
|
* @param sString the path to the file.
|
|
* @param bUnescape a flag to see if we need to unescape values.
|
|
* @return its success or failure.
|
|
*/
|
|
void ReadFromString( const RString &sString, bool bUnescape );
|
|
|
|
/**
|
|
* @brief Should an error take place, have an easy place to get it.
|
|
* @return the current error. */
|
|
RString GetError() const { return error; }
|
|
|
|
/**
|
|
* @brief Retrieve the number of values for each tag.
|
|
* @return the nmber of values. */
|
|
unsigned GetNumValues() const { return values.size(); }
|
|
/**
|
|
* @brief Get the number of parameters for the current index.
|
|
* @param val the current value index.
|
|
* @return the number of params.
|
|
*/
|
|
unsigned GetNumParams( unsigned val ) const { if( val >= GetNumValues() ) return 0; return values[val].params.size(); }
|
|
/**
|
|
* @brief Get the specified value.
|
|
* @param val the current value index.
|
|
* @return The specified value.
|
|
*/
|
|
const value_t &GetValue( unsigned val ) const { ASSERT(val < GetNumValues()); return values[val]; }
|
|
/**
|
|
* @brief Retrieve the specified parameter.
|
|
* @param val the current value index.
|
|
* @param par the current parameter index.
|
|
* @return the parameter in question.
|
|
*/
|
|
RString GetParam( unsigned val, unsigned par ) const;
|
|
|
|
|
|
private:
|
|
/**
|
|
* @brief Attempt to read an MSD file from the buffer.
|
|
* @param buf the buffer containing the MSD file.
|
|
* @param len the length of the buffer.
|
|
* @param bUnescape a flag to see if we need to unescape values.
|
|
*/
|
|
void ReadBuf( const char *buf, int len, bool bUnescape );
|
|
/**
|
|
* @brief Add a new parameter.
|
|
* @param buf the new parameter.
|
|
* @param len the length of the new parameter.
|
|
*/
|
|
void AddParam( const char *buf, int len );
|
|
/**
|
|
* @brief Add a new value.
|
|
*/
|
|
void AddValue();
|
|
|
|
/** @brief The list of values. */
|
|
vector<value_t> values;
|
|
/** @brief The error string. */
|
|
RString error;
|
|
};
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @file
|
|
* @author Chris Danford, Glenn Maynard (c) 2001-2004
|
|
* @section LICENSE
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|