Aegisub/aegisub/reporter/include/platform.h

// Copyright (c) 2009, Amar Takhar <verm@aegisub.org>
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// $Id$

/// @file platform.h
/// @brief API for gathering platform information.
/// @see platform.cpp
/// @ingroup base

#ifndef R_PRECOMP
#include <wx/intl.h>
#include <wx/glcanvas.h>
#include <wx/platinfo.h>
#include <wx/string.h>
#endif

/// @class Platform
/// @brief Grab platform-specific information.
class Platform {
public:

	/// Constructor
	Platform() {};

	/// Destructor
	~Platform();

	/// Get platform instance.
	static Platform* GetPlatform();

	/// @name Platform Agonstic
	/// These are platform agnostic mostly from wx functions.
	//@{

	//   From wxPlatformInfo

	/// Architecture
	/// @return Architecture name.
	/// @retval 32 bit, 64 bit
	std::string ArchName();

	/// OS Family
	/// @return OS Family
	/// @retval Unix, Windows, Mac
	std::string OSFamily();

	/// OS Name
	/// @return OS Name
	/// @retval FreeBSD, Windows, Mac
	std::string OSName();

	/// Endian
	/// @return Endian
	/// @retval Little endian, Big endian
	std::string Endian();

	//   From <wx/gdicmn.h>

	/// Display depth
	/// @return Depth
	/// @return Integer
	int DisplayDepth();

	/// Display size
	/// @return Size delimited by a space.
	/// @retval "w h"
	std::string DisplaySize();

	/// Pixels per inch
	/// @return PPI
	/// @retval Integer
	std::string DisplayPPI();

	//   Misc

	/// Report signature
	/// @return Signature
	/// @retval SHA256 hash
	std::string Signature();

	/// wxWidgets version
	/// @return Version
	/// @retval Major.Minor.Micro.Patch: 2.9.0.0
	std::string wxVersion();

	/// Locale
	/// @return Locale name
	/// @retval C,POSIX,<code>
	std::string Locale();

	/// Language currently in use
	/// @return Language reporter is currently running in
	/// @retval Language code: en_US, en_CA...
	const char* Language();

	/// System language
	/// @return Language operating system is currently running in
	/// @retval Language code: en_US, en_CA...
	const char* SystemLanguage();

	/// Date
	/// @return Date
	/// @retval Date in YYYY-MM-DD
	std::string Date();

	/// Time
	/// @return Time
	/// @retval Time in HH:MM:SS
	std::string Time();

	/// TimeZone
	/// @return TimeZone
	/// @retval EST,EDT,JST...
	std::string TimeZone();
	//@}

	/// @name Platform Specific
	/// The following are all platform-specific.
	//@{
	//   Misc

	/// Operating System version
	/// @return OS Version
	/// @retval Any
	virtual const std::string OSVersion()=0;

	//   Hardware

	/// CPU ID string
	/// @return CPU ID
	/// @retval Any, ex: Intel(R) Pentium(R) M processor 1600MHz
	virtual std::string CPUId()=0;

	/// CPU Speed
	/// @return Speed
	/// @retval Integer
	virtual std::string CPUSpeed()=0;

	/// CPU Count
	/// @return Count
	/// @retval Integer
	virtual int CPUCount()=0;

	/// CPU Cores
	/// @return Cores
	/// @retval Integer
	virtual int CPUCores()=0;

	/// CPU Features
	/// @return Features set 1
	/// @retval FPU,VME,DE,PSE,TSC,MSR...
	virtual std::string CPUFeatures()=0;

	/// CPU Features2
	/// @return Features set 2
	/// @retval CPU-specific features
	/// @note "EST,TM2" on my P-M, or "SYSCALL,NX,MMX+,LM,3DNow!+,3DNow!" on an Opteron
	virtual std::string CPUFeatures2()=0;

	/// System memory
	/// @return Memory
	/// @retval Integer in bytes
	virtual uint64_t Memory()=0;

	/// OpenGL vendor
	/// @return Vendor
	/// @retval Any
	virtual std::string OpenGLVendor();

	/// OpenGL renderer
	/// @return Renderer
	/// @retval Any
	virtual std::string OpenGLRenderer();

	/// OpenGL version
	/// @return Renderer version
	/// @retval Any
	virtual std::string OpenGLVersion();

	/// OpenGL extensions
	/// @return OpenGL extensions
	/// @retval Space delimited list of extensions
	virtual std::string OpenGLExt();
	//@}

	/// @name Windows
	//@{
#ifdef __WINDOWS__

	/// Service pack
	/// @return Service pack
	/// @retval Any
	virtual std::string ServicePack()=0;

	/// Graphics driver version
	/// @return Driver version
	/// @retval Any
	virtual std::string DriverGraphicsVersion()=0;

	/// Directshow filters installed
	/// @return json::Object of filters installed
	/// @retval A json::Object format of:
	/// \verbatim
	/// <filter>
	///   <name version="[version]">[name]</name>
	/// </filter>
	/// \endverbatim
	virtual std::string DirectShowFilters()=0;

	/// AntiVirus installed
	/// @return true/false
	/// @retval 1,0
	virtual std::string AntiVirus()=0;

	/// Firewall installed
	/// @return true/false
	/// @retval 1,0
	virtual std::string Firewall()=0;

	/// DLL versions used
	/// @return json::Array of DLLs used
	/// @retval A json::Array in the format of:
	/// \verbatim
	/// { "version", "name" }
	/// \endverbatim
	virtual std::string DLLVersions()=0;
#endif
	//@}

	/// @name Unix
	//@{
#ifdef __UNIX__

	/// Library versions used
	/// @return json::Array of DLLs used
	/// @retval A json::Array in the format of:
	/// \verbatim
	/// { "version", "name" }
	/// \endverbatim
	virtual std::string UnixLibraries()=0;

	/// Desktop environment
	/// @return Environment
	/// @retval Gnome, KDE, WindowMaker...
	virtual const char* DesktopEnvironment()=0;
#endif
	//@}

	/// @name OS X
	//@{
#ifdef __APPLE__

	/// OS patch level
	/// @return Patch level
	/// @retval Any
	virtual std::string PatchLevel()=0;

	/// Hardware model
	/// @return Model
	/// @retval Any
	virtual std::string HardwareModel()=0;
#endif
	//@}

private:
	void Init();

	/// wxPlatformInfo struct.
	const wxPlatformInfo plat;

	/// wxLocale instance.
	wxLocale *locale;

	/// wxGLCanvas.
	wxGLCanvas *glc;

	/// wxGLContext.
	wxGLContext *ctx;

	/// Available video information.
	enum VideoInfo {
		VIDEO_RENDERER,	///< Renderer
		VIDEO_VENDOR,	///< Vendor
		VIDEO_VERSION,	///< Version
		VIDEO_EXT		///< Extensions
	};

	/// Retrieve OpenGL video information.
	/// @param which Requested information
	/// @return Video info.
	std::string GetVideoInfo(enum Platform::VideoInfo which);

};