tools/parameters.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2004-2006 by Jorrit Tyberghein
  
    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; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_PARAMETERS__
#define __CEL_PARAMETERS__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/scf_implementation.h"
#include "csutil/weakref.h"
#include "csutil/hash.h"
#include "csgeom/vector3.h"
#include "csutil/refarr.h"
#include "physicallayer/pl.h"

class celVariableParameterBlock;
struct iCelDataBuffer;
struct iCelParameterBlock;

struct celParSpec
{
  celDataType type;

  csStringID id;

  csString name;

  csString value;
};

//---------------------------------------------------------------------------
struct iParameter : public virtual iBase
{
  SCF_INTERFACE (iParameter, 0, 0, 2);

  virtual const celData* GetData (iCelParameterBlock* params) = 0;

  virtual const char* Get (iCelParameterBlock* params) = 0;

  virtual const char* Get (iCelParameterBlock* params, bool& changed) = 0;

  virtual int32 GetLong (iCelParameterBlock* params) = 0;
};

//---------------------------------------------------------------------------
typedef csHash<csStringBase,csStringBase> celParams;
//---------------------------------------------------------------------------

struct iParameterManager : public virtual iBase
{
    SCF_INTERFACE (iParameterManager, 1, 0, 0);

  virtual csPtr<iParameter> GetParameter (
        const celParams& params,
        const char* param) = 0;

  virtual const char* ResolveParameter (
        const celParams& params,
        const char* param) = 0;

  virtual csPtr<celVariableParameterBlock> GetParameterBlock (
        const celParams& params,
        const csArray<celParSpec>& parameters,
        csRefArray<iParameter>& quest_parameters) = 0;

  virtual bool FillParameterBlock (
    iCelParameterBlock* params,
        celVariableParameterBlock* act_params,
        const csArray<celParSpec>& parameters,
        const csRefArray<iParameter>& quest_parameters) = 0;


};
//---------------------------------------------------------------------------

#endif // __CEL_PARAMETERS__