X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=codegen%2Fmain.cpp;h=45aa9d70a6dee52debba714542870e50eccaf26b;hp=ec974036bac336b9fdeba37d059cf6411bde973b;hb=a930cc995e41002986df3d6c9b722eea11fd6627;hpb=d340d435f156ae23b7d285c6e3abd59b019a5363
diff --git a/codegen/main.cpp b/codegen/main.cpp
index ec97403..45aa9d7 100644
--- a/codegen/main.cpp
+++ b/codegen/main.cpp
@@ -1,3 +1,75 @@
+/*
+ Copyright (C) 2006
+ intra2net.com
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+*/
+
+/*! \mainpage libt2n - (talk2neighbor)
+ \section intro_sec Introduction
+ libt2n (talk2neighbor) is a C++ library for inter-process communication (IPC, s.a. http://en.wikipedia.org/wiki/Inter-process_communication)
+ with an additional code generator to make remote procedure calls simple. XXX: improve this paragraph: The input for the code generator is standard C++ code (in fact we use gccxml to parse the C++ code and the code generator takes the XML as input) and you mark the procedures you want to expose to other processes.
+ It then generates the stubs needed.
+ The exported procedures can be grouped. For each group the code generator is called which generates 6 outputfiles: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files are used by the client and the _server files by the server.
+
+ \section install_sec Installation
+
+ \subsection requirements Requirements
+ - boost (serialization )
+ - gccxml
+ - libxmlpp
+
+ \section usage Usage example
+
+ In this example we create two packages:
+ - server program and library to connect to the server. The server exports a simple procedure using one group: "t2nexample"
+ - client program using the library
+
+ \subsection server Example server program and client library
+
+ \par The procedure to export (input for the code generator - libt2n-codegen): t2nexample.cpp:
+ \verbinclude libt2n-example1/t2nexample.cpp
+
+ \par Required includes must be put into a seperate group header file: t2nexample.hxx:
+ \verbinclude libt2n-example1/t2nexample.hxx
+
+ \par The server program:
+ \verbinclude libt2n-example1/server.cpp
+
+ \par Using autoconf and automake to build a example server program and a client library.
+ In the configure.in(.ac) we put a check for libt2n:
+ \verbinclude libt2n-example1/configure.in
+ Writing the Makefile.am isn't difficult either:
+ \verbinclude libt2n-example1/Makefile.am
+
+ \subsection client Client using the library
+ Using the library is as simple as using any other library using pkg-config (the pkg-config .pc file is created automatically by the included Makefile snippet)
+ \par We only have to check that the library is installed
+ \verbinclude libt2n-example1-client/configure.in
+ \par Nothing special
+ \verbinclude libt2n-example1-client/Makefile.am
+ \par The client program
+ \verbinclude libt2n-example1-client/client.cpp
+
+*/
+
+/*!
+ \example t2nexample.cpp
+ example input for libt2n-codegen
+*/
+
#include
#include
#include
@@ -6,6 +78,16 @@
#include
#include
#include
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+
+//! map group to class name
+std::string
+groupClass(const std::string &group) {
+ return std::string("cmd_group_")+group;
+}
//! convert string to upper case
std::string
@@ -291,7 +373,7 @@ protected:
};
void output_common_hpp(std::ostream &o, const std::string &group, const std::list &procs) {
- o << "class cmd_group_" << group << " : public libt2n::command\n"
+ o << "class " << groupClass(group) << " : public libt2n::command\n"
<< "{\n"
<< "private:\n"
<< " friend class boost::serialization::access;\n"
@@ -319,7 +401,7 @@ void output_common_hpp(std::ostream &o, const std::string &group, const std::lis
<< "};\n";
}
for (std::list::const_iterator it=procs.begin();it!=procs.end();++it) {
- o << "class " << it->cmd_classname() << " : public " << "cmd_group_" << group << "\n"
+ o << "class " << it->cmd_classname() << " : public " << groupClass(group) << "\n"
<< "{\n"
<< "private:\n";
for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
@@ -329,7 +411,7 @@ void output_common_hpp(std::ostream &o, const std::string &group, const std::lis
<< " template\n"
<< " void serialize(Archive & ar, const unsigned int /* version */)\n"
<< " {\n"
- << " ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(cmd_group_" << group << ");\n";
+ << " ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(" << groupClass(group) << ");\n";
for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
o << " ar & BOOST_SERIALIZATION_NVP(" << ait->first << ");\n";
}
@@ -362,7 +444,7 @@ void output_common_cpp(std::ostream &o, const std::string &group, const std::lis
<< "#include \n"
<< "\n"
<< "/* register types with boost serialization */\n";
- o << "BOOST_CLASS_EXPORT(cmd_group_" << group << ")\n";
+ o << "BOOST_CLASS_EXPORT(" << groupClass(group) << ")\n";
for (std::list::const_iterator it=procs.begin();it!=procs.end();++it) {
o << "BOOST_CLASS_EXPORT("<ret_classname()<<")\n"
<< "BOOST_CLASS_EXPORT("<cmd_classname()<<")\n";
@@ -372,10 +454,10 @@ void output_common_cpp(std::ostream &o, const std::string &group, const std::lis
void output_client_hpp(std::ostream &o, const std::string &group, const std::list &procs) {
o << "#include \n";
- o << "class cmd_group_" << group << "_client : public libt2n::command_client\n"
+ o << "class " << groupClass(group) << "_client : public libt2n::command_client\n"
<< "{\n"
<< "public:\n"
- << "cmd_group_" << group << "_client(libt2n::client_connection &_c,\n"
+ << groupClass(group) << "_client(libt2n::client_connection &_c,\n"
<< " long long _command_timeout_usec=command_timeout_usec_default,\n"
<< " long long _hello_timeout_usec=hello_timeout_usec_default)\n"
<< " : libt2n::command_client(_c,_command_timeout_usec,_hello_timeout_usec)\n"
@@ -395,7 +477,7 @@ void output_client_cpp(std::ostream &o, const std::string &group, const std::lis
}
for (std::list::const_iterator pit=procs.begin();pit!=procs.end();++pit) {
- o << pit->ret_type << " cmd_group_" << group << "_client::" << pit->name << "(" << pit->args << ")\n"
+ o << pit->ret_type << " " << groupClass(group) << "_client::" << pit->name << "(" << pit->args << ")\n"
<< "{\n"
<< " libt2n::result_container rc;\n"
<< " send_command(new " << pit->cmd_classname() << "(";
@@ -444,7 +526,7 @@ struct header_file : public std::ofstream
header_file(const char* fname) : std::ofstream(fname) {
std::cerr << "create header: '" << fname << "'" << std::endl;
std::string macro(replace(toupper(fname),'.','_'));
- *this << "// automatically generated code - do not edit\n" << std::endl;
+ *this << "// automatically generated code (generated by libt2n-codegen " << VERSION << ") - do not edit\n" << std::endl;
*this << "#ifndef " << macro << "\n"
<< "#define " << macro << "\n";
}
@@ -464,12 +546,18 @@ struct cpp_file : public std::ofstream
int
main(int argc, char* argv[])
{
- if (argc < 3) {
- std::cerr << "Usage: " << argv[0] << "default-group gccxml-file1 gccxml-file2 ... " << std::endl;
- return 1;
- }
+ // todo: maybe use getopt
+ if ((argc>1)&&(std::string(argv[1])=="--version")) {
+ std::cerr << VERSION << std::endl;
+ return 0;
+ }
+ if (argc < 3)
+ {
+ std::cerr << "Usage: " << argv[0] << "default-group gccxml-file1 gccxml-file2 ... " << std::endl;
+ return 1;
+ }
- try{
+ try{
std::string group(argv[1]);
std::list xmlfiles;
for (int i=2;i