autodoc/source/parser_i/inc/s2_luidl/tokproct.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: tokproct.hxx,v $
  10  * $Revision: 1.3 $
  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_TOKPROCT_HXX
  32 #define ADC_TOKPROCT_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40
  41
  42 namespace csi
  43 {
  44 namespace uidl
  45 {
  46
  47
  48 class UnoIDL_PE;
  49
  50
  51 /**     is a parent class for classes, which take part in parsing tokens semantically.
  52     It provides some types for them.
  53 */
  54 class TokenProcessing_Types
  55 {
  56   public:
  57     enum E_TokenDone
  58     {
  59         not_done = 0,
  60         done = 1
  61     };
  62
  63     enum E_EnvStackAction
  64     {
  65         stay,                   // same parse environment
  66         push_sure,      // push sub environment, which must be the correct one
  67         push_try,       // push sub environment, which is tried, if it may be the right one
  68         pop_success,    // return to parent environment, parsing was successful
  69         pop_failure     // return to parent environment, but an error occured.
  70     };
  71
  72     struct TokenProcessing_Result
  73     {
  74         E_TokenDone                     eDone;
  75         E_EnvStackAction        eStackAction;
  76         UnoIDL_PE *                     pEnv2Push;
  77
  78                             TokenProcessing_Result()
  79                                                 : eDone(not_done), eStackAction(stay), pEnv2Push(0) {}
  80         void                            reset()                         { eDone = not_done; eStackAction = stay; pEnv2Push = 0; }
  81     };
  82
  83     enum E_ParseResult
  84     {
  85         res_error,
  86         res_complete,
  87         res_predeclaration
  88     };
  89 };
  90
  91
  92 }   // namespace uidl
  93 }   // namespace csi
  94
  95 #endif
  96