GlueGen: src/java/com/jogamp/gluegen/SymbolFilter.java Source File

GlueGen v2.6.0-rc-20250712 GlueGen, Native Binding Generator for Java™ (public API).

SymbolFilter.java
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 * - Redistribution of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * - Redistribution in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * Neither the name of Sun Microsystems, Inc. or the names of
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * This software is provided "AS IS," without a warranty of any kind. ALL
20 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
21 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
22 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
23 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
24 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
25 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
26 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
27 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
28 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
29 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
30 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
31 *
32 */
33
34package com.jogamp.gluegen;
35
36import com.jogamp.gluegen.cgram.types.FunctionSymbol;
37
38import java.util.List;
39
40/** Provides a mechanism by which the GlueEmitter can look at all of
41 the #defines, enum values and function symbols and perform certain
42 filtering and processing which requires all of them to be visible
43 simultaneously. */
44
45 public interface SymbolFilter {
46 /**
47 * Filters the given constant and function symbols. The caller
48 * will query the SymbolFilter for its resulting constant and
49 * function symbol lists after this routine returns.
50 *
51 * @param defines a list of {@link com.jogamp.gluegen.cgram.Define Define} objects
52 * @param functions a list of {@link com.jogamp.gluegen.cgram.types.FunctionSymbol FunctionSymbol} objects
53 */
54 public void filterSymbols(List<ConstantDefinition> constants, List<FunctionSymbol> functions);
55
56 /** Returns the filtered list of constants. This method may return
57 a new list, the original list, or null, in which case the
58 original list will be used. */
59 public List<ConstantDefinition> getConstants();
60
61 /** Returns the filtered list of function symbols. This method may
62 return a new list, the original list, or null, in which case
63 the original list will be used. */
64 public List<FunctionSymbol> getFunctions();
65}
com.jogamp.gluegen.SymbolFilter
Provides a mechanism by which the GlueEmitter can look at all of the #defines, enum values and functi...
Definition: SymbolFilter.java:45
com.jogamp.gluegen.SymbolFilter.getConstants
List< ConstantDefinition > getConstants()
Returns the filtered list of constants.
com.jogamp.gluegen.SymbolFilter.filterSymbols
void filterSymbols(List< ConstantDefinition > constants, List< FunctionSymbol > functions)
Filters the given constant and function symbols.
com.jogamp.gluegen.SymbolFilter.getFunctions
List< FunctionSymbol > getFunctions()
Returns the filtered list of function symbols.