/
nsfont.m
1541 lines (1318 loc) · 47.4 KB
/
nsfont.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Font back-end driver for the NeXT/Open/GNUstep and MacOSX window system.
See font.h
Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs 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.
GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
Author: Adrian Robert (arobert@cogsci.ucsd.edu)
*/
/* This should be the first include, as it may set up #defines affecting
interpretation of even the system includes. */
#include "config.h"
#include <setjmp.h>
#include "lisp.h"
#include "dispextern.h"
#include "composite.h"
#include "blockinput.h"
#include "charset.h"
#include "frame.h"
#include "window.h"
#include "fontset.h"
#include "nsterm.h"
#include "frame.h"
#include "character.h"
#include "font.h"
/* TODO: Drop once we can assume gnustep-gui 0.17.1. */
#ifdef NS_IMPL_GNUSTEP
#import <AppKit/NSFontDescriptor.h>
#endif
#define NSFONT_TRACE 0
extern Lisp_Object Qns;
extern Lisp_Object Qnormal, Qbold, Qitalic, Qcondensed, Qexpanded;
static Lisp_Object Vns_reg_to_script;
static Lisp_Object Qapple, Qroman, Qmedium;
extern Lisp_Object Qappend;
extern Lisp_Object ns_antialias_text;
extern float ns_antialias_threshold;
extern int ns_tmp_flags;
extern struct nsfont_info *ns_tmp_font;
/* font glyph and metrics caching functions, implemented at end */
static void ns_uni_to_glyphs (struct nsfont_info *font_info,
unsigned char block);
static void ns_glyph_metrics (struct nsfont_info *font_info,
unsigned char block);
/* ==========================================================================
Utilities
========================================================================== */
/* Replace spaces w/another character so emacs core font parsing routines
aren't thrown off. */
static void
ns_escape_name (char *name)
{
int i =0, len =strlen (name);
for ( ; i<len; i++)
if (name[i] == ' ')
name[i] = '_';
}
/* Reconstruct spaces in a font family name passed through emacs. */
static void
ns_unescape_name (char *name)
{
int i =0, len =strlen (name);
for ( ; i<len; i++)
if (name[i] == '_')
name[i] = ' ';
}
/* Extract family name from a font spec. */
static NSString *
ns_get_family (Lisp_Object font_spec)
{
Lisp_Object tem = AREF (font_spec, FONT_FAMILY_INDEX);
if (NILP (tem))
return nil;
else
{
char *tmp = strdup (SDATA (SYMBOL_NAME (tem)));
NSString *family;
ns_unescape_name (tmp);
family = [NSString stringWithUTF8String: tmp];
free (tmp);
return family;
}
}
/* Return 0 if attr not set, else value (which might also be 0).
On Leopard 0 gets returned even on descriptors where the attribute
was never set, so there's no way to distinguish between unspecified
and set to not have. Callers should assume 0 means unspecified. */
static float
ns_attribute_fvalue (NSFontDescriptor *fdesc, NSString *trait)
{
NSDictionary *tdict = [fdesc objectForKey: NSFontTraitsAttribute];
NSNumber *val = [tdict objectForKey: trait];
return val == nil ? 0.0 : [val floatValue];
}
/* Converts FONT_WEIGHT, FONT_SLANT, FONT_WIDTH, plus family and script/lang
to NSFont descriptor. Information under extra only needed for matching. */
#define STYLE_REF 100
static NSFontDescriptor
*ns_spec_to_descriptor(Lisp_Object font_spec)
{
NSFontDescriptor *fdesc;
NSMutableDictionary *fdAttrs = [NSMutableDictionary new];
NSMutableDictionary *tdict = [NSMutableDictionary new];
NSString *family = ns_get_family (font_spec);
float n;
/* add each attr in font_spec to fdAttrs.. */
n = min (FONT_WEIGHT_NUMERIC (font_spec), 200);
if (n != -1 && n != STYLE_REF)
[tdict setObject: [NSNumber numberWithFloat: (n - 100.0) / 100.0]
forKey: NSFontWeightTrait];
n = min (FONT_SLANT_NUMERIC (font_spec), 200);
if (n != -1 && n != STYLE_REF)
[tdict setObject: [NSNumber numberWithFloat: (n - 100.0) / 100.0]
forKey: NSFontSlantTrait];
n = min (FONT_WIDTH_NUMERIC (font_spec), 200);
if (n > -1 && (n > STYLE_REF + 10 || n < STYLE_REF - 10))
[tdict setObject: [NSNumber numberWithFloat: (n - 100.0) / 100.0]
forKey: NSFontWidthTrait];
if ([tdict count] > 0)
[fdAttrs setObject: tdict forKey: NSFontTraitsAttribute];
fdesc = [NSFontDescriptor fontDescriptorWithFontAttributes: fdAttrs];
if (family != nil)
fdesc = [fdesc fontDescriptorWithFamily: family];
return fdesc;
}
/* Converts NSFont descriptor to FONT_WEIGHT, FONT_SLANT, FONT_WIDTH, etc.. */
static Lisp_Object
ns_descriptor_to_entity (NSFontDescriptor *desc, Lisp_Object extra, char *style)
{
Lisp_Object font_entity = font_make_entity ();
/* NSString *psName = [desc postscriptName]; */
NSString *family = [desc objectForKey: NSFontFamilyAttribute];
unsigned int traits = [desc symbolicTraits];
char *escapedFamily;
/* Shouldn't happen, but on Tiger fallback desc gets name but no family. */
if (family == nil)
family = [desc objectForKey: NSFontNameAttribute];
if (family == nil)
family = [[NSFont userFixedPitchFontOfSize: 0] familyName];
escapedFamily = strdup ([family UTF8String]);
ns_escape_name (escapedFamily);
ASET (font_entity, FONT_TYPE_INDEX, Qns);
ASET (font_entity, FONT_FOUNDRY_INDEX, Qapple);
ASET (font_entity, FONT_FAMILY_INDEX, intern (escapedFamily));
ASET (font_entity, FONT_ADSTYLE_INDEX, style ? intern (style) : Qnil);
ASET (font_entity, FONT_REGISTRY_INDEX, Qiso10646_1);
FONT_SET_STYLE (font_entity, FONT_WEIGHT_INDEX,
traits & NSFontBoldTrait ? Qbold : Qmedium);
/* FONT_SET_STYLE (font_entity, FONT_WEIGHT_INDEX,
make_number (100 + 100
* ns_attribute_fvalue (desc, NSFontWeightTrait)));*/
FONT_SET_STYLE (font_entity, FONT_SLANT_INDEX,
traits & NSFontItalicTrait ? Qitalic : Qnormal);
/* FONT_SET_STYLE (font_entity, FONT_SLANT_INDEX,
make_number (100 + 100
* ns_attribute_fvalue (desc, NSFontSlantTrait)));*/
FONT_SET_STYLE (font_entity, FONT_WIDTH_INDEX,
traits & NSFontCondensedTrait ? Qcondensed :
traits & NSFontExpandedTrait ? Qexpanded : Qnormal);
/* FONT_SET_STYLE (font_entity, FONT_WIDTH_INDEX,
make_number (100 + 100
* ns_attribute_fvalue (desc, NSFontWidthTrait)));*/
ASET (font_entity, FONT_SIZE_INDEX, make_number (0));
ASET (font_entity, FONT_AVGWIDTH_INDEX, make_number (0));
ASET (font_entity, FONT_SPACING_INDEX,
make_number([desc symbolicTraits] & NSFontMonoSpaceTrait
? FONT_SPACING_MONO : FONT_SPACING_PROPORTIONAL));
ASET (font_entity, FONT_EXTRA_INDEX, extra);
ASET (font_entity, FONT_OBJLIST_INDEX, Qnil);
if (NSFONT_TRACE)
{
fprintf (stderr, "created font_entity:\n ");
debug_print (font_entity);
}
free (escapedFamily);
return font_entity;
}
/* Default font entity. */
static Lisp_Object
ns_fallback_entity ()
{
return ns_descriptor_to_entity ([[NSFont userFixedPitchFontOfSize: 0]
fontDescriptor], Qnil, NULL);
}
/* Utility: get width of a char c in screen font sfont */
static float
ns_char_width (NSFont *sfont, int c)
{
NSString *cstr = [NSString stringWithFormat: @"%c", c];
#ifdef NS_IMPL_COCOA
return max (2.0, [cstr sizeWithAttributes:
[NSDictionary dictionaryWithObject:sfont
forKey:NSFontAttributeName]].width);
#else
/* deprecated in OS X 10.4 */
return = max (2.0, [sfont widthOfString: cstr]);
#endif
}
/* Return whether set1 covers set2 to a reasonable extent given by pct.
We check, out of each 16 unicode char range containing chars in set2,
whether at least one character is present in set1.
This must be true for pct of the pairs to consider it covering. */
static BOOL
ns_charset_covers(NSCharacterSet *set1, NSCharacterSet *set2, float pct)
{
const unsigned short *bytes1 = [[set1 bitmapRepresentation] bytes];
const unsigned short *bytes2 = [[set2 bitmapRepresentation] bytes];
int i, off = 0, tot = 0;
for (i=0; i<4096; i++, bytes1++, bytes2++)
if (*bytes2)
{
tot++;
if (*bytes1 == 0) // *bytes1 & *bytes2 != *bytes2
off++;
}
//fprintf(stderr, "off = %d\ttot = %d\n", off,tot);
return (float)off / tot < 1.0 - pct;
}
/* Convert :lang property to a script. Use of :lang property by font backend
seems to be limited for now (2009/05) to ja, zh, and ko. */
static NSString
*ns_lang_to_script (Lisp_Object lang)
{
if (!strcmp (SDATA (SYMBOL_NAME (lang)), "ja"))
return @"han";
/* NOTE: ja given for any hanzi that's also a kanji, but Chinese fonts
have more characters. */
else if (!strcmp (SDATA (SYMBOL_NAME (lang)), "zh"))
return @"han";
else if (!strcmp (SDATA (SYMBOL_NAME (lang)), "ko"))
return @"hangul";
else
return @"";
}
/* Convert OTF 4-letter script code to emacs script name. (Why can't
everyone just use some standard unicode names for these?) */
static NSString
*ns_otf_to_script (Lisp_Object otf)
{
Lisp_Object script = assq_no_quit (XCAR (otf), Votf_script_alist);
return CONSP (script)
? [NSString stringWithUTF8String: SDATA (SYMBOL_NAME XCDR ((script)))]
: @"";
}
/* Convert a font registry, such as */
static NSString
*ns_registry_to_script (char *reg)
{
Lisp_Object script, r, rts = Vns_reg_to_script;
while CONSP (rts)
{
r = XCAR (XCAR (rts));
if (!strncmp(SDATA(r), reg, strlen(SDATA(r))))
{
script = XCDR (XCAR (rts));
return [NSString stringWithUTF8String: SDATA (SYMBOL_NAME (script))];
}
rts = XCDR (rts);
}
return @"";
}
/* Searches the :script, :lang, and :otf extra-bundle properties of the spec,
plus registry regular property, for something that can be mapped to a
unicode script. Empty string returned if no script spec found. */
static NSString
*ns_get_req_script (Lisp_Object font_spec)
{
Lisp_Object reg = AREF (font_spec, FONT_REGISTRY_INDEX);
Lisp_Object extra = AREF (font_spec, FONT_EXTRA_INDEX);
/* The extra-bundle properties have priority. */
for ( ; CONSP (extra); extra = XCDR (extra))
{
Lisp_Object tmp = XCAR (extra);
if (CONSP (tmp))
{
Lisp_Object key = XCAR (tmp), val = XCDR (tmp);
if (EQ (key, QCscript) && SYMBOLP (val))
return [NSString stringWithUTF8String:
SDATA (SYMBOL_NAME (val))];
if (EQ (key, QClang) && SYMBOLP (val))
return ns_lang_to_script (val);
if (EQ (key, QCotf) && CONSP (val) && SYMBOLP (XCAR (val)))
return ns_otf_to_script (val);
}
}
/* If we get here, check the charset portion of the registry. */
if (! NILP (reg))
{
/* XXX: iso10646 is passed in for non-ascii latin-1 characters
(which causes box rendering if we don't treat it like iso8858-1)
but also for ascii (which causes unnecessary font substitution). */
#if 0
if (EQ (reg, Qiso10646_1))
reg = Qiso8859_1;
#endif
return ns_registry_to_script (SDATA (SYMBOL_NAME (reg)));
}
return @"";
}
/* This small function is static in fontset.c. If it can be made public for
all ports, remove this, but otherwise it doesn't seem worth the ifdefs. */
static void
accumulate_script_ranges (Lisp_Object arg, Lisp_Object range, Lisp_Object val)
{
if (EQ (XCAR (arg), val))
{
if (CONSP (range))
XSETCDR (arg, Fcons (Fcons (XCAR (range), XCDR (range)), XCDR (arg)));
else
XSETCDR (arg, Fcons (Fcons (range, range), XCDR (arg)));
}
}
/* Use the unicode range information in Vchar_script_table to convert a script
name into an NSCharacterSet. */
static NSCharacterSet
*ns_script_to_charset (NSString *scriptName)
{
NSMutableCharacterSet *charset = [NSMutableCharacterSet new];
Lisp_Object script = intern ([scriptName UTF8String]);
Lisp_Object script_list = XCHAR_TABLE (Vchar_script_table)->extras[0];
if (! NILP (Fmemq (script, script_list)))
{
Lisp_Object ranges, range_list;
ranges = Fcons (script, Qnil);
map_char_table (accumulate_script_ranges, Qnil, Vchar_script_table,
ranges);
range_list = Fnreverse (XCDR (ranges));
if (! NILP (range_list))
{
for (; CONSP (range_list); range_list = XCDR (range_list))
{
int start = XINT (XCAR (XCAR (range_list)));
int end = XINT (XCDR (XCAR (range_list)));
if (NSFONT_TRACE)
debug_print (XCAR (range_list));
if (end < 0x10000)
[charset addCharactersInRange:
NSMakeRange (start, end-start)];
}
}
}
return charset;
}
/* Return an array of font families containing characters for the given
script, for the given coverage criterion, including at least LastResort.
Results are cached by script for faster access.
If none are found, we reduce the percentage and try again, until 5%.
This provides a font with at least some characters if such can be found.
We don't use isSupersetOfSet: because (a) it doesn't work on Tiger, and
(b) need approximate match as fonts covering full unicode ranges are rare. */
static NSSet
*ns_get_covering_families (NSString *script, float pct)
{
static NSMutableDictionary *scriptToFamilies = nil;
NSMutableSet *families;
if (NSFONT_TRACE)
NSLog(@"Request covering families for script: '%@'", script);
if (scriptToFamilies == nil)
scriptToFamilies = [[NSMutableDictionary alloc] init];
if ((families = [scriptToFamilies objectForKey: script]) == nil)
{
NSFontManager *fontMgr = [NSFontManager sharedFontManager];
NSArray *allFamilies = [fontMgr availableFontFamilies];
if ([script length] == 0)
families = [NSMutableSet setWithArray: allFamilies];
else
{
NSCharacterSet *charset = ns_script_to_charset (script);
NSString *family;
families = [NSMutableSet setWithCapacity: 10];
while (1)
{
NSEnumerator *allFamiliesEnum = [allFamilies objectEnumerator];
while (family = [allFamiliesEnum nextObject])
{
NSCharacterSet *fset = [[fontMgr fontWithFamily: family
traits: 0 weight: 5 size: 12.0] coveredCharacterSet];
/* Some fonts on OS X, maybe many on GNUstep, return nil. */
if (fset == nil)
fset = [NSCharacterSet characterSetWithRange:
NSMakeRange (0, 127)];
if (ns_charset_covers(fset, charset, pct))
[families addObject: family];
}
pct -= 0.2;
if ([families count] > 0 || pct < 0.05)
break;
}
}
#ifdef NS_IMPL_COCOA
if ([families count] == 0)
[families addObject: @"LastResort"];
#endif
[scriptToFamilies setObject: families forKey: script];
}
if (NSFONT_TRACE)
NSLog(@" returning %d families", [families count]);
return families;
}
/* Implementation for list() and match(). List() can return nil, match()
must return something. Strategy is to drop family name from attribute
matching set for match. */
static Lisp_Object
ns_findfonts (Lisp_Object font_spec, BOOL isMatch)
{
Lisp_Object tem, list = Qnil;
NSFontDescriptor *fdesc, *desc;
NSMutableSet *fkeys;
NSArray *matchingDescs;
NSEnumerator *dEnum;
NSString *family;
NSSet *cFamilies;
BOOL foundItal = NO;
if (NSFONT_TRACE)
{
fprintf (stderr, "nsfont: %s for fontspec:\n ",
(isMatch ? "match" : "list"));
debug_print (font_spec);
}
cFamilies = ns_get_covering_families (ns_get_req_script (font_spec), 0.90);
fdesc = ns_spec_to_descriptor (font_spec);
fkeys = [NSMutableSet setWithArray: [[fdesc fontAttributes] allKeys]];
if (isMatch)
[fkeys removeObject: NSFontFamilyAttribute];
matchingDescs = [fdesc matchingFontDescriptorsWithMandatoryKeys: fkeys];
if (NSFONT_TRACE)
NSLog(@"Got desc %@ and found %d matching fonts from it: ", fdesc,
[matchingDescs count]);
for (dEnum = [matchingDescs objectEnumerator]; desc = [dEnum nextObject]; )
{
if (![cFamilies containsObject:
[desc objectForKey: NSFontFamilyAttribute]])
continue;
tem = ns_descriptor_to_entity (desc,
AREF (font_spec, FONT_EXTRA_INDEX),
NULL);
if (isMatch)
return tem;
list = Fcons (tem, list);
if (fabs (ns_attribute_fvalue (desc, NSFontSlantTrait)) > 0.05)
foundItal = YES;
}
/* Add synthItal member if needed. */
family = [fdesc objectForKey: NSFontFamilyAttribute];
if (family != nil && !foundItal && XINT (Flength (list)) > 0)
{
NSFontDescriptor *sDesc = [[[NSFontDescriptor new]
fontDescriptorWithSymbolicTraits: NSFontItalicTrait]
fontDescriptorWithFamily: family];
list = Fcons (ns_descriptor_to_entity (sDesc,
AREF (font_spec, FONT_EXTRA_INDEX),
"synthItal"), list);
}
/* Return something if was a match and nothing found. */
if (isMatch)
return ns_fallback_entity ();
if (NSFONT_TRACE)
fprintf (stderr, " Returning %ld entities.\n",
(long) XINT (Flength (list)));
return list;
}
/* ==========================================================================
Font driver implementation
========================================================================== */
static Lisp_Object nsfont_get_cache (FRAME_PTR frame);
static Lisp_Object nsfont_list (Lisp_Object frame, Lisp_Object font_spec);
static Lisp_Object nsfont_match (Lisp_Object frame, Lisp_Object font_spec);
static Lisp_Object nsfont_list_family (Lisp_Object frame);
static Lisp_Object nsfont_open (FRAME_PTR f, Lisp_Object font_entity,
int pixel_size);
static void nsfont_close (FRAME_PTR f, struct font *font);
static int nsfont_has_char (Lisp_Object entity, int c);
static unsigned int nsfont_encode_char (struct font *font, int c);
static int nsfont_text_extents (struct font *font, unsigned int *code,
int nglyphs, struct font_metrics *metrics);
static int nsfont_draw (struct glyph_string *s, int from, int to, int x, int y,
int with_background);
struct font_driver nsfont_driver =
{
0, /* Qns */
1, /* case sensitive */
nsfont_get_cache,
nsfont_list,
nsfont_match,
nsfont_list_family,
NULL, /*free_entity */
nsfont_open,
nsfont_close,
NULL, /* prepare_face */
NULL, /* done_face */
nsfont_has_char,
nsfont_encode_char,
nsfont_text_extents,
nsfont_draw,
/* excluded: get_bitmap, free_bitmap, get_outline, free_outline,
anchor_point, otf_capability, otf_driver,
start_for_frame, end_for_frame, shape */
};
/* Return a cache of font-entities on FRAME. The cache must be a
cons whose cdr part is the actual cache area. */
static Lisp_Object
nsfont_get_cache (FRAME_PTR frame)
{
Display_Info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
return (dpyinfo->name_list_element);
}
/* List fonts exactly matching with FONT_SPEC on FRAME. The value is a
**list** of font-entities. This and match () are sole APIs that allocate
font-entities. Properties to be considered (2009/05/19) are:
regular: foundry, family, adstyle, registry
extended: script, lang, otf
"Extended" properties are not part of the vector but get stored as
lisp properties under FONT_EXTRA_INDEX.
The returned entities should have type set (to 'ns), plus the following:
foundry, family, adstyle, registry,
weight, slant, width, size (0 if scalable),
dpi, spacing, avgwidth (0 if scalable) */
static Lisp_Object
nsfont_list (Lisp_Object frame, Lisp_Object font_spec)
{
return ns_findfonts (font_spec, NO);
}
/* Return a font entity most closely maching with FONT_SPEC on
FRAME. The closeness is determined by the font backend, thus
`face-font-selection-order' is ignored here.
Properties to be considered are same as for list(). */
static Lisp_Object
nsfont_match (Lisp_Object frame, Lisp_Object font_spec)
{
return ns_findfonts(font_spec, YES);
}
/* List available families. The value is a list of family names
(symbols). */
static Lisp_Object
nsfont_list_family (Lisp_Object frame)
{
Lisp_Object list = Qnil;
NSEnumerator *families =
[[[NSFontManager sharedFontManager] availableFontFamilies]
objectEnumerator];
NSString *family;
while (family = [families nextObject])
list = Fcons (intern ([family UTF8String]), list);
/* FIXME: escape the name? */
if (NSFONT_TRACE)
fprintf (stderr, "nsfont: list families returning %ld entries\n",
(long) XINT (Flength (list)));
return list;
}
/* Open a font specified by FONT_ENTITY on frame F. If the font is
scalable, open it with PIXEL_SIZE. */
static Lisp_Object
nsfont_open (FRAME_PTR f, Lisp_Object font_entity, int pixel_size)
{
BOOL synthItal;
unsigned int traits = 0;
struct nsfont_info *font_info;
struct font *font;
NSFontDescriptor *fontDesc = ns_spec_to_descriptor (font_entity);
NSFontManager *fontMgr = [NSFontManager sharedFontManager];
NSString *family;
NSFont *nsfont, *sfont;
Lisp_Object tem;
NSRect brect;
Lisp_Object font_object;
int i;
int fixLeopardBug;
static NSMutableDictionary *fontCache = nil;
NSNumber *cached;
/* 2008/03/08: The same font may end up being requested for different
entities, due to small differences in numeric values or other issues,
or for different copies of the same entity. Therefore we cache to
avoid creating multiple struct font objects (with metrics cache, etc.)
for the same NSFont object. */
if (fontCache == nil)
fontCache = [[NSMutableDictionary alloc] init];
if (NSFONT_TRACE)
{
fprintf (stderr, "nsfont: open size %d of fontentity:\n ", pixel_size);
debug_print (font_entity);
}
if (pixel_size <= 0)
{
/* try to get it out of frame params */
Lisp_Object tem = get_frame_param (f, Qfontsize);
pixel_size = NILP (tem) ? 0 : XFASTINT (tem);
}
tem = AREF (font_entity, FONT_ADSTYLE_INDEX);
synthItal = !NILP (tem) && !strncmp ("synthItal", SDATA (SYMBOL_NAME (tem)),
9);
family = ns_get_family (font_entity);
if (family == nil)
family = [[NSFont userFixedPitchFontOfSize: 0] familyName];
/* Should be > 0.23 as some font descriptors (e.g. Terminus) set to that
when setting family in ns_spec_to_descriptor(). */
if (ns_attribute_fvalue (fontDesc, NSFontWeightTrait) > 0.50)
traits |= NSBoldFontMask;
if (fabs (ns_attribute_fvalue (fontDesc, NSFontSlantTrait) > 0.05))
traits |= NSItalicFontMask;
/* see http://cocoadev.com/forums/comments.php?DiscussionID=74 */
fixLeopardBug = traits & NSBoldFontMask ? 10 : 5;
nsfont = [fontMgr fontWithFamily: family
traits: traits weight: fixLeopardBug
size: pixel_size];
/* if didn't find, try synthetic italic */
if (nsfont == nil && synthItal)
{
nsfont = [fontMgr fontWithFamily: family
traits: traits & ~NSItalicFontMask
weight: fixLeopardBug size: pixel_size];
}
#ifdef NS_IMPL_COCOA
/* LastResort not really a family */
if (nsfont == nil && [@"LastResort" isEqualToString: family])
nsfont = [NSFont fontWithName: @"LastResort" size: pixel_size];
#endif
if (nsfont == nil)
{
message_with_string ("*** Warning: font in family '%s' not found",
build_string ([family UTF8String]), 1);
nsfont = [NSFont userFixedPitchFontOfSize: pixel_size];
}
if (NSFONT_TRACE)
NSLog (@"%@\n", nsfont);
/* Check the cache */
cached = [fontCache objectForKey: nsfont];
if (cached != nil && !synthItal)
{
if (NSFONT_TRACE)
fprintf(stderr, "*** nsfont_open CACHE HIT!\n");
/* FIXME: Cast from (unsigned long) to Lisp_Object. */
XHASH (font_object) = [cached unsignedLongValue];
return font_object;
}
else
{
font_object = font_make_object (VECSIZE (struct nsfont_info),
font_entity, pixel_size);
if (!synthItal)
[fontCache setObject: [NSNumber numberWithUnsignedLong:
(unsigned long) XHASH (font_object)]
forKey: nsfont];
}
font_info = (struct nsfont_info *) XFONT_OBJECT (font_object);
font = (struct font *) font_info;
if (!font)
return Qnil; /* FIXME: other terms do, but return Qnil causes segfault */
font_info->glyphs = (unsigned short **)
xmalloc (0x100 * sizeof (unsigned short *));
font_info->metrics = (struct font_metrics **)
xmalloc (0x100 * sizeof (struct font_metrics *));
if (!font_info->glyphs || !font_info->metrics)
return Qnil;
bzero (font_info->glyphs, 0x100 * sizeof (unsigned short *));
bzero (font_info->metrics, 0x100 * sizeof (struct font_metrics *));
BLOCK_INPUT;
/* for metrics */
sfont = [nsfont screenFont];
if (sfont == nil)
sfont = nsfont;
/* non-metric backend font struct fields */
font = (struct font *) font_info;
font->pixel_size = [sfont pointSize];
font->driver = &nsfont_driver;
font->encoding_type = FONT_ENCODING_NOT_DECIDED;
font->encoding_charset = -1;
font->repertory_charset = -1;
font->default_ascent = 0;
font->vertical_centering = 0;
font->baseline_offset = 0;
font->relative_compose = 0;
font->font_encoder = NULL;
font->props[FONT_FORMAT_INDEX] = Qns;
font->props[FONT_FILE_INDEX] = Qnil;
{
double expand, hshrink;
float full_height, min_height, hd;
const char *fontName = [[nsfont fontName] UTF8String];
int len = strlen (fontName);
#ifdef NS_IMPL_GNUSTEP
font_info->nsfont = sfont;
#else
font_info->nsfont = nsfont;
#endif
[font_info->nsfont retain];
/* set up ns_font (defined in nsgui.h) */
font_info->name = (char *)xmalloc (strlen (fontName) + 1);
bcopy (fontName, font_info->name, strlen (fontName) + 1);
font_info->bold = [fontMgr traitsOfFont: nsfont] & NSBoldFontMask;
font_info->ital =
synthItal || ([fontMgr traitsOfFont: nsfont] & NSItalicFontMask);
/* Metrics etc.; some fonts return an unusually large max advance, so we
only use it for fonts that have wide characters. */
font_info->width = ([sfont numberOfGlyphs] > 3000) ?
[sfont maximumAdvancement].width : ns_char_width (sfont, '0');
if (font_info->width == 0)
font_info->width = ns_char_width (sfont, 'e');
if (font_info->width == 0)
font_info->width = ns_char_width (sfont, '_');
if (font_info->width == 0)
font_info->width = ns_char_width (sfont, 'J');
if (font_info->width == 0)
font_info->width = [sfont maximumAdvancement].width;
brect = [sfont boundingRectForFont];
full_height = brect.size.height;
min_height = [sfont ascender] - [sfont descender] - [sfont leading];
hd = full_height - min_height;
/* standard height, similar to Carbon. Emacs.app: was 0.5 by default. */
expand = [sfont isFixedPitch] ? 0.2 : 0;
hshrink = 1;
float expand2 = 0;
/* if ascender/descender do not provide enough natural spacing, add some:
this idea did not work well, so expand2 = 0 for now.*/
float spc_ratio = expand2 * max (0, ((float) full_height) / hd - 2.8);
font_info->underpos = 2; /*[sfont underlinePosition] is often clipped out */
font_info->underwidth = [sfont underlineThickness];
font_info->size = font->pixel_size;
font_info->voffset = lrint (hshrink * [sfont ascender] + expand * hd / 2
+ spc_ratio/2);
/* printf("leading+%f fh/hd=%f asc=%f desc=%f spc-r=spc_ratio=%f\n",
[sfont leading], full_height / hd, [sfont ascender],
[sfont descender], spc_ratio);
*/
/* max bounds */
font_info->max_bounds.ascent =
lrint (hshrink * [sfont ascender] + expand * hd/2);
/* [sfont descender] is usually negative. Use floor to avoid
clipping descenders. */
font_info->max_bounds.descent =
-lrint (floor(hshrink* [sfont descender] - expand*hd/2));
font_info->height =
font_info->max_bounds.ascent + font_info->max_bounds.descent;
font_info->max_bounds.width = lrint (font_info->width);
font_info->max_bounds.lbearing = lrint (brect.origin.x);
font_info->max_bounds.rbearing =
lrint (brect.size.width - font_info->width);
#ifdef NS_IMPL_COCOA
/* set up synthItal and the CG font */
font_info->synthItal = synthItal;
{
ATSFontRef atsFont = ATSFontFindFromPostScriptName
((CFStringRef)[nsfont fontName], kATSOptionFlagsDefault);
if (atsFont == kATSFontRefUnspecified)
{
/* see if we can get it by dropping italic (then synthesizing) */
atsFont = ATSFontFindFromPostScriptName ((CFStringRef)
[[fontMgr convertFont: nsfont toNotHaveTrait: NSItalicFontMask]
fontName], kATSOptionFlagsDefault);
if (atsFont != kATSFontRefUnspecified)
font_info->synthItal = YES;
else
{
/* last resort fallback */
atsFont = ATSFontFindFromPostScriptName
((CFStringRef)@"Monaco", kATSOptionFlagsDefault);
}
}
font_info->cgfont = CGFontCreateWithPlatformFont ((void*)&atsFont);
}
#endif
/* set up metrics portion of font struct */
font->ascent = lrint([sfont ascender]);
font->descent = -lrint(floor([sfont descender]));
font->min_width = ns_char_width(sfont, '|');
font->space_width = lrint (ns_char_width (sfont, ' '));
font->average_width = lrint (font_info->width);
font->max_width = lrint (font_info->max_bounds.width);
font->height = lrint (font_info->height);
font->underline_position = lrint (font_info->underpos);
font->underline_thickness = lrint (font_info->underwidth);
font->props[FONT_NAME_INDEX] = Ffont_xlfd_name (font_object, Qnil);
font->props[FONT_FULLNAME_INDEX] =
make_unibyte_string (font_info->name, strlen (font_info->name));
}
UNBLOCK_INPUT;
return font_object;
}
/* Close FONT on frame F. */
static void
nsfont_close (FRAME_PTR f, struct font *font)
{
struct nsfont_info *font_info = (struct nsfont_info *)font;
int i;
/* FIXME: this occurs apparently due to same failure to detect same font
that causes need for cache in nsfont_open () */
if (!font_info)
return;
for (i =0; i<0x100; i++)
{
xfree (font_info->glyphs[i]);
xfree (font_info->metrics[i]);
}
[font_info->nsfont release];
#ifdef NS_IMPL_COCOA
CGFontRelease (font_info->cgfont);
#endif
xfree (font_info->name);
xfree (font_info);
}
/* If FONT_ENTITY has a glyph for character C (Unicode code point),
return 1. If not, return 0. If a font must be opened to check
it, return -1. */
static int
nsfont_has_char (Lisp_Object entity, int c)
{
return -1;
}
/* Return a glyph code of FONT for character C (Unicode code point).
If FONT doesn't have such a glyph, return FONT_INVALID_CODE. */
static unsigned int
nsfont_encode_char (struct font *font, int c)
{
struct nsfont_info *font_info = (struct nsfont_info *)font;
unsigned char high = (c & 0xff00) >> 8, low = c & 0x00ff;
unsigned short g;
if (c > 0xFFFF)
return FONT_INVALID_CODE;
/* did we already cache this block? */
if (!font_info->glyphs[high])
ns_uni_to_glyphs (font_info, high);
g = font_info->glyphs[high][low];
return g == 0xFFFF ? FONT_INVALID_CODE : g;
}
/* Perform the size computation of glyphs of FONT and fill in members
of METRICS. The glyphs are specified by their glyph codes in
CODE (length NGLYPHS). */
static int
nsfont_text_extents (struct font *font, unsigned int *code, int nglyphs,
struct font_metrics *metrics)
{
struct nsfont_info *font_info = (struct nsfont_info *)font;
struct font_metrics *pcm;
unsigned char high, low;
int totalWidth = 0;
int i;
bzero (metrics, sizeof (struct font_metrics));
for (i =0; i<nglyphs; i++)
{
/* get metrics for this glyph, filling cache if need be */
/* TODO: get metrics for whole string from an NSLayoutManager
(if not too slow) */
high = (code[i] & 0xFF00) >> 8;
low = code[i] & 0x00FF;
if (!font_info->metrics[high])
ns_glyph_metrics (font_info, high);
pcm = &(font_info->metrics[high][low]);