common/includes/common.h


#ifndef _COMMON_H_
#define _COMMON_H_

// Disable the warning C4706 -> assignment within conditional expression
// Allow us to use Warning level 4 instead of level 3
#pragma warning( disable : 4706)
#pragma warning( disable : 4786)        // Debug symbols thing
#pragma warning( disable : 4996)   // #define _CRT_SECURE_NO_WARNINGS
//#define _CRT_SECURE_NO_WARNINGS


#include <string>
#include <vector>

#include <fcntl.h>

#ifndef O_BINARY
#define O_BINARY 0
#endif

#ifdef _WIN32
#define strncasecmp _strnicmp
#include <io.h>
#else
#include <unistd.h>
#endif


//
// Debugging macros
//
#ifdef  _DEBUG
#define _BREAK_                         __asm { int 3 }
#define _BREAK_IF_(cond)                if (cond) __asm { int 3 } else ((void)0)
#else
#define _BREAK_                         ((void)0)
#define _BREAK_IF_(cond)                ((void)0)
#endif


//
// Argument parsing, error handling
//
void SetApplicationParameters(const char* pcApplicationName,int nVersionMajor,int nVersionMinor,const char* pcUsageMessage);

void ShowError(const char *pcMessage,...);


class ArgumentParser
{
public:
  ArgumentParser(int argc,char *argv[]);
  ~ArgumentParser() {}

  const char* GetParameter(int nParameterIndex);
  int GetParameterCount();

  bool ProcessNextArgument();

  bool IsSwitch(const char *ptr_switch);
  bool IsParameter();

  std::string GetStringValue();
  int GetIntegerValue(int default_value);
  bool GetBooleanValue(bool default_value);
  bool GetSeparator(const char* ptr_separator_list);
  const char* GetRemainingStuff();

private:
  ArgumentParser();

private:
  int           m_argc;
  char**        m_argv;
  long          m_first_param;

  int           m_remaining_argc;
  long          m_nb_arg;
  const char*   m_ptr_arg;
};

bool get_switch(const char *&ptr_arg,const char *ptr_switch);
int get_value(const char *&ptr_arg,long default_value);
std::string get_string(const char *&ptr_arg);


//
// File loading and saving
//
bool LoadFile(const char* pcFileName,void* &pcBuffer,size_t &cBufferSize);
bool SaveFile(const char* pcFileName,const void* pcBuffer,size_t cBufferSize);
bool DeleteFile(const char* pcFileName);

bool LoadText(const char* pcFileName,std::vector<std::string>& cTextData);

//
// Compression (moved out FilePack)
//
long LZ77_Compress(void *buf_src,void *buf_dest,long size_buf_src);
void LZ77_UnCompress(void *buf_src,void *buf_dest,long size);
long LZ77_ComputeDelta(unsigned char *buf_comp,long size_uncomp,long size_comp);
extern unsigned char gLZ77_XorMask;

//
// Preprocessing and filtering
//
int StringReplace(std::string& cMainString,const std::string& cSearchedString,const std::string& cReplaceString);
std::string StringTrim(const std::string& cInputString,const std::string& cFilteredOutCharacterList=" \t\f\v\n\r");
std::string StringFormat(const char* pFormatString,...);

int ConvertAdress(const char *ptr_value);

class TextFileGenerator
{
public:
  enum Language_e
  {
    _eLanguage_Undefined_,
    eLanguage_C,
    eLanguage_Assembler,
    eLanguage_BASIC
  };

  enum Endianness_e
  {
    _eEndianness_Undefined_,
    _eEndianness_Little,
    _eEndianness_Big
  };

  enum NumericBase_e
  {
    _eNumericBase_Undefined_,
    _eNumericBase_Hexadecimal,
    _eNumericBase_Decimal
  };

public:
  TextFileGenerator();
  ~TextFileGenerator();

  void SetDataSize(int nDataSize)                           { m_nDataSize=nDataSize; }
  void SetFileType(Language_e nFileType)                    { m_nFileType=nFileType; }
  void SetEndianness(Endianness_e nEndianness)              { m_nEndianness=nEndianness; }
  void SetNumericBase(NumericBase_e nNumericBase)           { m_nNumericBase=nNumericBase; }
  void SetValuesPerLine(unsigned int nValuesPerLine)        { m_nValuesPerLine=nValuesPerLine; }
  void SetLabel(const std::string& cLabel)                  { m_cLabelName=cLabel; }
  void SetLineNumber(int nLineNumber)                       { m_nFirstLineNumber=nLineNumber; }
  void SetIncrementLineNumber(int nIncrementLineNumber)     { m_nIncrementLineNumber=nIncrementLineNumber; }

  int GetDataSize()                 { return m_nDataSize; }
  Language_e GetFileType()          { return m_nFileType; }
  Endianness_e GetEndianness()      { return m_nEndianness; }
  NumericBase_e GetNumericBase()    { return m_nNumericBase; }
  unsigned int GetValuesPerLine()   { return m_nValuesPerLine; }
  const std::string& GetLabel()     { return m_cLabelName; }
  int GetLineNumber()               { return m_nFirstLineNumber; }
  int GetIncrementLineNumber()      { return m_nIncrementLineNumber; }

  std::string ConvertData(const void* pSourceData,size_t nFileSize);

private:
  int             m_nDataSize;
  Language_e      m_nFileType;
  Endianness_e    m_nEndianness;
  NumericBase_e   m_nNumericBase;
  unsigned int    m_nValuesPerLine;

  bool            m_bEnableLineNumber;
  int             m_nFirstLineNumber;
  int             m_nIncrementLineNumber;

  std::string     m_cLabelName;
};


#endif // _COMMON_H_
1
2	#ifndef _COMMON_H_
3	#define _COMMON_H_
4
5	// Disable the warning C4706 -> assignment within conditional expression
6	// Allow us to use Warning level 4 instead of level 3
7	#pragma warning( disable : 4706)
8	#pragma warning( disable : 4786) // Debug symbols thing
9	#pragma warning( disable : 4996) // #define _CRT_SECURE_NO_WARNINGS
10	//#define _CRT_SECURE_NO_WARNINGS
11
12
13	#include <string>
14	#include <vector>
15
16	#include <fcntl.h>
17
18	#ifndef O_BINARY
19	#define O_BINARY 0
20	#endif
21
22	#ifdef _WIN32
23	#define strncasecmp _strnicmp
24	#include <io.h>
25	#else
26	#include <unistd.h>
27	#endif
28
29
30	//
31	// Debugging macros
32	//
33	#ifdef _DEBUG
34	#define _BREAK_ __asm { int 3 }
35	#define _BREAK_IF_(cond) if (cond) __asm { int 3 } else ((void)0)
36	#else
37	#define _BREAK_ ((void)0)
38	#define _BREAK_IF_(cond) ((void)0)
39	#endif
40
41
42	//
43	// Argument parsing, error handling
44	//
45	void SetApplicationParameters(const char* pcApplicationName,int nVersionMajor,int nVersionMinor,const char* pcUsageMessage);
46
47	void ShowError(const char *pcMessage,...);
48
49
50	class ArgumentParser
51	{
52	public:
53	ArgumentParser(int argc,char *argv[]);
54	~ArgumentParser() {}
55
56	const char* GetParameter(int nParameterIndex);
57	int GetParameterCount();
58
59	bool ProcessNextArgument();
60
61	bool IsSwitch(const char *ptr_switch);
62	bool IsParameter();
63
64	std::string GetStringValue();
65	int GetIntegerValue(int default_value);
66	bool GetBooleanValue(bool default_value);
67	bool GetSeparator(const char* ptr_separator_list);
68	const char* GetRemainingStuff();
69
70	private:
71	ArgumentParser();
72
73	private:
74	int m_argc;
75	char** m_argv;
76	long m_first_param;
77
78	int m_remaining_argc;
79	long m_nb_arg;
80	const char* m_ptr_arg;
81	};
82
83	bool get_switch(const char &ptr_arg,const char ptr_switch);
84	int get_value(const char *&ptr_arg,long default_value);
85	std::string get_string(const char *&ptr_arg);
86
87
88	//
89	// File loading and saving
90	//
91	bool LoadFile(const char* pcFileName,void* &pcBuffer,size_t &cBufferSize);
92	bool SaveFile(const char* pcFileName,const void* pcBuffer,size_t cBufferSize);
93	bool DeleteFile(const char* pcFileName);
94
95	bool LoadText(const char* pcFileName,std::vector<std::string>& cTextData);
96
97	//
98	// Compression (moved out FilePack)
99	//
100	long LZ77_Compress(void buf_src,void buf_dest,long size_buf_src);
101	void LZ77_UnCompress(void buf_src,void buf_dest,long size);
102	long LZ77_ComputeDelta(unsigned char *buf_comp,long size_uncomp,long size_comp);
103	extern unsigned char gLZ77_XorMask;
104
105	//
106	// Preprocessing and filtering
107	//
108	int StringReplace(std::string& cMainString,const std::string& cSearchedString,const std::string& cReplaceString);
109	std::string StringTrim(const std::string& cInputString,const std::string& cFilteredOutCharacterList=" \t\f\v\n\r");
110	std::string StringFormat(const char* pFormatString,...);
111
112	int ConvertAdress(const char *ptr_value);
113
114	class TextFileGenerator
115	{
116	public:
117	enum Language_e
118	{
119	_eLanguage_Undefined_,
120	eLanguage_C,
121	eLanguage_Assembler,
122	eLanguage_BASIC
123	};
124
125	enum Endianness_e
126	{
127	_eEndianness_Undefined_,
128	_eEndianness_Little,
129	_eEndianness_Big
130	};
131
132	enum NumericBase_e
133	{
134	_eNumericBase_Undefined_,
135	_eNumericBase_Hexadecimal,
136	_eNumericBase_Decimal
137	};
138
139	public:
140	TextFileGenerator();
141	~TextFileGenerator();
142
143	void SetDataSize(int nDataSize) { m_nDataSize=nDataSize; }
144	void SetFileType(Language_e nFileType) { m_nFileType=nFileType; }
145	void SetEndianness(Endianness_e nEndianness) { m_nEndianness=nEndianness; }
146	void SetNumericBase(NumericBase_e nNumericBase) { m_nNumericBase=nNumericBase; }
147	void SetValuesPerLine(unsigned int nValuesPerLine) { m_nValuesPerLine=nValuesPerLine; }
148	void SetLabel(const std::string& cLabel) { m_cLabelName=cLabel; }
149	void SetLineNumber(int nLineNumber) { m_nFirstLineNumber=nLineNumber; }
150	void SetIncrementLineNumber(int nIncrementLineNumber) { m_nIncrementLineNumber=nIncrementLineNumber; }
151
152	int GetDataSize() { return m_nDataSize; }
153	Language_e GetFileType() { return m_nFileType; }
154	Endianness_e GetEndianness() { return m_nEndianness; }
155	NumericBase_e GetNumericBase() { return m_nNumericBase; }
156	unsigned int GetValuesPerLine() { return m_nValuesPerLine; }
157	const std::string& GetLabel() { return m_cLabelName; }
158	int GetLineNumber() { return m_nFirstLineNumber; }
159	int GetIncrementLineNumber() { return m_nIncrementLineNumber; }
160
161	std::string ConvertData(const void* pSourceData,size_t nFileSize);
162
163	private:
164	int m_nDataSize;
165	Language_e m_nFileType;
166	Endianness_e m_nEndianness;
167	NumericBase_e m_nNumericBase;
168	unsigned int m_nValuesPerLine;
169
170	bool m_bEnableLineNumber;
171	int m_nFirstLineNumber;
172	int m_nIncrementLineNumber;
173
174	std::string m_cLabelName;
175	};
176
177
178	#endif // _COMMON_H_