TCustomDefaults class

In unit fpMkUnit

Base class for build system default configurations

Declaration

pascal

TCustomDefaults = class(TPersistent)

Inheritance

TCustomDefaults
TPersistent
TObject

Descends from it: TBasicDefaults TFPCDefaults

Description

TCustomDefaults serves as the base class for managing default configuration settings in the fpmake build system. This abstract class provides a foundation for storing and accessing system-wide defaults and build preferences.

Derived classes extend this base to provide specific configuration management for different aspects of the build system such as compiler settings, paths, and installation options.

Properties

`CompileTarget`	public	Target configuration for compilation
`Target`	public	Build target specification
`OS`	public	Target operating system
`CPU`	public	Target CPU architecture
`SubTarget`	public	Subtarget configuration name
`SourceOS`	public	Source operating system for cross-compilation
`SourceCPU`	public	Source CPU architecture for cross-compilation
`CompilerVersion`	public	Version of the compiler being used
`CompilerDate`	public	Build date of the compiler
`FullCompilerVersion`	public	Full version string of the compiler
`ExplicitOSNone`	public	Whether to explicitly specify no target OS
`BuildString`	public	Build configuration string
`BuildTarget`	public	Build target specification
`BuildOS`	public	Operating system for the build environment
`BuildCPU`	public	CPU architecture for the build environment
`Mode`	public	Build mode configuration
`UnixPaths`	public	Whether to use Unix-style path conventions
`Options`	public	Configuration options for the build
`NoFPCCfg`	public	Whether to ignore FPC configuration files
`ThreadsAmount`	public	Number of threads to use during compilation
`LocalUnitDir`	public	Local directory for compiled units
`GlobalUnitDir`	public	Global directory for compiled units
`UnitOutputDirectory`	public
`SearchPath`	public	Search paths for finding files
`Prefix`	public	Installation prefix directory
`ZipPrefix`	public	Prefix for archive file operations
`BaseInstallDir`	public	Base directory for installations
`UnitInstallDir`	public	Directory for installing unit files
`UnitConfigFilesInstallDir`	public	Directory for installing unit configuration files
`BinInstallDir`	public	Directory for installing binary files
`LibInstallDir`	public	Directory for installing library files
`DocInstallDir`	public	Directory for installing documentation files
`ExamplesInstallDir`	public	Directory for installing example files
`FPDocOutputDir`	public	Output directory for FPDoc documentation
`FPDocOptions`	public	Command line options for FPDoc
`FPUnitSourcePath`	public	Source path for FPUnit testing framework
`Compiler`	public	Compiler executable path and options
`Copy`	public	File copy command and options
`Move`	public	File move command and options
`Remove`	public	File removal command and options
`RemoveDir`	public	Directory removal command and options
`RemoveTree`	public	Directory tree removal command and options
`MkDir`	public	Directory creation command and options
`Archive`	public	Archive creation command and options
`UseEnvironment`	public	Whether to use environment variables
`IgnoreInvalidOptions`	public	Whether to ignore invalid configuration options
`BuildMode`	public	Build mode configuration setting
`SingleFPDocFile`	public	Whether to generate single FPDoc output file
`Namespaces`	public	Whether to use unit namespaces
`InstallExamples`	public	Whether to install example files
`SkipCrossPrograms`	public	Whether to skip cross-compilation programs
`SkipAllPrograms`	public	Whether to skip building all programs

Methods

`RecalcTarget`	protected
`CmdLineOptions`	protected
`Create`	public	Creates a new defaults configuration object
`Destroy`	public	Destroys the defaults object and releases resources
`InitDefaults`	public	Initializes default configuration values
`HaveOptions`	public	Checks if configuration options are available
`AddOption`	public	Adds a configuration option to the defaults
`IsBuildDifferentFromTarget`	public	Checks if build configuration differs from target
`CompilerDefaults`	public	Sets up compiler default configuration
`LocalInit`	public	Initializes configuration from local file
`LoadFromFile`	public	Loads configuration settings from a file
`SaveToFile`	public	Saves configuration settings to a file
`SaveToStream`	public	Saves configuration settings to a stream
`LoadFromStream`	public	Loads configuration settings from a stream

Inherited

From TPersistent (8)

Assign AssignTo DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath GetOwner

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.