Add Support for cpp:identifier Metadata, and the Groundwork for `xx…

…x:identifier` Metadata in General (#3292)

cpp/src/IceGrid/DescriptorBuilder.cpp

@@ -408,7 +408,7 @@ ApplicationDescriptorBuilder::isOverride(const string& name)
 
 ServerInstanceDescriptorBuilder::ServerInstanceDescriptorBuilder(const XmlAttributesHelper& attrs)
 {
-    _descriptor._cpp_template = attrs("template");
+    _descriptor.templateName = attrs("template");
     _descriptor.parameterValues = attrs.asMap();
     _descriptor.parameterValues.erase("template");
 }
@@ -724,7 +724,7 @@ CommunicatorDescriptorBuilder::addProperty(PropertyDescriptorSeq& properties, co
 
 ServiceInstanceDescriptorBuilder::ServiceInstanceDescriptorBuilder(const XmlAttributesHelper& attrs)
 {
-    _descriptor._cpp_template = attrs("template");
+    _descriptor.templateName = attrs("template");
     _descriptor.parameterValues = attrs.asMap();
     _descriptor.parameterValues.erase("template");
 }

cpp/src/IceGrid/DescriptorHelper.cpp

@@ -1729,7 +1729,7 @@ ServiceInstanceHelper::ServiceInstanceHelper(ServiceInstanceDescriptor desc, boo
     // descriptor must be set and contain the definition of the
     // service.
     //
-    if (_def._cpp_template.empty() && !_def.descriptor)
+    if (_def.templateName.empty() && !_def.descriptor)
     {
         throw DeploymentException("invalid service instance: no template defined");
     }
@@ -1743,13 +1743,13 @@ ServiceInstanceHelper::ServiceInstanceHelper(ServiceInstanceDescriptor desc, boo
 bool
 ServiceInstanceHelper::operator==(const ServiceInstanceHelper& helper) const
 {
-    if (_def._cpp_template.empty())
+    if (_def.templateName.empty())
     {
         return _service == helper._service;
     }
     else
     {
-        return _def._cpp_template == helper._def._cpp_template && _def.parameterValues == helper._def.parameterValues &&
+        return _def.templateName == helper._def.templateName && _def.parameterValues == helper._def.parameterValues &&
                _def.propertySet == helper._def.propertySet;
     }
 }
@@ -1767,12 +1767,12 @@ ServiceInstanceHelper::instantiate(const Resolver& resolve, const PropertySetDes
     std::map<std::string, std::string> parameterValues;
     if (!def.getDescriptor())
     {
-        assert(!_def._cpp_template.empty());
-        TemplateDescriptor tmpl = resolve.getServiceTemplate(_def._cpp_template);
+        assert(!_def.templateName.empty());
+        TemplateDescriptor tmpl = resolve.getServiceTemplate(_def.templateName);
         def = ServiceHelper(dynamic_pointer_cast<ServiceDescriptor>(tmpl.descriptor));
         parameterValues = instantiateParams(
             resolve,
-            _def._cpp_template,
+            _def.templateName,
             _def.parameterValues,
             tmpl.parameters,
             tmpl.parameterDefaults);
@@ -1797,7 +1797,7 @@ ServiceInstanceHelper::instantiate(const Resolver& resolve, const PropertySetDes
     // the template + parameters which would be wrong (if the template
     // changed the instance also changed.)
     //
-    // desc._cpp_template = _template;
+    // desc.templateName = _template;
     // desc.parameterValues = _parameters;
     return desc;
 }
@@ -1825,10 +1825,10 @@ ServiceInstanceHelper::print(const shared_ptr<Ice::Communicator>& communicator,
     }
     else
     {
-        assert(!_def._cpp_template.empty());
+        assert(!_def.templateName.empty());
         out << "service instance";
         out << sb;
-        out << nl << "template = '" << _def._cpp_template << "'";
+        out << nl << "template = '" << _def.templateName << "'";
         out << nl << "parameters";
         out << sb;
         for (const auto& parameterValue : _def.parameterValues)
@@ -1865,19 +1865,19 @@ ServerInstanceHelper::init(const shared_ptr<ServerDescriptor>& definition, const
     std::map<std::string, std::string> parameterValues;
     if (!def)
     {
-        if (_def._cpp_template.empty())
+        if (_def.templateName.empty())
         {
             resolve.exception("invalid server instance: template is not defined");
         }
 
         //
         // Get the server definition and the template property sets.
         //
-        TemplateDescriptor tmpl = resolve.getServerTemplate(_def._cpp_template);
+        TemplateDescriptor tmpl = resolve.getServerTemplate(_def.templateName);
         def = dynamic_pointer_cast<ServerDescriptor>(tmpl.descriptor);
         parameterValues = instantiateParams(
             resolve,
-            _def._cpp_template,
+            _def.templateName,
             _def.parameterValues,
             tmpl.parameters,
             tmpl.parameterDefaults);
@@ -1916,9 +1916,9 @@ ServerInstanceHelper::init(const shared_ptr<ServerDescriptor>& definition, const
     // Instantiate the server instance definition (we use the server
     // resolver above, so using parameters in properties is possible).
     //
-    if (!_def._cpp_template.empty())
+    if (!_def.templateName.empty())
     {
-        _instance._cpp_template = _def._cpp_template;
+        _instance.templateName = _def.templateName;
         _instance.parameterValues = parameterValues;
         _instance.propertySet = svrResolve(_def.propertySet);
         for (const auto& servicePropertySet : _def.servicePropertySets)
@@ -1939,13 +1939,13 @@ ServerInstanceHelper::init(const shared_ptr<ServerDescriptor>& definition, const
 bool
 ServerInstanceHelper::operator==(const ServerInstanceHelper& helper) const
 {
-    if (_def._cpp_template.empty())
+    if (_def.templateName.empty())
     {
         return *_serverDefinition == *helper._serverDefinition;
     }
     else
     {
-        return _def._cpp_template == helper._def._cpp_template && _def.parameterValues == helper._def.parameterValues &&
+        return _def.templateName == helper._def.templateName && _def.parameterValues == helper._def.parameterValues &&
                _def.propertySet == helper._def.propertySet &&
                _def.servicePropertySets == helper._def.servicePropertySets;
     }
@@ -1966,21 +1966,21 @@ ServerInstanceHelper::getId() const
 ServerInstanceDescriptor
 ServerInstanceHelper::getDefinition() const
 {
-    assert(!_def._cpp_template.empty());
+    assert(!_def.templateName.empty());
     return _def;
 }
 
 ServerInstanceDescriptor
 ServerInstanceHelper::getInstance() const
 {
-    assert(!_def._cpp_template.empty() && !_instance._cpp_template.empty());
+    assert(!_def.templateName.empty() && !_instance.templateName.empty());
     return _instance;
 }
 
 shared_ptr<ServerDescriptor>
 ServerInstanceHelper::getServerDefinition() const
 {
-    assert(_def._cpp_template.empty());
+    assert(_def.templateName.empty());
     return _serverDefinition->getDescriptor();
 }
 

cpp/src/IceGrid/Parser.cpp

@@ -821,7 +821,7 @@ Parser::instantiateServerTemplate(const list<string>& args)
         }
 
         ServerInstanceDescriptor desc;
-        desc._cpp_template = templ;
+        desc.templateName = templ;
         desc.parameterValues = vars;
         _admin->instantiateServer(application, node, desc);
     }

cpp/src/Slice/MetadataValidation.cpp

@@ -83,9 +83,9 @@ Slice::validateMetadata(const UnitPtr& p, string_view prefix, map<string, Metada
     MetadataInfo deprecatedInfo = {
         .validOn =
             {typeid(InterfaceDecl),
-             typeid(ClassDecl),
              typeid(Operation),
-             typeid(Exception),
+             typeid(ClassDecl),
+             typeid(Slice::Exception),
              typeid(Struct),
              typeid(Sequence),
              typeid(Dictionary),

cpp/src/Slice/Parser.cpp

@@ -38,6 +38,9 @@ compareTag(const T& lhs, const T& rhs)
     return lhs->tag() < rhs->tag();
 }
 
+// NOTE: It is important that this list is kept in alphabetical order!
+constexpr string_view languages[] = {"cpp", "cs", "java", "js", "matlab", "php", "python", "ruby", "swift"};
+
 // Forward declare things from Bison and Flex the parser can use.
 extern int slice_parse();
 extern int slice_lineno;
@@ -104,8 +107,6 @@ Slice::Metadata::Metadata(string rawMetadata, string file, int line) : GrammarBa
     if (firstColonPos != string::npos)
     {
         // Check if the metadata starts with a language prefix.
-        // NOTE: It is important that this list is kept in alphabetical order!
-        constexpr string_view languages[] = {"cpp", "cs", "java", "js", "matlab", "php", "python", "rb", "swift"};
         string prefix = rawMetadata.substr(0, firstColonPos);
         bool hasLangPrefix = binary_search(&languages[0], &languages[sizeof(languages) / sizeof(*languages)], prefix);
         if (hasLangPrefix)
@@ -562,27 +563,52 @@ Slice::Contained::name() const
 string
 Slice::Contained::scoped() const
 {
-    return _scoped;
+    return scope() + name();
 }
 
 string
 Slice::Contained::scope() const
 {
-    string::size_type idx = _scoped.rfind("::");
-    assert(idx != string::npos);
-    return string(_scoped, 0, idx + 2);
+    string scoped;
+    if (auto container = dynamic_pointer_cast<Contained>(_container))
+    {
+        scoped = container->scoped();
+    }
+    return scoped + "::";
 }
 
 string
-Slice::Contained::flattenedScope() const
+Slice::Contained::mappedName() const
 {
-    string s = scope();
-    string::size_type pos = 0;
-    while ((pos = s.find("::", pos)) != string::npos)
+    const string languageName = _unit->languageName();
+    assert(!languageName.empty());
+
+    // First check if any 'xxx:identifier' has been applied to this element.
+    // If so, we return that instead of the element's Slice identifier.
+    const string metadata = languageName + ":identifier";
+    if (auto customName = getMetadataArgs(metadata))
     {
-        s.replace(pos, 2, "_");
+        return *customName;
     }
-    return s;
+
+    return _name;
+}
+
+string
+Slice::Contained::mappedScoped() const
+{
+    return mappedScope() + mappedName();
+}
+
+string
+Slice::Contained::mappedScope() const
+{
+    string scoped;
+    if (auto container = dynamic_pointer_cast<Contained>(_container))
+    {
+        scoped = container->mappedScoped();
+    }
+    return scoped + "::";
 }
 
 string
@@ -1050,12 +1076,6 @@ Slice::Contained::Contained(const ContainerPtr& container, string name)
       _container(container),
       _name(std::move(name))
 {
-    ContainedPtr cont = dynamic_pointer_cast<Contained>(_container);
-    if (cont)
-    {
-        _scoped = cont->scoped();
-    }
-    _scoped += "::" + _name;
     assert(_unit);
     _file = _unit->currentFile();
     _line = _unit->currentLine();
@@ -4544,19 +4564,25 @@ Slice::DataMember::DataMember(
 // ----------------------------------------------------------------------
 
 UnitPtr
-Slice::Unit::createUnit(bool all, const StringList& defaultFileMetadata)
+Slice::Unit::createUnit(string languageName, bool all, const StringList& defaultFileMetadata)
 {
     MetadataList defaultMetadata;
     for (const auto& metadataString : defaultFileMetadata)
     {
         defaultMetadata.push_back(make_shared<Metadata>(metadataString, "<command-line>", 0));
     }
 
-    UnitPtr unit{new Unit{all, std::move(defaultMetadata)}};
+    UnitPtr unit{new Unit{std::move(languageName), all, std::move(defaultMetadata)}};
     unit->_unit = unit;
     return unit;
 }
 
+string
+Slice::Unit::languageName() const
+{
+    return _languageName;
+}
+
 void
 Slice::Unit::setDocComment(const string& comment)
 {
@@ -5006,15 +5032,19 @@ Slice::Unit::getTopLevelModules(const string& file) const
     }
 }
 
-Slice::Unit::Unit(bool all, MetadataList defaultFileMetadata)
+Slice::Unit::Unit(string languageName, bool all, MetadataList defaultFileMetadata)
     : SyntaxTreeBase(nullptr),
       Container(nullptr),
+      _languageName(std::move(languageName)),
       _all(all),
       _defaultFileMetadata(std::move(defaultFileMetadata)),
       _errors(0),
       _currentIncludeLevel(0)
-
 {
+    if (!languageName.empty())
+    {
+        assert(binary_search(&languages[0], &languages[sizeof(languages) / sizeof(*languages)], _languageName));
+    }
 }
 
 // ----------------------------------------------------------------------