canoe 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9763386960dfa876185c776041f832de8e6ff3fc050327fc8c616a02467137
-  data.tar.gz: fde0dde4b2c9fc3a360a2bf91f2eb6828439cea7ea15d88790bae382abebbad7
+  metadata.gz: 6e9bebbc3472c5f6271c4c019f23bf18779492934ed86411f4d09384e51bfeab
+  data.tar.gz: 9aa82b75a58e0992653ddc5419bf14e129846cc54cc9358f08baa1d2014d8d5a
 SHA512:
-  metadata.gz: 9fd27c0889f66c239c0c305b7554418c3afe9b40bf7a1d6eaa3eb9e76e13247dcec8ddee48aeb58dfbfc8995f13ac05dd63de36837d680c87c6dbbf932b657b2
-  data.tar.gz: 27655015444a90c232c398b8f7e02d4dfb454769d68086e4dcaa7039f41bae8cee33968cce105cf36ab92bde0b10464251e79b5443385f2f5598aa6ce593b054
+  metadata.gz: fd9be9cc303239eaa9853c177501e460023279a6385094afbe79e55b912257cebe72860633b53503dff96583a61aa88ea6034ce0e741e36f4fce8acce33c2496
+  data.tar.gz: 6ee389790c8490d80ef9742e877fc0de8b13b6b74629361e68f363155c628a0dff1764d066f4608b0b7e7cef72f20b1775c2b214be487b4bdcf943ab1b985c3f

data/lib/compiler.rb

@@ -18,12 +18,18 @@ class Compiler
     system "#{name} -o #{out} #{flags_as_str} -c #{src}"
   end
 
-  def link(out, objs)
+  def link_executable(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(" ")}"
   end
 
+  def link_shared(out, objs)
+    libs = flags.select {|f| f.start_with?('-l')}
+    puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
+    system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
+  end
+  
   def inspect
     puts "compiler name: #{name.inspect}"
     puts "compiler flags: #{flags.inspect}"

data/lib/default_files.rb

@@ -35,6 +35,18 @@ class DefaultFiles
     )
   end
 
+  def self.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_emacs_dir_local(path)
     open_file_and_write(
       "#{path}/.dir-locals.el",
@@ -52,7 +64,7 @@ class DefaultFiles
       "#{filename}.#{src_sfx}", 
       <<~DOC
                 #include "#{filename}.#{hdr_sfx}"
-            DOC
+      DOC
     )
   end
 

data/lib/workspace.rb

@@ -18,7 +18,9 @@ class WorkSpace
                 
                 canoe build: compile current project (execute this command in project directory)
 
-                canoe generate: generate dependency relationship and store it in '.canoe.deps'
+                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)
                 
@@ -27,7 +29,8 @@ class WorkSpace
                 canoe help: show this help message
 
                 canoe add tada: add a folder named tada under workspace/components,
-                                two files tada.hpp and tada.cpp would be craeted and intialized
+                
+                canoe dep: show current dependency relationships of current project
                 
                 canoe verion: version information
 
@@ -38,11 +41,21 @@ class WorkSpace
 
                 [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
@@ -95,7 +108,11 @@ class WorkSpace
     Dir.mkdir(@src)
     Dir.mkdir(@components)
     Dir.mkdir("#{@workspace}/obj")
-    DefaultFiles.create_main(@src, @source_suffix) if @mode == :bin
+    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
@@ -136,6 +153,7 @@ class WorkSpace
   end
 
   def run(args)
+    return if @mode == :lib
     build []
     args = args.join " "
     puts "./target/#{@name} #{args}"
@@ -208,18 +226,30 @@ class WorkSpace
     @compiler.compile f, o
   end
 
-  def link(odir, objs)
-    status = system "#{@compiler} -o #{odir}/#{@name} #{objs.join(" ")}"
-    unless status
-      puts "compilation failed"
-      return
-    end
-    
-    @compiler.link "#{odir}/#{@name}", objs
+  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
     
@@ -236,12 +266,6 @@ class WorkSpace
                          .gsub('/', '_') + '.o'
       compile f, o
     end
-    
-    link('./target', Dir.glob("obj/*.o")) unless files.empty?
-  end
-
-  def build_lib
-    puts "build a lib"
   end
 
   def clean_obj

metadata

@@ -1,19 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies: []
-description: |
-  Tired of writing Makefile, CMakeList and even SConstruct? Let Canoe help you wipe them out.
+description: |+
+  Canoe offers project management and building facilities to C/C++ projects.
+
+  If you are tired of writing Makefile, CMakeList and even SConstruct, please let Canoe help you wipe them out.
+
   Similar to Cargo for Rust, Canoe offers commands such as new, build, run, etc. to help you generate a C/C++ project and build it automatically.
-  No more Makefiles, Canoe would analyze dependencies and build like our old friend make if you follow a few conventions over file names
+
+  Different from tools like Scons and Blade, Canoe requires users to write NO building scripts, Canoe would analyze dependencies and build like our old friend 'make' if a few conventions over file names are followed.
+
 email: noahxiong@outlook.com
 executables:
 - canoe
@@ -52,5 +57,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: a C/C++ project management and build tool
+summary: a C/C++ project management and building tool
 test_files: []