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