poke-elf-1.0/0000755000175000017500000000000014602060043010050 500000000000000poke-elf-1.0/elf.pk0000644000175000017500000000314414602057306011104 00000000000000/* elf.pk - ELF implementation for GNU poke. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* This file contains a Poke description of the ELF (Executable and * Linking Format) object file format. The ELF format is described in * the chapter 4 of the SysV ABI. * * Both ELF32 and ELF64 are supported. * * In general, we use the same field names used in the C structs * documented in the gABI, that are also used in the widely used ELF * implementations like in the GNU binutils and also in elfutils. * This makes life easier for system hackers who are already familiar * with these names. */ load "elf-build.pk"; load "elf-config.pk"; load "elf-common.pk"; load "elf-os-gnu.pk"; load "elf-os-linux.pk"; load "elf-os-llvm.pk"; load "elf-os-openbsd.pk"; load "elf-mach-x86-64.pk"; load "elf-mach-aarch64.pk"; load "elf-mach-mips.pk"; load "elf-mach-sparc.pk"; load "elf-mach-arm.pk"; load "elf-mach-bpf.pk"; load "elf-mach-riscv.pk"; load "elf-32.pk"; load "elf-64.pk"; poke-elf-1.0/elf-mach-arm.pk0000644000175000017500000001406014602057352012567 00000000000000/* elf-mach-arm.pk - ELF ARM specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* ARM file flags. */ var ELF_EF_ARM_RELEXEC = 0x01U, ELF_EF_ARM_INTERWORK = 0x04U, ELF_EF_ARM_APCS_26 = 0x08U, ELF_EF_ARM_APCS_FLOAT = 0x10U, ELF_EF_ARM_PIC = 0x20U, ELF_EF_ARM_ALIGN8 = 0x40U, ELF_EF_ARM_NEW_ABI = 0x80U, ELF_EF_ARM_OLD_ABI = 0x100U, ELF_EF_ARM_SOFT_FLOAT = 0x200U, ELF_EF_ARM_VFP_FLOAT = 0x400U, ELF_EF_ARM_MAVERICK_FLOAT = 0x800U, /* These are for AAELF, whatever that thing is. */ ELF_EF_ARM_BE8 = 0x0080_0000U, ELF_EF_ARM_LE8 = 0x0040_0000U, /* The 0xFF00_0000 bits are for the EABI version. */ ELF_EF_ARM_EABIMASK = 0xff00_0000U, ELF_EF_ARM_EABI_VER1 = 0x0100_0000U, ELF_EF_ARM_EABI_VER2 = 0x02000000U, ELF_EF_ARM_EABI_VER3 = 0x03000000U, ELF_EF_ARM_EABI_VER4 = 0x04000000U, ELF_EF_ARM_EABI_VER5 = 0x05000000U; elf_config.add_mask :machine ELF_EM_ARM :class "file-flags" :entries [Elf_Config_Mask { value = ELF_EF_ARM_RELEXEC, name = "relexec" }, Elf_Config_Mask { value = ELF_EF_ARM_INTERWORK, name = "interwork" }, Elf_Config_Mask { value = ELF_EF_ARM_APCS_26, name = "apcs-26" }, Elf_Config_Mask { value = ELF_EF_ARM_APCS_FLOAT, name = "apcs-float" }, Elf_Config_Mask { value = ELF_EF_ARM_PIC, name = "pic" }, Elf_Config_Mask { value = ELF_EF_ARM_ALIGN8, name = "align8" }, Elf_Config_Mask { value = ELF_EF_ARM_NEW_ABI, name = "new-abi" }, Elf_Config_Mask { value = ELF_EF_ARM_OLD_ABI, name = "old-abi" }, Elf_Config_Mask { value = ELF_EF_ARM_SOFT_FLOAT, name = "soft-float" }, Elf_Config_Mask { value = ELF_EF_ARM_VFP_FLOAT, name = "vfp-float" }, Elf_Config_Mask { value = ELF_EF_ARM_MAVERICK_FLOAT, name = "maverick-float" }, Elf_Config_Mask { value = ELF_EF_ARM_BE8, name = "be8" }, Elf_Config_Mask { value = ELF_EF_ARM_LE8, name = "le8" }, Elf_Config_Mask { value = ELF_EF_ARM_EABI_VER1, name = "eabi-ver1" }, Elf_Config_Mask { value = ELF_EF_ARM_EABI_VER2, name = "eabi-ver2" }, Elf_Config_Mask { value = ELF_EF_ARM_EABI_VER3, name = "eabi-ver3" }, Elf_Config_Mask { value = ELF_EF_ARM_EABI_VER4, name = "eabi-ver4" }, Elf_Config_Mask { value = ELF_EF_ARM_EABI_VER5, name = "eabi-ver5" }]; /* ARM segment types. */ var ELF_PT_ARM_EXIDX = ELF_PT_LOPROC + 1; elf_config.add_enum :machine ELF_EM_ARM :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_ARM_EXIDX, name = "exidx" }]; /* ARM symbol types. */ var ELF_STT_ARM_TFUNC = ELF_STT_LOPROC, ELF_STT_ARM_16BIT = ELF_STT_HIPROC; elf_config.add_enum :machine ELF_EM_ARM :class "symbol-types" :entries [Elf_Config_UInt { value = ELF_STT_ARM_TFUNC, name = "tfunc", doc = "A Thumb function." }, Elf_Config_UInt { value = ELF_STT_ARM_16BIT, name = "16bit", doc = "A Thumb label." }]; /* ARM section types. */ var ELF_SHT_ARM_EXIDX = 0x7000_0001U, ELF_SHT_ARM_PREEMPTMAP = 0x7000_0002U, ELF_SHT_ARM_ATTRIBUTES = 0x7000_0003U, ELF_SHT_ARM_DEBUGOVERLAY = 0x7000_0004U, ELF_SHT_ARM_OVERLAYSECTION = 0x7000_0005U; elf_config.add_enum :machine ELF_EM_ARM :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_ARM_EXIDX, name = "exidx", doc = "Section holds ARM unwind info." }, Elf_Config_UInt { value = ELF_SHT_ARM_PREEMPTMAP, name = "preemptmap", doc = "Section pre-emption details." }, Elf_Config_UInt { value = ELF_SHT_ARM_ATTRIBUTES, name = "attributes", doc = "Section holds attributes." }, Elf_Config_UInt { value = ELF_SHT_ARM_DEBUGOVERLAY, name = "debugoverlay", doc = "Section holds overlay debug info." }, Elf_Config_UInt { value = ELF_SHT_ARM_OVERLAYSECTION, name = "overlaysection", doc = "Section holds GDB and overlay integration info." }]; /* ARM section flags. */ var ELF_SHF_ARM_ENTRYSECT = 0x1000_0000U, ELF_SHF_ARM_PURECODE = 0x2000_0000U, ELF_SHF_ARM_COMDEF = 0x8000_0000U; elf_config.add_mask :machine ELF_EM_ARM :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_ARM_ENTRYSECT, name = "entrysect", doc = "Section contains an entry point." }, Elf_Config_Mask { value = ELF_SHF_ARM_PURECODE, name = "purecode", doc = "Section contains only code and no data." }, Elf_Config_Mask { value = ELF_SHF_ARM_COMDEF, name = "comdef", doc = "Section may be multiply defined in the input to a link step." }]; /* ARM segment flags. */ var ELF_PF_ARM_SB = 0x1000_0000, ELF_PF_ARM_PI = 0x2000_0000, ELF_PF_ARM_ABS = 0x4000_000; elf_config.add_mask :machine ELF_EM_ARM :class "segment-flags" :entries [Elf_Config_Mask { value = ELF_PF_ARM_SB, name = "sb", doc = "Segment contains the location addressed by the static base." }, Elf_Config_Mask { value = ELF_PF_ARM_PI, name = "pi", doc = "Segment is position-independent." }, Elf_Config_Mask { value = ELF_PF_ARM_ABS, name = "abs", doc = "Segment must be loaded at its base address." }]; poke-elf-1.0/elf-os-gnu.pk0000644000175000017500000002437314602057373012325 00000000000000/* elf-os-gnu.pk - ELF GNU specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* The GNU ABI is documented at https://sourceware.org/gnu-gabi */ /* GNU segment types. */ var ELF_PT_GNU_EH_FRAME = 0x6474e550U, ELF_PT_GNU_STACK = 0x6474e551U, ELF_PT_GNU_RELRO = 0x6474e552U, ELF_PT_GNU_PROPERTY = 0x6474e553U; elf_config.add_enum :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_GNU_EH_FRAME, name = "gnu-eh-frame" }, Elf_Config_UInt { value = ELF_PT_GNU_STACK, name = "gnu-stack" }, Elf_Config_UInt { value = ELF_PT_GNU_RELRO, name = "gnu-relro" }, Elf_Config_UInt { value = ELF_PT_GNU_PROPERTY, name = "gnu-property" }]; /* GNU section types. */ var ELF_SHT_GNU_INCREMENTAL_INPUTS = 0x6fff_4700U, ELF_SHT_GNU_ATTRIBUTES = 0x6fff_fff5U, ELF_SHT_GNU_HASH = 0x6fff_fff6U, ELF_SHT_GNU_LIBLIST = 0x6fff_fff7U, ELF_SHT_GNU_VERDEF = 0x6fff_fffdU, ELF_SHT_GNU_VERNEED = 0x6fff_fffeU, ELF_SHT_GNU_VERSYM = 0x6fff_ffffU; elf_config.add_enum :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_GNU_INCREMENTAL_INPUTS, name = "gnu-incremental-inputs" }, Elf_Config_UInt { value = ELF_SHT_GNU_ATTRIBUTES, name = "gnu-attributes" }, Elf_Config_UInt { value = ELF_SHT_GNU_HASH, name = "gnu-hash" }, Elf_Config_UInt { value = ELF_SHT_GNU_LIBLIST, name = "gnu-liblist" }, Elf_Config_UInt { value = ELF_SHT_GNU_VERDEF, name = "gnu-verdef" }, Elf_Config_UInt { value = ELF_SHT_GNU_VERNEED, name = "gnu-verneed" }, Elf_Config_UInt { value = ELF_SHT_GNU_VERSYM, name = "gnu-versym" }]; /* GNU Dynamic tags. */ var ELF_DT_GNU_HASH = 0x6fff_fef5U, ELF_DT_VERSYM = 0x6fff_fff0U, ELF_DT_FLAGS_1 = 0x6fff_fffbU, ELF_DT_VERDEF = 0x6fff_fffcU, ELF_DT_GNU_PRELINKED = 0x6ffffdf5U, ELF_DT_GNU_CONFLICTSZ = 0x6ffffdf6U, ELF_DT_TLSDESC_PLT = 0x6ffffef6U, ELF_DT_TLSDESC_GOT = 0x6ffffef7U, ELF_DT_GNU_CONFLICT = 0x6ffffef8U, ELF_DT_GNU_LIBLIST= 0x6ffffef9U, ELF_DT_CONFIG = 0x6ffffefaU, ELF_DT_DEPAUDIT = 0x6ffffefbU, ELF_DT_AUDIT = 0x6ffffefcU, ELF_DT_PLTPAD = 0x6ffffefdU, ELF_DT_MOVETAB = 0x6ffffefeU, ELF_DT_SYMINFO = 0x6ffffeffU, ELF_DT_ADDRRNGHI = 0x6ffffeffU, ELF_DT_RELACOUNT = 0x6ffffff9U, ELF_DT_RELCOUNT = 0x6ffffffaU, ELF_DT_FLAGS_1 = 0x6ffffffbU, ELF_DT_VERDEF = 0x6ffffffcU, ELF_DT_VERDEFNUM = 0x6ffffffdU, ELF_DT_VERNEED = 0x6fff_fffeU, ELF_DT_VERNEEDNUM = 0x6fff_ffffU; elf_config.add_enum :class "dynamic-tag-types" :entries [Elf_Config_UInt { value = ELF_DT_GNU_HASH, name = "gnu-hash" }, Elf_Config_UInt { value = ELF_DT_VERSYM, name = "versym" }, Elf_Config_UInt { value = ELF_DT_FLAGS_1, name = "flags_1" }, Elf_Config_UInt { value = ELF_DT_GNU_PRELINKED, name = "gnu-prelinked", doc = "d_val contains a time_t value giving a \ time_t value giving the UTC time at which the object was (pre)linked." }, Elf_Config_UInt { value = ELF_DT_GNU_CONFLICTSZ, name = "conflictsz", doc = "Used in prelinked objects. d_val contains \ the size of the conflict segment." }, Elf_Config_UInt { value = ELF_DT_TLSDESC_PLT, name = "tlsdesc_plt" }, Elf_Config_UInt { value = ELF_DT_TLSDESC_GOT, name = "tlsdesc_got" }, Elf_Config_UInt { value = ELF_DT_GNU_CONFLICT, name = "gnu_conflict" }, Elf_Config_UInt { value = ELF_DT_GNU_LIBLIST, name = "gnu_liblis" }, Elf_Config_UInt { value = ELF_DT_CONFIG, name = "config" }, Elf_Config_UInt { value = ELF_DT_DEPAUDIT, name = "depaudit" }, Elf_Config_UInt { value = ELF_DT_AUDIT, name = "audit" }, Elf_Config_UInt { value = ELF_DT_PLTPAD, name = "pltpad" }, Elf_Config_UInt { value = ELF_DT_MOVETAB, name = "movetab" }, Elf_Config_UInt { value = ELF_DT_SYMINFO, name = "syminfo" }, Elf_Config_UInt { value = ELF_DT_ADDRRNGHI, name = "addrrnghi" }, Elf_Config_UInt { value = ELF_DT_RELACOUNT, name = "relacount" }, Elf_Config_UInt { value = ELF_DT_RELCOUNT, name = "relcount" }, Elf_Config_UInt { value = ELF_DT_FLAGS_1, name = "flags_1" }, Elf_Config_UInt { value = ELF_DT_VERDEF, name = "verdef" }, Elf_Config_UInt { value = ELF_DT_VERNEED, name = "verneed" }, Elf_Config_UInt { value = ELF_DT_VERNEEDNUM, name = "verneednum" }]; /* Some of the tags above are between DT_HIOS and DT_LOPROC, so whether they are pointers or values has to be explicitly determined. */ apush (elf_tag_rules, Elf_Tag_Rule { tag = ELF_DT_VERSYM, is_ptr = 1 }); apush (elf_tag_rules, Elf_Tag_Rule { tag = ELF_DT_GNU_HASH, is_ptr = 1 }); apush (elf_tag_rules, Elf_Tag_Rule { tag = ELF_DT_GNU_PRELINKED, is_ptr = 0 }); apush (elf_tag_rules, Elf_Tag_Rule { tag = ELF_DT_GNU_CONFLICTSZ, is_ptr = 0 }); /* .note.ABI-tag sections contain notes that indicate the kernel type and minimum kernel version required to load this binary. */ var ELF_NT_GNU_ABI_TAG = 1; elf_config.add_enum :class "note-tags" :entries [Elf_Config_UInt { value = ELF_NT_GNU_ABI_TAG, name = "gnu-abi-tag", doc = "Kernel type and minimum kernel version. \ The note name contains the string \"GNU\". The desc field contains an \ Elf_ABI_Tag struct." }]; var ELF_GNU_ABI_TAG_LINUX = 0 as Elf_Word, ELF_GNU_ABI_TAG_HURD = 1 as Elf_Word, ELF_GNU_ABI_TAG_SOLARIS = 2 as Elf_Word, ELF_GNU_ABI_TAG_FREEBSD = 3 as Elf_Word, ELF_GNU_ABI_TAG_NETBSD = 4 as Elf_Word, ELF_GNU_ABI_TAG_SYLLABLE = 5 as Elf_Word, ELF_GNU_ABI_TAG_NACL = 6 as Elf_Word; type Elf_ABI_Tag = struct { Elf_Word kernel_type : kernel_type in [ELF_GNU_ABI_TAG_LINUX, ELF_GNU_ABI_TAG_HURD, ELF_GNU_ABI_TAG_SOLARIS, ELF_GNU_ABI_TAG_FREEBSD, ELF_GNU_ABI_TAG_NETBSD, ELF_GNU_ABI_TAG_SYLLABLE]; Elf_Word[3] kernel_version; method _print_kernel_version = void: { printf "#<%u32d.%u32d.%u32d>", kernel_version[0], kernel_version[1], kernel_version[2]; } }; /* Hardware capability notes reflect the hardware "capabilities" required by the object file. */ var ELF_NT_GNU_HWCAP = 2; elf_config.add_enum :class "note-tags" :entries [Elf_Config_UInt { value = ELF_NT_GNU_HWCAP, name = "gnu-hwcap", doc = "Hardware capabilities required by the object. \ The desc field contains an Elf_Hwcaps struct." }]; type Elf_Hwcap = struct { uint<8> testbit; string capname; }; type Elf_Hwcaps = struct { int<32> num_caps; uint<32> enabled; Elf_Hwcap[num_caps] caps; }; /* Other GNU specific notes. */ var ELF_NT_GNU_BUILD_ID = 3, ELF_NT_GNU_GOLD_VERSION = 4, ELF_NT_GNU_PROPERTY_TYPE_0 = 5; elf_config.add_enum :class "note-tags" :entries [Elf_Config_UInt { value = ELF_NT_GNU_BUILD_ID, name = "gnu-build-id", doc = "GNU build ID. Contents are not requrired to \ be printable, and is opaque." }, Elf_Config_UInt { value = ELF_NT_GNU_GOLD_VERSION, name = "gnu-gold-version", doc = "Up to descsz of printable gold version string bytes"}, Elf_Config_UInt { value = ELF_NT_GNU_PROPERTY_TYPE_0, name = "gnu-property-type-0", doc = "Program properties for the kernel to consider." }]; /* Contents of ELF_GNU_PT_GNU_Property segments/sections. If there is a program property that requires the kernel to perform some action before loading and ELF file (eg AArch64 BTI or Intel CET) then this header MUST be present. If no such features are to be enabled this header MUST NOT be present. The contents are laid out as a sequence of notes, with type NT_GNU_PROPERTY_TYPE_0 and name "GNU". The note desc contains an an array of Elf_Prop struct values. */ var ELF_GNU_PROPERTY_STACK_SIZE = 1, ELF_GNU_PROPERTY_NO_COPY_ON_PROTECTED = 2, ELF_GNU_PROPERTY_LOPROC = 0xc0000000, ELF_GNU_PROPERTY_HIPROC = 0xdfffffff, ELF_GNU_PROPERTY_LOUSER = 0xe0000000, ELF_GNU_PROPERTY_HIUSER = 0xffffffff; elf_config.add_enum :class "gnu-properties" :entries [Elf_Config_UInt { value = ELF_GNU_PROPERTY_STACK_SIZE, name = "stack-size", doc = "pr_data holds a native sized (4 bytes on 32 bit architecures, \ 8 bytes on 64 bit) integer in the target processor's native format." }, Elf_Config_UInt { value = ELF_GNU_PROPERTY_NO_COPY_ON_PROTECTED, name = "no-copy-on-protected", doc = "The linker should treat protected data symbol as defined locally at \ run-time and copy this property to the output share object." }]; type Elf_Prop = struct { Elf_Word pr_type : elf_config.check_enum ("gnu-properties", elf_mach, pr_type); offset pr_datasz; uint<8>[pr_datasz] pr_data; uint<8>[alignto (pr_datasz, 4#B)] pr_padding; method _print_pr_type = void: { printf "#<%s>", elf_config.format_enum ("gnu-properties", elf_mach, pr_type); } }; /* Symbol versioning. */ type Elf_Verneed = struct { Elf_Half vn_version; Elf_Half vn_cnt; Elf_Word vn_file; Elf_Word vn_aux; Elf_Word vn_next; }; type Elf_Vernaux = struct { Elf_Word vna_hash; Elf_Half vna_flags; Elf_Half vna_other; Elf_Word vna_name; Elf_Word vna_next; }; poke-elf-1.0/elf-os-linux.pk0000644000175000017500000000260014602057376012663 00000000000000/* elf-os-gnu.pk - ELF Linux kernel specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* The Linux ELF extensions (like notes) are specified in the include/linux/* files in the kernel source tree. */ /* ELF notes generated by the kernel. */ var ELF_NT_LINUX_VERSION_CODE = 0, ELF_NT_LINUX_BUILD_SALT = 0x100; elf_config.add_enum :class "note-tags" :entries [Elf_Config_UInt { value = ELF_NT_LINUX_VERSION_CODE, name = "linux-version-code", doc = "Unsigned 64-bit integer encoding Linux version code." }, Elf_Config_UInt { value = ELF_NT_LINUX_BUILD_SALT, name = "linux-build-salt", doc = "Arbitrary string to avoid identical vDSO debug info." }]; poke-elf-1.0/configure.ac0000644000175000017500000000341614602057677012305 00000000000000dnl configure.ac for the poke ELF pickle dnl dnl Please process this file with autoconf to get a 'configure' dnl script. dnl Copyright (C) 2024 Jose E. Marchesi dnl This program is free software: you can redistribute it and/or modify dnl it under the terms of the GNU General Public License as published by dnl the Free Software Foundation, either version 3 of the License, or dnl (at your option) any later version. dnl dnl This program is distributed in the hope that it will be useful, dnl but WITHOUT ANY WARRANTY; without even the implied warranty of dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the dnl GNU General Public License for more details. dnl dnl You should have received a copy of the GNU General Public License dnl along with this program. If not, see . AC_INIT([poke-elf], [1.0], [poke-devel@gnu.org], [poke-elf], [https://www.jemarch.net/poke-elf]) AC_CONFIG_AUX_DIR([build-aux]) AM_INIT_AUTOMAKE([foreign]) AC_REQUIRE_AUX_FILE([tap-driver.sh]) dnl Check for an installed poke, and minimum required version to test dnl this pickle. If found, it puts the absolute path in the POKE dnl variable, and AC_SUBST it. If not found, it sets POKE to :. run_pickle_tests=no PK_PROG_POKE([POKE],[4.0]) if test "x$POKE" != "x:"; then dnl pktest is also required to run the testsuite. have_pktest=no PK_CHECK_PICKLE([$POKE],[pktest.pk],[run_pickle_tests=yes]) fi AM_CONDITIONAL([RUN_TESTS], [test "x$run_pickle_tests" = "xyes"]) dnl Configure and output files. AC_CONFIG_FILES([Makefile elf-build.pk]) AC_CONFIG_FILES([test-elf.pk], [chmod +x test-elf.pk]) AC_OUTPUT dnl Emit some diagnostics at the end. if test "x$POKE" = "x:"; then AC_MSG_WARN([poke >= 3.0-dev-102 is required to run this pickle's testsuite]) fi poke-elf-1.0/test-elf.pk.in0000755000175000017500000000163714602057420012473 00000000000000#!/bin/sh exec @POKE@ --no-stdtypes -q -L "$0" "$@" !# /* test-elf.pk - Tests for the ELF poke pickle. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ load pktest; load elf; var tests = [ PkTest { name = "load elf pickle", },]; exit (pktest_run (tests) ? 0 : 1); poke-elf-1.0/build-aux/0000755000175000017500000000000014602060043011742 500000000000000poke-elf-1.0/build-aux/mdate-sh0000755000175000017500000001373214365270527013340 00000000000000#!/bin/sh # Get modification time of a file or directory and pretty-print it. scriptversion=2018-03-07.03; # UTC # Copyright (C) 1995-2020 Free Software Foundation, Inc. # written by Ulrich Drepper , June 1995 # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # As a special exception to the GNU General Public License, if you # distribute this file as part of a program that contains a # configuration script generated by Autoconf, you may include it under # the same distribution terms that you use for the rest of that program. # This file is maintained in Automake, please report # bugs to or send patches to # . if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then emulate sh NULLCMD=: # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which # is contrary to our usage. Disable this feature. alias -g '${1+"$@"}'='"$@"' setopt NO_GLOB_SUBST fi case $1 in '') echo "$0: No file. Try '$0 --help' for more information." 1>&2 exit 1; ;; -h | --h*) cat <<\EOF Usage: mdate-sh [--help] [--version] FILE Pretty-print the modification day of FILE, in the format: 1 January 1970 Report bugs to . EOF exit $? ;; -v | --v*) echo "mdate-sh $scriptversion" exit $? ;; esac error () { echo "$0: $1" >&2 exit 1 } # Prevent date giving response in another language. LANG=C export LANG LC_ALL=C export LC_ALL LC_TIME=C export LC_TIME # Use UTC to get reproducible result. TZ=UTC0 export TZ # GNU ls changes its time format in response to the TIME_STYLE # variable. Since we cannot assume 'unset' works, revert this # variable to its documented default. if test "${TIME_STYLE+set}" = set; then TIME_STYLE=posix-long-iso export TIME_STYLE fi save_arg1=$1 # Find out how to get the extended ls output of a file or directory. if ls -L /dev/null 1>/dev/null 2>&1; then ls_command='ls -L -l -d' else ls_command='ls -l -d' fi # Avoid user/group names that might have spaces, when possible. if ls -n /dev/null 1>/dev/null 2>&1; then ls_command="$ls_command -n" fi # A 'ls -l' line looks as follows on OS/2. # drwxrwx--- 0 Aug 11 2001 foo # This differs from Unix, which adds ownership information. # drwxrwx--- 2 root root 4096 Aug 11 2001 foo # # To find the date, we split the line on spaces and iterate on words # until we find a month. This cannot work with files whose owner is a # user named "Jan", or "Feb", etc. However, it's unlikely that '/' # will be owned by a user whose name is a month. So we first look at # the extended ls output of the root directory to decide how many # words should be skipped to get the date. # On HPUX /bin/sh, "set" interprets "-rw-r--r--" as options, so the "x" below. set x`$ls_command /` # Find which argument is the month. month= command= until test $month do test $# -gt 0 || error "failed parsing '$ls_command /' output" shift # Add another shift to the command. command="$command shift;" case $1 in Jan) month=January; nummonth=1;; Feb) month=February; nummonth=2;; Mar) month=March; nummonth=3;; Apr) month=April; nummonth=4;; May) month=May; nummonth=5;; Jun) month=June; nummonth=6;; Jul) month=July; nummonth=7;; Aug) month=August; nummonth=8;; Sep) month=September; nummonth=9;; Oct) month=October; nummonth=10;; Nov) month=November; nummonth=11;; Dec) month=December; nummonth=12;; esac done test -n "$month" || error "failed parsing '$ls_command /' output" # Get the extended ls output of the file or directory. set dummy x`eval "$ls_command \"\\\$save_arg1\""` # Remove all preceding arguments eval $command # Because of the dummy argument above, month is in $2. # # On a POSIX system, we should have # # $# = 5 # $1 = file size # $2 = month # $3 = day # $4 = year or time # $5 = filename # # On Darwin 7.7.0 and 7.6.0, we have # # $# = 4 # $1 = day # $2 = month # $3 = year or time # $4 = filename # Get the month. case $2 in Jan) month=January; nummonth=1;; Feb) month=February; nummonth=2;; Mar) month=March; nummonth=3;; Apr) month=April; nummonth=4;; May) month=May; nummonth=5;; Jun) month=June; nummonth=6;; Jul) month=July; nummonth=7;; Aug) month=August; nummonth=8;; Sep) month=September; nummonth=9;; Oct) month=October; nummonth=10;; Nov) month=November; nummonth=11;; Dec) month=December; nummonth=12;; esac case $3 in ???*) day=$1;; *) day=$3; shift;; esac # Here we have to deal with the problem that the ls output gives either # the time of day or the year. case $3 in *:*) set `date`; eval year=\$$# case $2 in Jan) nummonthtod=1;; Feb) nummonthtod=2;; Mar) nummonthtod=3;; Apr) nummonthtod=4;; May) nummonthtod=5;; Jun) nummonthtod=6;; Jul) nummonthtod=7;; Aug) nummonthtod=8;; Sep) nummonthtod=9;; Oct) nummonthtod=10;; Nov) nummonthtod=11;; Dec) nummonthtod=12;; esac # For the first six month of the year the time notation can also # be used for files modified in the last year. if (expr $nummonth \> $nummonthtod) > /dev/null; then year=`expr $year - 1` fi;; *) year=$3;; esac # The result. echo $day $month $year # Local Variables: # mode: shell-script # sh-indentation: 2 # eval: (add-hook 'before-save-hook 'time-stamp) # time-stamp-start: "scriptversion=" # time-stamp-format: "%:y-%02m-%02d.%02H" # time-stamp-time-zone: "UTC0" # time-stamp-end: "; # UTC" # End: poke-elf-1.0/build-aux/texinfo.tex0000644000175000017500000134723414365270527014116 00000000000000% texinfo.tex -- TeX macros to handle Texinfo files. % % Load plain if necessary, i.e., if running under initex. \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi % \def\texinfoversion{2020-10-24.12} % % Copyright 1985, 1986, 1988, 1990-2020 Free Software Foundation, Inc. % % This texinfo.tex file is free software: you can redistribute it and/or % modify it under the terms of the GNU General Public License as % published by the Free Software Foundation, either version 3 of the % License, or (at your option) any later version. % % This texinfo.tex file 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 for more details. % % You should have received a copy of the GNU General Public License % along with this program. If not, see . % % As a special exception, when this file is read by TeX when processing % a Texinfo source document, you may use the result without % restriction. This Exception is an additional permission under section 7 % of the GNU General Public License, version 3 ("GPLv3"). % % Please try the latest version of texinfo.tex before submitting bug % reports; you can get the latest version from: % https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or % https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or % https://www.gnu.org/software/texinfo/ (the Texinfo home page) % The texinfo.tex in any given distribution could well be out % of date, so if that's what you're using, please check. % % Send bug reports to bug-texinfo@gnu.org. Please include a % complete document in each bug report with which we can reproduce the % problem. Patches are, of course, greatly appreciated. % % To process a Texinfo manual with TeX, it's most reliable to use the % texi2dvi shell script that comes with the distribution. For a simple % manual foo.texi, however, you can get away with this: % tex foo.texi % texindex foo.?? % tex foo.texi % tex foo.texi % dvips foo.dvi -o # or whatever; this makes foo.ps. % The extra TeX runs get the cross-reference information correct. % Sometimes one run after texindex suffices, and sometimes you need more % than two; texi2dvi does it as many times as necessary. % % It is possible to adapt texinfo.tex for other languages, to some % extent. You can get the existing language-specific files from the % full Texinfo distribution. % % The GNU Texinfo home page is https://www.gnu.org/software/texinfo. \message{Loading texinfo [version \texinfoversion]:} % If in a .fmt file, print the version number % and turn on active characters that we couldn't do earlier because % they might have appeared in the input file name. \everyjob{\message{[Texinfo version \texinfoversion]}% \catcode`+=\active \catcode`\_=\active} % LaTeX's \typeout. This ensures that the messages it is used for % are identical in format to the corresponding ones from latex/pdflatex. \def\typeout{\immediate\write17}% \chardef\other=12 % We never want plain's \outer definition of \+ in Texinfo. % For @tex, we can use \tabalign. \let\+ = \relax % Save some plain tex macros whose names we will redefine. \let\ptexb=\b \let\ptexbullet=\bullet \let\ptexc=\c \let\ptexcomma=\, \let\ptexdot=\. \let\ptexdots=\dots \let\ptexend=\end \let\ptexequiv=\equiv \let\ptexexclam=\! \let\ptexfootnote=\footnote \let\ptexgtr=> \let\ptexhat=^ \let\ptexi=\i \let\ptexindent=\indent \let\ptexinsert=\insert \let\ptexlbrace=\{ \let\ptexless=< \let\ptexnewwrite\newwrite \let\ptexnoindent=\noindent \let\ptexplus=+ \let\ptexraggedright=\raggedright \let\ptexrbrace=\} \let\ptexslash=\/ \let\ptexsp=\sp \let\ptexstar=\* \let\ptexsup=\sup \let\ptext=\t \let\ptextop=\top {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode % If this character appears in an error message or help string, it % starts a new line in the output. \newlinechar = `^^J % Use TeX 3.0's \inputlineno to get the line number, for better error % messages, but if we're using an old version of TeX, don't do anything. % \ifx\inputlineno\thisisundefined \let\linenumber = \empty % Pre-3.0. \else \def\linenumber{l.\the\inputlineno:\space} \fi % Set up fixed words for English if not already set. \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi \ifx\putworderror\undefined \gdef\putworderror{error}\fi \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi \ifx\putwordin\undefined \gdef\putwordin{in}\fi \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi \ifx\putwordof\undefined \gdef\putwordof{of}\fi \ifx\putwordon\undefined \gdef\putwordon{on}\fi \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi % \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi % \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi % Give the space character the catcode for a space. \def\spaceisspace{\catcode`\ =10\relax} % Likewise for ^^M, the end of line character. \def\endlineisspace{\catcode13=10\relax} \chardef\dashChar = `\- \chardef\slashChar = `\/ \chardef\underChar = `\_ % Ignore a token. % \def\gobble#1{} % The following is used inside several \edef's. \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} % Hyphenation fixes. \hyphenation{ Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script ap-pen-dix bit-map bit-maps data-base data-bases eshell fall-ing half-way long-est man-u-script man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces spell-ing spell-ings stand-alone strong-est time-stamp time-stamps which-ever white-space wide-spread wrap-around } % Sometimes it is convenient to have everything in the transcript file % and nothing on the terminal. We don't just call \tracingall here, % since that produces some useless output on the terminal. We also make % some effort to order the tracing commands to reduce output in the log % file; cf. trace.sty in LaTeX. % \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% \def\loggingall{% \tracingstats2 \tracingpages1 \tracinglostchars2 % 2 gives us more in etex \tracingparagraphs1 \tracingoutput1 \tracingmacros2 \tracingrestores1 \showboxbreadth\maxdimen \showboxdepth\maxdimen \ifx\eTeXversion\thisisundefined\else % etex gives us more logging \tracingscantokens1 \tracingifs1 \tracinggroups1 \tracingnesting2 \tracingassigns1 \fi \tracingcommands3 % 3 gives us more in etex \errorcontextlines16 }% % @errormsg{MSG}. Do the index-like expansions on MSG, but if things % aren't perfect, it's not the end of the world, being an error message, % after all. % \def\errormsg{\begingroup \indexnofonts \doerrormsg} \def\doerrormsg#1{\errmessage{#1}} % add check for \lastpenalty to plain's definitions. If the last thing % we did was a \nobreak, we don't want to insert more space. % \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount \removelastskip\penalty-50\smallskip\fi\fi} \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount \removelastskip\penalty-100\medskip\fi\fi} \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount \removelastskip\penalty-200\bigskip\fi\fi} % Output routine % % For a final copy, take out the rectangles % that mark overfull boxes (in case you have decided % that the text looks ok even though it passes the margin). % \def\finalout{\overfullrule=0pt } \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines \newdimen\topandbottommargin \topandbottommargin=.75in % Output a mark which sets \thischapter, \thissection and \thiscolor. % We dump everything together because we only have one kind of mark. % This works because we only use \botmark / \topmark, not \firstmark. % % A mark contains a subexpression of the \ifcase ... \fi construct. % \get*marks macros below extract the needed part using \ifcase. % % Another complication is to let the user choose whether \thischapter % (\thissection) refers to the chapter (section) in effect at the top % of a page, or that at the bottom of a page. % \domark is called twice inside \chapmacro, to add one % mark before the section break, and one after. % In the second call \prevchapterdefs is the same as \currentchapterdefs, % and \prevsectiondefs is the same as \currentsectiondefs. % Then if the page is not broken at the mark, some of the previous % section appears on the page, and we can get the name of this section % from \firstmark for @everyheadingmarks top. % @everyheadingmarks bottom uses \botmark. % % See page 260 of The TeXbook. \def\domark{% \toks0=\expandafter{\currentchapterdefs}% \toks2=\expandafter{\currentsectiondefs}% \toks4=\expandafter{\prevchapterdefs}% \toks6=\expandafter{\prevsectiondefs}% \toks8=\expandafter{\currentcolordefs}% \mark{% \the\toks0 \the\toks2 % 0: marks for @everyheadingmarks top \noexpand\or \the\toks4 \the\toks6 % 1: for @everyheadingmarks bottom \noexpand\else \the\toks8 % 2: color marks }% } % \gettopheadingmarks, \getbottomheadingmarks, % \getcolormarks - extract needed part of mark. % % \topmark doesn't work for the very first chapter (after the title % page or the contents), so we use \firstmark there -- this gets us % the mark with the chapter defs, unless the user sneaks in, e.g., % @setcolor (or @url, or @link, etc.) between @contents and the very % first @chapter. \def\gettopheadingmarks{% \ifcase0\the\savedtopmark\fi \ifx\thischapter\empty \ifcase0\firstmark\fi \fi } \def\getbottomheadingmarks{\ifcase1\botmark\fi} \def\getcolormarks{\ifcase2\the\savedtopmark\fi} % Avoid "undefined control sequence" errors. \def\currentchapterdefs{} \def\currentsectiondefs{} \def\currentsection{} \def\prevchapterdefs{} \def\prevsectiondefs{} \def\currentcolordefs{} % Margin to add to right of even pages, to left of odd pages. \newdimen\bindingoffset \newdimen\normaloffset \newdimen\txipagewidth \newdimen\txipageheight % Main output routine. % \chardef\PAGE = 255 \newtoks\defaultoutput \defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}} \output=\expandafter{\the\defaultoutput} \newbox\headlinebox \newbox\footlinebox % When outputting the double column layout for indices, an output routine % is run several times, which hides the original value of \topmark. This % can lead to a page heading being output and duplicating the chapter heading % of the index. Hence, save the contents of \topmark at the beginning of % the output routine. The saved contents are valid until we actually % \shipout a page. % % (We used to run a short output routine to actually set \topmark and % \firstmark to the right values, but if this was called with an empty page % containing whatsits for writing index entries, the whatsits would be thrown % away and the index auxiliary file would remain empty.) % \newtoks\savedtopmark \newif\iftopmarksaved \topmarksavedtrue \def\savetopmark{% \iftopmarksaved\else \global\savedtopmark=\expandafter{\topmark}% \global\topmarksavedtrue \fi } % \onepageout takes a vbox as an argument. % \shipout a vbox for a single page, adding an optional header, footer % and footnote. This also causes index entries for this page to be written % to the auxiliary files. % \def\onepageout#1{% \hoffset=\normaloffset % \ifodd\pageno \advance\hoffset by \bindingoffset \else \advance\hoffset by -\bindingoffset\fi % \checkchapterpage % % Retrieve the information for the headings from the marks in the page, % and call Plain TeX's \makeheadline and \makefootline, which use the % values in \headline and \footline. % % Common context changes for both heading and footing. % Do this outside of the \shipout so @code etc. will be expanded in % the headline as they should be, not taken literally (outputting ''code). \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars} % \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}% \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}% % {% % Set context for writing to auxiliary files like index files. % Have to do this stuff outside the \shipout because we want it to % take effect in \write's, yet the group defined by the \vbox ends % before the \shipout runs. % \atdummies % don't expand commands in the output. \turnoffactive \shipout\vbox{% % Do this early so pdf references go to the beginning of the page. \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi % \unvbox\headlinebox \pagebody{#1}% \ifdim\ht\footlinebox > 0pt % Only leave this space if the footline is nonempty. % (We lessened \vsize for it in \oddfootingyyy.) % The \baselineskip=24pt in plain's \makefootline has no effect. \vskip 24pt \unvbox\footlinebox \fi % }% }% \global\topmarksavedfalse \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi } \newinsert\margin \dimen\margin=\maxdimen % Main part of page, including any footnotes \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}} {\catcode`\@ =11 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi % marginal hacks, juha@viisa.uucp (Juha Takala) \ifvoid\margin\else % marginal info is present \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi \dimen@=\dp#1\relax \unvbox#1\relax \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi \ifr@ggedbottom \kern-\dimen@ \vfil \fi} } % Check if we are on the first page of a chapter. Used for printing headings. \newif\ifchapterpage \def\checkchapterpage{% % Get the chapter that was current at the end of the last page \ifcase1\the\savedtopmark\fi \let\prevchaptername\thischaptername % \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi \let\curchaptername\thischaptername % \ifx\curchaptername\prevchaptername \chapterpagefalse \else \chapterpagetrue \fi } % Argument parsing % Parse an argument, then pass it to #1. The argument is the rest of % the input line (except we remove a trailing comment). #1 should be a % macro which expects an ordinary undelimited TeX argument. % For example, \def\foo{\parsearg\fooxxx}. % \def\parsearg{\parseargusing{}} \def\parseargusing#1#2{% \def\argtorun{#2}% \begingroup \obeylines \spaceisspace #1% \parseargline\empty% Insert the \empty token, see \finishparsearg below. } {\obeylines % \gdef\parseargline#1^^M{% \endgroup % End of the group started in \parsearg. \argremovecomment #1\comment\ArgTerm% }% } % First remove any @comment, then any @c comment. Pass the result on to % \argcheckspaces. \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} % Each occurrence of `\^^M' or `\^^M' is replaced by a single space. % % \argremovec might leave us with trailing space, e.g., % @end itemize @c foo % This space token undergoes the same procedure and is eventually removed % by \finishparsearg. % \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% \def\temp{#3}% \ifx\temp\empty % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: \let\temp\finishparsearg \else \let\temp\argcheckspaces \fi % Put the space token in: \temp#1 #3\ArgTerm } % If a _delimited_ argument is enclosed in braces, they get stripped; so % to get _exactly_ the rest of the line, we had to prevent such situation. % We prepended an \empty token at the very beginning and we expand it now, % just before passing the control to \argtorun. % (Similarly, we have to think about #3 of \argcheckspacesY above: it is % either the null string, or it ends with \^^M---thus there is no danger % that a pair of braces would be stripped. % % But first, we have to remove the trailing space token. % \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} % \parseargdef - define a command taking an argument on the line % % \parseargdef\foo{...} % is roughly equivalent to % \def\foo{\parsearg\Xfoo} % \def\Xfoo#1{...} \def\parseargdef#1{% \expandafter \doparseargdef \csname\string#1\endcsname #1% } \def\doparseargdef#1#2{% \def#2{\parsearg#1}% \def#1##1% } % Several utility definitions with active space: { \obeyspaces \gdef\obeyedspace{ } % Make each space character in the input produce a normal interword % space in the output. Don't allow a line break at this space, as this % is used only in environments like @example, where each line of input % should produce a line of output anyway. % \gdef\sepspaces{\obeyspaces\let =\tie} % If an index command is used in an @example environment, any spaces % therein should become regular spaces in the raw index file, not the % expansion of \tie (\leavevmode \penalty \@M \ ). \gdef\unsepspaces{\let =\space} } \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} % Define the framework for environments in texinfo.tex. It's used like this: % % \envdef\foo{...} % \def\Efoo{...} % % It's the responsibility of \envdef to insert \begingroup before the % actual body; @end closes the group after calling \Efoo. \envdef also % defines \thisenv, so the current environment is known; @end checks % whether the environment name matches. The \checkenv macro can also be % used to check whether the current environment is the one expected. % % Non-false conditionals (@iftex, @ifset) don't fit into this, so they % are not treated as environments; they don't open a group. (The % implementation of @end takes care not to call \endgroup in this % special case.) % At run-time, environments start with this: \def\startenvironment#1{\begingroup\def\thisenv{#1}} % initialize \let\thisenv\empty % ... but they get defined via ``\envdef\foo{...}'': \long\def\envdef#1#2{\def#1{\startenvironment#1#2}} \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} % Check whether we're in the right environment: \def\checkenv#1{% \def\temp{#1}% \ifx\thisenv\temp \else \badenverr \fi } % Environment mismatch, #1 expected: \def\badenverr{% \errhelp = \EMsimple \errmessage{This command can appear only \inenvironment\temp, not \inenvironment\thisenv}% } \def\inenvironment#1{% \ifx#1\empty outside of any environment% \else in environment \expandafter\string#1% \fi } % @end foo executes the definition of \Efoo. % But first, it executes a specialized version of \checkenv % \parseargdef\end{% \if 1\csname iscond.#1\endcsname \else % The general wording of \badenverr may not be ideal. \expandafter\checkenv\csname#1\endcsname \csname E#1\endcsname \endgroup \fi } \newhelp\EMsimple{Press RETURN to continue.} % Be sure we're in horizontal mode when doing a tie, since we make space % equivalent to this in @example-like environments. Otherwise, a space % at the beginning of a line will start with \penalty -- and % since \penalty is valid in vertical mode, we'd end up putting the % penalty on the vertical list instead of in the new paragraph. {\catcode`@ = 11 % Avoid using \@M directly, because that causes trouble % if the definition is written into an index file. \global\let\tiepenalty = \@M \gdef\tie{\leavevmode\penalty\tiepenalty\ } } % @: forces normal size whitespace following. \def\:{\spacefactor=1000 } % @* forces a line break. \def\*{\unskip\hfil\break\hbox{}\ignorespaces} % @/ allows a line break. \let\/=\allowbreak % @. is an end-of-sentence period. \def\.{.\spacefactor=\endofsentencespacefactor\space} % @! is an end-of-sentence bang. \def\!{!\spacefactor=\endofsentencespacefactor\space} % @? is an end-of-sentence query. \def\?{?\spacefactor=\endofsentencespacefactor\space} % @frenchspacing on|off says whether to put extra space after punctuation. % \def\onword{on} \def\offword{off} % \parseargdef\frenchspacing{% \def\temp{#1}% \ifx\temp\onword \plainfrenchspacing \else\ifx\temp\offword \plainnonfrenchspacing \else \errhelp = \EMsimple \errmessage{Unknown @frenchspacing option `\temp', must be on|off}% \fi\fi } % @w prevents a word break. Without the \leavevmode, @w at the % beginning of a paragraph, when TeX is still in vertical mode, would % produce a whole line of output instead of starting the paragraph. \def\w#1{\leavevmode\hbox{#1}} % @group ... @end group forces ... to be all on one page, by enclosing % it in a TeX vbox. We use \vtop instead of \vbox to construct the box % to keep its height that of a normal line. According to the rules for % \topskip (p.114 of the TeXbook), the glue inserted is % max (\topskip - \ht (first item), 0). If that height is large, % therefore, no glue is inserted, and the space between the headline and % the text is small, which looks bad. % % Another complication is that the group might be very large. This can % cause the glue on the previous page to be unduly stretched, because it % does not have much material. In this case, it's better to add an % explicit \vfill so that the extra space is at the bottom. The % threshold for doing this is if the group is more than \vfilllimit % percent of a page (\vfilllimit can be changed inside of @tex). % \newbox\groupbox \def\vfilllimit{0.7} % \envdef\group{% \ifnum\catcode`\^^M=\active \else \errhelp = \groupinvalidhelp \errmessage{@group invalid in context where filling is enabled}% \fi \startsavinginserts % \setbox\groupbox = \vtop\bgroup % Do @comment since we are called inside an environment such as % @example, where each end-of-line in the input causes an % end-of-line in the output. We don't want the end-of-line after % the `@group' to put extra space in the output. Since @group % should appear on a line by itself (according to the Texinfo % manual), we don't worry about eating any user text. \comment } % % The \vtop produces a box with normal height and large depth; thus, TeX puts % \baselineskip glue before it, and (when the next line of text is done) % \lineskip glue after it. Thus, space below is not quite equal to space % above. But it's pretty close. \def\Egroup{% % To get correct interline space between the last line of the group % and the first line afterwards, we have to propagate \prevdepth. \endgraf % Not \par, as it may have been set to \lisppar. \global\dimen1 = \prevdepth \egroup % End the \vtop. \addgroupbox \prevdepth = \dimen1 \checkinserts } \def\addgroupbox{ % \dimen0 is the vertical size of the group's box. \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox % \dimen2 is how much space is left on the page (more or less). \dimen2 = \txipageheight \advance\dimen2 by -\pagetotal % if the group doesn't fit on the current page, and it's a big big % group, force a page break. \ifdim \dimen0 > \dimen2 \ifdim \pagetotal < \vfilllimit\txipageheight \page \fi \fi \box\groupbox } % % TeX puts in an \escapechar (i.e., `@') at the beginning of the help % message, so this ends up printing `@group can only ...'. % \newhelp\groupinvalidhelp{% group can only be used in environments such as @example,^^J% where each line of input produces a line of output.} % @need space-in-mils % forces a page break if there is not space-in-mils remaining. \newdimen\mil \mil=0.001in \parseargdef\need{% % Ensure vertical mode, so we don't make a big box in the middle of a % paragraph. \par % % If the @need value is less than one line space, it's useless. \dimen0 = #1\mil \dimen2 = \ht\strutbox \advance\dimen2 by \dp\strutbox \ifdim\dimen0 > \dimen2 % % Do a \strut just to make the height of this box be normal, so the % normal leading is inserted relative to the preceding line. % And a page break here is fine. \vtop to #1\mil{\strut\vfil}% % % TeX does not even consider page breaks if a penalty added to the % main vertical list is 10000 or more. But in order to see if the % empty box we just added fits on the page, we must make it consider % page breaks. On the other hand, we don't want to actually break the % page after the empty box. So we use a penalty of 9999. % % There is an extremely small chance that TeX will actually break the % page at this \penalty, if there are no other feasible breakpoints in % sight. (If the user is using lots of big @group commands, which % almost-but-not-quite fill up a page, TeX will have a hard time doing % good page breaking, for example.) However, I could not construct an % example where a page broke at this \penalty; if it happens in a real % document, then we can reconsider our strategy. \penalty9999 % % Back up by the size of the box, whether we did a page break or not. \kern -#1\mil % % Do not allow a page break right after this kern. \nobreak \fi } % @br forces paragraph break (and is undocumented). \let\br = \par % @page forces the start of a new page. % \def\page{\par\vfill\supereject} % @exdent text.... % outputs text on separate line in roman font, starting at standard page margin % This records the amount of indent in the innermost environment. % That's how much \exdent should take out. \newskip\exdentamount % This defn is used inside fill environments such as @defun. \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} % This defn is used inside nofill environments such as @example. \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount \leftline{\hskip\leftskip{\rm#1}}}} % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current % paragraph. For more general purposes, use the \margin insertion % class. WHICH is `l' or `r'. Not documented, written for gawk manual. % \newskip\inmarginspacing \inmarginspacing=1cm \def\strutdepth{\dp\strutbox} % \def\doinmargin#1#2{\strut\vadjust{% \nobreak \kern-\strutdepth \vtop to \strutdepth{% \baselineskip=\strutdepth \vss % if you have multiple lines of stuff to put here, you'll need to % make the vbox yourself of the appropriate size. \ifx#1l% \llap{\ignorespaces #2\hskip\inmarginspacing}% \else \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% \fi \null }% }} \def\inleftmargin{\doinmargin l} \def\inrightmargin{\doinmargin r} % % @inmargin{TEXT [, RIGHT-TEXT]} % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; % else use TEXT for both). % \def\inmargin#1{\parseinmargin #1,,\finish} \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. \setbox0 = \hbox{\ignorespaces #2}% \ifdim\wd0 > 0pt \def\lefttext{#1}% have both texts \def\righttext{#2}% \else \def\lefttext{#1}% have only one text \def\righttext{#1}% \fi % \ifodd\pageno \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin \else \def\temp{\inleftmargin\lefttext}% \fi \temp } % @include FILE -- \input text of FILE. % \def\include{\parseargusing\filenamecatcodes\includezzz} \def\includezzz#1{% \pushthisfilestack \def\thisfile{#1}% {% \makevalueexpandable % we want to expand any @value in FILE. \turnoffactive % and allow special characters in the expansion \indexnofonts % Allow `@@' and other weird things in file names. \wlog{texinfo.tex: doing @include of #1^^J}% \edef\temp{\noexpand\input #1 }% % % This trickery is to read FILE outside of a group, in case it makes % definitions, etc. \expandafter }\temp \popthisfilestack } \def\filenamecatcodes{% \catcode`\\=\other \catcode`~=\other \catcode`^=\other \catcode`_=\other \catcode`|=\other \catcode`<=\other \catcode`>=\other \catcode`+=\other \catcode`-=\other \catcode`\`=\other \catcode`\'=\other } \def\pushthisfilestack{% \expandafter\pushthisfilestackX\popthisfilestack\StackTerm } \def\pushthisfilestackX{% \expandafter\pushthisfilestackY\thisfile\StackTerm } \def\pushthisfilestackY #1\StackTerm #2\StackTerm {% \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% } \def\popthisfilestack{\errthisfilestackempty} \def\errthisfilestackempty{\errmessage{Internal error: the stack of filenames is empty.}} % \def\thisfile{} % @center line % outputs that line, centered. % \parseargdef\center{% \ifhmode \let\centersub\centerH \else \let\centersub\centerV \fi \centersub{\hfil \ignorespaces#1\unskip \hfil}% \let\centersub\relax % don't let the definition persist, just in case } \def\centerH#1{{% \hfil\break \advance\hsize by -\leftskip \advance\hsize by -\rightskip \line{#1}% \break }} % \newcount\centerpenalty \def\centerV#1{% % The idea here is the same as in \startdefun, \cartouche, etc.: if % @center is the first thing after a section heading, we need to wipe % out the negative parskip inserted by \sectionheading, but still % prevent a page break here. \centerpenalty = \lastpenalty \ifnum\centerpenalty>10000 \vskip\parskip \fi \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi \line{\kern\leftskip #1\kern\rightskip}% } % @sp n outputs n lines of vertical space % \parseargdef\sp{\vskip #1\baselineskip} % @comment ...line which is ignored... % @c is the same as @comment % @ignore ... @end ignore is another way to write a comment \def\c{\begingroup \catcode`\^^M=\active% \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% \cxxx} {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}} % \let\comment\c % @paragraphindent NCHARS % We'll use ems for NCHARS, close enough. % NCHARS can also be the word `asis' or `none'. % We cannot feasibly implement @paragraphindent asis, though. % \def\asisword{asis} % no translation, these are keywords \def\noneword{none} % \parseargdef\paragraphindent{% \def\temp{#1}% \ifx\temp\asisword \else \ifx\temp\noneword \defaultparindent = 0pt \else \defaultparindent = #1em \fi \fi \parindent = \defaultparindent } % @exampleindent NCHARS % We'll use ems for NCHARS like @paragraphindent. % It seems @exampleindent asis isn't necessary, but % I preserve it to make it similar to @paragraphindent. \parseargdef\exampleindent{% \def\temp{#1}% \ifx\temp\asisword \else \ifx\temp\noneword \lispnarrowing = 0pt \else \lispnarrowing = #1em \fi \fi } % @firstparagraphindent WORD % If WORD is `none', then suppress indentation of the first paragraph % after a section heading. If WORD is `insert', then do indent at such % paragraphs. % % The paragraph indentation is suppressed or not by calling % \suppressfirstparagraphindent, which the sectioning commands do. % We switch the definition of this back and forth according to WORD. % By default, we suppress indentation. % \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} \def\insertword{insert} % \parseargdef\firstparagraphindent{% \def\temp{#1}% \ifx\temp\noneword \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent \else\ifx\temp\insertword \let\suppressfirstparagraphindent = \relax \else \errhelp = \EMsimple \errmessage{Unknown @firstparagraphindent option `\temp'}% \fi\fi } % Here is how we actually suppress indentation. Redefine \everypar to % \kern backwards by \parindent, and then reset itself to empty. % % We also make \indent itself not actually do anything until the next % paragraph. % \gdef\dosuppressfirstparagraphindent{% \gdef\indent {\restorefirstparagraphindent \indent}% \gdef\noindent{\restorefirstparagraphindent \noindent}% \global\everypar = {\kern -\parindent \restorefirstparagraphindent}% } % \gdef\restorefirstparagraphindent{% \global\let\indent = \ptexindent \global\let\noindent = \ptexnoindent \global\everypar = {}% } % @refill is a no-op. \let\refill=\relax % @setfilename INFO-FILENAME - ignored \let\setfilename=\comment % @bye. \outer\def\bye{\chappager\pagelabels\tracingstats=1\ptexend} \message{pdf,} % adobe `portable' document format \newcount\tempnum \newcount\lnkcount \newtoks\filename \newcount\filenamelength \newcount\pgn \newtoks\toksA \newtoks\toksB \newtoks\toksC \newtoks\toksD \newbox\boxA \newbox\boxB \newcount\countA \newif\ifpdf \newif\ifpdfmakepagedest % % For LuaTeX % \newif\iftxiuseunicodedestname \txiuseunicodedestnamefalse % For pdfTeX etc. \ifx\luatexversion\thisisundefined \else % Use Unicode destination names \txiuseunicodedestnametrue % Escape PDF strings with converting UTF-16 from UTF-8 \begingroup \catcode`\%=12 \directlua{ function UTF16oct(str) tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377') for c in string.utfvalues(str) do if c < 0x10000 then tex.sprint( string.format(string.char(0x5c) .. string.char(0x25) .. '03o' .. string.char(0x5c) .. string.char(0x25) .. '03o', math.floor(c / 256), math.floor(c % 256))) else c = c - 0x10000 local c_hi = c / 1024 + 0xd800 local c_lo = c % 1024 + 0xdc00 tex.sprint( string.format(string.char(0x5c) .. string.char(0x25) .. '03o' .. string.char(0x5c) .. string.char(0x25) .. '03o' .. string.char(0x5c) .. string.char(0x25) .. '03o' .. string.char(0x5c) .. string.char(0x25) .. '03o', math.floor(c_hi / 256), math.floor(c_hi % 256), math.floor(c_lo / 256), math.floor(c_lo % 256))) end end end } \endgroup \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}} % Escape PDF strings without converting \begingroup \directlua{ function PDFescstr(str) for c in string.bytes(str) do if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then tex.sprint(-2, string.format(string.char(0x5c) .. string.char(0x25) .. '03o', c)) else tex.sprint(-2, string.char(c)) end end end } % The -2 in the arguments here gives all the input to TeX catcode 12 % (other) or 10 (space), preventing undefined control sequence errors. See % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html % \endgroup \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}} \ifnum\luatexversion>84 % For LuaTeX >= 0.85 \def\pdfdest{\pdfextension dest} \let\pdfoutput\outputmode \def\pdfliteral{\pdfextension literal} \def\pdfcatalog{\pdfextension catalog} \def\pdftexversion{\numexpr\pdffeedback version\relax} \let\pdfximage\saveimageresource \let\pdfrefximage\useimageresource \let\pdflastximage\lastsavedimageresourceindex \def\pdfendlink{\pdfextension endlink\relax} \def\pdfoutline{\pdfextension outline} \def\pdfstartlink{\pdfextension startlink} \def\pdffontattr{\pdfextension fontattr} \def\pdfobj{\pdfextension obj} \def\pdflastobj{\numexpr\pdffeedback lastobj\relax} \let\pdfpagewidth\pagewidth \let\pdfpageheight\pageheight \edef\pdfhorigin{\pdfvariable horigin} \edef\pdfvorigin{\pdfvariable vorigin} \fi \fi % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 % can be set). So we test for \relax and 0 as well as being undefined. \ifx\pdfoutput\thisisundefined \else \ifx\pdfoutput\relax \else \ifcase\pdfoutput \else \pdftrue \fi \fi \fi \newif\ifpdforxetex \pdforxetexfalse \ifpdf \pdforxetextrue \fi \ifx\XeTeXrevision\thisisundefined\else \pdforxetextrue \fi % Output page labels information. % See PDF reference v.1.7 p.594, section 8.3.1. \ifpdf \def\pagelabels{% \def\title{0 << /P (T-) /S /D >>}% \edef\roman{\the\romancount << /S /r >>}% \edef\arabic{\the\arabiccount << /S /D >>}% % % Page label ranges must be increasing. Remove any duplicates. % (There is a slight chance of this being wrong if e.g. there is % a @contents but no @titlepage, etc.) % \ifnum\romancount=0 \def\roman{}\fi \ifnum\arabiccount=0 \def\title{}% \else \ifnum\romancount=\arabiccount \def\roman{}\fi \fi % \ifnum\romancount<\arabiccount \pdfcatalog{/PageLabels << /Nums [\title \roman \arabic ] >> }\relax \else \pdfcatalog{/PageLabels << /Nums [\title \arabic \roman ] >> }\relax \fi } \else \let\pagelabels\relax \fi \newcount\pagecount \pagecount=0 \newcount\romancount \romancount=0 \newcount\arabiccount \arabiccount=0 \ifpdf \let\ptxadvancepageno\advancepageno \def\advancepageno{% \ptxadvancepageno\global\advance\pagecount by 1 } \fi % PDF uses PostScript string constants for the names of xref targets, % for display in the outlines, and in other places. Thus, we have to % double any backslashes. Otherwise, a name like "\node" will be % interpreted as a newline (\n), followed by o, d, e. Not good. % % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and % related messages. The final outcome is that it is up to the TeX user % to double the backslashes and otherwise make the string valid, so % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to % do this reliably, so we use it. % #1 is a control sequence in which to do the replacements, % which we \xdef. \def\txiescapepdf#1{% \ifx\pdfescapestring\thisisundefined % No primitive available; should we give a warning or log? % Many times it won't matter. \xdef#1{#1}% \else % The expandable \pdfescapestring primitive escapes parentheses, % backslashes, and other special chars. \xdef#1{\pdfescapestring{#1}}% \fi } \def\txiescapepdfutfsixteen#1{% \ifx\pdfescapestrutfsixteen\thisisundefined % No UTF-16 converting macro available. \txiescapepdf{#1}% \else \xdef#1{\pdfescapestrutfsixteen{#1}}% \fi } \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images with PDF output, and none of those formats could be found. (.eps cannot be supported due to the design of the PDF format; use regular TeX (DVI output) for that.)} \ifpdf % % Color manipulation macros using ideas from pdfcolor.tex, % except using rgb instead of cmyk; the latter is said to render as a % very dark gray on-screen and a very dark halftone in print, instead % of actual black. The dark red here is dark enough to print on paper as % nearly black, but still distinguishable for online viewing. We use % black by default, though. \def\rgbDarkRed{0.50 0.09 0.12} \def\rgbBlack{0 0 0} % % rg sets the color for filling (usual text, etc.); % RG sets the color for stroking (thin rules, e.g., normal _'s). \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}} % % Set color, and create a mark which defines \thiscolor accordingly, % so that \makeheadline knows which color to restore. \def\setcolor#1{% \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}% \domark \pdfsetcolor{#1}% } % \def\maincolor{\rgbBlack} \pdfsetcolor{\maincolor} \edef\thiscolor{\maincolor} \def\currentcolordefs{} % \def\makefootline{% \baselineskip24pt \line{\pdfsetcolor{\maincolor}\the\footline}% } % \def\makeheadline{% \vbox to 0pt{% \vskip-22.5pt \line{% \vbox to8.5pt{}% % Extract \thiscolor definition from the marks. \getcolormarks % Typeset the headline with \maincolor, then restore the color. \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}% }% \vss }% \nointerlineskip } % % \pdfcatalog{/PageMode /UseOutlines} % % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). \def\dopdfimage#1#2#3{% \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% % % pdftex (and the PDF format) support .pdf, .png, .jpg (among % others). Let's try in that order, PDF first since if % someone has a scalable image, presumably better to use that than a % bitmap. \let\pdfimgext=\empty \begingroup \openin 1 #1.pdf \ifeof 1 \openin 1 #1.PDF \ifeof 1 \openin 1 #1.png \ifeof 1 \openin 1 #1.jpg \ifeof 1 \openin 1 #1.jpeg \ifeof 1 \openin 1 #1.JPG \ifeof 1 \errhelp = \nopdfimagehelp \errmessage{Could not find image file #1 for pdf}% \else \gdef\pdfimgext{JPG}% \fi \else \gdef\pdfimgext{jpeg}% \fi \else \gdef\pdfimgext{jpg}% \fi \else \gdef\pdfimgext{png}% \fi \else \gdef\pdfimgext{PDF}% \fi \else \gdef\pdfimgext{pdf}% \fi \closein 1 \endgroup % % without \immediate, ancient pdftex seg faults when the same image is % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) \ifnum\pdftexversion < 14 \immediate\pdfimage \else \immediate\pdfximage \fi \ifdim \wd0 >0pt width \pdfimagewidth \fi \ifdim \wd2 >0pt height \pdfimageheight \fi \ifnum\pdftexversion<13 #1.\pdfimgext \else {#1.\pdfimgext}% \fi \ifnum\pdftexversion < 14 \else \pdfrefximage \pdflastximage \fi} % \def\setpdfdestname#1{{% % We have to set dummies so commands such as @code, and characters % such as \, aren't expanded when present in a section title. \indexnofonts \makevalueexpandable \turnoffactive \iftxiuseunicodedestname \ifx \declaredencoding \latone % Pass through Latin-1 characters. % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode. \else \ifx \declaredencoding \utfeight % Pass through Unicode characters. \else % Use ASCII approximations in destination names. \passthroughcharsfalse \fi \fi \else % Use ASCII approximations in destination names. \passthroughcharsfalse \fi \def\pdfdestname{#1}% \txiescapepdf\pdfdestname }} % \def\setpdfoutlinetext#1{{% \indexnofonts \makevalueexpandable \turnoffactive \ifx \declaredencoding \latone % The PDF format can use an extended form of Latin-1 in bookmark % strings. See Appendix D of the PDF Reference, Sixth Edition, for % the "PDFDocEncoding". \passthroughcharstrue % Pass through Latin-1 characters. % LuaTeX: Convert to Unicode % pdfTeX: Use Latin-1 as PDFDocEncoding \def\pdfoutlinetext{#1}% \else \ifx \declaredencoding \utfeight \ifx\luatexversion\thisisundefined % For pdfTeX with UTF-8. % TODO: the PDF format can use UTF-16 in bookmark strings, % but the code for this isn't done yet. % Use ASCII approximations. \passthroughcharsfalse \def\pdfoutlinetext{#1}% \else % For LuaTeX with UTF-8. % Pass through Unicode characters for title texts. \passthroughcharstrue \def\pdfoutlinetext{#1}% \fi \else % For non-Latin-1 or non-UTF-8 encodings. % Use ASCII approximations. \passthroughcharsfalse \def\pdfoutlinetext{#1}% \fi \fi % LuaTeX: Convert to UTF-16 % pdfTeX: Use Latin-1 as PDFDocEncoding \txiescapepdfutfsixteen\pdfoutlinetext }} % \def\pdfmkdest#1{% \setpdfdestname{#1}% \safewhatsit{\pdfdest name{\pdfdestname} xyz}% } % % used to mark target names; must be expandable. \def\pdfmkpgn#1{#1} % % by default, use black for everything. \def\urlcolor{\rgbBlack} \def\linkcolor{\rgbBlack} \def\endlink{\setcolor{\maincolor}\pdfendlink} % % Adding outlines to PDF; macros for calculating structure of outlines % come from Petr Olsak \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% \else \csname#1\endcsname \fi} \def\advancenumber#1{\tempnum=\expnumber{#1}\relax \advance\tempnum by 1 \expandafter\xdef\csname#1\endcsname{\the\tempnum}} % % #1 is the section text, which is what will be displayed in the % outline by the pdf viewer. #2 is the pdf expression for the number % of subentries (or empty, for subsubsections). #3 is the node text, % which might be empty if this toc entry had no corresponding node. % #4 is the page number % \def\dopdfoutline#1#2#3#4{% % Generate a link to the node text if that exists; else, use the % page number. We could generate a destination for the section % text in the case where a section has no node, but it doesn't % seem worth the trouble, since most documents are normally structured. \setpdfoutlinetext{#1} \setpdfdestname{#3} \ifx\pdfdestname\empty \def\pdfdestname{#4}% \fi % \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}% } % \def\pdfmakeoutlines{% \begingroup % Read toc silently, to get counts of subentries for \pdfoutline. \def\partentry##1##2##3##4{}% ignore parts in the outlines \def\numchapentry##1##2##3##4{% \def\thischapnum{##2}% \def\thissecnum{0}% \def\thissubsecnum{0}% }% \def\numsecentry##1##2##3##4{% \advancenumber{chap\thischapnum}% \def\thissecnum{##2}% \def\thissubsecnum{0}% }% \def\numsubsecentry##1##2##3##4{% \advancenumber{sec\thissecnum}% \def\thissubsecnum{##2}% }% \def\numsubsubsecentry##1##2##3##4{% \advancenumber{subsec\thissubsecnum}% }% \def\thischapnum{0}% \def\thissecnum{0}% \def\thissubsecnum{0}% % % use \def rather than \let here because we redefine \chapentry et % al. a second time, below. \def\appentry{\numchapentry}% \def\appsecentry{\numsecentry}% \def\appsubsecentry{\numsubsecentry}% \def\appsubsubsecentry{\numsubsubsecentry}% \def\unnchapentry{\numchapentry}% \def\unnsecentry{\numsecentry}% \def\unnsubsecentry{\numsubsecentry}% \def\unnsubsubsecentry{\numsubsubsecentry}% \readdatafile{toc}% % % Read toc second time, this time actually producing the outlines. % The `-' means take the \expnumber as the absolute number of % subentries, which we calculated on our first read of the .toc above. % % We use the node names as the destinations. % % Currently we prefix the section name with the section number % for chapter and appendix headings only in order to avoid too much % horizontal space being required in the PDF viewer. \def\numchapentry##1##2##3##4{% \dopdfoutline{##2 ##1}{count-\expnumber{chap##2}}{##3}{##4}}% \def\unnchapentry##1##2##3##4{% \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% \def\numsecentry##1##2##3##4{% \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% \def\numsubsecentry##1##2##3##4{% \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% \def\numsubsubsecentry##1##2##3##4{% count is always zero \dopdfoutline{##1}{}{##3}{##4}}% % % PDF outlines are displayed using system fonts, instead of % document fonts. Therefore we cannot use special characters, % since the encoding is unknown. For example, the eogonek from % Latin 2 (0xea) gets translated to a | character. Info from % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. % % TODO this right, we have to translate 8-bit characters to % their "best" equivalent, based on the @documentencoding. Too % much work for too little return. Just use the ASCII equivalents % we use for the index sort strings. % \indexnofonts \setupdatafile % We can have normal brace characters in the PDF outlines, unlike % Texinfo index files. So set that up. \def\{{\lbracecharliteral}% \def\}{\rbracecharliteral}% \catcode`\\=\active \otherbackslash \input \tocreadfilename \endgroup } {\catcode`[=1 \catcode`]=2 \catcode`{=\other \catcode`}=\other \gdef\lbracecharliteral[{]% \gdef\rbracecharliteral[}]% ] % \def\skipspaces#1{\def\PP{#1}\def\D{|}% \ifx\PP\D\let\nextsp\relax \else\let\nextsp\skipspaces \addtokens{\filename}{\PP}% \advance\filenamelength by 1 \fi \nextsp} \def\getfilename#1{% \filenamelength=0 % If we don't expand the argument now, \skipspaces will get % snagged on things like "@value{foo}". \edef\temp{#1}% \expandafter\skipspaces\temp|\relax } \ifnum\pdftexversion < 14 \let \startlink \pdfannotlink \else \let \startlink \pdfstartlink \fi % make a live url in pdf output. \def\pdfurl#1{% \begingroup % it seems we really need yet another set of dummies; have not % tried to figure out what each command should do in the context % of @url. for now, just make @/ a no-op, that's the only one % people have actually reported a problem with. % \normalturnoffactive \def\@{@}% \let\/=\empty \makevalueexpandable % do we want to go so far as to use \indexnofonts instead of just % special-casing \var here? \def\var##1{##1}% % \leavevmode\setcolor{\urlcolor}% \startlink attr{/Border [0 0 0]}% user{/Subtype /Link /A << /S /URI /URI (#1) >>}% \endgroup} % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may % be a simple number, or a list of numbers in the case of an index % entry. \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} \def\maketoks{% \expandafter\poptoks\the\toksA|ENDTOKS|\relax \ifx\first0\adn0 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 \else \ifnum0=\countA\else\makelink\fi \ifx\first.\let\next=\done\else \let\next=\maketoks \addtokens{\toksB}{\the\toksD} \ifx\first,\addtokens{\toksB}{\space}\fi \fi \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi \next} \def\makelink{\addtokens{\toksB}% {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} \def\pdflink#1{% \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} \setcolor{\linkcolor}#1\endlink} \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} \else % non-pdf mode \let\pdfmkdest = \gobble \let\pdfurl = \gobble \let\endlink = \relax \let\setcolor = \gobble \let\pdfsetcolor = \gobble \let\pdfmakeoutlines = \relax \fi % \ifx\pdfoutput % % For XeTeX % \ifx\XeTeXrevision\thisisundefined \else % % XeTeX version check % \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1 % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307. % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941). % For avoiding PDF destination name replacement, we use this special % instead of xdvipdfmx's command line option `-C 0x0010'. \special{dvipdfmx:config C 0x0010} % XeTeX 0.99995+ comes with xdvipdfmx 20160307+. % It can handle Unicode destination names for PDF. \txiuseunicodedestnametrue \else % XeTeX < 0.99996 (TeX Live < 2016) cannot use the % `dvipdfmx:config' special. % So for avoiding PDF destination name replacement, % xdvipdfmx's command line option `-C 0x0010' is necessary. % % XeTeX < 0.99995 can not handle Unicode destination names for PDF % because xdvipdfmx 20150315 has a UTF-16 conversion issue. % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753). \txiuseunicodedestnamefalse \fi % % Color support % \def\rgbDarkRed{0.50 0.09 0.12} \def\rgbBlack{0 0 0} % \def\pdfsetcolor#1{\special{pdf:scolor [#1]}} % % Set color, and create a mark which defines \thiscolor accordingly, % so that \makeheadline knows which color to restore. \def\setcolor#1{% \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}% \domark \pdfsetcolor{#1}% } % \def\maincolor{\rgbBlack} \pdfsetcolor{\maincolor} \edef\thiscolor{\maincolor} \def\currentcolordefs{} % \def\makefootline{% \baselineskip24pt \line{\pdfsetcolor{\maincolor}\the\footline}% } % \def\makeheadline{% \vbox to 0pt{% \vskip-22.5pt \line{% \vbox to8.5pt{}% % Extract \thiscolor definition from the marks. \getcolormarks % Typeset the headline with \maincolor, then restore the color. \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}% }% \vss }% \nointerlineskip } % % PDF outline support % % Emulate pdfTeX primitive \def\pdfdest name#1 xyz{% \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}% } % \def\setpdfdestname#1{{% % We have to set dummies so commands such as @code, and characters % such as \, aren't expanded when present in a section title. \indexnofonts \makevalueexpandable \turnoffactive \iftxiuseunicodedestname % Pass through Unicode characters. \else % Use ASCII approximations in destination names. \passthroughcharsfalse \fi \def\pdfdestname{#1}% \txiescapepdf\pdfdestname }} % \def\setpdfoutlinetext#1{{% \turnoffactive % Always use Unicode characters in title texts. \def\pdfoutlinetext{#1}% % For XeTeX, xdvipdfmx converts to UTF-16. % So we do not convert. \txiescapepdf\pdfoutlinetext }} % \def\pdfmkdest#1{% \setpdfdestname{#1}% \safewhatsit{\pdfdest name{\pdfdestname} xyz}% } % % by default, use black for everything. \def\urlcolor{\rgbBlack} \def\linkcolor{\rgbBlack} \def\endlink{\setcolor{\maincolor}\pdfendlink} % \def\dopdfoutline#1#2#3#4{% \setpdfoutlinetext{#1} \setpdfdestname{#3} \ifx\pdfdestname\empty \def\pdfdestname{#4}% \fi % \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A << /S /GoTo /D (\pdfdestname) >> >> }% } % \def\pdfmakeoutlines{% \begingroup % % For XeTeX, counts of subentries are not necessary. % Therefore, we read toc only once. % % We use node names as destinations. % % Currently we prefix the section name with the section number % for chapter and appendix headings only in order to avoid too much % horizontal space being required in the PDF viewer. \def\partentry##1##2##3##4{}% ignore parts in the outlines \def\numchapentry##1##2##3##4{% \dopdfoutline{##2 ##1}{1}{##3}{##4}}% \def\numsecentry##1##2##3##4{% \dopdfoutline{##1}{2}{##3}{##4}}% \def\numsubsecentry##1##2##3##4{% \dopdfoutline{##1}{3}{##3}{##4}}% \def\numsubsubsecentry##1##2##3##4{% \dopdfoutline{##1}{4}{##3}{##4}}% % \let\appentry\numchapentry% \let\appsecentry\numsecentry% \let\appsubsecentry\numsubsecentry% \let\appsubsubsecentry\numsubsubsecentry% \def\unnchapentry##1##2##3##4{% \dopdfoutline{##1}{1}{##3}{##4}}% \let\unnsecentry\numsecentry% \let\unnsubsecentry\numsubsecentry% \let\unnsubsubsecentry\numsubsubsecentry% % % For XeTeX, xdvipdfmx converts strings to UTF-16. % Therefore, the encoding and the language may not be considered. % \indexnofonts \setupdatafile % We can have normal brace characters in the PDF outlines, unlike % Texinfo index files. So set that up. \def\{{\lbracecharliteral}% \def\}{\rbracecharliteral}% \catcode`\\=\active \otherbackslash \input \tocreadfilename \endgroup } {\catcode`[=1 \catcode`]=2 \catcode`{=\other \catcode`}=\other \gdef\lbracecharliteral[{]% \gdef\rbracecharliteral[}]% ] \special{pdf:docview << /PageMode /UseOutlines >> } % ``\special{pdf:tounicode ...}'' is not necessary % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it. % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315, % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings. % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753). % \def\skipspaces#1{\def\PP{#1}\def\D{|}% \ifx\PP\D\let\nextsp\relax \else\let\nextsp\skipspaces \addtokens{\filename}{\PP}% \advance\filenamelength by 1 \fi \nextsp} \def\getfilename#1{% \filenamelength=0 % If we don't expand the argument now, \skipspaces will get % snagged on things like "@value{foo}". \edef\temp{#1}% \expandafter\skipspaces\temp|\relax } % make a live url in pdf output. \def\pdfurl#1{% \begingroup % it seems we really need yet another set of dummies; have not % tried to figure out what each command should do in the context % of @url. for now, just make @/ a no-op, that's the only one % people have actually reported a problem with. % \normalturnoffactive \def\@{@}% \let\/=\empty \makevalueexpandable % do we want to go so far as to use \indexnofonts instead of just % special-casing \var here? \def\var##1{##1}% % \leavevmode\setcolor{\urlcolor}% \special{pdf:bann << /Border [0 0 0] /Subtype /Link /A << /S /URI /URI (#1) >> >>}% \endgroup} \def\endlink{\setcolor{\maincolor}\special{pdf:eann}} \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} \def\maketoks{% \expandafter\poptoks\the\toksA|ENDTOKS|\relax \ifx\first0\adn0 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 \else \ifnum0=\countA\else\makelink\fi \ifx\first.\let\next=\done\else \let\next=\maketoks \addtokens{\toksB}{\the\toksD} \ifx\first,\addtokens{\toksB}{\space}\fi \fi \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi \next} \def\makelink{\addtokens{\toksB}% {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} \def\pdflink#1{% \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}% \setcolor{\linkcolor}#1\endlink} \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} % % % @image support % % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). \def\doxeteximage#1#2#3{% \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% % % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among % others). Let's try in that order, PDF first since if % someone has a scalable image, presumably better to use that than a % bitmap. \let\xeteximgext=\empty \begingroup \openin 1 #1.pdf \ifeof 1 \openin 1 #1.PDF \ifeof 1 \openin 1 #1.png \ifeof 1 \openin 1 #1.jpg \ifeof 1 \openin 1 #1.jpeg \ifeof 1 \openin 1 #1.JPG \ifeof 1 \errmessage{Could not find image file #1 for XeTeX}% \else \gdef\xeteximgext{JPG}% \fi \else \gdef\xeteximgext{jpeg}% \fi \else \gdef\xeteximgext{jpg}% \fi \else \gdef\xeteximgext{png}% \fi \else \gdef\xeteximgext{PDF}% \fi \else \gdef\xeteximgext{pdf}% \fi \closein 1 \endgroup % \def\xetexpdfext{pdf}% \ifx\xeteximgext\xetexpdfext \XeTeXpdffile "#1".\xeteximgext "" \else \def\xetexpdfext{PDF}% \ifx\xeteximgext\xetexpdfext \XeTeXpdffile "#1".\xeteximgext "" \else \XeTeXpicfile "#1".\xeteximgext "" \fi \fi \ifdim \wd0 >0pt width \xeteximagewidth \fi \ifdim \wd2 >0pt height \xeteximageheight \fi \relax } \fi % \message{fonts,} % Set the baselineskip to #1, and the lineskip and strut size % correspondingly. There is no deep meaning behind these magic numbers % used as factors; they just match (closely enough) what Knuth defined. % \def\lineskipfactor{.08333} \def\strutheightpercent{.70833} \def\strutdepthpercent {.29167} % % can get a sort of poor man's double spacing by redefining this. \def\baselinefactor{1} % \newdimen\textleading \def\setleading#1{% \dimen0 = #1\relax \normalbaselineskip = \baselinefactor\dimen0 \normallineskip = \lineskipfactor\normalbaselineskip \normalbaselines \setbox\strutbox =\hbox{% \vrule width0pt height\strutheightpercent\baselineskip depth \strutdepthpercent \baselineskip }% } % PDF CMaps. See also LaTeX's t1.cmap. % % do nothing with this by default. \expandafter\let\csname cmapOT1\endcsname\gobble \expandafter\let\csname cmapOT1IT\endcsname\gobble \expandafter\let\csname cmapOT1TT\endcsname\gobble % if we are producing pdf, and we have \pdffontattr, then define cmaps. % (\pdffontattr was introduced many years ago, but people still run % older pdftex's; it's easy to conditionalize, so we do.) \ifpdf \ifx\pdffontattr\thisisundefined \else \begingroup \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap %%DocumentNeededResources: ProcSet (CIDInit) %%IncludeResource: ProcSet (CIDInit) %%BeginResource: CMap (TeX-OT1-0) %%Title: (TeX-OT1-0 TeX OT1 0) %%Version: 1.000 %%EndComments /CIDInit /ProcSet findresource begin 12 dict begin begincmap /CIDSystemInfo << /Registry (TeX) /Ordering (OT1) /Supplement 0 >> def /CMapName /TeX-OT1-0 def /CMapType 2 def 1 begincodespacerange <00> <7F> endcodespacerange 8 beginbfrange <00> <01> <0393> <09> <0A> <03A8> <23> <26> <0023> <28> <3B> <0028> <3F> <5B> <003F> <5D> <5E> <005D> <61> <7A> <0061> <7B> <7C> <2013> endbfrange 40 beginbfchar <02> <0398> <03> <039B> <04> <039E> <05> <03A0> <06> <03A3> <07> <03D2> <08> <03A6> <0B> <00660066> <0C> <00660069> <0D> <0066006C> <0E> <006600660069> <0F> <00660066006C> <10> <0131> <11> <0237> <12> <0060> <13> <00B4> <14> <02C7> <15> <02D8> <16> <00AF> <17> <02DA> <18> <00B8> <19> <00DF> <1A> <00E6> <1B> <0153> <1C> <00F8> <1D> <00C6> <1E> <0152> <1F> <00D8> <21> <0021> <22> <201D> <27> <2019> <3C> <00A1> <3D> <003D> <3E> <00BF> <5C> <201C> <5F> <02D9> <60> <2018> <7D> <02DD> <7E> <007E> <7F> <00A8> endbfchar endcmap CMapName currentdict /CMap defineresource pop end end %%EndResource %%EOF }\endgroup \expandafter\edef\csname cmapOT1\endcsname#1{% \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% }% % % \cmapOT1IT \begingroup \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap %%DocumentNeededResources: ProcSet (CIDInit) %%IncludeResource: ProcSet (CIDInit) %%BeginResource: CMap (TeX-OT1IT-0) %%Title: (TeX-OT1IT-0 TeX OT1IT 0) %%Version: 1.000 %%EndComments /CIDInit /ProcSet findresource begin 12 dict begin begincmap /CIDSystemInfo << /Registry (TeX) /Ordering (OT1IT) /Supplement 0 >> def /CMapName /TeX-OT1IT-0 def /CMapType 2 def 1 begincodespacerange <00> <7F> endcodespacerange 8 beginbfrange <00> <01> <0393> <09> <0A> <03A8> <25> <26> <0025> <28> <3B> <0028> <3F> <5B> <003F> <5D> <5E> <005D> <61> <7A> <0061> <7B> <7C> <2013> endbfrange 42 beginbfchar <02> <0398> <03> <039B> <04> <039E> <05> <03A0> <06> <03A3> <07> <03D2> <08> <03A6> <0B> <00660066> <0C> <00660069> <0D> <0066006C> <0E> <006600660069> <0F> <00660066006C> <10> <0131> <11> <0237> <12> <0060> <13> <00B4> <14> <02C7> <15> <02D8> <16> <00AF> <17> <02DA> <18> <00B8> <19> <00DF> <1A> <00E6> <1B> <0153> <1C> <00F8> <1D> <00C6> <1E> <0152> <1F> <00D8> <21> <0021> <22> <201D> <23> <0023> <24> <00A3> <27> <2019> <3C> <00A1> <3D> <003D> <3E> <00BF> <5C> <201C> <5F> <02D9> <60> <2018> <7D> <02DD> <7E> <007E> <7F> <00A8> endbfchar endcmap CMapName currentdict /CMap defineresource pop end end %%EndResource %%EOF }\endgroup \expandafter\edef\csname cmapOT1IT\endcsname#1{% \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% }% % % \cmapOT1TT \begingroup \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap %%DocumentNeededResources: ProcSet (CIDInit) %%IncludeResource: ProcSet (CIDInit) %%BeginResource: CMap (TeX-OT1TT-0) %%Title: (TeX-OT1TT-0 TeX OT1TT 0) %%Version: 1.000 %%EndComments /CIDInit /ProcSet findresource begin 12 dict begin begincmap /CIDSystemInfo << /Registry (TeX) /Ordering (OT1TT) /Supplement 0 >> def /CMapName /TeX-OT1TT-0 def /CMapType 2 def 1 begincodespacerange <00> <7F> endcodespacerange 5 beginbfrange <00> <01> <0393> <09> <0A> <03A8> <21> <26> <0021> <28> <5F> <0028> <61> <7E> <0061> endbfrange 32 beginbfchar <02> <0398> <03> <039B> <04> <039E> <05> <03A0> <06> <03A3> <07> <03D2> <08> <03A6> <0B> <2191> <0C> <2193> <0D> <0027> <0E> <00A1> <0F> <00BF> <10> <0131> <11> <0237> <12> <0060> <13> <00B4> <14> <02C7> <15> <02D8> <16> <00AF> <17> <02DA> <18> <00B8> <19> <00DF> <1A> <00E6> <1B> <0153> <1C> <00F8> <1D> <00C6> <1E> <0152> <1F> <00D8> <20> <2423> <27> <2019> <60> <2018> <7F> <00A8> endbfchar endcmap CMapName currentdict /CMap defineresource pop end end %%EndResource %%EOF }\endgroup \expandafter\edef\csname cmapOT1TT\endcsname#1{% \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}% }% \fi\fi % Set the font macro #1 to the font named \fontprefix#2. % #3 is the font's design size, #4 is a scale factor, #5 is the CMap % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit). % Example: % #1 = \textrm % #2 = \rmshape % #3 = 10 % #4 = \mainmagstep % #5 = OT1 % \def\setfont#1#2#3#4#5{% \font#1=\fontprefix#2#3 scaled #4 \csname cmap#5\endcsname#1% } % This is what gets called when #5 of \setfont is empty. \let\cmap\gobble % % (end of cmaps) % Use cm as the default font prefix. % To specify the font prefix, you must define \fontprefix % before you read in texinfo.tex. \ifx\fontprefix\thisisundefined \def\fontprefix{cm} \fi % Support font families that don't use the same naming scheme as CM. \def\rmshape{r} \def\rmbshape{bx} % where the normal face is bold \def\bfshape{b} \def\bxshape{bx} \def\ttshape{tt} \def\ttbshape{tt} \def\ttslshape{sltt} \def\itshape{ti} \def\itbshape{bxti} \def\slshape{sl} \def\slbshape{bxsl} \def\sfshape{ss} \def\sfbshape{ss} \def\scshape{csc} \def\scbshape{csc} % Definitions for a main text size of 11pt. (The default in Texinfo.) % \def\definetextfontsizexi{% % Text fonts (11.2pt, magstep1). \def\textnominalsize{11pt} \edef\mainmagstep{\magstephalf} \setfont\textrm\rmshape{10}{\mainmagstep}{OT1} \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} \setfont\textbf\bfshape{10}{\mainmagstep}{OT1} \setfont\textit\itshape{10}{\mainmagstep}{OT1IT} \setfont\textsl\slshape{10}{\mainmagstep}{OT1} \setfont\textsf\sfshape{10}{\mainmagstep}{OT1} \setfont\textsc\scshape{10}{\mainmagstep}{OT1} \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} \font\texti=cmmi10 scaled \mainmagstep \font\textsy=cmsy10 scaled \mainmagstep \def\textecsize{1095} % A few fonts for @defun names and args. \setfont\defbf\bfshape{10}{\magstep1}{OT1} \setfont\deftt\ttshape{10}{\magstep1}{OT1TT} \setfont\defsl\slshape{10}{\magstep1}{OT1} \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT} \def\df{\let\ttfont=\deftt \let\bffont = \defbf \let\ttslfont=\defttsl \let\slfont=\defsl \bf} % Fonts for indices, footnotes, small examples (9pt). \def\smallnominalsize{9pt} \setfont\smallrm\rmshape{9}{1000}{OT1} \setfont\smalltt\ttshape{9}{1000}{OT1TT} \setfont\smallbf\bfshape{10}{900}{OT1} \setfont\smallit\itshape{9}{1000}{OT1IT} \setfont\smallsl\slshape{9}{1000}{OT1} \setfont\smallsf\sfshape{9}{1000}{OT1} \setfont\smallsc\scshape{10}{900}{OT1} \setfont\smallttsl\ttslshape{10}{900}{OT1TT} \font\smalli=cmmi9 \font\smallsy=cmsy9 \def\smallecsize{0900} % Fonts for small examples (8pt). \def\smallernominalsize{8pt} \setfont\smallerrm\rmshape{8}{1000}{OT1} \setfont\smallertt\ttshape{8}{1000}{OT1TT} \setfont\smallerbf\bfshape{10}{800}{OT1} \setfont\smallerit\itshape{8}{1000}{OT1IT} \setfont\smallersl\slshape{8}{1000}{OT1} \setfont\smallersf\sfshape{8}{1000}{OT1} \setfont\smallersc\scshape{10}{800}{OT1} \setfont\smallerttsl\ttslshape{10}{800}{OT1TT} \font\smalleri=cmmi8 \font\smallersy=cmsy8 \def\smallerecsize{0800} % Fonts for math mode superscripts (7pt). \def\sevennominalsize{7pt} \setfont\sevenrm\rmshape{7}{1000}{OT1} \setfont\seventt\ttshape{10}{700}{OT1TT} \setfont\sevenbf\bfshape{10}{700}{OT1} \setfont\sevenit\itshape{7}{1000}{OT1IT} \setfont\sevensl\slshape{10}{700}{OT1} \setfont\sevensf\sfshape{10}{700}{OT1} \setfont\sevensc\scshape{10}{700}{OT1} \setfont\seventtsl\ttslshape{10}{700}{OT1TT} \font\seveni=cmmi7 \font\sevensy=cmsy7 \def\sevenecsize{0700} % Fonts for title page (20.4pt): \def\titlenominalsize{20pt} \setfont\titlerm\rmbshape{12}{\magstep3}{OT1} \setfont\titleit\itbshape{10}{\magstep4}{OT1IT} \setfont\titlesl\slbshape{10}{\magstep4}{OT1} \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} \setfont\titlesf\sfbshape{17}{\magstep1}{OT1} \let\titlebf=\titlerm \setfont\titlesc\scbshape{10}{\magstep4}{OT1} \font\titlei=cmmi12 scaled \magstep3 \font\titlesy=cmsy10 scaled \magstep4 \def\titleecsize{2074} % Chapter (and unnumbered) fonts (17.28pt). \def\chapnominalsize{17pt} \setfont\chaprm\rmbshape{12}{\magstep2}{OT1} \setfont\chapit\itbshape{10}{\magstep3}{OT1IT} \setfont\chapsl\slbshape{10}{\magstep3}{OT1} \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT} \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT} \setfont\chapsf\sfbshape{17}{1000}{OT1} \let\chapbf=\chaprm \setfont\chapsc\scbshape{10}{\magstep3}{OT1} \font\chapi=cmmi12 scaled \magstep2 \font\chapsy=cmsy10 scaled \magstep3 \def\chapecsize{1728} % Section fonts (14.4pt). \def\secnominalsize{14pt} \setfont\secrm\rmbshape{12}{\magstep1}{OT1} \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1} \setfont\secit\itbshape{10}{\magstep2}{OT1IT} \setfont\secsl\slbshape{10}{\magstep2}{OT1} \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT} \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT} \setfont\secsf\sfbshape{12}{\magstep1}{OT1} \let\secbf\secrm \setfont\secsc\scbshape{10}{\magstep2}{OT1} \font\seci=cmmi12 scaled \magstep1 \font\secsy=cmsy10 scaled \magstep2 \def\sececsize{1440} % Subsection fonts (13.15pt). \def\ssecnominalsize{13pt} \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1} \setfont\ssecit\itbshape{10}{1315}{OT1IT} \setfont\ssecsl\slbshape{10}{1315}{OT1} \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT} \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT} \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1} \let\ssecbf\ssecrm \setfont\ssecsc\scbshape{10}{1315}{OT1} \font\sseci=cmmi12 scaled \magstephalf \font\ssecsy=cmsy10 scaled 1315 \def\ssececsize{1200} % Reduced fonts for @acronym in text (10pt). \def\reducednominalsize{10pt} \setfont\reducedrm\rmshape{10}{1000}{OT1} \setfont\reducedtt\ttshape{10}{1000}{OT1TT} \setfont\reducedbf\bfshape{10}{1000}{OT1} \setfont\reducedit\itshape{10}{1000}{OT1IT} \setfont\reducedsl\slshape{10}{1000}{OT1} \setfont\reducedsf\sfshape{10}{1000}{OT1} \setfont\reducedsc\scshape{10}{1000}{OT1} \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT} \font\reducedi=cmmi10 \font\reducedsy=cmsy10 \def\reducedecsize{1000} \textleading = 13.2pt % line spacing for 11pt CM \textfonts % reset the current fonts \rm } % end of 11pt text font size definitions, \definetextfontsizexi % Definitions to make the main text be 10pt Computer Modern, with % section, chapter, etc., sizes following suit. This is for the GNU % Press printing of the Emacs 22 manual. Maybe other manuals in the % future. Used with @smallbook, which sets the leading to 12pt. % \def\definetextfontsizex{% % Text fonts (10pt). \def\textnominalsize{10pt} \edef\mainmagstep{1000} \setfont\textrm\rmshape{10}{\mainmagstep}{OT1} \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT} \setfont\textbf\bfshape{10}{\mainmagstep}{OT1} \setfont\textit\itshape{10}{\mainmagstep}{OT1IT} \setfont\textsl\slshape{10}{\mainmagstep}{OT1} \setfont\textsf\sfshape{10}{\mainmagstep}{OT1} \setfont\textsc\scshape{10}{\mainmagstep}{OT1} \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT} \font\texti=cmmi10 scaled \mainmagstep \font\textsy=cmsy10 scaled \mainmagstep \def\textecsize{1000} % A few fonts for @defun names and args. \setfont\defbf\bfshape{10}{\magstephalf}{OT1} \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT} \setfont\defsl\slshape{10}{\magstephalf}{OT1} \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT} \def\df{\let\ttfont=\deftt \let\bffont = \defbf \let\slfont=\defsl \let\ttslfont=\defttsl \bf} % Fonts for indices, footnotes, small examples (9pt). \def\smallnominalsize{9pt} \setfont\smallrm\rmshape{9}{1000}{OT1} \setfont\smalltt\ttshape{9}{1000}{OT1TT} \setfont\smallbf\bfshape{10}{900}{OT1} \setfont\smallit\itshape{9}{1000}{OT1IT} \setfont\smallsl\slshape{9}{1000}{OT1} \setfont\smallsf\sfshape{9}{1000}{OT1} \setfont\smallsc\scshape{10}{900}{OT1} \setfont\smallttsl\ttslshape{10}{900}{OT1TT} \font\smalli=cmmi9 \font\smallsy=cmsy9 \def\smallecsize{0900} % Fonts for small examples (8pt). \def\smallernominalsize{8pt} \setfont\smallerrm\rmshape{8}{1000}{OT1} \setfont\smallertt\ttshape{8}{1000}{OT1TT} \setfont\smallerbf\bfshape{10}{800}{OT1} \setfont\smallerit\itshape{8}{1000}{OT1IT} \setfont\smallersl\slshape{8}{1000}{OT1} \setfont\smallersf\sfshape{8}{1000}{OT1} \setfont\smallersc\scshape{10}{800}{OT1} \setfont\smallerttsl\ttslshape{10}{800}{OT1TT} \font\smalleri=cmmi8 \font\smallersy=cmsy8 \def\smallerecsize{0800} % Fonts for math mode superscripts (7pt). \def\sevennominalsize{7pt} \setfont\sevenrm\rmshape{7}{1000}{OT1} \setfont\seventt\ttshape{10}{700}{OT1TT} \setfont\sevenbf\bfshape{10}{700}{OT1} \setfont\sevenit\itshape{7}{1000}{OT1IT} \setfont\sevensl\slshape{10}{700}{OT1} \setfont\sevensf\sfshape{10}{700}{OT1} \setfont\sevensc\scshape{10}{700}{OT1} \setfont\seventtsl\ttslshape{10}{700}{OT1TT} \font\seveni=cmmi7 \font\sevensy=cmsy7 \def\sevenecsize{0700} % Fonts for title page (20.4pt): \def\titlenominalsize{20pt} \setfont\titlerm\rmbshape{12}{\magstep3}{OT1} \setfont\titleit\itbshape{10}{\magstep4}{OT1IT} \setfont\titlesl\slbshape{10}{\magstep4}{OT1} \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT} \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT} \setfont\titlesf\sfbshape{17}{\magstep1}{OT1} \let\titlebf=\titlerm \setfont\titlesc\scbshape{10}{\magstep4}{OT1} \font\titlei=cmmi12 scaled \magstep3 \font\titlesy=cmsy10 scaled \magstep4 \def\titleecsize{2074} % Chapter fonts (14.4pt). \def\chapnominalsize{14pt} \setfont\chaprm\rmbshape{12}{\magstep1}{OT1} \setfont\chapit\itbshape{10}{\magstep2}{OT1IT} \setfont\chapsl\slbshape{10}{\magstep2}{OT1} \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT} \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT} \setfont\chapsf\sfbshape{12}{\magstep1}{OT1} \let\chapbf\chaprm \setfont\chapsc\scbshape{10}{\magstep2}{OT1} \font\chapi=cmmi12 scaled \magstep1 \font\chapsy=cmsy10 scaled \magstep2 \def\chapecsize{1440} % Section fonts (12pt). \def\secnominalsize{12pt} \setfont\secrm\rmbshape{12}{1000}{OT1} \setfont\secit\itbshape{10}{\magstep1}{OT1IT} \setfont\secsl\slbshape{10}{\magstep1}{OT1} \setfont\sectt\ttbshape{12}{1000}{OT1TT} \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT} \setfont\secsf\sfbshape{12}{1000}{OT1} \let\secbf\secrm \setfont\secsc\scbshape{10}{\magstep1}{OT1} \font\seci=cmmi12 \font\secsy=cmsy10 scaled \magstep1 \def\sececsize{1200} % Subsection fonts (10pt). \def\ssecnominalsize{10pt} \setfont\ssecrm\rmbshape{10}{1000}{OT1} \setfont\ssecit\itbshape{10}{1000}{OT1IT} \setfont\ssecsl\slbshape{10}{1000}{OT1} \setfont\ssectt\ttbshape{10}{1000}{OT1TT} \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT} \setfont\ssecsf\sfbshape{10}{1000}{OT1} \let\ssecbf\ssecrm \setfont\ssecsc\scbshape{10}{1000}{OT1} \font\sseci=cmmi10 \font\ssecsy=cmsy10 \def\ssececsize{1000} % Reduced fonts for @acronym in text (9pt). \def\reducednominalsize{9pt} \setfont\reducedrm\rmshape{9}{1000}{OT1} \setfont\reducedtt\ttshape{9}{1000}{OT1TT} \setfont\reducedbf\bfshape{10}{900}{OT1} \setfont\reducedit\itshape{9}{1000}{OT1IT} \setfont\reducedsl\slshape{9}{1000}{OT1} \setfont\reducedsf\sfshape{9}{1000}{OT1} \setfont\reducedsc\scshape{10}{900}{OT1} \setfont\reducedttsl\ttslshape{10}{900}{OT1TT} \font\reducedi=cmmi9 \font\reducedsy=cmsy9 \def\reducedecsize{0900} \divide\parskip by 2 % reduce space between paragraphs \textleading = 12pt % line spacing for 10pt CM \textfonts % reset the current fonts \rm } % end of 10pt text font size definitions, \definetextfontsizex % Fonts for short table of contents. \setfont\shortcontrm\rmshape{12}{1000}{OT1} \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12 \setfont\shortcontsl\slshape{12}{1000}{OT1} \setfont\shortconttt\ttshape{12}{1000}{OT1TT} % We provide the user-level command % @fonttextsize 10 % (or 11) to redefine the text font size. pt is assumed. % \def\xiword{11} \def\xword{10} \def\xwordpt{10pt} % \parseargdef\fonttextsize{% \def\textsizearg{#1}% %\wlog{doing @fonttextsize \textsizearg}% % % Set \globaldefs so that documents can use this inside @tex, since % makeinfo 4.8 does not support it, but we need it nonetheless. % \begingroup \globaldefs=1 \ifx\textsizearg\xword \definetextfontsizex \else \ifx\textsizearg\xiword \definetextfontsizexi \else \errhelp=\EMsimple \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} \fi\fi \endgroup } % % Change the current font style to #1, remembering it in \curfontstyle. % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in % italics, not bold italics. % \def\setfontstyle#1{% \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. \csname #1font\endcsname % change the current font } \def\rm{\fam=0 \setfontstyle{rm}} \def\it{\fam=\itfam \setfontstyle{it}} \def\sl{\fam=\slfam \setfontstyle{sl}} \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} \def\tt{\fam=\ttfam \setfontstyle{tt}}\def\ttstylename{tt} % Texinfo sort of supports the sans serif font style, which plain TeX does not. % So we set up a \sf. \newfam\sffam \def\sf{\fam=\sffam \setfontstyle{sf}} % We don't need math for this font style. \def\ttsl{\setfontstyle{ttsl}} % In order for the font changes to affect most math symbols and letters, % we have to define the \textfont of the standard families. % We don't bother to reset \scriptscriptfont; awaiting user need. % \def\resetmathfonts{% \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont \textfont\ttfam=\ttfont \textfont\sffam=\sffont % % Fonts for superscript. Note that the 7pt fonts are used regardless % of the current font size. \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt \scriptfont\sffam=\sevensf } % % The font-changing commands (all called \...fonts) redefine the meanings % of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs % to also set the current \fam for math mode. Our \STYLE (e.g., \rm) % commands hardwire \STYLEfont to set the current font. % % The fonts used for \ifont are for "math italics" (\itfont is for italics % in regular text). \syfont is also used in math mode only. % % Each font-changing command also sets the names \lsize (one size lower) % and \lllsize (three sizes lower). These relative commands are used % in, e.g., the LaTeX logo and acronyms. % % This all needs generalizing, badly. % \def\assignfonts#1{% \expandafter\let\expandafter\rmfont\csname #1rm\endcsname \expandafter\let\expandafter\itfont\csname #1it\endcsname \expandafter\let\expandafter\slfont\csname #1sl\endcsname \expandafter\let\expandafter\bffont\csname #1bf\endcsname \expandafter\let\expandafter\ttfont\csname #1tt\endcsname \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname \expandafter\let\expandafter\sffont \csname #1sf\endcsname \expandafter\let\expandafter\ifont \csname #1i\endcsname \expandafter\let\expandafter\syfont \csname #1sy\endcsname \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname } \newif\ifrmisbold % Select smaller font size with the current style. Used to change font size % in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for % normal roman text, also use bold fonts for roman text in the smaller size. \def\switchtolllsize{% \expandafter\assignfonts\expandafter{\lllsize}% \ifrmisbold \let\rmfont\bffont \fi \csname\curfontstyle\endcsname }% \def\switchtolsize{% \expandafter\assignfonts\expandafter{\lsize}% \ifrmisbold \let\rmfont\bffont \fi \csname\curfontstyle\endcsname }% \def\definefontsetatsize#1#2#3#4#5{% \expandafter\def\csname #1fonts\endcsname{% \def\curfontsize{#1}% \def\lsize{#2}\def\lllsize{#3}% \csname rmisbold#5\endcsname \assignfonts{#1}% \resetmathfonts \setleading{#4}% }} \definefontsetatsize{text} {reduced}{smaller}{\textleading}{false} \definefontsetatsize{title} {chap} {subsec} {27pt} {true} \definefontsetatsize{chap} {sec} {text} {19pt} {true} \definefontsetatsize{sec} {subsec} {reduced}{17pt} {true} \definefontsetatsize{ssec} {text} {small} {15pt} {true} \definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false} \definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false} \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false} \def\titlefont#1{{\titlefonts\rm #1}} \let\subsecfonts = \ssecfonts \let\subsubsecfonts = \ssecfonts % Define these just so they can be easily changed for other fonts. \def\angleleft{$\langle$} \def\angleright{$\rangle$} % Set the fonts to use with the @small... environments. \let\smallexamplefonts = \smallfonts % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample % can fit this many characters: % 8.5x11=86 smallbook=72 a4=90 a5=69 % If we use \scriptfonts (8pt), then we can fit this many characters: % 8.5x11=90+ smallbook=80 a4=90+ a5=77 % For me, subjectively, the few extra characters that fit aren't worth % the additional smallness of 8pt. So I'm making the default 9pt. % % By the way, for comparison, here's what fits with @example (10pt): % 8.5x11=71 smallbook=60 a4=75 a5=58 % --karl, 24jan03. % Set up the default fonts, so we can use them for creating boxes. % \definetextfontsizexi \message{markup,} % Check if we are currently using a typewriter font. Since all the % Computer Modern typewriter fonts have zero interword stretch (and % shrink), and it is reasonable to expect all typewriter fonts to have % this property, we can check that font parameter. % \def\ifmonospace{\ifdim\fontdimen3\font=0pt } % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will % define and register \INITMACRO to be called on markup style changes. % \INITMACRO can check \currentmarkupstyle for the innermost % style. \let\currentmarkupstyle\empty \def\setupmarkupstyle#1{% \def\currentmarkupstyle{#1}% \markupstylesetup } \let\markupstylesetup\empty \def\defmarkupstylesetup#1{% \expandafter\def\expandafter\markupstylesetup \expandafter{\markupstylesetup #1}% \def#1% } % Markup style setup for left and right quotes. \defmarkupstylesetup\markupsetuplq{% \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname \ifx\temp\relax \markupsetuplqdefault \else \temp \fi } \defmarkupstylesetup\markupsetuprq{% \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname \ifx\temp\relax \markupsetuprqdefault \else \temp \fi } { \catcode`\'=\active \catcode`\`=\active \gdef\markupsetuplqdefault{\let`\lq} \gdef\markupsetuprqdefault{\let'\rq} \gdef\markupsetcodequoteleft{\let`\codequoteleft} \gdef\markupsetcodequoteright{\let'\codequoteright} } \let\markupsetuplqcode \markupsetcodequoteleft \let\markupsetuprqcode \markupsetcodequoteright % \let\markupsetuplqexample \markupsetcodequoteleft \let\markupsetuprqexample \markupsetcodequoteright % \let\markupsetuplqkbd \markupsetcodequoteleft \let\markupsetuprqkbd \markupsetcodequoteright % \let\markupsetuplqsamp \markupsetcodequoteleft \let\markupsetuprqsamp \markupsetcodequoteright % \let\markupsetuplqverb \markupsetcodequoteleft \let\markupsetuprqverb \markupsetcodequoteright % \let\markupsetuplqverbatim \markupsetcodequoteleft \let\markupsetuprqverbatim \markupsetcodequoteright % Allow an option to not use regular directed right quote/apostrophe % (char 0x27), but instead the undirected quote from cmtt (char 0x0d). % The undirected quote is ugly, so don't make it the default, but it % works for pasting with more pdf viewers (at least evince), the % lilypond developers report. xpdf does work with the regular 0x27. % \def\codequoteright{% \ifmonospace \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax '% \else \char'15 \fi \else \char'15 \fi \else '% \fi } % % and a similar option for the left quote char vs. a grave accent. % Modern fonts display ASCII 0x60 as a grave accent, so some people like % the code environments to do likewise. % \def\codequoteleft{% \ifmonospace \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax % [Knuth] pp. 380,381,391 % \relax disables Spanish ligatures ?` and !` of \tt font. \relax`% \else \char'22 \fi \else \char'22 \fi \else \relax`% \fi } % Commands to set the quote options. % \parseargdef\codequoteundirected{% \def\temp{#1}% \ifx\temp\onword \expandafter\let\csname SETtxicodequoteundirected\endcsname = t% \else\ifx\temp\offword \expandafter\let\csname SETtxicodequoteundirected\endcsname = \relax \else \errhelp = \EMsimple \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}% \fi\fi } % \parseargdef\codequotebacktick{% \def\temp{#1}% \ifx\temp\onword \expandafter\let\csname SETtxicodequotebacktick\endcsname = t% \else\ifx\temp\offword \expandafter\let\csname SETtxicodequotebacktick\endcsname = \relax \else \errhelp = \EMsimple \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}% \fi\fi } % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font. \def\noligaturesquoteleft{\relax\lq} % Count depth in font-changes, for error checks \newcount\fontdepth \fontdepth=0 % Font commands. % #1 is the font command (\sl or \it), #2 is the text to slant. % If we are in a monospaced environment, however, 1) always use \ttsl, % and 2) do not add an italic correction. \def\dosmartslant#1#2{% \ifusingtt {{\ttsl #2}\let\next=\relax}% {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}% \next } \def\smartslanted{\dosmartslant\sl} \def\smartitalic{\dosmartslant\it} % Output an italic correction unless \next (presumed to be the following % character) is such as not to need one. \def\smartitaliccorrection{% \ifx\next,% \else\ifx\next-% \else\ifx\next.% \else\ifx\next\.% \else\ifx\next\comma% \else\ptexslash \fi\fi\fi\fi\fi \aftersmartic } % Unconditional use \ttsl, and no ic. @var is set to this for defuns. \def\ttslanted#1{{\ttsl #1}} % @cite is like \smartslanted except unconditionally use \sl. We never want % ttsl for book titles, do we? \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection} \def\aftersmartic{} \def\var#1{% \let\saveaftersmartic = \aftersmartic \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}% \smartslanted{#1}% } \let\i=\smartitalic \let\slanted=\smartslanted \let\dfn=\smartslanted \let\emph=\smartitalic % Explicit font changes: @r, @sc, undocumented @ii. \def\r#1{{\rm #1}} % roman font \def\sc#1{{\smallcaps#1}} % smallcaps font \def\ii#1{{\it #1}} % italic font % @b, explicit bold. Also @strong. \def\b#1{{\bf #1}} \let\strong=\b % @sansserif, explicit sans. \def\sansserif#1{{\sf #1}} % We can't just use \exhyphenpenalty, because that only has effect at % the end of a paragraph. Restore normal hyphenation at the end of the % group within which \nohyphenation is presumably called. % \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} \def\restorehyphenation{\hyphenchar\font = `- } % Set sfcode to normal for the chars that usually have another value. % Can't use plain's \frenchspacing because it uses the `\x notation, and % sometimes \x has an active definition that messes things up. % \catcode`@=11 \def\plainfrenchspacing{% \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m \def\endofsentencespacefactor{1000}% for @. and friends } \def\plainnonfrenchspacing{% \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 \def\endofsentencespacefactor{3000}% for @. and friends } \catcode`@=\other \def\endofsentencespacefactor{3000}% default % @t, explicit typewriter. \def\t#1{% {\tt \plainfrenchspacing #1}% \null } % @samp. \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}} % @indicateurl is \samp, that is, with quotes. \let\indicateurl=\samp % @code (and similar) prints in typewriter, but with spaces the same % size as normal in the surrounding text, without hyphenation, etc. % This is a subroutine for that. \def\tclose#1{% {% % Change normal interword space to be same as for the current font. \spaceskip = \fontdimen2\font % % Switch to typewriter. \tt % % But `\ ' produces the large typewriter interword space. \def\ {{\spaceskip = 0pt{} }}% % % Turn off hyphenation. \nohyphenation % \plainfrenchspacing #1% }% \null % reset spacefactor to 1000 } % We *must* turn on hyphenation at `-' and `_' in @code. % (But see \codedashfinish below.) % Otherwise, it is too hard to avoid overfull hboxes % in the Emacs manual, the Library manual, etc. % % Unfortunately, TeX uses one parameter (\hyphenchar) to control % both hyphenation at - and hyphenation within words. % We must therefore turn them both off (\tclose does that) % and arrange explicitly to hyphenate at a dash. -- rms. { \catcode`\-=\active \catcode`\_=\active \catcode`\'=\active \catcode`\`=\active \global\let'=\rq \global\let`=\lq % default definitions % \global\def\code{\begingroup \setupmarkupstyle{code}% % The following should really be moved into \setupmarkupstyle handlers. \catcode\dashChar=\active \catcode\underChar=\active \ifallowcodebreaks \let-\codedash \let_\codeunder \else \let-\normaldash \let_\realunder \fi % Given -foo (with a single dash), we do not want to allow a break % after the hyphen. \global\let\codedashprev=\codedash % \codex } % \gdef\codedash{\futurelet\next\codedashfinish} \gdef\codedashfinish{% \normaldash % always output the dash character itself. % % Now, output a discretionary to allow a line break, unless % (a) the next character is a -, or % (b) the preceding character is a -. % E.g., given --posix, we do not want to allow a break after either -. % Given --foo-bar, we do want to allow a break between the - and the b. \ifx\next\codedash \else \ifx\codedashprev\codedash \else \discretionary{}{}{}\fi \fi % we need the space after the = for the case when \next itself is a % space token; it would get swallowed otherwise. As in @code{- a}. \global\let\codedashprev= \next } } \def\normaldash{-} % \def\codex #1{\tclose{#1}\endgroup} \def\codeunder{% % this is all so @math{@code{var_name}+1} can work. In math mode, _ % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) % will therefore expand the active definition of _, which is us % (inside @code that is), therefore an endless loop. \ifusingtt{\ifmmode \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. \else\normalunderscore \fi \discretionary{}{}{}}% {\_}% } % An additional complication: the above will allow breaks after, e.g., % each of the four underscores in __typeof__. This is bad. % @allowcodebreaks provides a document-level way to turn breaking at - % and _ on and off. % \newif\ifallowcodebreaks \allowcodebreakstrue \def\keywordtrue{true} \def\keywordfalse{false} \parseargdef\allowcodebreaks{% \def\txiarg{#1}% \ifx\txiarg\keywordtrue \allowcodebreakstrue \else\ifx\txiarg\keywordfalse \allowcodebreaksfalse \else \errhelp = \EMsimple \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}% \fi\fi } % For @command, @env, @file, @option quotes seem unnecessary, % so use \code rather than \samp. \let\command=\code \let\env=\code \let\file=\code \let\option=\code % @uref (abbreviation for `urlref') aka @url takes an optional % (comma-separated) second argument specifying the text to display and % an optional third arg as text to display instead of (rather than in % addition to) the url itself. First (mandatory) arg is the url. % TeX-only option to allow changing PDF output to show only the second % arg (if given), and not the url (which is then just the link target). \newif\ifurefurlonlylink % The default \pretolerance setting stops the penalty inserted in % \urefallowbreak being a discouragement to line breaking. Set it to % a negative value for this paragraph only. Hopefully this does not % conflict with redefinitions of \par done elsewhere. \def\nopretolerance{% \pretolerance=-1 \def\par{\endgraf\pretolerance=100 \let\par\endgraf}% } % The main macro is \urefbreak, which allows breaking at expected % places within the url. \def\urefbreak{\nopretolerance \begingroup \urefcatcodes \dourefbreak} \let\uref=\urefbreak % \def\dourefbreak#1{\urefbreakfinish #1,,,\finish} \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example \unsepspaces \pdfurl{#1}% \setbox0 = \hbox{\ignorespaces #3}% \ifdim\wd0 > 0pt \unhbox0 % third arg given, show only that \else \setbox0 = \hbox{\ignorespaces #2}% look for second arg \ifdim\wd0 > 0pt \ifpdf % For pdfTeX and LuaTeX \ifurefurlonlylink % PDF plus option to not display url, show just arg \unhbox0 \else % PDF, normally display both arg and url for consistency, % visibility, if the pdf is eventually used to print, etc. \unhbox0\ (\urefcode{#1})% \fi \else \ifx\XeTeXrevision\thisisundefined \unhbox0\ (\urefcode{#1})% DVI, always show arg and url \else % For XeTeX \ifurefurlonlylink % PDF plus option to not display url, show just arg \unhbox0 \else % PDF, normally display both arg and url for consistency, % visibility, if the pdf is eventually used to print, etc. \unhbox0\ (\urefcode{#1})% \fi \fi \fi \else \urefcode{#1}% only url given, so show it \fi \fi \endlink \endgroup} % Allow line breaks around only a few characters (only). \def\urefcatcodes{% \catcode`\&=\active \catcode`\.=\active \catcode`\#=\active \catcode`\?=\active \catcode`\/=\active } { \urefcatcodes % \global\def\urefcode{\begingroup \setupmarkupstyle{code}% \urefcatcodes \let&\urefcodeamp \let.\urefcodedot \let#\urefcodehash \let?\urefcodequest \let/\urefcodeslash \codex } % % By default, they are just regular characters. \global\def&{\normalamp} \global\def.{\normaldot} \global\def#{\normalhash} \global\def?{\normalquest} \global\def/{\normalslash} } \def\urefcodeamp{\urefprebreak \&\urefpostbreak} \def\urefcodedot{\urefprebreak .\urefpostbreak} \def\urefcodehash{\urefprebreak \#\urefpostbreak} \def\urefcodequest{\urefprebreak ?\urefpostbreak} \def\urefcodeslash{\futurelet\next\urefcodeslashfinish} { \catcode`\/=\active \global\def\urefcodeslashfinish{% \urefprebreak \slashChar % Allow line break only after the final / in a sequence of % slashes, to avoid line break between the slashes in http://. \ifx\next/\else \urefpostbreak \fi } } % By default we'll break after the special characters, but some people like to % break before the special chars, so allow that. Also allow no breaking at % all, for manual control. % \parseargdef\urefbreakstyle{% \def\txiarg{#1}% \ifx\txiarg\wordnone \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak} \else\ifx\txiarg\wordbefore \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak} \else\ifx\txiarg\wordafter \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak} \else \errhelp = \EMsimple \errmessage{Unknown @urefbreakstyle setting `\txiarg'}% \fi\fi\fi } \def\wordafter{after} \def\wordbefore{before} \def\wordnone{none} % Allow a ragged right output to aid breaking long URL's. There can % be a break at the \allowbreak with no extra glue (if the existing stretch in % the line is sufficient), a break at the \penalty with extra glue added % at the end of the line, or no break at all here. % Changing the value of the penalty and/or the amount of stretch affects how % preferable one choice is over the other. \def\urefallowbreak{% \penalty0\relax \hskip 0pt plus 2 em\relax \penalty1000\relax \hskip 0pt plus -2 em\relax } \urefbreakstyle after % @url synonym for @uref, since that's how everyone uses it. % \let\url=\uref % rms does not like angle brackets --karl, 17may97. % So now @email is just like @uref, unless we are pdf. % %\def\email#1{\angleleft{\tt #1}\angleright} \ifpdforxetex \def\email#1{\doemail#1,,\finish} \def\doemail#1,#2,#3\finish{\begingroup \unsepspaces \pdfurl{mailto:#1}% \setbox0 = \hbox{\ignorespaces #2}% \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi \endlink \endgroup} \else \let\email=\uref \fi % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), % `example' (@kbd uses ttsl only inside of @example and friends), % or `code' (@kbd uses normal tty font always). \parseargdef\kbdinputstyle{% \def\txiarg{#1}% \ifx\txiarg\worddistinct \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% \else\ifx\txiarg\wordexample \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% \else\ifx\txiarg\wordcode \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% \else \errhelp = \EMsimple \errmessage{Unknown @kbdinputstyle setting `\txiarg'}% \fi\fi\fi } \def\worddistinct{distinct} \def\wordexample{example} \def\wordcode{code} % Default is `distinct'. \kbdinputstyle distinct % @kbd is like @code, except that if the argument is just one @key command, % then @kbd has no effect. \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}} \def\xkey{\key} \def\kbdsub#1#2#3\par{% \def\one{#1}\def\three{#3}\def\threex{??}% \ifx\one\xkey\ifx\threex\three \key{#2}% \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi } % definition of @key that produces a lozenge. Doesn't adjust to text size. %\setfont\keyrm\rmshape{8}{1000}{OT1} %\font\keysy=cmsy9 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% % \vbox{\hrule\kern-0.4pt % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% % \kern-0.4pt\hrule}% % \kern-.06em\raise0.4pt\hbox{\angleright}}}} % definition of @key with no lozenge. If the current font is already % monospace, don't change it; that way, we respect @kbdinputstyle. But % if it isn't monospace, then use \tt. % \def\key#1{{\setupmarkupstyle{key}% \nohyphenation \ifmonospace\else\tt\fi #1}\null} % @clicksequence{File @click{} Open ...} \def\clicksequence#1{\begingroup #1\endgroup} % @clickstyle @arrow (by default) \parseargdef\clickstyle{\def\click{#1}} \def\click{\arrow} % Typeset a dimension, e.g., `in' or `pt'. The only reason for the % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. % \def\dmn#1{\thinspace #1} % @acronym for "FBI", "NATO", and the like. % We print this one point size smaller, since it's intended for % all-uppercase. % \def\acronym#1{\doacronym #1,,\finish} \def\doacronym#1,#2,#3\finish{% {\switchtolsize #1}% \def\temp{#2}% \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi \null % reset \spacefactor=1000 } % @abbr for "Comput. J." and the like. % No font change, but don't do end-of-sentence spacing. % \def\abbr#1{\doabbr #1,,\finish} \def\doabbr#1,#2,#3\finish{% {\plainfrenchspacing #1}% \def\temp{#2}% \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi \null % reset \spacefactor=1000 } % @asis just yields its argument. Used with @table, for example. % \def\asis#1{#1} % @math outputs its argument in math mode. % % One complication: _ usually means subscripts, but it could also mean % an actual _ character, as in @math{@var{some_variable} + 1}. So make % _ active, and distinguish by seeing if the current family is \slfam, % which is what @var uses. { \catcode`\_ = \active \gdef\mathunderscore{% \catcode`\_=\active \def_{\ifnum\fam=\slfam \_\else\sb\fi}% } } % Another complication: we want \\ (and @\) to output a math (or tt) \. % FYI, plain.tex uses \\ as a temporary control sequence (for no % particular reason), but this is not advertised and we don't care. % % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} % \def\math{% \ifmmode\else % only go into math if not in math mode already \tex \mathunderscore \let\\ = \mathbackslash \mathactive % make the texinfo accent commands work in math mode \let\"=\ddot \let\'=\acute \let\==\bar \let\^=\hat \let\`=\grave \let\u=\breve \let\v=\check \let\~=\tilde \let\dotaccent=\dot % have to provide another name for sup operator \let\mathopsup=\sup $\expandafter\finishmath\fi } \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. % Some active characters (such as <) are spaced differently in math. % We have to reset their definitions in case the @math was an argument % to a command which sets the catcodes (such as @item or @section). % { \catcode`^ = \active \catcode`< = \active \catcode`> = \active \catcode`+ = \active \catcode`' = \active \gdef\mathactive{% \let^ = \ptexhat \let< = \ptexless \let> = \ptexgtr \let+ = \ptexplus \let' = \ptexquoteright } } % for @sub and @sup, if in math mode, just do a normal sub/superscript. % If in text, use math to place as sub/superscript, but switch % into text mode, with smaller fonts. This is a different font than the % one used for real math sub/superscripts (8pt vs. 7pt), but let's not % fix it (significant additions to font machinery) until someone notices. % \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi} \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}% % \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi} \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}% % provide this command from LaTeX as it is very common \def\frac#1#2{{{#1}\over{#2}}} % @displaymath. % \globaldefs is needed to recognize the end lines in \tex and % \end tex. Set \thisenv as @end displaymath is seen before @end tex. {\obeylines \globaldefs=1 \envdef\displaymath{% \tex \def\thisenv{\displaymath}% $$% } \def\Edisplaymath{$$ \def\thisenv{\tex}% \end tex }} % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}. % Ignore unless FMTNAME == tex; then it is like @iftex and @tex, % except specified as a normal braced arg, so no newlines to worry about. % \def\outfmtnametex{tex} % \long\def\inlinefmt#1{\doinlinefmt #1,\finish} \long\def\doinlinefmt#1,#2,\finish{% \def\inlinefmtname{#1}% \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi } % % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if % FMTNAME is tex, else ELSE-TEXT. \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish} \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{% \def\inlinefmtname{#1}% \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi } % % For raw, must switch into @tex before parsing the argument, to avoid % setting catcodes prematurely. Doing it this way means that, for % example, @inlineraw{html, foo{bar} gets a parse error instead of being % ignored. But this isn't important because if people want a literal % *right* brace they would have to use a command anyway, so they may as % well use a command to get a left brace too. We could re-use the % delimiter character idea from \verb, but it seems like overkill. % \long\def\inlineraw{\tex \doinlineraw} \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish} \def\doinlinerawtwo#1,#2,\finish{% \def\inlinerawname{#1}% \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi \endgroup % close group opened by \tex. } % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set. % \long\def\inlineifset#1{\doinlineifset #1,\finish} \long\def\doinlineifset#1,#2,\finish{% \def\inlinevarname{#1}% \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \else\ignorespaces#2\fi } % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set. % \long\def\inlineifclear#1{\doinlineifclear #1,\finish} \long\def\doinlineifclear#1,#2,\finish{% \def\inlinevarname{#1}% \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi } \message{glyphs,} % and logos. % @@ prints an @, as does @atchar{}. \def\@{\char64 } \let\atchar=\@ % @{ @} @lbracechar{} @rbracechar{} all generate brace characters. \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}} \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}} \let\{=\lbracechar \let\}=\rbracechar % @comma{} to avoid , parsing problems. \let\comma = , % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. \let\, = \ptexc \let\dotaccent = \ptexdot \def\ringaccent#1{{\accent23 #1}} \let\tieaccent = \ptext \let\ubaraccent = \ptexb \let\udotaccent = \d % Other special characters: @questiondown @exclamdown @ordf @ordm % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. \def\questiondown{?`} \def\exclamdown{!`} \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}} \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}} % Dotless i and dotless j, used for accents. \def\imacro{i} \def\jmacro{j} \def\dotless#1{% \def\temp{#1}% \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi \else \errmessage{@dotless can be used only with i or j}% \fi\fi } % The \TeX{} logo, as in plain, but resetting the spacing so that a % period following counts as ending a sentence. (Idea found in latex.) % \edef\TeX{\TeX \spacefactor=1000 } % @LaTeX{} logo. Not quite the same results as the definition in % latex.ltx, since we use a different font for the raised A; it's most % convenient for us to use an explicitly smaller font, rather than using % the \scriptstyle font (since we don't reset \scriptstyle and % \scriptscriptstyle). % \def\LaTeX{% L\kern-.36em {\setbox0=\hbox{T}% \vbox to \ht0{\hbox{% \ifx\textnominalsize\xwordpt % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX. % Revert to plain's \scriptsize, which is 7pt. \count255=\the\fam $\fam\count255 \scriptstyle A$% \else % For 11pt, we can use our lllsize. \switchtolllsize A% \fi }% \vss }}% \kern-.15em \TeX } % Some math mode symbols. Define \ensuremath to switch into math mode % unless we are already there. Expansion tricks may not be needed here, % but safer, and can't hurt. \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi} \def\ensuredmath#1{$\relax#1$} % \def\bullet{\ensuremath\ptexbullet} \def\geq{\ensuremath\ge} \def\leq{\ensuremath\le} \def\minus{\ensuremath-} % @dots{} outputs an ellipsis using the current font. % We do .5em per period so that it has the same spacing in the cm % typewriter fonts as three actual period characters; on the other hand, % in other typewriter fonts three periods are wider than 1.5em. So do % whichever is larger. % \def\dots{% \leavevmode \setbox0=\hbox{...}% get width of three periods \ifdim\wd0 > 1.5em \dimen0 = \wd0 \else \dimen0 = 1.5em \fi \hbox to \dimen0{% \hskip 0pt plus.25fil .\hskip 0pt plus1fil .\hskip 0pt plus1fil .\hskip 0pt plus.5fil }% } % @enddots{} is an end-of-sentence ellipsis. % \def\enddots{% \dots \spacefactor=\endofsentencespacefactor } % @point{}, @result{}, @expansion{}, @print{}, @equiv{}. % % Since these characters are used in examples, they should be an even number of % \tt widths. Each \tt character is 1en, so two makes it 1em. % \def\point{$\star$} \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}} \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}} \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}} % The @error{} command. % Adapted from the TeXbook's \boxit. % \newbox\errorbox % {\ttfont \global\dimen0 = 3em}% Width of the box. \dimen2 = .55pt % Thickness of rules % The text. (`r' is open on the right, `e' somewhat less so on the left.) \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt} % \setbox\errorbox=\hbox to \dimen0{\hfil \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. \advance\hsize by -2\dimen2 % Rules. \vbox{% \hrule height\dimen2 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. \kern3pt\vrule width\dimen2}% Space to right. \hrule height\dimen2} \hfil} % \def\error{\leavevmode\lower.7ex\copy\errorbox} % @pounds{} is a sterling sign, which Knuth put in the CM italic font. % \def\pounds{\ifmonospace{\ecfont\char"BF}\else{\it\$}\fi} % @euro{} comes from a separate font, depending on the current style. % We use the free feym* fonts from the eurosym package by Henrik % Theiling, which support regular, slanted, bold and bold slanted (and % "outlined" (blackboard board, sort of) versions, which we don't need). % It is available from http://www.ctan.org/tex-archive/fonts/eurosym. % % Although only regular is the truly official Euro symbol, we ignore % that. The Euro is designed to be slightly taller than the regular % font height. % % feymr - regular % feymo - slanted % feybr - bold % feybo - bold slanted % % There is no good (free) typewriter version, to my knowledge. % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. % Hmm. % % Also doesn't work in math. Do we need to do math with euro symbols? % Hope not. % % \def\euro{{\eurofont e}} \def\eurofont{% % We set the font at each command, rather than predefining it in % \textfonts and the other font-switching commands, so that % installations which never need the symbol don't have to have the % font installed. % % There is only one designed size (nominal 10pt), so we always scale % that to the current nominal size. % % By the way, simply using "at 1em" works for cmr10 and the like, but % does not work for cmbx10 and other extended/shrunken fonts. % \def\eurosize{\csname\curfontsize nominalsize\endcsname}% % \ifx\curfontstyle\bfstylename % bold: \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize \else % regular: \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize \fi \thiseurofont } % Glyphs from the EC fonts. We don't use \let for the aliases, because % sometimes we redefine the original macro, and the alias should reflect % the redefinition. % % Use LaTeX names for the Icelandic letters. \def\DH{{\ecfont \char"D0}} % Eth \def\dh{{\ecfont \char"F0}} % eth \def\TH{{\ecfont \char"DE}} % Thorn \def\th{{\ecfont \char"FE}} % thorn % \def\guillemetleft{{\ecfont \char"13}} \def\guillemotleft{\guillemetleft} \def\guillemetright{{\ecfont \char"14}} \def\guillemotright{\guillemetright} \def\guilsinglleft{{\ecfont \char"0E}} \def\guilsinglright{{\ecfont \char"0F}} \def\quotedblbase{{\ecfont \char"12}} \def\quotesinglbase{{\ecfont \char"0D}} % % This positioning is not perfect (see the ogonek LaTeX package), but % we have the precomposed glyphs for the most common cases. We put the % tests to use those glyphs in the single \ogonek macro so we have fewer % dummy definitions to worry about for index entries, etc. % % ogonek is also used with other letters in Lithuanian (IOU), but using % the precomposed glyphs for those is not so easy since they aren't in % the same EC font. \def\ogonek#1{{% \def\temp{#1}% \ifx\temp\macrocharA\Aogonek \else\ifx\temp\macrochara\aogonek \else\ifx\temp\macrocharE\Eogonek \else\ifx\temp\macrochare\eogonek \else \ecfont \setbox0=\hbox{#1}% \ifdim\ht0=1ex\accent"0C #1% \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}% \fi \fi\fi\fi\fi }% } \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A} \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a} \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E} \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e} % % Use the European Computer Modern fonts (cm-super in outline format) % for non-CM glyphs. That is ec* for regular text and tc* for the text % companion symbols (LaTeX TS1 encoding). Both are part of the ec % package and follow the same conventions. % \def\ecfont{\etcfont{e}} \def\tcfont{\etcfont{t}} % \def\etcfont#1{% % We can't distinguish serif/sans and italic/slanted, but this % is used for crude hacks anyway (like adding French and German % quotes to documents typeset with CM, where we lose kerning), so % hopefully nobody will notice/care. \edef\ecsize{\csname\curfontsize ecsize\endcsname}% \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}% \ifmonospace % typewriter: \font\thisecfont = #1ctt\ecsize \space at \nominalsize \else \ifx\curfontstyle\bfstylename % bold: \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize \else % regular: \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize \fi \fi \thisecfont } % @registeredsymbol - R in a circle. The font for the R should really % be smaller yet, but lllsize is the best we can do for now. % Adapted from the plain.tex definition of \copyright. % \def\registeredsymbol{% $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}% \hfil\crcr\Orb}}% }$% } % @textdegree - the normal degrees sign. % \def\textdegree{$^\circ$} % Laurent Siebenmann reports \Orb undefined with: % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 % so we'll define it if necessary. % \ifx\Orb\thisisundefined \def\Orb{\mathhexbox20D} \fi % Quotes. \chardef\quoteleft=`\` \chardef\quoteright=`\' % only change font for tt for correct kerning and to avoid using % \ecfont unless necessary. \def\quotedblleft{% \ifmonospace{\ecfont\char"10}\else{\char"5C}\fi } \def\quotedblright{% \ifmonospace{\ecfont\char"11}\else{\char`\"}\fi } \message{page headings,} \newskip\titlepagetopglue \titlepagetopglue = 1.5in \newskip\titlepagebottomglue \titlepagebottomglue = 2pc % First the title page. Must do @settitle before @titlepage. \newif\ifseenauthor \newif\iffinishedtitlepage % @setcontentsaftertitlepage used to do an implicit @contents or % @shortcontents after @end titlepage, but it is now obsolete. \def\setcontentsaftertitlepage{% \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo command; move your @contents command if you want the contents after the title page.}}% \def\setshortcontentsaftertitlepage{% \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo command; move your @shortcontents and @contents commands if you want the contents after the title page.}}% \parseargdef\shorttitlepage{% \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}% \endgroup\page\hbox{}\page} \envdef\titlepage{% % Open one extra group, as we want to close it in the middle of \Etitlepage. \begingroup \parindent=0pt \textfonts % Leave some space at the very top of the page. \vglue\titlepagetopglue % No rule at page bottom unless we print one at the top with @title. \finishedtitlepagetrue % % Most title ``pages'' are actually two pages long, with space % at the top of the second. We don't want the ragged left on the second. \let\oldpage = \page \def\page{% \iffinishedtitlepage\else \finishtitlepage \fi \let\page = \oldpage \page \null }% } \def\Etitlepage{% \iffinishedtitlepage\else \finishtitlepage \fi % It is important to do the page break before ending the group, % because the headline and footline are only empty inside the group. % If we use the new definition of \page, we always get a blank page % after the title page, which we certainly don't want. \oldpage \endgroup % % Need this before the \...aftertitlepage checks so that if they are % in effect the toc pages will come out with page numbers. \HEADINGSon } \def\finishtitlepage{% \vskip4pt \hrule height 2pt width \hsize \vskip\titlepagebottomglue \finishedtitlepagetrue } % Settings used for typesetting titles: no hyphenation, no indentation, % don't worry much about spacing, ragged right. This should be used % inside a \vbox, and fonts need to be set appropriately first. \par should % be specified before the end of the \vbox, since a vbox is a group. % \def\raggedtitlesettings{% \rm \hyphenpenalty=10000 \parindent=0pt \tolerance=5000 \ptexraggedright } % Macros to be used within @titlepage: \let\subtitlerm=\rmfont \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} \parseargdef\title{% \checkenv\titlepage \vbox{\titlefonts \raggedtitlesettings #1\par}% % print a rule at the page bottom also. \finishedtitlepagefalse \vskip4pt \hrule height 4pt width \hsize \vskip4pt } \parseargdef\subtitle{% \checkenv\titlepage {\subtitlefont \rightline{#1}}% } % @author should come last, but may come many times. % It can also be used inside @quotation. % \parseargdef\author{% \def\temp{\quotation}% \ifx\thisenv\temp \def\quotationauthor{#1}% printed in \Equotation. \else \checkenv\titlepage \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi {\secfonts\rm \leftline{#1}}% \fi } % Set up page headings and footings. \let\thispage=\folio \newtoks\evenheadline % headline on even pages \newtoks\oddheadline % headline on odd pages \newtoks\evenchapheadline% headline on even pages with a new chapter \newtoks\oddchapheadline % headline on odd pages with a new chapter \newtoks\evenfootline % footline on even pages \newtoks\oddfootline % footline on odd pages % Now make \makeheadline and \makefootline in Plain TeX use those variables \headline={{\textfonts\rm \ifchapterpage \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi \else \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi \fi}} \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline \else \the\evenfootline \fi}\HEADINGShook} \let\HEADINGShook=\relax % Commands to set those variables. % For example, this is what @headings on does % @evenheading @thistitle|@thispage|@thischapter % @oddheading @thischapter|@thispage|@thistitle % @evenfooting @thisfile|| % @oddfooting ||@thisfile \def\evenheading{\parsearg\evenheadingxxx} \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} \def\evenheadingyyy #1\|#2\|#3\|#4\finish{% \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}} \global\evenchapheadline=\evenheadline} \def\oddheading{\parsearg\oddheadingxxx} \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} \def\oddheadingyyy #1\|#2\|#3\|#4\finish{% \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}% \global\oddchapheadline=\oddheadline} \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% \def\evenfooting{\parsearg\evenfootingxxx} \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} \def\evenfootingyyy #1\|#2\|#3\|#4\finish{% \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} \def\oddfooting{\parsearg\oddfootingxxx} \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} \def\oddfootingyyy #1\|#2\|#3\|#4\finish{% \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% % % Leave some space for the footline. Hopefully ok to assume % @evenfooting will not be used by itself. \global\advance\txipageheight by -12pt \global\advance\vsize by -12pt } \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} % @evenheadingmarks top \thischapter <- chapter at the top of a page % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page % % The same set of arguments for: % % @oddheadingmarks % @evenfootingmarks % @oddfootingmarks % @everyheadingmarks % @everyfootingmarks % These define \getoddheadingmarks, \getevenheadingmarks, % \getoddfootingmarks, and \getevenfootingmarks, each to one of % \gettopheadingmarks, \getbottomheadingmarks. % \def\evenheadingmarks{\headingmarks{even}{heading}} \def\oddheadingmarks{\headingmarks{odd}{heading}} \def\evenfootingmarks{\headingmarks{even}{footing}} \def\oddfootingmarks{\headingmarks{odd}{footing}} \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1} \headingmarks{odd}{heading}{#1} } \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1} \headingmarks{odd}{footing}{#1} } % #1 = even/odd, #2 = heading/footing, #3 = top/bottom. \def\headingmarks#1#2#3 {% \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname \global\expandafter\let\csname get#1#2marks\endcsname \temp } \everyheadingmarks bottom \everyfootingmarks bottom % @headings double turns headings on for double-sided printing. % @headings single turns headings on for single-sided printing. % @headings off turns them off. % @headings on same as @headings double, retained for compatibility. % @headings after turns on double-sided headings after this page. % @headings doubleafter turns on double-sided headings after this page. % @headings singleafter turns on single-sided headings after this page. % By default, they are off at the start of a document, % and turned `on' after @end titlepage. \parseargdef\headings{\csname HEADINGS#1\endcsname} \def\headingsoff{% non-global headings elimination \evenheadline={\hfil}\evenfootline={\hfil}\evenchapheadline={\hfil}% \oddheadline={\hfil}\oddfootline={\hfil}\oddchapheadline={\hfil}% } \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting \HEADINGSoff % it's the default % When we turn headings on, set the page number to 1. \def\pageone{ \global\pageno=1 \global\arabiccount = \pagecount } % For double-sided printing, put current file name in lower left corner, % chapter name on inside top of right hand pages, document % title on inside top of left hand pages, and page numbers on outside top % edge of all pages. \def\HEADINGSdouble{% \pageone \HEADINGSdoublex } \let\contentsalignmacro = \chappager % For single-sided printing, chapter title goes across top left of page, % page number on top right. \def\HEADINGSsingle{% \pageone \HEADINGSsinglex } \def\HEADINGSon{\HEADINGSdouble} \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} \let\HEADINGSdoubleafter=\HEADINGSafter \def\HEADINGSdoublex{% \global\evenfootline={\hfil} \global\oddfootline={\hfil} \global\evenheadline={\line{\folio\hfil\thistitle}} \global\oddheadline={\line{\thischapter\hfil\folio}} \global\evenchapheadline={\line{\folio\hfil}} \global\oddchapheadline={\line{\hfil\folio}} \global\let\contentsalignmacro = \chapoddpage } \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} \def\HEADINGSsinglex{% \global\evenfootline={\hfil} \global\oddfootline={\hfil} \global\evenheadline={\line{\thischapter\hfil\folio}} \global\oddheadline={\line{\thischapter\hfil\folio}} \global\evenchapheadline={\line{\hfil\folio}} \global\oddchapheadline={\line{\hfil\folio}} \global\let\contentsalignmacro = \chappager } % for @setchapternewpage off \def\HEADINGSsinglechapoff{% \pageone \global\evenfootline={\hfil} \global\oddfootline={\hfil} \global\evenheadline={\line{\thischapter\hfil\folio}} \global\oddheadline={\line{\thischapter\hfil\folio}} \global\evenchapheadline=\evenheadline \global\oddchapheadline=\oddheadline \global\let\contentsalignmacro = \chappager } % Subroutines used in generating headings % This produces Day Month Year style of output. % Only define if not already defined, in case a txi-??.tex file has set % up a different format (e.g., txi-cs.tex does this). \ifx\today\thisisundefined \def\today{% \number\day\space \ifcase\month \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec \fi \space\number\year} \fi % @settitle line... specifies the title of the document, for headings. % It generates no output of its own. \def\thistitle{\putwordNoTitle} \def\settitle{\parsearg{\gdef\thistitle}} \message{tables,} % Tables -- @table, @ftable, @vtable, @item(x). % default indentation of table text \newdimen\tableindent \tableindent=.8in % default indentation of @itemize and @enumerate text \newdimen\itemindent \itemindent=.3in % margin between end of table item and start of table text. \newdimen\itemmargin \itemmargin=.1in % used internally for \itemindent minus \itemmargin \newdimen\itemmax % Note @table, @ftable, and @vtable define @item, @itemx, etc., with % these defs. % They also define \itemindex % to index the item name in whatever manner is desired (perhaps none). \newif\ifitemxneedsnegativevskip \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} \def\internalBitem{\smallbreak \parsearg\itemzzz} \def\internalBitemx{\itemxpar \parsearg\itemzzz} \def\itemzzz #1{\begingroup % \advance\hsize by -\rightskip \advance\hsize by -\tableindent \setbox0=\hbox{\itemindicate{#1}}% \itemindex{#1}% \nobreak % This prevents a break before @itemx. % % If the item text does not fit in the space we have, put it on a line % by itself, and do not allow a page break either before or after that % line. We do not start a paragraph here because then if the next % command is, e.g., @kindex, the whatsit would get put into the % horizontal list on a line by itself, resulting in extra blank space. \ifdim \wd0>\itemmax % % Make this a paragraph so we get the \parskip glue and wrapping, % but leave it ragged-right. \begingroup \advance\leftskip by-\tableindent \advance\hsize by\tableindent \advance\rightskip by0pt plus1fil\relax \leavevmode\unhbox0\par \endgroup % % We're going to be starting a paragraph, but we don't want the % \parskip glue -- logically it's part of the @item we just started. \nobreak \vskip-\parskip % % Stop a page break at the \parskip glue coming up. However, if % what follows is an environment such as @example, there will be no % \parskip glue; then the negative vskip we just inserted would % cause the example and the item to crash together. So we use this % bizarre value of 10001 as a signal to \aboveenvbreak to insert % \parskip glue after all. Section titles are handled this way also. % \penalty 10001 \endgroup \itemxneedsnegativevskipfalse \else % The item text fits into the space. Start a paragraph, so that the % following text (if any) will end up on the same line. \noindent % Do this with kerns and \unhbox so that if there is a footnote in % the item text, it can migrate to the main vertical list and % eventually be printed. \nobreak\kern-\tableindent \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 \unhbox0 \nobreak\kern\dimen0 \endgroup \itemxneedsnegativevskiptrue \fi } \def\item{\errmessage{@item while not in a list environment}} \def\itemx{\errmessage{@itemx while not in a list environment}} % @table, @ftable, @vtable. \envdef\table{% \let\itemindex\gobble \tablecheck{table}% } \envdef\ftable{% \def\itemindex ##1{\doind {fn}{\code{##1}}}% \tablecheck{ftable}% } \envdef\vtable{% \def\itemindex ##1{\doind {vr}{\code{##1}}}% \tablecheck{vtable}% } \def\tablecheck#1{% \ifnum \the\catcode`\^^M=\active \endgroup \errmessage{This command won't work in this context; perhaps the problem is that we are \inenvironment\thisenv}% \def\next{\doignore{#1}}% \else \let\next\tablex \fi \next } \def\tablex#1{% \def\itemindicate{#1}% \parsearg\tabley } \def\tabley#1{% {% \makevalueexpandable \edef\temp{\noexpand\tablez #1\space\space\space}% \expandafter }\temp \endtablez } \def\tablez #1 #2 #3 #4\endtablez{% \aboveenvbreak \ifnum 0#1>0 \advance \leftskip by #1\mil \fi \ifnum 0#2>0 \tableindent=#2\mil \fi \ifnum 0#3>0 \advance \rightskip by #3\mil \fi \itemmax=\tableindent \advance \itemmax by -\itemmargin \advance \leftskip by \tableindent \exdentamount=\tableindent \parindent = 0pt \parskip = \smallskipamount \ifdim \parskip=0pt \parskip=2pt \fi \let\item = \internalBitem \let\itemx = \internalBitemx } \def\Etable{\endgraf\afterenvbreak} \let\Eftable\Etable \let\Evtable\Etable \let\Eitemize\Etable \let\Eenumerate\Etable % This is the counter used by @enumerate, which is really @itemize \newcount \itemno \envdef\itemize{\parsearg\doitemize} \def\doitemize#1{% \aboveenvbreak \itemmax=\itemindent \advance\itemmax by -\itemmargin \advance\leftskip by \itemindent \exdentamount=\itemindent \parindent=0pt \parskip=\smallskipamount \ifdim\parskip=0pt \parskip=2pt \fi % % Try typesetting the item mark so that if the document erroneously says % something like @itemize @samp (intending @table), there's an error % right away at the @itemize. It's not the best error message in the % world, but it's better than leaving it to the @item. This means if % the user wants an empty mark, they have to say @w{} not just @w. \def\itemcontents{#1}% \setbox0 = \hbox{\itemcontents}% % % @itemize with no arg is equivalent to @itemize @bullet. \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi % \let\item=\itemizeitem } % Definition of @item while inside @itemize and @enumerate. % \def\itemizeitem{% \advance\itemno by 1 % for enumerations {\let\par=\endgraf \smallbreak}% reasonable place to break {% % If the document has an @itemize directly after a section title, a % \nobreak will be last on the list, and \sectionheading will have % done a \vskip-\parskip. In that case, we don't want to zero % parskip, or the item text will crash with the heading. On the % other hand, when there is normal text preceding the item (as there % usually is), we do want to zero parskip, or there would be too much % space. In that case, we won't have a \nobreak before. At least % that's the theory. \ifnum\lastpenalty<10000 \parskip=0in \fi \noindent \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% % \ifinner\else \vadjust{\penalty 1200}% not good to break after first line of item. \fi % We can be in inner vertical mode in a footnote, although an % @itemize looks awful there. }% \flushcr } % \splitoff TOKENS\endmark defines \first to be the first token in % TOKENS, and \rest to be the remainder. % \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% % Allow an optional argument of an uppercase letter, lowercase letter, % or number, to specify the first label in the enumerated list. No % argument is the same as `1'. % \envparseargdef\enumerate{\enumeratey #1 \endenumeratey} \def\enumeratey #1 #2\endenumeratey{% % If we were given no argument, pretend we were given `1'. \def\thearg{#1}% \ifx\thearg\empty \def\thearg{1}\fi % % Detect if the argument is a single token. If so, it might be a % letter. Otherwise, the only valid thing it can be is a number. % (We will always have one token, because of the test we just made. % This is a good thing, since \splitoff doesn't work given nothing at % all -- the first parameter is undelimited.) \expandafter\splitoff\thearg\endmark \ifx\rest\empty % Only one token in the argument. It could still be anything. % A ``lowercase letter'' is one whose \lccode is nonzero. % An ``uppercase letter'' is one whose \lccode is both nonzero, and % not equal to itself. % Otherwise, we assume it's a number. % % We need the \relax at the end of the \ifnum lines to stop TeX from % continuing to look for a . % \ifnum\lccode\expandafter`\thearg=0\relax \numericenumerate % a number (we hope) \else % It's a letter. \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax \lowercaseenumerate % lowercase letter \else \uppercaseenumerate % uppercase letter \fi \fi \else % Multiple tokens in the argument. We hope it's a number. \numericenumerate \fi } % An @enumerate whose labels are integers. The starting integer is % given in \thearg. % \def\numericenumerate{% \itemno = \thearg \startenumeration{\the\itemno}% } % The starting (lowercase) letter is in \thearg. \def\lowercaseenumerate{% \itemno = \expandafter`\thearg \startenumeration{% % Be sure we're not beyond the end of the alphabet. \ifnum\itemno=0 \errmessage{No more lowercase letters in @enumerate; get a bigger alphabet}% \fi \char\lccode\itemno }% } % The starting (uppercase) letter is in \thearg. \def\uppercaseenumerate{% \itemno = \expandafter`\thearg \startenumeration{% % Be sure we're not beyond the end of the alphabet. \ifnum\itemno=0 \errmessage{No more uppercase letters in @enumerate; get a bigger alphabet} \fi \char\uccode\itemno }% } % Call \doitemize, adding a period to the first argument and supplying the % common last two arguments. Also subtract one from the initial value in % \itemno, since @item increments \itemno. % \def\startenumeration#1{% \advance\itemno by -1 \doitemize{#1.}\flushcr } % @alphaenumerate and @capsenumerate are abbreviations for giving an arg % to @enumerate. % \def\alphaenumerate{\enumerate{a}} \def\capsenumerate{\enumerate{A}} \def\Ealphaenumerate{\Eenumerate} \def\Ecapsenumerate{\Eenumerate} % @multitable macros % Amy Hendrickson, 8/18/94, 3/6/96 % % @multitable ... @end multitable will make as many columns as desired. % Contents of each column will wrap at width given in preamble. Width % can be specified either with sample text given in a template line, % or in percent of \hsize, the current width of text on page. % Table can continue over pages but will only break between lines. % To make preamble: % % Either define widths of columns in terms of percent of \hsize: % @multitable @columnfractions .25 .3 .45 % @item ... % % Numbers following @columnfractions are the percent of the total % current hsize to be used for each column. You may use as many % columns as desired. % Or use a template: % @multitable {Column 1 template} {Column 2 template} {Column 3 template} % @item ... % using the widest term desired in each column. % Each new table line starts with @item, each subsequent new column % starts with @tab. Empty columns may be produced by supplying @tab's % with nothing between them for as many times as empty columns are needed, % ie, @tab@tab@tab will produce two empty columns. % @item, @tab do not need to be on their own lines, but it will not hurt % if they are. % Sample multitable: % @multitable {Column 1 template} {Column 2 template} {Column 3 template} % @item first col stuff @tab second col stuff @tab third col % @item % first col stuff % @tab % second col stuff % @tab % third col % @item first col stuff @tab second col stuff % @tab Many paragraphs of text may be used in any column. % % They will wrap at the width determined by the template. % @item@tab@tab This will be in third column. % @end multitable % Default dimensions may be reset by user. % @multitableparskip is vertical space between paragraphs in table. % @multitableparindent is paragraph indent in table. % @multitablecolmargin is horizontal space to be left between columns. % @multitablelinespace is space to leave between table items, baseline % to baseline. % 0pt means it depends on current normal line spacing. % \newskip\multitableparskip \newskip\multitableparindent \newdimen\multitablecolspace \newskip\multitablelinespace \multitableparskip=0pt \multitableparindent=6pt \multitablecolspace=12pt \multitablelinespace=0pt % Macros used to set up halign preamble: % \let\endsetuptable\relax \def\xendsetuptable{\endsetuptable} \let\columnfractions\relax \def\xcolumnfractions{\columnfractions} \newif\ifsetpercent % #1 is the @columnfraction, usually a decimal number like .5, but might % be just 1. We just use it, whatever it is. % \def\pickupwholefraction#1 {% \global\advance\colcount by 1 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% \setuptable } \newcount\colcount \def\setuptable#1{% \def\firstarg{#1}% \ifx\firstarg\xendsetuptable \let\go = \relax \else \ifx\firstarg\xcolumnfractions \global\setpercenttrue \else \ifsetpercent \let\go\pickupwholefraction \else \global\advance\colcount by 1 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a % separator; typically that is always in the input, anyway. \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% \fi \fi \ifx\go\pickupwholefraction % Put the argument back for the \pickupwholefraction call, so % we'll always have a period there to be parsed. \def\go{\pickupwholefraction#1}% \else \let\go = \setuptable \fi% \fi \go } % multitable-only commands. % % @headitem starts a heading row, which we typeset in bold. Assignments % have to be global since we are inside the implicit group of an % alignment entry. \everycr below resets \everytab so we don't have to % undo it ourselves. \def\headitemfont{\b}% for people to use in the template row; not changeable \def\headitem{% \checkenv\multitable \crcr \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings \global\everytab={\bf}% can't use \headitemfont since the parsing differs \the\everytab % for the first item }% % % default for tables with no headings. \let\headitemcrhook=\relax % % A \tab used to include \hskip1sp. But then the space in a template % line is not enough. That is bad. So let's go back to just `&' until % we again encounter the problem the 1sp was intended to solve. % --karl, nathan@acm.org, 20apr99. \def\tab{\checkenv\multitable &\the\everytab}% % @multitable ... @end multitable definitions: % \newtoks\everytab % insert after every tab. % \envdef\multitable{% \vskip\parskip \startsavinginserts % % @item within a multitable starts a normal row. % We use \def instead of \let so that if one of the multitable entries % contains an @itemize, we don't choke on the \item (seen as \crcr aka % \endtemplate) expanding \doitemize. \def\item{\crcr}% % \tolerance=9500 \hbadness=9500 \setmultitablespacing \parskip=\multitableparskip \parindent=\multitableparindent \overfullrule=0pt \global\colcount=0 % \everycr = {% \noalign{% \global\everytab={}% Reset from possible headitem. \global\colcount=0 % Reset the column counter. % % Check for saved footnotes, etc.: \checkinserts % % Perhaps a \nobreak, then reset: \headitemcrhook \global\let\headitemcrhook=\relax }% }% % \parsearg\domultitable } \def\domultitable#1{% % To parse everything between @multitable and @item: \setuptable#1 \endsetuptable % % This preamble sets up a generic column definition, which will % be used as many times as user calls for columns. % \vtop will set a single line and will also let text wrap and % continue for many paragraphs if desired. \halign\bgroup &% \global\advance\colcount by 1 \multistrut \vtop{% % Use the current \colcount to find the correct column width: \hsize=\expandafter\csname col\the\colcount\endcsname % % In order to keep entries from bumping into each other % we will add a \leftskip of \multitablecolspace to all columns after % the first one. % % If a template has been used, we will add \multitablecolspace % to the width of each template entry. % % If the user has set preamble in terms of percent of \hsize we will % use that dimension as the width of the column, and the \leftskip % will keep entries from bumping into each other. Table will start at % left margin and final column will justify at right margin. % % Make sure we don't inherit \rightskip from the outer environment. \rightskip=0pt \ifnum\colcount=1 % The first column will be indented with the surrounding text. \advance\hsize by\leftskip \else \ifsetpercent \else % If user has not set preamble in terms of percent of \hsize % we will advance \hsize by \multitablecolspace. \advance\hsize by \multitablecolspace \fi % In either case we will make \leftskip=\multitablecolspace: \leftskip=\multitablecolspace \fi % Ignoring space at the beginning and end avoids an occasional spurious % blank line, when TeX decides to break the line at the space before the % box from the multistrut, so the strut ends up on a line by itself. % For example: % @multitable @columnfractions .11 .89 % @item @code{#} % @tab Legal holiday which is valid in major parts of the whole country. % Is automatically provided with highlighting sequences respectively % marking characters. \noindent\ignorespaces##\unskip\multistrut }\cr } \def\Emultitable{% \crcr \egroup % end the \halign \global\setpercentfalse } \def\setmultitablespacing{% \def\multistrut{\strut}% just use the standard line spacing % % Compute \multitablelinespace (if not defined by user) for use in % \multitableparskip calculation. We used define \multistrut based on % this, but (ironically) that caused the spacing to be off. % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. \ifdim\multitablelinespace=0pt \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip \global\advance\multitablelinespace by-\ht0 \fi % Test to see if parskip is larger than space between lines of % table. If not, do nothing. % If so, set to same dimension as multitablelinespace. \ifdim\multitableparskip>\multitablelinespace \global\multitableparskip=\multitablelinespace \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller % than skip between lines in the table. \fi% \ifdim\multitableparskip=0pt \global\multitableparskip=\multitablelinespace \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller % than skip between lines in the table. \fi} \message{conditionals,} % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, % @ifnotxml always succeed. They currently do nothing; we don't % attempt to check whether the conditionals are properly nested. But we % have to remember that they are conditionals, so that @end doesn't % attempt to close an environment group. % \def\makecond#1{% \expandafter\let\csname #1\endcsname = \relax \expandafter\let\csname iscond.#1\endcsname = 1 } \makecond{iftex} \makecond{ifnotdocbook} \makecond{ifnothtml} \makecond{ifnotinfo} \makecond{ifnotplaintext} \makecond{ifnotxml} % Ignore @ignore, @ifhtml, @ifinfo, and the like. % \def\direntry{\doignore{direntry}} \def\documentdescription{\doignore{documentdescription}} \def\docbook{\doignore{docbook}} \def\html{\doignore{html}} \def\ifdocbook{\doignore{ifdocbook}} \def\ifhtml{\doignore{ifhtml}} \def\ifinfo{\doignore{ifinfo}} \def\ifnottex{\doignore{ifnottex}} \def\ifplaintext{\doignore{ifplaintext}} \def\ifxml{\doignore{ifxml}} \def\ignore{\doignore{ignore}} \def\menu{\doignore{menu}} \def\xml{\doignore{xml}} % Ignore text until a line `@end #1', keeping track of nested conditionals. % % A count to remember the depth of nesting. \newcount\doignorecount \def\doignore#1{\begingroup % Scan in ``verbatim'' mode: \obeylines \catcode`\@ = \other \catcode`\{ = \other \catcode`\} = \other % % Make sure that spaces turn into tokens that match what \doignoretext wants. \spaceisspace % % Count number of #1's that we've seen. \doignorecount = 0 % % Swallow text until we reach the matching `@end #1'. \dodoignore{#1}% } { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. \obeylines % % \gdef\dodoignore#1{% % #1 contains the command name as a string, e.g., `ifinfo'. % % Define a command to find the next `@end #1'. \long\def\doignoretext##1^^M@end #1{% \doignoretextyyy##1^^M@#1\_STOP_}% % % And this command to find another #1 command, at the beginning of a % line. (Otherwise, we would consider a line `@c @ifset', for % example, to count as an @ifset for nesting.) \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% % % And now expand that command. \doignoretext ^^M% }% } \def\doignoreyyy#1{% \def\temp{#1}% \ifx\temp\empty % Nothing found. \let\next\doignoretextzzz \else % Found a nested condition, ... \advance\doignorecount by 1 \let\next\doignoretextyyy % ..., look for another. % If we're here, #1 ends with ^^M\ifinfo (for example). \fi \next #1% the token \_STOP_ is present just after this macro. } % We have to swallow the remaining "\_STOP_". % \def\doignoretextzzz#1{% \ifnum\doignorecount = 0 % We have just found the outermost @end. \let\next\enddoignore \else % Still inside a nested condition. \advance\doignorecount by -1 \let\next\doignoretext % Look for the next @end. \fi \next } % Finish off ignored text. { \obeylines% % Ignore anything after the last `@end #1'; this matters in verbatim % environments, where otherwise the newline after an ignored conditional % would result in a blank line in the output. \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% } % @set VAR sets the variable VAR to an empty value. % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. % % Since we want to separate VAR from REST-OF-LINE (which might be % empty), we can't just use \parsearg; we have to insert a space of our % own to delimit the rest of the line, and then take it out again if we % didn't need it. % We rely on the fact that \parsearg sets \catcode`\ =10. % \parseargdef\set{\setyyy#1 \endsetyyy} \def\setyyy#1 #2\endsetyyy{% {% \makevalueexpandable \def\temp{#2}% \edef\next{\gdef\makecsname{SET#1}}% \ifx\temp\empty \next{}% \else \setzzz#2\endsetzzz \fi }% } % Remove the trailing space \setxxx inserted. \def\setzzz#1 \endsetzzz{\next{#1}} % @clear VAR clears (i.e., unsets) the variable VAR. % \parseargdef\clear{% {% \makevalueexpandable \global\expandafter\let\csname SET#1\endcsname=\relax }% } % @value{foo} gets the text saved in variable foo. \def\value{\begingroup\makevalueexpandable\valuexxx} \def\valuexxx#1{\expandablevalue{#1}\endgroup} { \catcode`\-=\active \catcode`\_=\active % \gdef\makevalueexpandable{% \let\value = \expandablevalue % We don't want these characters active, ... \catcode`\-=\other \catcode`\_=\other % ..., but we might end up with active ones in the argument if % we're called from @code, as @code{@value{foo-bar_}}, though. % So \let them to their normal equivalents. \let-\normaldash \let_\normalunderscore } } \def\expandablevalue#1{% \expandafter\ifx\csname SET#1\endcsname\relax {[No value for ``#1'']}% \message{Variable `#1', used in @value, is not set.}% \else \csname SET#1\endcsname \fi } % Like \expandablevalue, but completely expandable (the \message in the % definition above operates at the execution level of TeX). Used when % writing to auxiliary files, due to the expansion that \write does. % If flag is undefined, pass through an unexpanded @value command: maybe it % will be set by the time it is read back in. % % NB flag names containing - or _ may not work here. \def\dummyvalue#1{% \expandafter\ifx\csname SET#1\endcsname\relax \string\value{#1}% \else \csname SET#1\endcsname \fi } % Used for @value's in index entries to form the sort key: expand the @value % if possible, otherwise sort late. \def\indexnofontsvalue#1{% \expandafter\ifx\csname SET#1\endcsname\relax ZZZZZZZ% \else \csname SET#1\endcsname \fi } % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined % with @set. % % To get the special treatment we need for `@end ifset,' we call % \makecond and then redefine. % \makecond{ifset} \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} \def\doifset#1#2{% {% \makevalueexpandable \let\next=\empty \expandafter\ifx\csname SET#2\endcsname\relax #1% If not set, redefine \next. \fi \expandafter }\next } \def\ifsetfail{\doignore{ifset}} % @ifclear VAR ... @end executes the `...' iff VAR has never been % defined with @set, or has been undefined with @clear. % % The `\else' inside the `\doifset' parameter is a trick to reuse the % above code: if the variable is not set, do nothing, if it is set, % then redefine \next to \ifclearfail. % \makecond{ifclear} \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} \def\ifclearfail{\doignore{ifclear}} % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written % without the @) is in fact defined. We can only feasibly check at the % TeX level, so something like `mathcode' is going to considered % defined even though it is not a Texinfo command. % \makecond{ifcommanddefined} \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}} % \def\doifcmddefined#1#2{{% \makevalueexpandable \let\next=\empty \expandafter\ifx\csname #2\endcsname\relax #1% If not defined, \let\next as above. \fi \expandafter }\next } \def\ifcmddefinedfail{\doignore{ifcommanddefined}} % @ifcommandnotdefined CMD ... handled similar to @ifclear above. \makecond{ifcommandnotdefined} \def\ifcommandnotdefined{% \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}} \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}} % Set the `txicommandconditionals' variable, so documents have a way to % test if the @ifcommand...defined conditionals are available. \set txicommandconditionals % @dircategory CATEGORY -- specify a category of the dir file % which this file should belong to. Ignore this in TeX. \let\dircategory=\comment % @defininfoenclose. \let\definfoenclose=\comment \message{indexing,} % Index generation facilities % Define \newwrite to be identical to plain tex's \newwrite % except not \outer, so it can be used within macros and \if's. \edef\newwrite{\makecsname{ptexnewwrite}} % \newindex {foo} defines an index named IX. % It automatically defines \IXindex such that % \IXindex ...rest of line... puts an entry in the index IX. % It also defines \IXindfile to be the number of the output channel for % the file that accumulates this index. The file's extension is IX. % The name of an index should be no more than 2 characters long % for the sake of vms. % \def\newindex#1{% \expandafter\chardef\csname#1indfile\endcsname=0 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index \noexpand\doindex{#1}} } % @defindex foo == \newindex{foo} % \def\defindex{\parsearg\newindex} % Define @defcodeindex, like @defindex except put all entries in @code. % \def\defcodeindex{\parsearg\newcodeindex} % \def\newcodeindex#1{% \expandafter\chardef\csname#1indfile\endcsname=0 \expandafter\xdef\csname#1index\endcsname{% \noexpand\docodeindex{#1}}% } % The default indices: \newindex{cp}% concepts, \newcodeindex{fn}% functions, \newcodeindex{vr}% variables, \newcodeindex{tp}% types, \newcodeindex{ky}% keys \newcodeindex{pg}% and programs. % @synindex foo bar makes index foo feed into index bar. % Do this instead of @defindex foo if you don't want it as a separate index. % % @syncodeindex foo bar similar, but put all entries made for index foo % inside @code. % \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), % #3 the target index (bar). \def\dosynindex#1#2#3{% \requireopenindexfile{#3}% % redefine \fooindfile: \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname \expandafter\let\csname#2indfile\endcsname=\temp % redefine \fooindex: \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% } % Define \doindex, the driver for all index macros. % Argument #1 is generated by the calling \fooindex macro, % and it is the two-letter name of the index. \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx} \def\doindexxxx #1{\doind{\indexname}{#1}} % like the previous two, but they put @code around the argument. \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx} \def\docodeindexxxx #1{\docind{\indexname}{#1}} % Used for the aux, toc and index files to prevent expansion of Texinfo % commands. % \def\atdummies{% \definedummyletter\@% \definedummyletter\ % \definedummyletter\{% \definedummyletter\}% \definedummyletter\&% % % Do the redefinitions. \definedummies \otherbackslash } % \definedummyword defines \#1 as \string\#1\space, thus effectively % preventing its expansion. This is used only for control words, % not control letters, because the \space would be incorrect for % control characters, but is needed to separate the control word % from whatever follows. % % These can be used both for control words that take an argument and % those that do not. If it is followed by {arg} in the input, then % that will dutifully get written to the index (or wherever). % % For control letters, we have \definedummyletter, which omits the % space. % \def\definedummyword #1{\def#1{\string#1\space}}% \def\definedummyletter#1{\def#1{\string#1}}% \let\definedummyaccent\definedummyletter % Called from \atdummies to prevent the expansion of commands. % \def\definedummies{% % \let\commondummyword\definedummyword \let\commondummyletter\definedummyletter \let\commondummyaccent\definedummyaccent \commondummiesnofonts % \definedummyletter\_% \definedummyletter\-% % % Non-English letters. \definedummyword\AA \definedummyword\AE \definedummyword\DH \definedummyword\L \definedummyword\O \definedummyword\OE \definedummyword\TH \definedummyword\aa \definedummyword\ae \definedummyword\dh \definedummyword\exclamdown \definedummyword\l \definedummyword\o \definedummyword\oe \definedummyword\ordf \definedummyword\ordm \definedummyword\questiondown \definedummyword\ss \definedummyword\th % % Although these internal commands shouldn't show up, sometimes they do. \definedummyword\bf \definedummyword\gtr \definedummyword\hat \definedummyword\less \definedummyword\sf \definedummyword\sl \definedummyword\tclose \definedummyword\tt % \definedummyword\LaTeX \definedummyword\TeX % % Assorted special characters. \definedummyword\ampchar \definedummyword\atchar \definedummyword\arrow \definedummyword\backslashchar \definedummyword\bullet \definedummyword\comma \definedummyword\copyright \definedummyword\registeredsymbol \definedummyword\dots \definedummyword\enddots \definedummyword\entrybreak \definedummyword\equiv \definedummyword\error \definedummyword\euro \definedummyword\expansion \definedummyword\geq \definedummyword\guillemetleft \definedummyword\guillemetright \definedummyword\guilsinglleft \definedummyword\guilsinglright \definedummyword\lbracechar \definedummyword\leq \definedummyword\mathopsup \definedummyword\minus \definedummyword\ogonek \definedummyword\pounds \definedummyword\point \definedummyword\print \definedummyword\quotedblbase \definedummyword\quotedblleft \definedummyword\quotedblright \definedummyword\quoteleft \definedummyword\quoteright \definedummyword\quotesinglbase \definedummyword\rbracechar \definedummyword\result \definedummyword\sub \definedummyword\sup \definedummyword\textdegree % \definedummyword\subentry % % We want to disable all macros so that they are not expanded by \write. \macrolist \let\value\dummyvalue % \normalturnoffactive } % \commondummiesnofonts: common to \definedummies and \indexnofonts. % Define \commondummyletter, \commondummyaccent and \commondummyword before % using. Used for accents, font commands, and various control letters. % \def\commondummiesnofonts{% % Control letters and accents. \commondummyletter\!% \commondummyaccent\"% \commondummyaccent\'% \commondummyletter\*% \commondummyaccent\,% \commondummyletter\.% \commondummyletter\/% \commondummyletter\:% \commondummyaccent\=% \commondummyletter\?% \commondummyaccent\^% \commondummyaccent\`% \commondummyaccent\~% \commondummyword\u \commondummyword\v \commondummyword\H \commondummyword\dotaccent \commondummyword\ogonek \commondummyword\ringaccent \commondummyword\tieaccent \commondummyword\ubaraccent \commondummyword\udotaccent \commondummyword\dotless % % Texinfo font commands. \commondummyword\b \commondummyword\i \commondummyword\r \commondummyword\sansserif \commondummyword\sc \commondummyword\slanted \commondummyword\t % % Commands that take arguments. \commondummyword\abbr \commondummyword\acronym \commondummyword\anchor \commondummyword\cite \commondummyword\code \commondummyword\command \commondummyword\dfn \commondummyword\dmn \commondummyword\email \commondummyword\emph \commondummyword\env \commondummyword\file \commondummyword\image \commondummyword\indicateurl \commondummyword\inforef \commondummyword\kbd \commondummyword\key \commondummyword\math \commondummyword\option \commondummyword\pxref \commondummyword\ref \commondummyword\samp \commondummyword\strong \commondummyword\tie \commondummyword\U \commondummyword\uref \commondummyword\url \commondummyword\var \commondummyword\verb \commondummyword\w \commondummyword\xref } \let\indexlbrace\relax \let\indexrbrace\relax \let\indexatchar\relax \let\indexbackslash\relax {\catcode`\@=0 \catcode`\\=13 @gdef@backslashdisappear{@def\{}} } { \catcode`\<=13 \catcode`\-=13 \catcode`\`=13 \gdef\indexnonalnumdisappear{% \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else % @set txiindexlquoteignore makes us ignore left quotes in the sort term. % (Introduced for FSFS 2nd ed.) \let`=\empty \fi % \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else \backslashdisappear \fi % \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else \def-{}% \fi \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else \def<{}% \fi \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else \def\@{}% \fi } \gdef\indexnonalnumreappear{% \let-\normaldash \let<\normalless } } % \indexnofonts is used when outputting the strings to sort the index % by, and when constructing control sequence names. It eliminates all % control sequences and just writes whatever the best ASCII sort string % would be for a given command (usually its argument). % \def\indexnofonts{% % Accent commands should become @asis. \def\commondummyaccent##1{\let##1\asis}% % We can just ignore other control letters. \def\commondummyletter##1{\let##1\empty}% % All control words become @asis by default; overrides below. \let\commondummyword\commondummyaccent \commondummiesnofonts % % Don't no-op \tt, since it isn't a user-level command % and is used in the definitions of the active chars like <, >, |, etc. % Likewise with the other plain tex font commands. %\let\tt=\asis % \def\ { }% \def\@{@}% \def\_{\normalunderscore}% \def\-{}% @- shouldn't affect sorting % \uccode`\1=`\{ \uppercase{\def\{{1}}% \uccode`\1=`\} \uppercase{\def\}{1}}% \let\lbracechar\{% \let\rbracechar\}% % % \let\do\indexnofontsdef % % Non-English letters. \do\AA{AA}% \do\AE{AE}% \do\DH{DZZ}% \do\L{L}% \do\OE{OE}% \do\O{O}% \do\TH{TH}% \do\aa{aa}% \do\ae{ae}% \do\dh{dzz}% \do\exclamdown{!}% \do\l{l}% \do\oe{oe}% \do\ordf{a}% \do\ordm{o}% \do\o{o}% \do\questiondown{?}% \do\ss{ss}% \do\th{th}% % \do\LaTeX{LaTeX}% \do\TeX{TeX}% % % Assorted special characters. \do\atchar{@}% \do\arrow{->}% \do\bullet{bullet}% \do\comma{,}% \do\copyright{copyright}% \do\dots{...}% \do\enddots{...}% \do\equiv{==}% \do\error{error}% \do\euro{euro}% \do\expansion{==>}% \do\geq{>=}% \do\guillemetleft{<<}% \do\guillemetright{>>}% \do\guilsinglleft{<}% \do\guilsinglright{>}% \do\leq{<=}% \do\lbracechar{\{}% \do\minus{-}% \do\point{.}% \do\pounds{pounds}% \do\print{-|}% \do\quotedblbase{"}% \do\quotedblleft{"}% \do\quotedblright{"}% \do\quoteleft{`}% \do\quoteright{'}% \do\quotesinglbase{,}% \do\rbracechar{\}}% \do\registeredsymbol{R}% \do\result{=>}% \do\textdegree{o}% % % We need to get rid of all macros, leaving only the arguments (if present). % Of course this is not nearly correct, but it is the best we can do for now. % makeinfo does not expand macros in the argument to @deffn, which ends up % writing an index entry, and texindex isn't prepared for an index sort entry % that starts with \. % % Since macro invocations are followed by braces, we can just redefine them % to take a single TeX argument. The case of a macro invocation that % goes to end-of-line is not handled. % \macrolist \let\value\indexnofontsvalue } % Give the control sequence a definition that removes the {} that follows % its use, e.g. @AA{} -> AA \def\indexnofontsdef#1#2{\def#1##1{#2}}% % #1 is the index name, #2 is the entry text. \def\doind#1#2{% \iflinks {% % \requireopenindexfile{#1}% \edef\writeto{\csname#1indfile\endcsname}% % \def\indextext{#2}% \safewhatsit\doindwrite }% \fi } % Same as \doind, but for code indices \def\docind#1#2{% \iflinks {% % \requireopenindexfile{#1}% \edef\writeto{\csname#1indfile\endcsname}% % \def\indextext{#2}% \safewhatsit\docindwrite }% \fi } % Check if an index file has been opened, and if not, open it. \def\requireopenindexfile#1{% \ifnum\csname #1indfile\endcsname=0 \expandafter\newwrite \csname#1indfile\endcsname \edef\suffix{#1}% % A .fls suffix would conflict with the file extension for the output % of -recorder, so use .f1s instead. \ifx\suffix\indexisfl\def\suffix{f1}\fi % Open the file \immediate\openout\csname#1indfile\endcsname \jobname.\suffix % Using \immediate above here prevents an object entering into the current % box, which could confound checks such as those in \safewhatsit for % preceding skips. \typeout{Writing index file \jobname.\suffix}% \fi} \def\indexisfl{fl} % Definition for writing index entry sort key. { \catcode`\-=13 \gdef\indexwritesortas{% \begingroup \indexnonalnumreappear \indexwritesortasxxx} \gdef\indexwritesortasxxx#1{% \xdef\indexsortkey{#1}\endgroup} } \def\indexwriteseealso#1{ \gdef\pagenumbertext{\string\seealso{#1}}% } \def\indexwriteseeentry#1{ \gdef\pagenumbertext{\string\seeentry{#1}}% } % The default definitions \def\sortas#1{}% \def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only \def\putwordSeeAlso{See also} \def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}": % * Set \bracedtext to "{aaa}{bbb}" % * Set \fullindexsortkey to "aaa @subentry ZZZ" % * If @seealso occurs, set \pagenumbertext % \def\splitindexentry#1{% \gdef\fullindexsortkey{}% \xdef\bracedtext{}% \def\sep{}% \def\seealso##1{}% \def\seeentry##1{}% \expandafter\doindexsegment#1\subentry\finish\subentry } % append the results from the next segment \def\doindexsegment#1\subentry{% \def\segment{#1}% \ifx\segment\isfinish \else % % Fully expand the segment, throwing away any @sortas directives, and % trim spaces. \edef\trimmed{\segment}% \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}% \ifincodeindex \edef\trimmed{\noexpand\code{\trimmed}}% \fi % \xdef\bracedtext{\bracedtext{\trimmed}}% % % Get the string to sort by. Process the segment with all % font commands turned off. \bgroup \let\sortas\indexwritesortas \let\seealso\indexwriteseealso \let\seeentry\indexwriteseeentry \indexnofonts % The braces around the commands are recognized by texindex. \def\lbracechar{{\string\indexlbrace}}% \def\rbracechar{{\string\indexrbrace}}% \let\{=\lbracechar \let\}=\rbracechar \def\@{{\string\indexatchar}}% \def\atchar##1{\@}% \def\backslashchar{{\string\indexbackslash}}% \uccode`\~=`\\ \uppercase{\let~\backslashchar}% % \let\indexsortkey\empty \global\let\pagenumbertext\empty % Execute the segment and throw away the typeset output. This executes % any @sortas or @seealso commands in this segment. \setbox\dummybox = \hbox{\segment}% \ifx\indexsortkey\empty{% \indexnonalnumdisappear \xdef\trimmed{\segment}% \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}% \xdef\indexsortkey{\trimmed}% \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi }\fi % % Append to \fullindexsortkey. \edef\tmp{\gdef\noexpand\fullindexsortkey{% \fullindexsortkey\sep\indexsortkey}}% \tmp \egroup \def\sep{\subentry}% % \expandafter\doindexsegment \fi } \def\isfinish{\finish}% \newbox\dummybox % used above \let\subentry\relax % Use \ instead of @ in index files. To support old texi2dvi and texindex. % This works without changing the escape character used in the toc or aux % files because the index entries are fully expanded here, and \string uses % the current value of \escapechar. \def\escapeisbackslash{\escapechar=`\\} % Use \ in index files by default. texi2dvi didn't support @ as the escape % character (as it checked for "\entry" in the files, and not "@entry"). When % the new version of texi2dvi has had a chance to become more prevalent, then % the escape character can change back to @ again. This should be an easy % change to make now because both @ and \ are only used as escape characters in % index files, never standing for themselves. % \set txiindexescapeisbackslash % Write the entry in \indextext to the index file. % \newif\ifincodeindex \def\doindwrite{\incodeindexfalse\doindwritex} \def\docindwrite{\incodeindextrue\doindwritex} \def\doindwritex{% \maybemarginindex % \atdummies % \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else \escapeisbackslash \fi % % For texindex which always views { and } as separators. \def\{{\lbracechar{}}% \def\}{\rbracechar{}}% \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}% % % Split the entry into primary entry and any subentries, and get the index % sort key. \splitindexentry\indextext % % Set up the complete index entry, with both the sort key and % the original text, including any font commands. We write % three arguments to \entry to the .?? file (four in the % subentry case), texindex reduces to two when writing the .??s % sorted result. % \edef\temp{% \write\writeto{% \string\entry{\fullindexsortkey}% {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}% \bracedtext}% }% \temp } % Put the index entry in the margin if desired (undocumented). \def\maybemarginindex{% \ifx\SETmarginindex\relax\else \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}% \fi } \let\SETmarginindex=\relax % Take care of unwanted page breaks/skips around a whatsit: % % If a skip is the last thing on the list now, preserve it % by backing up by \lastskip, doing the \write, then inserting % the skip again. Otherwise, the whatsit generated by the % \write or \pdfdest will make \lastskip zero. The result is that % sequences like this: % @end defun % @tindex whatever % @defun ... % will have extra space inserted, because the \medbreak in the % start of the @defun won't see the skip inserted by the @end of % the previous defun. % % But don't do any of this if we're not in vertical mode. We % don't want to do a \vskip and prematurely end a paragraph. % % Avoid page breaks due to these extra skips, too. % % But wait, there is a catch there: % We'll have to check whether \lastskip is zero skip. \ifdim is not % sufficient for this purpose, as it ignores stretch and shrink parts % of the skip. The only way seems to be to check the textual % representation of the skip. % % The following is almost like \def\zeroskipmacro{0.0pt} except that % the ``p'' and ``t'' characters have catcode \other, not 11 (letter). % \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} % \newskip\whatsitskip \newcount\whatsitpenalty % % ..., ready, GO: % \def\safewhatsit#1{\ifhmode #1% \else % \lastskip and \lastpenalty cannot both be nonzero simultaneously. \whatsitskip = \lastskip \edef\lastskipmacro{\the\lastskip}% \whatsitpenalty = \lastpenalty % % If \lastskip is nonzero, that means the last item was a % skip. And since a skip is discardable, that means this % -\whatsitskip glue we're inserting is preceded by a % non-discardable item, therefore it is not a potential % breakpoint, therefore no \nobreak needed. \ifx\lastskipmacro\zeroskipmacro \else \vskip-\whatsitskip \fi % #1% % \ifx\lastskipmacro\zeroskipmacro % If \lastskip was zero, perhaps the last item was a penalty, and % perhaps it was >=10000, e.g., a \nobreak. In that case, we want % to re-insert the same penalty (values >10000 are used for various % signals); since we just inserted a non-discardable item, any % following glue (such as a \parskip) would be a breakpoint. For example: % @deffn deffn-whatever % @vindex index-whatever % Description. % would allow a break between the index-whatever whatsit % and the "Description." paragraph. \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi \else % On the other hand, if we had a nonzero \lastskip, % this make-up glue would be preceded by a non-discardable item % (the whatsit from the \write), so we must insert a \nobreak. \nobreak\vskip\whatsitskip \fi \fi} % The index entry written in the file actually looks like % \entry {sortstring}{page}{topic} % or % \entry {sortstring}{page}{topic}{subtopic} % The texindex program reads in these files and writes files % containing these kinds of lines: % \initial {c} % before the first topic whose initial is c % \entry {topic}{pagelist} % for a topic that is used without subtopics % \primary {topic} % \entry {topic}{} % for the beginning of a topic that is used with subtopics % \secondary {subtopic}{pagelist} % for each subtopic. % \secondary {subtopic}{} % for a subtopic with sub-subtopics % \tertiary {subtopic}{subsubtopic}{pagelist} % for each sub-subtopic. % Define the user-accessible indexing commands % @findex, @vindex, @kindex, @cindex. \def\findex {\fnindex} \def\kindex {\kyindex} \def\cindex {\cpindex} \def\vindex {\vrindex} \def\tindex {\tpindex} \def\pindex {\pgindex} % Define the macros used in formatting output of the sorted index material. % @printindex causes a particular index (the ??s file) to get printed. % It does not print any chapter heading (usually an @unnumbered). % \parseargdef\printindex{\begingroup \dobreak \chapheadingskip{10000}% % \smallfonts \rm \tolerance = 9500 \plainfrenchspacing \everypar = {}% don't want the \kern\-parindent from indentation suppression. % % See comment in \requireopenindexfile. \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi % % See if the index file exists and is nonempty. \openin 1 \jobname.\indexname s \ifeof 1 % \enddoublecolumns gets confused if there is no text in the index, % and it loses the chapter title and the aux file entries for the % index. The easiest way to prevent this problem is to make sure % there is some text. \putwordIndexNonexistent \typeout{No file \jobname.\indexname s.}% \else % If the index file exists but is empty, then \openin leaves \ifeof % false. We have to make TeX try to read something from the file, so % it can discover if there is anything in it. \read 1 to \thisline \ifeof 1 \putwordIndexIsEmpty \else \expandafter\printindexzz\thisline\relax\relax\finish% \fi \fi \closein 1 \endgroup} % If the index file starts with a backslash, forgo reading the index % file altogether. If somebody upgrades texinfo.tex they may still have % old index files using \ as the escape character. Reading this would % at best lead to typesetting garbage, at worst a TeX syntax error. \def\printindexzz#1#2\finish{% \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1 \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax \errmessage{% ERROR: A sorted index file in an obsolete format was skipped. To fix this problem, please upgrade your version of 'texi2dvi' or 'texi2pdf' to that at . If you are using an old version of 'texindex' (part of the Texinfo distribution), you may also need to upgrade to a newer version (at least 6.0). You may be able to typeset the index if you run 'texindex \jobname.\indexname' yourself. You could also try setting the 'txiindexescapeisbackslash' flag by running a command like 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do this, Texinfo will try to use index files in the old format. If you continue to have problems, deleting the index files and starting again might help (with 'rm \jobname.?? \jobname.??s')% }% \else (Skipped sorted index file in obsolete format) \fi \else \begindoublecolumns \input \jobname.\indexname s \enddoublecolumns \fi \else \begindoublecolumns \catcode`\\=0\relax % % Make @ an escape character to give macros a chance to work. This % should work because we (hopefully) don't otherwise use @ in index files. %\catcode`\@=12\relax \catcode`\@=0\relax \input \jobname.\indexname s \enddoublecolumns \fi } % These macros are used by the sorted index file itself. % Change them to control the appearance of the index. {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13 \catcode`\$=3 \gdef\initialglyphs{% % special control sequences used in the index sort key \let\indexlbrace\{% \let\indexrbrace\}% \let\indexatchar\@% \def\indexbackslash{\math{\backslash}}% % % Some changes for non-alphabetic characters. Using the glyphs from the % math fonts looks more consistent than the typewriter font used elsewhere % for these characters. \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}} % % In case @\ is used for backslash \uppercase{\let\\=~} % Can't get bold backslash so don't use bold forward slash \catcode`\/=13 \def/{{\secrmnotbold \normalslash}}% \def-{{\normaldash\normaldash}}% en dash `--' \def^{{\chapbf \normalcaret}}% \def~{{\chapbf \normaltilde}}% \def\_{% \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }% \def|{$\vert$}% \def<{$\less$}% \def>{$\gtr$}% \def+{$\normalplus$}% }} \def\initial{% \bgroup \initialglyphs \initialx } \def\initialx#1{% % Remove any glue we may have, we'll be inserting our own. \removelastskip % % We like breaks before the index initials, so insert a bonus. % The glue before the bonus allows a little bit of space at the % bottom of a column to reduce an increase in inter-line spacing. \nobreak \vskip 0pt plus 5\baselineskip \penalty -300 \vskip 0pt plus -5\baselineskip % % Typeset the initial. Making this add up to a whole number of % baselineskips increases the chance of the dots lining up from column % to column. It still won't often be perfect, because of the stretch % we need before each entry, but it's better. % % No shrink because it confuses \balancecolumns. \vskip 1.67\baselineskip plus 1\baselineskip \leftline{\secfonts \kern-0.05em \secbf #1}% % \secfonts is inside the argument of \leftline so that the change of % \baselineskip will not affect any glue inserted before the vbox that % \leftline creates. % Do our best not to break after the initial. \nobreak \vskip .33\baselineskip plus .1\baselineskip \egroup % \initialglyphs } \newdimen\entryrightmargin \entryrightmargin=0pt % \entry typesets a paragraph consisting of the text (#1), dot leaders, and % then page number (#2) flushed to the right margin. It is used for index % and table of contents entries. The paragraph is indented by \leftskip. % \def\entry{% \begingroup % % Start a new paragraph if necessary, so our assignments below can't % affect previous text. \par % % No extra space above this paragraph. \parskip = 0in % % When reading the text of entry, convert explicit line breaks % from @* into spaces. The user might give these in long section % titles, for instance. \def\*{\unskip\space\ignorespaces}% \def\entrybreak{\hfil\break}% An undocumented command % % Swallow the left brace of the text (first parameter): \afterassignment\doentry \let\temp = } \def\entrybreak{\unskip\space\ignorespaces}% \def\doentry{% % Save the text of the entry \global\setbox\boxA=\hbox\bgroup \bgroup % Instead of the swallowed brace. \noindent \aftergroup\finishentry % And now comes the text of the entry. % Not absorbing as a macro argument reduces the chance of problems % with catcodes occurring. } {\catcode`\@=11 \gdef\finishentry#1{% \egroup % end box A \dimen@ = \wd\boxA % Length of text of entry \global\setbox\boxA=\hbox\bgroup \unhbox\boxA % #1 is the page number. % % Get the width of the page numbers, and only use % leaders if they are present. \global\setbox\boxB = \hbox{#1}% \ifdim\wd\boxB = 0pt \null\nobreak\hfill\ % \else % \null\nobreak\indexdotfill % Have leaders before the page number. % \ifpdforxetex \pdfgettoks#1.% \hskip\skip\thinshrinkable\the\toksA \else \hskip\skip\thinshrinkable #1% \fi \fi \egroup % end \boxA \ifdim\wd\boxB = 0pt \noindent\unhbox\boxA\par \nobreak \else\bgroup % We want the text of the entries to be aligned to the left, and the % page numbers to be aligned to the right. % \parindent = 0pt \advance\leftskip by 0pt plus 1fil \advance\leftskip by 0pt plus -1fill \rightskip = 0pt plus -1fil \advance\rightskip by 0pt plus 1fill % Cause last line, which could consist of page numbers on their own % if the list of page numbers is long, to be aligned to the right. \parfillskip=0pt plus -1fill % \advance\rightskip by \entryrightmargin % Determine how far we can stretch into the margin. % This allows, e.g., "Appendix H GNU Free Documentation License" to % fit on one line in @letterpaper format. \ifdim\entryrightmargin>2.1em \dimen@i=2.1em \else \dimen@i=0em \fi \advance \parfillskip by 0pt minus 1\dimen@i % \dimen@ii = \hsize \advance\dimen@ii by -1\leftskip \advance\dimen@ii by -1\entryrightmargin \advance\dimen@ii by 1\dimen@i \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line \ifdim\dimen@ > 0.8\dimen@ii % due to long index text % Try to split the text roughly evenly. \dimen@ will be the length of % the first line. \dimen@ = 0.7\dimen@ \dimen@ii = \hsize \ifnum\dimen@>\dimen@ii % If the entry is too long (for example, if it needs more than % two lines), use all the space in the first line. \dimen@ = \dimen@ii \fi \advance\leftskip by 0pt plus 1fill % ragged right \advance \dimen@ by 1\rightskip \parshape = 2 0pt \dimen@ 0em \dimen@ii % Ideally we'd add a finite glue at the end of the first line only, % instead of using \parshape with explicit line lengths, but TeX % doesn't seem to provide a way to do such a thing. % % Indent all lines but the first one. \advance\leftskip by 1em \advance\parindent by -1em \fi\fi \indent % start paragraph \unhbox\boxA % % Do not prefer a separate line ending with a hyphen to fewer lines. \finalhyphendemerits = 0 % % Word spacing - no stretch \spaceskip=\fontdimen2\font minus \fontdimen4\font % \linepenalty=1000 % Discourage line breaks. \hyphenpenalty=5000 % Discourage hyphenation. % \par % format the paragraph \egroup % The \vbox \fi \endgroup }} \newskip\thinshrinkable \skip\thinshrinkable=.15em minus .15em % Like plain.tex's \dotfill, except uses up at least 1 em. % The filll stretch here overpowers both the fil and fill stretch to push % the page number to the right. \def\indexdotfill{\cleaders \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll} \def\primary #1{\line{#1\hfil}} \def\secondary{\indententry{0.5cm}} \def\tertiary{\indententry{1cm}} \def\indententry#1#2#3{% \bgroup \leftskip=#1 \entry{#2}{#3}% \egroup } % Define two-column mode, which we use to typeset indexes. % Adapted from the TeXbook, page 416, which is to say, % the manmac.tex format used to print the TeXbook itself. \catcode`\@=11 % private names \newbox\partialpage \newdimen\doublecolumnhsize \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns % If not much space left on page, start a new page. \ifdim\pagetotal>0.8\vsize\vfill\eject\fi % % Grab any single-column material above us. \output = {% \savetopmark % \global\setbox\partialpage = \vbox{% % Unvbox the main output page. \unvbox\PAGE \kern-\topskip \kern\baselineskip }% }% \eject % run that output routine to set \partialpage % % Use the double-column output routine for subsequent pages. \output = {\doublecolumnout}% % % Change the page size parameters. We could do this once outside this % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 % format, but then we repeat the same computation. Repeating a couple % of assignments once per index is clearly meaningless for the % execution time, so we may as well do it in one place. % % First we halve the line length, less a little for the gutter between % the columns. We compute the gutter based on the line length, so it % changes automatically with the paper format. The magic constant % below is chosen so that the gutter has the same value (well, +-<1pt) % as it did when we hard-coded it. % % We put the result in a separate register, \doublecolumhsize, so we % can restore it in \pagesofar, after \hsize itself has (potentially) % been clobbered. % \doublecolumnhsize = \hsize \advance\doublecolumnhsize by -.04154\hsize \divide\doublecolumnhsize by 2 \hsize = \doublecolumnhsize % % Get the available space for the double columns -- the normal % (undoubled) page height minus any material left over from the % previous page. \advance\vsize by -\ht\partialpage \vsize = 2\vsize % % For the benefit of balancing columns \advance\baselineskip by 0pt plus 0.5pt } % The double-column output routine for all double-column pages except % the last, which is done by \balancecolumns. % \def\doublecolumnout{% % \savetopmark \splittopskip=\topskip \splitmaxdepth=\maxdepth \dimen@ = \vsize \divide\dimen@ by 2 % % box0 will be the left-hand column, box2 the right. \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@ \global\advance\vsize by 2\ht\partialpage \onepageout\pagesofar % empty except for the first time we are called \unvbox\PAGE \penalty\outputpenalty } % % Re-output the contents of the output page -- any previous material, % followed by the two boxes we just split, in box0 and box2. \def\pagesofar{% \unvbox\partialpage % \hsize = \doublecolumnhsize \wd0=\hsize \wd2=\hsize \hbox to\txipagewidth{\box0\hfil\box2}% } % Finished with double columns. \def\enddoublecolumns{% % The following penalty ensures that the page builder is exercised % _before_ we change the output routine. This is necessary in the % following situation: % % The last section of the index consists only of a single entry. % Before this section, \pagetotal is less than \pagegoal, so no % break occurs before the last section starts. However, the last % section, consisting of \initial and the single \entry, does not % fit on the page and has to be broken off. Without the following % penalty the page builder will not be exercised until \eject % below, and by that time we'll already have changed the output % routine to the \balancecolumns version, so the next-to-last % double-column page will be processed with \balancecolumns, which % is wrong: The two columns will go to the main vertical list, with % the broken-off section in the recent contributions. As soon as % the output routine finishes, TeX starts reconsidering the page % break. The two columns and the broken-off section both fit on the % page, because the two columns now take up only half of the page % goal. When TeX sees \eject from below which follows the final % section, it invokes the new output routine that we've set after % \balancecolumns below; \onepageout will try to fit the two columns % and the final section into the vbox of \txipageheight (see % \pagebody), causing an overfull box. % % Note that glue won't work here, because glue does not exercise the % page builder, unlike penalties (see The TeXbook, pp. 280-281). \penalty0 % \output = {% % Split the last of the double-column material. \savetopmark \balancecolumns }% \eject % call the \output just set \ifdim\pagetotal=0pt % Having called \balancecolumns once, we do not % want to call it again. Therefore, reset \output to its normal % definition right away. \global\output=\expandafter{\the\defaultoutput} % \endgroup % started in \begindoublecolumns % Leave the double-column material on the current page, no automatic % page break. \box\balancedcolumns % % \pagegoal was set to the doubled \vsize above, since we restarted % the current page. We're now back to normal single-column % typesetting, so reset \pagegoal to the normal \vsize. \global\vsize = \txipageheight % \pagegoal = \txipageheight % \else % We had some left-over material. This might happen when \doublecolumnout % is called in \balancecolumns. Try again. \expandafter\enddoublecolumns \fi } \newbox\balancedcolumns \setbox\balancedcolumns=\vbox{shouldnt see this}% % % Only called for the last of the double column material. \doublecolumnout % does the others. \def\balancecolumns{% \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120. \dimen@ = \ht0 \ifdim\dimen@<7\baselineskip % Don't split a short final column in two. \setbox2=\vbox{}% \global\setbox\balancedcolumns=\vbox{\pagesofar}% \else % double the leading vertical space \advance\dimen@ by \topskip \advance\dimen@ by-\baselineskip \divide\dimen@ by 2 % target to split to \dimen@ii = \dimen@ \splittopskip = \topskip % Loop until left column is at least as high as the right column. {% \vbadness = 10000 \loop \global\setbox3 = \copy0 \global\setbox1 = \vsplit3 to \dimen@ \ifdim\ht1<\ht3 \global\advance\dimen@ by 1pt \repeat }% % Now the left column is in box 1, and the right column in box 3. % % Check whether the left column has come out higher than the page itself. % (Note that we have doubled \vsize for the double columns, so % the actual height of the page is 0.5\vsize). \ifdim2\ht1>\vsize % It appears that we have been called upon to balance too much material. % Output some of it with \doublecolumnout, leaving the rest on the page. \setbox\PAGE=\box0 \doublecolumnout \else % Compare the heights of the two columns. \ifdim4\ht1>5\ht3 % Column heights are too different, so don't make their bottoms % flush with each other. \setbox2=\vbox to \ht1 {\unvbox3\vfill}% \setbox0=\vbox to \ht1 {\unvbox1\vfill}% \else % Make column bottoms flush with each other. \setbox2=\vbox to\ht1{\unvbox3\unskip}% \setbox0=\vbox to\ht1{\unvbox1\unskip}% \fi \global\setbox\balancedcolumns=\vbox{\pagesofar}% \fi \fi % } \catcode`\@ = \other \message{sectioning,} % Chapters, sections, etc. % Let's start with @part. \outer\parseargdef\part{\partzzz{#1}} \def\partzzz#1{% \chapoddpage \null \vskip.3\vsize % move it down on the page a bit \begingroup \noindent \titlefonts\rm #1\par % the text \let\lastnode=\empty % no node to associate with \writetocentry{part}{#1}{}% but put it in the toc \headingsoff % no headline or footline on the part page % This outputs a mark at the end of the page that clears \thischapter % and \thissection, as is done in \startcontents. \let\pchapsepmacro\relax \chapmacro{}{Yomitfromtoc}{}% \chapoddpage \endgroup } % \unnumberedno is an oxymoron. But we count the unnumbered % sections so that we can refer to them unambiguously in the pdf % outlines by their "section number". We avoid collisions with chapter % numbers by starting them at 10000. (If a document ever has 10000 % chapters, we're in trouble anyway, I'm sure.) \newcount\unnumberedno \unnumberedno = 10000 \newcount\chapno \newcount\secno \secno=0 \newcount\subsecno \subsecno=0 \newcount\subsubsecno \subsubsecno=0 % This counter is funny since it counts through charcodes of letters A, B, ... \newcount\appendixno \appendixno = `\@ % % \def\appendixletter{\char\the\appendixno} % We do the following ugly conditional instead of the above simple % construct for the sake of pdftex, which needs the actual % letter in the expansion, not just typeset. % \def\appendixletter{% \ifnum\appendixno=`A A% \else\ifnum\appendixno=`B B% \else\ifnum\appendixno=`C C% \else\ifnum\appendixno=`D D% \else\ifnum\appendixno=`E E% \else\ifnum\appendixno=`F F% \else\ifnum\appendixno=`G G% \else\ifnum\appendixno=`H H% \else\ifnum\appendixno=`I I% \else\ifnum\appendixno=`J J% \else\ifnum\appendixno=`K K% \else\ifnum\appendixno=`L L% \else\ifnum\appendixno=`M M% \else\ifnum\appendixno=`N N% \else\ifnum\appendixno=`O O% \else\ifnum\appendixno=`P P% \else\ifnum\appendixno=`Q Q% \else\ifnum\appendixno=`R R% \else\ifnum\appendixno=`S S% \else\ifnum\appendixno=`T T% \else\ifnum\appendixno=`U U% \else\ifnum\appendixno=`V V% \else\ifnum\appendixno=`W W% \else\ifnum\appendixno=`X X% \else\ifnum\appendixno=`Y Y% \else\ifnum\appendixno=`Z Z% % The \the is necessary, despite appearances, because \appendixletter is % expanded while writing the .toc file. \char\appendixno is not % expandable, thus it is written literally, thus all appendixes come out % with the same letter (or @) in the toc without it. \else\char\the\appendixno \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} % Each @chapter defines these (using marks) as the number+name, number % and name of the chapter. Page headings and footings can use % these. @section does likewise. \def\thischapter{} \def\thischapternum{} \def\thischaptername{} \def\thissection{} \def\thissectionnum{} \def\thissectionname{} \newcount\absseclevel % used to calculate proper heading level \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count % @raisesections: treat @section as chapter, @subsection as section, etc. \def\raisesections{\global\advance\secbase by -1} % @lowersections: treat @chapter as section, @section as subsection, etc. \def\lowersections{\global\advance\secbase by 1} % we only have subsub. \chardef\maxseclevel = 3 % % A numbered section within an unnumbered changes to unnumbered too. % To achieve this, remember the "biggest" unnum. sec. we are currently in: \chardef\unnlevel = \maxseclevel % % Trace whether the current chapter is an appendix or not: % \chapheadtype is "N" or "A", unnumbered chapters are ignored. \def\chapheadtype{N} % Choose a heading macro % #1 is heading type % #2 is heading level % #3 is text for heading \def\genhead#1#2#3{% % Compute the abs. sec. level: \absseclevel=#2 \advance\absseclevel by \secbase % Make sure \absseclevel doesn't fall outside the range: \ifnum \absseclevel < 0 \absseclevel = 0 \else \ifnum \absseclevel > 3 \absseclevel = 3 \fi \fi % The heading type: \def\headtype{#1}% \if \headtype U% \ifnum \absseclevel < \unnlevel \chardef\unnlevel = \absseclevel \fi \else % Check for appendix sections: \ifnum \absseclevel = 0 \edef\chapheadtype{\headtype}% \else \if \headtype A\if \chapheadtype N% \errmessage{@appendix... within a non-appendix chapter}% \fi\fi \fi % Check for numbered within unnumbered: \ifnum \absseclevel > \unnlevel \def\headtype{U}% \else \chardef\unnlevel = 3 \fi \fi % Now print the heading: \if \headtype U% \ifcase\absseclevel \unnumberedzzz{#3}% \or \unnumberedseczzz{#3}% \or \unnumberedsubseczzz{#3}% \or \unnumberedsubsubseczzz{#3}% \fi \else \if \headtype A% \ifcase\absseclevel \appendixzzz{#3}% \or \appendixsectionzzz{#3}% \or \appendixsubseczzz{#3}% \or \appendixsubsubseczzz{#3}% \fi \else \ifcase\absseclevel \chapterzzz{#3}% \or \seczzz{#3}% \or \numberedsubseczzz{#3}% \or \numberedsubsubseczzz{#3}% \fi \fi \fi \suppressfirstparagraphindent } % an interface: \def\numhead{\genhead N} \def\apphead{\genhead A} \def\unnmhead{\genhead U} % @chapter, @appendix, @unnumbered. Increment top-level counter, reset % all lower-level sectioning counters to zero. % % Also set \chaplevelprefix, which we prepend to @float sequence numbers % (e.g., figures), q.v. By default (before any chapter), that is empty. \let\chaplevelprefix = \empty % \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz \def\chapterzzz#1{% % section resetting is \global in case the chapter is in a group, such % as an @include file. \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\chapno by 1 % % Used for \float. \gdef\chaplevelprefix{\the\chapno.}% \resetallfloatnos % % \putwordChapter can contain complex things in translations. \toks0=\expandafter{\putwordChapter}% \message{\the\toks0 \space \the\chapno}% % % Write the actual heading. \chapmacro{#1}{Ynumbered}{\the\chapno}% % % So @section and the like are numbered underneath this chapter. \global\let\section = \numberedsec \global\let\subsection = \numberedsubsec \global\let\subsubsection = \numberedsubsubsec } \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz % \def\appendixzzz#1{% \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\appendixno by 1 \gdef\chaplevelprefix{\appendixletter.}% \resetallfloatnos % % \putwordAppendix can contain complex things in translations. \toks0=\expandafter{\putwordAppendix}% \message{\the\toks0 \space \appendixletter}% % \chapmacro{#1}{Yappendix}{\appendixletter}% % \global\let\section = \appendixsec \global\let\subsection = \appendixsubsec \global\let\subsubsection = \appendixsubsubsec } % normally unnmhead0 calls unnumberedzzz: \outer\parseargdef\unnumbered{\unnmhead0{#1}} \def\unnumberedzzz#1{% \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\unnumberedno by 1 % % Since an unnumbered has no number, no prefix for figures. \global\let\chaplevelprefix = \empty \resetallfloatnos % % This used to be simply \message{#1}, but TeX fully expands the % argument to \message. Therefore, if #1 contained @-commands, TeX % expanded them. For example, in `@unnumbered The @cite{Book}', TeX % expanded @cite (which turns out to cause errors because \cite is meant % to be executed, not expanded). % % Anyway, we don't want the fully-expanded definition of @cite to appear % as a result of the \message, we just want `@cite' itself. We use % \the to achieve this: TeX expands \the only once, % simply yielding the contents of . (We also do this for % the toc entries.) \toks0 = {#1}% \message{(\the\toks0)}% % \chapmacro{#1}{Ynothing}{\the\unnumberedno}% % \global\let\section = \unnumberedsec \global\let\subsection = \unnumberedsubsec \global\let\subsubsection = \unnumberedsubsubsec } % @centerchap is like @unnumbered, but the heading is centered. \outer\parseargdef\centerchap{% \let\centerparametersmaybe = \centerparameters \unnmhead0{#1}% \let\centerparametersmaybe = \relax } % @top is like @unnumbered. \let\top\unnumbered % Sections. % \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz \def\seczzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% } % normally calls appendixsectionzzz: \outer\parseargdef\appendixsection{\apphead1{#1}} \def\appendixsectionzzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% } \let\appendixsec\appendixsection % normally calls unnumberedseczzz: \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} \def\unnumberedseczzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% } % Subsections. % % normally calls numberedsubseczzz: \outer\parseargdef\numberedsubsec{\numhead2{#1}} \def\numberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% } % normally calls appendixsubseczzz: \outer\parseargdef\appendixsubsec{\apphead2{#1}} \def\appendixsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno}% } % normally calls unnumberedsubseczzz: \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} \def\unnumberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynothing}% {\the\unnumberedno.\the\secno.\the\subsecno}% } % Subsubsections. % % normally numberedsubsubseczzz: \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} \def\numberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynumbered}% {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% } % normally appendixsubsubseczzz: \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} \def\appendixsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% } % normally unnumberedsubsubseczzz: \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} \def\unnumberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynothing}% {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% } % These macros control what the section commands do, according % to what kind of chapter we are in (ordinary, appendix, or unnumbered). % Define them by default for a numbered chapter. \let\section = \numberedsec \let\subsection = \numberedsubsec \let\subsubsection = \numberedsubsubsec % Define @majorheading, @heading and @subheading \def\majorheading{% {\advance\chapheadingskip by 10pt \chapbreak }% \parsearg\chapheadingzzz } \def\chapheading{\chapbreak \parsearg\chapheadingzzz} \def\chapheadingzzz#1{% \vbox{\chapfonts \raggedtitlesettings #1\par}% \nobreak\bigskip \nobreak \suppressfirstparagraphindent } % @heading, @subheading, @subsubheading. \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} \suppressfirstparagraphindent} \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} \suppressfirstparagraphindent} \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} \suppressfirstparagraphindent} % These macros generate a chapter, section, etc. heading only % (including whitespace, linebreaking, etc. around it), % given all the information in convenient, parsed form. % Args are the skip and penalty (usually negative) \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} % Parameter controlling skip before chapter headings (if needed) \newskip\chapheadingskip % Define plain chapter starts, and page on/off switching for it. \def\chapbreak{\dobreak \chapheadingskip {-4000}} % Start a new page \def\chappager{\par\vfill\supereject} % \chapoddpage - start on an odd page for a new chapter % Because \domark is called before \chapoddpage, the filler page will % get the headings for the next chapter, which is wrong. But we don't % care -- we just disable all headings on the filler page. \def\chapoddpage{% \chappager \ifodd\pageno \else \begingroup \headingsoff \null \chappager \endgroup \fi } \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname} \def\CHAPPAGoff{% \global\let\contentsalignmacro = \chappager \global\let\pchapsepmacro=\chapbreak \global\def\HEADINGSon{\HEADINGSsinglechapoff}} \def\CHAPPAGon{% \global\let\contentsalignmacro = \chappager \global\let\pchapsepmacro=\chappager \global\def\HEADINGSon{\HEADINGSsingle}} \def\CHAPPAGodd{% \global\let\contentsalignmacro = \chapoddpage \global\let\pchapsepmacro=\chapoddpage \global\def\HEADINGSon{\HEADINGSdouble}} \CHAPPAGon % \chapmacro - Chapter opening. % % #1 is the text, #2 is the section type (Ynumbered, Ynothing, % Yappendix, Yomitfromtoc), #3 the chapter number. % Not used for @heading series. % % To test against our argument. \def\Ynothingkeyword{Ynothing} \def\Yappendixkeyword{Yappendix} \def\Yomitfromtockeyword{Yomitfromtoc} % \def\chapmacro#1#2#3{% \expandafter\ifx\thisenv\titlepage\else \checkenv{}% chapters, etc., should not start inside an environment. \fi % Insert the first mark before the heading break (see notes for \domark). \let\prevchapterdefs=\currentchapterdefs \let\prevsectiondefs=\currentsectiondefs \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}% \gdef\thissection{}}% % \def\temptype{#2}% \ifx\temptype\Ynothingkeyword \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% \gdef\thischapter{\thischaptername}}% \else\ifx\temptype\Yomitfromtockeyword \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% \gdef\thischapter{}}% \else\ifx\temptype\Yappendixkeyword \toks0={#1}% \xdef\currentchapterdefs{% \gdef\noexpand\thischaptername{\the\toks0}% \gdef\noexpand\thischapternum{\appendixletter}% % \noexpand\putwordAppendix avoids expanding indigestible % commands in some of the translations. \gdef\noexpand\thischapter{\noexpand\putwordAppendix{} \noexpand\thischapternum: \noexpand\thischaptername}% }% \else \toks0={#1}% \xdef\currentchapterdefs{% \gdef\noexpand\thischaptername{\the\toks0}% \gdef\noexpand\thischapternum{\the\chapno}% % \noexpand\putwordChapter avoids expanding indigestible % commands in some of the translations. \gdef\noexpand\thischapter{\noexpand\putwordChapter{} \noexpand\thischapternum: \noexpand\thischaptername}% }% \fi\fi\fi % % Output the mark. Pass it through \safewhatsit, to take care of % the preceding space. \safewhatsit\domark % % Insert the chapter heading break. \pchapsepmacro % % Now the second mark, after the heading break. No break points % between here and the heading. \let\prevchapterdefs=\currentchapterdefs \let\prevsectiondefs=\currentsectiondefs \domark % {% \chapfonts \rm \let\footnote=\errfootnoteheading % give better error message % % Have to define \currentsection before calling \donoderef, because the % xref code eventually uses it. On the other hand, it has to be called % after \pchapsepmacro, or the headline will change too soon. \gdef\currentsection{#1}% % % Only insert the separating space if we have a chapter/appendix % number, and don't print the unnumbered ``number''. \ifx\temptype\Ynothingkeyword \setbox0 = \hbox{}% \def\toctype{unnchap}% \else\ifx\temptype\Yomitfromtockeyword \setbox0 = \hbox{}% contents like unnumbered, but no toc entry \def\toctype{omit}% \else\ifx\temptype\Yappendixkeyword \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% \def\toctype{app}% \else \setbox0 = \hbox{#3\enspace}% \def\toctype{numchap}% \fi\fi\fi % % Write the toc entry for this chapter. Must come before the % \donoderef, because we include the current node name in the toc % entry, and \donoderef resets it to empty. \writetocentry{\toctype}{#1}{#3}% % % For pdftex, we have to write out the node definition (aka, make % the pdfdest) after any page break, but before the actual text has % been typeset. If the destination for the pdf outline is after the % text, then jumping from the outline may wind up with the text not % being visible, for instance under high magnification. \donoderef{#2}% % % Typeset the actual heading. \nobreak % Avoid page breaks at the interline glue. \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe \unhbox0 #1\par}% }% \nobreak\bigskip % no page break after a chapter title \nobreak } % @centerchap -- centered and unnumbered. \let\centerparametersmaybe = \relax \def\centerparameters{% \advance\rightskip by 3\rightskip \leftskip = \rightskip \parfillskip = 0pt } % Section titles. These macros combine the section number parts and % call the generic \sectionheading to do the printing. % \newskip\secheadingskip \def\secheadingbreak{\dobreak \secheadingskip{-1000}} % Subsection titles. \newskip\subsecheadingskip \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} % Subsubsection titles. \def\subsubsecheadingskip{\subsecheadingskip} \def\subsubsecheadingbreak{\subsecheadingbreak} % Print any size, any type, section title. % % #1 is the text of the title, % #2 is the section level (sec/subsec/subsubsec), % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc), % #4 is the section number. % \def\seckeyword{sec} % \def\sectionheading#1#2#3#4{% {% \def\sectionlevel{#2}% \def\temptype{#3}% % % It is ok for the @heading series commands to appear inside an % environment (it's been historically allowed, though the logic is % dubious), but not the others. \ifx\temptype\Yomitfromtockeyword\else \checkenv{}% non-@*heading should not be in an environment. \fi \let\footnote=\errfootnoteheading % % Switch to the right set of fonts. \csname #2fonts\endcsname \rm % % Insert first mark before the heading break (see notes for \domark). \let\prevsectiondefs=\currentsectiondefs \ifx\temptype\Ynothingkeyword \ifx\sectionlevel\seckeyword \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}% \gdef\thissection{\thissectionname}}% \fi \else\ifx\temptype\Yomitfromtockeyword % Don't redefine \thissection. \else\ifx\temptype\Yappendixkeyword \ifx\sectionlevel\seckeyword \toks0={#1}% \xdef\currentsectiondefs{% \gdef\noexpand\thissectionname{\the\toks0}% \gdef\noexpand\thissectionnum{#4}% % \noexpand\putwordSection avoids expanding indigestible % commands in some of the translations. \gdef\noexpand\thissection{\noexpand\putwordSection{} \noexpand\thissectionnum: \noexpand\thissectionname}% }% \fi \else \ifx\sectionlevel\seckeyword \toks0={#1}% \xdef\currentsectiondefs{% \gdef\noexpand\thissectionname{\the\toks0}% \gdef\noexpand\thissectionnum{#4}% % \noexpand\putwordSection avoids expanding indigestible % commands in some of the translations. \gdef\noexpand\thissection{\noexpand\putwordSection{} \noexpand\thissectionnum: \noexpand\thissectionname}% }% \fi \fi\fi\fi % % Go into vertical mode. Usually we'll already be there, but we % don't want the following whatsit to end up in a preceding paragraph % if the document didn't happen to have a blank line. \par % % Output the mark. Pass it through \safewhatsit, to take care of % the preceding space. \safewhatsit\domark % % Insert space above the heading. \csname #2headingbreak\endcsname % % Now the second mark, after the heading break. No break points % between here and the heading. \global\let\prevsectiondefs=\currentsectiondefs \domark % % Only insert the space after the number if we have a section number. \ifx\temptype\Ynothingkeyword \setbox0 = \hbox{}% \def\toctype{unn}% \gdef\currentsection{#1}% \else\ifx\temptype\Yomitfromtockeyword % for @headings -- no section number, don't include in toc, % and don't redefine \currentsection. \setbox0 = \hbox{}% \def\toctype{omit}% \let\sectionlevel=\empty \else\ifx\temptype\Yappendixkeyword \setbox0 = \hbox{#4\enspace}% \def\toctype{app}% \gdef\currentsection{#1}% \else \setbox0 = \hbox{#4\enspace}% \def\toctype{num}% \gdef\currentsection{#1}% \fi\fi\fi % % Write the toc entry (before \donoderef). See comments in \chapmacro. \writetocentry{\toctype\sectionlevel}{#1}{#4}% % % Write the node reference (= pdf destination for pdftex). % Again, see comments in \chapmacro. \donoderef{#3}% % % Interline glue will be inserted when the vbox is completed. % That glue will be a valid breakpoint for the page, since it'll be % preceded by a whatsit (usually from the \donoderef, or from the % \writetocentry if there was no node). We don't want to allow that % break, since then the whatsits could end up on page n while the % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. \nobreak % % Output the actual section heading. \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright \hangindent=\wd0 % zero if no section number \unhbox0 #1}% }% % Add extra space after the heading -- half of whatever came above it. % Don't allow stretch, though. \kern .5 \csname #2headingskip\endcsname % % Do not let the kern be a potential breakpoint, as it would be if it % was followed by glue. \nobreak % % We'll almost certainly start a paragraph next, so don't let that % glue accumulate. (Not a breakpoint because it's preceded by a % discardable item.) However, when a paragraph is not started next % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out % or the negative glue will cause weirdly wrong output, typically % obscuring the section heading with something else. \vskip-\parskip % % This is so the last item on the main vertical list is a known % \penalty > 10000, so \startdefun, etc., can recognize the situation % and do the needful. \penalty 10001 } \message{toc,} % Table of contents. \newwrite\tocfile % Write an entry to the toc file, opening it if necessary. % Called from @chapter, etc. % % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} % We append the current node name (if any) and page number as additional % arguments for the \{chap,sec,...}entry macros which will eventually % read this. The node name is used in the pdf outlines as the % destination to jump to. % % We open the .toc file for writing here instead of at @setfilename (or % any other fixed time) so that @contents can be anywhere in the document. % But if #1 is `omit', then we don't do anything. This is used for the % table of contents chapter openings themselves. % \newif\iftocfileopened \def\omitkeyword{omit}% % \def\writetocentry#1#2#3{% \edef\writetoctype{#1}% \ifx\writetoctype\omitkeyword \else \iftocfileopened\else \immediate\openout\tocfile = \jobname.toc \global\tocfileopenedtrue \fi % \iflinks {\atdummies \edef\temp{% \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% \temp }% \fi \fi % % Tell \shipout to create a pdf destination on each page, if we're % writing pdf. These are used in the table of contents. We can't % just write one on every page because the title pages are numbered % 1 and 2 (the page numbers aren't printed), and so are the first % two pages of the document. Thus, we'd have two destinations named % `1', and two named `2'. \ifpdforxetex \global\pdfmakepagedesttrue \fi } % These characters do not print properly in the Computer Modern roman % fonts, so we must take special care. This is more or less redundant % with the Texinfo input format setup at the end of this file. % \def\activecatcodes{% \catcode`\"=\active \catcode`\$=\active \catcode`\<=\active \catcode`\>=\active \catcode`\\=\active \catcode`\^=\active \catcode`\_=\active \catcode`\|=\active \catcode`\~=\active } % Read the toc file, which is essentially Texinfo input. \def\readtocfile{% \setupdatafile \activecatcodes \input \tocreadfilename } \newskip\contentsrightmargin \contentsrightmargin=1in \newcount\savepageno \newcount\lastnegativepageno \lastnegativepageno = -1 % Prepare to read what we've written to \tocfile. % \def\startcontents#1{% % If @setchapternewpage on, and @headings double, the contents should % start on an odd page, unlike chapters. \contentsalignmacro \immediate\closeout\tocfile % % Don't need to put `Contents' or `Short Contents' in the headline. % It is abundantly clear what they are. \chapmacro{#1}{Yomitfromtoc}{}% % \savepageno = \pageno \begingroup % Set up to handle contents files properly. \raggedbottom % Worry more about breakpoints than the bottom. \entryrightmargin=\contentsrightmargin % Don't use the full line length. % % Roman numerals for page numbers. \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi \def\thistitle{}% no title in double-sided headings % Record where the Roman numerals started. \ifnum\romancount=0 \global\romancount=\pagecount \fi } % redefined for the two-volume lispref. We always output on % \jobname.toc even if this is redefined. % \def\tocreadfilename{\jobname.toc} % Normal (long) toc. % \def\contents{% \startcontents{\putwordTOC}% \openin 1 \tocreadfilename\space \ifeof 1 \else \readtocfile \fi \vfill \eject \contentsalignmacro % in case @setchapternewpage odd is in effect \ifeof 1 \else \pdfmakeoutlines \fi \closein 1 \endgroup \contentsendroman } % And just the chapters. \def\summarycontents{% \startcontents{\putwordShortTOC}% % \let\partentry = \shortpartentry \let\numchapentry = \shortchapentry \let\appentry = \shortchapentry \let\unnchapentry = \shortunnchapentry % We want a true roman here for the page numbers. \secfonts \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl \let\tt=\shortconttt \rm \hyphenpenalty = 10000 \advance\baselineskip by 1pt % Open it up a little. \def\numsecentry##1##2##3##4{} \let\appsecentry = \numsecentry \let\unnsecentry = \numsecentry \let\numsubsecentry = \numsecentry \let\appsubsecentry = \numsecentry \let\unnsubsecentry = \numsecentry \let\numsubsubsecentry = \numsecentry \let\appsubsubsecentry = \numsecentry \let\unnsubsubsecentry = \numsecentry \openin 1 \tocreadfilename\space \ifeof 1 \else \readtocfile \fi \closein 1 \vfill \eject \contentsalignmacro % in case @setchapternewpage odd is in effect \endgroup \contentsendroman } \let\shortcontents = \summarycontents % Get ready to use Arabic numerals again \def\contentsendroman{% \lastnegativepageno = \pageno \global\pageno = \savepageno % % If \romancount > \arabiccount, the contents are at the end of the % document. Otherwise, advance where the Arabic numerals start for % the page numbers. \ifnum\romancount>\arabiccount\else\global\arabiccount=\pagecount\fi } % Typeset the label for a chapter or appendix for the short contents. % The arg is, e.g., `A' for an appendix, or `3' for a chapter. % \def\shortchaplabel#1{% % This space should be enough, since a single number is .5em, and the % widest letter (M) is 1em, at least in the Computer Modern fonts. % But use \hss just in case. % (This space doesn't include the extra space that gets added after % the label; that gets put in by \shortchapentry above.) % % We'd like to right-justify chapter numbers, but that looks strange % with appendix letters. And right-justifying numbers and % left-justifying letters looks strange when there is less than 10 % chapters. Have to read the whole toc once to know how many chapters % there are before deciding ... \hbox to 1em{#1\hss}% } % These macros generate individual entries in the table of contents. % The first argument is the chapter or section name. % The last argument is the page number. % The arguments in between are the chapter number, section number, ... % Parts, in the main contents. Replace the part number, which doesn't % exist, with an empty box. Let's hope all the numbers have the same width. % Also ignore the page number, which is conventionally not printed. \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}} \def\partentry#1#2#3#4{% % Add stretch and a bonus for breaking the page before the part heading. % This reduces the chance of the page being broken immediately after the % part heading, before a following chapter heading. \vskip 0pt plus 5\baselineskip \penalty-300 \vskip 0pt plus -5\baselineskip \dochapentry{\numeralbox\labelspace#1}{}% } % % Parts, in the short toc. \def\shortpartentry#1#2#3#4{% \penalty-300 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip \shortchapentry{{\bf #1}}{\numeralbox}{}{}% } % Chapters, in the main contents. \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} % Chapters, in the short toc. % See comments in \dochapentry re vbox and related settings. \def\shortchapentry#1#2#3#4{% \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% } % Appendices, in the main contents. % Need the word Appendix, and a fixed-size box. % \def\appendixbox#1{% % We use M since it's probably the widest letter. \setbox0 = \hbox{\putwordAppendix{} M}% \hbox to \wd0{\putwordAppendix{} #1\hss}} % \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}} % Unnumbered chapters. \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} % Sections. \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} \let\appsecentry=\numsecentry \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} % Subsections. \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} \let\appsubsecentry=\numsubsecentry \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} % And subsubsections. \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} \let\appsubsubsecentry=\numsubsubsecentry \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} % This parameter controls the indentation of the various levels. % Same as \defaultparindent. \newdimen\tocindent \tocindent = 15pt % Now for the actual typesetting. In all these, #1 is the text and #2 is the % page number. % % If the toc has to be broken over pages, we want it to be at chapters % if at all possible; hence the \penalty. \def\dochapentry#1#2{% \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip \begingroup % Move the page numbers slightly to the right \advance\entryrightmargin by -0.05em \chapentryfonts \tocentry{#1}{\dopageno\bgroup#2\egroup}% \endgroup \nobreak\vskip .25\baselineskip plus.1\baselineskip } \def\dosecentry#1#2{\begingroup \secentryfonts \leftskip=\tocindent \tocentry{#1}{\dopageno\bgroup#2\egroup}% \endgroup} \def\dosubsecentry#1#2{\begingroup \subsecentryfonts \leftskip=2\tocindent \tocentry{#1}{\dopageno\bgroup#2\egroup}% \endgroup} \def\dosubsubsecentry#1#2{\begingroup \subsubsecentryfonts \leftskip=3\tocindent \tocentry{#1}{\dopageno\bgroup#2\egroup}% \endgroup} % We use the same \entry macro as for the index entries. \let\tocentry = \entry % Space between chapter (or whatever) number and the title. \def\labelspace{\hskip1em \relax} \def\dopageno#1{{\rm #1}} \def\doshortpageno#1{{\rm #1}} \def\chapentryfonts{\secfonts \rm} \def\secentryfonts{\textfonts} \def\subsecentryfonts{\textfonts} \def\subsubsecentryfonts{\textfonts} \message{environments,} % @foo ... @end foo. % @tex ... @end tex escapes into raw TeX temporarily. % One exception: @ is still an escape character, so that @end tex works. % But \@ or @@ will get a plain @ character. \envdef\tex{% \setupmarkupstyle{tex}% \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie \catcode `\%=14 \catcode `\+=\other \catcode `\"=\other \catcode `\|=\other \catcode `\<=\other \catcode `\>=\other \catcode `\`=\other \catcode `\'=\other % % ' is active in math mode (mathcode"8000). So reset it, and all our % other math active characters (just in case), to plain's definitions. \mathactive % % Inverse of the list at the beginning of the file. \let\b=\ptexb \let\bullet=\ptexbullet \let\c=\ptexc \let\,=\ptexcomma \let\.=\ptexdot \let\dots=\ptexdots \let\equiv=\ptexequiv \let\!=\ptexexclam \let\i=\ptexi \let\indent=\ptexindent \let\noindent=\ptexnoindent \let\{=\ptexlbrace \let\+=\tabalign \let\}=\ptexrbrace \let\/=\ptexslash \let\sp=\ptexsp \let\*=\ptexstar %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode \let\t=\ptext \expandafter \let\csname top\endcsname=\ptextop % we've made it outer \let\frenchspacing=\plainfrenchspacing % \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% \def\@{@}% } % There is no need to define \Etex. % Define @lisp ... @end lisp. % @lisp environment forms a group so it can rebind things, % including the definition of @end lisp (which normally is erroneous). % Amount to narrow the margins by for @lisp. \newskip\lispnarrowing \lispnarrowing=0.4in % This is the definition that ^^M gets inside @lisp, @example, and other % such environments. \null is better than a space, since it doesn't % have any width. \def\lisppar{\null\endgraf} % This space is always present above and below environments. \newskip\envskipamount \envskipamount = 0pt % Make spacing and below environment symmetrical. We use \parskip here % to help in doing that, since in @example-like environments \parskip % is reset to zero; thus the \afterenvbreak inserts no space -- but the % start of the next paragraph will insert \parskip. % \def\aboveenvbreak{{% % =10000 instead of <10000 because of a special case in \itemzzz and % \sectionheading, q.v. \ifnum \lastpenalty=10000 \else \advance\envskipamount by \parskip \endgraf \ifdim\lastskip<\envskipamount \removelastskip \ifnum\lastpenalty<10000 % Penalize breaking before the environment, because preceding text % often leads into it. \penalty100 \fi \vskip\envskipamount \fi \fi }} \def\afterenvbreak{{% % =10000 instead of <10000 because of a special case in \itemzzz and % \sectionheading, q.v. \ifnum \lastpenalty=10000 \else \advance\envskipamount by \parskip \endgraf \ifdim\lastskip<\envskipamount \removelastskip % it's not a good place to break if the last penalty was \nobreak % or better ... \ifnum\lastpenalty<10000 \penalty-50 \fi \vskip\envskipamount \fi \fi }} % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will % also clear it, so that its embedded environments do the narrowing again. \let\nonarrowing=\relax % @cartouche ... @end cartouche: draw rectangle w/rounded corners around % environment contents. % \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth \def\ctr{{\hskip 6pt\circle\char'010}} \def\cbl{{\circle\char'012\hskip -6pt}} \def\cbr{{\hskip 6pt\circle\char'011}} \def\carttop{\hbox to \cartouter{\hskip\lskip \ctl\leaders\hrule height\circthick\hfil\ctr \hskip\rskip}} \def\cartbot{\hbox to \cartouter{\hskip\lskip \cbl\leaders\hrule height\circthick\hfil\cbr \hskip\rskip}} % \newskip\lskip\newskip\rskip % only require the font if @cartouche is actually used \def\cartouchefontdefs{% \font\circle=lcircle10\relax \circthick=\fontdimen8\circle } \newdimen\circthick \newdimen\cartouter\newdimen\cartinner \newskip\normbskip\newskip\normpskip\newskip\normlskip \envdef\cartouche{% \cartouchefontdefs \ifhmode\par\fi % can't be in the midst of a paragraph. \startsavinginserts \lskip=\leftskip \rskip=\rightskip \leftskip=0pt\rightskip=0pt % we want these *outside*. \cartinner=\hsize \advance\cartinner by-\lskip \advance\cartinner by-\rskip \cartouter=\hsize \advance\cartouter by 18.4pt % allow for 3pt kerns on either % side, and for 6pt waste from % each corner char, and rule thickness \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip % % If this cartouche directly follows a sectioning command, we need the % \parskip glue (backspaced over by default) or the cartouche can % collide with the section heading. \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi % \setbox\groupbox=\vbox\bgroup \baselineskip=0pt\parskip=0pt\lineskip=0pt \carttop \hbox\bgroup \hskip\lskip \vrule\kern3pt \vbox\bgroup \kern3pt \hsize=\cartinner \baselineskip=\normbskip \lineskip=\normlskip \parskip=\normpskip \vskip -\parskip \comment % For explanation, see the end of def\group. } \def\Ecartouche{% \ifhmode\par\fi \kern3pt \egroup \kern3pt\vrule \hskip\rskip \egroup \cartbot \egroup \addgroupbox \checkinserts } % This macro is called at the beginning of all the @example variants, % inside a group. \newdimen\nonfillparindent \def\nonfillstart{% \aboveenvbreak \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy \sepspaces % Make spaces be word-separators rather than space tokens. \let\par = \lisppar % don't ignore blank lines \obeylines % each line of input is a line of output \parskip = 0pt % Turn off paragraph indentation but redefine \indent to emulate % the normal \indent. \nonfillparindent=\parindent \parindent = 0pt \let\indent\nonfillindent % \emergencystretch = 0pt % don't try to avoid overfull boxes \ifx\nonarrowing\relax \advance \leftskip by \lispnarrowing \exdentamount=\lispnarrowing \else \let\nonarrowing = \relax \fi \let\exdent=\nofillexdent } \begingroup \obeyspaces % We want to swallow spaces (but not other tokens) after the fake % @indent in our nonfill-environments, where spaces are normally % active and set to @tie, resulting in them not being ignored after % @indent. \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}% \gdef\nonfillindentcheck{% \ifx\temp % \expandafter\nonfillindentgobble% \else% \leavevmode\nonfillindentbox% \fi% }% \endgroup \def\nonfillindentgobble#1{\nonfillindent} \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}} % If you want all examples etc. small: @set dispenvsize small. % If you want even small examples the full size: @set dispenvsize nosmall. % This affects the following displayed environments: % @example, @display, @format, @lisp % \def\smallword{small} \def\nosmallword{nosmall} \let\SETdispenvsize\relax \def\setnormaldispenv{% \ifx\SETdispenvsize\smallword % end paragraph for sake of leading, in case document has no blank % line. This is redundant with what happens in \aboveenvbreak, but % we need to do it before changing the fonts, and it's inconvenient % to change the fonts afterward. \ifnum \lastpenalty=10000 \else \endgraf \fi \smallexamplefonts \rm \fi } \def\setsmalldispenv{% \ifx\SETdispenvsize\nosmallword \else \ifnum \lastpenalty=10000 \else \endgraf \fi \smallexamplefonts \rm \fi } % We often define two environments, @foo and @smallfoo. % Let's do it in one command. #1 is the env name, #2 the definition. \def\makedispenvdef#1#2{% \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}% \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}% \expandafter\let\csname E#1\endcsname \afterenvbreak \expandafter\let\csname Esmall#1\endcsname \afterenvbreak } % Define two environment synonyms (#1 and #2) for an environment. \def\maketwodispenvdef#1#2#3{% \makedispenvdef{#1}{#3}% \makedispenvdef{#2}{#3}% } % % @lisp: indented, narrowed, typewriter font; % @example: same as @lisp. % % @smallexample and @smalllisp: use smaller fonts. % Originally contributed by Pavel@xerox. % \maketwodispenvdef{lisp}{example}{% \nonfillstart \tt\setupmarkupstyle{example}% \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. \gobble % eat return } % @display/@smalldisplay: same as @lisp except keep current font. % \makedispenvdef{display}{% \nonfillstart \gobble } % @format/@smallformat: same as @display except don't narrow margins. % \makedispenvdef{format}{% \let\nonarrowing = t% \nonfillstart \gobble } % @flushleft: same as @format, but doesn't obey \SETdispenvsize. \envdef\flushleft{% \let\nonarrowing = t% \nonfillstart \gobble } \let\Eflushleft = \afterenvbreak % @flushright. % \envdef\flushright{% \let\nonarrowing = t% \nonfillstart \advance\leftskip by 0pt plus 1fill\relax \gobble } \let\Eflushright = \afterenvbreak % @raggedright does more-or-less normal line breaking but no right % justification. From plain.tex. \envdef\raggedright{% \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax } \let\Eraggedright\par \envdef\raggedleft{% \parindent=0pt \leftskip0pt plus2em \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt \hbadness=10000 % Last line will usually be underfull, so turn off % badness reporting. } \let\Eraggedleft\par \envdef\raggedcenter{% \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt \hbadness=10000 % Last line will usually be underfull, so turn off % badness reporting. } \let\Eraggedcenter\par % @quotation does normal linebreaking (hence we can't use \nonfillstart) % and narrows the margins. We keep \parskip nonzero in general, since % we're doing normal filling. So, when using \aboveenvbreak and % \afterenvbreak, temporarily make \parskip 0. % \makedispenvdef{quotation}{\quotationstart} % \def\quotationstart{% \indentedblockstart % same as \indentedblock, but increase right margin too. \ifx\nonarrowing\relax \advance\rightskip by \lispnarrowing \fi \parsearg\quotationlabel } % We have retained a nonzero parskip for the environment, since we're % doing normal filling. % \def\Equotation{% \par \ifx\quotationauthor\thisisundefined\else % indent a bit. \leftline{\kern 2\leftskip \sl ---\quotationauthor}% \fi {\parskip=0pt \afterenvbreak}% } \def\Esmallquotation{\Equotation} % If we're given an argument, typeset it in bold with a colon after. \def\quotationlabel#1{% \def\temp{#1}% \ifx\temp\empty \else {\bf #1: }% \fi } % @indentedblock is like @quotation, but indents only on the left and % has no optional argument. % \makedispenvdef{indentedblock}{\indentedblockstart} % \def\indentedblockstart{% {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip \parindent=0pt % % @cartouche defines \nonarrowing to inhibit narrowing at next level down. \ifx\nonarrowing\relax \advance\leftskip by \lispnarrowing \exdentamount = \lispnarrowing \else \let\nonarrowing = \relax \fi } % Keep a nonzero parskip for the environment, since we're doing normal filling. % \def\Eindentedblock{% \par {\parskip=0pt \afterenvbreak}% } \def\Esmallindentedblock{\Eindentedblock} % LaTeX-like @verbatim...@end verbatim and @verb{...} % If we want to allow any as delimiter, % we need the curly braces so that makeinfo sees the @verb command, eg: % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org % % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. % % [Knuth] p.344; only we need to do the other characters Texinfo sets % active too. Otherwise, they get lost as the first character on a % verbatim line. \def\dospecials{% \do\ \do\\\do\{\do\}\do\$\do\&% \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% \do\<\do\>\do\|\do\@\do+\do\"% % Don't do the quotes -- if we do, @set txicodequoteundirected and % @set txicodequotebacktick will not have effect on @verb and % @verbatim, and ?` and !` ligatures won't get disabled. %\do\`\do\'% } % % [Knuth] p. 380 \def\uncatcodespecials{% \def\do##1{\catcode`##1=\other}\dospecials} % % Setup for the @verb command. % % Eight spaces for a tab \begingroup \catcode`\^^I=\active \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} \endgroup % \def\setupverb{% \tt % easiest (and conventionally used) font for verbatim \def\par{\leavevmode\endgraf}% \setupmarkupstyle{verb}% \tabeightspaces % Respect line breaks, % print special symbols as themselves, and % make each space count % must do in this order: \obeylines \uncatcodespecials \sepspaces } % Setup for the @verbatim environment % % Real tab expansion. \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount % % We typeset each line of the verbatim in an \hbox, so we can handle % tabs. \newbox\verbbox \def\starttabbox{\setbox\verbbox=\hbox\bgroup} % \begingroup \catcode`\^^I=\active \gdef\tabexpand{% \catcode`\^^I=\active \def^^I{\leavevmode\egroup \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab \divide\dimen\verbbox by\tabw \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw \wd\verbbox=\dimen\verbbox \leavevmode\box\verbbox \starttabbox }% } \endgroup % start the verbatim environment. \def\setupverbatim{% \let\nonarrowing = t% \nonfillstart \tt % easiest (and conventionally used) font for verbatim \def\par{\egroup\leavevmode\box\verbbox\endgraf\starttabbox}% \tabexpand \setupmarkupstyle{verbatim}% % Respect line breaks, % print special symbols as themselves, and % make each space count. % Must do in this order: \obeylines \uncatcodespecials \sepspaces } % Do the @verb magic: verbatim text is quoted by unique % delimiter characters. Before first delimiter expect a % right brace, after last delimiter expect closing brace: % % \def\doverb'{'#1'}'{#1} % % [Knuth] p. 382; only eat outer {} \begingroup \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] \endgroup % \def\verb{\begingroup\setupverb\doverb} % % % Do the @verbatim magic: define the macro \doverbatim so that % the (first) argument ends when '@end verbatim' is reached, ie: % % \def\doverbatim#1@end verbatim{#1} % % For Texinfo it's a lot easier than for LaTeX, % because texinfo's \verbatim doesn't stop at '\end{verbatim}': % we need not redefine '\', '{' and '}'. % % Inspired by LaTeX's verbatim command set [latex.ltx] % \begingroup \catcode`\ =\active \obeylines % % ignore everything up to the first ^^M, that's the newline at the end % of the @verbatim input line itself. Otherwise we get an extra blank % line in the output. \xdef\doverbatim#1^^M#2@end verbatim{% \starttabbox#2\egroup\noexpand\end\gobble verbatim}% % We really want {...\end verbatim} in the body of the macro, but % without the active space; thus we have to use \xdef and \gobble. % The \egroup ends the \verbbox started at the end of the last line in % the block. \endgroup % \envdef\verbatim{% \setnormaldispenv\setupverbatim\doverbatim } \let\Everbatim = \afterenvbreak % @verbatiminclude FILE - insert text of file in verbatim environment. % \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} % \def\doverbatiminclude#1{% {% \makevalueexpandable \setupverbatim {% \indexnofonts % Allow `@@' and other weird things in file names. \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}% \edef\tmp{\noexpand\input #1 } \expandafter }\expandafter\starttabbox\tmp\egroup \afterenvbreak }% } % @copying ... @end copying. % Save the text away for @insertcopying later. % % We save the uninterpreted tokens, rather than creating a box. % Saving the text in a box would be much easier, but then all the % typesetting commands (@smallbook, font changes, etc.) have to be done % beforehand -- and a) we want @copying to be done first in the source % file; b) letting users define the frontmatter in as flexible order as % possible is desirable. % \def\copying{\checkenv{}\begingroup\scanargctxt\docopying} \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} % \def\insertcopying{% \begingroup \parindent = 0pt % paragraph indentation looks wrong on title page \scanexp\copyingtext \endgroup } \message{defuns,} % @defun etc. \newskip\defbodyindent \defbodyindent=.4in \newskip\defargsindent \defargsindent=50pt \newskip\deflastargmargin \deflastargmargin=18pt \newcount\defunpenalty % Start the processing of @deffn: \def\startdefun{% \ifnum\lastpenalty<10000 \medbreak \defunpenalty=10003 % Will keep this @deffn together with the % following @def command, see below. \else % If there are two @def commands in a row, we'll have a \nobreak, % which is there to keep the function description together with its % header. But if there's nothing but headers, we need to allow a % break somewhere. Check specifically for penalty 10002, inserted % by \printdefunline, instead of 10000, since the sectioning % commands also insert a nobreak penalty, and we don't want to allow % a break between a section heading and a defun. % % As a further refinement, we avoid "club" headers by signalling % with penalty of 10003 after the very first @deffn in the % sequence (see above), and penalty of 10002 after any following % @def command. \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi % % Similarly, after a section heading, do not allow a break. % But do insert the glue. \medskip % preceded by discardable penalty, so not a breakpoint \fi % \parindent=0in \advance\leftskip by \defbodyindent \exdentamount=\defbodyindent } \def\dodefunx#1{% % First, check whether we are in the right environment: \checkenv#1% % % As above, allow line break if we have multiple x headers in a row. % It's not a great place, though. \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi % % And now, it's time to reuse the body of the original defun: \expandafter\gobbledefun#1% } \def\gobbledefun#1\startdefun{} % \printdefunline \deffnheader{text} % \def\printdefunline#1#2{% \begingroup % call \deffnheader: #1#2 \endheader % common ending: \interlinepenalty = 10000 \advance\rightskip by 0pt plus 1fil\relax \endgraf \nobreak\vskip -\parskip \penalty\defunpenalty % signal to \startdefun and \dodefunx % Some of the @defun-type tags do not enable magic parentheses, % rendering the following check redundant. But we don't optimize. \checkparencounts \endgroup } \def\Edefun{\endgraf\medbreak} % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; % the only thing remaining is to define \deffnheader. % \def\makedefun#1{% \expandafter\let\csname E#1\endcsname = \Edefun \edef\temp{\noexpand\domakedefun \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% \temp } % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) } % % Define \deffn and \deffnx, without parameters. % \deffnheader has to be defined explicitly. % \def\domakedefun#1#2#3{% \envdef#1{% \startdefun \doingtypefnfalse % distinguish typed functions from all else \parseargusing\activeparens{\printdefunline#3}% }% \def#2{\dodefunx#1}% \def#3% } \newif\ifdoingtypefn % doing typed function? \newif\ifrettypeownline % typeset return type on its own line? % @deftypefnnewline on|off says whether the return type of typed functions % are printed on their own line. This affects @deftypefn, @deftypefun, % @deftypeop, and @deftypemethod. % \parseargdef\deftypefnnewline{% \def\temp{#1}% \ifx\temp\onword \expandafter\let\csname SETtxideftypefnnl\endcsname = \empty \else\ifx\temp\offword \expandafter\let\csname SETtxideftypefnnl\endcsname = \relax \else \errhelp = \EMsimple \errmessage{Unknown @txideftypefnnl value `\temp', must be on|off}% \fi\fi } % \dosubind {index}{topic}{subtopic} % % If SUBTOPIC is present, precede it with a space, and call \doind. % (At some time during the 20th century, this made a two-level entry in an % index such as the operation index. Nobody seemed to notice the change in % behaviour though.) \def\dosubind#1#2#3{% \def\thirdarg{#3}% \ifx\thirdarg\empty \doind{#1}{#2}% \else \doind{#1}{#2\space#3}% \fi } % Untyped functions: % @deffn category name args \makedefun{deffn}{\deffngeneral{}} % @deffn category class name args \makedefun{defop}#1 {\defopon{#1\ \putwordon}} % \defopon {category on}class name args \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } % \deffngeneral {subind}category name args % \def\deffngeneral#1#2 #3 #4\endheader{% \dosubind{fn}{\code{#3}}{#1}% \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% } % Typed functions: % @deftypefn category type name args \makedefun{deftypefn}{\deftypefngeneral{}} % @deftypeop category class type name args \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} % \deftypeopon {category on}class type name args \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } % \deftypefngeneral {subind}category type name args % \def\deftypefngeneral#1#2 #3 #4 #5\endheader{% \dosubind{fn}{\code{#4}}{#1}% \doingtypefntrue \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } % Typed variables: % @deftypevr category type var args \makedefun{deftypevr}{\deftypecvgeneral{}} % @deftypecv category class type var args \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} % \deftypecvof {category of}class type var args \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } % \deftypecvgeneral {subind}category type var args % \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% \dosubind{vr}{\code{#4}}{#1}% \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } % Untyped variables: % @defvr category var args \makedefun{defvr}#1 {\deftypevrheader{#1} {} } % @defcv category class var args \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} % \defcvof {category of}class var args \def\defcvof#1#2 {\deftypecvof{#1}#2 {} } % Types: % @deftp category name args \makedefun{deftp}#1 #2 #3\endheader{% \doind{tp}{\code{#2}}% \defname{#1}{}{#2}\defunargs{#3\unskip}% } % Remaining @defun-like shortcuts: \makedefun{defun}{\deffnheader{\putwordDeffunc} } \makedefun{defmac}{\deffnheader{\putwordDefmac} } \makedefun{defspec}{\deffnheader{\putwordDefspec} } \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } \makedefun{defvar}{\defvrheader{\putwordDefvar} } \makedefun{defopt}{\defvrheader{\putwordDefopt} } \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } \makedefun{defmethod}{\defopon\putwordMethodon} \makedefun{deftypemethod}{\deftypeopon\putwordMethodon} \makedefun{defivar}{\defcvof\putwordInstanceVariableof} \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} % \defname, which formats the name of the @def (not the args). % #1 is the category, such as "Function". % #2 is the return type, if any. % #3 is the function name. % % We are followed by (but not passed) the arguments, if any. % \def\defname#1#2#3{% \par % Get the values of \leftskip and \rightskip as they were outside the @def... \advance\leftskip by -\defbodyindent % % Determine if we are typesetting the return type of a typed function % on a line by itself. \rettypeownlinefalse \ifdoingtypefn % doing a typed function specifically? % then check user option for putting return type on its own line: \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else \rettypeownlinetrue \fi \fi % % How we'll format the category name. Putting it in brackets helps % distinguish it from the body text that may end up on the next line % just below it. \def\temp{#1}% \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} % % Figure out line sizes for the paragraph shape. We'll always have at % least two. \tempnum = 2 % % The first line needs space for \box0; but if \rightskip is nonzero, % we need only space for the part of \box0 which exceeds it: \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip % % If doing a return type on its own line, we'll have another line. \ifrettypeownline \advance\tempnum by 1 \def\maybeshapeline{0in \hsize}% \else \def\maybeshapeline{}% \fi % % The continuations: \dimen2=\hsize \advance\dimen2 by -\defargsindent % % The final paragraph shape: \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2 % % Put the category name at the right margin. \noindent \hbox to 0pt{% \hfil\box0 \kern-\hsize % \hsize has to be shortened this way: \kern\leftskip % Intentionally do not respect \rightskip, since we need the space. }% % % Allow all lines to be underfull without complaint: \tolerance=10000 \hbadness=10000 \exdentamount=\defbodyindent {% % defun fonts. We use typewriter by default (used to be bold) because: % . we're printing identifiers, they should be in tt in principle. % . in languages with many accents, such as Czech or French, it's % common to leave accents off identifiers. The result looks ok in % tt, but exceedingly strange in rm. % . we don't want -- and --- to be treated as ligatures. % . this still does not fix the ?` and !` ligatures, but so far no % one has made identifiers using them :). \df \tt \def\temp{#2}% text of the return type \ifx\temp\empty\else \tclose{\temp}% typeset the return type \ifrettypeownline % put return type on its own line; prohibit line break following: \hfil\vadjust{\nobreak}\break \else \space % type on same line, so just followed by a space \fi \fi % no return type #3% output function name }% {\rm\enskip}% hskip 0.5 em of \rmfont % \boldbrax % arguments will be output next, if any. } % Print arguments in slanted roman (not ttsl), inconsistently with using % tt for the name. This is because literal text is sometimes needed in % the argument list (groff manual), and ttsl and tt are not very % distinguishable. Prevent hyphenation at `-' chars. % \def\defunargs#1{% % use sl by default (not ttsl), % tt for the names. \df \sl \hyphenchar\font=0 % % On the other hand, if an argument has two dashes (for instance), we % want a way to get ttsl. We used to recommend @var for that, so % leave the code in, but it's strange for @var to lead to typewriter. % Nowadays we recommend @code, since the difference between a ttsl hyphen % and a tt hyphen is pretty tiny. @code also disables ?` !`. \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}% #1% \sl\hyphenchar\font=45 } % We want ()&[] to print specially on the defun line. % \def\activeparens{% \catcode`\(=\active \catcode`\)=\active \catcode`\[=\active \catcode`\]=\active \catcode`\&=\active } % Make control sequences which act like normal parenthesis chars. \let\lparen = ( \let\rparen = ) % Be sure that we always have a definition for `(', etc. For example, % if the fn name has parens in it, \boldbrax will not be in effect yet, % so TeX would otherwise complain about undefined control sequence. { \activeparens \global\let(=\lparen \global\let)=\rparen \global\let[=\lbrack \global\let]=\rbrack \global\let& = \& \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} \gdef\magicamp{\let&=\amprm} } \let\ampchar\& \newcount\parencount % If we encounter &foo, then turn on ()-hacking afterwards \newif\ifampseen \def\amprm#1 {\ampseentrue{\bf\ }} \def\parenfont{% \ifampseen % At the first level, print parens in roman, % otherwise use the default font. \ifnum \parencount=1 \rm \fi \else % The \sf parens (in \boldbrax) actually are a little bolder than % the contained text. This is especially needed for [ and ] . \sf \fi } \def\infirstlevel#1{% \ifampseen \ifnum\parencount=1 #1% \fi \fi } \def\bfafterword#1 {#1 \bf} \def\opnr{% \global\advance\parencount by 1 {\parenfont(}% \infirstlevel \bfafterword } \def\clnr{% {\parenfont)}% \infirstlevel \sl \global\advance\parencount by -1 } \newcount\brackcount \def\lbrb{% \global\advance\brackcount by 1 {\bf[}% } \def\rbrb{% {\bf]}% \global\advance\brackcount by -1 } \def\checkparencounts{% \ifnum\parencount=0 \else \badparencount \fi \ifnum\brackcount=0 \else \badbrackcount \fi } % these should not use \errmessage; the glibc manual, at least, actually % has such constructs (when documenting function pointers). \def\badparencount{% \message{Warning: unbalanced parentheses in @def...}% \global\parencount=0 } \def\badbrackcount{% \message{Warning: unbalanced square brackets in @def...}% \global\brackcount=0 } \message{macros,} % @macro. % To do this right we need a feature of e-TeX, \scantokens, % which we arrange to emulate with a temporary file in ordinary TeX. \ifx\eTeXversion\thisisundefined \newwrite\macscribble \def\scantokens#1{% \toks0={#1}% \immediate\openout\macscribble=\jobname.tmp \immediate\write\macscribble{\the\toks0}% \immediate\closeout\macscribble \input \jobname.tmp } \fi % Used at the time of macro expansion. % Argument is macro body with arguments substituted \def\scanmacro#1{% \newlinechar`\^^M \def\xeatspaces{\eatspaces}% % % Process the macro body under the current catcode regime. \scantokens{#1@comment}% % % The \comment is to remove the \newlinechar added by \scantokens, and % can be noticed by \parsearg. Note \c isn't used because this means cedilla % in math mode. } % Used for copying and captions \def\scanexp#1{% \expandafter\scanmacro\expandafter{#1}% } \newcount\paramno % Count of parameters \newtoks\macname % Macro name \newif\ifrecursive % Is it recursive? % List of all defined macros in the form % \commondummyword\macro1\commondummyword\macro2... % Currently is also contains all @aliases; the list can be split % if there is a need. \def\macrolist{} % Add the macro to \macrolist \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} \def\addtomacrolistxxx#1{% \toks0 = \expandafter{\macrolist\commondummyword#1}% \xdef\macrolist{\the\toks0}% } % Utility routines. % This does \let #1 = #2, with \csnames; that is, % \let \csname#1\endcsname = \csname#2\endcsname % (except of course we have to play expansion games). % \def\cslet#1#2{% \expandafter\let \csname#1\expandafter\endcsname \csname#2\endcsname } % Trim leading and trailing spaces off a string. % Concepts from aro-bend problem 15 (see CTAN). {\catcode`\@=11 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} \def\unbrace#1{#1} \unbrace{\gdef\trim@@@ #1 } #2@{#1} } % Trim a single trailing ^^M off a string. {\catcode`\^^M=\other \catcode`\Q=3% \gdef\eatcr #1{\eatcra #1Q^^MQ}% \gdef\eatcra#1^^MQ{\eatcrb#1Q}% \gdef\eatcrb#1Q#2Q{#1}% } % Macro bodies are absorbed as an argument in a context where % all characters are catcode 10, 11 or 12, except \ which is active % (as in normal texinfo). It is necessary to change the definition of \ % to recognize macro arguments; this is the job of \mbodybackslash. % % Non-ASCII encodings make 8-bit characters active, so un-activate % them to avoid their expansion. Must do this non-globally, to % confine the change to the current group. % % It's necessary to have hard CRs when the macro is executed. This is % done by making ^^M (\endlinechar) catcode 12 when reading the macro % body, and then making it the \newlinechar in \scanmacro. % \def\scanctxt{% used as subroutine \catcode`\"=\other \catcode`\+=\other \catcode`\<=\other \catcode`\>=\other \catcode`\^=\other \catcode`\_=\other \catcode`\|=\other \catcode`\~=\other \passthroughcharstrue } \def\scanargctxt{% used for copying and captions, not macros. \scanctxt \catcode`\@=\other \catcode`\\=\other \catcode`\^^M=\other } \def\macrobodyctxt{% used for @macro definitions \scanctxt \catcode`\ =\other \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other \catcode`\^^M=\other \usembodybackslash } % Used when scanning braced macro arguments. Note, however, that catcode % changes here are ineffectual if the macro invocation was nested inside % an argument to another Texinfo command. \def\macroargctxt{% \scanctxt \catcode`\ =\active \catcode`\@=\other \catcode`\^^M=\other \catcode`\\=\active } \def\macrolineargctxt{% used for whole-line arguments without braces \scanctxt \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other } % \mbodybackslash is the definition of \ in @macro bodies. % It maps \foo\ => \csname macarg.foo\endcsname => #N % where N is the macro parameter number. % We define \csname macarg.\endcsname to be \realbackslash, so % \\ in macro replacement text gets you a backslash. % {\catcode`@=0 @catcode`@\=@active @gdef@usembodybackslash{@let\=@mbodybackslash} @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} } \expandafter\def\csname macarg.\endcsname{\realbackslash} \def\margbackslash#1{\char`\#1 } \def\macro{\recursivefalse\parsearg\macroxxx} \def\rmacro{\recursivetrue\parsearg\macroxxx} \def\macroxxx#1{% \getargs{#1}% now \macname is the macname and \argl the arglist \ifx\argl\empty % no arguments \paramno=0\relax \else \expandafter\parsemargdef \argl;% \if\paramno>256\relax \ifx\eTeXversion\thisisundefined \errhelp = \EMsimple \errmessage{You need eTeX to compile a file with macros with more than 256 arguments} \fi \fi \fi \if1\csname ismacro.\the\macname\endcsname \message{Warning: redefining \the\macname}% \else \expandafter\ifx\csname \the\macname\endcsname \relax \else \errmessage{Macro name \the\macname\space already defined}\fi \global\cslet{macsave.\the\macname}{\the\macname}% \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% \addtomacrolist{\the\macname}% \fi \begingroup \macrobodyctxt \ifrecursive \expandafter\parsermacbody \else \expandafter\parsemacbody \fi} \parseargdef\unmacro{% \if1\csname ismacro.#1\endcsname \global\cslet{#1}{macsave.#1}% \global\expandafter\let \csname ismacro.#1\endcsname=0% % Remove the macro name from \macrolist: \begingroup \expandafter\let\csname#1\endcsname \relax \let\commondummyword\unmacrodo \xdef\macrolist{\macrolist}% \endgroup \else \errmessage{Macro #1 not defined}% \fi } % Called by \do from \dounmacro on each macro. The idea is to omit any % macro definitions that have been changed to \relax. % \def\unmacrodo#1{% \ifx #1\relax % remove this \else \noexpand\commondummyword \noexpand#1% \fi } % \getargs -- Parse the arguments to a @macro line. Set \macname to % the name of the macro, and \argl to the braced argument list. \def\getargs#1{\getargsxxx#1{}} \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} \def\getmacname#1 #2\relax{\macname={#1}} \def\getmacargs#1{\def\argl{#1}} % This made use of the feature that if the last token of a % is #, then the preceding argument is delimited by % an opening brace, and that opening brace is not consumed. % Parse the optional {params} list to @macro or @rmacro. % Set \paramno to the number of arguments, % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a % three-param macro.) Define \macarg.BLAH for each BLAH in the params % list to some hook where the argument is to be expanded. If there are % less than 10 arguments that hook is to be replaced by ##N where N % is the position in that list, that is to say the macro arguments are to be % defined `a la TeX in the macro body. % % That gets used by \mbodybackslash (above). % % If there are 10 or more arguments, a different technique is used: see % \parsemmanyargdef. % \def\parsemargdef#1;{% \paramno=0\def\paramlist{}% \let\hash\relax % \hash is redefined to `#' later to get it into definitions \let\xeatspaces\relax \parsemargdefxxx#1,;,% \ifnum\paramno<10\relax\else \paramno0\relax \parsemmanyargdef@@#1,;,% 10 or more arguments \fi } \def\parsemargdefxxx#1,{% \if#1;\let\next=\relax \else \let\next=\parsemargdefxxx \advance\paramno by 1 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname {\xeatspaces{\hash\the\paramno}}% \edef\paramlist{\paramlist\hash\the\paramno,}% \fi\next} % \parsemacbody, \parsermacbody % % Read recursive and nonrecursive macro bodies. (They're different since % rec and nonrec macros end differently.) % % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro % body to be transformed. % Set \macrobody to the body of the macro, and call \defmacro. % {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{% \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}% {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{% \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}% % Make @ a letter, so that we can make private-to-Texinfo macro names. \edef\texiatcatcode{\the\catcode`\@} \catcode `@=11\relax %%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%% % If there are 10 or more arguments, a different technique is used, where the % hook remains in the body, and when macro is to be expanded the body is % processed again to replace the arguments. % % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the % argument N value and then \edef the body (nothing else will expand because of % the catcode regime under which the body was input). % % If you compile with TeX (not eTeX), and you have macros with 10 or more % arguments, no macro can have more than 256 arguments (else error). % % In case that there are 10 or more arguments we parse again the arguments % list to set new definitions for the \macarg.BLAH macros corresponding to % each BLAH argument. It was anyhow needed to parse already once this list % in order to count the arguments, and as macros with at most 9 arguments % are by far more frequent than macro with 10 or more arguments, defining % twice the \macarg.BLAH macros does not cost too much processing power. \def\parsemmanyargdef@@#1,{% \if#1;\let\next=\relax \else \let\next=\parsemmanyargdef@@ \edef\tempb{\eatspaces{#1}}% \expandafter\def\expandafter\tempa \expandafter{\csname macarg.\tempb\endcsname}% % Note that we need some extra \noexpand\noexpand, this is because we % don't want \the to be expanded in the \parsermacbody as it uses an % \xdef . \expandafter\edef\tempa {\noexpand\noexpand\noexpand\the\toks\the\paramno}% \advance\paramno by 1\relax \fi\next} \let\endargs@\relax \let\nil@\relax \def\nilm@{\nil@}% \long\def\nillm@{\nil@}% % This macro is expanded during the Texinfo macro expansion, not during its % definition. It gets all the arguments' values and assigns them to macros % macarg.ARGNAME % % #1 is the macro name % #2 is the list of argument names % #3 is the list of argument values \def\getargvals@#1#2#3{% \def\macargdeflist@{}% \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion. \def\paramlist{#2,\nil@}% \def\macroname{#1}% \begingroup \macroargctxt \def\argvaluelist{#3,\nil@}% \def\@tempa{#3}% \ifx\@tempa\empty \setemptyargvalues@ \else \getargvals@@ \fi } \def\getargvals@@{% \ifx\paramlist\nilm@ % Some sanity check needed here that \argvaluelist is also empty. \ifx\argvaluelist\nillm@ \else \errhelp = \EMsimple \errmessage{Too many arguments in macro `\macroname'!}% \fi \let\next\macargexpandinbody@ \else \ifx\argvaluelist\nillm@ % No more arguments values passed to macro. Set remaining named-arg % macros to empty. \let\next\setemptyargvalues@ \else % pop current arg name into \@tempb \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}% \expandafter\@tempa\expandafter{\paramlist}% % pop current argument value into \@tempc \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}% \expandafter\@tempa\expandafter{\argvaluelist}% % Here \@tempb is the current arg name and \@tempc is the current arg value. % First place the new argument macro definition into \@tempd \expandafter\macname\expandafter{\@tempc}% \expandafter\let\csname macarg.\@tempb\endcsname\relax \expandafter\def\expandafter\@tempe\expandafter{% \csname macarg.\@tempb\endcsname}% \edef\@tempd{\long\def\@tempe{\the\macname}}% \push@\@tempd\macargdeflist@ \let\next\getargvals@@ \fi \fi \next } \def\push@#1#2{% \expandafter\expandafter\expandafter\def \expandafter\expandafter\expandafter#2% \expandafter\expandafter\expandafter{% \expandafter#1#2}% } % Replace arguments by their values in the macro body, and place the result % in macro \@tempa. % \def\macvalstoargs@{% % To do this we use the property that token registers that are \the'ed % within an \edef expand only once. So we are going to place all argument % values into respective token registers. % % First we save the token context, and initialize argument numbering. \begingroup \paramno0\relax % Then, for each argument number #N, we place the corresponding argument % value into a new token list register \toks#N \expandafter\putargsintokens@\saveparamlist@,;,% % Then, we expand the body so that argument are replaced by their % values. The trick for values not to be expanded themselves is that they % are within tokens and that tokens expand only once in an \edef . \edef\@tempc{\csname mac.\macroname .body\endcsname}% % Now we restore the token stack pointer to free the token list registers % which we have used, but we make sure that expanded body is saved after % group. \expandafter \endgroup \expandafter\def\expandafter\@tempa\expandafter{\@tempc}% } % Define the named-macro outside of this group and then close this group. % \def\macargexpandinbody@{% \expandafter \endgroup \macargdeflist@ % First the replace in body the macro arguments by their values, the result % is in \@tempa . \macvalstoargs@ % Then we point at the \norecurse or \gobble (for recursive) macro value % with \@tempb . \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname % Depending on whether it is recursive or not, we need some tailing % \egroup . \ifx\@tempb\gobble \let\@tempc\relax \else \let\@tempc\egroup \fi % And now we do the real job: \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}% \@tempd } \def\putargsintokens@#1,{% \if#1;\let\next\relax \else \let\next\putargsintokens@ % First we allocate the new token list register, and give it a temporary % alias \@tempb . \toksdef\@tempb\the\paramno % Then we place the argument value into that token list register. \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname \expandafter\@tempb\expandafter{\@tempa}% \advance\paramno by 1\relax \fi \next } % Trailing missing arguments are set to empty. % \def\setemptyargvalues@{% \ifx\paramlist\nilm@ \let\next\macargexpandinbody@ \else \expandafter\setemptyargvaluesparser@\paramlist\endargs@ \let\next\setemptyargvalues@ \fi \next } \def\setemptyargvaluesparser@#1,#2\endargs@{% \expandafter\def\expandafter\@tempa\expandafter{% \expandafter\def\csname macarg.#1\endcsname{}}% \push@\@tempa\macargdeflist@ \def\paramlist{#2}% } % #1 is the element target macro % #2 is the list macro % #3,#4\endargs@ is the list value \def\pop@#1#2#3,#4\endargs@{% \def#1{#3}% \def#2{#4}% } \long\def\longpop@#1#2#3,#4\endargs@{% \long\def#1{#3}% \long\def#2{#4}% } %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%% % This defines a Texinfo @macro or @rmacro, called by \parsemacbody. % \macrobody has the body of the macro in it, with placeholders for % its parameters, looking like "\xeatspaces{\hash 1}". % \paramno is the number of parameters % \paramlist is a TeX parameter text, e.g. "#1,#2,#3," % There are four cases: macros of zero, one, up to nine, and many arguments. % \xdef is used so that macro definitions will survive the file % they're defined in: @include reads the file inside a group. % \def\defmacro{% \let\hash=##% convert placeholders to macro parameter chars \ifnum\paramno=1 \def\xeatspaces##1{##1}% % This removes the pair of braces around the argument. We don't % use \eatspaces, because this can cause ends of lines to be lost % when the argument to \eatspaces is read, leading to line-based % commands like "@itemize" not being read correctly. \else \let\xeatspaces\relax % suppress expansion \fi \ifcase\paramno % 0 \expandafter\xdef\csname\the\macname\endcsname{% \bgroup \noexpand\spaceisspace \noexpand\endlineisspace \noexpand\expandafter % skip any whitespace after the macro name. \expandafter\noexpand\csname\the\macname @@@\endcsname}% \expandafter\xdef\csname\the\macname @@@\endcsname{% \egroup \noexpand\scanmacro{\macrobody}}% \or % 1 \expandafter\xdef\csname\the\macname\endcsname{% \bgroup \noexpand\braceorline \expandafter\noexpand\csname\the\macname @@@\endcsname}% \expandafter\xdef\csname\the\macname @@@\endcsname##1{% \egroup \noexpand\scanmacro{\macrobody}% }% \else % at most 9 \ifnum\paramno<10\relax % @MACNAME sets the context for reading the macro argument % @MACNAME@@ gets the argument, processes backslashes and appends a % comma. % @MACNAME@@@ removes braces surrounding the argument list. % @MACNAME@@@@ scans the macro body with arguments substituted. \expandafter\xdef\csname\the\macname\endcsname{% \bgroup \noexpand\expandafter % This \expandafter skip any spaces after the \noexpand\macroargctxt % macro before we change the catcode of space. \noexpand\expandafter \expandafter\noexpand\csname\the\macname @@\endcsname}% \expandafter\xdef\csname\the\macname @@\endcsname##1{% \noexpand\passargtomacro \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}% \expandafter\xdef\csname\the\macname @@@\endcsname##1{% \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}% \expandafter\expandafter \expandafter\xdef \expandafter\expandafter \csname\the\macname @@@@\endcsname\paramlist{% \egroup\noexpand\scanmacro{\macrobody}}% \else % 10 or more: \expandafter\xdef\csname\the\macname\endcsname{% \noexpand\getargvals@{\the\macname}{\argl}% }% \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble \fi \fi} \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % {\catcode`\@=0 \catcode`\\=13 % We need to manipulate \ so use @ as escape @catcode`@_=11 % private names @catcode`@!=11 % used as argument separator % \passargtomacro#1#2 - % Call #1 with a list of tokens #2, with any doubled backslashes in #2 % compressed to one. % % This implementation works by expansion, and not execution (so we cannot use % \def or similar). This reduces the risk of this failing in contexts where % complete expansion is done with no execution (for example, in writing out to % an auxiliary file for an index entry). % % State is kept in the input stream: the argument passed to % @look_ahead, @gobble_and_check_finish and @add_segment is % % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input) % % where: % THE_MACRO - name of the macro we want to call % ARG_RESULT - argument list we build to pass to that macro % PENDING_BS - either a backslash or nothing % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next @gdef@passargtomacro#1#2{% @add_segment #1!{}@relax#2\@_finish\% } @gdef@_finish{@_finishx} @global@let@_finishx@relax % #1 - THE_MACRO ARG_RESULT % #2 - PENDING_BS % #3 - NEXT_TOKEN % #4 used to look ahead % % If the next token is not a backslash, process the rest of the argument; % otherwise, remove the next token. @gdef@look_ahead#1!#2#3#4{% @ifx#4\% @expandafter@gobble_and_check_finish @else @expandafter@add_segment @fi#1!{#2}#4#4% } % #1 - THE_MACRO ARG_RESULT % #2 - PENDING_BS % #3 - NEXT_TOKEN % #4 should be a backslash, which is gobbled. % #5 looks ahead % % Double backslash found. Add a single backslash, and look ahead. @gdef@gobble_and_check_finish#1!#2#3#4#5{% @add_segment#1\!{}#5#5% } @gdef@is_fi{@fi} % #1 - THE_MACRO ARG_RESULT % #2 - PENDING_BS % #3 - NEXT_TOKEN % #4 is input stream until next backslash % % Input stream is either at the start of the argument, or just after a % backslash sequence, either a lone backslash, or a doubled backslash. % NEXT_TOKEN contains the first token in the input stream: if it is \finish, % finish; otherwise, append to ARG_RESULT the segment of the argument up until % the next backslash. PENDING_BACKSLASH contains a backslash to represent % a backslash just before the start of the input stream that has not been % added to ARG_RESULT. @gdef@add_segment#1!#2#3#4\{% @ifx#3@_finish @call_the_macro#1!% @else % append the pending backslash to the result, followed by the next segment @expandafter@is_fi@look_ahead#1#2#4!{\}@fi % this @fi is discarded by @look_ahead. % we can't get rid of it with \expandafter because we don't know how % long #4 is. } % #1 - THE_MACRO % #2 - ARG_RESULT % #3 discards the res of the conditional in @add_segment, and @is_fi ends the % conditional. @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}} } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % \braceorline MAC is used for a one-argument macro MAC. It checks % whether the next non-whitespace character is a {. It sets the context % for reading the argument (slightly different in the two cases). Then, % to read the argument, in the whole-line case, it then calls the regular % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC. % \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} \def\braceorlinexxx{% \ifx\nchar\bgroup \macroargctxt \expandafter\passargtomacro \else \macrolineargctxt\expandafter\parsearg \fi \macnamexxx} % @alias. % We need some trickery to remove the optional spaces around the equal % sign. Make them active and then expand them all to nothing. % \def\alias{\parseargusing\obeyspaces\aliasxxx} \def\aliasxxx #1{\aliasyyy#1\relax} \def\aliasyyy #1=#2\relax{% {% \expandafter\let\obeyedspace=\empty \addtomacrolist{#1}% \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% }% \next } \message{cross references,} \newwrite\auxfile \newif\ifhavexrefs % True if xref values are known. \newif\ifwarnedxrefs % True if we warned once that they aren't known. % @inforef is relatively simple. \def\inforef #1{\inforefzzz #1,,,,**} \def\inforefzzz #1,#2,#3,#4**{% \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, node \samp{\ignorespaces#1{}}} % @node's only job in TeX is to define \lastnode, which is used in % cross-references. The @node line might or might not have commas, and % might or might not have spaces before the first comma, like: % @node foo , bar , ... % We don't want such trailing spaces in the node name. % \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} % % also remove a trailing comma, in case of something like this: % @node Help-Cross, , , Cross-refs \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode} % Used so that the @top node doesn't have to be wrapped in an @ifnottex % conditional. % \doignore goes to more effort to skip nested conditionals but we don't need % that here. \def\omittopnode{% \ifx\lastnode\wordTop \expandafter\ignorenode\fi } \def\wordTop{Top} % Until the next @node or @bye command, divert output to a box that is not % output. \def\ignorenode{\setbox\dummybox\vbox\bgroup\def\node{\egroup\node}% \ignorenodebye } {\let\bye\relax \gdef\ignorenodebye{\let\bye\ignorenodebyedef} \gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}} % The redefinition of \bye here is because it is declared \outer \let\lastnode=\empty % Write a cross-reference definition for the current node. #1 is the % type (Ynumbered, Yappendix, Ynothing). % \def\donoderef#1{% \ifx\lastnode\empty\else \setref{\lastnode}{#1}% \global\let\lastnode=\empty \fi } % @anchor{NAME} -- define xref target at arbitrary point. % \newcount\savesfregister % \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an % anchor), which consists of three parts: % 1) NAME-title - the current sectioning name taken from \currentsection, % or the anchor name. % 2) NAME-snt - section number and type, passed as the SNT arg, or % empty for anchors. % 3) NAME-pg - the page number. % % This is called from \donoderef, \anchor, and \dofloat. In the case of % floats, there is an additional part, which is not written here: % 4) NAME-lof - the text as it should appear in a @listoffloats. % \def\setref#1#2{% \pdfmkdest{#1}% \iflinks {% \requireauxfile \atdummies % preserve commands, but don't expand them % match definition in \xrdef, \refx, \xrefX. \def\value##1{##1}% \edef\writexrdef##1##2{% \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef ##1}{##2}}% these are parameters of \writexrdef }% \toks0 = \expandafter{\currentsection}% \immediate \writexrdef{title}{\the\toks0 }% \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout }% \fi } % @xrefautosectiontitle on|off says whether @section(ing) names are used % automatically in xrefs, if the third arg is not explicitly specified. % This was provided as a "secret" @set xref-automatic-section-title % variable, now it's official. % \parseargdef\xrefautomaticsectiontitle{% \def\temp{#1}% \ifx\temp\onword \expandafter\let\csname SETxref-automatic-section-title\endcsname = \empty \else\ifx\temp\offword \expandafter\let\csname SETxref-automatic-section-title\endcsname = \relax \else \errhelp = \EMsimple \errmessage{Unknown @xrefautomaticsectiontitle value `\temp', must be on|off}% \fi\fi } % % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is % the node name, #2 the name of the Info cross-reference, #3 the printed % node name, #4 the name of the Info file, #5 the name of the printed % manual. All but the node name can be omitted. % \def\pxref{\putwordsee{} \xrefXX} \def\xref{\putwordSee{} \xrefXX} \def\ref{\xrefXX} \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX} \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]} % \newbox\toprefbox \newbox\printedrefnamebox \newbox\infofilenamebox \newbox\printedmanualbox % \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup \unsepspaces % % Get args without leading/trailing spaces. \def\printedrefname{\ignorespaces #3}% \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}% % \def\infofilename{\ignorespaces #4}% \setbox\infofilenamebox = \hbox{\infofilename\unskip}% % \def\printedmanual{\ignorespaces #5}% \setbox\printedmanualbox = \hbox{\printedmanual\unskip}% % % If the printed reference name (arg #3) was not explicitly given in % the @xref, figure out what we want to use. \ifdim \wd\printedrefnamebox = 0pt % No printed node name was explicitly given. \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax % Not auto section-title: use node name inside the square brackets. \def\printedrefname{\ignorespaces #1}% \else % Auto section-title: use chapter/section title inside % the square brackets if we have it. \ifdim \wd\printedmanualbox > 0pt % It is in another manual, so we don't have it; use node name. \def\printedrefname{\ignorespaces #1}% \else \ifhavexrefs % We (should) know the real title if we have the xref values. \def\printedrefname{\refx{#1-title}{}}% \else % Otherwise just copy the Info node name. \def\printedrefname{\ignorespaces #1}% \fi% \fi \fi \fi % % Make link in pdf output. \ifpdf % For pdfTeX and LuaTeX {\indexnofonts \makevalueexpandable \turnoffactive % This expands tokens, so do it after making catcode changes, so _ % etc. don't get their TeX definitions. This ignores all spaces in % #4, including (wrongly) those in the middle of the filename. \getfilename{#4}% % % This (wrongly) does not take account of leading or trailing % spaces in #1, which should be ignored. \setpdfdestname{#1}% % \ifx\pdfdestname\empty \def\pdfdestname{Top}% no empty targets \fi % \leavevmode \startlink attr{/Border [0 0 0]}% \ifnum\filenamelength>0 goto file{\the\filename.pdf} name{\pdfdestname}% \else goto name{\pdfmkpgn{\pdfdestname}}% \fi }% \setcolor{\linkcolor}% \else \ifx\XeTeXrevision\thisisundefined \else % For XeTeX {\indexnofonts \makevalueexpandable \turnoffactive % This expands tokens, so do it after making catcode changes, so _ % etc. don't get their TeX definitions. This ignores all spaces in % #4, including (wrongly) those in the middle of the filename. \getfilename{#4}% % % This (wrongly) does not take account of leading or trailing % spaces in #1, which should be ignored. \setpdfdestname{#1}% % \ifx\pdfdestname\empty \def\pdfdestname{Top}% no empty targets \fi % \leavevmode \ifnum\filenamelength>0 % With default settings, % XeTeX (xdvipdfmx) replaces link destination names with integers. % In this case, the replaced destination names of % remote PDFs are no longer known. In order to avoid a replacement, % you can use xdvipdfmx's command line option `-C 0x0010'. % If you use XeTeX 0.99996+ (TeX Live 2016+), % this command line option is no longer necessary % because we can use the `dvipdfmx:config' special. \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}% \else \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A << /S /GoTo /D (\pdfdestname) >> >>}% \fi }% \setcolor{\linkcolor}% \fi \fi {% % Have to otherify everything special to allow the \csname to % include an _ in the xref name, etc. \indexnofonts \turnoffactive \def\value##1{##1}% \expandafter\global\expandafter\let\expandafter\Xthisreftitle \csname XR#1-title\endcsname }% % % Float references are printed completely differently: "Figure 1.2" % instead of "[somenode], p.3". \iffloat distinguishes them by % \Xthisreftitle being set to a magic string. \iffloat\Xthisreftitle % If the user specified the print name (third arg) to the ref, % print it instead of our usual "Figure 1.2". \ifdim\wd\printedrefnamebox = 0pt \refx{#1-snt}{}% \else \printedrefname \fi % % If the user also gave the printed manual name (fifth arg), append % "in MANUALNAME". \ifdim \wd\printedmanualbox > 0pt \space \putwordin{} \cite{\printedmanual}% \fi \else % node/anchor (non-float) references. % % If we use \unhbox to print the node names, TeX does not insert % empty discretionaries after hyphens, which means that it will not % find a line break at a hyphen in a node names. Since some manuals % are best written with fairly long node names, containing hyphens, % this is a loss. Therefore, we give the text of the node name % again, so it is as if TeX is seeing it for the first time. % \ifdim \wd\printedmanualbox > 0pt % Cross-manual reference with a printed manual name. % \crossmanualxref{\cite{\printedmanual\unskip}}% % \else\ifdim \wd\infofilenamebox > 0pt % Cross-manual reference with only an info filename (arg 4), no % printed manual name (arg 5). This is essentially the same as % the case above; we output the filename, since we have nothing else. % \crossmanualxref{\code{\infofilename\unskip}}% % \else % Reference within this manual. % % Only output a following space if the -snt ref is nonempty; for % @unnumbered and @anchor, it won't be. \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi % % output the `[mynode]' via the macro below so it can be overridden. \xrefprintnodename\printedrefname % % But we always want a comma and a space: ,\space % % output the `page 3'. \turnoffactive \putwordpage\tie\refx{#1-pg}{}% % Add a , if xref followed by a space \if\space\noexpand\tokenafterxref ,% \else\ifx\ \tokenafterxref ,% @TAB \else\ifx\*\tokenafterxref ,% @* \else\ifx\ \tokenafterxref ,% @SPACE \else\ifx\ \tokenafterxref ,% @NL \else\ifx\tie\tokenafterxref ,% @tie \fi\fi\fi\fi\fi\fi \fi\fi \fi \endlink \endgroup} % Output a cross-manual xref to #1. Used just above (twice). % % Only include the text "Section ``foo'' in" if the foo is neither % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply % "see The Foo Manual", the idea being to refer to the whole manual. % % But, this being TeX, we can't easily compare our node name against the % string "Top" while ignoring the possible spaces before and after in % the input. By adding the arbitrary 7sp below, we make it much less % likely that a real node name would have the same width as "Top" (e.g., % in a monospaced font). Hopefully it will never happen in practice. % % For the same basic reason, we retypeset the "Top" at every % reference, since the current font is indeterminate. % \def\crossmanualxref#1{% \setbox\toprefbox = \hbox{Top\kern7sp}% \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}% \ifdim \wd2 > 7sp % nonempty? \ifdim \wd2 = \wd\toprefbox \else % same as Top? \putwordSection{} ``\printedrefname'' \putwordin{}\space \fi \fi #1% } % This macro is called from \xrefX for the `[nodename]' part of xref % output. It's a separate macro only so it can be changed more easily, % since square brackets don't work well in some documents. Particularly % one that Bob is working on :). % \def\xrefprintnodename#1{[#1]} % Things referred to by \setref. % \def\Ynothing{} \def\Yomitfromtoc{} \def\Ynumbered{% \ifnum\secno=0 \putwordChapter@tie \the\chapno \else \ifnum\subsecno=0 \putwordSection@tie \the\chapno.\the\secno \else \ifnum\subsubsecno=0 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno \else \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno \fi\fi\fi } \def\Yappendix{% \ifnum\secno=0 \putwordAppendix@tie @char\the\appendixno{}% \else \ifnum\subsecno=0 \putwordSection@tie @char\the\appendixno.\the\secno \else \ifnum\subsubsecno=0 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno \else \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno \fi\fi\fi } % \refx{NAME}{SUFFIX} - reference a cross-reference string named NAME. SUFFIX % is output afterwards if non-empty. \def\refx#1#2{% \requireauxfile {% \indexnofonts \turnoffactive \def\value##1{##1}% \expandafter\global\expandafter\let\expandafter\thisrefX \csname XR#1\endcsname }% \ifx\thisrefX\relax % If not defined, say something at least. \angleleft un\-de\-fined\angleright \iflinks \ifhavexrefs {\toks0 = {#1}% avoid expansion of possibly-complex value \message{\linenumber Undefined cross reference `\the\toks0'.}}% \else \ifwarnedxrefs\else \global\warnedxrefstrue \message{Cross reference values unknown; you must run TeX again.}% \fi \fi \fi \else % It's defined, so just use it. \thisrefX \fi #2% Output the suffix in any case. } % This is the macro invoked by entries in the aux file. Define a control % sequence for a cross-reference target (we prepend XR to the control sequence % name to avoid collisions). The value is the page number. If this is a float % type, we have more work to do. % \def\xrdef#1#2{% {% Expand the node or anchor name to remove control sequences. % \turnoffactive stops 8-bit characters being changed to commands % like @'e. \refx does the same to retrieve the value in the definition. \indexnofonts \turnoffactive \def\value##1{##1}% \xdef\safexrefname{#1}% }% % \bgroup \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% \egroup % We put the \gdef inside a group to avoid the definitions building up on % TeX's save stack, which can cause it to run out of space for aux files with % thousands of lines. \gdef doesn't use the save stack, but \csname does % when it defines an unknown control sequence as \relax. % % Was that xref control sequence that we just defined for a float? \expandafter\iffloat\csname XR\safexrefname\endcsname % it was a float, and we have the (safe) float type in \iffloattype. \expandafter\let\expandafter\floatlist \csname floatlist\iffloattype\endcsname % % Is this the first time we've seen this float type? \expandafter\ifx\floatlist\relax \toks0 = {\do}% yes, so just \do \else % had it before, so preserve previous elements in list. \toks0 = \expandafter{\floatlist\do}% \fi % % Remember this xref in the control sequence \floatlistFLOATTYPE, % for later use in \listoffloats. \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0 {\safexrefname}}% \fi } % If working on a large document in chapters, it is convenient to % be able to disable indexing, cross-referencing, and contents, for test runs. % This is done with @novalidate at the beginning of the file. % \newif\iflinks \linkstrue % by default we want the aux files. \let\novalidate = \linksfalse % Used when writing to the aux file, or when using data from it. \def\requireauxfile{% \iflinks \tryauxfile % Open the new aux file. TeX will close it automatically at exit. \immediate\openout\auxfile=\jobname.aux \fi \global\let\requireauxfile=\relax % Only do this once. } % Read the last existing aux file, if any. No error if none exists. % \def\tryauxfile{% \openin 1 \jobname.aux \ifeof 1 \else \readdatafile{aux}% \global\havexrefstrue \fi \closein 1 } \def\setupdatafile{% \catcode`\^^@=\other \catcode`\^^A=\other \catcode`\^^B=\other \catcode`\^^C=\other \catcode`\^^D=\other \catcode`\^^E=\other \catcode`\^^F=\other \catcode`\^^G=\other \catcode`\^^H=\other \catcode`\^^K=\other \catcode`\^^L=\other \catcode`\^^N=\other \catcode`\^^P=\other \catcode`\^^Q=\other \catcode`\^^R=\other \catcode`\^^S=\other \catcode`\^^T=\other \catcode`\^^U=\other \catcode`\^^V=\other \catcode`\^^W=\other \catcode`\^^X=\other \catcode`\^^Z=\other \catcode`\^^[=\other \catcode`\^^\=\other \catcode`\^^]=\other \catcode`\^^^=\other \catcode`\^^_=\other \catcode`\^=\other % % Special characters. Should be turned off anyway, but... \catcode`\~=\other \catcode`\[=\other \catcode`\]=\other \catcode`\"=\other \catcode`\_=\other \catcode`\|=\other \catcode`\<=\other \catcode`\>=\other \catcode`\$=\other \catcode`\#=\other \catcode`\&=\other \catcode`\%=\other \catcode`+=\other % avoid \+ for paranoia even though we've turned it off % \catcode`\\=\active % % @ is our escape character in .aux files, and we need braces. \catcode`\{=1 \catcode`\}=2 \catcode`\@=0 } \def\readdatafile#1{% \begingroup \setupdatafile \input\jobname.#1 \endgroup} \message{insertions,} % including footnotes. \newcount \footnoteno % The trailing space in the following definition for supereject is % vital for proper filling; pages come out unaligned when you do a % pagealignmacro call if that space before the closing brace is % removed. (Generally, numeric constants should always be followed by a % space to prevent strange expansion errors.) \def\supereject{\par\penalty -20000\footnoteno =0 } % @footnotestyle is meaningful for Info output only. \let\footnotestyle=\comment {\catcode `\@=11 % % Auto-number footnotes. Otherwise like plain. \gdef\footnote{% \global\advance\footnoteno by \@ne \edef\thisfootno{$^{\the\footnoteno}$}% % % In case the footnote comes at the end of a sentence, preserve the % extra spacing after we do the footnote number. \let\@sf\empty \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi % % Remove inadvertent blank space before typesetting the footnote number. \unskip \thisfootno\@sf \dofootnote }% % Don't bother with the trickery in plain.tex to not require the % footnote text as a parameter. Our footnotes don't need to be so general. % % Oh yes, they do; otherwise, @ifset (and anything else that uses % \parseargline) fails inside footnotes because the tokens are fixed when % the footnote is read. --karl, 16nov96. % \gdef\dofootnote{% \insert\footins\bgroup % % Nested footnotes are not supported in TeX, that would take a lot % more work. (\startsavinginserts does not suffice.) \let\footnote=\errfootnotenest % % We want to typeset this text as a normal paragraph, even if the % footnote reference occurs in (for example) a display environment. % So reset some parameters. \hsize=\txipagewidth \interlinepenalty\interfootnotelinepenalty \splittopskip\ht\strutbox % top baseline for broken footnotes \splitmaxdepth\dp\strutbox \floatingpenalty\@MM \leftskip\z@skip \rightskip\z@skip \spaceskip\z@skip \xspaceskip\z@skip \parindent\defaultparindent % \smallfonts \rm % % Because we use hanging indentation in footnotes, a @noindent appears % to exdent this text, so make it be a no-op. makeinfo does not use % hanging indentation so @noindent can still be needed within footnote % text after an @example or the like (not that this is good style). \let\noindent = \relax % % Hang the footnote text off the number. Use \everypar in case the % footnote extends for more than one paragraph. \everypar = {\hang}% \textindent{\thisfootno}% % % Don't crash into the line above the footnote text. Since this % expands into a box, it must come within the paragraph, lest it % provide a place where TeX can split the footnote. \footstrut % % Invoke rest of plain TeX footnote routine. \futurelet\next\fo@t } }%end \catcode `\@=11 \def\errfootnotenest{% \errhelp=\EMsimple \errmessage{Nested footnotes not supported in texinfo.tex, even though they work in makeinfo; sorry} } \def\errfootnoteheading{% \errhelp=\EMsimple \errmessage{Footnotes in chapters, sections, etc., are not supported} } % In case a @footnote appears in a vbox, save the footnote text and create % the real \insert just after the vbox finished. Otherwise, the insertion % would be lost. % Similarly, if a @footnote appears inside an alignment, save the footnote % text to a box and make the \insert when a row of the table is finished. % And the same can be done for other insert classes. --kasal, 16nov03. % % Replace the \insert primitive by a cheating macro. % Deeper inside, just make sure that the saved insertions are not spilled % out prematurely. % \def\startsavinginserts{% \ifx \insert\ptexinsert \let\insert\saveinsert \else \let\checkinserts\relax \fi } % This \insert replacement works for both \insert\footins{foo} and % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. % \def\saveinsert#1{% \edef\next{\noexpand\savetobox \makeSAVEname#1}% \afterassignment\next % swallow the left brace \let\temp = } \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} \def\placesaveins#1{% \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname {\box#1}% } % eat @SAVE -- beware, all of them have catcode \other: { \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) \gdef\gobblesave @SAVE{} } % initialization: \def\newsaveins #1{% \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% \next } \def\newsaveinsX #1{% \csname newbox\endcsname #1% \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts \checksaveins #1}% } % initialize: \let\checkinserts\empty \newsaveins\footins \newsaveins\margin % @image. We use the macros from epsf.tex to support this. % If epsf.tex is not installed and @image is used, we complain. % % Check for and read epsf.tex up front. If we read it only at @image % time, we might be inside a group, and then its definitions would get % undone and the next image would fail. \openin 1 = epsf.tex \ifeof 1 \else % Do not bother showing banner with epsf.tex v2.7k (available in % doc/epsf.tex and on ctan). \def\epsfannounce{\toks0 = }% \input epsf.tex \fi \closein 1 % % We will only complain once about lack of epsf.tex. \newif\ifwarnednoepsf \newhelp\noepsfhelp{epsf.tex must be installed for images to work. It is also included in the Texinfo distribution, or you can get it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.} % \def\image#1{% \ifx\epsfbox\thisisundefined \ifwarnednoepsf \else \errhelp = \noepsfhelp \errmessage{epsf.tex not found, images will be ignored}% \global\warnednoepsftrue \fi \else \imagexxx #1,,,,,\finish \fi } % % Arguments to @image: % #1 is (mandatory) image filename; we tack on .eps extension. % #2 is (optional) width, #3 is (optional) height. % #4 is (ignored optional) html alt text. % #5 is (ignored optional) extension. % #6 is just the usual extra ignored arg for parsing stuff. \newif\ifimagevmode \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup \catcode`\^^M = 5 % in case we're inside an example \normalturnoffactive % allow _ et al. in names \def\xprocessmacroarg{\eatspaces}% in case we are being used via a macro % If the image is by itself, center it. \ifvmode \imagevmodetrue \else \ifx\centersub\centerV % for @center @image, we need a vbox so we can have our vertical space \imagevmodetrue \vbox\bgroup % vbox has better behavior than vtop herev \fi\fi % \ifimagevmode \nobreak\medskip % Usually we'll have text after the image which will insert % \parskip glue, so insert it here too to equalize the space % above and below. \nobreak\vskip\parskip \nobreak \fi % % Leave vertical mode so that indentation from an enclosing % environment such as @quotation is respected. % However, if we're at the top level, we don't want the % normal paragraph indentation. % On the other hand, if we are in the case of @center @image, we don't % want to start a paragraph, which will create a hsize-width box and % eradicate the centering. \ifx\centersub\centerV\else \noindent \fi % % Output the image. \ifpdf % For pdfTeX and LuaTeX <= 0.80 \dopdfimage{#1}{#2}{#3}% \else \ifx\XeTeXrevision\thisisundefined % For epsf.tex % \epsfbox itself resets \epsf?size at each figure. \setbox0 = \hbox{\ignorespaces #2}% \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi \setbox0 = \hbox{\ignorespaces #3}% \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi \epsfbox{#1.eps}% \else % For XeTeX \doxeteximage{#1}{#2}{#3}% \fi \fi % \ifimagevmode \medskip % space after a standalone image \fi \ifx\centersub\centerV \egroup \fi \endgroup} % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, % etc. We don't actually implement floating yet, we always include the % float "here". But it seemed the best name for the future. % \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} % There may be a space before second and/or third parameter; delete it. \def\eatcommaspace#1, {#1,} % #1 is the optional FLOATTYPE, the text label for this float, typically % "Figure", "Table", "Example", etc. Can't contain commas. If omitted, % this float will not be numbered and cannot be referred to. % % #2 is the optional xref label. Also must be present for the float to % be referable. % % #3 is the optional positioning argument; for now, it is ignored. It % will somehow specify the positions allowed to float to (here, top, bottom). % % We keep a separate counter for each FLOATTYPE, which we reset at each % chapter-level command. \let\resetallfloatnos=\empty % \def\dofloat#1,#2,#3,#4\finish{% \let\thiscaption=\empty \let\thisshortcaption=\empty % % don't lose footnotes inside @float. % % BEWARE: when the floats start float, we have to issue warning whenever an % insert appears inside a float which could possibly float. --kasal, 26may04 % \startsavinginserts % % We can't be used inside a paragraph. \par % \vtop\bgroup \def\floattype{#1}% \def\floatlabel{#2}% \def\floatloc{#3}% we do nothing with this yet. % \ifx\floattype\empty \let\safefloattype=\empty \else {% % the floattype might have accents or other special characters, % but we need to use it in a control sequence name. \indexnofonts \turnoffactive \xdef\safefloattype{\floattype}% }% \fi % % If label is given but no type, we handle that as the empty type. \ifx\floatlabel\empty \else % We want each FLOATTYPE to be numbered separately (Figure 1, % Table 1, Figure 2, ...). (And if no label, no number.) % \expandafter\getfloatno\csname\safefloattype floatno\endcsname \global\advance\floatno by 1 % {% % This magic value for \currentsection is output by \setref as the % XREFLABEL-title value. \xrefX uses it to distinguish float % labels (which have a completely different output format) from % node and anchor labels. And \xrdef uses it to construct the % lists of floats. % \edef\currentsection{\floatmagic=\safefloattype}% \setref{\floatlabel}{Yfloat}% }% \fi % % start with \parskip glue, I guess. \vskip\parskip % % Don't suppress indentation if a float happens to start a section. \restorefirstparagraphindent } % we have these possibilities: % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap % @float Foo,lbl & no caption: Foo 1.1 % @float Foo & @caption{Cap}: Foo: Cap % @float Foo & no caption: Foo % @float ,lbl & Caption{Cap}: 1.1: Cap % @float ,lbl & no caption: 1.1 % @float & @caption{Cap}: Cap % @float & no caption: % \def\Efloat{% \let\floatident = \empty % % In all cases, if we have a float type, it comes first. \ifx\floattype\empty \else \def\floatident{\floattype}\fi % % If we have an xref label, the number comes next. \ifx\floatlabel\empty \else \ifx\floattype\empty \else % if also had float type, need tie first. \appendtomacro\floatident{\tie}% \fi % the number. \appendtomacro\floatident{\chaplevelprefix\the\floatno}% \fi % % Start the printed caption with what we've constructed in % \floatident, but keep it separate; we need \floatident again. \let\captionline = \floatident % \ifx\thiscaption\empty \else \ifx\floatident\empty \else \appendtomacro\captionline{: }% had ident, so need a colon between \fi % % caption text. \appendtomacro\captionline{\scanexp\thiscaption}% \fi % % If we have anything to print, print it, with space before. % Eventually this needs to become an \insert. \ifx\captionline\empty \else \vskip.5\parskip \captionline % % Space below caption. \vskip\parskip \fi % % If have an xref label, write the list of floats info. Do this % after the caption, to avoid chance of it being a breakpoint. \ifx\floatlabel\empty \else % Write the text that goes in the lof to the aux file as % \floatlabel-lof. Besides \floatident, we include the short % caption if specified, else the full caption if specified, else nothing. {% \requireauxfile \atdummies % \ifx\thisshortcaption\empty \def\gtemp{\thiscaption}% \else \def\gtemp{\thisshortcaption}% \fi \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident \ifx\gtemp\empty \else : \gtemp \fi}}% }% \fi \egroup % end of \vtop % \checkinserts } % Append the tokens #2 to the definition of macro #1, not expanding either. % \def\appendtomacro#1#2{% \expandafter\def\expandafter#1\expandafter{#1#2}% } % @caption, @shortcaption % \def\caption{\docaption\thiscaption} \def\shortcaption{\docaption\thisshortcaption} \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} \def\defcaption#1#2{\egroup \def#1{#2}} % The parameter is the control sequence identifying the counter we are % going to use. Create it if it doesn't exist and assign it to \floatno. \def\getfloatno#1{% \ifx#1\relax % Haven't seen this figure type before. \csname newcount\endcsname #1% % % Remember to reset this floatno at the next chap. \expandafter\gdef\expandafter\resetallfloatnos \expandafter{\resetallfloatnos #1=0 }% \fi \let\floatno#1% } % \setref calls this to get the XREFLABEL-snt value. We want an @xref % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we % first read the @float command. % \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% % Magic string used for the XREFLABEL-title value, so \xrefX can % distinguish floats from other xref types. \def\floatmagic{!!float!!} % #1 is the control sequence we are passed; we expand into a conditional % which is true if #1 represents a float ref. That is, the magic % \currentsection value which we \setref above. % \def\iffloat#1{\expandafter\doiffloat#1==\finish} % % #1 is (maybe) the \floatmagic string. If so, #2 will be the % (safe) float type for this float. We set \iffloattype to #2. % \def\doiffloat#1=#2=#3\finish{% \def\temp{#1}% \def\iffloattype{#2}% \ifx\temp\floatmagic } % @listoffloats FLOATTYPE - print a list of floats like a table of contents. % \parseargdef\listoffloats{% \def\floattype{#1}% floattype {% % the floattype might have accents or other special characters, % but we need to use it in a control sequence name. \indexnofonts \turnoffactive \xdef\safefloattype{\floattype}% }% % % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax \ifhavexrefs % if the user said @listoffloats foo but never @float foo. \message{\linenumber No `\safefloattype' floats to list.}% \fi \else \begingroup \leftskip=\tocindent % indent these entries like a toc \let\do=\listoffloatsdo \csname floatlist\safefloattype\endcsname \endgroup \fi } % This is called on each entry in a list of floats. We're passed the % xref label, in the form LABEL-title, which is how we save it in the % aux file. We strip off the -title and look up \XRLABEL-lof, which % has the text we're supposed to typeset here. % % Figures without xref labels will not be included in the list (since % they won't appear in the aux file). % \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} \def\listoffloatsdoentry#1-title\finish{{% % Can't fully expand XR#1-lof because it can contain anything. Just % pass the control sequence. On the other hand, XR#1-pg is just the % page number, and we want to fully expand that so we can get a link % in pdf output. \toksA = \expandafter{\csname XR#1-lof\endcsname}% % % use the same \entry macro we use to generate the TOC and index. \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% \writeentry }} \message{localization,} % For single-language documents, @documentlanguage is usually given very % early, just after @documentencoding. Single argument is the language % (de) or locale (de_DE) abbreviation. % { \catcode`\_ = \active \globaldefs=1 \parseargdef\documentlanguage{% \tex % read txi-??.tex file in plain TeX. % Read the file by the name they passed if it exists. \let_ = \normalunderscore % normal _ character for filename test \openin 1 txi-#1.tex \ifeof 1 \documentlanguagetrywithoutunderscore #1_\finish \else \globaldefs = 1 % everything in the txi-LL files needs to persist \input txi-#1.tex \fi \closein 1 \endgroup % end raw TeX } % % If they passed de_DE, and txi-de_DE.tex doesn't exist, % try txi-de.tex. % \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{% \openin 1 txi-#1.tex \ifeof 1 \errhelp = \nolanghelp \errmessage{Cannot read language file txi-#1.tex}% \else \globaldefs = 1 % everything in the txi-LL files needs to persist \input txi-#1.tex \fi \closein 1 } }% end of special _ catcode % \newhelp\nolanghelp{The given language definition file cannot be found or is empty. Maybe you need to install it? Putting it in the current directory should work if nowhere else does.} % This macro is called from txi-??.tex files; the first argument is the % \language name to set (without the "\lang@" prefix), the second and % third args are \{left,right}hyphenmin. % % The language names to pass are determined when the format is built. % See the etex.log file created at that time, e.g., % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log. % % With TeX Live 2008, etex now includes hyphenation patterns for all % available languages. This means we can support hyphenation in % Texinfo, at least to some extent. (This still doesn't solve the % accented characters problem.) % \catcode`@=11 \def\txisetlanguage#1#2#3{% % do not set the language if the name is undefined in the current TeX. \expandafter\ifx\csname lang@#1\endcsname \relax \message{no patterns for #1}% \else \global\language = \csname lang@#1\endcsname \fi % but there is no harm in adjusting the hyphenmin values regardless. \global\lefthyphenmin = #2\relax \global\righthyphenmin = #3\relax } % XeTeX and LuaTeX can handle Unicode natively. % Their default I/O uses UTF-8 sequences instead of a byte-wise operation. % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise. % \newif\iftxinativeunicodecapable \newif\iftxiusebytewiseio \ifx\XeTeXrevision\thisisundefined \ifx\luatexversion\thisisundefined \txinativeunicodecapablefalse \txiusebytewiseiotrue \else \txinativeunicodecapabletrue \txiusebytewiseiofalse \fi \else \txinativeunicodecapabletrue \txiusebytewiseiofalse \fi % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex % for non-UTF-8 (byte-wise) encodings. % \def\setbytewiseio{% \ifx\XeTeXrevision\thisisundefined \else \XeTeXdefaultencoding "bytes" % For subsequent files to be read \XeTeXinputencoding "bytes" % For document root file % Unfortunately, there seems to be no corresponding XeTeX command for % output encoding. This is a problem for auxiliary index and TOC files. % The only solution would be perhaps to write out @U{...} sequences in % place of non-ASCII characters. \fi \ifx\luatexversion\thisisundefined \else \directlua{ local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub local function convert_char (char) return utf8_char(byte(char)) end local function convert_line (line) return gsub(line, ".", convert_char) end callback.register("process_input_buffer", convert_line) local function convert_line_out (line) local line_out = "" for c in string.utfvalues(line) do line_out = line_out .. string.char(c) end return line_out end callback.register("process_output_buffer", convert_line_out) } \fi \txiusebytewiseiotrue } % Helpers for encodings. % Set the catcode of characters 128 through 255 to the specified number. % \def\setnonasciicharscatcode#1{% \count255=128 \loop\ifnum\count255<256 \global\catcode\count255=#1\relax \advance\count255 by 1 \repeat } \def\setnonasciicharscatcodenonglobal#1{% \count255=128 \loop\ifnum\count255<256 \catcode\count255=#1\relax \advance\count255 by 1 \repeat } % @documentencoding sets the definition of non-ASCII characters % according to the specified encoding. % \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz} \def\documentencodingzzz#1{% % % Encoding being declared for the document. \def\declaredencoding{\csname #1.enc\endcsname}% % % Supported encodings: names converted to tokens in order to be able % to compare them with \ifx. \def\ascii{\csname US-ASCII.enc\endcsname}% \def\latnine{\csname ISO-8859-15.enc\endcsname}% \def\latone{\csname ISO-8859-1.enc\endcsname}% \def\lattwo{\csname ISO-8859-2.enc\endcsname}% \def\utfeight{\csname UTF-8.enc\endcsname}% % \ifx \declaredencoding \ascii \asciichardefs % \else \ifx \declaredencoding \lattwo \iftxinativeunicodecapable \setbytewiseio \fi \setnonasciicharscatcode\active \lattwochardefs % \else \ifx \declaredencoding \latone \iftxinativeunicodecapable \setbytewiseio \fi \setnonasciicharscatcode\active \latonechardefs % \else \ifx \declaredencoding \latnine \iftxinativeunicodecapable \setbytewiseio \fi \setnonasciicharscatcode\active \latninechardefs % \else \ifx \declaredencoding \utfeight \iftxinativeunicodecapable % For native Unicode handling (XeTeX and LuaTeX) \nativeunicodechardefs \else % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX) \setnonasciicharscatcode\active % since we already invoked \utfeightchardefs at the top level % (below), do not re-invoke it, otherwise our check for duplicated % definitions gets triggered. Making non-ascii chars active is % sufficient. \fi % \else \message{Ignoring unknown document encoding: #1.}% % \fi % utfeight \fi % latnine \fi % latone \fi % lattwo \fi % ascii % \ifx\XeTeXrevision\thisisundefined \else \ifx \declaredencoding \utfeight \else \ifx \declaredencoding \ascii \else \message{Warning: XeTeX with non-UTF-8 encodings cannot handle % non-ASCII characters in auxiliary files.}% \fi \fi \fi } % emacs-page % A message to be logged when using a character that isn't available % the default font encoding (OT1). % \def\missingcharmsg#1{\message{Character missing, sorry: #1.}} % Take account of \c (plain) vs. \, (Texinfo) difference. \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi} % First, make active non-ASCII characters in order for them to be % correctly categorized when TeX reads the replacement text of % macros containing the character definitions. \setnonasciicharscatcode\active % \def\gdefchar#1#2{% \gdef#1{% \ifpassthroughchars \string#1% \else #2% \fi }} % Latin1 (ISO-8859-1) character definitions. \def\latonechardefs{% \gdefchar^^a0{\tie} \gdefchar^^a1{\exclamdown} \gdefchar^^a2{{\tcfont \char162}} % cent \gdefchar^^a3{\pounds{}} \gdefchar^^a4{{\tcfont \char164}} % currency \gdefchar^^a5{{\tcfont \char165}} % yen \gdefchar^^a6{{\tcfont \char166}} % broken bar \gdefchar^^a7{\S} \gdefchar^^a8{\"{}} \gdefchar^^a9{\copyright{}} \gdefchar^^aa{\ordf} \gdefchar^^ab{\guillemetleft{}} \gdefchar^^ac{\ensuremath\lnot} \gdefchar^^ad{\-} \gdefchar^^ae{\registeredsymbol{}} \gdefchar^^af{\={}} % \gdefchar^^b0{\textdegree} \gdefchar^^b1{$\pm$} \gdefchar^^b2{$^2$} \gdefchar^^b3{$^3$} \gdefchar^^b4{\'{}} \gdefchar^^b5{$\mu$} \gdefchar^^b6{\P} \gdefchar^^b7{\ensuremath\cdot} \gdefchar^^b8{\cedilla\ } \gdefchar^^b9{$^1$} \gdefchar^^ba{\ordm} \gdefchar^^bb{\guillemetright{}} \gdefchar^^bc{$1\over4$} \gdefchar^^bd{$1\over2$} \gdefchar^^be{$3\over4$} \gdefchar^^bf{\questiondown} % \gdefchar^^c0{\`A} \gdefchar^^c1{\'A} \gdefchar^^c2{\^A} \gdefchar^^c3{\~A} \gdefchar^^c4{\"A} \gdefchar^^c5{\ringaccent A} \gdefchar^^c6{\AE} \gdefchar^^c7{\cedilla C} \gdefchar^^c8{\`E} \gdefchar^^c9{\'E} \gdefchar^^ca{\^E} \gdefchar^^cb{\"E} \gdefchar^^cc{\`I} \gdefchar^^cd{\'I} \gdefchar^^ce{\^I} \gdefchar^^cf{\"I} % \gdefchar^^d0{\DH} \gdefchar^^d1{\~N} \gdefchar^^d2{\`O} \gdefchar^^d3{\'O} \gdefchar^^d4{\^O} \gdefchar^^d5{\~O} \gdefchar^^d6{\"O} \gdefchar^^d7{$\times$} \gdefchar^^d8{\O} \gdefchar^^d9{\`U} \gdefchar^^da{\'U} \gdefchar^^db{\^U} \gdefchar^^dc{\"U} \gdefchar^^dd{\'Y} \gdefchar^^de{\TH} \gdefchar^^df{\ss} % \gdefchar^^e0{\`a} \gdefchar^^e1{\'a} \gdefchar^^e2{\^a} \gdefchar^^e3{\~a} \gdefchar^^e4{\"a} \gdefchar^^e5{\ringaccent a} \gdefchar^^e6{\ae} \gdefchar^^e7{\cedilla c} \gdefchar^^e8{\`e} \gdefchar^^e9{\'e} \gdefchar^^ea{\^e} \gdefchar^^eb{\"e} \gdefchar^^ec{\`{\dotless i}} \gdefchar^^ed{\'{\dotless i}} \gdefchar^^ee{\^{\dotless i}} \gdefchar^^ef{\"{\dotless i}} % \gdefchar^^f0{\dh} \gdefchar^^f1{\~n} \gdefchar^^f2{\`o} \gdefchar^^f3{\'o} \gdefchar^^f4{\^o} \gdefchar^^f5{\~o} \gdefchar^^f6{\"o} \gdefchar^^f7{$\div$} \gdefchar^^f8{\o} \gdefchar^^f9{\`u} \gdefchar^^fa{\'u} \gdefchar^^fb{\^u} \gdefchar^^fc{\"u} \gdefchar^^fd{\'y} \gdefchar^^fe{\th} \gdefchar^^ff{\"y} } % Latin9 (ISO-8859-15) encoding character definitions. \def\latninechardefs{% % Encoding is almost identical to Latin1. \latonechardefs % \gdefchar^^a4{\euro{}} \gdefchar^^a6{\v S} \gdefchar^^a8{\v s} \gdefchar^^b4{\v Z} \gdefchar^^b8{\v z} \gdefchar^^bc{\OE} \gdefchar^^bd{\oe} \gdefchar^^be{\"Y} } % Latin2 (ISO-8859-2) character definitions. \def\lattwochardefs{% \gdefchar^^a0{\tie} \gdefchar^^a1{\ogonek{A}} \gdefchar^^a2{\u{}} \gdefchar^^a3{\L} \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}} \gdefchar^^a5{\v L} \gdefchar^^a6{\'S} \gdefchar^^a7{\S} \gdefchar^^a8{\"{}} \gdefchar^^a9{\v S} \gdefchar^^aa{\cedilla S} \gdefchar^^ab{\v T} \gdefchar^^ac{\'Z} \gdefchar^^ad{\-} \gdefchar^^ae{\v Z} \gdefchar^^af{\dotaccent Z} % \gdefchar^^b0{\textdegree{}} \gdefchar^^b1{\ogonek{a}} \gdefchar^^b2{\ogonek{ }} \gdefchar^^b3{\l} \gdefchar^^b4{\'{}} \gdefchar^^b5{\v l} \gdefchar^^b6{\'s} \gdefchar^^b7{\v{}} \gdefchar^^b8{\cedilla\ } \gdefchar^^b9{\v s} \gdefchar^^ba{\cedilla s} \gdefchar^^bb{\v t} \gdefchar^^bc{\'z} \gdefchar^^bd{\H{}} \gdefchar^^be{\v z} \gdefchar^^bf{\dotaccent z} % \gdefchar^^c0{\'R} \gdefchar^^c1{\'A} \gdefchar^^c2{\^A} \gdefchar^^c3{\u A} \gdefchar^^c4{\"A} \gdefchar^^c5{\'L} \gdefchar^^c6{\'C} \gdefchar^^c7{\cedilla C} \gdefchar^^c8{\v C} \gdefchar^^c9{\'E} \gdefchar^^ca{\ogonek{E}} \gdefchar^^cb{\"E} \gdefchar^^cc{\v E} \gdefchar^^cd{\'I} \gdefchar^^ce{\^I} \gdefchar^^cf{\v D} % \gdefchar^^d0{\DH} \gdefchar^^d1{\'N} \gdefchar^^d2{\v N} \gdefchar^^d3{\'O} \gdefchar^^d4{\^O} \gdefchar^^d5{\H O} \gdefchar^^d6{\"O} \gdefchar^^d7{$\times$} \gdefchar^^d8{\v R} \gdefchar^^d9{\ringaccent U} \gdefchar^^da{\'U} \gdefchar^^db{\H U} \gdefchar^^dc{\"U} \gdefchar^^dd{\'Y} \gdefchar^^de{\cedilla T} \gdefchar^^df{\ss} % \gdefchar^^e0{\'r} \gdefchar^^e1{\'a} \gdefchar^^e2{\^a} \gdefchar^^e3{\u a} \gdefchar^^e4{\"a} \gdefchar^^e5{\'l} \gdefchar^^e6{\'c} \gdefchar^^e7{\cedilla c} \gdefchar^^e8{\v c} \gdefchar^^e9{\'e} \gdefchar^^ea{\ogonek{e}} \gdefchar^^eb{\"e} \gdefchar^^ec{\v e} \gdefchar^^ed{\'{\dotless{i}}} \gdefchar^^ee{\^{\dotless{i}}} \gdefchar^^ef{\v d} % \gdefchar^^f0{\dh} \gdefchar^^f1{\'n} \gdefchar^^f2{\v n} \gdefchar^^f3{\'o} \gdefchar^^f4{\^o} \gdefchar^^f5{\H o} \gdefchar^^f6{\"o} \gdefchar^^f7{$\div$} \gdefchar^^f8{\v r} \gdefchar^^f9{\ringaccent u} \gdefchar^^fa{\'u} \gdefchar^^fb{\H u} \gdefchar^^fc{\"u} \gdefchar^^fd{\'y} \gdefchar^^fe{\cedilla t} \gdefchar^^ff{\dotaccent{}} } % UTF-8 character definitions. % % This code to support UTF-8 is based on LaTeX's utf8.def, with some % changes for Texinfo conventions. It is included here under the GPL by % permission from Frank Mittelbach and the LaTeX team. % \newcount\countUTFx \newcount\countUTFy \newcount\countUTFz \gdef\UTFviiiTwoOctets#1#2{\expandafter \UTFviiiDefined\csname u8:#1\string #2\endcsname} % \gdef\UTFviiiThreeOctets#1#2#3{\expandafter \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname} % \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname} \gdef\UTFviiiDefined#1{% \ifx #1\relax \message{\linenumber Unicode char \string #1 not defined for Texinfo}% \else \expandafter #1% \fi } % Give non-ASCII bytes the active definitions for processing UTF-8 sequences \begingroup \catcode`\~13 \catcode`\$12 \catcode`\"12 % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp % substituting ~ and $ with a character token of that value. \def\UTFviiiLoop{% \global\catcode\countUTFx\active \uccode`\~\countUTFx \uccode`\$\countUTFx \uppercase\expandafter{\UTFviiiTmp}% \advance\countUTFx by 1 \ifnum\countUTFx < \countUTFy \expandafter\UTFviiiLoop \fi} % For bytes other than the first in a UTF-8 sequence. Not expected to % be expanded except when writing to auxiliary files. \countUTFx = "80 \countUTFy = "C2 \def\UTFviiiTmp{% \gdef~{% \ifpassthroughchars $\fi}}% \UTFviiiLoop \countUTFx = "C2 \countUTFy = "E0 \def\UTFviiiTmp{% \gdef~{% \ifpassthroughchars $% \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}% \UTFviiiLoop \countUTFx = "E0 \countUTFy = "F0 \def\UTFviiiTmp{% \gdef~{% \ifpassthroughchars $% \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}% \UTFviiiLoop \countUTFx = "F0 \countUTFy = "F4 \def\UTFviiiTmp{% \gdef~{% \ifpassthroughchars $% \else\expandafter\UTFviiiFourOctets\expandafter$\fi }}% \UTFviiiLoop \endgroup \def\globallet{\global\let} % save some \expandafter's below % @U{xxxx} to produce U+xxxx, if we support it. \def\U#1{% \expandafter\ifx\csname uni:#1\endcsname \relax \iftxinativeunicodecapable % All Unicode characters can be used if native Unicode handling is % active. However, if the font does not have the glyph, % letters are missing. \begingroup \uccode`\.="#1\relax \uppercase{.} \endgroup \else \errhelp = \EMsimple \errmessage{Unicode character U+#1 not supported, sorry}% \fi \else \csname uni:#1\endcsname \fi } % These macros are used here to construct the name of a control % sequence to be defined. \def\UTFviiiTwoOctetsName#1#2{% \csname u8:#1\string #2\endcsname}% \def\UTFviiiThreeOctetsName#1#2#3{% \csname u8:#1\string #2\string #3\endcsname}% \def\UTFviiiFourOctetsName#1#2#3#4{% \csname u8:#1\string #2\string #3\string #4\endcsname}% % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX), % provide a definition macro to replace a Unicode character; % this gets used by the @U command % \begingroup \catcode`\"=12 \catcode`\<=12 \catcode`\.=12 \catcode`\,=12 \catcode`\;=12 \catcode`\!=12 \catcode`\~=13 \gdef\DeclareUnicodeCharacterUTFviii#1#2{% \countUTFz = "#1\relax \begingroup \parseXMLCharref % Give \u8:... its definition. The sequence of seven \expandafter's % expands after the \gdef three times, e.g. % % 1. \UTFviiTwoOctetsName B1 B2 % 2. \csname u8:B1 \string B2 \endcsname % 3. \u8: B1 B2 (a single control sequence token) % \expandafter\expandafter \expandafter\expandafter \expandafter\expandafter \expandafter\gdef \UTFviiiTmp{#2}% % \expandafter\ifx\csname uni:#1\endcsname \relax \else \message{Internal error, already defined: #1}% \fi % % define an additional control sequence for this code point. \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp \endgroup} % % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp % to the corresponding UTF-8 sequence. \gdef\parseXMLCharref{% \ifnum\countUTFz < "A0\relax \errhelp = \EMsimple \errmessage{Cannot define Unicode char value < 00A0}% \else\ifnum\countUTFz < "800\relax \parseUTFviiiA,% \parseUTFviiiB C\UTFviiiTwoOctetsName.,% \else\ifnum\countUTFz < "10000\relax \parseUTFviiiA;% \parseUTFviiiA,% \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}% \else \parseUTFviiiA;% \parseUTFviiiA,% \parseUTFviiiA!% \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}% \fi\fi\fi } % Extract a byte from the end of the UTF-8 representation of \countUTFx. % It must be a non-initial byte in the sequence. % Change \uccode of #1 for it to be used in \parseUTFviiiB as one % of the bytes. \gdef\parseUTFviiiA#1{% \countUTFx = \countUTFz \divide\countUTFz by 64 \countUTFy = \countUTFz % Save to be the future value of \countUTFz. \multiply\countUTFz by 64 % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract % in order to get the last five bits. \advance\countUTFx by -\countUTFz % Convert this to the byte in the UTF-8 sequence. \advance\countUTFx by 128 \uccode `#1\countUTFx \countUTFz = \countUTFy} % Used to put a UTF-8 byte sequence into \UTFviiiTmp % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8 % sequence. % #2 is one of the \UTFviii*OctetsName macros. % #3 is always a full stop (.) % #4 is a template for the other bytes in the sequence. The values for these % bytes is substituted in here with \uppercase using the \uccode's. \gdef\parseUTFviiiB#1#2#3#4{% \advance\countUTFz by "#10\relax \uccode `#3\countUTFz \uppercase{\gdef\UTFviiiTmp{#2#3#4}}} \endgroup % For native Unicode handling (XeTeX and LuaTeX), % provide a definition macro that sets a catcode to `other' non-globally % \def\DeclareUnicodeCharacterNativeOther#1#2{% \catcode"#1=\other } % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block) % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block) % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B % % Many of our renditions are less than wonderful, and all the missing % characters are available somewhere. Loading the necessary fonts % awaits user request. We can't truly support Unicode without % reimplementing everything that's been done in LaTeX for many years, % plus probably using luatex or xetex, and who knows what else. % We won't be doing that here in this simple file. But we can try to at % least make most of the characters not bomb out. % \def\unicodechardefs{% \DeclareUnicodeCharacter{00A0}{\tie}% \DeclareUnicodeCharacter{00A1}{\exclamdown}% \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent \DeclareUnicodeCharacter{00A3}{\pounds{}}% \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar \DeclareUnicodeCharacter{00A7}{\S}% \DeclareUnicodeCharacter{00A8}{\"{ }}% \DeclareUnicodeCharacter{00A9}{\copyright{}}% \DeclareUnicodeCharacter{00AA}{\ordf}% \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}% \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}% \DeclareUnicodeCharacter{00AD}{\-}% \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}% \DeclareUnicodeCharacter{00AF}{\={ }}% % \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}% \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}% \DeclareUnicodeCharacter{00B2}{$^2$}% \DeclareUnicodeCharacter{00B3}{$^3$}% \DeclareUnicodeCharacter{00B4}{\'{ }}% \DeclareUnicodeCharacter{00B5}{$\mu$}% \DeclareUnicodeCharacter{00B6}{\P}% \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}% \DeclareUnicodeCharacter{00B8}{\cedilla{ }}% \DeclareUnicodeCharacter{00B9}{$^1$}% \DeclareUnicodeCharacter{00BA}{\ordm}% \DeclareUnicodeCharacter{00BB}{\guillemetright{}}% \DeclareUnicodeCharacter{00BC}{$1\over4$}% \DeclareUnicodeCharacter{00BD}{$1\over2$}% \DeclareUnicodeCharacter{00BE}{$3\over4$}% \DeclareUnicodeCharacter{00BF}{\questiondown}% % \DeclareUnicodeCharacter{00C0}{\`A}% \DeclareUnicodeCharacter{00C1}{\'A}% \DeclareUnicodeCharacter{00C2}{\^A}% \DeclareUnicodeCharacter{00C3}{\~A}% \DeclareUnicodeCharacter{00C4}{\"A}% \DeclareUnicodeCharacter{00C5}{\AA}% \DeclareUnicodeCharacter{00C6}{\AE}% \DeclareUnicodeCharacter{00C7}{\cedilla{C}}% \DeclareUnicodeCharacter{00C8}{\`E}% \DeclareUnicodeCharacter{00C9}{\'E}% \DeclareUnicodeCharacter{00CA}{\^E}% \DeclareUnicodeCharacter{00CB}{\"E}% \DeclareUnicodeCharacter{00CC}{\`I}% \DeclareUnicodeCharacter{00CD}{\'I}% \DeclareUnicodeCharacter{00CE}{\^I}% \DeclareUnicodeCharacter{00CF}{\"I}% % \DeclareUnicodeCharacter{00D0}{\DH}% \DeclareUnicodeCharacter{00D1}{\~N}% \DeclareUnicodeCharacter{00D2}{\`O}% \DeclareUnicodeCharacter{00D3}{\'O}% \DeclareUnicodeCharacter{00D4}{\^O}% \DeclareUnicodeCharacter{00D5}{\~O}% \DeclareUnicodeCharacter{00D6}{\"O}% \DeclareUnicodeCharacter{00D7}{\ensuremath\times}% \DeclareUnicodeCharacter{00D8}{\O}% \DeclareUnicodeCharacter{00D9}{\`U}% \DeclareUnicodeCharacter{00DA}{\'U}% \DeclareUnicodeCharacter{00DB}{\^U}% \DeclareUnicodeCharacter{00DC}{\"U}% \DeclareUnicodeCharacter{00DD}{\'Y}% \DeclareUnicodeCharacter{00DE}{\TH}% \DeclareUnicodeCharacter{00DF}{\ss}% % \DeclareUnicodeCharacter{00E0}{\`a}% \DeclareUnicodeCharacter{00E1}{\'a}% \DeclareUnicodeCharacter{00E2}{\^a}% \DeclareUnicodeCharacter{00E3}{\~a}% \DeclareUnicodeCharacter{00E4}{\"a}% \DeclareUnicodeCharacter{00E5}{\aa}% \DeclareUnicodeCharacter{00E6}{\ae}% \DeclareUnicodeCharacter{00E7}{\cedilla{c}}% \DeclareUnicodeCharacter{00E8}{\`e}% \DeclareUnicodeCharacter{00E9}{\'e}% \DeclareUnicodeCharacter{00EA}{\^e}% \DeclareUnicodeCharacter{00EB}{\"e}% \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}% \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}% \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}% \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}% % \DeclareUnicodeCharacter{00F0}{\dh}% \DeclareUnicodeCharacter{00F1}{\~n}% \DeclareUnicodeCharacter{00F2}{\`o}% \DeclareUnicodeCharacter{00F3}{\'o}% \DeclareUnicodeCharacter{00F4}{\^o}% \DeclareUnicodeCharacter{00F5}{\~o}% \DeclareUnicodeCharacter{00F6}{\"o}% \DeclareUnicodeCharacter{00F7}{\ensuremath\div}% \DeclareUnicodeCharacter{00F8}{\o}% \DeclareUnicodeCharacter{00F9}{\`u}% \DeclareUnicodeCharacter{00FA}{\'u}% \DeclareUnicodeCharacter{00FB}{\^u}% \DeclareUnicodeCharacter{00FC}{\"u}% \DeclareUnicodeCharacter{00FD}{\'y}% \DeclareUnicodeCharacter{00FE}{\th}% \DeclareUnicodeCharacter{00FF}{\"y}% % \DeclareUnicodeCharacter{0100}{\=A}% \DeclareUnicodeCharacter{0101}{\=a}% \DeclareUnicodeCharacter{0102}{\u{A}}% \DeclareUnicodeCharacter{0103}{\u{a}}% \DeclareUnicodeCharacter{0104}{\ogonek{A}}% \DeclareUnicodeCharacter{0105}{\ogonek{a}}% \DeclareUnicodeCharacter{0106}{\'C}% \DeclareUnicodeCharacter{0107}{\'c}% \DeclareUnicodeCharacter{0108}{\^C}% \DeclareUnicodeCharacter{0109}{\^c}% \DeclareUnicodeCharacter{010A}{\dotaccent{C}}% \DeclareUnicodeCharacter{010B}{\dotaccent{c}}% \DeclareUnicodeCharacter{010C}{\v{C}}% \DeclareUnicodeCharacter{010D}{\v{c}}% \DeclareUnicodeCharacter{010E}{\v{D}}% \DeclareUnicodeCharacter{010F}{d'}% % \DeclareUnicodeCharacter{0110}{\DH}% \DeclareUnicodeCharacter{0111}{\dh}% \DeclareUnicodeCharacter{0112}{\=E}% \DeclareUnicodeCharacter{0113}{\=e}% \DeclareUnicodeCharacter{0114}{\u{E}}% \DeclareUnicodeCharacter{0115}{\u{e}}% \DeclareUnicodeCharacter{0116}{\dotaccent{E}}% \DeclareUnicodeCharacter{0117}{\dotaccent{e}}% \DeclareUnicodeCharacter{0118}{\ogonek{E}}% \DeclareUnicodeCharacter{0119}{\ogonek{e}}% \DeclareUnicodeCharacter{011A}{\v{E}}% \DeclareUnicodeCharacter{011B}{\v{e}}% \DeclareUnicodeCharacter{011C}{\^G}% \DeclareUnicodeCharacter{011D}{\^g}% \DeclareUnicodeCharacter{011E}{\u{G}}% \DeclareUnicodeCharacter{011F}{\u{g}}% % \DeclareUnicodeCharacter{0120}{\dotaccent{G}}% \DeclareUnicodeCharacter{0121}{\dotaccent{g}}% \DeclareUnicodeCharacter{0122}{\cedilla{G}}% \DeclareUnicodeCharacter{0123}{\cedilla{g}}% \DeclareUnicodeCharacter{0124}{\^H}% \DeclareUnicodeCharacter{0125}{\^h}% \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}% \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}% \DeclareUnicodeCharacter{0128}{\~I}% \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}% \DeclareUnicodeCharacter{012A}{\=I}% \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}% \DeclareUnicodeCharacter{012C}{\u{I}}% \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}% \DeclareUnicodeCharacter{012E}{\ogonek{I}}% \DeclareUnicodeCharacter{012F}{\ogonek{i}}% % \DeclareUnicodeCharacter{0130}{\dotaccent{I}}% \DeclareUnicodeCharacter{0131}{\dotless{i}}% \DeclareUnicodeCharacter{0132}{IJ}% \DeclareUnicodeCharacter{0133}{ij}% \DeclareUnicodeCharacter{0134}{\^J}% \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}% \DeclareUnicodeCharacter{0136}{\cedilla{K}}% \DeclareUnicodeCharacter{0137}{\cedilla{k}}% \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}% \DeclareUnicodeCharacter{0139}{\'L}% \DeclareUnicodeCharacter{013A}{\'l}% \DeclareUnicodeCharacter{013B}{\cedilla{L}}% \DeclareUnicodeCharacter{013C}{\cedilla{l}}% \DeclareUnicodeCharacter{013D}{L'}% should kern \DeclareUnicodeCharacter{013E}{l'}% should kern \DeclareUnicodeCharacter{013F}{L\U{00B7}}% % \DeclareUnicodeCharacter{0140}{l\U{00B7}}% \DeclareUnicodeCharacter{0141}{\L}% \DeclareUnicodeCharacter{0142}{\l}% \DeclareUnicodeCharacter{0143}{\'N}% \DeclareUnicodeCharacter{0144}{\'n}% \DeclareUnicodeCharacter{0145}{\cedilla{N}}% \DeclareUnicodeCharacter{0146}{\cedilla{n}}% \DeclareUnicodeCharacter{0147}{\v{N}}% \DeclareUnicodeCharacter{0148}{\v{n}}% \DeclareUnicodeCharacter{0149}{'n}% \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}% \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}% \DeclareUnicodeCharacter{014C}{\=O}% \DeclareUnicodeCharacter{014D}{\=o}% \DeclareUnicodeCharacter{014E}{\u{O}}% \DeclareUnicodeCharacter{014F}{\u{o}}% % \DeclareUnicodeCharacter{0150}{\H{O}}% \DeclareUnicodeCharacter{0151}{\H{o}}% \DeclareUnicodeCharacter{0152}{\OE}% \DeclareUnicodeCharacter{0153}{\oe}% \DeclareUnicodeCharacter{0154}{\'R}% \DeclareUnicodeCharacter{0155}{\'r}% \DeclareUnicodeCharacter{0156}{\cedilla{R}}% \DeclareUnicodeCharacter{0157}{\cedilla{r}}% \DeclareUnicodeCharacter{0158}{\v{R}}% \DeclareUnicodeCharacter{0159}{\v{r}}% \DeclareUnicodeCharacter{015A}{\'S}% \DeclareUnicodeCharacter{015B}{\'s}% \DeclareUnicodeCharacter{015C}{\^S}% \DeclareUnicodeCharacter{015D}{\^s}% \DeclareUnicodeCharacter{015E}{\cedilla{S}}% \DeclareUnicodeCharacter{015F}{\cedilla{s}}% % \DeclareUnicodeCharacter{0160}{\v{S}}% \DeclareUnicodeCharacter{0161}{\v{s}}% \DeclareUnicodeCharacter{0162}{\cedilla{T}}% \DeclareUnicodeCharacter{0163}{\cedilla{t}}% \DeclareUnicodeCharacter{0164}{\v{T}}% \DeclareUnicodeCharacter{0165}{\v{t}}% \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}% \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}% \DeclareUnicodeCharacter{0168}{\~U}% \DeclareUnicodeCharacter{0169}{\~u}% \DeclareUnicodeCharacter{016A}{\=U}% \DeclareUnicodeCharacter{016B}{\=u}% \DeclareUnicodeCharacter{016C}{\u{U}}% \DeclareUnicodeCharacter{016D}{\u{u}}% \DeclareUnicodeCharacter{016E}{\ringaccent{U}}% \DeclareUnicodeCharacter{016F}{\ringaccent{u}}% % \DeclareUnicodeCharacter{0170}{\H{U}}% \DeclareUnicodeCharacter{0171}{\H{u}}% \DeclareUnicodeCharacter{0172}{\ogonek{U}}% \DeclareUnicodeCharacter{0173}{\ogonek{u}}% \DeclareUnicodeCharacter{0174}{\^W}% \DeclareUnicodeCharacter{0175}{\^w}% \DeclareUnicodeCharacter{0176}{\^Y}% \DeclareUnicodeCharacter{0177}{\^y}% \DeclareUnicodeCharacter{0178}{\"Y}% \DeclareUnicodeCharacter{0179}{\'Z}% \DeclareUnicodeCharacter{017A}{\'z}% \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}% \DeclareUnicodeCharacter{017C}{\dotaccent{z}}% \DeclareUnicodeCharacter{017D}{\v{Z}}% \DeclareUnicodeCharacter{017E}{\v{z}}% \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}% % \DeclareUnicodeCharacter{01C4}{D\v{Z}}% \DeclareUnicodeCharacter{01C5}{D\v{z}}% \DeclareUnicodeCharacter{01C6}{d\v{z}}% \DeclareUnicodeCharacter{01C7}{LJ}% \DeclareUnicodeCharacter{01C8}{Lj}% \DeclareUnicodeCharacter{01C9}{lj}% \DeclareUnicodeCharacter{01CA}{NJ}% \DeclareUnicodeCharacter{01CB}{Nj}% \DeclareUnicodeCharacter{01CC}{nj}% \DeclareUnicodeCharacter{01CD}{\v{A}}% \DeclareUnicodeCharacter{01CE}{\v{a}}% \DeclareUnicodeCharacter{01CF}{\v{I}}% % \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}% \DeclareUnicodeCharacter{01D1}{\v{O}}% \DeclareUnicodeCharacter{01D2}{\v{o}}% \DeclareUnicodeCharacter{01D3}{\v{U}}% \DeclareUnicodeCharacter{01D4}{\v{u}}% % \DeclareUnicodeCharacter{01E2}{\={\AE}}% \DeclareUnicodeCharacter{01E3}{\={\ae}}% \DeclareUnicodeCharacter{01E6}{\v{G}}% \DeclareUnicodeCharacter{01E7}{\v{g}}% \DeclareUnicodeCharacter{01E8}{\v{K}}% \DeclareUnicodeCharacter{01E9}{\v{k}}% % \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}% \DeclareUnicodeCharacter{01F1}{DZ}% \DeclareUnicodeCharacter{01F2}{Dz}% \DeclareUnicodeCharacter{01F3}{dz}% \DeclareUnicodeCharacter{01F4}{\'G}% \DeclareUnicodeCharacter{01F5}{\'g}% \DeclareUnicodeCharacter{01F8}{\`N}% \DeclareUnicodeCharacter{01F9}{\`n}% \DeclareUnicodeCharacter{01FC}{\'{\AE}}% \DeclareUnicodeCharacter{01FD}{\'{\ae}}% \DeclareUnicodeCharacter{01FE}{\'{\O}}% \DeclareUnicodeCharacter{01FF}{\'{\o}}% % \DeclareUnicodeCharacter{021E}{\v{H}}% \DeclareUnicodeCharacter{021F}{\v{h}}% % \DeclareUnicodeCharacter{0226}{\dotaccent{A}}% \DeclareUnicodeCharacter{0227}{\dotaccent{a}}% \DeclareUnicodeCharacter{0228}{\cedilla{E}}% \DeclareUnicodeCharacter{0229}{\cedilla{e}}% \DeclareUnicodeCharacter{022E}{\dotaccent{O}}% \DeclareUnicodeCharacter{022F}{\dotaccent{o}}% % \DeclareUnicodeCharacter{0232}{\=Y}% \DeclareUnicodeCharacter{0233}{\=y}% \DeclareUnicodeCharacter{0237}{\dotless{j}}% % \DeclareUnicodeCharacter{02BC}{'}% % \DeclareUnicodeCharacter{02DB}{\ogonek{ }}% % % Greek letters upper case \DeclareUnicodeCharacter{0391}{{\it A}}% \DeclareUnicodeCharacter{0392}{{\it B}}% \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}% \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}% \DeclareUnicodeCharacter{0395}{{\it E}}% \DeclareUnicodeCharacter{0396}{{\it Z}}% \DeclareUnicodeCharacter{0397}{{\it H}}% \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}% \DeclareUnicodeCharacter{0399}{{\it I}}% \DeclareUnicodeCharacter{039A}{{\it K}}% \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}% \DeclareUnicodeCharacter{039C}{{\it M}}% \DeclareUnicodeCharacter{039D}{{\it N}}% \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}% \DeclareUnicodeCharacter{039F}{{\it O}}% \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}% \DeclareUnicodeCharacter{03A1}{{\it P}}% %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}% \DeclareUnicodeCharacter{03A4}{{\it T}}% \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}% \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}% \DeclareUnicodeCharacter{03A7}{{\it X}}% \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}% \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}% % % Vowels with accents \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}% \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}% \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}% \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}% \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}% \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}% % % Standalone accent \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}% % % Greek letters lower case \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}% \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}% \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}% \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}% \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}% \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}% \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}% \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}% \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}% \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}% \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}% \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}% \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}% \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}% \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}% \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}% \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}% \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}% \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}% \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}% \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}% \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}% \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}% \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}% % % More Greek vowels with accents \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}% \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}% \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}% \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}% \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}% % % Variant Greek letters \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}% \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}% \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}% % \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}% \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}% \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}% \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}% \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}% \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}% \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}% \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}% \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}% \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}% \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}% \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}% % \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}% \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}% % \DeclareUnicodeCharacter{1E20}{\=G}% \DeclareUnicodeCharacter{1E21}{\=g}% \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}% \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}% \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}% \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}% \DeclareUnicodeCharacter{1E26}{\"H}% \DeclareUnicodeCharacter{1E27}{\"h}% % \DeclareUnicodeCharacter{1E30}{\'K}% \DeclareUnicodeCharacter{1E31}{\'k}% \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}% \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}% \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}% \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}% \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}% \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}% \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}% \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}% \DeclareUnicodeCharacter{1E3E}{\'M}% \DeclareUnicodeCharacter{1E3F}{\'m}% % \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}% \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}% \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}% \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}% \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}% \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}% \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}% \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}% \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}% \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}% % \DeclareUnicodeCharacter{1E54}{\'P}% \DeclareUnicodeCharacter{1E55}{\'p}% \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}% \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}% \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}% \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}% \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}% \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}% \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}% \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}% % \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}% \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}% \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}% \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}% \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}% \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}% \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}% \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}% \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}% \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}% % \DeclareUnicodeCharacter{1E7C}{\~V}% \DeclareUnicodeCharacter{1E7D}{\~v}% \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}% \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}% % \DeclareUnicodeCharacter{1E80}{\`W}% \DeclareUnicodeCharacter{1E81}{\`w}% \DeclareUnicodeCharacter{1E82}{\'W}% \DeclareUnicodeCharacter{1E83}{\'w}% \DeclareUnicodeCharacter{1E84}{\"W}% \DeclareUnicodeCharacter{1E85}{\"w}% \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}% \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}% \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}% \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}% \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}% \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}% \DeclareUnicodeCharacter{1E8C}{\"X}% \DeclareUnicodeCharacter{1E8D}{\"x}% \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}% \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}% % \DeclareUnicodeCharacter{1E90}{\^Z}% \DeclareUnicodeCharacter{1E91}{\^z}% \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}% \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}% \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}% \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}% \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}% \DeclareUnicodeCharacter{1E97}{\"t}% \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}% \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}% % \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}% \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}% % \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}% \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}% \DeclareUnicodeCharacter{1EBC}{\~E}% \DeclareUnicodeCharacter{1EBD}{\~e}% % \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}% \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}% \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}% \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}% % \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}% \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}% % \DeclareUnicodeCharacter{1EF2}{\`Y}% \DeclareUnicodeCharacter{1EF3}{\`y}% \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}% % \DeclareUnicodeCharacter{1EF8}{\~Y}% \DeclareUnicodeCharacter{1EF9}{\~y}% % % Punctuation \DeclareUnicodeCharacter{2013}{--}% \DeclareUnicodeCharacter{2014}{---}% \DeclareUnicodeCharacter{2018}{\quoteleft{}}% \DeclareUnicodeCharacter{2019}{\quoteright{}}% \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}% \DeclareUnicodeCharacter{201C}{\quotedblleft{}}% \DeclareUnicodeCharacter{201D}{\quotedblright{}}% \DeclareUnicodeCharacter{201E}{\quotedblbase{}}% \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}% \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}% \DeclareUnicodeCharacter{2022}{\bullet{}}% \DeclareUnicodeCharacter{202F}{\thinspace}% \DeclareUnicodeCharacter{2026}{\dots{}}% \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}% \DeclareUnicodeCharacter{203A}{\guilsinglright{}}% % \DeclareUnicodeCharacter{20AC}{\euro{}}% % \DeclareUnicodeCharacter{2192}{\expansion{}}% \DeclareUnicodeCharacter{21D2}{\result{}}% % % Mathematical symbols \DeclareUnicodeCharacter{2200}{\ensuremath\forall}% \DeclareUnicodeCharacter{2203}{\ensuremath\exists}% \DeclareUnicodeCharacter{2208}{\ensuremath\in}% \DeclareUnicodeCharacter{2212}{\minus{}}% \DeclareUnicodeCharacter{2217}{\ast}% \DeclareUnicodeCharacter{221E}{\ensuremath\infty}% \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}% \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}% \DeclareUnicodeCharacter{2229}{\ensuremath\cap}% \DeclareUnicodeCharacter{2261}{\equiv{}}% \DeclareUnicodeCharacter{2264}{\ensuremath\leq}% \DeclareUnicodeCharacter{2265}{\ensuremath\geq}% \DeclareUnicodeCharacter{2282}{\ensuremath\subset}% \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}% % \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}% \DeclareUnicodeCharacter{2032}{\ensuremath\prime}% \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}% \DeclareUnicodeCharacter{2111}{\ensuremath\Im}% \DeclareUnicodeCharacter{2113}{\ensuremath\ell}% \DeclareUnicodeCharacter{2118}{\ensuremath\wp}% \DeclareUnicodeCharacter{211C}{\ensuremath\Re}% \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}% \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}% \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}% \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}% \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}% \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}% \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}% \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}% \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}% \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}% \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}% \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}% \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}% \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}% \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}% \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}% \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}% \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}% \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}% \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}% \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}% \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}% \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}% \DeclareUnicodeCharacter{2202}{\ensuremath\partial}% \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}% \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}% \DeclareUnicodeCharacter{2209}{\ensuremath\notin}% \DeclareUnicodeCharacter{220B}{\ensuremath\owns}% \DeclareUnicodeCharacter{220F}{\ensuremath\prod}% \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}% \DeclareUnicodeCharacter{2211}{\ensuremath\sum}% \DeclareUnicodeCharacter{2213}{\ensuremath\mp}% \DeclareUnicodeCharacter{2218}{\ensuremath\circ}% \DeclareUnicodeCharacter{221A}{\ensuremath\surd}% \DeclareUnicodeCharacter{221D}{\ensuremath\propto}% \DeclareUnicodeCharacter{2220}{\ensuremath\angle}% \DeclareUnicodeCharacter{2223}{\ensuremath\mid}% \DeclareUnicodeCharacter{2228}{\ensuremath\vee}% \DeclareUnicodeCharacter{222A}{\ensuremath\cup}% \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}% \DeclareUnicodeCharacter{222E}{\ensuremath\oint}% \DeclareUnicodeCharacter{223C}{\ensuremath\sim}% \DeclareUnicodeCharacter{2240}{\ensuremath\wr}% \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}% \DeclareUnicodeCharacter{2245}{\ensuremath\cong}% \DeclareUnicodeCharacter{2248}{\ensuremath\approx}% \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}% \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}% \DeclareUnicodeCharacter{2260}{\ensuremath\neq}% \DeclareUnicodeCharacter{226A}{\ensuremath\ll}% \DeclareUnicodeCharacter{226B}{\ensuremath\gg}% \DeclareUnicodeCharacter{227A}{\ensuremath\prec}% \DeclareUnicodeCharacter{227B}{\ensuremath\succ}% \DeclareUnicodeCharacter{2283}{\ensuremath\supset}% \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}% \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}% \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}% \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}% \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}% \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}% \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}% \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}% \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}% \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}% \DeclareUnicodeCharacter{2299}{\ensuremath\odot}% \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}% \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}% \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}% \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}% \DeclareUnicodeCharacter{22A8}{\ensuremath\models}% \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}% \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}% \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}% \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}% \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}% \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}% \DeclareUnicodeCharacter{22C6}{\ensuremath\star}% \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}% \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}% \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}% \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}% \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}% \DeclareUnicodeCharacter{2322}{\ensuremath\frown}% \DeclareUnicodeCharacter{2323}{\ensuremath\smile}% % \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}% \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}% \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}% \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}% \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}% \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}% \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}% \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}% \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}% \DeclareUnicodeCharacter{266D}{\ensuremath\flat}% \DeclareUnicodeCharacter{266E}{\ensuremath\natural}% \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}% \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}% \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}% \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}% \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}% \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}% \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}% \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}% \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}% \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}% \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}% \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}% \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}% \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}% \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}% \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}% \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}% \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}% % \global\mathchardef\checkmark="1370% actually the square root sign \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}% }% end of \unicodechardefs % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command) % It makes the setting that replace UTF-8 byte sequence. \def\utfeightchardefs{% \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii \unicodechardefs } % Whether the active definitions of non-ASCII characters expand to % non-active tokens with the same character code. This is used to % write characters literally, instead of using active definitions for % printing the correct glyphs. \newif\ifpassthroughchars \passthroughcharsfalse % For native Unicode handling (XeTeX and LuaTeX), % provide a definition macro to replace/pass-through a Unicode character % \def\DeclareUnicodeCharacterNative#1#2{% \catcode"#1=\active \def\dodeclareunicodecharacternative##1##2##3{% \begingroup \uccode`\~="##2\relax \uppercase{\gdef~}{% \ifpassthroughchars ##1% \else ##3% \fi } \endgroup } \begingroup \uccode`\.="#1\relax \uppercase{\def\UTFNativeTmp{.}}% \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}% \endgroup } % Native Unicode handling (XeTeX and LuaTeX) character replacing definition. % It activates the setting that replaces Unicode characters. \def\nativeunicodechardefs{% \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative \unicodechardefs } % For native Unicode handling (XeTeX and LuaTeX), % make the character token expand % to the sequences given in \unicodechardefs for printing. \def\DeclareUnicodeCharacterNativeAtU#1#2{% \def\UTFAtUTmp{#2} \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp } % @U command definitions for native Unicode handling (XeTeX and LuaTeX). \def\nativeunicodechardefsatu{% \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU \unicodechardefs } % US-ASCII character definitions. \def\asciichardefs{% nothing need be done \relax } % Define all Unicode characters we know about. This makes UTF-8 the default % input encoding and allows @U to work. \iftxinativeunicodecapable \nativeunicodechardefsatu \else \utfeightchardefs \fi \message{formatting,} \newdimen\defaultparindent \defaultparindent = 15pt \chapheadingskip = 15pt plus 4pt minus 2pt \secheadingskip = 12pt plus 3pt minus 2pt \subsecheadingskip = 9pt plus 2pt minus 2pt % Prevent underfull vbox error messages. \vbadness = 10000 % Don't be very finicky about underfull hboxes, either. \hbadness = 6666 % Following George Bush, get rid of widows and orphans. \widowpenalty=10000 \clubpenalty=10000 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're % using an old version of TeX, don't do anything. We want the amount of % stretch added to depend on the line length, hence the dependence on % \hsize. We call this whenever the paper size is set. % \def\setemergencystretch{% \ifx\emergencystretch\thisisundefined % Allow us to assign to \emergencystretch anyway. \def\emergencystretch{\dimen0}% \else \emergencystretch = .15\hsize \fi } % Parameters in order: 1) textheight; 2) textwidth; % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; % 7) physical page height; 8) physical page width. % % We also call \setleading{\textleading}, so the caller should define % \textleading. The caller should also set \parskip. % \def\internalpagesizes#1#2#3#4#5#6#7#8{% \voffset = #3\relax \topskip = #6\relax \splittopskip = \topskip % \vsize = #1\relax \advance\vsize by \topskip \outervsize = \vsize \advance\outervsize by 2\topandbottommargin \txipageheight = \vsize % \hsize = #2\relax \outerhsize = \hsize \advance\outerhsize by 0.5in \txipagewidth = \hsize % \normaloffset = #4\relax \bindingoffset = #5\relax % \ifpdf \pdfpageheight #7\relax \pdfpagewidth #8\relax % if we don't reset these, they will remain at "1 true in" of % whatever layout pdftex was dumped with. \pdfhorigin = 1 true in \pdfvorigin = 1 true in \else \ifx\XeTeXrevision\thisisundefined \special{papersize=#8,#7}% \else \pdfpageheight #7\relax \pdfpagewidth #8\relax % XeTeX does not have \pdfhorigin and \pdfvorigin. \fi \fi % \setleading{\textleading} % \parindent = \defaultparindent \setemergencystretch } % @letterpaper (the default). \def\letterpaper{{\globaldefs = 1 \parskip = 3pt plus 2pt minus 1pt \textleading = 13.2pt % % If page is nothing but text, make it come out even. \internalpagesizes{607.2pt}{6in}% that's 46 lines {\voffset}{.25in}% {\bindingoffset}{36pt}% {11in}{8.5in}% }} % Use @smallbook to reset parameters for 7x9.25 trim size. \def\smallbook{{\globaldefs = 1 \parskip = 2pt plus 1pt \textleading = 12pt % \internalpagesizes{7.5in}{5in}% {-.2in}{0in}% {\bindingoffset}{16pt}% {9.25in}{7in}% % \lispnarrowing = 0.3in \tolerance = 700 \contentsrightmargin = 0pt \defbodyindent = .5cm }} % Use @smallerbook to reset parameters for 6x9 trim size. % (Just testing, parameters still in flux.) \def\smallerbook{{\globaldefs = 1 \parskip = 1.5pt plus 1pt \textleading = 12pt % \internalpagesizes{7.4in}{4.8in}% {-.2in}{-.4in}% {0pt}{14pt}% {9in}{6in}% % \lispnarrowing = 0.25in \tolerance = 700 \contentsrightmargin = 0pt \defbodyindent = .4cm }} % Use @afourpaper to print on European A4 paper. \def\afourpaper{{\globaldefs = 1 \parskip = 3pt plus 2pt minus 1pt \textleading = 13.2pt % % Double-side printing via postscript on Laserjet 4050 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. % To change the settings for a different printer or situation, adjust % \normaloffset until the front-side and back-side texts align. Then % do the same for \bindingoffset. You can set these for testing in % your texinfo source file like this: % @tex % \global\normaloffset = -6mm % \global\bindingoffset = 10mm % @end tex \internalpagesizes{673.2pt}{160mm}% that's 51 lines {\voffset}{\hoffset}% {\bindingoffset}{44pt}% {297mm}{210mm}% % \tolerance = 700 \contentsrightmargin = 0pt \defbodyindent = 5mm }} % Use @afivepaper to print on European A5 paper. % From romildo@urano.iceb.ufop.br, 2 July 2000. % He also recommends making @example and @lisp be small. \def\afivepaper{{\globaldefs = 1 \parskip = 2pt plus 1pt minus 0.1pt \textleading = 12.5pt % \internalpagesizes{160mm}{120mm}% {\voffset}{\hoffset}% {\bindingoffset}{8pt}% {210mm}{148mm}% % \lispnarrowing = 0.2in \tolerance = 800 \contentsrightmargin = 0pt \defbodyindent = 2mm \tableindent = 12mm }} % A specific text layout, 24x15cm overall, intended for A4 paper. \def\afourlatex{{\globaldefs = 1 \afourpaper \internalpagesizes{237mm}{150mm}% {\voffset}{4.6mm}% {\bindingoffset}{7mm}% {297mm}{210mm}% % % Must explicitly reset to 0 because we call \afourpaper. \globaldefs = 0 }} % Use @afourwide to print on A4 paper in landscape format. \def\afourwide{{\globaldefs = 1 \afourpaper \internalpagesizes{241mm}{165mm}% {\voffset}{-2.95mm}% {\bindingoffset}{7mm}% {297mm}{210mm}% \globaldefs = 0 }} \def\bsixpaper{{\globaldefs = 1 \afourpaper \internalpagesizes{140mm}{100mm}% {-6.35mm}{-12.7mm}% {\bindingoffset}{14pt}% {176mm}{125mm}% \let\SETdispenvsize=\smallword \lispnarrowing = 0.2in \globaldefs = 0 }} % @pagesizes TEXTHEIGHT[,TEXTWIDTH] % Perhaps we should allow setting the margins, \topskip, \parskip, % and/or leading, also. Or perhaps we should compute them somehow. % \parseargdef\pagesizes{\pagesizesyyy #1,,\finish} \def\pagesizesyyy#1,#2,#3\finish{{% \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi \globaldefs = 1 % \parskip = 3pt plus 2pt minus 1pt \setleading{\textleading}% % \dimen0 = #1\relax \advance\dimen0 by 2.5in % default 1in margin above heading line % and 1.5in to include heading, footing and % bottom margin % \dimen2 = \hsize \advance\dimen2 by 2in % default to 1 inch margin on each side % \internalpagesizes{#1}{\hsize}% {\voffset}{\normaloffset}% {\bindingoffset}{44pt}% {\dimen0}{\dimen2}% }} % Set default to letter. % \letterpaper % Default value of \hfuzz, for suppressing warnings about overfull hboxes. \hfuzz = 1pt \message{and turning on texinfo input format.} \def^^L{\par} % remove \outer, so ^L can appear in an @comment % DEL is a comment character, in case @c does not suffice. \catcode`\^^? = 14 % Define macros to output various characters with catcode for normal text. \catcode`\"=\other \def\normaldoublequote{"} \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix \catcode`\+=\other \def\normalplus{+} \catcode`\<=\other \def\normalless{<} \catcode`\>=\other \def\normalgreater{>} \catcode`\^=\other \def\normalcaret{^} \catcode`\_=\other \def\normalunderscore{_} \catcode`\|=\other \def\normalverticalbar{|} \catcode`\~=\other \def\normaltilde{~} % This macro is used to make a character print one way in \tt % (where it can probably be output as-is), and another way in other fonts, % where something hairier probably needs to be done. % % #1 is what to print if we are indeed using \tt; #2 is what to print % otherwise. Since all the Computer Modern typewriter fonts have zero % interword stretch (and shrink), and it is reasonable to expect all % typewriter fonts to have this, we can check that font parameter. % \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} % Same as above, but check for italic font. Actually this also catches % non-italic slanted fonts since it is impossible to distinguish them from % italic fonts. But since this is only used by $ and it uses \sl anyway % this is not a problem. \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} % Set catcodes for Texinfo file % Active characters for printing the wanted glyph. % Most of these we simply print from the \tt font, but for some, we can % use math or other variants that look better in normal text. % \catcode`\"=\active \def\activedoublequote{{\tt\char34}} \let"=\activedoublequote \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde \chardef\hatchar=`\^ \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat \catcode`\_=\active \def_{\ifusingtt\normalunderscore\_} \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } \let\realunder=_ \catcode`\|=\active \def|{{\tt\char124}} \chardef \less=`\< \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless \chardef \gtr=`\> \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr \catcode`\+=\active \def+{{\tt \char 43}} \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix \catcode`\-=\active \let-=\normaldash % used for headline/footline in the output routine, in case the page % breaks in the middle of an @tex block. \def\texinfochars{% \let< = \activeless \let> = \activegtr \let~ = \activetilde \let^ = \activehat \markupsetuplqdefault \markupsetuprqdefault \let\b = \strong \let\i = \smartitalic % in principle, all other definitions in \tex have to be undone too. } % Used sometimes to turn off (effectively) the active characters even after % parsing them. \def\turnoffactive{% \normalturnoffactive \otherbackslash } \catcode`\@=0 % \backslashcurfont outputs one backslash character in current font, % as in \char`\\. \global\chardef\backslashcurfont=`\\ % \realbackslash is an actual character `\' with catcode other. {\catcode`\\=\other @gdef@realbackslash{\}} % In Texinfo, backslash is an active character; it prints the backslash % in fixed width font. \catcode`\\=\active % @ for escape char from now on. % Print a typewriter backslash. For math mode, we can't simply use % \backslashcurfont: the story here is that in math mode, the \char % of \backslashcurfont ends up printing the roman \ from the math symbol % font (because \char in math mode uses the \mathcode, and plain.tex % sets \mathcode`\\="026E). Hence we use an explicit \mathchar, % which is the decimal equivalent of "715c (class 7, e.g., use \fam; % ignored family value; char position "5C). We can't use " for the % usual hex value because it has already been made active. @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}} @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents. % \otherbackslash defines an active \ to be a literal `\' character with % catcode other. @gdef@otherbackslash{@let\=@realbackslash} % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of % the literal character `\'. % {@catcode`- = @active @gdef@normalturnoffactive{% @passthroughcharstrue @let-=@normaldash @let"=@normaldoublequote @let$=@normaldollar %$ font-lock fix @let+=@normalplus @let<=@normalless @let>=@normalgreater @let^=@normalcaret @let_=@normalunderscore @let|=@normalverticalbar @let~=@normaltilde @let\=@ttbackslash @markupsetuplqdefault @markupsetuprqdefault @unsepspaces } } % If a .fmt file is being used, characters that might appear in a file % name cannot be active until we have parsed the command line. % So turn them off again, and have @fixbackslash turn them back on. @catcode`+=@other @catcode`@_=@other % \enablebackslashhack - allow file to begin `\input texinfo' % % If a .fmt file is being used, we don't want the `\input texinfo' to show up. % That is what \eatinput is for; after that, the `\' should revert to printing % a backslash. % If the file did not have a `\input texinfo', then it is turned off after % the first line; otherwise the first `\' in the file would cause an error. % This is used on the very last line of this file, texinfo.tex. % We also use @c to call @fixbackslash, in case ends of lines are hidden. { @catcode`@^=7 @catcode`@^^M=13@gdef@enablebackslashhack{% @global@let\ = @eatinput% @catcode`@^^M=13% @def@c{@fixbackslash@c}% % Definition for the newline at the end of this file. @def ^^M{@let^^M@secondlinenl}% % Definition for a newline in the main Texinfo file. @gdef @secondlinenl{@fixbackslash}% % In case the first line has a whole-line command on it @let@originalparsearg@parsearg @def@parsearg{@fixbackslash@originalparsearg} }} {@catcode`@^=7 @catcode`@^^M=13% @gdef@eatinput input texinfo#1^^M{@fixbackslash}} % Emergency active definition of newline, in case an active newline token % appears by mistake. {@catcode`@^=7 @catcode13=13% @gdef@enableemergencynewline{% @gdef^^M{% @par% %@par% }}} @gdef@fixbackslash{% @ifx\@eatinput @let\ = @ttbackslash @fi @catcode13=5 % regular end of line @enableemergencynewline @let@c=@comment @let@parsearg@originalparsearg % Also turn back on active characters that might appear in the input % file name, in case not using a pre-dumped format. @catcode`+=@active @catcode`@_=@active % % If texinfo.cnf is present on the system, read it. % Useful for site-wide @afourpaper, etc. This macro, @fixbackslash, gets % called at the beginning of every Texinfo file. Not opening texinfo.cnf % directly in this file, texinfo.tex, makes it possible to make a format % file for Texinfo. % @openin 1 texinfo.cnf @ifeof 1 @else @input texinfo.cnf @fi @closein 1 } % Say @foo, not \foo, in error messages. @escapechar = `@@ % These (along with & and #) are made active for url-breaking, so need % active definitions as the normal characters. @def@normaldot{.} @def@normalquest{?} @def@normalslash{/} % These look ok in all fonts, so just make them not special. % @hashchar{} gets its own user-level command, because of #line. @catcode`@& = @other @def@normalamp{&} @catcode`@# = @other @def@normalhash{#} @catcode`@% = @other @def@normalpercent{%} @let @hashchar = @normalhash @c Finally, make ` and ' active, so that txicodequoteundirected and @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we @c don't make ` and ' active, @code will not get them as active chars. @c Do this last of all since we use ` in the previous @catcode assignments. @catcode`@'=@active @catcode`@`=@active @markupsetuplqdefault @markupsetuprqdefault @c Local variables: @c eval: (add-hook 'before-save-hook 'time-stamp) @c page-delimiter: "^\\\\message\\|emacs-page" @c time-stamp-start: "def\\\\texinfoversion{" @c time-stamp-format: "%:y-%02m-%02d.%02H" @c time-stamp-end: "}" @c End: @c vim:sw=2: @enablebackslashhack poke-elf-1.0/build-aux/tap-driver.sh0000755000175000017500000004600514365270527014323 00000000000000#! /bin/sh # Copyright (C) 2011-2020 Free Software Foundation, Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # As a special exception to the GNU General Public License, if you # distribute this file as part of a program that contains a # configuration script generated by Autoconf, you may include it under # the same distribution terms that you use for the rest of that program. # This file is maintained in Automake, please report # bugs to or send patches to # . scriptversion=2013-12-23.17; # UTC # Make unconditional expansion of undefined variables an error. This # helps a lot in preventing typo-related bugs. set -u me=tap-driver.sh fatal () { echo "$me: fatal: $*" >&2 exit 1 } usage_error () { echo "$me: $*" >&2 print_usage >&2 exit 2 } print_usage () { cat < # trap : 1 3 2 13 15 if test $merge -gt 0; then exec 2>&1 else exec 2>&3 fi "$@" echo $? ) | LC_ALL=C ${AM_TAP_AWK-awk} \ -v me="$me" \ -v test_script_name="$test_name" \ -v log_file="$log_file" \ -v trs_file="$trs_file" \ -v expect_failure="$expect_failure" \ -v merge="$merge" \ -v ignore_exit="$ignore_exit" \ -v comments="$comments" \ -v diag_string="$diag_string" \ ' # TODO: the usages of "cat >&3" below could be optimized when using # GNU awk, and/on on systems that supports /dev/fd/. # Implementation note: in what follows, `result_obj` will be an # associative array that (partly) simulates a TAP result object # from the `TAP::Parser` perl module. ## ----------- ## ## FUNCTIONS ## ## ----------- ## function fatal(msg) { print me ": " msg | "cat >&2" exit 1 } function abort(where) { fatal("internal error " where) } # Convert a boolean to a "yes"/"no" string. function yn(bool) { return bool ? "yes" : "no"; } function add_test_result(result) { if (!test_results_index) test_results_index = 0 test_results_list[test_results_index] = result test_results_index += 1 test_results_seen[result] = 1; } # Whether the test script should be re-run by "make recheck". function must_recheck() { for (k in test_results_seen) if (k != "XFAIL" && k != "PASS" && k != "SKIP") return 1 return 0 } # Whether the content of the log file associated to this test should # be copied into the "global" test-suite.log. function copy_in_global_log() { for (k in test_results_seen) if (k != "PASS") return 1 return 0 } function get_global_test_result() { if ("ERROR" in test_results_seen) return "ERROR" if ("FAIL" in test_results_seen || "XPASS" in test_results_seen) return "FAIL" all_skipped = 1 for (k in test_results_seen) if (k != "SKIP") all_skipped = 0 if (all_skipped) return "SKIP" return "PASS"; } function stringify_result_obj(result_obj) { if (result_obj["is_unplanned"] || result_obj["number"] != testno) return "ERROR" if (plan_seen == LATE_PLAN) return "ERROR" if (result_obj["directive"] == "TODO") return result_obj["is_ok"] ? "XPASS" : "XFAIL" if (result_obj["directive"] == "SKIP") return result_obj["is_ok"] ? "SKIP" : COOKED_FAIL; if (length(result_obj["directive"])) abort("in function stringify_result_obj()") return result_obj["is_ok"] ? COOKED_PASS : COOKED_FAIL } function decorate_result(result) { color_name = color_for_result[result] if (color_name) return color_map[color_name] "" result "" color_map["std"] # If we are not using colorized output, or if we do not know how # to colorize the given result, we should return it unchanged. return result } function report(result, details) { if (result ~ /^(X?(PASS|FAIL)|SKIP|ERROR)/) { msg = ": " test_script_name add_test_result(result) } else if (result == "#") { msg = " " test_script_name ":" } else { abort("in function report()") } if (length(details)) msg = msg " " details # Output on console might be colorized. print decorate_result(result) msg # Log the result in the log file too, to help debugging (this is # especially true when said result is a TAP error or "Bail out!"). print result msg | "cat >&3"; } function testsuite_error(error_message) { report("ERROR", "- " error_message) } function handle_tap_result() { details = result_obj["number"]; if (length(result_obj["description"])) details = details " " result_obj["description"] if (plan_seen == LATE_PLAN) { details = details " # AFTER LATE PLAN"; } else if (result_obj["is_unplanned"]) { details = details " # UNPLANNED"; } else if (result_obj["number"] != testno) { details = sprintf("%s # OUT-OF-ORDER (expecting %d)", details, testno); } else if (result_obj["directive"]) { details = details " # " result_obj["directive"]; if (length(result_obj["explanation"])) details = details " " result_obj["explanation"] } report(stringify_result_obj(result_obj), details) } # `skip_reason` should be empty whenever planned > 0. function handle_tap_plan(planned, skip_reason) { planned += 0 # Avoid getting confused if, say, `planned` is "00" if (length(skip_reason) && planned > 0) abort("in function handle_tap_plan()") if (plan_seen) { # Error, only one plan per stream is acceptable. testsuite_error("multiple test plans") return; } planned_tests = planned # The TAP plan can come before or after *all* the TAP results; we speak # respectively of an "early" or a "late" plan. If we see the plan line # after at least one TAP result has been seen, assume we have a late # plan; in this case, any further test result seen after the plan will # be flagged as an error. plan_seen = (testno >= 1 ? LATE_PLAN : EARLY_PLAN) # If testno > 0, we have an error ("too many tests run") that will be # automatically dealt with later, so do not worry about it here. If # $plan_seen is true, we have an error due to a repeated plan, and that # has already been dealt with above. Otherwise, we have a valid "plan # with SKIP" specification, and should report it as a particular kind # of SKIP result. if (planned == 0 && testno == 0) { if (length(skip_reason)) skip_reason = "- " skip_reason; report("SKIP", skip_reason); } } function extract_tap_comment(line) { if (index(line, diag_string) == 1) { # Strip leading `diag_string` from `line`. line = substr(line, length(diag_string) + 1) # And strip any leading and trailing whitespace left. sub("^[ \t]*", "", line) sub("[ \t]*$", "", line) # Return what is left (if any). return line; } return ""; } # When this function is called, we know that line is a TAP result line, # so that it matches the (perl) RE "^(not )?ok\b". function setup_result_obj(line) { # Get the result, and remove it from the line. result_obj["is_ok"] = (substr(line, 1, 2) == "ok" ? 1 : 0) sub("^(not )?ok[ \t]*", "", line) # If the result has an explicit number, get it and strip it; otherwise, # automatically assign the next test number to it. if (line ~ /^[0-9]+$/ || line ~ /^[0-9]+[^a-zA-Z0-9_]/) { match(line, "^[0-9]+") # The final `+ 0` is to normalize numbers with leading zeros. result_obj["number"] = substr(line, 1, RLENGTH) + 0 line = substr(line, RLENGTH + 1) } else { result_obj["number"] = testno } if (plan_seen == LATE_PLAN) # No further test results are acceptable after a "late" TAP plan # has been seen. result_obj["is_unplanned"] = 1 else if (plan_seen && testno > planned_tests) result_obj["is_unplanned"] = 1 else result_obj["is_unplanned"] = 0 # Strip trailing and leading whitespace. sub("^[ \t]*", "", line) sub("[ \t]*$", "", line) # This will have to be corrected if we have a "TODO"/"SKIP" directive. result_obj["description"] = line result_obj["directive"] = "" result_obj["explanation"] = "" if (index(line, "#") == 0) return # No possible directive, nothing more to do. # Directives are case-insensitive. rx = "[ \t]*#[ \t]*([tT][oO][dD][oO]|[sS][kK][iI][pP])[ \t]*" # See whether we have the directive, and if yes, where. pos = match(line, rx "$") if (!pos) pos = match(line, rx "[^a-zA-Z0-9_]") # If there was no TAP directive, we have nothing more to do. if (!pos) return # Let`s now see if the TAP directive has been escaped. For example: # escaped: ok \# SKIP # not escaped: ok \\# SKIP # escaped: ok \\\\\# SKIP # not escaped: ok \ # SKIP if (substr(line, pos, 1) == "#") { bslash_count = 0 for (i = pos; i > 1 && substr(line, i - 1, 1) == "\\"; i--) bslash_count += 1 if (bslash_count % 2) return # Directive was escaped. } # Strip the directive and its explanation (if any) from the test # description. result_obj["description"] = substr(line, 1, pos - 1) # Now remove the test description from the line, that has been dealt # with already. line = substr(line, pos) # Strip the directive, and save its value (normalized to upper case). sub("^[ \t]*#[ \t]*", "", line) result_obj["directive"] = toupper(substr(line, 1, 4)) line = substr(line, 5) # Now get the explanation for the directive (if any), with leading # and trailing whitespace removed. sub("^[ \t]*", "", line) sub("[ \t]*$", "", line) result_obj["explanation"] = line } function get_test_exit_message(status) { if (status == 0) return "" if (status !~ /^[1-9][0-9]*$/) abort("getting exit status") if (status < 127) exit_details = "" else if (status == 127) exit_details = " (command not found?)" else if (status >= 128 && status <= 255) exit_details = sprintf(" (terminated by signal %d?)", status - 128) else if (status > 256 && status <= 384) # We used to report an "abnormal termination" here, but some Korn # shells, when a child process die due to signal number n, can leave # in $? an exit status of 256+n instead of the more standard 128+n. # Apparently, both behaviours are allowed by POSIX (2008), so be # prepared to handle them both. See also Austing Group report ID # 0000051 exit_details = sprintf(" (terminated by signal %d?)", status - 256) else # Never seen in practice. exit_details = " (abnormal termination)" return sprintf("exited with status %d%s", status, exit_details) } function write_test_results() { print ":global-test-result: " get_global_test_result() > trs_file print ":recheck: " yn(must_recheck()) > trs_file print ":copy-in-global-log: " yn(copy_in_global_log()) > trs_file for (i = 0; i < test_results_index; i += 1) print ":test-result: " test_results_list[i] > trs_file close(trs_file); } BEGIN { ## ------- ## ## SETUP ## ## ------- ## '"$init_colors"' # Properly initialized once the TAP plan is seen. planned_tests = 0 COOKED_PASS = expect_failure ? "XPASS": "PASS"; COOKED_FAIL = expect_failure ? "XFAIL": "FAIL"; # Enumeration-like constants to remember which kind of plan (if any) # has been seen. It is important that NO_PLAN evaluates "false" as # a boolean. NO_PLAN = 0 EARLY_PLAN = 1 LATE_PLAN = 2 testno = 0 # Number of test results seen so far. bailed_out = 0 # Whether a "Bail out!" directive has been seen. # Whether the TAP plan has been seen or not, and if yes, which kind # it is ("early" is seen before any test result, "late" otherwise). plan_seen = NO_PLAN ## --------- ## ## PARSING ## ## --------- ## is_first_read = 1 while (1) { # Involutions required so that we are able to read the exit status # from the last input line. st = getline if (st < 0) # I/O error. fatal("I/O error while reading from input stream") else if (st == 0) # End-of-input { if (is_first_read) abort("in input loop: only one input line") break } if (is_first_read) { is_first_read = 0 nextline = $0 continue } else { curline = nextline nextline = $0 $0 = curline } # Copy any input line verbatim into the log file. print | "cat >&3" # Parsing of TAP input should stop after a "Bail out!" directive. if (bailed_out) continue # TAP test result. if ($0 ~ /^(not )?ok$/ || $0 ~ /^(not )?ok[^a-zA-Z0-9_]/) { testno += 1 setup_result_obj($0) handle_tap_result() } # TAP plan (normal or "SKIP" without explanation). else if ($0 ~ /^1\.\.[0-9]+[ \t]*$/) { # The next two lines will put the number of planned tests in $0. sub("^1\\.\\.", "") sub("[^0-9]*$", "") handle_tap_plan($0, "") continue } # TAP "SKIP" plan, with an explanation. else if ($0 ~ /^1\.\.0+[ \t]*#/) { # The next lines will put the skip explanation in $0, stripping # any leading and trailing whitespace. This is a little more # tricky in truth, since we want to also strip a potential leading # "SKIP" string from the message. sub("^[^#]*#[ \t]*(SKIP[: \t][ \t]*)?", "") sub("[ \t]*$", ""); handle_tap_plan(0, $0) } # "Bail out!" magic. # Older versions of prove and TAP::Harness (e.g., 3.17) did not # recognize a "Bail out!" directive when preceded by leading # whitespace, but more modern versions (e.g., 3.23) do. So we # emulate the latter, "more modern" behaviour. else if ($0 ~ /^[ \t]*Bail out!/) { bailed_out = 1 # Get the bailout message (if any), with leading and trailing # whitespace stripped. The message remains stored in `$0`. sub("^[ \t]*Bail out![ \t]*", ""); sub("[ \t]*$", ""); # Format the error message for the bailout_message = "Bail out!" if (length($0)) bailout_message = bailout_message " " $0 testsuite_error(bailout_message) } # Maybe we have too look for dianogtic comments too. else if (comments != 0) { comment = extract_tap_comment($0); if (length(comment)) report("#", comment); } } ## -------- ## ## FINISH ## ## -------- ## # A "Bail out!" directive should cause us to ignore any following TAP # error, as well as a non-zero exit status from the TAP producer. if (!bailed_out) { if (!plan_seen) { testsuite_error("missing test plan") } else if (planned_tests != testno) { bad_amount = testno > planned_tests ? "many" : "few" testsuite_error(sprintf("too %s tests run (expected %d, got %d)", bad_amount, planned_tests, testno)) } if (!ignore_exit) { # Fetch exit status from the last line. exit_message = get_test_exit_message(nextline) if (exit_message) testsuite_error(exit_message) } } write_test_results() exit 0 } # End of "BEGIN" block. ' # TODO: document that we consume the file descriptor 3 :-( } 3>"$log_file" test $? -eq 0 || fatal "I/O or internal error" # Local Variables: # mode: shell-script # sh-indentation: 2 # eval: (add-hook 'before-save-hook 'time-stamp) # time-stamp-start: "scriptversion=" # time-stamp-format: "%:y-%02m-%02d.%02H" # time-stamp-time-zone: "UTC0" # time-stamp-end: "; # UTC" # End: poke-elf-1.0/build-aux/install-sh0000755000175000017500000003577614365270527013730 00000000000000#!/bin/sh # install - install a program, script, or datafile scriptversion=2020-11-14.01; # UTC # This originates from X11R5 (mit/util/scripts/install.sh), which was # later released in X11R6 (xc/config/util/install.sh) with the # following copyright and license. # # Copyright (C) 1994 X Consortium # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to # deal in the Software without restriction, including without limitation the # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or # sell copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN # AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNEC- # TION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # # Except as contained in this notice, the name of the X Consortium shall not # be used in advertising or otherwise to promote the sale, use or other deal- # ings in this Software without prior written authorization from the X Consor- # tium. # # # FSF changes to this file are in the public domain. # # Calling this script install-sh is preferred over install.sh, to prevent # 'make' implicit rules from creating a file called install from it # when there is no Makefile. # # This script is compatible with the BSD install script, but was written # from scratch. tab=' ' nl=' ' IFS=" $tab$nl" # Set DOITPROG to "echo" to test this script. doit=${DOITPROG-} doit_exec=${doit:-exec} # Put in absolute file names if you don't have them in your path; # or use environment vars. chgrpprog=${CHGRPPROG-chgrp} chmodprog=${CHMODPROG-chmod} chownprog=${CHOWNPROG-chown} cmpprog=${CMPPROG-cmp} cpprog=${CPPROG-cp} mkdirprog=${MKDIRPROG-mkdir} mvprog=${MVPROG-mv} rmprog=${RMPROG-rm} stripprog=${STRIPPROG-strip} posix_mkdir= # Desired mode of installed file. mode=0755 # Create dirs (including intermediate dirs) using mode 755. # This is like GNU 'install' as of coreutils 8.32 (2020). mkdir_umask=22 backupsuffix= chgrpcmd= chmodcmd=$chmodprog chowncmd= mvcmd=$mvprog rmcmd="$rmprog -f" stripcmd= src= dst= dir_arg= dst_arg= copy_on_change=false is_target_a_directory=possibly usage="\ Usage: $0 [OPTION]... [-T] SRCFILE DSTFILE or: $0 [OPTION]... SRCFILES... DIRECTORY or: $0 [OPTION]... -t DIRECTORY SRCFILES... or: $0 [OPTION]... -d DIRECTORIES... In the 1st form, copy SRCFILE to DSTFILE. In the 2nd and 3rd, copy all SRCFILES to DIRECTORY. In the 4th, create DIRECTORIES. Options: --help display this help and exit. --version display version info and exit. -c (ignored) -C install only if different (preserve data modification time) -d create directories instead of installing files. -g GROUP $chgrpprog installed files to GROUP. -m MODE $chmodprog installed files to MODE. -o USER $chownprog installed files to USER. -p pass -p to $cpprog. -s $stripprog installed files. -S SUFFIX attempt to back up existing files, with suffix SUFFIX. -t DIRECTORY install into DIRECTORY. -T report an error if DSTFILE is a directory. Environment variables override the default commands: CHGRPPROG CHMODPROG CHOWNPROG CMPPROG CPPROG MKDIRPROG MVPROG RMPROG STRIPPROG By default, rm is invoked with -f; when overridden with RMPROG, it's up to you to specify -f if you want it. If -S is not specified, no backups are attempted. Email bug reports to bug-automake@gnu.org. Automake home page: https://www.gnu.org/software/automake/ " while test $# -ne 0; do case $1 in -c) ;; -C) copy_on_change=true;; -d) dir_arg=true;; -g) chgrpcmd="$chgrpprog $2" shift;; --help) echo "$usage"; exit $?;; -m) mode=$2 case $mode in *' '* | *"$tab"* | *"$nl"* | *'*'* | *'?'* | *'['*) echo "$0: invalid mode: $mode" >&2 exit 1;; esac shift;; -o) chowncmd="$chownprog $2" shift;; -p) cpprog="$cpprog -p";; -s) stripcmd=$stripprog;; -S) backupsuffix="$2" shift;; -t) is_target_a_directory=always dst_arg=$2 # Protect names problematic for 'test' and other utilities. case $dst_arg in -* | [=\(\)!]) dst_arg=./$dst_arg;; esac shift;; -T) is_target_a_directory=never;; --version) echo "$0 $scriptversion"; exit $?;; --) shift break;; -*) echo "$0: invalid option: $1" >&2 exit 1;; *) break;; esac shift done # We allow the use of options -d and -T together, by making -d # take the precedence; this is for compatibility with GNU install. if test -n "$dir_arg"; then if test -n "$dst_arg"; then echo "$0: target directory not allowed when installing a directory." >&2 exit 1 fi fi if test $# -ne 0 && test -z "$dir_arg$dst_arg"; then # When -d is used, all remaining arguments are directories to create. # When -t is used, the destination is already specified. # Otherwise, the last argument is the destination. Remove it from $@. for arg do if test -n "$dst_arg"; then # $@ is not empty: it contains at least $arg. set fnord "$@" "$dst_arg" shift # fnord fi shift # arg dst_arg=$arg # Protect names problematic for 'test' and other utilities. case $dst_arg in -* | [=\(\)!]) dst_arg=./$dst_arg;; esac done fi if test $# -eq 0; then if test -z "$dir_arg"; then echo "$0: no input file specified." >&2 exit 1 fi # It's OK to call 'install-sh -d' without argument. # This can happen when creating conditional directories. exit 0 fi if test -z "$dir_arg"; then if test $# -gt 1 || test "$is_target_a_directory" = always; then if test ! -d "$dst_arg"; then echo "$0: $dst_arg: Is not a directory." >&2 exit 1 fi fi fi if test -z "$dir_arg"; then do_exit='(exit $ret); exit $ret' trap "ret=129; $do_exit" 1 trap "ret=130; $do_exit" 2 trap "ret=141; $do_exit" 13 trap "ret=143; $do_exit" 15 # Set umask so as not to create temps with too-generous modes. # However, 'strip' requires both read and write access to temps. case $mode in # Optimize common cases. *644) cp_umask=133;; *755) cp_umask=22;; *[0-7]) if test -z "$stripcmd"; then u_plus_rw= else u_plus_rw='% 200' fi cp_umask=`expr '(' 777 - $mode % 1000 ')' $u_plus_rw`;; *) if test -z "$stripcmd"; then u_plus_rw= else u_plus_rw=,u+rw fi cp_umask=$mode$u_plus_rw;; esac fi for src do # Protect names problematic for 'test' and other utilities. case $src in -* | [=\(\)!]) src=./$src;; esac if test -n "$dir_arg"; then dst=$src dstdir=$dst test -d "$dstdir" dstdir_status=$? # Don't chown directories that already exist. if test $dstdir_status = 0; then chowncmd="" fi else # Waiting for this to be detected by the "$cpprog $src $dsttmp" command # might cause directories to be created, which would be especially bad # if $src (and thus $dsttmp) contains '*'. if test ! -f "$src" && test ! -d "$src"; then echo "$0: $src does not exist." >&2 exit 1 fi if test -z "$dst_arg"; then echo "$0: no destination specified." >&2 exit 1 fi dst=$dst_arg # If destination is a directory, append the input filename. if test -d "$dst"; then if test "$is_target_a_directory" = never; then echo "$0: $dst_arg: Is a directory" >&2 exit 1 fi dstdir=$dst dstbase=`basename "$src"` case $dst in */) dst=$dst$dstbase;; *) dst=$dst/$dstbase;; esac dstdir_status=0 else dstdir=`dirname "$dst"` test -d "$dstdir" dstdir_status=$? fi fi case $dstdir in */) dstdirslash=$dstdir;; *) dstdirslash=$dstdir/;; esac obsolete_mkdir_used=false if test $dstdir_status != 0; then case $posix_mkdir in '') # With -d, create the new directory with the user-specified mode. # Otherwise, rely on $mkdir_umask. if test -n "$dir_arg"; then mkdir_mode=-m$mode else mkdir_mode= fi posix_mkdir=false # The $RANDOM variable is not portable (e.g., dash). Use it # here however when possible just to lower collision chance. tmpdir=${TMPDIR-/tmp}/ins$RANDOM-$$ trap ' ret=$? rmdir "$tmpdir/a/b" "$tmpdir/a" "$tmpdir" 2>/dev/null exit $ret ' 0 # Because "mkdir -p" follows existing symlinks and we likely work # directly in world-writeable /tmp, make sure that the '$tmpdir' # directory is successfully created first before we actually test # 'mkdir -p'. if (umask $mkdir_umask && $mkdirprog $mkdir_mode "$tmpdir" && exec $mkdirprog $mkdir_mode -p -- "$tmpdir/a/b") >/dev/null 2>&1 then if test -z "$dir_arg" || { # Check for POSIX incompatibilities with -m. # HP-UX 11.23 and IRIX 6.5 mkdir -m -p sets group- or # other-writable bit of parent directory when it shouldn't. # FreeBSD 6.1 mkdir -m -p sets mode of existing directory. test_tmpdir="$tmpdir/a" ls_ld_tmpdir=`ls -ld "$test_tmpdir"` case $ls_ld_tmpdir in d????-?r-*) different_mode=700;; d????-?--*) different_mode=755;; *) false;; esac && $mkdirprog -m$different_mode -p -- "$test_tmpdir" && { ls_ld_tmpdir_1=`ls -ld "$test_tmpdir"` test "$ls_ld_tmpdir" = "$ls_ld_tmpdir_1" } } then posix_mkdir=: fi rmdir "$tmpdir/a/b" "$tmpdir/a" "$tmpdir" else # Remove any dirs left behind by ancient mkdir implementations. rmdir ./$mkdir_mode ./-p ./-- "$tmpdir" 2>/dev/null fi trap '' 0;; esac if $posix_mkdir && ( umask $mkdir_umask && $doit_exec $mkdirprog $mkdir_mode -p -- "$dstdir" ) then : else # mkdir does not conform to POSIX, # or it failed possibly due to a race condition. Create the # directory the slow way, step by step, checking for races as we go. case $dstdir in /*) prefix='/';; [-=\(\)!]*) prefix='./';; *) prefix='';; esac oIFS=$IFS IFS=/ set -f set fnord $dstdir shift set +f IFS=$oIFS prefixes= for d do test X"$d" = X && continue prefix=$prefix$d if test -d "$prefix"; then prefixes= else if $posix_mkdir; then (umask $mkdir_umask && $doit_exec $mkdirprog $mkdir_mode -p -- "$dstdir") && break # Don't fail if two instances are running concurrently. test -d "$prefix" || exit 1 else case $prefix in *\'*) qprefix=`echo "$prefix" | sed "s/'/'\\\\\\\\''/g"`;; *) qprefix=$prefix;; esac prefixes="$prefixes '$qprefix'" fi fi prefix=$prefix/ done if test -n "$prefixes"; then # Don't fail if two instances are running concurrently. (umask $mkdir_umask && eval "\$doit_exec \$mkdirprog $prefixes") || test -d "$dstdir" || exit 1 obsolete_mkdir_used=true fi fi fi if test -n "$dir_arg"; then { test -z "$chowncmd" || $doit $chowncmd "$dst"; } && { test -z "$chgrpcmd" || $doit $chgrpcmd "$dst"; } && { test "$obsolete_mkdir_used$chowncmd$chgrpcmd" = false || test -z "$chmodcmd" || $doit $chmodcmd $mode "$dst"; } || exit 1 else # Make a couple of temp file names in the proper directory. dsttmp=${dstdirslash}_inst.$$_ rmtmp=${dstdirslash}_rm.$$_ # Trap to clean up those temp files at exit. trap 'ret=$?; rm -f "$dsttmp" "$rmtmp" && exit $ret' 0 # Copy the file name to the temp name. (umask $cp_umask && { test -z "$stripcmd" || { # Create $dsttmp read-write so that cp doesn't create it read-only, # which would cause strip to fail. if test -z "$doit"; then : >"$dsttmp" # No need to fork-exec 'touch'. else $doit touch "$dsttmp" fi } } && $doit_exec $cpprog "$src" "$dsttmp") && # and set any options; do chmod last to preserve setuid bits. # # If any of these fail, we abort the whole thing. If we want to # ignore errors from any of these, just make sure not to ignore # errors from the above "$doit $cpprog $src $dsttmp" command. # { test -z "$chowncmd" || $doit $chowncmd "$dsttmp"; } && { test -z "$chgrpcmd" || $doit $chgrpcmd "$dsttmp"; } && { test -z "$stripcmd" || $doit $stripcmd "$dsttmp"; } && { test -z "$chmodcmd" || $doit $chmodcmd $mode "$dsttmp"; } && # If -C, don't bother to copy if it wouldn't change the file. if $copy_on_change && old=`LC_ALL=C ls -dlL "$dst" 2>/dev/null` && new=`LC_ALL=C ls -dlL "$dsttmp" 2>/dev/null` && set -f && set X $old && old=:$2:$4:$5:$6 && set X $new && new=:$2:$4:$5:$6 && set +f && test "$old" = "$new" && $cmpprog "$dst" "$dsttmp" >/dev/null 2>&1 then rm -f "$dsttmp" else # If $backupsuffix is set, and the file being installed # already exists, attempt a backup. Don't worry if it fails, # e.g., if mv doesn't support -f. if test -n "$backupsuffix" && test -f "$dst"; then $doit $mvcmd -f "$dst" "$dst$backupsuffix" 2>/dev/null fi # Rename the file to the real destination. $doit $mvcmd -f "$dsttmp" "$dst" 2>/dev/null || # The rename failed, perhaps because mv can't rename something else # to itself, or perhaps because mv is so ancient that it does not # support -f. { # Now remove or move aside any old file at destination location. # We try this two ways since rm can't unlink itself on some # systems and the destination file might be busy for other # reasons. In this case, the final cleanup might fail but the new # file should still install successfully. { test ! -f "$dst" || $doit $rmcmd "$dst" 2>/dev/null || { $doit $mvcmd -f "$dst" "$rmtmp" 2>/dev/null && { $doit $rmcmd "$rmtmp" 2>/dev/null; :; } } || { echo "$0: cannot unlink or rename $dst" >&2 (exit 1); exit 1 } } && # Now rename the file to the real destination. $doit $mvcmd "$dsttmp" "$dst" } fi || exit 1 trap '' 0 fi done # Local variables: # eval: (add-hook 'before-save-hook 'time-stamp) # time-stamp-start: "scriptversion=" # time-stamp-format: "%:y-%02m-%02d.%02H" # time-stamp-time-zone: "UTC0" # time-stamp-end: "; # UTC" # End: poke-elf-1.0/build-aux/test-driver0000755000175000017500000001112714365270527014102 00000000000000#! /bin/sh # test-driver - basic testsuite driver script. scriptversion=2018-03-07.03; # UTC # Copyright (C) 2011-2020 Free Software Foundation, Inc. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # As a special exception to the GNU General Public License, if you # distribute this file as part of a program that contains a # configuration script generated by Autoconf, you may include it under # the same distribution terms that you use for the rest of that program. # This file is maintained in Automake, please report # bugs to or send patches to # . # Make unconditional expansion of undefined variables an error. This # helps a lot in preventing typo-related bugs. set -u usage_error () { echo "$0: $*" >&2 print_usage >&2 exit 2 } print_usage () { cat <$log_file 2>&1 estatus=$? if test $enable_hard_errors = no && test $estatus -eq 99; then tweaked_estatus=1 else tweaked_estatus=$estatus fi case $tweaked_estatus:$expect_failure in 0:yes) col=$red res=XPASS recheck=yes gcopy=yes;; 0:*) col=$grn res=PASS recheck=no gcopy=no;; 77:*) col=$blu res=SKIP recheck=no gcopy=yes;; 99:*) col=$mgn res=ERROR recheck=yes gcopy=yes;; *:yes) col=$lgn res=XFAIL recheck=no gcopy=yes;; *:*) col=$red res=FAIL recheck=yes gcopy=yes;; esac # Report the test outcome and exit status in the logs, so that one can # know whether the test passed or failed simply by looking at the '.log' # file, without the need of also peaking into the corresponding '.trs' # file (automake bug#11814). echo "$res $test_name (exit status: $estatus)" >>$log_file # Report outcome to console. echo "${col}${res}${std}: $test_name" # Register the test result, and other relevant metadata. echo ":test-result: $res" > $trs_file echo ":global-test-result: $res" >> $trs_file echo ":recheck: $recheck" >> $trs_file echo ":copy-in-global-log: $gcopy" >> $trs_file # Local Variables: # mode: shell-script # sh-indentation: 2 # eval: (add-hook 'before-save-hook 'time-stamp) # time-stamp-start: "scriptversion=" # time-stamp-format: "%:y-%02m-%02d.%02H" # time-stamp-time-zone: "UTC0" # time-stamp-end: "; # UTC" # End: poke-elf-1.0/build-aux/missing0000755000175000017500000001533614365270527013311 00000000000000#! /bin/sh # Common wrapper for a few potentially missing GNU programs. scriptversion=2018-03-07.03; # UTC # Copyright (C) 1996-2020 Free Software Foundation, Inc. # Originally written by Fran,cois Pinard , 1996. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2, or (at your option) # any later version. # This program 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 for more details. # You should have received a copy of the GNU General Public License # along with this program. If not, see . # As a special exception to the GNU General Public License, if you # distribute this file as part of a program that contains a # configuration script generated by Autoconf, you may include it under # the same distribution terms that you use for the rest of that program. if test $# -eq 0; then echo 1>&2 "Try '$0 --help' for more information" exit 1 fi case $1 in --is-lightweight) # Used by our autoconf macros to check whether the available missing # script is modern enough. exit 0 ;; --run) # Back-compat with the calling convention used by older automake. shift ;; -h|--h|--he|--hel|--help) echo "\ $0 [OPTION]... PROGRAM [ARGUMENT]... Run 'PROGRAM [ARGUMENT]...', returning a proper advice when this fails due to PROGRAM being missing or too old. Options: -h, --help display this help and exit -v, --version output version information and exit Supported PROGRAM values: aclocal autoconf autoheader autom4te automake makeinfo bison yacc flex lex help2man Version suffixes to PROGRAM as well as the prefixes 'gnu-', 'gnu', and 'g' are ignored when checking the name. Send bug reports to ." exit $? ;; -v|--v|--ve|--ver|--vers|--versi|--versio|--version) echo "missing $scriptversion (GNU Automake)" exit $? ;; -*) echo 1>&2 "$0: unknown '$1' option" echo 1>&2 "Try '$0 --help' for more information" exit 1 ;; esac # Run the given program, remember its exit status. "$@"; st=$? # If it succeeded, we are done. test $st -eq 0 && exit 0 # Also exit now if we it failed (or wasn't found), and '--version' was # passed; such an option is passed most likely to detect whether the # program is present and works. case $2 in --version|--help) exit $st;; esac # Exit code 63 means version mismatch. This often happens when the user # tries to use an ancient version of a tool on a file that requires a # minimum version. if test $st -eq 63; then msg="probably too old" elif test $st -eq 127; then # Program was missing. msg="missing on your system" else # Program was found and executed, but failed. Give up. exit $st fi perl_URL=https://www.perl.org/ flex_URL=https://github.com/westes/flex gnu_software_URL=https://www.gnu.org/software program_details () { case $1 in aclocal|automake) echo "The '$1' program is part of the GNU Automake package:" echo "<$gnu_software_URL/automake>" echo "It also requires GNU Autoconf, GNU m4 and Perl in order to run:" echo "<$gnu_software_URL/autoconf>" echo "<$gnu_software_URL/m4/>" echo "<$perl_URL>" ;; autoconf|autom4te|autoheader) echo "The '$1' program is part of the GNU Autoconf package:" echo "<$gnu_software_URL/autoconf/>" echo "It also requires GNU m4 and Perl in order to run:" echo "<$gnu_software_URL/m4/>" echo "<$perl_URL>" ;; esac } give_advice () { # Normalize program name to check for. normalized_program=`echo "$1" | sed ' s/^gnu-//; t s/^gnu//; t s/^g//; t'` printf '%s\n' "'$1' is $msg." configure_deps="'configure.ac' or m4 files included by 'configure.ac'" case $normalized_program in autoconf*) echo "You should only need it if you modified 'configure.ac'," echo "or m4 files included by it." program_details 'autoconf' ;; autoheader*) echo "You should only need it if you modified 'acconfig.h' or" echo "$configure_deps." program_details 'autoheader' ;; automake*) echo "You should only need it if you modified 'Makefile.am' or" echo "$configure_deps." program_details 'automake' ;; aclocal*) echo "You should only need it if you modified 'acinclude.m4' or" echo "$configure_deps." program_details 'aclocal' ;; autom4te*) echo "You might have modified some maintainer files that require" echo "the 'autom4te' program to be rebuilt." program_details 'autom4te' ;; bison*|yacc*) echo "You should only need it if you modified a '.y' file." echo "You may want to install the GNU Bison package:" echo "<$gnu_software_URL/bison/>" ;; lex*|flex*) echo "You should only need it if you modified a '.l' file." echo "You may want to install the Fast Lexical Analyzer package:" echo "<$flex_URL>" ;; help2man*) echo "You should only need it if you modified a dependency" \ "of a man page." echo "You may want to install the GNU Help2man package:" echo "<$gnu_software_URL/help2man/>" ;; makeinfo*) echo "You should only need it if you modified a '.texi' file, or" echo "any other file indirectly affecting the aspect of the manual." echo "You might want to install the Texinfo package:" echo "<$gnu_software_URL/texinfo/>" echo "The spurious makeinfo call might also be the consequence of" echo "using a buggy 'make' (AIX, DU, IRIX), in which case you might" echo "want to install GNU make:" echo "<$gnu_software_URL/make/>" ;; *) echo "You might have modified some files without having the proper" echo "tools for further handling them. Check the 'README' file, it" echo "often tells you about the needed prerequisites for installing" echo "this package. You may also peek at any GNU archive site, in" echo "case some other package contains this missing '$1' program." ;; esac } give_advice "$1" | sed -e '1s/^/WARNING: /' \ -e '2,$s/^/ /' >&2 # Propagate the correct exit status (expected to be 127 for a program # not found, 63 for a program that failed due to version mismatch). exit $st # Local variables: # eval: (add-hook 'before-save-hook 'time-stamp) # time-stamp-start: "scriptversion=" # time-stamp-format: "%:y-%02m-%02d.%02H" # time-stamp-time-zone: "UTC0" # time-stamp-end: "; # UTC" # End: poke-elf-1.0/poke-elf.info0000644000175000017500000016770714602060007012371 00000000000000This is poke-elf.info, produced by makeinfo version 6.7 from poke-elf.texi. Copyright (C) 2024 Jose E. Marchesi. You can redistribute it and/or modify this manual under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. INFO-DIR-SECTION GNU poke START-INFO-DIR-ENTRY * poke-elf: (poke-elf). ELF pickles for GNU poke. END-INFO-DIR-ENTRY  File: poke-elf.info, Node: Top, Next: Introduction, Up: (dir) Editing ELF files with GNU poke ******************************* Copyright (C) 2024 Jose E. Marchesi. You can redistribute it and/or modify this manual under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. GNU poke is an interactive, extensible editor for binary data. Not limited to editing basic entities such as bits and bytes, it provides a full-fledged procedural, interactive programming language designed to describe data structures and to operate on them. This manual explains how to use the ELF pickles distributed at . * Menu: Getting Started * Introduction:: How to use this manual. * Installation:: Installing the poke-elf pickles. * Pickles Overview:: Know your pickles. Poking at ELF * ELF Configurations:: The ELF Configuration Registry. * ELF Basic Types:: Simple types. * ELF File:: 32-bit and 64-bit ELF files. * ELF Header:: The ELF file header. * ELF Section Headers:: Entry in the ELF section header table. * ELF Program Headers:: Entry in the ELF program header table. * ELF Symbols:: Symbols and their attributes. * ELF Notes:: Auxiliary information. * ELF Relocations:: REL and RELA relocations. * ELF Dynamic Info:: Stored information for dynamic linking. * ELF Machines:: ELF machine specific data structures. * ELF OSes:: ELF OS specific data structures. Extending and Hacking Appendices * Indices:: List of indices in this document.  File: poke-elf.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top 1 Introduction ************** This manual documents the pickles shipped in the poke-elf package. It not only describes the data structures implemented in these pickles, but also shows examples of techniques to how to make best use of them. 1.1 Who is this manual for? =========================== This manual assumes that the reader is familiar with both the 'poke' program and the Poke programming language. 1.2 Approach used to describe Poke data structures ================================================== When describing Poke types (such as for example 'Elf64_Chdr') this manual takes the approach of first showing a simplified or stripped-out version of the type, like this: type Elf64_Chdr = struct { Elf_Word ch_type; Elf_Word ch_reserved; offset ch_size; offset ch_addralign; }; Generally speaking, these stripped versions of the type do not contain comments, constraints, variables, functions nor methods. However, there are exceptions to this rule in the particular cases where we want to draw your attention to some particular aspect involving some constraint, method, etc. Following the simplified version of the type, its fields get discussed in detail. Then, the overall data structure gets discussed, and examples on how to use it to poke at data are shown. Finally, the methods offered by the type, if any, are described in detail along with usage examples.  File: poke-elf.info, Node: Installation, Next: Pickles Overview, Prev: Introduction, Up: Top 2 Installation ************** Welcome! This section should get you up and running to enjoy poking at nasty ELF data in no time. 2.1 Build Requirements ====================== These are the build requirements if you are building from a distribution source tarball: - A recent enough version of GNU poke is necessary in order to run the test suite of this package. This is checked at configure time. If no suitable poke is found, the test suite is not run. 2.2 Fetching and unpacking poke-elf =================================== The first step to install 'poke-elf' is to fetch a copy of it. Like all GNU poke pickles, 'poke-elf' releases are distributed as source tarballs: $ wget https://ftp.gnu.org/gnu/poke/poke-elf-VERSION.tar.gz Where VERSION is the version you want to install. Next step is to untar the tarball. It will expand to a 'poke-elf-VERSION' directory: $ tar xvf poke-elf-VERSION.tar.gz $ cd poke-elf-VERSION/ 2.3 Configuring the sources =========================== It is time now to configure the sources. You do that by invoking the 'configure' script that is in the root directory of the distribution. $ ./configure By default the 'configure' script will configure the source in order to be installed under '/usr/local', which is a system location. If you want to install the pickles in some other location, you can pass a '--prefix' command line option to the script. For example: $ ./configure --prefix=$HOME/.poke.d Now that the sources are configured, it is time to build them and check the distribution. 2.4 Building and checking ========================= $ make $ make check There should be no errors. If any of the tests fail, please re-run 'make check' but this time enabling verbose output: $ make check VERBOSE=1 And file a bug report at including both the contents of your 'config.log' file and the output you get on the terminal when you run 'make check'. Please file the bug report for product "poke" and component "elf-pickle". Note that the testsuite will only be executed if a recent enough 'poke' was found during configure. 2.5 Installing ============== The last step is to install the pickles in your system: $ make install Note that the installed poke will find the installed pickles only if these are installed under the same prefix than poke. If you install the pickles in some other location (like under '~/.poke.d' for example, you will have to set the environment variable 'POKE_LOAD_PATH'. Just put something like this in your '.bashrc' or similar file: export POKE_LOAD_PATH=$HOME/.poke.d And that's it! Now run poke, load the pickles and enjoy! $ poke /bin/ls (poke) load elf (poke) var elf = Elf64_File @ 0#B ...  File: poke-elf.info, Node: Pickles Overview, Next: ELF Configurations, Prev: Installation, Up: Top 3 Pickles Overview ****************** This chapter provides an high-level overview of all the pickles distributed by this package. These are all developed in subsequent chapters. 'elf.pk' This is the main ELF pickle, and the one that is intended to be loaded by the user. It does little more than loading the rest of the 'elf-*' pickles, but it does it in the right order! 'elf-build.pk' This pickle contains information generating during building the 'poke-elf' package. In particular, the version. 'elf-config.pk' This pickle implements the "ELF configuration registry", which is used by the ELF pickles in order to maintain a database of the very varied set of different configuration parameters supported by the ELF specification: machine types, section types, segment types, file flags, etc. *Note ELF Configurations::. 'elf-common.pk' This pickle contains definitions which are common to both 32-bit and 64-bit ELF. It also registers configuration parameters that are common to all machine types. 'elf-os-OS.pk' These pickles contain definitions and configuration parameters for the different operating systems supported in the ELF specification. For example, 'elf-os-gnu.pk' covers the GNU extensions documented in the GNU gabi extensions (1). 'elf-mach-aarch64.pk' 'elf-mach-arm.pk' 'elf-mach-bpf.pk' 'elf-mach-mips.pk' 'elf-mach-riscv.pk' 'elf-mach-sparc.pk' 'elf-mach-x86-64.pk' These pickles contain definitions and configuration parameters for the different "machine types" supported in the ELF specification. 'elf-32.pk' This pickle contains definitions for 32-bit ELF files. Among these is the definition of the 'Elf32_File' type, which corresponds to an entire ELF-32 file. 'elf-64.pk' This pickle contains definitions for 64-bit ELF files. Among these is the definition of the 'Elf64_File' type, which corresponds to an entire ELF-64 file. ---------- Footnotes ---------- (1)  File: poke-elf.info, Node: ELF Configurations, Next: ELF Basic Types, Prev: Pickles Overview, Up: Top 4 ELF Configurations ******************** 4.1 ELF Configuration Parameters ================================ The ELF object format specification, unlike most (all?) its predecessors, was designed with the goal of being extremely flexible and extensible, in order to cover the needs of any conceivable hardware architecture and operating system. In order to achieve this goal, many of the entities that appear in ELF files, such as sections, symbols, or segments, are pretty generic and configurable. For example, consider the following (simplified) definition of an ELF64 relocation: type Elf64_RelInfo = struct { uint<32> r_sym; uint<32> r_type; }; Where 'r_type' contains a code identifying the type of the relocation. The ELF specification itself doesn't say what values may go in 'r_type'; it is the different supplements for particular architectures (or "machines" in ELF parlance) that list the relocation types used in their machines. Relocation types, understood as the set of valid codes to be set in a 'r_type' field, is just one example of what in poke-elf we call an ELF "configuration parameter". There are many other configuration parameters: section flags, section types, symbol types, and a large etc. They are often dependent of particular machines and OSes, and there can be _many_ of them: there are often literally hundreds of different relocation types defined by some particular architecture. 4.2 The ELF Configuration Registry ================================== As the different ELF pickles get loaded, they populate a registry of configuration parameters. This registry is a value of the struct type 'Elf_Config' that is defined in 'elf-config.pk', and is stored in the global variable 'elf_config'. There are two kinds of configuration parameters: "enumerations" and "masks". The registry contains several collections of them: - One set of common enumerations. - One set of common masks. - One set of enumerations per machine type. - One set of masks per machine type. 4.3 Enumeration configuration parameters ======================================== Enumeration configuration parameters, or "enums" for short, are sets of numbers or codes. Each entry in an enum represents an alternative value for some parameter. New enum entries are constructed using the 'Elf_Config_UInt' struct type: type Elf_Config_UInt = struct { uint<32> value; string name; string doc; }; Where 'name' is a short and descriptive name for the parameter value and 'doc' is an English statement describing the meaning of this particular VALUE. For example, this is how the definition of a X86_64 relocation type looks like: Elf_Config_UInt { value = ELF_R_X86_64_PC32, name = "pc32", doc = "PC relative 32 bit signed." } Adding new enum configuration parameters to the registry is done by using the 'add_enum' method of 'Elf_Config': method add_enum = (int<32> machine = -1, string class = "", Elf_Config_UInt[] entries = Elf_Config_UInt[]()) void: Where 'machine' is either -1 or an ELF machine code (likely one of the 'ELF_EM_*' values defined in 'elf-common.pk'). If the former, the new parameter is added to the set of common enums. Otherwise it is added to the set of enums defined for the specified machine type. Finally, 'entries' is an array of the different values this parameter may adopt. The 'class' argument is a string that gives a name to the new configuration parameter. These have names like 'reloc-types' or 'file-classes'. Our ELF pickles use a definite set of names, documented below, but nothing prevents you to use your own. This is how we would add a couple of common relocation types to the register (note the actual ELF specification has none of these, they are all machine-specific): elf_config.add_enum :class "reloc-types" :entries [Elf_Config_UInt { value = 0, name = "null reloc" }, Elf_Config_UInt { value = 1, name = "PC-relative 16-bit displacement." }]; And this is how we would add relocation types for the X86_64 architecture: elf_config.add_enum :class "relocation_types" :entries [Elf_Config_UInt { value = ELF_R_X86_64_PC32, name = "pc32", doc = "PC relative 32 bit signed." }, Elf_Config_UInt { value = ELF_R_X86_64_GOT32, name = "got32", doc = "32 bit GOT entry." }, ...]; 4.4 Mask configuration parameters ================================= Mask configuration parameters are sets of bit-masks. Each entry is an unsigned number determining some valid configuration of bits for the value of some parameter. New mask entries are constructed using the 'Elf_Config_Mask' type: type Elf_Config_Mask = struct { uint<64> value; string name; string doc; }; Where 'name' is a short an descriptive name summarizing the quality of the bit of bits set in 'value', and 'doc' is an English statement describing the meaning of these particular bits. For example, this is how the definition of an ARM section flag looks like: Elf_Config_Mask { value = ELF_SHF_ARM_PURECODE, name = "purecode", doc = "Section contains only code and no data." } Adding new mask configuration parameters to the registry is done by using the 'add_mask' method of 'Elf_Config': method add_mask = (int<32> machine = -1, string class = "", Elf_Config_Mask[] entries = Elf_Config_Mask[]()) void: Where 'machine' is either -1 or an ELF machine code. If the former, the new mask is added to the set of common masks. Otherwise it is added to the set of masks defined for the specified machine type. Finally, 'entries' is an array of the different sub-masks this parameter may adopt. As with enums, the 'class' argument is a string that gives a name to the new configuration parameter. Masks have names like '"section-flags"' or '"segment-flags"'. This is how we would register a couple of common section flags: elf_config.add_mask :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_WRITE, name = "write" }, Elf_Config_Mask { value = ELF_SHF_ALLOC, name = "alloc" }]; And this is how we would register section flags for the ARM architecture: elf_config.add_mask :machine ELF_EM_ARM :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_ARM_ENTRYSECT, name = "entrysect", doc = "Section contains an entry point." }, Elf_Config_Mask { value = ELF_SHF_ARM_PURECODE, name = "purecode", doc = "Section contains only code and no data." }, ...]; 4.5 Configuration parameters used by this pickle ================================================ As we have mentioned, it is possible to register new configuration parameters in the registry, with arbitrary names. This is certainly useful to the happy poker that is working on some weird ELF extension, or simply playing around. However, the set of 'elf-*pk' pickles are designed to work with a closed set of configuration parameters. Having extra parameters in the registry is perfectly ok, but if you mess with the parameters below, you are gonna have to face the consequences :) Note however that adding support for a new machine type or a new operating system shouldn't require extending the set of configuration parameters: just to add new values to them. The enum configuration parameters used by this pickle are: 'elf-machines' Valid values in 'e_machine' fields. 'file-osabis' Valid values in 'ei_osabi' fields. 'file-encodings' Valid values in ei_data fields. 'file-classes' Valid values in ei_class fields. 'file-types' Valid values in e_type fields. 'section-types' Valid values in sh_type fields. 'section-indices' Indices in the file section header table with special meanings. 'section-other' Valid values in sh_other fields. 'segment-types' Valid values in p_type fields. 'reloc-types' Valid values in r_type fields. 'dynamic-tag-types' Valid values in d_tag fields. 'symbol-types' Valid values in st_type fields. 'symbol-bindings' Valid values in st_bind fields. 'symbol-visibilities' Valid values in st_visibility fields. 'note-tags' Valid tags for notes stored in notes sections. 'gnu-properties' Valid values for 'pr_type' fields in GNU properties. The mask configuration parameters used by this pickle are: 'file-flags' Valid bits in e_flags fields. 'section-flags' Valid bits in sh_flags fields. 'segment-flags' Valid bits in p_flags fields. The architecture-specific enum configuration parameters used by this pickle are: 'mips-abis' Valid values in the 'ELF_EF_MIPS_ABI' bits of 'e_flags' in MIPS machines. 'mips-machines' Valid values in the 'ELF_EF_MIPS_MACH' bits of 'e_flags' in MIPS machines. 'mips-architectures' Valid values in the 'ELF_EF_MIPS_ARCH' bits of 'eflags' in MIPS machines. The architecture-specific mask configuration parameters used by this pickle are: 'mips-l-flags' Valid bits in 'l_flags' fields. 4.6 Getting printed representations of configuration parameters =============================================================== The 'format_enum' and 'format_mask' methods of 'Elf_Config' return the user-friendly printed representation of the given alternative value or bitmap. They have the following prototypes: method format_enum = (string class, uint<16> machine, uint<32> value) string: method format_mask = (string class, uint<16> machine, uint<64> value) string: The printed representation of an enum is simply the 'name' that was provided when registering it. For example: (poke) elf_config.format_enum ("reloc-types", ELF_EM_X86_64, 2) "pc32" The printed representation of a mask is a sequence of the names given to the different bitmaps at registration time, separated by comma (',') characters. For example: (poke) elf_config.format_mask ("section-flags", ELF_EM_X86_64, 0xf00) "os-nonconforming,group,tls,compressed" 4.7 Checking valid configuration parameters =========================================== The 'check_enum' and 'check_mask' methods of 'Elf_Config' check whether the given values are valid for some particular configuration parameter. They have the following prototypes: method check_enum = (string class, uint<16> machine, uint<32> value) int<32>: method check_mask = (string class, uint<16> machine, uint<64> value) int<32>: Where 'machine' specifies the machine type and 'class' the name of the configuration parameter. They determe wether 'value' is a valid 'class'. For example, this is how we would check whether 57 identifies a valid relocation type in RISCV: (poke) elf_config.check_enum ("reloc-types", ELF_EM_RISCV, 57) 0 Turns out it doesn't! :D 4.8 Using configuration parameters in types =========================================== The formatting and checking methods described above are mainly used in the ELF pickles in order to implement pretty-printers and data integrity constraints in the several ELF structures holding such values. For example: type Elf64_Shdr = struct { Elf_Word sh_type : elf_config.check_enum ("section-types", elf_mach, sh_type); Elf64_Xword sh_flags : elf_config.check_mask ("section-flags", elf_mach, sh_flags); [...] method _print_sh_type = void: { printf "#<%s>", elf_config.format_enum ("section-types", elf_mach, sh_type); } method _print_sh_flags = void: { printf "#<%s>", elf_config.format_mask ("section-flags", elf_mach, sh_flags); } }; However, they are also very useful to the user while poking at existing data ("if these bytes were to be interpreted as ELF section flags in some given arch, which ones they would be?"), composing new data and also when generating reports and statistics. 4.9 Debugging the registry ========================== If you want to get a trace of the configuration parameters as they are being added to the registry, simply set the 'elf_config_debug' variable to a non zero value and reload the ELF pickles: (poke) elf_config_debug = 1 (poke) load elf  File: poke-elf.info, Node: ELF Basic Types, Next: ELF File, Prev: ELF Configurations, Up: Top 5 ELF Basic Types ***************** The encoding of the simple fields in the ELF data structures is abstracted in the following Poke types. Types used in both 32-bit and 64-bit ELF: 'type Elf_Half = uint<16>' An ELF "unsigned medium integer". 'type Elf_Word = uint<32>' An ELF "unsigned integer". 'type Elf_Sword = int<32>' An ELF "signed integer". Types used in 32-bit ELF only: 'type Elf32_Addr = offset,B>' An ELF "unsigned program address". 'type Elf32_Off = offset,B>' An ELF "unsigned file offset". Types used in 64-bit ELF only: 'type Elf64_Xword = uint<64>' An ELF "unsigned long integer". 'type Elf64_Sxword = int<64>' An ELF "signed long integer". 'type Elf64_Addr = offset,B>' An ELF "unsigned program address". 'type Elf64_Off = offset,uint<64>,B>' And ELF "unsigned file offset".  File: poke-elf.info, Node: ELF File, Next: ELF Header, Prev: ELF Basic Types, Up: Top 6 ELF File ********** The Poke types provided to denote ELF64 and ELF32 files are 'Elf64_File' and 'Elf32_File' respectively. 6.1 Overview ============ type Elf32_File = struct { Elf32_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf32_Shdr[ehdr.e_shnum] shdr ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf32_Phdr[ehdr.e_phnum] phdr ehdr.e_phoff; }; type Elf64_File = struct { Elf64_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf64_Shdr[ehdr.e_shnum] shdr ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf64_Phdr[ehdr.e_phnum] phdr ehdr.e_phoff; }; 6.2 Fields ========== 'ehdr' Is the header of the ELF file, of type 'Elf64_File'. This always exists and is always located at the beginning of the ELF file. 'shdr' Is the optional section header table of the ELF file. This is an optional field that is an array of 'Elf64_Shdr' (or 'Elf32_Shdr') values, describing the ELF sections present in the file. This table, if it exists, can be located anywhere in the ELF file. The ELF header determines the size and location of the table. 'phdr' Is the optional program section header table of the ELF file. This is an optional field that is an array of 'Elf64_Phdr' (or 'Elf32_Phdr') describing ELF segments present in the file. This table, if it exists, can be located anywhere in the ELF file. The ELF header determines the size and location of the table. 6.3 Methods =========== 6.3.1 Methods related to sections --------------------------------- 'File_Elf64.section_name_p = (string NAME) int<32>' 'File_Elf32.section_name_p = (string NAME) int<32>' Given a section NAME, return whether a section with that name exists in the ELF file. 'File_Elf64.get_sections_by_name = (string NAME) Elf64_Shdr[]' 'File_Elf32.get_sections_by_name = (string NAME) Elf32_Shdr[]' Given the NAME of a section, return an array of section headers in the ELF file having that name. The returned array may of course be empty. For example, this is how you can get an array of all the sections in the file with name '.text': (poke) elf.get_sections_by_name (".text") [Elf64_Shdr { sh_name=141U#B, sh_type=#, sh_flags=#, sh_addr=18144UL#B, sh_offset=18144UL#B, sh_size=80574UL#B, sh_link=0U, sh_info=0U, sh_addralign=16UL, sh_entsize=0UL#B }] 'File_Elf64.get_sections_by_type = (Elf_Word STYPE) Elf64_Shdr[]' 'File_Elf32.get_sections_by_type = (Elf_Word STYPE) Elf32_Shdr[]' Given a section type (one of the 'ELF_SHT_*' value) return an array of section headers in the ELF file with that type. The returned array may be empty. 6.3.2 Methods related to string tables -------------------------------------- 'Elf64_File.get_section_name = (offset OFFSET) string' 'Elf32_File.get_section_name = (offset OFFSET) string' Given an offset into the ELF file's section string table, return the string starting at that OFFSET. This uses one particular string table that is linked from the ELF header via the 'e_shstrndx' field. For example, this is how we would print the name of the second section in an ELF file(1): (poke) elf.get_section_name (elf.shdr[1].sh_name) ".interp" 'Elf64_File.get_symbol_name = (Elf64_Shdr SYMTAB, offset OFFSET) string' 'Elf64_File.get_symbol_name = (Elf32_Shdr SYMTAB, offset OFFSET) string' Given the section header of a section that contains a symbol table SYMTAB, and an OFFSET, return the corresponding string stored at the symbol table associated string table. 'Elf64_File.get_string = (offset offset) string' 'Elf32_File.get_string = (offset offset) string' Given an OFFSET, return the string stored at that offset in the "default" string table of the ELF file. The default string table is contained in a section named '.strtab'. If such a section doesn't exist, or if it exists but it doesn't contain a string table, then this function raises 'E_inval'. 6.3.3 Methods related to section groups --------------------------------------- 'Elf64_File.get_group_signature = (Elf64_Shdr SECTION) string' 'Elf32_File.get_group_signature = (Elf32_Shdr SECTION) string' Return the signature corresponding to a given group SECTION, characterized by its entry in the section header table. If the given section header doesn't correspond to a group section then raise 'E_inval'. 'Elf64_File.get_group_signatures = string[]' 'Elf32_File.get_group_signatures = string[]' Return an array of strings with the signatures of the section groups present in this ELF file. 'Elf64_File.get_section_group = (string NAME) Elf64_Shdr[]' 'Elf32_File.get_section_group = (string NAME) Elf32_Shdr[]' Given the NAME of a section group, return an array with the section headers corresponding to all the sections in that group. If the given name doesn't identify a section group in the ELF file then return an empty array. 6.3.4 Methods related to loaded contents ---------------------------------------- 'Elf64_File.get_load_base = Elf64_Addr' Determine the base where the contents of the ELF file are loaded, understood as the lower virtual address where segments get loaded. If there are no loadable segments in the ELF file then this method raises 'E_inval'. 'Elf64_File.vaddr_to_sec = (Elf64_Addr VADDR) Elf64_Addr' Given a virtual address, return the index in the section header table of the section whose loaded contents cover the given address. If no such section is found this method returns -1. Consider for example a relocation which points to some content that is stored in some section in a loadable ELF file. The corresponding 'r_offset' field in the relocation will not contain a file offset, but a loaded address. This method can be then used to determine the section the relocation is applied to. 'Elf64_File.vaddr_to_file_offset = (Elf64_Addr VADDR) Elf64_Addr' If some of the contents of the file sections are to be loaded in VADDR, this method returns the file offset to these contents. 6.4 Usage ========= Poking at an ELF file usually starts by opening some IO space and mapping a 'Elf64_File' (or 'Elf32_File'): (poke) .file /bin/ls (poke) var elf = Elf64_File @ 0#B Once mapped, we can access any of the above fields. For example, let's see how many sections and segments this file has: (poke) elf.shdr'length 30UL (poke) elf.phdr'length 11UL In case the file didn't have a program header table, which always happens with object files, we would have got an exception if we tried to access the absent field 'phdr': $ echo '' | gcc -c -xc -o foo.o - $ poke foo.o (poke) load elf (poke) (Elf64_File @ 0#B).phdr unhandled invalid element exception 6.4.1 Working with sections --------------------------- Unlike in older object formats (like a.out for example) the sections present in ELF files are not fixed nor they have fixed pre-defined names: there can be any number of them (including none) and they can have any arbitrary name. Also, more than one section in the file can have the same name. So when it comes to ELF files, the process to determine whether one or more section with a given name exists in the file is a bit laborious: one has to traverse the section header table, fetch the section names from whatever appropriate string table, etc. The following methods, that you can use in your own pickles, scripts, or at the prompt, are handy to look at particular sections in the file. 6.4.2 Working with string tables -------------------------------- The names of several entities in ELF files are stored in different string table, which are themselves stored in different sections. There are different rules establishing where exactly the name of certain entities (sections, symbols, ...) are to be found. These rules are not trivial and require traversing several data structures. Therefore the 'Elf64_File' (and 'File32_File') type provides several methods in order to easily determine the name of these entities. 6.4.3 Working with section groups --------------------------------- ELF supports grouping several sections in a "section group". This is useful when several sections have to go together, because they rely on each other somehow. A section of type 'SHT_GROUP' defines a section group. Groups are univocally identified by a "group signature", which is the name associated with a symbol that is stored in a particular symbol table, linked from the section header of the group defining section. Again, it is not exactly trivial to determine, for example, which of the sections in the ELF file pertain to which group. Therefore the pickle provides the methods below: ---------- Footnotes ---------- (1) The first section in an ELF file is the "null" section and has an empty name.  File: poke-elf.info, Node: ELF Header, Next: ELF Section Headers, Prev: ELF File, Up: Top 7 ELF Header ************ The ELF headers are always to be found at the beginning of an ELF file. However, it is also common to find ELF data embedded in other container formats (such as an ELF section!) and sometimes ELF headers are used to describe non-conformance ELF contents. Therefore poking at headers directly is not that uncommon. The Poke types provided to denote ELF headers are 'Elf64_Ehdr' and 'Elf32_Ehdr', for 64-bit and 32-bit ELF files respectively. 7.1 Overview ============ type Elf32_Ehdr = struct { Elf_Ident e_ident; Elf_Half e_type; Elf_Half e_machine; Elf_Word e_version = ELF_EV_CURRENT; Elf32_Addr e_entry; Elf32_Off e_phoff; Elf32_Off e_shoff; Elf_Word e_flags; offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx; }; type Elf64_Ehdr = struct { Elf_Ident e_ident; Elf_Half e_type; Elf_Half e_machine; Elf_Word e_version = ELF_EV_CURRENT; Elf64_Addr e_entry; Elf64_Off e_phoff; Elf64_Off e_shoff; Elf_Word e_flags; offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx; }; 7.2 Fields ========== 'e_ident' Is a field that describes the encoding of the contents that follow in the ELF file. The data in this field is encoded in a clever way that only requires to read the information byte by byte. This is necessary, because part of the information stored in 'e_ident' is precisely the encoding used by the data in the ELF file: type Elf_Ident = struct { byte[4] ei_mag == [0x7fUB, 'E', 'L', 'F']; byte ei_class; byte ei_data; byte ei_version; byte ei_osabi; byte ei_abiversion; byte[7] ei_pad; }; Where: 'ei_mag' Is the magic number identifying the ELF file. It is always 0x7F. 'ei_class' Determines the class of the ELF file. This can be one of 'ELF_CLASS_NONE', 'ELF_CLASS_32' or 'ELF_CLASS_64' denoting and "invalid class", a 32-bit ELF file and a 64-bit ELF file respectively. I personally have never come across an ELF file with 'ELF_CLASS_NONE'. But if such class is found, it shall be considered as a data integrity error. That is the approach implemented in this pickle. 'ei_data' Determines the encoding of the data in the file. This can be one of 'ELF_DATA_NONE', 'ELF_DATA_2LSB' or 'ELF_DATA_2MSB', denoting no encoding, 2's complement and little endian, and 2's complement and big endian. Note that at this point the only supported encoding for signed numbers in ELF files is 2's complement. This pickle considers an ELF file with encoding 'ELF_DATA_NONE' as a data integrity error. 'ei_version' Is the ELF header version number. This must be 'ELF_EV_CURRENT'. 'ei_osabi' Identifies the ABI or operating system (these concepts are mixed in ELF) used by the ELF file. This must be one of the 'ELF_OSABI_*' values defined in 'elf-common.pk'. The ELF specification recommends this field to be 'ELF_OSABI_NONE', which actually identifies the "UNIX System V ABI". 'ei_abiversion' Identifies the version of the ABI to which the ELF file is targeted. The ELF spec points out that the purpose of this field is to distinguish among incompatible versions of an ABI, and that its interpretation ultimately depends on the value of 'ei_osabi'. 'ei_pad' Are unused bytes. These bytes may be used for some particular purpose in future versions of the ELF specification, and currently they must be set to zero. 'e_type' Identifies the kind of ELF file: whether it is an object file, an executable, a dynamic object or a core dump. This field is checked against the 'file-types' configuration parameter, and pretty-printed accordingly. 'e_machine' Identifies the machine type on which the elf file is supposed to run. When poke maps or constructs a 'Elf64_Ehdr' (or 'Elf32_Edhr') struct, it sets the global ELF machine to the value of this field. This field is checked against the 'machine-types' configuration parameter, and pretty-printed accordingly. 'e_version' Identifies the ELF version the ELF file conforms to. It must hold 'ELF_EV_CURRENT'. 'e_entry' Is the virtual memory address of the entry point of a process executing the program in this ELF file. This can be '0#B'. 'e_phoff' Is the file offset of the program header table. If the ELF file doesn't contain any segment, then the table is empty and this field contains '0#B'. 'e_shoff' Is the file offset of the section header table. If the ELF file doesn't contain any section, then the table is empty and this field contains '0#B'. 'e_flags' Is a bitmap of file flags. This field contains ORed 'ELF_EF_*' values. This field is checked against the 'filed-flags' configuration parameter, and pretty-printed accordingly. 'e_ehsize' Is the size in bytes of the ELF header. 'e_phentsize' Is the size in bytes of one entry in the program header table. 'e_phnum' Is the number of entries in the program header table. 'e_shentsize' Is the size in bytes of one entry in the section header table. 'e_shnum' Is the number of entries in the section header table. 'e_shstrndx' Is the index in the section header table of the entry associated with the string table that contains the names of the sections stored in the file. If the ELF file doesn't contain a section name string table (which is uncommon but certainly possible) then this field contains 'ELF_SHN_UNDEF'. 7.3 Usage ========= XXX  File: poke-elf.info, Node: ELF Section Headers, Next: ELF Program Headers, Prev: ELF Header, Up: Top 8 ELF Section Headers ********************* Sections can be stored anywhere in an ELF file. They can also be of any size, of any type, have any name (or no name) and their contents are free. The ELF file therefore contains a table, called the "section header table", whose entries describe each section. This table is sized and linked from the ELF header via the 'e_shoff' field. As we have seen, the section header table is available in the 'shdr' field of 'Elf32_File' and 'Elf64_File'. The Poke types denoting entries in the section header table are 'Elf32_Shdr' and 'Elf64_Shdr' for ELF32 and ELF64 respectively. 8.1 Overview ============ type Elf32_Shdr = struct { offset sh_name; Elf_Word sh_type; Elf_Word sh_flags; Elf32_Addr sh_addr; Elf32_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf_Word sh_addralign; offset sh_entsize; }; type Elf64_Shdr = struct { offset sh_name; Elf_Word sh_type; Elf64_Xword sh_flags; Elf64_Addr sh_addr; Elf64_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf64_Xword sh_addralign; offset sh_entsize; }; 8.2 Fields ========== 'sh_name' Is the offset to the name of this section in the file's section string table. Two or more sections can share the same name. 'sh_type' Is a code identifying the type of the section. This is one of the 'ELF_SHT_*' values. The type of a section determines what kind of contents (if any) a section has: relocations, a symbol table, a string table, executable compiled code, etc. These are the types defined in the base spec: 'ELF_SHT_NULL' This marks "unused" entry in the section header table. The first entry in the table seems to always be an unused entry. Unused entries have empty names. 'ELF_SHT_PROGBITS' Section is what the spec calls "program specific (private) data." In practice, this basically means executable code. The prototypical progbits section is '.text'. 'ELF_SHT_SYMTAB' Section contains a symbol table. Each symbol table is an array of 'ELF64_Sym' ('Elf32_Sym' in ELF32) values spanning for 'sh_size' bytes. *Note ELF Symbols::. 'ELF_SHT_STRTAB' Section contains a string table. Each string table is an array of NULL terminated strings spanning for 'sh_size' bytes. 'ELF_SHT_RELA' 'ELF_SHT_REL' Section contains ELF relocations, with or without explicit addend. Each section contains an array of 'Elf64_Rela' or 'Elf64_Rel' ('Elf32_Rela' or 'Elf32_Rel' in ELF32) values spanning for 'sh_size' bytes. *Note ELF Relocations::. 'ELF_SHT_HASH' Section contains a symbol hash table. 'ELF_SHT_DYNAMIC' Section contains dynamic linking information in the form of a sequence of "dynamic tags". This is an array of 'Elf64_Dyn' ('Elf32_Dyn' in ELF32) values spanning for 'sh_size' bytes. *Note ELF Dynamic Info::. 'ELF_SHT_NOTE' Section contains "notes". These are flexible annotations that are usually used in order to reflect certain "auxiliary" attributes of the ELF file. For example, the name and full version of the compiler that generated it. The format in which the notes are encoded is well defined, and supported by the elf pickles. *Note ELF Notes::. 'ELF_SHT_SHLIB' This value for 'sh_type' is reserved by the ELF specification and has undefined semantics. 'ELF_SHT_DYNSYM' 'ELF_SHT_NOBITS' The section contents occupy no bits in the file. 'ELF_SHT_INIT_ARRAY' 'ELF_SHT_FINI_ARRAY' 'ELF_SHT_PREINIT_ARRAY' Section contains an array of pointers to initialization/finalization/pre-initialization functions, which are parameter-less procedures that do not return any value. This is an array of 'offset,B>' ('offset,B>' in ELF32) values spanning for 'sh_size' bytes. 'ELF_SHT_GROUP' Section contains the definition of an ELF section group. *Note ELF File::. 'ELF_SHT_SYMTAB_SHNDX' Section contains indices for 'SHN_XINDEX' entries. The ELF supplements for architectures/machines and operating systems introduce their own additional section types. *Note ELF Machines::. This field is checked against the 'section-types' configuration parameter, and pretty-printed accordingly. 'sh_flags' Is a bitmap where each enabled bit flags some particular property of the section. This is one of the 'ELF_SHF_*' values. These are the flags defined in the base spec: 'ELF_SHF_WRITE' The section contains data that should be writable during process execution. 'ELF_SHF_ALLOC' The section contents are actually loaded into memory during process execution. 'ELF_SHF_EXECINSTR' The section contains executable machine instructions. 'ELF_SHF_MERGE' The section contents can be merged to eliminate duplication. The ELF spec provides an algorithm (to be implemented by link editors) that explains how to merge sections flagged with this flag. The algorithm covers two cases: merge-able sections containing elements of fixed size, and string tables. 'ELF_SHF_STRINGS' The section contains a string table. 'ELF_SHF_INFO_LINK' The 'sh_info' field of this section header contains a section header table index. 'ELF_SHF_LINK_ORDER' This section is to be ordered in a particular way by link editors. The order to use is specified by a link to other section header table via 'sh_info'. See the ELF spec for details. 'ELF_SHF_OS_NONCONFORMING' This section requires special OS support to be linked. 'ELF_SHF_OS_TLS' This section holds "thread-local storage". 'ELF_SHF_COMPRESSED' This section contents are compressed. Sections flagged as compressed cannot have the flag 'ELF_SHF_ALLOC' set. Also, sections of type 'ELF_SHT_NOBITS' cannot be compressed. The ELF supplements for architectures/machines and operating systems introduce their own additional section types. *Note ELF Machines::. This field is checked against the 'section-flags' configuration parameter, and pretty-printed accordingly.  File: poke-elf.info, Node: ELF Program Headers, Next: ELF Symbols, Prev: ELF Section Headers, Up: Top 9 ELF Program Headers ********************* Segments can be stored anywhere in an ELF file. In case of relocatable objects, both sections and segments are present in the file, and they most certainly overlap. The ELF file contains a table, called the "program header table", whose entries describe each segment. This table is sized and linked from the ELF header via the 'e_phoff' field. The program header table is available in the 'phdr' field of 'Elf32_File' and 'Elf64_File'. The Poke types denoting entries in the program header table are 'Elf32_Phdr' and 'Elf64_Phdr' for ELF32 and ELF64 respectively. 9.1 Overview ============ type Elf32_Phdr = struct { Elf_Word p_type; Elf32_Off p_offset; Elf32_Addr p_vaddr; Elf32_Addr p_paddr; offset p_filesz; offset p_memsz; Elf_Word p_flags; offset p_align; }; type Elf64_Phdr = struct { Elf_Word p_type; Elf_Word p_flags; Elf64_Off p_offset; Elf64_Addr p_vaddr; Elf64_Addr p_paddr; offset p_filesz; offset p_memsz; offset p_align; }; 9.2 Fields ========== 'p_type' Is a code identifying the type of the segment. This is one of the 'ELF_PT_*' values. The type of a segment determines what kind of contents a segment has. These are the types defined in the base spec: 'ELF_PT_NULL' This entry in the program header table is unused, and is ignored by ELF readers. 'ELF_PT_LOAD' The segment is loadable. The stored file size is in 'p_filesz', and the loaded size is in 'p_memsz'. These sizes can be different in certain situations; for example, when the loaded data has to fulfill different alignment constraints than the stored data. However, the stored size shall not be larger than the loaded size. This is checked by a constraint. 'ELF_PT_DYNAMIC' The segment contains dynamic linking information in the form of a sequence of dynamic tags. This is an array of 'Elf64_Dyn' or 'Elf32_Dyn'. 'ELF_PT_INTERP' The segment contains a null-terminated path name that the kernel uses to invoke as an interpreter. This segment should not occur more than once in a file. If it is present, it must precede any loadable segment entry. There is a constraint in 'Elf32_File' and 'Elf64_File' that checks for this. 'ELF_PT_NOTE' The segment contains "notes". These are flexible annotations that are usually used in order to reflect certain "auxiliary" attributes of the ELF file. For example, the name and full version of the compiler that generated it. The format in which the notes are encoded is well defined, and supported by the elf pickles. *Note ELF Notes::. 'ELF_PT_SHLIB' This value for 'p_type' is reserved by the ELF specification and has undefined semantics. 'ELF_PT_PHDR' Segment contains the program header table itself, in both file and memory. This segment type may not occur more than once in a file. If it is present, it must precede any loadable segment entry. There is a constraint in 'Elf32_File' and 'Elf64_File' that checks for this. 'ELF_PT_TLS' The segment contains a thread local storage template. 'p_flags' Is a bitmap where each enabled bit flags some particular property of the segment described by this entry. This is one of the 'ELF_PF_*' values. These are the segment flags defined in the base spec: 'ELF_PF_X' The segment is executable. 'ELF_PF_W' The segment is writable. 'ELF_PF_R' The segment is readable. 'p_offset' This is the file offset of the start of the segment contents. 'p_vaddr' This is the virtual address of the start of the loaded segment contents. 'p_paddr' This is the physical address of the start of the loaded segment. Since sys-v ignores physical addressing for application programs (which use virtual memory) this field has unspecified contents in executables and shared objects. 'p_filesz' Size of the segment in the file in bytes. This may be zero for some segments. 'p_memsz' Loaded size of the segment in memory. This can be bigger than 'p_filesz'. See above. 'p_align' This is the alignment of the segment contents in both file and memory. If this field is either 0 or 1, no alignment is applied. Otherwise it must contain a power of two, and 'p_vaddr == p_offset % p_align'. This is checked by a constraint in 'Elf32_Phdr' and 'Elf64_Phdr'.  File: poke-elf.info, Node: ELF Symbols, Next: ELF Notes, Prev: ELF Program Headers, Up: Top 10 ELF Symbols ************** ELF symbols are implemented by the 'Elf32_Sym' and 'Elf64_Sym' struct types. 10.1 Overview ============= type Elf32_Sym = struct { offset st_name; Elf32_Addr st_value; offset st_size; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other; Elf_Half st_shndx; }; type Elf64_Sym = struct { offset st_name; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other; Elf_Half st_shndx; Elf64_Addr st_value; Elf64_Xword st_size; }; 10.2 Fields =========== 'st_name' Index into the file symbol string table. If this entry is zero it means the symbol has no name. 'st_info' The type and the binding attributes of the symbol. type Elf_Sym_Info = struct uint<8> { uint<4> st_bind; uint<4> st_type; }; Where: 'st_bind' Specifies how the symbol binds. This must be one of 'ELF_STB_LOCAL', 'ELF_STB_GLOBAL' or 'ELF_STB_WEAK'. 'st_type' Specifies the type of the symbol. This must be one of the 'ELF_STT_*' values. The following symbol types are defined by the core specification: 'ELF_STT_NOTYPE' The symbol's type is not specified. 'ELF_STT_OBJECT' The symbol is associated with a data object, such as a variable, an array and so on. 'ELF_STT_FUNC' The symbol is associated with a function or other executable code. 'ELF_STT_SECTION' The symbol is associated with a section. This is primarily used for relocations. 'ELF_STT_FILE' By convention, this symbol's name gives the name of the source file associated with the object file. A file symbol has local binding, its section index is 'ELF_SHN_ABS' and it precedes the other local symbols for the file. This is currently not checked by the pickles. 'ELF_STT_COMMON' The symbol labels an uninitialized common block. 'ELF_STT_TLS' The symbol specifies a Thread-Local Storage entity, in the form of an offset. 'st_other' This field specifies the symbol's visibility. This is one of the 'ELF_STV_*' values. The list of symbol visibility defined by the core spec are: 'ELF_STV_DEFAULT' The visibility of this symbol is defined by its binding. Global and weak symbols are visible outside of heir defining component. Local symbols are hidden. 'ELF_STV_PROTECTED' This symbol is visible in other components but it is not preemptable. A symbol with local binding may not have protected visibility. This is checked by a constraint in 'Elf_Sym_Info'. 'ELF_STV_HIDDEN' This symbol is not visible to other components. 'ELF_STV_INTERNAL' The meaning of this attribute, if any, is processor specific. Some machine types define other values that can be used in 'st_other'. *Note ELF Machines::. 'st_shndx' Every symbol table entry is defined in relation to some section. This holds the index into the section header table of the section related to this symbol. However, some values for this field indicate special meanings. These are the 'ELF_SHN_*' values. The core specification defines the following: 'ELF_SHN_UNDEF' The symbol is undefined. 'ELF_SHN_ABS' The symbol is absolute, meaning its value will not change because of relocation. 'ELF_SHN_COMMON' The symbol refers to a common block that has not yet been allocated. 'ELF_SHN_XINDEX' The symbol refers to a specific location within a section, but the section header index for that section is too large to e represented directly in this entry. The actual section header index is found in the associated 'SHT_SYMTAB_SHNDX' section. Some machine types define additional values with special meanings for 'st_shndx'. *Note ELF Machines::. 'st_value' Offset from the beginning of the section identified by 'st_shndx'. 'st_size' Size associated with the symbol. For example, the size of a data object. Symbols that have no associated size, or unknown size, have zero in this field.  File: poke-elf.info, Node: ELF Notes, Next: ELF Relocations, Prev: ELF Symbols, Up: Top 11 ELF Notes ************ ELF notes provide a generic mechanism for adding metadata to ELF files in the form of "notes" stored in sections. ELF notes are implemented by the 'Elf_Note' struct type. 11.1 Overview ============= type Elf_Note = struct { Elf_Word namesz; Elf_Word descsz; Elf_Word _type; byte[namesz] name; byte[descsz] desc; }; 11.2 Fields =========== 'namesz' The first 'namesz' bytes in 'name' contain a NULL-terminated character representation of the entry's owner or originator. 'descsz' The first 'descsz' bytes in 'desc' hold the note descriptor. The ABI places no constraints on a descriptor's contents. '_type' This word gives the interpretation of the descriptor. Each originator controls its own types. The ABI does not define what descriptors mean. 'name' Note name. 'desc' Note descriptor.  File: poke-elf.info, Node: ELF Relocations, Next: ELF Dynamic Info, Prev: ELF Notes, Up: Top 12 ELF Relocations ****************** ELF supports two kind of relocations: relocations without addend ("REL" relocations) and relocations with addend ("RELA" relocations). REL relocations are implemented by the 'Elf32_Rel' and 'Elf64_Rel' types. RELA relocations are implementd by the 'Elf32_Rela' and 'Elf64_Rela' types. 12.1 Overview ============= type Elf32_RelInfo = struct Elf_Word { uint<24> r_sym; uint<8> r_type; }; type Elf32_Rel = struct { Elf32_Addr r_offset; Elf32_RelInfo r_info; }; type Elf32_Rela = struct { Elf32_Addr r_offset; Elf32_RelInfo r_info; Elf_Sword r_addend; }; type Elf64_RelInfo = struct Elf64_Xword { uint<32> r_sym; uint<32> r_type; }; type Elf64_Rel = struct { Elf64_Addr r_offset; Elf64_RelInfo r_info; }; type Elf64_Rela = struct { Elf64_Addr r_offset; Elf64_RelInfo r_info; Elf64_Sxword r_addend; }; 12.2 Fields =========== 'r_offset' This field specifies the location at which to apply the relocation action, which itself depends on the specific kind of relocation. This is the byte offset from the beginning of the section whose contents are to be relocated. In executables and shared objects this offset is a virtual address; in all other ELF files this refers to the stored data. 'r_info' XXX 'r_sym' XXX 'r_type' XXX 'r_addend' XXX  File: poke-elf.info, Node: ELF Dynamic Info, Next: ELF Machines, Prev: ELF Relocations, Up: Top 13 ELF Dynamic Info ******************* XXX  File: poke-elf.info, Node: ELF Machines, Next: ELF OSes, Prev: ELF Dynamic Info, Up: Top 14 ELF Machines *************** XXX  File: poke-elf.info, Node: ELF OSes, Next: Indices, Prev: ELF Machines, Up: Top 15 ELF OSes *********** XXX  File: poke-elf.info, Node: Indices, Prev: ELF OSes, Up: Top Appendix A Indices ****************** * Menu: * Concept Index:: General concept index  File: poke-elf.info, Node: Concept Index, Up: Indices A.1 Concept Index ================= [index] * Menu: * Elf32_Dyn: ELF Dynamic Info. (line 6) * Elf32_Ehdr: ELF Header. (line 6) * Elf32_File: ELF File. (line 6) * Elf32_Phdr: ELF Program Headers. (line 6) * Elf32_Rel: ELF Relocations. (line 6) * Elf32_Rela: ELF Relocations. (line 6) * Elf32_RelInfo: ELF Relocations. (line 6) * Elf32_Shdr: ELF Section Headers. (line 6) * Elf32_Sym: ELF Symbols. (line 6) * Elf64_Dyn: ELF Dynamic Info. (line 6) * Elf64_Ehdr: ELF Header. (line 6) * Elf64_File: ELF File. (line 6) * Elf64_Phdr: ELF Program Headers. (line 6) * Elf64_Rel: ELF Relocations. (line 6) * Elf64_Rela: ELF Relocations. (line 6) * Elf64_RelInfo: ELF Relocations. (line 6) * Elf64_Shdr: ELF Section Headers. (line 6) * Elf64_Sym: ELF Symbols. (line 6) * Elf_Note: ELF Notes. (line 6) * overview, pickles: Pickles Overview. (line 6) * POKE_LOAD_PATH: Installation. (line 78)  Tag Table: Node: Top470 Node: Introduction2318 Node: Installation3888 Node: Pickles Overview6805 Ref: Pickles Overview-Footnote-18944 Node: ELF Configurations8986 Node: ELF Basic Types21891 Node: ELF File22865 Ref: ELF File-Footnote-132208 Node: ELF Header32294 Node: ELF Section Headers38837 Node: ELF Program Headers45886 Node: ELF Symbols51003 Node: ELF Notes55787 Node: ELF Relocations56823 Node: ELF Dynamic Info58574 Node: ELF Machines58723 Node: ELF OSes58857 Node: Indices58974 Node: Concept Index59143  End Tag Table  Local Variables: coding: utf-8 End: poke-elf-1.0/README0000644000175000017500000000076414427650610010671 00000000000000poke-elf is a full-fledged GNU poke pickle for editing ELF object files, executables, shared libraries and core dumps. It supports many architectures and extensions. This pickle is part of the GNU poke project. GNU poke (https://jemarch.net/poke) is an interactive, extensible editor for binary data. Not limited to editing basic entities such as bits and bytes, it provides a full-fledged procedural, interactive programming language designed to describe data structures and to operate on them. poke-elf-1.0/Makefile.in0000644000175000017500000013445514602057767012074 00000000000000# Makefile.in generated by automake 1.16.5 from Makefile.am. # @configure_input@ # Copyright (C) 1994-2021 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY, to the extent permitted by law; without # even the implied warranty of MERCHANTABILITY or FITNESS FOR A # PARTICULAR PURPOSE. @SET_MAKE@ # ELF pickle for GNU poke # Copyright (C) 2024 Jose E. Marchesi # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . VPATH = @srcdir@ am__is_gnu_make = { \ if test -z '$(MAKELEVEL)'; then \ false; \ elif test -n '$(MAKE_HOST)'; then \ true; \ elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ true; \ else \ false; \ fi; \ } am__make_running_with_option = \ case $${target_option-} in \ ?) ;; \ *) echo "am__make_running_with_option: internal error: invalid" \ "target option '$${target_option-}' specified" >&2; \ exit 1;; \ esac; \ has_opt=no; \ sane_makeflags=$$MAKEFLAGS; \ if $(am__is_gnu_make); then \ sane_makeflags=$$MFLAGS; \ else \ case $$MAKEFLAGS in \ *\\[\ \ ]*) \ bs=\\; \ sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ esac; \ fi; \ skip_next=no; \ strip_trailopt () \ { \ flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ }; \ for flg in $$sane_makeflags; do \ test $$skip_next = yes && { skip_next=no; continue; }; \ case $$flg in \ *=*|--*) continue;; \ -*I) strip_trailopt 'I'; skip_next=yes;; \ -*I?*) strip_trailopt 'I';; \ -*O) strip_trailopt 'O'; skip_next=yes;; \ -*O?*) strip_trailopt 'O';; \ -*l) strip_trailopt 'l'; skip_next=yes;; \ -*l?*) strip_trailopt 'l';; \ -[dEDm]) skip_next=yes;; \ -[JT]) skip_next=yes;; \ esac; \ case $$flg in \ *$$target_option*) has_opt=yes; break;; \ esac; \ done; \ test $$has_opt = yes am__make_dryrun = (target_option=n; $(am__make_running_with_option)) am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ pkglibexecdir = $(libexecdir)/@PACKAGE@ am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd install_sh_DATA = $(install_sh) -c -m 644 install_sh_PROGRAM = $(install_sh) -c install_sh_SCRIPT = $(install_sh) -c INSTALL_HEADER = $(INSTALL_DATA) transform = $(program_transform_name) NORMAL_INSTALL = : PRE_INSTALL = : POST_INSTALL = : NORMAL_UNINSTALL = : PRE_UNINSTALL = : POST_UNINSTALL = : subdir = . ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) DIST_COMMON = $(srcdir)/Makefile.am $(top_srcdir)/configure \ $(am__configure_deps) $(dist_bin_SCRIPTS) \ $(srcdir)/version.texi $(srcdir)/stamp-vti \ $(dist_pickles_DATA) $(am__DIST_COMMON) am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \ configure.lineno config.status.lineno mkinstalldirs = $(install_sh) -d CONFIG_CLEAN_FILES = elf-build.pk test-elf.pk CONFIG_CLEAN_VPATH_FILES = am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; am__vpath_adj = case $$p in \ $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ *) f=$$p;; \ esac; am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; am__install_max = 40 am__nobase_strip_setup = \ srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` am__nobase_strip = \ for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" am__nobase_list = $(am__nobase_strip_setup); \ for p in $$list; do echo "$$p $$p"; done | \ sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ if (++n[$$2] == $(am__install_max)) \ { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ END { for (dir in files) print dir, files[dir] }' am__base_list = \ sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' am__uninstall_files_from_dir = { \ test -z "$$files" \ || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ $(am__cd) "$$dir" && rm -f $$files; }; \ } am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(infodir)" \ "$(DESTDIR)$(picklesdir)" SCRIPTS = $(dist_bin_SCRIPTS) AM_V_P = $(am__v_P_@AM_V@) am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) am__v_P_0 = false am__v_P_1 = : AM_V_GEN = $(am__v_GEN_@AM_V@) am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) am__v_GEN_0 = @echo " GEN " $@; am__v_GEN_1 = AM_V_at = $(am__v_at_@AM_V@) am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) am__v_at_0 = @ am__v_at_1 = SOURCES = DIST_SOURCES = AM_V_DVIPS = $(am__v_DVIPS_@AM_V@) am__v_DVIPS_ = $(am__v_DVIPS_@AM_DEFAULT_V@) am__v_DVIPS_0 = @echo " DVIPS " $@; am__v_DVIPS_1 = AM_V_MAKEINFO = $(am__v_MAKEINFO_@AM_V@) am__v_MAKEINFO_ = $(am__v_MAKEINFO_@AM_DEFAULT_V@) am__v_MAKEINFO_0 = @echo " MAKEINFO" $@; am__v_MAKEINFO_1 = AM_V_INFOHTML = $(am__v_INFOHTML_@AM_V@) am__v_INFOHTML_ = $(am__v_INFOHTML_@AM_DEFAULT_V@) am__v_INFOHTML_0 = @echo " INFOHTML" $@; am__v_INFOHTML_1 = AM_V_TEXI2DVI = $(am__v_TEXI2DVI_@AM_V@) am__v_TEXI2DVI_ = $(am__v_TEXI2DVI_@AM_DEFAULT_V@) am__v_TEXI2DVI_0 = @echo " TEXI2DVI" $@; am__v_TEXI2DVI_1 = AM_V_TEXI2PDF = $(am__v_TEXI2PDF_@AM_V@) am__v_TEXI2PDF_ = $(am__v_TEXI2PDF_@AM_DEFAULT_V@) am__v_TEXI2PDF_0 = @echo " TEXI2PDF" $@; am__v_TEXI2PDF_1 = AM_V_texinfo = $(am__v_texinfo_@AM_V@) am__v_texinfo_ = $(am__v_texinfo_@AM_DEFAULT_V@) am__v_texinfo_0 = -q am__v_texinfo_1 = AM_V_texidevnull = $(am__v_texidevnull_@AM_V@) am__v_texidevnull_ = $(am__v_texidevnull_@AM_DEFAULT_V@) am__v_texidevnull_0 = > /dev/null am__v_texidevnull_1 = INFO_DEPS = $(srcdir)/poke-elf.info TEXINFO_TEX = $(top_srcdir)/build-aux/texinfo.tex am__TEXINFO_TEX_DIR = $(top_srcdir)/build-aux DVIS = poke-elf.dvi PDFS = poke-elf.pdf PSS = poke-elf.ps HTMLS = poke-elf.html TEXINFOS = poke-elf.texi TEXI2DVI = texi2dvi TEXI2PDF = $(TEXI2DVI) --pdf --batch MAKEINFOHTML = $(MAKEINFO) --html AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) DVIPS = dvips am__can_run_installinfo = \ case $$AM_UPDATE_INFO_DIR in \ n|no|NO) false;; \ *) (install-info --version) >/dev/null 2>&1;; \ esac DATA = $(dist_pickles_DATA) am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) am__tty_colors_dummy = \ mgn= red= grn= lgn= blu= brg= std=; \ am__color_tests=no am__tty_colors = { \ $(am__tty_colors_dummy); \ if test "X$(AM_COLOR_TESTS)" = Xno; then \ am__color_tests=no; \ elif test "X$(AM_COLOR_TESTS)" = Xalways; then \ am__color_tests=yes; \ elif test "X$$TERM" != Xdumb && { test -t 1; } 2>/dev/null; then \ am__color_tests=yes; \ fi; \ if test $$am__color_tests = yes; then \ red=''; \ grn=''; \ lgn=''; \ blu=''; \ mgn=''; \ brg=''; \ std=''; \ fi; \ } am__recheck_rx = ^[ ]*:recheck:[ ]* am__global_test_result_rx = ^[ ]*:global-test-result:[ ]* am__copy_in_global_log_rx = ^[ ]*:copy-in-global-log:[ ]* # A command that, given a newline-separated list of test names on the # standard input, print the name of the tests that are to be re-run # upon "make recheck". am__list_recheck_tests = $(AWK) '{ \ recheck = 1; \ while ((rc = (getline line < ($$0 ".trs"))) != 0) \ { \ if (rc < 0) \ { \ if ((getline line2 < ($$0 ".log")) < 0) \ recheck = 0; \ break; \ } \ else if (line ~ /$(am__recheck_rx)[nN][Oo]/) \ { \ recheck = 0; \ break; \ } \ else if (line ~ /$(am__recheck_rx)[yY][eE][sS]/) \ { \ break; \ } \ }; \ if (recheck) \ print $$0; \ close ($$0 ".trs"); \ close ($$0 ".log"); \ }' # A command that, given a newline-separated list of test names on the # standard input, create the global log from their .trs and .log files. am__create_global_log = $(AWK) ' \ function fatal(msg) \ { \ print "fatal: making $@: " msg | "cat >&2"; \ exit 1; \ } \ function rst_section(header) \ { \ print header; \ len = length(header); \ for (i = 1; i <= len; i = i + 1) \ printf "="; \ printf "\n\n"; \ } \ { \ copy_in_global_log = 1; \ global_test_result = "RUN"; \ while ((rc = (getline line < ($$0 ".trs"))) != 0) \ { \ if (rc < 0) \ fatal("failed to read from " $$0 ".trs"); \ if (line ~ /$(am__global_test_result_rx)/) \ { \ sub("$(am__global_test_result_rx)", "", line); \ sub("[ ]*$$", "", line); \ global_test_result = line; \ } \ else if (line ~ /$(am__copy_in_global_log_rx)[nN][oO]/) \ copy_in_global_log = 0; \ }; \ if (copy_in_global_log) \ { \ rst_section(global_test_result ": " $$0); \ while ((rc = (getline line < ($$0 ".log"))) != 0) \ { \ if (rc < 0) \ fatal("failed to read from " $$0 ".log"); \ print line; \ }; \ printf "\n"; \ }; \ close ($$0 ".trs"); \ close ($$0 ".log"); \ }' # Restructured Text title. am__rst_title = { sed 's/.*/ & /;h;s/./=/g;p;x;s/ *$$//;p;g' && echo; } # Solaris 10 'make', and several other traditional 'make' implementations, # pass "-e" to $(SHELL), and POSIX 2008 even requires this. Work around it # by disabling -e (using the XSI extension "set +e") if it's set. am__sh_e_setup = case $$- in *e*) set +e;; esac # Default flags passed to test drivers. am__common_driver_flags = \ --color-tests "$$am__color_tests" \ --enable-hard-errors "$$am__enable_hard_errors" \ --expect-failure "$$am__expect_failure" # To be inserted before the command running the test. Creates the # directory for the log if needed. Stores in $dir the directory # containing $f, in $tst the test, in $log the log. Executes the # developer- defined test setup AM_TESTS_ENVIRONMENT (if any), and # passes TESTS_ENVIRONMENT. Set up options for the wrapper that # will run the test scripts (or their associated LOG_COMPILER, if # thy have one). am__check_pre = \ $(am__sh_e_setup); \ $(am__vpath_adj_setup) $(am__vpath_adj) \ $(am__tty_colors); \ srcdir=$(srcdir); export srcdir; \ case "$@" in \ */*) am__odir=`echo "./$@" | sed 's|/[^/]*$$||'`;; \ *) am__odir=.;; \ esac; \ test "x$$am__odir" = x"." || test -d "$$am__odir" \ || $(MKDIR_P) "$$am__odir" || exit $$?; \ if test -f "./$$f"; then dir=./; \ elif test -f "$$f"; then dir=; \ else dir="$(srcdir)/"; fi; \ tst=$$dir$$f; log='$@'; \ if test -n '$(DISABLE_HARD_ERRORS)'; then \ am__enable_hard_errors=no; \ else \ am__enable_hard_errors=yes; \ fi; \ case " $(XFAIL_TESTS) " in \ *[\ \ ]$$f[\ \ ]* | *[\ \ ]$$dir$$f[\ \ ]*) \ am__expect_failure=yes;; \ *) \ am__expect_failure=no;; \ esac; \ $(AM_TESTS_ENVIRONMENT) $(TESTS_ENVIRONMENT) # A shell command to get the names of the tests scripts with any registered # extension removed (i.e., equivalently, the names of the test logs, with # the '.log' extension removed). The result is saved in the shell variable # '$bases'. This honors runtime overriding of TESTS and TEST_LOGS. Sadly, # we cannot use something simpler, involving e.g., "$(TEST_LOGS:.log=)", # since that might cause problem with VPATH rewrites for suffix-less tests. # See also 'test-harness-vpath-rewrite.sh' and 'test-trs-basic.sh'. am__set_TESTS_bases = \ bases='$(TEST_LOGS)'; \ bases=`for i in $$bases; do echo $$i; done | sed 's/\.log$$//'`; \ bases=`echo $$bases` AM_TESTSUITE_SUMMARY_HEADER = ' for $(PACKAGE_STRING)' RECHECK_LOGS = $(TEST_LOGS) AM_RECURSIVE_TARGETS = check recheck TEST_SUITE_LOG = test-suite.log TEST_EXTENSIONS = .test LOG_DRIVER = $(SHELL) $(top_srcdir)/build-aux/test-driver LOG_COMPILE = $(LOG_COMPILER) $(AM_LOG_FLAGS) $(LOG_FLAGS) am__set_b = \ case '$@' in \ */*) \ case '$*' in \ */*) b='$*';; \ *) b=`echo '$@' | sed 's/\.log$$//'`; \ esac;; \ *) \ b='$*';; \ esac am__test_logs1 = $(TESTS:=.log) TEST_LOGS = $(am__test_logs1:.test.log=.log) TEST_LOG_COMPILE = $(TEST_LOG_COMPILER) $(AM_TEST_LOG_FLAGS) \ $(TEST_LOG_FLAGS) am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/elf-build.pk.in \ $(srcdir)/test-elf.pk.in $(top_srcdir)/build-aux/install-sh \ $(top_srcdir)/build-aux/mdate-sh \ $(top_srcdir)/build-aux/missing \ $(top_srcdir)/build-aux/tap-driver.sh \ $(top_srcdir)/build-aux/test-driver \ $(top_srcdir)/build-aux/texinfo.tex AUTHORS COPYING README \ build-aux/install-sh build-aux/mdate-sh build-aux/missing \ build-aux/texinfo.tex DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) distdir = $(PACKAGE)-$(VERSION) top_distdir = $(distdir) am__remove_distdir = \ if test -d "$(distdir)"; then \ find "$(distdir)" -type d ! -perm -200 -exec chmod u+w {} ';' \ && rm -rf "$(distdir)" \ || { sleep 5 && rm -rf "$(distdir)"; }; \ else :; fi am__post_remove_distdir = $(am__remove_distdir) DIST_ARCHIVES = $(distdir).tar.gz GZIP_ENV = --best DIST_TARGETS = dist-gzip # Exists only to be overridden by the user if desired. AM_DISTCHECK_DVI_TARGET = dvi distuninstallcheck_listfiles = find . -type f -print am__distuninstallcheck_listfiles = $(distuninstallcheck_listfiles) \ | sed 's|^\./|$(prefix)/|' | grep -v '$(infodir)/dir$$' distcleancheck_listfiles = find . -type f -print ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ AWK = @AWK@ CSCOPE = @CSCOPE@ CTAGS = @CTAGS@ CYGPATH_W = @CYGPATH_W@ DEFS = @DEFS@ ECHO_C = @ECHO_C@ ECHO_N = @ECHO_N@ ECHO_T = @ECHO_T@ ETAGS = @ETAGS@ INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LTLIBOBJS = @LTLIBOBJS@ MAKEINFO = @MAKEINFO@ MKDIR_P = @MKDIR_P@ PACKAGE = @PACKAGE@ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ PACKAGE_NAME = @PACKAGE_NAME@ PACKAGE_STRING = @PACKAGE_STRING@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ POKE = @POKE@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ VERSION = @VERSION@ abs_builddir = @abs_builddir@ abs_srcdir = @abs_srcdir@ abs_top_builddir = @abs_top_builddir@ abs_top_srcdir = @abs_top_srcdir@ am__leading_dot = @am__leading_dot@ am__tar = @am__tar@ am__untar = @am__untar@ bindir = @bindir@ build_alias = @build_alias@ builddir = @builddir@ datadir = @datadir@ datarootdir = @datarootdir@ docdir = @docdir@ dvidir = @dvidir@ exec_prefix = @exec_prefix@ host_alias = @host_alias@ htmldir = @htmldir@ includedir = @includedir@ infodir = @infodir@ install_sh = @install_sh@ libdir = @libdir@ libexecdir = @libexecdir@ localedir = @localedir@ localstatedir = @localstatedir@ mandir = @mandir@ mkdir_p = @mkdir_p@ oldincludedir = @oldincludedir@ pdfdir = @pdfdir@ prefix = @prefix@ program_transform_name = @program_transform_name@ psdir = @psdir@ runstatedir = @runstatedir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ sysconfdir = @sysconfdir@ target_alias = @target_alias@ top_build_prefix = @top_build_prefix@ top_builddir = @top_builddir@ top_srcdir = @top_srcdir@ picklesdir = $(datadir)/poke/pickles dist_pickles_DATA = elf.pk \ elf-build.pk \ elf-common.pk \ elf-64.pk elf-32.pk \ elf-config.pk \ elf-mach-x86-64.pk \ elf-mach-aarch64.pk \ elf-mach-mips.pk \ elf-mach-sparc.pk \ elf-mach-bpf.pk \ elf-mach-riscv.pk \ elf-mach-arm.pk \ elf-os-gnu.pk \ elf-os-llvm.pk \ elf-os-linux.pk \ elf-os-openbsd.pk info_TEXINFOS = poke-elf.texi AM_MAKEINFOFLAGS = --set-customization-variable CHECK_NORMAL_MENU_STRUCTURE=true # Running the testsuite. # # Note that it is important to invoke POKE from the same directory # where the pickle's .pk files are, so they are picked up before the # system-installed pickles. EXTRA_DIST = elf-build.pk.in test-elf.pk.in # Example utilities. dist_bin_SCRIPTS = examples/prelinkr @RUN_TESTS_TRUE@TEST_LOG_DRIVER = env AM_TAP_AWK='$(AWK)' \ @RUN_TESTS_TRUE@ $(SHELL) $(top_srcdir)/build-aux/tap-driver.sh @RUN_TESTS_TRUE@TESTS_ENVIRONMENT = POKE_LOAD_PATH=$(top_srcdir) @RUN_TESTS_TRUE@TESTS = test-elf.pk all: all-am .SUFFIXES: .SUFFIXES: .dvi .html .info .log .pdf .ps .test .texi .trs am--refresh: Makefile @: $(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) @for dep in $?; do \ case '$(am__configure_deps)' in \ *$$dep*) \ echo ' cd $(srcdir) && $(AUTOMAKE) --foreign'; \ $(am__cd) $(srcdir) && $(AUTOMAKE) --foreign \ && exit 0; \ exit 1;; \ esac; \ done; \ echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Makefile'; \ $(am__cd) $(top_srcdir) && \ $(AUTOMAKE) --foreign Makefile Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status @case '$?' in \ *config.status*) \ echo ' $(SHELL) ./config.status'; \ $(SHELL) ./config.status;; \ *) \ echo ' cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles)'; \ cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles);; \ esac; $(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) $(SHELL) ./config.status --recheck $(top_srcdir)/configure: $(am__configure_deps) $(am__cd) $(srcdir) && $(AUTOCONF) $(ACLOCAL_M4): $(am__aclocal_m4_deps) $(am__cd) $(srcdir) && $(ACLOCAL) $(ACLOCAL_AMFLAGS) $(am__aclocal_m4_deps): elf-build.pk: $(top_builddir)/config.status $(srcdir)/elf-build.pk.in cd $(top_builddir) && $(SHELL) ./config.status $@ test-elf.pk: $(top_builddir)/config.status $(srcdir)/test-elf.pk.in cd $(top_builddir) && $(SHELL) ./config.status $@ install-dist_binSCRIPTS: $(dist_bin_SCRIPTS) @$(NORMAL_INSTALL) @list='$(dist_bin_SCRIPTS)'; test -n "$(bindir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(bindir)'"; \ $(MKDIR_P) "$(DESTDIR)$(bindir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ if test -f "$$d$$p"; then echo "$$d$$p"; echo "$$p"; else :; fi; \ done | \ sed -e 'p;s,.*/,,;n' \ -e 'h;s|.*|.|' \ -e 'p;x;s,.*/,,;$(transform)' | sed 'N;N;N;s,\n, ,g' | \ $(AWK) 'BEGIN { files["."] = ""; dirs["."] = 1; } \ { d=$$3; if (dirs[d] != 1) { print "d", d; dirs[d] = 1 } \ if ($$2 == $$4) { files[d] = files[d] " " $$1; \ if (++n[d] == $(am__install_max)) { \ print "f", d, files[d]; n[d] = 0; files[d] = "" } } \ else { print "f", d "/" $$4, $$1 } } \ END { for (d in files) print "f", d, files[d] }' | \ while read type dir files; do \ if test "$$dir" = .; then dir=; else dir=/$$dir; fi; \ test -z "$$files" || { \ echo " $(INSTALL_SCRIPT) $$files '$(DESTDIR)$(bindir)$$dir'"; \ $(INSTALL_SCRIPT) $$files "$(DESTDIR)$(bindir)$$dir" || exit $$?; \ } \ ; done uninstall-dist_binSCRIPTS: @$(NORMAL_UNINSTALL) @list='$(dist_bin_SCRIPTS)'; test -n "$(bindir)" || exit 0; \ files=`for p in $$list; do echo "$$p"; done | \ sed -e 's,.*/,,;$(transform)'`; \ dir='$(DESTDIR)$(bindir)'; $(am__uninstall_files_from_dir) .texi.info: $(AM_V_MAKEINFO)restore=: && backupdir="$(am__leading_dot)am$$$$" && \ am__cwd=`pwd` && $(am__cd) $(srcdir) && \ rm -rf $$backupdir && mkdir $$backupdir && \ if ($(MAKEINFO) --version) >/dev/null 2>&1; then \ for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \ if test -f $$f; then mv $$f $$backupdir; restore=mv; else :; fi; \ done; \ else :; fi && \ cd "$$am__cwd"; \ if $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ -o $@ $<; \ then \ rc=0; \ $(am__cd) $(srcdir); \ else \ rc=$$?; \ $(am__cd) $(srcdir) && \ $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \ fi; \ rm -rf $$backupdir; exit $$rc .texi.dvi: $(AM_V_TEXI2DVI)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ $(TEXI2DVI) $(AM_V_texinfo) --build-dir=$(@:.dvi=.t2d) -o $@ $(AM_V_texidevnull) \ $< .texi.pdf: $(AM_V_TEXI2PDF)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ $(TEXI2PDF) $(AM_V_texinfo) --build-dir=$(@:.pdf=.t2p) -o $@ $(AM_V_texidevnull) \ $< .texi.html: $(AM_V_MAKEINFO)rm -rf $(@:.html=.htp) $(AM_V_at)if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ -o $(@:.html=.htp) $<; \ then \ rm -rf $@ && mv $(@:.html=.htp) $@; \ else \ rm -rf $(@:.html=.htp); exit 1; \ fi $(srcdir)/poke-elf.info: poke-elf.texi $(srcdir)/version.texi poke-elf.dvi: poke-elf.texi $(srcdir)/version.texi poke-elf.pdf: poke-elf.texi $(srcdir)/version.texi poke-elf.html: poke-elf.texi $(srcdir)/version.texi $(srcdir)/version.texi: $(srcdir)/stamp-vti $(srcdir)/stamp-vti: poke-elf.texi $(top_srcdir)/configure @(dir=.; test -f ./poke-elf.texi || dir=$(srcdir); \ set `$(SHELL) $(top_srcdir)/build-aux/mdate-sh $$dir/poke-elf.texi`; \ echo "@set UPDATED $$1 $$2 $$3"; \ echo "@set UPDATED-MONTH $$2 $$3"; \ echo "@set EDITION $(VERSION)"; \ echo "@set VERSION $(VERSION)") > vti.tmp$$$$ && \ (cmp -s vti.tmp$$$$ $(srcdir)/version.texi \ || (echo "Updating $(srcdir)/version.texi" && \ cp vti.tmp$$$$ $(srcdir)/version.texi.tmp$$$$ && \ mv $(srcdir)/version.texi.tmp$$$$ $(srcdir)/version.texi)) && \ rm -f vti.tmp$$$$ $(srcdir)/version.texi.$$$$ @cp $(srcdir)/version.texi $@ mostlyclean-vti: -rm -f vti.tmp* $(srcdir)/version.texi.tmp* maintainer-clean-vti: -rm -f $(srcdir)/stamp-vti $(srcdir)/version.texi .dvi.ps: $(AM_V_DVIPS)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ $(DVIPS) $(AM_V_texinfo) -o $@ $< uninstall-dvi-am: @$(NORMAL_UNINSTALL) @list='$(DVIS)'; test -n "$(dvidir)" || list=; \ for p in $$list; do \ $(am__strip_dir) \ echo " rm -f '$(DESTDIR)$(dvidir)/$$f'"; \ rm -f "$(DESTDIR)$(dvidir)/$$f"; \ done uninstall-html-am: @$(NORMAL_UNINSTALL) @list='$(HTMLS)'; test -n "$(htmldir)" || list=; \ for p in $$list; do \ $(am__strip_dir) \ echo " rm -rf '$(DESTDIR)$(htmldir)/$$f'"; \ rm -rf "$(DESTDIR)$(htmldir)/$$f"; \ done uninstall-info-am: @$(PRE_UNINSTALL) @if test -d '$(DESTDIR)$(infodir)' && $(am__can_run_installinfo); then \ list='$(INFO_DEPS)'; \ for file in $$list; do \ relfile=`echo "$$file" | sed 's|^.*/||'`; \ echo " install-info --info-dir='$(DESTDIR)$(infodir)' --remove '$(DESTDIR)$(infodir)/$$relfile'"; \ if install-info --info-dir="$(DESTDIR)$(infodir)" --remove "$(DESTDIR)$(infodir)/$$relfile"; \ then :; else test ! -f "$(DESTDIR)$(infodir)/$$relfile" || exit 1; fi; \ done; \ else :; fi @$(NORMAL_UNINSTALL) @list='$(INFO_DEPS)'; \ for file in $$list; do \ relfile=`echo "$$file" | sed 's|^.*/||'`; \ relfile_i=`echo "$$relfile" | sed 's|\.info$$||;s|$$|.i|'`; \ (if test -d "$(DESTDIR)$(infodir)" && cd "$(DESTDIR)$(infodir)"; then \ echo " cd '$(DESTDIR)$(infodir)' && rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]"; \ rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]; \ else :; fi); \ done uninstall-pdf-am: @$(NORMAL_UNINSTALL) @list='$(PDFS)'; test -n "$(pdfdir)" || list=; \ for p in $$list; do \ $(am__strip_dir) \ echo " rm -f '$(DESTDIR)$(pdfdir)/$$f'"; \ rm -f "$(DESTDIR)$(pdfdir)/$$f"; \ done uninstall-ps-am: @$(NORMAL_UNINSTALL) @list='$(PSS)'; test -n "$(psdir)" || list=; \ for p in $$list; do \ $(am__strip_dir) \ echo " rm -f '$(DESTDIR)$(psdir)/$$f'"; \ rm -f "$(DESTDIR)$(psdir)/$$f"; \ done dist-info: $(INFO_DEPS) @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ list='$(INFO_DEPS)'; \ for base in $$list; do \ case $$base in \ $(srcdir)/*) base=`echo "$$base" | sed "s|^$$srcdirstrip/||"`;; \ esac; \ if test -f $$base; then d=.; else d=$(srcdir); fi; \ base_i=`echo "$$base" | sed 's|\.info$$||;s|$$|.i|'`; \ for file in $$d/$$base $$d/$$base-[0-9] $$d/$$base-[0-9][0-9] $$d/$$base_i[0-9] $$d/$$base_i[0-9][0-9]; do \ if test -f $$file; then \ relfile=`expr "$$file" : "$$d/\(.*\)"`; \ test -f "$(distdir)/$$relfile" || \ cp -p $$file "$(distdir)/$$relfile"; \ else :; fi; \ done; \ done mostlyclean-aminfo: -rm -rf poke-elf.t2d poke-elf.t2p clean-aminfo: -test -z "poke-elf.dvi poke-elf.pdf poke-elf.ps poke-elf.html" \ || rm -rf poke-elf.dvi poke-elf.pdf poke-elf.ps poke-elf.html maintainer-clean-aminfo: @list='$(INFO_DEPS)'; for i in $$list; do \ i_i=`echo "$$i" | sed 's|\.info$$||;s|$$|.i|'`; \ echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \ rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \ done install-dist_picklesDATA: $(dist_pickles_DATA) @$(NORMAL_INSTALL) @list='$(dist_pickles_DATA)'; test -n "$(picklesdir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(picklesdir)'"; \ $(MKDIR_P) "$(DESTDIR)$(picklesdir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(picklesdir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(picklesdir)" || exit $$?; \ done uninstall-dist_picklesDATA: @$(NORMAL_UNINSTALL) @list='$(dist_pickles_DATA)'; test -n "$(picklesdir)" || list=; \ files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ dir='$(DESTDIR)$(picklesdir)'; $(am__uninstall_files_from_dir) tags TAGS: ctags CTAGS: cscope cscopelist: # Recover from deleted '.trs' file; this should ensure that # "rm -f foo.log; make foo.trs" re-run 'foo.test', and re-create # both 'foo.log' and 'foo.trs'. Break the recipe in two subshells # to avoid problems with "make -n". .log.trs: rm -f $< $@ $(MAKE) $(AM_MAKEFLAGS) $< # Leading 'am--fnord' is there to ensure the list of targets does not # expand to empty, as could happen e.g. with make check TESTS=''. am--fnord $(TEST_LOGS) $(TEST_LOGS:.log=.trs): $(am__force_recheck) am--force-recheck: @: $(TEST_SUITE_LOG): $(TEST_LOGS) @$(am__set_TESTS_bases); \ am__f_ok () { test -f "$$1" && test -r "$$1"; }; \ redo_bases=`for i in $$bases; do \ am__f_ok $$i.trs && am__f_ok $$i.log || echo $$i; \ done`; \ if test -n "$$redo_bases"; then \ redo_logs=`for i in $$redo_bases; do echo $$i.log; done`; \ redo_results=`for i in $$redo_bases; do echo $$i.trs; done`; \ if $(am__make_dryrun); then :; else \ rm -f $$redo_logs && rm -f $$redo_results || exit 1; \ fi; \ fi; \ if test -n "$$am__remaking_logs"; then \ echo "fatal: making $(TEST_SUITE_LOG): possible infinite" \ "recursion detected" >&2; \ elif test -n "$$redo_logs"; then \ am__remaking_logs=yes $(MAKE) $(AM_MAKEFLAGS) $$redo_logs; \ fi; \ if $(am__make_dryrun); then :; else \ st=0; \ errmsg="fatal: making $(TEST_SUITE_LOG): failed to create"; \ for i in $$redo_bases; do \ test -f $$i.trs && test -r $$i.trs \ || { echo "$$errmsg $$i.trs" >&2; st=1; }; \ test -f $$i.log && test -r $$i.log \ || { echo "$$errmsg $$i.log" >&2; st=1; }; \ done; \ test $$st -eq 0 || exit 1; \ fi @$(am__sh_e_setup); $(am__tty_colors); $(am__set_TESTS_bases); \ ws='[ ]'; \ results=`for b in $$bases; do echo $$b.trs; done`; \ test -n "$$results" || results=/dev/null; \ all=` grep "^$$ws*:test-result:" $$results | wc -l`; \ pass=` grep "^$$ws*:test-result:$$ws*PASS" $$results | wc -l`; \ fail=` grep "^$$ws*:test-result:$$ws*FAIL" $$results | wc -l`; \ skip=` grep "^$$ws*:test-result:$$ws*SKIP" $$results | wc -l`; \ xfail=`grep "^$$ws*:test-result:$$ws*XFAIL" $$results | wc -l`; \ xpass=`grep "^$$ws*:test-result:$$ws*XPASS" $$results | wc -l`; \ error=`grep "^$$ws*:test-result:$$ws*ERROR" $$results | wc -l`; \ if test `expr $$fail + $$xpass + $$error` -eq 0; then \ success=true; \ else \ success=false; \ fi; \ br='==================='; br=$$br$$br$$br$$br; \ result_count () \ { \ if test x"$$1" = x"--maybe-color"; then \ maybe_colorize=yes; \ elif test x"$$1" = x"--no-color"; then \ maybe_colorize=no; \ else \ echo "$@: invalid 'result_count' usage" >&2; exit 4; \ fi; \ shift; \ desc=$$1 count=$$2; \ if test $$maybe_colorize = yes && test $$count -gt 0; then \ color_start=$$3 color_end=$$std; \ else \ color_start= color_end=; \ fi; \ echo "$${color_start}# $$desc $$count$${color_end}"; \ }; \ create_testsuite_report () \ { \ result_count $$1 "TOTAL:" $$all "$$brg"; \ result_count $$1 "PASS: " $$pass "$$grn"; \ result_count $$1 "SKIP: " $$skip "$$blu"; \ result_count $$1 "XFAIL:" $$xfail "$$lgn"; \ result_count $$1 "FAIL: " $$fail "$$red"; \ result_count $$1 "XPASS:" $$xpass "$$red"; \ result_count $$1 "ERROR:" $$error "$$mgn"; \ }; \ { \ echo "$(PACKAGE_STRING): $(subdir)/$(TEST_SUITE_LOG)" | \ $(am__rst_title); \ create_testsuite_report --no-color; \ echo; \ echo ".. contents:: :depth: 2"; \ echo; \ for b in $$bases; do echo $$b; done \ | $(am__create_global_log); \ } >$(TEST_SUITE_LOG).tmp || exit 1; \ mv $(TEST_SUITE_LOG).tmp $(TEST_SUITE_LOG); \ if $$success; then \ col="$$grn"; \ else \ col="$$red"; \ test x"$$VERBOSE" = x || cat $(TEST_SUITE_LOG); \ fi; \ echo "$${col}$$br$${std}"; \ echo "$${col}Testsuite summary"$(AM_TESTSUITE_SUMMARY_HEADER)"$${std}"; \ echo "$${col}$$br$${std}"; \ create_testsuite_report --maybe-color; \ echo "$$col$$br$$std"; \ if $$success; then :; else \ echo "$${col}See $(subdir)/$(TEST_SUITE_LOG)$${std}"; \ if test -n "$(PACKAGE_BUGREPORT)"; then \ echo "$${col}Please report to $(PACKAGE_BUGREPORT)$${std}"; \ fi; \ echo "$$col$$br$$std"; \ fi; \ $$success || exit 1 check-TESTS: @list='$(RECHECK_LOGS)'; test -z "$$list" || rm -f $$list @list='$(RECHECK_LOGS:.log=.trs)'; test -z "$$list" || rm -f $$list @test -z "$(TEST_SUITE_LOG)" || rm -f $(TEST_SUITE_LOG) @set +e; $(am__set_TESTS_bases); \ log_list=`for i in $$bases; do echo $$i.log; done`; \ trs_list=`for i in $$bases; do echo $$i.trs; done`; \ log_list=`echo $$log_list`; trs_list=`echo $$trs_list`; \ $(MAKE) $(AM_MAKEFLAGS) $(TEST_SUITE_LOG) TEST_LOGS="$$log_list"; \ exit $$?; recheck: all @test -z "$(TEST_SUITE_LOG)" || rm -f $(TEST_SUITE_LOG) @set +e; $(am__set_TESTS_bases); \ bases=`for i in $$bases; do echo $$i; done \ | $(am__list_recheck_tests)` || exit 1; \ log_list=`for i in $$bases; do echo $$i.log; done`; \ log_list=`echo $$log_list`; \ $(MAKE) $(AM_MAKEFLAGS) $(TEST_SUITE_LOG) \ am__force_recheck=am--force-recheck \ TEST_LOGS="$$log_list"; \ exit $$? test-elf.pk.log: test-elf.pk @p='test-elf.pk'; \ b='test-elf.pk'; \ $(am__check_pre) $(LOG_DRIVER) --test-name "$$f" \ --log-file $$b.log --trs-file $$b.trs \ $(am__common_driver_flags) $(AM_LOG_DRIVER_FLAGS) $(LOG_DRIVER_FLAGS) -- $(LOG_COMPILE) \ "$$tst" $(AM_TESTS_FD_REDIRECT) .test.log: @p='$<'; \ $(am__set_b); \ $(am__check_pre) $(TEST_LOG_DRIVER) --test-name "$$f" \ --log-file $$b.log --trs-file $$b.trs \ $(am__common_driver_flags) $(AM_TEST_LOG_DRIVER_FLAGS) $(TEST_LOG_DRIVER_FLAGS) -- $(TEST_LOG_COMPILE) \ "$$tst" $(AM_TESTS_FD_REDIRECT) distdir: $(BUILT_SOURCES) $(MAKE) $(AM_MAKEFLAGS) distdir-am distdir-am: $(DISTFILES) $(am__remove_distdir) test -d "$(distdir)" || mkdir "$(distdir)" @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ list='$(DISTFILES)'; \ dist_files=`for file in $$list; do echo $$file; done | \ sed -e "s|^$$srcdirstrip/||;t" \ -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ case $$dist_files in \ */*) $(MKDIR_P) `echo "$$dist_files" | \ sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ sort -u` ;; \ esac; \ for file in $$dist_files; do \ if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ if test -d $$d/$$file; then \ dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ if test -d "$(distdir)/$$file"; then \ find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ fi; \ if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ fi; \ cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ else \ test -f "$(distdir)/$$file" \ || cp -p $$d/$$file "$(distdir)/$$file" \ || exit 1; \ fi; \ done $(MAKE) $(AM_MAKEFLAGS) \ top_distdir="$(top_distdir)" distdir="$(distdir)" \ dist-info -test -n "$(am__skip_mode_fix)" \ || find "$(distdir)" -type d ! -perm -755 \ -exec chmod u+rwx,go+rx {} \; -o \ ! -type d ! -perm -444 -links 1 -exec chmod a+r {} \; -o \ ! -type d ! -perm -400 -exec chmod a+r {} \; -o \ ! -type d ! -perm -444 -exec $(install_sh) -c -m a+r {} {} \; \ || chmod -R a+r "$(distdir)" dist-gzip: distdir tardir=$(distdir) && $(am__tar) | eval GZIP= gzip $(GZIP_ENV) -c >$(distdir).tar.gz $(am__post_remove_distdir) dist-bzip2: distdir tardir=$(distdir) && $(am__tar) | BZIP2=$${BZIP2--9} bzip2 -c >$(distdir).tar.bz2 $(am__post_remove_distdir) dist-lzip: distdir tardir=$(distdir) && $(am__tar) | lzip -c $${LZIP_OPT--9} >$(distdir).tar.lz $(am__post_remove_distdir) dist-xz: distdir tardir=$(distdir) && $(am__tar) | XZ_OPT=$${XZ_OPT--e} xz -c >$(distdir).tar.xz $(am__post_remove_distdir) dist-zstd: distdir tardir=$(distdir) && $(am__tar) | zstd -c $${ZSTD_CLEVEL-$${ZSTD_OPT--19}} >$(distdir).tar.zst $(am__post_remove_distdir) dist-tarZ: distdir @echo WARNING: "Support for distribution archives compressed with" \ "legacy program 'compress' is deprecated." >&2 @echo WARNING: "It will be removed altogether in Automake 2.0" >&2 tardir=$(distdir) && $(am__tar) | compress -c >$(distdir).tar.Z $(am__post_remove_distdir) dist-shar: distdir @echo WARNING: "Support for shar distribution archives is" \ "deprecated." >&2 @echo WARNING: "It will be removed altogether in Automake 2.0" >&2 shar $(distdir) | eval GZIP= gzip $(GZIP_ENV) -c >$(distdir).shar.gz $(am__post_remove_distdir) dist-zip: distdir -rm -f $(distdir).zip zip -rq $(distdir).zip $(distdir) $(am__post_remove_distdir) dist dist-all: $(MAKE) $(AM_MAKEFLAGS) $(DIST_TARGETS) am__post_remove_distdir='@:' $(am__post_remove_distdir) # This target untars the dist file and tries a VPATH configuration. Then # it guarantees that the distribution is self-contained by making another # tarfile. distcheck: dist case '$(DIST_ARCHIVES)' in \ *.tar.gz*) \ eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).tar.gz | $(am__untar) ;;\ *.tar.bz2*) \ bzip2 -dc $(distdir).tar.bz2 | $(am__untar) ;;\ *.tar.lz*) \ lzip -dc $(distdir).tar.lz | $(am__untar) ;;\ *.tar.xz*) \ xz -dc $(distdir).tar.xz | $(am__untar) ;;\ *.tar.Z*) \ uncompress -c $(distdir).tar.Z | $(am__untar) ;;\ *.shar.gz*) \ eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).shar.gz | unshar ;;\ *.zip*) \ unzip $(distdir).zip ;;\ *.tar.zst*) \ zstd -dc $(distdir).tar.zst | $(am__untar) ;;\ esac chmod -R a-w $(distdir) chmod u+w $(distdir) mkdir $(distdir)/_build $(distdir)/_build/sub $(distdir)/_inst chmod a-w $(distdir) test -d $(distdir)/_build || exit 0; \ dc_install_base=`$(am__cd) $(distdir)/_inst && pwd | sed -e 's,^[^:\\/]:[\\/],/,'` \ && dc_destdir="$${TMPDIR-/tmp}/am-dc-$$$$/" \ && am__cwd=`pwd` \ && $(am__cd) $(distdir)/_build/sub \ && ../../configure \ $(AM_DISTCHECK_CONFIGURE_FLAGS) \ $(DISTCHECK_CONFIGURE_FLAGS) \ --srcdir=../.. --prefix="$$dc_install_base" \ && $(MAKE) $(AM_MAKEFLAGS) \ && $(MAKE) $(AM_MAKEFLAGS) $(AM_DISTCHECK_DVI_TARGET) \ && $(MAKE) $(AM_MAKEFLAGS) check \ && $(MAKE) $(AM_MAKEFLAGS) install \ && $(MAKE) $(AM_MAKEFLAGS) installcheck \ && $(MAKE) $(AM_MAKEFLAGS) uninstall \ && $(MAKE) $(AM_MAKEFLAGS) distuninstallcheck_dir="$$dc_install_base" \ distuninstallcheck \ && chmod -R a-w "$$dc_install_base" \ && ({ \ (cd ../.. && umask 077 && mkdir "$$dc_destdir") \ && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" install \ && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" uninstall \ && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" \ distuninstallcheck_dir="$$dc_destdir" distuninstallcheck; \ } || { rm -rf "$$dc_destdir"; exit 1; }) \ && rm -rf "$$dc_destdir" \ && $(MAKE) $(AM_MAKEFLAGS) dist \ && rm -rf $(DIST_ARCHIVES) \ && $(MAKE) $(AM_MAKEFLAGS) distcleancheck \ && cd "$$am__cwd" \ || exit 1 $(am__post_remove_distdir) @(echo "$(distdir) archives ready for distribution: "; \ list='$(DIST_ARCHIVES)'; for i in $$list; do echo $$i; done) | \ sed -e 1h -e 1s/./=/g -e 1p -e 1x -e '$$p' -e '$$x' distuninstallcheck: @test -n '$(distuninstallcheck_dir)' || { \ echo 'ERROR: trying to run $@ with an empty' \ '$$(distuninstallcheck_dir)' >&2; \ exit 1; \ }; \ $(am__cd) '$(distuninstallcheck_dir)' || { \ echo 'ERROR: cannot chdir into $(distuninstallcheck_dir)' >&2; \ exit 1; \ }; \ test `$(am__distuninstallcheck_listfiles) | wc -l` -eq 0 \ || { echo "ERROR: files left after uninstall:" ; \ if test -n "$(DESTDIR)"; then \ echo " (check DESTDIR support)"; \ fi ; \ $(distuninstallcheck_listfiles) ; \ exit 1; } >&2 distcleancheck: distclean @if test '$(srcdir)' = . ; then \ echo "ERROR: distcleancheck can only run from a VPATH build" ; \ exit 1 ; \ fi @test `$(distcleancheck_listfiles) | wc -l` -eq 0 \ || { echo "ERROR: files left in build directory after distclean:" ; \ $(distcleancheck_listfiles) ; \ exit 1; } >&2 check-am: all-am $(MAKE) $(AM_MAKEFLAGS) check-TESTS check: check-am all-am: Makefile $(INFO_DEPS) $(SCRIPTS) $(DATA) installdirs: for dir in "$(DESTDIR)$(bindir)" "$(DESTDIR)$(infodir)" "$(DESTDIR)$(picklesdir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am install-exec: install-exec-am install-data: install-data-am uninstall: uninstall-am install-am: all-am @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am installcheck: installcheck-am install-strip: if test -z '$(STRIP)'; then \ $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ install; \ else \ $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ fi mostlyclean-generic: -test -z "$(TEST_LOGS)" || rm -f $(TEST_LOGS) -test -z "$(TEST_LOGS:.log=.trs)" || rm -f $(TEST_LOGS:.log=.trs) -test -z "$(TEST_SUITE_LOG)" || rm -f $(TEST_SUITE_LOG) clean-generic: distclean-generic: -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) maintainer-clean-generic: @echo "This command is intended for maintainers to use" @echo "it deletes files that may require special tools to rebuild." clean: clean-am clean-am: clean-aminfo clean-generic mostlyclean-am distclean: distclean-am -rm -f $(am__CONFIG_DISTCLEAN_FILES) -rm -f Makefile distclean-am: clean-am distclean-generic dvi: dvi-am dvi-am: $(DVIS) html: html-am html-am: $(HTMLS) info: info-am info-am: $(INFO_DEPS) install-data-am: install-dist_picklesDATA install-info-am install-dvi: install-dvi-am install-dvi-am: $(DVIS) @$(NORMAL_INSTALL) @list='$(DVIS)'; test -n "$(dvidir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(dvidir)'"; \ $(MKDIR_P) "$(DESTDIR)$(dvidir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(dvidir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(dvidir)" || exit $$?; \ done install-exec-am: install-dist_binSCRIPTS install-html: install-html-am install-html-am: $(HTMLS) @$(NORMAL_INSTALL) @list='$(HTMLS)'; list2=; test -n "$(htmldir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)'"; \ $(MKDIR_P) "$(DESTDIR)$(htmldir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p" || test -d "$$p"; then d=; else d="$(srcdir)/"; fi; \ $(am__strip_dir) \ d2=$$d$$p; \ if test -d "$$d2"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(htmldir)/$$f'"; \ $(MKDIR_P) "$(DESTDIR)$(htmldir)/$$f" || exit 1; \ echo " $(INSTALL_DATA) '$$d2'/* '$(DESTDIR)$(htmldir)/$$f'"; \ $(INSTALL_DATA) "$$d2"/* "$(DESTDIR)$(htmldir)/$$f" || exit $$?; \ else \ list2="$$list2 $$d2"; \ fi; \ done; \ test -z "$$list2" || { echo "$$list2" | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(htmldir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(htmldir)" || exit $$?; \ done; } install-info: install-info-am install-info-am: $(INFO_DEPS) @$(NORMAL_INSTALL) @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ list='$(INFO_DEPS)'; test -n "$(infodir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(infodir)'"; \ $(MKDIR_P) "$(DESTDIR)$(infodir)" || exit 1; \ fi; \ for file in $$list; do \ case $$file in \ $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ esac; \ if test -f $$file; then d=.; else d=$(srcdir); fi; \ file_i=`echo "$$file" | sed 's|\.info$$||;s|$$|.i|'`; \ for ifile in $$d/$$file $$d/$$file-[0-9] $$d/$$file-[0-9][0-9] \ $$d/$$file_i[0-9] $$d/$$file_i[0-9][0-9] ; do \ if test -f $$ifile; then \ echo "$$ifile"; \ else : ; fi; \ done; \ done | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(infodir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(infodir)" || exit $$?; done @$(POST_INSTALL) @if $(am__can_run_installinfo); then \ list='$(INFO_DEPS)'; test -n "$(infodir)" || list=; \ for file in $$list; do \ relfile=`echo "$$file" | sed 's|^.*/||'`; \ echo " install-info --info-dir='$(DESTDIR)$(infodir)' '$(DESTDIR)$(infodir)/$$relfile'";\ install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\ done; \ else : ; fi install-man: install-pdf: install-pdf-am install-pdf-am: $(PDFS) @$(NORMAL_INSTALL) @list='$(PDFS)'; test -n "$(pdfdir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(pdfdir)'"; \ $(MKDIR_P) "$(DESTDIR)$(pdfdir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(pdfdir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(pdfdir)" || exit $$?; done install-ps: install-ps-am install-ps-am: $(PSS) @$(NORMAL_INSTALL) @list='$(PSS)'; test -n "$(psdir)" || list=; \ if test -n "$$list"; then \ echo " $(MKDIR_P) '$(DESTDIR)$(psdir)'"; \ $(MKDIR_P) "$(DESTDIR)$(psdir)" || exit 1; \ fi; \ for p in $$list; do \ if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ echo "$$d$$p"; \ done | $(am__base_list) | \ while read files; do \ echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(psdir)'"; \ $(INSTALL_DATA) $$files "$(DESTDIR)$(psdir)" || exit $$?; done installcheck-am: maintainer-clean: maintainer-clean-am -rm -f $(am__CONFIG_DISTCLEAN_FILES) -rm -rf $(top_srcdir)/autom4te.cache -rm -f Makefile maintainer-clean-am: distclean-am maintainer-clean-aminfo \ maintainer-clean-generic maintainer-clean-vti mostlyclean: mostlyclean-am mostlyclean-am: mostlyclean-aminfo mostlyclean-generic mostlyclean-vti pdf: pdf-am pdf-am: $(PDFS) ps: ps-am ps-am: $(PSS) uninstall-am: uninstall-dist_binSCRIPTS uninstall-dist_picklesDATA \ uninstall-dvi-am uninstall-html-am uninstall-info-am \ uninstall-pdf-am uninstall-ps-am .MAKE: check-am install-am install-strip .PHONY: all all-am am--refresh check check-TESTS check-am clean \ clean-aminfo clean-generic cscopelist-am ctags-am dist \ dist-all dist-bzip2 dist-gzip dist-info dist-lzip dist-shar \ dist-tarZ dist-xz dist-zip dist-zstd distcheck distclean \ distclean-generic distcleancheck distdir distuninstallcheck \ dvi dvi-am html html-am info info-am install install-am \ install-data install-data-am install-dist_binSCRIPTS \ install-dist_picklesDATA install-dvi install-dvi-am \ install-exec install-exec-am install-html install-html-am \ install-info install-info-am install-man install-pdf \ install-pdf-am install-ps install-ps-am install-strip \ installcheck installcheck-am installdirs maintainer-clean \ maintainer-clean-aminfo maintainer-clean-generic \ maintainer-clean-vti mostlyclean mostlyclean-aminfo \ mostlyclean-generic mostlyclean-vti pdf pdf-am ps ps-am \ recheck tags-am uninstall uninstall-am \ uninstall-dist_binSCRIPTS uninstall-dist_picklesDATA \ uninstall-dvi-am uninstall-html-am uninstall-info-am \ uninstall-pdf-am uninstall-ps-am .PRECIOUS: Makefile # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: poke-elf-1.0/elf-mach-riscv.pk0000644000175000017500000000660414602057363013145 00000000000000/* elf-mach-riscv.pk - ELF RISCV specific definitions. */ /* Copyright (C) 2024 Jose E. Maorchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* RISCV file flags. */ var ELF_EF_RISCV_RVC = 0x0001U, ELF_EF_RISCV_FLOAT_ABI = 0x0006U, ELF_EF_RISCV_FLOAT_ABI_SOFT = 0x0000U, ELF_EF_RISCV_FLOAT_ABI_SINGLE = 0x0002U, ELF_EF_RISCV_FLOAT_ABI_DOUBLE = 0x0004U, ELF_EF_RISCV_FLOAT_ABI_QUAD = 0x0006U, ELF_EF_RISCV_RVE = 0x0008U; elf_config.add_mask :machine ELF_EM_RISCV :class "file-flags" :entries [Elf_Config_Mask { value = ELF_EF_RISCV_RVC, name = "rvc", doc = "File may contain compressed instructions." }, Elf_Config_Mask { value = ELF_EF_RISCV_FLOAT_ABI_SOFT, name = "float-abi-soft", doc = "File uses the soft-float ABI." }, Elf_Config_Mask { value = ELF_EF_RISCV_FLOAT_ABI_SINGLE, name = "float-abi-single", doc = "File uses the single-float ABI." }, Elf_Config_Mask { value = ELF_EF_RISCV_FLOAT_ABI_DOUBLE, name = "float-abi-double", doc = "File uses the double-float ABI." }, Elf_Config_Mask { value = ELF_EF_RISCV_FLOAT_ABI_QUAD, name = "float-abi-quad", doc = "File uses the quad-float ABI." }, Elf_Config_Mask { value = ELF_EF_RISCV_RVE, name = "rve", doc = "File uses the 32E base integer instruction." }]; /* RISCV dynamic tags. */ var ELF_DT_RISCV_VARIANT_CC = ELF_DT_LOPROC + 1; elf_config.add_enum :machine ELF_EM_RISCV :class "dynamic-tag-types" :entries [Elf_Config_UInt { value = ELF_DT_RISCV_VARIANT_CC, name = "variant-cc" }]; /* RISCV section types. */ var ELF_SHT_RISCV_ATTRIBUTES = 0x7000_0003U; elf_config.add_enum :machine ELF_EM_RISCV :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_RISCV_ATTRIBUTES, name = "attributes", doc = "Section holds attributes" }]; /* RISCV segment types. */ var ELF_PT_RISCV_ATTRIBUTES = 0x7000_0003U; elf_config.add_enum :machine ELF_EM_RISCV :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_RISCV_ATTRIBUTES, name = "attributes", doc = "Segment holds attributes." }]; /* RISCV st_other values. */ var ELF_STO_RISCV_VARIANT_CC = 0x80; elf_config.add_enum :machine ELF_EM_RISCV :class "section-other" :entries [Elf_Config_UInt { value = ELF_STO_RISCV_VARIANT_CC, name = "variant-cc" }]; poke-elf-1.0/poke-elf.texi0000644000175000017500000015645614602057414012416 00000000000000\input texinfo @comment %**start of header @setfilename poke-elf.info @include version.texi @settitle ELF pickles for GNU poke @afourpaper @defcodeindex pv @comment %**end of header @copying Copyright @copyright{} 2024 Jose E. Marchesi. @quotation You can redistribute it and/or modify this manual under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @end quotation @end copying @dircategory GNU poke @direntry * poke-elf: (poke-elf). ELF pickles for GNU poke. @end direntry @titlepage @title ELF pickles for GNU poke @author by Jose E. Marchesi @page @vskip 0pt plus 1filll @insertcopying @end titlepage @contents @ifnottex @node Top @top Editing ELF files with GNU poke @insertcopying @end ifnottex GNU poke is an interactive, extensible editor for binary data. Not limited to editing basic entities such as bits and bytes, it provides a full-fledged procedural, interactive programming language designed to describe data structures and to operate on them. This manual explains how to use the ELF pickles distributed at @url{https://jemarch.net/poke-elf}. @menu Getting Started * Introduction:: How to use this manual. * Installation:: Installing the poke-elf pickles. * Pickles Overview:: Know your pickles. Poking at ELF * ELF Configurations:: The ELF Configuration Registry. * ELF Basic Types:: Simple types. * ELF File:: 32-bit and 64-bit ELF files. * ELF Header:: The ELF file header. * ELF Section Headers:: Entry in the ELF section header table. * ELF Program Headers:: Entry in the ELF program header table. @c * ELF Sections:: ELF sections and their contents. @c * ELF Segments:: ELF segments and their contents. * ELF Symbols:: Symbols and their attributes. * ELF Notes:: Auxiliary information. * ELF Relocations:: REL and RELA relocations. * ELF Dynamic Info:: Stored information for dynamic linking. * ELF Machines:: ELF machine specific data structures. * ELF OSes:: ELF OS specific data structures. Extending and Hacking @c * Adding a new ELF machine @c * Adding a new ELF operating system Appendices * Indices:: List of indices in this document. @end menu @node Introduction @chapter Introduction This manual documents the pickles shipped in the poke-elf package. It not only describes the data structures implemented in these pickles, but also shows examples of techniques to how to make best use of them. @section Who is this manual for? This manual assumes that the reader is familiar with both the @command{poke} program and the Poke programming language. @section Approach used to describe Poke data structures When describing Poke types (such as for example @code{Elf64_Chdr}) this manual takes the approach of first showing a simplified or stripped-out version of the type, like this: @example type Elf64_Chdr = struct @{ Elf_Word ch_type; Elf_Word ch_reserved; offset ch_size; offset ch_addralign; @}; @end example @noindent Generally speaking, these stripped versions of the type do not contain comments, constraints, variables, functions nor methods. However, there are exceptions to this rule in the particular cases where we want to draw your attention to some particular aspect involving some constraint, method, etc. Following the simplified version of the type, its fields get discussed in detail. Then, the overall data structure gets discussed, and examples on how to use it to poke at data are shown. Finally, the methods offered by the type, if any, are described in detail along with usage examples. @node Installation @chapter Installation Welcome! This section should get you up and running to enjoy poking at nasty ELF data in no time. @section Build Requirements These are the build requirements if you are building from a distribution source tarball: @itemize @minus @item A recent enough version of GNU poke is necessary in order to run the test suite of this package. This is checked at configure time. If no suitable poke is found, the test suite is not run. @end itemize @section Fetching and unpacking poke-elf The first step to install @code{poke-elf} is to fetch a copy of it. Like all GNU poke pickles, @code{poke-elf} releases are distributed as source tarballs: @example $ wget https://ftp.gnu.org/gnu/poke/poke-elf-@var{version}.tar.gz @end example @noindent Where @var{version} is the version you want to install. Next step is to untar the tarball. It will expand to a @file{poke-elf-@var{version}} directory: @example $ tar xvf poke-elf-@var{version}.tar.gz $ cd poke-elf-@var{version}/ @end example @section Configuring the sources @noindent It is time now to configure the sources. You do that by invoking the @code{configure} script that is in the root directory of the distribution. @example $ ./configure @end example @noindent By default the @code{configure} script will configure the source in order to be installed under @file{/usr/local}, which is a system location. If you want to install the pickles in some other location, you can pass a @option{--prefix} command line option to the script. For example: @example $ ./configure --prefix=$HOME/.poke.d @end example @noindent Now that the sources are configured, it is time to build them and check the distribution. @section Building and checking @example $ make $ make check @end example @noindent There should be no errors. If any of the tests fail, please re-run @command{make check} but this time enabling verbose output: @example $ make check VERBOSE=1 @end example @noindent And file a bug report at @url{https://sourceware.org/bugilla} including both the contents of your @file{config.log} file and the output you get on the terminal when you run @command{make check}. Please file the bug report for product ``poke'' and component ``elf-pickle''. @noindent Note that the testsuite will only be executed if a recent enough @command{poke} was found during configure. @section Installing @noindent The last step is to install the pickles in your system: @example $ make install @end example @cindex @code{POKE_LOAD_PATH} @noindent Note that the installed poke will find the installed pickles only if these are installed under the same prefix than poke. If you install the pickles in some other location (like under @file{~/.poke.d} for example, you will have to set the environment variable @code{POKE_LOAD_PATH}. Just put something like this in your @file{.bashrc} or similar file: @example export POKE_LOAD_PATH=$HOME/.poke.d @end example @noindent And that's it! Now run poke, load the pickles and enjoy! @example $ poke /bin/ls (poke) load elf (poke) var elf = Elf64_File @@ 0#B ... @end example @node Pickles Overview @chapter Pickles Overview @cindex overview, pickles This chapter provides an high-level overview of all the pickles distributed by this package. These are all developed in subsequent chapters. @table @file @item elf.pk This is the main ELF pickle, and the one that is intended to be loaded by the user. It does little more than loading the rest of the @file{elf-*} pickles, but it does it in the right order! @item elf-build.pk This pickle contains information generating during building the @code{poke-elf} package. In particular, the version. @item elf-config.pk This pickle implements the @dfn{ELF configuration registry}, which is used by the ELF pickles in order to maintain a database of the very varied set of different configuration parameters supported by the ELF specification: machine types, section types, segment types, file flags, @i{etc}. @xref{ELF Configurations}. @item elf-common.pk This pickle contains definitions which are common to both 32-bit and 64-bit ELF. It also registers configuration parameters that are common to all machine types. @item elf-os-@var{os}.pk These pickles contain definitions and configuration parameters for the different operating systems supported in the ELF specification. For example, @file{elf-os-gnu.pk} covers the GNU extensions documented in the GNU gabi extensions @footnote{@url{https://sourceware.org/gnu-gabi}}. @item elf-mach-aarch64.pk @itemx elf-mach-arm.pk @itemx elf-mach-bpf.pk @itemx elf-mach-mips.pk @itemx elf-mach-riscv.pk @itemx elf-mach-sparc.pk @itemx elf-mach-x86-64.pk These pickles contain definitions and configuration parameters for the different @dfn{machine types} supported in the ELF specification. @item elf-32.pk This pickle contains definitions for 32-bit ELF files. Among these is the definition of the @code{Elf32_File} type, which corresponds to an entire ELF-32 file. @item elf-64.pk This pickle contains definitions for 64-bit ELF files. Among these is the definition of the @code{Elf64_File} type, which corresponds to an entire ELF-64 file. @end table @node ELF Configurations @chapter ELF Configurations @section ELF Configuration Parameters The ELF object format specification, unlike most (all?) its predecessors, was designed with the goal of being extremely flexible and extensible, in order to cover the needs of any conceivable hardware architecture and operating system. In order to achieve this goal, many of the entities that appear in ELF files, such as sections, symbols, or segments, are pretty generic and configurable. For example, consider the following (simplified) definition of an ELF64 relocation: @example type Elf64_RelInfo = struct @{ uint<32> r_sym; uint<32> r_type; @}; @end example @noindent Where @code{r_type} contains a code identifying the type of the relocation. The ELF specification itself doesn't say what values may go in @code{r_type}; it is the different supplements for particular architectures (or @dfn{machines} in ELF parlance) that list the relocation types used in their machines. Relocation types, understood as the set of valid codes to be set in a @code{r_type} field, is just one example of what in poke-elf we call an ELF @dfn{configuration parameter}. There are many other configuration parameters: section flags, section types, symbol types, and a large @i{etc}. They are often dependent of particular machines and OSes, and there can be @emph{many} of them: there are often literally hundreds of different relocation types defined by some particular architecture. @section The ELF Configuration Registry As the different ELF pickles get loaded, they populate a registry of configuration parameters. This registry is a value of the struct type @code{Elf_Config} that is defined in @file{elf-config.pk}, and is stored in the global variable @code{elf_config}. @noindent There are two kinds of configuration parameters: @dfn{enumerations} and @dfn{masks}. The registry contains several collections of them: @itemize @minus @item One set of common enumerations. @item One set of common masks. @item One set of enumerations per machine type. @item One set of masks per machine type. @end itemize @section Enumeration configuration parameters Enumeration configuration parameters, or @dfn{enums} for short, are sets of numbers or codes. Each entry in an enum represents an alternative value for some parameter. New enum entries are constructed using the @code{Elf_Config_UInt} struct type: @example type Elf_Config_UInt = struct @{ uint<32> value; string name; string doc; @}; @end example @noindent Where @code{name} is a short and descriptive name for the parameter value and @code{doc} is an English statement describing the meaning of this particular @var{value}. For example, this is how the definition of a X86_64 relocation type looks like: @example Elf_Config_UInt @{ value = ELF_R_X86_64_PC32, name = "pc32", doc = "PC relative 32 bit signed." @} @end example Adding new enum configuration parameters to the registry is done by using the @code{add_enum} method of @code{Elf_Config}: @example method add_enum = (int<32> machine = -1, string class = "", Elf_Config_UInt[] entries = Elf_Config_UInt[]()) void: @end example @noindent Where @code{machine} is either -1 or an ELF machine code (likely one of the @code{ELF_EM_*} values defined in @file{elf-common.pk}). If the former, the new parameter is added to the set of common enums. Otherwise it is added to the set of enums defined for the specified machine type. Finally, @code{entries} is an array of the different values this parameter may adopt. The @code{class} argument is a string that gives a name to the new configuration parameter. These have names like @code{reloc-types} or @code{file-classes}. Our ELF pickles use a definite set of names, documented below, but nothing prevents you to use your own. This is how we would add a couple of common relocation types to the register (note the actual ELF specification has none of these, they are all machine-specific): @example elf_config.add_enum :class "reloc-types" :entries [Elf_Config_UInt @{ value = 0, name = "null reloc" @}, Elf_Config_UInt @{ value = 1, name = "PC-relative 16-bit displacement." @}]; @end example @noindent And this is how we would add relocation types for the X86_64 architecture: @example elf_config.add_enum :class "relocation_types" :entries [Elf_Config_UInt @{ value = ELF_R_X86_64_PC32, name = "pc32", doc = "PC relative 32 bit signed." @}, Elf_Config_UInt @{ value = ELF_R_X86_64_GOT32, name = "got32", doc = "32 bit GOT entry." @}, ...]; @end example @section Mask configuration parameters Mask configuration parameters are sets of bit-masks. Each entry is an unsigned number determining some valid configuration of bits for the value of some parameter. New mask entries are constructed using the @code{Elf_Config_Mask} type: @example type Elf_Config_Mask = struct @{ uint<64> value; string name; string doc; @}; @end example @noindent Where @code{name} is a short an descriptive name summarizing the quality of the bit of bits set in @code{value}, and @code{doc} is an English statement describing the meaning of these particular bits. For example, this is how the definition of an ARM section flag looks like: @example Elf_Config_Mask @{ value = ELF_SHF_ARM_PURECODE, name = "purecode", doc = "Section contains only code and no data." @} @end example Adding new mask configuration parameters to the registry is done by using the @code{add_mask} method of @code{Elf_Config}: @example method add_mask = (int<32> machine = -1, string class = "", Elf_Config_Mask[] entries = Elf_Config_Mask[]()) void: @end example @noindent Where @code{machine} is either -1 or an ELF machine code. If the former, the new mask is added to the set of common masks. Otherwise it is added to the set of masks defined for the specified machine type. Finally, @code{entries} is an array of the different sub-masks this parameter may adopt. As with enums, the @code{class} argument is a string that gives a name to the new configuration parameter. Masks have names like @code{"section-flags"} or @code{"segment-flags"}. @noindent This is how we would register a couple of common section flags: @example elf_config.add_mask :class "section-flags" :entries [Elf_Config_Mask @{ value = ELF_SHF_WRITE, name = "write" @}, Elf_Config_Mask @{ value = ELF_SHF_ALLOC, name = "alloc" @}]; @end example And this is how we would register section flags for the ARM architecture: @example elf_config.add_mask :machine ELF_EM_ARM :class "section-flags" :entries [Elf_Config_Mask @{ value = ELF_SHF_ARM_ENTRYSECT, name = "entrysect", doc = "Section contains an entry point." @}, Elf_Config_Mask @{ value = ELF_SHF_ARM_PURECODE, name = "purecode", doc = "Section contains only code and no data." @}, ...]; @end example @section Configuration parameters used by this pickle As we have mentioned, it is possible to register new configuration parameters in the registry, with arbitrary names. This is certainly useful to the happy poker that is working on some weird ELF extension, or simply playing around. However, the set of @file{elf-*pk} pickles are designed to work with a closed set of configuration parameters. Having extra parameters in the registry is perfectly ok, but if you mess with the parameters below, you are gonna have to face the consequences :) Note however that adding support for a new machine type or a new operating system shouldn't require extending the set of configuration parameters: just to add new values to them. @noindent The enum configuration parameters used by this pickle are: @table @code @item elf-machines Valid values in @code{e_machine} fields. @item file-osabis Valid values in @code{ei_osabi} fields. @item file-encodings Valid values in ei_data fields. @item file-classes Valid values in ei_class fields. @item file-types Valid values in e_type fields. @item section-types Valid values in sh_type fields. @item section-indices Indices in the file section header table with special meanings. @item section-other Valid values in sh_other fields. @item segment-types Valid values in p_type fields. @item reloc-types Valid values in r_type fields. @item dynamic-tag-types Valid values in d_tag fields. @item symbol-types Valid values in st_type fields. @item symbol-bindings Valid values in st_bind fields. @item symbol-visibilities Valid values in st_visibility fields. @item note-tags Valid tags for notes stored in notes sections. @item gnu-properties Valid values for @code{pr_type} fields in GNU properties. @end table @noindent The mask configuration parameters used by this pickle are: @table @code @item file-flags Valid bits in e_flags fields. @item section-flags Valid bits in sh_flags fields. @item segment-flags Valid bits in p_flags fields. @end table @noindent The architecture-specific enum configuration parameters used by this pickle are: @table @code @item mips-abis Valid values in the @code{ELF_EF_MIPS_ABI} bits of @code{e_flags} in MIPS machines. @item mips-machines Valid values in the @code{ELF_EF_MIPS_MACH} bits of @code{e_flags} in MIPS machines. @item mips-architectures Valid values in the @code{ELF_EF_MIPS_ARCH} bits of @code{eflags} in MIPS machines. @end table @noindent The architecture-specific mask configuration parameters used by this pickle are: @table @code @item mips-l-flags Valid bits in @code{l_flags} fields. @end table @section Getting printed representations of configuration parameters The @code{format_enum} and @code{format_mask} methods of @code{Elf_Config} return the user-friendly printed representation of the given alternative value or bitmap. They have the following prototypes: @example method format_enum = (string class, uint<16> machine, uint<32> value) string: method format_mask = (string class, uint<16> machine, uint<64> value) string: @end example The printed representation of an enum is simply the @code{name} that was provided when registering it. For example: @example (poke) elf_config.format_enum ("reloc-types", ELF_EM_X86_64, 2) "pc32" @end example The printed representation of a mask is a sequence of the names given to the different bitmaps at registration time, separated by comma (@code{,}) characters. For example: @example (poke) elf_config.format_mask ("section-flags", ELF_EM_X86_64, 0xf00) "os-nonconforming,group,tls,compressed" @end example @section Checking valid configuration parameters The @code{check_enum} and @code{check_mask} methods of @code{Elf_Config} check whether the given values are valid for some particular configuration parameter. They have the following prototypes: @example method check_enum = (string class, uint<16> machine, uint<32> value) int<32>: method check_mask = (string class, uint<16> machine, uint<64> value) int<32>: @end example @noindent Where @code{machine} specifies the machine type and @code{class} the name of the configuration parameter. They determe wether @code{value} is a valid @code{class}. For example, this is how we would check whether 57 identifies a valid relocation type in RISCV: @example (poke) elf_config.check_enum ("reloc-types", ELF_EM_RISCV, 57) 0 @end example Turns out it doesn't! :D @section Using configuration parameters in types The formatting and checking methods described above are mainly used in the ELF pickles in order to implement pretty-printers and data integrity constraints in the several ELF structures holding such values. @noindent For example: @example type Elf64_Shdr = struct @{ Elf_Word sh_type : elf_config.check_enum ("section-types", elf_mach, sh_type); Elf64_Xword sh_flags : elf_config.check_mask ("section-flags", elf_mach, sh_flags); [...] method _print_sh_type = void: @{ printf "#<%s>", elf_config.format_enum ("section-types", elf_mach, sh_type); @} method _print_sh_flags = void: @{ printf "#<%s>", elf_config.format_mask ("section-flags", elf_mach, sh_flags); @} @}; @end example However, they are also very useful to the user while poking at existing data (``if these bytes were to be interpreted as ELF section flags in some given arch, which ones they would be?''), composing new data and also when generating reports and statistics. @section Debugging the registry If you want to get a trace of the configuration parameters as they are being added to the registry, simply set the @code{elf_config_debug} variable to a non zero value and reload the ELF pickles: @example (poke) elf_config_debug = 1 (poke) load elf @end example @node ELF Basic Types @chapter ELF Basic Types The encoding of the simple fields in the ELF data structures is abstracted in the following Poke types. @noindent Types used in both 32-bit and 64-bit ELF: @table @code @item type Elf_Half = uint<16> An ELF @dfn{unsigned medium integer}. @item type Elf_Word = uint<32> An ELF @dfn{unsigned integer}. @item type Elf_Sword = int<32> An ELF @dfn{signed integer}. @end table @noindent Types used in 32-bit ELF only: @table @code @item type Elf32_Addr = offset,B> An ELF @dfn{unsigned program address}. @item type Elf32_Off = offset,B> An ELF @dfn{unsigned file offset}. @end table @noindent Types used in 64-bit ELF only: @table @code @item type Elf64_Xword = uint<64> An ELF @dfn{unsigned long integer}. @item type Elf64_Sxword = int<64> An ELF @dfn{signed long integer}. @item type Elf64_Addr = offset,B> An ELF @dfn{unsigned program address}. @item type Elf64_Off = offset,uint<64>,B> And ELF @dfn{unsigned file offset}. @end table @node ELF File @chapter ELF File @cindex @code{Elf32_File} @cindex @code{Elf64_File} The Poke types provided to denote ELF64 and ELF32 files are @code{Elf64_File} and @code{Elf32_File} respectively. @section Overview @example type Elf32_File = struct @{ Elf32_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf32_Shdr[ehdr.e_shnum] shdr @ ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf32_Phdr[ehdr.e_phnum] phdr @ ehdr.e_phoff; @}; @end example @example type Elf64_File = struct @{ Elf64_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf64_Shdr[ehdr.e_shnum] shdr @ ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf64_Phdr[ehdr.e_phnum] phdr @ ehdr.e_phoff; @}; @end example @section Fields @table @code @item ehdr Is the header of the ELF file, of type @code{Elf64_File}. This always exists and is always located at the beginning of the ELF file. @item shdr Is the optional section header table of the ELF file. This is an optional field that is an array of @code{Elf64_Shdr} (or @code{Elf32_Shdr}) values, describing the ELF sections present in the file. This table, if it exists, can be located anywhere in the ELF file. The ELF header determines the size and location of the table. @item phdr Is the optional program section header table of the ELF file. This is an optional field that is an array of @code{Elf64_Phdr} (or @code{Elf32_Phdr}) describing ELF segments present in the file. This table, if it exists, can be located anywhere in the ELF file. The ELF header determines the size and location of the table. @end table @section Methods @subsection Methods related to sections @table @code @item File_Elf64.section_name_p = (string @var{name}) int<32> @itemx File_Elf32.section_name_p = (string @var{name}) int<32> Given a section @var{name}, return whether a section with that name exists in the ELF file. @item File_Elf64.get_sections_by_name = (string @var{name}) Elf64_Shdr[] @itemx File_Elf32.get_sections_by_name = (string @var{name}) Elf32_Shdr[] Given the @var{name} of a section, return an array of section headers in the ELF file having that name. The returned array may of course be empty. For example, this is how you can get an array of all the sections in the file with name @code{.text}: @example (poke) elf.get_sections_by_name (".text") [Elf64_Shdr @{ sh_name=141U#B, sh_type=#, sh_flags=#, sh_addr=18144UL#B, sh_offset=18144UL#B, sh_size=80574UL#B, sh_link=0U, sh_info=0U, sh_addralign=16UL, sh_entsize=0UL#B @}] @end example @item File_Elf64.get_sections_by_type = (Elf_Word @var{stype}) Elf64_Shdr[] @itemx File_Elf32.get_sections_by_type = (Elf_Word @var{stype}) Elf32_Shdr[] Given a section type (one of the @code{ELF_SHT_*} value) return an array of section headers in the ELF file with that type. The returned array may be empty. @end table @subsection Methods related to string tables @table @code @item Elf64_File.get_section_name = (offset @var{offset}) string @itemx Elf32_File.get_section_name = (offset @var{offset}) string Given an offset into the ELF file's section string table, return the string starting at that @var{offset}. This uses one particular string table that is linked from the ELF header via the @code{e_shstrndx} field. For example, this is how we would print the name of the second section in an ELF file@footnote{The first section in an ELF file is the ``null'' section and has an empty name.}: @example (poke) elf.get_section_name (elf.shdr[1].sh_name) ".interp" @end example @item Elf64_File.get_symbol_name = (Elf64_Shdr @var{symtab}, offset @var{offset}) string @itemx Elf64_File.get_symbol_name = (Elf32_Shdr @var{symtab}, offset @var{offset}) string Given the section header of a section that contains a symbol table @var{symtab}, and an @var{offset}, return the corresponding string stored at the symbol table associated string table. @item Elf64_File.get_string = (offset offset) string @itemx Elf32_File.get_string = (offset offset) string Given an @var{offset}, return the string stored at that offset in the ``default'' string table of the ELF file. The default string table is contained in a section named @code{.strtab}. If such a section doesn't exist, or if it exists but it doesn't contain a string table, then this function raises @code{E_inval}. @end table @subsection Methods related to section groups @table @code @item Elf64_File.get_group_signature = (Elf64_Shdr @var{section}) string @itemx Elf32_File.get_group_signature = (Elf32_Shdr @var{section}) string Return the signature corresponding to a given group @var{section}, characterized by its entry in the section header table. If the given section header doesn't correspond to a group section then raise @code{E_inval}. @item Elf64_File.get_group_signatures = string[] @itemx Elf32_File.get_group_signatures = string[] Return an array of strings with the signatures of the section groups present in this ELF file. @item Elf64_File.get_section_group = (string @var{name}) Elf64_Shdr[] @itemx Elf32_File.get_section_group = (string @var{name}) Elf32_Shdr[] Given the @var{name} of a section group, return an array with the section headers corresponding to all the sections in that group. If the given name doesn't identify a section group in the ELF file then return an empty array. @end table @subsection Methods related to loaded contents @table @code @item Elf64_File.get_load_base = Elf64_Addr Determine the base where the contents of the ELF file are loaded, understood as the lower virtual address where segments get loaded. If there are no loadable segments in the ELF file then this method raises @code{E_inval}. @item Elf64_File.vaddr_to_sec = (Elf64_Addr @var{vaddr}) Elf64_Addr Given a virtual address, return the index in the section header table of the section whose loaded contents cover the given address. If no such section is found this method returns -1. Consider for example a relocation which points to some content that is stored in some section in a loadable ELF file. The corresponding @code{r_offset} field in the relocation will not contain a file offset, but a loaded address. This method can be then used to determine the section the relocation is applied to. @item Elf64_File.vaddr_to_file_offset = (Elf64_Addr @var{vaddr}) Elf64_Addr If some of the contents of the file sections are to be loaded in @var{vaddr}, this method returns the file offset to these contents. @end table @section Usage @noindent Poking at an ELF file usually starts by opening some IO space and mapping a @code{Elf64_File} (or @code{Elf32_File}): @example (poke) .file /bin/ls (poke) var elf = Elf64_File @@ 0#B @end example @noindent Once mapped, we can access any of the above fields. For example, let's see how many sections and segments this file has: @example (poke) elf.shdr'length 30UL (poke) elf.phdr'length 11UL @end example @noindent In case the file didn't have a program header table, which always happens with object files, we would have got an exception if we tried to access the absent field @code{phdr}: @example $ echo '' | gcc -c -xc -o foo.o - $ poke foo.o (poke) load elf (poke) (Elf64_File @@ 0#B).phdr unhandled invalid element exception @end example @subsection Working with sections Unlike in older object formats (like a.out for example) the sections present in ELF files are not fixed nor they have fixed pre-defined names: there can be any number of them (including none) and they can have any arbitrary name. Also, more than one section in the file can have the same name. So when it comes to ELF files, the process to determine whether one or more section with a given name exists in the file is a bit laborious: one has to traverse the section header table, fetch the section names from whatever appropriate string table, etc. The following methods, that you can use in your own pickles, scripts, or at the prompt, are handy to look at particular sections in the file. @subsection Working with string tables The names of several entities in ELF files are stored in different string table, which are themselves stored in different sections. There are different rules establishing where exactly the name of certain entities (sections, symbols, ...) are to be found. These rules are not trivial and require traversing several data structures. Therefore the @code{Elf64_File} (and @code{File32_File}) type provides several methods in order to easily determine the name of these entities. @subsection Working with section groups ELF supports grouping several sections in a @dfn{section group}. This is useful when several sections have to go together, because they rely on each other somehow. A section of type @code{SHT_GROUP} defines a section group. Groups are univocally identified by a @dfn{group signature}, which is the name associated with a symbol that is stored in a particular symbol table, linked from the section header of the group defining section. Again, it is not exactly trivial to determine, for example, which of the sections in the ELF file pertain to which group. Therefore the pickle provides the methods below: @node ELF Header @chapter ELF Header @cindex @code{Elf32_Ehdr} @cindex @code{Elf64_Ehdr} The ELF headers are always to be found at the beginning of an ELF file. However, it is also common to find ELF data embedded in other container formats (such as an ELF section!) and sometimes ELF headers are used to describe non-conformance ELF contents. Therefore poking at headers directly is not that uncommon. The Poke types provided to denote ELF headers are @code{Elf64_Ehdr} and @code{Elf32_Ehdr}, for 64-bit and 32-bit ELF files respectively. @section Overview @example type Elf32_Ehdr = struct @{ Elf_Ident e_ident; Elf_Half e_type; Elf_Half e_machine; Elf_Word e_version = ELF_EV_CURRENT; Elf32_Addr e_entry; Elf32_Off e_phoff; Elf32_Off e_shoff; Elf_Word e_flags; offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx; @}; @end example @example type Elf64_Ehdr = struct @{ Elf_Ident e_ident; Elf_Half e_type; Elf_Half e_machine; Elf_Word e_version = ELF_EV_CURRENT; Elf64_Addr e_entry; Elf64_Off e_phoff; Elf64_Off e_shoff; Elf_Word e_flags; offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx; @}; @end example @section Fields @table @code @item e_ident Is a field that describes the encoding of the contents that follow in the ELF file. The data in this field is encoded in a clever way that only requires to read the information byte by byte. This is necessary, because part of the information stored in @code{e_ident} is precisely the encoding used by the data in the ELF file: @example type Elf_Ident = struct @{ byte[4] ei_mag == [0x7fUB, 'E', 'L', 'F']; byte ei_class; byte ei_data; byte ei_version; byte ei_osabi; byte ei_abiversion; byte[7] ei_pad; @}; @end example @noindent Where: @table @code @item ei_mag Is the magic number identifying the ELF file. It is always 0x7F. @item ei_class Determines the class of the ELF file. This can be one of @code{ELF_CLASS_NONE}, @code{ELF_CLASS_32} or @code{ELF_CLASS_64} denoting and ``invalid class'', a 32-bit ELF file and a 64-bit ELF file respectively. I personally have never come across an ELF file with @code{ELF_CLASS_NONE}. But if such class is found, it shall be considered as a data integrity error. That is the approach implemented in this pickle. @item ei_data Determines the encoding of the data in the file. This can be one of @code{ELF_DATA_NONE}, @code{ELF_DATA_2LSB} or @code{ELF_DATA_2MSB}, denoting no encoding, 2's complement and little endian, and 2's complement and big endian. Note that at this point the only supported encoding for signed numbers in ELF files is 2's complement. This pickle considers an ELF file with encoding @code{ELF_DATA_NONE} as a data integrity error. @item ei_version Is the ELF header version number. This must be @code{ELF_EV_CURRENT}. @item ei_osabi Identifies the ABI or operating system (these concepts are mixed in ELF) used by the ELF file. This must be one of the @code{ELF_OSABI_*} values defined in @file{elf-common.pk}. The ELF specification recommends this field to be @code{ELF_OSABI_NONE}, which actually identifies the ``UNIX System V ABI''. @item ei_abiversion Identifies the version of the ABI to which the ELF file is targeted. The ELF spec points out that the purpose of this field is to distinguish among incompatible versions of an ABI, and that its interpretation ultimately depends on the value of @code{ei_osabi}. @item ei_pad Are unused bytes. These bytes may be used for some particular purpose in future versions of the ELF specification, and currently they must be set to zero. @end table @item e_type Identifies the kind of ELF file: whether it is an object file, an executable, a dynamic object or a core dump. This field is checked against the @code{file-types} configuration parameter, and pretty-printed accordingly. @item e_machine Identifies the machine type on which the elf file is supposed to run. When poke maps or constructs a @code{Elf64_Ehdr} (or @code{Elf32_Edhr}) struct, it sets the global ELF machine to the value of this field. This field is checked against the @code{machine-types} configuration parameter, and pretty-printed accordingly. @item e_version Identifies the ELF version the ELF file conforms to. It must hold @code{ELF_EV_CURRENT}. @item e_entry Is the virtual memory address of the entry point of a process executing the program in this ELF file. This can be @code{0#B}. @item e_phoff Is the file offset of the program header table. If the ELF file doesn't contain any segment, then the table is empty and this field contains @code{0#B}. @item e_shoff Is the file offset of the section header table. If the ELF file doesn't contain any section, then the table is empty and this field contains @code{0#B}. @item e_flags Is a bitmap of file flags. This field contains ORed @code{ELF_EF_*} values. This field is checked against the @code{filed-flags} configuration parameter, and pretty-printed accordingly. @item e_ehsize Is the size in bytes of the ELF header. @item e_phentsize Is the size in bytes of one entry in the program header table. @item e_phnum Is the number of entries in the program header table. @item e_shentsize Is the size in bytes of one entry in the section header table. @item e_shnum Is the number of entries in the section header table. @item e_shstrndx Is the index in the section header table of the entry associated with the string table that contains the names of the sections stored in the file. If the ELF file doesn't contain a section name string table (which is uncommon but certainly possible) then this field contains @code{ELF_SHN_UNDEF}. @end table @section Usage XXX @node ELF Section Headers @chapter ELF Section Headers @cindex @code{Elf64_Shdr} @cindex @code{Elf32_Shdr} Sections can be stored anywhere in an ELF file. They can also be of any size, of any type, have any name (or no name) and their contents are free. The ELF file therefore contains a table, called the @dfn{section header table}, whose entries describe each section. This table is sized and linked from the ELF header via the @code{e_shoff} field. As we have seen, the section header table is available in the @code{shdr} field of @code{Elf32_File} and @code{Elf64_File}. The Poke types denoting entries in the section header table are @code{Elf32_Shdr} and @code{Elf64_Shdr} for ELF32 and ELF64 respectively. @section Overview @example type Elf32_Shdr = struct @{ offset sh_name; Elf_Word sh_type; Elf_Word sh_flags; Elf32_Addr sh_addr; Elf32_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf_Word sh_addralign; offset sh_entsize; @}; @end example @example type Elf64_Shdr = struct @{ offset sh_name; Elf_Word sh_type; Elf64_Xword sh_flags; Elf64_Addr sh_addr; Elf64_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf64_Xword sh_addralign; offset sh_entsize; @}; @end example @section Fields @table @code @item sh_name Is the offset to the name of this section in the file's section string table. Two or more sections can share the same name. @item sh_type Is a code identifying the type of the section. This is one of the @code{ELF_SHT_*} values. The type of a section determines what kind of contents (if any) a section has: relocations, a symbol table, a string table, executable compiled code, etc. These are the types defined in the base spec: @table @code @item ELF_SHT_NULL This marks ``unused'' entry in the section header table. The first entry in the table seems to always be an unused entry. Unused entries have empty names. @item ELF_SHT_PROGBITS Section is what the spec calls ``program specific (private) data.'' In practice, this basically means executable code. The prototypical progbits section is @code{.text}. @item ELF_SHT_SYMTAB Section contains a symbol table. Each symbol table is an array of @code{ELF64_Sym} (@code{Elf32_Sym} in ELF32) values spanning for @code{sh_size} bytes. @xref{ELF Symbols}. @item ELF_SHT_STRTAB Section contains a string table. Each string table is an array of NULL terminated strings spanning for @code{sh_size} bytes. @item ELF_SHT_RELA @itemx ELF_SHT_REL Section contains ELF relocations, with or without explicit addend. Each section contains an array of @code{Elf64_Rela} or @code{Elf64_Rel} (@code{Elf32_Rela} or @code{Elf32_Rel} in ELF32) values spanning for @code{sh_size} bytes. @xref{ELF Relocations}. @item ELF_SHT_HASH Section contains a symbol hash table. @item ELF_SHT_DYNAMIC Section contains dynamic linking information in the form of a sequence of @dfn{dynamic tags}. This is an array of @code{Elf64_Dyn} (@code{Elf32_Dyn} in ELF32) values spanning for @code{sh_size} bytes. @xref{ELF Dynamic Info}. @item ELF_SHT_NOTE Section contains @dfn{notes}. These are flexible annotations that are usually used in order to reflect certain ``auxiliary'' attributes of the ELF file. For example, the name and full version of the compiler that generated it. The format in which the notes are encoded is well defined, and supported by the elf pickles. @xref{ELF Notes}. @item ELF_SHT_SHLIB This value for @code{sh_type} is reserved by the ELF specification and has undefined semantics. @item ELF_SHT_DYNSYM @item ELF_SHT_NOBITS The section contents occupy no bits in the file. @item ELF_SHT_INIT_ARRAY @itemx ELF_SHT_FINI_ARRAY @itemx ELF_SHT_PREINIT_ARRAY Section contains an array of pointers to initialization/finalization/pre-initialization functions, which are parameter-less procedures that do not return any value. This is an array of @code{offset,B>} (@code{offset,B>} in ELF32) values spanning for @code{sh_size} bytes. @item ELF_SHT_GROUP Section contains the definition of an ELF section group. @xref{ELF File}. @item ELF_SHT_SYMTAB_SHNDX Section contains indices for @code{SHN_XINDEX} entries. @end table The ELF supplements for architectures/machines and operating systems introduce their own additional section types. @xref{ELF Machines}. This field is checked against the @code{section-types} configuration parameter, and pretty-printed accordingly. @item sh_flags Is a bitmap where each enabled bit flags some particular property of the section. This is one of the @code{ELF_SHF_*} values. These are the flags defined in the base spec: @table @code @item ELF_SHF_WRITE The section contains data that should be writable during process execution. @item ELF_SHF_ALLOC The section contents are actually loaded into memory during process execution. @item ELF_SHF_EXECINSTR The section contains executable machine instructions. @item ELF_SHF_MERGE The section contents can be merged to eliminate duplication. The ELF spec provides an algorithm (to be implemented by link editors) that explains how to merge sections flagged with this flag. The algorithm covers two cases: merge-able sections containing elements of fixed size, and string tables. @item ELF_SHF_STRINGS The section contains a string table. @item ELF_SHF_INFO_LINK The @code{sh_info} field of this section header contains a section header table index. @item ELF_SHF_LINK_ORDER This section is to be ordered in a particular way by link editors. The order to use is specified by a link to other section header table via @code{sh_info}. See the ELF spec for details. @item ELF_SHF_OS_NONCONFORMING This section requires special OS support to be linked. @item ELF_SHF_OS_TLS This section holds @dfn{thread-local storage}. @item ELF_SHF_COMPRESSED This section contents are compressed. Sections flagged as compressed cannot have the flag @code{ELF_SHF_ALLOC} set. Also, sections of type @code{ELF_SHT_NOBITS} cannot be compressed. @end table The ELF supplements for architectures/machines and operating systems introduce their own additional section types. @xref{ELF Machines}. This field is checked against the @code{section-flags} configuration parameter, and pretty-printed accordingly. @end table @node ELF Program Headers @chapter ELF Program Headers @cindex @code{Elf64_Phdr} @cindex @code{Elf32_Phdr} Segments can be stored anywhere in an ELF file. In case of relocatable objects, both sections and segments are present in the file, and they most certainly overlap. The ELF file contains a table, called the @dfn{program header table}, whose entries describe each segment. This table is sized and linked from the ELF header via the @code{e_phoff} field. The program header table is available in the @code{phdr} field of @code{Elf32_File} and @code{Elf64_File}. The Poke types denoting entries in the program header table are @code{Elf32_Phdr} and @code{Elf64_Phdr} for ELF32 and ELF64 respectively. @section Overview @example type Elf32_Phdr = struct @{ Elf_Word p_type; Elf32_Off p_offset; Elf32_Addr p_vaddr; Elf32_Addr p_paddr; offset p_filesz; offset p_memsz; Elf_Word p_flags; offset p_align; @}; type Elf64_Phdr = struct @{ Elf_Word p_type; Elf_Word p_flags; Elf64_Off p_offset; Elf64_Addr p_vaddr; Elf64_Addr p_paddr; offset p_filesz; offset p_memsz; offset p_align; @}; @end example @section Fields @table @code @item p_type Is a code identifying the type of the segment. This is one of the @code{ELF_PT_*} values. The type of a segment determines what kind of contents a segment has. These are the types defined in the base spec: @table @code @item ELF_PT_NULL This entry in the program header table is unused, and is ignored by ELF readers. @item ELF_PT_LOAD The segment is loadable. The stored file size is in @code{p_filesz}, and the loaded size is in @code{p_memsz}. These sizes can be different in certain situations; for example, when the loaded data has to fulfill different alignment constraints than the stored data. However, the stored size shall not be larger than the loaded size. This is checked by a constraint. @item ELF_PT_DYNAMIC The segment contains dynamic linking information in the form of a sequence of dynamic tags. This is an array of @code{Elf64_Dyn} or @code{Elf32_Dyn}. @item ELF_PT_INTERP The segment contains a null-terminated path name that the kernel uses to invoke as an interpreter. This segment should not occur more than once in a file. If it is present, it must precede any loadable segment entry. There is a constraint in @code{Elf32_File} and @code{Elf64_File} that checks for this. @item ELF_PT_NOTE The segment contains @dfn{notes}. These are flexible annotations that are usually used in order to reflect certain ``auxiliary'' attributes of the ELF file. For example, the name and full version of the compiler that generated it. The format in which the notes are encoded is well defined, and supported by the elf pickles. @xref{ELF Notes}. @item ELF_PT_SHLIB This value for @code{p_type} is reserved by the ELF specification and has undefined semantics. @item ELF_PT_PHDR Segment contains the program header table itself, in both file and memory. This segment type may not occur more than once in a file. If it is present, it must precede any loadable segment entry. There is a constraint in @code{Elf32_File} and @code{Elf64_File} that checks for this. @item ELF_PT_TLS The segment contains a thread local storage template. @end table @item p_flags Is a bitmap where each enabled bit flags some particular property of the segment described by this entry. This is one of the @code{ELF_PF_*} values. These are the segment flags defined in the base spec: @table @code @item ELF_PF_X The segment is executable. @item ELF_PF_W The segment is writable. @item ELF_PF_R The segment is readable. @end table @item p_offset This is the file offset of the start of the segment contents. @item p_vaddr This is the virtual address of the start of the loaded segment contents. @item p_paddr This is the physical address of the start of the loaded segment. Since sys-v ignores physical addressing for application programs (which use virtual memory) this field has unspecified contents in executables and shared objects. @item p_filesz Size of the segment in the file in bytes. This may be zero for some segments. @item p_memsz Loaded size of the segment in memory. This can be bigger than @code{p_filesz}. See above. @item p_align This is the alignment of the segment contents in both file and memory. If this field is either 0 or 1, no alignment is applied. Otherwise it must contain a power of two, and @code{p_vaddr == p_offset % p_align}. This is checked by a constraint in @code{Elf32_Phdr} and @code{Elf64_Phdr}. @end table @node ELF Symbols @chapter ELF Symbols @cindex @code{Elf64_Sym} @cindex @code{Elf32_Sym} ELF symbols are implemented by the @code{Elf32_Sym} and @code{Elf64_Sym} struct types. @section Overview @example type Elf32_Sym = struct @{ offset st_name; Elf32_Addr st_value; offset st_size; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other; Elf_Half st_shndx; @}; @end example @example type Elf64_Sym = struct @{ offset st_name; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other; Elf_Half st_shndx; Elf64_Addr st_value; Elf64_Xword st_size; @}; @end example @section Fields @table @code @item st_name Index into the file symbol string table. If this entry is zero it means the symbol has no name. @item st_info The type and the binding attributes of the symbol. @example type Elf_Sym_Info = struct uint<8> @{ uint<4> st_bind; uint<4> st_type; @}; @end example @noindent Where: @table @code @item st_bind Specifies how the symbol binds. This must be one of @code{ELF_STB_LOCAL}, @code{ELF_STB_GLOBAL} or @code{ELF_STB_WEAK}. @item st_type Specifies the type of the symbol. This must be one of the @code{ELF_STT_*} values. The following symbol types are defined by the core specification: @table @code @item ELF_STT_NOTYPE The symbol's type is not specified. @item ELF_STT_OBJECT The symbol is associated with a data object, such as a variable, an array and so on. @item ELF_STT_FUNC The symbol is associated with a function or other executable code. @item ELF_STT_SECTION The symbol is associated with a section. This is primarily used for relocations. @item ELF_STT_FILE By convention, this symbol's name gives the name of the source file associated with the object file. A file symbol has local binding, its section index is @code{ELF_SHN_ABS} and it precedes the other local symbols for the file. This is currently not checked by the pickles. @item ELF_STT_COMMON The symbol labels an uninitialized common block. @item ELF_STT_TLS The symbol specifies a Thread-Local Storage entity, in the form of an offset. @end table @end table @item st_other This field specifies the symbol's visibility. This is one of the @code{ELF_STV_*} values. The list of symbol visibility defined by the core spec are: @table @code @item ELF_STV_DEFAULT The visibility of this symbol is defined by its binding. Global and weak symbols are visible outside of heir defining component. Local symbols are hidden. @item ELF_STV_PROTECTED This symbol is visible in other components but it is not preemptable. A symbol with local binding may not have protected visibility. This is checked by a constraint in @code{Elf_Sym_Info}. @item ELF_STV_HIDDEN This symbol is not visible to other components. @item ELF_STV_INTERNAL The meaning of this attribute, if any, is processor specific. @end table Some machine types define other values that can be used in @code{st_other}. @xref{ELF Machines}. @item st_shndx Every symbol table entry is defined in relation to some section. This holds the index into the section header table of the section related to this symbol. However, some values for this field indicate special meanings. These are the @code{ELF_SHN_*} values. The core specification defines the following: @table @code @item ELF_SHN_UNDEF The symbol is undefined. @item ELF_SHN_ABS The symbol is absolute, meaning its value will not change because of relocation. @item ELF_SHN_COMMON The symbol refers to a common block that has not yet been allocated. @item ELF_SHN_XINDEX The symbol refers to a specific location within a section, but the section header index for that section is too large to e represented directly in this entry. The actual section header index is found in the associated @code{SHT_SYMTAB_SHNDX} section. @end table Some machine types define additional values with special meanings for @code{st_shndx}. @xref{ELF Machines}. @item st_value Offset from the beginning of the section identified by @code{st_shndx}. @item st_size Size associated with the symbol. For example, the size of a data object. Symbols that have no associated size, or unknown size, have zero in this field. @end table @node ELF Notes @chapter ELF Notes @cindex @code{Elf_Note} ELF notes provide a generic mechanism for adding metadata to ELF files in the form of @dfn{notes} stored in sections. ELF notes are implemented by the @code{Elf_Note} struct type. @section Overview @example type Elf_Note = struct @{ Elf_Word namesz; Elf_Word descsz; Elf_Word _type; byte[namesz] name; byte[descsz] desc; @}; @end example @section Fields @table @code @item namesz The first @code{namesz} bytes in @code{name} contain a NULL-terminated character representation of the entry's owner or originator. @item descsz The first @code{descsz} bytes in @code{desc} hold the note descriptor. The ABI places no constraints on a descriptor's contents. @item _type This word gives the interpretation of the descriptor. Each originator controls its own types. The ABI does not define what descriptors mean. @item name Note name. @item desc Note descriptor. @end table @node ELF Relocations @chapter ELF Relocations @cindex @code{Elf64_RelInfo} @cindex @code{Elf64_Rel} @cindex @code{Elf64_Rela} @cindex @code{Elf32_RelInfo} @cindex @code{Elf32_Rel} @cindex @code{Elf32_Rela} ELF supports two kind of relocations: relocations without addend (@dfn{REL} relocations) and relocations with addend (@dfn{RELA} relocations). REL relocations are implemented by the @code{Elf32_Rel} and @code{Elf64_Rel} types. RELA relocations are implementd by the @code{Elf32_Rela} and @code{Elf64_Rela} types. @section Overview @example type Elf32_RelInfo = struct Elf_Word @{ uint<24> r_sym; uint<8> r_type; @}; type Elf32_Rel = struct @{ Elf32_Addr r_offset; Elf32_RelInfo r_info; @}; type Elf32_Rela = struct @{ Elf32_Addr r_offset; Elf32_RelInfo r_info; Elf_Sword r_addend; @}; type Elf64_RelInfo = struct Elf64_Xword @{ uint<32> r_sym; uint<32> r_type; @}; type Elf64_Rel = struct @{ Elf64_Addr r_offset; Elf64_RelInfo r_info; @}; type Elf64_Rela = struct @{ Elf64_Addr r_offset; Elf64_RelInfo r_info; Elf64_Sxword r_addend; @}; @end example @section Fields @table @code @item r_offset This field specifies the location at which to apply the relocation action, which itself depends on the specific kind of relocation. This is the byte offset from the beginning of the section whose contents are to be relocated. In executables and shared objects this offset is a virtual address; in all other ELF files this refers to the stored data. @item r_info XXX @table @code @item r_sym XXX @item r_type XXX @end table @item r_addend XXX @end table @node ELF Dynamic Info @chapter ELF Dynamic Info @cindex @code{Elf64_Dyn} @cindex @code{Elf32_Dyn} XXX @node ELF Machines @chapter ELF Machines XXX @node ELF OSes @chapter ELF OSes XXX @node Indices @appendix Indices @menu * Concept Index:: General concept index @end menu @node Concept Index @appendixsec Concept Index @printindex cp @bye poke-elf-1.0/examples/0000755000175000017500000000000014602060043011666 500000000000000poke-elf-1.0/examples/prelinkr0000755000175000017500000003115614562413123013376 00000000000000#!/usr/bin/env sh exec poke -L "$0" "$@" !# /* prelinkr.pk - Prepare ELF64 DSOs to load to a given address. */ /* Copyright (C) 2024 Free Software Foundation Inc. */ /* Written by Jose E. Marchesi Contributed by Oracle Inc. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* This program is basically a Poke version of `prelink -r', written by Jakub Jelinek. */ load argp; load elf; var verbose = 0; fun read_load_address = (Elf64_File elf, Elf64_Addr addr) Elf64_Addr: { var off = elf.vaddr_to_file_offset (addr); return Elf64_Addr @ off; } fun write_load_address = (Elf64_File elf, Elf64_Addr addr, Elf64_Addr val) void: { var off = elf.vaddr_to_file_offset (addr); if (verbose) { var sec = elf.vaddr_to_sec (addr); assert (sec != -1); printf ("adjusting data %s(%i32d):%v[%v->%v]\n", elf.get_section_name (elf.shdr[sec].sh_name), sec, addr, Elf64_Addr @ off, val); } Elf64_Addr @ off = val; } fun adjust_section = (Elf64_File elf, int<32> idx, Elf64_Addr start, Elf64_Addr adjust) void: { var shdr = elf.shdr[idx]; /* First adjust section contents. */ if (shdr.sh_type == ELF_SHT_PROGBITS) { if (elf.get_section_name (shdr.sh_name) == ".stab") { raise Exception { code = EC_inval, msg = "relocating .stab sections is not supported" }; } else if (elf.get_section_name (shdr.sh_name) == ".debug_info") { raise Exception { code = EC_inval, msg = "relocating .debug_info sections is not supported" }; } } else if (shdr.sh_type in [ELF_SHT_SYMTAB, ELF_SHT_DYNSYM]) { for (sym in Elf64_Sym [shdr.sh_size] @ shdr.sh_offset) { if ((sym.st_shndx == ELF_SHN_ABS && sym.st_value != 0#B && sym.st_info.st_type <= ELF_STT_FUNC) || (sym.st_shndx > ELF_SHN_UNDEF && sym.st_shndx < elf.ehdr.e_shnum && sym.st_info.st_type != ELF_STT_TLS && elf.shdr[sym.st_shndx].sh_flags & (ELF_SHF_WRITE | ELF_SHF_ALLOC | ELF_SHF_EXECINSTR))) { sym.st_value += adjust; if (verbose) printf ("adjusting symbol %s st_value[%v->%v]\n", elf.get_string (sym.st_name), sym.st_value - adjust, sym.st_value); } } } else if (shdr.sh_type == ELF_SHT_DYNAMIC) { /* XXX non-strict due to a poke bug regarding unions below. */ for (dyn in Elf64_Dyn[shdr.sh_size] @ shdr.sh_offset) { if (elf_mach == ELF_EM_X86_64 && dyn.d_tag == ELF_DT_PLTGOT) { var sec = elf.vaddr_to_sec (dyn.d_data.d_ptr); if (sec != -1) { var data = read_load_address (elf, dyn.d_data.d_ptr); /* If .got.plt[0] points to _DYNAMIC, it needs to be adjusted. */ if (data == shdr.sh_addr && data >= start) write_load_address (elf, dyn.d_data.d_ptr, data + adjust); data = read_load_address (elf, dyn.d_data.d_ptr + 8#B); /* If .got.plt[1] points to .plt + 0x16, it needs to be adjusted. */ if (data > 0#B && data >= start) { for (s in elf.shdr) if (data == s.sh_addr + 0x16#B && s.sh_type == ELF_SHT_PROGBITS && elf.get_section_name (s.sh_name) == ".plt") write_load_address (elf, dyn.d_data.d_ptr + 8#B, data + adjust); } } } if (dyn.d_tag as uint<32> in [ELF_DT_REL, ELF_DT_RELA]) { if (dyn.d_data.d_ptr != 0#B && dyn.d_data.d_ptr >= start) { if (verbose) printf ("adjusting dynamic tag d_ptr[%v->%v] with tag %v\n", dyn.d_data.d_ptr, dyn.d_data.d_ptr + adjust, dyn.d_tag); dyn.d_data.d_ptr += adjust; } } else if (!(dyn.d_data.d_ptr ?! E_elem)) { if (dyn.d_data.d_ptr >= start) { if (verbose) printf ("adjusting dynamic tag d_ptr[%v->%v] with tag %v\n", dyn.d_data.d_ptr, dyn.d_data.d_ptr + adjust, dyn.d_tag); printf ("DYN %v\n", dyn); dyn.d_data.d_ptr += adjust; printf ("POST\n"); } } } } else if (shdr.sh_type == ELF_SHT_REL) { for (rel in Elf64_Rel [shdr.sh_size] @ shdr.sh_offset where elf.vaddr_to_sec (rel.r_offset) != -1) { if (rel.r_offset >= start) rel.r_offset += adjust; } } else if (shdr.sh_type == ELF_SHT_RELA) { for (rela in Elf64_Rela[shdr.sh_size] @ shdr.sh_offset where elf.vaddr_to_sec (rela.r_offset) != -1) { if (elf_mach == ELF_EM_X86_64) { if (rela.r_info.r_type == ELF_R_X86_64_RELATIVE) { if (rela.r_addend >= start) { if (verbose) { print "adjusting reloc R_X86_64_RELATIVE"; printf " addend[%v->%v]\n", rela.r_addend, rela.r_addend + adjust; } if (read_load_address (elf, rela.r_offset) == rela.r_addend) write_load_address (elf, rela.r_offset, rela.r_addend + adjust); rela.r_addend += adjust; } } else if (rela.r_info.r_type == ELF_R_X86_64_IRELATIVE) { if (rela.r_addend >= start) { if (verbose) printf "adjusting reloc R_X86_64_IRELATIVE addend[%v->%v]\n", rela.r_addend, rela.r_addend + adjust; rela.r_addend += adjust; } var addr = read_load_address (elf, rela.r_offset); if (addr >= start) write_load_address (elf, rela.r_offset, addr + adjust); } else if (rela.r_info.r_type == ELF_R_X86_64_JUMP_SLOT) { var addr = read_load_address (elf, rela.r_offset); if (addr >= start) write_load_address (elf, rela.r_offset, addr + adjust); } } if (rela.r_offset >= start) rela.r_offset += adjust; } } /* Now the section itself. */ if (shdr.sh_flags & (ELF_SHF_WRITE | ELF_SHF_ALLOC | ELF_SHF_EXECINSTR)) { if (shdr.sh_addr >= start) { shdr.sh_addr += adjust; if (start > 0#B) { shdr.sh_offset += adjust; if (verbose) printf ("adjusting section [%i32d] %s sh_offset[%v->%v]\n", idx, elf.get_section_name (shdr.sh_name), shdr.sh_offset - adjust, shdr.sh_offset); } if (verbose) printf ("adjusting section [%i32d] %s sh_addr[%v->%v]\n", idx, elf.get_section_name (shdr.sh_name), shdr.sh_addr - adjust, shdr.sh_addr); } } } fun adjust_segment = (Elf64_File elf, int<32> idx, Elf64_Addr start, Elf64_Addr adjust) void: { var phdr = elf.phdr[idx]; /* The STACK segment doesn't need to be adjusted, since all its addresses and offsets shall be zero. */ if (phdr.p_type == ELF_PT_GNU_STACK) return; fun check_alignment = (Elf64_Addr vaddr, Elf64_Addr offset) void: { if (phdr.p_type == ELF_PT_LOAD && ((vaddr - offset) % phdr.p_align) != 0#B) raise Exception { code = EC_inval, msg = "specified address leads to unaligned PT_LOAD segment in DSO" }; } fun note_adjust = (string field, Elf64_Addr from, Elf64_Addr to) void: { if (verbose) printf "adjusting segment [%i32d] %s[%v->%v]\n", idx, field, from, to; } if (start == 0#B) { check_alignment (phdr.p_vaddr + adjust, phdr.p_offset); phdr.p_vaddr += adjust; phdr.p_paddr += adjust; note_adjust ("p_paddr", phdr.p_paddr - adjust, phdr.p_paddr); note_adjust ("p_vaddr", phdr.p_vaddr - adjust, phdr.p_vaddr); } else if (start <= phdr.p_vaddr) { check_alignment (phdr.p_vaddr + adjust, phdr.p_offset + adjust); phdr.p_vaddr += adjust; phdr.p_paddr += adjust; phdr.p_offset += adjust; note_adjust ("p_paddr", phdr.p_paddr - adjust, phdr.p_paddr); note_adjust ("p_vaddr", phdr.p_vaddr - adjust, phdr.p_vaddr); note_adjust ("p_offset", phdr.p_offset - adjust, phdr.p_offset); } else if (start < phdr.p_vaddr + phdr.p_filesz) { phdr.p_filesz += adjust; phdr.p_memsz += adjust; note_adjust ("p_filesz", phdr.p_filesz - adjust, phdr.p_filesz); note_adjust ("p_memsz", phdr.p_memsz - adjust, phdr.p_memsz); } else if (start < phdr.p_vaddr + phdr.p_memsz) { phdr.p_memsz += adjust; note_adjust ("p_memsz", phdr.p_memsz - adjust, phdr.p_memsz); } else return; } fun adjust_file = (Elf64_File elf, Elf64_Addr start, Elf64_Addr adjust) void: { if (elf.ehdr.e_entry >= start) elf.ehdr.e_entry += adjust; for (var i = 0; i < elf.ehdr.e_phnum; ++i) adjust_segment (elf, i, start, adjust); for (var i = 0; i < elf.ehdr.e_shnum; ++i) adjust_section (elf, i, start, adjust); } /******************** Main program. **************************/ var address = 0#B; argv = argp_parse ("prelinkr", "", "Prepare ELF64 DSOs to load to a given address.", [Argp_Option { name = "a", long_name = "address", arg_required = 1, handler = lambda (string arg) void: { var base = 10; if (arg'length > 1 && arg[0:2] == "0x") { base = 16; arg = arg[2:]; } address = (strtoi (arg, base).val)#B; } }, Argp_Option { name = "v", long_name = "verbose", handler = lambda (string arg) void: { verbose = 1; } }], argv); if (argv'length != 1) { print "Usage: prelinkr [-v|--verbose] [-a ADDRESS] FILE\n"; exit (1); } vm_set_obase (16); vm_set_autoremap (0); var file = argv[0]; try { var fd = open (file, IOS_F_READ|IOS_F_WRITE); var dso = Elf64_File @ fd : 0#B; /* We handle only DSOs. */ if (dso.ehdr.e_type != ELF_ET_DYN) { print "Invalid ELF file. Expected a DSO.\n"; exit (1); } /* We support x86_64 and aarch64. */ if (!(elf_mach as int<32> in [ELF_EM_X86_64, ELF_EM_AARCH64])) { print "Unsupported ELF architecture.\n"; exit (1); } /* Determine the current base of the DSO and relocate if necessary. */ var elf_base = dso.get_load_base; if (address > elf_base) adjust_file (dso, 0#B, address - elf_base); } catch (Exception e) { if (e.code == EC_constraint) print "error: invalid DSO or transformation leads to invalid ELF\n"; if (e == E_io) printf ("error: could not read `%s'\n", file); else if (e == E_perm) printf ("error: not enough permissions to read `%s'\n", file); else if (e.code == EC_inval) printf ("error: %s\n", e.msg); else raise e; exit (1); } /* * Local Variables: * mode: poke * End: */ poke-elf-1.0/AUTHORS0000644000175000017500000000005114365270503011046 00000000000000Jose E. Marchesi poke-elf-1.0/elf-mach-sparc.pk0000644000175000017500000003200414602057366013123 00000000000000/* elf-mach-sparc.pk - ELF SPARC specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* Many of the entities defined in this file apply to several of the recognized SPARC machines. */ fun elf_sparc_add_enum = (string class, Elf_Config_UInt[] entries) void: { elf_config.add_enum (ELF_EM_SPARC, class, entries); elf_config.add_enum (ELF_EM_SPARC32PLUS, class, entries); elf_config.add_enum (ELF_EM_SPARCV9, class, entries); } fun elf_sparc_add_mask = (string class, Elf_Config_Mask[] entries) void: { elf_config.add_mask (ELF_EM_SPARC, class, entries); elf_config.add_mask (ELF_EM_SPARC32PLUS, class, entries); elf_config.add_mask (ELF_EM_SPARCV9, class, entries); } /* SPARC file flags. */ var ELF_EF_SPARC_32PLUS = 0x0000_0100, ELF_EF_SPARC_SUN_US1 = 0x0000_0200, ELF_EF_SPARC_HAL_R1 = 0x0000_0400, ELF_EF_SPARC_SUN_US3 = 0x0000_0800, ELF_EF_SPARC_LEDATA = 0x0080_0000; elf_sparc_add_mask :class "file-flags" :entries [Elf_Config_Mask { value = ELF_EF_SPARC_32PLUS, name = "32plus", doc = "Generic V8+ features." }, Elf_Config_Mask { value = ELF_EF_SPARC_SUN_US1, name = "sun-us1", doc = "Sun UltraSPARC1 extensions." }, Elf_Config_Mask { value = ELF_EF_SPARC_HAL_R1, name = "hal-r1", doc = "HAL R1 extensions." }, Elf_Config_Mask { value = ELF_EF_SPARC_SUN_US3, name = "sun-us3", doc = "Sun UltraSPARCIII extensions." }]; /* SPARC section flags. */ var ELF_SHF_SPARC_ORDERED = 0x4000_0000U; elf_sparc_add_mask :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_SPARC_ORDERED, name = "ordered", doc = "Treat sh_link, sh_info specially." }]; /* SPARC symbol types. */ var ELF_STT_SPARC_REGISTER = 13; elf_sparc_add_enum :class "symbol-types" :entries [Elf_Config_UInt { value = ELF_STT_SPARC_REGISTER, name = "stt-register", doc = "Global register reserved to app." }]; /* SPARC dynamic tag types. */ var ELF_DT_SPARC_REGISTER = 0x7000_0001; elf_sparc_add_enum :class "dynamic-tag-types" :entries [Elf_Config_UInt { value = ELF_DT_SPARC_REGISTER, name = "register" }]; /* SPARC relocation types. */ var ELF_R_SPARC_NONE = 0, ELF_R_SPARC_8 = 1, ELF_R_SPARC_16 = 2, ELF_R_SPARC_32 = 3, ELF_R_SPARC_DISP8 = 4, ELF_R_SPARC_DISP16 = 5, ELF_R_SPARC_DISP32 = 6, ELF_R_SPARC_WDISP30 = 7, ELF_R_SPARC_WDISP22 = 8, ELF_R_SPARC_HI22 = 9, ELF_R_SPARC_22 = 10, ELF_R_SPARC_13 = 11, ELF_R_SPARC_LO10 = 12, ELF_R_SPARC_GOT10 = 13, ELF_R_SPARC_GOT13 = 14, ELF_R_SPARC_GOT22 = 15, ELF_R_SPARC_PC10 = 16, ELF_R_SPARC_PC22 = 17, ELF_R_SPARC_WPLT30 = 18, ELF_R_SPARC_COPY = 19, ELF_R_SPARC_GLOB_DAT = 20, ELF_R_SPARC_JMP_SLOT = 21, ELF_R_SPARC_RELATIVE = 22, ELF_R_SPARC_UA32 = 23, ELF_R_SPARC_PLT32 = 24, ELF_R_SPARC_HIPLT22 = 25, ELF_R_SPARC_LOPLT10 = 26, ELF_R_SPARC_PCPLT32 = 27, ELF_R_SPARC_PCPLT22 = 28, ELF_R_SPARC_PCPLT10 = 29, ELF_R_SPARC_10 = 30, ELF_R_SPARC_11 = 31, ELF_R_SPARC_64 = 32, ELF_R_SPARC_OLO10 = 33, ELF_R_SPARC_HH22 = 34, ELF_R_SPARC_HM10 = 35, ELF_R_SPARC_LM22 = 36, ELF_R_SPARC_PC_HH22 = 37, ELF_R_SPARC_PC_HM10 = 38, ELF_R_SPARC_PC_LM22 = 39, ELF_R_SPARC_WDISP16 = 40, ELF_R_SPARC_WDISP19 = 41, ELF_R_SPARC_UNUSED_42 = 42, ELF_R_SPARC_7 = 43, ELF_R_SPARC_5 = 44, ELF_R_SPARC_6 = 45, ELF_R_SPARC_DISP64 = 46, ELF_R_SPARC_PLT64 = 47, ELF_R_SPARC_HIX22 = 48, ELF_R_SPARC_LOX10 = 49, ELF_R_SPARC_H44 = 50, ELF_R_SPARC_M44 = 51, ELF_R_SPARC_L44 = 52, ELF_R_SPARC_REGISTER = 53, ELF_R_SPARC_UA64 = 54, ELF_R_SPARC_UA16 = 55, ELF_R_SPARC_TLS_GD_HI22 = 56, ELF_R_SPARC_TLS_GD_LO10 = 57, ELF_R_SPARC_TLS_GD_ADD = 58, ELF_R_SPARC_TLS_GD_CALL = 59, ELF_R_SPARC_TLS_LDM_HI22 = 60, ELF_R_SPARC_TLS_LDM_LO10 = 61, ELF_R_SPARC_TLS_LDM_ADD = 62, ELF_R_SPARC_TLS_LDM_CALL = 63, ELF_R_SPARC_TLS_LDO_HIX22 = 64, ELF_R_SPARC_TLS_LDO_LOX10 = 65, ELF_R_SPARC_TLS_LDO_ADD = 66, ELF_R_SPARC_TLS_IE_HI22 = 67, ELF_R_SPARC_TLS_IE_LO10 = 68, ELF_R_SPARC_TLS_IE_LD = 69, ELF_R_SPARC_TLS_IE_LDX = 70, ELF_R_SPARC_TLS_IE_ADD = 71, ELF_R_SPARC_TLS_LE_HIX22 = 72, ELF_R_SPARC_TLS_LE_LOX10 = 73, ELF_R_SPARC_TLS_DTPMOD32 = 74, ELF_R_SPARC_TLS_DTPMOD64 = 75, ELF_R_SPARC_TLS_DTPOFF32 = 76, ELF_R_SPARC_TLS_DTPOFF64 = 77, ELF_R_SPARC_TLS_TPOFF32 = 78, ELF_R_SPARC_TLS_TPOFF64 = 79, ELF_R_SPARC_GOTDATA_HIX22 = 80, ELF_R_SPARC_GOTDATA_LOX10 = 81, ELF_R_SPARC_GOTDATA_OP_HIX22 = 82, ELF_R_SPARC_GOTDATA_OP_LOX10 = 83, ELF_R_SPARC_GOTDATA_OP = 84, ELF_R_SPARC_H34 = 85, ELF_R_SPARC_SIZE32 = 86, ELF_R_SPARC_SIZE64 = 87, ELF_R_SPARC_WDISP10 = 88, ELF_R_SPARC_JMP_IREL = 248, ELF_R_SPARC_IRELATIVE = 249, ELF_R_SPARC_GNU_VTINHERIT = 250, ELF_R_SPARC_GNU_VTENTRY = 251, ELF_R_SPARC_REV32 = 252; elf_sparc_add_enum :class "reloc-types" :entries [Elf_Config_UInt { value = ELF_R_SPARC_NONE, name = "none" }, Elf_Config_UInt { value = ELF_R_SPARC_8, name = "8" }, Elf_Config_UInt { value = ELF_R_SPARC_16, name = "16" }, Elf_Config_UInt { value = ELF_R_SPARC_32, name = "32" }, Elf_Config_UInt { value = ELF_R_SPARC_DISP8, name = "DISP8" }, Elf_Config_UInt { value = ELF_R_SPARC_DISP16, name = "DISP16" }, Elf_Config_UInt { value = ELF_R_SPARC_DISP32, name = "DISP32" }, Elf_Config_UInt { value = ELF_R_SPARC_WDISP30, name = "WDISP30" }, Elf_Config_UInt { value = ELF_R_SPARC_WDISP22, name = "WDISP22" }, Elf_Config_UInt { value = ELF_R_SPARC_HI22, name = "HI22" }, Elf_Config_UInt { value = ELF_R_SPARC_22, name = "22" }, Elf_Config_UInt { value = ELF_R_SPARC_13, name = "13" }, Elf_Config_UInt { value = ELF_R_SPARC_LO10, name = "LO10" }, Elf_Config_UInt { value = ELF_R_SPARC_GOT10, name = "GOT10" }, Elf_Config_UInt { value = ELF_R_SPARC_GOT13, name = "GOT13" }, Elf_Config_UInt { value = ELF_R_SPARC_GOT22, name = "GOT22" }, Elf_Config_UInt { value = ELF_R_SPARC_PC10, name = "PC10" }, Elf_Config_UInt { value = ELF_R_SPARC_PC22, name = "PC22" }, Elf_Config_UInt { value = ELF_R_SPARC_WPLT30, name = "WPLT30" }, Elf_Config_UInt { value = ELF_R_SPARC_COPY, name = "COPY" }, Elf_Config_UInt { value = ELF_R_SPARC_GLOB_DAT, name = "GLOB_DAT" }, Elf_Config_UInt { value = ELF_R_SPARC_JMP_SLOT, name = "JMP_SLOT" }, Elf_Config_UInt { value = ELF_R_SPARC_RELATIVE, name = "RELATIVE" }, Elf_Config_UInt { value = ELF_R_SPARC_UA32, name = "UA32" }, Elf_Config_UInt { value = ELF_R_SPARC_PLT32, name = "PLT32" }, Elf_Config_UInt { value = ELF_R_SPARC_HIPLT22, name = "HIPLT22" }, Elf_Config_UInt { value = ELF_R_SPARC_LOPLT10, name = "LOPLT10" }, Elf_Config_UInt { value = ELF_R_SPARC_PCPLT32, name = "PCPLT32" }, Elf_Config_UInt { value = ELF_R_SPARC_PCPLT22, name = "PCPLT22" }, Elf_Config_UInt { value = ELF_R_SPARC_PCPLT10, name = "PCPLT10" }, Elf_Config_UInt { value = ELF_R_SPARC_10, name = "10" }, Elf_Config_UInt { value = ELF_R_SPARC_11, name = "11" }, Elf_Config_UInt { value = ELF_R_SPARC_64, name = "64" }, Elf_Config_UInt { value = ELF_R_SPARC_OLO10, name = "OLO10" }, Elf_Config_UInt { value = ELF_R_SPARC_HH22, name = "HH22" }, Elf_Config_UInt { value = ELF_R_SPARC_HM10, name = "HM10" }, Elf_Config_UInt { value = ELF_R_SPARC_LM22, name = "LM22" }, Elf_Config_UInt { value = ELF_R_SPARC_PC_HH22, name = "PC_HH22" }, Elf_Config_UInt { value = ELF_R_SPARC_PC_HM10, name = "PC_HM10" }, Elf_Config_UInt { value = ELF_R_SPARC_PC_LM22, name = "PC_LM22" }, Elf_Config_UInt { value = ELF_R_SPARC_WDISP16, name = "WDISP16" }, Elf_Config_UInt { value = ELF_R_SPARC_WDISP19, name = "WDISP19" }, Elf_Config_UInt { value = ELF_R_SPARC_UNUSED_42, name = "UNUSED_42" }, Elf_Config_UInt { value = ELF_R_SPARC_7, name = "7" }, Elf_Config_UInt { value = ELF_R_SPARC_5, name = "5" }, Elf_Config_UInt { value = ELF_R_SPARC_6, name = "6" }, Elf_Config_UInt { value = ELF_R_SPARC_DISP64, name = "DISP64" }, Elf_Config_UInt { value = ELF_R_SPARC_PLT64, name = "PLT64" }, Elf_Config_UInt { value = ELF_R_SPARC_HIX22, name = "HIX22" }, Elf_Config_UInt { value = ELF_R_SPARC_LOX10, name = "LOX10" }, Elf_Config_UInt { value = ELF_R_SPARC_H44, name = "H44" }, Elf_Config_UInt { value = ELF_R_SPARC_M44, name = "M44" }, Elf_Config_UInt { value = ELF_R_SPARC_L44, name = "L44" }, Elf_Config_UInt { value = ELF_R_SPARC_REGISTER, name = "REGISTER" }, Elf_Config_UInt { value = ELF_R_SPARC_UA64, name = "UA64" }, Elf_Config_UInt { value = ELF_R_SPARC_UA16, name = "UA16" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_GD_HI22, name = "TLS_GD_HI22" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_GD_LO10, name = "TLS_GD_LO10" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_GD_ADD, name = "TLS_GD_ADD" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_GD_CALL, name = "TLS_GD_CALL" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDM_HI22, name = "TLS_LDM_HI22" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDM_LO10, name = "TLS_LDM_LO10" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDM_ADD, name = "TLS_LDM_ADD" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDM_CALL, name = "TLS_LDM_CALL" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDO_HIX22, name = "TLS_LDO_HIX22" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDO_LOX10, name = "TLS_LDO_LOX10" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LDO_ADD, name = "TLS_LDO_ADD" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_IE_HI22, name = "TLS_IE_HI22" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_IE_LO10, name = "TLS_IE_LO10" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_IE_LD, name = "TLS_IE_LD" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_IE_LDX, name = "TLS_IE_LDX" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_IE_ADD, name = "TLS_IE_ADD" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LE_HIX22, name = "TLS_LE_HIX22" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_LE_LOX10, name = "TLS_LE_LOX10" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_DTPMOD32, name = "TLS_DTPMOD32" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_DTPMOD64, name = "TLS_DTPMOD64" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_DTPOFF32, name = "TLS_DTPOFF32" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_DTPOFF64, name = "TLS_DTPOFF64" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_TPOFF32, name = "TLS_TPOFF32" }, Elf_Config_UInt { value = ELF_R_SPARC_TLS_TPOFF64, name = "TLS_TPOFF64" }, Elf_Config_UInt { value = ELF_R_SPARC_GOTDATA_HIX22, name = "GOTDATA_HIX22" }, Elf_Config_UInt { value = ELF_R_SPARC_GOTDATA_LOX10, name = "GOTDATA_LOX10" }, Elf_Config_UInt { value = ELF_R_SPARC_GOTDATA_OP_HIX22, name = "GOTDATA_OP_HIX22" }, Elf_Config_UInt { value = ELF_R_SPARC_GOTDATA_OP_LOX10, name = "GOTDATA_OP_LOX10" }, Elf_Config_UInt { value = ELF_R_SPARC_GOTDATA_OP, name = "GOTDATA_OP" }, Elf_Config_UInt { value = ELF_R_SPARC_H34, name = "H34" }, Elf_Config_UInt { value = ELF_R_SPARC_SIZE32, name = "SIZE32" }, Elf_Config_UInt { value = ELF_R_SPARC_SIZE64, name = "SIZE64" }, Elf_Config_UInt { value = ELF_R_SPARC_WDISP10, name = "WDISP10" }, Elf_Config_UInt { value = ELF_R_SPARC_JMP_IREL, name = "JMP_IREL" }, Elf_Config_UInt { value = ELF_R_SPARC_IRELATIVE, name = "IRELATIVE" }, Elf_Config_UInt { value = ELF_R_SPARC_GNU_VTINHERIT, name = "GNU_VTINHERIT" }, Elf_Config_UInt { value = ELF_R_SPARC_GNU_VTENTRY, name = "GNU_VTENTRY" }, Elf_Config_UInt { value = ELF_R_SPARC_REV32, name = "REV32" }]; poke-elf-1.0/elf-config.pk0000644000175000017500000002050114602057344012345 00000000000000/* elf-config.pk - ELF configuration parameters. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* This file implements a type Elf_Config that implements a registry of several values associated to the different supported ELF machines and operating systems: relocation types, section types, segment types, several kind of flags, etc. */ var elf_config_debug = 0; type Elf_Config_Mask = struct { uint<64> value; string name; string doc; }; type Elf_Config_UInt = struct { uint<32> value; string name; string doc; }; type Elf_Config = struct { type Mask = struct { string class; uint<64> value; Elf_Config_Mask[] entries; method update_value = void: { value = 0; for (e in entries) value |= e.value; } }; type Enum = struct { string class; Elf_Config_UInt[] entries; }; type Machine = struct { uint<16> machine; Mask[] masks; Enum[] enums; }; Machine[] machines; Mask[] common_masks; Enum[] common_enums; /* Search in the machines entries for some given MACHINE. Raise E_inval if no entry is found. */ fun search_machine = (uint<16> machine) Machine: { for (m in machines where m.machine == machine) return m; raise E_inval; } /* Add the given ENTRIES to an enumeration with class CLASS. If MACHINE is not specified, or passed -1, then the values are common and apply to any machine. Otherwise the values only apply to the given machine. */ method add_enum = (int<32> machine = -1, string class = "", Elf_Config_UInt[] entries = Elf_Config_UInt[]()) void: { var new_enum = Enum { class = class, entries = entries }; if (machine == -1) apush (common_enums, new_enum); else { try apush (search_machine (machine).enums, new_enum); catch if E_inval { /* Add a new entry. */ apush (machines, Machine { machine = machine, enums = [new_enum] }); } } } /* Add the given ENTRIES to a bitmask with class CLASS. If MACHINE is not specified, or passed -1, then the values are common and apply to any machine. Otherwise the values only apply to the given machine. */ method add_mask = (int<32> machine = -1, string class = "", Elf_Config_Mask[] entries = Elf_Config_Mask[]()) void: { var new_mask = Mask { class = class, entries = entries }; new_mask.update_value; if (machine == -1) apush (common_masks, Mask { class = class, entries = entries }); else { try apush (search_machine (machine).masks, new_mask); catch if E_inval { /* Add a new entry. */ apush (machines, Machine { machine = machine, masks = [new_mask] }); } } } /* Check whether the bits set in the given VALUE satisfy the mask with CLASS in MACHINE. Note that common masks not pertaining to any particular machine are also checked. */ method check_mask = (string class, uint<16> machine, uint<64> value) int<32>: { if (elf_config_debug) printf ("elf_config: checking mask %v, %v, %v\n", class, machine, value); /* Fast track :P */ if (value == 0) return 1; fun check_masks = (Mask[] masks) int<32>: { for (m in masks where m.class == class) value |= m.value; return !!value; } if (check_masks (common_masks)) return 1; try return check_masks (search_machine (machine).masks); catch if E_inval { return 0; } } /* Check whether the given VALUE is a member of the enum with CLASS in MACHINE. Note that common enums not pertaining to any particular machine are also checked. */ method check_enum = (string class, uint<16> machine, uint<32> value) int<32>: { if (elf_config_debug) printf ("elf_config: checking enum %v, %v, %v\n", class, machine, value); fun check_enums = (Enum[] enums) int<32>: { for (e in enums where e.class == class) for (entry in e.entries where entry.value == value) return 1; return 0; } if (check_enums (common_enums)) return 1; try return check_enums (search_machine (machine).enums); catch if E_inval { return 0; } } /* Format and return a string for the given VALUE as a bitmap of the mask with CLASS in MACHINE. If the specified mask is not found then return the empty string. */ method format_mask = (string class, uint<16> machine, uint<64> value) string: { fun format_masks = (Mask[] masks) string: { var res = ""; var count = 0; for (m in masks where m.class == class) for (entry in m.entries where entry.value & value) { if (count++ != 0) res += ","; res += entry.name; } return res; } var res = format_masks (common_masks); if (res != "") return res; try return format_masks (search_machine (machine).masks); catch if E_inval { return ""; } } /* Format and return a string for the given VALUE as a member of the enum with CLASS in MACHINE. If no enum is found then return the empty string. */ method format_enum = (string class, uint<16> machine, uint<32> value) string: { fun format_enums = (Enum[] enums) string: { for (e in enums where e.class == class) for (entry in e.entries where entry.value == value) return entry.name; return ""; } var res = format_enums (common_enums); if (res != "") return res; try return format_enums (search_machine (machine).enums); catch if E_inval { return ""; } } /* Get the doc strings of the given item named NAME, which can be an enum or a mask. If CLASS is specified, restrict the search to classes with that name. If a non-negative MACHINE is specified, restrict the search to the common classes and the specific machine. */ method apropos = (string name, string class = "", int<32> machine = -1) string[][]: { var res = string[][](); fun apropos_enums = (Enum[] enums) void: { for (en in enums) { if (class == "" || en.class == class) for (e in en.entries where e.name == name) apush (res, [en.class, e.doc] as string[]); } } fun apropos_masks = (Mask[] masks) void: { for (mask in masks) { if (class == "" || mask.class == class) for (e in mask.entries where e.name == name) apush (res, [mask.class, e.doc] as string[]); } } apropos_enums (common_enums); apropos_masks (common_masks); for (m in machines where machine == -1 || m.machine == machine) { apropos_enums (m.enums); apropos_masks (m.masks); } return res; } }; /* The global database `elf_config' is populated by the several elf-*.pk pickles as they get loaded. */ var elf_config = Elf_Config {}; poke-elf-1.0/Makefile.am0000644000175000017500000000365414602057277012053 00000000000000# ELF pickle for GNU poke # Copyright (C) 2024 Jose E. Marchesi # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . picklesdir = $(datadir)/poke/pickles dist_pickles_DATA = elf.pk \ elf-build.pk \ elf-common.pk \ elf-64.pk elf-32.pk \ elf-config.pk \ elf-mach-x86-64.pk \ elf-mach-aarch64.pk \ elf-mach-mips.pk \ elf-mach-sparc.pk \ elf-mach-bpf.pk \ elf-mach-riscv.pk \ elf-mach-arm.pk \ elf-os-gnu.pk \ elf-os-llvm.pk \ elf-os-linux.pk \ elf-os-openbsd.pk info_TEXINFOS = poke-elf.texi AM_MAKEINFOFLAGS = --set-customization-variable CHECK_NORMAL_MENU_STRUCTURE=true EXTRA_DIST = elf-build.pk.in # Example utilities. dist_bin_SCRIPTS = examples/prelinkr # Running the testsuite. # # Note that it is important to invoke POKE from the same directory # where the pickle's .pk files are, so they are picked up before the # system-installed pickles. EXTRA_DIST += test-elf.pk.in if RUN_TESTS TEST_LOG_DRIVER = env AM_TAP_AWK='$(AWK)' \ $(SHELL) $(top_srcdir)/build-aux/tap-driver.sh TESTS_ENVIRONMENT = POKE_LOAD_PATH=$(top_srcdir) TESTS = test-elf.pk endif poke-elf-1.0/COPYING0000644000175000017500000010451314365270503011041 00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . poke-elf-1.0/elf-os-llvm.pk0000644000175000017500000000703114602057404012471 00000000000000/* elf-os-llvm.pk - ELF LLVM specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* LLVM is not an OS, but it uses the OS-specific ranges for its ELF extensions. Values extracted from the include/llvm/BinaryFormat/ELF.h file in the LLVM source distribution. */ /* LLVM section types. */ var ELF_SHT_LLVM_ODRTAB = 0x6fff4c00U, ELF_SHT_LLVM_LINKER_OPTIONS = 0x6fff4c01U, ELF_SHT_LLVM_ADDRSIG = 0x6fff4c03U, ELF_SHT_LLVM_DEPENDENT_LIBRARIES = 0x6fff4c04U, ELF_SHT_LLVM_SYMPART = 0x6fff4c05U, ELF_SHT_LLVM_PART_EHDR = 0x6fff4c06U, ELF_SHT_LLVM_PART_PHDR = 0x6fff4c07U, ELF_SHT_LLVM_BB_ADDR_MAP_V0 = 0x6fff4c08U, ELF_SHT_LLVM_CALL_GRAPH_PROFILE = 0x6fff4c09U, ELF_SHT_LLVM_BB_ADDR_MAP = 0x6fff4c0aU, ELF_SHT_LLVM_OFFLOADING = 0x6fff4c0bU; elf_config.add_enum :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_LLVM_ODRTAB, name ="llvm-odrtab", doc = "LLVM ODR table" }, Elf_Config_UInt { value = ELF_SHT_LLVM_LINKER_OPTIONS, name = "llvm-linker-options", doc = "LLVM Linker Options" }, Elf_Config_UInt { value = ELF_SHT_LLVM_ADDRSIG, name = "llvm-addrsig", doc = "List of address-significant symbols for safeICF" }, Elf_Config_UInt { value = ELF_SHT_LLVM_DEPENDENT_LIBRARIES, name = "llvm-dependent-libraries", doc = "LLVM Dependend library specifiers" }, Elf_Config_UInt { value = ELF_SHT_LLVM_SYMPART, name = "llvm-sympart", doc = "Symbol partition specification" }, Elf_Config_UInt { value = ELF_SHT_LLVM_PART_EHDR, name = "llvm-part-ehdr", doc = "ELF header for loadable partition" }, Elf_Config_UInt { value = ELF_SHT_LLVM_PART_PHDR, name = "llvm-part-phdr", doc = "Phdrs for loadable partition" }, Elf_Config_UInt { value = ELF_SHT_LLVM_BB_ADDR_MAP_V0, name = "llvm-bb-addr-map-v0", doc = "LLVM basic block address map (old version)" }, Elf_Config_UInt { value = ELF_SHT_LLVM_CALL_GRAPH_PROFILE, name = "llvm-call-graph-profile", doc = "LLVM call graph profile" }, Elf_Config_UInt { value = ELF_SHT_LLVM_BB_ADDR_MAP, name = "llvm-bb-addr-map", doc = "LLVM basic block address map" }, Elf_Config_UInt { value = ELF_SHT_LLVM_OFFLOADING, name = "llvm-offloading", doc = "LLVM device offloading data" }]; /* Contents of sections of type ELF_SHT_LLVM_CALL_GRAPH_PROFILE. */ type Elf_CGProfile = struct { Elf_Word cgp_from; /* Symbol index of the source of the edge. */ Elf_Word cgp_to; /* Symbol index of the destination of the edge. */ uint<64> cgp_weight; /* The weight of the edge. */ }; poke-elf-1.0/stamp-vti0000644000175000017500000000013314602060007011634 00000000000000@set UPDATED 30 March 2024 @set UPDATED-MONTH March 2024 @set EDITION 1.0 @set VERSION 1.0 poke-elf-1.0/configure0000755000175000017500000033266714602057766011742 00000000000000#! /bin/sh # Guess values for system-dependent variables and create Makefiles. # Generated by GNU Autoconf 2.71 for poke-elf 1.0. # # Report bugs to . # # # Copyright (C) 1992-1996, 1998-2017, 2020-2021 Free Software Foundation, # Inc. # # # This configure script is free software; the Free Software Foundation # gives unlimited permission to copy, distribute and modify it. ## -------------------- ## ## M4sh Initialization. ## ## -------------------- ## # Be more Bourne compatible DUALCASE=1; export DUALCASE # for MKS sh as_nop=: if test ${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 then : emulate sh NULLCMD=: # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which # is contrary to our usage. Disable this feature. alias -g '${1+"$@"}'='"$@"' setopt NO_GLOB_SUBST else $as_nop case `(set -o) 2>/dev/null` in #( *posix*) : set -o posix ;; #( *) : ;; esac fi # Reset variables that may have inherited troublesome values from # the environment. # IFS needs to be set, to space, tab, and newline, in precisely that order. # (If _AS_PATH_WALK were called with IFS unset, it would have the # side effect of setting IFS to empty, thus disabling word splitting.) # Quoting is to prevent editors from complaining about space-tab. as_nl=' ' export as_nl IFS=" "" $as_nl" PS1='$ ' PS2='> ' PS4='+ ' # Ensure predictable behavior from utilities with locale-dependent output. LC_ALL=C export LC_ALL LANGUAGE=C export LANGUAGE # We cannot yet rely on "unset" to work, but we need these variables # to be unset--not just set to an empty or harmless value--now, to # avoid bugs in old shells (e.g. pre-3.0 UWIN ksh). This construct # also avoids known problems related to "unset" and subshell syntax # in other old shells (e.g. bash 2.01 and pdksh 5.2.14). for as_var in BASH_ENV ENV MAIL MAILPATH CDPATH do eval test \${$as_var+y} \ && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : done # Ensure that fds 0, 1, and 2 are open. if (exec 3>&0) 2>/dev/null; then :; else exec 0&1) 2>/dev/null; then :; else exec 1>/dev/null; fi if (exec 3>&2) ; then :; else exec 2>/dev/null; fi # The user is always right. if ${PATH_SEPARATOR+false} :; then PATH_SEPARATOR=: (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || PATH_SEPARATOR=';' } fi # Find who we are. Look in the path if we contain no directory separator. as_myself= case $0 in #(( *[\\/]* ) as_myself=$0 ;; *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac test -r "$as_dir$0" && as_myself=$as_dir$0 && break done IFS=$as_save_IFS ;; esac # We did not find ourselves, most probably we were run as `sh COMMAND' # in which case we are not to be found in the path. if test "x$as_myself" = x; then as_myself=$0 fi if test ! -f "$as_myself"; then printf "%s\n" "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 exit 1 fi # Use a proper internal environment variable to ensure we don't fall # into an infinite loop, continuously re-executing ourselves. if test x"${_as_can_reexec}" != xno && test "x$CONFIG_SHELL" != x; then _as_can_reexec=no; export _as_can_reexec; # We cannot yet assume a decent shell, so we have to provide a # neutralization value for shells without unset; and this also # works around shells that cannot unset nonexistent variables. # Preserve -v and -x to the replacement shell. BASH_ENV=/dev/null ENV=/dev/null (unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV case $- in # (((( *v*x* | *x*v* ) as_opts=-vx ;; *v* ) as_opts=-v ;; *x* ) as_opts=-x ;; * ) as_opts= ;; esac exec $CONFIG_SHELL $as_opts "$as_myself" ${1+"$@"} # Admittedly, this is quite paranoid, since all the known shells bail # out after a failed `exec'. printf "%s\n" "$0: could not re-execute with $CONFIG_SHELL" >&2 exit 255 fi # We don't want this to propagate to other subprocesses. { _as_can_reexec=; unset _as_can_reexec;} if test "x$CONFIG_SHELL" = x; then as_bourne_compatible="as_nop=: if test \${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 then : emulate sh NULLCMD=: # Pre-4.2 versions of Zsh do word splitting on \${1+\"\$@\"}, which # is contrary to our usage. Disable this feature. alias -g '\${1+\"\$@\"}'='\"\$@\"' setopt NO_GLOB_SUBST else \$as_nop case \`(set -o) 2>/dev/null\` in #( *posix*) : set -o posix ;; #( *) : ;; esac fi " as_required="as_fn_return () { (exit \$1); } as_fn_success () { as_fn_return 0; } as_fn_failure () { as_fn_return 1; } as_fn_ret_success () { return 0; } as_fn_ret_failure () { return 1; } exitcode=0 as_fn_success || { exitcode=1; echo as_fn_success failed.; } as_fn_failure && { exitcode=1; echo as_fn_failure succeeded.; } as_fn_ret_success || { exitcode=1; echo as_fn_ret_success failed.; } as_fn_ret_failure && { exitcode=1; echo as_fn_ret_failure succeeded.; } if ( set x; as_fn_ret_success y && test x = \"\$1\" ) then : else \$as_nop exitcode=1; echo positional parameters were not saved. fi test x\$exitcode = x0 || exit 1 blah=\$(echo \$(echo blah)) test x\"\$blah\" = xblah || exit 1 test -x / || exit 1" as_suggested=" as_lineno_1=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_1a=\$LINENO as_lineno_2=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_2a=\$LINENO eval 'test \"x\$as_lineno_1'\$as_run'\" != \"x\$as_lineno_2'\$as_run'\" && test \"x\`expr \$as_lineno_1'\$as_run' + 1\`\" = \"x\$as_lineno_2'\$as_run'\"' || exit 1" if (eval "$as_required") 2>/dev/null then : as_have_required=yes else $as_nop as_have_required=no fi if test x$as_have_required = xyes && (eval "$as_suggested") 2>/dev/null then : else $as_nop as_save_IFS=$IFS; IFS=$PATH_SEPARATOR as_found=false for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac as_found=: case $as_dir in #( /*) for as_base in sh bash ksh sh5; do # Try only shells that exist, to save several forks. as_shell=$as_dir$as_base if { test -f "$as_shell" || test -f "$as_shell.exe"; } && as_run=a "$as_shell" -c "$as_bourne_compatible""$as_required" 2>/dev/null then : CONFIG_SHELL=$as_shell as_have_required=yes if as_run=a "$as_shell" -c "$as_bourne_compatible""$as_suggested" 2>/dev/null then : break 2 fi fi done;; esac as_found=false done IFS=$as_save_IFS if $as_found then : else $as_nop if { test -f "$SHELL" || test -f "$SHELL.exe"; } && as_run=a "$SHELL" -c "$as_bourne_compatible""$as_required" 2>/dev/null then : CONFIG_SHELL=$SHELL as_have_required=yes fi fi if test "x$CONFIG_SHELL" != x then : export CONFIG_SHELL # We cannot yet assume a decent shell, so we have to provide a # neutralization value for shells without unset; and this also # works around shells that cannot unset nonexistent variables. # Preserve -v and -x to the replacement shell. BASH_ENV=/dev/null ENV=/dev/null (unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV case $- in # (((( *v*x* | *x*v* ) as_opts=-vx ;; *v* ) as_opts=-v ;; *x* ) as_opts=-x ;; * ) as_opts= ;; esac exec $CONFIG_SHELL $as_opts "$as_myself" ${1+"$@"} # Admittedly, this is quite paranoid, since all the known shells bail # out after a failed `exec'. printf "%s\n" "$0: could not re-execute with $CONFIG_SHELL" >&2 exit 255 fi if test x$as_have_required = xno then : printf "%s\n" "$0: This script requires a shell more modern than all" printf "%s\n" "$0: the shells that I found on your system." if test ${ZSH_VERSION+y} ; then printf "%s\n" "$0: In particular, zsh $ZSH_VERSION has bugs and should" printf "%s\n" "$0: be upgraded to zsh 4.3.4 or later." else printf "%s\n" "$0: Please tell bug-autoconf@gnu.org and poke-devel@gnu.org $0: about your system, including any error possibly output $0: before this message. Then install a modern shell, or $0: manually run the script under such a shell if you do $0: have one." fi exit 1 fi fi fi SHELL=${CONFIG_SHELL-/bin/sh} export SHELL # Unset more variables known to interfere with behavior of common tools. CLICOLOR_FORCE= GREP_OPTIONS= unset CLICOLOR_FORCE GREP_OPTIONS ## --------------------- ## ## M4sh Shell Functions. ## ## --------------------- ## # as_fn_unset VAR # --------------- # Portably unset VAR. as_fn_unset () { { eval $1=; unset $1;} } as_unset=as_fn_unset # as_fn_set_status STATUS # ----------------------- # Set $? to STATUS, without forking. as_fn_set_status () { return $1 } # as_fn_set_status # as_fn_exit STATUS # ----------------- # Exit the shell with STATUS, even in a "trap 0" or "set -e" context. as_fn_exit () { set +e as_fn_set_status $1 exit $1 } # as_fn_exit # as_fn_nop # --------- # Do nothing but, unlike ":", preserve the value of $?. as_fn_nop () { return $? } as_nop=as_fn_nop # as_fn_mkdir_p # ------------- # Create "$as_dir" as a directory, including parents if necessary. as_fn_mkdir_p () { case $as_dir in #( -*) as_dir=./$as_dir;; esac test -d "$as_dir" || eval $as_mkdir_p || { as_dirs= while :; do case $as_dir in #( *\'*) as_qdir=`printf "%s\n" "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( *) as_qdir=$as_dir;; esac as_dirs="'$as_qdir' $as_dirs" as_dir=`$as_dirname -- "$as_dir" || $as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ X"$as_dir" : 'X\(//\)[^/]' \| \ X"$as_dir" : 'X\(//\)$' \| \ X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X"$as_dir" | sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/ q } /^X\(\/\/\)[^/].*/{ s//\1/ q } /^X\(\/\/\)$/{ s//\1/ q } /^X\(\/\).*/{ s//\1/ q } s/.*/./; q'` test -d "$as_dir" && break done test -z "$as_dirs" || eval "mkdir $as_dirs" } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" } # as_fn_mkdir_p # as_fn_executable_p FILE # ----------------------- # Test if FILE is an executable regular file. as_fn_executable_p () { test -f "$1" && test -x "$1" } # as_fn_executable_p # as_fn_append VAR VALUE # ---------------------- # Append the text in VALUE to the end of the definition contained in VAR. Take # advantage of any shell optimizations that allow amortized linear growth over # repeated appends, instead of the typical quadratic growth present in naive # implementations. if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null then : eval 'as_fn_append () { eval $1+=\$2 }' else $as_nop as_fn_append () { eval $1=\$$1\$2 } fi # as_fn_append # as_fn_arith ARG... # ------------------ # Perform arithmetic evaluation on the ARGs, and store the result in the # global $as_val. Take advantage of shells that can avoid forks. The arguments # must be portable across $(()) and expr. if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null then : eval 'as_fn_arith () { as_val=$(( $* )) }' else $as_nop as_fn_arith () { as_val=`expr "$@" || test $? -eq 1` } fi # as_fn_arith # as_fn_nop # --------- # Do nothing but, unlike ":", preserve the value of $?. as_fn_nop () { return $? } as_nop=as_fn_nop # as_fn_error STATUS ERROR [LINENO LOG_FD] # ---------------------------------------- # Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are # provided, also output the error to LOG_FD, referencing LINENO. Then exit the # script with STATUS, using 1 if that was 0. as_fn_error () { as_status=$1; test $as_status -eq 0 && as_status=1 if test "$4"; then as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 fi printf "%s\n" "$as_me: error: $2" >&2 as_fn_exit $as_status } # as_fn_error if expr a : '\(a\)' >/dev/null 2>&1 && test "X`expr 00001 : '.*\(...\)'`" = X001; then as_expr=expr else as_expr=false fi if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then as_basename=basename else as_basename=false fi if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then as_dirname=dirname else as_dirname=false fi as_me=`$as_basename -- "$0" || $as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ X"$0" : 'X\(//\)$' \| \ X"$0" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X/"$0" | sed '/^.*\/\([^/][^/]*\)\/*$/{ s//\1/ q } /^X\/\(\/\/\)$/{ s//\1/ q } /^X\/\(\/\).*/{ s//\1/ q } s/.*/./; q'` # Avoid depending upon Character Ranges. as_cr_letters='abcdefghijklmnopqrstuvwxyz' as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' as_cr_Letters=$as_cr_letters$as_cr_LETTERS as_cr_digits='0123456789' as_cr_alnum=$as_cr_Letters$as_cr_digits as_lineno_1=$LINENO as_lineno_1a=$LINENO as_lineno_2=$LINENO as_lineno_2a=$LINENO eval 'test "x$as_lineno_1'$as_run'" != "x$as_lineno_2'$as_run'" && test "x`expr $as_lineno_1'$as_run' + 1`" = "x$as_lineno_2'$as_run'"' || { # Blame Lee E. McMahon (1931-1989) for sed's syntax. :-) sed -n ' p /[$]LINENO/= ' <$as_myself | sed ' s/[$]LINENO.*/&-/ t lineno b :lineno N :loop s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ t loop s/-\n.*// ' >$as_me.lineno && chmod +x "$as_me.lineno" || { printf "%s\n" "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2; as_fn_exit 1; } # If we had to re-execute with $CONFIG_SHELL, we're ensured to have # already done that, so ensure we don't try to do so again and fall # in an infinite loop. This has already happened in practice. _as_can_reexec=no; export _as_can_reexec # Don't try to exec as it changes $[0], causing all sort of problems # (the dirname of $[0] is not the place where we might find the # original and so on. Autoconf is especially sensitive to this). . "./$as_me.lineno" # Exit status is that of the last command. exit } # Determine whether it's possible to make 'echo' print without a newline. # These variables are no longer used directly by Autoconf, but are AC_SUBSTed # for compatibility with existing Makefiles. ECHO_C= ECHO_N= ECHO_T= case `echo -n x` in #((((( -n*) case `echo 'xy\c'` in *c*) ECHO_T=' ';; # ECHO_T is single tab character. xy) ECHO_C='\c';; *) echo `echo ksh88 bug on AIX 6.1` > /dev/null ECHO_T=' ';; esac;; *) ECHO_N='-n';; esac # For backward compatibility with old third-party macros, we provide # the shell variables $as_echo and $as_echo_n. New code should use # AS_ECHO(["message"]) and AS_ECHO_N(["message"]), respectively. as_echo='printf %s\n' as_echo_n='printf %s' rm -f conf$$ conf$$.exe conf$$.file if test -d conf$$.dir; then rm -f conf$$.dir/conf$$.file else rm -f conf$$.dir mkdir conf$$.dir 2>/dev/null fi if (echo >conf$$.file) 2>/dev/null; then if ln -s conf$$.file conf$$ 2>/dev/null; then as_ln_s='ln -s' # ... but there are two gotchas: # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. # In both cases, we have to default to `cp -pR'. ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || as_ln_s='cp -pR' elif ln conf$$.file conf$$ 2>/dev/null; then as_ln_s=ln else as_ln_s='cp -pR' fi else as_ln_s='cp -pR' fi rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file rmdir conf$$.dir 2>/dev/null if mkdir -p . 2>/dev/null; then as_mkdir_p='mkdir -p "$as_dir"' else test -d ./-p && rmdir ./-p as_mkdir_p=false fi as_test_x='test -x' as_executable_p=as_fn_executable_p # Sed expression to map a string onto a valid CPP name. as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" # Sed expression to map a string onto a valid variable name. as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" test -n "$DJDIR" || exec 7<&0 &1 # Name of the host. # hostname on some systems (SVR3.2, old GNU/Linux) returns a bogus exit status, # so uname gets run too. ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` # # Initializations. # ac_default_prefix=/usr/local ac_clean_files= ac_config_libobj_dir=. LIBOBJS= cross_compiling=no subdirs= MFLAGS= MAKEFLAGS= # Identity of this package. PACKAGE_NAME='poke-elf' PACKAGE_TARNAME='poke-elf' PACKAGE_VERSION='1.0' PACKAGE_STRING='poke-elf 1.0' PACKAGE_BUGREPORT='poke-devel@gnu.org' PACKAGE_URL='https://www.jemarch.net/poke-elf' ac_subst_vars='LTLIBOBJS LIBOBJS RUN_TESTS_FALSE RUN_TESTS_TRUE POKE AM_BACKSLASH AM_DEFAULT_VERBOSITY AM_DEFAULT_V AM_V CSCOPE ETAGS CTAGS am__untar am__tar AMTAR am__leading_dot SET_MAKE AWK mkdir_p MKDIR_P INSTALL_STRIP_PROGRAM STRIP install_sh MAKEINFO AUTOHEADER AUTOMAKE AUTOCONF ACLOCAL VERSION PACKAGE CYGPATH_W am__isrc INSTALL_DATA INSTALL_SCRIPT INSTALL_PROGRAM target_alias host_alias build_alias LIBS ECHO_T ECHO_N ECHO_C DEFS mandir localedir libdir psdir pdfdir dvidir htmldir infodir docdir oldincludedir includedir runstatedir localstatedir sharedstatedir sysconfdir datadir datarootdir libexecdir sbindir bindir program_transform_name prefix exec_prefix PACKAGE_URL PACKAGE_BUGREPORT PACKAGE_STRING PACKAGE_VERSION PACKAGE_TARNAME PACKAGE_NAME PATH_SEPARATOR SHELL' ac_subst_files='' ac_user_opts=' enable_option_checking enable_silent_rules ' ac_precious_vars='build_alias host_alias target_alias' # Initialize some variables set by options. ac_init_help= ac_init_version=false ac_unrecognized_opts= ac_unrecognized_sep= # The variables have the same names as the options, with # dashes changed to underlines. cache_file=/dev/null exec_prefix=NONE no_create= no_recursion= prefix=NONE program_prefix=NONE program_suffix=NONE program_transform_name=s,x,x, silent= site= srcdir= verbose= x_includes=NONE x_libraries=NONE # Installation directory options. # These are left unexpanded so users can "make install exec_prefix=/foo" # and all the variables that are supposed to be based on exec_prefix # by default will actually change. # Use braces instead of parens because sh, perl, etc. also accept them. # (The list follows the same order as the GNU Coding Standards.) bindir='${exec_prefix}/bin' sbindir='${exec_prefix}/sbin' libexecdir='${exec_prefix}/libexec' datarootdir='${prefix}/share' datadir='${datarootdir}' sysconfdir='${prefix}/etc' sharedstatedir='${prefix}/com' localstatedir='${prefix}/var' runstatedir='${localstatedir}/run' includedir='${prefix}/include' oldincludedir='/usr/include' docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' infodir='${datarootdir}/info' htmldir='${docdir}' dvidir='${docdir}' pdfdir='${docdir}' psdir='${docdir}' libdir='${exec_prefix}/lib' localedir='${datarootdir}/locale' mandir='${datarootdir}/man' ac_prev= ac_dashdash= for ac_option do # If the previous option needs an argument, assign it. if test -n "$ac_prev"; then eval $ac_prev=\$ac_option ac_prev= continue fi case $ac_option in *=?*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; *=) ac_optarg= ;; *) ac_optarg=yes ;; esac case $ac_dashdash$ac_option in --) ac_dashdash=yes ;; -bindir | --bindir | --bindi | --bind | --bin | --bi) ac_prev=bindir ;; -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) bindir=$ac_optarg ;; -build | --build | --buil | --bui | --bu) ac_prev=build_alias ;; -build=* | --build=* | --buil=* | --bui=* | --bu=*) build_alias=$ac_optarg ;; -cache-file | --cache-file | --cache-fil | --cache-fi \ | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) ac_prev=cache_file ;; -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) cache_file=$ac_optarg ;; --config-cache | -C) cache_file=config.cache ;; -datadir | --datadir | --datadi | --datad) ac_prev=datadir ;; -datadir=* | --datadir=* | --datadi=* | --datad=*) datadir=$ac_optarg ;; -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ | --dataroo | --dataro | --datar) ac_prev=datarootdir ;; -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) datarootdir=$ac_optarg ;; -disable-* | --disable-*) ac_useropt=`expr "x$ac_option" : 'x-*disable-\(.*\)'` # Reject names that are not valid shell variable names. expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && as_fn_error $? "invalid feature name: \`$ac_useropt'" ac_useropt_orig=$ac_useropt ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` case $ac_user_opts in *" "enable_$ac_useropt" "*) ;; *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--disable-$ac_useropt_orig" ac_unrecognized_sep=', ';; esac eval enable_$ac_useropt=no ;; -docdir | --docdir | --docdi | --doc | --do) ac_prev=docdir ;; -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) docdir=$ac_optarg ;; -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) ac_prev=dvidir ;; -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) dvidir=$ac_optarg ;; -enable-* | --enable-*) ac_useropt=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` # Reject names that are not valid shell variable names. expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && as_fn_error $? "invalid feature name: \`$ac_useropt'" ac_useropt_orig=$ac_useropt ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` case $ac_user_opts in *" "enable_$ac_useropt" "*) ;; *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--enable-$ac_useropt_orig" ac_unrecognized_sep=', ';; esac eval enable_$ac_useropt=\$ac_optarg ;; -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ | --exec | --exe | --ex) ac_prev=exec_prefix ;; -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ | --exec=* | --exe=* | --ex=*) exec_prefix=$ac_optarg ;; -gas | --gas | --ga | --g) # Obsolete; use --with-gas. with_gas=yes ;; -help | --help | --hel | --he | -h) ac_init_help=long ;; -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) ac_init_help=recursive ;; -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) ac_init_help=short ;; -host | --host | --hos | --ho) ac_prev=host_alias ;; -host=* | --host=* | --hos=* | --ho=*) host_alias=$ac_optarg ;; -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) ac_prev=htmldir ;; -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ | --ht=*) htmldir=$ac_optarg ;; -includedir | --includedir | --includedi | --included | --include \ | --includ | --inclu | --incl | --inc) ac_prev=includedir ;; -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ | --includ=* | --inclu=* | --incl=* | --inc=*) includedir=$ac_optarg ;; -infodir | --infodir | --infodi | --infod | --info | --inf) ac_prev=infodir ;; -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) infodir=$ac_optarg ;; -libdir | --libdir | --libdi | --libd) ac_prev=libdir ;; -libdir=* | --libdir=* | --libdi=* | --libd=*) libdir=$ac_optarg ;; -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ | --libexe | --libex | --libe) ac_prev=libexecdir ;; -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ | --libexe=* | --libex=* | --libe=*) libexecdir=$ac_optarg ;; -localedir | --localedir | --localedi | --localed | --locale) ac_prev=localedir ;; -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) localedir=$ac_optarg ;; -localstatedir | --localstatedir | --localstatedi | --localstated \ | --localstate | --localstat | --localsta | --localst | --locals) ac_prev=localstatedir ;; -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) localstatedir=$ac_optarg ;; -mandir | --mandir | --mandi | --mand | --man | --ma | --m) ac_prev=mandir ;; -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) mandir=$ac_optarg ;; -nfp | --nfp | --nf) # Obsolete; use --without-fp. with_fp=no ;; -no-create | --no-create | --no-creat | --no-crea | --no-cre \ | --no-cr | --no-c | -n) no_create=yes ;; -no-recursion | --no-recursion | --no-recursio | --no-recursi \ | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) no_recursion=yes ;; -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ | --oldin | --oldi | --old | --ol | --o) ac_prev=oldincludedir ;; -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) oldincludedir=$ac_optarg ;; -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) ac_prev=prefix ;; -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) prefix=$ac_optarg ;; -program-prefix | --program-prefix | --program-prefi | --program-pref \ | --program-pre | --program-pr | --program-p) ac_prev=program_prefix ;; -program-prefix=* | --program-prefix=* | --program-prefi=* \ | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) program_prefix=$ac_optarg ;; -program-suffix | --program-suffix | --program-suffi | --program-suff \ | --program-suf | --program-su | --program-s) ac_prev=program_suffix ;; -program-suffix=* | --program-suffix=* | --program-suffi=* \ | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) program_suffix=$ac_optarg ;; -program-transform-name | --program-transform-name \ | --program-transform-nam | --program-transform-na \ | --program-transform-n | --program-transform- \ | --program-transform | --program-transfor \ | --program-transfo | --program-transf \ | --program-trans | --program-tran \ | --progr-tra | --program-tr | --program-t) ac_prev=program_transform_name ;; -program-transform-name=* | --program-transform-name=* \ | --program-transform-nam=* | --program-transform-na=* \ | --program-transform-n=* | --program-transform-=* \ | --program-transform=* | --program-transfor=* \ | --program-transfo=* | --program-transf=* \ | --program-trans=* | --program-tran=* \ | --progr-tra=* | --program-tr=* | --program-t=*) program_transform_name=$ac_optarg ;; -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) ac_prev=pdfdir ;; -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) pdfdir=$ac_optarg ;; -psdir | --psdir | --psdi | --psd | --ps) ac_prev=psdir ;; -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) psdir=$ac_optarg ;; -q | -quiet | --quiet | --quie | --qui | --qu | --q \ | -silent | --silent | --silen | --sile | --sil) silent=yes ;; -runstatedir | --runstatedir | --runstatedi | --runstated \ | --runstate | --runstat | --runsta | --runst | --runs \ | --run | --ru | --r) ac_prev=runstatedir ;; -runstatedir=* | --runstatedir=* | --runstatedi=* | --runstated=* \ | --runstate=* | --runstat=* | --runsta=* | --runst=* | --runs=* \ | --run=* | --ru=* | --r=*) runstatedir=$ac_optarg ;; -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) ac_prev=sbindir ;; -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ | --sbi=* | --sb=*) sbindir=$ac_optarg ;; -sharedstatedir | --sharedstatedir | --sharedstatedi \ | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ | --sharedst | --shareds | --shared | --share | --shar \ | --sha | --sh) ac_prev=sharedstatedir ;; -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ | --sha=* | --sh=*) sharedstatedir=$ac_optarg ;; -site | --site | --sit) ac_prev=site ;; -site=* | --site=* | --sit=*) site=$ac_optarg ;; -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) ac_prev=srcdir ;; -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) srcdir=$ac_optarg ;; -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ | --syscon | --sysco | --sysc | --sys | --sy) ac_prev=sysconfdir ;; -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) sysconfdir=$ac_optarg ;; -target | --target | --targe | --targ | --tar | --ta | --t) ac_prev=target_alias ;; -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) target_alias=$ac_optarg ;; -v | -verbose | --verbose | --verbos | --verbo | --verb) verbose=yes ;; -version | --version | --versio | --versi | --vers | -V) ac_init_version=: ;; -with-* | --with-*) ac_useropt=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` # Reject names that are not valid shell variable names. expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && as_fn_error $? "invalid package name: \`$ac_useropt'" ac_useropt_orig=$ac_useropt ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` case $ac_user_opts in *" "with_$ac_useropt" "*) ;; *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--with-$ac_useropt_orig" ac_unrecognized_sep=', ';; esac eval with_$ac_useropt=\$ac_optarg ;; -without-* | --without-*) ac_useropt=`expr "x$ac_option" : 'x-*without-\(.*\)'` # Reject names that are not valid shell variable names. expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && as_fn_error $? "invalid package name: \`$ac_useropt'" ac_useropt_orig=$ac_useropt ac_useropt=`printf "%s\n" "$ac_useropt" | sed 's/[-+.]/_/g'` case $ac_user_opts in *" "with_$ac_useropt" "*) ;; *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--without-$ac_useropt_orig" ac_unrecognized_sep=', ';; esac eval with_$ac_useropt=no ;; --x) # Obsolete; use --with-x. with_x=yes ;; -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ | --x-incl | --x-inc | --x-in | --x-i) ac_prev=x_includes ;; -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) x_includes=$ac_optarg ;; -x-libraries | --x-libraries | --x-librarie | --x-librari \ | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) ac_prev=x_libraries ;; -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) x_libraries=$ac_optarg ;; -*) as_fn_error $? "unrecognized option: \`$ac_option' Try \`$0 --help' for more information" ;; *=*) ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` # Reject names that are not valid shell variable names. case $ac_envvar in #( '' | [0-9]* | *[!_$as_cr_alnum]* ) as_fn_error $? "invalid variable name: \`$ac_envvar'" ;; esac eval $ac_envvar=\$ac_optarg export $ac_envvar ;; *) # FIXME: should be removed in autoconf 3.0. printf "%s\n" "$as_me: WARNING: you should use --build, --host, --target" >&2 expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && printf "%s\n" "$as_me: WARNING: invalid host type: $ac_option" >&2 : "${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option}" ;; esac done if test -n "$ac_prev"; then ac_option=--`echo $ac_prev | sed 's/_/-/g'` as_fn_error $? "missing argument to $ac_option" fi if test -n "$ac_unrecognized_opts"; then case $enable_option_checking in no) ;; fatal) as_fn_error $? "unrecognized options: $ac_unrecognized_opts" ;; *) printf "%s\n" "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2 ;; esac fi # Check all directory arguments for consistency. for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ datadir sysconfdir sharedstatedir localstatedir includedir \ oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ libdir localedir mandir runstatedir do eval ac_val=\$$ac_var # Remove trailing slashes. case $ac_val in */ ) ac_val=`expr "X$ac_val" : 'X\(.*[^/]\)' \| "X$ac_val" : 'X\(.*\)'` eval $ac_var=\$ac_val;; esac # Be sure to have absolute directory names. case $ac_val in [\\/$]* | ?:[\\/]* ) continue;; NONE | '' ) case $ac_var in *prefix ) continue;; esac;; esac as_fn_error $? "expected an absolute directory name for --$ac_var: $ac_val" done # There might be people who depend on the old broken behavior: `$host' # used to hold the argument of --host etc. # FIXME: To remove some day. build=$build_alias host=$host_alias target=$target_alias # FIXME: To remove some day. if test "x$host_alias" != x; then if test "x$build_alias" = x; then cross_compiling=maybe elif test "x$build_alias" != "x$host_alias"; then cross_compiling=yes fi fi ac_tool_prefix= test -n "$host_alias" && ac_tool_prefix=$host_alias- test "$silent" = yes && exec 6>/dev/null ac_pwd=`pwd` && test -n "$ac_pwd" && ac_ls_di=`ls -di .` && ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || as_fn_error $? "working directory cannot be determined" test "X$ac_ls_di" = "X$ac_pwd_ls_di" || as_fn_error $? "pwd does not report name of working directory" # Find the source files, if location was not specified. if test -z "$srcdir"; then ac_srcdir_defaulted=yes # Try the directory containing this script, then the parent directory. ac_confdir=`$as_dirname -- "$as_myself" || $as_expr X"$as_myself" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ X"$as_myself" : 'X\(//\)[^/]' \| \ X"$as_myself" : 'X\(//\)$' \| \ X"$as_myself" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X"$as_myself" | sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/ q } /^X\(\/\/\)[^/].*/{ s//\1/ q } /^X\(\/\/\)$/{ s//\1/ q } /^X\(\/\).*/{ s//\1/ q } s/.*/./; q'` srcdir=$ac_confdir if test ! -r "$srcdir/$ac_unique_file"; then srcdir=.. fi else ac_srcdir_defaulted=no fi if test ! -r "$srcdir/$ac_unique_file"; then test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." as_fn_error $? "cannot find sources ($ac_unique_file) in $srcdir" fi ac_msg="sources are in $srcdir, but \`cd $srcdir' does not work" ac_abs_confdir=`( cd "$srcdir" && test -r "./$ac_unique_file" || as_fn_error $? "$ac_msg" pwd)` # When building in place, set srcdir=. if test "$ac_abs_confdir" = "$ac_pwd"; then srcdir=. fi # Remove unnecessary trailing slashes from srcdir. # Double slashes in file names in object file debugging info # mess up M-x gdb in Emacs. case $srcdir in */) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; esac for ac_var in $ac_precious_vars; do eval ac_env_${ac_var}_set=\${${ac_var}+set} eval ac_env_${ac_var}_value=\$${ac_var} eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} eval ac_cv_env_${ac_var}_value=\$${ac_var} done # # Report the --help message. # if test "$ac_init_help" = "long"; then # Omit some internal or obsolete options to make the list less imposing. # This message is too long to be a string in the A/UX 3.1 sh. cat <<_ACEOF \`configure' configures poke-elf 1.0 to adapt to many kinds of systems. Usage: $0 [OPTION]... [VAR=VALUE]... To assign environment variables (e.g., CC, CFLAGS...), specify them as VAR=VALUE. See below for descriptions of some of the useful variables. Defaults for the options are specified in brackets. Configuration: -h, --help display this help and exit --help=short display options specific to this package --help=recursive display the short help of all the included packages -V, --version display version information and exit -q, --quiet, --silent do not print \`checking ...' messages --cache-file=FILE cache test results in FILE [disabled] -C, --config-cache alias for \`--cache-file=config.cache' -n, --no-create do not create output files --srcdir=DIR find the sources in DIR [configure dir or \`..'] Installation directories: --prefix=PREFIX install architecture-independent files in PREFIX [$ac_default_prefix] --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX [PREFIX] By default, \`make install' will install all the files in \`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify an installation prefix other than \`$ac_default_prefix' using \`--prefix', for instance \`--prefix=\$HOME'. For better control, use the options below. Fine tuning of the installation directories: --bindir=DIR user executables [EPREFIX/bin] --sbindir=DIR system admin executables [EPREFIX/sbin] --libexecdir=DIR program executables [EPREFIX/libexec] --sysconfdir=DIR read-only single-machine data [PREFIX/etc] --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] --localstatedir=DIR modifiable single-machine data [PREFIX/var] --runstatedir=DIR modifiable per-process data [LOCALSTATEDIR/run] --libdir=DIR object code libraries [EPREFIX/lib] --includedir=DIR C header files [PREFIX/include] --oldincludedir=DIR C header files for non-gcc [/usr/include] --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] --datadir=DIR read-only architecture-independent data [DATAROOTDIR] --infodir=DIR info documentation [DATAROOTDIR/info] --localedir=DIR locale-dependent data [DATAROOTDIR/locale] --mandir=DIR man documentation [DATAROOTDIR/man] --docdir=DIR documentation root [DATAROOTDIR/doc/poke-elf] --htmldir=DIR html documentation [DOCDIR] --dvidir=DIR dvi documentation [DOCDIR] --pdfdir=DIR pdf documentation [DOCDIR] --psdir=DIR ps documentation [DOCDIR] _ACEOF cat <<\_ACEOF Program names: --program-prefix=PREFIX prepend PREFIX to installed program names --program-suffix=SUFFIX append SUFFIX to installed program names --program-transform-name=PROGRAM run sed PROGRAM on installed program names _ACEOF fi if test -n "$ac_init_help"; then case $ac_init_help in short | recursive ) echo "Configuration of poke-elf 1.0:";; esac cat <<\_ACEOF Optional Features: --disable-option-checking ignore unrecognized --enable/--with options --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) --enable-FEATURE[=ARG] include FEATURE [ARG=yes] --enable-silent-rules less verbose build output (undo: "make V=1") --disable-silent-rules verbose build output (undo: "make V=0") Report bugs to . poke-elf home page: . _ACEOF ac_status=$? fi if test "$ac_init_help" = "recursive"; then # If there are subdirs, report their specific --help. for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue test -d "$ac_dir" || { cd "$srcdir" && ac_pwd=`pwd` && srcdir=. && test -d "$ac_dir"; } || continue ac_builddir=. case "$ac_dir" in .) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; *) ac_dir_suffix=/`printf "%s\n" "$ac_dir" | sed 's|^\.[\\/]||'` # A ".." for each directory in $ac_dir_suffix. ac_top_builddir_sub=`printf "%s\n" "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` case $ac_top_builddir_sub in "") ac_top_builddir_sub=. ac_top_build_prefix= ;; *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; esac ;; esac ac_abs_top_builddir=$ac_pwd ac_abs_builddir=$ac_pwd$ac_dir_suffix # for backward compatibility: ac_top_builddir=$ac_top_build_prefix case $srcdir in .) # We are building in place. ac_srcdir=. ac_top_srcdir=$ac_top_builddir_sub ac_abs_top_srcdir=$ac_pwd ;; [\\/]* | ?:[\\/]* ) # Absolute name. ac_srcdir=$srcdir$ac_dir_suffix; ac_top_srcdir=$srcdir ac_abs_top_srcdir=$srcdir ;; *) # Relative name. ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix ac_top_srcdir=$ac_top_build_prefix$srcdir ac_abs_top_srcdir=$ac_pwd/$srcdir ;; esac ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix cd "$ac_dir" || { ac_status=$?; continue; } # Check for configure.gnu first; this name is used for a wrapper for # Metaconfig's "Configure" on case-insensitive file systems. if test -f "$ac_srcdir/configure.gnu"; then echo && $SHELL "$ac_srcdir/configure.gnu" --help=recursive elif test -f "$ac_srcdir/configure"; then echo && $SHELL "$ac_srcdir/configure" --help=recursive else printf "%s\n" "$as_me: WARNING: no configuration information is in $ac_dir" >&2 fi || ac_status=$? cd "$ac_pwd" || { ac_status=$?; break; } done fi test -n "$ac_init_help" && exit $ac_status if $ac_init_version; then cat <<\_ACEOF poke-elf configure 1.0 generated by GNU Autoconf 2.71 Copyright (C) 2021 Free Software Foundation, Inc. This configure script is free software; the Free Software Foundation gives unlimited permission to copy, distribute and modify it. _ACEOF exit fi ## ------------------------ ## ## Autoconf initialization. ## ## ------------------------ ## ac_configure_args_raw= for ac_arg do case $ac_arg in *\'*) ac_arg=`printf "%s\n" "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; esac as_fn_append ac_configure_args_raw " '$ac_arg'" done case $ac_configure_args_raw in *$as_nl*) ac_safe_unquote= ;; *) ac_unsafe_z='|&;<>()$`\\"*?[ '' ' # This string ends in space, tab. ac_unsafe_a="$ac_unsafe_z#~" ac_safe_unquote="s/ '\\([^$ac_unsafe_a][^$ac_unsafe_z]*\\)'/ \\1/g" ac_configure_args_raw=` printf "%s\n" "$ac_configure_args_raw" | sed "$ac_safe_unquote"`;; esac cat >config.log <<_ACEOF This file contains any messages produced by compilers while running configure, to aid debugging if configure makes a mistake. It was created by poke-elf $as_me 1.0, which was generated by GNU Autoconf 2.71. Invocation command line was $ $0$ac_configure_args_raw _ACEOF exec 5>>config.log { cat <<_ASUNAME ## --------- ## ## Platform. ## ## --------- ## hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` uname -m = `(uname -m) 2>/dev/null || echo unknown` uname -r = `(uname -r) 2>/dev/null || echo unknown` uname -s = `(uname -s) 2>/dev/null || echo unknown` uname -v = `(uname -v) 2>/dev/null || echo unknown` /usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` /bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` /bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` /usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` /usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` /usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` /bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` /usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` /bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` _ASUNAME as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac printf "%s\n" "PATH: $as_dir" done IFS=$as_save_IFS } >&5 cat >&5 <<_ACEOF ## ----------- ## ## Core tests. ## ## ----------- ## _ACEOF # Keep a trace of the command line. # Strip out --no-create and --no-recursion so they do not pile up. # Strip out --silent because we don't want to record it for future runs. # Also quote any args containing shell meta-characters. # Make two passes to allow for proper duplicate-argument suppression. ac_configure_args= ac_configure_args0= ac_configure_args1= ac_must_keep_next=false for ac_pass in 1 2 do for ac_arg do case $ac_arg in -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; -q | -quiet | --quiet | --quie | --qui | --qu | --q \ | -silent | --silent | --silen | --sile | --sil) continue ;; *\'*) ac_arg=`printf "%s\n" "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; esac case $ac_pass in 1) as_fn_append ac_configure_args0 " '$ac_arg'" ;; 2) as_fn_append ac_configure_args1 " '$ac_arg'" if test $ac_must_keep_next = true; then ac_must_keep_next=false # Got value, back to normal. else case $ac_arg in *=* | --config-cache | -C | -disable-* | --disable-* \ | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ | -with-* | --with-* | -without-* | --without-* | --x) case "$ac_configure_args0 " in "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; esac ;; -* ) ac_must_keep_next=true ;; esac fi as_fn_append ac_configure_args " '$ac_arg'" ;; esac done done { ac_configure_args0=; unset ac_configure_args0;} { ac_configure_args1=; unset ac_configure_args1;} # When interrupted or exit'd, cleanup temporary files, and complete # config.log. We remove comments because anyway the quotes in there # would cause problems or look ugly. # WARNING: Use '\'' to represent an apostrophe within the trap. # WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. trap 'exit_status=$? # Sanitize IFS. IFS=" "" $as_nl" # Save into config.log some information that might help in debugging. { echo printf "%s\n" "## ---------------- ## ## Cache variables. ## ## ---------------- ##" echo # The following way of writing the cache mishandles newlines in values, ( for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do eval ac_val=\$$ac_var case $ac_val in #( *${as_nl}*) case $ac_var in #( *_cv_*) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 printf "%s\n" "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; esac case $ac_var in #( _ | IFS | as_nl) ;; #( BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( *) { eval $ac_var=; unset $ac_var;} ;; esac ;; esac done (set) 2>&1 | case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( *${as_nl}ac_space=\ *) sed -n \ "s/'\''/'\''\\\\'\'''\''/g; s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" ;; #( *) sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" ;; esac | sort ) echo printf "%s\n" "## ----------------- ## ## Output variables. ## ## ----------------- ##" echo for ac_var in $ac_subst_vars do eval ac_val=\$$ac_var case $ac_val in *\'\''*) ac_val=`printf "%s\n" "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; esac printf "%s\n" "$ac_var='\''$ac_val'\''" done | sort echo if test -n "$ac_subst_files"; then printf "%s\n" "## ------------------- ## ## File substitutions. ## ## ------------------- ##" echo for ac_var in $ac_subst_files do eval ac_val=\$$ac_var case $ac_val in *\'\''*) ac_val=`printf "%s\n" "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; esac printf "%s\n" "$ac_var='\''$ac_val'\''" done | sort echo fi if test -s confdefs.h; then printf "%s\n" "## ----------- ## ## confdefs.h. ## ## ----------- ##" echo cat confdefs.h echo fi test "$ac_signal" != 0 && printf "%s\n" "$as_me: caught signal $ac_signal" printf "%s\n" "$as_me: exit $exit_status" } >&5 rm -f core *.core core.conftest.* && rm -f -r conftest* confdefs* conf$$* $ac_clean_files && exit $exit_status ' 0 for ac_signal in 1 2 13 15; do trap 'ac_signal='$ac_signal'; as_fn_exit 1' $ac_signal done ac_signal=0 # confdefs.h avoids OS command line length limits that DEFS can exceed. rm -f -r conftest* confdefs.h printf "%s\n" "/* confdefs.h */" > confdefs.h # Predefined preprocessor variables. printf "%s\n" "#define PACKAGE_NAME \"$PACKAGE_NAME\"" >>confdefs.h printf "%s\n" "#define PACKAGE_TARNAME \"$PACKAGE_TARNAME\"" >>confdefs.h printf "%s\n" "#define PACKAGE_VERSION \"$PACKAGE_VERSION\"" >>confdefs.h printf "%s\n" "#define PACKAGE_STRING \"$PACKAGE_STRING\"" >>confdefs.h printf "%s\n" "#define PACKAGE_BUGREPORT \"$PACKAGE_BUGREPORT\"" >>confdefs.h printf "%s\n" "#define PACKAGE_URL \"$PACKAGE_URL\"" >>confdefs.h # Let the site file select an alternate cache file if it wants to. # Prefer an explicitly selected file to automatically selected ones. if test -n "$CONFIG_SITE"; then ac_site_files="$CONFIG_SITE" elif test "x$prefix" != xNONE; then ac_site_files="$prefix/share/config.site $prefix/etc/config.site" else ac_site_files="$ac_default_prefix/share/config.site $ac_default_prefix/etc/config.site" fi for ac_site_file in $ac_site_files do case $ac_site_file in #( */*) : ;; #( *) : ac_site_file=./$ac_site_file ;; esac if test -f "$ac_site_file" && test -r "$ac_site_file"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: loading site script $ac_site_file" >&5 printf "%s\n" "$as_me: loading site script $ac_site_file" >&6;} sed 's/^/| /' "$ac_site_file" >&5 . "$ac_site_file" \ || { { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 printf "%s\n" "$as_me: error: in \`$ac_pwd':" >&2;} as_fn_error $? "failed to load site script $ac_site_file See \`config.log' for more details" "$LINENO" 5; } fi done if test -r "$cache_file"; then # Some versions of bash will fail to source /dev/null (special files # actually), so we avoid doing that. DJGPP emulates it as a regular file. if test /dev/null != "$cache_file" && test -f "$cache_file"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: loading cache $cache_file" >&5 printf "%s\n" "$as_me: loading cache $cache_file" >&6;} case $cache_file in [\\/]* | ?:[\\/]* ) . "$cache_file";; *) . "./$cache_file";; esac fi else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating cache $cache_file" >&5 printf "%s\n" "$as_me: creating cache $cache_file" >&6;} >$cache_file fi # Auxiliary files required by this configure script. ac_aux_files="tap-driver.sh missing install-sh" # Locations in which to look for auxiliary files. ac_aux_dir_candidates="${srcdir}/build-aux" # Search for a directory containing all of the required auxiliary files, # $ac_aux_files, from the $PATH-style list $ac_aux_dir_candidates. # If we don't find one directory that contains all the files we need, # we report the set of missing files from the *first* directory in # $ac_aux_dir_candidates and give up. ac_missing_aux_files="" ac_first_candidate=: printf "%s\n" "$as_me:${as_lineno-$LINENO}: looking for aux files: $ac_aux_files" >&5 as_save_IFS=$IFS; IFS=$PATH_SEPARATOR as_found=false for as_dir in $ac_aux_dir_candidates do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac as_found=: printf "%s\n" "$as_me:${as_lineno-$LINENO}: trying $as_dir" >&5 ac_aux_dir_found=yes ac_install_sh= for ac_aux in $ac_aux_files do # As a special case, if "install-sh" is required, that requirement # can be satisfied by any of "install-sh", "install.sh", or "shtool", # and $ac_install_sh is set appropriately for whichever one is found. if test x"$ac_aux" = x"install-sh" then if test -f "${as_dir}install-sh"; then printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}install-sh found" >&5 ac_install_sh="${as_dir}install-sh -c" elif test -f "${as_dir}install.sh"; then printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}install.sh found" >&5 ac_install_sh="${as_dir}install.sh -c" elif test -f "${as_dir}shtool"; then printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}shtool found" >&5 ac_install_sh="${as_dir}shtool install -c" else ac_aux_dir_found=no if $ac_first_candidate; then ac_missing_aux_files="${ac_missing_aux_files} install-sh" else break fi fi else if test -f "${as_dir}${ac_aux}"; then printf "%s\n" "$as_me:${as_lineno-$LINENO}: ${as_dir}${ac_aux} found" >&5 else ac_aux_dir_found=no if $ac_first_candidate; then ac_missing_aux_files="${ac_missing_aux_files} ${ac_aux}" else break fi fi fi done if test "$ac_aux_dir_found" = yes; then ac_aux_dir="$as_dir" break fi ac_first_candidate=false as_found=false done IFS=$as_save_IFS if $as_found then : else $as_nop as_fn_error $? "cannot find required auxiliary files:$ac_missing_aux_files" "$LINENO" 5 fi # These three variables are undocumented and unsupported, # and are intended to be withdrawn in a future Autoconf release. # They can cause serious problems if a builder's source tree is in a directory # whose full name contains unusual characters. if test -f "${ac_aux_dir}config.guess"; then ac_config_guess="$SHELL ${ac_aux_dir}config.guess" fi if test -f "${ac_aux_dir}config.sub"; then ac_config_sub="$SHELL ${ac_aux_dir}config.sub" fi if test -f "$ac_aux_dir/configure"; then ac_configure="$SHELL ${ac_aux_dir}configure" fi # Check that the precious variables saved in the cache have kept the same # value. ac_cache_corrupted=false for ac_var in $ac_precious_vars; do eval ac_old_set=\$ac_cv_env_${ac_var}_set eval ac_new_set=\$ac_env_${ac_var}_set eval ac_old_val=\$ac_cv_env_${ac_var}_value eval ac_new_val=\$ac_env_${ac_var}_value case $ac_old_set,$ac_new_set in set,) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 printf "%s\n" "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} ac_cache_corrupted=: ;; ,set) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was not set in the previous run" >&5 printf "%s\n" "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} ac_cache_corrupted=: ;; ,);; *) if test "x$ac_old_val" != "x$ac_new_val"; then # differences in whitespace do not lead to failure. ac_old_val_w=`echo x $ac_old_val` ac_new_val_w=`echo x $ac_new_val` if test "$ac_old_val_w" != "$ac_new_val_w"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' has changed since the previous run:" >&5 printf "%s\n" "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} ac_cache_corrupted=: else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&5 printf "%s\n" "$as_me: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&2;} eval $ac_var=\$ac_old_val fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: former value: \`$ac_old_val'" >&5 printf "%s\n" "$as_me: former value: \`$ac_old_val'" >&2;} { printf "%s\n" "$as_me:${as_lineno-$LINENO}: current value: \`$ac_new_val'" >&5 printf "%s\n" "$as_me: current value: \`$ac_new_val'" >&2;} fi;; esac # Pass precious variables to config.status. if test "$ac_new_set" = set; then case $ac_new_val in *\'*) ac_arg=$ac_var=`printf "%s\n" "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; *) ac_arg=$ac_var=$ac_new_val ;; esac case " $ac_configure_args " in *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. *) as_fn_append ac_configure_args " '$ac_arg'" ;; esac fi done if $ac_cache_corrupted; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 printf "%s\n" "$as_me: error: in \`$ac_pwd':" >&2;} { printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: changes in the environment can compromise the build" >&5 printf "%s\n" "$as_me: error: changes in the environment can compromise the build" >&2;} as_fn_error $? "run \`${MAKE-make} distclean' and/or \`rm $cache_file' and start over" "$LINENO" 5 fi ## -------------------- ## ## Main body of script. ## ## -------------------- ## ac_ext=c ac_cpp='$CPP $CPPFLAGS' ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' ac_compiler_gnu=$ac_cv_c_compiler_gnu am__api_version='1.16' # Find a good install program. We prefer a C program (faster), # so one script is as good as another. But avoid the broken or # incompatible versions: # SysV /etc/install, /usr/sbin/install # SunOS /usr/etc/install # IRIX /sbin/install # AIX /bin/install # AmigaOS /C/install, which installs bootblocks on floppy discs # AIX 4 /usr/bin/installbsd, which doesn't work without a -g flag # AFS /usr/afsws/bin/install, which mishandles nonexistent args # SVR4 /usr/ucb/install, which tries to use the nonexistent group "staff" # OS/2's system install, which has a completely different semantic # ./install, which can be erroneously created by make from ./install.sh. # Reject install programs that cannot install multiple files. { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for a BSD-compatible install" >&5 printf %s "checking for a BSD-compatible install... " >&6; } if test -z "$INSTALL"; then if test ${ac_cv_path_install+y} then : printf %s "(cached) " >&6 else $as_nop as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac # Account for fact that we put trailing slashes in our PATH walk. case $as_dir in #(( ./ | /[cC]/* | \ /etc/* | /usr/sbin/* | /usr/etc/* | /sbin/* | /usr/afsws/bin/* | \ ?:[\\/]os2[\\/]install[\\/]* | ?:[\\/]OS2[\\/]INSTALL[\\/]* | \ /usr/ucb/* ) ;; *) # OSF1 and SCO ODT 3.0 have their own names for install. # Don't use installbsd from OSF since it installs stuff as root # by default. for ac_prog in ginstall scoinst install; do for ac_exec_ext in '' $ac_executable_extensions; do if as_fn_executable_p "$as_dir$ac_prog$ac_exec_ext"; then if test $ac_prog = install && grep dspmsg "$as_dir$ac_prog$ac_exec_ext" >/dev/null 2>&1; then # AIX install. It has an incompatible calling convention. : elif test $ac_prog = install && grep pwplus "$as_dir$ac_prog$ac_exec_ext" >/dev/null 2>&1; then # program-specific install script used by HP pwplus--don't use. : else rm -rf conftest.one conftest.two conftest.dir echo one > conftest.one echo two > conftest.two mkdir conftest.dir if "$as_dir$ac_prog$ac_exec_ext" -c conftest.one conftest.two "`pwd`/conftest.dir/" && test -s conftest.one && test -s conftest.two && test -s conftest.dir/conftest.one && test -s conftest.dir/conftest.two then ac_cv_path_install="$as_dir$ac_prog$ac_exec_ext -c" break 3 fi fi fi done done ;; esac done IFS=$as_save_IFS rm -rf conftest.one conftest.two conftest.dir fi if test ${ac_cv_path_install+y}; then INSTALL=$ac_cv_path_install else # As a last resort, use the slow shell script. Don't cache a # value for INSTALL within a source directory, because that will # break other packages using the cache if that directory is # removed, or if the value is a relative name. INSTALL=$ac_install_sh fi fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $INSTALL" >&5 printf "%s\n" "$INSTALL" >&6; } # Use test -z because SunOS4 sh mishandles braces in ${var-val}. # It thinks the first close brace ends the variable substitution. test -z "$INSTALL_PROGRAM" && INSTALL_PROGRAM='${INSTALL}' test -z "$INSTALL_SCRIPT" && INSTALL_SCRIPT='${INSTALL}' test -z "$INSTALL_DATA" && INSTALL_DATA='${INSTALL} -m 644' { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether build environment is sane" >&5 printf %s "checking whether build environment is sane... " >&6; } # Reject unsafe characters in $srcdir or the absolute working directory # name. Accept space and tab only in the latter. am_lf=' ' case `pwd` in *[\\\"\#\$\&\'\`$am_lf]*) as_fn_error $? "unsafe absolute working directory name" "$LINENO" 5;; esac case $srcdir in *[\\\"\#\$\&\'\`$am_lf\ \ ]*) as_fn_error $? "unsafe srcdir value: '$srcdir'" "$LINENO" 5;; esac # Do 'set' in a subshell so we don't clobber the current shell's # arguments. Must try -L first in case configure is actually a # symlink; some systems play weird games with the mod time of symlinks # (eg FreeBSD returns the mod time of the symlink's containing # directory). if ( am_has_slept=no for am_try in 1 2; do echo "timestamp, slept: $am_has_slept" > conftest.file set X `ls -Lt "$srcdir/configure" conftest.file 2> /dev/null` if test "$*" = "X"; then # -L didn't work. set X `ls -t "$srcdir/configure" conftest.file` fi if test "$*" != "X $srcdir/configure conftest.file" \ && test "$*" != "X conftest.file $srcdir/configure"; then # If neither matched, then we have a broken ls. This can happen # if, for instance, CONFIG_SHELL is bash and it inherits a # broken ls alias from the environment. This has actually # happened. Such a system could not be considered "sane". as_fn_error $? "ls -t appears to fail. Make sure there is not a broken alias in your environment" "$LINENO" 5 fi if test "$2" = conftest.file || test $am_try -eq 2; then break fi # Just in case. sleep 1 am_has_slept=yes done test "$2" = conftest.file ) then # Ok. : else as_fn_error $? "newly created file is older than distributed files! Check your system clock" "$LINENO" 5 fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 printf "%s\n" "yes" >&6; } # If we didn't sleep, we still need to ensure time stamps of config.status and # generated files are strictly newer. am_sleep_pid= if grep 'slept: no' conftest.file >/dev/null 2>&1; then ( sleep 1 ) & am_sleep_pid=$! fi rm -f conftest.file test "$program_prefix" != NONE && program_transform_name="s&^&$program_prefix&;$program_transform_name" # Use a double $ so make ignores it. test "$program_suffix" != NONE && program_transform_name="s&\$&$program_suffix&;$program_transform_name" # Double any \ or $. # By default was `s,x,x', remove it if useless. ac_script='s/[\\$]/&&/g;s/;s,x,x,$//' program_transform_name=`printf "%s\n" "$program_transform_name" | sed "$ac_script"` # Expand $ac_aux_dir to an absolute path. am_aux_dir=`cd "$ac_aux_dir" && pwd` if test x"${MISSING+set}" != xset; then MISSING="\${SHELL} '$am_aux_dir/missing'" fi # Use eval to expand $SHELL if eval "$MISSING --is-lightweight"; then am_missing_run="$MISSING " else am_missing_run= { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: 'missing' script is too old or missing" >&5 printf "%s\n" "$as_me: WARNING: 'missing' script is too old or missing" >&2;} fi if test x"${install_sh+set}" != xset; then case $am_aux_dir in *\ * | *\ *) install_sh="\${SHELL} '$am_aux_dir/install-sh'" ;; *) install_sh="\${SHELL} $am_aux_dir/install-sh" esac fi # Installed binaries are usually stripped using 'strip' when the user # run "make install-strip". However 'strip' might not be the right # tool to use in cross-compilation environments, therefore Automake # will honor the 'STRIP' environment variable to overrule this program. if test "$cross_compiling" != no; then if test -n "$ac_tool_prefix"; then # Extract the first word of "${ac_tool_prefix}strip", so it can be a program name with args. set dummy ${ac_tool_prefix}strip; ac_word=$2 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 printf %s "checking for $ac_word... " >&6; } if test ${ac_cv_prog_STRIP+y} then : printf %s "(cached) " >&6 else $as_nop if test -n "$STRIP"; then ac_cv_prog_STRIP="$STRIP" # Let the user override the test. else as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac for ac_exec_ext in '' $ac_executable_extensions; do if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then ac_cv_prog_STRIP="${ac_tool_prefix}strip" printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 break 2 fi done done IFS=$as_save_IFS fi fi STRIP=$ac_cv_prog_STRIP if test -n "$STRIP"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $STRIP" >&5 printf "%s\n" "$STRIP" >&6; } else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 printf "%s\n" "no" >&6; } fi fi if test -z "$ac_cv_prog_STRIP"; then ac_ct_STRIP=$STRIP # Extract the first word of "strip", so it can be a program name with args. set dummy strip; ac_word=$2 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 printf %s "checking for $ac_word... " >&6; } if test ${ac_cv_prog_ac_ct_STRIP+y} then : printf %s "(cached) " >&6 else $as_nop if test -n "$ac_ct_STRIP"; then ac_cv_prog_ac_ct_STRIP="$ac_ct_STRIP" # Let the user override the test. else as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac for ac_exec_ext in '' $ac_executable_extensions; do if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then ac_cv_prog_ac_ct_STRIP="strip" printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 break 2 fi done done IFS=$as_save_IFS fi fi ac_ct_STRIP=$ac_cv_prog_ac_ct_STRIP if test -n "$ac_ct_STRIP"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_ct_STRIP" >&5 printf "%s\n" "$ac_ct_STRIP" >&6; } else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 printf "%s\n" "no" >&6; } fi if test "x$ac_ct_STRIP" = x; then STRIP=":" else case $cross_compiling:$ac_tool_warned in yes:) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 printf "%s\n" "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} ac_tool_warned=yes ;; esac STRIP=$ac_ct_STRIP fi else STRIP="$ac_cv_prog_STRIP" fi fi INSTALL_STRIP_PROGRAM="\$(install_sh) -c -s" { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for a race-free mkdir -p" >&5 printf %s "checking for a race-free mkdir -p... " >&6; } if test -z "$MKDIR_P"; then if test ${ac_cv_path_mkdir+y} then : printf %s "(cached) " >&6 else $as_nop as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH$PATH_SEPARATOR/opt/sfw/bin do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac for ac_prog in mkdir gmkdir; do for ac_exec_ext in '' $ac_executable_extensions; do as_fn_executable_p "$as_dir$ac_prog$ac_exec_ext" || continue case `"$as_dir$ac_prog$ac_exec_ext" --version 2>&1` in #( 'mkdir ('*'coreutils) '* | \ 'BusyBox '* | \ 'mkdir (fileutils) '4.1*) ac_cv_path_mkdir=$as_dir$ac_prog$ac_exec_ext break 3;; esac done done done IFS=$as_save_IFS fi test -d ./--version && rmdir ./--version if test ${ac_cv_path_mkdir+y}; then MKDIR_P="$ac_cv_path_mkdir -p" else # As a last resort, use the slow shell script. Don't cache a # value for MKDIR_P within a source directory, because that will # break other packages using the cache if that directory is # removed, or if the value is a relative name. MKDIR_P="$ac_install_sh -d" fi fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $MKDIR_P" >&5 printf "%s\n" "$MKDIR_P" >&6; } for ac_prog in gawk mawk nawk awk do # Extract the first word of "$ac_prog", so it can be a program name with args. set dummy $ac_prog; ac_word=$2 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 printf %s "checking for $ac_word... " >&6; } if test ${ac_cv_prog_AWK+y} then : printf %s "(cached) " >&6 else $as_nop if test -n "$AWK"; then ac_cv_prog_AWK="$AWK" # Let the user override the test. else as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac for ac_exec_ext in '' $ac_executable_extensions; do if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then ac_cv_prog_AWK="$ac_prog" printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 break 2 fi done done IFS=$as_save_IFS fi fi AWK=$ac_cv_prog_AWK if test -n "$AWK"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $AWK" >&5 printf "%s\n" "$AWK" >&6; } else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 printf "%s\n" "no" >&6; } fi test -n "$AWK" && break done { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether ${MAKE-make} sets \$(MAKE)" >&5 printf %s "checking whether ${MAKE-make} sets \$(MAKE)... " >&6; } set x ${MAKE-make} ac_make=`printf "%s\n" "$2" | sed 's/+/p/g; s/[^a-zA-Z0-9_]/_/g'` if eval test \${ac_cv_prog_make_${ac_make}_set+y} then : printf %s "(cached) " >&6 else $as_nop cat >conftest.make <<\_ACEOF SHELL = /bin/sh all: @echo '@@@%%%=$(MAKE)=@@@%%%' _ACEOF # GNU make sometimes prints "make[1]: Entering ...", which would confuse us. case `${MAKE-make} -f conftest.make 2>/dev/null` in *@@@%%%=?*=@@@%%%*) eval ac_cv_prog_make_${ac_make}_set=yes;; *) eval ac_cv_prog_make_${ac_make}_set=no;; esac rm -f conftest.make fi if eval test \$ac_cv_prog_make_${ac_make}_set = yes; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5 printf "%s\n" "yes" >&6; } SET_MAKE= else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 printf "%s\n" "no" >&6; } SET_MAKE="MAKE=${MAKE-make}" fi rm -rf .tst 2>/dev/null mkdir .tst 2>/dev/null if test -d .tst; then am__leading_dot=. else am__leading_dot=_ fi rmdir .tst 2>/dev/null # Check whether --enable-silent-rules was given. if test ${enable_silent_rules+y} then : enableval=$enable_silent_rules; fi case $enable_silent_rules in # ((( yes) AM_DEFAULT_VERBOSITY=0;; no) AM_DEFAULT_VERBOSITY=1;; *) AM_DEFAULT_VERBOSITY=1;; esac am_make=${MAKE-make} { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether $am_make supports nested variables" >&5 printf %s "checking whether $am_make supports nested variables... " >&6; } if test ${am_cv_make_support_nested_variables+y} then : printf %s "(cached) " >&6 else $as_nop if printf "%s\n" 'TRUE=$(BAR$(V)) BAR0=false BAR1=true V=1 am__doit: @$(TRUE) .PHONY: am__doit' | $am_make -f - >/dev/null 2>&1; then am_cv_make_support_nested_variables=yes else am_cv_make_support_nested_variables=no fi fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $am_cv_make_support_nested_variables" >&5 printf "%s\n" "$am_cv_make_support_nested_variables" >&6; } if test $am_cv_make_support_nested_variables = yes; then AM_V='$(V)' AM_DEFAULT_V='$(AM_DEFAULT_VERBOSITY)' else AM_V=$AM_DEFAULT_VERBOSITY AM_DEFAULT_V=$AM_DEFAULT_VERBOSITY fi AM_BACKSLASH='\' if test "`cd $srcdir && pwd`" != "`pwd`"; then # Use -I$(srcdir) only when $(srcdir) != ., so that make's output # is not polluted with repeated "-I." am__isrc=' -I$(srcdir)' # test to see if srcdir already configured if test -f $srcdir/config.status; then as_fn_error $? "source directory already configured; run \"make distclean\" there first" "$LINENO" 5 fi fi # test whether we have cygpath if test -z "$CYGPATH_W"; then if (cygpath --version) >/dev/null 2>/dev/null; then CYGPATH_W='cygpath -w' else CYGPATH_W=echo fi fi # Define the identity of the package. PACKAGE='poke-elf' VERSION='1.0' printf "%s\n" "#define PACKAGE \"$PACKAGE\"" >>confdefs.h printf "%s\n" "#define VERSION \"$VERSION\"" >>confdefs.h # Some tools Automake needs. ACLOCAL=${ACLOCAL-"${am_missing_run}aclocal-${am__api_version}"} AUTOCONF=${AUTOCONF-"${am_missing_run}autoconf"} AUTOMAKE=${AUTOMAKE-"${am_missing_run}automake-${am__api_version}"} AUTOHEADER=${AUTOHEADER-"${am_missing_run}autoheader"} MAKEINFO=${MAKEINFO-"${am_missing_run}makeinfo"} # For better backward compatibility. To be removed once Automake 1.9.x # dies out for good. For more background, see: # # mkdir_p='$(MKDIR_P)' # We need awk for the "check" target (and possibly the TAP driver). The # system "awk" is bad on some platforms. # Always define AMTAR for backward compatibility. Yes, it's still used # in the wild :-( We should find a proper way to deprecate it ... AMTAR='$${TAR-tar}' # We'll loop over all known methods to create a tar archive until one works. _am_tools='gnutar pax cpio none' am__tar='$${TAR-tar} chof - "$$tardir"' am__untar='$${TAR-tar} xf -' # Variables for tags utilities; see am/tags.am if test -z "$CTAGS"; then CTAGS=ctags fi if test -z "$ETAGS"; then ETAGS=etags fi if test -z "$CSCOPE"; then CSCOPE=cscope fi # POSIX will say in a future version that running "rm -f" with no argument # is OK; and we want to be able to make that assumption in our Makefile # recipes. So use an aggressive probe to check that the usage we want is # actually supported "in the wild" to an acceptable degree. # See automake bug#10828. # To make any issue more visible, cause the running configure to be aborted # by default if the 'rm' program in use doesn't match our expectations; the # user can still override this though. if rm -f && rm -fr && rm -rf; then : OK; else cat >&2 <<'END' Oops! Your 'rm' program seems unable to run without file operands specified on the command line, even when the '-f' option is present. This is contrary to the behaviour of most rm programs out there, and not conforming with the upcoming POSIX standard: Please tell bug-automake@gnu.org about your system, including the value of your $PATH and any error possibly output before this message. This can help us improve future automake versions. END if test x"$ACCEPT_INFERIOR_RM_PROGRAM" = x"yes"; then echo 'Configuration will proceed anyway, since you have set the' >&2 echo 'ACCEPT_INFERIOR_RM_PROGRAM variable to "yes"' >&2 echo >&2 else cat >&2 <<'END' Aborting the configuration process, to ensure you take notice of the issue. You can download and install GNU coreutils to get an 'rm' implementation that behaves properly: . If you want to complete the configuration process using your problematic 'rm' anyway, export the environment variable ACCEPT_INFERIOR_RM_PROGRAM to "yes", and re-run configure. END as_fn_error $? "Your 'rm' program is bad, sorry." "$LINENO" 5 fi fi run_pickle_tests=no # Extract the first word of "poke", so it can be a program name with args. set dummy poke; ac_word=$2 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 printf %s "checking for $ac_word... " >&6; } if test ${ac_cv_path_POKE+y} then : printf %s "(cached) " >&6 else $as_nop case $POKE in [\\/]* | ?:[\\/]*) ac_cv_path_POKE="$POKE" # Let the user override the test with a path. ;; *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac for ac_exec_ext in '' $ac_executable_extensions; do if as_fn_executable_p "$as_dir$ac_word$ac_exec_ext"; then ac_cv_path_POKE="$as_dir$ac_word$ac_exec_ext" printf "%s\n" "$as_me:${as_lineno-$LINENO}: found $as_dir$ac_word$ac_exec_ext" >&5 break 2 fi done done IFS=$as_save_IFS ;; esac fi POKE=$ac_cv_path_POKE if test -n "$POKE"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $POKE" >&5 printf "%s\n" "$POKE" >&6; } else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: no" >&5 printf "%s\n" "no" >&6; } fi if test -z "$POKE"; then ac_verc_fail=yes else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking for poke 4.0 or newer" >&5 printf %s "checking for poke 4.0 or newer... " >&6; } # First see if poke is old enough to have pk_version. cat >conftest.pk <<_ACEOF pk_version; _ACEOF ac_poke_has_pk_version=no if $POKE -L conftest.pk 2>&1 >/dev/null; then ac_poke_has_pk_version=yes fi if test "x$ac_poke_has_pk_version" = "xyes"; then cat >conftest.pk <<_ACEOF exit ((pk_vercmp (pk_version_parse (pk_version), pk_version_parse ("4.0")) >= 0) ? 0 : 1); _ACEOF ac_prog_version=`$POKE --version 2>&1 | sed -n 's/^.*GNU poke.* \(.*$\)/\1/p'` if $POKE -L conftest.pk 2>&1 >/dev/null; then ac_prog_version="$ac_prog_version, ok" ac_verc_fail=no else ac_prog_version="$ac_prog_version, bad" ac_verc_fail=yes fi else ac_prog_version="unknown" fi rm -f conftest.pk { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_prog_version" >&5 printf "%s\n" "$ac_prog_version" >&6; } fi if test $ac_verc_fail = yes; then POKE=: fi if test "x$POKE" != "x:"; then have_pktest=no cat >conftest.pk <<_ACEOF load "pktest.pk"; _ACEOF { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking whether poke can load pickle pktest.pk" >&5 printf %s "checking whether poke can load pickle pktest.pk... " >&6; } ac_pickle_found= if $POKE -L conftest.pk 2>&1 >/dev/null; then ac_pickle_found=yes run_pickle_tests=yes else ac_pickle_found=no fi rm -f conftest.pk { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $ac_pickle_found" >&5 printf "%s\n" "$ac_pickle_found" >&6; } fi if test "x$run_pickle_tests" = "xyes"; then RUN_TESTS_TRUE= RUN_TESTS_FALSE='#' else RUN_TESTS_TRUE='#' RUN_TESTS_FALSE= fi ac_config_files="$ac_config_files Makefile elf-build.pk" ac_config_files="$ac_config_files test-elf.pk" cat >confcache <<\_ACEOF # This file is a shell script that caches the results of configure # tests run on this system so they can be shared between configure # scripts and configure runs, see configure's option --config-cache. # It is not useful on other systems. If it contains results you don't # want to keep, you may remove or edit it. # # config.status only pays attention to the cache file if you give it # the --recheck option to rerun configure. # # `ac_cv_env_foo' variables (set or unset) will be overridden when # loading this file, other *unset* `ac_cv_foo' will be assigned the # following values. _ACEOF # The following way of writing the cache mishandles newlines in values, # but we know of no workaround that is simple, portable, and efficient. # So, we kill variables containing newlines. # Ultrix sh set writes to stderr and can't be redirected directly, # and sets the high bit in the cache file unless we assign to the vars. ( for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do eval ac_val=\$$ac_var case $ac_val in #( *${as_nl}*) case $ac_var in #( *_cv_*) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 printf "%s\n" "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; esac case $ac_var in #( _ | IFS | as_nl) ;; #( BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( *) { eval $ac_var=; unset $ac_var;} ;; esac ;; esac done (set) 2>&1 | case $as_nl`(ac_space=' '; set) 2>&1` in #( *${as_nl}ac_space=\ *) # `set' does not quote correctly, so add quotes: double-quote # substitution turns \\\\ into \\, and sed turns \\ into \. sed -n \ "s/'/'\\\\''/g; s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" ;; #( *) # `set' quotes correctly as required by POSIX, so do not add quotes. sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" ;; esac | sort ) | sed ' /^ac_cv_env_/b end t clear :clear s/^\([^=]*\)=\(.*[{}].*\)$/test ${\1+y} || &/ t end s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ :end' >>confcache if diff "$cache_file" confcache >/dev/null 2>&1; then :; else if test -w "$cache_file"; then if test "x$cache_file" != "x/dev/null"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: updating cache $cache_file" >&5 printf "%s\n" "$as_me: updating cache $cache_file" >&6;} if test ! -f "$cache_file" || test -h "$cache_file"; then cat confcache >"$cache_file" else case $cache_file in #( */* | ?:*) mv -f confcache "$cache_file"$$ && mv -f "$cache_file"$$ "$cache_file" ;; #( *) mv -f confcache "$cache_file" ;; esac fi fi else { printf "%s\n" "$as_me:${as_lineno-$LINENO}: not updating unwritable cache $cache_file" >&5 printf "%s\n" "$as_me: not updating unwritable cache $cache_file" >&6;} fi fi rm -f confcache test "x$prefix" = xNONE && prefix=$ac_default_prefix # Let make expand exec_prefix. test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' # Transform confdefs.h into DEFS. # Protect against shell expansion while executing Makefile rules. # Protect against Makefile macro expansion. # # If the first sed substitution is executed (which looks for macros that # take arguments), then branch to the quote section. Otherwise, # look for a macro that doesn't take arguments. ac_script=' :mline /\\$/{ N s,\\\n,, b mline } t clear :clear s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g t quote s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g t quote b any :quote s/[ `~#$^&*(){}\\|;'\''"<>?]/\\&/g s/\[/\\&/g s/\]/\\&/g s/\$/$$/g H :any ${ g s/^\n// s/\n/ /g p } ' DEFS=`sed -n "$ac_script" confdefs.h` ac_libobjs= ac_ltlibobjs= U= for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue # 1. Remove the extension, and $U if already installed. ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' ac_i=`printf "%s\n" "$ac_i" | sed "$ac_script"` # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR # will be set to the directory where LIBOBJS objects are built. as_fn_append ac_libobjs " \${LIBOBJDIR}$ac_i\$U.$ac_objext" as_fn_append ac_ltlibobjs " \${LIBOBJDIR}$ac_i"'$U.lo' done LIBOBJS=$ac_libobjs LTLIBOBJS=$ac_ltlibobjs { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking that generated files are newer than configure" >&5 printf %s "checking that generated files are newer than configure... " >&6; } if test -n "$am_sleep_pid"; then # Hide warnings about reused PIDs. wait $am_sleep_pid 2>/dev/null fi { printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: done" >&5 printf "%s\n" "done" >&6; } if test -z "${RUN_TESTS_TRUE}" && test -z "${RUN_TESTS_FALSE}"; then as_fn_error $? "conditional \"RUN_TESTS\" was never defined. Usually this means the macro was only invoked conditionally." "$LINENO" 5 fi : "${CONFIG_STATUS=./config.status}" ac_write_fail=0 ac_clean_files_save=$ac_clean_files ac_clean_files="$ac_clean_files $CONFIG_STATUS" { printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating $CONFIG_STATUS" >&5 printf "%s\n" "$as_me: creating $CONFIG_STATUS" >&6;} as_write_fail=0 cat >$CONFIG_STATUS <<_ASEOF || as_write_fail=1 #! $SHELL # Generated by $as_me. # Run this file to recreate the current configuration. # Compiler output produced by configure, useful for debugging # configure, is in config.log if it exists. debug=false ac_cs_recheck=false ac_cs_silent=false SHELL=\${CONFIG_SHELL-$SHELL} export SHELL _ASEOF cat >>$CONFIG_STATUS <<\_ASEOF || as_write_fail=1 ## -------------------- ## ## M4sh Initialization. ## ## -------------------- ## # Be more Bourne compatible DUALCASE=1; export DUALCASE # for MKS sh as_nop=: if test ${ZSH_VERSION+y} && (emulate sh) >/dev/null 2>&1 then : emulate sh NULLCMD=: # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which # is contrary to our usage. Disable this feature. alias -g '${1+"$@"}'='"$@"' setopt NO_GLOB_SUBST else $as_nop case `(set -o) 2>/dev/null` in #( *posix*) : set -o posix ;; #( *) : ;; esac fi # Reset variables that may have inherited troublesome values from # the environment. # IFS needs to be set, to space, tab, and newline, in precisely that order. # (If _AS_PATH_WALK were called with IFS unset, it would have the # side effect of setting IFS to empty, thus disabling word splitting.) # Quoting is to prevent editors from complaining about space-tab. as_nl=' ' export as_nl IFS=" "" $as_nl" PS1='$ ' PS2='> ' PS4='+ ' # Ensure predictable behavior from utilities with locale-dependent output. LC_ALL=C export LC_ALL LANGUAGE=C export LANGUAGE # We cannot yet rely on "unset" to work, but we need these variables # to be unset--not just set to an empty or harmless value--now, to # avoid bugs in old shells (e.g. pre-3.0 UWIN ksh). This construct # also avoids known problems related to "unset" and subshell syntax # in other old shells (e.g. bash 2.01 and pdksh 5.2.14). for as_var in BASH_ENV ENV MAIL MAILPATH CDPATH do eval test \${$as_var+y} \ && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : done # Ensure that fds 0, 1, and 2 are open. if (exec 3>&0) 2>/dev/null; then :; else exec 0&1) 2>/dev/null; then :; else exec 1>/dev/null; fi if (exec 3>&2) ; then :; else exec 2>/dev/null; fi # The user is always right. if ${PATH_SEPARATOR+false} :; then PATH_SEPARATOR=: (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || PATH_SEPARATOR=';' } fi # Find who we are. Look in the path if we contain no directory separator. as_myself= case $0 in #(( *[\\/]* ) as_myself=$0 ;; *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR for as_dir in $PATH do IFS=$as_save_IFS case $as_dir in #((( '') as_dir=./ ;; */) ;; *) as_dir=$as_dir/ ;; esac test -r "$as_dir$0" && as_myself=$as_dir$0 && break done IFS=$as_save_IFS ;; esac # We did not find ourselves, most probably we were run as `sh COMMAND' # in which case we are not to be found in the path. if test "x$as_myself" = x; then as_myself=$0 fi if test ! -f "$as_myself"; then printf "%s\n" "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 exit 1 fi # as_fn_error STATUS ERROR [LINENO LOG_FD] # ---------------------------------------- # Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are # provided, also output the error to LOG_FD, referencing LINENO. Then exit the # script with STATUS, using 1 if that was 0. as_fn_error () { as_status=$1; test $as_status -eq 0 && as_status=1 if test "$4"; then as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack printf "%s\n" "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 fi printf "%s\n" "$as_me: error: $2" >&2 as_fn_exit $as_status } # as_fn_error # as_fn_set_status STATUS # ----------------------- # Set $? to STATUS, without forking. as_fn_set_status () { return $1 } # as_fn_set_status # as_fn_exit STATUS # ----------------- # Exit the shell with STATUS, even in a "trap 0" or "set -e" context. as_fn_exit () { set +e as_fn_set_status $1 exit $1 } # as_fn_exit # as_fn_unset VAR # --------------- # Portably unset VAR. as_fn_unset () { { eval $1=; unset $1;} } as_unset=as_fn_unset # as_fn_append VAR VALUE # ---------------------- # Append the text in VALUE to the end of the definition contained in VAR. Take # advantage of any shell optimizations that allow amortized linear growth over # repeated appends, instead of the typical quadratic growth present in naive # implementations. if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null then : eval 'as_fn_append () { eval $1+=\$2 }' else $as_nop as_fn_append () { eval $1=\$$1\$2 } fi # as_fn_append # as_fn_arith ARG... # ------------------ # Perform arithmetic evaluation on the ARGs, and store the result in the # global $as_val. Take advantage of shells that can avoid forks. The arguments # must be portable across $(()) and expr. if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null then : eval 'as_fn_arith () { as_val=$(( $* )) }' else $as_nop as_fn_arith () { as_val=`expr "$@" || test $? -eq 1` } fi # as_fn_arith if expr a : '\(a\)' >/dev/null 2>&1 && test "X`expr 00001 : '.*\(...\)'`" = X001; then as_expr=expr else as_expr=false fi if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then as_basename=basename else as_basename=false fi if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then as_dirname=dirname else as_dirname=false fi as_me=`$as_basename -- "$0" || $as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ X"$0" : 'X\(//\)$' \| \ X"$0" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X/"$0" | sed '/^.*\/\([^/][^/]*\)\/*$/{ s//\1/ q } /^X\/\(\/\/\)$/{ s//\1/ q } /^X\/\(\/\).*/{ s//\1/ q } s/.*/./; q'` # Avoid depending upon Character Ranges. as_cr_letters='abcdefghijklmnopqrstuvwxyz' as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' as_cr_Letters=$as_cr_letters$as_cr_LETTERS as_cr_digits='0123456789' as_cr_alnum=$as_cr_Letters$as_cr_digits # Determine whether it's possible to make 'echo' print without a newline. # These variables are no longer used directly by Autoconf, but are AC_SUBSTed # for compatibility with existing Makefiles. ECHO_C= ECHO_N= ECHO_T= case `echo -n x` in #((((( -n*) case `echo 'xy\c'` in *c*) ECHO_T=' ';; # ECHO_T is single tab character. xy) ECHO_C='\c';; *) echo `echo ksh88 bug on AIX 6.1` > /dev/null ECHO_T=' ';; esac;; *) ECHO_N='-n';; esac # For backward compatibility with old third-party macros, we provide # the shell variables $as_echo and $as_echo_n. New code should use # AS_ECHO(["message"]) and AS_ECHO_N(["message"]), respectively. as_echo='printf %s\n' as_echo_n='printf %s' rm -f conf$$ conf$$.exe conf$$.file if test -d conf$$.dir; then rm -f conf$$.dir/conf$$.file else rm -f conf$$.dir mkdir conf$$.dir 2>/dev/null fi if (echo >conf$$.file) 2>/dev/null; then if ln -s conf$$.file conf$$ 2>/dev/null; then as_ln_s='ln -s' # ... but there are two gotchas: # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. # In both cases, we have to default to `cp -pR'. ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || as_ln_s='cp -pR' elif ln conf$$.file conf$$ 2>/dev/null; then as_ln_s=ln else as_ln_s='cp -pR' fi else as_ln_s='cp -pR' fi rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file rmdir conf$$.dir 2>/dev/null # as_fn_mkdir_p # ------------- # Create "$as_dir" as a directory, including parents if necessary. as_fn_mkdir_p () { case $as_dir in #( -*) as_dir=./$as_dir;; esac test -d "$as_dir" || eval $as_mkdir_p || { as_dirs= while :; do case $as_dir in #( *\'*) as_qdir=`printf "%s\n" "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( *) as_qdir=$as_dir;; esac as_dirs="'$as_qdir' $as_dirs" as_dir=`$as_dirname -- "$as_dir" || $as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ X"$as_dir" : 'X\(//\)[^/]' \| \ X"$as_dir" : 'X\(//\)$' \| \ X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X"$as_dir" | sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/ q } /^X\(\/\/\)[^/].*/{ s//\1/ q } /^X\(\/\/\)$/{ s//\1/ q } /^X\(\/\).*/{ s//\1/ q } s/.*/./; q'` test -d "$as_dir" && break done test -z "$as_dirs" || eval "mkdir $as_dirs" } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" } # as_fn_mkdir_p if mkdir -p . 2>/dev/null; then as_mkdir_p='mkdir -p "$as_dir"' else test -d ./-p && rmdir ./-p as_mkdir_p=false fi # as_fn_executable_p FILE # ----------------------- # Test if FILE is an executable regular file. as_fn_executable_p () { test -f "$1" && test -x "$1" } # as_fn_executable_p as_test_x='test -x' as_executable_p=as_fn_executable_p # Sed expression to map a string onto a valid CPP name. as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" # Sed expression to map a string onto a valid variable name. as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" exec 6>&1 ## ----------------------------------- ## ## Main body of $CONFIG_STATUS script. ## ## ----------------------------------- ## _ASEOF test $as_write_fail = 0 && chmod +x $CONFIG_STATUS || ac_write_fail=1 cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 # Save the log message, to keep $0 and so on meaningful, and to # report actual input values of CONFIG_FILES etc. instead of their # values after options handling. ac_log=" This file was extended by poke-elf $as_me 1.0, which was generated by GNU Autoconf 2.71. Invocation command line was CONFIG_FILES = $CONFIG_FILES CONFIG_HEADERS = $CONFIG_HEADERS CONFIG_LINKS = $CONFIG_LINKS CONFIG_COMMANDS = $CONFIG_COMMANDS $ $0 $@ on `(hostname || uname -n) 2>/dev/null | sed 1q` " _ACEOF case $ac_config_files in *" "*) set x $ac_config_files; shift; ac_config_files=$*;; esac cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 # Files that config.status was made for. config_files="$ac_config_files" _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 ac_cs_usage="\ \`$as_me' instantiates files and other configuration actions from templates according to the current configuration. Unless the files and actions are specified as TAGs, all are instantiated by default. Usage: $0 [OPTION]... [TAG]... -h, --help print this help, then exit -V, --version print version number and configuration settings, then exit --config print configuration, then exit -q, --quiet, --silent do not print progress messages -d, --debug don't remove temporary files --recheck update $as_me by reconfiguring in the same conditions --file=FILE[:TEMPLATE] instantiate the configuration file FILE Configuration files: $config_files Report bugs to . poke-elf home page: ." _ACEOF ac_cs_config=`printf "%s\n" "$ac_configure_args" | sed "$ac_safe_unquote"` ac_cs_config_escaped=`printf "%s\n" "$ac_cs_config" | sed "s/^ //; s/'/'\\\\\\\\''/g"` cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 ac_cs_config='$ac_cs_config_escaped' ac_cs_version="\\ poke-elf config.status 1.0 configured by $0, generated by GNU Autoconf 2.71, with options \\"\$ac_cs_config\\" Copyright (C) 2021 Free Software Foundation, Inc. This config.status script is free software; the Free Software Foundation gives unlimited permission to copy, distribute and modify it." ac_pwd='$ac_pwd' srcdir='$srcdir' INSTALL='$INSTALL' MKDIR_P='$MKDIR_P' AWK='$AWK' test -n "\$AWK" || AWK=awk _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 # The default lists apply if the user does not specify any file. ac_need_defaults=: while test $# != 0 do case $1 in --*=?*) ac_option=`expr "X$1" : 'X\([^=]*\)='` ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` ac_shift=: ;; --*=) ac_option=`expr "X$1" : 'X\([^=]*\)='` ac_optarg= ac_shift=: ;; *) ac_option=$1 ac_optarg=$2 ac_shift=shift ;; esac case $ac_option in # Handling of the options. -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) ac_cs_recheck=: ;; --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) printf "%s\n" "$ac_cs_version"; exit ;; --config | --confi | --conf | --con | --co | --c ) printf "%s\n" "$ac_cs_config"; exit ;; --debug | --debu | --deb | --de | --d | -d ) debug=: ;; --file | --fil | --fi | --f ) $ac_shift case $ac_optarg in *\'*) ac_optarg=`printf "%s\n" "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` ;; '') as_fn_error $? "missing file argument" ;; esac as_fn_append CONFIG_FILES " '$ac_optarg'" ac_need_defaults=false;; --he | --h | --help | --hel | -h ) printf "%s\n" "$ac_cs_usage"; exit ;; -q | -quiet | --quiet | --quie | --qui | --qu | --q \ | -silent | --silent | --silen | --sile | --sil | --si | --s) ac_cs_silent=: ;; # This is an error. -*) as_fn_error $? "unrecognized option: \`$1' Try \`$0 --help' for more information." ;; *) as_fn_append ac_config_targets " $1" ac_need_defaults=false ;; esac shift done ac_configure_extra_args= if $ac_cs_silent; then exec 6>/dev/null ac_configure_extra_args="$ac_configure_extra_args --silent" fi _ACEOF cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 if \$ac_cs_recheck; then set X $SHELL '$0' $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion shift \printf "%s\n" "running CONFIG_SHELL=$SHELL \$*" >&6 CONFIG_SHELL='$SHELL' export CONFIG_SHELL exec "\$@" fi _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 exec 5>>config.log { echo sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX ## Running $as_me. ## _ASBOX printf "%s\n" "$ac_log" } >&5 _ACEOF cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 # Handling of arguments. for ac_config_target in $ac_config_targets do case $ac_config_target in "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; "elf-build.pk") CONFIG_FILES="$CONFIG_FILES elf-build.pk" ;; "test-elf.pk") CONFIG_FILES="$CONFIG_FILES test-elf.pk" ;; *) as_fn_error $? "invalid argument: \`$ac_config_target'" "$LINENO" 5;; esac done # If the user did not use the arguments to specify the items to instantiate, # then the envvar interface is used. Set only those that are not. # We use the long form for the default assignment because of an extremely # bizarre bug on SunOS 4.1.3. if $ac_need_defaults; then test ${CONFIG_FILES+y} || CONFIG_FILES=$config_files fi # Have a temporary directory for convenience. Make it in the build tree # simply because there is no reason against having it here, and in addition, # creating and moving files from /tmp can sometimes cause problems. # Hook for its removal unless debugging. # Note that there is a small window in which the directory will not be cleaned: # after its creation but before its name has been assigned to `$tmp'. $debug || { tmp= ac_tmp= trap 'exit_status=$? : "${ac_tmp:=$tmp}" { test ! -d "$ac_tmp" || rm -fr "$ac_tmp"; } && exit $exit_status ' 0 trap 'as_fn_exit 1' 1 2 13 15 } # Create a (secure) tmp directory for tmp files. { tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && test -d "$tmp" } || { tmp=./conf$$-$RANDOM (umask 077 && mkdir "$tmp") } || as_fn_error $? "cannot create a temporary directory in ." "$LINENO" 5 ac_tmp=$tmp # Set up the scripts for CONFIG_FILES section. # No need to generate them if there are no CONFIG_FILES. # This happens for instance with `./config.status config.h'. if test -n "$CONFIG_FILES"; then ac_cr=`echo X | tr X '\015'` # On cygwin, bash can eat \r inside `` if the user requested igncr. # But we know of no other shell where ac_cr would be empty at this # point, so we can use a bashism as a fallback. if test "x$ac_cr" = x; then eval ac_cr=\$\'\\r\' fi ac_cs_awk_cr=`$AWK 'BEGIN { print "a\rb" }' /dev/null` if test "$ac_cs_awk_cr" = "a${ac_cr}b"; then ac_cs_awk_cr='\\r' else ac_cs_awk_cr=$ac_cr fi echo 'BEGIN {' >"$ac_tmp/subs1.awk" && _ACEOF { echo "cat >conf$$subs.awk <<_ACEOF" && echo "$ac_subst_vars" | sed 's/.*/&!$&$ac_delim/' && echo "_ACEOF" } >conf$$subs.sh || as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 ac_delim_num=`echo "$ac_subst_vars" | grep -c '^'` ac_delim='%!_!# ' for ac_last_try in false false false false false :; do . ./conf$$subs.sh || as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 ac_delim_n=`sed -n "s/.*$ac_delim\$/X/p" conf$$subs.awk | grep -c X` if test $ac_delim_n = $ac_delim_num; then break elif $ac_last_try; then as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 else ac_delim="$ac_delim!$ac_delim _$ac_delim!! " fi done rm -f conf$$subs.sh cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 cat >>"\$ac_tmp/subs1.awk" <<\\_ACAWK && _ACEOF sed -n ' h s/^/S["/; s/!.*/"]=/ p g s/^[^!]*!// :repl t repl s/'"$ac_delim"'$// t delim :nl h s/\(.\{148\}\)..*/\1/ t more1 s/["\\]/\\&/g; s/^/"/; s/$/\\n"\\/ p n b repl :more1 s/["\\]/\\&/g; s/^/"/; s/$/"\\/ p g s/.\{148\}// t nl :delim h s/\(.\{148\}\)..*/\1/ t more2 s/["\\]/\\&/g; s/^/"/; s/$/"/ p b :more2 s/["\\]/\\&/g; s/^/"/; s/$/"\\/ p g s/.\{148\}// t delim ' >$CONFIG_STATUS || ac_write_fail=1 rm -f conf$$subs.awk cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 _ACAWK cat >>"\$ac_tmp/subs1.awk" <<_ACAWK && for (key in S) S_is_set[key] = 1 FS = "" } { line = $ 0 nfields = split(line, field, "@") substed = 0 len = length(field[1]) for (i = 2; i < nfields; i++) { key = field[i] keylen = length(key) if (S_is_set[key]) { value = S[key] line = substr(line, 1, len) "" value "" substr(line, len + keylen + 3) len += length(value) + length(field[++i]) substed = 1 } else len += 1 + keylen } print line } _ACAWK _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 if sed "s/$ac_cr//" < /dev/null > /dev/null 2>&1; then sed "s/$ac_cr\$//; s/$ac_cr/$ac_cs_awk_cr/g" else cat fi < "$ac_tmp/subs1.awk" > "$ac_tmp/subs.awk" \ || as_fn_error $? "could not setup config files machinery" "$LINENO" 5 _ACEOF # VPATH may cause trouble with some makes, so we remove sole $(srcdir), # ${srcdir} and @srcdir@ entries from VPATH if srcdir is ".", strip leading and # trailing colons and then remove the whole line if VPATH becomes empty # (actually we leave an empty line to preserve line numbers). if test "x$srcdir" = x.; then ac_vpsub='/^[ ]*VPATH[ ]*=[ ]*/{ h s/// s/^/:/ s/[ ]*$/:/ s/:\$(srcdir):/:/g s/:\${srcdir}:/:/g s/:@srcdir@:/:/g s/^:*// s/:*$// x s/\(=[ ]*\).*/\1/ G s/\n// s/^[^=]*=[ ]*$// }' fi cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 fi # test -n "$CONFIG_FILES" eval set X " :F $CONFIG_FILES " shift for ac_tag do case $ac_tag in :[FHLC]) ac_mode=$ac_tag; continue;; esac case $ac_mode$ac_tag in :[FHL]*:*);; :L* | :C*:*) as_fn_error $? "invalid tag \`$ac_tag'" "$LINENO" 5;; :[FH]-) ac_tag=-:-;; :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; esac ac_save_IFS=$IFS IFS=: set x $ac_tag IFS=$ac_save_IFS shift ac_file=$1 shift case $ac_mode in :L) ac_source=$1;; :[FH]) ac_file_inputs= for ac_f do case $ac_f in -) ac_f="$ac_tmp/stdin";; *) # Look for the file first in the build tree, then in the source tree # (if the path is not absolute). The absolute path cannot be DOS-style, # because $ac_f cannot contain `:'. test -f "$ac_f" || case $ac_f in [\\/$]*) false;; *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; esac || as_fn_error 1 "cannot find input file: \`$ac_f'" "$LINENO" 5;; esac case $ac_f in *\'*) ac_f=`printf "%s\n" "$ac_f" | sed "s/'/'\\\\\\\\''/g"`;; esac as_fn_append ac_file_inputs " '$ac_f'" done # Let's still pretend it is `configure' which instantiates (i.e., don't # use $as_me), people would be surprised to read: # /* config.h. Generated by config.status. */ configure_input='Generated from '` printf "%s\n" "$*" | sed 's|^[^:]*/||;s|:[^:]*/|, |g' `' by configure.' if test x"$ac_file" != x-; then configure_input="$ac_file. $configure_input" { printf "%s\n" "$as_me:${as_lineno-$LINENO}: creating $ac_file" >&5 printf "%s\n" "$as_me: creating $ac_file" >&6;} fi # Neutralize special characters interpreted by sed in replacement strings. case $configure_input in #( *\&* | *\|* | *\\* ) ac_sed_conf_input=`printf "%s\n" "$configure_input" | sed 's/[\\\\&|]/\\\\&/g'`;; #( *) ac_sed_conf_input=$configure_input;; esac case $ac_tag in *:-:* | *:-) cat >"$ac_tmp/stdin" \ || as_fn_error $? "could not create $ac_file" "$LINENO" 5 ;; esac ;; esac ac_dir=`$as_dirname -- "$ac_file" || $as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ X"$ac_file" : 'X\(//\)[^/]' \| \ X"$ac_file" : 'X\(//\)$' \| \ X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || printf "%s\n" X"$ac_file" | sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ s//\1/ q } /^X\(\/\/\)[^/].*/{ s//\1/ q } /^X\(\/\/\)$/{ s//\1/ q } /^X\(\/\).*/{ s//\1/ q } s/.*/./; q'` as_dir="$ac_dir"; as_fn_mkdir_p ac_builddir=. case "$ac_dir" in .) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; *) ac_dir_suffix=/`printf "%s\n" "$ac_dir" | sed 's|^\.[\\/]||'` # A ".." for each directory in $ac_dir_suffix. ac_top_builddir_sub=`printf "%s\n" "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` case $ac_top_builddir_sub in "") ac_top_builddir_sub=. ac_top_build_prefix= ;; *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; esac ;; esac ac_abs_top_builddir=$ac_pwd ac_abs_builddir=$ac_pwd$ac_dir_suffix # for backward compatibility: ac_top_builddir=$ac_top_build_prefix case $srcdir in .) # We are building in place. ac_srcdir=. ac_top_srcdir=$ac_top_builddir_sub ac_abs_top_srcdir=$ac_pwd ;; [\\/]* | ?:[\\/]* ) # Absolute name. ac_srcdir=$srcdir$ac_dir_suffix; ac_top_srcdir=$srcdir ac_abs_top_srcdir=$srcdir ;; *) # Relative name. ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix ac_top_srcdir=$ac_top_build_prefix$srcdir ac_abs_top_srcdir=$ac_pwd/$srcdir ;; esac ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix case $ac_mode in :F) # # CONFIG_FILE # case $INSTALL in [\\/$]* | ?:[\\/]* ) ac_INSTALL=$INSTALL ;; *) ac_INSTALL=$ac_top_build_prefix$INSTALL ;; esac ac_MKDIR_P=$MKDIR_P case $MKDIR_P in [\\/$]* | ?:[\\/]* ) ;; */*) ac_MKDIR_P=$ac_top_build_prefix$MKDIR_P ;; esac _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 # If the template does not know about datarootdir, expand it. # FIXME: This hack should be removed a few years after 2.60. ac_datarootdir_hack=; ac_datarootdir_seen= ac_sed_dataroot=' /datarootdir/ { p q } /@datadir@/p /@docdir@/p /@infodir@/p /@localedir@/p /@mandir@/p' case `eval "sed -n \"\$ac_sed_dataroot\" $ac_file_inputs"` in *datarootdir*) ac_datarootdir_seen=yes;; *@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 printf "%s\n" "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} _ACEOF cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 ac_datarootdir_hack=' s&@datadir@&$datadir&g s&@docdir@&$docdir&g s&@infodir@&$infodir&g s&@localedir@&$localedir&g s&@mandir@&$mandir&g s&\\\${datarootdir}&$datarootdir&g' ;; esac _ACEOF # Neutralize VPATH when `$srcdir' = `.'. # Shell code in configure.ac might set extrasub. # FIXME: do we really want to maintain this feature? cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 ac_sed_extra="$ac_vpsub $extrasub _ACEOF cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 :t /@[a-zA-Z_][a-zA-Z_0-9]*@/!b s|@configure_input@|$ac_sed_conf_input|;t t s&@top_builddir@&$ac_top_builddir_sub&;t t s&@top_build_prefix@&$ac_top_build_prefix&;t t s&@srcdir@&$ac_srcdir&;t t s&@abs_srcdir@&$ac_abs_srcdir&;t t s&@top_srcdir@&$ac_top_srcdir&;t t s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t s&@builddir@&$ac_builddir&;t t s&@abs_builddir@&$ac_abs_builddir&;t t s&@abs_top_builddir@&$ac_abs_top_builddir&;t t s&@INSTALL@&$ac_INSTALL&;t t s&@MKDIR_P@&$ac_MKDIR_P&;t t $ac_datarootdir_hack " eval sed \"\$ac_sed_extra\" "$ac_file_inputs" | $AWK -f "$ac_tmp/subs.awk" \ >$ac_tmp/out || as_fn_error $? "could not create $ac_file" "$LINENO" 5 test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && { ac_out=`sed -n '/\${datarootdir}/p' "$ac_tmp/out"`; test -n "$ac_out"; } && { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' \ "$ac_tmp/out"`; test -z "$ac_out"; } && { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file contains a reference to the variable \`datarootdir' which seems to be undefined. Please make sure it is defined" >&5 printf "%s\n" "$as_me: WARNING: $ac_file contains a reference to the variable \`datarootdir' which seems to be undefined. Please make sure it is defined" >&2;} rm -f "$ac_tmp/stdin" case $ac_file in -) cat "$ac_tmp/out" && rm -f "$ac_tmp/out";; *) rm -f "$ac_file" && mv "$ac_tmp/out" "$ac_file";; esac \ || as_fn_error $? "could not create $ac_file" "$LINENO" 5 ;; esac case $ac_file$ac_mode in "test-elf.pk":F) chmod +x test-elf.pk ;; esac done # for ac_tag as_fn_exit 0 _ACEOF ac_clean_files=$ac_clean_files_save test $ac_write_fail = 0 || as_fn_error $? "write failure creating $CONFIG_STATUS" "$LINENO" 5 # configure is writing to config.log, and then calls config.status. # config.status does its own redirection, appending to config.log. # Unfortunately, on DOS this fails, as config.log is still kept open # by configure, so config.status won't be able to write to it; its # output is simply discarded. So we exec the FD to /dev/null, # effectively closing config.log, so it can be properly (re)opened and # appended to by config.status. When coming back to configure, we # need to make the FD available again. if test "$no_create" != yes; then ac_cs_success=: ac_config_status_args= test "$silent" = yes && ac_config_status_args="$ac_config_status_args --quiet" exec 5>/dev/null $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false exec 5>>config.log # Use ||, not &&, to avoid exiting from the if with $? = 1, which # would make configure fail if this is the last instruction. $ac_cs_success || as_fn_exit 1 fi if test -n "$ac_unrecognized_opts" && test "$enable_option_checking" != no; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: unrecognized options: $ac_unrecognized_opts" >&5 printf "%s\n" "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2;} fi if test "x$POKE" = "x:"; then { printf "%s\n" "$as_me:${as_lineno-$LINENO}: WARNING: poke >= 3.0-dev-102 is required to run this pickle's testsuite" >&5 printf "%s\n" "$as_me: WARNING: poke >= 3.0-dev-102 is required to run this pickle's testsuite" >&2;} fi poke-elf-1.0/elf-os-openbsd.pk0000644000175000017500000000541614562415146013164 00000000000000/* elf-os-openbsd.pk - ELF OpenBSD specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* OPENBSD segment types. */ var ELF_PT_OPENBSD_MUTABLE = ELF_PT_LOOS + 0x5a3dbe5, ELF_PT_OPENBSD_RANDOMIZE = ELF_PT_LOOS + 0x5a3dbe6, ELF_PT_OPENBSD_WXNEEDED = ELF_PT_LOOS + 0x5a3dbe7, ELF_PT_OPENBSD_NOBTCFI = ELF_PT_LOOS + 0x5a3dbe8, ELF_PT_OPENBSD_BOOTDATA = ELF_PT_LOOS + 0x5a41be6; elf_config.add_enum :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_OPENBSD_MUTABLE, name = "openbsd-mutable", doc = "Like bss, but not immutable." }, Elf_Config_UInt { value = ELF_PT_OPENBSD_RANDOMIZE, name = "openbsd-randomize", doc = "Fill with random data." }, Elf_Config_UInt { value = ELF_PT_OPENBSD_WXNEEDED, name = "openbsd-wxneeded", doc = "Program does W^X violations." }, Elf_Config_UInt { value = ELF_PT_OPENBSD_NOBTCFI, name = "openbsd-nobtcfi", doc = "No branch target CFI." }, Elf_Config_UInt { value = ELF_PT_OPENBSD_BOOTDATA, name = "openbsd-bootdata", doc = "Section for bot arguments." }]; /* Note segments for core files on OpenBSD systems. */ var ELF_NT_OPENBSD_IDENT = 1, ELF_NT_OPENBSD_PROCINFO = 10, ELF_NT_OPENBSD_AUXV = 11, ELF_NT_OPENBSD_REGS = 20, ELF_NT_OPENBSD_FPREGS = 21, ELF_NT_OPENBSD_XFPREGS = 22, ELF_NT_OPENBSD_WCOOKIE = 23; elf_config.add_enum :class "note-tags" :entries [Elf_Config_UInt { value = ELF_NT_OPENBSD_IDENT, name = "openbsd-ident" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_PROCINFO, name = "openbsd-procinfo" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_AUXV, name = "openbsd-auxv" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_REGS, name = "openbsd-regs" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_FPREGS, name = "openbsd-fpregs" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_XFPREGS, name = "openbsd-xfpregs" }, Elf_Config_UInt { value = ELF_NT_OPENBSD_WCOOKIE, name = "openbsd-wcookie" }]; poke-elf-1.0/elf-mach-bpf.pk0000644000175000017500000000266614602057355012573 00000000000000/* elf-mach-bpf.pk - ELF BPF specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* BPF relocation types. */ var ELF_R_BPF_NONE = 0U, ELF_R_BPF_64_64 = 1U, ELF_R_BPF_64_ABS64 = 2U, ELF_R_BPF_64_ABS32 = 3U, ELF_R_BPF_64_NODYLD32 = 4U, ELF_R_BPF_64_32 = 10U; elf_config.add_enum :machine ELF_EM_BPF :class "reloc-types" :entries [Elf_Config_UInt { value = ELF_R_BPF_NONE, name = "none" }, Elf_Config_UInt { value = ELF_R_BPF_64_64, name = "64" }, Elf_Config_UInt { value = ELF_R_BPF_64_ABS64, name = "abs64" }, Elf_Config_UInt { value = ELF_R_BPF_64_ABS32, name = "abs32" }, Elf_Config_UInt { value = ELF_R_BPF_64_NODYLD32, name = "nodyld32" }, Elf_Config_UInt { value = ELF_R_BPF_64_32, name = "32" }]; poke-elf-1.0/elf-32.pk0000644000175000017500000002411114602057314011322 00000000000000/* elf-32.pk - 32-bit ELF definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* ELF32 basic types. */ type Elf32_Addr = offset,B>, Elf32_Off = offset,B>; /* ELF32 relocation info. */ type Elf32_RelInfo = struct Elf_Word { uint<24> r_sym; uint<8> r_type : elf_config.check_enum ("reloc-types", elf_mach, r_type); method _print_r_type = void: { printf "#<%s>", elf_config.format_enum ("reloc-types", elf_mach, r_type); } }; /* ELF32 REL relocation entry. */ type Elf32_Rel = struct { Elf32_Addr r_offset; Elf32_RelInfo r_info; }; /* ELF32 RELA relocation entry. r_offset holds a section offset in relocatable files, a virtual address in executable and shared object files. r_addend holds a constant value to be added to the relocation's value. In architectures using Rel relocations this addend is somehow stored in the relocation's memory location. */ type Elf32_Rela = struct { Elf32_Addr r_offset; Elf32_RelInfo r_info; Elf_Sword r_addend; }; /* ELF32 RELR relocation entry. */ type Elf32_Relr = Elf_Word; /* ELF32 symbol. */ type Elf32_Sym = struct { offset st_name; Elf32_Addr st_value; offset st_size; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other : (st_info.st_bind == ELF_STB_LOCAL => +st_other != ELF_STV_PROTECTED); Elf_Half st_shndx; }; /* ELF32 compressed section header. */ type Elf32_Chdr = struct { /* This member specifies the compression algorithm. */ Elf_Word ch_type : elf_compress_algorithm_p (ch_type); /* Size and required alignment of the uncompressed data. */ offset ch_size; offset ch_addralign; }; /* ELF32 section header table entry. */ type Elf32_Shdr = struct { offset sh_name; Elf_Word sh_type : sh_type >= ELF_SHT_LOUSER && sh_type <= ELF_SHT_HIUSER || elf_config.check_enum ("section-types", elf_mach, sh_type); Elf_Word sh_flags : elf_config.check_enum ("section-flags", elf_mach, sh_flags) && (sh_flags & ELF_SHF_COMPRESSED => (sh_type != ELF_SHT_NOBITS && !(sh_flags & ELF_SHF_ALLOC))); Elf32_Addr sh_addr; Elf32_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf_Word sh_addralign; offset sh_entsize; method _print_sh_type = void: { printf "#<%s>", elf_config.format_enum ("section-types", elf_mach, sh_type); } method _print_sh_flags = void: { printf "#<%s>", elf_config.format_mask ("section-flags", elf_mach, sh_flags); } }; /* ELF32 program header table entry. */ type Elf32_Phdr = struct { Elf_Word p_type : elf_config.check_enum ("segment-types", elf_mach, p_type); Elf32_Off p_offset; Elf32_Addr p_vaddr; Elf32_Addr p_paddr; offset p_filesz; offset p_memsz : p_type == ELF_PT_LOAD => p_memsz >= p_filesz; Elf_Word p_flags : p_type == ELF_PT_NULL || elf_config.check_mask ("segment-flags", elf_mach, p_flags); offset p_align : p_align < 2#B || ((p_align & (p_align - 1#B)) == 0#B) /* Is a power of 2. */ && ((p_vaddr - p_offset) % p_align) == 0#B; method _print_p_type = void: { printf "#<%s>", elf_config.format_enum ("segment-types", elf_mach, p_type); } method _print_p_flags = void: { printf "#<%s>", elf_config.format_mask ("segment-flags", elf_mach, p_flags); } }; /* ELF32 file header. */ type Elf32_Ehdr = struct { fun set_mach = (int<32> mach) int<32>: { elf_selected_mach = mach; return 1; } Elf_Ident e_ident; Elf_Half e_type : elf_config.check_enum ("file-types", elf_mach, e_type); Elf_Half e_machine : set_mach (e_machine); Elf_Word e_version = ELF_EV_CURRENT; Elf32_Addr e_entry; Elf32_Off e_phoff; Elf32_Off e_shoff; Elf_Word e_flags : elf_config.check_mask ("file-flags", elf_mach, e_flags); offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx : e_shnum == 0 || e_shstrndx < e_shnum; method _print_e_type = void: { printf "#<%s>", elf_config.format_enum ("file-types", elf_mach, e_type); } method _print_e_flags = void: { printf "#<%s>", elf_config.format_mask ("file-flags", elf_mach, e_flags); } }; /* ELF32 file. */ fun elf32_check_phdr = (Elf32_Phdr[] phdr) int<32>: { var found_loadable = 0, found_phdr = 0, found_interp = 0; for (segment in phdr) { /* Some entries must appear before any loadable segment, and appear only once in the table. */ if (segment.p_type == ELF_PT_INTERP && (found_loadable || found_interp)) return 0; if (segment.p_type == ELF_PT_PHDR && (found_loadable || found_phdr)) return 0; found_interp = segment.p_type == ELF_PT_INTERP; found_phdr = segment.p_type == ELF_PT_PHDR; found_loadable += segment.p_type == ELF_PT_LOAD; } return 1; } type Elf32_File = struct { Elf32_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf32_Shdr[ehdr.e_shnum] shdr @ ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf32_Phdr[ehdr.e_phnum] phdr : elf32_check_phdr (phdr) @ ehdr.e_phoff; /* Given an offset into the ELF file's section string table, return the string. */ method get_section_name = (offset offset) string: { var strtab = ehdr.e_shstrndx; return string @ shdr'ios : shdr[strtab].sh_offset + offset; } /* Given a symtab and an offset into its associated symbol string table, return the string. */ method get_symbol_name = (Elf32_Shdr symtab, offset offset) string: { var strtab = symtab.sh_link; return string @ shdr'ios : shdr[strtab].sh_offset + offset; } /* Given a section name, return an array of section headers in the ELF file having that name. */ method get_sections_by_name = (string name) Elf32_Shdr[]: { var sections = Elf32_Shdr[](); for (s in shdr where get_section_name (s.sh_name) == name) apush (sections, s); return sections; } /* Given a section type (SHT_* value) return an array of section headers in the ELF file with that type. */ method get_sections_by_type = (Elf_Word stype) Elf32_Shdr[]: { var sections = Elf32_Shdr[](); for (s in shdr where s.sh_type == stype) apush (sections, s); return sections; } /* Given a section name, return whether it exists in this file. */ method section_name_p = (string name) int<32>: { var sections = Elf32_Shdr[](); try sections = get_sections_by_name (name); catch if E_inval { return 0; } return sections'length; } /* Given an offset, return the string stored at that offset in the "default" string table of the ELF file. This is the string table section named ".strtab". If such a section doesn't exist, or it doesn't contain a string table, then raise E_inval. */ method get_string = (offset offset) string: { if (!section_name_p (".strtab")) raise E_inval; var strtab = get_sections_by_name (".strtab")[0]; return string @ strtab'ios : strtab.sh_offset + offset; } /* Return the signature corresponding to a given group section. If the given section header doesn't correspond to a group section then raise E_inval. */ method get_group_signature = (Elf32_Shdr section) string: { if (section.sh_type != ELF_SHT_GROUP) raise E_inval; var symtab = shdr[section.sh_link]; var symtab_data = Elf32_Sym [symtab.sh_size] @ shdr'ios : symtab.sh_offset; var symbol = symtab_data[section.sh_info]; var symbol_name = get_symbol_name (symtab, symbol.st_name); return symbol_name; } /* Return an array of strings with the signatures of the section groups present in this ELF file. */ method get_group_signatures = string[]: { var signatures = string[](); for (section in shdr where section.sh_type == ELF_SHT_GROUP) apush (signatures, get_group_signature (section)); return signatures; } /* Given the name of a section group, return an array with the section headers corresponding to all the sections in that group. If the given name doesn't identify a section group in the ELF file then return an empty array. */ method get_section_group = (string group_name) Elf32_Shdr[]: { var section_group = Elf32_Shdr[](); var group_sections = get_sections_by_type (ELF_SHT_GROUP); for (sec in group_sections where get_group_signature (sec) == group_name) { var group_entries = (Elf_Word[sec.sh_size - sizeof (Elf_Word)] @ sec'ios : sec.sh_offset + sizeof (Elf_Word)); for (entry in group_entries) apush (section_group, shdr[entry]); break; } return section_group; } }; poke-elf-1.0/elf-mach-mips.pk0000644000175000017500000010214114602057360012755 00000000000000/* elf-mach-mips.pk - ELF MIPS specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* MIPS relocation types. */ var ELF_R_MIPS_NONE = 0, ELF_R_MIPS_16 = 1, ELF_R_MIPS_32 = 2, ELF_R_MIPS_REL32 = 3, ELF_R_MIPS_26 = 4, ELF_R_MIPS_HI16 = 5, ELF_R_MIPS_LO16 = 6, ELF_R_MIPS_GPREL16 = 7, ELF_R_MIPS_LITERAL = 8, ELF_R_MIPS_GOT16 = 9, ELF_R_MIPS_PC16 = 10, ELF_R_MIPS_CALL16 = 11, ELF_R_MIPS_GPREL32 = 12, ELF_R_MIPS_UNUSED1 = 13, ELF_R_MIPS_UNUSED2 = 14, ELF_R_MIPS_UNUSED3 = 15, ELF_R_MIPS_SHIFT5 = 16, ELF_R_MIPS_SHIFT6 = 17, ELF_R_MIPS_64 = 18, ELF_R_MIPS_GOT_DISP = 19, ELF_R_MIPS_GOT_PAGE = 20, ELF_R_MIPS_GOT_OFST = 21, ELF_R_MIPS_GOT_HI16 = 22, ELF_R_MIPS_GOT_LO16 = 23, ELF_R_MIPS_SUB = 24, ELF_R_MIPS_INSERT_A = 25, ELF_R_MIPS_INSERT_B = 26, ELF_R_MIPS_DELETE = 27, ELF_R_MIPS_HIGHER = 28, ELF_R_MIPS_HIGHEST = 29, ELF_R_MIPS_CALL_HI16 = 30, ELF_R_MIPS_CALL_LO16 = 31, ELF_R_MIPS_SCN_DISP = 32, ELF_R_MIPS_REL16 = 33, ELF_R_MIPS_ADD_IMMEDIATE = 34, ELF_R_MIPS_PJUMP = 35, ELF_R_MIPS_RELGOT = 36, ELF_R_MIPS_JALR = 37, ELF_R_MIPS_TLS_DTPMOD32 = 38, ELF_R_MIPS_TLS_DTPREL32 = 39, ELF_R_MIPS_TLS_DTPMOD64 = 40, ELF_R_MIPS_TLS_DTPREL64 = 41, ELF_R_MIPS_TLS_GD = 42, ELF_R_MIPS_TLS_LDM = 43, ELF_R_MIPS_TLS_DTPREL_HI16 = 44, ELF_R_MIPS_TLS_DTPREL_LO16 = 45, ELF_R_MIPS_TLS_GOTTPREL = 46, ELF_R_MIPS_TLS_TPREL32 = 47, ELF_R_MIPS_TLS_TPREL64 = 48, ELF_R_MIPS_TLS_TPREL_HI16 = 49, ELF_R_MIPS_TLS_TPREL_LO16 = 50, ELF_R_MIPS_GLOB_DAT = 51, ELF_R_MIPS_PC21_S2 = 60, ELF_R_MIPS_PC26_S2 = 61, ELF_R_MIPS_PC18_S3 = 62, ELF_R_MIPS_PC19_S2 = 63, ELF_R_MIPS_PCHI16 = 64, ELF_R_MIPS_PCLO16 = 65, ELF_R_MIPS16_26 = 100, ELF_R_MIPS16_GPREL = 101, ELF_R_MIPS16_GOT16 = 102, ELF_R_MIPS16_CALL16 = 103, ELF_R_MIPS16_HI16 = 104, ELF_R_MIPS16_LO16 = 105, ELF_R_MIPS16_TLS_GD = 106, ELF_R_MIPS16_TLS_LDM = 107, ELF_R_MIPS16_TLS_DTPREL_HI16 = 108, ELF_R_MIPS16_TLS_DTPREL_LO16 = 109, ELF_R_MIPS16_TLS_GOTTPREL = 110, ELF_R_MIPS16_TLS_TPREL_HI16 = 111, ELF_R_MIPS16_TLS_TPREL_LO16 = 112, ELF_R_MIPS16_PC16_S1 = 113, ELF_R_MIPS_COPY = 126, ELF_R_MIPS_JUMP_SLOT = 127, ELF_R_MICROMIPS_26_S1 = 133, ELF_R_MICROMIPS_HI16 = 134, ELF_R_MICROMIPS_LO16 = 135, ELF_R_MICROMIPS_GPREL16 = 136, ELF_R_MICROMIPS_LITERAL = 137, ELF_R_MICROMIPS_GOT16 = 138, ELF_R_MICROMIPS_PC7_S1 = 139, ELF_R_MICROMIPS_PC10_S1 = 140, ELF_R_MICROMIPS_PC16_S1 = 141, ELF_R_MICROMIPS_CALL16 = 142, ELF_R_MICROMIPS_GOT_DISP = 145, ELF_R_MICROMIPS_GOT_PAGE = 146, ELF_R_MICROMIPS_GOT_OFST = 147, ELF_R_MICROMIPS_GOT_HI16 = 148, ELF_R_MICROMIPS_GOT_LO16 = 149, ELF_R_MICROMIPS_SUB = 150, ELF_R_MICROMIPS_HIGHER = 151, ELF_R_MICROMIPS_HIGHEST = 152, ELF_R_MICROMIPS_CALL_HI16 = 153, ELF_R_MICROMIPS_CALL_LO16 = 154, ELF_R_MICROMIPS_SCN_DISP = 155, ELF_R_MICROMIPS_JALR = 156, ELF_R_MICROMIPS_HI0_LO16 = 157, ELF_R_MICROMIPS_TLS_GD = 162, ELF_R_MICROMIPS_TLS_LDM = 163, ELF_R_MICROMIPS_TLS_DTPREL_HI16 = 164, ELF_R_MICROMIPS_TLS_DTPREL_LO16 = 165, ELF_R_MICROMIPS_TLS_GOTTPREL = 166, ELF_R_MICROMIPS_TLS_TPREL_HI16 = 169, ELF_R_MICROMIPS_TLS_TPREL_LO16 = 170, ELF_R_MICROMIPS_GPREL7_S2 = 172, ELF_R_MICROMIPS_PC23_S2 = 173, ELF_R_MIPS_PC32 = 248, ELF_R_MIPS_EH = 249, ELF_R_MIPS_GNU_REL16_S2 = 250, ELF_R_MIPS_GNU_VTINHERIT = 253, ELF_R_MIPS_GNU_VTENTRY = 254; elf_config.add_enum :machine ELF_EM_MIPS :class "reloc-types" :entries [Elf_Config_UInt { value = ELF_R_MIPS_NONE, name = "NONE" }, Elf_Config_UInt { value = ELF_R_MIPS_16, name = "16" }, Elf_Config_UInt { value = ELF_R_MIPS_32, name = "32" }, Elf_Config_UInt { value = ELF_R_MIPS_REL32, name = "REL32" }, Elf_Config_UInt { value = ELF_R_MIPS_26, name = "26" }, Elf_Config_UInt { value = ELF_R_MIPS_HI16, name = "HI16" }, Elf_Config_UInt { value = ELF_R_MIPS_LO16, name = "LO16" }, Elf_Config_UInt { value = ELF_R_MIPS_GPREL16, name = "GPREL16" }, Elf_Config_UInt { value = ELF_R_MIPS_LITERAL, name = "LITERAL" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT16, name = "GOT16" }, Elf_Config_UInt { value = ELF_R_MIPS_PC16, name = "PC16" }, Elf_Config_UInt { value = ELF_R_MIPS_CALL16, name = "CALL16" }, Elf_Config_UInt { value = ELF_R_MIPS_GPREL32, name = "GPREL32" }, Elf_Config_UInt { value = ELF_R_MIPS_UNUSED1, name = "UNUSED1" }, Elf_Config_UInt { value = ELF_R_MIPS_UNUSED2, name = "UNUSED2" }, Elf_Config_UInt { value = ELF_R_MIPS_UNUSED3, name = "UNUSED3" }, Elf_Config_UInt { value = ELF_R_MIPS_SHIFT5, name = "SHIFT5" }, Elf_Config_UInt { value = ELF_R_MIPS_SHIFT6, name = "SHIFT6" }, Elf_Config_UInt { value = ELF_R_MIPS_64, name = "64" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT_DISP, name = "GOT_DISP" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT_PAGE, name = "GOT_PAGE" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT_OFST, name = "GOT_OFST" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT_HI16, name = "GOT_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS_GOT_LO16, name = "GOT_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS_SUB, name = "SUB" }, Elf_Config_UInt { value = ELF_R_MIPS_INSERT_A, name = "INSERT_A" }, Elf_Config_UInt { value = ELF_R_MIPS_INSERT_B, name = "INSERT_B" }, Elf_Config_UInt { value = ELF_R_MIPS_DELETE, name = "DELETE" }, Elf_Config_UInt { value = ELF_R_MIPS_HIGHER, name = "HIGHER" }, Elf_Config_UInt { value = ELF_R_MIPS_HIGHEST, name = "HIGHEST" }, Elf_Config_UInt { value = ELF_R_MIPS_CALL_HI16, name = "CALL_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS_CALL_LO16, name = "CALL_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS_SCN_DISP, name = "SCN_DISP" }, Elf_Config_UInt { value = ELF_R_MIPS_REL16, name = "REL16" }, Elf_Config_UInt { value = ELF_R_MIPS_ADD_IMMEDIATE, name = "ADD_IMMEDIATE" }, Elf_Config_UInt { value = ELF_R_MIPS_PJUMP, name = "PJUMP" }, Elf_Config_UInt { value = ELF_R_MIPS_RELGOT, name = "RELGOT" }, Elf_Config_UInt { value = ELF_R_MIPS_JALR, name = "JALR" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPMOD32, name = "TLS_DTPMOD32" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPREL32, name = "TLS_DTPREL32" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPMOD64, name = "TLS_DTPMOD64" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPREL64, name = "TLS_DTPREL64" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_GD, name = "TLS_GD" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_LDM, name = "TLS_LDM" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPREL_HI16, name = "TLS_DTPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_DTPREL_LO16, name = "TLS_DTPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_GOTTPREL, name = "TLS_GOTTPREL" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_TPREL32, name = "TLS_TPREL32" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_TPREL64, name = "TLS_TPREL64" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_TPREL_HI16, name = "TLS_TPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS_TLS_TPREL_LO16, name = "TLS_TPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS_GLOB_DAT, name = "GLOB_DAT" }, Elf_Config_UInt { value = ELF_R_MIPS_PC21_S2, name = "PC21_S2" }, Elf_Config_UInt { value = ELF_R_MIPS_PC26_S2, name = "PC26_S2" }, Elf_Config_UInt { value = ELF_R_MIPS_PC18_S3, name = "PC18_S3" }, Elf_Config_UInt { value = ELF_R_MIPS_PC19_S2, name = "PC19_S2" }, Elf_Config_UInt { value = ELF_R_MIPS_PCHI16, name = "PCHI16" }, Elf_Config_UInt { value = ELF_R_MIPS_PCLO16, name = "PCLO16" }, Elf_Config_UInt { value = ELF_R_MIPS16_GPREL, name = "MIPS16_GPREL" }, Elf_Config_UInt { value = ELF_R_MIPS16_GOT16, name = "MIPS16_GOT16" }, Elf_Config_UInt { value = ELF_R_MIPS16_CALL16, name = "MIPS16_CALL16" }, Elf_Config_UInt { value = ELF_R_MIPS16_HI16, name = "MIPS16_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS16_LO16, name = "MIPS16_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_GD, name = "MIPS16_TLS_GD" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_LDM, name = "MIPS16_TLS_LDM" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_DTPREL_HI16, name = "MIPS16_TLS_DTPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_DTPREL_LO16, name = "MIPS16_TLS_DTPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_GOTTPREL, name = "MIPS16_TLS_GOTTPREL" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_TPREL_HI16, name = "MIPS16_TLS_TPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MIPS16_TLS_TPREL_LO16, name = "MIPS16_TLS_TPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MIPS16_PC16_S1, name = "MIPS16_PC16_S1" }, Elf_Config_UInt { value = ELF_R_MIPS_COPY, name = "COPY" }, Elf_Config_UInt { value = ELF_R_MIPS_JUMP_SLOT, name = "JUMP_SLOT" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_26_S1, name = "MICROMIPS_26_S1" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_HI16, name = "MICROMIPS_HI16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_LO16, name = "MICROMIPS_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GPREL16, name = "MICROMIPS_GPREL16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_LITERAL, name = "MICROMIPS_LITERAL" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT16, name = "MICROMIPS_GOT16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_PC7_S1, name = "MICROMIPS_PC7_S1" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_PC10_S1, name = "MICROMIPS_PC10_S1" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_PC16_S1, name = "MICROMIPS_PC16_S1" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_CALL16, name = "MICROMIPS_CALL16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT_DISP, name = "MICROMIPS_GOT_DISP" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT_PAGE, name = "MICROMIPS_GOT_PAGE" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT_OFST, name = "MICROMIPS_GOT_OFST" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT_HI16, name = "MICROMIPS_GOT_HI16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GOT_LO16, name = "MICROMIPS_GOT_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_SUB, name = "MICROMIPS_SUB" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_HIGHER, name = "MICROMIPS_HIGHER" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_HIGHEST, name = "MICROMIPS_HIGHEST" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_CALL_HI16, name = "MICROMIPS_CALL_HI16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_CALL_LO16, name = "MICROMIPS_CALL_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_SCN_DISP, name = "MICROMIPS_SCN_DISP" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_JALR, name = "MICROMIPS_JALR" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_HI0_LO16, name = "MICROMIPS_HI0_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_GD, name = "MICROMIPS_TLS_GD" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_LDM, name = "MICROMIPS_TLS_LDM" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_DTPREL_HI16, name = "MICROMIPS_TLS_DTPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_DTPREL_LO16, name = "MICROMIPS_TLS_DTPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_GOTTPREL, name = "MICROMIPS_TLS_GOTTPREL" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_TPREL_HI16, name = "MICROMIPS_TLS_TPREL_HI16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_TLS_TPREL_LO16, name = "MICROMIPS_TLS_TPREL_LO16" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_GPREL7_S2, name = "MICROMIPS_GPREL7_S2" }, Elf_Config_UInt { value = ELF_R_MICROMIPS_PC23_S2, name = "MICROMIPS_PC23_S2" }, Elf_Config_UInt { value = ELF_R_MIPS_PC32, name = "PC32" }, Elf_Config_UInt { value = ELF_R_MIPS_EH, name = "EH" }, Elf_Config_UInt { value = ELF_R_MIPS_GNU_REL16_S2, name = "GNU_REL16_S2" }, Elf_Config_UInt { value = ELF_R_MIPS_GNU_VTINHERIT, name = "GNU_VTINHERIT" }, Elf_Config_UInt { value = ELF_R_MIPS_GNU_VTENTRY, name = "GNU_VTENTRY" }]; /* MIPS file flags. */ var ELF_EF_MIPS_NOREORDER = 0x0000_0001U, ELF_EF_MIPS_PIC = 0x0000_0002U, ELF_EF_MIPS_CPIC = 0x0000_0004U, ELF_EF_MIPS_XGOT = 0x0000_0008U, ELF_EF_MIPS_UCODE = 0x0000_0010U, ELF_EF_MIPS_ABI2 = 0x0000_0020U, ELF_EF_MIPS_OPTIONS_FIRST = 0x0000_0080U, ELF_EF_MIPS_32BITMODE = 0x0000_0010U, ELF_EF_MIPS_FP64 = 0x0000_0200U, EFL_EF_MIPS_NAN2008 = 0x0000_0400U, ELF_EF_MIPS_ARCH_ASE = 0x0f00_0000U, ELF_EF_MIPS_ARCH_ASE_MDMX = 0x0800_0000U, ELF_EF_MIPS_ARCH_ASE_M16 = 0x0400_0000U, ELF_EF_MIPS_ARCH_ASE_MICROMIPS = 0x0200_0000U, ELF_EF_MIPS_ARCH = 0xf000_0000U, ELF_EF_MIPS_ABI = 0x0000_f000U, ELF_EF_MIPS_MACH = 0x00ff_0000U; elf_config.add_mask :machine ELF_EM_MIPS :class "file-flags" :entries [Elf_Config_Mask { value = ELF_EF_MIPS_NOREORDER, name = "noreorder", doc = "At least one .noreorder directive appears in the source." }]; /* MIPS architectures encoded in the ELF_EF_MIPS_ARCH bits of the file flags. */ var ELF_E_MIPS_ARCH_1 = 0x0000_0000U, ELF_E_MIPS_ARCH_2 = 0x1000_0000U, ELF_E_MIPS_ARCH_3 = 0x2000_0000U, ELF_E_MIPS_ARCH_4 = 0x3000_0000U, ELF_E_MIPS_ARCH_5 = 0x4000_0000U, ELF_E_MIPS_ARCH_32 = 0x5000_0000U, ELF_E_MIPS_ARCH_64 = 0x6000_0000U, ELF_E_MIPS_ARCH_32R2 = 0x7000_0000U, ELF_E_MIPS_ARCH_64R2 = 0x8000_0000U, ELF_E_MIPS_ARCH_32R6 = 0x9000_0000U, ELF_E_MIPS_ARCH_64R6 = 0xa000_0000U; elf_config.add_enum :machine ELF_EM_MIPS :class "mips-architectures" :entries [Elf_Config_UInt { value = ELF_E_MIPS_ARCH_1, name = "mips1", doc = "-mips1 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_2, name = "mips2", doc = "-mips2 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_3, name = "mips3", doc = "-mips3 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_4, name = "mips4", doc = "-mips4 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_5, name = "mips5", doc = "-mips5 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_32, name = "mips32", doc = "-mips32 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_64, name = "mips64", doc = "-mips64 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_32R2, name = "mips32r2", doc = "-mips32r2 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_64R2, name = "mips64r2", doc = "-mips64r2 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_32R6, name = "mips32r6", doc = "-mips32r6 code." }, Elf_Config_UInt { value = ELF_E_MIPS_ARCH_64R6, name = "mips64r6", doc = "-mips64r6 code." }]; /* MIPS machines encoded in the ELF_EF_MIPS_MACH bits of the file flags. */ var ELF_E_MIPS_ABI_O32 = 0x0000_1000U, ELF_E_MIPS_ABI_O64 = 0x0000_2000U, ELF_E_MIPS_ABI_EABI32 = 0x0000_3000U, ELF_E_MIPS_ABI_EABI64 = 0x0000_4000U; elf_config.add_enum :machine ELF_EM_MIPS :class "mips-abis" :entries [Elf_Config_UInt { value = ELF_E_MIPS_ABI_O32, name = "o32", doc = "The original o32 abi." }, Elf_Config_UInt { value = ELF_E_MIPS_ABI_O64, name = "o64", doc = "o32 extended to work on 64 bit architectures." }, Elf_Config_UInt { value = ELF_E_MIPS_ABI_EABI32, name = "eabi32", doc = "EABI in 32 bit mode." }, Elf_Config_UInt { value = ELF_E_MIPS_ABI_EABI64, name = "eabi64", doc = "EABI in 64 bit mode." }]; var ELF_E_MIPS_MACH_3900 = 0x0081_0000U, ELF_E_MIPS_MACH_4010 = 0x0082_0000U, ELF_E_MIPS_MACH_4100 = 0x0083_0000U, ELF_E_MIPS_MACH_4650 = 0x0085_0000U, ELF_E_MIPS_MACH_4120 = 0x0087_0000U, ELF_E_MIPS_MACH_4111 = 0x0088_0000U, ELF_E_MIPS_MACH_SB1 = 0x008a_0000U, ELF_E_MIPS_MACH_OCTEON = 0x008b_0000U, ELF_E_MIPS_MACH_XLR = 0x008c_0000U, ELF_E_MIPS_MACH_OCTEON2 = 0x008d_0000U, ELF_E_MIPS_MACH_OCTEON3 = 0x008e_0000U, ELF_E_MIPS_MACH_5400 = 0x0091_0000U, ELF_E_MIPS_MACH_5900 = 0x0092_0000U, ELF_E_MIPS_MACH_IAMR2 = 0x0093_0000U, ELF_E_MIPS_MACH_5500 = 0x0098_0000U, ELF_E_MIPS_MACH_9000 = 0x0099_0000U, ELF_E_MIPS_MACH_LS2E = 0x00A0_0000U, ELF_E_MIPS_MACH_LS2F = 0x00A1_0000U, ELF_E_MIPS_MACH_GS464 = 0x00A2_0000U, ELF_E_MIPS_MACH_GS464E = 0x00A3_0000U, ELF_E_MIPS_MACH_GS264E = 0x00A4_0000U; elf_config.add_enum :machine ELF_EM_MIPS :class "mips-machines" :entries [Elf_Config_UInt { value = ELF_E_MIPS_MACH_3900, name = "3900" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_4010, name = "4010" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_4100, name = "4100" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_4650, name = "4650" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_4120, name = "4120" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_4111, name = "4111" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_SB1 , name = "SB1 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_OCTEON , name = "OCTEON " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_XLR , name = "XLR " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_OCTEON2, name = "OCTEON2" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_OCTEON3, name = "OCTEON3" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_5400 , name = "5400 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_5900 , name = "5900 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_IAMR2 , name = "IAMR2 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_5500 , name = "5500 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_9000 , name = "9000 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_LS2E , name = "LS2E " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_LS2F , name = "LS2F " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_GS464 , name = "GS464 " }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_GS464E, name = "GS464E" }, Elf_Config_UInt { value = ELF_E_MIPS_MACH_GS264E, name = "GS264E" }]; /* MIPS section indices. */ var ELF_SHN_MIPS_ACOMMON = ELF_SHN_LORESERVE; elf_config.add_enum :machine ELF_EM_MIPS :class "section-indices" :entries [Elf_Config_UInt { value = ELF_SHN_MIPS_ACOMMON, name = "acommon", doc = "Defined and allocated common symbol." }]; /* MIPS section types. */ var ELF_SHT_MIPS_MSYM = 0x7000_0000U, ELF_SHT_MIPS_MSYM = 0x7000_0001U, ELF_SHT_MIPS_CONFLICT = 0x7000_0002U, ELF_SHT_MIPS_GPTAB = 0x7000_0003U, ELF_SHT_MIPS_UCODE = 0x7000_0004U, ELF_SHT_MIPS_DEBUG = 0x7000_0005U, ELF_SHT_MIPS_REGINFO = 0x7000_0006U, ELF_SHT_MIPS_PACKAGE = 0x7000_0007U, ELF_SHT_MIPS_PACKSYM = 0x7000_0008U, ELF_SHT_MIPS_RELD = 0x7000_0009U, ELF_SHT_MIPS_IFACE = 0x7000_000bU, ELF_SHT_MIPS_CONTENT = 0x7000_000cU, ELF_SHT_MIPS_OPTIONS = 0x7000_000dU, ELF_SHT_MIPS_SHDR = 0x7000_0010U, ELF_SHT_MIPS_FDESC = 0x7000_0011U, ELF_SHT_MIPS_EXTSYM = 0x7000_0012U, ELF_SHT_MIPS_DENSE = 0x7000_0013U, ELF_SHT_MIPS_PDESC = 0x7000_0014U, ELF_SHT_MIPS_LOCSYM = 0x7000_0015U, ELF_SHT_MIPS_AUXSYM = 0x7000_0016U, ELF_SHT_MIPS_OPTSYM = 0x7000_0017U, ELF_SHT_MIPS_LOCSTR = 0x7000_0018U, ELF_SHT_MIPS_LINE = 0x7000_0019U, ELF_SHT_MIPS_RFDES = 0x7000_001aU, ELF_SHT_MIPS_DELTASYM = 0x7000_001bU, ELF_SHT_MIPS_DELTAINST = 0x7000_001cU, ELF_SHT_MIPS_DELTACLASS = 0x7000_001dU, ELF_SHT_MIPS_DWARF = 0x7000_001eU, ELF_SHT_MIPS_DELTADECL = 0x7000_001fU, ELF_SHT_MIPS_SYMBOL_LIB = 0x7000_0020U, ELF_SHT_MIPS_EVENTS = 0x7000_0021U, ELF_SHT_MIPS_TRANSLATE = 0x7000_0022U, ELF_SHT_MIPS_PIXIE = 0x7000_0023U, ELF_SHT_MIPS_XLATE = 0x7000_0024U, ELF_SHT_MIPS_XLATE_DEBUG = 0x7000_0025U, ELF_SHT_MIPS_WHIRL = 0x7000_0026U, ELF_SHT_MIPS_EH_REGION = 0x7000_0027U, ELF_SHT_MIPS_XLATE_OLD = 0x7000_0028U, ELF_SHT_MIPS_PDR_EXCEPTION = 0x7000_0029U, ELF_SHT_MIPS_ABIFLAGS = 0x7000_002aU, ELF_SHT_MIPS_XHASH = 0x7000_002bU; elf_config.add_enum :machine ELF_EM_MIPS :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_MIPS_MSYM, name = "MSYM", doc = "Section contains the set of dynamic shared" + " objects used when statically linking." }, Elf_Config_UInt { value = ELF_SHT_MIPS_MSYM, name = "MSYM", doc = "Used on Irix 5." }, Elf_Config_UInt { value = ELF_SHT_MIPS_CONFLICT, name = "CONFLICT", doc = "Section contains list of symbols whose definitions" + " conflict with symbols defined in shared objects."}, Elf_Config_UInt { value = ELF_SHT_MIPS_GPTAB, name = "GPTAB", doc = "Section contains the global pointer table." }, Elf_Config_UInt { value = ELF_SHT_MIPS_UCODE, name = "UCODE", doc = "Section contains microcode information. The exact" + "format is unspecified." }, Elf_Config_UInt { value = ELF_SHT_MIPS_DEBUG, name = "DEBUG", doc = "Section contains some sort of debugging information." + "Probably ECOFF symbols." }, Elf_Config_UInt { value = ELF_SHT_MIPS_REGINFO, name = "REGINFO", doc = "Section contains register usage information." }, Elf_Config_UInt { value = ELF_SHT_MIPS_PACKAGE, name = "PACKAGE" }, Elf_Config_UInt { value = ELF_SHT_MIPS_PACKSYM, name = "PACKSYM" }, Elf_Config_UInt { value = ELF_SHT_MIPS_RELD, name = "RELD" }, Elf_Config_UInt { value = ELF_SHT_MIPS_IFACE, name = "IFACE", doc = "Section contains interface information." }, Elf_Config_UInt { value = ELF_SHT_MIPS_CONTENT, name = "CONTENT", doc = "Section contains description of contents of another section." }, Elf_Config_UInt { value = ELF_SHT_MIPS_OPTIONS, name = "OPTIONS", doc = "Section contains miscellaneous options." }, Elf_Config_UInt { value = ELF_SHT_MIPS_SHDR, name = "SHDR" }, Elf_Config_UInt { value = ELF_SHT_MIPS_FDESC, name = "FDESC" }, Elf_Config_UInt { value = ELF_SHT_MIPS_EXTSYM, name = "EXTSYM" }, Elf_Config_UInt { value = ELF_SHT_MIPS_DENSE, name = "DENSE" }, Elf_Config_UInt { value = ELF_SHT_MIPS_PDESC, name = "PDESC" }, Elf_Config_UInt { value = ELF_SHT_MIPS_LOCSYM, name = "LOCSYM" }, Elf_Config_UInt { value = ELF_SHT_MIPS_AUXSYM, name = "AUXSYM" }, Elf_Config_UInt { value = ELF_SHT_MIPS_OPTSYM, name = "OPTSYM" }, Elf_Config_UInt { value = ELF_SHT_MIPS_LOCSTR, name = "LOCSTR" }, Elf_Config_UInt { value = ELF_SHT_MIPS_LINE, name = "LINE" }, Elf_Config_UInt { value = ELF_SHT_MIPS_RFDES, name = "RFDES" }, Elf_Config_UInt { value = ELF_SHT_MIPS_DELTASYM, name = "DELTASYM", doc = "Delta C++: symbol table." }, Elf_Config_UInt { value = ELF_SHT_MIPS_DELTAINST, name = "DELTAINST", doc = "Delta C++: instance table." }, Elf_Config_UInt { value = ELF_SHT_MIPS_DELTACLASS, name = "DELTACLASS", doc = "Delta C++: class table." }, Elf_Config_UInt { value = ELF_SHT_MIPS_DWARF, name = "DWARF", doc = "DWARF debugging section." }, Elf_Config_UInt { value = ELF_SHT_MIPS_DELTADECL, name = "DELTADECL", doc = "Delta C++: declarations" }, Elf_Config_UInt { value = ELF_SHT_MIPS_SYMBOL_LIB, name = "SYMBOL_LIB", doc = "List of libraries the binary depends on. Includes" + "a time stamp, version number." }, Elf_Config_UInt { value = ELF_SHT_MIPS_EVENTS, name = "EVENTS", doc = "Events section." }, Elf_Config_UInt { value = ELF_SHT_MIPS_TRANSLATE, name = "TRANSLATE" }, Elf_Config_UInt { value = ELF_SHT_MIPS_PIXIE, name = "PIXIE", doc = "Special pixie sections." }, Elf_Config_UInt { value = ELF_SHT_MIPS_XLATE, name = "XLATE", doc = "Addres translation table (for debug info)." }, Elf_Config_UInt { value = ELF_SHT_MIPS_XLATE_DEBUG, name = "XLATE_DEBUG", doc = "SGI internal address translation table (for debug info)." }, Elf_Config_UInt { value = ELF_SHT_MIPS_WHIRL, name = "WHIRL", doc = "Intermediate code." }, Elf_Config_UInt { value = ELF_SHT_MIPS_EH_REGION, name = "EH_REGION", doc = "C++ exceptino handling region info." }, Elf_Config_UInt { value = ELF_SHT_MIPS_XLATE_OLD, name = "XLATE_OLD", doc = "Obsolete address translation table (for debug info)." }, Elf_Config_UInt { value = ELF_SHT_MIPS_PDR_EXCEPTION, name = "PDR_EXCEPTION", doc = "Runtime procedure descriptor table exception information (ucode)." }, Elf_Config_UInt { value = ELF_SHT_MIPS_ABIFLAGS, name = "ABIFLAGS", doc = "ABI related flags section." }, Elf_Config_UInt { value = ELF_SHT_MIPS_XHASH, name = "XHASH", doc = "GNU style symbol hash table with xlat." }]; /* MIPS section flags. */ var ELF_SHF_MIPS_GPRE = 0x1000_0000U, ELF_SHF_MIPS_MERGE = 0x2000_0000U, ELF_SHF_MIPS_ADDR = 0x4000_0000U, ELF_SHF_MIPS_STRING = 0x8000_0000U, ELF_SHF_MIPS_NOSTRIP = 0x0800_0000U, ELF_SHF_MIPS_LOCAL = 0x0400_0000U, ELF_SHF_MIPS_NAMES = 0x0200_0000U, ELF_SHF_MIPS_NODUPES = 0x0100_0000U; elf_config.add_mask :machine ELF_EM_MIPS :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_MIPS_GPRE, name = "gpre", doc = "This section must be in the global data area." }, Elf_Config_Mask { value = ELF_SHF_MIPS_MERGE, name = "merge", doc = "This section should be merged." }, Elf_Config_Mask { value = ELF_SHF_MIPS_ADDR, name = "addr", doc = "This section contains address data of size" + " implied by section element size." }, Elf_Config_Mask { value = ELF_SHF_MIPS_STRING, name = "string", doc = "This section contains string data." }, Elf_Config_Mask { value = ELF_SHF_MIPS_NOSTRIP, name = "nostrip", doc = "This section may not be stripped." }, Elf_Config_Mask { value = ELF_SHF_MIPS_LOCAL, name = "local", doc = "This section is local to threads." }, Elf_Config_Mask { value = ELF_SHF_MIPS_NAMES, name = "names", doc = "Linker should generate implicit weak names for this section." }, Elf_Config_Mask { value = ELF_SHF_MIPS_NODUPES, name = "nodupes", doc = "Section contains text/data which may be replicated" + " in other sections. Linker should retain only one copy." }]; /* MIPS segment types. */ var ELF_PT_MIPS_REGINFO = 0x7000_0000U, ELF_PT_MIPS_RTPROC = 0x7000_0001U, ELF_PT_MIPS_OPTIONS = 0x7000_0002U, ELF_PT_MIPS_ABIFLAGS = 0x7000_0003U; elf_config.add_enum :machine ELF_EM_MIPS :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_MIPS_REGINFO, name = "reginfo", doc = "Register usage information. Identifies one .reginfo section." }, Elf_Config_UInt { value = ELF_PT_MIPS_RTPROC, name = "rtproc", doc = "Runtime procedure table." }, Elf_Config_UInt { value = ELF_PT_MIPS_OPTIONS, name = "options", doc = ".MIPS.options section." }, Elf_Config_UInt { value = ELF_PT_MIPS_ABIFLAGS, name = "abiflags", doc = "Records ABI related flags." }]; /* Values for the l_flags field of an Elf32_MIPS_Lib. */ var ELF_MIPS_LL_EXACT_MATCH = 0x0000_0001U, ELF_MIPS_LL_IGNORE_INT_VER = 0x0000_0002U, ELF_MIPS_LL_REQUIRE_MINOR = 0x0000_0004U, ELF_MIPS_LL_EXPORTS = 0x0000_0008U, ELF_MIPS_LL_DELAY_LOAD = 0x0000_0010U, ELF_MIPS_LL_DELTA = 0x0000_0020U; elf_config.add_mask :machine ELF_EM_MIPS :class "mips-l-flags" :entries [Elf_Config_Mask { value = ELF_MIPS_LL_EXACT_MATCH, name = "exact-match", doc = "Require an exact match at runtime." }, Elf_Config_Mask { value = ELF_MIPS_LL_IGNORE_INT_VER, name = "ignore-int-ver", doc = "Ignore version incompatibilities at runtime." }, Elf_Config_Mask { value = ELF_MIPS_LL_REQUIRE_MINOR, name = "require-minor", doc = "Require matching minor version number." }, Elf_Config_Mask { value = ELF_MIPS_LL_EXPORTS, name = "exports" }, Elf_Config_Mask { value = ELF_MIPS_LL_DELAY_LOAD, name = "delay-load", doc = "Delay loading of this library until really needed." }, Elf_Config_Mask { value = ELF_MIPS_LL_DELTA, name = "delta", doc = "Delta C++ stuff???" }]; /* Sections of type ELF_SHT_MIPS_LIBLIST contain an array of the following structure. The sh_link field is the section index of the string table. The sh_info field is the number of entries in the section. */ type Elf32_MIPS_Lib = struct { /* String table index for name of shared object. */ uint<32> l_name; uint<32> l_time_stamp; /* Checksum of symbol names and common sizes. */ uint<32> l_checksum; /* String table index for version. */ uint<32> l_version; /* Flags. */ uint<32> l_flags : elf_config.check_mask ("mips-l-flags", ELF_EM_MIPS, l_flags); method _print_l_flags = void: { printf "#<%s>", elf_config.format_mask ("mips-l-flags", ELF_EM_MIPS, l_flags); } }; /* Sections of type ELF_SHT_MIPS_CONFLICT contain arrays of indices into the .dynsym section. Each element of the array has the following type. */ type Elf32_MIPS_Conflict = uint<4>; type Elf64_MIPS_Conflict = uint<8>; /* Sections of type ELF_SHT_MIPS_GPTAB contain a single instance of an Elf32_MIPS_Gptab_Entry, followed by zero or more Elf32_Gptab_Entry. */ type Elf32_MIPS_Gptab_Header = struct { /* -G value actually used for this object file. */ uint<32> gt_current_g_value; uint<32> gt_unused; }; type Elf32_MIPS_Gptab_Entry = struct { /* If this -G argument has been used... */ uint<32> gt_g_value; /* ... this many GP section bytes would be required. */ uint<32> gt_bytes; }; /* Sections of type SHT_MIPS_REGINFO contain a single instance of Elf32_MIPS_RegInfo. */ type Elf32_MIPS_RegInfo = struct { /* Mask of general purpose registers used. */ uint<32> ri_gprmask; /* Mask of co-processor registers used. */ uint<32>[4] ri_cprmask; /* GP register value for this object file. */ uint<32> ri_gp_value; }; poke-elf-1.0/aclocal.m40000644000175000017500000007431714602057766011666 00000000000000# generated automatically by aclocal 1.16.5 -*- Autoconf -*- # Copyright (C) 1996-2021 Free Software Foundation, Inc. # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY, to the extent permitted by law; without # even the implied warranty of MERCHANTABILITY or FITNESS FOR A # PARTICULAR PURPOSE. m4_ifndef([AC_CONFIG_MACRO_DIRS], [m4_defun([_AM_CONFIG_MACRO_DIRS], [])m4_defun([AC_CONFIG_MACRO_DIRS], [_AM_CONFIG_MACRO_DIRS($@)])]) m4_ifndef([AC_AUTOCONF_VERSION], [m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl m4_if(m4_defn([AC_AUTOCONF_VERSION]), [2.71],, [m4_warning([this file was generated for autoconf 2.71. You have another version of autoconf. It may work, but is not guaranteed to. If you have problems, you may need to regenerate the build system entirely. To do so, use the procedure documented by the package, typically 'autoreconf'.])]) # Autoconf macros for GNU poke. # Copyright (C) 2023, 2024 Jose E. Marchesi # This file is part of GNU poke. # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program 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 for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # This macro defines the autoconf variable VARIABLE to 'poke' if the # specified minimum version of poke is found in $PATH, or to ':' # otherwise. AC_DEFUN([PK_PROG_POKE], [ AC_PATH_PROG([$1], [poke]) if test -z "$[$1]"; then ac_verc_fail=yes else AC_MSG_CHECKING([for poke $2 or newer]) # First see if poke is old enough to have pk_version. cat >conftest.pk <<_ACEOF pk_version; _ACEOF ac_poke_has_pk_version=no if $$1 -L conftest.pk 2>&1 >/dev/null; then ac_poke_has_pk_version=yes fi if test "x$ac_poke_has_pk_version" = "xyes"; then cat >conftest.pk <<_ACEOF exit ((pk_vercmp (pk_version_parse (pk_version), pk_version_parse ("$2")) >= 0) ? 0 : 1); _ACEOF ac_prog_version=`$$1 --version 2>&1 | sed -n 's/^.*GNU poke.* \(.*$\)/\1/p'` if $$1 -L conftest.pk 2>&1 >/dev/null; then ac_prog_version="$ac_prog_version, ok" ac_verc_fail=no else ac_prog_version="$ac_prog_version, bad" ac_verc_fail=yes fi else ac_prog_version="unknown" fi rm -f conftest.pk AC_MSG_RESULT([$ac_prog_version]) fi if test $ac_verc_fail = yes; then [$1]=: fi AC_SUBST([$1]) ]) # If POKE can load the given PICKLE, execute IF_FOUND, otherwise # execute IF_NOT_FOUND. AC_DEFUN([PK_CHECK_PICKLE], [ cat >conftest.pk <<_ACEOF load "$2"; _ACEOF AC_MSG_CHECKING([whether poke can load pickle $2]) ac_pickle_found= if $1 -L conftest.pk 2>&1 >/dev/null; then ac_pickle_found=yes $3 else ac_pickle_found=no $4 fi rm -f conftest.pk AC_MSG_RESULT([$ac_pickle_found]) ]) # Copyright (C) 2002-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_AUTOMAKE_VERSION(VERSION) # ---------------------------- # Automake X.Y traces this macro to ensure aclocal.m4 has been # generated from the m4 files accompanying Automake X.Y. # (This private macro should not be called outside this file.) AC_DEFUN([AM_AUTOMAKE_VERSION], [am__api_version='1.16' dnl Some users find AM_AUTOMAKE_VERSION and mistake it for a way to dnl require some minimum version. Point them to the right macro. m4_if([$1], [1.16.5], [], [AC_FATAL([Do not call $0, use AM_INIT_AUTOMAKE([$1]).])])dnl ]) # _AM_AUTOCONF_VERSION(VERSION) # ----------------------------- # aclocal traces this macro to find the Autoconf version. # This is a private macro too. Using m4_define simplifies # the logic in aclocal, which can simply ignore this definition. m4_define([_AM_AUTOCONF_VERSION], []) # AM_SET_CURRENT_AUTOMAKE_VERSION # ------------------------------- # Call AM_AUTOMAKE_VERSION and AM_AUTOMAKE_VERSION so they can be traced. # This function is AC_REQUIREd by AM_INIT_AUTOMAKE. AC_DEFUN([AM_SET_CURRENT_AUTOMAKE_VERSION], [AM_AUTOMAKE_VERSION([1.16.5])dnl m4_ifndef([AC_AUTOCONF_VERSION], [m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl _AM_AUTOCONF_VERSION(m4_defn([AC_AUTOCONF_VERSION]))]) # AM_AUX_DIR_EXPAND -*- Autoconf -*- # Copyright (C) 2001-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # For projects using AC_CONFIG_AUX_DIR([foo]), Autoconf sets # $ac_aux_dir to '$srcdir/foo'. In other projects, it is set to # '$srcdir', '$srcdir/..', or '$srcdir/../..'. # # Of course, Automake must honor this variable whenever it calls a # tool from the auxiliary directory. The problem is that $srcdir (and # therefore $ac_aux_dir as well) can be either absolute or relative, # depending on how configure is run. This is pretty annoying, since # it makes $ac_aux_dir quite unusable in subdirectories: in the top # source directory, any form will work fine, but in subdirectories a # relative path needs to be adjusted first. # # $ac_aux_dir/missing # fails when called from a subdirectory if $ac_aux_dir is relative # $top_srcdir/$ac_aux_dir/missing # fails if $ac_aux_dir is absolute, # fails when called from a subdirectory in a VPATH build with # a relative $ac_aux_dir # # The reason of the latter failure is that $top_srcdir and $ac_aux_dir # are both prefixed by $srcdir. In an in-source build this is usually # harmless because $srcdir is '.', but things will broke when you # start a VPATH build or use an absolute $srcdir. # # So we could use something similar to $top_srcdir/$ac_aux_dir/missing, # iff we strip the leading $srcdir from $ac_aux_dir. That would be: # am_aux_dir='\$(top_srcdir)/'`expr "$ac_aux_dir" : "$srcdir//*\(.*\)"` # and then we would define $MISSING as # MISSING="\${SHELL} $am_aux_dir/missing" # This will work as long as MISSING is not called from configure, because # unfortunately $(top_srcdir) has no meaning in configure. # However there are other variables, like CC, which are often used in # configure, and could therefore not use this "fixed" $ac_aux_dir. # # Another solution, used here, is to always expand $ac_aux_dir to an # absolute PATH. The drawback is that using absolute paths prevent a # configured tree to be moved without reconfiguration. AC_DEFUN([AM_AUX_DIR_EXPAND], [AC_REQUIRE([AC_CONFIG_AUX_DIR_DEFAULT])dnl # Expand $ac_aux_dir to an absolute path. am_aux_dir=`cd "$ac_aux_dir" && pwd` ]) # AM_CONDITIONAL -*- Autoconf -*- # Copyright (C) 1997-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_CONDITIONAL(NAME, SHELL-CONDITION) # ------------------------------------- # Define a conditional. AC_DEFUN([AM_CONDITIONAL], [AC_PREREQ([2.52])dnl m4_if([$1], [TRUE], [AC_FATAL([$0: invalid condition: $1])], [$1], [FALSE], [AC_FATAL([$0: invalid condition: $1])])dnl AC_SUBST([$1_TRUE])dnl AC_SUBST([$1_FALSE])dnl _AM_SUBST_NOTMAKE([$1_TRUE])dnl _AM_SUBST_NOTMAKE([$1_FALSE])dnl m4_define([_AM_COND_VALUE_$1], [$2])dnl if $2; then $1_TRUE= $1_FALSE='#' else $1_TRUE='#' $1_FALSE= fi AC_CONFIG_COMMANDS_PRE( [if test -z "${$1_TRUE}" && test -z "${$1_FALSE}"; then AC_MSG_ERROR([[conditional "$1" was never defined. Usually this means the macro was only invoked conditionally.]]) fi])]) # Do all the work for Automake. -*- Autoconf -*- # Copyright (C) 1996-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # This macro actually does too much. Some checks are only needed if # your package does certain things. But this isn't really a big deal. dnl Redefine AC_PROG_CC to automatically invoke _AM_PROG_CC_C_O. m4_define([AC_PROG_CC], m4_defn([AC_PROG_CC]) [_AM_PROG_CC_C_O ]) # AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE]) # AM_INIT_AUTOMAKE([OPTIONS]) # ----------------------------------------------- # The call with PACKAGE and VERSION arguments is the old style # call (pre autoconf-2.50), which is being phased out. PACKAGE # and VERSION should now be passed to AC_INIT and removed from # the call to AM_INIT_AUTOMAKE. # We support both call styles for the transition. After # the next Automake release, Autoconf can make the AC_INIT # arguments mandatory, and then we can depend on a new Autoconf # release and drop the old call support. AC_DEFUN([AM_INIT_AUTOMAKE], [AC_PREREQ([2.65])dnl m4_ifdef([_$0_ALREADY_INIT], [m4_fatal([$0 expanded multiple times ]m4_defn([_$0_ALREADY_INIT]))], [m4_define([_$0_ALREADY_INIT], m4_expansion_stack)])dnl dnl Autoconf wants to disallow AM_ names. We explicitly allow dnl the ones we care about. m4_pattern_allow([^AM_[A-Z]+FLAGS$])dnl AC_REQUIRE([AM_SET_CURRENT_AUTOMAKE_VERSION])dnl AC_REQUIRE([AC_PROG_INSTALL])dnl if test "`cd $srcdir && pwd`" != "`pwd`"; then # Use -I$(srcdir) only when $(srcdir) != ., so that make's output # is not polluted with repeated "-I." AC_SUBST([am__isrc], [' -I$(srcdir)'])_AM_SUBST_NOTMAKE([am__isrc])dnl # test to see if srcdir already configured if test -f $srcdir/config.status; then AC_MSG_ERROR([source directory already configured; run "make distclean" there first]) fi fi # test whether we have cygpath if test -z "$CYGPATH_W"; then if (cygpath --version) >/dev/null 2>/dev/null; then CYGPATH_W='cygpath -w' else CYGPATH_W=echo fi fi AC_SUBST([CYGPATH_W]) # Define the identity of the package. dnl Distinguish between old-style and new-style calls. m4_ifval([$2], [AC_DIAGNOSE([obsolete], [$0: two- and three-arguments forms are deprecated.]) m4_ifval([$3], [_AM_SET_OPTION([no-define])])dnl AC_SUBST([PACKAGE], [$1])dnl AC_SUBST([VERSION], [$2])], [_AM_SET_OPTIONS([$1])dnl dnl Diagnose old-style AC_INIT with new-style AM_AUTOMAKE_INIT. m4_if( m4_ifset([AC_PACKAGE_NAME], [ok]):m4_ifset([AC_PACKAGE_VERSION], [ok]), [ok:ok],, [m4_fatal([AC_INIT should be called with package and version arguments])])dnl AC_SUBST([PACKAGE], ['AC_PACKAGE_TARNAME'])dnl AC_SUBST([VERSION], ['AC_PACKAGE_VERSION'])])dnl _AM_IF_OPTION([no-define],, [AC_DEFINE_UNQUOTED([PACKAGE], ["$PACKAGE"], [Name of package]) AC_DEFINE_UNQUOTED([VERSION], ["$VERSION"], [Version number of package])])dnl # Some tools Automake needs. AC_REQUIRE([AM_SANITY_CHECK])dnl AC_REQUIRE([AC_ARG_PROGRAM])dnl AM_MISSING_PROG([ACLOCAL], [aclocal-${am__api_version}]) AM_MISSING_PROG([AUTOCONF], [autoconf]) AM_MISSING_PROG([AUTOMAKE], [automake-${am__api_version}]) AM_MISSING_PROG([AUTOHEADER], [autoheader]) AM_MISSING_PROG([MAKEINFO], [makeinfo]) AC_REQUIRE([AM_PROG_INSTALL_SH])dnl AC_REQUIRE([AM_PROG_INSTALL_STRIP])dnl AC_REQUIRE([AC_PROG_MKDIR_P])dnl # For better backward compatibility. To be removed once Automake 1.9.x # dies out for good. For more background, see: # # AC_SUBST([mkdir_p], ['$(MKDIR_P)']) # We need awk for the "check" target (and possibly the TAP driver). The # system "awk" is bad on some platforms. AC_REQUIRE([AC_PROG_AWK])dnl AC_REQUIRE([AC_PROG_MAKE_SET])dnl AC_REQUIRE([AM_SET_LEADING_DOT])dnl _AM_IF_OPTION([tar-ustar], [_AM_PROG_TAR([ustar])], [_AM_IF_OPTION([tar-pax], [_AM_PROG_TAR([pax])], [_AM_PROG_TAR([v7])])]) _AM_IF_OPTION([no-dependencies],, [AC_PROVIDE_IFELSE([AC_PROG_CC], [_AM_DEPENDENCIES([CC])], [m4_define([AC_PROG_CC], m4_defn([AC_PROG_CC])[_AM_DEPENDENCIES([CC])])])dnl AC_PROVIDE_IFELSE([AC_PROG_CXX], [_AM_DEPENDENCIES([CXX])], [m4_define([AC_PROG_CXX], m4_defn([AC_PROG_CXX])[_AM_DEPENDENCIES([CXX])])])dnl AC_PROVIDE_IFELSE([AC_PROG_OBJC], [_AM_DEPENDENCIES([OBJC])], [m4_define([AC_PROG_OBJC], m4_defn([AC_PROG_OBJC])[_AM_DEPENDENCIES([OBJC])])])dnl AC_PROVIDE_IFELSE([AC_PROG_OBJCXX], [_AM_DEPENDENCIES([OBJCXX])], [m4_define([AC_PROG_OBJCXX], m4_defn([AC_PROG_OBJCXX])[_AM_DEPENDENCIES([OBJCXX])])])dnl ]) # Variables for tags utilities; see am/tags.am if test -z "$CTAGS"; then CTAGS=ctags fi AC_SUBST([CTAGS]) if test -z "$ETAGS"; then ETAGS=etags fi AC_SUBST([ETAGS]) if test -z "$CSCOPE"; then CSCOPE=cscope fi AC_SUBST([CSCOPE]) AC_REQUIRE([AM_SILENT_RULES])dnl dnl The testsuite driver may need to know about EXEEXT, so add the dnl 'am__EXEEXT' conditional if _AM_COMPILER_EXEEXT was seen. This dnl macro is hooked onto _AC_COMPILER_EXEEXT early, see below. AC_CONFIG_COMMANDS_PRE(dnl [m4_provide_if([_AM_COMPILER_EXEEXT], [AM_CONDITIONAL([am__EXEEXT], [test -n "$EXEEXT"])])])dnl # POSIX will say in a future version that running "rm -f" with no argument # is OK; and we want to be able to make that assumption in our Makefile # recipes. So use an aggressive probe to check that the usage we want is # actually supported "in the wild" to an acceptable degree. # See automake bug#10828. # To make any issue more visible, cause the running configure to be aborted # by default if the 'rm' program in use doesn't match our expectations; the # user can still override this though. if rm -f && rm -fr && rm -rf; then : OK; else cat >&2 <<'END' Oops! Your 'rm' program seems unable to run without file operands specified on the command line, even when the '-f' option is present. This is contrary to the behaviour of most rm programs out there, and not conforming with the upcoming POSIX standard: Please tell bug-automake@gnu.org about your system, including the value of your $PATH and any error possibly output before this message. This can help us improve future automake versions. END if test x"$ACCEPT_INFERIOR_RM_PROGRAM" = x"yes"; then echo 'Configuration will proceed anyway, since you have set the' >&2 echo 'ACCEPT_INFERIOR_RM_PROGRAM variable to "yes"' >&2 echo >&2 else cat >&2 <<'END' Aborting the configuration process, to ensure you take notice of the issue. You can download and install GNU coreutils to get an 'rm' implementation that behaves properly: . If you want to complete the configuration process using your problematic 'rm' anyway, export the environment variable ACCEPT_INFERIOR_RM_PROGRAM to "yes", and re-run configure. END AC_MSG_ERROR([Your 'rm' program is bad, sorry.]) fi fi dnl The trailing newline in this macro's definition is deliberate, for dnl backward compatibility and to allow trailing 'dnl'-style comments dnl after the AM_INIT_AUTOMAKE invocation. See automake bug#16841. ]) dnl Hook into '_AC_COMPILER_EXEEXT' early to learn its expansion. Do not dnl add the conditional right here, as _AC_COMPILER_EXEEXT may be further dnl mangled by Autoconf and run in a shell conditional statement. m4_define([_AC_COMPILER_EXEEXT], m4_defn([_AC_COMPILER_EXEEXT])[m4_provide([_AM_COMPILER_EXEEXT])]) # When config.status generates a header, we must update the stamp-h file. # This file resides in the same directory as the config header # that is generated. The stamp files are numbered to have different names. # Autoconf calls _AC_AM_CONFIG_HEADER_HOOK (when defined) in the # loop where config.status creates the headers, so we can generate # our stamp files there. AC_DEFUN([_AC_AM_CONFIG_HEADER_HOOK], [# Compute $1's index in $config_headers. _am_arg=$1 _am_stamp_count=1 for _am_header in $config_headers :; do case $_am_header in $_am_arg | $_am_arg:* ) break ;; * ) _am_stamp_count=`expr $_am_stamp_count + 1` ;; esac done echo "timestamp for $_am_arg" >`AS_DIRNAME(["$_am_arg"])`/stamp-h[]$_am_stamp_count]) # Copyright (C) 2001-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_PROG_INSTALL_SH # ------------------ # Define $install_sh. AC_DEFUN([AM_PROG_INSTALL_SH], [AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl if test x"${install_sh+set}" != xset; then case $am_aux_dir in *\ * | *\ *) install_sh="\${SHELL} '$am_aux_dir/install-sh'" ;; *) install_sh="\${SHELL} $am_aux_dir/install-sh" esac fi AC_SUBST([install_sh])]) # Copyright (C) 2003-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # Check whether the underlying file-system supports filenames # with a leading dot. For instance MS-DOS doesn't. AC_DEFUN([AM_SET_LEADING_DOT], [rm -rf .tst 2>/dev/null mkdir .tst 2>/dev/null if test -d .tst; then am__leading_dot=. else am__leading_dot=_ fi rmdir .tst 2>/dev/null AC_SUBST([am__leading_dot])]) # Fake the existence of programs that GNU maintainers use. -*- Autoconf -*- # Copyright (C) 1997-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_MISSING_PROG(NAME, PROGRAM) # ------------------------------ AC_DEFUN([AM_MISSING_PROG], [AC_REQUIRE([AM_MISSING_HAS_RUN]) $1=${$1-"${am_missing_run}$2"} AC_SUBST($1)]) # AM_MISSING_HAS_RUN # ------------------ # Define MISSING if not defined so far and test if it is modern enough. # If it is, set am_missing_run to use it, otherwise, to nothing. AC_DEFUN([AM_MISSING_HAS_RUN], [AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl AC_REQUIRE_AUX_FILE([missing])dnl if test x"${MISSING+set}" != xset; then MISSING="\${SHELL} '$am_aux_dir/missing'" fi # Use eval to expand $SHELL if eval "$MISSING --is-lightweight"; then am_missing_run="$MISSING " else am_missing_run= AC_MSG_WARN(['missing' script is too old or missing]) fi ]) # Helper functions for option handling. -*- Autoconf -*- # Copyright (C) 2001-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # _AM_MANGLE_OPTION(NAME) # ----------------------- AC_DEFUN([_AM_MANGLE_OPTION], [[_AM_OPTION_]m4_bpatsubst($1, [[^a-zA-Z0-9_]], [_])]) # _AM_SET_OPTION(NAME) # -------------------- # Set option NAME. Presently that only means defining a flag for this option. AC_DEFUN([_AM_SET_OPTION], [m4_define(_AM_MANGLE_OPTION([$1]), [1])]) # _AM_SET_OPTIONS(OPTIONS) # ------------------------ # OPTIONS is a space-separated list of Automake options. AC_DEFUN([_AM_SET_OPTIONS], [m4_foreach_w([_AM_Option], [$1], [_AM_SET_OPTION(_AM_Option)])]) # _AM_IF_OPTION(OPTION, IF-SET, [IF-NOT-SET]) # ------------------------------------------- # Execute IF-SET if OPTION is set, IF-NOT-SET otherwise. AC_DEFUN([_AM_IF_OPTION], [m4_ifset(_AM_MANGLE_OPTION([$1]), [$2], [$3])]) # Check to make sure that the build environment is sane. -*- Autoconf -*- # Copyright (C) 1996-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_SANITY_CHECK # --------------- AC_DEFUN([AM_SANITY_CHECK], [AC_MSG_CHECKING([whether build environment is sane]) # Reject unsafe characters in $srcdir or the absolute working directory # name. Accept space and tab only in the latter. am_lf=' ' case `pwd` in *[[\\\"\#\$\&\'\`$am_lf]]*) AC_MSG_ERROR([unsafe absolute working directory name]);; esac case $srcdir in *[[\\\"\#\$\&\'\`$am_lf\ \ ]]*) AC_MSG_ERROR([unsafe srcdir value: '$srcdir']);; esac # Do 'set' in a subshell so we don't clobber the current shell's # arguments. Must try -L first in case configure is actually a # symlink; some systems play weird games with the mod time of symlinks # (eg FreeBSD returns the mod time of the symlink's containing # directory). if ( am_has_slept=no for am_try in 1 2; do echo "timestamp, slept: $am_has_slept" > conftest.file set X `ls -Lt "$srcdir/configure" conftest.file 2> /dev/null` if test "$[*]" = "X"; then # -L didn't work. set X `ls -t "$srcdir/configure" conftest.file` fi if test "$[*]" != "X $srcdir/configure conftest.file" \ && test "$[*]" != "X conftest.file $srcdir/configure"; then # If neither matched, then we have a broken ls. This can happen # if, for instance, CONFIG_SHELL is bash and it inherits a # broken ls alias from the environment. This has actually # happened. Such a system could not be considered "sane". AC_MSG_ERROR([ls -t appears to fail. Make sure there is not a broken alias in your environment]) fi if test "$[2]" = conftest.file || test $am_try -eq 2; then break fi # Just in case. sleep 1 am_has_slept=yes done test "$[2]" = conftest.file ) then # Ok. : else AC_MSG_ERROR([newly created file is older than distributed files! Check your system clock]) fi AC_MSG_RESULT([yes]) # If we didn't sleep, we still need to ensure time stamps of config.status and # generated files are strictly newer. am_sleep_pid= if grep 'slept: no' conftest.file >/dev/null 2>&1; then ( sleep 1 ) & am_sleep_pid=$! fi AC_CONFIG_COMMANDS_PRE( [AC_MSG_CHECKING([that generated files are newer than configure]) if test -n "$am_sleep_pid"; then # Hide warnings about reused PIDs. wait $am_sleep_pid 2>/dev/null fi AC_MSG_RESULT([done])]) rm -f conftest.file ]) # Copyright (C) 2009-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_SILENT_RULES([DEFAULT]) # -------------------------- # Enable less verbose build rules; with the default set to DEFAULT # ("yes" being less verbose, "no" or empty being verbose). AC_DEFUN([AM_SILENT_RULES], [AC_ARG_ENABLE([silent-rules], [dnl AS_HELP_STRING( [--enable-silent-rules], [less verbose build output (undo: "make V=1")]) AS_HELP_STRING( [--disable-silent-rules], [verbose build output (undo: "make V=0")])dnl ]) case $enable_silent_rules in @%:@ ((( yes) AM_DEFAULT_VERBOSITY=0;; no) AM_DEFAULT_VERBOSITY=1;; *) AM_DEFAULT_VERBOSITY=m4_if([$1], [yes], [0], [1]);; esac dnl dnl A few 'make' implementations (e.g., NonStop OS and NextStep) dnl do not support nested variable expansions. dnl See automake bug#9928 and bug#10237. am_make=${MAKE-make} AC_CACHE_CHECK([whether $am_make supports nested variables], [am_cv_make_support_nested_variables], [if AS_ECHO([['TRUE=$(BAR$(V)) BAR0=false BAR1=true V=1 am__doit: @$(TRUE) .PHONY: am__doit']]) | $am_make -f - >/dev/null 2>&1; then am_cv_make_support_nested_variables=yes else am_cv_make_support_nested_variables=no fi]) if test $am_cv_make_support_nested_variables = yes; then dnl Using '$V' instead of '$(V)' breaks IRIX make. AM_V='$(V)' AM_DEFAULT_V='$(AM_DEFAULT_VERBOSITY)' else AM_V=$AM_DEFAULT_VERBOSITY AM_DEFAULT_V=$AM_DEFAULT_VERBOSITY fi AC_SUBST([AM_V])dnl AM_SUBST_NOTMAKE([AM_V])dnl AC_SUBST([AM_DEFAULT_V])dnl AM_SUBST_NOTMAKE([AM_DEFAULT_V])dnl AC_SUBST([AM_DEFAULT_VERBOSITY])dnl AM_BACKSLASH='\' AC_SUBST([AM_BACKSLASH])dnl _AM_SUBST_NOTMAKE([AM_BACKSLASH])dnl ]) # Copyright (C) 2001-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # AM_PROG_INSTALL_STRIP # --------------------- # One issue with vendor 'install' (even GNU) is that you can't # specify the program used to strip binaries. This is especially # annoying in cross-compiling environments, where the build's strip # is unlikely to handle the host's binaries. # Fortunately install-sh will honor a STRIPPROG variable, so we # always use install-sh in "make install-strip", and initialize # STRIPPROG with the value of the STRIP variable (set by the user). AC_DEFUN([AM_PROG_INSTALL_STRIP], [AC_REQUIRE([AM_PROG_INSTALL_SH])dnl # Installed binaries are usually stripped using 'strip' when the user # run "make install-strip". However 'strip' might not be the right # tool to use in cross-compilation environments, therefore Automake # will honor the 'STRIP' environment variable to overrule this program. dnl Don't test for $cross_compiling = yes, because it might be 'maybe'. if test "$cross_compiling" != no; then AC_CHECK_TOOL([STRIP], [strip], :) fi INSTALL_STRIP_PROGRAM="\$(install_sh) -c -s" AC_SUBST([INSTALL_STRIP_PROGRAM])]) # Copyright (C) 2006-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # _AM_SUBST_NOTMAKE(VARIABLE) # --------------------------- # Prevent Automake from outputting VARIABLE = @VARIABLE@ in Makefile.in. # This macro is traced by Automake. AC_DEFUN([_AM_SUBST_NOTMAKE]) # AM_SUBST_NOTMAKE(VARIABLE) # -------------------------- # Public sister of _AM_SUBST_NOTMAKE. AC_DEFUN([AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE($@)]) # Check how to create a tarball. -*- Autoconf -*- # Copyright (C) 2004-2021 Free Software Foundation, Inc. # # This file is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. # _AM_PROG_TAR(FORMAT) # -------------------- # Check how to create a tarball in format FORMAT. # FORMAT should be one of 'v7', 'ustar', or 'pax'. # # Substitute a variable $(am__tar) that is a command # writing to stdout a FORMAT-tarball containing the directory # $tardir. # tardir=directory && $(am__tar) > result.tar # # Substitute a variable $(am__untar) that extract such # a tarball read from stdin. # $(am__untar) < result.tar # AC_DEFUN([_AM_PROG_TAR], [# Always define AMTAR for backward compatibility. Yes, it's still used # in the wild :-( We should find a proper way to deprecate it ... AC_SUBST([AMTAR], ['$${TAR-tar}']) # We'll loop over all known methods to create a tar archive until one works. _am_tools='gnutar m4_if([$1], [ustar], [plaintar]) pax cpio none' m4_if([$1], [v7], [am__tar='$${TAR-tar} chof - "$$tardir"' am__untar='$${TAR-tar} xf -'], [m4_case([$1], [ustar], [# The POSIX 1988 'ustar' format is defined with fixed-size fields. # There is notably a 21 bits limit for the UID and the GID. In fact, # the 'pax' utility can hang on bigger UID/GID (see automake bug#8343 # and bug#13588). am_max_uid=2097151 # 2^21 - 1 am_max_gid=$am_max_uid # The $UID and $GID variables are not portable, so we need to resort # to the POSIX-mandated id(1) utility. Errors in the 'id' calls # below are definitely unexpected, so allow the users to see them # (that is, avoid stderr redirection). am_uid=`id -u || echo unknown` am_gid=`id -g || echo unknown` AC_MSG_CHECKING([whether UID '$am_uid' is supported by ustar format]) if test $am_uid -le $am_max_uid; then AC_MSG_RESULT([yes]) else AC_MSG_RESULT([no]) _am_tools=none fi AC_MSG_CHECKING([whether GID '$am_gid' is supported by ustar format]) if test $am_gid -le $am_max_gid; then AC_MSG_RESULT([yes]) else AC_MSG_RESULT([no]) _am_tools=none fi], [pax], [], [m4_fatal([Unknown tar format])]) AC_MSG_CHECKING([how to create a $1 tar archive]) # Go ahead even if we have the value already cached. We do so because we # need to set the values for the 'am__tar' and 'am__untar' variables. _am_tools=${am_cv_prog_tar_$1-$_am_tools} for _am_tool in $_am_tools; do case $_am_tool in gnutar) for _am_tar in tar gnutar gtar; do AM_RUN_LOG([$_am_tar --version]) && break done am__tar="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$$tardir"' am__tar_="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$tardir"' am__untar="$_am_tar -xf -" ;; plaintar) # Must skip GNU tar: if it does not support --format= it doesn't create # ustar tarball either. (tar --version) >/dev/null 2>&1 && continue am__tar='tar chf - "$$tardir"' am__tar_='tar chf - "$tardir"' am__untar='tar xf -' ;; pax) am__tar='pax -L -x $1 -w "$$tardir"' am__tar_='pax -L -x $1 -w "$tardir"' am__untar='pax -r' ;; cpio) am__tar='find "$$tardir" -print | cpio -o -H $1 -L' am__tar_='find "$tardir" -print | cpio -o -H $1 -L' am__untar='cpio -i -H $1 -d' ;; none) am__tar=false am__tar_=false am__untar=false ;; esac # If the value was cached, stop now. We just wanted to have am__tar # and am__untar set. test -n "${am_cv_prog_tar_$1}" && break # tar/untar a dummy directory, and stop if the command works. rm -rf conftest.dir mkdir conftest.dir echo GrepMe > conftest.dir/file AM_RUN_LOG([tardir=conftest.dir && eval $am__tar_ >conftest.tar]) rm -rf conftest.dir if test -s conftest.tar; then AM_RUN_LOG([$am__untar /dev/null 2>&1 && break fi done rm -rf conftest.dir AC_CACHE_VAL([am_cv_prog_tar_$1], [am_cv_prog_tar_$1=$_am_tool]) AC_MSG_RESULT([$am_cv_prog_tar_$1])]) AC_SUBST([am__tar]) AC_SUBST([am__untar]) ]) # _AM_PROG_TAR poke-elf-1.0/elf-64.pk0000644000175000017500000003205514602057323011335 00000000000000/* elf-64.pk - 64-bit ELF definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* ELF64 basic types. */ type Elf64_Xword = uint<64>, Elf64_Sxword = int<64>, Elf64_Addr = offset,B>, Elf64_Off = offset,B>; /* ELF64 relocation info. r_sym is the symbol table index with respect to which the relocation must be made. r_type is the type of relocation to apply, which is architecture-specific. */ type Elf64_RelInfo = struct Elf64_Xword { uint<32> r_sym; uint<32> r_type : elf_config.check_enum ("reloc-types", elf_mach, r_type); method _print_r_type = void: { printf "#<%s>", elf_config.format_enum ("reloc-types", elf_mach, r_type); } }; /* ELF64 REL relocation entry. */ type Elf64_Rel = struct { Elf64_Addr r_offset; Elf64_RelInfo r_info; }; /* ELF64 RELA relocation entry. r_offset holds a section offset in relocatable files, a virtual address in executable and shared object files. r_addend holds a constant value to be added to the relocation's value. In architectures using Rel relocations this addend is somehow stored in the relocation's memory location. */ type Elf64_Rela = struct { Elf64_Addr r_offset; Elf64_RelInfo r_info; offset r_addend; }; /* ELF64 RELR relocation entry. */ type Elf64_Relr = Elf64_Xword; /* ELF64 symbol. */ type Elf64_Sym = struct { offset st_name; Elf_Sym_Info st_info; Elf_Sym_Other_Info st_other : (st_info.st_bind == ELF_STB_LOCAL => +st_other != ELF_STV_PROTECTED); Elf_Half st_shndx; Elf64_Addr st_value; Elf64_Xword st_size; }; /* Compressed section header, used in sections flagged with SHF_COMPRESSED. */ type Elf64_Chdr = struct { /* This member specifies the compression algorithm. */ Elf_Word ch_type : elf_compress_algorithm_p (ch_type); Elf_Word ch_reserved; /* Size and required alignment of the uncompressed data. */ offset ch_size; offset ch_addralign; }; /* The ELF64 dynamic section contents. */ type Elf64_Dyn = struct { Elf64_Sxword d_tag : elf_config.check_enum ("dynamic-tag-types", elf_mach, d_tag); union { Elf64_Addr d_ptr : elf_tag_is_ptr (d_tag); Elf64_Xword d_val; } d_data; method _print_d_tag = void: { printf "#<%s>", elf_config.format_enum ("dynamic-tag-types", elf_mach, d_tag); } }; /* ELF64 section group. */ type Elf64_Group = struct { Elf_Word flags; Elf_Word[] entries; /* Section header indices. */ }; /* ELF64 section header table entry. */ type Elf64_Shdr = struct { offset sh_name; Elf_Word sh_type : sh_type >= ELF_SHT_LOUSER && sh_type <= ELF_SHT_HIUSER || elf_config.check_enum ("section-types", elf_mach, sh_type); Elf64_Xword sh_flags : elf_config.check_mask ("section-flags", elf_mach, sh_flags) && (sh_flags & ELF_SHF_COMPRESSED => (sh_type != ELF_SHT_NOBITS && !(sh_flags & ELF_SHF_ALLOC))); Elf64_Addr sh_addr; Elf64_Off sh_offset; offset sh_size; Elf_Word sh_link; Elf_Word sh_info; Elf64_Xword sh_addralign; offset sh_entsize; method _print_sh_type = void: { printf "#<%s>", elf_config.format_enum ("section-types", elf_mach, sh_type); } method _print_sh_flags = void: { printf "#<%s>", elf_config.format_mask ("section-flags", elf_mach, sh_flags); } }; /* ELF64 program header table entry. */ type Elf64_Phdr = struct { Elf_Word p_type : elf_config.check_enum ("segment-types", elf_mach, p_type); Elf_Word p_flags : p_type == ELF_PT_NULL || elf_config.check_mask ("segment-flags", elf_mach, p_flags); Elf64_Off p_offset; Elf64_Addr p_vaddr; Elf64_Addr p_paddr; offset p_filesz; offset p_memsz : p_type == ELF_PT_LOAD => p_memsz >= p_filesz; offset p_align : (p_align < 2#B || ((p_align & (p_align - 1#B)) == 0#B) /* Is a power of 2. */ && ((p_vaddr - p_offset) % p_align) == 0#B); method _print_p_type = void: { printf "#<%s>", elf_config.format_enum ("segment-types", elf_mach, p_type); } method _print_p_flags = void: { printf "#<%s>", elf_config.format_mask ("segment-flags", elf_mach, p_flags); } }; /* ELF64 file header. */ type Elf64_Ehdr = struct { fun set_mach = (int<32> mach) int<32>: { elf_selected_mach = mach; return 1; } Elf_Ident e_ident; Elf_Half e_type : elf_config.check_enum ("file-types", elf_mach, e_type); Elf_Half e_machine : elf_config.check_enum ("elf-machines", elf_mach, e_machine) && set_mach (e_machine); Elf_Word e_version = ELF_EV_CURRENT; Elf64_Addr e_entry; Elf64_Off e_phoff; Elf64_Off e_shoff; Elf_Word e_flags : elf_config.check_mask ("file-flags", elf_mach, e_flags); offset e_ehsize; offset e_phentsize; Elf_Half e_phnum; offset e_shentsize; Elf_Half e_shnum; Elf_Half e_shstrndx : e_shnum == 0 || e_shstrndx < e_shnum; method _print_e_type = void: { printf "#<%s>", elf_config.format_enum ("file-types", elf_mach, e_type); } method _print_e_flags = void: { printf "#<%s>", elf_config.format_mask ("file-flags", elf_mach, e_flags); } method _print_e_machine = void: { printf "#<%s>", elf_config.format_enum ("elf-machines", elf_mach, e_machine); } }; /* ELF64 file. */ fun elf64_check_phdr = (Elf64_Phdr[] phdr) int<32>: { var found_loadable = 0, found_phdr = 0, found_interp = 0; for (segment in phdr) { /* Some entries must appear before any loadable segment, and appear only once in the table. */ if (segment.p_type == ELF_PT_INTERP && (found_loadable || found_interp)) return 0; if (segment.p_type == ELF_PT_PHDR && (found_loadable || found_phdr)) return 0; found_interp = segment.p_type == ELF_PT_INTERP; found_phdr = segment.p_type == ELF_PT_PHDR; found_loadable += segment.p_type == ELF_PT_LOAD; } return 1; } type Elf64_File = struct { Elf64_Ehdr ehdr; if (ehdr.e_shnum > 0) Elf64_Shdr[ehdr.e_shnum] shdr @ ehdr.e_shoff; if (ehdr.e_phnum > 0) Elf64_Phdr[ehdr.e_phnum] phdr : elf64_check_phdr (phdr) @ ehdr.e_phoff; /* Given an offset into the ELF file's section string table, return the string. */ method get_section_name = (offset offset) string: { var strtab = ehdr.e_shstrndx; return string @ shdr'ios : shdr[strtab].sh_offset + offset; } /* Given a symtab and an offset into its associated symbol string table, return the string. */ method get_symbol_name = (Elf64_Shdr symtab, offset offset) string: { var strtab = symtab.sh_link; return string @ shdr'ios : shdr[strtab].sh_offset + offset; } /* Given a section name, return an array of section headers in the ELF file having that name. */ method get_sections_by_name = (string name) Elf64_Shdr[]: { var sections = Elf64_Shdr[](); for (s in shdr where get_section_name (s.sh_name) == name) apush (sections, s); return sections; } /* Given a section type (SHT_* value) return an array of section headers in the ELF file with that type. */ method get_sections_by_type = (Elf_Word stype) Elf64_Shdr[]: { var sections = Elf64_Shdr[](); for (s in shdr where (s.sh_type as Elf_Word) == stype) apush (sections, s); return sections; } /* Given a section name, return whether it exists in this file. */ method section_name_p = (string name) int<32>: { var sections = Elf64_Shdr[](); try sections = get_sections_by_name (name); catch if E_inval { return 0; } return sections'length; } /* Given an offset, return the string stored at that offset in the "default" string table of the ELF file. This is the string table section named ".strtab". If such a section doesn't exist, or it doesn't contain a string table, then raise E_inval. */ method get_string = (offset offset) string: { if (!section_name_p (".strtab")) raise E_inval; var strtab = get_sections_by_name (".strtab")[0]; return string @ strtab'ios : strtab.sh_offset + offset; } /* Return the signature corresponding to a given group section. If the given section header doesn't correspond to a group section then raise E_inval. */ method get_group_signature = (Elf64_Shdr section) string: { if (section.sh_type as Elf_Word != ELF_SHT_GROUP) raise E_inval; var symtab = shdr[section.sh_link]; var symtab_data = Elf64_Sym [symtab.sh_size] @ shdr'ios : symtab.sh_offset; var symbol = symtab_data[section.sh_info]; var symbol_name = get_symbol_name (symtab, symbol.st_name); return symbol_name; } /* Return an array of strings with the signatures of the section groups present in this ELF file. */ method get_group_signatures = string[]: { var signatures = string[](); for (section in shdr where section.sh_type as Elf_Word == ELF_SHT_GROUP) apush (signatures, get_group_signature (section)); return signatures; } /* Given the name of a section group, return an array with the section headers corresponding to all the sections in that group. If the given name doesn't identify a section group in the ELF file then return an empty array. */ method get_section_group = (string group_name) Elf64_Shdr[]: { var section_group = Elf64_Shdr[](); var group_sections = get_sections_by_type (ELF_SHT_GROUP); for (sec in group_sections where get_group_signature (sec) == group_name) { var group_entries = (Elf_Word[sec.sh_size - sizeof (Elf_Word)] @ sec'ios : sec.sh_offset + sizeof (Elf_Word)); for (entry in group_entries) apush (section_group, shdr[entry]); break; } return section_group; } /* Given a virtual address, return the index of the section whose loaded contents cover the given address. If no such section is found this methods returns -1. */ method vaddr_to_sec = (Elf64_Addr vaddr) int<32>: { if (ehdr.e_shnum > 0) for (var i = 0; i < ehdr.e_shnum; ++i) { var s = shdr[i]; if (s.sh_flags & (ELF_SHF_WRITE | ELF_SHF_ALLOC | ELF_SHF_EXECINSTR) && (s.sh_addr <= vaddr && s.sh_addr + s.sh_size > vaddr) && (s.sh_type != ELF_SHT_NOBITS || (s.sh_flags & ELF_SHF_TLS) == 0)) return i; } return -1; } /* Given a virtual address, return the file offset to the section contents that would be loaded in that virtual address. If no such file offset is found, return 0#B. */ method vaddr_to_file_offset = (Elf64_Addr vaddr) Elf64_Addr: { var sec = vaddr_to_sec (vaddr); return sec == -1 ? 0UL#B : shdr[sec].sh_offset + (vaddr - shdr[sec].sh_addr); } /* Determine the base where the contents of the ELF file are loaded, understood as the lower virtual address where segments get loaded. If there are no loadable segments in the ELF file then this method raises E_inval. */ method get_load_base = Elf64_Addr: { var base = ~(0#B as Elf64_Addr); if (ehdr.e_phnum > 0) for (p in phdr where p.p_type == ELF_PT_LOAD) { var b = p.p_vaddr & ~(p.p_align - 1#B); if (b < base) base = b; } if (base == ~(0#B as Elf64_Addr)) raise Exception { code = EC_inval, msg = "cannot find loadable segment in DSO" }; return base; } }; poke-elf-1.0/elf-mach-x86-64.pk0000644000175000017500000002277714602057371012703 00000000000000/* elf--mach-x86-64.pk - ELF X86-64 specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* X86-64 relocation types. */ var ELF_R_X86_64_NONE = 0U, ELF_R_X86_64_64 = 1U, ELF_R_X86_64_PC32 = 2U, ELF_R_X86_64_GOT32 = 3U, ELF_R_X86_64_PLT32 = 4U, ELF_R_X86_64_COPY = 5U, ELF_R_X86_64_GLOB_DAT = 6U, ELF_R_X86_64_JUMP_SLOT = 7U, ELF_R_X86_64_RELATIVE = 8U, ELF_R_X86_64_GOTPCREL = 9U, ELF_R_X86_64_32 = 10U, ELF_R_X86_64_32S = 11U, ELF_R_X86_64_16 = 12U, ELF_R_X86_64_PC16 = 13U, ELF_R_X86_64_8 = 14U, ELF_R_X86_64_PC8 = 15U, ELF_R_X86_64_DTPMOD64 = 16U, ELF_R_X86_64_DTPOFF64 = 17U, ELF_R_X86_64_TPOFF64 = 18U, ELF_R_X86_64_TLSGD = 19U, ELF_R_X86_64_TLSLD = 20U, ELF_R_X86_64_DTPOFF32 = 21U, ELF_R_X86_64_GOTTPOFF = 22U, ELF_R_X86_64_TPOFF32 = 23U, ELF_R_X86_64_PC64 = 24U, ELF_R_X86_64_GOTOFF64 = 25U, ELF_R_X86_64_GOTPC32 = 26U, ELF_R_X86_64_GOT64 = 27U, ELF_R_X86_64_GOTPCREL64 = 28U, ELF_R_X86_64_GOTPC64 = 29U, ELF_R_X86_64_GOTPLT64 = 30U, ELF_R_X86_64_PLTOFF64 = 31U, ELF_R_X86_64_SIZE32 = 32U, ELF_R_X86_64_SIZE64 = 33U, ELF_R_X86_64_GOTPC32_TLSDESC = 34U, ELF_R_X86_64_TLSDESC_CALL = 35U, ELF_R_X86_64_TLSDESC = 36U, ELF_R_X86_64_IRELATIVE = 37U, ELF_R_X86_64_RELATIVE64 = 38U, ELF_R_X86_64_PC32_BND = 39U, ELF_R_X86_64_PLT32_BND = 40U, ELF_R_X86_64_GOTPCRELX = 41U, ELF_R_X86_64_REX_GOTPCRELX = 42U, ELF_R_X86_64_GNU_VTINHERIT = 250U, /* GNU C++ hack */ ELF_R_X86_64_GNU_VTENTRY = 251U; /* GNU C++ hack */ elf_config.add_enum :machine ELF_EM_X86_64 :class "reloc-types" :entries [Elf_Config_UInt { value = ELF_R_X86_64_NONE, name = "none", doc = "No reloc." }, Elf_Config_UInt { value = ELF_R_X86_64_64, name = "64", doc = "Direct 64 bit." }, Elf_Config_UInt { value = ELF_R_X86_64_PC32, name = "pc32", doc = "PC relative 32 bit signed." }, Elf_Config_UInt { value = ELF_R_X86_64_GOT32, name = "got32", doc = "32 bit GOT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_PLT32, name = "plt32", doc = "32 bit PLT address." }, Elf_Config_UInt { value = ELF_R_X86_64_COPY, name = "copy", doc = "Copy symbol at runtime." }, Elf_Config_UInt { value = ELF_R_X86_64_GLOB_DAT, name = "glob-dat", doc = "Create GOT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_JUMP_SLOT, name = "jump-slot", doc = "Create PLT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_RELATIVE, name = "relative", doc = "Adjust by program base." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPCREL, name = "gotpcrel", doc = "32 bit signed pc relative offset to GOT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_32, name = "32", doc = "Direct 32 bit zero extended." }, Elf_Config_UInt { value = ELF_R_X86_64_32S, name = "32S", doc = "Direct 32 bit sign extended." }, Elf_Config_UInt { value = ELF_R_X86_64_16, name = "16", doc = "Direct 16 bit zero extended." }, Elf_Config_UInt { value = ELF_R_X86_64_PC16, name = "pc16", doc = "16 bit sign extended pc relative." }, Elf_Config_UInt { value = ELF_R_X86_64_8, name = "8", doc = "Direct 8 bit zero extended." }, Elf_Config_UInt { value = ELF_R_X86_64_PC8, name = "pc8", doc = "8 bit sign extended pc relative." }, Elf_Config_UInt { value = ELF_R_X86_64_DTPMOD64, name = "dtpmod64", doc = "ID of module containing symbol." }, Elf_Config_UInt { value = ELF_R_X86_64_DTPOFF64, name = "dtpoff64", doc = "Offset in TLS block." }, Elf_Config_UInt { value = ELF_R_X86_64_TPOFF64, name = "tpoff64", doc = "Offset in initial TLS block." }, Elf_Config_UInt { value = ELF_R_X86_64_TLSGD, name = "tlsgd", doc = "PC relative offset to GD GOT block." }, Elf_Config_UInt { value = ELF_R_X86_64_TLSLD, name = "tlsld", doc = "PC relative offset to LD GOT block." }, Elf_Config_UInt { value = ELF_R_X86_64_DTPOFF32, name = "dtpoff32", doc = "Offset in TLS block." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTTPOFF, name = "gottpoff", doc = "PC relative offset to IE GOT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_TPOFF32, name = "tpoff32", doc = "Offset in initial TLS block." }, Elf_Config_UInt { value = ELF_R_X86_64_PC64, name = "pc64", doc = "PC relative 64 bit." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTOFF64, name = "gotoff64", doc = "64 bit offset to GOT." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPC32, name = "gotpc32", doc = "32 bit signed pc relative offset to GOT." }, Elf_Config_UInt { value = ELF_R_X86_64_GOT64, name = "got64", doc = "64 bit GOT entry offset." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPCREL64, name = "gotpcrel64", doc = "64 bit signed pc relative offset to GOT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPC64, name = "gotpc64", doc = "64 bit signed pc relative offset to GOT." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPLT64, name = "gotplt64", doc = "Obsolete. The same as got64." }, Elf_Config_UInt { value = ELF_R_X86_64_PLTOFF64, name = "pltoff64", doc = "64-bit GOT relative offset to PLT entry." }, Elf_Config_UInt { value = ELF_R_X86_64_SIZE32, name = "size32", doc = "32-bit symbol size." }, Elf_Config_UInt { value = ELF_R_X86_64_SIZE64, name = "size64", doc = "64-bit symbol size." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPC32_TLSDESC, name = "gotpc32-tlsdesc", doc = "32 bit signed pc relative offset to TLS descriptor in the GOT." }, Elf_Config_UInt { value = ELF_R_X86_64_TLSDESC_CALL, name = "tlsdec-call", doc = "Relaxable call through TLS descriptor." }, Elf_Config_UInt { value = ELF_R_X86_64_TLSDESC, name = "tlsdesc", doc = "2x64-bit TLS descriptor." }, Elf_Config_UInt { value = ELF_R_X86_64_IRELATIVE, name = "irelative", doc = "Adjust indirectly by program base." }, Elf_Config_UInt { value = ELF_R_X86_64_RELATIVE64, name = "relative64", doc = "64 bit adjust by program base." }, Elf_Config_UInt { value = ELF_R_X86_64_PC32_BND, name = "pc32bnd", doc = "PC relative 32 bit signed with BND prefix." }, Elf_Config_UInt { value = ELF_R_X86_64_PLT32_BND, name = "plt32bnd", doc = "32 bit PLT address with BND prefix." }, Elf_Config_UInt { value = ELF_R_X86_64_GOTPCRELX, name = "gotpcrelx", doc = "Load from 32 bit signed pc relative offset to " + "GOT entry without REX prefix, relaxable." }, Elf_Config_UInt { value = ELF_R_X86_64_REX_GOTPCRELX, name = "rex-gotpcrelx", doc = "Load from 32 bit signed pc relative offset to " + "GOT entry with REX prefix, relaxable." }, Elf_Config_UInt { value = ELF_R_X86_64_GNU_VTINHERIT, name = "gnu-vtinherit", doc = "GNU C++ hack." }, Elf_Config_UInt { value = ELF_R_X86_64_GNU_VTENTRY, name = "gnu-vtentry", doc = "GNU C++ hack." }]; /* X86_64 section types. */ var ELF_SHT_X86_64_UNWIND = 0x70000001U; /* unwind information */ elf_config.add_enum :machine ELF_EM_X86_64 :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_X86_64_UNWIND, name = "unwind", doc = "Section contains unwind info." }]; /* X86_64 section flags. */ var ELF_SHF_X86_64_LARGE = 0x10000000UL; elf_config.add_mask :machine ELF_EM_X86_64 :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_X86_64_LARGE, name = "large" }]; poke-elf-1.0/version.texi0000644000175000017500000000013314602060007012345 00000000000000@set UPDATED 30 March 2024 @set UPDATED-MONTH March 2024 @set EDITION 1.0 @set VERSION 1.0 poke-elf-1.0/elf-build.pk0000644000175000017500000000142014602060000012155 00000000000000/* elf-build.pk - ELF implementation for GNU poke. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ var elf_pickle_version = "1.0"; poke-elf-1.0/elf-build.pk.in0000644000175000017500000000143614602057334012611 00000000000000/* elf-build.pk - ELF implementation for GNU poke. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ var elf_pickle_version = "@PACKAGE_VERSION@"; poke-elf-1.0/elf-common.pk0000644000175000017500000022335014602057341012374 00000000000000/* elf-common.pk - ELF structures common to 32 and 64 bits. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* Basic types. */ type Elf_Half = uint<16>, Elf_Word = uint<32>, Elf_Sword = int<32>; /* ELF versions. */ var ELF_EV_NONE = 0, /* Invalid ELF version. */ ELF_EV_CURRENT = 1; /* The different classes of ELF files. */ var ELF_CLASS_NONE = 0, ELF_CLASS_32 = 1, ELF_CLASS_64 = 2; elf_config.add_enum :class "file-classes" :entries [Elf_Config_UInt { value = ELF_CLASS_NONE, name = "none", doc = "Invalid class." }, Elf_Config_UInt { value = ELF_CLASS_32, name = "32bit", doc = "32-bit object." }, Elf_Config_UInt { value = ELF_CLASS_64, name = "64bit", doc = "64-bit object." }]; /* The different kind of ELF files. */ var ELF_ET_NONE = 0, ELF_ET_REL = 1, ELF_ET_EXEC = 2, ELF_ET_DYN = 3, ELF_ET_CORE = 4; elf_config.add_enum :class "file-types" :entries [Elf_Config_UInt { value = ELF_ET_NONE, name = "none", doc = "No file type." }, Elf_Config_UInt { value = ELF_ET_REL, name = "relocatable", doc = "Relocatable file." }, Elf_Config_UInt { value = ELF_ET_EXEC, name = "executable", doc = "Position-dependent executable." }, Elf_Config_UInt { value = ELF_ET_DYN, name = "dyn", doc = "Position-independent executable or shared object." }, Elf_Config_UInt { value = ELF_ET_CORE, name = "core", doc = "Core file." }]; /* The different supported OS ABIs. */ var ELF_OSABI_NONE = 0, ELF_OSABI_HPUX = 1, ELF_OSABI_NETBSD = 2, ELF_OSABI_GNU = 3, ELF_OSABI_LINUX = 3, ELF_OSABI_SOLARIS = 6, ELF_OSABI_AIX = 7, ELF_OSABI_IRIX = 8, ELF_OSABI_FREEBSD = 9, ELF_OSABI_TRU64 = 10, ELF_OSABI_MODESTO = 11, ELF_OSABI_OPENBSD = 12, ELF_OSABI_OPENVMS = 13, ELF_OSABI_NSK = 14, ELF_OSABI_AROS = 15, ELF_OSABI_FENIXOS = 16, ELF_OSABI_CLOUDABI = 17, ELF_OSABI_OPENVOS = 18, ELF_OSABI_C6000_ELFABI = 64, ELF_OSABI_AMDGPU_HSA = 64, ELF_OSABI_C6000_LINUX = 65, ELF_OSABI_AMDGPU_PAL = 65, ELF_OSABI_ARM_FDPIC = 65, ELF_OSABI_AMDGPU_MESA3D = 66, ELF_OSABI_ARM = 97, ELF_OSABI_STANDALONE = 255; elf_config.add_enum :class "file-osabis" :entries [Elf_Config_UInt { value = ELF_OSABI_NONE, name = "sysv", doc = "UNIX System V ABI." }, Elf_Config_UInt { value = ELF_OSABI_HPUX, name = "hpux", doc = "HP-UX operating system." }, Elf_Config_UInt { value = ELF_OSABI_NETBSD, name = "netbsd", doc = "NetBSD." }, Elf_Config_UInt { value = ELF_OSABI_GNU, name = "gnu", doc = "GNU." }, Elf_Config_UInt { value = ELF_OSABI_LINUX, name = "linux", doc = "Alias for gnu." }, Elf_Config_UInt { value = ELF_OSABI_SOLARIS, name = "solaris", doc = "Solaris." }, Elf_Config_UInt { value = ELF_OSABI_AIX, name = "aix", doc = "AIX." }, Elf_Config_UInt { value = ELF_OSABI_IRIX, name = "irix", doc = "IRIX." }, Elf_Config_UInt { value = ELF_OSABI_FREEBSD, name = "freebsd", doc = "FreeBSD." }, Elf_Config_UInt { value = ELF_OSABI_TRU64, name = "tru64", doc = "TRU64 UNIX." }, Elf_Config_UInt { value = ELF_OSABI_MODESTO, name = "modesto", doc = "Novell Modesto." }, Elf_Config_UInt { value = ELF_OSABI_OPENBSD, name = "openbsd", doc = "OpenBSD." }, Elf_Config_UInt { value = ELF_OSABI_OPENVMS, name = "openvms", doc = "OpenVMS." }, Elf_Config_UInt { value = ELF_OSABI_NSK, name = "nsk", doc = "Hewlett-Packard Non-Stop Kernel." }, Elf_Config_UInt { value = ELF_OSABI_AROS, name = "aros", doc = "AROS." }, Elf_Config_UInt { value = ELF_OSABI_FENIXOS, name = "fenixos", doc = "FenixOS" }, Elf_Config_UInt { value = ELF_OSABI_CLOUDABI, name = "cloudabi", doc = "Nuxi CloudABI." }, Elf_Config_UInt { value = ELF_OSABI_OPENVOS, name = "openvos", doc = "Stratus Technologies OpenVOS." }, Elf_Config_UInt { value = ELF_OSABI_C6000_ELFABI, name = "c6000-elfabi", doc = "Bare-metal TMS320C6000." }, Elf_Config_UInt { value = ELF_OSABI_AMDGPU_HSA, name = "amdgpu-hsa", doc = "AMD HSA Runtime." }, Elf_Config_UInt { value = ELF_OSABI_C6000_LINUX, name = "c6000-linux", doc = "Linux TMS320C6000." }, Elf_Config_UInt { value = ELF_OSABI_AMDGPU_PAL, name = "amdgpu-pal", doc = "AMD PAL Runtime." }, Elf_Config_UInt { value = ELF_OSABI_ARM_FDPIC, name = "arm-fdpic", doc = "ARM FDPIC." }, Elf_Config_UInt { value = ELF_OSABI_AMDGPU_MESA3D, name = "amdgpu-mesa3d", doc = "AMD Mesa3D Runtime." }, Elf_Config_UInt { value = ELF_OSABI_ARM, name = "arm", doc = "ARM." }, Elf_Config_UInt { value = ELF_OSABI_STANDALONE, name = "standalone", doc = "Standalone (embedded) application." }]; /* ELF machine numbers. */ var ELF_EM_NONE = 0, ELF_EM_M32 = 1, ELF_EM_SPARC = 2, ELF_EM_386 = 3, ELF_EM_68K = 4, ELF_EM_88K = 5, ELF_EM_IAMCU = 6, ELF_EM_860 = 7, ELF_EM_MIPS = 8, ELF_EM_S370 = 9, ELF_EM_MIPS_RS3_LE = 10, ELF_EM_OLD_SPARCV9 = 11, /* Old version of Sparc v9, from before the ABI. Deprecated. */ ELF_EM_PARISC = 15 , /* HPPA */ ELF_EM_PPC_OLD = 17 , /* Old version of PowerPC. Deprecated. */ ELF_EM_VPP550 = 17 , /* Fujitsu VPP500 */ ELF_EM_SPARC32PLUS = 18 , /* Sun's "v8plus" */ ELF_EM_960 = 19 , /* Intel 80960 */ ELF_EM_PPC = 20 , /* PowerPC */ ELF_EM_PPC64 = 21 , /* 64-bit PowerPC */ ELF_EM_S390 = 22 , /* IBM S/390 */ ELF_EM_SPU = 23 , /* Sony/Toshiba/IBM SPU */ ELF_EM_V800 = 36 , /* NEC V800 series */ ELF_EM_FR20 = 37 , /* Fujitsu FR20 */ ELF_EM_RH32 = 38 , /* TRW RH32 */ ELF_EM_MCORE = 39 , /* Motorola M*Core */ /* May also be taken by Fujitsu MMA */ ELF_EM_RCE = 39 , /* Old name for MCore */ ELF_EM_ARM = 40 , /* ARM */ ELF_EM_OLD_ALPHA = 41 , /* Digital Alpha */ ELF_EM_SH = 42 , /* Renesas (formerly Hitachi) / SuperH SH */ ELF_EM_SPARCV9 = 43 , /* SPARC v9 64-bit */ ELF_EM_TRICORE = 44 , /* Siemens Tricore embedded processor */ ELF_EM_ARC = 45 , /* ARC Cores */ ELF_EM_H8_300 = 46 , /* Renesas (formerly Hitachi) H8/300 */ ELF_EM_H8_300H = 47 , /* Renesas (formerly Hitachi) H8/300H */ ELF_EM_H8S = 48 , /* Renesas (formerly Hitachi) H8S */ ELF_EM_H8_500 = 49 , /* Renesas (formerly Hitachi) H8/500 */ ELF_EM_IA_64 = 50 , /* Intel IA-64 Processor */ ELF_EM_MIPS_X = 51 , /* Stanford MIPS-X */ ELF_EM_COLDFIRE = 52 , /* Motorola Coldfire */ ELF_EM_68HC12 = 53 , /* Motorola M68HC12 */ ELF_EM_MMA = 54 , /* Fujitsu Multimedia Accelerator */ ELF_EM_PCP = 55 , /* Siemens PCP */ ELF_EM_NCPU = 56 , /* Sony nCPU embedded RISC processor */ ELF_EM_NDR1 = 57 , /* Denso NDR1 microprocessor */ ELF_EM_STARCORE = 58 , /* Motorola Star*Core processor */ ELF_EM_ME16 = 59 , /* Toyota ME16 processor */ ELF_EM_ST100 = 60 , /* STMicroelectronics ST100 processor */ ELF_EM_TINYJ = 61 , /* Advanced Logic Corp. TinyJ embedded processor */ ELF_EM_X86_64 = 62 , /* Advanced Micro Devices X86-64 processor */ ELF_EM_PDSP = 63 , /* Sony DSP Processor */ ELF_EM_PDP10 = 64 , /* Digital Equipment Corp. PDP-10 */ ELF_EM_PDP11 = 65 , /* Digital Equipment Corp. PDP-11 */ ELF_EM_FX66 = 66 , /* Siemens FX66 microcontroller */ ELF_EM_ST9PLUS = 67 , /* STMicroelectronics ST9+ 8/16 bit microcontroller */ ELF_EM_ST7 = 68 , /* STMicroelectronics ST7 8-bit microcontroller */ ELF_EM_68HC16 = 69 , /* Motorola MC68HC16 Microcontroller */ ELF_EM_68HC11 = 70 , /* Motorola MC68HC11 Microcontroller */ ELF_EM_68HC08 = 71 , /* Motorola MC68HC08 Microcontroller */ ELF_EM_68HC05 = 72 , /* Motorola MC68HC05 Microcontroller */ ELF_EM_SVX = 73 , /* Silicon Graphics SVx */ ELF_EM_ST19 = 74 , /* STMicroelectronics ST19 8-bit cpu */ ELF_EM_VAX = 75 , /* Digital VAX */ ELF_EM_CRIS = 76 , /* Axis Communications 32-bit embedded processor */ ELF_EM_JAVELIN = 77 , /* Infineon Technologies 32-bit embedded cpu */ ELF_EM_FIREPATH = 78 , /* Element 14 64-bit DSP processor */ ELF_EM_ZSP = 79 , /* LSI Logic's 16-bit DSP processor */ ELF_EM_MMIX = 80 , /* Donald Knuth's educational 64-bit processor */ ELF_EM_HUANY = 81 , /* Harvard's machine-independent format */ ELF_EM_PRISM = 82 , /* SiTera Prism */ ELF_EM_AVR = 83 , /* Atmel AVR 8-bit microcontroller */ ELF_EM_FR30 = 84 , /* Fujitsu FR30 */ ELF_EM_D10V = 85 , /* Mitsubishi D10V */ ELF_EM_D30V = 86 , /* Mitsubishi D30V */ ELF_EM_V850 = 87 , /* Renesas V850 (formerly NEC V850) */ ELF_EM_M32R = 88 , /* Renesas M32R (formerly Mitsubishi M32R) */ ELF_EM_MN10300 = 89 , /* Matsushita MN10300 */ ELF_EM_MN10200 = 90 , /* Matsushita MN10200 */ ELF_EM_PJ = 91 , /* picoJava */ ELF_EM_OR1K = 92 , /* OpenRISC 1000 32-bit embedded processor */ ELF_EM_ARC_COMPACT = 93 , /* ARC International ARCompact processor */ ELF_EM_XTENSA = 94 , /* Tensilica Xtensa Architecture */ ELF_EM_SCORE_OLD = 95 , /* Old Sunplus S+core7 backend magic number. Written in the absence of an ABI. */ ELF_EM_VIDEOCORE = 95 , /* Alphamosaic VideoCore processor */ ELF_EM_TMM_GPP = 96 , /* Thompson Multimedia General Purpose Processor */ ELF_EM_NS32K = 97 , /* National Semiconductor 32000 series */ ELF_EM_TPC = 98 , /* Tenor Network TPC processor */ ELF_EM_PJ_OLD = 99 , /* Old value for picoJava. Deprecated. */ ELF_EM_SNP1K = 99 , /* Trebia SNP 1000 processor */ ELF_EM_ST200 = 100 , /* STMicroelectronics ST200 microcontroller */ ELF_EM_IP2K = 101 , /* Ubicom IP2022 micro controller */ ELF_EM_MAX = 102 , /* MAX Processor */ ELF_EM_CR = 103 , /* National Semiconductor CompactRISC */ ELF_EM_F2MC16 = 104 , /* Fujitsu F2MC16 */ ELF_EM_MSP430 = 105 , /* TI msp430 micro controller */ ELF_EM_BLACKFIN = 106 , /* ADI Blackfin */ ELF_EM_SE_C33 = 107 , /* S1C33 Family of Seiko Epson processors */ ELF_EM_SEP = 108 , /* Sharp embedded microprocessor */ ELF_EM_ARCA = 109 , /* Arca RISC Microprocessor */ ELF_EM_UNICORE = 110 , /* Microprocessor series from PKU-Unity Ltd. and MPRC of Peking University */ ELF_EM_EXCESS = 111 , /* eXcess: 16/32/64-bit configurable embedded CPU */ ELF_EM_DXP = 112 , /* Icera Semiconductor Inc. Deep Execution Processor */ ELF_EM_ALTERA_NIOS2 = 113 , /* Altera Nios II soft-core processor */ ELF_EM_CRX = 114 , /* National Semiconductor CRX */ ELF_EM_CR16_OLD = 115 , /* Old, value for National Semiconductor CompactRISC. Deprecated. */ ELF_EM_XGATE = 115 , /* Motorola XGATE embedded processor */ ELF_EM_C166 = 116 , /* Infineon C16x/XC16x processor */ ELF_EM_M16C = 117 , /* Renesas M16C series microprocessors */ ELF_EM_DSPIC30F = 118 , /* Microchip Technology dsPIC30F Digital Signal Controller */ ELF_EM_CE = 119 , /* Freescale Communication Engine RISC core */ ELF_EM_M32C = 120 , /* Renesas M32C series microprocessors */ ELF_EM_TSK3000 = 131 , /* Altium TSK3000 core */ ELF_EM_RS08 = 132 , /* Freescale RS08 embedded processor */ ELF_EM_ECOG2 = 134 , /* Cyan Technology eCOG2 microprocessor */ ELF_EM_SCORE = 135 , /* Sunplus Score */ ELF_EM_SCORE7 = 135 , /* Sunplus S+core7 RISC processor */ ELF_EM_DSP24 = 136 , /* New Japan Radio (NJR) 24-bit DSP Processor */ ELF_EM_VIDEOCORE3 = 137 , /* Broadcom VideoCore III processor */ ELF_EM_LATTICEMICO32 = 138 , /* RISC processor for Lattice FPGA architecture */ ELF_EM_SE_C17 = 139 , /* Seiko Epson C17 family */ ELF_EM_TI_C6000 = 140 , /* Texas Instruments TMS320C6000 DSP family */ ELF_EM_TI_C2000 = 141 , /* Texas Instruments TMS320C2000 DSP family */ ELF_EM_TI_C5500 = 142 , /* Texas Instruments TMS320C55x DSP family */ ELF_EM_TI_PRU = 144 , /* Texas Instruments Programmable Realtime Unit */ ELF_EM_MMDSP_PLUS = 160 , /* STMicroelectronics 64bit VLIW Data Signal Processor */ ELF_EM_CYPRESS_M8C = 161 , /* Cypress M8C microprocessor */ ELF_EM_R32C = 162 , /* Renesas R32C series microprocessors */ ELF_EM_TRIMEDIA = 163 , /* NXP Semiconductors TriMedia architecture family */ ELF_EM_QDSP6 = 164 , /* QUALCOMM DSP6 Processor */ ELF_EM_8051 = 165 , /* Intel 8051 and variants */ ELF_EM_STXP7X = 166 , /* STMicroelectronics STxP7x family */ ELF_EM_NDS32 = 167 , /* Andes Technology compact code size embedded RISC processor family */ ELF_EM_ECOG1 = 168 , /* Cyan Technology eCOG1X family */ ELF_EM_ECOG1X = 168 , /* Cyan Technology eCOG1X family */ ELF_EM_MAXQ30 = 169 , /* Dallas Semiconductor MAXQ30 Core Micro-controllers */ ELF_EM_XIMO16 = 170 , /* New Japan Radio (NJR) 16-bit DSP Processor */ ELF_EM_MANIK = 171 , /* M2000 Reconfigurable RISC Microprocessor */ ELF_EM_CRAYNV2 = 172 , /* Cray Inc. NV2 vector architecture */ ELF_EM_RX = 173 , /* Renesas RX family */ ELF_EM_METAG = 174 , /* Imagination Technologies Meta processor architecture */ ELF_EM_MCST_ELBRUS = 175 , /* MCST Elbrus general purpose hardware architecture */ ELF_EM_ECOG16 = 176 , /* Cyan Technology eCOG16 family */ ELF_EM_CR16 = 177 , /* National Semiconductor CompactRISC 16-bit processor */ ELF_EM_ETPU = 178 , /* Freescale Extended Time Processing Unit */ ELF_EM_SLE9X = 179 , /* Infineon Technologies SLE9X core */ ELF_EM_L1OM = 180 , /* Intel L1OM */ ELF_EM_K1OM = 181 , /* Intel K1OM */ ELF_EM_INTEL182 = 182 , /* Reserved by Intel */ ELF_EM_AARCH64 = 183 , /* ARM 64-bit architecture */ ELF_EM_ARM184 = 184 , /* Reserved by ARM */ ELF_EM_AVR32 = 185 , /* Atmel Corporation 32-bit microprocessor family */ ELF_EM_STM8 = 186 , /* STMicroeletronics STM8 8-bit microcontroller */ ELF_EM_TILE64 = 187 , /* Tilera TILE64 multicore architecture family */ ELF_EM_TILEPRO = 188 , /* Tilera TILEPro multicore architecture family */ ELF_EM_MICROBLAZE = 189 , /* Xilinx MicroBlaze 32-bit RISC soft processor core */ ELF_EM_CUDA = 190 , /* NVIDIA CUDA architecture */ ELF_EM_TILEGX = 191 , /* Tilera TILE-Gx multicore architecture family */ ELF_EM_CLOUDSHIELD = 192 , /* CloudShield architecture family */ ELF_EM_COREA_1ST = 193 , /* KIPO-KAIST Core-A 1st generation processor family */ ELF_EM_COREA_2ND = 194 , /* KIPO-KAIST Core-A 2nd generation processor family */ ELF_EM_ARC_COMPACT2 = 195 , /* Synopsys ARCompact V2 */ ELF_EM_OPEN8 = 196 , /* Open8 8-bit RISC soft processor core */ ELF_EM_RL78 = 197 , /* Renesas RL78 family. */ ELF_EM_VIDEOCORE5 = 198 , /* Broadcom VideoCore V processor */ ELF_EM_78K0R = 199 , /* Renesas 78K0R. */ ELF_EM_56800EX = 200 , /* Freescale 56800EX Digital Signal Controller (DSC) */ ELF_EM_BA1 = 201 , /* Beyond BA1 CPU architecture */ ELF_EM_BA2 = 202 , /* Beyond BA2 CPU architecture */ ELF_EM_XCORE = 203 , /* XMOS xCORE processor family */ ELF_EM_MCHP_PIC = 204 , /* Microchip 8-bit PIC(r) family */ ELF_EM_INTELGT = 205 , /* Intel Graphics Technology */ ELF_EM_INTEL206 = 206 , /* Reserved by Intel */ ELF_EM_INTEL207 = 207 , /* Reserved by Intel */ ELF_EM_INTEL208 = 208 , /* Reserved by Intel */ ELF_EM_INTEL209 = 209 , /* Reserved by Intel */ ELF_EM_KM32 = 210 , /* KM211 KM32 32-bit processor */ ELF_EM_KMX32 = 211 , /* KM211 KMX32 32-bit processor */ ELF_EM_KMX16 = 212 , /* KM211 KMX16 16-bit processor */ ELF_EM_KMX8 = 213 , /* KM211 KMX8 8-bit processor */ ELF_EM_KVARC = 214 , /* KM211 KVARC processor */ ELF_EM_CDP = 215 , /* Paneve CDP architecture family */ ELF_EM_COGE = 216 , /* Cognitive Smart Memory Processor */ ELF_EM_COOL = 217 , /* Bluechip Systems CoolEngine */ ELF_EM_NORC = 218 , /* Nanoradio Optimized RISC */ ELF_EM_CSR_KALIMBA = 219 , /* CSR Kalimba architecture family */ ELF_EM_Z80 = 220 , /* Zilog Z80 */ ELF_EM_VISIUM = 221 , /* Controls and Data Services VISIUMcore processor */ ELF_EM_FT32 = 222 , /* FTDI Chip FT32 high performance 32-bit RISC architecture */ ELF_EM_MOXIE = 223 , /* Moxie processor family */ ELF_EM_AMDGPU = 224 , /* AMD GPU architecture */ ELF_EM_RISCV = 243 , /* RISC-V */ ELF_EM_LANAI = 244 , /* Lanai 32-bit processor. */ ELF_EM_CEVA = 245 , /* CEVA Processor Architecture Family */ ELF_EM_CEVA_X2 = 246 , /* CEVA X2 Processor Family */ ELF_EM_BPF = 247 , /* Linux BPF – in-kernel virtual machine. */ ELF_EM_GRAPHCORE_IPU = 248 , /* Graphcore Intelligent Processing Unit */ ELF_EM_IMG1 = 249 , /* Imagination Technologies */ ELF_EM_NFP = 250 , /* Netronome Flow Processor. */ ELF_EM_VE = 251 , /* NEC Vector Engine */ ELF_EM_CSKY = 252 , /* C-SKY processor family. */ ELF_EM_ARC_COMPACT3_64 = 253 , /* Synopsys ARCv2.3 64-bit */ ELF_EM_MCS6502 = 254 , /* MOS Technology MCS 6502 processor */ ELF_EM_ARC_COMPACT3 = 255 , /* Synopsys ARCv2.3 32-bit */ ELF_EM_KVX = 256 , /* Kalray VLIW core of the MPPA processor family */ ELF_EM_65816 = 257 , /* WDC 65816/65C816 */ ELF_EM_LOONGARCH = 258 , /* LoongArch */ ELF_EM_KF32 = 259 , /* ChipON KungFu32 */ ELF_EM_U16_U8CORE = 260 , /* LAPIS nX-U16/U8 */ ELF_EM_TACHYUM = 261, /* Tachyum */ ELF_EM_56800EF = 262, /* NXP 56800EF Digital Signal Controller (DSC) */ ELF_EM_SIMA_MLA = 265; /* SiMa MLA. */ elf_config.add_enum :class "elf-machines" :entries [Elf_Config_UInt { value = ELF_EM_NONE, name = "none", doc = "No machine." }, Elf_Config_UInt { value = ELF_EM_M32, name = "m32", doc = "AT&T WE 32100." }, Elf_Config_UInt { value = ELF_EM_SPARC, name = "sparc", doc = "SUN SPARC." }, Elf_Config_UInt { value = ELF_EM_386, name = "386", doc = "Intel 80368." }, Elf_Config_UInt { value = ELF_EM_68K, name = "m38k", doc = "Motorola m68k family." }, Elf_Config_UInt { value = ELF_EM_88K, name = "m88k", doc = "Motorola m88k family." }, Elf_Config_UInt { value = ELF_EM_IAMCU, name = "iamcu", doc = "Intel MCU." }, Elf_Config_UInt { value = ELF_EM_860, name = "860", doc = "Intel 80860." }, Elf_Config_UInt { value = ELF_EM_MIPS, name = "mips", doc = "MIPS R3000 (officially, big-endian only)." }, Elf_Config_UInt { value = ELF_EM_S370, name = "s370", doc = "IBM System/370." }, Elf_Config_UInt { value = ELF_EM_MIPS_RS3_LE, name = "mips-rs3-le", doc = "MIPS R3000 little-endian. Deprecated." }, Elf_Config_UInt { value = ELF_EM_OLD_SPARCV9, name = "SPARCV9", doc = "Old version of Sparc v9, from before the ABI. Deprecated." }, Elf_Config_UInt { value = ELF_EM_PARISC, name = "PARISC", doc = "HPPA." }, Elf_Config_UInt { value = ELF_EM_PPC_OLD, name = "ppc-old", doc = "Old version of PowerPC. Deprecated." }, Elf_Config_UInt { value = ELF_EM_VPP550, name = "VPP550", doc = "Fujitsu VPP500 " }, Elf_Config_UInt { value = ELF_EM_SPARC32PLUS, name = "SPARC32PLUS", doc = "Sun's v8plus" }, Elf_Config_UInt { value = ELF_EM_960, name = "960", doc = "Intel 80960." }, Elf_Config_UInt { value = ELF_EM_PPC, name = "PPC", doc = "PowerPC " }, Elf_Config_UInt { value = ELF_EM_PPC64, name = "PPC64", doc = "64-bit PowerPC." }, Elf_Config_UInt { value = ELF_EM_S390, name = "S390", doc = "IBM S/390." }, Elf_Config_UInt { value = ELF_EM_SPU , name = "SPU ", doc = "Sony/Toshiba/IBM SPU " }, Elf_Config_UInt { value = ELF_EM_V800, name = "V800", doc = "NEC V800 series." }, Elf_Config_UInt { value = ELF_EM_FR20, name = "FR20", doc = "Fujitsu FR20." }, Elf_Config_UInt { value = ELF_EM_RH32, name = "RH32", doc = "TRW RH32." }, Elf_Config_UInt { value = ELF_EM_MCORE, name = "MCORE", doc = "Motorola M*Core. May also be taken by Fujitsu MMA." }, Elf_Config_UInt { value = ELF_EM_RCE, name = "RCE", doc = "Old name for MCore " }, Elf_Config_UInt { value = ELF_EM_ARM, name = "ARM", doc = "ARM." }, Elf_Config_UInt { value = ELF_EM_OLD_ALPHA , name = "OLD_ALPHA.", doc = "Digital Alpha." }, Elf_Config_UInt { value = ELF_EM_SH, name = "SH", doc = "Renesas (formerly Hitachi) / SuperH SH." }, Elf_Config_UInt { value = ELF_EM_SPARCV9, name = "SPARCV9", doc = "SPARC v9 64-bit." }, Elf_Config_UInt { value = ELF_EM_TRICORE, name = "TRICORE", doc = "Siemens Tricore embedded processor." }, Elf_Config_UInt { value = ELF_EM_ARC, name = "ARC", doc = "ARC Cores." }, Elf_Config_UInt { value = ELF_EM_H8_300, name = "H8_300", doc = "Renesas (formerly Hitachi) H8/300." }, Elf_Config_UInt { value = ELF_EM_H8_300H, name = "H8_300H", doc = "Renesas (formerly Hitachi) H8/300H." }, Elf_Config_UInt { value = ELF_EM_H8S, name = "H8S", doc = "Renesas (formerly Hitachi) H8S." }, Elf_Config_UInt { value = ELF_EM_H8_500, name = "H8_500", doc = "Renesas (formerly Hitachi) H8/500." }, Elf_Config_UInt { value = ELF_EM_IA_64, name = "IA_64", doc = "Intel IA-64 Processor." }, Elf_Config_UInt { value = ELF_EM_MIPS_X, name = "MIPS_X", doc = "Stanford MIPS-X." }, Elf_Config_UInt { value = ELF_EM_COLDFIRE, name = "COLDFIRE", doc = "Motorola Coldfire." }, Elf_Config_UInt { value = ELF_EM_68HC12, name = "68HC12", doc = "Motorola M68HC12." }, Elf_Config_UInt { value = ELF_EM_MMA, name = "MMA", doc = "Fujitsu Multimedia Accelerator." }, Elf_Config_UInt { value = ELF_EM_PCP, name = "PCP", doc = "Siemens PCP." }, Elf_Config_UInt { value = ELF_EM_NCPU, name = "NCPU", doc = "Sony nCPU embedded RISC processor." }, Elf_Config_UInt { value = ELF_EM_NDR1, name = "NDR1", doc = "Denso NDR1 microprocessor." }, Elf_Config_UInt { value = ELF_EM_STARCORE, name = "STARCORE", doc = "Motorola Star*Core processor." }, Elf_Config_UInt { value = ELF_EM_ME16, name = "ME16", doc = "Toyota ME16 processor." }, Elf_Config_UInt { value = ELF_EM_ST100, name = "ST100", doc = "STMicroelectronics ST100 processor." }, Elf_Config_UInt { value = ELF_EM_TINYJ, name = "TINYJ", doc = "Advanced Logic Corp. TinyJ embedded processor." }, Elf_Config_UInt { value = ELF_EM_X86_64, name = "X86_64", doc = "Advanced Micro Devices X86-64 processor." }, Elf_Config_UInt { value = ELF_EM_PDSP, name = "PDSP", doc = "Sony DSP Processor." }, Elf_Config_UInt { value = ELF_EM_PDP10, name = "PDP10", doc = "Digital Equipment Corp. PDP-10." }, Elf_Config_UInt { value = ELF_EM_PDP11, name = "PDP11", doc = "Digital Equipment Corp. PDP-11." }, Elf_Config_UInt { value = ELF_EM_FX66, name = "FX66", doc = "Siemens FX66 microcontroller." }, Elf_Config_UInt { value = ELF_EM_ST9PLUS, name = "ST9PLUS", doc = "STMicroelectronics ST9+ 8/16 bit microcontroller." }, Elf_Config_UInt { value = ELF_EM_ST7, name = "ST7", doc = "STMicroelectronics ST7 8-bit microcontroller." }, Elf_Config_UInt { value = ELF_EM_68HC16, name = "68HC16", doc = "Motorola MC68HC16 Microcontroller." }, Elf_Config_UInt { value = ELF_EM_68HC11, name = "68HC11", doc = "Motorola MC68HC11 Microcontroller." }, Elf_Config_UInt { value = ELF_EM_68HC08, name = "68HC08", doc = "Motorola MC68HC08 Microcontroller." }, Elf_Config_UInt { value = ELF_EM_68HC05, name = "68HC05", doc = "Motorola MC68HC05 Microcontroller." }, Elf_Config_UInt { value = ELF_EM_SVX, name = "SVX", doc = "Silicon Graphics SVx." }, Elf_Config_UInt { value = ELF_EM_ST19, name = "ST19", doc = "STMicroelectronics ST19 8-bit cpu." }, Elf_Config_UInt { value = ELF_EM_VAX, name = "VAX", doc = "Digital VAX." }, Elf_Config_UInt { value = ELF_EM_CRIS, name = "CRIS", doc = "Axis Communications 32-bit embedded processor." }, Elf_Config_UInt { value = ELF_EM_JAVELIN, name = "JAVELIN", doc = "Infineon Technologies 32-bit embedded cpu." }, Elf_Config_UInt { value = ELF_EM_FIREPATH, name = "FIREPATH", doc = "Element 14 64-bit DSP processor." }, Elf_Config_UInt { value = ELF_EM_ZSP, name = "ZSP", doc = "LSI Logic's 16-bit DSP processor." }, Elf_Config_UInt { value = ELF_EM_MMIX, name = "MMIX", doc = "Donald Knuth's educational 64-bit processor." }, Elf_Config_UInt { value = ELF_EM_HUANY, name = "HUANY", doc = "Harvard's machine-independent format." }, Elf_Config_UInt { value = ELF_EM_PRISM, name = "PRISM", doc = "SiTera Prism." }, Elf_Config_UInt { value = ELF_EM_AVR, name = "AVR", doc = "Atmel AVR 8-bit microcontroller." }, Elf_Config_UInt { value = ELF_EM_FR30, name = "FR30", doc = "Fujitsu FR30." }, Elf_Config_UInt { value = ELF_EM_D10V, name = "D10V", doc = "Mitsubishi D10V." }, Elf_Config_UInt { value = ELF_EM_D30V, name = "D30V", doc = "Mitsubishi D30V." }, Elf_Config_UInt { value = ELF_EM_V850, name = "V850", doc = "Renesas V850 (formerly NEC V850)." }, Elf_Config_UInt { value = ELF_EM_M32R, name = "M32R", doc = "Renesas M32R (formerly Mitsubishi M32R)." }, Elf_Config_UInt { value = ELF_EM_MN10300, name = "MN10300", doc = "Matsushita MN10300." }, Elf_Config_UInt { value = ELF_EM_MN10200, name = "MN10200", doc = "Matsushita MN10200." }, Elf_Config_UInt { value = ELF_EM_PJ, name = "PJ", doc = "picoJava." }, Elf_Config_UInt { value = ELF_EM_OR1K, name = "OR1K", doc = "OpenRISC 1000 32-bit embedded processor." }, Elf_Config_UInt { value = ELF_EM_ARC_COMPACT, name = "ARC_COMPACT", doc = "ARC International ARCompact processor." }, Elf_Config_UInt { value = ELF_EM_XTENSA, name = "XTENSA", doc = "Tensilica Xtensa Architecture." }, Elf_Config_UInt { value = ELF_EM_SCORE_OLD, name = "SCORE_OLD", doc = "Old Sunplus S+core7 backend magic number. Written in the absence of an ABI." }, Elf_Config_UInt { value = ELF_EM_VIDEOCORE, name = "VIDEOCORE", doc = "Alphamosaic VideoCore processor." }, Elf_Config_UInt { value = ELF_EM_TMM_GPP, name = "TMM_GPP", doc = "Thompson Multimedia General Purpose Processor." }, Elf_Config_UInt { value = ELF_EM_NS32K, name = "NS32K", doc = "National Semiconductor 32000 series." }, Elf_Config_UInt { value = ELF_EM_TPC, name = "TPC", doc = "Tenor Network TPC processor." }, Elf_Config_UInt { value = ELF_EM_PJ_OLD, name = "PJ_OLD", doc = "Old value for picoJava. Deprecated." }, Elf_Config_UInt { value = ELF_EM_SNP1K, name = "SNP1K", doc = "Trebia SNP 1000 processor." }, Elf_Config_UInt { value = ELF_EM_ST200, name = "ST200", doc = "STMicroelectronics ST200 microcontroller." }, Elf_Config_UInt { value = ELF_EM_IP2K, name = "IP2K", doc = "Ubicom IP2022 micro controller." }, Elf_Config_UInt { value = ELF_EM_MAX, name = "MAX", doc = "MAX Processor." }, Elf_Config_UInt { value = ELF_EM_CR, name = "CR", doc = "National Semiconductor CompactRISC." }, Elf_Config_UInt { value = ELF_EM_F2MC16, name = "F2MC16", doc = "Fujitsu F2MC16." }, Elf_Config_UInt { value = ELF_EM_MSP430, name = "MSP430", doc = "TI msp430 micro controller." }, Elf_Config_UInt { value = ELF_EM_BLACKFIN, name = "BLACKFIN", doc = "ADI Blackfin." }, Elf_Config_UInt { value = ELF_EM_SE_C33, name = "SE_C33", doc = "S1C33 Family of Seiko Epson processors." }, Elf_Config_UInt { value = ELF_EM_SEP, name = "SEP", doc = "Sharp embedded microprocessor." }, Elf_Config_UInt { value = ELF_EM_ARCA, name = "ARCA", doc = "Arca RISC Microprocessor." }, Elf_Config_UInt { value = ELF_EM_UNICORE, name = "UNICORE", doc = "Microprocessor series from PKU-Unity Ltd. and MPRC of Peking University." }, Elf_Config_UInt { value = ELF_EM_EXCESS, name = "EXCESS", doc = "eXcess: 16/32/64-bit configurable embedded CPU." }, Elf_Config_UInt { value = ELF_EM_DXP, name = "DXP", doc = "Icera Semiconductor Inc. Deep Execution Processor." }, Elf_Config_UInt { value = ELF_EM_ALTERA_NIOS2, name = "ALTERA_NIOS2", doc = "Altera Nios II soft-core processor." }, Elf_Config_UInt { value = ELF_EM_CRX, name = "CRX", doc = "National Semiconductor CRX." }, Elf_Config_UInt { value = ELF_EM_CR16_OLD, name = "CR16_OLD", doc = "Old, value for National Semiconductor CompactRISC. Deprecated." }, Elf_Config_UInt { value = ELF_EM_XGATE, name = "XGATE", doc = "Motorola XGATE embedded processor." }, Elf_Config_UInt { value = ELF_EM_C166, name = "C166", doc = "Infineon C16x/XC16x processor." }, Elf_Config_UInt { value = ELF_EM_M16C, name = "M16C", doc = "Renesas M16C series microprocessors." }, Elf_Config_UInt { value = ELF_EM_DSPIC30F, name = "DSPIC30F", doc = "Microchip Technology dsPIC30F Digital Signal Controller." }, Elf_Config_UInt { value = ELF_EM_CE, name = "CE", doc = "Freescale Communication Engine RISC core." }, Elf_Config_UInt { value = ELF_EM_M32C, name = "M32C", doc = "Renesas M32C series microprocessors." }, Elf_Config_UInt { value = ELF_EM_TSK3000, name = "TSK3000", doc = "Altium TSK3000 core." }, Elf_Config_UInt { value = ELF_EM_RS08, name = "RS08", doc = "Freescale RS08 embedded processor." }, Elf_Config_UInt { value = ELF_EM_ECOG2, name = "ECOG2", doc = "Cyan Technology eCOG2 microprocessor." }, Elf_Config_UInt { value = ELF_EM_SCORE, name = "SCORE", doc = "Sunplus Score." }, Elf_Config_UInt { value = ELF_EM_SCORE7, name = "SCORE7", doc = "Sunplus S+core7 RISC processor." }, Elf_Config_UInt { value = ELF_EM_DSP24, name = "DSP24", doc = "New Japan Radio (NJR) 24-bit DSP Processor." }, Elf_Config_UInt { value = ELF_EM_VIDEOCORE3, name = "VIDEOCORE3", doc = "Broadcom VideoCore III processor." }, Elf_Config_UInt { value = ELF_EM_LATTICEMICO32, name = "LATTICEMICO32", doc = "RISC processor for Lattice FPGA architecture." }, Elf_Config_UInt { value = ELF_EM_SE_C17, name = "SE_C17", doc = "Seiko Epson C17 family." }, Elf_Config_UInt { value = ELF_EM_TI_C6000, name = "TI_C6000", doc = "Texas Instruments TMS320C6000 DSP family." }, Elf_Config_UInt { value = ELF_EM_TI_C2000, name = "TI_C2000", doc = "Texas Instruments TMS320C2000 DSP family." }, Elf_Config_UInt { value = ELF_EM_TI_C5500, name = "TI_C5500", doc = "Texas Instruments TMS320C55x DSP family." }, Elf_Config_UInt { value = ELF_EM_TI_PRU, name = "TI_PRU", doc = "Texas Instruments Programmable Realtime Unit." }, Elf_Config_UInt { value = ELF_EM_MMDSP_PLUS, name = "MMDSP_PLUS", doc = "STMicroelectronics 64bit VLIW Data Signal Processor." }, Elf_Config_UInt { value = ELF_EM_CYPRESS_M8C, name = "CYPRESS_M8C", doc = "Cypress M8C microprocessor." }, Elf_Config_UInt { value = ELF_EM_R32C , name = "R32C ", doc = "Renesas R32C series microprocessors." }, Elf_Config_UInt { value = ELF_EM_TRIMEDIA, name = "TRIMEDIA", doc = "NXP Semiconductors TriMedia architecture family." }, Elf_Config_UInt { value = ELF_EM_QDSP6, name = "QDSP6", doc = "QUALCOMM DSP6 Processor." }, Elf_Config_UInt { value = ELF_EM_8051, name = "8051", doc = "Intel 8051 and variants." }, Elf_Config_UInt { value = ELF_EM_STXP7X, name = "STXP7X", doc = "STMicroelectronics STxP7x family." }, Elf_Config_UInt { value = ELF_EM_NDS32, name = "NDS32", doc = "Andes Technology compact code size embedded RISC processor family." }, Elf_Config_UInt { value = ELF_EM_ECOG1, name = "ECOG1", doc = "Cyan Technology eCOG1X family." }, Elf_Config_UInt { value = ELF_EM_ECOG1X, name = "ECOG1X", doc = "Cyan Technology eCOG1X family." }, Elf_Config_UInt { value = ELF_EM_MAXQ30, name = "MAXQ30", doc = "Dallas Semiconductor MAXQ30 Core Micro-controllers." }, Elf_Config_UInt { value = ELF_EM_XIMO16, name = "XIMO16", doc = "New Japan Radio (NJR) 16-bit DSP Processor." }, Elf_Config_UInt { value = ELF_EM_MANIK, name = "MANIK", doc = "M2000 Reconfigurable RISC Microprocessor." }, Elf_Config_UInt { value = ELF_EM_CRAYNV2, name = "CRAYNV2", doc = "Cray Inc. NV2 vector architecture." }, Elf_Config_UInt { value = ELF_EM_RX , name = "RX ", doc = "Renesas RX family." }, Elf_Config_UInt { value = ELF_EM_METAG, name = "METAG", doc = "Imagination Technologies Meta processor architecture." }, Elf_Config_UInt { value = ELF_EM_MCST_ELBRUS, name = "MCST_ELBRUS", doc = "MCST Elbrus general purpose hardware architecture." }, Elf_Config_UInt { value = ELF_EM_ECOG16, name = "ECOG16", doc = "Cyan Technology eCOG16 family." }, Elf_Config_UInt { value = ELF_EM_CR16, name = "CR16", doc = "National Semiconductor CompactRISC 16-bit processor." }, Elf_Config_UInt { value = ELF_EM_ETPU, name = "ETPU", doc = "Freescale Extended Time Processing Unit." }, Elf_Config_UInt { value = ELF_EM_SLE9X, name = "SLE9X", doc = "Infineon Technologies SLE9X core." }, Elf_Config_UInt { value = ELF_EM_L1OM, name = "L1OM", doc = "Intel L1OM." }, Elf_Config_UInt { value = ELF_EM_K1OM, name = "K1OM", doc = "Intel K1OM." }, Elf_Config_UInt { value = ELF_EM_INTEL182, name = "INTEL182", doc = "Reserved by Intel." }, Elf_Config_UInt { value = ELF_EM_AARCH64, name = "AARCH64", doc = "ARM 64-bit architecture." }, Elf_Config_UInt { value = ELF_EM_ARM184, name = "ARM184", doc = "Reserved by ARM." }, Elf_Config_UInt { value = ELF_EM_AVR32, name = "AVR32", doc = "Atmel Corporation 32-bit microprocessor family." }, Elf_Config_UInt { value = ELF_EM_STM8 , name = "STM8 ", doc = "STMicroeletronics STM8 8-bit microcontroller." }, Elf_Config_UInt { value = ELF_EM_TILE64, name = "TILE64", doc = "Tilera TILE64 multicore architecture family." }, Elf_Config_UInt { value = ELF_EM_TILEPRO, name = "TILEPRO", doc = "Tilera TILEPro multicore architecture family." }, Elf_Config_UInt { value = ELF_EM_MICROBLAZE, name = "MICROBLAZE", doc = "Xilinx MicroBlaze 32-bit RISC soft processor core." }, Elf_Config_UInt { value = ELF_EM_CUDA, name = "CUDA", doc = "NVIDIA CUDA architecture." }, Elf_Config_UInt { value = ELF_EM_TILEGX, name = "TILEGX", doc = "Tilera TILE-Gx multicore architecture family." }, Elf_Config_UInt { value = ELF_EM_CLOUDSHIELD , name = "CLOUDSHIELD ", doc = "CloudShield architecture family." }, Elf_Config_UInt { value = ELF_EM_COREA_1ST , name = "COREA_1ST ", doc = "KIPO-KAIST Core-A 1st generation processor family." }, Elf_Config_UInt { value = ELF_EM_COREA_2ND , name = "COREA_2ND ", doc = "KIPO-KAIST Core-A 2nd generation processor family." }, Elf_Config_UInt { value = ELF_EM_ARC_COMPACT2, name = "ARC_COMPACT2", doc = "Synopsys ARCompact V2." }, Elf_Config_UInt { value = ELF_EM_OPEN8, name = "OPEN8", doc = "Open8 8-bit RISC soft processor core." }, Elf_Config_UInt { value = ELF_EM_RL78, name = "RL78", doc = "Renesas RL78 family." }, Elf_Config_UInt { value = ELF_EM_VIDEOCORE5 , name = "VIDEOCORE5 ", doc = "Broadcom VideoCore V processor." }, Elf_Config_UInt { value = ELF_EM_78K0R, name = "78K0R", doc = "Renesas 78K0R." }, Elf_Config_UInt { value = ELF_EM_56800EX, name = "56800EX", doc = "Freescale 56800EX Digital Signal Controller (DSC)." }, Elf_Config_UInt { value = ELF_EM_BA1, name = "BA1", doc = "Beyond BA1 CPU architecture." }, Elf_Config_UInt { value = ELF_EM_BA2, name = "BA2", doc = "Beyond BA2 CPU architecture." }, Elf_Config_UInt { value = ELF_EM_XCORE, name = "XCORE", doc = "XMOS xCORE processor family." }, Elf_Config_UInt { value = ELF_EM_MCHP_PIC, name = "MCHP_PIC", doc = "Microchip 8-bit PIC(r) family." }, Elf_Config_UInt { value = ELF_EM_INTELGT, name = "INTELGT", doc = "Intel Graphics Technology." }, Elf_Config_UInt { value = ELF_EM_INTEL206, name = "INTEL206", doc = "Reserved by Intel." }, Elf_Config_UInt { value = ELF_EM_INTEL207, name = "INTEL207", doc = "Reserved by Intel." }, Elf_Config_UInt { value = ELF_EM_INTEL208, name = "INTEL208", doc = "Reserved by Intel." }, Elf_Config_UInt { value = ELF_EM_INTEL209, name = "INTEL209", doc = "Reserved by Intel." }, Elf_Config_UInt { value = ELF_EM_KM32, name = "KM32", doc = "KM211 KM32 32-bit processor." }, Elf_Config_UInt { value = ELF_EM_KMX32, name = "KMX32", doc = "KM211 KMX32 32-bit processor." }, Elf_Config_UInt { value = ELF_EM_KMX16, name = "KMX16", doc = "KM211 KMX16 16-bit processor." }, Elf_Config_UInt { value = ELF_EM_KMX8, name = "KMX8", doc = "KM211 KMX8 8-bit processor." }, Elf_Config_UInt { value = ELF_EM_KVARC, name = "KVARC", doc = "KM211 KVARC processor." }, Elf_Config_UInt { value = ELF_EM_CDP, name = "CDP", doc = "Paneve CDP architecture family." }, Elf_Config_UInt { value = ELF_EM_COGE, name = "COGE", doc = "Cognitive Smart Memory Processor." }, Elf_Config_UInt { value = ELF_EM_COOL, name = "COOL", doc = "Bluechip Systems CoolEngine." }, Elf_Config_UInt { value = ELF_EM_NORC, name = "NORC", doc = "Nanoradio Optimized RISC." }, Elf_Config_UInt { value = ELF_EM_CSR_KALIMBA , name = "CSR_KALIMBA ", doc = "CSR Kalimba architecture family." }, Elf_Config_UInt { value = ELF_EM_Z80, name = "Z80", doc = "Zilog Z80." }, Elf_Config_UInt { value = ELF_EM_VISIUM, name = "VISIUM", doc = "Controls and Data Services VISIUMcore processor." }, Elf_Config_UInt { value = ELF_EM_FT32, name = "FT32", doc = "FTDI Chip FT32 high performance 32-bit RISC architecture." }, Elf_Config_UInt { value = ELF_EM_MOXIE, name = "MOXIE", doc = "Moxie processor family." }, Elf_Config_UInt { value = ELF_EM_AMDGPU, name = "AMDGPU", doc = "AMD GPU architecture." }, Elf_Config_UInt { value = ELF_EM_RISCV, name = "RISCV", doc = "RISC-V." }, Elf_Config_UInt { value = ELF_EM_LANAI, name = "LANAI", doc = "Lanai 32-bit processor." }, Elf_Config_UInt { value = ELF_EM_CEVA, name = "CEVA", doc = "CEVA Processor Architecture Family." }, Elf_Config_UInt { value = ELF_EM_CEVA_X2, name = "CEVA_X2", doc = "CEVA X2 Processor Family." }, Elf_Config_UInt { value = ELF_EM_BPF, name = "BPF", doc = "Linux BPF – in-kernel virtual machine." }, Elf_Config_UInt { value = ELF_EM_GRAPHCORE_IPU, name = "GRAPHCORE_IPU", doc = "Graphcore Intelligent Processing Unit." }, Elf_Config_UInt { value = ELF_EM_IMG1, name = "IMG1", doc = "Imagination Technologies." }, Elf_Config_UInt { value = ELF_EM_NFP, name = "NFP", doc = "Netronome Flow Processor." }, Elf_Config_UInt { value = ELF_EM_VE, name = "VE", doc = "NEC Vector Engine." }, Elf_Config_UInt { value = ELF_EM_CSKY, name = "CSKY", doc = "C-SKY processor family." }, Elf_Config_UInt { value = ELF_EM_ARC_COMPACT3_64, name = "ARC_COMPACT3_64", doc = "Synopsys ARCv2.3 64-bit." }, Elf_Config_UInt { value = ELF_EM_MCS6502, name = "MCS6502", doc = "MOS Technology MCS 6502 processor." }, Elf_Config_UInt { value = ELF_EM_ARC_COMPACT3, name = "ARC_COMPACT3", doc = "Synopsys ARCv2.3 32-bit." }, Elf_Config_UInt { value = ELF_EM_KVX, name = "KVX", doc = "Kalray VLIW core of the MPPA processor family." }, Elf_Config_UInt { value = ELF_EM_65816, name = "65816", doc = "WDC 65816/65C816." }, Elf_Config_UInt { value = ELF_EM_LOONGARCH, name = "LOONGARCH", doc = "LoongArch." }, Elf_Config_UInt { value = ELF_EM_KF32, name = "KF32", doc = "ChipON KungFu32." }, Elf_Config_UInt { value = ELF_EM_U16_U8CORE, name = "U16_U8CORE", doc = "LAPIS nX-U16/U8." }, Elf_Config_UInt { value = ELF_EM_TACHYUM, name = "TACHYUM", doc = "Tachyum." }, Elf_Config_UInt { value = ELF_EM_56800EF, name = "56800EF", doc = "NXP 56800EF Digital Signal Controller (DSC)." }]; /* When the ELF pickle maps or constructs an ELF header, it sets elf_selected_mach to whatever machine is specified in the header. However, the user can set elf_fixed_mach to a value different to ELF_EM_NONE in order to specify a particular machine. The data integrity checks in the pickle structures use the automatically selected machine, unless a fixed machine is set. This logic is implemented in the elf_mach function below. */ var elf_fixed_mach = ELF_EM_NONE; var elf_selected_mach = ELF_EM_NONE; fun elf_mach = uint<16>: { return elf_fixed_mach != ELF_EM_NONE ? elf_fixed_mach : elf_selected_mach; } /* ELF symbol types. */ var ELF_STT_NOTYPE = 0UN, ELF_STT_OBJECT = 1UN, ELF_STT_FUNC = 2UN, ELF_STT_SECTION = 3UN, ELF_STT_FILE = 4UN, ELF_STT_COMMON = 5UN, ELF_STT_TLS = 6UN, ELF_STT_NUM = 7UN, ELF_STT_LOOS = 10UN, ELF_STT_GNU_IFUNC = 10UN, ELF_STT_HIOS = 12UN, ELF_STT_LOPROC = 13UN, ELF_STT_HIPROC = 15UN; elf_config.add_enum :class "symbol-types" :entries [Elf_Config_UInt { value = ELF_STT_NOTYPE, name = "notype", doc = "The symbol type is not specified." }, Elf_Config_UInt { value = ELF_STT_OBJECT, name = "object", doc = "The symbol is associated with a data object" }, Elf_Config_UInt { value = ELF_STT_FUNC, name = "func", doc = "The symbol is associated with a function" + " or other executable code." }, Elf_Config_UInt { value = ELF_STT_SECTION, name = "section", doc = "The symbol is associated with a section." }, Elf_Config_UInt { value = ELF_STT_FILE, name = "file", doc = "The symbol is associated with a file." }, Elf_Config_UInt { value = ELF_STT_COMMON, name = "common", doc = "The symbol labels an uininitialized common block." }, Elf_Config_UInt { value = ELF_STT_TLS, name = "tls", doc = "the symbol specifies a TLS entity." }, Elf_Config_UInt { value = ELF_STT_NUM, name = "num" }]; /* ELF symbol bindings. */ var ELF_STB_LOCAL = 0, ELF_STB_GLOBAL = 1, ELF_STB_WEAK = 2, ELF_STB_LOOS = 10, ELF_STB_HIOS = 12, ELF_STB_LOPROC = 13, ELF_STB_HIPROC = 15; elf_config.add_enum :class "symbol-bindings" :entries [Elf_Config_UInt { value = ELF_STB_LOCAL, name = "local" }, Elf_Config_UInt { value = ELF_STB_GLOBAL, name = "global" }, Elf_Config_UInt { value = ELF_STB_WEAK, name = "weak" }]; /* ELF symbol visibility. */ var ELF_STV_DEFAULT = 0, ELF_STV_INTERNAL = 1, ELF_STV_HIDDEN = 2, ELF_STV_PROTECTED = 3; elf_config.add_enum :class "symbol-visibilities" :entries [Elf_Config_UInt { value = ELF_STV_DEFAULT, name = "default", doc = "Visibility of this symbol is defined by" + " its binding." }, Elf_Config_UInt { value = ELF_STV_INTERNAL, name = "internal", doc = "Visibility is defined by a processor-specific" + " supplement." }, Elf_Config_UInt { value = ELF_STV_HIDDEN, name = "hidden", doc = "Symbol is not visible to other components." }, Elf_Config_UInt { value = ELF_STV_PROTECTED, name = "protected", doc = "Symbol is visible in other components" + " but it is not preemptable." }]; /* Types for ELF symbol information, including binding, type and visibility. */ type Elf_Sym_Info = struct uint<8> { uint<4> st_bind : elf_config.check_enum ("symbol-bindings", elf_mach, st_bind); uint<4> st_type : elf_config.check_enum ("symbol-types", elf_mach, st_type); method _print_st_bind = void: { printf "#<%s>", elf_config.format_enum ("symbol-bindings", elf_mach, st_bind); } method _print_st_type = void: { printf "#<%s>", elf_config.format_enum ("symbol-types", elf_mach, st_type); } }; type Elf_Sym_Other_Info = struct uint<8> { uint<5>; uint<3> st_visibility : elf_config.check_enum ("symbol-visibilities", elf_mach, st_visibility); method _print_st_visibility = void: { printf "#<%s>", elf_config.format_enum ("symbol-visibilities", elf_mach, st_visibility); } }; /* Compression algorithm identificators. */ var ELF_COMPRESS_ZLIB = 1, ELF_COMPRESS_LOOS = 0x6000_0000, ELF_COMPRESS_HIOS = 0x6fff_ffff, ELF_COMPRESS_LOPROC = 0x7000_0000, ELF_COMPRESS_HIPROC = 0x7fff_ffff; fun elf_compress_algorithm_p = (uint<64> ch_type) int<32>: { return (ch_type == ELF_COMPRESS_ZLIB || (ch_type >= ELF_COMPRESS_LOOS && ch_type <= ELF_COMPRESS_HIOS) || (ch_type >= ELF_COMPRESS_LOPROC && ch_type <= ELF_COMPRESS_HIPROC)); } /* ELF hashing function. */ fun elf_hash = (string input) Elf_Word: { var h = 0 as uint<32>; var high = 0 as uint<32>; for (c in input) { h = (h <<. 4) + c; high = h & 0xf0000000; if (high) h = h ^ (high .>> 24); h = h & ~high; }; return h; } /* Dynamic tags. */ var ELF_DT_NULL = 0U, /* Tags the end of the dynamic array. */ /* d_val holds the string table offset of a null-terminated string, giving the name of a needed library. The dynamic array may. contain multiple entries with this type. */ ELF_DT_NEEDED = 1U, /* d_val holds the total size, in bytes, of the relocation entries associated with the procedure linkage table. If an entry of type ELF_DT_JMPREL is present, a ELF_DT_PLTRELSZ must accompany it. */ ELF_DT_PLTRELSZ = 2U, /* d_ptr holds an address associated with the procedure linkage table and/or the global offset table. */ ELF_DT_PLTGOT = 3U, /* d_ptr holds the address of the symbol hash table. This hash table refers to the symbol table referenced by the ELF_DT_SYMTAB element. */ ELF_DT_HASH = 4U, /* d_ptr holds the address of the string table. Symbol names, library names, and other strings reside in this table. */ ELF_DT_STRTAB = 5U, /* d_ptr holds the address of the symbol table. */ ELF_DT_SYMTAB = 6U, /* d_ptr holds the address of a relocation table. Entries in the table have explicit addends. An object file may have multiple relocation sections. If this element is present, the dynamic vector must also have ELF_DT_RELASZ and ELF_DT_RELAENT elements. */ ELF_DT_RELA = 7U, /* d_val holds the total size, in bytes, of the ELF_DT_RELA relocation entry. */ ELF_DT_RELASZ = 8U, /* d_val holds the size, in bytes, of the ELF_DT_RELA relocation entry. */ ELF_DT_RELAENT = 9U, /* d_val holds the size, in bytes, of the string table. */ ELF_DT_STRSZ = 10U, /* d_val holds the size, in bytes, of a symbol table entry. */ ELF_DT_SYMENT = 11U, /* d_ptr holds the address of the initialization function. */ ELF_DT_INIT = 12U, /* d_ptr holds the address of the finalization function. */ ELF_DT_FINI = 13U, /* d_val holds the string table offset of a null-terminated string, giving the name of the shared object. The offset is an index into the table recorded in the ELF_DT_STRTAB entry. */ ELF_DT_SONAME = 14U, /* d_val holds the string table offset of a null-terminated search library search path string. The offset is an index into the table recorded in the ELF_DT_STRTAB entry. This entry is at level 2. Its use has been superseded by ELF_DT_RUNPATH. */ ELF_DT_RPATH = 15U, /* This element's presence in a shared object library alters the dynamic linker's symbol resolution algorithm for references within the library. */ ELF_DT_SYMBOLIC = 16U, /* d_ptr holds the address of a relocation table containing REL relocations. If this element is present, the dynamic structure must also have ELF_DT_RELSZ and ELF_DT_RELENT elements. */ ELF_DT_REL = 17U, /* d_val holds the total size, in bytes, of the ELF_DT_REL relocation table. */ ELF_DT_RELSZ = 18U, /* d_val holds the size, in bytes, of the ELF_DT_REL relocation entry. */ ELF_DT_RELENT = 19U, /* d_val specifies the type of relocation entry to which the procedure linkage table refers: ELF_DT_REL or ELF_DT_RELA. */ ELF_DT_PLTREL = 20U, /* This tag is used for debugging. Its contents are not specified for the ABI. */ ELF_DT_DEBUG = 21U, /* This tag's absence signifies that no relocation entry should cause a modification to a non-writable segment, as specified by the segment permissions in the program header table. If this tag is present, one or more relocation entries might request modifications to a non-writable segment, and the dynamic linker can prepare accordingly. This entry is at level 2. Its use has been superseded by the DF_TEXTREL flag. */ ELF_DT_TEXTREL = 22U, /* d_ptr holds the address of relocation entries associated solely with the procedure linkage table. If this tag is present, the related entries of types ELF_DT_PLTRELSZ and ELF_DT_PLTREL must also be present. */ ELF_DT_JMPREL = 23U, /* If present, this tag instructs the dynamic linker to process all relocations for the object containing this entry before transferring control to the program. */ ELF_DT_BIND_NOW = 24U, /* d_ptr holds the address of the array of pointers to initialization functions. */ ELF_DT_INIT_ARRAY = 25U, /* d_ptr holds the address of the array of pointers to finalization functions. */ ELF_DT_FINI_ARRAY = 26U, /* d_val holds the size in bytes of the array of initialization functions pointed to by the ELF_DT_INIT_ARRAY entry. If an object has a ELF_DT_INIT_ARRAY entry, it must also have a ELF_DT_INIT_ARRAYSZ entry. */ ELF_DT_INIT_ARRAYSZ = 27U, /* d_val holds the size in bytes of the array of termination functions pointed to by the ELF_DT_FINI_ARRAY entry. If an object has a ELF_DT_fINI_ARRAY entry, it must also have a ELF_DT_FINI_ARRAYSZ entry. */ ELF_DT_FINI_ARRAYSZ = 28U, /* d_val holds the string table offset of a null-terminated library search path string. The offset is an index into the table recorded in the ELF_DT_STRTAB entry. */ ELF_DT_RUNPATH = 29U, /* d_val holds flag values specific to the object being loaded. */ ELF_DT_FLAGS = 30U, ELF_DT_ENCODING = 32U, /* d_ptr holds the address of the array of pointers to pre-initialization functions. */ ELF_DT_PREINIT_ARRAY = 32U, /* d_val holds the size in bytes of the array of pre-initialization functions pointed to by the ELF_DT_PREINIT_ARRAY entry. */ ELF_DT_PREINIT_ARRAYSZ = 33U, /* d_ptr holds the address of the SHT_SYMTAB_SHNDX section associated with the dynamic symbol table referenced by the ELF_DT_SYMTAB element. */ ELF_DT_SYMTAB_SHNDX = 34U, /* d_val holds the total size, in bytes, of the ELF_DT_RELR relocation entry. */ ELF_DT_RELRSZ = 35U, /* d_ptr holds the address of a relocation table containing RELR relocations. If this element is present, the dynamic structure must also have ELF_DT_RELRSZ and ELF_DT_RELRENT elements. */ ELF_DT_RELR = 36U, /* d_val holds the size, in bytes, of the ELF_DT_RELR relocation entry. */ ELF_DT_RELRENT = 37U, ELF_DT_LOOS = 0x6000_000dU, ELF_DT_HIOS = 0x6fff_f000U, ELF_DT_LOPROC = 0x7000_0000U, ELF_DT_SPARC_REGISTER = 0x7000_0001U, ELF_DT_HIPROC = 0x7fff_ffffU; elf_config.add_enum :class "dynamic-tag-types" :entries [Elf_Config_UInt { value = ELF_DT_NULL, name = "null" }, Elf_Config_UInt { value = ELF_DT_NEEDED, name = "needed" }, Elf_Config_UInt { value = ELF_DT_PLTRELSZ, name = "pltrelsz" }, Elf_Config_UInt { value = ELF_DT_PLTGOT, name = "pltgot" }, Elf_Config_UInt { value = ELF_DT_HASH, name = "hash" }, Elf_Config_UInt { value = ELF_DT_STRTAB, name = "strtab" }, Elf_Config_UInt { value = ELF_DT_SYMTAB, name = "symtab" }, Elf_Config_UInt { value = ELF_DT_RELA, name = "rela" }, Elf_Config_UInt { value = ELF_DT_RELASZ, name = "relasz" }, Elf_Config_UInt { value = ELF_DT_RELAENT, name = "relaent" }, Elf_Config_UInt { value = ELF_DT_STRSZ, name = "strsz" }, Elf_Config_UInt { value = ELF_DT_SYMENT, name = "syment" }, Elf_Config_UInt { value = ELF_DT_INIT, name = "init" }, Elf_Config_UInt { value = ELF_DT_FINI, name = "fini" }, Elf_Config_UInt { value = ELF_DT_SONAME, name = "soname" }, Elf_Config_UInt { value = ELF_DT_RPATH, name = "rpath" }, Elf_Config_UInt { value = ELF_DT_SYMBOLIC, name = "symbolic" }, Elf_Config_UInt { value = ELF_DT_REL, name = "rel" }, Elf_Config_UInt { value = ELF_DT_RELSZ, name = "relsz" }, Elf_Config_UInt { value = ELF_DT_RELENT, name = "relent" }, Elf_Config_UInt { value = ELF_DT_PLTREL, name = "pltrel" }, Elf_Config_UInt { value = ELF_DT_DEBUG, name = "debug" }, Elf_Config_UInt { value = ELF_DT_TEXTREL, name = "textrel" }, Elf_Config_UInt { value = ELF_DT_JMPREL, name = "jmprel" }, Elf_Config_UInt { value = ELF_DT_BIND_NOW, name = "bind-now" }, Elf_Config_UInt { value = ELF_DT_INIT_ARRAY, name = "init-array" }, Elf_Config_UInt { value = ELF_DT_FINI_ARRAY, name = "fini-array" }, Elf_Config_UInt { value = ELF_DT_INIT_ARRAYSZ, name = "init-arraysz" }, Elf_Config_UInt { value = ELF_DT_FINI_ARRAYSZ, name = "fini-arraysz" }, Elf_Config_UInt { value = ELF_DT_RUNPATH, name = "runpath" }, Elf_Config_UInt { value = ELF_DT_FLAGS, name = "flags" }, Elf_Config_UInt { value = ELF_DT_PREINIT_ARRAY, name = "preinit-array" }, Elf_Config_UInt { value = ELF_DT_PREINIT_ARRAYSZ, name = "preinit-arraysz" }, Elf_Config_UInt { value = ELF_DT_SYMTAB_SHNDX, name = "symtab-shndx" }, Elf_Config_UInt { value = ELF_DT_RELRSZ, name = "relrsz" }, Elf_Config_UInt { value = ELF_DT_RELR, name = "relr" }, Elf_Config_UInt { value = ELF_DT_RELRENT, name = "relrent" }]; /* ELF dynamic tags may be pointers or values, and this is is established implicitly by certain rules. */ type Elf_Tag_Rule = struct { uint<32> tag; int<32> is_ptr; }; var elf_tag_rules = Elf_Tag_Rule[](); fun elf_tag_is_ptr = (uint<32> tag) int<32>: { /* For tags < ELF_DT_ENCODING, the ABI determines whether they are pointers or values. */ if (tag in [ELF_DT_PLTGOT, ELF_DT_HASH, ELF_DT_STRTAB, ELF_DT_SYMTAB, ELF_DT_RELA, ELF_DT_SYMENT, ELF_DT_INIT, ELF_DT_FINI, ELF_DT_REL, ELF_DT_JMPREL, ELF_DT_INIT_ARRAY, ELF_DT_FINI_ARRAY]) return 1; /* Tags between DT_HIOS and DT_LOPROC do not follow the usual rules. We have to lookup in elf_freeform_tag_rules. */ if (tag > ELF_DT_HIOS && tag < ELF_DT_LOPROC) for (r in elf_tag_rules where r.tag == tag) return r.is_ptr; /* Tags above ELF_DT_ENCODING are pointers if the tag has an even value. */ if (tag >= ELF_DT_ENCODING) return tag % 2 == 0; return 0; } /* Definitions related to section groups. */ var ELF_GRP_COMDAT = 1, ELF_GRP_MASKOS = 0x0ff0_0000, ELF_GRP_MASKPROC = 0xf000_0000; /* Particular indexes in the section header table. */ var ELF_SHN_UNDEF = 0U, ELF_SHN_LORESERVE = -0x100U, ELF_SHN_LOPROC = -0x100U, ELF_SHN_HIPROC = -0xe1U, ELF_SHN_LOOS = -0xe0U, ELF_SHN_HIOS = -0xc1U, ELF_SHN_ABS = -0xfU, ELF_SHN_COMMON = -0xfeU, ELF_SHN_XINDEX = -0x1U, ELF_SHN_HIRESERVE = 0x1U; elf_config.add_enum :class "section-indices" :entries [Elf_Config_UInt { value = ELF_SHN_UNDEF, name = "undef", doc = "Undefined section reference." }, Elf_Config_UInt { value = ELF_SHN_ABS, name = "abs", doc = "Associated symbol is absolute." }, Elf_Config_UInt { value = ELF_SHN_COMMON, name = "common", doc = "Associated symbol is in common." }, Elf_Config_UInt { value = ELF_SHN_XINDEX, name = "xindex", doc = "Section index is held elsewhere." }]; /* Section types. */ var ELF_SHT_NULL = 0U, ELF_SHT_PROGBITS = 1U, ELF_SHT_SYMTAB = 2U, ELF_SHT_STRTAB = 3U, ELF_SHT_RELA = 4U, ELF_SHT_HASH = 5U, ELF_SHT_DYNAMIC = 6U, ELF_SHT_NOTE = 7U, ELF_SHT_NOBITS = 8U, ELF_SHT_REL = 9U, ELF_SHT_SHLIB = 10U, ELF_SHT_DYNSYM = 11U, ELF_SHT_INIT_ARRAY = 14U, ELF_SHT_FINI_ARRAY = 15U, ELF_SHT_PREINIT_ARRAY = 16U, ELF_SHT_GROUP = 17U, ELF_SHT_SYMTAB_SHNDX = 18U, ELF_SHT_RELR = 19U, ELF_SHT_LOOS = 0x6000_0000U, ELF_SHT_HIOS = 0x6fff_ffffU, ELF_SHT_LOUSER = 0x8000_0000U, ELF_SHT_HIUSER = 0xffff_ffffU; elf_config.add_enum :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_NULL, name = "null", doc = "Section header table entry unused." }, Elf_Config_UInt { value = ELF_SHT_PROGBITS, name = "progbits", doc = "Program specific (private) data." }, Elf_Config_UInt { value = ELF_SHT_SYMTAB, name = "symtab", doc = "Link editing symbol table." }, Elf_Config_UInt { value = ELF_SHT_STRTAB, name = "strtab", doc = "A string table." }, Elf_Config_UInt { value = ELF_SHT_RELA, name = "rela", doc = "Relocation entries with addends." }, Elf_Config_UInt { value = ELF_SHT_HASH, name = "hash", doc = "A symbol hash table." }, Elf_Config_UInt { value = ELF_SHT_DYNAMIC, name = "dynamic", doc = "Information for dynamic linking." }, Elf_Config_UInt { value = ELF_SHT_NOTE, name = "note", doc = "Section contains notes." }, Elf_Config_UInt { value = ELF_SHT_NOBITS, name = "nobits", doc = "Section occupies no space in file." }, Elf_Config_UInt { value = ELF_SHT_REL, name = "rel", doc = "Relocation entries, no addends." }, Elf_Config_UInt { value = ELF_SHT_SHLIB, name = "shlib", doc = "Reserved, unspecified semantics." }, Elf_Config_UInt { value = ELF_SHT_DYNSYM, name = "dynsym", doc = "Dynamic linking symbol table." }, Elf_Config_UInt { value = ELF_SHT_INIT_ARRAY, name = "init-array", doc = "Array of ptrs to init functions." }, Elf_Config_UInt { value = ELF_SHT_FINI_ARRAY, name = "fini-array", doc = "Array of ptrs to finish functions." }, Elf_Config_UInt { value = ELF_SHT_PREINIT_ARRAY, name = "preinit-array", doc = "Array of ptrs to pre-init functions." }, Elf_Config_UInt { value = ELF_SHT_GROUP, name = "group", doc = "Section contains a section group." }, Elf_Config_UInt { value = ELF_SHT_SYMTAB_SHNDX, name = "symtab-shndx", doc = "Indices for SHN_XINDEX entries." }, Elf_Config_UInt { value = ELF_SHT_RELR, name = "relr", doc = "Packed relative relocations." }]; /* Section Attribute Flags. */ var ELF_SHF_WRITE = 0x1, ELF_SHF_ALLOC = 0x2, ELF_SHF_EXECINSTR = 0x4, ELF_SHF_MERGE = 0x10, ELF_SHF_STRINGS = 0x20, ELF_SHF_INFO_LINK = 0x40, ELF_SHF_LINK_ORDER = 0x80, ELF_SHF_OS_NONCONFORMING = 0x100, ELF_SHF_GROUP = 0x200, ELF_SHF_TLS = 0x400, ELF_SHF_COMPRESSED = 0x800, ELF_SHF_MASKOS = 0x0ff0_0000, ELF_SHF_MASKPROC = 0xf000_0000; elf_config.add_mask :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_WRITE, name = "write" }, Elf_Config_Mask { value = ELF_SHF_ALLOC, name = "alloc" }, Elf_Config_Mask { value = ELF_SHF_EXECINSTR, name = "execinstr" }, Elf_Config_Mask { value = ELF_SHF_MERGE, name = "merge" }, Elf_Config_Mask { value = ELF_SHF_STRINGS, name = "strings" }, Elf_Config_Mask { value = ELF_SHF_INFO_LINK, name = "info-link" }, Elf_Config_Mask { value = ELF_SHF_LINK_ORDER, name = "link-order" }, Elf_Config_Mask { value = ELF_SHF_OS_NONCONFORMING, name = "os-nonconforming" }, Elf_Config_Mask { value = ELF_SHF_GROUP, name = "group" }, Elf_Config_Mask { value = ELF_SHF_TLS, name = "tls" }, Elf_Config_Mask { value = ELF_SHF_COMPRESSED,name = "compressed" }]; /* Segment types. */ var ELF_PT_NULL = 0U, ELF_PT_LOAD = 1U, ELF_PT_DYNAMIC = 2U, ELF_PT_INTERP = 3U, ELF_PT_NOTE = 4U, ELF_PT_SHLIB = 5U, ELF_PT_PHDR = 6U, ELF_PT_TLS = 7U, ELF_PT_LOOS = 0x6000_0000U, ELF_PT_HIOS = 0x6fff_ffffU, ELF_PT_LOPROC = 0x7000_0000U, ELF_PT_HIPROC = 0x7fff_ffffU; elf_config.add_enum :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_NULL, name = "null", doc = "Ignored entry." }, Elf_Config_UInt { value = ELF_PT_LOAD, name = "load", doc = "Segment is loadable."}, Elf_Config_UInt { value = ELF_PT_DYNAMIC, name = "dynamic", doc = "Segment contains dynamic linking information." }, Elf_Config_UInt { value = ELF_PT_INTERP, name = "interp", doc = "Segment contains the path of an interpreter." }, Elf_Config_UInt { value = ELF_PT_NOTE, name = "note", doc = "Segment contains notes." }, Elf_Config_UInt { value = ELF_PT_SHLIB, name = "shlib", doc = "Reserved entry." }, Elf_Config_UInt { value = ELF_PT_PHDR, name = "phdr", doc = "Segment contains the program header table itself." }, Elf_Config_UInt { value = ELF_PT_TLS, name = "tls", doc = "Segment contains a TLS template." }]; /* Segment Flags. */ var ELF_PF_X = 0x1, ELF_PF_W = 0x2, ELF_PF_R = 0x4, ELF_PF_MASKOS = 0x0ff0_0000, ELF_PF_MASKPROC = 0xf000_0000; elf_config.add_mask :class "segment-flags" :entries [Elf_Config_Mask { value = ELF_PF_X, name = "X", doc = "Segment is executable." }, Elf_Config_Mask { value = ELF_PF_W, name = "W", doc = "Segment is writeable." }, Elf_Config_Mask { value = ELF_PF_R, name = "R", doc = "Segment is readable." }]; /* Encoding of the ELF file. */ var ELF_DATA_NONE = 0, ELF_DATA_2LSB = 1, ELF_DATA_2MSB = 2; elf_config.add_enum :class "file-encodings" :entries [Elf_Config_UInt { value = ELF_DATA_NONE, name = "none" }, Elf_Config_UInt { value = ELF_DATA_2LSB, name = "2lsb", doc = "File is encoded in 2's complement, little endian." }, Elf_Config_UInt { value = ELF_DATA_2MSB, name = "2msb", doc = "File is encoded in 2's complement, big endian." }]; /* ELF hash table. */ type Elf_Hash_Table = struct { Elf_Word nbucket; Elf_Word nchain; Elf_Word[nbucket] bucket; Elf_Word[nchain] chain; }; /* ELF notes. */ /* Note that the type below can be used for both ELF32 and ELF64 files. The SYSV ABI says that 64-bit notes must be aligned to 8 bytes, but binutils is known to generate 64-bit notes aligned to 4 bytes instead. */ type Elf_Note = struct { /* The first `namesz' bytes in `name' contain a NULL-terminated character representation of the entry's owner or originator. */ Elf_Word namesz; /* The first `descsz' bytes in `desc' hold the note descriptor. The ABI places no constraints on a descriptor's contents. */ Elf_Word descsz; /* This word gives the interpretation of the descriptor. Each originator controls its own types. They must be non-negative. The ABI does not define what descriptors mean. */ Elf_Word _type : elf_config.check_enum ("note-tags", elf_mach, _type); uint<8>[namesz] name; uint<8>[alignto (OFFSET, 4#B)]; uint<8>[descsz] desc; uint<8>[alignto (OFFSET, 4#B)]; method _print_name = void: { printf "#<%s>", catos (name); } method _print__type = void: { printf "#<%s>", elf_config.format_enum ("note-tags", elf_mach, _type); } }; /* ELF identification struct. This is the first component in the ELF header for both ELF32 and ELF64. */ type Elf_Ident = struct { uint<8>[4] ei_mag == [0x7fUB, 'E', 'L', 'F']; uint<8> ei_class : elf_config.check_enum ("file-classes", elf_mach, ei_class) && ei_class != ELF_CLASS_NONE; uint<8> ei_data : elf_config.check_enum ("file-encodings", elf_mach, ei_data) && ei_data != ELF_DATA_NONE && (ei_data == ELF_DATA_2LSB) ? set_endian (ENDIAN_LITTLE) : set_endian (ENDIAN_BIG); uint<8> ei_version = ELF_EV_CURRENT; uint<8> ei_osabi : elf_config.check_enum ("file-osabis", elf_mach, ei_osabi); uint<8> ei_abiversion : ei_osabi == ELF_OSABI_NONE => ei_abiversion == 0; uint<8>[7] ei_pad = [0UB,0UB,0UB,0UB,0UB,0UB,0UB]; method _print_ei_class = void: { printf "#<%s>", elf_config.format_enum ("file-classes", elf_mach, ei_class); } method _print_ei_data = void: { printf "#<%s>", elf_config.format_enum ("file-encodings", elf_mach, ei_data); } method _print_ei_osabi = void: { printf "#<%s>", elf_config.format_enum ("file-osabis", elf_mach, ei_osabi); } }; poke-elf-1.0/elf-mach-aarch64.pk0000644000175000017500000011236514602057347013253 00000000000000/* elf-mach-aarch64.pk - ELF Aarch64 specific definitions. */ /* Copyright (C) 2024 Jose E. Marchesi. */ /* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* Aarch64 segment types. */ var ELF_PT_AARCH64_ARCHEXT = ELF_PT_LOPROC + 0, ELF_PT_AARCH64_MEMTAG_MTE = ELF_PT_LOPROC + 0x2; elf_config.add_enum :machine ELF_EM_AARCH64 :class "segment-types" :entries [Elf_Config_UInt { value = ELF_PT_AARCH64_ARCHEXT, name = "archext" }, Elf_Config_UInt { value = ELF_PT_AARCH64_MEMTAG_MTE, name = "memtag-mte", doc = "MTE memory tag segment." }]; /* Aarch64 section types. */ var ELF_SHT_AARCH64_ATTRIBUTES = 0x70000003U; elf_config.add_enum :machine ELF_EM_AARCH64 :class "section-types" :entries [Elf_Config_UInt { value = ELF_SHT_AARCH64_ATTRIBUTES, name = "attributes", doc = "Section holds attributes." }]; /* Aarch64 section flags. */ var ELF_SHF_AARCH64_ENTRYSECT = 0x10000000U, ELF_SHF_AARCH64_COMDEF = 0x80000000U; elf_config.add_mask :machine ELF_EM_AARCH64 :class "section-flags" :entries [Elf_Config_Mask { value = ELF_SHF_AARCH64_ENTRYSECT, name = "entrysect", doc = "Section contains an entry point." }, Elf_Config_Mask { value = ELF_SHF_AARCH64_COMDEF, name = "comdef", doc = "Section may be multiply defined in the input" + " to a link step." }]; /* Aarch64 dynamic tag types. */ var ELF_DT_AARCH64_BTI_PLT = ELF_DT_LOPROC + 1, ELF_DT_AARCH64_PAC_PLT = ELF_DT_LOPROC + 3, ELF_DT_AARCH64_VARIANT_PCS = ELF_DT_LOPROC + 5; elf_config.add_enum :machine ELF_EM_AARCH64 :class "dynamic-tag-types" :entries [Elf_Config_UInt { value = ELF_DT_AARCH64_BTI_PLT, name = "bti-plt" }, Elf_Config_UInt { value = ELF_DT_AARCH64_PAC_PLT, name = "pac-plt" }, Elf_Config_UInt { value = ELF_DT_AARCH64_VARIANT_PCS, name = "variant-pcs" }]; /* AArch64 values for st_other. */ var ELF_STO_AARCH64_VARIANT_PCS = 0x80; elf_config.add_enum :machine ELF_EM_AARCH64 :class "section-other" :entries [Elf_Config_UInt { value = ELF_STO_AARCH64_VARIANT_PCS, name = "variant-pcs", doc = "Symbol may follow different call convention from" + " the base PCS." }]; /* Aarch64 relocation types. */ var ELF_R_AARCH64_NONE = 0U, ELF_R_AARCH64_P32_ABS32 = 1U, ELF_R_AARCH64_P32_ABS16 = 2U, ELF_R_AARCH64_P32_PREL32 = 3U, ELF_R_AARCH64_P32_PREL16 = 4U, ELF_R_AARCH64_P32_MOVW_UABS_G0 = 5U, ELF_R_AARCH64_P32_MOVW_UABS_G0_NC = 6U, ELF_R_AARCH64_P32_MOVW_UABS_G1 = 7U, ELF_R_AARCH64_P32_MOVW_SABS_G0 = 8U, ELF_R_AARCH64_P32_LD_PREL_LO19 = 9U, ELF_R_AARCH64_P32_ADR_PREL_LO21 = 10U, ELF_R_AARCH64_P32_ADR_PREL_PG_HI21 = 11U, ELF_R_AARCH64_P32_ADD_ABS_LO12_NC = 12U, ELF_R_AARCH64_P32_LDST8_ABS_LO12_NC = 13U, ELF_R_AARCH64_P32_LDST16_ABS_LO12_NC = 14U, ELF_R_AARCH64_P32_LDST32_ABS_LO12_NC = 15U, ELF_R_AARCH64_P32_LDST64_ABS_LO12_NC = 16U, ELF_R_AARCH64_P32_LDST128_ABS_LO12_NC = 17U, ELF_R_AARCH64_P32_TSTBR14 = 18U, ELF_R_AARCH64_P32_CONDBR19 = 19U, ELF_R_AARCH64_P32_JUMP26 = 20U, ELF_R_AARCH64_P32_CALL26 = 21U, ELF_R_AARCH64_P32_MOVW_PREL_G0 = 22U, ELF_R_AARCH64_P32_MOVW_PREL_G0_NC = 23U, ELF_R_AARCH64_P32_MOVW_PREL_G1 = 24U, ELF_R_AARCH64_P32_GOT_LD_PREL19 = 25U, ELF_R_AARCH64_P32_ADR_GOT_PAGE = 26U, ELF_R_AARCH64_P32_LD32_GOT_LO12_NC = 27U, ELF_R_AARCH64_P32_LD32_GOTPAGE_LO14 = 28U, ELF_R_AARCH64_P32_TLSGD_ADR_PREL21 = 80U, ELF_R_AARCH64_P32_TLSGD_ADR_PAGE21 = 81U, ELF_R_AARCH64_P32_TLSGD_ADD_LO12_NC = 82U, ELF_R_AARCH64_P32_TLSLD_ADR_PREL21 = 83U, ELF_R_AARCH64_P32_TLSLD_ADR_PAGE21 = 84U, ELF_R_AARCH64_P32_TLSLD_ADD_LO12_NC = 85U, ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G1 = 87U, ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G0 = 88U, ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G0_NC = 89U, ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_HI12 = 90U, ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_LO12 = 91U, ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_LO12_NC = 92U, ELF_R_AARCH64_P32_TLSIE_ADR_GOTTPREL_PAGE21 = 103U, ELF_R_AARCH64_P32_TLSIE_LD32_GOTTPREL_LO12_NC = 104U, ELF_R_AARCH64_P32_TLSIE_LD_GOTTPREL_PREL19 = 105U, ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G1 = 106U, ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G0 = 107U, ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G0_NC = 108U, ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_HI12 = 109U, ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_LO12 = 110U, ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_LO12_NC = 111U, ELF_R_AARCH64_P32_TLSLE_LDST8_TPREL_LO12 = 112U, ELF_R_AARCH64_P32_TLSLE_LDST8_TPREL_LO12_NC = 113U, ELF_R_AARCH64_P32_TLSLE_LDST16_TPREL_LO12 = 114U, ELF_R_AARCH64_P32_TLSLE_LDST16_TPREL_LO12_NC = 115U, ELF_R_AARCH64_P32_TLSLE_LDST32_TPREL_LO12 = 116U, ELF_R_AARCH64_P32_TLSLE_LDST32_TPREL_LO12_NC = 117U, ELF_R_AARCH64_P32_TLSLE_LDST64_TPREL_LO12 = 118U, ELF_R_AARCH64_P32_TLSLE_LDST64_TPREL_LO12_NC = 119U, ELF_R_AARCH64_P32_TLSDESC_LD_PREL19 = 122U, ELF_R_AARCH64_P32_TLSDESC_ADR_PREL21 = 123U, ELF_R_AARCH64_P32_TLSDESC_ADR_PAGE21 = 124U, ELF_R_AARCH64_P32_TLSDESC_LD32_LO12_NC = 125U, ELF_R_AARCH64_P32_TLSDESC_ADD_LO12_NC = 126U, ELF_R_AARCH64_P32_TLSDESC_CALL = 127U, ELF_R_AARCH64_P32_COPY = 180U, ELF_R_AARCH64_P32_GLOB_DAT = 181U, ELF_R_AARCH64_P32_JUMP_SLOT = 182U, ELF_R_AARCH64_P32_RELATIVE = 183U, ELF_R_AARCH64_P32_TLS_DTPMOD = 184U, ELF_R_AARCH64_P32_TLS_DTPREL = 185U, ELF_R_AARCH64_P32_TLS_TPREL = 186U, ELF_R_AARCH64_P32_TLSDESC = 187U, ELF_R_AARCH64_P32_IRELATIVE = 188U, ELF_R_AARCH64_NULL = 256U, ELF_R_AARCH64_ABS64 = 257U, ELF_R_AARCH64_ABS32 = 258U, ELF_R_AARCH64_ABS16 = 259U, ELF_R_AARCH64_PREL64 = 260U, ELF_R_AARCH64_PREL32 = 261U, ELF_R_AARCH64_PREL16 = 262U, ELF_R_AARCH64_MOVW_UABS_G0 = 263U, ELF_R_AARCH64_MOVW_UABS_G0_NC = 264U, ELF_R_AARCH64_MOVW_UABS_G1 = 265U, ELF_R_AARCH64_MOVW_UABS_G1_NC = 266U, ELF_R_AARCH64_MOVW_UABS_G2 = 267U, ELF_R_AARCH64_MOVW_UABS_G2_NC = 268U, ELF_R_AARCH64_MOVW_UABS_G3 = 269U, ELF_R_AARCH64_MOVW_SABS_G0 = 270U, ELF_R_AARCH64_MOVW_SABS_G1 = 271U, ELF_R_AARCH64_MOVW_SABS_G2 = 272U, ELF_R_AARCH64_LD_PREL_LO19 = 273U, ELF_R_AARCH64_ADR_PREL_LO21 = 274U, ELF_R_AARCH64_ADR_PREL_PG_HI21 = 275U, ELF_R_AARCH64_ADR_PREL_PG_HI21_NC = 276U, ELF_R_AARCH64_ADD_ABS_LO12_NC = 277U, ELF_R_AARCH64_LDST8_ABS_LO12_NC = 278U, ELF_R_AARCH64_TSTBR14 = 279U, ELF_R_AARCH64_CONDBR19 = 280U, ELF_R_AARCH64_JUMP26 = 282U, ELF_R_AARCH64_CALL26 = 283U, ELF_R_AARCH64_LDST16_ABS_LO12_NC = 284U, ELF_R_AARCH64_LDST32_ABS_LO12_NC = 285U, ELF_R_AARCH64_LDST64_ABS_LO12_NC = 286U, ELF_R_AARCH64_MOVW_PREL_G0 = 287U, ELF_R_AARCH64_MOVW_PREL_G0_NC = 288U, ELF_R_AARCH64_MOVW_PREL_G1 = 289U, ELF_R_AARCH64_MOVW_PREL_G1_NC = 290U, ELF_R_AARCH64_MOVW_PREL_G2 = 291U, ELF_R_AARCH64_MOVW_PREL_G2_NC = 292U, ELF_R_AARCH64_MOVW_PREL_G3 = 293U, ELF_R_AARCH64_LDST128_ABS_LO12_NC = 299U, ELF_R_AARCH64_MOVW_GOTOFF_G0 = 300U, ELF_R_AARCH64_MOVW_GOTOFF_G0_NC = 301U, ELF_R_AARCH64_MOVW_GOTOFF_G1 = 302U, ELF_R_AARCH64_MOVW_GOTOFF_G1_NC = 303U, ELF_R_AARCH64_MOVW_GOTOFF_G2 = 304U, ELF_R_AARCH64_MOVW_GOTOFF_G2_NC = 305U, ELF_R_AARCH64_MOVW_GOTOFF_G3 = 306U, ELF_R_AARCH64_GOTREL64 = 307U, ELF_R_AARCH64_GOTREL32 = 308U, ELF_R_AARCH64_GOT_LD_PREL19 = 309U, ELF_R_AARCH64_LD64_GOTOFF_LO15 = 310U, ELF_R_AARCH64_ADR_GOT_PAGE = 311U, ELF_R_AARCH64_LD64_GOT_LO12_NC = 312U, ELF_R_AARCH64_LD64_GOTPAGE_LO15 = 313U, ELF_R_AARCH64_TLSGD_ADR_PREL21 = 512U, ELF_R_AARCH64_TLSGD_ADR_PAGE21 = 513U, ELF_R_AARCH64_TLSGD_ADD_LO12_NC = 514U, ELF_R_AARCH64_TLSGD_MOVW_G1 = 515U, ELF_R_AARCH64_TLSGD_MOVW_G0_NC = 516U, ELF_R_AARCH64_TLSLD_ADR_PREL21 = 517U, ELF_R_AARCH64_TLSLD_ADR_PAGE21 = 518U, ELF_R_AARCH64_TLSLD_ADD_LO12_NC = 519U, ELF_R_AARCH64_TLSLD_MOVW_G1 = 520U, ELF_R_AARCH64_TLSLD_MOVW_G0_NC = 521U, ELF_R_AARCH64_TLSLD_LD_PREL19 = 522U, ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G2 = 523U, ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G1 = 524U, ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G1_NC = 525U, ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G0 = 526U, ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G0_NC = 527U, ELF_R_AARCH64_TLSLD_ADD_DTPREL_HI12 = 528U, ELF_R_AARCH64_TLSLD_ADD_DTPREL_LO12 = 529U, ELF_R_AARCH64_TLSLD_ADD_DTPREL_LO12_NC = 530U, ELF_R_AARCH64_TLSLD_LDST8_DTPREL_LO12 = 531U, ELF_R_AARCH64_TLSLD_LDST8_DTPREL_LO12_NC = 532U, ELF_R_AARCH64_TLSLD_LDST16_DTPREL_LO12 = 533U, ELF_R_AARCH64_TLSLD_LDST16_DTPREL_LO12_NC = 534U, ELF_R_AARCH64_TLSLD_LDST32_DTPREL_LO12 = 535U, ELF_R_AARCH64_TLSLD_LDST32_DTPREL_LO12_NC = 536U, ELF_R_AARCH64_TLSLD_LDST64_DTPREL_LO12 = 537U, ELF_R_AARCH64_TLSLD_LDST64_DTPREL_LO12_NC = 538U, ELF_R_AARCH64_TLSIE_MOVW_GOTTPREL_G1 = 539U, ELF_R_AARCH64_TLSIE_MOVW_GOTTPREL_G0_NC = 540U, ELF_R_AARCH64_TLSIE_ADR_GOTTPREL_PAGE21 = 541U, ELF_R_AARCH64_TLSIE_LD64_GOTTPREL_LO12_NC = 542U, ELF_R_AARCH64_TLSIE_LD_GOTTPREL_PREL19 = 543U, ELF_R_AARCH64_TLSLE_MOVW_TPREL_G2 = 544U, ELF_R_AARCH64_TLSLE_MOVW_TPREL_G1 = 545U, ELF_R_AARCH64_TLSLE_MOVW_TPREL_G1_NC = 546U, ELF_R_AARCH64_TLSLE_MOVW_TPREL_G0 = 547U, ELF_R_AARCH64_TLSLE_MOVW_TPREL_G0_NC = 548U, ELF_R_AARCH64_TLSLE_ADD_TPREL_HI12 = 549U, ELF_R_AARCH64_TLSLE_ADD_TPREL_LO12 = 550U, ELF_R_AARCH64_TLSLE_ADD_TPREL_LO12_NC = 551U, ELF_R_AARCH64_TLSLE_LDST8_TPREL_LO12 = 552U, ELF_R_AARCH64_TLSLE_LDST8_TPREL_LO12_NC = 553U, ELF_R_AARCH64_TLSLE_LDST16_TPREL_LO12 = 554U, ELF_R_AARCH64_TLSLE_LDST16_TPREL_LO12_NC = 555U, ELF_R_AARCH64_TLSLE_LDST32_TPREL_LO12 = 556U, ELF_R_AARCH64_TLSLE_LDST32_TPREL_LO12_NC = 557U, ELF_R_AARCH64_TLSLE_LDST64_TPREL_LO12 = 558U, ELF_R_AARCH64_TLSLE_LDST64_TPREL_LO12_NC = 559U, ELF_R_AARCH64_TLSDESC_LD_PREL19 = 560U, ELF_R_AARCH64_TLSDESC_ADR_PREL21 = 561U, ELF_R_AARCH64_TLSDESC_ADR_PAGE21 = 562U, ELF_R_AARCH64_TLSDESC_LD64_LO12 = 563U, ELF_R_AARCH64_TLSDESC_ADD_LO12 = 564U, ELF_R_AARCH64_TLSDESC_OFF_G1 = 565U, ELF_R_AARCH64_TLSDESC_OFF_G0_NC = 566U, ELF_R_AARCH64_TLSDESC_LDR = 567U, ELF_R_AARCH64_TLSDESC_ADD = 568U, ELF_R_AARCH64_TLSDESC_CALL = 569U, ELF_R_AARCH64_TLSLE_LDST128_TPREL_LO12 = 570U, ELF_R_AARCH64_TLSLE_LDST128_TPREL_LO12_NC = 571U, ELF_R_AARCH64_TLSLD_LDST128_DTPREL_LO12 = 572U, ELF_R_AARCH64_TLSLD_LDST128_DTPREL_LO12_NC = 573U, ELF_R_AARCH64_COPY = 1024U, ELF_R_AARCH64_GLOB_DAT = 1025U, ELF_R_AARCH64_JUMP_SLOT = 1026U, ELF_R_AARCH64_RELATIVE = 1027U, ELF_R_AARCH64_TLS_DTPMOD64 = 1028U, ELF_R_AARCH64_TLS_DTPREL64 = 1029U, ELF_R_AARCH64_TLS_TPREL64 = 1030U, ELF_R_AARCH64_TLS_DTPMOD = 1028U, ELF_R_AARCH64_TLS_DTPREL = 1029U, ELF_R_AARCH64_TLS_TPREL = 1030U, ELF_R_AARCH64_TLSDESC = 1031U, ELF_R_AARCH64_IRELATIVE = 1032U; elf_config.add_enum :machine ELF_EM_AARCH64 :class "reloc-types" :entries [Elf_Config_UInt { value = ELF_R_AARCH64_NONE, name = "NONE" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ABS32, name = "P32_ABS32" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ABS16, name = "P32_ABS16" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_PREL32, name = "P32_PREL32" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_PREL16, name = "P32_PREL16" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_UABS_G0, name = "P32_MOVW_UABS_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_UABS_G0_NC, name = "P32_MOVW_UABS_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_UABS_G1, name = "P32_MOVW_UABS_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_SABS_G0, name = "P32_MOVW_SABS_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LD_PREL_LO19, name = "P32_LD_PREL_LO19" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ADR_PREL_LO21, name = "P32_ADR_PREL_LO21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ADR_PREL_PG_HI21, name = "P32_ADR_PREL_PG_HI21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ADD_ABS_LO12_NC, name = "P32_ADD_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LDST8_ABS_LO12_NC, name = "P32_LDST8_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LDST16_ABS_LO12_NC, name = "P32_LDST16_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LDST32_ABS_LO12_NC, name = "P32_LDST32_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LDST64_ABS_LO12_NC, name = "P32_LDST64_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LDST128_ABS_LO12_NC, name = "P32_LDST128_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TSTBR14, name = "P32_TSTBR14" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_CONDBR19, name = "P32_CONDBR19" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_JUMP26, name = "P32_JUMP26" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_CALL26, name = "P32_CALL26" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_PREL_G0, name = "P32_MOVW_PREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_PREL_G0_NC, name = "P32_MOVW_PREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_MOVW_PREL_G1, name = "P32_MOVW_PREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_GOT_LD_PREL19, name = "P32_GOT_LD_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_ADR_GOT_PAGE, name = "P32_ADR_GOT_PAGE" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LD32_GOT_LO12_NC, name = "P32_LD32_GOT_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_LD32_GOTPAGE_LO14, name = "P32_LD32_GOTPAGE_LO14" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSGD_ADR_PREL21, name = "P32_TLSGD_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSGD_ADR_PAGE21, name = "P32_TLSGD_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSGD_ADD_LO12_NC, name = "P32_TLSGD_ADD_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADR_PREL21, name = "P32_TLSLD_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADR_PAGE21, name = "P32_TLSLD_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADD_LO12_NC, name = "P32_TLSLD_ADD_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G1, name = "P32_TLSLD_MOVW_DTPREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G0, name = "P32_TLSLD_MOVW_DTPREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_MOVW_DTPREL_G0_NC, name = "P32_TLSLD_MOVW_DTPREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_HI12, name = "P32_TLSLD_ADD_DTPREL_HI12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_LO12, name = "P32_TLSLD_ADD_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLD_ADD_DTPREL_LO12_NC, name = "P32_TLSLD_ADD_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSIE_ADR_GOTTPREL_PAGE21, name = "P32_TLSIE_ADR_GOTTPREL_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSIE_LD32_GOTTPREL_LO12_NC, name = "P32_TLSIE_LD32_GOTTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSIE_LD_GOTTPREL_PREL19, name = "P32_TLSIE_LD_GOTTPREL_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G1, name = "P32_TLSLE_MOVW_TPREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G0, name = "P32_TLSLE_MOVW_TPREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_MOVW_TPREL_G0_NC, name = "P32_TLSLE_MOVW_TPREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_HI12, name = "P32_TLSLE_ADD_TPREL_HI12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_LO12, name = "P32_TLSLE_ADD_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_ADD_TPREL_LO12_NC, name = "P32_TLSLE_ADD_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST8_TPREL_LO12, name = "P32_TLSLE_LDST8_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST8_TPREL_LO12_NC, name = "P32_TLSLE_LDST8_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST16_TPREL_LO12, name = "P32_TLSLE_LDST16_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST16_TPREL_LO12_NC, name = "P32_TLSLE_LDST16_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST32_TPREL_LO12, name = "P32_TLSLE_LDST32_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST32_TPREL_LO12_NC, name = "P32_TLSLE_LDST32_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST64_TPREL_LO12, name = "P32_TLSLE_LDST64_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSLE_LDST64_TPREL_LO12_NC, name = "P32_TLSLE_LDST64_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_LD_PREL19, name = "P32_TLSDESC_LD_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_ADR_PREL21, name = "P32_TLSDESC_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_ADR_PAGE21, name = "P32_TLSDESC_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_LD32_LO12_NC, name = "P32_TLSDESC_LD32_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_ADD_LO12_NC, name = "P32_TLSDESC_ADD_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC_CALL, name = "P32_TLSDESC_CALL" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_COPY, name = "P32_COPY" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_GLOB_DAT, name = "P32_GLOB_DAT" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_JUMP_SLOT, name = "P32_JUMP_SLOT" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_RELATIVE, name = "P32_RELATIVE" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLS_DTPMOD, name = "P32_TLS_DTPMOD" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLS_DTPREL, name = "P32_TLS_DTPREL" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLS_TPREL, name = "P32_TLS_TPREL" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_TLSDESC, name = "P32_TLSDESC" }, Elf_Config_UInt { value = ELF_R_AARCH64_P32_IRELATIVE, name = "P32_IRELATIVE" }, Elf_Config_UInt { value = ELF_R_AARCH64_NULL, name = "NULL" }, Elf_Config_UInt { value = ELF_R_AARCH64_ABS64, name = "ABS64" }, Elf_Config_UInt { value = ELF_R_AARCH64_ABS32, name = "ABS32" }, Elf_Config_UInt { value = ELF_R_AARCH64_ABS16, name = "ABS16" }, Elf_Config_UInt { value = ELF_R_AARCH64_PREL64, name = "PREL64" }, Elf_Config_UInt { value = ELF_R_AARCH64_PREL32, name = "PREL32" }, Elf_Config_UInt { value = ELF_R_AARCH64_PREL16, name = "PREL16" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G0, name = "MOVW_UABS_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G0_NC, name = "MOVW_UABS_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G1, name = "MOVW_UABS_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G1_NC, name = "MOVW_UABS_G1_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G2, name = "MOVW_UABS_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G2_NC, name = "MOVW_UABS_G2_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_UABS_G3, name = "MOVW_UABS_G3" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_SABS_G0, name = "MOVW_SABS_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_SABS_G1, name = "MOVW_SABS_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_SABS_G2, name = "MOVW_SABS_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_LD_PREL_LO19, name = "LD_PREL_LO19" }, Elf_Config_UInt { value = ELF_R_AARCH64_ADR_PREL_LO21, name = "ADR_PREL_LO21" }, Elf_Config_UInt { value = ELF_R_AARCH64_ADR_PREL_PG_HI21, name = "ADR_PREL_PG_HI21" }, Elf_Config_UInt { value = ELF_R_AARCH64_ADR_PREL_PG_HI21_NC, name = "ADR_PREL_PG_HI21_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_ADD_ABS_LO12_NC, name = "ADD_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_LDST8_ABS_LO12_NC, name = "LDST8_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TSTBR14, name = "TSTBR14" }, Elf_Config_UInt { value = ELF_R_AARCH64_CONDBR19, name = "CONDBR19" }, Elf_Config_UInt { value = ELF_R_AARCH64_JUMP26, name = "JUMP26" }, Elf_Config_UInt { value = ELF_R_AARCH64_CALL26, name = "CALL26" }, Elf_Config_UInt { value = ELF_R_AARCH64_LDST16_ABS_LO12_NC, name = "LDST16_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_LDST32_ABS_LO12_NC, name = "LDST32_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_LDST64_ABS_LO12_NC, name = "LDST64_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G0, name = "MOVW_PREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G0_NC, name = "MOVW_PREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G1, name = "MOVW_PREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G1_NC, name = "MOVW_PREL_G1_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G2, name = "MOVW_PREL_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G2_NC, name = "MOVW_PREL_G2_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_PREL_G3, name = "MOVW_PREL_G3" }, Elf_Config_UInt { value = ELF_R_AARCH64_LDST128_ABS_LO12_NC, name = "LDST128_ABS_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G0, name = "MOVW_GOTOFF_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G0_NC, name = "MOVW_GOTOFF_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G1, name = "MOVW_GOTOFF_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G1_NC, name = "MOVW_GOTOFF_G1_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G2, name = "MOVW_GOTOFF_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G2_NC, name = "MOVW_GOTOFF_G2_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_MOVW_GOTOFF_G3, name = "MOVW_GOTOFF_G3" }, Elf_Config_UInt { value = ELF_R_AARCH64_GOTREL64, name = "GOTREL64" }, Elf_Config_UInt { value = ELF_R_AARCH64_GOTREL32, name = "GOTREL32" }, Elf_Config_UInt { value = ELF_R_AARCH64_GOT_LD_PREL19, name = "GOT_LD_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_LD64_GOTOFF_LO15, name = "LD64_GOTOFF_LO15" }, Elf_Config_UInt { value = ELF_R_AARCH64_ADR_GOT_PAGE, name = "ADR_GOT_PAGE" }, Elf_Config_UInt { value = ELF_R_AARCH64_LD64_GOT_LO12_NC, name = "LD64_GOT_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_LD64_GOTPAGE_LO15, name = "LD64_GOTPAGE_LO15" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSGD_ADR_PREL21, name = "TLSGD_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSGD_ADR_PAGE21, name = "TLSGD_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSGD_ADD_LO12_NC, name = "TLSGD_ADD_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSGD_MOVW_G1, name = "TLSGD_MOVW_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSGD_MOVW_G0_NC, name = "TLSGD_MOVW_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADR_PREL21, name = "TLSLD_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADR_PAGE21, name = "TLSLD_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADD_LO12_NC, name = "TLSLD_ADD_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_G1, name = "TLSLD_MOVW_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_G0_NC, name = "TLSLD_MOVW_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LD_PREL19, name = "TLSLD_LD_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G2, name = "TLSLD_MOVW_DTPREL_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G1, name = "TLSLD_MOVW_DTPREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G1_NC, name = "TLSLD_MOVW_DTPREL_G1_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G0, name = "TLSLD_MOVW_DTPREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_MOVW_DTPREL_G0_NC, name = "TLSLD_MOVW_DTPREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADD_DTPREL_HI12, name = "TLSLD_ADD_DTPREL_HI12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADD_DTPREL_LO12, name = "TLSLD_ADD_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_ADD_DTPREL_LO12_NC, name = "TLSLD_ADD_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST8_DTPREL_LO12, name = "TLSLD_LDST8_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST8_DTPREL_LO12_NC, name = "TLSLD_LDST8_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST16_DTPREL_LO12, name = "TLSLD_LDST16_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST16_DTPREL_LO12_NC, name = "TLSLD_LDST16_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST32_DTPREL_LO12, name = "TLSLD_LDST32_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST32_DTPREL_LO12_NC, name = "TLSLD_LDST32_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST64_DTPREL_LO12, name = "TLSLD_LDST64_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST64_DTPREL_LO12_NC, name = "TLSLD_LDST64_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSIE_MOVW_GOTTPREL_G1, name = "TLSIE_MOVW_GOTTPREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSIE_MOVW_GOTTPREL_G0_NC, name = "TLSIE_MOVW_GOTTPREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSIE_ADR_GOTTPREL_PAGE21, name = "TLSIE_ADR_GOTTPREL_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSIE_LD64_GOTTPREL_LO12_NC, name = "TLSIE_LD64_GOTTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSIE_LD_GOTTPREL_PREL19, name = "TLSIE_LD_GOTTPREL_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_MOVW_TPREL_G2, name = "TLSLE_MOVW_TPREL_G2" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_MOVW_TPREL_G1, name = "TLSLE_MOVW_TPREL_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_MOVW_TPREL_G1_NC, name = "TLSLE_MOVW_TPREL_G1_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_MOVW_TPREL_G0, name = "TLSLE_MOVW_TPREL_G0" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_MOVW_TPREL_G0_NC, name = "TLSLE_MOVW_TPREL_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_ADD_TPREL_HI12, name = "TLSLE_ADD_TPREL_HI12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_ADD_TPREL_LO12, name = "TLSLE_ADD_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_ADD_TPREL_LO12_NC, name = "TLSLE_ADD_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST8_TPREL_LO12, name = "TLSLE_LDST8_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST8_TPREL_LO12_NC, name = "TLSLE_LDST8_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST16_TPREL_LO12, name = "TLSLE_LDST16_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST16_TPREL_LO12_NC, name = "TLSLE_LDST16_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST32_TPREL_LO12, name = "TLSLE_LDST32_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST32_TPREL_LO12_NC, name = "TLSLE_LDST32_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST64_TPREL_LO12, name = "TLSLE_LDST64_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST64_TPREL_LO12_NC, name = "TLSLE_LDST64_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_LD_PREL19, name = "TLSDESC_LD_PREL19" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_ADR_PREL21, name = "TLSDESC_ADR_PREL21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_ADR_PAGE21, name = "TLSDESC_ADR_PAGE21" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_LD64_LO12, name = "TLSDESC_LD64_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_ADD_LO12, name = "TLSDESC_ADD_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_OFF_G1, name = "TLSDESC_OFF_G1" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_OFF_G0_NC, name = "TLSDESC_OFF_G0_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_LDR, name = "TLSDESC_LDR" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_ADD, name = "TLSDESC_ADD" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC_CALL, name = "TLSDESC_CALL" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST128_TPREL_LO12, name = "TLSLE_LDST128_TPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLE_LDST128_TPREL_LO12_NC, name = "TLSLE_LDST128_TPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST128_DTPREL_LO12, name = "TLSLD_LDST128_DTPREL_LO12" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSLD_LDST128_DTPREL_LO12_NC, name = "TLSLD_LDST128_DTPREL_LO12_NC" }, Elf_Config_UInt { value = ELF_R_AARCH64_COPY, name = "COPY" }, Elf_Config_UInt { value = ELF_R_AARCH64_GLOB_DAT, name = "GLOB_DAT" }, Elf_Config_UInt { value = ELF_R_AARCH64_JUMP_SLOT, name = "JUMP_SLOT" }, Elf_Config_UInt { value = ELF_R_AARCH64_RELATIVE, name = "RELATIVE" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_DTPMOD64, name = "TLS_DTPMOD64" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_DTPREL64, name = "TLS_DTPREL64" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_TPREL64, name = "TLS_TPREL64" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_DTPMOD, name = "TLS_DTPMOD" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_DTPREL, name = "TLS_DTPREL" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLS_TPREL, name = "TLS_TPREL" }, Elf_Config_UInt { value = ELF_R_AARCH64_TLSDESC, name = "TLSDESC" }, Elf_Config_UInt { value = ELF_R_AARCH64_IRELATIVE, name = "IRELATIVE" }];