icinga2/lib/config/configcompiler.h

/******************************************************************************
 * Icinga 2                                                                   *
 * Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/)        *
 *                                                                            *
 * This program 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.                     *
 *                                                                            *
 * This program 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 this program; if not, write to the Free Software Foundation     *
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ******************************************************************************/

#ifndef CONFIGCOMPILER_H
#define CONFIGCOMPILER_H

namespace icinga
{

/**
 * The configuration compiler can be used to compile a configuration file
 * into a number of configuration items.
 *
 * @ingroup config
 */
class I2_CONFIG_API ConfigCompiler
{
public:
	typedef function<void (const String&, bool, const DebugInfo&)> HandleIncludeFunc;

	explicit ConfigCompiler(const String& path, istream *input = &cin,
	    HandleIncludeFunc includeHandler = &ConfigCompiler::HandleFileInclude);
	virtual ~ConfigCompiler(void);

	void Compile(void);

	static void CompileStream(const String& path, istream *stream);
	static void CompileFile(const String& path);
	static void CompileText(const String& path, const String& text);

	static void AddIncludeSearchDir(const String& dir);

	String GetPath(void) const;

	static void HandleFileInclude(const String& include, bool search,
	    const DebugInfo& debuginfo);

	/* internally used methods */
	void HandleInclude(const String& include, bool search, const DebugInfo& debuginfo);
	void HandleLibrary(const String& library);

	size_t ReadInput(char *buffer, size_t max_bytes);
	void *GetScanner(void) const;

	static void RegisterConfigFragment(const String& name, const String& fragment);
	static map<String, String>& GetConfigFragments(void);

private:
	String m_Path;
	istream *m_Input;

	HandleIncludeFunc m_HandleInclude;

	void *m_Scanner;

	static vector<String> m_IncludeSearchDirs;

	void InitializeScanner(void);
	void DestroyScanner(void);
};

/**
 * Helper class for registering config fragments.
 *
 * @ingroup base
 */
class RegisterConfigFragmentHelper
{
public:
	RegisterConfigFragmentHelper(const String& name, const String& fragment)
	{
		ConfigCompiler::RegisterConfigFragment(name, fragment);
	}
};

#define REGISTER_CONFIG_FRAGMENT(name, fragment) \
	static icinga::RegisterConfigFragmentHelper g_RegisterCF_ ## type(name, fragment)

}

#endif /* CONFIGCOMPILER_H */