canoe 0.2.4 → 0.3.1.1

data/lib/dependence.rb

@@ -1,31 +1,54 @@
-require_relative 'source_files'
-require_relative 'err'
+require_relative "source_files"
+require_relative "err"
 
+##
+# class DepAnalyzer
+#   This class is the key component of canoe, which offers file dependency analysis functionality.
+#     A DepAnalyzer takes a directory as input, sources files and corresponding header files in this
+#     directory should have same name, e.g. test.cpp and test.hpp.
+#     DepAnalyzer would read every source file and recursively process user header files included in this source file to
+#     find out all user header files this source file depends on.
+#     Based on dependencies built in previous stage, DepAnalyzer determines which files should be recompiled and return
+#     these files to caller.
+#
+#     Dependencies could be written to a file to avoid wasting time parsing all files, Depanalyzer would read from
+#     this file to construct dependencies. But if sources files included new headers or included headers are revmoed,
+#     Depanalyzer should rebuild the whole dependencies.
 class DepAnalyzer
   include Err
   def self.read_from(filename)
     File.open(filename, "r") do |f|
       ret = Hash.new []
       f.each_with_index do |line, i|
-        entry = line.split(': ')
-        Err.abort_on_err("Bad .canoe.deps format, line #{i+1}") unless entry.length == 2
+        entry = line.split(": ")
+        Err.abort_on_err("Bad .canoe.deps format, line #{i + 1}") unless entry.length == 2
         ret[entry[0]] = entry[1].split
-      end            
+      end
       ret
     end
   end
 
-  def self.compiling_filter(deps, build_time, src_sfx='cpp', hdr_sfx='hpp')
-    files = [] 
+  def self.compiling_filter(deps, build_time, src_sfx = "cpp", hdr_sfx = "hpp")
+    files = []
+    @processed = {}
+    @recompiles = {}
+    deps.keys.each do |k|
+      @processed[k] = false
+      @recompiles[k] = false
+    end
     deps.each do |k, v|
       next if k.end_with? ".#{hdr_sfx}"
       if should_recompile?(k, build_time)
         files << k
+        @processed[k] = true
+        @recompiles[k] = true
         next
       end
       v.each do |f|
         if mark(f, build_time, deps) || mark(f.sub(".#{hdr_sfx}", ".#{src_sfx}"), build_time, deps)
           files << k
+          @processed[k] = true
+          @recompiles[k] = true
           break
         end
       end
@@ -34,22 +57,36 @@ class DepAnalyzer
   end
 
   private
+
   def self.mark(file, build_time, deps)
+    ret = false
     return false unless File.exists? file
     if should_recompile?(file, build_time)
       return true
     else
       deps[file].each do |f|
-        return true if mark(f, build_time, deps)
+        if @processed[f]
+          ret |= @recompiles[f]
+          next
+        end
+        @processed[f] = true
+        if mark(f, build_time, deps)
+          @recompiles[f] = true
+          return true
+        end
       end
     end
-    false
+    ret
   end
 
-  def self.should_recompile?(file, build_time) 
+  def self.should_recompile?(file, build_time)
     judge = build_time
     if build_time == Time.new(0)
-      objfile = "./obj/#{File.basename(file, ".*")}.o"
+      objfile = if file.start_with?("./src/components")
+          "./obj/" + file.delete_suffix(File.extname(file))["./src/components/".length..].gsub("/", "_") + ".o"
+        else
+          "./obj/#{File.basename(file, ".*")}.o"
+        end
       return true unless File.exists? objfile
       judge = File.mtime(objfile)
     end
@@ -57,7 +94,8 @@ class DepAnalyzer
   end
 
   public
-  def initialize(dir, src_sfx='cpp', hdr_sfx='hpp')
+
+  def initialize(dir, src_sfx = "cpp", hdr_sfx = "hpp")
     @dir = dir
     @deps = Hash.new []
     @source_suffix = src_sfx
@@ -79,25 +117,26 @@ class DepAnalyzer
 
   def build_to_file(include_path, filename)
     build_dependence include_path
-    
+
     File.open(filename, "w") do |f|
       @deps.each do |k, v|
         f.write "#{k}: #{v.join(" ")}\n"
       end
     end
-    
+
     @deps
   end
 
   private
-  def get_all_headers(include_path, file, suffix='hpp')
+
+  def get_all_headers(include_path, file, suffix = "hpp")
     File.open(file, "r") do |f|
       ret = []
       if file.end_with?(".#{@source_suffix}")
         header = file.sub(".#{@source_suffix}", ".#{@header_suffix}")
         ret += [header] if File.exists?(header)
       end
-      
+
       f.each_line do |line|
         if mat = line.match(/include "(.+\.#{suffix})"/)
           include_path.each do |path|
@@ -106,7 +145,7 @@ class DepAnalyzer
           end
         end
       end
-      
+
       ret.uniq
     end
   end

data/lib/err.rb

@@ -1,7 +1,9 @@
+require_relative "coloring"
+
 module Err
   def warn_on_err(err)
     puts <<~ERR
-           Warning: 
+           #{"Waring: ".yellow}
                #{err}
            try 'canoe help' for more information
          ERR
@@ -9,10 +11,10 @@ module Err
 
   def abort_on_err(err)
     abort <<~ERR
-            Fatal: 
+            #{"Fatal: ".red}
                 #{err}
             try 'canoe help' for more information
-         ERR
+          ERR
   end
 
   module_function :warn_on_err, :abort_on_err

data/lib/source_files.rb

@@ -1,8 +1,11 @@
+##
+# class SourceFiles
+#   A simple class to assist collect all files or some files in a directory.
 class SourceFiles
   class << self
     def get_all(dir, &block)
       @files = []
-      get_all_helper(dir, &block) 
+      get_all_helper(dir, &block)
       @files
     end
 
@@ -16,13 +19,14 @@ class SourceFiles
           else
             @files << "#{file}"
           end
-        end 
+        end
       end
-      
+
       @files
     end
 
     private
+
     def get_all_helper(dir, &block)
       Dir.each_child(dir) do |f|
         file = "#{dir}/#{f}"
@@ -39,4 +43,3 @@ class SourceFiles
     end
   end
 end
-

data/lib/workspace/add.rb

@@ -0,0 +1,27 @@
+class WorkSpace
+  def add(args)
+    args.each do |i|
+      dir = @components
+      filenames = i.split("/")
+      prefix = []
+      filenames.each do |filename|
+        dir += "/#{filename}"
+        prefix << filename
+        unless Dir.exist? dir
+          FileUtils.mkdir dir
+          Dir.chdir(dir) do
+            puts "created " + Dir.pwd.blue
+            create_working_files prefix.join("__"), filename
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def create_working_files(prefix, filename)
+    DefaultFiles.create_cpp filename, @source_suffix, @header_suffix
+    DefaultFiles.create_hpp @name, prefix, filename, @header_suffix
+  end
+end

data/lib/workspace/build.rb

@@ -0,0 +1,131 @@
+class WorkSpace
+  # args are commandline parameters passed to `canoe build`,
+  # could be 'all', 'test', 'target' or empty
+  def build(args)
+    case args[0]
+    when "all"
+      build_all
+    when "test"
+      build_test
+    else
+      build_target
+    end
+  end
+
+  private
+
+  def build_flags(flags, config)
+    config.values.each do |v|
+      case v
+      when String
+        flags << v
+      when Array
+        v.each do |o|
+          flags << o
+        end
+      else
+        abort_on_err "unknown options in config.json, #{v}"
+      end
+    end
+  end
+
+  def build_compiler_from_config
+    Dir.chdir(@workspace) do
+      flags = ConfigReader.extract_flags "config.json"
+      compiler_name = flags["compiler"] ? flags["compiler"] : "clang++"
+      abort_on_err "compiler #{compiler_name} not found" unless File.exists?("/usr/bin/#{compiler_name}")
+      compiler_flags = ["-Isrc/components"]
+      linker_flags = []
+
+      c_flags, l_flags = flags["flags"]["compile"], flags["flags"]["link"]
+      build_flags(compiler_flags, c_flags)
+      build_flags(linker_flags, l_flags)
+
+      @compiler = Compiler.new compiler_name, compiler_flags, linker_flags
+    end
+  end
+
+  def compile(f, o)
+    @compiler.compile f, o
+  end
+
+  def link_exectutable(odir, objs)
+    puts "#{"[100%]".green} linking"
+    @compiler.link_executable "#{odir}/#{@name}", objs
+  end
+
+  def link_shared(odir, objs)
+    puts "#{"[100%]".green} linking"
+    @compiler.link_shared "#{odir}/lib#{@name}", objs
+  end
+
+  def build_bin(files)
+    # return if files.empty?
+    build_compiler_from_config
+    if build_common(files) && link_exectutable("./target", Dir.glob("obj/*.o"))
+      puts "BUILDING SUCCEEDED".green
+    else
+      puts "building FAILED".red
+    end
+  end
+
+  def build_lib(files)
+    # return if files.empty?
+    build_compiler_from_config
+    @compiler.append_compiling_flag "-fPIC"
+    if build_common(files) && link_shared("./target", Dir.glob("obj/*.o"))
+      puts "BUILDING SUCCEEDED".green
+    else
+      puts "building FAILED".red
+    end
+  end
+
+  def build_common(files)
+    all = SourceFiles.get_all("./src") { |f| f.end_with? @source_suffix }
+    total = all.size.to_f
+    compiled = total - files.size
+    comps = files.select { |f| f.start_with? @components_prefix }
+    srcs = files - comps
+    flag = true
+
+    srcs.each do |f|
+      progress = (compiled / total).round(2) * 100
+      printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
+      fname = f.split("/")[-1]
+      o = @obj_prefix + File.basename(fname, ".*") + ".o"
+      flag = false unless compile f, o
+      compiled += 1
+    end
+
+    comps.each do |f|
+      progress = (compiled / total).round(2) * 100
+      printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
+      o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
+        .gsub("/", "_") + ".o"
+      flag = false unless compile f, o
+      compiled += 1
+    end
+    flag
+  end
+
+  def build_all
+    build_target
+    build_test
+  end
+
+  def build_target
+    deps = File.exist?(@deps) ?
+      DepAnalyzer.read_from(@deps) :
+      DepAnalyzer.new("./src").build_to_file(["./src", "./src/components"], @deps)
+    target = "./target/#{@name}"
+    build_time = File.exist?(target) ? File.mtime(target) : Time.new(0)
+    files = DepAnalyzer.compiling_filter(deps, build_time, @source_suffix, @header_suffix)
+
+    if files.empty? && File.exist?(target)
+      puts "nothing to do, all up to date"
+      return
+    end
+
+    self.send "build_#{@mode.to_s}", files
+  end
+end

data/lib/workspace/clean.rb

@@ -0,0 +1,27 @@
+class WorkSpace
+  def clean
+    self.send "clean_#{@mode.to_s}"
+  end
+
+  private
+
+  def clean_obj
+    puts "rm -f ./obj/*.o"
+    system "rm -f ./obj/*.o"
+  end
+
+  def clean_target
+    puts "rm -f ./target/*"
+    system "rm -f ./target/*"
+  end
+
+  def clean_bin
+    clean_obj
+    clean_target
+  end
+
+  def clean_lib
+    clean_obj
+    clean_target
+  end
+end

data/lib/workspace/dep.rb

@@ -0,0 +1,12 @@
+class WorkSpace
+  def dep
+    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
+    deps.each do |k, v|
+      unless v.empty?
+        puts "#{k.blue} depends on: "
+        v.each { |f| puts "    #{f.blue}" }
+        puts ""
+      end
+    end
+  end
+end

data/lib/workspace/generate.rb

@@ -0,0 +1,5 @@
+class WorkSpace
+  def generate
+    DepAnalyzer.new("./src", @source_suffix, @header_suffix).build_to_file ["./src", "./src/components"], @deps
+  end
+end

data/lib/workspace/help.rb

@@ -0,0 +1,76 @@
+class WorkSpace
+  def self.help
+    info = <<~INFO
+      canoe is a C/C++ project manager, inspired by Rust cargo.
+      usage:
+          canoe new tada: create a project named 'tada' in current directory
+            
+          canoe build: compile current project (execute this command in project directory)
+      
+          canoe generate: generate dependency relationships and store it in '.canoe.deps' file. Alias: update
+
+          canoe update: udpate dependency relationships and store it in '.canoe.deps' file. 
+              
+          canoe run: compile and execute current project (execute this command in project directory)
+            
+          canoe clean: remove all generated object files and binary files
+            
+          canoe help: show this help message
+      
+          canoe add tada: add a folder named tada under workspace/components,
+            
+          canoe dep: show current dependency relationships of current project
+            
+          canoe verion: version information
+
+          canoe make: generate a makefile for this project
+      
+      new project_name [mode] [suffixes]:
+          create a new project with project_name.
+          In this project, four directories obj, src, target and third-party will be generated in project directory.
+          in src, directory 'components' will be generated if [mode] is '--lib', an extra main.cpp will be generated if [mode] is '--bin'
+      
+          [mode]: --lib for a library and --bin for executable binaries
+          [suffixes]: should be in 'source_suffix:header_suffix" format, notice the ':' between two suffixes
+      add component_name:
+          add a folder named tada under workspace/components.
+          two files tada.hpp and tada.cpp would be craeted and intialized. File suffix may differ according users' specifications.
+          if component_name is a path separated by '/', then canoe would create folders and corresponding files recursively.
+      
+      generate: 
+          generate dependence relationship for each file, this may accelarate
+          `canoe buid` command. It's recommanded to execute this command everytime
+          headers are added or removed from any file.
+          
+      update:
+          this command is needed because '.canoe.deps' is actually a cache of dependency relationships so that canoe doesn't have to analyze all the files when building a project.
+          So when a file includes new headers or some headers are removed, users have to use 'canoe udpate'
+          to update dependency relationships.
+      
+      build [options]:
+          build current project, arguments in [options] will be passed to C++ compiler
+        
+      run [options]:
+          build current project with no specific compilation flags, and run this project, passing [options] as command line arguments to the binary
+      
+      clean:
+          remove all generated object files and binary files
+      
+      help:
+          show this help message
+      
+      verion: 
+          display version information
+      
+      dep:
+          display file dependencies in a better readable way
+
+      make: 
+          generate a Makefile for this project
+      
+      @author: written by XIONG Ziwei, ICT, CAS
+      @contact: noahxiong@outlook.com
+    INFO
+    puts info
+  end
+end