From 5af1a8326248d669de2367761febbe464650779e Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Mon, 24 Jul 2006 14:24:06 +0100 Subject: [PATCH] Initial commit. --- install-lib.sh | 93 ++++++++++ skel/COPYING | 278 +++++++++++++++++++++++++++++ skel/README | 3 + skel/make.sh | 279 ++++++++++++++++++++++++++++++ skel/project.kdevelop | 168 ++++++++++++++++++ skel/project.kdevelop.filelist | 4 + skel/run-test.sh | 50 ++++++ skel/scripts/functions.sh | 64 +++++++ skel/scripts/release.sh | 75 ++++++++ skel/src/capp/TopHeader.h | 11 ++ skel/src/capp/TopSource.c | 11 ++ skel/src/capp/build.app | 40 +++++ skel/src/capp/build.default | 1 + skel/src/capp/build.install | 1 + skel/src/capp/build.install-app | 9 + skel/src/capp/build.monolithic | 15 ++ skel/src/clib/BottomHeader.h | 11 ++ skel/src/clib/TopHeader.h | 14 ++ skel/src/clib/TopSource.c | 13 ++ skel/src/clib/build.default | 1 + skel/src/clib/build.install | 1 + skel/src/clib/build.install-lib | 34 ++++ skel/src/clib/build.lib | 46 +++++ skel/src/clib/build.monolithic | 18 ++ skel/src/clib/pkgconf.in | 20 +++ skel/src/cppapp/TopHeader.h | 11 ++ skel/src/cppapp/TopSource.cpp | 11 ++ skel/src/cppapp/build.app | 40 +++++ skel/src/cppapp/build.default | 1 + skel/src/cppapp/build.install | 1 + skel/src/cppapp/build.install-app | 9 + skel/src/cppapp/build.monolithic | 15 ++ skel/src/cpplib/BottomHeader.h | 11 ++ skel/src/cpplib/TopHeader.h | 14 ++ skel/src/cpplib/TopSource.cpp | 13 ++ skel/src/cpplib/build.default | 1 + skel/src/cpplib/build.install | 1 + skel/src/cpplib/build.install-lib | 34 ++++ skel/src/cpplib/build.lib | 46 +++++ skel/src/cpplib/build.monolithic | 18 ++ skel/src/cpplib/pkgconf.in | 20 +++ skel/src/docs/Doxyfile.in | 145 ++++++++++++++++ skel/src/docs/MainPage.dox | 13 ++ skel/src/docs/build.default | 1 + skel/src/docs/build.docs | 41 +++++ skel/src/docs/build.install | 1 + skel/src/docs/build.install-docs | 19 ++ skel/src/tests/build.default | 1 + skel/src/tests/build.tests | 32 ++++ skel/src/tests/template | 42 +++++ skel/version | 23 +++ 51 files changed, 1824 insertions(+) create mode 100755 install-lib.sh create mode 100644 skel/COPYING create mode 100644 skel/README create mode 100755 skel/make.sh create mode 100644 skel/project.kdevelop create mode 100644 skel/project.kdevelop.filelist create mode 100755 skel/run-test.sh create mode 100755 skel/scripts/functions.sh create mode 100755 skel/scripts/release.sh create mode 100644 skel/src/capp/TopHeader.h create mode 100644 skel/src/capp/TopSource.c create mode 100644 skel/src/capp/build.app create mode 100644 skel/src/capp/build.default create mode 100644 skel/src/capp/build.install create mode 100644 skel/src/capp/build.install-app create mode 100644 skel/src/capp/build.monolithic create mode 100644 skel/src/clib/BottomHeader.h create mode 100644 skel/src/clib/TopHeader.h create mode 100644 skel/src/clib/TopSource.c create mode 100644 skel/src/clib/build.default create mode 100644 skel/src/clib/build.install create mode 100644 skel/src/clib/build.install-lib create mode 100644 skel/src/clib/build.lib create mode 100644 skel/src/clib/build.monolithic create mode 100644 skel/src/clib/pkgconf.in create mode 100644 skel/src/cppapp/TopHeader.h create mode 100644 skel/src/cppapp/TopSource.cpp create mode 100644 skel/src/cppapp/build.app create mode 100644 skel/src/cppapp/build.default create mode 100644 skel/src/cppapp/build.install create mode 100644 skel/src/cppapp/build.install-app create mode 100644 skel/src/cppapp/build.monolithic create mode 100644 skel/src/cpplib/BottomHeader.h create mode 100644 skel/src/cpplib/TopHeader.h create mode 100644 skel/src/cpplib/TopSource.cpp create mode 100644 skel/src/cpplib/build.default create mode 100644 skel/src/cpplib/build.install create mode 100644 skel/src/cpplib/build.install-lib create mode 100644 skel/src/cpplib/build.lib create mode 100644 skel/src/cpplib/build.monolithic create mode 100644 skel/src/cpplib/pkgconf.in create mode 100644 skel/src/docs/Doxyfile.in create mode 100644 skel/src/docs/MainPage.dox create mode 100644 skel/src/docs/build.default create mode 100644 skel/src/docs/build.docs create mode 100644 skel/src/docs/build.install create mode 100644 skel/src/docs/build.install-docs create mode 100644 skel/src/tests/build.default create mode 100644 skel/src/tests/build.tests create mode 100644 skel/src/tests/template create mode 100644 skel/version diff --git a/install-lib.sh b/install-lib.sh new file mode 100755 index 0000000..032edf6 --- /dev/null +++ b/install-lib.sh @@ -0,0 +1,93 @@ +#!/bin/bash +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for details. +# + + + +# Used to create a new project. You pass it the template parameters, it +# does the rest. + + + +# Sanity checks +if [ $# -ne 5 ] +then + echo "Wrong number of arguments. Expecting:" + echo " ./install.sh @P@ @PC@ @HEADER_NAME@" + echo " dest_dir directory in which project subdir will be created" + echo " @P@ package name (e.g. \"libnmc\")" + echo " @PC@ C identifier version of @P@, used in header etc." + echo " @HEADER_NAME@ name of header (e.g. \"lw-support\" or \"nmc\")" + exit 1 +fi + +cd "$(dirname $0)" +TEMPLATE=$(dirname "$(pwd)")/skel + + + +# Get arguments, include standard functions +source scripts/functions.sh || exit 1 +DEST_DIR="$1"; shift +P="$1"; shift +PC="$1"; shift +HEADER_NAME="$1"; shift + + + +# Copy to destination directory. Deal with the case where the user has +# specified the name of the resulting directory, and the case where the +# user simply specified where the directory should be created. +echo "Copying ${TEMPLATE} directory..." +do_cmd cp -rp "${TEMPLATE}" "${DEST_DIR}" || exit 1 +cd "${DEST_DIR}" +if [ -d "${TEMPLATE}" ] +then + mv "${TEMPLATE}" "${P}" + cd "${P}" +fi +print_success "Done: $(pwd)" + + + +# Move the project files to something more sensible +mv project.kdevelop ${P}.kdevelop +mv project.kdevelop.filelist ${P}.kdevelop.filelist + + + +# Build sed script +echo "Changing variables..." +echo " Building script" +SED_SCRIPT="script.sed" +for param in P PC HEADER_NAME +do + echo "s,@${param}@,${!param},g" >> "${SED_SCRIPT}" +done + +# Create a list of all the files. +echo " Building list of files" +ALL_FILES=$(find . -type f -not -name script.sed) + +# Run sed script on all files. +echo " Running script" +for f in ${ALL_FILES} +do + do_cmd sed -f "${SED_SCRIPT}" -i "${f}" || exit 1 +done +print_success "Done" + + + +# Print the todo list +echo +echo " ======== TODO list ========" +grep -Hn @TODO@ ${ALL_FILES} +print_success "Done" + + + +# Clean up +rm "${SED_SCRIPT}" diff --git a/skel/COPYING b/skel/COPYING new file mode 100644 index 0000000..d28d2c7 --- /dev/null +++ b/skel/COPYING @@ -0,0 +1,278 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. diff --git a/skel/README b/skel/README new file mode 100644 index 0000000..5f8e394 --- /dev/null +++ b/skel/README @@ -0,0 +1,3 @@ +@P@ +======================================================================== +@TODO@ diff --git a/skel/make.sh b/skel/make.sh new file mode 100755 index 0000000..3293c4e --- /dev/null +++ b/skel/make.sh @@ -0,0 +1,279 @@ +#!/bin/bash +# @P@/make.sh +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for more information / terms of license. +# + + + +# This file is the script used to build @P@. There are some +# options that can be edited; these are set below (or you can pass them +# in as variables). +[ -z "${CC}" ] && CC="gcc" +[ -z "${CXX}" ] && CXX="g++" +[ -z "${CFLAGS}" ] && CFLAGS="-g -O2 -W -Wall" +[ -z "${PREFIX}" ] && PREFIX="/usr/local" +[ -z "${LIBDIR}" ] && LIBDIR="${PREFIX}/lib" +[ -z "${BINDIR}" ] && BINDIR="${PREFIX}/bin" +[ -z "${INCLUDEDIR}" ] && INCLUDEDIR="${PREFIX}/include" +[ -z "${DOCSDIR}" ] && DOCSDIR="${PREFIX}/share/doc/@P@" + +# for pkg-config +[ -z "${PKGCONFDIR}" ] && PKGCONFDIR="${LIBDIR}/pkgconfig" +[ -z "${FINALLIBDIR}" ] && FINALLIBDIR="${LIBDIR}" +[ -z "${FINALINCLUDEDIR}" ] && FINALINCLUDEDIR="${INCLUDEDIR}" + + + +# Get version information +source version || exit 1 +VERSION="${VERMAJOR}.${VERMINOR}.${VERMICRO}" +if [ ! -z "${VEREXTRA}" ] +then + VERSION="${VERSION}-${VEREXTRA}" +fi + + + +# Get standard functions +[ -z "${VERBOSE}" ] && VERBOSE="0" +source scripts/functions.sh || exit 1 + + +# List of directories which will be emptied by clean. +OUTPUT_DIRS="obj" + + + +# This function makes a monolithic file out of several source files. Its +# first argument is the name of the output file, and the second is the +# format of monolithic file to create (for example, "C" will cause the +# inclusion of "#line" directives at the top of each included file). +# +# It also examines the following variables: +# MONOLITHIC_TESTS if any file mentioned in this list is newer +# than the output file, then we recreate it +# MONOLITHIC_SOURCE a list (in order) of the source files +# +# Recognised formats are: +# none no special processing happens before each file +# C #line directives are inserted before each file +# and VERSION, VERMAJOR etc. are #defined +# +make_monolithic() { + if [ $# -ne 2 ] + then + print_failure "make_monolithic() called with wrong number of arguments" + print_failure "(expecting 2, got $#)" + return 1 + fi + + MONOLITHIC_OUT=$1 + + # extract options + HASHLINE=0 + VERDEFINE=0 + if [ "$2" == "C" ] + then + HASHLINE=1 + VERDEFINE=1 + elif [ "$2" == "none" ] + then + HASHLINE=0 # dummy command + else + print_failure "make_monolithic() called with unknown format $2" + return 1 + fi + + echo " Building monolithic file '${MONOLITHIC_OUT}'..." + + MODIFIED=0 + for FILE in ${MONOLITHIC_TESTS} ${MONOLITHIC_SOURCE} + do + if [ ! -e "${FILE}" ] + then + print_failure "'${FILE}' does not exist" + return 1 + fi + + if [ "${FILE}" -nt ${MONOLITHIC_OUT} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + do_cmd mkdir -p $(dirname ${MONOLITHIC_OUT}) + do_cmd rm -f ${MONOLITHIC_OUT} || exit 1 + + if [ ${VERDEFINE} -ne 0 ] + then + do_cmd_redir ${MONOLITHIC_OUT} echo "#define VERSION \"${VERSION}\"" || return 1 + do_cmd_redir ${MONOLITHIC_OUT} echo "#define VERMAJOR ${VERMAJOR}" || return 1 + do_cmd_redir ${MONOLITHIC_OUT} echo "#define VERMINOR ${VERMINOR}" || return 1 + do_cmd_redir ${MONOLITHIC_OUT} echo "#define VERMICRO ${VERMICRO}" || return 1 + do_cmd_redir ${MONOLITHIC_OUT} echo "#define VEREXTRA \"${VEREXTRA}\"" || return 1 + fi + + for FILE in ${MONOLITHIC_SOURCE} + do + if [ ${HASHLINE} -ne 0 ] + then + do_cmd_redir ${MONOLITHIC_OUT} echo "#line 1 \"${FILE}\"" || return 1 + fi + do_cmd_redir ${MONOLITHIC_OUT} cat "${FILE}" || return 1 + done + print_success "Done" + else + print_success "Up to date" + fi +} + + + +# This will build a directory tree, if required, with mode 0755. The +# argument is the directory to build. +build_dir_tree() { + # sanity check + if [ $# -ne 1 ] + then + print_failure "build_dir_tree() called with wrong number of arguments" + print_failure "(expecting 1, got $#)" + return 1 + fi + + local DIR="$1" + + # if the directory already exists, return success + [ -d "${DIR}" ] && return 0 + + # if something with this name already exists, but not a directory, + # then fail + if [ -e "${DIR}" ] + then + print_failure "Failed to create directory '${DIR}'" + return 1 + fi + + # build the directory, but if it fails, recurse a level (and handle + # the case where recursion fails) + mkdir "${DIR}" >& /dev/null + if [ $? -ne 0 ] + then + build_dir_tree $(dirname "${DIR}") || return 1 + mkdir "${DIR}" + if [ $? -ne 0 ] + then + print_failure "Failed to create directory '${DIR}'" + return 1 + fi + fi + + # set permissions on newly-created dir and return + chmod 0755 "${DIR}" + return 0 +} + + + +# This will install a file. The first parameter is the source, and the +# second is the destination. The third is the octal mode. +install_file() { + # figure out if $2 is a directory or not + DEST_FILE="$2" + [ -d "$2" ] && DEST_FILE="$2/$(basename $1)" + + echo " Installing: '$1' -> '$2'" + do_cmd cp -fP "$1" "${DEST_FILE}" || return 1 + do_cmd chmod "$3" "${DEST_FILE}" || return 1 + + return 0 +} + + + +# This will install a header file. It is basically similar to +# install_file(), only we strip out the #line directives. +install_header() { + DEST_FILE="$2" + [ -d "$2" ] && DEST_FILE="$2/$(basename $1)" + + echo " Installing header: '$1' -> '$2'" + do_cmd rm -f ${DEST_FILE} || exit 1 + do_cmd_redir ${DEST_FILE} sed -e "s,^#line.*,," $1 || exit 1 + do_cmd chmod "$3" "${DEST_FILE}" || return 1 + + return 0 +} + + + +# This installs a symlink. The first argument is the symlink's name; the +# second the symlink's source filename, and the third is the directory +# in which to create the symlink. +install_symlink() { + echo " Installing symlink: '$3/$2' -> '$1'" + + ( do_cmd cd $3; ln -sf $2 $1 ) || return 1 + + return 0 +} + + + +build_target() { + ITEMS="$(find src -type f -name build.$1)" + if [ -z "${ITEMS}" ] + then + print_failure "Unrecognised target '$1'" + return 1 + fi + + for item in ${ITEMS} + do + do_cmd source ${item} || return 1 + done + return 0 +} + + + +######################################################################## +# Main script +######################################################################## + +if [ $# -eq 0 ] +then + targets="default" +else + targets="$@" +fi + +for func in "${targets}" +do + case ${func} in + clean) + echo "Cleaning..." + for dir in ${OUTPUT_DIRS} + do + do_cmd find ${dir} \( -type f -o -type l \) -exec rm {} \; || exit 1 + done + print_success "Done" + ;; + + # bad Kdevelop! bad! + -j1) + ;; + -k) + ;; + + *) + build_target ${func} || exit 1 + ;; + esac +done + +exit 0 diff --git a/skel/project.kdevelop b/skel/project.kdevelop new file mode 100644 index 0000000..2ddbc5e --- /dev/null +++ b/skel/project.kdevelop @@ -0,0 +1,168 @@ + + + + Laurence Withers + l@lwithers.me.uk + $VERSION$ + KDevCustomProject + C++ + + . + false + + + + + + /bin/true + executable + / + + false + true + + + + make + + + + false + 1 + 0 + false + ./make.sh + default + + default + + + + + + + + + + + + + + + + + true + false + false + + + false + true + 10 + + + + + ada + ada_bugs_gcc + bash + bash_bugs + clanlib + fortran_bugs_gcc + gnome1 + gnustep + gtk + gtk_bugs + haskell + haskell_bugs_ghc + java_bugs_gcc + java_bugs_sun + kde2book + opengl + pascal_bugs_fp + php + php_bugs + perl + perl_bugs + python + python_bugs + qt-kdev3 + ruby + ruby_bugs + sdl + sw + w3c-dom-level2-html + w3c-svg + w3c-uaag10 + wxwidgets_bugs + + + Guide to the Qt Translation Tools + Qt Assistant Manual + Qt Designer Manual + Qt Reference Documentation + qmake User Guide + + + KDE Libraries (Doxygen) + + + + + + + + + + + + .h + .cpp + + + + + true + true + true + false + true + true + true + 1 + 1 + 250 + + + + set + m_,_ + theValue + true + true + + + + + + + + + + + + + false + false + + + *.o,*.lo,CVS + false + false + + + + + + + diff --git a/skel/project.kdevelop.filelist b/skel/project.kdevelop.filelist new file mode 100644 index 0000000..81bce2d --- /dev/null +++ b/skel/project.kdevelop.filelist @@ -0,0 +1,4 @@ +# KDevelop Custom Project File List +src/lib/BottomHeader.h +src/lib/TopHeader.h +src/lib/TopSource.cpp diff --git a/skel/run-test.sh b/skel/run-test.sh new file mode 100755 index 0000000..332352d --- /dev/null +++ b/skel/run-test.sh @@ -0,0 +1,50 @@ +#!/bin/bash +# @P@/test.sh +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for more information / terms of license. +# + +# Running this script on its own will display a summary of all the +# available tests; running it with arguments runs the relevant test. + + + +# This runs a test, setting the correct library path. +run_test() { + EXE=obj/tests/$1 + shift + if [ ! -x ${EXE} ] + then + echo "No such test '${EXE}'" + return 1 + fi + + LD_LIBRARY_PATH="obj" ${EXE} "$@" || return 1 + return 0 +} + + + +# This prints summary output from each test app. +print_tests() { + echo "Available tests" + echo "---------------------------------------------------------------------" + for EXE in obj/tests/* + do + [ -x ${EXE} ] || continue + NAME=$(echo ${EXE} | sed 's,obj/tests/,,') + echo -ne "${NAME}\t" + LD_LIBRARY_PATH="obj" ${EXE} --print-summary + done +} + + +# Main script +if [ $# -eq 0 ] +then + print_tests + exit 0 +fi + +run_test $* diff --git a/skel/scripts/functions.sh b/skel/scripts/functions.sh new file mode 100755 index 0000000..ea063cc --- /dev/null +++ b/skel/scripts/functions.sh @@ -0,0 +1,64 @@ +#!/bin/bash +# @P@/scripts/functions.sh +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for more information / terms of license. +# + +# Common functions + + + +# Print a success message +print_success() { + if [ -z "${TERM}" -o "${TERM}" == "dumb" ] + then + echo -n " - " + else + (echo -n -e " \E[32m* "; tput sgr0) + fi + echo $* +} + + + +# Print a failure message +print_failure() { + if [ -z "${TERM}" -o "${TERM}" == "dumb" ] + then + echo -n " *** " + else + (echo -n -e " \E[31m*** "; tput sgr0) + fi + echo $* +} + + + +# This function carries out a command, but reports its failure if +# necessary. +do_cmd() { + [ "${VERBOSE}" != "0" ] && echo "$@" + "$@" + if [ $? -ne 0 ] + then + print_failure "'$@' failed." + return 1 + fi +} + + + +# This function carries out a command, but reports its failure if +# necessary. +do_cmd_redir() { + DEST=$1 + shift + [ "${VERBOSE}" != "0" ] && echo "$@ \>\> ${DEST}" + "$@" >> ${DEST} + if [ $? -ne 0 ] + then + print_failure "'$@' failed." + return 1 + fi +} diff --git a/skel/scripts/release.sh b/skel/scripts/release.sh new file mode 100755 index 0000000..390c328 --- /dev/null +++ b/skel/scripts/release.sh @@ -0,0 +1,75 @@ +#!/bin/bash +# @P@/scripts/release.sh +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for more information / terms of license. +# + +# Prepares package for release. Expects the version number on the +# command line. + + + +# Get the directory of the repository (needed to include functions file) +cd "$(dirname $0)" +REPOS=$(dirname "$(pwd)") +source "${REPOS}/scripts/functions.sh" || exit 1 + + + +# Get version etc. +if [ $# -ne 2 ] +then + echo "Usage: scripts/release.sh " + exit 1 +fi +VER=$1 +DIR=$2 + +PKGNAME="@P@-${VER}" + + + +# move to output directory and clone git repository +echo "Cloning repository..." +do_cmd cd "${DIR}" || exit 1 +do_cmd rm -rf "${PKGNAME}" "${PKGNAME}-doc" || exit 1 +do_cmd git-clone --local --shared -n "${REPOS}" "${PKGNAME}" || exit 1 +do_cmd cd "${PKGNAME}" || exit 1 +print_success "Done" + + + +# Check out a new copy of the library from git +echo "Checking out tag ${VER}..." +do_cmd git-checkout "${VER}" || exit 1 +print_success "Done" + + + +# Check that the default build operation runs; also, build and save the +# documentation whilst we're at it +do_cmd ./make.sh default docs || exit 1 +do_cmd mv html "../${PKGNAME}-doc" || exit 1 + + + +# Clean up +do_cmd ./make.sh clean || exit 1 +do_cmd rm -rf .git || exit 1 + + + +# Build archive, md5sum and signature +cd .. +tar c "${PKGNAME}" | bzip2 > "${PKGNAME}.tar.bz2" +tar c "${PKGNAME}-doc" | bzip2 > "${PKGNAME}-doc.tar.bz2" +md5sum "${PKGNAME}.tar.bz2" > "${PKGNAME}.md5" +md5sum "${PKGNAME}-doc.tar.bz2" > "${PKGNAME}-doc.md5" +gpg -a -b "${PKGNAME}.tar.bz2" +gpg -a -b "${PKGNAME}-doc.tar.bz2" + + + +# clean up +rm -rf "${PKGNAME}" "${PKGNAME}-doc" diff --git a/skel/src/capp/TopHeader.h b/skel/src/capp/TopHeader.h new file mode 100644 index 0000000..4a1d4c4 --- /dev/null +++ b/skel/src/capp/TopHeader.h @@ -0,0 +1,11 @@ +/* @P@/src/capp/TopHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +// standard includes, or includes needed for type declarations + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/capp/TopSource.c b/skel/src/capp/TopSource.c new file mode 100644 index 0000000..2595542 --- /dev/null +++ b/skel/src/capp/TopSource.c @@ -0,0 +1,11 @@ +/* @P@/src/capp/TopSource.c + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +// Below are all the includes used throughout the library. + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/capp/build.app b/skel/src/capp/build.app new file mode 100644 index 0000000..8792303 --- /dev/null +++ b/skel/src/capp/build.app @@ -0,0 +1,40 @@ +# These are external variables, and shouldn't clash with anything else +# APPC +# APPC_BUILT +# + +if [ -z ${APPC_BUILT} ] +then + APP="obj/@P@" + LIBS="" + + echo "Building application ${APP}..." + + source src/capp/build.monolithic + + MODIFIED=0 + for test in ${MONOLITHIC_TESTS} ${HDR} ${SRC} + do + if [ ${test} -nt ${LIB} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + echo " Compiling" + + do_cmd ${CC} ${CFLAGS} -o "${APP}" \ + ${SRC} ${LIBS} || return 1 + + print_success "Application built" + else + print_success "Application up to date" + fi + + APPC=${APP} + APPC_BUILT=1 + +fi diff --git a/skel/src/capp/build.default b/skel/src/capp/build.default new file mode 100644 index 0000000..f06bb1e --- /dev/null +++ b/skel/src/capp/build.default @@ -0,0 +1 @@ +source src/capp/build.lib diff --git a/skel/src/capp/build.install b/skel/src/capp/build.install new file mode 100644 index 0000000..3725062 --- /dev/null +++ b/skel/src/capp/build.install @@ -0,0 +1 @@ +source src/capp/build.install-lib diff --git a/skel/src/capp/build.install-app b/skel/src/capp/build.install-app new file mode 100644 index 0000000..fa6d854 --- /dev/null +++ b/skel/src/capp/build.install-app @@ -0,0 +1,9 @@ +build_target app + +# make paths (this is for Gentoo in particular) +build_dir_tree "${BINDIR}" || return 1 + +# install binary +echo "Installing binaries into '${BINDIR}'" +install_file "${APPC}" "${BINDIR}" 0755 || return 1 +print_success "Done" diff --git a/skel/src/capp/build.monolithic b/skel/src/capp/build.monolithic new file mode 100644 index 0000000..1588330 --- /dev/null +++ b/skel/src/capp/build.monolithic @@ -0,0 +1,15 @@ +# These are external variables, and shouldn't clash with anything else +# APPC_MONOLITHIC +# + +if [ -z "${APPC_MONOLITHIC}" ] +then + SRC="obj/app.c" + + MONOLITHIC_TESTS="src/capp/build.app src/capp/build.monolithic" + MONOLITHIC_SOURCE="$(echo src/lib/TopHeader.h) $(echo src/lib/TopSource.c)" + make_monolithic ${SRC} C || return 1 + + APPC_MONOLITHIC=1 + MONOLITHIC_DOC="${MONOLITHIC_DOC} ${SRC}" +fi diff --git a/skel/src/clib/BottomHeader.h b/skel/src/clib/BottomHeader.h new file mode 100644 index 0000000..702d660 --- /dev/null +++ b/skel/src/clib/BottomHeader.h @@ -0,0 +1,11 @@ +/* @P@/src/clib/BottomHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#endif + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/clib/TopHeader.h b/skel/src/clib/TopHeader.h new file mode 100644 index 0000000..b0591f2 --- /dev/null +++ b/skel/src/clib/TopHeader.h @@ -0,0 +1,14 @@ +/* @P@/src/clib/TopHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#ifndef HEADER_lib@PC@ +#define HEADER_lib@PC@ + +// standard includes, or includes needed for type declarations + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/clib/TopSource.c b/skel/src/clib/TopSource.c new file mode 100644 index 0000000..0213c1f --- /dev/null +++ b/skel/src/clib/TopSource.c @@ -0,0 +1,13 @@ +/* @P@/src/clib/TopSource.c + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#include "@HEADER_NAME@" + +// Below are all the includes used throughout the library. + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/clib/build.default b/skel/src/clib/build.default new file mode 100644 index 0000000..f0a10de --- /dev/null +++ b/skel/src/clib/build.default @@ -0,0 +1 @@ +source src/clib/build.lib diff --git a/skel/src/clib/build.install b/skel/src/clib/build.install new file mode 100644 index 0000000..0b0018f --- /dev/null +++ b/skel/src/clib/build.install @@ -0,0 +1 @@ +source src/clib/build.install-lib diff --git a/skel/src/clib/build.install-lib b/skel/src/clib/build.install-lib new file mode 100644 index 0000000..6e338f2 --- /dev/null +++ b/skel/src/clib/build.install-lib @@ -0,0 +1,34 @@ +build_target lib + +# make paths (this is for Gentoo in particular) +build_dir_tree "${LIBDIR}" || return 1 +build_dir_tree "${PKGCONFDIR}" || return 1 +build_dir_tree "${INCLUDEDIR}" || return 1 + +# install library +echo "Installing libraries into '${LIBDIR}'" +install_file ${LIBC} ${LIBDIR} 0755 || return 1 +BASE="${LIBC_BASE}.so" +MAJOR="${BASE}.${SOMAJOR}" +MINOR="${MAJOR}.${SOMINOR}" +MICRO="${MINOR}.${SOMICRO}" +install_symlink "${MINOR}" "${MICRO}" "${LIBDIR}" +install_symlink "${MAJOR}" "${MINOR}" "${LIBDIR}" +install_symlink "${BASE}" "${MAJOR}" "${LIBDIR}" + +# install header +echo "Installing header file '${LIBC_HEADER}' into ${INCLUDEDIR}" +install_header ${LIBC_HEADER} ${INCLUDEDIR} 0644 || return 1 + +# install pkgconfig file +echo "Installing package config file into ${PKGCONFDIR}" +PKGCONFFILE=${PKGCONFDIR}/@P@.pc +do_cmd rm -f ${PKGCONFFILE} +do_cmd_redir ${PKGCONFFILE} sed \ + -e "s,@VERSION@,${VERSION}," \ + -e "s,@LIBDIR@,${FINALLIBDIR}," \ + -e "s,@INCLUDEDIR@,${FINALINCLUDEDIR}," \ + src/clib/pkgconf.in +do_cmd chmod 0644 ${PKGCONFFILE} +print_success "Done" + diff --git a/skel/src/clib/build.lib b/skel/src/clib/build.lib new file mode 100644 index 0000000..b2ca416 --- /dev/null +++ b/skel/src/clib/build.lib @@ -0,0 +1,46 @@ +# These are external variables, and shouldn't clash with anything else +# LIBC +# LIBC_BUILT +# LIBC_HEADER +# LIBC_BASE + +if [ -z ${LIBC_BUILT} ] +then + + LIB_BASE="@P@" + LIB="obj/${LIB_BASE}.so.${SOMAJOR}.${SOMINOR}.${SOMICRO}" + SO_LIBS="-lc" + + echo "Building library ${LIB}..." + + source src/clib/build.monolithic + + MODIFIED=0 + for test in ${MONOLITHIC_TESTS} ${HDR} ${SRC} + do + if [ ${test} -nt ${LIB} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + echo " Compiling" + + do_cmd ${CC} ${CFLAGS} -shared -fpic -o "${LIB}" \ + -Wl,-soname,${LIB_BASE}.so.${SOMAJOR}.${SOMINOR} \ + ${SRC} ${SO_LIBS} || return 1 + + print_success "Library built" + else + print_success "Library up to date" + fi + + LIBC=${LIB} + LIBC_BUILT=1 + LIBC_HEADER=${HDR} + LIBC_BASE=${LIB_BASE} + +fi diff --git a/skel/src/clib/build.monolithic b/skel/src/clib/build.monolithic new file mode 100644 index 0000000..8bfd6d7 --- /dev/null +++ b/skel/src/clib/build.monolithic @@ -0,0 +1,18 @@ +# These are external variables, and shouldn't clash with anything else +# LIBC_MONOLITHIC + +if [ -z "${LIBC_MONOLITHIC}" ] +then + SRC="obj/lib.c" + HDR="obj/@HEADER_NAME@" + + MONOLITHIC_TESTS="src/clib/build.lib src/clib/build.monolithic" + MONOLITHIC_SOURCE="$(echo src/lib/{TopHeader,BottomHeader}.h)" + make_monolithic ${HDR} C || return 1 + + MONOLITHIC_SOURCE="$(echo src/lib/TopSource.c)" + make_monolithic ${SRC} C || return 1 + + LIBC_MONOLITHIC=1 + MONOLITHIC_DOC="${MONOLITHIC_DOC} ${HDR}" +fi diff --git a/skel/src/clib/pkgconf.in b/skel/src/clib/pkgconf.in new file mode 100644 index 0000000..5862c6a --- /dev/null +++ b/skel/src/clib/pkgconf.in @@ -0,0 +1,20 @@ +# @P@/src/lib/clib/pkgconf.in +# +# Metadata file for pkg-config +# ( http://www.freedesktop.org/software/pkgconfig/ ) +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for details. +# + +# Name, description +Name: @TODO@ +Description: @TODO@ +Version: @VERSION@ + +# Requirements +Requires: + +# Compilation information +Libs: -L@LIBDIR@ -l@P@ +Cflags: -I@INCLUDEDIR@ diff --git a/skel/src/cppapp/TopHeader.h b/skel/src/cppapp/TopHeader.h new file mode 100644 index 0000000..0efb810 --- /dev/null +++ b/skel/src/cppapp/TopHeader.h @@ -0,0 +1,11 @@ +/* @P@/src/cppapp/TopHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +// standard includes, or includes needed for type declarations + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/cppapp/TopSource.cpp b/skel/src/cppapp/TopSource.cpp new file mode 100644 index 0000000..a623c9f --- /dev/null +++ b/skel/src/cppapp/TopSource.cpp @@ -0,0 +1,11 @@ +/* @P@/src/cppapp/TopSource.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +// Below are all the includes used throughout the library. + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/cppapp/build.app b/skel/src/cppapp/build.app new file mode 100644 index 0000000..360826b --- /dev/null +++ b/skel/src/cppapp/build.app @@ -0,0 +1,40 @@ +# These are external variables, and shouldn't clash with anything else +# APPCPP +# APPCPP_BUILT +# + +if [ -z ${APPCPP_BUILT} ] +then + APP="obj/@P@" + LIBS="" + + echo "Building application ${APP}..." + + source src/cppapp/build.monolithic + + MODIFIED=0 + for test in ${MONOLITHIC_TESTS} ${HDR} ${SRC} + do + if [ ${test} -nt ${LIB} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + echo " Compiling" + + do_cmd ${CXX} ${CFLAGS} -o "${APP}" \ + ${SRC} ${LIBS} || return 1 + + print_success "Application built" + else + print_success "Application up to date" + fi + + APPCPP=${APP} + APPCPP_BUILT=1 + +fi diff --git a/skel/src/cppapp/build.default b/skel/src/cppapp/build.default new file mode 100644 index 0000000..100c38b --- /dev/null +++ b/skel/src/cppapp/build.default @@ -0,0 +1 @@ +source src/cppapp/build.lib diff --git a/skel/src/cppapp/build.install b/skel/src/cppapp/build.install new file mode 100644 index 0000000..3568d31 --- /dev/null +++ b/skel/src/cppapp/build.install @@ -0,0 +1 @@ +source src/cppapp/build.install-lib diff --git a/skel/src/cppapp/build.install-app b/skel/src/cppapp/build.install-app new file mode 100644 index 0000000..1770d15 --- /dev/null +++ b/skel/src/cppapp/build.install-app @@ -0,0 +1,9 @@ +build_target app + +# make paths (this is for Gentoo in particular) +build_dir_tree "${BINDIR}" || return 1 + +# install binary +echo "Installing binaries into '${BINDIR}'" +install_file "${APPCPP}" "${BINDIR}" 0755 || return 1 +print_success "Done" diff --git a/skel/src/cppapp/build.monolithic b/skel/src/cppapp/build.monolithic new file mode 100644 index 0000000..b744f15 --- /dev/null +++ b/skel/src/cppapp/build.monolithic @@ -0,0 +1,15 @@ +# These are external variables, and shouldn't clash with anything else +# APPCPP_MONOLITHIC +# + +if [ -z "${APPCPP_MONOLITHIC}" ] +then + SRC="obj/app.cpp" + + MONOLITHIC_TESTS="src/cppapp/build.app src/cppapp/build.monolithic" + MONOLITHIC_SOURCE="$(echo src/lib/TopHeader.h) $(echo src/lib/TopSource.cpp)" + make_monolithic ${SRC} C || return 1 + + APPCPP_MONOLITHIC=1 + MONOLITHIC_DOC="${MONOLITHIC_DOC} ${SRC}" +fi diff --git a/skel/src/cpplib/BottomHeader.h b/skel/src/cpplib/BottomHeader.h new file mode 100644 index 0000000..129c84f --- /dev/null +++ b/skel/src/cpplib/BottomHeader.h @@ -0,0 +1,11 @@ +/* @P@/src/cpplib/BottomHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#endif + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/cpplib/TopHeader.h b/skel/src/cpplib/TopHeader.h new file mode 100644 index 0000000..ac478fc --- /dev/null +++ b/skel/src/cpplib/TopHeader.h @@ -0,0 +1,14 @@ +/* @P@/src/cpplib/TopHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#ifndef HEADER_@PC@ +#define HEADER_@PC@ + +// standard includes, or includes needed for type declarations + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/cpplib/TopSource.cpp b/skel/src/cpplib/TopSource.cpp new file mode 100644 index 0000000..ace6352 --- /dev/null +++ b/skel/src/cpplib/TopSource.cpp @@ -0,0 +1,13 @@ +/* @P@/src/cpplib/TopSource.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#include "@HEADER_NAME@" + +// Below are all the includes used throughout the library. + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/cpplib/build.default b/skel/src/cpplib/build.default new file mode 100644 index 0000000..84b57d8 --- /dev/null +++ b/skel/src/cpplib/build.default @@ -0,0 +1 @@ +source src/cpplib/build.lib diff --git a/skel/src/cpplib/build.install b/skel/src/cpplib/build.install new file mode 100644 index 0000000..bbb5a2a --- /dev/null +++ b/skel/src/cpplib/build.install @@ -0,0 +1 @@ +source src/cpplib/build.install-lib diff --git a/skel/src/cpplib/build.install-lib b/skel/src/cpplib/build.install-lib new file mode 100644 index 0000000..a4a9a18 --- /dev/null +++ b/skel/src/cpplib/build.install-lib @@ -0,0 +1,34 @@ +build_target lib + +# make paths (this is for Gentoo in particular) +build_dir_tree "${LIBDIR}" || return 1 +build_dir_tree "${PKGCONFDIR}" || return 1 +build_dir_tree "${INCLUDEDIR}" || return 1 + +# install library +echo "Installing libraries into '${LIBDIR}'" +install_file ${LIBCPP} ${LIBDIR} 0755 || return 1 +BASE="${LIBCPP_BASE}.so" +MAJOR="${BASE}.${SOMAJOR}" +MINOR="${MAJOR}.${SOMINOR}" +MICRO="${MINOR}.${SOMICRO}" +install_symlink "${MINOR}" "${MICRO}" "${LIBDIR}" +install_symlink "${MAJOR}" "${MINOR}" "${LIBDIR}" +install_symlink "${BASE}" "${MAJOR}" "${LIBDIR}" + +# install header +echo "Installing header file '${LIBCPP_HEADER}' into ${INCLUDEDIR}" +install_header ${LIBCPP_HEADER} ${INCLUDEDIR} 0644 || return 1 + +# install pkgconfig file +echo "Installing package config file into ${PKGCONFDIR}" +PKGCONFFILE=${PKGCONFDIR}/@P@.pc +do_cmd rm -f ${PKGCONFFILE} +do_cmd_redir ${PKGCONFFILE} sed \ + -e "s,@VERSION@,${VERSION}," \ + -e "s,@LIBDIR@,${FINALLIBDIR}," \ + -e "s,@INCLUDEDIR@,${FINALINCLUDEDIR}," \ + src/cpplib/pkgconf.in +do_cmd chmod 0644 ${PKGCONFFILE} +print_success "Done" + diff --git a/skel/src/cpplib/build.lib b/skel/src/cpplib/build.lib new file mode 100644 index 0000000..4a9f86b --- /dev/null +++ b/skel/src/cpplib/build.lib @@ -0,0 +1,46 @@ +# These are external variables, and shouldn't clash with anything else +# LIBCPP +# LIBCPP_BUILT +# LIBCPP_HEADER +# LIBCPP_BASE + +if [ -z ${LIBCPP_BUILT} ] +then + + LIB_BASE="@P@" + LIB="obj/${LIB_BASE}.so.${SOMAJOR}.${SOMINOR}.${SOMICRO}" + SO_LIBS="-lstdc++ -lc" + + echo "Building library ${LIB}..." + + source src/cpplib/build.monolithic + + MODIFIED=0 + for test in ${MONOLITHIC_TESTS} ${HDR} ${SRC} + do + if [ ${test} -nt ${LIB} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + echo " Compiling" + + do_cmd ${CXX} ${CFLAGS} -shared -fpic -o "${LIB}" \ + -Wl,-soname,${LIB_BASE}.so.${SOMAJOR}.${SOMINOR} \ + ${SRC} ${SO_LIBS} || return 1 + + print_success "Library built" + else + print_success "Library up to date" + fi + + LIBCPP=${LIB} + LIBCPP_BUILT=1 + LIBCPP_HEADER=${HDR} + LIBCPP_BASE=${LIB_BASE} + +fi diff --git a/skel/src/cpplib/build.monolithic b/skel/src/cpplib/build.monolithic new file mode 100644 index 0000000..6d71856 --- /dev/null +++ b/skel/src/cpplib/build.monolithic @@ -0,0 +1,18 @@ +# These are external variables, and shouldn't clash with anything else +# LIBCPP_MONOLITHIC + +if [ -z "${LIBCPP_MONOLITHIC}" ] +then + SRC="obj/lib.cpp" + HDR="obj/@HEADER_NAME@" + + MONOLITHIC_TESTS="src/cpplib/build.lib src/cpplib/build.monolithic" + MONOLITHIC_SOURCE="$(echo src/lib/{TopHeader,BottomHeader}.h)" + make_monolithic ${HDR} C || return 1 + + MONOLITHIC_SOURCE="$(echo src/lib/TopSource.cpp)" + make_monolithic ${SRC} C || return 1 + + LIBCPP_MONOLITHIC=1 + MONOLITHIC_DOC="${MONOLITHIC_DOC} ${HDR}" +fi diff --git a/skel/src/cpplib/pkgconf.in b/skel/src/cpplib/pkgconf.in new file mode 100644 index 0000000..c4c4cd3 --- /dev/null +++ b/skel/src/cpplib/pkgconf.in @@ -0,0 +1,20 @@ +# @P@/src/lib/cpplib/pkgconf.in +# +# Metadata file for pkg-config +# ( http://www.freedesktop.org/software/pkgconfig/ ) +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for details. +# + +# Name, description +Name: @TODO@ +Description: @TODO@ +Version: @VERSION@ + +# Requirements +Requires: + +# Compilation information +Libs: -L@LIBDIR@ -l@P@ +Cflags: -I@INCLUDEDIR@ diff --git a/skel/src/docs/Doxyfile.in b/skel/src/docs/Doxyfile.in new file mode 100644 index 0000000..45ca5ef --- /dev/null +++ b/skel/src/docs/Doxyfile.in @@ -0,0 +1,145 @@ +# @P@/src/docs/Doxyfile.in +# +# (c)2006, Laurence Withers. Released under the GNU GPL. See file +# COPYING for more information / terms of license. +# + +PROJECT_NAME = @P@ +OUTPUT_DIRECTORY = +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +USE_WINDOWS_ENCODING = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = YES +DETAILS_AT_TOP = YES +INHERIT_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 4 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +SUBGROUPING = YES +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO +SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = src/docs +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +VERBATIM_HEADERS = NO +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_XML = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_PERLMOD = NO +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = DOXYGEN +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = NO +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +CALL_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = NO +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = YES +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +SEARCHENGINE = NO diff --git a/skel/src/docs/MainPage.dox b/skel/src/docs/MainPage.dox new file mode 100644 index 0000000..400971b --- /dev/null +++ b/skel/src/docs/MainPage.dox @@ -0,0 +1,13 @@ +/* @P@/src/docs/MainPage.txt + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +/*! \mainpage + +*/ + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/src/docs/build.default b/skel/src/docs/build.default new file mode 100644 index 0000000..ca22639 --- /dev/null +++ b/skel/src/docs/build.default @@ -0,0 +1 @@ +source src/docs/build.docs diff --git a/skel/src/docs/build.docs b/skel/src/docs/build.docs new file mode 100644 index 0000000..1309d0e --- /dev/null +++ b/skel/src/docs/build.docs @@ -0,0 +1,41 @@ +# These are external variables, and shouldn't clash with anything else +# DOCS_BUILT +# + +MONOLITHIC_DOC="${MONOLITHIC_DOC} $(echo src/docs/*.dox)" +build_target monolithic + +if [ -z ${DOCS_BUILT} ] +then + echo "Building documentation with Doxygen..." + + DOXYFILE=obj/Doxyfile + + if [ ! -e ${DOXYFILE} ] + then + do_cmd cp src/docs/Doxyfile.in ${DOXYFILE} || return 1 + echo "INPUT = ${MONOLITHIC_DOC}" >> ${DOXYFILE} + echo "PROJECT_NUMBER = ${VERSION}" >> ${DOXYFILE} + fi + + MODIFIED=0 + for file in ${MONOLITHIC_DOC} + do + if [ ${file} -nt html/index.html ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + do_cmd doxygen ${DOXYFILE} || return 1 + print_success "Documentation built" + else + print_success "Documentation is up to date" + fi + + DOCS_BUILT=1 +fi + diff --git a/skel/src/docs/build.install b/skel/src/docs/build.install new file mode 100644 index 0000000..016c75c --- /dev/null +++ b/skel/src/docs/build.install @@ -0,0 +1 @@ +source src/docs/build.install-docs diff --git a/skel/src/docs/build.install-docs b/skel/src/docs/build.install-docs new file mode 100644 index 0000000..9af0931 --- /dev/null +++ b/skel/src/docs/build.install-docs @@ -0,0 +1,19 @@ +build_target docs + +# create documentation directories +echo "Installing documentation into ${DOCSDIR}" +build_dir_tree "${DOCSDIR}/html" || return 1 + +# copy across the Doxygen-generated documentation +for file in html/* +do + install_file ${file} ${DOCSDIR}/html 0644 || return 1 +done + +# copy across the generic files +for file in COPYING README +do + install_file ${file} ${DOCSDIR} 0644 || return 1 +done + +print_success "Documentation installed" diff --git a/skel/src/tests/build.default b/skel/src/tests/build.default new file mode 100644 index 0000000..1ae62a2 --- /dev/null +++ b/skel/src/tests/build.default @@ -0,0 +1 @@ +source src/tests/build.tests diff --git a/skel/src/tests/build.tests b/skel/src/tests/build.tests new file mode 100644 index 0000000..059d9d9 --- /dev/null +++ b/skel/src/tests/build.tests @@ -0,0 +1,32 @@ +# These are external variables, and shouldn't clash with anything else +# TESTS_BUILT +# + +build_target lib +LIBS="${LIBCPP}" + +if [ -z ${TESTS_BUILT} ] +then + echo "Building test programs..." + do_cmd mkdir -p obj/tests || return 1 + + for SRC in src/tests/*.cpp + do + TEST="obj/tests/$(basename ${SRC} | sed -e 's,.cpp$,,')" + MODIFIED=0 + [ ${LIBOPT} -nt ${TEST} -o ${SRC} -nt ${TEST} ] && MODIFIED=1 + + if [ ${MODIFIED} -ne 0 ] + then + do_cmd ${CXX} -Iobj ${CFLAGS} -o ${TEST} ${SRC} ${LIBS} || return 1 + print_success "Built ${TEST}" + else + print_success "${TEST} is up to date" + fi + done + + print_success "All tests built" + + TESTS_BUILT=1 +fi + diff --git a/skel/src/tests/template b/skel/src/tests/template new file mode 100644 index 0000000..962d7a1 --- /dev/null +++ b/skel/src/tests/template @@ -0,0 +1,42 @@ +/* @P@/src/tests/???.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#include "@HEADER_NAME@" + +#include + + + +int main(int argc, char* argv[]) +{ + if(argc == 2 && !strcmp(argv[1], "--print-summary")) { + std::cout << "One line summary.\n"; + return 0; + } + + if(argc == 1) { + // empty argument list + } + + int ret = 0; + try { + // TODO + } + catch(std::exception& e) { + std::cerr << e.what() << std::endl; + ret = 1; + } + catch(...) { + std::cerr << "Unknown exception caught." << std::endl; + ret = 1; + } + + return ret; +} + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/skel/version b/skel/version new file mode 100644 index 0000000..5785ac2 --- /dev/null +++ b/skel/version @@ -0,0 +1,23 @@ +# @P@/version +# + + + +# VERSION contains the full version number of the library, which is +# expected to be in 'major.minor.micro' format. It can optionally be +# suffixed with a string. +VERMAJOR=1 +VERMINOR=0 +VERMICRO=2 +VEREXTRA="" + + + +# SOMAJOR and SOMINOR are included in the library's soname. They need to +# be bumped on a binary-incompatible release. They are both single +# integers. +SOMAJOR=0 +SOMINOR=0 + +# SOMICRO is bumped every time there is a binary-compatible release. +SOMICRO=0