diff options
Diffstat (limited to 'template')
| -rw-r--r-- | template/Doxyfile.tmpl | 2686 | ||||
| -rw-r--r-- | template/GNUmakefile.in | 19 | ||||
| -rw-r--r-- | template/Makefile.in | 704 | ||||
| -rw-r--r-- | template/builtin_binary.inc.tmpl | 30 | ||||
| -rw-r--r-- | template/call_iseq_optimized.inc.tmpl | 68 | ||||
| -rw-r--r-- | template/configure-ext.mk.tmpl | 46 | ||||
| -rw-r--r-- | template/depend.tmpl | 2 | ||||
| -rw-r--r-- | template/encdb.h.tmpl | 101 | ||||
| -rw-r--r-- | template/extinit.c.tmpl | 17 | ||||
| -rw-r--r-- | template/exts.mk.tmpl | 171 | ||||
| -rw-r--r-- | template/fake.rb.in | 53 | ||||
| -rw-r--r-- | template/id.c.tmpl | 41 | ||||
| -rw-r--r-- | template/id.h.tmpl | 97 | ||||
| -rw-r--r-- | template/known_errors.inc.tmpl | 14 | ||||
| -rw-r--r-- | template/limits.c.tmpl | 97 | ||||
| -rw-r--r-- | template/prelude.c.tmpl | 281 | ||||
| -rwxr-xr-x | template/ruby-gdb.in | 6 | ||||
| -rwxr-xr-x | template/ruby-lldb.in | 6 | ||||
| -rw-r--r-- | template/ruby-runner.h.in | 9 | ||||
| -rw-r--r-- | template/ruby.pc.in | 59 | ||||
| -rw-r--r-- | template/sizes.c.tmpl | 54 | ||||
| -rw-r--r-- | template/transdb.h.tmpl | 60 | ||||
| -rw-r--r-- | template/unicode_norm_gen.tmpl | 220 | ||||
| -rw-r--r-- | template/verconf.h.tmpl | 63 |
24 files changed, 4904 insertions, 0 deletions
diff --git a/template/Doxyfile.tmpl b/template/Doxyfile.tmpl new file mode 100644 index 0000000000..36c0b1c8d6 --- /dev/null +++ b/template/Doxyfile.tmpl @@ -0,0 +1,2686 @@ +# Doxyfile 1.9.3 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single 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 (\" \"). + +<% +srcdir = miniruby = nil +opt = OptionParser.new do |o| + o.on('--srcdir=SRCDIR') {|v| srcdir = v} + o.on('--miniruby=MINIRUBY') {|v| miniruby = v} + o.order!(ARGV) +end +srcdir ||= File.dirname(File.dirname(__FILE__)) +load 'rbconfig.rb' +unless miniruby + miniruby = './miniruby$(EXEEXT) -I$(srcdir)/lib -I$(EXTOUT)/common -I./-' + RbConfig.expand(miniruby, RbConfig::CONFIG.merge("srcdir"=>srcdir)) +end +dot = RbConfig::CONFIG['DOT'] || "" +have_dot = dot.empty? ? "NO" : "YES" +%> + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = Ruby + +# 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 = "<%=RUBY_VERSION%><%= RUBY_PATCHLEVEL < 0 ? 'dev' : "p#{RUBY_PATCHLEVEL}" %> (<%=RUBY_RELEASE_DATE%> revision <%=RUBY_REVISION%>)" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/capi + +# 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 causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, 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. +# The default value is: YES. + +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 and 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. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# 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. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, 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 +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = <%=srcdir%> + +# 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 list of 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. +# The default value is: NO. + +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-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. 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 behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +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. +# The default value is: NO. + +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. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = +ALIASES += "alias{1}=Just another name of @ref \1" +ALIASES += "old{1}=Old name of @ref \1.^^@deprecated Use @ref \1 instead.^^@ingroup deprecated_macros" +ALIASES += "shyouhei=\@shyouhei" +ALIASES += "ko1=\@ko1" +ALIASES += "matz=\@matz" + +# 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. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_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. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES 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. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# 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 respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If 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, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +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, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = YES + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES 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. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the 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. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +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. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = "<%=miniruby%> <%=srcdir%>/tool/file2lastrev.rb -q --srcdir=<%=srcdir%>" + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag 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. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = 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) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = +INPUT += <%=srcdir%> +INPUT += . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = +FILE_PATTERNS += *.c +FILE_PATTERNS += *.h +FILE_PATTERNS += *.hpp +FILE_PATTERNS += *.y +FILE_PATTERNS +=*.def + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = +EXCLUDE += <%=srcdir%>/ccan +EXCLUDE += <%=srcdir%>/ext + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = YES + +# 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 = +EXCLUDE_PATTERNS += *.src +EXCLUDE_PATTERNS += *prelude.c +EXCLUDE_PATTERNS += .ext +EXCLUDE_PATTERNS += .git +EXCLUDE_PATTERNS += .svn +EXCLUDE_PATTERNS += bootstraptest +EXCLUDE_PATTERNS += build +EXCLUDE_PATTERNS += doc +EXCLUDE_PATTERNS += enc +EXCLUDE_PATTERNS += encdb.h +EXCLUDE_PATTERNS += extconf.h +EXCLUDE_PATTERNS += insns.def +EXCLUDE_PATTERNS += lib +EXCLUDE_PATTERNS += rb_mjit_header.h +EXCLUDE_PATTERNS += spec +EXCLUDE_PATTERNS += test +EXCLUDE_PATTERNS += tmp +EXCLUDE_PATTERNS += transdb.h +EXCLUDE_PATTERNS += yarvtest + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = <%=srcdir%>/doc/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = "<%=miniruby%> <%=srcdir%>/tool/strip-rdoc.rb" + +# 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 information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = YES + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = 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 https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES 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. +# See also: Section \class. +# The default value is: YES. + +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. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +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. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# 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. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# 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. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# 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. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using JavaScript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: +# https://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +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 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. +# +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). 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. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + +#--------------------------------------------------------------------------- +# 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 too pretty with other RTF +# readers/editors. +# The default value is: NO. + +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. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +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 some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +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. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# 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 value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +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. +# The default value is: NO. + +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. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# 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. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to 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. +# The default value is: NO. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +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. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +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. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +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, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = YES + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +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. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = +INCLUDE_PATH += <%=srcdir%> +INCLUDE_PATH += <%=srcdir%>/include + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +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 e.g. +# 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. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = +PREDEFINED += ALWAYS_INLINE(_)=_ +PREDEFINED += COLDFUNC= +PREDEFINED += CONSTFUNC(_)=_ +PREDEFINED += DEPRECATED(_)=_ +PREDEFINED += DEPRECATED_BY(__,_)=_ +PREDEFINED += ENUM_OVER_INT=1 +PREDEFINED += ERRORFUNC(__,_)=_ +PREDEFINED += MJIT_FUNC_EXPORTED= +PREDEFINED += MJIT_STATIC=extern +PREDEFINED += MJIT_SYMBOL_EXPORT_BEGIN= +PREDEFINED += MJIT_SYMBOL_EXPORT_END= +PREDEFINED += NOINLINE(_)=_ +PREDEFINED += NORETURN(_)=_ +PREDEFINED += PACKED_STRUCT_UNALIGNED(_)=_ +PREDEFINED += PRINTF_ARGS(_,__,___)=_ +PREDEFINED += PUREFUNC(_)=_ +PREDEFINED += RB_UNUSED_VAR(_)=_ +PREDEFINED += RUBY_EXTERN=extern +PREDEFINED += RUBY_FUNC_EXPORTED= +PREDEFINED += RUBY_FUNC_NONNULL(__,_)=_ +PREDEFINED += RUBY_SYMBOL_EXPORT_BEGIN= +PREDEFINED += RUBY_SYMBOL_EXPORT_END= +PREDEFINED += WARNINGFUNC(__,_)=_ +PREDEFINED += _MSC_VER=1924 +PREDEFINED += __DOXYGEN__ +PREDEFINED += __GNUC_MINOR__=0 +PREDEFINED += __GNUC_PATCHLEVEL__=0 +PREDEFINED += __GNUC__=10 +PREDEFINED += __STDC_VERSION__=201710L +PREDEFINED += __clang__=10 +PREDEFINED += __clang_major__=10 +PREDEFINED += __clang_minor__=0 +PREDEFINED += __clang_patchlevel__=0 +PREDEFINED += __cplusplus=201704L +PREDEFINED += __has_attribute(_)=1 +PREDEFINED += __has_builtin(_)=1 +PREDEFINED += __has_c_attribute(_)=1 +PREDEFINED += __has_cpp_attribute(_)=1 +PREDEFINED += __has_declspec_attribute(_)=1 +PREDEFINED += __has_extension(_)=1 +PREDEFINED += __has_feature(_)=1 +PREDEFINED += __has_warning(_)=1 + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED += RBIMPL_FL_USER_N + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# 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. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: 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. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = <%= have_dot %> + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a +# graph for each documented class showing the direct and indirect inheritance +# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, +# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set +# to TEXT the direct and indirect inheritance relations will be shown as texts / +# links. +# Possible values are: NO, YES, TEXT and GRAPH. +# The default value is: YES. + +CLASS_GRAPH = NO + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = NO + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag UML_LOOK is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is 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. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = NO + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = NO + +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag 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. +# This tag requires that the tag HAVE_DOT is set to YES. + +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). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 128 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate +# files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. +# The default value is: YES. + +DOT_CLEANUP = YES diff --git a/template/GNUmakefile.in b/template/GNUmakefile.in new file mode 100644 index 0000000000..4fe4aab979 --- /dev/null +++ b/template/GNUmakefile.in @@ -0,0 +1,19 @@ +gnumake = yes + +ifeq ($(filter Makefile,$(MAKEFILE_LIST)),) +include Makefile + +GNUmakefile: $(srcdir)/template/GNUmakefile.in +endif + +override silence := $(if $(findstring s,$(firstword $(MFLAGS))),yes,no) + +ifeq ($(HAVE_BASERUBY),yes) +override REVISION_FORCE := PHONY +endif + +include $(srcdir)/defs/universal.mk +-include uncommon.mk +include $(srcdir)/defs/gmake.mk + +GNUmakefile: $(srcdir)/template/GNUmakefile.in diff --git a/template/Makefile.in b/template/Makefile.in new file mode 100644 index 0000000000..0bb30e1474 --- /dev/null +++ b/template/Makefile.in @@ -0,0 +1,704 @@ +# -*- mode: makefile-gmake; indent-tabs-mode: t -*- + +SHELL = /bin/sh +NULLCMD = @NULLCMD@ +silence = no # yes/no +yes_silence = $(silence:no=) +no_silence = $(silence:yes=) +n=$(NULLCMD) +ECHO1 = $(V:1=$n) +RUNCMD = $(SHELL) +CDPATH = . +CHDIR = @CHDIR@ +exec = exec +NULL = /dev/null +PATH_SEPARATOR = @PATH_SEPARATOR@ + +#### Start of system configuration section. #### + +srcdir = @srcdir@ +top_srcdir = $(srcdir) +hdrdir = $(srcdir)/include +tooldir = $(srcdir)/tool + +PLATFORM_DIR = @PLATFORM_DIR@ + +CC_WRAPPER = @XCC_WRAPPER@ +CC = @CC@ +CPP = @CPP@ +LD = @LD@ +YACC = bison +PURIFY = +AUTOCONF = autoconf +CONFIGURE = @CONFIGURE@ +@SET_MAKE@ +MKFILES = @MAKEFILES@ +BASERUBY = @BASERUBY@ +HAVE_BASERUBY = @HAVE_BASERUBY@ +TEST_RUNNABLE = @TEST_RUNNABLE@ +CROSS_COMPILING = @CROSS_COMPILING@ +DOXYGEN = @DOXYGEN@ + +prefix = @prefix@ +exec_prefix = @exec_prefix@ +bindir = @bindir@ +sbindir = @sbindir@ +libdir = @libdir@ +libexecdir = @libexecdir@ +datarootdir = @datarootdir@ +datadir = @datadir@ +target_os = @target_os@ +arch = @arch@ +sitearch = @sitearch@ +sitedir = @sitedir@ +archlibdir = @archlibdir@ +includedir = @includedir@ +archincludedir = @archincludedir@ +rubylibprefix = @rubylibprefix@ +rubylibdir = @rubylibdir@ +rubyarchprefix = @rubyarchprefix@ +rubyarchdir = @rubyarchdir@ +rubyhdrdir = @rubyhdrdir@ +rubyarchhdrdir = @rubyarchhdrdir@ +ruby_version = @ruby_version@ +RUBY_VERSION_NAME = @RUBY_VERSION_NAME@ +UNIVERSAL_ARCHNAMES = @UNIVERSAL_ARCHNAMES@ + +TESTUI = console +TESTS = +INSTALLDOC = @INSTALLDOC@ +DOCTARGETS = @RDOCTARGET@ @CAPITARGET@ + +EXTOUT = @EXTOUT@ +TIMESTAMPDIR = $(EXTOUT)/.timestamp +arch_hdrdir = $(EXTOUT)/include/$(arch) +VPATH = $(arch_hdrdir)/ruby:$(hdrdir)/ruby:$(srcdir):$(srcdir)/missing + +empty = +CC_VERSION = @CC_VERSION@ +OUTFLAG = @OUTFLAG@$(empty) +COUTFLAG = @COUTFLAG@$(empty) +CPPOUTFLAG = > +ARCH_FLAG = @ARCH_FLAG@ +CFLAGS_NO_ARCH = @CFLAGS@ +CFLAGS = $(CFLAGS_NO_ARCH) $(ARCH_FLAG) +cflags = @cflags@ +optflags = @optflags@ +debugflags = @debugflags@ +warnflags = @warnflags@ @strict_warnflags@ +cppflags = @cppflags@ +incflags = @incflags@ +XCFLAGS = @XCFLAGS@ $(INCFLAGS) +USE_RUBYGEMS = @USE_RUBYGEMS@ +USE_RUBYGEMS_ = $(USE_RUBYGEMS:yes=) +CPPFLAGS = @CPPFLAGS@ $(USE_RUBYGEMS_:no=-DDISABLE_RUBYGEMS=1) +MJIT_SUPPORT = @MJIT_SUPPORT@ +MJIT_HEADER_FLAGS = @MJIT_HEADER_FLAGS@ +MJIT_HEADER_SUFFIX = +MJIT_HEADER_ARCH = +MJIT_HEADER_INSTALL_DIR = @MJIT_HEADER_INSTALL_DIR@ +MJIT_CC = @MJIT_CC@ +MJIT_CFLAGS = @MJIT_CFLAGS@ +MJIT_OPTFLAGS = @MJIT_OPTFLAGS@ +MJIT_DEBUGFLAGS = @MJIT_DEBUGFLAGS@ +MJIT_LDSHARED = @MJIT_LDSHARED@ +MJIT_DLDFLAGS = $(XDLDFLAGS) +MJIT_HEADER = rb_mjit_header.h +MJIT_MIN_HEADER_NAME = rb_mjit_min_header-$(RUBY_PROGRAM_VERSION).h +MJIT_MIN_HEADER = $(MJIT_HEADER_BUILD_DIR)/$(MJIT_MIN_HEADER_NAME) +MJIT_HEADER_BUILD_DIR = $(EXTOUT)/include/$(arch) +MJIT_TABS=@MJIT_TABS@ +LDFLAGS = @STATIC@ $(CFLAGS) @LDFLAGS@ +EXE_LDFLAGS = $(LDFLAGS) +EXTLDFLAGS = @EXTLDFLAGS@ +XLDFLAGS = @XLDFLAGS@ $(EXTLDFLAGS) +EXTLIBS = +LIBS = @LIBS@ $(EXTLIBS) +MISSING = @LIBOBJS@ @ALLOCA@ +ENABLE_SHARED = @ENABLE_SHARED@ +LDSHARED = @LIBRUBY_LDSHARED@ +DLDSHARED = @DLDSHARED@ +XDLDFLAGS = @DLDFLAGS@ +DLDFLAGS = @LIBRUBY_DLDFLAGS@ $(XLDFLAGS) $(ARCH_FLAG) +SOLIBS = @SOLIBS@ +ENABLE_DEBUG_ENV = @ENABLE_DEBUG_ENV@ +MAINLIBS = @MAINLIBS@ +ARCHMINIOBJS = @MINIOBJS@ +DLNOBJ = @DLNOBJ@ +ENCOBJS = @ENCOBJS@ +EXTOBJS = @EXTOBJS@ +BUILTIN_ENCOBJS = @BUILTIN_ENCOBJS@ +BUILTIN_TRANSSRCS = @BUILTIN_TRANSSRCS@ +BUILTIN_TRANSOBJS = @BUILTIN_TRANSOBJS@ +POSTLINK = @POSTLINK@ + +RUBY_BASE_NAME=@RUBY_BASE_NAME@ +RUBY_API_VERSION=@RUBY_API_VERSION@ +RUBY_INSTALL_NAME=@RUBY_INSTALL_NAME@ +RUBY_SO_NAME=@RUBY_SO_NAME@ +EXEEXT = @EXEEXT@ +LIBEXT = @LIBEXT@ +PROGRAM=$(RUBY_INSTALL_NAME)$(EXEEXT) +RUBY = $(RUBY_INSTALL_NAME) +MINIRUBY = @MINIRUBY@\ + $(MINIRUBYOPT) +# RUNRUBY_COMMAND:: runruby.rb or baseruby. do not append options directly +RUNRUBY_COMMAND = @RUNRUBY_COMMAND@ +# RUNRUBY:: run ruby with RUN_OPTS which is passed to ruby +RUNRUBY = @RUNRUBY@ $(RUN_OPTS) +# RUNRUBY_DEBUGGER:: debugging option for runruby.rb +RUNRUBY_DEBUGGER = --debugger='gdb -x run.gdb --quiet --args' +XRUBY = @XRUBY@ +BTESTRUBY = @BTESTRUBY@ -r./$(arch)-fake +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +XRUBY_LIBDIR = @XRUBY_LIBDIR@ +XRUBY_RUBYLIBDIR = @XRUBY_RUBYLIBDIR@ +XRUBY_RUBYHDRDIR = @XRUBY_RUBYHDRDIR@ + +yes_baseruby = $(HAVE_BASERUBY:no=) +no_baseruby = $(HAVE_BASERUBY:yes=) +BOOTSTRAPRUBY = $(yes_baseruby:yes=$(BASERUBY)) $(no_baseruby:no=$(MINIRUBY)) +BOOTSTRAPRUBY_OPT = $(yes_baseruby:yes=-r./$(arch)-fake) +BOOTSTRAPRUBY_FAKE = $(yes_baseruby:yes=$(arch)-fake.rb) + +COROUTINE_H = @X_COROUTINE_H@ +COROUTINE_OBJ = $(COROUTINE_H:.h=.@OBJEXT@) +COROUTINE_SRC = @X_COROUTINE_SRC@ + +#### End of system configuration section. #### + +MAJOR= @MAJOR@ +MINOR= @MINOR@ +TEENY= @TEENY@ + +# here for MJIT_MIN_HEADER_NAME, not in common.mk +RUBY_PROGRAM_VERSION = $(MAJOR).$(MINOR).$(TEENY) + +LIBRUBY_A = @LIBRUBY_A@ +LIBRUBY_SO = @LIBRUBY_SO@ +LIBRUBY_SONAME= @LIBRUBY_SONAME@ +LIBRUBY_ALIASES= @LIBRUBY_ALIASES@ +LIBRUBY = @LIBRUBY@ +LIBRUBYARG = @LIBRUBYARG@ +LIBRUBYARG_STATIC = @LIBRUBYARG_STATIC@ +LIBRUBYARG_SHARED = @LIBRUBYARG_SHARED@ +LIBRUBY_RELATIVE = @LIBRUBY_RELATIVE@ +LIBRUBY_A_OBJS = @LIBRUBY_A_OBJS@ + +DTRACE_REBUILD_OBJS = $(DTRACE_REBUILD:yes=$(DTRACE_DEPENDENT_OBJS)) + +DTRACE_DEPENDENT_OBJS = array.$(OBJEXT) \ + eval.$(OBJEXT) \ + gc.$(OBJEXT) \ + hash.$(OBJEXT) \ + load.$(OBJEXT) \ + object.$(OBJEXT) \ + parse.$(OBJEXT) \ + string.$(OBJEXT) \ + symbol.$(OBJEXT) \ + vm.$(OBJEXT) + +THREAD_MODEL = @THREAD_MODEL@ + +PREP = @PREP@ +ARCHFILE = @ARCHFILE@ +SETUP = +EXTSTATIC = @EXTSTATIC@ +ENCSTATIC = @ENCSTATIC@ +SET_LC_MESSAGES = env LC_MESSAGES=C + +MAKEDIRS = @MKDIR_P@ +CP = cp +MV = mv +RM = rm -f +RM1 = $(RM) +RMDIR = @RMDIR@ +RMDIRS = @RMDIRS@ +RMALL = @RMALL@ +LN_S = @LN_S@ +NM = @NM@ +AR = @AR@ +ARFLAGS = @ARFLAGS@$(empty) +RANLIB = @RANLIB@ +AS = @AS@ +ASFLAGS = @ASFLAGS@ $(ARCH_FLAG) $(INCFLAGS) +IFCHANGE = $(SHELL) $(tooldir)/ifchange +OBJDUMP = @OBJDUMP@ +OBJCOPY = @OBJCOPY@ +HAVE_GIT = @HAVE_GIT@ +GIT = @GIT@ +VCS = @VCS@ +VCSUP = @VCSUP@ +DTRACE = @DTRACE@ @DTRACE_OPT@ +DTRACE_EXT = @DTRACE_EXT@ +DTRACE_OBJ = @DTRACE_OBJ@ +DTRACE_REBUILD= @DTRACE_REBUILD@ +DTRACE_GLOMMED_OBJ = $(DTRACE_REBUILD:yes=ruby-glommed.$(OBJEXT)) + +OBJEXT = @OBJEXT@ +ASMEXT = @ASMEXT@ +SOEXT = @SOEXT@ +DLEXT = @DLEXT@ +MANTYPE = @MANTYPE@ +SYMBOL_PREFIX = @SYMBOL_PREFIX@ + +INSTALLED_LIST= .installed.list + +NEWLINE_C = enc/trans/newline.c +MINIPRELUDE_C = miniprelude.c +GOLF_PRELUDE_C= golf_prelude.c +RBCONFIG = .rbconfig.time + +MAINSRC = $(MAINOBJ:.@OBJEXT@=.c) + +SRC_FILE = $< +OS_SRC_FILE = $< +DEST_FILE = $@ +OS_DEST_FILE = $@ + +MESSAGE_BEGIN = @for line in +MESSAGE_END = ; do echo "$$line"; done +ECHO_BEGIN = @sep=''; for word in +ECHO_END = ; do echo @ECHO_N@ "$$sep'$$word'@ECHO_C@"; sep=' '; done; echo + +ACTIONS_GROUP = @$(NULLCMD) $(empty) +ACTIONS_ENDGROUP = @$(NULLCMD) + +DESTDIR = @DESTDIR@ + +configure_args = @configure_args@ +#### End of variables + +.SUFFIXES: .inc .h .c .y .i .$(ASMEXT) .$(DTRACE_EXT) + +all: + +# Prevent GNU make v3 from overflowing arg limit on SysV. +.NOEXPORT: + +miniruby$(EXEEXT): + @-if test -f $@; then $(MV) -f $@ $@.old; $(RM) $@.old; fi + $(ECHO) linking $@ + $(Q) $(PURIFY) $(CC) $(EXE_LDFLAGS) $(XLDFLAGS) $(NORMALMAINOBJ) $(MINIOBJS) $(COMMONOBJS) $(MAINLIBS) $(LIBS) $(OUTFLAG)$@ + $(Q) $(POSTLINK) + +$(PROGRAM): + @$(RM) $@ + $(ECHO) linking $@ + $(Q) $(PURIFY) $(CC) $(EXE_LDFLAGS) $(XLDFLAGS) $(MAINOBJ) $(EXTOBJS) $(LIBRUBYARG) $(MAINLIBS) $(LIBS) $(EXTLIBS) $(OUTFLAG)$@ + $(Q) $(POSTLINK) + +$(PROGRAM): @XRUBY_LIBPATHENV_WRAPPER@ + +PRE_LIBRUBY_UPDATE = [ -n "$(LIBRUBY_SO_UPDATE)" ] || $(gnumake:yes=exec) $(RM) $(LIBRUBY_EXTS) + +# We must `rm' the library each time this rule is invoked because "updating" a +# MAB library on Apple/NeXT (see --enable-fat-binary in configure) is not +# supported. +$(LIBRUBY_A): + @$(RM) $@ + @-[ -z "$(EXTSTATIC)" ] || $(PRE_LIBRUBY_UPDATE) + $(ECHO) linking static-library $@ + $(Q) $(AR) $(ARFLAGS) $@ $(LIBRUBY_A_OBJS) $(INITOBJS) + @-$(RANLIB) $@ 2> /dev/null || true + +verify-static-library: $(LIBRUBY_A) + $(ECHO) verifying static-library $@ + @$(PURIFY) $(CC) $(EXE_LDFLAGS) $(XLDFLAGS) $(MAINOBJ) $(LIBRUBY_A) $(MAINLIBS) $(EXTLIBS) $(LIBS) $(OUTFLAG)conftest$(EXEEXT) + @$(RMALL) conftest$(EXEEXT) conftest.c conftest.dSYM + +$(LIBRUBY_SO): + @-[ -n "$(EXTSTATIC)" ] || $(PRE_LIBRUBY_UPDATE) + $(ECHO) linking shared-library $@ + $(Q) $(LDSHARED) $(DLDFLAGS) $(OBJS) $(DLDOBJS) $(SOLIBS) $(EXTSOLIBS) $(OUTFLAG)$@ + -$(Q) $(OBJCOPY) -w -L '$(SYMBOL_PREFIX)Init_*' -L '$(SYMBOL_PREFIX)ruby_static_id_*' \ + -L '$(SYMBOL_PREFIX)*_threadptr_*' -L '$(SYMBOL_PREFIX)*_ec_*' $@ + $(Q) $(POSTLINK) + @-$(MINIRUBY) -e 'so, *aliases = ARGV; aliases.uniq!; aliases.delete(File.basename(so)); \ + aliases.each { |link| File.delete link rescue nil; File.symlink so, link }' \ + $(LIBRUBY_SO) $(LIBRUBY_ALIASES) || true + +LIBRUBY_WITH_EXT = @LIBRUBY_WITH_EXT@ +$(LIBRUBY_$(LIBRUBY_WITH_EXT)): $(LIBRUBY_SO_UPDATE) + +PKG_CONFIG = @PKG_CONFIG@ +ruby_pc = @ruby_pc@ +$(ruby_pc): config.status Makefile + $(Q)./config.status --file=-:$(srcdir)/template/ruby.pc.in | \ + sed -e 's/\$$(\([A-Za-z_][A-Za-z0-9_]*\))/$${\1}/g' \ + -e 's|^prefix=.*|prefix=$(prefix)|' \ + > ruby.tmp.pc + $(Q)pkg_config=${PKG_CONFIG} && PKG_CONFIG_PATH=. $${pkg_config:-:} --print-errors ruby.tmp + $(Q)$(MV) -f ruby.tmp.pc $(ruby_pc) + +pre-install-local:: pkgconfig-data + +ruby-runner.h: template/ruby-runner.h.in config.status + @./config.status --file=$@:$(srcdir)/template/$(@F).in + +install-cross: $(arch)-fake.rb $(RBCONFIG) rbconfig.rb $(arch_hdrdir)/ruby/config.h \ + $(LIBRUBY_A) $(LIBRUBY_SO) $(ARCHFILE) pkgconfig-data + $(ECHO) installing cross-compiling stuff + $(Q) $(MAKEDIRS) $(XRUBY_RUBYLIBDIR)/$(arch) $(XRUBY_RUBYHDRDIR)/$(arch)/ruby + $(Q) sed '/^\$$:\.unshift/q' $(arch)-fake.rb > fake.rb + $(Q) $(BASERUBY) -p \ + -e '~/^\s*CONFIG\["LDFLAGS"\]/ and' \ + -e '$$_[/(?=\s*"$$)/] = %q[ #{(CONFIG["LIBPATHFLAG"]%File.dirname(__FILE__)).strip}]' \ + rbconfig.rb > fake-rbconfig.rb + $(INSTALL_SCRIPT) fake.rb $(XRUBY_RUBYLIBDIR)/$(arch)/fake.rb + $(INSTALL_SCRIPT) fake-rbconfig.rb $(XRUBY_RUBYLIBDIR)/$(arch)/rbconfig.rb + @$(RM) fake.rb fake-rbconfig.rb + $(INSTALL_DATA) $(arch_hdrdir)/ruby/config.h $(XRUBY_RUBYHDRDIR)/$(arch)/ruby + $(INSTALL_DATA) $(top_srcdir)/include/ruby/win32.h $(XRUBY_RUBYHDRDIR)/ruby + $(INSTALL_DATA) $(LIBRUBY) $(LIBRUBY_A) $(XRUBY_RUBYLIBDIR)/$(arch) + $(INSTALL_PROGRAM) $(LIBRUBY_SO) $(XRUBY_RUBYLIBDIR)/$(arch) + +Makefile: $(srcdir)/template/Makefile.in $(srcdir)/enc/Makefile.in + +$(MKFILES): config.status $(srcdir)/version.h + @[ -f $@ ] && mv $@ $@.old + MAKE=$(MAKE) $(SHELL) ./config.status $@ + @cmp $@ $@.old > /dev/null 2>&1 && echo $@ unchanged && exit 0; \ + { \ + echo "all:; -@rm -f conftest.mk"; \ + echo "conftest.mk: .force; @echo AUTO_REMAKE"; \ + echo ".force:"; \ + } > conftest.mk || exit 1; \ + $(MAKE) -f conftest.mk | grep '^AUTO_REMAKE$$' >/dev/null 2>&1 || \ + { echo "$@ updated, restart."; exit 1; } + +uncommon.mk: $(srcdir)/common.mk + sed 's/{\$$([^(){}]*)[^{}]*}//g' $< > $@ + +.PHONY: reconfig +reconfig-args = $(srcdir)/$(CONFIGURE) $(yes_silence:yes=--silent) $(configure_args) +config.status-args = ./config.status $(yes_silence:yes=--silent) --recheck +reconfig-exec-0 = test -t 1 && { : $${CONFIGURE_TTY=yes}; export CONFIGURE_TTY; }; exec 3>&1; exit `exec 4>&1; { "$$@" 3>&- 4>&-; echo $$? 1>&4; } | fgrep -v '(cached)' 1>&3 3>&- 4>&-` +reconfig-exec-1 = set -x; "$$@" + +reconfig config.status: $(srcdir)/$(CONFIGURE) $(srcdir)/enc/Makefile.in \ + $(srcdir)/include/ruby/version.h + @PWD= MINIRUBY="$(MINIRUBY)"; export MINIRUBY; \ + set $(SHELL) $($@-args); $(reconfig-exec-$(V)) + +$(srcdir)/$(CONFIGURE): $(srcdir)/configure.ac + $(CHDIR) $(srcdir) && exec $(AUTOCONF) -o $(@F) + +prereq: $(srcdir)/$(CONFIGURE) + +incs: id.h +all-incs: probes.h + +# Things which should be considered: +# * with gperf v.s. without gperf +# * committers may have various versions of gperf +# * ./configure v.s. ../ruby/configure +# * GNU make v.s. HP-UX make # HP-UX make invokes the action if lex.c and keywords has same mtime. +# * svn checkout generate a file with mtime as current time +# * ext4 and XFS has a mtime with fractional part +lex.c: defs/keywords + @\ + if cmp -s $(srcdir)/defs/lex.c.src $?; then \ + [ $(Q) ] && echo copying $@ || set -x; \ + $(CP) $(srcdir)/lex.c.blt $@; \ + else \ + [ $(Q) ] && echo generating $@ || set -x; \ + gperf -C -P -p -j1 -i 1 -g -o -t -N rb_reserved_word -k1,3,$$ $? \ + | sed -f $(tooldir)/gperf.sed \ + > $@.tmp && \ + $(MV) $@.tmp $@ && \ + $(CP) $? $(srcdir)/defs/lex.c.src && \ + $(CP) $@ $(srcdir)/lex.c.blt; \ + fi + +JIS_PROPS_OPTIONS = -k1,3 -7 -c -j1 -i1 -t -C -P -t --ignore-case -H onig_jis_property_hash -Q onig_jis_property_pool -N onig_jis_property + +$(srcdir)/enc/jis/props.h: enc/jis/props.kwd + $(MAKEDIRS) $(@D) + @set +e; \ + if cmp -s $(?:.kwd=.src) $?; then \ + set -x; \ + $(CP) $(?:.kwd=.h.blt) $@; \ + else \ + set -x; \ + gperf $(JIS_PROPS_OPTIONS) $? | \ + sed -f $(tooldir)/gperf.sed > $@ && \ + $(CP) $? $(?:.kwd=.src) && \ + $(CP) $@ $(?:.kwd=.h.blt); \ + fi + +.c.@OBJEXT@: + @$(ECHO) compiling $< + $(Q) $(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) $(COUTFLAG)$@ -c $< + +.$(ASMEXT).@OBJEXT@: + @$(ECHO) assembling $< + $(Q) $(CC) $(ASFLAGS) -DSYMBOL_PREFIX=$(SYMBOL_PREFIX) -o $@ -c $< + +.c.$(ASMEXT): + @$(ECHO) translating $< + $(Q) $(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) $(COUTFLAG)$@ -S $< + +.c.i: + @$(ECHO) preprocessing $< + $(Q) $(CPP) $(warnflags) $(XCFLAGS) $(CPPFLAGS) $(COUTFLAG)$@ -E $< > $@ + +.d.h: + @$(ECHO) translating probes $< + $(Q) $(DTRACE) -o $@.tmp -h -C $(INCFLAGS) -s $< + $(Q) sed -e 's/RUBY_/RUBY_DTRACE_/g' -e 's/PROBES_H_TMP/RUBY_PROBES_H/' -e 's/(char \*/(const char */g' -e 's/, char \*/, const char */g' $@.tmp > $@ + $(Q) $(RM) $@.tmp + +.dmyh.h: + @$(ECHO) making dummy $(DEST_FILE) + $(Q)echo '#include "$(*F).dmyh"' > $@ + +probes.stamp: $(DTRACE_REBUILD_OBJS) + $(Q) if test -f $@ -o -f probes.$(OBJEXT); then \ + $(RM) $(DTRACE_REBUILD_OBJS) $@; \ + $(ECHO0) "rebuilding objects which were modified by \"dtrace -G\""; \ + $(MAKE) $(DTRACE_REBUILD_OBJS); \ + fi + $(Q) touch $@ + +probes.$(OBJEXT): $(srcdir)/probes.d $(DTRACE_REBUILD:yes=probes.stamp) + @$(ECHO) processing probes in object files + $(Q) $(RM) $@ + $(Q) $(DTRACE) -G -C $(INCFLAGS) -s $(srcdir)/probes.d -o $@ $(DTRACE_REBUILD_OBJS) + +main: mjit-headers +yes-mjit-headers: $(MJIT_MIN_HEADER) +clean-local:: + $(Q)$(RM) \ + $(MJIT_HEADER) $(MJIT_HEADER:.h=)$(MJIT_HEADER_SUFFIX:%=*).h \ + $(MJIT_MIN_HEADER) $(MJIT_MIN_HEADER:.h=)$(MJIT_HEADER_SUFFIX:%=*).h \ + $(MJIT_HEADER_INSTALL_DIR)/rb_mjit_min_header-*.h \ + $(TIMESTAMPDIR)/$(MJIT_HEADER:.h=)$(MJIT_HEADER_SUFFIX).time mjit_config.h \ + || $(NULLCMD) + $(Q)$(RM) -r mjit_build_dir.* + -$(Q) $(RMDIRS) $(MJIT_HEADER_INSTALL_DIR) $(MJIT_HEADER_BUILD_DIR) $(TIMESTAMPDIR) 2> $(NULL) || $(NULLCMD) + +# DTrace static library hacks described here: +# https://marc.info/?l=opensolaris-dtrace-discuss&m=114761203110734&w=4 +ruby-glommed.$(OBJEXT): + @$(ECHO) generating a glommed object with DTrace probes for static library + $(Q) $(LD) -r -o $@ $(OBJS) + +clean-local:: + $(Q)$(RM) \ + ext/extinit.c ext/extinit.$(OBJEXT) ext/ripper/y.output \ + enc/encinit.c enc/encinit.$(OBJEXT) $(pkgconfig_DATA) \ + ruby-runner.$(OBJEXT) ruby-runner.h \ + || $(NULLCMD) + $(Q)find . -name '*.bc' -o -name '*.[is]' -delete + -$(Q)$(RMALL) exe/ *.dSYM + +distclean-local:: + $(Q)$(RM) \ + ext/config.cache $(RBCONFIG) Doxyfile run.gdb \ + $(INSTALLED_LIST) $(arch_hdrdir)/ruby/config.h verconf.h \ + || $(NULLCMD) + -$(Q)$(RMDIRS) $(arch_hdrdir)/ruby 2> /dev/null || true + +ext/clean.sub:: ext/clean.mk +ext/distclean.sub:: ext/distclean.mk +ext/realclean.sub:: ext/realclean.mk + +ext/clean.mk ext/distclean.mk ext/realclean.mk:: + -$(Q) if [ -f $(EXTS_MK) ]; then exec $(MAKE) -f $(EXTS_MK) $(@F:.mk=); fi + +ext/clean:: ext/clean.sub +ext/distclean:: ext/distclean.sub +ext/realclean:: ext/realclean.sub +.bundle/clean:: .bundle/clean.sub +.bundle/distclean:: .bundle/distclean.sub +.bundle/realclean:: .bundle/realclean.sub + +ext/clean.sub .bundle/clean.sub:: ext/clean.mk +ext/distclean.sub .bundle/distclean.sub:: ext/distclean.mk +ext/realclean.sub .bundle/realclean.sub:: ext/realclean.mk + +ext/clean.sub ext/distclean.sub ext/realclean.sub \ +.bundle/clean.sub .bundle/distclean.sub .bundle/realclean.sub:: + $(Q) set dummy `echo "${EXTS}" | tr , ' '`; shift; \ + test "$$#" = 0 && set .; \ + set dummy `\ + cd $(@D) 2>/dev/null && \ + find "$$@" \( -name Makefile -o -name exts.mk \) -print | \ + sed -n 's:^\./::;s:^:$(@D)/:;s:/[^/][^/]*$$::p' | sort -u; \ + `; shift; \ + for dir do \ + $(RM) "$$dir/exts.mk"; \ + if [ -f "$$dir/Makefile" ]; then \ + echo $(@F:.sub=)ing "$$dir"; \ + (cd "$$dir" && exec $(MAKE) $(mflags) $(@F:.sub=)); \ + fi; \ + done || true + +ext/distclean ext/realclean .bundle/distclean .bundle/realclean:: + $(Q) set dummy `echo "${EXTS}" | tr , ' '`; shift; \ + test "$$#" = 0 && set .; \ + cd $(@D) 2>/dev/null && \ + find "$$@" -type d -empty -exec $(RMDIRS) {} + 2> /dev/null || true + $(Q) $(RMDIRS) $(@D) 2> /dev/null || true + +clean-enc distclean-enc realclean-enc: + @test -f "$(ENC_MK)" || exit 0; \ + echo $(@:-enc=ing) encodings; \ + exec $(MAKE) $(MAKE_ENC) $(@:-enc=) + +ext/extinit.$(OBJEXT): ext/extinit.c $(SETUP) + $(ECHO) compiling $@ + $(Q) $(CC) $(CFLAGS) $(XCFLAGS) $(CPPFLAGS) $(COUTFLAG)$@ -c ext/extinit.c + +enc/encinit.$(OBJEXT): enc/encinit.c $(SETUP) + +cont.$(OBJEXT): $(COROUTINE_H) + +update-src:: + @$(CHDIR) "$(srcdir)" && LC_TIME=C exec $(VCSUP) + +update-download:: update-config_files + +after-update:: prereq + +gcov: + $(Q) $(BASERUBY) $(tooldir)/run-gcov.rb + +lcov: + $(Q) $(BASERUBY) $(tooldir)/run-lcov.rb + +update-benchmark-driver: + $(Q) $(tooldir)/git-refresh -C $(srcdir)/benchmark $(Q1:0=-q) \ + --branch $(BENCHMARK_DRIVER_GIT_REF) \ + $(BENCHMARK_DRIVER_GIT_URL) benchmark-driver $(GIT_OPTS) + +update-doclie: + $(Q) $(tooldir)/git-refresh -C $(srcdir)/coverage $(Q1:0=-q) \ + --branch $(DOCLIE_GIT_REF) \ + $(DOCLIE_GIT_URL) doclie $(GIT_OPTS) + +update-simplecov-html: + $(Q) $(tooldir)/git-refresh -C $(srcdir)/coverage $(Q1:0=-q) \ + --branch $(SIMPLECOV_HTML_GIT_REF) \ + $(SIMPLECOV_HTML_GIT_URL) simplecov-html $(GIT_OPTS) + +update-simplecov: + $(Q) $(tooldir)/git-refresh -C $(srcdir)/coverage $(Q1:0=-q) \ + --branch $(SIMPLECOV_GIT_REF) \ + $(SIMPLECOV_GIT_URL) simplecov $(GIT_OPTS) + +update-coverage: update-simplecov update-simplecov-html update-doclie + +update-known-errors: + errno --list | cut -d' ' -f1 | sort -u - $(srcdir)/defs/known_errors.def | \ + $(IFCHANGE) $(srcdir)/defs/known_errors.def - + +INSNS = opt_sc.inc optinsn.inc optunifs.inc insns.inc insns_info.inc \ + vmtc.inc vm.inc mjit_compile.inc + +$(INSNS): $(srcdir)/insns.def vm_opts.h \ + $(srcdir)/defs/opt_operand.def $(srcdir)/defs/opt_insn_unif.def \ + $(tooldir)/insns2vm.rb \ + $(tooldir)/ruby_vm/controllers/application_controller.rb \ + $(tooldir)/ruby_vm/helpers/c_escape.rb \ + $(tooldir)/ruby_vm/helpers/dumper.rb \ + $(tooldir)/ruby_vm/helpers/scanner.rb \ + $(tooldir)/ruby_vm/loaders/insns_def.rb \ + $(tooldir)/ruby_vm/loaders/opt_insn_unif_def.rb \ + $(tooldir)/ruby_vm/loaders/opt_operand_def.rb \ + $(tooldir)/ruby_vm/loaders/vm_opts_h.rb \ + $(tooldir)/ruby_vm/models/attribute.rb \ + $(tooldir)/ruby_vm/models/bare_instructions.rb \ + $(tooldir)/ruby_vm/models/c_expr.rb \ + $(tooldir)/ruby_vm/models/instructions.rb \ + $(tooldir)/ruby_vm/models/instructions_unifications.rb \ + $(tooldir)/ruby_vm/models/operands_unifications.rb \ + $(tooldir)/ruby_vm/models/trace_instructions.rb \ + $(tooldir)/ruby_vm/models/typemap.rb \ + $(tooldir)/ruby_vm/scripts/converter.rb \ + $(tooldir)/ruby_vm/scripts/insns2vm.rb \ + $(tooldir)/ruby_vm/views/_attributes.erb \ + $(tooldir)/ruby_vm/views/_c_expr.erb \ + $(tooldir)/ruby_vm/views/_comptime_insn_stack_increase.erb \ + $(tooldir)/ruby_vm/views/_copyright.erb \ + $(tooldir)/ruby_vm/views/_insn_entry.erb \ + $(tooldir)/ruby_vm/views/_insn_len_info.erb \ + $(tooldir)/ruby_vm/views/_insn_name_info.erb \ + $(tooldir)/ruby_vm/views/_insn_operand_info.erb \ + $(tooldir)/ruby_vm/views/_insn_sp_pc_dependency.erb \ + $(tooldir)/ruby_vm/views/_insn_type_chars.erb \ + $(tooldir)/ruby_vm/views/_leaf_helpers.erb \ + $(tooldir)/ruby_vm/views/_mjit_compile_insn.erb \ + $(tooldir)/ruby_vm/views/_mjit_compile_insn_body.erb \ + $(tooldir)/ruby_vm/views/_mjit_compile_ivar.erb \ + $(tooldir)/ruby_vm/views/_mjit_compile_pc_and_sp.erb \ + $(tooldir)/ruby_vm/views/_mjit_compile_send.erb \ + $(tooldir)/ruby_vm/views/_notice.erb \ + $(tooldir)/ruby_vm/views/_sp_inc_helpers.erb \ + $(tooldir)/ruby_vm/views/_trace_instruction.erb \ + $(tooldir)/ruby_vm/views/insns.inc.erb \ + $(tooldir)/ruby_vm/views/insns_info.inc.erb \ + $(tooldir)/ruby_vm/views/mjit_compile.inc.erb \ + $(tooldir)/ruby_vm/views/opt_sc.inc.erb \ + $(tooldir)/ruby_vm/views/optinsn.inc.erb \ + $(tooldir)/ruby_vm/views/optunifs.inc.erb \ + $(tooldir)/ruby_vm/views/vm.inc.erb \ + $(tooldir)/ruby_vm/views/vmtc.inc.erb + $(ECHO) generating $@ + $(Q) $(BASERUBY) -Ku $(tooldir)/insns2vm.rb $(INSNS2VMOPT) $@ + + +loadpath: verconf.h + @$(CPP) $(XCFLAGS) $(CPPFLAGS) $(srcdir)/loadpath.c | \ + sed -e '1,/^const char ruby_initial_load_paths/d;/;/,$$d' \ + -e '/^ /!d;s/ *"\\0"$$//;s/" *"//g' + +un-runnable: + $(ECHO) cannot make runnable, configure with --enable-load-relative. + $(Q) exit 1 + +mjit_config.h: + $(ECHO) making $@ + @{ \ + . $(tooldir)/mjit_archflag.sh; \ + parse_arch_flags "$(UNIVERSAL_ARCHNAMES)" $(ARCH_FLAG); \ + test "$(Q)" = @ || set -x; \ + echo '#ifndef RUBY_MJIT_CONFIG_H'; \ + echo '#define RUBY_MJIT_CONFIG_H 1'; \ + echo; \ + sep=; \ + echo '#ifdef LOAD_RELATIVE'; \ + quote MJIT_HEADER_INSTALL_DIR "/$(MJIT_HEADER_INSTALL_DIR)"; \ + echo '#else'; \ + quote MJIT_HEADER_INSTALL_DIR "$(rubyarchhdrdir)"; \ + echo '#endif'; \ + quote MJIT_MIN_HEADER_NAME "$(MJIT_MIN_HEADER_NAME)"; \ + sep=,; \ + quote "MJIT_CC_COMMON " $(MJIT_CC); \ + quote "MJIT_CFLAGS MJIT_ARCHFLAG" $(MJIT_CFLAGS); \ + quote "MJIT_OPTFLAGS " $(MJIT_OPTFLAGS); \ + quote "MJIT_DEBUGFLAGS " $(MJIT_DEBUGFLAGS); \ + quote "MJIT_LDSHARED " $(MJIT_LDSHARED); \ + quote "MJIT_DLDFLAGS MJIT_ARCHFLAG" $(MJIT_DLDFLAGS); \ + quote "MJIT_LIBS " $(LIBRUBYARG_SHARED); \ + quote 'PRELOADENV "@PRELOADENV@"'; \ + indent=$${archs:+' '}; \ + define_arch_flags; \ + echo; \ + echo '#endif /* RUBY_MJIT_CONFIG_H */'; \ + } > $@ + +yes-test-almost yes-test-all programs: mjit_build_dir.$(SOEXT) +mjit_build_dir.$(SOEXT): $(MJIT_MIN_HEADER) $(srcdir)/ruby-runner.c ruby-runner.h + $(ECHO) making $@ + $(Q) $(DLDSHARED) $(MJIT_DLDFLAGS) $(ARCH_FLAG) $(CFLAGS) $(INCFLAGS) $(CPPFLAGS) \ + -DMAKE_MJIT_BUILD_DIR=1 -DMJIT_MIN_HEADER='"$(MJIT_MIN_HEADER)"' \ + $(OUTFLAG)$@ $(srcdir)/ruby-runner.c + +# yes-test-basic: leaked-globals +leaked-globals: $(COMMONOBJS) prog $(tooldir)/leaked-globals PHONY + $(Q) $(XRUBY) $(tooldir)/leaked-globals NM=$(NM) SYMBOL_PREFIX=$(SYMBOL_PREFIX) PLATFORM=$(hdrdir)/ruby/$(PLATFORM_DIR).h $(srcdir)/configure.ac $(COMMONOBJS) diff --git a/template/builtin_binary.inc.tmpl b/template/builtin_binary.inc.tmpl new file mode 100644 index 0000000000..787ced5f3d --- /dev/null +++ b/template/builtin_binary.inc.tmpl @@ -0,0 +1,30 @@ +// -*- c -*- +// DO NOT MODIFY THIS FILE DIRECTLY. +// auto-generated file by tool/generic_erb.rb +// with template/builtin_binary.inc.tmpl +% unless ARGV.include?('--cross=yes') +% ary = RubyVM.enum_for(:each_builtin).to_a +% ary.each{|feature, iseq| + +static const unsigned char <%= feature %>_bin[] = { +% iseq \ +% . to_binary \ +% . each_byte \ +% . map(&:ord) \ +% . map{ '0x%02x' % _1 } \ +% . each_slice(12) {|a| + <%= a.join(', ') %>, +% } +}; +% } + +static const struct builtin_binary builtin_binary[] = { +% ary.each{|feature, | + { <%= feature.dump %>, <%= feature %>_bin, sizeof(<%= feature %>_bin), }, +% } + { NULL, },<%# dummy entry %> +}; + +#define BUILTIN_BINARY_SIZE <%= ary.size %> +STATIC_ASSERT(n_builtin, numberof(builtin_binary) == BUILTIN_BINARY_SIZE + 1); +% end diff --git a/template/call_iseq_optimized.inc.tmpl b/template/call_iseq_optimized.inc.tmpl new file mode 100644 index 0000000000..2d3ad40f7e --- /dev/null +++ b/template/call_iseq_optimized.inc.tmpl @@ -0,0 +1,68 @@ +/* -*- c -*- */ +% P = (0..3) +% L = (0..5) +% +% def fname param, local +% "vm_call_iseq_setup_normal_0start_#{param}params_#{local}locals" +% end +#if 1 /* enable or disable this optimization */ + +/* DO NOT EDIT THIS FILE DIRECTLY + * + * This file is generated by tool/generic_erb.rb + * with template/call_iseq_optimized.inc.tmpl + */ + +% P.each{|param| +% L.each{|local| +static VALUE +<%= fname(param, local) %>(rb_execution_context_t *ec, rb_control_frame_t *cfp, struct rb_calling_info *calling) +{ + RB_DEBUG_COUNTER_INC(ccf_iseq_fix); + return vm_call_iseq_setup_normal(ec, cfp, calling, vm_cc_cme(calling->cc), 0, <%= param %>, <%= local %>); +} + +% } +% } +/* vm_call_iseq_handlers[param][local] */ +static const vm_call_handler vm_call_iseq_handlers[][<%= L.to_a.size %>] = { +% P.each{|param| + { +% L.each{|local| + <%= fname(param, local) %>, +% } + }, +% } +}; + +static inline vm_call_handler +vm_call_iseq_setup_func(const struct rb_callinfo *ci, const int param_size, const int local_size) +{ + if (UNLIKELY(vm_ci_flag(ci) & VM_CALL_TAILCALL)) { + return &vm_call_iseq_setup_tailcall_0start; + } + else if (0) { /* to disable optimize */ + return &vm_call_iseq_setup_normal_0start; + } + else if (param_size <= <%= P.end %> && local_size <= <%= L.end %>) { + VM_ASSERT(local_size >= 0); + return vm_call_iseq_handlers[param_size][local_size]; + } + else { + return &vm_call_iseq_setup_normal_0start; + } +} + +#else + +static inline vm_call_handler +vm_call_iseq_setup_func(const struct rb_callinfo *ci, const int param_size, const int local_size) +{ + if (UNLIKELY(vm_ci_flag(ci) & VM_CALL_TAILCALL)) { + return &vm_call_iseq_setup_tailcall_0start; + } + else { + return &vm_call_iseq_setup_normal_0start; + } +} +#endif diff --git a/template/configure-ext.mk.tmpl b/template/configure-ext.mk.tmpl new file mode 100644 index 0000000000..8ba6b963e3 --- /dev/null +++ b/template/configure-ext.mk.tmpl @@ -0,0 +1,46 @@ +V = 0 +V0 = $(V:0=) +Q1 = $(V:1=) +Q = $(Q1:0=@) +ECHO1 = $(V:1=@:) +ECHO = $(ECHO1:0=@echo) + +<% +srcdir = miniruby = script_args = nil +opt = OptionParser.new do |o| + o.on('--srcdir=SRCDIR') {|v| srcdir = v} + o.on('--miniruby=MINIRUBY') {|v| miniruby = v} + o.on('--script-args=MINIRUBY') {|v| script_args = v} + o.order!(ARGV) +end +srcdir ||= File.dirname(File.dirname(__FILE__)) +exts = {} +[ + ["exts", "ext", "--extstatic $(EXTSTATIC)"], + ["gems", ".bundle/gems", "--no-extstatic"], +].each do |t, d, o| + exts[t] = [o, Dir.glob("#{srcdir}/#{d}/*/").map {|n| n[(srcdir.size+1)..-2]}] +end +%> +MINIRUBY = <%=miniruby%> +SCRIPT_ARGS = <%=script_args.gsub("#", "\\#")%> +EXTMK_ARGS = $(SCRIPT_ARGS) --gnumake=$(gnumake) --extflags="$(EXTLDFLAGS)" \ + --make-flags="MINIRUBY='$(MINIRUBY)'" + +all: exts gems +exts: +gems: + +% exts.each do |t, (o, dirs)| +% dirs.each do |d| +% next if Dir.glob("#{srcdir}/#{d}/**/extconf.rb").empty? +<%=t%>: <%=d%>/exts.mk +<%=d%>/exts.mk: FORCE + $(Q)$(MINIRUBY) $(srcdir)/ext/extmk.rb --make='$(MAKE)' \ + --command-output=$@ $(EXTMK_ARGS) <%=o%> \ + -- configure $(@D) +% end +% end + +.PHONY: FORCE all exts gems +FORCE: diff --git a/template/depend.tmpl b/template/depend.tmpl new file mode 100644 index 0000000000..0301ce074c --- /dev/null +++ b/template/depend.tmpl @@ -0,0 +1,2 @@ +# AUTOGENERATED DEPENDENCIES START +# AUTOGENERATED DEPENDENCIES END diff --git a/template/encdb.h.tmpl b/template/encdb.h.tmpl new file mode 100644 index 0000000000..8e658f7985 --- /dev/null +++ b/template/encdb.h.tmpl @@ -0,0 +1,101 @@ +<% #-*- mode: ruby -*- +# +# OnigEncodingDefine(foo, Foo) = { +# .. +# "Shift_JIS", /* Canonical Name */ +# .. +# }; +# ENC_ALIAS("SJIS", "Shift_JIS") +# ENC_REPLICATE("Windows-31J", "Shift_JIS") +# ENC_ALIAS("CP932", "Windows-31J") +# + +def check_duplication(defs, name, fn, line) + if defs[name] + raise ArgumentError, "%s:%d: encoding %s is already registered(%s:%d)" % + [fn, line, name, *defs[name]] + else + defs[name.upcase] = [fn,line] + end +end + +lines = [] +BUILTIN_ENCODINGS = { + 'ASCII-8BIT' => 0, + 'UTF-8' => 1, + 'US-ASCII' => 2, +} +encodings = %w[ASCII-8BIT UTF-8 US-ASCII] # BUILTIN_ENCODINGS.keys is not available on cross compiling and used ruby 1.8 +count = encodings.size +defs = {} +encdirs = ARGV.dup +encdirs << 'enc' if encdirs.empty? +files = {} +encdirs.each do |encdir| + next unless File.directory?(encdir) + Dir.open(encdir) {|d| d.grep(/.+\.[ch]\z/)}.sort_by {|e| + e.scan(/(\d+)|(\D+)/).map {|n,a| a||[n.size,n.to_i]}.flatten + }.each do |fn| + next if files[fn] + files[fn] = true + open(File.join(encdir,fn)) do |f| + name = nil + skip_ifndef_ruby = false + encoding_def = false + f.each_line do |line| + case line + when /^#ifndef RUBY/ + skip_ifndef_ruby = true + when /^#endif/ + skip_ifndef_ruby = false + end + next if skip_ifndef_ruby + encoding_def = true if /^OnigEncodingDefine/ =~ line + if encoding_def && /"(.*?)"/ =~ line + encoding_def = false + if name + lines << %[ENC_SET_BASE("#$1", "#{name}");] + else + name = $1 + end + check_duplication(defs, $1, fn, f.lineno) + next if BUILTIN_ENCODINGS[name] + encodings << $1 + count += 1 + else + case line + when /^\s*rb_enc_register\(\s*"([^"]+)"/ + count += 1 + line = nil + encodings << $1 + when /^ENC_REPLICATE\(\s*"([^"]+)"\s*,\s*"([^"]+)"/ + raise ArgumentError, + '%s:%d: ENC_REPLICATE: %s is not defined yet. (replica %s)' % + [fn, f.lineno, $2, $1] unless defs[$2.upcase] + count += 1 + when /^ENC_ALIAS\(\s*"([^"]+)"\s*,\s*"([^"]+)"/ + raise ArgumentError, + '%s:%d: ENC_ALIAS: %s is not defined yet. (alias %s)' % + [fn, f.lineno, $2, $1] unless defs[$2.upcase] + when /^ENC_DUMMY\w*\(\s*"([^"]+)"/ + count += 1 + else + next + end + check_duplication(defs, $1, fn, f.lineno) + lines << line.sub(/;.*/m, "").chomp + ";" if line + end + end + end + end +end +-%> +% encodings.each_with_index do |e, i| +ENC_DEFINE("<%=e%>"); +% end +% encidx = encodings.size - 1 +% lines.each do |line| +<%=line%><%#=%% %> +% end + +#define ENCODING_COUNT <%=count%> diff --git a/template/extinit.c.tmpl b/template/extinit.c.tmpl new file mode 100644 index 0000000000..e0b076b03c --- /dev/null +++ b/template/extinit.c.tmpl @@ -0,0 +1,17 @@ +%# -*- C -*- +% extinits = ARGV.map {|n| [n.tr('/', '_'), n]} +#include "ruby/ruby.h" + +#define init(func, name) { \ + extern void func(void); \ + ruby_init_ext(name".so", func); \ +} + +void ruby_init_ext(const char *name, void (*init)(void)); + +void Init_ext(void) +{ +% extinits.each do |f, n| + init(Init_<%=f%>, <%=n.dump%>); +% end +} diff --git a/template/exts.mk.tmpl b/template/exts.mk.tmpl new file mode 100644 index 0000000000..5595a08da1 --- /dev/null +++ b/template/exts.mk.tmpl @@ -0,0 +1,171 @@ +# -*- makefile -*- +V = 0 +V0 = $(V:0=) +Q1 = $(V:1=) +Q = $(Q1:0=@) +ECHO1 = $(V:1=@:) +ECHO = $(ECHO1:0=@echo) +<% +require './rbconfig' +macros = {} +deps = [] +notes = {} +rubies = [] +exeext = RbConfig::CONFIG['EXEEXT'] +gnumake = false +confexts = nil +opt = OptionParser.new do |o| + o.on('--gnumake=BOOL') {|v| gnumake = v == 'yes'} + o.on('--configure-exts=FILE') {|v| confexts = v} + o.order!(ARGV) +end +confexts &&= File.read(confexts).scan(/^(?:ext|gem)s: (.*\.mk)/).flatten rescue nil +confexts ||= [] +macros["old_extensions"] = [] + +contpat = /(?>(?>[^\\\n]|\\.)*\\\n)*(?>[^\\\n]|\\.)*/ +Dir.glob("{ext,.bundle/gems}/*/exts.mk") do |e| + gem = e.start_with?(".bundle/gems/") + s = File.read(e) + s.scan(/^(extensions|SUBMAKEOPTS|EXT[A-Z]+|MFLAGS|NOTE_[A-Z]+)[ \t]*=[ \t]*(#{contpat})$/o) do |n, v| + v.gsub!(/\\\n[ \t]*/, ' ') + next if v.empty? + n = "old_extensions" if n == "extensions" and !confexts.include?(e) + v = v.split + m = macros[n] ||= [] + case n + when "LIBS" + m.concat(v) + else + macros[n] = m | v + end + break if n == "old_extensions" + end + if gem + r = "" + else + r = s[/^all static: (.+)$/, 1] + deps << $& + rubies |= r.split if r + r = "(?:#{Regexp.new(r)})|" + end + s.scan(%r"^(ext/\S+)/[^/\s:]+:[ \t]*\1/static$| + ^(?:#{r} + all|static|install(?:-(?:so|rb))?| + (?:dist|real)?clean + ):.+$ + "x) do + deps << $&.sub(/ +note$/, '') + end + s.scan(%r"^(note(?:-\w+)?):(:)?[ \t]*(#{contpat})\n((?:\t.+\n)*)"o) do |(t, m, d, n)| + note = (notes[t] ||= [[m||""], []]) + note[0] |= d.split(/(?:\\\n|[ \t])[ \t]*/) + n = n.split(/^/) + if m + note[1].concat(n) + else + note[1] |= n + end + end +end +deps.uniq! +if objs = macros["EXTOBJS"] and objs.any? {|e|e.start_with?("ext/extinit.")} + objs.delete_if {|e|e.start_with?("dmyext.")} +end +macros.default = [].freeze +class Array + def fold(h, w = 70) + return "" if empty? + w -= h + ret = [s = String.new] + each do |e| + if s.size + e.size + 1 > w + ret << (s = String.new) + end + s << " " << e + end + ret.join(" \\\n" + "\t" * (h / 8) + " " * (h % 8)) + end +end +@erbout = _erbout +def self.column + w = 0 + @erbout[/^.*\z/].scan(/\t|([^\t]+)/) {|s,| w += (s ? s.size : 8 - w % 8)} + w +end +targets = %w[all static install install-so install-rb clean distclean realclean] +objext = RbConfig::CONFIG["OBJEXT"] +if gnumake + submake = "$(MAKE) -C $(@D)" +else + submake = "cd $(@D) && " + exec = RbConfig::CONFIG["exec"] and !exec.empty? and submake << exec << " " + submake << "$(MAKE)" + mflags = " $(MFLAGS)" +end +-%> +% macros.each_pair do |k, v| +<%=k%> =<%= v.fold(column) %> +% end +% RbConfig::MAKEFILE_CONFIG.keys.grep(/RM/) do |k| +<%=k%> = <%=RbConfig::MAKEFILE_CONFIG[k]%> +% end + +all: +static: + +clean: + -$(Q)$(RM) ext/extinit.<%= objext %> +distclean: + -$(Q)$(RM) ext/extinit.c + +% deps.each do |d| +<%= d %> +% end + +% rubies.each do |ruby| +<%= ruby %>: + $(Q)$(MAKE)<%=mflags%> $(SUBMAKEOPTS) $@ +% end +% if rubies.size > 1 +<%= rubies[1..-1].join(' ')%>: <%= rubies[0] %> +% end + +libencs: + $(Q)$(MAKE)<%=mflags%> -f enc.mk V=$(V) MINIRUBY="$(MINIRUBY)" $@ +ext/extinit.<%=objext%>: + $(Q)$(MAKE)<%=mflags%> V=$(V) EXTINITS="$(EXTINITS)" $@ + +% exts = (macros["extensions"] + macros["old_extensions"]) +% exts.map! {|e|e.chomp("/.")}.sort +% targets.each do |tgt| +% exts.each do |d| +% t = "#{d}/#{tgt}" +% if /^(dist|real)?clean$/ =~ tgt +% deps = exts.select {|e|e.start_with?("#{d}/")}.map {|e|"#{e}/#{tgt}"} +% pd = ' ' + deps.join(' ') unless deps.empty? +% else +% pext = File.dirname(d) +% pd = " #{pext}/#{tgt}" if exts.include?(pext) +% end +<%=t%>:<%=pd%> +% if /^(dist|real)clean$/ =~ tgt + $(ECHO) $(@F)ing $(@D) +% end + $(Q)<%= submake %><%=mflags%> V=$(V) $(@F) +% if /^(dist|real)clean$/ =~ tgt + $(Q)$(RM) <%=t[%r[\A(?:\.[^/]+/)?(?:[^/]+/){2}]]%>exts.mk + $(Q)$(RMDIRS) $(@D) +% end +% end +% end + +extso: + @echo EXTSO=$(EXTSO) + +% notes.each_pair do |k, (d, n)| +<%= k %>:<%= d.join(' ') %> +<%= n.join("") %> +% end + +remove-old-extensions: $(old_extensions:/.=/distclean) diff --git a/template/fake.rb.in b/template/fake.rb.in new file mode 100644 index 0000000000..e5900e8065 --- /dev/null +++ b/template/fake.rb.in @@ -0,0 +1,53 @@ +# frozen_string_literal: true +# shareable_constant_value: literal +<% +arg = {} +while /\A(\w+)=(.*)/ =~ ARGV[0] + arg[$1] = $2 + arg[$1].tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR + ARGV.shift +end +if inc = arg['i'] + src = inc == '-' ? STDIN.read : File.read(inc) + src.gsub!(/^#.*\n/, '') + def src.value(name) + eval(self[/\bruby_#{name}(?:\[\])?\s*=\s*((?:"(?:\\.|[^\"\\])*"\s*)*(?=;)|[^{};]+)/m, 1].gsub(/#/, '\\#')) + end + arg['versions'] = version = {} + File.read(File.join(arg['srcdir'], 'version.c')). + scan(/rb_define_global_const\("(RUBY_\w+)",[^;]*?\bMK(?:INT|STR)\(([^()]*)\)/m) do |n, v| + version[n] = src.value(v) + end + arg['RUBY_DESCRIPTION_WITH_MJIT'] = src.value('description_with_mjit') +end +%>baseruby="<%=arg['BASERUBY']%>" +_\ +=begin +_= +ruby="${RUBY-$baseruby}" +case "$ruby" in "echo "*) $ruby; exit $?;; esac +case "$0" in /*) r=-r"$0";; *) r=-r"./$0";; esac +exec $ruby "$r" "$@" +=end +=baseruby +class Object + remove_const :CROSS_COMPILING if defined?(CROSS_COMPILING) + CROSS_COMPILING = RUBY_PLATFORM + constants.grep(/^RUBY_/) {|n| remove_const n} +% arg['versions'].each {|n, v| + <%=n%> = <%if n=='RUBY_DESCRIPTION' %>RubyVM.const_defined?(:JIT) && RubyVM::MJIT.enabled? ? + <%=arg['RUBY_DESCRIPTION_WITH_JIT'].inspect%> : + <%end%><%=v.inspect%> +% } +end +builddir = File.dirname(File.expand_path(__FILE__)) +srcdir = "<%=arg['srcdir']%>" +top_srcdir = File.realpath(srcdir, builddir) +fake = File.join(top_srcdir, "tool/fake.rb") +eval(File.binread(fake), nil, fake) +ropt = "-r#{__FILE__}" +["RUBYOPT"].each do |flag| + opt = ENV[flag] + opt = opt ? ([ropt] | opt.b.split(/\s+/)).join(" ") : ropt + ENV[flag] = opt +end diff --git a/template/id.c.tmpl b/template/id.c.tmpl new file mode 100644 index 0000000000..4f30875c04 --- /dev/null +++ b/template/id.c.tmpl @@ -0,0 +1,41 @@ +%# -*- c -*- +/* DO NOT EDIT THIS FILE DIRECTLY */ +/********************************************************************** + + id.c - + + $Author$ + created at: Wed Dec 5 02:36:10 2012 + + Copyright (C) 2004-2007 Koichi Sasada + +**********************************************************************/ +<% +defs = File.join(File.dirname(File.dirname(erb.filename)), "defs/id.def") +ids = eval(File.read(defs), binding, defs) +ops = ids[:token_op].uniq {|id, op, token| token && op} +%> +% ops.each do |_id, _op, token| +% next unless token +#define t<%=token%> RUBY_TOKEN(<%=token%>) +% end + +static const struct { + unsigned short token; + const char name[3], term; +} op_tbl[] = { +% ops.each do |_id, op, token| +% next unless token + {t<%=token%>, "<%=op%>"}, +% end +}; + +static void +Init_id(void) +{ + rb_encoding *enc = rb_usascii_encoding(); + +% ids[:predefined].each do |token, name| + REGISTER_SYMID(id<%=token%>, "<%=name%>"); +% end +} diff --git a/template/id.h.tmpl b/template/id.h.tmpl new file mode 100644 index 0000000000..687cbbbe40 --- /dev/null +++ b/template/id.h.tmpl @@ -0,0 +1,97 @@ +%# -*- c -*- +/* DO NOT EDIT THIS FILE DIRECTLY */ +/********************************************************************** + + id.h - + + $Author$ + created at: Sun Oct 19 21:12:51 2008 + + Copyright (C) 2007 Koichi Sasada + +**********************************************************************/ +<% +op_id_offset = 128 + +defs = File.join(File.dirname(File.dirname(erb.filename)), "defs/id.def") +ids = eval(File.read(defs), binding, defs) +types = ids.keys.grep(/^[A-Z]/) +%> +#ifndef RUBY_ID_H +#define RUBY_ID_H + +enum ruby_id_types { + RUBY_ID_STATIC_SYM = 0x01, + RUBY_ID_LOCAL = 0x00, + RUBY_ID_INSTANCE = (0x01<<1), + RUBY_ID_GLOBAL = (0x03<<1), + RUBY_ID_ATTRSET = (0x04<<1), + RUBY_ID_CONST = (0x05<<1), + RUBY_ID_CLASS = (0x06<<1), + RUBY_ID_JUNK = (0x07<<1), + RUBY_ID_INTERNAL = RUBY_ID_JUNK, + RUBY_ID_SCOPE_SHIFT = 4, + RUBY_ID_SCOPE_MASK = (~(~0U<<(RUBY_ID_SCOPE_SHIFT-1))<<1) +}; + +#define ID_STATIC_SYM RUBY_ID_STATIC_SYM +#define ID_SCOPE_SHIFT RUBY_ID_SCOPE_SHIFT +#define ID_SCOPE_MASK RUBY_ID_SCOPE_MASK +#define ID_LOCAL RUBY_ID_LOCAL +#define ID_INSTANCE RUBY_ID_INSTANCE +#define ID_GLOBAL RUBY_ID_GLOBAL +#define ID_ATTRSET RUBY_ID_ATTRSET +#define ID_CONST RUBY_ID_CONST +#define ID_CLASS RUBY_ID_CLASS +#define ID_JUNK RUBY_ID_JUNK +#define ID_INTERNAL RUBY_ID_INTERNAL + +#define symIFUNC ID2SYM(idIFUNC) +#define symCFUNC ID2SYM(idCFUNC) + +% index = op_id_offset +% ids[:token_op].each do |_id, _op, token| +% next unless token +#define RUBY_TOKEN_<%=token%> <%=index%> +% index += 1 +% end +#define RUBY_TOKEN(t) RUBY_TOKEN_##t + +#define RUBY_TOKEN2ID_TYPE(tok, type) ((tok<<RUBY_ID_SCOPE_SHIFT)|type|RUBY_ID_STATIC_SYM) +% types.each do |type| +#define TOKEN2<%=type%>ID(tok) RUBY_TOKEN2ID_TYPE(tok, RUBY_ID_<%=type%>) +% end + +enum ruby_method_ids { +% ids[:token_op].uniq {|_, op| op}.each do |id, op, token| + id<%=id%> = <%=token ? "RUBY_TOKEN(#{token})" : "'#{op}'"%>, +% end + tPRESERVED_ID_BEGIN = <%=index-1%>, +% ids[:preserved].each do |token| + id<%=token%>, +% end + tPRESERVED_ID_END, +% prev = 'tPRESERVED_ID_END' +% types.each do |type| +% tokens = ids[type] + tTOKEN_<%=type%>_BEGIN = <%=prev%>-1, +% tokens.each do |token| + t<%=token%>, +% end +% prev = "tTOKEN_#{type}_END" + <%=prev%>, +% end + tNEXT_ID = <%=prev%>, +% types.each do |type| +% tokens = ids[type] +#define DEFINE_<%=type%>ID_FROM_TOKEN(n) id##n = TOKEN2<%=type%>ID(t##n) +% tokens or next +% tokens.each do |token| + DEFINE_<%=type%>ID_FROM_TOKEN(<%=token%>), +% end +% end + tLAST_OP_ID = tPRESERVED_ID_END-1, + idLAST_OP_ID = tLAST_OP_ID >> ID_SCOPE_SHIFT +}; + +#endif /* RUBY_ID_H */ diff --git a/template/known_errors.inc.tmpl b/template/known_errors.inc.tmpl new file mode 100644 index 0000000000..c3aee77477 --- /dev/null +++ b/template/known_errors.inc.tmpl @@ -0,0 +1,14 @@ +/** -*-c-*- + * DO NOT EDIT + * This file is automatically generated by tool/generic_erb.rb from + * template/known_errors.inc.tmpl and defs/known_errors.def. + */ + +% error_names = ARGF.read.split(/\s+/) +% error_names.each do |name| +#ifdef <%=name%> + defined_error("<%=name%>", <%=name%>) +#else + undefined_error("<%=name%>") +#endif +% end diff --git a/template/limits.c.tmpl b/template/limits.c.tmpl new file mode 100644 index 0000000000..de35354829 --- /dev/null +++ b/template/limits.c.tmpl @@ -0,0 +1,97 @@ +%# -*- c -*- +% limits = %w[ +% FIXNUM +% CHAR SCHAR UCHAR WCHAR +% SHRT USHRT +% INT UINT +% LONG ULONG +% LLONG ULLONG +% INT8 UINT8 INT_LEAST8 UINT_LEAST8 INT_FAST8 UINT_FAST8 +% INT16 UINT16 INT_LEAST16 UINT_LEAST16 INT_FAST16 UINT_FAST16 +% INT32 UINT32 INT_LEAST32 UINT_LEAST32 INT_FAST32 UINT_FAST32 +% INT64 UINT64 INT_LEAST64 UINT_LEAST64 INT_FAST64 UINT_FAST64 +% INT128 UINT128 +% INTMAX UINTMAX +% INTPTR UINTPTR +% SSZIE SIZE +% PTRDIFF +% ] +% +% verbatim_integers = %w[ +% FLT_RADIX +% FLT_ROUNDS +% FLT_EVAL_METHOD +% FLT_MANT_DIG DBL_MANT_DIG LDBL_MANT_DIG +% FLT_DIG DBL_DIG LDBL_DIG +% FLT_MIN_EXP DBL_MIN_EXP LDBL_MIN_EXP +% FLT_MIN_10_EXP DBL_MIN_10_EXP LDBL_MIN_10_EXP +% FLT_MAX_EXP DBL_MAX_EXP LDBL_MAX_EXP +% FLT_MAX_10_EXP DBL_MAX_10_EXP LDBL_MAX_10_EXP +% FLT_DECIMAL_DIG DBL_DECIMAL_DIG LDBL_DECIMAL_DIG DECIMAL_DIG +% FLT_HAS_SUBNORM DBL_HAS_SUBNORM LDBL_HAS_SUBNORM +% ] +% +% # Beware; Ruby cannot handle LDBL_MAX. +% verbatim_doubles = %w[ +% FLT_MAX DBL_MAX +% FLT_EPSILON DBL_EPSILON +% FLT_MIN DBL_MIN +% FLT_TRUE_MIN DBL_TRUE_MIN +% ] +% +#include <limits.h> +#include "ruby/ruby.h" +#ifdef HAVE_STDINT_H +# include <stdint.h> +#endif +#ifdef HAVE_INTTYPES_H +# include <stdint.h> +#endif +#ifdef HAVE_FLOAT_H +# include <float.h> +#endif + +void +Init_limits(void) +{ + VALUE h = rb_hash_new(); + rb_define_const(rb_define_module("RbConfig"), "LIMITS", h); + +#ifdef HAVE_LONG_LONG +#ifndef ULLONG_MAX +#define ULLONG_MAX ((unsigned LONG_LONG)LLONG_MAX*2+1) +#endif +#define MAX2NUM(name) ULL2NUM(name ## _MAX) +#define MIN2NUM(name) LL2NUM(name ## _MIN) +#else +#define MAX2NUM(name) ULONG2NUM(name ## _MAX) +#define MIN2NUM(name) LONG2NUM(name ## _MIN) +#endif +#define DEFINE(k, v) rb_hash_aset(h, rb_str_new_cstr(#k), v) + +% limits.each do |type| +#ifdef <%= type %>_MAX + DEFINE(<%= type %>_MAX, MAX2NUM(<%= type %>)); +#endif +#ifdef <%= type %>_MIN + DEFINE(<%= type %>_MIN, MIN2NUM(<%= type %>)); +#endif +% end + +% verbatim_integers.each do |name| +#ifdef <%= name %> + DEFINE(<%= name %>, LONG2NUM(<%= name %>)); +#endif +% end + +% verbatim_doubles.each do |name| +#ifdef <%= name %> + DEFINE(<%= name %>, DBL2NUM(<%= name %>)); +#endif +% end + +#undef DEFINE +#undef MIN2NUM +#undef MAX2NUM + OBJ_FREEZE(h); +} diff --git a/template/prelude.c.tmpl b/template/prelude.c.tmpl new file mode 100644 index 0000000000..8743d63de7 --- /dev/null +++ b/template/prelude.c.tmpl @@ -0,0 +1,281 @@ +<% +# This file is interpreted by $(BASERUBY) and miniruby. +# $(BASERUBY) is used for miniprelude.c. +# miniruby is used for prelude.c. +# Since $(BASERUBY) may be older than Ruby 1.9, +# Ruby 1.9 feature should not be used. + +require_relative '../tool/ruby_vm/helpers/c_escape' + +class Prelude + include RubyVM::CEscape + LINE_LIMIT = 509 # by C89 + + def prelude_base(filename) + filename.chomp(".rb") + end + def prelude_name(filename) + "<internal:" + prelude_base(filename) + ">" + end + + def initialize(output, preludes, vpath) + @output = output + @have_sublib = false + @vpath = vpath + @prelude_count = 0 + @builtin_count = 0 + @preludes = {} + @mains = preludes.map do |filename| + if prelude = filename.end_with?("golf_prelude.rb") + @prelude_count += 1 + else + @builtin_count += 1 + end + translate(filename, (filename unless prelude))[0] + end + @preludes.delete_if {|_, (_, _, lines, sub)| sub && lines.empty?} + end + + def translate(filename, sub = false) + idx = @preludes[filename] + return idx if idx + lines = [] + start_line = nil + lineno = 0 + result = [@preludes.size, @vpath.strip(filename), lines, sub] + @vpath.foreach(filename) do |line| + line.force_encoding("ASCII-8BIT") if line.respond_to?(:force_encoding) + line.rstrip! + lineno += 1 + @preludes[filename] ||= result + comment = ($1 || '' if line.sub!(/(?:^|\s+)\#(?:$|[#\s](.*))/, '')) + if !line.empty? or start_line + line << "\n" + start_line ||= lineno + end + if line.size > LINE_LIMIT + raise "#{filename}:#{lines.size+1}: too long line" + end + line.sub!(/require(_relative)?\s*\(?\s*(["'])(.*?)(?:\.rb)?\2\)?/) do + orig, rel, path = $&, $2, $3 + if rel + path = File.join(File.dirname(filename), path) + nil while path.gsub!(%r'(\A|/)(?!\.\.?/)[^/]+/\.\.(?:/|\z)', '') + end + path = translate("#{path}.rb", true) rescue nil + if path + @have_sublib = true + "TMP_RUBY_PREFIX.require(#{path[0]})" + else + orig + end + end + lines << [line, comment] + end + result << (start_line || 1) + result + end +end +Prelude.new(output, ARGV, vpath).instance_eval do +-%> +/* -*-c-*- + THIS FILE WAS AUTOGENERATED BY template/prelude.c.tmpl. DO NOT EDIT. + + sources: <%= @preludes.map {|n,*| prelude_base(n)}.join(', ') %><%=%> +*/ +%unless @preludes.empty? +#include "internal.h" +#include "internal/warnings.h" +#include "iseq.h" +#include "ruby/ruby.h" +#include "vm_core.h" + +COMPILER_WARNING_PUSH +#if __has_warning("-Wstring-concatenation") +COMPILER_WARNING_IGNORED(-Wstring-concatenation) +#endif +% preludes = @preludes.values.sort +% preludes.each {|i, prelude, lines, sub| + +% name = prelude_name(*prelude) +static const char prelude_name<%=i%><%=%>[] = <%=rstring2cstr(name)%>; +static const struct { +% size = beg = 0 +% lines.each_with_index {|(line, comment), n| +% if size + line.size < Prelude::LINE_LIMIT +% size += line.size +% next +% end + char L<%=beg%><%=%>[<%=size%><%=%>]; /* <%=beg+1%>..<%=n%> */ +% size = line.size +% beg = n +% } +% if size > 0 + char L<%=beg%><%=%>[<%=size%><%=%>]; /* <%=beg+1%>..<%=lines.size+1%> */ +% end +} prelude_code<%=i%><%=%> = { +% size = 0 +#line 1 <%=rstring2cstr(prelude)%> +% lines.each_with_index {|(line, comment), n| +% if size + line.size >= Prelude::LINE_LIMIT +% size = 0 +, +#line <%=n+1%> <%=rstring2cstr(prelude)%> +% end +% size += line.size +<%=rstring2cstr(line)%><%if comment%><%=commentify(comment)%><%end%> +% } +#line <%=_erbout.count("\n")+2%> "<%=@output%>" +}; +% } + +COMPILER_WARNING_POP + +% if @have_sublib +#define PRELUDE_COUNT <%=preludes.size%> + +struct prelude_env { + volatile VALUE prefix_path; +#if PRELUDE_COUNT > 0 + char loaded[PRELUDE_COUNT]; +#endif +}; + +static VALUE +prelude_prefix_path(VALUE self) +{ + struct prelude_env *ptr = DATA_PTR(self); + return ptr->prefix_path; +} + +% end +% unless preludes.empty? +#define PRELUDE_NAME(n) rb_usascii_str_new_static(prelude_name##n, sizeof(prelude_name##n)-1) +#define PRELUDE_CODE(n) rb_utf8_str_new_static(prelude_code##n.L0, sizeof(prelude_code##n)) + +static rb_ast_t * +prelude_ast(VALUE name, VALUE code, int line) +{ + rb_ast_t *ast = rb_parser_compile_string_path(rb_parser_new(), name, code, line); + if (!ast->body.root) { + rb_ast_dispose(ast); + rb_exc_raise(rb_errinfo()); + } + return ast; +} + +% end +% if @builtin_count > 0 +#define PRELUDE_AST(n, name_str, start_line) \ + (((sizeof(prelude_name<%='##'%><%=%>n) - prefix_len - 2) == namelen) && \ + (strncmp(prelude_name<%='##'%><%=%>n + prefix_len, feature_name, namelen) == 0) ? \ + prelude_ast((name_str) = PRELUDE_NAME(n), PRELUDE_CODE(n), start_line) : 0) + +rb_ast_t * +rb_builtin_ast(const char *feature_name, VALUE *name_str) +{ + const size_t prefix_len = rb_strlen_lit("<internal:"); + size_t namelen = strlen(feature_name); + rb_ast_t *ast = 0; + +% @preludes.each_value do |i, prelude, lines, sub, start_line| +% if sub and sub != true + if ((ast = PRELUDE_AST(<%=i%><%=%>, *name_str, <%=start_line%>)) != 0) return ast; +% end +% end + return ast; +} + +% end +% if @prelude_count > 0 +COMPILER_WARNING_PUSH +#if GCC_VERSION_SINCE(4, 2, 0) +COMPILER_WARNING_ERROR(-Wmissing-field-initializers) +#endif +static void +prelude_eval(VALUE code, VALUE name, int line) +{ + static const rb_compile_option_t optimization = { + TRUE, /* int inline_const_cache; */ + TRUE, /* int peephole_optimization; */ + FALSE,/* int tailcall_optimization; */ + TRUE, /* int specialized_instruction; */ + TRUE, /* int operands_unification; */ + TRUE, /* int instructions_unification; */ + TRUE, /* int stack_caching; */ + TRUE, /* int frozen_string_literal; */ + FALSE, /* int debug_frozen_string_literal; */ + FALSE, /* unsigned int coverage_enabled; */ + 0, /* int debug_level; */ + }; + + rb_ast_t *ast = prelude_ast(name, code, line); + rb_iseq_eval(rb_iseq_new_with_opt(&ast->body, name, name, Qnil, INT2FIX(line), + NULL, 0, ISEQ_TYPE_TOP, &optimization)); + rb_ast_dispose(ast); +} +COMPILER_WARNING_POP + +% end +% if @have_sublib +static VALUE +prelude_require(VALUE self, VALUE nth) +{ + struct prelude_env *ptr = DATA_PTR(self); + VALUE code, name; + int n = FIX2INT(nth); + int start_line; + + if (n > PRELUDE_COUNT) return Qfalse; + if (ptr->loaded[n]) return Qfalse; + ptr->loaded[n] = 1; + switch (n) { +% @preludes.each_value do |i, prelude, lines, sub, start_line| +% if sub == true + case <%=i%><%=%>: + code = PRELUDE_CODE(<%=i%><%=%>); + name = PRELUDE_NAME(<%=i%><%=%>); + start_line = <%=start_line%>; + break; +% end +% end + default: + return Qfalse; + } + prelude_eval(code, name, start_line); + return Qtrue; +} + +% end +%end +% init_name = @output && @output[/\w+(?=_prelude.c\b)/] || 'prelude' +void +Init_<%=init_name%><%=%>(void) +{ +%unless @prelude_count.zero? +% if @have_sublib + struct prelude_env memo; + ID name = rb_intern("TMP_RUBY_PREFIX"); + VALUE prelude = Data_Wrap_Struct(rb_cData, 0, 0, &memo); + + memo.prefix_path = rb_const_remove(rb_cObject, name); + rb_const_set(rb_cObject, name, prelude); + rb_define_singleton_method(prelude, "to_s", prelude_prefix_path, 0); +% end +% if @have_sublib + memset(memo.loaded, 0, sizeof(memo.loaded)); + rb_define_singleton_method(prelude, "require", prelude_require, 1); +% end +% preludes.each do |i, prelude, lines, sub, start_line| +% next if sub + prelude_eval(PRELUDE_CODE(<%=i%><%=%>), PRELUDE_NAME(<%=i%><%=%>), <%=start_line%>); +% end + +#if 0 +% preludes.length.times {|i| + printf("%.*s", (int)sizeof(prelude_code<%=i%><%=%>), prelude_code<%=i%><%=%>.L0); +% } +#endif +%end +} +<%end -%> diff --git a/template/ruby-gdb.in b/template/ruby-gdb.in new file mode 100755 index 0000000000..7ab4e976c6 --- /dev/null +++ b/template/ruby-gdb.in @@ -0,0 +1,6 @@ +#!/bin/sh +prefix="/${0%/*}" +prefix="${prefix%/*}" +ruby="${bindir}/${RUBY_INSTALL_NAME}" +gdbinit="${rubylibdir}/gdbinit" +exec gdb --command="$gdbinit" --args "$ruby" "$@" diff --git a/template/ruby-lldb.in b/template/ruby-lldb.in new file mode 100755 index 0000000000..c33603b94d --- /dev/null +++ b/template/ruby-lldb.in @@ -0,0 +1,6 @@ +#!/bin/sh +prefix="/${0%/*}" +prefix="${prefix%/*}" +ruby="${bindir}/${RUBY_INSTALL_NAME}" +lldbinit="${rubylibdir}/lldb_cruby.py" +exec lldb -O "command script import $lldbinit" "$ruby" -- "$@" diff --git a/template/ruby-runner.h.in b/template/ruby-runner.h.in new file mode 100644 index 0000000000..fdfe88dcb9 --- /dev/null +++ b/template/ruby-runner.h.in @@ -0,0 +1,9 @@ +#define ABS_SRCDIR "@abs_srcdir@" +#define BUILDDIR "@abs_top_builddir@" +#define LIBPATHENV "@LIBPATHENV@" +#define PRELOADENV "@PRELOADENV@" +#define PATH_SEPARATOR "@PATH_SEPARATOR@" +#define PATH_SEP '@PATH_SEPARATOR@' +#define EXTOUT "@EXTOUT@" +#define ARCH "@arch@" +#define SOEXT "@SOEXT@" diff --git a/template/ruby.pc.in b/template/ruby.pc.in new file mode 100644 index 0000000000..c4848805a3 --- /dev/null +++ b/template/ruby.pc.in @@ -0,0 +1,59 @@ +MAJOR=@MAJOR@ +MINOR=@MINOR@ +TEENY=@TEENY@ +ruby_version=@ruby_version@ +RUBY_API_VERSION=@RUBY_API_VERSION@ +RUBY_PROGRAM_VERSION=@RUBY_PROGRAM_VERSION@ +arch=@arch@ +sitearch=@sitearch@ + +RUBY_BASE_NAME=@RUBY_BASE_NAME@ +RUBY_VERSION_NAME=@RUBY_VERSION_NAME@ +RUBY_SO_NAME=@RUBY_SO_NAME@ +RUBY_INSTALL_NAME=@RUBY_INSTALL_NAME@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +bindir=@bindir@ +libdir=@libdir@ +includedir=@includedir@ +archlibdir=@archlibdir@ +sitearchlibdir=@sitearchlibdir@ +archincludedir=@archincludedir@ +sitearchincludedir=@sitearchincludedir@ +ruby=${bindir}/${RUBY_INSTALL_NAME}@EXEEXT@ +rubylibprefix=@rubylibprefix@ +rubyarchprefix=@rubyarchprefix@ +rubysitearchprefix=@rubysitearchprefix@ +rubylibdir=@rubylibdir@ +vendordir=@vendordir@ +sitedir=@sitedir@ +vendorlibdir=@vendorlibdir@ +sitelibdir=@sitelibdir@ +rubyarchdir=@rubyarchdir@ +vendorarchdir=@vendorarchdir@ +sitearchdir=@sitearchdir@ +rubyhdrdir=@rubyhdrdir@ +vendorhdrdir=@vendorhdrdir@ +sitehdrdir=@sitehdrdir@ +rubyarchhdrdir=@rubyarchhdrdir@ +vendorarchhdrdir=@vendorarchhdrdir@ +sitearchhdrdir=@sitearchhdrdir@ +MAINLIBS=@MAINLIBS@ +SOEXT=@SOEXT@ +LIBPATH=@LIBPATH@ +LIBRUBY_A=@LIBRUBY_A@ +LIBRUBY_SO=@LIBRUBY_SO@ +LIBRUBY=@LIBRUBY@ +LIBRUBYARG_SHARED=@LIBRUBYARG_SHARED@ +LIBRUBYARG_STATIC=@LIBRUBYARG_STATIC@ +LIBRUBYARG=@LIBRUBYARG@ +LIBS=@LIBS@ +DLDFLAGS=@DLDFLAGS@ + +Name: Ruby +Description: Object Oriented Script Language +Version: ${ruby_version} +URL: https://www.ruby-lang.org +Cflags: -I${rubyarchhdrdir} -I${rubyhdrdir} +Libs: ${DLDFLAGS} ${LIBRUBYARG_SHARED} ${LIBS} +Requires: diff --git a/template/sizes.c.tmpl b/template/sizes.c.tmpl new file mode 100644 index 0000000000..31060f5fea --- /dev/null +++ b/template/sizes.c.tmpl @@ -0,0 +1,54 @@ +%# -*- c -*- +#include "ruby/ruby.h" +<% +class String + def tr_cpp + strip.upcase.tr_s("^A-Z0-9_*", "_").tr_s("*", "P") + end +end +headers = Hash.new {[]} +sizes = {} +types = ARGF.grep(/^\s*RUBY_CHECK_SIZEOF\((\w[^\[\],#]*)[^#]*\)| + ^\s*RUBY_DEFINT\((\w[^\[\],#]*)[^#]*\)| + ^\s*have_type\('(.+?)'(?:,\s*%w\[(.+)\])?\)/x) do + sizes[type = $3] = true + hdrs = $4 and hdrs.split.each {|h| headers[h] <<= type} + type || $+ +end +conditions = { + "long long" => 'defined(HAVE_TRUE_LONG_LONG)', +} +%> +% headers.each do |h, type| +#if <%= type.map {|t| "defined(HAVE_TYPE_#{t.tr_cpp})"}.join(' || ') %> +# include <<%= h %>> +#endif + +% end +extern void Init_limits(void); +void +Init_sizeof(void) +{ + VALUE s = rb_hash_new(); + rb_define_const(rb_define_module("RbConfig"), "SIZEOF", s); + +#define DEFINE(type, size) rb_hash_aset(s, rb_str_new_cstr(#type), INT2FIX(SIZEOF_##size)) +#define DEFINE_SIZE(type) rb_hash_aset(s, rb_str_new_cstr(#type), INT2FIX(sizeof(type))) + +% types.each do |type| +% if sizes[type] +#ifdef HAVE_TYPE_<%= type.tr_cpp %> + DEFINE_SIZE(<%= type %>); +#endif +% next +% end +% cond = conditions[type] +#if defined(SIZEOF_<%= type.tr_cpp %>) && SIZEOF_<%= type.tr_cpp %> != 0<%= " && #{cond}" if cond %> + DEFINE(<%= type %>, <%= type.tr_cpp %>); +#endif +% end + OBJ_FREEZE(s); + +#undef DEFINE + Init_limits(); +} diff --git a/template/transdb.h.tmpl b/template/transdb.h.tmpl new file mode 100644 index 0000000000..990a8639d0 --- /dev/null +++ b/template/transdb.h.tmpl @@ -0,0 +1,60 @@ +<% +# +# static const rb_transcoder +# rb_from_US_ASCII = { +# "US-ASCII", "UTF-8", &from_US_ASCII, 1, 0, +# NULL, NULL, +# }; +# + +count = 0 +converters = {} +transdirs = ARGV.dup +transdirs << 'enc/trans' if transdirs.empty? + +transdirs = transdirs.sort_by {|td| + -td.length +}.inject([]) {|tds, td| + next tds unless File.directory?(td) + tds << td if tds.all? {|td2| !File.identical?(td2, td) } + tds +} + +files = {} +names_t = [] +converter_list = [] +transdirs.each do |transdir| + names = Dir.entries(transdir) + names_t += names.map {|n| /(?!\A)\.trans\z/ =~ n ? $` : nil }.compact + names_c = names.map {|n| /(?!\A)\.c\z/ =~ n ? $` : nil }.compact + (names_t & names_c).map {|n| + "#{n}.c" + }.sort_by {|e| + e.scan(/(\d+)|(\D+)/).map {|n,a| a||[n.size,n.to_i]}.flatten + }.each do |fn| + next if files[fn] + files[fn] = true + path = File.join(transdir,fn) + open(path) do |f| + transcoder_def = false + f.each_line do |line| + transcoder_def = true if /^static const rb_transcoder/ =~ line + if transcoder_def && /"(.*?)"\s*,\s*"(.*?)"/ =~ line + transcoder_def = false + from_to = "%s to %s" % [$1, $2] + if converters[from_to] + raise ArgumentError, '%s:%d: transcode "%s" is already registered at %s:%d' % + [path, f.lineno, from_to, *converters[from_to].values_at(3, 4)] + else + converters[from_to] = [$1, $2, fn[0..-3], path, f.lineno] + converter_list << from_to + end + end + end + end + end +end +converter_list.each do |from_to| + from, to, fn = *converters[from_to] +%>rb_declare_transcoder("<%=from%>", "<%=to%>", "<%=fn%>"); +% end diff --git a/template/unicode_norm_gen.tmpl b/template/unicode_norm_gen.tmpl new file mode 100644 index 0000000000..a16712fbac --- /dev/null +++ b/template/unicode_norm_gen.tmpl @@ -0,0 +1,220 @@ +%# -*- mode: ruby; coding: utf-8 -*- +<% +# Copyright Ayumu Nojima (野島 歩) and Martin J. Dürst (duerst@it.aoyama.ac.jp) + +# Script to generate Ruby data structures used in implementing +# String#unicode_normalize,... + +# Constants for input and output directory +InputDataDir = ARGV[0] || 'enc/unicode/data' +unicode_version = InputDataDir[/.*\/(\d+\.\d+\.\d+)(?=\/|\z)/, 1] + +# convenience methods +class Integer + def to_UTF8() # convert to string, taking legibility into account + if self>0xFFFF + "\\u{#{to_s(16).upcase}}" + elsif self>0x7f + "\\u#{to_s(16).upcase.rjust(4, '0')}" + else + chr.sub(/[\\\"]/, "\\\\\\\&") + end + end +end + +module Enumerable + unless method_defined?(:each_slice) + def each_slice(n) + ary = [] + each do |i| + ary << i + if ary.size >= n + yield ary + ary = [] + end + end + yield ary unless ary.empty? + self + end + end +end + +class Array + def to_UTF8() collect {|c| c.to_UTF8}.join('') end + + def each_regexp_chars(n = 1) # converts an array of Integers to character ranges + sort.inject([]) do |ranges, value| + if ranges.last and ranges.last[1]+1>=value + ranges.last[1] = value + ranges + else + ranges << [value, value] + end + end.collect do |first, last| + case last-first + when 0 + first.to_UTF8 + when 1 + first.to_UTF8 + last.to_UTF8 + else + first.to_UTF8 + '-' + last.to_UTF8 + end + end.each_slice(n) do |slice| + yield slice.join('') + end + end +end + +# read the file 'CompositionExclusions.txt' +composition_exclusions = vpath.open("#{InputDataDir}/CompositionExclusions.txt", 'rb') {|f| + base = Regexp.quote(File.basename(f.path, '.*')) + ext = Regexp.quote(File.extname(f.path)) + version = (line = f.gets)[/^# *#{base}-([\d.]+)#{ext}\s*$/, 1] or + abort "No file version in #{f.path}: #{line}" + (unicode_version ||= version) == version or + abort "Unicode version of directory (#{unicode_version}) and file (#{version}) mismatch" + f.grep(/^[A-Z0-9]{4,5}/) {|code| code.hex} +} + +decomposition_table = {} +kompatible_table = {} +combining_class = {} # constant to allow use in Integer#to_UTF8 + +# read the file 'UnicodeData.txt' +vpath.foreach("#{InputDataDir}/UnicodeData.txt") do |line| + codepoint, name, _, char_class, _, decomposition, *_rest = line.split(";") + + case decomposition + when /^[0-9A-F]/ + decomposition_table[codepoint.hex] = decomposition.split(' ').collect {|w| w.hex} + when /^</ + kompatible_table[codepoint.hex] = decomposition.split(' ')[1..-1].collect {|w| w.hex} + end + combining_class[codepoint.hex] = char_class.to_i if char_class != "0" + + if name=~/(First|Last)>$/ and (char_class!="0" or decomposition!="") + warn "Unexpected: Character range with data relevant to normalization!" + end +end + +# calculate compositions from decompositions +composition_table = decomposition_table.reject do |character, decomposition| + composition_exclusions.member? character or # predefined composition exclusion + decomposition.length<=1 or # Singleton Decomposition + combining_class[character] or # character is not a Starter + combining_class[decomposition.first] # decomposition begins with a character that is not a Starter +end.invert + +# recalculate composition_exclusions +composition_exclusions = decomposition_table.keys - composition_table.values + +accent_array = combining_class.keys + composition_table.keys.collect {|key| key.last} + +composition_starters = composition_table.keys.collect {|key| key.first} + +hangul_no_trailing = [] +0xAC00.step(0xD7A3, 28) {|c| hangul_no_trailing << c} + +# expand decomposition table values +decomposition_table.each do |key, value| + position = 0 + while position < value.length + if decomposition = decomposition_table[value[position]] + decomposition_table[key] = value = value.dup # avoid overwriting composition_table key + value[position, 1] = decomposition + else + position += 1 + end + end +end + +# deal with relationship between canonical and kompatibility decompositions +decomposition_table.each do |key, value| + value = value.dup + expanded = false + position = 0 + while position < value.length + if decomposition = kompatible_table[value[position]] + value[position, 1] = decomposition + expanded = true + else + position += 1 + end + end + kompatible_table[key] = value if expanded +end + +while kompatible_table.any? {|key, value| + expanded = value.map {|v| kompatible_table[v] || v}.flatten + kompatible_table[key] = expanded unless value == expanded + } +end + +# generate normalization tables file +%># coding: us-ascii +# frozen_string_literal: true +%# > + +# automatically generated by template/unicode_norm_gen.tmpl + +module UnicodeNormalize # :nodoc: + accents = "" \ + "[<% accent_array.each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>]" + ACCENTS = accents + REGEXP_D_STRING = "#{'' # composition starters and composition exclusions + }" \ + "[<% (composition_table.values+composition_exclusions).each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>]#{accents}*" \ + "|#{'' # characters that can be the result of a composition, except composition starters + }" \ + "[<% (composition_starters-composition_table.values).each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>]?#{accents}+" \ + "|#{'' # precomposed Hangul syllables + }" \ + "[\u{AC00}-\u{D7A4}]" + REGEXP_C_STRING = "#{'' # composition exclusions + }" \ + "[<% composition_exclusions.each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>]#{accents}*" \ + "|#{'' # composition starters and characters that can be the result of a composition + }" \ + "[<% (composition_starters+composition_table.values).each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>]?#{accents}+" \ + "|#{'' # Hangul syllables with separate trailer + }" \ + "[<% hangul_no_trailing.each_regexp_chars do |rx|%><%=rx%>" \ + "<% end%>][\u11A8-\u11C2]" \ + "|#{'' # decomposed Hangul syllables + }" \ + "[\u1100-\u1112][\u1161-\u1175][\u11A8-\u11C2]?" + REGEXP_K_STRING = "" \ + "[<% kompatible_table.keys.each_regexp_chars do |rx|%><%=rx%>" \ + "<%end%>]" + + class_table = { +% combining_class.each do |key, value| + "<%=key.to_UTF8%>"=><%=value%><%=%>, +% end + } + class_table.default = 0 + CLASS_TABLE = class_table.freeze + + DECOMPOSITION_TABLE = { +% decomposition_table.each do |key, value| + "<%=key.to_UTF8%>"=>"<%=value.to_UTF8%>"<%=%>, +% end + }.freeze + + KOMPATIBLE_TABLE = { +% kompatible_table.each do |key, value| + "<%=key.to_UTF8%>"=>"<%=value.to_UTF8%>"<%=%>, +% end + }.freeze + + COMPOSITION_TABLE = { +% composition_table.each do |key, value| + "<%=key.to_UTF8%>"=>"<%=value.to_UTF8%>"<%=%>, +% end + }.freeze +end diff --git a/template/verconf.h.tmpl b/template/verconf.h.tmpl new file mode 100644 index 0000000000..9ba2bd6de5 --- /dev/null +++ b/template/verconf.h.tmpl @@ -0,0 +1,63 @@ +% config = File.read(conffile = 'rbconfig.rb') +% config.sub!(/^(\s*)RUBY_VERSION\b.*(\sor\s*)$/, '\1true\2') +% rbconfig = Module.new {module_eval(config, conffile)}::RbConfig +% C = rbconfig::MAKEFILE_CONFIG.dup +% def C.[](name) str = super and (str unless str.empty?); end +#define RUBY_BASE_NAME "${RUBY_BASE_NAME}" +#define RUBY_VERSION_NAME "${RUBY_VERSION_NAME}" +% if C["RUBY_LIB_VERSION_STYLE"] +#define RUBY_LIB_VERSION_STYLE ${RUBY_LIB_VERSION_STYLE} +% elsif !C["RUBY_LIB_VERSION"] +#define RUBY_LIB_VERSION_STYLE 3 /* full */ +% else +#define RUBY_LIB_VERSION "${RUBY_LIB_VERSION}" +% end +#define RUBY_EXEC_PREFIX "<%='${RUBY_EXEC_PREFIX}' if C['RUBY_EXEC_PREFIX']%>" +#define RUBY_LIB_PREFIX "${rubylibprefix}" +% unless (sitearch = C["sitearch"]) == '$(arch)' +#define RUBY_SITEARCH "<%=sitearch%>" +% end +#define RUBY_ARCH_PREFIX_FOR(arch) "${rubyarchprefix}" +#define RUBY_SITEARCH_PREFIX_FOR(arch) "${rubysitearchprefix}" +#define RUBY_LIB "${rubylibdir}" +#define RUBY_ARCH_LIB_FOR(arch) "${rubyarchdir}" +% if !C["sitedir"] || C["sitedir"] == "no" +#define NO_RUBY_SITE_LIB 1 +% else +#define RUBY_SITE_LIB "${sitedir}" +#define RUBY_SITE_ARCH_LIB_FOR(arch) "${sitearchdir}" +% end +% if !C["vendordir"] || C["vendordir"] == "no" +#define NO_RUBY_VENDOR_LIB 1 +% else +#define RUBY_VENDOR_LIB "${vendordir}" +#define RUBY_VENDOR_ARCH_LIB_FOR(arch) "${vendorarchdir}" +% end +% if C["RUBY_SEARCH_PATH"] +#define RUBY_SEARCH_PATH "${RUBY_SEARCH_PATH}" +% end +% +% R = {} +% R["ruby_version"] = '"RUBY_LIB_VERSION"' +% R["arch"] = '"arch"' +% R["sitearch"] = '"arch"' +% R["vendorlibdir"] = '"RUBY_VENDOR_LIB2"' +% R["sitelibdir"] = '"RUBY_SITE_LIB2"' +% R["vendordir"] = '"RUBY_VENDOR_LIB"' +% R["sitedir"] = '"RUBY_SITE_LIB"' +% R["rubylibdir"] = '"RUBY_LIB"' +% R["rubylibprefix"] = '"RUBY_LIB_PREFIX"' +% R["rubyarchprefix"] = '"RUBY_ARCH_PREFIX_FOR(arch)"' +% R["rubysitearchprefix"] = '"RUBY_SITEARCH_PREFIX_FOR(arch)"' +% R["exec_prefix"] = '"RUBY_EXEC_PREFIX"' +% R["prefix"] = '"RUBY_EXEC_PREFIX"' +% exec_prefix_pat = /\A"#{Regexp.quote(rbconfig::CONFIG['exec_prefix'])}(?=\/|\z)/ +% _erbout.gsub!(/^(#define\s+(\S+)\s+)(.*)/) { +% pre, name, repl = $1, $2, $3 +% pat = %["#{name}"] +% c = C.merge(R.reject {|key, value| key == name or value.include?(pat)}) +% rbconfig.expand(repl, c) +% repl.gsub!(/^""(?!$)|(.)""$/, '\1') +% repl.sub!(exec_prefix_pat, 'RUBY_EXEC_PREFIX"') +% pre + repl +% } |
