office-gobmx/autodoc/source/display/idl/hi_factory.cxx
Oliver Bolte 08439b5e9c INTEGRATION: CWS sdki18n (1.4.60); FILE MERGED
2004/02/11 09:56:55 jsc 1.4.60.1: #115338# merge diffs from sdk11zhja to src680
2004-02-20 08:41:37 +00:00

307 lines
9.1 KiB
C++

/*************************************************************************
*
* $RCSfile: hi_factory.cxx,v $
*
* $Revision: 1.5 $
*
* last change: $Author: obo $ $Date: 2004-02-20 09:41:37 $
*
* 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 "hi_factory.hxx"
// NOT FULLY DEFINED SERVICES
#include <ary/idl/i_ce.hxx>
#include <toolkit/hf_title.hxx>
#include "hfi_doc.hxx"
#include "hfi_navibar.hxx"
#include "hfi_tag.hxx"
#include "hfi_typetext.hxx"
#include "hi_linkhelper.hxx"
extern const String
C_sCellStyle_SummaryLeft("imsum_left");
extern const String
C_sCellStyle_SummaryRight("imsum_right");
extern const String
C_sCellStyle_MDetail("imdetail");
extern const String
C_sMemberTitle("membertitle");
namespace
{
const char C_sSpace[92] = " "
" "
" ";
}
void
HtmlFactory_Idl::produce_InternalLink( Xml::Element & o_screen,
const client & i_ce ) const
{
StreamLock aLocalLink(100);
aLocalLink() << "#" << i_ce.LocalName();
o_screen
>> *new Html::TableCell
<< new Html::ClassAttr( C_sCellStyle_SummaryLeft )
>> *new Html::Link( aLocalLink().c_str() )
<< i_ce.LocalName();
}
void
HtmlFactory_Idl::produce_ShortDoc( Xml::Element & o_screen,
const client & i_ce ) const
{
Xml::Element &
rDetailsRowCell = o_screen
>> *new Html::TableCell
<< new Html::ClassAttr( C_sCellStyle_SummaryRight );
HF_IdlShortDocu
aLinkDoc(Env(), rDetailsRowCell);
aLinkDoc.Produce_byData( i_ce );
}
void
HtmlFactory_Idl::produce_Bases( Xml::Element & o_screen,
const client & i_ce,
const String & i_sLabel ) const
{
ary::idl::Type_id nBaseT = baseOf(i_ce);
// ary::idl::ifc_interface::attr::Base(i_ce);
if ( nBaseT.IsValid() )
{
HF_DocEntryList
aDocList( o_screen );
aDocList.Produce_Term(i_sLabel);
int nDepth = 0;
Xml::Element &
rBaseList = aDocList.Produce_Definition()
>> *new Xml::AnElement("pre")
<< new Xml::AnAttribute("style","font-family:monospace;");
recursive_ShowBases( rBaseList,
nBaseT,
nDepth );
csv_assert(nDepth > 0);
if (nDepth > 30)
nDepth = 30;
rBaseList
<< (C_sSpace + 93 - 3*nDepth)
<< "|\n"
<< (C_sSpace + 93 - 3*nDepth)
<< "+-"
>> *new Html::Bold
<< i_ce.LocalName();
}
}
void
HtmlFactory_Idl::produce_Members( ce_list & it_list,
const String & i_summaryTitle,
const String & i_summaryLabel,
const String & i_detailsTitle,
const String & i_detailsLabel ) const
{
csv_assert( it_list );
HF_SubTitleTable
aSummary( CurOut(),
i_summaryLabel,
i_summaryTitle,
2 );
HF_SubTitleTable
aDetails( CurOut(),
i_detailsLabel,
i_detailsTitle,
1 );
for ( ; BOOL_OF(it_list); ++it_list )
{
const ary::idl::CodeEntity &
rCe = Env().Data().Find_Ce(*it_list);
Xml::Element &
rSummaryRow = aSummary.Add_Row();
produce_InternalLink(rSummaryRow, rCe);
produce_ShortDoc(rSummaryRow, rCe);
produce_MemberDetails(aDetails, rCe);
}
}
void
HtmlFactory_Idl::write_Docu( Xml::Element & o_screen,
const client & i_ce ) const
{
if (i_ce.Docu() != 0)
{
HF_DocEntryList
aDocuList( o_screen );
HF_IdlDocu
aDocu( Env(), aDocuList );
aDocu.Produce_byData(i_ce);
}
write_ManualLinks(o_screen, i_ce);
}
void
HtmlFactory_Idl::write_ManualLinks( Xml::Element & o_screen,
const client & i_ce ) const
{
const StringVector &
rLinks2Descrs = i_ce.Secondaries().Links2DescriptionInManual();
if ( rLinks2Descrs.size() == 0 )
return;
o_screen
>> *new Html::Label(C_sLocalManualLinks.c_str()+1) // Leave out the leading '#'.
<< " ";
HF_DocEntryList
aDocuList( o_screen );
aDocuList.Produce_Term("Developers Guide");
csv_assert(rLinks2Descrs.size() % 2 == 0);
for ( StringVector::const_iterator it = rLinks2Descrs.begin();
it != rLinks2Descrs.end();
++it )
{
Xml::Element &
rLink = aDocuList.Produce_Definition() >> *new Html::Link( Env().Link2Manual(*it));
if ( (*(it+1)).empty() )
// HACK KORR_FUTURE
// Research what happens with manual links which contain normal characters
// in non-utf-8 texts. And research, why utfF-8 does not work here.
rLink << new Xml::XmlCode(*it);
else
rLink << new Xml::XmlCode( *(it+1) );
++it;
} // end for
}
void
HtmlFactory_Idl::produce_MemberDetails( HF_SubTitleTable & o_table,
const client & ce ) const
{
// Dummy, which does not need to do anything.
}
void
HtmlFactory_Idl::recursive_ShowBases( Xml::Element & o_screen,
type_id i_baseType,
int & io_nDepth ) const
{
// go up:
const ary::idl::CodeEntity *
pCe = Env().Linker().Search_CeFromType(i_baseType);
if (pCe == 0)
{
HF_IdlTypeText
aText( Env(), o_screen, pCe != 0 );
aText.Produce_byData( i_baseType );
o_screen
<< "\n";
++io_nDepth;
return;
}
else
{
ary::idl::Type_id nBaseT = baseOf(*pCe);
if (nBaseT.IsValid())
recursive_ShowBases(o_screen,nBaseT,io_nDepth);
else
{
HF_IdlTypeText
aText( Env(), o_screen, true );
aText.Produce_byData(pCe->CeId());
o_screen
<< "\n";
++io_nDepth;
return;
}
}
// go back down:
csv_assert(io_nDepth > 0);
if (io_nDepth > 30)
io_nDepth = 30;
o_screen
<< (C_sSpace + 93 - 3*io_nDepth)
<< "|\n"
<< (C_sSpace + 93 - 3*io_nDepth)
<< "+-";
HF_IdlTypeText
aBaseLink( Env(), o_screen, true );
aBaseLink.Produce_byData(pCe->CeId());
o_screen
<< "\n";
++io_nDepth;
}
HtmlFactory_Idl::type_id
HtmlFactory_Idl::inq_BaseOf( const client & i_ce ) const
{
// Unused dummy.
return type_id(0);
}