Attributes.h

Go to the documentation of this file.

#ifndef OPAL_Attributes_HH
#define OPAL_Attributes_HH
 
// ------------------------------------------------------------------------
// $RCSfile: Attributes.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Namespace Attributes
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:37 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------
 
#include "AbstractObjects/Attribute.h"
#include "Parser/Token.h"
 
#include <initializer_list>
#include <list>
#include <string>
#include <vector>
 
class PlaceRep;
class RangeRep;
class TableRowRep;
 
// Namespace Attributes.
// ------------------------------------------------------------------------
//  their values.
//  Each exemplar constructor must use these functions to fill in the
//  attribute handlers for all command attributes.
//  This namespace is part of the interface to the class Attribute,
//  used to store object attributes.
 
namespace Attributes {
 
    //  Initial value undefined.
    extern Attribute makeBool(const std::string &name, const std::string &help);
 
    //  Initial value defined.
    extern Attribute
    makeBool(const std::string &name, const std::string &help, bool initial);
 
    //  Evaluate any expression and return value.
    //  If the expression is non-deferred, the value is cached.
    //  Re-evaluation takes place only if a new definition has been read.
    bool getBool(const Attribute &);
 
    extern void setBool(Attribute &, bool);
 
 
    //  Initial value is empty array.
    extern Attribute makeBoolArray(const std::string &name, const std::string &help);
 
    extern std::vector<bool> getBoolArray(const Attribute &);
 
    extern void setBoolArray(Attribute &, const std::vector<bool> &);
 
 
    //  Initial value is "#S".
    extern Attribute makePlace(const std::string &name, const std::string &help);
 
    extern PlaceRep getPlace(const Attribute &);
 
    extern void setPlace(Attribute &, const PlaceRep &);
 
 
    //  Initial value is "FULL".
    extern Attribute makeRange(const std::string &name, const std::string &help);
 
    extern RangeRep getRange(const Attribute &);
 
    extern void setRange(Attribute &, const RangeRep &);
 
 
    //  Initial value is undefined.
    extern Attribute
    makeReal(const std::string &name, const std::string &help);
 
    //  Initial value is defined.
    extern Attribute
    makeReal(const std::string &name, const std::string &help, double initial);
 
    extern double getReal(const Attribute &attr);
 
    extern void setReal(Attribute &attr, double val);
 
 
    //  Initial value is empty array.
    extern Attribute makeRealArray(const std::string &name, const std::string &help);
 
    extern std::vector<double> getRealArray(const Attribute &);
 
    extern void setRealArray(Attribute &, const std::vector<double> &);
 
 
    //  Initial value is undefined.
    extern Attribute makeReference(const std::string &name, const std::string &help);
 
 
    //  Initial value undefined.
    extern Attribute makeString(const std::string &name, const std::string &help);
 
    //  Initial value is defined.
    extern Attribute
    makeString(const std::string &name, const std::string &help, const std::string &initial);
 
    extern std::string getString(const Attribute &attr);
 
    extern void setString(Attribute &attr, const std::string &val);
 
    //  Initial value undefined.
    extern Attribute makePredefinedString(const std::string &name,
                                          const std::string &help,
                                          const std::initializer_list<std::string>& predefinedStrings);
 
    //  Initial value is defined.
    extern Attribute
    makePredefinedString(const std::string &name,
                         const std::string &help,
                         const std::initializer_list<std::string>& predefinedStrings,
                         const std::string &initial);
 
    extern void setPredefinedString(Attribute &attr, const std::string &val);
 
    //  Initial value undefined.
    extern Attribute makeUpperCaseString(const std::string &name, const std::string &help);
 
    //  Initial value is defined.
    extern Attribute
    makeUpperCaseString(const std::string &name, const std::string &help, const std::string &initial);
 
    extern void setUpperCaseString(Attribute &attr, const std::string &val);
 
    //  Initial value is empty array.
    extern Attribute makeStringArray(const std::string &name, const std::string &help);
 
    extern std::vector<std::string> getStringArray(const Attribute &);
 
    extern void setStringArray(Attribute &, const std::vector<std::string> &);
 
    //  Initial value is empty array.
    extern Attribute makeUpperCaseStringArray(const std::string &name, const std::string &help);
 
    extern void setUpperCaseStringArray(Attribute &, const std::vector<std::string> &);
 
    //  Initial value is undefined.
    extern Attribute makeTableRow(const std::string &name, const std::string &help);
 
    extern TableRowRep getTableRow(const Attribute &);
 
    extern void setTableRow(Attribute &, const TableRowRep &);
 
 
    //  Initial value is empty list.
    extern Attribute makeTokenList(const std::string &name, const std::string &help);
 
    extern std::list<Token> getTokenList(const Attribute &attr);
 
    extern void setTokenList(Attribute &attr, const std::list<Token> &);
 
 
    //  Initial value is empty array.
    extern Attribute makeTokenListArray(const std::string &name, const std::string &help);
 
    extern std::vector<std::list<Token> >
    getTokenListArray(const Attribute &attr);
 
    extern void
    setTokenListArray(Attribute &attr, const std::vector<std::list<Token> > &);
 
};
 
#endif // OPAL_Attributes_HH