canoe 0.2.4 → 0.3.1.1

data/lib/workspace/make.rb

@@ -0,0 +1,233 @@
+# If the project has circular dependency, this command would fail
+class Makefile
+  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 ""
+  end
+
+  def extract_name(name, prefix)
+    if name.start_with?(prefix)
+      name.delete_suffix(File.extname(name))[prefix.length..].gsub("/", "_")
+    else
+      File.basename(name.split("/")[-1], ".*")
+    end
+  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] = @workspace.obj_prefix + extract_name(f, @workspace.components_prefix) + ".o"
+    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}")
+    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})" }.join " "
+    makefile.puts("OBJS=#{objs}")
+    makefile.puts ""
+  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_rules(makefile, deps)
+    make_dependencies(makefile, deps)
+    makefile.puts ""
+    makefile.puts("all: BIN\n")
+    makefile.puts ""
+    cmplr = cxx?(get_compiler) ? "CXX" : "CC"
+    @all_names.each do |n|
+      makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(OBJ_#{n}) -c $(SRC_#{n})")
+      makefile.puts ""
+    end
+
+    if @workspace.mode == :bin
+      makefile.puts("BIN: $(OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(TARGET) $(wildcard ./obj/*.o) $(LDFLAGS) $(LDLIBS)")
+    else
+      makefile.puts("LIB: $(OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -shared -o $(TARGET) $(wildcard ./obj/*.o) -fPIC $(LDFLAGS) $(LDLIBS)")
+    end
+    makefile.puts ""
+
+    clean = <<~DOC
+      .PHONY: clean
+      clean: 
+      \trm $(TARGET)
+      \trm ./obj/*.o
+    DOC
+    makefile.puts(clean)
+  end
+end
+
+class WorkSpace
+  def make
+    config = ConfigReader.extract_flags "config.json"
+
+    deps = File.exist?(@deps) ?
+      DepAnalyzer.read_from(@deps) :
+      DepAnalyzer.new("./src").build_to_file(["./src", "./src/components"], @deps)
+
+    makefile = Makefile.new(self)
+    makefile.configure(config)
+    makefile.make!(deps)
+  end
+end

data/lib/workspace/new.rb

@@ -0,0 +1,28 @@
+class WorkSpace
+  def new
+    begin
+      Dir.mkdir(@name)
+    rescue
+      abort_on_err "workspace #{@name} already exsits"
+    end
+    Dir.mkdir(@src)
+    Dir.mkdir(@components)
+    Dir.mkdir("#{@workspace}/obj")
+    if @mode == :bin
+      DefaultFiles.create_main(@src, @source_suffix)
+    else
+      DefaultFiles.create_lib_header(@src, @name, @header_suffix)
+    end
+    File.new("#{@workspace}/.canoe", "w")
+    DefaultFiles.create_config @workspace, @source_suffix, @header_suffix
+    # DefaultFiles.create_emacs_dir_local @workspace
+
+    Dir.mkdir(@third)
+    Dir.mkdir(@target)
+    Dir.mkdir(@tests)
+    Dir.chdir(@workspace) do
+      system "git init"
+    end
+    puts "workspace #{@workspace.blue} is created"
+  end
+end

data/lib/workspace/run.rb

@@ -0,0 +1,9 @@
+class WorkSpace
+  def run(args)
+    return if @mode == :lib
+    build []
+    args = args.join " "
+    puts "./target/#{@name} #{args}"
+    exec "./target/#{@name} #{args}"
+  end
+end

data/lib/workspace/test.rb

@@ -0,0 +1,41 @@
+class WorkSpace
+  public
+
+  def test(args)
+    if args.empty?
+      test_all
+      return
+    end
+
+    args.each do |arg|
+      case arg
+      when "all"
+        test_all
+      else
+        test_single arg
+      end
+    end
+  end
+
+  private
+
+  def test_all
+    puts "tests all"
+  end
+
+  def test_single(name)
+    puts "#{@tests}/bin/test_#{name}"
+    # system "./#{@tests}/bin/test_#{name}"
+  end
+
+  ##
+  # how to build:
+  # each test file tests one or more components, indicated by included headers
+  # find corresponding object file in ../obj and link them to test file
+  # TODO
+  def build_test
+    build
+    deps = DepAnalyzer.new("./tests").build_to_file(["./src", "./src/components", "./tests", "./tests/common"], "./tests/.canoe.deps")
+    puts deps
+  end
+end

data/lib/workspace/update.rb

@@ -0,0 +1,5 @@
+class WorkSpace
+  def update
+    generate
+  end
+end

data/lib/workspace/version.rb

@@ -0,0 +1,13 @@
+class WorkSpace
+  def self.version
+    puts <<~VER
+           canoe v0.3.1.1
+           For features in this version, please visit https://github.com/Dicridon/canoe
+           Currently, canoe can do below:
+               - project creation
+               - project auto build and run (works like Cargo for Rust)
+               - project structure management
+           by XIONG Ziwei
+         VER
+  end
+end

data/lib/workspace/workspace.rb

@@ -0,0 +1,53 @@
+require "fileutils"
+require_relative "../source_files"
+require_relative "../compiler"
+require_relative "../config_reader"
+require_relative "../default_files"
+require_relative "../err"
+require_relative "../dependence"
+require_relative "../coloring"
+
+class WorkSpace
+  include Err
+  attr_reader :name, :cwd, :src_prefix, :components_prefix, :obj_prefix, :source_suffix, :header_suffix, :mode
+
+  def initialize(name, mode, src_suffix = "cpp", hdr_suffix = "hpp")
+    @name = name
+    @compiler = Compiler.new "clang++", ["-Isrc/components"], []
+    @cwd = Dir.new(Dir.pwd)
+    @workspace = "#{Dir.pwd}/#{@name}"
+    @src = "#{@workspace}/src"
+    @components = "#{@src}/components"
+    @obj = "#{@workspace}/obj"
+    @third = "#{@workspace}/third-party"
+    @target = "#{@workspace}/target"
+    @tests = "#{@workspace}/tests"
+    @mode = mode
+    @deps = ".canoe.deps"
+
+    @src_prefix = "./src/"
+    @components_prefix = "./src/components/"
+    @obj_prefix = "./obj/"
+
+    @source_suffix = src_suffix
+    @header_suffix = hdr_suffix
+  end
+
+  def inspect
+    puts "name is #{@name}"
+    puts "name is #{@workspace}"
+  end
+end
+
+require_relative "help"
+require_relative "version"
+require_relative "new"
+require_relative "add"
+require_relative "build"
+require_relative "generate"
+require_relative "run"
+require_relative "dep"
+require_relative "clean"
+require_relative "update"
+require_relative "test"
+require_relative "make"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1.1
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.
@@ -28,13 +28,26 @@ files:
 - bin/canoe
 - lib/canoe.rb
 - lib/cmd.rb
+- lib/coloring.rb
 - lib/compiler.rb
 - lib/config_reader.rb
 - lib/default_files.rb
 - lib/dependence.rb
 - lib/err.rb
 - lib/source_files.rb
-- lib/workspace.rb
+- lib/workspace/add.rb
+- lib/workspace/build.rb
+- lib/workspace/clean.rb
+- lib/workspace/dep.rb
+- lib/workspace/generate.rb
+- lib/workspace/help.rb
+- lib/workspace/make.rb
+- lib/workspace/new.rb
+- lib/workspace/run.rb
+- lib/workspace/test.rb
+- lib/workspace/update.rb
+- lib/workspace/version.rb
+- lib/workspace/workspace.rb
 homepage: https://github.com/Dicridon/canoe
 licenses:
 - MIT
@@ -54,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: a C/C++ project management and building tool

data/lib/workspace.rb

@@ -1,296 +0,0 @@
-require 'fileutils'
-require 'open3'
-require_relative 'source_files'
-require_relative 'compiler'
-require_relative 'config_reader'
-require_relative 'default_files'
-require_relative 'err'
-require_relative 'dependence'
-
-class WorkSpace
-  include Err
-  attr_reader :name, :cwd
-  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
-
-            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
-
-            @author: written by XIONG Ziwei, ICT, CAS
-            @contact: noahxiong@outlook.com
-        INFO
-    puts info
-  end
-
-
-  def initialize(name, mode, src_suffix='cpp', hdr_suffix='hpp')
-    @name = name
-    @compiler = Compiler.new 'clang++', '-Isrc/components'
-    @cwd = Dir.new(Dir.pwd)
-    @workspace = "#{Dir.pwd}/#{@name}"
-    @src = "#{@workspace}/src"
-    @components = "#{@src}/components"
-    @obj = "#{@workspace}/obj"
-    @third = "#{@workspace}/third-party"
-    @target = "#{@workspace}/target"
-    @mode = mode
-    @deps = '.canoe.deps'
-
-    @src_prefix = './src/'
-    @components_prefix = './src/components/'
-    @obj_prefix = './obj/'
-
-    @source_suffix = src_suffix
-    @header_suffix = hdr_suffix
-  end
-
-  def new
-    Dir.mkdir(@name)
-    Dir.mkdir(@src)
-    Dir.mkdir(@components)
-    Dir.mkdir("#{@workspace}/obj")
-    if @mode == :bin
-      DefaultFiles.create_main(@src, @source_suffix) 
-    else
-      DefaultFiles.create_lib_header(@src, @name, @header_suffix)
-    end
-    File.new("#{@workspace}/.canoe", "w")
-    DefaultFiles.create_config @workspace, @source_suffix, @header_suffix
-    DefaultFiles.create_emacs_dir_local @workspace
-
-    Dir.mkdir(@third)
-    Dir.mkdir(@target)
-    puts "workspace #{@workspace} is created"
-  end
-
-  # args are commandline parameters passed to `canoe build`    
-  def build(args)
-    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?
-      puts "nothing to do, all up to date"
-      return
-    end
-    
-    self.send "build_#{@mode.to_s}", files, args 
-  end
-
-  def generate
-    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
-               .build_to_file ['./src', './src/components'], @deps
-  end
-
-  def update
-    generate
-  end
-
-  def clean
-    self.send "clean_#{@mode.to_s}"
-  end
-
-  def run(args)
-    return if @mode == :lib
-    build []
-    args = args.join " "
-    puts "./target/#{@name} #{args}"
-    exec "./target/#{@name} #{args}"
-  end
-
-  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
-            create_working_files prefix.join('__'), filename
-          end
-        end
-      end
-    end
-  end
-
-  def dep
-    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
-    deps.each do |k, v|
-      unless v.empty?
-        puts "#{k} depends on: "
-        v.each {|f| puts "    #{f}"}
-        puts ""
-      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
-
-  def build_compiler_from_config(args)
-    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'] + args
-      
-      if opts = flags['flags'] 
-        opts.each do |k, v|
-          case v
-          when String
-            compiler_flags << v
-          when Array
-            v.each do |o|
-              compiler_flags << o
-            end
-          else
-            abort_on_err "unknown options in config.json, #{v}"
-          end
-        end
-      end
-
-      @compiler = Compiler.new compiler_name, compiler_flags
-    end
-  end
-
-  def compile(f, o)
-    @compiler.compile f, o
-  end
-
-  def link_exectutable(odir, objs)
-    @compiler.link_executable "#{odir}/#{@name}", objs
-  end
-
-  def link_shared(odir, objs)
-    @compiler.link_shared "#{odir}/lib#{@name}", objs
-  end
-
-  def build_bin(files, args)
-    return if files.empty?
-    build_compiler_from_config args
-    build_common files, args
-    link_exectutable('./target', Dir.glob("obj/*.o"))
-  end
-
-  def build_lib(files, args)
-    return if files.empty?
-    build_compiler_from_config args
-    @compiler.append_flag '-fPIC'
-    build_common files, args
-    link_shared('./target', Dir.glob("obj/*.o"))
-  end
-
-  def build_common(files, args)
-    comps = files.select {|f| f.start_with? @components_prefix}
-    srcs = files - comps
-    
-    srcs.each do |f|
-      puts "compiling #{f}"
-      fname = f.split("/")[-1]
-      o = @obj_prefix + fname.delete_suffix(File.extname(fname)) + '.o'
-      compile f, o
-    end
-    
-    comps.each do |f|
-      puts "compiling #{f}"
-      o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
-                         .gsub('/', '_') + '.o'
-      compile f, o
-    end
-  end
-
-  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
-
-  public
-  def inspect 
-    puts "name is #{@name}"
-    puts "name is #{@workspace}"
-  end
-end