From 9643f46cc8bab8ab4bea353088a60823bd94fbbc Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Thu, 28 Aug 2008 02:57:12 +0200 Subject: [PATCH 01/30] Scons-Wiki: Improvements until 2008 This code was taken from the Wiki and incorporated into the Lumiera.org build system in August 2008 --- __init__.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/__init__.py b/__init__.py index fd51393e7..630fb9f92 100644 --- a/__init__.py +++ b/__init__.py @@ -116,8 +116,17 @@ def DoxySourceScan(node, env, path): file_patterns = data.get("FILE_PATTERNS", default_file_patterns) exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) + + # + # We're running in the top-level directory, but the doxygen + # configuration file is in the same directory as node; this means + # that relative pathnames in node must be adjusted before they can + # go onto the sources list + conf_dir = os.path.dirname(str(node)) for node in data.get("INPUT", []): + if not os.path.isabs(node): + node = os.path.join(conf_dir, node) if os.path.isfile(node): sources.append(node) elif os.path.isdir(node): @@ -150,7 +159,7 @@ def DoxyEmitter(source, target, env): "HTML": ("YES", "html"), "LATEX": ("YES", "latex"), "RTF": ("NO", "rtf"), - "MAN": ("YES", "man"), + "MAN": ("NO", "man"), "XML": ("NO", "xml"), } @@ -185,13 +194,12 @@ def generate(env): scan_check = DoxySourceScanCheck, ) - doxyfile_builder = env.Builder( - action = env.Action("cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}"), + import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( + action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, - - source_scanner = doxyfile_scanner, ) From bb3755562e8b5607c009d665053aa6ddb46294de Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Fri, 5 Mar 2010 20:58:30 +0000 Subject: [PATCH 02/30] Scons-Wiki: Improvements until 2010 Start a Mercurial repo to track further changes to the DoxygenBuilder This base is taken from http://www.scons.org/wiki/DoxygenBuilder. --- __init__.py | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/__init__.py b/__init__.py index fd51393e7..ff7f34f98 100644 --- a/__init__.py +++ b/__init__.py @@ -60,10 +60,10 @@ def DoxyfileParse(file_contents): key_token = False else: if token == "+=": - if not data.has_key(key): - data[key] = list() + if key not in data: + data[key] = [] elif token == "=": - data[key] = list() + data[key] = [] else: append_data( data, key, new_data, token ) new_data = True @@ -76,7 +76,7 @@ def DoxyfileParse(file_contents): append_data( data, key, new_data, '\\' ) # compress lists of len 1 into single strings - for (k, v) in data.items(): + for k, v in data.items(): if len(v) == 0: data.pop(k) @@ -109,10 +109,7 @@ def DoxySourceScan(node, env, path): data = DoxyfileParse(node.get_contents()) - if data.get("RECURSIVE", "NO") == "YES": - recursive = True - else: - recursive = False + recursive = data.get("RECURSIVE") == "YES" file_patterns = data.get("FILE_PATTERNS", default_file_patterns) exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) @@ -126,8 +123,8 @@ def DoxySourceScan(node, env, path): for f in files: filename = os.path.join(root, f) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + pattern_check = any(fnmatch(filename, y) for y in file_patterns) + exclude_check = any(fnmatch(filename, y) for y in exclude_patterns) if pattern_check and not exclude_check: sources.append(filename) @@ -135,7 +132,7 @@ def DoxySourceScan(node, env, path): for pattern in file_patterns: sources.extend(glob.glob("/".join([node, pattern]))) - sources = map( lambda path: env.File(path), sources ) + sources = [env.File(path) for path in sources] return sources @@ -150,7 +147,7 @@ def DoxyEmitter(source, target, env): "HTML": ("YES", "html"), "LATEX": ("YES", "latex"), "RTF": ("NO", "rtf"), - "MAN": ("YES", "man"), + "MAN": ("NO", "man"), "XML": ("NO", "xml"), } @@ -160,7 +157,7 @@ def DoxyEmitter(source, target, env): out_dir = data.get("OUTPUT_DIRECTORY", ".") # add our output locations - for (k, v) in output_formats.items(): + for k, v in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": targets.append(env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) ) @@ -185,13 +182,12 @@ def generate(env): scan_check = DoxySourceScanCheck, ) - doxyfile_builder = env.Builder( - action = env.Action("cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}"), + import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( + action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, - - source_scanner = doxyfile_scanner, ) From cb8f493718568ca007245231236a8f11f9df8fff Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Fri, 5 Mar 2010 21:28:18 +0000 Subject: [PATCH 03/30] Add Norton's example. See http://scons.tigris.org/ds/viewMessage.do?dsForumId=1272&dsMessageId=954207 --- Sample/SConstruct | 4 + Sample/doxy.cfg | 1242 +++++++++++++++++++++++++++++++++++++++++++++ Sample/test.h | 4 + 3 files changed, 1250 insertions(+) create mode 100644 Sample/SConstruct create mode 100644 Sample/doxy.cfg create mode 100644 Sample/test.h diff --git a/Sample/SConstruct b/Sample/SConstruct new file mode 100644 index 000000000..4623c5ca4 --- /dev/null +++ b/Sample/SConstruct @@ -0,0 +1,4 @@ + +env =Environment(tools=['default', 'doxygen'], toolpath='.') +env.Doxygen('doxy.cfg') + diff --git a/Sample/doxy.cfg b/Sample/doxy.cfg new file mode 100644 index 000000000..436f00e6b --- /dev/null +++ b/Sample/doxy.cfg @@ -0,0 +1,1242 @@ +# Doxyfile 1.4.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = doxytest + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to +# include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = YES + + + + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = test.h + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO + + diff --git a/Sample/test.h b/Sample/test.h new file mode 100644 index 000000000..452086fdd --- /dev/null +++ b/Sample/test.h @@ -0,0 +1,4 @@ +/** + * \file + * Test file. + */ From 3514289a1c0defc303983be9f3098dd69cf177a7 Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Sun, 7 Mar 2010 13:46:01 +0000 Subject: [PATCH 04/30] Add things so that the tests run. --- Sample/site_scons/site_tools/doxygen | 1 + 1 file changed, 1 insertion(+) create mode 120000 Sample/site_scons/site_tools/doxygen diff --git a/Sample/site_scons/site_tools/doxygen b/Sample/site_scons/site_tools/doxygen new file mode 120000 index 000000000..a8a4f8c21 --- /dev/null +++ b/Sample/site_scons/site_tools/doxygen @@ -0,0 +1 @@ +../../.. \ No newline at end of file From b9b02a51a4598356a4ca31049b2830423fa3db3b Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Sun, 7 Mar 2010 13:46:27 +0000 Subject: [PATCH 05/30] Add an ignore list so as to be able to ignore generated files. --- .bzrignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .bzrignore diff --git a/.bzrignore b/.bzrignore new file mode 100644 index 000000000..5b2d46270 --- /dev/null +++ b/.bzrignore @@ -0,0 +1 @@ +.sconsign.dblite From 904f5eec6451bf744b6ff865814bd0607b7a2f30 Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Sun, 7 Mar 2010 16:19:46 +0000 Subject: [PATCH 06/30] Add some notes of analysis as a record of reasoning regarding the choice of merges. --- notes.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 notes.txt diff --git a/notes.txt b/notes.txt new file mode 100644 index 000000000..a3c40dd43 --- /dev/null +++ b/notes.txt @@ -0,0 +1,13 @@ +The original __init__.py is the file posted to http://www.scons.org/wiki/DoxygenBuilder by Matthew Nicolson +2006-03-31. Attached to this wiki page were two other files, both of which are included here: +doxygen_reiners_2007-02-26.py, and doxygen_boehme_2007-07-18.py. Boehme's version seems to include many of +the changes in Reiners but many of Reiners changes are missing from Boehme. It is not clear why Reiner's +changes have been reverted by Boehme. it seems appropriate to merge in Boehme's directly rather than +Reiner's and then Boehme's. + +Robert Smallshire in his email of +http://scons.tigris.org/ds/viewMessage.do?dsForumId=1272&dsMessageId=2383574 supports the move to use +Boehme's version as the next iteration. It may then be that a version he has can be merged in. + +Apart from one change to the builder command line, Norton's version seems to be Boehme's version with all +the TAGFILE stuff removed. From 153dcfb5b22a90c3d9a64081374ad4709bc7cb73 Mon Sep 17 00:00:00 2001 From: Dirk Reiners Date: Mon, 26 Feb 2007 00:00:00 +0100 Subject: [PATCH 07/30] Scons-Wiki: variable substituion and hierarchical doxygen (Reiners) Improvements added by Dirk Reiners: I added two (at least for me ;)) important features of doxygen: variable substituion and hierarchical doxygen files. Variable substituion allows doxygen to reference variables from the scons environment using $(VARNAME). This is very useful for things like version numbers or for only having certain parts (as defined by scons) included in the documentation without having to mess with doxygen files. Hierarchical doxygen files just interpret the @INCLUDE key as an include. I also had trouble with files that started with a key, I fixed that. Note that I'm a python newbie, so there are probably more elegant ways to do some of the things I did. Feel free to change them. Hope it helps. --- __init__.py | 67 ++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 54 insertions(+), 13 deletions(-) diff --git a/__init__.py b/__init__.py index fd51393e7..d3938da6f 100644 --- a/__init__.py +++ b/__init__.py @@ -1,4 +1,8 @@ -# vim: set et sw=3 tw=0 fo=awqorc ft=python: +# SCons Doxygen Bilder +# +# Copyright (C) 2007 Dirk Reiners +# +# based on the version from http://www.scons.org/wiki/DoxygenBuilder?highlight=%28doxygen%29 # # Astxx, the Asterisk C++ API and Utility Library. # Copyright (C) 2005, 2006 Matthew A. Nicholson @@ -21,8 +25,9 @@ import os import os.path import glob from fnmatch import fnmatch +import subprocess -def DoxyfileParse(file_contents): +def DoxyfileParse(file_contents, file_dir, env): """ Parse a Doxygen source file and return a dictionary of all the values. Values will be strings and lists of strings. @@ -30,20 +35,34 @@ def DoxyfileParse(file_contents): data = {} import shlex + lex = shlex.shlex(instream = file_contents, posix = True) - lex.wordchars += "*+./-:" + lex.wordchars += "*+./-:@$()" lex.whitespace = lex.whitespace.replace("\n", "") - lex.escape = "" - + lex.escape = "" + lineno = lex.lineno token = lex.get_token() key = token # the first token should be a key last_token = "" - key_token = False - next_key = False + key_token = True new_data = True - + def append_data(data, key, new_data, token): + if token[:2] == "$(": + try: + token = env[token[2:-1]] + except KeyError: + print "ERROR: Variable %s used in Doxygen file is not in environment!" % token + token = "" + # Convert space-separated list to actual list + token = token.split() + if len(token): + append_data(data, key, new_data, token[0]) + for i in token[1:]: + append_data(data, key, True, i) + return + if new_data or len(data[key]) == 0: data[key].append(token) else: @@ -64,6 +83,13 @@ def DoxyfileParse(file_contents): data[key] = list() elif token == "=": data[key] = list() + elif key == "@INCLUDE": + + filename = token + if not os.path.isabs(filename): + filename = os.path.join(file_dir, filename) + + lex.push_source(open(filename), filename) else: append_data( data, key, new_data, token ) new_data = True @@ -74,6 +100,7 @@ def DoxyfileParse(file_contents): if last_token == '\\' and token != '\n': new_data = False append_data( data, key, new_data, '\\' ) + # compress lists of len 1 into single strings for (k, v) in data.items(): @@ -107,7 +134,9 @@ def DoxySourceScan(node, env, path): sources = [] - data = DoxyfileParse(node.get_contents()) + conf_dir = os.path.dirname(str(node)) + + data = DoxyfileParse(node.get_contents(), conf_dir, env) if data.get("RECURSIVE", "NO") == "YES": recursive = True @@ -118,6 +147,8 @@ def DoxySourceScan(node, env, path): exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) for node in data.get("INPUT", []): + if not os.path.isabs(node): + node = os.path.join(conf_dir, node) if os.path.isfile(node): sources.append(node) elif os.path.isdir(node): @@ -154,7 +185,7 @@ def DoxyEmitter(source, target, env): "XML": ("NO", "xml"), } - data = DoxyfileParse(source[0].get_contents()) + data = DoxyfileParse(source[0].get_contents(), os.path.dirname(str(source[0])), env) targets = [] out_dir = data.get("OUTPUT_DIRECTORY", ".") @@ -162,6 +193,7 @@ def DoxyEmitter(source, target, env): # add our output locations for (k, v) in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": + print os.path.join(out_dir, data.get(k + "_OUTPUT", v[1])) targets.append(env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) ) # don't clobber targets @@ -174,6 +206,17 @@ def DoxyEmitter(source, target, env): return (targets, source) + +def DoxyAction(source, target, env): + """Doxygen action""" + e={} + for k,v in env.Dictionary().iteritems(): + e[k] = str(v) + p = subprocess.Popen("cd %s && %s %s" % + (os.path.dirname(str(source[0])), env["DOXYGEN"], os.path.basename(str(source[0]))), + shell=True, env=e) + sts = os.waitpid(p.pid, 0) + def generate(env): """ Add builders and construction variables for the @@ -186,12 +229,10 @@ def generate(env): ) doxyfile_builder = env.Builder( - action = env.Action("cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}"), + action = DoxyAction, emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, - - source_scanner = doxyfile_scanner, ) From b3ed295388299b79d75d7dbe4f0bc7368ba4bd62 Mon Sep 17 00:00:00 2001 From: Matthew Nicolson Date: Fri, 31 Mar 2006 00:00:00 +0200 Subject: [PATCH 08/30] Scons-Wiki: Doxygen Builder __Remark__: as of 2025, this is the oldest code version that can be documented. The content is taken from an Achive.org snapshot from June 21, 2006 https://web.archive.org/web/20060621095023/http://www.scons.org/wiki/DoxygenBuilder Based on the comments added 2010-03-07 by Russel Winder, this code can be attributed to Matthew Nicolson --- __init__.py | 210 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) create mode 100644 __init__.py diff --git a/__init__.py b/__init__.py new file mode 100644 index 000000000..fd51393e7 --- /dev/null +++ b/__init__.py @@ -0,0 +1,210 @@ +# vim: set et sw=3 tw=0 fo=awqorc ft=python: +# +# Astxx, the Asterisk C++ API and Utility Library. +# Copyright (C) 2005, 2006 Matthew A. Nicholson +# Copyright (C) 2006 Tim Blechmann +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License version 2.1 as published by the Free Software Foundation. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +import os +import os.path +import glob +from fnmatch import fnmatch + +def DoxyfileParse(file_contents): + """ + Parse a Doxygen source file and return a dictionary of all the values. + Values will be strings and lists of strings. + """ + data = {} + + import shlex + lex = shlex.shlex(instream = file_contents, posix = True) + lex.wordchars += "*+./-:" + lex.whitespace = lex.whitespace.replace("\n", "") + lex.escape = "" + + lineno = lex.lineno + token = lex.get_token() + key = token # the first token should be a key + last_token = "" + key_token = False + next_key = False + new_data = True + + def append_data(data, key, new_data, token): + if new_data or len(data[key]) == 0: + data[key].append(token) + else: + data[key][-1] += token + + while token: + if token in ['\n']: + if last_token not in ['\\']: + key_token = True + elif token in ['\\']: + pass + elif key_token: + key = token + key_token = False + else: + if token == "+=": + if not data.has_key(key): + data[key] = list() + elif token == "=": + data[key] = list() + else: + append_data( data, key, new_data, token ) + new_data = True + + last_token = token + token = lex.get_token() + + if last_token == '\\' and token != '\n': + new_data = False + append_data( data, key, new_data, '\\' ) + + # compress lists of len 1 into single strings + for (k, v) in data.items(): + if len(v) == 0: + data.pop(k) + + # items in the following list will be kept as lists and not converted to strings + if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS"]: + continue + + if len(v) == 1: + data[k] = v[0] + + return data + +def DoxySourceScan(node, env, path): + """ + Doxygen Doxyfile source scanner. This should scan the Doxygen file and add + any files used to generate docs to the list of source files. + """ + default_file_patterns = [ + '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', + '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', + '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', + '*.py', + ] + + default_exclude_patterns = [ + '*~', + ] + + sources = [] + + data = DoxyfileParse(node.get_contents()) + + if data.get("RECURSIVE", "NO") == "YES": + recursive = True + else: + recursive = False + + file_patterns = data.get("FILE_PATTERNS", default_file_patterns) + exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) + + for node in data.get("INPUT", []): + if os.path.isfile(node): + sources.append(node) + elif os.path.isdir(node): + if recursive: + for root, dirs, files in os.walk(node): + for f in files: + filename = os.path.join(root, f) + + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob("/".join([node, pattern]))) + + sources = map( lambda path: env.File(path), sources ) + return sources + + +def DoxySourceScanCheck(node, env): + """Check if we should scan this file""" + return os.path.isfile(node.path) + +def DoxyEmitter(source, target, env): + """Doxygen Doxyfile emitter""" + # possible output formats and their default values and output locations + output_formats = { + "HTML": ("YES", "html"), + "LATEX": ("YES", "latex"), + "RTF": ("NO", "rtf"), + "MAN": ("YES", "man"), + "XML": ("NO", "xml"), + } + + data = DoxyfileParse(source[0].get_contents()) + + targets = [] + out_dir = data.get("OUTPUT_DIRECTORY", ".") + + # add our output locations + for (k, v) in output_formats.items(): + if data.get("GENERATE_" + k, v[0]) == "YES": + targets.append(env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) ) + + # don't clobber targets + for node in targets: + env.Precious(node) + + # set up cleaning stuff + for node in targets: + env.Clean(node, node) + + return (targets, source) + +def generate(env): + """ + Add builders and construction variables for the + Doxygen tool. This is currently for Doxygen 1.4.6. + """ + doxyfile_scanner = env.Scanner( + DoxySourceScan, + "DoxySourceScan", + scan_check = DoxySourceScanCheck, + ) + + doxyfile_builder = env.Builder( + action = env.Action("cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}"), + emitter = DoxyEmitter, + target_factory = env.fs.Entry, + single_source = True, + + + source_scanner = doxyfile_scanner, + ) + + env.Append(BUILDERS = { + 'Doxygen': doxyfile_builder, + }) + + env.AppendUnique( + DOXYGEN = 'doxygen', + ) + +def exists(env): + """ + Make sure doxygen exists. + """ + return env.Detect("doxygen") From 30ef78ac307cd2cdf54cba5c0f00a790d5e95066 Mon Sep 17 00:00:00 2001 From: Norton Date: Thu, 20 Dec 2007 00:00:00 +0100 Subject: [PATCH 09/30] Scons-Wiki: generate fake target file in output directory (Norton) --- __init__.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/__init__.py b/__init__.py index fd51393e7..9a3f1a134 100644 --- a/__init__.py +++ b/__init__.py @@ -138,7 +138,6 @@ def DoxySourceScan(node, env, path): sources = map( lambda path: env.File(path), sources ) return sources - def DoxySourceScanCheck(node, env): """Check if we should scan this file""" return os.path.isfile(node.path) @@ -159,6 +158,9 @@ def DoxyEmitter(source, target, env): targets = [] out_dir = data.get("OUTPUT_DIRECTORY", ".") + # generate a fake target file in the output directory + targets.append(env.File( os.path.join(out_dir, 'foobar'))) + # add our output locations for (k, v) in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": @@ -185,13 +187,12 @@ def generate(env): scan_check = DoxySourceScanCheck, ) - doxyfile_builder = env.Builder( - action = env.Action("cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}"), + import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( + action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file} && touch ${TARGET}", emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, - - source_scanner = doxyfile_scanner, ) From 537286fdbc2e58144d3ff4e60377e6dc36937001 Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Sun, 7 Mar 2010 16:32:27 +0000 Subject: [PATCH 10/30] Add an Emacs mode line. --- __init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/__init__.py b/__init__.py index c60d940e1..13a6d435b 100644 --- a/__init__.py +++ b/__init__.py @@ -1,4 +1,5 @@ # vim: set et sw=3 tw=0 fo=awqorc ft=python: +# -*- mode:python; coding:utf-8; -*- # # Astxx, the Asterisk C++ API and Utility Library. # Copyright (C) 2005, 2006 Matthew A. Nicholson From 56cedc74f3dc4406d32eec0206ecc132e61b1000 Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Sun, 7 Mar 2010 16:34:37 +0000 Subject: [PATCH 11/30] Add a copyright acknowledgement for Boehme's contributions. --- __init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/__init__.py b/__init__.py index 13a6d435b..84372ae1b 100644 --- a/__init__.py +++ b/__init__.py @@ -5,6 +5,8 @@ # Copyright (C) 2005, 2006 Matthew A. Nicholson # Copyright (C) 2006 Tim Blechmann # +# Copyright (C) 2007 Christoph Boehme +# # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License version 2.1 as published by the Free Software Foundation. From 495765024c11bbd419317066a7cfd3cab5db5800 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Thu, 19 Jan 2012 23:56:29 +0100 Subject: [PATCH 12/30] Handle dependencies and output file ext overrides - corrected basic dependencies (builds and 'scons -c' seem to work now) - added support for output file EXTENSION override variables (HTML and MAN pages) - TODOs: 1.) targets for MAN output don't work yet, 2.) more testing --- __init__.py | 134 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 87 insertions(+), 47 deletions(-) diff --git a/__init__.py b/__init__.py index 84372ae1b..3c1e1ec60 100644 --- a/__init__.py +++ b/__init__.py @@ -25,6 +25,22 @@ import os.path import glob from fnmatch import fnmatch +# Currently supported output formats and their default +# values and output locations. +# From left to right: +# 1. default setting YES|NO +# 2. default output folder for this format +# 3. name of the (main) output file +# 4. default extension " +# 5. field for overriding the output file extension +output_formats = { + "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), + "LATEX": ("YES", "latex", "refman", ".tex", ""), + "RTF": ("NO", "rtf", "refman", ".rtf", ""), + "MAN": ("YES", "man", "", ".3", "MAN_EXTENSION"), + "XML": ("NO", "xml", "index", ".xml", ""), +} + def DoxyfileParse(file_contents): """ Parse a Doxygen source file and return a dictionary of all the values. @@ -130,25 +146,42 @@ def DoxySourceScan(node, env, path): # go onto the sources list conf_dir = os.path.dirname(str(node)) - for node in data.get("INPUT", []): - if not os.path.isabs(node): - node = os.path.join(conf_dir, node) - if os.path.isfile(node): - sources.append(node) - elif os.path.isdir(node): - if recursive: - for root, dirs, files in os.walk(node): - for f in files: - filename = os.path.join(root, f) + input = data.get("INPUT") + if input: + for node in data.get("INPUT", []): + if not os.path.isabs(node): + node = os.path.join(conf_dir, node) + if os.path.isfile(node): + sources.append(node) + elif os.path.isdir(node): + if recursive: + for root, dirs, files in os.walk(node): + for f in files: + filename = os.path.join(root, f) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) - if pattern_check and not exclude_check: - sources.append(filename) - else: - for pattern in file_patterns: - sources.extend(glob.glob("/".join([node, pattern]))) + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob("/".join([node, pattern]))) + else: + # No INPUT specified, so apply plain patterns only + if recursive: + for root, dirs, files in os.walk('.'): + for f in files: + filename = os.path.join(root, f) + + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob(pattern)) # Add tagfiles to the list of source files: for node in data.get("TAGFILES", []): @@ -158,17 +191,20 @@ def DoxySourceScan(node, env, path): sources.append(file) # Add additional files to the list of source files: - def append_additional_source(option): - file = data.get(option, "") - if file != "": - if not os.path.isabs(file): - file = os.path.join(conf_dir, file) - if os.path.isfile(file): - sources.append(file) + def append_additional_source(option, formats): + for f in formats: + if data.get('GENERATE_'+f, output_formats[f][0]) == "YES": + file = data.get(option, "") + if file != "": + if not os.path.isabs(file): + file = os.path.join(conf_dir, file) + if os.path.isfile(file): + sources.append(file) + break; - append_additional_source("HTML_STYLESHEET") - append_additional_source("HTML_HEADER") - append_additional_source("HTML_FOOTER") + append_additional_source("HTML_STYLESHEET",['HTML']) + append_additional_source("HTML_HEADER",['HTML']) + append_additional_source("HTML_FOOTER",['HTML']) sources = map( lambda path: env.File(path), sources ) return sources @@ -178,17 +214,8 @@ def DoxySourceScanCheck(node, env): """Check if we should scan this file""" return os.path.isfile(node.path) -def DoxyEmitter(source, target, env): +def DoxyEmitter(target, source, env): """Doxygen Doxyfile emitter""" - # possible output formats and their default values and output locations - output_formats = { - "HTML": ("YES", "html"), - "LATEX": ("YES", "latex"), - "RTF": ("NO", "rtf"), - "MAN": ("YES", "man"), - "XML": ("NO", "xml"), - } - data = DoxyfileParse(source[0].get_contents()) targets = [] @@ -200,8 +227,29 @@ def DoxyEmitter(source, target, env): # add our output locations for (k, v) in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": - targets.append(env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) ) - + od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) + # don't clobber target folders + env.Precious(od) + # set up cleaning stuff + env.Clean(od, od) + + # Add target files + if k != "MAN": + # Is an extension override var given? + if v[4]: + fname = v[2]+data.get(v[4]) + else: + fname = v[2]+v[3] + of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) + else: + # Special case: man files + # We have to add a target file docs/man/man3/foo.h.3 + # for each input file foo.h :( + pass + # add the tag file if neccessary: tagfile = data.get("GENERATE_TAGFILE", "") if tagfile != "": @@ -210,14 +258,6 @@ def DoxyEmitter(source, target, env): tagfile = os.path.join(conf_dir, tagfile) targets.append(env.File(tagfile)) - # don't clobber targets - for node in targets: - env.Precious(node) - - # set up cleaning stuff - for node in targets: - env.Clean(node, node) - return (targets, source) def generate(env): From 46cdd8aa0e8639e9303cac22f0e08721d278f587 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Tue, 24 Jan 2012 21:46:04 +0100 Subject: [PATCH 13/30] added support for MAN pages --- __init__.py | 51 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/__init__.py b/__init__.py index 3c1e1ec60..5e91fcc29 100644 --- a/__init__.py +++ b/__init__.py @@ -112,9 +112,9 @@ def DoxyfileParse(file_contents): return data -def DoxySourceScan(node, env, path): +def DoxySourceFiles(node, env): """ - Doxygen Doxyfile source scanner. This should scan the Doxygen file and add + Scan the given node's contents (a Doxygen file) and add any files used to generate docs to the list of source files. """ default_file_patterns = [ @@ -206,9 +206,16 @@ def DoxySourceScan(node, env, path): append_additional_source("HTML_HEADER",['HTML']) append_additional_source("HTML_FOOTER",['HTML']) - sources = map( lambda path: env.File(path), sources ) return sources +def DoxySourceScan(node, env, path): + """ + Doxygen Doxyfile source scanner. This should scan the Doxygen file and add + any files used to generate docs to the list of source files. + """ + filepaths = DoxySourceFiles(node, env) + sources = map( lambda path: env.File(path), filepaths ) + return sources def DoxySourceScanCheck(node, env): """Check if we should scan this file""" @@ -216,18 +223,36 @@ def DoxySourceScanCheck(node, env): def DoxyEmitter(target, source, env): """Doxygen Doxyfile emitter""" + doxy_fpath = str(source[0]) data = DoxyfileParse(source[0].get_contents()) targets = [] out_dir = data.get("OUTPUT_DIRECTORY", ".") if not os.path.isabs(out_dir): - conf_dir = os.path.dirname(str(source[0])) + conf_dir = os.path.dirname(doxy_fpath) out_dir = os.path.join(conf_dir, out_dir) # add our output locations for (k, v) in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": - od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) + # Initialize output file extension for MAN pages + if k == 'MAN': + # Is the given extension valid? + manext = v[3] + if v[4]: + manext = data.get(v[4]) + # Try to strip off dots + manext = manext.replace('.','') + # Can we convert it to an int? + try: + e = int(manext) + except: + # No, so set back to default + manext = "3" + + od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man"+manext)) + else: + od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) # don't clobber target folders env.Precious(od) # set up cleaning stuff @@ -245,10 +270,20 @@ def DoxyEmitter(target, source, env): # don't clean single files, we remove the complete output folders (see above) env.NoClean(of) else: - # Special case: man files + # Special case: MAN pages # We have to add a target file docs/man/man3/foo.h.3 - # for each input file foo.h :( - pass + # for each input file foo.h, so we scan the config file + # a second time... :( + filepaths = DoxySourceFiles(source[0], env) + for f in filepaths: + if os.path.isfile(f) and f != doxy_fpath: + of = env.File( os.path.join(out_dir, + data.get(k + "_OUTPUT", v[1]), + "man"+manext, + f+"."+manext)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) # add the tag file if neccessary: tagfile = data.get("GENERATE_TAGFILE", "") From 2e8fe4797ae799c1626668d4cb700dfbe3ae7d8d Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Wed, 6 Jun 2012 10:52:33 -0400 Subject: [PATCH 14/30] Add stamp file to improve change detection Add ".last_updated" targets to doxygen output directories, so that doxygen isn't automatically considered up-to-date just because the output directory exists. --- __init__.py | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/__init__.py b/__init__.py index 84372ae1b..4345cba26 100644 --- a/__init__.py +++ b/__init__.py @@ -2,10 +2,10 @@ # -*- mode:python; coding:utf-8; -*- # # Astxx, the Asterisk C++ API and Utility Library. -# Copyright (C) 2005, 2006 Matthew A. Nicholson -# Copyright (C) 2006 Tim Blechmann -# -# Copyright (C) 2007 Christoph Boehme +# Copyright (C) 2005, 2006 Matthew A. Nicholson +# Copyright (C) 2006 Tim Blechmann +# Copyright (C) 2007 Christoph Boehme +# Copyright (C) 2012 Eric Anderson # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -200,7 +200,9 @@ def DoxyEmitter(source, target, env): # add our output locations for (k, v) in output_formats.items(): if data.get("GENERATE_" + k, v[0]) == "YES": - targets.append(env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) ) + dir = env.Dir(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) + targets.append(dir.File(".last_updated")) + ##targets.append(dir.File(".content_hash")) # add the tag file if neccessary: tagfile = data.get("GENERATE_TAGFILE", "") @@ -220,6 +222,20 @@ def DoxyEmitter(source, target, env): return (targets, source) +def generate_doxygen_commands(source, target, env, for_signature): + + """Generate the doxygen command line (easy) and the post-execution + timestamping (harder). The second part requires us to know which + directories are being built, which is why we do this as a Generator + (after the Emitter has run)""" + + dox_cmd = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}" + timestamp_cmds = ["date > %s"%(str(t)) for t in target] + print dox_cmd + print timestamp_cmds + return [dox_cmd] + timestamp_cmds + + def generate(env): """ Add builders and construction variables for the @@ -233,7 +249,7 @@ def generate(env): import SCons.Builder doxyfile_builder = SCons.Builder.Builder( - action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", + generator = generate_doxygen_commands, emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, From eb47568aaa1b5ecaf2610bbb3c519699d39c8386 Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Mon, 12 Aug 2013 16:05:59 +0100 Subject: [PATCH 15/30] Restructure so that the plugin is a module and a package, it's just more flexible. Clarify notes regarding history. --- .bzrignore => .hgignore | 0 __init__.py | 341 +------------------------------------- doxygen.py | 355 ++++++++++++++++++++++++++++++++++++++++ notes.txt | 14 +- 4 files changed, 366 insertions(+), 344 deletions(-) rename .bzrignore => .hgignore (100%) create mode 100644 doxygen.py diff --git a/.bzrignore b/.hgignore similarity index 100% rename from .bzrignore rename to .hgignore diff --git a/__init__.py b/__init__.py index 40f2c6a1e..29dae0e02 100644 --- a/__init__.py +++ b/__init__.py @@ -1,14 +1,7 @@ # vim: set et sw=3 tw=0 fo=awqorc ft=python: # -*- mode:python; coding:utf-8; -*- # -# Astxx, the Asterisk C++ API and Utility Library. -# Copyright (C) 2005, 2006 Matthew A. Nicholson -# Copyright (C) 2006 Tim Blechmann -# -# Copyright (C) 2007 Christoph Boehme -# -# Copyright (C) 2012 Dirk Baechle -# Copyright (C) 2012 Eric Anderson +# Copyright © 2013 Russel Winder # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -23,333 +16,5 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -import os -import os.path -import glob -from fnmatch import fnmatch - -# Currently supported output formats and their default -# values and output locations. -# From left to right: -# 1. default setting YES|NO -# 2. default output folder for this format -# 3. name of the (main) output file -# 4. default extension " -# 5. field for overriding the output file extension -output_formats = { - "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), - "LATEX": ("YES", "latex", "refman", ".tex", ""), - "RTF": ("NO", "rtf", "refman", ".rtf", ""), - "MAN": ("YES", "man", "", ".3", "MAN_EXTENSION"), - "XML": ("NO", "xml", "index", ".xml", ""), -} - -def DoxyfileParse(file_contents): - """ - Parse a Doxygen source file and return a dictionary of all the values. - Values will be strings and lists of strings. - """ - data = {} - - import shlex - lex = shlex.shlex(instream = file_contents, posix = True) - lex.wordchars += "*+./-:" - lex.whitespace = lex.whitespace.replace("\n", "") - lex.escape = "" - - lineno = lex.lineno - token = lex.get_token() - key = token # the first token should be a key - last_token = "" - key_token = False - next_key = False - new_data = True - - def append_data(data, key, new_data, token): - if new_data or len(data[key]) == 0: - data[key].append(token) - else: - data[key][-1] += token - - while token: - if token in ['\n']: - if last_token not in ['\\']: - key_token = True - elif token in ['\\']: - pass - elif key_token: - key = token - key_token = False - else: - if token == "+=": - if not data.has_key(key): - data[key] = list() - elif token == "=": - if key == "TAGFILES" and data.has_key(key): - append_data( data, key, False, "=" ) - new_data=False - else: - data[key] = list() - else: - append_data( data, key, new_data, token ) - new_data = True - - last_token = token - token = lex.get_token() - - if last_token == '\\' and token != '\n': - new_data = False - append_data( data, key, new_data, '\\' ) - - # compress lists of len 1 into single strings - for (k, v) in data.items(): - if len(v) == 0: - data.pop(k) - - # items in the following list will be kept as lists and not converted to strings - if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES"]: - continue - - if len(v) == 1: - data[k] = v[0] - - return data - -def DoxySourceFiles(node, env): - """ - Scan the given node's contents (a Doxygen file) and add - any files used to generate docs to the list of source files. - """ - default_file_patterns = [ - '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', - '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', - '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', - '*.py', - ] - - default_exclude_patterns = [ - '*~', - ] - - sources = [] - - data = DoxyfileParse(node.get_contents()) - - if data.get("RECURSIVE", "NO") == "YES": - recursive = True - else: - recursive = False - - file_patterns = data.get("FILE_PATTERNS", default_file_patterns) - exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) - - # We're running in the top-level directory, but the doxygen - # configuration file is in the same directory as node; this means - # that relative pathnames in node must be adjusted before they can - # go onto the sources list - conf_dir = os.path.dirname(str(node)) - - input = data.get("INPUT") - if input: - for node in data.get("INPUT", []): - if not os.path.isabs(node): - node = os.path.join(conf_dir, node) - if os.path.isfile(node): - sources.append(node) - elif os.path.isdir(node): - if recursive: - for root, dirs, files in os.walk(node): - for f in files: - filename = os.path.join(root, f) - - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) - - if pattern_check and not exclude_check: - sources.append(filename) - else: - for pattern in file_patterns: - sources.extend(glob.glob("/".join([node, pattern]))) - else: - # No INPUT specified, so apply plain patterns only - if recursive: - for root, dirs, files in os.walk('.'): - for f in files: - filename = os.path.join(root, f) - - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) - - if pattern_check and not exclude_check: - sources.append(filename) - else: - for pattern in file_patterns: - sources.extend(glob.glob(pattern)) - - # Add tagfiles to the list of source files: - for node in data.get("TAGFILES", []): - file = node.split("=")[0] - if not os.path.isabs(file): - file = os.path.join(conf_dir, file) - sources.append(file) - - # Add additional files to the list of source files: - def append_additional_source(option, formats): - for f in formats: - if data.get('GENERATE_'+f, output_formats[f][0]) == "YES": - file = data.get(option, "") - if file != "": - if not os.path.isabs(file): - file = os.path.join(conf_dir, file) - if os.path.isfile(file): - sources.append(file) - break; - - append_additional_source("HTML_STYLESHEET",['HTML']) - append_additional_source("HTML_HEADER",['HTML']) - append_additional_source("HTML_FOOTER",['HTML']) - - return sources - -def DoxySourceScan(node, env, path): - """ - Doxygen Doxyfile source scanner. This should scan the Doxygen file and add - any files used to generate docs to the list of source files. - """ - filepaths = DoxySourceFiles(node, env) - sources = map( lambda path: env.File(path), filepaths ) - return sources - -def DoxySourceScanCheck(node, env): - """Check if we should scan this file""" - return os.path.isfile(node.path) - -def DoxyEmitter(target, source, env): - """Doxygen Doxyfile emitter""" - doxy_fpath = str(source[0]) - data = DoxyfileParse(source[0].get_contents()) - - targets = [] - out_dir = data.get("OUTPUT_DIRECTORY", ".") - if not os.path.isabs(out_dir): - conf_dir = os.path.dirname(doxy_fpath) - out_dir = os.path.join(conf_dir, out_dir) - - # add our output locations - for (k, v) in output_formats.items(): - if data.get("GENERATE_" + k, v[0]) == "YES": - # Initialize output file extension for MAN pages - if k == 'MAN': - # Is the given extension valid? - manext = v[3] - if v[4]: - manext = data.get(v[4]) - # Try to strip off dots - manext = manext.replace('.','') - # Can we convert it to an int? - try: - e = int(manext) - except: - # No, so set back to default - manext = "3" - - od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man"+manext)) - else: - od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) - # don't clobber target folders - env.Precious(od) - # set up cleaning stuff - env.Clean(od, od) - - # Add target files - if k != "MAN": - # Is an extension override var given? - if v[4]: - fname = v[2]+data.get(v[4]) - else: - fname = v[2]+v[3] - of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) - targets.append(of) - # don't clean single files, we remove the complete output folders (see above) - env.NoClean(of) - else: - # Special case: MAN pages - # We have to add a target file docs/man/man3/foo.h.3 - # for each input file foo.h, so we scan the config file - # a second time... :( - filepaths = DoxySourceFiles(source[0], env) - for f in filepaths: - if os.path.isfile(f) and f != doxy_fpath: - of = env.File( os.path.join(out_dir, - data.get(k + "_OUTPUT", v[1]), - "man"+manext, - f+"."+manext)) - targets.append(of) - # don't clean single files, we remove the complete output folders (see above) - env.NoClean(of) - - # add the tag file if neccessary: - tagfile = data.get("GENERATE_TAGFILE", "") - if tagfile != "": - if not os.path.isabs(tagfile): - conf_dir = os.path.dirname(str(source[0])) - tagfile = os.path.join(conf_dir, tagfile) - targets.append(env.File(tagfile)) - - # don't clobber targets - for node in targets: - env.Precious(node) - - # set up cleaning stuff - for node in targets: - env.Clean(node, node) - - return (targets, source) - -def generate_doxygen_commands(source, target, env, for_signature): - - """Generate the doxygen command line (easy) and the post-execution - timestamping (harder). The second part requires us to know which - directories are being built, which is why we do this as a Generator - (after the Emitter has run)""" - - dox_cmd = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}" - timestamp_cmds = ["date > %s"%(str(t)) for t in target] - print dox_cmd - print timestamp_cmds - return [dox_cmd] + timestamp_cmds - - -def generate(env): - """ - Add builders and construction variables for the - Doxygen tool. This is currently for Doxygen 1.4.6. - """ - doxyfile_scanner = env.Scanner( - DoxySourceScan, - "DoxySourceScan", - scan_check = DoxySourceScanCheck, - ) - - import SCons.Builder - doxyfile_builder = SCons.Builder.Builder( - generator = generate_doxygen_commands, - emitter = DoxyEmitter, - target_factory = env.fs.Entry, - single_source = True, - source_scanner = doxyfile_scanner, - ) - - env.Append(BUILDERS = { - 'Doxygen': doxyfile_builder, - }) - - env.AppendUnique( - DOXYGEN = 'doxygen', - ) - -def exists(env): - """ - Make sure doxygen exists. - """ - return env.Detect("doxygen") +from doxygen import generate +from doxygen import exists diff --git a/doxygen.py b/doxygen.py new file mode 100644 index 000000000..6919c8224 --- /dev/null +++ b/doxygen.py @@ -0,0 +1,355 @@ +# vim: set et sw=3 tw=0 fo=awqorc ft=python: +# -*- mode:python; coding:utf-8; -*- +# +# Astxx, the Asterisk C++ API and Utility Library. +# Copyright © 2005, 2006 Matthew A. Nicholson +# Copyright © 2006 Tim Blechmann +# +# Copyright © 2007 Christoph Boehme +# +# Copyright © 2012 Dirk Baechle +# Copyright © 2012 Eric Anderson +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License version 2.1 as published by the Free Software Foundation. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +import os +import os.path +import glob +from fnmatch import fnmatch + +# Currently supported output formats and their default +# values and output locations. +# From left to right: +# 1. default setting YES|NO +# 2. default output folder for this format +# 3. name of the (main) output file +# 4. default extension " +# 5. field for overriding the output file extension +output_formats = { + "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), + "LATEX": ("YES", "latex", "refman", ".tex", ""), + "RTF": ("NO", "rtf", "refman", ".rtf", ""), + "MAN": ("YES", "man", "", ".3", "MAN_EXTENSION"), + "XML": ("NO", "xml", "index", ".xml", ""), +} + +def DoxyfileParse(file_contents): + """ + Parse a Doxygen source file and return a dictionary of all the values. + Values will be strings and lists of strings. + """ + data = {} + + import shlex + lex = shlex.shlex(instream = file_contents, posix = True) + lex.wordchars += "*+./-:" + lex.whitespace = lex.whitespace.replace("\n", "") + lex.escape = "" + + lineno = lex.lineno + token = lex.get_token() + key = token # the first token should be a key + last_token = "" + key_token = False + next_key = False + new_data = True + + def append_data(data, key, new_data, token): + if new_data or len(data[key]) == 0: + data[key].append(token) + else: + data[key][-1] += token + + while token: + if token in ['\n']: + if last_token not in ['\\']: + key_token = True + elif token in ['\\']: + pass + elif key_token: + key = token + key_token = False + else: + if token == "+=": + if not data.has_key(key): + data[key] = list() + elif token == "=": + if key == "TAGFILES" and data.has_key(key): + append_data( data, key, False, "=" ) + new_data=False + else: + data[key] = list() + else: + append_data( data, key, new_data, token ) + new_data = True + + last_token = token + token = lex.get_token() + + if last_token == '\\' and token != '\n': + new_data = False + append_data( data, key, new_data, '\\' ) + + # compress lists of len 1 into single strings + for (k, v) in data.items(): + if len(v) == 0: + data.pop(k) + + # items in the following list will be kept as lists and not converted to strings + if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES"]: + continue + + if len(v) == 1: + data[k] = v[0] + + return data + +def DoxySourceFiles(node, env): + """ + Scan the given node's contents (a Doxygen file) and add + any files used to generate docs to the list of source files. + """ + default_file_patterns = [ + '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', + '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', + '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', + '*.py', + ] + + default_exclude_patterns = [ + '*~', + ] + + sources = [] + + data = DoxyfileParse(node.get_contents()) + + if data.get("RECURSIVE", "NO") == "YES": + recursive = True + else: + recursive = False + + file_patterns = data.get("FILE_PATTERNS", default_file_patterns) + exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) + + # We're running in the top-level directory, but the doxygen + # configuration file is in the same directory as node; this means + # that relative pathnames in node must be adjusted before they can + # go onto the sources list + conf_dir = os.path.dirname(str(node)) + + input = data.get("INPUT") + if input: + for node in data.get("INPUT", []): + if not os.path.isabs(node): + node = os.path.join(conf_dir, node) + if os.path.isfile(node): + sources.append(node) + elif os.path.isdir(node): + if recursive: + for root, dirs, files in os.walk(node): + for f in files: + filename = os.path.join(root, f) + + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob("/".join([node, pattern]))) + else: + # No INPUT specified, so apply plain patterns only + if recursive: + for root, dirs, files in os.walk('.'): + for f in files: + filename = os.path.join(root, f) + + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob(pattern)) + + # Add tagfiles to the list of source files: + for node in data.get("TAGFILES", []): + file = node.split("=")[0] + if not os.path.isabs(file): + file = os.path.join(conf_dir, file) + sources.append(file) + + # Add additional files to the list of source files: + def append_additional_source(option, formats): + for f in formats: + if data.get('GENERATE_'+f, output_formats[f][0]) == "YES": + file = data.get(option, "") + if file != "": + if not os.path.isabs(file): + file = os.path.join(conf_dir, file) + if os.path.isfile(file): + sources.append(file) + break; + + append_additional_source("HTML_STYLESHEET",['HTML']) + append_additional_source("HTML_HEADER",['HTML']) + append_additional_source("HTML_FOOTER",['HTML']) + + return sources + +def DoxySourceScan(node, env, path): + """ + Doxygen Doxyfile source scanner. This should scan the Doxygen file and add + any files used to generate docs to the list of source files. + """ + filepaths = DoxySourceFiles(node, env) + sources = map( lambda path: env.File(path), filepaths ) + return sources + +def DoxySourceScanCheck(node, env): + """Check if we should scan this file""" + return os.path.isfile(node.path) + +def DoxyEmitter(target, source, env): + """Doxygen Doxyfile emitter""" + doxy_fpath = str(source[0]) + data = DoxyfileParse(source[0].get_contents()) + + targets = [] + out_dir = data.get("OUTPUT_DIRECTORY", ".") + if not os.path.isabs(out_dir): + conf_dir = os.path.dirname(doxy_fpath) + out_dir = os.path.join(conf_dir, out_dir) + + # add our output locations + for (k, v) in output_formats.items(): + if data.get("GENERATE_" + k, v[0]) == "YES": + # Initialize output file extension for MAN pages + if k == 'MAN': + # Is the given extension valid? + manext = v[3] + if v[4]: + manext = data.get(v[4]) + # Try to strip off dots + manext = manext.replace('.','') + # Can we convert it to an int? + try: + e = int(manext) + except: + # No, so set back to default + manext = "3" + + od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man"+manext)) + else: + od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) + # don't clobber target folders + env.Precious(od) + # set up cleaning stuff + env.Clean(od, od) + + # Add target files + if k != "MAN": + # Is an extension override var given? + if v[4]: + fname = v[2]+data.get(v[4]) + else: + fname = v[2]+v[3] + of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) + else: + # Special case: MAN pages + # We have to add a target file docs/man/man3/foo.h.3 + # for each input file foo.h, so we scan the config file + # a second time... :( + filepaths = DoxySourceFiles(source[0], env) + for f in filepaths: + if os.path.isfile(f) and f != doxy_fpath: + of = env.File( os.path.join(out_dir, + data.get(k + "_OUTPUT", v[1]), + "man"+manext, + f+"."+manext)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) + + # add the tag file if neccessary: + tagfile = data.get("GENERATE_TAGFILE", "") + if tagfile != "": + if not os.path.isabs(tagfile): + conf_dir = os.path.dirname(str(source[0])) + tagfile = os.path.join(conf_dir, tagfile) + targets.append(env.File(tagfile)) + + # don't clobber targets + for node in targets: + env.Precious(node) + + # set up cleaning stuff + for node in targets: + env.Clean(node, node) + + return (targets, source) + +def generate_doxygen_commands(source, target, env, for_signature): + + """Generate the doxygen command line (easy) and the post-execution + timestamping (harder). The second part requires us to know which + directories are being built, which is why we do this as a Generator + (after the Emitter has run)""" + + dox_cmd = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}" + timestamp_cmds = ["date > %s"%(str(t)) for t in target] + print dox_cmd + print timestamp_cmds + return [dox_cmd] + timestamp_cmds + + +def generate(env): + """ + Add builders and construction variables for the + Doxygen tool. This is currently for Doxygen 1.4.6. + """ + doxyfile_scanner = env.Scanner( + DoxySourceScan, + "DoxySourceScan", + scan_check = DoxySourceScanCheck, + ) + + import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( + generator = generate_doxygen_commands, + emitter = DoxyEmitter, + target_factory = env.fs.Entry, + single_source = True, + source_scanner = doxyfile_scanner, + ) + + env.Append(BUILDERS = { + 'Doxygen': doxyfile_builder, + }) + + env.AppendUnique( + DOXYGEN = 'doxygen', + ) + +def exists(env): + """ + Make sure doxygen exists. + """ + return env.Detect("doxygen") diff --git a/notes.txt b/notes.txt index a3c40dd43..9b139d2f2 100644 --- a/notes.txt +++ b/notes.txt @@ -1,9 +1,9 @@ -The original __init__.py is the file posted to http://www.scons.org/wiki/DoxygenBuilder by Matthew Nicolson -2006-03-31. Attached to this wiki page were two other files, both of which are included here: -doxygen_reiners_2007-02-26.py, and doxygen_boehme_2007-07-18.py. Boehme's version seems to include many of -the changes in Reiners but many of Reiners changes are missing from Boehme. It is not clear why Reiner's -changes have been reverted by Boehme. it seems appropriate to merge in Boehme's directly rather than -Reiner's and then Boehme's. +The original plugin file is the file posted to http://www.scons.org/wiki/DoxygenBuilder by Matthew Nicolson +2006-03-31. Attached to this wiki page were two other files, both of which are in the repository history +although removed from being in the working tree: doxygen_reiners_2007-02-26.py, and +doxygen_boehme_2007-07-18.py. Boehme's version seems to include many of the changes in Reiners but many of +Reiners changes are missing from Boehme. It is not clear why Reiner's changes have been reverted by Boehme. +it seems appropriate to merge in Boehme's directly rather than Reiner's and then Boehme's. Robert Smallshire in his email of http://scons.tigris.org/ds/viewMessage.do?dsForumId=1272&dsMessageId=2383574 supports the move to use @@ -11,3 +11,5 @@ Boehme's version as the next iteration. It may then be that a version he has ca Apart from one change to the builder command line, Norton's version seems to be Boehme's version with all the TAGFILE stuff removed. + +Since then others have made contributions, see the log for the history. From 92cee51e2e5e0a22a6f1e754a5954a1c4362dd9f Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Mon, 12 Aug 2013 17:35:23 +0100 Subject: [PATCH 16/30] Backout of pull request #2, 12:f443da08d6ef, as per Eric's comments on BitBucket. --- doxygen.py | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/doxygen.py b/doxygen.py index 6919c8224..02d055af3 100644 --- a/doxygen.py +++ b/doxygen.py @@ -8,7 +8,6 @@ # Copyright © 2007 Christoph Boehme # # Copyright © 2012 Dirk Baechle -# Copyright © 2012 Eric Anderson # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -296,30 +295,8 @@ def DoxyEmitter(target, source, env): tagfile = os.path.join(conf_dir, tagfile) targets.append(env.File(tagfile)) - # don't clobber targets - for node in targets: - env.Precious(node) - - # set up cleaning stuff - for node in targets: - env.Clean(node, node) - return (targets, source) -def generate_doxygen_commands(source, target, env, for_signature): - - """Generate the doxygen command line (easy) and the post-execution - timestamping (harder). The second part requires us to know which - directories are being built, which is why we do this as a Generator - (after the Emitter has run)""" - - dox_cmd = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}" - timestamp_cmds = ["date > %s"%(str(t)) for t in target] - print dox_cmd - print timestamp_cmds - return [dox_cmd] + timestamp_cmds - - def generate(env): """ Add builders and construction variables for the @@ -333,7 +310,7 @@ def generate(env): import SCons.Builder doxyfile_builder = SCons.Builder.Builder( - generator = generate_doxygen_commands, + action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", emitter = DoxyEmitter, target_factory = env.fs.Entry, single_source = True, From 0d12211c55cf6e854715aec264e5cb6aab9d7a3f Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 12:32:21 +0100 Subject: [PATCH 17/30] Assume we are not generating man pages by default. Set output_formats["MAN"] to "NO", by default, as suggested at http://www.scons.org/wiki/DoxygenBuilder#Note_added_by_Reinderien. Despite what the Doxygen docs say, GENERATE_MAN is off by default, and a browse of the source suggests that it's been that way since at least 2008 / Doxygen 1.5.7. --- doxygen.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen.py b/doxygen.py index 02d055af3..47907fddf 100644 --- a/doxygen.py +++ b/doxygen.py @@ -39,7 +39,7 @@ output_formats = { "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), "LATEX": ("YES", "latex", "refman", ".tex", ""), "RTF": ("NO", "rtf", "refman", ".rtf", ""), - "MAN": ("YES", "man", "", ".3", "MAN_EXTENSION"), + "MAN": ("NO", "man", "", ".3", "MAN_EXTENSION"), "XML": ("NO", "xml", "index", ".xml", ""), } From 3926ea513a99ac408a7785e89fd2b0f03dbcf080 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 15:38:49 +0100 Subject: [PATCH 18/30] Fix Doxyfile parsing when the first tag occurs on the first line. Also, add a couple of regression tests. --- doxygen.py | 4 ++-- test.py | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100755 test.py diff --git a/doxygen.py b/doxygen.py index 47907fddf..28ce3a9d5 100644 --- a/doxygen.py +++ b/doxygen.py @@ -58,9 +58,9 @@ def DoxyfileParse(file_contents): lineno = lex.lineno token = lex.get_token() - key = token # the first token should be a key + key = None last_token = "" - key_token = False + key_token = True # the first token should be a key next_key = False new_data = True diff --git a/test.py b/test.py new file mode 100755 index 000000000..eb0a89c27 --- /dev/null +++ b/test.py @@ -0,0 +1,26 @@ +#!/usr/bin/python +# +# tests for scons doxygen builder +# + +import unittest +import os +import sys +from doxygen import DoxyfileParse + +class TestParser(unittest.TestCase): + def testSimpleParse(self): + text=""" +INPUT = test.h +""" + result = DoxyfileParse(text) + self.assertEqual(["test.h"], result["INPUT"]) + + def testParseTagOnFirstLine(self): + text="""INPUT=.""" + result = DoxyfileParse(text) + self.assertEqual(["."], result["INPUT"]) + + +if __name__ == '__main__': + unittest.main() From d50e42638b27d430ba055114bb87ce4d6c37aee2 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 21:31:57 +0100 Subject: [PATCH 19/30] check that DoxyfileParse still works when there's a comment in the config. --- test.py | 1 + 1 file changed, 1 insertion(+) diff --git a/test.py b/test.py index eb0a89c27..7ae22d32e 100755 --- a/test.py +++ b/test.py @@ -11,6 +11,7 @@ from doxygen import DoxyfileParse class TestParser(unittest.TestCase): def testSimpleParse(self): text=""" +# comment INPUT = test.h """ result = DoxyfileParse(text) From 22dfdfb824c955dd929b2c4be99c130a40407da5 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 21:42:23 +0100 Subject: [PATCH 20/30] Fix test method names PEP8 says that method names should use lowercase_names. --- test.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test.py b/test.py index 7ae22d32e..d6c313a6b 100755 --- a/test.py +++ b/test.py @@ -9,7 +9,7 @@ import sys from doxygen import DoxyfileParse class TestParser(unittest.TestCase): - def testSimpleParse(self): + def test_simple_parse(self): text=""" # comment INPUT = test.h @@ -17,7 +17,7 @@ INPUT = test.h result = DoxyfileParse(text) self.assertEqual(["test.h"], result["INPUT"]) - def testParseTagOnFirstLine(self): + def test_parse_tag_on_first_line(self): text="""INPUT=.""" result = DoxyfileParse(text) self.assertEqual(["."], result["INPUT"]) From c876fe00443179643848a7abf29e59d8c38746bf Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 22:34:57 +0100 Subject: [PATCH 21/30] Add support for @INCLUDE tags in doxyfiles Doxygen configs can include other doxygen configs. Add support for @INCLUDE tag. --- doxygen.py | 48 ++++++++++++++++++-------- test.py | 18 ++++++++-- test_config/include_test.cfg | 1 + test_config/recursive_include_test.cfg | 1 + 4 files changed, 52 insertions(+), 16 deletions(-) create mode 100644 test_config/include_test.cfg create mode 100644 test_config/recursive_include_test.cfg diff --git a/doxygen.py b/doxygen.py index 28ce3a9d5..13a0f5bf5 100644 --- a/doxygen.py +++ b/doxygen.py @@ -43,16 +43,17 @@ output_formats = { "XML": ("NO", "xml", "index", ".xml", ""), } -def DoxyfileParse(file_contents): +def DoxyfileParse(file_contents, conf_dir, data=None): """ Parse a Doxygen source file and return a dictionary of all the values. Values will be strings and lists of strings. """ - data = {} + if data is None: + data = {} import shlex lex = shlex.shlex(instream = file_contents, posix = True) - lex.wordchars += "*+./-:" + lex.wordchars += "*+./-:@" lex.whitespace = lex.whitespace.replace("\n", "") lex.escape = "" @@ -87,12 +88,28 @@ def DoxyfileParse(file_contents): if key == "TAGFILES" and data.has_key(key): append_data( data, key, False, "=" ) new_data=False + elif key == "@INCLUDE" and data.has_key(key): + # don't reset the @INCLUDE list when we see a new @INCLUDE line. + pass else: data[key] = list() + elif key == "@INCLUDE": + # special case for @INCLUDE key: read the referenced + # file as a doxyfile too. + nextfile = token + if not os.path.isabs(nextfile): + nextfile = os.path.join(conf_dir, nextfile) + if nextfile in data[key]: + raise Exception("recursive @INCLUDE in Doxygen config: "+nextfile) + data[key].append(nextfile) + fh = open(nextfile,'r') + DoxyfileParse(fh.read(), conf_dir, data) + fh.close() else: append_data( data, key, new_data, token ) new_data = True + last_token = token token = lex.get_token() @@ -106,7 +123,7 @@ def DoxyfileParse(file_contents): data.pop(k) # items in the following list will be kept as lists and not converted to strings - if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES"]: + if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES", "@INCLUDE"]: continue if len(v) == 1: @@ -132,7 +149,13 @@ def DoxySourceFiles(node, env): sources = [] - data = DoxyfileParse(node.get_contents()) + # We're running in the top-level directory, but the doxygen + # configuration file is in the same directory as node; this means + # that relative pathnames in node must be adjusted before they can + # go onto the sources list + conf_dir = os.path.dirname(str(node)) + + data = DoxyfileParse(node.get_contents(), conf_dir) if data.get("RECURSIVE", "NO") == "YES": recursive = True @@ -142,12 +165,6 @@ def DoxySourceFiles(node, env): file_patterns = data.get("FILE_PATTERNS", default_file_patterns) exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) - # We're running in the top-level directory, but the doxygen - # configuration file is in the same directory as node; this means - # that relative pathnames in node must be adjusted before they can - # go onto the sources list - conf_dir = os.path.dirname(str(node)) - input = data.get("INPUT") if input: for node in data.get("INPUT", []): @@ -185,6 +202,10 @@ def DoxySourceFiles(node, env): for pattern in file_patterns: sources.extend(glob.glob(pattern)) + # Add @INCLUDEd files to the list of source files: + for node in data.get("@INCLUDE", []): + sources.append(node) + # Add tagfiles to the list of source files: for node in data.get("TAGFILES", []): file = node.split("=")[0] @@ -226,12 +247,12 @@ def DoxySourceScanCheck(node, env): def DoxyEmitter(target, source, env): """Doxygen Doxyfile emitter""" doxy_fpath = str(source[0]) - data = DoxyfileParse(source[0].get_contents()) + conf_dir = os.path.dirname(doxy_fpath) + data = DoxyfileParse(source[0].get_contents(), conf_dir) targets = [] out_dir = data.get("OUTPUT_DIRECTORY", ".") if not os.path.isabs(out_dir): - conf_dir = os.path.dirname(doxy_fpath) out_dir = os.path.join(conf_dir, out_dir) # add our output locations @@ -291,7 +312,6 @@ def DoxyEmitter(target, source, env): tagfile = data.get("GENERATE_TAGFILE", "") if tagfile != "": if not os.path.isabs(tagfile): - conf_dir = os.path.dirname(str(source[0])) tagfile = os.path.join(conf_dir, tagfile) targets.append(env.File(tagfile)) diff --git a/test.py b/test.py index d6c313a6b..9f372de91 100755 --- a/test.py +++ b/test.py @@ -9,19 +9,33 @@ import sys from doxygen import DoxyfileParse class TestParser(unittest.TestCase): + test_config_dir = os.path.join(os.path.dirname(__file__),'test_config') + def test_simple_parse(self): text=""" # comment INPUT = test.h """ - result = DoxyfileParse(text) + result = DoxyfileParse(text, self.test_config_dir) self.assertEqual(["test.h"], result["INPUT"]) def test_parse_tag_on_first_line(self): text="""INPUT=.""" - result = DoxyfileParse(text) + result = DoxyfileParse(text, self.test_config_dir) self.assertEqual(["."], result["INPUT"]) + def test_include_tag(self): + text="""@INCLUDE=include_test.cfg""" + result = DoxyfileParse(text, self.test_config_dir) + self.assertEqual(["abc"], result["INPUT"]) + self.assertEqual([os.path.join(self.test_config_dir, + "include_test.cfg")], + result["@INCLUDE"]) + + def test_recursive_include_tag(self): + text="""@INCLUDE=recursive_include_test.cfg""" + self.assertRaises(Exception, DoxyfileParse, text, self.test_config_dir) + if __name__ == '__main__': unittest.main() diff --git a/test_config/include_test.cfg b/test_config/include_test.cfg new file mode 100644 index 000000000..1b6b7ba1a --- /dev/null +++ b/test_config/include_test.cfg @@ -0,0 +1 @@ +INPUT="abc" diff --git a/test_config/recursive_include_test.cfg b/test_config/recursive_include_test.cfg new file mode 100644 index 000000000..0ed7b9ae8 --- /dev/null +++ b/test_config/recursive_include_test.cfg @@ -0,0 +1 @@ +@INCLUDE=recursive_include_test.cfg From 0224e8e22ac7cf2e82254aeb23f1208214b2aaa5 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Mon, 12 Aug 2013 22:06:23 +0100 Subject: [PATCH 22/30] Fix a TypeError in DoxyEmitter There is a problem with 7674543f, in that if HTML_FILE_EXTENSION or MAN_EXTENSION is not specified, we'll try to concatenate a string with None, and get a type error. We should check that they are set before trying to use them. --- doxygen.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doxygen.py b/doxygen.py index 13a0f5bf5..f397be065 100644 --- a/doxygen.py +++ b/doxygen.py @@ -262,7 +262,7 @@ def DoxyEmitter(target, source, env): if k == 'MAN': # Is the given extension valid? manext = v[3] - if v[4]: + if v[4] and data.has_key(v[4]): manext = data.get(v[4]) # Try to strip off dots manext = manext.replace('.','') @@ -284,7 +284,7 @@ def DoxyEmitter(target, source, env): # Add target files if k != "MAN": # Is an extension override var given? - if v[4]: + if v[4] and data.has_key(v[4]): fname = v[2]+data.get(v[4]) else: fname = v[2]+v[3] From 35e74d755d247754ae5c487fc8c81b1a413dc3bb Mon Sep 17 00:00:00 2001 From: Russel Winder Date: Tue, 2 Jun 2020 19:26:31 +0100 Subject: [PATCH 23/30] sconsDoxy: Import the final state of the Mercurial repository without the history. --- .hgignore | 1 - LICENCE.txt | 3 + README.md | 12 ++ doxygen.py | 532 ++++++++++++++++++++++++++------------------------- lgpl-2.1.txt | 502 ++++++++++++++++++++++++++++++++++++++++++++++++ test.py | 32 +++- 6 files changed, 811 insertions(+), 271 deletions(-) delete mode 100644 .hgignore create mode 100644 LICENCE.txt create mode 100644 README.md create mode 100644 lgpl-2.1.txt diff --git a/.hgignore b/.hgignore deleted file mode 100644 index 5b2d46270..000000000 --- a/.hgignore +++ /dev/null @@ -1 +0,0 @@ -.sconsign.dblite diff --git a/LICENCE.txt b/LICENCE.txt new file mode 100644 index 000000000..26d092d42 --- /dev/null +++ b/LICENCE.txt @@ -0,0 +1,3 @@ +This software is licenced under the GNU Lesser General Public License version 2.1, LGPLv2.1. + +See lgpl-2.1.txt. diff --git a/README.md b/README.md new file mode 100644 index 000000000..8d11eef86 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Doxygen Tools for SCons + +## Introduction + +[SCons](http://www.scons.org) is a build framework originally for C, C++, Fortran, and D builds. It has +though a tools (think plugin) architecture that allows tools to be built for other language builds. This +repository contains a tool for building Doxygen documentation. + +## Licence + +This software is provided by the SCons Foundation under the [LGPL v2.1 +licence](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html) diff --git a/doxygen.py b/doxygen.py index f397be065..3b63765a2 100644 --- a/doxygen.py +++ b/doxygen.py @@ -9,6 +9,8 @@ # # Copyright © 2012 Dirk Baechle # +# Copyright © 2013 Russel Winder +# # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public # License version 2.1 as published by the Free Software Foundation. @@ -36,317 +38,323 @@ from fnmatch import fnmatch # 4. default extension " # 5. field for overriding the output file extension output_formats = { - "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), - "LATEX": ("YES", "latex", "refman", ".tex", ""), - "RTF": ("NO", "rtf", "refman", ".rtf", ""), - "MAN": ("NO", "man", "", ".3", "MAN_EXTENSION"), - "XML": ("NO", "xml", "index", ".xml", ""), + "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"), + "LATEX": ("YES", "latex", "refman", ".tex", ""), + "RTF": ("NO", "rtf", "refman", ".rtf", ""), + "MAN": ("NO", "man", "", ".3", "MAN_EXTENSION"), + "XML": ("NO", "xml", "index", ".xml", ""), } + def DoxyfileParse(file_contents, conf_dir, data=None): - """ - Parse a Doxygen source file and return a dictionary of all the values. - Values will be strings and lists of strings. - """ - if data is None: - data = {} + """ + Parse a Doxygen source file and return a dictionary of all the values. + Values will be strings and lists of strings. + """ + if data is None: + data = {} - import shlex - lex = shlex.shlex(instream = file_contents, posix = True) - lex.wordchars += "*+./-:@" - lex.whitespace = lex.whitespace.replace("\n", "") - lex.escape = "" + import shlex + lex = shlex.shlex(instream=file_contents, posix=True) + lex.wordchars += "*+./-:@" + lex.whitespace = lex.whitespace.replace("\n", "") + lex.escape = "" - lineno = lex.lineno - token = lex.get_token() - key = None - last_token = "" - key_token = True # the first token should be a key - next_key = False - new_data = True + lineno = lex.lineno + token = lex.get_token() + key = None + last_token = "" + key_token = True # The first token should be a key. + next_key = False + new_data = True - def append_data(data, key, new_data, token): - if new_data or len(data[key]) == 0: - data[key].append(token) - else: - data[key][-1] += token + def append_data(data, key, new_data, token): + if new_data or len(data[key]) == 0: + data[key].append(token) + else: + data[key][-1] += token - while token: - if token in ['\n']: - if last_token not in ['\\']: - key_token = True - elif token in ['\\']: - pass - elif key_token: - key = token - key_token = False - else: - if token == "+=": - if not data.has_key(key): - data[key] = list() - elif token == "=": - if key == "TAGFILES" and data.has_key(key): - append_data( data, key, False, "=" ) - new_data=False - elif key == "@INCLUDE" and data.has_key(key): - # don't reset the @INCLUDE list when we see a new @INCLUDE line. - pass + while token: + if token in ['\n']: + if last_token not in ['\\']: + key_token = True + elif token in ['\\']: + pass + elif key_token: + key = token + key_token = False + else: + if token == "+=": + if key not in data: + data[key] = [] + elif token == "=": + if key == "TAGFILES" and key in data: + append_data(data, key, False, "=") + new_data = False + elif key == "@INCLUDE" and key in data: + # don't reset the @INCLUDE list when we see a new @INCLUDE line. + pass + else: + data[key] = [] + elif key == "@INCLUDE": + # special case for @INCLUDE key: read the referenced + # file as a doxyfile too. + nextfile = token + if not os.path.isabs(nextfile): + nextfile = os.path.join(conf_dir, nextfile) + if nextfile in data[key]: + raise Exception("recursive @INCLUDE in Doxygen config: " + nextfile) + data[key].append(nextfile) + fh = open(nextfile, 'r') + DoxyfileParse(fh.read(), conf_dir, data) + fh.close() else: - data[key] = list() - elif key == "@INCLUDE": - # special case for @INCLUDE key: read the referenced - # file as a doxyfile too. - nextfile = token - if not os.path.isabs(nextfile): - nextfile = os.path.join(conf_dir, nextfile) - if nextfile in data[key]: - raise Exception("recursive @INCLUDE in Doxygen config: "+nextfile) - data[key].append(nextfile) - fh = open(nextfile,'r') - DoxyfileParse(fh.read(), conf_dir, data) - fh.close() - else: - append_data( data, key, new_data, token ) - new_data = True + append_data(data, key, new_data, token) + new_data = True + last_token = token + token = lex.get_token() - last_token = token - token = lex.get_token() + if last_token == '\\' and token != '\n': + new_data = False + append_data(data, key, new_data, '\\') - if last_token == '\\' and token != '\n': - new_data = False - append_data( data, key, new_data, '\\' ) + # compress lists of len 1 into single strings + for (k, v) in data.items(): + if len(v) == 0: + data.pop(k) - # compress lists of len 1 into single strings - for (k, v) in data.items(): - if len(v) == 0: - data.pop(k) + # items in the following list will be kept as lists and not converted to strings + if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES", "@INCLUDE"]: + continue - # items in the following list will be kept as lists and not converted to strings - if k in ["INPUT", "FILE_PATTERNS", "EXCLUDE_PATTERNS", "TAGFILES", "@INCLUDE"]: - continue + if len(v) == 1: + data[k] = v[0] - if len(v) == 1: - data[k] = v[0] + return data - return data def DoxySourceFiles(node, env): - """ - Scan the given node's contents (a Doxygen file) and add - any files used to generate docs to the list of source files. - """ - default_file_patterns = [ - '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', - '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', - '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', - '*.py', - ] + """ + Scan the given node's contents (a Doxygen file) and add + any files used to generate docs to the list of source files. + """ + default_file_patterns = [ + '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', + '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', + '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', + '*.py', + ] - default_exclude_patterns = [ - '*~', - ] + default_exclude_patterns = [ + '*~', + ] - sources = [] + sources = [] - # We're running in the top-level directory, but the doxygen - # configuration file is in the same directory as node; this means - # that relative pathnames in node must be adjusted before they can - # go onto the sources list - conf_dir = os.path.dirname(str(node)) + # We're running in the top-level directory, but the doxygen + # configuration file is in the same directory as node; this means + # that relative pathnames in node must be adjusted before they can + # go onto the sources list + conf_dir = os.path.dirname(str(node)) - data = DoxyfileParse(node.get_contents(), conf_dir) + data = DoxyfileParse(node.get_contents(), conf_dir) - if data.get("RECURSIVE", "NO") == "YES": - recursive = True - else: - recursive = False + if data.get("RECURSIVE", "NO") == "YES": + recursive = True + else: + recursive = False - file_patterns = data.get("FILE_PATTERNS", default_file_patterns) - exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) + file_patterns = data.get("FILE_PATTERNS", default_file_patterns) + exclude_patterns = data.get("EXCLUDE_PATTERNS", default_exclude_patterns) - input = data.get("INPUT") - if input: - for node in data.get("INPUT", []): - if not os.path.isabs(node): - node = os.path.join(conf_dir, node) - if os.path.isfile(node): - sources.append(node) - elif os.path.isdir(node): - if recursive: - for root, dirs, files in os.walk(node): - for f in files: - filename = os.path.join(root, f) + input = data.get("INPUT") + if input: + for node in data.get("INPUT", []): + if not os.path.isabs(node): + node = os.path.join(conf_dir, node) + if os.path.isfile(node): + sources.append(node) + elif os.path.isdir(node): + if recursive: + for root, dirs, files in os.walk(node): + for f in files: + filename = os.path.join(root, f) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) - if pattern_check and not exclude_check: + if pattern_check and not exclude_check: + sources.append(filename) + else: + for pattern in file_patterns: + sources.extend(glob.glob("/".join([node, pattern]))) + else: + # No INPUT specified, so apply plain patterns only + if recursive: + for root, dirs, files in os.walk('.'): + for f in files: + filename = os.path.join(root, f) + + pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) + exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + + if pattern_check and not exclude_check: sources.append(filename) - else: - for pattern in file_patterns: - sources.extend(glob.glob("/".join([node, pattern]))) - else: - # No INPUT specified, so apply plain patterns only - if recursive: - for root, dirs, files in os.walk('.'): - for f in files: - filename = os.path.join(root, f) + else: + for pattern in file_patterns: + sources.extend(glob.glob(pattern)) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + # Add @INCLUDEd files to the list of source files: + for node in data.get("@INCLUDE", []): + sources.append(node) - if pattern_check and not exclude_check: - sources.append(filename) - else: - for pattern in file_patterns: - sources.extend(glob.glob(pattern)) + # Add tagfiles to the list of source files: + for node in data.get("TAGFILES", []): + file = node.split("=")[0] + if not os.path.isabs(file): + file = os.path.join(conf_dir, file) + sources.append(file) - # Add @INCLUDEd files to the list of source files: - for node in data.get("@INCLUDE", []): - sources.append(node) + # Add additional files to the list of source files: + def append_additional_source(option, formats): + for f in formats: + if data.get('GENERATE_' + f, output_formats[f][0]) == "YES": + file = data.get(option, "") + if file != "": + if not os.path.isabs(file): + file = os.path.join(conf_dir, file) + if os.path.isfile(file): + sources.append(file) + break - # Add tagfiles to the list of source files: - for node in data.get("TAGFILES", []): - file = node.split("=")[0] - if not os.path.isabs(file): - file = os.path.join(conf_dir, file) - sources.append(file) + append_additional_source("HTML_STYLESHEET", ['HTML']) + append_additional_source("HTML_HEADER", ['HTML']) + append_additional_source("HTML_FOOTER", ['HTML']) - # Add additional files to the list of source files: - def append_additional_source(option, formats): - for f in formats: - if data.get('GENERATE_'+f, output_formats[f][0]) == "YES": - file = data.get(option, "") - if file != "": - if not os.path.isabs(file): - file = os.path.join(conf_dir, file) - if os.path.isfile(file): - sources.append(file) - break; + return sources - append_additional_source("HTML_STYLESHEET",['HTML']) - append_additional_source("HTML_HEADER",['HTML']) - append_additional_source("HTML_FOOTER",['HTML']) - - return sources def DoxySourceScan(node, env, path): - """ - Doxygen Doxyfile source scanner. This should scan the Doxygen file and add - any files used to generate docs to the list of source files. - """ - filepaths = DoxySourceFiles(node, env) - sources = map( lambda path: env.File(path), filepaths ) - return sources + """ + Doxygen Doxyfile source scanner. This should scan the Doxygen file and add + any files used to generate docs to the list of source files. + """ + filepaths = DoxySourceFiles(node, env) + sources = map(lambda path: env.File(path), filepaths) + return sources + def DoxySourceScanCheck(node, env): - """Check if we should scan this file""" - return os.path.isfile(node.path) + """Check if we should scan this file""" + return os.path.isfile(node.path) + def DoxyEmitter(target, source, env): - """Doxygen Doxyfile emitter""" - doxy_fpath = str(source[0]) - conf_dir = os.path.dirname(doxy_fpath) - data = DoxyfileParse(source[0].get_contents(), conf_dir) + """Doxygen Doxyfile emitter""" + doxy_fpath = str(source[0]) + conf_dir = os.path.dirname(doxy_fpath) + data = DoxyfileParse(source[0].get_contents(), conf_dir) - targets = [] - out_dir = data.get("OUTPUT_DIRECTORY", ".") - if not os.path.isabs(out_dir): - out_dir = os.path.join(conf_dir, out_dir) + targets = [] + out_dir = data.get("OUTPUT_DIRECTORY", ".") + if not os.path.isabs(out_dir): + out_dir = os.path.join(conf_dir, out_dir) - # add our output locations - for (k, v) in output_formats.items(): - if data.get("GENERATE_" + k, v[0]) == "YES": - # Initialize output file extension for MAN pages - if k == 'MAN': - # Is the given extension valid? - manext = v[3] - if v[4] and data.has_key(v[4]): - manext = data.get(v[4]) - # Try to strip off dots - manext = manext.replace('.','') - # Can we convert it to an int? - try: - e = int(manext) - except: - # No, so set back to default - manext = "3" + # add our output locations + for (k, v) in output_formats.items(): + if data.get("GENERATE_" + k, v[0]) == "YES": + # Initialize output file extension for MAN pages + if k == 'MAN': + # Is the given extension valid? + manext = v[3] + if v[4] and v[4] in data: + manext = data.get(v[4]) + # Try to strip off dots + manext = manext.replace('.', '') + # Can we convert it to an int? + try: + e = int(manext) + except: + # No, so set back to default + manext = "3" - od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man"+manext)) - else: - od = env.Dir( os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) - # don't clobber target folders - env.Precious(od) - # set up cleaning stuff - env.Clean(od, od) - - # Add target files - if k != "MAN": - # Is an extension override var given? - if v[4] and data.has_key(v[4]): - fname = v[2]+data.get(v[4]) + od = env.Dir(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man" + manext)) else: - fname = v[2]+v[3] - of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) - targets.append(of) - # don't clean single files, we remove the complete output folders (see above) - env.NoClean(of) - else: - # Special case: MAN pages - # We have to add a target file docs/man/man3/foo.h.3 - # for each input file foo.h, so we scan the config file - # a second time... :( - filepaths = DoxySourceFiles(source[0], env) - for f in filepaths: - if os.path.isfile(f) and f != doxy_fpath: - of = env.File( os.path.join(out_dir, - data.get(k + "_OUTPUT", v[1]), - "man"+manext, - f+"."+manext)) - targets.append(of) - # don't clean single files, we remove the complete output folders (see above) - env.NoClean(of) + od = env.Dir(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) + # don't clobber target folders + env.Precious(od) + # set up cleaning stuff + env.Clean(od, od) - # add the tag file if neccessary: - tagfile = data.get("GENERATE_TAGFILE", "") - if tagfile != "": - if not os.path.isabs(tagfile): - tagfile = os.path.join(conf_dir, tagfile) - targets.append(env.File(tagfile)) + # Add target files + if k != "MAN": + # Is an extension override var given? + if v[4] and v[4] in data: + fname = v[2] + data.get(v[4]) + else: + fname = v[2] + v[3] + of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) + else: + # Special case: MAN pages + # We have to add a target file docs/man/man3/foo.h.3 + # for each input file foo.h, so we scan the config file + # a second time... :( + filepaths = DoxySourceFiles(source[0], env) + for f in filepaths: + if os.path.isfile(f) and f != doxy_fpath: + of = env.File(os.path.join(out_dir, + data.get(k + "_OUTPUT", v[1]), + "man" + manext, + f + "." + manext)) + targets.append(of) + # don't clean single files, we remove the complete output folders (see above) + env.NoClean(of) + + # add the tag file if neccessary: + tagfile = data.get("GENERATE_TAGFILE", "") + if tagfile != "": + if not os.path.isabs(tagfile): + tagfile = os.path.join(conf_dir, tagfile) + targets.append(env.File(tagfile)) + + return (targets, source) - return (targets, source) def generate(env): - """ - Add builders and construction variables for the - Doxygen tool. This is currently for Doxygen 1.4.6. - """ - doxyfile_scanner = env.Scanner( - DoxySourceScan, - "DoxySourceScan", - scan_check = DoxySourceScanCheck, - ) + """ + Add builders and construction variables for the + Doxygen tool. This is currently for Doxygen 1.4.6. + """ + doxyfile_scanner = env.Scanner( + DoxySourceScan, + "DoxySourceScan", + scan_check=DoxySourceScanCheck, + ) - import SCons.Builder - doxyfile_builder = SCons.Builder.Builder( - action = "cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", - emitter = DoxyEmitter, - target_factory = env.fs.Entry, - single_source = True, - source_scanner = doxyfile_scanner, - ) + import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( + action="cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", + emitter=DoxyEmitter, + target_factory=env.fs.Entry, + single_source=True, + source_scanner=doxyfile_scanner, + ) - env.Append(BUILDERS = { - 'Doxygen': doxyfile_builder, - }) + env.Append(BUILDERS={ + 'Doxygen': doxyfile_builder, + }) + + env.AppendUnique( + DOXYGEN='doxygen', + ) - env.AppendUnique( - DOXYGEN = 'doxygen', - ) def exists(env): - """ - Make sure doxygen exists. - """ - return env.Detect("doxygen") + """ + Make sure doxygen exists. + """ + return env.Detect("doxygen") diff --git a/lgpl-2.1.txt b/lgpl-2.1.txt new file mode 100644 index 000000000..4362b4915 --- /dev/null +++ b/lgpl-2.1.txt @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/test.py b/test.py index 9f372de91..525998757 100755 --- a/test.py +++ b/test.py @@ -1,18 +1,35 @@ #!/usr/bin/python +# -*- coding=utf-8; -*- + +# Tests for SCons Doxygen builder. # -# tests for scons doxygen builder +# Copyright © 2013 Richard van der Hoff +# Copyright © 2013 Russel Winder # +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License version 2.1 as published by the Free Software Foundation. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA import unittest import os import sys from doxygen import DoxyfileParse + class TestParser(unittest.TestCase): - test_config_dir = os.path.join(os.path.dirname(__file__),'test_config') + test_config_dir = os.path.join(os.path.dirname(__file__), 'test_config') def test_simple_parse(self): - text=""" + text = """ # comment INPUT = test.h """ @@ -20,20 +37,19 @@ INPUT = test.h self.assertEqual(["test.h"], result["INPUT"]) def test_parse_tag_on_first_line(self): - text="""INPUT=.""" + text = """INPUT=.""" result = DoxyfileParse(text, self.test_config_dir) self.assertEqual(["."], result["INPUT"]) def test_include_tag(self): - text="""@INCLUDE=include_test.cfg""" + text = """@INCLUDE=include_test.cfg""" result = DoxyfileParse(text, self.test_config_dir) self.assertEqual(["abc"], result["INPUT"]) - self.assertEqual([os.path.join(self.test_config_dir, - "include_test.cfg")], + self.assertEqual([os.path.join(self.test_config_dir, "include_test.cfg")], result["@INCLUDE"]) def test_recursive_include_tag(self): - text="""@INCLUDE=recursive_include_test.cfg""" + text = """@INCLUDE=recursive_include_test.cfg""" self.assertRaises(Exception, DoxyfileParse, text, self.test_config_dir) From cce3dad4fe55a486930aa851cc90f1ac50f44581 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Fri, 5 Mar 2021 08:55:42 -0700 Subject: [PATCH 24/30] sconsDoxy: Run converters on chapel and doxygen tools Signed-off-by: Mats Wichmann --- Sample/SConstruct | 6 +-- __init__.py | 4 +- doxygen.py | 118 ++++++++++++++++++++++++++++++++-------------- test.py | 11 +++-- 4 files changed, 93 insertions(+), 46 deletions(-) diff --git a/Sample/SConstruct b/Sample/SConstruct index 4623c5ca4..1ab85c4ba 100644 --- a/Sample/SConstruct +++ b/Sample/SConstruct @@ -1,4 +1,2 @@ - -env =Environment(tools=['default', 'doxygen'], toolpath='.') -env.Doxygen('doxy.cfg') - +env = Environment(tools=["default", "doxygen"], toolpath=".") +env.Doxygen("doxy.cfg") diff --git a/__init__.py b/__init__.py index 29dae0e02..4b2c9313e 100644 --- a/__init__.py +++ b/__init__.py @@ -16,5 +16,5 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -from doxygen import generate -from doxygen import exists +from .doxygen import generate +from .doxygen import exists diff --git a/doxygen.py b/doxygen.py index 3b63765a2..d3ec9fac0 100644 --- a/doxygen.py +++ b/doxygen.py @@ -28,6 +28,7 @@ import os import os.path import glob from fnmatch import fnmatch +from functools import reduce # Currently supported output formats and their default # values and output locations. @@ -55,6 +56,7 @@ def DoxyfileParse(file_contents, conf_dir, data=None): data = {} import shlex + lex = shlex.shlex(instream=file_contents, posix=True) lex.wordchars += "*+./-:@" lex.whitespace = lex.whitespace.replace("\n", "") @@ -75,10 +77,10 @@ def DoxyfileParse(file_contents, conf_dir, data=None): data[key][-1] += token while token: - if token in ['\n']: - if last_token not in ['\\']: + if token in ["\n"]: + if last_token not in ["\\"]: key_token = True - elif token in ['\\']: + elif token in ["\\"]: pass elif key_token: key = token @@ -105,7 +107,7 @@ def DoxyfileParse(file_contents, conf_dir, data=None): if nextfile in data[key]: raise Exception("recursive @INCLUDE in Doxygen config: " + nextfile) data[key].append(nextfile) - fh = open(nextfile, 'r') + fh = open(nextfile, "r") DoxyfileParse(fh.read(), conf_dir, data) fh.close() else: @@ -115,12 +117,12 @@ def DoxyfileParse(file_contents, conf_dir, data=None): last_token = token token = lex.get_token() - if last_token == '\\' and token != '\n': + if last_token == "\\" and token != "\n": new_data = False - append_data(data, key, new_data, '\\') + append_data(data, key, new_data, "\\") # compress lists of len 1 into single strings - for (k, v) in data.items(): + for (k, v) in list(data.items()): if len(v) == 0: data.pop(k) @@ -140,14 +142,35 @@ def DoxySourceFiles(node, env): any files used to generate docs to the list of source files. """ default_file_patterns = [ - '*.c', '*.cc', '*.cxx', '*.cpp', '*.c++', '*.java', '*.ii', '*.ixx', - '*.ipp', '*.i++', '*.inl', '*.h', '*.hh ', '*.hxx', '*.hpp', '*.h++', - '*.idl', '*.odl', '*.cs', '*.php', '*.php3', '*.inc', '*.m', '*.mm', - '*.py', + "*.c", + "*.cc", + "*.cxx", + "*.cpp", + "*.c++", + "*.java", + "*.ii", + "*.ixx", + "*.ipp", + "*.i++", + "*.inl", + "*.h", + "*.hh ", + "*.hxx", + "*.hpp", + "*.h++", + "*.idl", + "*.odl", + "*.cs", + "*.php", + "*.php3", + "*.inc", + "*.m", + "*.mm", + "*.py", ] default_exclude_patterns = [ - '*~', + "*~", ] sources = [] @@ -181,8 +204,16 @@ def DoxySourceFiles(node, env): for f in files: filename = os.path.join(root, f) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + pattern_check = reduce( + lambda x, y: x or bool(fnmatch(filename, y)), + file_patterns, + False, + ) + exclude_check = reduce( + lambda x, y: x and fnmatch(filename, y), + exclude_patterns, + True, + ) if pattern_check and not exclude_check: sources.append(filename) @@ -192,12 +223,18 @@ def DoxySourceFiles(node, env): else: # No INPUT specified, so apply plain patterns only if recursive: - for root, dirs, files in os.walk('.'): + for root, dirs, files in os.walk("."): for f in files: filename = os.path.join(root, f) - pattern_check = reduce(lambda x, y: x or bool(fnmatch(filename, y)), file_patterns, False) - exclude_check = reduce(lambda x, y: x and fnmatch(filename, y), exclude_patterns, True) + pattern_check = reduce( + lambda x, y: x or bool(fnmatch(filename, y)), + file_patterns, + False, + ) + exclude_check = reduce( + lambda x, y: x and fnmatch(filename, y), exclude_patterns, True + ) if pattern_check and not exclude_check: sources.append(filename) @@ -219,7 +256,7 @@ def DoxySourceFiles(node, env): # Add additional files to the list of source files: def append_additional_source(option, formats): for f in formats: - if data.get('GENERATE_' + f, output_formats[f][0]) == "YES": + if data.get("GENERATE_" + f, output_formats[f][0]) == "YES": file = data.get(option, "") if file != "": if not os.path.isabs(file): @@ -228,9 +265,9 @@ def DoxySourceFiles(node, env): sources.append(file) break - append_additional_source("HTML_STYLESHEET", ['HTML']) - append_additional_source("HTML_HEADER", ['HTML']) - append_additional_source("HTML_FOOTER", ['HTML']) + append_additional_source("HTML_STYLESHEET", ["HTML"]) + append_additional_source("HTML_HEADER", ["HTML"]) + append_additional_source("HTML_FOOTER", ["HTML"]) return sources @@ -241,7 +278,7 @@ def DoxySourceScan(node, env, path): any files used to generate docs to the list of source files. """ filepaths = DoxySourceFiles(node, env) - sources = map(lambda path: env.File(path), filepaths) + sources = [env.File(path) for path in filepaths] return sources @@ -262,16 +299,16 @@ def DoxyEmitter(target, source, env): out_dir = os.path.join(conf_dir, out_dir) # add our output locations - for (k, v) in output_formats.items(): + for (k, v) in list(output_formats.items()): if data.get("GENERATE_" + k, v[0]) == "YES": # Initialize output file extension for MAN pages - if k == 'MAN': + if k == "MAN": # Is the given extension valid? manext = v[3] if v[4] and v[4] in data: manext = data.get(v[4]) # Try to strip off dots - manext = manext.replace('.', '') + manext = manext.replace(".", "") # Can we convert it to an int? try: e = int(manext) @@ -279,7 +316,9 @@ def DoxyEmitter(target, source, env): # No, so set back to default manext = "3" - od = env.Dir(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man" + manext)) + od = env.Dir( + os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), "man" + manext) + ) else: od = env.Dir(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]))) # don't clobber target folders @@ -294,7 +333,9 @@ def DoxyEmitter(target, source, env): fname = v[2] + data.get(v[4]) else: fname = v[2] + v[3] - of = env.File(os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname)) + of = env.File( + os.path.join(out_dir, data.get(k + "_OUTPUT", v[1]), fname) + ) targets.append(of) # don't clean single files, we remove the complete output folders (see above) env.NoClean(of) @@ -306,10 +347,14 @@ def DoxyEmitter(target, source, env): filepaths = DoxySourceFiles(source[0], env) for f in filepaths: if os.path.isfile(f) and f != doxy_fpath: - of = env.File(os.path.join(out_dir, - data.get(k + "_OUTPUT", v[1]), - "man" + manext, - f + "." + manext)) + of = env.File( + os.path.join( + out_dir, + data.get(k + "_OUTPUT", v[1]), + "man" + manext, + f + "." + manext, + ) + ) targets.append(of) # don't clean single files, we remove the complete output folders (see above) env.NoClean(of) @@ -336,6 +381,7 @@ def generate(env): ) import SCons.Builder + doxyfile_builder = SCons.Builder.Builder( action="cd ${SOURCE.dir} && ${DOXYGEN} ${SOURCE.file}", emitter=DoxyEmitter, @@ -344,12 +390,14 @@ def generate(env): source_scanner=doxyfile_scanner, ) - env.Append(BUILDERS={ - 'Doxygen': doxyfile_builder, - }) + env.Append( + BUILDERS={ + "Doxygen": doxyfile_builder, + } + ) env.AppendUnique( - DOXYGEN='doxygen', + DOXYGEN="doxygen", ) diff --git a/test.py b/test.py index 525998757..26e401a48 100755 --- a/test.py +++ b/test.py @@ -22,11 +22,11 @@ import unittest import os import sys -from doxygen import DoxyfileParse +from .doxygen import DoxyfileParse class TestParser(unittest.TestCase): - test_config_dir = os.path.join(os.path.dirname(__file__), 'test_config') + test_config_dir = os.path.join(os.path.dirname(__file__), "test_config") def test_simple_parse(self): text = """ @@ -45,13 +45,14 @@ INPUT = test.h text = """@INCLUDE=include_test.cfg""" result = DoxyfileParse(text, self.test_config_dir) self.assertEqual(["abc"], result["INPUT"]) - self.assertEqual([os.path.join(self.test_config_dir, "include_test.cfg")], - result["@INCLUDE"]) + self.assertEqual( + [os.path.join(self.test_config_dir, "include_test.cfg")], result["@INCLUDE"] + ) def test_recursive_include_tag(self): text = """@INCLUDE=recursive_include_test.cfg""" self.assertRaises(Exception, DoxyfileParse, text, self.test_config_dir) -if __name__ == '__main__': +if __name__ == "__main__": unittest.main() From 11ee48ec9f0bb1d287a03807f227cf4fb38ef0dd Mon Sep 17 00:00:00 2001 From: kprussing Date: Sat, 3 Jul 2021 01:59:28 -0400 Subject: [PATCH 25/30] sconsDoxy: Remove the symlink for doxygen The symlink in the doxygen tool example interferes with installing using pip because it tries to do a recursive installation. --- Sample/site_scons/site_tools/doxygen | 1 - 1 file changed, 1 deletion(-) delete mode 120000 Sample/site_scons/site_tools/doxygen diff --git a/Sample/site_scons/site_tools/doxygen b/Sample/site_scons/site_tools/doxygen deleted file mode 120000 index a8a4f8c21..000000000 --- a/Sample/site_scons/site_tools/doxygen +++ /dev/null @@ -1 +0,0 @@ -../../.. \ No newline at end of file From 4cf4e090496a05794a27b52003113314a8ea7fa2 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sat, 12 Feb 2022 08:36:50 -0700 Subject: [PATCH 26/30] sconsDoxy: Move all markdown READMEs to reST It's a pain to mentally switch markup style if modifying notes on several tools. pandoc used for the conversion. Signed-off-by: Mats Wichmann --- README.md | 12 ------------ README.rst | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 12 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 8d11eef86..000000000 --- a/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Doxygen Tools for SCons - -## Introduction - -[SCons](http://www.scons.org) is a build framework originally for C, C++, Fortran, and D builds. It has -though a tools (think plugin) architecture that allows tools to be built for other language builds. This -repository contains a tool for building Doxygen documentation. - -## Licence - -This software is provided by the SCons Foundation under the [LGPL v2.1 -licence](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html) diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..c04c8b856 --- /dev/null +++ b/README.rst @@ -0,0 +1,16 @@ +Doxygen Tools for SCons +======================= + +Introduction +------------ + +`SCons `__ is a build framework originally for C, +C++, Fortran, and D builds. It has though a tools (think plugin) +architecture that allows tools to be built for other language builds. +This repository contains a tool for building Doxygen documentation. + +Licence +------- + +This software is provided by the SCons Foundation under the `LGPL v2.1 +licence `__ From 865fe4e3c5f19fedda7b3007db55fa9e193e2e95 Mon Sep 17 00:00:00 2001 From: "Tanjeff-N. Moos" Date: Fri, 29 Jul 2022 21:31:17 +0200 Subject: [PATCH 27/30] sconsDoxy: Bugfix: Convert object to . In DoxyfileParse(), the 'file_contents' parameter is a object. Since the shlex.shlex() member doesn't accept objects, we convert it to a . --- doxygen.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen.py b/doxygen.py index d3ec9fac0..60e20e64c 100644 --- a/doxygen.py +++ b/doxygen.py @@ -57,7 +57,7 @@ def DoxyfileParse(file_contents, conf_dir, data=None): import shlex - lex = shlex.shlex(instream=file_contents, posix=True) + lex = shlex.shlex(instream=file_contents.decode("utf-8"), posix=True) lex.wordchars += "*+./-:@" lex.whitespace = lex.whitespace.replace("\n", "") lex.escape = "" From 035a38b17710781bd890733660f0abc9a968f5cf Mon Sep 17 00:00:00 2001 From: "Tanjeff-N. Moos" Date: Sat, 30 Jul 2022 09:19:08 +0200 Subject: [PATCH 28/30] sconsDoxy: Better fix: get_contents() -> get_text_contents(). --- doxygen.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doxygen.py b/doxygen.py index 60e20e64c..579b77cf8 100644 --- a/doxygen.py +++ b/doxygen.py @@ -57,7 +57,7 @@ def DoxyfileParse(file_contents, conf_dir, data=None): import shlex - lex = shlex.shlex(instream=file_contents.decode("utf-8"), posix=True) + lex = shlex.shlex(instream=file_contents, posix=True) lex.wordchars += "*+./-:@" lex.whitespace = lex.whitespace.replace("\n", "") lex.escape = "" @@ -181,7 +181,7 @@ def DoxySourceFiles(node, env): # go onto the sources list conf_dir = os.path.dirname(str(node)) - data = DoxyfileParse(node.get_contents(), conf_dir) + data = DoxyfileParse(node.get_text_contents(), conf_dir) if data.get("RECURSIVE", "NO") == "YES": recursive = True @@ -291,7 +291,8 @@ def DoxyEmitter(target, source, env): """Doxygen Doxyfile emitter""" doxy_fpath = str(source[0]) conf_dir = os.path.dirname(doxy_fpath) - data = DoxyfileParse(source[0].get_contents(), conf_dir) + + data = DoxyfileParse(source[0].get_text_contents(), conf_dir) targets = [] out_dir = data.get("OUTPUT_DIRECTORY", ".") From ebf51f227c3daef1a8558f63ed3fea9fa9a96398 Mon Sep 17 00:00:00 2001 From: "Tanjeff-N. Moos" Date: Sun, 31 Jul 2022 16:22:56 +0200 Subject: [PATCH 29/30] sconsDoxy: Restructure code: close file in case of exception. Up to now, the file was opened, then DoxyfileParse() was invoked, then the file was closed. If DoxyfileParse() throws an exception, the file would not be closed. The new solution auto-closes the file in any case. --- doxygen.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doxygen.py b/doxygen.py index 579b77cf8..5a1e46ca2 100644 --- a/doxygen.py +++ b/doxygen.py @@ -107,9 +107,8 @@ def DoxyfileParse(file_contents, conf_dir, data=None): if nextfile in data[key]: raise Exception("recursive @INCLUDE in Doxygen config: " + nextfile) data[key].append(nextfile) - fh = open(nextfile, "r") - DoxyfileParse(fh.read(), conf_dir, data) - fh.close() + with open(nextfile, "r") as fh: + DoxyfileParse(fh.read(), conf_dir, data) else: append_data(data, key, new_data, token) new_data = True From 5d1bf3c0bef84b2a48f6106a07f968b74557a44e Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sun, 31 Jul 2022 17:12:23 -0600 Subject: [PATCH 30/30] sconsDoxy: Update doxygen testcase and rename Signed-off-by: Mats Wichmann --- test.py => doxygenTests.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) rename test.py => doxygenTests.py (87%) diff --git a/test.py b/doxygenTests.py similarity index 87% rename from test.py rename to doxygenTests.py index 26e401a48..311eefa7f 100755 --- a/test.py +++ b/doxygenTests.py @@ -22,7 +22,7 @@ import unittest import os import sys -from .doxygen import DoxyfileParse +from doxygen import DoxyfileParse class TestParser(unittest.TestCase): @@ -53,6 +53,14 @@ INPUT = test.h text = """@INCLUDE=recursive_include_test.cfg""" self.assertRaises(Exception, DoxyfileParse, text, self.test_config_dir) + def test_bytes_parse(self): + """Parsing bytes instead of txt should blow up.""" + text = b""" +# comment +INPUT = test.h +""" + self.assertRaises(AttributeError, DoxyfileParse, text, self.test_config_dir) + if __name__ == "__main__": unittest.main()