Refactored the project skeleton

davidchappelle · Oct 1, 2013 · b30594b · b30594b
1 parent 8ffac25
commit b30594b
Show file tree

Hide file tree

Showing 34 changed files with 118 additions and 177 deletions.
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -1,4 +1,23 @@
-cpp-project-framework
-=====================
++ cpp-project-framework
+
+This is a project skeleton that can be used to quickly get up and running with a c++ based project without having to fight through all of the initial gnu make overhead.
+
++ Unit Testing
+
+cxxtest is integrated with this project. To install cxxtest in your development
+environment you first need to download the cxxtest tarball which you can find at
+the following site:
+
+    http://sourceforge.net/projects/cxxtest/files/cxxtest/
+
+Extract the tarball and install:
+
+    $ gunzip cxxtest-<version>.tar.gz
+    $ tar xf cxxtest-<version>.tar
+    $ cd cxxtest-<version>/python
+    $ python setup.py install
+
+You should now be able to build your projects unit tests:
+
+    $ make test
 
-This is a project skeleton that can be used to quickly get up and running with a c++ based project without having to fight through all of the initial gnu make overhead.
diff --git a/bin/Makefile b/bin/Makefile
@@ -1,5 +1,5 @@
 TOP_DIRECTORY=..
-SUB_DIRECTORIES=client server
+SUB_DIRECTORIES=skeleton
 
 -include $(TOP_DIRECTORY)/mk/subdirectory.mk
 
diff --git a/bin/client/client.cpp b/bin/client/client.cpp
diff --git a/bin/server/Makefile b/bin/server/Makefile
diff --git a/bin/server/server.cpp b/bin/server/server.cpp
diff --git a/bin/client/Makefile → bin/skeleton/Makefile b/bin/client/Makefile → bin/skeleton/Makefile
@@ -2,9 +2,9 @@ TOP_DIRECTORY=../..
 
 CXX_LDFLAGS+= \
 	-lstdc++ \
-	-lclient \
+	-lskeleton \
 
-EXECUTABLE=client
+EXECUTABLE=skeleton
 
 SOURCES=$(EXECUTABLE).cpp
 

diff --git a/bin/skeleton/skeleton.cpp b/bin/skeleton/skeleton.cpp
@@ -0,0 +1,10 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "skeleton/Skeleton.hpp"
+
+int main(int argc, char** argv)
+{
+    printf("argc=%d argv=%p\n", argc, argv);
+    return 0;
+}
diff --git a/include/client/client.hpp b/include/client/client.hpp
diff --git a/include/server/server.hpp b/include/server/server.hpp
diff --git a/include/skeleton/Skeleton.hpp b/include/skeleton/Skeleton.hpp
@@ -0,0 +1,9 @@
+#ifndef SKELETON_HPP
+#define SKELETON_HPP
+
+namespace skeleton
+{
+
+} // namespace skeleton
+
+#endif
diff --git a/mk/build.mk b/mk/build.mk
@@ -2,10 +2,6 @@ ifeq ($(TOP_DIRECTORY),)
   $(error <build.mk> TOP_DIRECTORY must be defined)
 endif
 
-ifeq ($(BUILD_CLEANUP_FILES),)
-  $(error <build.mk> BUILD_CLEANUP_FILES must be defined)
-endif
-
 ifeq ($(BUILD_OUTPUT_DIRECTORY),)
   $(error <build.mk> BUILD_OUTPUT_DIRECTORY must be defined)
 endif
@@ -14,6 +10,11 @@ ifeq ($(BUILD_LIBRARY_DIRECTORY),)
   $(error <build.mk> BUILD_LIBRARY_DIRECTORY must be defined)
 endif
 
+ifneq ($(BUILD_OUTPUT_FILES),)
+  CLEANUP_BUILD_OUTPUT_FILES=1
+endif
+CLEANUP_BUILD_OUTPUT_FILES?=0
+
 BUILD_DIRECTORIES=$(BUILD_OUTPUT_DIRECTORY) $(BUILD_LIBRARY_DIRECTORY)
 BUILD_VERBOSE?=1
 
@@ -26,45 +27,47 @@ define create_build_directories
   +@directories='$(BUILD_DIRECTORIES)'; \
   for directory in $$directories; do \
     if [ ! -d $$directory ]; then \
-      if test ! "$(BUILD_VERBOSE)" -eq 1; then \
+      if test $(BUILD_VERBOSE) -eq 1; then \
         echo "Creating directory $$directory"; \
       fi; \
       $(MKDIR) -p $$directory; \
     fi; \
   done;
 endef
 
-# Currently we do not remove build directories. If we
-# do find the need to it this should be called from
-# clean below.
-define remove_build_directories
-  +@directories='$(BUILD_DIRECTORIES)'; \
-  for directory in $$directories; do \
-    if [ -d $$directory ]; then \
-      if test ! "$(BUILD_VERBOSE)" -eq 1; then \
-        echo "Removing directory $$directory"; \
-      fi; \
-      $(RM) -fr $$directory; \
+define cleanup_build_output
+  if [ -d $(BUILD_OUTPUT_DIRECTORY) ]; then \
+    if test $(BUILD_VERBOSE) -eq 1; then \
+      echo "Removing build output directory: $(BUILD_OUTPUT_DIRECTORY)"; \
     fi; \
-  done;
+    $(RM) -fr $(BUILD_OUTPUT_DIRECTORY); \
+  fi; \
+  if test $(CLEANUP_BUILD_OUTPUT_FILES) -eq 1; then \
+    if test $(BUILD_VERBOSE) -eq 1; then \
+      echo "Removing build output files: $(BUILD_OUTPUT_FILES)"; \
+    fi; \
+    $(RM) -f $(BUILD_OUTPUT_FILES); \
+  fi;
 endef
 
 define compile_cxx_file
   @cmd="$(CXX) $(CXX_FLAGS) -MMD -MP -c $< -o $@" ; \
-  if test ! "$(BUILD_VERBOSE)" -eq 1; then \
-    echo "Compiling $(BUILD_OUTPUT_DIRECTORY)/$<"; \
+  if test $(BUILD_VERBOSE) -eq 1; then \
+    echo "Compiling $<"; \
   else \
     echo "$$cmd"; \
   fi; \
   $$cmd
 endef
 
 build-directories:
-	$(create_build_directories)
+	@$(create_build_directories)
 
 clean:
-	@rm -f $(BUILD_CLEANUP_FILES)
+	@$(cleanup_build_output)
+
 
 $(BUILD_OUTPUT_DIRECTORY)/%.o: %.cpp
 	@$(compile_cxx_file)
 
+.PHONY: clean
diff --git a/mk/configuration.mk b/mk/configuration.mk
@@ -6,7 +6,3 @@ BUILD_VERBOSE?=1
 BUILD_OUTPUT_DIRECTORY?=output
 BUILD_LIBRARY_DIRECTORY?=$(TOP_DIRECTORY)/lib
 BUILD_INCLUDE_DIRECTORY?=$(TOP_DIRECTORY)/include
-
-THIRDPARTY_LIBRARY_DIRECTORY?=$(TOP_DIRECTORY)/thirdparty/lib
-THIRDPARTY_INCLUDE_DIRECTORY?=$(TOP_DIRECTORY)/thirdparty/include
-
diff --git a/mk/executable.mk b/mk/executable.mk
@@ -24,7 +24,7 @@ endif
 OBJECTS=$(addprefix $(BUILD_OUTPUT_DIRECTORY)/,$(addsuffix .o,$(basename $(SOURCES))))
 DEPENDENCIES=$(addprefix $(BUILD_OUTPUT_DIRECTORY)/,$(addsuffix .d,$(basename $(SOURCES))))
 EXECUTABLE_TARGETS=$(addprefix $(BUILD_OUTPUT_DIRECTORY)/, $(EXECUTABLES))
-BUILD_CLEANUP_FILES=$(OBJECTS) $(DEPENDENCIES) $(EXECUTABLE_TARGETS)
+BUILD_OUTPUT_FILES=$(OBJECTS) $(DEPENDENCIES) $(EXECUTABLE_TARGETS)
 
 define compile_executable_target
   @cmd="$(CXX) $(CXX_FLAGS) $@.o -o $@ $(CXX_LDFLAGS)" ; \

diff --git a/mk/flags.mk b/mk/flags.mk
@@ -3,12 +3,10 @@ ifeq ($(TOP_DIRECTORY),)
 endif
 
 INCLUDE_DIRECTORIES+= \
-	-I$(BUILD_INCLUDE_DIRECTORY) \
-	-I$(THIRDPARTY_INCLUDE_DIRECTORY) \
+	-I$(BUILD_INCLUDE_DIRECTORY)
 
 LIBRARY_DIRECTORIES+= \
-	-L$(BUILD_LIBRARY_DIRECTORY) \
-	-L$(THIRDPARTY_LIBRARY_DIRECTORY) \
+	-L$(BUILD_LIBRARY_DIRECTORY)
 
 CXX_WARNINGS= \
 	-Wall \

diff --git a/mk/library.mk b/mk/library.mk
@@ -16,7 +16,7 @@ OBJECTS=$(addprefix $(BUILD_OUTPUT_DIRECTORY)/,$(addsuffix .o,$(basename $(SOURC
 DEPENDENCIES=$(addprefix $(BUILD_OUTPUT_DIRECTORY)/,$(addsuffix .d,$(basename $(SOURCES))))
 LIBRARY_DIRECTORY=$(TOP_DIRECTORY)/lib
 LIBRARY_TARGET=$(LIBRARY_DIRECTORY)/lib$(LIBRARY).a
-BUILD_CLEANUP_FILES=$(OBJECTS) $(DEPENDENCIES) $(LIBRARY_TARGET)
+BUILD_OUTPUT_FILES=$(OBJECTS) $(DEPENDENCIES) $(LIBRARY_TARGET)
 
 all: build-directories $(OBJECTS) $(LIBRARY_TARGET)
 

diff --git a/mk/subdirectory.mk b/mk/subdirectory.mk
diff --git a/mk/target.mk b/mk/target.mk
diff --git a/mk/test.mk b/mk/test.mk
@@ -6,23 +6,18 @@ ifeq ($(TEST_SOURCES),)
   $(error <test.mk> TEST_SOURCES must be defined)
 endif
 
-ifeq ($(TEST_EXECUTABLES),)
-  $(error <test.mk> TEST_EXECUTABLES must be defined)
-endif
+-include $(TOP_DIRECTORY)/mk/tools.mk
+-include $(TOP_DIRECTORY)/mk/configuration.mk
+-include $(TOP_DIRECTORY)/mk/build.mk
 
-SOURCES=$(TEST_SOURCES)
-EXECUTABLES=$(TEST_EXECUTABLES)
+all:
 
--include $(TOP_DIRECTORY)/mk/executable.mk
+test: build-directories $(BUILD_OUTPUT_DIRECTORY)/runner 
+	$(BUILD_OUTPUT_DIRECTORY)/runner
 
-define run_tests
-  +@tests='$(TEST_EXECUTABLES)'; \
-  for test in $$tests; do \
-    echo "Running test => $$test"; \
-    $(BUILD_OUTPUT_DIRECTORY)/$$test; \
-  done;
-endef
+$(BUILD_OUTPUT_DIRECTORY)/runner: $(BUILD_OUTPUT_DIRECTORY)/runner.cpp
+	$(CXX) $(CXX_FLAGS) -o $@ $< $(CXX_LDFLAGS)
 
-test: all
-	$(run_tests)
+$(BUILD_OUTPUT_DIRECTORY)/runner.cpp: $(TEST_SOURCES)
+	$(CXXTESTGEN) -o $@ --error-printer $^
 
diff --git a/mk/tools.mk b/mk/tools.mk
@@ -3,6 +3,7 @@ INSTALL=?install
 CP?=cp
 MV?=mv
 RM?=rm
+RMDIR?=rmdir
 MKDIR?=mkdir
 DATE?=date
 BISON?=bison
@@ -29,3 +30,4 @@ RANLIB=ranlib
 SIZE=size
 STRIP=strip
 MAKE?=make
+CXXTESTGEN=cxxtestgen
diff --git a/src/Makefile b/src/Makefile
@@ -1,5 +1,5 @@
 TOP_DIRECTORY=..
-SUB_DIRECTORIES=client server
+SUB_DIRECTORIES=skeleton
 
 -include $(TOP_DIRECTORY)/mk/subdirectory.mk
 
diff --git a/src/client/client.cpp b/src/client/client.cpp
diff --git a/src/client/test/Makefile b/src/client/test/Makefile
diff --git a/src/client/test/t_test1.cpp b/src/client/test/t_test1.cpp
diff --git a/src/client/test/t_test2.cpp b/src/client/test/t_test2.cpp
diff --git a/src/server/Makefile b/src/server/Makefile
diff --git a/src/server/server.cpp b/src/server/server.cpp
diff --git a/src/server/test/Makefile b/src/server/test/Makefile
diff --git a/src/server/test/t_test1.cpp b/src/server/test/t_test1.cpp
diff --git a/src/server/test/t_test2.cpp b/src/server/test/t_test2.cpp
diff --git a/src/client/Makefile → src/skeleton/Makefile b/src/client/Makefile → src/skeleton/Makefile
@@ -1,7 +1,7 @@
 TOP_DIRECTORY=../..
 SUB_DIRECTORIES=test
-LIBRARY=client
-SOURCES=client.cpp
+LIBRARY=skeleton
+SOURCES=Skeleton.cpp
 
 -include $(TOP_DIRECTORY)/mk/library.mk
 -include $(TOP_DIRECTORY)/mk/subdirectory.mk