Merge remote-tracking branch 'illwieckz/pakpath'
[xonotic/netradiant.git] / include / ieclass.h
index bfca1d6..a50b74a 100644 (file)
-/*\r
-Copyright (C) 1999-2007 id Software, Inc. and contributors.\r
-For a list of contributors, see the accompanying CONTRIBUTORS file.\r
-\r
-This file is part of GtkRadiant.\r
-\r
-GtkRadiant is free software; you can redistribute it and/or modify\r
-it under the terms of the GNU General Public License as published by\r
-the Free Software Foundation; either version 2 of the License, or\r
-(at your option) any later version.\r
-\r
-GtkRadiant is distributed in the hope that it will be useful,\r
-but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-GNU General Public License for more details.\r
-\r
-You should have received a copy of the GNU General Public License\r
-along with GtkRadiant; if not, write to the Free Software\r
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA\r
-*/\r
-\r
-/*! \file ieclass.h\r
-    \brief entity files loader API\r
-    this describes the APIs involved when loading entity description files\r
-    (initially, .def and .fgd)\r
-*/\r
-\r
-#ifndef _IECLASS_H_\r
-#define _IECLASS_H_\r
-\r
-#define ECLASS_MAJOR "eclass"\r
-\r
-typedef void (* PFN_ECLASS_SCANFILE) (char *filename);\r
-typedef const char*       (* PFN_ECLASS_GETEXTENSION)     ();\r
-\r
-struct _EClassTable\r
-{\r
-  int m_nSize;\r
-  PFN_ECLASS_SCANFILE m_pfnScanFile;\r
-  PFN_ECLASS_GETEXTENSION       m_pfnGetExtension;\r
-};\r
-\r
-#ifdef USE_ECLASSTABLE_DEFINE\r
-#ifndef __ECLASSTABLENAME\r
-#define __ECLASSTABLENAME g_EClassTable\r
-#endif\r
-#define EClass_ScanFile __ECLASSTABLENAME.m_pfnEClass_ScanFile\r
-#define EClass_GetExtension __ECLASSTABLENAME.m_pfnEClass_GetExtension\r
-#endif\r
-\r
-#define ECLASSMANAGER_MAJOR "eclassmanager"\r
-\r
-typedef void (* PFN_ECLASS_INSERTALPHABETIZED) (eclass_t *e);\r
-typedef eclass_t** (* PFN_GET_ECLASS_E) ();\r
-typedef void (* PFN_SET_ECLASS_FOUND) (qboolean);\r
-typedef qboolean (* PFN_GET_PARSING_SINGLE) ();\r
-typedef eclass_t* (* PFN_ECLASS_CREATE) (const char *name, float col1, float col2, float col3, const vec3_t *mins, const vec3_t *maxs, const char *comments);\r
-typedef eclass_t* (* PFN_ECLASS_FORNAME) (const char* name, qboolean has_brushes);\r
-\r
-struct _EClassManagerTable\r
-{\r
-  int m_nSize;\r
-  PFN_ECLASS_INSERTALPHABETIZED m_pfnEclass_InsertAlphabetized;\r
-  PFN_GET_ECLASS_E m_pfnGet_Eclass_E;\r
-  PFN_SET_ECLASS_FOUND m_pfnSet_Eclass_Found;\r
-  PFN_GET_PARSING_SINGLE m_pfnGet_Parsing_Single;\r
-  PFN_ECLASS_CREATE m_pfnEClass_Create;\r
-  PFN_ECLASS_FORNAME m_pfnEclass_ForName;\r
-};\r
-\r
-#ifdef USE_ECLASSMANAGER_DEFINE\r
-#ifndef __ECLASSMANAGERTABLENAME\r
-#define __ECLASSMANAGERTABLENAME g_EClassManagerTable\r
-#endif\r
-#define Eclass_InsertAlphabetized __ECLASSMANAGERTABLENAME.m_pfnEclass_InsertAlphabetized\r
-#define Get_Eclass_E __ECLASSMANAGERTABLENAME.m_pfnGet_Eclass_E\r
-#define Set_Eclass_Found __ECLASSMANAGERTABLENAME.m_pfnSet_Eclass_Found\r
-#define Get_Parsing_Single __ECLASSMANAGERTABLENAME.m_pfnGet_Parsing_Single\r
-#define EClass_Create __ECLASSMANAGERTABLENAME.m_pfnEClass_Create\r
-#define Eclass_ForName __ECLASSMANAGERTABLENAME.m_pfnEclass_ForName\r
-#endif\r
-\r
-#endif\r
-\r
+/*
+   Copyright (C) 1999-2006 Id Software, Inc. and contributors.
+   For a list of contributors, see the accompanying CONTRIBUTORS file.
+
+   This file is part of GtkRadiant.
+
+   GtkRadiant 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.
+
+   GtkRadiant 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 GtkRadiant; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+/// \file ieclass.h
+/// \brief Entity Class definition loader API.
+
+
+#if !defined( INCLUDED_IECLASS_H )
+#define INCLUDED_IECLASS_H
+
+#include "generic/constant.h"
+
+#define MAX_FLAGS   16
+
+// eclass show flags
+
+#define     ECLASS_LIGHT      0x00000001
+#define     ECLASS_ANGLE      0x00000002
+#define     ECLASS_PATH       0x00000004
+#define     ECLASS_MISCMODEL  0x00000008
+
+class Shader;
+
+class EntityClass;
+class ListAttributeType;
+
+class EntityClassCollector
+{
+public:
+virtual void insert( EntityClass* eclass ) = 0;
+virtual void insert( const char* name, const ListAttributeType& list ){
+}
+};
+
+struct EntityClassScanner
+{
+       INTEGER_CONSTANT( Version, 1 );
+       STRING_CONSTANT( Name, "eclass" );
+
+       void ( *scanFile )( EntityClassCollector& collector, const char* filename );
+       const char* ( *getExtension )( );
+};
+
+#include "modulesystem.h"
+
+template<typename Type>
+class ModuleRef;
+typedef ModuleRef<EntityClassScanner> EClassModuleRef;
+
+template<typename Type>
+class Modules;
+typedef Modules<EntityClassScanner> EClassModules;
+
+template<typename Type>
+class ModulesRef;
+typedef ModulesRef<EntityClassScanner> EClassModulesRef;
+
+
+
+
+
+
+class EntityClassVisitor
+{
+public:
+virtual void visit( EntityClass* eclass ) = 0;
+};
+
+class ModuleObserver;
+
+
+struct EntityClassManager
+{
+       INTEGER_CONSTANT( Version, 1 );
+       STRING_CONSTANT( Name, "eclassmanager" );
+
+       EntityClass* ( *findOrInsert )( const char* name, bool has_brushes );
+       const ListAttributeType* ( *findListType )(const char* name);
+       void ( *forEach )( EntityClassVisitor& visitor );
+       void ( *attach )( ModuleObserver& observer );
+       void ( *detach )( ModuleObserver& observer );
+       void ( *realise )();
+       void ( *unrealise )();
+};
+
+template<typename Type>
+class GlobalModule;
+typedef GlobalModule<EntityClassManager> GlobalEntityClassManagerModule;
+
+template<typename Type>
+class GlobalModuleRef;
+typedef GlobalModuleRef<EntityClassManager> GlobalEntityClassManagerModuleRef;
+
+inline EntityClassManager& GlobalEntityClassManager(){
+       return GlobalEntityClassManagerModule::getTable();
+}
+
+#endif