1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 /* $Id$ */
19 
20 package org.apache.fop.complexscripts.fonts;
21 
22 // CSOFF: LineLengthCheck
23 
24 /**
25  * <p>The <code>GlyphSubstitution</code> interface is implemented by a glyph substitution subtable
26  * that supports the determination of glyph substitution information based on script and
27  * language of the corresponding character content.</p>
28  *
29  * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
30  */
31 public interface GlyphSubstitution {
32 
33     /**
34      * Perform glyph substitution at the current index, mutating the substitution state object as required.
35      * Only the context associated with the current index is processed.
36      * @param ss glyph substitution state object
37      * @return true if the glyph subtable was applied, meaning that the current context matches the
38      * associated input context glyph coverage table
39      */
substitute(GlyphSubstitutionState ss)40     boolean substitute(GlyphSubstitutionState ss);
41 
42 }
43