c_project 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 549cd23c32d308b17666fa8ee6ec6fe8fcb42ef9
-  data.tar.gz: 98eb91295947c019418a6877a638719f5cfbfea5
+  metadata.gz: 8f077249f45ad2c626eccf6af687d6279f4263fc
+  data.tar.gz: ebe32b2737e48ad6b8225a6f6b8e095046fb5fa2
 SHA512:
-  metadata.gz: 405c0e7c9f291c79eeae4a22b3648668ec7447831bc90ecfedbdb3245c6a13d10199e7773fea61ce4d9100bb7096843fd77d0344b6cf25e48904b516514c5c3d
-  data.tar.gz: 81d5a0e89256c082fa56c2531e8ef435bab56928cde86ffa0e8f11c2339cad85fbeed018a31e35a1084af064f53d7988f07231d56c677a5b492d300b08bca502
+  metadata.gz: 626f3eeed41a89e0cf5abd99962999fe9fc4c25306b39f9ab7ccb284aa8536e98542c1b7e5ca0238dfffb26239bf4d5622931700bf5705f2844261af06ba2590
+  data.tar.gz: 97c8ebd7531a73910f737bb79048b0347800a35dac8224ef82d92dd6bf34912ee2579c65675d731225d13a7c9be63575ce002402dc4a109f32b643e0ef249863

data/bin/c_project

@@ -4,7 +4,7 @@ require 'thor'
 require 'date'
 
 module CProject
-  class New < Thor::Group
+  class NewProject < Thor::Group
     include Thor::Actions
 
     argument :name, :desc => 'Name of the new project.'
@@ -18,20 +18,46 @@ module CProject
     end
 
     def fill_root
-      create_file_from_template "LICENCE"
+      empty_directory file_path('bin')
+      empty_directory file_path('experiments')
+      empty_directory file_path('scripts')
+      create_file_from_shared_template "LICENCE"
+    end
+
+    private
+
+    def header_guard
+      "__#{name.upcase}_H__"
+    end
+
+    def file_path(file_name)
+      File.join name, file_name
+    end
+
+    def create_file_from_shared_template(file_name)
+      template(
+        "templates/#{file_name}.tt",
+        file_path(file_name)
+      )
+    end
+  end
+
+  class C < NewProject
+    def fill_root
+      super
       create_file_from_template "README.md"
       create_file_from_template "Makefile"
     end
 
     def src
       create_file_from_template 'src/CExceptionConfig.h'
-      template 'templates/src/c_project.c.tt', file_path("src/#{name}.c")
-      template 'templates/src/c_project.h.tt', file_path("src/#{name}.h")
+      template 'templates/c/src/c_project.c.tt', file_path("src/#{name}.c")
+      template 'templates/c/src/c_project.h.tt', file_path("src/#{name}.h")
       create_file_from_template 'src/main.c'
     end
 
     def test
-      template 'templates/test/test_c_project.c.tt', file_path("test/test_#{name}.c")
+      template 'templates/c/test/test_c_project.c.tt', file_path("test/test_#{name}.c")
     end
 
     def support
@@ -40,37 +66,99 @@ module CProject
     end
 
     def vendor
-      directory 'templates/vendor', file_path("vendor")
+      directory 'templates/c/vendor', file_path("vendor")
+      directory 'templates/commander.c', file_path('vendor/commander.c')
     end
 
     private
 
-    def header_guard
-      "__#{name.upcase}_H__"
+    def create_file_from_template(file_name)
+      template(
+        "templates/c/#{file_name}.tt",
+        file_path(file_name)
+      )
     end
 
-    def file_path(file_name)
-      File.join name, file_name
+    def extension
+      'c'
     end
 
+    def compiler
+      'CC'
+    end
+  end
+
+  class Cpp < Thor::Group
+    include Thor::Actions
+
+    argument :name, :desc => 'Name of the new project.'
+
+    def self.source_root
+      File.expand_path('../../', __FILE__)
+    end
+
+    def fill_root
+      super
+      create_file_from_template "README.md"
+      create_file_from_template "Makefile"
+    end
+
+    # @todo
+    # def src
+    #   create_file_from_template 'src/CExceptionConfig.h'
+    #   template 'templates/src/c_project.c.tt', file_path("src/#{name}.c")
+    #   template 'templates/src/c_project.h.tt', file_path("src/#{name}.h")
+    #   create_file_from_template 'src/main.c'
+    # end
+
+    # def test
+    #   template 'templates/test/test_c_project.c.tt', file_path("test/test_#{name}.c")
+    # end
+
+    # def support
+    #   create_file_from_template 'test/support/test_helper.c'
+    #   create_file_from_template 'test/support/test_helper.h'
+    # end
+
+    # def vendor
+    #   directory 'templates/vendor', file_path("vendor")
+    # end
+
+    private
+
     def create_file_from_template(file_name)
       template(
-        "templates/#{file_name}.tt",
+        "templates/cpp/#{file_name}.tt",
         file_path(file_name)
       )
     end
+
+    def extension
+      'cpp'
+    end
+
+    def compiler
+      'CCPP'
+    end
   end
 
   class CProject < Thor
-    map 'n' => :new
-
     register(
-      New,
-      'new',
-      'new NAME',
+      C,
+      'c',
+      'c NAME',
       "Creates a new C project the name NAME"
     )
-    tasks["new"].options = New.class_options
+    tasks["c"].options = C.class_options
+
+    # @todo
+    # register(
+    #   Cpp,
+    #   'c++',
+    #   'c++ NAME',
+    #   "Creates a new C++ project the name NAME"
+    # )
+    # tasks["c++"].options = Cpp.class_options
   end
 end
 

data/lib/c_project/version.rb

@@ -1,3 +1,3 @@
 module CProject
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/templates/c/Makefile.tt

@@ -0,0 +1,150 @@
+# More precise but typically not necessary and more verbose
+#THIS_DIR := $(CURDIR)/$(dir $(lastword $(MAKEFILE_LIST)))
+THIS_DIR := ./
+
+# Project definitions
+#====================
+TARGET_BASE = <%= name %>
+TARGET := $(THIS_DIR)/bin/$(TARGET_BASE)
+default: $(TARGET)
+
+OBJ_DIR = $(THIS_DIR)/obj
+$(OBJ_DIR):
+	-mkdir $(THIS_DIR)/obj
+
+SRC_DIR := $(THIS_DIR)/src
+SRC_INCLUDES := -I$(SRC_DIR)
+
+# Compiler definitions
+#======================
+CC = gcc -std=gnu99
+CCPP = g++ -std=gnu++0x
+
+COMPILER := $(<%= compiler %>)
+
+DEBUG_SYMBOLS = -g
+
+TO_OBJ = -c
+
+TO_FILE = -o
+
+# Preprocess out asserts
+NO_ASSERTS = -DNDEBUG
+
+# Enable print log
+PRINT_LOG = -DPRINTLOG
+
+OPTIMIZATION = -O1
+
+WARNINGS = -Wall
+
+CEXCEPTION_CONFIGURATION = -DCEXCEPTION_USE_CONFIG_FILE
+
+# CC options concatenated together
+FLAGS := $(WARNINGS) $(DEBUG_SYMBOLS) $(OPTIMIZATION) $(PRINT_LOG) $(CEXCEPTION_CONFIGURATION)
+
+LIBS = -lm
+
+# Vendor definitions
+#=======================
+VENDOR_DIR := $(THIS_DIR)/vendor/
+
+# Commander
+#----------
+COMMANDER_SRC_DIR := $(VENDOR_DIR)/commander.c/src
+COMMANDER_INCLUDES := -I$(COMMANDER_SRC_DIR)
+COMMANDER_SRC := $(COMMANDER_SRC_DIR)/commander.c
+COMMANDER_OBJ := $(OBJ_DIR)/commander.o
+$(COMMANDER_OBJ): $(COMMANDER_SRC) $(OBJ_DIR)
+	$(CC) $(TO_OBJ) $(FLAGS) $(TO_FILE) $@ $< $(COMMANDER_INCLUDES)
+
+# CException
+#-----------
+CEXCEPTION_SRC_DIR := $(VENDOR_DIR)/cexception/lib
+CEXCEPTION_INCLUDES := -I$(CEXCEPTION_SRC_DIR)
+CEXCEPTION_SRC := $(CEXCEPTION_SRC_DIR)/CException.c
+CEXCEPTION_OBJ := $(OBJ_DIR)/CException.o
+$(CEXCEPTION_OBJ): $(CEXCEPTION_SRC) $(OBJ_DIR)
+	$(CC) $(TO_OBJ) $(FLAGS) $(TO_FILE) $@ $< $(CEXCEPTION_INCLUDES) $(SRC_INCLUDES)
+
+# Timer
+#-----------
+TIMER_SRC_DIR := $(VENDOR_DIR)/timer/src
+TIMER_INCLUDES := -I$(TIMER_SRC_DIR)
+TIMER_SRC := $(TIMER_SRC_DIR)/timer.c
+TIMER_OBJ := $(OBJ_DIR)/timer.o
+$(TIMER_OBJ): $(TIMER_SRC) $(OBJ_DIR)
+	$(CC) $(TO_OBJ) $(FLAGS) $(TO_FILE) $@ $< $(TIMER_INCLUDES) $(SRC_INCLUDES)
+
+
+# Concatenated includes and objects
+#----------------------------------
+VENDOR_INCLUDES := $(COMMANDER_INCLUDES) $(CEXCEPTION_INCLUDES) $(TIMER_INCLUDES)
+VENDOR_OBJS := $(COMMANDER_OBJ) $(CEXCEPTION_OBJ) $(TIMER_OBJ)
+
+# Project
+#========
+INCLUDES := $(VENDOR_INCLUDES) $(SRC_INCLUDES)
+
+# Main
+#-----
+MAIN_SRC := $(SRC_DIR)/main.<%= extension %>
+MAIN_OBJ := $(OBJ_DIR)/main.o
+$(MAIN_OBJ): $(MAIN_SRC) $(OBJ_DIR)
+	$(COMPILER) $(TO_OBJ) $(FLAGS) $(TO_FILE) $@ $< $(INCLUDES)
+
+# Concatenated objects
+#---------------------
+PROJECT_OBJS :=
+
+# Target
+#-------
+$(TARGET): $(MAIN_OBJ) $(PROJECT_OBJS) $(VENDOR_OBJS)
+	$(COMPILER) $(TO_FILE) $@ $^ $(LIBS)
+	chmod 755 $@
+
+
+# Testing
+#===========
+UNITY_DIR := $(VENDOR_DIR)/unity
+UNITY_SRC_DIR := $(UNITY_DIR)/src
+TEST_DIR := $(THIS_DIR)/test
+TEST_SUPPORT_DIR := $(TEST_DIR)/support
+TEST_INCLUDES := -I$(UNITY_SRC_DIR) -I$(TEST_SUPPORT_DIR) $(INCLUDES)
+SYMBOLS = -DTEST -DUNITY_FLOAT_TYPE=double -DUNITY_FLOAT_VERBOSE
+
+TEST_BASE := $(TEST_DIR)/test_$(TARGET_BASE)
+ifeq ($(OS),Windows_NT)
+	TEST_EXTENSION=.exe
+else
+	TEST_EXTENSION=.out
+endif
+
+# Test 1
+#-------------
+TEST1_BASE := $(TEST_BASE)
+TEST1_SRC := $(TEST1_BASE).c
+TEST1 := $(TEST1_BASE)$(TEST_EXTENSION)
+TEST1_RUNNER := $(TEST1_BASE)_Runner.c
+
+$(TEST1_RUNNER): $(TEST1_SRC)
+	ruby $(UNITY_DIR)/auto/generate_test_runner.rb $(TEST1_SRC) $(TEST1_RUNNER)
+
+$(TEST1): $(TEST1_RUNNER) $(PROJECT_OBJS) $(VENDOR_OBJS)
+	$(COMPILER) $(TO_FILE) $@ $^ $(TEST_SUPPORT_DIR)/test_helper.c $(UNITY_SRC_DIR)/unity.c $(TEST1_SRC) $(TEST_INCLUDES) $(LIBS)
+	chmod 755 $@
+
+# Automatic tests (require Ruby)
+#--------------------------------
+test: clean $(TEST1)
+	$(TEST1)
+
+# Clean
+#============
+clean:
+	-rm -fr $(TARGET) obj *.out $(THIS_DIR)/test/*.out core.*
+
+# Makefile debugging
+#===================
+print-%:
+	@echo $* = $($*)

data/templates/c/vendor/timer/LICENCE

@@ -0,0 +1,23 @@
+Copyright (C) 2013 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+Except as contained in this notice, the name(s) of the above copyright holders
+shall not be used in advertising or otherwise to promote the sale, use or other
+dealings in this Software without prior written authorization.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/templates/c/vendor/timer/README.md

@@ -0,0 +1,8 @@
+timer
+==================
+
+@todo Write description
+
+License
+-------
+MIT license (see `LICENCE`).

data/templates/c/vendor/timer/src/timer.c

@@ -0,0 +1,27 @@
+#include <stdlib.h>
+#include <assert.h>
+#include <sys/time.h>
+#include "timer.h"
+
+static struct timeval before, after;
+
+void start_timer() {
+  before.tv_sec = 0;
+  before.tv_usec = 0;
+  after.tv_sec = 0;
+  after.tv_usec = 0;
+
+  gettimeofday(&before, NULL);
+}
+long long stop_timer() {
+  gettimeofday(&after, NULL);
+
+  // Two subtractions can be done here without decreasing stability because
+  // tv_sec and tv_usec are not floating point format. Doing the subtractions
+  // separately before the multiplication and addition reduces the
+  // possibility of overflow.
+  return (
+      (after.tv_sec - before.tv_sec) * 1e6 +
+      (after.tv_usec - before.tv_usec)
+  );
+}

data/templates/c/vendor/timer/src/timer.h

@@ -0,0 +1,7 @@
+#ifndef __TIMER_H__
+#define __TIMER_H__
+
+void start_timer();
+long long stop_timer();
+
+#endif

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: c_project
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dustin Morrill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -70,43 +70,47 @@ files:
 - lib/c_project.rb
 - lib/c_project/version.rb
 - templates/LICENCE.tt
-- templates/Makefile.tt
-- templates/README.md.tt
-- templates/src/CExceptionConfig.h.tt
-- templates/src/c_project.c.tt
-- templates/src/c_project.h.tt
-- templates/src/main.c.tt
-- templates/test/support/test_helper.c.tt
-- templates/test/support/test_helper.h.tt
-- templates/test/test_c_project.c.tt
-- templates/vendor/cexception/docs/license.txt
-- templates/vendor/cexception/docs/readme.txt
-- templates/vendor/cexception/lib/CException.c
-- templates/vendor/cexception/lib/CException.h
-- templates/vendor/cexception/release/build.info
-- templates/vendor/cexception/release/version.info
-- templates/vendor/commander.c/History.md
-- templates/vendor/commander.c/Makefile
-- templates/vendor/commander.c/Readme.md
-- templates/vendor/commander.c/package.json
-- templates/vendor/commander.c/src/commander.c
-- templates/vendor/commander.c/src/commander.h
-- templates/vendor/commander.c/test.c
-- templates/vendor/unity/.gitignore
-- templates/vendor/unity/auto/colour_prompt.rb
-- templates/vendor/unity/auto/colour_reporter.rb
-- templates/vendor/unity/auto/generate_config.yml
-- templates/vendor/unity/auto/generate_module.rb
-- templates/vendor/unity/auto/generate_test_runner.rb
-- templates/vendor/unity/auto/test_file_filter.rb
-- templates/vendor/unity/auto/unity_test_summary.rb
-- templates/vendor/unity/docs/Unity Summary.txt
-- templates/vendor/unity/docs/license.txt
-- templates/vendor/unity/release/build.info
-- templates/vendor/unity/release/version.info
-- templates/vendor/unity/src/unity.c
-- templates/vendor/unity/src/unity.h
-- templates/vendor/unity/src/unity_internals.h
+- templates/c/Makefile.tt
+- templates/c/README.md.tt
+- templates/c/src/CExceptionConfig.h.tt
+- templates/c/src/c_project.c.tt
+- templates/c/src/c_project.h.tt
+- templates/c/src/main.c.tt
+- templates/c/test/support/test_helper.c.tt
+- templates/c/test/support/test_helper.h.tt
+- templates/c/test/test_c_project.c.tt
+- templates/c/vendor/cexception/docs/license.txt
+- templates/c/vendor/cexception/docs/readme.txt
+- templates/c/vendor/cexception/lib/CException.c
+- templates/c/vendor/cexception/lib/CException.h
+- templates/c/vendor/cexception/release/build.info
+- templates/c/vendor/cexception/release/version.info
+- templates/c/vendor/timer/LICENCE
+- templates/c/vendor/timer/README.md
+- templates/c/vendor/timer/src/timer.c
+- templates/c/vendor/timer/src/timer.h
+- templates/c/vendor/unity/.gitignore
+- templates/c/vendor/unity/auto/colour_prompt.rb
+- templates/c/vendor/unity/auto/colour_reporter.rb
+- templates/c/vendor/unity/auto/generate_config.yml
+- templates/c/vendor/unity/auto/generate_module.rb
+- templates/c/vendor/unity/auto/generate_test_runner.rb
+- templates/c/vendor/unity/auto/test_file_filter.rb
+- templates/c/vendor/unity/auto/unity_test_summary.rb
+- templates/c/vendor/unity/docs/Unity Summary.txt
+- templates/c/vendor/unity/docs/license.txt
+- templates/c/vendor/unity/release/build.info
+- templates/c/vendor/unity/release/version.info
+- templates/c/vendor/unity/src/unity.c
+- templates/c/vendor/unity/src/unity.h
+- templates/c/vendor/unity/src/unity_internals.h
+- templates/commander.c/History.md
+- templates/commander.c/Makefile
+- templates/commander.c/Readme.md
+- templates/commander.c/package.json
+- templates/commander.c/src/commander.c
+- templates/commander.c/src/commander.h
+- templates/commander.c/test.c
 homepage: https://github.com/dmorrill10/c_project
 licenses:
 - MIT

data/templates/Makefile.tt

@@ -1,74 +0,0 @@
-THIS_DIR := $(CURDIR)/$(dir $(lastword $(MAKEFILE_LIST)))
-
-CC = gcc -std=gnu99
-CFLAGS = -O3 -g -Wall
-LIBS = -lm
-TARGET_SYMBOLS = -DCEXCEPTION_USE_CONFIG_FILE
-
-VENDOR_DIR := $(THIS_DIR)/vendor/
-COMMANDER_DIR := $(VENDOR_DIR)/commander.c
-TARGET_INCLUDES = -I$(THIS_DIR)/src -I$(CEXCEPTION_LIB) -I$(COMMANDER_DIR)/src
-
-CEXCEPTION_DIR := $(VENDOR_DIR)/cexception/
-CEXCEPTION_LIB := $(CEXCEPTION_DIR)/lib
-CEXCEPTION_SRC := $(CEXCEPTION_LIB)/CException.c
-
-TARGET_BASE = <%= name %>
-TARGET_SRC_DIR := $(THIS_DIR)/src
-TARGET_SRC := $(TARGET_SRC_DIR)/$(TARGET_BASE).c $(CEXCEPTION_SRC)
-
-BUILD_PREFIX := $(CC) $(CFLAGS) $(TARGET_SYMBOLS)
-
-TARGET := $(THIS_DIR)/$(TARGET_BASE)
-
-default: $(TARGET) 
-
-# Build target
-#==============
-$(TARGET): $(TARGET_SRC)
-	$(BUILD_PREFIX) $(TARGET_INCLUDES) $(TARGET_SRC) $(TARGET_SRC_DIR)/main.c $(COMMANDER_DIR)/src/commander.c $(PROJECT_SRC) $(LIBS) -o $@
-	chmod 755 $@
-
-# Testing
-#===========
-UNITY_DIR := $(VENDOR_DIR)/unity
-TEST_DIR := $(THIS_DIR)/test
-TEST_SUPPORT_DIR := $(TEST_DIR)/support
-INC_DIRS := -I$(UNITY_DIR)/src -I$(TEST_SUPPORT_DIR) -I$(THIS_DIR)/src $(TARGET_INCLUDES)
-SYMBOLS = -DTEST -DUNITY_FLOAT_TYPE=double -DUNITY_FLOAT_VERBOSE
-TEST_BASE := $(TEST_DIR)/test_$(TARGET_BASE)
-ifeq ($(OS),Windows_NT)
-	TEST_EXTENSION=.exe
-else
-	TEST_EXTENSION=.out
-endif
-
-# Test 1
-#-------------
-TEST1_BASE := $(TEST_BASE)
-TEST1_SRC := $(TEST1_BASE).c
-TEST1 := $(TEST1_BASE)$(TEST_EXTENSION)
-TEST1_RUNNER := $(TEST1_BASE)_Runner.c
-
-$(TEST1_RUNNER): $(TEST1_SRC)
-	ruby $(UNITY_DIR)/auto/generate_test_runner.rb $(TEST1_SRC) $(TEST1_RUNNER)
-
-$(TEST1): $(TARGET) $(TEST1_RUNNER)
-	$(BUILD_PREFIX) $(SYMBOLS) $(INC_DIRS) $(TARGET_SRC) $(PROJECT_SRC) $(TEST_SUPPORT_DIR)/test_helper.c $(UNITY_DIR)/src/unity.c $(TEST1_SRC) $(TEST1_RUNNER) $(LIBS) -o $@
-	chmod 755 $@
-
-# Automatic tests (require Ruby)
-#--------------------------------
-test: clean $(TEST1)
-	$(TEST1)
-
-# Clean
-#============
-clean:
-	rm -f $(TARGET) *.o *.il *.out $(TEST1) $(TEST1_RUNNER) $(THIS_DIR)/test/*.out
-
-# Makefile debugging
-#===================
-print-%:
-	@echo $* = $($*)
-