SymbolFilter.java

/*
 * Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 */

package com.jogamp.gluegen;

import com.jogamp.gluegen.cgram.types.FunctionSymbol;

import java.util.List;

/** Provides a mechanism by which the GlueEmitter can look at all of
    the #defines, enum values and function symbols and perform certain
    filtering and processing which requires all of them to be visible
    simultaneously. */

public interface SymbolFilter {
    /**
     * Filters the given constant and function symbols. The caller
     * will query the SymbolFilter for its resulting constant and
     * function symbol lists after this routine returns.
     *
     * @param defines a list of {@link com.jogamp.gluegen.cgram.Define Define} objects
     * @param functions a list of {@link com.jogamp.gluegen.cgram.types.FunctionSymbol FunctionSymbol} objects
     */
    public void filterSymbols(List<ConstantDefinition> constants, List<FunctionSymbol> functions);

    /** Returns the filtered list of constants. This method may return
        a new list, the original list, or null, in which case the
        original list will be used. */
    public List<ConstantDefinition> getConstants();

    /** Returns the filtered list of function symbols. This method may
        return a new list, the original list, or null, in which case
        the original list will be used. */
    public List<FunctionSymbol> getFunctions();
}