/
tkMacOSXFont.c
2678 lines (2379 loc) · 74.1 KB
/
tkMacOSXFont.c
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
/*
* tkMacOSXFont.c --
*
* Contains the Macintosh implementation of the platform-independant
* font package interface. This version uses ATSU instead of Quickdraw.
*
* Copyright 2002-2004 Benjamin Riefenstahl, Benjamin.Riefenstahl@epost.de
* Copyright (c) 2006-2008 Daniel A. Steffen <das@users.sourceforge.net>
*
* Some functions were originally copied verbatim from the QuickDraw version
* of tkMacOSXFont.c, which had these copyright notices:
*
* Copyright (c) 1990-1994 The Regents of the University of California.
* Copyright (c) 1994-1997 Sun Microsystems, Inc.
* Copyright 2001, Apple Computer, Inc.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
*
* Todos:
*
* - Get away from Font Manager and Quickdraw functions as much as possible,
* replace with ATS functions instead.
*
* - Use Font Manager functions to translate ids from ATS to Font Manager
* instead of just assuming that they are the same.
*
* - Get a second font register going for fonts that are not assigned to a
* font family by the OS. On my system I have 27 fonts of that type,
* Hebrew, Arabic and Hindi fonts that actually come with the system.
* FMGetFontFamilyInstanceFromFont() returns -981 (kFMInvalidFontFamilyErr)
* for these and they are not listed when enumerating families, but they
* are when enumerating fonts directly. The problem that the OS sees may
* be that at least some of them do not contain any Latin characters. Note
* that such fonts can not be used for controls, because controls
* definitely require a family id (this assertion needs testing).
*/
#include "tkMacOSXPrivate.h"
#include "tkMacOSXFont.h"
/*
#ifdef TK_MAC_DEBUG
#define TK_MAC_DEBUG_FONTS
#endif
*/
/*
* Problem: The sum of two parts is not the same as the whole. In particular
* the width of two separately measured strings will usually be larger than
* the width of them pasted together. Tk has a design bug here, because it
* generally assumes that this kind of arithmetic works.
* To workaround this, #define TK_MAC_COALESCE_LINE to 1 below, we then avoid
* lines that tremble and shiver while the cursor passes through them by
* undercutting the system and behind the scenes pasting strings together that
* look like they are on the same line and adjacent and that are drawn with
* the same font. To do this we need some global data.
*/
#define TK_MAC_COALESCE_LINE 0
/*
* The following structure represents our Macintosh-specific implementation
* of a font object.
*/
typedef struct {
TkFont font; /* Stuff used by generic font package. Must
* be first in structure. */
/*
* The ATSU view of the font and other text properties. Used for drawing
* and measuring.
*/
ATSUFontID atsuFontId; /* == FMFont. */
ATSUTextLayout atsuLayout; /* ATSU layout object, representing the whole
* text that ATSU sees with some option
* bits. */
ATSUStyle atsuStyle; /* ATSU style object, representing a run of
* text with the same properties. */
/*
* The QuickDraw view of the font. Used to configure controls.
*/
FMFontFamily qdFont; /* == FMFontFamilyId, Carbon replacement for
* QD face numbers. */
short qdSize; /* Font size in points. */
short qdStyle; /* QuickDraw style bits. */
} MacFont;
/*
* Information about font families, initialized at startup time. Font
* families are described by a mapping from UTF-8 names to MacOS font family
* IDs. The whole list is kept as the sorted array "familyList", allocated
* with ckrealloc().
*
* Note: This would have been easier, if we could just have used Tcl hash
* arrays. Unfortunately there seems to be no pre-packaged
* non-case-sensitive version of that available.
*/
typedef struct {
const char * name;
FMFontFamily familyId;
} MacFontFamily;
static MacFontFamily * familyList = NULL;
static int
familyListNextFree = 0, /* The next free slot in familyList. */
familyListMaxValid = 0, /* The top of the sorted area. */
familyListSize = 0; /* The size of the whole array. */
/*
* A simple one-shot sub-allocator for fast and efficient allocation of
* strings. Used by the familyList array for the names. These strings are
* only allocated once at startup and never freed. If you ever need to
* re-initialize this, you can just ckfree() all the StringBlocks in the list
* and start over.
*/
#define STRING_BLOCK_MAX (1024-8) /* Make sizeof(StringBlock) ==
* 1024. */
typedef struct StringBlock {
struct StringBlock *next; /* Starting from "stringMemory" these
* blocks form a linked list. */
int nextFree; /* Top of the used area in the
* "strings" member. */
char strings[STRING_BLOCK_MAX]; /* The actual memory managed here. */
} StringBlock;
static StringBlock *stringMemory = NULL;
#if TK_MAC_COALESCE_LINE
static Tcl_DString currentLine; /* The current line as seen so far. This
* contains a Tcl_UniChar DString. */
static int
currentY = -1, /* The Y position (row in pixels) of the
* current line. */
currentLeft = -1, /* The left edge (pixels) of the current
* line. */
currentRight = -1; /* The right edge (pixels) of the current
* line. */
static const MacFont *currentFontPtr = NULL;
/* The font of the current line. */
#endif /* TK_MAC_COALESCE_LINE */
static int antialiasedTextEnabled;
/*
* The names for our "native" fonts.
*/
#define SYSTEMFONT_NAME "system"
#define APPLFONT_NAME "application"
#define MENUITEMFONT_NAME "menu"
struct SystemFontMapEntry {
const ThemeFontID id;
const char *systemName;
const char *tkName;
const char *tkName1;
};
#define ThemeFont(n, ...) { kTheme##n##Font, "system" #n "Font", ##__VA_ARGS__ }
static const struct SystemFontMapEntry systemFontMap[] = {
ThemeFont(System, "TkDefaultFont", "TkIconFont"),
ThemeFont(EmphasizedSystem, "TkCaptionFont"),
ThemeFont(SmallSystem, "TkHeadingFont", "TkTooltipFont"),
ThemeFont(SmallEmphasizedSystem),
ThemeFont(Application, "TkTextFont"),
ThemeFont(Label, "TkSmallCaptionFont"),
ThemeFont(Views),
ThemeFont(MenuTitle),
ThemeFont(MenuItem, "TkMenuFont"),
ThemeFont(MenuItemMark),
ThemeFont(MenuItemCmdKey),
ThemeFont(WindowTitle),
ThemeFont(PushButton),
ThemeFont(UtilityWindowTitle),
ThemeFont(AlertHeader),
ThemeFont(Toolbar),
ThemeFont(MiniSystem),
{ kThemeSystemFontDetail, "systemDetailSystemFont" },
{ kThemeSystemFontDetailEmphasized, "systemDetailEmphasizedSystemFont" },
{ -1, NULL }
};
#undef ThemeFont
/*
* Procedures used only in this file.
*/
static void LayoutSetString(const MacFont *fontPtr,
const TkMacOSXDrawingContext *drawingContextPtr,
const UniChar * uchars, int ulen);
/*
* The actual workers.
*/
static int MeasureStringWidth(const MacFont *fontPtr, int start, int end);
#if TK_MAC_COALESCE_LINE
static const Tcl_UniChar *UpdateLineBuffer(const MacFont *fontPtr,
const TkMacOSXDrawingContext *drawingContextPtr, const char *source,
int numBytes, int x, int y, int * offset);
#endif /* TK_MAC_COALESCE_LINE */
/*
* Initialization and setup of a font data structure.
*/
static const char *FamilyNameForFamilyID(FMFontFamily familyId);
static void InitFont(FMFontFamily familyId, const char *familyName,
int size, int qdStyle, MacFont *fontPtr);
static void InitATSUObjects(FMFontFamily familyId, short qdsize, short qdStyle,
ATSUFontID *fontIdPtr, ATSUTextLayout *layoutPtr, ATSUStyle *stylePtr);
static void InitATSUStyle(ATSUFontID fontId, short ptSize, short qdStyle,
ATSUStyle style);
static void SetFontFeatures(ATSUFontID fontId, int fixed, short size,
ATSUStyle style);
static void AdjustFontHeight(MacFont *fontPtr);
static void InitATSULayout(const TkMacOSXDrawingContext *drawingContextPtr,
ATSUTextLayout layout, int fixed);
static void ReleaseFont(MacFont *fontPtr);
/*
* Finding fonts by name.
*/
static const MacFontFamily *FindFontFamilyOrAlias(const char *name);
static const MacFontFamily *FindFontFamilyOrAliasOrFallback(const char *name);
/*
* Doing interesting things with font families and fonts.
*/
static void InitFontFamilies(void);
static OSStatus GetFontFamilyName(FMFontFamily fontFamily, char *name,
int numBytes);
/*
* Accessor functions and internal utilities for the font family list.
*/
static const MacFontFamily *AddFontFamily(const char *name,
FMFontFamily familyId);
static const MacFontFamily *FindFontFamily(const char *name);
static Tcl_Obj *EnumFontFamilies(void);
static OSStatus FontFamilyEnumCallback(ATSFontFamilyRef family, void *refCon);
static void SortFontFamilies(void);
static int CompareFontFamilies(const void *vp1, const void *vp2);
static const char *AddString(const char *in);
static OSStatus GetThemeFontAndFamily(const ThemeFontID themeFontId,
FMFontFamily *fontFamily, unsigned char *fontName, SInt16 *fontSize,
Style *fontStyle);
static void InitSystemFonts(TkMainInfo *mainPtr);
static int CreateNamedSystemFont(Tcl_Interp *interp, Tk_Window tkwin,
const char* name, TkFontAttributes *faPtr);
static void DrawCharsInContext(Display *display,
Drawable drawable, GC gc, Tk_Font tkfont,
const char *source, int numBytes, int rangeStart,
int rangeLength, int x, int y, double angle);
/*
*-------------------------------------------------------------------------
*
* TkpFontPkgInit --
*
* This procedure is called when an application is created. It
* initializes all the structures that are used by the
* platform-dependant code on a per application basis.
*
* Results:
* None.
*
* Side effects:
* Initialization of variables local to this file.
*
*-------------------------------------------------------------------------
*/
void
TkpFontPkgInit(
TkMainInfo *mainPtr) /* The application being created. */
{
InitFontFamilies();
InitSystemFonts(mainPtr);
#if TK_MAC_COALESCE_LINE
Tcl_DStringInit(¤tLine);
#endif
}
/*
*-------------------------------------------------------------------------
*
* InitSystemFonts --
*
* Initialize named system fonts.
*
* Results:
*
* None.
*
* Side effects:
*
* None.
*
*-------------------------------------------------------------------------
*/
static void
InitSystemFonts(
TkMainInfo *mainPtr)
{
Tcl_Interp *interp = mainPtr->interp;
Tk_Window tkwin = (Tk_Window) mainPtr->winPtr;
const struct SystemFontMapEntry *systemFont = systemFontMap;
TkFontAttributes fa;
/* force this for now */
if (!mainPtr->winPtr->mainPtr) {
mainPtr->winPtr->mainPtr = mainPtr;
}
TkInitFontAttributes(&fa);
while (systemFont->systemName) {
Str255 fontName;
SInt16 fontSize;
Style fontStyle;
if (GetThemeFont(systemFont->id, smSystemScript, fontName,
&fontSize, &fontStyle) == noErr) {
CopyPascalStringToC(fontName, (char*)fontName);
fa.family = Tk_GetUid((char*)fontName);
fa.size = fontSize;
fa.weight = (fontStyle & bold) ? TK_FW_BOLD : TK_FW_NORMAL;
fa.slant = (fontStyle & italic) ? TK_FS_ITALIC : TK_FS_ROMAN;
fa.underline = ((fontStyle & underline) != 0);
CreateNamedSystemFont(interp, tkwin, systemFont->systemName, &fa);
if (systemFont->tkName) {
CreateNamedSystemFont(interp, tkwin, systemFont->tkName, &fa);
}
if (systemFont->tkName1) {
CreateNamedSystemFont(interp, tkwin, systemFont->tkName1, &fa);
}
}
systemFont++;
}
fa.family = Tk_GetUid("monaco");
fa.size = 11;
fa.weight = TK_FW_NORMAL;
fa.slant = TK_FS_ROMAN;
fa.underline = 0;
CreateNamedSystemFont(interp, tkwin, "TkFixedFont", &fa);
}
/*
*-------------------------------------------------------------------------
*
* CreateNamedSystemFont --
*
* Register a system font with the Tk named font mechanism.
*
* Results:
*
* Result from TkCreateNamedFont().
*
* Side effects:
*
* A new named font is added to the Tk font registry.
*
*-------------------------------------------------------------------------
*/
static int
CreateNamedSystemFont(
Tcl_Interp *interp,
Tk_Window tkwin,
const char* name,
TkFontAttributes *faPtr)
{
TkDeleteNamedFont(NULL, tkwin, name);
return TkCreateNamedFont(interp, tkwin, name, faPtr);
}
/*
*---------------------------------------------------------------------------
*
* GetThemeFontAndFamily --
*
* Wrapper around the GetThemeFont and FMGetFontFamilyFromName APIs.
*
*---------------------------------------------------------------------------
*/
OSStatus
GetThemeFontAndFamily(
const ThemeFontID themeFontId,
FMFontFamily* fontFamily,
unsigned char *fontName,
SInt16 *fontSize,
Style *fontStyle)
{
OSStatus err = ChkErr(GetThemeFont, themeFontId, smSystemScript, fontName,
fontSize, fontStyle);
if (err == noErr) {
*fontFamily = FMGetFontFamilyFromName(fontName);
if (*fontFamily == kInvalidFontFamily) {
err = kFMInvalidFontFamilyErr;
TkMacOSXDbgMsg("FMGetFontFamilyFromName failed.");
}
}
return err;
}
/*
*---------------------------------------------------------------------------
*
* TkpGetNativeFont --
*
* Map a platform-specific native font name to a TkFont.
*
* Results:
* The return value is a pointer to a TkFont that represents the
* native font. If a native font by the given name could not be
* found, the return value is NULL.
*
* Every call to this procedure returns a new TkFont structure, even
* if the name has already been seen before. The caller should call
* TkpDeleteFont() when the font is no longer needed.
*
* The caller is responsible for initializing the memory associated
* with the generic TkFont when this function returns and releasing
* the contents of the generics TkFont before calling TkpDeleteFont().
*
* Side effects:
* None.
*
*---------------------------------------------------------------------------
*/
TkFont *
TkpGetNativeFont(
Tk_Window tkwin, /* For display where font will be used. */
const char *name) /* Platform-specific font name. */
{
ThemeFontID themeFontId;
FMFontFamily fontFamily;
Str255 fontName;
SInt16 fontSize;
Style fontStyle;
MacFont *fontPtr;
if (strcmp(name, SYSTEMFONT_NAME) == 0) {
themeFontId = kThemeSystemFont;
} else if (strcmp(name, APPLFONT_NAME) == 0) {
themeFontId = kThemeApplicationFont;
} else if (strcmp(name, MENUITEMFONT_NAME) == 0) {
themeFontId = kThemeMenuItemFont;
} else {
return NULL;
}
if (GetThemeFontAndFamily(themeFontId, &fontFamily, fontName, &fontSize,
&fontStyle) != noErr) {
return NULL;
}
CopyPascalStringToC(fontName, (char*)fontName);
fontPtr = ckalloc(sizeof(MacFont));
InitFont(fontFamily, (char*)fontName, fontSize, fontStyle, fontPtr);
return (TkFont *) fontPtr;
}
/*
*---------------------------------------------------------------------------
*
* TkpGetFontFromAttributes --
*
* Given a desired set of attributes for a font, find a font with the
* closest matching attributes.
*
* Results:
* The return value is a pointer to a TkFont that represents the font
* with the desired attributes. If a font with the desired attributes
* could not be constructed, some other font will be substituted
* automatically.
*
* Every call to this procedure returns a new TkFont structure, even
* if the specified attributes have already been seen before. The
* caller should call TkpDeleteFont() to free the platform- specific
* data when the font is no longer needed.
*
* The caller is responsible for initializing the memory associated
* with the generic TkFont when this function returns and releasing
* the contents of the generic TkFont before calling TkpDeleteFont().
*
* Side effects:
* None.
*
*---------------------------------------------------------------------------
*/
TkFont *
TkpGetFontFromAttributes(
TkFont *tkFontPtr, /* If non-NULL, store the information in this
* existing TkFont structure, rather than
* allocating a new structure to hold the
* font; the existing contents of the font
* will be released. If NULL, a new TkFont
* structure is allocated. */
Tk_Window tkwin, /* For display where font will be used. */
const TkFontAttributes *faPtr)
/* Set of attributes to match. */
{
short qdStyle;
FMFontFamily familyId;
const char *name;
const MacFontFamily *familyPtr;
MacFont *fontPtr;
familyId = GetAppFont();
name = NULL;
qdStyle = 0;
if (faPtr->family != NULL) {
familyPtr = FindFontFamilyOrAliasOrFallback(faPtr->family);
if (familyPtr != NULL) {
name = familyPtr->name;
familyId = familyPtr->familyId;
}
}
if (faPtr->weight != TK_FW_NORMAL) {
qdStyle |= bold;
}
if (faPtr->slant != TK_FS_ROMAN) {
qdStyle |= italic;
}
if (faPtr->underline) {
qdStyle |= underline;
}
if (tkFontPtr == NULL) {
fontPtr = ckalloc(sizeof(MacFont));
} else {
fontPtr = (MacFont *) tkFontPtr;
ReleaseFont(fontPtr);
}
InitFont(familyId, name, TkFontGetPoints(tkwin, faPtr->size),
qdStyle, fontPtr);
return (TkFont *) fontPtr;
}
/*
*---------------------------------------------------------------------------
*
* TkpDeleteFont --
*
* Called to release a font allocated by TkpGetNativeFont() or
* TkpGetFontFromAttributes(). The caller should have already
* released the fields of the TkFont that are used exclusively by the
* generic TkFont code.
*
* Results:
* TkFont is deallocated.
*
* Side effects:
* None.
*
*---------------------------------------------------------------------------
*/
void
TkpDeleteFont(
TkFont *tkFontPtr) /* Token of font to be deleted. */
{
ReleaseFont((MacFont *) tkFontPtr);
}
/*
*---------------------------------------------------------------------------
*
* TkpGetFontFamilies --
*
* Return information about the font families that are available on
* the display of the given window.
*
* Results:
* Modifies interp's result object to hold a list of all the available
* font families.
*
* Side effects:
* None.
*
*---------------------------------------------------------------------------
*/
void
TkpGetFontFamilies(
Tcl_Interp *interp, /* Interp to hold result. */
Tk_Window tkwin) /* For display to query. */
{
Tcl_SetObjResult(interp, EnumFontFamilies());
}
/*
*-------------------------------------------------------------------------
*
* TkpGetSubFonts --
*
* A function used by the testing package for querying the actual
* screen fonts that make up a font object.
*
* Results:
* Modifies interp's result object to hold a list containing the names
* of the screen fonts that make up the given font object.
*
* Side effects:
* None.
*
*-------------------------------------------------------------------------
*/
void
TkpGetSubFonts(
Tcl_Interp *interp, /* Interp to hold result. */
Tk_Font tkfont) /* Font object to query. */
{
/* We don't know much about our fallback fonts, ATSU does all that for
* us. We could use ATSUMatchFont to implement this function. But as
* the information is only used for testing, such an effort seems not
* very useful. */
}
/*
*----------------------------------------------------------------------
*
* TkpGetFontAttrsForChar --
*
* Retrieve the font attributes of the actual font used to render a
* given character.
*
* Results:
* None.
*
* Side effects:
* The font attributes are stored in *faPtr.
*
*----------------------------------------------------------------------
*/
void
TkpGetFontAttrsForChar(
Tk_Window tkwin, /* Window on the font's display */
Tk_Font tkfont, /* Font to query */
Tcl_UniChar c, /* Character of interest */
TkFontAttributes* faPtr) /* Output: Font attributes */
{
const MacFont * fontPtr = (const MacFont *) tkfont;
UniChar uchar = c;
TkMacOSXDrawingContext drawingContext;
OSStatus err;
ATSUFontID fontId;
UniCharArrayOffset changedOffset;
UniCharCount changedLength;
/*
* Most of the attributes are just copied from the base font. This
* assumes that all fonts can have all attributes.
*/
*faPtr = fontPtr->font.fa;
/*
* But the name of the actual font may still differ, so we activate the
* string as an ATSU layout and ask ATSU about the fallback.
*/
if (!TkMacOSXSetupDrawingContext(Tk_WindowId(tkwin), NULL, 1,
&drawingContext)) {
Tcl_Panic("TkpGetFontAttrsForChar: drawingContext not setup");
}
LayoutSetString(fontPtr, &drawingContext, &uchar, 1);
fontId = fontPtr->atsuFontId;
err = ATSUMatchFontsToText(
fontPtr->atsuLayout, 0, 1,
&fontId, &changedOffset, &changedLength);
if (err != kATSUFontsMatched && err != noErr) {
TkMacOSXDbgMsg("Can't match \\u%04X", (unsigned) c);
}
if (err == kATSUFontsMatched) {
/*
* A fallback was used and the actual font is in fontId. Determine
* the name.
*/
FMFontFamily fontFamilyId;
FMFontStyle fontStyle;
int i;
err = ChkErr(FMGetFontFamilyInstanceFromFont, fontId, &fontFamilyId,
&fontStyle);
if (err == noErr) {
/*
* Find the canonical name in our global list.
*/
for (i=0; i<familyListMaxValid; ++i) {
if (fontFamilyId == familyList[i].familyId) {
faPtr->family = familyList[i].name;
break;
}
}
if (i >= familyListMaxValid) {
TkMacOSXDbgMsg("Can't find font %d for \\u%04X", fontFamilyId,
(unsigned) c);
}
}
}
TkMacOSXRestoreDrawingContext(&drawingContext);
}
/*
*---------------------------------------------------------------------------
*
* Tk_MeasureChars --
*
* Determine the number of characters from the string that will fit in
* the given horizontal span. The measurement is done under the
* assumption that Tk_DrawChars() will be used to actually display the
* characters.
*
* With ATSUI we need the line context to do this right, so we have the
* actual implementation in TkpMeasureCharsInContext().
*
* Results:
* The return value is the number of bytes from source that fit into the
* span that extends from 0 to maxLength. *lengthPtr is filled with the
* x-coordinate of the right edge of the last character that did fit.
*
* Side effects:
* None.
*
* Todo:
* Effects of the "flags" parameter are untested.
*
*---------------------------------------------------------------------------
*/
int
Tk_MeasureChars(
Tk_Font tkfont, /* Font in which characters will be drawn. */
const char *source, /* UTF-8 string to be displayed. Need not be
* '\0' terminated. */
int numBytes, /* Maximum number of bytes to consider from
* source string. */
int maxLength, /* If >= 0, maxLength specifies the longest
* permissible line length; don't consider any
* character that would cross this x-position.
* If < 0, then line length is unbounded and
* the flags argument is ignored. */
int flags, /* Various flag bits OR-ed together:
* TK_PARTIAL_OK means include the last char
* which only partially fit on this line.
* TK_WHOLE_WORDS means stop on a word
* boundary, if possible. TK_AT_LEAST_ONE
* means return at least one character even if
* no characters fit. */
int *lengthPtr) /* Filled with x-location just after the
* terminating character. */
{
return TkpMeasureCharsInContext(tkfont, source, numBytes, 0, numBytes,
maxLength, flags, lengthPtr);
}
/*
*---------------------------------------------------------------------------
*
* TkpMeasureCharsInContext --
*
* Determine the number of bytes from the string that will fit in the
* given horizontal span. The measurement is done under the assumption
* that TkpDrawCharsInContext() will be used to actually display the
* characters.
*
* This one is almost the same as Tk_MeasureChars(), but with access to
* all the characters on the line for context.
*
* Results:
* The return value is the number of bytes from source that
* fit into the span that extends from 0 to maxLength. *lengthPtr is
* filled with the x-coordinate of the right edge of the last
* character that did fit.
*
* Side effects:
* None.
*
*---------------------------------------------------------------------------
*/
int
TkpMeasureCharsInContext(
Tk_Font tkfont, /* Font in which characters will be drawn. */
const char * source, /* UTF-8 string to be displayed. Need not be
* '\0' terminated. */
int numBytes, /* Maximum number of bytes to consider from
* source string in all. */
int rangeStart, /* Index of first byte to measure. */
int rangeLength, /* Length of range to measure in bytes. */
int maxLength, /* If >= 0, maxLength specifies the longest
* permissible line length; don't consider any
* character that would cross this x-position.
* If < 0, then line length is unbounded and
* the flags argument is ignored. */
int flags, /* Various flag bits OR-ed together:
* TK_PARTIAL_OK means include the last char
* which only partially fits on this line.
* TK_WHOLE_WORDS means stop on a word
* boundary, if possible. TK_AT_LEAST_ONE
* means return at least one character even
* if no characters fit. If TK_WHOLE_WORDS
* and TK_AT_LEAST_ONE are set and the first
* word doesn't fit, we return at least one
* character or whatever characters fit into
* maxLength. TK_ISOLATE_END means that the
* last character should not be considered in
* context with the rest of the string (used
* for breaking lines). */
int *lengthPtr) /* Filled with x-location just after the
* terminating character. */
{
const MacFont *fontPtr = (const MacFont *) tkfont;
int curX = -1, curByte = 0;
UniChar *uchars;
int ulen;
UniCharArrayOffset urstart, urlen, urend;
Tcl_DString ucharBuffer;
int forceCharacterMode = 0;
/*
* Sanity checks.
*/
if (rangeStart < 0 || (rangeStart+rangeLength) > numBytes) {
TkMacOSXDbgMsg("Bad parameters");
*lengthPtr = 0;
return 0;
}
/*
* Get simple no-brainers out of the way.
*/
if (rangeLength == 0 || (maxLength == 0 && !(flags & TK_AT_LEAST_ONE))) {
*lengthPtr = 0;
return 0;
}
Tcl_DStringInit(&ucharBuffer);
uchars = Tcl_UtfToUniCharDString(source, numBytes, &ucharBuffer);
ulen = Tcl_DStringLength(&ucharBuffer) / sizeof(Tcl_UniChar);
LayoutSetString(fontPtr, NULL, uchars, ulen);
urstart = Tcl_NumUtfChars(source, rangeStart);
urlen = Tcl_NumUtfChars(source+rangeStart,rangeLength);
urend = urstart + urlen;
if (maxLength < 0) {
curX = MeasureStringWidth(fontPtr, urstart, urend);
curByte = rangeLength;
} else {
UniCharArrayOffset offset = 0;
OSStatus err;
/*
* Have some upper limit on the size actually used.
*/
if (maxLength > 32767) {
maxLength = 32767;
}
offset = urstart;
err = noErr;
if (maxLength > 1) {
/*
* Let the system do some work by calculating a line break.
*
* Somehow ATSUBreakLine seems to assume that it needs at least
* one pixel padding. So we add one to the limit. Note also
* that ATSUBreakLine sometimes runs into an endless loop when
* the third parameter is equal or less than IntToFixed(2), so we
* need at least IntToFixed(3) (at least that's the current state
* of my knowledge).
*/
err = ATSUBreakLine(fontPtr->atsuLayout, urstart,
IntToFixed(maxLength+1), false, /* !iUseAsSoftLineBreak */
&offset);
/*
* There is no way to signal an error from this routine, so we
* use predefined offset=urstart and otherwise ignore the
* possibility.
*/
if ((err != noErr) && (err != kATSULineBreakInWord)) {
TkMacOSXDbgMsg("ATSUBreakLine failed: %ld for '%.*s'", err,
rangeLength, source+rangeStart);
}
#ifdef TK_MAC_DEBUG_FONTS
TkMacOSXDbgMsg("measure: '%.*s', break offset=%ld, errcode=%ld",
rangeLength, source+rangeStart, offset, err);
#endif
/*
* ATSUBreakLine includes the whitespace that separates words,
* but we don't want that. Besides, ATSUBreakLine thinks that
* spaces don't occupy pixels at the end of the break, which is
* also something we like to decide for ourself.
*/
while ((offset > urstart) && (uchars[offset-1] == ' ')) {
offset--;
}
}
/*
* Fix up left-overs for the TK_WHOLE_WORDS case.
*/
if (flags & TK_WHOLE_WORDS) {
if ((flags & TK_AT_LEAST_ONE) && ((offset == urstart)
|| ((offset != urend) && (uchars[offset] != ' ')))) {
/*
* With TK_AT_LEAST_ONE, if we are the the start of the
* range, we need to add at least one character. If we are
* not at the end of a word, we must be in the middle of the
* first word still and we want to just use what we have so
* far. In both cases we still need to find the right
* character boundary, so we set a flag that gets us into the
* code for character mode below.
*/
forceCharacterMode = 1;
} else {
/*
* If we are not at the end of a word, we must be in the
* middle of the first word still. Return 0.
*/
if ((offset != urend) && (uchars[offset] != ' ')) {
offset = urstart;
curX = 0;
}
}
}
if (offset > urend) {
offset = urend;
}
/*
* If "flags" says that we don't actually want a word break, we need
* to find the next character break ourself, as ATSUBreakLine will
* only give us word breaks. Do a simple linear search.
*
* Even do this, if ATSUBreakLine returned kATSULineBreakInWord,
* because we have not accounted correctly for all of the flags yet,
* like TK_AT_LEAST_ONE.
*/
if ((!(flags & TK_WHOLE_WORDS) || forceCharacterMode) && (offset <= urend)) {
UniCharArrayOffset lastOffset = offset;
UniCharArrayOffset nextoffset;
int lastX = -1;
int wantonemorechar = -1; /* undecided */
while (offset <= urend) {
if (flags & TK_ISOLATE_END) {
LayoutSetString(fontPtr, NULL, uchars, offset);
}
curX = MeasureStringWidth(fontPtr, urstart, offset);
#ifdef TK_MAC_DEBUG_FONTS
TkMacOSXDbgMsg("measure: '%.*s', try until=%ld, width=%d",
rangeLength, source+rangeStart, offset, curX);