gls_font_man.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsFontMan class.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef _GLS_FONT_MAN_H
#define _GLS_FONT_MAN_H

#include "gls_gl.h"
#include <map>
#include <string>

namespace disti
{
/** prefix used for font name to indicate that font is a Unicode font */
#define GLS_UNICODE_FONT_NAME_PREFIX "$$GLS_UNICODE_FONT$$"

/** prefix used for font name to indicate that font is a Runtime font */
#define GLS_RUNTIME_FONT_NAME_PREFIX "$$GLS_RUNTIME_FONT$$"

class GlsFontBase;

//---------------------------------------------------------------------------
/**
* The GlsFontMan class provides a manager singleton for registering and
* retrieving fonts.  
*/
class GlsFontMan
{
public:
    /** Provides access to the singleton factory object. */
    GLS_EXPORT static GlsFontMan& Instance();

    /** Class Destructor. */
    GLS_EXPORT ~GlsFontMan();

    /** Retrieve the specified font object.
     * \param name   font family name, eg. Arial
     * \param style  font style, eg. Bold
     * \param ptSize point size
     *
     * \return a pointer to the font object, or 0 if the font has not been
     * registered with the factory.
     */
    GLS_EXPORT GlsFontBase* Font(
        const std::string& name,
        const std::string& style,
        GLuint             ptSize ) const;

    /** Register the specified font object.
     * \param font   font object
     */
    GLS_EXPORT void Register( GlsFontBase* font );

    /** Notify the font manager that the particular font is being used so
     * that its reference count can be managed. If the font is not already
     * being managed, it will be added to the manager's font repository first.
     * The font's reference count will be incremented by 1.  The Use and
     * Release reference counting methods are separate from the Font and
     * Register methods so that reference counting of fonts can be optional.
     * For example, reference counting may be necessary in the GL Studio
     * editor but not desired at run-time.
     *
     * \param font   font object
     */
    GLS_EXPORT void Use( GlsFontBase* font );

    /** Notify the font manager that the particular font is no longer being
     * used by the caller so that its reference count can be managed.
     * The font's reference count will be decremented by 1 and if there are
     * no longer any users, the font object will be deleted. Only use
     * Release subsequent to using the Use call or the reference counting
     * will not work.
     *
     * \param font   font object
     */
    GLS_EXPORT void Release( GlsFontBase* font );

private:
    struct FontRef_t
    {
        GlsFontBase* font;
        GLint        refCount;
        FontRef_t()
            : font( 0 )
            , refCount( 0 )
        {}
        FontRef_t( GlsFontBase* newFont, GLint initialCount )
            : font( newFont )
            , refCount( initialCount )
        {}
    };

    typedef std::map<std::string, FontRef_t> FontMap_t;

    /** Container of all registered fonts */
    FontMap_t _fonts;

    /** Class Constructor. */
    GLS_EXPORT GlsFontMan( void );

    //-----------------------------------------------------------------------
    // Prevent copies
    //-----------------------------------------------------------------------
    GlsFontMan( const GlsFontMan& );
    GlsFontMan& operator=( const GlsFontMan& );

}; // end class GlsFontMan

} // end namespace disti

#endif