autodoc/source/parser/inc/tokens/stmstate.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: stmstate.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_STMSTATE_HXX
  32 #define ADC_STMSTATE_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37     // PARAMETERS
  38 class StmArrayStatus;
  39 class StmBoundsStatus;
  40
  41 /**     A StmStatus is a state within a StateMachine.
  42     There are two kinds of it.  Either its an array of pointers to
  43     other states within the state machine - an ArrayStatus.
  44
  45     Or it is a BoundsStatus, which shows, the token cannot be
  46     followed further within the StateMachine.
  47 **/
  48 class StmStatus // := "State machine status"
  49 {
  50   public:
  51     typedef intt                Branch;                 /// Values >= 0 give a next #Status' ID.
  52                                         /// Values <= 0 tell, that a token is finished.
  53                                         /// a value < 0 returns the status back to an upper level state machine.
  54         // LIFECYCLE
  55     virtual                     ~StmStatus() {}
  56
  57         // OPERATIONS
  58     virtual StmArrayStatus *
  59                         AsArray();
  60     virtual StmBoundsStatus *
  61                         AsBounds();
  62
  63         // INQUIRY
  64     virtual bool                IsADefault() const = 0;
  65 };
  66
  67
  68
  69 #endif
  70
  71