diff --git a/CMakeLists.txt b/CMakeLists.txt index ec98368..6782518 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,12 +11,12 @@ if(hasParent) set (STF_BASE ${STF_BASE} PARENT_SCOPE) endif() -include (${STF_BASE}/cmake/stf-config.cmake) - # Boost find_package (Boost 1.49.0) include_directories (SYSTEM ${Boost_INCLUDE_DIRS}) +include (${STF_BASE}/cmake/stf-config.cmake) + add_subdirectory(lib) if(BUILD_STF_PYTHON_LIB) diff --git a/README.md b/README.md index 57ff473..c7bd45f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # STF Library -The acronym STF stands for Simulation Tracing Format. This is intended to be used +The acronym STF stands for Simulation Trace Format. This is intended to be used with Sparta-based simulators, but that's not necessary. + +You can view the STF specification at [stf_spec](https://github.com/sparcians/stf_spec). + This repo contains the following: -1. The STF definition 1. Trace generators (writers) 1. Trace consumers (readers) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index e031393..caa511b 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1,4 +1,4 @@ -# Doxyfile 1.8.15 +# Doxyfile 1.9.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,6 +12,16 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -32,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "stf_lib" +PROJECT_NAME = stf_lib # 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 @@ -60,16 +70,28 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc_doxygen/ -# 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 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 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 causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode @@ -81,26 +103,18 @@ ALLOW_UNICODE_NAMES = 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. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - # If the BRIEF_MEMBER_DESC tag is set to YES, 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. @@ -197,6 +211,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + # 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 Qt-style will behave just like regular Qt-style comments (thus @@ -217,6 +241,14 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. @@ -240,25 +272,19 @@ TAB_SIZE = 4 # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "sideeffect=@par Side Effects:^^" # 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 (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) 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 @@ -299,19 +325,22 @@ OPTIMIZE_OUTPUT_SLICE = NO # 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, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files), VHDL, tcl. 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. +# default for Fortran type files). 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: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = @@ -329,11 +358,22 @@ MARKDOWN_SUPPORT = YES # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. +# Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + # 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 putting a % sign in front of the word or @@ -445,6 +485,27 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -465,6 +526,12 @@ EXTRACT_ALL = NO EXTRACT_PRIVATE = NO +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. @@ -502,6 +569,13 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation @@ -513,14 +587,15 @@ 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, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. 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, these declarations will be -# included in the documentation. +# declarations. If set to NO, these declarations will be included in the +# documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO @@ -539,12 +614,20 @@ HIDE_IN_BODY_DOCS = NO 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. -# The default value is: system dependent. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = YES @@ -562,6 +645,12 @@ HIDE_SCOPE_NAMES = NO HIDE_COMPOUND_REFERENCE= NO +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -719,7 +808,8 @@ FILE_VERSION_FILTER = # 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. +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE @@ -765,24 +855,50 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag 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. +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + # This 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, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC # The default value is: NO. WARN_NO_PARAMDOC = NO +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. WARN_AS_ERROR = NO @@ -793,13 +909,27 @@ WARN_AS_ERROR = NO # 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) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # 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 standard -# error (stderr). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). WARN_LOGFILE = @@ -813,17 +943,30 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/stf-inc/ @CMAKE_CURRENT_SOURCE_DIR@/lib/ @CMAKE_CURRENT_SOURCE_DIR@/docs +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/stf-inc/ \ + @CMAKE_CURRENT_SOURCE_DIR@/lib/ \ + @CMAKE_CURRENT_SOURCE_DIR@/docs # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: https://www.gnu.org/software/libiconv/) for the list of -# possible encodings. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. @@ -832,11 +975,15 @@ INPUT_ENCODING = UTF-8 # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -919,10 +1066,7 @@ EXCLUDE_PATTERNS = # (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 -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* +# ANamespace::AClass, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -967,6 +1111,11 @@ IMAGE_PATH = # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. @@ -1008,6 +1157,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -1105,17 +1263,11 @@ VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -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 a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1194,7 +1346,12 @@ HTML_STYLESHEET = # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1209,9 +1366,22 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # 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 +# this color. Hue is specified as an angle on a color-wheel, see # https://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. @@ -1221,7 +1391,7 @@ HTML_EXTRA_FILES = 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 +# in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1239,20 +1409,11 @@ HTML_COLORSTYLE_SAT = 100 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 YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will +# are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, +# page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1267,6 +1428,13 @@ HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + # 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 @@ -1282,10 +1450,11 @@ 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 (see: https://developer.apple.com/xcode/), 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 +# environment (see: +# https://developer.apple.com/xcode/), 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 https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. @@ -1302,6 +1471,13 @@ GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL of the docset 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. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # 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. @@ -1327,8 +1503,12 @@ DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML @@ -1358,7 +1538,7 @@ CHM_FILE = HHC_LOCATION = # 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). +# (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1385,6 +1565,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # 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 @@ -1403,7 +1593,8 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1411,8 +1602,8 @@ 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 Qt Help Project / Virtual -# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- -# folders). +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1420,30 +1611,30 @@ QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# 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. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = @@ -1486,16 +1677,28 @@ DISABLE_INDEX = NO # 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # @@ -1520,6 +1723,24 @@ TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML @@ -1529,19 +1750,14 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT 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 directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. -FORMULA_TRANSPARENT = YES +FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered 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 @@ -1551,11 +1767,29 @@ FORMULA_TRANSPARENT = YES USE_MATHJAX = NO +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + # When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1568,22 +1802,29 @@ MATHJAX_FORMAT = HTML-CSS # 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 https://www.mathjax.org before deployment. -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1611,7 +1852,7 @@ MATHJAX_CODEFILE = 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 +# implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching 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 @@ -1630,7 +1871,8 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1643,8 +1885,9 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). See the section "External Indexing and -# Searching" for details. +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = @@ -1715,10 +1958,11 @@ LATEX_CMD_NAME = MAKEINDEX_CMD_NAME = makeindex # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to -# generate index for LaTeX. +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. # Note: This tag is used in the generated output file (.tex). # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. -# The default value is: \makeindex. +# The default value is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_MAKEINDEX_CMD = \makeindex @@ -1752,29 +1996,31 @@ PAPER_TYPE = a4 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. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. +# The LATEX_HEADER tag can be used to specify a user-defined 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. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empty -# string, for the replacement values of the other commands the user is referred -# to HTML_HEADER. +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. 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. See +# The LATEX_FOOTER tag can be used to specify a user-defined 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. See # LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = @@ -1807,18 +2053,26 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES, to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. 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. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1831,16 +2085,6 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag 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. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -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. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. @@ -1849,14 +2093,6 @@ LATEX_SOURCE_CODE = NO LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# 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. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -1921,16 +2157,6 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_SOURCE_CODE = NO - #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -2027,27 +2253,44 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- + +# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 +# database with symbols found by doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be +# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put +# in front of it. +# The default directory is: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each doxygen run. If set to NO, doxygen +# will warn if an a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- @@ -2122,10 +2365,11 @@ 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. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = +INCLUDE_PATH = @Boost_INCLUDE_DIRS@ # 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 @@ -2143,7 +2387,9 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = __attribute__(x)= +PREDEFINED = DOXYGEN \ + __attribute__(x)= \ + REGISTER_RECORD(x)= # 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 @@ -2152,7 +2398,29 @@ PREDEFINED = __attribute__(x)= # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = STF_ENUM \ + STF_ENUM_CONFIG \ + STF_ENUM_VAL \ + STF_ENUM_STR \ + STF_ENUM_ALIAS \ + STF_IS_TUPLE \ + _STF_ENUM_CONFIG \ + _STF_ENUM_NO_CONFIG \ + BOOST_PP_IIF \ + BOOST_PP_IIF_OO \ + BOOST_PP_IIF_I \ + BOOST_PP_IIF_II \ + BOOST_PP_IIF_1 \ + BOOST_PP_OVERLOAD \ + BOOST_PP_IS_BEGIN_PARENS \ + BOOST_PP_DETAIL_IBP_SPLIT \ + BOOST_PP_DETAIL_IBP_CAT \ + BOOST_PP_DETAIL_IBP_IS_VARIADIC_R_ \ + BOOST_PP_DETAIL_IBP_IS_VARIADIC_C \ + BOOST_PP_DETAIL_IBP_PRIMITIVE_CAT \ + BOOST_PP_DETAIL_IBP_SPLIT_0 \ + BOOST_PP_DETAIL_IBP_IS_VARIADIC_R_1 \ + BOOST_PP_VARIADIC_TO_TUPLE # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have @@ -2162,7 +2430,7 @@ EXPAND_AS_DEFINED = # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -SKIP_FUNCTION_MACROS = YES +SKIP_FUNCTION_MACROS = NO #--------------------------------------------------------------------------- # Configuration options related to external references @@ -2189,15 +2457,15 @@ TAGFILES = GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. 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 +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. @@ -2211,25 +2479,9 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML 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. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_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. # The default value is: YES. @@ -2238,10 +2490,10 @@ 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 (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), 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 value is: NO. +# The default value is: YES. HAVE_DOT = NO @@ -2255,49 +2507,73 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates 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. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification 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. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is 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. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH tag is 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. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2320,10 +2596,32 @@ UML_LOOK = NO # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2335,7 +2633,9 @@ TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2344,7 +2644,10 @@ INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2384,21 +2687,32 @@ GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH tag is 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. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). +# https://www.graphviz.org/)). # Note: 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). -# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# Possible values are: png, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, +# gif, gif:cairo, gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, +# png:cairo, png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and # png:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2430,11 +2744,12 @@ DOT_PATH = 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). +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile @@ -2443,10 +2758,10 @@ MSCFILE_DIRS = DIAFILE_DIRS = # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = @@ -2484,18 +2799,6 @@ DOT_GRAPH_MAX_NODES = 50 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). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to 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 @@ -2508,14 +2811,34 @@ DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# 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 = diff --git a/docs/STF_Specification.pdf b/docs/STF_Specification.pdf deleted file mode 100644 index da0868b..0000000 Binary files a/docs/STF_Specification.pdf and /dev/null differ diff --git a/lib/stf_inst.cpp b/lib/stf_inst.cpp index 20bee6d..0e48b05 100644 --- a/lib/stf_inst.cpp +++ b/lib/stf_inst.cpp @@ -14,6 +14,9 @@ namespace stf { std::ostream& operator<<(std::ostream& os, const MemAccess& access) { + static constexpr size_t ATTR_TO_VA_PADDING = 7; + static constexpr size_t VA_TO_DATA_PADDING = 5; + if (format_utils::showPhys()) { format_utils::formatSpaces(os, format_utils::PA_WIDTH + 1); } @@ -21,15 +24,26 @@ namespace stf { format_utils::formatLeft(os, access.getType(), format_utils::MEM_ACCESS_FIELD_WIDTH); format_utils::formatSpaces(os, 1); format_utils::formatHex(os, access.getAttr()); - format_utils::formatSpaces(os, 7); + format_utils::formatSpaces(os, ATTR_TO_VA_PADDING); format_utils::formatVA(os, access.getAddress()); if (format_utils::showPhys()) { os << ':'; format_utils::formatPA(os, access.getPhysAddress()); } - format_utils::formatSpaces(os, 5); - format_utils::formatData(os, access.getData()); + format_utils::formatSpaces(os, VA_TO_DATA_PADDING); + + const size_t num_data_spaces = (format_utils::showPhys() ? format_utils::PA_WIDTH + 1 : 0) + + format_utils::OPERAND_LABEL_WIDTH + + format_utils::MEM_ACCESS_FIELD_WIDTH + + 1 + // single space + 4 + // attr + ATTR_TO_VA_PADDING + + format_utils::VA_WIDTH + + (format_utils::showPhys() ? format_utils::PA_WIDTH + 1 : 0) + + VA_TO_DATA_PADDING; + + access.formatContent(os, num_data_spaces); return os; } diff --git a/stf-inc/protocols/channel_protocol.hpp b/stf-inc/protocols/channel_protocol.hpp index 94a69c4..41b26e6 100644 --- a/stf-inc/protocols/channel_protocol.hpp +++ b/stf-inc/protocols/channel_protocol.hpp @@ -174,6 +174,10 @@ namespace stf { */ template struct ChannelProtocol { + /** + * \class Channel + * Base Channel class that can be constructed from an STF + */ class Channel : public STFObject { public: /** @@ -221,17 +225,26 @@ namespace stf { } public: + /** + * Constructs a FieldChannel from an STFIFstream + */ explicit FieldChannel(STFIFstream& reader) : fields_(Fields(reader)...) { } + /** + * Constructs a FieldChannel by specifying individual field values + */ template explicit FieldChannel(const FieldArgs&... args) : fields_(args...) { } + /** + * Move-constructs a FieldChannel by specifying individual field values + */ template explicit FieldChannel(FieldArgs&&... args) : fields_(std::forward(args)...) diff --git a/stf-inc/stf_descriptor.hpp b/stf-inc/stf_descriptor.hpp index 767957e..4781827 100644 --- a/stf-inc/stf_descriptor.hpp +++ b/stf-inc/stf_descriptor.hpp @@ -1,3 +1,8 @@ +/** + * \file + * \brief This file defines the descriptor values for each STF record type + */ + #ifndef __STF_DESCRIPTOR_HPP__ #define __STF_DESCRIPTOR_HPP__ @@ -133,8 +138,10 @@ namespace stf { using ArrayType = enums::EnumArray; /**< Array that maps FromDescriptor values to ToDescriptor values */ +#ifndef DOXYGEN #define _INIT_DESC_ARRAY_ENTRY(r, data, elem) \ case FromDescriptor::elem: newarr[i] = ToDescriptor::elem; continue; +#endif /** * \def INIT_DESC_ARRAY @@ -463,6 +470,9 @@ namespace stf { } // end namespace iterators namespace encoded { + /** + * Formats an encoded Descriptor to an std::ostream + */ inline std::ostream& operator<<(std::ostream& os, const Descriptor desc) { return os << conversion::toInternal(desc); } diff --git a/stf-inc/stf_enum_utils.hpp b/stf-inc/stf_enum_utils.hpp index 84ddd4d..8e495fe 100644 --- a/stf-inc/stf_enum_utils.hpp +++ b/stf-inc/stf_enum_utils.hpp @@ -86,20 +86,32 @@ * STF_ENUM_VAL(name, val, str, enable_print) * Defines an STF_ENUM entry with the given name, value, string representation, and print-enable setting. */ +#ifdef DOXYGEN +#define STF_ENUM_VAL(name, val, ...) name = val +#else #define STF_ENUM_VAL(name, ...) BOOST_PP_OVERLOAD(_STF_ENUM_VAL_, __VA_ARGS__)(name, __VA_ARGS__) +#endif /** * \def STF_ENUM_ALIAS * Defines an STF_ENUM entry as an alias of another entry */ +#ifdef DOXYGEN +#define STF_ENUM_ALIAS name = other_name +#else #define STF_ENUM_ALIAS(name, other_name) STF_ENUM_VAL(name, other_name, BOOST_PP_NIL, STF_ENUM_NO_PRINT) +#endif /** * \def STF_ENUM_STR * Defines an STF_ENUM entry with the given name and string representation. Value is auto-generated and * print-enable is set to 1. */ +#ifdef DOXYGEN +#define STF_ENUM_STR(name, str) name +#else #define STF_ENUM_STR(name, str) (name, str) +#endif // Defines an STF_ENUM entry tuple from a name only. Allows users to use bare names in an STF_ENUM just as // they would with a normal enum class. String representation and value are auto-generated and print-enable @@ -343,6 +355,9 @@ // STF_ENUM_VAL/STF_ENUM_STR/STF_ENUM_ALIAS directives. The config is converted from an STF_ENUM_CONFIG // tuple to a tuple of binary flags with _FLATTEN_STF_ENUM_CONFIG before passing everything to // __STF_ENUM_CONFIG +#ifdef DOXYGEN +#define _STF_ENUM_CONFIG(config, name, type, ...) _STF_ENUM_NO_CONFIG(name, type, __VA_ARGS__) +#else #define _STF_ENUM_CONFIG(config, name, type, ...) \ __STF_ENUM_CONFIG( \ _FLATTEN_STF_ENUM_CONFIG(config), \ @@ -350,10 +365,17 @@ type, \ __VA_ARGS__ \ ) +#endif // Defines an STF_ENUM with the given name and underlying type. // The __VA_ARGS__ are the enum elements, which can be either bare names or tuples generated with // STF_ENUM_VAL/STF_ENUM_STR/STF_ENUM_ALIAS directives. Uses a default config where all flags are disabled. +#ifdef DOXYGEN +#define _STF_ENUM_NO_CONFIG(name, type, ...) \ + enum class name : type { \ + __VA_ARGS__ \ + } +#else #define _STF_ENUM_NO_CONFIG(name, type, ...) \ __STF_ENUM_CONFIG( \ _DEFAULT_STF_CONFIG, \ @@ -361,6 +383,7 @@ type, \ __VA_ARGS__ \ ) +#endif /** * \def STF_ENUM diff --git a/stf-inc/stf_enums.hpp b/stf-inc/stf_enums.hpp index 4b07b87..7b752bf 100644 --- a/stf-inc/stf_enums.hpp +++ b/stf-inc/stf_enums.hpp @@ -29,36 +29,15 @@ namespace stf { * */ STF_ENUM( - STF_ENUM_CONFIG(OVERRIDE_START, OVERRIDE_END), + STF_ENUM_CONFIG(OVERRIDE_START, OVERRIDE_END, AUTO_PRINT), INST_IEM, uint16_t, - STF_INST_IEM_INVALID, /**< Invalid */ - STF_ENUM_VAL(STF_INST_IEM_RV32, 1), - STF_ENUM_VAL(STF_INST_IEM_RV64, 2), - STF_ENUM_VAL(STF_INST_IEM_RESERVED, 0xFFFF) + STF_ENUM_STR(STF_INST_IEM_INVALID, "INVALID"), /**< Invalid */ + STF_ENUM_VAL(STF_INST_IEM_RV32, 1, "RV32"), + STF_ENUM_VAL(STF_INST_IEM_RV64, 2, "RV64"), + STF_ENUM_VAL(STF_INST_IEM_RESERVED, 0xFFFF, "RESERVED") ); - inline std::ostream& operator<<(std::ostream& os, const INST_IEM iem) - { - switch(iem) - { - case INST_IEM::STF_INST_IEM_INVALID: - os << "INVALID"; - break; - case INST_IEM::STF_INST_IEM_RV32: - os << "RV32"; - break; - case INST_IEM::STF_INST_IEM_RV64: - os << "RV64"; - break; - case INST_IEM::STF_INST_IEM_RESERVED: - os << "RESERVED"; - break; - } - - return os; - } - /** * \enum BUS_MASTER * diff --git a/stf-inc/stf_exception.hpp b/stf-inc/stf_exception.hpp index 2cb207b..6f6bf89 100644 --- a/stf-inc/stf_exception.hpp +++ b/stf-inc/stf_exception.hpp @@ -115,7 +115,14 @@ namespace stf reason_(std::move(reason)) { } + /** + * \brief Copy constructor + */ STFException(const STFException&) = default; + + /** + * \brief Move constructor + */ STFException(STFException&&) = default; /// Destroy! diff --git a/stf-inc/stf_inst.hpp b/stf-inc/stf_inst.hpp index 8d50f4f..5e089e3 100644 --- a/stf-inc/stf_inst.hpp +++ b/stf-inc/stf_inst.hpp @@ -42,19 +42,198 @@ namespace stf { * */ class MemAccess { + public: + /** + * \class ContentVector + * \brief Holds a vector of const InstMemContentRecord*, but iterators dereference to const InstMemContentRecord& + */ + class ContentVector { + private: + using VectorType = boost::container::small_vector; + VectorType data_; + + public: + /** + * \class iterator + * \brief Iterator that dereferences to a const InstMemContentRecord& + */ + class iterator : public VectorType::const_iterator { + public: + iterator() = default; + + /** + * Constructs an iterator from a boost::container::small_vector iterator + */ + iterator(const VectorType::const_iterator& rhs) : + VectorType::const_iterator(rhs) + { + } + + /** + * Move-constructs an iterator from a boost::container::small_vector iterator + */ + iterator(VectorType::const_iterator&& rhs) : + VectorType::const_iterator(std::move(rhs)) + { + } + + /** + * Dereferences the iterator + */ + const InstMemContentRecord& operator*() const { + return *VectorType::const_iterator::operator*(); + } + + /** + * Dereferences the iterator + */ + const InstMemContentRecord* operator->() const { + return VectorType::const_iterator::operator*(); + } + }; + + /** + * Default constructor + */ + ContentVector() = default; + + /** + * Constructs a ContentVector from a single InstMemContentRecord + */ + explicit ContentVector(const InstMemContentRecord* data) : + data_(1, data) + { + } + + /** + * Appends a new InstMemContentRecord + */ + void emplace_back(const InstMemContentRecord* record) { + data_.emplace_back(record); + } + + /** + * Appends a new STFRecord that points to an InstMemContentRecord + */ + void emplace_back(const STFRecord* record) { + emplace_back(static_cast(record)); + } + + /** + * Gets an iterator to the beginning of the memory content records + */ + iterator begin() const { + return data_.begin(); + } + + /** + * Gets an iterator to the end of the memory content records + */ + iterator end() const { + return data_.end(); + } + + /** + * Clears the vector + */ + void clear() { + data_.clear(); + } + }; + + /** + * \class ContentValueView + * \brief Provides a view of a ContentVector whose iterators dereference to the value + * returned by InstMemContentRecord::getData + */ + class ContentValueView { + public: + /** + * \class iterator + * \brief Dereferences to the data contained by an InstMemContentRecord + */ + class iterator : public ContentVector::iterator { + public: + iterator() = default; + + /** + * Constructs an iterator from a ContentVector::iterator + */ + iterator(const ContentVector::iterator& rhs) : + ContentVector::iterator(rhs) + { + } + + /** + * Move-constructs an iterator from a ContentVector::iterator + */ + iterator(ContentVector::iterator&& rhs) : + ContentVector::iterator(std::move(rhs)) + { + } + + /** + * Dereferences the iterator + */ + uint64_t operator*() const { + return ContentVector::iterator::operator*().getData(); + } + }; + + private: + const iterator begin_; + const iterator end_; + + public: + /** + * Constructs a ContentValueView + * \param data ContentVector that provides the underlying values + */ + ContentValueView(const ContentVector& data) : + begin_(data.begin()), + end_(data.end()) + { + } + + /** + * Gets an iterator to the beginning of the sequence + */ + const iterator& begin() const { + return begin_; + } + + /** + * Gets an iterator to the end of the sequence + */ + const iterator& end() const { + return end_; + } + }; + private: const STFInst* inst_; const InstMemAccessRecord* access_ = nullptr; - const InstMemContentRecord* data_ = nullptr; + ContentVector data_; public: + /** + * Constructs a MemAccess + * \param inst Parent STFInst object + * \param access_record Pointer to underlying InstMemAccessRecord + */ + MemAccess(const STFInst* inst, const STFRecord* const access_record) : + inst_(inst), + access_(static_cast(access_record)) + { + } + /** * Constructs a MemAccess * \param inst Parent STFInst object * \param access_record Pointer to underlying InstMemAccessRecord * \param content_record Pointer to underlying InstMemContentRecord */ - MemAccess(const STFInst* inst, const STFRecord* const access_record, const STFRecord* const content_record = nullptr) : + MemAccess(const STFInst* inst, const STFRecord* const access_record, const STFRecord* const content_record) : inst_(inst), access_(static_cast(access_record)), data_(static_cast(content_record)) @@ -65,8 +244,8 @@ namespace stf { * Sets the content for the memory access * \param record Pointer to underlying InstMemContentRecord */ - inline void setContent(const STFRecord* const record) { - data_ = static_cast(record); + inline void appendContent(const STFRecord* const record) { + data_.emplace_back(static_cast(record)); } /** @@ -74,7 +253,7 @@ namespace stf { */ inline void reset() { access_ = nullptr; - data_ = nullptr; + data_.clear(); } /** @@ -100,7 +279,7 @@ namespace stf { /** * Gets data of access */ - inline uint64_t getData() const { return getContentRecord().getData(); } + inline ContentValueView getData() const { return data_; } /** * Gets type of access @@ -120,9 +299,56 @@ namespace stf { /** * Gets underlying content record */ - inline const InstMemContentRecord& getContentRecord() const { - stf_assert(data_, "MemAccess has invalid content record"); - return *data_; + inline const ContentVector& getContentRecords() const { + return data_; + } + + /** + * Formats the contents of a memory access to an std::ostream + * \tparam single_line If true, prints the contents on a single line + * \tparam prefix_0x If true, prefixes values with 0x. Defaults to false. + * \param os std::ostream to use for output + * \param sep If not nullptr, use the specified string to separate the values + */ + template + void formatContent(std::ostream& os, const char* sep = nullptr) const { + static constexpr size_t default_indent = single_line ? 1 : 0; + formatContent(os, default_indent, sep); + } + + /** + * Formats the contents of a memory access to an std::ostream + * \tparam single_line If true, prints the contents on a single line + * \tparam prefix_0x If true, prefixes values with 0x. Defaults to false. + * \param os std::ostream to use for output + * \param indent Indent values by the specified number of spaces + * \param sep If not nullptr, use the specified string to separate the values + */ + template + void formatContent(std::ostream& os, const size_t indent, const char* sep = nullptr) const { + bool first = true; + + for(const auto val: getData()) { + if(STF_EXPECT_FALSE(first)) { + first = false; + } + else { + if constexpr(!single_line) { + os << std::endl; + } + + format_utils::formatSpaces(os, indent); + + if(sep) { + os << sep; + } + } + + if constexpr(prefix_0x) { + os << "0x"; + } + format_utils::formatData(os, val); + } } /** @@ -869,6 +1095,8 @@ namespace stf { * from the trace */ + MemAccess* last_mem_access_ = nullptr; /**< Pointer to the last MemAccess object added to this instruction */ + /** * Writes a record type, paired with a second record type */ @@ -928,6 +1156,16 @@ namespace stf { return mem_access_records_[idx]; } + /** + * \brief Appends a new MemAccess + * \param type Memory access type + * \param access_record Memory access record + */ + inline void appendMemAccess_(const INST_MEM_ACCESS type, + const STFRecord* const access_record) { + last_mem_access_ = &getMemAccessVector_(type).emplace_back(this, access_record); + } + /** * \brief Appends a new MemAccess * \param type Memory access type @@ -937,7 +1175,16 @@ namespace stf { inline void appendMemAccess_(const INST_MEM_ACCESS type, const STFRecord* const access_record, const STFRecord* const content_record) { - getMemAccessVector_(type).emplace_back(this, access_record, content_record); + last_mem_access_ = &getMemAccessVector_(type).emplace_back(this, access_record, content_record); + } + + /** + * \brief Appends another content record to the last MemAccess + * \param content_record Memory content record + */ + inline void appendMemContent_(const STFRecord* const content_record) { + stf_assert(last_mem_access_, "Attempted to attach a memory content record without an accompanying access record"); + last_mem_access_->appendContent(content_record); } /** @@ -1630,6 +1877,19 @@ namespace stf { */ class STFInstDelegate : public STFSkippableItemDelegate { private: + /** + * Appends a memory access + * \param inst STFInst to modify + * \param type Type of memory access + * \param access_record Memory access record + */ + __attribute__((always_inline)) + static inline void appendMemAccess_(STFInst& inst, + const INST_MEM_ACCESS type, + const STFRecord* const access_record) { + inst.appendMemAccess_(type, access_record); + } + /** * Appends a memory access * \param inst STFInst to modify @@ -1645,6 +1905,17 @@ namespace stf { inst.appendMemAccess_(type, access_record, content_record); } + /** + * Appends additional content to the last memory access record + * \param inst STFInst to modify + * \param content_record Memory content record + */ + __attribute__((always_inline)) + static inline void appendMemContent_(STFInst& inst, + const STFRecord* const content_record) { + inst.appendMemContent_(content_record); + } + /** * Sets an instruction flag * \param inst STFInst to modify @@ -1727,9 +1998,13 @@ namespace stf { } /** - * Appends a record to the instruction's record map + * Finalizes an instruction * \param inst STFInst to modify - * \param urec Record to append + * \param rec Record containing instruction's opcode + * \param hw_thread_id HW thread ID + * \param pid Process ID + * \param tid Thread ID + * \param is_skipped If true, instruction should be skipped */ template __attribute__((always_inline)) @@ -1758,6 +2033,7 @@ namespace stf { inst.hw_thread_id_ = hw_thread_id; inst.pid_ = pid; inst.tid_ = tid; + inst.last_mem_access_ = nullptr; } /** diff --git a/stf-inc/stf_inst_reader.hpp b/stf-inc/stf_inst_reader.hpp index 2606c71..bd8ca21 100644 --- a/stf-inc/stf_inst_reader.hpp +++ b/stf-inc/stf_inst_reader.hpp @@ -144,8 +144,6 @@ namespace stf { } const auto desc = rec->getId(); - stf_assert(desc != IntDescriptor::STF_INST_MEM_CONTENT, - "Saw MemContentRecord without accompanying MemAccessRecord"); // These are the most common records - moving them outside of the switch statement // eliminates a hard to predict indirect branch and improves performance @@ -163,18 +161,13 @@ namespace stf { break; } else if(STF_EXPECT_TRUE(desc == IntDescriptor::STF_INST_MEM_ACCESS)) { - // Assume in the trace, INST_MEM_CONTENT always appears right - // after INST_MEM_ACCESS of the same memory access - const auto content_rec = readRecord_(inst); - if(STF_EXPECT_TRUE(content_rec != nullptr)) { - stf_assert(content_rec->getId() == IntDescriptor::STF_INST_MEM_CONTENT, - "Invalid trace: memory access must be followed by memory content"); - - const auto access_type = rec->template as().getType(); - delegates::STFInstDelegate::setFlag_(inst, MEM_ACCESS_FLAGS[enums::to_int(access_type)]); - - delegates::STFInstDelegate::appendMemAccess_(inst, access_type, rec, content_rec); - } + const auto access_type = rec->template as().getType(); + delegates::STFInstDelegate::setFlag_(inst, MEM_ACCESS_FLAGS[enums::to_int(access_type)]); + + delegates::STFInstDelegate::appendMemAccess_(inst, access_type, rec); + } + else if(STF_EXPECT_TRUE(desc == IntDescriptor::STF_INST_MEM_CONTENT)) { + delegates::STFInstDelegate::appendMemContent_(inst, rec); } // These are the least common records else { diff --git a/stf-inc/stf_object.hpp b/stf-inc/stf_object.hpp index 6062063..da854f7 100644 --- a/stf-inc/stf_object.hpp +++ b/stf-inc/stf_object.hpp @@ -208,7 +208,13 @@ namespace stf { */ virtual void pack(STFOFstream& writer) const = 0; STFBaseObject() = default; + /** + * Copy constructor + */ STFBaseObject(const STFBaseObject&) = default; + /** + * Move constructor + */ STFBaseObject(STFBaseObject&&) = default; virtual inline ~STFBaseObject() = default; }; diff --git a/stf-inc/stf_protocol_fields.hpp b/stf-inc/stf_protocol_fields.hpp index 80afbbd..2124755 100644 --- a/stf-inc/stf_protocol_fields.hpp +++ b/stf-inc/stf_protocol_fields.hpp @@ -316,18 +316,33 @@ namespace stf { ProtocolFieldFormatter Formatter = defaultProtocolFieldFormatter> class ProtocolField { public: + /** + * \typedef ReferenceType + * Reference type + */ using ReferenceType = type_utils::optimal_const_ref_t; + + /** + * \typedef ReturnType + * Return type of getValue() method + */ using ReturnType = type_utils::optimal_return_ref_t; protected: friend class STFIFstream; - DataType data_ {}; + DataType data_ {}; /**< The data stored in this field */ + /** + * Gets the field name + */ inline const char* getName_() const { return static_cast(this)->getName(); } + /** + * Gets the data + */ DataType& getData_() { return data_; } @@ -335,26 +350,41 @@ namespace stf { public: ProtocolField() = default; + /** + * Constructs a ProtocolField from an STFIFstream + */ explicit ProtocolField(STFIFstream& reader) { reader >> data_; } + /** + * Constructs a ProtocolField from a data value + */ explicit ProtocolField(const DataType& data) : data_(data) { } + /** + * Move-constructs a ProtocolField from a data value + */ template explicit ProtocolField(DataType&& data) : data_(std::move(data)) { } + /** + * Constructs an empty ProtocolField + */ explicit ProtocolField(const type_utils::none_t&) : ProtocolField() { } + /** + * Move-constructs an empty ProtocolField + */ explicit ProtocolField(type_utils::none_t&&) : ProtocolField() { @@ -416,36 +446,57 @@ namespace stf { ProtocolVectorField() = default; + /** + * Constructs a ProtocolVectorField from an STFIFstream + */ explicit ProtocolVectorField(STFIFstream& reader) : ParentType(reader) { } + /** + * Constructs a ProtocolVectorField from a single data value + */ explicit ProtocolVectorField(ReferenceType data) : ParentType(data) { } + /** + * Move-constructs a ProtocolVectorField from a serializable vector of data values + */ explicit ProtocolVectorField(VectorType&& data) : ParentType(std::forward(data)) { } + /** + * Constructs a ProtocolVectorField from a vector of data values + */ explicit ProtocolVectorField(const std::vector& data) : ParentType(VectorType(data)) { } + /** + * Move-constructs a ProtocolVectorField from a vector of data values + */ explicit ProtocolVectorField(std::vector&& data) : ParentType(VectorType(std::forward>(data))) { } + /** + * Constructs an empty ProtocolVectorField + */ explicit ProtocolVectorField(const type_utils::none_t&) : ParentType(type_utils::none) { } + /** + * Move-constructs an empty ProtocolVectorField + */ explicit ProtocolVectorField(type_utils::none_t&&) : ParentType(type_utils::none) { diff --git a/stf-inc/stf_reader_base.hpp b/stf-inc/stf_reader_base.hpp index abca75f..facaa6f 100644 --- a/stf-inc/stf_reader_base.hpp +++ b/stf-inc/stf_reader_base.hpp @@ -37,7 +37,7 @@ namespace stf { protected: STFRecord::ConstHandle version_; /**< Version record */ std::vector> header_comments_; /**< Header commment records */ - std::vector header_comments_str_; /** String type of header comments*/ + std::vector header_comments_str_; /**< String type of header comments*/ std::vector> trace_info_records_; /**< Trace info records */ STFRecord::ConstHandle trace_features_; /**< Trace feature records */ @@ -64,7 +64,13 @@ namespace stf { public: STFReaderBase() = default; ~STFReaderBase(); + /** + * Move constructor + */ STFReaderBase(STFReaderBase&& rhs) = default; + /** + * Move-assignment operator + */ STFReaderBase& operator=(STFReaderBase&& rhs) = default; /** diff --git a/stf-inc/stf_serializable_container.hpp b/stf-inc/stf_serializable_container.hpp index 74ab970..19b044a 100644 --- a/stf-inc/stf_serializable_container.hpp +++ b/stf-inc/stf_serializable_container.hpp @@ -213,6 +213,12 @@ namespace stf { } }; + /** + * \class SerializablePackedBitVector + * + * Type that holds single bit values in single T-type elements, but transparently packs those bits + * together into uint8_t elements when writing the vector to an STF + */ template class SerializablePackedBitVector : public std::vector { private: @@ -224,7 +230,7 @@ namespace stf { SerializablePackedBitVector() = default; /** - * Copy-constructs a SerializableVector from its underlying type + * Copy-constructs a SerializablePackedBitVector from its underlying type */ explicit SerializablePackedBitVector(const std::vector& rhs) : std::vector(rhs) @@ -232,7 +238,7 @@ namespace stf { } /** - * Move-constructs a SerializableVector from its underlying container type + * Move-constructs a SerializablePackedBitVector from its underlying container type */ explicit SerializablePackedBitVector(std::vector&& rhs) : std::vector(std::forward>(rhs)) @@ -241,6 +247,10 @@ namespace stf { using std::vector::operator=; + /** + * Unpacks a SerializablePackedBitVector object from an STFIFstream + * \param reader STFIFstream to use + */ inline void unpack(STFIFstream& reader) { SerializedSizeT new_size; reader >> new_size; @@ -256,7 +266,7 @@ namespace stf { } /** - * Packs a tilelink::MaskedChannel object to an STFOFstream + * Packs a SerializablePackedBitVector object to an STFOFstream * \param writer STFOFstream to use */ inline void pack(STFOFstream& writer) const { diff --git a/stfpy/stfpy/stf_inst.pxd b/stfpy/stfpy/stf_inst.pxd index cb5f261..90bf949 100644 --- a/stfpy/stfpy/stf_inst.pxd +++ b/stfpy/stfpy/stf_inst.pxd @@ -102,6 +102,26 @@ cdef class OperandVector: new_vec.c_vec = &vec return new_vec +cdef class MemAccessContentValueViewIterator: + cdef _MemAccess.ContentValueView.iterator c_it + cdef _MemAccess.ContentValueView.iterator c_end_it + + @staticmethod + cdef inline MemAccessContentValueViewIterator _construct(const _MemAccess.ContentValueView* view): + it = MemAccessContentValueViewIterator() + it.c_it = dereference(view).begin() + it.c_end_it = dereference(view).end() + return it + +cdef class MemAccessContentValueView: + cdef const _MemAccess.ContentValueView* c_view + + @staticmethod + cdef inline MemAccessContentValueView _construct(const _MemAccess.ContentValueView& view): + new_view = MemAccessContentValueView() + new_view.c_view = &view + return new_view + cdef class MemAccess: cdef const _MemAccess* c_mem diff --git a/stfpy/stfpy/stf_inst.pyx b/stfpy/stfpy/stf_inst.pyx index a42a144..3894eab 100644 --- a/stfpy/stfpy/stf_inst.pyx +++ b/stfpy/stfpy/stf_inst.pyx @@ -134,6 +134,18 @@ cdef class OperandVector: def __bool__(self): return not dereference(self.c_vec).empty() +cdef class MemAccessContentValueViewIterator: + def __next__(self): + if self.c_it == self.c_end_it: + raise StopIteration + value = dereference(self.c_it) + preincrement(self.c_it) + return value + +cdef class MemAccessContentValueView: + def __iter__(self): + return MemAccessContentValueViewIterator._construct(self.c_view) + cdef class MemAccess: def getSize(self): return dereference(self.c_mem).getSize() @@ -142,7 +154,7 @@ cdef class MemAccess: return dereference(self.c_mem).getAddress() def getData(self): - return dereference(self.c_mem).getData() + return MemAccessContentValueView._construct(dereference(self.c_mem).getData()) def getType(self): return INST_MEM_ACCESS(dereference(self.c_mem).getType()) diff --git a/stfpy/stfpy/stf_lib/stf_inst.pxd b/stfpy/stfpy/stf_lib/stf_inst.pxd index 07fce95..55d74a7 100644 --- a/stfpy/stfpy/stf_lib/stf_inst.pxd +++ b/stfpy/stfpy/stf_lib/stf_inst.pxd @@ -16,9 +16,16 @@ ctypedef SerializableVector[uint64_t, uint8_t].const_iterator EventDataVectorIte cdef extern from "stf_inst.hpp" namespace "stf": cdef cppclass MemAccess: + cppclass ContentValueView: + cppclass iterator: + uint64_t operator*() + bint operator==(const iterator&) + iterator& operator++() + iterator begin() + iterator end() uint64_t getSize() uint64_t getAddress() - uint64_t getData() + ContentValueView getData() _INST_MEM_ACCESS getType() uint16_t getAttr() diff --git a/tests/stf_writer_test/CMakeLists.txt b/tests/stf_writer_test/CMakeLists.txt index c132687..902ab2c 100644 --- a/tests/stf_writer_test/CMakeLists.txt +++ b/tests/stf_writer_test/CMakeLists.txt @@ -36,7 +36,7 @@ add_compile_options( -Wno-unused-command-line-argument ) -add_compile_options($<$:-Ofast>) +add_compile_options($<$:-O3> $<$:-ffast-math>) add_link_options($<$:-flto>) set(SOURCES