Class: Rscons::Builders::Program

Inherits:
Rscons::Builder show all
Defined in:
lib/rscons/builders/program.rb

Overview

A default Rscons builder that knows how to link object files into an executable program.

Instance Method Summary collapse

Methods inherited from Rscons::Builder

#features, #name, #produces?, #standard_build, #standard_finalize, #standard_threaded_build

Instance Method Details

#create_build_target(options) ⇒ BuildTarget

Create a BuildTarget object for this build target.

The build target filename is given a “.exe” suffix if Rscons is executing on a Windows platform and no other suffix is given.

Options Hash (options):

  • :env (Environment)

    The Environment.

  • :target (String)

    The user-supplied target name.

  • :sources (Array<String>)

    The user-supplied source file name(s).


41
42
43
44
45
46
47
48
# File 'lib/rscons/builders/program.rb', line 41

def create_build_target(options)
  env, target, vars = options.values_at(:env, :target, :vars)
  my_options = options.dup
  unless File.basename(target)["."]
    my_options[:target] += env.expand_varref("${PROGSUFFIX}", vars)
  end
  super(my_options)
end

#default_variables(env) ⇒ Hash

Return default construction variables for the builder.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
# File 'lib/rscons/builders/program.rb', line 12

def default_variables(env)
  {
    'OBJSUFFIX' => '.o',
    'PROGSUFFIX' => (Object.const_get("RUBY_PLATFORM") =~ /mingw|cygwin/ ? ".exe" : ""),
    'LD' => nil,
    'LIBSUFFIX' => '.a',
    'LDFLAGS' => [],
    'LIBPATH' => [],
    'LIBDIRPREFIX' => '-L',
    'LIBLINKPREFIX' => '-l',
    'LIBS' => [],
    'LDCMD' => ['${LD}', '-o', '${_TARGET}', '${LDFLAGS}', '${_SOURCES}', '${LIBDIRPREFIX}${LIBPATH}', '${LIBLINKPREFIX}${LIBS}']
  }
end

#finalize(options) ⇒ String?

Finalize a build.


99
100
101
# File 'lib/rscons/builders/program.rb', line 99

def finalize(options)
  standard_finalize(options)
end

#run(options) ⇒ String, false

Run the builder to produce a build target.


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/rscons/builders/program.rb', line 70

def run(options)
  target, sources, cache, env, vars, objects = options.values_at(:target, :sources, :cache, :env, :vars, :setup_info)
  ld = env.expand_varref("${LD}", vars)
  ld = if ld != ""
         ld
       elsif sources.find {|s| s.end_with?(*env.expand_varref("${DSUFFIX}", vars))}
         "${DC}"
       elsif sources.find {|s| s.end_with?(*env.expand_varref("${CXXSUFFIX}", vars))}
         "${CXX}"
       else
         "${CC}"
       end
  vars = vars.merge({
    '_TARGET' => target,
    '_SOURCES' => objects,
    'LD' => ld,
  })
  options[:sources] = objects
  command = env.build_command("${LDCMD}", vars)
  standard_threaded_build("LD #{target}", target, command, objects, env, cache)
end

#setup(options) ⇒ Object

Set up a build operation using this builder.


57
58
59
60
61
62
# File 'lib/rscons/builders/program.rb', line 57

def setup(options)
  target, sources, env, vars = options.values_at(:target, :sources, :env, :vars)
  suffixes = env.expand_varref(["${OBJSUFFIX}", "${LIBSUFFIX}"], vars)
  # Register builders to build each source to an object file or library.
  env.register_builds(target, sources, suffixes, vars)
end