office-gobmx/autodoc/inc/ary/cpp/inpcontx.hxx
Rüdiger Timm 0bb6472949 INTEGRATION: CWS ooo19126 (1.2.96); FILE MERGED
2005/09/05 13:09:14 rt 1.2.96.1: #i54170# Change license header: remove SISSL
2005-09-07 15:05:11 +00:00

231 lines
8.1 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: inpcontx.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: rt $ $Date: 2005-09-07 16:05:11 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef ARY_CPP_INPCONTX_HXX
#define ARY_CPP_INPCONTX_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
#include <ary/ids.hxx>
#include <ary/cpp/c_etypes.hxx>
namespace ary
{
namespace cpp
{
class Namespace;
class Class;
class Enum;
class ProjectGroup;
class FileGroup;
/** This class provides information about the context of an
CodeEntity, which is going to be stored in the repository.
The information is used mainly by class ary::cpp::Gate.
*/
class InputContext
{
public:
class Owner
{
public:
// LIFECYCLE
virtual ~Owner() {}
// OPERATIONS
/// Adds Class data to current inner scope (Namespace or Class).
void Add_Class(
const udmstri & i_sLocalName,
Cid i_nId );
/// Adds Enum data to current inner scope (Namespace or Class).
void Add_Enum(
const udmstri & i_sLocalName,
Cid i_nId );
/// Adds Typedef data to current inner scope (Namespace or Class).
void Add_Typedef(
const udmstri & i_sLocalName,
Cid i_nId );
/// Adds Operation data to current inner scope (Namespace or Class).
void Add_Operation(
const udmstri & i_sLocalName,
OSid i_nSignature,
Cid i_nId,
bool i_bIsStaticMember ); /// True only for static class members.
/// Adds Variable data to current inner scope (Namespace or Class).
void Add_Variable(
const udmstri & i_sLocalName,
Cid i_nId,
bool i_bIsConst,
bool i_bIsStaticMember ); /// True only for static class members.
// INQUIRY
Cid Id() const;
/** @attention Must only be used by ary::cpp::Gate!
Will work nerver else!
*/
virtual bool HasClass(
const udmstri & i_sLocalName ) = 0;
/** @attention Must only be used by ary::cpp::Gate!
Will work nerver else!
*/
virtual bool HasOperation(
const udmstri & i_sLocalName,
OSid i_nSignature ) = 0;
private:
virtual void do_Add_Class(
const udmstri & i_sLocalName,
Cid i_nId ) = 0;
virtual void do_Add_Enum(
const udmstri & i_sLocalName,
Cid i_nId ) = 0;
virtual void do_Add_Typedef(
const udmstri & i_sLocalName,
Cid i_nId ) = 0;
virtual void do_Add_Operation(
const udmstri & i_sLocalName,
OSid i_nSignature,
Cid i_nId,
bool i_bIsStatic ) = 0;
virtual void do_Add_Variable(
const udmstri & i_sLocalName,
Cid i_nId,
bool i_bIsConst,
bool i_bIsStatic ) = 0;
virtual Cid inq_Id() const = 0;
};
// LIFECYCLE
virtual ~InputContext() {}
// OPERATIONS
// INQUIRY
ProjectGroup & CurProjectGroup() const;
FileGroup & CurFileGroup() const;
Namespace & CurNamespace() const;
Class * CurClass() const;
Enum * CurEnum() const;
Owner & CurOwner() const;
E_Protection CurProtection() const;
private:
virtual ProjectGroup &
inq_CurProjectGroup() const = 0;
virtual FileGroup & inq_CurFileGroup() const = 0;
virtual Namespace & inq_CurNamespace() const = 0;
virtual Class * inq_CurClass() const = 0;
virtual Enum * inq_CurEnum() const = 0;
virtual Owner & inq_CurOwner() const = 0;
virtual E_Protection
inq_CurProtection() const = 0;
};
// IMPLEMENTATION
inline ProjectGroup &
InputContext::CurProjectGroup() const
{ return inq_CurProjectGroup(); }
inline FileGroup &
InputContext::CurFileGroup() const
{ return inq_CurFileGroup(); }
inline Namespace &
InputContext::CurNamespace() const
{ return inq_CurNamespace(); }
inline Class *
InputContext::CurClass() const
{ return inq_CurClass(); }
inline Enum *
InputContext::CurEnum() const
{ return inq_CurEnum(); }
inline InputContext::Owner &
InputContext::CurOwner() const
{ return inq_CurOwner(); }
inline E_Protection
InputContext::CurProtection() const
{ return inq_CurProtection(); }
inline void
InputContext::Owner::Add_Class( const udmstri & i_sLocalName,
Cid i_nId )
{ do_Add_Class(i_sLocalName, i_nId); }
inline void
InputContext::Owner::Add_Enum( const udmstri & i_sLocalName,
Cid i_nId )
{ do_Add_Enum(i_sLocalName, i_nId); }
inline void
InputContext::Owner::Add_Typedef( const udmstri & i_sLocalName,
Cid i_nId )
{ do_Add_Typedef(i_sLocalName, i_nId); }
inline void
InputContext::Owner::Add_Operation( const udmstri & i_sLocalName,
OSid i_nSignature,
Cid i_nId,
bool i_bIsStatic )
{ do_Add_Operation( i_sLocalName, i_nSignature, i_nId, i_bIsStatic ); }
inline void
InputContext::Owner::Add_Variable( const udmstri & i_sLocalName,
Cid i_nId,
bool i_bIsConst,
bool i_bIsStatic )
{ do_Add_Variable( i_sLocalName, i_nId, i_bIsConst, i_bIsStatic ); }
inline Cid
InputContext::Owner::Id() const
{ return inq_Id(); }
} // namespace cpp
} // namespace ary
#endif