projects.h File Reference

#include <HEKGuerilla/components/tags/tags.h>
#include <blam/api/v1/types/project_info.h>

Include dependency graph for projects.h:

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

Go to the source code of this file.

Classes
class	BlamTagTreeNode
	Class representing a tag tree node. More...
class	BlamProjectUserConfig
class	BlamProject
	Class representing a Blamite Project. More...

Namespaces
	Guerilla
	Namespace containing functions for Guerilla.
	Guerilla::Projects
	Namespace containing functions for working with project files.

Macros
#define	GUERILLA_LIB_API   __declspec(dllimport)
#define	PROJECT_FILE_EXTENSION   ".blam"
#define	PROJECT_FILE_USER_SUFFIX   ".user"
#define	BLAM_PROJECTS_DIR   "Projects"
#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
GUERILLA_LIB_API BlamProject *	Guerilla::Projects::GetCurrentProject ()
GUERILLA_LIB_API void	Guerilla::Projects::SetCurrentProject (BlamProject *project)
GUERILLA_LIB_API BlamProject *	Guerilla::Projects::LoadProject (std::string file_path)
	Loads a project file from disk and prepares it for use. More...
GUERILLA_LIB_API BlamProject *	Guerilla::Projects::CreateProject (std::string name)
GUERILLA_LIB_API void	Guerilla::Projects::LoadProjects ()
	Attempts to load all available project folders. More...
GUERILLA_LIB_API void	Guerilla::Projects::UnloadProjects ()
	Releases all project data loaded into memory. More...
GUERILLA_LIB_API std::vector< BlamProject * >	Guerilla::Projects::GetLoadedProjects ()
	Retrieves the list of loaded projects. More...
GUERILLA_LIB_API std::string	Guerilla::Projects::GetProjectsRoot ()

Macro Definition Documentation

BLAM_PROJECTS_DIR

#define BLAM_PROJECTS_DIR   "Projects"

GUERILLA_LIB_API

#define GUERILLA_LIB_API   __declspec(dllimport)

PROJECT_FILE_EXTENSION

#define PROJECT_FILE_EXTENSION   ".blam"

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_FILE_USER_SUFFIX

#define PROJECT_FILE_USER_SUFFIX   ".user"

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.