autodoc/inc/parser/parserinfo.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: parserinfo.hxx,v $
  10  * $Revision: 1.4 $
  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_PARSERINFO_HXX
  32 #define ADC_PARSERINFO_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37     // PARAMETERS
  38
  39 /** Interface about current state of parsing.
  40 */
  41 class ParserInfo
  42 {
  43   public:
  44     // OPERATIONS
  45     void                Set_CurFile(
  46                             const String &      i_file,
  47                             bool                i_bUseLines = false)
  48                                                 { sCurFile = i_file;
  49                                                   nCurLine = i_bUseLines ? 1 : 0; }
  50     void                Increment_CurLine()
  51                                                 { ++nCurLine; }
  52
  53     // INQUIRY
  54     const String &      CurFile() const         { return sCurFile; }
  55     uintt               CurLine() const         { return nCurLine; }
  56
  57   protected:
  58     // LIFECYCLE
  59                         ParserInfo()            : sCurFile(), nCurLine(0) {}
  60                         ~ParserInfo()           {}
  61   private:
  62     String              sCurFile;
  63     uintt                               nCurLine;
  64
  65 };
  66
  67 #endif