autodoc/source/parser/cpp/cxt2ary.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cxt2ary.cxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include <precomp.h>
  32 #include "cxt2ary.hxx"
  33
  34
  35 // NOT FULLY DEFINED SERVICES
  36 #include <ary/entity.hxx>
  37 #include <ary/cpp/c_class.hxx>
  38 #include <ary/cpp/c_define.hxx>
  39 #include <ary/cpp/c_enum.hxx>
  40 #include <ary/cpp/c_enuval.hxx>
  41 #include <ary/cpp/c_funct.hxx>
  42 #include <ary/cpp/c_macro.hxx>
  43 #include <ary/cpp/c_tydef.hxx>
  44 #include <ary/cpp/c_vari.hxx>
  45 #include <ary/cpp/c_gate.hxx>
  46 #include <ary/cpp/cp_ce.hxx>
  47 #include <ary/loc/loc_file.hxx>
  48 #include <ary/doc/d_oldcppdocu.hxx>
  49 #include <ary/info/docstore.hxx>
  50 #include "icprivow.hxx"
  51
  52 // Implementationheaders, only to be used in this file!
  53 #include "sfscope.hxx"
  54 #include "sownstck.hxx"
  55 #include "sdocdist.hxx"
  56 #include "srecover.hxx"
  57
  58
  59
  60
  61
  62 namespace cpp
  63 {
  64
  65 using ary::cpp::E_Protection;
  66
  67 ContextForAry::ContextForAry( ary::cpp::Gate &  io_rAryGate )
  68     :   pGate(&io_rAryGate),
  69         aTokenResult(),
  70         pFileScopeInfo( new S_FileScopeInfo ),
  71         pOwnerStack( new S_OwnerStack ),
  72         pDocuDistributor( new S_DocuDistributor ),
  73         pRecoveryGuard( new S_RecoveryGuard )
  74 {
  75     OpenNamespace( pGate->Ces().GlobalNamespace() );
  76 }
  77
  78 ContextForAry::~ContextForAry()
  79 {
  80 }
  81
  82 ary::loc::File &
  83 ContextForAry::inq_CurFile() const
  84 {
  85     csv_assert(pFileScopeInfo->pCurFile != 0);
  86
  87     return *pFileScopeInfo->pCurFile;
  88 }
  89
  90 ary::cpp::Namespace &
  91 ContextForAry::inq_CurNamespace() const
  92 {
  93     return pOwnerStack->CurNamespace();
  94 }
  95
  96 ary::cpp::Class *
  97 ContextForAry::inq_CurClass() const
  98 {
  99     return pOwnerStack->CurClass();
 100 }
 101
 102 ary::cpp::Enum *
 103 ContextForAry::inq_CurEnum() const
 104 {
 105     return pOwnerStack->CurEnum();
 106 }
 107
 108
 109 ary::cpp::InputContext::Owner &
 110 ContextForAry::inq_CurOwner() const
 111 {
 112     return pOwnerStack->CurOwner();
 113 }
 114
 115 E_Protection
 116 ContextForAry::inq_CurProtection() const
 117 {
 118     return pOwnerStack->CurProtection();
 119 }
 120
 121 void
 122 ContextForAry::do_SetTokenResult( E_TokenDone                   i_eDone,
 123                                   E_EnvStackAction          i_eWhat2DoWithEnvStack,
 124                                   ParseEnvironment *    i_pParseEnv2Push )
 125 {
 126     aTokenResult.eDone = i_eDone;
 127     aTokenResult.eStackAction = i_eWhat2DoWithEnvStack;
 128     aTokenResult.pEnv2Push = i_pParseEnv2Push;
 129 }
 130
 131 void
 132 ContextForAry::do_OpenNamespace( ary::cpp::Namespace & io_rOpenedNamespace )
 133 {
 134     pOwnerStack->OpenNamespace( io_rOpenedNamespace );
 135 }
 136
 137 void
 138 ContextForAry::do_OpenExternC( bool )
 139 {
 140     pOwnerStack->OpenExternC();
 141     // KORR_FUTURE
 142     // use i_bOnlyForOneDeclaration
 143 }
 144
 145 void
 146 ContextForAry::do_OpenClass( ary::cpp::Class & io_rOpenedClass )
 147 {
 148     pOwnerStack->OpenClass(io_rOpenedClass);
 149     pDocuDistributor->SetCurrentlyStoredRe(io_rOpenedClass);
 150 }
 151
 152 void
 153 ContextForAry::do_OpenEnum(     ary::cpp::Enum & io_rOpenedEnum )
 154 {
 155     pOwnerStack->OpenEnum(io_rOpenedEnum);
 156     pDocuDistributor->SetCurrentlyStoredRe(io_rOpenedEnum);
 157 }
 158
 159 void
 160 ContextForAry::do_CloseBlock()
 161 {
 162     pOwnerStack->CloseBlock();
 163 }
 164
 165 void
 166 ContextForAry::do_CloseClass()
 167 {
 168     pOwnerStack->CloseClass();
 169 }
 170
 171 void
 172 ContextForAry::do_CloseEnum()
 173 {
 174     pOwnerStack->CloseEnum();
 175 }
 176
 177 void
 178 ContextForAry::do_SetCurProtection( ary::cpp::E_Protection i_eProtection )
 179 {
 180     pOwnerStack->SetCurProtection(i_eProtection);
 181 }
 182
 183 void
 184 ContextForAry::do_OpenTemplate( const StringVector & i_rParameters )
 185 {
 186     pFileScopeInfo->pCurTemplateParameters = new StringVector(i_rParameters);
 187 }
 188
 189 DYN StringVector *
 190 ContextForAry::do_Get_CurTemplateParameters()
 191 {
 192     return pFileScopeInfo->pCurTemplateParameters.Release();
 193 }
 194
 195 void
 196 ContextForAry::do_Close_OpenTemplate()
 197 {
 198     if (pFileScopeInfo->pCurTemplateParameters)
 199         delete pFileScopeInfo->pCurTemplateParameters.Release();
 200 }
 201
 202 void
 203 ContextForAry::do_Event_Class_FinishedBase( const String & )
 204 {
 205     // KORR_FUTURE
 206 }
 207
 208 void
 209 ContextForAry::do_Event_Store_Typedef( ary::cpp::Typedef & io_rTypedef )
 210 {
 211     pDocuDistributor->SetCurrentlyStoredRe(io_rTypedef);
 212 }
 213
 214 void
 215 ContextForAry::do_Event_Store_EnumValue( ary::cpp::EnumValue & io_rEnumValue )
 216 {
 217     pDocuDistributor->SetCurrentlyStoredRe(io_rEnumValue);
 218 }
 219
 220 void
 221 ContextForAry::do_Event_Store_CppDefinition( ary::cpp::DefineEntity & io_rDefinition )
 222 {
 223     pDocuDistributor->SetCurrentlyStoredRe(io_rDefinition);
 224 }
 225
 226 void
 227 ContextForAry::do_Event_EnterFunction_ParameterList()
 228 {
 229     // KORR_FUTURE
 230     // Inform pDocuDistributor about possibility of parameters' inline documentation.
 231 }
 232
 233 void
 234 ContextForAry::do_Event_Function_FinishedParameter( const String & )
 235 {
 236     // KORR_FUTURE
 237 }
 238
 239 void
 240 ContextForAry::do_Event_LeaveFunction_ParameterList()
 241 {
 242     // KORR_FUTURE
 243 }
 244
 245 void
 246 ContextForAry::do_Event_EnterFunction_Implementation()
 247 {
 248     // KORR_FUTURE
 249 }
 250
 251 void
 252 ContextForAry::do_Event_LeaveFunction_Implementation()
 253 {
 254     // KORR_FUTURE
 255 }
 256
 257 void
 258 ContextForAry::do_Event_Store_Function( ary::cpp::Function & io_rFunction )
 259 {
 260     pDocuDistributor->SetCurrentlyStoredRe(io_rFunction);
 261 }
 262
 263
 264 void
 265 ContextForAry::do_Event_Store_Variable( ary::cpp::Variable & io_rVariable )
 266 {
 267     pDocuDistributor->SetCurrentlyStoredRe(io_rVariable);
 268 }
 269
 270 void
 271 ContextForAry::do_TakeDocu( DYN ary::doc::OldCppDocu & let_drInfo )
 272 {
 273     let_drInfo.Store2(*pDocuDistributor);
 274 }
 275
 276 void
 277 ContextForAry::do_StartWaitingFor_Recovery()
 278 {
 279     pRecoveryGuard->StartWaitingFor_Recovery();
 280 }
 281
 282 ary::cpp::Gate &
 283 ContextForAry::inq_AryGate() const
 284 {
 285      return * const_cast< ary::cpp::Gate* >(pGate);
 286 }
 287
 288 const ary::cpp::InputContext &
 289 ContextForAry::inq_Context() const
 290 {
 291     return *this;
 292 }
 293
 294 String
 295 ContextForAry::inq_CurFileName() const
 296 {
 297     return pFileScopeInfo->pCurFile != 0
 298             ?   pFileScopeInfo->pCurFile->LocalName()
 299             :   String::Null_();
 300 }
 301
 302 uintt
 303 ContextForAry::inq_LineCount() const
 304 {
 305     return pFileScopeInfo->nLineCount;
 306 }
 307
 308 bool
 309 ContextForAry::inq_IsWaitingFor_Recovery() const
 310 {
 311     return pRecoveryGuard->IsWithinRecovery();
 312 }
 313
 314 bool
 315 ContextForAry::inq_IsExternC() const
 316 {
 317      return pOwnerStack->IsExternC();
 318 }
 319
 320 void
 321 ContextForAry::do_SetCurFile( ary::loc::File &  io_rCurFile )
 322 {
 323     pFileScopeInfo->pCurFile = &io_rCurFile;
 324     pFileScopeInfo->nLineCount = 0;
 325     pFileScopeInfo->pCurTemplateParameters = 0;
 326
 327     pOwnerStack->Reset();
 328     pDocuDistributor->Reset();
 329     pRecoveryGuard->Reset();
 330 }
 331
 332 void
 333 ContextForAry::do_Event_IncrLineCount()
 334 {
 335     ++pFileScopeInfo->nLineCount;
 336     pDocuDistributor->Event_LineBreak();
 337 }
 338
 339 void
 340 ContextForAry::do_Event_SwBracketOpen()
 341 {
 342     pRecoveryGuard->Hdl_SwBracketOpen();
 343 }
 344
 345 void
 346 ContextForAry::do_Event_SwBracketClose()
 347 {
 348     pRecoveryGuard->Hdl_SwBracketClose();
 349 }
 350
 351 void
 352 ContextForAry::do_Event_Semicolon()
 353 {
 354     pRecoveryGuard->Hdl_Semicolon();
 355 }
 356
 357
 358
 359
 360 }   // namespace cpp