Skip to content

Commit

Permalink
First public version
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas Pouillon committed Oct 11, 2011
0 parents commit 115c552
Show file tree
Hide file tree
Showing 43 changed files with 4,978 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.libs
.deps
Makefile.in
glob:Makefile
aclocal.m4
autom4te.cache
config.h.in
config.h
autotools/
glob:configure
missing
glob:*.pc
glob:*.lo
glob:*.la
glob:*.o
stamp-h1
depcomp
install-sh
libtool
ltmain.sh
m4
doc/html
configure
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Copyright © 2011, Nicolas Pouillon, Freebox SAS
Contact, questions: [email protected]
4 changes: 4 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
2011-10-06 Nicolas Pouillon

* First public version

25 changes: 25 additions & 0 deletions LICENSE.TXT
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Copyright © 2011 Freebox SA. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.

This software is provided ``as is'' and any express or implied
warranties, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose are
disclaimed. In no event shall author or contributors be liable for any
direct, indirect, incidental, special, exemplary, or consequential
damages (including, but not limited to, procurement of substitute
goods or services; loss of use, data, or profits; or business
interruption) however caused and on any theory of liability, whether
in contract, strict liability, or tort (including negligence or
otherwise) arising in any way out of the use of this software, even if
advised of the possibility of such damage.
9 changes: 9 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

ACLOCAL_AMFLAGS = -I autotools

noinst_DATA = ChangeLog

SUBDIRS=include src test doc

pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = rudp.pc
55 changes: 55 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.61])
AC_INIT([librudp], [0.3], [[email protected]])
AC_CONFIG_MACRO_DIR([autotools])
AC_CONFIG_AUX_DIR([autotools])

AC_CONFIG_SRCDIR([src/rudp.c])
AC_CONFIG_HEADERS([config.h])

AM_INIT_AUTOMAKE([1.10 foreign dist-bzip2])

dnl AM_SILENT_RULES([yes])

# Checks for programs.
AC_PROG_CC

if test "x$GCC" = "xyes"; then
GCC_CFLAGS="-Wall -g -Wstrict-prototypes -Wmissing-prototypes -fvisibility=hidden"
fi
AC_SUBST(GCC_CFLAGS)

# Initialize libtool
LT_PREREQ([2.2])
LT_INIT

# Checks for header files.
AC_CHECK_HEADERS([stdint.h stdlib.h])

AC_PATH_PROG([mkdoc], [mkdoc])
AM_CONDITIONAL(HAVE_MKDOC, test x$mkdoc != x)

# Checks for typedefs, structures, and compiler characteristics.
AC_C_INLINE
AC_TYPE_UINT32_T

AM_PROG_LIBTOOL

# Checks for libraries.
PKG_CHECK_MODULES(ELA, ela)

# Checks for library functions.
AC_FUNC_MALLOC

AC_CONFIG_FILES([
rudp.pc
Makefile
doc/Makefile
include/Makefile
include/rudp/Makefile
src/Makefile
test/Makefile
])
AC_OUTPUT
19 changes: 19 additions & 0 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

if HAVE_MKDOC

html-local:
$(mkdoc) \
--conf-file $(srcdir)/mkdoc.conf \
--doc-path $(srcdir)/. \
-I $(top_srcdir)/include \
rudp/compiler.h rudp/error.h rudp/time.h \
rudp/list.h rudp/rudp.h rudp/packet.h \
rudp/address.h \
rudp/endpoint.h rudp/peer.h rudp/client.h \
rudp/server.h


clean-local:
-rm -r html

endif
6 changes: 6 additions & 0 deletions doc/html_title.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<h2>@@doc_title@@</h2>
<h3>@@doc_subtitle@@</h3>
<p class="copy_info">&copy; Freebox,
@@doc_author@@,
@@doc_date@@
</p>
13 changes: 13 additions & 0 deletions doc/mkdoc.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
@setopt output_filename {liblea}
@setopt doc_title {Reliable UDP transport library}
@setopt doc_author {Nicolas Pouillon}
@setopt show_type_keyword {1}
@setopt function_overloading {0}
@setopt hide_internal
@setopt hide_experimental
@setopt output_path {.}
@setopt html_single_js {1}
@setopt html_embed_css {1}
@setopt html_css_optimize {1}
@setopt titled_refs {1}
@setopt top_file {top.mkdoc}
Empty file added doc/modules.mkdoc
Empty file.
126 changes: 126 additions & 0 deletions doc/template.mkdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
@c
@c Default template.mkdoc file for C projects copied by mkdoc
@c

@c ===== member doc =====

@macro _member_doc id
@insert {@id@} decl_warn_sentence
@insert {@id@} decl_location_sentence
@insert {@id@} decl_homonyms_sentence
@insert {@id@} decl_cpp_condition_sentence
@insert {@id@} decl_involved_macros_sentence

@insert {@id@} decl_inline_doc
@insert {@id@} decl_content
@insert {@id@} see_related_typedefs

@insert {No documentation available} on_empty_section
@end macro

@c ===== compound members detail =====

@macro _compound_details id

@foreach mid {typedef,enum,struct,function,variable,macro} {@id@} {1}
@section {} {@mid@}
@invoke {@mid@} _member_doc
@end section
@end foreach

@end macro

@c ===== compound documentation macro for internal use =====

@macro _compound_doc id

@c short member doc with link to detailed description
@insert {@id@} decl_short_desc @exref {Description} {More}

@ifsymtype {@id@} {module}
@section e {Related headers}
@insert {header} {1} {@id@} compound_table
@end section
@end if

@ifsymtype {@id@} {header}
@section e {Header inclusion}
@c @insert {@id@} {D} inclusion_diagram

@c @section e {Included files}
@insert {@id@} include_list
@c @end section

@c @section e {Including files}
@c @insert {@id@} included_by_list
@c @end section
@end section
@end if

@section e {Members}
@insert {@id@} compound_member_list
@end section

@section e {Description}
@insert {@id@} decl_inline_doc
@end section

@end macro

@c ===== compound section macro for internal use =====

@macro _compound_section type id name

@section P {@name@ @type@ reference} {@id@}
@invoke {@id@} _compound_doc

@c change this to specify where member details must be written
@c @ifsymtype {@id@} {namespace}
@ifsymtype {@id@} {header}
@section e {Members detail}
@invoke {@id@} _compound_details
@end section
@end if

@end section

@end macro

@c ===== compound section with documentation and member details =====

@macro member_section name

@lookup id {@name@}
@section {} {@id@}
@invoke {@id@} _member_doc
@end section
@end lookup

@end macro

@c ===== compound section with documentation and member details =====

@macro compound_section name

@lookup id mname mtype {@name@}
@invoke {@mtype@} {@id@} {@mname@} _compound_section
@end lookup

@end macro

@c ===== global scope section with documentation and member details =====

@macro global_scope_doc
@invoke {::} _compound_doc
@end macro

@c ===== documentation sections for all compounds of given types =====

@macro all_compound_sections types scope

@foreach id name type {@types@} {@scope@} {0}
@invoke {@type@} {@id@} {@name@} _compound_section
@end foreach

@end macro

Loading

0 comments on commit 115c552

Please sign in to comment.