office-gobmx/autodoc/source/parser/cpp/defdescr.hxx

139 lines
4.3 KiB
C++

/*************************************************************************
*
* $RCSfile: defdescr.hxx,v $
*
* $Revision: 1.1.1.1 $
*
* last change: $Author: np $ $Date: 2002-03-08 14:45:29 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef ADC_CPP_DEFDESCR_HXX
#define ADC_CPP_DEFDESCR_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
namespace cpp
{
/** Describes a C/C++ #define statement. May be a define or a macro, for which
two cases the two different constructors are to be used.
This class is used by cpp::PreProcessor.
*/
class DefineDescription
{
public:
enum E_DefineType
{
type_define,
type_macro
};
typedef StringVector str_vector;
DefineDescription( /// Used for: #define DEFINE xyz
const udmstri & i_sName,
const str_vector & i_rDefinition );
DefineDescription( /// Used for: #define MACRO(...) abc
const udmstri & i_sName,
const str_vector & i_rParams,
const str_vector & i_rDefinition );
~DefineDescription();
/// Only vaild if (eDefineType == type_define) else returns "".
void GetDefineText(
csv::StreamStr & o_rText ) const;
/// Only vaild if (eDefineType == type_macro) else returns "".
void GetMacroText(
csv::StreamStr & o_rText,
const StringVector &
i_rGivenArguments ) const;
uintt ParamCount() const;
E_DefineType DefineType() const;
private:
// DATA
udmstri sName;
str_vector aParams;
str_vector aDefinition;
E_DefineType eDefineType;
};
// IMPLEMENTATION
inline uintt
DefineDescription::ParamCount() const
{ return aParams.size(); }
inline DefineDescription::E_DefineType
DefineDescription::DefineType() const
{ return eDefineType; }
} // end namespace cpp
#endif