Loading...

Homework Assignment #2

Open Posted By: ahmad8858 Date: 09/09/2020 High School Proofreading & Editing

Need help in modiying and implementing the C++ code according to the attached problem description.

Category: Mathematics & Physics Subjects: Algebra Deadline: 24 Hours Budget: $80 - $120 Pages: 2-3 Pages (Short Assignment)

Attachment 1

Doxyfile

# Doxyfile 1.8.3.1 # 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 #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or sequence of words) that should # identify the project. Note that if you do not use Doxywizard you need # to put quotes around the project name if it contains spaces. PROJECT_NAME = catalogs # 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 = structs, modular # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer # a quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify an logo or icon that is # included in the documentation. The maximum height of the logo should not # exceed 55 pixels and the maximum width should not exceed 200 pixels. # Doxygen will copy the logo to the output directory. PROJECT_LOGO = # 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 = docs # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # 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: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # 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 = YES # 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. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. Note that you specify absolute paths here, but also # relative paths, which will be relative from the directory where doxygen is # started. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful if your file system # 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 regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # 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 = NO # 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 the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = 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 = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding # "class=itcl::class" will allow you to use the command class in the # itcl::class meaning. TCL_SUBST = # 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 OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, # and language is one of the parsers supported by doxygen: IDL, Java, # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, # C++. For instance to make doxygen treat .inc files as Fortran files (default # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note # that for custom extensions you also need to set FILE_PATTERNS otherwise the # files are not read by doxygen. EXTENSION_MAPPING = # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all # comments according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you # can mix doxygen, HTML, and XML commands with Markdown formatting. # Disable only in case of backward compatibilities issues. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented classes, # or namespaces to their corresponding documentation. Such a link can be # prevented in individual cases by by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES (the # default) will make doxygen replace the get and set methods by a property in # the documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = 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 # 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 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and # unions are shown inside the group in which they are included (e.g. using # @ingroup) instead of on a separate page (for HTML and Man pages) or # section (for LaTeX and RTF). INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and # unions with only public data fields will be shown inline in the documentation # of the scope in which they are defined (i.e. file, namespace, or group # documentation), provided this scope is documented. If set to NO (the default), # structs, classes, and unions are shown on a separate page (for HTML and Man # pages) or section (for LaTeX and RTF). INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # their name and scope. Since this can be an expensive process and often the # same symbol appear multiple times in the code, doxygen keeps a cache of # pre-resolved symbols. If the cache is too small doxygen will become slower. # If the cache is too large, memory is wasted. The cache size is given by this # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # 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 = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. EXTRACT_PACKAGE = 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 # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespaces are hidden. EXTRACT_ANON_NSPACES = NO # 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 # and Mac 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 FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen # will list include files with double quotes in the documentation # rather than with sharp brackets. FORCE_LOCAL_INCLUDES = NO # 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_MEMBERS_CTORS_1ST tag is set to YES then doxygen # will sort the (brief and detailed) documentation of class members so that # constructors and destructors are listed first. If set to NO (the default) # the constructors will appear in the respective orders defined by # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = 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 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to # do proper type resolution of all parameters of a function it will reject a # match between the prototype and the implementation of a member function even # if there is only one candidate or it is obvious which candidate to choose # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen # will still accept a match between prototype and implementation in such cases. STRICT_PROTO_MATCHING = 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 section-label ... \endif # and \cond section-label ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or macro 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 macros 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 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command <command> <input-file>, where <command> is the value of # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. # You can optionally specify a file name after the option, if omitted # DoxygenLayout.xml will be used as the name of the layout file. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files # containing the references data. This must be a list of .bib files. The # .bib extension is automatically appended if omitted. Using this command # requires the bibtex tool to be installed. See also # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this # feature you need bibtex and perl available in the search path. Do not use # file names with spaces, bibtex cannot handle them. CITE_BIB_FILES = #--------------------------------------------------------------------------- # 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_NO_PARAMDOC option can be enabled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = NO # 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. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) 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 = # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py # *.f90 *.f *.for *.vhd *.vhdl 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 = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # 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. # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system 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. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # 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 <filter> <input-file>, where <filter> # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty or if # non of the patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # 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 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) # and it is also possible to disable source filtering for a specific pattern # using *.ext= (so without naming a filter). This option only has effect when # FILTER_SOURCE_FILES is enabled. FILTER_SOURCE_PATTERNS = # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page (index.html). # This can be useful if you have a project on for instance GitHub and want reuse # the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # 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 = NO # 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, C++ and Fortran comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # 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. Note that when using a custom header you are responsible # for the proper inclusion of any scripts and style sheets that doxygen # needs, which is dependent on the configuration options used. # It is advised to generate a default header using "doxygen -w html # header.html footer.html stylesheet.css YourConfigFile" and then modify # that header. Note that the header is subject to change so you typically # have to redo this when upgrading to a newer version of doxygen or when # changing the value of configuration settings such as GENERATE_TREEVIEW! 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 left blank doxygen will # generate a default style sheet. Note that it is recommended to use # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this # tag will in the future become obsolete. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional # user-defined cascading style sheet that is included after the standard # style sheets created by doxygen. Using this option one can overrule # certain style aspects. This is preferred over using HTML_STYLESHEET # since it does not replace the standard style sheet and is therefor more # robust against future updates. Doxygen will copy the style sheet file to # the output directory. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that # the files will be copied as-is; there are no commands or markers available. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # Doxygen will adjust the colors in the style sheet and background images # according to this color. Hue is specified as an angle on a colorwheel, # see http://en.wikipedia.org/wiki/Hue for more information. # For instance the value 0 represents red, 60 is yellow, 120 is green, # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. # The allowed range is 0 to 359. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # the colors in the HTML output. For a value of 0 the output will use # grayscales only. A value of 255 will produce the most vivid colors. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # the luminance component of the colors in the HTML output. Values below # 100 gradually make the output lighter, whereas values above 100 make # the output darker. The value divided by 100 is the actual gamma applied, # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, # and 100 does not change the gamma. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting # this to NO can help when comparing the output of multiple runs. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of # entries shown in the various tree structured indices initially; the user # can expand and collapse entries dynamically later on. Doxygen will expand # the tree to such a level that at most the specified number of entries are # visible (unless a fully collapsed tree already exceeds this amount). # So setting the number of entries 1 will produce a full collapsed tree by # default. 0 is a special value representing an infinite number of entries # and will result in a full expanded tree by default. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely # identify the documentation publisher. This should be a reverse domain-name # style string, e.g. com.mycompany.MyDocSet.documentation. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. DOCSET_PUBLISHER_NAME = Publisher # 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 compiled 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 CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # 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 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated # that can be used as input for Qt's qhelpgenerator to generate a # Qt Compressed Help (.qch) of the generated HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to # add. For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> # Qt Help Project / Custom Filters</a>. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's # filter section matches. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> # Qt Help Project / Filter Attributes</a>. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files # will be generated, which together with the HTML files, form an Eclipse help # plugin. To install this plugin and make it available under the help contents # menu in Eclipse, the contents of the directory containing the HTML and XML # files needs to be copied into the plugins directory of eclipse. The name of # the directory within the plugins directory should be the same as # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before # the help appears. GENERATE_ECLIPSEHELP = NO # A unique identifier for the eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have # this name. ECLIPSE_DOC_ID = org.doxygen.Project # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) # at top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. Since the tabs have the same information as the # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value 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 (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. # Since the tree basically has the same information as the tab index you # could consider to set DISABLE_INDEX to NO when enabling this option. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # (range [0,1..20]) that doxygen will group on one line in the generated HTML # documentation. Note that a value of 0 will completely suppress the enum # values from appearing in the overview section. ENUM_VALUES_PER_LINE = 4 # 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 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open # links to external symbols imported via tag files in a separate window. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are # not supported properly for IE 6.0, but are supported on all modern browsers. # Note that when changing this option you need to delete any form_*.png files # in the HTML output before the changes have effect. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax # (see http://www.mathjax.org) which uses client side Javascript for the # rendering instead of using prerendered bitmaps. Use this if you do not # have LaTeX installed or if you want to formulas look prettier in the HTML # output. When enabled you may also need to install MathJax separately and # configure the path to it using the MATHJAX_RELPATH option. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and # SVG. The default value is HTML-CSS, which is slower, but has the best # compatibility. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the # HTML output directory using the MATHJAX_RELPATH option. The destination # directory should contain the MathJax.js script. For instance, if the mathjax # directory is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to # the MathJax Content Delivery Network so you can quickly see the result without # installing MathJax. # However, it is strongly recommended to install a local # copy of MathJax from http://www.mathjax.org before deployment. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension # names that should be enabled during MathJax rendering. MATHJAX_EXTENSIONS = # When the SEARCHENGINE tag is enabled doxygen will generate a search box # for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets # (GENERATE_DOCSET) there is already a search function so this one should # typically be disabled. For large projects the javascript based search engine # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. # There are two flavours of web server based search depending on the # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for # searching and an index file used by the script. When EXTERNAL_SEARCH is # enabled the indexing and searching needs to be provided by external tools. # See the manual for details. SERVER_BASED_SEARCH = NO # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain # the search results. Doxygen ships with an example indexer (doxyindexer) and # search engine (doxysearch.cgi) which are based on the open source search engine # library Xapian. See the manual for configuration details. EXTERNAL_SEARCH = NO # The SEARCHENGINE_URL should point to a search engine hosted by a web server # which will returned the search results when EXTERNAL_SEARCH is enabled. # Doxygen ships with an example search engine (doxysearch) which is based on # the open source search engine library Xapian. See the manual for configuration # details. SEARCHENGINE_URL = # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the # SEARCHDATA_FILE tag the name of this file can be specified. SEARCHDATA_FILE = searchdata.xml # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple # projects and redirect the results back to the right project. EXTERNAL_SEARCH_ID = # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id # of to a relative location where the documentation can be found. # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # 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. # Note that when enabling USE_PDFLATEX this option is only used for # generating bitmaps for formulas in the HTML output, but not in the # Makefile that is written to the output directory. 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, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4 # 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 = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for # the generated latex document. The footer should contain everything after # the last chapter. If it is left blank doxygen will generate a # standard footer. Notice: only use this tag if you know what you are doing! LATEX_FOOTER = # 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 = YES # 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 = YES # 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 # If LATEX_SOURCE_CODE is set to YES then doxygen will include # source code with syntax highlighting in the LaTeX output. # Note that which sources are shown also depends on other settings # such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See # http://en.wikipedia.org/wiki/BibTeX for more info. LATEX_BIB_STYLE = plain #--------------------------------------------------------------------------- # 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 style sheet 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 = NO # 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_DEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # pointed to by INCLUDE_PATH will be searched when 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 = # 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. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. 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 that # overrules the definition found in the source code. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all references to function-like macros # that are alone on a line, have an all uppercase name, and do not end with a # semicolon, because these 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. For each # tag file the location of the external documentation should be added. 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. 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 also works with HAVE_DOT disabled, but it is recommended to # install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # 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 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # allowed to run in parallel. When set to 0 (the default) doxygen will # base this on the number of processors available in the system. You can set it # explicitly to a value larger than 0 to get control over the balance # between CPU load and processing speed. DOT_NUM_THREADS = 0 # By default doxygen will use the Helvetica font for all dot files that # doxygen generates. When you want a differently looking font you can specify # the font name using DOT_FONTNAME. You need to make sure dot is able to find # the font, which can be done by putting it in a standard location or by setting # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the # directory containing the font. DOT_FONTNAME = Helvetica # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the Helvetica font. # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to # set the path where dot can find it. DOT_FONTPATH = # 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 # 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 GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = 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 the UML_LOOK tag is enabled, the fields and methods are shown inside # the class node. If there are many fields or methods and many nodes the # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS # threshold limits the number of items for each type to make the size more # managable. Set this to 0 for no limit. Note that the threshold may be # exceeded by 50% before the limit is enforced. UML_LIMIT_NUM_FIELDS = 10 # 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 options 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 CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller 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 caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will generate a graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are svg, png, jpg, or gif. # If left blank png will be used. If you choose svg you need to set # HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. # Note that this requires a modern browser other than Internet Explorer. # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible. Older versions of IE do not have SVG support. INTERACTIVE_SVG = NO # 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 in 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 MSCFILE_DIRS tag can be used to specify one or more directories that # contain msc files that are included in the documentation (see the # \mscfile command). MSCFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # 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 the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # 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

bin/Linux/permittedResearch

bin/Windows/permittedResearch.exe

check.sh

#!/bin/sh gdb -ex 'ptype ResearchPlan' -batch $1 > sanityCheck.txt OK=1 if ! grep -q 'vector<Topic.*requirements' sanityCheck.txt; then OK=0 fi if grep -q 'int numberOfRequirements' sanityCheck.txt; then OK=0 fi if grep -q 'int maxRequirements' sanityCheck.txt; then OK=0 fi intCount=`grep int sanityCheck.txt | wc -l` if test $intCount -ne 1 ; then OK=0 fi if test $OK -eq 0 ; then echo ReseachPlan data members were not modified according to the assignment instructions. rm $1 $2 exit 1 fi

encyclopedia.cpp

#include <algorithm> #include <iterator> #include <sstream> #include <vector> #include "encyclopedia.h" #include "nosuchplan.h" using namespace std; Encyclopedia::Encyclopedia() { } // Remove leading spaces from a string string Encyclopedia::trim (string str) { string::size_type k = 0; while (str[k] == ' ') ++k; return str.substr(k); } // Split a string into fields separated by // a delimiter character. vector<string> Encyclopedia::split (const string& str, char delimiter) { vector<string> results; string::size_type start = 0; while (start != string::npos) { string::size_type splitPos = str.find(delimiter, start); if (splitPos == string::npos) { results.push_back(str.substr(start)); start = splitPos; } else { results.push_back(str.substr(start, splitPos-start)); start = splitPos + 1; } } return results; } void Encyclopedia::read (istream& input) { string line; getline (input, line); while (input && (line != "---")) { vector<string> parts = split(line, ':'); if (parts.size() != 2) continue; string nameToResearch = trim(parts[0]); parts = split(parts[1], ','); string costStr = parts[parts.size()-1]; int cost = stoi(costStr); for (unsigned i = 0; i < parts.size()-1; ++i) { string requiredTopicName = trim(parts[i]); ResearchPlan& priorPlan = findOrAdd(requiredTopicName); Topic priorTopic = priorPlan.getTopic(); ResearchPlan& plan = findOrAdd(nameToResearch); plan.addRequirement(priorTopic); } ResearchPlan& plan = findOrAdd(nameToResearch); plan.getTopic().researchCost = cost; getline (input, line); } } void Encyclopedia::addPlanRequirement ( const Topic& topic1, const Topic& requiredTopic) { findOrAdd(requiredTopic.name); ResearchPlan& plan1 = findOrAdd(topic1.name); plan1.addRequirement(requiredTopic); } void Encyclopedia::removeTopic (const Topic& topic) { for (ResearchPlan& plan: plans) { plan.removeRequirement (topic); } auto pos = find_if(plans.begin(), plans.end(), [&] (ResearchPlan& plan){return plan.getTopic() == topic;}); if (pos != plans.end()) { plans.erase(pos); } } ResearchPlan& Encyclopedia::getPlan (const Topic& topic) { for (ResearchPlan& plan: plans) { if (plan.getTopic() == topic) return plan; } throw NoSuchPlan(topic.name); } const ResearchPlan& Encyclopedia::getPlan (const Topic& topic) const { for (const ResearchPlan& plan: plans) { if (plan.getTopic() == topic) return plan; } throw NoSuchPlan(topic.name); } bool Encyclopedia::containsTopic (const Topic& topic) const { for (const ResearchPlan& plan: plans) { if (plan.getTopic() == topic) return true; } return false; } ResearchPlan& Encyclopedia::findOrAdd (const std::string& topicName) { for (ResearchPlan& plan: plans) { if (plan.getTopic().name == topicName) return plan; } ResearchPlan newPlan (Topic(topicName, 0)); plans.push_back(newPlan); return plans.back(); } bool Encyclopedia::operator== (const Encyclopedia& right) const { auto rightItr = right.plans.begin(); for (const ResearchPlan& plan1: plans) { if (rightItr == right.plans.end()) return false; if (!(plan1 == *rightItr)) return false; ++rightItr; } return (rightItr == right.plans.end()); } std::ostream& operator<< (std::ostream& out, const Encyclopedia& encyc) { for (const Topic& t: encyc) { out << encyc.getPlan(t) << endl; } return out; } // Move position forward 1 place Encyclopedia::iterator& Encyclopedia::iterator::operator++() { ++pos; return *this; } Encyclopedia::iterator Encyclopedia::iterator::operator++(int) { iterator saved = *this; pos++; return saved; } Encyclopedia::const_iterator& Encyclopedia::const_iterator::operator++() { ++pos; return *this; } Encyclopedia::const_iterator Encyclopedia::const_iterator::operator++(int) { const_iterator saved = *this; pos++; return saved; }

encyclopedia.h

#ifndef ENCYCLOPEDIA_H #define ENCYCLOPEDIA_H #include <iostream> #include <vector> #include "researchplan.h" /** * The master list of all research topics, organized * by their research plans. */ class Encyclopedia { public: class iterator { public: typedef std::random_access_iterator_tag iterator_category; typedef Topic value_type; typedef ptrdiff_t difference_type; typedef value_type* pointer; typedef value_type& reference; iterator() {} // Get the data element at this position reference operator*() const {return pos->getTopic();} pointer operator->() const {return &(pos->getTopic());} // Move position forward 1 place iterator& operator++(); iterator operator++(int); // Random access iterator operator+ (int offset) const {return iterator(pos+offset);} int operator- (const iterator& right) const {return pos-right.pos;} // Comparison operators bool operator== (const iterator& right) const {return pos == right.pos;} bool operator!= (const iterator& right) const {return pos != right.pos;} private: std::vector<ResearchPlan>::iterator pos; iterator (std::vector<ResearchPlan>::iterator p) : pos(p) {} friend class Encyclopedia; }; class const_iterator { public: typedef std::random_access_iterator_tag iterator_category; typedef Topic value_type; typedef ptrdiff_t difference_type; typedef const value_type* pointer; typedef const value_type& reference; const_iterator() {} // Get the data element at this position reference operator*() const {return pos->getTopic();} pointer operator->() const {return &(pos->getTopic());} // Move position forward 1 place const_iterator& operator++(); const_iterator operator++(int); // Random access const_iterator operator+ (int offset) const {return const_iterator(pos+offset);} int operator- (const const_iterator& right) const {return pos-right.pos;} // Comparison operators bool operator== (const const_iterator& right) const {return pos == right.pos;} bool operator!= (const const_iterator& right) const {return pos != right.pos;} private: std::vector<ResearchPlan>::const_iterator pos; const_iterator (std::vector<ResearchPlan>::const_iterator p) : pos(p) {} friend class Encyclopedia; }; /** * Create a new encyclopedia. */ Encyclopedia(); /** * Provide access to the topics in the encyclopedia. */ iterator begin() {return iterator(plans.begin());} iterator end() {return iterator(plans.end());} const_iterator begin() const {return const_iterator(plans.begin());} const_iterator end() const {return const_iterator(plans.end());} /** * Adds a plan requirement to the encyclopedia. This is a pair of topics, * possibly never seen before, such that one topic must have been researched * before research can begin on the other. * * @param topic1 a topic, possibly never seen before * @param requiredPriorTopic another topic that must be researched * before topic1. */ void addPlanRequirement ( const Topic& topic1, const Topic& requiredPriorTopic); /** * Remove a topic from the encyclopedia, including any * plan requirements in which it participates. */ void removeTopic (const Topic& topic); /** * See if a topic is already in the catalog. * * @param topic a topic whose name is to be searched for * @return true iff topic is in the catalog */ bool containsTopic (const Topic& topic) const; /** * Fetch a plan by topic name. * @param topic a topic whose name is to be searched for * @return the plan for the topic that same name. * @throws NoSuchPlan if a plan for that topic does not exist. */ ResearchPlan& getPlan (const Topic& topic); const ResearchPlan& getPlan (const Topic& topic) const; /** * Read an encyclopedia from an input stream. * * Input is repeated lines of * * topic: prior topic 1, prior topic 2, ... , cost * * Topic names may be any mixture of alphanumeric characters and * blanks, but must have at least one non-blank character, must not begin * with a blank, and must not include the characters ',' or ':'. * * Leading blanks may appear before a topic name in the input, but are * ignored. * * The end of input is signaled by the end of the input stream or by a * line consisting solely of the string "---". (Three hyphens.) * * @param input the input stream */ void read (istream& input); bool operator== (const Encyclopedia& right) const; private: /** * All of the plans in this encyclopedia. */ std::vector<ResearchPlan> plans; /** * Check to see if a research plan already exists for this * topic. If not, create one. Return the created plan or * existing one that was found. */ ResearchPlan& findOrAdd (const std::string& topicName); /** * Remove leading spaces from a string. */ static std::string trim (std::string str); /** * Split a string into fields separated by a delimiter character. * * @param str: the string to be split * @param delimiter: the character separating the parts of the string * @returns a vector containing one or more parts of the string, with * the delimiter character removed. */ static std::vector<std::string> split ( const std::string& str, char delimiter); }; std::ostream& operator<< (std::ostream& out, const Encyclopedia& cat); #endif

make.dep

encyclopedia.o: encyclopedia.cpp encyclopedia.h researchplan.h topic.h \ memoryChecked.h nosuchplan.h topic.o: topic.cpp topic.h memoryChecked.h unittest.o: unittest.cpp unittest.h testEncyclopedia.o: testEncyclopedia.cpp unittest.h encyclopedia.h \ researchplan.h topic.h memoryChecked.h testResearchPlan.o: testResearchPlan.cpp researchplan.h topic.h \ memoryChecked.h unittest.h memoryChecked.o: memoryChecked.cpp memoryChecked.h permittedResearch.o: permittedResearch.cpp encyclopedia.h researchplan.h \ topic.h memoryChecked.h researchplan.o: researchplan.cpp researchplan.h topic.h memoryChecked.h

makefile

MAINPROG=permittedResearch DIR=${PWD} ASST=$(notdir ${DIR}) CC=gcc CXX=g++ ## # Adjust settings for different compilers # ifeq ($(OS),Windows_NT) # # Flags for Windows compilers CPPFLAGS=-g -std=c++17 -MMD -pthread -D_GLIBCXX_DEBUG -Wall LFLAGS= RM=del /q EXE=.exe else # # Flags for Linux & MacOS CPPFLAGS=-g -std=c++17 -MMD -pthread -D_GLIBCXX_DEBUG -Wall LFLAGSx=-fuse-ld=gold -pthread RM=/bin/rm -rf EXE= endif # ######################################################################## # Macro definitions for "standard" C and C++ compilations # CFLAGS=-g TARGET=$(MAINPROG)$(EXE) CPPS=$(wildcard *.cpp) MAINCPPS=$(filter-out unittest.cpp test%.cpp, $(CPPS)) TESTCPPS=$(filter-out $(MAINPROG).cpp, $(CPPS)) LINK=g++ $(CPPFLAGS) # # # In most cases, you should not change anything below this line. # # The following is "boilerplate" to set up the standard compilation # commands: # MAINOBJS=$(MAINCPPS:%.cpp=%.o) TESTOBJS=$(TESTCPPS:%.cpp=%.o) DEPENDENCIES = $(CPPS:%.cpp=%.d) %.d: %.cpp touch [email protected] %.o: %.cpp $(CXX) $(CPPFLAGS) -o [email protected] -c $*.cpp # # Targets: # all: $(TARGET) unittest$(EXE) $(TARGET): $(MAINOBJS) $(LINK) $(FLAGS) -o $(TARGET) $^ $(LFLAGS) clean: -/bin/rm -rf *.d *.o $(TARGET) unittest$(EXE) docs documentation: -mkdir docs doxygen Doxyfile check: all /bin/sh check.sh $(TARGET) unittest$(EXE) unittest$(EXE): $(TESTOBJS) $(LINK) $(FLAGS) -o [email protected] $^ $(LFLAGS) make.dep: $(DEPENDENCIES) -cat $(DEPENDENCIES) > [email protected] include make.dep

memoryChecked.cpp

memoryChecked.cpp

/*
 * counted.cpp
 *
 *  Created on: Apr 10, 2017
 *      Author: zeil
 */

#include   "memoryChecked.h"

#include   < iostream >

int   MemoryChecked :: numObjects  =   0 ;
bool   MemoryChecked :: memoryViolationDetected  =   false ;

MemoryChecked &   MemoryChecked :: operator =   ( const   MemoryChecked &  rhs )
{
     if   ( hasBeenDestroyed )
     {
        memoryViolationDetected  =   true ;
         throw   DanglingPointerException ( "*** Attempted to assign to an already destroyed object" );
     }
     if   ( rhs . hasBeenDestroyed )
     {
        memoryViolationDetected  =   true ;
         throw   DanglingPointerException   ( "*** Attempted to assign from an already destroyed object" );
     }
     return   * this ;
}

MemoryChecked :: MemoryChecked   ( const   MemoryChecked &  c )
:  hasBeenDestroyed ( false )
{
     ++ numObjects ;
     if   ( c . hasBeenDestroyed )
     {
        memoryViolationDetected  =   true ;
         throw   DanglingPointerException   ( "*** Attempted to copy an already destroyed object" );
     }
}


MemoryChecked ::~ MemoryChecked ()  noexcept ( false )
{
     if   ( hasBeenDestroyed )
     {
        memoryViolationDetected  =   true ;
         throw   DanglingPointerException   ( "*** Attempted to destroy an already destroyed object" );
     }
     else
     {
        hasBeenDestroyed  =   true ;
         -- numObjects ;
     }
}

void   MemoryChecked :: resetMemoryChecks ()
{
    numObjects  =   0 ;
    memoryViolationDetected  =   false ;
}

memoryChecked.h

/* * counted.h * * Created on: Apr 10, 2017 * Author: zeil */ #ifndef MEMORYCHECKED_H_ #define MEMORYCHECKED_H_ #include <exception> /** * Utility for detecting memory leaks and dangling pointers. * * * Detection can be added to a class by adding a data member of this type. * */ class MemoryChecked { /** * A count of the number of Counted objects currently in use. */ static int numObjects; // = 0; /** * Indicates if a dangling pointer problem has * been detected during this execution. */ static bool memoryViolationDetected; // = false; /** * Indicates whether this object has been destroyed. */ bool hasBeenDestroyed; public: /** * This exception will be thrown when an attempt to copy * an object that has already been destroyed, when an * attempt is made to assign to/from a destroyed object, or * when an attempt is made to destroy an already-destroyed * object. */ class DanglingPointerException: public std::exception { const char* explain; public: DanglingPointerException (const char* explanation) : explain(explanation) {} virtual const char* what() const throw() { return explain; } }; MemoryChecked () : hasBeenDestroyed(false) { ++numObjects; } MemoryChecked (const MemoryChecked& c); MemoryChecked& operator= (const MemoryChecked& rhs); virtual ~MemoryChecked() noexcept(false); /** * How many checked objects have been created but not yet * destroyed? */ static int getCurrentCount() {return numObjects;} /** * Have we detected any attempts to manipulate objects via * dangling pointers? */ static bool danglingPointersDetected() {return memoryViolationDetected;} /** * This is intended only for use when unit testing * the MemoryChecked class itself. */ static void resetMemoryChecks(); }; #endif /* MEMORYCHECKED_H_ */

nosuchplan.h

#ifndef NOSUCHPLAN_H_ #define NOSUCHPLAN_H_ #include <string> #include <exception> /** * Error signaled when trying to retrieve a plan for an unknown topic * from an Encyclopedia. */ struct NoSuchPlan : public exception { std::string topicName; NoSuchPlan (std::string topic): topicName(topic) {} const char * what () const throw () { static const std::string msg = "There is no plan for: "; return (msg + topicName).c_str(); } }; #endif /* NOSUCHPLAN_H_ */

permittedResearch.cpp

#include <algorithm> #include <iostream> #include <fstream> #include <limits> #include <iomanip> #include <string> #include <vector> #include "encyclopedia.h" #include "memoryChecked.h" #include "researchplan.h" using namespace std; void readPlayerInfo (istream& input, vector<string>& knownTopics) { string line; getline (input, line); while (input && (line != "---")) { knownTopics.push_back(line); getline (input, line); } } bool containsTopicName (const vector<string>& alreadyKnown, const string& topicName) { for (const string& known: alreadyKnown) { if (topicName == known) { return true; } } return false; } bool couldBeResearched (const ResearchPlan& plan, const vector<string>& alreadyKnown) { for (Topic required: plan) { if (!containsTopicName(alreadyKnown, required.name)) { return false ; // If any required prior topic is unknown. } } return true; // If every required prior topic is already known. } /** * Print a list of the research topics that could be researched * by a game player, given the encyclopedia of possible research plans * and the list of topics already known/researched. */ void permittedResearch(const Encyclopedia& encyc, const vector<string>& alreadyKnown) { vector<Topic> researchable; Topic lowestCostTopic ("nonsense", numeric_limits<int>::max()); for (const Topic& topic: encyc) { ResearchPlan plan = encyc.getPlan(topic); if ((!containsTopicName(alreadyKnown, plan.getTopic().name)) && couldBeResearched(plan, alreadyKnown)) { researchable.push_back(topic); if (topic.researchCost < lowestCostTopic.researchCost) { lowestCostTopic = topic; } } } cout << "There are " << researchable.size() << " topics available for research." << endl; sort (researchable.begin(), researchable.end()); for (const Topic& topic: researchable) { cout << setw(24) << topic.name << setw(0) << " " << topic.researchCost << endl; } cout << "The cheapest to research is " << lowestCostTopic << endl; } int main (int argc, char** argv) { { Encyclopedia encyclopedia; vector<string> alreadyResearched; if (argc > 1) { ifstream in (argv[1]); encyclopedia.read (in); readPlayerInfo (in, alreadyResearched); } else { encyclopedia.read (cin); readPlayerInfo (cin, alreadyResearched); } permittedResearch (encyclopedia, alreadyResearched); } if (MemoryChecked::getCurrentCount() > 0) { cout << "**Memory leaks detected: " << MemoryChecked::getCurrentCount() << endl; } return 0; }

sanityCheck.txt

type = class ResearchPlan { private: Topic researchTopic; std::__debug::vector<Topic, std::allocator<Topic> > requirements; public: ResearchPlan(void); ResearchPlan(const Topic &); ResearchPlan(const Topic &, std::initializer_list<Topic>); const Topic & getTopic(void) const; Topic & getTopic(void); int getNumberOfRequirements(void) const; void addRequirement(const Topic &); void removeRequirement(const Topic &); iterator begin(void); const_iterator begin(void) const; iterator end(void); const_iterator end(void) const; bool operator==(const ResearchPlan &) const; bool operator<(const ResearchPlan &) const; typedef std::__debug::vector<Topic, std::allocator<Topic> >::iterator iterator; typedef std::__debug::vector<Topic, std::allocator<Topic> >::const_iterator const_iterator; }

test0.in

Alphabet: 28 Bronze Working: 28 Ceremonial Burial: 28 Code of Laws: Alphabet, 79 Currency: Bronze Working, 79 Horseback Riding: 28 Iron Working: Bronze Working, Warrior Code, 136 Map Making: Alphabet, 79 Masonry: 28 Mathematics: Alphabet, Masonry, 136 Mysticism: Ceremonial Burial, 79 Polytheism: Horseback Riding, Ceremonial Burial, 136 Pottery: 28 The Wheel: Horseback Riding, 79 Warrior Code: 28 Writing: Alphabet, 79 --- Bronze Working Ceremonial Burial Horseback Riding Warrior Code ---

test031.dat

#include "researchplan.h" #include "unittest.h" #include <array> #include <list> #include <sstream> using namespace std; /** * A "test fixture" is a mechanism for providing common access to test * data that may be used in multiple tests. */ class Fixture { public: const Topic alphabet; const Topic mining; const Topic commerce; const Topic sailing; const Topic trade; const Topic wheel; std::array<Topic, 2> topics2; std::array<Topic, 3> topics3; std::array<Topic, 4> topics4; std::array<Topic, 5> topics5; Fixture(); }; Fixture::Fixture() : alphabet ("Alphabet", 15), mining ("Mining", 25), commerce ("Commerce", 30), sailing ("Sailing", 36), trade ("Trade", 45), wheel ("Wheel", 10), topics2{commerce, sailing}, topics3{alphabet, mining, commerce}, topics4{alphabet, mining, commerce, sailing}, topics5{alphabet, mining, commerce, sailing, trade} { } UnitTest(PlanDefaultConstructor) { ResearchPlan plan; assertThat (plan.getTopic(), isEqualTo(Topic())); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isEqualTo(ResearchPlan())); assertThat (plan, not(isLessThan(ResearchPlan()))); assertThat (plan, not(isGreaterThan(ResearchPlan()))); } UnitTest(PlanConstructor) { Fixture fix; ResearchPlan plan (fix.alphabet); assertThat (plan.getTopic(), isEqualTo(fix.alphabet)); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.mining))); assertThat (plan.begin(), isEqualTo(plan.end())); ostringstream out; out << plan; assertThat (out.str(), contains("Alphabet")); } UnitTest(PlanConsInitList0) { Fixture fix; ResearchPlan plan (fix.trade, {fix.alphabet, fix.commerce, fix.sailing}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(3)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.wheel))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Alphabet")); assertThat (out.str(), contains("Commerce")); assertThat (out.str(), contains("Sailing")); } UnitTest(PlanConsInitListSingle) { Fixture fix; ResearchPlan plan (fix.trade, {fix.sailing}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.wheel))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Sailing")); } UnitTest(PlanConsInitListEmpty) { Fixture fix; ResearchPlan plan (fix.trade, {}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, not(isLessThan(ResearchPlan(fix.commerce)))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("()")); } UnitTest(PlanConsIter0) { Fixture fix; ResearchPlan plan1 (fix.trade, fix.topics3.begin(), fix.topics3.end()); vector<Topic> v(fix.topics3.begin(), fix.topics3.end()); ResearchPlan plan2 (fix.trade, v.begin(), v.end()); assertThat (plan1.getTopic(), isEqualTo(fix.trade)); assertThat (plan1.getNumberOfRequirements(), isEqualTo(3)); assertThat (plan1, isEqualTo(plan2)); list<Topic> list(fix.topics4.begin(), fix.topics4.end()); ResearchPlan plan3 (fix.trade, list.begin(), list.end()); assertThat(plan1, isNotEqualTo(plan3)); ostringstream out; out << plan1; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Alphabet")); assertThat (out.str(), contains("Mining")); assertThat (out.str(), contains("Commerce")); } /** * Generate an always empty iterator range */ class BogusContainer { Topic x; public: typedef Topic* iterator; typedef const Topic* const_iterator; iterator begin() {return &x;} iterator end() {return &x;} const_iterator begin() const {return &x;} const_iterator end() const {return &x;} }; UnitTest(PlanConsIterEmpty) { Fixture fix; ResearchPlan plan1 (fix.trade, fix.topics3.begin(), fix.topics3.begin()); vector<Topic> v(fix.topics3.begin(), fix.topics3.end()); ResearchPlan plan2 (fix.trade, v.begin()+1, v.begin()+1); assertThat (plan1.getTopic(), isEqualTo(fix.trade)); assertThat (plan1.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan1, isEqualTo(plan2)); BogusContainer bc; ResearchPlan plan3 (fix.trade, bc.begin(), bc.end()); assertThat(plan1, isEqualTo(plan3)); ostringstream out; out << plan1; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("()")); } UnitTest(PlanAddPrereq) { Fixture fix; ResearchPlan plan0(fix.trade); ResearchPlan plan (fix.trade); assertThat (plan, isEqualTo(plan0)); plan.addRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan, isNotEqualTo(plan0)); assertThat (*(plan.begin()), isEqualTo(fix.commerce)); plan.addRequirement(fix.sailing); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); plan.addRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); ostringstream out; out << plan; string outStr = out.str(); assertThat (outStr, contains("Trade")); assertThat (outStr, contains("Sailing")); assertThat (outStr, contains("Commerce")); } UnitTest(PlanRemovePrereq) { Fixture fix; ResearchPlan plan0(fix.trade); ResearchPlan plan (fix.trade); assertThat (plan, isEqualTo(plan0)); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); ostringstream out; out << plan; string outStr = out.str(); assertThat (outStr, contains("Trade")); assertThat (outStr, contains("Sailing")); assertThat (outStr, not(contains("Commerce"))); } UnitTest(PlanCopy) { Fixture fix; ResearchPlan plan(fix.trade); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); ResearchPlan plan2 (plan); assertThat(plan2, isEqualTo(plan)); plan2.addRequirement(fix.alphabet); assertThat(plan2, isNotEqualTo(plan)); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); std::array<Topic, 3> plan2prereqs {fix.commerce, fix.sailing, fix.alphabet}; assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); } UnitTest(PlanAssign) { Fixture fix; ResearchPlan plan(fix.trade); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); ResearchPlan plan2; ResearchPlan plan3(plan2 = plan); assertThat(plan2, isEqualTo(plan)); assertThat(plan3, isEqualTo(plan)); plan2.addRequirement(fix.alphabet); assertThat(plan2, isNotEqualTo(plan)); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); std::array<Topic, 3> plan2prereqs {fix.commerce, fix.sailing, fix.alphabet}; assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); } UnitTest(zzCheckForMemoryLeaks) { assertThat(MemoryChecked::getCurrentCount(), isEqualTo(0)); }

test1.in

Alphabet: 28 Bronze Working: 28 Ceremonial Burial: 28 Code of Laws: Alphabet, 79 Currency: Bronze Working, 79 Horseback Riding: 28 Iron Working: Bronze Working, Warrior Code, 136 Map Making: Alphabet, 79 Masonry: 28 Mathematics: Alphabet, Masonry, 136 Mysticism: Ceremonial Burial, 79 Polytheism: Horseback Riding, Ceremonial Burial, 136 Pottery: 28 The Wheel: Horseback Riding, 79 Warrior Code: 28 Writing: Alphabet, 79 --- Bronze Working Ceremonial Burial Horseback Riding Warrior Code Alphabet Masonry Pottery ---

test2.in

Advanced Flight: Radio, Machine Tools, 44370 Alphabet: 28 Amphibious Warfare: Navigation, Tactics, 12889 Astronomy: Mysticism, Mathematics, 400 Atomic Theory: Theory of Gravity, Physics, 3633 Automobile: Combustion, Steel, 28118 Banking: Trade, The Republic, 928 Bridge Building: Iron Working, Construction, 552 Bronze Working: 28 Ceremonial Burial: 28 Chemistry: University, Medicine, 2298 Chivalry: Feudalism, Horseback Riding, 729 Code of Laws: Alphabet, 79 Combined Arms: Mobile Warfare, Advanced Flight, 56104 Combustion: Refining, Explosives, 19155 Communism: Philosophy, Industrialization, 10004 Computers: Mass Production, Miniaturization, 50380 Conscription: Democracy, Metallurgy, 6470 Construction: Masonry, Currency, 218 Currency: Bronze Working, 79 Democracy: Banking, Invention, 2540 Economics: Banking, University, 2405 Electricity: Metallurgy, Magnetism, 7550 Electronics: The Corporation, Electricity, 17914 Engineering: The Wheel, Construction, 523 Environmentalism: Recycling, Space Flight, 79634 Espionage: Communism, Democracy, 12774 Explosives: Gunpowder, Chemistry, 5180 Feudalism: Warrior Code, Monarchy, 431 Flight: Combustion, Theory of Gravity, 22442 Fusion Power: Nuclear Power, Superconductors, 54353 Genetic Engineering: Medicine, The Corporation, 13908 Guerilla Warfare: Communism, Tactics, 20397 Gunpowder: Invention, Iron Working, 1980 Horseback Riding: 28 Industrialization: Railroad, Banking, 7883 Invention: Engineering, Literacy, 1232 Iron Working: Bronze Working, Warrior Code, 136 Labor Union: Mass Production, Guerilla Warfare, 45896 Laser: Mass Production, Nuclear Power, 46307 Leadership: Chivalry, Gunpowder, 3536 Literacy: Writing, Code of Laws, 241 Machine Tools: Steel, Tactics, 23516 Magnetism: Iron Working, Physics, 2711 Map Making: Alphabet, 79 Masonry: 28 Mass Production: Automobile, The Corporation, 31340 Mathematics: Alphabet, Masonry, 136 Medicine: Philosophy, Trade, 1186 Metallurgy: Gunpowder, University, 3760 Miniaturization: Machine Tools, Electronics, 32350 Mobile Warfare: Automobile, Tactics, 37526 Monarchy: Ceremonial Burial, Code of Laws, 218 Monotheism: Philosophy, Polytheism, 1018 Mysticism: Ceremonial Burial, 79 Navigation: Seafaring, Astronomy, 954 Nuclear Fission: Mass Production, Atomic Theory, 36171 Nuclear Power: Nuclear Fission, Electronics, 42449 Philosophy: Mysticism, Literacy, 546 Physics: Literacy, Navigation, 1747 Plastics: Refining, Space Flight, 76083 Polytheism: Horseback Riding, Ceremonial Burial, 136 Pottery: 28 Radio: Flight, Electricity, 29166 Railroad: Steam Engine, Bridge Building, 5549 Recycling: Mass Production, Democracy, 35470 Refining: Chemistry, The Corporation, 14640 Refrigeration: Sanitation, Electricity, 10856 Robotics: Mobile Warfare, Computers, 58995 Rocketry: Advanced Flight, Electronics, 51430 Sanitation: Engineering, Medicine, 2393 Seafaring: Pottery, Map Making, 218 Space Flight: Computers, Rocketry, 70843 Stealth: Superconductors, Advanced Flight, 74539 Steam Engine: Physics, Invention, 3813 Steel: Electricity, Industrialization, 14957 Superconductors: Nuclear Power, Laser, 50275 Tactics: Conscription, Leadership, 9808 The Corporation: Economics, Industrialization, 11243 The Republic: Code of Laws, Literacy, 387 The Wheel: Horseback Riding, 79 Theology: Feudalism, Monotheism, 1922 Theory of Gravity: Astronomy, University, 1671 Trade: Currency, Code of Laws, 304 University: Mathematics, Philosophy, 1018 Warrior Code: 28 Writing: Alphabet, 79 --- Advanced Flight Alphabet Amphibious Warfare Astronomy Atomic Theory Automobile Banking Bridge Building Bronze Working Ceremonial Burial Chemistry Chivalry Code of Laws Combustion Communism Conscription Construction Currency Democracy Economics Electricity Electronics Engineering Espionage Explosives Feudalism Flight Genetic Engineering Guerilla Warfare Gunpowder Horseback Riding Industrialization Invention Iron Working Labor Union Laser Leadership Literacy Machine Tools Magnetism Map Making Masonry Mass Production Mathematics Medicine Metallurgy Miniaturization Mobile Warfare Monarchy Monotheism Mysticism Navigation Nuclear Fission Nuclear Power Philosophy Physics Polytheism Pottery Radio Railroad Recycling Refining Refrigeration Sanitation Seafaring Steam Engine Steel Tactics The Corporation The Republic The Wheel Theology Theory of Gravity Trade University Warrior Code Writing

testEncyclopedia.cpp

#include "unittest.h" #include <sstream> #include <algorithm> #include <iterator> #include <set> #include "encyclopedia.h" using namespace std; UnitTest(EncyclopediaConstructor) { Encyclopedia enc; assertThat (enc.end(), isEqualTo(enc.begin())); } UnitTest(EncyclopediaAddCourse) { Topic alphabet ("Alphabet", 15); Topic commerce ("Commerce", 25); Topic sailing ("Sailing", 36); Topic mapping ("Mapping", 30); Topic trading ("Trading", 35); Encyclopedia enc; enc.addPlanRequirement(commerce, alphabet); assertThat (distance(enc.begin(), enc.end()), isEqualTo(2)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertFalse(enc.containsTopic(sailing)); assertFalse(enc.containsTopic(mapping)); assertFalse(enc.containsTopic(trading)); set<Topic> expected1 {alphabet, commerce}; set<Topic> observed1; transform(enc.begin(), enc.end(), inserter(observed1, observed1.begin()), [] (const ResearchPlan& plan) {return plan.getTopic();}); assertThat(observed1, isEqualTo(expected1)); enc.addPlanRequirement(trading, sailing); assertThat (distance(enc.begin(), enc.end()), isEqualTo(4)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertTrue(enc.containsTopic(sailing)); assertFalse(enc.containsTopic(mapping)); assertTrue(enc.containsTopic(trading)); set<Topic> expected2 {alphabet, commerce, sailing, trading}; set<Topic> observed2; transform(enc.begin(), enc.end(), inserter(observed2, observed2.begin()), [] (const ResearchPlan& plan) {return plan.getTopic();}); assertThat(observed2, isEqualTo(expected2)); enc.addPlanRequirement(trading, mapping); assertThat (distance(enc.begin(), enc.end()), isEqualTo(5)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertTrue(enc.containsTopic(sailing)); assertTrue(enc.containsTopic(mapping)); assertTrue(enc.containsTopic(trading)); enc.addPlanRequirement(mapping, commerce); assertThat (distance(enc.begin(), enc.end()), isEqualTo(5)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertTrue(enc.containsTopic(sailing)); assertTrue(enc.containsTopic(mapping)); assertTrue(enc.containsTopic(trading)); enc.addPlanRequirement(sailing, commerce); assertThat (distance(enc.begin(), enc.end()), isEqualTo(5)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertTrue(enc.containsTopic(sailing)); assertTrue(enc.containsTopic(mapping)); assertTrue(enc.containsTopic(trading)); set<Topic> expected3 {alphabet, commerce, mapping, sailing, trading}; set<Topic> observed3; transform(enc.begin(), enc.end(), inserter(observed3, observed3.begin()), [] (const ResearchPlan& plan) {return plan.getTopic();}); assertThat(observed3, isEqualTo(expected3)); auto plan = enc.getPlan(commerce); assertThat (plan.getTopic(), isEqualTo(commerce)); assertThat(plan.getNumberOfRequirements(), isEqualTo(1)); plan = enc.getPlan(trading); assertThat (plan.getTopic(), isEqualTo(trading)); assertThat(plan.getNumberOfRequirements(), isEqualTo(2)); } UnitTest(EncyclopediaRemoveCourse) { Topic alphabet ("Alphabet", 15); Topic commerce ("Commerce", 25); Topic sailing ("Sailing", 36); Topic mapping ("Mapping", 30); Topic trading ("Trading", 35); Encyclopedia enc; enc.addPlanRequirement(commerce, alphabet); enc.addPlanRequirement(trading, sailing); enc.addPlanRequirement(trading, mapping); enc.addPlanRequirement(mapping, commerce); enc.addPlanRequirement(sailing, commerce); enc.removeTopic(mapping); assertThat (distance(enc.begin(), enc.end()), isEqualTo(4)); assertTrue(enc.containsTopic(alphabet)); assertTrue(enc.containsTopic(commerce)); assertTrue(enc.containsTopic(sailing)); assertFalse(enc.containsTopic(mapping)); assertTrue(enc.containsTopic(trading)); auto plan = enc.getPlan(trading); assertThat (plan.getTopic(), isEqualTo(trading)); assertThat(plan.getNumberOfRequirements(), isEqualTo(1)); } UnitTest(EncyclopediaCopy) { Topic alphabet ("Alphabet", 15); Topic commerce ("Commerce", 25); Topic sailing ("Sailing", 36); Topic mapping ("Mapping", 30); Topic trading ("Trading", 35); Encyclopedia enc; enc.addPlanRequirement(commerce, alphabet); enc.addPlanRequirement(trading, sailing); enc.addPlanRequirement(trading, mapping); enc.addPlanRequirement(mapping, commerce); enc.addPlanRequirement(sailing, commerce); Encyclopedia enc2 (enc); assertThat(enc2, isEqualTo(enc)); enc.removeTopic(mapping); assertThat(enc2, isNotEqualTo(enc)); assertThat (distance(enc2.begin(), enc2.end()), isEqualTo(5)); assertTrue(enc2.containsTopic(alphabet)); assertTrue(enc2.containsTopic(commerce)); assertTrue(enc2.containsTopic(sailing)); assertTrue(enc2.containsTopic(mapping)); assertTrue(enc2.containsTopic(trading)); auto plan = enc2.getPlan(trading); assertThat (plan.getTopic(), isEqualTo(trading)); assertThat(plan.getNumberOfRequirements(), isEqualTo(2)); } UnitTest(EncyclopediaAssign) { Topic alphabet ("Alphabet", 15); Topic commerce ("Commerce", 25); Topic sailing ("Sailing", 36); Topic mapping ("Mapping", 30); Topic trading ("Trading", 35); Encyclopedia enc; enc.addPlanRequirement(commerce, alphabet); enc.addPlanRequirement(trading, sailing); enc.addPlanRequirement(trading, mapping); enc.addPlanRequirement(mapping, commerce); enc.addPlanRequirement(sailing, commerce); Encyclopedia enc2; Encyclopedia enc3 (enc2 = enc); assertThat(enc2, isEqualTo(enc)); assertThat(enc3, isEqualTo(enc)); enc.removeTopic(mapping); assertThat(enc2, isNotEqualTo(enc)); assertThat (distance(enc2.begin(), enc2.end()), isEqualTo(5)); assertTrue(enc2.containsTopic(alphabet)); assertTrue(enc2.containsTopic(commerce)); assertTrue(enc2.containsTopic(sailing)); assertTrue(enc2.containsTopic(mapping)); assertTrue(enc2.containsTopic(trading)); auto plan = enc2.getPlan(trading); assertThat (plan.getTopic(), isEqualTo(trading)); assertThat(plan.getNumberOfRequirements(), isEqualTo(2)); } UnitTest(EncyclopediaRead) { Topic agriculture ("Agriculture", 10); Topic alphabet ("Alphabet", 15); Topic printing ("Printing", 100); Topic publishing ("Publishing", 100); string testIn = string("Agriculture: 10\n") + + "Alphabet: 15\n" "Printing: Alphabet, 100\n" + "Publishing: Printing, Agriculture, 100\n" + "---"; istringstream in (testIn); Encyclopedia enc; enc.read(in); assertTrue (enc.containsTopic(agriculture)); assertTrue (enc.containsTopic(printing)); assertTrue (enc.containsTopic(publishing)); assertTrue (enc.containsTopic(alphabet)); assertThat(distance(enc.begin(), enc.end()), isEqualTo(4)); assertThat(enc.getPlan(agriculture).getNumberOfRequirements(), isEqualTo(0)); assertThat(enc.getPlan(printing).getNumberOfRequirements(), isEqualTo(1)); assertThat(enc.getPlan(publishing).getNumberOfRequirements(), isEqualTo(2)); assertThat(enc.getPlan(agriculture).getTopic().researchCost, isEqualTo(10)); assertThat(enc.getPlan(alphabet).getTopic().researchCost, isEqualTo(15)); assertThat(enc.getPlan(printing).getTopic().researchCost, isEqualTo(100)); assertThat(enc.getPlan(publishing).getTopic().researchCost, isEqualTo(100)); }

testResearchPlan.cpp

#include "researchplan.h" #include "unittest.h" #include <array> #include <list> #include <sstream> using namespace std; /** * A "test fixture" is a mechanism for providing common access to test * data that may be used in multiple tests. */ class Fixture { public: const Topic alphabet; const Topic mining; const Topic commerce; const Topic sailing; const Topic trade; const Topic wheel; std::array<Topic, 2> topics2; std::array<Topic, 3> topics3; std::array<Topic, 4> topics4; std::array<Topic, 5> topics5; Fixture(); }; Fixture::Fixture() : alphabet ("Alphabet", 15), mining ("Mining", 25), commerce ("Commerce", 30), sailing ("Sailing", 36), trade ("Trade", 45), wheel ("Wheel", 10), topics2{commerce, sailing}, topics3{alphabet, mining, commerce}, topics4{alphabet, mining, commerce, sailing}, topics5{alphabet, mining, commerce, sailing, trade} { } UnitTest(PlanDefaultConstructor) { ResearchPlan plan; assertThat (plan.getTopic(), isEqualTo(Topic())); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isEqualTo(ResearchPlan())); assertThat (plan, not(isLessThan(ResearchPlan()))); assertThat (plan, not(isGreaterThan(ResearchPlan()))); } UnitTest(PlanConstructor) { Fixture fix; ResearchPlan plan (fix.alphabet); assertThat (plan.getTopic(), isEqualTo(fix.alphabet)); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.mining))); assertThat (plan.begin(), isEqualTo(plan.end())); ostringstream out; out << plan; assertThat (out.str(), contains("Alphabet")); } UnitTest(PlanConsInitList0) { Fixture fix; ResearchPlan plan (fix.trade, {fix.alphabet, fix.commerce, fix.sailing}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(3)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.wheel))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Alphabet")); assertThat (out.str(), contains("Commerce")); assertThat (out.str(), contains("Sailing")); } UnitTest(PlanConsInitListSingle) { Fixture fix; ResearchPlan plan (fix.trade, {fix.sailing}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, isLessThan(ResearchPlan(fix.wheel))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Sailing")); } UnitTest(PlanConsInitListEmpty) { Fixture fix; ResearchPlan plan (fix.trade, {}); assertThat (plan.getTopic(), isEqualTo(fix.trade)); assertThat (plan.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan, isNotEqualTo(ResearchPlan())); assertThat (plan, not(isLessThan(ResearchPlan(fix.commerce)))); assertThat (plan, isGreaterThan(ResearchPlan(fix.mining))); ostringstream out; out << plan; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("()")); } UnitTest(PlanConsIter0) { Fixture fix; ResearchPlan plan1 (fix.trade, fix.topics3.begin(), fix.topics3.end()); vector<Topic> v(fix.topics3.begin(), fix.topics3.end()); ResearchPlan plan2 (fix.trade, v.begin(), v.end()); assertThat (plan1.getTopic(), isEqualTo(fix.trade)); assertThat (plan1.getNumberOfRequirements(), isEqualTo(3)); assertThat (plan1, isEqualTo(plan2)); list<Topic> list(fix.topics4.begin(), fix.topics4.end()); ResearchPlan plan3 (fix.trade, list.begin(), list.end()); assertThat(plan1, isNotEqualTo(plan3)); ostringstream out; out << plan1; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("(Alphabet")); assertThat (out.str(), contains("Mining")); assertThat (out.str(), contains("Commerce")); } /** * Generate an always empty iterator range */ class BogusContainer { Topic x; public: typedef Topic* iterator; typedef const Topic* const_iterator; iterator begin() {return &x;} iterator end() {return &x;} const_iterator begin() const {return &x;} const_iterator end() const {return &x;} }; UnitTest(PlanConsIterEmpty) { Fixture fix; ResearchPlan plan1 (fix.trade, fix.topics3.begin(), fix.topics3.begin()); vector<Topic> v(fix.topics3.begin(), fix.topics3.end()); ResearchPlan plan2 (fix.trade, v.begin()+1, v.begin()+1); assertThat (plan1.getTopic(), isEqualTo(fix.trade)); assertThat (plan1.getNumberOfRequirements(), isEqualTo(0)); assertThat (plan1, isEqualTo(plan2)); BogusContainer bc; ResearchPlan plan3 (fix.trade, bc.begin(), bc.end()); assertThat(plan1, isEqualTo(plan3)); ostringstream out; out << plan1; assertThat (out.str(), contains("Trade")); assertThat (out.str(), contains("()")); } UnitTest(PlanAddPrereq) { Fixture fix; ResearchPlan plan0(fix.trade); ResearchPlan plan (fix.trade); assertThat (plan, isEqualTo(plan0)); plan.addRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan, isNotEqualTo(plan0)); assertThat (*(plan.begin()), isEqualTo(fix.commerce)); plan.addRequirement(fix.sailing); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); plan.addRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); ostringstream out; out << plan; string outStr = out.str(); assertThat (outStr, contains("Trade")); assertThat (outStr, contains("Sailing")); assertThat (outStr, contains("Commerce")); } UnitTest(PlanRemovePrereq) { Fixture fix; ResearchPlan plan0(fix.trade); ResearchPlan plan (fix.trade); assertThat (plan, isEqualTo(plan0)); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); ostringstream out; out << plan; string outStr = out.str(); assertThat (outStr, contains("Trade")); assertThat (outStr, contains("Sailing")); assertThat (outStr, not(contains("Commerce"))); } UnitTest(PlanCopy) { Fixture fix; ResearchPlan plan(fix.trade); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); ResearchPlan plan2 (plan); assertThat(plan2, isEqualTo(plan)); plan2.addRequirement(fix.alphabet); assertThat(plan2, isNotEqualTo(plan)); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); std::array<Topic, 3> plan2prereqs {fix.commerce, fix.sailing, fix.alphabet}; assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); } UnitTest(PlanAssign) { Fixture fix; ResearchPlan plan(fix.trade); plan.addRequirement(fix.commerce); plan.addRequirement(fix.sailing); ResearchPlan plan2; ResearchPlan plan3(plan2 = plan); assertThat(plan2, isEqualTo(plan)); assertThat(plan3, isEqualTo(plan)); plan2.addRequirement(fix.alphabet); assertThat(plan2, isNotEqualTo(plan)); assertThat (plan.getNumberOfRequirements(), isEqualTo(2)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertTrue (equal(plan.begin(), plan.end(), fix.topics2.begin(), fix.topics2.end())); std::array<Topic, 3> plan2prereqs {fix.commerce, fix.sailing, fix.alphabet}; assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); plan.removeRequirement(fix.commerce); assertThat (plan.getNumberOfRequirements(), isEqualTo(1)); assertThat (plan2.getNumberOfRequirements(), isEqualTo(3)); assertThat (*(plan.begin()), isEqualTo(fix.sailing)); assertTrue (equal(plan2.begin(), plan2.end(), plan2prereqs.begin(), plan2prereqs.end())); } UnitTest(zzCheckForMemoryLeaks) { assertThat(MemoryChecked::getCurrentCount(), isEqualTo(0)); }

topic.cpp

#include "topic.h" #include <iostream> #include <string> using namespace std; Topic::Topic () : name(""), researchCost(0) { } Topic::Topic (string theName, int cost) : name(theName), researchCost(cost) { } bool Topic::operator== (const Topic& right) const { return name == right.name; } bool Topic::operator< (const Topic& right) const { return name < right.name; } ostream& operator<< (ostream& out, const Topic& topic) { out << topic.name << ": " << topic.researchCost; return out; }

topic.h

#ifndef COURSENAME_H #define COURSENAME_H #include <iostream> #include <string> #include "memoryChecked.h" using namespace std; /* * A topic that can be researched. */ struct Topic { std::string name; int researchCost; Topic(); Topic (std::string theName, int theCost); bool operator== (const Topic& right) const; bool operator< (const Topic& right) const; private: MemoryChecked _mem; }; std::ostream& operator<< (std::ostream& out, const Topic& c); #endif

unittest.cpp

#include <algorithm> #include <iostream> #include <iomanip> #include <set> #include <sstream> #include <fstream> #include <chrono> #include <thread> #include <mutex> #include <regex> #include <iterator> #include <signal.h> #include <setjmp.h> #include <cstdlib> #include <unistd.h> #include "unittest.h" #ifdef __MINGW32__ #ifdef __MINGW64__ #include <debugapi.h> #else #include <winbase.h> #endif #elif __CYGWIN__ #include <w32api/debugapi.h> #endif using namespace CppUnitLite; std::map<std::string, UnitTest::BoundedTest> *UnitTest::tests = nullptr; long UnitTest::numSuccesses = 0L; long UnitTest::numFailures = 0L; long UnitTest::numErrors = 0L; std::string UnitTest::currentTest; bool UnitTest::expectToFail = false; bool UnitTest::diagnosticMessagesBeforeResults = true; std::vector<std::string> UnitTest::callLog; std::vector<std::string> UnitTest::failedTests; #ifdef __amd64__ #define breakDebugger { asm volatile ("int $3"); } #elif __i386__ #define breakDebugger { asm volatile ("int $3"); } #else #define breakDebugger { } #endif template <> std::string CppUnitLite::getStringRepr(std::string t) { return std::string("\"") + t + '"'; } template <> std::string CppUnitLite::getStringRepr(const char t[]) { return CppUnitLite::getStringRepr(std::string(t)); } template <> std::string CppUnitLite::getStringRepr(char t) { return std::string("'") + t + "'"; } template <> std::string CppUnitLite::getStringRepr(bool b) { return (b) ? "true" : "false"; } UnitTest::UnitTestFailure::UnitTestFailure ( const char* conditionStr, const char* fileName, int lineNumber) { if (!UnitTest::expectToFail) { std::ostringstream out; out << "Failed assertion " << conditionStr << " in " << currentTest << " at " << fileName << ", line " << lineNumber << "\n"; explanation = out.str(); } else { explanation = "(expected to fail)"; } } UnitTest::UnitTestFailure::UnitTestFailure ( const std::string& conditionStr, const char* fileName, int lineNumber) { if (!UnitTest::expectToFail) { std::ostringstream out; out << fileName << ":" << lineNumber << ": \t" << conditionStr << "\n"; explanation = out.str(); } else { explanation = "(expected to fail)"; } } const char* UnitTest::UnitTestFailure::what() const noexcept { return explanation.c_str(); } AssertionResult::AssertionResult (bool theResult, std::string pexplain, std::string fexplain) : result(theResult), passExplanation(pexplain), failExplanation(fexplain) {} #ifdef __MINGW32__ bool UnitTest::debuggerIsRunning() { return IsDebuggerPresent(); } #elif __CYGWIN__ bool UnitTest::debuggerIsRunning() { bool debuggerDetected = IsDebuggerPresent(); if (debuggerDetected) { UnitTest::msg("# Debugger detected -- test time limits will be ignored.\n"); } return debuggerDetected; } #else bool UnitTest::debuggerIsRunning() { using namespace std; static bool debuggerDetected = false; const string traceField = "tracerpid"; int pid = ::getpid(); string statusFile = string("/proc/") + std::to_string(pid) + "/status"; ifstream status (statusFile); if (status) { string line; getline (status, line); while (status) { transform(line.begin(), line.end(), line.begin(), ::tolower); if (line.find(traceField) != string::npos) { string::size_type k = line.find_first_of(" \t"); if (k != string::npos) { line = line.substr(k+1); istringstream lineIn (line); pid = -1; lineIn >> pid; if (pid > 0) { debuggerDetected = true; } } break; } getline (status, line); } } if (debuggerDetected) { UnitTest::msg("# Debugger detected -- test time limits will be ignored.\n"); } return debuggerDetected; } #endif void UnitTest::checkTest (AssertionResult assertionResult, std::string conditionStr, const char* fileName, int lineNumber) { if (!assertionResult.result) { if (debuggerIsRunning()) { std::string explanation = "Failed assertion: " + conditionStr + "\n" + assertionResult.failExplanation; breakDebugger; // A unit test has failed. // Examine explanation and your call stack for information explanation = explanation + " "; } if (assertionResult.failExplanation.size() > 0) { conditionStr += "\n\t" + assertionResult.failExplanation; } throw UnitTestFailure(conditionStr, fileName, lineNumber); } } //void UnitTest::checkTest (bool condition, const string& conditionStr, // const char* fileName, int lineNumber) //{ // checkTest(AssertionResult(condition), conditionStr.c_str(), fileName, lineNumber); //} // Print a simple summary report void UnitTest::report () { UnitTest::msgSummary(); } // Register a new UnitTest int UnitTest::registerUT (std::string functName, int timeLimit, TestFunction funct) { if (tests == nullptr) { tests = new std::map<std::string, UnitTest::BoundedTest>(); } if (tests->count(functName) > 0) { std::cerr << "**Error: duplicate unit test named " << functName << std::endl; } (*tests)[functName] = BoundedTest(timeLimit, funct); return 0; } jmp_buf unitTestSignalEnv; int unitTestLastSignal = 0; void unitTestSignalHandler(int sig) { unitTestLastSignal = sig; longjmp (unitTestSignalEnv, sig); } int UnitTest::runTestGuarded (unsigned testNumber, std::string testName, TestFunction u, std::string& testExplanation) { currentTest = testName; expectToFail = false; try { signal(SIGFPE, &unitTestSignalHandler); signal(SIGSEGV, &unitTestSignalHandler); if (setjmp(unitTestSignalEnv)) { // Runtime error was caught std::ostringstream out; out << "# runtime error " << unitTestLastSignal; if (!expectToFail) { testExplanation = UnitTest::msgFailed(testNumber, testName, out.str(), 0); return -1; } else { // OK (failed but was expected to fail)" UnitTest::msgXFailed(testNumber, testName, out.str(), 0); } } else { u(); if (!expectToFail) { UnitTest::msgPassed(testNumber, testName, 0); } else { // Failed (passed but was expected to fail UnitTest::msgXPassed(testNumber, testName, 0); return 0; } } return 1; } catch (UnitTestFailure& ex) { if (!expectToFail) { testExplanation = UnitTest::msgFailed(testNumber, testName, ex.what(), 0); return 0; } else { // OK (failed but was expected to fail)" UnitTest::msgXFailed(testNumber, testName, ex.what(), 0); return 1; } } catch (std::exception& e) { if (!expectToFail) { UnitTest::msgError(testNumber, testName, "Unexpected error in " + currentTest + ": " +e.what(), 0); testExplanation = ""; return -1; } else { // OK (exception but was expected to fail)" UnitTest::msgXFailed(testNumber, testName, "", 0); return 1; } } catch (...) { if (!expectToFail) { UnitTest::msgError(testNumber, testName, "Unexpected error in " + currentTest, 0); testExplanation = ""; return -1; } else { // OK (exception but was expected to fail)" UnitTest::msgXFailed(testNumber, testName, "", 0); return 1; } } } /** * Reverses the expectation for the current test. A test that fails or halts * with an error will be reported and counted as OK. If that test succeeds, * it will be reported and counted as an error. * * Must be called before any assertions. */ void UnitTest::expectedToFail() { expectToFail = true; } // Run a single unit test function with no timer. void UnitTest::runTestUntimed (unsigned testNumber, std::string testName, TestFunction u) { int testResult; // 1== passed, 0 == failed, -1 == erro std::string testExplanation; // No time-out supported if compiler does not have thread support. testResult = runTestGuarded (testNumber, testName, u, testExplanation); try { // Normal exit if (testResult == 1) { ++numSuccesses; } else if (testResult == 0) { ++numFailures; failedTests.push_back(testName); UnitTest::msg(testExplanation); } else if (testResult == -1) { ++numErrors; failedTests.push_back(testName); UnitTest::msg(testExplanation); } } catch (std::runtime_error& e) { ++numErrors; failedTests.push_back(testName); UnitTest::msg(std::string("# Test ") + currentTest + " failed due to " + e.what() + "\n"); } } #ifndef __MINGW32__ // Run a single unit test function. void UnitTest::runTest (unsigned testNumber, std::string testName, TestFunction u, long timeLimit) { if (timeLimit > 0L && !debuggerIsRunning()) { int testResult = -99; // 1== passed, 0 == failed, -1 == error std::string testExplanation; std::mutex m; std::chrono::duration<int,std::milli> limit (timeLimit); std::chrono::duration<int,std::milli> incr (100); std::chrono::duration<int,std::milli> elapsed (0); std::thread t([&m, &testNumber, &testName, &u, &testResult, &testExplanation](){ { int result = runTestGuarded (testNumber, testName, u, testExplanation); std::unique_lock<std::mutex> l2(m); testResult = result; } }); t.detach(); bool finished = false; do { { std::unique_lock<std::mutex> l(m); finished = (testResult >= -1 || elapsed >= limit); elapsed += incr; } std::this_thread::sleep_for( incr ); } while (!finished); if (testResult < -1) { ++numFailures; failedTests.push_back(testName); std::ostringstream out; out << "# Test " << testNumber << " - " << currentTest << " still running after " << timeLimit << " milliseconds - possible infinite loop?"; if (!expectToFail) { UnitTest::msg ( UnitTest::msgFailed(testNumber, testName, out.str(), timeLimit) ); } else { UnitTest::msgXFailed(testNumber, testName, out.str(), timeLimit); ++numSuccesses; --numFailures; } } // Normal exit else if (testResult == 1) { ++numSuccesses; } else if (testResult == 0) { ++numFailures; failedTests.push_back(testName); UnitTest::msg(testExplanation); } else if (testResult == -1) { ++numErrors; failedTests.push_back(testName); UnitTest::msg(testExplanation); } } else { runTestUntimed (testNumber, testName, u); } } #else // Run a single unit test function. void UnitTest::runTest (unsigned testNumber, std::string testName, TestFunction u, long int timeLimit) { runTestUntimed (testNumber, testName, u); } #endif // Run all units tests whose name contains testNames[i], // 0 <= i <= nTests // // Special case: If nTests == 0, runs all unit Tests. void UnitTest::runTests (int nTests, char** testNames, char* program) { std::set<std::string> testsToRun; // Check for GTest emulation for (int i = 0; i < nTests; ++i) { std::string arg = testNames[i]; } std::string badTestSpecifications = ""; for (int i = 0; i < nTests; ++i) { std::string testID = testNames[i]; bool found = false; for (const auto& utest: *tests) { if (utest.first.find(testID) != std::string::npos) { testsToRun.insert(utest.first); found = true; } } if (!found) { for (const auto& utest: *tests) { const std::string& utestName = utest.first; std::string reducedName (1, utestName[0]); for (unsigned j = 1; j < utest.first.size(); ++j) { if (utestName[j] >= 'A' && utestName[j] <= 'Z') { reducedName += utestName[j]; } } if (testID == reducedName) { testsToRun.insert(utest.first); found = true; } } } if (!found) { badTestSpecifications += "# Warning: No matching test found for input specification " + testID + "\n"; } } if (testsToRun.size() == 0) { for (const auto& utest: *tests) { testsToRun.insert(utest.first); } } // Emit TAP plan line UnitTest::msg ("1.." + std::to_string(testsToRun.size())); UnitTest::msg (badTestSpecifications); unsigned testNumber = 1; for (std::string testName: testsToRun) { BoundedTest test = (*tests)[testName]; runTest (testNumber, testName, test.unitTest, test.timeLimit); ++testNumber; } } /** * Clear the call log. */ void UnitTest::clearCallLog() { callLog.clear(); } /** * Position of oldest logged call. */ UnitTest::iterator UnitTest::begin() { return callLog.begin(); } /** * Position just after the most recently logged call. */ UnitTest::iterator UnitTest::end() { return callLog.end(); } /** * Log a call to a zero-parameter function. * * @param functionName name of the function */ void UnitTest::logCall (const std::string& functionName) { callLog.push_back (functionName); } void UnitTest::msgPassed (unsigned testNumber, std::string testName, unsigned timeMS) { using namespace std; cout << flush; cout << "ok " << testNumber << " - " << testName << endl; } void UnitTest::msgXPassed (unsigned testNumber, std::string testName, unsigned timeMS) { UnitTest::msg( UnitTest::msgFailed(testNumber, testName, std::string("Test ") + std::to_string(testNumber) + " - " + testName + " passed but was expected to fail.", timeMS) ); } std::string UnitTest::extractLocation (const std::string& msg) { using namespace std; string::size_type len = msg.size(); string::size_type pos1 = msg.find(".h:"); string::size_type pos2 = msg.find(".cpp:"); string::size_type pos = (pos1 < pos2) ? pos1 : pos2; string::size_type posEnd = pos + ((pos1 < pos2) ? 3 : 5); string::size_type stop = posEnd; while (stop < len && isdigit(msg[stop])) { ++stop; } if (stop == posEnd) return ""; string::size_type start = pos; char c = msg[start]; while (start <= pos && (isalnum(c) || c == '.' || c == '_' || c == '-' || c == '/' || c == '\\')) { --start; if (start <= pos) c = msg[start]; } if (start == pos) return ""; string result = msg.substr(start+1, stop-start-1); return result; } std::string UnitTest::msgFailed (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS) { using namespace std; string location = extractLocation(diagnostics); if (location.size() > 0) location += ": error: Failed test\n"; string diagnosticString = location + msgComment(diagnostics); string resultMsg = "not ok " + to_string(testNumber) + " - " + testName; if (diagnosticMessagesBeforeResults) return diagnosticString + ": \n" + resultMsg; else return resultMsg + "\n" + diagnosticString; } std::string UnitTest::msgComment (const std::string& commentary) { const static std::string commentPrefix = "# "; std::string result; std::string startOfLine = commentary.substr(0, commentPrefix.size()); if (startOfLine == commentPrefix) result = commentary; else result = commentPrefix + commentary; std::string::size_type pos = result.find('\n'); while (pos != std::string::npos) { if (result.size() >= pos+1+commentPrefix.size()) { startOfLine = result.substr(pos+1, commentPrefix.size()); if (startOfLine != commentPrefix) { result.insert(pos+1, commentPrefix); } } else { result.insert(pos+1, commentPrefix); } pos = result.find('\n', pos+1); } return result; } void UnitTest::msgXFailed (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS) { std::string diagnosticMsg = msgComment(std::string("Test ") + std::to_string(testNumber) + " failed but was expected to fail."); if (diagnosticMessagesBeforeResults) UnitTest::msg(diagnosticMsg); UnitTest::msgPassed(testNumber, testName, timeMS); if (!diagnosticMessagesBeforeResults) UnitTest::msg(diagnosticMsg); } void UnitTest::msgError (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS) { std::string diagnosticMsg = msgComment("ERROR - " + diagnostics); if (diagnosticMessagesBeforeResults) UnitTest::msg(diagnosticMsg); UnitTest::msg("not ok " + std::to_string(testNumber) + " - " + testName); if (!diagnosticMessagesBeforeResults) UnitTest::msg(diagnosticMsg); } void UnitTest::msgSummary () { using namespace std; cout << "# UnitTest: passed " << numSuccesses << " out of " << getNumTests() << " tests, for a success rate of " << std::showpoint << std::fixed << std::setprecision(1) << (100.0 * numSuccesses)/(float)getNumTests() << "%" << endl; } void UnitTest::msg (const std::string& detailMessage) { using std::cout; cout << detailMessage; if (detailMessage.size() > 0 && detailMessage[detailMessage.size()-1] != '\n') cout << "\n"; cout << std::flush; } StringContainsMatcher::StringContainsMatcher (const std::string& t): right(t) {} AssertionResult StringContainsMatcher::eval(const std::string& e) const { auto result = e.find(right); return AssertionResult( result != std::string::npos, "Found " + getStringRepr(right) + " starting in position " + getStringRepr(result) + " of " + getStringRepr(e), "Within " + getStringRepr(e) + ", cannot find " + getStringRepr(right)); } CppUnitLite::StringContainsMatcher contains(const char* t) { return CppUnitLite::StringContainsMatcher(std::string(t)); } CppUnitLite::StringContainsMatcher contains(const std::string& t) { return CppUnitLite::StringContainsMatcher(t); } StringEndsWithMatcher::StringEndsWithMatcher (const std::string& t): right(t) {} AssertionResult StringEndsWithMatcher::eval(const std::string& e) const { std::string eStr = getStringRepr(e); std::string rightStr = getStringRepr(right); bool result = (right.size() <= e.size()) && equal(right.begin(), right.end(), e.begin() + e.size() - right.size()); return AssertionResult(result, eStr + " ends with " + rightStr, eStr + " does not end with " + rightStr); } StringEndsWithMatcher endsWith(const char* t) { return StringEndsWithMatcher(std::string(t)); } StringEndsWithMatcher endsWith(const std::string& t) { return StringEndsWithMatcher(t); } StringBeginsWithMatcher::StringBeginsWithMatcher (const std::string& t) : right(t) {} AssertionResult StringBeginsWithMatcher::eval(const std::string& e) const { std::string eStr = getStringRepr(e); std::string rightStr = getStringRepr(right); bool result = (right.size() <= e.size()) && equal(right.begin(), right.end(), e.begin()); return AssertionResult(result, eStr + " begins with " + rightStr, eStr + " does not begin with " + rightStr ); } StringBeginsWithMatcher beginsWith(const char* t) { return CppUnitLite::StringBeginsWithMatcher(std::string(t)); } StringBeginsWithMatcher beginsWith(const std::string& t) { return StringBeginsWithMatcher(t); } StringBeginsWithMatcher startsWith(const char* t) { return StringBeginsWithMatcher(std::string(t)); } StringBeginsWithMatcher startsWith(const std::string& t) { return StringBeginsWithMatcher(t); } AssertionResult NullMatcher::eval(const void* p) const { return AssertionResult(p == nullptr, "", ""); } CppUnitLite::NullMatcher isNull() { return CppUnitLite::NullMatcher(); } AssertionResult NotNullMatcher::eval(const void* p) const { return AssertionResult(p != nullptr, "", ""); } CppUnitLite::NotNullMatcher isNotNull() { return CppUnitLite::NotNullMatcher(); } #ifndef NOMAIN int main(int argc, char** argv) { UnitTest::diagnosticMessagesBeforeResults = true; UnitTest::runTests(argc-1, argv+1, argv[0]); UnitTest::report(); return 0; } #endif

unittest.h

#ifndef UNITTEST_H #define UNITTEST_H #include <algorithm> #include <cstdarg> #include <iostream> #include <map> #include <sstream> #include <string> #include <vector> /** * This class helps support self-checking unit tests. * * This is a lightweight framework similar in spirit to JUnit (for Java), * Google Test, and Boost Test, but which can be added to a project by the * simple addition of the two files, unittest.h and unittest.cpp. It's not as * robust as those other frameworks - some runtime errors will shut the * test suite down with no final report. * * # Usage * * The framework consists of a two files, `unittest.h` and `unittest.cpp`, * that can be dropped into a C++ project directory, allowing the creation of * a unit test suite. * * A test suite consists of a collection of unit test functions, which can * be distributed among multiple .cpp files. (Typically one such file * would be devoted to testing each class in the project.) * * Each unit test function is introduced via `UnitTest` or, optionally, * `UnitTestTimed` (which alters the default timeout, measured in * milliseconds). * * Each unit test function can contain code to set up parameters, invoke * the function(s) being tested, and to evaluate the results of those * function calls via the use of assertions. Most assertions have the form: * * assertThat (value, matcher); * * although the following "old-fashioned" assertions are also supported. * * assertTrue (condition); * assertFalse (condition); * assertEqual (expression1, expression2); * assertNotEqual (expression1, expression2); * assertNull (expression); * assertNotNull (expression); * * The assertThat form, however, allows for a much wider and expressive range of * tests: * * ## Relational Matchers * * assertThat(x, isEqualTo(y)); * assertThat(x, is(y)); // same as isEqualTo * assertThat(x, isApproximately(y, delta)); // floating point only * assertThat(x, isNotEqualTo(y)); * assertThat(x, isNot(y)); // same as isNotEqualTo * * assertThat(x, isOneOf(w, y, z)); // Allows 1 or more options * * assertThat(x, isLessThan(y)); * assertThat(x, isGreaterThan(y)); * assertThat(x, isLessThanOrEqualTo(y)); * assertThat(x, isGreaterThanOrEqualTo(y)); * * ## String Matchers * * assertThat(str, contains("bc")); * assertThat(str, beginsWith(str2)); * assertThat(str, endsWith(str2)); * assertThat(str, startsWith(str2)); // same as beginsWith * * ## Pointer Matchers * * assertThat(p, isNull()); * assertThat(q, isNotNull()); * * ## Container Matchers * * Containers that define key_type (sets and maps, including unordered) * will be searched using their own fast find member function. Other * containers will be searched using a sequential search over begin()..end(). * * assertThat(v, contains(3)); * assertThat(v, hasItem(x)); // Same as contains * assertThat(v, hasKey(x)); // Same as contains * * assertThat(L, hasItems(3, 9)); // Allows one or more values * assertThat(L, hasKeys(3, 9)); // Same as hasItems * * assertThat(range(v.begin(), v.end()), hasItem(z)); * assertThat(arrayOfLength(array, len), hasItem(z)); * * * assertThat(x, isIn(v)); * assertThat(x, isInRange(v.begin(), v.end())); * * assertThat(aMap, hasEntry(5, 10)); // maps only * * ## Combining Matchers * * assertThat(x, !(matcher)); // Negate a matcher * * assertThat(x, allOf(isLessThan(42), isGreaterThan(10), is(23))); // All must be true * * assertThat(23, anyOf(isLessThan(42), isGreaterThan(10))); // One or more must be true * * # Example * * ## Writing A Unit Test * * A unit test of a simple "counter" class might look like: * * #include "unittest.h" * #include "myCounter.h" * * UnitTest (testConstructor) * { * MyClass x (23); * assertThat (x.getValue(), is(23)); * assertThat (x.isZero(), is(true)); * assertTrue (x.isZero()); // older style * } * * UnitTestTimed (testIncrement, 100L) // Limited to 100ms * { * MyClass x (23); * x.increment(); * assertThat (x.getValue(), is(24)); * x.increment(); * assertThat (x.getValue(), is(25)); * } * * UnitTestTimed (longTest, -1L) // No timer: will never time out * { * MyClass x (23); * for (int i = 0; i < 10000; ++i) * x.increment(); * assertThat (x.getValue(), is(10023)); * } * * * ## Running Your Tests * * The unittest.cpp includes a main() function to drive the tests. When * run with no command-line parameters, all unit test functions are run. * If command-line parameters are provided, they provide a list of test * function names to indicate which tests to run. Specifically, * any test function whose name contains the command-line parameter * will be run. * * For example, if the above tests are compiled to form an executable * named "`unittest`", then * * ./unittest testIncrement * * or * * ./unittest Incr * * * would run only the second test above, but any of the following * * ./unittest testConstructor testIncrement longTest * ./unittest est * ./unittest * * would run all three tests. */ /** * Time limit, in milliseconds, before a test function is killed * on suspicion of the code under test having gone into an infinite loop. * * Affects all subsequent UniTest(...) declarations, but is ignored by * any UnitTestTimed(...) declarations (because they supply their own * time limit, overriding the default). * * Note that a non-positive value for this time limit suppresses the timing * check entirely. This may be useful as a way of "stopping the clock" * when debugging failed tests. */ #define DEFAULT_UNIT_TEST_TIME_LIMIT 500L /** * Macros - actual tests will invoke one of these */ #define assertThat( obj, matcher ) CppUnitLite::UnitTest::checkTest \ ((matcher).eval(obj), \ std::string(#obj) + " " + std::string(#matcher), __FILE__, __LINE__) #define assertTrue(cond) CppUnitLite::UnitTest::checkTest\ (CppUnitLite::AssertionResult(cond,"",""), #cond, __FILE__, __LINE__) #define assertTruex(cond) CppUnitLite::UnitTest::checkTest\ (cond, #cond, __FILE__, __LINE__) #define assertFalse(cond) CppUnitLite::UnitTest::checkTest\ (CppUnitLite::AssertionResult(!(cond),"",""), std::string("!(") + #cond + ")", __FILE__, __LINE__) #define assertFalsex(cond) CppUnitLite::UnitTest::checkTest\ (!(cond), std::string("!(") + #cond + ")", __FILE__, __LINE__) #define assertEqual( x, y ) assertThat(x, isEqualTo(y)) #define assertEqualx( x, y ) CppUnitLite::UnitTest::checkTest ((x)==(y),\ "assertEqual(" #x "," #y ")", \ __FILE__, __LINE__) #define assertNotEqual( x , y ) assertThat(x, isNotEqualTo(y)) #define assertNotEqualx( x , y ) assertFalse ((x)==(y)) #define assertNull(x) assertTrue ((x)==nullptr) #define assertNotNull(x) assertTrue ((x)!=nullptr) #define succeed CppUnitLite::UnitTest::checkTest (\ CppUnitLite::AssertionResult(true,"",""),\ "succeed", __FILE__, __LINE__) #define fail CppUnitLite::UnitTest::checkTest (\ CppUnitLite::AssertionResult(false,"",""), "fail",\ __FILE__, __LINE__) /** * Test registration */ #define UnitTest(functName) UnitTestTimed(functName, DEFAULT_UNIT_TEST_TIME_LIMIT) #define UnitTestTimed(functName, limit) void functName(); int functName ## dummy = \ CppUnitLite::UnitTest::registerUT(#functName, limit, &functName); void functName() namespace CppUnitLite { template <typename T> struct has_begin { private: template <typename U, class = decltype( std::declval<U&>().begin() ) > static std::true_type try_begin(U&&); static std::false_type try_begin(...); public: using type = decltype( try_begin( std::declval<T>())); static constexpr bool value = type(); }; template <typename T> struct can_be_written { private: template <typename U, class = decltype( std::declval<std::ostringstream&>() << std::declval<U&>()) > static std::true_type try_output(U&&); static std::false_type try_output(...); public: using type = decltype( try_output( std::declval<T>())); static constexpr bool value = type(); }; template <typename T, typename U> std::string getStringRepr(const std::pair<T,U>& t); template <typename T> std::string getStringRepr(T t); template<typename T, typename std::enable_if<can_be_written<T>::value, int>::type = 0> std::string getStringRepr2(T const& t) { std::ostringstream out; out << t; return out.str(); } template<typename T, typename std::enable_if<!can_be_written<T>::value && has_begin<T>::value, int>::type = 0> std::string getStringRepr2(T t) { static const unsigned ContainerDisplayLimit = 10; auto n = std::distance(t.begin(), t.end()); auto pos = t.begin(); unsigned count = 0; std::string result = "["; while (pos != t.end() && n > 0) { result += getStringRepr(*pos); if (n > 1) result += ", "; --n; ++pos; ++count; if (count >= ContainerDisplayLimit && n > 0) { result += "..."; break; } } if (n > 0) { result += "... (" + getStringRepr(n) + " additional elements) ..."; } result += "]"; return result; } template<typename T, typename std::enable_if<!can_be_written<T>::value && !has_begin<T>::value, int>::type = 0> std::string getStringRepr2(T t) { return "???"; } template <typename T, typename U> std::string getStringRepr(const std::pair<T,U>& t) { return std::string("<") + getStringRepr(t.first) + ", " + getStringRepr(t.second) + ">"; } template <typename Tuple, std::size_t size, std::size_t remaining> struct getTupleRepr { static std::string getContentRepr(Tuple t) { std::string separator = (remaining > 1)? std::string(", ") : std::string(); return getStringRepr(std::get<size-remaining>(t)) + separator + getTupleRepr<Tuple,size, remaining-1>::getContentRepr(t); } }; template <typename Tuple, std::size_t size> struct getTupleRepr<Tuple, size, 0> { static std::string getContentRepr(Tuple t) { return ""; } }; template <typename Tuple> std::string getTupleStringRepr(Tuple t) { return std::string("<") + getTupleRepr<Tuple, std::tuple_size<Tuple>::value, std::tuple_size<Tuple>::value>::getContentRepr(t) + ">"; } template <typename... T> std::string getStringRepr(const std::tuple<T...>& t) { return getTupleStringRepr(t); } template <typename T> std::string getStringRepr(T t) { return getStringRepr2(t); } template <> std::string getStringRepr(std::string t); template <> std::string getStringRepr(const char t[]); template <> std::string getStringRepr(char t); template <> std::string getStringRepr(bool b); class AssertionResult { public: bool result; ///> True iff assertion passed std::string passExplanation; ///> Optional explanation for passing; std::string failExplanation; ///> Optional explanation for failure; AssertionResult (bool theResult, std::string passExplain, std::string failExplain); }; /** * Main support class for unit test execution. */ class UnitTest { private: static long numSuccesses; static long numFailures; static long numErrors; static std::string currentTest; static std::vector<std::string> failedTests; static std::vector<std::string> callLog; public: /** * Change to false to print diagnostics after the ok/not ok result. */ static bool diagnosticMessagesBeforeResults; typedef void (*TestFunction)(); /** * Exception thrown to indicate a failed assertion. */ class UnitTestFailure: public std::exception { std::string explanation; public: UnitTestFailure (const char* conditionStr, const char* fileName, int lineNumber); UnitTestFailure (const std::string& conditionStr, const char* fileName, int lineNumber); virtual const char* what() const noexcept; }; /** * The main test function - normally called via one of the macros * declared following this class. Does nothing if the assertion * was passed, but throws an exception if the assertion was failed. * * @param result the assertion condition, "" if passed, otherwise * contains an explanation for the failure. * @param conditionStr a string rendering of the assertion condition. * @param fileName Source code file in which the assertion occurs, * @param lineNumber Source code line number at which the assertion occurs, * @throws UnitTestFailure if condition is false. */ static void checkTest (AssertionResult result, std::string conditionStr, const char* fileName, int lineNumber); /** * The main test function - normally called via one of the macros * declared following this class. Does nothing if the assertion * was passed, but throws an exception if the assertion was failed. * * @param condition the assertion condition, true iff passed. * @param conditionStr a string rendering of the assertion condition. * @param fileName Source code file in which the assertion occurs, * @param lineNumber Source code line number at which the assertion occurs, * @throws UnitTestFailure if condition is false. */ // static void checkTest (bool condition, const std::string& conditionStr, // const char* fileName, int lineNumber); // Summary info about tests conducted so far /** * How many tests have been run? * * @return number of tests. */ static long getNumTests() {return numSuccesses + numFailures;} /** * How many tests were terminated by a failed assertion? * * @return number of failed tests. */ static long getNumFailures() {return numFailures;} /** * How many tests were terminated by an unexpected exception, * run-time error, or time-out? * * @return number of uncompleted tests. */ static long getNumErrors() {return numErrors;} /** * How many tests terminated successfully? * * @return number of passed tests. */ static long getNumSuccesses() {return numSuccesses;} /** * Run all units tests whose name contains testNames[i], * for all i in 0..nTests-1. * * Special case: If nTests == 0, runs all unit Tests. * * @param nTests number of test name substrings * @param testNames array of possible substrings of test names * @param programName path to program executable */ static void runTests (int nTests, char** testNames, char* programName); /** * Print a simple summary report. Includes number of tests passed, * failed, and erroneously termnated. * */ static void report (); /** * Register a new UnitTest, making it eligible for running. * * @param functName name of the test function. * @param timeLimit time limit in milliseconds * @param funct the unit test function */ static int registerUT (std::string functName, int timeLimit, TestFunction funct); /** * Reverses the expectation for the current test. A test that fails or halts * with an error will be reported and counted as OK. If that test succeeds, * it will be reported and counted as an error. * * Must be called before any assertions. */ static void expectedToFail(); /* ******************************************************** * The call log is intended as an aid in writing stubs. * ********************************************************/ typedef std::vector<std::string>::const_iterator const_iterator; typedef std::vector<std::string>::const_iterator iterator; /** * Clear the call log. */ static void clearCallLog(); /** * Position of oldest logged call. */ static iterator begin(); /** * Position just after the most recently logged call. */ static iterator end(); /** * Log a call to a zero-parameter function. * * @param functionName name of the function */ static void logCall (const std::string& functionName); /** * Log a call to a function with one parameter. * * Parameter types must support operator<< * * @param functionName name of the function * @param arg1 a parameter to the function call */ template <typename T1> static void logCall (const std::string& functionName, const T1& arg1) { logCall (functionName + "\t" + getStringRepr(arg1)); } /** * Log a call to a function with two parameters. * * Parameter types must support operator<< * * @param functionName name of the function * @param arg1 a parameter to the function call * @param arg2 a parameter to the function call */ template <typename T1, typename T2> static void logCall (const std::string& functionName, const T1& arg1, const T2& arg2) { logCall (functionName + "\t" + getStringRepr(arg1) + "\t" + getStringRepr(arg2)); } /** * Log a call to a function with three parameters. * * Parameter types must support operator<< * * @param functionName name of the function * @param arg1 a parameter to the function call * @param arg2 a parameter to the function call * @param arg3 a parameter to the function call */ template <typename T1, typename T2, typename T3> static void logCall (const std::string& functionName, const T1& arg1, const T2& arg2, const T3& arg3) { logCall (functionName + "\t" + getStringRepr(arg1) + "\t" + getStringRepr(arg2) + "\t" + getStringRepr(arg3)); } /** * Log a call to a function with four parameters. * * Parameter types must support operator<< * * @param functionName name of the function * @param arg1 a parameter to the function call * @param arg2 a parameter to the function call * @param arg3 a parameter to the function call * @param arg4 a parameter to the function call */ template <typename T1, typename T2, typename T3, typename T4> static void logCall (const std::string& functionName, const T1& arg1, const T2& arg2, const T3& arg3, const T4& arg4) { logCall (functionName + "\t" + getStringRepr(arg1) + "\t" + getStringRepr(arg2) + "\t" + getStringRepr(arg3) + "\t" + getStringRepr(arg4)); } // These should be private, but I wanted to unit test them. static std::string msgComment (const std::string& commentary); static std::string msgFailed (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS); static bool debuggerIsRunning(); private: /** * Internal container for test functions and their associated time limits. */ struct BoundedTest { int timeLimit; TestFunction unitTest; BoundedTest(): timeLimit(0), unitTest(0) {} BoundedTest (int time, TestFunction f): timeLimit(time), unitTest(f) {} }; static std::map<std::string, BoundedTest> *tests; static bool expectToFail; static void runTest(unsigned testNumber, std::string testName, TestFunction u, long timeLimitInMS); static void runTestUntimed(unsigned testNumber, std::string testName, TestFunction u); static int runTestGuarded(unsigned testNumber, std::string testName, TestFunction u, std::string& msg); static std::string extractLocation (const std::string& msg); static void msgRunning (unsigned testNumber, std::string testName); static void msgPassed (unsigned testNumber, std::string testName, unsigned timeMS); static void msgXPassed (unsigned testNumber, std::string testName, unsigned timeMS); //static std::string msgFailed (unsigned testNumber, std::string testName, unsigned timeMS); //static std::string msgComment (const std::string& commentary); static void msgXFailed (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS); static void msgError (unsigned testNumber, std::string testName, std::string diagnostics, unsigned timeMS); static void msgSummary (); static void msg (const std::string& detailMessage); }; inline void expectedToFail() { UnitTest::expectedToFail(); } // Compile-time test for associative containers inline constexpr auto container_has_keytype_impl(...) -> std::false_type { return std::false_type{}; } template <typename C, typename = typename C::key_type> constexpr auto container_has_keytype_impl(C const*) -> std::true_type { return std::true_type{}; } template <typename C> constexpr auto container_has_keytype(C const& c) -> decltype(container_has_keytype_impl(&c)) { return container_has_keytype_impl(&c); } template <typename Container, typename Element> long find_in_container_impl (const Container& c, const Element& e, std::false_type) { long ctr = 0L; for (auto it = c.begin(); it != c.end(); ++it) { if (e == *it) return ctr; ++ctr; } return -1L; } template <typename Container, typename Element> long find_in_container_impl (const Container& c, const Element& e, std::true_type) { auto pos = c.find(e); if (c.find(e) != c.end()) return (long)distance(c.begin(), pos); else return -1L; } template <typename Container, typename Element> long find_in_container (const Container& c, const Element& e) { return find_in_container_impl (c, e, container_has_keytype(c)); } //// Relational Matchers template <typename T> class EqualToMatcher { const T right; public: EqualToMatcher (const T& t) : right(t) {} /** * Evaluate the condition denoted by this matcher. */ AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); std::string explain = "Expected: " + rightStr + "\n\tObserved: " + leftStr; return AssertionResult(left == right, "Both values were: " + getStringRepr(left), explain ); } }; template <typename T, typename U> class ApproximatelyEqualToMatcher { const T right; const U delta; public: ApproximatelyEqualToMatcher (const T& t, const U& d): right(t), delta(d) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightPlusStr = CppUnitLite::getStringRepr(right+delta); std::string rightMinusStr = CppUnitLite::getStringRepr(right-delta); std::string passExplain = leftStr + " is between " + rightMinusStr + " and " + rightPlusStr; if (left < right - delta || left > right + delta) return AssertionResult(false, passExplain, leftStr + " is outside the range " + getStringRepr(right-delta) + " .. " + getStringRepr(right+delta)); else return AssertionResult(true, passExplain, ""); } }; template <typename T> class NotEqualToMatcher { const T right; public: NotEqualToMatcher (const T& t): right(t) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); std::string explain = "Expected: " + rightStr + "\n\tObserved: " + leftStr; return AssertionResult(!(left == right), explain, "Both values were: " + getStringRepr(left) ); } }; template <typename T> class LessThanMatcher { const T right; public: LessThanMatcher (const T& t): right(t) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); return AssertionResult(left < right, leftStr + " is less than " + rightStr, leftStr + " is not less than " + rightStr ); } }; template <typename T> class GreaterThanMatcher { const T right; public: GreaterThanMatcher (const T& t): right(t) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); return AssertionResult(right < left, leftStr + " is greater than " + rightStr, leftStr + " is not greater than " + rightStr ); } }; template <typename T> class LessThanOrEqualToMatcher { const T right; public: LessThanOrEqualToMatcher (const T& t): right(t) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); return AssertionResult(!(right < left), leftStr + " is less than or equal to " + rightStr, leftStr + " is greater than " + rightStr ); } }; template <typename T> class GreaterThanOrEqualToMatcher { const T right; public: GreaterThanOrEqualToMatcher (const T& t): right(t) {} AssertionResult eval(const T& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); return AssertionResult(!(left < right), leftStr + " is greater than or equal to " + rightStr, leftStr + " is less than " + rightStr ); } }; //// String Matchers class StringContainsMatcher { const std::string right; public: StringContainsMatcher (const std::string& t); AssertionResult eval(const std::string& e) const; }; class StringEndsWithMatcher { const std::string right; public: StringEndsWithMatcher (const std::string& t); AssertionResult eval(const std::string& e) const; }; class StringBeginsWithMatcher { const std::string right; public: StringBeginsWithMatcher (const std::string& t); AssertionResult eval(const std::string& e) const; }; // Pointer Matchers class NullMatcher { public: AssertionResult eval(const void* p) const; }; class NotNullMatcher { public: AssertionResult eval(const void* p) const; }; //// Container Matchers template <typename Element> class ContainsMatcher { Element right; public: ContainsMatcher (Element e) : right(e) {} template <typename Container> AssertionResult eval(const Container& c) const { std::string containerStr = CppUnitLite::getStringRepr(c); std::string rightStr = CppUnitLite::getStringRepr(right); long pos = find_in_container(c, right); return AssertionResult(pos >= 0, "Found " + rightStr + " in position " + getStringRepr(pos) + " of " + containerStr, "Could not find " + rightStr + " in " + containerStr ); } }; template <typename Key, typename Data> class HasEntryMatcher { Key key; Data data; public: HasEntryMatcher (const Key& k, const Data& d) : key(k), data(d) {} template <typename Container> AssertionResult eval(const Container& c) const { std::string containerStr = CppUnitLite::getStringRepr(c); std::string keyStr = CppUnitLite::getStringRepr(key); auto pos = c.find(key); if (pos != c.end()) { return AssertionResult(data == pos->second, "Found " + getStringRepr(*pos) + " in " + containerStr, "Could not find <" + keyStr + ", " + getStringRepr(data) + "> in " + containerStr ); } else return AssertionResult(pos != c.end(), "Found " + getStringRepr(*pos) + " in " + containerStr, "Could not find " + keyStr + " in " + containerStr ); } }; template <typename Iterator> class IteratorRange { Iterator start; Iterator stop; public: typedef Iterator iterator; typedef Iterator const_iterator; IteratorRange (Iterator b, Iterator e): start(b), stop(e) {} Iterator begin() const { return start; } Iterator end() const { return stop; } }; template <typename... Ts> class HasItemsMatcher { using Element = typename std::common_type<Ts...>::type; typename std::vector<Element> right; public: HasItemsMatcher (Ts... ts): right({ts...}) { } template <typename Container> AssertionResult eval (const Container& c) const { std::string cStr = getStringRepr(c); std::string foundAll = "Found all of " + getStringRepr(right) + " in " + cStr; for (const Element& e: right) { if (find_in_container(c, e) < 0L) { std::string explain = "Did not find " + getStringRepr(e) + " in " + cStr; return AssertionResult(false, foundAll, explain); } } return AssertionResult(true, foundAll, foundAll); } }; template <typename Iterator1> class MatchesMatcher { const IteratorRange<Iterator1> range1; public: MatchesMatcher (IteratorRange<Iterator1> r1) : range1(r1) {} template <typename Iterator2> AssertionResult eval(IteratorRange<Iterator2> range2) const { auto d1 = std::distance(range1.begin(), range1.end()); auto d2 = std::distance(range2.begin(), range2.end()); if (d1 == d2) { Iterator1 pos1 = range1.begin(); Iterator2 pos2 = range2.begin(); while (pos1 != range1.end()) { if (!(*pos1 == *pos2)) { return AssertionResult (false, "", "In position " + getStringRepr(std::distance(range1.begin(), pos1)) + ", " + getStringRepr(*pos1) + " != " + getStringRepr(*pos2) ); } ++pos1; ++pos2; } return AssertionResult (true, "All corresponding elements were equal.",""); } else return AssertionResult(false, "", "Ranges are of different length (" + getStringRepr(d1) + " and " + getStringRepr(d2) + ")"); } }; template <typename Container> class IsInMatcher { const Container& container; public: IsInMatcher (const Container& c) : container(c) {} template <typename Element> AssertionResult eval(const Element& e) const { std::string cStr = getStringRepr(container); std::string eStr = getStringRepr(e); long pos = find_in_container(container, e); return AssertionResult(pos >= 0L, "Found " + eStr + " in postion " + getStringRepr(pos) + " of " + cStr, "Could not find " + eStr + " in " + cStr); } }; template <typename Iterator> class IsInRangeMatcher { Iterator start; Iterator stop; public: IsInRangeMatcher (Iterator b, Iterator e) : start(b), stop(e) {} template <typename Element> AssertionResult eval(const Element& e) const { std::string eStr = getStringRepr(e); auto pos = find(start, stop, e); return AssertionResult (pos != stop, "Found " + eStr + " in range, " + getStringRepr(distance(start,pos)) + " steps from the start", "Could not find " + eStr + " in the range"); } }; //// Boolean Matchers template <typename T> class NotMatcher { T right; public: NotMatcher (const T& t): right(t) {} template <typename U> AssertionResult eval(const U& u) const { AssertionResult r = right.eval(u); return AssertionResult(!(r.result), r.failExplanation, r.passExplanation); } }; template <typename... Rest> class AllOfMatcher { public: AllOfMatcher (Rest... matchers) { } template <typename T> AssertionResult eval (const T& t) const { return AssertionResult(true, "", ""); } }; template <typename Matcher, typename... Rest> class AllOfMatcher<Matcher, Rest...> { Matcher matcher; AllOfMatcher<Rest...> rest; public: AllOfMatcher (Matcher m, Rest... matchers): matcher(m), rest(matchers...) { } template <typename T> AssertionResult eval (const T& t) const { AssertionResult result1 = matcher.eval(t); if (result1.result) return rest.eval(t); else return AssertionResult(false, "All of the conditions were true", result1.failExplanation); } }; template <typename... Rest> class AnyOfMatcher { public: AnyOfMatcher (Rest... matchers) { } template <typename T> AssertionResult eval (const T& t) const { return AssertionResult(false, "", ""); } }; template <typename Matcher, typename... Rest> class AnyOfMatcher<Matcher, Rest...> { Matcher matcher; AnyOfMatcher<Rest...> rest; public: AnyOfMatcher (Matcher m, Rest... matchers): matcher(m), rest(matchers...) { } template <typename T> AssertionResult eval (const T& t) const { AssertionResult result1 = matcher.eval(t); if (!result1.result) return rest.eval(t); else return AssertionResult(true, result1.passExplanation, "None of the conditions were true"); } }; template <typename... T> class OneOfMatcher { using Element = typename std::common_type<T...>::type; typename std::vector<Element> right; public: OneOfMatcher (T... t): right({std::forward<T>(t)...}) { } AssertionResult eval (const Element& left) const { std::string leftStr = CppUnitLite::getStringRepr(left); std::string rightStr = CppUnitLite::getStringRepr(right); std::string foundMessage = "Found " + leftStr + " in " + rightStr; std::string notFoundMessage = "Could not find " + leftStr + " in " + rightStr; for (const Element& e: right) { if (left == e) return AssertionResult(true, foundMessage, notFoundMessage); } return AssertionResult(false, foundMessage, notFoundMessage); } }; } //// Matchers /// Relational Matchers inline CppUnitLite::EqualToMatcher<std::string> isEqualTo(const char* t) { return CppUnitLite::EqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::EqualToMatcher<T> isEqualTo(const T& t) { return CppUnitLite::EqualToMatcher<T>(t); } inline CppUnitLite::EqualToMatcher<std::string> is(const char* t) { return CppUnitLite::EqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::EqualToMatcher<T> is(const T& t) { return CppUnitLite::EqualToMatcher<T>(t); } template <typename T, typename U> CppUnitLite::ApproximatelyEqualToMatcher<T,U> isApproximately(const T& t, const U& delta) { return CppUnitLite::ApproximatelyEqualToMatcher<T,U>(t, delta); } inline CppUnitLite::NotEqualToMatcher<std::string> isNotEqualTo(const char* t) { return CppUnitLite::NotEqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::NotEqualToMatcher<T> isNotEqualTo(const T& t) { return CppUnitLite::NotEqualToMatcher<T>(t); } inline CppUnitLite::NotEqualToMatcher<std::string> isNot(const char* t) { return CppUnitLite::NotEqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::NotEqualToMatcher<T> isNot(const T& t) { return CppUnitLite::NotEqualToMatcher<T>(t); } inline CppUnitLite::LessThanMatcher<std::string> \ isLessThan(const char* t) { return CppUnitLite::LessThanMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::LessThanMatcher<T> isLessThan(const T& t) { return CppUnitLite::LessThanMatcher<T>(t); } inline CppUnitLite::GreaterThanMatcher<std::string> isGreaterThan(const char* t) { return CppUnitLite::GreaterThanMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::GreaterThanMatcher<T> isGreaterThan(const T& t) { return CppUnitLite::GreaterThanMatcher<T>(t); } inline CppUnitLite::LessThanOrEqualToMatcher<std::string> isLessThanOrEqualTo(const char* t) { return CppUnitLite::LessThanOrEqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::LessThanOrEqualToMatcher<T> isLessThanOrEqualTo(const T& t) { return CppUnitLite::LessThanOrEqualToMatcher<T>(t); } inline CppUnitLite::GreaterThanOrEqualToMatcher<std::string> isGreaterThanOrEqualTo(const char* t) { return CppUnitLite::GreaterThanOrEqualToMatcher<std::string>(std::string(t)); } template <typename T> CppUnitLite::GreaterThanOrEqualToMatcher<T> isGreaterThanOrEqualTo(const T& t) { return CppUnitLite::GreaterThanOrEqualToMatcher<T>(t); } /// String matchers CppUnitLite::StringContainsMatcher contains(const char* t); CppUnitLite::StringContainsMatcher contains(const std::string& t); CppUnitLite::StringEndsWithMatcher endsWith(const char* t); CppUnitLite::StringEndsWithMatcher endsWith(const std::string& t); CppUnitLite::StringBeginsWithMatcher beginsWith(const char* t); CppUnitLite::StringBeginsWithMatcher beginsWith(const std::string& t); CppUnitLite::StringBeginsWithMatcher startsWith(const char* t); CppUnitLite::StringBeginsWithMatcher startsWith(const std::string& t); /// Pointer matchers CppUnitLite::NullMatcher isNull(); CppUnitLite::NotNullMatcher isNotNull(); /// Container matchers template <typename T> CppUnitLite::ContainsMatcher<T> hasItem(const T& e) { return CppUnitLite::ContainsMatcher<T>(e); } template <typename T> CppUnitLite::ContainsMatcher<T> contains(const T& e) { return CppUnitLite::ContainsMatcher<T>(e); } template <typename T> CppUnitLite::ContainsMatcher<T> hasKey(const T& e) { return CppUnitLite::ContainsMatcher<T>(e); } template <typename Key, typename Data> CppUnitLite::HasEntryMatcher<Key, Data> hasEntry(const Key& k, const Data& d) { return CppUnitLite::HasEntryMatcher<Key, Data>(k, d); } template <typename Element> CppUnitLite::IteratorRange<const Element*> arrayOfLength (const Element* start, int n) { return CppUnitLite::IteratorRange<const Element*>(start, start+n); } template <typename Iterator> CppUnitLite::IteratorRange<Iterator> range (Iterator start, Iterator stop) { return CppUnitLite::IteratorRange<Iterator>(start, stop); } template <typename... Ts> CppUnitLite::HasItemsMatcher<Ts...> hasItems (Ts... t) { return CppUnitLite::HasItemsMatcher<Ts...>(t...); } template <typename T> CppUnitLite::MatchesMatcher<T> matches (CppUnitLite::IteratorRange<T> range) { return CppUnitLite::MatchesMatcher<T>(range); } /// Associative container (set & map) matchers template <typename... Ts> CppUnitLite::HasItemsMatcher<Ts...> hasKeys (Ts... t) { return CppUnitLite::HasItemsMatcher<Ts...>(t...); } template <typename Container> CppUnitLite::IsInMatcher<Container> isIn(const Container& c) { return CppUnitLite::IsInMatcher<Container>(c); } template <typename Iterator> CppUnitLite::IsInRangeMatcher<Iterator> isInRange(Iterator b, Iterator e) { return CppUnitLite::IsInRangeMatcher<Iterator>(b, e); } /// Combining matchers template <typename T> CppUnitLite::NotMatcher<T> operator!(const T& t) { return CppUnitLite::NotMatcher<T>(t); } template <typename... Ts> CppUnitLite::AllOfMatcher<Ts...> allOf(Ts... ts) { return CppUnitLite::AllOfMatcher<Ts...>(ts...); } template <typename... Ts> CppUnitLite::AnyOfMatcher<Ts...> anyOf(Ts... ts) { return CppUnitLite::AnyOfMatcher<Ts...>(ts...); } template <typename... T> CppUnitLite::OneOfMatcher<T...> isOneOf (T... t) { return CppUnitLite::OneOfMatcher<T...>(t...); } #endif

researchplan.h

#ifndef RESEARCHPLAN_H #define RESEARCHPLAN_H #include <iostream> #include <string> #include "topic.h" using namespace std; /** * A ResearchPlan describes the prior requirements for researching * a research topic. It consists of a topic to be researched and a list of * research requirements, prior topics that must have been successfully * completed before research on this one can begin. */ class ResearchPlan { //** You may not change the declarations in this private: area. Topic researchTopic; ///< The topic to be researched int numberOfRequirements; ///< How many requirements for this topic? int maxRequirements; ///< How many requirements will fit into the array? Topic * requirements; ///< Pointer to an array of requirements. public: /** * Create a new plan for a default topic (Topic()) and having no * known prerequisites; */ ResearchPlan(); /** * Create a new plan for researching a given topic and having no * known prerequisites; * * @param topic the topic to be researched */ ResearchPlan (const Topic& topic); ResearchPlan (const ResearchPlan& plan); ~ResearchPlan(); const ResearchPlan& operator= (const ResearchPlan& c); /** * @return the topic to be researched */ const Topic& getTopic() const {return researchTopic;} Topic& getTopic() {return researchTopic;} /** * @return the number of known requirements for this plan. */ int getNumberOfRequirements() const; /** * Adds topic to the list of requirements for this plan. * If this topic is already in the list, this has no effect. * * @param topic a required prior topic */ void addRequirement(const Topic& topic); /** * Removes a topic from the list of requirements for this plan. * If this topic is not already required, this has no effect. * * @param topic a prior required topic */ void removeRequirement(const Topic& topic); /** * Get the name of the i_th requirement. * * @precondition 0 <= i && i < getNumberofRequirements() * @param i index of the requirement to retrieve * @return a topic whose name indicates a required prior research topic. * The cost info in the returned topic is not necessarily accurate. */ Topic getRequirement(int i) const; /** * Compare two plans for equality. */ bool operator== (const ResearchPlan& right) const; /** * Compare two plans for ordering. */ bool operator< (const ResearchPlan& right) const; private: friend std::ostream& operator<< (std::ostream& out, const ResearchPlan& plan); }; std::ostream& operator<< (std::ostream& out, const ResearchPlan& plan); #endif

researchplan.cpp

#include "researchplan.h" #include <cassert> #include <iostream> #include <string> #include <utility> using namespace std; ResearchPlan::ResearchPlan() : researchTopic(), numberOfRequirements(0), maxRequirements(0), requirements(nullptr) { } ResearchPlan::ResearchPlan (const Topic& topic) : researchTopic(topic), numberOfRequirements(0), maxRequirements(10), requirements(new Topic[maxRequirements]) { } int ResearchPlan::getNumberOfRequirements() const { return numberOfRequirements; } void ResearchPlan::addRequirement(const Topic& topic) { for (int i = 0; i < numberOfRequirements; ++i) if (requirements[i] == topic) return; assert (numberOfRequirements < maxRequirements); requirements[numberOfRequirements] = topic; ++numberOfRequirements; } void ResearchPlan::removeRequirement(const Topic& topic) { for (int i = 0; i < numberOfRequirements; ++i) if (requirements[i] == topic) { for (int j = i+1; j < numberOfRequirements; ++j) requirements[j-1] = requirements[j]; --numberOfRequirements; break; } } Topic ResearchPlan::getRequirement(int i) const { assert (i >= 0 && i < numberOfRequirements); return requirements[i]; } bool ResearchPlan::operator== (const ResearchPlan& right) const { using namespace std::rel_ops; if (researchTopic != right.researchTopic) return false; if (numberOfRequirements != right.numberOfRequirements) return false; for (int i = 0; i < numberOfRequirements; ++i) if (requirements[i] != right.requirements[i]) return false; return true; } bool ResearchPlan::operator< (const ResearchPlan& right) const { using namespace std::rel_ops; if (researchTopic != right.researchTopic) return researchTopic < right.researchTopic; if (numberOfRequirements != right.numberOfRequirements) return numberOfRequirements < right.numberOfRequirements; for (int i = 0; i < numberOfRequirements; ++i) if (requirements[i] != right.requirements[i]) return requirements[i] < right.requirements[i]; return false; } ResearchPlan::ResearchPlan (const ResearchPlan& plan) : researchTopic(plan.researchTopic), numberOfRequirements(plan.numberOfRequirements), maxRequirements(plan.maxRequirements) { requirements = new Topic[maxRequirements]; for (int i = 0; i < numberOfRequirements; ++i) requirements[i] = plan.requirements[i]; } ResearchPlan::~ResearchPlan() { delete [] requirements; } const ResearchPlan& ResearchPlan::operator= (const ResearchPlan& plan) { if (&plan != this) { researchTopic = plan.researchTopic; numberOfRequirements = plan.numberOfRequirements; maxRequirements = plan.maxRequirements; delete [] requirements; requirements = new Topic[maxRequirements]; for (int i = 0; i < numberOfRequirements; ++i) requirements[i] = plan.requirements[i]; } return *this; }

researchplan.d

researchplan.o: researchplan.cpp researchplan.h topic.h memoryChecked.h