/*
    Crystal Space Entity Layer
    Copyright (C) 2003 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_BLXML_BL__
#define __CEL_BLXML_BL__

#include "csutil/util.h"
#include "csutil/hash.h"
#include "csutil/parray.h"
#include "csutil/strhash.h"
#include "iutil/comp.h"
#include "behaviourlayer/bl.h"
#include "behaviourlayer/blgen.h"
#include "plugins/behaviourlayer/xml/xmlscript.h"
#include "tools/expression.h"
#include "tools/billboard.h"

struct iObjectRegistry;
struct iCelEntity;
struct iCelParameterBlock;
struct iSyntaxService;
struct iCelPlLayer;
struct iBillboardManager;
struct iGraphics3D;
struct iEngine;
struct iMouseDriver;
class celXmlScript;
class celXmlScriptEventHandler;
class csStringArray;

#define DO_PROFILE 0

class celExpression : public scfImplementation1<celExpression,
			   iCelExpression>
{
public:
  celBlXml* cbl;
  celXmlScriptEventHandler* handler;
  csStringArray local_vars;

public:
  celExpression (celBlXml* cbl) : scfImplementationType (this), cbl (cbl)
  {
    handler = 0;
  }
  virtual ~celExpression ()
  {
    delete handler;
  }
  virtual bool Execute (iCelEntity* entity, celData& ret);
  virtual size_t FindLocalVariable (const char* name) const;
  virtual const csStringArray& GetLocalVariables () const { return local_vars; }
  virtual void SetLocalVariable (size_t idx, const celData& value);
  virtual void SetLocalVariableLong (size_t idx, int32 value);
  virtual void SetLocalVariableULong (size_t idx, uint32 value);
  virtual void SetLocalVariableFloat (size_t idx, float value);
  virtual void SetLocalVariableBool (size_t idx, bool value);
  virtual void SetLocalVariableString (size_t idx, const char* value);
  virtual void SetLocalVariableVector2 (size_t idx, const csVector2& value);
  virtual void SetLocalVariableVector3 (size_t idx, const csVector3& value);
  virtual void SetLocalVariableColor (size_t idx, const csColor& value);
};

/**
 * This is the Behaviour Layer itself.
 */
class celBlXml : public scfImplementation4<celBlXml, iCelBlLayer,
		 	iCelBlLayerGenerate, iCelExpressionParser,
			iComponent>
{
public:
  // This is the call stack: useful for debugging.
  csArray<const char*> call_stack;
  csArray<iCelEntity*> call_stack_entity;
  csArray<iCelParameterBlock*> call_stack_params;
  // If true we will trace all changes to variables and properties.
  bool varprop_trace;
  // For profiling.
#if DO_PROFILE
  struct celProfileInfo
  {
    const char* msg;
    csTicks time;
    int count;
  };
  csArray<celProfileInfo> profile_info;
  csHash<int, csStrKey> profile_info_hash;
#endif

private:
  iObjectRegistry* object_reg;
  csRef<iGraphics3D> g3d;
  csRef<iEngine> engine;
  csRef<iMouseDriver> mouse;
  csRef<iBillboardManager> billboard_mgr;

  csRef<iSyntaxService> synldr;
  csWeakRef<iCelPlLayer> pl;
  csPDelArray<celXmlScript> scripts;
  csHash<celXmlScript*,csStrKey> scripts_hash;
  csStringHash xmltokens;
  csStringHash functions;

  const char* GetAttributeValue (iDocumentNode* child,
	const char* propname);
  const char* GetAttributeString (iDocumentNode* child,
	const char* attrname, const char* parentname);
  bool ParseEventHandler (celXmlScriptEventHandler* h,
  	csStringArray& local_vars, iDocumentNode* node,
  	celXmlScript* script);

  bool SkipComma (const char*& input, iDocumentNode* child,
	const char* name);
  bool ParseID (const char*& input, csStringArray& local_vars,
  	iDocumentNode* child, celXmlScriptEventHandler* h,
	const char* name, char* str, csStringID fun_id);
  bool ParseFunction (const char*& input, const char* pinput,
  	csStringArray& local_vars,
  	iDocumentNode* child, celXmlScriptEventHandler* h,
	const char* name);
  bool ParseAction (const char*& input, const char* pinput,
  	csStringArray& local_vars,
  	iDocumentNode* child, celXmlScriptEventHandler* h,
	const char* name);
  bool ParseExpression (csStringArray& local_vars,
        iDocumentNode* child,
	celXmlScriptEventHandler* h, const char* attrname, const char* name,
	int optional_type = CEL_DATA_NONE);
  bool ParseExpressionOrConstantString (csStringArray& local_vars,
  	iDocumentNode* child, celXmlScriptEventHandler* h,
	const char* attrname, const char* name, char*& str);
  bool ParseExpressionInt (const char*& input, const char* pinput,
	int token, csStringArray& local_vars, iDocumentNode* child,
	celXmlScriptEventHandler* h, const char* name,
	int stoppri);
  bool ParseExpression (const char*& input, csStringArray& local_vars,
  	iDocumentNode* child, celXmlScriptEventHandler* h,
	const char* name, int stoppri);
  bool ParseExpressionOrConstantString (const char*& input,
	csStringArray& local_vars, iDocumentNode* child,
	celXmlScriptEventHandler* h,
	const char* name, int stoppri, char*& str);
  celXmlScriptEventHandler* FindEventHandler (celXmlScript* script,
  	const char* eventname);

public:
  celBlXml (iBase* parent);
  virtual ~celBlXml ();
  virtual bool Initialize (iObjectRegistry* object_reg);

  iObjectRegistry* GetObjectRegistry () { return object_reg; }
  iMouseDriver* GetMouseDriver () { return mouse; }
  iGraphics3D* GetG3D () { return g3d; }
  iEngine* GetEngine () { return engine; }
  iBillboardManager* GetBillboardManager ()
  {
    if (!billboard_mgr)
      billboard_mgr = CS_QUERY_REGISTRY (object_reg, iBillboardManager);
    return billboard_mgr;
  }

  virtual const char* GetName () const { return "blxml"; }
  virtual iCelBehaviour* CreateBehaviour (iCelEntity* entity,
      const char* name);

  virtual bool CreateBehaviourScriptFromDoc (const char* name,
  	iDocumentNode* node);
  virtual bool CreateBehaviourScriptFromString (const char* name,
  	const char* string);
  virtual bool CreateBehaviourScriptFromFile (const char* name,
  	const char* filename);

  virtual csPtr<iCelExpression> Parse (const char* string);
};

#endif // __CEL_BLXML_BL__