canoe 0.3.2.1 → 0.3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f216d0dc37bc62674772eb685e40bae7859af341e75f3b67e4f9327030ad3483
-  data.tar.gz: 28c69b2037f47926b86a5f927ff0398f6122a30adb725ce0e5830dea81acf549
+  metadata.gz: 50752029532b56ce10a610ae7d9705212a1c424533ed2fde71a3133505c11d0e
+  data.tar.gz: 501d882198eb59157961a741d786dbbe5c420e9d2704d37e7b1ca9a0f651854a
 SHA512:
-  metadata.gz: 110c69c11e3be4d7d38e23cb2d83680fd4677f5537f5448fba4a5d68999e5e1727794d9c857ccb290a628e6c4586c22a68c8ee73799f7ecf1e58ffa9dd1ea351
-  data.tar.gz: 05a9808ee35431a874a932c36af3b6ab3d5f0734a04fd2ed70aa9d18ac2a4d3c211340142f722acee9dea997030b80c5e34e77491c6a387ab1bad74936529e7e
+  metadata.gz: 2da665d3e3ce5e073a207863fc2cc2f06a892d9e7889d3e0e29617c673c01d5aa503854c5effb80b34989b3cdf9743a1b8ada49c537920ba06f5ec1e5cd836c0
+  data.tar.gz: 9d13815277a02e41a894cee4528c3742d35a6e81cbc84828a0f8dc857aae1c7356de4cc05511ca9145a2f4d2912315955746541bd47d35d949c38863d1ddecf7

data/lib/cmd.rb

@@ -53,31 +53,38 @@ module Canoe
         abort_on_err "it's not reasonable to add a component with no name given"
       end
 
-      get_current_workspace.add args
+      current_workspace.add args
     end
 
     def parse_build(args)
-      get_current_workspace.build args
+      options = {[] => 'target', ['all'] => 'all', ['test'] => 'test', ['base'] => 'base'}
+      abort_on_err "Unkown subcommand #{args.join(" ").red}" unless options.include?(args)
+      current_workspace.build options[args]
     end
 
     def parse_generate(args)
-      get_current_workspace.generate
+      current_workspace.generate
     end
 
     def parse_run(args)
-      get_current_workspace.run args
+      current_workspace.run args
     end
 
     def parse_dep(args)
-      get_current_workspace.dep
+      current_workspace.dep
     end
 
     def parse_clean(args)
-      get_current_workspace.clean args
+      options = {
+        [] => 'all', ['all'] => 'all',
+        ['target'] => 'target', ['tests'] => 'tests', ['obj'] => 'obj'
+      }
+      abort_on_err "Unkown subcommand #{args.join(" ").red}" unless options.include?(args)
+      current_workspace.clean options[args]
     end
 
     def parse_test(args)
-      get_current_workspace.test args
+      current_workspace.test args
     end
 
     def parse_version(args)
@@ -89,11 +96,11 @@ module Canoe
     end
 
     def parse_update(args)
-      get_current_workspace.update
+      current_workspace.update
     end
 
     def parse_make(args)
-      get_current_workspace.make
+      current_workspace.make
     end
   end
 end

data/lib/default_files.rb

@@ -10,19 +10,18 @@ class DefaultFiles
       end
     end
 
-    def create_config(path, src_sfx = 'cpp', hdr_sfx = 'hpp')
+    def create_config(path, compiler = 'clang++', src_sfx = 'cpp', hdr_sfx = 'hpp')
       open_file_and_write(
         "#{path}/config.json",
         <<~CONFIG
           {
-              "compiler": "clang++",
+              "compiler": "#{compiler}",
               "header-suffix": "#{hdr_sfx}",
               "source-suffix": "#{src_sfx}",
               "flags": {
                   "compile": {
                       "opt": "-O2",
-                      "debug": "-g",
-                      "std": "-std=c++17"
+                      "debug": "-g"
                   },
                   "link": {
 
@@ -34,12 +33,13 @@ class DefaultFiles
     end
 
     def create_main(path, suffix = 'cpp')
+      header = suffix == 'c' ? 'stdio.h' : 'iostream'
       open_file_and_write(
         "#{path}/main.#{suffix}",
         <<~DOC
-          #include <iostream>
+          #include <#{header}>
           int main(int argc, char *argv[]) {
-              std::cout << "hello world!" << std::endl;
+
           }
         DOC
       )

data/lib/util.rb

@@ -1,6 +1,9 @@
 require_relative 'coloring'
 
 module Canoe
+  ##
+  # Stepper record the progress of a task
+  # progress is obtained via #'progress_as_str
   class Stepper
     def initialize(total, togo)
       @total = total.to_f
@@ -16,11 +19,11 @@ module Canoe
       @togo -= 1 if @togo.positive?
     end
   end
-  
+
   ##
   # wrapping workspace related functionality to expose to other modules
   module WorkSpaceUtil
-    def get_current_workspace
+    def current_workspace
       abort_on_err 'not in a canoe workspace' unless File.exist? '.canoe'
       config = ConfigReader.extract_flags('config.json')
 
@@ -34,23 +37,23 @@ module Canoe
     end
 
     def src_to_obj(src)
-      get_current_workspace.src_to_obj(src)
+      current_workspace.src_to_obj(src)
     end
 
     def comp_to_obj(comp)
-      get_current_workspace.comp_to_obj(comp)
+      current_workspace.comp_to_obj(comp)
     end
 
     def file_to_obj(file)
-      get_current_workspace.file_to_obj(file)
+      current_workspace.file_to_obj(file)
     end
 
     def extract_one_file(file, deps)
-      get_current_workspace.extract_one_file(file, deps)
+      current_workspace.extract_one_file(file, deps)
     end
 
     def extract_one_file_obj(file, deps)
-      get_current_workspace.extract_one_file_obj(file, deps)
+      current_workspace.extract_one_file_obj(file, deps)
     end
   end
 

data/lib/workspace/build.rb

@@ -1,3 +1,4 @@
+require 'json'
 module Canoe
   class WorkSpace
     def src_to_obj(src)
@@ -18,14 +19,9 @@ module Canoe
     end
 
     # args are commandline parameters passed to `canoe build`,
-    # could be 'all', 'test', 'target' or empty
-    def build(args)
-      options = {[] => 'target', ['all'] => 'all', ['test'] => 'test'}
-      if options.include?(args)
-        send "build_#{options[args]}"
-      else
-        abort_on_err "Unkown subcommand #{args.join(" ").red}"
-      end
+    # could be 'all', 'test', 'target', 'base' or empty
+    def build(arg = 'target')
+      send "build_#{arg}"
     end
 
     private
@@ -132,10 +128,9 @@ module Canoe
 
     def build_target
       puts "#{'[BUILDING TARGET]'.magenta}..."
-      deps = get_deps @deps, @src, [@src_short, @components_short]
       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 
+      files = DepAnalyzer.compiling_filter target_deps, build_time, @source_suffix, @header_suffix 
 
       build_compiler_from_config
 
@@ -146,5 +141,50 @@ module Canoe
 
       self.send "build_#{@mode.to_s}", files
     end
+
+    # generate a compile_commands.json file
+    def build_base
+      deps = target_deps.merge tests_deps
+      build_compiler_from_config
+      database = CompilationDatabase.new
+      deps.each_key do |k|
+        next if k.end_with? @header_suffix
+        c = @compiler.name.end_with?('++') ? 'c++' : 'c'
+
+        arg =  [c] + @compiler.compiling_flags_as_str.split + [k] + [file_to_obj(k)] + ['-c', '-o']
+        database.add_command_object(@workspace, arg, k)
+      end
+      File.open('compile_commands.json', 'w') do |f|
+        f.puts database.pretty_to_s
+      end
+    end
+  end
+
+  class CompilationDatabase
+    attr_reader :database
+    def initialize
+      @database = []
+    end
+
+    def add_command_object(dir, arguments, file)
+      temp = {             
+        "arguments" => arguments,
+        "directory" => dir,
+        "file" => file
+      }
+      @database << temp
+    end
+
+    def to_s
+      @database.to_s
+    end
+
+    def pretty_to_s
+      JSON.pretty_generate(@database)
+    end
+
+    def to_json
+      @database.to_json
+    end
   end
 end

data/lib/workspace/clean.rb

@@ -1,16 +1,8 @@
 module Canoe
   class WorkSpace
     # valid options: none, 'all', 'target', 'tests'
-    def clean(args)
-      options = {
-        [] => 'all', ['all'] => 'all',
-        ['target'] => 'target', ['tests'] => 'tests', ['obj'] => 'obj'
-      }
-      if options.include?(args)
-        send "clean_#{options[args]}"
-      else
-        abort_on_err "Unkown subcommand #{args.join(' ').red}"
-      end
+    def clean(arg = 'all')
+      send "clean_#{arg}"
     end
 
     private

data/lib/workspace/make.rb

@@ -1,6 +1,8 @@
 # If the project has circular dependency, this command would fail
 module Canoe
-  class Makefile
+  ##
+  # CanoeMakefile is used to offer makefile generation utilities
+  class CanoeMakefile
     include WorkSpaceUtil
     def initialize(workspace)
       @workspace = workspace
@@ -208,25 +210,23 @@ module Canoe
 
     def make_obj_rules(makefile, deps)
       cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
-      makefile.puts("all: OUT\n")
-      makefile.puts ''
 
       @all_names.each do |n|
-        makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ -c $(SRC_#{n})")
-        makefile.puts ''
+        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)")
+        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)")
+        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)
@@ -256,10 +256,9 @@ module Canoe
     def make_rules(makefile, deps)
       make_dependencies makefile, deps
       makefile.puts ''
-      make_obj_rules 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
@@ -272,7 +271,7 @@ module Canoe
 
       deps = target_deps.merge tests_deps
 
-      makefile = Makefile.new self
+      makefile = CanoeMakefile.new self
       makefile.configure config
       makefile.make! deps
     end

data/lib/workspace/new.rb

@@ -15,8 +15,8 @@ module Canoe
         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
+      compiler = @source_suffix == 'c' ? 'clang' : 'clang++'
+      DefaultFiles.create_config @workspace, compiler, @source_suffix, @header_suffix
 
       Dir.mkdir(@third)
       Dir.mkdir(@target)

data/lib/workspace/run.rb

@@ -3,7 +3,7 @@ module Canoe
     def run(args)
       return if @mode == :lib
 
-      return unless build []
+      return unless build
       
       args = args.join ' '
       issue_command "#{@target_short}/#{@name} #{args}"

data/lib/workspace/version.rb

@@ -2,7 +2,7 @@ module Canoe
   class WorkSpace
     def self.version
       puts <<~VER
-           canoe v0.3.2.1
+           canoe v0.3.2.2
            For features in this version, please visit https://github.com/Dicridon/canoe
            Currently, canoe can do below:
                - project creation

data/lib/workspace/workspace.rb

@@ -11,6 +11,8 @@ module Canoe
   ##
   # A workspace resents a C/C++ project
   # This class is responsible for the main functionality of canoe, such as building and cleaning
+  # TODO
+  #   add a command to generate compile_commands.json so users won't have to install bear
   class WorkSpace
     include Err
     include SystemCommand

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.3.2.1
+  version: 0.3.2.2
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.