autodoc/source/parser_i/inc/tokens/tkp2.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: tkp2.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_TKP2_HXX
  32 #define ADC_TKP2_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37 class CharacterSource;
  38 class TkpContext;
  39     // PARAMETRS
  40
  41
  42
  43 /** This is the interface for parser classes, which get a sequence of Token s from
  44     a text.
  45
  46     Start() starts to parse the text from the given i_rSource.
  47     GetNextToken() returns a Token on the heap as long as there are
  48     still characters in the text left. The last time GetNextToken()
  49     returns NULL.
  50
  51     The algorithms for parsing tokens from the text are an issue of
  52     the derived classes.
  53 */
  54 class TokenParse2
  55 {
  56   public:
  57     // LIFECYCLE
  58                         TokenParse2();
  59     virtual                             ~TokenParse2() {}
  60
  61     // OPERATIONS
  62     virtual void                Start(
  63                             CharacterSource &
  64                                             i_rSource );
  65
  66     /** @short  Gets the next identifiable token out of the
  67         source code.
  68         @return true, if there was passed a valid token.
  69                 false, if the parsed stream is finished or
  70                        an error occured.
  71     */
  72     bool                                GetNextToken();
  73
  74   private:
  75     virtual void                SetStartContext() = 0;
  76     virtual void        SetCurrentContext(
  77                             TkpContext &                io_rContext ) = 0;
  78     virtual TkpContext &
  79                         CurrentContext() = 0;
  80     // DATA
  81     CharacterSource *   pChars;
  82 };
  83
  84
  85 #endif
  86
  87