nsfont.m 46 KB
Newer Older
1 2
/* Font back-end driver for the NeXT/Open/GNUstep and MacOSX window system.
   See font.h
3
   Copyright (C) 2006-2014 Free Software Foundation, Inc.
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
11 12 13 14 15 16 17

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
19 20 21 22

Author: Adrian Robert (arobert@cogsci.ucsd.edu)
*/

23 24
/* This should be the first include, as it may set up #defines affecting
   interpretation of even the system includes. */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
25
#include <config.h>
26 27 28 29 30 31 32 33 34 35 36 37

#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 "character.h"
#include "font.h"
38
#include "termchar.h"
39

40
/* TODO: Drop once we can assume gnustep-gui 0.17.1. */
41 42 43 44
#ifdef NS_IMPL_GNUSTEP
#import <AppKit/NSFontDescriptor.h>
#endif

45
#define NSFONT_TRACE 0
46
#define LCD_SMOOTHING_MARGIN 2
47 48

extern Lisp_Object Qns;
49
extern Lisp_Object Qnormal, Qbold, Qitalic;
50
static Lisp_Object Qapple, Qroman, Qmedium;
51
static Lisp_Object Qcondensed, Qexpanded;
52 53 54
extern Lisp_Object Qappend;
extern float ns_antialias_threshold;

55

56 57 58 59 60 61
/* 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);

62
#define INVALID_GLYPH 0xFFFF
63 64 65 66 67 68 69 70 71 72 73

/* ==========================================================================

    Utilities

   ========================================================================== */


/* Replace spaces w/another character so emacs core font parsing routines
   aren't thrown off. */
static void
74
ns_escape_name (char *name)
75
{
76 77 78
  for (; *name; name++)
    if (*name == ' ')
      *name = '_';
79 80 81 82 83
}


/* Reconstruct spaces in a font family name passed through emacs. */
static void
84
ns_unescape_name (char *name)
85
{
86 87 88
  for (; *name; name++)
    if (*name == '_')
      *name = ' ';
89 90 91 92 93
}


/* Extract family name from a font spec. */
static NSString *
94
ns_get_family (Lisp_Object font_spec)
95 96 97 98 99 100
{
  Lisp_Object tem = AREF (font_spec, FONT_FAMILY_INDEX);
  if (NILP (tem))
      return nil;
  else
    {
101
      char *tmp = xstrdup (SSDATA (SYMBOL_NAME (tem)));
102
      NSString *family;
103
      ns_unescape_name (tmp);
104
      family = [NSString stringWithUTF8String: tmp];
105
      xfree (tmp);
106 107 108 109 110
      return family;
    }
}


111 112 113 114
/* 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. */
115 116 117
static float
ns_attribute_fvalue (NSFontDescriptor *fdesc, NSString *trait)
{
118 119
    NSDictionary *tdict = [fdesc objectForKey: NSFontTraitsAttribute];
    NSNumber *val = [tdict objectForKey: trait];
120
    return val == nil ? 0.0F : [val floatValue];
121
}
122 123


124 125 126
/* 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
127 128
static NSFontDescriptor *
ns_spec_to_descriptor (Lisp_Object font_spec)
129 130 131 132 133 134 135 136 137 138
{
    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)
139
	[tdict setObject: [NSNumber numberWithFloat: (n - 100.0F) / 100.0F]
140 141 142
		  forKey: NSFontWeightTrait];
    n = min (FONT_SLANT_NUMERIC (font_spec), 200);
    if (n != -1 && n != STYLE_REF)
143
	[tdict setObject: [NSNumber numberWithFloat: (n - 100.0F) / 100.0F]
144 145 146
		  forKey: NSFontSlantTrait];
    n = min (FONT_WIDTH_NUMERIC (font_spec), 200);
    if (n > -1 && (n > STYLE_REF + 10 || n < STYLE_REF - 10))
147
	[tdict setObject: [NSNumber numberWithFloat: (n - 100.0F) / 100.0F]
148 149 150 151
		  forKey: NSFontWidthTrait];
    if ([tdict count] > 0)
	[fdAttrs setObject: tdict forKey: NSFontTraitsAttribute];

152 153 154
    fdesc = [[[NSFontDescriptor fontDescriptorWithFontAttributes: fdAttrs]
               retain] autorelease];

155
    if (family != nil)
156
      {
157 158
        NSFontDescriptor *fdesc2 = [fdesc fontDescriptorWithFamily: family];
        fdesc = [[fdesc2 retain] autorelease];
159 160 161 162
      }

    [fdAttrs release];
    [tdict release];
163
    return fdesc;
164 165 166
}


167
/* Converts NSFont descriptor to FONT_WEIGHT, FONT_SLANT, FONT_WIDTH, etc.. */
168
static Lisp_Object
Jan D's avatar
Jan D committed
169 170 171
ns_descriptor_to_entity (NSFontDescriptor *desc,
                         Lisp_Object extra,
                         const char *style)
172
{
173 174 175 176
    Lisp_Object font_entity = font_make_entity ();
    /*   NSString *psName = [desc postscriptName]; */
    NSString *family = [desc objectForKey: NSFontFamilyAttribute];
    unsigned int traits = [desc symbolicTraits];
177
    char *escapedFamily;
178

179 180 181 182 183 184
    /* 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];

185
    escapedFamily = xstrdup ([family UTF8String]);
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
    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)));*/
204 205 206
    FONT_SET_STYLE (font_entity, FONT_WIDTH_INDEX,
                    traits & NSFontCondensedTrait ? Qcondensed :
                    traits & NSFontExpandedTrait ? Qexpanded : Qnormal);
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
/*    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);
      }
225

226
    xfree (escapedFamily);
227 228
    return font_entity;
}
229

230 231 232

/* Default font entity. */
static Lisp_Object
233
ns_fallback_entity (void)
234 235 236
{
  return ns_descriptor_to_entity ([[NSFont userFixedPitchFontOfSize: 0]
      fontDescriptor], Qnil, NULL);
237 238 239
}


240
/* Utility: get width of a char c in screen font SFONT */
241
static CGFloat
242
ns_char_width (NSFont *sfont, int c)
243
{
244
  CGFloat w = -1.0;
245 246
  NSString *cstr = [NSString stringWithFormat: @"%c", c];

247
#ifdef NS_IMPL_COCOA
248 249 250
  NSGlyph glyph = [sfont glyphWithName: cstr];
  if (glyph)
    w = [sfont advancementForGlyph: glyph].width;
251
#endif
252 253

  if (w < 0.0)
254 255 256 257 258
    {
      NSDictionary *attrsDictionary =
        [NSDictionary dictionaryWithObject: sfont forKey: NSFontAttributeName];
      w = [cstr sizeWithAttributes: attrsDictionary].width;
    }
259 260 261 262 263 264 265 266 267 268 269

  return max (w, 1.0);
}

/* Return average width over ASCII printable characters for SFONT.  */

static NSString *ascii_printable;

static int
ns_ascii_average_width (NSFont *sfont)
{
270
  CGFloat w = -1.0;
271 272 273

  if (!ascii_printable)
    {
274
      char chars[96];
275 276 277
      int ch;
      for (ch = 0; ch < 95; ch++)
	chars[ch] = ' ' + ch;
278
      chars[95] = '\0';
279

280
      ascii_printable = [[NSString alloc] initWithFormat: @"%s", chars];
281 282 283 284 285 286 287 288
    }

#ifdef NS_IMPL_COCOA
  NSGlyph glyph = [sfont glyphWithName: ascii_printable];
  if (glyph)
    w = [sfont advancementForGlyph: glyph].width;
#endif

289
  if (w < (CGFloat) 0.0)
290 291 292 293 294 295
    {
      NSDictionary *attrsDictionary =
	[NSDictionary dictionaryWithObject: sfont forKey: NSFontAttributeName];
      w = [ascii_printable sizeWithAttributes: attrsDictionary].width;
    }

296
  return lrint (w / (CGFloat) 95.0);
297 298 299 300
}


/* Return whether set1 covers set2 to a reasonable extent given by pct.
Juanma Barranquero's avatar
Juanma Barranquero committed
301
   We check, out of each 16 Unicode char range containing chars in set2,
302 303 304 305 306 307 308 309 310
   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;

311 312 313 314 315
    /* Work around what appears to be a GNUstep bug.
       See <http://bugs.gnu.org/11853>.  */
    if (! (bytes1 && bytes2))
      return NO;

316 317 318 319 320 321 322 323
    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);
324
    return (float)off / tot < 1.0F - pct;
325 326 327 328 329 330 331 332
}


/* 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)
{
333
    if (!strcmp (SSDATA (SYMBOL_NAME (lang)), "ja"))
334 335 336
	return @"han";
    /* NOTE: ja given for any hanzi that's also a kanji, but Chinese fonts
             have more characters. */
337
    else if (!strcmp (SSDATA (SYMBOL_NAME (lang)), "zh"))
338
	return @"han";
339
    else if (!strcmp (SSDATA (SYMBOL_NAME (lang)), "ko"))
340 341 342 343 344 345 346
	return @"hangul";
    else
	return @"";
}


/* Convert OTF 4-letter script code to emacs script name.  (Why can't
Juanma Barranquero's avatar
Juanma Barranquero committed
347
   everyone just use some standard Unicode names for these?) */
348 349 350 351 352
static NSString
*ns_otf_to_script (Lisp_Object otf)
{
    Lisp_Object script = assq_no_quit (XCAR (otf), Votf_script_alist);
    return CONSP (script)
353
	? [NSString stringWithUTF8String: SSDATA (SYMBOL_NAME (XCDR ((script))))]
354 355 356 357
	: @"";
}


358 359 360 361 362
/* Convert a font registry, such as  */
static NSString
*ns_registry_to_script (char *reg)
{
    Lisp_Object script, r, rts = Vns_reg_to_script;
363
    while (CONSP (rts))
364 365
      {
        r = XCAR (XCAR (rts));
366
        if (!strncmp (SSDATA (r), reg, SBYTES (r)))
367 368
          {
            script = XCDR (XCAR (rts));
369
            return [NSString stringWithUTF8String: SSDATA (SYMBOL_NAME (script))];
370 371 372 373 374 375 376 377 378
          }
        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
Juanma Barranquero's avatar
Juanma Barranquero committed
379
   Unicode script.  Empty string returned if no script spec found. */
380 381 382
static NSString
*ns_get_req_script (Lisp_Object font_spec)
{
383
    Lisp_Object reg = AREF (font_spec, FONT_REGISTRY_INDEX);
384 385
    Lisp_Object extra = AREF (font_spec, FONT_EXTRA_INDEX);

386
    /* The extra-bundle properties have priority. */
387 388 389 390 391 392 393 394
    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:
395
		            SSDATA (SYMBOL_NAME (val))];
396 397 398 399 400 401
	    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);
	  }
      }
402 403 404 405 406 407 408 409 410 411 412

    /* 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
413
        return ns_registry_to_script (SSDATA (SYMBOL_NAME (reg)));
414 415
      }

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    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)));
      }
}


Juanma Barranquero's avatar
Juanma Barranquero committed
435
/* Use the Unicode range information in Vchar_script_table to convert a script
436 437 438 439 440 441 442 443 444 445 446 447
   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;

448
	ranges = list1 (script);
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
	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;
467 468 469
}


470 471 472 473 474 475
/* 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
Juanma Barranquero's avatar
Juanma Barranquero committed
476
   (b) need approximate match as fonts covering full Unicode ranges are rare. */
477 478 479 480 481 482 483 484 485 486
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)
487
        scriptToFamilies = [[NSMutableDictionary alloc] init];
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

    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];
504
		while ((family = [allFamiliesEnum nextObject]))
505 506 507 508 509 510 511 512 513 514
		  {
		    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];
		  }
515 516
                pct -= 0.2F;
		if ([families count] > 0 || pct < 0.05F)
517 518
		    break;
	      }
519
            [charset release];
520 521 522 523 524 525 526 527 528
	  }
#ifdef NS_IMPL_COCOA
	if ([families count] == 0)
	    [families addObject: @"LastResort"];
#endif
	[scriptToFamilies setObject: families forKey: script];
      }

    if (NSFONT_TRACE)
529
      NSLog(@"    returning %lu families", (unsigned long)[families count]);
530 531 532 533 534 535 536
    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. */
537
static Lisp_Object
538
ns_findfonts (Lisp_Object font_spec, BOOL isMatch)
539
{
540 541 542 543 544 545 546 547 548
    Lisp_Object tem, list = Qnil;
    NSFontDescriptor *fdesc, *desc;
    NSMutableSet *fkeys;
    NSArray *matchingDescs;
    NSEnumerator *dEnum;
    NSString *family;
    NSSet *cFamilies;
    BOOL foundItal = NO;

549
    block_input ();
550 551 552 553 554 555 556 557 558 559 560 561 562 563
    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];

564
    matchingDescs = [fdesc matchingFontDescriptorsWithMandatoryKeys: fkeys];
565

566
    if (NSFONT_TRACE)
567 568
	NSLog(@"Got desc %@ and found %lu matching fonts from it: ", fdesc,
	      (unsigned long)[matchingDescs count]);
569

570
    for (dEnum = [matchingDescs objectEnumerator]; (desc = [dEnum nextObject]);)
571 572 573 574
      {
	if (![cFamilies containsObject:
	         [desc objectForKey: NSFontFamilyAttribute]])
	    continue;
575
        tem = ns_descriptor_to_entity (desc,
576
					 AREF (font_spec, FONT_EXTRA_INDEX),
577 578 579 580
                                       NULL);
        if (isMatch)
          return tem;
	list = Fcons (tem, list);
581
	if (fabs (ns_attribute_fvalue (desc, NSFontSlantTrait)) > 0.05)
582 583 584 585 586
	    foundItal = YES;
      }

    /* Add synthItal member if needed. */
    family = [fdesc objectForKey: NSFontFamilyAttribute];
587
    if (family != nil && !foundItal && XINT (Flength (list)) > 0)
588
      {
589 590 591 592
        NSFontDescriptor *s1 = [NSFontDescriptor new];
        NSFontDescriptor *sDesc
          = [[s1 fontDescriptorWithSymbolicTraits: NSFontItalicTrait]
              fontDescriptorWithFamily: family];
593 594 595
	list = Fcons (ns_descriptor_to_entity (sDesc,
					 AREF (font_spec, FONT_EXTRA_INDEX),
					 "synthItal"), list);
596
        [s1 release];
597 598
      }

599 600
    unblock_input ();

601
    /* Return something if was a match and nothing found. */
602 603
    if (isMatch)
      return ns_fallback_entity ();
604

605
    if (NSFONT_TRACE)
606 607
	fprintf (stderr, "    Returning %"pI"d entities.\n",
                 XINT (Flength (list)));
608 609

    return list;
610 611 612
}


613

614 615 616 617 618 619
/* ==========================================================================

    Font driver implementation

   ========================================================================== */

620

Dmitry Antipov's avatar
Dmitry Antipov committed
621
static Lisp_Object nsfont_get_cache (struct frame *frame);
622 623 624
static Lisp_Object nsfont_list (struct frame *, Lisp_Object);
static Lisp_Object nsfont_match (struct frame *, Lisp_Object);
static Lisp_Object nsfont_list_family (struct frame *);
Dmitry Antipov's avatar
Dmitry Antipov committed
625
static Lisp_Object nsfont_open (struct frame *f, Lisp_Object font_entity,
626
                                 int pixel_size);
627
static void nsfont_close (struct font *font);
628 629
static int nsfont_has_char (Lisp_Object entity, int c);
static unsigned int nsfont_encode_char (struct font *font, int c);
630 631
static void nsfont_text_extents (struct font *font, unsigned int *code,
				 int nglyphs, struct font_metrics *metrics);
632
static int nsfont_draw (struct glyph_string *s, int from, int to, int x, int y,
633
                        bool with_background);
634 635 636

struct font_driver nsfont_driver =
  {
637
    0,				/* Qns */
638 639 640 641 642 643 644 645 646 647 648 649 650 651
    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,
652
    /* excluded: get_bitmap, free_bitmap,
653 654 655 656 657 658 659 660
                 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
Dmitry Antipov's avatar
Dmitry Antipov committed
661
nsfont_get_cache (struct frame *frame)
662
{
663
  Display_Info *dpyinfo = FRAME_DISPLAY_INFO (frame);
664 665 666 667
  return (dpyinfo->name_list_element);
}


668 669 670 671 672 673 674 675 676 677 678 679
/* 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)  */
680
static Lisp_Object
681
nsfont_list (struct frame *f, Lisp_Object font_spec)
682
{
683
  return ns_findfonts (font_spec, NO);
684 685 686
}


Paul Eggert's avatar
Paul Eggert committed
687
/* Return a font entity most closely matching with FONT_SPEC on
688
   FRAME.  The closeness is determined by the font backend, thus
689 690
   `face-font-selection-order' is ignored here.
   Properties to be considered are same as for list(). */
691
static Lisp_Object
692
nsfont_match (struct frame *f, Lisp_Object font_spec)
693
{
694
  return ns_findfonts (font_spec, YES);
695 696 697 698 699 700
}


/* List available families.  The value is a list of family names
   (symbols). */
static Lisp_Object
701
nsfont_list_family (struct frame *f)
702 703
{
  Lisp_Object list = Qnil;
704
  NSEnumerator *families;
705
  NSString *family;
706 707 708 709

  block_input ();
  families = [[[NSFontManager sharedFontManager] availableFontFamilies]
               objectEnumerator];
710
  while ((family = [families nextObject]))
711
      list = Fcons (intern ([family UTF8String]), list);
712
  /* FIXME: escape the name? */
713 714

  if (NSFONT_TRACE)
715 716
    fprintf (stderr, "nsfont: list families returning %"pI"d entries\n",
	     XINT (Flength (list)));
717

718
  unblock_input ();
719 720 721 722 723 724 725
  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
Dmitry Antipov's avatar
Dmitry Antipov committed
726
nsfont_open (struct frame *f, Lisp_Object font_entity, int pixel_size)
727 728
{
  BOOL synthItal;
729
  unsigned int traits = 0;
730 731
  struct nsfont_info *font_info;
  struct font *font;
732
  NSFontDescriptor *fontDesc = ns_spec_to_descriptor (font_entity);
733 734 735 736 737 738 739 740
  NSFontManager *fontMgr = [NSFontManager sharedFontManager];
  NSString *family;
  NSFont *nsfont, *sfont;
  Lisp_Object tem;
  NSRect brect;
  Lisp_Object font_object;
  int fixLeopardBug;

741 742
  block_input ();

743 744 745 746 747 748 749 750 751 752 753 754 755 756
  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);
757
  synthItal = !NILP (tem) && !strncmp ("synthItal", SSDATA (SYMBOL_NAME (tem)),
758
                                       9);
759
  family = ns_get_family (font_entity);
760 761
  if (family == nil)
    family = [[NSFont userFixedPitchFontOfSize: 0] familyName];
762 763
  /* Should be > 0.23 as some font descriptors (e.g. Terminus) set to that
     when setting family in ns_spec_to_descriptor(). */
764
  if (ns_attribute_fvalue (fontDesc, NSFontWeightTrait) > 0.50F)
765
      traits |= NSBoldFontMask;
766
  if (fabs (ns_attribute_fvalue (fontDesc, NSFontSlantTrait) > 0.05F))
767
      traits |= NSItalicFontMask;
768

769
  /* see http://cocoadev.com/forums/comments.php?DiscussionID=74 */
770 771 772 773 774
  fixLeopardBug = traits & NSBoldFontMask ? 10 : 5;
  nsfont = [fontMgr fontWithFamily: family
                            traits: traits weight: fixLeopardBug
			      size: pixel_size];
  /* if didn't find, try synthetic italic */
775
  if (nsfont == nil && synthItal)
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
    {
      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];
    }

794 795
  if (NSFONT_TRACE)
    NSLog (@"%@\n", nsfont);
796

797 798
  font_object = font_make_object (VECSIZE (struct nsfont_info),
                                  font_entity, pixel_size);
799
  ASET (font_object, FONT_TYPE_INDEX, nsfont_driver.type);
800
  font_info = (struct nsfont_info *) XFONT_OBJECT (font_object);
801
  font = (struct font *) font_info;
802
  if (!font)
803 804 805 806
    {
      unblock_input ();
      return Qnil; /* FIXME: other terms do, but return Qnil causes segfault */
    }
807

808 809
  font_info->glyphs = xzalloc (0x100 * sizeof *font_info->glyphs);
  font_info->metrics = xzalloc (0x100 * sizeof *font_info->metrics);
810 811

  /* for metrics */
812 813 814 815
#ifdef NS_IMPL_COCOA
  sfont = [nsfont screenFontWithRenderingMode:
                    NSFontAntialiasedIntegerAdvancementsRenderingMode];
#else
816
  sfont = [nsfont screenFont];
817 818
#endif

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
  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_charset = -1;
  font->repertory_charset = -1;
  font->default_ascent = 0;
  font->vertical_centering = 0;
  font->baseline_offset = 0;
  font->relative_compose = 0;

  {
    const char *fontName = [[nsfont fontName] UTF8String];

836 837 838 839 840 841 842 843
    /* The values specified by fonts are not always exact. For
     * example, a 6x8 font could specify that the descender is
     * -2.00000405... (represented by 0xc000000220000000).  Without
     * adjustment, the code below would round the descender to -3,
     * resulting in a font that would be one pixel higher than
     * intended. */
    CGFloat adjusted_descender = [sfont descender] + 0.0001;

844 845 846 847 848 849 850 851
#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) */
852
    font_info->name = xstrdup (fontName);
853 854 855 856 857 858 859
    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] > 2000) ?
860
      [sfont maximumAdvancement].width : ns_char_width (sfont, '0');
861 862 863

    brect =  [sfont boundingRectForFont];

864
    font_info->underpos = [sfont underlinePosition];
865 866 867 868
    font_info->underwidth = [sfont underlineThickness];
    font_info->size = font->pixel_size;

    /* max bounds */
869
    font->ascent = font_info->max_bounds.ascent = lrint ([sfont ascender]);
870
    /* Descender is usually negative.  Use floor to avoid
871
       clipping descenders. */
872 873
    font->descent =
      font_info->max_bounds.descent = -lrint (floor(adjusted_descender));
874 875 876 877 878
    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 =
879
      lrint (brect.size.width - (CGFloat) font_info->width);
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

#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 */
908
    font->ascent = lrint([sfont ascender]);
909
    font->descent = -lrint(floor(adjusted_descender));
910
    font->space_width = lrint (ns_char_width (sfont, ' '));
911
    font->max_width = lrint (font_info->max_bounds.width);
912 913 914
    font->min_width = font->space_width;  /* Approximate.  */
    font->average_width = ns_ascii_average_width (sfont);

915 916 917 918 919
    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);
920
    font->props[FONT_FULLNAME_INDEX] = build_unibyte_string (font_info->name);
921
  }
922
  unblock_input ();
923 924 925 926 927

  return font_object;
}


928
/* Close FONT. */
929
static void
930
nsfont_close (struct font *font)
931
{
932
  struct nsfont_info *font_info = (struct nsfont_info *) font;
933

934 935 936
  /* FIXME: font_info may be NULL due to same failure to detect
     same font that causes need for cache in nsfont_open.  */
  if (font_info && font_info->name)
937
    {
938 939 940 941 942 943 944
      int i;

      for (i = 0; i < 0x100; i++)
	{
	  xfree (font_info->glyphs[i]);
	  xfree (font_info->metrics[i]);
	}
945 946
      xfree (font_info->glyphs);
      xfree (font_info->metrics);
947
      [font_info->nsfont release];
948
#ifdef NS_IMPL_COCOA
949
      CGFontRelease (font_info->cgfont);
950
#endif
951 952 953
      xfree (font_info->name);
      font_info->name = NULL;
    }
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
}


/* 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];
984
  return g == INVALID_GLYPH ? FONT_INVALID_CODE : g;
985 986 987 988 989 990
}


/* 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). */
991 992 993
static void
nsfont_text_extents (struct font *font, unsigned int *code,
		     int nglyphs, struct font_metrics *metrics)
994 995 996 997 998 999 1000
{
  struct nsfont_info *font_info = (struct nsfont_info *)font;
  struct font_metrics *pcm;
  unsigned char high, low;
  int totalWidth = 0;
  int i;

1001
  memset (metrics, 0, sizeof (struct font_metrics));
1002

1003
  for (i = 0; i < nglyphs; i++)
1004 1005
    {
      /* get metrics for this glyph, filling cache if need be */
1006 1007
      /* TODO: get metrics for whole string from an NSLayoutManager
               (if not too slow) */
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
      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]);

      if (metrics->lbearing > totalWidth + pcm->lbearing)
	metrics->lbearing = totalWidth + pcm->lbearing;
      if (metrics->rbearing < totalWidth + pcm->rbearing)
	metrics->rbearing = totalWidth + pcm->rbearing;
      if (metrics->ascent < pcm->ascent)
	metrics->ascent = pcm->ascent;
      if (metrics->descent < pcm->descent)
	metrics->descent = pcm->descent;

      totalWidth += pcm->width;
    }

  metrics->width = totalWidth;
}


/* Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
1031 1032 1033
   position of frame F with S->FACE and S->GC.  If WITH_BACKGROUND,
   fill the background in advance.  It is assured that WITH_BACKGROUND
   is false when (FROM > 0 || TO < S->nchars). */
1034