Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add enum documentation #241

Merged
merged 1 commit into from
Jan 24, 2025
Merged

docs: add enum documentation #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 34 additions & 10 deletions ristretto_classfile/src/attributes/attribute.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ const VERSION_61_0: Version = Version::Java17 { minor: 0 };
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7>
#[derive(Clone, Debug, PartialEq)]
pub enum Attribute {
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.2>
ConstantValue {
name_index: u16,
constant_value_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.3>
Code {
name_index: u16,
max_stack: u16,
Expand All @@ -49,89 +51,107 @@ pub enum Attribute {
exception_table: Vec<ExceptionTableEntry>,
attributes: Vec<Attribute>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.4>
StackMapTable {
name_index: u16,
frames: Vec<StackFrame>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.5>
Exceptions {
name_index: u16,
exception_indexes: Vec<u16>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.6>
InnerClasses {
name_index: u16,
classes: Vec<InnerClass>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.7>
EnclosingMethod {
name_index: u16,
class_index: u16,
method_index: u16,
},
Synthetic {
name_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.8>
Synthetic { name_index: u16 },
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.9>
Signature {
name_index: u16,
signature_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.10>
SourceFile {
name_index: u16,
source_file_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.11>
SourceDebugExtension {
name_index: u16,
debug_extension: String,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.12>
LineNumberTable {
name_index: u16,
line_numbers: Vec<LineNumber>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.13>
LocalVariableTable {
name_index: u16,
variables: Vec<LocalVariableTable>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.14>
LocalVariableTypeTable {
name_index: u16,
variable_types: Vec<LocalVariableTypeTable>,
},
Deprecated {
name_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.15>
Deprecated { name_index: u16 },
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.16>
RuntimeVisibleAnnotations {
name_index: u16,
annotations: Vec<Annotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.17>
RuntimeInvisibleAnnotations {
name_index: u16,
annotations: Vec<Annotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.18>
RuntimeVisibleParameterAnnotations {
name_index: u16,
parameter_annotations: Vec<ParameterAnnotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.19>
RuntimeInvisibleParameterAnnotations {
name_index: u16,
parameter_annotations: Vec<ParameterAnnotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.20>
RuntimeVisibleTypeAnnotations {
name_index: u16,
type_annotations: Vec<TypeAnnotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.21>
RuntimeInvisibleTypeAnnotations {
name_index: u16,
type_annotations: Vec<TypeAnnotation>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.22>
AnnotationDefault {
name_index: u16,
element: AnnotationElement,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.23>
BootstrapMethods {
name_index: u16,
methods: Vec<BootstrapMethod>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.24>
MethodParameters {
name_index: u16,
parameters: Vec<MethodParameter>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.25>
Module {
name_index: u16,
module_name_index: u16,
Expand All @@ -143,34 +163,38 @@ pub enum Attribute {
uses: Vec<u16>,
provides: Vec<Provides>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.26>
ModulePackages {
name_index: u16,
package_indexes: Vec<u16>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.27>
ModuleMainClass {
name_index: u16,
main_class_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.28>
NestHost {
name_index: u16,
host_class_index: u16,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.29>
NestMembers {
name_index: u16,
class_indexes: Vec<u16>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.30>
Record {
name_index: u16,
records: Vec<Record>,
},
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.31>
PermittedSubclasses {
name_index: u16,
class_indexes: Vec<u16>,
},
Unknown {
name_index: u16,
info: Vec<u8>,
},
/// Used to support reading future classes where the structure is not known beforehand.
Unknown { name_index: u16, info: Vec<u8> },
}

impl Attribute {
Expand Down
3 changes: 3 additions & 0 deletions ristretto_classfile/src/attributes/exception_table_entry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ use std::ops::Range;

/// Implementation of an `ExceptionTable` entry.
///
/// This implementation differs from the specification. The program counter offsets represent
/// an index into the logical code instructions instead of the physical byte offsets.
///
/// See: <https://docs.oracle.com/javase/specs/jvms/se23/html/jvms-4.html#jvms-4.7.3>
#[derive(Clone, Debug, PartialEq)]
pub struct ExceptionTableEntry {
Expand Down
Loading
Loading