autodoc/source/parser/inc/tokens/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_CPP_TOKPROCT_HXX
  32 #define ADC_CPP_TOKPROCT_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40
  41
  42 class ParseEnvironment;
  43
  44 /**     is a parent class for classes, which take part in parsing tokens semantically.
  45     It provides some types for them.
  46 */
  47 class TokenProcessing_Types
  48 {
  49   public:
  50     enum E_TokenDone
  51     {
  52         not_done = 0,
  53         done = 1
  54     };
  55
  56     enum E_EnvStackAction
  57     {
  58         stay,                   // same parse environment
  59         push,                   // push sub environment
  60         pop_success,    // return to parent environment, parsing was successful
  61         pop_failure     // return to parent environment, but an error occured.
  62     };
  63
  64     struct TokenProcessing_Result
  65     {
  66         E_TokenDone                     eDone;
  67         E_EnvStackAction        eStackAction;
  68         ParseEnvironment *      pEnv2Push;
  69
  70                             TokenProcessing_Result()
  71                                                 : eDone(not_done), eStackAction(stay), pEnv2Push(0) {}
  72         void                            Reset()                         { eDone = not_done; eStackAction = stay; pEnv2Push = 0; }
  73     };
  74
  75     enum E_ParseResult
  76     {
  77         res_error,
  78         res_complete,
  79         res_predeclaration
  80     };
  81 };
  82
  83
  84
  85 #endif
  86