Initial commit

graphics/fontman.h

@@ -0,0 +1,137 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * 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/>.
+ *
+ */
+
+#ifndef GRAPHICS_FONTMAN_H
+#define GRAPHICS_FONTMAN_H
+
+#include "common/scummsys.h"
+#include "common/singleton.h"
+#include "common/str.h"
+#include "common/hashmap.h"
+#include "common/hash-str.h"
+
+
+namespace Graphics {
+
+/**
+ * @defgroup graphics_fontman Font manager
+ * @ingroup graphics
+ *
+ * @brief FontManager class used for managing fonts.
+ *
+ * @{
+ */
+
+class Font;
+class BdfFont;
+
+class FontManager : public Common::Singleton<FontManager> {
+public:
+	enum FontUsage {
+		kLocalizedFont = 0,
+		kConsoleFont = 1,
+		kGUIFont = 2,
+		kBigGUIFont = 3
+	};
+
+	/**
+	 * Sets the localized font name.
+	 *
+	 * @param name the name of the localized font.
+	 * @return true when the font was present, false otherwise.
+	 */
+	bool setLocalizedFont(const Common::String &name);
+
+	/**
+	 * Retrieve a font object based on its 'name'.
+	 *
+	 * @param name	the name of the font to be retrieved.
+	 * @return a pointer to a font, or 0 if no suitable font was found.
+	 */
+	const Font *getFontByName(const Common::String &name) const;
+
+	/**
+	 * Associates a font object with an 'name'.
+	 * The FontManager takes ownership of the provided font object
+	 * and will delete it when necesssary.
+	 *
+	 * @param name	the name of the font
+	 * @param font	the font object
+	 * @return true on success, false on failure
+	 */
+	bool assignFontToName(const Common::String &name, const Font *font);
+
+	/**
+	 * Associates a BDF font object with an 'usage'. This is useful for platforms
+	 * with a screen DPI much larger than a regular desktop workstation.
+	 *
+	 * @param font	the font object
+	 * @return true on success, false on failure
+	 */
+	bool setFont(FontUsage usage, const BdfFont *font);
+
+	/**
+	 * Removes binding from name to font
+	 *
+	 * @param name	name which should be removed
+	 */
+	void removeFontName(const Common::String &name);
+
+	/**
+	 * Retrieve a font object based on what it is supposed
+	 * to be used for
+	 *
+	 * @param usage	a FontUsage enum value indicating what the font will be used for.
+	 * @return a pointer to a font, or 0 if no suitable font was found.
+	 */
+	const Font *getFontByUsage(FontUsage usage) const;
+
+	//const Font *getFontBySize(int size???) const;
+
+	/**
+	 * Delete the font if it's not one in use by the FontManager
+	 * This may be used when mixing directly loaded fonts and FontManager ones.
+	 *
+	 * @param font the font object to delete
+	 */
+	void mayDeleteFont(const Font *font) const;
+
+private:
+	friend class Common::Singleton<SingletonBaseType>;
+	FontManager();
+	~FontManager();
+
+	Common::HashMap<Common::String, const Font *> _fontMap;
+	Common::Array<const Font *> _ownedFonts;
+	Common::String _localizedFontName;
+};
+
+/** @} */
+} // End of namespace Graphics
+
+/** @addtogroup graphics_fontman
+ *  @{
+ */
+
+/** Shortcut for accessing the font manager. */
+#define FontMan		(Graphics::FontManager::instance())
+ /** @} */
+#endif