office-gobmx/autodoc/source/display/idl/hfi_hierarchy.hxx
Rüdiger Timm e8cddc9f6c INTEGRATION: CWS changefileheader (1.5.22); FILE MERGED
2008/03/28 16:02:03 rt 1.5.22.1: #i87441# Change license header to LPGL v3.
2008-04-10 13:47:05 +00:00

159 lines
5.3 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: hfi_hierarchy.hxx,v $
* $Revision: 1.6 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ADC_DISPLAY_HFI_HIERARCHY_HXX
#define ADC_DISPLAY_HFI_HIERARCHY_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
#include <ary/idl/i_comrela.hxx>
#include <ary/idl/i_types4idl.hxx>
namespace csi
{
namespace xml
{
class Element;
}
}
class HF_IdlInterface;
class HtmlEnvironment_Idl;
/** Represents a node in an pyramidic inheritance hierarchy which shall be
displayed in text mode.
*/
class HF_IdlBaseNode
{
public:
typedef ary::idl::CodeEntity CE;
typedef ary::idl::Type TYPE;
typedef ary::idl::Gate GATE;
typedef ary::idl::Ce_id Ce_id;
typedef ary::idl::Type_id Type_id;
/** Constructor for the most derived class, whose base hierarchy
is to be built.
The constructor recursively calls further constructors of
HF_IdlBaseNode for the bases of ->i_rCe.
So it builds up a complete hierarchy tree of all base classes
of ->i_rCe.
*/
HF_IdlBaseNode(
const CE & i_rCe,
const GATE & i_rGate );
/** @descr
The constructor recursively calls further constructors of
HF_IdlBaseNode for the bases of ->i_rType, if ->i_rType matches to a
->CE.
So it builds up a complete hierarchy tree of all base classes
of ->i_pEntity.
*/
HF_IdlBaseNode(
const TYPE & i_rType,
const GATE & i_rGate,
intt i_nPositionOffset,
HF_IdlBaseNode & io_rDerived );
~HF_IdlBaseNode();
/** Recursively fills ->o_rPositionList with the instances of base
classes in the order in which they will be displayed.
*/
void FillPositionList(
std::vector< const HF_IdlBaseNode* > &
o_rPositionList ) const;
/** Writes the base hierarchy of this node into ->o_rOut.
It ends at the position where the name of the most derived
class would have to be written. Example:
abc::MyClass
|
| AnotherClass
| |
+--+--XYZ
The "XYZ" would NOT be written, that is the task of the caller.
*/
void WriteBaseHierarchy(
csi::xml::Element & o_rOut,
const HF_IdlInterface &
io_rDisplayer,
const String & i_sMainNodesText );
Type_id Type() const { return nType; }
intt BaseCount() const { return nCountBases; }
intt Position() const { return nPosition; }
int Xpos() const { return 3*Position(); }
int Ypos() const { return 2*Position(); }
const HF_IdlBaseNode * Derived() const { return pDerived; }
private:
typedef std::vector< DYN HF_IdlBaseNode* > BaseList;
void GatherBases(
const CE & i_rCe,
const GATE & i_rGate );
// DATA
Type_id nType;
BaseList aBases;
intt nCountBases;
intt nPosition;
HF_IdlBaseNode * pDerived;
};
void Write_BaseHierarchy(
csi::xml::Element & o_rOut,
HtmlEnvironment_Idl &
i_env,
const ary::idl::CodeEntity &
i_rCe );
void Write_Bases(
csi::xml::Element & o_rOut,
HtmlEnvironment_Idl &
i_env,
const ary::idl::CodeEntity &
i_rCe,
std::vector<uintt> &
io_setColumns );
#endif