tdepim/kode/function.h

/*
    This file is part of kdepim.

    Copyright (c) 2004 Cornelius Schumacher <schumacher@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KODE_FUNCTION_H
#define KODE_FUNCTION_H

#include "code.h"

#include <tqvaluelist.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include <kdepimmacros.h>

namespace KODE {

class KDE_EXPORT Function
{
  public:
    typedef TQValueList<Function> List;

    enum AccessSpecifier { Public = 1, Protected = 2, Private = 4, Signal = 8, Slot = 16 };

    Function();
    Function( const TQString &name, const TQString &returnType = TQString::null,
              int access = Public, bool isStatic = false );

    void setConst( bool isConst );
    bool isConst() const { return mIsConst; }
    
    void setStatic( bool isStatic );
    bool isStatic() const { return mIsStatic; }
    
    void addArgument( const TQString &argument );
    void setArgumentString( const TQString &argumentString );
    
    void addInitializer( const TQString & );
    TQStringList initializers() const { return mInitializers; }
    
    void setBody( const TQString &body );
    void setBody( const Code &code );
    void addBodyLine( const TQString &bodyLine );

    void setAccess( int );
    int access() const { return mAccess; }
    TQString accessAsString() const;

    void setReturnType( const TQString & );
    TQString returnType() const { return mReturnType; }

    void setName( const TQString & );
    TQString name() const { return mName; }

    TQStringList arguments() const { return mArguments; }

    TQString body() const { return mBody; }

    void setDocs( const TQString & );
    TQString docs() const { return mDocs; }

  private:
    int mAccess;
    bool mIsConst;
    bool mIsStatic;
    TQString mReturnType;
    TQString mName;
    TQStringList mArguments;
    TQStringList mInitializers;
    TQString mBody;
    TQString mDocs;
};

}

#endif