pavolmarko@1: // From fastdelegate pavolmarko@1: // http://www.codeproject.com/cpp/FastDelegate.asp pavolmarko@1: pavolmarko@1: // Modified to be run from shworker by PM pavolmarko@1: pavolmarko@1: pavolmarko@1: // HOPTER.EXE -- A simple header generator for vararg templates pavolmarko@1: /* MOTIVATION pavolmarko@1: C++ doesn't have a vararg feature for templates. This can be a pavolmarko@1: nuisance when writing class libraries. There are a few options: pavolmarko@1: (a) manually repeat code. This is tedious and error prone. pavolmarko@1: (b) Use macros. Messy, can't cope with template pavolmarko@1: arguments, and users get hard-to-interpret error messages. pavolmarko@1: (c) Use the boost preprocessor library. This slows compilation, pavolmarko@1: and introduces a dependency on boost. pavolmarko@1: (d) Write a program to automatically generate the code. pavolmarko@1: I've never seen a general program to do this job, so this is pavolmarko@1: a very simple command-line program to do it. pavolmarko@1: pavolmarko@1: Why is it called Hopter? pavolmarko@1: I wanted a word that started with h, to be reminiscent of header pavolmarko@1: files. At the time, my 2yo son kept talking about 'Hopter Copters' pavolmarko@1: (he couldn't pronounce 'helicopter'). pavolmarko@1: It also reflects the level of sophistication of this program -- pavolmarko@1: it was named by a two year old. pavolmarko@1: pavolmarko@1: IMPLEMENTATION pavolmarko@1: pavolmarko@1: When you analyze the problem, you find that the requirements pavolmarko@1: are very simple. pavolmarko@1: Varargs are needed in two places: templates and functions. pavolmarko@1: You want to use them in two ways: when declaring the template pavolmarko@1: or function, and when invoking the function / selecting the pavolmarko@1: template. pavolmarko@1: pavolmarko@1: It's a brain-dead implementation, which just does a search-and-replace pavolmarko@1: of specific strings. It could be done with a few lines using sed on pavolmarko@1: a *NIX platform. Because I use Windows, I've done a quick and dirty pavolmarko@1: implementation using CString. pavolmarko@1: pavolmarko@1: In a file, @VARARGS at the start of a line indicates the start of the code pavolmarko@1: to be expanded. @ENDVAR at the start of a line marks the end of the pavolmarko@1: expansion. pavolmarko@1: pavolmarko@1: declare template -- template <@CLASSARGS> class SomeClass pavolmarko@1: template pavolmarko@1: class SomeClass pavolmarko@1: pavolmarko@1: declare function -- somefunc(@FUNCARGS) pavolmarko@1: somefunc(Param1 p1, Param2 p2) pavolmarko@1: pavolmarko@1: select template -- SomeClass<@SELARGS> pavolmarko@1: SomeClass pavolmarko@1: pavolmarko@1: invoke function -- somefunc(@INVOKEARGS) pavolmarko@1: somefunc(p1, p2) pavolmarko@1: pavolmarko@1: I also provide @NUM which is the number of arguments. pavolmarko@1: The case where @NUM is zero is a special case: for template declarations, pavolmarko@1: the entire template<> bit needs to disappear. When other arguments are pavolmarko@1: involved, either at the beginning or end of the list, there a commas pavolmarko@1: which might need to be removed. pavolmarko@1: pavolmarko@1: I've used .hxx as the extension for these files. This enables C++ pavolmarko@1: I wanted to use an unusual file extension (.HOH) for these files, because they pavolmarko@1: aren't real header files. But I also like to use the C++ syntax highlighting pavolmarko@1: in Visual Studio. I chose .hxx because MSVC treats it as C++, but it pavolmarko@1: seems to very rarely used. pavolmarko@1: pavolmarko@1: Installation (for VC6, if you want to use .HOH as the extension instead): pavolmarko@1: Go into the registry and change pavolmarko@1: 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: to cpp;cxx;c;h;hxx;hpp;inl;tlh;tli;rc;rc2;hoh by adding “;hoh” to the end. pavolmarko@1: Then add this as a custom build step to the main file of your project: pavolmarko@1: hopter $(InputDir)\*.hoh $(InputDir)\*.h pavolmarko@1: pavolmarko@1: */ pavolmarko@1: pavolmarko@1: #include pavolmarko@1: #include pavolmarko@1: #include pavolmarko@1: pavolmarko@1: // This is a quick-n-dirty implementation of a CString replacement. pavolmarko@1: // It promises nothing more than to provide enough functionality to get pavolmarko@1: // this program to run. pavolmarko@1: // Note that I have really never used CString, so the information to pavolmarko@1: // implement the members that are used in this program come from pavolmarko@1: // online documentation at http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vcmfc98/html/_mfc_cstring.asp pavolmarko@1: // Also, I have only used VC++ a few times, a long time ago, so pavolmarko@1: // I really do not know what all their alphabet soup is suppoed to pavolmarko@1: // mean, so I just made a guess... pavolmarko@1: pavolmarko@1: pavolmarko@1: class CString pavolmarko@1: { pavolmarko@1: public: pavolmarko@1: enum { MAX_FORMAT_STRING_SIZE = 8 * 1044 }; pavolmarko@1: CString() pavolmarko@1: : str_() pavolmarko@1: { pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString( pavolmarko@1: CString const & rhs) pavolmarko@1: : str_(rhs.str_) pavolmarko@1: { pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString( pavolmarko@1: char ch, pavolmarko@1: int repeat = 1) pavolmarko@1: : str_(repeat, ch) pavolmarko@1: { pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString( pavolmarko@1: char const * s) pavolmarko@1: : str_(s) pavolmarko@1: { pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString & operator=( pavolmarko@1: CString const & rhs) pavolmarko@1: { pavolmarko@1: str_ = rhs.str_; pavolmarko@1: return *this; pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString & operator=( pavolmarko@1: char const * s) pavolmarko@1: { pavolmarko@1: str_ = s; pavolmarko@1: return *this; pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString & operator=( pavolmarko@1: char ch) pavolmarko@1: { pavolmarko@1: str_ = ch; pavolmarko@1: return *this; pavolmarko@1: } pavolmarko@1: pavolmarko@1: void Format( pavolmarko@1: char const * fmt, pavolmarko@1: ...) pavolmarko@1: { pavolmarko@1: char buffer[ MAX_FORMAT_STRING_SIZE ]; pavolmarko@1: va_list ap; pavolmarko@1: va_start(ap, fmt); pavolmarko@1: vsprintf(buffer, fmt, ap); pavolmarko@1: va_end(ap); pavolmarko@1: str_ = buffer; pavolmarko@1: } pavolmarko@1: pavolmarko@1: char operator[]( pavolmarko@1: int x) const pavolmarko@1: { pavolmarko@1: return str_[x]; pavolmarko@1: } pavolmarko@1: pavolmarko@1: CString & operator+=( pavolmarko@1: CString const & x) pavolmarko@1: { pavolmarko@1: str_ += x.str_; return *this; pavolmarko@1: } pavolmarko@1: pavolmarko@1: int Replace( pavolmarko@1: CString const & lhs, pavolmarko@1: CString const & rhs) pavolmarko@1: { pavolmarko@1: int rval = 0; pavolmarko@1: std::string::size_type pos = 0; pavolmarko@1: while (pos < str_.length()) pavolmarko@1: { pavolmarko@1: pos = str_.find(lhs.str_, pos); pavolmarko@1: if (pos != std::string::npos) pavolmarko@1: { pavolmarko@1: str_.replace(pos, lhs.GetLength(), rhs.str_); pavolmarko@1: pos += rhs.GetLength(); pavolmarko@1: ++rval; pavolmarko@1: } pavolmarko@1: } pavolmarko@1: return rval; pavolmarko@1: } pavolmarko@1: pavolmarko@1: int GetLength() const pavolmarko@1: { pavolmarko@1: return str_.length(); pavolmarko@1: } pavolmarko@1: pavolmarko@1: operator char const * () const pavolmarko@1: { pavolmarko@1: return str_.c_str(); pavolmarko@1: } pavolmarko@1: pavolmarko@1: private: pavolmarko@1: std::string str_; pavolmarko@1: }; pavolmarko@1: pavolmarko@1: pavolmarko@1: CString operator+( pavolmarko@1: CString const & x, pavolmarko@1: CString const & y) pavolmarko@1: { pavolmarko@1: CString result(x); pavolmarko@1: result += y; pavolmarko@1: return result; pavolmarko@1: } pavolmarko@1: pavolmarko@1: pavolmarko@1: /* Example: This is an excerpt from boost::function_template.hpp pavolmarko@1: pavolmarko@1: #define BOOST_FUNCTION_FUNCTION_INVOKER \ pavolmarko@1: BOOST_JOIN(function_invoker,BOOST_FUNCTION_NUM_ARGS) pavolmarko@1: #define BOOST_FUNCTION_VOID_FUNCTION_INVOKER \ pavolmarko@1: BOOST_JOIN(void_function_invoker,BOOST_FUNCTION_NUM_ARGS) pavolmarko@1: pavolmarko@1: template< pavolmarko@1: typename FunctionPtr, pavolmarko@1: typename R BOOST_FUNCTION_COMMA pavolmarko@1: BOOST_FUNCTION_TEMPLATE_PARMS pavolmarko@1: > pavolmarko@1: struct BOOST_FUNCTION_GET_FUNCTION_INVOKER pavolmarko@1: { pavolmarko@1: typedef typename ct_if<(is_void::value), pavolmarko@1: BOOST_FUNCTION_VOID_FUNCTION_INVOKER< pavolmarko@1: FunctionPtr, pavolmarko@1: R BOOST_FUNCTION_COMMA pavolmarko@1: BOOST_FUNCTION_TEMPLATE_ARGS pavolmarko@1: >, pavolmarko@1: BOOST_FUNCTION_FUNCTION_INVOKER< pavolmarko@1: FunctionPtr, pavolmarko@1: R BOOST_FUNCTION_COMMA pavolmarko@1: BOOST_FUNCTION_TEMPLATE_ARGS pavolmarko@1: > pavolmarko@1: >::type type; pavolmarko@1: }; pavolmarko@1: pavolmarko@1: Using HOPTER, this can be written as: pavolmarko@1: pavolmarko@1: template< typename FunctionPtr, typename R, @CLASSARGS> pavolmarko@1: struct get_function_invoker@NUM pavolmarko@1: { pavolmarko@1: typedef typename ct_if<(is_void::value), pavolmarko@1: void_function_invoker@NUM, pavolmarko@1: function_invoker@NUM pavolmarko@1: >::type type; pavolmarko@1: }; pavolmarko@1: */ pavolmarko@1: pavolmarko@1: int MaxNumArgs; pavolmarko@1: pavolmarko@1: /// Makes the necessary subsititutions in 'bigblock', and writes to fout. pavolmarko@1: void PrintVarArgs(FILE *fout, CString bigblock, int num) { pavolmarko@1: CString numstr; pavolmarko@1: CString invokelist; pavolmarko@1: CString funclist; pavolmarko@1: CString selectlist; pavolmarko@1: CString classlist; pavolmarko@1: CString commastr; pavolmarko@1: numstr.Format("%d", num); pavolmarko@1: if (num==0) { pavolmarko@1: invokelist=""; pavolmarko@1: funclist=""; pavolmarko@1: selectlist=""; pavolmarko@1: commastr=""; pavolmarko@1: classlist=""; pavolmarko@1: }else { pavolmarko@1: invokelist="p1"; pavolmarko@1: funclist="Param1 p1"; pavolmarko@1: selectlist = "Param1"; pavolmarko@1: classlist = "class Param1"; pavolmarko@1: commastr=", "; pavolmarko@1: CString str; pavolmarko@1: for (int k=2; k<=num; k++) { pavolmarko@1: str.Format(", p%d", k); pavolmarko@1: invokelist+=str; pavolmarko@1: str.Format(", Param%d p%d", k, k); pavolmarko@1: funclist+=str; pavolmarko@1: str.Format(", Param%d", k); pavolmarko@1: selectlist += str; pavolmarko@1: str.Format(", class Param%d", k); pavolmarko@1: classlist += str; pavolmarko@1: } pavolmarko@1: } pavolmarko@1: pavolmarko@1: // Simple replacement of number of arguments pavolmarko@1: bigblock.Replace("@NUM", numstr); pavolmarko@1: pavolmarko@1: // Template declarations pavolmarko@1: if (num==0) bigblock.Replace("template<@CLASSARGS>", ""); pavolmarko@1: else bigblock.Replace("template<@CLASSARGS>", pavolmarko@1: (CString)"template<" + classlist+">"); pavolmarko@1: if (num==0) bigblock.Replace("template <@CLASSARGS>", ""); pavolmarko@1: else bigblock.Replace("template <@CLASSARGS>", pavolmarko@1: (CString)"template<" + classlist+">"); pavolmarko@1: bigblock.Replace(",@CLASSARGS", commastr + classlist); pavolmarko@1: bigblock.Replace(", @CLASSARGS", commastr + classlist); pavolmarko@1: bigblock.Replace("@CLASSARGS, ", classlist + commastr); pavolmarko@1: bigblock.Replace("@CLASSARGS,", classlist + commastr); pavolmarko@1: bigblock.Replace("@CLASSARGS", classlist); pavolmarko@1: pavolmarko@1: // Template selections pavolmarko@1: CString selargstr; pavolmarko@1: if (num==0) selargstr = ""; pavolmarko@1: else selargstr = (CString)"<"+selectlist+">"; pavolmarko@1: pavolmarko@1: bigblock.Replace("<@SELARGS>", selargstr); pavolmarko@1: bigblock.Replace("< @SELARGS >", selargstr); pavolmarko@1: bigblock.Replace(",@SELARGS", commastr + selectlist); pavolmarko@1: bigblock.Replace(", @SELARGS", commastr + selectlist); pavolmarko@1: bigblock.Replace("@SELARGS, ", selectlist + commastr); pavolmarko@1: bigblock.Replace("@SELARGS,", selectlist + commastr); pavolmarko@1: bigblock.Replace("@SELARGS", selectlist); pavolmarko@1: pavolmarko@1: // Function declarations pavolmarko@1: bigblock.Replace(",@FUNCARGS", commastr + funclist); pavolmarko@1: bigblock.Replace(", @FUNCARGS", commastr + funclist); pavolmarko@1: bigblock.Replace("@FUNCARGS, ", funclist + commastr); pavolmarko@1: bigblock.Replace("@FUNCARGS,", funclist + commastr); pavolmarko@1: bigblock.Replace("@FUNCARGS", funclist); pavolmarko@1: pavolmarko@1: // Function invocation pavolmarko@1: bigblock.Replace(",@INVOKEARGS", commastr + invokelist); pavolmarko@1: bigblock.Replace(", @INVOKEARGS", commastr + invokelist); pavolmarko@1: bigblock.Replace("@INVOKEARGS, ", invokelist + commastr); pavolmarko@1: bigblock.Replace("@INVOKEARGS,", invokelist + commastr); pavolmarko@1: bigblock.Replace("@INVOKEARGS", invokelist); pavolmarko@1: pavolmarko@1: fprintf(fout, bigblock); pavolmarko@1: } pavolmarko@1: pavolmarko@195: int action_hopter(int numargs, const char *filenamein, const char *filenameout) pavolmarko@1: { pavolmarko@1: pavolmarko@1: MaxNumArgs = numargs; pavolmarko@1: pavolmarko@1: FILE * fin; pavolmarko@1: FILE *fout; pavolmarko@1: pavolmarko@1: fin =fopen(filenamein,"rt"); pavolmarko@1: if (!fin) { printf("Error, can't open %s\n", filenamein); return 1; }; pavolmarko@1: fout = fopen (filenameout, "wt"); pavolmarko@1: if (!fout) { printf("Error, can't open %s\n", filenameout); return 1; }; pavolmarko@1: char buf[5000]; pavolmarko@1: for (;;) { pavolmarko@1: if (!fgets(buf, 5000, fin)) break; pavolmarko@1: if (!strncmp(buf, "@VARARGS", 8)) { pavolmarko@1: // found a match... pavolmarko@1: CString bigblock; pavolmarko@1: for (;;) { pavolmarko@1: if (feof(fin)) { printf("No matching @ENDVAR !!??\n"); return 1; }; pavolmarko@1: fgets(buf, 5000, fin); pavolmarko@1: if (!strncmp(buf, "@ENDVAR", 7)) break; pavolmarko@1: bigblock+=buf; pavolmarko@1: } pavolmarko@1: // fprintf(fout, "// Auto-generated code [[[\n"); pavolmarko@1: for (int k=0; k<=MaxNumArgs; k++) { pavolmarko@1: fprintf(fout, "//N=%d\n", k); pavolmarko@1: PrintVarArgs(fout, bigblock, k); pavolmarko@1: } pavolmarko@1: // fprintf(fout, "// ]]] End auto-generated code\n"); pavolmarko@1: } else { pavolmarko@1: fprintf(fout, "%s", buf); pavolmarko@1: } pavolmarko@1: } pavolmarko@1: fclose(fin); pavolmarko@1: fclose(fout); pavolmarko@1: return 0; pavolmarko@1: }