autodoc/source/parser/cpp/preproc.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: preproc.hxx,v $
  10  * $Revision: 1.4 $
  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_PREPROC_HXX
  32 #define ADC_CPP_PREPROC_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39 #include <deque>
  40     // PARAMETERS
  41
  42 class CharacterSource;
  43
  44
  45 namespace cpp
  46 {
  47
  48 class Token;
  49 class CodeExplorer;
  50 class DefineDescription;
  51
  52
  53 class PreProcessor
  54 {
  55   public:
  56     typedef std::map< String, DefineDescription* > MacroMap;
  57
  58     // LIFECYCLE
  59                         PreProcessor();
  60                         ~PreProcessor();
  61     // OPERATONS
  62     void                AssignPartners(
  63                             CodeExplorer &      o_rCodeExplorer,
  64                             CharacterSource &   o_rCharSource,
  65                             const MacroMap &    i_rCurValidDefines );
  66     void                Process_Token(
  67                             cpp::Token &        let_drToken );
  68     void                UnblockMacro(
  69                             const char *        i_sMacroName );
  70   private:
  71     public: // Necessary for instantiation of static variable:
  72     enum E_State
  73     {
  74         plain = 0,
  75         expect_macro_bracket_left,
  76         expect_macro_param,
  77         state_MAX
  78     };
  79     typedef void (PreProcessor::*                   F_TOKENPROC )(cpp::Token &);
  80     void                On_plain( cpp::Token & );
  81     void                On_expect_macro_bracket_left( cpp::Token & );
  82     void                On_expect_macro_param( cpp::Token & );
  83
  84     private:  // Reprivate again:
  85     typedef std::deque< DYN cpp::Token * >          TokenQueue;
  86     typedef StringVector                  List_MacroParams;
  87
  88
  89     bool                CheckForDefine(
  90                             cpp::Token &        let_drToken );
  91     void                InterpretMacro();
  92
  93     // DATA
  94     static F_TOKENPROC  aTokProcs[state_MAX];
  95         // Referenced extern objects
  96     CodeExplorer *      pCppExplorer;
  97     CharacterSource *   pSourceText;
  98     const MacroMap *    pCurValidDefines;
  99
 100         // internal data
 101     TokenQueue          aTokens;
 102
 103     E_State             eState;
 104
 105     DefineDescription * pCurMacro;
 106     DYN Token *         dpCurMacroName;
 107     List_MacroParams    aCurMacroParams;
 108     csv::StreamStr      aCurParamText;
 109
 110     intt                nBracketInParameterCounter;
 111     StringVector        aBlockedMacroNames;
 112 };
 113
 114
 115
 116 }   // end namespace cpp
 117
 118 #endif
 119