/*  Starshatter OpenSource Distribution
    Copyright (c) 1997-2004, Destroyer Studios LLC.
    All Rights Reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name "Destroyer Studios" nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    SUBSYSTEM:    nGenEx.lib
    FILE:         Font.h
    AUTHOR:       John DiCamillo


    OVERVIEW
    ========
    Font Resource class
*/

#ifndef Font_h
#define Font_h

#include "Types.h"
#include "Bitmap.h"
#include "Color.h"
#include "Geometry.h"

// +--------------------------------------------------------------------+

struct Poly;
struct Material;
struct VertexSet;
class  Video;

// +--------------------------------------------------------------------+

struct FontChar
{
    short offset;
    short width;
};

// +--------------------------------------------------------------------+

class Font
{
public:
    static const char* TYPENAME() { return "Font"; }

    enum FLAGS { FONT_FIXED_PITCH = 1,
        FONT_ALL_CAPS    = 2,
        FONT_NO_KERN     = 4
    };

    enum CHARS { PIPE_NBSP   = 16,
        PIPE_VERT   = 17,
        PIPE_LT     = 18,
        PIPE_TEE    = 19,
        PIPE_UL     = 20,
        PIPE_LL     = 21,
        PIPE_HORZ   = 22,
        PIPE_PLUS   = 23,
        PIPE_MINUS  = 24,
        ARROW_UP    = 25,
        ARROW_DOWN  = 26,
        ARROW_LEFT  = 27,
        ARROW_RIGHT = 28
    };

    // default constructor:
    Font();
    Font(const char* name);
    ~Font();

    bool     Load(const char* name);

    int      CharWidth(char c) const;
    int      SpaceWidth() const;
    int      KernWidth(char left, char right) const;
    int      StringWidth(const char* str, int len=0) const;

    void     DrawText(const char* txt, int count, Rect& txt_rect, DWORD flags, Bitmap* tgt_bitmap=0);
    int      DrawString( const char* txt, int len, int x1, int y1, const Rect& clip, Bitmap* tgt_bitmap=0);

    int      Height()                   const { return height;           }
    int      Baseline()                 const { return baseline;         }
    WORD     GetFlags()                 const { return flags;            }
    void     SetFlags(WORD s)                 { flags = s;               }
    Color    GetColor()                 const { return color;            }
    void     SetColor(const Color& c)         { color = c;               }
    double   GetExpansion()             const { return expansion;        }
    void     SetExpansion(double e)           { expansion = (float) e;   }
    double   GetAlpha()                 const { return alpha;            }
    void     SetAlpha(double a)               { alpha = (float) a;       }
    int      GetBlend()                 const { return blend;            }
    void     SetBlend(int b)                  { blend = b;               }

    void     SetKern(char left, char right, int k=0);

    int      GetCaretIndex()            const { return caret_index;      }
    void     SetCaretIndex(int n)             { caret_index = n;         }

private:
    void        AutoKern();
    void        FindEdges(BYTE c, double* l, double* r);
    int         CalcWidth(BYTE c) const;
    int         GlyphOffset(BYTE c) const;
    int         GlyphLocationX(BYTE c) const;
    int         GlyphLocationY(BYTE c) const;

    void        DrawTextSingle(const char* txt, int count, const Rect& txt_rect, Rect& clip_rect, DWORD flags);
    void        DrawTextWrap(const char* txt, int count, const Rect& txt_rect, Rect& clip_rect, DWORD flags);
    void        DrawTextMulti(const char* txt, int count, const Rect& txt_rect, Rect& clip_rect, DWORD flags);

    void        LoadDef(char* defname, char* imgname);

    char        name[64];
    WORD        flags;
    BYTE        height;
    BYTE        baseline;
    BYTE        interspace;
    BYTE        spacewidth;
    float       expansion;
    float       alpha;
    int         blend;
    int         scale;

    int         caret_index;
    int         caret_x;
    int         caret_y;

    int         imagewidth;
    BYTE*       image;
    Bitmap      bitmap;
    Bitmap*     tgt_bitmap;
    Material*   material;
    VertexSet*  vset;
    Poly*       polys;
    int         npolys;

    FontChar    glyph[256];
    Color       color;

    char        kern[256][256];
};

#endif  // Font_h