Merge branch 'master' of supraverse.net:libpsyc

README

@@ -10,9 +10,20 @@ See http://about.psyc.eu for information on PSYC in general.
 The plain C API located in the include/psyc directory along with the file psyc.h
 is primarily intended to be used for binding with other languages and frameworks.
 
-Available bindings are located in include/<name> where name is the lanugage or
+Available bindings are located in include/<name> where name is the language or
 framework.
 
+== C API ==
+
+The "plain C API" is a very low-level API intended to be used for bindings.
+To access a certain module of the library, just include the according header
+file from the psyc directory:
+
+parser.h -- parse psyc packets
+render.h -- render psyc packets
+text.h   -- text template functions 
+packet.h -- structures for render.h and functions to initialize them
+syntax.h -- definitions and constants related to parsing and rendering
 
 == Directory Overview ==
 

src/lib.h

@@ -3,7 +3,7 @@
 #ifndef PSYC_LIB_H
 # define PSYC_LIB_H
 
-#include "../psyc.h"
+#include <psyc.h>
 #include "./debug.h"
 #include <assert.h>
 

src/match.c

@@ -1,4 +1,4 @@
-#include "psyc/lib.h"
+#include "lib.h"
 
 int psyc_inherits(char* sho, size_t slen,
 		  char* lon, size_t llen) {

src/packet.c

@@ -1,4 +1,4 @@
-#include <psyc/lib.h>
+#include "lib.h"
 #include <psyc/syntax.h>
 #include <psyc/packet.h>
 

src/parser.c

@@ -5,7 +5,7 @@
 #include <stdio.h>
 #endif
 
-#include <psyc/lib.h>
+#include "lib.h"
 #include <psyc/parser.h>
 
 #define ADVANCE_CURSOR_OR_RETURN(ret)            \

src/render.c

@@ -1,6 +1,6 @@
-#include "psyc/lib.h"
+#include "lib.h"
-#include "psyc/render.h"
+#include <psyc/render.h>
-#include "psyc/syntax.h"
+#include <psyc/syntax.h>
 
 psycRenderRC psyc_renderList (psycList *list, char *buffer, size_t buflen)
 {

src/text.c

@@ -1,4 +1,4 @@
-#include <psyc/lib.h>
+#include "lib.h"
 #include <psyc/text.h>
 
 psycTextRC psyc_text (psycTextState *state, psycTextCB getValue)

src/variable.c

@@ -1,4 +1,4 @@
-#include <psyc/lib.h>
+#include "lib.h"
 #include <stdint.h>
 
 /// Routing variables in alphabetical order.

test/Makefile

@@ -1,6 +1,6 @@
 OPT = -O2
 DEBUG = 2
-CFLAGS = -I../include -Wall -std=c99 ${OPT}
+CFLAGS = -I../include -I../src -Wall -std=c99 ${OPT}
 LDFLAGS = -L../lib
 LOADLIBES = -lpsyc -lm
 LOADLIBES_NET = ${LOADLIBES}

test/getVarType.c

@@ -2,7 +2,7 @@
 #include <unistd.h>
 #include <stdio.h>
 #include <fcntl.h>
-#include "../include/psyc/lib.h"
+#include <lib.h>
 
 int main() {
 	unless (psyc_getVarType(PSYC_C2ARG("_list"))) return 1;

test/isRoutingVar.c

@@ -2,7 +2,7 @@
 #include <unistd.h>
 #include <stdio.h>
 #include <fcntl.h>
-#include "../include/psyc/lib.h"
+#include <lib.h>
 
 int main() {
 #if 0

test/testMatch.c

@@ -1,5 +1,5 @@
 #include <stdio.h>
-#include "../include/psyc/lib.h"
+#include <lib.h>
 
 int main() {
 	if (psyc_matches(PSYC_C2ARG("_failure_delivery"), PSYC_C2ARG("_failure_unsuccessful_delivery_death"))) return 1;

test/testRender.c

@@ -1,6 +1,6 @@
 #include <stdio.h>
 
-#include <psyc/lib.h>
+#include <lib.h>
 #include <psyc/render.h>
 #include <psyc/syntax.h>
 

test/testText.c

@@ -1,6 +1,6 @@
 #include <stdio.h>
 
-#include <psyc/lib.h>
+#include <lib.h>
 #include <psyc/text.h>
 
 #define BUFSIZE 512