idlc/source/astinterface.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <idlc/astinterface.hxx>
  21 #include <idlc/astattribute.hxx>
  22 #include <idlc/astoperation.hxx>
  23 #include "idlc/idlc.hxx"
  24
  25 #include <registry/version.h>
  26 #include <registry/writer.hxx>
  27
  28 #include <osl/diagnose.h>
  29
  30 AstInterface::AstInterface(const OString& name,
  31                            AstInterface const * pInherits,
  32                            AstScope* pScope)
  33     : AstType(NT_interface, name, pScope)
  34     , AstScope(NT_interface)
  35     , m_mandatoryInterfaces(0)
  36     , m_bIsDefined(false)
  37     , m_bForwarded(false)
  38     , m_bForwardedInSameFile(false)
  39     , m_bSingleInheritance(pInherits != 0)
  40 {
  41     if (pInherits != 0) {
  42         addInheritedInterface(pInherits, false, OUString());
  43     }
  44 }
  45
  46 AstInterface::~AstInterface()
  47 {
  48 }
  49
  50 AstInterface::DoubleDeclarations AstInterface::checkInheritedInterfaceClashes(
  51     AstInterface const * ifc, bool optional) const
  52 {
  53     DoubleDeclarations doubleDecls;
  54     std::set< OString > seen;
  55     checkInheritedInterfaceClashes(
  56         doubleDecls, seen, ifc, true, optional, optional);
  57     return doubleDecls;
  58 }
  59
  60 void AstInterface::addInheritedInterface(
  61     AstType const * ifc, bool optional, OUString const & documentation)
  62 {
  63     m_inheritedInterfaces.push_back(
  64         InheritedInterface(ifc, optional, documentation));
  65     if (!optional) {
  66         ++m_mandatoryInterfaces;
  67     }
  68     AstInterface const * resolved = resolveInterfaceTypedefs(ifc);
  69     addVisibleInterface(resolved, true, optional);
  70     if (optional) {
  71         addOptionalVisibleMembers(resolved);
  72     }
  73 }
  74
  75 AstInterface::DoubleMemberDeclarations AstInterface::checkMemberClashes(
  76     AstDeclaration const * member) const
  77 {
  78     DoubleMemberDeclarations doubleMembers;
  79     checkMemberClashes(doubleMembers, member, true);
  80     return doubleMembers;
  81 }
  82
  83 void AstInterface::addMember(AstDeclaration /*TODO: const*/ * member) {
  84     addDeclaration(member);
  85     m_visibleMembers.insert(
  86         VisibleMembers::value_type(
  87             member->getLocalName(), VisibleMember(member)));
  88 }
  89
  90 void AstInterface::forwardDefined(AstInterface const & def)
  91 {
  92     setImported(def.isImported());
  93     setInMainfile(def.isInMainfile());
  94     setLineNumber(def.getLineNumber());
  95     setFileName(def.getFileName());
  96     setDocumentation(def.getDocumentation());
  97     m_inheritedInterfaces = def.m_inheritedInterfaces;
  98     m_mandatoryInterfaces = def.m_mandatoryInterfaces;
  99     m_bIsDefined = true;
 100 }
 101
 102 bool AstInterface::dump(RegistryKey& rKey)
 103 {
 104     if ( !isDefined() )
 105         return true;
 106
 107     RegistryKey localKey;
 108     if (rKey.createKey( OStringToOUString(getFullName(), RTL_TEXTENCODING_UTF8 ), localKey) != RegError::NO_ERROR)
 109     {
 110         fprintf(stderr, "%s: warning, could not create key '%s' in '%s'\n",
 111                 idlc()->getOptions()->getProgramName().getStr(),
 112                 getFullName().getStr(), OUStringToOString(rKey.getRegistryName(), RTL_TEXTENCODING_UTF8).getStr());
 113         return false;
 114     }
 115
 116     if (m_mandatoryInterfaces > SAL_MAX_UINT16
 117         || m_inheritedInterfaces.size() - m_mandatoryInterfaces
 118             > SAL_MAX_UINT16)
 119     {
 120         fprintf(
 121             stderr, "%s: interface %s has too many direct base interfaces\n",
 122             idlc()->getOptions()->getProgramName().getStr(),
 123             getScopedName().getStr());
 124         return false;
 125     }
 126     sal_uInt16 nBaseTypes = static_cast< sal_uInt16 >(m_mandatoryInterfaces);
 127     sal_uInt16 nAttributes = 0;
 128     sal_uInt16 nMethods = 0;
 129     sal_uInt16 nReferences = static_cast< sal_uInt16 >(
 130         m_inheritedInterfaces.size() - m_mandatoryInterfaces);
 131     typereg_Version version
 132         = (nBaseTypes <= 1 && nReferences == 0 && !m_bPublished
 133            ? TYPEREG_VERSION_0 : TYPEREG_VERSION_1);
 134     for (DeclList::const_iterator i(getIteratorBegin()); i != getIteratorEnd();
 135           ++i)
 136     {
 137         switch ((*i)->getNodeType()) {
 138         case NT_attribute:
 139             {
 140                 if (!increment(&nAttributes, "attributes")) {
 141                     return false;
 142                 }
 143                 AstAttribute * attr = static_cast<AstAttribute *>(*i);
 144                 if (attr->isBound()) {
 145                     version = TYPEREG_VERSION_1;
 146                 }
 147                 DeclList::size_type getCount = attr->getGetExceptionCount();
 148                 if (getCount > SAL_MAX_UINT16) {
 149                     fprintf(
 150                         stderr,
 151                         ("%s: raises clause of getter for attribute %s of"
 152                          " interface %s is too long\n"),
 153                         idlc()->getOptions()->getProgramName().getStr(),
 154                         (*i)->getLocalName().getStr(),
 155                         getScopedName().getStr());
 156                     return false;
 157                 }
 158                 if (getCount > 0) {
 159                     version = TYPEREG_VERSION_1;
 160                     if (!increment(&nMethods, "attributes")) {
 161                         return false;
 162                     }
 163                 }
 164                 DeclList::size_type setCount = attr->getSetExceptionCount();
 165                 if (setCount > SAL_MAX_UINT16) {
 166                     fprintf(
 167                         stderr,
 168                         ("%s: raises clause of setter for attribute %s of"
 169                          " interface %s is too long\n"),
 170                         idlc()->getOptions()->getProgramName().getStr(),
 171                         (*i)->getLocalName().getStr(),
 172                         getScopedName().getStr());
 173                     return false;
 174                 }
 175                 if (setCount > 0) {
 176                     version = TYPEREG_VERSION_1;
 177                     if (!increment(&nMethods, "attributes")) {
 178                         return false;
 179                     }
 180                 }
 181                 break;
 182             }
 183
 184         case NT_operation:
 185             if (!increment(&nMethods, "methods")) {
 186                 return false;
 187             }
 188             break;
 189
 190         default:
 191             OSL_ASSERT(false);
 192             break;
 193         }
 194     }
 195
 196     OUString emptyStr;
 197     typereg::Writer aBlob(
 198         version, getDocumentation(), emptyStr, RT_TYPE_INTERFACE, m_bPublished,
 199         OStringToOUString(getRelativName(), RTL_TEXTENCODING_UTF8), nBaseTypes,
 200         nAttributes, nMethods, nReferences);
 201
 202     sal_uInt16 superTypeIndex = 0;
 203     sal_uInt16 referenceIndex = 0;
 204     for (InheritedInterfaces::iterator i = m_inheritedInterfaces.begin();
 205           i != m_inheritedInterfaces.end(); ++i)
 206     {
 207         if (i->isOptional()) {
 208             aBlob.setReferenceData(
 209                 referenceIndex++, i->getDocumentation(), RTReferenceType::SUPPORTS,
 210                 RTFieldAccess::OPTIONAL,
 211                 OStringToOUString(
 212                     i->getInterface()->getRelativName(),
 213                     RTL_TEXTENCODING_UTF8));
 214         } else {
 215             aBlob.setSuperTypeName(
 216                 superTypeIndex++,
 217                 OStringToOUString(
 218                     i->getInterface()->getRelativName(),
 219                     RTL_TEXTENCODING_UTF8));
 220         }
 221     }
 222
 223     sal_uInt16 attributeIndex = 0;
 224     sal_uInt16 methodIndex = 0;
 225     for (DeclList::const_iterator i(getIteratorBegin()); i != getIteratorEnd();
 226           ++i)
 227     {
 228         switch ((*i)->getNodeType()) {
 229         case NT_attribute:
 230             static_cast<AstAttribute *>(*i)->dumpBlob(
 231                 aBlob, attributeIndex++, &methodIndex);
 232             break;
 233
 234         case NT_operation:
 235             static_cast<AstOperation *>(*i)->dumpBlob(aBlob, methodIndex++);
 236             break;
 237
 238         default:
 239             OSL_ASSERT(false);
 240             break;
 241         }
 242     }
 243
 244     sal_uInt32 aBlobSize;
 245     void const * pBlob = aBlob.getBlob(&aBlobSize);
 246
 247     if (localKey.setValue(emptyStr, RegValueType::BINARY, const_cast<RegValue>(pBlob), aBlobSize) != RegError::NO_ERROR)
 248     {
 249         fprintf(stderr, "%s: warning, could not set value of key \"%s\" in %s\n",
 250                 idlc()->getOptions()->getProgramName().getStr(),
 251                 getFullName().getStr(), OUStringToOString(localKey.getRegistryName(), RTL_TEXTENCODING_UTF8).getStr());
 252         return false;
 253     }
 254
 255     return true;
 256 }
 257
 258 void AstInterface::checkInheritedInterfaceClashes(
 259     DoubleDeclarations & doubleDeclarations,
 260     std::set< OString > & seenInterfaces, AstInterface const * ifc,
 261     bool direct, bool optional, bool mainOptional) const
 262 {
 263     if (direct || optional
 264         || seenInterfaces.insert(ifc->getScopedName()).second)
 265     {
 266         VisibleInterfaces::const_iterator visible(
 267             m_visibleInterfaces.find(ifc->getScopedName()));
 268         if (visible != m_visibleInterfaces.end()) {
 269             switch (visible->second) {
 270             case INTERFACE_INDIRECT_OPTIONAL:
 271                 if (direct && optional) {
 272                     doubleDeclarations.interfaces.push_back(ifc);
 273                     return;
 274                 }
 275                 break;
 276
 277             case INTERFACE_DIRECT_OPTIONAL:
 278                 if (direct || !mainOptional) {
 279                     doubleDeclarations.interfaces.push_back(ifc);
 280                 }
 281                 return;
 282
 283             case INTERFACE_INDIRECT_MANDATORY:
 284                 if (direct) {
 285                     doubleDeclarations.interfaces.push_back(ifc);
 286                 }
 287                 return;
 288
 289             case INTERFACE_DIRECT_MANDATORY:
 290                 if (direct || (!optional && !mainOptional)) {
 291                     doubleDeclarations.interfaces.push_back(ifc);
 292                 }
 293                 return;
 294             }
 295         }
 296         if (direct || !optional) {
 297             for (DeclList::const_iterator i(ifc->getIteratorBegin());
 298                   i != ifc->getIteratorEnd(); ++i)
 299             {
 300                 checkMemberClashes(
 301                     doubleDeclarations.members, *i, !mainOptional);
 302             }
 303             for (InheritedInterfaces::const_iterator i(
 304                       ifc->m_inheritedInterfaces.begin());
 305                   i != ifc->m_inheritedInterfaces.end(); ++i)
 306             {
 307                 checkInheritedInterfaceClashes(
 308                     doubleDeclarations, seenInterfaces, i->getResolved(),
 309                     false, i->isOptional(), mainOptional);
 310             }
 311         }
 312     }
 313 }
 314
 315 void AstInterface::checkMemberClashes(
 316     DoubleMemberDeclarations & doubleMembers, AstDeclaration const * member,
 317     bool checkOptional) const
 318 {
 319     VisibleMembers::const_iterator i(
 320         m_visibleMembers.find(member->getLocalName()));
 321     if (i != m_visibleMembers.end()) {
 322         if (i->second.mandatory != 0) {
 323             if (i->second.mandatory->getScopedName() != member->getScopedName())
 324             {
 325                 DoubleMemberDeclaration d;
 326                 d.first = i->second.mandatory;
 327                 d.second = member;
 328                 doubleMembers.push_back(d);
 329             }
 330         } else if (checkOptional) {
 331             for (VisibleMember::Optionals::const_iterator j(
 332                      i->second.optionals.begin());
 333                  j != i->second.optionals.end(); ++j)
 334             {
 335                 if (j->second->getScopedName() != member->getScopedName()) {
 336                     DoubleMemberDeclaration d;
 337                     d.first = j->second;
 338                     d.second = member;
 339                     doubleMembers.push_back(d);
 340                 }
 341             }
 342         }
 343     }
 344 }
 345
 346 void AstInterface::addVisibleInterface(
 347     AstInterface const * ifc, bool direct, bool optional)
 348 {
 349     InterfaceKind kind = optional
 350         ? direct ? INTERFACE_DIRECT_OPTIONAL : INTERFACE_INDIRECT_OPTIONAL
 351         : direct ? INTERFACE_DIRECT_MANDATORY : INTERFACE_INDIRECT_MANDATORY;
 352     std::pair< VisibleInterfaces::iterator, bool > result(
 353         m_visibleInterfaces.insert(
 354             VisibleInterfaces::value_type(ifc->getScopedName(), kind)));
 355     bool seen = !result.second
 356         && result.first->second >= INTERFACE_INDIRECT_MANDATORY;
 357     if (!result.second && kind > result.first->second) {
 358         result.first->second = kind;
 359     }
 360     if (!optional && !seen) {
 361         for (DeclList::const_iterator i(ifc->getIteratorBegin());
 362               i != ifc->getIteratorEnd(); ++i)
 363         {
 364             m_visibleMembers.insert(
 365                 VisibleMembers::value_type(
 366                     (*i)->getLocalName(), VisibleMember(*i)));
 367         }
 368         for (InheritedInterfaces::const_iterator i(
 369                   ifc->m_inheritedInterfaces.begin());
 370               i != ifc->m_inheritedInterfaces.end(); ++i)
 371         {
 372             addVisibleInterface(i->getResolved(), false, i->isOptional());
 373         }
 374     }
 375 }
 376
 377 void AstInterface::addOptionalVisibleMembers(AstInterface const * ifc) {
 378     for (DeclList::const_iterator i(ifc->getIteratorBegin());
 379           i != ifc->getIteratorEnd(); ++i)
 380     {
 381         VisibleMembers::iterator visible(
 382             m_visibleMembers.find((*i)->getLocalName()));
 383         if (visible == m_visibleMembers.end()) {
 384             visible = m_visibleMembers.insert(
 385                 VisibleMembers::value_type(
 386                     (*i)->getLocalName(), VisibleMember())).first;
 387         }
 388         if (visible->second.mandatory == 0) {
 389             visible->second.optionals.insert(
 390                 VisibleMember::Optionals::value_type(ifc->getScopedName(), *i));
 391         }
 392     }
 393     for (InheritedInterfaces::const_iterator i(
 394               ifc->m_inheritedInterfaces.begin());
 395           i != ifc->m_inheritedInterfaces.end(); ++i)
 396     {
 397         if (!i->isOptional()) {
 398             addOptionalVisibleMembers(i->getResolved());
 399         }
 400     }
 401 }
 402
 403 bool AstInterface::increment(sal_uInt16 * counter, char const * sort) const {
 404     if (*counter == SAL_MAX_UINT16) {
 405         fprintf(
 406             stderr, "%s: interface %s has too many direct %s\n",
 407             idlc()->getOptions()->getProgramName().getStr(),
 408             getScopedName().getStr(), sort);
 409         return false;
 410     }
 411     ++*counter;
 412     return true;
 413 }
 414
 415 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */