CEL

Public API Reference

tools/rulebase.h

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2006 by Jorrit Tyberghein
00004   
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009   
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014   
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_RULEBASE__
00021 #define __CEL_RULEBASE__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 #include "csutil/ref.h"
00026 #include "csutil/hash.h"
00027 #include "csutil/csstring.h"
00028 
00029 struct iCelExpression;
00030 
00034 struct iCelRule : public virtual iBase
00035 {
00036   SCF_INTERFACE (iCelRule, 0, 0, 1);
00037 
00041   virtual const char* GetName () const = 0;
00042 
00046   virtual const char* GetVariable () const = 0;
00047 
00051   virtual void SetVariable (const char* var) = 0 ;
00052 
00057   virtual size_t GetVariableIndex () = 0;
00058 
00062   virtual iCelExpression* GetExpression () = 0;
00063 
00067   virtual void SetExpression (iCelExpression* expr) = 0;
00068 
00072   virtual csStringID GetPriority () = 0;
00073 
00077   virtual void SetPriority (csStringID priority) = 0;
00078 
00082   virtual size_t GetPriorityNumber () const = 0;
00083 };
00084 
00086 typedef csHash<csRef<iCelRule>,csStringBase> celRuleHash;
00087 
00091 struct iCelRuleBase : public virtual iBase
00092 {
00093   SCF_INTERFACE (iCelRuleBase, 0, 0, 1);
00094 
00098   virtual iCelRule* CreateRule (const char* name) = 0;
00099 
00103   virtual iCelRule* FindRule (const char* name) = 0;
00104 
00108   virtual const celRuleHash& GetRules () const = 0;
00109 
00113   virtual void DeleteRule (iCelRule* rule) = 0;
00114 
00118   virtual void ClearPriorityTable () = 0;
00119 
00125   virtual void AddPriority (csStringID priority) = 0;
00126 };
00127 
00128 #endif // __CEL_RULEBASE__
00129 

Generated for CEL: Crystal Entity Layer 1.2 by doxygen 1.4.7