| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| #include <precomp.h> |
| #include "opageenv.hxx" |
| |
| |
| // NOT FULLY DEFINED SERVICES |
| #include <cosv/ploc_dir.hxx> |
| #include <ary/cpp/c_ce.hxx> |
| #include <ary/cpp/c_class.hxx> |
| #include <ary/cpp/c_enum.hxx> |
| #include <ary/cpp/c_gate.hxx> |
| #include <ary/cpp/c_namesp.hxx> |
| #include <ary/cpp/c_tydef.hxx> |
| #include <ary/cpp/cp_ce.hxx> |
| #include <ary/loc/loc_file.hxx> |
| #include <udm/html/htmlitem.hxx> |
| #include <estack.hxx> |
| #include "hdimpl.hxx" |
| #include "strconst.hxx" |
| |
| |
| const String C_sCppDir( "names" ); |
| const String C_sIndexDir( "ix" ); |
| |
| |
| //************************ Implementation ********************// |
| |
| namespace |
| { |
| |
| void CreateDirectory( const csv::ploc::Path & i_rPath ); |
| |
| void |
| CreateDirectory( const csv::ploc::Path & i_rPath ) |
| { |
| csv::ploc::Directory aDirectory(i_rPath); |
| if (NOT aDirectory.Exists()) |
| aDirectory.PhysicalCreate(); |
| } |
| |
| //************************ CheshireCat ********************// |
| |
| struct InNamespaceTree |
| { |
| enum E_Type |
| { |
| t_unknown, |
| t_namespace, |
| t_type, |
| t_operations, |
| t_data |
| }; |
| |
| EStack< const ary::cpp::Namespace * > |
| aNamespaces; /// never empty. |
| EStack< const ary::cpp::Class * > |
| aClasses; /// maybe empty. |
| const ary::cpp::CodeEntity * |
| pCe; /// CurFileCe, maybe 0 |
| E_Type eType; |
| |
| InNamespaceTree( |
| const ary::cpp::Namespace & |
| i_rNsp ); |
| ~InNamespaceTree(); |
| void GoDown( |
| const ary::cpp::Namespace & |
| i_rNsp ); |
| void GoDown( |
| const ary::cpp::Class & |
| i_rClass ); |
| void GoUp(); |
| }; |
| |
| InNamespaceTree::InNamespaceTree( const ary::cpp::Namespace & i_rNsp ) |
| : // aNamespaces, |
| // aClasses, |
| pCe(0), |
| eType(t_unknown) |
| { |
| aNamespaces.push( &i_rNsp ); |
| } |
| |
| InNamespaceTree::~InNamespaceTree() |
| { |
| } |
| |
| void |
| InNamespaceTree::GoDown( const ary::cpp::Namespace & i_rNsp ) |
| { |
| aNamespaces.push(&i_rNsp); |
| aClasses.erase_all(); |
| pCe = 0; |
| eType = t_unknown; |
| } |
| |
| void |
| InNamespaceTree::GoDown( const ary::cpp::Class & i_rClass ) |
| { |
| aClasses.push(&i_rClass); |
| pCe = 0; |
| eType = t_unknown; |
| } |
| |
| void |
| InNamespaceTree::GoUp() |
| { |
| if ( NOT aClasses.empty() ) |
| aClasses.pop(); |
| else |
| aNamespaces.pop(); |
| pCe = 0; |
| eType = t_unknown; |
| } |
| |
| struct InIndex |
| { |
| char cLetter; |
| |
| InIndex() : cLetter('A') {} |
| }; |
| |
| |
| } // anonymous namespace |
| |
| |
| |
| |
| |
| struct OuputPage_Environment::CheshireCat |
| { |
| csv::ploc::Path aOutputRoot; |
| csv::ploc::Path aMyPath; |
| csv::StreamStr aFileName; |
| |
| const ary::cpp::Gate * |
| pGate; |
| const display::CorporateFrame * |
| pLayout; |
| intt nDepth; |
| |
| Dyn<InNamespaceTree> |
| pInNamespace; |
| Dyn<InIndex> pInIndex; |
| |
| CheshireCat( |
| const csv::ploc::Path & |
| io_rOutputDir, |
| const ary::cpp::Gate & |
| i_rGate, |
| const display::CorporateFrame & |
| i_rLayout ); |
| ~CheshireCat(); |
| void AddQualifiedName2Path( |
| const ary::cpp::CodeEntity & |
| i_rCe, |
| bool i_bIncludeLocalName ); |
| |
| const Dyn<InNamespaceTree> & |
| NspEnv() const { return pInNamespace; } |
| Dyn<InNamespaceTree> & |
| NspEnv() { return pInNamespace; } |
| const ary::cpp::Namespace * |
| Namespace() const { return pInNamespace ? pInNamespace->aNamespaces.top() : 0; } |
| const ary::cpp::Class * |
| Class() const { return pInNamespace ? (pInNamespace->aClasses.empty() ? 0 : pInNamespace->aClasses.top()) : 0; } |
| }; |
| |
| OuputPage_Environment:: |
| CheshireCat::CheshireCat( const csv::ploc::Path & io_rOutputDir, |
| const ary::cpp::Gate & i_rGate, |
| const display::CorporateFrame & i_rLayout ) |
| : aOutputRoot(io_rOutputDir), |
| aMyPath(io_rOutputDir), |
| aFileName(500), |
| pGate(&i_rGate), |
| pLayout(&i_rLayout), |
| nDepth(0), |
| pInNamespace(), |
| pInIndex() |
| { |
| } |
| |
| OuputPage_Environment:: |
| CheshireCat::~CheshireCat() |
| { |
| } |
| |
| void |
| OuputPage_Environment:: |
| CheshireCat::AddQualifiedName2Path( const ary::cpp::CodeEntity & i_rCe, |
| bool i_bIncludeLocalName ) |
| { |
| if (NOT i_rCe.Owner().IsValid()) |
| { |
| aMyPath.DirChain().PushBack( C_sCppDir ); |
| return; |
| } |
| |
| const ary::cpp::CodeEntity & |
| rParent = pGate->Ces().Find_Ce( i_rCe.Owner() ); |
| AddQualifiedName2Path( rParent, true ); |
| |
| if ( i_bIncludeLocalName ) |
| aMyPath.DirChain().PushBack( i_rCe.LocalName() ); |
| } |
| |
| |
| |
| //************************ OuputPage_Environment ********************// |
| |
| OuputPage_Environment::OuputPage_Environment( const csv::ploc::Path & io_rOutputDir, |
| const ary::cpp::Gate & i_rGate, |
| const display::CorporateFrame & i_rLayout ) |
| : pi( new CheshireCat(io_rOutputDir, i_rGate, i_rLayout) ) |
| { |
| } |
| |
| OuputPage_Environment::~OuputPage_Environment() |
| { |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_2Root() |
| { |
| pi->NspEnv() = 0; |
| pi->pInIndex = 0; |
| pi->nDepth = 0; |
| while ( pi->aMyPath.DirChain().Size() > pi->aOutputRoot.DirChain().Size() ) |
| pi->aMyPath.DirChain().PopBack(); |
| pi->aMyPath.SetFile(String ::Null_()); |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_2Names() |
| { |
| pi->NspEnv() = new InNamespaceTree( Gate().Ces().GlobalNamespace() ); |
| pi->aMyPath.DirChain().PushBack( C_sCppDir ); |
| pi->aMyPath.SetFile(String ::Null_()); |
| ++pi->nDepth; |
| |
| CreateDirectory( pi->aMyPath ); |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_Down2( const ary::cpp::Namespace & i_rNsp ) |
| { |
| csv_assert(i_rNsp.Depth() > 0); |
| csv_assert( pi->NspEnv() ); |
| csv_assert( pi->Namespace()->CeId() == i_rNsp.Owner() ); |
| |
| pi->NspEnv()->GoDown( i_rNsp ); |
| pi->aMyPath.DirChain().PushBack(i_rNsp.LocalName()); |
| ++pi->nDepth; |
| pi->aMyPath.SetFile(String ::Null_()); |
| |
| CreateDirectory( pi->aMyPath ); |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_Down2( const ary::cpp::Class & i_rClass ) |
| { |
| csv_assert( pi->NspEnv() ); |
| if ( i_rClass.Protection() == ary::cpp::PROTECT_global ) |
| { |
| csv_assert( pi->Namespace()->CeId() == i_rClass.Owner() ); |
| } |
| else |
| { |
| csv_assert( pi->Class() != 0 ); |
| csv_assert( pi->Class()->CeId() == i_rClass.Owner() ); |
| } |
| |
| pi->NspEnv()->GoDown(i_rClass); |
| pi->aMyPath.DirChain().PushBack(i_rClass.LocalName()); |
| pi->aMyPath.SetFile(String ::Null_()); |
| ++pi->nDepth; |
| |
| CreateDirectory( pi->aMyPath ); |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_2Index() |
| { |
| MoveDir_2Root(); |
| pi->pInIndex = new InIndex; |
| pi->aMyPath.DirChain().PushBack( String (C_sDIR_Index) ); |
| pi->aMyPath.SetFile(String ::Null_()); |
| pi->nDepth = 1; |
| |
| CreateDirectory( pi->aMyPath ); |
| } |
| |
| void |
| OuputPage_Environment::MoveDir_Up() |
| { |
| if ( pi->nDepth == 1 ) |
| { |
| MoveDir_2Root(); |
| return; |
| } |
| else if ( pi->NspEnv() ) |
| { |
| pi->NspEnv()->GoUp(); |
| pi->aMyPath.DirChain().PopBack(); |
| pi->aMyPath.SetFile(String ::Null_()); |
| --pi->nDepth; |
| } |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Css() |
| { |
| pi->aMyPath.SetFile( C_sHFN_Css ); |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Overview() |
| { |
| pi->aMyPath.SetFile( C_sHFN_Overview ); |
| } |
| |
| void |
| OuputPage_Environment::SetFile_AllDefs() |
| { |
| // Provisorium |
| pi->aMyPath.SetFile("def-all.html"); |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Index( char i_cLetter ) |
| { |
| csv_assert( 'A' <= i_cLetter AND i_cLetter <= 'Z' OR i_cLetter == '_' ); |
| |
| static StreamStr sIndexFileName(40); |
| sIndexFileName.seekp(0); |
| sIndexFileName << "index-"; |
| if ( i_cLetter == '_' ) |
| { |
| sIndexFileName << "27"; |
| } |
| else |
| { |
| sIndexFileName << int(i_cLetter -'A' + 1); |
| } |
| sIndexFileName << ".html"; |
| |
| pi->aMyPath.SetFile( sIndexFileName.c_str() ); |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Help() |
| { |
| pi->aMyPath.SetFile( C_sHFN_Help ); |
| } |
| |
| void |
| OuputPage_Environment::SetFile_CurNamespace() |
| { |
| csv_assert( pi->NspEnv() ); |
| pi->aMyPath.SetFile("index.html"); |
| pi->NspEnv()->pCe = pi->Namespace(); |
| pi->NspEnv()->eType = InNamespaceTree::t_namespace; |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Class( const ary::cpp::Class & i_rClass ) |
| { |
| csv_assert( pi->NspEnv() ); |
| pi->aMyPath.SetFile( ClassFileName(i_rClass.LocalName()) ); |
| pi->NspEnv()->pCe = &i_rClass; |
| pi->NspEnv()->eType = InNamespaceTree::t_type; |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Enum( const ary::cpp::Enum & i_rEnum ) |
| { |
| csv_assert( pi->NspEnv() ); |
| pi->aMyPath.SetFile( EnumFileName(i_rEnum.LocalName()) ); |
| pi->NspEnv()->pCe = &i_rEnum; |
| pi->NspEnv()->eType = InNamespaceTree::t_type; |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Typedef( const ary::cpp::Typedef & i_rTypedef ) |
| { |
| csv_assert( pi->NspEnv() ); |
| pi->aMyPath.SetFile( TypedefFileName(i_rTypedef.LocalName()) ); |
| pi->NspEnv()->pCe = &i_rTypedef; |
| pi->NspEnv()->eType = InNamespaceTree::t_type; |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Operations( const ary::loc::File * i_pFile ) |
| { |
| csv_assert( pi->NspEnv() ); |
| if ( CurClass() != 0 ) |
| pi->aMyPath.SetFile( "o.html" ); |
| else |
| { |
| csv_assert( i_pFile != 0 ); |
| pi->aMyPath.SetFile( HtmlFileName("o-", i_pFile->LocalName()) ); |
| } |
| pi->NspEnv()->pCe = 0; |
| pi->NspEnv()->eType = InNamespaceTree::t_operations; |
| } |
| |
| void |
| OuputPage_Environment::SetFile_Data( const ary::loc::File * i_pFile ) |
| { |
| csv_assert( pi->NspEnv() ); |
| if ( CurClass() != 0 ) |
| pi->aMyPath.SetFile( "d.html" ); |
| else |
| { |
| csv_assert( i_pFile != 0 ); |
| pi->aMyPath.SetFile( HtmlFileName("d-", i_pFile->LocalName()) ); |
| } |
| pi->NspEnv()->pCe = 0; |
| pi->NspEnv()->eType = InNamespaceTree::t_data; |
| } |
| |
| const ary::cpp::Namespace * |
| OuputPage_Environment::CurNamespace() const |
| { |
| return pi->Namespace(); |
| } |
| |
| const ary::cpp::Class * |
| OuputPage_Environment::CurClass() const |
| { |
| return pi->Class(); |
| } |
| |
| const csv::ploc::Path & |
| OuputPage_Environment::CurPath() const |
| { |
| return pi->aMyPath; |
| } |
| |
| const ary::cpp::Gate & |
| OuputPage_Environment::Gate() const |
| { |
| return *pi->pGate; |
| } |
| |
| const display::CorporateFrame & |
| OuputPage_Environment::Layout() const |
| { |
| return *pi->pLayout; |
| } |
| |
| uintt |
| OuputPage_Environment::Depth() const |
| { |
| return static_cast<uintt>(pi->nDepth); |
| } |
| |
| const String & |
| OuputPage_Environment::RepositoryTitle() const |
| { |
| return Gate().RepositoryTitle(); |
| } |
