PComplexData.h

Go to the documentation of this file.

//* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       src/base/PComplexData.h
//    Purpose:    Contains definition for the complex data type, held by the Variant Class
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    PEBL 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PCOMPLEXDATA_H__
#define __PCOMPLEXDATA_H__
 
//#include "PEBLObject.h"
 
#include "PList.h"
 
#include "../objects/PColor.h"
 
#ifdef PEBL_VALIDATOR
#include "../platforms/validator/PlatformEnvironment.h"
#include "../platforms/validator/PlatformWindow.h"
#include "../platforms/validator/PlatformImageBox.h"
#include "../platforms/validator/PlatformAudioOut.h"
#include "../platforms/validator/PlatformNetwork.h"
#include "../platforms/validator/PlatformJoystick.h"
#else
#include "../platforms/sdl/PlatformEnvironment.h"
#include "../platforms/sdl/PlatformWindow.h"
#include "../platforms/sdl/PlatformImageBox.h"
//#include "../platforms/sdl/PlatformFont.h"
//#include "../platforms/sdl/PlatformLabel.h"
//#include "../platforms/sdl/PlatformTextBox.h"
//#include "../platforms/sdl/PlatformKeyboard.h"
//#include "../platforms/sdl/PlatformDrawObject.h"
//#include "../platforms/sdl/PlatformCanvas.h"
//#include "../platforms/sdl/PlatformMovie.h"
#include "../platforms/sdl/PlatformAudioOut.h"
#include "../platforms/sdl/PlatformNetwork.h"
#include "../platforms/sdl/PlatformJoystick.h"
#endif
#include "../devices/PStream.h"
#include "../utility/rc_ptrs.h"
#include "../devices/PParallelPort.h"
#include "../devices/PComPort.h"
 
#include <iostream>
 
 
 
 
 
 
 
 
class PComplexData
{
public:
 
 
    //Constructors
    PComplexData();
    PComplexData(const counted_ptr<PEBLObjectBase> & object);
 
    //     PComplexData(counted_ptr<PlatformEnvironment>);
//     PComplexData(counted_ptr<PlatformWindow>);
//     PComplexData(counted_ptr<PColor>);
//     PComplexData(counted_ptr<PlatformFont>);
//     PComplexData(counted_ptr<PlatformLabel>);
//     PComplexData(counted_ptr<PlatformTextBox> );
//     PComplexData(counted_ptr<PlatformImageBox>);
//     PComplexData(counted_ptr<PlatformKeyboard>);
//     PComplexData(counted_ptr<PStream>);
//     PComplexData(counted_ptr<PlatformAudioOut>);
//     PComplexData(counted_ptr<PlatformDrawObject>);
 
 
    PComplexData(const PComplexData & pcd);
 
    PComplexData(const PComplexData * pcd);
 
 
    ~PComplexData();
 
 
    //Overload of the << operator
    friend std::ostream & operator <<(std::ostream & out, const PComplexData & pcd );
 
 
 
 
    //'Get' Methods.
 
    ComplexDataType GetType() const;
    std::string  GetTypeName() const;
 
 
 
    //The following are convenience accessors; do not
    //destroy or mangle the returned object.
 
    PList *    GetList() const;
//     counted_ptr<PlatformEnvironment>   GetEnvironment() const;
//     counted_ptr<PlatformWindow>        GetWindow() const;
//     counted_ptr<PColor>                GetColor() const;
//     counted_ptr<PlatformFont>          GetFont() const;
//     counted_ptr<PlatformLabel>         GetLabel() const;
//     counted_ptr<PlatformTextBox>       GetTextBox() const;
//     counted_ptr<PlatformImageBox>      GetImageBox() const;
//     counted_ptr<PlatformKeyboard>      GetKeyboard() const;
//     counted_ptr<PlatformDrawObject>    GetDrawObject() const;
//     counted_ptr<PStream>               GetFileStream() const;
//     counted_ptr<PlatformAudioOut>      GetAudioOut() const;
 
    counted_ptr<PEBLObjectBase> GetObject() const;
    counted_ptr<PEBLObjectBase> GetPEBLObject() const;
 
    //This is no longer under control of the counted pointer system.
    PlatformWidget * GetWidget() const;   //Returns pointer to a widget, whatever it is.
 
 
    //'IsX' methods
    bool IsList() const;
    bool IsEnvironment()const;
    bool IsWidget() const;
    bool IsWindow() const;
    bool IsColor() const;
    bool IsFont() const;
    bool IsTextObject() const;
    bool IsLabel() const;
    bool IsTextBox() const;
    bool IsImageBox() const;
    bool IsKeyboard() const;
    bool IsFileStream() const;
    bool IsAudioOut() const;
    bool IsNetworkConnection() const;
    bool IsDrawObject() const;
    bool IsThickLine() const;
    bool IsDrawCircle() const;
    bool IsDrawSquare() const;
    bool IsDrawRectangle() const;
    bool IsCanvas() const;
    bool IsJoystick() const;
    bool IsParallelPort() const;
    bool IsComPort() const;
    bool IsMovie() const;
    bool IsCustomObject()const;
 
 
 
    void SetProperty(std::string, Variant v);
    Variant GetProperty(std::string prop) const;
    bool PropertyExists(std::string prop)const;
 
protected:
    //Inheritable function for use by << operator.
    std::ostream & SendToStream(std::ostream& out) const;
 
 
private:
 
    //This isn't very efficient--each of these gets
    //created whenever a PCD is created (or copied), and each
    //will get destroyed as well.
 
    counted_ptr<PEBLObjectBase>  mPEBLObject;
 
//     counted_ptr<PList>                mList;
//     counted_ptr<PlatformEnvironment>  mEnvironment;
//     counted_ptr<PlatformWindow>       mWindow;
//     counted_ptr<PColor>               mColor;
//     counted_ptr<PlatformFont>         mFont;
//     counted_ptr<PlatformLabel>        mLabel;
//     counted_ptr<PlatformTextBox>      mTextBox;
//     counted_ptr<PlatformImageBox>     mImageBox;
//     counted_ptr<PlatformKeyboard>     mKeyboard;
//     counted_ptr<PStream>              mFileStream;
//     counted_ptr<PlatformAudioOut>     mAudioOut;
 
//     counted_ptr<PlatformDrawObject>   mDrawObject;
};
 
 
#endif