Class: Bake::Blocks::Compile

Inherits:
BlockBase show all
Defined in:
lib/blocks/compile.rb

Direct Known Subclasses

Convert, Lint

Instance Attribute Summary collapse

Attributes inherited from BlockBase

#tcs

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BlockBase

#calcOutputDir, #check_config_file, #config_changed?, #defaultToolchainTime, isCmdLineEqual?, prepareOutput, #printCmd, #process_console_output, #process_result, writeCmdLineFile

Constructor Details

#initialize(block, config, referencedConfigs, tcs) ⇒ Compile

Returns a new instance of Compile.



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/blocks/compile.rb', line 16

def initialize(block, config, referencedConfigs, tcs)
  super(block, config, referencedConfigs, tcs)
  @objects = []
  @object_files = {}
  
  calcFileTcs
  calcIncludes
  calcDefines # not for files with changed tcs

  calcFlags   # not for files with changed tcs

end

Instance Attribute Details

#include_list ⇒ Object (readonly)

Returns the value of attribute include_list.



14
15
16
 
# File 'lib/blocks/compile.rb', line 14

def include_list
  @include_list
end

#objects ⇒ Object (readonly)

Returns the value of attribute objects.



14
15
16
 
# File 'lib/blocks/compile.rb', line 14

def objects
  @objects
end

Class Method Details

.read_depfile(dep_filename, projDir, singeLine) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/blocks/compile.rb', line 201

def self.read_depfile(dep_filename, projDir, singeLine)
  deps = []
  begin
    if singeLine
      File.readlines(dep_filename).each do |line|
        splitted = line.split(": ")
        deps << splitted[1].gsub(/[\\]/,'/') if splitted.length > 1
      end
    else          
      deps_string = File.read(dep_filename)
      deps_string = deps_string.gsub(/\\\n/,'')
      dep_splitted = deps_string.split(/([^\\]) /).each_slice(2).map(&:join)[2..-1]
      deps = dep_splitted.map { |d| d.gsub(/[\\] /,' ').gsub(/[\\]/,'/').strip }.delete_if {|d| d == "" }
    end
  rescue Exception
    Bake.formatter.printWarning("Could not read '#{dep_filename}'", projDir)
    return nil
  end
  deps
end

.write_depfile(deps, dep_filename_conv) ⇒ Object

todo: move to toolchain util file



223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/blocks/compile.rb', line 223

def self.write_depfile(deps, dep_filename_conv)
  if deps
    begin
      File.open(dep_filename_conv, 'wb') do |f|
        deps.each do |dep|
          f.puts(dep)
        end
      end
    rescue Exception
      Bake.formatter.printWarning("Could not write '#{dep_filename_conv}'", projDir)
      return nil
    end
  end
end

Instance Method Details

#calcCmdlineFile(object) ⇒ Object 



82
83
84
 
# File 'lib/blocks/compile.rb', line 82

def calcCmdlineFile(object)
  object[0..-3] + ".cmdline"
end

#calcDefines ⇒ Object 



424
425
426
427
428
429
 
# File 'lib/blocks/compile.rb', line 424

def calcDefines
  @define_array = {}
  [:CPP, :C, :ASM].each do |type|
    @define_array[type] = getDefines(@tcs[:COMPILER][type])
  end
end

#calcDepFile(object, type) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/blocks/compile.rb', line 86

def calcDepFile(object, type)
  dep_filename = nil
  if type != :ASM
    dep_filename = object[0..-3] + ".d"
  end
  dep_filename
end

#calcDepFileConv(dep_filename) ⇒ Object 



94
95
96
 
# File 'lib/blocks/compile.rb', line 94

def calcDepFileConv(dep_filename)
  dep_filename + ".bake"
end

#calcFileTcs ⇒ Object 



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/blocks/compile.rb', line 437

def calcFileTcs
  @fileTcs = {}
  @config.files.each do |f|
    if (f.define.length > 0 or f.flags.length > 0)
      if f.name.include?"*"
        Bake.formatter.printWarning("Toolchain settings not allowed for file pattern #{f.name}", f)
        err_res = ErrorDesc.new
        err_res.file_name = @config.file_name
        err_res.line_number = f.line_number
        err_res.severity = ErrorParser::SEVERITY_WARNING
        err_res.message = "Toolchain settings not allowed for file patterns"
        Bake::IDEInterface.instance.set_errors([err_res])                
      else
        @fileTcs[f.name] = integrateCompilerFile(Utils.deep_copy(@tcs),f)
      end
    end
  end
end

#calcFlags ⇒ Object 



430
431
432
433
434
435
 
# File 'lib/blocks/compile.rb', line 430

def calcFlags
  @flag_array = {}
  [:CPP, :C, :ASM].each do |type|
    @flag_array[type] = getFlags(@tcs[:COMPILER][type])
  end
end

#calcIncludes ⇒ Object 



405
406
407
408
409
410
411
412
413
414
 
# File 'lib/blocks/compile.rb', line 405

def calcIncludes
  @include_list = @config.includeDir.uniq.map do |dir|
    (dir.name == "___ROOTS___") ? (Bake.options.roots.map { |r| File.rel_from_to_project(@projectDir,r,false) }) : @block.convPath(dir)
  end.flatten.uniq
  
  @include_array = {}
  [:CPP, :C, :ASM].each do |type|
    @include_array[type] = @include_list.map {|k| "#{@tcs[:COMPILER][type][:INCLUDE_PATH_FLAG]}#{k}"}
  end
end

#calcObjects ⇒ Object 



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/blocks/compile.rb', line 335

def calcObjects
  @source_files.each do |source|
    type = get_source_type(source)
    if not type.nil?
      object = get_object_file(source)
      @object_files[source] = object
      @objects << object
    end
  end
end

#calcSources(cleaning = false) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/blocks/compile.rb', line 346

def calcSources(cleaning = false)
  @source_files = []
    
  exclude_files = Set.new
  @config.excludeFiles.each do |p|
    Dir.glob(p.name).each {|f| exclude_files << f}
  end
    
  source_files = Set.new
  @config.files.each do |sources|
    p = sources.name
    res = Dir.glob(p).sort
    if res.length == 0 and cleaning == false
      if not p.include?"*" and not p.include?"?"
        Bake.formatter.printError("Source file '#{p}' not found", sources)
        raise SystemCommandFailed.new  
      elsif Bake.options.verbose >= 1
        Bake.formatter.printInfo("Source file pattern '#{p}' does not match to any file", sources)
      end
    end
    res.each do |f|
      next if exclude_files.include?(f)
      source_files << f
    end
  end
  
  if Bake.options.filename
    source_files.keep_if do |source|
      source.include?Bake.options.filename
    end
    if source_files.length == 0 and cleaning == false
      Bake.formatter.printInfo("#{Bake.options.filename} does not match to any source", @config)
    end
  end
  
  @source_files = source_files.sort.to_a
  
  if Bake.options.eclipseOrder # directories reverse order, files in directories in alphabetical order

    dirs = []
    filemap = {}
    @source_files.reverse.each do |o|
      d = File.dirname(o)
      if filemap.include?(d)
        filemap[d] << o
      else
        filemap[d] = [o]
        dirs << d
      end
    end
    @source_files = []
    dirs.each do |d|
      filemap[d].reverse.each do |f|
        @source_files << f
      end
    end
  end
  
end

#clean ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/blocks/compile.rb', line 304

def clean
  if Bake.options.filename or Bake.options.analyze
    Dir.chdir(@projectDir) do
      calcSources(true)
      @source_files.each do |source|
        
        type = get_source_type(source)
        next if type.nil?
        object = get_object_file(source)
        if File.exist?object 
          puts "Deleting file #{object}" if Bake.options.verbose >= 2
          FileUtils.rm_rf(object)
        end
        if not Bake.options.analyze
          dep_filename = calcDepFile(object, type)
          if dep_filename and File.exist?dep_filename 
            puts "Deleting file #{dep_filename}" if Bake.options.verbose >= 2
            FileUtils.rm_rf(dep_filename)
          end
          cmdLineFile = calcCmdlineFile(object)
          if File.exist?cmdLineFile 
            puts "Deleting file #{cmdLineFile}" if Bake.options.verbose >= 2
            FileUtils.rm_rf(cmdLineFile)
          end
        end
      end
    end
  end
  return true
end

#compileFile(source) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/blocks/compile.rb', line 106

def compileFile(source)
  type = get_source_type(source)
  return true if type.nil?
  
  object = @object_files[source]
  
  dep_filename = calcDepFile(object, type)
  dep_filename_conv = calcDepFileConv(dep_filename) if type != :ASM
  
  cmdLineCheck = false
  cmdLineFile = calcCmdlineFile(object)
  return true unless maybe_needed?(source, object, type, dep_filename_conv)

  reason = needed?(source, object, type, dep_filename_conv)
  if not reason
    cmdLineCheck = true
    reason = config_changed?(cmdLineFile)
  end
  return true unless reason

  if @fileTcs.include?(source)
    compiler = @fileTcs[source][:COMPILER][type]
    defines = getDefines(compiler)
    flags = getFlags(compiler)
  else
    compiler = @tcs[:COMPILER][type]
    defines = @define_array[type]
    flags = @flag_array[type]
  end
  includes = @include_array[type]

  if Bake.options.prepro and compiler[:PREPRO_FLAGS] == "" 
    Bake.formatter.printError("Error: No preprocessor option available for " + source)
    raise SystemCommandFailed.new 
  end
             
  cmd = Utils.flagSplit(compiler[:COMMAND], false)
  cmd += compiler[:COMPILE_FLAGS].split(" ")
    
  if dep_filename
    cmd += @tcs[:COMPILER][type][:DEP_FLAGS].split(" ")
    if @tcs[:COMPILER][type][:DEP_FLAGS_FILENAME]
      if @tcs[:COMPILER][type][:DEP_FLAGS_SPACE]
        cmd << dep_filename
      else
        if dep_filename.include?" "
          cmd[cmd.length-1] << "\"" + dep_filename + "\""
        else
          cmd[cmd.length-1] << dep_filename
        end
        
      end
    end
  end
       
  cmd += compiler[:PREPRO_FLAGS].split(" ") if Bake.options.prepro
  cmd += flags
  cmd += includes
  cmd += defines
  
  offlag = compiler[:OBJECT_FILE_FLAG]       
  offlag = compiler[:PREPRO_FILE_FLAG] if compiler[:PREPRO_FILE_FLAG] and Bake.options.prepro

  if compiler[:OBJ_FLAG_SPACE]
    cmd << offlag
    cmd << object
  else
    if object.include?" "
      cmd << offlag + "\"" + object + "\"" 
    else
      cmd << offlag + object
    end
  end
  cmd << source

  if Bake.options.cc2j_filename
    Blocks::CC2J << { :directory => @projectDir, :command => cmd, :file => source }
  end
  
  return true if cmdLineCheck and BlockBase.isCmdLineEqual?(cmd, cmdLineFile)
  
  BlockBase.prepareOutput(object)
  BlockBase.writeCmdLineFile(cmd, cmdLineFile)
  success, consoleOutput = ProcessHelper.run(cmd, false, false)
  
  outputType = Bake.options.analyze ? "Analyzing" : (Bake.options.prepro ? "Preprocessing" : "Compiling")
  incList = process_result(cmd, consoleOutput, compiler[:ERROR_PARSER], "#{outputType} #{source}", reason, success)
   
  if type != :ASM and not Bake.options.analyze and not Bake.options.prepro
    incList = Compile.read_depfile(dep_filename, @projectDir, @tcs[:COMPILER][:DEP_FILE_SINGLE_LINE]) if incList.nil?
    Compile.write_depfile(incList, dep_filename_conv) 
  end
  check_config_file
end

#execute ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/blocks/compile.rb', line 242

def execute
  Dir.chdir(@projectDir) do
  
    calcSources
    calcObjects
    
    @error_strings = {}
    
    compileJobs = Multithread::Jobs.new(@source_files) do |jobs|
      while source = jobs.get_next_or_nil do
        
        if (jobs.failed and Bake.options.stopOnFirstError) or Bake::IDEInterface.instance.get_abort
          break
        end
        
        s = StringIO.new
        tmp = Thread.current[:stdout]
        Thread.current[:stdout] = s unless tmp
            
        result = false
        begin
          compileFile(source)
          result = true
        rescue Bake::SystemCommandFailed => scf # normal compilation error

        rescue SystemExit => exSys
        rescue Exception => ex1
          if not Bake::IDEInterface.instance.get_abort
            Bake.formatter.printError("Error: #{ex1.message}")
            puts ex1.backtrace if Bake.options.debug
          end
        end 
        
        jobs.set_failed if not result
          
        Thread.current[:stdout] = tmp
            
        mutex.synchronize do
          if s.string.length > 0 
            if Bake.options.stopOnFirstError and not result
              @error_strings[source] = s.string
            else
              puts s.string
            end
          end
        end                  
            
      end
    end
    compileJobs.join

    # can only happen in case of bail_on_first_error.

    # if not sorted, it may be confusing when builing more than once and the order of the error appearances changes from build to build

    # (it is not deterministic which file compilation finishes first)

    @error_strings.sort.each {|es| puts es[1]}
                
    raise SystemCommandFailed.new if compileJobs.failed
    
    
  end
  return true
end

#get_object_file(source) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/blocks/compile.rb', line 27

def get_object_file(source)

  # until now all OBJECT_FILE_ENDING are equal in all three types

  adaptedSource = source.chomp(File.extname(source)).gsub(/\.\./, "##") + (Bake.options.prepro ? ".i" : @tcs[:COMPILER][:CPP][:OBJECT_FILE_ENDING])
  return adaptedSource if File.is_absolute?source
  File.join([@output_dir, adaptedSource])
end

#get_source_type(source) ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/blocks/compile.rb', line 98

def get_source_type(source)
  ex = File.extname(source)
  [:CPP, :C, :ASM].each do |t|
    return t if @tcs[:COMPILER][t][:SOURCE_FILE_ENDINGS].include?(ex)
  end
  nil
end

#getDefines(compiler) ⇒ Object 



416
417
418
 
# File 'lib/blocks/compile.rb', line 416

def getDefines(compiler)
  compiler[:DEFINES].map {|k| "#{compiler[:DEFINE_FLAG]}#{k}"}
end

#getFlags(compiler) ⇒ Object 



420
421
422
 
# File 'lib/blocks/compile.rb', line 420

def getFlags(compiler)
  Bake::Utils::flagSplit(compiler[:FLAGS],true)
end

#maybe_needed?(source, object, type, dep_filename_conv) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
 
# File 'lib/blocks/compile.rb', line 35

def maybe_needed?(source, object, type, dep_filename_conv)
  return false if Bake.options.linkOnly
  return false if Bake.options.prepro and type == ASM
  return true
end

#mutex ⇒ Object 



238
239
240
 
# File 'lib/blocks/compile.rb', line 238

def mutex
  @mutex ||= Mutex.new
end

#needed?(source, object, type, dep_filename_conv) ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/blocks/compile.rb', line 41

def needed?(source, object, type, dep_filename_conv)
  return "because analyzer toolchain is configured" if Bake.options.analyze
  return "because prepro was specified and source is no assembler file" if Bake.options.prepro 
  
  return "because object does not exist" if not File.exist?(object)
  oTime = File.mtime(object)
  
  return "because source is newer than object" if oTime < File.mtime(source)
  
  if type != :ASM
    return "because dependency file does not exist" if not File.exist?(dep_filename_conv)
    
    begin
      File.readlines(dep_filename_conv).map{|line| line.strip}.each do |dep|
        if not File.exist?(dep)
          # we need a hack here. with some windows configurations the compiler prints unix paths

          # into the dep file which cannot be found easily. this will be true for system includes,

          # e.g. /usr/lib/...xy.h

          if (Bake::Utils::OS.windows? and dep.start_with?"/") or
            (not Bake::Utils::OS.windows? and dep.length > 1 and dep[1] == ":")
            puts "Dependency header file #{dep} ignored!" if Bake.options.debug
          else
            return "because dependent header #{dep} does not exist"
          end
        else
          return "because dependent header #{dep} is newer than object" if oTime < File.mtime(dep)
        end
      end
    rescue Exception => ex
      if Bake.options.debug
        puts "While reading #{dep_filename_conv}:"
        puts ex.message
        puts ex.backtrace 
      end
      return "because dependency file could not be loaded"
    end
  end
  
  false
end

#tcs4source(source) ⇒ Object 



456
457
458
 
# File 'lib/blocks/compile.rb', line 456

def tcs4source(source)
  @fileTcs[source] || @tcs
end