sourcehook/generate/shworker/fd_hopter.cpp
author David Anderson <dvander@alliedmods.net>
Thu Sep 27 20:43:03 2007 +0000 (2007-09-27)
branchsourcemm-1.6.0
changeset 358 a4de8673bdbd
parent 347 e82968c21606
permissions -rw-r--r--
more filling in of the provider for episode1
dvander@347
     1
// From fastdelegate
dvander@347
     2
// http://www.codeproject.com/cpp/FastDelegate.asp
dvander@347
     3
dvander@347
     4
// Modified to be run from shworker by PM
dvander@347
     5
dvander@347
     6
dvander@347
     7
// HOPTER.EXE -- A simple header generator for vararg templates
dvander@347
     8
/*  MOTIVATION
dvander@347
     9
 C++ doesn't have a vararg feature for templates. This can be a
dvander@347
    10
 nuisance when writing class libraries. There are a few options:
dvander@347
    11
 (a) manually repeat code. This is tedious and error prone.
dvander@347
    12
 (b) Use macros. Messy, can't cope with template
dvander@347
    13
   arguments, and users get hard-to-interpret error messages.
dvander@347
    14
 (c) Use the boost preprocessor library. This slows compilation,
dvander@347
    15
   and introduces a dependency on boost.
dvander@347
    16
 (d) Write a program to automatically generate the code.
dvander@347
    17
   I've never seen a general program to do this job, so this is 
dvander@347
    18
   a very simple command-line program to do it.
dvander@347
    19
dvander@347
    20
 Why is it called Hopter?
dvander@347
    21
 I wanted a word that started with h, to be reminiscent of header
dvander@347
    22
 files. At the time, my 2yo son kept talking about 'Hopter Copters'
dvander@347
    23
 (he couldn't pronounce 'helicopter').
dvander@347
    24
 It also reflects the level of sophistication of this program --
dvander@347
    25
 it was named by a two year old.
dvander@347
    26
dvander@347
    27
 IMPLEMENTATION
dvander@347
    28
dvander@347
    29
 When you analyze the problem, you find that the requirements
dvander@347
    30
 are very simple.
dvander@347
    31
 Varargs are needed in two places: templates and functions.
dvander@347
    32
 You want to use them in two ways: when declaring the template
dvander@347
    33
 or function, and when invoking the function / selecting the 
dvander@347
    34
 template.
dvander@347
    35
dvander@347
    36
 It's a brain-dead implementation, which just does a search-and-replace
dvander@347
    37
 of specific strings. It could be done with a few lines using sed on
dvander@347
    38
 a *NIX platform. Because I use Windows, I've done a quick and dirty
dvander@347
    39
 implementation using CString.
dvander@347
    40
dvander@347
    41
In a file, @VARARGS at the start of a line indicates the start of the code
dvander@347
    42
to be expanded. @ENDVAR at the start of a line marks the end of the 
dvander@347
    43
expansion.
dvander@347
    44
dvander@347
    45
 declare template  --  template <@CLASSARGS> class SomeClass
dvander@347
    46
 template<class Param1, class Param2>
dvander@347
    47
 class SomeClass
dvander@347
    48
dvander@347
    49
 declare function  -- somefunc(@FUNCARGS)
dvander@347
    50
 somefunc(Param1 p1, Param2 p2)
dvander@347
    51
dvander@347
    52
 select template -- SomeClass<@SELARGS>
dvander@347
    53
 SomeClass<Param1, Param2>
dvander@347
    54
dvander@347
    55
 invoke function -- somefunc(@INVOKEARGS)
dvander@347
    56
 somefunc(p1, p2)
dvander@347
    57
dvander@347
    58
 I also provide @NUM which is the number of arguments.
dvander@347
    59
 The case where @NUM is zero is a special case: for template declarations,
dvander@347
    60
 the entire template<> bit needs to disappear. When other arguments are 
dvander@347
    61
 involved, either at the beginning or end of the list, there a commas 
dvander@347
    62
 which might need to be removed.
dvander@347
    63
dvander@347
    64
 I've used .hxx as the extension for these files. This enables C++ 
dvander@347
    65
 I wanted to use an unusual file extension (.HOH) for these files, because they
dvander@347
    66
 aren't real header files. But I also like to use the C++ syntax highlighting 
dvander@347
    67
 in Visual Studio. I chose .hxx because MSVC treats it as C++, but it 
dvander@347
    68
 seems to very rarely used.
dvander@347
    69
dvander@347
    70
 Installation (for VC6, if you want to use .HOH as the extension instead):
dvander@347
    71
 Go into the registry and change 
dvander@347
    72
 HKEY_CURRENT_USER\Software\Microsoft\DevStudio\6.0\Text Editor\Tabs/Language Settings\C/C++\FileExtensions from cpp;cxx;c;h;hxx;hpp;inl;tlh;tli;rc;rc2 
dvander@347
    73
 to cpp;cxx;c;h;hxx;hpp;inl;tlh;tli;rc;rc2;hoh by adding �;hoh� to the end.
dvander@347
    74
 Then add this as a custom build step to the main file of your project:
dvander@347
    75
 hopter $(InputDir)\*.hoh $(InputDir)\*.h
dvander@347
    76
dvander@347
    77
*/
dvander@347
    78
dvander@347
    79
#include <string>
dvander@347
    80
#include <stdarg.h>
dvander@347
    81
#include <stdio.h>
dvander@347
    82
dvander@347
    83
// This is a quick-n-dirty implementation of a CString replacement.
dvander@347
    84
// It promises nothing more than to provide enough functionality to get
dvander@347
    85
// this program to run.
dvander@347
    86
// Note that I have really never used CString, so the information to
dvander@347
    87
// implement the members that are used in this program come from
dvander@347
    88
// online documentation at http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vcmfc98/html/_mfc_cstring.asp
dvander@347
    89
// Also, I have only used VC++ a few times, a long time ago, so
dvander@347
    90
// I really do not know what all their alphabet soup is suppoed to
dvander@347
    91
// mean, so I just made a guess...
dvander@347
    92
dvander@347
    93
dvander@347
    94
class CString
dvander@347
    95
{
dvander@347
    96
public:
dvander@347
    97
  enum { MAX_FORMAT_STRING_SIZE = 8 * 1044 };
dvander@347
    98
  CString()
dvander@347
    99
    : str_()
dvander@347
   100
  {
dvander@347
   101
  }
dvander@347
   102
dvander@347
   103
  CString(
dvander@347
   104
      CString const & rhs)
dvander@347
   105
    : str_(rhs.str_)
dvander@347
   106
  {
dvander@347
   107
  }
dvander@347
   108
dvander@347
   109
  CString(
dvander@347
   110
      char ch,
dvander@347
   111
      int repeat = 1)
dvander@347
   112
    : str_(repeat, ch)
dvander@347
   113
  {
dvander@347
   114
  }
dvander@347
   115
dvander@347
   116
  CString(
dvander@347
   117
      char const * s)
dvander@347
   118
    : str_(s)
dvander@347
   119
  {
dvander@347
   120
  }
dvander@347
   121
dvander@347
   122
  CString & operator=(
dvander@347
   123
      CString const & rhs)
dvander@347
   124
  {
dvander@347
   125
    str_ = rhs.str_;
dvander@347
   126
    return *this;
dvander@347
   127
  }
dvander@347
   128
dvander@347
   129
  CString & operator=(
dvander@347
   130
      char const * s)
dvander@347
   131
  {
dvander@347
   132
    str_ = s;
dvander@347
   133
    return *this;
dvander@347
   134
  }
dvander@347
   135
dvander@347
   136
  CString & operator=(
dvander@347
   137
      char ch)
dvander@347
   138
  {
dvander@347
   139
    str_ = ch;
dvander@347
   140
    return *this;
dvander@347
   141
  }
dvander@347
   142
dvander@347
   143
  void Format(
dvander@347
   144
      char const * fmt,
dvander@347
   145
      ...)
dvander@347
   146
  {
dvander@347
   147
    char buffer[ MAX_FORMAT_STRING_SIZE ];
dvander@347
   148
    va_list ap;
dvander@347
   149
    va_start(ap, fmt);
dvander@347
   150
    vsprintf(buffer, fmt, ap);
dvander@347
   151
    va_end(ap);
dvander@347
   152
    str_ = buffer;
dvander@347
   153
  }
dvander@347
   154
dvander@347
   155
  char operator[](
dvander@347
   156
      int x) const
dvander@347
   157
  {
dvander@347
   158
    return str_[x];
dvander@347
   159
  }
dvander@347
   160
  
dvander@347
   161
  CString & operator+=(
dvander@347
   162
      CString const & x)
dvander@347
   163
  {
dvander@347
   164
    str_ += x.str_; return *this;
dvander@347
   165
  }
dvander@347
   166
dvander@347
   167
  int Replace(
dvander@347
   168
      CString const & lhs,
dvander@347
   169
      CString const & rhs)
dvander@347
   170
  {
dvander@347
   171
    int rval = 0;
dvander@347
   172
    std::string::size_type pos = 0;
dvander@347
   173
    while (pos < str_.length())
dvander@347
   174
    {
dvander@347
   175
      pos = str_.find(lhs.str_, pos);
dvander@347
   176
      if (pos != std::string::npos)
dvander@347
   177
      {
dvander@347
   178
        str_.replace(pos, lhs.GetLength(), rhs.str_);
dvander@347
   179
        pos += rhs.GetLength();
dvander@347
   180
        ++rval;
dvander@347
   181
      }
dvander@347
   182
    }
dvander@347
   183
    return rval;
dvander@347
   184
  }
dvander@347
   185
dvander@347
   186
  int GetLength() const
dvander@347
   187
  {
dvander@347
   188
    return str_.length();
dvander@347
   189
  }
dvander@347
   190
dvander@347
   191
  operator char const * () const
dvander@347
   192
  {
dvander@347
   193
    return str_.c_str();
dvander@347
   194
  }
dvander@347
   195
dvander@347
   196
private:
dvander@347
   197
  std::string str_;
dvander@347
   198
};
dvander@347
   199
dvander@347
   200
dvander@347
   201
CString operator+(
dvander@347
   202
    CString const & x,
dvander@347
   203
    CString const & y)
dvander@347
   204
{
dvander@347
   205
  CString result(x);
dvander@347
   206
  result += y;
dvander@347
   207
  return result;
dvander@347
   208
}
dvander@347
   209
dvander@347
   210
dvander@347
   211
/* Example: This is an excerpt from boost::function_template.hpp
dvander@347
   212
dvander@347
   213
#define BOOST_FUNCTION_FUNCTION_INVOKER \
dvander@347
   214
  BOOST_JOIN(function_invoker,BOOST_FUNCTION_NUM_ARGS)
dvander@347
   215
#define BOOST_FUNCTION_VOID_FUNCTION_INVOKER \
dvander@347
   216
  BOOST_JOIN(void_function_invoker,BOOST_FUNCTION_NUM_ARGS)
dvander@347
   217
dvander@347
   218
      template<
dvander@347
   219
        typename FunctionPtr,
dvander@347
   220
        typename R BOOST_FUNCTION_COMMA
dvander@347
   221
        BOOST_FUNCTION_TEMPLATE_PARMS
dvander@347
   222
      >
dvander@347
   223
      struct BOOST_FUNCTION_GET_FUNCTION_INVOKER
dvander@347
   224
      {
dvander@347
   225
        typedef typename ct_if<(is_void<R>::value),
dvander@347
   226
                            BOOST_FUNCTION_VOID_FUNCTION_INVOKER<
dvander@347
   227
                            FunctionPtr,
dvander@347
   228
                            R BOOST_FUNCTION_COMMA
dvander@347
   229
                            BOOST_FUNCTION_TEMPLATE_ARGS
dvander@347
   230
                          >,
dvander@347
   231
                          BOOST_FUNCTION_FUNCTION_INVOKER<
dvander@347
   232
                            FunctionPtr,
dvander@347
   233
                            R BOOST_FUNCTION_COMMA
dvander@347
   234
                            BOOST_FUNCTION_TEMPLATE_ARGS
dvander@347
   235
                          >
dvander@347
   236
                       >::type type;
dvander@347
   237
      };
dvander@347
   238
dvander@347
   239
Using HOPTER, this can be written as:
dvander@347
   240
dvander@347
   241
    template< typename FunctionPtr, typename R, @CLASSARGS>
dvander@347
   242
      struct get_function_invoker@NUM
dvander@347
   243
	  {
dvander@347
   244
        typedef typename ct_if<(is_void<R>::value),
dvander@347
   245
					void_function_invoker@NUM<FunctionPtr, R, @SELARGS>,
dvander@347
   246
					function_invoker@NUM<FunctionPtr,R, @SELARGS>
dvander@347
   247
                       >::type type;
dvander@347
   248
      };
dvander@347
   249
*/
dvander@347
   250
dvander@347
   251
int MaxNumArgs;
dvander@347
   252
dvander@347
   253
/// Makes the necessary subsititutions in 'bigblock', and writes to fout.
dvander@347
   254
void PrintVarArgs(FILE *fout, CString bigblock, int num) {
dvander@347
   255
	CString numstr;
dvander@347
   256
	CString invokelist;
dvander@347
   257
	CString funclist;
dvander@347
   258
	CString selectlist;
dvander@347
   259
	CString classlist;
dvander@347
   260
	CString commastr;
dvander@347
   261
	numstr.Format("%d", num);
dvander@347
   262
	if (num==0) {
dvander@347
   263
		invokelist="";
dvander@347
   264
		funclist="";
dvander@347
   265
		selectlist="";
dvander@347
   266
		commastr="";
dvander@347
   267
		classlist="";
dvander@347
   268
	}else {
dvander@347
   269
		invokelist="p1";
dvander@347
   270
		funclist="Param1 p1";
dvander@347
   271
		selectlist = "Param1";
dvander@347
   272
		classlist = "class Param1";
dvander@347
   273
		commastr=", ";
dvander@347
   274
		CString str;
dvander@347
   275
		for (int k=2; k<=num; k++) {
dvander@347
   276
			str.Format(", p%d", k);
dvander@347
   277
			invokelist+=str;
dvander@347
   278
			str.Format(", Param%d p%d", k, k);
dvander@347
   279
			funclist+=str;
dvander@347
   280
			str.Format(", Param%d", k);
dvander@347
   281
			selectlist += str;
dvander@347
   282
			str.Format(", class Param%d", k);
dvander@347
   283
			classlist += str;
dvander@347
   284
		}
dvander@347
   285
	}
dvander@347
   286
dvander@347
   287
	// Simple replacement of number of arguments
dvander@347
   288
	bigblock.Replace("@NUM", numstr);
dvander@347
   289
dvander@347
   290
	// Template declarations
dvander@347
   291
	if (num==0) bigblock.Replace("template<@CLASSARGS>", "");
dvander@347
   292
	else bigblock.Replace("template<@CLASSARGS>", 
dvander@347
   293
		(CString)"template<" + classlist+">");
dvander@347
   294
	if (num==0) bigblock.Replace("template <@CLASSARGS>", "");
dvander@347
   295
	else bigblock.Replace("template <@CLASSARGS>", 
dvander@347
   296
		(CString)"template<" + classlist+">");
dvander@347
   297
	bigblock.Replace(",@CLASSARGS", commastr + classlist);
dvander@347
   298
	bigblock.Replace(", @CLASSARGS", commastr + classlist);
dvander@347
   299
	bigblock.Replace("@CLASSARGS, ", classlist + commastr);
dvander@347
   300
	bigblock.Replace("@CLASSARGS,", classlist + commastr);
dvander@347
   301
	bigblock.Replace("@CLASSARGS", classlist);
dvander@347
   302
dvander@347
   303
	// Template selections
dvander@347
   304
	CString selargstr;
dvander@347
   305
	if (num==0) selargstr = "";
dvander@347
   306
	else selargstr = (CString)"<"+selectlist+">";
dvander@347
   307
dvander@347
   308
	bigblock.Replace("<@SELARGS>", selargstr);
dvander@347
   309
	bigblock.Replace("< @SELARGS >", selargstr);
dvander@347
   310
	bigblock.Replace(",@SELARGS", commastr + selectlist);
dvander@347
   311
	bigblock.Replace(", @SELARGS", commastr + selectlist);
dvander@347
   312
	bigblock.Replace("@SELARGS, ", selectlist + commastr);
dvander@347
   313
	bigblock.Replace("@SELARGS,", selectlist + commastr);
dvander@347
   314
	bigblock.Replace("@SELARGS", selectlist);
dvander@347
   315
dvander@347
   316
	// Function declarations
dvander@347
   317
	bigblock.Replace(",@FUNCARGS", commastr + funclist);
dvander@347
   318
	bigblock.Replace(", @FUNCARGS", commastr + funclist);
dvander@347
   319
	bigblock.Replace("@FUNCARGS, ", funclist + commastr);
dvander@347
   320
	bigblock.Replace("@FUNCARGS,", funclist + commastr);
dvander@347
   321
	bigblock.Replace("@FUNCARGS", funclist);
dvander@347
   322
dvander@347
   323
	// Function invocation
dvander@347
   324
	bigblock.Replace(",@INVOKEARGS", commastr + invokelist);
dvander@347
   325
	bigblock.Replace(", @INVOKEARGS", commastr + invokelist);
dvander@347
   326
	bigblock.Replace("@INVOKEARGS, ", invokelist + commastr);
dvander@347
   327
	bigblock.Replace("@INVOKEARGS,", invokelist + commastr);
dvander@347
   328
	bigblock.Replace("@INVOKEARGS", invokelist);
dvander@347
   329
dvander@347
   330
	fprintf(fout, bigblock);				
dvander@347
   331
}
dvander@347
   332
dvander@347
   333
int action_hopter(int numargs, const char *filenamein, const char *filenameout)
dvander@347
   334
{
dvander@347
   335
dvander@347
   336
	MaxNumArgs = numargs;
dvander@347
   337
dvander@347
   338
	FILE * fin;
dvander@347
   339
	FILE *fout;
dvander@347
   340
dvander@347
   341
	fin =fopen(filenamein,"rt");
dvander@347
   342
	if (!fin) { printf("Error, can't open %s\n", filenamein); return 1; };
dvander@347
   343
	fout = fopen (filenameout, "wt");
dvander@347
   344
	if (!fout) { printf("Error, can't open %s\n", filenameout); return 1; };
dvander@347
   345
	char buf[5000];
dvander@347
   346
	for (;;) {
dvander@347
   347
	 if (!fgets(buf, 5000, fin)) break;
dvander@347
   348
		if (!strncmp(buf, "@VARARGS", 8)) {
dvander@347
   349
			// found a match...
dvander@347
   350
			CString bigblock;
dvander@347
   351
			for (;;) {
dvander@347
   352
				if (feof(fin)) { printf("No matching @ENDVAR !!??\n"); return 1; };
dvander@347
   353
				fgets(buf, 5000, fin);
dvander@347
   354
				if (!strncmp(buf, "@ENDVAR", 7)) break;
dvander@347
   355
				bigblock+=buf;
dvander@347
   356
			}
dvander@347
   357
//			fprintf(fout, "// Auto-generated code [[[\n");
dvander@347
   358
			for (int k=0; k<=MaxNumArgs; k++) {
dvander@347
   359
				fprintf(fout, "//N=%d\n", k);
dvander@347
   360
				PrintVarArgs(fout, bigblock, k);
dvander@347
   361
			}
dvander@347
   362
//			fprintf(fout, "// ]]] End auto-generated code\n");
dvander@347
   363
		} else {
dvander@347
   364
			fprintf(fout, "%s", buf);
dvander@347
   365
		}
dvander@347
   366
	}
dvander@347
   367
	fclose(fin);
dvander@347
   368
	fclose(fout);
dvander@347
   369
	return 0;
dvander@347
   370
}