Onyx2D/O2Font.h

   1 /* Copyright (c) 2008 Christopher J. W. Lloyd
   2
   3 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:
   4
   5 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
   6
   7 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. */
   8 #import <Foundation/NSObject.h>
   9 #import <Onyx2D/O2Geometry.h>
  10
  11 @class O2Font, O2Encoding;
  12
  13 typedef O2Font *O2FontRef;
  14
  15 typedef uint16_t O2Glyph;
  16
  17 #import <Onyx2D/O2Context.h>
  18 #import <Onyx2D/O2DataProvider.h>
  19 //#import <Onyx2D/O2Image.h>
  20
  21 #define O2FONTLOGGINGENABLED 0
  22
  23 #if O2FONTLOGGINGENABLED
  24 #define O2FontLog(format, args...) NSLog(@"%s line: %d | %@", __PRETTY_FUNCTION__, __LINE__, [NSString stringWithFormat:format, ##args])
  25 #else
  26 #define O2FontLog(format, args...)
  27 #endif
  28
  29 @class NSData;
  30
  31 typedef enum {
  32     O2FontPlatformTypeGDI,
  33     O2FontPlatformTypeFreeType,
  34 } O2FontPlatformType;
  35
  36 @interface O2Font : NSObject {
  37     O2FontPlatformType _platformType;
  38     NSString *_name;
  39     NSCharacterSet *_coveredCharSet;
  40     O2DataProviderRef _provider;
  41     int _unitsPerEm;
  42     int _ascent;
  43     int _descent;
  44     int _leading;
  45     int _capHeight;
  46     int _xHeight;
  47     O2Float _italicAngle;
  48     O2Float _stemV;
  49     O2Rect _bbox;
  50     int _numberOfGlyphs;
  51     int *_advances;
  52     O2Glyph *_MacRomanEncoding;
  53 }
  54
  55 // Font name mapping : platform specific font class may override
  56 // these methods in a category O2Font(<platformname>) if some
  57 // mapping is needed between the font postscript names and the
  58 // native names used by the platform
  59 + (NSString *)nativeFontNameForPostscriptName:(NSString *)name;
  60 + (NSString *)postscriptNameForNativeName:(NSString *)name;
  61 + (NSString *)postscriptNameForDisplayName:(NSString *)name;
  62 + (NSString *)displayNameForPostscriptName:(NSString *)name;
  63 + (NSString *)postscriptNameForFontName:(NSString *)name;
  64
  65 + (NSArray *)preferredFontNames;
  66 + (void)setPreferredFontNames:(NSArray *)fontNames;
  67
  68 - initWithFontName:(NSString *)name;
  69 - initWithDataProvider:(O2DataProviderRef)provider;
  70
  71 - (NSData *)copyTableForTag:(uint32_t)tag;
  72
  73 - (O2Glyph)glyphWithGlyphName:(NSString *)name;
  74 - (NSString *)copyGlyphNameForGlyph:(O2Glyph)glyph;
  75
  76 - (NSCharacterSet *)coveredCharacterSet;
  77
  78 - (float)nativeSizeForSize:(float)size;
  79
  80 - (void)fetchAdvances;
  81
  82 - (O2Encoding *)createEncodingForTextEncoding:(O2TextEncoding)encoding;
  83
  84 O2FontRef O2FontCreateWithFontName(NSString *name);
  85 O2FontRef O2FontCreateWithDataProvider(O2DataProviderRef provider);
  86 O2FontRef O2FontRetain(O2FontRef self);
  87 void O2FontRelease(O2FontRef self);
  88
  89 O2FontPlatformType O2FontGetPlatformType(O2Font *self);
  90 CFStringRef O2FontCopyFullName(O2FontRef self);
  91 int O2FontGetUnitsPerEm(O2FontRef self);
  92 int O2FontGetAscent(O2FontRef self);
  93 int O2FontGetDescent(O2FontRef self);
  94 int O2FontGetLeading(O2FontRef self);
  95 int O2FontGetCapHeight(O2FontRef self);
  96 int O2FontGetXHeight(O2FontRef self);
  97 O2Float O2FontGetItalicAngle(O2FontRef self);
  98 O2Float O2FontGetStemV(O2FontRef self);
  99 O2Rect O2FontGetFontBBox(O2FontRef self);
 100
 101 NSCharacterSet *O2FontGetCoveredCharacterSet(O2FontRef self);
 102
 103 size_t O2FontGetNumberOfGlyphs(O2FontRef self);
 104 BOOL O2FontGetGlyphAdvances(O2FontRef self, const O2Glyph *glyphs, size_t count, int *advances);
 105
 106 O2Glyph O2FontGetGlyphWithGlyphName(O2FontRef self, CFStringRef name);
 107 NSString *O2FontCopyGlyphNameForGlyph(O2FontRef self, O2Glyph glyph);
 108
 109 NSData *O2FontCopyTableForTag(O2FontRef self, uint32_t tag);
 110
 111 uint16_t O2FontUnicodeForGlyphName(CFStringRef name);
 112
 113 @end