font_helper.h

Go to the documentation of this file.

//          __                _         _            _                     _            //
//         / _|  ___   _ __  | |_      | |__    ___ | | _ __    ___  _ __ | |__         //
//        | |_  / _ \ | '_ \ | __|     | '_ \  / _ \| || '_ \  / _ \| '__|| '_ \        //
//        |  _|| (_) || | | || |_      | | | ||  __/| || |_) ||  __/| | _ | | | |       //
//        |_|   \___/ |_| |_| \__|_____|_| |_| \___||_|| .__/  \___||_|(_)|_| |_|       //
//                               |_____|               |_|                              //
//                       basic font enumeration and selection                           //
//                                                                                      //

/*****************************************************************************

    X11workbench - X11 programmer's 'work bench' application and toolkit
    Copyright (c) 2010-2019 by Bob Frazier (aka 'Big Bad Bombastic Bob')


  DISCLAIMER:  The X11workbench application and toolkit software are supplied
               'as-is', with no warranties, either implied or explicit.
               Any claims to alleged functionality or features should be
               considered 'preliminary', and might not function as advertised.

  MIT-like license:

  There is no restriction as to what you can do with this software, so long
  as you include the above copyright notice and DISCLAIMER for any distributed
  work that is equal to or derived from this one, along with this paragraph
  that explains the terms of the license if the source is also being made
  available.  A "derived work" describes a work that uses a significant portion
  of the source files or algorithms that are included with this one.
  Specifically excluded from this are files that were generated by the software,
  or anything that is included with the software that is part of another package
  (such as files that were created or added during the 'configure' process).
  Specifically included is the use of part or all of any of the X11 workbench
  toolkit source or header files in your distributed application.  If you do not
  ship the source, the above copyright statement is still required to be placed
  in a reasonably prominent place, such as documentation, splash screens, and/or
  'about the application' dialog boxes.

  Use and distribution are in accordance with GPL, LGPL, and/or the above
  MIT-like license.  See COPYING and README files for more information.


  Additional information at http://sourceforge.net/projects/X11workbench

******************************************************************************/

#ifndef _FONT_HELPER_H_INCLUDED_
#define _FONT_HELPER_H_INCLUDED_

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


#ifdef X11WORKBENCH_TOOLKIT_HAVE_XFT
#include <X11/Xft/Xft.h> /* required header for Xft definitions */
#endif // X11WORKBENCH_TOOLKIT_HAVE_XFT

#ifndef _WINDOW_HELPER_H_INCLUDED_
typedef struct s_WB_EXTENT WB_EXTENT; // forward reference on WB_EXTENT structure for WBTextExtent()
#endif // _WINDOW_HELPER_H_INCLUDED_


// UTF-8 HANDLING
// X11 has XFree86 extensions with 'Xutf8' versions of a lot of things
// which is only applicable with the following
//#ifdef X_HAVE_UTF8_STRING
//   I use the utf8 version
// etc.
//
// Unfortunately many things that I use don't have that available
// like XTextWidth for one (maybe I could use Xutf8TextExtents?)
// Using Xmb and Xwc equivalent methods should work on Interix
//
#if defined(X_HAVE_UTF8_STRING) || defined(__DOXYGEN__)

#define WB_TEXT_EXTENTS Xutf8TextExtents        
#define WB_TEXT_ESCAPEMENT Xutf8TextEscapement  
#define WB_DRAW_STRING Xutf8DrawString          
#define WB_DRAW_TEXT Xutf8DrawText              
#define WB_LOOKUP_STRING Xutf8LookupString      
#else  // X_HAVE_UTF8_STRING

#warning UTF8 not supported, using 'MB' equivalents

#define WB_TEXT_EXTENTS XmbTextExtents          
#define WB_TEXT_ESCAPEMENT XmbTextEscapement    
#define WB_DRAW_STRING XmbDrawString            
#define WB_DRAW_TEXT XmbDrawText                
#define WB_LOOKUP_STRING XmbLookupString        
#endif // X_HAVE_UTF8_STRING


typedef struct WBFont
{
  struct WBFont *pShareNext;  
  struct WBFont *pSharePrev;  
  int iAscent;                
  int iDescent;               
  int iHeight;                
  int iAvgCharWidth;          
  int iMaxCharWidth;          
  XCharStruct max_bounds;     
  Display *pDisplay;          
#ifdef X11WORKBENCH_TOOLKIT_HAVE_XFT
  XftFont *pxftFont;          
  XftFontInfo *pxftFontInfo;  
#endif // X11WORKBENCH_TOOLKIT_HAVE_XFT
  XFontStruct *pFontStruct;   
  XFontSet fsFont;            
} * WB_FONT; // WB_FONT will always point to this struct, allocated using WBAlloc

typedef const struct WBFont *WB_FONTC;


// -----------------------------------------
// FONT INTERNAL-ONLY AND DEBUGGING FEATURES
// -----------------------------------------

typedef struct WBFontInfo
{
  char *szFoundry, *szFamily;
  int iWeight, iSlant, iWidth;
  char *szAdStyle;
  int iPixelSize, iPointSize, iResX, iResY, iSpacing, iAvgWidth;
  char *szRegistry, *szEncoding;
  char data[8];
} WB_FONT_INFO;


#ifndef NO_DEBUG

static void WBDumpFontStruct(const XFontStruct *pFont);


static void WBDumpMatchingFontNames(Display *pDisplay, const char *szFontName);


static void WBDumpFontSet(Display *pDisplay, XFontSet fontSet);
#endif // NO_DEBUG


void __internal_font_helper_init(void);


void __internal_font_helper_exit(void);


int WBFontEnableAntiAlias(void);


void WBFontSetEnableAntiAlias(int bEnable);

void WBFreeFont(Display *pDisplay, WB_FONT pFont);

WB_FONT WBCopyFont(Display *pDisplay, WB_FONTC pFont);

WB_FONT WBCopyModifyFont(Display *pDisplay, WB_FONTC pOriginal,
                         int iFontSize, int iFlags);

WB_FONT WBLoadFont(Display *pDisplay, const char *szFontName,
                   int iFontSize, int iFlags);

int WBFontAvgCharWidth(WB_FONTC pFont);


int WBFontMaxCharWidth(WB_FONTC pFont);


int WBFontDescent(WB_FONTC pFont);


int WBFontAscent(WB_FONTC pFont);


int WBFontHeight(WB_FONTC pFont);


XCharStruct WBFontMaxBounds(WB_FONTC pFont);


int WBTextWidth(WB_FONTC pFont, const char *szText, int cbText);


void WBTextExtent(WB_FONTC pFont, const char *szText, int cbText, WB_EXTENT *pExtent);


enum WBFontFlags
{
  WBFontFlag_PITCH_FIXED     = 1,       
  WBFontFlag_PITCH_VARIABLE  = 2,       
  WBFontFlag_PITCH_CONDENSED = 4,       
  WBFontFlag_PITCH_ANY       = 0,       
  WBFontFlag_PITCH_MASK      = 7,       

  WBFontFlag_STYLE_SANS      = 8,       
  WBFontFlag_STYLE_SERIF     = 0x10,    
  WBFontFlag_Reserved20      = 0x20,    
  WBFontFlag_Reserved40      = 0x40,    
  WBFontFlag_STYLE_ANY       = 0,       
  WBFontFlag_STYLE_MASK      = 0x78,    

  WBFontFlag_RASTER          = 0x80,    
  WBFontFlag_FREETYPE        = 0x100,   
  WBFontFlag_Reserved200     = 0x200,   
  WBFontFlag_FNDRY_ANY       = 0,       
  WBFontFlag_FNDRY_MASK      = 0x380,   

  // if the font size is > 0 then these bits apply
  WBFontFlag_SIZE_PIXELS     = 0,       
  WBFontFlag_SIZE_POINTS     = 0x400,   
  WBFontFlag_SIZE_TWIPS      = 0x800,   
  WBFontFlag_SIZE_Reserved   = 0xc00,   
  WBFontFlag_SIZE_MASK       = 0xc00,   

  WBFontFlag_WT_ANY          = 0,       
  WBFontFlag_WT_REGULAR      = 0x1000,  
  WBFontFlag_WT_MEDIUM       = 0x2000,  
  WBFontFlag_WT_DEMIBOLD     = 0x3000,  
  WBFontFlag_WT_BOLD         = 0x4000,  
  WBFontFlag_WT_Reserved5    = 0x5000,  
  WBFontFlag_WT_Reserved6    = 0x6000,  
  WBFontFlag_WT_MASK         = 0x7000,  

  WBFontFlag_SLANT_REGULAR   = 0x10000, 
  WBFontFlag_SLANT_OBLIQUE   = 0x20000, 
  WBFontFlag_SLANT_ITALIC    = 0x30000, 
  WBFontFlag_SLANT_ANY       = 0,       
  WBFontFlag_SLANT_MASK      = 0x30000, 

  WBFontFlag_WIDTH_NORMAL    = 0x40000, 
  WBFontFlag_WIDTH_SEMICOND  = 0x80000, 
  WBFontFlag_WIDTH_Reserved  = 0xc0000, 
  WBFontFlag_WIDTH_ANY       = 0,       
  WBFontFlag_WIDTH_MASK      = 0xc0000, 

  // reserved - font registry and encoding (installed X11 fonts typically include most if not all of these)
  WBFontFlag_REG_ISO8859     = 0x100000, 
  WBFontFlag_REG_ISO646_1991 = 0x200000, 
  WBFontFlag_REG_ASCII       = 0x300000, 
  WBFontFlag_REG_FNTSPECIFIC = 0x400000, 
  WBFontFlag_REG_MISC        = 0x500000, 
  WBFontFlag_REG_GB2312_1980 = 0x600000, 
  WBFontFlag_REG_ADOBE       = 0x700000, 
  WBFontFlag_REG_Reserved8   = 0x800000, 
  WBFontFlag_REG_Reserved9   = 0x900000, 
  WBFontFlag_REG_ReservedA   = 0xa00000, 
  WBFontFlag_REG_ReservedB   = 0xb00000, 
  WBFontFlag_REG_ReservedC   = 0xc00000, 
  WBFontFlag_REG_ReservedD   = 0xd00000, 
  WBFontFlag_REG_ReservedE   = 0xe00000, 
  WBFontFlag_REG_ReservedF   = 0xf00000, 
  WBFontFlag_REG_MASK        = 0xf00000, 

  // TODO: flags for 'encoding' ?

  WBFontFlag_WHATEVER        = 0    // don't force anything (zero, default)
};



//                                                                                                                   //
//   _                                       _____              _     ____                                     _     //
//  | |     ___   __ _   __ _   ___  _   _  |  ___|___   _ __  | |_  / ___|  _   _  _ __   _ __    ___   _ __ | |_   //
//  | |    / _ \ / _` | / _` | / __|| | | | | |_  / _ \ | '_ \ | __| \___ \ | | | || '_ \ | '_ \  / _ \ | '__|| __|  //
//  | |___|  __/| (_| || (_| || (__ | |_| | |  _|| (_) || | | || |_   ___) || |_| || |_) || |_) || (_) || |   | |_   //
//  |_____|\___| \__, | \__,_| \___| \__, | |_|   \___/ |_| |_| \__| |____/  \__,_|| .__/ | .__/  \___/ |_|    \__|  //
//               |___/               |___/                                         |_|    |_|                        //
//                                                                                                                   //


XFontStruct *WBLoadFontX(Display *pDisplay, const char *szFontName,
                         int iFontSize, int iFlags);

XFontStruct *WBCopyFontX(XFontStruct *pFont);

XFontStruct *WBLoadModifyFontX(Display *pDisplay, const XFontStruct *pOriginal,
                               int iFontSize, int iFlags);

XFontSet WBCopyModifyFontSet(Display *pDisplay, XFontSet fsOrig, int iFontSize, int iFlags);


int WBFontAvgCharWidthX(Display *pDisplay, const XFontStruct *pFont);


int WBFontSetDescent(Display *pDisplay, XFontSet fontSet);


int WBFontSetAscent(Display *pDisplay, XFontSet fontSet);


int WBFontSetHeight(Display *pDisplay, XFontSet fontSet);


int WBFontSetAvgCharWidth(Display *pDisplay, XFontSet fontSet);


XCharStruct WBFontSetMaxBounds(Display *pDisplay, XFontSet fontSet);


XFontSet WBFontSetFromFont(Display *pDisplay, const XFontStruct *pFont);


XFontStruct * WBFontFromFontSet(Display *pDisplay, XFontSet fontSet);


XFontSet WBFontSetFromFontSingle(Display *pDisplay, const XFontStruct *pFont);


int WBTextWidthX(XFontSet fontSet, const char *szText, int cbText);


void WBTextExtentX(XFontSet fontSet, const char *szText, int cbText, WB_EXTENT *pExtent);


#ifdef NO_DEBUG
#define WBDumpFontInfo(X) /* do nothing macro */
#else // NO_DEBUG

void WBDumpFontInfo(const char *pSpec);  // debugging function - dumps a list of fonts and info

#endif // NO_DEBUG



#ifdef __cplusplus
};
#endif // __cplusplus


#endif // _FONT_HELPER_H_INCLUDED_