project_info.h File Reference

#include <string>

Include dependency graph for project_info.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	BlamProjectInfo
	Structure representing a Blam Project Information file. More...

Namespaces
	BlamStrings
	Namespace containing general-purpose utilities.
	BlamStrings::Resources
	Functions used in loading and accessing resources.
	BlamStrings::Resources::ProjectInfo
	Namespace containing functions used to work with Blam Project Information files.

Macros
#define	STRINGS_API   __declspec(dllimport)
#define	PROJECT_SECTION(name, fields)   struct name##_data fields; name##_data name = name##_data();
	Macro used to aid in the creation of BlamProjectInfo sections. More...
#define	PROJECT_FILE_FORMAT_VERSION   1
	The current project file format version. More...

Functions
STRINGS_API BlamProjectInfo	BlamStrings::Resources::ProjectInfo::LoadProjectInfo (std::string file_path)
	Loads a project information file from disk. More...
STRINGS_API bool	BlamStrings::Resources::ProjectInfo::SaveProjectInfo (BlamProjectInfo project)
	Saves a project information file to disk. More...

Macro Definition Documentation

PROJECT_FILE_FORMAT_VERSION

#define PROJECT_FILE_FORMAT_VERSION   1

The current project file format version.

This should be incremented in the event that any major changes are made to the project files. Namely, any changes which would break previous projects - such as the removal of sections or settings. The addition of new settings will usually not require a format change, assuming that project files without the new settings can still be properly loaded and supported.

PROJECT_SECTION

#define PROJECT_SECTION	(		name,
			fields
	)		struct name##_data fields; name##_data name = name##_data();

Macro used to aid in the creation of BlamProjectInfo sections.

Each section consists of a struct with a series of fields, and an instance of this struct.

Parameters

name	- The name of the section.
fields	- The list of fields within the struct. Must include curly braces.

STRINGS_API

#define STRINGS_API   __declspec(dllimport)