RubyGems - bake-toolkit - Versions diffs - 1.0.27 → 1.1.0 - Mend

bake-toolkit 1.0.27 → 1.1.0

Files changed (13) hide show

data/doc/deployDoc.bat CHANGED Viewed

@@ -1,2 +1,2 @@
-scp -r "./" "aschaal@esrlabs.com:/var/www/esrlabs/wordpress/gems/doc/bake-toolkit/"
+scp -r "./" "aschaal@esrlabs.com:/var/www/esrlabs/wordpress2/gems/doc/bake-toolkit/"
 pause

data/doc/dyk/lint.html ADDED Viewed

@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+<style type="text/css">
+#rundrum {
+  border-width:1px;
+  border-style:dashed;
+  border-color:blue;
+  padding:0.2cm;
+  text-align:justify; }
+}
+</style>
+</head>
+<body>
+<h1>Lint</h1>
+<h3>General</h3>
+bake can be easily used to lint source files:
+<ul>
+	<li>"lint-nt.exe" must be in the path
+	<li>add "--lint" on the command line
+</ul>
+Example:
+<pre id="rundrum"><code>bake Debug -p MyLibraryProject --lint</code></pre>
+<h3>How does it work</h3>
+You can lint LibraryConfigs, ExecutableConfigs and single files, but not the complete workspace. The CPP Toolchain settings
+of the project are used regardless of the file type and file specific options.
+It is possible to specify lnt-files with LintPolicy, but you can add every other lint command line option as well.<br>
+A possible approach is to add global Lint policies in the DefaultToolchain like this:
+<pre id="rundrum"><code>DefaultToolchain GCC {
+  ...
+  LintPolicy "$(ProjectDir)/lint/misra.lnt"
+  LintPolicy "$(ProjectDir)/lint/suppressions.lnt"
+}</code></pre>
+<h3>Notes</h3>
+In rare cases lint has problems if it has to open too many (include) files. If that is the case, use --lint_min and --lint_max command line option of bake. Example:
+<pre id="rundrum"><code>bake Debug -p MyLibraryProject --lint --lint_max 50                (lints the first 51 files)
+bake Debug -p MyLibraryProject --lint --lint_min 51 --lint_max 100 (lints the next 50 files)
+bake Debug -p MyLibraryProject --lint --lint_min 101               (lints the rest of the files)</code></pre>
+<p>
+Lint in bake uses GCC includes to check system include stuff. Therefore it is required to have a working GCC installation.<br>
+But you don't have to use a config with GCC toolchain. Every other toolchain is also valid.
+</body>
+</html>

data/doc/further/change.html CHANGED Viewed

@@ -7,12 +7,17 @@
 <body>
 <h1>Changelog</h1>
+March 14, 2014 - bake-toolkit 1.1.0<br>
+<ul>
+<li><b>Added: Lint support</b>
+<li><b>Added: $(ProjectDir) variable</b>
+</ul>
 March 7, 2014 - bake-toolkit 1.0.27<br>
 <ul>
 <li><b>Cosmetic: some pictures in documentation were missing</b>
 </ul>
 March 5, 2014 - bake-toolkit 1.0.26<br>
 <ul>
 <li><b>Bugfix: in rare cases invalid characters from compiler output were not handled correctly</b>

data/doc/index.html CHANGED Viewed

@@ -56,6 +56,7 @@ bake is used to build software <font color="#009900"><b>fast</b></font> and <fon
 <h3>Did you know?</h3>
 <ul>
+<li><a href="dyk/lint.html">Lint</a>
 <li><a href="dyk/tipps.html">Tipps and Tricks</a>
 </ul>
@@ -71,7 +72,7 @@ bake is used to build software <font color="#009900"><b>fast</b></font> and <fon
 <p>
 <hr>
-<table width="100%" border="0"><tr><td align="left">Described bake-toolkit version: 1.0.27</td><td align="right">March 7, 2014</td></tr></table>
+<table width="100%" border="0"><tr><td align="left">Described bake-toolkit version: 1.1.0</td><td align="right">March 14, 2014</td></tr></table>
 </body>

data/doc/syntax/subst.html CHANGED Viewed

@@ -23,6 +23,7 @@
   <tr><td>$(MainProjectName)</td> <td>bootloader</td></tr>
   <tr><td>$(ConfigName)</td> <td>lib</td></tr>
   <tr><td>$(ProjectName)</td> <td>canDriver</td></tr>
+  <tr><td>$(ProjectDir)</td> <td>C:/Root/MyProject</td></tr>
   <tr><td>$(OutputDir)</td> <td>Debug_bootloader</td></tr>
   <tr><td>$(ArtifactName)</td> <td>bootloader_1.0.elf</td></tr>
   <tr><td>$(ArtifactNameBase)</td> <td>bootloader_1.0</td></tr>

data/doc/syntax/syntax.html CHANGED Viewed

@@ -117,6 +117,7 @@ z-index: 100;
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPrefixFlags()" onMouseout="notip()">LibPrefixFlags</span> &#60;flags&#62;<br>
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> &#60;flags&#62;<br>
 &nbsp; &nbsp; &nbsp; }<br>
+&nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showDefaultLintPolicy()" onMouseout="notip()">LintPolicy</span> &#60;policy&#62;<br>
 &nbsp; &nbsp; }<br></span><br></span>
               <span id="libExe_part"><span class="show" style="background-color:#EEEEEE;">
@@ -143,6 +144,7 @@ z-index: 100;
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPrefixFlags()" onMouseout="notip()">LibPrefixFlags</span> &#60;flags&#62;, add: &#60;flags&#62;, remove: &#60;flags&#62<br>
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> &#60;flags&#62;, add: &#60;flags&#62;, remove: &#60;flags&#62<br>
 &nbsp; &nbsp; &nbsp; }<br>
+&nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLintPolicy()" onMouseout="notip()">LintPolicy</span> &#60;policy&#62;<br>
 &nbsp; &nbsp; }<br></span><br></span>
               <span id="exe_part"><span class="show" style="background-color:#EEEEEE;">
@@ -486,6 +488,10 @@ function showLinker() {
   ddrivetip("Linker", "No","0..1","-","Makes sense only for ExecutableConfigs.")
 }
+function showLintPolicy() {
+  ddrivetip("LintPolicy", "No","0..n","-","lnt-file - but it can be used for any other command line option for Lint.")
+}
 function showDefaultFlags() {
   ddrivetip("Flags", "No","0..n","-","Default flags.")
 }
@@ -506,6 +512,10 @@ function showDefaultLinker() {
   ddrivetip("Linker", "No","0..1","-","Default settings for the linker.")
 }
+function showDefaultLintPolicy() {
+  ddrivetip("LintPolicy", "No","0..n","-","lnt-file - but it can be used for any other command line option for Lint.")
+}
 function showCommand() {
   ddrivetip("command", "No","-","Depending on toolchain, e.g. \"gcc\"","Change command, e.g. \"$(PATH_TO_EXE)/gcc_speciale.exe\"")
 }

data/lib/bake/model/metamodel.rb CHANGED Viewed

@@ -66,17 +66,23 @@ module Cxxproject
         contains_many 'flags', Flags, 'parent'
       end
+      class LintPolicy < ModelElement
+        has_attr 'name', String, :defaultValueLiteral => ""
+      end
       class DefaultToolchain < ModelElement
         has_attr 'basedOn', String, :defaultValueLiteral => ""
         contains_many 'compiler', Compiler, 'parent'
         contains_one 'archiver', Archiver, 'parent'
         contains_one 'linker', Linker, 'parent'
+        contains_many 'lintPolicy', LintPolicy, 'parent'
       end
       class Toolchain < ModelElement
         contains_many 'compiler', Compiler, 'parent'
         contains_one 'archiver', Archiver, 'parent'
         contains_one 'linker', Linker, 'parent'
+        contains_many 'lintPolicy', LintPolicy, 'parent'
       end
       class Person < ModelElement

data/lib/bake/options.rb CHANGED Viewed

@@ -8,8 +8,8 @@ module Cxxproject
   class Options < Parser
     attr_reader :build_config, :main_dir, :project, :filename, :eclipse_version, :alias_filename # String
     attr_reader :roots, :include_filter, :exclude_filter # String List
-    attr_reader :clean, :rebuild, :single, :verbose, :nocache, :color, :show_includes, :linkOnly, :check_uninc, :printLess, :no_autodir, :clobber # Boolean
-    attr_reader :threads, :socket # Fixnum
+    attr_reader :clean, :rebuild, :single, :verbose, :nocache, :color, :show_includes, :linkOnly, :check_uninc, :printLess, :no_autodir, :clobber, :lint, :debug # Boolean
+    attr_reader :threads, :socket, :lint_min, :lint_max # Fixnum
     def initialize(argv)
       super(argv)
@@ -21,6 +21,8 @@ module Cxxproject
       @single = false
       @clean = false
       @clobber = false
+      @lint = false
+      @debug = false
       @rebuild = false
       @verbose = false
       @nocache = false
@@ -31,6 +33,8 @@ module Cxxproject
       @printLess = false
       @no_autodir = false
       @threads = 8
+      @lint_min = -1
+      @lint_max = -1
       @roots = []
       @socket = 0
       @include_filter = []
@@ -54,11 +58,16 @@ module Cxxproject
       add_option(Option.new("--prepro",false)              {     set_prepro                 })
       add_option(Option.new("--link_only",false)           {     set_linkOnly               })
       add_option(Option.new("--no_autodir",false)          {     set_no_autodir             })
+      add_option(Option.new("--lint",false)                {     set_lint                   })
+      add_option(Option.new("--lint_min",true)             { |x| set_lint_min(x)            })
+      add_option(Option.new("--lint_max",true)             { |x| set_lint_max(x)            })
       add_option(Option.new("-v0",false)                   {     set_v(0)                   })
       add_option(Option.new("-v1",false)                   {     set_v(1)                   })
       add_option(Option.new("-v2",false)                   {     set_v(2)                   })
+      add_option(Option.new("--debug",false)               {     set_debug                  })
       add_option(Option.new("--clobber",false)             {     set_clobber                })
       add_option(Option.new("--ignore_cache",false)        {     set_nocache                })
       add_option(Option.new("--threads",true)              { |x| set_threads(x)             })
@@ -95,7 +104,12 @@ module Cxxproject
       puts " --rebuild                Clean before build."
       puts " --clobber                Clean the file/project (same as option -c) AND the bake cache files."
       puts " --prepro                 Stop after preprocessor."
-      puts " --link_only              Only link executable - doesn't update objects and archives or start PreSteps and PostSteps"
+      puts " --link_only              Only link executable - doesn't update objects and archives or start PreSteps and PostSteps."
+      puts " --lint                   Performs Lint checks instead of compiling sources. Works currently only with"
+      puts "                          GCC toolchain in project and file scope."
+      puts " --lint_min <num>         If number of files in a project is too large for lint to handle, it is possible"
+      puts "                          to specify only a part of the file list to lint (default -1)."
+      puts " --lint_max <num>         See above (default -1)."
       puts " --ignore_cache           Rereads the original meta files - usefull if workspace structure has been changed."
       puts " --check_uninc            Checks for unnecessary includes (only done for successful project builds)."
       puts " --threads <num>          Set NUMBER of parallel compiled files (default is 8)."
@@ -121,6 +135,7 @@ module Cxxproject
       set_project(File.basename(@main_dir)) if @project.nil?
       @roots = @def_roots if @roots.length == 0
       Rake::application.max_parallel_tasks = @threads
+      Rake::application.debug = @debug
       if @linkOnly
         if @rebuild
@@ -132,6 +147,22 @@ module Cxxproject
           ExitHelper.exit(1)
         end
       end
+      if @lint and not @single
+        Printer.printError "Error: --lint must be used together with -p and optional with -f"
+        ExitHelper.exit(1)
+      end
+      if @lint and @clean
+        Printer.printError "Error: --lint and -c not allowed (yet)"
+        ExitHelper.exit(1)
+      end
+      if @lint_max >= 0 and @lint_min >= 0 and @lint_max < @lint_min
+        Printer.printError "Error: lint_max must be greater than lint_min"
+        ExitHelper.exit(1)
+      end
     end
     def check_valid_dir(dir)
@@ -214,6 +245,14 @@ module Cxxproject
       @no_autodir = true
     end
+    def set_lint()
+      @lint = true
+    end
+    def set_debug()
+      @debug = true
+    end
     def set_v(num)
       if num == 0
         @printLess = true
@@ -279,10 +318,19 @@ module Cxxproject
         ExitHelper.exit(1)
       end
     end
     def set_socket(num)
       @socket = String === num ? num.to_i : num
     end
+    def set_lint_min(num)
+      @lint_min = String === num ? num.to_i : num
+    end
+    def set_lint_max(num)
+      @lint_max = String === num ? num.to_i : num
+    end
     def printHash(x, level)
       x.each do |k,v|
         if Hash === v

data/lib/bake/subst.rb CHANGED Viewed

@@ -5,6 +5,7 @@ module Cxxproject
     def self.itute(config, projName, options)
       @@configName = config.name
+      @@projDir = config.parent.get_project_dir
       @@projName = projName
       @@options = options
       @@mainProjectName = File::basename(options.main_dir)
@@ -49,6 +50,8 @@ module Cxxproject
            substStr << @@configName
           elsif var == "ProjectName"
             substStr << @@projName
+          elsif var == "ProjectDir"
+            substStr << @@projDir
           elsif var == "OutputDir"
             if @@projName == @@mainProjectName
               substStr << @@options.build_config

data/lib/bake/util.rb CHANGED Viewed

@@ -44,8 +44,14 @@ def integrateToolchain(tcs, toolchain)
   toolchain.compiler.each do |c|
     integrateCompiler(tcs, c, c.ctype)
   end
+  integrateLintPolicy(tcs, toolchain.lintPolicy)
 end
+def integrateLintPolicy(tcs, policies)
+  policies.each do |d|
+    tcs[:LINT_POLICY] << d.name
+  end
+end
 def integrateLinker(tcs, linker)
   return tcs unless linker

data/lib/bake/version.rb CHANGED Viewed

@@ -1,11 +1,11 @@
 module Cxxproject
   class Version
     def self.bake
-      "1.0.27"
+      "1.1.0"
     end
   end
-  expectedCxx = "0.5.71"
+  expectedCxx = "0.5.72"
   expectedRGen = "0.6.0"
   expectedRText = "0.2.0"

data/lib/tocxx.rb CHANGED Viewed

@@ -13,7 +13,7 @@ require 'bake/mergeConfig'
 require 'cxxproject/buildingblocks/module'
 require 'cxxproject/buildingblocks/makefile'
 require 'cxxproject/buildingblocks/executable'
-require 'cxxproject/buildingblocks/source_library'
+require 'cxxproject/buildingblocks/lint'
 require 'cxxproject/buildingblocks/binary_library'
 require 'cxxproject/buildingblocks/custom_building_block'
 require 'cxxproject/buildingblocks/command_line'
@@ -316,9 +316,11 @@ module Cxxproject
             Printer.printError "Error: Main project configuration must contain DefaultToolchain"
             ExitHelper.exit(1)
           else
-            basedOnToolchain = Cxxproject::Toolchain::Provider[config.defaultToolchain.basedOn]
+            basedOn = config.defaultToolchain.basedOn
+            basedOn = "GCC_Lint" if @options.lint
+            basedOnToolchain = Cxxproject::Toolchain::Provider[basedOn]
             if basedOnToolchain == nil
-              Printer.printError "Error: DefaultToolchain based on unknown compiler '#{config.defaultToolchain.basedOn}'"
+              Printer.printError "Error: DefaultToolchain based on unknown compiler '#{basedOn}'"
               ExitHelper.exit(1)
             end
             @defaultToolchain = Utils.deep_copy(basedOnToolchain)
@@ -334,7 +336,8 @@ module Cxxproject
                 @defaultToolchain[:COMPILER][:C][:FLAGS]              == @defaultToolchainCached[:COMPILER][:C][:FLAGS] and
                 @defaultToolchain[:COMPILER][:C][:DEFINES].join("")   == @defaultToolchainCached[:COMPILER][:C][:DEFINES].join("") and
                 @defaultToolchain[:COMPILER][:ASM][:FLAGS]            == @defaultToolchainCached[:COMPILER][:ASM][:FLAGS] and
-                @defaultToolchain[:COMPILER][:ASM][:DEFINES].join("") == @defaultToolchainCached[:COMPILER][:ASM][:DEFINES].join("")
+                @defaultToolchain[:COMPILER][:ASM][:DEFINES].join("") == @defaultToolchainCached[:COMPILER][:ASM][:DEFINES].join("") and
+                @defaultToolchain[:LINT_POLICY].join("")              == @defaultToolchainCached[:LINT_POLICY].join("")
                 @defaultToolchainTime = @mainMetaTime
               end
             end
@@ -383,10 +386,12 @@ module Cxxproject
       @mainConfig = @project2config[@mainProjectName]
-      basedOnToolchain = Cxxproject::Toolchain::Provider[@mainConfig.defaultToolchain.basedOn]
+      basedOn = @mainConfig.defaultToolchain.basedOn
+      basedOn = "GCC_Lint" if @options.lint
+      basedOnToolchain = Cxxproject::Toolchain::Provider[basedOn]
       @defaultToolchain = Utils.deep_copy(basedOnToolchain)
       integrateToolchain(@defaultToolchain, @mainConfig.defaultToolchain)
     end
     def convert2bb
@@ -408,17 +413,7 @@ module Cxxproject
         addSteps(config.postSteps, bbModule, projDir, "POST", tcs) if not @options.linkOnly
-        # LIB, EXE
-        if Metamodel::LibraryConfig === config
-          bbModule.main_content = SourceLibrary.new(projName)
-        elsif Metamodel::ExecutableConfig === config
-          bbModule.main_content = Executable.new(projName)
-          if not config.artifactName.nil?
-            x = @options.build_config + "/" + config.artifactName.name
-            bbModule.main_content.set_executable_name(x)
-          end
-          bbModule.main_content.set_linker_script(convPath(config.linkerScript, config)) unless config.linkerScript.nil?
-        else # CUSTOM
+        if Metamodel::CustomConfig === config
           if config.step
             if config.step.filter != ""
               Printer.printError "Error: #{config.file_name}(#{config.step.line_number}): attribute filter not allowed here"
@@ -431,6 +426,18 @@ module Cxxproject
             addSteps(config.step, bbModule, projDir, nil, tcs)
           end
           bbModule.main_content = BinaryLibrary.new(projName, false)
+        elsif @options.lint
+          bbModule.main_content = Lint.new(projName)
+          bbModule.main_content.set_lint_min(@options.lint_min).set_lint_max(@options.lint_max)
+        elsif Metamodel::LibraryConfig === config
+          bbModule.main_content = SourceLibrary.new(projName)
+        elsif Metamodel::ExecutableConfig === config
+          bbModule.main_content = Executable.new(projName)
+          if not config.artifactName.nil?
+            x = @options.build_config + "/" + config.artifactName.name
+            bbModule.main_content.set_executable_name(x)
+          end
+          bbModule.main_content.set_linker_script(convPath(config.linkerScript, config)) unless config.linkerScript.nil?
         end
         bbModule.last_content.dependencies << bbModule.main_content.name
         bbModule.last_content = bbModule.main_content
@@ -536,7 +543,7 @@ module Cxxproject
         end
         # special exe stuff
-        if Metamodel::ExecutableConfig === config
+        if Metamodel::ExecutableConfig === config and not @options.lint
           if not config.mapFile.nil?
             if config.mapFile.name == ""
               exeName = bbModule.main_content.get_executable_name
@@ -548,18 +555,19 @@ module Cxxproject
             bbModule.main_content.set_mapfile(mapfileName)
           end
         end
-          bbModule.contents.each do |c|
-            if Cxxproject::CommandLine === c
-              cmdLine = convPath(c.get_command_line, config, bbModule.main_content)
-              c.set_command_line(cmdLine)
-            end
-          end
+        bbModule.contents.each do |c|
+          if Cxxproject::CommandLine === c
+            cmdLine = convPath(c.get_command_line, config, bbModule.main_content)
+            c.set_command_line(cmdLine)
+          end
+        end
-          # DEPS
-          projDeps = config.dependency.map { |dd| "Project "+dd.name }
-          projDeps.concat(bbModule.main_content.dependencies)
-          bbModule.main_content.set_dependencies(projDeps)
-          config.dependency.each { |dd| @lib_elements[dd.line_number] = [HasLibraries::DEPENDENCY, dd.name] }
+        # DEPS
+        projDeps = config.dependency.map { |dd| "Project "+dd.name }
+        projDeps.concat(bbModule.main_content.dependencies)
+        bbModule.main_content.set_dependencies(projDeps)
+        config.dependency.each { |dd| @lib_elements[dd.line_number] = [HasLibraries::DEPENDENCY, dd.name] }
         @lib_elements.sort.each do |x|
@@ -745,7 +753,7 @@ module Cxxproject
             c.set_sources([@startupFilename])
             c.set_source_patterns([])
             c.set_exclude_sources([])
-            c.extend(SingleSourceModule)
+            c.extend(SingleSourceModule) unless @options.lint
             break
           else
             def c.needed?

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-toolkit
 version: !ruby/object:Gem::Version
-  version: 1.0.27
+  version: 1.1.0
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cxxproject
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.71
+        version: 0.5.72
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.71
+        version: 0.5.72
 - !ruby/object:Gem::Dependency
   name: rtext
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - doc/concepts/mainproject.html
 - doc/deployDoc.bat
 - doc/dyk/keys.png
+- doc/dyk/lint.html
 - doc/dyk/tipps.html
 - doc/eclipse/build/buildFile.png
 - doc/eclipse/build/buildMain.png