office-gobmx/autodoc/source/display/idl/hi_ary.hxx
2003-03-18 13:11:43 +00:00

181 lines
6.4 KiB
C++

/*************************************************************************
*
* $RCSfile: hi_ary.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: hr $ $Date: 2003-03-18 14:11:38 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef ADC_DISPLAY_HI_ARY_HXX
#define ADC_DISPLAY_HI_ARY_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
#include <ary/idl/i_language.hxx>
// PARAMETERS
#include <ary/idl/ip_2s.hxx>
namespace ary
{
namespace idl
{
class Module;
class Gate;
class CePilot;
class TypePilot;
}
}
namespace output
{
class Position;
}
/** A helper class to wrap the access to data in the Autodoc Repository.
*/
class AryAccess
{
public:
// LIFECYCLE
AryAccess(
const ary::idl::Gate &
i_rGate );
// INQUIRY
const ary::idl::Module &
GlobalNamespace() const;
const ary::idl::Module &
Find_Module(
ary::idl::Ce_id i_ce ) const;
const ary::idl::CodeEntity &
Find_Ce(
ary::idl::Ce_id i_ce ) const;
const ary::idl::Type &
Find_Type(
ary::idl::Type_id i_type ) const;
ary::idl::Ce_id CeFromType(
ary::idl::Type_id i_type ) const;
bool IsBuiltInOrRelated(
const ary::idl::Type &
i_type ) const;
bool Search_Ce(
StringVector & o_module,
String & o_mainEntity,
String & o_memberEntity,
const char * i_sText,
const ary::idl::Module &
i_referingScope ) const;
bool Search_CesModule(
StringVector & o_module,
const String & i_scope,
const String & i_ce,
const ary::idl::Module &
i_referingScope ) const;
const ary::idl::Module *
Search_Module(
const StringVector &
i_nameChain ) const;
void Get_CeText(
StringVector & o_module,
String & o_ce,
String & o_member,
const ary::idl::CodeEntity &
i_ce ) const;
void Get_TypeText(
StringVector & o_module,
String & o_sCe,
ary::idl::Ce_id & o_nCe,
int & o_sequenceCount,
const ary::idl::Type &
i_type ) const;
void Get_IndexData(
std::vector<ary::idl::Ce_id> &
o_data,
ary::idl::alphabetical_index::E_Letter
i_letter ) const;
const ary::idl::CePilot &
Ces() const; // KORR
private:
const ary::idl::Module *
find_SubModule(
const ary::idl::Module &
i_parent,
const String & i_name ) const;
/// Gets "::"-separated names out of a string.
bool nextName(
const char * & io_TextPtr,
String & o_name ) const;
const ary::idl::Gate &
gate() const;
const ary::idl::CePilot &
ces() const;
const ary::idl::TypePilot &
types() const;
// DATA
const ary::idl::Gate &
rGate;
};
#endif