Class ProgramLicences

java.lang.Object

org.ek9lang.core.ProgramLicences

public final class ProgramLicences
extends Object

THE licence files every program EK9 compiles carries with it (licence decision D-L1, docs/legal): the runtime's Apache-2.0 licence, the runtime's NOTICE, and the notices of the third-party code the program contains. Apache-2.0 s.4 asks that they travel with every copy of the runtime, and every compiled program is one.

A program jar holds them as JAR_DIRECTORY entries (RuntimeClassExtractor writes them). A native executable has no jar, so it holds them EMBEDDED: each file is a NUL, EMBEDDED_MARK, its name, a newline, its text and a NUL - plain bytes in a data section, found by scanning, so no object-file format needs parsing and strings shows them too. readFrom(Path) reads either form back; ek9 -show-licences is its door. The names are always FILE_NAMES, whatever the form, and nothing else is ever read or written.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ProgramLicences.LicenceFile	One licence file: its name (one of FILE_NAMES) and its bytes.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMBEDDED_MARK	What precedes the name of each embedded file, after its NUL.
static final List<String>	FILE_NAMES	Every licence file a program carries, in the order they are shown.
static final String	JAR_DIRECTORY	Where a program jar holds them.
static final String	LICENCE_FILE	The runtime's licence, the Apache License 2.0.
static final String	NOTICE_FILE	The runtime's NOTICE.
static final String	THIRD_PARTY_FILE	The notices of the third-party code in the program (a JVM program and a native one contain different code).

Method Summary

Modifier and Type	Method	Description
static byte[]	embedded(List<ProgramLicences.LicenceFile> files)	The embedded form of files, for a native executable's data.
static List<ProgramLicences.LicenceFile>	forJvmPrograms()	The licence files the compiler puts with every program it compiles for the JVM.
(package private) static List<ProgramLicences.LicenceFile>	fromEmbedded(byte[] bytes)	The embedded files in bytes; the first of each name counts.
static List<ProgramLicences.LicenceFile>	readFrom(Path program)	The licence files program carries - a program jar or a native executable - in FILE_NAMES order; empty when it carries none (it is not a program EK9 compiled, or EK9 compiled it before programs carried them).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LICENCE_FILE

public static final String LICENCE_FILE

The runtime's licence, the Apache License 2.0.

See Also:

• Constant Field Values

NOTICE_FILE

public static final String NOTICE_FILE

The runtime's NOTICE.

See Also:

• Constant Field Values

THIRD_PARTY_FILE

public static final String THIRD_PARTY_FILE

The notices of the third-party code in the program (a JVM program and a native one contain different code).

See Also:

• Constant Field Values

FILE_NAMES

public static final List<String> FILE_NAMES

Every licence file a program carries, in the order they are shown.

JAR_DIRECTORY

public static final String JAR_DIRECTORY

Where a program jar holds them.

See Also:

• Constant Field Values

EMBEDDED_MARK

public static final String EMBEDDED_MARK

What precedes the name of each embedded file, after its NUL.

See Also:

• Constant Field Values

Method Details

forJvmPrograms

public static List<ProgramLicences.LicenceFile> forJvmPrograms()

The licence files the compiler puts with every program it compiles for the JVM.

embedded

public static byte[] embedded(List<ProgramLicences.LicenceFile> files)

The embedded form of files, for a native executable's data.

readFrom

public static List<ProgramLicences.LicenceFile> readFrom(Path program)
                                                  throws IOException

The licence files program carries - a program jar or a native executable - in FILE_NAMES order; empty when it carries none (it is not a program EK9 compiled, or EK9 compiled it before programs carried them).

Throws:

IOException

fromEmbedded

static List<ProgramLicences.LicenceFile> fromEmbedded(byte[] bytes)

The embedded files in bytes; the first of each name counts.