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>GlyphClassMapping</code> interface provides glyph identifier to class
26  * index mapping support.</p>
27  *
28  * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
29  */
30 public interface GlyphClassMapping {
31 
32     /**
33      * Obtain size of class table, i.e., ciMax + 1, where ciMax is the maximum
34      * class index.
35      * @param set for coverage set based class mappings, indicates set index, otherwise ignored
36      * @return size of class table
37      */
getClassSize(int set)38     int getClassSize(int set);
39 
40     /**
41      * Map glyph identifier (code) to coverge index. Returns -1 if glyph identifier is not in the domain of
42      * the class table.
43      * @param gid glyph identifier (code)
44      * @param set for coverage set based class mappings, indicates set index, otherwise ignored
45      * @return non-negative glyph class index or -1 if glyph identifiers is not mapped by table
46      */
getClassIndex(int gid, int set)47     int getClassIndex(int gid, int set);
48 
49 }
50