summaryrefslogtreecommitdiff
path: root/cpp/src/Slice/RubyUtil.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/src/Slice/RubyUtil.cpp')
-rw-r--r--cpp/src/Slice/RubyUtil.cpp1733
1 files changed, 1733 insertions, 0 deletions
diff --git a/cpp/src/Slice/RubyUtil.cpp b/cpp/src/Slice/RubyUtil.cpp
new file mode 100644
index 00000000000..22a8270f04f
--- /dev/null
+++ b/cpp/src/Slice/RubyUtil.cpp
@@ -0,0 +1,1733 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2006 ZeroC, Inc. All rights reserved.
+//
+// This copy of Ice is licensed to you under the terms described in the
+// ICE_LICENSE file included in this distribution.
+//
+// **********************************************************************
+
+#include <Slice/RubyUtil.h>
+#include <Slice/Checksum.h>
+#include <IceUtil/Functional.h>
+
+using namespace std;
+using namespace Slice;
+using namespace IceUtil;
+
+namespace Slice
+{
+namespace Ruby
+{
+
+//
+// CodeVisitor generates the Ruby mapping for a translation unit.
+//
+class CodeVisitor : public ParserVisitor
+{
+public:
+
+ CodeVisitor(IceUtil::Output&);
+
+ virtual bool visitModuleStart(const ModulePtr&);
+ virtual void visitModuleEnd(const ModulePtr&);
+ virtual void visitClassDecl(const ClassDeclPtr&);
+ virtual bool visitClassDefStart(const ClassDefPtr&);
+ virtual bool visitExceptionStart(const ExceptionPtr&);
+ virtual bool visitStructStart(const StructPtr&);
+ virtual void visitSequence(const SequencePtr&);
+ virtual void visitDictionary(const DictionaryPtr&);
+ virtual void visitEnum(const EnumPtr&);
+ virtual void visitConst(const ConstPtr&);
+
+private:
+
+ //
+ // Return a Python symbol for the given parser element.
+ //
+ string getSymbol(const ContainedPtr&);
+
+ //
+ // Emit Python code to assign the given symbol in the current module.
+ //
+ void registerName(const string&);
+
+ //
+ // Emit the array that describes a Slice type.
+ //
+ void writeType(const TypePtr&);
+
+ //
+ // Get a default value for a given type.
+ //
+ string getDefaultValue(const TypePtr&);
+
+ //
+ // Add a value to a hash code.
+ //
+ void writeHash(const string&, const TypePtr&, int&);
+
+ struct MemberInfo
+ {
+ string fixedName;
+ TypePtr type;
+ bool inherited;
+ };
+ typedef list<MemberInfo> MemberInfoList;
+
+ void collectClassMembers(const ClassDefPtr&, MemberInfoList&, bool);
+ void collectExceptionMembers(const ExceptionPtr&, MemberInfoList&, bool);
+
+ Output& _out;
+ set<string> _classHistory;
+};
+
+}
+}
+
+static string
+lookupKwd(const string& name)
+{
+ //
+ // Keyword list. *Must* be kept in alphabetical order.
+ //
+ // This list only contains keywords that might conflict with a Slice
+ // identifier, so keywords like "defined?" are not necessary.
+ //
+ // This list also contains the names of methods on Object that might
+ // conflict with a Slice identifier, so names such as "inspect" and
+ // "send" are included but "to_s" is not.
+ //
+ static const string keywordList[] =
+ {
+ "BEGIN", "END", "alias", "and", "begin", "break", "case", "class", "clone", "def", "display", "do", "dup",
+ "else", "elsif", "end", "ensure", "extend", "false", "for", "freeze", "hash", "if", "in", "inspect", "method",
+ "methods", "module", "next", "new", "nil", "not", "or", "redo", "rescue", "retry", "return", "self", "send",
+ "super", "taint", "then", "true", "undef", "unless", "untaint", "until", "when", "while", "yield"
+ };
+ bool found = binary_search(&keywordList[0],
+ &keywordList[sizeof(keywordList) / sizeof(*keywordList)],
+ name);
+ return found ? "_" + name : name;
+}
+
+//
+// Split a scoped name into its components and return the components as a list of (unscoped) identifiers.
+//
+static vector<string>
+splitScopedName(const string& scoped)
+{
+ assert(scoped[0] == ':');
+ vector<string> ids;
+ string::size_type next = 0;
+ string::size_type pos;
+ while((pos = scoped.find("::", next)) != string::npos)
+ {
+ pos += 2;
+ if(pos != scoped.size())
+ {
+ string::size_type endpos = scoped.find("::", pos);
+ if(endpos != string::npos)
+ {
+ ids.push_back(scoped.substr(pos, endpos - pos));
+ }
+ }
+ next = pos;
+ }
+ if(next != scoped.size())
+ {
+ ids.push_back(scoped.substr(next));
+ }
+ else
+ {
+ ids.push_back("");
+ }
+
+ return ids;
+}
+
+//
+// CodeVisitor implementation.
+//
+Slice::Ruby::CodeVisitor::CodeVisitor(Output& out) :
+ _out(out)
+{
+}
+
+bool
+Slice::Ruby::CodeVisitor::visitModuleStart(const ModulePtr& p)
+{
+ _out << sp << nl << "module " << fixIdent(p->name(), true);
+ _out.inc();
+ return true;
+}
+
+void
+Slice::Ruby::CodeVisitor::visitModuleEnd(const ModulePtr& p)
+{
+ _out.dec();
+ _out << nl << "end";
+}
+
+void
+Slice::Ruby::CodeVisitor::visitClassDecl(const ClassDeclPtr& p)
+{
+ //
+ // Emit forward declarations.
+ //
+ string scoped = p->scoped();
+ if(_classHistory.count(scoped) == 0)
+ {
+ string name = "T_" + fixIdent(p->name(), true);
+ _out << sp << nl << "if not defined?(" << name << ')';
+ _out.inc();
+ _out << nl << name << " = ::Ice::__declareClass('" << scoped << "')";
+ if(!p->isLocal())
+ {
+ _out << nl << name << "Prx = ::Ice::__declareProxy('" << scoped << "')";
+ }
+ _out.dec();
+ _out << nl << "end";
+ _classHistory.insert(scoped); // Avoid redundant declarations.
+ }
+}
+
+bool
+Slice::Ruby::CodeVisitor::visitClassDefStart(const ClassDefPtr& p)
+{
+ string scoped = p->scoped();
+ string name = fixIdent(p->name(), true);
+ ClassList bases = p->bases();
+ ClassDefPtr base;
+ OperationList ops = p->operations();
+ OperationList::iterator oli;
+
+ //
+ // Define a mix-in module for the class.
+ //
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true) << "_mixin)";
+ _out.inc();
+ _out << nl << "module " << name << "_mixin";
+ _out.inc();
+
+ if(!p->isLocal())
+ {
+ if(!bases.empty() && !bases.front()->isInterface())
+ {
+ base = bases.front();
+ _out << nl << "include " << getAbsolute(bases.front(), true) << "_mixin";
+ }
+ else
+ {
+ _out << nl << "include ::Ice::Object_mixin";
+ }
+
+ //
+ // ice_ids
+ //
+ ClassList allBases = p->allBases();
+ StringList ids;
+#if defined(__IBMCPP__) && defined(NDEBUG)
+//
+// VisualAge C++ 6.0 does not see that ClassDef is a Contained,
+// when inlining is on. The code below issues a warning: better
+// than an error!
+//
+ transform(allBases.begin(), allBases.end(), back_inserter(ids),
+ IceUtil::constMemFun<string,ClassDef>(&Contained::scoped));
+#else
+ transform(allBases.begin(), allBases.end(), back_inserter(ids), IceUtil::constMemFun(&Contained::scoped));
+#endif
+ StringList other;
+ other.push_back(scoped);
+ other.push_back("::Ice::Object");
+ other.sort();
+ ids.merge(other);
+ ids.unique();
+ _out << sp << nl << "def ice_ids(current=nil)";
+ _out.inc();
+ _out << nl << "[";
+ for(StringList::iterator q = ids.begin(); q != ids.end(); ++q)
+ {
+ if(q != ids.begin())
+ {
+ _out << ", ";
+ }
+ _out << "'" << *q << "'";
+ }
+ _out << ']';
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // ice_id
+ //
+ _out << sp << nl << "def ice_id(current=nil)";
+ _out.inc();
+ _out << nl << "'" << scoped << "'";
+ _out.dec();
+ _out << nl << "end";
+ }
+
+ if(!ops.empty())
+ {
+ //
+ // Emit a comment for each operation.
+ //
+ _out << sp
+ << nl << "#"
+ << nl << "# Operation signatures."
+ << nl << "#";
+ for(oli = ops.begin(); oli != ops.end(); ++oli)
+ {
+ string fixedOpName = fixIdent((*oli)->name(), false);
+ if(!p->isLocal() && (p->hasMetaData("amd") || (*oli)->hasMetaData("amd")))
+ {
+ _out << nl << "# def " << fixedOpName << "_async(_cb";
+
+ ParamDeclList params = (*oli)->parameters();
+
+ for(ParamDeclList::iterator pli = params.begin(); pli != params.end(); ++pli)
+ {
+ if(!(*pli)->isOutParam())
+ {
+ _out << ", " << fixIdent((*pli)->name(), false);
+ }
+ }
+ if(!p->isLocal())
+ {
+ _out << ", current=nil";
+ }
+ _out << ")";
+ }
+ else
+ {
+ _out << nl << "# def " << fixedOpName << "(";
+
+ ParamDeclList params = (*oli)->parameters();
+
+ bool first = true;
+ for(ParamDeclList::iterator pli = params.begin(); pli != params.end(); ++pli)
+ {
+ if(!(*pli)->isOutParam())
+ {
+ if(first)
+ {
+ first = false;
+ }
+ else
+ {
+ _out << ", ";
+ }
+ _out << fixIdent((*pli)->name(), false);
+ }
+ }
+ if(!p->isLocal())
+ {
+ if(!first)
+ {
+ _out << ", ";
+ }
+ _out << "current=nil";
+ }
+ _out << ")";
+ }
+ }
+ }
+
+ //
+ // inspect
+ //
+ _out << sp << nl << "def inspect";
+ _out.inc();
+ _out << nl << "::Ice::__stringify(self, T_" << name << ")";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // read/write accessors for data members.
+ //
+ DataMemberList members = p->dataMembers();
+ if(!members.empty())
+ {
+ _out << sp << nl << "attr_accessor ";
+ for(DataMemberList::iterator q = members.begin(); q != members.end(); ++q)
+ {
+ if(q != members.begin())
+ {
+ _out << ", ";
+ }
+ _out << ":" << fixIdent((*q)->name(), false);
+ }
+ }
+
+ _out.dec();
+ _out << nl << "end"; // End of mix-in module for class.
+
+ if(!p->isInterface())
+ {
+ //
+ // Class.
+ //
+ _out << nl << "class " << name;
+ if(base)
+ {
+ _out << " < " << getAbsolute(base, true);
+ }
+ _out.inc();
+ _out << nl << "include " << name << "_mixin";
+
+ //
+ // initialize
+ //
+ MemberInfoList allMembers;
+ collectClassMembers(p, allMembers, false);
+ bool inheritsMembers = false;
+ if(!allMembers.empty())
+ {
+ _out << sp << nl << "def initialize";
+ _out << spar;
+ MemberInfoList::iterator q;
+ for(q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ ostringstream ostr;
+ ostr << q->fixedName << '=' << getDefaultValue(q->type);
+ _out << ostr.str();
+ if(q->inherited)
+ {
+ inheritsMembers = true;
+ }
+ }
+ _out << epar;
+ _out.inc();
+ if(inheritsMembers)
+ {
+ _out << nl << "super" << spar;
+ for(q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ if(q->inherited)
+ {
+ _out << q->fixedName;
+ }
+ }
+ _out << epar;
+ }
+ for(q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ if(!q->inherited)
+ {
+ _out << nl << '@' << q->fixedName << " = " << q->fixedName;
+ }
+ }
+ _out.dec();
+ _out << nl << "end";
+ }
+
+ _out.dec();
+ _out << nl << "end"; // End of class.
+ }
+
+ //
+ // Generate proxy support. This includes a mix-in module for the proxy's
+ // operations and a class for the proxy itself.
+ //
+ if(!p->isLocal())
+ {
+ _out << nl << "module " << name << "Prx_mixin";
+ _out.inc();
+ for(ClassList::iterator cli = bases.begin(); cli != bases.end(); ++cli)
+ {
+ _out << nl << "include " << getAbsolute(*cli, true) << "Prx_mixin";
+ }
+ for(oli = ops.begin(); oli != ops.end(); ++oli)
+ {
+ string fixedOpName = fixIdent((*oli)->name(), false);
+ if(fixedOpName == "checkedCast" || fixedOpName == "uncheckedCast")
+ {
+ fixedOpName.insert(0, "_");
+ }
+ TypePtr ret = (*oli)->returnType();
+ ParamDeclList paramList = (*oli)->parameters();
+ string inParams;
+
+ for(ParamDeclList::const_iterator q = paramList.begin(); q != paramList.end(); ++q)
+ {
+ if(!(*q)->isOutParam())
+ {
+ if(!inParams.empty())
+ {
+ inParams.append(", ");
+ }
+ inParams.append(fixIdent((*q)->name(), false));
+ }
+ }
+
+ _out << sp << nl << "def " << fixedOpName << "(";
+ if(!inParams.empty())
+ {
+ _out << inParams << ", ";
+ }
+ _out << "_ctx=nil)";
+ _out.inc();
+ _out << nl << name << "_mixin::OP_" << (*oli)->name() << ".invoke(self, [" << inParams;
+ _out << "], _ctx)";
+ _out.dec();
+ _out << nl << "end";
+
+ if(p->hasMetaData("ami") || (*oli)->hasMetaData("ami"))
+ {
+ _out << sp << nl << "def " << fixedOpName << "_async(_cb";
+ if(!inParams.empty())
+ {
+ _out << ", " << inParams;
+ }
+ _out << ", _ctx=nil)";
+ _out.inc();
+ _out << nl << name << "_mixin::OP_" << (*oli)->name() << ".invokeAsync(self, _cb, [" << inParams;
+ if(!inParams.empty() && inParams.find(',') == string::npos)
+ {
+ _out << ", ";
+ }
+ _out << "], _ctx)";
+ _out.dec();
+ _out << nl << "end";
+ }
+ }
+ _out.dec();
+ _out << nl << "end"; // End of mix-in module for proxy.
+
+ _out << nl << "class " << name << "Prx < ::Ice::ObjectPrx";
+ _out.inc();
+ _out << nl << "include " << name << "Prx_mixin";
+
+ _out << sp << nl << "def " << name << "Prx.checkedCast(proxy, facetOrCtx=nil, _ctx=nil)";
+ _out.inc();
+ _out << nl << "ice_checkedCast(proxy, '" << scoped << "', facetOrCtx, _ctx)";
+ _out.dec();
+ _out << nl << "end";
+
+ _out << sp << nl << "def " << name << "Prx.uncheckedCast(proxy, facet='')";
+ _out.inc();
+ _out << nl << "ice_uncheckedCast(proxy, facet)";
+ _out.dec();
+ _out << nl << "end";
+
+ _out.dec();
+ _out << nl << "end"; // End of proxy class.
+ }
+
+ //
+ // Emit type descriptions.
+ //
+ _out << sp << nl << "if not defined?(T_" << name << ')';
+ _out.inc();
+ _out << nl << "T_" << name << " = ::Ice::__declareClass('" << scoped << "')";
+ if(!p->isLocal())
+ {
+ _out << nl << "T_" << name << "Prx = ::Ice::__declareProxy('" << scoped << "')";
+ }
+ _out.dec();
+ _out << nl << "end";
+ _classHistory.insert(scoped); // Avoid redundant declarations.
+
+ _out << sp << nl << "T_" << name << ".defineClass(" << (p->isInterface() ? "nil" : name) << ", "
+ << (p->isAbstract() ? "true" : "false") << ", ";
+ if(!base)
+ {
+ _out << "nil";
+ }
+ else
+ {
+ _out << getAbsolute(base, true, "T_");
+ }
+ _out << ", [";
+ //
+ // Interfaces
+ //
+ // TODO: Necessary?
+ //
+ {
+ int interfaceCount = 0;
+ for(ClassList::const_iterator q = bases.begin(); q != bases.end(); ++q)
+ {
+ if((*q)->isInterface())
+ {
+ if(interfaceCount > 0)
+ {
+ _out << ", ";
+ }
+ _out << getAbsolute(*q, true, "T_");
+ ++interfaceCount;
+ }
+ }
+ }
+ //
+ // Members
+ //
+ // Data members are represented as an array:
+ //
+ // ['MemberName', MemberType]
+ //
+ // where MemberType is either a primitive type constant (T_INT, etc.) or the id of a constructed type.
+ //
+ _out << "], [";
+ if(members.size() > 1)
+ {
+ _out.inc();
+ _out << nl;
+ }
+ {
+ for(DataMemberList::iterator q = members.begin(); q != members.end(); ++q)
+ {
+ if(q != members.begin())
+ {
+ _out << ',' << nl;
+ }
+ _out << "['" << fixIdent((*q)->name(), false) << "', ";
+ writeType((*q)->type());
+ _out << ']';
+ }
+ }
+ if(members.size() > 1)
+ {
+ _out.dec();
+ _out << nl;
+ }
+ _out << "])";
+ _out << nl << name << "_mixin::ICE_TYPE = T_" << name;
+
+ //
+ // Define each operation. The arguments to __defineOperation are:
+ //
+ // 'opName', Mode, [InParams], [OutParams], ReturnType, [Exceptions]
+ //
+ // where InParams and OutParams are arrays of type descriptions, and Exceptions
+ // is an array of exception types.
+ //
+ if(!p->isLocal())
+ {
+ _out << sp << nl << "T_" << name << "Prx.defineProxy(" << name << "Prx, T_" << name << ')';
+ _out << nl << name << "Prx::ICE_TYPE = T_" << name << "Prx";
+
+ if(!ops.empty())
+ {
+ _out << sp;
+ }
+ for(OperationList::iterator s = ops.begin(); s != ops.end(); ++s)
+ {
+ ParamDeclList params = (*s)->parameters();
+ ParamDeclList::iterator t;
+ int count;
+
+ _out << nl << name << "_mixin::OP_" << (*s)->name() << " = ::Ice::__defineOperation('"
+ << (*s)->name() << "', ";
+ switch((*s)->mode())
+ {
+ case Operation::Normal:
+ _out << "::Ice::OperationMode.Normal";
+ break;
+ case Operation::Nonmutating:
+ _out << "::Ice::OperationMode.Nonmutating";
+ break;
+ case Operation::Idempotent:
+ _out << "::Ice::OperationMode.Idempotent";
+ break;
+ }
+ _out << ", " << ((p->hasMetaData("amd") || (*s)->hasMetaData("amd")) ? "true" : "false") << ", [";
+ for(t = params.begin(), count = 0; t != params.end(); ++t)
+ {
+ if(!(*t)->isOutParam())
+ {
+ if(count > 0)
+ {
+ _out << ", ";
+ }
+ writeType((*t)->type());
+ ++count;
+ }
+ }
+ _out << "], [";
+ for(t = params.begin(), count = 0; t != params.end(); ++t)
+ {
+ if((*t)->isOutParam())
+ {
+ if(count > 0)
+ {
+ _out << ", ";
+ }
+ writeType((*t)->type());
+ ++count;
+ }
+ }
+ _out << "], ";
+ TypePtr returnType = (*s)->returnType();
+ if(returnType)
+ {
+ writeType(returnType);
+ }
+ else
+ {
+ _out << "nil";
+ }
+ _out << ", [";
+ ExceptionList exceptions = (*s)->throws();
+ for(ExceptionList::iterator u = exceptions.begin(); u != exceptions.end(); ++u)
+ {
+ if(u != exceptions.begin())
+ {
+ _out << ", ";
+ }
+ _out << getAbsolute(*u, true, "T_");
+ }
+ _out << "])";
+
+ string deprecateMetadata;
+ if((*s)->findMetaData("deprecate", deprecateMetadata) || p->findMetaData("deprecate", deprecateMetadata))
+ {
+ string msg;
+ string::size_type pos = deprecateMetadata.find(':');
+ if(pos != string::npos && pos < deprecateMetadata.size() - 1)
+ {
+ msg = deprecateMetadata.substr(pos + 1);
+ }
+ _out << nl << name << "_mixin::OP_" << (*s)->name() << ".deprecate(\"" << msg << "\")";
+ }
+ }
+ }
+
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+
+ return false;
+}
+
+bool
+Slice::Ruby::CodeVisitor::visitExceptionStart(const ExceptionPtr& p)
+{
+ string scoped = p->scoped();
+ string name = fixIdent(p->name(), true);
+
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true) << ')';
+ _out.inc();
+ _out << nl << "class " << name << " < ";
+ ExceptionPtr base = p->base();
+ string baseName;
+ if(base)
+ {
+ baseName = getAbsolute(base, true);
+ _out << baseName;
+ }
+ else if(p->isLocal())
+ {
+ _out << "Ice::LocalException";
+ }
+ else
+ {
+ _out << "Ice::UserException";
+ }
+ _out.inc();
+
+ DataMemberList members = p->dataMembers();
+ DataMemberList::iterator dmli;
+
+ //
+ // initialize
+ //
+ _out << nl << "def initialize";
+ MemberInfoList allMembers;
+ collectExceptionMembers(p, allMembers, false);
+ bool inheritsMembers = false;
+ if(!allMembers.empty())
+ {
+ _out << spar;
+ for(MemberInfoList::iterator q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ ostringstream ostr;
+ ostr << q->fixedName << '=' << getDefaultValue(q->type);
+ _out << ostr.str();
+ if(q->inherited)
+ {
+ inheritsMembers = true;
+ }
+ }
+ _out << epar;
+ }
+ _out.inc();
+ if(!allMembers.empty())
+ {
+ if(inheritsMembers)
+ {
+ _out << nl << "super" << spar;
+ for(MemberInfoList::iterator q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ if(q->inherited)
+ {
+ _out << q->fixedName;
+ }
+ }
+ _out << epar;
+ }
+ for(MemberInfoList::iterator q = allMembers.begin(); q != allMembers.end(); ++q)
+ {
+ if(!q->inherited)
+ {
+ _out << nl << '@' << q->fixedName << '=' << q->fixedName;
+ }
+ }
+ }
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // to_s
+ //
+ _out << sp << nl << "def to_s";
+ _out.inc();
+ _out << nl << "'" << scoped.substr(2) << "'";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // inspect
+ //
+ _out << sp << nl << "def inspect";
+ _out.inc();
+ _out << nl << "return ::Ice::__stringifyException(self)";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // read/write accessors for data members.
+ //
+ if(!members.empty())
+ {
+ _out << sp << nl << "attr_accessor ";
+ for(dmli = members.begin(); dmli != members.end(); ++dmli)
+ {
+ if(dmli != members.begin())
+ {
+ _out << ", ";
+ }
+ _out << ':' << fixIdent((*dmli)->name(), false);;
+ }
+ }
+
+ _out.dec();
+ _out << nl << "end"; // End of class.
+
+ //
+ // Emit the type information.
+ //
+ _out << sp << nl << "T_" << name << " = ::Ice::__defineException('" << scoped << "', " << name << ", ";
+ if(!base)
+ {
+ _out << "nil";
+ }
+ else
+ {
+ _out << getAbsolute(base, true, "T_");
+ }
+ _out << ", [";
+ if(members.size() > 1)
+ {
+ _out.inc();
+ _out << nl;
+ }
+ //
+ // Data members are represented as an array:
+ //
+ // ['MemberName', MemberType]
+ //
+ // where MemberType is either a primitive type constant (T_INT, etc.) or the id of a constructed type.
+ //
+ for(dmli = members.begin(); dmli != members.end(); ++dmli)
+ {
+ if(dmli != members.begin())
+ {
+ _out << ',' << nl;
+ }
+ _out << "[\"" << fixIdent((*dmli)->name(), false) << "\", ";
+ writeType((*dmli)->type());
+ _out << ']';
+ }
+ if(members.size() > 1)
+ {
+ _out.dec();
+ _out << nl;
+ }
+ _out << "])";
+ _out << nl << name << "::ICE_TYPE = T_" << name;
+
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+
+ return false;
+}
+
+bool
+Slice::Ruby::CodeVisitor::visitStructStart(const StructPtr& p)
+{
+ string scoped = p->scoped();
+ string name = fixIdent(p->name(), true);
+ MemberInfoList memberList;
+ MemberInfoList::iterator r;
+
+ {
+ DataMemberList members = p->dataMembers();
+ for(DataMemberList::iterator q = members.begin(); q != members.end(); ++q)
+ {
+ memberList.push_back(MemberInfo());
+ memberList.back().fixedName = fixIdent((*q)->name(), false);
+ memberList.back().type = (*q)->type();
+ }
+ }
+
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true) << ')';
+ _out.inc();
+ _out << nl << "class " << name;
+ _out.inc();
+ if(!memberList.empty())
+ {
+ _out << nl << "def initialize(";
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ if(r != memberList.begin())
+ {
+ _out << ", ";
+ }
+ _out << r->fixedName << '=' << getDefaultValue(r->type);
+ }
+ _out << ")";
+ _out.inc();
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ _out << nl << '@' << r->fixedName << " = " << r->fixedName;
+ }
+ _out.dec();
+ _out << nl << "end";
+ }
+
+ //
+ // hash
+ //
+ _out << sp << nl << "def hash";
+ _out.inc();
+ _out << nl << "_h = 0";
+ int iter = 0;
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ writeHash("@" + r->fixedName, r->type, iter);
+ }
+ _out << nl << "_h % 0x7fffffff";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // ==
+ //
+ _out << sp << nl << "def ==(other)";
+ _out.inc();
+ _out << nl << "return false if";
+ _out.inc();
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ if(r != memberList.begin())
+ {
+ _out << " or";
+ }
+ _out << nl << "@" << r->fixedName << " != other." << r->fixedName;
+ }
+ _out.dec();
+ _out << nl << "true";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // inspect
+ //
+ _out << sp << nl << "def inspect";
+ _out.inc();
+ _out << nl << "::Ice::__stringify(self, T_" << name << ")";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // read/write accessors for data members.
+ //
+ if(!memberList.empty())
+ {
+ _out << sp << nl << "attr_accessor ";
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ if(r != memberList.begin())
+ {
+ _out << ", ";
+ }
+ _out << ':' << r->fixedName;
+ }
+ }
+
+ _out.dec();
+ _out << nl << "end"; // End of class.
+
+ //
+ // Emit the type information.
+ //
+ _out << sp << nl << "T_" << name << " = ::Ice::__defineStruct('" << scoped << "', " << name << ", [";
+ //
+ // Data members are represented as an array:
+ //
+ // ['MemberName', MemberType]
+ //
+ // where MemberType is either a primitive type constant (T_INT, etc.) or the id of a constructed type.
+ //
+ if(memberList.size() > 1)
+ {
+ _out.inc();
+ _out << nl;
+ }
+ for(r = memberList.begin(); r != memberList.end(); ++r)
+ {
+ if(r != memberList.begin())
+ {
+ _out << ',' << nl;
+ }
+ _out << "[\"" << r->fixedName << "\", ";
+ writeType(r->type);
+ _out << ']';
+ }
+ if(memberList.size() > 1)
+ {
+ _out.dec();
+ _out << nl;
+ }
+ _out << "])";
+
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+
+ return false;
+}
+
+void
+Slice::Ruby::CodeVisitor::visitSequence(const SequencePtr& p)
+{
+ //
+ // Emit the type information.
+ //
+ string name = fixIdent(p->name(), true);
+ string scoped = p->scoped();
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true, "T_") << ')';
+ _out.inc();
+ _out << nl << "T_" << name << " = ::Ice::__defineSequence('" << scoped << "', ";
+ writeType(p->type());
+ _out << ")";
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+}
+
+void
+Slice::Ruby::CodeVisitor::visitDictionary(const DictionaryPtr& p)
+{
+ //
+ // Emit the type information.
+ //
+ string name = fixIdent(p->name(), true);
+ string scoped = p->scoped();
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true, "T_") << ')';
+ _out.inc();
+ _out << nl << "T_" << name << " = ::Ice::__defineDictionary('" << scoped << "', ";
+ writeType(p->keyType());
+ _out << ", ";
+ writeType(p->valueType());
+ _out << ")";
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+}
+
+void
+Slice::Ruby::CodeVisitor::visitEnum(const EnumPtr& p)
+{
+ string scoped = p->scoped();
+ string name = fixIdent(p->name(), true);
+ EnumeratorList enums = p->getEnumerators();
+ EnumeratorList::iterator q;
+ int i;
+
+ _out << sp << nl << "if not defined?(" << getAbsolute(p, true) << ')';
+ _out.inc();
+ _out << nl << "class " << name;
+ _out.inc();
+ _out << nl << "include Comparable";
+ _out << sp << nl << "def initialize(val)";
+ _out.inc();
+ {
+ ostringstream assertion;
+ assertion << "fail(\"invalid value #{val} for " << name << "\") unless(val >= 0 and val < "
+ << enums.size() << ')';
+ _out << nl << assertion.str();
+ }
+ _out << nl << "@val = val";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // Accessor for each enumerator.
+ //
+ for(q = enums.begin(), i = 0; q != enums.end(); ++q, ++i)
+ {
+ ostringstream idx;
+ idx << i;
+ _out << sp << nl << "def " << name << "." << fixIdent((*q)->name(), false);
+ _out.inc();
+ _out << nl << "@@_values[" << idx.str() << "]";
+ _out.dec();
+ _out << nl << "end";
+ }
+
+ //
+ // from_int
+ //
+ {
+ _out << sp << nl << "def " << name << ".from_int(val)";
+ ostringstream sz;
+ sz << enums.size() - 1;
+ _out.inc();
+ _out << nl << "raise IndexError, \"#{val} is out of range 0.." << sz.str() << "\" if(val < 0 || val > "
+ << sz.str() << ')';
+ _out << nl << "@@_values[val]";
+ _out.dec();
+ _out << nl << "end";
+ }
+
+ //
+ // to_s
+ //
+ _out << sp << nl << "def to_s";
+ _out.inc();
+ _out << nl << "@@_names[@val]";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // to_i
+ //
+ _out << sp << nl << "def to_i";
+ _out.inc();
+ _out << nl << "@val";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // <=>
+ //
+ _out << sp << nl << "def <=>(other)";
+ _out.inc();
+ _out << nl << "other.is_a?(" << name << ") or raise ArgumentError, \"value must be a " << name << "\"";
+ _out << nl << "@val <=> other.to_i";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // hash
+ //
+ _out << sp << nl << "def hash";
+ _out.inc();
+ _out << nl << "@val.hash";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // inspect
+ //
+ _out << sp << nl << "def inspect";
+ _out.inc();
+ _out << nl << "@@_names[@val] + \"(#{@val})\"";
+ _out.dec();
+ _out << nl << "end";
+
+ //
+ // each
+ //
+ _out << sp << nl << "def " << name << ".each(&block)";
+ _out.inc();
+ _out << nl << "@@_values.each(&block)";
+ _out.dec();
+ _out << nl << "end";
+
+ _out << sp << nl << "@@_names = [";
+ for(q = enums.begin(); q != enums.end(); ++q)
+ {
+ if(q != enums.begin())
+ {
+ _out << ", ";
+ }
+ _out << "'" << (*q)->name() << "'";
+ }
+ _out << ']';
+
+ _out << nl << "@@_values = [";
+ for(EnumeratorList::size_type j = 0; j < enums.size(); ++j)
+ {
+ if(j > 0)
+ {
+ _out << ", ";
+ }
+ ostringstream idx;
+ idx << j;
+ _out << name << ".new(" << idx.str() << ')';
+ }
+ _out << ']';
+
+ _out << sp << nl << "private_class_method :new";
+
+ _out.dec();
+ _out << nl << "end"; // End of class.
+
+ //
+ // Emit the type information.
+ //
+ _out << sp << nl << "T_" << name << " = ::Ice::__defineEnum('" << scoped << "', " << name << ", [";
+ for(q = enums.begin(); q != enums.end(); ++q)
+ {
+ if(q != enums.begin())
+ {
+ _out << ", ";
+ }
+ _out << name << '.' << fixIdent((*q)->name(), false);
+ }
+ _out << "])";
+
+ _out.dec();
+ _out << nl << "end"; // if not defined?()
+}
+
+void
+Slice::Ruby::CodeVisitor::visitConst(const ConstPtr& p)
+{
+ Slice::TypePtr type = p->type();
+ string value = p->value();
+ string name = fixIdent(p->name(), true);
+
+ _out << sp << nl << name << " = ";
+
+ Slice::BuiltinPtr b = Slice::BuiltinPtr::dynamicCast(type);
+ Slice::EnumPtr en = Slice::EnumPtr::dynamicCast(type);
+ if(b)
+ {
+ switch(b->kind())
+ {
+ case Slice::Builtin::KindBool:
+ {
+ _out << value;
+ break;
+ }
+ case Slice::Builtin::KindByte:
+ case Slice::Builtin::KindShort:
+ case Slice::Builtin::KindInt:
+ case Slice::Builtin::KindFloat:
+ case Slice::Builtin::KindDouble:
+ {
+ _out << value;
+ break;
+ }
+ case Slice::Builtin::KindLong:
+ {
+ IceUtil::Int64 l;
+ IceUtil::stringToInt64(value, l);
+ _out << value;
+ break;
+ }
+
+ case Slice::Builtin::KindString:
+ {
+ //
+ // Expand strings into the basic source character set. We can't use isalpha() and the like
+ // here because they are sensitive to the current locale.
+ //
+ static const string basicSourceChars = "abcdefghijklmnopqrstuvwxyz"
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+ "0123456789"
+ "_{}[]#()<>%:;.?*+-/^&|~!=, '";
+ static const set<char> charSet(basicSourceChars.begin(), basicSourceChars.end());
+
+ _out << "\""; // Opening "
+
+ for(string::const_iterator c = value.begin(); c != value.end(); ++c)
+ {
+ switch(*c)
+ {
+ case '"':
+ {
+ _out << "\\\"";
+ break;
+ }
+ case '\\':
+ {
+ _out << "\\\\";
+ break;
+ }
+ case '\r':
+ {
+ _out << "\\r";
+ break;
+ }
+ case '\n':
+ {
+ _out << "\\n";
+ break;
+ }
+ case '\t':
+ {
+ _out << "\\t";
+ break;
+ }
+ case '\b':
+ {
+ _out << "\\b";
+ break;
+ }
+ case '\f':
+ {
+ _out << "\\f";
+ break;
+ }
+ default:
+ {
+ if(charSet.find(*c) == charSet.end())
+ {
+ unsigned char uc = *c; // Char may be signed, so make it positive.
+ stringstream s;
+ s << "\\"; // Print as octal if not in basic source character set.
+ s.flags(ios_base::oct);
+ s.width(3);
+ s.fill('0');
+ s << static_cast<unsigned>(uc);
+ _out << s.str();
+ }
+ else
+ {
+ _out << *c; // Print normally if in basic source character set.
+ }
+ break;
+ }
+ }
+ }
+
+ _out << "\""; // Closing "
+ break;
+ }
+
+ case Slice::Builtin::KindObject:
+ case Slice::Builtin::KindObjectProxy:
+ case Slice::Builtin::KindLocalObject:
+ assert(false);
+ }
+ }
+ else if(en)
+ {
+ _out << getAbsolute(en, true) << '.';
+ string::size_type colon = value.rfind(':');
+ if(colon != string::npos)
+ {
+ _out << fixIdent(value.substr(colon + 1), false);
+ }
+ else
+ {
+ _out << fixIdent(value, false);
+ }
+ }
+ else
+ {
+ assert(false); // Unknown const type.
+ }
+}
+
+void
+Slice::Ruby::CodeVisitor::writeType(const TypePtr& p)
+{
+ BuiltinPtr builtin = BuiltinPtr::dynamicCast(p);
+ if(builtin)
+ {
+ switch(builtin->kind())
+ {
+ case Builtin::KindBool:
+ {
+ _out << "::Ice::T_bool";
+ break;
+ }
+ case Builtin::KindByte:
+ {
+ _out << "::Ice::T_byte";
+ break;
+ }
+ case Builtin::KindShort:
+ {
+ _out << "::Ice::T_short";
+ break;
+ }
+ case Builtin::KindInt:
+ {
+ _out << "::Ice::T_int";
+ break;
+ }
+ case Builtin::KindLong:
+ {
+ _out << "::Ice::T_long";
+ break;
+ }
+ case Builtin::KindFloat:
+ {
+ _out << "::Ice::T_float";
+ break;
+ }
+ case Builtin::KindDouble:
+ {
+ _out << "::Ice::T_double";
+ break;
+ }
+ case Builtin::KindString:
+ {
+ _out << "::Ice::T_string";
+ break;
+ }
+ case Builtin::KindObject:
+ {
+ _out << "::Ice::T_Object";
+ break;
+ }
+ case Builtin::KindObjectProxy:
+ {
+ _out << "::Ice::T_ObjectPrx";
+ break;
+ }
+ case Builtin::KindLocalObject:
+ {
+ _out << "::Ice::T_LocalObject";
+ break;
+ }
+ }
+ return;
+ }
+
+ ProxyPtr prx = ProxyPtr::dynamicCast(p);
+ if(prx)
+ {
+ _out << getAbsolute(prx->_class(), true, "T_") << "Prx";
+ return;
+ }
+
+ ContainedPtr cont = ContainedPtr::dynamicCast(p);
+ assert(cont);
+ _out << getAbsolute(cont, true, "T_");
+}
+
+string
+Slice::Ruby::CodeVisitor::getDefaultValue(const TypePtr& p)
+{
+ BuiltinPtr builtin = BuiltinPtr::dynamicCast(p);
+ if(builtin)
+ {
+ switch(builtin->kind())
+ {
+ case Builtin::KindBool:
+ {
+ return "false";
+ }
+ case Builtin::KindByte:
+ case Builtin::KindShort:
+ case Builtin::KindInt:
+ case Builtin::KindLong:
+ {
+ return "0";
+ }
+ case Builtin::KindFloat:
+ case Builtin::KindDouble:
+ {
+ return "0.0";
+ }
+ case Builtin::KindString:
+ {
+ return "''";
+ }
+ case Builtin::KindObject:
+ case Builtin::KindObjectProxy:
+ case Builtin::KindLocalObject:
+ {
+ return "nil";
+ }
+ }
+ }
+
+ EnumPtr en = EnumPtr::dynamicCast(p);
+ if(en)
+ {
+ EnumeratorList enums = en->getEnumerators();
+ return getAbsolute(en, true) + "." + fixIdent(enums.front()->name(), false);
+ }
+
+ StructPtr st = StructPtr::dynamicCast(p);
+ if(st)
+ {
+ return getAbsolute(st, true) + ".new";
+ }
+
+ return "nil";
+}
+
+void
+Slice::Ruby::CodeVisitor::writeHash(const string& name, const TypePtr& p, int& iter)
+{
+ _out << nl << "_h = 5 * _h + " << name << ".hash";
+}
+
+void
+Slice::Ruby::CodeVisitor::collectClassMembers(const ClassDefPtr& p, MemberInfoList& allMembers, bool inherited)
+{
+ ClassList bases = p->bases();
+ if(!bases.empty() && !bases.front()->isInterface())
+ {
+ collectClassMembers(bases.front(), allMembers, true);
+ }
+
+ DataMemberList members = p->dataMembers();
+
+ for(DataMemberList::iterator q = members.begin(); q != members.end(); ++q)
+ {
+ MemberInfo m;
+ m.fixedName = fixIdent((*q)->name(), false);
+ m.type = (*q)->type();
+ m.inherited = inherited;
+ allMembers.push_back(m);
+ }
+}
+
+void
+Slice::Ruby::CodeVisitor::collectExceptionMembers(const ExceptionPtr& p, MemberInfoList& allMembers, bool inherited)
+{
+ ExceptionPtr base = p->base();
+ if(base)
+ {
+ collectExceptionMembers(base, allMembers, true);
+ }
+
+ DataMemberList members = p->dataMembers();
+
+ for(DataMemberList::iterator q = members.begin(); q != members.end(); ++q)
+ {
+ MemberInfo m;
+ m.fixedName = fixIdent((*q)->name(), false);
+ m.type = (*q)->type();
+ m.inherited = inherited;
+ allMembers.push_back(m);
+ }
+}
+
+static string
+normalizePath(const string& path)
+{
+ string result = path;
+ replace(result.begin(), result.end(), '\\', '/');
+ string::size_type pos;
+ while((pos = result.find("//")) != string::npos)
+ {
+ result.replace(pos, 2, "/");
+ }
+ return result;
+}
+
+static string
+changeInclude(const string& inc, const vector<string>& includePaths)
+{
+ string orig = normalizePath(inc);
+ string curr = orig; // The current shortest pathname.
+
+ //
+ // Compare the pathname of the included file against each of the include directories.
+ // If any of the include directories match the leading part of the included file,
+ // then select the include directory whose removal results in the shortest pathname.
+ //
+ for(vector<string>::const_iterator p = includePaths.begin(); p != includePaths.end(); ++p)
+ {
+ string includePath = *p;
+
+ if(orig.compare(0, p->size(), *p) == 0)
+ {
+ string s = orig.substr(p->size());
+ if(s.size() < curr.size())
+ {
+ curr = s;
+ }
+ }
+ }
+
+ string::size_type pos = curr.rfind('.');
+ if(pos != string::npos)
+ {
+ curr.erase(pos);
+ }
+
+ return curr;
+}
+
+void
+Slice::Ruby::generate(const UnitPtr& un, bool all, bool checksum, const vector<string>& includePaths, Output& out)
+{
+ out << nl << "require 'Ice'";
+
+ if(!all)
+ {
+ vector<string> paths = includePaths;
+ for(vector<string>::iterator p = paths.begin(); p != paths.end(); ++p)
+ {
+ if(p->size() && (*p)[p->size() - 1] != '/')
+ {
+ *p += '/';
+ }
+ *p = normalizePath(*p);
+ }
+
+ StringList includes = un->includeFiles();
+ for(StringList::const_iterator q = includes.begin(); q != includes.end(); ++q)
+ {
+ string file = changeInclude(*q, paths);
+ out << nl << "require '" << file << ".rb'";
+ }
+ }
+
+ CodeVisitor codeVisitor(out);
+ un->visit(&codeVisitor, false);
+
+ if(checksum)
+ {
+ ChecksumMap checksums = createChecksums(un);
+ if(!checksums.empty())
+ {
+ out << sp;
+ for(ChecksumMap::const_iterator p = checksums.begin(); p != checksums.end(); ++p)
+ {
+ out << nl << "::Ice::SliceChecksums[\"" << p->first << "\"] = \"";
+ ostringstream str;
+ str.flags(ios_base::hex);
+ str.fill('0');
+ for(vector<unsigned char>::const_iterator q = p->second.begin(); q != p->second.end(); ++q)
+ {
+ str << (int)(*q);
+ }
+ out << str.str() << "\"";
+ }
+ }
+ }
+
+ out << nl; // Trailing newline.
+}
+
+bool
+Slice::Ruby::splitString(const string& str, vector<string>& args, const string& delim)
+{
+ string::size_type beg;
+ string::size_type end = 0;
+ while(true)
+ {
+ beg = str.find_first_not_of(delim, end);
+ if(beg == string::npos)
+ {
+ break;
+ }
+
+ //
+ // Check for quoted argument.
+ //
+ char ch = str[beg];
+ if(ch == '"' || ch == '\'')
+ {
+ beg++;
+ end = str.find(ch, beg);
+ if(end == string::npos)
+ {
+ return false;
+ }
+ args.push_back(str.substr(beg, end - beg));
+ end++; // Skip end quote.
+ }
+ else
+ {
+ end = str.find_first_of(delim + "'\"", beg);
+ if(end == string::npos)
+ {
+ end = str.length();
+ }
+ args.push_back(str.substr(beg, end - beg));
+ }
+ }
+
+ return true;
+}
+
+string
+Slice::Ruby::fixIdent(const string& ident, bool checkUpperCase)
+{
+ if(ident[0] != ':')
+ {
+ string id = ident;
+ if(checkUpperCase)
+ {
+ // TODO: Is this the correct way to capitalize Slice identifiers?
+ if(id[0] >= 'a' && id[0] <= 'z')
+ {
+ id[0] += 'A' - 'a';
+ }
+ }
+ return lookupKwd(id);
+ }
+
+ vector<string> ids = splitScopedName(ident);
+ ostringstream result;
+ for(vector<string>::const_iterator i = ids.begin(); i != ids.end(); ++i)
+ {
+ string id = *i;
+ if(checkUpperCase)
+ {
+ // TODO: Is this the correct way to capitalize Slice identifiers?
+ if(id[0] >= 'a' && id[0] <= 'z')
+ {
+ id[0] += 'A' - 'a';
+ }
+ }
+ result << "::" << lookupKwd(id);
+ }
+ return result.str();
+}
+
+string
+Slice::Ruby::getAbsolute(const ContainedPtr& cont, bool checkUpperCase, const string& prefix)
+{
+ string scope = fixIdent(cont->scope(), checkUpperCase);
+
+ if(prefix.empty())
+ {
+ return scope + fixIdent(cont->name(), checkUpperCase);
+ }
+ else
+ {
+ return scope + prefix + fixIdent(cont->name(), checkUpperCase);
+ }
+}
+
+void
+Slice::Ruby::printHeader(IceUtil::Output& out)
+{
+ static const char* header =
+"# **********************************************************************\n"
+"#\n"
+"# Copyright (c) 2003-2006 ZeroC, Inc. All rights reserved.\n"
+"#\n"
+"# This copy of Ice is licensed to you under the terms described in the\n"
+"# ICE_LICENSE file included in this distribution.\n"
+"#\n"
+"# **********************************************************************\n"
+ ;
+
+ out << header;
+ out << "\n# Ice version " << ICE_STRING_VERSION;
+}
generated by cgit v1.2.3 (git 2.46.0) at 2025-08-04 15:42:51 +0000