FXFont.h

/********************************************************************************
*                                                                               *
*                               F o n t   O b j e c t                           *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library 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 Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXFONT_H
#define FXFONT_H

#ifndef FXID_H
#include "FXId.h"
#endif

namespace FX {


enum FXFontEncoding {
  FONTENCODING_DEFAULT,         

  FONTENCODING_ISO_8859_1   = 1,        
  FONTENCODING_ISO_8859_2   = 2,        
  FONTENCODING_ISO_8859_3   = 3,        
  FONTENCODING_ISO_8859_4   = 4,
  FONTENCODING_ISO_8859_5   = 5,        
  FONTENCODING_ISO_8859_6   = 6,        
  FONTENCODING_ISO_8859_7   = 7,        
  FONTENCODING_ISO_8859_8   = 8,        
  FONTENCODING_ISO_8859_9   = 9,        
  FONTENCODING_ISO_8859_10  = 10,       
  FONTENCODING_ISO_8859_11  = 11,       
  FONTENCODING_ISO_8859_13  = 13,       
  FONTENCODING_ISO_8859_14  = 14,       
  FONTENCODING_ISO_8859_15  = 15,       
  FONTENCODING_ISO_8859_16  = 16,       
  FONTENCODING_KOI8         = 17,       
  FONTENCODING_KOI8_R       = 18,       
  FONTENCODING_KOI8_U       = 19,       
  FONTENCODING_KOI8_UNIFIED = 20,

  FONTENCODING_CP437        = 437,      
  FONTENCODING_CP850        = 850,      
  FONTENCODING_CP851        = 851,      
  FONTENCODING_CP852        = 852,      
  FONTENCODING_CP855        = 855,      
  FONTENCODING_CP856        = 856,      
  FONTENCODING_CP857        = 857,      
  FONTENCODING_CP860        = 860,      
  FONTENCODING_CP861        = 861,      
  FONTENCODING_CP862        = 862,      
  FONTENCODING_CP863        = 863,      
  FONTENCODING_CP864        = 864,      
  FONTENCODING_CP865        = 865,      
  FONTENCODING_CP866        = 866,      
  FONTENCODING_CP869        = 869,      
  FONTENCODING_CP870        = 870,      

  FONTENCODING_CP1250       = 1250,     
  FONTENCODING_CP1251       = 1251,     
  FONTENCODING_CP1252       = 1252,     
  FONTENCODING_CP1253       = 1253,     
  FONTENCODING_CP1254       = 1254,     
  FONTENCODING_CP1255       = 1255,     
  FONTENCODING_CP1256       = 1256,     
  FONTENCODING_CP1257       = 1257,     
  FONTENCODING_CP1258       = 1258,     
  FONTENCODING_CP874        = 874,      

  FONTENCODING_UNICODE      = 9999,

  FONTENCODING_LATIN1       = FONTENCODING_ISO_8859_1,   
  FONTENCODING_LATIN2       = FONTENCODING_ISO_8859_2,   
  FONTENCODING_LATIN3       = FONTENCODING_ISO_8859_3,   
  FONTENCODING_LATIN4       = FONTENCODING_ISO_8859_4,   
  FONTENCODING_LATIN5       = FONTENCODING_ISO_8859_9,   
  FONTENCODING_LATIN6       = FONTENCODING_ISO_8859_10,  
  FONTENCODING_LATIN7       = FONTENCODING_ISO_8859_13,  
  FONTENCODING_LATIN8       = FONTENCODING_ISO_8859_14,  
  FONTENCODING_LATIN9       = FONTENCODING_ISO_8859_15,  
  FONTENCODING_LATIN10      = FONTENCODING_ISO_8859_16,  

  FONTENCODING_USASCII      = FONTENCODING_ISO_8859_1,   
  FONTENCODING_WESTEUROPE   = FONTENCODING_ISO_8859_1,   
  FONTENCODING_EASTEUROPE   = FONTENCODING_ISO_8859_2,   
  FONTENCODING_SOUTHEUROPE  = FONTENCODING_ISO_8859_3,   
  FONTENCODING_NORTHEUROPE  = FONTENCODING_ISO_8859_4,   
  FONTENCODING_CYRILLIC     = FONTENCODING_ISO_8859_5,   
  FONTENCODING_RUSSIAN      = FONTENCODING_KOI8,         
  FONTENCODING_ARABIC       = FONTENCODING_ISO_8859_6,   
  FONTENCODING_GREEK        = FONTENCODING_ISO_8859_7,   
  FONTENCODING_HEBREW       = FONTENCODING_ISO_8859_8,   
  FONTENCODING_TURKISH      = FONTENCODING_ISO_8859_9,   
  FONTENCODING_NORDIC       = FONTENCODING_ISO_8859_10,  
  FONTENCODING_THAI         = FONTENCODING_ISO_8859_11,  
  FONTENCODING_BALTIC       = FONTENCODING_ISO_8859_13,  
  FONTENCODING_CELTIC       = FONTENCODING_ISO_8859_14   
  };


struct FXFontDesc {
  FXchar          face[116];                
  FXushort        size;                     
  FXushort        weight;                   
  FXushort        slant;                    
  FXushort        setwidth;                 
  FXushort        encoding;                 
  FXushort        flags;                    

  void setFont(const FXString& string);

  FXString getFont() const;
  };


class FXDC;
class FXDCWindow;


class FXAPI FXFont : public FXId {
  friend class FXDCWindow;
  FXDECLARE(FXFont)
protected:
  FXString  wantedName;         // Desired font font name
  FXString  actualName;         // Matched font font name
  FXushort  wantedSize;         // Font size (points*10)
  FXushort  actualSize;         // Actual size that was matched
  FXushort  wantedWeight;       // Font weight
  FXushort  actualWeight;       // Font weight
  FXushort  wantedSlant;        // Font slant
  FXushort  actualSlant;        // Font slant
  FXushort  wantedSetwidth;     // Relative setwidth
  FXushort  actualSetwidth;     // Relative setwidth
  FXushort  wantedEncoding;     // Character set encoding
  FXushort  actualEncoding;     // Character set encoding
  FXushort  hints;              // Matching hint flags
  FXushort  flags;              // Actual flags
  FXshort   angle;              // Angle
  void     *font;               // Info about the font
private:
#ifdef WIN32
  FXID      dc;
#endif
protected:
  FXFont();
  void* match(const FXString& wantfamily,const FXString& wantforge,FXuint wantsize,FXuint wantweight,FXuint wantslant,FXuint wantsetwidth,FXuint wantencoding,FXuint wanthints,FXint res);
private:
  FXFont(const FXFont&);
  FXFont &operator=(const FXFont&);
public:

  enum {
    Mono           = 1,         
    Variable       = 2,         
    Dual           = 4,         
    Cell           = 8,         
    Fixed          = Mono|Cell  
    };

  enum {
    Decorative     = 16,        
    Modern         = 32,        
    Roman          = 64,        
    Script         = 128,       
    Swiss          = 256,       
    System         = 512,       
    X11            = 1024,      
    Scalable       = 2048,      
    Polymorphic    = 4096,      
    Rotatable      = 8192       
    };

  enum {
    ReverseOblique = 1,         
    ReverseItalic  = 2,         
    Straight       = 5,         
    Italic         = 8,         
    Oblique        = 9          
    };

  enum {
    Thin           = 10,        
    ExtraLight     = 20,        
    Light          = 30,        
    Normal         = 40,        
    Medium         = 50,        
    DemiBold       = 60,        
    Bold           = 70,        
    ExtraBold      = 80,        
    Black          = 90         
    };

  enum {
    UltraCondensed = 50,        
    ExtraCondensed = 63,        
    Condensed      = 75,        
    SemiCondensed  = 87,        
    NonExpanded    = 100,       
    SemiExpanded   = 113,       
    Expanded       = 125,       
    ExtraExpanded  = 150,       
    UltraExpanded  = 200        
    };

public:

  FXFont(FXApp* a,const FXString& string);

  FXFont(FXApp* a,const FXString& face,FXuint size,FXuint weight=FXFont::Normal,FXuint slant=FXFont::Straight,FXuint encoding=FONTENCODING_DEFAULT,FXuint setwidth=FXFont::NonExpanded,FXuint h=0);

  FXFont(FXApp* a,const FXFontDesc& fontdesc);

  virtual void create();

  virtual void detach();

  virtual void destroy();

  FXString getFamily() const;

  FXString getFoundry() const;

  const FXString& getName() const { return wantedName; }

  const FXString& getActualName() const { return actualName; }

  FXuint getSize() const { return wantedSize; }

  FXuint getActualSize() const { return actualSize; }

  FXuint getWeight() const { return wantedWeight; }

  FXuint getActualWeight() const { return actualWeight; }

  FXuint getSlant() const { return wantedSlant; }

  FXuint getActualSlant() const { return actualSlant; }

  FXuint getEncoding() const { return wantedEncoding; }

  FXuint getActualEncoding() const { return actualEncoding; }

  FXuint getSetWidth() const { return wantedSetwidth; }

  FXuint getActualSetWidth() const { return actualSetwidth; }

  FXuint getHints() const { return hints; }

  FXuint getFlags() const { return flags; }

  virtual void setFontDesc(const FXFontDesc& fontdesc);

  FXFontDesc getFontDesc() const;

  FXFontDesc getActualFontDesc() const;

  FXint getAngle() const { return angle; }

  virtual void setAngle(FXint ang);

  FXString getFont() const;

  virtual void setFont(const FXString& string);

  virtual FXbool isFontMono() const;

  virtual FXbool hasChar(FXwchar ch) const;

  virtual FXwchar getMinChar() const;

  virtual FXwchar getMaxChar() const;

  virtual FXint leftBearing(FXwchar ch) const;

  virtual FXint rightBearing(FXwchar ch) const;

  virtual FXint getFontWidth() const;

  virtual FXint getFontHeight() const;

  virtual FXint getFontAscent() const;

  virtual FXint getFontDescent() const;

  virtual FXint getFontLeading() const;

  virtual FXint getFontSpacing() const;

  virtual FXint getCharWidth(const FXwchar ch) const;

  virtual FXint getTextWidth(const FXString& string) const;

  virtual FXint getTextWidth(const FXchar* string,FXuint length) const;

  virtual FXint getTextHeight(const FXString& string) const;

  virtual FXint getTextHeight(const FXchar *string,FXuint length) const;

  static FXuint styleFromString(const FXString& str);
  static FXString stringFromStyle(FXuint style);

  static FXuint slantFromString(const FXString& str);
  static FXString stringFromSlant(FXuint slant);

  static FXuint weightFromString(const FXString& str);
  static FXString stringFromWeight(FXuint weight);

  static FXuint setWidthFromString(const FXString& str);
  static FXString stringFromSetWidth(FXuint setwidth);

  static FXuint encodingFromString(const FXString& str);
  static FXString stringFromEncoding(FXuint encoding);

  static FXbool listFonts(FXFontDesc*& fonts,FXuint& numfonts,const FXString& face,FXuint wt=0,FXuint sl=0,FXuint sw=0,FXuint en=0,FXuint h=0);

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXFont();
  };


}

#endif