/* BSD 2-Clause License - see OPAL/LICENSE for details. */
package org.opalj
package bi
package reader

import java.io.DataInputStream

/**
 * The SourceFile attribute is an optional attribute in the
 * attributes table of a ClassFile structure.
 */
trait SourceFile_attributeReader extends AttributeReader {

    //
    // TYPE DEFINITIONS AND FACTORY METHODS
    //

    type SourceFile_attribute <: Attribute

    def SourceFile_attribute(
        cp:                   Constant_Pool,
        ap_name_index:        Constant_Pool_Index,
        ap_descriptor_index:  Constant_Pool_Index,
        attribute_name_index: Constant_Pool_Index,
        sourcefile_index:     Constant_Pool_Index
    ): SourceFile_attribute

    //
    // IMPLEMENTATION
    //

    /**
     * The SourceFile attribute is an optional fixed-length attribute in the
     * attributes table of a ClassFile structure.
     *
     * <pre>
     * SourceFile_attribute {
     *    u2 attribute_name_index;
     *    u4 attribute_length;
     *    u2 sourcefile_index;
     * }
     * </pre>
     */
    private[this] def parserFactory() = (
        cp: Constant_Pool,
        ap: AttributeParent,
        ap_name_index: Constant_Pool_Index,
        ap_descriptor_index: Constant_Pool_Index,
        attribute_name_index: Constant_Pool_Index,
        in: DataInputStream
    ) => {
        /*val attribute_length =*/ in.readInt
        SourceFile_attribute(
            cp, ap_name_index, ap_descriptor_index, attribute_name_index, in.readUnsignedShort
        )
    }

    registerAttributeReader(SourceFileAttribute.Name -> parserFactory())
}