commit fce228c0807fc0731fbb15643554f6f4a35eb534 Author: Laurence Withers Date: Wed Aug 2 16:31:39 2006 +0100 Reimport libopt++ after changing build system. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d025740 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +obj +html diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d28d2c7 --- /dev/null +++ b/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/README b/README new file mode 100644 index 0000000..e07ed9b --- /dev/null +++ b/README @@ -0,0 +1,14 @@ +libopt++ +======================================================================== +(c)2006, Laurence Withers, . +Released under the GNU GPLv2. See file COPYING or +http://www.gnu.org/copyleft/gpl.html for details. + +Really Quick Instructions +------------------------- + +To build: ./make.sh +To install: ./make.sh install + (you might want to set PREFIX, by default it's /usr/local) + +@TODO@ diff --git a/libopt++.kdevelop b/libopt++.kdevelop new file mode 100644 index 0000000..2ddbc5e --- /dev/null +++ b/libopt++.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/libopt++.kdevelop.filelist b/libopt++.kdevelop.filelist new file mode 100644 index 0000000..81bce2d --- /dev/null +++ b/libopt++.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/make.sh b/make.sh new file mode 100755 index 0000000..75ee505 --- /dev/null +++ b/make.sh @@ -0,0 +1,288 @@ +#!/bin/bash +# libopt++/make.sh +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + + +# This file is the script used to build libopt++. 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/libopt++" + +# for pkg-config +[ -z "${PKGCONFDIR}" ] && PKGCONFDIR="${LIBDIR}/pkgconfig" +[ -z "${FINALLIBDIR}" ] && FINALLIBDIR="${LIBDIR}" +[ -z "${FINALINCLUDEDIR}" ] && FINALINCLUDEDIR="${INCLUDEDIR}" + +# for SDCC-built firmware +[ -z "${HEXDIR}" ] && HEXDIR="${PREFIX}/share/firmware" +[ -z "${SDCC}" ] && SDCC="sdcc" + + + +# 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 html" + + + +# 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="src/$1/build.default" + if [ ! -e "${ITEMS}" ] + then + ITEMS="$(find src -type f -name build.$1)" + fi + + if [ -z "${ITEMS}" ] + then + print_failure "Unrecognised target '$1'" + return 1 + fi + + for item in ${ITEMS} + do + do_cmd source ${item} || exit 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..." + rm -rf ${OUTPUT_DIRS} + print_success "Done" + ;; + + # bad Kdevelop! bad! + -j1) + ;; + -k) + ;; + + *) + build_target ${func} || exit 1 + ;; + esac +done + +exit 0 + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/run-test.sh b/run-test.sh new file mode 100755 index 0000000..d47f607 --- /dev/null +++ b/run-test.sh @@ -0,0 +1,54 @@ +#!/bin/bash +# libopt++/test.sh +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + +# 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 $* + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/scripts/.gitignore b/scripts/.gitignore new file mode 100644 index 0000000..ce33425 --- /dev/null +++ b/scripts/.gitignore @@ -0,0 +1,11 @@ +build.c++.app +build.c++.lib +build.c++.tests +build.c.app +build.c.lib +build.c.tests +build.doxygen.docs +build.none.files +build.sdcc.firmware +module-create.sh +release.sh diff --git a/scripts/functions.sh b/scripts/functions.sh new file mode 100755 index 0000000..da4c72c --- /dev/null +++ b/scripts/functions.sh @@ -0,0 +1,68 @@ +#!/bin/bash +# libopt++/scripts/functions.sh +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + +# 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 +} + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/docs/.params b/src/docs/.params new file mode 100644 index 0000000..efd9ae0 --- /dev/null +++ b/src/docs/.params @@ -0,0 +1 @@ +doxygen docs docs diff --git a/src/docs/Doxyfile.in b/src/docs/Doxyfile.in new file mode 100644 index 0000000..aa3ef13 --- /dev/null +++ b/src/docs/Doxyfile.in @@ -0,0 +1,146 @@ +# libopt++/src/docs/Doxyfile.in +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + +PROJECT_NAME = libopt++ +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/src/docs/MainPage.dox b/src/docs/MainPage.dox new file mode 100644 index 0000000..eefe67f --- /dev/null +++ b/src/docs/MainPage.dox @@ -0,0 +1,23 @@ +/* libopt++/src/docs/MainPage.dox + * + * (c)2006, Laurence Withers, . + * Released under the GNU GPLv2. See file COPYING or + * http://www.gnu.org/copyleft/gpl.html for details. +*/ + +/*! \mainpage + +libopt++ is a library for parsing commandline options passed to the main() function of a program. +It understands short and long style options specified as e.g. \c -x or \c --long. It is similar to +the GNU C library's getopt_long() with a few exceptions (no optional arguments, uses callbacks to +report options, etc.). + +The library's main interface is through the opt::Parser class, which you override to implement +the callbacks. The header file is \c <opt>. + +*/ + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +vim: expandtab:ts=4:sw=4 +*/ diff --git a/src/docs/build.default b/src/docs/build.default new file mode 100644 index 0000000..ca22639 --- /dev/null +++ b/src/docs/build.default @@ -0,0 +1 @@ +source src/docs/build.docs diff --git a/src/docs/build.docs b/src/docs/build.docs new file mode 100644 index 0000000..653c323 --- /dev/null +++ b/src/docs/build.docs @@ -0,0 +1,43 @@ +# 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.docs + + 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 + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/docs/build.install b/src/docs/build.install new file mode 100644 index 0000000..016c75c --- /dev/null +++ b/src/docs/build.install @@ -0,0 +1 @@ +source src/docs/build.install-docs diff --git a/src/docs/build.install-docs b/src/docs/build.install-docs new file mode 100644 index 0000000..66167d3 --- /dev/null +++ b/src/docs/build.install-docs @@ -0,0 +1,21 @@ +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" +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/libopt++/.params b/src/libopt++/.params new file mode 100644 index 0000000..5dfe185 --- /dev/null +++ b/src/libopt++/.params @@ -0,0 +1 @@ +c++ lib libopt++ opt diff --git a/src/libopt++/BadArg.h b/src/libopt++/BadArg.h new file mode 100644 index 0000000..304ddca --- /dev/null +++ b/src/libopt++/BadArg.h @@ -0,0 +1,44 @@ +/* libopt++/src/libopt++/Parser.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +namespace opt { + + + +/*! \brief Exception thrown when options cannot be parsed. + +This exception is thrown whenever the options for a program cannot be parsed, meaning that either an +option is missing a required argument, or an option is not recognised at all. It is derived from +std::exception and has its what() method overloaded to print a useful description of the error. +Alternatively, you can get this from the msg member. + +*/ +class BadArg : public std::exception { +public: + /*! \brief Constructor. + + \param msg Message explanining the error. + + */ + BadArg(const std::string& msg) : msg(msg) { } + + /// Destructor (does nothing special). + virtual ~BadArg() throw() { } + + /// A message explaining the error. + const std::string msg; + + /// Returns \a msg. + virtual const char* what() const throw() { return msg.c_str(); } +}; + + + +} + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/src/libopt++/BottomHeader.h b/src/libopt++/BottomHeader.h new file mode 100644 index 0000000..1bd64d2 --- /dev/null +++ b/src/libopt++/BottomHeader.h @@ -0,0 +1,11 @@ +/* libopt++/src/libopt++/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/src/libopt++/Parser.cpp b/src/libopt++/Parser.cpp new file mode 100644 index 0000000..59f78a2 --- /dev/null +++ b/src/libopt++/Parser.cpp @@ -0,0 +1,158 @@ +/* libopt++/src/libopt++/Parser.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +namespace opt { + + + +Parser::Parser() + : progName(_progName), progPath(_progPath), progDir(_progDir), args(_args) +{ +} + + + +void Parser::addOption(int callbackResult, bool arg, const std::string& opt, char shopt, + const std::string& help) +{ + if(!opt.size() && !shopt) throw std::invalid_argument("opt, shopt"); + opts.push_back(Opt(callbackResult, arg, opt, shopt, help)); +} + + + +void Parser::parse(int argc, const char* const* argv) +{ + bool parseopts = true, expectingArg = false; + int whichOpt = -1; + std::string opt; + + if(argc < 1 || !argv) throw std::invalid_argument("argc/argv[]"); + + // get program name + if(!argv[0]) throw std::invalid_argument("argv[0]"); + _progPath = argv[0]; + std::string::size_type pos = _progPath.rfind('/'); + if(pos != std::string::npos) { + _progName = _progPath.substr(pos + 1, std::string::npos); + _progDir = _progPath.substr(0, pos ?: 1); + } else { + _progName = _progPath; + } + + // interpret remaining arguments / options + for(int i = 1; i < argc; ++i) { + const char* arg = argv[i]; + if(!arg) throw std::invalid_argument("argv[]"); + + if(parseopts && arg[0] && arg[0] == '-' && arg[1]) { + if(expectingArg) goto missingArg; + + if(arg[1] == '-') { + // long option + if(!arg[2]) parseopts = false; // -- switches off option parsing + else { + opt = arg; + whichOpt = findOpt(opt); + if(opts.at(whichOpt).arg) expectingArg = true; + else option(opts.at(whichOpt).result, opt); + } + } else { + // short option[s] + for(const char* p = arg + 1; *p; ++p) { + if(expectingArg) goto missingArg; + opt = "-x"; + opt[1] = *p; + whichOpt = findOpt(opt); + if(opts.at(whichOpt).arg) expectingArg = true; + else option(opts.at(whichOpt).result, opt); + } + } + } else { + if(expectingArg) { + // option argument + expectingArg = false; + option(opts.at(whichOpt).result, opt, arg); + } else { + // program argument + _args.push_back(arg); + } + } + } + + if(!expectingArg) return; + +missingArg: + std::ostringstream str; + str << "Option '" << opt << "' is missing an argument."; + throw BadArg(str.str()); +} + + + +void Parser::showHelp(std::ostream& str) const +{ + const uint end = opts.size(); + std::string::size_type max = 0; + + char oldfill = str.fill(' '); + std::ios_base::fmtflags oldfmt = str.setf(std::ios_base::left, std::ios_base::adjustfield); + + for(uint i = 0; i < end; ++i) { + if(!opts[i].opt.size()) continue; + max = std::max(max, opts[i].opt.size() + (opts[i].arg ? 6 : 0)); + } + + for(uint i = 0, end = opts.size(); i < end; ++i) { + str << " "; + if(opts[i].shopt) { + str << '-' << opts[i].shopt; + if(opts[i].opt.size()) { + str << ", --" << std::setw(max - (opts[i].arg ? 6 : 0)) << opts[i].opt; + if(opts[i].arg) str << " "; + } else { + if(opts[i].arg) str << " " << std::setw(max - 6) << ' '; + else str << std::setw(max) << ' '; + } + } else { + str << " --" << std::setw(max - (opts[i].arg ? 6 : 0)) << opts[i].opt; + if(opts[i].arg) str << " "; + } + + str << " " << opts[i].help << '\n'; + } + str << " Short options without arguments may be combined. Pass -- to\n" + " stop processing options.\n"; + + str.fill(oldfill); + str.setf(oldfmt, std::ios_base::adjustfield); +} + + + +uint Parser::findOpt(const std::string& opt) +{ + const uint end = opts.size(); + + if(opt[1] == '-') { + std::string opt2 = opt.substr(2, std::string::npos); + for(uint pos = 0; pos < end; ++pos) if(opts[pos].opt == opt2) return pos; + } else { + for(uint pos = 0; pos < end; ++pos) if(opts[pos].shopt == opt[1]) return pos; + } + + std::ostringstream str; + str << "Unrecognsied option '" << opt << "'."; + throw BadArg(str.str()); +} + + + +} + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/src/libopt++/Parser.h b/src/libopt++/Parser.h new file mode 100644 index 0000000..04a3d4a --- /dev/null +++ b/src/libopt++/Parser.h @@ -0,0 +1,141 @@ +/* libopt++/src/libopt++/Parser.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +namespace opt { + + + +/*! \brief Main option parser. + +This class is responsible for parsing commandline options. It is an abstract base class; you must +derive from it and overload the option() functions. These specify the behaviour on encountering +options. + +To use the class, you must first instantiate it and then call addOption() for each option your +program understands. Once this is complete, you can call parse() with the argc/argv that were passed +to your program's main(). + +parse() will set \ref progName, \ref progPath and \ref progDir appropriately, and will call option() +for each valid option it encounters. It will store any non-option arguments in the \ref args vector. + +*/ +class Parser { +public: + /// Constructor (does nothing special). + Parser(); + + /// Destructor (does nothing special). + virtual ~Parser() throw() { } + + + + /*! \brief Registers an option that the program understands. + + \param callbackResult This is what is passed to option() as the \a result argument. + \param arg \a true if the option requires an argument, \a false if not. + \param opt The options long name, excluding leading \c --. May be empty. + \param shopt The short option character (used in e.g. \c -v). May be 0 (no short option). + \param help A string displayed when showHelp() is called. May be empty. + \throws std::invalid_argument if \a opt is empty and \a shopt is 0. + + This registers an option that the program understands with the parser engine. Each option has + a corresponding code, \a callbackResult, that is used to uniquely identify it. This is parsed + to the option() callback as the first argument, \a result. An option may have both short and + long forms. + + */ + void addOption(int callbackResult, bool arg, const std::string& opt, char shopt = 0, + const std::string& help = ""); + + + + /*! \brief Parse commandline options. + + \param argc argc from main(), the argument count. + \param argv argv from main(), the argument vector. + \throws std::invalid_argument if argc or argv are invalid in some way (this won't happen if you + pass them directly from main). + \throws Opt::BadArg if an option is unrecognised or missing an argument. + + */ + void parse(int argc, const char* const* argv); + + + + /*! \brief Display help. + + \param ostr The output stream to display help onto (typically \a std::cout). + + This function displays a nicely-formatted list of options to be used as part of a help screen. + It uses the \a help string passed to addOption() to display information about each option. + + */ + void showHelp(std::ostream& ostr) const; + + + + /// The program name (filename only, no path). + const std::string& progName; + + /// The program path (full filename and path, i.e. argv[0]). + const std::string& progPath; + + /// The program directory (relative, without filename). + const std::string& progDir; + + /// A list of the arguments (non-option items on the commandline). + const std::vector& args; + + + + /*! \brief Option callback. + + \param result The result code given as \a callbackResult in addOption(). + \param opt The formatted option name (i.e. "-x" or "--long"). + + This function is the callback for options encountered in parse(). This version does not take + any arguments. + + */ + virtual void option(int result, const std::string& opt) = 0; + + /*! \brief Option callback. + + \param result The result code given as \a callbackResult in addOption(). + \param opt The formatted option name (i.e. "-x" or "--long"). + \param arg The argument following the option. + + This function is the callback for options encountered in parse(). This version takes a + mandatory argument. + + */ + virtual void option(int result, const std::string& opt, const std::string& arg) = 0; + +private: + std::string _progName, _progPath, _progDir; + std::vector _args; + + struct Opt { + int result; + bool arg; + std::string opt; + char shopt; + std::string help; + Opt(int result, bool arg, const std::string& opt, char shopt, const std::string& help) + : result(result), arg(arg), opt(opt), shopt(shopt), help(help) + { } + }; + std::vector opts; + uint findOpt(const std::string& opt); +}; + + + +} + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/src/libopt++/TopHeader.h b/src/libopt++/TopHeader.h new file mode 100644 index 0000000..2c8d7ee --- /dev/null +++ b/src/libopt++/TopHeader.h @@ -0,0 +1,27 @@ +/* libopt++/src/libopt++/TopHeader.h + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#ifndef HEADER_liboptpp +#define HEADER_liboptpp + +// standard includes, or includes needed for type declarations +#include +#include +#include +#include + +/*! \brief libopt++ namespace + * + * Contains classes used to parse commandline options (argc, argv). Like getopt, only for C++. + * The main class is Opt::Parser, which is an abstract base class (override its option() methods). + * There is also an exception class, BadArg, derived from std::exception. + * + * */ +namespace opt { } + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/src/libopt++/TopSource.cpp b/src/libopt++/TopSource.cpp new file mode 100644 index 0000000..e4e58ca --- /dev/null +++ b/src/libopt++/TopSource.cpp @@ -0,0 +1,16 @@ +/* libopt++/src/libopt++/TopSource.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#include "opt" + +// Below are all the includes used throughout the library. +#include +#include +#include + +/* options for text editors +kate: replace-trailing-space-save true; space-indent true; tab-width 4; +*/ diff --git a/src/libopt++/build.default b/src/libopt++/build.default new file mode 100644 index 0000000..382754e --- /dev/null +++ b/src/libopt++/build.default @@ -0,0 +1 @@ +source src/libopt++/build.lib diff --git a/src/libopt++/build.install b/src/libopt++/build.install new file mode 100644 index 0000000..7375671 --- /dev/null +++ b/src/libopt++/build.install @@ -0,0 +1 @@ +source src/libopt++/build.install-lib diff --git a/src/libopt++/build.install-lib b/src/libopt++/build.install-lib new file mode 100644 index 0000000..262a8c5 --- /dev/null +++ b/src/libopt++/build.install-lib @@ -0,0 +1,36 @@ +build_target libopt++ + +# 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 ${liboptpp} ${LIBDIR} 0755 || return 1 +BASE="${liboptpp_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 '${liboptpp_HEADER}' into ${INCLUDEDIR}" +install_header ${liboptpp_HEADER} ${INCLUDEDIR} 0644 || return 1 + +# install pkgconfig file +echo "Installing package config file into ${PKGCONFDIR}" +PKGCONFFILE=${PKGCONFDIR}/libopt++.pc +do_cmd rm -f ${PKGCONFFILE} +do_cmd_redir ${PKGCONFFILE} sed \ + -e "s,@VERSION@,${VERSION}," \ + -e "s,@LIBDIR@,${FINALLIBDIR}," \ + -e "s,@INCLUDEDIR@,${FINALINCLUDEDIR}," \ + src/libopt++/pkgconf.in +do_cmd chmod 0644 ${PKGCONFFILE} +print_success "Done" + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/libopt++/build.lib b/src/libopt++/build.lib new file mode 100644 index 0000000..4187db1 --- /dev/null +++ b/src/libopt++/build.lib @@ -0,0 +1,51 @@ +# These are external variables, and shouldn't clash with anything else +# liboptpp +# liboptpp_BUILT +# liboptpp_HEADER +# liboptpp_BASE + +if [ -z ${liboptpp_BUILT} ] +then + liboptpp_BASE=libopt++ + source src/libopt++/soversion + + liboptpp="obj/${liboptpp_BASE}.so.${SOMAJOR}.${SOMINOR}.${SOMICRO}" + SO_EXTRA="-lstdc++ -lc" + + echo "Building library ${liboptpp}..." + + do_cmd source src/libopt++/build.monolithic || return 1 + + MODIFIED=0 + for test in ${MONOLITHIC_TESTS} ${HDR} ${SRC} + do + if [ ${test} -nt ${liboptpp} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + echo " Compiling" + + SONAME="${liboptpp_BASE}.so.${SOMAJOR}.${SOMINOR}" + do_cmd ${CXX} ${CFLAGS} -shared -fpic -o "${liboptpp}" \ + -Wl,-soname,${SONAME} \ + ${SRC} ${SO_EXTRA} || return 1 + + # make tests work + do_cmd ln -sf $(basename ${liboptpp}) obj/${SONAME} || return 1 + + print_success "Library built" + else + print_success "Library up to date" + fi + + liboptpp_BUILT=1 + liboptpp_HEADER=${HDR} + +fi +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/libopt++/build.monolithic b/src/libopt++/build.monolithic new file mode 100644 index 0000000..50c3b41 --- /dev/null +++ b/src/libopt++/build.monolithic @@ -0,0 +1,21 @@ +# These are external variables, and shouldn't clash with anything else +# liboptpp_MONOLITHIC + +SRC="obj/libopt++.cpp" +HDR="obj/opt" + +MONOLITHIC_TESTS="src/libopt++/build.lib src/libopt++/build.monolithic" + +if [ -z "${liboptpp_MONOLITHIC}" ] +then + MONOLITHIC_SOURCE="$(echo src/libopt++/{TopHeader,BadArg,Parser,BottomHeader}.h)" + make_monolithic ${HDR} C || return 1 + + MONOLITHIC_SOURCE="$(echo src/libopt++/{TopSource,Parser}.cpp)" + make_monolithic ${SRC} C || return 1 + + liboptpp_MONOLITHIC=1 + MONOLITHIC_DOC="${MONOLITHIC_DOC} ${HDR}" +fi +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/libopt++/pkgconf.in b/src/libopt++/pkgconf.in new file mode 100644 index 0000000..0dec374 --- /dev/null +++ b/src/libopt++/pkgconf.in @@ -0,0 +1,21 @@ +# libopt++/src/lib/libopt++/pkgconf.in +# +# Metadata file for pkg-config +# ( http://www.freedesktop.org/software/pkgconfig/ ) +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + +# Name, description +Name: libopt++ +Description: C++ library for parsing commandline options (getopt replacement). +Version: @VERSION@ + +# Requirements +Requires: + +# Compilation information +Libs: -L@LIBDIR@ -lopt++ +Cflags: -I@INCLUDEDIR@ diff --git a/src/libopt++/soversion b/src/libopt++/soversion new file mode 100644 index 0000000..5c940eb --- /dev/null +++ b/src/libopt++/soversion @@ -0,0 +1,17 @@ +# libopt++/src/libopt++/soversion +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + + + +# 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 diff --git a/src/tests/.params b/src/tests/.params new file mode 100644 index 0000000..c48673d --- /dev/null +++ b/src/tests/.params @@ -0,0 +1 @@ +c++ tests tests libopt++ diff --git a/src/tests/build.default b/src/tests/build.default new file mode 100644 index 0000000..2d979e2 --- /dev/null +++ b/src/tests/build.default @@ -0,0 +1,3 @@ +source src/tests/build.tests +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/tests/build.tests b/src/tests/build.tests new file mode 100644 index 0000000..c0313c5 --- /dev/null +++ b/src/tests/build.tests @@ -0,0 +1,43 @@ +# These are external variables, and shouldn't clash with anything else +# tests_BUILT +# + +build_target libopt++ || return 1 + +if [ -z ${tests_BUILT} ] +then + LIBS="${liboptpp}" + EXTRAS="" + + 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 + for file in ${LIBS} ${SRC} src/tests/build.tests + do + if [ ${file} -nt ${TEST} ] + then + MODIFIED=1 + break + fi + done + + if [ ${MODIFIED} -ne 0 ] + then + do_cmd ${CXX} -Iobj ${CFLAGS} -o ${TEST} ${SRC} ${LIBS} ${EXTRAS} || 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 + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 diff --git a/src/tests/simple.cpp b/src/tests/simple.cpp new file mode 100644 index 0000000..3b63520 --- /dev/null +++ b/src/tests/simple.cpp @@ -0,0 +1,98 @@ +/* libopt++/src/tests/simple.cpp + * + * (c)2006, Laurence Withers. Released under the GNU GPL. See file + * COPYING for more information / terms of license. +*/ + +#include "opt" + +#include + + + +class Opt : private opt::Parser { +public: + Opt(int argc, const char* const* argv) + : quiet(false) + { + addOption(OptSummary, false, "print-summary", 0, "Displays a one-line summary of usage."); + addOption(OptHelp, false, "help", 'h', "Displays options and usage."); + addOption(OptPrint, true, "print", 'p', "Prints a string."); + addOption(OptPrint, true, "", 'P', "As -p."); + parse(argc, argv); + } + + virtual ~Opt() throw() { } + + void displayArgs() + { + if(quiet) return; + std::cout << "\nprogName = " << progName + << "\nprogPath = " << progPath + << "\nprogDir = " << progDir + << "\n"; + for(uint i = 0, end = args.size(); i != end; ++i) std::cout << "Argument: " << args[i] << "\n"; + } + +private: + enum { OptSummary, OptHelp, OptPrint }; + bool quiet; + + virtual void option(int result, const std::string& opt) + { + switch(result) { + case OptSummary: + std::cout << "A simple example program with a couple of options.\n"; + quiet = true; + break; + + case OptHelp: + std::cout << "Usage:\n\n " + << progName << " [options] args\n\n"; + showHelp(std::cout); + break; + + default: + std::cerr << "Unrecognised option " << result << " (" << opt << + ") -- this is a program bug.\n"; + } + } + + virtual void option(int result, const std::string& opt, const std::string& arg) + { + switch(result) { + case OptPrint: + std::cout << opt << ": " << arg << "\n"; + break; + + default: + std::cerr << "Unrecognised option " << result << " (" << opt << ' ' << arg << + ") -- this is a program bug.\n"; + } + } +}; + + + +int main(int argc, char* argv[]) +{ + int ret = 0; + try { + Opt o(argc, argv); + o.displayArgs(); + } + 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/src/tests/template b/src/tests/template new file mode 100644 index 0000000..55fd783 --- /dev/null +++ b/src/tests/template @@ -0,0 +1,43 @@ +/* libopt++/src/tests/???.cpp + * + * (c)2006, Laurence Withers, . + * Released under the GNU GPLv2. See file COPYING or + * http://www.gnu.org/copyleft/gpl.html for details. +*/ + +#include "opt" +#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; +vim: expandtab:ts=4:sw=4 +*/ diff --git a/version b/version new file mode 100644 index 0000000..5ba87dc --- /dev/null +++ b/version @@ -0,0 +1,19 @@ +# libopt++/version +# +# (c)2006, Laurence Withers, . +# Released under the GNU GPLv2. See file COPYING or +# http://www.gnu.org/copyleft/gpl.html for details. +# + + + +# 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=4 +VEREXTRA="" + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4