office-gobmx/autodoc/source/display/idl/hi_main.cxx
2002-11-29 09:20:06 +00:00

696 lines
22 KiB
C++

/*************************************************************************
*
* $RCSfile: hi_main.cxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: np $ $Date: 2002-11-29 10:20:06 $
*
* 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_main.hxx"
// NOT FULLY DEFINED SERVICES
#include <algorithm>
#include <cosv/ploc.hxx>
#include <cosv/file.hxx>
#include <ary/idl/i_ce.hxx>
#include <ary/idl/ik_ce.hxx>
#include <ary/idl/ik_enum.hxx>
#include <ary/idl/ik_exception.hxx>
#include <ary/idl/ik_interface.hxx>
#include <ary/idl/ik_service.hxx>
#include <ary/idl/ik_struct.hxx>
#include <ary/idl/ik_typedef.hxx>
#include <cfrstd.hxx>
#include <toolkit/htmlfile.hxx>
#include <toolkit/out_position.hxx>
#include <toolkit/out_tree.hxx>
#include "hfi_constgroup.hxx"
#include "hfi_enum.hxx"
#include "hfi_globalindex.hxx"
#include "hfi_interface.hxx"
#include "hfi_module.hxx"
#include "hfi_struct.hxx"
#include "hfi_service.hxx"
#include "hfi_singleton.hxx"
#include "hfi_typedef.hxx"
#include "hfi_xrefpage.hxx"
#include "hi_env.hxx"
#include "hi_linkhelper.hxx"
using ::ary::idl::Ce_id;
using ::ary::idl::Type_id;
using ::ary::idl::ifc_ce::Dyn_CeIterator;
/*
typedef ::ary::Dyn_StdConstIterator< ::ary::idl::CommentedReference>
Dyn_ComRefIterator;
namespace read_module = ::ary::idl::ifc_module;
namespace read_interface = ::ary::idl::ifc_interface;
namespace read_service = ::ary::idl::ifc_service;
namespace read_struct = ::ary::idl::ifc_struct;
namespace read_exception = ::ary::idl::ifc_exception;
namespace read_enum = ::ary::idl::ifc_enum;
namespace read_typedef = ::ary::idl::ifc_typedef;
namespace read_constgroup = ::ary::idl::ifc_constantsgroup;
*/
namespace
{
/** @resp
Inits (constructor) and creates (destructor) the current
html documentation file ( MainDisplay_Idl.pMyFile ).
*/
class Guard_CurFile
{
public:
Guard_CurFile( /// For CodeEntities
DocuFile_Html & io_client,
HtmlEnvironment_Idl &
io_env,
const ary::idl::CodeEntity &
i_ce,
const String & i_titlePrefix );
Guard_CurFile( /// For Use pages
DocuFile_Html & io_client,
HtmlEnvironment_Idl &
io_env,
const String & i_fileName,
const String & i_titlePrefix );
Guard_CurFile( /// For Modules
DocuFile_Html & io_client,
HtmlEnvironment_Idl &
io_env,
const ary::idl::CodeEntity &
i_ce );
Guard_CurFile( /// For Indices
DocuFile_Html & io_client,
HtmlEnvironment_Idl &
io_env,
char i_letter );
~Guard_CurFile();
private:
DocuFile_Html & rClient;
HtmlEnvironment_Idl &
rEnv;
};
/** @resp
Sets and releases the current factory pointer
( MainDisplay_Idl.pCurFactory ).
*/
class Guard_CurFactoryPtr
{
public:
Guard_CurFactoryPtr(
HtmlFactory_Idl *& io_client,
HtmlFactory_Idl & i_factory )
: rpClient(io_client)
{ rpClient = &i_factory; }
~Guard_CurFactoryPtr()
{ rpClient = 0; }
private:
HtmlFactory_Idl *& rpClient;
};
Guard_CurFile::Guard_CurFile( DocuFile_Html & io_client,
HtmlEnvironment_Idl & io_env,
const ary::idl::CodeEntity & i_ce,
const String & i_titlePrefix )
: rClient(io_client),
rEnv(io_env)
{ // For Ces
io_env.Set_CurFile( StreamLock(100)() << i_ce.LocalName()
<< ".html"
<< c_str );
StreamLock aCurFilePath(700);
io_env.Get_CurFilePath(aCurFilePath());
rClient.EmptyBody();
rClient.SetLocation( aCurFilePath().c_str() );
rClient.SetTitle( StreamLock(100)() << i_titlePrefix << " " << i_ce.LocalName() << c_str );
io_env.Set_CurPageCe(&i_ce);
}
Guard_CurFile::Guard_CurFile( DocuFile_Html & io_client,
HtmlEnvironment_Idl & io_env,
const String & i_fileName,
const String & i_titlePrefix )
: rClient(io_client),
rEnv(io_env)
{ // For Use pages
io_env.Set_CurFile( StreamLock(100)() << i_fileName
<< ".html"
<< c_str );
StreamLock aCurFilePath(700);
io_env.Get_CurFilePath(aCurFilePath());
rClient.EmptyBody();
rClient.SetLocation( aCurFilePath().c_str() );
rClient.SetTitle( StreamLock(100)() << i_titlePrefix << " " << i_fileName << c_str );
io_env.Set_CurPageCe(0);
}
Guard_CurFile::Guard_CurFile( DocuFile_Html & io_client,
HtmlEnvironment_Idl & io_env,
const ary::idl::CodeEntity & i_ce )
: rClient(io_client),
rEnv(io_env)
{ // For Modules
io_env.Set_CurFile( output::ModuleFileName() );
StreamLock aCurFilePath(700);
io_env.Get_CurFilePath(aCurFilePath());
rClient.EmptyBody();
rClient.SetLocation( aCurFilePath().c_str() );
rClient.SetTitle( StreamLock(100)() << "Module " << io_env.CurPosition().Name() << c_str );
io_env.Set_CurPageCe(&i_ce);
}
Guard_CurFile::Guard_CurFile( DocuFile_Html & io_client,
HtmlEnvironment_Idl & io_env,
char i_letter )
: rClient(io_client),
rEnv(io_env)
{ // For Index pages
io_env.Set_CurFile( StreamLock(100)() << "index-"
<< ( i_letter != '_'
? int(i_letter)-'a'+1
: 27 )
<< ".html"
<< c_str );
StreamLock aCurFilePath(700);
io_env.Get_CurFilePath(aCurFilePath());
rClient.EmptyBody();
rClient.SetLocation( aCurFilePath().c_str() );
rClient.SetTitle( StreamLock(100)() << "Global Index "
<< ( i_letter != '_'
? char(i_letter-'a'+'A')
: '_' )
<< c_str );
}
Guard_CurFile::~Guard_CurFile()
{
rClient.CreateFile();
rEnv.Set_CurPageCe(0);
}
} // anonymous namespace
MainDisplay_Idl::MainDisplay_Idl( HtmlEnvironment_Idl & io_rEnv )
: pEnv(&io_rEnv),
pMyFile(new DocuFile_Html),
pCurFactory(0)
{
pMyFile->SetStyle( Env().Layout().CssStyle() );
pMyFile->SetCopyright( Env().Layout().CopyrightText() );
}
MainDisplay_Idl::~MainDisplay_Idl()
{
}
void
MainDisplay_Idl::WriteGlobalIndices()
{
for ( const char * pLetter = "abcdefghijklmnopqrstuvwxyz_X"; *pLetter != 'X'; ++pLetter )
{
Guard_CurFile gFile( *pMyFile, Env(), *pLetter );
HF_IdlGlobalIndex aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_Page( ary::idl::alphabetical_index::E_Letter(*pLetter) );
} // end for
}
void
MainDisplay_Idl::do_Module( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce );
HF_IdlModule aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_Interface( const ary::idl::CodeEntity & i_ce )
{
do_InterfaceDescr(i_ce);
do_Interface2s(i_ce);
}
void
MainDisplay_Idl::do_Service( const ary::idl::CodeEntity & i_ce )
{
do_ServiceDescr(i_ce);
do_Service2s(i_ce);
}
void
MainDisplay_Idl::do_Struct( const ary::idl::CodeEntity & i_ce )
{
do_StructDescr(i_ce);
do_Struct2s(i_ce);
}
void
MainDisplay_Idl::do_Exception( const ary::idl::CodeEntity & i_ce )
{
do_ExceptionDescr(i_ce);
do_Exception2s(i_ce);
}
void
MainDisplay_Idl::do_Enum( const ary::idl::CodeEntity & i_ce )
{
do_EnumDescr(i_ce);
do_Enum2s(i_ce);
}
void
MainDisplay_Idl::do_Typedef( const ary::idl::CodeEntity & i_ce )
{
do_TypedefDescr(i_ce);
do_Typedef2s(i_ce);
}
void
MainDisplay_Idl::do_ConstantsGroup( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Constants' Group" );
HF_IdlConstGroup aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_Singleton( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Singleton" );
HF_IdlSingleton aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_InterfaceDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Interface" );
HF_IdlInterface aInterface( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aInterface);
aInterface.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_ServiceDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Service" );
HF_IdlService aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_StructDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Struct" );
HF_IdlStruct aFactory( *pEnv, pMyFile->Body(), false );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_ExceptionDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Exception" );
HF_IdlStruct aFactory( *pEnv, pMyFile->Body(), true );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_EnumDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Enum" );
HF_IdlEnum aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_TypedefDescr( const ary::idl::CodeEntity & i_ce )
{
Guard_CurFile gFile( *pMyFile,
Env(),
i_ce,
"Typedef" );
HF_IdlTypedef aFactory( *pEnv, pMyFile->Body() );
Guard_CurFactoryPtr gFactory(pCurFactory,aFactory);
aFactory.Produce_byData(i_ce);
}
void
MainDisplay_Idl::do_Interface2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Interface" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Interface,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_interface::xref::Get_Derivations(pXrefList,i_ce);
aUses.Produce_List(
"Derived Interfaces",
"#Deriveds",
*pXrefList );
ary::idl::ifc_interface::xref::Get_SynonymTypedefs(pXrefList,i_ce);
aUses.Produce_List(
"Synonym Typedefs",
"#Synonyms",
*pXrefList );
ary::idl::ifc_interface::xref::Get_ExportingServices(pXrefList,i_ce);
aUses.Produce_List(
"Services which Support this Interface",
"#SupportingServices",
*pXrefList );
ary::idl::ifc_interface::xref::Get_AsReturns(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Return Type",
"#Returns",
*pXrefList );
ary::idl::ifc_interface::xref::Get_AsParameters(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Parameter",
"#Parameters",
*pXrefList );
ary::idl::ifc_interface::xref::Get_AsDataTypes(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Data Type",
"#DataTypes",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}
void
MainDisplay_Idl::do_Service2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Service" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Service,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_service::xref::Get_IncludingServices(pXrefList,i_ce);
aUses.Produce_List(
"Services which Include this Service",
"#IncludingServices",
*pXrefList );
ary::idl::ifc_service::xref::Get_InstantiatingSingletons(pXrefList,i_ce);
aUses.Produce_List(
"Singletons which Instantiate this Service",
"#Singletons",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}
void
MainDisplay_Idl::do_Struct2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Struct" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Struct,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_struct::xref::Get_Derivations(pXrefList,i_ce);
aUses.Produce_List(
"Derived Structs",
"#Deriveds",
*pXrefList );
ary::idl::ifc_struct::xref::Get_SynonymTypedefs(pXrefList,i_ce);
aUses.Produce_List(
"Synonym Typedefs",
"#Synonyms",
*pXrefList );
ary::idl::ifc_struct::xref::Get_AsReturns(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Return Type",
"#Returns",
*pXrefList );
ary::idl::ifc_struct::xref::Get_AsParameters(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Parameter",
"#Parameters",
*pXrefList );
ary::idl::ifc_struct::xref::Get_AsDataTypes(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Data Type",
"#DataTypes",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}
void
MainDisplay_Idl::do_Exception2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Exception" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Exception,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_exception::xref::Get_Derivations(pXrefList,i_ce);
aUses.Produce_List(
"Derived Exceptions",
"#Deriveds",
*pXrefList );
ary::idl::ifc_exception::xref::Get_RaisingFunctions(pXrefList,i_ce);
aUses.Produce_List(
"Raising Functions",
"#Raisers",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}
void
MainDisplay_Idl::do_Enum2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Enum" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Enum,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_enum::xref::Get_SynonymTypedefs(pXrefList,i_ce);
aUses.Produce_List(
"Synonym Typedefs",
"#Synonyms",
*pXrefList );
ary::idl::ifc_enum::xref::Get_AsReturns(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Return Type",
"#Returns",
*pXrefList );
ary::idl::ifc_enum::xref::Get_AsParameters(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Parameter",
"#Parameters",
*pXrefList );
ary::idl::ifc_enum::xref::Get_AsDataTypes(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Data Type",
"#DataTypes",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}
void
MainDisplay_Idl::do_Typedef2s( const ary::idl::CodeEntity & i_ce )
{
String sUsesFileName(
StreamLock(100)()
<< i_ce.LocalName()
<< Env().Linker().XrefsSuffix()
<< c_str );
Guard_CurFile gFile( *pMyFile,
Env(),
sUsesFileName,
"Uses of Typedef" );
HF_IdlXrefs aUses( *pEnv,
pMyFile->Body(),
C_sCePrefix_Typedef,
i_ce );
Dyn_CeIterator pXrefList;
ary::idl::ifc_typedef::xref::Get_SynonymTypedefs(pXrefList,i_ce);
aUses.Produce_List(
"Synonym Typedefs",
"#Synonyms",
*pXrefList );
ary::idl::ifc_typedef::xref::Get_AsReturns(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Return Type",
"#Returns",
*pXrefList );
ary::idl::ifc_typedef::xref::Get_AsParameters(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Parameter",
"#Parameters",
*pXrefList );
ary::idl::ifc_typedef::xref::Get_AsDataTypes(pXrefList,i_ce);
aUses.Produce_List(
"Uses as Data Type",
"#DataTypes",
*pXrefList );
aUses.Write_ManualLinks(i_ce);
}