Working makefiles! Wohoo!

Author: martinmarinov

JavaGUI/jni/TSDRLibraryNDK.h

@@ -1,6 +1,12 @@
-# TODO! Make this platform independent!
-INC = "C:\PROGRA~2\Java\jdk1.7.0_45\include" "C:\PROGRA~2\Java\jdk1.7.0_45\include\win32"
+# JAVA_HOME should be initialized to something like C:\PROGRA~2\Java\jdk1.7.0_45
+ifndef JAVA_HOME
+$(warning JAVA_HOME should be set so it points to your jdk installation dir)
+endif
+
+# Headers
+INC = "$(JAVA_HOME)/include" "$(JAVA_HOME)/include/win32"
 
+# Detect library extension depending on OS
 ifeq ($(OS),Windows_NT)
     EXT = .dll
 else
@@ -10,31 +16,38 @@ else
     endif
 endif
 
+# We want to build the library
 all : ../TSDRLibraryNDK$(EXT)
 
-# $@ matches the target, $< matches the firs8t dependancy
+# Linking
 ../TSDRLibraryNDK$(EXT) : TSDRLibraryNDK.o rebuildtempestsdr
 	gcc -L../../TempestSDR/bin/ -lTSDRLibrary -Wl,--add-stdcall-alias -shared -o $@ $<
 
+# Rebuild the main library so that we have the most up-to-date version
+# The main library is assumed to be two levels below this jni folder
 rebuildtempestsdr :
 	@$(MAKE) -C ../../TempestSDR bin/TSDRLibrary$(EXT)
 	@cp -f ../../TempestSDR/bin/TSDRLibrary$(EXT) ../TSDRLibrary$(EXT)
 
-# $@ matches the target, $< matches the first dependancy
+# Compile the sources to obj files
 TSDRLibraryNDK.o : TSDRLibraryNDK.c TSDRLibraryNDK.h include/TSDRLibrary.h
 	gcc $(foreach d, $(INC), -I$d) -c $< -o $@
-	
+
+# Copy over a fresh set of library headers
 include/TSDRLibrary.h : ../../TempestSDR/src/include/TSDRLibrary.h
 	mkdir -p include
 	@cp -f $< $@
 
+# Generate the java header based on the class
 TSDRLibraryNDK.h : ../bin/martin/tempest/core/TSDRLibrary.class 
 	javah -classpath ../bin -o TSDRLibraryNDK.h -jni martin.tempest.core.TSDRLibrary
-	
+
+# If the class is not compiled, do it
 ../bin/martin/tempest/core/TSDRLibrary.class  : ../src/martin/tempest/core/TSDRLibrary.java
 	mkdir -p include ../bin/martin/tempest/core/
-	javac $< -d ../bin/
+	javac $< -d ../bin/ -cp ../src/
 
+# Remove any compiled artifacts
 clean :
 	rm -f TSDRLibraryNDK.h *.o ../TSDRLibraryNDK$(EXT) ../TSDRLibrary$(EXT) include/*.h
 	rm -rf include/

JavaGUI/jni/include/TSDRLibrary.h

@@ -1,14 +1,68 @@
+# USER CONFIGURATION STARTS HERE
+
+# Define the plugins that you like to compile with the library. They need to be in a folder
+# in the parent directory with the exact same name as the plugin names. The library files
+# produced need to have the name of the plugin folder and need to be in the bin directory.
+# The default plugin file will make sure this is compatible.
+PLUGINS=TSDRPlugin_RawFile
+
+# USER CONFIGURATION ENDS HERE
+
+# Define a recursive wildcard function
+rwildcard=$(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2) $(filter $(subst *,%,$2),$d))
+
+# Discover all the java sources
+JAVAFILES:=$(call rwildcard,src/,*.java)
+
+# Create the class dependencies
+CLASSFILES:=$(patsubst %,bin/%,$(addsuffix .class,$(basename $(foreach jfile,$(JAVAFILES), $(subst src/,,$(jfile)) ))))
+
+# Detect shared library extension based on OS
+ifeq ($(OS),Windows_NT)
+	EXT = .dll
+else
+	UNAME_S := $(shell uname -s)
+	ifeq ($(UNAME_S),Linux)
+		EXT = .so
+	endif
+endif
+
+# Build the file names of the plugin files
+PLUGINS_FILES=$(addsuffix $(EXT),$(PLUGINS))
+
+# Build the directory names of the plugins
+PLUGINS_DIRS=$(addprefix ../,$(addsuffix /,$(PLUGINS)))
+
+# When compiling from command line with all
+# make sure we compile both jni and java files
 all : jnilib java
 
-java :
-	rwildcard=$(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2) $(filter $(subst *,%,$2),$d))
-	javafiles=$(call rwildcard,/src/,*.java)
-	
-jnilib :
-	@$(MAKE) -C jni/ all
+# The compilation of the java classes from command line
+# depends on the class files (we want to produce them)
+java : $(CLASSFILES)
+
+# For each class file, invoke javac with the source file which is constructed
+# from the name of the class file
+%.class : $(JAVAFILES)
+	mkdir -p bin # Create the bin directory if it doesn't exist (if you downloaded it from github)
+	javac $(patsubst %,src/%, $(subst bin/,,$(@:.class=.java))) -d bin/ -cp src/
+
+# Invoke the makefile for the jni stuff
+jnilib : plugins
+	@$(MAKE) -C jni/ all JAVA_HOME=$(JAVA_HOME)
 
-cleanjni:
+# Recompile each plugin and copy its shared library over to the java directory
+plugins : 
+	$(foreach pdir, $(PLUGINS_DIRS), $(MAKE) -C $(pdir) all; cp -f $(pdir)/bin/*$(EXT) .;)
+
+# Clean the jni stuff
+cleanjni: cleanplugins
 	@$(MAKE) -C jni/ clean
-	
+
+# Clean the plugin libraries
+cleanplugins:
+	$(foreach pfile, $(PLUGINS_FILES), rm -rf $(pfile);)	
+
+# Clean the java classes as well
 clean : cleanjni
 	rm -rf bin/

JavaGUI/jni/makefile

@@ -8,15 +8,46 @@ Folder Structure
 
 The different folders contain the different subprojects. The TempestSDR folder contains the main C library. The project aims to be crossplatform with plugin support for SDR frontends in different folders.
 
-Compiling
+Requirements for Building
 ------------
 
-The project is built with Eclipse with the CDT plugin. Currently it supports Windows and Linux. Some frontend plugins might not be crossplatform.
+The project is built with Eclipse with the CDT plugin (but this is not required). Currently it supports Windows and Linux. Some frontend plugins might not be crossplatform. You also need a Java Development Kit (JDK) installed.
 
 ### Windows
 
 You need to have MinGW installed and gcc and make commands need to be in your path. Also javac and javah also need to be in your path.
 
 ### Linux
 
-To be announced soon.
+To be announced soon.
+
+Building
+------------
+
+All project could be built both with Eclipse and make as well.
+
+### TempestSDR library
+
+Enter the folder and type
+
+    make all
+	
+This will produce the library which could be found in the bin subdir. The headers you need to interface with it are located in src/include.
+
+### Plugins
+
+Go into a plugin directory and type
+
+    make all
+	
+This should work unless there is something specific for the plugin itself. Look for a README in this case.
+
+### JavaGUI
+
+This is the Java wrapper and GUI. It builds all projects and supported plugins including the Java GUI itself. Go into the JavaGUI folder and type in
+
+    make all JAVA_HOME=path_to_jdk_installation
+
+On Windows 8 this could look like
+
+    make all JAVA_HOME=C:/PROGRA~2/Java/jdk1.7.0_45

JavaGUI/makefile

@@ -1,18 +1,26 @@
 # This makefile should work for all plugins that reside in the root directory of the repository.
 # The header file is copied over from the source
 PLUGNAME=TSDRPlugin_RawFile
+
+# Dependencies
+OBJS=$(PLUGNAME).o
+DEPS=TSDRPlugin.h
+
+# END OF CONFIGURATION IF STANDARD DIR STRUCTURE IS USED
+
+# Where the TSDRPlugin.h of the TempestSDR library resides (so it will be copied over)
 HEADLOCATION=../TempestSDR/src/include/
 
+# If you need a different directory structure. Don't change that unless you really want to.
 SOURCEFOLDER=src
 OUTPUTFOLDER=bin
 OBJFOLDER=bin/obj
 
-OBJS=$(PLUGNAME).o
-DEPS=TSDRPlugin.h
-
+# Calculate the path to dependencies
 _OBJS = $(patsubst %,$(OBJFOLDER)/%,$(OBJS))
 _DEPS = $(patsubst %,$(SOURCEFOLDER)/%,$(DEPS))
 
+# Discover the library extension for each OS
 ifeq ($(OS),Windows_NT)
 	EXT = .dll
 else
@@ -22,20 +30,25 @@ else
 	endif
 endif
 
+# Generate the library
 all : $(OUTPUTFOLDER)/$(PLUGNAME)$(EXT)
 
+# Copy over a fresh version of the TSDRPlugin.h
 copyoverheaderfile:
 	@cp -f $(HEADLOCATION)/TSDRPlugin.h $(SOURCEFOLDER)/TSDRPlugin.h
 
-$(OUTPUTFOLDER)/$(PLUGNAME)$(EXT): $(_OBJS)
+# Link
+$(OUTPUTFOLDER)/$(PLUGNAME)$(EXT): copyoverheaderfile $(_OBJS)
 	gcc -Wl,--add-stdcall-alias -shared -o $@ $(_OBJS)
 
+# Make dirs and compile
 $(OBJFOLDER)/%.o : $(SOURCEFOLDER)/%.c $(_DEPS)
 	mkdir -p $(OUTPUTFOLDER)
 	mkdir -p $(OBJFOLDER)
 	gcc $(foreach d, $(INC), -I$d) -c $< -o $@
 
 .PHONY: clean
 
+# Clean artifacts
 clean :
-	rm -f $(OBJFOLDER)/*.o $(OUTPUTFOLDER)/$(PLUGNAME)$(EXT) $(SOURCEFOLDER)/TSDRPlugin.h
+	rm -f $(OBJFOLDER)/*.o $(OUTPUTFOLDER)/$(PLUGNAME)$(EXT)

README.md

@@ -0,0 +1,6 @@
+#ifndef _TSDRPluginHeader
+#define _TSDRPluginHeader
+
+	void tsdrplugin_getName(char *);
+
+#endif

TSDRPlugin_RawFile/makefile

@@ -1,3 +1,6 @@
+#include <stdio.h>
+#include <string.h>
+
 #include "TSDRPlugin.h"
 
 void tsdrplugin_getName(char * name) {

TSDRPlugin_RawFile/src/TSDRPlugin.h

@@ -1,9 +1,18 @@
+# Define all of the C files here
 OBJS = TSDRLibrary.o TSDRPluginLoader.o
+
+# Define all of the dependencies here
 DEPS = include/TSDRLibrary.h TSDRPluginLoader.h
 
+# USER CONFIGURATION ENDS HERE
+
+# The obj files reside in the bin/obj directory
 _OBJS = $(patsubst %,bin/obj/%,$(OBJS))
+
+# The header files are relative to the source directory
 _DEPS = $(patsubst %,src/%,$(DEPS))
 
+# Detect library extension based on OS
 ifeq ($(OS),Windows_NT)
     EXT = .dll
 else
@@ -13,19 +22,21 @@ else
     endif
 endif
 
+# Build library
 all : bin/TSDRLibrary$(EXT)
 
-# $@ matches the target, $< matches the first dependancy
+# Link
 bin/TSDRLibrary$(EXT) : $(_OBJS)
 	gcc -Wl,--add-stdcall-alias -shared -o $@ $(_OBJS)
 
-# $@ matches the target, $< matches the first dependancy
+# Create folders if needed and compile
 bin/obj/%.o : src/%.c $(_DEPS)
 	mkdir -p bin
 	mkdir -p bin/obj
 	gcc $(foreach d, $(INC), -I$d) -c $< -o $@
 
 .PHONY: clean
 
+# Clean artifacts
 clean :
 	rm -f bin/obj/*.o bin/TSDRLibrary$(EXT)

TSDRPlugin_RawFile/src/TSDRPlugin_RawFile.c

@@ -14,10 +14,13 @@
 void test(void) {
 	pluginsource_t plugin;
 
-	if (tsdrplug_load(&plugin, "abc.dll"))
-		printf(plugin.tsdrplugin_getName());
-	else
-		printf("Error!");
+	char name[40] = "Not working :( ";
+
+	if (tsdrplug_load(&plugin, "TSDRPlugin_RawFile.dll")) {
+		plugin.tsdrplugin_getName(name);
+		printf("%s\n",name);
+	} else
+		printf("Error!\n");
 
 	tsdrplug_close(&plugin);
 }