SPVMCC(1)

📦 version 0.990125, in alpine 3.24

✨ Name ✨

spvmcc(1) — User Contributed Perl Documentation. Okay bestie, this page is about spvmcc — Generating Excutable File (that’s the manual’s spelling, not me being chaotic 💀). It’s the command that turns SPVM classes into an executable file, and it’s giving build-system main character energy.

💖 Description 💖

The spvmcc command generates an executable file from SPVM classes. No cap, that’s the whole vibe: you feed it SPVM stuff, it gives you an executable.

🌸 Usage 🌸

Usage: spvmcc [OPTIONS] SCRIPT_NAME

  spvmcc -o myapp myapp.spvm

  spvmcc -I lib/SPVM -o myapp myapp.spvm

Now the option menu, one bullet per option so nobody gets lost in the sauce 💅

💅 Options 💅

  • -h, --help — shows this message.
  • -v, --version — shows the version.
  • -o, --output FILE — the output file name.
  • -I DIR — adds a include directory.
  • -B, --build-dir DIR — build directory.
  • -q, --quiet — stops the output of messages.
  • -f, --force — forces the compile and link.
  • --no-config — no configration file is ok.
  • -m, --mode MODE — config mode.
  • -w — enables warning flag.
  • -Mblib — same as "-Mblib" in perl.
  • --ccflag VALUE — compiler flag.
  • --ccflag-spvm VALUE — same as --ccflag, but only SPVM core source files and a bootstrap file.
  • --ccflag-native VALUE — same as --ccflag, but only native class source files and native source files.
  • --ccflag-native-class CLASS_NAME@VALUE — same as --ccflag-native, but only a class.
  • --ccflag-precompile VALUE — same as --ccflag, but only precompile class source files.
  • --define VALUE — same as --ccflag, but -D is prefixed.
  • --define-spvm VALUE — same as --define, but only SPVM core source files and a bootstrap file.
  • --define-native VALUE — same as --define, but only native class source files and native source files.
  • --define-native-class CLASS_NAME@VALUE — same as --define-native, but only a class.
  • --define-precompile VALUE — same as --define, but only precompile class source files.
  • --optimize LEVEL — optimization level such as "-O3", "-O0 -g".
  • --optimize-spvm LEVEL — same as --optimize, but only SPVM core source files and a bootstrap file.
  • --optimize-native LEVEL — same as --optimize, but only native class source files and native source files.
  • --optimize-native-class CLASS_NAME@LEVEL — same as --optimize-native, but only a class.
  • --optimize-precompile LEVEL — same as --optimize, but only precompile class source files.
  • --include-dir DIR — same as --ccflag, but -I is prefixed.
  • --include-dir-spvm DIR — same as --include-dir, but only SPVM core source files and a bootstrap file.
  • --include-dir-native DIR — same as --include-dir, but only native class source files and native source files.
  • --include-dir-native-class CLASS_NAME@DIR — same as --include-dir-native, but only a class.
  • --include-dir-precompile DIR — same as --include-dir, but only precompile class source files.
  • --build-spvm-archive — generate an SPVM archive.

🦋 Details 🦋

👑 spvmcc Command 👑

spvmcc [OPTIONS] SCRIPT_NAME

The spvmcc command generates an executable file from SPVM classes.

OPTIONS are options. Iconic, honestly.

SCRIPT_NAME is a script path that contains an SPVM script.

# myapp.spvm
use Fn;
my $var = 1;
say $var;

Anon class that contains a bootstrap method is allowed as an SPVM script.

# myapp.spvm
class {

  version "1.001";

  our $FOO : int;

  use Fn;

  static method main : void () {
    my $var = 1;
    say $var;
  }
}

The base name of SCRIPT_NAME must be a Script Base Name. Otherwise an exception is thrown. Periodt.

See Class Search Directories about default class search directories.

See SPVM::Document::EnvironmentVariables about available environment variables.

🎀 Config File for Executable File 🎀

A config file that corresponding to the script name must exist for an executable file, except for the case that --no-config is specified.

The config for an executable file is a SPVM::Builder::Config::Exe object.

"myapp.config":

use SPVM::Builder::Config::Exe;

my $exe_config = SPVM::Builder::Config::Exe->new;

$exe_config

🍓 Caching System 🍓

Compiled object files and an executable file are not rebuilt unless they need to be rebuilt.

--force option forces the rebuild. Not me having to poke it manually unless you pass that flag, iykyk.

🧚 Resources 🧚

bestie, this is the part where resources are not automatically compiled. Read it twice, fr fr.

There are important points to be aware of when generating executable files. That is, resources are not automatically compiled.

When you run an SPVM program with the spvm command, the resources are contained within the shared library of each class. Therefore, there are no conflicts between resources.

However, in the case of executable files, there are resource conflicts. For this, the resources must be resolved manually in the configuration file.

$config->use_resource('Resource::Zlib');

This is hard work, but given that the executable file must be compiled from source files and run on a variety of platforms, I think that solving it manually is a better way.

I have published a command that allows you to view the list of classes using resources and the resource settings.

See also --resource-info option in spvmdeps command to dump resource information.

🌈 lib Directive 🌈

If the source code specified by SCRIPT_NAME contains lib directives, the directories specified by lib directive is prepended to class search directories.

#lib "$FindBin::Bin/lib"

This directories specified by lib directive is placed after the directories specified by --include-dir option.

⭐ SPVM Archive ⭐

An SPVM archive is a tarball (.tar.gz) containing SPVM class files and object files generated from native classes, precompilation classes, and resource classes.

spvmcc.json in an SPVM archive has archive information. This contains the application name, the mode, the version and class information.

The recommended file extension is .spvm-archive.tar.gz.

An SPVM archive does not contains external object files (.o), static library files (.a), dynamic library files (.so, .dll, etc), and SPVM anon class files.

An SPVM archive can be created by --build-spvm-archive option.

spvmcc --build-spvm-archive -o $exe_dir/myapp.spvm-archive.tar.gz myapp.spvm

An SPVM archive can be load by load_spvm_archive in SPVM::Builder::Config::Exe method.

By loading an SPVM archive, you can load its classes, and its object files are linked.

If an SPVM archive is loaded and --build-spvm-archive option is specified, the current application information is merged with the SPVM archive information, and then the merged SPVM archive is output.

✨ OPTIONS ✨

Okay bestie, buckle up — there are a lot of flags here, but honestly? They're organized. Slay. 💅 Let's go.

  • --help — shows you help. literally just check out --help in spvm, that's where the whole explanation lives 🫶
  • -h — the short version, -h. same deal: see -h in spvm 💖
  • --version — prints the version. see --version in spvm, no cap ✨
  • -v — smol version of the above, -v. see -v in spvm 🌸
  • -I — used as -I DIR. see -I in spvm for the full tea 🍓
  • --build-dir — used as --build-dir DIR. see --build-dir in spvm 💜
  • -B — used as -B DIR. see -B in spvm 🦋
  • -w — just -w. see -w in spvm, mwah 😌
  • -Mblib — literally -Mblib. see -Mblib in spvm 🎀
  • --output — takes --output FILE and sets the output file path to FILE. and bestie, this output file is an executable file 👑
  • -o — takes -o FILE. it's the exact same thing as --output, just shorter ✨
  • --quiet — shuts up the messages coming from the spvmcc command. peace and quiet, we love to see it 🤫
  • -q — -q. same as --quiet, periodt 💅
  • --force — forces a rebuild of object files and an executable file. like "idc if nothing changed, build it again" energy 🔥
  • -f — -f. same as --force, fr fr 💀
  • --no-config — if you specify this and a config file does not exist, the spvmcc command runs without finishing the program 🙈
  • --mode — takes --mode MODE and specifies the config mode MODE. check the Config Mode section for what the modes actually are, iykyk 🌈
  • -m — takes -m MODE. same as --mode 🫶
  • --ccflag — takes --ccflag VALUE, a compiler flag. this one affects all source files. and yes, you can repeat this option as many times as you want ⭐
  • --ccflag-spvm — takes --ccflag-spvm VALUE, a compiler flag. this affects SPVM core source files and a bootstrap file. repeatable too 💖
  • --ccflag-native — takes --ccflag-native VALUE, a compiler flag. this affects native class source files (such as MyClass.c) and native source files (such as MyClass.native/src/foo). repeat it all you like 🦋
  • --ccflag-native-class — takes --ccflag-native-class CLASS_NAME@VALUE, a compiler flag. this affects a native class source file specified by CLASS_NAME (such as MyClass.c) and its native source files (such as MyClass.native/src/foo). repeatable ✨

example, bestie:

--ccflag-native-class MyClass@-Wall
  • --ccflag-precompile — takes --ccflag-precompile VALUE, a compiler flag. this affects precompile class source files. repeatable 🎀
  • --define — takes --define VALUE. it's a compiler flag, but with -D prefixed onto it. this affects all source files. repeatable 💜
  • --define-spvm — takes --define-spvm VALUE. compiler flag with -D prefixed. this affects SPVM core source files and a bootstrap file. repeatable 🌸
  • --define-native — takes --define-native CLASS_NAME@VALUE. compiler flag with -D prefixed. this affects native class source files (such as MyClass.c) and native source files (such as MyClass.native/src/foo). repeatable 🍓
  • --define-native-class — takes --define-native-class VALUE. compiler flag with -D prefixed. this affects a native class source file specified by CLASS_NAME (such as MyClass.c) and its native source files (such as MyClass.native/src/foo). repeatable 🔥

example:

# Expanded to -DDEBUG_MEMORY
--define-native-class MyClass@DEBUG_MEMORY
  • --define-precompile — takes --define-precompile VALUE. compiler flag with -D prefixed. this affects precompile class source files. repeatable 🧚
  • --optimize — takes --optimize LEVEL, an optimization level. affects all source files 🌈

example:

--optimize "-O0 -g"
  • --optimize-spvm — takes --optimize-spvm LEVEL, an optimization level. this affects SPVM core source files and a bootstrap file ⭐
  • --optimize-native — takes --optimize-native LEVEL, an optimization level. this affects native class source files (such as MyClass.c) and native source files (such as MyClass.native/src/foo) 🦋
  • --optimize-native-class — takes --optimize-native-class LEVEL, an optimization level. this affects a native class source file specified by CLASS_NAME (such as MyClass.c) and its native source files (such as MyClass.native/src/foo). repeatable 💅

example:

--optimize-native-class "MyClass@-O0 -g"
  • --optimize-precompile — takes --optimize-precompile LEVEL, an optimization level. this affects precompile class source files 🎀
  • --include-dir — takes --include-dir DIR. it's a compiler flag, but with -I prefixed. affects all source files. repeatable 💖
  • --include-dir-spvm — takes --include-dir-spvm DIR. compiler flag with -I prefixed. affects SPVM core source files and a bootstrap file. repeatable 🌸
  • --include-dir-native — takes --include-dir-native DIR. compiler flag with -I prefixed. affects native class source files (such as MyClass.c) and native source files (such as MyClass.native/src/foo). repeatable 🍓
  • --include-dir-native-class — takes --include-dir-native-class DIR. compiler flag with -I prefixed. affects a native class source file specified by CLASS_NAME (such as MyClass.c) and its native source files (such as MyClass.native/src/foo). repeatable 🌟

example:

--include-dir-native-class MyClass@/path/foo
  • --include-dir-precompile — takes --include-dir-precompile DIR. compiler flag with -I prefixed. affects precompile class source files. repeatable 🧚
  • --object-file — takes --object-file OBJECT_FILE, an additional object file OBJECT_FILE passed to the linker. repeatable 💜
  • --build-spvm-archive — no value, just the flag. generates an SPVM archive into the path given by the -o option. the recommended file extension for an SPVM archive is a tarball (.spvm-archive.tar.gz) 👑

Copyright 2023 Yuki Kimoto. All Rights Reserved.

MIT License.

okay that's the whole thing, bestie — you're officially a spvmcc girlie now 👑✨ this page is from perl v5.42.2, dated 2026-02-03, and it's SPVMCC(1) if you need to cite your sources 💖 go build something iconic 🎀

📦 where this page comes from