mirror of
https://github.com/openjdk/jdk.git
synced 2026-01-28 20:18:48 +00:00
98 lines
4.2 KiB
Java
98 lines
4.2 KiB
Java
/*
|
|
* Copyright (c) 2022, 2025, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package java.lang.classfile.attribute;
|
|
|
|
import java.lang.classfile.Attribute;
|
|
import java.lang.classfile.AttributeMapper;
|
|
import java.lang.classfile.AttributeMapper.AttributeStability;
|
|
import java.lang.classfile.Attributes;
|
|
import java.lang.classfile.ClassFile;
|
|
import java.lang.classfile.CodeBuilder;
|
|
import java.lang.classfile.CodeModel;
|
|
import java.lang.classfile.instruction.CharacterRange;
|
|
import java.util.List;
|
|
|
|
import jdk.internal.classfile.impl.BoundAttribute;
|
|
import jdk.internal.classfile.impl.UnboundAttribute;
|
|
|
|
/**
|
|
* Models the {@link Attributes#characterRangeTable() CharacterRangeTable}
|
|
* attribute, which is a bidirectional mapping from ranges of positions in the
|
|
* source file to ranges of indices into the {@code code} array. Its entries
|
|
* are delivered as {@link CharacterRange}s when traversing the elements of a
|
|
* {@link CodeModel}, toggled by {@link ClassFile.DebugElementsOption}.
|
|
* <p>
|
|
* The {@code CharacterRangeTable} attribute consists of an array of {@linkplain
|
|
* CharacterRangeInfo character range entries}. The character range entries
|
|
* form a forest data structure: any two range entries are either disjoint, or
|
|
* if they overlap, then one entry must be enclosed within the other, both in
|
|
* {@code code} array indices and source file character positions. The
|
|
* character range entries may appear in any order.
|
|
* <p>
|
|
* This attribute only appears on {@code Code} attributes, permits multiple
|
|
* appearances but should only {@linkplain AttributeMapper#allowMultiple()
|
|
* appear once} in a {@code Code} attribute. It has a data dependency on
|
|
* {@linkplain AttributeStability#LABELS labels}.
|
|
* <p>
|
|
* This attribute cannot be sent to a {@link CodeBuilder}; its entries can be
|
|
* constructed with {@link CharacterRange}, resulting in at most one
|
|
* attribute instance in the built {@code Code} attribute.
|
|
* <p>
|
|
* This attribute is not predefined in the Java SE Platform. This is a
|
|
* JDK-specific nonstandard attribute produced by the {@linkplain jdk.compiler/
|
|
* implementation of the system Java compiler}.
|
|
*
|
|
* @see Attributes#characterRangeTable()
|
|
* @see CompilationIDAttribute
|
|
* @see SourceIDAttribute
|
|
* @since 24
|
|
*/
|
|
@SuppressWarnings("doclint:reference")
|
|
public sealed interface CharacterRangeTableAttribute
|
|
extends Attribute<CharacterRangeTableAttribute>
|
|
permits BoundAttribute.BoundCharacterRangeTableAttribute,
|
|
UnboundAttribute.UnboundCharacterRangeTableAttribute {
|
|
|
|
/**
|
|
* {@return the entries of the character range table}
|
|
*/
|
|
List<CharacterRangeInfo> characterRangeTable();
|
|
|
|
/**
|
|
* {@return a {@code CharacterRangeTable} attribute}
|
|
*
|
|
* @apiNote
|
|
* The created attribute cannot be written to a {@link CodeBuilder}. Use
|
|
* {@link CodeBuilder#characterRange CodeBuilder::characterRange} instead.
|
|
*
|
|
* @param ranges the descriptions of the character ranges
|
|
*/
|
|
static CharacterRangeTableAttribute of(List<CharacterRangeInfo> ranges) {
|
|
return new UnboundAttribute.UnboundCharacterRangeTableAttribute(ranges);
|
|
}
|
|
}
|
|
|