canoe 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9763386960dfa876185c776041f832de8e6ff3fc050327fc8c616a02467137
-  data.tar.gz: fde0dde4b2c9fc3a360a2bf91f2eb6828439cea7ea15d88790bae382abebbad7
+  metadata.gz: af31768c0b36d635c13ff31e41dc772dd9834ccd2d52e791f399053ebb3b9782
+  data.tar.gz: 135f95f9631bcc43c4817833ee9a6075b1d336239b9131c8f5f26d3f0006cd3b
 SHA512:
-  metadata.gz: 9fd27c0889f66c239c0c305b7554418c3afe9b40bf7a1d6eaa3eb9e76e13247dcec8ddee48aeb58dfbfc8995f13ac05dd63de36837d680c87c6dbbf932b657b2
-  data.tar.gz: 27655015444a90c232c398b8f7e02d4dfb454769d68086e4dcaa7039f41bae8cee33968cce105cf36ab92bde0b10464251e79b5443385f2f5598aa6ce593b054
+  metadata.gz: 9c82734822d59c1cd1a119dcc55f954f3d6b971457f44df22c8e9f6eceaa638c503816a1f05dc54019ea8ded2c70f1431e26cab0c057db3cd4ee2775dc12583c
+  data.tar.gz: 9b23406264a260e2b715018f5ad275c6a8b9293d712fd4d7623b03709fa5d93ee03cbc916472d9b24e9e6e1d4e2dd83e6781903ca7987febc4ec28a3e92e0ce5

data/bin/canoe

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# require_relative '../lib/canoe'
 require 'canoe'
 
 Canoe.new.parse ARGV

data/lib/canoe.rb

@@ -1,23 +1,25 @@
-require_relative "workspace"
+require_relative "workspace/workspace.rb"
 require_relative "cmd"
 require_relative "source_files"
 
 class Canoe
   def initialize
-    options = ['new', 
-               'add',
-               'build',
-               'generate',
-               'run',
-               'dep',
-               'clean',
-               'version',
-               'help',
-               'update']
+    options = ["new",
+               "add",
+               "build",
+               "generate",
+               "make",
+               "run",
+               "dep",
+               "clean",
+               "version",
+               "help",
+               "update",
+               "test"]
     @cmd = CmdParser.new options
   end
 
   def parse(args)
-      @cmd.parse args
+    @cmd.parse args
   end
 end

data/lib/cmd.rb

@@ -1,16 +1,20 @@
-require_relative "workspace"
+require_relative "workspace/workspace"
 require_relative "err"
 require_relative "config_reader"
 
+##
+# class CmdParser
+#   Parsing command arguments passed to canoe
 class CmdParser
   include Err
+
   def initialize(options)
-    @options = options 
+    @options = options
   end
 
   def parse(args)
-    if args.size < 1 
-      abort_on_err "please give one command among #{@options.join(', ')}"
+    if args.size < 1
+      abort_on_err "please give one command among #{@options.join(", ")}"
     end
 
     unless @options.include?(args[0])
@@ -21,6 +25,7 @@ class CmdParser
   end
 
   private
+
   def get_current_workspace
     abort_on_err "not in a canoe workspace" unless File.exists? ".canoe"
     config = ConfigReader.extract_flags("config.json")
@@ -31,7 +36,7 @@ class CmdParser
     name = Dir.pwd.split("/")[-1]
     mode = File.exists?("src/main.#{src_sfx}") ? :bin : :lib
 
-    Dir.chdir('..') do
+    Dir.chdir("..") do
       return WorkSpace.new(name, mode, src_sfx, hdr_sfx)
     end
   end
@@ -41,10 +46,10 @@ class CmdParser
 
     name, mode = nil, "bin"
     suffixes = ["cpp", "hpp"]
-    
+
     args.each do |arg|
       case arg
-      when '--bin', '--lib'
+      when "--bin", "--lib"
         mode = arg[2..]
       when /--suffix=(\w+)\:(\w+)/
         suffixes[0], suffixes[1] = $1, $2
@@ -52,7 +57,7 @@ class CmdParser
         name = arg unless name
       end
     end
-    
+
     abort_on_err("please give a name to this project") unless name
     WorkSpace.new(name, mode.to_sym, suffixes[0], suffixes[1]).new
   end
@@ -64,7 +69,7 @@ class CmdParser
 
     get_current_workspace.add args
   end
-  
+
   def parse_build(args)
     get_current_workspace.build args
   end
@@ -72,31 +77,35 @@ class CmdParser
   def parse_generate(args)
     get_current_workspace.generate
   end
-  
+
   def parse_run(args)
     get_current_workspace.run args
   end
 
   def parse_dep(args)
-    get_current_workspace.dep 
+    get_current_workspace.dep
   end
-  
+
   def parse_clean(args)
     get_current_workspace.clean
   end
 
+  def parse_test(args)
+    get_current_workspace.test args
+  end
+
   def parse_version(args)
     puts <<~VER
-        canoe v0.2.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
+           canoe v0.3.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
-  
+
   def parse_help(args)
     WorkSpace.help
   end
@@ -104,4 +113,8 @@ class CmdParser
   def parse_update(args)
     get_current_workspace.update
   end
+
+  def parse_make(args)
+    get_current_workspace.make
+  end
 end

data/lib/coloring.rb

@@ -0,0 +1,23 @@
+##
+# gem Colorize is a great tool, but I don't want add dependencies to Canoe
+class String
+  def self.define_coloring_methods
+    colors = {
+      30 => :black,
+      31 => :red,
+      32 => :green,
+      33 => :yellow,
+      34 => :blue,
+      35 => :magenta,
+      36 => :cyan,
+      37 => :white,
+    }
+    colors.each do |k, v|
+      define_method v do
+        "\033[#{k}m#{self}\033[0m"
+      end
+    end
+  end
+
+  define_coloring_methods
+end

data/lib/compiler.rb

@@ -1,27 +1,46 @@
+##
+# class Compiler
+#   Storing compiler name in String and flags as an array
 class Compiler
   attr_reader :name, :flags
-  def initialize(name, flgs)
+  ##
+  # @name: String
+  # @flgs: Array of String
+  def initialize(name, compiling_flags, linking_flags)
     @name = name
-    @flags = flgs
+    @linking_flags = linking_flags
+    @compiling_flags = compiling_flags
   end
 
-  def flags_as_str
-    flags.join " "
+  def compiling_flags_as_str
+    @compiling_flags.join " "
   end
 
-  def append_flag(flag)
-    @flags << flag
+  def linking_flags_as_str
+    @linking_flags.join " "
+  end
+
+  def append_compiling_flag(flag)
+    @compiling_flags << flag
+  end
+
+  def append_linking_flag(flag)
+    @linking_flags << flag
   end
 
   def compile(src, out)
-    puts "#{name} -o #{out} #{flags_as_str} -c #{src}"
-    system "#{name} -o #{out} #{flags_as_str} -c #{src}"
+    puts "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
+    system "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
+  end
+
+  def link_executable(out, objs)
+    puts "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
+    system "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
   end
 
-  def link(out, objs)
-    libs = flags.select {|f| f.start_with?('-l')}
-    puts "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
-    system "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
+  def link_shared(out, objs)
+    puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
+    system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
   end
 
   def inspect

data/lib/config_reader.rb

@@ -1,5 +1,8 @@
-require 'json'
+require "json"
 
+##
+# class ConfigReader
+#   Just read a json file
 class ConfigReader
   def self.extract_flags(file)
     abort_on_err("config file #{file} does not exsit") unless File.exists? file

data/lib/default_files.rb

@@ -1,70 +1,98 @@
+##
+# class DefaultFiles
+#   A singleton class to generate header and souce files.
+#   TODO: consider using class source_file.rb in Pareater
 class DefaultFiles
-  def self.open_file_and_write(filename, content)
-    File.open(filename, "w") {|f|
-      f.write(content)
-    }
-  end
+  class << self
+    def open_file_and_write(filename, content)
+      File.open(filename, "w") do |f|
+        f.write(content)
+      end
+    end
 
-  def self.create_config(path, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{path}/config.json", 
-      <<~CONFIG
-        {
-            "compiler": "clang++",
-            "header-suffix": "#{hdr_sfx}",
-            "source-suffix": "#{src_sfx}",
-            "flags": {
-                "opt": "-O2",
-                "debug": "-g",
-                "std": "-std=c++17"
-            }
-        }
-      CONFIG
-    )
-  end
+    def create_config(path, src_sfx = "cpp", hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{path}/config.json",
+        <<~CONFIG
+          {
+              "compiler": "clang++",
+              "header-suffix": "#{hdr_sfx}",
+              "source-suffix": "#{src_sfx}",
+              "flags": {
+                  "compile": {
+                      "opt": "-O2",
+                      "debug": "-g",
+                      "std": "-std=c++17"
+                  },
+                  "link": {
+                    
+                  }
+              }
+          }
+        CONFIG
+      
+)
+    end
 
-  def self.create_main(path, suffix='cpp')
-    open_file_and_write(
-      "#{path}/main.#{suffix}",
-      <<~DOC
-        #include <iostream>
-        int main(int argc, char *argv[]) {
-            std::cout << "hello world!" << std::endl;
-        }
-      DOC
-    )
-  end
+    def create_main(path, suffix = "cpp")
+      open_file_and_write(
+        "#{path}/main.#{suffix}",
+        <<~DOC
+          #include <iostream>
+          int main(int argc, char *argv[]) {
+              std::cout << "hello world!" << std::endl;
+          }
+        DOC
+      
+)
+    end
 
-  def self.create_emacs_dir_local(path)
-    open_file_and_write(
-      "#{path}/.dir-locals.el",
-      <<~DOC
-        ((nil . ((company-clang-arguments . ("-I./src/components/"
-                                             "-I./components/"))))
-         (nil . ((company-c-headers-path-user . ("./src/components/"
-                                 "./components/")))))
-      DOC
-    )
-  end
+    def create_lib_header(path, lib_name, suffix = "hpp")
+      open_file_and_write(
+        "#{path}/#{lib_name}.#{suffix}",
+        <<~DOC
+          #ifndef __#{lib_name.upcase}__
+          #define __#{lib_name.upcase}__
+         
+          #endif
+        DOC
+      
+)
+    end
 
-  def self.create_cpp(filename, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{src_sfx}", 
-      <<~DOC
-                #include "#{filename}.#{hdr_sfx}"
-            DOC
-    )
-  end
+    # def create_emacs_dir_local(path)
+    #   open_file_and_write(
+    #     "#{path}/.dir-locals.el",
+    #     <<~DOC
+    #       ((nil . ((company-clang-arguments . ("-I./src/components/"
+    #                                            "-I./components/"))))
+    #        (nil . ((company-c-headers-path-user . ("./src/components/"
+    #                                "./components/")))))
+    #     DOC
+    #   )
+    # end
 
-  def self.create_hpp(workspace, prefix, filename, hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{hdr_sfx}",
-      <<~DOC
-        #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
-        #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+    def create_cpp(filename, src_sfx = "cpp", hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{filename}.#{src_sfx}",
+        <<~DOC
+          #include "#{filename}.#{hdr_sfx}"
+        DOC
+      
+)
+    end
 
-        #endif
-      DOC
-    )
+    def create_hpp(workspace, prefix, filename, hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{filename}.#{hdr_sfx}",
+        <<~DOC
+          #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          
+          #endif
+        DOC
+      
+)
+    end
   end
 end

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