Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef ADC_TKP2_HXX
      21             : #define ADC_TKP2_HXX
      22             : 
      23             : // USED SERVICES
      24             :     // BASE CLASSES
      25             :     // COMPONENTS
      26             : class CharacterSource;
      27             : class TkpContext;
      28             :     // PARAMETRS
      29             : 
      30             : 
      31             : 
      32             : /** This is the interface for parser classes, which get a sequence of Token s from
      33             :     a text.
      34             : 
      35             :     Start() starts to parse the text from the given i_rSource.
      36             :     GetNextToken() returns a Token on the heap as long as there are
      37             :     still characters in the text left. The last time GetNextToken()
      38             :     returns NULL.
      39             : 
      40             :     The algorithms for parsing tokens from the text are an issue of
      41             :     the derived classes.
      42             : */
      43             : class TokenParse2
      44             : {
      45             :   public:
      46             :     // LIFECYCLE
      47             :                         TokenParse2();
      48           3 :     virtual             ~TokenParse2() {}
      49             : 
      50             :     // OPERATIONS
      51             :     virtual void        Start(
      52             :                             CharacterSource &
      53             :                                             i_rSource );
      54             : 
      55             :     /** @short  Gets the next identifiable token out of the
      56             :         source code.
      57             :         @return true, if there was passed a valid token.
      58             :                 false, if the parsed stream is finished or
      59             :                        an error occurred.
      60             :     */
      61             :     bool                GetNextToken();
      62             : 
      63             :   private:
      64             :     virtual void        SetStartContext() = 0;
      65             :     virtual void        SetCurrentContext(
      66             :                             TkpContext &        io_rContext ) = 0;
      67             :     virtual TkpContext &
      68             :                         CurrentContext() = 0;
      69             :     // DATA
      70             :     CharacterSource *   pChars;
      71             : };
      72             : 
      73             : 
      74             : #endif
      75             : 
      76             : 
      77             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */