aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/fonts/FontManager.java
blob: 8ff85afb4118680c1dfd54ba7a83d520c3fa6e40 (plain)
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
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id: $ */

package org.apache.fop.fonts;

import java.awt.Graphics2D;
import java.net.MalformedURLException;

import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;

import org.apache.fop.apps.FopFactory;
import org.apache.fop.fonts.substitute.FontSubstitutions;
import org.apache.fop.render.PrintRenderer;

// TODO: Refactor fonts package so major font activities (autodetection etc) 
// are all centrally managed and delegated from this class, also remove dependency on FopFactory
// and start using POJO config/properties type classes

/**
 * The manager of fonts
 */
public class FontManager {
    /** Use cache (record previously detected font triplet info) */
    public static final boolean DEFAULT_USE_CACHE = true;

    /** The base URL for all font URL resolutions. */
    private String fontBase = null;

    /** Font cache to speed up auto-font configuration (null if disabled) */
    private FontCache fontCache = null;

    /** Font substitutions */
    private FontSubstitutions fontSubstitutions = null;

    private FopFactory fopFactory = null;

    /** Allows enabling kerning on the base 14 fonts, default is false */
    private boolean enableBase14Kerning = false;

    /**
     * Main constructor
     * 
     * @param fopFactory the fo URI resolver
     */
    public FontManager(FopFactory fopFactory) {
        this(fopFactory, DEFAULT_USE_CACHE);
    }
    
    /**
     * Constructor
     * 
     * @param fopFactory the fo URI resolver
     * @param useCache true if the FontCache should be used
     */
    public FontManager(FopFactory fopFactory, boolean useCache) {
        this.fopFactory  = fopFactory;
        setUseCache(useCache);
    }
    
    /**
     * Sets the font base URL.
     * @param fontBase font base URL
     * @throws MalformedURLException if there's a problem with a file URL
     */
    public void setFontBaseURL(String fontBase) throws MalformedURLException {
        this.fontBase = fopFactory.getFOURIResolver().checkBaseURL(fontBase);
    }

    /**
     * @return the font base URL
     */
    public String getFontBaseURL() {
        return this.fontBase;
    }

    /** @return true if kerning on base 14 fonts is enabled */
    public boolean isBase14KerningEnabled() {
        return this.enableBase14Kerning;
    }

    /**
     * Controls whether kerning is activated on base 14 fonts.
     * @param value true if kerning should be activated
     */
    public void setBase14KerningEnabled(boolean value) {
        this.enableBase14Kerning = value;        
    }

    /**
     * Sets the font substitutions
     * @param substitutions font substitutions
     */
    public void setFontSubstitutions(FontSubstitutions substitutions) {
        this.fontSubstitutions = substitutions;
    }
    
    /**
     * Returns the font substitution catalog
     * @return the font substitution catalog
     */
    protected FontSubstitutions getFontSubstitutions() {
        if (fontSubstitutions == null) {
            this.fontSubstitutions = new FontSubstitutions();
        }
        return fontSubstitutions;
    }

    /**
     * Whether or not to cache results of font triplet detection/auto-config
     * @param useCache use cache or not
     */
    public void setUseCache(boolean useCache) {
        if (useCache) {
            this.fontCache = FontCache.load();
            if (this.fontCache == null) {
                this.fontCache = new FontCache();
            }
        } else {
            this.fontCache = null;
        }
    }

    /**
     * Cache results of font triplet detection/auto-config?
     * @return true if this font manager uses the cache
     */
    public boolean useCache() {
        return (this.fontCache != null);
    }

    /**
     * Returns the font cache instance used by this font manager.
     * @return the font cache
     */
    public FontCache getFontCache() {
        return this.fontCache;
    }
    
    /**
     * Sets up the fonts on a given PrintRenderer
     * @param renderer a print renderer
     */
    public void setupRenderer(PrintRenderer renderer) {
        FontInfo fontInfo = renderer.getFontInfo();

        int startNum = 1;
        
        // Configure base 14 fonts
        org.apache.fop.fonts.base14.Base14FontCollection base14FontCollection
            = new org.apache.fop.fonts.base14.Base14FontCollection(this.enableBase14Kerning);
        startNum = base14FontCollection.setup(startNum, fontInfo);

        // Configure any custom font collection
        org.apache.fop.fonts.CustomFontCollection customFontCollection
            = new org.apache.fop.fonts.CustomFontCollection(renderer);
        startNum = customFontCollection.setup(startNum, fontInfo);
                
        // Make any defined substitutions in the font info
        getFontSubstitutions().adjustFontInfo(fontInfo);
    }

    /**
     * Sets up the fonts on a given PrintRenderer with Graphics2D
     * @param renderer a print renderer
     * @param graphics2D a graphics 2D
     */
    public void setupRenderer(PrintRenderer renderer, Graphics2D graphics2D) {
        FontInfo fontInfo = renderer.getFontInfo();

        int startNum = 1;

        // setup base 14 fonts
        org.apache.fop.render.java2d.Base14FontCollection base14FontCollection
            = new org.apache.fop.render.java2d.Base14FontCollection(graphics2D);
        
        // setup any custom font collection
        startNum = base14FontCollection.setup(startNum, fontInfo);

        // setup any installed fonts
        org.apache.fop.render.java2d.InstalledFontCollection installedFontCollection
            = new org.apache.fop.render.java2d.InstalledFontCollection(graphics2D);
        startNum = installedFontCollection.setup(startNum, fontInfo);

        // setup any configured fonts
        org.apache.fop.render.java2d.ConfiguredFontCollection configuredFontCollection
            = new org.apache.fop.render.java2d.ConfiguredFontCollection(renderer);
        startNum = configuredFontCollection.setup(startNum, fontInfo);

        // Make any defined substitutions in the font info
        getFontSubstitutions().adjustFontInfo(fontInfo);        
    }

    /** @return a new FontResolver to be used by the font subsystem */
    public static FontResolver createMinimalFontResolver() {
        return new FontResolver() {

            /** {@inheritDoc} */
            public Source resolve(String href) {
                //Minimal functionality here
                return new StreamSource(href);
            }
        };
    }
}