allow to set default group, cleanup, added support for overloaded procedures
[libt2n] / codegen / main.cpp
CommitLineData
e50cc1d6
JT
1#include <libxml++/libxml++.h>
2#include <cassert>
3#include <iostream>
060fbd87
JT
4#include <set>
5#include <fstream>
9d3993e5 6#include <list>
e50cc1d6 7
52b6f93a 8//! convert string to upper case
e035276b
JT
9std::string
10toupper(std::string s) {
11 for (unsigned i=0; i<s.length(); ++i) s[i]=toupper(s[i]);
12 return s;
13}
14
52b6f93a 15//! replace all characters f by r in string s
e035276b
JT
16std::string
17replace(std::string s, char f, char r) {
18 for (unsigned i=0; i<s.length(); ++i) if (s[i]==f) s[i]=r;
19 return s;
20}
21
52b6f93a
JT
22//! strip prefix from string s
23/*!
24 \return string s without prefix or an empty string on error
25 */
e035276b
JT
26std::string
27strip(std::string s, std::string prefix)
28{
29 std::string error;
30 if ( (prefix.length()>s.length() ) || ( std::string(s,0,prefix.length())!=prefix ) ) return error;
31 return std::string(s, prefix.length(), s.length()-prefix.length());
32}
33
52b6f93a 34//! extract group from attributes
25b3f2c1
JT
35std::string
36extract_group(const std::string &attrs)
37{
38 // todo: improve this
39 std::string error;
40 std::string to_match("gccxml(libt2n-");
41 std::string::size_type p(attrs.find(to_match));
42 if (p==std::string::npos) return error;
43 std::string group(attrs, p+to_match.length(), attrs.length());
44 p=group.find_first_of(')');
45 assert(p!=std::string::npos);
46 return std::string(group,0,p);
47}
48
e50cc1d6
JT
49//! get child element by id
50/*!
51 \return pointer to element having id or null on error
52 \todo find libxmlpp pendant
53*/
54const xmlpp::Element* get_element_by_id(const xmlpp::Element* element, const std::string &id)
55{
56 const xmlpp::Attribute* cid = element->get_attribute("id");
57 if ( cid && ( cid->get_value() == id)) return element;
58
59 //Recurse through child nodes:
60 xmlpp::Node::NodeList list = element->get_children();
61 for(xmlpp::Node::NodeList::iterator iter = list.begin(); iter != list.end(); ++iter)
62 {
63 const xmlpp::Element* element = dynamic_cast<const xmlpp::Element*>(*iter);
64 if (element) {
65 const xmlpp::Element* match = get_element_by_id(element, id);
66 if (match) return match;
67 }
68 }
69 return NULL;
70}
71
72//! get namespace by id
73/*!
74 \return namespace name or empty string on error
75*/
76std::string get_namespace(const xmlpp::Element* root, const std::string &id)
77{
78 std::string error;
79 const xmlpp::Element* element(get_element_by_id(root, id));
80 if ((!element)||(!element->get_attribute("name"))) return error;
81 return element->get_attribute("name")->get_value();
82}
83
52b6f93a
JT
84//! get default group
85std::string get_default_group(const xmlpp::Element* root) {
86 std::string error;
87
88 if ( (root->get_attribute("name"))
89 && (root->get_attribute("attributes"))
90 && (root->get_name() == "Typedef")
91 && (root->get_attribute("name")->get_value()=="libt2n_default_group"))
92 return extract_group(root->get_attribute("attributes")->get_value());
93
94 //Recurse through child nodes:
95 xmlpp::Node::NodeList list = root->get_children();
96 for(xmlpp::Node::NodeList::iterator iter = list.begin(); iter != list.end(); ++iter)
97 {
98 if (const xmlpp::Element* elem=dynamic_cast<const xmlpp::Element*>(*iter)) {
99 std::string ret(get_default_group(elem));
100 if (!ret.empty()) return ret;
101 }
102 }
103 return error;
104}
e035276b
JT
105
106struct type_info
107{
108 std::string name;
109 std::string noref_name;
110 bool operator==(const type_info& o) {return (name==o.name) && (noref_name == o.noref_name);}
9d3993e5 111 std::string noref() const {return noref_name.empty() ? name : noref_name;}
e035276b
JT
112};
113
114std::ostream &operator<<(std::ostream &o, const type_info &t) {
115 o << t.name;
116 return o;
117}
118
e50cc1d6
JT
119//! get type by id
120/*!
121 \return type name or empty string on error
122*/
e035276b 123type_info get_type(const xmlpp::Element* root, const std::string &id)
e50cc1d6 124{
e035276b 125 type_info error;
e50cc1d6
JT
126 const xmlpp::Element* element(get_element_by_id(root, id));
127 if (!element) return error;
128
129 // TODO: not yet complete
130 // if we recurse - when do we stop?
131 // if it is a typedef? yes? (hmm if the typedef is in the file parsed this will not work)
060fbd87 132
9d3993e5 133 // TODO: const and reference types handling is a ugly hack
060fbd87 134
e50cc1d6
JT
135 std::string tag(element->get_name());
136 if (tag=="ReferenceType") {
137 assert(element->get_attribute("type"));
e035276b 138 type_info ret(get_type(root, element->get_attribute("type")->get_value()));
e50cc1d6 139 if (ret==error) return error;
e035276b
JT
140 // at the moment we only support const &
141 // todo: nice error message!
142 if ((ret.noref_name=strip(ret.name,"const ")).empty()) return error;
143 ret.name=ret.name+"&";
144 return ret;
e50cc1d6
JT
145 }else if (tag=="CvQualifiedType") {
146 assert(element->get_attribute("type"));
e035276b 147 type_info ret(get_type(root, element->get_attribute("type")->get_value()));
e50cc1d6 148 if (ret==error) return error;
e035276b
JT
149 ret.name=std::string("const ")+ret.name;
150 return ret;
e50cc1d6
JT
151 }
152
153 assert(element->get_attribute("name"));
e035276b 154 type_info ret;
9d3993e5
JT
155 if (element->get_attribute("context"))
156 ret.name=get_namespace(root, element->get_attribute("context")->get_value())+"::";
157 ret.name+=element->get_attribute("name")->get_value();
e035276b 158 return ret;
e50cc1d6
JT
159}
160
060fbd87
JT
161struct t2n_procedure
162{
9d3993e5 163 typedef std::list<std::pair<std::string, type_info> > Args;
e50cc1d6 164
060fbd87 165 std::string group;
e035276b 166 type_info ret_type;
060fbd87 167 std::string name;
52b6f93a 168 std::string mangled;
060fbd87 169 Args args;
e50cc1d6 170
060fbd87 171 std::string ret_classname() const {
52b6f93a 172 return name+mangled+"_res";
060fbd87
JT
173 }
174 std::string cmd_classname() const {
52b6f93a 175 return name+mangled+"_cmd";
060fbd87
JT
176 }
177};
e50cc1d6 178
060fbd87
JT
179std::ostream &operator<<(std::ostream &o, const t2n_procedure::Args &args) {
180 for (t2n_procedure::Args::const_iterator it=args.begin();it!=args.end();++it) {
181 if (it!=args.begin()) o << ", ";
182 o << it->second << " " << it->first;
183 }
184 return o;
185}
e50cc1d6 186
060fbd87
JT
187std::ostream &operator<<(std::ostream &o, const t2n_procedure &f) {
188 o << f.ret_type << " " << f.name << "(" << f.args << ")";
189 return o;
190}
e50cc1d6 191
060fbd87
JT
192class Parser
193{
194public:
195 Parser(const std::string &fname) : m_fname(fname) {}
e50cc1d6 196
060fbd87
JT
197 std::list<t2n_procedure> get_procedures() {
198 xmlpp::DomParser parser;
199 // parser.set_validate();
200 parser.set_substitute_entities(); //We just want the text to be resolved/unescaped automatically.
201 parser.parse_file(m_fname);
202 if(parser)
203 {
204 //Walk the tree:
205 const xmlpp::Node* pNode = parser.get_document()->get_root_node(); //deleted by DomParser.
206 const xmlpp::Element* root = dynamic_cast<const xmlpp::Element*>(pNode);
207 assert(root);
208 visit_node(root);
e50cc1d6 209 }
060fbd87 210 return m_procedures;
e50cc1d6 211 }
060fbd87
JT
212protected:
213 std::string m_fname;
214 std::list<t2n_procedure> m_procedures;
215
216 void parse_function(const xmlpp::Element* root, const xmlpp::Node* node) {
217 const xmlpp::Element* element = dynamic_cast<const xmlpp::Element*>(node);
218 if (!element) return;
219
220 const xmlpp::Attribute* attributes = element->get_attribute("attributes");
221 const xmlpp::Attribute* name = element->get_attribute("name");
52b6f93a 222 const xmlpp::Attribute* mangled = element->get_attribute("mangled");
060fbd87 223 const xmlpp::Attribute* returns = element->get_attribute("returns");
52b6f93a 224 if ((!attributes)||(!name)||(!mangled)||(!returns)) return;
060fbd87
JT
225
226 // check wether the procedure is marked (TODO: improve)
227 // attributes are speparated by spaces?
060fbd87 228
060fbd87 229 t2n_procedure f;
25b3f2c1
JT
230 f.group=extract_group(attributes->get_value());
231 if (f.group.empty()) return;
232 // todo: handle default group
52b6f93a 233 if (f.group=="default") f.group=get_default_group(root);
e50cc1d6 234
060fbd87
JT
235 // we need the return type
236 f.ret_type=get_type(root, returns->get_value());
237 f.name=name->get_value();
52b6f93a 238 f.mangled=mangled->get_value();
060fbd87
JT
239
240 xmlpp::Node::NodeList list = node->get_children("Argument");
241 for(xmlpp::Node::NodeList::iterator iter = list.begin(); iter != list.end(); ++iter)
242 {
243 const xmlpp::Element* arg = dynamic_cast<const xmlpp::Element*>(*iter);
244 if ( arg ) {
245 assert(arg->get_name() == "Argument");
246 assert(arg->get_attribute("name"));
247 assert(arg->get_attribute("type"));
9d3993e5 248 f.args.push_back(std::pair<std::string, type_info>(arg->get_attribute("name")->get_value(), get_type(root, arg->get_attribute("type")->get_value())));
060fbd87
JT
249 }
250 }
9d3993e5 251 std::cerr << "Found function: " << f << std::endl;
060fbd87 252 m_procedures.push_back(f);
e50cc1d6 253 }
e50cc1d6 254
060fbd87
JT
255 void visit_node(const xmlpp::Element* root, const xmlpp::Node* node = NULL, unsigned int indentation = 0)
256 {
257 if (!node) node=root;
060fbd87
JT
258
259 const xmlpp::ContentNode* nodeContent = dynamic_cast<const xmlpp::ContentNode*>(node);
260 const xmlpp::TextNode* nodeText = dynamic_cast<const xmlpp::TextNode*>(node);
261 const xmlpp::CommentNode* nodeComment = dynamic_cast<const xmlpp::CommentNode*>(node);
e50cc1d6 262
060fbd87
JT
263 if(nodeText && nodeText->is_white_space()) //Let's ignore the indenting - you don't always want to do this.
264 return;
e50cc1d6 265
060fbd87 266 std::string nodename = node->get_name();
e50cc1d6 267
060fbd87
JT
268 if(!nodeText && !nodeComment && !nodename.empty()) //Let's not say "name: text".
269 {
52b6f93a 270 if (node->get_name() == "Function") parse_function(root, node);
060fbd87 271 }
060fbd87
JT
272 if(!nodeContent)
273 {
274 //Recurse through child nodes:
275 xmlpp::Node::NodeList list = node->get_children();
276 for(xmlpp::Node::NodeList::iterator iter = list.begin(); iter != list.end(); ++iter)
277 {
278 visit_node(root, *iter, indentation + 2); //recursive
279 }
280 }
e50cc1d6 281 }
060fbd87
JT
282};
283
284//! find used groups
285std::set<std::string>
286used_groups(const std::list<t2n_procedure> &funcs) {
287 typedef std::set<std::string> Groups;
288 Groups groups;
289 for (std::list<t2n_procedure>::const_iterator it=funcs.begin();it!=funcs.end();++it)
290 // since we use std::set each group is inserted only once
291 groups.insert(it->group);
292 return groups;
293}
294
295void output_common_hpp(std::ostream &o, const std::list<t2n_procedure> &procs) {
296 std::set<std::string> groups(used_groups(procs));
297
298 o << "#include \"codegen-stubhead.hxx\"\n";
299 for (std::set<std::string>::iterator it=groups.begin();it!=groups.end();++it) {
300 o << "class cmd_group_" << *it << " : public libt2n::command\n"
301 << "{\n"
302 << "private:\n"
303 << " friend class boost::serialization::access;\n"
304 << " template<class Archive>\n"
305 << " void serialize(Archive & ar, const unsigned int version)\n"
306 << " {ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(libt2n::command);}\n"
307 << "};\n";
e50cc1d6 308 }
060fbd87
JT
309
310 for (std::list<t2n_procedure>::const_iterator it=procs.begin();it!=procs.end();++it) {
311 o << "class " << it->ret_classname() << " : public libt2n::result\n"
312 << "{\n"
313 << "private:\n"
314 << " " << it->ret_type << " res;\n"
315 << " friend class boost::serialization::access;\n"
316 << " template<class Archive>\n"
317 << " void serialize(Archive & ar, const unsigned int version)\n"
318 << " {\n"
319 << " ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(libt2n::result);\n"
320 << " ar & BOOST_SERIALIZATION_NVP(res);\n"
321 << " }\n"
322 << "public:\n"
e035276b 323 << " " << it->ret_classname() << "() {}\n"
060fbd87
JT
324 << " " << it->ret_classname() << "(const " << it->ret_type << " &_res) : res(_res) {}\n"
325 << " " << it->ret_type << " get_data() { return res; }\n"
326 << "};\n";
e50cc1d6 327 }
060fbd87
JT
328 for (std::list<t2n_procedure>::const_iterator it=procs.begin();it!=procs.end();++it) {
329 o << "class " << it->cmd_classname() << " : public " << "cmd_group_" << it->group << "\n"
330 << "{\n"
331 << "private:\n";
332 for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
e035276b 333 o << " " << ait->second.noref() << " " << ait->first << ";\n";
060fbd87
JT
334 }
335 o << " friend class boost::serialization::access;\n"
336 << " template<class Archive>\n"
337 << " void serialize(Archive & ar, const unsigned int version)\n"
338 << " {\n"
339 << " ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(cmd_group_" << it->group << ");\n";
340 for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
341 o << " ar & BOOST_SERIALIZATION_NVP(" << ait->first << ");\n";
342 }
e50cc1d6 343
060fbd87
JT
344 // default constructor
345 o << " }\n"
346 << "\n"
347 << "public:\n"
348 << " " << it->cmd_classname() << "() {}\n";
349
350 // constructor taking all arguments
351 o << " " << it->cmd_classname() << "(";
352 for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
353 if (ait!=it->args.begin()) o << ", ";
354 o << ait->second << " _" << ait->first;
355 }
356 o << ") : ";
357 for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
358 if (ait!=it->args.begin()) o << ", ";
359 o << ait->first << "(_" << ait->first << ")";
360 }
361 o << " {}\n"
362 << " libt2n::result* operator()();\n"
363 << "};\n";
e50cc1d6 364 }
060fbd87
JT
365}
366
367void output_common_cpp(std::ostream &o, const std::list<t2n_procedure> &procs, const std::string &common_hpp) {
368 std::set<std::string> groups(used_groups(procs));
369
370 o << "#include \"" << common_hpp << "\"\n"
e035276b 371 << "#include <boost/serialization/export.hpp>\n"
060fbd87
JT
372 << "\n"
373 << "/* register types with boost serialization */\n";
374 for (std::set<std::string>::iterator it=groups.begin();it!=groups.end();++it) {
375 o << "BOOST_CLASS_EXPORT(cmd_group_" << *it << ")\n";
e50cc1d6 376 }
060fbd87
JT
377 for (std::list<t2n_procedure>::const_iterator it=procs.begin();it!=procs.end();++it) {
378 o << "BOOST_CLASS_EXPORT("<<it->ret_classname()<<")\n"
379 << "BOOST_CLASS_EXPORT("<<it->cmd_classname()<<")\n";
e50cc1d6 380 }
060fbd87 381}
e50cc1d6 382
060fbd87
JT
383void output_client_hpp(std::ostream &o, const std::list<t2n_procedure> &procs) {
384 std::set<std::string> groups(used_groups(procs));
e50cc1d6 385
060fbd87
JT
386 o << "#include <command_client.hxx>\n";
387
388 for (std::set<std::string>::iterator it=groups.begin();it!=groups.end();++it) {
389 o << "class cmd_group_" << *it << "_client : public libt2n::command_client\n"
390 << "{\n"
391 << "public:\n"
392 << "cmd_group_" << *it << "_client(libt2n::client_connection &_c,\n"
393 << " long long _command_timeout_usec=command_timeout_usec_default,\n"
394 << " long long _hello_timeout_usec=hello_timeout_usec_default)\n"
395 << " : libt2n::command_client(_c,_command_timeout_usec,_hello_timeout_usec)\n"
396 << " {}\n";
397 for (std::list<t2n_procedure>::const_iterator pit=procs.begin();pit!=procs.end();++pit) {
398 if (pit->group==*it) {
399 o << " " << *pit << ";\n";
400 }
e50cc1d6 401 }
060fbd87
JT
402 o << "};\n";
403 }
404}
e50cc1d6 405
060fbd87
JT
406void output_client_cpp(std::ostream &o, const std::list<t2n_procedure> &procs, const std::string &common_hpp, const std::string &common_cpp, const std::string &client_hpp) {
407 std::set<std::string> groups(used_groups(procs));
408
409 o << "#include \"" << client_hpp << "\"\n"
410 << "#include \"" << common_hpp << "\"\n"
411 << "// fake\n";
412 for (std::list<t2n_procedure>::const_iterator it=procs.begin();it!=procs.end();++it) {
413 o << "libt2n::result* " << it->cmd_classname() << "::operator()() { return NULL; }\n";
414 }
415
416 for (std::set<std::string>::iterator it=groups.begin();it!=groups.end();++it) {
417 for (std::list<t2n_procedure>::const_iterator pit=procs.begin();pit!=procs.end();++pit) {
418 if (pit->group==*it) {
419 o << pit->ret_type << " cmd_group_" << *it << "_client::" << pit->name << "(" << pit->args << ")\n"
420 << "{\n"
421 << " libt2n::result_container rc;\n"
422 << " send_command(new " << pit->cmd_classname() << "(";
423 for (t2n_procedure::Args::const_iterator ait=pit->args.begin();ait!=pit->args.end();++ait) {
424 if (ait!=pit->args.begin()) o << ", ";
425 o << ait->first;
426 }
427 o << "), rc);\n"
428 << " " << pit->ret_classname() << "* res=dynamic_cast<" << pit->ret_classname() << "*>(rc.get_result());\n"
429 << " if (!res) throw libt2n::t2n_communication_error(\"result object of wrong type\");\n"
430 << " return res->get_data();\n"
431 << "}\n";
432 }
e50cc1d6
JT
433 }
434 }
060fbd87
JT
435
436 // include in this compilation unit to ensure the compilation unit is used
437 // see also:
438 // http://www.google.de/search?q=g%2B%2B+static+initializer+in+static+library
439 o << "#include \"" << common_cpp << "\"\n";
440}
441
442void output_server_cpp(std::ostream &o, const std::list<t2n_procedure> &procs, const std::string &common_hpp, const std::string &common_cpp) {
443 o << "#include \"" << common_hpp << "\"\n";
444
445 for (std::list<t2n_procedure>::const_iterator it=procs.begin();it!=procs.end();++it) {
446 o << *it << ";\n";
447 o << "libt2n::result* " << it->cmd_classname() << "::operator()() { return new " << it->ret_classname() << "(" << it->name << "(";
448 for (t2n_procedure::Args::const_iterator ait=it->args.begin();ait!=it->args.end();++ait) {
449 if (ait!=it->args.begin()) o << ", ";
450 o << ait->first;
e50cc1d6 451 }
060fbd87 452 o << ")); }\n";
e50cc1d6 453 }
060fbd87
JT
454 o << "#include \"" << common_cpp << "\"\n";
455}
456
060fbd87
JT
457struct header_file : public std::ofstream
458{
459 header_file(const char* fname) : std::ofstream(fname) {
460 std::cerr << "create header: '" << fname << "'" << std::endl;
461 std::string macro(replace(toupper(fname),'.','_'));
462 *this << "// automatically generated code - do not edit\n" << std::endl;
463 *this << "#ifndef " << macro << "\n"
464 << "#define " << macro << "\n";
465 }
466 ~header_file() {
467 *this << "#endif" << std::endl;
468 }
469};
470
471struct cpp_file : public std::ofstream
472{
473 cpp_file(const char* fname) : std::ofstream(fname) {
474 std::cerr << "create cpp: '" << fname << "'" << std::endl;
475 *this << "// automatically generated code - do not edit\n" << std::endl;
476 }
477};
478
479int
480main(int argc, char* argv[])
e50cc1d6 481{
f8b78aa8
JT
482 if (argc != 3) {
483 std::cerr << "Usage: " << argv[0] << " gccxml-file outputprefix" << std::endl;
484 return 1;
485 }
486 std::string filepath(argv[1]);
487 std::string prefix(argv[2]);
e50cc1d6 488
060fbd87
JT
489 Parser parser(filepath);
490 std::list<t2n_procedure> procedures(parser.get_procedures());
491
492 std::cerr << "Procedures:" << std::endl;
493 for (std::list<t2n_procedure>::const_iterator it=procedures.begin();it!=procedures.end();++it)
494 std::cerr << *it << ";" << std::endl;
495
496 std::set<std::string> groups(used_groups(procedures));
497 std::cerr << "Used groups:" << std::endl;
498 for (std::set<std::string>::const_iterator it=groups.begin();it!=groups.end();++it)
499 std::cerr << *it << std::endl;
500
060fbd87
JT
501 std::string common_hpp_fname(prefix+"common.hxx");
502 std::string common_cpp_fname(prefix+"common.cpp");
503 std::string client_hpp_fname(prefix+"client.hxx");
504 std::string client_cpp_fname(prefix+"client.cpp");
e035276b 505 std::string server_cpp_fname(prefix+"server.cpp");
060fbd87
JT
506
507 header_file common_hpp(common_hpp_fname.c_str());
508 output_common_hpp(common_hpp, procedures);
509
510 cpp_file common_cpp(common_cpp_fname.c_str());
e035276b 511 output_common_cpp(common_cpp, procedures, common_hpp_fname);
060fbd87
JT
512
513 header_file client_hpp(client_hpp_fname.c_str());
514 output_client_hpp(client_hpp, procedures);
515
516 cpp_file client_cpp(client_cpp_fname.c_str());
517 output_client_cpp(client_cpp, procedures, common_hpp_fname, common_cpp_fname, client_hpp_fname);
e50cc1d6 518
060fbd87
JT
519 cpp_file server_cpp(server_cpp_fname.c_str());
520 output_server_cpp(server_cpp, procedures, common_hpp_fname, common_cpp_fname);
e50cc1d6
JT
521 return 0;
522}