[转载]一套完整的makefile样板

2011年3月01日 16:22

 

应用系统的目录结构如下：

~/bin	可执行程序目录

~/etc	配置文件目录

~/inc	头文件目录

~/lib	函数库文件目录

~/log	日志文件目录

~/src	源程序文件目录

~/src/lib	函数库源程序目录

~/src/lib/LIB_1	函数库libLIB_1源程序目录

~/src/APP_A	子系统APP_A源程序目录

~/src/APP_A/mod_a	子系统APP_A模块mod_a源程序目录

~/.profile

~/makefile

~/makefile文件内容如下：


all:

	@MakeSubDir() \

	{ \

		for DIR in `ls|grep 'lib';ls|grep -v 'lib'`; do \

			if [ -d $${DIR} ]; then \

				cd $${DIR}; \

				MakeSubDir; \

				if [ -f makefile -o -f Makefile ]; then \

					echo ""; \

					pwd; \

					make all; \

				fi; \

				cd ..; \

			fi; \

		done; \

	}; \

	MakeSubDir



tar:

	@tar -cf `date +%Y%m%d-%H%M%S`.tar .profile `ls|grep -v '.tar'`

~/src/lib/LIB_1/makefile文件内容如下：


ALL:	INFO all



BASEDIR	= $(HOME)

INC	= $(BASEDIR)/inc

LIB	= $(BASEDIR)/lib



PRDNAME	= $(LIB)/libLIB_1



PRODUCT	= $(PRDNAME).a $(PRDNAME).so



OBJS	= LIB_1_f1.o LIB_1_f2.o



AR	= ar <特定平台ar可选参数>;

CC	= cc <特定平台cc可选参数>;



all:	$(PRODUCT)



$(PRDNAME).a:	$(OBJS)

	@echo "  Making $@ ..."

	@$(AR) -r $@ $(OBJS)



$(PRDNAME).so:	$(OBJS)

	@echo "  Making $@ ..."

	@$(CC) -G -o $@ $(OBJS)



.c.o:	*.h $(INC)/*.h

	@echo "  Compiling $< ..."

	@$(CC) -c -I$(INC) $<



INFO:

	@echo "  make all - same with 'make' except this message"

	@echo "  make clear - remove object files"

	@echo "  make clean - remove all object and target files"

	@echo ""



clear:	FORCE

	@rm -f *.o



clean:	FORCE clear

	@rm -f $(PRODUCT)



FORCE:

~/src/APP_A/mod_a/makefile文件内容如下：


ALL:	INFO all



BASEDIR	= $(HOME)

INC	= $(BASEDIR)/inc

LIB	= $(BASEDIR)/lib

BIN	= $(BASEDIR)/bin



MODULE	= $(BIN)/APP_A_mod_a

TESTER	= APP_A_mod_a_t

PRODUCT	= $(SERVER) $(TESTER)



CC	= cc <特定平台cc可选参数>;



all:	$(PRODUCT)



$(MODULE):	APP_A_mod_a.o

	@echo "  Making $@ ..."

	@$(CC) $? -o$@ -L$(LIB) -lLIB_1



APP_A_mod_a_t:	APP_A_mod_a_t.o

	@echo "  Making $@ ..."

	@$(CC) $? -o$@ -L$(LIB) -lLIB_1



.c.o:	*.h $(INC)/*.h

	@echo "  Compiling $< ..."

	@$(CC) -c -I$(INC) $<



INFO:

	@echo "  make all - same with 'make' except this message"

	@echo "  make clear - remove object files"

	@echo "  make clean - remove all object and target files"

	@echo ""



clear:	FORCE

	@rm -f *.o



clean:	FORCE clear

	@rm -f $(PRODUCT)



FORCE:

使用方法： 
1.在主目录下使用'make'命令能够首先建立函数库，然后建立所有目标。 
2.在主目录下使用'make tar'命令能够对整个系统进行打包，生成的文件以日期和时间命名。 
3.在最下层子目录中直接使用'make'命令会首先给出用法提示，然后建立本目录所有目标。 
4.在最下层子目录中使用'make all'命令不出现提示信息，直接建立本目录所有目标。 
5.在最下层子目录中使用'make clear'命令可以清除本目录的所有.o文件。 
6.在最下层子目录中使用'make clean'命令可以清除本目录的所有.o文件和建立的所有目标。 

注：在某些环境下，由于make中调用shell命令的机制，可能不支持递归。

 

文章来源http://www.chinaunix.net 作者:FH 

Tags: c makefile
评论(1) 阅读(1432)

[转载]如何写出专业的C头文件

2011年3月01日 16:19

 

做到专业，应该是每个职业程序员应该要求自己做到的。
让我们看看lua是怎么写头文件的。

1.License Agreement
License Agreement应该加在每个头文件的顶部。
Lua Sample:

 

/*
** $Id: lua.h,v 1.175b 2003/03/18 12:31:39 roberto Exp $
** Lua - An Extensible Extension Language
** Tecgraf: Computer Graphics Technology Group, PUC-Rio, Brazil
** http://www.lua.org    mailto:info@lua.org
** See Copyright Notice at the end of this file
*/

 


2.guard define
整个头文件应该在guard define之间

 

#ifndef lua_h
#define lua_h

#endif

 另外，如果这个头文件可能给c++使用，要加上

 

#ifdef __cplusplus
extern "C" {
#endif
/*The lines within extern "C" */



#ifdef __cplusplus
}
#endif

 
3.尽量不要在头文件中暴露数据结构

这样可以用户降低对你的实现的依赖，也减少了用户的编译时间

 

typedef struct lua_State lua_State;
LUA_API lua_State *lua_open (void);
LUA_API void       lua_close (lua_State *L);

 可以看到虽然用户会一直使用lua_State,但是并不知道lua_State的结构是什么

从一个使用lua的例子程序可以看出：

 

#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"

 

int main(int argc, char *argv[])
{
    lua_State *L = lua_open();
    const char *buf = "var = 100";
    int var ;
    luaopen_base(L);
    luaopen_io(L);
    lua_dostring(L, buf);
    lua_getglobal(L, "var");
    var = lua_tonumber(L, -1);
    lua_close(L);
    return 0;
}

 

4．函数声明前加XXX_API已利于拓展

 Lua的例子

#ifndef LUA_API
#define LUA_API              extern
#endif

LUA_API lua_State *lua_open (void);


如果定义了LUA_API就是给LUA内部使用的

如果没定义LUA_API就是for user 的

写Window dll程序经常会用到

 

#ifdef DLLTEST_EXPORTS
#define DLLTEST_API __declspec(dllexport)
#else
#define DLLTEST_API __declspec(dllimport)
#endif

 

 

5.宏的定义

尽量使用括号来包住所定义的对象

 

#define LUA_TNONE       (-1)

#define lua_register(L,n,f) \
       (lua_pushstring(L, n), \
        lua_pushcfunction(L, f), \
        lua_settable(L, LUA_GLOBALSINDEX))

 
6.目录结构

一般应该使用一个单独的include目录来包含要发布的头文件，但不应该把内部使用的头文件包含进去。

Lua  的 include目录只包含了三个头文件

lauxlib.h , lua.h, lualib.h

非常简洁

Tags: c 头文件
评论(0) 阅读(1495)