1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef ADC_DISPLAY_HI_ENV_HXX 25*b1cdbd2cSJim Jagielski #define ADC_DISPLAY_HI_ENV_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski // USED SERVICES 29*b1cdbd2cSJim Jagielski // BASE CLASSES 30*b1cdbd2cSJim Jagielski // COMPONENTS 31*b1cdbd2cSJim Jagielski #include <cosv/ploc.hxx> 32*b1cdbd2cSJim Jagielski #include <cosv/ploc_dir.hxx> 33*b1cdbd2cSJim Jagielski // PARAMETERS 34*b1cdbd2cSJim Jagielski #include <toolkit/out_position.hxx> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski namespace ary 37*b1cdbd2cSJim Jagielski { 38*b1cdbd2cSJim Jagielski namespace idl 39*b1cdbd2cSJim Jagielski { 40*b1cdbd2cSJim Jagielski class Gate; 41*b1cdbd2cSJim Jagielski class CodeEntity; 42*b1cdbd2cSJim Jagielski } 43*b1cdbd2cSJim Jagielski } 44*b1cdbd2cSJim Jagielski namespace display 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski class CorporateFrame; 47*b1cdbd2cSJim Jagielski } 48*b1cdbd2cSJim Jagielski namespace output 49*b1cdbd2cSJim Jagielski { 50*b1cdbd2cSJim Jagielski class Tree; 51*b1cdbd2cSJim Jagielski } 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski class AryAccess; 54*b1cdbd2cSJim Jagielski class LinkHelper; 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski /** @resp 57*b1cdbd2cSJim Jagielski Provides enviroment information to the HTML factory 58*b1cdbd2cSJim Jagielski classes. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @descr 61*b1cdbd2cSJim Jagielski All information that is not included in the data, especially 62*b1cdbd2cSJim Jagielski about the layout of the output tree and the access to 63*b1cdbd2cSJim Jagielski information from the repository are provided here. 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @see HtmlFactory 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski class HtmlEnvironment_Idl 68*b1cdbd2cSJim Jagielski { 69*b1cdbd2cSJim Jagielski public: 70*b1cdbd2cSJim Jagielski // LIFECYCLE 71*b1cdbd2cSJim Jagielski HtmlEnvironment_Idl( 72*b1cdbd2cSJim Jagielski const csv::ploc::Path & 73*b1cdbd2cSJim Jagielski io_rOutputDir, 74*b1cdbd2cSJim Jagielski const ary::idl::Gate & 75*b1cdbd2cSJim Jagielski i_rGate, 76*b1cdbd2cSJim Jagielski const display::CorporateFrame & 77*b1cdbd2cSJim Jagielski i_rLayout ); 78*b1cdbd2cSJim Jagielski ~HtmlEnvironment_Idl(); 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski // OPERATIONS 81*b1cdbd2cSJim Jagielski void Goto_Directory( 82*b1cdbd2cSJim Jagielski output::Position i_pos, 83*b1cdbd2cSJim Jagielski bool i_bCreateDirectoryIfNecessary ); 84*b1cdbd2cSJim Jagielski void Goto_DirectoryLevelDown( 85*b1cdbd2cSJim Jagielski const String & i_subDirName, 86*b1cdbd2cSJim Jagielski bool i_bCreateDirectoryIfNecessary ); 87*b1cdbd2cSJim Jagielski void Goto_DirectoryLevelUp(); 88*b1cdbd2cSJim Jagielski void Set_CurFile( 89*b1cdbd2cSJim Jagielski const String & i_fileName ); Set_CurPageCe(const ary::idl::CodeEntity * i_ce)90*b1cdbd2cSJim Jagielski void Set_CurPageCe( 91*b1cdbd2cSJim Jagielski const ary::idl::CodeEntity * 92*b1cdbd2cSJim Jagielski i_ce ) 93*b1cdbd2cSJim Jagielski { pCurPageCe = i_ce; } 94*b1cdbd2cSJim Jagielski // INQUIRY 95*b1cdbd2cSJim Jagielski const ary::idl::Gate & Gate() const96*b1cdbd2cSJim Jagielski Gate() const { return *pGate; } Data() const97*b1cdbd2cSJim Jagielski const AryAccess & Data() const { return *pData; } 98*b1cdbd2cSJim Jagielski const char * Link2Manual( 99*b1cdbd2cSJim Jagielski const String & i_link ) const; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski /// This may be reimplemented for removing dead links to members. Is_MemberExistenceCheckRequired() const102*b1cdbd2cSJim Jagielski bool Is_MemberExistenceCheckRequired() const 103*b1cdbd2cSJim Jagielski { return false; } 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /// @return Holds only the current directory, not the current file. CurPosition() const106*b1cdbd2cSJim Jagielski output::Position & CurPosition() const { return aCurPosition; } Get_CurFilePath(StreamStr & o_buffer) const107*b1cdbd2cSJim Jagielski void Get_CurFilePath( 108*b1cdbd2cSJim Jagielski StreamStr & o_buffer ) const 109*b1cdbd2cSJim Jagielski { o_buffer << aCurPath; } 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski const display::CorporateFrame & Layout() const112*b1cdbd2cSJim Jagielski Layout() const { return *pLayout; } Linker() const113*b1cdbd2cSJim Jagielski const LinkHelper & Linker() const { return *pLinker; } 114*b1cdbd2cSJim Jagielski Get_LinkTo(StreamStr & o_result,output::Position i_destination)115*b1cdbd2cSJim Jagielski void Get_LinkTo( 116*b1cdbd2cSJim Jagielski StreamStr & o_result, 117*b1cdbd2cSJim Jagielski output::Position i_destination ) 118*b1cdbd2cSJim Jagielski { CurPosition().Get_LinkTo(o_result, i_destination); } 119*b1cdbd2cSJim Jagielski String CurPageCe_AsText() const; 120*b1cdbd2cSJim Jagielski String CurPageCe_AsFile( 121*b1cdbd2cSJim Jagielski const char * i_sEnding) const; 122*b1cdbd2cSJim Jagielski const ary::idl::CodeEntity * CurPageCe() const123*b1cdbd2cSJim Jagielski CurPageCe() const { return pCurPageCe; } 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski // ACCESS OutputTree()126*b1cdbd2cSJim Jagielski output::Tree & OutputTree() { return *pOutputTree; } 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski private: 129*b1cdbd2cSJim Jagielski // Local 130*b1cdbd2cSJim Jagielski void create_Directory( 131*b1cdbd2cSJim Jagielski const csv::ploc::Path & 132*b1cdbd2cSJim Jagielski i_path ); 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski // DATA 135*b1cdbd2cSJim Jagielski csv::ploc::Directory 136*b1cdbd2cSJim Jagielski aOutputRoot; 137*b1cdbd2cSJim Jagielski csv::ploc::Path aCurPath; 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski Dyn<AryAccess> pData; /// @invariant *pData is valid. 140*b1cdbd2cSJim Jagielski const ary::idl::Gate * 141*b1cdbd2cSJim Jagielski pGate; /// @invariant pGate != 0. 142*b1cdbd2cSJim Jagielski Dyn<output::Tree> pOutputTree; /// @invariant *pOutputTree is valid. 143*b1cdbd2cSJim Jagielski mutable output::Position 144*b1cdbd2cSJim Jagielski aCurPosition; 145*b1cdbd2cSJim Jagielski const ary::idl::CodeEntity * 146*b1cdbd2cSJim Jagielski pCurPageCe; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski const display::CorporateFrame * 149*b1cdbd2cSJim Jagielski pLayout; 150*b1cdbd2cSJim Jagielski 151*b1cdbd2cSJim Jagielski Dyn<LinkHelper> pLinker; 152*b1cdbd2cSJim Jagielski }; 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski #endif 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski 158