canoe 0.3.0.2 → 0.3.2.2

data/lib/workspace/clean.rb

@@ -1,26 +1,28 @@
-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
+module Canoe
+  class WorkSpace
+    # valid options: none, 'all', 'target', 'tests'
+    def clean(arg = 'all')
+      send "clean_#{arg}"
+    end
 
-  def clean_target
-    puts "rm -f ./target/*"
-    system "rm -f ./target/*"
-  end
+    private
 
-  def clean_bin
-    clean_obj
-    clean_target
-  end
+    def clean_all
+      clean_target
+      clean_obj
+    end
+
+    def clean_target
+      issue_command 'rm ./target/* -rf'
+    end
+
+    def clean_obj
+      issue_command 'rm ./obj/* -rf'
+    end
 
-  def clean_lib
-    clean_obj
-    clean_target
+    def clean_tests
+      issue_command 'rm ./obj/test_* -rf'
+      issue_command 'rm ./target/test_* -rf'
+    end
   end
-end
+end

data/lib/workspace/dep.rb

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

data/lib/workspace/generate.rb

@@ -1,6 +1,10 @@
-class WorkSpace
-  def generate
-    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
-               .build_to_file ['./src', './src/components'], @deps
+module Canoe
+  class WorkSpace
+    def generate
+      DepAnalyzer.new(@src_short, @source_suffix, @header_suffix)
+                 .build_to_file [@src_short, @components_short], @deps
+      DepAnalyzer.new(@tests_short, @source_suffix, @header_suffix)
+                 .build_to_file [@src_short, @components_short], @test_deps
+    end
   end
 end

data/lib/workspace/help.rb

@@ -1,71 +1,84 @@
-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
+module Canoe
+  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 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
-  
-            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
+          canoe test: build and run tests
+      
+          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. 
               
-            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
-    
-            @author: written by XIONG Ziwei, ICT, CAS
-            @contact: noahxiong@outlook.com
-        INFO
-    puts info
+          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 [all|test]:
+          build current project, 'all' builds both target and tests, 'test' builds tests only
+
+      test [tests]:
+          build and run tests
+          [tests]: 'all' for all tests, or a name of a test for a single test
+        
+      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
-end
+end

data/lib/workspace/make.rb

@@ -0,0 +1,279 @@
+# If the project has circular dependency, this command would fail
+module Canoe
+  ##
+  # CanoeMakefile is used to offer makefile generation utilities
+  class CanoeMakefile
+    include WorkSpaceUtil
+    def initialize(workspace)
+      @workspace = workspace
+      @all_names = []
+      @common_variables = {}
+      @src_variables = {}
+      @hdr_variables = {}
+      @obj_variables = {}
+      @config = {}
+    end
+
+    def configure(config)
+      @config = config
+    end
+
+    def make!(deps)
+      File.open('Makefile', 'w') do |f|
+        if cxx?(get_compiler)
+          make_cxx(f, deps)
+        else
+          make_c(f, deps)
+        end
+      end
+    end
+
+    private
+
+    def get_compiler
+      @config['compiler']
+    end
+
+    def get_header_suffix
+      @workspace.header_suffix
+    end
+
+    def get_source_suffix
+      @workspace.source_suffix
+    end
+
+    def get_compiling_flags
+      flags = @config['flags']['compile'].values.join ' '
+      flags + ' -I./src/components'
+    end
+
+    def get_ldflags
+      @config['flags']['link'].values.select { |v| v.start_with?('-L') }.join ' '
+    end
+
+    def get_ldlibs
+      (@config['flags']['link'].values - (get_ldflags.split)).join ' '
+    end
+
+    def cxx?(name)
+      return get_compiler.end_with? '++'
+    end
+
+    def make_cxx(makefile, deps)
+      make_common(makefile, 'CXX', deps)
+    end
+
+    def make_c(makefile, deps)
+      make_common(makefile, 'CC', deps)
+    end
+
+    def make_common(makefile, compiler_prefix, deps)
+      make_compiling_info(makefile, compiler_prefix)
+      define_variables(makefile, deps)
+      make_rules(makefile, deps)
+    end
+
+    def make_compiling_info(makefile, compiler_prefix)
+      makefile.puts("#{compiler_prefix}=#{get_compiler}")
+      makefile.puts("#{compiler_prefix}FLAGS=#{get_compiling_flags}")
+      makefile.puts("LDFLAGS=#{get_ldflags}")
+      makefile.puts("LDLIBS=#{get_ldlibs}")
+      makefile.puts ''
+    end
+
+    def define_variables(makefile, deps)
+      define_dirs(makefile)
+      src_files = deps.keys.select { |f| f.end_with? get_source_suffix }
+      
+      generate_all_names(src_files)
+      define_srcs(makefile, src_files)
+      makefile.puts ''
+      define_hdrs(makefile, src_files)
+      makefile.puts ''
+      define_objs(makefile, src_files)
+      makefile.puts ''
+      define_tests(makefile, src_files)
+      makefile.puts ''
+    end
+
+    def extract_name(name, _)
+      File.basename(file_to_obj(name), '.*')
+    end
+
+    def generate_all_names(files)
+      files.each do |f|
+        name = extract_name(f, @workspace.components_prefix).upcase
+        @all_names << name
+        @src_variables[name] = f
+        @hdr_variables[name] = f.gsub @workspace.source_suffix, @workspace.header_suffix
+        @obj_variables[name] = file_to_obj(f)
+      end
+    end
+
+    def define_dirs(makefile)
+      makefile.puts("TARGET_DIR=./target")
+      if @workspace.mode == :bin
+        makefile.puts("TARGET=$(TARGET_DIR)/#{@workspace.name}")
+      else
+        makefile.puts("TARGET=$(TARGET_DIR)/lib#{@workspace.name.downcase}.so")
+      end
+      # note the ending slash
+      makefile.puts("OBJ_DIR=#{@workspace.obj_prefix[..-2]}")
+      makefile.puts("SRC_DIR=#{@workspace.src_prefix[..-2]}")
+      makefile.puts("COMPONENTS_DIR=#{@workspace.components_prefix[..-2]}")
+      makefile.puts ""
+    end
+
+    def define_srcs(makefile, files)
+      @src_variables.each do |k, v|
+        makefile.puts("SRC_#{k}=#{v}")
+      end
+    end
+
+    def define_hdrs(makefile, files)
+      @hdr_variables.each do |k, v|
+        next if k == "MAIN"
+        makefile.puts("HDR_#{k}=#{v}") if File.exist? v
+      end
+    end
+
+    def define_objs(makefile, files)
+      @obj_variables.each do |k, v|
+        makefile.puts("OBJ_#{k}=#{v}")
+      end
+      objs = @obj_variables.keys.map { |k| "$(OBJ_#{k})" }
+      bin_objs = objs.reject { |o| o.start_with? '$(OBJ_TEST'}
+      test_objs = objs - bin_objs
+      makefile.puts ''
+      makefile.puts("OUT_OBJS=#{bin_objs.join ' '}")
+      makefile.puts("TEST_OBJS=#{test_objs.join ' '}")
+    end
+
+    def define_tests(makefile, files)
+      test_files = files.select { |f| File.basename(f, '.*').start_with? 'test_'}
+      test_files.each do |f|
+        basename = File.basename(f, '.*')
+        test = "#{@workspace.target_short}/#{basename}"
+        makefile.puts("#{basename.upcase}=#{test}")
+      end
+      tests = test_files.map do |f|
+        "$(#{File.basename(f, '.*').upcase})"
+      end
+      makefile.puts("TESTS=#{tests.join ' '}")
+    end
+
+    def get_all_dep_name(file_name, deps)
+      dep = deps[file_name]
+      if dep.empty?
+        []
+      else
+        tmp = dep.map { |n| extract_name(n, @workspace.components_prefix).upcase }
+        dep.each do |d|
+          tmp += get_all_dep_name(d, deps)
+        end
+        tmp
+      end
+    end
+
+    def emit_dependencies(makefile, name, deps)
+      as_str = deps.map do |n|
+        if n == name
+          ["$(SRC_#{n})"] + ["$(HDR_#{n})"] * (name == "MAIN" ? 0 : 1)
+        else
+          "$(#{n}_DEP)"
+        end
+      end.flatten.join " "
+      makefile.puts("#{name}_DEP=#{as_str}")
+    end
+
+    def make_dependencies(makefile, deps)
+      dep_variables = Hash[@all_names.map { |n| [n, []] }]
+      reference = Hash[@all_names.map { |n| [n, []] }]
+      @all_names.each do |n|
+        dep_variables[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
+        reference[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
+      end
+
+      # deduplication
+      dep_variables.each do |k, v|
+        v.each do |n|
+          next if n == k
+          v = v - reference[n] + [n] if v.include? n
+        end
+        dep_variables[k] = v
+      end
+
+      dep_variables.each do |k, v|
+        emit_dependencies(makefile, k, v)
+      end
+    end
+
+    def make_obj_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+
+      @all_names.each do |n|
+        makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ -c $(SRC_#{n})\n\n")
+      end
+    end
+
+    def make_out_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+      if @workspace.mode == :bin
+        makefile.puts("out: $(OUT_OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(TARGET) $(OUT_OBJS) $(LDFLAGS) $(LDLIBS)")
+      else
+        makefile.puts("out: $(OUT_OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -shared -o $(TARGET) $(OUT_OBJS) -fPIC $(LDFLAGS) $(LDLIBS)")
+      end
+      makefile.puts ''
+      makefile.puts("test: $(TESTS)")
+      makefile.puts ''
+      makefile.puts("all: out test")
+    end
+
+    def make_tests_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+      @all_names.each do |n|
+        next unless n.start_with? 'TEST_'
+        filename = "#{@workspace.tests_short}/#{n.downcase}.#{@workspace.source_suffix}"
+        objs = ["$(OBJ_#{n})"] + extract_one_file_obj(filename, deps).map do |o|
+          "$(OBJ_#{File.basename(o, '.*').upcase})"
+        end
+
+        makefile.puts("$(#{n}): #{objs.join ' '}\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ $^ $(LDFLAGS) $(LDLIBS)")
+        makefile.puts ''
+      end
+    end
+
+    def make_clean(makefile)
+      clean = <<~DOC
+            .PHONY: clean
+            clean: 
+            \trm ./target/*
+            \trm ./obj/*.o
+            DOC
+      makefile.puts(clean)
+    end
+
+    def make_rules(makefile, deps)
+      make_dependencies makefile, deps
+      makefile.puts ''
+      make_out_rules makefile, deps
+      makefile.puts ''
+      make_obj_rules makefile, deps
+      make_tests_rules makefile, deps
+      makefile.puts ''
+      make_clean makefile
+    end
+  end
+
+  class WorkSpace
+    def make
+      config = ConfigReader.extract_flags "config.json"
+
+      deps = target_deps.merge tests_deps
+
+      makefile = CanoeMakefile.new self
+      makefile.configure config
+      makefile.make! deps
+    end
+  end
+end