/*
 * FTGL - OpenGL font library
 *
 * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
 * Copyright (c) 2008 Sam Hocevar <sam@zoy.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef __FTFontImpl__
#define __FTFontImpl__

#include "FTGL/ftgl.h"

#include "FTFace.h"

class FTGlyphContainer;
class FTGlyph;

class FTGL_EXPORT FTFontImpl
{
        friend class FTFont;

    protected:
        FTFontImpl(FTFont *ftFont, char const *fontFilePath);

        FTFontImpl(FTFont *ftFont, const unsigned char *pBufferBytes,
                   size_t bufferSizeInBytes);

        virtual ~FTFontImpl();

        virtual bool Attach(const char* fontFilePath);

        virtual bool Attach(const unsigned char *pBufferBytes,
                            size_t bufferSizeInBytes);

        virtual void GlyphLoadFlags(FT_Int flags);

        virtual bool CharMap(FT_Encoding encoding);

        virtual unsigned int CharMapCount() const;

        virtual FT_Encoding* CharMapList();

        virtual void UseDisplayList(bool useList);

        virtual float Ascender() const;

        virtual float Descender() const;

        virtual float LineHeight() const;

        virtual bool FaceSize(const unsigned int size,
                              const unsigned int res);

        virtual unsigned int FaceSize() const;

        virtual void Depth(float depth);

        virtual void Outset(float outset);

        virtual void Outset(float front, float back);

        virtual FTBBox BBox(const char *s, const int len, FTPoint, FTPoint);

        virtual FTBBox BBox(const wchar_t *s, const int len, FTPoint, FTPoint);

        virtual float Advance(const char *s, const int len, FTPoint);

        virtual float Advance(const wchar_t *s, const int len, FTPoint);

        virtual FTPoint Render(const char *s, const int len,
                               FTPoint, FTPoint, int);

        virtual FTPoint Render(const wchar_t *s, const int len,
                               FTPoint, FTPoint, int);

        virtual FTPoint Render(mgVBO& vbo, const char *s, const int len,
                               FTPoint, FTPoint, int);

        virtual FTPoint Render(mgVBO& vbo, const wchar_t *s, const int len,
                               FTPoint, FTPoint, int);

        /**
         * Current face object
         */
        FTFace face;

        /**
         * Current size object
         */
        FTSize charSize;

        /**
         * Flag to enable or disable the use of Display Lists inside FTGL
         * <code>true</code> turns ON display lists.
         * <code>false</code> turns OFF display lists.
         */
        bool useDisplayLists;

        /**
         * The default glyph loading flags.
         */
        FT_Int load_flags;

        /**
         * Current error code. Zero means no error.
         */
        FT_Error err;

    private:
        /**
         * A link back to the interface of which we are the implementation.
         */
        FTFont *intf;

        /**
         * Check that the glyph at <code>chr</code> exist. If not load it.
         *
         * @param chr  character index
         * @return <code>true</code> if the glyph can be created.
         */
        bool CheckGlyph(const unsigned int chr);

        /**
         * An object that holds a list of glyphs
         */
        FTGlyphContainer* glyphList;

        /**
         * Current pen or cursor position;
         */
        FTPoint pen;

        /* Internal generic BBox() implementation */
        template <typename T>
        inline FTBBox BBoxI(const T *s, const int len,
                            FTPoint position, FTPoint spacing);

        /* Internal generic Advance() implementation */
        template <typename T>
        inline float AdvanceI(const T *s, const int len, FTPoint spacing);

        /* Internal generic Render() implementation */
        template <typename T>
        inline FTPoint RenderI(const T *s, const int len,
                               FTPoint position, FTPoint spacing, int mode);

        /* Internal generic Render() implementation */
        template <typename T>
        inline FTPoint RenderI(mgVBO& vbo, const T *s, const int len,
                               FTPoint position, FTPoint spacing, int mode);
};

#endif  //  __FTFontImpl__