1 // idlcomp/languages/c++/main.cc -- C++ IDL binding
3 // This software is copyright (c) 2006 Scott Wood <scott@buserror.net>.
5 // This software is provided 'as-is', without any express or implied warranty.
6 // In no event will the authors or contributors be held liable for any damages
7 // arising from the use of this software.
9 // Permission is hereby granted to everyone, free of charge, to use, copy,
10 // modify, prepare derivative works of, publish, distribute, perform,
11 // sublicense, and/or sell copies of the Software, provided that the above
12 // copyright notice and disclaimer of warranty be included in all copies or
13 // substantial portions of this software.
15 // FIXME: escape C++ reserved words
19 #include <sys/types.h>
25 CPPBinding cppbinding;
27 CPPFile::CPPFile(UserNameSpace *NS, const char *dir) :
30 indent.indent_level = 0;
31 indent.align_spaces = 0;
32 do_extra_newline = true;
35 dirname.append(1, '/');
36 dirname.append(ns->name);
37 string headername(dirname);
38 headername.append(".h");
40 file.open(headername.c_str());
41 if (!file.is_open()) {
42 fprintf(stderr, "Could not create output file \"%s\": %s.\n",
43 headername.c_str(), strerror(errno));
48 if (mkdir(dirname.c_str(), 0777) < 0) {
49 fprintf(stderr, "Could not create output directory \"%s\": %s.\n",
50 dir, strerror(errno));
55 file << "// " << *ns->get_fq_name()->flatten(".")
56 << "\n// This is a C++ language binding generated by idlc.\n"
57 << "// Do not modify this file directly.\n\n";
59 fqname = ns->get_fq_name();
60 String *fqname_flat = ns->get_fq_name()->flatten("_IDLNS_");
61 file << "#ifndef IDL_HDR_" << *fqname_flat
62 << "\n#define IDL_HDR_" << *fqname_flat << "\n\n";
64 file << "#include <orb.h>\n";
66 first_traversal = ++traversal;
67 assert(first_traversal >= 0);
69 for (NameSpace::const_iterator i = ns->begin(); i != ns->end(); ++i) {
70 Symbol *sym = (*i).second;
71 UserNameSpace *uns = dynamic_cast<UserNameSpace *>(sym);
74 file << "#include \"" << **ns->name << '/' << **uns->name << ".h\"\n";
76 // Process namespaces first, to minimize duplicate definitions
77 // if this namespace depends on something declared in a sub
84 for (NameSpace::const_iterator i = ns->begin(); i != ns->end(); ++i) {
85 Symbol *sym = (*i).second;
86 UserNameSpace *uns = dynamic_cast<UserNameSpace *>(sym);
89 output_pass(sym, trav_nsdecl);
92 for (NameSpace::const_iterator i = ns->begin(); i != ns->end(); ++i) {
93 Symbol *sym = (*i).second;
94 UserNameSpace *uns = dynamic_cast<UserNameSpace *>(sym);
97 output_pass(sym, trav_full);
105 assert(indent.indent_level == 0);
108 void CPPFile::ifndef_in(Symbol *sym, const char *extra)
110 StrList *fqname = sym->get_fq_name();
111 String *fqname_flat = fqname->flatten("_IDLNS_");
113 assert(indent.indent_level == 0);
115 file << "\n#ifndef IDL_DUP_" << extra << *fqname_flat
116 << "\n#define IDL_DUP_" << extra << *fqname_flat << "\n";
119 void CPPFile::ifndef_out()
121 file << "\n#endif\n";
124 void CPPFile::ns_in(Symbol *sym, const char *extra)
126 // Only output user namespaces here; if we're defining a nested type,
127 // it will have been forward declared already, and thus the
128 // non-user-namespaces can be specified directly in the definition.
130 // For non-forward-declarables such as metadata, use all_ns_in.
132 StrList *ns_fqname = sym->find_toplevel_type()->get_ns()->get_fq_name();
134 ifndef_in(sym, extra);
136 for (StrList::const_iterator i = ns_fqname->begin();
137 i != ns_fqname->end(); ++i) {
138 const String *str = *i;
139 file << "namespace " << *str << " {\n";
145 void CPPFile::ns_out(Symbol *sym)
148 assert(indent.indent_level == 0);
150 for (Symbol *s = sym->find_toplevel_type()->get_ns(); s != toplevel;
157 void CPPFile::all_ns_in(Symbol *sym, bool include_self, const char *extra)
159 NameSpace *ns = sym->find_toplevel_type()->get_ns();
160 StrList *ns_fqname = ns->get_fq_name();
162 ifndef_in(sym, extra);
164 for (StrList::const_iterator i = ns_fqname->begin();
165 i != ns_fqname->end(); ++i) {
166 const String *str = *i;
167 file << "namespace " << *str << " {\n";
170 stack<SymbolRef> typens;
175 for (Symbol *s = sym; s != ns; s = s->get_ns())
178 while (!typens.empty()) {
179 Symbol *s = typens.top();
181 file << "namespace " << **s->name << "_ns {\n";
187 void CPPFile::all_ns_out(Symbol *sym, bool include_self)
190 assert(indent.indent_level == 0);
195 for (Symbol *s = sym; s != toplevel; s = s->get_ns())
201 String &CPPFile::get_definition_name(Symbol *sym, const char *prefix)
203 NameSpace *ns = sym->get_ns();
204 UserNameSpace *uns = dynamic_cast<UserNameSpace *>(ns);
208 str = &get_definition_name(ns);
209 str->append("_ns::");
215 str->append(**sym->name);
219 void cpp_output_name(ostream &file, Symbol *sym, const char *prefix)
221 StrList *sl = sym->get_fq_name("_ns");
224 file << "::" << *sl->flatten("::") << "::" << prefix << **sym->name;
227 void CPPFile::output(UserNameSpace *sym, int pass, void *arg2)
229 assert(indent.indent_level == 0);
230 delete new CPPFile(sym, dirname.c_str());
233 static inline int round_up_bits(int bits)
235 assert(bits >= 1 && bits <= 64);
247 // FIXME: Inline arrays...
248 void cpp_output_type(ostream &file, Type *t, bool array, bool is_mutable)
251 file << "::System::RunTime::";
259 cpp_output_name(file, t);
267 // FIXME: Inline arrays...
268 void cpp_output_type(ostream &file, CompiledBasicType &t, bool is_mutable)
271 file << "::System::RunTime::";
279 if (t.flags.field.Bool) {
280 // Don't rely on C++ to provide any particular representation
283 } else if (t.flags.field.Float) {
289 if (t.flags.field.Unsigned)
292 file << "int" << round_up_bits(t.bits) << "_t";
301 // FIXME: implement padding
302 int CPPFile::output_datum(Struct *ns, Datum *d, int offset)
305 cpp_output_type(file, d->type, is_array(d->def.basictype),
306 !d->def.flags.field.Immutable);
308 Struct *dtype = dynamic_cast<Struct *>(*d->type);
309 if (dtype && !dtype->is_inline())
312 cpp_output_type(file, d->def.basictype,
313 !d->def.flags.field.Immutable);
319 void CPPFile::declare_type_dependency(Type *t, bool need_obj_def)
321 Symbol *toplevel_type = t->find_toplevel_type();
323 assert(indent.indent_level == 0);
325 output_pass(toplevel_type, trav_nsdecl);
327 if (t == toplevel_type)
328 output_pass(t, trav_forward);
330 if (dynamic_cast<Interface *>(t))
331 output_pass(t, need_obj_def ? trav_obj_def : trav_obj_stub);
332 else if (!dynamic_cast<Struct *>(t) || need_obj_def)
333 output_pass(t, trav_full);
336 void CPPFile::declare_dependencies(Interface *iface, bool need_obj_def)
338 for (Interface::methods_iterator i = iface->methods_begin();
339 i != iface->methods_end(); ++i)
342 for (Method::entries_iterator j = m->entries_begin();
343 j != m->entries_end(); ++j)
347 declare_type_dependency(p->type, need_obj_def);
351 for (Interface::supers_iterator i = iface->supers_begin();
352 i != iface->supers_end(); ++i)
354 Interface *super = *i;
355 declare_type_dependency(super);
359 void CPPFile::declare_dependencies(Struct *str)
361 for (NameSpace::const_iterator i = str->begin(); i != str->end(); ++i) {
362 Symbol *sym = (*i).second;
363 Datum *d = dynamic_cast<Datum *>(sym);
366 declare_type_dependency(d->type, d->is_inline());
371 Struct *mstr = dynamic_cast<Struct *>(sym);
373 declare_dependencies(mstr);
377 Interface *miface = dynamic_cast<Interface *>(sym);
379 declare_dependencies(miface);
383 void CPPFile::output_guid(const uint64_t *guid64)
385 const unsigned char *guid = reinterpret_cast<const unsigned char *>(guid64);
388 file << indent << "static const __attribute__((unused))\n"
389 << indent << "::System::RunTime::GUID _guid = {\n"
392 for (int i = 0; i < 16; i++) {
394 file << '\n' << indent << "\t ";
396 sprintf(guidhex, "0x%02x, ", *guid++);
403 do_extra_newline = true;
406 void CPPFile::output_nsdecl(NameSpace *ns, nsdecl_callback cb)
408 // If indent level is not zero, this is a nested struct or interface.
409 if (indent.indent_level == 0)
414 file << indent << "namespace " << **ns->name << "_ns {\n";
420 for (NameSpace::const_iterator i = ns->begin(); i != ns->end(); ++i) {
421 Symbol *sym = (*i).second;
423 assert(pass_needed(sym, trav_forward));
424 assert(pass_needed(sym, trav_nsdecl));
426 // If it's a Method or a non-const Datum, this is a no-op.
427 output_pass(sym, trav_forward);
428 output_pass(sym, trav_nsdecl);
433 file << indent << "}\n";
435 if (indent.indent_level == 1)
439 void CPPFile::output_aliases_and_types(NameSpace *ns)
441 for (NameSpace::const_iterator i = ns->begin(); i != ns->end(); ++i) {
442 Symbol *sym = (*i).second;
443 if (dynamic_cast<Alias *>(sym) || dynamic_cast<Type *>(sym))
444 output_pass(sym, trav_full);
448 void CPPFile::output_vstruct_ns(CPPFile *cpp, NameSpace *sym)
450 Struct *str = dynamic_cast<Struct *>(sym);
452 assert(str->is_virtual());
454 cpp->output_guid(str->def.guid);
457 void CPPFile::output_vstruct_info(Struct *sym)
459 all_ns_in(sym, true, "VINFO_");
461 file << indent << "static const __attribute__((unused)) "
462 "unsigned long *const _guids[] = {\n";
464 stack<StructRef> supers;
467 for (Struct *i = sym; i; i = i->get_super()) {
472 for (int i = 0; i < sym->chainlen; i++) {
473 Struct *super = supers.top();
476 file << indent << '\t';
477 cpp_output_name(file, super);
478 file << "_ns::_guid.l,\n";
481 file << indent << "};\n\n"
482 << indent << "static const __attribute__((unused)) "
483 "::System::RunTime::VStructInfo _info = {\n"
484 << indent << "\t_guids, " << sym->chainlen << '\n'
488 all_ns_out(sym, true);
491 void CPPFile::output_vstruct_main(Struct *sym)
493 assert(sym->is_virtual());
494 Struct *super = sym->get_super();
496 const char *name = sym->name->c_str();
499 assert(sym == System_VStruct);
500 file << indent << "const ::System::RunTime::VStructInfo "
501 "*const _infoptr;\n\n";
504 file << indent << name
505 << "(const ::System::RunTime::VStructInfo *realinfo = &"
506 << name << "_ns::_info) :\n"
512 cpp_output_name(file, super);
514 file << "(realinfo)\n"
520 << indent << "static " << name << " *downcast(::System::VStruct *base)\n"
522 << indent << "\tif (!base)\n"
523 << indent << "\t\treturn NULL;\n\n"
524 << indent << "\tconst ::System::RunTime::VStructInfo *info = base->_infoptr;\n\n"
525 << indent << "\tif (info->chainlen < " << sym->chainlen << ")\n"
526 << indent << "\t\treturn NULL;\n\n"
527 << indent << "\tif (::System::RunTime::guids_equal(info->guids["
528 << sym->chainlen - 1 << "], " << name << "_ns::_guid.l))\n"
529 << indent << "\t\treturn static_cast<" << name << " *>(base);\n\n"
530 << indent << "\treturn NULL;\n"
533 do_extra_newline = true;
536 // Output an init method that initializes all the elements in the
537 // struct; this is useful for throwing exceptions. Due to the
538 // annoying, apparently unwaiveable-by-the-struct requirement that any
539 // struct with a ctor be initialized using the ctor (and thus at
540 // runtime, not statically), this can't be an actual ctor in
541 // non-virtual structs.
543 // In virtual structs, there's already a ctor, so it wouldn't
544 // matter. It'd generally be best to be consistent and use the
545 // init method for both, but the main intended use for this is
546 // throwing exceptions (which are virtual), and it'd be
547 // unfortunate to cripple 99% of the uses with unnecessary
548 // syntactic cruft. The init method will remain available
549 // for vstructs so that things won't break if a non-vstruct
550 // gets made virtual (or if a user really wants to be consistent
551 // between both types in their own code).
553 void CPPFile::output_struct_ctor(Struct *sym, bool extra_vstruct)
555 const char *method_name = extra_vstruct ? sym->name->c_str() : " _init";
557 file << '\n' << indent << **sym->name;
558 indent.align_spaces = sym->name->length() + 1;
560 if (!extra_vstruct) {
562 indent.align_spaces += 7;
566 output_struct_ctor_rec1(sym, 0);
569 Struct *super = sym->get_super();
571 file << ",\n" << indent
572 << "const ::System::RunTime::VStructInfo *_realinfo = &"
573 << **sym->name << "_ns::_info) :\n";
575 indent.align_spaces = 0;
581 cpp_output_name(file, super);
583 file << "(_realinfo";
586 indent.align_spaces = 0;
587 file << ")\n" << indent << "{\n";
589 indent.indent_level++;
591 output_struct_ctor_rec2(sym, 0);
594 file << indent << "return *this;\n";
596 indent.indent_level--;
597 file << indent << "}\n";
600 int CPPFile::output_struct_ctor_rec1(Struct *sym, int num)
602 if (sym->get_super())
603 num = output_struct_ctor_rec1(sym->get_super(), num);
605 for (Struct::entries_iterator i = sym->entries_begin();
606 i != sym->entries_end(); ++i)
609 file << ",\n" << indent;
611 output_datum(sym, *i, -1);
612 file << "_arg" << num;
618 int CPPFile::output_struct_ctor_rec2(Struct *sym, int num)
620 if (sym->get_super())
621 num = output_struct_ctor_rec2(sym->get_super(), num);
623 for (Struct::entries_iterator i = sym->entries_begin();
624 i != sym->entries_end(); ++i)
627 file << indent << **d->name << " = _arg" << ++num << ";\n";
633 void CPPFile::output(Struct *sym, int pass, void *arg2)
637 if (sym->is_virtual()) {
638 output_nsdecl(sym, output_vstruct_ns);
646 bool nested = indent.indent_level != 0;
653 file << indent << "struct " << **sym->name << ";\n";
662 output_pass(sym, trav_nsdecl);
663 Struct *super = sym->get_super();
666 output_pass(super, trav_full);
668 if (sym->is_virtual())
669 output_vstruct_info(sym);
671 declare_dependencies(sym);
674 file << indent << "struct " << get_definition_name(sym);
677 const String *supername = super->get_fq_name("_ns")
679 file << " :\n" << indent << "public ::" << *supername;
682 file << "\n" << indent << "{\n";
685 if (sym->is_virtual())
686 output_vstruct_main(sym);
689 for (Struct::entries_iterator i = sym->entries_begin();
690 i != sym->entries_end(); ++i)
695 offset = output_datum(sym, d, offset);
696 file << **d->name << ";\n";
699 bool empty_struct = true;
700 for (Struct *s = sym; s; s = s->get_super()) {
701 if (s->entries_begin() != s->entries_end()) {
702 empty_struct = false;
708 output_struct_ctor(sym, false);
710 if (sym->is_virtual())
711 output_struct_ctor(sym, true);
715 file << indent << "};\n";
719 output_aliases_and_types(sym);
721 for (NameSpace::const_iterator i = sym->begin(); i != sym->end(); ++i) {
722 Symbol *sym2 = (*i).second;
723 output_pass(sym2, trav_full);
734 void CPPFile::output_iface_ns(CPPFile *file, NameSpace *sym)
736 Interface *i = dynamic_cast<Interface *>(sym);
739 file->output_guid(i->def.guid);
740 file->output_ifaceinfo(i);
743 void CPPFile::output(Interface *sym, int pass, void *arg2)
747 output_nsdecl(sym, output_iface_ns);
751 bool nested = indent.indent_level != 0;
758 file << indent << "struct " << **sym->name << ";\n"
759 << indent << "struct _i_" << **sym->name << ";\n";
767 case trav_obj_stub: {
768 output_pass(sym, trav_forward);
770 for (Interface::supers_iterator i = sym->supers_begin();
771 i != sym->supers_end(); ++i)
773 Interface *super = *i;
774 output_pass(super, trav_obj_stub);
777 declare_dependencies(sym);
780 file << indent << "struct "
781 << get_definition_name(sym) << " {\n";
788 file << indent << "};\n";
795 output_pass(sym, trav_obj_stub);
797 for (Interface::supers_iterator i = sym->supers_begin();
798 i != sym->supers_end(); ++i)
800 Interface *super = *i;
801 output_pass(super, trav_full);
804 declare_dependencies(sym);
805 ns_in(sym, "OBJDEF_");
807 file << indent << "struct ";
808 file << get_definition_name(sym, "_i_") << " {\n";
812 output_internal(sym);
815 file << indent << "};\n\n";
823 output_pass(sym, trav_obj_def);
825 declare_dependencies(sym, true);
828 output_method_defs(sym);
831 output_aliases_and_types(sym);
833 for (NameSpace::const_iterator i = sym->begin(); i != sym->end(); ++i) {
834 Symbol *sym2 = (*i).second;
835 output_pass(sym2, trav_full);
846 void CPPFile::output_bf_elem(Datum *d, int pos, int bits,
850 BitField *bf = dynamic_cast<BitField *>(t);
851 Enum *en = dynamic_cast<Enum *>(t);
855 if (!d->name->compare(0, 4, "get_") ||
856 !d->name->compare(0, 4, "set_"))
859 fieldname.append(**d->name);
862 string newprefix(prefix);
863 newprefix.append(**d->name);
864 newprefix.append("_IDLNS_");
865 output_bf(bf, d->def.icon, bits, newprefix);
867 // FIXME: getters and setters
868 } else if (en || !t) {
869 file << indent << "uint" << bits << "_t "
870 << prefix << fieldname << ':' << d->def.icon << ";\n";
872 // This is checked here rather than in input.cc, because
875 fprintf(stderr, "idlc: Bad input: \"%s\" cannot be the type of \"%s\"\n",
876 t->get_fq_name()->flatten()->c_str(),
877 d->get_fq_name()->flatten()->c_str());
883 void CPPFile::output_bf(BitField *sym, int bits, int typebits,
888 assert(bits == sym->def.bits || bits == typebits);
890 for (BitField::entries_iterator i = sym->entries_begin();
891 i != sym->entries_end(); ++i)
892 size += (*i)->def.icon;
894 if (size > sym->def.bits) {
895 // FIXME: This isn't detected in the front end,
896 // but even once it is, this should stay as a
897 // replacement for input.cc checking.
899 fprintf(stderr, "idlc: \"%s\" is too small (%d bits) for its "
900 "contents (%d bits)\n",
901 sym->get_fq_name()->flatten()->c_str(),
902 sym->def.bits, size);
907 if (target->bitfield_big_endian) {
909 // The prefix is put at the end, so that we can avoid
910 // consecutive underscores or an underscore followed
911 // by a capital, both of which are reserved in C++.
913 file << indent << "uint" << bits << "_t _pad_" << prefix
914 << ':' << bits - size << ";\n";
917 int pos = sym->def.bits;
919 for (BitField::entries_reverse_iterator i = sym->entries_rbegin();
920 i != sym->entries_rend(); ++i)
924 output_bf_elem(d, pos, typebits, prefix);
929 for (BitField::entries_iterator i = sym->entries_begin();
930 i != sym->entries_end(); ++i)
933 output_bf_elem(d, pos, typebits, prefix);
939 void CPPFile::output(BitField *sym, int pass, void *arg2)
948 file << indent << "union " << **sym->name << ";\n";
952 int bits = round_up_bits(sym->def.bits);
955 file << indent << "union ";
956 file << get_definition_name(sym) << " {\n";
959 file << indent << "struct {\n";
963 output_bf(sym, bits, bits, nullprefix);
966 file << indent << "};\n\n"
967 << indent << "uint" << bits << "_t _raw;\n\n"
968 << indent << **sym->name << "()\n"
970 << indent << "\t_raw = 0;\n"
972 << indent << **sym->name << "(uint" << bits << "_t _init)\n"
974 << indent << "\t_raw = _init;\n"
976 << indent << "operator uint" << bits << "_t()\n"
978 << indent << "\treturn _raw;\n"
982 file << indent << "};\n";
985 output_aliases_and_types(sym);
995 void CPPFile::output(Enum *sym, int pass, void *arg2)
1002 case trav_forward: {
1003 bool do_ns_out = false;
1005 if (indent.indent_level == 0) {
1012 file << indent << "struct " << **sym->name << " {\n";
1015 for (Enum::entries_iterator i = sym->entries_begin();
1016 i != sym->entries_end(); ++i)
1020 file << indent << "static const uint"
1021 << round_up_bits(sym->def.bits) << "_t "
1022 << **d->name << " = " << d->def.ucon << ";\n";
1025 file << '\n' << indent << "unsigned int _val;\n\n";
1027 file << indent << **sym->name << "()\n"
1029 << indent << "\t_val = 0;\n"
1030 << indent << "}\n\n";
1032 file << indent << **sym->name << "(unsigned int val)\n"
1034 << indent << "\t_val = val;\n"
1035 << indent << "}\n\n";
1037 file << indent << "operator unsigned int()\n"
1039 << indent << "\treturn _val;\n"
1040 << indent << "}\n\n";
1043 file << indent << "};\n";
1052 // Nothing particular to do here, other than to make sure
1053 // that trav_forward has happened (which will always need to
1054 // be done here if it's not a nested type).
1056 output_pass(sym, trav_forward);
1064 void CPPFile::output(BasicType *sym, int pass, void *arg2)
1071 case trav_forward: {
1072 bool do_ns_out = false;
1074 if (indent.indent_level == 0) {
1081 file << indent << "typedef ";
1082 assert(!is_array(sym->def));
1083 cpp_output_type(file, sym->def, false);
1084 file << **sym->name << ";\n";
1093 output_pass(sym, trav_forward);
1101 void CPPFile::output(Alias *sym, int pass, void *arg2)
1108 case trav_forward: {
1109 bool do_ns_out = false;
1111 if (indent.indent_level == 0) {
1118 const String *type = sym->get_concrete_sym()->get_fq_name("_ns")
1121 file << indent << "typedef " << *type << " "
1122 << **sym->name << ";\n";
1131 output_pass(sym, trav_forward);
1139 void CPPFile::output(TypeDef *sym, int pass, void *arg2)
1148 output_pass(sym->get_concrete_sym(), trav_forward);
1150 bool do_ns_out = false;
1152 if (indent.indent_level == 0) {
1159 const String *type = sym->get_concrete_sym()->get_fq_name("_ns")
1162 file << indent << "typedef " << *type << " "
1163 << **sym->name << ";\n";
1176 void CPPFile::output(Datum *sym, int pass, void *arg2)
1178 assert(sym->def.flags.field.Const);
1188 declare_type_dependency(sym->type, false);
1190 bool do_ns_out = false;
1192 if (indent.indent_level == 0) {
1199 file << indent << "static const ";
1201 assert(!is_array(sym->def.basictype));
1204 cpp_output_type(file, sym->type, false, false);
1206 cpp_output_type(file, sym->def.basictype, false);
1208 file << **sym->name << " = ";
1210 CompiledBasicType *def;
1212 Symbol *real_type = sym->type->get_concrete_sym();
1213 BasicType *bt = dynamic_cast<BasicType *>(real_type);
1218 def = &sym->def.basictype;
1221 if (def->flags.field.Float) {
1222 file << sym->def.fcon;
1223 } else if (def->flags.field.Bool) {
1224 if (sym->def.ucon == 0)
1229 if (def->flags.field.Unsigned) {
1230 file << "0x" << std::hex << sym->def.ucon << std::dec << 'U';
1232 file << sym->def.icon;
1251 void CPPBinding::output_root(UserNameSpace *ns, const char *dir)
1253 delete new CPPFile(ns, dir);