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

320 lines
9.3 KiB
C++

/*************************************************************************
*
* $RCSfile: hfi_service.cxx,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): _______________________________________
*
*
************************************************************************/
#include <precomp.h>
#include "hfi_service.hxx"
// NOT FULLY DEFINED SERVICES
#include <ary/idl/i_ce.hxx>
#include <ary/idl/ik_service.hxx>
#include <ary_i/codeinf2.hxx>
#include <toolkit/hf_docentry.hxx>
#include <toolkit/hf_linachain.hxx>
#include <toolkit/hf_navi_sub.hxx>
#include <toolkit/hf_title.hxx>
#include "hfi_doc.hxx"
#include "hfi_navibar.hxx"
#include "hfi_property.hxx"
#include "hfi_tag.hxx"
#include "hfi_typetext.hxx"
#include "hi_linkhelper.hxx"
extern const String
C_sCePrefix_Service("service");
namespace
{
const String
C_sList_IncludedServices("Included Services");
const String
C_sList_IncludedServices_Label("IncludedServices");
const String
C_sList_ExportedInterfaces("Exported Interfaces");
const String
C_sList_ExportedInterfaces_Label("ExportedInterfaces");
const String
C_sList_Properties("Properties' Summary");
const String
C_sList_Properties_Label("PropertiesSummary");
const String
C_sList_PropertiesDetails("Properties' Details");
const String
C_sList_PropertiesDetails_Label("PropertiesDetails");
enum E_SubListIndices
{
sli_IncludedServices = 0,
sli_ExportedInterfaces = 1,
sli_PropertiesSummary = 2,
sli_PropertiesDetails = 3
};
} //anonymous namespace
HF_IdlService::HF_IdlService( Environment & io_rEnv,
Xml::Element & o_rOut )
: HtmlFactory_Idl(io_rEnv, &o_rOut)
{
}
HF_IdlService::~HF_IdlService()
{
}
typedef ::ary::idl::ifc_service::attr
ServiceAttr;
typedef ::ary::Dyn_StdConstIterator< ::ary::idl::CommentedReference >
dyn_comref_list;
void
HF_IdlService::Produce_byData( const client & i_ce ) const
{
Dyn<HF_NaviSubRow>
pNaviSubRow( &make_Navibar(i_ce) );
HF_TitleTable
aTitle(CurOut());
HF_LinkedNameChain
aNameChain(aTitle.Add_Row());
aNameChain.Produce_CompleteChain(Env().CurPosition(), nameChainLinker);
aTitle.Produce_Title( StreamLock(200)() << C_sCePrefix_Service
<< " "
<< i_ce.LocalName()
<< c_str );
write_Docu(aTitle.Add_Row(), i_ce);
CurOut() << new Html::HorizontalLine();
dyn_comref_list
dpIncludedServices;
ServiceAttr::Get_IncludedServices(dpIncludedServices, i_ce);
if ( BOOL_OF(*dpIncludedServices) )
{
produce_IncludedServices( i_ce, *dpIncludedServices );
pNaviSubRow->SwitchOn(sli_IncludedServices);
}
dyn_comref_list
dpExportedInterfaces;
ServiceAttr::Get_ExportedInterfaces(dpExportedInterfaces, i_ce);
if ( BOOL_OF(*dpExportedInterfaces) )
{
produce_ExportedInterfaces( i_ce, *dpExportedInterfaces );
pNaviSubRow->SwitchOn(sli_ExportedInterfaces);
}
dyn_ce_list
dpProperties;
ServiceAttr::Get_Properties(dpProperties, i_ce);
if ( BOOL_OF(*dpProperties) )
{
produce_Members( *dpProperties,
C_sList_Properties,
C_sList_Properties_Label,
C_sList_PropertiesDetails,
C_sList_PropertiesDetails_Label );
pNaviSubRow->SwitchOn(sli_PropertiesSummary);
pNaviSubRow->SwitchOn(sli_PropertiesDetails);
}
pNaviSubRow->Produce_Row();
CurOut() << new Xml::XmlCode("<br>&nbsp;");
}
DYN HF_NaviSubRow &
HF_IdlService::make_Navibar( const client & i_ce ) const
{
HF_IdlNavigationBar
aNaviBar(Env(), CurOut());
aNaviBar.Produce_CeMainRow(i_ce);
DYN HF_NaviSubRow &
ret = aNaviBar.Add_SubRow();
ret.AddItem(C_sList_IncludedServices, C_sList_IncludedServices_Label, false);
ret.AddItem(C_sList_ExportedInterfaces, C_sList_ExportedInterfaces_Label, false);
ret.AddItem(C_sList_Properties, C_sList_Properties_Label, false);
ret.AddItem(C_sList_PropertiesDetails, C_sList_PropertiesDetails_Label, false);
CurOut() << new Html::HorizontalLine();
return ret;
}
void
HF_IdlService::produce_IncludedServices( const client & i_ce,
comref_list & it_list ) const
{
csv_assert( it_list );
HF_SubTitleTable
aTable( CurOut(),
C_sList_IncludedServices_Label,
C_sList_IncludedServices,
2 );
for ( ; BOOL_OF(it_list); ++it_list )
{
Xml::Element &
rRow = aTable.Add_Row();
produce_Link(rRow, (*it_list).first);
produce_LinkDoc(i_ce, rRow, it_list);
} // end for
}
void
HF_IdlService::produce_ExportedInterfaces( const client & i_ce,
comref_list & it_list ) const
{
csv_assert( it_list );
HF_SubTitleTable
aTable( CurOut(),
C_sList_ExportedInterfaces_Label,
C_sList_ExportedInterfaces,
2 );
for ( ; it_list; ++it_list )
{
Xml::Element &
rRow = aTable.Add_Row();
produce_Link(rRow, (*it_list).first);
produce_LinkDoc(i_ce, rRow, it_list);
} // end for
}
void
HF_IdlService::produce_Link( Xml::Element & o_row,
type_id i_type ) const
{
Xml::Element &
rCell = o_row
>> *new Html::TableCell
<< new Html::ClassAttr(C_sCellStyle_SummaryLeft);
HF_IdlTypeText
aText(Env(), rCell, true);
aText.Produce_byData(i_type);
}
void
HF_IdlService::produce_LinkDoc( const client & i_ce,
Xml::Element & o_row,
comref_list & i_commentedRef ) const
{
Xml::Element &
rCell = o_row
>> *new Html::TableCell
<< new Html::ClassAttr(C_sCellStyle_SummaryRight);
HF_DocEntryList
aDocList(rCell);
if ( (*i_commentedRef).second != 0 )
{
HF_IdlDocu
aDocuDisplay(Env(), aDocList);
aDocuDisplay.Produce_byData(i_ce, (*i_commentedRef).second );
}
else
{
const client *
pCe = Env().Linker().Search_CeFromType((*i_commentedRef).first);
const ce_info *
pShort = pCe != 0
? pCe->Docu()
: 0;
if ( pShort != 0 )
{
if (pShort->IsDeprecated())
{
rCell << "[ DEPRECATED ]" << new Html::LineBreak;
}
if (pShort->IsOptional())
{
rCell << "[ OPTIONAL ]" << new Html::LineBreak;
}
HF_IdlDocuTextDisplay
aShortDisplay( Env(), &rCell, *pCe);
pShort->Short().DisplayAt(aShortDisplay);
}
} // endif ( (*i_commentedRef).second != 0 ) else
}
void
HF_IdlService::produce_MemberDetails( HF_SubTitleTable & o_table,
const client & i_ce ) const
{
HF_IdlProperty
aProperty( Env(), o_table);
aProperty.Produce_byData( i_ce );
}