autodoc/source/parser/cpp/c_dealer.hxx

   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: c_dealer.hxx,v $
  10  * $Revision: 1.5 $
  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 #ifndef ADC_CPP_C_DEALER_HXX
  32 #define ADC_CPP_C_DEALER_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <cpp/ctokdeal.hxx>
  39 #include <adoc/atokdeal.hxx>
  40 #include <ary/info/docstore.hxx>
  41     // COMPONENTS
  42 #include "preproc.hxx"
  43 #include "c_rcode.hxx"
  44 #include <adoc/a_rdocu.hxx>
  45     // PARAMETERS
  46
  47 namespace csv
  48 {
  49     namespace ploc
  50     {
  51         class Path;
  52         class DirectoryChain;
  53     }
  54 }
  55
  56
  57 class TokenParser;
  58
  59
  60 namespace cpp
  61 {
  62
  63 class PE_File;
  64 class DefineDescription;
  65
  66
  67 class Distributor : public cpp::TokenDealer,        /// Handle C++ code tokens.
  68                     public adoc::TokenDealer        /// Handle Autodoc documentation tokens.
  69 {
  70   public:
  71     typedef std::map< String, DefineDescription* >     MacroMap;
  72
  73     // LIFECYCLE
  74                         Distributor(
  75                             ary::cpp::Gate &    io_rGate );
  76                         ~Distributor();
  77     // OPERATIONS
  78     void                                AssignPartners(
  79                             CharacterSource &   io_rSourceText,
  80                             const MacroMap &    i_rValidMacros );
  81     void                StartNewFile(
  82                             const csv::ploc::Path &
  83                                                 i_file );
  84     virtual void                Deal_Eol();
  85     virtual void                Deal_Eof();
  86
  87     virtual void                Deal_CppCode(
  88                             cpp::Token &                let_drToken );
  89     virtual void        Deal_Cpp_UnblockMacro(
  90                             Tok_UnblockMacro &  let_drToken );
  91
  92     virtual void                Deal_AdcDocu(
  93                             adoc::Token &               let_drToken );
  94     virtual Distributor *
  95                         AsDistributor();
  96   private:
  97     // DATA
  98     PreProcessor        aCppPreProcessor;
  99     CodeExplorer            aCodeExplorer;
 100     adoc::DocuExplorer  aDocuExplorer;
 101     ary::cpp::Gate *    pGate;
 102     FileScope_EventHandler *
 103                         pFileEventHandler;
 104     DocuDealer *        pDocuDistributor;
 105 };
 106
 107
 108
 109 }   // namespace cpp
 110 #endif
 111