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_HTML_HD_DOCU_HXX 25*b1cdbd2cSJim Jagielski #define ADC_DISPLAY_HTML_HD_DOCU_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski // BASE CLASSES 28*b1cdbd2cSJim Jagielski #include <ary/ary_disp.hxx> 29*b1cdbd2cSJim Jagielski #include <ary/info/infodisp.hxx> 30*b1cdbd2cSJim Jagielski #include <cosv/tpl/processor.hxx> 31*b1cdbd2cSJim Jagielski #include "hdimpl.hxx" 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski namespace ary 34*b1cdbd2cSJim Jagielski { 35*b1cdbd2cSJim Jagielski namespace cpp 36*b1cdbd2cSJim Jagielski { 37*b1cdbd2cSJim Jagielski class Namespace; 38*b1cdbd2cSJim Jagielski class Class; 39*b1cdbd2cSJim Jagielski class Enum; 40*b1cdbd2cSJim Jagielski class Typedef; 41*b1cdbd2cSJim Jagielski class Function; 42*b1cdbd2cSJim Jagielski class Variable; 43*b1cdbd2cSJim Jagielski } 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski namespace doc 46*b1cdbd2cSJim Jagielski { 47*b1cdbd2cSJim Jagielski class Documentation; 48*b1cdbd2cSJim Jagielski } 49*b1cdbd2cSJim Jagielski namespace info 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski class DocuText; 52*b1cdbd2cSJim Jagielski } 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski class QualifiedName; 55*b1cdbd2cSJim Jagielski } 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski class OuputPage_Environment; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski class Docu_Display : public ary::Display, 61*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Namespace>, 62*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Class>, 63*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Enum>, 64*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Typedef>, 65*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Function>, 66*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::cpp::Variable>, 67*b1cdbd2cSJim Jagielski public csv::ConstProcessor<ary::doc::Documentation>, 68*b1cdbd2cSJim Jagielski public ary::info::DocuDisplay, 69*b1cdbd2cSJim Jagielski private HtmlDisplay_Impl 70*b1cdbd2cSJim Jagielski { 71*b1cdbd2cSJim Jagielski public: 72*b1cdbd2cSJim Jagielski Docu_Display( 73*b1cdbd2cSJim Jagielski OuputPage_Environment & 74*b1cdbd2cSJim Jagielski io_rEnv ); 75*b1cdbd2cSJim Jagielski virtual ~Docu_Display(); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski void Assign_Out( 78*b1cdbd2cSJim Jagielski csi::xml::Element & o_rOut ); 79*b1cdbd2cSJim Jagielski void Unassign_Out(); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski virtual void Display_StdTag( 82*b1cdbd2cSJim Jagielski const ary::info::StdTag & 83*b1cdbd2cSJim Jagielski i_rData ); 84*b1cdbd2cSJim Jagielski virtual void Display_BaseTag( 85*b1cdbd2cSJim Jagielski const ary::info::BaseTag & 86*b1cdbd2cSJim Jagielski i_rData ); 87*b1cdbd2cSJim Jagielski virtual void Display_ExceptionTag( 88*b1cdbd2cSJim Jagielski const ary::info::ExceptionTag & 89*b1cdbd2cSJim Jagielski i_rData ); 90*b1cdbd2cSJim Jagielski virtual void Display_ImplementsTag( 91*b1cdbd2cSJim Jagielski const ary::info::ImplementsTag & 92*b1cdbd2cSJim Jagielski i_rData ); 93*b1cdbd2cSJim Jagielski virtual void Display_KeywordTag( 94*b1cdbd2cSJim Jagielski const ary::info::KeywordTag & 95*b1cdbd2cSJim Jagielski i_rData ); 96*b1cdbd2cSJim Jagielski virtual void Display_ParameterTag( 97*b1cdbd2cSJim Jagielski const ary::info::ParameterTag & 98*b1cdbd2cSJim Jagielski i_rData ); 99*b1cdbd2cSJim Jagielski virtual void Display_SeeTag( 100*b1cdbd2cSJim Jagielski const ary::info::SeeTag & 101*b1cdbd2cSJim Jagielski i_rData ); 102*b1cdbd2cSJim Jagielski virtual void Display_TemplateTag( 103*b1cdbd2cSJim Jagielski const ary::info::TemplateTag & 104*b1cdbd2cSJim Jagielski i_rData ); 105*b1cdbd2cSJim Jagielski virtual void Display_LabelTag( 106*b1cdbd2cSJim Jagielski const ary::info::LabelTag & 107*b1cdbd2cSJim Jagielski i_rData ); 108*b1cdbd2cSJim Jagielski virtual void Display_SinceTag( 109*b1cdbd2cSJim Jagielski const ary::info::SinceTag & 110*b1cdbd2cSJim Jagielski i_rData ); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski virtual void Display_DT_Text( 113*b1cdbd2cSJim Jagielski const ary::info::DT_Text & 114*b1cdbd2cSJim Jagielski i_rData ); 115*b1cdbd2cSJim Jagielski virtual void Display_DT_MaybeLink( 116*b1cdbd2cSJim Jagielski const ary::info::DT_MaybeLink & 117*b1cdbd2cSJim Jagielski i_rData ); 118*b1cdbd2cSJim Jagielski virtual void Display_DT_Whitespace( 119*b1cdbd2cSJim Jagielski const ary::info::DT_Whitespace & 120*b1cdbd2cSJim Jagielski i_rData ); 121*b1cdbd2cSJim Jagielski virtual void Display_DT_Eol( 122*b1cdbd2cSJim Jagielski const ary::info::DT_Eol & 123*b1cdbd2cSJim Jagielski i_rData ); 124*b1cdbd2cSJim Jagielski virtual void Display_DT_Xml( 125*b1cdbd2cSJim Jagielski const ary::info::DT_Xml & 126*b1cdbd2cSJim Jagielski i_rData ); 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski using csv::ConstProcessor<ary::doc::Documentation>::Process; 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski private: 131*b1cdbd2cSJim Jagielski // Interface csv::ConstProcessor<>: 132*b1cdbd2cSJim Jagielski virtual void do_Process( 133*b1cdbd2cSJim Jagielski const ary::cpp::Namespace & 134*b1cdbd2cSJim Jagielski i_rData ); 135*b1cdbd2cSJim Jagielski virtual void do_Process( 136*b1cdbd2cSJim Jagielski const ary::cpp::Class & 137*b1cdbd2cSJim Jagielski i_rData ); 138*b1cdbd2cSJim Jagielski virtual void do_Process( 139*b1cdbd2cSJim Jagielski const ary::cpp::Enum & 140*b1cdbd2cSJim Jagielski i_rData ); 141*b1cdbd2cSJim Jagielski virtual void do_Process( 142*b1cdbd2cSJim Jagielski const ary::cpp::Typedef & 143*b1cdbd2cSJim Jagielski i_rData ); 144*b1cdbd2cSJim Jagielski virtual void do_Process( 145*b1cdbd2cSJim Jagielski const ary::cpp::Function & 146*b1cdbd2cSJim Jagielski i_rData ); 147*b1cdbd2cSJim Jagielski virtual void do_Process( 148*b1cdbd2cSJim Jagielski const ary::cpp::Variable & 149*b1cdbd2cSJim Jagielski i_rData ); 150*b1cdbd2cSJim Jagielski virtual void do_Process( 151*b1cdbd2cSJim Jagielski const ary::doc::Documentation & 152*b1cdbd2cSJim Jagielski i_rData ); 153*b1cdbd2cSJim Jagielski // Interface ary::Display: 154*b1cdbd2cSJim Jagielski virtual const ary::cpp::Gate * 155*b1cdbd2cSJim Jagielski inq_Get_ReFinder() const; 156*b1cdbd2cSJim Jagielski // Locals 157*b1cdbd2cSJim Jagielski void Start_DocuBlock(); 158*b1cdbd2cSJim Jagielski void Finish_DocuBlock(); 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski void Write_TagTitle( 161*b1cdbd2cSJim Jagielski const char * i_sText, 162*b1cdbd2cSJim Jagielski const char * i_nFontSize = "+0" ); 163*b1cdbd2cSJim Jagielski void Write_TagContents( 164*b1cdbd2cSJim Jagielski const ary::info::DocuText & 165*b1cdbd2cSJim Jagielski i_rDocuText ); 166*b1cdbd2cSJim Jagielski void Write_Text( 167*b1cdbd2cSJim Jagielski const ary::info::DocuText & 168*b1cdbd2cSJim Jagielski i_rDocuText ); 169*b1cdbd2cSJim Jagielski void Write_TextToken( 170*b1cdbd2cSJim Jagielski const String & i_sText ); 171*b1cdbd2cSJim Jagielski void Write_LinkableText( 172*b1cdbd2cSJim Jagielski const ary::QualifiedName & 173*b1cdbd2cSJim Jagielski i_sQuName ); 174*b1cdbd2cSJim Jagielski void Write_QualifiedName( 175*b1cdbd2cSJim Jagielski const ary::QualifiedName & 176*b1cdbd2cSJim Jagielski i_sQuName ); 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski // DATA 179*b1cdbd2cSJim Jagielski bool bUseHtmlInDocuTokens; 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski /** This is used, if a class documentation is displayed, 182*b1cdbd2cSJim Jagielski because for links to members then the "current class" 183*b1cdbd2cSJim Jagielski is not the parent, but this class itself. 184*b1cdbd2cSJim Jagielski */ 185*b1cdbd2cSJim Jagielski const ary::cpp::Class * 186*b1cdbd2cSJim Jagielski pCurClassOverwrite; 187*b1cdbd2cSJim Jagielski }; 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski #endif 193