/data/gitorious.org/libyui/libyui-master/src/YProperty.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program 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.

This program 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 this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                                      |
|                                         (c) SuSE Linux Products GmbH |
\----------------------------------------------------------------------/

  File:         YProperty.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YProperty_h
#define YProperty_h

#include <string>
#include <vector>

using std::string;


enum YPropertyType
{
    YUnknownPropertyType = 0,
    YOtherProperty,             // requires futher checking
    YStringProperty,            // const string &
    YBoolProperty,              // bool
    YIntegerProperty            // YCP Integer == C++ long long
};

class YWidget;
class YProperty;

typedef long long       YInteger;


class YProperty
{
public:
    YProperty( const string & name, YPropertyType type, bool isReadOnly = false )
        : _name( name )
        , _type( type )
        , _isReadOnly( isReadOnly )
        {}

    string name() const { return _name; }

    YPropertyType type() const { return _type; }

    bool isReadOnly() const { return _isReadOnly; }

    string typeAsStr() const { return YProperty::typeAsStr( _type ); }

    static string typeAsStr( YPropertyType type );

private:

    string              _name;
    YPropertyType       _type;
    bool                _isReadOnly;
};


class YPropertyValue
{
public:

    YPropertyValue( const string & str ):
        _type( YStringProperty ), _stringVal( str ) {}

    YPropertyValue( const char * str ):
        _type( YStringProperty ), _stringVal( str ) {}

    explicit YPropertyValue( bool b ):
        _type( YBoolProperty ), _boolVal( b ) {}

    explicit YPropertyValue( YInteger num ):
        _type( YIntegerProperty ), _integerVal( num ) {}

    explicit YPropertyValue( int num ):
        _type( YIntegerProperty ), _integerVal( num ) {}

    explicit YPropertyValue( YPropertyType type ) :
        _type( type ) {}

    YPropertyValue():
        _type( YUnknownPropertyType ) {}

    ~YPropertyValue();

    YPropertyType type() const { return _type; }

    string typeAsStr() const { return YProperty::typeAsStr( _type ); }

    string      stringVal()     const { return _stringVal;      }
    bool        boolVal()       const { return _boolVal;        }
    YInteger    integerVal()    const { return _integerVal;     }


private:

    YPropertyType       _type;
    string              _stringVal;
    bool                _boolVal;
    YInteger            _integerVal;
};


class YPropertySet
{
public:
    YPropertySet();

    void check( const string & propertyName ) const;

    void check( const string & propertyName, YPropertyType type ) const;

    void check( const YProperty & prop ) const
        { check( prop.name(), prop.type() ); }

    bool contains( const string & propertyName ) const throw();

    bool contains( const string & propertyName, YPropertyType type ) const;

    bool contains( const YProperty & prop ) const
        { return contains( prop.name(), prop.type() ); }

    bool isEmpty() const { return _properties.empty(); }

    int size() const { return (int) _properties.size(); }

    void add( const YProperty & prop );

    void add( const YPropertySet & otherSet );

    typedef std::vector<YProperty>::const_iterator const_iterator;

    const_iterator propertiesBegin() const;

    const_iterator propertiesEnd() const;

private:

    std::vector<YProperty> _properties;
};


#endif // YProperty_h