diff --git a/livesupport/modules/core/include/LiveSupport/Core/LocalizedObject.h b/livesupport/modules/core/include/LiveSupport/Core/LocalizedObject.h index c2a4e85e4..0616b0cf4 100644 --- a/livesupport/modules/core/include/LiveSupport/Core/LocalizedObject.h +++ b/livesupport/modules/core/include/LiveSupport/Core/LocalizedObject.h @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.5 $ + Version : $Revision: 1.6 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/core/include/LiveSupport/Core/LocalizedObject.h,v $ ------------------------------------------------------------------------------*/ @@ -64,7 +64,7 @@ namespace Core { * to make localized life easier. * * @author $Author: maroy $ - * @version $Revision: 1.5 $ + * @version $Revision: 1.6 $ */ class LocalizedObject { @@ -236,12 +236,99 @@ class LocalizedObject * specified by patternKey * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html */ - virtual Ptr::Ref + virtual Ptr::Ref formatMessage(const char * patternKey, Formattable * arguments, unsigned int nArguments) throw (std::invalid_argument); + /** + * A convenience function to format a message, based on a pattern + * loaded from a resource. + * For more information, see the ICU MessageFormat class + * documentation. + * + * @param patternKey the key of the pattern to format + * @param arguments the arguments to use in the formatting + * @param nArguments the number of arguments supplied + * @return the formatted string + * @exception std::invalid_argument if the pattern is bad, or + * the arguments do not match, or there is no resource + * specified by patternKey + * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html + */ + virtual Ptr::Ref + formatMessage(const std::string & patternKey, + Formattable * arguments, + unsigned int nArguments) + throw (std::invalid_argument) + { + return formatMessage(patternKey.c_str(), arguments, nArguments); + } + + /** + * A convenience function to format a message, based on a pattern + * loaded from a resource, with one argument. + * For more information, see the ICU MessageFormat class + * documentation. + * + * @param patternKey the key of the pattern to format + * @param argument1 the single argument to the message. + * @return the formatted string + * @exception std::invalid_argument if the pattern is bad, or + * the arguments do not match, or there is no resource + * specified by patternKey + * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html + */ + virtual Ptr::Ref + formatMessage(const std::string & patternKey, + const Glib::ustring & argument1) + throw (std::invalid_argument); + + /** + * A convenience function to format a message, based on a pattern + * loaded from a resource, with two arguments. + * For more information, see the ICU MessageFormat class + * documentation. + * + * @param patternKey the key of the pattern to format + * @param argument1 the first argument to the message. + * @param argument2 the second argument to the message. + * @return the formatted string + * @exception std::invalid_argument if the pattern is bad, or + * the arguments do not match, or there is no resource + * specified by patternKey + * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html + */ + virtual Ptr::Ref + formatMessage(const std::string & patternKey, + const Glib::ustring & argument1, + const Glib::ustring & argument2) + throw (std::invalid_argument); + + /** + * A convenience function to format a message, based on a pattern + * loaded from a resource, with three arguments. + * For more information, see the ICU MessageFormat class + * documentation. + * + * @param patternKey the key of the pattern to format + * @param argument1 the first argument to the message. + * @param argument2 the second argument to the message. + * @param argument3 the second argument to the message. + * @return the formatted string + * @exception std::invalid_argument if the pattern is bad, or + * the arguments do not match, or there is no resource + * specified by patternKey + * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html + */ + virtual Ptr::Ref + formatMessage(const std::string & patternKey, + const Glib::ustring & argument1, + const Glib::ustring & argument2, + const Glib::ustring & argument3) + throw (std::invalid_argument); + /** * Convert an ICU unicode string to a Glib ustring. * @@ -262,6 +349,16 @@ class LocalizedObject ustringToUnicodeString(Ptr::Ref gString) throw (); + /** + * Convert a Glib ustring to an ICU unicode string. + * + * @param gString the Glib ustring to convert + * @return the same string as supplied, in ICU unicode form. + */ + static Ptr::Ref + ustringToUnicodeString(const Glib::ustring & gString) + throw (); + /** * Get a string from the resource bundle, as a Glib ustring. * @@ -278,30 +375,20 @@ class LocalizedObject } /** - * A convenience function to format a message, based on a pattern - * loaded from a resource. - * For more information, see the ICU MessageFormat class - * documentation. + * Get a string from the resource bundle, as a Glib ustring. * - * @param patternKey the key of the pattern to format - * @param arguments the arguments to use in the formatting - * @param nArguments the number of arguments supplied - * @return the formatted string, in Glib ustring form - * @exception std::invalid_argument if the pattern is bad, or - * the arguments do not match, or there is no resource - * specified by patternKey - * @see http://oss.software.ibm.com/icu/apiref/classMessageFormat.html + * @param key the key identifying the requested string. + * @return the requested string + * @exception std::invalid_argument if there is no string for the + * specified key. */ - virtual Ptr::Ref - formatMessageUstring(const char * patternKey, - Formattable * arguments, - unsigned int nArguments) + Ptr::Ref + getResourceUstring(const std::string &key) throw (std::invalid_argument) { - return unicodeStringToUstring(formatMessage(patternKey, - arguments, - nArguments)); + return unicodeStringToUstring(getResourceString(key.c_str())); } + }; /* ================================================= external data structures */ diff --git a/livesupport/modules/core/src/LocalizedObject.cxx b/livesupport/modules/core/src/LocalizedObject.cxx index 8de582916..5f042f6ff 100644 --- a/livesupport/modules/core/src/LocalizedObject.cxx +++ b/livesupport/modules/core/src/LocalizedObject.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.6 $ + Version : $Revision: 1.7 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/core/src/LocalizedObject.cxx,v $ ------------------------------------------------------------------------------*/ @@ -171,13 +171,70 @@ LocalizedObject :: formatMessage(Ptr::Ref pattern, /*------------------------------------------------------------------------------ * Format a message, based on a resource key for its pattern *----------------------------------------------------------------------------*/ -Ptr::Ref +Ptr::Ref LocalizedObject :: formatMessage(const char * patternKey, Formattable * arguments, unsigned int nArguments) throw (std::invalid_argument) { - return formatMessage(getResourceString(patternKey), arguments, nArguments); + return unicodeStringToUstring( + formatMessage(getResourceString(patternKey), arguments, nArguments)); +} + + +/*------------------------------------------------------------------------------ + * Format a message, based on a resource key for its pattern + * and one argument for formatting. + *----------------------------------------------------------------------------*/ +Ptr::Ref +LocalizedObject :: formatMessage(const std::string & patternKey, + const Glib::ustring & argument1) + throw (std::invalid_argument) +{ + Ptr::Ref uArgument1 = ustringToUnicodeString(argument1); + Formattable arguments[] = { *uArgument1 }; + + return formatMessage(patternKey, arguments, 1); +} + + +/*------------------------------------------------------------------------------ + * Format a message, based on a resource key for its pattern + * and two arguments for formatting. + *----------------------------------------------------------------------------*/ +Ptr::Ref +LocalizedObject :: formatMessage(const std::string & patternKey, + const Glib::ustring & argument1, + const Glib::ustring & argument2) + throw (std::invalid_argument) +{ + Ptr::Ref uArgument1 = ustringToUnicodeString(argument1); + Ptr::Ref uArgument2 = ustringToUnicodeString(argument2); + Formattable arguments[] = { *uArgument1, + *uArgument2 }; + + return formatMessage(patternKey, arguments, 2); +} + + +/*------------------------------------------------------------------------------ + * Format a message, based on a resource key for its pattern + * and one argument for formatting. + *----------------------------------------------------------------------------*/ +Ptr::Ref +LocalizedObject :: formatMessage(const std::string & patternKey, + const Glib::ustring & argument1, + const Glib::ustring & argument2, + const Glib::ustring & argument3) + throw (std::invalid_argument) +{ + Ptr::Ref uArgument1 = ustringToUnicodeString(argument1); + Ptr::Ref uArgument2 = ustringToUnicodeString(argument2); + Ptr::Ref uArgument3 = ustringToUnicodeString(argument3); + Formattable arguments[] = { *uArgument1, + *uArgument2, + *uArgument3 }; + return formatMessage(patternKey, arguments, 3); } @@ -212,7 +269,7 @@ LocalizedObject :: ustringToUnicodeString( { Ptr::Ref uString(new UnicodeString()); - Glib::ustring::const_iterator it = gString->begin(); + Glib::ustring::const_iterator it = gString->begin(); Glib::ustring::const_iterator end = gString->end(); while (it < end) { uString->append((UChar32) *it++); @@ -221,3 +278,22 @@ LocalizedObject :: ustringToUnicodeString( return uString; } + +/*------------------------------------------------------------------------------ + * Create an ICU UnicodeString from a Glib ustring + *----------------------------------------------------------------------------*/ +Ptr::Ref +LocalizedObject :: ustringToUnicodeString(const Glib::ustring & gString) + throw () +{ + Ptr::Ref uString(new UnicodeString()); + + Glib::ustring::const_iterator it = gString.begin(); + Glib::ustring::const_iterator end = gString.end(); + while (it < end) { + uString->append((UChar32) *it++); + } + + return uString; +} + diff --git a/livesupport/modules/core/src/LocalizedObjectTest.cxx b/livesupport/modules/core/src/LocalizedObjectTest.cxx index 71fa09303..163d872e5 100644 --- a/livesupport/modules/core/src/LocalizedObjectTest.cxx +++ b/livesupport/modules/core/src/LocalizedObjectTest.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.5 $ + Version : $Revision: 1.6 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/core/src/LocalizedObjectTest.cxx,v $ ------------------------------------------------------------------------------*/ @@ -207,7 +207,7 @@ LocalizedObjectTest :: formatMessageTest(void) CPPUNIT_ASSERT(U_SUCCESS(status)); try { - Ptr::Ref message; + Ptr::Ref message; Ptr::Ref locObj(new LocalizedObject(bundle)); Ptr::Ref messages(new LocalizedObject( locObj->getBundle("messages"))); @@ -215,14 +215,22 @@ LocalizedObjectTest :: formatMessageTest(void) // test formatting through a key message = messages->formatMessage("aMessage", arguments, 2); - CPPUNIT_ASSERT( - message->compare("parameter 0: p1, parameter 1: p2" == 0)); + CPPUNIT_ASSERT(*message == "parameter 0: p1, parameter 1: p2"); // test formatting through an explicit pattern + Ptr::Ref uMessage; Ptr::Ref pattern(new UnicodeString( "only 1 parameter: {0}")); - message = LocalizedObject::formatMessage(pattern, arguments, 1); - CPPUNIT_ASSERT(message->compare("only 1 parameter: p1") == 0); + uMessage = LocalizedObject::formatMessage(pattern, arguments, 1); + CPPUNIT_ASSERT(uMessage->compare("only 1 parameter: p1") == 0); + + // test formatting through a key, and a fixed number of parameters + message = messages->formatMessage("aMessage3Args", "p0"); + CPPUNIT_ASSERT(*message == "p0: p0, p2: {2}, p1: {1}"); + message = messages->formatMessage("aMessage3Args", "p0", "p1"); + CPPUNIT_ASSERT(*message == "p0: p0, p2: {2}, p1: p1"); + message = messages->formatMessage("aMessage3Args", "p0", "p1", "p2"); + CPPUNIT_ASSERT(*message == "p0: p0, p2: p2, p1: p1"); } catch (std::invalid_argument &e) { CPPUNIT_FAIL(e.what()); @@ -299,7 +307,7 @@ LocalizedObjectTest :: ustringTest(void) Formattable arguments[] = { "p1", "p2" }; // test formatting through a key - message = messages->formatMessageUstring("aMessage", arguments, 2); + message = messages->formatMessage("aMessage", arguments, 2); CPPUNIT_ASSERT(*message == "parameter 0: p1, parameter 1: p2"); } catch (std::invalid_argument &e) { diff --git a/livesupport/modules/core/var/root.txt b/livesupport/modules/core/var/root.txt index 19ccb4d89..cd191b362 100644 --- a/livesupport/modules/core/var/root.txt +++ b/livesupport/modules/core/var/root.txt @@ -8,7 +8,8 @@ root:table messages:table { - aMessage:string { "parameter 0: {0}, parameter 1: {1}" } + aMessage:string { "parameter 0: {0}, parameter 1: {1}" } + aMessage3Args:string { "p0: {0}, p2: {2}, p1: {1}" } } } diff --git a/livesupport/modules/widgets/etc/Makefile.in b/livesupport/modules/widgets/etc/Makefile.in index 587744bc3..e05c88321 100644 --- a/livesupport/modules/widgets/etc/Makefile.in +++ b/livesupport/modules/widgets/etc/Makefile.in @@ -20,8 +20,8 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # -# Author : $Author: fgerlits $ -# Version : $Revision: 1.12 $ +# Author : $Author: maroy $ +# Version : $Revision: 1.13 $ # Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/etc/Makefile.in,v $ # # @configure_input@ @@ -119,7 +119,8 @@ WIDGETS_LIB_OBJS = ${TMP_DIR}/ImageButton.o \ ${TMP_DIR}/WidgetFactory.o \ ${TMP_DIR}/ZebraTreeView.o \ ${TMP_DIR}/ZebraCellRenderer.o \ - ${TMP_DIR}/Colors.o + ${TMP_DIR}/Colors.o \ + ${TMP_DIR}/MessageWindow.o TEST_EXE_OBJS = ${TMP_DIR}/TestWindow.o \ ${TMP_DIR}/main.o diff --git a/livesupport/modules/widgets/etc/doxygen.config b/livesupport/modules/widgets/etc/doxygen.config new file mode 100644 index 000000000..400657999 --- /dev/null +++ b/livesupport/modules/widgets/etc/doxygen.config @@ -0,0 +1,1144 @@ +#------------------------------------------------------------------------------- +# Copyright (c) 2004 Media Development Loan Fund +# +# This file is part of the LiveSupport project. +# http://livesupport.campware.org/ +# To report bugs, send an e-mail to bugs@campware.org +# +# LiveSupport is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LiveSupport is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LiveSupport; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# +# Author : $Author: maroy $ +# Version : $Revision: 1.1 $ +# Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/etc/doxygen.config,v $ +#------------------------------------------------------------------------------- + +# Doxyfile 1.3.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = LiveSupport + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 1.0 + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/doxygen + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. It is allowed to use relative paths in the argument list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = YES + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = YES + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = include src + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. + +INPUT_FILTER = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = include + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/livesupport/modules/widgets/include/LiveSupport/Widgets/WhiteWindow.h b/livesupport/modules/widgets/include/LiveSupport/Widgets/WhiteWindow.h index 0acbcaa13..84a8a6198 100644 --- a/livesupport/modules/widgets/include/LiveSupport/Widgets/WhiteWindow.h +++ b/livesupport/modules/widgets/include/LiveSupport/Widgets/WhiteWindow.h @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.10 $ + Author : $Author: maroy $ + Version : $Revision: 1.11 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/include/LiveSupport/Widgets/WhiteWindow.h,v $ ------------------------------------------------------------------------------*/ @@ -69,10 +69,33 @@ using namespace LiveSupport::Core; /* =============================================================== data types */ /** - * A container holding exactly one child, habing a light blue border to it. + * A container holding exactly one child, having a light blue border to it. * - * @author $Author: fgerlits $ - * @version $Revision: 1.10 $ + * To create a white window, subclass your window class from WhiteWindow, + * and supply appropriate parameters to the WhiteWindow constructor, + * upon construction. + * + * For example: + * 
+ *  class MyWindow : public WhiteWindow
+ *  {
+ *      MyWindow(void);
+ *      ...
+ *  };
+ *
+ *  MyWindow::MyWindow(void)
+ *       : WhiteWindow("window title",
+ *                     Colors::White,
+ *                     WidgetFactory::getInstance()->getWhiteWindowCorners())
+ *  {
+ *      ...
+ *  }
+ *
+ * + * @author $Author: maroy $ + * @version $Revision: 1.11 $ + * @see WidgetFactory + * @see WidgetFactory#getWhiteWindowCorners */ class WhiteWindow : public Gtk::Window { diff --git a/livesupport/modules/widgets/include/LiveSupport/Widgets/WidgetFactory.h b/livesupport/modules/widgets/include/LiveSupport/Widgets/WidgetFactory.h index 6a8529432..e04cc646f 100644 --- a/livesupport/modules/widgets/include/LiveSupport/Widgets/WidgetFactory.h +++ b/livesupport/modules/widgets/include/LiveSupport/Widgets/WidgetFactory.h @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.13 $ + Author : $Author: maroy $ + Version : $Revision: 1.14 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/include/LiveSupport/Widgets/WidgetFactory.h,v $ ------------------------------------------------------------------------------*/ @@ -68,6 +68,8 @@ using namespace LiveSupport::Core; /* =============================================================== data types */ +class WhiteWindow; + /** * A factory to provide access to LiveSupport Widgets. * @@ -86,8 +88,8 @@ using namespace LiveSupport::Core; * * * - * @author $Author: fgerlits $ - * @version $Revision: 1.13 $ + * @author $Author: maroy $ + * @version $Revision: 1.14 $ */ class WidgetFactory : virtual public Configurable @@ -334,6 +336,17 @@ class WidgetFactory : ZebraTreeView * createTreeView(Glib::RefPtr treeModel) throw (); + + /** + * Create a window with a single line of text, and an OK button. + * Good for displaying error messages. + * It is the reponsibility of the caller to dispose of the created + * object properly. + * + * @param message the message to include in the window. + */ + WhiteWindow * + createMessageWindow(Ptr::Ref message) throw (); }; diff --git a/livesupport/modules/widgets/src/MessageWindow.cxx b/livesupport/modules/widgets/src/MessageWindow.cxx new file mode 100644 index 000000000..d9ee09063 --- /dev/null +++ b/livesupport/modules/widgets/src/MessageWindow.cxx @@ -0,0 +1,99 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + LiveSupport is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/MessageWindow.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "LiveSupport/Widgets/WidgetFactory.h" +#include "LiveSupport/Widgets/Colors.h" +#include "MessageWindow.h" + + +using namespace LiveSupport::Widgets; + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Constructor. + *----------------------------------------------------------------------------*/ +MessageWindow :: MessageWindow (Ptr::Ref message) + throw () + : WhiteWindow(*message, + Colors::White, + WidgetFactory::getInstance()->getWhiteWindowCorners()) +{ + Ptr::Ref widgetFactory = WidgetFactory::getInstance(); + + messageLabel = Gtk::manage(new Gtk::Label(*message)); + + // init the okButton + // TODO: localize the OK text on the button + okButton = Gtk::manage(widgetFactory->createButton("OK")); + okButton->signal_clicked().connect(sigc::mem_fun(*this, + &MessageWindow::onOkButtonClicked)); + + layout = Gtk::manage(new Gtk::VBox()); + + layout->pack_start(*messageLabel, true, true); + layout->pack_start(*okButton); + + add(*layout); + show_all(); +} + + +/*------------------------------------------------------------------------------ + * Destructor. + *----------------------------------------------------------------------------*/ +MessageWindow :: ~MessageWindow (void) throw () +{ +} + + +/*------------------------------------------------------------------------------ + * Event handler for the OK button clicked + *----------------------------------------------------------------------------*/ +void +MessageWindow :: onOkButtonClicked(void) throw () +{ + hide(); +} + diff --git a/livesupport/modules/widgets/src/MessageWindow.h b/livesupport/modules/widgets/src/MessageWindow.h new file mode 100644 index 000000000..47cb462e3 --- /dev/null +++ b/livesupport/modules/widgets/src/MessageWindow.h @@ -0,0 +1,121 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + LiveSupport is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/MessageWindow.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef MessageWindow_h +#define MessageWindow_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include +#include + +#include "LiveSupport/Core/Ptr.h" + +#include "LiveSupport/Widgets/WhiteWindow.h" + +namespace LiveSupport { +namespace Widgets { + +using namespace LiveSupport::Core; + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * A message window, displaying a single line of message, with an OK + * button. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class MessageWindow : public WhiteWindow +{ + protected: + /** + * The vertical box holding the message and the button. + */ + Gtk::Box * layout; + + /** + * The message. + */ + Gtk::Label * messageLabel; + + /** + * The OK button. + */ + Button * okButton; + + /** + * The event handler for the OK button clicked. + */ + virtual void + onOkButtonClicked(void) throw (); + + + public: + /** + * Constructor. + * + * @param message the message to display in the window + */ + MessageWindow(Ptr::Ref message) throw (); + + /** + * Virtual destructor. + */ + virtual + ~MessageWindow(void) throw (); + +}; + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace Widgets +} // namespace LiveSupport + +#endif // MessageWindow_h + diff --git a/livesupport/modules/widgets/src/TestWindow.cxx b/livesupport/modules/widgets/src/TestWindow.cxx index 96aa2eed0..a575aecfe 100644 --- a/livesupport/modules/widgets/src/TestWindow.cxx +++ b/livesupport/modules/widgets/src/TestWindow.cxx @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.15 $ + Author : $Author: maroy $ + Version : $Revision: 1.16 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/TestWindow.cxx,v $ ------------------------------------------------------------------------------*/ @@ -33,7 +33,7 @@ #include "configure.h" #endif -#include +#include #include "LiveSupport/Widgets/WidgetFactory.h" #include "LiveSupport/Widgets/Colors.h" @@ -78,6 +78,8 @@ TestWindow :: TestWindow (void) // create a button button = Gtk::manage(widgetFactory->createButton("Hello, World!")); + button->signal_clicked().connect(sigc::mem_fun(*this, + &TestWindow::onButtonClicked)); // create a combo box comboBoxText = Gtk::manage(widgetFactory->createComboBoxText()); @@ -119,6 +121,21 @@ TestWindow :: ~TestWindow (void) throw () } +/*------------------------------------------------------------------------------ + * Event handler for the button being clicked. + *----------------------------------------------------------------------------*/ +void +TestWindow :: onButtonClicked(void) throw () +{ + Ptr::Ref wf = WidgetFactory::getInstance(); + Ptr::Ref message(new Glib::ustring("Hello, World!")); + + WhiteWindow * helloWindow = wf->createMessageWindow(message); + Gtk::Main::run(*helloWindow); + delete helloWindow; +} + + /*------------------------------------------------------------------------------ * Change the image from "play" to "stop" on the button when pressed. *----------------------------------------------------------------------------*/ diff --git a/livesupport/modules/widgets/src/TestWindow.h b/livesupport/modules/widgets/src/TestWindow.h index f7c34356b..8dc59bcd7 100644 --- a/livesupport/modules/widgets/src/TestWindow.h +++ b/livesupport/modules/widgets/src/TestWindow.h @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.9 $ + Author : $Author: maroy $ + Version : $Revision: 1.10 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/TestWindow.h,v $ ------------------------------------------------------------------------------*/ @@ -71,8 +71,8 @@ using namespace LiveSupport::Core; /** * A window, enabling interactive testing of UI components. * - * @author $Author: fgerlits $ - * @version $Revision: 1.9 $ + * @author $Author: maroy $ + * @version $Revision: 1.10 $ */ class TestWindow : public WhiteWindow { @@ -140,6 +140,12 @@ class TestWindow : public WhiteWindow */ BlueBin * blueBin; + /** + * Event handler for the button being clicked. + */ + virtual void + onButtonClicked(void) throw (); + public: /** diff --git a/livesupport/modules/widgets/src/WhiteWindow.cxx b/livesupport/modules/widgets/src/WhiteWindow.cxx index 361ab05af..5ee0dc93a 100644 --- a/livesupport/modules/widgets/src/WhiteWindow.cxx +++ b/livesupport/modules/widgets/src/WhiteWindow.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.12 $ + Version : $Revision: 1.13 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/WhiteWindow.cxx,v $ ------------------------------------------------------------------------------*/ @@ -352,7 +352,7 @@ WhiteWindow :: set_title(const Glib::ustring & title) throw () Glib::ustring WhiteWindow :: get_title(void) const throw () { - titleLabel->get_label(); + return titleLabel->get_label(); } diff --git a/livesupport/modules/widgets/src/WidgetFactory.cxx b/livesupport/modules/widgets/src/WidgetFactory.cxx index b29a2f80b..f0519a3c9 100644 --- a/livesupport/modules/widgets/src/WidgetFactory.cxx +++ b/livesupport/modules/widgets/src/WidgetFactory.cxx @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.15 $ + Author : $Author: maroy $ + Version : $Revision: 1.16 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/widgets/src/WidgetFactory.cxx,v $ ------------------------------------------------------------------------------*/ @@ -36,8 +36,9 @@ #include #include "LiveSupport/Widgets/Colors.h" - #include "LiveSupport/Widgets/WidgetFactory.h" +#include "MessageWindow.h" + using namespace LiveSupport::Core; using namespace LiveSupport::Widgets; @@ -425,3 +426,14 @@ WidgetFactory :: createTreeView(Glib::RefPtr treeModel) return new ZebraTreeView(treeModel); } + +/*------------------------------------------------------------------------------ + * Create a message window. + *----------------------------------------------------------------------------*/ +WhiteWindow * +WidgetFactory :: createMessageWindow(Ptr::Ref message) + throw () +{ + return new MessageWindow(message); +} + diff --git a/livesupport/products/gLiveSupport/src/GLiveSupport.cxx b/livesupport/products/gLiveSupport/src/GLiveSupport.cxx index db26806a9..0e8b83408 100644 --- a/livesupport/products/gLiveSupport/src/GLiveSupport.cxx +++ b/livesupport/products/gLiveSupport/src/GLiveSupport.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.27 $ + Version : $Revision: 1.28 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/GLiveSupport.cxx,v $ ------------------------------------------------------------------------------*/ @@ -54,6 +54,7 @@ using namespace LiveSupport::Core; using namespace LiveSupport::Authentication; using namespace LiveSupport::Storage; using namespace LiveSupport::SchedulerClient; +using namespace LiveSupport::Widgets; using namespace LiveSupport::GLiveSupport; @@ -93,6 +94,15 @@ static const std::string nameAttrName = "name"; *----------------------------------------------------------------------------*/ static const std::string scratchpadContentsKey = "scratchpadContents"; +/*------------------------------------------------------------------------------ + * Static constant for the key of the scheduler not available key + *----------------------------------------------------------------------------*/ +static const std::string schedulerNotReachableKey = "schedulerNotReachableMsg"; + +/*------------------------------------------------------------------------------ + * Static constant for the key of the locale not available key + *----------------------------------------------------------------------------*/ +static const std::string localeNotAvailableKey = "localeNotAvailableMsg"; /* =============================================== local function prototypes */ @@ -221,6 +231,67 @@ GLiveSupport :: configSupportedLanguages(const xmlpp::Element & element) } +/*------------------------------------------------------------------------------ + * Check all configured resources + *----------------------------------------------------------------------------*/ +bool +LiveSupport :: GLiveSupport :: +GLiveSupport :: checkConfiguration(void) throw () +{ + // first, check if resources are available for all configured languages + LanguageMap::iterator it = supportedLanguages->begin(); + try { + LanguageMap::iterator end = supportedLanguages->end(); + while (it != end) { + changeLocale((*it).second); + ++it; + } + changeLocale(""); + } catch (std::invalid_argument &e) { + Ptr::Ref language(new Glib::ustring((*it).first)); + Ptr::Ref uLanguage = ustringToUnicodeString(language); + Ptr::Ref msg = formatMessage(localeNotAvailableKey, + (*it).first); + displayMessageWindow(msg); + + changeLocale(""); + return false; + } + + // TODO: check if the authentication server is available + + // TODO: check if the storage server is available + + // no need to check the widget factory + + // check the scheduler client + try { + scheduler->getVersion(); + } catch (XmlRpcException &e) { + displayMessageWindow(getResourceUstring(schedulerNotReachableKey)); + return false; + } + + // TODO: check the audio player? + + return true; +} + + +/*------------------------------------------------------------------------------ + * Display a message window. + *----------------------------------------------------------------------------*/ +void +LiveSupport :: GLiveSupport :: +GLiveSupport :: displayMessageWindow(Ptr::Ref message) + throw () +{ + WhiteWindow * window = widgetFactory->createMessageWindow(message); + Gtk::Main::run(*window); + delete window; +} + + /*------------------------------------------------------------------------------ * Show the main window. *----------------------------------------------------------------------------*/ @@ -243,7 +314,7 @@ GLiveSupport :: show(void) throw () void LiveSupport :: GLiveSupport :: GLiveSupport :: changeLanguage(Ptr::Ref locale) - throw () + throw (std::invalid_argument) { changeLocale(*locale); diff --git a/livesupport/products/gLiveSupport/src/GLiveSupport.h b/livesupport/products/gLiveSupport/src/GLiveSupport.h index f03e546dd..6962cd049 100644 --- a/livesupport/products/gLiveSupport/src/GLiveSupport.h +++ b/livesupport/products/gLiveSupport/src/GLiveSupport.h @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.24 $ + Author : $Author: maroy $ + Version : $Revision: 1.25 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/GLiveSupport.h,v $ ------------------------------------------------------------------------------*/ @@ -99,8 +99,8 @@ class MasterPanelWindow; * schedulerClientFactory elements see their * respective documentation. * - * @author $Author: fgerlits $ - * @version $Revision: 1.24 $ + * @author $Author: maroy $ + * @version $Revision: 1.25 $ * @see LocalizedObject#getBundle(const xmlpp::Element &) * @see AuthenticationClientFactory * @see StorageClientFactory @@ -265,6 +265,25 @@ class GLiveSupport : public LocalizedConfigurable, throw (std::invalid_argument, std::logic_error); + /** + * A function to check the configuration of this object. + * Checks all resources configured by configure() + * + * @retun true if all resources are accessible and working, + * false otherwise + */ + bool + checkConfiguration(void) throw (); + + /** + * Display a message window. + * This function only returns after the message window is closed. + * + * @param message the message to display + */ + void + displayMessageWindow(Ptr::Ref message) throw (); + /** * Show the main window, and run the application. * This call will only return after the main window has been closed. @@ -276,9 +295,12 @@ class GLiveSupport : public LocalizedConfigurable, * Change the language of the application. * * @param locale the new locale of the appliction. + * @exception std::invalid_argument if the specified locale is not + * available */ void - changeLanguage(Ptr::Ref locale) throw (); + changeLanguage(Ptr::Ref locale) + throw (std::invalid_argument); /** * Perform authentication for the user of the application. diff --git a/livesupport/products/gLiveSupport/src/MasterPanelUserInfoWidget.cxx b/livesupport/products/gLiveSupport/src/MasterPanelUserInfoWidget.cxx index 73173c1b1..198e5b7cf 100644 --- a/livesupport/products/gLiveSupport/src/MasterPanelUserInfoWidget.cxx +++ b/livesupport/products/gLiveSupport/src/MasterPanelUserInfoWidget.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.7 $ + Version : $Revision: 1.8 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/MasterPanelUserInfoWidget.cxx,v $ ------------------------------------------------------------------------------*/ @@ -227,10 +227,7 @@ MasterPanelUserInfoWidget :: updateStrings(void) loginButtonLabel = getResourceUstring("loginButtonLabel"); loggedInMsg = getResourceUstring("notLoggedInMsg"); } else { - Ptr::Ref uLogin = ustringToUnicodeString(login); - Formattable arguments[] = { *uLogin }; - loggedInMsg = formatMessageUstring("loggedInMsg", arguments, 1); - + loggedInMsg = formatMessage("loggedInMsg", *login); loginButtonLabel = getResourceUstring("logoutButtonLabel"); } diff --git a/livesupport/products/gLiveSupport/src/SimplePlaylistManagementWindow.cxx b/livesupport/products/gLiveSupport/src/SimplePlaylistManagementWindow.cxx index d86fc31ff..186678ccc 100644 --- a/livesupport/products/gLiveSupport/src/SimplePlaylistManagementWindow.cxx +++ b/livesupport/products/gLiveSupport/src/SimplePlaylistManagementWindow.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.7 $ + Version : $Revision: 1.8 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/SimplePlaylistManagementWindow.cxx,v $ ------------------------------------------------------------------------------*/ @@ -155,13 +155,9 @@ SimplePlaylistManagementWindow :: onSaveButtonClicked (void) throw () playlist = gLiveSupport->savePlaylist(); - Ptr::Ref uTitle = ustringToUnicodeString( - playlist->getTitle()); - Formattable arguments[] = { *uTitle }; - Ptr::Ref statusText = formatMessageUstring( + Ptr::Ref statusText = formatMessage( "playlistSavedMessage", - arguments, - 1); + *playlist->getTitle()); statusBar->set_text(*statusText); gLiveSupport->releaseEditedPlaylist(); diff --git a/livesupport/products/gLiveSupport/src/UploadFileWindow.cxx b/livesupport/products/gLiveSupport/src/UploadFileWindow.cxx index 07e48e349..1231f320f 100644 --- a/livesupport/products/gLiveSupport/src/UploadFileWindow.cxx +++ b/livesupport/products/gLiveSupport/src/UploadFileWindow.cxx @@ -21,8 +21,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Author : $Author: fgerlits $ - Version : $Revision: 1.6 $ + Author : $Author: maroy $ + Version : $Revision: 1.7 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/UploadFileWindow.cxx,v $ ------------------------------------------------------------------------------*/ @@ -293,13 +293,9 @@ UploadFileWindow :: onUploadButtonClicked(void) throw () gLiveSupport->uploadFile(audioClip); // display success in the status bar - Ptr::Ref uTitle = ustringToUnicodeString( - audioClip->getTitle()); - Formattable arguments[] = { *uTitle }; - Ptr::Ref statusText = formatMessageUstring( + Ptr::Ref statusText = formatMessage( "clipUploadedMessage", - arguments, - 1); + *audioClip->getTitle()); statusBar->set_text(*statusText); // clean the entry fields diff --git a/livesupport/products/gLiveSupport/src/main.cxx b/livesupport/products/gLiveSupport/src/main.cxx index fedbf7747..13bbdf925 100644 --- a/livesupport/products/gLiveSupport/src/main.cxx +++ b/livesupport/products/gLiveSupport/src/main.cxx @@ -22,7 +22,7 @@ Author : $Author: maroy $ - Version : $Revision: 1.6 $ + Version : $Revision: 1.7 $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/products/gLiveSupport/src/main.cxx,v $ ------------------------------------------------------------------------------*/ @@ -167,6 +167,15 @@ int main ( int argc, std::cerr << "error parsing configuration file" << std::endl << e.what() << std::endl; return 1; + } catch (std::logic_error &e) { + std::cerr << "error configuring..." << std::endl + << e.what() << std::endl; + return 1; + } + + if (!gLiveSupport->checkConfiguration()) { + std::cerr << "some problem with the configuration" << std::endl; + return 1; } gLiveSupport->show(); diff --git a/livesupport/products/gLiveSupport/var/hu.txt b/livesupport/products/gLiveSupport/var/hu.txt index 27c727f6a..11e638b90 100644 --- a/livesupport/products/gLiveSupport/var/hu.txt +++ b/livesupport/products/gLiveSupport/var/hu.txt @@ -10,6 +10,9 @@ hu:table simplePlaylistMgmtButtonLabel:string { "egyszerű playlist kezelés" } schedulerButtonLabel:string { "időzítő" } + localeNotAvailableMsg:string { "A {0} nyelv nem elérhető" } + schedulerNotReachableMsg:string { "Az időzitő szerver nem elérhető" } + loginWindow:table { windowTitle:string { "Belépés" } diff --git a/livesupport/products/gLiveSupport/var/root.txt b/livesupport/products/gLiveSupport/var/root.txt index a13adef12..349af7256 100644 --- a/livesupport/products/gLiveSupport/var/root.txt +++ b/livesupport/products/gLiveSupport/var/root.txt @@ -10,6 +10,9 @@ root:table simplePlaylistMgmtButtonLabel:string { "simple playlist management" } schedulerButtonLabel:string { "scheduler" } + localeNotAvailableMsg:string { "Locale {0} not available" } + schedulerNotReachableMsg:string { "Scheduler server not available" } + loginWindow:table { windowTitle:string { "LOGIN" }