office-gobmx/idlc/source/astdeclaration.cxx
Stephan Bergmann 44ea5d1414 Adding SAL_DEPRECATED_INTERNAL to an implementation function is pointless
...as there are typically no direct calls to it anyway.  What is apparently
needed is to decorate the cppumaker-generated headers instead:

* cppumaker obtains deprecation-information from the documentation strings in
  .rdb files.  As these are normally generated by idlc without documentation
  included (no -C), idlc got changed to nevertheless contain documentation
  consisting of just "@deprecated" in this case, to allow to easily tunnel this
  information to cppumaker always.

* The mechanism of parsing for "@deprecated" in documentation strings is
  somewhat crude, of course.

* For now, cppumaker only decorates C++ functions that correspond to UNOIDL
  interface attributes and methods.  More should be possible (but, e.g., being
  able to decorate a complete C++ class corresponding to a deprecated UNOIDL
  interface type depends on whether all platforms would accept
  SAL_DEPRECATED_INTERNAL at the same position in a C++ class declaration.

* This could also be extended to other languages than C++/cppumaker.

* Always using SAL_DEPRECATED_INERNAL instead of SAL_DEPRECATED for decoration
  is to keep things simple and our codebase working.  Improvements are possible
  here, too, of course.

Change-Id: Ia2917892f780d477652e4cd9f286588a6898c3f5
2012-11-23 14:04:51 +01:00

201 lines
5.2 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <idlc/astdeclaration.hxx>
#include <idlc/astscope.hxx>
#include <rtl/strbuf.hxx>
using namespace ::rtl;
static OString sGlobal("::");
static OString convertName(const OString& name)
{
OStringBuffer nameBuffer(name.getLength()+1);
sal_Int32 nIndex = 0;
do
{
OString token( name.getToken( 0, ':', nIndex ) );
if( !token.isEmpty() )
{
nameBuffer.append('/');
nameBuffer.append( token );
}
} while( nIndex != -1 );
return nameBuffer.makeStringAndClear();
}
AstDeclaration::AstDeclaration(NodeType type, const OString& name, AstScope* pScope)
: m_localName(name)
, m_pScope(pScope)
, m_nodeType(type)
, m_bImported(sal_False)
, m_bIsAdded(sal_False)
, m_bInMainFile(sal_False)
, m_bPredefined(false)
{
if ( m_pScope )
{
AstDeclaration* pDecl = scopeAsDecl(m_pScope);
if (pDecl)
{
m_scopedName = pDecl->getScopedName();
if (!m_scopedName.isEmpty())
m_scopedName += sGlobal;
m_scopedName += m_localName;
}
} else
{
m_scopedName = m_localName;
}
m_fullName = convertName(m_scopedName);
if ( idlc()->getFileName() == idlc()->getRealFileName() )
{
m_fileName = idlc()->getMainFileName();
m_bInMainFile = sal_True;
} else
{
m_fileName = idlc()->getFileName();
m_bImported = sal_True;
}
m_documentation = idlc()->processDocumentation();
m_bPublished = idlc()->isPublished();
}
AstDeclaration::~AstDeclaration()
{
}
void AstDeclaration::setPredefined(bool bPredefined)
{
m_bPredefined = bPredefined;
if ( m_bPredefined )
{
m_fileName = OString();
m_bInMainFile = sal_False;
}
}
void AstDeclaration::setName(const ::rtl::OString& name)
{
m_scopedName = name;
sal_Int32 nIndex = name.lastIndexOf( ':' );
m_localName = name.copy( nIndex+1 );
// Huh ? There is always at least one token
// sal_Int32 count = name.getTokenCount(':');
// if ( count > 0 )
// {
// m_localName = name.getToken(count-1, ':');
// m_scopedName = name;
// } else if ( m_pScope )
// {
// m_localName = name;
// AstDeclaration* pDecl = scopeAsDecl(m_pScope);
// if (pDecl)
// {
// m_scopedName = pDecl->getScopedName();
// if (m_scopedName.getLength() > 0)
// m_scopedName += sGlobal;
// m_scopedName += m_localName;
// }
// } else
// {
// m_localName = name;
// m_scopedName = name;
// }
m_fullName = convertName(m_scopedName);
}
bool AstDeclaration::isType() const {
switch (m_nodeType) {
case NT_interface:
case NT_instantiated_struct:
case NT_union:
case NT_enum:
case NT_sequence:
case NT_array:
case NT_typedef:
case NT_predefined:
case NT_type_parameter:
return true;
default:
OSL_ASSERT(m_nodeType != NT_struct); // see AstStruct::isType
return false;
}
}
sal_Bool AstDeclaration::hasAncestor(AstDeclaration* pDecl)
{
if (this == pDecl)
return sal_True;
if ( !m_pScope )
return sal_False;
return scopeAsDecl(m_pScope)->hasAncestor(pDecl);
}
sal_Bool AstDeclaration::dump(RegistryKey& rKey)
{
AstScope* pScope = declAsScope(this);
sal_Bool bRet = sal_True;
if ( pScope )
{
DeclList::const_iterator iter = pScope->getIteratorBegin();
DeclList::const_iterator end = pScope->getIteratorEnd();
AstDeclaration* pDecl = NULL;
while ( iter != end && bRet)
{
pDecl = *iter;
if ( pDecl->isInMainfile() )
{
switch ( pDecl->getNodeType() )
{
case NT_module:
case NT_constants:
case NT_interface:
case NT_struct:
case NT_exception:
case NT_enum:
case NT_union:
case NT_typedef:
case NT_service:
case NT_singleton:
bRet = pDecl->dump(rKey);
break;
default:
break;
}
}
++iter;
}
}
return bRet;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */