common.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2012 Josh Bialkowski (jbialk@mit.edu)
 *
 *  This file is part of cppfontconfig.
 *
 *  cppfontconfig is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  cppfontconfig 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with cppfontconfig.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef CPPFONTCONFIG_COMMON_H_
#define CPPFONTCONFIG_COMMON_H_





#define FCMM_DONT_CONSTRUCT( TYPE ) \
private:                        \
    template <typename T>       \
    TYPE( const T& param )      \
    {                           \
        struct TYPE##_is_an_opaque_type_use_create_method{} obj;    \
        int i = obj;            \
    }                           \


namespace fontconfig
{


const unsigned int MAJOR    = 2;
const unsigned int MINOR    = 10;
const unsigned int REVISION = 0;
const unsigned int VERSION  = ((MAJOR * 10000) + (MINOR * 100) + (REVISION));

const char* const CACHE_VERSION = "3";


typedef unsigned char   Char8_t;
typedef unsigned short  Char16_t;
typedef unsigned int    Char32_t;
typedef int             Bool_t;
typedef int             Object_t;

const char* const FAMILY          = "family";         
const char* const STYLE           = "style";          
const char* const SLANT           = "slant";          
const char* const WEIGHT          = "weight";         
const char* const SIZE            = "size";           
const char* const ASPECT          = "aspect";         
const char* const PIXEL_SIZE      = "pixelsize";      
const char* const SPACING         = "spacing";        
const char* const FOUNDRY         = "foundry";        
const char* const ANTIALIAS       = "antialias";      
const char* const HINTING         = "hinting";        
const char* const HINT_STYLE      = "hintstyle";      
const char* const VERTICAL_LAYOUT = "verticallayout"; 
const char* const AUTOHINT        = "autohint";       

/* GLOBAL_ADVANCE is deprecated. this is simply ignored on freetype 2.4.5 or later */
const char* const GLOBAL_ADVANCE  = "globaladvance";  
const char* const WIDTH           = "width";          
const char* const FILE            = "file";           
const char* const INDEX           = "index";          
const char* const FT_FACE         = "ftface";         
const char* const RASTERIZER      = "rasterizer";     
const char* const OUTLINE         = "outline";        
const char* const SCALABLE        = "scalable";       
const char* const SCALE           = "scale";          
const char* const DPI             = "dpi";            
const char* const RGBA            = "rgba";           
const char* const MINSPACE        = "minspace";       
const char* const SOURCE          = "source";         
const char* const CHARSET         = "charset";        
const char* const LANG            = "lang";           
const char* const FONTVERSION     = "fontversion";    
const char* const FULLNAME        = "fullname";       
const char* const FAMILYLANG      = "familylang";     
const char* const STYLELANG       = "stylelang";      
const char* const FULLNAMELANG    = "fullnamelang";   
const char* const CAPABILITY      = "capability";     
const char* const FONTFORMAT      = "fontformat";     
const char* const EMBOLDEN        = "embolden";       
const char* const EMBEDDED_BITMAP = "embeddedbitmap"; 
const char* const DECORATIVE      = "decorative";     
const char* const LCD_FILTER      = "lcdfilter";      
const char* const NAMELANG        = "namelang";       

namespace key
{

enum Key
{
    FAMILY,
    STYLE,
    SLANT,
    WEIGHT,
    SIZE,
    ASPECT,
    PIXEL_SIZE,
    SPACING,
    FOUNDRY,
    ANTIALIAS,
    HINTING,
    HINT_STYLE,
    VERTICAL_LAYOUT,
    AUTOHINT,
    GLOBAL_ADVANCE,
    WIDTH,
    FILE,
    INDEX,
    FT_FACE,
    RASTERIZER,
    OUTLINE,
    SCALABLE,
    SCALE,
    DPI,
    RGBA,
    MINSPACE,
    SOURCE,
    CHARSET,
    LANG,
    FONTVERSION,
    FULLNAME,
    FAMILYLANG,
    STYLELANG,
    FULLNAMELANG,
    CAPABILITY,
    FONTFORMAT,
    EMBOLDEN,
    EMBEDDED_BITMAP,
    DECORATIVE,
    LCD_FILTER,
    NAMELANG,
};

}

typedef key::Key Key_t;



// these "3" should probably not be written by hand, but I'm trying to
// avoid any macros... this can be done with boost::mpl
// (http://stackoverflow.com/questions/4693819/c-template-string-concatenation)
// but it seems kind of ridiculous to add that dependency to save 6 seconds
// of maintanance
const char* const CACHE_SUFFIX    = ".cache-3";
const char* const DIR_CACHE_FILE  = "fonts.cache-3";
const char* const USER_CACHE_FILE = ".fonts.cache-3";

// Adjust outline rasterizer
const char* const CHAR_WIDTH  = "charwidth";  
const char* const CHAR_HEIGHT = "charheight"; 
const char* const MATRIX      = "matrix";     



namespace weight
{

const unsigned int THIN         = 0;
const unsigned int EXTRALIGHT   = 40;
const unsigned int ULTRALIGHT   = EXTRALIGHT;
const unsigned int LIGHT        = 50;
const unsigned int BOOK         = 75;
const unsigned int REGULAR      = 80;
const unsigned int NORMAL       = REGULAR;
const unsigned int MEDIUM       = 100;
const unsigned int DEMIBOLD     = 180;
const unsigned int SEMIBOLD     = DEMIBOLD;
const unsigned int BOLD         = 200;
const unsigned int EXTRABOLD    = 205;
const unsigned int ULTRABOLD    = EXTRABOLD;
const unsigned int BLACK        = 210;
const unsigned int HEAVY        = BLACK;
const unsigned int EXTRABLACK   = 215;
const unsigned int ULTRABLACK   = EXTRABLACK;

}


namespace slant
{

const unsigned int ROMAN    = 0;
const unsigned int ITALIC   = 100;
const unsigned int OBLIQUE  = 110;

}

namespace width
{

const unsigned int ULTRACONDENSED   = 50;
const unsigned int EXTRACONDENSED   = 63;
const unsigned int CONDENSED        = 75;
const unsigned int SEMICONDENSED    = 87;
const unsigned int NORMAL           = 100;
const unsigned int SEMIEXPANDED     = 113;
const unsigned int EXPANDED         = 125;
const unsigned int EXTRAEXPANDED    = 150;
const unsigned int ULTRAEXPANDED    = 200;

}

namespace rgba
{

const unsigned int UNKNOWN  = 0;
const unsigned int RGB      = 1;
const unsigned int BGR      = 2;
const unsigned int VRGB     = 3;
const unsigned int VBGR     = 4;
const unsigned int NONE     = 5;

}

namespace hint
{

const unsigned int NONE     = 0;
const unsigned int SLIGHT   = 1;
const unsigned int MEDIUM   = 2;
const unsigned int FULL     = 3;

}

namespace lcd
{

const unsigned int NONE     = 0;
const unsigned int DEFAULT  = 1;
const unsigned int LIGHT    = 2;
const unsigned int LEGACY   = 3;

}

namespace type
{

enum Type {
    Void,
    Integer,
    Double,
    String,
    Bool,
    Matrix,
    CharSet,
    FTFace,
    LangSet
};

}

typedef type::Type Type_t;

namespace match
{

enum MatchKind
{
    Pattern,
    Font,
    Scan
};

}

typedef match::MatchKind MatchKind_t;

namespace qual
{

enum Qual
{
    Any,
    All,
    First,
    NotFirst
};


}

typedef qual::Qual Qual_t;


namespace op
{

enum Op
{
    Integer, Double, String, Matrix, Range, Bool, CharSet, LangSet,
    Nil,
    Field, Const,
    Assign, AssignReplace,
    PrependFirst, Prepend, Append, AppendLast,
    Quest,
    Or, And, Equal, NotEqual,
    Contains, Listing, NotContains,
    Less, LessEqual, More, MoreEqual,
    Plus, Minus, Times, Divide,
    Not, Comma, Floor, Ceil, Round, Trunc,
    Invalid
};

}

typedef op::Op Op_t;


namespace lang
{

enum Result
{
    Equal                 = 0,
    DifferentCountry      = 1,
    DifferentTerritory    = 1,
    DifferentLang         = 2
};

}

typedef lang::Result LangResult_t;


namespace result
{

enum Result
{
    Match,
    NoMatch,
    TypeMismatch,
    NoId,
    OutOfMemory
};

}

typedef result::Result Result_t;


namespace setname
{

enum SetName
{
    System      = 0,
    Application = 1
};

}

typedef setname::SetName SetName_t;

namespace endian
{
    enum Endian
    {
        Big,
        Little
    };
}

typedef endian::Endian Endian_t;

}













#endif // COMMON_H_