ProgramInfo.h

/*************************************************************************************

	cpl - cross-platform library - v. 0.1.0.

	Copyright (C) 2016 Janus Lynggaard Thorborg (www.jthorborg.com)

	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 3 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, see <http://www.gnu.org/licenses/>.

	See \licenses\ for additional details on licenses associated with this program.

**************************************************************************************

	file:ProgramInfo.h

		Defines program information CPL will use in dialogs, file paths etc.

*************************************************************************************/

#ifndef CPL_PROGRAMINFO_H
#define CPL_PROGRAMINFO_H

#include <string>
#include "ProgramVersion.h"

struct ProgramInfo
{
	/// <summary>
	/// The name of the program
	/// </summary>
	std::string name;
	/// <summary>
	/// Versioning info for this program
	/// </summary>
	cpl::Version version;
	/// <summary>
	/// Your (company's) name
	/// </summary>
	std::string author;
	/// <summary>
	/// Your (company's) contact mail
	/// </summary>
	std::string mail;
	/// <summary>
	/// Abbreviation of the program's name for small spaces (and file extensions)
	/// </summary>
	std::string programAbbr;
	/// <summary>
	/// cpl has a generic tree structure, it looks for in the current working directory.
	/// you can specify your own here - will affect filechoosers, temporary files, resources etc.
	/// set this to true if you specify your own.
	/// </summary>
	bool hasCustomDirectory;
	/// <summary>
	/// A function returning the path (or relative offset) to your custom directory.
	/// </summary>
	std::string(*customDirectory)();
	/// <summary>
	/// An optional string identifying this build through other means than versioning (branches etc)
	/// </summary>
	std::string customBuildInfo;
};

namespace cpl
{
	extern const ProgramInfo programInfo;
}

#endif