core/systems/PluginInfoDatabase.h
author Borja Ferrer <faluco@alliedmods.net>
Thu Jul 05 14:47:36 2007 +0000 (2007-07-05)
changeset 1041 f7b2073013df
parent 653 ef60870067ff
child 1231 17badaf66ce4
permissions -rw-r--r--
added a time stamp argument to FormatTime
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@370
     3
 * ===============================================================
dvander@370
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     5
 * ===============================================================
dvander@370
     6
 *
dvander@370
     7
 * This file is not open source and may not be copied without explicit
dvander@370
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     9
 * in whole or significant part.
dvander@370
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    11
 *
dvander@370
    12
 * Version: $Id$
dvander@370
    13
 */
dvander@370
    14
dvander@203
    15
#ifndef _INCLUDE_SOURCEMOD_CORE_SYSTEM_PLUGININFODATABASE_H_
dvander@203
    16
#define _INCLUDE_SOURCEMOD_CORE_SYSTEM_PLUGININFODATABASE_H_
dvander@203
    17
dvander@203
    18
/**
dvander@203
    19
 * This file parses plugin_settings.cfg and stores the information in cached memory.
dvander@203
    20
 * It provides simplistic abstraction to retrieving the info.
dvander@203
    21
 * :TODO: currently untested
dvander@203
    22
 */
dvander@203
    23
dvander@203
    24
#include "sm_memtable.h"
dvander@203
    25
#include "ITextParsers.h"
dvander@203
    26
#include "IPluginSys.h"
dvander@203
    27
#include "sm_globals.h"
dvander@203
    28
dvander@203
    29
struct PluginOpts
dvander@203
    30
{
dvander@203
    31
	int key;
dvander@203
    32
	int val;
dvander@203
    33
};
dvander@203
    34
dvander@203
    35
struct PluginSettings
dvander@203
    36
{
dvander@203
    37
	void Init();
dvander@203
    38
	int name;
dvander@203
    39
	bool pause_val;
dvander@203
    40
	PluginType type_val;
dvander@203
    41
	int optarray;
dvander@203
    42
	size_t opts_num;
dvander@203
    43
	size_t opts_size;
dvander@203
    44
};
dvander@203
    45
dvander@203
    46
class CPluginInfoDatabase : public ITextListener_SMC
dvander@203
    47
{
dvander@203
    48
public:
dvander@203
    49
	CPluginInfoDatabase();
dvander@203
    50
	~CPluginInfoDatabase();
dvander@203
    51
public: //ITextListener_SMC
dvander@203
    52
	void ReadSMC_ParseStart();
dvander@203
    53
	SMCParseResult ReadSMC_NewSection(const char *name, bool opt_quotes);
dvander@203
    54
	SMCParseResult ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes);
dvander@203
    55
	SMCParseResult ReadSMC_LeavingSection();
dvander@203
    56
public:
dvander@203
    57
	/**
dvander@203
    58
	 * Returns the number of plugin settings available.
dvander@203
    59
	 */
dvander@203
    60
	unsigned int GetSettingsNum();
dvander@203
    61
dvander@203
    62
	/** 
dvander@203
    63
	 * Given an index, returns the plugin settings block if the filename matches.
dvander@203
    64
	 * Otherwise, returns NULL.
dvander@203
    65
	 */
dvander@203
    66
	PluginSettings *GetSettingsIfMatch(unsigned int index, const char *filename);
dvander@203
    67
dvander@203
    68
	/** 
dvander@203
    69
	 *  Given a plugin settings struct and an index,
dvander@203
    70
	 * returns the given JIT key/value option pair at that index.
dvander@203
    71
	 * If the input is invalid, key and val will be set to NULL.
dvander@203
    72
	 */
dvander@203
    73
	void GetOptionsForPlugin(PluginSettings *settings, unsigned int opt_num, const char **key, const char **val);
dvander@203
    74
private:
dvander@203
    75
	SMCParseResult MakeError(const char *fmt, ...);
dvander@203
    76
private:
dvander@203
    77
	BaseStringTable *m_strtab;
dvander@203
    78
	int m_errmsg;
dvander@203
    79
	bool in_plugins;
dvander@203
    80
	bool in_options;
dvander@351
    81
	int m_infodb;
dvander@203
    82
	size_t m_infodb_count;
dvander@203
    83
	size_t m_infodb_size;
dvander@203
    84
	int cur_plugin;
dvander@203
    85
};
dvander@203
    86
dvander@203
    87
dvander@203
    88
#endif //_INCLUDE_SOURCEMOD_CORE_SYSTEM_PLUGININFODATABASE_H_