types.reef - zygaena/coral

root / src / types.reef
types.reef Reef 400 lines 9.6 KB
/******************************************************************************
               __               ____                __
              / /   ___  ____ _/ __/_____________ _/ /__
             / /   / _ \/ __ `/ /_/ ___/ ___/ __ `/ / _ \
            / /___/  __/ /_/ / __(__  ) /__/ /_/ / /  __/
           /_____/\___/\__,_/_/ /____/\___/\__,_/_/\___/

   (C)opyright 2025, Leafscale, LLC -  https://www.leafscale.com

   Project: Zygaena
  Filename: types.reef
   Authors: Chris Tusa <chris.tusa@leafscale.com>
   License: <see LICENSE file included with this source code>
Description: Shared type definitions for Coral package manager

******************************************************************************/

module types

export
    // Path getter functions (constants can't be exported across modules)
    fn get_ports_dir(): string
    fn get_sources_dir(): string
    fn get_packages_dir(): string
    fn get_build_dir(): string
    fn get_db_dir(): string
    fn get_index_dir(): string
    fn get_repos_dir(): string
    fn get_config_file(): string
    fn get_groups_dir(): string
    // Legacy (for compatibility)
    fn get_work_dir(): string
    fn get_pkg_dir(): string

    // Types
    type PackageInfo
    type Dependencies
    type Source
    type SourceInfo
    type PatchInfo
    type ConfigInfo
    type ScriptsInfo
    type BuildConfig
    type Port
    type InstalledPackage
    type BuildResult
    type GlobalOptions
    type PackageGroup
    type PortResult

    // Factory functions
    fn new_package_info(): PackageInfo
    fn new_dependencies(): Dependencies
    fn new_global_options(): GlobalOptions
    fn new_source(): Source
    fn new_source_info(): SourceInfo
    fn new_patch_info(): PatchInfo
    fn new_config_info(): ConfigInfo
    fn new_scripts_info(): ScriptsInfo
    fn new_build_config(): BuildConfig
    fn new_port(): Port
    fn new_port_result(ok: bool, p: Port, err: string): PortResult
    fn new_installed_package(): InstalledPackage
    fn new_package_group(): PackageGroup
end export

// Zygaena/Coral filesystem paths
// Ports tree and build artifacts
const PORTS_DIR: string = "/usr/zports"
const GROUPS_DIR: string = "/usr/zports/groups"
const SOURCES_DIR: string = "/usr/zports/pkgs/sources"
const PACKAGES_DIR: string = "/usr/zports/pkgs/packages"
const BUILD_DIR: string = "/usr/zports/pkgs/build"

// System state (in /var/lib)
const DB_DIR: string = "/var/lib/coral/installed"
const INDEX_DIR: string = "/var/lib/coral/db"
const REPOS_DIR: string = "/var/lib/coral/repos"

// Configuration
const CONFIG_FILE: string = "/etc/coral/coral.conf"

// Legacy aliases (for compatibility during transition)
const WORK_DIR: string = "/usr/zports/pkgs/build"
const PKG_DIR: string = "/usr/zports/pkgs/build"

// Package metadata from package.toml
type PackageInfo = struct
    name: string
    version: string
    release: int
    description: string
    url: string
    license: string
    maintainer: string
    arch: string
    alternatives: [string]
    alternatives_count: int
    conflicts: [string]
    conflicts_count: int
    runtime_deps: [string]
    build_deps: [string]
    runtime_deps_count: int
    build_deps_count: int
end PackageInfo

// Dependencies
type Dependencies = struct
    runtime: [string]
    build: [string]
    runtime_count: int
    build_count: int
end Dependencies

// Individual source file with mirror support
type Source = struct
    file: string        // Output filename (what to save as)
    urls: [string]      // Mirror URLs (tried in order)
    url_count: int      // Number of URLs
    checksum: string    // SHA256 checksum (or "SKIP")
    extract: bool       // Whether to extract archive (default: true)
end Source

// Collection of source files to download
type SourceInfo = struct
    sources: [Source]   // Array of Source structs
    count: int          // Number of sources
end SourceInfo

// Patch configuration
type PatchInfo = struct
    files: [string]
    strip: int
    count: int
end PatchInfo

// Config file protection
type ConfigInfo = struct
    files: [string]
    count: int
end ConfigInfo

// Install/remove scripts
type ScriptsInfo = struct
    pre_install: string
    post_install: string
    pre_remove: string
    post_remove: string
end ScriptsInfo

// Build configuration
type BuildConfig = struct
    parallel: bool
    jobs: int
end BuildConfig

// Complete port definition
type Port = struct
    info: PackageInfo
    deps: Dependencies
    sources: SourceInfo
    patches: PatchInfo
    config: ConfigInfo
    scripts: ScriptsInfo
    build_cfg: BuildConfig
    port_dir: string
    category: string
    // Per-package path overrides (from package.toml [paths] section)
    prefix: string
    sysconfdir: string
end Port

// Installed package record
type InstalledPackage = struct
    info: PackageInfo
    install_date: string
    install_reason: string
    files: [string]
    files_count: int
end InstalledPackage

// Build result
type BuildResult = struct
    success: bool
    package_path: string
    error_message: string
end BuildResult

// Global CLI options
type GlobalOptions = struct
    yes: bool
    force: bool
    verbose: bool
    dry_run: bool
    quiet: bool
    root: string
    prefix: string
    no_chroot: bool  // --no-chroot-scripts: run maintainer scripts on the host, not chrooted
    cmd_index: int  // Index of the command in args (for subcommand parsing)
end GlobalOptions

// Package group (meta-package)
type PackageGroup = struct
    name: string
    description: string
    members: [string]
    members_count: int
end PackageGroup

// Parse result wrapper
type PortResult = struct
    success: bool
    port: Port
    error: string
end PortResult

// Initialize empty PackageInfo
fn new_package_info(): PackageInfo
    return PackageInfo{
        name: "",
        version: "",
        release: 1,
        description: "",
        url: "",
        license: "",
        maintainer: "",
        arch: "x86_64",
        alternatives: new [string](0),
        alternatives_count: 0,
        conflicts: new [string](0),
        conflicts_count: 0,
        runtime_deps: new [string](64),
        build_deps: new [string](64),
        runtime_deps_count: 0,
        build_deps_count: 0
    }
end new_package_info

// Initialize empty Dependencies
fn new_dependencies(): Dependencies
    return Dependencies{
        runtime: new [string](0),
        build: new [string](0),
        runtime_count: 0,
        build_count: 0
    }
end new_dependencies

// Initialize empty GlobalOptions with defaults
fn new_global_options(): GlobalOptions
    return GlobalOptions{
        yes: false,
        force: false,
        verbose: false,
        dry_run: false,
        quiet: false,
        root: "",
        prefix: "",
        no_chroot: false,
        cmd_index: 1
    }
end new_global_options

// Initialize empty Source
fn new_source(): Source
    return Source{
        file: "",
        urls: new [string](16),
        url_count: 0,
        checksum: "SKIP",
        extract: true
    }
end new_source

// Initialize empty SourceInfo
fn new_source_info(): SourceInfo
    return SourceInfo{
        sources: new [Source](16),
        count: 0
    }
end new_source_info

// Initialize empty PatchInfo
fn new_patch_info(): PatchInfo
    return PatchInfo{
        files: new [string](0),
        strip: 1,
        count: 0
    }
end new_patch_info

// Initialize empty ConfigInfo
fn new_config_info(): ConfigInfo
    return ConfigInfo{
        files: new [string](0),
        count: 0
    }
end new_config_info

// Initialize empty ScriptsInfo
fn new_scripts_info(): ScriptsInfo
    return ScriptsInfo{
        pre_install: "",
        post_install: "",
        pre_remove: "",
        post_remove: ""
    }
end new_scripts_info

// Initialize default BuildConfig
fn new_build_config(): BuildConfig
    return BuildConfig{
        parallel: true,
        jobs: 0
    }
end new_build_config

// Initialize empty Port
fn new_port(): Port
    return Port{
        info: new_package_info(),
        deps: new_dependencies(),
        sources: new_source_info(),
        patches: new_patch_info(),
        config: new_config_info(),
        scripts: new_scripts_info(),
        build_cfg: new_build_config(),
        port_dir: "",
        category: "",
        prefix: "",
        sysconfdir: ""
    }
end new_port

// Create a PortResult
fn new_port_result(ok: bool, p: Port, err: string): PortResult
    return PortResult{
        success: ok,
        port: p,
        error: err
    }
end new_port_result

// Path getter functions
fn get_ports_dir(): string
    return PORTS_DIR
end get_ports_dir

fn get_sources_dir(): string
    return SOURCES_DIR
end get_sources_dir

fn get_packages_dir(): string
    return PACKAGES_DIR
end get_packages_dir

fn get_build_dir(): string
    return BUILD_DIR
end get_build_dir

fn get_db_dir(): string
    return DB_DIR
end get_db_dir

fn get_index_dir(): string
    return INDEX_DIR
end get_index_dir

fn get_repos_dir(): string
    return REPOS_DIR
end get_repos_dir

fn get_config_file(): string
    return CONFIG_FILE
end get_config_file

fn get_groups_dir(): string
    return GROUPS_DIR
end get_groups_dir

// Legacy aliases (for compatibility during transition)
fn get_work_dir(): string
    return BUILD_DIR
end get_work_dir

fn get_pkg_dir(): string
    return BUILD_DIR
end get_pkg_dir

// Initialize empty InstalledPackage
fn new_installed_package(): InstalledPackage
    return InstalledPackage{ info: new_package_info(), install_date: "", install_reason: "", files: new [string](0), files_count: 0 }
end new_installed_package

fn new_package_group(): PackageGroup
    return PackageGroup{ name: "", description: "", members: new [string](256), members_count: 0 }
end new_package_group

end module