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